diff --git a/.gitignore b/.gitignore index b25c15b8..2fa964ab 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,20 @@ *~ +external/ + +# Secrets are BAD! +*secret*sh +.env +.env-secrets +*-secrets.env +secrets/ + +# Rust build output +/target + +# Editors / OS +.DS_Store +.idea/ +.vscode/ + +# Python virtual envs (named by convention) +venv/ diff --git a/.sqlx/query-13d435d8f681b73e4080748dcef0579e246e41049af67e1bd79ffc06aa6ba974.json b/.sqlx/query-13d435d8f681b73e4080748dcef0579e246e41049af67e1bd79ffc06aa6ba974.json new file mode 100644 index 00000000..129a5f59 --- /dev/null +++ b/.sqlx/query-13d435d8f681b73e4080748dcef0579e246e41049af67e1bd79ffc06aa6ba974.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET is_dismissed_by_user = 1\n WHERE id = ?\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 1 + }, + "nullable": [] + }, + "hash": "13d435d8f681b73e4080748dcef0579e246e41049af67e1bd79ffc06aa6ba974" +} diff --git a/.sqlx/query-14dfb477ee766faa95038946a0383c27bd3fa103928a9c4f795e78ff16faf039.json b/.sqlx/query-14dfb477ee766faa95038946a0383c27bd3fa103928a9c4f795e78ff16faf039.json new file mode 100644 index 00000000..e05ed5f4 --- /dev/null +++ b/.sqlx/query-14dfb477ee766faa95038946a0383c27bd3fa103928a9c4f795e78ff16faf039.json @@ -0,0 +1,146 @@ +{ + "db_name": "SQLite", + "query": "\n SELECT\n id,\n task_status,\n task_type,\n model_type,\n provider,\n provider_job_id,\n is_batch_generation,\n frontend_caller,\n frontend_subscriber_id,\n frontend_subscriber_payload,\n on_complete_primary_media_file_token,\n on_complete_primary_media_file_class,\n on_complete_batch_token,\n on_complete_primary_media_file_cdn_url,\n on_complete_primary_media_file_thumbnail_url_template,\n on_complete_directory_location,\n on_complete_first_file_location,\n on_failure_type,\n on_failure_message,\n created_at as \"created_at: DateTime\",\n updated_at as \"updated_at: DateTime\",\n completed_at as \"completed_at: DateTime\"\n FROM tasks\n WHERE is_dismissed_by_user == 0\n ", + "describe": { + "columns": [ + { + "name": "id", + "ordinal": 0, + "type_info": "Text" + }, + { + "name": "task_status", + "ordinal": 1, + "type_info": "Text" + }, + { + "name": "task_type", + "ordinal": 2, + "type_info": "Text" + }, + { + "name": "model_type", + "ordinal": 3, + "type_info": "Text" + }, + { + "name": "provider", + "ordinal": 4, + "type_info": "Text" + }, + { + "name": "provider_job_id", + "ordinal": 5, + "type_info": "Text" + }, + { + "name": "is_batch_generation", + "ordinal": 6, + "type_info": "Int64" + }, + { + "name": "frontend_caller", + "ordinal": 7, + "type_info": "Text" + }, + { + "name": "frontend_subscriber_id", + "ordinal": 8, + "type_info": "Text" + }, + { + "name": "frontend_subscriber_payload", + "ordinal": 9, + "type_info": "Text" + }, + { + "name": "on_complete_primary_media_file_token", + "ordinal": 10, + "type_info": "Text" + }, + { + "name": "on_complete_primary_media_file_class", + "ordinal": 11, + "type_info": "Text" + }, + { + "name": "on_complete_batch_token", + "ordinal": 12, + "type_info": "Text" + }, + { + "name": "on_complete_primary_media_file_cdn_url", + "ordinal": 13, + "type_info": "Text" + }, + { + "name": "on_complete_primary_media_file_thumbnail_url_template", + "ordinal": 14, + "type_info": "Text" + }, + { + "name": "on_complete_directory_location", + "ordinal": 15, + "type_info": "Text" + }, + { + "name": "on_complete_first_file_location", + "ordinal": 16, + "type_info": "Text" + }, + { + "name": "on_failure_type", + "ordinal": 17, + "type_info": "Text" + }, + { + "name": "on_failure_message", + "ordinal": 18, + "type_info": "Text" + }, + { + "name": "created_at: DateTime", + "ordinal": 19, + "type_info": "Int64" + }, + { + "name": "updated_at: DateTime", + "ordinal": 20, + "type_info": "Int64" + }, + { + "name": "completed_at: DateTime", + "ordinal": 21, + "type_info": "Int64" + } + ], + "parameters": { + "Right": 0 + }, + "nullable": [ + false, + false, + false, + true, + true, + true, + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + true + ] + }, + "hash": "14dfb477ee766faa95038946a0383c27bd3fa103928a9c4f795e78ff16faf039" +} diff --git a/.sqlx/query-1e3758851fc8451670f86a9432009b73bdb81de4a08dcaa96a86afb5f9be7a68.json b/.sqlx/query-1e3758851fc8451670f86a9432009b73bdb81de4a08dcaa96a86afb5f9be7a68.json new file mode 100644 index 00000000..5c1b1e3f --- /dev/null +++ b/.sqlx/query-1e3758851fc8451670f86a9432009b73bdb81de4a08dcaa96a86afb5f9be7a68.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET\n task_status = ?,\n on_complete_batch_token = ?,\n on_complete_primary_media_file_token = ?,\n on_complete_primary_media_file_class = ?,\n on_complete_primary_media_file_cdn_url = ?,\n on_complete_primary_media_file_thumbnail_url_template = ?\n WHERE\n provider = ?\n AND provider_job_id = ?\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 8 + }, + "nullable": [] + }, + "hash": "1e3758851fc8451670f86a9432009b73bdb81de4a08dcaa96a86afb5f9be7a68" +} diff --git a/.sqlx/query-30272128d83543d9fbfca930b7cdd4af30adfb4d90f2de044463a111c6340495.json b/.sqlx/query-30272128d83543d9fbfca930b7cdd4af30adfb4d90f2de044463a111c6340495.json new file mode 100644 index 00000000..4be4ed48 --- /dev/null +++ b/.sqlx/query-30272128d83543d9fbfca930b7cdd4af30adfb4d90f2de044463a111c6340495.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET task_status = \"cancelled_by_user\"\n WHERE task_status NOT IN (\n \"complete_success\",\n \"complete_failure\",\n \"dead\",\n \"cancelled_by_user\",\n \"cancelled_by_provider\",\n \"cancelled_by_us\"\n )\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 0 + }, + "nullable": [] + }, + "hash": "30272128d83543d9fbfca930b7cdd4af30adfb4d90f2de044463a111c6340495" +} diff --git a/.sqlx/query-34830ae5f2981a1bb25866aa484ef3ab54a2ba2e9c4ae0600da436899980da67.json b/.sqlx/query-34830ae5f2981a1bb25866aa484ef3ab54a2ba2e9c4ae0600da436899980da67.json new file mode 100644 index 00000000..bbdbf102 --- /dev/null +++ b/.sqlx/query-34830ae5f2981a1bb25866aa484ef3ab54a2ba2e9c4ae0600da436899980da67.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n INSERT INTO tasks (\n id,\n task_status,\n task_type,\n model_type,\n provider,\n provider_job_id,\n is_batch_generation,\n queue_status_url,\n queue_response_url,\n prompt_token,\n frontend_caller,\n frontend_subscriber_id,\n frontend_subscriber_payload\n )\n VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 13 + }, + "nullable": [] + }, + "hash": "34830ae5f2981a1bb25866aa484ef3ab54a2ba2e9c4ae0600da436899980da67" +} diff --git a/.sqlx/query-50a2449b87abed7df3302a74ecd0e8ab87940077a247636680cb09b2fe488321.json b/.sqlx/query-50a2449b87abed7df3302a74ecd0e8ab87940077a247636680cb09b2fe488321.json new file mode 100644 index 00000000..8d5c10f1 --- /dev/null +++ b/.sqlx/query-50a2449b87abed7df3302a74ecd0e8ab87940077a247636680cb09b2fe488321.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET\n task_status = ?,\n on_complete_batch_token = ?,\n on_complete_primary_media_file_token = ?,\n on_complete_primary_media_file_class = ?,\n on_complete_primary_media_file_cdn_url = ?,\n on_complete_primary_media_file_thumbnail_url_template = ?\n WHERE id = ?\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 7 + }, + "nullable": [] + }, + "hash": "50a2449b87abed7df3302a74ecd0e8ab87940077a247636680cb09b2fe488321" +} diff --git a/.sqlx/query-831db74e7eb2bed43f24f9efc275df9b1bac4fd78115a698f8e9faef30e39f4a.json b/.sqlx/query-831db74e7eb2bed43f24f9efc275df9b1bac4fd78115a698f8e9faef30e39f4a.json new file mode 100644 index 00000000..e11ead32 --- /dev/null +++ b/.sqlx/query-831db74e7eb2bed43f24f9efc275df9b1bac4fd78115a698f8e9faef30e39f4a.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET\n on_complete_directory_location = ?,\n on_complete_first_file_location = ?\n WHERE id = ?\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 3 + }, + "nullable": [] + }, + "hash": "831db74e7eb2bed43f24f9efc275df9b1bac4fd78115a698f8e9faef30e39f4a" +} diff --git a/.sqlx/query-9b99ccd0baf9a4b74d8903f63e3a3dcf4c09b75cad978f0532388cbd743b7516.json b/.sqlx/query-9b99ccd0baf9a4b74d8903f63e3a3dcf4c09b75cad978f0532388cbd743b7516.json new file mode 100644 index 00000000..3f2887d4 --- /dev/null +++ b/.sqlx/query-9b99ccd0baf9a4b74d8903f63e3a3dcf4c09b75cad978f0532388cbd743b7516.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET task_status = ?,\n on_failure_type = ?,\n on_failure_message = ?\n WHERE id = ?\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 4 + }, + "nullable": [] + }, + "hash": "9b99ccd0baf9a4b74d8903f63e3a3dcf4c09b75cad978f0532388cbd743b7516" +} diff --git a/.sqlx/query-bc8df0a71de3547cf9e015c7facd8a9856c000a47f91114cc5c2a4aba9c11b47.json b/.sqlx/query-bc8df0a71de3547cf9e015c7facd8a9856c000a47f91114cc5c2a4aba9c11b47.json new file mode 100644 index 00000000..d188077e --- /dev/null +++ b/.sqlx/query-bc8df0a71de3547cf9e015c7facd8a9856c000a47f91114cc5c2a4aba9c11b47.json @@ -0,0 +1,92 @@ +{ + "db_name": "SQLite", + "query": "\n SELECT\n id,\n task_status,\n task_type,\n model_type,\n provider,\n provider_job_id,\n is_batch_generation,\n frontend_caller,\n queue_status_url,\n queue_response_url,\n prompt_token,\n frontend_subscriber_id,\n frontend_subscriber_payload\n FROM tasks\n WHERE\n provider = ?\n AND provider_job_id = ?\n ", + "describe": { + "columns": [ + { + "name": "id", + "ordinal": 0, + "type_info": "Text" + }, + { + "name": "task_status", + "ordinal": 1, + "type_info": "Text" + }, + { + "name": "task_type", + "ordinal": 2, + "type_info": "Text" + }, + { + "name": "model_type", + "ordinal": 3, + "type_info": "Text" + }, + { + "name": "provider", + "ordinal": 4, + "type_info": "Text" + }, + { + "name": "provider_job_id", + "ordinal": 5, + "type_info": "Text" + }, + { + "name": "is_batch_generation", + "ordinal": 6, + "type_info": "Int64" + }, + { + "name": "frontend_caller", + "ordinal": 7, + "type_info": "Text" + }, + { + "name": "queue_status_url", + "ordinal": 8, + "type_info": "Text" + }, + { + "name": "queue_response_url", + "ordinal": 9, + "type_info": "Text" + }, + { + "name": "prompt_token", + "ordinal": 10, + "type_info": "Text" + }, + { + "name": "frontend_subscriber_id", + "ordinal": 11, + "type_info": "Text" + }, + { + "name": "frontend_subscriber_payload", + "ordinal": 12, + "type_info": "Text" + } + ], + "parameters": { + "Right": 2 + }, + "nullable": [ + false, + false, + false, + true, + true, + true, + false, + true, + true, + true, + true, + true, + true + ] + }, + "hash": "bc8df0a71de3547cf9e015c7facd8a9856c000a47f91114cc5c2a4aba9c11b47" +} diff --git a/.sqlx/query-dc0367e9e43c3d7dda3623e77337ab4529eac2192475be7d08589886703ba1cb.json b/.sqlx/query-dc0367e9e43c3d7dda3623e77337ab4529eac2192475be7d08589886703ba1cb.json new file mode 100644 index 00000000..b4ed4996 --- /dev/null +++ b/.sqlx/query-dc0367e9e43c3d7dda3623e77337ab4529eac2192475be7d08589886703ba1cb.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET task_status = ?\n WHERE id = ?\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 2 + }, + "nullable": [] + }, + "hash": "dc0367e9e43c3d7dda3623e77337ab4529eac2192475be7d08589886703ba1cb" +} diff --git a/.sqlx/query-f83018ec5493982659a56576296914f937bb4e75db3a522eb4bda486d5caa402.json b/.sqlx/query-f83018ec5493982659a56576296914f937bb4e75db3a522eb4bda486d5caa402.json new file mode 100644 index 00000000..244607f5 --- /dev/null +++ b/.sqlx/query-f83018ec5493982659a56576296914f937bb4e75db3a522eb4bda486d5caa402.json @@ -0,0 +1,12 @@ +{ + "db_name": "SQLite", + "query": "\n UPDATE tasks\n SET is_dismissed_by_user = 1\n WHERE is_dismissed_by_user != 1\n ", + "describe": { + "columns": [], + "parameters": { + "Right": 0 + }, + "nullable": [] + }, + "hash": "f83018ec5493982659a56576296914f937bb4e75db3a522eb4bda486d5caa402" +} diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..b12fc333 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,73 @@ +# CLAUDE.md + +This file provides guidance for Claude Code when working with the ArtCraftX monorepo. + +## Project Overview + +ArtCraftX is a pared-down desktop application for generating AI image and video. It is written in +Rust (Tauri) and TypeScript (React) and contains desktop and frontend components. + +## Project Structure + +``` +artcraftx/ +├── crates/ # Rust workspace +│ ├── api_clients/ # HTTP clients for calling internal and 3rd party services +│ ├── artcraftx/ # (Important) ArtCraftX, the Tauri desktop app +│ ├── core_types/ # Highest-level shared types: GenerationSource, CredentialId, ... +│ ├── lib/ # Various utility libraries +│ ├── router/ # Provider routing for generation requests (Artcraft, Fal, ...) +│ ├── schema/ # Data definition layer +│ │ ├── local_files_database/ # Separate SQLite DB: content-hash index of local files (thumbnails, dedup) +│ │ ├── sqlite_database/ # Desktop app's "tasks" SQLite database: queries + embedded migrations +│ │ └── sqlite_identifiers/ # Enums and IDs used in sqlite queries as enums or keys +│ ├── testing/ # Test data and test utilities +│ └── vendor/ # Vendored third-party crates (eg. tauri-plugin-http) +├── frontend/ # Nx typescript monorepo for the Tauri desktop app frontend +│ ├── apps/ +│ │ └── artcraft/ # ArtCraftX the Tauri app's frontend. Used with the `artcraftx` Rust crate. +│ └── libs/ # Support libraries, reusable React components, etc. +├── script/ +│ └── artcraftx/ # Launch and build scripts for the desktop app +└── Cargo.toml # Rust monorepo workspace +``` + +## Code Style + +- Rust with no minimum supported version +- A mix of wreq and reqwest for Rust HTTP clients +- SQLx for SQLite (the desktop app's local task database in `sqlite_database`) +- Never use `println!` or `eprintln!` outside of tests; use `log` crate macros instead +- When two crates export the same type name, alias imports with a suffix: `use foo::Bar as BarFoo;` +- Prefer `use` imports over inline fully-qualified paths; only qualify inline for true one-offs or std collisions +- TypeScript with Nx, React, Vite, Zustand, and Three.js +- Use two spaces for indentation + +### File Layout + +Organize for top-to-bottom reading. Important things first, details later. + +- **Constants** at the top (after imports) +- **Structs/enums** next; outer structs above inner sub-structs +- **API types** in order: Request, Response, Error +- **In impl blocks**: constructors first, then public methods, then private helpers +- Private helpers go *below* the methods that call them +- Among helpers: meatier logic above leaf-level formatters +- **In test modules**: constants first, then test cases (grouped into sub-modules when 2+), then helper functions last + +## Markdown + +- **Tables must be space-padded so columns align in plain text.** Markdown + tables are read raw (terminals, diffs, editors) at least as often as + rendered, and condensed tables are unreadable there. Pad every cell to its + column width: + + ```markdown + | Model | Configuration | Credits | Speed | Score | + |--------------|---------------|--------------------|---------| + | Meshy 6 | text or image | 104 | 80.0 | +24 | + | Rodin 2.5 | text or image | 13 | 10.0 | +3 | + ``` + + Not: `| Model | Configuration | Credits | Speed | Score |` packed tight + with varying widths per row. diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 00000000..ead15269 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,9635 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "adler2" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627" + +[[package]] +name = "ahash" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "891477e0c6a8957309ee5c45a6368af3ae14bb510732d2684ffa19af310920f9" +dependencies = [ + "getrandom 0.2.14", + "once_cell", + "version_check", +] + +[[package]] +name = "ahash" +version = "0.8.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a15f179cd60c4584b8a8c596927aadc462e27f2ca70c04e0071964a73ba7a75" +dependencies = [ + "cfg-if", + "getrandom 0.3.1", + "once_cell", + "version_check", + "zerocopy", +] + +[[package]] +name = "aho-corasick" +version = "1.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916" +dependencies = [ + "memchr", +] + +[[package]] +name = "aligned-vec" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4aa90d7ce82d4be67b64039a3d588d38dbcc6736577de4a847025ce5b0c468d1" + +[[package]] +name = "alloc-no-stdlib" +version = "2.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc7bb162ec39d46ab1ca8c77bf72e890535becd1751bb45f64c597edb4c8c6b3" + +[[package]] +name = "alloc-stdlib" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94fb8275041c72129eb51b7d0322c29b8387a0386127718b096429201a5d6ece" +dependencies = [ + "alloc-no-stdlib", +] + +[[package]] +name = "allocator-api2" +version = "0.2.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f" + +[[package]] +name = "android_log-sys" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84521a3cf562bc62942e294181d9eef17eb38ceb8c68677bc49f144e4c3d4f8d" + +[[package]] +name = "android_logger" +version = "0.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6f39be698127218cca460cb624878c9aa4e2b47dba3b277963d2bf00bad263b" +dependencies = [ + "android_log-sys", + "env_filter 0.1.0", + "log", +] + +[[package]] +name = "android_system_properties" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311" +dependencies = [ + "libc", +] + +[[package]] +name = "anstream" +version = "0.6.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43d5b281e737544384e969a5ccad3f1cdd24b48086a0fc1b2a5262a26b8f4f4a" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5192cca8006f1fd4f7237516f40fa183bb07f8fbdfedaa0036de5ea9b0b45e78" + +[[package]] +name = "anstyle-parse" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c03a11a9034d92058ceb6ee011ce58af4a9bf61491aa7e1e59ecd24bd40d22d4" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad186efb764318d35165f1758e7dcef3b10628e26d41a44bc5550652e6804391" +dependencies = [ + "windows-sys 0.52.0", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" +dependencies = [ + "anstyle", + "once_cell_polyfill", + "windows-sys 0.61.2", +] + +[[package]] +name = "anyhow" +version = "1.0.102" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" + +[[package]] +name = "arbitrary" +version = "1.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d036a3c4ab069c7b410a2ce876bd74808d2d0888a82667669f8e783a898bf1" + +[[package]] +name = "arc-swap" +version = "1.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69f7f8c3906b62b754cd5326047894316021dcfe5a194c8ea52bdd94934a3457" + +[[package]] +name = "arg_enum_proc_macro" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ae92a5119aa49cdbcf6b9f893fe4e1d98b04ccbf82ee0584ad948a44a734dea" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "arrayvec" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50" + +[[package]] +name = "artcraft_client" +version = "0.0.1" +dependencies = [ + "anyhow", + "backoff", + "chrono", + "cloudflare_errors", + "cookie", + "core_types", + "errors", + "log", + "mimetypes", + "regex", + "reqwest 0.12.23", + "serde", + "serde_derive", + "serde_json", + "sqlite_identifiers", + "strum", + "tokio", + "toml 1.0.7+spec-1.1.0", + "url", + "url-builder", + "uuid 1.22.0", + "uuid_utils", + "workspace-build-acceleration", +] + +[[package]] +name = "artcraftx" +version = "0.0.1" +dependencies = [ + "anyhow", + "artcraft_client", + "async-trait", + "base64 0.22.1", + "browser_emulation", + "build_metadata", + "bytes", + "chrono", + "cookie_store_wrapper", + "core_types", + "directories", + "dirs", + "discord-rich-presence", + "errors", + "fal_client", + "file_hashing", + "filesys", + "futures", + "grok_consumer_client", + "grok_consumer_statsig", + "higgsfield_client", + "image", + "images", + "indexmap 2.13.0", + "local_files_database", + "log", + "memory_store", + "midjourney_client", + "mimetypes", + "models", + "once_cell", + "os_info", + "primitives", + "rand 0.9.2", + "reqwest 0.12.23", + "router", + "serde", + "serde_derive", + "serde_json", + "serial_test", + "sqlite_database", + "sqlite_identifiers", + "tauri", + "tauri-build", + "tauri-plugin-dialog", + "tauri-plugin-http", + "tauri-plugin-log", + "tauri-plugin-opener", + "tauri-plugin-upload", + "tempdir", + "tempfile", + "thumbnails", + "tokio", + "tokio-util", + "toml 1.0.7+spec-1.1.0", + "url", + "url_utils", + "uuid_utils", + "web_base64", + "workspace-build-acceleration", +] + +[[package]] +name = "assertor" +version = "0.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b02f2af4042fbbed4d5732c517666629512c574c8e2edb5cfe2cf8a86564d52" +dependencies = [ + "num-traits", +] + +[[package]] +name = "async-broadcast" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "435a87a52755b8f27fcf321ac4f04b2802e337c8c4872923137471ec39c37532" +dependencies = [ + "event-listener 5.4.1", + "event-listener-strategy", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-channel" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f2776ead772134d55b62dd45e59a79e21612d85d0af729b8b7d3967d601a62a" +dependencies = [ + "concurrent-queue", + "event-listener 5.4.1", + "event-listener-strategy", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-compression" +version = "0.4.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddb939d66e4ae03cee6091612804ba446b12878410cfa17f785f4dd67d4014e8" +dependencies = [ + "brotli", + "flate2", + "futures-core", + "memchr", + "pin-project-lite", + "tokio", + "zstd", + "zstd-safe", +] + +[[package]] +name = "async-executor" +version = "1.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b10202063978b3351199d68f8b22c4e47e4b1b822f8d43fd862d5ea8c006b29a" +dependencies = [ + "async-task", + "concurrent-queue", + "fastrand", + "futures-lite", + "slab", +] + +[[package]] +name = "async-io" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43a2b323ccce0a1d90b449fd71f2a06ca7faa7c54c2751f06c9bd851fc061059" +dependencies = [ + "async-lock", + "cfg-if", + "concurrent-queue", + "futures-io", + "futures-lite", + "parking", + "polling", + "rustix 0.38.44", + "slab", + "tracing", + "windows-sys 0.59.0", +] + +[[package]] +name = "async-lock" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff6e472cdea888a4bd64f342f09b3f50e1886d32afe8df3d663c01140b811b18" +dependencies = [ + "event-listener 5.4.1", + "event-listener-strategy", + "pin-project-lite", +] + +[[package]] +name = "async-process" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63255f1dc2381611000436537bbedfe83183faa303a5a0edaf191edef06526bb" +dependencies = [ + "async-channel", + "async-io", + "async-lock", + "async-signal", + "async-task", + "blocking", + "cfg-if", + "event-listener 5.4.1", + "futures-lite", + "rustix 0.38.44", + "tracing", +] + +[[package]] +name = "async-recursion" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b43422f69d8ff38f95f1b2bb76517c91589a924d1559a0e935d7c8ce0274c11" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "async-signal" +version = "0.2.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "637e00349800c0bdf8bfc21ebbc0b6524abea702b0da4168ac00d070d0c0b9f3" +dependencies = [ + "async-io", + "async-lock", + "atomic-waker", + "cfg-if", + "futures-core", + "futures-io", + "rustix 0.38.44", + "signal-hook-registry", + "slab", + "windows-sys 0.59.0", +] + +[[package]] +name = "async-task" +version = "4.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b75356056920673b02621b35afd0f7dda9306d03c79a30f5c56c44cf256e3de" + +[[package]] +name = "async-trait" +version = "0.1.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.5", +] + +[[package]] +name = "atk" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "241b621213072e993be4f6f3a9e4b45f65b7e6faad43001be957184b7bb1824b" +dependencies = [ + "atk-sys", + "glib", + "libc", +] + +[[package]] +name = "atk-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5e48b684b0ca77d2bbadeef17424c2ea3c897d44d566a1617e7e8f30614d086" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "atoi" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f28d99ec8bfea296261ca1af174f24225171fea9664ba9003cbebee704810528" +dependencies = [ + "num-traits", +] + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + +[[package]] +name = "autocfg" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0" + +[[package]] +name = "av1-grain" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6678909d8c5d46a42abcf571271e15fdbc0a225e3646cf23762cd415046c78bf" +dependencies = [ + "anyhow", + "arrayvec", + "log", + "nom", + "num-rational", + "v_frame", +] + +[[package]] +name = "avif-serialize" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e335041290c43101ca215eed6f43ec437eb5a42125573f600fc3fa42b9bddd62" +dependencies = [ + "arrayvec", +] + +[[package]] +name = "backoff" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b62ddb9cb1ec0a098ad4bbf9344d0713fa193ae1a80af55febcff2627b6a00c1" +dependencies = [ + "futures-core", + "getrandom 0.2.14", + "instant", + "pin-project-lite", + "rand 0.8.5", +] + +[[package]] +name = "base64" +version = "0.21.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567" + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "base64ct" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8c3c1a368f70d6cf7302d78f8f7093da241fb8e8807c05cc9e51a125895a6d5b" + +[[package]] +name = "bincode" +version = "1.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f45e9417d87227c7a56d22e471c6206462cba514c7590c09aff4cf6d1ddcad" +dependencies = [ + "serde", +] + +[[package]] +name = "bindgen" +version = "0.72.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "993776b509cfb49c750f11b8f07a46fa23e0a1386ffc01fb1e7d343efc387895" +dependencies = [ + "bitflags 2.11.0", + "cexpr", + "clang-sys", + "itertools 0.13.0", + "proc-macro2", + "quote", + "regex", + "rustc-hash", + "shlex", + "syn 2.0.117", +] + +[[package]] +name = "bit-set" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08807e080ed7f9d5433fa9b275196cfc35414f66a0c79d864dc51a0d825231a3" +dependencies = [ + "bit-vec", +] + +[[package]] +name = "bit-vec" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e764a1d40d510daf35e07be9eb06e75770908c27d411ee6c92109c9840eaaf7" + +[[package]] +name = "bit_field" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc827186963e592360843fb5ba4b973e145841266c1357f7180c43526f2e5b61" + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "bitflags" +version = "2.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "843867be96c8daad0d758b57df9392b6d8d271134fce549de6ce169ff98a92af" +dependencies = [ + "serde_core", +] + +[[package]] +name = "bitstream-io" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6099cdc01846bc367c4e7dd630dc5966dccf36b652fae7a74e17b640411a91b2" + +[[package]] +name = "bitvec" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bc2832c24239b0141d5674bb9174f9d68a8b5b3f2753311927c172ca46f7e9c" +dependencies = [ + "funty", + "radium", + "tap", + "wyz", +] + +[[package]] +name = "blake3" +version = "1.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6d9e454fc11f76977dc803893aff6304ed33d6a26efae8696573bea74baa27ae" +dependencies = [ + "arrayvec", + "cc", + "cfg-if", + "constant_time_eq", + "cpufeatures 0.3.1", +] + +[[package]] +name = "block-buffer" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" +dependencies = [ + "generic-array", +] + +[[package]] +name = "block-buffer" +version = "0.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdd35008169921d80bc60d3d0ab416eecb028c4cd653352907921d95084790be" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "block2" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2c132eebf10f5cad5289222520a4a058514204aed6d791f1cf4fe8088b82d15f" +dependencies = [ + "objc2 0.5.2", +] + +[[package]] +name = "block2" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "340d2f0bdb2a43c1d3cd40513185b2bd7def0aa1052f956455114bc98f82dcf2" +dependencies = [ + "objc2 0.6.4", +] + +[[package]] +name = "blocking" +version = "1.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "703f41c54fc768e63e091340b424302bb1c29ef4aa0c7f10fe849dfb114d29ea" +dependencies = [ + "async-channel", + "async-task", + "futures-io", + "futures-lite", + "piper", +] + +[[package]] +name = "boring-sys2" +version = "5.0.0-alpha.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "455d79965f5155dcc88a7abce112c3590883889131b799beda10bf9a813ed669" +dependencies = [ + "bindgen", + "cmake", + "fs_extra", + "fslock", +] + +[[package]] +name = "boring2" +version = "5.0.0-alpha.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "183ccc3854411c035410dcdbffafca62084f3a6c33f013c77e83c025d2a08a28" +dependencies = [ + "bitflags 2.11.0", + "boring-sys2", + "foreign-types 0.5.0", + "libc", + "openssl-macros", +] + +[[package]] +name = "borsh" +version = "1.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5430e3be710b68d984d1391c854eb431a9d548640711faa54eecb1df93db91cc" +dependencies = [ + "borsh-derive", + "cfg_aliases", +] + +[[package]] +name = "borsh-derive" +version = "1.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8b668d39970baad5356d7c83a86fee3a539e6f93bf6764c97368243e17a0487" +dependencies = [ + "once_cell", + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "brotli" +version = "8.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4bd8b9603c7aa97359dbd97ecf258968c95f3adddd6db2f7e7a5bef101c84560" +dependencies = [ + "alloc-no-stdlib", + "alloc-stdlib", + "brotli-decompressor", +] + +[[package]] +name = "brotli-decompressor" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "874bb8112abecc98cbd6d81ea4fa7e94fb9449648c93cc89aa40c81c24d7de03" +dependencies = [ + "alloc-no-stdlib", + "alloc-stdlib", +] + +[[package]] +name = "browser_emulation" +version = "0.0.1" +dependencies = [ + "workspace-build-acceleration", + "wreq", + "wreq-util", +] + +[[package]] +name = "bstr" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63044e1ae8e69f3b5a92c736ca6269b8d12fa7efe39bf34ddb06d102cf0e2cab" +dependencies = [ + "memchr", + "regex-automata", + "serde", +] + +[[package]] +name = "build-info" +version = "0.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "288657edd15bfa5a7f30ca3b123c1af2c503eaf218e517fa10bc9063dbc2ad99" +dependencies = [ + "bincode", + "build-info-common", + "build-info-proc", +] + +[[package]] +name = "build-info-build" +version = "0.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3146483d5bc5081ec26f9c4e60232e770980d750b2802d6cc2563cded665cc73" +dependencies = [ + "anyhow", + "base64 0.22.1", + "bincode", + "build-info-common", + "cargo_metadata", + "chrono", + "git2", + "glob", + "pretty_assertions", + "rustc_version", + "serde_json", + "zstd", +] + +[[package]] +name = "build-info-common" +version = "0.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8524ad59f5958f37f95e66bf6c9a8fa8440c4f56c069247c44244434cfca3eb1" +dependencies = [ + "chrono", + "derive_more", + "semver", + "serde", +] + +[[package]] +name = "build-info-proc" +version = "0.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b58fb02636d968e8327d84a5a256df9704ac27a1eda98429c35dbe50a278f69" +dependencies = [ + "anyhow", + "base64 0.22.1", + "bincode", + "build-info-common", + "chrono", + "num-bigint", + "num-traits", + "proc-macro-error2", + "proc-macro2", + "quote", + "serde_json", + "syn 2.0.117", + "zstd", +] + +[[package]] +name = "build_metadata" +version = "0.0.1" +dependencies = [ + "build-info", + "build-info-build", + "workspace-build-acceleration", +] + +[[package]] +name = "built" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73848a43c5d63a1251d17adf6c2bf78aa94830e60a335a95eeea45d6ba9e1e4d" + +[[package]] +name = "bumpalo" +version = "3.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "79296716171880943b8470b5f8d03aa55eb2e645a4874bdbb28adb49162e012c" + +[[package]] +name = "byte-unit" +version = "5.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1cd29c3c585209b0cbc7309bfe3ed7efd8c84c21b7af29c8bfae908f8777174" +dependencies = [ + "rust_decimal", + "serde", + "utf8-width", +] + +[[package]] +name = "bytecheck" +version = "0.6.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23cdc57ce23ac53c931e88a43d06d070a6fd142f2617be5855eb75efc9beb1c2" +dependencies = [ + "bytecheck_derive", + "ptr_meta", + "simdutf8", +] + +[[package]] +name = "bytecheck_derive" +version = "0.6.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3db406d29fbcd95542e92559bed4d8ad92636d1ca8b3b72ede10b4bcc010e659" +dependencies = [ + "proc-macro2", + "quote", + "syn 1.0.109", +] + +[[package]] +name = "bytemuck" +version = "1.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78834c15cb5d5efe3452d58b1e8ba890dd62d21907f867f383358198e56ebca5" + +[[package]] +name = "byteorder" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" + +[[package]] +name = "byteorder-lite" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f1fe948ff07f4bd06c30984e69f5b4899c516a3ef74f34df92a2df2ab535495" + +[[package]] +name = "bytes" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33" +dependencies = [ + "serde", +] + +[[package]] +name = "cairo-rs" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ca26ef0159422fb77631dc9d17b102f253b876fe1586b03b803e63a309b4ee2" +dependencies = [ + "bitflags 2.11.0", + "cairo-sys-rs", + "glib", + "libc", + "once_cell", + "thiserror 1.0.63", +] + +[[package]] +name = "cairo-sys-rs" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "685c9fa8e590b8b3d678873528d83411db17242a73fccaed827770ea0fedda51" +dependencies = [ + "glib-sys", + "libc", + "system-deps", +] + +[[package]] +name = "camino" +version = "1.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b96ec4966b5813e2c0507c1f86115c8c5abaadc3980879c3424042a02fd1ad3" +dependencies = [ + "serde", +] + +[[package]] +name = "cargo-platform" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e35af189006b9c0f00a064685c727031e3ed2d8020f7ba284d78cc2671bd36ea" +dependencies = [ + "serde", +] + +[[package]] +name = "cargo_metadata" +version = "0.19.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8769706aad5d996120af43197bf46ef6ad0fda35216b4505f926a365a232d924" +dependencies = [ + "camino", + "cargo-platform", + "semver", + "serde", + "serde_json", + "thiserror 2.0.18", +] + +[[package]] +name = "cargo_toml" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "02260d489095346e5cafd04dea8e8cb54d1d74fcd759022a9b72986ebe9a1257" +dependencies = [ + "serde", + "toml 0.8.23", +] + +[[package]] +name = "cc" +version = "1.2.56" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aebf35691d1bfb0ac386a69bac2fde4dd276fb618cf8bf4f5318fe285e821bb2" +dependencies = [ + "find-msvc-tools", + "jobserver", + "libc", + "shlex", +] + +[[package]] +name = "cesu8" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6d43a04d8753f35258c91f8ec639f792891f748a1edbd759cf1dcea3382ad83c" + +[[package]] +name = "cexpr" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6fac387a98bb7c37292057cffc56d62ecb629900026402633ae9160df93a8766" +dependencies = [ + "nom", +] + +[[package]] +name = "cfb" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d38f2da7a0a2c4ccf0065be06397cc26a81f4e528be095826eee9d4adbb8c60f" +dependencies = [ + "byteorder", + "fnv", + "uuid 1.22.0", +] + +[[package]] +name = "cfg-expr" +version = "0.15.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d067ad48b8650848b989a59a86c6c36a995d02d2bf778d45c3c5d57bc2718f02" +dependencies = [ + "smallvec", + "target-lexicon", +] + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "cfg_aliases" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724" + +[[package]] +name = "chrono" +version = "0.4.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c673075a2e0e5f4a1dde27ce9dee1ea4558c7ffe648f576438a20ca1d2acc4b0" +dependencies = [ + "iana-time-zone", + "js-sys", + "num-traits", + "serde", + "wasm-bindgen", + "windows-link 0.2.1", +] + +[[package]] +name = "ciborium" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42e69ffd6f0917f5c029256a24d0161db17cea3997d185db0d35926308770f0e" +dependencies = [ + "ciborium-io", + "ciborium-ll", + "serde", +] + +[[package]] +name = "ciborium-io" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "05afea1e0a06c9be33d539b876f1ce3692f4afea2cb41f740e7743225ed1c757" + +[[package]] +name = "ciborium-ll" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57663b653d948a338bfb3eeba9bb2fd5fcfaecb9e199e87e1eda4d9e8b240fd9" +dependencies = [ + "ciborium-io", + "half", +] + +[[package]] +name = "clang-sys" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b023947811758c97c59bf9d1c188fd619ad4718dcaa767947df1cadb14f39f4" +dependencies = [ + "glob", + "libc", + "libloading 0.8.6", +] + +[[package]] +name = "cloudflare_errors" +version = "0.0.1" +dependencies = [ + "log", + "workspace-build-acceleration", +] + +[[package]] +name = "cloudflare_mitigation" +version = "0.0.1" +dependencies = [ + "browser_emulation", + "cloudflare_errors", + "once_cell", + "workspace-build-acceleration", + "wreq", +] + +[[package]] +name = "cmake" +version = "0.1.57" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75443c44cd6b379beb8c5b45d85d0773baf31cce901fe7bb252f4eff3008ef7d" +dependencies = [ + "cc", +] + +[[package]] +name = "color_quant" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d7b894f5411737b7867f4827955924d7c254fc9f4d91a6aad6b097804b1018b" + +[[package]] +name = "colorchoice" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b6a852b24ab71dffc585bcb46eaf7959d175cb865a7152e35b348d1b2960422" + +[[package]] +name = "combine" +version = "4.6.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35ed6e9d84f0b51a7f52daf1c7d71dd136fd7a3f41a8462b8cdb8c78d920fad4" +dependencies = [ + "bytes", + "memchr", +] + +[[package]] +name = "concurrent-queue" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ca0197aee26d1ae37445ee532fefce43251d24cc7c166799f4d46817f1d3973" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "const-oid" +version = "0.9.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2459377285ad874054d797f3ccebf984978aa39129f6eafde5cdc8315b612f8" + +[[package]] +name = "const-oid" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0dabb6555f92fb9ee4140454eb5dcd14c7960e1225c6d1a6cc361f032947713e" + +[[package]] +name = "constant_time_eq" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d52eff69cd5e647efe296129160853a42795992097e8af39800e1060caeea9b" + +[[package]] +name = "cookie" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ddef33a339a91ea89fb53151bd0a4689cfce27055c291dfa69945475d22c747" +dependencies = [ + "percent-encoding", + "time", + "version_check", +] + +[[package]] +name = "cookie_store" +version = "0.21.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2eac901828f88a5241ee0600950ab981148a18f2f756900ffba1b125ca6a3ef9" +dependencies = [ + "cookie", + "document-features", + "idna", + "log", + "publicsuffix", + "serde", + "serde_derive", + "serde_json", + "time", + "url", +] + +[[package]] +name = "cookie_store_wrapper" +version = "0.0.2" +dependencies = [ + "chrono", + "cookie_store", + "log", + "serde", + "serde_derive", + "serde_json", + "time", + "toml 1.0.7+spec-1.1.0", + "url", + "workspace-build-acceleration", + "wreq", +] + +[[package]] +name = "core-foundation" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b55271e5c8c478ad3f38ad24ef34923091e0548492a266d19b3c0b4d82574c63" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" + +[[package]] +name = "core-graphics" +version = "0.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa95a34622365fa5bbf40b20b75dba8dfa8c94c734aea8ac9a5ca38af14316f1" +dependencies = [ + "bitflags 2.11.0", + "core-foundation 0.10.0", + "core-graphics-types", + "foreign-types 0.5.0", + "libc", +] + +[[package]] +name = "core-graphics" +version = "0.25.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "064badf302c3194842cf2c5d61f56cc88e54a759313879cdf03abdd27d0c3b97" +dependencies = [ + "bitflags 2.11.0", + "core-foundation 0.10.0", + "core-graphics-types", + "foreign-types 0.5.0", + "libc", +] + +[[package]] +name = "core-graphics-types" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d44a101f213f6c4cdc1853d4b78aef6db6bdfa3468798cc1d9912f4735013eb" +dependencies = [ + "bitflags 2.11.0", + "core-foundation 0.10.0", + "libc", +] + +[[package]] +name = "core_types" +version = "0.0.1" +dependencies = [ + "serde", + "serde_derive", + "serde_json", + "strum", + "ulid", + "workspace-build-acceleration", +] + +[[package]] +name = "cpufeatures" +version = "0.2.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53fe5e26ff1b7aef8bca9c6080520cfb8d9333c7568e1829cef191a9723e5504" +dependencies = [ + "libc", +] + +[[package]] +name = "cpufeatures" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566" +dependencies = [ + "libc", +] + +[[package]] +name = "crc" +version = "3.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86ec7a15cbe22e59248fc7eadb1907dab5ba09372595da4d73dd805ed4417dfe" +dependencies = [ + "crc-catalog", +] + +[[package]] +name = "crc-catalog" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19d374276b40fb8bbdee95aef7c7fa6b5316ec764510eb64b8dd0e2ed0d7e7f5" + +[[package]] +name = "crc32fast" +version = "1.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a97769d94ddab943e4510d138150169a2758b5ef3eb191a9ee688de3e23ef7b3" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "crossbeam-channel" +version = "0.5.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33480d6946193aa8033910124896ca395333cae7e2d1113d1fef6c3272217df2" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-deque" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce6fd6f855243022dcecf8702fef0c297d4338e226845fe067f6341ad9fa0cef" +dependencies = [ + "cfg-if", + "crossbeam-epoch", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-epoch" +version = "0.9.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae211234986c545741a7dc064309f67ee1e5ad243d0e48335adc0484d960bcc7" +dependencies = [ + "autocfg", + "cfg-if", + "crossbeam-utils", + "memoffset", + "scopeguard", +] + +[[package]] +name = "crossbeam-queue" +version = "0.3.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1cfb3ea8a53f37c40dea2c7bedcbd88bdfae54f5e2175d6ecaff1c988353add" +dependencies = [ + "cfg-if", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-utils" +version = "0.8.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22ec99545bb0ed0ea7bb9b8e1e9122ea386ff8a48c0922e43f36d45ab09e0e80" + +[[package]] +name = "crunchy" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7a81dae078cea95a014a339291cec439d2f232ebe854a9d672b796c6afafa9b7" + +[[package]] +name = "crypto-common" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3" +dependencies = [ + "generic-array", + "typenum", +] + +[[package]] +name = "crypto-common" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77727bb15fa921304124b128af125e7e3b968275d1b108b379190264f4423710" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "cssparser" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e901edd733a1472f944a45116df3f846f54d37e67e68640ac8bb69689aca2aa" +dependencies = [ + "cssparser-macros", + "dtoa-short", + "itoa", + "phf 0.11.2", + "smallvec", +] + +[[package]] +name = "cssparser" +version = "0.36.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dae61cf9c0abb83bd659dab65b7e4e38d8236824c85f0f804f173567bda257d2" +dependencies = [ + "cssparser-macros", + "dtoa-short", + "itoa", + "phf 0.13.1", + "smallvec", +] + +[[package]] +name = "cssparser-macros" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13b588ba4ac1a99f7f2964d24b3d896ddc6bf847ee3855dbd4366f058cfcd331" +dependencies = [ + "quote", + "syn 2.0.117", +] + +[[package]] +name = "ctor" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "352d39c2f7bef1d6ad73db6f5160efcaed66d94ef8c6c573a8410c00bf909a98" +dependencies = [ + "ctor-proc-macro", + "dtor", +] + +[[package]] +name = "ctor-proc-macro" +version = "0.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52560adf09603e58c9a7ee1fe1dcb95a16927b17c127f0ac02d6e768a0e25bc1" + +[[package]] +name = "darling" +version = "0.20.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f63b86c8a8826a49b8c21f08a2d07338eec8d900540f8630dc76284be802989" +dependencies = [ + "darling_core", + "darling_macro", +] + +[[package]] +name = "darling_core" +version = "0.20.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95133861a8032aaea082871032f5815eb9e98cef03fa916ab4500513994df9e5" +dependencies = [ + "fnv", + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 2.0.117", +] + +[[package]] +name = "darling_macro" +version = "0.20.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d336a2a514f6ccccaa3e09b02d41d35330c07ddf03a62165fcec10bb561c7806" +dependencies = [ + "darling_core", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "data-encoding" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e962a19be5cfc3f3bf6dd8f61eb50107f356ad6270fbb3ed41476571db78be5" + +[[package]] +name = "data-url" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c297a1c74b71ae29df00c3e22dd9534821d60eb9af5a0192823fa2acea70c2a" + +[[package]] +name = "datadome_errors" +version = "0.0.1" +dependencies = [ + "log", + "serde_json", + "workspace-build-acceleration", +] + +[[package]] +name = "datadome_mitigation" +version = "0.0.1" +dependencies = [ + "browser_emulation", + "datadome_errors", + "workspace-build-acceleration", +] + +[[package]] +name = "dbus" +version = "0.9.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b942602992bb7acfd1f51c49811c58a610ef9181b6e66f3e519d79b540a3bf73" +dependencies = [ + "libc", + "libdbus-sys", + "windows-sys 0.61.2", +] + +[[package]] +name = "der" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fffa369a668c8af7dbf8b5e56c9f744fbd399949ed171606040001947de40b1c" +dependencies = [ + "const-oid 0.9.6", + "pem-rfc7468", + "zeroize", +] + +[[package]] +name = "deranged" +version = "0.3.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b42b6fa04a440b495c8b04d0e71b707c585f83cb9cb28cf8cd0d976c315e31b4" +dependencies = [ + "powerfmt", + "serde", +] + +[[package]] +name = "derive_more" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "093242cf7570c207c83073cf82f79706fe7b8317e98620a47d5be7c3d8497678" +dependencies = [ + "derive_more-impl", +] + +[[package]] +name = "derive_more-impl" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bda628edc44c4bb645fbe0f758797143e4e07926f7ebf4e9bdfbd3d2ce621df3" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", + "unicode-xid", +] + +[[package]] +name = "destructure_traitobject" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c877555693c14d2f84191cfd3ad8582790fc52b5e2274b40b59cf5f5cea25c7" + +[[package]] +name = "diff" +version = "0.1.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8" + +[[package]] +name = "digest" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292" +dependencies = [ + "block-buffer 0.10.4", + "const-oid 0.9.6", + "crypto-common 0.1.6", + "subtle", +] + +[[package]] +name = "digest" +version = "0.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4850db49bf08e663084f7fb5c87d202ef91a3907271aff24a94eb97ff039153c" +dependencies = [ + "block-buffer 0.12.0", + "const-oid 0.10.1", + "crypto-common 0.2.1", +] + +[[package]] +name = "directories" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16f5094c54661b38d03bd7e50df373292118db60b585c08a411c6d840017fe7d" +dependencies = [ + "dirs-sys", +] + +[[package]] +name = "dirs" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3e8aa94d75141228480295a7d0e7feb620b1a5ad9f12bc40be62411e38cce4e" +dependencies = [ + "dirs-sys", +] + +[[package]] +name = "dirs-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab" +dependencies = [ + "libc", + "option-ext", + "redox_users", + "windows-sys 0.61.2", +] + +[[package]] +name = "discord-rich-presence" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "90c55d69cab17c19677ce3a5f8face993a9e6eaf847fecac3547f3a3ff4a2494" +dependencies = [ + "log", + "serde", + "serde_derive", + "serde_json", + "serde_repr", + "thiserror 2.0.18", + "uuid 0.8.2", +] + +[[package]] +name = "dispatch2" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89a09f22a6c6069a18470eb92d2298acf25463f14256d24778e1230d789a2aec" +dependencies = [ + "bitflags 2.11.0", + "block2 0.6.1", + "libc", + "objc2 0.6.4", +] + +[[package]] +name = "displaydoc" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "487585f4d0c6655fe74905e2504d8ad6908e4db67f744eb140876906c2f3175d" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "dlopen2" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b54f373ccf864bf587a89e880fb7610f8d73f3045f13580948ccbcaff26febff" +dependencies = [ + "dlopen2_derive", + "libc", + "once_cell", + "winapi", +] + +[[package]] +name = "dlopen2_derive" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2b99bf03862d7f545ebc28ddd33a665b50865f4dfd84031a393823879bd4c54" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "document-features" +version = "0.2.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95249b50c6c185bee49034bcb378a49dc2b5dff0be90ff6616d31d64febab05d" +dependencies = [ + "litrs", +] + +[[package]] +name = "dom_query" +version = "0.20.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2646c2bb4993c86006961293208b69d86a2b254356889ddad826e9df3f684f9" +dependencies = [ + "bit-set", + "cssparser 0.35.0", + "foldhash 0.1.5", + "html5ever 0.35.0", + "precomputed-hash", + "selectors 0.30.0", + "tendril 0.4.3", +] + +[[package]] +name = "dom_query" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521e380c0c8afb8d9a1e83a1822ee03556fc3e3e7dbc1fd30be14e37f9cb3f89" +dependencies = [ + "bit-set", + "cssparser 0.36.0", + "foldhash 0.2.0", + "html5ever 0.38.0", + "precomputed-hash", + "selectors 0.36.1", + "tendril 0.5.0", +] + +[[package]] +name = "dotenvy" +version = "0.15.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1aaf95b3e5c8f23aa320147307562d361db0ae0d51242340f558153b4eb2439b" + +[[package]] +name = "dpi" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f25c0e292a7ca6d6498557ff1df68f32c99850012b6ea401cf8daf771f22ff53" +dependencies = [ + "serde", +] + +[[package]] +name = "dtoa" +version = "1.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dcbb2bf8e87535c23f7a8a321e364ce21462d0ff10cb6407820e8e96dfff6653" + +[[package]] +name = "dtoa-short" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dbaceec3c6e4211c79e7b1800fb9680527106beb2f9c51904a3210c03a448c74" +dependencies = [ + "dtoa", +] + +[[package]] +name = "dtor" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1057d6c64987086ff8ed0fd3fbf377a6b7d205cc7715868cd401705f715cbe4" +dependencies = [ + "dtor-proc-macro", +] + +[[package]] +name = "dtor-proc-macro" +version = "0.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f678cf4a922c215c63e0de95eb1ff08a958a81d47e485cf9da1e27bf6305cfa5" + +[[package]] +name = "dunce" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813" + +[[package]] +name = "dyn-clone" +version = "1.0.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "545b22097d44f8a9581187cdf93de7a71e4722bf51200cfaba810865b49a495d" + +[[package]] +name = "ego-tree" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2972feb8dffe7bc8c5463b1dacda1b0dfbed3710e50f977d965429692d74cd8" + +[[package]] +name = "either" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3dca9240753cf90908d7e4aac30f630662b02aebaa1b58a3cadabdb23385b58b" +dependencies = [ + "serde", +] + +[[package]] +name = "embed-resource" +version = "3.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7fbc6e0d8e0c03a655b53ca813f0463d2c956bc4db8138dbc89f120b066551e3" +dependencies = [ + "cc", + "memchr", + "rustc_version", + "toml 0.8.23", + "vswhom", + "winreg", +] + +[[package]] +name = "embed_plist" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7" + +[[package]] +name = "encoding_rs" +version = "0.8.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b45de904aa0b010bce2ab45264d0631681847fa7b6f2eaa7dab7619943bc4f59" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "endi" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3d8a32ae18130a3c84dd492d4215c3d913c3b07c6b63c2eb3eb7ff1101ab7bf" + +[[package]] +name = "enumflags2" +version = "0.7.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba2f4b465f5318854c6f8dd686ede6c0a9dc67d4b1ac241cf0eb51521a309147" +dependencies = [ + "enumflags2_derive", + "serde", +] + +[[package]] +name = "enumflags2_derive" +version = "0.7.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc4caf64a58d7a6d65ab00639b046ff54399a39f5f2554728895ace4b297cd79" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "env" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bc95de49ad098572c02d3fbf368c9a020bfff5ae78483685b77f51d8a7e9486d" +dependencies = [ + "num_threads", +] + +[[package]] +name = "env_filter" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a009aa4810eb158359dda09d0c87378e4bbb89b5a801f016885a4707ba24f7ea" +dependencies = [ + "log", + "regex", +] + +[[package]] +name = "env_filter" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7a1c3cc8e57274ec99de65301228b537f1e4eedc1b8e0f9411c6caac8ae7308f" +dependencies = [ + "log", + "regex", +] + +[[package]] +name = "env_logger" +version = "0.11.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2daee4ea451f429a58296525ddf28b45a3b64f1acf6587e2067437bb11e218d" +dependencies = [ + "anstream", + "anstyle", + "env_filter 1.0.0", + "jiff", + "log", +] + +[[package]] +name = "equivalent" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5" + +[[package]] +name = "erased-serde" +version = "0.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24e2389d65ab4fab27dc2a5de7b191e1f6617d1f1c8855c0dc569c94a4cbb18d" +dependencies = [ + "serde", + "typeid", +] + +[[package]] +name = "errno" +version = "0.3.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33d852cb9b869c2a9b3df2f71a3074817f01e1844f839a144f5fcef059a4eb5d" +dependencies = [ + "libc", + "windows-sys 0.59.0", +] + +[[package]] +name = "errors" +version = "0.0.1" +dependencies = [ + "anyhow", + "workspace-build-acceleration", +] + +[[package]] +name = "etcetera" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "136d1b5283a1ab77bd9257427ffd09d8667ced0570b6f938942bc7568ed5b943" +dependencies = [ + "cfg-if", + "home", + "windows-sys 0.48.0", +] + +[[package]] +name = "event-listener" +version = "2.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0206175f82b8d6bf6652ff7d71a1e27fd2e4efde587fd368662814d6ec1d9ce0" + +[[package]] +name = "event-listener" +version = "5.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e13b66accf52311f30a0db42147dadea9850cb48cd070028831ae5f5d4b856ab" +dependencies = [ + "concurrent-queue", + "parking", + "pin-project-lite", +] + +[[package]] +name = "event-listener-strategy" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93" +dependencies = [ + "event-listener 5.4.1", + "pin-project-lite", +] + +[[package]] +name = "exr" +version = "1.73.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f83197f59927b46c04a183a619b7c29df34e63e63c7869320862268c0ef687e0" +dependencies = [ + "bit_field", + "half", + "lebe", + "miniz_oxide", + "rayon-core", + "smallvec", + "zune-inflate", +] + +[[package]] +name = "fal_client" +version = "0.0.1" +dependencies = [ + "anyhow", + "errors", + "file_to_base64_url", + "futures", + "log", + "reqwest 0.12.23", + "serde", + "serde_json", + "strum", + "test_data", + "test_utils", + "thiserror 2.0.18", + "tokio", + "url", + "workspace-build-acceleration", +] + +[[package]] +name = "fastrand" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be" + +[[package]] +name = "fdeflate" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e6853b52649d4ac5c0bd02320cddc5ba956bdb407c4b75a2c6b75bf51500f8c" +dependencies = [ + "simd-adler32", +] + +[[package]] +name = "fern" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4316185f709b23713e41e3195f90edef7fb00c3ed4adc79769cf09cc762a3b29" +dependencies = [ + "log", +] + +[[package]] +name = "field-offset" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38e2275cc4e4fc009b0669731a1e5ab7ebf11f469eaede2bab9309a5b4d6057f" +dependencies = [ + "memoffset", + "rustc_version", +] + +[[package]] +name = "file_hashing" +version = "0.0.1" +dependencies = [ + "blake3", + "tempfile", + "workspace-build-acceleration", +] + +[[package]] +name = "file_to_base64_url" +version = "0.0.1" +dependencies = [ + "anyhow", + "base64 0.22.1", + "errors", + "mimetypes", + "test_utils", + "workspace-build-acceleration", +] + +[[package]] +name = "filesys" +version = "0.0.1" +dependencies = [ + "errors", + "log", + "test_utils", + "walkdir", + "workspace-build-acceleration", +] + +[[package]] +name = "find-msvc-tools" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5baebc0774151f905a1a2cc41989300b1e6fbb29aff0ceffa1064fdd3088d582" + +[[package]] +name = "finl_unicode" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8fcfdc7a0362c9f4444381a9e697c79d435fe65b52a37466fc2c1184cee9edc6" + +[[package]] +name = "flate2" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a3d7db9596fecd151c5f638c0ee5d5bd487b6e0ea232e5dc96d5250f6f94b1d" +dependencies = [ + "crc32fast", + "miniz_oxide", +] + +[[package]] +name = "flume" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "55ac459de2512911e4b674ce33cf20befaba382d05b62b008afc1c8b57cbf181" +dependencies = [ + "futures-core", + "futures-sink", + "spin 0.9.8", +] + +[[package]] +name = "fnv" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" + +[[package]] +name = "foldhash" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" + +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + +[[package]] +name = "foreign-types" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1" +dependencies = [ + "foreign-types-shared 0.1.1", +] + +[[package]] +name = "foreign-types" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d737d9aa519fb7b749cbc3b962edcf310a8dd1f4b67c91c4f83975dbdd17d965" +dependencies = [ + "foreign-types-macros", + "foreign-types-shared 0.3.1", +] + +[[package]] +name = "foreign-types-macros" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a5c6c585bc94aaf2c7b51dd4c2ba22680844aba4c687be581871a6f518c5742" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "foreign-types-shared" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" + +[[package]] +name = "foreign-types-shared" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa9a19cbb55df58761df49b23516a86d432839add4af60fc256da840f66ed35b" + +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "fs_extra" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" + +[[package]] +name = "fslock" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04412b8935272e3a9bae6f48c7bfff74c2911f60525404edfdd28e49884c3bfb" +dependencies = [ + "libc", + "winapi", +] + +[[package]] +name = "fuchsia-cprng" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a06f77d526c1a601b7c4cdd98f54b5eaabffc14d5f2f0296febdc7f357c6d3ba" + +[[package]] +name = "funty" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6d5a32815ae3f33302d95fdcb2ce17862f8c65363dcfd29360480ba1001fc9c" + +[[package]] +name = "futf" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df420e2e84819663797d1ec6544b13c5be84629e7bb00dc960d6917db2987843" +dependencies = [ + "mac", + "new_debug_unreachable", +] + +[[package]] +name = "futures" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b147ee9d1f6d097cef9ce628cd2ee62288d963e16fb287bd9286455b241382d" +dependencies = [ + "futures-channel", + "futures-core", + "futures-executor", + "futures-io", + "futures-sink", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-channel" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07bbe89c50d7a535e539b8c17bc0b49bdb77747034daa8087407d655f3f7cc1d" +dependencies = [ + "futures-core", + "futures-sink", +] + +[[package]] +name = "futures-core" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e3450815272ef58cec6d564423f6e755e25379b217b0bc688e295ba24df6b1d" + +[[package]] +name = "futures-executor" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf29c38818342a3b26b5b923639e7b1f4a61fc5e76102d4b1981c6dc7a7579d" +dependencies = [ + "futures-core", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-intrusive" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d930c203dd0b6ff06e0201a4a2fe9149b43c684fd4420555b26d21b1a02956f" +dependencies = [ + "futures-core", + "lock_api", + "parking_lot", +] + +[[package]] +name = "futures-io" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cecba35d7ad927e23624b22ad55235f2239cfa44fd10428eecbeba6d6a717718" + +[[package]] +name = "futures-lite" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f5edaec856126859abb19ed65f39e90fea3a9574b9707f13539acf4abf7eb532" +dependencies = [ + "fastrand", + "futures-core", + "futures-io", + "parking", + "pin-project-lite", +] + +[[package]] +name = "futures-macro" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e835b70203e41293343137df5c0664546da5745f82ec9b84d40be8336958447b" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "futures-sink" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c39754e157331b013978ec91992bde1ac089843443c49cbc7f46150b0fad0893" + +[[package]] +name = "futures-task" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "037711b3d59c33004d3856fbdc83b99d4ff37a24768fa1be9ce3538a1cde4393" + +[[package]] +name = "futures-util" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "389ca41296e6190b48053de0321d02a77f32f8a5d2461dd38762c0593805c6d6" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-macro", + "futures-sink", + "futures-task", + "memchr", + "pin-project-lite", + "slab", +] + +[[package]] +name = "fxhash" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c31b6d751ae2c7f11320402d34e41349dd1016f8d5d45e48c4312bc8625af50c" +dependencies = [ + "byteorder", +] + +[[package]] +name = "gdk" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9f245958c627ac99d8e529166f9823fb3b838d1d41fd2b297af3075093c2691" +dependencies = [ + "cairo-rs", + "gdk-pixbuf", + "gdk-sys", + "gio", + "glib", + "libc", + "pango", +] + +[[package]] +name = "gdk-pixbuf" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50e1f5f1b0bfb830d6ccc8066d18db35c487b1b2b1e8589b5dfe9f07e8defaec" +dependencies = [ + "gdk-pixbuf-sys", + "gio", + "glib", + "libc", + "once_cell", +] + +[[package]] +name = "gdk-pixbuf-sys" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9839ea644ed9c97a34d129ad56d38a25e6756f99f3a88e15cd39c20629caf7" +dependencies = [ + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "gdk-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c2d13f38594ac1e66619e188c6d5a1adb98d11b2fcf7894fc416ad76aa2f3f7" +dependencies = [ + "cairo-sys-rs", + "gdk-pixbuf-sys", + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "pango-sys", + "pkg-config", + "system-deps", +] + +[[package]] +name = "gdkwayland-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "140071d506d223f7572b9f09b5e155afbd77428cd5cc7af8f2694c41d98dfe69" +dependencies = [ + "gdk-sys", + "glib-sys", + "gobject-sys", + "libc", + "pkg-config", + "system-deps", +] + +[[package]] +name = "gdkx11" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3caa00e14351bebbc8183b3c36690327eb77c49abc2268dd4bd36b856db3fbfe" +dependencies = [ + "gdk", + "gdkx11-sys", + "gio", + "glib", + "libc", + "x11", +] + +[[package]] +name = "gdkx11-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e2e7445fe01ac26f11601db260dd8608fe172514eb63b3b5e261ea6b0f4428d" +dependencies = [ + "gdk-sys", + "glib-sys", + "libc", + "system-deps", + "x11", +] + +[[package]] +name = "generic-array" +version = "0.14.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a" +dependencies = [ + "typenum", + "version_check", +] + +[[package]] +name = "getopts" +version = "0.2.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfe4fbac503b8d1f88e6676011885f34b7174f46e59956bba534ba83abded4df" +dependencies = [ + "unicode-width", +] + +[[package]] +name = "getrandom" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94b22e06ecb0110981051723910cbf0b5f5e09a2062dd7663334ee79a9d1286c" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi 0.11.0+wasi-snapshot-preview1", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43a49c392881ce6d5c3b8cb70f98717b7c07aabbdff06687b9030dbfbe2725f8" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi 0.13.3+wasi-0.2.2", + "wasm-bindgen", + "windows-targets 0.52.6", +] + +[[package]] +name = "getrandom" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "139ef39800118c7683f2fd3c98c1b23c09ae076556b435f8e9064ae108aaeeec" +dependencies = [ + "cfg-if", + "libc", + "r-efi", + "wasip2", + "wasip3", +] + +[[package]] +name = "gif" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fb2d69b19215e18bb912fa30f7ce15846e301408695e44e0ef719f1da9e19f2" +dependencies = [ + "color_quant", + "weezl", +] + +[[package]] +name = "gio" +version = "0.18.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4fc8f532f87b79cbc51a79748f16a6828fb784be93145a322fa14d06d354c73" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-util", + "gio-sys", + "glib", + "libc", + "once_cell", + "pin-project-lite", + "smallvec", + "thiserror 1.0.63", +] + +[[package]] +name = "gio-sys" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37566df850baf5e4cb0dfb78af2e4b9898d817ed9263d1090a2df958c64737d2" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", + "winapi", +] + +[[package]] +name = "git2" +version = "0.20.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2deb07a133b1520dc1a5690e9bd08950108873d7ed5de38dcc74d3b5ebffa110" +dependencies = [ + "bitflags 2.11.0", + "libc", + "libgit2-sys", + "log", + "url", +] + +[[package]] +name = "glib" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "233daaf6e83ae6a12a52055f568f9d7cf4671dabb78ff9560ab6da230ce00ee5" +dependencies = [ + "bitflags 2.11.0", + "futures-channel", + "futures-core", + "futures-executor", + "futures-task", + "futures-util", + "gio-sys", + "glib-macros", + "glib-sys", + "gobject-sys", + "libc", + "memchr", + "once_cell", + "smallvec", + "thiserror 1.0.63", +] + +[[package]] +name = "glib-macros" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bb0228f477c0900c880fd78c8759b95c7636dbd7842707f49e132378aa2acdc" +dependencies = [ + "heck 0.4.1", + "proc-macro-crate 2.0.0", + "proc-macro-error", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "glib-sys" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "063ce2eb6a8d0ea93d2bf8ba1957e78dbab6be1c2220dd3daca57d5a9d869898" +dependencies = [ + "libc", + "system-deps", +] + +[[package]] +name = "glob" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b" + +[[package]] +name = "gmicloud_client" +version = "0.0.1" +dependencies = [ + "errors", + "log", + "reqwest 0.12.23", + "serde", + "serde_derive", + "serde_json", + "test_data", + "test_utils", + "tokio", + "workspace-build-acceleration", +] + +[[package]] +name = "gobject-sys" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0850127b514d1c4a4654ead6dedadb18198999985908e6ffe4436f53c785ce44" +dependencies = [ + "glib-sys", + "libc", + "system-deps", +] + +[[package]] +name = "grok_api_client" +version = "0.0.1" +dependencies = [ + "anyhow", + "env_logger", + "errors", + "log", + "reqwest 0.12.23", + "serde", + "serde_derive", + "serde_json", + "test_data", + "tokio", + "workspace-build-acceleration", +] + +[[package]] +name = "grok_consumer_client" +version = "0.0.1" +dependencies = [ + "anyhow", + "base64 0.22.1", + "bstr", + "byteorder", + "chrono", + "cloudflare_errors", + "cloudflare_mitigation", + "env", + "env_logger", + "errors", + "filesys", + "futures", + "log", + "log4rs", + "once_cell", + "regex", + "scraper", + "serde", + "serde_json", + "sha2 0.11.0-rc.5", + "test_data", + "test_utils", + "tokio", + "toml 1.0.7+spec-1.1.0", + "url", + "uuid 1.22.0", + "workspace-build-acceleration", + "wreq", + "wreq-util", +] + +[[package]] +name = "grok_consumer_statsig" +version = "0.0.1" +dependencies = [ + "base64 0.22.1", + "chrono", + "env_logger", + "errors", + "log", + "serde", + "serde_json", + "sha2 0.11.0-rc.5", + "tao", + "thiserror 2.0.18", + "tokio", + "toml 1.0.7+spec-1.1.0", + "wry", +] + +[[package]] +name = "gtk" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd56fb197bfc42bd5d2751f4f017d44ff59fbb58140c6b49f9b3b2bdab08506a" +dependencies = [ + "atk", + "cairo-rs", + "field-offset", + "futures-channel", + "gdk", + "gdk-pixbuf", + "gio", + "glib", + "gtk-sys", + "gtk3-macros", + "libc", + "pango", + "pkg-config", +] + +[[package]] +name = "gtk-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f29a1c21c59553eb7dd40e918be54dccd60c52b049b75119d5d96ce6b624414" +dependencies = [ + "atk-sys", + "cairo-sys-rs", + "gdk-pixbuf-sys", + "gdk-sys", + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "pango-sys", + "system-deps", +] + +[[package]] +name = "gtk3-macros" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ff3c5b21f14f0736fed6dcfc0bfb4225ebf5725f3c0209edeec181e4d73e9d" +dependencies = [ + "proc-macro-crate 1.3.1", + "proc-macro-error", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "h2" +version = "0.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa82e28a107a8cc405f0839610bdc9b15f1e25ec7d696aa5cf173edbcb1486ab" +dependencies = [ + "atomic-waker", + "bytes", + "fnv", + "futures-core", + "futures-sink", + "http", + "indexmap 2.13.0", + "slab", + "tokio", + "tokio-util", + "tracing", +] + +[[package]] +name = "half" +version = "2.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dd08c532ae367adf81c312a4580bc67f1d0fe8bc9c460520283f4c0ff277888" +dependencies = [ + "cfg-if", + "crunchy", +] + +[[package]] +name = "hashbrown" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" +dependencies = [ + "ahash 0.7.8", +] + +[[package]] +name = "hashbrown" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43a3c133739dddd0d2990f9a4bdf8eb4b21ef50e4851ca85ab661199821d510e" + +[[package]] +name = "hashbrown" +version = "0.14.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" +dependencies = [ + "ahash 0.8.12", + "allocator-api2", +] + +[[package]] +name = "hashbrown" +version = "0.15.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf151400ff0baff5465007dd2f3e717f3fe502074ca563069ce3a6629d07b289" +dependencies = [ + "foldhash 0.1.5", +] + +[[package]] +name = "hashbrown" +version = "0.16.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100" + +[[package]] +name = "hashlink" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8094feaf31ff591f651a2664fb9cfd92bba7a60ce3197265e9482ebe753c8f7" +dependencies = [ + "hashbrown 0.14.5", +] + +[[package]] +name = "heck" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" +dependencies = [ + "unicode-segmentation", +] + +[[package]] +name = "heck" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + +[[package]] +name = "hermit-abi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d231dfb89cfffdbc30e7fc41579ed6066ad03abda9e567ccafae602b97ec5024" + +[[package]] +name = "hermit-abi" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fbf6a919d6cf397374f7dfeeea91d974c7c0a7221d0d0f4f20d859d329e53fcc" + +[[package]] +name = "hex" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" + +[[package]] +name = "higgsfield_client" +version = "0.0.1" +dependencies = [ + "anyhow", + "base64 0.22.1", + "browser_emulation", + "chrono", + "cloudflare_errors", + "cloudflare_mitigation", + "datadome_errors", + "datadome_mitigation", + "env_logger", + "errors", + "jwt_light", + "log", + "rand 0.9.2", + "serde", + "serde_json", + "tokio", + "toml 1.0.7+spec-1.1.0", + "workspace-build-acceleration", + "wreq", +] + +[[package]] +name = "hkdf" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791a029f6b9fc27657f6f188ec6e5e43f6911f6f878e0dc5501396e09809d437" +dependencies = [ + "hmac", +] + +[[package]] +name = "hmac" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c49c37c09c17a53d937dfbb742eb3a961d65a994e6bcdcf37e7399d0cc8ab5e" +dependencies = [ + "digest 0.10.7", +] + +[[package]] +name = "home" +version = "0.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5444c27eef6923071f7ebcc33e3444508466a76f7a2b93da00ed6e19f30c1ddb" +dependencies = [ + "windows-sys 0.48.0", +] + +[[package]] +name = "html5ever" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "55d958c2f74b664487a2035fe1dadb032c48718a03b63f3ab0b8537db8549ed4" +dependencies = [ + "log", + "markup5ever 0.35.0", + "match_token", +] + +[[package]] +name = "html5ever" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1054432bae2f14e0061e33d23402fbaa67a921d319d56adc6bcf887ddad1cbc2" +dependencies = [ + "log", + "markup5ever 0.38.0", +] + +[[package]] +name = "http" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f4a85d31aea989eead29a3aaf9e1115a180df8282431156e533de47660892565" +dependencies = [ + "bytes", + "fnv", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1efedce1fb8e6913f23e0c92de8e62cd5b772a67e7b3946df930a62566c93184" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b021d93e26becf5dc7e1b75b1bed1fd93124b374ceb73f43d4d4eafec896a64a" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "http-range" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "21dec9db110f5f872ed9699c3ecf50cf16f423502706ba5c72462e28d3157573" + +[[package]] +name = "http2" +version = "0.5.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "faafa0f89e637a3524a9c081bcf825996e841afac53e691943e72049cea56f0a" +dependencies = [ + "atomic-waker", + "bytes", + "fnv", + "futures-core", + "futures-sink", + "http", + "indexmap 2.13.0", + "parking_lot", + "slab", + "smallvec", + "tokio", + "tokio-util", +] + +[[package]] +name = "http_headers" +version = "0.0.1" +dependencies = [ + "errors", + "workspace-build-acceleration", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "humantime" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4" + +[[package]] +name = "hybrid-array" +version = "0.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8655f91cd07f2b9d0c24137bd650fe69617773435ee5ec83022377777ce65ef1" +dependencies = [ + "typenum", +] + +[[package]] +name = "hyper" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc2b571658e38e0c01b1fdca3bbbe93c00d3d71693ff2770043f8c29bc7d6f80" +dependencies = [ + "bytes", + "futures-channel", + "futures-util", + "h2", + "http", + "http-body", + "httparse", + "itoa", + "pin-project-lite", + "smallvec", + "tokio", + "want", +] + +[[package]] +name = "hyper-rustls" +version = "0.27.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08afdbb5c31130e3034af566421053ab03787c640246a446327f550d11bcb333" +dependencies = [ + "futures-util", + "http", + "hyper", + "hyper-util", + "rustls 0.23.36", + "rustls-native-certs", + "rustls-pki-types", + "tokio", + "tokio-rustls", + "tower-service", + "webpki-roots 0.26.2", +] + +[[package]] +name = "hyper-tls" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70206fc6890eaca9fde8a0bf71caa2ddfc9fe045ac9e5c70df101a7dbde866e0" +dependencies = [ + "bytes", + "http-body-util", + "hyper", + "hyper-util", + "native-tls", + "tokio", + "tokio-native-tls", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d9b05277c7e8da2c93a568989bb6207bef0112e8d17df7a6eda4a3cf143bc5e" +dependencies = [ + "base64 0.22.1", + "bytes", + "futures-channel", + "futures-core", + "futures-util", + "http", + "http-body", + "hyper", + "ipnet", + "libc", + "percent-encoding", + "pin-project-lite", + "socket2 0.6.2", + "system-configuration", + "tokio", + "tower-service", + "tracing", + "windows-registry", +] + +[[package]] +name = "iana-time-zone" +version = "0.1.58" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8326b86b6cff230b97d0d312a6c40a60726df3332e721f72a1b035f451663b20" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "wasm-bindgen", + "windows-core 0.51.1", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "ico" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e795dff5605e0f04bff85ca41b51a96b83e80b281e96231bcaaf1ac35103371" +dependencies = [ + "byteorder", + "png 0.17.16", +] + +[[package]] +name = "icu_collections" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db2fa452206ebee18c4b5c2274dbf1de17008e874b4dc4f0aea9d01ca79e4526" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locid" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13acbb8371917fc971be86fc8057c41a64b521c184808a698c02acc242dbf637" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_locid_transform" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "01d11ac35de8e40fdeda00d9e1e9d92525f3f9d887cdd7aa81d727596788b54e" +dependencies = [ + "displaydoc", + "icu_locid", + "icu_locid_transform_data", + "icu_provider", + "tinystr", + "zerovec", +] + +[[package]] +name = "icu_locid_transform_data" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fdc8ff3388f852bede6b579ad4e978ab004f139284d7b28715f773507b946f6e" + +[[package]] +name = "icu_normalizer" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19ce3e0da2ec68599d193c93d088142efd7f9c5d6fc9b803774855747dc6a84f" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "utf16_iter", + "utf8_iter", + "write16", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8cafbf7aa791e9b22bec55a167906f9e1215fd475cd22adfcf660e03e989516" + +[[package]] +name = "icu_properties" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93d6020766cfc6302c15dbbc9c8778c37e62c14427cb7f6e601d849e092aeef5" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locid_transform", + "icu_properties_data", + "icu_provider", + "tinystr", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67a8effbc3dd3e4ba1afa8ad918d5684b8868b3b26500753effea8d2eed19569" + +[[package]] +name = "icu_provider" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ed421c8a8ef78d3e2dbc98a973be2f3770cb42b606e3ab18d6237c4dfde68d9" +dependencies = [ + "displaydoc", + "icu_locid", + "icu_provider_macros", + "stable_deref_trait", + "tinystr", + "writeable", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_provider_macros" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ec89e9337638ecdc08744df490b221a7399bf8d164eb52a665454e60e075ad6" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "id-arena" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d3067d79b975e8844ca9eb072e16b31c3c1c36928edf9c6789548c524d0d954" + +[[package]] +name = "ident_case" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" + +[[package]] +name = "idna" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "daca1df1c957320b2cf139ac61e7bd64fed304c5040df000a745aa1de3b4ef71" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "image" +version = "0.25.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db35664ce6b9810857a38a906215e75a9c879f0696556a39f59c62829710251a" +dependencies = [ + "bytemuck", + "byteorder-lite", + "color_quant", + "exr", + "gif", + "image-webp", + "num-traits", + "png 0.17.16", + "qoi", + "ravif", + "rayon", + "rgb", + "tiff", + "zune-core", + "zune-jpeg", +] + +[[package]] +name = "image-webp" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b77d01e822461baa8409e156015a1d91735549f0f2c17691bd2d996bef238f7f" +dependencies = [ + "byteorder-lite", + "quick-error", +] + +[[package]] +name = "images" +version = "0.0.1" +dependencies = [ + "anyhow", + "errors", + "image", + "mimetypes", + "test_utils", + "workspace-build-acceleration", +] + +[[package]] +name = "imgref" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "44feda355f4159a7c757171a77de25daf6411e217b4cabd03bd6650690468126" + +[[package]] +name = "indexmap" +version = "1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd070e393353796e801d209ad339e89596eb4c8d430d18ede6a1cced8fafbd99" +dependencies = [ + "autocfg", + "hashbrown 0.12.3", + "serde", +] + +[[package]] +name = "indexmap" +version = "2.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7714e70437a7dc3ac8eb7e6f8df75fd8eb422675fc7678aff7364301092b1017" +dependencies = [ + "equivalent", + "hashbrown 0.16.1", + "serde", + "serde_core", +] + +[[package]] +name = "infer" +version = "0.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a588916bfdfd92e71cacef98a63d9b1f0d74d6599980d11894290e7ddefffcf7" +dependencies = [ + "cfb", +] + +[[package]] +name = "instant" +version = "0.1.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7a5bbe824c507c5da5956355e86a746d82e0e1464f65d862cc5e71da70e94b2c" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "interpolate_name" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c34819042dc3d3971c46c2190835914dfbe0c3c13f61449b2997f4e9722dfa60" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "ipnet" +version = "2.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "469fb0b9cefa57e3ef31275ee7cacb78f2fdca44e4765491884a2b119d4eb130" + +[[package]] +name = "iri-string" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dbc5ebe9c3a1a7a5127f920a418f7585e9e758e911d0466ed004f393b0e380b2" +dependencies = [ + "memchr", + "serde", +] + +[[package]] +name = "is-docker" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "928bae27f42bc99b60d9ac7334e3a21d10ad8f1835a4e12ec3ec0464765ed1b3" +dependencies = [ + "once_cell", +] + +[[package]] +name = "is-wsl" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "173609498df190136aa7dea1a91db051746d339e18476eed5ca40521f02d7aa5" +dependencies = [ + "is-docker", + "once_cell", +] + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8478577c03552c21db0e2724ffb8986a5ce7af88107e6be5d2ee6e158c12800" + +[[package]] +name = "itertools" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1c173a5686ce8bfa551b3563d0c2170bf24ca44da99c7ca4bfdab5418c3fe57" +dependencies = [ + "either", +] + +[[package]] +name = "itertools" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba291022dbbd398a455acf126c1e341954079855bc60dfdda641363bd6922569" +dependencies = [ + "either", +] + +[[package]] +name = "itertools" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "413ee7dfc52ee1a4949ceeb7dbc8a33f2d6c088194d9f922fb8318faf1f01186" +dependencies = [ + "either", +] + +[[package]] +name = "itoa" +version = "1.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b" + +[[package]] +name = "javascriptcore-rs" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca5671e9ffce8ffba57afc24070e906da7fc4b1ba66f2cabebf61bf2ea257fcc" +dependencies = [ + "bitflags 1.3.2", + "glib", + "javascriptcore-rs-sys", +] + +[[package]] +name = "javascriptcore-rs-sys" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af1be78d14ffa4b75b66df31840478fef72b51f8c2465d4ca7c194da9f7a5124" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "jiff" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be1f93b8b1eb69c77f24bbb0afdf66f54b632ee39af40ca21c4365a1d7347e49" +dependencies = [ + "jiff-static", + "log", + "portable-atomic", + "portable-atomic-util", + "serde", +] + +[[package]] +name = "jiff-static" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03343451ff899767262ec32146f6d559dd759fdadf42ff0e227c7c48f72594b4" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "jni" +version = "0.21.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a87aa2bb7d2af34197c04845522473242e1aa17c12f4935d5856491a7fb8c97" +dependencies = [ + "cesu8", + "cfg-if", + "combine", + "jni-sys", + "log", + "thiserror 1.0.63", + "walkdir", + "windows-sys 0.45.0", +] + +[[package]] +name = "jni-sys" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8eaf4bc02d17cbdd7ff4c7438cafcdf7fb9a4613313ad11b4f8fefe7d3fa0130" + +[[package]] +name = "jobserver" +version = "0.1.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2b099aaa34a9751c5bf0878add70444e1ed2dd73f347be99003d4577277de6e" +dependencies = [ + "libc", +] + +[[package]] +name = "jpeg-decoder" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bc0000e42512c92e31c2252315bda326620a4e034105e900c98ec492fa077b3e" + +[[package]] +name = "js-sys" +version = "0.3.102" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03d04c30968dffe80775bd4d7fb676131cd04a1fb46d2686dbffbaec2d9dfd31" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + +[[package]] +name = "json-patch" +version = "3.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "863726d7afb6bc2590eeff7135d923545e5e964f004c2ccf8716c25e70a86f08" +dependencies = [ + "jsonptr", + "serde", + "serde_json", + "thiserror 1.0.63", +] + +[[package]] +name = "jsonptr" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5dea2b27dd239b2556ed7a25ba842fe47fd602e7fc7433c2a8d6106d4d9edd70" +dependencies = [ + "serde", + "serde_json", +] + +[[package]] +name = "jwt_light" +version = "0.0.1" +dependencies = [ + "base64 0.22.1", + "chrono", + "serde_json", + "workspace-build-acceleration", +] + +[[package]] +name = "keyboard-types" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b750dcadc39a09dbadd74e118f6dd6598df77fa01df0cfcdc52c28dece74528a" +dependencies = [ + "bitflags 2.11.0", + "serde", + "unicode-segmentation", +] + +[[package]] +name = "lazy_static" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" +dependencies = [ + "spin 0.5.2", +] + +[[package]] +name = "leb128fmt" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09edd9e8b54e49e587e4f6295a7d29c3ea94d469cb40ab8ca70b288248a81db2" + +[[package]] +name = "lebe" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03087c2bad5e1034e8cace5926dec053fb3790248370865f5117a7d0213354c8" + +[[package]] +name = "libappindicator" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03589b9607c868cc7ae54c0b2a22c8dc03dd41692d48f2d7df73615c6a95dc0a" +dependencies = [ + "glib", + "gtk", + "gtk-sys", + "libappindicator-sys", + "log", +] + +[[package]] +name = "libappindicator-sys" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e9ec52138abedcc58dc17a7c6c0c00a2bdb4f3427c7f63fa97fd0d859155caf" +dependencies = [ + "gtk-sys", + "libloading 0.7.4", + "once_cell", +] + +[[package]] +name = "libc" +version = "0.2.183" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5b646652bf6661599e1da8901b3b9522896f01e736bad5f723fe7a3a27f899d" + +[[package]] +name = "libdbus-sys" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "328c4789d42200f1eeec05bd86c9c13c7f091d2ba9a6ea35acdf51f31bc0f043" +dependencies = [ + "pkg-config", +] + +[[package]] +name = "libfuzzer-sys" +version = "0.4.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf78f52d400cf2d84a3a973a78a592b4adc535739e0a5597a0da6f0c357adc75" +dependencies = [ + "arbitrary", + "cc", +] + +[[package]] +name = "libgit2-sys" +version = "0.18.1+1.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1dcb20f84ffcdd825c7a311ae347cce604a6f084a767dec4a4929829645290e" +dependencies = [ + "cc", + "libc", + "libz-sys", + "pkg-config", +] + +[[package]] +name = "libloading" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b67380fd3b2fbe7527a606e18729d21c6f3951633d0500574c4dc22d2d638b9f" +dependencies = [ + "cfg-if", + "winapi", +] + +[[package]] +name = "libloading" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc2f4eb4bc735547cfed7c0a4922cbd04a4655978c09b54f1f7b228750664c34" +dependencies = [ + "cfg-if", + "windows-targets 0.52.6", +] + +[[package]] +name = "libm" +version = "0.2.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8355be11b20d696c8f18f6cc018c4e372165b1fa8126cef092399c9951984ffa" + +[[package]] +name = "libredox" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d" +dependencies = [ + "bitflags 2.11.0", + "libc", +] + +[[package]] +name = "libsqlite3-sys" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf4e226dcd58b4be396f7bd3c20da8fdee2911400705297ba7d2d7cc2c30f716" +dependencies = [ + "cc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "libwebp-sys2" +version = "0.1.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4790186411a6843ecc0a141c8948c8e623a0bb5e886834b1b6c90f3dfa85bb99" +dependencies = [ + "cc", + "cfg-if", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "libz-sys" +version = "1.1.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b70e7a7df205e92a1a4cd9aaae7898dac0aa555503cc0a649494d0d60e7651d" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "linux-raw-sys" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78b3ae25bc7c8c38cec158d1f2757ee79e9b3740fbc7ccf0e59e4b08d793fa89" + +[[package]] +name = "linux-raw-sys" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" + +[[package]] +name = "litemap" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ee93343901ab17bd981295f2cf0026d4ad018c7c31ba84549a4ddbb47a45104" + +[[package]] +name = "litrs" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ce301924b7887e9d637144fdade93f9dfff9b60981d4ac161db09720d39aa5" + +[[package]] +name = "local_files_database" +version = "0.0.1" +dependencies = [ + "chrono", + "errors", + "log", + "sqlx", + "tempfile", + "tokio", + "workspace-build-acceleration", +] + +[[package]] +name = "lock_api" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965" +dependencies = [ + "scopeguard", +] + +[[package]] +name = "log" +version = "0.4.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897" +dependencies = [ + "serde_core", + "value-bag", +] + +[[package]] +name = "log-mdc" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a94d21414c1f4a51209ad204c1776a3d0765002c76c6abcb602a6f09f1e881c7" + +[[package]] +name = "log4rs" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e947bb896e702c711fccc2bf02ab2abb6072910693818d1d6b07ee2b9dfd86c" +dependencies = [ + "anyhow", + "arc-swap", + "chrono", + "derive_more", + "fnv", + "humantime", + "libc", + "log", + "log-mdc", + "mock_instant", + "parking_lot", + "rand 0.9.2", + "serde", + "serde-value", + "serde_json", + "serde_yaml", + "thiserror 2.0.18", + "thread-id", + "typemap-ors", + "unicode-segmentation", + "winapi", +] + +[[package]] +name = "loop9" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fae87c125b03c1d2c0150c90365d7d6bcc53fb73a9acaef207d2d065860f062" +dependencies = [ + "imgref", +] + +[[package]] +name = "lru-slab" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112b39cec0b298b6c1999fee3e31427f74f676e4cb9879ed1a121b43661a4154" + +[[package]] +name = "mac" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c41e0c4fef86961ac6d6f8a82609f55f31b05e4fce149ac5710e439df7619ba4" + +[[package]] +name = "markup5ever" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "311fe69c934650f8f19652b3946075f0fc41ad8757dbb68f1ca14e7900ecc1c3" +dependencies = [ + "log", + "tendril 0.4.3", + "web_atoms 0.1.3", +] + +[[package]] +name = "markup5ever" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8983d30f2915feeaaab2d6babdd6bc7e9ed1a00b66b5e6d74df19aa9c0e91862" +dependencies = [ + "log", + "tendril 0.5.0", + "web_atoms 0.2.4", +] + +[[package]] +name = "match_token" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac84fd3f360fcc43dc5f5d186f02a94192761a080e8bc58621ad4d12296a58cf" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "maybe-rayon" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ea1f30cedd69f0a2954655f7188c6a834246d2bcf1e315e2ac40c4b24dc9519" +dependencies = [ + "cfg-if", + "rayon", +] + +[[package]] +name = "md-5" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d89e7ee0cfbedfc4da3340218492196241d89eefb6dab27de5df917a6d2e78cf" +dependencies = [ + "cfg-if", + "digest 0.10.7", +] + +[[package]] +name = "memchr" +version = "2.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" + +[[package]] +name = "memoffset" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a634b1c61a95585bd15607c6ab0c4e5b226e695ff2800ba0cdccddf208c406c" +dependencies = [ + "autocfg", +] + +[[package]] +name = "memory_store" +version = "0.0.1" +dependencies = [ + "anyhow", + "errors", + "workspace-build-acceleration", +] + +[[package]] +name = "midjourney_client" +version = "0.0.1" +dependencies = [ + "anyhow", + "browser_emulation", + "ciborium", + "cloudflare_errors", + "cookie_store_wrapper", + "dom_query 0.20.2", + "errors", + "filesys", + "futures", + "log", + "serde", + "serde_json", + "test_data", + "test_utils", + "tokio", + "url", + "workspace-build-acceleration", + "wreq", + "wreq-util", +] + +[[package]] +name = "mime" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" + +[[package]] +name = "mime_guess" +version = "2.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4192263c238a5f0d0c6bfd21f336a313a4ce1c450542449ca191bb657b4642ef" +dependencies = [ + "mime", + "unicase", +] + +[[package]] +name = "mimetypes" +version = "0.0.1" +dependencies = [ + "anyhow", + "infer", + "test_utils", + "workspace-build-acceleration", +] + +[[package]] +name = "minimal-lexical" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a" + +[[package]] +name = "miniz_oxide" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316" +dependencies = [ + "adler2", + "simd-adler32", +] + +[[package]] +name = "mio" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "80e04d1dcff3aae0704555fe5fee3bcfaf3d1fdf8a7e521d5b9d2b42acb52cec" +dependencies = [ + "hermit-abi 0.3.9", + "libc", + "wasi 0.11.0+wasi-snapshot-preview1", + "windows-sys 0.52.0", +] + +[[package]] +name = "mock_instant" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dce6dd36094cac388f119d2e9dc82dc730ef91c32a6222170d630e5414b956e6" + +[[package]] +name = "models" +version = "0.0.1" +dependencies = [ + "once_cell", + "serde", + "serde_derive", + "serde_json", + "strum", + "workspace-build-acceleration", +] + +[[package]] +name = "mp4" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c9ef834d5ed55e494a2ae350220314dc4aacd1c43a9498b00e320e0ea352a5c3" +dependencies = [ + "byteorder", + "bytes", + "num-rational", + "serde", + "serde_json", + "thiserror 1.0.63", +] + +[[package]] +name = "muda" +version = "0.19.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47a2e3dff89cd322c66647942668faee0a2b1f88ea6cbb4d374b4a8d7e92528c" +dependencies = [ + "crossbeam-channel", + "dpi", + "gtk", + "keyboard-types", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation 0.3.1", + "once_cell", + "png 0.18.1", + "serde", + "thiserror 2.0.18", + "windows-sys 0.61.2", +] + +[[package]] +name = "nasm-rs" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "706bf8a5e8c8ddb99128c3291d31bd21f4bcde17f0f4c20ec678d85c74faa149" +dependencies = [ + "log", +] + +[[package]] +name = "native-tls" +version = "0.2.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "465500e14ea162429d264d44189adc38b199b62b1c21eea9f69e4b73cb03bbf2" +dependencies = [ + "libc", + "log", + "openssl", + "openssl-probe 0.2.1", + "openssl-sys", + "schannel", + "security-framework 3.7.0", + "security-framework-sys", + "tempfile", +] + +[[package]] +name = "ndk" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3f42e7bbe13d351b6bead8286a43aac9534b82bd3cc43e47037f012ebfd62d4" +dependencies = [ + "bitflags 2.11.0", + "jni-sys", + "log", + "ndk-sys", + "num_enum", + "raw-window-handle", + "thiserror 1.0.63", +] + +[[package]] +name = "ndk-sys" +version = "0.6.0+11769913" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee6cda3051665f1fb8d9e08fc35c96d5a244fb1be711a03b71118828afc9a873" +dependencies = [ + "jni-sys", +] + +[[package]] +name = "new_debug_unreachable" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4a24736216ec316047a1fc4252e27dabb04218aa4a3f37c6e7ddbf1f9782b54" + +[[package]] +name = "nom" +version = "7.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d273983c5a657a70a3e8f2a01329822f3b8c8172b73826411a55751e404a0a4a" +dependencies = [ + "memchr", + "minimal-lexical", +] + +[[package]] +name = "noop_proc_macro" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0676bb32a98c1a483ce53e500a81ad9c3d5b3f7c920c28c24e9cb0980d0b5bc8" + +[[package]] +name = "num-bigint" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a5e44f723f1133c9deac646763579fdb3ac745e418f2a7af9cd0c431da1f20b9" +dependencies = [ + "num-integer", + "num-traits", +] + +[[package]] +name = "num-bigint-dig" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc84195820f291c7697304f3cbdadd1cb7199c0efc917ff5eafd71225c136151" +dependencies = [ + "byteorder", + "lazy_static", + "libm", + "num-integer", + "num-iter", + "num-traits", + "rand 0.8.5", + "smallvec", + "zeroize", +] + +[[package]] +name = "num-conv" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "51d515d32fb182ee37cda2ccdcb92950d6a3c2893aa280e540671c2cd0f3b1d9" + +[[package]] +name = "num-derive" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed3955f1a9c7c0c15e092f9c887db08b1fc683305fdf6eb6684f22555355e202" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "num-integer" +version = "0.1.46" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7969661fd2958a5cb096e56c8e1ad0444ac2bbcd0061bd28660485a44879858f" +dependencies = [ + "num-traits", +] + +[[package]] +name = "num-iter" +version = "0.1.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1429034a0490724d0075ebb2bc9e875d6503c3cf69e235a8941aa757d83ef5bf" +dependencies = [ + "autocfg", + "num-integer", + "num-traits", +] + +[[package]] +name = "num-rational" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f83d14da390562dca69fc84082e73e548e1ad308d24accdedd2720017cb37824" +dependencies = [ + "num-bigint", + "num-integer", + "num-traits", + "serde", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", + "libm", +] + +[[package]] +name = "num_enum" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "02339744ee7253741199f897151b38e72257d13802d4ee837285cc2990a90845" +dependencies = [ + "num_enum_derive", +] + +[[package]] +name = "num_enum_derive" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "681030a937600a36906c185595136d26abfebb4aa9c65701cefcaf8578bb982b" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "num_threads" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c7398b9c8b70908f6371f47ed36737907c87c52af34c268fed0bf0ceb92ead9" +dependencies = [ + "libc", +] + +[[package]] +name = "objc-sys" +version = "0.3.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdb91bdd390c7ce1a8607f35f3ca7151b65afc0ff5ff3b34fa350f7d7c7e4310" + +[[package]] +name = "objc2" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "46a785d4eeff09c14c487497c162e92766fbb3e4059a71840cecc03d9a50b804" +dependencies = [ + "objc-sys", + "objc2-encode", +] + +[[package]] +name = "objc2" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a12a8ed07aefc768292f076dc3ac8c48f3781c8f2d5851dd3d98950e8c5a89f" +dependencies = [ + "objc2-encode", + "objc2-exception-helper", +] + +[[package]] +name = "objc2-app-kit" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6f29f568bec459b0ddff777cec4fe3fd8666d82d5a40ebd0ff7e66134f89bcc" +dependencies = [ + "bitflags 2.11.0", + "block2 0.6.1", + "objc2 0.6.4", + "objc2-core-foundation", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-cloud-kit" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "17614fdcd9b411e6ff1117dfb1d0150f908ba83a7df81b1f118005fe0a8ea15d" +dependencies = [ + "bitflags 2.11.0", + "objc2 0.6.4", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-core-data" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291fbbf7d29287518e8686417cf7239c74700fd4b607623140a7d4a3c834329d" +dependencies = [ + "objc2 0.6.4", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-core-foundation" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c10c2894a6fed806ade6027bcd50662746363a9589d3ec9d9bef30a4e4bc166" +dependencies = [ + "bitflags 2.11.0", + "dispatch2", + "objc2 0.6.4", +] + +[[package]] +name = "objc2-core-graphics" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "989c6c68c13021b5c2d6b71456ebb0f9dc78d752e86a98da7c716f4f9470f5a4" +dependencies = [ + "bitflags 2.11.0", + "dispatch2", + "objc2 0.6.4", + "objc2-core-foundation", + "objc2-io-surface", +] + +[[package]] +name = "objc2-core-image" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "79b3dc0cc4386b6ccf21c157591b34a7f44c8e75b064f85502901ab2188c007e" +dependencies = [ + "objc2 0.6.4", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-core-location" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac0f75792558aa9d618443bbb5db7426a7a0b6fddf96903f86ef9ad02e135740" +dependencies = [ + "objc2 0.6.4", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-encode" +version = "4.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef25abbcd74fb2609453eb695bd2f860d389e457f67dc17cafc8b8cbc89d0c33" + +[[package]] +name = "objc2-exception-helper" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7a1c5fbb72d7735b076bb47b578523aedc40f3c439bea6dfd595c089d79d98a" +dependencies = [ + "cc", +] + +[[package]] +name = "objc2-foundation" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ee638a5da3799329310ad4cfa62fbf045d5f56e3ef5ba4149e7452dcf89d5a8" +dependencies = [ + "bitflags 2.11.0", + "block2 0.5.1", + "libc", + "objc2 0.5.2", +] + +[[package]] +name = "objc2-foundation" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "900831247d2fe1a09a683278e5384cfb8c80c79fe6b166f9d14bfdde0ea1b03c" +dependencies = [ + "bitflags 2.11.0", + "block2 0.6.1", + "libc", + "objc2 0.6.4", + "objc2-core-foundation", +] + +[[package]] +name = "objc2-io-surface" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7282e9ac92529fa3457ce90ebb15f4ecbc383e8338060960760fa2cf75420c3c" +dependencies = [ + "bitflags 2.11.0", + "objc2 0.6.4", + "objc2-core-foundation", +] + +[[package]] +name = "objc2-metal" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd0cba1276f6023976a406a14ffa85e1fdd19df6b0f737b063b95f6c8c7aadd6" +dependencies = [ + "bitflags 2.11.0", + "block2 0.5.1", + "objc2 0.5.2", + "objc2-foundation 0.2.2", +] + +[[package]] +name = "objc2-quartz-core" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e42bee7bff906b14b167da2bac5efe6b6a07e6f7c0a21a7308d40c960242dc7a" +dependencies = [ + "bitflags 2.11.0", + "block2 0.5.1", + "objc2 0.5.2", + "objc2-foundation 0.2.2", + "objc2-metal", +] + +[[package]] +name = "objc2-quartz-core" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "90ffb6a0cd5f182dc964334388560b12a57f7b74b3e2dec5e2722aa2dfb2ccd5" +dependencies = [ + "bitflags 2.11.0", + "objc2 0.6.4", + "objc2-core-foundation", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-ui-kit" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "777a571be14a42a3990d4ebedaeb8b54cd17377ec21b92e8200ac03797b3bee1" +dependencies = [ + "bitflags 2.11.0", + "block2 0.6.1", + "objc2 0.6.4", + "objc2-cloud-kit", + "objc2-core-data", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-core-image", + "objc2-core-location", + "objc2-foundation 0.3.1", + "objc2-quartz-core 0.3.1", + "objc2-user-notifications", +] + +[[package]] +name = "objc2-user-notifications" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2a3f5ec77a81d9e0c5a0b32159b0cb143d7086165e79708351e02bf37dfc65cd" +dependencies = [ + "objc2 0.6.4", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "objc2-web-kit" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91672909de8b1ce1c2252e95bbee8c1649c9ad9d14b9248b3d7b4c47903c47ad" +dependencies = [ + "bitflags 2.11.0", + "block2 0.6.1", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation 0.3.1", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" + +[[package]] +name = "once_cell_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" + +[[package]] +name = "open" +version = "5.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43bb73a7fa3799b198970490a51174027ba0d4ec504b03cd08caf513d40024bc" +dependencies = [ + "dunce", + "is-wsl", + "libc", + "pathdiff", +] + +[[package]] +name = "openh264" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fef0655e143954965073374f5390411131590d0bc793208aabf7c6785430fa00" +dependencies = [ + "openh264-sys2", + "wide", +] + +[[package]] +name = "openh264-sys2" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad97e73d98000c46623ec4719e4fd2d7f79076a75350af8ae3878abf682c071d" +dependencies = [ + "cc", + "nasm-rs", + "walkdir", +] + +[[package]] +name = "openssl" +version = "0.10.75" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08838db121398ad17ab8531ce9de97b244589089e290a384c900cb9ff7434328" +dependencies = [ + "bitflags 2.11.0", + "cfg-if", + "foreign-types 0.3.2", + "libc", + "once_cell", + "openssl-macros", + "openssl-sys", +] + +[[package]] +name = "openssl-macros" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "openssl-probe" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" + +[[package]] +name = "openssl-probe" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c87def4c32ab89d880effc9e097653c8da5d6ef28e6b539d313baaacfbafcbe" + +[[package]] +name = "openssl-src" +version = "300.4.2+3.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "168ce4e058f975fe43e89d9ccf78ca668601887ae736090aacc23ae353c298e2" +dependencies = [ + "cc", +] + +[[package]] +name = "openssl-sys" +version = "0.9.111" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82cab2d520aa75e3c58898289429321eb788c3106963d0dc886ec7a5f4adc321" +dependencies = [ + "cc", + "libc", + "openssl-src", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "option-ext" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" + +[[package]] +name = "ordered-float" +version = "2.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68f19d67e5a2795c94e73e0bb1cc1a7edeb2e28efd39e2e1c9b7a40c1108b11c" +dependencies = [ + "num-traits", +] + +[[package]] +name = "ordered-stream" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9aa2b01e1d916879f73a53d01d1d6cee68adbb31d6d9177a8cfce093cced1d50" +dependencies = [ + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "os_info" +version = "3.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0e1ac5fde8d43c34139135df8ea9ee9465394b2d8d20f032d38998f64afffc3" +dependencies = [ + "log", + "plist", + "windows-sys 0.52.0", +] + +[[package]] +name = "pango" +version = "0.18.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ca27ec1eb0457ab26f3036ea52229edbdb74dee1edd29063f5b9b010e7ebee4" +dependencies = [ + "gio", + "glib", + "libc", + "once_cell", + "pango-sys", +] + +[[package]] +name = "pango-sys" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "436737e391a843e5933d6d9aa102cb126d501e815b83601365a948a518555dc5" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "parking" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb813b8af86854136c6922af0598d719255ecb2179515e6e7730d468f05c9cae" + +[[package]] +name = "parking_lot" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall 0.5.2", + "smallvec", + "windows-link 0.2.1", +] + +[[package]] +name = "paste" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "de3145af08024dea9fa9914f381a17b8fc6034dfb00f3a84013f7ff43f29ed4c" + +[[package]] +name = "pathdiff" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df94ce210e5bc13cb6651479fa48d14f601d9858cfe0467f43ae157023b938d3" + +[[package]] +name = "pem-rfc7468" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88b39c9bfcfc231068454382784bb460aae594343fb030d46e9f50a645418412" +dependencies = [ + "base64ct", +] + +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "phf" +version = "0.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ade2d8b8f33c7333b51bcf0428d37e217e9f32192ae4772156f65063b8ce03dc" +dependencies = [ + "phf_macros 0.11.2", + "phf_shared 0.11.3", +] + +[[package]] +name = "phf" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1562dc717473dbaa4c1f85a36410e03c047b2e7df7f45ee938fbef64ae7fadf" +dependencies = [ + "phf_macros 0.13.1", + "phf_shared 0.13.1", + "serde", +] + +[[package]] +name = "phf_codegen" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aef8048c789fa5e851558d709946d6d79a8ff88c0440c587967f8e94bfb1216a" +dependencies = [ + "phf_generator 0.11.2", + "phf_shared 0.11.3", +] + +[[package]] +name = "phf_codegen" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49aa7f9d80421bca176ca8dbfebe668cc7a2684708594ec9f3c0db0805d5d6e1" +dependencies = [ + "phf_generator 0.13.1", + "phf_shared 0.13.1", +] + +[[package]] +name = "phf_generator" +version = "0.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "48e4cc64c2ad9ebe670cb8fd69dd50ae301650392e81c05f9bfcb2d5bdbc24b0" +dependencies = [ + "phf_shared 0.11.3", + "rand 0.8.5", +] + +[[package]] +name = "phf_generator" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "135ace3a761e564ec88c03a77317a7c6b80bb7f7135ef2544dbe054243b89737" +dependencies = [ + "fastrand", + "phf_shared 0.13.1", +] + +[[package]] +name = "phf_macros" +version = "0.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3444646e286606587e49f3bcf1679b8cef1dc2c5ecc29ddacaffc305180d464b" +dependencies = [ + "phf_generator 0.11.2", + "phf_shared 0.11.3", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "phf_macros" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "812f032b54b1e759ccd5f8b6677695d5268c588701effba24601f6932f8269ef" +dependencies = [ + "phf_generator 0.13.1", + "phf_shared 0.13.1", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "phf_shared" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67eabc2ef2a60eb7faa00097bd1ffdb5bd28e62bf39990626a582201b7a754e5" +dependencies = [ + "siphasher", +] + +[[package]] +name = "phf_shared" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e57fef6bc5981e38c2ce2d63bfa546861309f875b8a75f092d1d54ae2d64f266" +dependencies = [ + "siphasher", +] + +[[package]] +name = "pin-project-lite" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b3cff922bd51709b605d9ead9aa71031d81447142d828eb4a6eba76fe619f9b" + +[[package]] +name = "piper" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96c8c490f422ef9a4efd2cb5b42b76c8613d7e7dfc1caf667b8a3350a5acc066" +dependencies = [ + "atomic-waker", + "fastrand", + "futures-io", +] + +[[package]] +name = "pkcs1" +version = "0.7.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8ffb9f10fa047879315e6625af03c164b16962a5368d724ed16323b68ace47f" +dependencies = [ + "der", + "pkcs8", + "spki", +] + +[[package]] +name = "pkcs8" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f950b2377845cebe5cf8b5165cb3cc1a5e0fa5cfa3e1f7f55707d8fd82e0a7b7" +dependencies = [ + "der", + "spki", +] + +[[package]] +name = "pkg-config" +version = "0.3.30" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d231b230927b5e4ad203db57bbcbee2802f6bce620b1e4a9024a07d94e2907ec" + +[[package]] +name = "plist" +version = "1.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42cf17e9a1800f5f396bc67d193dc9411b59012a5876445ef450d449881e1016" +dependencies = [ + "base64 0.22.1", + "indexmap 2.13.0", + "quick-xml", + "serde", + "time", +] + +[[package]] +name = "png" +version = "0.17.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82151a2fc869e011c153adc57cf2789ccb8d9906ce52c0b39a6b5697749d7526" +dependencies = [ + "bitflags 1.3.2", + "crc32fast", + "fdeflate", + "flate2", + "miniz_oxide", +] + +[[package]] +name = "png" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60769b8b31b2a9f263dae2776c37b1b28ae246943cf719eb6946a1db05128a61" +dependencies = [ + "bitflags 2.11.0", + "crc32fast", + "fdeflate", + "flate2", + "miniz_oxide", +] + +[[package]] +name = "polling" +version = "3.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a604568c3202727d1507653cb121dbd627a58684eb09a820fd746bee38b4442f" +dependencies = [ + "cfg-if", + "concurrent-queue", + "hermit-abi 0.4.0", + "pin-project-lite", + "rustix 0.38.44", + "tracing", + "windows-sys 0.59.0", +] + +[[package]] +name = "portable-atomic" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f84267b20a16ea918e43c6a88433c2d54fa145c92a811b5b047ccbe153674483" + +[[package]] +name = "portable-atomic-util" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8a2f0d8d040d7848a709caf78912debcc3f33ee4b3cac47d73d1e1069e83507" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "powerfmt" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391" + +[[package]] +name = "ppv-lite86" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de" + +[[package]] +name = "precomputed-hash" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "925383efa346730478fb4838dbe9137d2a47675ad789c546d150a6e1dd4ab31c" + +[[package]] +name = "pretty_assertions" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ae130e2f271fbc2ac3a40fb1d07180839cdbbe443c7a27e1e3c13c5cac0116d" +dependencies = [ + "diff", + "yansi", +] + +[[package]] +name = "prettyplease" +version = "0.2.37" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b" +dependencies = [ + "proc-macro2", + "syn 2.0.117", +] + +[[package]] +name = "primitives" +version = "0.0.1" +dependencies = [ + "assertor", + "test_utils", + "workspace-build-acceleration", +] + +[[package]] +name = "proc-macro-crate" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f4c021e1093a56626774e81216a4ce732a735e5bad4868a03f3ed65ca0c3919" +dependencies = [ + "once_cell", + "toml_edit 0.19.15", +] + +[[package]] +name = "proc-macro-crate" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e8366a6159044a37876a2b9817124296703c586a5c92e2c53751fa06d8d43e8" +dependencies = [ + "toml_edit 0.20.7", +] + +[[package]] +name = "proc-macro-crate" +version = "3.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e67ba7e9b2b56446f1d419b1d807906278ffa1a658a8a5d8a39dcb1f5a78614f" +dependencies = [ + "toml_edit 0.25.5+spec-1.1.0", +] + +[[package]] +name = "proc-macro-error" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c" +dependencies = [ + "proc-macro-error-attr", + "proc-macro2", + "quote", + "syn 1.0.109", + "version_check", +] + +[[package]] +name = "proc-macro-error-attr" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869" +dependencies = [ + "proc-macro2", + "quote", + "version_check", +] + +[[package]] +name = "proc-macro-error-attr2" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96de42df36bb9bba5542fe9f1a054b8cc87e172759a1868aa05c1f3acc89dfc5" +dependencies = [ + "proc-macro2", + "quote", +] + +[[package]] +name = "proc-macro-error2" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11ec05c52be0a07b08061f7dd003e7d7092e0472bc731b4af7bb1ef876109802" +dependencies = [ + "proc-macro-error-attr2", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "proc-macro2" +version = "1.0.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "profiling" +version = "1.0.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "afbdc74edc00b6f6a218ca6a5364d6226a259d4b8ea1af4a0ea063f27e179f4d" +dependencies = [ + "profiling-procmacros", +] + +[[package]] +name = "profiling-procmacros" +version = "1.0.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a65f2e60fbf1063868558d69c6beacf412dc755f9fc020f514b7955fc914fe30" +dependencies = [ + "quote", + "syn 2.0.117", +] + +[[package]] +name = "psl-types" +version = "2.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33cb294fe86a74cbcf50d4445b37da762029549ebeea341421c7c70370f86cac" + +[[package]] +name = "ptr_meta" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0738ccf7ea06b608c10564b31debd4f5bc5e197fc8bfe088f68ae5ce81e7a4f1" +dependencies = [ + "ptr_meta_derive", +] + +[[package]] +name = "ptr_meta_derive" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16b845dbfca988fa33db069c0e230574d15a3088f147a87b64c7589eb662c9ac" +dependencies = [ + "proc-macro2", + "quote", + "syn 1.0.109", +] + +[[package]] +name = "publicsuffix" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f42ea446cab60335f76979ec15e12619a2165b5ae2c12166bef27d283a9fadf" +dependencies = [ + "idna", + "psl-types", +] + +[[package]] +name = "qoi" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f6d64c71eb498fe9eae14ce4ec935c555749aef511cca85b5568910d6e48001" +dependencies = [ + "bytemuck", +] + +[[package]] +name = "quick-error" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a993555f31e5a609f617c12db6250dedcac1b0a85076912c436e6fc9b2c8e6a3" + +[[package]] +name = "quick-xml" +version = "0.32.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d3a6e5838b60e0e8fa7a43f22ade549a37d61f8bdbe636d0d7816191de969c2" +dependencies = [ + "memchr", +] + +[[package]] +name = "quinn" +version = "0.11.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e20a958963c291dc322d98411f541009df2ced7b5a4f2bd52337638cfccf20" +dependencies = [ + "bytes", + "cfg_aliases", + "pin-project-lite", + "quinn-proto", + "quinn-udp", + "rustc-hash", + "rustls 0.23.36", + "socket2 0.6.2", + "thiserror 2.0.18", + "tokio", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-proto" +version = "0.11.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1906b49b0c3bc04b5fe5d86a77925ae6524a19b816ae38ce1e426255f1d8a31" +dependencies = [ + "bytes", + "getrandom 0.3.1", + "lru-slab", + "rand 0.9.2", + "ring", + "rustc-hash", + "rustls 0.23.36", + "rustls-pki-types", + "slab", + "thiserror 2.0.18", + "tinyvec", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-udp" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8bffec3605b73c6f1754535084a85229fa8a30f86014e6c81aeec4abb68b0285" +dependencies = [ + "libc", + "once_cell", + "socket2 0.5.10", + "tracing", + "windows-sys 0.52.0", +] + +[[package]] +name = "quote" +version = "1.0.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "r-efi" +version = "5.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f" + +[[package]] +name = "radium" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc33ff2d4973d518d823d61aa239014831e521c75da58e3df4840d3f47749d09" + +[[package]] +name = "rand" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "552840b97013b1a26992c11eac34bdd778e464601a4c2054b5f0bff7c6761293" +dependencies = [ + "fuchsia-cprng", + "libc", + "rand_core 0.3.1", + "rdrand", + "winapi", +] + +[[package]] +name = "rand" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404" +dependencies = [ + "libc", + "rand_chacha 0.3.1", + "rand_core 0.6.4", +] + +[[package]] +name = "rand" +version = "0.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6db2770f06117d490610c7488547d543617b21bfa07796d7a12f6f1bd53850d1" +dependencies = [ + "rand_chacha 0.9.0", + "rand_core 0.9.3", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core 0.6.4", +] + +[[package]] +name = "rand_chacha" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb" +dependencies = [ + "ppv-lite86", + "rand_core 0.9.3", +] + +[[package]] +name = "rand_core" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7a6fdeb83b075e8266dcc8762c22776f6877a63111121f5f8c7411e5be7eed4b" +dependencies = [ + "rand_core 0.4.2", +] + +[[package]] +name = "rand_core" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c33a3c44ca05fa6f1807d8e6743f3824e8509beca625669633be0acbdf509dc" + +[[package]] +name = "rand_core" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" +dependencies = [ + "getrandom 0.2.14", +] + +[[package]] +name = "rand_core" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "99d9a13982dcf210057a8a78572b2217b667c3beacbf3a0d8b454f6f82837d38" +dependencies = [ + "getrandom 0.3.1", +] + +[[package]] +name = "rav1e" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd87ce80a7665b1cce111f8a16c1f3929f6547ce91ade6addf4ec86a8dda5ce9" +dependencies = [ + "arbitrary", + "arg_enum_proc_macro", + "arrayvec", + "av1-grain", + "bitstream-io", + "built", + "cfg-if", + "interpolate_name", + "itertools 0.12.1", + "libc", + "libfuzzer-sys", + "log", + "maybe-rayon", + "new_debug_unreachable", + "noop_proc_macro", + "num-derive", + "num-traits", + "once_cell", + "paste", + "profiling", + "rand 0.8.5", + "rand_chacha 0.3.1", + "simd_helpers", + "system-deps", + "thiserror 1.0.63", + "v_frame", + "wasm-bindgen", +] + +[[package]] +name = "ravif" +version = "0.11.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2413fd96bd0ea5cdeeb37eaf446a22e6ed7b981d792828721e74ded1980a45c6" +dependencies = [ + "avif-serialize", + "imgref", + "loop9", + "quick-error", + "rav1e", + "rayon", + "rgb", +] + +[[package]] +name = "raw-window-handle" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20675572f6f24e9e76ef639bc5552774ed45f1c30e2951e1e99c59888861c539" + +[[package]] +name = "rayon" +version = "1.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b418a60154510ca1a002a752ca9714984e21e4241e804d32555251faf8b78ffa" +dependencies = [ + "either", + "rayon-core", +] + +[[package]] +name = "rayon-core" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1465873a3dfdaa8ae7cb14b4383657caab0b3e8a0aa9ae8e04b044854c8dfce2" +dependencies = [ + "crossbeam-deque", + "crossbeam-utils", +] + +[[package]] +name = "rdrand" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "678054eb77286b51581ba43620cc911abf02758c91f93f479767aed0f90458b2" +dependencies = [ + "rand_core 0.3.1", +] + +[[package]] +name = "read-progress-stream" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6435842fc2fea44b528719eb8c32203bbc1bb2f5b619fbe0c0a3d8350fd8d2a8" +dependencies = [ + "bytes", + "futures", + "pin-project-lite", +] + +[[package]] +name = "redox_syscall" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4722d768eff46b75989dd134e5c353f0d6296e5aaa3132e776cbdb56be7731aa" +dependencies = [ + "bitflags 1.3.2", +] + +[[package]] +name = "redox_syscall" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c82cf8cff14456045f55ec4241383baeff27af886adb72ffb2162f99911de0fd" +dependencies = [ + "bitflags 2.11.0", +] + +[[package]] +name = "redox_users" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd6f9d3d47bdd2ad6945c5015a226ec6155d0bcdfd8f7cd29f86b71f8de99d2b" +dependencies = [ + "getrandom 0.2.14", + "libredox", + "thiserror 2.0.18", +] + +[[package]] +name = "regex" +version = "1.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e10754a14b9137dd7b1e3e5b0493cc9171fdd105e0ab477f51b72e7f3ac0e276" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.4.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5276caf25ac86c8d810222b3dbb938e512c55c6831a10f3e6ed1c93b84041f1c" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c" + +[[package]] +name = "remove_dir_all" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3acd125665422973a33ac9d3dd2df85edad0f4ae9b00dafb1a05e43a9f5ef8e7" +dependencies = [ + "winapi", +] + +[[package]] +name = "rend" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "71fe3824f5629716b1589be05dacd749f6aa084c87e00e016714a8cdfccc997c" +dependencies = [ + "bytecheck", +] + +[[package]] +name = "reqwest" +version = "0.12.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d429f34c8092b2d42c7c93cec323bb4adeb7c67698f70839adec842ec10c7ceb" +dependencies = [ + "async-compression", + "base64 0.22.1", + "bytes", + "cookie", + "cookie_store", + "encoding_rs", + "futures-channel", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-rustls", + "hyper-tls", + "hyper-util", + "js-sys", + "log", + "mime", + "mime_guess", + "native-tls", + "percent-encoding", + "pin-project-lite", + "quinn", + "rustls 0.23.36", + "rustls-native-certs", + "rustls-pki-types", + "serde", + "serde_json", + "serde_urlencoded", + "sync_wrapper", + "tokio", + "tokio-native-tls", + "tokio-rustls", + "tokio-util", + "tower", + "tower-http", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "wasm-streams 0.4.0", + "web-sys", + "webpki-roots 1.0.2", +] + +[[package]] +name = "reqwest" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab3f43e3283ab1488b624b44b0e988d0acea0b3214e694730a055cb6b2efa801" +dependencies = [ + "base64 0.22.1", + "bytes", + "futures-core", + "futures-util", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-util", + "js-sys", + "log", + "percent-encoding", + "pin-project-lite", + "serde", + "serde_json", + "sync_wrapper", + "tokio", + "tokio-util", + "tower", + "tower-http", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "wasm-streams 0.5.0", + "web-sys", +] + +[[package]] +name = "rfd" +version = "0.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a15ad77d9e70a92437d8f74c35d99b4e4691128df018833e99f90bcd36152672" +dependencies = [ + "block2 0.6.1", + "dispatch2", + "glib-sys", + "gobject-sys", + "gtk-sys", + "js-sys", + "log", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation 0.3.1", + "raw-window-handle", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", + "windows-sys 0.60.2", +] + +[[package]] +name = "rgb" +version = "0.8.50" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57397d16646700483b67d2dd6511d79318f9d057fdbd21a4066aeac8b41d310a" + +[[package]] +name = "ring" +version = "0.17.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c17fa4cb658e3583423e915b9f3acc01cceaee1860e33d59ebae66adc3a2dc0d" +dependencies = [ + "cc", + "cfg-if", + "getrandom 0.2.14", + "libc", + "spin 0.9.8", + "untrusted", + "windows-sys 0.52.0", +] + +[[package]] +name = "rkyv" +version = "0.7.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9008cd6385b9e161d8229e1f6549dd23c3d022f132a2ea37ac3a10ac4935779b" +dependencies = [ + "bitvec", + "bytecheck", + "bytes", + "hashbrown 0.12.3", + "ptr_meta", + "rend", + "rkyv_derive", + "seahash", + "tinyvec", + "uuid 1.22.0", +] + +[[package]] +name = "rkyv_derive" +version = "0.7.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "503d1d27590a2b0a3a4ca4c94755aa2875657196ecbf401a42eff41d7de532c0" +dependencies = [ + "proc-macro2", + "quote", + "syn 1.0.109", +] + +[[package]] +name = "router" +version = "0.0.1" +dependencies = [ + "anyhow", + "artcraft_client", + "async-trait", + "browser_emulation", + "fal_client", + "file_hashing", + "gmicloud_client", + "grok_api_client", + "grok_consumer_client", + "higgsfield_client", + "log", + "midjourney_client", + "reqwest 0.12.23", + "seedance2pro_client", + "serde", + "serde_derive", + "serde_json", + "sqlite_identifiers", + "strum", + "test_data", + "test_utils", + "tokio", + "url_utils", + "uuid 1.22.0", + "workspace-build-acceleration", + "wreq", +] + +[[package]] +name = "rsa" +version = "0.9.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d0e5124fcb30e76a7e79bfee683a2746db83784b86289f6251b54b7950a0dfc" +dependencies = [ + "const-oid 0.9.6", + "digest 0.10.7", + "num-bigint-dig", + "num-integer", + "num-traits", + "pkcs1", + "pkcs8", + "rand_core 0.6.4", + "signature", + "spki", + "subtle", + "zeroize", +] + +[[package]] +name = "rust_decimal" +version = "1.36.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b082d80e3e3cc52b2ed634388d436fe1f4de6af5786cc2de9ba9737527bdf555" +dependencies = [ + "arrayvec", + "borsh", + "bytes", + "num-traits", + "rand 0.8.5", + "rkyv", + "serde", + "serde_json", +] + +[[package]] +name = "rustc-hash" +version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "357703d41365b4b27c590e3ed91eabb1b663f07c4c084095e60cbed4362dff0d" + +[[package]] +name = "rustc_version" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfa0f585226d2e68097d4f95d113b15b83a82e819ab25717ec0590d9584ef366" +dependencies = [ + "semver", +] + +[[package]] +name = "rustix" +version = "0.38.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fdb5bc1ae2baa591800df16c9ca78619bf65c0488b41b96ccec5d11220d8c154" +dependencies = [ + "bitflags 2.11.0", + "errno", + "libc", + "linux-raw-sys 0.4.14", + "windows-sys 0.59.0", +] + +[[package]] +name = "rustix" +version = "1.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6fe4565b9518b83ef4f91bb47ce29620ca828bd32cb7e408f0062e9930ba190" +dependencies = [ + "bitflags 2.11.0", + "errno", + "libc", + "linux-raw-sys 0.12.1", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls" +version = "0.21.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f56a14d1f48b391359b22f731fd4bd7e43c97f3c50eee276f3aa09c94784d3e" +dependencies = [ + "ring", + "rustls-webpki 0.101.7", + "sct", +] + +[[package]] +name = "rustls" +version = "0.23.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c665f33d38cea657d9614f766881e4d510e0eda4239891eea56b4cadcf01801b" +dependencies = [ + "once_cell", + "ring", + "rustls-pki-types", + "rustls-webpki 0.103.9", + "subtle", + "zeroize", +] + +[[package]] +name = "rustls-native-certs" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fcaf18a4f2be7326cd874a5fa579fae794320a0f388d365dca7e480e55f83f8a" +dependencies = [ + "openssl-probe 0.1.5", + "rustls-pemfile 2.1.2", + "rustls-pki-types", + "schannel", + "security-framework 2.10.0", +] + +[[package]] +name = "rustls-pemfile" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c74cae0a4cf6ccbbf5f359f08efdf8ee7e1dc532573bf0db71968cb56b1448c" +dependencies = [ + "base64 0.21.7", +] + +[[package]] +name = "rustls-pemfile" +version = "2.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29993a25686778eb88d4189742cd713c9bce943bc54251a33509dc63cbacf73d" +dependencies = [ + "base64 0.22.1", + "rustls-pki-types", +] + +[[package]] +name = "rustls-pki-types" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "229a4a4c221013e7e1f1a043678c5cc39fe5171437c88fb47151a21e6f5b5c79" +dependencies = [ + "web-time", + "zeroize", +] + +[[package]] +name = "rustls-webpki" +version = "0.101.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b6275d1ee7a1cd780b64aca7726599a1dbc893b1e64144529e55c3c2f745765" +dependencies = [ + "ring", + "untrusted", +] + +[[package]] +name = "rustls-webpki" +version = "0.103.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7df23109aa6c1567d1c575b9952556388da57401e4ace1d15f79eedad0d8f53" +dependencies = [ + "ring", + "rustls-pki-types", + "untrusted", +] + +[[package]] +name = "rustversion" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ffc183a10b4478d04cbbbfc96d0873219d962dd5accaff2ffbd4ceb7df837f4" + +[[package]] +name = "ryu" +version = "1.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f" + +[[package]] +name = "safe_arch" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96b02de82ddbe1b636e6170c21be622223aea188ef2e139be0a5b219ec215323" +dependencies = [ + "bytemuck", +] + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "scc" +version = "2.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea091f6cac2595aa38993f04f4ee692ed43757035c36e67c180b6828356385b1" +dependencies = [ + "sdd", +] + +[[package]] +name = "schannel" +version = "0.1.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "891d81b926048e76efe18581bf793546b4c0eaf8448d72be8de2bbee5fd166e1" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "schemars" +version = "0.8.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09c024468a378b7e36765cd36702b7a90cc3cba11654f6685c8f233408e89e92" +dependencies = [ + "dyn-clone", + "indexmap 1.9.3", + "schemars_derive", + "serde", + "serde_json", + "url", + "uuid 1.22.0", +] + +[[package]] +name = "schemars_derive" +version = "0.8.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1eee588578aff73f856ab961cd2f79e36bc45d7ded33a7562adba4667aecc0e" +dependencies = [ + "proc-macro2", + "quote", + "serde_derive_internals", + "syn 2.0.117", +] + +[[package]] +name = "schnellru" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "356285bbf17bea63d9e52e96bd18f039672ac92b55b8cb997d6162a2a37d1649" +dependencies = [ + "ahash 0.8.12", + "cfg-if", + "hashbrown 0.13.2", +] + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "scraper" +version = "0.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5f3a24d916e78954af99281a455168d4a9515d65eca99a18da1b813689c4ad9" +dependencies = [ + "cssparser 0.35.0", + "ego-tree", + "getopts", + "html5ever 0.35.0", + "precomputed-hash", + "selectors 0.31.0", + "tendril 0.4.3", +] + +[[package]] +name = "sct" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da046153aa2352493d6cb7da4b6e5c0c057d8a1d0a9aa8560baffdd945acd414" +dependencies = [ + "ring", + "untrusted", +] + +[[package]] +name = "sdd" +version = "3.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "584e070911c7017da6cb2eb0788d09f43d789029b5877d3e5ecc8acf86ceee21" + +[[package]] +name = "seahash" +version = "4.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c107b6f4780854c8b126e228ea8869f4d7b71260f962fefb57b996b8959ba6b" + +[[package]] +name = "security-framework" +version = "2.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "770452e37cad93e0a50d5abc3990d2bc351c36d0328f86cefec2f2fb206eaef6" +dependencies = [ + "bitflags 1.3.2", + "core-foundation 0.9.4", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f4bc775c73d9a02cde8bf7b2ec4c9d12743edf609006c7facc23998404cd1d" +dependencies = [ + "bitflags 2.11.0", + "core-foundation 0.10.0", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2691df843ecc5d231c0b14ece2acc3efb62c0a398c7e1d875f3983ce020e3" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "seedance2pro_client" +version = "0.0.1" +dependencies = [ + "chrono", + "cloudflare_errors", + "env", + "env_logger", + "errors", + "log", + "rand 0.9.2", + "serde", + "serde_derive", + "serde_json", + "test_data", + "test_utils", + "tokio", + "url", + "workspace-build-acceleration", + "wreq", + "wreq-util", +] + +[[package]] +name = "selectors" +version = "0.30.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3df44ba8a7ca7a4d28c589e04f526266ed76b6cc556e33fe69fa25de31939a65" +dependencies = [ + "bitflags 2.11.0", + "cssparser 0.35.0", + "derive_more", + "fxhash", + "log", + "new_debug_unreachable", + "phf 0.11.2", + "phf_codegen 0.11.3", + "precomputed-hash", + "servo_arc", + "smallvec", +] + +[[package]] +name = "selectors" +version = "0.31.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5685b6ae43bfcf7d2e7dfcfb5d8e8f61b46442c902531e41a32a9a8bf0ee0fb6" +dependencies = [ + "bitflags 2.11.0", + "cssparser 0.35.0", + "derive_more", + "fxhash", + "log", + "new_debug_unreachable", + "phf 0.11.2", + "phf_codegen 0.11.3", + "precomputed-hash", + "servo_arc", + "smallvec", +] + +[[package]] +name = "selectors" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5d9c0c92a92d33f08817311cf3f2c29a3538a8240e94a6a3c622ce652d7e00c" +dependencies = [ + "bitflags 2.11.0", + "cssparser 0.36.0", + "derive_more", + "log", + "new_debug_unreachable", + "phf 0.13.1", + "phf_codegen 0.13.1", + "precomputed-hash", + "rustc-hash", + "servo_arc", + "smallvec", +] + +[[package]] +name = "semver" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61697e0a1c7e512e84a621326239844a24d8207b4669b41bc18b32ea5cbf988b" +dependencies = [ + "serde", +] + +[[package]] +name = "serde" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde-untagged" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2676ba99bd82f75cae5cbd2c8eda6fa0b8760f18978ea840e980dd5567b5c5b6" +dependencies = [ + "erased-serde", + "serde", + "typeid", +] + +[[package]] +name = "serde-value" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3a1a3341211875ef120e117ea7fd5228530ae7e7036a779fdc9117be6b3282c" +dependencies = [ + "ordered-float", + "serde", +] + +[[package]] +name = "serde_core" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "serde_derive_internals" +version = "0.29.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18d26a20a969b9e3fdf2fc2d9f21eda6c40e2de84c9408bb5d3b05d499aae711" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "serde_json" +version = "1.0.149" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "83fc039473c5595ace860d8c4fafa220ff474b3fc6bfdb4293327f1a37e94d86" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "serde_repr" +version = "0.1.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c64451ba24fc7a6a2d60fc75dd9c83c90903b19028d4eff35e88fc1e86564e9" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "serde_spanned" +version = "0.6.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf41e0cfaf7226dca15e8197172c295a782857fcb97fad1808a166870dee75a3" +dependencies = [ + "serde", +] + +[[package]] +name = "serde_spanned" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8bbf91e5a4d6315eee45e704372590b30e260ee83af6639d64557f51b067776" +dependencies = [ + "serde_core", +] + +[[package]] +name = "serde_urlencoded" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd" +dependencies = [ + "form_urlencoded", + "itoa", + "ryu", + "serde", +] + +[[package]] +name = "serde_with" +version = "3.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6b6f7f2fcb69f747921f79f3926bd1e203fce4fef62c268dd3abfb6d86029aa" +dependencies = [ + "base64 0.22.1", + "chrono", + "hex", + "indexmap 1.9.3", + "indexmap 2.13.0", + "serde", + "serde_derive", + "serde_json", + "serde_with_macros", + "time", +] + +[[package]] +name = "serde_with_macros" +version = "3.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d00caa5193a3c8362ac2b73be6b9e768aa5a4b2f721d8f4b339600c3cb51f8e" +dependencies = [ + "darling", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "serde_yaml" +version = "0.9.34+deprecated" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47" +dependencies = [ + "indexmap 2.13.0", + "itoa", + "ryu", + "serde", + "unsafe-libyaml", +] + +[[package]] +name = "serial_test" +version = "3.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b258109f244e1d6891bf1053a55d63a5cd4f8f4c30cf9a1280989f80e7a1fa9" +dependencies = [ + "futures", + "log", + "once_cell", + "parking_lot", + "scc", + "serial_test_derive", +] + +[[package]] +name = "serial_test_derive" +version = "3.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d69265a08751de7844521fd15003ae0a888e035773ba05695c5c759a6f89eef" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "serialize-to-javascript" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04f3666a07a197cdb77cdf306c32be9b7f598d7060d50cfd4d5aa04bfd92f6c5" +dependencies = [ + "serde", + "serde_json", + "serialize-to-javascript-impl", +] + +[[package]] +name = "serialize-to-javascript-impl" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "772ee033c0916d670af7860b6e1ef7d658a4629a6d0b4c8c3e67f09b3765b75d" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "servo_arc" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "170fb83ab34de17dc69aa7c67482b22218ddb85da56546f9bd6b929e32a05930" +dependencies = [ + "stable_deref_trait", +] + +[[package]] +name = "sha1" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3bf829a2d51ab4a5ddf1352d8470c140cadc8301b2ae1789db023f01cedd6ba" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.12", + "digest 0.10.7", +] + +[[package]] +name = "sha2" +version = "0.10.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "793db75ad2bcafc3ffa7c68b215fee268f537982cd901d132f89c6343f3a3dc8" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.12", + "digest 0.10.7", +] + +[[package]] +name = "sha2" +version = "0.11.0-rc.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c5f3b1e2dc8aad28310d8410bd4d7e180eca65fca176c52ab00d364475d0024" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.12", + "digest 0.11.2", +] + +[[package]] +name = "shlex" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" + +[[package]] +name = "signal-hook-registry" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8229b473baa5980ac72ef434c4415e70c4b5e71b423043adb4ba059f89c99a1" +dependencies = [ + "libc", +] + +[[package]] +name = "signature" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77549399552de45a898a580c1b41d445bf730df867cc44e6c0233bbc4b8329de" +dependencies = [ + "digest 0.10.7", + "rand_core 0.6.4", +] + +[[package]] +name = "simd-adler32" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe" + +[[package]] +name = "simd_helpers" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95890f873bec569a0362c235787f3aca6e1e887302ba4840839bcc6459c42da6" +dependencies = [ + "quote", +] + +[[package]] +name = "simdutf8" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" + +[[package]] +name = "siphasher" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56199f7ddabf13fe5074ce809e7d3f42b42ae711800501b5b16ea82ad029c39d" + +[[package]] +name = "slab" +version = "0.4.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f92a496fb766b417c996b9c5e57daf2f7ad3b0bebe1ccfca4856390e3d3bb67" +dependencies = [ + "autocfg", +] + +[[package]] +name = "smallvec" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" + +[[package]] +name = "socket2" +version = "0.5.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e22376abed350d73dd1cd119b57ffccad95b4e585a7cda43e286245ce23c0678" +dependencies = [ + "libc", + "windows-sys 0.52.0", +] + +[[package]] +name = "socket2" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86f4aa3ad99f2088c990dfa82d367e19cb29268ed67c574d10d0a4bfe71f07e0" +dependencies = [ + "libc", + "windows-sys 0.60.2", +] + +[[package]] +name = "softbuffer" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18051cdd562e792cad055119e0cdb2cfc137e44e3987532e0f9659a77931bb08" +dependencies = [ + "bytemuck", + "cfg_aliases", + "core-graphics 0.24.0", + "foreign-types 0.5.0", + "js-sys", + "log", + "objc2 0.5.2", + "objc2-foundation 0.2.2", + "objc2-quartz-core 0.2.2", + "raw-window-handle", + "redox_syscall 0.5.2", + "wasm-bindgen", + "web-sys", + "windows-sys 0.59.0", +] + +[[package]] +name = "soup3" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "471f924a40f31251afc77450e781cb26d55c0b650842efafc9c6cbd2f7cc4f9f" +dependencies = [ + "futures-channel", + "gio", + "glib", + "libc", + "soup3-sys", +] + +[[package]] +name = "soup3-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ebe8950a680a12f24f15ebe1bf70db7af98ad242d9db43596ad3108aab86c27" +dependencies = [ + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "spin" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d" + +[[package]] +name = "spin" +version = "0.9.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67" +dependencies = [ + "lock_api", +] + +[[package]] +name = "spki" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d91ed6c858b01f942cd56b37a94b3e0a1798290327d1236e4d9cf4eaca44d29d" +dependencies = [ + "base64ct", + "der", +] + +[[package]] +name = "sqlformat" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b7b278788e7be4d0d29c0f39497a0eef3fba6bbc8e70d8bf7fde46edeaa9e85" +dependencies = [ + "itertools 0.11.0", + "nom", + "unicode_categories", +] + +[[package]] +name = "sqlite_database" +version = "0.0.1" +dependencies = [ + "anyhow", + "chrono", + "core_types", + "errors", + "log", + "once_cell", + "regex", + "serde", + "serde_derive", + "serde_json", + "sqlite_identifiers", + "sqlx", + "tempfile", + "tokio", + "workspace-build-acceleration", +] + +[[package]] +name = "sqlite_identifiers" +version = "0.0.1" +dependencies = [ + "rand 0.8.5", + "serde", + "serde_derive", + "serde_json", + "strum", + "workspace-build-acceleration", +] + +[[package]] +name = "sqlx" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c9a2ccff1a000a5a59cd33da541d9f2fdcd9e6e8229cc200565942bff36d0aaa" +dependencies = [ + "sqlx-core", + "sqlx-macros", + "sqlx-mysql", + "sqlx-postgres", + "sqlx-sqlite", +] + +[[package]] +name = "sqlx-core" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24ba59a9342a3d9bab6c56c118be528b27c9b60e490080e9711a04dccac83ef6" +dependencies = [ + "ahash 0.8.12", + "atoi", + "byteorder", + "bytes", + "chrono", + "crc", + "crossbeam-queue", + "either", + "event-listener 2.5.3", + "futures-channel", + "futures-core", + "futures-intrusive", + "futures-io", + "futures-util", + "hashlink", + "hex", + "indexmap 2.13.0", + "log", + "memchr", + "once_cell", + "paste", + "percent-encoding", + "rustls 0.21.12", + "rustls-pemfile 1.0.4", + "serde", + "serde_json", + "sha2 0.10.8", + "smallvec", + "sqlformat", + "thiserror 1.0.63", + "tokio", + "tokio-stream", + "tracing", + "url", + "webpki-roots 0.25.3", +] + +[[package]] +name = "sqlx-macros" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ea40e2345eb2faa9e1e5e326db8c34711317d2b5e08d0d5741619048a803127" +dependencies = [ + "proc-macro2", + "quote", + "sqlx-core", + "sqlx-macros-core", + "syn 1.0.109", +] + +[[package]] +name = "sqlx-macros-core" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5833ef53aaa16d860e92123292f1f6a3d53c34ba8b1969f152ef1a7bb803f3c8" +dependencies = [ + "dotenvy", + "either", + "heck 0.4.1", + "hex", + "once_cell", + "proc-macro2", + "quote", + "serde", + "serde_json", + "sha2 0.10.8", + "sqlx-core", + "sqlx-mysql", + "sqlx-postgres", + "sqlx-sqlite", + "syn 1.0.109", + "tempfile", + "tokio", + "url", +] + +[[package]] +name = "sqlx-mysql" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ed31390216d20e538e447a7a9b959e06ed9fc51c37b514b46eb758016ecd418" +dependencies = [ + "atoi", + "base64 0.21.7", + "bitflags 2.11.0", + "byteorder", + "bytes", + "chrono", + "crc", + "digest 0.10.7", + "dotenvy", + "either", + "futures-channel", + "futures-core", + "futures-io", + "futures-util", + "generic-array", + "hex", + "hkdf", + "hmac", + "itoa", + "log", + "md-5", + "memchr", + "once_cell", + "percent-encoding", + "rand 0.8.5", + "rsa", + "serde", + "sha1", + "sha2 0.10.8", + "smallvec", + "sqlx-core", + "stringprep", + "thiserror 1.0.63", + "tracing", + "whoami", +] + +[[package]] +name = "sqlx-postgres" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c824eb80b894f926f89a0b9da0c7f435d27cdd35b8c655b114e58223918577e" +dependencies = [ + "atoi", + "base64 0.21.7", + "bitflags 2.11.0", + "byteorder", + "chrono", + "crc", + "dotenvy", + "etcetera", + "futures-channel", + "futures-core", + "futures-io", + "futures-util", + "hex", + "hkdf", + "hmac", + "home", + "itoa", + "log", + "md-5", + "memchr", + "once_cell", + "rand 0.8.5", + "serde", + "serde_json", + "sha2 0.10.8", + "smallvec", + "sqlx-core", + "stringprep", + "thiserror 1.0.63", + "tracing", + "whoami", +] + +[[package]] +name = "sqlx-sqlite" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b244ef0a8414da0bed4bb1910426e890b19e5e9bccc27ada6b797d05c55ae0aa" +dependencies = [ + "atoi", + "chrono", + "flume", + "futures-channel", + "futures-core", + "futures-executor", + "futures-intrusive", + "futures-util", + "libsqlite3-sys", + "log", + "percent-encoding", + "serde", + "sqlx-core", + "tracing", + "url", + "urlencoding", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3" + +[[package]] +name = "string_cache" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf776ba3fa74f83bf4b63c3dcbbf82173db2632ed8452cb2d891d33f459de70f" +dependencies = [ + "new_debug_unreachable", + "parking_lot", + "phf_shared 0.11.3", + "precomputed-hash", + "serde", +] + +[[package]] +name = "string_cache" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a18596f8c785a729f2819c0f6a7eae6ebeebdfffbfe4214ae6b087f690e31901" +dependencies = [ + "new_debug_unreachable", + "parking_lot", + "phf_shared 0.13.1", + "precomputed-hash", +] + +[[package]] +name = "string_cache_codegen" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c711928715f1fe0fe509c53b43e993a9a557babc2d0a3567d0a3006f1ac931a0" +dependencies = [ + "phf_generator 0.11.2", + "phf_shared 0.11.3", + "proc-macro2", + "quote", +] + +[[package]] +name = "string_cache_codegen" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "585635e46db231059f76c5849798146164652513eb9e8ab2685939dd90f29b69" +dependencies = [ + "phf_generator 0.13.1", + "phf_shared 0.13.1", + "proc-macro2", + "quote", +] + +[[package]] +name = "stringprep" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb41d74e231a107a1b4ee36bd1214b11285b77768d2e3824aedafa988fd36ee6" +dependencies = [ + "finl_unicode", + "unicode-bidi", + "unicode-normalization", +] + +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + +[[package]] +name = "strum" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9628de9b8791db39ceda2b119bbe13134770b56c138ec1d3af810d045c04f9bd" +dependencies = [ + "strum_macros", +] + +[[package]] +name = "strum_macros" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab85eea0270ee17587ed4156089e10b9e6880ee688791d45a905f5b1ca36f664" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "subtle" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "81cdd64d312baedb58e21336b31bc043b77e01cc99033ce76ef539f78e965ebc" + +[[package]] +name = "swift-rs" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4057c98e2e852d51fdcfca832aac7b571f6b351ad159f9eda5db1655f8d0c4d7" +dependencies = [ + "base64 0.21.7", + "serde", + "serde_json", +] + +[[package]] +name = "syn" +version = "1.0.109" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "2.0.117" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "3.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12df2e0110f65b775f769bb17ef989067a1d931b2eb822bd4346631eeada89f9" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" +dependencies = [ + "futures-core", +] + +[[package]] +name = "synstructure" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "system-configuration" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c879d448e9d986b661742763247d3693ed13609438cf3d006f51f5368a5ba6b" +dependencies = [ + "bitflags 2.11.0", + "core-foundation 0.9.4", + "system-configuration-sys", +] + +[[package]] +name = "system-configuration-sys" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e1d1b10ced5ca923a1fcb8d03e96b8d3268065d724548c0211415ff6ac6bac4" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "system-deps" +version = "6.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3e535eb8dded36d55ec13eddacd30dec501792ff23a0b1682c38601b8cf2349" +dependencies = [ + "cfg-expr", + "heck 0.5.0", + "pkg-config", + "toml 0.8.23", + "version-compare", +] + +[[package]] +name = "tao" +version = "0.35.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1c93047acf68669466a34690ac58cca7010bd1b201e1ec86f1fd0a75d3dd4a9" +dependencies = [ + "bitflags 2.11.0", + "block2 0.6.1", + "core-foundation 0.10.0", + "core-graphics 0.25.0", + "crossbeam-channel", + "dbus", + "dispatch2", + "dlopen2", + "dpi", + "gdkwayland-sys", + "gdkx11-sys", + "gtk", + "jni", + "libc", + "log", + "ndk", + "ndk-sys", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-foundation 0.3.1", + "objc2-ui-kit", + "once_cell", + "parking_lot", + "percent-encoding", + "raw-window-handle", + "tao-macros", + "unicode-segmentation", + "url", + "windows", + "windows-core 0.61.2", + "windows-version", + "x11-dl", +] + +[[package]] +name = "tao-macros" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f4e16beb8b2ac17db28eab8bca40e62dbfbb34c0fcdc6d9826b11b7b5d047dfd" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "tap" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "55937e1799185b12863d447f42597ed69d9928686b8d88a1df17376a097d8369" + +[[package]] +name = "target-lexicon" +version = "0.12.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1fc403891a21bcfb7c37834ba66a547a8f402146eba7265b5a6d88059c9ff2f" + +[[package]] +name = "tauri" +version = "2.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "437404997acf375d85f1177afa7e11bb971f274ed6a7b83a2a3e339015f4cc28" +dependencies = [ + "anyhow", + "bytes", + "cookie", + "dirs", + "dunce", + "embed_plist", + "getrandom 0.3.1", + "glob", + "gtk", + "heck 0.5.0", + "http", + "http-range", + "jni", + "libc", + "log", + "mime", + "muda", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-foundation 0.3.1", + "objc2-ui-kit", + "objc2-web-kit", + "percent-encoding", + "plist", + "raw-window-handle", + "reqwest 0.13.2", + "serde", + "serde_json", + "serde_repr", + "serialize-to-javascript", + "swift-rs", + "tauri-build", + "tauri-macros", + "tauri-runtime", + "tauri-runtime-wry", + "tauri-utils", + "thiserror 2.0.18", + "tokio", + "tray-icon", + "url", + "webkit2gtk", + "webview2-com", + "window-vibrancy", + "windows", +] + +[[package]] +name = "tauri-build" +version = "2.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4aa1f9055fc23919a54e4e125052bed16ed04aef0487086e758fe01a67b451c7" +dependencies = [ + "anyhow", + "cargo_toml", + "dirs", + "glob", + "heck 0.5.0", + "json-patch", + "schemars", + "semver", + "serde", + "serde_json", + "tauri-utils", + "tauri-winres", + "walkdir", +] + +[[package]] +name = "tauri-codegen" +version = "2.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4a0319528a025a38c4078e7dae2c446f4e63620ddb0659a643ede1cb38f90e9" +dependencies = [ + "base64 0.22.1", + "brotli", + "ico", + "json-patch", + "plist", + "png 0.17.16", + "proc-macro2", + "quote", + "semver", + "serde", + "serde_json", + "sha2 0.10.8", + "syn 2.0.117", + "tauri-utils", + "thiserror 2.0.18", + "time", + "url", + "uuid 1.22.0", + "walkdir", +] + +[[package]] +name = "tauri-macros" +version = "2.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae6cb4e3896c21d2f6da5b31251d2faea0153bba56ed0e970f918115dbee4924" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.117", + "tauri-codegen", + "tauri-utils", +] + +[[package]] +name = "tauri-plugin" +version = "2.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e126abc9e84e35cdfd01596140a73a1850cdb0df0a23acf0185776c30b469a6e" +dependencies = [ + "anyhow", + "glob", + "plist", + "schemars", + "serde", + "serde_json", + "tauri-utils", + "walkdir", +] + +[[package]] +name = "tauri-plugin-dialog" +version = "2.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65981abb771e74e571a38196c3baa11c459379164791eba0e67abc1a5fac9884" +dependencies = [ + "log", + "raw-window-handle", + "rfd", + "serde", + "serde_json", + "tauri", + "tauri-plugin", + "tauri-plugin-fs", + "thiserror 2.0.18", + "url", +] + +[[package]] +name = "tauri-plugin-fs" +version = "2.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7ecc274121aca0c036a2b42d1cbe83d368d348f54e0bb8a735c2b1548e8f371" +dependencies = [ + "anyhow", + "dunce", + "glob", + "log", + "objc2-foundation 0.3.1", + "percent-encoding", + "schemars", + "serde", + "serde_json", + "serde_repr", + "tauri", + "tauri-plugin", + "tauri-utils", + "thiserror 2.0.18", + "toml 1.0.7+spec-1.1.0", + "url", +] + +[[package]] +name = "tauri-plugin-http" +version = "2.4.3" +dependencies = [ + "bytes", + "cookie_store", + "data-url", + "http", + "regex", + "reqwest 0.12.23", + "schemars", + "serde", + "serde_json", + "tauri", + "tauri-plugin", + "tauri-plugin-fs", + "thiserror 2.0.18", + "tokio", + "tracing", + "url", + "urlpattern", +] + +[[package]] +name = "tauri-plugin-log" +version = "2.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7545bd67f070a4500432c826e2e0682146a1d6712aee22a2786490156b574d93" +dependencies = [ + "android_logger", + "byte-unit", + "fern", + "log", + "objc2 0.6.4", + "objc2-foundation 0.3.1", + "serde", + "serde_json", + "serde_repr", + "swift-rs", + "tauri", + "tauri-plugin", + "thiserror 2.0.18", + "time", +] + +[[package]] +name = "tauri-plugin-opener" +version = "2.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "17e1bea14edce6b793a04e2417e3fd924b9bc4faae83cdee7d714156cceeed29" +dependencies = [ + "dunce", + "glob", + "objc2-app-kit", + "objc2-foundation 0.3.1", + "open", + "schemars", + "serde", + "serde_json", + "tauri", + "tauri-plugin", + "thiserror 2.0.18", + "url", + "windows", + "zbus", +] + +[[package]] +name = "tauri-plugin-upload" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e2844560c33b360506cea7289626267f43be253a01018b53bd556e86163b9fd" +dependencies = [ + "futures-util", + "log", + "read-progress-stream", + "reqwest 0.12.23", + "serde", + "serde_json", + "tauri", + "tauri-plugin", + "thiserror 2.0.18", + "tokio", + "tokio-util", +] + +[[package]] +name = "tauri-runtime" +version = "2.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "48222d7116c8807eaa6fe2f372e023fae125084e61e6eca6d70b7961cdf129ef" +dependencies = [ + "cookie", + "dpi", + "gtk", + "http", + "jni", + "objc2 0.6.4", + "objc2-ui-kit", + "objc2-web-kit", + "raw-window-handle", + "serde", + "serde_json", + "tauri-utils", + "thiserror 2.0.18", + "url", + "webkit2gtk", + "webview2-com", + "windows", +] + +[[package]] +name = "tauri-runtime-wry" +version = "2.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b83849ee63ecb27a8e8d0fe51915ca215076914aca43f96db1179f0f415f6cd9" +dependencies = [ + "gtk", + "http", + "jni", + "log", + "objc2 0.6.4", + "objc2-app-kit", + "once_cell", + "percent-encoding", + "raw-window-handle", + "softbuffer", + "tao", + "tauri-runtime", + "tauri-utils", + "url", + "webkit2gtk", + "webview2-com", + "windows", + "wry", +] + +[[package]] +name = "tauri-utils" +version = "2.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "092379df9a707631978e6c56b1bc2401d387f01e2d4a3c123360d167bbb9aa95" +dependencies = [ + "anyhow", + "brotli", + "cargo_metadata", + "ctor", + "dom_query 0.27.0", + "dunce", + "glob", + "http", + "infer", + "json-patch", + "log", + "memchr", + "phf 0.13.1", + "plist", + "proc-macro2", + "quote", + "regex", + "schemars", + "semver", + "serde", + "serde-untagged", + "serde_json", + "serde_with", + "swift-rs", + "thiserror 2.0.18", + "toml 1.0.7+spec-1.1.0", + "url", + "urlpattern", + "uuid 1.22.0", + "walkdir", +] + +[[package]] +name = "tauri-winres" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56eaa45f707bedf34d19312c26d350bc0f3c59a47e58e8adbeecdc850d2c13a0" +dependencies = [ + "embed-resource", + "toml 0.8.23", +] + +[[package]] +name = "tempdir" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15f2b5fb00ccdf689e0149d1b1b3c03fead81c2b37735d812fa8bddbbf41b6d8" +dependencies = [ + "rand 0.4.6", + "remove_dir_all", +] + +[[package]] +name = "tempfile" +version = "3.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" +dependencies = [ + "fastrand", + "getrandom 0.4.1", + "once_cell", + "rustix 1.1.4", + "windows-sys 0.61.2", +] + +[[package]] +name = "tendril" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d24a120c5fc464a3458240ee02c299ebcb9d67b5249c8848b09d639dca8d7bb0" +dependencies = [ + "futf", + "mac", + "utf-8", +] + +[[package]] +name = "tendril" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4790fc369d5a530f4b544b094e31388b9b3a37c0f4652ade4505945f5660d24" +dependencies = [ + "new_debug_unreachable", + "utf-8", +] + +[[package]] +name = "test_data" +version = "0.0.1" +dependencies = [ + "anyhow", + "errors", + "workspace-build-acceleration", +] + +[[package]] +name = "test_utils" +version = "0.0.1" +dependencies = [ + "errors", + "workspace-build-acceleration", +] + +[[package]] +name = "thiserror" +version = "1.0.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0342370b38b6a11b6cc11d6a805569958d54cfa061a29969c3b5ce2ea405724" +dependencies = [ + "thiserror-impl 1.0.63", +] + +[[package]] +name = "thiserror" +version = "2.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4" +dependencies = [ + "thiserror-impl 2.0.18", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "thread-id" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "99043e46c5a15af379c06add30d9c93a6c0e8849de00d244c4a2c417da128d80" +dependencies = [ + "libc", + "windows-sys 0.59.0", +] + +[[package]] +name = "thumbnails" +version = "0.0.1" +dependencies = [ + "images", + "log", + "mp4", + "openh264", + "tempfile", + "webp-animation", + "workspace-build-acceleration", +] + +[[package]] +name = "tiff" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6d172b0f4d3fba17ba89811858b9d3d97f928aece846475bbda076ca46736211" +dependencies = [ + "flate2", + "jpeg-decoder", + "weezl", +] + +[[package]] +name = "time" +version = "0.3.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5dfd88e563464686c916c7e46e623e520ddc6d79fa6641390f2e3fa86e83e885" +dependencies = [ + "deranged", + "itoa", + "libc", + "num-conv", + "num_threads", + "powerfmt", + "serde", + "time-core", + "time-macros", +] + +[[package]] +name = "time-core" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef927ca75afb808a4d64dd374f00a2adf8d0fcff8e7b184af886c3c87ec4a3f3" + +[[package]] +name = "time-macros" +version = "0.2.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f252a68540fde3a3877aeea552b832b40ab9a69e318efd078774a01ddee1ccf" +dependencies = [ + "num-conv", + "time-core", +] + +[[package]] +name = "tinystr" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9117f5d4db391c1cf6927e7bea3db74b9a1c1add8f7eda9ffd5364f40f57b82f" +dependencies = [ + "displaydoc", + "zerovec", +] + +[[package]] +name = "tinyvec" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +dependencies = [ + "tinyvec_macros", +] + +[[package]] +name = "tinyvec_macros" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" + +[[package]] +name = "tokio" +version = "1.50.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27ad5e34374e03cfffefc301becb44e9dc3c17584f414349ebe29ed26661822d" +dependencies = [ + "bytes", + "libc", + "mio", + "parking_lot", + "pin-project-lite", + "signal-hook-registry", + "socket2 0.6.2", + "tokio-macros", + "windows-sys 0.61.2", +] + +[[package]] +name = "tokio-boring2" +version = "5.0.0-alpha.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f81df1210d791f31d72d840de8fbd80b9c3cb324956523048b1413e2bd55756" +dependencies = [ + "boring2", + "tokio", +] + +[[package]] +name = "tokio-macros" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af407857209536a95c8e56f8231ef2c2e2aff839b22e07a1ffcbc617e9db9fa5" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "tokio-native-tls" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbae76ab933c85776efabc971569dd6119c580d8f5d448769dec1764bf796ef2" +dependencies = [ + "native-tls", + "tokio", +] + +[[package]] +name = "tokio-rustls" +version = "0.26.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c7bc40d0e5a97695bb96e27995cd3a08538541b0a846f65bba7a359f36700d4" +dependencies = [ + "rustls 0.23.36", + "rustls-pki-types", + "tokio", +] + +[[package]] +name = "tokio-stream" +version = "0.1.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32da49809aab5c3bc678af03902d4ccddea2a87d028d86392a4b1560c6906c70" +dependencies = [ + "futures-core", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "tokio-tungstenite" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d25a406cddcc431a75d3d9afc6a7c0f7428d4891dd973e4d54c56b46127bf857" +dependencies = [ + "futures-util", + "log", + "tokio", + "tungstenite", +] + +[[package]] +name = "tokio-util" +version = "0.7.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ae9cec805b01e8fc3fd2fe289f89149a9b66dd16786abd8b19cfa7b48cb0098" +dependencies = [ + "bytes", + "futures-core", + "futures-sink", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "toml" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc1beb996b9d83529a9e75c17a1686767d148d70663143c7854d8b4a09ced362" +dependencies = [ + "serde", + "serde_spanned 0.6.9", + "toml_datetime 0.6.11", + "toml_edit 0.22.27", +] + +[[package]] +name = "toml" +version = "1.0.7+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd28d57d8a6f6e458bc0b8784f8fdcc4b99a437936056fa122cb234f18656a96" +dependencies = [ + "indexmap 2.13.0", + "serde_core", + "serde_spanned 1.0.4", + "toml_datetime 1.0.1+spec-1.1.0", + "toml_parser", + "toml_writer", + "winnow 1.0.0", +] + +[[package]] +name = "toml_datetime" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22cddaf88f4fbc13c51aebbf5f8eceb5c7c5a9da2ac40a13519eb5b0a0e8f11c" +dependencies = [ + "serde", +] + +[[package]] +name = "toml_datetime" +version = "1.0.1+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b320e741db58cac564e26c607d3cc1fdc4a88fd36c879568c07856ed83ff3e9" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_edit" +version = "0.19.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b5bb770da30e5cbfde35a2d7b9b8a2c4b8ef89548a7a6aeab5c9a576e3e7421" +dependencies = [ + "indexmap 2.13.0", + "toml_datetime 0.6.11", + "winnow 0.5.40", +] + +[[package]] +name = "toml_edit" +version = "0.20.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70f427fce4d84c72b5b732388bf4a9f4531b53f74e2887e3ecb2481f68f66d81" +dependencies = [ + "indexmap 2.13.0", + "toml_datetime 0.6.11", + "winnow 0.5.40", +] + +[[package]] +name = "toml_edit" +version = "0.22.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41fe8c660ae4257887cf66394862d21dbca4a6ddd26f04a3560410406a2f819a" +dependencies = [ + "indexmap 2.13.0", + "serde", + "serde_spanned 0.6.9", + "toml_datetime 0.6.11", + "toml_write", + "winnow 0.7.13", +] + +[[package]] +name = "toml_edit" +version = "0.25.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ca1a40644a28bce036923f6a431df0b34236949d111cc07cb6dca830c9ef2e1" +dependencies = [ + "indexmap 2.13.0", + "toml_datetime 1.0.1+spec-1.1.0", + "toml_parser", + "winnow 1.0.0", +] + +[[package]] +name = "toml_parser" +version = "1.0.10+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7df25b4befd31c4816df190124375d5a20c6b6921e2cad937316de3fccd63420" +dependencies = [ + "winnow 1.0.0", +] + +[[package]] +name = "toml_write" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d99f8c9a7727884afe522e9bd5edbfc91a3312b36a77b5fb8926e4c31a41801" + +[[package]] +name = "toml_writer" +version = "1.0.7+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f17aaa1c6e3dc22b1da4b6bba97d066e354c7945cac2f7852d4e4e7ca7a6b56d" + +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-http" +version = "0.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4e6559d53cc268e5031cd8429d05415bc4cb4aefc4aa5d6cc35fbf5b924a1f8" +dependencies = [ + "async-compression", + "bitflags 2.11.0", + "bytes", + "futures-core", + "futures-util", + "http", + "http-body", + "http-body-util", + "iri-string", + "pin-project-lite", + "tokio", + "tokio-util", + "tower", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + +[[package]] +name = "tracing" +version = "0.1.41" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "784e0ac535deb450455cbfa28a6f0df145ea1bb7ae51b821cf5e7927fdcfbdd0" +dependencies = [ + "log", + "pin-project-lite", + "tracing-attributes", + "tracing-core", +] + +[[package]] +name = "tracing-attributes" +version = "0.1.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "395ae124c09f9e6918a2310af6038fba074bcf474ac352496d5910dd59a2226d" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "tracing-core" +version = "0.1.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e672c95779cf947c5311f83787af4fa8fffd12fb27e4993211a84bdfd9610f9c" +dependencies = [ + "once_cell", +] + +[[package]] +name = "tray-icon" +version = "0.23.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15edbb0d80583e85ee8df283410038e17314df5cba30da2087a54a85216c0773" +dependencies = [ + "crossbeam-channel", + "dirs", + "libappindicator", + "muda", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-foundation 0.3.1", + "once_cell", + "png 0.18.1", + "serde", + "thiserror 2.0.18", + "windows-sys 0.61.2", +] + +[[package]] +name = "try-lock" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" + +[[package]] +name = "tungstenite" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8628dcc84e5a09eb3d8423d6cb682965dea9133204e8fb3efee74c2a0c259442" +dependencies = [ + "bytes", + "data-encoding", + "http", + "httparse", + "log", + "rand 0.9.2", + "sha1", + "thiserror 2.0.18", + "utf-8", +] + +[[package]] +name = "typed-builder" +version = "0.23.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31aa81521b70f94402501d848ccc0ecaa8f93c8eb6999eb9747e72287757ffda" +dependencies = [ + "typed-builder-macro", +] + +[[package]] +name = "typed-builder-macro" +version = "0.23.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "076a02dc54dd46795c2e9c8282ed40bcfb1e22747e955de9389a1de28190fb26" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "typeid" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0e13db2e0ccd5e14a544e8a246ba2312cd25223f616442d7f2cb0e3db614236e" + +[[package]] +name = "typemap-ors" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a68c24b707f02dd18f1e4ccceb9d49f2058c2fb86384ef9972592904d7a28867" +dependencies = [ + "unsafe-any-ors", +] + +[[package]] +name = "typenum" +version = "1.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825" + +[[package]] +name = "uds_windows" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89daebc3e6fd160ac4aa9fc8b3bf71e1f74fbf92367ae71fb83a037e8bf164b9" +dependencies = [ + "memoffset", + "tempfile", + "winapi", +] + +[[package]] +name = "ulid" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "470dbf6591da1b39d43c14523b2b469c86879a53e8b758c8e090a470fe7b1fbe" +dependencies = [ + "rand 0.9.2", + "web-time", +] + +[[package]] +name = "unic-char-property" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8c57a407d9b6fa02b4795eb81c5b6652060a15a7903ea981f3d723e6c0be221" +dependencies = [ + "unic-char-range", +] + +[[package]] +name = "unic-char-range" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0398022d5f700414f6b899e10b8348231abf9173fa93144cbc1a43b9793c1fbc" + +[[package]] +name = "unic-common" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "80d7ff825a6a654ee85a63e80f92f054f904f21e7d12da4e22f9834a4aaa35bc" + +[[package]] +name = "unic-ucd-ident" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e230a37c0381caa9219d67cf063aa3a375ffed5bf541a452db16e744bdab6987" +dependencies = [ + "unic-char-property", + "unic-char-range", + "unic-ucd-version", +] + +[[package]] +name = "unic-ucd-version" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96bd2f2237fe450fcd0a1d2f5f4e91711124f7857ba2e964247776ebeeb7b0c4" +dependencies = [ + "unic-common", +] + +[[package]] +name = "unicase" +version = "2.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75b844d17643ee918803943289730bec8aac480150456169e647ed0b576ba539" + +[[package]] +name = "unicode-bidi" +version = "0.3.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08f95100a766bf4f8f28f90d77e0a5461bbdb219042e7679bebe79004fed8d75" + +[[package]] +name = "unicode-ident" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" + +[[package]] +name = "unicode-normalization" +version = "0.1.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a56d1686db2308d901306f92a263857ef59ea39678a5458e7cb17f01415101f5" +dependencies = [ + "tinyvec", +] + +[[package]] +name = "unicode-segmentation" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6ccf251212114b54433ec949fd6a7841275f9ada20dddd2f29e9ceea4501493" + +[[package]] +name = "unicode-width" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ac048d71ede7ee76d585517add45da530660ef4390e49b098733c6e897f254" + +[[package]] +name = "unicode-xid" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" + +[[package]] +name = "unicode_categories" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39ec24b3121d976906ece63c9daad25b85969647682eee313cb5779fdd69e14e" + +[[package]] +name = "unsafe-any-ors" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e0a303d30665362d9680d7d91d78b23f5f899504d4f08b3c4cf08d055d87c0ad" +dependencies = [ + "destructure_traitobject", +] + +[[package]] +name = "unsafe-libyaml" +version = "0.2.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "673aac59facbab8a9007c7f6108d11f63b603f7cabff99fabf650fea5c32b861" + +[[package]] +name = "untrusted" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" + +[[package]] +name = "url" +version = "2.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" +dependencies = [ + "form_urlencoded", + "idna", + "percent-encoding", + "serde", + "serde_derive", +] + +[[package]] +name = "url-builder" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c560d19163937c53680c515b82a9311c5a796691c67890b8ad579423123e194" + +[[package]] +name = "url_utils" +version = "0.0.1" +dependencies = [ + "url", + "workspace-build-acceleration", +] + +[[package]] +name = "urlencoding" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "daf8dba3b7eb870caf1ddeed7bc9d2a049f3cfdfae7cb521b087cc33ae4c49da" + +[[package]] +name = "urlpattern" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70acd30e3aa1450bc2eece896ce2ad0d178e9c079493819301573dae3c37ba6d" +dependencies = [ + "regex", + "serde", + "unic-ucd-ident", + "url", +] + +[[package]] +name = "utf-8" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9" + +[[package]] +name = "utf16_iter" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8232dd3cdaed5356e0f716d285e4b40b932ac434100fe9b7e0e8e935b9e6246" + +[[package]] +name = "utf8-width" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86bd8d4e895da8537e5315b8254664e6b769c4ff3db18321b297a1e7004392e3" + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + +[[package]] +name = "uuid" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bc5cf98d8186244414c848017f0e2676b3fcb46807f6668a97dfe67359a3c4b7" +dependencies = [ + "getrandom 0.2.14", +] + +[[package]] +name = "uuid" +version = "1.22.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a68d3c8f01c0cfa54a75291d83601161799e4a89a39e0929f4b0354d88757a37" +dependencies = [ + "getrandom 0.4.1", + "js-sys", + "serde_core", + "wasm-bindgen", +] + +[[package]] +name = "uuid_utils" +version = "0.0.1" +dependencies = [ + "uuid 1.22.0", + "workspace-build-acceleration", +] + +[[package]] +name = "v_frame" +version = "0.3.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6f32aaa24bacd11e488aa9ba66369c7cd514885742c9fe08cfe85884db3e92b" +dependencies = [ + "aligned-vec", + "num-traits", + "wasm-bindgen", +] + +[[package]] +name = "value-bag" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ba6f5989077681266825251a52748b8c1d8a4ad098cc37e440103d0ea717fc0" + +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + +[[package]] +name = "version-compare" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "852e951cb7832cb45cb1169900d19760cfa39b82bc0ea9c0e5a14ae88411c98b" + +[[package]] +name = "version_check" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" + +[[package]] +name = "vswhom" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be979b7f07507105799e854203b470ff7c78a1639e330a58f183b5fea574608b" +dependencies = [ + "libc", + "vswhom-sys", +] + +[[package]] +name = "vswhom-sys" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3b17ae1f6c8a2b28506cd96d412eebf83b4a0ff2cbefeeb952f2f9dfa44ba18" +dependencies = [ + "cc", + "libc", +] + +[[package]] +name = "walkdir" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "want" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfa7760aed19e106de2c7c0b581b509f2f25d3dacaf737cb82ac61bc6d760b0e" +dependencies = [ + "try-lock", +] + +[[package]] +name = "wasi" +version = "0.11.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" + +[[package]] +name = "wasi" +version = "0.13.3+wasi-0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26816d2e1a4a36a2940b96c5296ce403917633dff8f3440e9b236ed6f6bacad2" +dependencies = [ + "wit-bindgen-rt", +] + +[[package]] +name = "wasip2" +version = "1.0.2+wasi-0.2.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9517f9239f02c069db75e65f174b3da828fe5f5b945c4dd26bd25d89c03ebcf5" +dependencies = [ + "wit-bindgen", +] + +[[package]] +name = "wasip3" +version = "0.4.0+wasi-0.3.0-rc-2026-01-06" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5428f8bf88ea5ddc08faddef2ac4a67e390b88186c703ce6dbd955e1c145aca5" +dependencies = [ + "wit-bindgen", +] + +[[package]] +name = "wasite" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8dad83b4f25e74f184f64c43b150b91efe7647395b42289f38e50566d82855b" + +[[package]] +name = "wasm-bindgen" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ddb3f79143bced6de84270411622a2699cee572fc0875aeaf1e7867cf9fca1a" +dependencies = [ + "cfg-if", + "once_cell", + "rustversion", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.75" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "503b14d284f2c8dac03b819967e155ea753f573586193b2b2c95990cb5d69280" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e21a184b13fb19e157296e2c46056aec9092264fab83e4ba59e68c61b323c3d" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fecefd9c35bd935a20fc3fc344b5f29138961e4f47fb03297d88f2587afb5ebd" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn 2.0.117", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.125" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23939e44bb9a5d7576fa2b563dc2e136628f1224e88a8deed09e04858b77871f" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "wasm-encoder" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "990065f2fe63003fe337b932cfb5e3b80e0b4d0f5ff650e6985b1048f62c8319" +dependencies = [ + "leb128fmt", + "wasmparser", +] + +[[package]] +name = "wasm-metadata" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb0e353e6a2fbdc176932bbaab493762eb1255a7900fe0fea1a2f96c296cc909" +dependencies = [ + "anyhow", + "indexmap 2.13.0", + "wasm-encoder", + "wasmparser", +] + +[[package]] +name = "wasm-streams" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b65dc4c90b63b118468cf747d8bf3566c1913ef60be765b5730ead9e0a3ba129" +dependencies = [ + "futures-util", + "js-sys", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + +[[package]] +name = "wasm-streams" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d1ec4f6517c9e11ae630e200b2b65d193279042e28edd4a2cda233e46670bbb" +dependencies = [ + "futures-util", + "js-sys", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + +[[package]] +name = "wasmparser" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47b807c72e1bac69382b3a6fb3dbe8ea4c0ed87ff5629b8685ae6b9a611028fe" +dependencies = [ + "bitflags 2.11.0", + "hashbrown 0.15.2", + "indexmap 2.13.0", + "semver", +] + +[[package]] +name = "web-sys" +version = "0.3.102" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6430a72df5eb332242960fe84b3002a241163998241eb596d4f739b9757061d" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web-time" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web_atoms" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57ffde1dc01240bdf9992e3205668b235e59421fd085e8a317ed98da0178d414" +dependencies = [ + "phf 0.11.2", + "phf_codegen 0.11.3", + "string_cache 0.8.9", + "string_cache_codegen 0.5.4", +] + +[[package]] +name = "web_atoms" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7cff6eef815df1834fd250e3a2ff436044d82a9f1bc1980ca1dbdf07effc538" +dependencies = [ + "phf 0.13.1", + "phf_codegen 0.13.1", + "string_cache 0.9.0", + "string_cache_codegen 0.6.1", +] + +[[package]] +name = "web_base64" +version = "0.0.1" +dependencies = [ + "base64 0.22.1", + "workspace-build-acceleration", +] + +[[package]] +name = "webkit2gtk" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1027150013530fb2eaf806408df88461ae4815a45c541c8975e61d6f2fc4793" +dependencies = [ + "bitflags 1.3.2", + "cairo-rs", + "gdk", + "gdk-sys", + "gio", + "gio-sys", + "glib", + "glib-sys", + "gobject-sys", + "gtk", + "gtk-sys", + "javascriptcore-rs", + "libc", + "once_cell", + "soup3", + "webkit2gtk-sys", +] + +[[package]] +name = "webkit2gtk-sys" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "916a5f65c2ef0dfe12fff695960a2ec3d4565359fdbb2e9943c974e06c734ea5" +dependencies = [ + "bitflags 1.3.2", + "cairo-sys-rs", + "gdk-sys", + "gio-sys", + "glib-sys", + "gobject-sys", + "gtk-sys", + "javascriptcore-rs-sys", + "libc", + "pkg-config", + "soup3-sys", + "system-deps", +] + +[[package]] +name = "webp-animation" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a656b424e13a9e8b35f2cb7f96ff81c9d796b7ce3b6966cd4f8fd4a15feba4" +dependencies = [ + "libwebp-sys2", + "log", +] + +[[package]] +name = "webpki-root-certs" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e4ffd8df1c57e87c325000a3d6ef93db75279dc3a231125aac571650f22b12a" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "webpki-roots" +version = "0.25.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1778a42e8b3b90bff8d0f5032bf22250792889a5cdc752aa0020c84abe3aaf10" + +[[package]] +name = "webpki-roots" +version = "0.26.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c452ad30530b54a4d8e71952716a212b08efd0f3562baa66c29a618b07da7c3" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "webpki-roots" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e8983c3ab33d6fb807cfcdad2491c4ea8cbc8ed839181c7dfd9c67c83e261b2" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "webview2-com" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4ba622a989277ef3886dd5afb3e280e3dd6d974b766118950a08f8f678ad6a4" +dependencies = [ + "webview2-com-macros", + "webview2-com-sys", + "windows", + "windows-core 0.61.2", + "windows-implement", + "windows-interface", +] + +[[package]] +name = "webview2-com-macros" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d228f15bba3b9d56dde8bddbee66fa24545bd17b48d5128ccf4a8742b18e431" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "webview2-com-sys" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "36695906a1b53a3bf5c4289621efedac12b73eeb0b89e7e1a89b517302d5d75c" +dependencies = [ + "thiserror 2.0.18", + "windows", + "windows-core 0.61.2", +] + +[[package]] +name = "weezl" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53a85b86a771b1c87058196170769dd264f66c0782acf1ae6cc51bfd64b39082" + +[[package]] +name = "whoami" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a44ab49fad634e88f55bf8f9bb3abd2f27d7204172a112c7c9987e01c1c94ea9" +dependencies = [ + "redox_syscall 0.4.1", + "wasite", +] + +[[package]] +name = "wide" +version = "0.7.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ce5da8ecb62bcd8ec8b7ea19f69a51275e91299be594ea5cc6ef7819e16cd03" +dependencies = [ + "bytemuck", + "safe_arch", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f29e6f9198ba0d26b4c9f07dbe6f9ed633e1f3d5b8b414090084349e46a52596" +dependencies = [ + "winapi", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "window-vibrancy" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9bec5a31f3f9362f2258fd0e9c9dd61a9ca432e7306cc78c444258f0dce9a9c" +dependencies = [ + "objc2 0.6.4", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation 0.3.1", + "raw-window-handle", + "windows-sys 0.59.0", + "windows-version", +] + +[[package]] +name = "windows" +version = "0.61.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9babd3a767a4c1aef6900409f85f5d53ce2544ccdfaa86dad48c91782c6d6893" +dependencies = [ + "windows-collections", + "windows-core 0.61.2", + "windows-future", + "windows-link 0.1.3", + "windows-numerics", +] + +[[package]] +name = "windows-collections" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3beeceb5e5cfd9eb1d76b381630e82c4241ccd0d27f1a39ed41b2760b255c5e8" +dependencies = [ + "windows-core 0.61.2", +] + +[[package]] +name = "windows-core" +version = "0.51.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1f8cf84f35d2db49a46868f947758c7a1138116f7fac3bc844f43ade1292e64" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows-core" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0fdd3ddb90610c7638aa2b3a3ab2904fb9e5cdbecc643ddb3647212781c4ae3" +dependencies = [ + "windows-implement", + "windows-interface", + "windows-link 0.1.3", + "windows-result", + "windows-strings", +] + +[[package]] +name = "windows-future" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc6a41e98427b19fe4b73c550f060b59fa592d7d686537eebf9385621bfbad8e" +dependencies = [ + "windows-core 0.61.2", + "windows-link 0.1.3", + "windows-threading", +] + +[[package]] +name = "windows-implement" +version = "0.60.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a47fddd13af08290e67f4acabf4b459f647552718f683a7b415d290ac744a836" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "windows-interface" +version = "0.59.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd9211b69f8dcdfa817bfd14bf1c97c9188afa36f4750130fcdf3f400eca9fa8" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "windows-link" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e6ad25900d524eaabdbbb96d20b4311e1e7ae1699af4fb28c17ae66c80d798a" + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-numerics" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9150af68066c4c5c07ddc0ce30421554771e528bde427614c61038bc2c92c2b1" +dependencies = [ + "windows-core 0.61.2", + "windows-link 0.1.3", +] + +[[package]] +name = "windows-registry" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b3bab093bdd303a1240bb99b8aba8ea8a69ee19d34c9e2ef9594e708a4878820" +dependencies = [ + "windows-link 0.1.3", + "windows-result", + "windows-strings", +] + +[[package]] +name = "windows-result" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56f42bd332cc6c8eac5af113fc0c1fd6a8fd2aa08a0119358686e5160d0586c6" +dependencies = [ + "windows-link 0.1.3", +] + +[[package]] +name = "windows-strings" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56e6c93f3a0c3b36176cb1327a4958a0353d5d166c2a35cb268ace15e91d3b57" +dependencies = [ + "windows-link 0.1.3", +] + +[[package]] +name = "windows-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" +dependencies = [ + "windows-targets 0.42.2", +] + +[[package]] +name = "windows-sys" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets 0.52.6", +] + +[[package]] +name = "windows-sys" +version = "0.59.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" +dependencies = [ + "windows-targets 0.52.6", +] + +[[package]] +name = "windows-sys" +version = "0.60.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2f500e4d28234f72040990ec9d39e3a6b950f9f22d3dba18416c35882612bcb" +dependencies = [ + "windows-targets 0.53.3", +] + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link 0.2.1", +] + +[[package]] +name = "windows-targets" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071" +dependencies = [ + "windows_aarch64_gnullvm 0.42.2", + "windows_aarch64_msvc 0.42.2", + "windows_i686_gnu 0.42.2", + "windows_i686_msvc 0.42.2", + "windows_x86_64_gnu 0.42.2", + "windows_x86_64_gnullvm 0.42.2", + "windows_x86_64_msvc 0.42.2", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm 0.48.5", + "windows_aarch64_msvc 0.48.5", + "windows_i686_gnu 0.48.5", + "windows_i686_msvc 0.48.5", + "windows_x86_64_gnu 0.48.5", + "windows_x86_64_gnullvm 0.48.5", + "windows_x86_64_msvc 0.48.5", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm 0.52.6", + "windows_aarch64_msvc 0.52.6", + "windows_i686_gnu 0.52.6", + "windows_i686_gnullvm 0.52.6", + "windows_i686_msvc 0.52.6", + "windows_x86_64_gnu 0.52.6", + "windows_x86_64_gnullvm 0.52.6", + "windows_x86_64_msvc 0.52.6", +] + +[[package]] +name = "windows-targets" +version = "0.53.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5fe6031c4041849d7c496a8ded650796e7b6ecc19df1a431c1a363342e5dc91" +dependencies = [ + "windows-link 0.1.3", + "windows_aarch64_gnullvm 0.53.0", + "windows_aarch64_msvc 0.53.0", + "windows_i686_gnu 0.53.0", + "windows_i686_gnullvm 0.53.0", + "windows_i686_msvc 0.53.0", + "windows_x86_64_gnu 0.53.0", + "windows_x86_64_gnullvm 0.53.0", + "windows_x86_64_msvc 0.53.0", +] + +[[package]] +name = "windows-threading" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b66463ad2e0ea3bbf808b7f1d371311c80e115c0b71d60efc142cafbcfb057a6" +dependencies = [ + "windows-link 0.1.3", +] + +[[package]] +name = "windows-version" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c12476c23a74725c539b24eae8bfc0dac4029c39cdb561d9f23616accd4ae26d" +dependencies = [ + "windows-targets 0.53.3", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86b8d5f90ddd19cb4a147a5fa63ca848db3df085e25fee3cc10b39b6eebae764" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7651a1f62a11b8cbd5e0d42526e55f2c99886c77e007179efff86c2b137e66c" + +[[package]] +name = "windows_i686_gnu" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnu" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1dc67659d35f387f5f6c479dc4e28f1d4bb90ddd1a5d3da2e5d97b42d6272c3" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ce6ccbdedbf6d6354471319e781c0dfef054c81fbc7cf83f338a4296c0cae11" + +[[package]] +name = "windows_i686_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + +[[package]] +name = "windows_i686_msvc" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "581fee95406bb13382d2f65cd4a908ca7b1e4c2f1917f143ba16efe98a589b5d" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2e55b5ac9ea33f2fc1716d1742db15574fd6fc8dadc51caab1c16a3d3b4190ba" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0a6e035dd0599267ce1ee132e51c27dd29437f63325753051e71dd9e42406c57" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "271414315aff87387382ec3d271b52d7ae78726f5d44ac98b4f4030c91880486" + +[[package]] +name = "winnow" +version = "0.5.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f593a95398737aeed53e489c785df13f3618e41dbcd6718c6addbf1395aa6876" +dependencies = [ + "memchr", +] + +[[package]] +name = "winnow" +version = "0.7.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "21a0236b59786fed61e2a80582dd500fe61f18b5dca67a4a067d0bc9039339cf" +dependencies = [ + "memchr", +] + +[[package]] +name = "winnow" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a90e88e4667264a994d34e6d1ab2d26d398dcdca8b7f52bec8668957517fc7d8" +dependencies = [ + "memchr", +] + +[[package]] +name = "winreg" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a277a57398d4bfa075df44f501a17cfdf8542d224f0d36095a2adc7aee4ef0a5" +dependencies = [ + "cfg-if", + "windows-sys 0.48.0", +] + +[[package]] +name = "wit-bindgen" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7249219f66ced02969388cf2bb044a09756a083d0fab1e566056b04d9fbcaa5" +dependencies = [ + "wit-bindgen-rust-macro", +] + +[[package]] +name = "wit-bindgen-core" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea61de684c3ea68cb082b7a88508a8b27fcc8b797d738bfc99a82facf1d752dc" +dependencies = [ + "anyhow", + "heck 0.5.0", + "wit-parser", +] + +[[package]] +name = "wit-bindgen-rt" +version = "0.33.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3268f3d866458b787f390cf61f4bbb563b922d091359f9608842999eaee3943c" +dependencies = [ + "bitflags 2.11.0", +] + +[[package]] +name = "wit-bindgen-rust" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7c566e0f4b284dd6561c786d9cb0142da491f46a9fbed79ea69cdad5db17f21" +dependencies = [ + "anyhow", + "heck 0.5.0", + "indexmap 2.13.0", + "prettyplease", + "syn 2.0.117", + "wasm-metadata", + "wit-bindgen-core", + "wit-component", +] + +[[package]] +name = "wit-bindgen-rust-macro" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c0f9bfd77e6a48eccf51359e3ae77140a7f50b1e2ebfe62422d8afdaffab17a" +dependencies = [ + "anyhow", + "prettyplease", + "proc-macro2", + "quote", + "syn 2.0.117", + "wit-bindgen-core", + "wit-bindgen-rust", +] + +[[package]] +name = "wit-component" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d66ea20e9553b30172b5e831994e35fbde2d165325bec84fc43dbf6f4eb9cb2" +dependencies = [ + "anyhow", + "bitflags 2.11.0", + "indexmap 2.13.0", + "log", + "serde", + "serde_derive", + "serde_json", + "wasm-encoder", + "wasm-metadata", + "wasmparser", + "wit-parser", +] + +[[package]] +name = "wit-parser" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ecc8ac4bc1dc3381b7f59c34f00b67e18f910c2c0f50015669dde7def656a736" +dependencies = [ + "anyhow", + "id-arena", + "indexmap 2.13.0", + "log", + "semver", + "serde", + "serde_derive", + "serde_json", + "unicode-xid", + "wasmparser", +] + +[[package]] +name = "workspace-build-acceleration" +version = "0.1.0" + +[[package]] +name = "wreq" +version = "6.0.0-rc.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f79937f6c4df65b3f6f78715b9de2977afe9ee3b3436483c7949a24511e25935" +dependencies = [ + "ahash 0.8.12", + "boring2", + "brotli", + "bytes", + "cookie", + "flate2", + "futures-channel", + "futures-util", + "http", + "http-body", + "http-body-util", + "http2", + "httparse", + "ipnet", + "libc", + "mime_guess", + "percent-encoding", + "pin-project-lite", + "schnellru", + "serde", + "serde_json", + "serde_urlencoded", + "smallvec", + "socket2 0.6.2", + "sync_wrapper", + "tokio", + "tokio-boring2", + "tokio-tungstenite", + "tokio-util", + "tower", + "tower-http", + "url", + "want", + "webpki-root-certs", + "zstd", +] + +[[package]] +name = "wreq-util" +version = "3.0.0-rc.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c6bbe24d28beb9ceb58b514bd6a613c759d3b706f768b9d2950d5d35b543c04" +dependencies = [ + "typed-builder", + "wreq", +] + +[[package]] +name = "write16" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1890f4022759daae28ed4fe62859b1236caebfc61ede2f63ed4e695f3f6d936" + +[[package]] +name = "writeable" +version = "0.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e9df38ee2d2c3c5948ea468a8406ff0db0b29ae1ffde1bcf20ef305bcc95c51" + +[[package]] +name = "wry" +version = "0.55.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "186f9871daa55fd9c016578b810d149de58367113db7fb72b462d2323ce19514" +dependencies = [ + "base64 0.22.1", + "block2 0.6.1", + "cookie", + "crossbeam-channel", + "dirs", + "dom_query 0.27.0", + "dpi", + "dunce", + "gdkx11", + "gtk", + "http", + "javascriptcore-rs", + "jni", + "libc", + "ndk", + "objc2 0.6.4", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation 0.3.1", + "objc2-ui-kit", + "objc2-web-kit", + "once_cell", + "percent-encoding", + "raw-window-handle", + "sha2 0.10.8", + "soup3", + "tao-macros", + "thiserror 2.0.18", + "url", + "webkit2gtk", + "webkit2gtk-sys", + "webview2-com", + "windows", + "windows-core 0.61.2", + "windows-version", + "x11-dl", +] + +[[package]] +name = "wyz" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "05f360fc0b24296329c78fda852a1e9ae82de9cf7b27dae4b7f62f118f77b9ed" +dependencies = [ + "tap", +] + +[[package]] +name = "x11" +version = "2.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "502da5464ccd04011667b11c435cb992822c2c0dbde1770c988480d312a0db2e" +dependencies = [ + "libc", + "pkg-config", +] + +[[package]] +name = "x11-dl" +version = "2.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38735924fedd5314a6e548792904ed8c6de6636285cb9fec04d5b1db85c1516f" +dependencies = [ + "libc", + "once_cell", + "pkg-config", +] + +[[package]] +name = "yansi" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" + +[[package]] +name = "yoke" +version = "0.7.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "120e6aef9aa629e3d4f52dc8cc43a015c7724194c97dfaf45180d2daf2b77f40" +dependencies = [ + "serde", + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.7.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2380878cad4ac9aac1e2435f3eb4020e8374b5f13c296cb75b4620ff8e229154" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", + "synstructure", +] + +[[package]] +name = "zbus" +version = "5.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eee682d202a77e4a9f3b2c2bdf48a7b28af5c08c34ddf66f98c93e5e39464285" +dependencies = [ + "async-broadcast", + "async-executor", + "async-io", + "async-lock", + "async-process", + "async-recursion", + "async-task", + "async-trait", + "blocking", + "enumflags2", + "event-listener 5.4.1", + "futures-core", + "futures-lite", + "hex", + "libc", + "ordered-stream", + "rustix 1.1.4", + "serde", + "serde_repr", + "tracing", + "uds_windows", + "uuid 1.22.0", + "windows-sys 0.61.2", + "winnow 1.0.0", + "zbus_macros", + "zbus_names", + "zvariant", +] + +[[package]] +name = "zbus_macros" +version = "5.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "adf1bd45a81a103745b1757754762a26e8cd01e4532e4d6c8ec431624b80d1d6" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 2.0.117", + "zbus_names", + "zvariant", + "zvariant_utils", +] + +[[package]] +name = "zbus_names" +version = "4.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7074f3e50b894eac91750142016d30d0a89be8e67dbfd9704fb875825760e52d" +dependencies = [ + "serde", + "winnow 1.0.0", + "zvariant", +] + +[[package]] +name = "zerocopy" +version = "0.8.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0894878a5fa3edfd6da3f88c4805f4c8558e2b996227a3d864f47fe11e38282c" +dependencies = [ + "zerocopy-derive", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88d2b8d9c68ad2b9e4340d7832716a4d21a22a1154777ad56ea55c51a9cf3831" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "zerofrom" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cff3ee08c995dee1859d998dea82f7374f2826091dd9cd47def953cae446cd2e" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "595eed982f7d355beb85837f651fa22e90b3c044842dc7f2c2842c086f295808" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", + "synstructure", +] + +[[package]] +name = "zeroize" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ced3678a2879b30306d323f4542626697a464a97c0a07c9aebf7ebca65cd4dde" + +[[package]] +name = "zerovec" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa2b893d79df23bfb12d5461018d408ea19dfafe76c2c7ef6d4eba614f8ff079" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6eafa6dfb17584ea3e2bd6e76e0cc15ad7af12b09abdd1ca55961bed9b1063c6" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.117", +] + +[[package]] +name = "zmij" +version = "1.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8848ee67ecc8aedbaf3e4122217aff892639231befc6a1b58d29fff4c2cabaa" + +[[package]] +name = "zstd" +version = "0.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e91ee311a569c327171651566e07972200e76fcfe2242a4fa446149a3881c08a" +dependencies = [ + "zstd-safe", +] + +[[package]] +name = "zstd-safe" +version = "7.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1cd99b45c6bc03a018c8b8a86025678c87e55526064e38f9df301989dce7ec0a" +dependencies = [ + "zstd-sys", +] + +[[package]] +name = "zstd-sys" +version = "2.0.10+zstd.1.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c253a4914af5bafc8fa8c86ee400827e83cf6ec01195ec1f1ed8441bf00d65aa" +dependencies = [ + "cc", + "pkg-config", +] + +[[package]] +name = "zune-core" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f423a2c17029964870cfaabb1f13dfab7d092a62a29a89264f4d36990ca414a" + +[[package]] +name = "zune-inflate" +version = "0.2.54" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73ab332fe2f6680068f3582b16a24f90ad7096d5d39b974d1c0aff0125116f02" +dependencies = [ + "simd-adler32", +] + +[[package]] +name = "zune-jpeg" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "99a5bab8d7dedf81405c4bb1f2b83ea057643d9cb28778cea9eecddeedd2e028" +dependencies = [ + "zune-core", +] + +[[package]] +name = "zvariant" +version = "5.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a192a0bde63360d77a7523c833d4b4ce6070a927e2c53246e4c540b1a3e27be0" +dependencies = [ + "endi", + "enumflags2", + "serde", + "winnow 1.0.0", + "zvariant_derive", + "zvariant_utils", +] + +[[package]] +name = "zvariant_derive" +version = "5.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "90bc6cde9c01c511074be97f7ccb6c19d0da89e3f8662e812e999dcfd4638737" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 2.0.117", + "zvariant_utils", +] + +[[package]] +name = "zvariant_utils" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e8535915cfa75547e559d8c68e8139909a4aeee076831e4ef7fc59d8172c4d6" +dependencies = [ + "proc-macro2", + "quote", + "serde", + "syn 2.0.117", + "winnow 1.0.0", +] diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 00000000..5b9c72b0 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,189 @@ +[workspace] +resolver = "2" + +# This block defines the workspace members. +# When we add a library or binary crate, it needs an entry here. +members = [ + # API clients for external services + # These might be custom implementations or wrappers over other client libraries. + "crates/api_clients/artcraft_client", + "crates/api_clients/fal_client", + "crates/api_clients/gmicloud_client", + "crates/api_clients/grok_api_client", + "crates/api_clients/grok_consumer_client", + "crates/api_clients/grok_consumer_statsig", + "crates/api_clients/higgsfield_client", + "crates/api_clients/midjourney_client", + "crates/router", + "crates/api_clients/seedance2pro_client", + + # Desktop apps + "crates/artcraftx", + + # Highest-level shared types: enums and identifiers used across the workspace + "crates/core_types", + + # Every generation model (image, video, mesh, splat, audio) and its capabilities + "crates/models", + + # Shared libraries + "crates/lib/browser_emulation", + "crates/lib/build_metadata", + "crates/lib/caching/memory_store", + "crates/lib/cloudflare_errors", + "crates/lib/cloudflare_mitigation", + "crates/lib/cookie_store_wrapper", + "crates/lib/datadome_errors", + "crates/lib/datadome_mitigation", + "crates/lib/data/primitives", + "crates/lib/data/web_base64", + "crates/lib/errors", + "crates/lib/files/file_hashing", + "crates/lib/files/file_to_base64_url", + "crates/lib/files/filesys", + "crates/lib/files/images", + "crates/lib/files/mimetypes", + "crates/lib/files/thumbnails", + "crates/lib/http_headers", + "crates/lib/jwt_light", + "crates/lib/url_utils", + "crates/lib/uuid_utils", + + # Local task storage (SQLite, embedded migrations) + "crates/schema/local_files_database", + "crates/schema/sqlite_database", + "crates/schema/sqlite_identifiers", + + # Schema (public): common strongly-typed tokens, ids, payloads, etc. + + # Testing code + "crates/testing/test_data", + "crates/testing/test_utils", + + # Vendored code + "crates/vendor/tauri-plugin-http", + + # cargo-hakari workspace hack (compilation speedup hack) + # NB: Currently disabled (empty crate); kept so member crates can depend on it. + "crates/workspace-build-acceleration", +] + +[workspace.package] +# Common inheritable settings for monorepo packages +publish = false + +# NB: Profiles must live at the workspace root; profiles in member crates are ignored. +[profile.dev] +incremental = true # Compile your binary in smaller steps. + +[profile.release] +codegen-units = 1 # Allows LLVM to perform better optimization. +lto = true # Enables link-time-optimizations. +opt-level = 3 # `s` prioritizes small binary size. Use `3` if you prefer speed. +panic = "abort" # Higher performance by disabling panic handlers. +strip = true # Ensures debug symbols are removed. + +[workspace.dependencies] +# Hakari workspace hack (faster compile times) +workspace-build-acceleration = { path = "crates/workspace-build-acceleration" } + +# Internal libs +# Setting paths here ensures we don't need to do so in every crate's Cargo.toml +# It makes refactoring much easier. +artcraft_client = { path = "crates/api_clients/artcraft_client" } +build_metadata = { path = "crates/lib/build_metadata" } +cloudflare_errors = { path = "crates/lib/cloudflare_errors" } +cloudflare_mitigation = { path = "crates/lib/cloudflare_mitigation" } +datadome_errors = { path = "crates/lib/datadome_errors" } +datadome_mitigation = { path = "crates/lib/datadome_mitigation" } +browser_emulation = { path = "crates/lib/browser_emulation" } +cookie_store_wrapper = { path = "crates/lib/cookie_store_wrapper" } +errors = { path = "crates/lib/errors" } +fal_client = { path = "crates/api_clients/fal_client" } +file_hashing = { path = "crates/lib/files/file_hashing" } +file_to_base64_url = { path = "crates/lib/files/file_to_base64_url" } +filesys = { path = "crates/lib/files/filesys" } +gmicloud_client = { path = "crates/api_clients/gmicloud_client" } +grok_api_client = { path = "crates/api_clients/grok_api_client" } +grok_consumer_client = { path = "crates/api_clients/grok_consumer_client" } +higgsfield_client = { path = "crates/api_clients/higgsfield_client" } +grok_consumer_statsig = { path = "crates/api_clients/grok_consumer_statsig" } +http_headers = { path = "crates/lib/http_headers" } +core_types = { path = "crates/core_types" } +models = { path = "crates/models" } +images = { path = "crates/lib/files/images" } +jwt_light = { path = "crates/lib/jwt_light" } +memory_store = { path = "crates/lib/caching/memory_store" } +midjourney_client = { path = "crates/api_clients/midjourney_client" } +mimetypes = { path = "crates/lib/files/mimetypes" } +primitives = { path = "crates/lib/data/primitives" } +router = { path = "crates/router" } +seedance2pro_client = { path = "crates/api_clients/seedance2pro_client" } +local_files_database = { path = "crates/schema/local_files_database" } +sqlite_database = { path = "crates/schema/sqlite_database" } +sqlite_identifiers = { path = "crates/schema/sqlite_identifiers" } +test_data = { path = "crates/testing/test_data" } +thumbnails = { path = "crates/lib/files/thumbnails" } +test_utils = { path = "crates/testing/test_utils" } +url_utils = { path = "crates/lib/url_utils" } +uuid_utils = { path = "crates/lib/uuid_utils" } +web_base64 = { path = "crates/lib/data/web_base64" } + +# External libs +# Centrally pinned versions so that we can uniformly upgrade/downgrade versions across the workspace +# If a crate needs to use an older/newer version, the dependency should be managed in that crate's own Cargo.toml +anyhow = "1.0.102" +assertor = "0.0.3" +base64 = "0.22.1" +async-trait = "0.1.89" +blake3 = "1.5" +bstr = "1.12.1" +byteorder = "1.5.0" +bytes = "1.11.1" +chrono = { version = "0.4.44", features = ["serde"] } +cookie = "0.18.1" +env = "1.0.1" +env_logger = "0.11.9" +futures = { version = "0.3.32" } +indexmap = { version = "2.13.0", features = ["serde"] } +log = "0.4.29" +mp4 = "0.14.0" +openh264 = "0.8.0" +once_cell = "1.21.4" +rand = "0.9.1" +regex = "1.12.3" +reqwest = { version = "0.12.23", default-features = false, features = [ "charset", "http2", "system-proxy", "json", "cookies", "rustls-tls", "gzip" ] } +serde = { version = "1.0.228", features = ["derive"] } +serde_derive = "1.0.228" +serde_json = "1.0.149" +sha2 = "0.11.0-rc.5" +sha3 = "0.10.8" +strum = { version = "0.28.0", features = ["derive"] } +tauri = { version = "2.11.2", features = ["unstable", "devtools", "protocol-asset"] } # NB: "devtools" prevents App Store distribution; "unstable" is needed for window access +tauri-plugin-dialog = "2.7.1" +tauri-plugin-fs = "2.5.1" +tauri-plugin-log = "2.8.0" +tauri-plugin-upload = "2.4.0" +tempdir = "0.3.7" +tempfile = "3.27.0" +thiserror = "2.0.18" +tokio = { version = "1.50.0", features = ["macros"] } +tokio-util = "0.7.12" +toml = "1.0.7+spec-1.1.0" +url = { version = "2.5.8", features = ["serde"] } +uuid = "1.22.0" +walkdir = "2.4.0" +webp-animation = "0.9.0" + +# NB: wreq gets past fingerprinting, but we have to deal with platform-specific build issues. +# +# Mac: +# brew install --formula cmake pkg-config llvm +# Windows: +# choco install cmake -y +# choco install strawberryperl -y +# choco install pkgconfiglite -y +# choco install llvm -y +# choco install nasm -y +wreq-util = "3.0.0-rc.10" +wreq = { version = "6.0.0-rc.28", features = ["json", "query", "form", "multipart", "cookies", "ws", "stream", "gzip", "brotli", "zstd", "deflate"] } diff --git a/Cranky.toml b/Cranky.toml new file mode 100644 index 00000000..e83222e8 --- /dev/null +++ b/Cranky.toml @@ -0,0 +1,70 @@ +# Persist clippy check configurations: +# https://github.com/ericseppanen/cargo-cranky +# Clippy doesn't allow this (yet): +# https://github.com/rust-lang/rust-clippy/issues/6625 +deny = [ + # Rust + "unsafe_code", # We may remove this if needed + + # Clippy - "serious" lints + "clippy::borrow_interior_mutable_const", # Seems dangerous to allow this. Eg. `const F = Lazy::new()`; + + # Clippy - bad math + #"clippy::cast_possible_truncation", # Seems dangerous, eg f64 to u64. + #"clippy::cast_possible_wrap", + + # Clippy - pointer safety / readability / correctness + "clippy::as_ptr_cast_mut", + "clippy::borrow_as_ptr", + "clippy::borrow_deref_ref", + + # Clippy async + "clippy::await_holding_lock", + + # Clippy - performance + "clippy::cmp_owned", + "clippy::useless_vec", + "clippy::format_in_format_args", + #"clippy::redundant_clone", + #"clippy::unnecessary_to_owned", + #"clippy::vec_init_then_push", + + # Clippy - "ergonomic" / "usage" lints + "clippy::clone_on_copy", # Don't use clone() on Copy types + "clippy::option_option", # Lint: Don't ever Option>! Enums instead. + "clippy::zero_sized_map_values", # Lint: use a HashSet instead of HashMap. + + # Clippy - "aesthetic" / "style" lints + "clippy::clone_double_ref", # Lint: feels safer/hygienic to disallow this, but I'm not strongly opposed. + "clippy::double_comparisons", # Lint: readability + "clippy::empty_structs_with_brackets", # Lint: {} feels less aesthetic than ; + "clippy::implicit_clone", # Lint: Recommendation here seems more idiomatic. + "clippy::needless_late_init", # Don't declare variables without initializing them + "clippy::needless_return", # Lint: not the worst offender, but let's try to keep unnecessary returns out. + "clippy::redundant_field_names", # Lint: Duplicate names is a burden when reading: you wonder why they're dupes. + "clippy::redundant_static_lifetimes", # Lint: feels more modern to elide static lifetimes + + # Rust + "non_fmt_panics", # panic!(format!(...)) will be unsupported soon + "unused_imports", # These are easy to automatically cull + "unused_mut", # Be strict about mutability + "unused_parens", # Unused parens are ugly + "unused_variables", # Don't leave cruft + + # Possible: + # "clippy::ptr_arg", + # "clippy::too_many_lines" (note: this is configurable) +] + +warn = [ +] + +allow = [ + # Rust + "deprecated", # Other systems can handle deprecated code instead of the linter + "missing_docs", # Not everything needs documentation. Too much documentation is bad. Literate code. + + # Clippy + "clippy::if_same_then_else", # There are cases this is clearer! Branches may have notes / considerations. + "clippy::single_char_pattern", # This is like punishing trailing commas. Chars are dumb. +] diff --git a/crates/CLAUDE.md b/crates/CLAUDE.md new file mode 100644 index 00000000..f86e4060 --- /dev/null +++ b/crates/CLAUDE.md @@ -0,0 +1,59 @@ +# Rust Workspace + +All Rust code lives under `crates/`. The workspace is defined in `Cargo.toml` at the repo root. + +## Code Style + +- Two spaces for indentation (not four) +- No minimum supported Rust version; use latest stable features freely +- Never use `println!` or `eprintln!` outside of tests; use `log` crate macros instead +- Use `anyhow::Result` / `AnyhowResult` for fallible functions in application code +- Fields that are optional use the `maybe_` prefix: `maybe_creator_user_token` +- When two crates export the same type name, alias with a suffix: `use foo::Bar as BarFoo;` +- Prefer `use` imports over inline fully-qualified paths; only qualify inline for true one-offs or std prelude collisions (`Result`, `Option`, `Error`) + +## File Layout + +Organize for top-to-bottom reading. Important things first, details later. + +1. **Constants** at the top (after imports) +2. **Primary public type** (the main struct/enum the file defines) +3. **Supporting types** below the primary type +4. **API types** in order: Request, Response, Error +5. **`impl` blocks** after their type definitions + - Constructors first, then public methods, then private helpers + - Callers above callees — follow the call chain downward + +## Test Layout + +Within `#[cfg(test)] mod tests { ... }`: + +1. **Imports** +2. **Constants** (test IDs, URLs, fixture data) — small context that tests reference +3. **Test functions or sub-modules** grouped by category +4. **Helper functions** (builders, pipeline runners, assertions) + +Constants provide small context up front. Test cases come next so engineers see *what* is +tested before *how* the helpers work. + +Group related tests into sub-modules (`mod pricing_tests { ... }`) when a category has 2+ +tests. Don't wrap a single test in its own module. Keep nesting to two levels max. Shared +helpers go in the parent `mod tests` so sub-modules can `use super::*`. + +## Building + +- Most crates: `cargo check -p {crate_name}` or `cargo test -p {crate_name}` +- Crates using SQLx (eg. `sqlite_database`): `SQLX_OFFLINE=true cargo check -p {crate_name}` + +## Key Crates + +- `artcraftx` (desktop) — Tauri desktop app +- `router` — provider routing for image/video generation (Artcraft, Fal, Seedance2Pro) +- `artcraft_client` — HTTP client for the Artcraft/Storyteller API, including the API type definitions (`artcraft_client::api_defs`), enum variants stored as strings (`artcraft_client::enums`), and opaque server-minted identifier tokens with Stripe-like prefixes (`artcraft_client::tokens`, e.g. `user_`, `jinf_`) +- `seedance2pro_client` — HTTP client for the Kinovi/Seedance2Pro video generation service +- `core_types` — highest-level shared types: `GenerationSource`, the desktop app's own IDs (e.g. `credential_{ulid}`) +- `sqlite_database` — SQLx queries + embedded migrations for the desktop app's local task database +- `local_files_database` — separate SQLite DB (runtime SQLx queries, no macros): BLAKE3 content-hash index of local files + thumbnail accounting +- `thumbnails` — pure-Rust thumbnail generation: images via `image`, H.264 MP4 first-frame JPEG + ~1s animated WebP via `mp4`/`openh264`/`webp-animation` +- `file_hashing` — streaming BLAKE3 content hashing +- `sqlite_identifiers` — enums and IDs used in sqlite queries as enums or keys diff --git a/crates/api_clients/artcraft_client/CLAUDE.md b/crates/api_clients/artcraft_client/CLAUDE.md new file mode 100644 index 00000000..46394079 --- /dev/null +++ b/crates/api_clients/artcraft_client/CLAUDE.md @@ -0,0 +1,24 @@ +# artcraft_client + +HTTP API client for Artcraft / Storyteller, including the API type definitions. + +## Structure + +- `api_defs/` — request/response type definitions, organized by feature: + `users/`, `media_file/`, `jobs/`, `moderation/`, etc. (Formerly the separate + `artcraft_api_defs` crate; merged here since this repo has no server to share + them with.) +- `endpoints/` — one function per HTTP endpoint +- `credentials/` — session/cookie plumbing +- `datatypes/`, `error/`, `recipes/`, `utils/` — support code + +## Conventions + +- Request types: `#[derive(Deserialize)]` +- Response types: `#[derive(Serialize)]` +- Path params: `#[derive(Deserialize)]` with `PathInfo` suffix + +## Dependencies + +Keep `api_defs/` light: only `serde`, `serde_derive`, `chrono`, `url`, and +internal schema crates (`enums`, `tokens`). diff --git a/crates/api_clients/artcraft_client/Cargo.toml b/crates/api_clients/artcraft_client/Cargo.toml new file mode 100644 index 00000000..c12cfa79 --- /dev/null +++ b/crates/api_clients/artcraft_client/Cargo.toml @@ -0,0 +1,59 @@ +[package] +name = "artcraft_client" +edition = "2021" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +# [lints.rust] +# unused_imports = "forbid" + +[lib] +name = "artcraft_client" +path = "src/lib.rs" + +[dependencies] +core_types.workspace = true +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +cloudflare_errors.workspace = true +errors.workspace = true +uuid_utils.workspace = true +mimetypes.workspace = true +sqlite_identifiers.workspace = true + +# External +anyhow.workspace = true +chrono.workspace = true +cookie.workspace = true +log.workspace = true +reqwest = { workspace = true, features = ["multipart", "gzip"] } +url.workspace = true + +# Serialization +serde.workspace = true +serde_derive.workspace = true +serde_json.workspace = true + +# HTTP +backoff = { version = "0.4.0", features = ["futures"] } # Exponential backoff retry +uuid = { version = "1.8.0", features = ["v4"] } + +# TODO: This is not a very mature, safe, or intuitive URL builder library. Please replace it! +url-builder = "0.1.1" + +[dev-dependencies] +tokio.workspace = true + +# Enum test utilities +strum.workspace = true +toml.workspace = true +regex.workspace = true diff --git a/crates/api_clients/artcraft_client/src/api_defs/analytics/log_active_user.rs b/crates/api_clients/artcraft_client/src/api_defs/analytics/log_active_user.rs new file mode 100644 index 00000000..0d0c11fc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/analytics/log_active_user.rs @@ -0,0 +1,116 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::app_session::AppSessionToken; + +/// This is used in Artcraft versions 0.0.1 (several) through 0.3.0 +/// Clients to this version do not send generation count data (even if the endpoint supports it). +pub const LOG_ACTIVE_USER_V1_PATH: &str = "/v1/analytics/active_user"; + +/// This is used in Artcraft versions 0.4.0 and later. +pub const LOG_ACTIVE_USER_V2_PATH: &str = "/v1/analytics/active_user_v2"; + +#[derive(Serialize, Deserialize, Debug, Default)] +pub struct LogAppActiveUserRequest { + /// Clientside-generated session token. + /// If present, it'll be validated against an expected format. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_app_session_token: Option, + + /// An override for the application platform/OS (windows, mac, linux). + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_os_platform: Option, + + /// An override for the version of the OS (e.g. 10.15.7, 11, 22.04). + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_os_version: Option, + + /// An override for the application name. + /// If set together with `maybe_app_version`, the two will be + /// concatenated as `{maybe_app_name}/{maybe_app_version}`. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_app_name: Option, + + /// An override for the application version. + /// If set together with `maybe_app_name`, the two will be + /// concatenated as `{maybe_app_name}/{maybe_app_version}`. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_app_version: Option, + + /// How long the user has been active in the app, in seconds. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_session_duration_seconds: Option, + + // ========== GENERATION COUNTS ========== + + /// Number of items generated across all types. + #[serde(skip_serializing_if = "Option::is_none")] + pub total_generation_count: Option, + + /// Number of images generated. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_generation_count: Option, + + /// Number of videos generated. + #[serde(skip_serializing_if = "Option::is_none")] + pub video_generation_count: Option, + + /// Number of objects generated (meshes, etc.). + #[serde(skip_serializing_if = "Option::is_none")] + pub object_generation_count: Option, + + /// Number of images generated with text to image. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_to_image_count: Option, + + /// Number of images generated with image to image (image edits). + #[serde(skip_serializing_if = "Option::is_none")] + pub image_to_image_count: Option, + + /// Number of videos generated with text to video. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_to_video_count: Option, + + /// Number of videos generated with image to video. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_to_video_count: Option, + + /// Number of objects generated with text to object. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_to_object_count: Option, + + /// Number of objects generated with image to object. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_to_object_count: Option, + + /// Number of prompts from the image page. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_page_prompt_count: Option, + + /// Number of prompts from the video page. + #[serde(skip_serializing_if = "Option::is_none")] + pub video_page_prompt_count: Option, + + /// Number of prompts from the edit page. + #[serde(skip_serializing_if = "Option::is_none")] + pub edit_page_prompt_count: Option, + + /// Number of prompts from the stage page. + #[serde(skip_serializing_if = "Option::is_none")] + pub stage_page_prompt_count: Option, + + /// Number of prompts from the object page. + #[serde(skip_serializing_if = "Option::is_none")] + pub object_page_prompt_count: Option, + + /// Number of prompts from other pages. + #[serde(skip_serializing_if = "Option::is_none")] + pub other_page_prompt_count: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct LogAppActiveUserResponse { + pub success: bool, + + /// How long to wait until the next analytics event, in milliseconds. + /// The client should honor this and is free to add jitter. + pub wait_for_retry_millis: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/analytics/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/analytics/mod.rs new file mode 100644 index 00000000..8cb3740b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/analytics/mod.rs @@ -0,0 +1 @@ +pub mod log_active_user; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/common.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/common.rs new file mode 100644 index 00000000..ba173dec --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/common.rs @@ -0,0 +1,41 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::api_keys::ApiKeyToken; +use crate::tokens::users::UserToken; + +/// Canonical wire shape for an API key, used by the list rows and the +/// single-key GET. +/// +/// NB: the full secret `api_key` is NEVER included here — only +/// `truncated_api_key` (its first 20 characters), enough to disambiguate keys +/// in a UI. The full value is returned exactly once, at creation time. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct ApiKeyInfo { + pub token: ApiKeyToken, + + /// First 20 characters of the API key. The full secret is never returned + /// after creation. + pub truncated_api_key: String, + + pub name: String, + pub maybe_description: Option, + + pub owner_user_token: UserToken, + + pub ip_address_creation: String, + pub ip_address_update: String, + + pub created_at: DateTime, + pub updated_at: DateTime, + + /// Soft-delete timestamp. `None` for live keys. + pub maybe_deleted_at: Option>, +} + +/// Path info for endpoints addressed by the API key's `token` (NOT the secret +/// `api_key` value): `GET` / `DELETE` / `PUT` `/v1/api_keys/{api_key_token}`. +#[derive(Deserialize)] +pub struct ApiKeyPathInfo { + pub api_key_token: ApiKeyToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/create_api_key.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/create_api_key.rs new file mode 100644 index 00000000..12b9e6c9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/create_api_key.rs @@ -0,0 +1,27 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::api_keys::ApiKeyToken; + +// ── POST /v1/api_keys/create ── + +#[derive(Deserialize)] +pub struct CreateApiKeyRequest { + /// Display name (title) for the key. + pub name: String, + + /// Optional description. + pub maybe_description: Option, +} + +#[derive(Serialize)] +pub struct CreateApiKeySuccessResponse { + pub success: bool, + + /// The key's `token` — used for all subsequent management + /// (get / update / delete). Safe to store and display. + pub api_key_token: ApiKeyToken, + + /// The full secret API key value. This is the ONLY time it is ever + /// returned — the caller must store it now, as it cannot be retrieved again. + pub api_key: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/delete_api_key.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/delete_api_key.rs new file mode 100644 index 00000000..c324ebda --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/delete_api_key.rs @@ -0,0 +1,8 @@ +use serde_derive::Serialize; + +// ── DELETE /v1/api_keys/{api_key_token} ── + +#[derive(Serialize)] +pub struct DeleteApiKeySuccessResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/get_api_key.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/get_api_key.rs new file mode 100644 index 00000000..4daf54cd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/get_api_key.rs @@ -0,0 +1,11 @@ +use serde_derive::Serialize; + +use crate::api_defs::api_keys::common::ApiKeyInfo; + +// ── GET /v1/api_keys/{api_key_token} ── + +#[derive(Serialize)] +pub struct GetApiKeySuccessResponse { + pub success: bool, + pub api_key: ApiKeyInfo, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/list_api_keys.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/list_api_keys.rs new file mode 100644 index 00000000..fa7c6042 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/list_api_keys.rs @@ -0,0 +1,23 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::api_keys::common::ApiKeyInfo; + +// ── GET /v1/api_keys/list ── + +#[derive(Deserialize)] +pub struct ListApiKeysQueryParams { + /// Page size. Defaults server-side if omitted. + pub limit: Option, + + /// Number of rows to skip. Defaults to 0. + pub offset: Option, +} + +#[derive(Serialize)] +pub struct ListApiKeysSuccessResponse { + pub success: bool, + + /// The user's API keys (including soft-deleted ones), newest first. Each + /// entry's key value is truncated — the full secret is never listed. + pub api_keys: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/mod.rs new file mode 100644 index 00000000..e4a9b484 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/mod.rs @@ -0,0 +1,6 @@ +pub mod common; +pub mod create_api_key; +pub mod delete_api_key; +pub mod get_api_key; +pub mod list_api_keys; +pub mod update_api_key; diff --git a/crates/api_clients/artcraft_client/src/api_defs/api_keys/update_api_key.rs b/crates/api_clients/artcraft_client/src/api_defs/api_keys/update_api_key.rs new file mode 100644 index 00000000..485c1a50 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/api_keys/update_api_key.rs @@ -0,0 +1,14 @@ +use serde_derive::{Deserialize, Serialize}; + +// ── PUT /v1/api_keys/{api_key_token} ── + +#[derive(Deserialize)] +pub struct UpdateApiKeyRequest { + /// New description for the key. `None` clears it. + pub maybe_description: Option, +} + +#[derive(Serialize)] +pub struct UpdateApiKeySuccessResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/characters/create_character.rs b/crates/api_clients/artcraft_client/src/api_defs/characters/create_character.rs new file mode 100644 index 00000000..afc033bd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/characters/create_character.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_model_type::CommonModelType; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Request body for creating a character. +#[derive(Deserialize)] +pub struct CreateCharacterRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// The model to create the character for. + pub model: CommonModelType, + + /// The reference image media file token. + pub image_media_token: MediaFileToken, + + /// Name of the character. + pub character_name: String, + + /// Description of the character. + pub character_description: Option, +} + +/// Response body for creating a character. +#[derive(Serialize)] +pub struct CreateCharacterResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/characters/delete_character.rs b/crates/api_clients/artcraft_client/src/api_defs/characters/delete_character.rs new file mode 100644 index 00000000..d39c96dd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/characters/delete_character.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::characters::CharacterToken; + +/// Path parameters for deleting a character. +#[derive(Deserialize)] +pub struct DeleteCharacterPathInfo { + pub character_token: CharacterToken, +} + +/// Response body for deleting a character. +#[derive(Serialize)] +pub struct DeleteCharacterResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/characters/edit_character.rs b/crates/api_clients/artcraft_client/src/api_defs/characters/edit_character.rs new file mode 100644 index 00000000..556cc845 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/characters/edit_character.rs @@ -0,0 +1,22 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::characters::CharacterToken; + +/// Request body for editing a character. +#[derive(Deserialize)] +pub struct EditCharacterRequest { + /// The character to edit. + pub token: CharacterToken, + + /// Updated name (if changing). + pub updated_name: Option, + + /// Updated description (if changing). + pub updated_description: Option, +} + +/// Response body for editing a character. +#[derive(Serialize)] +pub struct EditCharacterResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/characters/get_character.rs b/crates/api_clients/artcraft_client/src/api_defs/characters/get_character.rs new file mode 100644 index 00000000..71a4f7f1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/characters/get_character.rs @@ -0,0 +1,35 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::enums::common::generation::common_model_type::CommonModelType; +use crate::tokens::characters::CharacterToken; + +/// Path parameters for getting a character. +#[derive(Deserialize)] +pub struct GetCharacterPathInfo { + pub character_token: CharacterToken, +} + +/// Response body for getting a character. +#[derive(Serialize)] +pub struct GetCharacterResponse { + pub success: bool, + pub character: GetCharacterDetails, +} + +/// Full character details returned by the get endpoint. +#[derive(Serialize)] +pub struct GetCharacterDetails { + pub token: CharacterToken, + + /// Which models this character can be used with. + pub models: Vec, + + pub name: String, + + pub maybe_description: Option, + + pub maybe_avatar: Option, + + pub maybe_full_image: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/characters/list_characters.rs b/crates/api_clients/artcraft_client/src/api_defs/characters/list_characters.rs new file mode 100644 index 00000000..cf6a09e4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/characters/list_characters.rs @@ -0,0 +1,37 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::enums::common::generation::common_model_type::CommonModelType; +use crate::tokens::characters::CharacterToken; + +/// Query string parameters for listing characters. +#[derive(Deserialize)] +pub struct ListCharactersQuery { + /// Optional cursor for pagination. + pub cursor: Option, +} + +/// Response body for listing characters in the current session. +#[derive(Serialize)] +pub struct ListCharactersResponse { + pub success: bool, + pub characters: Vec, + pub next_cursor: Option, +} + +/// A character entry in the list response. +#[derive(Serialize)] +pub struct ListCharactersEntry { + pub token: CharacterToken, + + /// Which models this character can be used with. + pub models: Vec, + + pub name: String, + + pub maybe_description: Option, + + pub maybe_avatar: Option, + + pub maybe_full_image: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/characters/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/characters/mod.rs new file mode 100644 index 00000000..bb9070c8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/characters/mod.rs @@ -0,0 +1,5 @@ +pub mod create_character; +pub mod delete_character; +pub mod edit_character; +pub mod get_character; +pub mod list_characters; diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/common/mod.rs new file mode 100644 index 00000000..6885733d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/mod.rs @@ -0,0 +1 @@ +pub mod responses; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/cover_image_links.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/cover_image_links.rs new file mode 100644 index 00000000..9f6d6e2e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/cover_image_links.rs @@ -0,0 +1,18 @@ +use serde_derive::{Deserialize, Serialize}; +use url::Url; + +// TODO(bt,2025-08-20): Replace the storyteller-web version of this. +// All it needs is the impl ported into a builder. + +/// Cover image links can only be jpg, png, etc. No videos. +#[derive(Serialize, Deserialize, Debug)] +pub struct CoverImageLinks { + /// Primary link to the cover image via the CDN. + pub cdn_url: Url, + + /// Template to construct thumbnail URLs. + /// Replace the string `{WIDTH}` with the desired width. + /// Only relevant for image media files. (Video media files instead have + /// video previews, which, in turn, have their own thumbnail templates.) + pub thumbnail_template: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/job_details.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/job_details.rs new file mode 100644 index 00000000..9f28ee7b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/job_details.rs @@ -0,0 +1,32 @@ +use serde::Deserialize; +use serde::Serialize; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Details about submitted live portrait jobs (request arguments only) +#[derive(Serialize, Deserialize)] +pub struct JobDetailsLivePortraitRequest { + /// Source media token + /// This can be an image or a video media file token + /// This is what constitutes the "portrait" or the overall final video. + /// This video or image must contain a face. + pub source_media_file_token: MediaFileToken, + + /// Driving media token + /// This must be a video media file token. + /// This drives the animation of the face, but the actor will disappear + /// and their facial expressions will be transferred to the source. + /// This video must contain a face. + pub face_driver_media_file_token: MediaFileToken, +} + +/// Details about submitted lipsync jobs (request arguments only) +#[derive(Serialize, Deserialize)] +pub struct JobDetailsLipsyncRequest { + /// Media file token for the source audio. + /// This is probably an audio file, but in the future we might pull audio from video. + pub audio_source_token: MediaFileToken, + + /// Media file token for the source visuals. + /// This is either an image or video. + pub image_or_video_source_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/media_file_cover_image_details.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/media_file_cover_image_details.rs new file mode 100644 index 00000000..fb662573 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/media_file_cover_image_details.rs @@ -0,0 +1,43 @@ +use crate::api_defs::common::responses::cover_image_links::CoverImageLinks; +use serde_derive::{Deserialize, Serialize}; + +// TODO(bt,2025-08-20): Replace the storyteller-web version of this. +// We can't drop the old version just yet due to the `impl` (easy) +// and a few differing fields. + +/// Everything we need to create a cover image. +/// Cover images are small descriptive images that can be set for any media file. +/// If a cover image is set, this is the path to the asset. +#[derive(Serialize, Deserialize, Debug)] +pub struct MediaFileCoverImageDetails { + // /// (DEPRECATED) URL path to the media file + // #[deprecated(note="This field doesn't point to the full URL. Use media_links instead to leverage the CDN.")] + // pub maybe_cover_image_public_bucket_path: Option, + + // /// (DEPRECATED) Full URL to the media file + // #[deprecated(note="This points to the bucket. Use media_links instead to leverage the CDN.")] + // pub maybe_cover_image_public_bucket_url: Option, + + // NB(bt,2024-09-19): I accidentally rolled this field out to production. + // I don't think this field is in use, but maybe ... + // /// (DEPRECATED) Use maybe_links instead. + // #[deprecated(note="Use `maybe_links` instead.")] + // pub maybe_media_links: Option, + + /// Links to the cover image (CDN direct link, thumbnail template) + /// If a cover image is set, this is the path to the asset. + /// If a cover image is not set, use the information in `default_cover` instead. + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub maybe_links: Option, + + /// For items without a cover image, we can use one of our own. + pub default_cover: MediaFileDefaultCover, +} + +/// The default cover is composed of an image and color pair that are +/// predefined by the frontend. +#[derive(Serialize, Deserialize, Debug)] +pub struct MediaFileDefaultCover { + pub image_index: u8, + pub color_index: u8, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/media_links.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/media_links.rs new file mode 100644 index 00000000..bd666061 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/media_links.rs @@ -0,0 +1,38 @@ +use serde::Deserialize; +use serde::Serialize; +use url::Url; + +/// Links to media file locations (bucket, CDN, etc.) +#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)] +pub struct MediaLinks { + /// Primary link to the asset via the CDN. + pub cdn_url: Url, + + /// Template to construct thumbnail URLs. + /// Replace the string `{WIDTH}` with the desired width. + /// Only relevant for image media files. (Video media files instead have + /// video previews, which, in turn, have their own thumbnail templates.) + pub maybe_thumbnail_template: Option, + + /// Video preview images (still and animated gif) for mp4 video files. + /// These are only set for video media files. + /// These are not set for "cover images" that are gif or webms, but rather video files. + pub maybe_video_previews: Option, +} + +#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)] +pub struct VideoPreviews { + /// A static single frame preview image of the video. + pub still: Url, + + /// An animated gif preview of the video. + pub animated: Url, + + /// A template used to construct the still thumbnail URL. + /// Replace the string `{WIDTH}` with the desired width. + pub still_thumbnail_template: String, + + /// A template used to construct the animated thumbnail URL. + /// Replace the string `{WIDTH}` with the desired width. + pub animated_thumbnail_template: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/mod.rs new file mode 100644 index 00000000..0a600adc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/mod.rs @@ -0,0 +1,8 @@ +pub mod cover_image_links; +pub mod job_details; +pub mod media_file_cover_image_details; +pub mod media_links; +pub mod pagination_cursors; +pub mod simple_entity_stats; +pub mod simple_generic_json_success; +pub mod user_details_light; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/pagination_cursors.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/pagination_cursors.rs new file mode 100644 index 00000000..359b4e45 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/pagination_cursors.rs @@ -0,0 +1,21 @@ +use serde_derive::{Deserialize, Serialize}; + +// TODO(bt,2026-07-09): Replace the storyteller-web version of this. + +/// Pagination by cursors +/// These types of pagination are for "infinite scrolling", which do not reveal a number of pages. +/// This is good so that investors and competitors cannot reveal how many database records we have. +/// This is typically used for "discovery" type pages, not user profiles. +#[derive(Serialize, Deserialize, Debug)] +pub struct PaginationCursors { + /// The "next" cursor. + /// This is an opaque (typically even encrypted) handle. + pub maybe_next: Option, + + /// The "previous" cursor. + /// This is an opaque (typically even encrypted) handle. + pub maybe_previous: Option, + + /// Details whether we're walking forward or backward. + pub cursor_is_reversed: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/simple_entity_stats.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/simple_entity_stats.rs new file mode 100644 index 00000000..0ba424cb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/simple_entity_stats.rs @@ -0,0 +1,12 @@ +use serde_derive::{Deserialize, Serialize}; + +// TODO(bt,2025-08-20): Replace the storyteller-web version of this. + +/// Simple stats that can be attached to any entity +#[derive(Serialize, Deserialize, Debug)] +pub struct SimpleEntityStats { + /// Number of positive ratings (or "likes") for this item + pub positive_rating_count: u32, + /// Number of bookmarks for this item + pub bookmark_count: u32, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/simple_generic_json_success.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/simple_generic_json_success.rs new file mode 100644 index 00000000..2dc3112a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/simple_generic_json_success.rs @@ -0,0 +1,6 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize)] +pub struct SimpleGenericJsonSuccess { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/common/responses/user_details_light.rs b/crates/api_clients/artcraft_client/src/api_defs/common/responses/user_details_light.rs new file mode 100644 index 00000000..938313a2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/common/responses/user_details_light.rs @@ -0,0 +1,33 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +/// Everything we need to refer to a user on the public web interface. +#[derive(Serialize, Deserialize, Debug)] +pub struct UserDetailsLight { + /// The token for the user + pub user_token: UserToken, + + /// The unique username someone logs in with + /// As of 2023-08-23, this is always lowercase + pub username: String, + + /// As of 2023-08-23, this is the username with capitalization + /// (In the future, a display name can be customized by the user.) + pub display_name: String, + + /// Email hash for Gravatar + /// Always set for now since login is email/username+password. + /// In the future this will need to become an optional *OR* be filled with a bogus hash. + pub gravatar_hash: String, + + /// For users without a gravatar, we show one of our own avatars. + pub default_avatar: UserDefaultAvatarInfo, + + // In the future, we'll also support user-uploaded avatars that we store on our servers. +} + +#[derive(Serialize, Deserialize, Debug)] +pub struct UserDefaultAvatarInfo { + pub image_index: u8, + pub color_index: u8, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/credits/get_session_credits.rs b/crates/api_clients/artcraft_client/src/api_defs/credits/get_session_credits.rs new file mode 100644 index 00000000..e16f7e8b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/credits/get_session_credits.rs @@ -0,0 +1,19 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize)] +pub struct GetSessionCreditsResponse { + pub success: bool, + + /// Any free credits the user might have + /// We might support daily free credits. + pub free_credits: u64, + + /// Any monthly refilling credits the user might have + pub monthly_credits: u64, + + /// Any banked credits the user might have. + pub banked_credits: u64, + + /// All the credit amounts added together. + pub sum_total_credits: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/credits/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/credits/mod.rs new file mode 100644 index 00000000..c6a4be34 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/credits/mod.rs @@ -0,0 +1 @@ +pub mod get_session_credits; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/folders/common.rs b/crates/api_clients/artcraft_client/src/api_defs/folders/common.rs new file mode 100644 index 00000000..c694c2a6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/folders/common.rs @@ -0,0 +1,93 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use url::Url; + +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::enums::by_table::media_files::media_file_type::MediaFileType; +use crate::tokens::folders::FolderToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::users::UserToken; + +// NB: The "folder media file" list-item shape lives in storyteller_web +// (see `endpoints/folders/media_files/list_folder_media_files_handler.rs`) +// because it embeds `MediaFileCoverImageDetails` and other domain types +// that depend on the request's `MediaDomain` + `ServerEnvironment`. + +/// Canonical wire shape for a folder. Used by single-folder GETs, create +/// responses, list rows, and subfolder list rows. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FolderInfo { + pub token: FolderToken, + pub name: String, + pub owner_user_token: UserToken, + pub maybe_parent_folder_token: Option, + + /// The four most-recent media files added to the folder, in slot order + /// (the schema stores them as `maybe_last_media_file_token_1..4`). + /// Slots whose media file has been deleted are skipped, so the vec + /// may contain 0-4 entries. + pub last_media_thumbnails: Vec, + + /// User-chosen cover image. When present, the frontend should use this + /// as the folder's primary thumbnail instead of the + /// `last_media_thumbnails` grid. + pub maybe_custom_cover_thumbnail: Option, + + pub maybe_color_code: Option, + pub has_star: bool, + + pub created_at: DateTime, + pub updated_at: DateTime, + + /// True when `maybe_parent_folder_token` is set but the referenced + /// parent row is missing or soft-deleted. + pub is_orphaned: bool, +} + +/// A compact thumbnail descriptor for a media file referenced by a +/// folder (either one of the `last_media_*` slots or the custom cover). +/// +/// Intentionally narrower than `MediaLinks` / `CoverImageLinks` — folders +/// only need the bare minimum to render a thumbnail card. The CDN URL is +/// the direct asset link; `maybe_thumbnail_template` carries the resizing +/// template URL (with `{{width}}` / `{{height}}` placeholders) when the +/// media class supports it. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FolderThumbnail { + pub token: MediaFileToken, + pub media_class: MediaFileClass, + pub media_type: MediaFileType, + + /// Direct CDN URL to the underlying media asset. + pub cdn_url: Url, + + /// Resizing template URL (with `{{width}}` / `{{height}}` placeholders) + /// when the media class supports it. `None` for media classes without + /// a thumbnail variant. (Video media files instead have video previews, + /// which, in turn, have their own thumbnail templates.) + pub maybe_thumbnail_template: Option, + + /// Video preview images (still and animated gif) for mp4 video files. + /// These are only set for video media files. + pub maybe_video_previews: Option, +} + +/// Video preview images for a video media file referenced by a folder. +/// Mirrors the shape of `MediaLinks`' video previews, but is its own type +/// so the folder wire shape can evolve independently. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FolderThumbnailVideoPreviews { + /// A static single frame preview image of the video. + pub still: Url, + + /// An animated gif preview of the video. + pub animated: Url, + + /// A template used to construct the still thumbnail URL. + /// Replace the string `{WIDTH}` with the desired width. + pub still_thumbnail_template: String, + + /// A template used to construct the animated thumbnail URL. + /// Replace the string `{WIDTH}` with the desired width. + pub animated_thumbnail_template: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/folders/folder.rs b/crates/api_clients/artcraft_client/src/api_defs/folders/folder.rs new file mode 100644 index 00000000..0b322c73 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/folders/folder.rs @@ -0,0 +1,115 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::folders::FolderToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::folders::common::FolderInfo; + +// ── POST /v1/folders/create ── + +#[derive(Deserialize)] +pub struct CreateFolderRequest { + pub name: String, + pub maybe_parent_folder_token: Option, + pub maybe_color_code: Option, +} + +#[derive(Serialize)] +pub struct CreateFolderSuccessResponse { + pub success: bool, + pub folder: FolderInfo, +} + +// ── GET /v1/folders/list_all ── + +#[derive(Deserialize)] +pub struct ListFoldersQueryParams { + pub cursor: Option, + pub limit: Option, +} + +#[derive(Serialize)] +pub struct ListFoldersSuccessResponse { + pub success: bool, + pub folders: Vec, + pub maybe_cursor: Option, +} + +// ── GET /v1/folders/folder/{folder_token} ── + +#[derive(Deserialize)] +pub struct FolderPathInfo { + pub folder_token: FolderToken, +} + +#[derive(Serialize)] +pub struct GetFolderSuccessResponse { + pub success: bool, + pub folder: FolderInfo, +} + +// ── PUT /v1/folders/folder/{folder_token}/rename ── + +#[derive(Deserialize)] +pub struct RenameFolderRequest { + pub new_name: String, +} + +#[derive(Serialize)] +pub struct RenameFolderSuccessResponse { + pub success: bool, +} + +// ── PUT /v1/folders/folder/{folder_token}/star ── + +#[derive(Deserialize)] +pub struct SetFolderStarRequest { + pub has_star: bool, +} + +#[derive(Serialize)] +pub struct SetFolderStarSuccessResponse { + pub success: bool, +} + +// ── PUT /v1/folders/folder/{folder_token}/color_code ── + +#[derive(Deserialize)] +pub struct SetFolderColorCodeRequest { + /// `None` clears the color tag. + pub maybe_color_code: Option, +} + +#[derive(Serialize)] +pub struct SetFolderColorCodeSuccessResponse { + pub success: bool, +} + +// ── PUT /v1/folders/folder/{folder_token}/cover_image ── + +#[derive(Deserialize)] +pub struct SetFolderCoverImageRequest { + /// `None` clears the cover image. If set, the server resolves it to a + /// usable cover-image media file token: image/video media files are + /// used directly; other types fall back to the file's own + /// `maybe_cover_image_media_file_token` (and fail if neither path + /// applies). + pub maybe_media_file_token: Option, +} + +#[derive(Serialize)] +pub struct SetFolderCoverImageSuccessResponse { + pub success: bool, + + /// The media file token that ended up being stored as the cover image + /// (may differ from the requested token if the server resolved through + /// the file's own cover image). `None` when the cover was cleared. + pub maybe_resolved_cover_media_file_token: Option, +} + +// ── DELETE /v1/folders/folder/{folder_token} ── + +#[derive(Serialize)] +pub struct DeleteFolderSuccessResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/folders/media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/folders/media_files.rs new file mode 100644 index 00000000..4cdb8b6a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/folders/media_files.rs @@ -0,0 +1,110 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::tokens::folders::FolderToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +// ── GET /v1/folders/media_files/{folder_token} ── +// +// NB: `ListFolderMediaFilesSuccessResponse` and `FolderMediaFileListItem` +// live in `storyteller_web`'s handler because the wire shape embeds +// `MediaFileCoverImageDetails` and `MediaLinks` constructors that depend +// on the request's `MediaDomain` + `ServerEnvironment`. + +#[derive(Deserialize)] +pub struct FolderMediaFilesPathInfo { + pub folder_token: FolderToken, +} + +#[derive(Deserialize)] +pub struct ListFolderMediaFilesQueryParams { + pub cursor: Option, + pub limit: Option, +} + +// ── GET /v1/folders/media_files_without_folder ── +// +// NB: `ListMediaFilesWithoutFolderSuccessResponse` and its list item live in +// `storyteller_web`'s handler because the wire shape embeds +// `MediaFileCoverImageDetails` and `MediaLinks` constructors that depend +// on the request's `MediaDomain` + `ServerEnvironment`. + +#[derive(Deserialize)] +pub struct ListMediaFilesWithoutFolderQueryParams { + pub cursor: Option, + pub limit: Option, + + /// Optional filter on the coarse media class. + /// + /// Usage: + /// - `?filter_media_class=image` + /// - `?filter_media_class=video` + /// - `?filter_media_class=mesh` + /// - `?filter_media_class=splat` + pub filter_media_class: Option, +} + +// ── PUT /v1/folders/media_files/{folder_token}/bulk_add ── + +#[derive(Deserialize)] +pub struct BulkAddFolderMediaFilesRequest { + /// Media files to add to the folder. Tokens that don't exist or are + /// soft-deleted are silently skipped. Already-added rows are no-ops + /// (idempotent via INSERT IGNORE on the composite primary key). + pub media_file_tokens: Vec, +} + +#[derive(Serialize)] +pub struct BulkAddFolderMediaFilesSuccessResponse { + pub success: bool, + /// Tokens that pre-existed (existed + not deleted). Already-added rows + /// are included since the operation is idempotent. + pub accepted_media_file_tokens: Vec, +} + +// ── PUT /v1/folders/media_files/{folder_token}/bulk_remove ── + +#[derive(Deserialize)] +pub struct BulkRemoveFolderMediaFilesRequest { + pub media_file_tokens: Vec, +} + +#[derive(Serialize)] +pub struct BulkRemoveFolderMediaFilesSuccessResponse { + pub success: bool, + /// How many membership rows were actually hard-deleted. + pub removed_count: u64, +} + +// ── POST /v1/folders/media_files/{folder_token}/bulk_move ── + +/// Atomically move the listed media files from `source_folder` to the +/// URL `folder_token` (destination). Idempotent on both sides: tokens +/// that aren't currently in the source are silently skipped, and tokens +/// that are already in the destination stay there. +#[derive(Deserialize)] +pub struct BulkMoveFolderMediaFilesRequest { + pub source_folder: FolderToken, + pub media_file_tokens: Vec, +} + +#[derive(Serialize)] +pub struct BulkMoveFolderMediaFilesSuccessResponse { + pub success: bool, + + /// Number of membership rows actually deleted from the source folder. + pub removed_from_source_count: u64, + + /// Number of membership rows actually inserted into the destination + /// folder. May be lower than the input length because (a) tokens that + /// were already present in the destination don't insert, and (b) + /// tokens whose media file doesn't exist / is soft-deleted are filtered + /// out before the insert. + pub added_to_destination_count: u64, + + /// The media file tokens that ended up resident in the destination + /// folder after the move — i.e. the subset of the input that actually + /// referred to live media files. Includes both newly-inserted rows and + /// rows that were already there. + pub accepted_media_file_tokens: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/folders/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/folders/mod.rs new file mode 100644 index 00000000..46416cdc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/folders/mod.rs @@ -0,0 +1,4 @@ +pub mod common; +pub mod folder; +pub mod media_files; +pub mod subfolder; diff --git a/crates/api_clients/artcraft_client/src/api_defs/folders/subfolder.rs b/crates/api_clients/artcraft_client/src/api_defs/folders/subfolder.rs new file mode 100644 index 00000000..88839d0d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/folders/subfolder.rs @@ -0,0 +1,60 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::folders::FolderToken; + +use crate::api_defs::folders::common::FolderInfo; + +// ── GET /v1/folders/subfolders/{folder_token} ── + +#[derive(Deserialize)] +pub struct SubfolderPathInfo { + pub folder_token: FolderToken, +} + +#[derive(Deserialize)] +pub struct ListSubfoldersQueryParams { + pub cursor: Option, + pub limit: Option, +} + +#[derive(Serialize)] +pub struct ListSubfoldersSuccessResponse { + pub success: bool, + pub subfolders: Vec, + pub maybe_cursor: Option, +} + +// ── PUT /v1/folders/subfolders/{folder_token}/bulk_add ── + +#[derive(Deserialize)] +pub struct BulkAddSubfoldersRequest { + /// The folders to reparent under the URL `folder_token`. Tokens that + /// don't exist, aren't owned by the caller, are soft-deleted, or are + /// the parent itself are silently skipped (idempotent). + pub subfolder_tokens: Vec, +} + +#[derive(Serialize)] +pub struct BulkAddSubfoldersSuccessResponse { + pub success: bool, + /// Tokens that were actually accepted (existed + owned + not deleted + + /// not the parent itself). Already-parented tokens are included here + /// since the operation is idempotent. + pub accepted_subfolder_tokens: Vec, +} + +// ── PUT /v1/folders/subfolders/{folder_token}/bulk_remove ── + +#[derive(Deserialize)] +pub struct BulkRemoveSubfoldersRequest { + /// Folders to unparent. Only rows currently parented to the URL + /// `folder_token` are affected; others are silently skipped. + pub subfolder_tokens: Vec, +} + +#[derive(Serialize)] +pub struct BulkRemoveSubfoldersSuccessResponse { + pub success: bool, + /// How many rows were actually unparented. + pub removed_count: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_image_cost.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_image_cost.rs new file mode 100644 index 00000000..94c75f25 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_image_cost.rs @@ -0,0 +1,121 @@ +use serde::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_image_model::CommonImageModel; +use crate::enums::common::generation::common_quality::CommonQuality; +use crate::enums::common::generation::common_resolution::CommonResolution; +use core_types::enums::generation_source::GenerationSource; + +pub const ESTIMATE_IMAGE_COST_PATH: &str = "/v1/generate/cost_estimate/image"; + +/// Request body for the image cost estimate endpoint. +#[derive(Serialize, Deserialize, Debug)] +pub struct EstimateImageCostRequest { + /// The image model to estimate costs for. + pub model: CommonImageModel, + + /// The provider to route the generation through. + pub provider: GenerationSource, + + /// The type of generation (determines whether input images are involved). + /// This is a tagged enum, so it looks like: + /// "generation_mode": {"type": "text_to_image"} + /// "generation_mode": {"type": "image_edit", "count": 2} + pub generation_mode: GenerationMode, + + /// Optional aspect ratio. + pub aspect_ratio: Option, + + /// Optional resolution. + pub resolution: Option, + + // Optional quality. + pub quality: Option, + + /// Number of images to generate in parallel. + pub image_batch_count: Option, +} + +/// Describes the type of image generation being requested. +#[derive(Serialize, Deserialize, Debug)] +#[serde(tag = "type", rename_all = "snake_case")] +pub enum GenerationMode { + /// No input images — generate from prompt only. + TextToImage, + /// One or more input images are provided for editing/compositing. + ImageEdit { count: u32 }, +} + +/// Response body for the image cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateImageCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, +} + +/// Error response for the image cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateImageCostError { + pub success: bool, + pub error_type: EstimateImageCostErrorType, + pub error_message: String, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum EstimateImageCostErrorType { + InvalidProviderForModel, + InvalidInput, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_serialization_text_to_image() { + let request = EstimateImageCostRequest { + model: CommonImageModel::NanoBananaPro, + provider: GenerationSource::Artcraft, + generation_mode: GenerationMode::TextToImage, + aspect_ratio: None, + resolution: None, + quality: None, + image_batch_count: None, + }; + let serialized = serde_json::to_string(&request).unwrap(); + assert!(serialized.contains("\"generation_mode\":{\"type\":\"text_to_image\"}")); + } + + #[test] + fn test_serialization_image_edit() { + let request = EstimateImageCostRequest { + model: CommonImageModel::NanoBananaPro, + provider: GenerationSource::Artcraft, + generation_mode: GenerationMode::ImageEdit { count: 2 }, + aspect_ratio: None, + resolution: None, + quality: None, + image_batch_count: None, + }; + let serialized = serde_json::to_string(&request).unwrap(); + assert!(serialized.contains("\"generation_mode\":{\"type\":\"image_edit\",\"count\":2}")); + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_splat_cost.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_splat_cost.rs new file mode 100644 index 00000000..fb965832 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_splat_cost.rs @@ -0,0 +1,58 @@ +use serde::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_splat_model::CommonSplatModel; +use core_types::enums::generation_source::GenerationSource; + +pub const ESTIMATE_SPLAT_COST_PATH: &str = "/v1/generate/cost_estimate/splat"; + +/// Request body for the splat cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateSplatCostRequest { + /// The splat model to estimate costs for. + pub model: CommonSplatModel, + + /// The provider to route the generation through. + pub provider: GenerationSource, + + /// Whether the request includes a reference image. + pub has_reference_image: Option, +} + +/// Response body for the splat cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateSplatCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, +} + +/// Error response for the splat cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateSplatCostError { + pub success: bool, + pub error_type: EstimateSplatCostErrorType, + pub error_message: String, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum EstimateSplatCostErrorType { + InvalidProviderForModel, + InvalidInput, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_video_cost.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_video_cost.rs new file mode 100644 index 00000000..7e5830b4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/estimate_video_cost.rs @@ -0,0 +1,129 @@ +use serde::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_video_model::CommonVideoModel; +use crate::enums::common::generation::common_resolution::CommonResolution; +use core_types::enums::generation_source::GenerationSource; + +pub const ESTIMATE_VIDEO_COST_PATH: &str = "/v1/generate/cost_estimate/video"; + +/// Request body for the video cost estimate endpoint. +/// +/// Every model cares about its own set of parameters and not all +/// parameters may be relevant for every model. +#[derive(Serialize, Deserialize, Debug)] +pub struct EstimateVideoCostRequest { + /// The video model to estimate costs for. + pub model: CommonVideoModel, + + /// The provider to route the generation through. + pub provider: GenerationSource, + + /// The type of generation (determines how many input images are involved). + /// This is a tagged enum, so it looks like: + /// "generation_mode": {"type": "text_to_video"} + /// "generation_mode": {"type": "reference_image_to_video", "count": 1} + pub generation_mode: GenerationMode, + + /// Optional aspect ratio. + pub aspect_ratio: Option, + + /// Optional resolution. + pub resolution: Option, + + /// Duration in seconds. + pub duration_seconds: Option, + + /// Number of videos to generate in parallel. + pub video_batch_count: Option, + + /// Whether to generate audio for the video. + pub generate_audio: Option, +} + +/// Describes the type of video generation being requested. +#[derive(Serialize, Deserialize, Debug)] +#[serde(tag = "type", rename_all = "snake_case")] +pub enum GenerationMode { + TextToVideo, + StartFrameToVideo, + StartAndEndFrameToVideo, + ReferenceImageToVideo { count: u32 }, +} + +/// Response body for the video cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateVideoCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, +} + +/// Error response for the video cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct EstimateVideoCostError { + pub success: bool, + pub error_type: EstimateVideoCostErrorType, + pub error_message: String, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum EstimateVideoCostErrorType { + InvalidProviderForModel, + InvalidInput, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_serialization_tagging1() { + let request = EstimateVideoCostRequest { + model: CommonVideoModel::GrokVideo, + provider: GenerationSource::Artcraft, + generation_mode: GenerationMode::TextToVideo, + aspect_ratio: None, + resolution: None, + duration_seconds: None, + video_batch_count: None, + generate_audio: None, + }; + let serialized = serde_json::to_string(&request).unwrap(); + assert!(serialized.contains("\"generation_mode\":{\"type\":\"text_to_video\"}")); + //assert_eq!(serialized, "{}"); + } + + #[test] + fn test_serialization_tagging2() { + let request = EstimateVideoCostRequest { + model: CommonVideoModel::GrokVideo, + provider: GenerationSource::Artcraft, + generation_mode: GenerationMode::ReferenceImageToVideo { count: 1 }, + aspect_ratio: None, + resolution: None, + duration_seconds: None, + video_batch_count: None, + generate_audio: None, + }; + let serialized = serde_json::to_string(&request).unwrap(); + assert!(serialized.contains("\"generation_mode\":{\"type\":\"reference_image_to_video\",\"count\":1}")); + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/mod.rs new file mode 100644 index 00000000..bcae15ce --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/cost_estimate/mod.rs @@ -0,0 +1,3 @@ +pub mod estimate_image_cost; +pub mod estimate_splat_cost; +pub mod estimate_video_cost; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/flux_2_lora_edit_image_angle.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/flux_2_lora_edit_image_angle.rs new file mode 100644 index 00000000..073bf9c1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/flux_2_lora_edit_image_angle.rs @@ -0,0 +1,55 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const FLUX_2_LORA_EDIT_IMAGE_ANGLE_PATH: &str = "/v1/generate/image/angle/flux_2_lora"; + +#[derive(Serialize, Deserialize, Debug)] +pub struct Flux2LoraEditImageAngleRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// The image to edit with angle adjustment. + pub image_media_token: MediaFileToken, + + /// Horizontal rotation angle in degrees. + pub horizontal_angle: Option, + + /// Vertical rotation angle in degrees. + pub vertical_angle: Option, + + /// Zoom level. + pub zoom: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Output image size. Default is square_hd. + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Flux2LoraEditImageAngleNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Flux2LoraEditImageAngleImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, +} + +#[derive(Serialize, Deserialize)] +pub struct Flux2LoraEditImageAngleResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/mod.rs new file mode 100644 index 00000000..fa3fe516 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/mod.rs @@ -0,0 +1,2 @@ +pub mod flux_2_lora_edit_image_angle; +pub mod qwen_edit_2511_edit_image_angle; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/qwen_edit_2511_edit_image_angle.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/qwen_edit_2511_edit_image_angle.rs new file mode 100644 index 00000000..c67b96cd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/angle/qwen_edit_2511_edit_image_angle.rs @@ -0,0 +1,58 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const QWEN_EDIT_2511_EDIT_IMAGE_ANGLE_PATH: &str = "/v1/generate/image/angle/qwen_edit_2511"; + +#[derive(Serialize, Deserialize, Debug)] +pub struct QwenEdit2511EditImageAngleRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// The image to edit with angle adjustment. + pub image_media_token: MediaFileToken, + + /// Horizontal rotation angle in degrees. + pub horizontal_angle: Option, + + /// Vertical rotation angle in degrees. + pub vertical_angle: Option, + + /// Zoom level. + pub zoom: Option, + + /// Additional text prompt to guide the generation. + pub additional_prompt: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Output image size. Default is square_hd. + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum QwenEdit2511EditImageAngleNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum QwenEdit2511EditImageAngleImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, +} + +#[derive(Serialize, Deserialize)] +pub struct QwenEdit2511EditImageAngleResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/bg_removal/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/bg_removal/mod.rs new file mode 100644 index 00000000..243c3076 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/bg_removal/mod.rs @@ -0,0 +1 @@ +pub mod remove_image_background; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/bg_removal/remove_image_background.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/bg_removal/remove_image_background.rs new file mode 100644 index 00000000..1a914dcb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/bg_removal/remove_image_background.rs @@ -0,0 +1,21 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const REMOVE_IMAGE_BACKGROUND_PATH: &str = "/v1/generate/image/remove_background"; + +#[derive(Serialize, Deserialize)] +pub struct RemoveImageBackgroundRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the file to remove the background from. + /// It must be an image. + pub media_file_token: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct RemoveImageBackgroundResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/flux_pro_kontext_max_edit_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/flux_pro_kontext_max_edit_image.rs new file mode 100644 index 00000000..3b8ccbd0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/flux_pro_kontext_max_edit_image.rs @@ -0,0 +1,35 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const FLUX_PRO_KONTEXT_MAX_EDIT_IMAGE_PATH: &str = "/v1/generate/image/edit/flux_pro_kontext_max"; + +#[derive(Serialize, Deserialize)] +pub struct FluxProKontextMaxEditImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// The image we're editing. + pub image_media_token: MediaFileToken, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum FluxProKontextMaxEditImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Serialize, Deserialize)] +pub struct FluxProKontextMaxEditImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/gemini_25_flash_edit_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/gemini_25_flash_edit_image.rs new file mode 100644 index 00000000..d533b6f6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/gemini_25_flash_edit_image.rs @@ -0,0 +1,49 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GEMINI_25_FLASH_EDIT_IMAGE_PATH: &str = "/v1/generate/image/edit/gemini_25_flash"; + +#[derive(Serialize, Deserialize)] +pub struct Gemini25FlashEditImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + // TODO: OneOf for image_urls or image_media_tokens + /// Image media tokens to include in the editing context. + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Quality of the image to generate. Default is High. + pub image_quality: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Gemini25FlashEditImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Gemini25FlashEditImageImageQuality { + Auto, + Low, + Medium, + High, // Default +} + + +#[derive(Serialize, Deserialize)] +pub struct Gemini25FlashEditImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/gpt_image_1_edit_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/gpt_image_1_edit_image.rs new file mode 100644 index 00000000..531b2e82 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/gpt_image_1_edit_image.rs @@ -0,0 +1,61 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GPT_IMAGE_1_EDIT_IMAGE_PATH: &str = "/v1/generate/image/edit/gpt_image_1"; + +#[derive(Serialize, Deserialize)] +pub struct GptImage1EditImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + // TODO: OneOf for image_urls or image_media_tokens + /// Image media tokens to include in the editing context. + pub image_media_tokens: Option>, + + /// Size of the image to generate. Default is Square. + pub image_size: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Quality of the image to generate. Default is High. + pub image_quality: Option, +} + + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1EditImageImageSize { + Square, // 1:1, Default + Horizontal, + Vertical, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1EditImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1EditImageImageQuality { + Auto, + Low, + Medium, + High, // Default +} + + +#[derive(Serialize, Deserialize)] +pub struct GptImage1EditImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/mod.rs new file mode 100644 index 00000000..d883c78a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/mod.rs @@ -0,0 +1,6 @@ +pub mod flux_pro_kontext_max_edit_image; +pub mod gemini_25_flash_edit_image; +pub mod gpt_image_1_edit_image; +pub mod qwen_edit_image; +pub mod seededit_3_edit_image; + diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/qwen_edit_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/qwen_edit_image.rs new file mode 100644 index 00000000..fc4de58b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/qwen_edit_image.rs @@ -0,0 +1,50 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const QWEN_EDIT_IMAGE_PATH: &str = "/v1/generate/image/edit/qwen"; + +#[derive(Serialize, Deserialize)] +pub struct QwenEditImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// The image we're editing. + pub image_media_token: MediaFileToken, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Text prompt to generate the image from. + pub negative_prompt: Option, + + /// Acceleration level for image generation. + /// Options: 'none', 'regular'. Higher acceleration increases speed. + /// 'regular' balances speed and quality. Default value: "none" + pub acceleration: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + +#[derive(Serialize, Deserialize)] +pub enum QwenEditImageAcceleration { + None, + Regular, + High, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum QwenEditImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Serialize, Deserialize)] +pub struct QwenEditImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/seededit_3_edit_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/seededit_3_edit_image.rs new file mode 100644 index 00000000..ffa88348 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/edit/seededit_3_edit_image.rs @@ -0,0 +1,23 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const SEEDEDIT_3_EDIT_IMAGE_PATH: &str = "/v1/generate/image/edit/seededit_3"; + +#[derive(Serialize, Deserialize)] +pub struct SeedEdit3EditImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// The image we're editing. + pub image_media_token: MediaFileToken, + + /// Text prompt to generate the image from. + pub prompt: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct SeedEdit3EditImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/flux_dev_juggernaut_inpaint_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/flux_dev_juggernaut_inpaint_image.rs new file mode 100644 index 00000000..0100f7be --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/flux_dev_juggernaut_inpaint_image.rs @@ -0,0 +1,38 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const FLUX_DEV_JUGGERNAUT_INPAINT_PATH: &str = "/v1/generate/image/inpaint/flux_dev_juggernaut"; + +#[derive(Serialize, Deserialize)] +pub struct FluxDevJuggernautInpaintImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// The image we're editing. + pub image_media_token: MediaFileToken, + + /// The mask to use against the image. + pub mask_media_token: MediaFileToken, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum FluxDevJuggernautInpaintImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Serialize, Deserialize)] +pub struct FluxDevJuggernautInpaintImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/flux_pro_1_inpaint_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/flux_pro_1_inpaint_image.rs new file mode 100644 index 00000000..23f23caf --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/flux_pro_1_inpaint_image.rs @@ -0,0 +1,38 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const FLUX_PRO_1_INPAINT_PATH: &str = "/v1/generate/image/inpaint/flux_pro_1"; + +#[derive(Serialize, Deserialize)] +pub struct FluxPro1InpaintImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// The image we're editing. + pub image_media_token: MediaFileToken, + + /// The mask to use against the image. + pub mask_media_token: MediaFileToken, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum FluxPro1InpaintImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Serialize, Deserialize)] +pub struct FluxPro1InpaintImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/mod.rs new file mode 100644 index 00000000..639ce489 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/inpaint/mod.rs @@ -0,0 +1,2 @@ +pub mod flux_dev_juggernaut_inpaint_image; +pub mod flux_pro_1_inpaint_image; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/mod.rs new file mode 100644 index 00000000..068f2ef5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/mod.rs @@ -0,0 +1,6 @@ +pub mod angle; +pub mod bg_removal; +pub mod edit; +pub mod inpaint; +pub mod multi_function; +pub mod text; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_5_lite_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_5_lite_multi_function_image_gen.rs new file mode 100644 index 00000000..97583422 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_5_lite_multi_function_image_gen.rs @@ -0,0 +1,67 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const BYTEDANCE_SEEDREAM_5_LITE_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/bytedance_seedream_5_lite"; + +#[derive(Serialize, Deserialize)] +pub struct BytedanceSeedream5LiteMultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context. + /// If present, we're doing image editing (image-to-image / image-editing) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + pub max_images: Option, + + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedream5LiteMultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedream5LiteMultiFunctionImageGenMaxImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedream5LiteMultiFunctionImageGenImageSize { + // Square + Square, + SquareHd, + // Tall + PortraitFourThree, + PortraitSixteenNine, + // Wide + LandscapeFourThree, + LandscapeSixteenNine, + // Auto (NB: 5 Lite max is auto_3K, not auto_4K like V4.5) + Auto2k, + Auto3k, +} + +#[derive(Serialize, Deserialize)] +pub struct BytedanceSeedream5LiteMultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_v4_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_v4_multi_function_image_gen.rs new file mode 100644 index 00000000..f6dba420 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_v4_multi_function_image_gen.rs @@ -0,0 +1,68 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const BYTEDANCE_SEEDREAM_V4_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/bytedance_seedream_4"; + +#[derive(Serialize, Deserialize)] +pub struct BytedanceSeedreamV4MultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context. + /// If present, we're doing image editing (image-to-image / image-editing) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + pub max_images: Option, + + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedreamV4MultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedreamV4MultiFunctionImageGenMaxImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedreamV4MultiFunctionImageGenImageSize { + // Square + Square, + SquareHd, + // Tall + PortraitFourThree, + PortraitSixteenNine, + // Wide + LandscapeFourThree, + LandscapeSixteenNine, + // Auto + Auto, + Auto2k, + Auto4k, +} + +#[derive(Serialize, Deserialize)] +pub struct BytedanceSeedreamV4MultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_v4p5_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_v4p5_multi_function_image_gen.rs new file mode 100644 index 00000000..7c159dfa --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/bytedance_seedream_v4p5_multi_function_image_gen.rs @@ -0,0 +1,67 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const BYTEDANCE_SEEDREAM_V4P5_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/bytedance_seedream_4p5"; + +#[derive(Serialize, Deserialize)] +pub struct BytedanceSeedreamV4p5MultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context. + /// If present, we're doing image editing (image-to-image / image-editing) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + pub max_images: Option, + + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedreamV4p5MultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedreamV4p5MultiFunctionImageGenMaxImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum BytedanceSeedreamV4p5MultiFunctionImageGenImageSize { + // Square + Square, + SquareHd, + // Tall + PortraitFourThree, + PortraitSixteenNine, + // Wide + LandscapeFourThree, + LandscapeSixteenNine, + // Auto + Auto2k, + Auto4k, +} + +#[derive(Serialize, Deserialize)] +pub struct BytedanceSeedreamV4p5MultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/gpt_image_1p5_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/gpt_image_1p5_multi_function_image_gen.rs new file mode 100644 index 00000000..e0f8d14b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/gpt_image_1p5_multi_function_image_gen.rs @@ -0,0 +1,94 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GPT_IMAGE_1P5_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/gpt_image_1p5"; + +#[derive(Serialize, Deserialize)] +pub struct GptImage1p5MultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context (**OR INPAINTING CONTEXT!**). + /// If present, we're doing image editing (image-to-image / image-editing / image-inpainting) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Only for image editing, which turns this into an inpainting task. + /// Text to image should not set this. + pub mask_image_token: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + pub image_size: Option, + + pub background: Option, + + pub quality: Option, + + /// Only for image editing. + pub input_fidelity: Option, + + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1p5MultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1p5MultiFunctionImageGenSize { + /// 1024x1024 + Square, + /// 1536x1024 + Wide, + /// 1024x1536 + Tall, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1p5MultiFunctionImageGenBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1p5MultiFunctionImageGenQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1p5MultiFunctionImageGenInputFidelity { + Low, + High, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GptImage1p5MultiFunctionImageGenOutputFormat { + Jpeg, + Png, + Webp, +} + +#[derive(Serialize, Deserialize)] +pub struct GptImage1p5MultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/mod.rs new file mode 100644 index 00000000..9df83518 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/mod.rs @@ -0,0 +1,7 @@ +pub mod bytedance_seedream_v4_multi_function_image_gen; +pub mod bytedance_seedream_v4p5_multi_function_image_gen; +pub mod bytedance_seedream_5_lite_multi_function_image_gen; +pub mod gpt_image_1p5_multi_function_image_gen; +pub mod nano_banana_2_multi_function_image_gen; +pub mod nano_banana_multi_function_image_gen; +pub mod nano_banana_pro_multi_function_image_gen; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_2_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_2_multi_function_image_gen.rs new file mode 100644 index 00000000..03608f2c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_2_multi_function_image_gen.rs @@ -0,0 +1,73 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const NANO_BANANA_2_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/nano_banana_2"; + +#[derive(Serialize, Deserialize, Debug)] +pub struct NanaBanana2MultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context. + /// If present, we're doing image editing (image-to-image / image-editing) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Resolution of the image to generate. Default is OneK (1K). + pub resolution: Option, + + /// Aspect ratio of the images to generate. Default is "1:1" + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanaBanana2MultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanaBanana2MultiFunctionImageGenImageResolution { + HalfK, + OneK, + TwoK, + FourK, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanaBanana2MultiFunctionImageGenAspectRatio { + // Auto (only for image editing) + Auto, // Default for image editing. + // Square + OneByOne, // Default for text-to-image + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + + +#[derive(Serialize, Deserialize)] +pub struct NanaBanana2MultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_multi_function_image_gen.rs new file mode 100644 index 00000000..cddb32a9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_multi_function_image_gen.rs @@ -0,0 +1,61 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const NANO_BANANA_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/nano_banana"; + +#[derive(Serialize, Deserialize, Debug)] +pub struct NanoBananaMultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context. + /// If present, we're doing image editing (image-to-image / image-editing) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Aspect ratio of the images to generate. Default is "1:1" + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanoBananaMultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanoBananaMultiFunctionImageGenAspectRatio { + // Auto (only for image editing) + Auto, // Default for image editing. + // Square + OneByOne, // Default for text-to-image + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, // NB: No NineByTwentyOne ? +} + + +#[derive(Serialize, Deserialize)] +pub struct NanoBananaMultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_pro_multi_function_image_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_pro_multi_function_image_gen.rs new file mode 100644 index 00000000..5543e3c7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/multi_function/nano_banana_pro_multi_function_image_gen.rs @@ -0,0 +1,72 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const NANO_BANANA_PRO_MULTI_FUNCTION_IMAGE_GEN_PATH: &str = "/v1/generate/image/multi_function/nano_banana_pro"; + +#[derive(Serialize, Deserialize, Debug)] +pub struct NanoBananaProMultiFunctionImageGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Image media tokens to include in the editing context. + /// If present, we're doing image editing (image-to-image / image-editing) + /// If absent, we're doing image generation (text-to-image) + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Resolution of the image to generate. Default is OneK (1K). + pub resolution: Option, + + /// Aspect ratio of the images to generate. Default is "1:1" + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanoBananaProMultiFunctionImageGenNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanoBananaProMultiFunctionImageGenImageResolution { + OneK, + TwoK, + FourK, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum NanoBananaProMultiFunctionImageGenAspectRatio { + // Auto (only for image editing) + Auto, // Default for image editing. + // Square + OneByOne, // Default for text-to-image + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, // NB: No NineByTwentyOne ? +} + + +#[derive(Serialize, Deserialize)] +pub struct NanoBananaProMultiFunctionImageGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/gemini_25_flash_text_to_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/gemini_25_flash_text_to_image.rs new file mode 100644 index 00000000..9e4f4ce4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/gemini_25_flash_text_to_image.rs @@ -0,0 +1,49 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GEMINI_25_FLASH_EDIT_IMAGE_PATH: &str = "/v1/generate/image/gemini_25_flash"; + +#[derive(Serialize, Deserialize)] +pub struct Gemini25FlashTextToImageImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + // TODO: OneOf for image_urls or image_media_tokens + /// Image media tokens to include in the editing context. + pub image_media_tokens: Option>, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Quality of the image to generate. Default is High. + pub image_quality: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Gemini25FlashTextToImageImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Gemini25FlashTextToImageImageImageQuality { + Auto, + Low, + Medium, + High, // Default +} + + +#[derive(Serialize, Deserialize)] +pub struct Gemini25FlashTextToImageImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_1_dev_text_to_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_1_dev_text_to_image.rs new file mode 100644 index 00000000..aa419835 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_1_dev_text_to_image.rs @@ -0,0 +1,48 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const GENERATE_FLUX_1_DEV_TEXT_TO_IMAGE_PATH: &str = "/v1/generate/image/flux_1_dev_text_to_image"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateFlux1DevTextToImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Aspect ratio of the output images. + pub aspect_ratio: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFlux1DevTextToImageAspectRatio { + Square, // 1:1 + SquareHd, // 1:1 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFlux1DevTextToImageNumImages { + One, // Default + Two, + Three, + Four, +} + + +#[derive(Serialize, Deserialize)] +pub struct GenerateFlux1DevTextToImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_1_schnell_text_to_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_1_schnell_text_to_image.rs new file mode 100644 index 00000000..5058f217 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_1_schnell_text_to_image.rs @@ -0,0 +1,48 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const GENERATE_FLUX_1_SCHNELL_TEXT_TO_IMAGE_PATH: &str = "/v1/generate/image/flux_1_schnell_text_to_image"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateFlux1SchnellTextToImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Aspect ratio of the output images. + pub aspect_ratio: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFlux1SchnellTextToImageAspectRatio { + Square, // 1:1 + SquareHd, // 1:1 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFlux1SchnellTextToImageNumImages { + One, // Default + Two, + Three, + Four, +} + + +#[derive(Serialize, Deserialize)] +pub struct GenerateFlux1SchnellTextToImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_pro_11_text_to_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_pro_11_text_to_image.rs new file mode 100644 index 00000000..309685be --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_pro_11_text_to_image.rs @@ -0,0 +1,46 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const GENERATE_FLUX_PRO_11_TEXT_TO_IMAGE_PATH: &str = "/v1/generate/image/flux_pro_1.1_text_to_image"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateFluxPro11TextToImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Aspect ratio of the output images. + pub aspect_ratio: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + +// TODO(btw,2026-01-01): Fal.ai and Fal.rs client libraries seem to disagree about the options. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFluxPro11TextToImageAspectRatio { + Square, // 1:1 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFluxPro11TextToImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateFluxPro11TextToImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_pro_11_ultra_text_to_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_pro_11_ultra_text_to_image.rs new file mode 100644 index 00000000..c64fc8d6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_flux_pro_11_ultra_text_to_image.rs @@ -0,0 +1,49 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const GENERATE_FLUX_PRO_11_ULTRA_TEXT_TO_IMAGE_PATH: &str = "/v1/generate/image/flux_pro_1.1_ultra_text_to_image"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateFluxPro11UltraTextToImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Aspect ratio of the output images. + pub aspect_ratio: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFluxPro11UltraTextToImageAspectRatio { + Square, // 1:1 + LandscapeThreeByTwo, // 3:2 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + LandscapeTwentyOneByNine, // 21:9 + PortraitTwoByThree, // 2:3 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + PortraitNineByTwentyOne, // 9:21 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateFluxPro11UltraTextToImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateFluxPro11UltraTextToImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_gpt_image_1_text_to_image.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_gpt_image_1_text_to_image.rs new file mode 100644 index 00000000..c5a2476c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/generate_gpt_image_1_text_to_image.rs @@ -0,0 +1,57 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GPT_IMAGE_1_TEXT_TO_IMAGE_PATH: &str = "/v1/generate/image/gpt_image_1_text_to_image"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateGptImage1TextToImageRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt to generate the image from. + pub prompt: Option, + + /// Size of the image to generate. Default is Square. + pub image_size: Option, + + /// Number of images to generate. Default is one. + pub num_images: Option, + + /// Quality of the image to generate. Default is High. + pub image_quality: Option, +} + + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateGptImage1TextToImageImageSize { + Square, // 1:1, Default + Horizontal, + Vertical, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateGptImage1TextToImageNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateGptImage1TextToImageImageQuality { + Auto, + Low, + Medium, + High, // Default +} + + +#[derive(Serialize, Deserialize)] +pub struct GenerateGptImage1TextToImageResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/mod.rs new file mode 100644 index 00000000..c3c74773 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/image/text/mod.rs @@ -0,0 +1,6 @@ +pub mod gemini_25_flash_text_to_image; +pub mod generate_flux_1_dev_text_to_image; +pub mod generate_flux_1_schnell_text_to_image; +pub mod generate_flux_pro_11_text_to_image; +pub mod generate_flux_pro_11_ultra_text_to_image; +pub mod generate_gpt_image_1_text_to_image; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/mod.rs new file mode 100644 index 00000000..41418113 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/mod.rs @@ -0,0 +1,5 @@ +pub mod cost_estimate; +pub mod image; +pub mod object; +pub mod splat; +pub mod video; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/object/generate_hunyuan_2_0_image_to_3d.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/object/generate_hunyuan_2_0_image_to_3d.rs new file mode 100644 index 00000000..0d59c089 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/object/generate_hunyuan_2_0_image_to_3d.rs @@ -0,0 +1,21 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_HUNYUAN_2_0_IMAGE_TO_3D_URL_PATH: &str = "/v1/generate/object/hunyuan_2.0_image_to_3d"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateHunyuan20ImageTo3dRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the file to convert to 3D + /// It must be an image. + pub media_file_token: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateHunyuan20ImageTo3dResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/object/generate_hunyuan_2_1_image_to_3d.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/object/generate_hunyuan_2_1_image_to_3d.rs new file mode 100644 index 00000000..706d6551 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/object/generate_hunyuan_2_1_image_to_3d.rs @@ -0,0 +1,21 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_HUNYUAN_2_1_IMAGE_TO_3D_URL_PATH: &str = "/v1/generate/object/hunyuan_2.1_image_to_3d"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateHunyuan21ImageTo3dRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the file to convert to 3D + /// It must be an image. + pub media_file_token: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateHunyuan21ImageTo3dResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/object/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/object/mod.rs new file mode 100644 index 00000000..582e9c13 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/object/mod.rs @@ -0,0 +1,3 @@ +pub mod generate_hunyuan_2_0_image_to_3d; +pub mod generate_hunyuan_2_1_image_to_3d; +pub mod multi_function; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/object/multi_function/hunyuan3d_v3_multi_function_object_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/object/multi_function/hunyuan3d_v3_multi_function_object_gen.rs new file mode 100644 index 00000000..42d763d8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/object/multi_function/hunyuan3d_v3_multi_function_object_gen.rs @@ -0,0 +1,83 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const HUNYUAN3D_V3_MULTI_FUNCTION_OBJECT_GEN_PATH: &str = "/v1/generate/object/multi_function/hunyuan3d_v3"; + +/// Hunyuan 3D v3 Multi-Function Request +/// +/// This endpoint combines three modes: +/// - Text-to-3D: Provide only a prompt (no image_media_token) +/// - Image-to-3D: Provide an image_media_token (no prompt or empty prompt) +/// - Sketch-to-3D: Provide both a prompt AND an image_media_token +#[derive(Serialize, Deserialize, Debug)] +pub struct Hunyuan3dV3MultiFunctionObjectGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt for generation. + /// - Required for text-to-3d mode + /// - Required for sketch-to-3d mode + /// - Ignored for image-to-3d mode + pub prompt: Option, + + /// Primary image media token. + /// - Required for image-to-3d mode + /// - Required for sketch-to-3d mode + /// - Not used for text-to-3d mode + pub image_media_token: Option, + + /// Back view image for multi-view image-to-3d mode. + /// Only applicable when image_media_token is provided without a prompt. + pub back_image_media_token: Option, + + /// Left view image for multi-view image-to-3d mode. + /// Only applicable when image_media_token is provided without a prompt. + pub left_image_media_token: Option, + + /// Right view image for multi-view image-to-3d mode. + /// Only applicable when image_media_token is provided without a prompt. + pub right_image_media_token: Option, + + /// Target face count for the generated mesh. + /// Optional - if not provided, the model will use its default. + pub face_count: Option, + + /// Type of generation to perform. + /// Default is Normal. + pub generate_type: Option, + + /// Type of polygon to use in the generated mesh. + /// Default is Triangle. + pub polygon_type: Option, + + /// Whether to enable PBR (Physically Based Rendering) materials. + /// Default is false. + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Hunyuan3dV3GenerateType { + /// Standard generation quality (default) + Normal, + /// Low polygon count for game assets + LowPoly, + /// Geometry only, no textures + Geometry, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Hunyuan3dV3PolygonType { + /// Triangle polygons (default) + Triangle, + /// Quadrilateral polygons + Quadrilateral, +} + +#[derive(Serialize, Deserialize)] +pub struct Hunyuan3dV3MultiFunctionObjectGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/object/multi_function/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/object/multi_function/mod.rs new file mode 100644 index 00000000..22285b9e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/object/multi_function/mod.rs @@ -0,0 +1 @@ +pub mod hunyuan3d_v3_multi_function_object_gen; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/splat/generate_worldlabs_marble_0p1_mini_splat.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/splat/generate_worldlabs_marble_0p1_mini_splat.rs new file mode 100644 index 00000000..861aa95e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/splat/generate_worldlabs_marble_0p1_mini_splat.rs @@ -0,0 +1,24 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_WORLDLABS_MARBLE_0P1_MINI_SPLAT_URL_PATH: &str = "/v1/generate/splat/worldlabs_marble_0p1_mini"; + +/// World Labs Marble 0.1-mini Splat Generation +#[derive(Serialize, Deserialize)] +pub struct GenerateWorldlabsMarble0p1MiniSplatRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Optional image to use as input for world generation. + pub image_media_file_token: Option, + + /// Optional text prompt for world generation. + pub prompt: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateWorldlabsMarble0p1MiniSplatResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/splat/generate_worldlabs_marble_0p1_plus_splat.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/splat/generate_worldlabs_marble_0p1_plus_splat.rs new file mode 100644 index 00000000..e289a970 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/splat/generate_worldlabs_marble_0p1_plus_splat.rs @@ -0,0 +1,24 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_WORLDLABS_MARBLE_0P1_PLUS_SPLAT_URL_PATH: &str = "/v1/generate/splat/worldlabs_marble_0p1_plus"; + +/// World Labs Marble 0.1-plus Splat Generation +#[derive(Serialize, Deserialize)] +pub struct GenerateWorldlabsMarble0p1PlusSplatRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Optional image to use as input for world generation. + pub image_media_file_token: Option, + + /// Optional text prompt for world generation. + pub prompt: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateWorldlabsMarble0p1PlusSplatResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/splat/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/splat/mod.rs new file mode 100644 index 00000000..68557f53 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/splat/mod.rs @@ -0,0 +1,2 @@ +pub mod generate_worldlabs_marble_0p1_mini_splat; +pub mod generate_worldlabs_marble_0p1_plus_splat; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/edit/beeble_switchx_edit_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/edit/beeble_switchx_edit_video.rs new file mode 100644 index 00000000..35538901 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/edit/beeble_switchx_edit_video.rs @@ -0,0 +1,19 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const BEEBLE_SWITCHX_EDIT_VIDEO_PATH: &str = "/v1/generate/video/edit/beeble_switchx"; + +#[derive(Serialize, Deserialize, Debug)] +pub struct BeebleSwitchXEditVideoRequest { + pub uuid_idempotency_token: String, + pub source_video_media_token: Option, + pub reference_image_media_token: Option, + pub prompt: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct BeebleSwitchXEditVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/edit/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/edit/mod.rs new file mode 100644 index 00000000..ad8f1b29 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/edit/mod.rs @@ -0,0 +1 @@ +pub mod beeble_switchx_edit_video; diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_1_6_pro_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_1_6_pro_image_to_video.rs new file mode 100644 index 00000000..34f7f78b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_1_6_pro_image_to_video.rs @@ -0,0 +1,52 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_KLING_1_6_PRO_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/kling_1.6_pro_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateKling16ProImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional. + /// Image media file; the image to remove the background from. + pub end_frame_image_media_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, + + /// Optional: aspect ratio of the generated video. + pub duration: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateKling16ProAspectRatio { + /// 16:9 aspect ratio + WideSixteenNine, + /// 9:16 aspect ratio + TallNineSixteen, + /// 1:1 aspect ratio + Square, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateKling16ProDuration { + FiveSeconds, + TenSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateKling16ProImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_2_1_master_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_2_1_master_image_to_video.rs new file mode 100644 index 00000000..079a9845 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_2_1_master_image_to_video.rs @@ -0,0 +1,48 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_KLING_2_1_MASTER_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/kling_2.1_master_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateKling21MasterImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, + + /// Optional: aspect ratio of the generated video. + pub duration: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateKling21MasterAspectRatio { + /// 16:9 aspect ratio + WideSixteenNine, + /// 9:16 aspect ratio + TallNineSixteen, + /// 1:1 aspect ratio + Square, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateKling21MasterDuration { + FiveSeconds, + TenSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateKling21MasterImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_2_1_pro_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_2_1_pro_image_to_video.rs new file mode 100644 index 00000000..c931b451 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_kling_2_1_pro_image_to_video.rs @@ -0,0 +1,52 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_KLING_2_1_PRO_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/kling_2.1_pro_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateKling21ProImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional. + /// Image media file; the image to remove the background from. + pub end_frame_image_media_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, + + /// Optional: aspect ratio of the generated video. + pub duration: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateKling21ProAspectRatio { + /// 16:9 aspect ratio + WideSixteenNine, + /// 9:16 aspect ratio + TallNineSixteen, + /// 1:1 aspect ratio + Square, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateKling21ProDuration { + FiveSeconds, + TenSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateKling21ProImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_seedance_1_0_lite_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_seedance_1_0_lite_image_to_video.rs new file mode 100644 index 00000000..6115ea92 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_seedance_1_0_lite_image_to_video.rs @@ -0,0 +1,64 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_SEEDANCE_1_0_LITE_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/seedance_1.0_lite_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateSeedance10LiteImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional. + /// Image media file; the image to remove the background from. + pub end_frame_image_media_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: resolution of the generated video. + pub resolution: Option, + + /// Optional: duration of the generated video. + pub duration: Option, + + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateSeedance10LiteResolution { + FourEightyP, + SevenTwentyP, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateSeedance10LiteDuration { + FiveSeconds, + TenSeconds, +} + + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateSeedance10LiteAspectRatio { + Auto, + TwentyOneByNine, + SixteenByNine, + FourByThree, + Square, + ThreeByFour, + NineBySixteen, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateSeedance10LiteImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_seedance_1_0_pro_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_seedance_1_0_pro_image_to_video.rs new file mode 100644 index 00000000..25b9a803 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_seedance_1_0_pro_image_to_video.rs @@ -0,0 +1,53 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_SEEDANCE_1_0_PRO_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/seedance_1.0_pro_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateSeedance10ProImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: aspect ratio of the generated video. + pub resolution: Option, + + /// Optional: aspect ratio of the generated video. + pub duration: Option, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateSeedance10ProResolution { + FourEightyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateSeedance10ProDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateSeedance10ProImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_2_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_2_image_to_video.rs new file mode 100644 index 00000000..78f0249b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_2_image_to_video.rs @@ -0,0 +1,49 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_VEO_2_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/veo_2_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateVeo2ImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// **NB(bt): ASPECT RATIO IS ACTUALLY NOT USED IN VEO 2 IMAGE-TO-VIDEO** + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, + + /// Optional: aspect ratio of the generated video. + pub duration: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo2AspectRatio { + Auto, + AutoPreferPortrait, + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo2Duration { + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateVeo2ImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_3_fast_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_3_fast_image_to_video.rs new file mode 100644 index 00000000..2cff62dc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_3_fast_image_to_video.rs @@ -0,0 +1,57 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_VEO_3_FAST_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/veo_3_fast_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateVeo3FastImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: resolution of the generated video. + pub resolution: Option, + + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, + + /// Optional: duration of the generated video. + pub duration: Option, + + /// Optional: Generate an audio track along with the video + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo3FastResolution { + SevenTwentyP, // 720p + TenEightyP, // 1080p +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo3FastAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo3FastDuration { + EightSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateVeo3FastImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_3_image_to_video.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_3_image_to_video.rs new file mode 100644 index 00000000..6055c494 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/generate_veo_3_image_to_video.rs @@ -0,0 +1,68 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const GENERATE_VEO_3_IMAGE_TO_VIDEO_URL_PATH: &str = "/v1/generate/video/veo_3_image_to_video"; + +#[derive(Serialize, Deserialize)] +pub struct GenerateVeo3ImageToVideoRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Source of the image file to convert to video. + /// It must be an image. + pub media_file_token: Option, + + /// Optional text prompt. + pub prompt: Option, + + /// Optional: aspect ratio of the generated video. + pub aspect_ratio: Option, + + /// Optional: resolution of the generated video. + pub resolution: Option, + + /// Optional: aspect ratio of the generated video. + pub duration: Option, + + /// Optional: Generate an audio track along with the video + pub generate_audio: Option, + + // /// Optional. + // pub enhance_prompt: Option, + // /// Optional. Whether to automatically attempt to fix prompts that fail + // /// content policy or other validation checks by rewriting them + // /// Default value: true + // pub auto_fix: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo3AspectRatio { + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 + + /// NB: DO NOT REMOVE. This is an unsupported resolution for Veo 3, but we can't + /// impact existing callers by removing it. The handler will convert this to a + /// supported resolution or 400 the request instead. + Square, // 1:1 +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo3Resolution { + SevenTwentyP, // 720p + TenEightyP, // 1080p +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerateVeo3Duration { + EightSeconds, +} + +#[derive(Serialize, Deserialize)] +pub struct GenerateVeo3ImageToVideoResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/mod.rs new file mode 100644 index 00000000..a1a46f0e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/mod.rs @@ -0,0 +1,10 @@ +pub mod edit; +pub mod generate_kling_1_6_pro_image_to_video; +pub mod generate_kling_2_1_master_image_to_video; +pub mod generate_kling_2_1_pro_image_to_video; +pub mod generate_seedance_1_0_lite_image_to_video; +pub mod generate_seedance_1_0_pro_image_to_video; +pub mod generate_veo_2_image_to_video; +pub mod generate_veo_3_fast_image_to_video; +pub mod generate_veo_3_image_to_video; +pub mod multi_function; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_2_5_turbo_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_2_5_turbo_multi_function_video_gen.rs new file mode 100644 index 00000000..ed573c88 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_2_5_turbo_multi_function_video_gen.rs @@ -0,0 +1,63 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const KLING_2P5_TURBO_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH: &str = "/v1/generate/video/multi_function/kling_2p5_turbo_pro"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Kling2p5TurboProMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for text-to-video. + pub negative_prompt: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the starting frame + /// If present, we're doing image-to-video + /// If absent, we're doing text-to-video + pub start_frame_image_media_token: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the ending frame (if desired) + pub end_frame_image_media_token: Option, + + /// Optional + /// Duration of the video + pub duration: Option, + + /// Optional. + /// Only for text-to-video + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling2p5TurboProMultiFunctionVideoGenDuration { + FiveSeconds, + TenSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling2p5TurboProMultiFunctionVideoGenAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + + +#[derive(Serialize, Deserialize)] +pub struct Kling2p5TurboProMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_2_6_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_2_6_multi_function_video_gen.rs new file mode 100644 index 00000000..945df4e4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_2_6_multi_function_video_gen.rs @@ -0,0 +1,67 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const KLING_2P6_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH: &str = "/v1/generate/video/multi_function/kling_2p6_pro"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Kling2p6ProMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for text-to-video. + pub negative_prompt: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the starting frame + /// If present, we're doing image-to-video + /// If absent, we're doing text-to-video + pub start_frame_image_media_token: Option, + + // /// Optional. + // /// Only for image-to-video + // /// Source of the ending frame (if desired) + // pub end_frame_image_media_token: Option, + + /// Optional + /// Duration of the video + pub duration: Option, + + /// Optional + /// Whether to generate audio. + pub generate_audio: Option, + + /// Optional. + /// Only for text-to-video + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling2p6ProMultiFunctionVideoGenDuration { + FiveSeconds, + TenSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling2p6ProMultiFunctionVideoGenAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + + +#[derive(Serialize, Deserialize)] +pub struct Kling2p6ProMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_3p0_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_3p0_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..4b538891 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_3p0_pro_multi_function_video_gen.rs @@ -0,0 +1,65 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const KLING_3P0_PRO_MULTI_FUNCTION_VIDEO_PATH: &str = "/v1/generate/video/multi_function/kling_3p0_pro"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Kling3p0ProMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt. + pub prompt: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// If present, we're doing image-to-video. If absent, text-to-video. + pub image_media_token: Option, + + /// Optional end frame image. + pub end_image_media_token: Option, + + /// Duration of the video (3-15 seconds). + pub duration: Option, + + /// Whether to generate audio. + pub generate_audio: Option, + + /// Aspect ratio (only for text-to-video). + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling3p0ProMultiFunctionVideoGenDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling3p0ProMultiFunctionVideoGenAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Serialize, Deserialize)] +pub struct Kling3p0ProMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_3p0_standard_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_3p0_standard_multi_function_video_gen.rs new file mode 100644 index 00000000..d4e85d28 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/kling_3p0_standard_multi_function_video_gen.rs @@ -0,0 +1,65 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const KLING_3P0_STANDARD_MULTI_FUNCTION_VIDEO_PATH: &str = "/v1/generate/video/multi_function/kling_3p0_standard"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Kling3p0StandardMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt. + pub prompt: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// If present, we're doing image-to-video. If absent, text-to-video. + pub image_media_token: Option, + + /// Optional end frame image. + pub end_image_media_token: Option, + + /// Duration of the video (3-15 seconds). + pub duration: Option, + + /// Whether to generate audio. + pub generate_audio: Option, + + /// Aspect ratio (only for text-to-video). + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling3p0StandardMultiFunctionVideoGenDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Kling3p0StandardMultiFunctionVideoGenAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Serialize, Deserialize)] +pub struct Kling3p0StandardMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/mod.rs new file mode 100644 index 00000000..e29945ab --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/mod.rs @@ -0,0 +1,10 @@ +pub mod kling_2_5_turbo_multi_function_video_gen; +pub mod kling_2_6_multi_function_video_gen; +pub mod kling_3p0_pro_multi_function_video_gen; +pub mod kling_3p0_standard_multi_function_video_gen; +pub mod seedance_1p5_pro_multi_function_video_gen; +pub mod seedance_2p0_multi_function_video_gen; +pub mod sora_2_multi_function_video_gen; +pub mod sora_2_pro_multi_function_video_gen; +pub mod veo_3p1_fast_multi_function_video_gen; +pub mod veo_3p1_multi_function_video_gen; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/seedance_1p5_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/seedance_1p5_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..4a023e3e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/seedance_1p5_pro_multi_function_video_gen.rs @@ -0,0 +1,84 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const SEEDANCE_1P5_PRO_MULTI_FUNCTION_VIDEO_GEN_PATH: &str = "/v1/generate/video/multi_function/seedance_1p5_pro"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize, Debug)] +pub struct Seedance1p5ProMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for image-to-video. + /// Source of the starting frame. + /// If present, we're doing image-to-video. + /// If absent, we're doing text-to-video. + pub start_frame_image_media_token: Option, + + /// Optional. + /// Only for image-to-video. + /// Source of the ending frame. + pub end_frame_image_media_token: Option, + + /// Optional. + pub resolution: Option, + + /// Optional. + /// Duration of the video. + /// (this is uniform against all modes) + pub duration: Option, + + /// Optional. + pub aspect_ratio: Option, + + /// Whether to generate audio. + pub generate_audio: Option, +} + +#[derive(Serialize, Deserialize, Copy, Clone, Debug)] +#[serde(rename_all = "snake_case")] +pub enum Seedance1p5ProMultiFunctionVideoGenResolution { + FourEightyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Serialize, Deserialize, Copy, Clone, Debug)] +#[serde(rename_all = "snake_case")] +pub enum Seedance1p5ProMultiFunctionVideoGenDuration { + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, +} + +#[derive(Serialize, Deserialize, Copy, Clone, Debug)] +#[serde(rename_all = "snake_case")] +pub enum Seedance1p5ProMultiFunctionVideoGenAspectRatio { + TwentyOneByNine, + SixteenByNine, + FourByThree, + Square, + ThreeByFour, + NineBySixteen, + Auto, +} + + +#[derive(Serialize, Deserialize)] +pub struct Seedance1p5ProMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/seedance_2p0_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/seedance_2p0_multi_function_video_gen.rs new file mode 100644 index 00000000..b3131ba3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/seedance_2p0_multi_function_video_gen.rs @@ -0,0 +1,109 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::characters::CharacterToken; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const SEEDANCE_2P0_MULTI_FUNCTION_VIDEO_GEN_PATH: &str = "/v1/generate/video/multi_function/seedance_2p0"; + +/// Seedance 2.0 multi-function video generation (text-to-video, image-to-video, and reference-based). +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct Seedance2p0MultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// Text prompt. + pub prompt: Option, + + /// Optional start frame image. + pub start_frame_media_token: Option, + + /// Optional end frame image. + pub end_frame_media_token: Option, + + /// Optional reference images (reference mode). When present, takes priority over start/end frames. + pub reference_image_media_tokens: Option>, + + /// Optional reference videos. + pub reference_video_media_tokens: Option>, + + /// Optional reference audio files. + pub reference_audio_media_tokens: Option>, + + /// Optional character tokens to reference in the prompt. + /// Characters are referenced in prompts as @CharacterName. + pub reference_character_tokens: Option>, + + /// Video aspect ratio / resolution. + pub aspect_ratio: Option, + + /// Output resolution quality tier (480p, 720p, 1080p). + pub output_resolution: Option, + + /// Duration in seconds (4–15). + pub duration_seconds: Option, + + /// Number of videos to generate. + pub batch_count: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Seedance2p0AspectRatio { + /// 16:9 landscape (1280x720) + Landscape16x9, + /// 9:16 portrait (720x1280) + Portrait9x16, + /// 1:1 square (720x720) + Square1x1, + /// 4:3 standard (960x720) + Standard4x3, + /// 3:4 portrait (720x960) + Portrait3x4, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Seedance2p0BatchCount { + One, + Two, + Four, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Seedance2p0OutputResolution { + /// 480p + FourEightyP, + /// 720p (default) + SevenTwentyP, + /// 1080p + TenEightyP, +} + +#[derive(Serialize, Deserialize)] +pub struct Seedance2p0MultiFunctionVideoGenResponse { + pub success: bool, + + /// The first inference job token (always present). + pub inference_job_token: InferenceJobToken, + + /// All inference job tokens for the batch (includes `inference_job_token` as the first entry). + pub all_inference_job_tokens: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + + fn aspect_to_string(input: Seedance2p0AspectRatio) -> anyhow::Result { + let val = serde_json::to_string(&input)?; + Ok(val.replace("\"", "")) + } + + #[test] + fn just_testing_snake_case() -> anyhow::Result<()> { + // Ugh, not sure what these are... + assert_eq!(aspect_to_string(Seedance2p0AspectRatio::Landscape16x9)?, "landscape16x9"); + Ok(()) + } +} \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/sora_2_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/sora_2_multi_function_video_gen.rs new file mode 100644 index 00000000..c2e2b66f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/sora_2_multi_function_video_gen.rs @@ -0,0 +1,65 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const SORA_2_MULTI_FUNCTION_VIDEO_VIDEO_PATH: &str = "/v1/generate/video/multi_function/sora_2"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Sora2MultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the starting frame + /// If present, we're doing image-to-video + /// If absent, we're doing text-to-video + pub image_media_token: Option, + + /// Optional. + pub resolution: Option, + + /// Optional + /// Duration of the video + /// (this is uniform against all modes) + pub duration: Option, + + /// Optional. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Sora2MultiFunctionVideoGenResolution { + Auto, + SevenTwentyP, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Sora2MultiFunctionVideoGenDuration { + FourSeconds, + EightSeconds, + TwelveSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Sora2MultiFunctionVideoGenAspectRatio { + Auto, + NineBySixteen, + SixteenByNine, +} + + +#[derive(Serialize, Deserialize)] +pub struct Sora2MultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/sora_2_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/sora_2_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..cc972df3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/sora_2_pro_multi_function_video_gen.rs @@ -0,0 +1,66 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const SORA_2_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH: &str = "/v1/generate/video/multi_function/sora_2_pro"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Sora2ProMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the starting frame + /// If present, we're doing image-to-video + /// If absent, we're doing text-to-video + pub image_media_token: Option, + + /// Optional. + pub resolution: Option, + + /// Optional + /// Duration of the video + /// (this is uniform against all modes) + pub duration: Option, + + /// Optional. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Sora2ProMultiFunctionVideoGenResolution { + Auto, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Sora2ProMultiFunctionVideoGenDuration { + FourSeconds, + EightSeconds, + TwelveSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Sora2ProMultiFunctionVideoGenAspectRatio { + Auto, + NineBySixteen, + SixteenByNine, +} + + +#[derive(Serialize, Deserialize)] +pub struct Sora2ProMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/veo_3p1_fast_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/veo_3p1_fast_multi_function_video_gen.rs new file mode 100644 index 00000000..671c01a9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/veo_3p1_fast_multi_function_video_gen.rs @@ -0,0 +1,89 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const VEO_3P1_FAST_MULTI_FUNCTION_VIDEO_VIDEO_PATH: &str = "/v1/generate/video/multi_function/veo_3p1_fast"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Veo3p1FastMultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for text-to-video. + pub negative_prompt: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the starting frame + /// If present, we're doing image-to-video + /// If absent, we're doing text-to-video + pub start_frame_image_media_token: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the ending frame (if desired) + pub end_frame_image_media_token: Option, + + /// Optional + /// Duration of the video + /// (this is uniform against all modes) + pub duration: Option, + + /// Optional. + pub aspect_ratio: Option, + + /// Optional. + pub resolution: Option, + + /// Optional + /// Whether to generate audio. + pub generate_audio: Option, + + /// Optional + /// Only for text-to-video + pub enhance_prompt: Option, + + /// Optional + /// Only for text-to-video + pub seed: Option, + + /// Optional + /// Only for text-to-video + pub auto_fix: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Veo3p1FastMultiFunctionVideoGenDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Veo3p1FastMultiFunctionVideoGenAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Veo3p1FastMultiFunctionVideoGenResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Serialize, Deserialize)] +pub struct Veo3p1FastMultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/veo_3p1_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/veo_3p1_multi_function_video_gen.rs new file mode 100644 index 00000000..6678b2cc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/generate/video/multi_function/veo_3p1_multi_function_video_gen.rs @@ -0,0 +1,89 @@ +use serde::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const VEO_3P1_MULTI_FUNCTION_VIDEO_VIDEO_PATH: &str = "/v1/generate/video/multi_function/veo_3p1"; + +/// Both text-to-video and image-to-video in one request. +#[derive(Serialize, Deserialize)] +pub struct Veo3p1MultiFunctionVideoGenRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// "Required". + /// Required downstream, but we'll coerce null to empty string. + /// Text prompt. + pub prompt: Option, + + /// Optional. + /// Only for text-to-video. + pub negative_prompt: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the starting frame + /// If present, we're doing image-to-video + /// If absent, we're doing text-to-video + pub start_frame_image_media_token: Option, + + /// Optional. + /// Only for image-to-video + /// Source of the ending frame (if desired) + pub end_frame_image_media_token: Option, + + /// Optional + /// Duration of the video + /// (this is uniform against all modes) + pub duration: Option, + + /// Optional. + pub aspect_ratio: Option, + + /// Optional. + pub resolution: Option, + + /// Optional + /// Whether to generate audio. + pub generate_audio: Option, + + /// Optional + /// Only for text-to-video + pub enhance_prompt: Option, + + /// Optional + /// Only for text-to-video + pub seed: Option, + + /// Optional + /// Only for text-to-video + pub auto_fix: Option, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Veo3p1MultiFunctionVideoGenDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Veo3p1MultiFunctionVideoGenAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Veo3p1MultiFunctionVideoGenResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Serialize, Deserialize)] +pub struct Veo3p1MultiFunctionVideoGenResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/jobs/batch_get_job_status.rs b/crates/api_clients/artcraft_client/src/api_defs/jobs/batch_get_job_status.rs new file mode 100644 index 00000000..6cb43cdb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/jobs/batch_get_job_status.rs @@ -0,0 +1,54 @@ +//! Types for `GET /v1/jobs/batch` — get job statuses for a batch of job tokens. +//! +//! Mirrors storyteller-web's `batch_get_inference_job_status_handler`. The +//! per-job payload shape is identical to the single-job endpoint, so this +//! reuses [`JobStatusPayload`](crate::api_defs::jobs::get_job_status::JobStatusPayload). + +use serde::Deserialize; +use serde::Serialize; + +use crate::api_defs::jobs::get_job_status::JobStatusPayload; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const BATCH_GET_JOB_STATUS_URL_PATH: &str = "/v1/jobs/batch"; + +/// Build the request path for a batch of job tokens. +/// The server reads repeated `tokens=` query keys into a set. +pub fn batch_get_job_status_url_path(job_tokens: &[InferenceJobToken]) -> String { + let query = job_tokens.iter() + .map(|token| format!("tokens={}", token.as_str())) + .collect::>() + .join("&"); + format!("{}?{}", BATCH_GET_JOB_STATUS_URL_PATH, query) +} + +#[derive(Serialize, Deserialize)] +pub struct BatchGetJobStatusSuccessResponse { + pub success: bool, + + /// One entry per job the server knows about. Unknown tokens are simply + /// absent from the list. + pub job_states: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn url_path_repeats_tokens_key() { + let tokens = vec![ + InferenceJobToken::new_from_str("jinf_aaa"), + InferenceJobToken::new_from_str("jinf_bbb"), + ]; + assert_eq!( + batch_get_job_status_url_path(&tokens), + "/v1/jobs/batch?tokens=jinf_aaa&tokens=jinf_bbb", + ); + } + + #[test] + fn url_path_with_no_tokens() { + assert_eq!(batch_get_job_status_url_path(&[]), "/v1/jobs/batch?"); + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/jobs/get_job_status.rs b/crates/api_clients/artcraft_client/src/api_defs/jobs/get_job_status.rs new file mode 100644 index 00000000..f3e8c359 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/jobs/get_job_status.rs @@ -0,0 +1,133 @@ +//! Types for `GET /v1/jobs/job/{token}` — get the status for a single job. +//! +//! Mirrors storyteller-web's `get_inference_job_status_handler`. The batch +//! endpoint (`/v1/jobs/batch`) returns the same per-job payload shape, so +//! its binding reuses these types. + +use chrono::{DateTime, Utc}; +use serde::Deserialize; +use serde::Serialize; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +use crate::api_defs::common::responses::job_details::{JobDetailsLipsyncRequest, JobDetailsLivePortraitRequest}; +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::enums::api_safe::by_table::generic_inference_jobs::frontend_failure_category_for_api_clients::FrontendFailureCategoryForApiClients; +use crate::enums::by_table::generic_inference_jobs::inference_category::InferenceCategory; +use crate::enums::common::job_status_plus::JobStatusPlus; +use crate::enums::no_table::style_transfer::style_transfer_name::StyleTransferName; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const GET_JOB_STATUS_URL_PATH_PREFIX: &str = "/v1/jobs/job"; + +/// Build the request path for a single job's status. +pub fn get_job_status_url_path(job_token: &InferenceJobToken) -> String { + format!("{}/{}", GET_JOB_STATUS_URL_PATH_PREFIX, job_token.as_str()) +} + +#[derive(Serialize, Deserialize)] +pub struct GetJobStatusSuccessResponse { + pub success: bool, + pub state: JobStatusPayload, +} + +/// The full status payload for one job. +#[derive(Serialize, Deserialize)] +pub struct JobStatusPayload { + pub job_token: InferenceJobToken, + + pub request: JobStatusRequestDetails, + pub status: JobStatusDetails, + pub maybe_result: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, +} + +/// Details about what the user requested for generation. +#[derive(Serialize, Deserialize)] +pub struct JobStatusRequestDetails { + pub inference_category: InferenceCategory, + + pub maybe_prompt_token: Option, + + pub maybe_model_type: Option, + pub maybe_model_token: Option, + + /// OPTIONAL. Title of the model, if it has one + pub maybe_model_title: Option, + + /// OPTIONAL. If the result was TTS, this is the raw inference text. + pub maybe_raw_inference_text: Option, + + /// OPTIONAL. For Comfy / Video Style Transfer jobs, this might include + /// the name of the selected style. + pub maybe_style_name: Option, + + /// OPTIONAL. For Live Portrait jobs, this is additional information on the request. + pub maybe_live_portrait_details: Option, + + /// OPTIONAL. For lipsync jobs (face fusion and sad talker), this is additional + /// information on the request. + pub maybe_lipsync_details: Option, +} + +/// Details about the ongoing job status. +#[derive(Serialize, Deserialize)] +pub struct JobStatusDetails { + /// Primary status from the database (a state machine). + pub status: JobStatusPlus, + + /// Extra, temporary status from Redis. + /// This can denote inference progress, and the Python code can write to it. + pub maybe_extra_status_description: Option, + + pub maybe_assigned_worker: Option, + pub maybe_assigned_cluster: Option, + + pub maybe_first_started_at: Option>, + + pub attempt_count: u8, + + /// Whether the frontend needs to maintain a keepalive check. + /// This is typically only for non-premium users. + pub requires_keepalive: bool, + + /// An enum the frontend can use to display localized/I18N error + /// messages. These pertain to both transient and permanent failures. + /// + /// NB: The server serializes its closed `FrontendFailureCategory` here; we + /// deserialize with the api-safe type so new server variants can't kill + /// the client. + pub maybe_failure_category: Option, + + /// This is an integer number between 0 and 100 (both inclusive) that + /// reports the completeness. + pub progress_percentage: u8, +} + +/// Details about the completed result (if any). +#[derive(Serialize, Deserialize)] +pub struct JobStatusResultDetails { + pub entity_type: String, + pub entity_token: String, + + /// (DEPRECATED) URL path to the media file. + /// This field doesn't point to the full URL. Use media_links instead to leverage the CDN. + pub maybe_public_bucket_media_path: Option, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + pub maybe_successfully_completed_at: Option>, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn url_path_includes_token() { + let token = InferenceJobToken::new_from_str("jinf_abc123"); + assert_eq!(get_job_status_url_path(&token), "/v1/jobs/job/jinf_abc123"); + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/jobs/list_session_jobs.rs b/crates/api_clients/artcraft_client/src/api_defs/jobs/list_session_jobs.rs new file mode 100644 index 00000000..9f246f18 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/jobs/list_session_jobs.rs @@ -0,0 +1,141 @@ +use crate::api_defs::common::responses::job_details::{JobDetailsLipsyncRequest, JobDetailsLivePortraitRequest}; +use crate::api_defs::common::responses::media_links::MediaLinks; +use chrono::{DateTime, Utc}; +use crate::enums::api_safe::by_table::generic_inference_jobs::frontend_failure_category_for_api_clients::FrontendFailureCategoryForApiClients; +use crate::enums::api_safe::by_table::generic_inference_jobs::frontend_failure_category_for_old_clients::FrontendFailureCategoryForOldClients; +use crate::enums::by_table::generic_inference_jobs::inference_category::InferenceCategory; +use crate::enums::common::job_status_plus::JobStatusPlus; +use crate::enums::no_table::style_transfer::style_transfer_name::StyleTransferName; +use serde::Deserialize; +use serde::Serialize; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +pub const LIST_SESSION_JOBS_URL_PATH: &str = "/v1/jobs/session"; + +#[derive(Deserialize)] +pub struct ListSessionJobsQueryParams { + //pub sort_ascending: Option, + //pub page_size: Option, // TODO(bt,2024-04-23): One page for now. + //pub page_index: Option, // TODO(bt,2024-04-23): One page for now. + + /// NB: This can be one (or more comma-separated values) from `JobStatusPlus`. + /// ?include_states=pending or ?include_states=pending,started,complete_success (etc.) + pub include_states: Option, + + /// The opposite of include_states, this filters out states from view. + pub exclude_states: Option, + + // TODO(bt,2024-04-23): Add the ability for users to dismiss completed/dead jobs from view. +} +#[derive(Serialize, Deserialize)] +pub struct ListSessionJobsSuccessResponse { + pub success: bool, + + /// This is not paginated and is limited to showing 100 jobs. + pub jobs: Vec, +} + +#[derive(Serialize, Deserialize)] +pub struct ListSessionJobsItem { + pub job_token: InferenceJobToken, + + pub request: ListSessionRequestDetailsResponse, + pub status: ListSessionStatusDetailsResponse, + pub maybe_result: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, +} + +/// Details about what the user requested for generation +#[derive(Serialize, Deserialize)] +pub struct ListSessionRequestDetailsResponse { + pub inference_category: InferenceCategory, + + pub maybe_prompt_token: Option, + + pub maybe_model_type: Option, + pub maybe_model_token: Option, + + /// OPTIONAL. Title of the model, if it has one + pub maybe_model_title: Option, + + /// OPTIONAL. If the result was TTS, this is the raw inference text. + pub maybe_raw_inference_text: Option, + + /// OPTIONAL. For Comfy / Video Style Transfer jobs, this might include + /// the name of the selected style. + pub maybe_style_name: Option, + + /// OPTIONAL. For Live Portrait jobs, this is additional information on the request. + pub maybe_live_portrait_details: Option, + + /// OPTIONAL. For lipsync jobs (face fusion and sad talker), this is additional + /// information on the request. + pub maybe_lipsync_details: Option, +} + +/// Details about the ongoing job status +#[derive(Serialize, Deserialize)] +pub struct ListSessionStatusDetailsResponse { + /// Primary status from the database (a state machine). + pub status: JobStatusPlus, + + /// Extra, temporary status from Redis. + /// This can denote inference progress, and the Python code can write to it. + pub maybe_extra_status_description: Option, + + pub maybe_assigned_worker: Option, + pub maybe_assigned_cluster: Option, + + pub maybe_first_started_at: Option>, + + /// If the job is currently running, this is how long it has been running in seconds. + /// This is heuristic estimate since we don't record the precise start time across runs. + pub maybe_current_execution_duration_seconds: Option, + + pub attempt_count: u8, + + /// Whether the frontend needs to maintain a keepalive check. + /// This is typically only for non-premium users. + pub requires_keepalive: bool, + + /// NB: DO NOT CHANGE: Old clients can't read the new enum payload values as they are introduced. + /// + /// An enum the frontend can use to display localized/I18N error + /// messages. These pertain to both transient and permanent failures. + #[deprecated(note="use maybe_failure_category_updated")] + pub maybe_failure_category: Option, + + /// An enum the frontend can use to display localized/I18N error + /// messages. These pertain to both transient and permanent failures. + pub maybe_failure_category_updated: Option, + + /// User-facing failure messages + pub maybe_failure_message: Option, + + /// This is an integer number between 0 and 100 (both inclusive) that + /// reports the completeness. + pub progress_percentage: u8, +} + +/// Details about the completed result (if any) +#[derive(Serialize, Deserialize)] +pub struct ListSessionResultDetailsResponse { + pub entity_type: String, + pub entity_token: String, + + /// If generated as part of a batch, the batch token. + pub maybe_batch_token: Option, + + /// (DEPRECATED) URL path to the media file + #[deprecated(note="This field doesn't point to the full URL. Use media_links instead to leverage the CDN.")] + pub maybe_public_bucket_media_path: Option, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + pub maybe_successfully_completed_at: Option>, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/jobs/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/jobs/mod.rs new file mode 100644 index 00000000..fc5d2f18 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/jobs/mod.rs @@ -0,0 +1,3 @@ +pub mod batch_get_job_status; +pub mod get_job_status; +pub mod list_session_jobs; diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/delete_media_file.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/delete_media_file.rs new file mode 100644 index 00000000..37da173b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/delete_media_file.rs @@ -0,0 +1,18 @@ +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +#[derive(Serialize, Deserialize)] +pub struct DeleteMediaFileRequest { + pub set_delete: bool, + + /// NB: this is only to disambiguate when a user is both a mod and an author. + pub as_mod: Option, +} + +/// For the URL PathInfo +#[derive(Serialize, Deserialize)] +pub struct DeleteMediaFilePathInfo { + pub token: MediaFileToken, +} + + diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_common.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_common.rs new file mode 100644 index 00000000..c123873e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_common.rs @@ -0,0 +1,63 @@ +//! Shared types for the by-class session media file list endpoints +//! (`/v1/media_files/mesh/list`, `/v1/media_files/splat/list`). + +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::enums::by_table::media_files::media_file_type::MediaFileType; +use crate::enums::common::visibility::Visibility; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +use crate::api_defs::common::responses::media_file_cover_image_details::MediaFileCoverImageDetails; +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::api_defs::common::responses::user_details_light::UserDetailsLight; + +/// Query string parameters for the by-class session media file lists. +/// Pagination only — the media class is fixed by the endpoint. +#[derive(Deserialize)] +pub struct ListSessionMediaFilesByTypeQueryParams { + pub sort_ascending: Option, + pub page_size: Option, + pub cursor: Option, + pub cursor_is_reversed: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct SessionMediaFileInfo { + /// Primary key identifier + pub token: MediaFileToken, + + /// The coarse-grained class of media file. + /// Fixed per endpoint (`mesh` or `splat`). + pub media_class: MediaFileClass, + + /// Type of media will dictate which fields are populated and what + /// the frontend should display (eg. video player vs audio player). + /// This is closer in meaning to a "mime type". + pub media_type: MediaFileType, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + /// Information about the cover image. Many media files do not require a cover image, + /// e.g. image files, video files with thumbnails, audio files, etc. + /// 3D files require them. + pub cover_image: MediaFileCoverImageDetails, + + /// User info + pub maybe_creator_user: Option, + + pub creator_set_visibility: Visibility, + + /// The generation's prompt record, when there is one. Clients resolve it + /// to display the original prompt and model. + pub maybe_prompt_token: Option, + + /// The name or title of the media file (optional) + pub maybe_title: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_mesh_media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_mesh_media_files.rs new file mode 100644 index 00000000..f9c6732a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_mesh_media_files.rs @@ -0,0 +1,13 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::common::responses::pagination_cursors::PaginationCursors; +use crate::api_defs::media_file::list::by_type::list_session_common::SessionMediaFileInfo; + +pub const LIST_SESSION_MESH_MEDIA_FILES_URL_PATH: &str = "/v1/media_files/mesh/list"; + +#[derive(Serialize, Deserialize)] +pub struct ListSessionMeshMediaFilesSuccessResponse { + pub success: bool, + pub results: Vec, + pub pagination: PaginationCursors, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_splat_media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_splat_media_files.rs new file mode 100644 index 00000000..9fbc143b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/list_session_splat_media_files.rs @@ -0,0 +1,13 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::common::responses::pagination_cursors::PaginationCursors; +use crate::api_defs::media_file::list::by_type::list_session_common::SessionMediaFileInfo; + +pub const LIST_SESSION_SPLAT_MEDIA_FILES_URL_PATH: &str = "/v1/media_files/splat/list"; + +#[derive(Serialize, Deserialize)] +pub struct ListSessionSplatMediaFilesSuccessResponse { + pub success: bool, + pub results: Vec, + pub pagination: PaginationCursors, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/mod.rs new file mode 100644 index 00000000..458c52ac --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/by_type/mod.rs @@ -0,0 +1,3 @@ +pub mod list_session_common; +pub mod list_session_mesh_media_files; +pub mod list_session_splat_media_files; diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/mod.rs new file mode 100644 index 00000000..d7d55e66 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list/mod.rs @@ -0,0 +1 @@ +pub mod by_type; diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list_batch_generated_media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list_batch_generated_media_files.rs new file mode 100644 index 00000000..5e66bd78 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list_batch_generated_media_files.rs @@ -0,0 +1,76 @@ +use crate::api_defs::common::responses::media_file_cover_image_details::MediaFileCoverImageDetails; +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::api_defs::common::responses::user_details_light::UserDetailsLight; +use chrono::{DateTime, Utc}; +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::enums::by_table::media_files::media_file_type::MediaFileType; +use crate::enums::common::visibility::Visibility; +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +pub const LIST_BATCH_GENERATED_REDUX_MEDIA_FILES_URL_PATH: &str = "/v1/media_files/batch_gen_redux"; + +/// For the URL PathInfo +#[derive(Serialize, Deserialize)] +pub struct ListBatchGeneratedReduxMediaFilesPathInfo { + pub token: BatchGenerationToken, +} + +#[derive(Serialize, Deserialize)] +pub struct ListBatchGeneratedReduxMediaFilesSuccessResponse { + pub success: bool, + pub media_files: Vec, +} + +#[derive(Serialize, Deserialize)] +pub struct BatchGeneratedReduxMediaFileInfo { + /// Primary key identifier + pub token: MediaFileToken, + + /// The coarse-grained class of media file: image, video, etc. + pub media_class: MediaFileClass, + + /// Type of media will dictate which fields are populated and what + /// the frontend should display (e.g. video player vs audio player). + /// This is closer in meaning to a "mime type". + pub media_type: MediaFileType, + + /// If the file was generated as part of a batch, this is the token for the batch. + pub maybe_batch_token: Option, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + /// Information about the cover image. Many media files do not require a cover image, + /// e.g. image files, video files with thumbnails, audio files, etc. + /// 3D files require them. + pub cover_image: MediaFileCoverImageDetails, + + /// User info. + pub maybe_creator_user: Option, + + /// File visibility. + pub creator_set_visibility: Visibility, + + /// The foreign key to the prompt used to generate the media, if applicable. + pub maybe_prompt_token: Option, + + /// The name or title of the media file (optional) + pub maybe_title: Option, + + /// The original filename for uploaded files, if they were provided. + /// In the future we'll provide our own internal optional filenames. + pub maybe_original_filename: Option, + + /// Duration for audio and video files, if available. + /// Measured in milliseconds. + pub maybe_duration_millis: Option, + + /// Created timestamp + pub created_at: DateTime, + + /// Updated timestamp + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list_media_files_by_job.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list_media_files_by_job.rs new file mode 100644 index 00000000..911c7f07 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list_media_files_by_job.rs @@ -0,0 +1,86 @@ +//! Types for `GET /v1/media_files/by_job/{job_token}` — list the media files +//! produced by an inference job. +//! +//! Mirrors storyteller-web's `list_media_files_by_job_handler`. Requires an +//! authenticated session; the server only returns files from the caller's +//! own jobs (other users' jobs and unknown tokens return an empty list). + +use chrono::{DateTime, Utc}; +use serde::Deserialize; +use serde::Serialize; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +use crate::api_defs::common::responses::media_file_cover_image_details::MediaFileCoverImageDetails; +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::enums::by_table::media_files::media_file_type::MediaFileType; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +pub const LIST_MEDIA_FILES_BY_JOB_URL_PATH_PREFIX: &str = "/v1/media_files/by_job"; + +/// Build the request path for a job's media files. +pub fn list_media_files_by_job_url_path(job_token: &InferenceJobToken) -> String { + format!("{}/{}", LIST_MEDIA_FILES_BY_JOB_URL_PATH_PREFIX, job_token.as_str()) +} + +#[derive(Serialize, Deserialize)] +pub struct ListMediaFilesByJobSuccessResponse { + pub success: bool, + + /// The job's output files, oldest first. + pub media_files: Vec, +} + +#[derive(Serialize, Deserialize)] +pub struct JobMediaFileInfo { + pub token: MediaFileToken, + + /// The coarse-grained class of media file: image, video, etc. + pub media_class: MediaFileClass, + + /// Type of media will dictate which fields are populated and what + /// the frontend should display (eg. video player vs audio player). + /// This is closer in meaning to a "mime type". + pub media_type: MediaFileType, + + /// If the file was generated as part of a batch, this is the token for the batch. + pub maybe_batch_token: Option, + + /// The foreign key to the prompt used to generate the media, if applicable. + pub maybe_prompt_token: Option, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + /// Information about the cover image. Many media files do not require a cover image, + /// e.g. image files, video files with thumbnails, audio files, etc. + /// 3D files require them. + pub cover_image: MediaFileCoverImageDetails, + + /// The original filename for uploaded files, if they were provided. + /// In the future we'll provide our own internal optional filenames. + pub maybe_original_filename: Option, + + /// Duration for audio and video files, if available. + /// Measured in milliseconds. + pub maybe_duration_millis: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn url_path_includes_token() { + let token = InferenceJobToken::new_from_str("jinf_abc123"); + assert_eq!( + list_media_files_by_job_url_path(&token), + "/v1/media_files/by_job/jinf_abc123", + ); + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/list_session_project_media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/list_session_project_media_files.rs new file mode 100644 index 00000000..3b7ba22a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/list_session_project_media_files.rs @@ -0,0 +1,77 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::enums::by_table::media_files::media_file_project_type::MediaFileProjectType; +use crate::enums::by_table::media_files::media_file_type::MediaFileType; +use crate::enums::common::visibility::Visibility; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::common::responses::media_file_cover_image_details::MediaFileCoverImageDetails; +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::api_defs::common::responses::pagination_cursors::PaginationCursors; +use crate::api_defs::common::responses::user_details_light::UserDetailsLight; + +pub const LIST_SESSION_PROJECT_MEDIA_FILES_URL_PATH: &str = "/v1/media_files/project/list"; + +/// Query string parameters for listing the session user's project files. +#[derive(Deserialize)] +pub struct ListSessionProjectMediaFilesQueryParams { + pub sort_ascending: Option, + pub page_size: Option, + pub cursor: Option, + pub cursor_is_reversed: Option, + + /// Optional filter on the specific project document type. + /// + /// Usage: + /// - `?filter_project_type=scene_3d` + /// - `?filter_project_type=mood_board` + /// - `?filter_project_type=workflow` + /// - `?filter_project_type=video_timeline` + pub filter_project_type: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct ListSessionProjectMediaFilesSuccessResponse { + pub success: bool, + pub results: Vec, + pub pagination: PaginationCursors, +} + +#[derive(Serialize, Deserialize)] +pub struct ProjectMediaFileInfo { + /// Primary key identifier + pub token: MediaFileToken, + + /// The coarse-grained class of media file. + /// Always `project` for this endpoint. + pub media_class: MediaFileClass, + + /// The specific kind of project document: 3D scene, mood board, etc. + pub project_type: MediaFileProjectType, + + /// Type of media will dictate which fields are populated and what + /// the frontend should display (eg. video player vs audio player). + /// This is closer in meaning to a "mime type". + pub media_type: MediaFileType, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + /// Information about the cover image. Many media files do not require a cover image, + /// e.g. image files, video files with thumbnails, audio files, etc. + /// 3D files require them. + pub cover_image: MediaFileCoverImageDetails, + + /// User info + pub maybe_creator_user: Option, + + pub creator_set_visibility: Visibility, + + /// The name or title of the media file (optional) + pub maybe_title: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/mod.rs new file mode 100644 index 00000000..b8b70053 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/mod.rs @@ -0,0 +1,6 @@ +pub mod delete_media_file; +pub mod list; +pub mod list_batch_generated_media_files; +pub mod list_media_files_by_job; +pub mod list_session_project_media_files; +pub mod project; diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/mod.rs new file mode 100644 index 00000000..0ebb463e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/mod.rs @@ -0,0 +1,8 @@ +pub mod upload_new_editor_2d_project; +pub mod upload_new_mood_board_project; +pub mod upload_new_scene_3d_project; +pub mod upload_new_video_timeline_project; +pub mod upload_updated_editor_2d_project; +pub mod upload_updated_mood_board_project; +pub mod upload_updated_scene_3d_project; +pub mod upload_updated_video_timeline_project; diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_editor_2d_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_editor_2d_project.rs new file mode 100644 index 00000000..d9b76fdf --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_editor_2d_project.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_NEW_EDITOR_2D_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/editor_2d/new"; + +/// Response for saving a new 2D editor document project. +#[derive(Serialize, Deserialize)] +pub struct UploadNewEditor2dProjectSuccessResponse { + pub success: bool, + + /// Token for the newly created project media file. Use it to query the + /// project and to save subsequent updates via the update endpoint. + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_mood_board_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_mood_board_project.rs new file mode 100644 index 00000000..55afe704 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_mood_board_project.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_NEW_MOOD_BOARD_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/mood_board/new"; + +/// Response for saving a new mood board project. +#[derive(Serialize, Deserialize)] +pub struct UploadNewMoodBoardProjectSuccessResponse { + pub success: bool, + + /// Token for the newly created project media file. Use it to query the + /// project and to save subsequent updates via the update endpoint. + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_scene_3d_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_scene_3d_project.rs new file mode 100644 index 00000000..d4cfd623 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_scene_3d_project.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_NEW_SCENE_3D_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/scene_3d/new"; + +/// Response for saving a new 3D scene project. +#[derive(Serialize, Deserialize)] +pub struct UploadNewScene3dProjectSuccessResponse { + pub success: bool, + + /// Token for the newly created project media file. Use it to query the + /// project and to save subsequent updates via the update endpoint. + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_video_timeline_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_video_timeline_project.rs new file mode 100644 index 00000000..70d4e0e1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_new_video_timeline_project.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_NEW_VIDEO_TIMELINE_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/video_timeline/new"; + +/// Response for saving a new video editor timeline project. +#[derive(Serialize, Deserialize)] +pub struct UploadNewVideoTimelineProjectSuccessResponse { + pub success: bool, + + /// Token for the newly created project media file. Use it to query the + /// project and to save subsequent updates via the update endpoint. + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_editor_2d_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_editor_2d_project.rs new file mode 100644 index 00000000..998ba789 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_editor_2d_project.rs @@ -0,0 +1,20 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_UPDATED_EDITOR_2D_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/editor_2d/update/{token}"; + +/// For the URL PathInfo +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedEditor2dProjectPathInfo { + pub token: MediaFileToken, +} + +/// Response for overwriting an existing 2D editor project. +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedEditor2dProjectSuccessResponse { + pub success: bool, + + /// Token of the updated project media file (unchanged by the update). + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_mood_board_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_mood_board_project.rs new file mode 100644 index 00000000..997c60f1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_mood_board_project.rs @@ -0,0 +1,20 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_UPDATED_MOOD_BOARD_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/mood_board/update/{token}"; + +/// For the URL PathInfo +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedMoodBoardProjectPathInfo { + pub token: MediaFileToken, +} + +/// Response for overwriting an existing mood board project. +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedMoodBoardProjectSuccessResponse { + pub success: bool, + + /// Token of the updated project media file (unchanged by the update). + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_scene_3d_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_scene_3d_project.rs new file mode 100644 index 00000000..6197f391 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_scene_3d_project.rs @@ -0,0 +1,20 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_UPDATED_SCENE_3D_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/scene_3d/update/{token}"; + +/// For the URL PathInfo +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedScene3dProjectPathInfo { + pub token: MediaFileToken, +} + +/// Response for overwriting an existing 3D scene project. +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedScene3dProjectSuccessResponse { + pub success: bool, + + /// Token of the updated project media file (unchanged by the update). + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_video_timeline_project.rs b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_video_timeline_project.rs new file mode 100644 index 00000000..f1ffb820 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/media_file/project/upload_updated_video_timeline_project.rs @@ -0,0 +1,20 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub const UPLOAD_UPDATED_VIDEO_TIMELINE_PROJECT_URL_PATH: &str = "/v1/media_files/upload/project/video_timeline/update/{token}"; + +/// For the URL PathInfo +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedVideoTimelineProjectPathInfo { + pub token: MediaFileToken, +} + +/// Response for overwriting an existing video editor timeline project. +#[derive(Serialize, Deserialize)] +pub struct UploadUpdatedVideoTimelineProjectSuccessResponse { + pub success: bool, + + /// Token of the updated project media file (unchanged by the update). + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/mod.rs new file mode 100644 index 00000000..40491ffb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/mod.rs @@ -0,0 +1,20 @@ +pub mod analytics; +pub mod api_keys; +pub mod characters; +pub mod common; +pub mod credits; +pub mod folders; +pub mod generate; +pub mod jobs; +pub mod media_file; +pub mod moderation; +pub mod omni_gen; +pub mod prompts; +pub mod stripe_artcraft; +pub mod subscriptions; +pub mod tags; +pub mod user_referral_codes; +pub mod users; +pub mod utils; +pub mod video_info; +pub mod web_referrals; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/alerts/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/alerts/mod.rs new file mode 100644 index 00000000..4970ea62 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/alerts/mod.rs @@ -0,0 +1 @@ +pub mod moderation_send_alert; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/alerts/moderation_send_alert.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/alerts/moderation_send_alert.rs new file mode 100644 index 00000000..e2cff259 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/alerts/moderation_send_alert.rs @@ -0,0 +1,28 @@ +use serde_derive::{Deserialize, Serialize}; + +pub const MODERATION_SEND_ALERT_PATH: &str = "/v1/moderation/alerts/send"; + +#[derive(Deserialize)] +pub struct ModerationSendAlertRequest { + /// Optional title for the alert. Defaults to "Test Moderation Alert". + pub title: Option, + + /// Optional description for the alert. Defaults to "This is a test moderation alert." + pub description: Option, + + /// Optional urgency of the page. + pub urgency: Option, +} + +#[derive(Deserialize, Copy, Clone, Debug)] +#[serde(rename_all = "snake_case")] +pub enum ModerationSendAlertUrgency { + High, + Medium, + Low, +} + +#[derive(Serialize)] +pub struct ModerationSendAlertResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/debug_log_entry.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/debug_log_entry.rs new file mode 100644 index 00000000..809d552d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/debug_log_entry.rs @@ -0,0 +1,35 @@ +use chrono::{DateTime, Utc}; +use serde_derive::Serialize; + +use crate::enums::by_table::debug_logs::debug_log_level::DebugLogLevel; +use crate::enums::by_table::debug_logs::debug_log_type::DebugLogType; +use crate::tokens::non_unique::debug_logs_event_token::DebugLogEventToken; +use crate::tokens::users::UserToken; + +/// A single debug log row. +/// Shared by the moderation debug-log list endpoints. +#[derive(Serialize)] +pub struct ModerationDebugLogEntry { + pub id: u64, + pub event_token: DebugLogEventToken, + pub debug_log_type: DebugLogType, + pub maybe_log_level: Option, + pub maybe_creator_user_token: Option, + /// The client IP address of the request (if recorded). + pub maybe_ip_address: Option, + /// The request URL (if recorded; truncated to 255 chars). + pub maybe_url: Option, + pub message: String, + pub created_at: DateTime, + /// The creator user, joined in when the row has a user token. + pub maybe_user: Option, +} + +/// The creator user of a debug log row. +#[derive(Serialize)] +pub struct ModerationDebugLogUser { + pub user_token: UserToken, + pub display_name: String, + pub username: String, + pub gravatar_hash: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/mod.rs new file mode 100644 index 00000000..e8e6926c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/mod.rs @@ -0,0 +1,4 @@ +pub mod debug_log_entry; +pub mod moderation_list_all_debug_logs; +pub mod moderation_list_debug_logs_for_token; +pub mod moderation_list_debug_logs_for_user; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_all_debug_logs.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_all_debug_logs.rs new file mode 100644 index 00000000..b8071a9a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_all_debug_logs.rs @@ -0,0 +1,75 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::by_table::debug_logs::debug_log_level::DebugLogLevel; +use crate::enums::by_table::debug_logs::debug_log_type::DebugLogType; +use crate::enums::error::enum_error::EnumError; +use crate::tokens::non_unique::debug_logs_event_token::DebugLogEventToken; +use crate::tokens::users::UserToken; + +use crate::api_defs::moderation::debug_logs::debug_log_entry::ModerationDebugLogUser; + +pub const MODERATION_LIST_ALL_DEBUG_LOGS_PATH: &str = "/v1/moderation/debug_logs/list_all"; + +// ── Query params ── + +#[derive(Deserialize)] +pub struct ModerationListAllDebugLogsQueryParams { + /// Optional comma-separated list of severity levels to include, + /// eg. `severities=error,warn`. Omit to include all rows. + pub severities: Option, + + /// Cursor for pagination. Pass the `next_cursor` from a previous response. + pub cursor: Option, + + /// Max rows per page (default 50, max 200). + pub limit: Option, +} + +impl ModerationListAllDebugLogsQueryParams { + /// Parse the comma-separated `severities` parameter. + /// Returns `None` when the parameter is absent or empty. + pub fn parsed_severities(&self) -> Result>, EnumError> { + let raw = match self.severities.as_deref() { + Some(value) if !value.trim().is_empty() => value, + _ => return Ok(None), + }; + + let levels = raw + .split(',') + .map(str::trim) + .filter(|part| !part.is_empty()) + .map(DebugLogLevel::from_str) + .collect::, EnumError>>()?; + + Ok(if levels.is_empty() { None } else { Some(levels) }) + } +} + +// ── Response ── + +#[derive(Serialize)] +pub struct ModerationListAllDebugLogsSuccessResponse { + pub success: bool, + /// Most recent first. + pub debug_logs: Vec, + /// Cursor for the next page. `None` if there are no more results. + pub next_cursor: Option, +} + +/// A debug log row with the creator user joined in (when one exists). +#[derive(Serialize)] +pub struct ModerationListAllDebugLogsEntry { + pub id: u64, + pub event_token: DebugLogEventToken, + pub debug_log_type: DebugLogType, + pub maybe_log_level: Option, + pub maybe_creator_user_token: Option, + /// The client IP address of the request (if recorded). + pub maybe_ip_address: Option, + /// The request URL (if recorded; truncated to 255 chars). + pub maybe_url: Option, + pub message: String, + pub created_at: DateTime, + pub maybe_user: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_debug_logs_for_token.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_debug_logs_for_token.rs new file mode 100644 index 00000000..cc029d1c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_debug_logs_for_token.rs @@ -0,0 +1,29 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::non_unique::debug_logs_event_token::DebugLogEventToken; + +use crate::api_defs::moderation::debug_logs::debug_log_entry::ModerationDebugLogEntry; + +pub const MODERATION_LIST_DEBUG_LOGS_FOR_TOKEN_PATH: &str = "/v1/moderation/debug_logs/list/{token}"; + +// ── Path params ── + +#[derive(Deserialize)] +pub struct ModerationListDebugLogsForTokenPathInfo { + pub token: DebugLogEventToken, +} + +// ── Query params ── + +#[derive(Deserialize)] +pub struct ModerationListDebugLogsForTokenQueryParams { + pub limit: Option, +} + +// ── Response ── + +#[derive(Serialize)] +pub struct ModerationListDebugLogsForTokenSuccessResponse { + pub success: bool, + pub debug_logs: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_debug_logs_for_user.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_debug_logs_for_user.rs new file mode 100644 index 00000000..4ffdee4c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/debug_logs/moderation_list_debug_logs_for_user.rs @@ -0,0 +1,36 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::users::UserToken; + +use crate::api_defs::moderation::debug_logs::debug_log_entry::ModerationDebugLogEntry; + +pub const MODERATION_LIST_DEBUG_LOGS_FOR_USER_PATH: &str = "/v1/moderation/debug_logs/user_list/{user_token}"; + +// ── Path params ── + +#[derive(Deserialize)] +pub struct ModerationListDebugLogsForUserPathInfo { + pub user_token: UserToken, +} + +// ── Query params ── + +#[derive(Deserialize)] +pub struct ModerationListDebugLogsForUserQueryParams { + /// Cursor for pagination. Pass the `next_cursor` from a previous response. + pub cursor: Option, + + /// Max rows per page (default 50, max 200). + pub limit: Option, +} + +// ── Response ── + +#[derive(Serialize)] +pub struct ModerationListDebugLogsForUserSuccessResponse { + pub success: bool, + /// Most recent first. + pub debug_logs: Vec, + /// Cursor for the next page. `None` if there are no more results. + pub next_cursor: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/mod.rs new file mode 100644 index 00000000..22d12a38 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/mod.rs @@ -0,0 +1 @@ +pub mod user; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/user/list_user_jobs.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/user/list_user_jobs.rs new file mode 100644 index 00000000..8eb8fc12 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/user/list_user_jobs.rs @@ -0,0 +1,38 @@ +use chrono::{DateTime, Utc}; +use crate::enums::by_table::generic_inference_jobs::inference_job_external_third_party::InferenceJobExternalThirdParty; +use crate::enums::by_table::wallet_ledger_entries::wallet_ledger_entry_type::WalletLedgerEntryType; +use crate::enums::common::job_status_plus::JobStatusPlus; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::users::UserToken; +use crate::tokens::wallet_ledger_entries::WalletLedgerEntryToken; + +pub const LIST_USER_JOBS_PATH: &str = "/v1/moderation/jobs/user/{user_token}/list"; + +#[derive(Deserialize)] +pub struct ListUserJobsPathInfo { + pub user_token: UserToken, +} + +#[derive(Serialize)] +pub struct ListUserJobsResponse { + pub success: bool, + pub jobs: Vec, +} + +#[derive(Serialize)] +pub struct ListUserJobsEntry { + pub job_status: JobStatusPlus, + pub job_failure_reason: Option, + pub credits_delta: Option, + pub maybe_linked_refund_ledger_token: Option, + pub on_success_result_media_token: Option, + pub job_token: InferenceJobToken, + pub wallet_ledger_entry_token: Option, + pub wallet_ledger_entry_type: Option, + pub maybe_external_third_party: Option, + pub maybe_external_third_party_id: Option, + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/user/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/user/mod.rs new file mode 100644 index 00000000..084446e8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/jobs/user/mod.rs @@ -0,0 +1 @@ +pub mod list_user_jobs; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/mod.rs new file mode 100644 index 00000000..154098c1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/mod.rs @@ -0,0 +1,12 @@ +pub mod alerts; +pub mod debug_logs; +pub mod top_spenders; +pub mod jobs; +pub mod user; +pub mod user_referrals; +pub mod user_stripe_data; +pub mod wallet_ledger_entries; +pub mod wallets; +pub mod user_daily_spends; +pub mod user_spend_summaries; +pub mod user_spend_events; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/top_spenders/list.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/top_spenders/list.rs new file mode 100644 index 00000000..b9e2bbae --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/top_spenders/list.rs @@ -0,0 +1,81 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_LIST_TOP_SPENDERS_PATH: &str = + "/v1/moderation/top_spenders/list"; + +/// Rolling aggregation window for the top spenders list. +#[derive(Deserialize, Serialize, Clone, Copy)] +pub enum TopSpendersWindow { + #[serde(rename = "24h")] + TwentyFourHours, + #[serde(rename = "7d")] + SevenDays, + #[serde(rename = "14d")] + FourteenDays, + #[serde(rename = "30d")] + ThirtyDays, + #[serde(rename = "60d")] + SixtyDays, + #[serde(rename = "90d")] + NinetyDays, + #[serde(rename = "180d")] + OneHundredEightyDays, + #[serde(rename = "365d")] + ThreeHundredSixtyFiveDays, +} + +impl TopSpendersWindow { + /// Window length in hours. + pub fn as_hours(self) -> i64 { + match self { + TopSpendersWindow::TwentyFourHours => 24, + TopSpendersWindow::SevenDays => 7 * 24, + TopSpendersWindow::FourteenDays => 14 * 24, + TopSpendersWindow::ThirtyDays => 30 * 24, + TopSpendersWindow::SixtyDays => 60 * 24, + TopSpendersWindow::NinetyDays => 90 * 24, + TopSpendersWindow::OneHundredEightyDays => 180 * 24, + TopSpendersWindow::ThreeHundredSixtyFiveDays => 365 * 24, + } + } +} + +#[derive(Deserialize)] +pub struct ModeratorListTopSpendersQueryParams { + /// Aggregation window: `24h`, `7d`, `14d`, `30d` (default), `60d`, `90d`, + /// `180d`, or `365d`. + pub window: Option, + /// Row offset for pagination (page size is fixed at 100). Pass `next_offset` from the previous page. + pub offset: Option, + /// Optional namespace filter (e.g. `artcraft`). Omit to return all namespaces. + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorListTopSpendersResponse { + pub success: bool, + /// The window the results were aggregated over (echoed back, post-default). + pub window: TopSpendersWindow, + pub spenders: Vec, + /// Offset for the next page, or `None` if this was the last page. + pub maybe_next_offset: Option, +} + +#[derive(Serialize)] +pub struct TopSpenderEntry { + pub user_token: UserToken, + pub username: String, + pub display_name: String, + pub email_gravatar_hash: String, + /// Sum of positive amounts in the window. + pub gross_spend_usd_cents: u64, + /// Refund/chargeback magnitude in the window (positive number). + pub refund_usd_cents: u64, + /// Gross minus refunds. Can be negative if refunds outweigh purchases. + pub net_spend_usd_cents: i64, + /// Number of positive money events in the window. + pub payment_count: u64, + /// Credits granted in the window. + pub credits_granted: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/top_spenders/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/top_spenders/mod.rs new file mode 100644 index 00000000..d17e233f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/top_spenders/mod.rs @@ -0,0 +1 @@ +pub mod list; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user/list_subscribing_users_by_signup_date.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/list_subscribing_users_by_signup_date.rs new file mode 100644 index 00000000..5642e2e7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/list_subscribing_users_by_signup_date.rs @@ -0,0 +1,54 @@ +use chrono::{DateTime, Utc}; +use crate::enums::by_table::users::user_signup_method::UserSignupMethod; +use crate::enums::by_table::users::user_signup_source::UserSignupSource; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_LIST_SUBSCRIBING_USERS_BY_SIGNUP_DATE_PATH: &str = "/v1/moderation/users/list_subscribers_by_signup_date"; + +#[derive(Deserialize)] +pub struct ModeratorListSubscribingUsersBySignupDateRequest { + /// Optional cursor for pagination. Pass the `next_cursor` from a previous response. + pub id_cursor: Option, +} + +#[derive(Serialize)] +pub struct ModeratorListSubscribingUsersBySignupDateResponse { + pub success: bool, + pub users: Vec, + /// The cursor for the next page. `None` if there are no more results. + pub next_cursor: Option, +} + +#[derive(Serialize)] +pub struct ModeratorListSubscribingUsersBySignupDateEntry { + // -- User fields -- + pub id: u64, + pub token: UserToken, + pub username: String, + pub display_name: String, + pub username_is_not_customized: bool, + pub email_address: String, + pub email_confirmed: bool, + pub is_without_password: bool, + pub ip_address_creation: String, + pub maybe_source: Option, + pub maybe_signup_method: Option, + pub created_at: DateTime, + pub maybe_referral_url: Option, + pub is_temporary: bool, + + // TODO: Use enum types/strong types - + // -- Subscription fields -- + pub subscription_namespace: String, + pub subscription_product_slug: String, + pub maybe_stripe_subscription_id: Option, + pub maybe_stripe_customer_id: Option, + pub maybe_stripe_product_id: Option, + pub maybe_stripe_price_id: Option, + pub maybe_stripe_subscription_status: Option, + pub maybe_stripe_recurring_interval: Option, + pub maybe_stripe_invoice_is_paid: Option, + pub maybe_cancel_at: Option>, + pub maybe_canceled_at: Option>, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user/list_users_by_signup_date.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/list_users_by_signup_date.rs new file mode 100644 index 00000000..ce04d28f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/list_users_by_signup_date.rs @@ -0,0 +1,39 @@ +use chrono::{DateTime, Utc}; +use crate::enums::by_table::users::user_signup_method::UserSignupMethod; +use crate::enums::by_table::users::user_signup_source::UserSignupSource; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_LIST_USERS_BY_SIGNUP_DATE_PATH: &str = "/v1/moderation/users/list_all_by_signup_date"; + +#[derive(Deserialize)] +pub struct ModeratorListUsersBySignupDateRequest { + /// Optional cursor for pagination. Pass the `next_cursor` from a previous response. + pub id_cursor: Option, +} + +#[derive(Serialize)] +pub struct ModeratorListUsersBySignupDateResponse { + pub success: bool, + pub users: Vec, + /// The cursor for the next page. `None` if there are no more results. + pub next_cursor: Option, +} + +#[derive(Serialize)] +pub struct ModeratorListUsersBySignupDateEntry { + pub id: u64, + pub token: UserToken, + pub username: String, + pub display_name: String, + pub username_is_not_customized: bool, + pub email_address: String, + pub email_confirmed: bool, + pub is_without_password: bool, + pub ip_address_creation: String, + pub maybe_source: Option, + pub maybe_signup_method: Option, + pub created_at: DateTime, + pub maybe_referral_url: Option, + pub is_temporary: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/mod.rs new file mode 100644 index 00000000..56e6c757 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/mod.rs @@ -0,0 +1,4 @@ +pub mod list_subscribing_users_by_signup_date; +pub mod list_users_by_signup_date; +pub mod user_lookup; +pub mod user_lookup_by_stripe_customer_id; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user/user_lookup.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/user_lookup.rs new file mode 100644 index 00000000..a44bac5b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/user_lookup.rs @@ -0,0 +1,38 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::users::UserToken; + +pub const MODERATOR_USER_LOOKUP_PATH: &str = "/v1/moderation/users/lookup"; + +#[derive(Deserialize)] +pub struct ModeratorUserLookupRequest { + pub search: String, +} + +#[derive(Serialize)] +pub struct ModeratorUserLookupSuccessResponse { + pub success: bool, + pub maybe_user: Option, +} + +#[derive(Serialize)] +pub struct ModeratorUserLookupUserDetails { + pub token: UserToken, + pub username: String, + pub display_name: String, + pub username_is_generated: bool, + pub is_temporary: bool, + pub username_is_not_customized: bool, + pub email_address: String, + pub email_confirmed: bool, + pub email_is_synthetic: bool, + pub is_without_password: bool, + pub ip_address_creation: String, + pub ip_address_last_login: String, + pub maybe_avatar_media_file_token: Option, + pub email_gravatar_hash: String, + pub is_banned: bool, + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user/user_lookup_by_stripe_customer_id.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/user_lookup_by_stripe_customer_id.rs new file mode 100644 index 00000000..790cf059 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user/user_lookup_by_stripe_customer_id.rs @@ -0,0 +1,26 @@ +use crate::enums::common::payments_namespace::PaymentsNamespace; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_USER_LOOKUP_BY_STRIPE_CUSTOMER_ID_PATH: &str = "/v1/moderation/users/lookup_by_stripe_customer_id"; + +#[derive(Deserialize)] +pub struct ModeratorUserLookupByStripeCustomerIdRequest { + pub stripe_customer_id: String, +} + +#[derive(Serialize)] +pub struct ModeratorUserLookupByStripeCustomerIdResponse { + pub success: bool, + pub users: Vec, +} + +#[derive(Serialize)] +pub struct ModeratorUserLookupByStripeCustomerIdEntry { + pub subscription_namespace: PaymentsNamespace, + pub maybe_stripe_subscription_id: Option, + pub token: UserToken, + pub email_address: String, + pub username: String, + pub display_name: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_daily_spends/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_daily_spends/mod.rs new file mode 100644 index 00000000..612b34b4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_daily_spends/mod.rs @@ -0,0 +1 @@ +pub mod user_daily_spends_list; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_daily_spends/user_daily_spends_list.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_daily_spends/user_daily_spends_list.rs new file mode 100644 index 00000000..8e3b6ab9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_daily_spends/user_daily_spends_list.rs @@ -0,0 +1,40 @@ +use chrono::{DateTime, NaiveDate, Utc}; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_USER_DAILY_SPENDS_PATH: &str = + "/v1/moderation/user_daily_spends/user/{user_token}"; + +#[derive(Deserialize)] +pub struct ModeratorUserDailySpendsQueryParams { + /// Page size (default 200, max 5000). + pub limit: Option, + /// Row offset for pagination. Pass `next_offset` from the previous page. + pub offset: Option, + /// Payments namespace. Defaults to `artcraft`. + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorUserDailySpendsResponse { + pub success: bool, + pub user_token: UserToken, + pub records: Vec, + /// Offset for the next page, or `None` if this was the last page. + pub maybe_next_offset: Option, +} + +#[derive(Serialize)] +pub struct UserDailySpendEntry { + pub payments_namespace: String, + pub spend_date: NaiveDate, + pub subscription_spend_usd_cents: u64, + pub credits_spend_usd_cents: u64, + pub gross_spend_usd_cents: u64, + pub refund_usd_cents: u64, + pub net_spend_usd_cents: i64, + pub payment_count: u32, + pub credits_granted: u64, + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/list_global_user_referrals.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/list_global_user_referrals.rs new file mode 100644 index 00000000..8b756558 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/list_global_user_referrals.rs @@ -0,0 +1,46 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::user_referral_codes::UserReferralCodeToken; +use crate::tokens::users::UserToken; + +// --- Request --- + +#[derive(Deserialize)] +pub struct ListGlobalUserReferralsQueryParams { + pub cursor: Option, + pub limit: Option, +} + +// --- Response --- + +#[derive(Serialize)] +pub struct ListGlobalUserReferralsSuccessResponse { + pub success: bool, + pub referrals: Vec, + pub maybe_cursor: Option, +} + +#[derive(Serialize)] +pub struct UserReferralResponse { + pub invited_user: InvitedUserDetails, + pub referrer_user: ReferrerUserDetails, + pub maybe_referral_code_token: Option, + pub maybe_referral_url: Option, + pub maybe_landing_url: Option, + pub created_at: DateTime, +} + +#[derive(Serialize)] +pub struct InvitedUserDetails { + pub token: UserToken, + pub username: String, + pub display_name: String, + pub email_address: String, +} + +#[derive(Serialize)] +pub struct ReferrerUserDetails { + pub token: UserToken, + pub username: String, + pub display_name: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/list_user_referrals_for_user.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/list_user_referrals_for_user.rs new file mode 100644 index 00000000..a38616b5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/list_user_referrals_for_user.rs @@ -0,0 +1,25 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::moderation::user_referrals::list_global_user_referrals::UserReferralResponse; + +// --- Request --- + +#[derive(Deserialize)] +pub struct ListUserReferralsForUserQueryParams { + pub cursor: Option, + pub limit: Option, +} + +#[derive(Deserialize)] +pub struct ListUserReferralsForUserPathInfo { + pub username: String, +} + +// --- Response --- + +#[derive(Serialize)] +pub struct ListUserReferralsForUserSuccessResponse { + pub success: bool, + pub referrals: Vec, + pub maybe_cursor: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/mod.rs new file mode 100644 index 00000000..3401f0ba --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_referrals/mod.rs @@ -0,0 +1,2 @@ +pub mod list_global_user_referrals; +pub mod list_user_referrals_for_user; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_events/list.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_events/list.rs new file mode 100644 index 00000000..f5b9fad8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_events/list.rs @@ -0,0 +1,45 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::user_spend_events::UserSpendEventToken; +use crate::tokens::users::UserToken; + +pub const MODERATOR_LIST_USER_SPEND_EVENTS_PATH: &str = + "/v1/moderation/user_spend_events/list"; + +#[derive(Deserialize)] +pub struct ModeratorListUserSpendEventsQueryParams { + /// Row offset for pagination (page size is fixed at 200). Pass `next_offset` from the previous page. + pub offset: Option, + /// Optional namespace filter (e.g. `artcraft`). Omit to return all namespaces. + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorListUserSpendEventsResponse { + pub success: bool, + pub events: Vec, + /// Offset for the next page, or `None` if this was the last page. + pub maybe_next_offset: Option, +} + +#[derive(Serialize)] +pub struct UserSpendEventListEntry { + pub token: UserSpendEventToken, + pub payments_namespace: String, + pub maybe_user_token: Option, + pub maybe_username: Option, + pub maybe_display_name: Option, + pub maybe_email_gravatar_hash: Option, + pub event_type: String, + pub amount_usd_cents: i64, + pub maybe_credits_granted: Option, + pub payment_source: String, + pub maybe_source_object_id: Option, + pub maybe_stripe_invoice_id: Option, + pub maybe_stripe_payment_intent_id: Option, + pub maybe_stripe_charge_id: Option, + pub maybe_stripe_customer_id: Option, + pub is_production: bool, + pub payment_occurred_at: DateTime, + pub created_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_events/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_events/mod.rs new file mode 100644 index 00000000..d17e233f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_events/mod.rs @@ -0,0 +1 @@ +pub mod list; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/get_summary.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/get_summary.rs new file mode 100644 index 00000000..3eb6ac13 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/get_summary.rs @@ -0,0 +1,68 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_GET_USER_SPEND_SUMMARY_PATH: &str = + "/v1/moderation/user_spend_summaries/summary/{user_token}"; + +#[derive(Deserialize)] +pub struct ModeratorGetUserSpendSummaryQueryParams { + /// Payments namespace. Defaults to `artcraft`. + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorGetUserSpendSummaryResponse { + pub success: bool, + /// `None` if the user has no spend summary row. + pub maybe_summary: Option, +} + +/// The full `user_spend_summaries` record for a user. +#[derive(Serialize)] +pub struct UserSpendSummaryView { + pub payments_namespace: String, + pub user_token: UserToken, + + pub lifetime_gross_spend_usd_cents: u64, + pub lifetime_subscription_spend_usd_cents: u64, + pub lifetime_credits_spend_usd_cents: u64, + pub lifetime_refund_usd_cents: u64, + pub lifetime_net_spend_usd_cents: u64, + pub lifetime_payment_count: u32, + pub lifetime_refund_count: u32, + pub maybe_first_payment_at: Option>, + pub first_spend_usd_cents: u64, + pub maybe_last_payment_at: Option>, + pub last_spend_usd_cents: u64, + pub maybe_days_since_first_payment: Option, + pub maybe_days_since_last_payment: Option, + + pub net_spend_7d_usd_cents: i64, + pub net_spend_prev_7d_usd_cents: i64, + pub net_spend_14d_usd_cents: i64, + pub net_spend_prev_14d_usd_cents: i64, + pub net_spend_30d_usd_cents: i64, + pub net_spend_prev_30d_usd_cents: i64, + pub net_spend_60d_usd_cents: i64, + pub net_spend_90d_usd_cents: i64, + pub net_spend_this_year_usd_cents: i64, + + pub avg_weekly_net_spend_4w_usd_cents: i64, + pub avg_weekly_net_spend_12w_usd_cents: i64, + pub active_weeks_in_last_4: u8, + pub active_weeks_in_last_8: u8, + pub active_weeks_in_last_12: u8, + pub active_weeks_in_last_24: u8, + pub active_weeks_in_last_52: u8, + pub consecutive_active_weeks: u32, + pub consecutive_inactive_weeks: u32, + pub maybe_weeks_since_last_spend: Option, + + pub is_active_subscriber: bool, + pub maybe_subscription_interval: Option, + pub maybe_reengagement_score: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/mod.rs new file mode 100644 index 00000000..1a1be210 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/mod.rs @@ -0,0 +1,3 @@ +pub mod get_summary; +pub mod reengagement_list; +pub mod top_users_list; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/reengagement_list.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/reengagement_list.rs new file mode 100644 index 00000000..6d231167 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/reengagement_list.rs @@ -0,0 +1,36 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_REENGAGEMENT_LIST_PATH: &str = + "/v1/moderation/user_spend_summaries/reengagement_list"; + +#[derive(Deserialize)] +pub struct ModeratorReengagementListQueryParams { + /// Row offset for pagination (page size is fixed at 200). Pass `next_offset` from the previous page. + pub offset: Option, + /// Payments namespace. Defaults to `artcraft`. + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorReengagementListResponse { + pub success: bool, + pub candidates: Vec, + /// Offset for the next page, or `None` if this was the last page. + pub maybe_next_offset: Option, +} + +#[derive(Serialize)] +pub struct ReengagementCandidateEntry { + pub user_token: UserToken, + pub username: String, + pub display_name: String, + pub email_gravatar_hash: String, + pub reengagement_score: u32, + pub lifetime_net_spend_usd_cents: u64, + pub maybe_last_payment_at: Option>, + pub maybe_days_since_last_payment: Option, + pub maybe_weeks_since_last_spend: Option, + pub is_active_subscriber: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/top_users_list.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/top_users_list.rs new file mode 100644 index 00000000..39e94bc1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_spend_summaries/top_users_list.rs @@ -0,0 +1,76 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_TOP_USERS_LIST_PATH: &str = + "/v1/moderation/user_spend_summaries/top_users_list"; + +/// Net-spend window that selects which column `top_users_list` sorts by. +#[derive(Deserialize, Serialize, Clone, Copy)] +pub enum TopUsersWindow { + #[serde(rename = "7d")] + SevenDays, + #[serde(rename = "14d")] + FourteenDays, + #[serde(rename = "30d")] + ThirtyDays, + #[serde(rename = "60d")] + SixtyDays, + #[serde(rename = "90d")] + NinetyDays, + #[serde(rename = "1y")] + OneYear, + #[serde(rename = "lifetime")] + Lifetime, +} + +impl TopUsersWindow { + /// The `window` key the `list_top_users_by_net_spend` query matches on. + pub fn as_query_key(self) -> &'static str { + match self { + TopUsersWindow::SevenDays => "7d", + TopUsersWindow::FourteenDays => "14d", + TopUsersWindow::ThirtyDays => "30d", + TopUsersWindow::SixtyDays => "60d", + TopUsersWindow::NinetyDays => "90d", + TopUsersWindow::OneYear => "1y", + TopUsersWindow::Lifetime => "lifetime", + } + } +} + +#[derive(Deserialize)] +pub struct ModeratorTopUsersListQueryParams { + /// Sort window: `7d`, `14d`, `30d`, `60d`, `90d`, `1y`, or `lifetime` (default). + pub window: Option, + /// Row offset for pagination (page size is fixed at 200). Pass `next_offset` from the previous page. + pub offset: Option, + /// Payments namespace. Defaults to `artcraft`. + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorTopUsersListResponse { + pub success: bool, + /// The window that was sorted by (echo of the request). + pub window: String, + pub users: Vec, + /// Offset for the next page, or `None` if this was the last page. + pub maybe_next_offset: Option, +} + +#[derive(Serialize)] +pub struct TopUserEntry { + pub user_token: UserToken, + pub username: String, + pub display_name: String, + pub email_gravatar_hash: String, + pub lifetime_net_spend_usd_cents: u64, + pub net_spend_7d_usd_cents: i64, + pub net_spend_14d_usd_cents: i64, + pub net_spend_30d_usd_cents: i64, + pub net_spend_60d_usd_cents: i64, + pub net_spend_90d_usd_cents: i64, + pub net_spend_this_year_usd_cents: i64, + pub is_active_subscriber: bool, + pub maybe_reengagement_score: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_stripe_data/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_stripe_data/mod.rs new file mode 100644 index 00000000..bfb52469 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_stripe_data/mod.rs @@ -0,0 +1 @@ +pub mod moderator_get_user_stripe_customer_ids; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/user_stripe_data/moderator_get_user_stripe_customer_ids.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_stripe_data/moderator_get_user_stripe_customer_ids.rs new file mode 100644 index 00000000..fc0dc5c1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/user_stripe_data/moderator_get_user_stripe_customer_ids.rs @@ -0,0 +1,42 @@ +use crate::enums::common::payments_namespace::PaymentsNamespace; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; + +pub const MODERATOR_GET_USER_STRIPE_CUSTOMER_IDS_PATH: &str = + "/v1/moderation/user_stripe_data/{user_token}/customer_ids"; + +#[derive(Deserialize)] +pub struct ModeratorGetUserStripeCustomerIdsPathInfo { + pub user_token: UserToken, +} + +#[derive(Serialize)] +pub struct ModeratorGetUserStripeCustomerIdsResponse { + pub success: bool, + + /// All stripe customer ids we have on file for the user, across payments + /// namespaces. A user may have zero or several: a customer link and/or + /// subscriptions per namespace (eg. artcraft), plus legacy fakeyou + /// subscriptions. The same customer id can appear once per source. + pub customer_ids: Vec, +} + +#[derive(Serialize)] +pub struct ModeratorUserStripeCustomerIdEntry { + pub stripe_customer_id: String, + pub payments_namespace: PaymentsNamespace, + pub source: ModeratorStripeCustomerIdSource, + + /// Link to the customer in the Stripe dashboard for the namespace's account. + pub stripe_dashboard_url: String, +} + +/// Which table the customer id was found in. +#[derive(Serialize)] +#[serde(rename_all = "snake_case")] +pub enum ModeratorStripeCustomerIdSource { + /// From the `user_stripe_customer_links` table (1:1 per namespace). + CustomerLink, + /// From the user's rows in the `user_subscriptions` table. + Subscription, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/list_wallet_ledger_entries_by_wallet.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/list_wallet_ledger_entries_by_wallet.rs new file mode 100644 index 00000000..07b7d2d9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/list_wallet_ledger_entries_by_wallet.rs @@ -0,0 +1,34 @@ +use chrono::{DateTime, Utc}; +use crate::enums::by_table::wallet_ledger_entries::wallet_ledger_entry_type::WalletLedgerEntryType; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::wallet_ledger_entries::WalletLedgerEntryToken; +use crate::tokens::wallets::WalletToken; + +pub const LIST_WALLET_LEDGER_ENTRIES_BY_WALLET_PATH: &str = "/v1/moderation/wallet_ledger_entries/wallet/{wallet_token}/list"; + +#[derive(Deserialize)] +pub struct ListWalletLedgerEntriesByWalletPathInfo { + pub wallet_token: WalletToken, +} + +#[derive(Serialize)] +pub struct ListWalletLedgerEntriesByWalletResponse { + pub success: bool, + pub entries: Vec, +} + +#[derive(Serialize)] +pub struct ListWalletLedgerEntriesByWalletEntry { + pub token: WalletLedgerEntryToken, + pub wallet_token: WalletToken, + pub entry_type: WalletLedgerEntryType, + pub maybe_entity_ref: Option, + pub credits_delta: i32, + pub banked_credits_before: u32, + pub banked_credits_after: u32, + pub monthly_credits_before: u32, + pub monthly_credits_after: u32, + pub created_at: DateTime, + pub is_refunded: bool, + pub maybe_linked_refund_ledger_token: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/mod.rs new file mode 100644 index 00000000..6103b92f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/mod.rs @@ -0,0 +1,2 @@ +pub mod list_wallet_ledger_entries_by_wallet; +pub mod moderator_get_wallet_ledger_entry; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/moderator_get_wallet_ledger_entry.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/moderator_get_wallet_ledger_entry.rs new file mode 100644 index 00000000..b3355a8c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallet_ledger_entries/moderator_get_wallet_ledger_entry.rs @@ -0,0 +1,32 @@ +use chrono::{DateTime, Utc}; +use crate::enums::by_table::wallet_ledger_entries::wallet_ledger_entry_type::WalletLedgerEntryType; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::wallet_ledger_entries::WalletLedgerEntryToken; + +pub const MODERATOR_GET_WALLET_LEDGER_ENTRY_PATH: &str = "/v1/moderation/wallet_ledger_entry/{wallet_ledger_entry_token}"; + +#[derive(Deserialize)] +pub struct ModeratorGetWalletLedgerEntryPathInfo { + pub wallet_ledger_entry_token: WalletLedgerEntryToken, +} + +#[derive(Serialize)] +pub struct ModeratorGetWalletLedgerEntryResponse { + pub success: bool, + pub maybe_entry: Option, +} + +#[derive(Serialize)] +pub struct ModeratorGetWalletLedgerEntryDetails { + pub token: WalletLedgerEntryToken, + pub entry_type: WalletLedgerEntryType, + pub maybe_entity_ref: Option, + pub credits_delta: i32, + pub banked_credits_before: u32, + pub banked_credits_after: u32, + pub monthly_credits_before: u32, + pub monthly_credits_after: u32, + pub is_refunded: bool, + pub maybe_linked_refund_ledger_token: Option, + pub created_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/list_user_wallets.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/list_user_wallets.rs new file mode 100644 index 00000000..42299c5f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/list_user_wallets.rs @@ -0,0 +1,29 @@ +use chrono::{DateTime, Utc}; +use crate::enums::common::payments_namespace::PaymentsNamespace; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; +use crate::tokens::wallets::WalletToken; + +pub const LIST_USER_WALLETS_PATH: &str = "/v1/moderation/wallets/user/{user_token}/list"; + +#[derive(Deserialize)] +pub struct ListUserWalletsPathInfo { + pub user_token: UserToken, +} + +#[derive(Serialize)] +pub struct ListUserWalletsResponse { + pub success: bool, + pub wallets: Vec, +} + +#[derive(Serialize)] +pub struct ListUserWalletsEntry { + pub token: WalletToken, + pub wallet_namespace: PaymentsNamespace, + pub banked_credits: u32, + pub monthly_credits: u32, + pub version: i32, + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/mod.rs new file mode 100644 index 00000000..23e8bc03 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/mod.rs @@ -0,0 +1,4 @@ +pub mod list_user_wallets; +pub mod moderator_add_banked_balance_to_wallet; +pub mod moderator_create_wallet_for_user; +pub mod moderator_get_wallet; diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_add_banked_balance_to_wallet.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_add_banked_balance_to_wallet.rs new file mode 100644 index 00000000..ad82fae5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_add_banked_balance_to_wallet.rs @@ -0,0 +1,19 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::wallets::WalletToken; + +pub const MODERATOR_ADD_BANKED_BALANCE_TO_WALLET_PATH: &str = "/v1/moderation/wallet/{wallet_token}/add_banked_balance"; + +#[derive(Deserialize)] +pub struct ModeratorAddBankedBalanceToWalletPathInfo { + pub wallet_token: WalletToken, +} + +#[derive(Deserialize)] +pub struct ModeratorAddBankedBalanceToWalletRequest { + pub credits: u16, +} + +#[derive(Serialize)] +pub struct ModeratorAddBankedBalanceToWalletResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_create_wallet_for_user.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_create_wallet_for_user.rs new file mode 100644 index 00000000..8e60a6b9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_create_wallet_for_user.rs @@ -0,0 +1,18 @@ +use crate::enums::common::payments_namespace::PaymentsNamespace; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; +use crate::tokens::wallets::WalletToken; + +pub const MODERATOR_CREATE_WALLET_FOR_USER_PATH: &str = "/v1/moderation/wallet/create_for_user"; + +#[derive(Deserialize)] +pub struct ModeratorCreateWalletForUserRequest { + pub user_token: Option, + pub payments_namespace: Option, +} + +#[derive(Serialize)] +pub struct ModeratorCreateWalletForUserResponse { + pub success: bool, + pub wallet_token: WalletToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_get_wallet.rs b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_get_wallet.rs new file mode 100644 index 00000000..1952e522 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/moderation/wallets/moderator_get_wallet.rs @@ -0,0 +1,30 @@ +use chrono::{DateTime, Utc}; +use crate::enums::common::payments_namespace::PaymentsNamespace; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::users::UserToken; +use crate::tokens::wallets::WalletToken; + +pub const MODERATOR_GET_WALLET_PATH: &str = "/v1/moderation/wallet/{wallet_token}"; + +#[derive(Deserialize)] +pub struct ModeratorGetWalletPathInfo { + pub wallet_token: WalletToken, +} + +#[derive(Serialize)] +pub struct ModeratorGetWalletResponse { + pub success: bool, + pub maybe_wallet: Option, +} + +#[derive(Serialize)] +pub struct ModeratorGetWalletDetails { + pub token: WalletToken, + pub wallet_namespace: PaymentsNamespace, + pub owner_user_token: UserToken, + pub banked_credits: u32, + pub monthly_credits: u32, + pub version: i32, + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/mod.rs new file mode 100644 index 00000000..35501ad1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/mod.rs @@ -0,0 +1,5 @@ +pub mod omni_gen_audio_cost_and_generate_request; +pub mod omni_gen_image_cost_and_generate_request; +pub mod omni_gen_mesh_cost_and_generate_request; +pub mod omni_gen_splat_cost_and_generate_request; +pub mod omni_gen_video_cost_and_generate_request; diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_audio_cost_and_generate_request.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_audio_cost_and_generate_request.rs new file mode 100644 index 00000000..e7999813 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_audio_cost_and_generate_request.rs @@ -0,0 +1,58 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_audio_model::CommonAudioModel; +use crate::enums::common::generation::common_musical_key::CommonMusicalKey; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Shared request body for both the audio cost estimate and audio generation endpoints. +#[derive(Clone, Serialize, Deserialize, Debug)] +pub struct OmniGenAudioCostAndGenerateRequest { + /// REQUIRED (even if marked optional) + /// Idempotency token to prevent duplicate requests. + pub idempotency_token: Option, + + /// REQUIRED (even if marked optional) + /// Which model to use. + pub model: Option, + + /// The text prompt for the audio generation. + pub prompt: Option, + + /// Style/genre direction (Suno's "tags"). + pub style_prompt: Option, + + /// Reference audio (optional). + /// The remix/sample source, or Seed Audio @Audio references (up to 3). + pub audio_media_tokens: Option>, + + /// Reference image (optional). + /// Seed Audio supports a single reference image; cannot be combined with audio references. + pub image_media_tokens: Option>, + + /// Whether to keep the original lyrics (Suno Remix). + pub keep_lyrics: Option, + + /// Whether to generate instrumental-only audio (Suno Music / Sample). + pub is_instrumental: Option, + + /// Whether the sound should loop vs a single hit (Suno Sounds). + pub is_loopable: Option, + + /// Beats per minute (Suno Sounds). + pub bpm: Option, + + /// The musical key to use (Suno Sounds). + pub musical_key: Option, + + /// Output sample rate in Hz (Seed Audio: 8000/16000/24000/32000/44100/48000). + pub sample_rate_hz: Option, + + /// Playback speed multiplier (Seed Audio: 0.5–2.0). + pub speed: Option, + + /// Volume multiplier (Seed Audio: 0.5–2.0). + pub volume: Option, + + /// Pitch shift in semitones (Seed Audio: -12..=12). + pub pitch: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_image_cost_and_generate_request.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_image_cost_and_generate_request.rs new file mode 100644 index 00000000..88f67ef2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_image_cost_and_generate_request.rs @@ -0,0 +1,49 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_image_model::CommonImageModel; +use crate::enums::common::generation::common_quality::CommonQuality; +use crate::enums::common::generation::common_resolution::CommonResolution; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Shared request body for both the image cost estimate and image generation endpoints. +#[derive(Clone, Serialize, Deserialize, Debug)] +pub struct OmniGenImageCostAndGenerateRequest { + /// REQUIRED (even if marked optional) + /// Idempotency token to prevent duplicate requests. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, + + /// REQUIRED (even if marked optional) + /// Which model to use. + pub model: Option, + + /// The prompt for the image generation. + pub prompt: Option, + + /// Input images for image editing. + /// If present, we're doing image editing (image-to-image). + /// If absent, we're doing text-to-image. + pub image_media_tokens: Option>, + + /// The resolution to use. + pub resolution: Option, + + /// The aspect ratio to use. + pub aspect_ratio: Option, + + /// The quality to use. + pub quality: Option, + + /// How many images to generate. + pub image_batch_count: Option, + + /// Only for angle manipulation models. + pub adjust_horizontal_angle: Option, + + /// Only for angle manipulation models. + pub adjust_vertical_angle: Option, + + /// Only for angle manipulation models. + pub adjust_zoom: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_mesh_cost_and_generate_request.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_mesh_cost_and_generate_request.rs new file mode 100644 index 00000000..afe9566c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_mesh_cost_and_generate_request.rs @@ -0,0 +1,72 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_mesh_model::CommonMeshModel; +use crate::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use crate::enums::common::generation::common_mesh_quality::CommonMeshQuality; +use crate::enums::common::generation::common_polygon_type::CommonPolygonType; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Shared request body for both the mesh cost estimate and mesh generation endpoints. +#[derive(Clone, Serialize, Deserialize, Debug)] +pub struct OmniGenMeshCostAndGenerateRequest { + /// REQUIRED (even if marked optional) + /// Idempotency token to prevent duplicate requests. + pub idempotency_token: Option, + + /// REQUIRED (even if marked optional) + /// Which model to use. + pub model: Option, + + /// The text prompt for the mesh generation (text-to-3D). + pub prompt: Option, + + /// Reference images (optional). + /// The primary/front input image, or the sketch image for sketch-to-3D. + pub reference_image_media_tokens: Option>, + + /// Front view image (optional; multi-view input). + /// Can be used instead of `reference_image_media_tokens[0]` when the other + /// side views are supplied. + pub front_image_media_token: Option, + + /// Back view image (optional; multi-view input). + pub back_image_media_token: Option, + + /// Left view image (optional; multi-view input). + pub left_image_media_token: Option, + + /// Right view image (optional; multi-view input). + pub right_image_media_token: Option, + + /// Input mesh file for mesh-to-mesh models (part splitting, retopology). + /// Required by `hunyuan_3d_3p1_part` (FBX) and + /// `hunyuan_3d_3p1_topology` (GLB/OBJ). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub input_mesh_media_token: Option, + + /// The mesh output type to generate (normal, low-poly, or geometry-only). + pub mesh_output_type: Option, + + /// The polygon type to use for the generated mesh (triangle or quad). + pub polygon_type: Option, + + /// Target face count for the generated mesh. + pub face_count: Option, + + /// Whether to generate PBR (physically based rendering) materials. + pub enable_pbr: Option, + + /// Whether to generate textures. Some models (Tripo3D) can skip texturing + /// for a cheaper, faster generation. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enable_texture: Option, + + /// Texture quality. `Detailed` costs extra on some models (Tripo3D's HD + /// texture tier). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub texture_quality: Option, + + /// Geometry quality. `Detailed` costs extra on some models (Tripo3D). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub geometry_quality: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_splat_cost_and_generate_request.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_splat_cost_and_generate_request.rs new file mode 100644 index 00000000..ddad18a4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_splat_cost_and_generate_request.rs @@ -0,0 +1,33 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_splat_model::CommonSplatModel; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Shared request body for both the splat cost estimate and splat generation endpoints. +#[derive(Clone, Serialize, Deserialize, Debug)] +pub struct OmniGenSplatCostAndGenerateRequest { + /// REQUIRED (even if marked optional) + /// Idempotency token to prevent duplicate requests. + pub idempotency_token: Option, + + /// REQUIRED (even if marked optional) + /// Which model to use. + pub model: Option, + + /// The text prompt for the splat generation. + pub prompt: Option, + + /// Reference images (optional). + /// NOTE: Spherical/panorama coordinates are not yet supported per-image; + /// multiple images are treated as multi-view input of the same world. + pub reference_image_media_tokens: Option>, + + /// Reference video (optional). + pub reference_video_media_token: Option, + + /// Whether the single reference image is a 360-degree panorama. + pub is_panoramic: Option, + + /// Whether to disable prompt recaptioning. + pub disable_recaption: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_video_cost_and_generate_request.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_video_cost_and_generate_request.rs new file mode 100644 index 00000000..86e02a35 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_and_generate_requests/omni_gen_video_cost_and_generate_request.rs @@ -0,0 +1,71 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_bitrate::CommonBitrate; +use crate::enums::common::generation::common_quality::CommonQuality; +use crate::enums::common::generation::common_resolution::CommonResolution; +use crate::enums::common::generation::common_video_model::CommonVideoModel; +use crate::tokens::characters::CharacterToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Shared request body for both the video cost estimate and video generation endpoints. +#[derive(Clone, Serialize, Deserialize, Debug)] +pub struct OmniGenVideoCostAndGenerateRequest { + /// REQUIRED (even if marked optional) + /// Idempotency token to prevent duplicate requests. + pub idempotency_token: Option, + + /// REQUIRED (even if marked optional) + /// Which model to use. + pub model: Option, + + /// The text prompt for the video generation. + pub prompt: Option, + + /// Some models support negative text prompts. + pub negative_prompt: Option, + + /// Starting keyframe (optional). + pub start_frame_image_media_token: Option, + + /// Ending keyframe (optional). + pub end_frame_image_media_token: Option, + + /// Reference images (optional). + pub reference_image_media_tokens: Option>, + + /// Reference videos (optional). + pub reference_video_media_tokens: Option>, + + /// Reference audio (optional). + pub reference_audio_media_tokens: Option>, + + /// Optional character tokens to reference in the prompt. + /// Characters are referenced in prompts as @CharacterName. + pub reference_character_tokens: Option>, + + /// The resolution to use. + pub resolution: Option, + + /// The aspect ratio to use. + pub aspect_ratio: Option, + + /// The output bitrate to use. + /// Not all models support this; models that don't simply ignore it. + pub bitrate: Option, + + /// The quality to use. + pub quality: Option, + + /// How many seconds to generate. + pub duration_seconds: Option, + + /// How many videos to generate. + pub video_batch_count: Option, + + /// Whether to turn on/off audio. + /// Not all models support audio, not all models have a choice. + /// Some models will default this to true, others will default it to false, + /// so it's best to be explicit. + pub generate_audio: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/mod.rs new file mode 100644 index 00000000..f360c72c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/mod.rs @@ -0,0 +1,5 @@ +pub mod omni_gen_audio_cost_response; +pub mod omni_gen_image_cost_response; +pub mod omni_gen_mesh_cost_response; +pub mod omni_gen_splat_cost_response; +pub mod omni_gen_video_cost_response; diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_audio_cost_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_audio_cost_response.rs new file mode 100644 index 00000000..b6b8ffe6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_audio_cost_response.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Response body for the omni-gen audio cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenAudioCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate-limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_image_cost_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_image_cost_response.rs new file mode 100644 index 00000000..ecb4a154 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_image_cost_response.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Response body for the omni-gen image cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenImageCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_mesh_cost_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_mesh_cost_response.rs new file mode 100644 index 00000000..76d14d03 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_mesh_cost_response.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Response body for the omni-gen mesh cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenMeshCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate-limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_splat_cost_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_splat_cost_response.rs new file mode 100644 index 00000000..c5d51480 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_splat_cost_response.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Response body for the omni-gen splat cost estimate endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenSplatCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate-limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_video_cost_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_video_cost_response.rs new file mode 100644 index 00000000..fc97920f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/cost_response/omni_gen_video_cost_response.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Response body for the omni-gen video cost estimate endpoint. +#[derive(Debug, Serialize, Deserialize)] +pub struct OmniGenVideoCostResponse { + pub success: bool, + + /// Estimated cost in credits. + pub cost_in_credits: Option, + + /// Estimated cost in USD cents. + pub cost_in_usd_cents: Option, + + /// Whether the generation is free for this user/plan. + pub is_free: bool, + + /// Whether the user has unlimited generations. + pub is_unlimited: bool, + + /// Whether the user is rate-limited. + pub is_rate_limited: bool, + + /// Whether the output will have a watermark. + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/mod.rs new file mode 100644 index 00000000..97c38597 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/mod.rs @@ -0,0 +1,5 @@ +pub mod omni_gen_audio_generate_response; +pub mod omni_gen_image_generate_response; +pub mod omni_gen_mesh_generate_response; +pub mod omni_gen_splat_generate_response; +pub mod omni_gen_video_generate_response; diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_audio_generate_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_audio_generate_response.rs new file mode 100644 index 00000000..0a6a7f38 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_audio_generate_response.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +/// Response body for the omni-gen audio generation endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenAudioGenerateResponse { + pub success: bool, + + pub inference_job_token: InferenceJobToken, + + /// All job tokens created by this request (including the primary). + /// For single-job requests this will contain just one element matching + /// `inference_job_token`. For batch requests this will contain all of them. + pub all_job_tokens: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_image_generate_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_image_generate_response.rs new file mode 100644 index 00000000..57daea0f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_image_generate_response.rs @@ -0,0 +1,9 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +/// Response body for the omni-gen image generation endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenImageGenerateResponse { + pub success: bool, + pub inference_job_token: InferenceJobToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_mesh_generate_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_mesh_generate_response.rs new file mode 100644 index 00000000..4fd41462 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_mesh_generate_response.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +/// Response body for the omni-gen mesh generation endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenMeshGenerateResponse { + pub success: bool, + + pub inference_job_token: InferenceJobToken, + + /// All job tokens created by this request (including the primary). + /// For single-job requests this will contain just one element matching + /// `inference_job_token`. For batch requests this will contain all of them. + pub all_job_tokens: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_splat_generate_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_splat_generate_response.rs new file mode 100644 index 00000000..3cb5fb78 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_splat_generate_response.rs @@ -0,0 +1,15 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +/// Response body for the omni-gen splat generation endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenSplatGenerateResponse { + pub success: bool, + + pub inference_job_token: InferenceJobToken, + + /// All job tokens created by this request (including the primary). + /// For single-job requests this will contain just one element matching + /// `inference_job_token`. For batch requests this will contain all of them. + pub all_job_tokens: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_video_generate_response.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_video_generate_response.rs new file mode 100644 index 00000000..d1cd1184 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/generate_response/omni_gen_video_generate_response.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::generic_inference_jobs::InferenceJobToken; + +/// Response body for the omni-gen video generation endpoint. +#[derive(Serialize, Deserialize)] +pub struct OmniGenVideoGenerateResponse { + pub success: bool, + + pub inference_job_token: InferenceJobToken, + + /// All job tokens created by this request (including the primary). + /// For single-job requests this will contain just one element matching + /// `inference_job_token`. For batch requests (eg. Seedance2Pro with + /// multiple order IDs) this will contain all of them. + pub all_job_tokens: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/mod.rs new file mode 100644 index 00000000..1544ead3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/mod.rs @@ -0,0 +1,4 @@ +pub mod cost_and_generate_requests; +pub mod cost_response; +pub mod generate_response; +pub mod models; diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/mod.rs new file mode 100644 index 00000000..1aa2d958 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/mod.rs @@ -0,0 +1,5 @@ +pub mod omni_gen_audio_models; +pub mod omni_gen_image_models; +pub mod omni_gen_mesh_models; +pub mod omni_gen_splat_models; +pub mod omni_gen_video_models; diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_audio_models.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_audio_models.rs new file mode 100644 index 00000000..034504dd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_audio_models.rs @@ -0,0 +1,138 @@ +use crate::enums::common::generation::common_audio_model::CommonAudioModel; +use crate::enums::common::generation::model_creator::ModelCreator; +use core_types::enums::generation_source::GenerationSource; +use serde_derive::Serialize; + +/// Audio model to default to if none is specified +const DEFAULT_AUDIO_MODEL : CommonAudioModel = CommonAudioModel::SunoMusic; + +/// Response body for the audio models endpoint. +#[derive(Serialize, Clone)] +pub struct OmniGenAudioModelsResponse { + pub success: bool, + + /// A list of all models: details, features, and capabilities + pub models: Vec, + + /// Provider-by-provider model offering and capability list, + /// with possible capability overrides (future) + pub providers: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenAudioModelProviderDetails { + pub provider: GenerationSource, + pub models: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenAudioProviderModelDetails { + pub model: CommonAudioModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub overrides: Option, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenAudioModelDetails { + + pub model: CommonAudioModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_creator: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub full_name: Option, + + /// Additional details about the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + + /// Additional details about the model. (Brief; only a few words.) + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info_short: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_supported: Option, + + /// Whether a style/genre prompt (Suno's "tags") is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub style_prompt_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_max: Option, + + /// Whether the "keep lyrics" toggle is supported (Suno Remix). + #[serde(skip_serializing_if = "Option::is_none")] + pub keep_lyrics_supported: Option, + + /// Whether the instrumental-only toggle is supported (Suno Music / Sample). + #[serde(skip_serializing_if = "Option::is_none")] + pub instrumental_toggle_supported: Option, + + /// Whether the loop vs single-hit toggle is supported (Suno Sounds). + #[serde(skip_serializing_if = "Option::is_none")] + pub loopable_toggle_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub bpm_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub musical_key_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sample_rate_hz_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sample_rate_hz_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub speed_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub volume_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub pitch_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub is_disabled: Option, +} + +impl Default for OmniGenAudioModelDetails { + fn default() -> Self { + Self { + model: DEFAULT_AUDIO_MODEL, + model_creator: None, + full_name: None, + extra_info: None, + extra_info_short: None, + text_prompt_supported: None, + style_prompt_supported: None, + audio_references_supported: None, + audio_references_max: None, + image_references_supported: None, + image_references_max: None, + keep_lyrics_supported: None, + instrumental_toggle_supported: None, + loopable_toggle_supported: None, + bpm_supported: None, + musical_key_supported: None, + sample_rate_hz_options: None, + sample_rate_hz_default: None, + speed_supported: None, + volume_supported: None, + pitch_supported: None, + is_disabled: None, + } + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_image_models.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_image_models.rs new file mode 100644 index 00000000..8cb6815d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_image_models.rs @@ -0,0 +1,158 @@ +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_image_model::CommonImageModel; +use crate::enums::common::generation::common_quality::CommonQuality; +use crate::enums::common::generation::common_resolution::CommonResolution; +use crate::enums::common::generation::model_creator::ModelCreator; +use core_types::enums::generation_source::GenerationSource; +use serde_derive::{Deserialize, Serialize}; + +/// Query string parameters for the image models endpoint. +#[derive(Deserialize)] +pub struct OmniGenImageModelsQuery { + /// Which provider's models to list. Defaults to "artcraft" if absent. + pub provider: Option, +} + +/// The provider filter for the models endpoint. +#[derive(Serialize, Deserialize, Debug, Clone, Copy)] +#[serde(rename_all = "snake_case")] +pub enum OmniGenImageModelsProvider { + /// Only models available through ArtCraft. + Artcraft, + /// All known models across all providers. + All, +} + +impl Default for OmniGenImageModelsProvider { + fn default() -> Self { + Self::Artcraft + } +} + +/// Response body for the image models endpoint. +/// TBD — fields will be added later. +#[derive(Serialize, Clone)] +pub struct OmniGenImageModelsResponse { + pub success: bool, + pub models: Vec, + pub providers: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenImageModelProviderDetails { + pub provider: GenerationSource, + pub models: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenImageProviderModelDetails { + pub model: CommonImageModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub overrides: Option, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenImageModelDetails { + pub model: CommonImageModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_creator: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub full_name: Option, + + // TODO: model_creator: ModelCreator, + + // TODO: Types of UI to show up in (list or bools) + // eg. can use in image editing UI, 3d editor, etc. + + // TODO: sub-features like inpainting masking, + // TODO: angle edit models + + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_text_prompt_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_text_prompt_max_length: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_refs_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_refs_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub has_fixed_editing_aspect_ratio: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_default_when_editing: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub quality_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub default_quality: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_min: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub is_disabled: Option, +} + +impl Default for OmniGenImageModelDetails { + fn default() -> Self { + Self { + model: CommonImageModel::NanoBananaPro, + model_creator: None, + full_name: None, + text_prompt_supported: None, + text_prompt_max_length: None, + negative_text_prompt_supported: None, + negative_text_prompt_max_length: None, + image_refs_supported: None, + image_refs_max: None, + has_fixed_editing_aspect_ratio: None, + aspect_ratio_options: None, + aspect_ratio_default: None, + aspect_ratio_default_when_editing: None, + resolution_options: None, + resolution_default: None, + quality_options: None, + default_quality: None, + batch_size_min: None, + batch_size_max: None, + batch_size_options: None, + batch_size_default: None, + is_disabled: None, + } + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_mesh_models.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_mesh_models.rs new file mode 100644 index 00000000..b261321b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_mesh_models.rs @@ -0,0 +1,133 @@ +use crate::enums::common::generation::common_mesh_model::CommonMeshModel; +use crate::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use crate::enums::common::generation::common_polygon_type::CommonPolygonType; +use crate::enums::common::generation::model_creator::ModelCreator; +use core_types::enums::generation_source::GenerationSource; +use serde_derive::Serialize; + +/// Mesh model to default to if none is specified +const DEFAULT_MESH_MODEL : CommonMeshModel = CommonMeshModel::Hunyuan3d3; + +/// Response body for the mesh models endpoint. +#[derive(Serialize, Clone)] +pub struct OmniGenMeshModelsResponse { + pub success: bool, + + /// A list of all models: details, features, and capabilities + pub models: Vec, + + /// Provider-by-provider model offering and capability list, + /// with possible capability overrides (future) + pub providers: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenMeshModelProviderDetails { + pub provider: GenerationSource, + pub models: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenMeshProviderModelDetails { + pub model: CommonMeshModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub overrides: Option, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenMeshModelDetails { + + pub model: CommonMeshModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_creator: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub full_name: Option, + + /// Additional details about the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + + /// Additional details about the model. (Brief; only a few words.) + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info_short: Option, + + /// Whether text-to-3D prompting is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_supported: Option, + + /// Whether image-to-3D input is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_input_supported: Option, + + /// Whether sketch-to-3D input is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub sketch_input_supported: Option, + + /// Whether multi-view (front/back/left/right) image input is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub multi_view_supported: Option, + + /// Whether the model takes an existing mesh file as input + /// (mesh-to-mesh models like part splitting and retopology). + #[serde(skip_serializing_if = "Option::is_none")] + pub mesh_input_supported: Option, + + /// The mesh output types the model supports. + #[serde(skip_serializing_if = "Option::is_none")] + pub mesh_output_types: Option>, + + /// The polygon types the model supports. + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_types: Option>, + + /// Whether a target face count can be specified. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count_supported: Option, + + /// Whether PBR (physically based rendering) material generation is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub pbr_supported: Option, + + /// Whether texture generation can be toggled off (untextured output). + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_toggle_supported: Option, + + /// Whether a texture quality level (standard/detailed) can be selected. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_quality_supported: Option, + + /// Whether a geometry quality level (standard/detailed) can be selected. + #[serde(skip_serializing_if = "Option::is_none")] + pub geometry_quality_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub is_disabled: Option, +} + +impl Default for OmniGenMeshModelDetails { + fn default() -> Self { + Self { + model: DEFAULT_MESH_MODEL, + model_creator: None, + full_name: None, + extra_info: None, + extra_info_short: None, + text_prompt_supported: None, + image_input_supported: None, + sketch_input_supported: None, + multi_view_supported: None, + mesh_input_supported: None, + mesh_output_types: None, + polygon_types: None, + face_count_supported: None, + pbr_supported: None, + texture_toggle_supported: None, + texture_quality_supported: None, + geometry_quality_supported: None, + is_disabled: None, + } + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_splat_models.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_splat_models.rs new file mode 100644 index 00000000..51457f90 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_splat_models.rs @@ -0,0 +1,97 @@ +use crate::enums::common::generation::common_splat_model::CommonSplatModel; +use crate::enums::common::generation::model_creator::ModelCreator; +use core_types::enums::generation_source::GenerationSource; +use serde_derive::Serialize; + +/// Splat model to default to if none is specified +const DEFAULT_SPLAT_MODEL : CommonSplatModel = CommonSplatModel::Marble1p1; + +/// Response body for the splat models endpoint. +#[derive(Serialize, Clone)] +pub struct OmniGenSplatModelsResponse { + pub success: bool, + + /// A list of all models: details, features, and capabilities + pub models: Vec, + + /// Provider-by-provider model offering and capability list, + /// with possible capability overrides (future) + pub providers: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenSplatModelProviderDetails { + pub provider: GenerationSource, + pub models: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenSplatProviderModelDetails { + pub model: CommonSplatModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub overrides: Option, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenSplatModelDetails { + + pub model: CommonSplatModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_creator: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub full_name: Option, + + /// Additional details about the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + + /// Additional details about the model. (Brief; only a few words.) + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info_short: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_max: Option, + + /// Whether a reference video input is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub video_reference_supported: Option, + + /// Whether a 360-degree panorama reference image is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub panorama_supported: Option, + + /// Whether the "disable recaption" toggle is supported. + #[serde(skip_serializing_if = "Option::is_none")] + pub disable_recaption_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub is_disabled: Option, +} + +impl Default for OmniGenSplatModelDetails { + fn default() -> Self { + Self { + model: DEFAULT_SPLAT_MODEL, + model_creator: None, + full_name: None, + extra_info: None, + extra_info_short: None, + text_prompt_supported: None, + image_references_supported: None, + image_references_max: None, + video_reference_supported: None, + panorama_supported: None, + disable_recaption_supported: None, + is_disabled: None, + } + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_video_models.rs b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_video_models.rs new file mode 100644 index 00000000..414579f8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/omni_gen/models/omni_gen_video_models.rs @@ -0,0 +1,245 @@ +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_quality::CommonQuality; +use crate::enums::common::generation::common_resolution::CommonResolution; +use crate::enums::common::generation::common_video_model::CommonVideoModel; +use crate::enums::common::generation::model_creator::ModelCreator; +use core_types::enums::generation_source::GenerationSource; +use serde_derive::{Deserialize, Serialize}; +use crate::enums::common::generation::common_bitrate::CommonBitrate; + +/// Video model to default to if none is specified +const DEFAULT_VIDEO_MODEL : CommonVideoModel = CommonVideoModel::Seedance2p0; + +/// Query string parameters for the video models endpoint. +#[derive(Deserialize)] +pub struct OmniGenVideoModelsQuery { + /// Which provider's models to list. Defaults to "artcraft" if absent. + pub provider: Option, +} + +/// The provider filter for the models endpoint. +#[derive(Serialize, Deserialize, Debug, Clone, Copy)] +#[serde(rename_all = "snake_case")] +pub enum OmniGenVideoModelsProvider { + /// Only models available through ArtCraft. + Artcraft, + /// All known models across all providers. + All, +} + +impl Default for OmniGenVideoModelsProvider { + fn default() -> Self { + Self::Artcraft + } +} + +/// Response body for the video models endpoint. +/// TBD — fields will be added later. +#[derive(Serialize, Clone)] +pub struct OmniGenVideoModelsResponse { + pub success: bool, + + /// A list of all models: details, features, and capabilities + pub models: Vec, + + /// Provider-by-provider model offering and capability list, + /// with possible capability overrides (future) + pub providers: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenVideoModelProviderDetails { + pub provider: GenerationSource, + pub models: Vec, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenVideoProviderModelDetails { + pub model: CommonVideoModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub overrides: Option, +} + +#[derive(Serialize, Clone)] +pub struct OmniGenVideoModelDetails { + + pub model: CommonVideoModel, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_creator: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub full_name: Option, + + /// Additional details about the model. + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + + /// Additional details about the model. (Brief; only a few words.) + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info_short: Option, + + /// Whether a pure text-to-video modality is supported + #[serde(skip_serializing_if = "Option::is_none")] + pub text_to_video_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_text_prompt_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_text_prompt_max_length: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub starting_keyframe_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub starting_keyframe_required: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub ending_keyframe_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub video_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub video_references_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub video_references_max_total_duration_seconds: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_max_total_duration_seconds: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub character_references_supported: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub character_references_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub show_generate_with_sound_toggle: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub bitrate_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub bitrate_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub quality_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub default_quality: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_min: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_max: Option, + + /// Specific maximum when image references are used, + /// eg. Grok limits to 10 seconds in this mode. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_max_with_image_references: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_min: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_max: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_options: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_default: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub is_disabled: Option, +} + +impl Default for OmniGenVideoModelDetails { + fn default() -> Self { + Self { + model: DEFAULT_VIDEO_MODEL, + model_creator: None, + full_name: None, + extra_info: None, + extra_info_short: None, + text_to_video_supported: None, + text_prompt_supported: None, + text_prompt_max_length: None, + negative_text_prompt_supported: None, + negative_text_prompt_max_length: None, + starting_keyframe_supported: None, + starting_keyframe_required: None, + ending_keyframe_supported: None, + image_references_supported: None, + image_references_max: None, + video_references_supported: None, + video_references_max: None, + video_references_max_total_duration_seconds: None, + audio_references_supported: None, + audio_references_max: None, + audio_references_max_total_duration_seconds: None, + character_references_supported: None, + character_references_max: None, + show_generate_with_sound_toggle: None, + aspect_ratio_options: None, + aspect_ratio_default: None, + resolution_options: None, + resolution_default: None, + bitrate_options: None, + bitrate_default: None, + quality_options: None, + default_quality: None, + duration_seconds_min: None, + duration_seconds_max: None, + duration_seconds_max_with_image_references: None, + duration_seconds_options: None, + duration_seconds_default: None, + batch_size_min: None, + batch_size_max: None, + batch_size_options: None, + batch_size_default: None, + is_disabled: None, + } + } +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/prompts/batch_get_prompts.rs b/crates/api_clients/artcraft_client/src/api_defs/prompts/batch_get_prompts.rs new file mode 100644 index 00000000..b640e19a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/prompts/batch_get_prompts.rs @@ -0,0 +1,74 @@ +use crate::api_defs::prompts::get_prompt::GetPromptImageContextItem; +use chrono::{DateTime, Utc}; +use crate::enums::by_table::prompts::prompt_type::PromptType; +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_bitrate::CommonBitrate; +use crate::enums::common::generation::common_generation_mode::CommonGenerationMode; +use crate::enums::common::generation::common_model_class::CommonModelClass; +use crate::enums::common::generation::common_model_type::CommonModelType; +use crate::enums::common::generation::common_resolution::CommonResolution; +use core_types::enums::generation_source::GenerationSource; +use std::collections::HashSet; + +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +pub const BATCH_GET_PROMPTS_PATH: &str = "/v1/prompt/batch"; + +#[derive(Deserialize)] +pub struct BatchGetPromptsQuery { + /// Prompt tokens to look up. + pub tokens: HashSet, +} + +#[derive(Serialize)] +pub struct BatchGetPromptsResponse { + pub success: bool, + pub prompts: Vec, +} + +#[derive(Serialize)] +pub struct BatchPromptInfo { + pub token: PromptToken, + + /// The type of model used + pub maybe_model_type: Option, + + /// The class of model used + pub maybe_model_class: Option, + + /// The service provider used + pub maybe_generation_provider: Option, + + /// Positive prompt (technically optional, but usually present) + pub maybe_positive_prompt: Option, + + /// Negative prompt (optional) + pub maybe_negative_prompt: Option, + + /// OPTIONAL. The generation mode (eg. keyframe, reference, inpaint, etc.) + pub maybe_generation_mode: Option, + + /// OPTIONAL. The aspect ratio (eg. square, auto, wide_three_by_two, etc.) + pub maybe_aspect_ratio: Option, + + /// OPTIONAL. The resolution (eg. one_k, two_k, four_k, etc.) + pub maybe_resolution: Option, + + /// OPTIONAL. The output bitrate (eg. normal, high). + pub maybe_bitrate: Option, + + /// OPTIONAL. The number of outputs to generate (0-255). + pub maybe_batch_count: Option, + + /// OPTIONAL. Whether to generate audio. + pub maybe_generate_audio: Option, + + /// OPTIONAL. The duration in seconds. + pub maybe_duration_seconds: Option, + + /// Context images (optional) + pub maybe_context_images: Option>, + + pub created_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/prompts/create_prompt.rs b/crates/api_clients/artcraft_client/src/api_defs/prompts/create_prompt.rs new file mode 100644 index 00000000..c1fa546d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/prompts/create_prompt.rs @@ -0,0 +1,51 @@ +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_generation_mode::CommonGenerationMode; +use crate::enums::common::generation::common_model_type::CommonModelType; +use crate::enums::common::generation::common_resolution::CommonResolution; +use core_types::enums::generation_source::GenerationSource; +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +pub const CREATE_PROMPT_PATH: &str = "/v1/prompts/create"; + +#[derive(Serialize, Deserialize)] +pub struct CreatePromptRequest { + /// Idempotency token to prevent duplicate requests. + pub uuid_idempotency_token: String, + + /// OPTIONAL. The positive prompt. + pub positive_prompt: Option, + + /// OPTIONAL. The negative prompt. + pub negative_prompt: Option, + + /// OPTIONAL. The model type. + pub model_type: Option, + + /// OPTIONAL. The service used. + pub generation_provider: Option, + + /// OPTIONAL. The generation mode (eg. keyframe, reference, inpaint, etc.) + pub maybe_generation_mode: Option, + + /// OPTIONAL. The aspect ratio (eg. square, auto, wide_three_by_two, etc.) + pub maybe_aspect_ratio: Option, + + /// OPTIONAL. The resolution (eg. one_k, two_k, four_k, etc.) + pub maybe_resolution: Option, + + /// OPTIONAL. The number of outputs to generate (0-255). + pub maybe_batch_count: Option, + + /// OPTIONAL. Whether to generate audio. + pub maybe_generate_audio: Option, + + /// OPTIONAL. The duration in seconds. + pub maybe_duration_seconds: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct CreatePromptResponse { + pub success: bool, + pub prompt_token: PromptToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/prompts/get_prompt.rs b/crates/api_clients/artcraft_client/src/api_defs/prompts/get_prompt.rs new file mode 100644 index 00000000..bb540946 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/prompts/get_prompt.rs @@ -0,0 +1,152 @@ +use crate::api_defs::common::responses::media_links::MediaLinks; +use chrono::{DateTime, Utc}; +use crate::enums::by_table::prompt_context_items::prompt_context_semantic_type::PromptContextSemanticType; +use crate::enums::by_table::prompts::prompt_type::PromptType; +use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common::generation::common_bitrate::CommonBitrate; +use crate::enums::common::generation::common_generation_mode::CommonGenerationMode; +use crate::enums::common::generation::common_model_type::CommonModelType; +use crate::enums::common::generation::common_resolution::CommonResolution; +use core_types::enums::generation_source::GenerationSource; +use crate::enums::no_table::style_transfer::style_transfer_name::StyleTransferName; +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use crate::enums::common::generation::common_model_class::CommonModelClass; + +pub const GET_PROMPT_PATH: &str = "/v1/prompts/{token}"; + +#[derive(Deserialize)] +pub struct GetPromptPathInfo { + pub token: PromptToken, +} + +#[derive(Serialize)] +pub struct GetPromptSuccessResponse { + pub success: bool, + pub prompt: PromptInfo, +} + +#[derive(Serialize)] +pub struct PromptInfo { + pub token: PromptToken, + + /// The type of prompt. + /// Note: Prompts may or may not be compatible across systems. + pub prompt_type: PromptType, + + /// The type of model used + pub maybe_model_type: Option, + + /// The class of model used + pub maybe_model_class: Option, + + /// The service provider used + pub maybe_generation_provider: Option, + + /// Positive prompt (technically optional, but usually present) + pub maybe_positive_prompt: Option, + + /// Negative prompt (optional) + pub maybe_negative_prompt: Option, + + /// OPTIONAL. The generation mode (eg. keyframe, reference, inpaint, etc.) + pub maybe_generation_mode: Option, + + /// OPTIONAL. The aspect ratio (eg. square, auto, wide_three_by_two, etc.) + pub maybe_aspect_ratio: Option, + + /// OPTIONAL. The resolution (eg. one_k, two_k, four_k, etc.) + pub maybe_resolution: Option, + + /// OPTIONAL. The output bitrate (eg. normal, high). + pub maybe_bitrate: Option, + + /// OPTIONAL. The number of outputs to generate (0-255). + pub maybe_batch_count: Option, + + /// OPTIONAL. Whether to generate audio. + pub maybe_generate_audio: Option, + + /// OPTIONAL. The duration in seconds. + pub maybe_duration_seconds: Option, + + /// Context images (optional) + pub maybe_context_images: Option>, + + /// Scheduled / travel prompt (optional) + pub maybe_travel_prompt: Option, + + /// If a "style" was used, this is the name of it. + /// This might not be present for all types of inference + /// and typically only applies to video style transfer. + pub maybe_style_name: Option, + + /// How many milliseconds it took to run generation. + pub maybe_inference_duration_millis: Option, + + /// If a "strength" was used. + /// Typically only for video style transfer. + pub maybe_strength: Option, + + /// If a frame skip setting was used. + pub maybe_frame_skip: Option, + + /// If a face detailer was used. + /// This might not be present for all types of inference + /// and typically only applies to video style transfer. + pub used_face_detailer: bool, + + /// If an upscaling pass was used. + /// This might not be present for all types of inference + /// and typically only applies to video style transfer. + pub used_upscaler: bool, + + /// If lipsync was enabled. + /// This might not be present for all types of inference + /// and typically only applies to video style transfer. + pub lipsync_enabled: bool, + + /// If LCM was disabled. + /// Only staff can do this for now. + pub lcm_disabled: bool, + + /// If the cinematic workflow was used. + /// Only staff can do this for now. + pub use_cinematic: bool, + + /// If a global IP Adapter Image was used, this is the details. + /// NB: We can't easily query for this without another DB round trip, + /// so the frontend should query for it instead. + pub maybe_global_ipa_image_token: Option, + + /// Fields that only moderators should see. + pub maybe_moderator_fields: Option, + + pub created_at: DateTime, +} + +#[derive(Serialize)] +pub struct GetPromptImageContextItem { + pub media_token: MediaFileToken, + pub semantic: PromptContextSemanticType, + pub media_links: MediaLinks, +} + +#[derive(Serialize)] +pub struct PromptInfoModeratorFields { + /// How many milliseconds it took to run generation. + pub maybe_inference_duration_millis: Option, + + /// Version of Yae's workflow + /// Used for logging and debugging by the art team. + pub main_ipa_workflow: Option, + + /// Version of Yae's face detailer workflow + /// Used for logging and debugging by the art team. + pub face_detailer_workflow: Option, + + /// Version of Yae's upscaler workflow + /// Used for logging and debugging by the art team. + pub upscaler_workflow: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/prompts/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/prompts/mod.rs new file mode 100644 index 00000000..90ff797a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/prompts/mod.rs @@ -0,0 +1,3 @@ +pub mod batch_get_prompts; +pub mod create_prompt; +pub mod get_prompt; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_create_new_user_account_and_subscription_checkout.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_create_new_user_account_and_subscription_checkout.rs new file mode 100644 index 00000000..27c3d7e3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_create_new_user_account_and_subscription_checkout.rs @@ -0,0 +1,69 @@ +use crate::enums::common::artcraft_subscription_slug::ArtcraftSubscriptionSlug; +use serde_derive::{Deserialize, Serialize}; + +pub const CREATE_NEW_USER_ACCOUNT_AND_SUBSCRIPTION_CHECKOUT_URL_PATH: &str = "/v1/stripe_artcraft/user_signup/subscription_checkout"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCreateSubscriptionCheckoutWithUserSignupRequest { + /// The (non-Stripe) internal identifier for the product or subscription. + /// This will be translated into a Stripe identifier. + pub plan: Option, + + pub cadence: Option, + + /// Optional: The referral URL the user arrived from when first hitting the site, prior to navigation and signing up. + /// The browser can send `document.referrer` to the backend so we know how people are finding us. + /// If the browser doesn't send this parameter, we'll try the `referer` header. + pub maybe_referral_url: Option, + + /// Optional: The URL where the user landed when they first arrived, prior to navigation and signing up. + /// The browser can send `window.location.href` to the backend so we know how people are finding us. + pub maybe_landing_url: Option, + + /// Optional: A referral username or code from a referring user. + pub maybe_referral_username: Option, + + /// Optional: A referral code created by another user. If present, takes priority over + /// `maybe_referral_username` for resolving the referring user. + pub maybe_referral_code: Option, +} + +#[derive(Serialize, Deserialize, Debug, Copy, Clone)] +pub enum PlanBillingCadence { + #[serde(rename = "monthly")] + Monthly, + + #[serde(rename = "yearly")] + Yearly, +} + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCreateSubscriptionCheckoutWithUserSignupResponse { + pub success: bool, + + /// The checkout session URL. + pub stripe_checkout_redirect_url: String, + + /// If a user account was created, these are the details. + pub generated_user: Option, + + /// If a session was created, these are the details. + pub session: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct UserDetails { + /// The generated username. + pub username: String, + + /// The generated display name. + pub display_name: String, +} + +#[derive(Serialize, Deserialize)] +pub struct SessionDetails { + /// A signed session that can be sent as a header, bypassing cookies. + /// This is useful for API clients that don't support cookies or Google + /// browsers killing cross-domain cookies. + pub signed_session: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_credits_pack_checkout.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_credits_pack_checkout.rs new file mode 100644 index 00000000..05caae62 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_credits_pack_checkout.rs @@ -0,0 +1,16 @@ +use crate::enums::common::artcraft_credits_pack_slug::ArtcraftCreditsPackSlug; +use serde_derive::{Deserialize, Serialize}; + +pub const CREATE_CREDITS_PACK_CHECKOUT_URL_PATH: &str = "/v1/stripe_artcraft/checkout/credits_pack"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCreateCreditsPackCheckoutRequest { + pub credits_pack: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCreateCreditsPackCheckoutResponse { + pub success: bool, + pub stripe_checkout_redirect_url: String, +} + diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_subscription_checkout.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_subscription_checkout.rs new file mode 100644 index 00000000..65e2ad1d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/create_subscription_checkout.rs @@ -0,0 +1,29 @@ +use crate::enums::common::artcraft_subscription_slug::ArtcraftSubscriptionSlug; +use serde_derive::{Deserialize, Serialize}; + +pub const CREATE_SUBSCRIPTION_CHECKOUT_URL_PATH: &str = "/v1/stripe_artcraft/checkout/subscription"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCreateSubscriptionCheckoutRequest { + /// The (non-Stripe) internal identifier for the product or subscription. + /// This will be translated into a Stripe identifier. + pub plan: Option, + + pub cadence: Option, +} + +#[derive(Serialize, Deserialize, Debug, Copy, Clone)] +pub enum PlanBillingCadence { + #[serde(rename = "monthly")] + Monthly, + + #[serde(rename = "yearly")] + Yearly, +} + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCreateSubscriptionCheckoutResponse { + pub success: bool, + pub stripe_checkout_redirect_url: String, +} + diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_cancel_plan.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_cancel_plan.rs new file mode 100644 index 00000000..039727db --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_cancel_plan.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; + +pub const CUSTOMER_PORTAL_CANCEL_PLAN_URL_PATH: &str = "/v1/stripe_artcraft/portal/cancel_plan"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalCancelPlanRequest { + // TODO: Not sure if this is needed + pub portal_config_id: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalCancelPlanResponse { + pub success: bool, + pub stripe_portal_url: String, +} + diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_manage_plan.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_manage_plan.rs new file mode 100644 index 00000000..14ac32e2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_manage_plan.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; + +pub const CUSTOMER_PORTAL_MANAGE_PLAN_URL_PATH: &str = "/v1/stripe_artcraft/portal/manage_plan"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalManagePlanRequest { + // TODO: Not sure if this is needed + pub portal_config_id: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalManagePlanResponse { + pub success: bool, + pub stripe_portal_url: String, +} + diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_switch_plan.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_switch_plan.rs new file mode 100644 index 00000000..b03682e4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_switch_plan.rs @@ -0,0 +1,36 @@ +use crate::enums::common::artcraft_subscription_slug::ArtcraftSubscriptionSlug; +use serde_derive::{Deserialize, Serialize}; + +pub const CUSTOMER_PORTAL_SWITCH_PLAN_URL_PATH: &str = "/v1/stripe_artcraft/portal/switch_plan"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalSwitchPlanRequest { + // TODO: Not sure if this is needed + pub portal_config_id: Option, + + /// REQUIRED + /// The plan we're switching to. + pub plan: Option, + + /// REQUIRED + /// The cadence for the plan billing. + pub cadence: Option, +} + + +#[derive(Serialize, Deserialize, Debug, Copy, Clone)] +pub enum PlanBillingCadenceConfirmation { + #[serde(rename = "monthly")] + Monthly, + + #[serde(rename = "yearly")] + Yearly, +} + + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalSwitchPlanResponse { + pub success: bool, + pub stripe_portal_url: String, +} + diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_update_payment_method.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_update_payment_method.rs new file mode 100644 index 00000000..c4ffafb3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/customer_portal_update_payment_method.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; + +pub const CUSTOMER_PORTAL_UPDATE_PAYMENT_METHOD_URL_PATH: &str = "/v1/stripe_artcraft/portal/update_payment_method"; + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalUpdatePaymentMethodRequest { + // TODO: Not sure if this is needed + pub portal_config_id: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct StripeArtcraftCustomerPortalUpdatePaymentMethodResponse { + pub success: bool, + pub stripe_portal_url: String, +} + diff --git a/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/mod.rs new file mode 100644 index 00000000..0083af57 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/stripe_artcraft/mod.rs @@ -0,0 +1,7 @@ +pub mod create_create_new_user_account_and_subscription_checkout; +pub mod create_credits_pack_checkout; +pub mod create_subscription_checkout; +pub mod customer_portal_cancel_plan; +pub mod customer_portal_manage_plan; +pub mod customer_portal_switch_plan; +pub mod customer_portal_update_payment_method; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/subscriptions/get_session_subscription.rs b/crates/api_clients/artcraft_client/src/api_defs/subscriptions/get_session_subscription.rs new file mode 100644 index 00000000..b608bcc8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/subscriptions/get_session_subscription.rs @@ -0,0 +1,36 @@ +use chrono::{DateTime, Utc}; +use crate::enums::common::payments_namespace::PaymentsNamespace; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::user_subscriptions::UserSubscriptionToken; + +// TODO: Maybe make "artcraft_subscription" or "fakeyou_subscription" with strongly typed slugs? + +#[derive(Serialize, Deserialize)] +pub struct GetSessionSubscriptionResponse { + pub success: bool, + + /// Information about the user's subscription, if any. + pub active_subscription: Option, +} + +#[derive(Serialize, Deserialize)] +pub struct SubscriptionInfo { + /// Unique token for the subscription. + pub subscription_token: UserSubscriptionToken, + + /// Namespace for the subscription. + pub namespace: PaymentsNamespace, + + /// Local key for the subscription. + pub product_slug: String, + + /// If the subscription is currently active, this is the next billing date. + pub next_bill_at: Option>, + + /// If the subscription is set to cancel, this is the end date of the subscription. + pub subscription_end_at: Option>, + + ///// When the current billing period ends (either + ///// auto-renew/rebill date or auto-cancel/cancellation date). + //pub current_billing_period_end_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/subscriptions/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/subscriptions/mod.rs new file mode 100644 index 00000000..1cc61e22 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/subscriptions/mod.rs @@ -0,0 +1 @@ +pub mod get_session_subscription; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/add_media_file_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/add_media_file_tags.rs new file mode 100644 index 00000000..dfab6bf0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/add_media_file_tags.rs @@ -0,0 +1,34 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── POST /v1/tags/media_file/add/{media_file_token} ── + +#[derive(Deserialize)] +pub struct AddMediaFileTagsPathInfo { + pub media_file_token: MediaFileToken, +} + +/// Exactly one of `maybe_tags` / `maybe_tags_list` must be set (400 if +/// both or neither). Tag text is trimmed and deduped case-insensitively; +/// empty entries are dropped. Must sanitize to at least one tag (400 +/// otherwise). +#[derive(Deserialize)] +pub struct AddMediaFileTagsRequest { + /// Comma-separated tags, e.g. `"cats, Sci-Fi, wallpaper"`. + pub maybe_tags: Option, + + /// Tags as a list. Entries are still trimmed. + pub maybe_tags_list: Option>, +} + +#[derive(Serialize)] +pub struct AddMediaFileTagsSuccessResponse { + pub success: bool, + + /// The tags from this request after upsert, with canonical tokens and + /// fresh use counts. Tags already on the file are absorbed (no error). + pub tags: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_add_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_add_tags.rs new file mode 100644 index 00000000..16e81f73 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_add_tags.rs @@ -0,0 +1,37 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── POST /v1/tags/bulk_add ── + +/// Exactly one of `maybe_tags` / `maybe_tags_list` must be set (400 if +/// both or neither). Tag text is trimmed and deduped case-insensitively; +/// empty entries are dropped. Must sanitize to at least one tag (400 +/// otherwise). Media file tokens are deduped; tokens the user doesn't +/// own (or that are deleted) are silently skipped. +#[derive(Deserialize)] +pub struct BulkAddTagsRequest { + /// Media files to tag. + pub media_file_tokens: Vec, + + /// Comma-separated tags, e.g. `"cats, Sci-Fi, wallpaper"`. + pub maybe_tags: Option, + + /// Tags as a list. Entries are still trimmed. + pub maybe_tags_list: Option>, +} + +#[derive(Serialize)] +pub struct BulkAddTagsSuccessResponse { + pub success: bool, + + /// The subset of the input tokens that were actually tagged: files + /// that exist, aren't deleted, and are owned by the caller. + pub accepted_media_file_tokens: Vec, + + /// The tags from this request after upsert, with canonical tokens and + /// fresh use counts. + pub tags: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_list_media_file_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_list_media_file_tags.rs new file mode 100644 index 00000000..91d532c2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_list_media_file_tags.rs @@ -0,0 +1,32 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── POST /v1/tags/media_files/bulk_list_tags ── +// +// POST rather than GET: the token list belongs in a request body, and +// GET request bodies are non-standard. The operation is still a pure +// read. + +#[derive(Deserialize)] +pub struct BulkListMediaFileTagsRequest { + /// Media files to look up. Tokens with no tags come back with an + /// empty `tags` list. + pub media_file_tokens: Vec, +} + +#[derive(Serialize)] +pub struct MediaFileTagsEntry { + pub media_file_token: MediaFileToken, + pub tags: Vec, +} + +#[derive(Serialize)] +pub struct BulkListMediaFileTagsSuccessResponse { + pub success: bool, + + /// One entry per requested media file token (deduped), in request order. + pub media_files: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_set_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_set_tags.rs new file mode 100644 index 00000000..caa7a3d7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/bulk_set_tags.rs @@ -0,0 +1,43 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── POST /v1/tags/bulk_set ── + +/// Exactly one of `maybe_tags` / `maybe_tags_list` must be set (400 if +/// both or neither). Tag text is trimmed and deduped case-insensitively; +/// empty entries are dropped. Unlike `bulk_add`, sanitizing down to zero +/// tags is allowed — it clears all tags from the listed media files. +/// Media file tokens are deduped; tokens the user doesn't own (or that +/// are deleted) are silently skipped. +#[derive(Deserialize)] +pub struct BulkSetTagsRequest { + /// Media files whose tag sets will be replaced. + pub media_file_tokens: Vec, + + /// Comma-separated tags, e.g. `"cats, Sci-Fi, wallpaper"`. + pub maybe_tags: Option, + + /// Tags as a list. Entries are still trimmed. + pub maybe_tags_list: Option>, +} + +#[derive(Serialize)] +pub struct BulkSetTagsSuccessResponse { + pub success: bool, + + /// The subset of the input tokens that were actually updated: files + /// that exist, aren't deleted, and are owned by the caller. + pub accepted_media_file_tokens: Vec, + + /// The full tag set now on every accepted media file, with canonical + /// tokens and fresh use counts. + pub tags: Vec, + + /// How many previously-attached tag links were removed across all the + /// accepted media files because they weren't mentioned in the request. + /// (Orphaned tags are not deleted.) + pub removed_count: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/clear_media_file_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/clear_media_file_tags.rs new file mode 100644 index 00000000..2fa03027 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/clear_media_file_tags.rs @@ -0,0 +1,19 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +// ── POST /v1/tags/media_file/clear/{media_file_token} ── + +#[derive(Deserialize)] +pub struct ClearMediaFileTagsPathInfo { + pub media_file_token: MediaFileToken, +} + +#[derive(Serialize)] +pub struct ClearMediaFileTagsSuccessResponse { + pub success: bool, + + /// How many tag links were removed from the media file. (Orphaned + /// tags are not deleted.) + pub removed_count: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/common.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/common.rs new file mode 100644 index 00000000..83763eeb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/common.rs @@ -0,0 +1,19 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::tags::TagToken; + +/// One tag as returned by every tags endpoint. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct TagDetails { + pub tag_token: TagToken, + + /// The display value of the tag, as entered by its creator. + pub tag_value: String, + + /// Lowercased form of `tag_value`. This is the tag's unique key + /// within the creator's account. + pub tag_value_lowercase: String, + + /// Rollup statistic: how many media files currently carry this tag. + pub use_count: u32, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/delete_tag.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/delete_tag.rs new file mode 100644 index 00000000..c2f012da --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/delete_tag.rs @@ -0,0 +1,19 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::tags::TagToken; + +// ── DELETE /v1/tags/{tag_token} ── + +#[derive(Deserialize)] +pub struct DeleteTagPathInfo { + pub tag_token: TagToken, +} + +#[derive(Serialize)] +pub struct DeleteTagSuccessResponse { + pub success: bool, + + /// How many media-file links were hard-deleted along with the tag. + /// (The tag record itself is soft-deleted.) + pub removed_link_count: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/list_media_file_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/list_media_file_tags.rs new file mode 100644 index 00000000..3762b48f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/list_media_file_tags.rs @@ -0,0 +1,20 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── GET /v1/tags/media_file/list/{media_file_token} ── + +#[derive(Deserialize)] +pub struct ListMediaFileTagsPathInfo { + pub media_file_token: MediaFileToken, +} + +#[derive(Serialize)] +pub struct ListMediaFileTagsSuccessResponse { + pub success: bool, + + /// All (live) tags on the media file, sorted by tag value. + pub tags: Vec, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/list_media_files_with_tag.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/list_media_files_with_tag.rs new file mode 100644 index 00000000..3f4d4c80 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/list_media_files_with_tag.rs @@ -0,0 +1,21 @@ +use serde_derive::Deserialize; + +use crate::tokens::tags::TagToken; + +// ── GET /v1/tags/media_files/with_tag/{tag_token} ── +// +// NB: The success response lives in `storyteller_web`'s handler because +// the wire shape embeds `MediaLinks` / `MediaFileCoverImageDetails` +// constructors that depend on the request's `MediaDomain` + +// `ServerEnvironment`. + +#[derive(Deserialize)] +pub struct ListMediaFilesWithTagPathInfo { + pub tag_token: TagToken, +} + +#[derive(Deserialize)] +pub struct ListMediaFilesWithTagQueryParams { + pub cursor: Option, + pub limit: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/list_tagged_media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/list_tagged_media_files.rs new file mode 100644 index 00000000..cf50470f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/list_tagged_media_files.rs @@ -0,0 +1,14 @@ +use serde_derive::Deserialize; + +// ── GET /v1/tags/media_files/list_tagged ── +// +// NB: The success response lives in `storyteller_web`'s handler because +// the wire shape embeds `MediaLinks` / `MediaFileCoverImageDetails` +// constructors that depend on the request's `MediaDomain` + +// `ServerEnvironment`. + +#[derive(Deserialize)] +pub struct ListTaggedMediaFilesQueryParams { + pub cursor: Option, + pub limit: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/list_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/list_tags.rs new file mode 100644 index 00000000..6e10fc18 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/list_tags.rs @@ -0,0 +1,22 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::api_defs::tags::common::TagDetails; + +// ── GET /v1/tags/list ── + +#[derive(Deserialize)] +pub struct ListTagsQueryParams { + pub cursor: Option, + pub limit: Option, +} + +#[derive(Serialize)] +pub struct ListTagsSuccessResponse { + pub success: bool, + + /// The logged-in user's (live) tags, newest first. + pub tags: Vec, + + /// Present when there may be more results; pass back as `cursor`. + pub maybe_cursor: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/list_untagged_media_files.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/list_untagged_media_files.rs new file mode 100644 index 00000000..f099cd3e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/list_untagged_media_files.rs @@ -0,0 +1,14 @@ +use serde_derive::Deserialize; + +// ── GET /v1/tags/media_files/list_untagged ── +// +// NB: The success response lives in `storyteller_web`'s handler because +// the wire shape embeds `MediaLinks` / `MediaFileCoverImageDetails` +// constructors that depend on the request's `MediaDomain` + +// `ServerEnvironment`. + +#[derive(Deserialize)] +pub struct ListUntaggedMediaFilesQueryParams { + pub cursor: Option, + pub limit: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/mod.rs new file mode 100644 index 00000000..cdade59b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/mod.rs @@ -0,0 +1,14 @@ +pub mod add_media_file_tags; +pub mod bulk_add_tags; +pub mod bulk_list_media_file_tags; +pub mod bulk_set_tags; +pub mod clear_media_file_tags; +pub mod common; +pub mod delete_tag; +pub mod list_media_file_tags; +pub mod list_media_files_with_tag; +pub mod list_tagged_media_files; +pub mod list_tags; +pub mod list_untagged_media_files; +pub mod rename_tag; +pub mod set_media_file_tags; diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/rename_tag.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/rename_tag.rs new file mode 100644 index 00000000..51240747 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/rename_tag.rs @@ -0,0 +1,28 @@ +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::tags::TagToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── PUT /v1/tags/rename/{tag_token} ── + +#[derive(Deserialize)] +pub struct RenameTagPathInfo { + pub tag_token: TagToken, +} + +#[derive(Deserialize)] +pub struct RenameTagRequest { + /// The new tag text (trimmed server-side). Both case-only changes and + /// wholesale renames are allowed. Fails with 400 if the caller already + /// has a different tag with the same lowercased value. + pub new_tag_value: String, +} + +#[derive(Serialize)] +pub struct RenameTagSuccessResponse { + pub success: bool, + + /// The tag after the rename. + pub tag: TagDetails, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/tags/set_media_file_tags.rs b/crates/api_clients/artcraft_client/src/api_defs/tags/set_media_file_tags.rs new file mode 100644 index 00000000..0aa9fc02 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/tags/set_media_file_tags.rs @@ -0,0 +1,38 @@ +use serde_derive::{Deserialize, Serialize}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api_defs::tags::common::TagDetails; + +// ── POST /v1/tags/media_file/set/{media_file_token} ── + +#[derive(Deserialize)] +pub struct SetMediaFileTagsPathInfo { + pub media_file_token: MediaFileToken, +} + +/// Exactly one of `maybe_tags` / `maybe_tags_list` must be set (400 if +/// both or neither). Tag text is trimmed and deduped case-insensitively; +/// empty entries are dropped. Unlike `add`, sanitizing down to zero tags +/// is allowed — it clears all tags from the media file. +#[derive(Deserialize)] +pub struct SetMediaFileTagsRequest { + /// Comma-separated tags, e.g. `"cats, Sci-Fi, wallpaper"`. + pub maybe_tags: Option, + + /// Tags as a list. Entries are still trimmed. + pub maybe_tags_list: Option>, +} + +#[derive(Serialize)] +pub struct SetMediaFileTagsSuccessResponse { + pub success: bool, + + /// The media file's full tag set after the operation, with canonical + /// tokens and fresh use counts. + pub tags: Vec, + + /// How many previously-attached tag links were removed because they + /// weren't mentioned in the request. (Orphaned tags are not deleted.) + pub removed_count: u64, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/create_referral_code.rs b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/create_referral_code.rs new file mode 100644 index 00000000..8858a9e6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/create_referral_code.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::user_referral_codes::UserReferralCodeToken; + +#[derive(Deserialize)] +pub struct CreateReferralCodeRequest { + /// The referral code string. Alphanumeric plus underscore, period, dash. + pub code: String, +} + +#[derive(Serialize)] +pub struct CreateReferralCodeResponse { + pub success: bool, + pub token: UserReferralCodeToken, + pub code: String, + pub code_lowercase: String, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/delete_referral_code.rs b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/delete_referral_code.rs new file mode 100644 index 00000000..2a786f18 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/delete_referral_code.rs @@ -0,0 +1,12 @@ +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::user_referral_codes::UserReferralCodeToken; + +#[derive(Deserialize)] +pub struct DeleteReferralCodePathInfo { + pub token: UserReferralCodeToken, +} + +#[derive(Serialize)] +pub struct DeleteReferralCodeResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/list_referral_codes.rs b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/list_referral_codes.rs new file mode 100644 index 00000000..38bd8fc8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/list_referral_codes.rs @@ -0,0 +1,18 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; +use crate::tokens::user_referral_codes::UserReferralCodeToken; + +#[derive(Serialize)] +pub struct ListReferralCodesResponse { + pub success: bool, + pub referral_codes: Vec, +} + +#[derive(Serialize)] +pub struct ReferralCodeEntry { + pub token: UserReferralCodeToken, + pub code: String, + pub code_lowercase: String, + pub created_at: DateTime, + pub updated_at: DateTime, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/mod.rs new file mode 100644 index 00000000..97274226 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/user_referral_codes/mod.rs @@ -0,0 +1,3 @@ +pub mod create_referral_code; +pub mod delete_referral_code; +pub mod list_referral_codes; diff --git a/crates/api_clients/artcraft_client/src/api_defs/users/change_password.rs b/crates/api_clients/artcraft_client/src/api_defs/users/change_password.rs new file mode 100644 index 00000000..68991b45 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/users/change_password.rs @@ -0,0 +1,12 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize)] +pub struct ChangePasswordRequest { + pub password: String, + pub password_confirmation: String, +} + +#[derive(Serialize, Deserialize)] +pub struct ChangePasswordResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/users/edit_email.rs b/crates/api_clients/artcraft_client/src/api_defs/users/edit_email.rs new file mode 100644 index 00000000..ad82e246 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/users/edit_email.rs @@ -0,0 +1,11 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize)] +pub struct EditEmailRequest { + pub email_address: String, +} + +#[derive(Serialize, Deserialize)] +pub struct EditEmailResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/users/edit_username.rs b/crates/api_clients/artcraft_client/src/api_defs/users/edit_username.rs new file mode 100644 index 00000000..bf7071c7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/users/edit_username.rs @@ -0,0 +1,11 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize)] +pub struct EditUsernameRequest { + pub display_name: String, +} + +#[derive(Serialize, Deserialize)] +pub struct EditUsernameResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/users/login.rs b/crates/api_clients/artcraft_client/src/api_defs/users/login.rs new file mode 100644 index 00000000..f72efe89 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/users/login.rs @@ -0,0 +1,34 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize)] +pub struct LoginRequest { + pub username_or_email: String, + pub password: String, +} + +#[derive(Serialize, Deserialize)] +pub struct LoginSuccessResponse { + pub success: bool, + + /// A signed session that can be sent as a header, bypassing cookies. + /// This is useful for API clients that don't support cookies or Google + /// browsers killing cross-domain cookies. + pub signed_session: String, +} + +/// Error body returned by `/v1/login` on 401/500 responses. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct LoginErrorResponse { + pub success: bool, + pub error_type: LoginErrorType, + pub error_message: String, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub enum LoginErrorType { + /// Account was created without a password and the user needs to create one + AccountNeedsPassword, + /// Invalid login credentials were supplied + InvalidCredentials, + ServerError, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/users/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/users/mod.rs new file mode 100644 index 00000000..a2a81c81 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/users/mod.rs @@ -0,0 +1,5 @@ +pub mod change_password; +pub mod edit_email; +pub mod edit_username; +pub mod login; +pub mod session_info; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/users/session_info.rs b/crates/api_clients/artcraft_client/src/api_defs/users/session_info.rs new file mode 100644 index 00000000..3c49aadf --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/users/session_info.rs @@ -0,0 +1,98 @@ +use crate::api_defs::common::responses::user_details_light::UserDetailsLight; +use crate::enums::by_table::users::user_feature_flag::UserFeatureFlag; +use serde_derive::Serialize; +use std::collections::BTreeSet; +use crate::tokens::users::UserToken; + +#[derive(Serialize, Copy, Clone)] +#[serde(rename_all = "snake_case")] +pub enum FakeYouPlan { + Free, + Basic, + Standard, + Pro, +} + +#[derive(Serialize, Copy, Clone)] +#[serde(rename_all = "snake_case")] +pub enum StorytellerStreamPlan { + Free, + Basic, + Standard, + Pro, +} + +#[derive(Serialize)] +pub struct SessionUserInfo { + pub core_info: UserDetailsLight, + + pub user_token: UserToken, + pub username: String, + pub display_name: String, + pub email_gravatar_hash: String, + + pub onboarding: SessionOnboardingState, + + // TODO(bt,2024-03-30): Remove legacy feature flag + #[deprecated(note = "DO NOT USE. Use `maybe_feature_flags` instead! The flag you're looking for is `studio`.")] + pub can_access_studio: bool, + + /// Collection of feature / rollout flags + /// This is the proper place to detect if a user has access to some rollout (non-paywall) feature. + /// NB: The BTreeSet maintains order so React doesn't introduce re-render state bugs when order changes + pub maybe_feature_flags: BTreeSet, + + // Premium plans: + #[deprecated(note = "DO NOT USE. This was never used and is 100% meaningless.")] + pub fakeyou_plan: FakeYouPlan, + + #[deprecated(note = "DO NOT USE. This was never used and is 100% meaningless.")] + pub storyteller_stream_plan: StorytellerStreamPlan, + + // Usage permissions: + pub can_use_tts: bool, + pub can_use_w2l: bool, + pub can_delete_own_tts_results: bool, + pub can_delete_own_w2l_results: bool, + pub can_delete_own_account: bool, + + // Contribution permissions: + pub can_upload_tts_models: bool, + pub can_upload_w2l_templates: bool, + pub can_delete_own_tts_models: bool, + pub can_delete_own_w2l_templates: bool, + + // Moderation permissions: + pub can_approve_w2l_templates: bool, + pub can_edit_other_users_profiles: bool, + pub can_edit_other_users_tts_models: bool, + pub can_edit_other_users_w2l_templates: bool, + pub can_delete_other_users_tts_models: bool, + pub can_delete_other_users_tts_results: bool, + pub can_delete_other_users_w2l_templates: bool, + pub can_delete_other_users_w2l_results: bool, + pub can_ban_users: bool, + pub can_delete_users: bool, +} + +#[derive(Serialize)] +pub struct SessionOnboardingState { + /// If true, the user hasn't set their email. + pub email_not_set: bool, + + /// If true, the user hasn't confirmed their email. + pub email_not_confirmed: bool, + + /// If true, the user hasn't set their password. + pub password_not_set: bool, + + /// If true, the user hasn't set their username (the username they have is random). + pub username_not_customized: bool, +} + +#[derive(Serialize)] +pub struct SessionInfoSuccessResponse { + pub success: bool, + pub logged_in: bool, + pub user: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/utils/media_links_to_thumbnail_template.rs b/crates/api_clients/artcraft_client/src/api_defs/utils/media_links_to_thumbnail_template.rs new file mode 100644 index 00000000..57a389c2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/utils/media_links_to_thumbnail_template.rs @@ -0,0 +1,12 @@ +use crate::api_defs::common::responses::media_links::MediaLinks; + +/// Get the thumbnail template for either images or videos. +pub fn media_links_to_thumbnail_template(links: &MediaLinks) -> Option<&str> { + // NB: We only populate video previews for video tasks. + if let Some(video) = links.maybe_video_previews.as_ref() { + return Some(&video.animated_thumbnail_template); + } + + // Image case - use the image thumbnail template if it exists. + links.maybe_thumbnail_template.as_deref() +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/utils/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/utils/mod.rs new file mode 100644 index 00000000..a9155d7e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/utils/mod.rs @@ -0,0 +1 @@ +pub mod media_links_to_thumbnail_template; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/api_defs/video_info/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/video_info/mod.rs new file mode 100644 index 00000000..af59a001 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/video_info/mod.rs @@ -0,0 +1,3 @@ +pub mod notes; +pub mod read_only; +pub mod upload; diff --git a/crates/api_clients/artcraft_client/src/api_defs/video_info/notes.rs b/crates/api_clients/artcraft_client/src/api_defs/video_info/notes.rs new file mode 100644 index 00000000..98d28812 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/video_info/notes.rs @@ -0,0 +1,59 @@ +//! Request/response types for `POST /v1/video_info/notes`. +//! +//! A note is user-submitted context about an uploaded video (what model they +//! believe it is, where it came from, free-form comments). Always tied to an +//! [`UploadedVideoToken`]; pass a [`UploadVideoNoteToken`] to update an existing +//! note instead of creating a new one. + +use serde_derive::{Deserialize, Serialize}; + +use crate::enums::by_table::uploaded_video_notes::uploaded_video_note_reported_model_type::UploadedVideoNoteReportedModelType; +use crate::enums::by_table::uploaded_video_notes::uploaded_video_note_reported_website::UploadedVideoNoteReportedWebsite; +use crate::tokens::uploaded_video_notes::UploadVideoNoteToken; +use crate::tokens::uploaded_videos::UploadedVideoToken; + +/// Request body for `POST /v1/video_info/notes`. +#[derive(Deserialize, Debug, Clone)] +pub struct VideoInfoNoteRequest { + /// The uploaded video this note is about. Required. + pub uploaded_video_token: UploadedVideoToken, + + /// If present, update this existing note instead of creating a new one. + pub maybe_uploaded_video_note_token: Option, + + /// Original filename of the submitted clip. + pub maybe_filename: Option, + + /// The model type the submitter claims this video is (dropdown / enum). + pub maybe_reported_model_type: Option, + + /// Free-form custom model name (trimmed; empty becomes absent). + pub maybe_reported_model_name: Option, + + /// The website / platform the video came from (dropdown / enum). + pub maybe_website: Option, + + /// Free-form website (trimmed; empty becomes absent). + pub maybe_other_website: Option, + + /// Free-form comments (trimmed; empty becomes absent). + pub maybe_comments: Option, + + /// Optional contact email (trimmed; empty becomes absent). + pub maybe_email_address: Option, + + /// Whether the submitter consents to us sharing the report. Defaults to false. + pub can_share_report: Option, + + /// Whether the submitter believes they were scammed. Defaults to false. + pub was_scammed: Option, +} + +/// Response body for `POST /v1/video_info/notes`. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct VideoInfoNoteResponse { + pub success: bool, + + /// The created or updated note's token (e.g. `uvnote_…`). + pub uploaded_video_note_token: UploadVideoNoteToken, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/video_info/read_only.rs b/crates/api_clients/artcraft_client/src/api_defs/video_info/read_only.rs new file mode 100644 index 00000000..4e8e6192 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/video_info/read_only.rs @@ -0,0 +1,166 @@ +//! Response types for `POST /v1/video_info/read_only`. +//! +//! The endpoint accepts a `multipart/form-data` video upload, inspects its +//! embedded provenance (C2PA manifests, AIGC labels, in-stream watermarks), and +//! returns what it found. These are the public, wire-stable API types — they +//! deliberately mirror, but do not re-export, the internal `video_info` crate +//! types so the parsing library can evolve independently of the HTTP contract. + +use serde_derive::{Deserialize, Serialize}; + +/// Response for `POST /v1/video_info/read_only`. +/// +/// [`kind`](Self::kind) names the detected provenance family; the matching +/// `maybe_*` field carries its details (all others are `null`). `unrecognized` +/// means no supported provenance was found — [`maybe_encoder`](Self::maybe_encoder) +/// still reports the container encoder tag when present (an `Lavf…` value means +/// the file was re-encoded through ffmpeg, which strips provenance). +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct VideoInfoReadOnlyResponse { + pub success: bool, + + /// Which provenance family was detected (if any). + pub kind: VideoProvenanceKind, + + /// The container `©too` encoder tag, e.g. `"Lavf60.16.100"` or `"Google"`. + pub maybe_encoder: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Seedance`]. + pub maybe_seedance: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Veo`]. + pub maybe_veo: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Sora`]. + pub maybe_sora: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Dreamina`]. + pub maybe_dreamina: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Kling`]. + pub maybe_kling: Option, +} + +/// The recognized AI-video provenance family. +#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum VideoProvenanceKind { + /// ByteDance Seedance API (Volcengine / BytePlus C2PA). + Seedance, + /// Google Veo (Google Generative AI video C2PA). + Veo, + /// OpenAI Sora (OpenAI Generative AI video C2PA). + Sora, + /// Dreamina (ByteDance/CapCut consumer app `ilst` metadata). + Dreamina, + /// Kling (Kuaishou AIGC-label / in-stream watermark). + Kling, + /// No supported provenance was found (often a re-encoded / stripped file). + Unrecognized, +} + +/// Seedance (ByteDance) provenance from an embedded C2PA manifest. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct SeedanceVideoInfo { + /// `"volcengine"` or `"byteplus"`. + pub platform: String, + /// C2PA `softwareAgent`, e.g. `"Volcengine_Ark_CN"`. + pub software_agent: String, + pub maybe_software_agent_version: Option, + /// Full model identifier, e.g. `"doubao-seedance-2-0-fast"`. + pub model_name: String, + pub maybe_model_brand: Option, + /// Parsed version, e.g. `"2.0"` / `"1.0"`. + pub maybe_model_version: Option, + pub is_fast: bool, + pub is_lite: bool, + /// Raw generation timestamp string (RFC 3339). + pub generated_at: String, + /// Normalized RFC 3339 timestamp, when parseable. + pub maybe_generated_at_utc: Option, + pub maybe_log_id: Option, + pub maybe_log_id_decoded_hex: Option, + pub maybe_digital_source_type: Option, + pub maybe_claim_generator: Option, + pub maybe_claim_generator_version: Option, + pub maybe_manifest_id: Option, + pub maybe_instance_id: Option, + pub maybe_signer_email: Option, + pub maybe_signer_org_id: Option, + pub maybe_signer_country: Option, + pub maybe_cert_serial: Option, +} + +/// Google Veo provenance. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct VeoVideoInfo { + /// Always `"Google"`. + pub producer: String, + /// Whether a full Google C2PA manifest is present (`false` = recognized only + /// by the `encoder=Google` tag, C2PA likely stripped by a re-encode). + pub has_c2pa_manifest: bool, + pub maybe_encoder: Option, + pub maybe_created_description: Option, + pub has_synthid_watermark: bool, + pub maybe_synthid_description: Option, + pub maybe_digital_source_type: Option, + pub maybe_claim_generator: Option, + pub maybe_claim_generator_version: Option, + pub maybe_manifest_id: Option, + pub maybe_instance_id: Option, + pub maybe_cert_serial: Option, + /// Issuing intermediate-CA common name, e.g. `"Google C2PA Media Services 1P ICA G3"`. + pub maybe_signer_ca: Option, + /// Whether the manifest carries an RFC 3161 trusted timestamp. + pub is_timestamped: bool, + pub maybe_timestamp_authority: Option, +} + +/// OpenAI Sora provenance. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct SoraVideoInfo { + /// Always `"OpenAI"`. + pub producer: String, + pub maybe_model_name: Option, + pub maybe_created_description: Option, + pub maybe_digital_source_type: Option, + pub maybe_claim_generator: Option, + pub maybe_manifest_id: Option, + pub maybe_instance_id: Option, + pub maybe_cert_serial: Option, +} + +/// Dreamina (ByteDance/CapCut app) provenance from `ilst` metadata. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct DreaminaVideoInfo { + /// The product string, e.g. `"dreamina"`. + pub product: String, + pub maybe_export_type: Option, + pub maybe_os: Option, + pub maybe_source_info: Option, + pub maybe_aigc_label_type: Option, + pub maybe_video_id: Option, + pub has_c2pa: bool, + pub maybe_signer_org_id: Option, + pub maybe_signer_country: Option, + pub maybe_cert_serial: Option, +} + +/// Kling (Kuaishou) provenance from the AIGC label and/or in-stream watermark. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct KlingVideoInfo { + /// Model version when a clean export embeds it (e.g. `"2.5-pro"`); usually `null`. + pub maybe_model_version: Option, + /// Whether labeled AI-generated (`Label == "1"`, per China GB 45438). + pub is_ai_generated: bool, + pub maybe_label: Option, + pub maybe_content_producer: Option, + pub maybe_produce_id: Option, + pub maybe_content_propagator: Option, + pub maybe_propagate_id: Option, + pub maybe_reserved_code_1: Option, + pub maybe_reserved_code_2: Option, + /// Whether the in-stream `kling-ai` SEI watermark is present. + pub has_stream_watermark: bool, + pub maybe_watermark_uuid: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/video_info/upload.rs b/crates/api_clients/artcraft_client/src/api_defs/video_info/upload.rs new file mode 100644 index 00000000..fe1df628 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/video_info/upload.rs @@ -0,0 +1,45 @@ +//! Response type for `POST /v1/video_info/upload`. +//! +//! Same detected provenance as the read-only endpoint, plus the persisted +//! [`UploadedVideoToken`] (used for follow-up requests, e.g. attaching a note). + +use serde_derive::{Deserialize, Serialize}; + +use crate::tokens::uploaded_videos::UploadedVideoToken; + +use crate::api_defs::video_info::read_only::{ + DreaminaVideoInfo, KlingVideoInfo, SeedanceVideoInfo, SoraVideoInfo, VeoVideoInfo, + VideoProvenanceKind, +}; + +/// Response for `POST /v1/video_info/upload`. Mirrors +/// [`crate::api_defs::video_info::read_only::VideoInfoReadOnlyResponse`] and adds the +/// persisted record's token. +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct VideoInfoUploadResponse { + pub success: bool, + + /// The persisted `uploaded_videos` record token (e.g. `uvt_…`). + pub uploaded_video_token: UploadedVideoToken, + + /// Which provenance family was detected (if any). + pub kind: VideoProvenanceKind, + + /// The container `©too` encoder tag, e.g. `"Lavf60.16.100"` or `"Google"`. + pub maybe_encoder: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Seedance`]. + pub maybe_seedance: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Veo`]. + pub maybe_veo: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Sora`]. + pub maybe_sora: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Dreamina`]. + pub maybe_dreamina: Option, + + /// Present when [`kind`](Self::kind) is [`VideoProvenanceKind::Kling`]. + pub maybe_kling: Option, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/web_referrals/log_web_referral.rs b/crates/api_clients/artcraft_client/src/api_defs/web_referrals/log_web_referral.rs new file mode 100644 index 00000000..7a8dee45 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/web_referrals/log_web_referral.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; + +pub const LOG_WEB_REFERRAL_URL_PATH: &str = "/v1/web_referrals/record"; + +#[derive(Deserialize)] +pub struct LogWebReferralRequest { + /// Optional: The referral URL the user arrived from when signing up. + /// The browser can send `document.referrer` to the backend so we know how people are finding us. + /// If the browser doesn't send this parameter, we'll try the `referer` header. + pub maybe_referral_url: Option, +} + +#[derive(Serialize)] +pub struct LogWebReferralResponse { + pub success: bool, +} diff --git a/crates/api_clients/artcraft_client/src/api_defs/web_referrals/mod.rs b/crates/api_clients/artcraft_client/src/api_defs/web_referrals/mod.rs new file mode 100644 index 00000000..ea486b9a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/api_defs/web_referrals/mod.rs @@ -0,0 +1 @@ +pub mod log_web_referral; diff --git a/crates/api_clients/artcraft_client/src/credentials/api_or_web_creds.rs b/crates/api_clients/artcraft_client/src/credentials/api_or_web_creds.rs new file mode 100644 index 00000000..9ed58ec7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/credentials/api_or_web_creds.rs @@ -0,0 +1,125 @@ +use crate::credentials::storyteller_avt_cookie::StorytellerAvtCookie; +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::credentials::storyteller_session_cookie::StorytellerSessionCookie; + +/// Credentials for endpoints that authenticate as either a web session +/// (cookies) or an API key (`Authorization` header). +#[derive(Clone)] +pub enum ApiOrWebCreds { + Web(WebCreds), + Api(ApiKey), +} + +/// Website session cookies: the anonymous visitor token and/or the +/// logged-in session cookie. +#[derive(Clone)] +pub struct WebCreds { + pub maybe_avt: Option, + pub maybe_session: Option, +} + +/// An Artcraft API key secret, sent as an `Authorization: Bearer` header. +#[derive(Clone)] +pub struct ApiKey { + api_key: String, +} + +impl ApiOrWebCreds { + /// The header this credential contributes to a request, as a + /// `(name, value)` pair. `None` for a web credential with no cookies set. + pub fn maybe_as_header(&self) -> Option<(&'static str, String)> { + match self { + Self::Web(web_creds) => { + web_creds.maybe_as_cookie_header() + .map(|value| ("Cookie", value)) + } + Self::Api(api_key) => { + Some(("Authorization", api_key.as_authorization_header_value())) + } + } + } +} + +impl From<&StorytellerCredentialSet> for ApiOrWebCreds { + fn from(creds: &StorytellerCredentialSet) -> Self { + Self::Web(WebCreds::from(creds)) + } +} + +impl WebCreds { + pub fn maybe_as_cookie_header(&self) -> Option { + let mut cookies = Vec::new(); + + if let Some(avt) = &self.maybe_avt { + cookies.push(avt.as_cookie_header()); + } + + if let Some(session) = &self.maybe_session { + cookies.push(session.as_cookie_header()); + } + + if cookies.is_empty() { + None + } else { + Some(cookies.join("; ")) + } + } +} + +impl From<&StorytellerCredentialSet> for WebCreds { + fn from(creds: &StorytellerCredentialSet) -> Self { + Self { + maybe_avt: creds.avt.clone(), + maybe_session: creds.session.clone(), + } + } +} + +impl ApiKey { + pub fn new(api_key: String) -> Self { + Self { api_key } + } + + pub fn as_authorization_header_value(&self) -> String { + format!("Bearer {}", self.api_key) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const SAMPLE_KEY: &str = "artcraft_api_55ax0zhd580m598r6n4n7szdwjb2b28sypapvawh"; + + mod header_tests { + use super::*; + + #[test] + fn api_key_bearer_header() { + let creds = ApiOrWebCreds::Api(ApiKey::new(SAMPLE_KEY.to_string())); + assert_eq!( + creds.maybe_as_header(), + Some(("Authorization", format!("Bearer {SAMPLE_KEY}")))); + } + + #[test] + fn web_creds_cookie_header() { + let creds = ApiOrWebCreds::Web(WebCreds { + maybe_avt: Some(StorytellerAvtCookie::new("bob".to_string())), + maybe_session: Some(StorytellerSessionCookie::new("alice".to_string())), + }); + assert_eq!( + creds.maybe_as_header(), + Some(("Cookie", "visitor=bob; session=alice".to_string()))); + } + + #[test] + fn empty_web_creds_no_header() { + let creds = ApiOrWebCreds::Web(WebCreds { + maybe_avt: None, + maybe_session: None, + }); + assert_eq!(creds.maybe_as_header(), None); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/credentials/mod.rs b/crates/api_clients/artcraft_client/src/credentials/mod.rs new file mode 100644 index 00000000..b2a57b40 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/credentials/mod.rs @@ -0,0 +1,5 @@ +pub mod api_or_web_creds; +pub mod parse_multi_cookie_header; +pub mod storyteller_avt_cookie; +pub mod storyteller_credential_set; +pub mod storyteller_session_cookie; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/credentials/parse_multi_cookie_header.rs b/crates/api_clients/artcraft_client/src/credentials/parse_multi_cookie_header.rs new file mode 100644 index 00000000..50630fe4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/credentials/parse_multi_cookie_header.rs @@ -0,0 +1,35 @@ +use crate::credentials::storyteller_avt_cookie::StorytellerAvtCookie; +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::credentials::storyteller_session_cookie::StorytellerSessionCookie; +use cookie::Cookie; + +/// Parses a multi-cookie header string (e.g. `"visitor=abc; session=xyz"`) and extracts +/// the known Storyteller cookies by name. +/// +/// Returns `Ok(Some(...))` if at least one recognised cookie is present, +/// `Ok(None)` if the input is empty or contains no recognised cookies, +/// and `Err` if any individual cookie segment fails to parse. +pub fn parse_multi_cookie_header(header: &str) -> Result, cookie::ParseError> { + let mut avt: Option = None; + let mut session: Option = None; + + for segment in header.split(';') { + let segment = segment.trim(); + if segment.is_empty() { + continue; + } + let cookie = Cookie::parse(segment.to_owned())?; + if avt.is_none() { + avt = StorytellerAvtCookie::maybe_from_cookie(&cookie); + } + if session.is_none() { + session = StorytellerSessionCookie::maybe_from_cookie(&cookie); + } + } + + if avt.is_none() && session.is_none() { + return Ok(None); + } + + Ok(Some(StorytellerCredentialSet::initialize(avt, session))) +} diff --git a/crates/api_clients/artcraft_client/src/credentials/storyteller_avt_cookie.rs b/crates/api_clients/artcraft_client/src/credentials/storyteller_avt_cookie.rs new file mode 100644 index 00000000..fedd0c9f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/credentials/storyteller_avt_cookie.rs @@ -0,0 +1,44 @@ +use cookie::Cookie; + +const AVT_COOKIE_NAME : &str = "visitor"; + +/// The "anonymous visitor token" cookie allows users to interact with +/// the service in a logged-out state with some continuity. +#[derive(Clone)] +pub struct StorytellerAvtCookie { + cookie: String, +} + +impl StorytellerAvtCookie { + pub fn new(cookie: String) -> Self { + Self { cookie } + } + + pub fn maybe_from_cookie(cookie: &Cookie) -> Option { + if cookie.name() == AVT_COOKIE_NAME { + Some(Self::new(cookie.value().to_string())) + } else { + None + } + } + + pub fn as_str(&self) -> &str { + &self.cookie + } + + pub fn as_bytes(&self) -> &[u8] { + self.cookie.as_bytes() + } + + pub fn to_string(&self) -> String { + self.cookie.clone() + } + + pub fn equals(&self, other: &Self) -> bool { + self.cookie == other.cookie + } + + pub fn as_cookie_header(&self) -> String { + format!("{}={}", AVT_COOKIE_NAME, self.cookie) + } +} diff --git a/crates/api_clients/artcraft_client/src/credentials/storyteller_credential_set.rs b/crates/api_clients/artcraft_client/src/credentials/storyteller_credential_set.rs new file mode 100644 index 00000000..3d2d69e1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/credentials/storyteller_credential_set.rs @@ -0,0 +1,141 @@ +use crate::credentials::parse_multi_cookie_header::parse_multi_cookie_header; +use crate::credentials::storyteller_avt_cookie::StorytellerAvtCookie; +use crate::credentials::storyteller_session_cookie::StorytellerSessionCookie; + +#[derive(Clone)] +pub struct StorytellerCredentialSet { + pub avt: Option, + pub session: Option, +} + +impl StorytellerCredentialSet { + pub fn empty() -> Self { + Self { + avt: None, + session: None, + } + } + + pub fn initialize( + avt: Option, + session: Option, + ) -> Self { + Self { + avt, + session, + } + } + + pub fn parse_multi_cookie_header(header: &str) -> Result, cookie::ParseError> { + parse_multi_cookie_header(header) + } + + pub fn initialize_with_just_cookie(session: StorytellerSessionCookie) -> Self { + Self { + avt: None, + session: Some(session), + } + } + + pub fn initialize_with_just_avt(avt: StorytellerAvtCookie) -> Self { + Self { + avt: Some(avt), + session: None, + } + } + + pub fn is_empty(&self) -> bool { + self.avt.is_none() && self.session.is_none() + } + + pub fn equals(&self, other: &Self) -> bool { + match (&self.avt, &other.avt) { + (None, None) => {} // Fallthrough + (Some(avt), Some(other_avt)) => { + if !avt.equals(other_avt) { + return false; + } + } + _ => return false, + } + + match (&self.session, &other.session) { + (None, None) => {} // Fallthrough + (Some(session), Some(other_session)) => { + if !session.equals(other_session) { + return false; + } + } + _ => return false, + } + + true + } + + pub fn maybe_as_cookie_header(&self) -> Option { + let mut cookies = Vec::new(); + + if let Some(avt) = &self.avt { + cookies.push(avt.as_cookie_header()); + } + + if let Some(session) = &self.session { + cookies.push(session.as_cookie_header()); + } + + if cookies.is_empty() { + None + } else { + Some(cookies.join("; ")) + } + } +} + +#[cfg(test)] +mod tests { + use crate::credentials::storyteller_avt_cookie::StorytellerAvtCookie; + use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; + use crate::credentials::storyteller_session_cookie::StorytellerSessionCookie; + + mod cookies_header { + use super::*; + + #[test] + fn no_cookie() { + let creds = StorytellerCredentialSet::empty(); + let header = creds.maybe_as_cookie_header(); + assert_eq!(header, None); + } + + #[test] + fn avt_cookies_header() { + let creds = StorytellerCredentialSet::initialize_with_just_avt( + StorytellerAvtCookie::new("bob".to_string()), + ); + + let header = creds.maybe_as_cookie_header(); + assert_eq!(header, Some("visitor=bob".to_string())); + } + + #[test] + fn session_cookies_header() { + let creds = StorytellerCredentialSet::initialize_with_just_cookie( + StorytellerSessionCookie::new("bob".to_string()), + ); + + let header = creds.maybe_as_cookie_header(); + assert_eq!(header, Some("session=bob".to_string())); + } + + #[test] + fn both_cookies_header() { + let creds = StorytellerCredentialSet::initialize( + Some(StorytellerAvtCookie::new("bob".to_string())), + Some(StorytellerSessionCookie::new("alice".to_string())), + ); + + let header = creds.maybe_as_cookie_header(); + assert_eq!(header, Some("visitor=bob; session=alice".to_string())); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/credentials/storyteller_session_cookie.rs b/crates/api_clients/artcraft_client/src/credentials/storyteller_session_cookie.rs new file mode 100644 index 00000000..fd089e4a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/credentials/storyteller_session_cookie.rs @@ -0,0 +1,43 @@ +use cookie::Cookie; + +const SESSION_COOKIE_NAME : &str = "session"; + +/// The primary FakeYou / Storyteller / Artcraft backend session identifier. +#[derive(Clone)] +pub struct StorytellerSessionCookie { + cookie: String, +} + +impl StorytellerSessionCookie { + pub fn new(cookie: String) -> Self { + Self { cookie } + } + + pub fn maybe_from_cookie(cookie: &Cookie) -> Option { + if cookie.name() == SESSION_COOKIE_NAME { + Some(Self::new(cookie.value().to_string())) + } else { + None + } + } + + pub fn as_str(&self) -> &str { + &self.cookie + } + + pub fn as_bytes(&self) -> &[u8] { + self.cookie.as_bytes() + } + + pub fn to_string(&self) -> String { + self.cookie.clone() + } + + pub fn equals(&self, other: &Self) -> bool { + self.cookie == other.cookie + } + + pub fn as_cookie_header(&self) -> String { + format!("{}={}", SESSION_COOKIE_NAME, self.cookie) + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_aspect_ratio.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_aspect_ratio.rs new file mode 100644 index 00000000..c88e2557 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_aspect_ratio.rs @@ -0,0 +1,131 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonAspectRatio` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientAspectRatio { + Auto, + Square, + WideThreeByTwo, + WideFourByThree, + WideFiveByFour, + WideSixteenByNine, + WideTwentyOneByNine, + TallTwoByThree, + TallThreeByFour, + TallFourByFive, + TallNineBySixteen, + TallNineByTwentyOne, + Wide, + Tall, + Auto2k, + Auto3k, + Auto4k, + SquareHd, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientAspectRatio { + fn from(value: String) -> Self { + match value.as_str() { + "auto" => Self::Auto, + "square" => Self::Square, + "wide_three_by_two" => Self::WideThreeByTwo, + "wide_four_by_three" => Self::WideFourByThree, + "wide_five_by_four" => Self::WideFiveByFour, + "wide_sixteen_by_nine" => Self::WideSixteenByNine, + "wide_twenty_one_by_nine" => Self::WideTwentyOneByNine, + "tall_two_by_three" => Self::TallTwoByThree, + "tall_three_by_four" => Self::TallThreeByFour, + "tall_four_by_five" => Self::TallFourByFive, + "tall_nine_by_sixteen" => Self::TallNineBySixteen, + "tall_nine_by_twenty_one" => Self::TallNineByTwentyOne, + "wide" => Self::Wide, + "tall" => Self::Tall, + "auto_2k" => Self::Auto2k, + "auto_3k" => Self::Auto3k, + "auto_4k" => Self::Auto4k, + "square_hd" => Self::SquareHd, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientAspectRatio) -> Self { + match value { + ApiClientAspectRatio::Auto => "auto".to_string(), + ApiClientAspectRatio::Square => "square".to_string(), + ApiClientAspectRatio::WideThreeByTwo => "wide_three_by_two".to_string(), + ApiClientAspectRatio::WideFourByThree => "wide_four_by_three".to_string(), + ApiClientAspectRatio::WideFiveByFour => "wide_five_by_four".to_string(), + ApiClientAspectRatio::WideSixteenByNine => "wide_sixteen_by_nine".to_string(), + ApiClientAspectRatio::WideTwentyOneByNine => "wide_twenty_one_by_nine".to_string(), + ApiClientAspectRatio::TallTwoByThree => "tall_two_by_three".to_string(), + ApiClientAspectRatio::TallThreeByFour => "tall_three_by_four".to_string(), + ApiClientAspectRatio::TallFourByFive => "tall_four_by_five".to_string(), + ApiClientAspectRatio::TallNineBySixteen => "tall_nine_by_sixteen".to_string(), + ApiClientAspectRatio::TallNineByTwentyOne => "tall_nine_by_twenty_one".to_string(), + ApiClientAspectRatio::Wide => "wide".to_string(), + ApiClientAspectRatio::Tall => "tall".to_string(), + ApiClientAspectRatio::Auto2k => "auto_2k".to_string(), + ApiClientAspectRatio::Auto3k => "auto_3k".to_string(), + ApiClientAspectRatio::Auto4k => "auto_4k".to_string(), + ApiClientAspectRatio::SquareHd => "square_hd".to_string(), + ApiClientAspectRatio::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientAspectRatio = serde_json::from_str("\"auto\"").unwrap(); + assert_eq!(parsed, ApiClientAspectRatio::Auto); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"auto\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientAspectRatio = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientAspectRatio::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientAspectRatio::Auto, "auto"), + (ApiClientAspectRatio::Square, "square"), + (ApiClientAspectRatio::WideThreeByTwo, "wide_three_by_two"), + (ApiClientAspectRatio::WideFourByThree, "wide_four_by_three"), + (ApiClientAspectRatio::WideFiveByFour, "wide_five_by_four"), + (ApiClientAspectRatio::WideSixteenByNine, "wide_sixteen_by_nine"), + (ApiClientAspectRatio::WideTwentyOneByNine, "wide_twenty_one_by_nine"), + (ApiClientAspectRatio::TallTwoByThree, "tall_two_by_three"), + (ApiClientAspectRatio::TallThreeByFour, "tall_three_by_four"), + (ApiClientAspectRatio::TallFourByFive, "tall_four_by_five"), + (ApiClientAspectRatio::TallNineBySixteen, "tall_nine_by_sixteen"), + (ApiClientAspectRatio::TallNineByTwentyOne, "tall_nine_by_twenty_one"), + (ApiClientAspectRatio::Wide, "wide"), + (ApiClientAspectRatio::Tall, "tall"), + (ApiClientAspectRatio::Auto2k, "auto_2k"), + (ApiClientAspectRatio::Auto3k, "auto_3k"), + (ApiClientAspectRatio::Auto4k, "auto_4k"), + (ApiClientAspectRatio::SquareHd, "square_hd"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientAspectRatio = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_audio_model.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_audio_model.rs new file mode 100644 index 00000000..d081c742 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_audio_model.rs @@ -0,0 +1,80 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonAudioModel` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientAudioModel { + SunoMusic, + SunoRemix, + SunoSounds, + SunoSample, + SeedAudio1p0, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientAudioModel { + fn from(value: String) -> Self { + match value.as_str() { + "suno_music" => Self::SunoMusic, + "suno_remix" => Self::SunoRemix, + "suno_sounds" => Self::SunoSounds, + "suno_sample" => Self::SunoSample, + "seed_audio_1p0" => Self::SeedAudio1p0, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientAudioModel) -> Self { + match value { + ApiClientAudioModel::SunoMusic => "suno_music".to_string(), + ApiClientAudioModel::SunoRemix => "suno_remix".to_string(), + ApiClientAudioModel::SunoSounds => "suno_sounds".to_string(), + ApiClientAudioModel::SunoSample => "suno_sample".to_string(), + ApiClientAudioModel::SeedAudio1p0 => "seed_audio_1p0".to_string(), + ApiClientAudioModel::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientAudioModel = serde_json::from_str("\"suno_music\"").unwrap(); + assert_eq!(parsed, ApiClientAudioModel::SunoMusic); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"suno_music\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientAudioModel = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientAudioModel::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientAudioModel::SunoMusic, "suno_music"), + (ApiClientAudioModel::SunoRemix, "suno_remix"), + (ApiClientAudioModel::SunoSounds, "suno_sounds"), + (ApiClientAudioModel::SunoSample, "suno_sample"), + (ApiClientAudioModel::SeedAudio1p0, "seed_audio_1p0") + ]; + for (variant, wire) in all { + let json = format!("\"{}\"", wire); + let parsed: ApiClientAudioModel = serde_json::from_str(&json).unwrap(); + assert_eq!(parsed, variant); + assert_eq!(serde_json::to_string(&variant).unwrap(), json); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_bitrate.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_bitrate.rs new file mode 100644 index 00000000..a98bc374 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_bitrate.rs @@ -0,0 +1,67 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonBitrate` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientBitrate { + Normal, + High, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientBitrate { + fn from(value: String) -> Self { + match value.as_str() { + "normal" => Self::Normal, + "high" => Self::High, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientBitrate) -> Self { + match value { + ApiClientBitrate::Normal => "normal".to_string(), + ApiClientBitrate::High => "high".to_string(), + ApiClientBitrate::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientBitrate = serde_json::from_str("\"normal\"").unwrap(); + assert_eq!(parsed, ApiClientBitrate::Normal); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"normal\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientBitrate = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientBitrate::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientBitrate::Normal, "normal"), + (ApiClientBitrate::High, "high"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientBitrate = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_generation_provider.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_generation_provider.rs new file mode 100644 index 00000000..4f58729d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_generation_provider.rs @@ -0,0 +1,83 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `GenerationSource` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientGenerationProvider { + Artcraft, + Fal, + Grok, + Midjourney, + Sora, + WorldLabs, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientGenerationProvider { + fn from(value: String) -> Self { + match value.as_str() { + "artcraft" => Self::Artcraft, + "fal" => Self::Fal, + "grok" => Self::Grok, + "midjourney" => Self::Midjourney, + "sora" => Self::Sora, + "world_labs" => Self::WorldLabs, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientGenerationProvider) -> Self { + match value { + ApiClientGenerationProvider::Artcraft => "artcraft".to_string(), + ApiClientGenerationProvider::Fal => "fal".to_string(), + ApiClientGenerationProvider::Grok => "grok".to_string(), + ApiClientGenerationProvider::Midjourney => "midjourney".to_string(), + ApiClientGenerationProvider::Sora => "sora".to_string(), + ApiClientGenerationProvider::WorldLabs => "world_labs".to_string(), + ApiClientGenerationProvider::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientGenerationProvider = serde_json::from_str("\"artcraft\"").unwrap(); + assert_eq!(parsed, ApiClientGenerationProvider::Artcraft); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"artcraft\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientGenerationProvider = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientGenerationProvider::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientGenerationProvider::Artcraft, "artcraft"), + (ApiClientGenerationProvider::Fal, "fal"), + (ApiClientGenerationProvider::Grok, "grok"), + (ApiClientGenerationProvider::Midjourney, "midjourney"), + (ApiClientGenerationProvider::Sora, "sora"), + (ApiClientGenerationProvider::WorldLabs, "world_labs"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientGenerationProvider = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_image_model.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_image_model.rs new file mode 100644 index 00000000..3f25f7ab --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_image_model.rs @@ -0,0 +1,147 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonImageModel` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientImageModel { + Flux1Dev, + Flux1Schnell, + FluxPro11, + FluxPro11Ultra, + GptImage1, + GptImage1p5, + GptImage2, + GrokImagineImage, + GrokImagineImageQuality, + Midjourney7, + Midjourney7Niji, + Midjourney8, + NanoBanana, + NanoBanana2, + NanoBananaPro, + Seedream4, + Seedream4p5, + Seedream5Lite, + Seedream5p0Pro, + Seedream5p0ProUltra, + QwenEdit2511Angles, + Flux2LoraAngles, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientImageModel { + fn from(value: String) -> Self { + match value.as_str() { + "flux_1_dev" => Self::Flux1Dev, + "flux_1_schnell" => Self::Flux1Schnell, + "flux_pro_1p1" => Self::FluxPro11, + "flux_pro_1p1_ultra" => Self::FluxPro11Ultra, + "gpt_image_1" => Self::GptImage1, + "gpt_image_1p5" => Self::GptImage1p5, + "gpt_image_2" => Self::GptImage2, + "grok_imagine_image" => Self::GrokImagineImage, + "grok_imagine_image_q" => Self::GrokImagineImageQuality, + "midjourney_7" => Self::Midjourney7, + "midjourney_7_niji" => Self::Midjourney7Niji, + "midjourney_8" => Self::Midjourney8, + "nano_banana" => Self::NanoBanana, + "nano_banana_2" => Self::NanoBanana2, + "nano_banana_pro" => Self::NanoBananaPro, + "seedream_4" => Self::Seedream4, + "seedream_4p5" => Self::Seedream4p5, + "seedream_5_lite" => Self::Seedream5Lite, + "seedream_5p0_pro" => Self::Seedream5p0Pro, + "seedream_5p0_pro_u" => Self::Seedream5p0ProUltra, + "qwen_edit_2511_angles" => Self::QwenEdit2511Angles, + "flux_2_lora_angles" => Self::Flux2LoraAngles, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientImageModel) -> Self { + match value { + ApiClientImageModel::Flux1Dev => "flux_1_dev".to_string(), + ApiClientImageModel::Flux1Schnell => "flux_1_schnell".to_string(), + ApiClientImageModel::FluxPro11 => "flux_pro_1p1".to_string(), + ApiClientImageModel::FluxPro11Ultra => "flux_pro_1p1_ultra".to_string(), + ApiClientImageModel::GptImage1 => "gpt_image_1".to_string(), + ApiClientImageModel::GptImage1p5 => "gpt_image_1p5".to_string(), + ApiClientImageModel::GptImage2 => "gpt_image_2".to_string(), + ApiClientImageModel::GrokImagineImage => "grok_imagine_image".to_string(), + ApiClientImageModel::GrokImagineImageQuality => "grok_imagine_image_q".to_string(), + ApiClientImageModel::Midjourney7 => "midjourney_7".to_string(), + ApiClientImageModel::Midjourney7Niji => "midjourney_7_niji".to_string(), + ApiClientImageModel::Midjourney8 => "midjourney_8".to_string(), + ApiClientImageModel::NanoBanana => "nano_banana".to_string(), + ApiClientImageModel::NanoBanana2 => "nano_banana_2".to_string(), + ApiClientImageModel::NanoBananaPro => "nano_banana_pro".to_string(), + ApiClientImageModel::Seedream4 => "seedream_4".to_string(), + ApiClientImageModel::Seedream4p5 => "seedream_4p5".to_string(), + ApiClientImageModel::Seedream5Lite => "seedream_5_lite".to_string(), + ApiClientImageModel::Seedream5p0Pro => "seedream_5p0_pro".to_string(), + ApiClientImageModel::Seedream5p0ProUltra => "seedream_5p0_pro_u".to_string(), + ApiClientImageModel::QwenEdit2511Angles => "qwen_edit_2511_angles".to_string(), + ApiClientImageModel::Flux2LoraAngles => "flux_2_lora_angles".to_string(), + ApiClientImageModel::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientImageModel = serde_json::from_str("\"flux_1_dev\"").unwrap(); + assert_eq!(parsed, ApiClientImageModel::Flux1Dev); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"flux_1_dev\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientImageModel = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientImageModel::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientImageModel::Flux1Dev, "flux_1_dev"), + (ApiClientImageModel::Flux1Schnell, "flux_1_schnell"), + (ApiClientImageModel::FluxPro11, "flux_pro_1p1"), + (ApiClientImageModel::FluxPro11Ultra, "flux_pro_1p1_ultra"), + (ApiClientImageModel::GptImage1, "gpt_image_1"), + (ApiClientImageModel::GptImage1p5, "gpt_image_1p5"), + (ApiClientImageModel::GptImage2, "gpt_image_2"), + (ApiClientImageModel::GrokImagineImage, "grok_imagine_image"), + (ApiClientImageModel::GrokImagineImageQuality, "grok_imagine_image_q"), + (ApiClientImageModel::Midjourney7, "midjourney_7"), + (ApiClientImageModel::Midjourney7Niji, "midjourney_7_niji"), + (ApiClientImageModel::Midjourney8, "midjourney_8"), + (ApiClientImageModel::NanoBanana, "nano_banana"), + (ApiClientImageModel::NanoBanana2, "nano_banana_2"), + (ApiClientImageModel::NanoBananaPro, "nano_banana_pro"), + (ApiClientImageModel::Seedream4, "seedream_4"), + (ApiClientImageModel::Seedream4p5, "seedream_4p5"), + (ApiClientImageModel::Seedream5Lite, "seedream_5_lite"), + (ApiClientImageModel::Seedream5p0Pro, "seedream_5p0_pro"), + (ApiClientImageModel::Seedream5p0ProUltra, "seedream_5p0_pro_u"), + (ApiClientImageModel::QwenEdit2511Angles, "qwen_edit_2511_angles"), + (ApiClientImageModel::Flux2LoraAngles, "flux_2_lora_angles"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientImageModel = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_mesh_model.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_mesh_model.rs new file mode 100644 index 00000000..4d708667 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_mesh_model.rs @@ -0,0 +1,104 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonMeshModel` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientMeshModel { + Hunyuan3d2p0, + Hunyuan3d2p1, + Hunyuan3d3, + Hunyuan3d3Sketch, + Hunyuan3d3p1Pro, + Hunyuan3d3p1Rapid, + Hunyuan3d3p1Part, + Hunyuan3d3p1SmartTopology, + Tripo3dH3p1, + MeshyV6, + Rodin2p5Fast, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientMeshModel { + fn from(value: String) -> Self { + match value.as_str() { + "hunyuan_3d_2p0" => Self::Hunyuan3d2p0, + "hunyuan_3d_2p1" => Self::Hunyuan3d2p1, + "hunyuan_3d_3" => Self::Hunyuan3d3, + "hunyuan_3d_3_sketch" => Self::Hunyuan3d3Sketch, + "hunyuan_3d_3p1_pro" => Self::Hunyuan3d3p1Pro, + "hunyuan_3d_3p1_rapid" => Self::Hunyuan3d3p1Rapid, + "hunyuan_3d_3p1_part" => Self::Hunyuan3d3p1Part, + "hunyuan_3d_3p1_topology" => Self::Hunyuan3d3p1SmartTopology, + "tripo3d_h3p1" => Self::Tripo3dH3p1, + "meshy_v6" => Self::MeshyV6, + "rodin_2p5_fast" => Self::Rodin2p5Fast, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientMeshModel) -> Self { + match value { + ApiClientMeshModel::Hunyuan3d2p0 => "hunyuan_3d_2p0".to_string(), + ApiClientMeshModel::Hunyuan3d2p1 => "hunyuan_3d_2p1".to_string(), + ApiClientMeshModel::Hunyuan3d3 => "hunyuan_3d_3".to_string(), + ApiClientMeshModel::Hunyuan3d3Sketch => "hunyuan_3d_3_sketch".to_string(), + ApiClientMeshModel::Hunyuan3d3p1Pro => "hunyuan_3d_3p1_pro".to_string(), + ApiClientMeshModel::Hunyuan3d3p1Rapid => "hunyuan_3d_3p1_rapid".to_string(), + ApiClientMeshModel::Hunyuan3d3p1Part => "hunyuan_3d_3p1_part".to_string(), + ApiClientMeshModel::Hunyuan3d3p1SmartTopology => "hunyuan_3d_3p1_topology".to_string(), + ApiClientMeshModel::Tripo3dH3p1 => "tripo3d_h3p1".to_string(), + ApiClientMeshModel::MeshyV6 => "meshy_v6".to_string(), + ApiClientMeshModel::Rodin2p5Fast => "rodin_2p5_fast".to_string(), + ApiClientMeshModel::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientMeshModel = serde_json::from_str("\"hunyuan_3d_2p0\"").unwrap(); + assert_eq!(parsed, ApiClientMeshModel::Hunyuan3d2p0); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"hunyuan_3d_2p0\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientMeshModel = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientMeshModel::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientMeshModel::Hunyuan3d2p0, "hunyuan_3d_2p0"), + (ApiClientMeshModel::Hunyuan3d2p1, "hunyuan_3d_2p1"), + (ApiClientMeshModel::Hunyuan3d3, "hunyuan_3d_3"), + (ApiClientMeshModel::Hunyuan3d3Sketch, "hunyuan_3d_3_sketch"), + (ApiClientMeshModel::Hunyuan3d3p1Pro, "hunyuan_3d_3p1_pro"), + (ApiClientMeshModel::Hunyuan3d3p1Rapid, "hunyuan_3d_3p1_rapid"), + (ApiClientMeshModel::Hunyuan3d3p1Part, "hunyuan_3d_3p1_part"), + (ApiClientMeshModel::Hunyuan3d3p1SmartTopology, "hunyuan_3d_3p1_topology"), + (ApiClientMeshModel::Tripo3dH3p1, "tripo3d_h3p1"), + (ApiClientMeshModel::MeshyV6, "meshy_v6"), + (ApiClientMeshModel::Rodin2p5Fast, "rodin_2p5_fast") + ]; + for (variant, wire) in all { + let json = format!("\"{}\"", wire); + let parsed: ApiClientMeshModel = serde_json::from_str(&json).unwrap(); + assert_eq!(parsed, variant); + assert_eq!(serde_json::to_string(&variant).unwrap(), json); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_mesh_output_type.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_mesh_output_type.rs new file mode 100644 index 00000000..d8fd2b85 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_mesh_output_type.rs @@ -0,0 +1,72 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonMeshOutputType` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientMeshOutputType { + Normal, + LowPoly, + Geometry, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientMeshOutputType { + fn from(value: String) -> Self { + match value.as_str() { + "normal" => Self::Normal, + "low_poly" => Self::LowPoly, + "geometry" => Self::Geometry, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientMeshOutputType) -> Self { + match value { + ApiClientMeshOutputType::Normal => "normal".to_string(), + ApiClientMeshOutputType::LowPoly => "low_poly".to_string(), + ApiClientMeshOutputType::Geometry => "geometry".to_string(), + ApiClientMeshOutputType::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientMeshOutputType = serde_json::from_str("\"normal\"").unwrap(); + assert_eq!(parsed, ApiClientMeshOutputType::Normal); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"normal\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientMeshOutputType = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientMeshOutputType::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientMeshOutputType::Normal, "normal"), + (ApiClientMeshOutputType::LowPoly, "low_poly"), + (ApiClientMeshOutputType::Geometry, "geometry") + ]; + for (variant, wire) in all { + let json = format!("\"{}\"", wire); + let parsed: ApiClientMeshOutputType = serde_json::from_str(&json).unwrap(); + assert_eq!(parsed, variant); + assert_eq!(serde_json::to_string(&variant).unwrap(), json); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_model_creator.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_model_creator.rs new file mode 100644 index 00000000..eeaafe11 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_model_creator.rs @@ -0,0 +1,147 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `ModelCreator` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientModelCreator { + Alibaba, + ArtCraft, + BlackForestLabs, + Bytedance, + Fal, + Google, + Grok, + Hailuo, + Higgsfield, + Kling, + Krea, + Midjourney, + OpenAi, + OpenArt, + Recraft, + Replicate, + Runway, + Stability, + Tencent, + TensorArt, + Vidu, + WorldLabs, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientModelCreator { + fn from(value: String) -> Self { + match value.as_str() { + "alibaba" => Self::Alibaba, + "artcraft" => Self::ArtCraft, + "black_forest_labs" => Self::BlackForestLabs, + "bytedance" => Self::Bytedance, + "fal" => Self::Fal, + "google" => Self::Google, + "grok" => Self::Grok, + "hailuo" => Self::Hailuo, + "higgsfield" => Self::Higgsfield, + "kling" => Self::Kling, + "krea" => Self::Krea, + "midjourney" => Self::Midjourney, + "open_ai" => Self::OpenAi, + "open_art" => Self::OpenArt, + "recraft" => Self::Recraft, + "replicate" => Self::Replicate, + "runway" => Self::Runway, + "stability" => Self::Stability, + "tencent" => Self::Tencent, + "tensor_art" => Self::TensorArt, + "vidu" => Self::Vidu, + "world_labs" => Self::WorldLabs, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientModelCreator) -> Self { + match value { + ApiClientModelCreator::Alibaba => "alibaba".to_string(), + ApiClientModelCreator::ArtCraft => "artcraft".to_string(), + ApiClientModelCreator::BlackForestLabs => "black_forest_labs".to_string(), + ApiClientModelCreator::Bytedance => "bytedance".to_string(), + ApiClientModelCreator::Fal => "fal".to_string(), + ApiClientModelCreator::Google => "google".to_string(), + ApiClientModelCreator::Grok => "grok".to_string(), + ApiClientModelCreator::Hailuo => "hailuo".to_string(), + ApiClientModelCreator::Higgsfield => "higgsfield".to_string(), + ApiClientModelCreator::Kling => "kling".to_string(), + ApiClientModelCreator::Krea => "krea".to_string(), + ApiClientModelCreator::Midjourney => "midjourney".to_string(), + ApiClientModelCreator::OpenAi => "open_ai".to_string(), + ApiClientModelCreator::OpenArt => "open_art".to_string(), + ApiClientModelCreator::Recraft => "recraft".to_string(), + ApiClientModelCreator::Replicate => "replicate".to_string(), + ApiClientModelCreator::Runway => "runway".to_string(), + ApiClientModelCreator::Stability => "stability".to_string(), + ApiClientModelCreator::Tencent => "tencent".to_string(), + ApiClientModelCreator::TensorArt => "tensor_art".to_string(), + ApiClientModelCreator::Vidu => "vidu".to_string(), + ApiClientModelCreator::WorldLabs => "world_labs".to_string(), + ApiClientModelCreator::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientModelCreator = serde_json::from_str("\"alibaba\"").unwrap(); + assert_eq!(parsed, ApiClientModelCreator::Alibaba); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"alibaba\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientModelCreator = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientModelCreator::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientModelCreator::Alibaba, "alibaba"), + (ApiClientModelCreator::ArtCraft, "artcraft"), + (ApiClientModelCreator::BlackForestLabs, "black_forest_labs"), + (ApiClientModelCreator::Bytedance, "bytedance"), + (ApiClientModelCreator::Fal, "fal"), + (ApiClientModelCreator::Google, "google"), + (ApiClientModelCreator::Grok, "grok"), + (ApiClientModelCreator::Hailuo, "hailuo"), + (ApiClientModelCreator::Higgsfield, "higgsfield"), + (ApiClientModelCreator::Kling, "kling"), + (ApiClientModelCreator::Krea, "krea"), + (ApiClientModelCreator::Midjourney, "midjourney"), + (ApiClientModelCreator::OpenAi, "open_ai"), + (ApiClientModelCreator::OpenArt, "open_art"), + (ApiClientModelCreator::Recraft, "recraft"), + (ApiClientModelCreator::Replicate, "replicate"), + (ApiClientModelCreator::Runway, "runway"), + (ApiClientModelCreator::Stability, "stability"), + (ApiClientModelCreator::Tencent, "tencent"), + (ApiClientModelCreator::TensorArt, "tensor_art"), + (ApiClientModelCreator::Vidu, "vidu"), + (ApiClientModelCreator::WorldLabs, "world_labs"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientModelCreator = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_polygon_type.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_polygon_type.rs new file mode 100644 index 00000000..5b38b7ab --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_polygon_type.rs @@ -0,0 +1,68 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonPolygonType` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientPolygonType { + Triangle, + Quad, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientPolygonType { + fn from(value: String) -> Self { + match value.as_str() { + "triangle" => Self::Triangle, + "quad" => Self::Quad, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientPolygonType) -> Self { + match value { + ApiClientPolygonType::Triangle => "triangle".to_string(), + ApiClientPolygonType::Quad => "quad".to_string(), + ApiClientPolygonType::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientPolygonType = serde_json::from_str("\"triangle\"").unwrap(); + assert_eq!(parsed, ApiClientPolygonType::Triangle); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"triangle\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientPolygonType = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientPolygonType::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientPolygonType::Triangle, "triangle"), + (ApiClientPolygonType::Quad, "quad") + ]; + for (variant, wire) in all { + let json = format!("\"{}\"", wire); + let parsed: ApiClientPolygonType = serde_json::from_str(&json).unwrap(); + assert_eq!(parsed, variant); + assert_eq!(serde_json::to_string(&variant).unwrap(), json); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_quality.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_quality.rs new file mode 100644 index 00000000..92f04bed --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_quality.rs @@ -0,0 +1,71 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonQuality` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientQuality { + High, + Medium, + Low, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientQuality { + fn from(value: String) -> Self { + match value.as_str() { + "high" => Self::High, + "medium" => Self::Medium, + "low" => Self::Low, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientQuality) -> Self { + match value { + ApiClientQuality::High => "high".to_string(), + ApiClientQuality::Medium => "medium".to_string(), + ApiClientQuality::Low => "low".to_string(), + ApiClientQuality::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientQuality = serde_json::from_str("\"high\"").unwrap(); + assert_eq!(parsed, ApiClientQuality::High); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"high\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientQuality = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientQuality::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientQuality::High, "high"), + (ApiClientQuality::Medium, "medium"), + (ApiClientQuality::Low, "low"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientQuality = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_resolution.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_resolution.rs new file mode 100644 index 00000000..807f24dc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_resolution.rs @@ -0,0 +1,91 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonResolution` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientResolution { + OneK, + TwoK, + ThreeK, + FourK, + HalfK, + FourEightyP, + SevenTwentyP, + TenEightyP, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientResolution { + fn from(value: String) -> Self { + match value.as_str() { + "one_k" => Self::OneK, + "two_k" => Self::TwoK, + "three_k" => Self::ThreeK, + "four_k" => Self::FourK, + "half_k" => Self::HalfK, + "four_eighty_p" => Self::FourEightyP, + "seven_twenty_p" => Self::SevenTwentyP, + "ten_eighty_p" => Self::TenEightyP, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientResolution) -> Self { + match value { + ApiClientResolution::OneK => "one_k".to_string(), + ApiClientResolution::TwoK => "two_k".to_string(), + ApiClientResolution::ThreeK => "three_k".to_string(), + ApiClientResolution::FourK => "four_k".to_string(), + ApiClientResolution::HalfK => "half_k".to_string(), + ApiClientResolution::FourEightyP => "four_eighty_p".to_string(), + ApiClientResolution::SevenTwentyP => "seven_twenty_p".to_string(), + ApiClientResolution::TenEightyP => "ten_eighty_p".to_string(), + ApiClientResolution::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientResolution = serde_json::from_str("\"one_k\"").unwrap(); + assert_eq!(parsed, ApiClientResolution::OneK); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"one_k\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientResolution = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientResolution::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientResolution::OneK, "one_k"), + (ApiClientResolution::TwoK, "two_k"), + (ApiClientResolution::ThreeK, "three_k"), + (ApiClientResolution::FourK, "four_k"), + (ApiClientResolution::HalfK, "half_k"), + (ApiClientResolution::FourEightyP, "four_eighty_p"), + (ApiClientResolution::SevenTwentyP, "seven_twenty_p"), + (ApiClientResolution::TenEightyP, "ten_eighty_p"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientResolution = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_splat_model.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_splat_model.rs new file mode 100644 index 00000000..0a14fa1c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_splat_model.rs @@ -0,0 +1,88 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonSplatModel` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientSplatModel { + Marble0p1Mini, + Marble0p1Plus, + Marble1p0, + Marble1p0Draft, + Marble1p1, + Marble1p1Plus, + TripoSplat, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientSplatModel { + fn from(value: String) -> Self { + match value.as_str() { + "marble_0p1_mini" => Self::Marble0p1Mini, + "marble_0p1_plus" => Self::Marble0p1Plus, + "marble_1p0" => Self::Marble1p0, + "marble_1p0_draft" => Self::Marble1p0Draft, + "marble_1p1" => Self::Marble1p1, + "marble_1p1_plus" => Self::Marble1p1Plus, + "triposplat" => Self::TripoSplat, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientSplatModel) -> Self { + match value { + ApiClientSplatModel::Marble0p1Mini => "marble_0p1_mini".to_string(), + ApiClientSplatModel::Marble0p1Plus => "marble_0p1_plus".to_string(), + ApiClientSplatModel::Marble1p0 => "marble_1p0".to_string(), + ApiClientSplatModel::Marble1p0Draft => "marble_1p0_draft".to_string(), + ApiClientSplatModel::Marble1p1 => "marble_1p1".to_string(), + ApiClientSplatModel::Marble1p1Plus => "marble_1p1_plus".to_string(), + ApiClientSplatModel::TripoSplat => "triposplat".to_string(), + ApiClientSplatModel::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientSplatModel = serde_json::from_str("\"marble_0p1_mini\"").unwrap(); + assert_eq!(parsed, ApiClientSplatModel::Marble0p1Mini); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"marble_0p1_mini\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientSplatModel = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientSplatModel::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientSplatModel::Marble0p1Mini, "marble_0p1_mini"), + (ApiClientSplatModel::Marble0p1Plus, "marble_0p1_plus"), + (ApiClientSplatModel::Marble1p0, "marble_1p0"), + (ApiClientSplatModel::Marble1p0Draft, "marble_1p0_draft"), + (ApiClientSplatModel::Marble1p1, "marble_1p1"), + (ApiClientSplatModel::Marble1p1Plus, "marble_1p1_plus"), + (ApiClientSplatModel::TripoSplat, "triposplat") + ]; + for (variant, wire) in all { + let json = format!("\"{}\"", wire); + let parsed: ApiClientSplatModel = serde_json::from_str(&json).unwrap(); + assert_eq!(parsed, variant); + assert_eq!(serde_json::to_string(&variant).unwrap(), json); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_video_model.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_video_model.rs new file mode 100644 index 00000000..18fed733 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/api_client_video_model.rs @@ -0,0 +1,191 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Forward-compatible, self-contained API-client copy of the server's `CommonVideoModel` enum. +/// +/// Serialized as a string. Any value this client build does not recognize is preserved +/// verbatim in [`Unknown`], so newer server variants never break deserialization and +/// still round-trip back to the original string. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(from = "String", into = "String")] +pub enum ApiClientVideoModel { + GrokVideo, + GrokImagineVideo, + GrokImagineVideo1p5, + Kling16Pro, + Kling21Pro, + Kling21Master, + Kling2p5TurboPro, + Kling2p6Pro, + Kling3p0Standard, + Kling3p0Pro, + HappyHorse1p0, + Seedance10Lite, + Seedance1p5Pro, + Seedance2p0, + Seedance2p0Fast, + Seedance2p0BytePlus, + Seedance2p0BytePlusFast, + Seedance2p0Ultra, + Seedance2p0UltraFast, + Seedance2p0BytePlusUltra, + Seedance2p0BytePlusUltraFast, + Seedance2p0Mini, + Seedance2p0BytePlusMini, + Seedance2p0BytePlusUltraMini, + Sora2, + Sora2Pro, + Veo2, + Veo3, + Veo3Fast, + Veo3p1, + Veo3p1Fast, + PreviewModel, + PreviewModelFast, + /// A value not known to this client build (preserved as-is). + Unknown(String), +} + +impl From for ApiClientVideoModel { + fn from(value: String) -> Self { + match value.as_str() { + "grok_video" => Self::GrokVideo, + "grok_imagine_video" => Self::GrokImagineVideo, + "grok_imagine_video_1p5" => Self::GrokImagineVideo1p5, + "kling_1p6_pro" => Self::Kling16Pro, + "kling_2p1_pro" => Self::Kling21Pro, + "kling_2p1_master" => Self::Kling21Master, + "kling_2p5_turbo_pro" => Self::Kling2p5TurboPro, + "kling_2p6_pro" => Self::Kling2p6Pro, + "kling_3p0_standard" => Self::Kling3p0Standard, + "kling_3p0_pro" => Self::Kling3p0Pro, + "happy_horse_1p0" => Self::HappyHorse1p0, + "seedance_1p0_lite" => Self::Seedance10Lite, + "seedance_1p5_pro" => Self::Seedance1p5Pro, + "seedance_2p0" => Self::Seedance2p0, + "seedance_2p0_fast" => Self::Seedance2p0Fast, + "seedance_2p0_bp" => Self::Seedance2p0BytePlus, + "seedance_2p0_bp_fast" => Self::Seedance2p0BytePlusFast, + "seedance_2p0_u" => Self::Seedance2p0Ultra, + "seedance_2p0_u_fast" => Self::Seedance2p0UltraFast, + "seedance_2p0_bpu" => Self::Seedance2p0BytePlusUltra, + "seedance_2p0_bpu_fast" => Self::Seedance2p0BytePlusUltraFast, + "seedance_2p0_mini" => Self::Seedance2p0Mini, + "seedance_2p0_bp_mini" => Self::Seedance2p0BytePlusMini, + "seedance_2p0_bpu_mini" => Self::Seedance2p0BytePlusUltraMini, + "sora_2" => Self::Sora2, + "sora_2_pro" => Self::Sora2Pro, + "veo_2" => Self::Veo2, + "veo_3" => Self::Veo3, + "veo_3_fast" => Self::Veo3Fast, + "veo_3p1" => Self::Veo3p1, + "veo_3p1_fast" => Self::Veo3p1Fast, + "preview_model" => Self::PreviewModel, + "preview_model_fast" => Self::PreviewModelFast, + _ => Self::Unknown(value), + } + } +} + +impl From for String { + fn from(value: ApiClientVideoModel) -> Self { + match value { + ApiClientVideoModel::GrokVideo => "grok_video".to_string(), + ApiClientVideoModel::GrokImagineVideo => "grok_imagine_video".to_string(), + ApiClientVideoModel::GrokImagineVideo1p5 => "grok_imagine_video_1p5".to_string(), + ApiClientVideoModel::Kling16Pro => "kling_1p6_pro".to_string(), + ApiClientVideoModel::Kling21Pro => "kling_2p1_pro".to_string(), + ApiClientVideoModel::Kling21Master => "kling_2p1_master".to_string(), + ApiClientVideoModel::Kling2p5TurboPro => "kling_2p5_turbo_pro".to_string(), + ApiClientVideoModel::Kling2p6Pro => "kling_2p6_pro".to_string(), + ApiClientVideoModel::Kling3p0Standard => "kling_3p0_standard".to_string(), + ApiClientVideoModel::Kling3p0Pro => "kling_3p0_pro".to_string(), + ApiClientVideoModel::HappyHorse1p0 => "happy_horse_1p0".to_string(), + ApiClientVideoModel::Seedance10Lite => "seedance_1p0_lite".to_string(), + ApiClientVideoModel::Seedance1p5Pro => "seedance_1p5_pro".to_string(), + ApiClientVideoModel::Seedance2p0 => "seedance_2p0".to_string(), + ApiClientVideoModel::Seedance2p0Fast => "seedance_2p0_fast".to_string(), + ApiClientVideoModel::Seedance2p0BytePlus => "seedance_2p0_bp".to_string(), + ApiClientVideoModel::Seedance2p0BytePlusFast => "seedance_2p0_bp_fast".to_string(), + ApiClientVideoModel::Seedance2p0Ultra => "seedance_2p0_u".to_string(), + ApiClientVideoModel::Seedance2p0UltraFast => "seedance_2p0_u_fast".to_string(), + ApiClientVideoModel::Seedance2p0BytePlusUltra => "seedance_2p0_bpu".to_string(), + ApiClientVideoModel::Seedance2p0BytePlusUltraFast => "seedance_2p0_bpu_fast".to_string(), + ApiClientVideoModel::Seedance2p0Mini => "seedance_2p0_mini".to_string(), + ApiClientVideoModel::Seedance2p0BytePlusMini => "seedance_2p0_bp_mini".to_string(), + ApiClientVideoModel::Seedance2p0BytePlusUltraMini => "seedance_2p0_bpu_mini".to_string(), + ApiClientVideoModel::Sora2 => "sora_2".to_string(), + ApiClientVideoModel::Sora2Pro => "sora_2_pro".to_string(), + ApiClientVideoModel::Veo2 => "veo_2".to_string(), + ApiClientVideoModel::Veo3 => "veo_3".to_string(), + ApiClientVideoModel::Veo3Fast => "veo_3_fast".to_string(), + ApiClientVideoModel::Veo3p1 => "veo_3p1".to_string(), + ApiClientVideoModel::Veo3p1Fast => "veo_3p1_fast".to_string(), + ApiClientVideoModel::PreviewModel => "preview_model".to_string(), + ApiClientVideoModel::PreviewModelFast => "preview_model_fast".to_string(), + ApiClientVideoModel::Unknown(other) => other, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_variant_round_trips() { + let parsed: ApiClientVideoModel = serde_json::from_str("\"grok_video\"").unwrap(); + assert_eq!(parsed, ApiClientVideoModel::GrokVideo); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"grok_video\""); + } + + #[test] + fn unknown_value_is_preserved_and_round_trips() { + let parsed: ApiClientVideoModel = serde_json::from_str("\"zzz_not_a_real_value\"").unwrap(); + assert_eq!(parsed, ApiClientVideoModel::Unknown("zzz_not_a_real_value".to_string())); + assert_eq!(serde_json::to_string(&parsed).unwrap(), "\"zzz_not_a_real_value\""); + } + + #[test] + fn every_known_variant_round_trips() { + let all = [ + (ApiClientVideoModel::GrokVideo, "grok_video"), + (ApiClientVideoModel::GrokImagineVideo, "grok_imagine_video"), + (ApiClientVideoModel::GrokImagineVideo1p5, "grok_imagine_video_1p5"), + (ApiClientVideoModel::Kling16Pro, "kling_1p6_pro"), + (ApiClientVideoModel::Kling21Pro, "kling_2p1_pro"), + (ApiClientVideoModel::Kling21Master, "kling_2p1_master"), + (ApiClientVideoModel::Kling2p5TurboPro, "kling_2p5_turbo_pro"), + (ApiClientVideoModel::Kling2p6Pro, "kling_2p6_pro"), + (ApiClientVideoModel::Kling3p0Standard, "kling_3p0_standard"), + (ApiClientVideoModel::Kling3p0Pro, "kling_3p0_pro"), + (ApiClientVideoModel::HappyHorse1p0, "happy_horse_1p0"), + (ApiClientVideoModel::Seedance10Lite, "seedance_1p0_lite"), + (ApiClientVideoModel::Seedance1p5Pro, "seedance_1p5_pro"), + (ApiClientVideoModel::Seedance2p0, "seedance_2p0"), + (ApiClientVideoModel::Seedance2p0Fast, "seedance_2p0_fast"), + (ApiClientVideoModel::Seedance2p0BytePlus, "seedance_2p0_bp"), + (ApiClientVideoModel::Seedance2p0BytePlusFast, "seedance_2p0_bp_fast"), + (ApiClientVideoModel::Seedance2p0Ultra, "seedance_2p0_u"), + (ApiClientVideoModel::Seedance2p0UltraFast, "seedance_2p0_u_fast"), + (ApiClientVideoModel::Seedance2p0BytePlusUltra, "seedance_2p0_bpu"), + (ApiClientVideoModel::Seedance2p0BytePlusUltraFast, "seedance_2p0_bpu_fast"), + (ApiClientVideoModel::Seedance2p0Mini, "seedance_2p0_mini"), + (ApiClientVideoModel::Seedance2p0BytePlusMini, "seedance_2p0_bp_mini"), + (ApiClientVideoModel::Seedance2p0BytePlusUltraMini, "seedance_2p0_bpu_mini"), + (ApiClientVideoModel::Sora2, "sora_2"), + (ApiClientVideoModel::Sora2Pro, "sora_2_pro"), + (ApiClientVideoModel::Veo2, "veo_2"), + (ApiClientVideoModel::Veo3, "veo_3"), + (ApiClientVideoModel::Veo3Fast, "veo_3_fast"), + (ApiClientVideoModel::Veo3p1, "veo_3p1"), + (ApiClientVideoModel::Veo3p1Fast, "veo_3p1_fast"), + (ApiClientVideoModel::PreviewModel, "preview_model"), + (ApiClientVideoModel::PreviewModelFast, "preview_model_fast"), + ]; + for (variant, s) in all { + assert_eq!(String::from(variant.clone()), s, "serialize mismatch for {:?}", variant); + let parsed: ApiClientVideoModel = serde_json::from_str(&format!("\"{}\"", s)).unwrap(); + assert_eq!(parsed, variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/mod.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/mod.rs new file mode 100644 index 00000000..3f44d72a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/generation/mod.rs @@ -0,0 +1,13 @@ +pub mod api_client_aspect_ratio; +pub mod api_client_audio_model; +pub mod api_client_bitrate; +pub mod api_client_generation_provider; +pub mod api_client_image_model; +pub mod api_client_mesh_model; +pub mod api_client_mesh_output_type; +pub mod api_client_model_creator; +pub mod api_client_polygon_type; +pub mod api_client_quality; +pub mod api_client_resolution; +pub mod api_client_splat_model; +pub mod api_client_video_model; diff --git a/crates/api_clients/artcraft_client/src/datatypes/common_enums/mod.rs b/crates/api_clients/artcraft_client/src/datatypes/common_enums/mod.rs new file mode 100644 index 00000000..48b4c955 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/common_enums/mod.rs @@ -0,0 +1 @@ +pub mod generation; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/datatypes/mod.rs b/crates/api_clients/artcraft_client/src/datatypes/mod.rs new file mode 100644 index 00000000..c78cc973 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/datatypes/mod.rs @@ -0,0 +1 @@ +pub mod common_enums; diff --git a/crates/api_clients/artcraft_client/src/endpoints/analytics/log_active_user.rs b/crates/api_clients/artcraft_client/src/endpoints/analytics/log_active_user.rs new file mode 100644 index 00000000..b8222f24 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/analytics/log_active_user.rs @@ -0,0 +1,48 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_query_string_post_request::basic_query_string_post_request; +use crate::api_defs::analytics::log_active_user::{LogAppActiveUserRequest, LogAppActiveUserResponse, LOG_ACTIVE_USER_V1_PATH}; +use std::collections::HashMap; + +pub async fn log_active_user( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: LogAppActiveUserRequest, +) -> Result { + + // TODO(bt): This is gross and doesn't automatically handle field changes. + + let mut query = HashMap::new(); + + if let Some(token) = request.maybe_app_session_token { + query.insert("maybe_app_session_token".to_string(), token.to_string()); + } + + if let Some(os_platform) = request.maybe_os_platform { + query.insert("maybe_os_platform".to_string(), os_platform); + } + + if let Some(os_version) = request.maybe_os_version { + query.insert("maybe_os_version".to_string(), os_version); + } + + if let Some(app_name) = request.maybe_app_name { + query.insert("maybe_app_name".to_string(), app_name); + } + + if let Some(app_version) = request.maybe_app_version { + query.insert("maybe_app_version".to_string(), app_version); + } + + if let Some(maybe_session_duration_seconds) = request.maybe_session_duration_seconds { + query.insert("maybe_session_duration_seconds".to_string(), maybe_session_duration_seconds.to_string()); + } + + Ok(basic_query_string_post_request( + api_host, + LOG_ACTIVE_USER_V1_PATH, + maybe_creds, + &query, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/analytics/log_active_user_v2.rs b/crates/api_clients/artcraft_client/src/endpoints/analytics/log_active_user_v2.rs new file mode 100644 index 00000000..64a21561 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/analytics/log_active_user_v2.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::analytics::log_active_user::{LogAppActiveUserRequest, LogAppActiveUserResponse, LOG_ACTIVE_USER_V2_PATH}; + +pub async fn log_active_user_v2( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: LogAppActiveUserRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + LOG_ACTIVE_USER_V2_PATH, + maybe_creds, + &request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/analytics/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/analytics/mod.rs new file mode 100644 index 00000000..1a5a6396 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/analytics/mod.rs @@ -0,0 +1,2 @@ +pub mod log_active_user; +pub mod log_active_user_v2; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/credits/get_session_credits.rs b/crates/api_clients/artcraft_client/src/endpoints/credits/get_session_credits.rs new file mode 100644 index 00000000..9acdcd02 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/credits/get_session_credits.rs @@ -0,0 +1,27 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; +use crate::api_defs::credits::get_session_credits::GetSessionCreditsResponse; +use crate::enums::common::payments_namespace::PaymentsNamespace; + +pub async fn get_session_credits( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + payments_namespace: PaymentsNamespace +) -> Result { + let url_path = get_url_path(payments_namespace); + + Ok(basic_json_get_request( + api_host, + &url_path, + maybe_creds, + ).await?) +} + + +fn get_url_path(payments_namespace: PaymentsNamespace) -> String { + let payments_namespace = payments_namespace.to_str(); + format!("/v1/credits/namespace/{}", payments_namespace) +} + diff --git a/crates/api_clients/artcraft_client/src/endpoints/credits/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/credits/mod.rs new file mode 100644 index 00000000..c6a4be34 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/credits/mod.rs @@ -0,0 +1 @@ +pub mod get_session_credits; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/image/estimate_image_cost.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/image/estimate_image_cost.rs new file mode 100644 index 00000000..9db9313f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/image/estimate_image_cost.rs @@ -0,0 +1,20 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::cost_estimate::estimate_image_cost::{ + EstimateImageCostRequest, EstimateImageCostResponse, ESTIMATE_IMAGE_COST_PATH, +}; + +pub async fn estimate_image_cost( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: EstimateImageCostRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + ESTIMATE_IMAGE_COST_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/image/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/image/mod.rs new file mode 100644 index 00000000..fc1b4c41 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/image/mod.rs @@ -0,0 +1 @@ +pub mod estimate_image_cost; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/mod.rs new file mode 100644 index 00000000..8b571e67 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/mod.rs @@ -0,0 +1,3 @@ +pub mod image; +pub mod splat; +pub mod video; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/splat/estimate_splat_cost.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/splat/estimate_splat_cost.rs new file mode 100644 index 00000000..c60441e5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/splat/estimate_splat_cost.rs @@ -0,0 +1,20 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::cost_estimate::estimate_splat_cost::{ + EstimateSplatCostRequest, EstimateSplatCostResponse, ESTIMATE_SPLAT_COST_PATH, +}; + +pub async fn estimate_splat_cost( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: EstimateSplatCostRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + ESTIMATE_SPLAT_COST_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/splat/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/splat/mod.rs new file mode 100644 index 00000000..1b208ee5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/splat/mod.rs @@ -0,0 +1 @@ +pub mod estimate_splat_cost; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/video/estimate_video_cost.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/video/estimate_video_cost.rs new file mode 100644 index 00000000..7f1d17c0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/video/estimate_video_cost.rs @@ -0,0 +1,20 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::cost_estimate::estimate_video_cost::{ + EstimateVideoCostRequest, EstimateVideoCostResponse, ESTIMATE_VIDEO_COST_PATH, +}; + +pub async fn estimate_video_cost( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: EstimateVideoCostRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + ESTIMATE_VIDEO_COST_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/video/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/video/mod.rs new file mode 100644 index 00000000..65a10d38 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/cost_estimate/video/mod.rs @@ -0,0 +1 @@ +pub mod estimate_video_cost; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/flux_2_lora_edit_image_angle.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/flux_2_lora_edit_image_angle.rs new file mode 100644 index 00000000..72031412 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/flux_2_lora_edit_image_angle.rs @@ -0,0 +1,21 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::angle::flux_2_lora_edit_image_angle::{ + Flux2LoraEditImageAngleRequest, Flux2LoraEditImageAngleResponse, + FLUX_2_LORA_EDIT_IMAGE_ANGLE_PATH, +}; + +pub async fn flux_2_lora_edit_image_angle( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Flux2LoraEditImageAngleRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + FLUX_2_LORA_EDIT_IMAGE_ANGLE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/mod.rs new file mode 100644 index 00000000..fa3fe516 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/mod.rs @@ -0,0 +1,2 @@ +pub mod flux_2_lora_edit_image_angle; +pub mod qwen_edit_2511_edit_image_angle; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/qwen_edit_2511_edit_image_angle.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/qwen_edit_2511_edit_image_angle.rs new file mode 100644 index 00000000..12ce59e0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/angle/qwen_edit_2511_edit_image_angle.rs @@ -0,0 +1,21 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::angle::qwen_edit_2511_edit_image_angle::{ + QwenEdit2511EditImageAngleRequest, QwenEdit2511EditImageAngleResponse, + QWEN_EDIT_2511_EDIT_IMAGE_ANGLE_PATH, +}; + +pub async fn qwen_edit_2511_edit_image_angle( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: QwenEdit2511EditImageAngleRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + QWEN_EDIT_2511_EDIT_IMAGE_ANGLE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/bg_removal/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/bg_removal/mod.rs new file mode 100644 index 00000000..243c3076 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/bg_removal/mod.rs @@ -0,0 +1 @@ +pub mod remove_image_background; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/bg_removal/remove_image_background.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/bg_removal/remove_image_background.rs new file mode 100644 index 00000000..08b7622e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/bg_removal/remove_image_background.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::bg_removal::remove_image_background::{RemoveImageBackgroundRequest, RemoveImageBackgroundResponse, REMOVE_IMAGE_BACKGROUND_PATH}; + +pub async fn remove_image_background( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: RemoveImageBackgroundRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + REMOVE_IMAGE_BACKGROUND_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/flux_pro_kontext_max_edit_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/flux_pro_kontext_max_edit_image.rs new file mode 100644 index 00000000..258aa572 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/flux_pro_kontext_max_edit_image.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::edit::flux_pro_kontext_max_edit_image::{FluxProKontextMaxEditImageRequest, FluxProKontextMaxEditImageResponse, FLUX_PRO_KONTEXT_MAX_EDIT_IMAGE_PATH}; + + +pub async fn flux_pro_kontext_max_edit_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: FluxProKontextMaxEditImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + FLUX_PRO_KONTEXT_MAX_EDIT_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/gemini_25_flash_edit_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/gemini_25_flash_edit_image.rs new file mode 100644 index 00000000..396f29e5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/gemini_25_flash_edit_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::edit::gemini_25_flash_edit_image::{Gemini25FlashEditImageRequest, Gemini25FlashEditImageResponse, GEMINI_25_FLASH_EDIT_IMAGE_PATH}; + +pub async fn gemini_25_flash_edit_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Gemini25FlashEditImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GEMINI_25_FLASH_EDIT_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/gpt_image_1_edit_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/gpt_image_1_edit_image.rs new file mode 100644 index 00000000..87b555b1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/gpt_image_1_edit_image.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::edit::gpt_image_1_edit_image::{GptImage1EditImageRequest, GptImage1EditImageResponse, GPT_IMAGE_1_EDIT_IMAGE_PATH}; + + +pub async fn gpt_image_1_edit_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GptImage1EditImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GPT_IMAGE_1_EDIT_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/mod.rs new file mode 100644 index 00000000..3b522121 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/edit/mod.rs @@ -0,0 +1,3 @@ +pub mod flux_pro_kontext_max_edit_image; +pub mod gemini_25_flash_edit_image; +pub mod gpt_image_1_edit_image; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/flux_dev_juggernaut_inpaint_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/flux_dev_juggernaut_inpaint_image.rs new file mode 100644 index 00000000..61c5a562 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/flux_dev_juggernaut_inpaint_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::inpaint::flux_dev_juggernaut_inpaint_image::{FluxDevJuggernautInpaintImageRequest, FluxDevJuggernautInpaintImageResponse, FLUX_DEV_JUGGERNAUT_INPAINT_PATH}; + +pub async fn flux_dev_juggernaut_inpaint_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: FluxDevJuggernautInpaintImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + FLUX_DEV_JUGGERNAUT_INPAINT_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/flux_pro_1_inpaint_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/flux_pro_1_inpaint_image.rs new file mode 100644 index 00000000..8346216a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/flux_pro_1_inpaint_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::inpaint::flux_pro_1_inpaint_image::{FluxPro1InpaintImageRequest, FluxPro1InpaintImageResponse, FLUX_PRO_1_INPAINT_PATH}; + +pub async fn flux_pro_1_inpaint_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: FluxPro1InpaintImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + FLUX_PRO_1_INPAINT_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/mod.rs new file mode 100644 index 00000000..32f09986 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/inpaint/mod.rs @@ -0,0 +1,2 @@ +pub mod flux_pro_1_inpaint_image; +pub mod flux_dev_juggernaut_inpaint_image; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/mod.rs new file mode 100644 index 00000000..068f2ef5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/mod.rs @@ -0,0 +1,6 @@ +pub mod angle; +pub mod bg_removal; +pub mod edit; +pub mod inpaint; +pub mod multi_function; +pub mod text; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_5_lite_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_5_lite_multi_function_image_gen_image.rs new file mode 100644 index 00000000..4e9fa243 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_5_lite_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::bytedance_seedream_5_lite_multi_function_image_gen::{BytedanceSeedream5LiteMultiFunctionImageGenRequest, BytedanceSeedream5LiteMultiFunctionImageGenResponse, BYTEDANCE_SEEDREAM_5_LITE_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn bytedance_seedream_5_lite_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: BytedanceSeedream5LiteMultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + BYTEDANCE_SEEDREAM_5_LITE_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_v4_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_v4_multi_function_image_gen_image.rs new file mode 100644 index 00000000..9cb01f3b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_v4_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::bytedance_seedream_v4_multi_function_image_gen::{BytedanceSeedreamV4MultiFunctionImageGenRequest, BytedanceSeedreamV4MultiFunctionImageGenResponse, BYTEDANCE_SEEDREAM_V4_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn bytedance_seedream_v4_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: BytedanceSeedreamV4MultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + BYTEDANCE_SEEDREAM_V4_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_v4p5_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_v4p5_multi_function_image_gen_image.rs new file mode 100644 index 00000000..a71637f5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/bytedance_seedream_v4p5_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::bytedance_seedream_v4p5_multi_function_image_gen::{BytedanceSeedreamV4p5MultiFunctionImageGenRequest, BytedanceSeedreamV4p5MultiFunctionImageGenResponse, BYTEDANCE_SEEDREAM_V4P5_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn bytedance_seedream_v4p5_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: BytedanceSeedreamV4p5MultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + BYTEDANCE_SEEDREAM_V4P5_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/gpt_image_1p5_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/gpt_image_1p5_multi_function_image_gen_image.rs new file mode 100644 index 00000000..38551b11 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/gpt_image_1p5_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::gpt_image_1p5_multi_function_image_gen::{GptImage1p5MultiFunctionImageGenRequest, GptImage1p5MultiFunctionImageGenResponse, GPT_IMAGE_1P5_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn gpt_image_1p5_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GptImage1p5MultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GPT_IMAGE_1P5_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/mod.rs new file mode 100644 index 00000000..cc3e6edc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/mod.rs @@ -0,0 +1,7 @@ +pub mod bytedance_seedream_v4_multi_function_image_gen_image; +pub mod bytedance_seedream_v4p5_multi_function_image_gen_image; +pub mod bytedance_seedream_5_lite_multi_function_image_gen_image; +pub mod gpt_image_1p5_multi_function_image_gen_image; +pub mod nano_banana_2_multi_function_image_gen_image; +pub mod nano_banana_multi_function_image_gen_image; +pub mod nano_banana_pro_multi_function_image_gen_image; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_2_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_2_multi_function_image_gen_image.rs new file mode 100644 index 00000000..3a74a5a3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_2_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::nano_banana_2_multi_function_image_gen::{NanaBanana2MultiFunctionImageGenRequest, NanaBanana2MultiFunctionImageGenResponse, NANO_BANANA_2_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn nano_banana_2_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: NanaBanana2MultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + NANO_BANANA_2_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_multi_function_image_gen_image.rs new file mode 100644 index 00000000..d26077e7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::nano_banana_multi_function_image_gen::{NanoBananaMultiFunctionImageGenRequest, NanoBananaMultiFunctionImageGenResponse, NANO_BANANA_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn nano_banana_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: NanoBananaMultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + NANO_BANANA_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_pro_multi_function_image_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_pro_multi_function_image_gen_image.rs new file mode 100644 index 00000000..591d0dd6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/multi_function/nano_banana_pro_multi_function_image_gen_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::multi_function::nano_banana_pro_multi_function_image_gen::{NanoBananaProMultiFunctionImageGenRequest, NanoBananaProMultiFunctionImageGenResponse, NANO_BANANA_PRO_MULTI_FUNCTION_IMAGE_GEN_PATH}; + +pub async fn nano_banana_pro_multi_function_image_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: NanoBananaProMultiFunctionImageGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + NANO_BANANA_PRO_MULTI_FUNCTION_IMAGE_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_1_dev_text_to_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_1_dev_text_to_image.rs new file mode 100644 index 00000000..dcd0a466 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_1_dev_text_to_image.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::text::generate_flux_1_dev_text_to_image::{GenerateFlux1DevTextToImageRequest, GenerateFlux1DevTextToImageResponse, GENERATE_FLUX_1_DEV_TEXT_TO_IMAGE_PATH}; + + +pub async fn generate_flux_1_dev_text_to_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateFlux1DevTextToImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_FLUX_1_DEV_TEXT_TO_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_1_schnell_text_to_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_1_schnell_text_to_image.rs new file mode 100644 index 00000000..0c1fc8b3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_1_schnell_text_to_image.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::text::generate_flux_1_schnell_text_to_image::{GenerateFlux1SchnellTextToImageRequest, GenerateFlux1SchnellTextToImageResponse, GENERATE_FLUX_1_SCHNELL_TEXT_TO_IMAGE_PATH}; + + +pub async fn generate_flux_1_schnell_text_to_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateFlux1SchnellTextToImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_FLUX_1_SCHNELL_TEXT_TO_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_pro_11_text_to_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_pro_11_text_to_image.rs new file mode 100644 index 00000000..fa286453 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_pro_11_text_to_image.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::text::generate_flux_pro_11_text_to_image::{GenerateFluxPro11TextToImageRequest, GenerateFluxPro11TextToImageResponse, GENERATE_FLUX_PRO_11_TEXT_TO_IMAGE_PATH}; + + +pub async fn generate_flux_pro_11_text_to_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateFluxPro11TextToImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_FLUX_PRO_11_TEXT_TO_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_pro_11_ultra_text_to_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_pro_11_ultra_text_to_image.rs new file mode 100644 index 00000000..db8819be --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_flux_pro_11_ultra_text_to_image.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::text::generate_flux_pro_11_ultra_text_to_image::{GenerateFluxPro11UltraTextToImageRequest, GenerateFluxPro11UltraTextToImageResponse, GENERATE_FLUX_PRO_11_ULTRA_TEXT_TO_IMAGE_PATH}; + +pub async fn generate_flux_pro_11_ultra_text_to_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateFluxPro11UltraTextToImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_FLUX_PRO_11_ULTRA_TEXT_TO_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_gpt_image_1_text_to_image.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_gpt_image_1_text_to_image.rs new file mode 100644 index 00000000..1c311550 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/generate_gpt_image_1_text_to_image.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::image::text::generate_gpt_image_1_text_to_image::{GenerateGptImage1TextToImageRequest, GenerateGptImage1TextToImageResponse, GPT_IMAGE_1_TEXT_TO_IMAGE_PATH}; + + +pub async fn generate_gpt_image_1_text_to_image( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateGptImage1TextToImageRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GPT_IMAGE_1_TEXT_TO_IMAGE_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/mod.rs new file mode 100644 index 00000000..baf99b02 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/image/text/mod.rs @@ -0,0 +1,5 @@ +pub mod generate_flux_1_dev_text_to_image; +pub mod generate_flux_1_schnell_text_to_image; +pub mod generate_flux_pro_11_text_to_image; +pub mod generate_flux_pro_11_ultra_text_to_image; +pub mod generate_gpt_image_1_text_to_image; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/mod.rs new file mode 100644 index 00000000..41418113 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/mod.rs @@ -0,0 +1,5 @@ +pub mod cost_estimate; +pub mod image; +pub mod object; +pub mod splat; +pub mod video; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/object/generate_hunyuan_3d_2_0_image_to_3d.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/object/generate_hunyuan_3d_2_0_image_to_3d.rs new file mode 100644 index 00000000..45e1a295 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/object/generate_hunyuan_3d_2_0_image_to_3d.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::object::generate_hunyuan_2_0_image_to_3d::{GenerateHunyuan20ImageTo3dRequest, GenerateHunyuan20ImageTo3dResponse, GENERATE_HUNYUAN_2_0_IMAGE_TO_3D_URL_PATH}; + +pub async fn generate_hunyuan3d_2_0_image_to_3d( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateHunyuan20ImageTo3dRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_HUNYUAN_2_0_IMAGE_TO_3D_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/object/generate_hunyuan_3d_2_1_image_to_3d.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/object/generate_hunyuan_3d_2_1_image_to_3d.rs new file mode 100644 index 00000000..d5f63b2d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/object/generate_hunyuan_3d_2_1_image_to_3d.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::object::generate_hunyuan_2_1_image_to_3d::{GenerateHunyuan21ImageTo3dRequest, GenerateHunyuan21ImageTo3dResponse, GENERATE_HUNYUAN_2_1_IMAGE_TO_3D_URL_PATH}; + +pub async fn generate_hunyuan3d_2_1_image_to_3d( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateHunyuan21ImageTo3dRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_HUNYUAN_2_1_IMAGE_TO_3D_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/object/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/object/mod.rs new file mode 100644 index 00000000..205c136e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/object/mod.rs @@ -0,0 +1,3 @@ +pub mod generate_hunyuan_3d_2_0_image_to_3d; +pub mod generate_hunyuan_3d_2_1_image_to_3d; +pub mod multi_function; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/object/multi_function/hunyuan3d_v3_multi_function_object_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/object/multi_function/hunyuan3d_v3_multi_function_object_gen.rs new file mode 100644 index 00000000..5a947af7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/object/multi_function/hunyuan3d_v3_multi_function_object_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::object::multi_function::hunyuan3d_v3_multi_function_object_gen::{Hunyuan3dV3MultiFunctionObjectGenRequest, Hunyuan3dV3MultiFunctionObjectGenResponse, HUNYUAN3D_V3_MULTI_FUNCTION_OBJECT_GEN_PATH}; + +pub async fn hunyuan3d_v3_multi_function_object_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Hunyuan3dV3MultiFunctionObjectGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + HUNYUAN3D_V3_MULTI_FUNCTION_OBJECT_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/object/multi_function/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/object/multi_function/mod.rs new file mode 100644 index 00000000..22285b9e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/object/multi_function/mod.rs @@ -0,0 +1 @@ +pub mod hunyuan3d_v3_multi_function_object_gen; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/splat/generate_worldlabs_marble_0p1_mini_splat.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/splat/generate_worldlabs_marble_0p1_mini_splat.rs new file mode 100644 index 00000000..7d1679b4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/splat/generate_worldlabs_marble_0p1_mini_splat.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::splat::generate_worldlabs_marble_0p1_mini_splat::{GenerateWorldlabsMarble0p1MiniSplatRequest, GenerateWorldlabsMarble0p1MiniSplatResponse, GENERATE_WORLDLABS_MARBLE_0P1_MINI_SPLAT_URL_PATH}; + +pub async fn generate_worldlabs_marble_0p1_mini_splat( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateWorldlabsMarble0p1MiniSplatRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_WORLDLABS_MARBLE_0P1_MINI_SPLAT_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/splat/generate_worldlabs_marble_0p1_plus_splat.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/splat/generate_worldlabs_marble_0p1_plus_splat.rs new file mode 100644 index 00000000..63cd46e8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/splat/generate_worldlabs_marble_0p1_plus_splat.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::splat::generate_worldlabs_marble_0p1_plus_splat::{GenerateWorldlabsMarble0p1PlusSplatRequest, GenerateWorldlabsMarble0p1PlusSplatResponse, GENERATE_WORLDLABS_MARBLE_0P1_PLUS_SPLAT_URL_PATH}; + +pub async fn generate_worldlabs_marble_0p1_plus_splat( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateWorldlabsMarble0p1PlusSplatRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_WORLDLABS_MARBLE_0P1_PLUS_SPLAT_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/splat/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/splat/mod.rs new file mode 100644 index 00000000..68557f53 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/splat/mod.rs @@ -0,0 +1,2 @@ +pub mod generate_worldlabs_marble_0p1_mini_splat; +pub mod generate_worldlabs_marble_0p1_plus_splat; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/edit/beeble_switchx_edit_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/edit/beeble_switchx_edit_video.rs new file mode 100644 index 00000000..fce7bc4f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/edit/beeble_switchx_edit_video.rs @@ -0,0 +1,20 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::edit::beeble_switchx_edit_video::{ + BeebleSwitchXEditVideoRequest, BeebleSwitchXEditVideoResponse, BEEBLE_SWITCHX_EDIT_VIDEO_PATH, +}; + +pub async fn beeble_switchx_edit_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: BeebleSwitchXEditVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + BEEBLE_SWITCHX_EDIT_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/edit/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/edit/mod.rs new file mode 100644 index 00000000..ad8f1b29 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/edit/mod.rs @@ -0,0 +1 @@ +pub mod beeble_switchx_edit_video; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_16_pro_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_16_pro_image_to_video.rs new file mode 100644 index 00000000..1475224f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_16_pro_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_kling_1_6_pro_image_to_video::{GenerateKling16ProImageToVideoRequest, GenerateKling16ProImageToVideoResponse, GENERATE_KLING_1_6_PRO_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_kling_16_pro_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateKling16ProImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_KLING_1_6_PRO_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_21_master_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_21_master_image_to_video.rs new file mode 100644 index 00000000..de10f13e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_21_master_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_kling_2_1_master_image_to_video::{GenerateKling21MasterImageToVideoRequest, GenerateKling21MasterImageToVideoResponse, GENERATE_KLING_2_1_MASTER_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_kling_21_master_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateKling21MasterImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_KLING_2_1_MASTER_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_21_pro_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_21_pro_image_to_video.rs new file mode 100644 index 00000000..cfe52a4f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_kling_21_pro_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_kling_2_1_pro_image_to_video::{GenerateKling21ProImageToVideoRequest, GenerateKling21ProImageToVideoResponse, GENERATE_KLING_2_1_PRO_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_kling_21_pro_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateKling21ProImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_KLING_2_1_PRO_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_seedance_1_0_lite_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_seedance_1_0_lite_image_to_video.rs new file mode 100644 index 00000000..3da5c80f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_seedance_1_0_lite_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_seedance_1_0_lite_image_to_video::{GenerateSeedance10LiteImageToVideoRequest, GenerateSeedance10LiteImageToVideoResponse, GENERATE_SEEDANCE_1_0_LITE_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_seedance_1_0_lite_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateSeedance10LiteImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_SEEDANCE_1_0_LITE_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_2_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_2_image_to_video.rs new file mode 100644 index 00000000..2919338d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_2_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_veo_2_image_to_video::{GenerateVeo2ImageToVideoRequest, GenerateVeo2ImageToVideoResponse, GENERATE_VEO_2_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_veo_2_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateVeo2ImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_VEO_2_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_3_fast_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_3_fast_image_to_video.rs new file mode 100644 index 00000000..918db2bb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_3_fast_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_veo_3_fast_image_to_video::{GenerateVeo3FastImageToVideoRequest, GenerateVeo3FastImageToVideoResponse, GENERATE_VEO_3_FAST_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_veo_3_fast_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateVeo3FastImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_VEO_3_FAST_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_3_image_to_video.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_3_image_to_video.rs new file mode 100644 index 00000000..13792bd0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/generate_veo_3_image_to_video.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::generate_veo_3_image_to_video::{GenerateVeo3ImageToVideoRequest, GenerateVeo3ImageToVideoResponse, GENERATE_VEO_3_IMAGE_TO_VIDEO_URL_PATH}; + +pub async fn generate_veo_3_image_to_video( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: GenerateVeo3ImageToVideoRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + GENERATE_VEO_3_IMAGE_TO_VIDEO_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/mod.rs new file mode 100644 index 00000000..ebae4b56 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/mod.rs @@ -0,0 +1,9 @@ +pub mod edit; +pub mod generate_kling_16_pro_image_to_video; +pub mod generate_kling_21_master_image_to_video; +pub mod generate_kling_21_pro_image_to_video; +pub mod generate_seedance_1_0_lite_image_to_video; +pub mod generate_veo_2_image_to_video; +pub mod generate_veo_3_fast_image_to_video; +pub mod generate_veo_3_image_to_video; +pub mod multi_function; diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_2p5_turbo_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_2p5_turbo_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..46b75a42 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_2p5_turbo_pro_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::kling_2_5_turbo_multi_function_video_gen::{Kling2p5TurboProMultiFunctionVideoGenRequest, Kling2p5TurboProMultiFunctionVideoGenResponse, KLING_2P5_TURBO_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH}; + +pub async fn kling_2p5_turbo_pro_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Kling2p5TurboProMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + KLING_2P5_TURBO_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_2p6_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_2p6_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..e788c93b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_2p6_pro_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::kling_2_6_multi_function_video_gen::{Kling2p6ProMultiFunctionVideoGenRequest, Kling2p6ProMultiFunctionVideoGenResponse, KLING_2P6_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH}; + +pub async fn kling_2p6_pro_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Kling2p6ProMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + KLING_2P6_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_3p0_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_3p0_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..a42266a0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_3p0_pro_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::kling_3p0_pro_multi_function_video_gen::{Kling3p0ProMultiFunctionVideoGenRequest, Kling3p0ProMultiFunctionVideoGenResponse, KLING_3P0_PRO_MULTI_FUNCTION_VIDEO_PATH}; + +pub async fn kling_3p0_pro_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Kling3p0ProMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + KLING_3P0_PRO_MULTI_FUNCTION_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_3p0_standard_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_3p0_standard_multi_function_video_gen.rs new file mode 100644 index 00000000..0de3a74e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/kling_3p0_standard_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::kling_3p0_standard_multi_function_video_gen::{Kling3p0StandardMultiFunctionVideoGenRequest, Kling3p0StandardMultiFunctionVideoGenResponse, KLING_3P0_STANDARD_MULTI_FUNCTION_VIDEO_PATH}; + +pub async fn kling_3p0_standard_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Kling3p0StandardMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + KLING_3P0_STANDARD_MULTI_FUNCTION_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/mod.rs new file mode 100644 index 00000000..f8296774 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/mod.rs @@ -0,0 +1,10 @@ +pub mod kling_2p5_turbo_pro_multi_function_video_gen; +pub mod seedance_1p5_pro_multi_function_video_gen; +pub mod seedance_2p0_multi_function_video_gen; +pub mod kling_2p6_pro_multi_function_video_gen; +pub mod kling_3p0_pro_multi_function_video_gen; +pub mod kling_3p0_standard_multi_function_video_gen; +pub mod sora_2_multi_function_video_gen; +pub mod sora_2_pro_multi_function_video_gen; +pub mod veo_3p1_fast_multi_function_video_gen; +pub mod veo_3p1_multi_function_video_gen; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/seedance_1p5_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/seedance_1p5_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..50b02468 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/seedance_1p5_pro_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::seedance_1p5_pro_multi_function_video_gen::{Seedance1p5ProMultiFunctionVideoGenRequest, Seedance1p5ProMultiFunctionVideoGenResponse, SEEDANCE_1P5_PRO_MULTI_FUNCTION_VIDEO_GEN_PATH}; + +pub async fn seedance_1p5_pro_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Seedance1p5ProMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + SEEDANCE_1P5_PRO_MULTI_FUNCTION_VIDEO_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/seedance_2p0_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/seedance_2p0_multi_function_video_gen.rs new file mode 100644 index 00000000..a9554f26 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/seedance_2p0_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::seedance_2p0_multi_function_video_gen::{Seedance2p0MultiFunctionVideoGenRequest, Seedance2p0MultiFunctionVideoGenResponse, SEEDANCE_2P0_MULTI_FUNCTION_VIDEO_GEN_PATH}; + +pub async fn seedance_2p0_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Seedance2p0MultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + SEEDANCE_2P0_MULTI_FUNCTION_VIDEO_GEN_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/sora_2_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/sora_2_multi_function_video_gen.rs new file mode 100644 index 00000000..c332ae64 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/sora_2_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::sora_2_multi_function_video_gen::{Sora2MultiFunctionVideoGenRequest, Sora2MultiFunctionVideoGenResponse, SORA_2_MULTI_FUNCTION_VIDEO_VIDEO_PATH}; + +pub async fn sora_2_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Sora2MultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + SORA_2_MULTI_FUNCTION_VIDEO_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/sora_2_pro_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/sora_2_pro_multi_function_video_gen.rs new file mode 100644 index 00000000..af823f75 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/sora_2_pro_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::sora_2_pro_multi_function_video_gen::{Sora2ProMultiFunctionVideoGenRequest, Sora2ProMultiFunctionVideoGenResponse, SORA_2_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH}; + +pub async fn sora_2_pro_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Sora2ProMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + SORA_2_PRO_MULTI_FUNCTION_VIDEO_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/veo_3p1_fast_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/veo_3p1_fast_multi_function_video_gen.rs new file mode 100644 index 00000000..1a4212e0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/veo_3p1_fast_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::veo_3p1_fast_multi_function_video_gen::{Veo3p1FastMultiFunctionVideoGenRequest, Veo3p1FastMultiFunctionVideoGenResponse, VEO_3P1_FAST_MULTI_FUNCTION_VIDEO_VIDEO_PATH}; + +pub async fn veo_3p1_fast_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Veo3p1FastMultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + VEO_3P1_FAST_MULTI_FUNCTION_VIDEO_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/veo_3p1_multi_function_video_gen.rs b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/veo_3p1_multi_function_video_gen.rs new file mode 100644 index 00000000..3baf20ca --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/generate/video/multi_function/veo_3p1_multi_function_video_gen.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::generate::video::multi_function::veo_3p1_multi_function_video_gen::{Veo3p1MultiFunctionVideoGenRequest, Veo3p1MultiFunctionVideoGenResponse, VEO_3P1_MULTI_FUNCTION_VIDEO_VIDEO_PATH}; + +pub async fn veo_3p1_multi_function_video_gen( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Veo3p1MultiFunctionVideoGenRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + VEO_3P1_MULTI_FUNCTION_VIDEO_VIDEO_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/jobs/batch_get_job_status.rs b/crates/api_clients/artcraft_client/src/endpoints/jobs/batch_get_job_status.rs new file mode 100644 index 00000000..e9743e7b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/jobs/batch_get_job_status.rs @@ -0,0 +1,46 @@ +//! Binding for `GET /v1/jobs/batch` — get job statuses for a batch of job tokens. + +use crate::api_defs::jobs::batch_get_job_status::{batch_get_job_status_url_path, BatchGetJobStatusSuccessResponse}; +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +/// Get the statuses of multiple jobs in one request. +/// Publicly exposed; credentials are optional. Unknown tokens are simply +/// absent from the response's `job_states`. +pub async fn batch_get_job_status( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + job_tokens: &[InferenceJobToken], +) -> Result { + basic_json_get_request( + api_host, + &batch_get_job_status_url_path(job_tokens), + maybe_creds, + ).await +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + #[ignore] // Live: hits api.storyteller.ai (read-only, no credits) + async fn live_batch_get_job_status() { + let host = ApiHost::Storyteller; + let tokens = vec![ + InferenceJobToken::new_from_str("jinf_sxr641zj1qgfaky9j78hwerk1r2"), + InferenceJobToken::new_from_str("jinf_vrbjye4tzfczz3z81e0trz8zmx1"), + ]; + let result = batch_get_job_status(&host, None, &tokens).await.unwrap(); + + for state in &result.job_states { + println!("job {}: {:?}", state.job_token.as_str(), state.status.status); + } + + assert!(result.success); + assert_eq!(result.job_states.len(), 2); + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/jobs/get_job_status.rs b/crates/api_clients/artcraft_client/src/endpoints/jobs/get_job_status.rs new file mode 100644 index 00000000..a452fea3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/jobs/get_job_status.rs @@ -0,0 +1,42 @@ +//! Binding for `GET /v1/jobs/job/{token}` — get the status for a single job. + +use crate::api_defs::jobs::get_job_status::{get_job_status_url_path, GetJobStatusSuccessResponse}; +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +/// Get the status of a single job by its token. +/// Publicly exposed; credentials are optional. +pub async fn get_job_status( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + job_token: &InferenceJobToken, +) -> Result { + basic_json_get_request( + api_host, + &get_job_status_url_path(job_token), + maybe_creds, + ).await +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + #[ignore] // Live: hits api.storyteller.ai (read-only, no credits) + async fn live_get_job_status() { + let host = ApiHost::Storyteller; + // A known completed job (nano banana smoke test). + let token = InferenceJobToken::new_from_str("jinf_sxr641zj1qgfaky9j78hwerk1r2"); + let result = get_job_status(&host, None, &token).await.unwrap(); + + println!("state.status: {:?}", result.state.status.status); + println!("maybe_result: entity_token={:?}", result.state.maybe_result.as_ref().map(|r| &r.entity_token)); + + assert!(result.success); + assert_eq!(result.state.job_token.as_str(), token.as_str()); + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/jobs/list_session_jobs.rs b/crates/api_clients/artcraft_client/src/endpoints/jobs/list_session_jobs.rs new file mode 100644 index 00000000..1fcdb02f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/jobs/list_session_jobs.rs @@ -0,0 +1,43 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; +use crate::api_defs::jobs::list_session_jobs::{ListSessionJobsSuccessResponse, LIST_SESSION_JOBS_URL_PATH}; +use crate::enums::common::job_status_plus::JobStatusPlus; +use std::collections::HashSet; + +#[derive(Clone)] +pub enum States { + All, + Include(HashSet), + Exclude(HashSet), +} + +pub async fn list_session_jobs( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + job_states: States, +) -> Result { + + let url = match job_states { + States::All => + LIST_SESSION_JOBS_URL_PATH.to_string(), + States::Include(states) => + format!("{}?include_states={}", LIST_SESSION_JOBS_URL_PATH, states_string(&states)), + States::Exclude(states) => + format!("{}?exclude_states={}", LIST_SESSION_JOBS_URL_PATH, states_string(&states)), + }; + + Ok(basic_json_get_request( + api_host, + &url, + maybe_creds, + ).await?) +} + +fn states_string(states: &HashSet) -> String { + states.iter() + .map(|state| state.to_str()) + .collect::>() + .join(",") +} \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/jobs/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/jobs/mod.rs new file mode 100644 index 00000000..fc5d2f18 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/jobs/mod.rs @@ -0,0 +1,3 @@ +pub mod batch_get_job_status; +pub mod get_job_status; +pub mod list_session_jobs; diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/delete_media_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/delete_media_file.rs new file mode 100644 index 00000000..4c385935 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/delete_media_file.rs @@ -0,0 +1,36 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_delete_request::basic_json_delete_request; +use crate::api_defs::common::responses::simple_generic_json_success::SimpleGenericJsonSuccess; +use crate::api_defs::media_file::delete_media_file::DeleteMediaFileRequest; +use crate::api_defs::subscriptions::get_session_subscription::GetSessionSubscriptionResponse; +use log::debug; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +pub async fn delete_media_file( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + media_file_token: &MediaFileToken, +) -> Result { + let url_path = get_url_path(media_file_token); + + debug!("Requesting {:?}", &url_path); + + // NB: We probably don't need to expose these options from FakeYou anymore. + let request = DeleteMediaFileRequest { + set_delete: true, + as_mod: None, + }; + + Ok(basic_json_delete_request( + api_host, + &url_path, + maybe_creds, + request, + ).await?) +} + +fn get_url_path(token: &MediaFileToken) -> String { + format!("/v1/media_files/file/{}", token.as_str()) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/get_media_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/get_media_file.rs new file mode 100644 index 00000000..15464815 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/get_media_file.rs @@ -0,0 +1,221 @@ +use crate::error::api_error::ApiError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::filter_bad_response::filter_bad_response; +use crate::utils::http_get_anonymous::http_get_anonymous; +use crate::api_defs::common::responses::media_file_cover_image_details::MediaFileCoverImageDetails; +use crate::api_defs::common::responses::media_links::MediaLinks; +use crate::api_defs::common::responses::simple_entity_stats::SimpleEntityStats; +use crate::api_defs::common::responses::user_details_light::UserDetailsLight; +use chrono::{DateTime, Utc}; +use crate::enums::by_table::media_files::media_file_animation_type::MediaFileAnimationType; +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; +use crate::enums::by_table::media_files::media_file_engine_category::MediaFileEngineCategory; +use crate::enums::by_table::media_files::media_file_type::MediaFileType; +use crate::enums::by_table::model_weights::weights_category::WeightsCategory; +use crate::enums::common::visibility::Visibility; +use crate::enums::no_table::style_transfer::style_transfer_name::StyleTransferName; +use crate::enums::by_table::model_weights::weights_types::WeightsType; +use log::debug; +use serde_derive::Deserialize; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::model_weights::ModelWeightToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +/// Get details about a media file from our backend +pub async fn get_media_file(api_host: &ApiHost, media_file_token: &MediaFileToken) -> Result { + let url = get_media_file_token_route(api_host, media_file_token); + + debug!("Requesting {:?}", &url); + + let response = http_get_anonymous(url).await?; + let response = filter_bad_response(response).await?; + let response_body = &response.text().await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let media_file = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(media_file) +} + +fn get_media_file_token_route(api_host: &ApiHost, media_file_token: &MediaFileToken) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + let media_file_token = media_file_token.as_str(); + format!("{}/v1/media_files/file/{}", api_hostname_and_scheme, media_file_token) +} + +// TODO(bt,2025-04-22): Share API definitions between client and server in common crate. + +#[derive(Deserialize, Debug)] +pub struct GetMediaFileSuccessResponse { + pub success: bool, + pub media_file: MediaFileInfo, +} + +#[derive(Deserialize, Debug)] +pub struct MediaFileInfo { + pub token: MediaFileToken, + + /// The coarse-grained class of media file: image, video, etc. + pub media_class: MediaFileClass, + + /// Type of media will dictate which fields are populated and what + /// the frontend should display (eg. video player vs audio player). + /// This is closer in meaning to a "mime type". + pub media_type: MediaFileType, + + /// If this is an engine/3D asset, this is the broad category (scene, + /// animation, etc.) of that object. + /// This can also be used for filtering in list/batch endpoints. + pub maybe_engine_category: Option, + + /// If this is an engine/3D asset for an animation or a rig that can + /// be animated with either (or both) skeletal or blend shape animations, + /// this describes the animation regime used or supported. + pub maybe_animation_type: Option, + + // /// Extension for the engine to load over remote:// URLs. + // #[deprecated(note="This was for the Bevy engine. Do not use.")] + // pub maybe_engine_extension: Option, + + /// If the file was generated as part of a batch, this is the token for the batch. + pub maybe_batch_token: Option, + + /// If this media file was generated by a scene from the engine, this is a + /// link to that file. + pub maybe_scene_source_media_file_token: Option, + + // /// (DEPRECATED) URL path to the media file + // #[deprecated(note="This field doesn't point to the full URL. Use media_links instead to leverage the CDN.")] + // pub public_bucket_path: String, + + // /// (DEPRECATED) Full URL to the media file + // #[deprecated(note="This points to the bucket. Use media_links instead to leverage the CDN.")] + // pub public_bucket_url: Url, + + /// Rich CDN links to the media, including thumbnails, previews, and more. + pub media_links: MediaLinks, + + /// Information about the cover image. Many media files do not require a cover image, + /// e.g. image files, video files with thumbnails, audio files, etc. + /// 3D files require them. + pub cover_image: MediaFileCoverImageDetails, + + //// Provenance Data + //pub origin_product: MediaFileOriginProductCategory, + //pub origin_category: MediaFileOriginCategory, + //pub maybe_origin_model_type: Option, + //pub maybe_origin_model_token: Option, + //pub maybe_origin_filename: Option, + + /// Possible model info (if generated by inference) + pub maybe_model_weight_info: Option, + + /// User info + pub maybe_creator_user: Option, + + pub creator_set_visibility: Visibility, + + /// The file was uploaded by the user. + /// This does not include files generated on the client side, like studio renders. + pub is_user_upload: bool, + + /// The file was created by the system. + /// This includes files generated on the client side, like studio renders. + pub is_intermediate_system_file: bool, + + /// The name or title of the media file (optional) + pub maybe_title: Option, + + /// Text transcripts for TTS, etc. + pub maybe_text_transcript: Option, + + // /// OPTIONAL. Details on live portrait generated media files, + // /// if this is a live portrait generated file. + // pub maybe_live_portrait_details: Option, + + /// For Comfy / Video Style Transfer jobs, this might include + /// the name of the selected style. + pub maybe_style_name: Option, + + /// For Comfy / Video Style Transfer jobs, this indicates use of face detailer. + pub used_face_detailer: bool, + + /// For Comfy / Video Style Transfer jobs, this indicates use of upscaling. + pub used_upscaler: bool, + + /// The foreign key to the prompt used to generate the media, if applicable. + pub maybe_prompt_token: Option, + + /// The original filename for uploaded files, if they were provided. + /// In the future we'll provide our own internal optional filenames. + pub maybe_original_filename: Option, + + /// Duration for audio and video files, if available. + /// Measured in milliseconds. + pub maybe_duration_millis: Option, + + /// We can simulate media files for "tts_results" records. + /// If this is set as true, this informs the frontend and API callers not to treat + /// the token as a media file and improperly assume it can be used with the rest of + /// the media file APIs. + pub is_emulated_media_file: bool, + + /// Whether the media file is featured by staff (the featured_items API) or not. + pub is_featured: bool, + + /// Statistics about the media file + pub stats: SimpleEntityStats, + + pub created_at: DateTime, + pub updated_at: DateTime, + + pub maybe_moderator_fields: Option, +} + +#[derive(Deserialize, Debug)] +pub struct GetMediaFileModeratorFields { + /// This may become public in the future. + pub maybe_style_transfer_source_media_file_token: Option, + //pub creator_ip_address: String, + //pub creator_is_banned_if_user: bool, + //pub maybe_creator_deleted_at: Option>, + //pub maybe_mod_deleted_at: Option>, +} + +#[derive(Deserialize, Debug)] +pub struct GetMediaFileModelInfo { + pub weight_token: ModelWeightToken, + pub weight_type: WeightsType, + pub weight_category: WeightsCategory, + pub title: String, + + /// Cover images are small descriptive images that can be set for any model. + /// If a cover image is set, this is the path to the asset. + pub maybe_cover_image_public_bucket_path: Option, + + /// NB: Technically this shouldn't be a nullable field, but since there are so many + /// joins we'll relax that this must exist (for now). + pub maybe_weight_creator: Option, +} + +#[cfg(test)] +mod tests { + use crate::endpoints::media_files::get_media_file::get_media_file; + use crate::utils::api_host::ApiHost; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + #[tokio::test] + #[ignore] // Don't run in CI. Requires valid cookie + async fn test_request() { + let host = ApiHost::Storyteller; + let token = MediaFileToken::new_from_str("m_gff67btr810vg3ng9szj85zskztcgy"); + let result = get_media_file(&host, &token).await.unwrap(); + + println!("Result: {:?}", &result); + + assert_eq!(result.success, false); // NB: Will fail so we can see debug printed result. + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/legacy_upload_media_file_from_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/legacy_upload_media_file_from_file.rs new file mode 100644 index 00000000..01e7497a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/legacy_upload_media_file_from_file.rs @@ -0,0 +1,137 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use crate::utils::http_get_anonymous::http_get_anonymous; +use chrono::{DateTime, Utc}; +use core_types::enums::generation_source::GenerationSource; +use uuid_utils::uuid::generate_random_uuid; +use log::debug; +use reqwest::multipart::{Form, Part}; +use reqwest::Client; +use serde_derive::{Deserialize, Serialize}; +use std::path::Path; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::model_weights::ModelWeightToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use uuid::uuid; + +pub struct LegacyUploadMediaFileFromFileArgs<'a, P: AsRef> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + + // NB: Path needs to be owned for the request. + pub path: P, + + // /// If true, we should hide the image from the user's gallery. + // pub is_intermediate_system_file: bool, + + // /// If provided, this is the prompt that this image is associated with. + // /// NOTE: Cannot set `is_intermediate_system_file = true` if this is set. + // pub maybe_prompt_token: Option<&'a PromptToken>, + + /// If provided, the third-party provider that generated this file. + pub maybe_generation_provider: Option, + + // /// If provided, this groups the file into a batch + // /// TODO: This shouldn't be set clientside without the backend generating the token + // /// and cryptographically securing it. But we need to go fast here. + // pub maybe_batch_token: Option<&'a BatchGenerationToken>, +} + +/// Upload using the legacy endpoint (spz, etc.) +pub async fn legacy_upload_media_file_from_file>( + args: LegacyUploadMediaFileFromFileArgs<'_, P>, +) -> Result { + + validate_args(&args)?; + + let url = get_route(args.api_host); + + debug!("Requesting {:?}", &url); + + //let mut file = File::open(path)?; + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let file_bytes = std::fs::read(args.path.as_ref()) + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + let file_name = args.path.as_ref().file_name() + .and_then(|n| n.to_str()).unwrap_or("file").to_string(); + let mut form = Form::new() + .text("uuid_idempotency_token", generate_random_uuid()) + .part("file", Part::bytes(file_bytes).file_name(file_name)); + + //if args.is_intermediate_system_file { + // form = form.text("is_intermediate_system_file", "true"); + //} + + //if let Some(prompt_token) = &args.maybe_prompt_token { + // form = form.text("maybe_prompt_token", prompt_token.to_string()); + //} + + //if let Some(batch_token) = &args.maybe_batch_token { + // form = form.text("maybe_batch_token", batch_token.to_string()); + //} + + if let Some(provider) = &args.maybe_generation_provider { + form = form.text("maybe_generation_provider", provider.to_str().to_string()); + } + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = args.maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .multipart(form) + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response = filter_bad_response(response).await?; + let response_body = &response.text().await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let media_file = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(media_file) +} + +fn get_route(api_host: &ApiHost) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + format!("{}/v1/media_files/upload", api_hostname_and_scheme) +} + +// TODO(bt,2025-04-22): Share API definitions between client and server in common crate. + +#[derive(Deserialize, Debug)] +pub struct UploadImageMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} + +fn validate_args>( + args: &LegacyUploadMediaFileFromFileArgs<'_, P>, +) -> Result<(), StorytellerError> { + // if args.is_intermediate_system_file && args.maybe_prompt_token.is_some() { + // return Err(StorytellerError::Client(ClientError::InvalidPreflightRequest( + // "Cannot set `is_intermediate_system_file` to true if `maybe_prompt_token` is provided." + // .to_string()))); + // } + + Ok(()) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/list_batch_generated_redux_media_files.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/list_batch_generated_redux_media_files.rs new file mode 100644 index 00000000..df96b026 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/list_batch_generated_redux_media_files.rs @@ -0,0 +1,19 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; +use crate::api_defs::media_file::list_batch_generated_media_files::{ListBatchGeneratedReduxMediaFilesSuccessResponse, LIST_BATCH_GENERATED_REDUX_MEDIA_FILES_URL_PATH}; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; + +pub async fn list_batch_generated_redux_media_files( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + batch_token: &BatchGenerationToken, +) -> Result { + let url = format!("{}/{}", LIST_BATCH_GENERATED_REDUX_MEDIA_FILES_URL_PATH, batch_token.to_string()); + Ok(basic_json_get_request( + api_host, + &url, + maybe_creds, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/list_media_files_by_job.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/list_media_files_by_job.rs new file mode 100644 index 00000000..db0c578f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/list_media_files_by_job.rs @@ -0,0 +1,64 @@ +//! Binding for `GET /v1/media_files/by_job/{job_token}` — list the media +//! files produced by an inference job. + +use crate::api_defs::media_file::list_media_files_by_job::{list_media_files_by_job_url_path, ListMediaFilesByJobSuccessResponse}; +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::tokens::generic_inference_jobs::InferenceJobToken; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +/// List the media files a completed job produced. +/// Requires an authenticated session (cookie or API key); the server only +/// returns files from the caller's own jobs — other users' jobs and unknown +/// tokens come back as an empty list. +pub async fn list_media_files_by_job( + api_host: &ApiHost, + creds: &StorytellerCredentialSet, + job_token: &InferenceJobToken, +) -> Result { + basic_json_get_request( + api_host, + &list_media_files_by_job_url_path(job_token), + Some(creds), + ).await +} + +#[cfg(test)] +mod tests { + use super::*; + + /// Load the desktop app's stored production credential cookie header. + fn load_artcraft_cookie_creds() -> StorytellerCredentialSet { + let home = std::env::var("HOME").expect("HOME not set"); + let path = format!("{home}/Artcraft/artcraftx/credentials/artcraft.toml"); + let contents = std::fs::read_to_string(&path).expect("no production credential on disk"); + let value: toml::Value = toml::from_str(&contents).expect("credential file should parse"); + let header = value + .get("cookie").and_then(|c| c.get("cookie_header")) + .and_then(|h| h.as_str()) + .expect("credential file has no cookie header"); + StorytellerCredentialSet::parse_multi_cookie_header(header) + .expect("cookie header should parse") + .expect("cookie header should contain session cookies") + } + + #[tokio::test] + #[ignore] // Live: hits api.storyteller.ai with the stored credential (read-only, no credits) + async fn live_list_media_files_by_job() { + let host = ApiHost::Storyteller; + let creds = load_artcraft_cookie_creds(); + // A known completed job (generic midjourney smoke test). + let token = InferenceJobToken::new_from_str("jinf_sxr641zj1qgfaky9j78hwerk1r2"); + let result = list_media_files_by_job(&host, &creds, &token).await.unwrap(); + + println!("media_files: {} entries", result.media_files.len()); + for file in &result.media_files { + println!("media file {}: class={:?} cdn={}", file.token.as_str(), file.media_class, file.media_links.cdn_url); + } + + // NB: Not all generation paths populate the media-file -> source-job + // linkage, so an empty list is valid for some completed jobs. + assert!(result.success); + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/mod.rs new file mode 100644 index 00000000..b25bbc62 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/mod.rs @@ -0,0 +1,10 @@ +pub mod delete_media_file; +pub mod get_media_file; +pub mod list_batch_generated_redux_media_files; +pub mod list_media_files_by_job; +pub mod upload_audio_media_file_from_file; +pub mod upload_image_media_file_from_bytes; +pub mod upload_image_media_file_from_file; +pub mod upload_new_engine_asset_from_file; +pub mod upload_video_media_file_from_file; +pub mod legacy_upload_media_file_from_file; diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_audio_media_file_from_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_audio_media_file_from_file.rs new file mode 100644 index 00000000..03045025 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_audio_media_file_from_file.rs @@ -0,0 +1,90 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use core_types::enums::generation_source::GenerationSource; +use uuid_utils::uuid::generate_random_uuid; +use log::debug; +use reqwest::multipart::{Form, Part}; +use reqwest::Client; +use serde_derive::Deserialize; +use std::path::Path; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +pub struct UploadAudioFromFileArgs<'a, P: AsRef> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + + // NB: Path needs to be owned for the request. + pub path: P, + + /// If provided, this is the prompt that this audio is associated with. + pub maybe_prompt_token: Option<&'a PromptToken>, + + /// If provided, the third-party provider that generated this file. + pub maybe_generation_provider: Option, +} + +#[derive(Deserialize, Debug)] +pub struct UploadAudioMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} + +/// Upload an audio media file from a file. +pub async fn upload_audio_media_file_from_file>( + args: UploadAudioFromFileArgs<'_, P>, +) -> Result { + + let url = get_route(args.api_host); + + debug!("Requesting {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build()?; + + let file_bytes = std::fs::read(args.path.as_ref())?; + let file_name = args.path.as_ref().file_name() + .and_then(|n| n.to_str()).unwrap_or("file").to_string(); + let mut form = Form::new() + .text("uuid_idempotency_token", generate_random_uuid()) + .part("file", Part::bytes(file_bytes).file_name(file_name)); + + if let Some(prompt_token) = &args.maybe_prompt_token { + form = form.text("maybe_prompt_token", prompt_token.to_string()); + } + + if let Some(provider) = &args.maybe_generation_provider { + form = form.text("maybe_generation_provider", provider.to_str().to_string()); + } + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = args.maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .multipart(form) + .send() + .await?; + + let response = filter_bad_response(response).await?; + let response_body = &response.text().await?; + + let media_file = serde_json::from_str(&response_body)?; + + Ok(media_file) +} + +fn get_route(api_host: &ApiHost) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + format!("{}/v1/media_files/upload/audio", api_hostname_and_scheme) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_image_media_file_from_bytes.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_image_media_file_from_bytes.rs new file mode 100644 index 00000000..f9ae9727 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_image_media_file_from_bytes.rs @@ -0,0 +1,134 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use crate::utils::http_get_anonymous::http_get_anonymous; +use core_types::enums::generation_source::GenerationSource; +use chrono::{DateTime, Utc}; +use uuid_utils::uuid::generate_random_uuid; +use log::debug; +use reqwest::multipart::{Form, Part}; +use reqwest::Client; +use serde_derive::{Deserialize, Serialize}; +use std::fs::File; +use std::io::Read; +use std::path::Path; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::model_weights::ModelWeightToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use uuid::uuid; + +pub struct UploadImageBytesArgs<'a> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + + // NB: Bytes need to be owned for the request. + pub image_bytes: Vec, + pub image_type: ImageType, + + /// If true, we should hide the image from the user's gallery. + pub is_intermediate_system_file: bool, + + /// If provided, the third-party provider that generated this file. + pub maybe_generation_provider: Option, +} + +#[derive(Clone, Copy, Debug)] +pub enum ImageType { + Png, + Jpeg, + Gif, +} + +impl ImageType { + pub fn mime_type(&self) -> &str { + match self { + ImageType::Png => "image/png", + ImageType::Jpeg => "image/jpeg", + ImageType::Gif => "image/gif", + } + } + pub fn file_extension(&self) -> &str { + match self { + ImageType::Png => "png", + ImageType::Jpeg => "jpg", + ImageType::Gif => "gif", + } + } +} + +/// Upload an image media file from a file. +/// NB: File type is not checked, so caller needs to enforce. +/// NB: We need owned bytes for the request. +pub async fn upload_image_media_file_from_bytes( + args: UploadImageBytesArgs<'_> +) -> Result { + + let url = get_route(args.api_host); + + debug!("Requesting {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let part = Part::bytes(args.image_bytes) + .file_name(format!("image.{}", args.image_type.file_extension())) + .mime_str(args.image_type.mime_type()) + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let mut form = Form::new() + .text("uuid_idempotency_token", generate_random_uuid()) + .part("file", part); + + if args.is_intermediate_system_file { + form = form.text("is_intermediate_system_file", "true"); + } + + if let Some(provider) = &args.maybe_generation_provider { + form = form.text("maybe_generation_provider", provider.to_str().to_string()); + } + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = args.maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .multipart(form) + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response = filter_bad_response(response).await?; + let response_body = &response.text().await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let media_file = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(media_file) +} + +fn get_route(api_host: &ApiHost) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + format!("{}/v1/media_files/upload/image", api_hostname_and_scheme) +} + +// TODO(bt,2025-04-22): Share API definitions between client and server in common crate. + +#[derive(Deserialize, Debug)] +pub struct UploadImageMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_image_media_file_from_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_image_media_file_from_file.rs new file mode 100644 index 00000000..91c722b1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_image_media_file_from_file.rs @@ -0,0 +1,137 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use crate::utils::http_get_anonymous::http_get_anonymous; +use chrono::{DateTime, Utc}; +use core_types::enums::generation_source::GenerationSource; +use uuid_utils::uuid::generate_random_uuid; +use log::debug; +use reqwest::multipart::{Form, Part}; +use reqwest::Client; +use serde_derive::{Deserialize, Serialize}; +use std::path::Path; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::model_weights::ModelWeightToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use uuid::uuid; + +pub struct UploadImageFromFileArgs<'a, P: AsRef> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + + // NB: Path needs to be owned for the request. + pub path: P, + + /// If true, we should hide the image from the user's gallery. + pub is_intermediate_system_file: bool, + + /// If provided, this is the prompt that this image is associated with. + /// NOTE: Cannot set `is_intermediate_system_file = true` if this is set. + pub maybe_prompt_token: Option<&'a PromptToken>, + + /// If provided, the third-party provider that generated this file. + pub maybe_generation_provider: Option, + + /// If provided, this groups the file into a batch + /// TODO: This shouldn't be set clientside without the backend generating the token + /// and cryptographically securing it. But we need to go fast here. + pub maybe_batch_token: Option<&'a BatchGenerationToken>, +} + +/// Upload an image media file from a file. +pub async fn upload_image_media_file_from_file>( + args: UploadImageFromFileArgs<'_, P>, +) -> Result { + + validate_args(&args)?; + + let url = get_route(args.api_host); + + debug!("Requesting {:?}", &url); + + //let mut file = File::open(path)?; + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let file_bytes = std::fs::read(args.path.as_ref()) + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + let file_name = args.path.as_ref().file_name() + .and_then(|n| n.to_str()).unwrap_or("file").to_string(); + let mut form = Form::new() + .text("uuid_idempotency_token", generate_random_uuid()) + .part("file", Part::bytes(file_bytes).file_name(file_name)); + + if args.is_intermediate_system_file { + form = form.text("is_intermediate_system_file", "true"); + } + + if let Some(prompt_token) = &args.maybe_prompt_token { + form = form.text("maybe_prompt_token", prompt_token.to_string()); + } + + if let Some(batch_token) = &args.maybe_batch_token { + form = form.text("maybe_batch_token", batch_token.to_string()); + } + + if let Some(provider) = &args.maybe_generation_provider { + form = form.text("maybe_generation_provider", provider.to_str().to_string()); + } + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = args.maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .multipart(form) + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response = filter_bad_response(response).await?; + let response_body = &response.text().await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let media_file = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(media_file) +} + +fn get_route(api_host: &ApiHost) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + format!("{}/v1/media_files/upload/image", api_hostname_and_scheme) +} + +// TODO(bt,2025-04-22): Share API definitions between client and server in common crate. + +#[derive(Deserialize, Debug)] +pub struct UploadImageMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} + +fn validate_args>( + args: &UploadImageFromFileArgs<'_, P>, +) -> Result<(), StorytellerError> { + if args.is_intermediate_system_file && args.maybe_prompt_token.is_some() { + return Err(StorytellerError::Client(ClientError::InvalidPreflightRequest( + "Cannot set `is_intermediate_system_file` to true if `maybe_prompt_token` is provided." + .to_string()))); + } + + Ok(()) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_new_engine_asset_from_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_new_engine_asset_from_file.rs new file mode 100644 index 00000000..4509f1f3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_new_engine_asset_from_file.rs @@ -0,0 +1,85 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use crate::utils::http_get_anonymous::http_get_anonymous; +use core_types::enums::generation_source::GenerationSource; +use chrono::{DateTime, Utc}; +use uuid_utils::uuid::generate_random_uuid; +use log::debug; +use reqwest::multipart::{Form, Part}; +use reqwest::Client; +use serde_derive::{Deserialize, Serialize}; +use std::path::Path; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::model_weights::ModelWeightToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use uuid::uuid; + +// TODO: The naming of these methods is ridiculous. It needs to be cleaned up. + +/// Upload an image media file from a file. +pub async fn upload_new_engine_asset_from_file>( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + path: P, + maybe_generation_provider: Option, +) -> Result { + + let url = get_route(api_host); + + debug!("Requesting {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build()?; + + let file_bytes = std::fs::read(path.as_ref())?; + let file_name = path.as_ref().file_name() + .and_then(|n| n.to_str()).unwrap_or("file").to_string(); + let mut form = Form::new() + .text("uuid_idempotency_token", generate_random_uuid()) + .text("engine_category", "object") // TODO: Which type should we use? + .part("file", Part::bytes(file_bytes).file_name(file_name)); + + if let Some(provider) = &maybe_generation_provider { + form = form.text("maybe_generation_provider", provider.to_str().to_string()); + } + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .multipart(form) + .send() + .await?; + + let response = filter_bad_response(response).await?; + let response_body = &response.text().await?; + + let media_file = serde_json::from_str(&response_body)?; + + Ok(media_file) +} + +fn get_route(api_host: &ApiHost) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + format!("{}/v1/media_files/upload/new_engine_asset", api_hostname_and_scheme) +} + +// TODO(bt,2025-04-22): Share API definitions between client and server in common crate. + +#[derive(Deserialize, Debug)] +pub struct UploadImageMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_video_media_file_from_file.rs b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_video_media_file_from_file.rs new file mode 100644 index 00000000..369de12c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/media_files/upload_video_media_file_from_file.rs @@ -0,0 +1,107 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use crate::utils::http_get_anonymous::http_get_anonymous; +use core_types::enums::generation_source::GenerationSource; +use chrono::{DateTime, Utc}; +use uuid_utils::uuid::generate_random_uuid; +use log::debug; +use reqwest::multipart::{Form, Part}; +use reqwest::Client; +use serde_derive::{Deserialize, Serialize}; +use std::path::Path; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::tokens::model_weights::ModelWeightToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use uuid::uuid; + +pub struct UploadVideoFromFileArgs<'a, P: AsRef> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + + // NB: Path needs to be owned for the request. + pub path: P, + + // /// If true, we should hide the image from the user's gallery. + // pub is_intermediate_system_file: bool, + + /// If provided, this is the prompt that this image is associated with. + /// NOTE: Cannot set `is_intermediate_system_file = true` if this is set. + pub maybe_prompt_token: Option<&'a PromptToken>, + + /// If provided, the third-party provider that generated this file. + pub maybe_generation_provider: Option, + + // /// If provided, this groups the file into a batch + // /// TODO: This shouldn't be set clientside without the backend generating the token + // /// and cryptographically securing it. But we need to go fast here. + // pub maybe_batch_token: Option<&'a BatchGenerationToken>, +} + +// TODO(bt,2025-04-22): Share API definitions between client and server in common crate. + +#[derive(Deserialize, Debug)] +pub struct UploadVideoMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} + +/// Upload a video media file from a file. +pub async fn upload_video_media_file_from_file>( + args: UploadVideoFromFileArgs<'_, P>, +) -> Result { + + let url = get_route(args.api_host); + + debug!("Requesting {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build()?; + + let file_bytes = std::fs::read(args.path.as_ref())?; + let file_name = args.path.as_ref().file_name() + .and_then(|n| n.to_str()).unwrap_or("file").to_string(); + let mut form = Form::new() + .text("uuid_idempotency_token", generate_random_uuid()) + .part("file", Part::bytes(file_bytes).file_name(file_name)); + + if let Some(prompt_token) = &args.maybe_prompt_token { + form = form.text("maybe_prompt_token", prompt_token.to_string()); + } + + if let Some(provider) = &args.maybe_generation_provider { + form = form.text("maybe_generation_provider", provider.to_str().to_string()); + } + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = args.maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .multipart(form) + .send() + .await?; + + let response = filter_bad_response(response).await?; + let response_body = &response.text().await?; + + let media_file = serde_json::from_str(&response_body)?; + + Ok(media_file) +} + +fn get_route(api_host: &ApiHost) -> String { + let api_hostname_and_scheme = api_host.to_api_hostname_and_scheme(); + format!("{}/v1/media_files/upload/new_video", api_hostname_and_scheme) +} + diff --git a/crates/api_clients/artcraft_client/src/endpoints/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/mod.rs new file mode 100644 index 00000000..aae0a14e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/mod.rs @@ -0,0 +1,10 @@ +pub mod analytics; +pub mod credits; +pub mod generate; +pub mod jobs; +pub mod omni_gen; +pub mod media_files; +pub mod prompts; +pub mod stripe_artcraft; +pub mod subscriptions; +pub mod users; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/audio/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/audio/mod.rs new file mode 100644 index 00000000..c414cffb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/audio/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_audio_cost; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/audio/omni_gen_audio_cost.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/audio/omni_gen_audio_cost.rs new file mode 100644 index 00000000..ce7e68dd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/audio/omni_gen_audio_cost.rs @@ -0,0 +1,27 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; +use crate::api_defs::omni_gen::cost_response::omni_gen_audio_cost_response::OmniGenAudioCostResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_AUDIO_COST_PATH: &str = "/v1/omni_gen/cost/audio"; + +pub struct OmniGenAudioCostArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenAudioCostAndGenerateRequest, +} + +/// Estimate the cost of a audio generation. Anonymous calls are allowed; +/// credentials personalize the estimate (free/unlimited plans). +pub async fn omni_gen_audio_cost( + args: OmniGenAudioCostArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_AUDIO_COST_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mesh/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mesh/mod.rs new file mode 100644 index 00000000..0e05afc1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mesh/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_mesh_cost; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mesh/omni_gen_mesh_cost.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mesh/omni_gen_mesh_cost.rs new file mode 100644 index 00000000..597c7977 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mesh/omni_gen_mesh_cost.rs @@ -0,0 +1,27 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; +use crate::api_defs::omni_gen::cost_response::omni_gen_mesh_cost_response::OmniGenMeshCostResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_MESH_COST_PATH: &str = "/v1/omni_gen/cost/mesh"; + +pub struct OmniGenMeshCostArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenMeshCostAndGenerateRequest, +} + +/// Estimate the cost of a mesh generation. Anonymous calls are allowed; +/// credentials personalize the estimate (free/unlimited plans). +pub async fn omni_gen_mesh_cost( + args: OmniGenMeshCostArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_MESH_COST_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mod.rs new file mode 100644 index 00000000..bf18ba44 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/mod.rs @@ -0,0 +1,3 @@ +pub mod audio; +pub mod mesh; +pub mod splat; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/splat/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/splat/mod.rs new file mode 100644 index 00000000..efdbb89e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/splat/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_splat_cost; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/splat/omni_gen_splat_cost.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/splat/omni_gen_splat_cost.rs new file mode 100644 index 00000000..0830137f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/cost/splat/omni_gen_splat_cost.rs @@ -0,0 +1,27 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; +use crate::api_defs::omni_gen::cost_response::omni_gen_splat_cost_response::OmniGenSplatCostResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_SPLAT_COST_PATH: &str = "/v1/omni_gen/cost/splat"; + +pub struct OmniGenSplatCostArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenSplatCostAndGenerateRequest, +} + +/// Estimate the cost of a splat generation. Anonymous calls are allowed; +/// credentials personalize the estimate (free/unlimited plans). +pub async fn omni_gen_splat_cost( + args: OmniGenSplatCostArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_SPLAT_COST_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/audio/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/audio/mod.rs new file mode 100644 index 00000000..a055a243 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/audio/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_audio; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/audio/omni_gen_audio.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/audio/omni_gen_audio.rs new file mode 100644 index 00000000..e0d7ed30 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/audio/omni_gen_audio.rs @@ -0,0 +1,25 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; +use crate::api_defs::omni_gen::generate_response::omni_gen_audio_generate_response::OmniGenAudioGenerateResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_AUDIO_GENERATE_PATH: &str = "/v1/omni_gen/generate/audio"; + +pub struct OmniGenAudioGenerateArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenAudioCostAndGenerateRequest, +} + +pub async fn omni_gen_audio_generate( + args: OmniGenAudioGenerateArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_AUDIO_GENERATE_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/image/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/image/mod.rs new file mode 100644 index 00000000..d36418bc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/image/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_image; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/image/omni_gen_image.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/image/omni_gen_image.rs new file mode 100644 index 00000000..466e0b43 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/image/omni_gen_image.rs @@ -0,0 +1,25 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; +use crate::api_defs::omni_gen::generate_response::omni_gen_image_generate_response::OmniGenImageGenerateResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_IMAGE_GENERATE_PATH: &str = "/v1/omni_gen/generate/image"; + +pub struct OmniGenImageGenerateArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenImageCostAndGenerateRequest, +} + +pub async fn omni_gen_image_generate( + args: OmniGenImageGenerateArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_IMAGE_GENERATE_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mesh/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mesh/mod.rs new file mode 100644 index 00000000..40ebdf21 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mesh/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_mesh; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mesh/omni_gen_mesh.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mesh/omni_gen_mesh.rs new file mode 100644 index 00000000..afc1f6e5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mesh/omni_gen_mesh.rs @@ -0,0 +1,25 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; +use crate::api_defs::omni_gen::generate_response::omni_gen_mesh_generate_response::OmniGenMeshGenerateResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_MESH_GENERATE_PATH: &str = "/v1/omni_gen/generate/mesh"; + +pub struct OmniGenMeshGenerateArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenMeshCostAndGenerateRequest, +} + +pub async fn omni_gen_mesh_generate( + args: OmniGenMeshGenerateArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_MESH_GENERATE_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mod.rs new file mode 100644 index 00000000..cd3fbb9d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/mod.rs @@ -0,0 +1,5 @@ +pub mod audio; +pub mod image; +pub mod mesh; +pub mod splat; +pub mod video; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/splat/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/splat/mod.rs new file mode 100644 index 00000000..014c2d26 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/splat/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_splat; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/splat/omni_gen_splat.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/splat/omni_gen_splat.rs new file mode 100644 index 00000000..8586467d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/splat/omni_gen_splat.rs @@ -0,0 +1,25 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; +use crate::api_defs::omni_gen::generate_response::omni_gen_splat_generate_response::OmniGenSplatGenerateResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_SPLAT_GENERATE_PATH: &str = "/v1/omni_gen/generate/splat"; + +pub struct OmniGenSplatGenerateArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenSplatCostAndGenerateRequest, +} + +pub async fn omni_gen_splat_generate( + args: OmniGenSplatGenerateArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_SPLAT_GENERATE_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/video/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/video/mod.rs new file mode 100644 index 00000000..d4efe9ee --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/video/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_video; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/video/omni_gen_video.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/video/omni_gen_video.rs new file mode 100644 index 00000000..5f8e5081 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/generate/video/omni_gen_video.rs @@ -0,0 +1,25 @@ +use crate::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; +use crate::api_defs::omni_gen::generate_response::omni_gen_video_generate_response::OmniGenVideoGenerateResponse; +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const OMNI_GEN_VIDEO_GENERATE_PATH: &str = "/v1/omni_gen/generate/video"; + +pub struct OmniGenVideoGenerateArgs<'a> { + pub api_host: &'a ApiHost, + pub api_or_web_creds: Option<&'a ApiOrWebCreds>, + pub request: &'a OmniGenVideoCostAndGenerateRequest, +} + +pub async fn omni_gen_video_generate( + args: OmniGenVideoGenerateArgs<'_>, +) -> Result { + Ok(api_or_web_json_post_request( + args.api_host, + OMNI_GEN_VIDEO_GENERATE_PATH, + args.api_or_web_creds, + args.request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/mod.rs new file mode 100644 index 00000000..b86ae0ed --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/mod.rs @@ -0,0 +1,3 @@ +pub mod cost; +pub mod generate; +pub mod models; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/audio/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/audio/mod.rs new file mode 100644 index 00000000..1dd09a14 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/audio/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_list_audio_models; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/audio/omni_gen_list_audio_models.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/audio/omni_gen_list_audio_models.rs new file mode 100644 index 00000000..7fbcc1f4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/audio/omni_gen_list_audio_models.rs @@ -0,0 +1,208 @@ +//! Self-contained, forward-compatible binding for `GET /v1/omni_gen/models/audio`. +//! +//! IMPORTANT: This module deliberately does NOT reuse any types from +//! `api_defs`. Client builds may be deployed in the wild long after the +//! server's models, enums, and response shapes have changed, so every request / +//! response type is copied here and made permissive: +//! - Unknown JSON fields are ignored (serde default behavior). +//! - Missing collection/flag fields default rather than fail (`serde(default)`). +//! - Every string-valued enum has an `Unknown(String)` catch-all so new server +//! variants deserialize instead of erroring. + +use serde_derive::{Deserialize, Serialize}; + +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::datatypes::common_enums::generation::api_client_generation_provider::ApiClientGenerationProvider; +use crate::datatypes::common_enums::generation::api_client_audio_model::ApiClientAudioModel; +use crate::datatypes::common_enums::generation::api_client_model_creator::ApiClientModelCreator; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +pub const OMNI_GEN_AUDIO_MODELS_PATH: &str = "/v1/omni_gen/models/audio"; + +/// Arguments for [`omni_gen_list_audio_models`]. +pub struct OmniGenListAudioModelsArgs<'a> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, +} + +/// List available audio models. +pub async fn omni_gen_list_audio_models( + args: OmniGenListAudioModelsArgs<'_>, +) -> Result { + Ok(basic_json_get_request( + args.api_host, + OMNI_GEN_AUDIO_MODELS_PATH, + args.maybe_creds, + ).await?) +} + +// ============================ Response types ============================ + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenAudioModelsResponse { + #[serde(default)] + pub success: bool, + #[serde(default)] + pub models: Vec, + #[serde(default)] + pub providers: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenAudioModelProviderDetails { + pub provider: ApiClientGenerationProvider, + #[serde(default)] + pub models: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenAudioProviderModelDetails { + pub model: ApiClientAudioModel, + #[serde(default)] + pub overrides: Option, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenAudioModelDetails { + pub model: ApiClientAudioModel, + #[serde(default)] + pub model_creator: Option, + #[serde(default)] + pub full_name: Option, + #[serde(default)] + pub extra_info: Option, + #[serde(default)] + pub extra_info_short: Option, + #[serde(default)] + pub text_prompt_supported: Option, + #[serde(default)] + pub style_prompt_supported: Option, + #[serde(default)] + pub audio_references_supported: Option, + #[serde(default)] + pub audio_references_max: Option, + #[serde(default)] + pub image_references_supported: Option, + #[serde(default)] + pub image_references_max: Option, + #[serde(default)] + pub keep_lyrics_supported: Option, + #[serde(default)] + pub instrumental_toggle_supported: Option, + #[serde(default)] + pub loopable_toggle_supported: Option, + #[serde(default)] + pub bpm_supported: Option, + #[serde(default)] + pub musical_key_supported: Option, + #[serde(default)] + pub sample_rate_hz_options: Option>, + #[serde(default)] + pub sample_rate_hz_default: Option, + #[serde(default)] + pub speed_supported: Option, + #[serde(default)] + pub volume_supported: Option, + #[serde(default)] + pub pitch_supported: Option, + #[serde(default)] + pub is_disabled: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn response_tolerates_unknown_fields_and_variants() { + let json = r#"{ + "success": true, + "models": [ + { + "model": "brand_new_audio_model", + "model_creator": "some_new_studio", + "surprise_new_field": 123 + } + ], + "providers": [ + { "provider": "new_provider", "models": [ { "model": "suno_music" } ] } + ], + "another_unexpected_top_level_field": "ignored" + }"#; + + let resp: OmniGenAudioModelsResponse = serde_json::from_str(json).unwrap(); + assert!(resp.success); + assert_eq!(resp.models.len(), 1); + assert_eq!( + resp.models[0].model, + ApiClientAudioModel::Unknown("brand_new_audio_model".to_string()), + ); + assert_eq!( + resp.models[0].model_creator, + Some(ApiClientModelCreator::Unknown("some_new_studio".to_string())), + ); + assert_eq!(resp.models[0].is_disabled, None); + assert_eq!( + resp.providers[0].provider, + ApiClientGenerationProvider::Unknown("new_provider".to_string()), + ); + } + + #[test] + fn empty_object_uses_defaults() { + let resp: OmniGenAudioModelsResponse = serde_json::from_str("{}").unwrap(); + assert!(!resp.success); + assert!(resp.models.is_empty()); + assert!(resp.providers.is_empty()); + } +} + +/// Live tests that hit real servers. All `#[ignore]` so they never run by default. +/// Run explicitly, e.g.: +/// cargo test -p artcraft_client omni_gen_list_audio_models::live_tests -- --ignored --nocapture +#[cfg(test)] +mod live_tests { + mod localhost { + use super::super::{omni_gen_list_audio_models, OmniGenListAudioModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits http://localhost:12345 + async fn list_audio_models() { + let api_host = ApiHost::Localhost { port: 12345 }; + let response = omni_gen_list_audio_models(OmniGenListAudioModelsArgs { + api_host: &api_host, + maybe_creds: None, + }) + .await + .expect("request should succeed"); + + println!("[localhost] audio models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one audio model"); + } + } + + mod production { + use super::super::{omni_gen_list_audio_models, OmniGenListAudioModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits https://api.storyteller.ai + async fn list_audio_models() { + let api_host = ApiHost::Storyteller; + let response = omni_gen_list_audio_models(OmniGenListAudioModelsArgs { + api_host: &api_host, + maybe_creds: None, + }) + .await + .expect("request should succeed"); + + println!("[production] audio models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one audio model"); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/image/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/image/mod.rs new file mode 100644 index 00000000..c6d40165 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/image/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_list_image_models; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/image/omni_gen_list_image_models.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/image/omni_gen_list_image_models.rs new file mode 100644 index 00000000..68c7996f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/image/omni_gen_list_image_models.rs @@ -0,0 +1,237 @@ +//! Self-contained, forward-compatible binding for `GET /v1/omni_gen/models/image`. +//! +//! IMPORTANT: This module deliberately does NOT reuse any types from +//! `api_defs`. Client builds may be deployed in the wild long after the +//! server's models, enums, and response shapes have changed, so every request / +//! response type is copied here and made permissive: +//! - Unknown JSON fields are ignored (serde default behavior). +//! - Missing collection/flag fields default rather than fail (`serde(default)`). +//! - Every string-valued enum has an `Unknown(String)` catch-all so new server +//! variants deserialize instead of erroring. + +use serde_derive::{Deserialize, Serialize}; + +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::datatypes::common_enums::generation::api_client_aspect_ratio::ApiClientAspectRatio; +use crate::datatypes::common_enums::generation::api_client_generation_provider::ApiClientGenerationProvider; +use crate::datatypes::common_enums::generation::api_client_image_model::ApiClientImageModel; +use crate::datatypes::common_enums::generation::api_client_model_creator::ApiClientModelCreator; +use crate::datatypes::common_enums::generation::api_client_quality::ApiClientQuality; +use crate::datatypes::common_enums::generation::api_client_resolution::ApiClientResolution; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +pub const OMNI_GEN_IMAGE_MODELS_PATH: &str = "/v1/omni_gen/models/image"; + +/// Arguments for [`omni_gen_list_image_models`]. +pub struct OmniGenListImageModelsArgs<'a> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + /// Which provider's models to list. `None` lets the server default (artcraft). + pub provider: Option, +} + +/// List available image models. +pub async fn omni_gen_list_image_models( + args: OmniGenListImageModelsArgs<'_>, +) -> Result { + let path = match args.provider { + Some(provider) => format!("{}?provider={}", OMNI_GEN_IMAGE_MODELS_PATH, provider.as_query_value()), + None => OMNI_GEN_IMAGE_MODELS_PATH.to_string(), + }; + + Ok(basic_json_get_request(args.api_host, &path, args.maybe_creds).await?) +} + +/// The provider filter for the models endpoint (a client-supplied request value). +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum OmniGenImageModelsProvider { + /// Only models available through ArtCraft. + Artcraft, + /// All known models across all providers. + All, +} + +impl OmniGenImageModelsProvider { + pub fn as_query_value(self) -> &'static str { + match self { + Self::Artcraft => "artcraft", + Self::All => "all", + } + } +} + +impl Default for OmniGenImageModelsProvider { + fn default() -> Self { + Self::Artcraft + } +} + +// ============================ Response types ============================ + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenImageModelsResponse { + #[serde(default)] + pub success: bool, + #[serde(default)] + pub models: Vec, + #[serde(default)] + pub providers: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenImageModelProviderDetails { + pub provider: ApiClientGenerationProvider, + #[serde(default)] + pub models: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenImageProviderModelDetails { + pub model: ApiClientImageModel, + #[serde(default)] + pub overrides: Option, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenImageModelDetails { + pub model: ApiClientImageModel, + #[serde(default)] + pub model_creator: Option, + #[serde(default)] + pub full_name: Option, + #[serde(default)] + pub text_prompt_supported: Option, + #[serde(default)] + pub text_prompt_max_length: Option, + #[serde(default)] + pub negative_text_prompt_supported: Option, + #[serde(default)] + pub negative_text_prompt_max_length: Option, + #[serde(default)] + pub image_refs_supported: Option, + #[serde(default)] + pub image_refs_max: Option, + #[serde(default)] + pub has_fixed_editing_aspect_ratio: Option, + #[serde(default)] + pub aspect_ratio_options: Option>, + #[serde(default)] + pub aspect_ratio_default: Option, + #[serde(default)] + pub aspect_ratio_default_when_editing: Option, + #[serde(default)] + pub resolution_options: Option>, + #[serde(default)] + pub resolution_default: Option, + #[serde(default)] + pub quality_options: Option>, + #[serde(default)] + pub default_quality: Option, + #[serde(default)] + pub batch_size_min: Option, + #[serde(default)] + pub batch_size_max: Option, + #[serde(default)] + pub batch_size_options: Option>, + #[serde(default)] + pub batch_size_default: Option, + #[serde(default)] + pub is_disabled: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn response_tolerates_unknown_fields_and_variants() { + let json = r#"{ + "success": true, + "models": [ + { + "model": "brand_new_image_model", + "model_creator": "some_new_studio", + "aspect_ratio_options": ["square", "some_new_ratio"], + "surprise_new_field": 123 + } + ], + "providers": [ + { "provider": "new_provider", "models": [ { "model": "nano_banana_pro" } ] } + ], + "another_unexpected_top_level_field": "ignored" + }"#; + + let resp: OmniGenImageModelsResponse = serde_json::from_str(json).unwrap(); + assert!(resp.success); + assert_eq!(resp.models.len(), 1); + assert_eq!(resp.models[0].model, ApiClientImageModel::Unknown("brand_new_image_model".to_string())); + assert_eq!(resp.models[0].model_creator, Some(ApiClientModelCreator::Unknown("some_new_studio".to_string()))); + let ratios = resp.models[0].aspect_ratio_options.as_ref().unwrap(); + assert_eq!(ratios[0], ApiClientAspectRatio::Square); + assert_eq!(ratios[1], ApiClientAspectRatio::Unknown("some_new_ratio".to_string())); + assert_eq!(resp.models[0].is_disabled, None); + assert_eq!(resp.providers[0].provider, ApiClientGenerationProvider::Unknown("new_provider".to_string())); + assert_eq!(resp.providers[0].models[0].model, ApiClientImageModel::NanoBananaPro); + } + + #[test] + fn empty_object_uses_defaults() { + let resp: OmniGenImageModelsResponse = serde_json::from_str("{}").unwrap(); + assert!(!resp.success); + assert!(resp.models.is_empty()); + assert!(resp.providers.is_empty()); + } +} + +/// Live tests that hit real servers. All `#[ignore]` so they never run by default. +/// Run explicitly, e.g.: +/// cargo test -p artcraft_client omni_gen_list_image_models::live_tests -- --ignored --nocapture +#[cfg(test)] +mod live_tests { + mod localhost { + use super::super::{omni_gen_list_image_models, OmniGenListImageModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits http://localhost:12345 + async fn list_image_models() { + let api_host = ApiHost::Localhost { port: 12345 }; + let response = omni_gen_list_image_models(OmniGenListImageModelsArgs { + api_host: &api_host, + maybe_creds: None, + provider: None, + }) + .await + .expect("request should succeed"); + + println!("[localhost] image models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one image model"); + } + } + + mod production { + use super::super::{omni_gen_list_image_models, OmniGenListImageModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits https://api.storyteller.ai + async fn list_image_models() { + let api_host = ApiHost::Storyteller; + let response = omni_gen_list_image_models(OmniGenListImageModelsArgs { + api_host: &api_host, + maybe_creds: None, + provider: None, + }) + .await + .expect("request should succeed"); + + println!("[production] image models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one image model"); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mesh/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mesh/mod.rs new file mode 100644 index 00000000..f348d924 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mesh/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_list_mesh_models; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mesh/omni_gen_list_mesh_models.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mesh/omni_gen_list_mesh_models.rs new file mode 100644 index 00000000..237a9c9b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mesh/omni_gen_list_mesh_models.rs @@ -0,0 +1,202 @@ +//! Self-contained, forward-compatible binding for `GET /v1/omni_gen/models/mesh`. +//! +//! IMPORTANT: This module deliberately does NOT reuse any types from +//! `api_defs`. Client builds may be deployed in the wild long after the +//! server's models, enums, and response shapes have changed, so every request / +//! response type is copied here and made permissive: +//! - Unknown JSON fields are ignored (serde default behavior). +//! - Missing collection/flag fields default rather than fail (`serde(default)`). +//! - Every string-valued enum has an `Unknown(String)` catch-all so new server +//! variants deserialize instead of erroring. + +use serde_derive::{Deserialize, Serialize}; + +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::datatypes::common_enums::generation::api_client_generation_provider::ApiClientGenerationProvider; +use crate::datatypes::common_enums::generation::api_client_mesh_model::ApiClientMeshModel; +use crate::datatypes::common_enums::generation::api_client_mesh_output_type::ApiClientMeshOutputType; +use crate::datatypes::common_enums::generation::api_client_polygon_type::ApiClientPolygonType; +use crate::datatypes::common_enums::generation::api_client_model_creator::ApiClientModelCreator; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +pub const OMNI_GEN_MESH_MODELS_PATH: &str = "/v1/omni_gen/models/mesh"; + +/// Arguments for [`omni_gen_list_mesh_models`]. +pub struct OmniGenListMeshModelsArgs<'a> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, +} + +/// List available mesh models. +pub async fn omni_gen_list_mesh_models( + args: OmniGenListMeshModelsArgs<'_>, +) -> Result { + Ok(basic_json_get_request( + args.api_host, + OMNI_GEN_MESH_MODELS_PATH, + args.maybe_creds, + ).await?) +} + +// ============================ Response types ============================ + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenMeshModelsResponse { + #[serde(default)] + pub success: bool, + #[serde(default)] + pub models: Vec, + #[serde(default)] + pub providers: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenMeshModelProviderDetails { + pub provider: ApiClientGenerationProvider, + #[serde(default)] + pub models: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenMeshProviderModelDetails { + pub model: ApiClientMeshModel, + #[serde(default)] + pub overrides: Option, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenMeshModelDetails { + pub model: ApiClientMeshModel, + #[serde(default)] + pub model_creator: Option, + #[serde(default)] + pub full_name: Option, + #[serde(default)] + pub extra_info: Option, + #[serde(default)] + pub extra_info_short: Option, + #[serde(default)] + pub text_prompt_supported: Option, + #[serde(default)] + pub image_input_supported: Option, + #[serde(default)] + pub sketch_input_supported: Option, + #[serde(default)] + pub multi_view_supported: Option, + #[serde(default)] + pub mesh_input_supported: Option, + #[serde(default)] + pub mesh_output_types: Option>, + #[serde(default)] + pub polygon_types: Option>, + #[serde(default)] + pub face_count_supported: Option, + #[serde(default)] + pub pbr_supported: Option, + #[serde(default)] + pub texture_toggle_supported: Option, + #[serde(default)] + pub texture_quality_supported: Option, + #[serde(default)] + pub geometry_quality_supported: Option, + #[serde(default)] + pub is_disabled: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn response_tolerates_unknown_fields_and_variants() { + let json = r#"{ + "success": true, + "models": [ + { + "model": "brand_new_mesh_model", + "model_creator": "some_new_studio", + "surprise_new_field": 123 + } + ], + "providers": [ + { "provider": "new_provider", "models": [ { "model": "hunyuan_3d_3" } ] } + ], + "another_unexpected_top_level_field": "ignored" + }"#; + + let resp: OmniGenMeshModelsResponse = serde_json::from_str(json).unwrap(); + assert!(resp.success); + assert_eq!(resp.models.len(), 1); + assert_eq!( + resp.models[0].model, + ApiClientMeshModel::Unknown("brand_new_mesh_model".to_string()), + ); + assert_eq!( + resp.models[0].model_creator, + Some(ApiClientModelCreator::Unknown("some_new_studio".to_string())), + ); + assert_eq!(resp.models[0].is_disabled, None); + assert_eq!( + resp.providers[0].provider, + ApiClientGenerationProvider::Unknown("new_provider".to_string()), + ); + } + + #[test] + fn empty_object_uses_defaults() { + let resp: OmniGenMeshModelsResponse = serde_json::from_str("{}").unwrap(); + assert!(!resp.success); + assert!(resp.models.is_empty()); + assert!(resp.providers.is_empty()); + } +} + +/// Live tests that hit real servers. All `#[ignore]` so they never run by default. +/// Run explicitly, e.g.: +/// cargo test -p artcraft_client omni_gen_list_mesh_models::live_tests -- --ignored --nocapture +#[cfg(test)] +mod live_tests { + mod localhost { + use super::super::{omni_gen_list_mesh_models, OmniGenListMeshModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits http://localhost:12345 + async fn list_mesh_models() { + let api_host = ApiHost::Localhost { port: 12345 }; + let response = omni_gen_list_mesh_models(OmniGenListMeshModelsArgs { + api_host: &api_host, + maybe_creds: None, + }) + .await + .expect("request should succeed"); + + println!("[localhost] mesh models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one mesh model"); + } + } + + mod production { + use super::super::{omni_gen_list_mesh_models, OmniGenListMeshModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits https://api.storyteller.ai + async fn list_mesh_models() { + let api_host = ApiHost::Storyteller; + let response = omni_gen_list_mesh_models(OmniGenListMeshModelsArgs { + api_host: &api_host, + maybe_creds: None, + }) + .await + .expect("request should succeed"); + + println!("[production] mesh models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one mesh model"); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mod.rs new file mode 100644 index 00000000..cd3fbb9d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/mod.rs @@ -0,0 +1,5 @@ +pub mod audio; +pub mod image; +pub mod mesh; +pub mod splat; +pub mod video; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/splat/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/splat/mod.rs new file mode 100644 index 00000000..ac0bb5ec --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/splat/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_list_splat_models; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/splat/omni_gen_list_splat_models.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/splat/omni_gen_list_splat_models.rs new file mode 100644 index 00000000..1526f4c4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/splat/omni_gen_list_splat_models.rs @@ -0,0 +1,188 @@ +//! Self-contained, forward-compatible binding for `GET /v1/omni_gen/models/splat`. +//! +//! IMPORTANT: This module deliberately does NOT reuse any types from +//! `api_defs`. Client builds may be deployed in the wild long after the +//! server's models, enums, and response shapes have changed, so every request / +//! response type is copied here and made permissive: +//! - Unknown JSON fields are ignored (serde default behavior). +//! - Missing collection/flag fields default rather than fail (`serde(default)`). +//! - Every string-valued enum has an `Unknown(String)` catch-all so new server +//! variants deserialize instead of erroring. + +use serde_derive::{Deserialize, Serialize}; + +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::datatypes::common_enums::generation::api_client_generation_provider::ApiClientGenerationProvider; +use crate::datatypes::common_enums::generation::api_client_splat_model::ApiClientSplatModel; +use crate::datatypes::common_enums::generation::api_client_model_creator::ApiClientModelCreator; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; + +pub const OMNI_GEN_SPLAT_MODELS_PATH: &str = "/v1/omni_gen/models/splat"; + +/// Arguments for [`omni_gen_list_splat_models`]. +pub struct OmniGenListSplatModelsArgs<'a> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, +} + +/// List available splat models. +pub async fn omni_gen_list_splat_models( + args: OmniGenListSplatModelsArgs<'_>, +) -> Result { + Ok(basic_json_get_request( + args.api_host, + OMNI_GEN_SPLAT_MODELS_PATH, + args.maybe_creds, + ).await?) +} + +// ============================ Response types ============================ + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenSplatModelsResponse { + #[serde(default)] + pub success: bool, + #[serde(default)] + pub models: Vec, + #[serde(default)] + pub providers: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenSplatModelProviderDetails { + pub provider: ApiClientGenerationProvider, + #[serde(default)] + pub models: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenSplatProviderModelDetails { + pub model: ApiClientSplatModel, + #[serde(default)] + pub overrides: Option, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenSplatModelDetails { + pub model: ApiClientSplatModel, + #[serde(default)] + pub model_creator: Option, + #[serde(default)] + pub full_name: Option, + #[serde(default)] + pub extra_info: Option, + #[serde(default)] + pub extra_info_short: Option, + #[serde(default)] + pub text_prompt_supported: Option, + #[serde(default)] + pub image_references_supported: Option, + #[serde(default)] + pub image_references_max: Option, + #[serde(default)] + pub video_reference_supported: Option, + #[serde(default)] + pub panorama_supported: Option, + #[serde(default)] + pub disable_recaption_supported: Option, + #[serde(default)] + pub is_disabled: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn response_tolerates_unknown_fields_and_variants() { + let json = r#"{ + "success": true, + "models": [ + { + "model": "brand_new_splat_model", + "model_creator": "some_new_studio", + "surprise_new_field": 123 + } + ], + "providers": [ + { "provider": "new_provider", "models": [ { "model": "marble_1p1" } ] } + ], + "another_unexpected_top_level_field": "ignored" + }"#; + + let resp: OmniGenSplatModelsResponse = serde_json::from_str(json).unwrap(); + assert!(resp.success); + assert_eq!(resp.models.len(), 1); + assert_eq!( + resp.models[0].model, + ApiClientSplatModel::Unknown("brand_new_splat_model".to_string()), + ); + assert_eq!( + resp.models[0].model_creator, + Some(ApiClientModelCreator::Unknown("some_new_studio".to_string())), + ); + assert_eq!(resp.models[0].is_disabled, None); + assert_eq!( + resp.providers[0].provider, + ApiClientGenerationProvider::Unknown("new_provider".to_string()), + ); + } + + #[test] + fn empty_object_uses_defaults() { + let resp: OmniGenSplatModelsResponse = serde_json::from_str("{}").unwrap(); + assert!(!resp.success); + assert!(resp.models.is_empty()); + assert!(resp.providers.is_empty()); + } +} + +/// Live tests that hit real servers. All `#[ignore]` so they never run by default. +/// Run explicitly, e.g.: +/// cargo test -p artcraft_client omni_gen_list_splat_models::live_tests -- --ignored --nocapture +#[cfg(test)] +mod live_tests { + mod localhost { + use super::super::{omni_gen_list_splat_models, OmniGenListSplatModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits http://localhost:12345 + async fn list_splat_models() { + let api_host = ApiHost::Localhost { port: 12345 }; + let response = omni_gen_list_splat_models(OmniGenListSplatModelsArgs { + api_host: &api_host, + maybe_creds: None, + }) + .await + .expect("request should succeed"); + + println!("[localhost] splat models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one splat model"); + } + } + + mod production { + use super::super::{omni_gen_list_splat_models, OmniGenListSplatModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits https://api.storyteller.ai + async fn list_splat_models() { + let api_host = ApiHost::Storyteller; + let response = omni_gen_list_splat_models(OmniGenListSplatModelsArgs { + api_host: &api_host, + maybe_creds: None, + }) + .await + .expect("request should succeed"); + + println!("[production] splat models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one splat model"); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/video/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/video/mod.rs new file mode 100644 index 00000000..7a4a26b3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/video/mod.rs @@ -0,0 +1 @@ +pub mod omni_gen_list_video_models; diff --git a/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/video/omni_gen_list_video_models.rs b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/video/omni_gen_list_video_models.rs new file mode 100644 index 00000000..6636c53b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/omni_gen/models/video/omni_gen_list_video_models.rs @@ -0,0 +1,291 @@ +//! Self-contained, forward-compatible binding for `GET /v1/omni_gen/models/video`. +//! +//! IMPORTANT: This module deliberately does NOT reuse any types from +//! `api_defs`. Client builds may be deployed in the wild long after the +//! server's models, enums, and response shapes have changed, so every request / +//! response type is copied here and made permissive: +//! - Unknown JSON fields are ignored (serde default behavior). +//! - Missing collection/flag fields default rather than fail (`serde(default)`). +//! - Every string-valued enum has an `Unknown(String)` catch-all so new server +//! variants deserialize instead of erroring. + +use serde_derive::{Deserialize, Serialize}; + +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; +use crate::datatypes::common_enums::generation::api_client_aspect_ratio::ApiClientAspectRatio; +use crate::datatypes::common_enums::generation::api_client_bitrate::ApiClientBitrate; +use crate::datatypes::common_enums::generation::api_client_generation_provider::ApiClientGenerationProvider; +use crate::datatypes::common_enums::generation::api_client_model_creator::ApiClientModelCreator; +use crate::datatypes::common_enums::generation::api_client_quality::ApiClientQuality; +use crate::datatypes::common_enums::generation::api_client_resolution::ApiClientResolution; +use crate::datatypes::common_enums::generation::api_client_video_model::ApiClientVideoModel; + +pub const OMNI_GEN_VIDEO_MODELS_PATH: &str = "/v1/omni_gen/models/video"; + +/// Arguments for [`omni_gen_list_video_models`]. +pub struct OmniGenListVideoModelsArgs<'a> { + pub api_host: &'a ApiHost, + pub maybe_creds: Option<&'a StorytellerCredentialSet>, + /// Which provider's models to list. `None` lets the server default (artcraft). + pub provider: Option, +} + +/// List available video models. +pub async fn omni_gen_list_video_models( + args: OmniGenListVideoModelsArgs<'_>, +) -> Result { + let path = match args.provider { + Some(provider) => format!("{}?provider={}", OMNI_GEN_VIDEO_MODELS_PATH, provider.as_query_value()), + None => OMNI_GEN_VIDEO_MODELS_PATH.to_string(), + }; + + Ok(basic_json_get_request(args.api_host, &path, args.maybe_creds).await?) +} + +/// The provider filter for the models endpoint (a client-supplied request value). +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum OmniGenVideoModelsProvider { + /// Only models available through ArtCraft. + Artcraft, + /// All known models across all providers. + All, +} + +impl OmniGenVideoModelsProvider { + pub fn as_query_value(self) -> &'static str { + match self { + Self::Artcraft => "artcraft", + Self::All => "all", + } + } +} + +impl Default for OmniGenVideoModelsProvider { + fn default() -> Self { + Self::Artcraft + } +} + +// ============================ Response types ============================ + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenVideoModelsResponse { + #[serde(default)] + pub success: bool, + #[serde(default)] + pub models: Vec, + #[serde(default)] + pub providers: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenVideoModelProviderDetails { + pub provider: ApiClientGenerationProvider, + #[serde(default)] + pub models: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenVideoProviderModelDetails { + pub model: ApiClientVideoModel, + #[serde(default)] + pub overrides: Option, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct OmniGenVideoModelDetails { + pub model: ApiClientVideoModel, + #[serde(default)] + pub model_creator: Option, + #[serde(default)] + pub full_name: Option, + #[serde(default)] + pub extra_info: Option, + #[serde(default)] + pub extra_info_short: Option, + #[serde(default)] + pub text_to_video_supported: Option, + #[serde(default)] + pub text_prompt_supported: Option, + #[serde(default)] + pub text_prompt_max_length: Option, + #[serde(default)] + pub negative_text_prompt_supported: Option, + #[serde(default)] + pub negative_text_prompt_max_length: Option, + #[serde(default)] + pub starting_keyframe_supported: Option, + #[serde(default)] + pub starting_keyframe_required: Option, + #[serde(default)] + pub ending_keyframe_supported: Option, + #[serde(default)] + pub image_references_supported: Option, + #[serde(default)] + pub image_references_max: Option, + #[serde(default)] + pub video_references_supported: Option, + #[serde(default)] + pub video_references_max: Option, + #[serde(default)] + pub video_references_max_total_duration_seconds: Option, + #[serde(default)] + pub audio_references_supported: Option, + #[serde(default)] + pub audio_references_max: Option, + #[serde(default)] + pub audio_references_max_total_duration_seconds: Option, + #[serde(default)] + pub character_references_supported: Option, + #[serde(default)] + pub character_references_max: Option, + #[serde(default)] + pub show_generate_with_sound_toggle: Option, + #[serde(default)] + pub aspect_ratio_options: Option>, + #[serde(default)] + pub aspect_ratio_default: Option, + #[serde(default)] + pub resolution_options: Option>, + #[serde(default)] + pub resolution_default: Option, + #[serde(default)] + pub bitrate_options: Option>, + #[serde(default)] + pub bitrate_default: Option, + #[serde(default)] + pub quality_options: Option>, + #[serde(default)] + pub default_quality: Option, + #[serde(default)] + pub duration_seconds_min: Option, + #[serde(default)] + pub duration_seconds_max: Option, + #[serde(default)] + pub duration_seconds_max_with_image_references: Option, + #[serde(default)] + pub duration_seconds_options: Option>, + #[serde(default)] + pub duration_seconds_default: Option, + #[serde(default)] + pub batch_size_min: Option, + #[serde(default)] + pub batch_size_max: Option, + #[serde(default)] + pub batch_size_options: Option>, + #[serde(default)] + pub batch_size_default: Option, + #[serde(default)] + pub is_disabled: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn unknown_enum_value_is_preserved_and_round_trips() { + let known: ApiClientVideoModel = serde_json::from_str("\"seedance_2p0\"").unwrap(); + assert_eq!(known, ApiClientVideoModel::Seedance2p0); + assert_eq!(serde_json::to_string(&known).unwrap(), "\"seedance_2p0\""); + + // A value this build has never heard of does NOT fail — it is captured verbatim. + let unknown: ApiClientVideoModel = serde_json::from_str("\"future_model_9000\"").unwrap(); + assert_eq!(unknown, ApiClientVideoModel::Unknown("future_model_9000".to_string())); + // ...and serializes back to exactly what came in. + assert_eq!(serde_json::to_string(&unknown).unwrap(), "\"future_model_9000\""); + } + + #[test] + fn response_tolerates_unknown_fields_and_variants() { + let json = r#"{ + "success": true, + "models": [ + { + "model": "brand_new_model", + "model_creator": "some_new_studio", + "aspect_ratio_options": ["wide_sixteen_by_nine", "some_new_ratio"], + "surprise_new_field": 123 + } + ], + "providers": [ + { "provider": "new_provider", "models": [ { "model": "seedance_2p0" } ] } + ], + "another_unexpected_top_level_field": "ignored" + }"#; + + let resp: OmniGenVideoModelsResponse = serde_json::from_str(json).unwrap(); + assert!(resp.success); + assert_eq!(resp.models.len(), 1); + assert_eq!(resp.models[0].model, ApiClientVideoModel::Unknown("brand_new_model".to_string())); + assert_eq!(resp.models[0].model_creator, Some(ApiClientModelCreator::Unknown("some_new_studio".to_string()))); + let ratios = resp.models[0].aspect_ratio_options.as_ref().unwrap(); + assert_eq!(ratios[0], ApiClientAspectRatio::WideSixteenByNine); + assert_eq!(ratios[1], ApiClientAspectRatio::Unknown("some_new_ratio".to_string())); + assert_eq!(resp.models[0].is_disabled, None); // missing optional -> None + assert_eq!(resp.providers[0].provider, ApiClientGenerationProvider::Unknown("new_provider".to_string())); + assert_eq!(resp.providers[0].models[0].model, ApiClientVideoModel::Seedance2p0); + } + + #[test] + fn empty_object_uses_defaults() { + let resp: OmniGenVideoModelsResponse = serde_json::from_str("{}").unwrap(); + assert!(!resp.success); + assert!(resp.models.is_empty()); + assert!(resp.providers.is_empty()); + } +} + +/// Live tests that hit real servers. All `#[ignore]` so they never run by default. +/// Run explicitly, e.g.: +/// cargo test -p artcraft_client omni_gen_list_video_models::live_tests -- --ignored --nocapture +#[cfg(test)] +mod live_tests { + mod localhost { + use super::super::{omni_gen_list_video_models, OmniGenListVideoModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits http://localhost:12345 + async fn list_video_models() { + let api_host = ApiHost::Localhost { port: 12345 }; + let response = omni_gen_list_video_models(OmniGenListVideoModelsArgs { + api_host: &api_host, + maybe_creds: None, + provider: None, + }) + .await + .expect("request should succeed"); + + println!("[localhost] video models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one video model"); + } + } + + mod production { + use super::super::{omni_gen_list_video_models, OmniGenListVideoModelsArgs}; + use crate::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // live: hits https://api.storyteller.ai + async fn list_video_models() { + let api_host = ApiHost::Storyteller; + let response = omni_gen_list_video_models(OmniGenListVideoModelsArgs { + api_host: &api_host, + maybe_creds: None, + provider: None, + }) + .await + .expect("request should succeed"); + + println!("[production] video models response: {:#?}", response); + assert!(response.success); + assert!(!response.models.is_empty(), "expected at least one video model"); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/prompts/create_prompt.rs b/crates/api_clients/artcraft_client/src/endpoints/prompts/create_prompt.rs new file mode 100644 index 00000000..8ac276e2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/prompts/create_prompt.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::prompts::create_prompt::{CreatePromptRequest, CreatePromptResponse, CREATE_PROMPT_PATH}; + +pub async fn create_prompt( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: CreatePromptRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CREATE_PROMPT_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/prompts/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/prompts/mod.rs new file mode 100644 index 00000000..11da7a9f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/prompts/mod.rs @@ -0,0 +1 @@ +pub mod create_prompt; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/create_credits_pack_checkout.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/create_credits_pack_checkout.rs new file mode 100644 index 00000000..68ee2e5a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/create_credits_pack_checkout.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::stripe_artcraft::create_credits_pack_checkout::{StripeArtcraftCreateCreditsPackCheckoutRequest, StripeArtcraftCreateCreditsPackCheckoutResponse, CREATE_CREDITS_PACK_CHECKOUT_URL_PATH}; + +pub async fn create_credits_pack_checkout( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: StripeArtcraftCreateCreditsPackCheckoutRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CREATE_CREDITS_PACK_CHECKOUT_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/create_subscription_checkout.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/create_subscription_checkout.rs new file mode 100644 index 00000000..82e1888e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/create_subscription_checkout.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::stripe_artcraft::create_subscription_checkout::{StripeArtcraftCreateSubscriptionCheckoutRequest, StripeArtcraftCreateSubscriptionCheckoutResponse, CREATE_SUBSCRIPTION_CHECKOUT_URL_PATH}; + +pub async fn create_subscription_checkout( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: StripeArtcraftCreateSubscriptionCheckoutRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CREATE_SUBSCRIPTION_CHECKOUT_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_cancel_plan.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_cancel_plan.rs new file mode 100644 index 00000000..da898043 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_cancel_plan.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::stripe_artcraft::customer_portal_cancel_plan::{StripeArtcraftCustomerPortalCancelPlanRequest, StripeArtcraftCustomerPortalCancelPlanResponse, CUSTOMER_PORTAL_CANCEL_PLAN_URL_PATH}; + +pub async fn customer_portal_cancel_plan( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: StripeArtcraftCustomerPortalCancelPlanRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CUSTOMER_PORTAL_CANCEL_PLAN_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_manage_plan.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_manage_plan.rs new file mode 100644 index 00000000..0f4d3024 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_manage_plan.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::stripe_artcraft::customer_portal_manage_plan::{StripeArtcraftCustomerPortalManagePlanRequest, StripeArtcraftCustomerPortalManagePlanResponse, CUSTOMER_PORTAL_MANAGE_PLAN_URL_PATH}; + +pub async fn customer_portal_manage_plan( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: StripeArtcraftCustomerPortalManagePlanRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CUSTOMER_PORTAL_MANAGE_PLAN_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_switch_plan.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_switch_plan.rs new file mode 100644 index 00000000..aa4d3ed2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_switch_plan.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::stripe_artcraft::customer_portal_switch_plan::{StripeArtcraftCustomerPortalSwitchPlanRequest, StripeArtcraftCustomerPortalSwitchPlanResponse, CUSTOMER_PORTAL_SWITCH_PLAN_URL_PATH}; + +pub async fn customer_portal_switch_plan( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: StripeArtcraftCustomerPortalSwitchPlanRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CUSTOMER_PORTAL_SWITCH_PLAN_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_update_payment_method.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_update_payment_method.rs new file mode 100644 index 00000000..45ba158a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/customer_portal_update_payment_method.rs @@ -0,0 +1,18 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_post_request::basic_json_post_request; +use crate::api_defs::stripe_artcraft::customer_portal_update_payment_method::{StripeArtcraftCustomerPortalUpdatePaymentMethodRequest, StripeArtcraftCustomerPortalUpdatePaymentMethodResponse, CUSTOMER_PORTAL_UPDATE_PAYMENT_METHOD_URL_PATH}; + +pub async fn customer_portal_update_payment_method( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + request: StripeArtcraftCustomerPortalUpdatePaymentMethodRequest, +) -> Result { + Ok(basic_json_post_request( + api_host, + CUSTOMER_PORTAL_UPDATE_PAYMENT_METHOD_URL_PATH, + maybe_creds, + request, + ).await?) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/mod.rs new file mode 100644 index 00000000..538dc98f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/stripe_artcraft/mod.rs @@ -0,0 +1,6 @@ +pub mod create_credits_pack_checkout; +pub mod create_subscription_checkout; +pub mod customer_portal_cancel_plan; +pub mod customer_portal_manage_plan; +pub mod customer_portal_switch_plan; +pub mod customer_portal_update_payment_method; diff --git a/crates/api_clients/artcraft_client/src/endpoints/subscriptions/get_session_subscription.rs b/crates/api_clients/artcraft_client/src/endpoints/subscriptions/get_session_subscription.rs new file mode 100644 index 00000000..e7600447 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/subscriptions/get_session_subscription.rs @@ -0,0 +1,28 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::basic_json_get_request::basic_json_get_request; +use crate::api_defs::subscriptions::get_session_subscription::GetSessionSubscriptionResponse; +use crate::enums::common::payments_namespace::PaymentsNamespace; +use log::debug; + +pub async fn get_session_subscription( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + payments_namespace: PaymentsNamespace +) -> Result { + let url_path = get_url_path(payments_namespace); + + debug!("Requesting {:?}", &url_path); + + Ok(basic_json_get_request( + api_host, + &url_path, + maybe_creds, + ).await?) +} + +fn get_url_path(payments_namespace: PaymentsNamespace) -> String { + let payments_namespace = payments_namespace.to_str(); + format!("/v1/subscriptions/namespace/{}", payments_namespace) +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/subscriptions/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/subscriptions/mod.rs new file mode 100644 index 00000000..1cc61e22 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/subscriptions/mod.rs @@ -0,0 +1 @@ +pub mod get_session_subscription; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/endpoints/users/login.rs b/crates/api_clients/artcraft_client/src/endpoints/users/login.rs new file mode 100644 index 00000000..b3260054 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/users/login.rs @@ -0,0 +1,122 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +use crate::api_defs::users::login::{LoginErrorResponse, LoginRequest, LoginSuccessResponse}; +use crate::error::api_error::ApiError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; + +pub const LOGIN_PATH: &str = "/v1/login"; + +pub struct LoginArgs<'a> { + pub api_host: &'a ApiHost, + pub request: &'a LoginRequest, +} + +/// Failure modes of the login endpoint. +#[derive(Debug)] +pub enum LoginError { + /// The API rejected the login with a structured error (invalid + /// credentials, account needs a password, server error). + Login(LoginErrorResponse), + /// Transport, client, or unexpected server failure. + Storyteller(StorytellerError), +} + +/// Log in with a username (or email) and password. On success the returned +/// `signed_session` can be sent back as a `session=` cookie. +pub async fn login( + args: LoginArgs<'_>, +) -> Result { + api_or_web_json_post_request( + args.api_host, + LOGIN_PATH, + None, + args.request, + ).await.map_err(classify_error) +} + +/// The login endpoint returns its structured error body on 401/500; surface +/// it as a typed [`LoginErrorResponse`] when it parses, and fall back to the +/// raw transport error otherwise. +fn classify_error(error: StorytellerError) -> LoginError { + let maybe_body = match &error { + StorytellerError::Api(ApiError::Unauthorized(body)) => Some(body), + StorytellerError::Api(ApiError::InternalServerError { body, .. }) => Some(body), + _ => None, + }; + + let maybe_response = maybe_body + .and_then(|body| serde_json::from_str::(body).ok()); + + match maybe_response { + Some(response) => LoginError::Login(response), + None => LoginError::Storyteller(error), + } +} + +impl Error for LoginError {} + +impl Display for LoginError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + LoginError::Login(response) => { + write!(f, "Login error ({:?}): {}", response.error_type, response.error_message) + } + LoginError::Storyteller(error) => write!(f, "{}", error), + } + } +} + +#[cfg(test)] +mod tests { + use crate::api_defs::users::login::LoginErrorType; + use crate::error::api_error::ApiError; + use crate::error::storyteller_error::StorytellerError; + use super::*; + + mod classify_error_tests { + use super::*; + + #[test] + fn unauthorized_with_login_body_is_typed() { + let body = r#"{"success":false,"error_type":"InvalidCredentials","error_message":"invalid credentials"}"#; + let error = StorytellerError::Api(ApiError::Unauthorized(body.to_string())); + + match classify_error(error) { + LoginError::Login(response) => { + assert_eq!(response.error_type, LoginErrorType::InvalidCredentials); + assert_eq!(response.error_message, "invalid credentials"); + } + other => panic!("expected typed login error, got {:?}", other), + } + } + + #[test] + fn server_error_with_login_body_is_typed() { + let body = r#"{"success":false,"error_type":"ServerError","error_message":"server error"}"#; + let error = StorytellerError::Api(ApiError::InternalServerError { + body: body.to_string(), + backend_hostname: None, + }); + + match classify_error(error) { + LoginError::Login(response) => { + assert_eq!(response.error_type, LoginErrorType::ServerError); + } + other => panic!("expected typed login error, got {:?}", other), + } + } + + #[test] + fn unparsable_body_falls_back_to_transport_error() { + let error = StorytellerError::Api(ApiError::Unauthorized("gateway".to_string())); + + match classify_error(error) { + LoginError::Storyteller(_) => {} + other => panic!("expected transport error, got {:?}", other), + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/endpoints/users/mod.rs b/crates/api_clients/artcraft_client/src/endpoints/users/mod.rs new file mode 100644 index 00000000..320cbbbc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/endpoints/users/mod.rs @@ -0,0 +1 @@ +pub mod login; diff --git a/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/frontend_failure_category_for_api_clients.rs b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/frontend_failure_category_for_api_clients.rs new file mode 100644 index 00000000..837ca283 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/frontend_failure_category_for_api_clients.rs @@ -0,0 +1,136 @@ +use crate::enums::by_table::generic_inference_jobs::frontend_failure_category::FrontendFailureCategory; + +/// A forward-compatible version of `FrontendFailureCategory` for API clients. +/// +/// Contains all known variants plus an `Unknown(String)` catch-all so that +/// newer server-side values never cause deserialization failures on the client. +#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum FrontendFailureCategoryForApiClients { + FaceNotDetected, + NoForegroundSubjectDetected, + FormatNotSupported, + KeepAliveElapsed, + NotYetImplemented, + RetryableWorkerError, + ModelRulesViolation, + RuleBansUserImage, + RuleBansUserImageWithFaces, + RuleBansUserTextPrompt, + RuleBansUserContent, + RuleBansGeneratedVideo, + RuleBansGeneratedAudio, + RuleBansGeneratedContent, + FilesizeTooLarge, + ImageDimensionsTooSmall, + ImageDimensionsTooLarge, + GenerationFailed, + + /// Catch-all for values the client doesn't yet know about. + /// The contained string is the raw serialized value from the server. + #[serde(untagged)] + Unknown(String), +} + +impl FrontendFailureCategoryForApiClients { + pub fn from_db_enum(value: FrontendFailureCategory) -> Self { + match value { + FrontendFailureCategory::FaceNotDetected => Self::FaceNotDetected, + FrontendFailureCategory::NoForegroundSubjectDetected => Self::NoForegroundSubjectDetected, + FrontendFailureCategory::FormatNotSupported => Self::FormatNotSupported, + FrontendFailureCategory::KeepAliveElapsed => Self::KeepAliveElapsed, + FrontendFailureCategory::NotYetImplemented => Self::NotYetImplemented, + FrontendFailureCategory::RetryableWorkerError => Self::RetryableWorkerError, + FrontendFailureCategory::ModelRulesViolation => Self::ModelRulesViolation, + FrontendFailureCategory::RuleBansUserImage => Self::RuleBansUserImage, + FrontendFailureCategory::RuleBansUserImageWithFaces => Self::RuleBansUserImageWithFaces, + FrontendFailureCategory::RuleBansUserTextPrompt => Self::RuleBansUserTextPrompt, + FrontendFailureCategory::RuleBansUserContent => Self::RuleBansUserContent, + FrontendFailureCategory::RuleBansGeneratedVideo => Self::RuleBansGeneratedVideo, + FrontendFailureCategory::RuleBansGeneratedAudio => Self::RuleBansGeneratedAudio, + FrontendFailureCategory::RuleBansGeneratedContent => Self::RuleBansGeneratedContent, + FrontendFailureCategory::FilesizeTooLarge => Self::FilesizeTooLarge, + FrontendFailureCategory::ImageDimensionsTooSmall => Self::ImageDimensionsTooSmall, + FrontendFailureCategory::ImageDimensionsTooLarge => Self::ImageDimensionsTooLarge, + FrontendFailureCategory::GenerationFailed => Self::GenerationFailed, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_deserialize_known_variants() { + let cases = vec![ + ("\"face_not_detected\"", FrontendFailureCategoryForApiClients::FaceNotDetected), + ("\"no_foreground_subject_detected\"", FrontendFailureCategoryForApiClients::NoForegroundSubjectDetected), + ("\"format_not_supported\"", FrontendFailureCategoryForApiClients::FormatNotSupported), + ("\"keep_alive_elapsed\"", FrontendFailureCategoryForApiClients::KeepAliveElapsed), + ("\"not_yet_implemented\"", FrontendFailureCategoryForApiClients::NotYetImplemented), + ("\"retryable_worker_error\"", FrontendFailureCategoryForApiClients::RetryableWorkerError), + ("\"model_rules_violation\"", FrontendFailureCategoryForApiClients::ModelRulesViolation), + ("\"rule_bans_user_image\"", FrontendFailureCategoryForApiClients::RuleBansUserImage), + ("\"rule_bans_user_image_with_faces\"", FrontendFailureCategoryForApiClients::RuleBansUserImageWithFaces), + ("\"rule_bans_user_text_prompt\"", FrontendFailureCategoryForApiClients::RuleBansUserTextPrompt), + ("\"rule_bans_user_content\"", FrontendFailureCategoryForApiClients::RuleBansUserContent), + ("\"rule_bans_generated_video\"", FrontendFailureCategoryForApiClients::RuleBansGeneratedVideo), + ("\"rule_bans_generated_audio\"", FrontendFailureCategoryForApiClients::RuleBansGeneratedAudio), + ("\"rule_bans_generated_content\"", FrontendFailureCategoryForApiClients::RuleBansGeneratedContent), + ("\"filesize_too_large\"", FrontendFailureCategoryForApiClients::FilesizeTooLarge), + ("\"image_dimensions_too_small\"", FrontendFailureCategoryForApiClients::ImageDimensionsTooSmall), + ("\"image_dimensions_too_large\"", FrontendFailureCategoryForApiClients::ImageDimensionsTooLarge), + ("\"generation_failed\"", FrontendFailureCategoryForApiClients::GenerationFailed), + ]; + + for (json, expected) in cases { + let parsed: FrontendFailureCategoryForApiClients = serde_json::from_str(json) + .unwrap_or_else(|e| panic!("failed to parse {}: {}", json, e)); + assert_eq!(parsed, expected, "mismatch for {}", json); + } + } + + #[test] + fn test_deserialize_unknown_variant() { + let json = "\"some_future_category\""; + let parsed: FrontendFailureCategoryForApiClients = serde_json::from_str(json).unwrap(); + assert_eq!(parsed, FrontendFailureCategoryForApiClients::Unknown("some_future_category".to_string())); + } + + #[test] + fn test_deserialize_another_unknown_variant() { + let json = "\"totally_new_thing\""; + let parsed: FrontendFailureCategoryForApiClients = serde_json::from_str(json).unwrap(); + assert_eq!(parsed, FrontendFailureCategoryForApiClients::Unknown("totally_new_thing".to_string())); + } + + #[test] + fn test_serialize_known_variants() { + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForApiClients::FaceNotDetected).unwrap(), "\"face_not_detected\""); + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForApiClients::ModelRulesViolation).unwrap(), "\"model_rules_violation\""); + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForApiClients::GenerationFailed).unwrap(), "\"generation_failed\""); + } + + #[test] + fn test_serialize_unknown_variant() { + let unknown = FrontendFailureCategoryForApiClients::Unknown("some_future_category".to_string()); + assert_eq!(serde_json::to_string(&unknown).unwrap(), "\"some_future_category\""); + } + + #[test] + fn test_from_db_enum() { + assert_eq!( + FrontendFailureCategoryForApiClients::from_db_enum(FrontendFailureCategory::FaceNotDetected), + FrontendFailureCategoryForApiClients::FaceNotDetected + ); + assert_eq!( + FrontendFailureCategoryForApiClients::from_db_enum(FrontendFailureCategory::GenerationFailed), + FrontendFailureCategoryForApiClients::GenerationFailed + ); + assert_eq!( + FrontendFailureCategoryForApiClients::from_db_enum(FrontendFailureCategory::RuleBansGeneratedContent), + FrontendFailureCategoryForApiClients::RuleBansGeneratedContent + ); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/frontend_failure_category_for_old_clients.rs b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/frontend_failure_category_for_old_clients.rs new file mode 100644 index 00000000..348f0337 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/frontend_failure_category_for_old_clients.rs @@ -0,0 +1,85 @@ +use crate::enums::by_table::generic_inference_jobs::frontend_failure_category::FrontendFailureCategory; + +/// A restricted subset of `FrontendFailureCategory` that only includes values +/// known to old deployed clients. New failure categories are omitted so that +/// old clients never receive an enum value they cannot deserialize. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum FrontendFailureCategoryForOldClients { + #[serde(rename = "face_not_detected")] + FaceNotDetected, + + #[serde(rename = "keep_alive_elapsed")] + KeepAliveElapsed, + + #[serde(rename = "not_yet_implemented")] + NotYetImplemented, + + #[serde(rename = "retryable_worker_error")] + RetryableWorkerError, +} + +impl FrontendFailureCategoryForOldClients { + /// Attempts to convert a database-level `FrontendFailureCategory` into the + /// restricted old-client enum. Returns `None` for categories that old + /// clients do not understand. + pub fn try_from_db_enum(value: FrontendFailureCategory) -> Option { + match value { + FrontendFailureCategory::FaceNotDetected => Some(Self::FaceNotDetected), + FrontendFailureCategory::KeepAliveElapsed => Some(Self::KeepAliveElapsed), + FrontendFailureCategory::NotYetImplemented => Some(Self::NotYetImplemented), + FrontendFailureCategory::RetryableWorkerError => Some(Self::RetryableWorkerError), + _ => None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_known_variants_convert() { + assert_eq!( + FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::FaceNotDetected), + Some(FrontendFailureCategoryForOldClients::FaceNotDetected) + ); + assert_eq!( + FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::KeepAliveElapsed), + Some(FrontendFailureCategoryForOldClients::KeepAliveElapsed) + ); + assert_eq!( + FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::NotYetImplemented), + Some(FrontendFailureCategoryForOldClients::NotYetImplemented) + ); + assert_eq!( + FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RetryableWorkerError), + Some(FrontendFailureCategoryForOldClients::RetryableWorkerError) + ); + } + + #[test] + fn test_new_variants_return_none() { + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::NoForegroundSubjectDetected), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::FormatNotSupported), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::ModelRulesViolation), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansUserImage), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansUserImageWithFaces), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansUserTextPrompt), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansUserContent), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansGeneratedVideo), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansGeneratedAudio), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::RuleBansGeneratedContent), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::GenerationFailed), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::FilesizeTooLarge), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::ImageDimensionsTooSmall), None); + assert_eq!(FrontendFailureCategoryForOldClients::try_from_db_enum(FrontendFailureCategory::ImageDimensionsTooLarge), None); + } + + #[test] + fn test_serialization() { + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForOldClients::FaceNotDetected).unwrap(), "\"face_not_detected\""); + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForOldClients::KeepAliveElapsed).unwrap(), "\"keep_alive_elapsed\""); + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForOldClients::NotYetImplemented).unwrap(), "\"not_yet_implemented\""); + assert_eq!(serde_json::to_string(&FrontendFailureCategoryForOldClients::RetryableWorkerError).unwrap(), "\"retryable_worker_error\""); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/mod.rs b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/mod.rs new file mode 100644 index 00000000..78e030c3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/generic_inference_jobs/mod.rs @@ -0,0 +1,2 @@ +pub mod frontend_failure_category_for_old_clients; +pub mod frontend_failure_category_for_api_clients; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/mod.rs b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/mod.rs new file mode 100644 index 00000000..319789d2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/api_safe/by_table/mod.rs @@ -0,0 +1 @@ +pub mod generic_inference_jobs; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/api_safe/mod.rs b/crates/api_clients/artcraft_client/src/enums/api_safe/mod.rs new file mode 100644 index 00000000..dc279ee5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/api_safe/mod.rs @@ -0,0 +1 @@ +pub mod by_table; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/audit_log_entity_action.rs b/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/audit_log_entity_action.rs new file mode 100644 index 00000000..4c0c30ce --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/audit_log_entity_action.rs @@ -0,0 +1,109 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `audit_logs` table in a `VARCHAR(32)` field named `entity_action`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum AuditLogEntityAction { + /// Create action + #[serde(rename = "create")] + Create, + + /// Edit action + #[serde(rename = "edit")] + Edit, + + /// Edit features (eg. user feature flags) + #[serde(rename = "edit_features")] + EditFeatures, + + /// Delete action + #[serde(rename = "delete")] + Delete, + + /// Create featured item + #[serde(rename = "featured_item_create")] + FeaturedItemCreate, + + /// Delete featured item + #[serde(rename = "featured_item_delete")] + FeaturedItemDelete, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(AuditLogEntityAction); + +/// NB: Legacy API for older code. +impl AuditLogEntityAction { + pub fn to_str(&self) -> &'static str { + match self { + Self::Create => "create", + Self::Edit => "edit", + Self::EditFeatures => "edit_features", + Self::Delete => "delete", + Self::FeaturedItemCreate => "featured_item_create", + Self::FeaturedItemDelete => "featured_item_delete", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "create" => Ok(Self::Create), + "edit" => Ok(Self::Edit), + "edit_features" => Ok(Self::EditFeatures), + "delete" => Ok(Self::Delete), + "featured_item_create" => Ok(Self::FeaturedItemCreate), + "featured_item_delete" => Ok(Self::FeaturedItemDelete), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::audit_logs::audit_log_entity_action::AuditLogEntityAction; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(AuditLogEntityAction::Create, "create"); + assert_serialization(AuditLogEntityAction::Edit, "edit"); + assert_serialization(AuditLogEntityAction::EditFeatures, "edit_features"); + assert_serialization(AuditLogEntityAction::Delete, "delete"); + assert_serialization(AuditLogEntityAction::FeaturedItemCreate, "featured_item_create"); + assert_serialization(AuditLogEntityAction::FeaturedItemDelete, "featured_item_delete"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(AuditLogEntityAction::Create.to_str(), "create"); + assert_eq!(AuditLogEntityAction::Edit.to_str(), "edit"); + assert_eq!(AuditLogEntityAction::EditFeatures.to_str(), "edit_features"); + assert_eq!(AuditLogEntityAction::Delete.to_str(), "delete"); + assert_eq!(AuditLogEntityAction::FeaturedItemCreate.to_str(), "featured_item_create"); + assert_eq!(AuditLogEntityAction::FeaturedItemDelete.to_str(), "featured_item_delete"); + } + + #[test] + fn test_from_str() { + assert_eq!(AuditLogEntityAction::from_str("create").unwrap(), AuditLogEntityAction::Create); + assert_eq!(AuditLogEntityAction::from_str("edit").unwrap(), AuditLogEntityAction::Edit); + assert_eq!(AuditLogEntityAction::from_str("edit_features").unwrap(), AuditLogEntityAction::EditFeatures); + assert_eq!(AuditLogEntityAction::from_str("delete").unwrap(), AuditLogEntityAction::Delete); + assert_eq!(AuditLogEntityAction::from_str("featured_item_create").unwrap(), AuditLogEntityAction::FeaturedItemCreate); + assert_eq!(AuditLogEntityAction::from_str("featured_item_delete").unwrap(), AuditLogEntityAction::FeaturedItemDelete); + assert!(AuditLogEntityAction::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/audit_log_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/audit_log_entity_type.rs new file mode 100644 index 00000000..244603ec --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/audit_log_entity_type.rs @@ -0,0 +1,91 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `audit_logs` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum AuditLogEntityType { + /// Comment system + #[serde(rename = "comment")] + Comment, + + /// Media file + #[serde(rename = "media_file")] + MediaFile, + + /// Model weight + #[serde(rename = "model_weight")] + ModelWeight, + + /// User + #[serde(rename = "user")] + User, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(AuditLogEntityType); + +/// NB: Legacy API for older code. +impl AuditLogEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Comment => "comment", + Self::MediaFile => "media_file", + Self::ModelWeight => "model_weight", + Self::User => "user", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "comment" => Ok(Self::Comment), + "media_file" => Ok(Self::MediaFile), + "model_weight" => Ok(Self::ModelWeight), + "user" => Ok(Self::User), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::audit_logs::audit_log_entity_type::AuditLogEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(AuditLogEntityType::Comment, "comment"); + assert_serialization(AuditLogEntityType::MediaFile, "media_file"); + assert_serialization(AuditLogEntityType::ModelWeight, "model_weight"); + assert_serialization(AuditLogEntityType::User, "user"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(AuditLogEntityType::Comment.to_str(), "comment"); + assert_eq!(AuditLogEntityType::MediaFile.to_str(), "media_file"); + assert_eq!(AuditLogEntityType::ModelWeight.to_str(), "model_weight"); + assert_eq!(AuditLogEntityType::User.to_str(), "user"); + } + + #[test] + fn test_from_str() { + assert_eq!(AuditLogEntityType::from_str("comment").unwrap(), AuditLogEntityType::Comment); + assert_eq!(AuditLogEntityType::from_str("media_file").unwrap(), AuditLogEntityType::MediaFile); + assert_eq!(AuditLogEntityType::from_str("model_weight").unwrap(), AuditLogEntityType::ModelWeight); + assert_eq!(AuditLogEntityType::from_str("user").unwrap(), AuditLogEntityType::User); + assert!(AuditLogEntityType::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/mod.rs new file mode 100644 index 00000000..1aa6f447 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/audit_logs/mod.rs @@ -0,0 +1,2 @@ +pub mod audit_log_entity_action; +pub mod audit_log_entity_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/batch_generations/batch_generation_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/batch_generations/batch_generation_entity_type.rs new file mode 100644 index 00000000..257d9fdd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/batch_generations/batch_generation_entity_type.rs @@ -0,0 +1,106 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `batch_generations` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize, Ord, PartialOrd)] +pub enum BatchGenerationEntityType { + /// Media files + /// This will probably be the only type supported, but we'll leave the possibility of future types. + #[serde(rename = "media_file")] + MediaFile, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(BatchGenerationEntityType); + +/// NB: Legacy API for older code. +impl BatchGenerationEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaFile => "media_file", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_file" => Ok(Self::MediaFile), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::MediaFile, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::batch_generations::batch_generation_entity_type::BatchGenerationEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(BatchGenerationEntityType::MediaFile, "media_file"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(BatchGenerationEntityType::MediaFile.to_str(), "media_file"); + } + + #[test] + fn from_str() { + assert_eq!(BatchGenerationEntityType::from_str("media_file").unwrap(), BatchGenerationEntityType::MediaFile); + assert!(BatchGenerationEntityType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = BatchGenerationEntityType::all_variants(); + assert_eq!(variants.len(), 1); + assert_eq!(variants.pop_first(), Some(BatchGenerationEntityType::MediaFile)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(BatchGenerationEntityType::all_variants().len(), BatchGenerationEntityType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in BatchGenerationEntityType::all_variants() { + assert_eq!(variant, BatchGenerationEntityType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, BatchGenerationEntityType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, BatchGenerationEntityType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/batch_generations/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/batch_generations/mod.rs new file mode 100644 index 00000000..2babf4fa --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/batch_generations/mod.rs @@ -0,0 +1 @@ +pub mod batch_generation_entity_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/beta_keys/beta_key_product.rs b/crates/api_clients/artcraft_client/src/enums/by_table/beta_keys/beta_key_product.rs new file mode 100644 index 00000000..b89c0927 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/beta_keys/beta_key_product.rs @@ -0,0 +1,106 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `batch_generations` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize, Ord, PartialOrd)] +pub enum BetaKeyProduct { + /// Media files + /// This will probably be the only type supported, but we'll leave the possibility of future types. + #[serde(rename = "studio")] + Studio, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(BetaKeyProduct); + +/// NB: Legacy API for older code. +impl BetaKeyProduct { + pub fn to_str(&self) -> &'static str { + match self { + Self::Studio => "studio", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "studio" => Ok(Self::Studio), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Studio, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::beta_keys::beta_key_product::BetaKeyProduct; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(BetaKeyProduct::Studio, "studio"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(BetaKeyProduct::Studio.to_str(), "studio"); + } + + #[test] + fn from_str() { + assert_eq!(BetaKeyProduct::from_str("studio").unwrap(), BetaKeyProduct::Studio); + assert!(BetaKeyProduct::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = BetaKeyProduct::all_variants(); + assert_eq!(variants.len(), 1); + assert_eq!(variants.pop_first(), Some(BetaKeyProduct::Studio)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(BetaKeyProduct::all_variants().len(), BetaKeyProduct::iter().len()); + } + + #[test] + fn round_trip() { + for variant in BetaKeyProduct::all_variants() { + assert_eq!(variant, BetaKeyProduct::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, BetaKeyProduct::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, BetaKeyProduct::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/beta_keys/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/beta_keys/mod.rs new file mode 100644 index 00000000..a3484beb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/beta_keys/mod.rs @@ -0,0 +1 @@ +pub mod beta_key_product; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/characters/character_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/characters/character_type.rs new file mode 100644 index 00000000..dab5dc9b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/characters/character_type.rs @@ -0,0 +1,107 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `characters` table in `VARCHAR(24)` field `character_type`. +/// +/// Identifies the type/backend used to create the character. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum CharacterType { + /// Character created via Kinovi / Seedance2Pro. + #[serde(rename = "kinovi_seedance")] + KinoviSeedance, +} + +impl_enum_display_and_debug_using_to_str!(CharacterType); + +impl CharacterType { + pub fn to_str(&self) -> &'static str { + match self { + Self::KinoviSeedance => "kinovi_seedance", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "kinovi_seedance" => Ok(Self::KinoviSeedance), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::KinoviSeedance, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::characters::character_type::CharacterType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(CharacterType::KinoviSeedance, "kinovi_seedance"); + } + + #[test] + fn to_str() { + assert_eq!(CharacterType::KinoviSeedance.to_str(), "kinovi_seedance"); + } + + #[test] + fn from_str() { + assert_eq!(CharacterType::from_str("kinovi_seedance").unwrap(), CharacterType::KinoviSeedance); + assert!(CharacterType::from_str("invalid").is_err()); + } + + #[test] + fn all_variants() { + const EXPECTED_COUNT: usize = 1; + + assert_eq!(CharacterType::all_variants().len(), EXPECTED_COUNT); + + use strum::IntoEnumIterator; + assert_eq!(CharacterType::all_variants().len(), CharacterType::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CharacterType::all_variants().len(), CharacterType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CharacterType::all_variants() { + assert_eq!(variant, CharacterType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CharacterType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CharacterType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 24; + for variant in CharacterType::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long for VARCHAR({})", variant, MAX_LENGTH); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/characters/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/characters/mod.rs new file mode 100644 index 00000000..d7b62c5e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/characters/mod.rs @@ -0,0 +1 @@ +pub mod character_type; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/comments/comment_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/comments/comment_entity_type.rs new file mode 100644 index 00000000..c6aef519 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/comments/comment_entity_type.rs @@ -0,0 +1,118 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `comments` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum CommentEntityType { + /// User + #[serde(rename = "user")] + User, + + /// Media files + #[serde(rename = "media_file")] + MediaFile, + + /// Model weights + #[serde(rename = "model_weight")] + ModelWeight, + + /// TTS model (architecture does not matter) + #[serde(rename = "tts_model")] + TtsModel, + + /// TTS result (architecture does not matter) + #[serde(rename = "tts_result")] + TtsResult, + + /// W2L template + #[serde(rename = "w2l_template")] + W2lTemplate, + + /// W2L result + #[serde(rename = "w2l_result")] + W2lResult, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(CommentEntityType); + +/// NB: Legacy API for older code. +impl CommentEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::User => "user", + Self::MediaFile => "media_file", + Self::ModelWeight => "model_weight", + Self::TtsModel => "tts_model", + Self::TtsResult => "tts_result", + Self::W2lTemplate => "w2l_template", + Self::W2lResult => "w2l_result", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "user" => Ok(Self::User), + "media_file" => Ok(Self::MediaFile), + "model_weight" => Ok(Self::ModelWeight), + "tts_model" => Ok(Self::TtsModel), + "tts_result" => Ok(Self::TtsResult), + "w2l_template" => Ok(Self::W2lTemplate), + "w2l_result" => Ok(Self::W2lResult), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::comments::comment_entity_type::CommentEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(CommentEntityType::User, "user"); + assert_serialization(CommentEntityType::MediaFile, "media_file"); + assert_serialization(CommentEntityType::ModelWeight, "model_weight"); + assert_serialization(CommentEntityType::TtsModel, "tts_model"); + assert_serialization(CommentEntityType::TtsResult, "tts_result"); + assert_serialization(CommentEntityType::W2lTemplate, "w2l_template"); + assert_serialization(CommentEntityType::W2lResult, "w2l_result"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(CommentEntityType::User.to_str(), "user"); + assert_eq!(CommentEntityType::MediaFile.to_str(), "media_file"); + assert_eq!(CommentEntityType::ModelWeight.to_str(), "model_weight"); + assert_eq!(CommentEntityType::TtsModel.to_str(), "tts_model"); + assert_eq!(CommentEntityType::TtsResult.to_str(), "tts_result"); + assert_eq!(CommentEntityType::W2lTemplate.to_str(), "w2l_template"); + assert_eq!(CommentEntityType::W2lResult.to_str(), "w2l_result"); + } + + #[test] + fn test_from_str() { + assert_eq!(CommentEntityType::from_str("user").unwrap(), CommentEntityType::User); + assert_eq!(CommentEntityType::from_str("media_file").unwrap(), CommentEntityType::MediaFile); + assert_eq!(CommentEntityType::from_str("model_weight").unwrap(), CommentEntityType::ModelWeight); + assert_eq!(CommentEntityType::from_str("tts_model").unwrap(), CommentEntityType::TtsModel); + assert_eq!(CommentEntityType::from_str("tts_result").unwrap(), CommentEntityType::TtsResult); + assert_eq!(CommentEntityType::from_str("w2l_template").unwrap(), CommentEntityType::W2lTemplate); + assert_eq!(CommentEntityType::from_str("w2l_result").unwrap(), CommentEntityType::W2lResult); + assert!(CommentEntityType::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/comments/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/comments/mod.rs new file mode 100644 index 00000000..2d9897d2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/comments/mod.rs @@ -0,0 +1 @@ +pub mod comment_entity_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/debug_log_level.rs b/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/debug_log_level.rs new file mode 100644 index 00000000..adca09d7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/debug_log_level.rs @@ -0,0 +1,148 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +pub const MAX_LENGTH: usize = 16; + +/// Used in the `debug_logs` table in a `VARCHAR(16)` field (`maybe_log_level`). +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum DebugLogLevel { + Info, + Warn, + Error, + Debug, + Trace, +} + +impl_enum_display_and_debug_using_to_str!(DebugLogLevel); + +impl DebugLogLevel { + pub fn to_str(&self) -> &'static str { + match self { + Self::Info => "info", + Self::Warn => "warn", + Self::Error => "error", + Self::Debug => "debug", + Self::Trace => "trace", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "info" => Ok(Self::Info), + "warn" => Ok(Self::Warn), + "error" => Ok(Self::Error), + "debug" => Ok(Self::Debug), + "trace" => Ok(Self::Trace), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Info, + Self::Warn, + Self::Error, + Self::Debug, + Self::Trace, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::debug_logs::debug_log_level::DebugLogLevel; + use crate::enums::by_table::debug_logs::debug_log_level::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(DebugLogLevel::Info, "info"); + assert_serialization(DebugLogLevel::Warn, "warn"); + assert_serialization(DebugLogLevel::Error, "error"); + assert_serialization(DebugLogLevel::Debug, "debug"); + assert_serialization(DebugLogLevel::Trace, "trace"); + } + + #[test] + fn to_str() { + assert_eq!(DebugLogLevel::Info.to_str(), "info"); + assert_eq!(DebugLogLevel::Warn.to_str(), "warn"); + assert_eq!(DebugLogLevel::Error.to_str(), "error"); + assert_eq!(DebugLogLevel::Debug.to_str(), "debug"); + assert_eq!(DebugLogLevel::Trace.to_str(), "trace"); + } + + #[test] + fn from_str() { + assert_eq!(DebugLogLevel::from_str("info").unwrap(), DebugLogLevel::Info); + assert_eq!(DebugLogLevel::from_str("warn").unwrap(), DebugLogLevel::Warn); + assert_eq!(DebugLogLevel::from_str("error").unwrap(), DebugLogLevel::Error); + assert_eq!(DebugLogLevel::from_str("debug").unwrap(), DebugLogLevel::Debug); + assert_eq!(DebugLogLevel::from_str("trace").unwrap(), DebugLogLevel::Trace); + } + + #[test] + fn from_str_err() { + let result = DebugLogLevel::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = DebugLogLevel::all_variants(); + assert_eq!(variants.len(), 5); + assert_eq!(variants.pop_first(), Some(DebugLogLevel::Info)); + assert_eq!(variants.pop_first(), Some(DebugLogLevel::Warn)); + assert_eq!(variants.pop_first(), Some(DebugLogLevel::Error)); + assert_eq!(variants.pop_first(), Some(DebugLogLevel::Debug)); + assert_eq!(variants.pop_first(), Some(DebugLogLevel::Trace)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(DebugLogLevel::all_variants().len(), DebugLogLevel::iter().len()); + } + + #[test] + fn round_trip() { + for variant in DebugLogLevel::all_variants() { + assert_eq!(variant, DebugLogLevel::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, DebugLogLevel::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, DebugLogLevel::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn max_length() { + for variant in DebugLogLevel::all_variants() { + assert!(variant.to_str().len() <= MAX_LENGTH); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/debug_log_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/debug_log_type.rs new file mode 100644 index 00000000..c8d3d68d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/debug_log_type.rs @@ -0,0 +1,189 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +pub const MAX_LENGTH: usize = 24; + +/// Used in the `debug_logs` table in a `VARCHAR(24)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum DebugLogType { + // ========== First party ========== + + /// A user request, typically the Json actix_web handlers read. + HttpRequest, + + /// A backend/pipeline failure while serving a request. + BackendFailure, + + // ========== Third party ========== + + FalRequest, + KinoviRequest, + GrokApiRequest, + FalWebhook, + BeebleWebhook, +} + +impl_enum_display_and_debug_using_to_str!(DebugLogType); + +impl DebugLogType { + pub fn to_str(&self) -> &'static str { + match self { + Self::HttpRequest => "http_request", + Self::BackendFailure => "backend_failure", + Self::FalRequest => "fal_request", + Self::KinoviRequest => "kinovi_request", + Self::GrokApiRequest => "grok_api_request", + Self::FalWebhook => "fal_webhook", + Self::BeebleWebhook => "beeble_webhook", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "http_request" => Ok(Self::HttpRequest), + "backend_failure" => Ok(Self::BackendFailure), + "fal_request" => Ok(Self::FalRequest), + "kinovi_request" => Ok(Self::KinoviRequest), + "grok_api_request" => Ok(Self::GrokApiRequest), + "fal_webhook" => Ok(Self::FalWebhook), + "beeble_webhook" => Ok(Self::BeebleWebhook), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::HttpRequest, + Self::BackendFailure, + Self::FalRequest, + Self::KinoviRequest, + Self::GrokApiRequest, + Self::FalWebhook, + Self::BeebleWebhook, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::debug_logs::debug_log_type::DebugLogType; + use crate::enums::by_table::debug_logs::debug_log_type::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(DebugLogType::HttpRequest, "http_request"); + assert_serialization(DebugLogType::BackendFailure, "backend_failure"); + assert_serialization(DebugLogType::FalRequest, "fal_request"); + assert_serialization(DebugLogType::KinoviRequest, "kinovi_request"); + assert_serialization(DebugLogType::GrokApiRequest, "grok_api_request"); + assert_serialization(DebugLogType::FalWebhook, "fal_webhook"); + assert_serialization(DebugLogType::BeebleWebhook, "beeble_webhook"); + } + + #[test] + fn to_str() { + assert_eq!(DebugLogType::HttpRequest.to_str(), "http_request"); + assert_eq!(DebugLogType::BackendFailure.to_str(), "backend_failure"); + assert_eq!(DebugLogType::FalRequest.to_str(), "fal_request"); + assert_eq!(DebugLogType::KinoviRequest.to_str(), "kinovi_request"); + assert_eq!(DebugLogType::GrokApiRequest.to_str(), "grok_api_request"); + assert_eq!(DebugLogType::FalWebhook.to_str(), "fal_webhook"); + assert_eq!(DebugLogType::BeebleWebhook.to_str(), "beeble_webhook"); + } + + #[test] + fn from_str() { + assert_eq!(DebugLogType::from_str("http_request").unwrap(), DebugLogType::HttpRequest); + assert_eq!(DebugLogType::from_str("backend_failure").unwrap(), DebugLogType::BackendFailure); + assert_eq!(DebugLogType::from_str("fal_request").unwrap(), DebugLogType::FalRequest); + assert_eq!(DebugLogType::from_str("kinovi_request").unwrap(), DebugLogType::KinoviRequest); + assert_eq!(DebugLogType::from_str("grok_api_request").unwrap(), DebugLogType::GrokApiRequest); + assert_eq!(DebugLogType::from_str("fal_webhook").unwrap(), DebugLogType::FalWebhook); + assert_eq!(DebugLogType::from_str("beeble_webhook").unwrap(), DebugLogType::BeebleWebhook); + } + + #[test] + fn from_str_err() { + let result = DebugLogType::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = DebugLogType::all_variants(); + assert_eq!(variants.len(), 7); + assert_eq!(variants.pop_first(), Some(DebugLogType::HttpRequest)); + assert_eq!(variants.pop_first(), Some(DebugLogType::BackendFailure)); + assert_eq!(variants.pop_first(), Some(DebugLogType::FalRequest)); + assert_eq!(variants.pop_first(), Some(DebugLogType::KinoviRequest)); + assert_eq!(variants.pop_first(), Some(DebugLogType::GrokApiRequest)); + assert_eq!(variants.pop_first(), Some(DebugLogType::FalWebhook)); + assert_eq!(variants.pop_first(), Some(DebugLogType::BeebleWebhook)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(DebugLogType::all_variants().len(), DebugLogType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in DebugLogType::all_variants() { + assert_eq!(variant, DebugLogType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, DebugLogType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, DebugLogType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in DebugLogType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long via to_str()", variant); + } + for variant in DebugLogType::all_variants() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(json.len() <= MAX_LENGTH, "variant {:?} is too long via JSON: {:?}", variant, json); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in DebugLogType::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/mod.rs new file mode 100644 index 00000000..f67cbb4a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/debug_logs/mod.rs @@ -0,0 +1,2 @@ +pub mod debug_log_level; +pub mod debug_log_type; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/email_sender_jobs/email_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/email_sender_jobs/email_category.rs new file mode 100644 index 00000000..6a041f49 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/email_sender_jobs/email_category.rs @@ -0,0 +1,114 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `email_sender_jobs` table in `VARCHAR(32)` field `id_category`. +/// +/// This denotes the type of email being sent. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum EmailCategory { + /// User is recently registered + #[serde(rename = "welcome")] + Welcome, + + /// User is resetting their password + #[serde(rename = "password_reset")] + PasswordReset, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(EmailCategory); + +/// NB: Legacy API for older code. +impl EmailCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::Welcome => "welcome", + Self::PasswordReset => "password_reset", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "welcome" => Ok(Self::Welcome), + "password_reset" => Ok(Self::PasswordReset), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Welcome, + Self::PasswordReset, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::email_sender_jobs::email_category::EmailCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(EmailCategory::Welcome, "welcome"); + assert_serialization(EmailCategory::PasswordReset, "password_reset"); + } + + #[test] + fn to_str() { + assert_eq!(EmailCategory::Welcome.to_str(), "welcome"); + assert_eq!(EmailCategory::PasswordReset.to_str(), "password_reset"); + } + + #[test] + fn from_str() { + assert_eq!(EmailCategory::from_str("welcome").unwrap(), EmailCategory::Welcome); + assert_eq!(EmailCategory::from_str("password_reset").unwrap(), EmailCategory::PasswordReset); + } + + #[test] + fn all_variants() { + // Static check + let mut variants = EmailCategory::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(EmailCategory::Welcome)); + assert_eq!(variants.pop_first(), Some(EmailCategory::PasswordReset)); + assert_eq!(variants.pop_first(), None); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(EmailCategory::all_variants().len(), EmailCategory::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(EmailCategory::all_variants().len(), EmailCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in EmailCategory::all_variants() { + assert_eq!(variant, EmailCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, EmailCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, EmailCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/email_sender_jobs/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/email_sender_jobs/mod.rs new file mode 100644 index 00000000..18d57317 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/email_sender_jobs/mod.rs @@ -0,0 +1 @@ +pub mod email_category; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/entity_stats/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/entity_stats/mod.rs new file mode 100644 index 00000000..12b1d9ca --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/entity_stats/mod.rs @@ -0,0 +1 @@ +pub mod stats_entity_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/entity_stats/stats_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/entity_stats/stats_entity_type.rs new file mode 100644 index 00000000..0ae673a0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/entity_stats/stats_entity_type.rs @@ -0,0 +1,119 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `user_stats` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize, Ord, PartialOrd)] +pub enum StatsEntityType { + /// Comment + #[serde(rename = "comment")] + Comment, + + /// MediaFile + #[serde(rename = "media_file")] + MediaFile, + + /// ModelWeight (the new way to store models) + #[serde(rename = "model_weight")] + ModelWeight, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(StatsEntityType); + +/// NB: Legacy API for older code. +impl StatsEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Comment => "comment", + Self::MediaFile => "media_file", + Self::ModelWeight => "model_weight", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "comment" => Ok(Self::Comment), + "media_file" => Ok(Self::MediaFile), + "model_weight" => Ok(Self::ModelWeight), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Comment, + Self::MediaFile, + Self::ModelWeight, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::entity_stats::stats_entity_type::StatsEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(StatsEntityType::Comment, "comment"); + assert_serialization(StatsEntityType::MediaFile, "media_file"); + assert_serialization(StatsEntityType::ModelWeight, "model_weight"); + } + + #[test] + fn test_to_str() { + assert_eq!(StatsEntityType::Comment.to_str(), "comment"); + assert_eq!(StatsEntityType::MediaFile.to_str(), "media_file"); + assert_eq!(StatsEntityType::ModelWeight.to_str(), "model_weight"); + } + + #[test] + fn test_from_str() { + assert_eq!(StatsEntityType::from_str("comment").unwrap(), StatsEntityType::Comment); + assert_eq!(StatsEntityType::from_str("media_file").unwrap(), StatsEntityType::MediaFile); + assert_eq!(StatsEntityType::from_str("model_weight").unwrap(), StatsEntityType::ModelWeight); + assert!(StatsEntityType::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = StatsEntityType::all_variants(); + assert_eq!(variants.len(), 3); + assert_eq!(variants.pop_first(), Some(StatsEntityType::Comment)); + assert_eq!(variants.pop_first(), Some(StatsEntityType::MediaFile)); + assert_eq!(variants.pop_first(), Some(StatsEntityType::ModelWeight)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(StatsEntityType::all_variants().len(), StatsEntityType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in StatsEntityType::all_variants() { + assert_eq!(variant, StatsEntityType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, StatsEntityType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, StatsEntityType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/featured_items/featured_item_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/featured_items/featured_item_entity_type.rs new file mode 100644 index 00000000..19463cda --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/featured_items/featured_item_entity_type.rs @@ -0,0 +1,123 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `user_bookmarks` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum FeaturedItemEntityType { + /// MediaFile + #[serde(rename = "media_file")] + MediaFile, + + /// ModelWeight (the new way to store models) + #[serde(rename = "model_weight")] + ModelWeight, + + /// User + #[serde(rename = "user")] + User, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(FeaturedItemEntityType); + +/// NB: Legacy API for older code. +impl FeaturedItemEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaFile => "media_file", + Self::ModelWeight => "model_weight", + Self::User => "user", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_file" => Ok(Self::MediaFile), + "model_weight" => Ok(Self::ModelWeight), + "user" => Ok(Self::User), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::MediaFile, + Self::ModelWeight, + Self::User, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::featured_items::featured_item_entity_type::FeaturedItemEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(FeaturedItemEntityType::MediaFile, "media_file"); + assert_serialization(FeaturedItemEntityType::ModelWeight, "model_weight"); + assert_serialization(FeaturedItemEntityType::User, "user"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(FeaturedItemEntityType::MediaFile.to_str(), "media_file"); + assert_eq!(FeaturedItemEntityType::ModelWeight.to_str(), "model_weight"); + assert_eq!(FeaturedItemEntityType::User.to_str(), "user"); + } + + #[test] + fn test_from_str() { + assert_eq!(FeaturedItemEntityType::from_str("media_file").unwrap(), FeaturedItemEntityType::MediaFile); + assert_eq!(FeaturedItemEntityType::from_str("model_weight").unwrap(), FeaturedItemEntityType::ModelWeight); + assert_eq!(FeaturedItemEntityType::from_str("user").unwrap(), FeaturedItemEntityType::User); + assert!(FeaturedItemEntityType::from_str("foo").is_err()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(FeaturedItemEntityType::all_variants().len(), FeaturedItemEntityType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in FeaturedItemEntityType::all_variants() { + assert_eq!(variant, FeaturedItemEntityType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, FeaturedItemEntityType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, FeaturedItemEntityType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in FeaturedItemEntityType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/featured_items/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/featured_items/mod.rs new file mode 100644 index 00000000..71c7785b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/featured_items/mod.rs @@ -0,0 +1 @@ +pub mod featured_item_entity_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_download_jobs/generic_download_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_download_jobs/generic_download_type.rs new file mode 100644 index 00000000..0f8004ba --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_download_jobs/generic_download_type.rs @@ -0,0 +1,166 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +// TODO: Use macro-derived impls + +/// Our "generic downloads" pipeline supports a wide variety of ML models and other media. +/// They are serialized in the database table `generic_download_jobs` as a VARCHAR(32). +/// +/// Each type of download is identified by the following enum variants. +/// These types are present in the HTTP API and database columns as serialized here. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[derive(Clone, Copy, Eq, PartialEq, Debug, Deserialize, Serialize, Hash, Ord, PartialOrd)] +#[cfg_attr(test, derive(EnumIter, EnumCount))] +pub enum GenericDownloadType { + /// NB: Note - this is hifigan for Tacotron2. + /// Some work will be needed to unify this with other hifigan types. + #[serde(rename = "hifigan")] + HifiGan, + + /// NB: Note - this is hifigan for SoftVC (our internal codename is "rocketvc"). + /// Some work will need to be done to unify this with other hifigan types. + #[serde(rename = "hifigan_rocket_vc")] + HifiGanRocketVc, + + /// NB: Note - this is hifigan for SoVitsSvc + /// Some work will need to be done to unify this with other hifigan types. + #[serde(rename = "hifigan_so_vits_svc")] + HifiGanSoVitsSvc, + + //#[serde(rename = "melgan_vocodes")] + //#[sqlx(rename = "melgan_vocodes")] + //MelGanVocodes, + + /// NB: Our external-facing name for "softvc" is rocketvc. + /// I wish we could stop being stupid about this. + #[serde(rename = "rocket_vc")] + RocketVc, + + /// RVC (v2) voice conversion models + #[serde(rename = "rvc_v2")] + RvcV2, + + /// so-vits-svc voice conversion models + #[serde(rename = "so_vits_svc")] + SoVitsSvc, + + /// Tacotron TTS models. + #[serde(rename = "tacotron2")] + Tacotron2, + + /// VITS TTS models. + #[serde(rename = "vits")] + Vits, +} + +/// NB: Legacy API for older code. +impl GenericDownloadType { + pub fn to_str(&self) -> &'static str { + match self { + Self::HifiGan => "hifigan", + Self::HifiGanRocketVc => "hifigan_rocket_vc", + Self::HifiGanSoVitsSvc => "hifigan_so_vits_svc", + Self::RocketVc => "rocket_vc", + Self::RvcV2 => "rvc_v2", + Self::SoVitsSvc => "so_vits_svc", + Self::Tacotron2 => "tacotron2", + Self::Vits => "vits", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "hifigan" => Ok(Self::HifiGan), + "hifigan_rocket_vc" => Ok(Self::HifiGanRocketVc), + "hifigan_so_vits_svc" => Ok(Self::HifiGanSoVitsSvc), + "rocket_vc" => Ok(Self::RocketVc), + "rvc_v2" => Ok(Self::RvcV2), + "so_vits_svc" => Ok(Self::SoVitsSvc), + "tacotron2" => Ok(Self::Tacotron2), + "vits" => Ok(Self::Vits), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::HifiGan, + Self::HifiGanRocketVc, + Self::HifiGanSoVitsSvc, + Self::RocketVc, + Self::RvcV2, + Self::SoVitsSvc, + Self::Tacotron2, + Self::Vits, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_download_jobs::generic_download_type::GenericDownloadType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(GenericDownloadType::HifiGan, "hifigan"); + assert_serialization(GenericDownloadType::HifiGanRocketVc, "hifigan_rocket_vc"); + assert_serialization(GenericDownloadType::HifiGanSoVitsSvc, "hifigan_so_vits_svc"); + assert_serialization(GenericDownloadType::RocketVc, "rocket_vc"); + assert_serialization(GenericDownloadType::RvcV2, "rvc_v2"); + assert_serialization(GenericDownloadType::SoVitsSvc, "so_vits_svc"); + assert_serialization(GenericDownloadType::Tacotron2, "tacotron2"); + assert_serialization(GenericDownloadType::Vits, "vits"); + } + + #[test] + fn to_str() { + assert_eq!(GenericDownloadType::HifiGan.to_str(), "hifigan"); + assert_eq!(GenericDownloadType::HifiGanRocketVc.to_str(), "hifigan_rocket_vc"); + assert_eq!(GenericDownloadType::HifiGanSoVitsSvc.to_str(), "hifigan_so_vits_svc"); + assert_eq!(GenericDownloadType::RocketVc.to_str(), "rocket_vc"); + assert_eq!(GenericDownloadType::RvcV2.to_str(), "rvc_v2"); + assert_eq!(GenericDownloadType::SoVitsSvc.to_str(), "so_vits_svc"); + assert_eq!(GenericDownloadType::Tacotron2.to_str(), "tacotron2"); + assert_eq!(GenericDownloadType::Vits.to_str(), "vits"); + } + + #[test] + fn from_str() { + assert_eq!(GenericDownloadType::from_str("hifigan").unwrap(), GenericDownloadType::HifiGan); + assert_eq!(GenericDownloadType::from_str("hifigan_rocket_vc").unwrap(), GenericDownloadType::HifiGanRocketVc); + assert_eq!(GenericDownloadType::from_str("hifigan_so_vits_svc").unwrap(), GenericDownloadType::HifiGanSoVitsSvc); + assert_eq!(GenericDownloadType::from_str("rocket_vc").unwrap(), GenericDownloadType::RocketVc); + assert_eq!(GenericDownloadType::from_str("rvc_v2").unwrap(), GenericDownloadType::RvcV2); + assert_eq!(GenericDownloadType::from_str("so_vits_svc").unwrap(), GenericDownloadType::SoVitsSvc); + assert_eq!(GenericDownloadType::from_str("tacotron2").unwrap(), GenericDownloadType::Tacotron2); + assert_eq!(GenericDownloadType::from_str("vits").unwrap(), GenericDownloadType::Vits); + } + + #[test] + fn all_variants() { + // Static check + let mut variants = GenericDownloadType::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::HifiGan)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::HifiGanRocketVc)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::HifiGanSoVitsSvc)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::RocketVc)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::RvcV2)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::SoVitsSvc)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::Tacotron2)); + assert_eq!(variants.pop_first(), Some(GenericDownloadType::Vits)); + assert_eq!(variants.pop_first(), None); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(GenericDownloadType::all_variants().len(), GenericDownloadType::iter().len()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_download_jobs/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_download_jobs/mod.rs new file mode 100644 index 00000000..40d1e08d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_download_jobs/mod.rs @@ -0,0 +1 @@ +pub mod generic_download_type; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/frontend_failure_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/frontend_failure_category.rs new file mode 100644 index 00000000..d604793b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/frontend_failure_category.rs @@ -0,0 +1,341 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `frontend_failure_category`. +/// +/// When jobs fail (permanently or transiently), we need to inform the frontend of the reason, +/// because perhaps there's something the user can do to change their input. +/// +/// The previous "VARCHAR(32) failure_reason" column was a text-based message that could not be +/// localized or made user friendly. This `frontend_failure_category` exists to provide well-defined +/// failure categories to the frontend that can easily be localized and indicated consistently in +/// the UI. +/// +/// Another benefit is that we'll surface all of the various types of failure and perhaps eventually +/// come to handle some in a cross-cutting way. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum FrontendFailureCategory { + /// When a face is not detected in the image used for animation. + /// For SadTalker (and possibly Wav2Lip) + #[serde(rename = "face_not_detected")] + FaceNotDetected, + + /// No foreground subject could be detected in the input image after + /// background removal (fal TripoSplat `input_value_error`). The user should + /// provide an image with a clear subject against a plain or distinct + /// background. + #[serde(rename = "no_foreground_subject_detected")] + NoForegroundSubjectDetected, + + /// The input file's format isn't supported by the model (e.g. Hunyuan 3D + /// Part only accepts FBX input). The user should convert or pick a + /// supported file. + #[serde(rename = "format_not_supported")] + FormatNotSupported, + + /// The user stepped away from their device and expected the workload to finish. + /// Some workloads require that the user keep their browser open. + #[serde(rename = "keep_alive_elapsed")] + KeepAliveElapsed, + + /// This is mostly for developers -- a feature isn't complete somewhere in the code. + /// Big oops if errors of this class make it to production. + #[serde(rename = "not_yet_implemented")] + NotYetImplemented, + + /// Tell the user that some kind of transient error happened. They don't need to know + /// exactly what happened. We'll retry their workload in any case. + #[serde(rename = "retryable_worker_error")] + RetryableWorkerError, + + /// Model content rules were violated + /// Eg. Seedance 2 will report: "your input text violates platform rules. please modify and try again" + #[serde(rename = "model_rules_violation")] + ModelRulesViolation, + + /// Model content violation + /// e.g. "Your uploaded image violates platform rules. Please modify and try again." (seedance2pro) + /// Model content rules prohibit the uploaded image. + #[serde(rename = "rule_bans_user_image")] + RuleBansUserImage, + + /// Model content violation + /// Model content rules prohibit user uploaded images containing faces (Seedance 2.0) + /// e.g. "The generated video did not pass review. Credits will not be deducted." (seedance2pro) + #[serde(rename = "rule_bans_user_image_with_faces")] + RuleBansUserImageWithFaces, + + /// Model content violation + /// Model content rules prohibit the user's given text prompt (this fails early). + /// e.g. "The generated video did not pass review. Credits will not be deducted." (seedance2pro) + #[serde(rename = "rule_bans_user_text_prompt")] + RuleBansUserTextPrompt, + + /// Model content violation + /// Model content rules prohibit user content. (I think this check happens early.) + /// e.g. "Content violates platform rules. Please modify and try again." (seedance2pro) + /// We also map fal WebhookErrorType::ContentPolicyViolation to this. + #[serde(rename = "rule_bans_user_content")] + RuleBansUserContent, + + /// Model content violation + /// The video didn't pass checks after it finished generation (this fails at the very end of the generation). + /// e.g. "The generated video did not pass review. Credits will not be deducted." (seedance2pro) + #[serde(rename = "rule_bans_generated_video")] + RuleBansGeneratedVideo, + + /// Model content violation + /// The audio (even in video!) didn't pass checks after it finished generation (this fails at the very end of the generation). + /// e.g. "The generated audio violates platform rules. Please adjust your prompt or images and try again." (seedance2pro) + #[serde(rename = "rule_bans_generated_audio")] + RuleBansGeneratedAudio, + + /// Model content violation + /// The content didn't pass checks after it finished generation (this fails at the very end of the generation). + /// e.g. "The generated content violates platform rules. Please adjust your prompt or images and try again." (seedance2pro) + #[serde(rename = "rule_bans_generated_content")] + RuleBansGeneratedContent, + + /// The uploaded file exceeds the maximum allowed size for this model. + /// We map fal WebhookErrorType::FileTooLarge to this. + #[serde(rename = "filesize_too_large")] + FilesizeTooLarge, + + /// The uploaded image dimensions are below the minimum required by the model. + /// We map fal WebhookErrorType::ImageTooSmall to this. + #[serde(rename = "image_dimensions_too_small")] + ImageDimensionsTooSmall, + + /// The uploaded image dimensions exceed the maximum allowed by the model. + /// We map fal WebhookErrorType::ImageTooLarge to this. + #[serde(rename = "image_dimensions_too_large")] + ImageDimensionsTooLarge, + + /// Generation failed (no reason) + /// Unspecified failure reason + /// Various example failures: + /// - "The generated video did not pass review. Credits will not be deducted." (seedance2pro) + /// - "Server error. Please try again later." (seedance2pro) + #[serde(rename = "generation_failed")] + GenerationFailed, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(FrontendFailureCategory); + +/// NB: Legacy API for older code. +impl FrontendFailureCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::FaceNotDetected => "face_not_detected", + Self::NoForegroundSubjectDetected => "no_foreground_subject_detected", + Self::FormatNotSupported => "format_not_supported", + Self::KeepAliveElapsed => "keep_alive_elapsed", + Self::NotYetImplemented => "not_yet_implemented", + Self::RetryableWorkerError => "retryable_worker_error", + Self::ModelRulesViolation => "model_rules_violation", + Self::RuleBansUserImage => "rule_bans_user_image", + Self::RuleBansUserImageWithFaces => "rule_bans_user_image_with_faces", + Self::RuleBansUserTextPrompt => "rule_bans_user_text_prompt", + Self::RuleBansUserContent => "rule_bans_user_content", + Self::RuleBansGeneratedVideo => "rule_bans_generated_video", + Self::RuleBansGeneratedAudio => "rule_bans_generated_audio", + Self::RuleBansGeneratedContent => "rule_bans_generated_content", + Self::FilesizeTooLarge => "filesize_too_large", + Self::ImageDimensionsTooSmall => "image_dimensions_too_small", + Self::ImageDimensionsTooLarge => "image_dimensions_too_large", + Self::GenerationFailed => "generation_failed", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "face_not_detected" => Ok(Self::FaceNotDetected), + "no_foreground_subject_detected" => Ok(Self::NoForegroundSubjectDetected), + "format_not_supported" => Ok(Self::FormatNotSupported), + "keep_alive_elapsed" => Ok(Self::KeepAliveElapsed), + "not_yet_implemented" => Ok(Self::NotYetImplemented), + "retryable_worker_error" => Ok(Self::RetryableWorkerError), + "model_rules_violation" => Ok(Self::ModelRulesViolation), + "rule_bans_user_image" => Ok(Self::RuleBansUserImage), + "rule_bans_user_image_with_faces" => Ok(Self::RuleBansUserImageWithFaces), + "rule_bans_user_text_prompt" => Ok(Self::RuleBansUserTextPrompt), + "rule_bans_user_content" => Ok(Self::RuleBansUserContent), + "rule_bans_generated_video" => Ok(Self::RuleBansGeneratedVideo), + "rule_bans_generated_audio" => Ok(Self::RuleBansGeneratedAudio), + "rule_bans_generated_content" => Ok(Self::RuleBansGeneratedContent), + "filesize_too_large" => Ok(Self::FilesizeTooLarge), + "image_dimensions_too_small" => Ok(Self::ImageDimensionsTooSmall), + "image_dimensions_too_large" => Ok(Self::ImageDimensionsTooLarge), + "generation_failed" => Ok(Self::GenerationFailed), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::FaceNotDetected, + Self::NoForegroundSubjectDetected, + Self::FormatNotSupported, + Self::KeepAliveElapsed, + Self::NotYetImplemented, + Self::RetryableWorkerError, + Self::ModelRulesViolation, + Self::RuleBansUserImage, + Self::RuleBansUserImageWithFaces, + Self::RuleBansUserTextPrompt, + Self::RuleBansUserContent, + Self::RuleBansGeneratedVideo, + Self::RuleBansGeneratedAudio, + Self::RuleBansGeneratedContent, + Self::FilesizeTooLarge, + Self::ImageDimensionsTooSmall, + Self::ImageDimensionsTooLarge, + Self::GenerationFailed, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::frontend_failure_category::FrontendFailureCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(FrontendFailureCategory::FaceNotDetected, "face_not_detected"); + assert_serialization(FrontendFailureCategory::NoForegroundSubjectDetected, "no_foreground_subject_detected"); + assert_serialization(FrontendFailureCategory::FormatNotSupported, "format_not_supported"); + assert_serialization(FrontendFailureCategory::KeepAliveElapsed, "keep_alive_elapsed"); + assert_serialization(FrontendFailureCategory::NotYetImplemented, "not_yet_implemented"); + assert_serialization(FrontendFailureCategory::RetryableWorkerError, "retryable_worker_error"); + assert_serialization(FrontendFailureCategory::ModelRulesViolation, "model_rules_violation"); + assert_serialization(FrontendFailureCategory::RuleBansUserImage, "rule_bans_user_image"); + assert_serialization(FrontendFailureCategory::RuleBansUserImageWithFaces, "rule_bans_user_image_with_faces"); + assert_serialization(FrontendFailureCategory::RuleBansUserTextPrompt, "rule_bans_user_text_prompt"); + assert_serialization(FrontendFailureCategory::RuleBansUserContent, "rule_bans_user_content"); + assert_serialization(FrontendFailureCategory::RuleBansGeneratedVideo, "rule_bans_generated_video"); + assert_serialization(FrontendFailureCategory::RuleBansGeneratedAudio, "rule_bans_generated_audio"); + assert_serialization(FrontendFailureCategory::RuleBansGeneratedContent, "rule_bans_generated_content"); + assert_serialization(FrontendFailureCategory::FilesizeTooLarge, "filesize_too_large"); + assert_serialization(FrontendFailureCategory::ImageDimensionsTooSmall, "image_dimensions_too_small"); + assert_serialization(FrontendFailureCategory::ImageDimensionsTooLarge, "image_dimensions_too_large"); + assert_serialization(FrontendFailureCategory::GenerationFailed, "generation_failed"); + } + + #[test] + fn to_str() { + assert_eq!(FrontendFailureCategory::FaceNotDetected.to_str(), "face_not_detected"); + assert_eq!(FrontendFailureCategory::NoForegroundSubjectDetected.to_str(), "no_foreground_subject_detected"); + assert_eq!(FrontendFailureCategory::FormatNotSupported.to_str(), "format_not_supported"); + assert_eq!(FrontendFailureCategory::KeepAliveElapsed.to_str(), "keep_alive_elapsed"); + assert_eq!(FrontendFailureCategory::NotYetImplemented.to_str(), "not_yet_implemented"); + assert_eq!(FrontendFailureCategory::RetryableWorkerError.to_str(), "retryable_worker_error"); + assert_eq!(FrontendFailureCategory::ModelRulesViolation.to_str(), "model_rules_violation"); + assert_eq!(FrontendFailureCategory::RuleBansUserImage.to_str(), "rule_bans_user_image"); + assert_eq!(FrontendFailureCategory::RuleBansUserImageWithFaces.to_str(), "rule_bans_user_image_with_faces"); + assert_eq!(FrontendFailureCategory::RuleBansUserTextPrompt.to_str(), "rule_bans_user_text_prompt"); + assert_eq!(FrontendFailureCategory::RuleBansUserContent.to_str(), "rule_bans_user_content"); + assert_eq!(FrontendFailureCategory::RuleBansGeneratedVideo.to_str(), "rule_bans_generated_video"); + assert_eq!(FrontendFailureCategory::RuleBansGeneratedAudio.to_str(), "rule_bans_generated_audio"); + assert_eq!(FrontendFailureCategory::RuleBansGeneratedContent.to_str(), "rule_bans_generated_content"); + assert_eq!(FrontendFailureCategory::FilesizeTooLarge.to_str(), "filesize_too_large"); + assert_eq!(FrontendFailureCategory::ImageDimensionsTooSmall.to_str(), "image_dimensions_too_small"); + assert_eq!(FrontendFailureCategory::ImageDimensionsTooLarge.to_str(), "image_dimensions_too_large"); + assert_eq!(FrontendFailureCategory::GenerationFailed.to_str(), "generation_failed"); + } + + #[test] + fn from_str() { + assert_eq!(FrontendFailureCategory::from_str("face_not_detected").unwrap(), FrontendFailureCategory::FaceNotDetected); + assert_eq!(FrontendFailureCategory::from_str("no_foreground_subject_detected").unwrap(), FrontendFailureCategory::NoForegroundSubjectDetected); + assert_eq!(FrontendFailureCategory::from_str("format_not_supported").unwrap(), FrontendFailureCategory::FormatNotSupported); + assert_eq!(FrontendFailureCategory::from_str("keep_alive_elapsed").unwrap(), FrontendFailureCategory::KeepAliveElapsed); + assert_eq!(FrontendFailureCategory::from_str("not_yet_implemented").unwrap(), FrontendFailureCategory::NotYetImplemented); + assert_eq!(FrontendFailureCategory::from_str("retryable_worker_error").unwrap(), FrontendFailureCategory::RetryableWorkerError); + assert_eq!(FrontendFailureCategory::from_str("model_rules_violation").unwrap(), FrontendFailureCategory::ModelRulesViolation); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_user_image").unwrap(), FrontendFailureCategory::RuleBansUserImage); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_user_image_with_faces").unwrap(), FrontendFailureCategory::RuleBansUserImageWithFaces); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_user_text_prompt").unwrap(), FrontendFailureCategory::RuleBansUserTextPrompt); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_user_content").unwrap(), FrontendFailureCategory::RuleBansUserContent); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_generated_video").unwrap(), FrontendFailureCategory::RuleBansGeneratedVideo); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_generated_audio").unwrap(), FrontendFailureCategory::RuleBansGeneratedAudio); + assert_eq!(FrontendFailureCategory::from_str("rule_bans_generated_content").unwrap(), FrontendFailureCategory::RuleBansGeneratedContent); + assert_eq!(FrontendFailureCategory::from_str("filesize_too_large").unwrap(), FrontendFailureCategory::FilesizeTooLarge); + assert_eq!(FrontendFailureCategory::from_str("image_dimensions_too_small").unwrap(), FrontendFailureCategory::ImageDimensionsTooSmall); + assert_eq!(FrontendFailureCategory::from_str("image_dimensions_too_large").unwrap(), FrontendFailureCategory::ImageDimensionsTooLarge); + assert_eq!(FrontendFailureCategory::from_str("generation_failed").unwrap(), FrontendFailureCategory::GenerationFailed); + assert_eq!(FrontendFailureCategory::from_str("invalid_value").is_err(), true); + } + + #[test] + fn all_variants() { + let mut variants = FrontendFailureCategory::all_variants(); + assert_eq!(variants.len(), 18); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::FaceNotDetected)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::NoForegroundSubjectDetected)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::FormatNotSupported)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::KeepAliveElapsed)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::NotYetImplemented)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RetryableWorkerError)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::ModelRulesViolation)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansUserImage)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansUserImageWithFaces)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansUserTextPrompt)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansUserContent)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansGeneratedVideo)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansGeneratedAudio)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::RuleBansGeneratedContent)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::FilesizeTooLarge)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::ImageDimensionsTooSmall)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::ImageDimensionsTooLarge)); + assert_eq!(variants.pop_first(), Some(FrontendFailureCategory::GenerationFailed)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(FrontendFailureCategory::all_variants().len(), FrontendFailureCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in FrontendFailureCategory::all_variants() { + assert_eq!(variant, FrontendFailureCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, FrontendFailureCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, FrontendFailureCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + /// The database column is VARCHAR(32). Every serialized variant must fit. + #[test] + fn max_serialization_length() { + const MAX_LENGTH: usize = 32; + for variant in FrontendFailureCategory::all_variants() { + let serialized = variant.to_str(); + assert!( + serialized.len() <= MAX_LENGTH, + "{:?} serializes to {:?} ({} chars), exceeds VARCHAR({}) limit", + variant, serialized, serialized.len(), MAX_LENGTH, + ); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_category.rs new file mode 100644 index 00000000..85a82cc1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_category.rs @@ -0,0 +1,302 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `inference_category`. +/// +/// Our "generic inference" pipeline supports a wide variety of ML models and other media. +/// Each "category" of inference is identified by the following enum variants. +/// These types are present in the HTTP API and database columns as serialized here. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize, Default)] +pub enum InferenceCategory { + /// Deprecate this field !!! + /// We should drain all jobs from using this database field, then remove it. + #[deprecated(note = "NB(bt,2024-09-05): The frontend still needs this")] + #[serde(rename = "deprecated_field")] + DeprecatedField, + + /// Facial lipsync animation (eg. SadTalker, Wav2Lip, FaceFusion) + #[serde(rename = "lipsync_animation")] + #[default] + LipsyncAnimation, + + /// FakeYou's text to speech (eg. Tacotron2) + #[serde(rename = "text_to_speech")] + TextToSpeech, + + /// FakeYou's voice conversion (eg. svc, rvc) + #[serde(rename = "voice_conversion")] + VoiceConversion, + + /// Image generation (eg. Stable Diffusion 1.5), FAL-powered image generation, etc. + #[serde(rename = "image_generation")] + ImageGeneration, + + /// FAL-powered video generation + /// (Also Seedance2-Pro.com) + #[serde(rename = "video_generation")] + VideoGeneration, + + /// Audio generation (eg. Suno music, Seed Audio) + #[serde(rename = "audio_generation")] + AudioGeneration, + + /// FAL-powered 3D object generation + #[serde(rename = "object_generation")] + ObjectGeneration, + + /// Gaussian Splat generation (eg. World Labs Marble) + #[serde(rename = "splat_generation")] + SplatGeneration, + + /// Character generation (eg. Kinovi/Seedance2Pro characters) + #[serde(rename = "character_generation")] + CharacterGeneration, + + /// FAL-powered image background removal + #[serde(rename = "background_removal")] + BackgroundRemoval, + + /// Turn video into animation data with mocap processing (eg. Mocapnet). + #[serde(rename = "mocap")] + Mocap, + + /// ComfyUI workflows + /// This is what powers Storyteller Studio! + #[serde(rename = "workflow")] + Workflow, + + /// FBX to GLTF/GLB. + /// Still supported, but few people will use it. + #[serde(rename = "format_conversion")] + FormatConversion, + + /// Live portrait + #[serde(rename = "live_portrait")] + LivePortrait, + + #[serde(rename="seed_vc")] + SeedVc, + + /// DEPRECATED. Do not use. + /// This was for ReRenderAVideo, which we never productionized. + #[deprecated(note = "This was for ReRenderAVideo, which we never productionized.")] + #[serde(rename = "video_filter")] + VideoFilter, + + /// DEPRECATED. Bevy engine serverside rendering. + #[deprecated(note = "This was for Bevy engine's server side rendering.")] + #[serde(rename = "convert_bvh_to_workflow")] + ConvertBvhToWorkflow, + + #[serde(rename = "f5_tts")] + F5TTS, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceCategory); + +/// NB: Legacy API for older code. +impl InferenceCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::DeprecatedField => "deprecated_field", + Self::LipsyncAnimation => "lipsync_animation", + Self::TextToSpeech => "text_to_speech", + Self::VoiceConversion => "voice_conversion", + Self::ImageGeneration => "image_generation", + Self::VideoGeneration => "video_generation", + Self::AudioGeneration => "audio_generation", + Self::ObjectGeneration => "object_generation", + Self::SplatGeneration => "splat_generation", + Self::CharacterGeneration => "character_generation", + Self::BackgroundRemoval => "background_removal", + Self::Mocap => "mocap", + Self::Workflow => "workflow", + Self::F5TTS => "f5_tts", + Self::FormatConversion => "format_conversion", + Self::LivePortrait => "live_portrait", + Self::SeedVc => "seed_vc", + Self::VideoFilter => "video_filter", + Self::ConvertBvhToWorkflow => "convert_bvh_to_workflow", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "deprecated_field" => Ok(Self::DeprecatedField), + "lipsync_animation" => Ok(Self::LipsyncAnimation), + "text_to_speech" => Ok(Self::TextToSpeech), + "voice_conversion" => Ok(Self::VoiceConversion), + "image_generation" => Ok(Self::ImageGeneration), + "video_generation" => Ok(Self::VideoGeneration), + "audio_generation" => Ok(Self::AudioGeneration), + "object_generation" => Ok(Self::ObjectGeneration), + "splat_generation" => Ok(Self::SplatGeneration), + "character_generation" => Ok(Self::CharacterGeneration), + "background_removal" => Ok(Self::BackgroundRemoval), + "f5_tts" => Ok(Self::F5TTS), + "mocap" => Ok(Self::Mocap), + "workflow" => Ok(Self::Workflow), + "format_conversion" => Ok(Self::FormatConversion), + "live_portrait" => Ok(Self::LivePortrait), + "seed_vc" => Ok(Self::SeedVc), + "video_filter" => Ok(Self::VideoFilter), + "convert_bvh_to_workflow" => Ok(Self::ConvertBvhToWorkflow), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::DeprecatedField, + Self::LipsyncAnimation, + Self::TextToSpeech, + Self::VoiceConversion, + Self::ImageGeneration, + Self::ObjectGeneration, + Self::SplatGeneration, + Self::CharacterGeneration, + Self::VideoGeneration, + Self::AudioGeneration, + Self::BackgroundRemoval, + Self::Mocap, + Self::F5TTS, + Self::SeedVc, + Self::Workflow, + Self::FormatConversion, + Self::LivePortrait, + Self::VideoFilter, + Self::ConvertBvhToWorkflow, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_category::InferenceCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(InferenceCategory::DeprecatedField, "deprecated_field"); + assert_serialization(InferenceCategory::LipsyncAnimation, "lipsync_animation"); + assert_serialization(InferenceCategory::TextToSpeech, "text_to_speech"); + assert_serialization(InferenceCategory::VoiceConversion, "voice_conversion"); + assert_serialization(InferenceCategory::ImageGeneration, "image_generation"); + assert_serialization(InferenceCategory::VideoGeneration, "video_generation"); + assert_serialization(InferenceCategory::AudioGeneration, "audio_generation"); + assert_serialization(InferenceCategory::ObjectGeneration, "object_generation"); + assert_serialization(InferenceCategory::SplatGeneration, "splat_generation"); + assert_serialization(InferenceCategory::CharacterGeneration, "character_generation"); + assert_serialization(InferenceCategory::BackgroundRemoval, "background_removal"); + assert_serialization(InferenceCategory::Mocap, "mocap"); + assert_serialization(InferenceCategory::F5TTS, "f5_tts"); + assert_serialization(InferenceCategory::SeedVc, "seed_vc"); + assert_serialization(InferenceCategory::Workflow, "workflow"); + assert_serialization(InferenceCategory::FormatConversion, "format_conversion"); + assert_serialization(InferenceCategory::LivePortrait, "live_portrait"); + assert_serialization(InferenceCategory::VideoFilter, "video_filter"); + assert_serialization(InferenceCategory::ConvertBvhToWorkflow, "convert_bvh_to_workflow"); + } + + #[test] + fn to_str() { + assert_eq!(InferenceCategory::DeprecatedField.to_str(), "deprecated_field"); + assert_eq!(InferenceCategory::LipsyncAnimation.to_str(), "lipsync_animation"); + assert_eq!(InferenceCategory::TextToSpeech.to_str(), "text_to_speech"); + assert_eq!(InferenceCategory::VoiceConversion.to_str(), "voice_conversion"); + assert_eq!(InferenceCategory::ImageGeneration.to_str(), "image_generation"); + assert_eq!(InferenceCategory::VideoGeneration.to_str(), "video_generation"); + assert_eq!(InferenceCategory::AudioGeneration.to_str(), "audio_generation"); + assert_eq!(InferenceCategory::ObjectGeneration.to_str(), "object_generation"); + assert_eq!(InferenceCategory::SplatGeneration.to_str(), "splat_generation"); + assert_eq!(InferenceCategory::CharacterGeneration.to_str(), "character_generation"); + assert_eq!(InferenceCategory::BackgroundRemoval.to_str(), "background_removal"); + assert_eq!(InferenceCategory::F5TTS.to_str(), "f5_tts"); + assert_eq!(InferenceCategory::SeedVc.to_str(), "seed_vc"); + assert_eq!(InferenceCategory::Mocap.to_str(), "mocap"); + assert_eq!(InferenceCategory::Workflow.to_str(), "workflow"); + assert_eq!(InferenceCategory::FormatConversion.to_str(), "format_conversion"); + assert_eq!(InferenceCategory::LivePortrait.to_str(), "live_portrait"); + assert_eq!(InferenceCategory::VideoFilter.to_str(), "video_filter"); + assert_eq!(InferenceCategory::ConvertBvhToWorkflow.to_str(), "convert_bvh_to_workflow"); + } + + #[test] + fn from_str() { + assert_eq!(InferenceCategory::from_str("deprecated_field").unwrap(), InferenceCategory::DeprecatedField); + assert_eq!(InferenceCategory::from_str("lipsync_animation").unwrap(), InferenceCategory::LipsyncAnimation); + assert_eq!(InferenceCategory::from_str("text_to_speech").unwrap(), InferenceCategory::TextToSpeech); + assert_eq!(InferenceCategory::from_str("voice_conversion").unwrap(), InferenceCategory::VoiceConversion); + assert_eq!(InferenceCategory::from_str("image_generation").unwrap(), InferenceCategory::ImageGeneration); + assert_eq!(InferenceCategory::from_str("video_generation").unwrap(), InferenceCategory::VideoGeneration); + assert_eq!(InferenceCategory::from_str("audio_generation").unwrap(), InferenceCategory::AudioGeneration); + assert_eq!(InferenceCategory::from_str("object_generation").unwrap(), InferenceCategory::ObjectGeneration); + assert_eq!(InferenceCategory::from_str("splat_generation").unwrap(), InferenceCategory::SplatGeneration); + assert_eq!(InferenceCategory::from_str("character_generation").unwrap(), InferenceCategory::CharacterGeneration); + assert_eq!(InferenceCategory::from_str("background_removal").unwrap(), InferenceCategory::BackgroundRemoval); + assert_eq!(InferenceCategory::from_str("f5_tts").unwrap(), InferenceCategory::F5TTS); + assert_eq!(InferenceCategory::from_str("seed_vc").unwrap(), InferenceCategory::SeedVc); + assert_eq!(InferenceCategory::from_str("mocap").unwrap(), InferenceCategory::Mocap); + assert_eq!(InferenceCategory::from_str("workflow").unwrap(), InferenceCategory::Workflow); + assert_eq!(InferenceCategory::from_str("format_conversion").unwrap(), InferenceCategory::FormatConversion); + assert_eq!(InferenceCategory::from_str("live_portrait").unwrap(), InferenceCategory::LivePortrait); + assert_eq!(InferenceCategory::from_str("video_filter").unwrap(), InferenceCategory::VideoFilter); + assert_eq!(InferenceCategory::from_str("convert_bvh_to_workflow").unwrap(), InferenceCategory::ConvertBvhToWorkflow); + } + + #[test] + fn all_variants() { + // Static check + const EXPECTED_COUNT : usize = 19; + + assert_eq!(InferenceCategory::all_variants().len(), EXPECTED_COUNT); + assert_eq!(InferenceCategory::iter().len(), EXPECTED_COUNT); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(InferenceCategory::all_variants().len(), InferenceCategory::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(InferenceCategory::all_variants().len(), InferenceCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in InferenceCategory::all_variants() { + assert_eq!(variant, InferenceCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, InferenceCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, InferenceCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in InferenceCategory::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_input_source_token_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_input_source_token_type.rs new file mode 100644 index 00000000..468c57a2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_input_source_token_type.rs @@ -0,0 +1,86 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `maybe_input_source_token`. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum InferenceInputSourceTokenType { + #[serde(rename = "media_file")] + MediaFile, + #[serde(rename = "media_upload")] + MediaUpload, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceInputSourceTokenType); + +/// NB: Legacy API for older code. +impl InferenceInputSourceTokenType { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaFile => "media_file", + Self::MediaUpload => "media_upload", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_file" => Ok(Self::MediaFile), + "media_upload" => Ok(Self::MediaUpload), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + InferenceInputSourceTokenType::MediaFile, + InferenceInputSourceTokenType::MediaUpload, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_input_source_token_type::InferenceInputSourceTokenType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(InferenceInputSourceTokenType::MediaFile, "media_file"); + assert_serialization(InferenceInputSourceTokenType::MediaUpload, "media_upload"); + } + + #[test] + fn to_str() { + assert_eq!(InferenceInputSourceTokenType::MediaFile.to_str(), "media_file"); + assert_eq!(InferenceInputSourceTokenType::MediaUpload.to_str(), "media_upload"); + } + + #[test] + fn from_str() { + assert_eq!(InferenceInputSourceTokenType::from_str("media_file").unwrap(), InferenceInputSourceTokenType::MediaFile); + assert_eq!(InferenceInputSourceTokenType::from_str("media_upload").unwrap(), InferenceInputSourceTokenType::MediaUpload); + } + + #[test] + fn all_variants() { + // Static check + let mut variants = InferenceInputSourceTokenType::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(InferenceInputSourceTokenType::MediaFile)); + assert_eq!(variants.pop_first(), Some(InferenceInputSourceTokenType::MediaUpload)); + assert_eq!(variants.pop_first(), None); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(InferenceInputSourceTokenType::all_variants().len(), InferenceInputSourceTokenType::iter().len()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_external_third_party.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_external_third_party.rs new file mode 100644 index 00000000..8c956784 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_external_third_party.rs @@ -0,0 +1,183 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(16)` field `maybe_external_third_party`. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize, Default)] +#[serde(rename_all = "snake_case")] +pub enum InferenceJobExternalThirdParty { + /// Beeble jobs + #[serde(rename = "beeble")] + Beeble, + + /// Fal jobs + #[serde(rename = "fal")] + #[default] + Fal, + + /// GmiCloud jobs + #[serde(rename = "gmicloud")] + GmiCloud, + + /// Grok (xAI) API jobs + #[serde(rename = "grok_api")] + GrokApi, + + /// Seedance 2 Pro jobs + #[serde(rename = "seedance2pro")] + Seedance2Pro, + + /// Seedance 2 Pro Alt jobs + #[serde(rename = "seedance2pro_alt")] + Seedance2ProAlt, + + /// Seedance 2 Pro BytePlus Ultra jobs + #[serde(rename = "seedance2pro_bpu")] + Seedance2ProBytePlusUltra, + + /// World Labs jobs + #[serde(rename = "worldlabs")] + Worldlabs, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceJobExternalThirdParty); + +/// NB: Legacy API for older code. +impl InferenceJobExternalThirdParty { + pub fn to_str(&self) -> &'static str { + match self { + Self::Beeble => "beeble", + Self::Fal => "fal", + Self::GmiCloud => "gmicloud", + Self::GrokApi => "grok_api", + Self::Seedance2Pro => "seedance2pro", + Self::Seedance2ProAlt => "seedance2pro_alt", + Self::Seedance2ProBytePlusUltra => "seedance2pro_bpu", + Self::Worldlabs => "worldlabs", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "beeble" => Ok(Self::Beeble), + "fal" => Ok(Self::Fal), + "gmicloud" => Ok(Self::GmiCloud), + "grok_api" => Ok(Self::GrokApi), + "seedance2pro" => Ok(Self::Seedance2Pro), + "seedance2pro_alt" => Ok(Self::Seedance2ProAlt), + "seedance2pro_bpu" => Ok(Self::Seedance2ProBytePlusUltra), + "worldlabs" => Ok(Self::Worldlabs), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Beeble, + Self::Fal, + Self::GmiCloud, + Self::GrokApi, + Self::Seedance2Pro, + Self::Seedance2ProAlt, + Self::Seedance2ProBytePlusUltra, + Self::Worldlabs, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_job_external_third_party::InferenceJobExternalThirdParty; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(InferenceJobExternalThirdParty::Beeble, "beeble"); + assert_serialization(InferenceJobExternalThirdParty::Fal, "fal"); + assert_serialization(InferenceJobExternalThirdParty::GmiCloud, "gmicloud"); + assert_serialization(InferenceJobExternalThirdParty::GrokApi, "grok_api"); + assert_serialization(InferenceJobExternalThirdParty::Seedance2Pro, "seedance2pro"); + assert_serialization(InferenceJobExternalThirdParty::Seedance2ProAlt, "seedance2pro_alt"); + assert_serialization(InferenceJobExternalThirdParty::Seedance2ProBytePlusUltra, "seedance2pro_bpu"); + assert_serialization(InferenceJobExternalThirdParty::Worldlabs, "worldlabs"); + } + + #[test] + fn to_str() { + assert_eq!(InferenceJobExternalThirdParty::Beeble.to_str(), "beeble"); + assert_eq!(InferenceJobExternalThirdParty::Fal.to_str(), "fal"); + assert_eq!(InferenceJobExternalThirdParty::GmiCloud.to_str(), "gmicloud"); + assert_eq!(InferenceJobExternalThirdParty::GrokApi.to_str(), "grok_api"); + assert_eq!(InferenceJobExternalThirdParty::Seedance2Pro.to_str(), "seedance2pro"); + assert_eq!(InferenceJobExternalThirdParty::Seedance2ProAlt.to_str(), "seedance2pro_alt"); + assert_eq!(InferenceJobExternalThirdParty::Seedance2ProBytePlusUltra.to_str(), "seedance2pro_bpu"); + assert_eq!(InferenceJobExternalThirdParty::Worldlabs.to_str(), "worldlabs"); + } + + #[test] + fn from_str() { + assert_eq!(InferenceJobExternalThirdParty::from_str("beeble").unwrap(), InferenceJobExternalThirdParty::Beeble); + assert_eq!(InferenceJobExternalThirdParty::from_str("fal").unwrap(), InferenceJobExternalThirdParty::Fal); + assert_eq!(InferenceJobExternalThirdParty::from_str("gmicloud").unwrap(), InferenceJobExternalThirdParty::GmiCloud); + assert_eq!(InferenceJobExternalThirdParty::from_str("grok_api").unwrap(), InferenceJobExternalThirdParty::GrokApi); + assert_eq!(InferenceJobExternalThirdParty::from_str("seedance2pro").unwrap(), InferenceJobExternalThirdParty::Seedance2Pro); + assert_eq!(InferenceJobExternalThirdParty::from_str("seedance2pro_alt").unwrap(), InferenceJobExternalThirdParty::Seedance2ProAlt); + assert_eq!(InferenceJobExternalThirdParty::from_str("seedance2pro_bpu").unwrap(), InferenceJobExternalThirdParty::Seedance2ProBytePlusUltra); + assert_eq!(InferenceJobExternalThirdParty::from_str("worldlabs").unwrap(), InferenceJobExternalThirdParty::Worldlabs); + } + + #[test] + fn all_variants() { + // Static check + const EXPECTED_COUNT : usize = 8; + + assert_eq!(InferenceJobExternalThirdParty::all_variants().len(), EXPECTED_COUNT); + assert_eq!(InferenceJobExternalThirdParty::iter().len(), EXPECTED_COUNT); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(InferenceJobExternalThirdParty::all_variants().len(), InferenceJobExternalThirdParty::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(InferenceJobExternalThirdParty::all_variants().len(), InferenceJobExternalThirdParty::iter().len()); + } + + #[test] + fn round_trip() { + for variant in InferenceJobExternalThirdParty::all_variants() { + assert_eq!(variant, InferenceJobExternalThirdParty::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, InferenceJobExternalThirdParty::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, InferenceJobExternalThirdParty::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in InferenceJobExternalThirdParty::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_product_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_product_category.rs new file mode 100644 index 00000000..15830171 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_product_category.rs @@ -0,0 +1,485 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `product_category`. +/// +/// This is a user-facing and analytics-facing column that describes what product area the job +/// is attributed to. For example, this will help us separate "video style transfer" from +/// "storyteller studio" and also separate "live portrait" from "webcam live portrait". +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize, Default)] +#[serde(rename_all = "snake_case")] +pub enum InferenceJobProductCategory { + // =============== DOWNLOAD =============== + + /// Download: GptSoVits + #[default] + DownloadGptSoVits, + + // =============== FAL =============== + + FalImage, + FalVideo, + FalAudio, + /// Fal: 3D Object Generation + FalObject, + FalBgRemoval, + + // =============== GMICLOUD =============== + + #[serde(rename = "gmicloud_video")] + GmiCloudVideo, + + // =============== GROK (xAI) =============== + + #[serde(rename = "grok_api_video")] + GrokApiVideo, + + // =============== BEEBLE =============== + + #[serde(rename = "beeble_video")] + BeebleVideo, + + // =============== SEEDANCE 2 PRO =============== + + #[serde(rename = "seedance2pro_video")] + Seedance2ProVideo, + + #[serde(rename = "seedance2pro_character")] + Seedance2ProCharacter, + + /// Seedance 2 Pro / Kinovi: Midjourney image generation. + #[serde(rename = "seedance2pro_image")] + Seedance2ProImage, + + /// Seedance 2 Pro / Kinovi: Suno audio generation. + #[serde(rename = "seedance2pro_audio")] + Seedance2ProAudio, + + // =============== SEEDANCE 2 PRO ALT =============== + + #[serde(rename = "seedance2pro_video_alt")] + Seedance2ProVideoAlt, + + // =============== SEEDANCE 2 PRO BYTEPLUS ULTRA =============== + + #[serde(rename = "seedance2pro_video_bpu")] + Seedance2ProVideoBytePlusUltra, + + /// Seedance 2 Pro / Kinovi (BytePlus Ultra account): image generation. + #[serde(rename = "seedance2pro_image_bpu")] + Seedance2ProImageBytePlusUltra, + + // =============== WORLD LABS =============== + + /// World Labs: Gaussian Splat Generation + #[serde(rename = "worldlabs_splat")] + WorldlabsSplat, + + // =============== TEXT TO SPEECH =============== + + /// TTS: GptSoVits + TtsGptSoVits, + + /// TTS: F5Tts (Zero Shot) + TtsF5, + + /// TTS: StyleTts2 (Zero Shot) + TtsStyleTts2, + + /// TTS: Tacotron2 + TtsTacotron2, + + // =============== VOICE CONVERSION =============== + + /// Voice Conversion: RVC v2 + VcRvc2, + + /// Voice Conversion: SoVitsSvc + VcSvc, + + VcSeedVc, // Ugh + + // =============== VIDEO =============== + + /// Video: Face Fusion (Lipsync) + VidLipsyncFaceFusion, + + /// Video: Sad Talker (Lipsync) + VidLipsyncSadTalker, + + /// Live Portrait (normal interface) + VidLivePortrait, + + /// Live Portrait (webcam interface) + VidLivePortraitWebcam, + + /// Video: Studio + VidStudio, + + /// Video: Studio Gen 2 + VidStudioGen2, + + /// Video: Style Transfer + VidStyleTransfer, + + // =============== DEPRECATED =============== + + /// Lipsync: Face Fusion + #[deprecated(note = "Use `VidLipsyncFaceFusion` instead")] + LipsyncFaceFusion, + + /// Lipsync: SadTalker + #[deprecated(note = "Use `VidLipsyncSadTalker` instead")] + LipsyncSadTalker, + + /// Live Portrait (normal interface) + #[deprecated(note = "Use `VidLivePortrait` instead")] + LivePortrait, + + /// Live Portrait (webcam interface) + #[deprecated(note = "Use `VidLivePortraitWebcam` instead")] + LivePortraitWebcam, + + /// Stable Diffusion (deprecated) + #[deprecated(note = "unused")] + StableDiffusion, + + /// Storyteller Studio + #[deprecated(note = "Use `VidStudio` instead")] + Studio, + + /// Lipsync: Face Fusion + #[deprecated(note = "Use `VidLipsyncFaceFusion` instead")] + VidFaceFusion, + + /// Video Style Transfer + #[deprecated(note = "Use `VidStyleTransfer` instead")] + Vst, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceJobProductCategory); + +/// NB: Legacy API for older code. +impl InferenceJobProductCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::DownloadGptSoVits => "download_gpt_so_vits", + Self::FalImage => "fal_image", + Self::FalVideo => "fal_video", + Self::FalAudio => "fal_audio", + Self::FalObject => "fal_object", + Self::FalBgRemoval => "fal_bg_removal", + Self::GmiCloudVideo => "gmicloud_video", + Self::GrokApiVideo => "grok_api_video", + Self::BeebleVideo => "beeble_video", + Self::Seedance2ProVideo => "seedance2pro_video", + Self::Seedance2ProCharacter => "seedance2pro_character", + Self::Seedance2ProImage => "seedance2pro_image", + Self::Seedance2ProAudio => "seedance2pro_audio", + Self::Seedance2ProVideoAlt => "seedance2pro_video_alt", + Self::Seedance2ProVideoBytePlusUltra => "seedance2pro_video_bpu", + Self::Seedance2ProImageBytePlusUltra => "seedance2pro_image_bpu", + Self::WorldlabsSplat => "worldlabs_splat", + Self::TtsGptSoVits => "tts_gpt_so_vits", + Self::TtsStyleTts2 => "tts_style_tts2", + Self::TtsTacotron2 => "tts_tacotron2", + Self::TtsF5 => "tts_f5", + Self::VcSvc => "vc_svc", + Self::VcRvc2 => "vc_rvc2", + Self::VcSeedVc => "vc_seed_vc", + Self::VidLipsyncFaceFusion => "vid_lipsync_face_fusion", + Self::VidLipsyncSadTalker => "vid_lipsync_sad_talker", + Self::VidLivePortrait => "vid_live_portrait", + Self::VidLivePortraitWebcam => "vid_live_portrait_webcam", + Self::VidStudio => "vid_studio", + Self::VidStudioGen2 => "vid_studio_gen2", + Self::VidStyleTransfer => "vid_style_transfer", + Self::LipsyncFaceFusion => "lipsync_face_fusion", + Self::LipsyncSadTalker => "lipsync_sad_talker", + Self::LivePortrait => "live_portrait", + Self::LivePortraitWebcam => "live_portrait_webcam", + Self::StableDiffusion => "stable_diffusion", + Self::Studio => "studio", + Self::VidFaceFusion => "vid_face_fusion", + Self::Vst => "vst", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "download_gpt_so_vits" => Ok(Self::DownloadGptSoVits), + "fal_image" => Ok(Self::FalImage), + "fal_video" => Ok(Self::FalVideo), + "fal_audio" => Ok(Self::FalAudio), + "fal_object" => Ok(Self::FalObject), + "fal_bg_removal" => Ok(Self::FalBgRemoval), + "gmicloud_video" => Ok(Self::GmiCloudVideo), + "grok_api_video" => Ok(Self::GrokApiVideo), + "beeble_video" => Ok(Self::BeebleVideo), + "seedance2pro_video" => Ok(Self::Seedance2ProVideo), + "seedance2pro_character" => Ok(Self::Seedance2ProCharacter), + "seedance2pro_image" => Ok(Self::Seedance2ProImage), + "seedance2pro_audio" => Ok(Self::Seedance2ProAudio), + "seedance2pro_video_alt" => Ok(Self::Seedance2ProVideoAlt), + "seedance2pro_video_bpu" => Ok(Self::Seedance2ProVideoBytePlusUltra), + "seedance2pro_image_bpu" => Ok(Self::Seedance2ProImageBytePlusUltra), + "worldlabs_splat" => Ok(Self::WorldlabsSplat), + "tts_gpt_so_vits" => Ok(Self::TtsGptSoVits), + "tts_style_tts2" => Ok(Self::TtsStyleTts2), + "tts_tacotron2" => Ok(Self::TtsTacotron2), + "tts_f5" => Ok(Self::TtsF5), + "vc_svc" => Ok(Self::VcSvc), + "vc_rvc2" => Ok(Self::VcRvc2), + "vc_seed_vc" => Ok(Self::VcSeedVc), + "vid_lipsync_face_fusion" => Ok(Self::VidLipsyncFaceFusion), + "vid_lipsync_sad_talker" => Ok(Self::VidLipsyncSadTalker), + "vid_live_portrait" => Ok(Self::VidLivePortrait), + "vid_live_portrait_webcam" => Ok(Self::VidLivePortraitWebcam), + "vid_studio" => Ok(Self::VidStudio), + "vid_studio_gen2" => Ok(Self::VidStudioGen2), + "vid_style_transfer" => Ok(Self::VidStyleTransfer), + "lipsync_face_fusion" => Ok(Self::LipsyncFaceFusion), + "lipsync_sad_talker" => Ok(Self::LipsyncSadTalker), + "live_portrait" => Ok(Self::LivePortrait), + "live_portrait_webcam" => Ok(Self::LivePortraitWebcam), + "stable_diffusion" => Ok(Self::StableDiffusion), + "studio" => Ok(Self::Studio), + "vid_face_fusion" => Ok(Self::VidFaceFusion), + "vst" => Ok(Self::Vst), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::DownloadGptSoVits, + Self::FalImage, + Self::FalVideo, + Self::FalAudio, + Self::FalObject, + Self::FalBgRemoval, + Self::GmiCloudVideo, + Self::GrokApiVideo, + Self::BeebleVideo, + Self::Seedance2ProVideo, + Self::Seedance2ProCharacter, + Self::Seedance2ProImage, + Self::Seedance2ProAudio, + Self::Seedance2ProVideoAlt, + Self::Seedance2ProVideoBytePlusUltra, + Self::Seedance2ProImageBytePlusUltra, + Self::WorldlabsSplat, + Self::TtsGptSoVits, + Self::TtsStyleTts2, + Self::TtsTacotron2, + Self::TtsF5, + Self::VcSeedVc, + Self::VcSvc, + Self::VcRvc2, + Self::VidLipsyncFaceFusion, + Self::VidLipsyncSadTalker, + Self::VidLivePortrait, + Self::VidLivePortraitWebcam, + Self::VidStudio, + Self::VidStudioGen2, + Self::VidStyleTransfer, + Self::LipsyncFaceFusion, + Self::LipsyncSadTalker, + Self::LivePortrait, + Self::LivePortraitWebcam, + Self::StableDiffusion, + Self::Studio, + Self::VidFaceFusion, + Self::Vst, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_job_product_category::InferenceJobProductCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(InferenceJobProductCategory::DownloadGptSoVits, "download_gpt_so_vits"); + assert_serialization(InferenceJobProductCategory::FalImage, "fal_image"); + assert_serialization(InferenceJobProductCategory::FalVideo, "fal_video"); + assert_serialization(InferenceJobProductCategory::FalAudio, "fal_audio"); + assert_serialization(InferenceJobProductCategory::FalObject, "fal_object"); + assert_serialization(InferenceJobProductCategory::FalBgRemoval, "fal_bg_removal"); + assert_serialization(InferenceJobProductCategory::GmiCloudVideo, "gmicloud_video"); + assert_serialization(InferenceJobProductCategory::GrokApiVideo, "grok_api_video"); + assert_serialization(InferenceJobProductCategory::BeebleVideo, "beeble_video"); + assert_serialization(InferenceJobProductCategory::Seedance2ProVideo, "seedance2pro_video"); + assert_serialization(InferenceJobProductCategory::Seedance2ProCharacter, "seedance2pro_character"); + assert_serialization(InferenceJobProductCategory::Seedance2ProImage, "seedance2pro_image"); + assert_serialization(InferenceJobProductCategory::Seedance2ProAudio, "seedance2pro_audio"); + assert_serialization(InferenceJobProductCategory::Seedance2ProVideoAlt, "seedance2pro_video_alt"); + assert_serialization(InferenceJobProductCategory::Seedance2ProVideoBytePlusUltra, "seedance2pro_video_bpu"); + assert_serialization(InferenceJobProductCategory::Seedance2ProImageBytePlusUltra, "seedance2pro_image_bpu"); + assert_serialization(InferenceJobProductCategory::WorldlabsSplat, "worldlabs_splat"); + assert_serialization(InferenceJobProductCategory::TtsGptSoVits, "tts_gpt_so_vits"); + assert_serialization(InferenceJobProductCategory::TtsStyleTts2, "tts_style_tts2"); + assert_serialization(InferenceJobProductCategory::TtsTacotron2, "tts_tacotron2"); + assert_serialization(InferenceJobProductCategory::TtsF5, "tts_f5"); + assert_serialization(InferenceJobProductCategory::VcRvc2, "vc_rvc2"); + assert_serialization(InferenceJobProductCategory::VcSvc, "vc_svc"); + assert_serialization(InferenceJobProductCategory::VcSvc, "vc_svc"); + assert_serialization(InferenceJobProductCategory::VidLipsyncFaceFusion, "vid_lipsync_face_fusion"); + assert_serialization(InferenceJobProductCategory::VidLipsyncSadTalker, "vid_lipsync_sad_talker"); + assert_serialization(InferenceJobProductCategory::VidLivePortrait, "vid_live_portrait"); + assert_serialization(InferenceJobProductCategory::VidLivePortraitWebcam, "vid_live_portrait_webcam"); + assert_serialization(InferenceJobProductCategory::VidStudio, "vid_studio"); + assert_serialization(InferenceJobProductCategory::VidStudioGen2, "vid_studio_gen2"); + assert_serialization(InferenceJobProductCategory::VidStyleTransfer, "vid_style_transfer"); + assert_serialization(InferenceJobProductCategory::LipsyncFaceFusion, "lipsync_face_fusion"); + assert_serialization(InferenceJobProductCategory::LipsyncSadTalker, "lipsync_sad_talker"); + assert_serialization(InferenceJobProductCategory::LivePortrait, "live_portrait"); + assert_serialization(InferenceJobProductCategory::LivePortraitWebcam, "live_portrait_webcam"); + assert_serialization(InferenceJobProductCategory::StableDiffusion, "stable_diffusion"); + assert_serialization(InferenceJobProductCategory::Studio, "studio"); + assert_serialization(InferenceJobProductCategory::VidFaceFusion, "vid_face_fusion"); + assert_serialization(InferenceJobProductCategory::Vst, "vst"); + } + + #[test] + fn to_str() { + assert_eq!(InferenceJobProductCategory::DownloadGptSoVits.to_str(), "download_gpt_so_vits"); + assert_eq!(InferenceJobProductCategory::FalImage.to_str(), "fal_image"); + assert_eq!(InferenceJobProductCategory::FalVideo.to_str(), "fal_video"); + assert_eq!(InferenceJobProductCategory::FalAudio.to_str(), "fal_audio"); + assert_eq!(InferenceJobProductCategory::FalObject.to_str(), "fal_object"); + assert_eq!(InferenceJobProductCategory::FalBgRemoval.to_str(), "fal_bg_removal"); + assert_eq!(InferenceJobProductCategory::GmiCloudVideo.to_str(), "gmicloud_video"); + assert_eq!(InferenceJobProductCategory::GrokApiVideo.to_str(), "grok_api_video"); + assert_eq!(InferenceJobProductCategory::BeebleVideo.to_str(), "beeble_video"); + assert_eq!(InferenceJobProductCategory::Seedance2ProVideo.to_str(), "seedance2pro_video"); + assert_eq!(InferenceJobProductCategory::Seedance2ProCharacter.to_str(), "seedance2pro_character"); + assert_eq!(InferenceJobProductCategory::Seedance2ProImage.to_str(), "seedance2pro_image"); + assert_eq!(InferenceJobProductCategory::Seedance2ProAudio.to_str(), "seedance2pro_audio"); + assert_eq!(InferenceJobProductCategory::Seedance2ProVideoAlt.to_str(), "seedance2pro_video_alt"); + assert_eq!(InferenceJobProductCategory::Seedance2ProVideoBytePlusUltra.to_str(), "seedance2pro_video_bpu"); + assert_eq!(InferenceJobProductCategory::Seedance2ProImageBytePlusUltra.to_str(), "seedance2pro_image_bpu"); + assert_eq!(InferenceJobProductCategory::WorldlabsSplat.to_str(), "worldlabs_splat"); + assert_eq!(InferenceJobProductCategory::TtsGptSoVits.to_str(), "tts_gpt_so_vits"); + assert_eq!(InferenceJobProductCategory::TtsStyleTts2.to_str(), "tts_style_tts2"); + assert_eq!(InferenceJobProductCategory::TtsTacotron2.to_str(), "tts_tacotron2"); + assert_eq!(InferenceJobProductCategory::VcRvc2.to_str(), "vc_rvc2"); + assert_eq!(InferenceJobProductCategory::VcSvc.to_str(), "vc_svc"); + assert_eq!(InferenceJobProductCategory::VcSvc.to_str(), "vc_svc"); + assert_eq!(InferenceJobProductCategory::VidLipsyncFaceFusion.to_str(), "vid_lipsync_face_fusion"); + assert_eq!(InferenceJobProductCategory::VidLipsyncSadTalker.to_str(), "vid_lipsync_sad_talker"); + assert_eq!(InferenceJobProductCategory::VidLivePortrait.to_str(), "vid_live_portrait"); + assert_eq!(InferenceJobProductCategory::VidLivePortraitWebcam.to_str(), "vid_live_portrait_webcam"); + assert_eq!(InferenceJobProductCategory::VidStudio.to_str(), "vid_studio"); + assert_eq!(InferenceJobProductCategory::VidStudioGen2.to_str(), "vid_studio_gen2"); + assert_eq!(InferenceJobProductCategory::VidStyleTransfer.to_str(), "vid_style_transfer"); + assert_eq!(InferenceJobProductCategory::LipsyncFaceFusion.to_str(), "lipsync_face_fusion"); + assert_eq!(InferenceJobProductCategory::LipsyncSadTalker.to_str(), "lipsync_sad_talker"); + assert_eq!(InferenceJobProductCategory::LivePortrait.to_str(), "live_portrait"); + assert_eq!(InferenceJobProductCategory::LivePortraitWebcam.to_str(), "live_portrait_webcam"); + assert_eq!(InferenceJobProductCategory::StableDiffusion.to_str(), "stable_diffusion"); + assert_eq!(InferenceJobProductCategory::Studio.to_str(), "studio"); + assert_eq!(InferenceJobProductCategory::VidFaceFusion.to_str(), "vid_face_fusion"); + assert_eq!(InferenceJobProductCategory::Vst.to_str(), "vst"); + } + + #[test] + fn from_str() { + assert_eq!(InferenceJobProductCategory::from_str("download_gpt_so_vits").unwrap(), InferenceJobProductCategory::DownloadGptSoVits); + assert_eq!(InferenceJobProductCategory::from_str("fal_image").unwrap(), InferenceJobProductCategory::FalImage); + assert_eq!(InferenceJobProductCategory::from_str("fal_video").unwrap(), InferenceJobProductCategory::FalVideo); + assert_eq!(InferenceJobProductCategory::from_str("fal_audio").unwrap(), InferenceJobProductCategory::FalAudio); + assert_eq!(InferenceJobProductCategory::from_str("fal_object").unwrap(), InferenceJobProductCategory::FalObject); + assert_eq!(InferenceJobProductCategory::from_str("fal_bg_removal").unwrap(), InferenceJobProductCategory::FalBgRemoval); + assert_eq!(InferenceJobProductCategory::from_str("gmicloud_video").unwrap(), InferenceJobProductCategory::GmiCloudVideo); + assert_eq!(InferenceJobProductCategory::from_str("grok_api_video").unwrap(), InferenceJobProductCategory::GrokApiVideo); + assert_eq!(InferenceJobProductCategory::from_str("beeble_video").unwrap(), InferenceJobProductCategory::BeebleVideo); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_video").unwrap(), InferenceJobProductCategory::Seedance2ProVideo); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_character").unwrap(), InferenceJobProductCategory::Seedance2ProCharacter); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_image").unwrap(), InferenceJobProductCategory::Seedance2ProImage); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_audio").unwrap(), InferenceJobProductCategory::Seedance2ProAudio); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_video_alt").unwrap(), InferenceJobProductCategory::Seedance2ProVideoAlt); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_video_bpu").unwrap(), InferenceJobProductCategory::Seedance2ProVideoBytePlusUltra); + assert_eq!(InferenceJobProductCategory::from_str("seedance2pro_image_bpu").unwrap(), InferenceJobProductCategory::Seedance2ProImageBytePlusUltra); + assert_eq!(InferenceJobProductCategory::from_str("worldlabs_splat").unwrap(), InferenceJobProductCategory::WorldlabsSplat); + assert_eq!(InferenceJobProductCategory::from_str("tts_gpt_so_vits").unwrap(), InferenceJobProductCategory::TtsGptSoVits); + assert_eq!(InferenceJobProductCategory::from_str("tts_style_tts2").unwrap(), InferenceJobProductCategory::TtsStyleTts2); + assert_eq!(InferenceJobProductCategory::from_str("tts_tacotron2").unwrap(), InferenceJobProductCategory::TtsTacotron2); + assert_eq!(InferenceJobProductCategory::from_str("vc_rvc2").unwrap(), InferenceJobProductCategory::VcRvc2); + assert_eq!(InferenceJobProductCategory::from_str("vc_svc").unwrap(), InferenceJobProductCategory::VcSvc); + assert_eq!(InferenceJobProductCategory::from_str("vc_svc").unwrap(), InferenceJobProductCategory::VcSvc); + assert_eq!(InferenceJobProductCategory::from_str("vid_lipsync_face_fusion").unwrap(), InferenceJobProductCategory::VidLipsyncFaceFusion); + assert_eq!(InferenceJobProductCategory::from_str("vid_lipsync_sad_talker").unwrap(), InferenceJobProductCategory::VidLipsyncSadTalker); + assert_eq!(InferenceJobProductCategory::from_str("vid_live_portrait").unwrap(), InferenceJobProductCategory::VidLivePortrait); + assert_eq!(InferenceJobProductCategory::from_str("vid_live_portrait_webcam").unwrap(), InferenceJobProductCategory::VidLivePortraitWebcam); + assert_eq!(InferenceJobProductCategory::from_str("vid_studio").unwrap(), InferenceJobProductCategory::VidStudio); + assert_eq!(InferenceJobProductCategory::from_str("vid_studio_gen2").unwrap(), InferenceJobProductCategory::VidStudioGen2); + assert_eq!(InferenceJobProductCategory::from_str("vid_style_transfer").unwrap(), InferenceJobProductCategory::VidStyleTransfer); + assert_eq!(InferenceJobProductCategory::from_str("lipsync_face_fusion").unwrap(), InferenceJobProductCategory::LipsyncFaceFusion); + assert_eq!(InferenceJobProductCategory::from_str("lipsync_sad_talker").unwrap(), InferenceJobProductCategory::LipsyncSadTalker); + assert_eq!(InferenceJobProductCategory::from_str("live_portrait").unwrap(), InferenceJobProductCategory::LivePortrait); + assert_eq!(InferenceJobProductCategory::from_str("live_portrait_webcam").unwrap(), InferenceJobProductCategory::LivePortraitWebcam); + assert_eq!(InferenceJobProductCategory::from_str("stable_diffusion").unwrap(), InferenceJobProductCategory::StableDiffusion); + assert_eq!(InferenceJobProductCategory::from_str("studio").unwrap(), InferenceJobProductCategory::Studio); + assert_eq!(InferenceJobProductCategory::from_str("vid_face_fusion").unwrap(), InferenceJobProductCategory::VidFaceFusion); + assert_eq!(InferenceJobProductCategory::from_str("vst").unwrap(), InferenceJobProductCategory::Vst); + } + + #[test] + fn all_variants() { + // Static check + const EXPECTED_COUNT : usize = 39; + + assert_eq!(InferenceJobProductCategory::all_variants().len(), EXPECTED_COUNT); + assert_eq!(InferenceJobProductCategory::iter().len(), EXPECTED_COUNT); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(InferenceJobProductCategory::all_variants().len(), InferenceJobProductCategory::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(InferenceJobProductCategory::all_variants().len(), InferenceJobProductCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in InferenceJobProductCategory::all_variants() { + assert_eq!(variant, InferenceJobProductCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, InferenceJobProductCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, InferenceJobProductCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in InferenceJobProductCategory::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_type.rs new file mode 100644 index 00000000..7e7782d4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_job_type.rs @@ -0,0 +1,401 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `job_type`. +/// +/// TODO(bt,2024-02-01): This will replace "inference_category" and "maybe_model_type" for job control and dispatch, +/// since those mechanisms are overloaded and inconsistent. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize, Default)] +#[serde(rename_all = "snake_case")] +pub enum InferenceJobType { + /// Fal jobs do not run on our job runners. + /// Instead, we receive web hook updates from Fal. + FalQueue, + + /// GmiCloud jobs. We poll for results. + #[serde(rename = "gmicloud_queue")] + GmiCloudQueue, + + /// Grok (xAI) API jobs. We poll for results. + #[serde(rename = "grok_api_queue")] + GrokApiQueue, + + /// Seedance 2 Pro jobs. We poll for results. + #[serde(rename = "seedance2pro_queue")] + Seedance2ProQueue, + + /// Seedance 2 Pro character creation. We poll for results. + #[serde(rename = "seedance2pro_character")] + Seedance2ProCharacter, + + /// Seedance 2 Pro Alt jobs. We poll for results. + #[serde(rename = "seedance2pro_alt_queue")] + Seedance2ProAltQueue, + + /// Seedance 2 Pro BytePlus Ultra jobs. We poll for results. + #[serde(rename = "seedance2pro_bpu_queue")] + Seedance2ProBytePlusUltraQueue, + + /// Beeble jobs. We poll for results. + #[serde(rename = "beeble_queue")] + BeebleQueue, + + /// World Labs jobs. We poll for results. + #[serde(rename = "worldlabs_queue")] + WorldlabsQueue, + + /// Storyteller Studio and Video Style Transfer Jobs (which we may want to split). + /// These run in Comfy. + /// TODO(bt,2024-07-15): We may segregate these two job types in the future + VideoRender, + + /// Live Portrait Jobs. + /// These run in Comfy. + LivePortrait, + + /// Face Fusion Jobs. + /// These run in Comfy. + FaceFusion, + + /// Voice jobs that use GPT-Sovits + GptSovits, + + /// Jobs that run ComfyUI workflows + /// This is actually just for Video Style Transfer and Storyteller Studio. + #[deprecated(note = "Use VideoRender instead.")] + ComfyUi, + + /// Second gen studio + #[serde(rename = "studio_gen2")] + StudioGen2, + + /// Sora GPT 4o image gen + #[serde(rename = "image_gen_api")] + ImageGenApi, + + /// A job that turns "FBX" game engine files into "GLTF" files (Bevy-compatible). + #[serde(rename = "convert_fbx_gltf")] + ConvertFbxToGltf, + + /// Process a video into BVH mocap animation data for game engines + MocapNet, + + /// Jobs that run F5TTS + #[serde(rename = "f5_tts")] + F5TTS, + + /// RVC is a voice conversion model. RVCv2 is the most popular such model currently. + #[serde(rename = "rvc_v2")] + RvcV2, + + /// SadTalker does image-to-video lip-syncing when given an audio file and image. + SadTalker, + + /// so-vits-svc voice conversion. This predates RVCv2. + SoVitsSvc, + + #[serde(rename = "seed_vc")] + SeedVc, + + /// Stable diffusion image generation + StableDiffusion, + + /// StyleTTS2 is a zero shot multi-speaker TTS model. + /// This job type should handle both speaker vector encoding and inference. + #[serde(rename = "styletts2")] + StyleTTS2, + + /// TT2 Text to speech + Tacotron2, + + /// A value we may use in the future for historical jobs + /// (i.e. when we backfill the database column and make it non-nullable) + #[default] + Unknown, + + /// DEPRECATED. DO NOT USE. + /// Job that converts bevy to workflow files + #[deprecated(note = "This was for Bevy engine's server side rendering.")] + #[serde(rename = "bevy_to_workflow")] + BevyToWorkflow, + + #[deprecated(note = "This was for ReRenderAVideo, which we never productionized.")] + /// DEPRECATED. DO NOT USE. + /// Re-render a video is a video style transfer algorithm. We developed code + /// around it, but chose to develop AnimateDiff / ComfyUI support instead. + RerenderAVideo, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceJobType); + +/// NB: Legacy API for older code. +impl InferenceJobType { + pub fn to_str(&self) -> &'static str { + match self { + Self::FalQueue => "fal_queue", + Self::GmiCloudQueue => "gmicloud_queue", + Self::GrokApiQueue => "grok_api_queue", + Self::BeebleQueue => "beeble_queue", + Self::Seedance2ProQueue => "seedance2pro_queue", + Self::Seedance2ProAltQueue => "seedance2pro_alt_queue", + Self::Seedance2ProBytePlusUltraQueue => "seedance2pro_bpu_queue", + Self::Seedance2ProCharacter => "seedance2pro_character", + Self::WorldlabsQueue => "worldlabs_queue", + Self::VideoRender => "video_render", + Self::LivePortrait => "live_portrait", + Self::FaceFusion => "face_fusion", + Self::F5TTS => "f5_tts", + Self::GptSovits => "gpt_sovits", + Self::ComfyUi => "comfy_ui", + Self::StudioGen2 => "studio_gen2", + Self::ImageGenApi => "image_gen_api", + Self::ConvertFbxToGltf => "convert_fbx_gltf", + Self::MocapNet => "mocap_net", + Self::RvcV2 => "rvc_v2", + Self::SadTalker => "sad_talker", + Self::SeedVc => "seed_vc", + Self::SoVitsSvc => "so_vits_svc", + Self::StableDiffusion => "stable_diffusion", + Self::StyleTTS2 => "styletts2", + Self::Tacotron2 => "tacotron2", + Self::Unknown => "unknown", + Self::BevyToWorkflow => "bevy_to_workflow", + Self::RerenderAVideo => "rerender_a_video", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "fal_queue" => Ok(Self::FalQueue), + "gmicloud_queue" => Ok(Self::GmiCloudQueue), + "grok_api_queue" => Ok(Self::GrokApiQueue), + "beeble_queue" => Ok(Self::BeebleQueue), + "seedance2pro_queue" => Ok(Self::Seedance2ProQueue), + "seedance2pro_character" => Ok(Self::Seedance2ProCharacter), + "seedance2pro_alt_queue" => Ok(Self::Seedance2ProAltQueue), + "seedance2pro_bpu_queue" => Ok(Self::Seedance2ProBytePlusUltraQueue), + "worldlabs_queue" => Ok(Self::WorldlabsQueue), + "video_render" => Ok(Self::VideoRender), + "live_portrait" => Ok(Self::LivePortrait), + "face_fusion" => Ok(Self::FaceFusion), + "f5_tts" => Ok(Self::F5TTS), + "gpt_sovits" => Ok(Self::GptSovits), + "comfy_ui" => Ok(Self::ComfyUi), + "studio_gen2" => Ok(Self::StudioGen2), + "image_gen_api" => Ok(Self::ImageGenApi), + "convert_fbx_gltf" => Ok(Self::ConvertFbxToGltf), + "mocap_net" => Ok(Self::MocapNet), + "rvc_v2" => Ok(Self::RvcV2), + "sad_talker" => Ok(Self::SadTalker), + "seed_vc" => Ok(Self::SeedVc), + "so_vits_svc" => Ok(Self::SoVitsSvc), + "stable_diffusion" => Ok(Self::StableDiffusion), + "styletts2" => Ok(Self::StyleTTS2), + "tacotron2" => Ok(Self::Tacotron2), + "unknown" => Ok(Self::Unknown), + "bevy_to_workflow" => Ok(Self::BevyToWorkflow), + "rerender_a_video" => Ok(Self::RerenderAVideo), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::FalQueue, + Self::GmiCloudQueue, + Self::GrokApiQueue, + Self::BeebleQueue, + Self::Seedance2ProQueue, + Self::Seedance2ProCharacter, + Self::Seedance2ProAltQueue, + Self::Seedance2ProBytePlusUltraQueue, + Self::WorldlabsQueue, + Self::VideoRender, + Self::LivePortrait, + Self::FaceFusion, + Self::F5TTS, + Self::GptSovits, + Self::ComfyUi, + Self::StudioGen2, + Self::ImageGenApi, + Self::ConvertFbxToGltf, + Self::MocapNet, + Self::RvcV2, + Self::SadTalker, + Self::SeedVc, + Self::SoVitsSvc, + Self::StableDiffusion, + Self::StyleTTS2, + Self::Tacotron2, + Self::Unknown, + Self::BevyToWorkflow, + Self::RerenderAVideo, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_job_type::InferenceJobType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn default() { + assert_eq!(InferenceJobType::default(), InferenceJobType::Unknown); + } + + #[test] + fn test_serialization() { + assert_serialization(InferenceJobType::FalQueue, "fal_queue"); + assert_serialization(InferenceJobType::GmiCloudQueue, "gmicloud_queue"); + assert_serialization(InferenceJobType::GrokApiQueue, "grok_api_queue"); + assert_serialization(InferenceJobType::BeebleQueue, "beeble_queue"); + assert_serialization(InferenceJobType::Seedance2ProQueue, "seedance2pro_queue"); + assert_serialization(InferenceJobType::Seedance2ProCharacter, "seedance2pro_character"); + assert_serialization(InferenceJobType::Seedance2ProAltQueue, "seedance2pro_alt_queue"); + assert_serialization(InferenceJobType::Seedance2ProBytePlusUltraQueue, "seedance2pro_bpu_queue"); + assert_serialization(InferenceJobType::WorldlabsQueue, "worldlabs_queue"); + assert_serialization(InferenceJobType::VideoRender, "video_render"); + assert_serialization(InferenceJobType::LivePortrait, "live_portrait"); + assert_serialization(InferenceJobType::FaceFusion, "face_fusion"); + assert_serialization(InferenceJobType::F5TTS, "f5_tts"); + assert_serialization(InferenceJobType::GptSovits, "gpt_sovits"); + assert_serialization(InferenceJobType::ComfyUi, "comfy_ui"); + assert_serialization(InferenceJobType::StudioGen2, "studio_gen2"); + assert_serialization(InferenceJobType::ImageGenApi, "image_gen_api"); + assert_serialization(InferenceJobType::ConvertFbxToGltf, "convert_fbx_gltf"); + assert_serialization(InferenceJobType::MocapNet, "mocap_net"); + assert_serialization(InferenceJobType::RvcV2, "rvc_v2"); + assert_serialization(InferenceJobType::SadTalker, "sad_talker"); + assert_serialization(InferenceJobType::SeedVc, "seed_vc"); + assert_serialization(InferenceJobType::SoVitsSvc, "so_vits_svc"); + assert_serialization(InferenceJobType::StableDiffusion, "stable_diffusion"); + assert_serialization(InferenceJobType::StyleTTS2, "styletts2"); + assert_serialization(InferenceJobType::Tacotron2, "tacotron2"); + assert_serialization(InferenceJobType::Unknown, "unknown"); + assert_serialization(InferenceJobType::BevyToWorkflow, "bevy_to_workflow"); + assert_serialization(InferenceJobType::RerenderAVideo, "rerender_a_video"); + } + + #[test] + fn to_str() { + assert_eq!(InferenceJobType::FalQueue.to_str(), "fal_queue"); + assert_eq!(InferenceJobType::GmiCloudQueue.to_str(), "gmicloud_queue"); + assert_eq!(InferenceJobType::GrokApiQueue.to_str(), "grok_api_queue"); + assert_eq!(InferenceJobType::BeebleQueue.to_str(), "beeble_queue"); + assert_eq!(InferenceJobType::Seedance2ProQueue.to_str(), "seedance2pro_queue"); + assert_eq!(InferenceJobType::Seedance2ProCharacter.to_str(), "seedance2pro_character"); + assert_eq!(InferenceJobType::Seedance2ProAltQueue.to_str(), "seedance2pro_alt_queue"); + assert_eq!(InferenceJobType::Seedance2ProBytePlusUltraQueue.to_str(), "seedance2pro_bpu_queue"); + assert_eq!(InferenceJobType::WorldlabsQueue.to_str(), "worldlabs_queue"); + assert_eq!(InferenceJobType::VideoRender.to_str(), "video_render"); + assert_eq!(InferenceJobType::LivePortrait.to_str(), "live_portrait"); + assert_eq!(InferenceJobType::FaceFusion.to_str(), "face_fusion"); + assert_eq!(InferenceJobType::F5TTS.to_str(), "f5_tts"); + assert_eq!(InferenceJobType::GptSovits.to_str(), "gpt_sovits"); + assert_eq!(InferenceJobType::ComfyUi.to_str(), "comfy_ui"); + assert_eq!(InferenceJobType::StudioGen2.to_str(), "studio_gen2"); + assert_eq!(InferenceJobType::ImageGenApi.to_str(), "image_gen_api"); + assert_eq!(InferenceJobType::ConvertFbxToGltf.to_str(), "convert_fbx_gltf"); + assert_eq!(InferenceJobType::MocapNet.to_str(), "mocap_net"); + assert_eq!(InferenceJobType::RvcV2.to_str(), "rvc_v2"); + assert_eq!(InferenceJobType::SadTalker.to_str(), "sad_talker"); + assert_eq!(InferenceJobType::SeedVc.to_str(), "seed_vc"); + assert_eq!(InferenceJobType::SoVitsSvc.to_str(), "so_vits_svc"); + assert_eq!(InferenceJobType::StableDiffusion.to_str(), "stable_diffusion"); + assert_eq!(InferenceJobType::StyleTTS2.to_str(), "styletts2"); + assert_eq!(InferenceJobType::Tacotron2.to_str(), "tacotron2"); + assert_eq!(InferenceJobType::Unknown.to_str(), "unknown"); + assert_eq!(InferenceJobType::BevyToWorkflow.to_str(), "bevy_to_workflow"); + assert_eq!(InferenceJobType::RerenderAVideo.to_str(), "rerender_a_video"); + } + + #[test] + fn from_str() { + assert_eq!(InferenceJobType::from_str("fal_queue").unwrap(), InferenceJobType::FalQueue); + assert_eq!(InferenceJobType::from_str("gmicloud_queue").unwrap(), InferenceJobType::GmiCloudQueue); + assert_eq!(InferenceJobType::from_str("grok_api_queue").unwrap(), InferenceJobType::GrokApiQueue); + assert_eq!(InferenceJobType::from_str("beeble_queue").unwrap(), InferenceJobType::BeebleQueue); + assert_eq!(InferenceJobType::from_str("seedance2pro_queue").unwrap(), InferenceJobType::Seedance2ProQueue); + assert_eq!(InferenceJobType::from_str("seedance2pro_character").unwrap(), InferenceJobType::Seedance2ProCharacter); + assert_eq!(InferenceJobType::from_str("seedance2pro_alt_queue").unwrap(), InferenceJobType::Seedance2ProAltQueue); + assert_eq!(InferenceJobType::from_str("seedance2pro_bpu_queue").unwrap(), InferenceJobType::Seedance2ProBytePlusUltraQueue); + assert_eq!(InferenceJobType::from_str("worldlabs_queue").unwrap(), InferenceJobType::WorldlabsQueue); + assert_eq!(InferenceJobType::from_str("video_render").unwrap(), InferenceJobType::VideoRender); + assert_eq!(InferenceJobType::from_str("live_portrait").unwrap(), InferenceJobType::LivePortrait); + assert_eq!(InferenceJobType::from_str("face_fusion").unwrap(), InferenceJobType::FaceFusion); + assert_eq!(InferenceJobType::from_str("f5_tts").unwrap(), InferenceJobType::F5TTS); + assert_eq!(InferenceJobType::from_str("gpt_sovits").unwrap(), InferenceJobType::GptSovits); + assert_eq!(InferenceJobType::from_str("comfy_ui").unwrap(), InferenceJobType::ComfyUi); + assert_eq!(InferenceJobType::from_str("studio_gen2").unwrap(), InferenceJobType::StudioGen2); + assert_eq!(InferenceJobType::from_str("image_gen_api").unwrap(), InferenceJobType::ImageGenApi); + assert_eq!(InferenceJobType::from_str("convert_fbx_gltf").unwrap(), InferenceJobType::ConvertFbxToGltf); + assert_eq!(InferenceJobType::from_str("mocap_net").unwrap(), InferenceJobType::MocapNet); + assert_eq!(InferenceJobType::from_str("rvc_v2").unwrap(), InferenceJobType::RvcV2); + assert_eq!(InferenceJobType::from_str("sad_talker").unwrap(), InferenceJobType::SadTalker); + assert_eq!(InferenceJobType::from_str("seed_vc").unwrap(), InferenceJobType::SeedVc); + assert_eq!(InferenceJobType::from_str("so_vits_svc").unwrap(), InferenceJobType::SoVitsSvc); + assert_eq!(InferenceJobType::from_str("stable_diffusion").unwrap(), InferenceJobType::StableDiffusion); + assert_eq!(InferenceJobType::from_str("styletts2").unwrap(), InferenceJobType::StyleTTS2); + assert_eq!(InferenceJobType::from_str("tacotron2").unwrap(), InferenceJobType::Tacotron2); + assert_eq!(InferenceJobType::from_str("unknown").unwrap(), InferenceJobType::Unknown); + assert_eq!(InferenceJobType::from_str("bevy_to_workflow").unwrap(), InferenceJobType::BevyToWorkflow); + assert_eq!(InferenceJobType::from_str("rerender_a_video").unwrap(), InferenceJobType::RerenderAVideo); + } + + #[test] + fn all_variants() { + // Static check + const EXPECTED_COUNT : usize = 29; + + assert_eq!(InferenceJobType::all_variants().len(), EXPECTED_COUNT); + assert_eq!(InferenceJobType::iter().len(), EXPECTED_COUNT); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(InferenceJobType::all_variants().len(), InferenceJobType::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(InferenceJobType::all_variants().len(), InferenceJobType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in InferenceJobType::all_variants() { + assert_eq!(variant, InferenceJobType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, InferenceJobType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, InferenceJobType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in InferenceJobType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_model_type.rs new file mode 100644 index 00000000..9580253e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_model_type.rs @@ -0,0 +1,1296 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::common::generation::common_model_type::CommonModelType; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `maybe_model_type`. +/// +/// Our "generic inference" pipeline supports a wide variety of ML models and other media. +/// Each inference "model type" identified by the following enum variants, though some pipelines +/// may use multiple models or no model (and may report NULL). +/// +/// These types are present in the HTTP API and database columns as serialized here. +/// +/// `InferenceModelType` is a **superset** of [`CommonModelType`]: every variant in +/// `CommonModelType` has a 1:1 mapping here (see [`from_common_model_type`]). The legacy +/// variants at the top of the enum (`ComfyUi`, `RvcV2`, …) only exist on this side. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum InferenceModelType { + // --------------------------------------------------------------------------- + // Legacy / inference-pipeline-only variants. These predate CommonModelType + // and have no counterpart there. + // --------------------------------------------------------------------------- + + // TODO(bt,2024-07-15): This is too generic. We probably need "StorytellerStudio", "LivePortrait", etc. + #[serde(rename = "comfy_ui")] + ComfyUi, + + #[serde(rename = "rvc_v2")] + RvcV2, + // NB: sad_talker does use user-supplied models, so there is no "model token" + #[serde(rename = "sad_talker")] + SadTalker, + #[serde(rename = "so_vits_svc")] + SoVitsSvc, + // TODO: Does this need to be "legacy_tacotron2" ? + + #[serde(rename = "seed_vc")] + SeedVc, + + /// NB: This is for Sora GPT 4o image gen + #[serde(rename = "image_gen_api")] + ImageGenApi, + + #[serde(rename = "tacotron2")] + Tacotron2, + #[serde(rename = "vits")] + Vits, + #[serde(rename = "vall_e_x")] + VallEX, + #[serde(rename = "rerender_a_video")] + RerenderAVideo, + #[serde(rename = "stable_diffusion")] + StableDiffusion, + #[serde(rename = "mocap_net")] + MocapNet, + #[serde(rename = "styletts2")] + StyleTTS2, + /// A job that turns "FBX" game engine files into "GLTF" files (Bevy-compatible). + #[serde(rename = "convert_fbx_gltf")] + ConvertFbxToGltf, + #[serde(rename = "bvh_to_workflow")] + BvhToWorkflow, + + // --------------------------------------------------------------------------- + // Mirror of `CommonModelType`. Names and serialized strings must stay in + // lock-step with that enum so `from_common_model_type` is trivially 1:1. + // When you add a new variant to `CommonModelType`, the match in + // `from_common_model_type` below will fail to compile until you mirror it + // here. + // --------------------------------------------------------------------------- + + // Image models + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_dev_juggernaut")] + FluxDevJuggernaut, + #[serde(rename = "flux_pro_1")] + FluxPro1, + #[serde(rename = "flux_pro_1p1")] + FluxPro11, + #[serde(rename = "flux_pro_1p1_ultra")] + FluxPro11Ultra, + #[serde(rename = "flux_pro_kontext_max")] + FluxProKontextMax, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + #[serde(rename = "grok_image")] + GrokImage, + #[serde(rename = "grok_imagine_image")] + GrokImagineImage, + #[serde(rename = "grok_imagine_image_q")] + GrokImagineImageQuality, + #[serde(rename = "recraft_3")] + Recraft3, + #[serde(rename = "seededit_3")] + SeedEdit3, + #[serde(rename = "qwen")] + Qwen, + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + #[serde(rename = "gemini_25_flash")] + Gemini25Flash, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "midjourney_v6")] + MidjourneyV6, + #[serde(rename = "midjourney_v6p1")] + MidjourneyV6p1, + #[serde(rename = "midjourney_v6p1_raw")] + MidjourneyV6p1Raw, + #[serde(rename = "midjourney_v7")] + MidjourneyV7, + #[serde(rename = "midjourney_v7_draft")] + MidjourneyV7Draft, + #[serde(rename = "midjourney_v7_draft_raw")] + MidjourneyV7DraftRaw, + #[serde(rename = "midjourney_v7_raw")] + MidjourneyV7Raw, + /// Midjourney v7 as routed via kinovi + #[serde(rename = "midjourney_7")] + Midjourney7, + /// Midjourney v7 niji as routed via kinovi + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + /// Midjourney v8 as routed via kinovi + #[serde(rename = "midjourney_8")] + Midjourney8, + + // Video models + #[serde(rename = "grok_video")] + GrokVideo, + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + #[serde(rename = "kling_2p1_master")] + Kling21Master, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p0_pro")] + Seedance10Pro, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + #[serde(rename = "seedance_2p0")] + Seedance2p0, + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + #[serde(rename = "seedance_2p0_bp_mini")] + Seedance2p0BytePlusMini, + #[serde(rename = "seedance_2p0_bpu_mini")] + Seedance2p0BytePlusUltraMini, + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + #[serde(rename = "vidu_q3")] + ViduQ3, + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, + + // Audio models + #[serde(rename = "suno_music")] + SunoMusic, + #[serde(rename = "suno_remix")] + SunoRemix, + #[serde(rename = "suno_sounds")] + SunoSounds, + #[serde(rename = "suno_sample")] + SunoSample, + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, + + #[serde(rename = "preview_model")] + PreviewModel, + #[serde(rename = "preview_model_fast")] + PreviewModelFast, + #[serde(rename = "switch_x")] + SwitchX, + + // 3D Object generation models + #[serde(rename = "hunyuan_3d_2p0")] + Hunyuan3d2_0, + #[serde(rename = "hunyuan_3d_2p1")] + Hunyuan3d2_1, + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3_1Pro, + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3_1Rapid, + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3_1Part, + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3_1SmartTopology, + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3_1, + #[serde(rename = "meshy_v6")] + MeshyV6, + #[serde(rename = "rodin_2p5_fast")] + Rodin2_5Fast, + + // Splat generation models (World Labs) + #[serde(rename = "marble_0p1_mini")] + Marble0p1Mini, + #[serde(rename = "marble_0p1_plus")] + Marble0p1Plus, + #[serde(rename = "marble_1p0")] + Marble1p0, + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + #[serde(rename = "marble_1p1")] + Marble1p1, + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + #[serde(rename = "triposplat")] + TripoSplat, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceModelType); + +/// NB: Legacy API for older code. +impl InferenceModelType { + pub fn to_str(&self) -> &'static str { + match self { + // Legacy variants + Self::RvcV2 => "rvc_v2", + Self::SadTalker => "sad_talker", + Self::SoVitsSvc => "so_vits_svc", + Self::Tacotron2 => "tacotron2", + Self::Vits => "vits", + Self::VallEX => "vall_e_x", + Self::RerenderAVideo => "rerender_a_video", + Self::StableDiffusion => "stable_diffusion", + Self::ImageGenApi => "image_gen_api", + Self::SeedVc => "seed_vc", + Self::MocapNet => "mocap_net", + Self::StyleTTS2 => "styletts2", + Self::ComfyUi => "comfy_ui", + Self::ConvertFbxToGltf => "convert_fbx_gltf", + Self::BvhToWorkflow => "bvh_to_workflow", + + // Image models (mirror of CommonModelType) + Self::Flux1Dev => "flux_1_dev", + Self::Flux1Schnell => "flux_1_schnell", + Self::FluxDevJuggernaut => "flux_dev_juggernaut", + Self::FluxPro1 => "flux_pro_1", + Self::FluxPro11 => "flux_pro_1p1", + Self::FluxPro11Ultra => "flux_pro_1p1_ultra", + Self::FluxProKontextMax => "flux_pro_kontext_max", + Self::Flux2LoraAngles => "flux_2_lora_angles", + Self::GptImage1 => "gpt_image_1", + Self::GptImage1p5 => "gpt_image_1p5", + Self::GptImage2 => "gpt_image_2", + Self::GrokImage => "grok_image", + Self::GrokImagineImage => "grok_imagine_image", + Self::GrokImagineImageQuality => "grok_imagine_image_q", + Self::Recraft3 => "recraft_3", + Self::SeedEdit3 => "seededit_3", + Self::Qwen => "qwen", + Self::QwenEdit2511Angles => "qwen_edit_2511_angles", + Self::Gemini25Flash => "gemini_25_flash", + Self::NanoBanana => "nano_banana", + Self::NanoBanana2 => "nano_banana_2", + Self::NanoBananaPro => "nano_banana_pro", + Self::Seedream4 => "seedream_4", + Self::Seedream4p5 => "seedream_4p5", + Self::Seedream5Lite => "seedream_5_lite", + Self::Seedream5p0Pro => "seedream_5p0_pro", + Self::Seedream5p0ProUltra => "seedream_5p0_pro_u", + Self::Midjourney => "midjourney", + Self::MidjourneyV6 => "midjourney_v6", + Self::MidjourneyV6p1 => "midjourney_v6p1", + Self::MidjourneyV6p1Raw => "midjourney_v6p1_raw", + Self::MidjourneyV7 => "midjourney_v7", + Self::MidjourneyV7Draft => "midjourney_v7_draft", + Self::MidjourneyV7DraftRaw => "midjourney_v7_draft_raw", + Self::MidjourneyV7Raw => "midjourney_v7_raw", + Self::Midjourney7 => "midjourney_7", + Self::Midjourney7Niji => "midjourney_7_niji", + Self::Midjourney8 => "midjourney_8", + + // Video models + Self::GrokVideo => "grok_video", + Self::GrokImagineVideo => "grok_imagine_video", + Self::GrokImagineVideo1p5 => "grok_imagine_video_1p5", + Self::Kling16Pro => "kling_1p6_pro", + Self::Kling21Pro => "kling_2p1_pro", + Self::Kling21Master => "kling_2p1_master", + Self::Kling2p5TurboPro => "kling_2p5_turbo_pro", + Self::Kling2p6Pro => "kling_2p6_pro", + Self::Kling3p0Standard => "kling_3p0_standard", + Self::Kling3p0Pro => "kling_3p0_pro", + Self::HappyHorse1p0 => "happy_horse_1p0", + Self::Seedance10Lite => "seedance_1p0_lite", + Self::Seedance10Pro => "seedance_1p0_pro", + Self::Seedance1p5Pro => "seedance_1p5_pro", + Self::Seedance2p0 => "seedance_2p0", + Self::Seedance2p0Fast => "seedance_2p0_fast", + Self::Seedance2p0BytePlus => "seedance_2p0_bp", + Self::Seedance2p0BytePlusFast => "seedance_2p0_bp_fast", + Self::Seedance2p0Ultra => "seedance_2p0_u", + Self::Seedance2p0UltraFast => "seedance_2p0_u_fast", + Self::Seedance2p0BytePlusUltra => "seedance_2p0_bpu", + Self::Seedance2p0BytePlusUltraFast => "seedance_2p0_bpu_fast", + Self::Seedance2p0Mini => "seedance_2p0_mini", + Self::Seedance2p0BytePlusMini => "seedance_2p0_bp_mini", + Self::Seedance2p0BytePlusUltraMini => "seedance_2p0_bpu_mini", + Self::Sora2 => "sora_2", + Self::Sora2Pro => "sora_2_pro", + Self::Veo2 => "veo_2", + Self::Veo3 => "veo_3", + Self::Veo3Fast => "veo_3_fast", + Self::Veo3p1 => "veo_3p1", + Self::Veo3p1Fast => "veo_3p1_fast", + Self::Veo3p1Lite => "veo_3p1_lite", + Self::ViduQ3 => "vidu_q3", + Self::ViduQ3Turbo => "vidu_q3_turbo", + + // Audio models + Self::SunoMusic => "suno_music", + Self::SunoRemix => "suno_remix", + Self::SunoSounds => "suno_sounds", + Self::SunoSample => "suno_sample", + Self::SeedAudio1p0 => "seed_audio_1p0", + + Self::PreviewModel => "preview_model", + Self::PreviewModelFast => "preview_model_fast", + Self::SwitchX => "switch_x", + + // 3D Object generation models + Self::Hunyuan3d2_0 => "hunyuan_3d_2p0", + Self::Hunyuan3d2_1 => "hunyuan_3d_2p1", + Self::Hunyuan3d3 => "hunyuan_3d_3", + Self::Hunyuan3d3_1Pro => "hunyuan_3d_3p1_pro", + Self::Hunyuan3d3_1Rapid => "hunyuan_3d_3p1_rapid", + Self::Hunyuan3d3_1Part => "hunyuan_3d_3p1_part", + Self::Hunyuan3d3_1SmartTopology => "hunyuan_3d_3p1_topology", + Self::Tripo3dH3_1 => "tripo3d_h3p1", + Self::MeshyV6 => "meshy_v6", + Self::Rodin2_5Fast => "rodin_2p5_fast", + + // Splat generation models (World Labs) + Self::Marble0p1Mini => "marble_0p1_mini", + Self::Marble0p1Plus => "marble_0p1_plus", + Self::Marble1p0 => "marble_1p0", + Self::Marble1p0Draft => "marble_1p0_draft", + Self::Marble1p1 => "marble_1p1", + Self::Marble1p1Plus => "marble_1p1_plus", + Self::TripoSplat => "triposplat", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + // Legacy variants + "rvc_v2" => Ok(Self::RvcV2), + "sad_talker" => Ok(Self::SadTalker), + "so_vits_svc" => Ok(Self::SoVitsSvc), + "seed_vc" => Ok(Self::SeedVc), + "tacotron2" => Ok(Self::Tacotron2), + "vits" => Ok(Self::Vits), + "vall_e_x" => Ok(Self::VallEX), + "rerender_a_video" => Ok(Self::RerenderAVideo), + "stable_diffusion" => Ok(Self::StableDiffusion), + "image_gen_api" => Ok(Self::ImageGenApi), + "mocap_net" => Ok(Self::MocapNet), + "styletts2" => Ok(Self::StyleTTS2), + "comfy_ui" => Ok(Self::ComfyUi), + "convert_fbx_gltf" => Ok(Self::ConvertFbxToGltf), + "bvh_to_workflow" => Ok(Self::BvhToWorkflow), + + // Image models (mirror of CommonModelType) + "flux_1_dev" => Ok(Self::Flux1Dev), + "flux_1_schnell" => Ok(Self::Flux1Schnell), + "flux_dev_juggernaut" => Ok(Self::FluxDevJuggernaut), + "flux_pro_1" => Ok(Self::FluxPro1), + "flux_pro_1p1" => Ok(Self::FluxPro11), + "flux_pro_1p1_ultra" => Ok(Self::FluxPro11Ultra), + "flux_pro_kontext_max" => Ok(Self::FluxProKontextMax), + "flux_2_lora_angles" => Ok(Self::Flux2LoraAngles), + "gpt_image_1" => Ok(Self::GptImage1), + "gpt_image_1p5" => Ok(Self::GptImage1p5), + "gpt_image_2" => Ok(Self::GptImage2), + "grok_image" => Ok(Self::GrokImage), + "grok_imagine_image" => Ok(Self::GrokImagineImage), + "grok_imagine_image_q" => Ok(Self::GrokImagineImageQuality), + "recraft_3" => Ok(Self::Recraft3), + "seededit_3" => Ok(Self::SeedEdit3), + "qwen" => Ok(Self::Qwen), + "qwen_edit_2511_angles" => Ok(Self::QwenEdit2511Angles), + "gemini_25_flash" => Ok(Self::Gemini25Flash), + "nano_banana" => Ok(Self::NanoBanana), + "nano_banana_2" => Ok(Self::NanoBanana2), + "nano_banana_pro" => Ok(Self::NanoBananaPro), + "seedream_4" => Ok(Self::Seedream4), + "seedream_4p5" => Ok(Self::Seedream4p5), + "seedream_5_lite" => Ok(Self::Seedream5Lite), + "seedream_5p0_pro" => Ok(Self::Seedream5p0Pro), + "seedream_5p0_pro_u" => Ok(Self::Seedream5p0ProUltra), + "midjourney" => Ok(Self::Midjourney), + "midjourney_v6" => Ok(Self::MidjourneyV6), + "midjourney_v6p1" => Ok(Self::MidjourneyV6p1), + "midjourney_v6p1_raw" => Ok(Self::MidjourneyV6p1Raw), + "midjourney_v7" => Ok(Self::MidjourneyV7), + "midjourney_v7_draft" => Ok(Self::MidjourneyV7Draft), + "midjourney_v7_draft_raw" => Ok(Self::MidjourneyV7DraftRaw), + "midjourney_v7_raw" => Ok(Self::MidjourneyV7Raw), + "midjourney_7" => Ok(Self::Midjourney7), + "midjourney_7_niji" => Ok(Self::Midjourney7Niji), + "midjourney_8" => Ok(Self::Midjourney8), + + // Video models + "grok_video" => Ok(Self::GrokVideo), + "grok_imagine_video" => Ok(Self::GrokImagineVideo), + "grok_imagine_video_1p5" => Ok(Self::GrokImagineVideo1p5), + "kling_1p6_pro" => Ok(Self::Kling16Pro), + "kling_2p1_pro" => Ok(Self::Kling21Pro), + "kling_2p1_master" => Ok(Self::Kling21Master), + "kling_2p5_turbo_pro" => Ok(Self::Kling2p5TurboPro), + "kling_2p6_pro" => Ok(Self::Kling2p6Pro), + "kling_3p0_standard" => Ok(Self::Kling3p0Standard), + "kling_3p0_pro" => Ok(Self::Kling3p0Pro), + "happy_horse_1p0" => Ok(Self::HappyHorse1p0), + "seedance_1p0_lite" => Ok(Self::Seedance10Lite), + "seedance_1p0_pro" => Ok(Self::Seedance10Pro), + "seedance_1p5_pro" => Ok(Self::Seedance1p5Pro), + "seedance_2p0" => Ok(Self::Seedance2p0), + "seedance_2p0_fast" => Ok(Self::Seedance2p0Fast), + "seedance_2p0_bp" => Ok(Self::Seedance2p0BytePlus), + "seedance_2p0_bp_fast" => Ok(Self::Seedance2p0BytePlusFast), + "seedance_2p0_u" => Ok(Self::Seedance2p0Ultra), + "seedance_2p0_u_fast" => Ok(Self::Seedance2p0UltraFast), + "seedance_2p0_bpu" => Ok(Self::Seedance2p0BytePlusUltra), + "seedance_2p0_bpu_fast" => Ok(Self::Seedance2p0BytePlusUltraFast), + "seedance_2p0_mini" => Ok(Self::Seedance2p0Mini), + "seedance_2p0_bp_mini" => Ok(Self::Seedance2p0BytePlusMini), + "seedance_2p0_bpu_mini" => Ok(Self::Seedance2p0BytePlusUltraMini), + "sora_2" => Ok(Self::Sora2), + "sora_2_pro" => Ok(Self::Sora2Pro), + "veo_2" => Ok(Self::Veo2), + "veo_3" => Ok(Self::Veo3), + "veo_3_fast" => Ok(Self::Veo3Fast), + "veo_3p1" => Ok(Self::Veo3p1), + "veo_3p1_fast" => Ok(Self::Veo3p1Fast), + "veo_3p1_lite" => Ok(Self::Veo3p1Lite), + "vidu_q3" => Ok(Self::ViduQ3), + "vidu_q3_turbo" => Ok(Self::ViduQ3Turbo), + + // Audio models + "suno_music" => Ok(Self::SunoMusic), + "suno_remix" => Ok(Self::SunoRemix), + "suno_sounds" => Ok(Self::SunoSounds), + "suno_sample" => Ok(Self::SunoSample), + "seed_audio_1p0" => Ok(Self::SeedAudio1p0), + + "preview_model" => Ok(Self::PreviewModel), + "preview_model_fast" => Ok(Self::PreviewModelFast), + "switch_x" => Ok(Self::SwitchX), + + // 3D Object generation models + "hunyuan_3d_2p0" => Ok(Self::Hunyuan3d2_0), + "hunyuan_3d_2p1" => Ok(Self::Hunyuan3d2_1), + "hunyuan_3d_3" => Ok(Self::Hunyuan3d3), + "hunyuan_3d_3p1_pro" => Ok(Self::Hunyuan3d3_1Pro), + "hunyuan_3d_3p1_rapid" => Ok(Self::Hunyuan3d3_1Rapid), + "hunyuan_3d_3p1_part" => Ok(Self::Hunyuan3d3_1Part), + "hunyuan_3d_3p1_topology" => Ok(Self::Hunyuan3d3_1SmartTopology), + "tripo3d_h3p1" => Ok(Self::Tripo3dH3_1), + "meshy_v6" => Ok(Self::MeshyV6), + "rodin_2p5_fast" => Ok(Self::Rodin2_5Fast), + + // Splat generation models (World Labs) + "marble_0p1_mini" => Ok(Self::Marble0p1Mini), + "marble_0p1_plus" => Ok(Self::Marble0p1Plus), + "marble_1p0" => Ok(Self::Marble1p0), + "marble_1p0_draft" => Ok(Self::Marble1p0Draft), + "marble_1p1" => Ok(Self::Marble1p1), + "marble_1p1_plus" => Ok(Self::Marble1p1Plus), + "triposplat" => Ok(Self::TripoSplat), + + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + // Legacy variants + Self::ComfyUi, + Self::RvcV2, + Self::SadTalker, + Self::SoVitsSvc, + Self::SeedVc, + Self::Tacotron2, + Self::Vits, + Self::VallEX, + Self::RerenderAVideo, + Self::StableDiffusion, + Self::ImageGenApi, + Self::MocapNet, + Self::StyleTTS2, + Self::ConvertFbxToGltf, + Self::BvhToWorkflow, + + // Image models (mirror of CommonModelType) + Self::Flux1Dev, + Self::Flux1Schnell, + Self::FluxDevJuggernaut, + Self::FluxPro1, + Self::FluxPro11, + Self::FluxPro11Ultra, + Self::FluxProKontextMax, + Self::Flux2LoraAngles, + Self::GptImage1, + Self::GptImage1p5, + Self::GptImage2, + Self::GrokImage, + Self::GrokImagineImage, + Self::GrokImagineImageQuality, + Self::Recraft3, + Self::SeedEdit3, + Self::Qwen, + Self::QwenEdit2511Angles, + Self::Gemini25Flash, + Self::NanoBanana, + Self::NanoBanana2, + Self::NanoBananaPro, + Self::Seedream4, + Self::Seedream4p5, + Self::Seedream5Lite, + Self::Seedream5p0Pro, + Self::Seedream5p0ProUltra, + Self::Midjourney, + Self::MidjourneyV6, + Self::MidjourneyV6p1, + Self::MidjourneyV6p1Raw, + Self::MidjourneyV7, + Self::MidjourneyV7Draft, + Self::MidjourneyV7DraftRaw, + Self::MidjourneyV7Raw, + Self::Midjourney7, + Self::Midjourney7Niji, + Self::Midjourney8, + + // Video models + Self::GrokVideo, + Self::GrokImagineVideo, + Self::GrokImagineVideo1p5, + Self::Kling16Pro, + Self::Kling21Pro, + Self::Kling21Master, + Self::Kling2p5TurboPro, + Self::Kling2p6Pro, + Self::Kling3p0Standard, + Self::Kling3p0Pro, + Self::HappyHorse1p0, + Self::Seedance10Lite, + Self::Seedance10Pro, + Self::Seedance1p5Pro, + Self::Seedance2p0, + Self::Seedance2p0Fast, + Self::Seedance2p0BytePlus, + Self::Seedance2p0BytePlusFast, + Self::Seedance2p0Ultra, + Self::Seedance2p0UltraFast, + Self::Seedance2p0BytePlusUltra, + Self::Seedance2p0BytePlusUltraFast, + Self::Seedance2p0Mini, + Self::Seedance2p0BytePlusMini, + Self::Seedance2p0BytePlusUltraMini, + Self::Sora2, + Self::Sora2Pro, + Self::Veo2, + Self::Veo3, + Self::Veo3Fast, + Self::Veo3p1, + Self::Veo3p1Fast, + Self::Veo3p1Lite, + Self::ViduQ3, + Self::ViduQ3Turbo, + + // Audio models + Self::SunoMusic, + Self::SunoRemix, + Self::SunoSounds, + Self::SunoSample, + Self::SeedAudio1p0, + + Self::PreviewModel, + Self::PreviewModelFast, + Self::SwitchX, + + // 3D Object generation models + Self::Hunyuan3d2_0, + Self::Hunyuan3d2_1, + Self::Hunyuan3d3, + Self::Hunyuan3d3_1Pro, + Self::Hunyuan3d3_1Rapid, + Self::Hunyuan3d3_1Part, + Self::Hunyuan3d3_1SmartTopology, + Self::Tripo3dH3_1, + Self::MeshyV6, + Self::Rodin2_5Fast, + + // Splat generation models (World Labs) + Self::Marble0p1Mini, + Self::Marble0p1Plus, + Self::Marble1p0, + Self::Marble1p0Draft, + Self::Marble1p1, + Self::Marble1p1Plus, + Self::TripoSplat, + ]) + } + + /// Infallibly map a [`CommonModelType`] to its [`InferenceModelType`] + /// counterpart. The mapping is exhaustively 1:1 by variant name; when a + /// new variant is added to `CommonModelType`, this match will fail to + /// compile until you mirror the variant here too. + pub fn from_common_model_type(common: CommonModelType) -> Self { + match common { + // Image models + CommonModelType::Flux1Dev => Self::Flux1Dev, + CommonModelType::Flux1Schnell => Self::Flux1Schnell, + CommonModelType::FluxDevJuggernaut => Self::FluxDevJuggernaut, + CommonModelType::FluxPro1 => Self::FluxPro1, + CommonModelType::FluxPro11 => Self::FluxPro11, + CommonModelType::FluxPro11Ultra => Self::FluxPro11Ultra, + CommonModelType::FluxProKontextMax => Self::FluxProKontextMax, + CommonModelType::Flux2LoraAngles => Self::Flux2LoraAngles, + CommonModelType::GptImage1 => Self::GptImage1, + CommonModelType::GptImage1p5 => Self::GptImage1p5, + CommonModelType::GptImage2 => Self::GptImage2, + CommonModelType::GrokImage => Self::GrokImage, + CommonModelType::GrokImagineImage => Self::GrokImagineImage, + CommonModelType::GrokImagineImageQuality => Self::GrokImagineImageQuality, + CommonModelType::Recraft3 => Self::Recraft3, + CommonModelType::SeedEdit3 => Self::SeedEdit3, + CommonModelType::Qwen => Self::Qwen, + CommonModelType::QwenEdit2511Angles => Self::QwenEdit2511Angles, + CommonModelType::Gemini25Flash => Self::Gemini25Flash, + CommonModelType::NanoBanana => Self::NanoBanana, + CommonModelType::NanoBanana2 => Self::NanoBanana2, + CommonModelType::NanoBananaPro => Self::NanoBananaPro, + CommonModelType::Seedream4 => Self::Seedream4, + CommonModelType::Seedream4p5 => Self::Seedream4p5, + CommonModelType::Seedream5Lite => Self::Seedream5Lite, + CommonModelType::Seedream5p0Pro => Self::Seedream5p0Pro, + CommonModelType::Seedream5p0ProUltra => Self::Seedream5p0ProUltra, + CommonModelType::Midjourney => Self::Midjourney, + CommonModelType::MidjourneyV6 => Self::MidjourneyV6, + CommonModelType::MidjourneyV6p1 => Self::MidjourneyV6p1, + CommonModelType::MidjourneyV6p1Raw => Self::MidjourneyV6p1Raw, + CommonModelType::MidjourneyV7 => Self::MidjourneyV7, + CommonModelType::MidjourneyV7Draft => Self::MidjourneyV7Draft, + CommonModelType::MidjourneyV7DraftRaw => Self::MidjourneyV7DraftRaw, + CommonModelType::MidjourneyV7Raw => Self::MidjourneyV7Raw, + CommonModelType::Midjourney7 => Self::Midjourney7, + CommonModelType::Midjourney7Niji => Self::Midjourney7Niji, + CommonModelType::Midjourney8 => Self::Midjourney8, + + // Video models + CommonModelType::GrokVideo => Self::GrokVideo, + CommonModelType::GrokImagineVideo => Self::GrokImagineVideo, + CommonModelType::GrokImagineVideo1p5 => Self::GrokImagineVideo1p5, + CommonModelType::Kling16Pro => Self::Kling16Pro, + CommonModelType::Kling21Pro => Self::Kling21Pro, + CommonModelType::Kling21Master => Self::Kling21Master, + CommonModelType::Kling2p5TurboPro => Self::Kling2p5TurboPro, + CommonModelType::Kling2p6Pro => Self::Kling2p6Pro, + CommonModelType::Kling3p0Standard => Self::Kling3p0Standard, + CommonModelType::Kling3p0Pro => Self::Kling3p0Pro, + CommonModelType::HappyHorse1p0 => Self::HappyHorse1p0, + CommonModelType::Seedance10Lite => Self::Seedance10Lite, + CommonModelType::Seedance10Pro => Self::Seedance10Pro, + CommonModelType::Seedance1p5Pro => Self::Seedance1p5Pro, + CommonModelType::Seedance2p0 => Self::Seedance2p0, + CommonModelType::Seedance2p0Fast => Self::Seedance2p0Fast, + CommonModelType::Seedance2p0BytePlus => Self::Seedance2p0BytePlus, + CommonModelType::Seedance2p0BytePlusFast => Self::Seedance2p0BytePlusFast, + CommonModelType::Seedance2p0Ultra => Self::Seedance2p0Ultra, + CommonModelType::Seedance2p0UltraFast => Self::Seedance2p0UltraFast, + CommonModelType::Seedance2p0BytePlusUltra => Self::Seedance2p0BytePlusUltra, + CommonModelType::Seedance2p0BytePlusUltraFast => Self::Seedance2p0BytePlusUltraFast, + CommonModelType::Seedance2p0Mini => Self::Seedance2p0Mini, + CommonModelType::Seedance2p0BytePlusMini => Self::Seedance2p0BytePlusMini, + CommonModelType::Seedance2p0BytePlusUltraMini => Self::Seedance2p0BytePlusUltraMini, + CommonModelType::Sora2 => Self::Sora2, + CommonModelType::Sora2Pro => Self::Sora2Pro, + CommonModelType::Veo2 => Self::Veo2, + CommonModelType::Veo3 => Self::Veo3, + CommonModelType::Veo3Fast => Self::Veo3Fast, + CommonModelType::Veo3p1 => Self::Veo3p1, + CommonModelType::Veo3p1Fast => Self::Veo3p1Fast, + CommonModelType::Veo3p1Lite => Self::Veo3p1Lite, + CommonModelType::ViduQ3 => Self::ViduQ3, + CommonModelType::ViduQ3Turbo => Self::ViduQ3Turbo, + + // Audio models + CommonModelType::SunoMusic => Self::SunoMusic, + CommonModelType::SunoRemix => Self::SunoRemix, + CommonModelType::SunoSounds => Self::SunoSounds, + CommonModelType::SunoSample => Self::SunoSample, + CommonModelType::SeedAudio1p0 => Self::SeedAudio1p0, + + CommonModelType::PreviewModel => Self::PreviewModel, + CommonModelType::PreviewModelFast => Self::PreviewModelFast, + CommonModelType::SwitchX => Self::SwitchX, + + // 3D Object generation models + CommonModelType::Hunyuan3d2_0 => Self::Hunyuan3d2_0, + CommonModelType::Hunyuan3d2_1 => Self::Hunyuan3d2_1, + CommonModelType::Hunyuan3d3 => Self::Hunyuan3d3, + CommonModelType::Hunyuan3d3_1Pro => Self::Hunyuan3d3_1Pro, + CommonModelType::Hunyuan3d3_1Rapid => Self::Hunyuan3d3_1Rapid, + CommonModelType::Hunyuan3d3_1Part => Self::Hunyuan3d3_1Part, + CommonModelType::Hunyuan3d3_1SmartTopology => Self::Hunyuan3d3_1SmartTopology, + CommonModelType::Tripo3dH3_1 => Self::Tripo3dH3_1, + CommonModelType::MeshyV6 => Self::MeshyV6, + CommonModelType::Rodin2_5Fast => Self::Rodin2_5Fast, + + // Splat generation models (World Labs) + CommonModelType::Marble0p1Mini => Self::Marble0p1Mini, + CommonModelType::Marble0p1Plus => Self::Marble0p1Plus, + CommonModelType::Marble1p0 => Self::Marble1p0, + CommonModelType::Marble1p0Draft => Self::Marble1p0Draft, + CommonModelType::Marble1p1 => Self::Marble1p1, + CommonModelType::Marble1p1Plus => Self::Marble1p1Plus, + CommonModelType::TripoSplat => Self::TripoSplat, + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_model_type::InferenceModelType; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + // Legacy variants + assert_serialization(InferenceModelType::RvcV2, "rvc_v2"); + assert_serialization(InferenceModelType::SadTalker, "sad_talker"); + assert_serialization(InferenceModelType::SeedVc, "seed_vc"); + assert_serialization(InferenceModelType::SoVitsSvc, "so_vits_svc"); + assert_serialization(InferenceModelType::Tacotron2, "tacotron2"); + assert_serialization(InferenceModelType::Vits, "vits"); + assert_serialization(InferenceModelType::VallEX, "vall_e_x"); + assert_serialization(InferenceModelType::RerenderAVideo, "rerender_a_video"); + assert_serialization(InferenceModelType::StableDiffusion, "stable_diffusion"); + assert_serialization(InferenceModelType::ImageGenApi, "image_gen_api"); + assert_serialization(InferenceModelType::MocapNet, "mocap_net"); + assert_serialization(InferenceModelType::ComfyUi, "comfy_ui"); + assert_serialization(InferenceModelType::StyleTTS2, "styletts2"); + assert_serialization(InferenceModelType::ConvertFbxToGltf, "convert_fbx_gltf"); + assert_serialization(InferenceModelType::BvhToWorkflow, "bvh_to_workflow"); + + // Image models (mirror of CommonModelType) + assert_serialization(InferenceModelType::Flux1Dev, "flux_1_dev"); + assert_serialization(InferenceModelType::Flux1Schnell, "flux_1_schnell"); + assert_serialization(InferenceModelType::FluxDevJuggernaut, "flux_dev_juggernaut"); + assert_serialization(InferenceModelType::FluxPro1, "flux_pro_1"); + assert_serialization(InferenceModelType::FluxPro11, "flux_pro_1p1"); + assert_serialization(InferenceModelType::FluxPro11Ultra, "flux_pro_1p1_ultra"); + assert_serialization(InferenceModelType::FluxProKontextMax, "flux_pro_kontext_max"); + assert_serialization(InferenceModelType::Flux2LoraAngles, "flux_2_lora_angles"); + assert_serialization(InferenceModelType::GptImage1, "gpt_image_1"); + assert_serialization(InferenceModelType::GptImage1p5, "gpt_image_1p5"); + assert_serialization(InferenceModelType::GptImage2, "gpt_image_2"); + assert_serialization(InferenceModelType::GrokImage, "grok_image"); + assert_serialization(InferenceModelType::GrokImagineImage, "grok_imagine_image"); + assert_serialization(InferenceModelType::GrokImagineImageQuality, "grok_imagine_image_q"); + assert_serialization(InferenceModelType::Recraft3, "recraft_3"); + assert_serialization(InferenceModelType::SeedEdit3, "seededit_3"); + assert_serialization(InferenceModelType::Qwen, "qwen"); + assert_serialization(InferenceModelType::QwenEdit2511Angles, "qwen_edit_2511_angles"); + assert_serialization(InferenceModelType::Gemini25Flash, "gemini_25_flash"); + assert_serialization(InferenceModelType::NanoBanana, "nano_banana"); + assert_serialization(InferenceModelType::NanoBanana2, "nano_banana_2"); + assert_serialization(InferenceModelType::NanoBananaPro, "nano_banana_pro"); + assert_serialization(InferenceModelType::Seedream4, "seedream_4"); + assert_serialization(InferenceModelType::Seedream4p5, "seedream_4p5"); + assert_serialization(InferenceModelType::Seedream5Lite, "seedream_5_lite"); + assert_serialization(InferenceModelType::Seedream5p0Pro, "seedream_5p0_pro"); + assert_serialization(InferenceModelType::Midjourney, "midjourney"); + assert_serialization(InferenceModelType::MidjourneyV6, "midjourney_v6"); + assert_serialization(InferenceModelType::MidjourneyV6p1, "midjourney_v6p1"); + assert_serialization(InferenceModelType::MidjourneyV6p1Raw, "midjourney_v6p1_raw"); + assert_serialization(InferenceModelType::MidjourneyV7, "midjourney_v7"); + assert_serialization(InferenceModelType::MidjourneyV7Draft, "midjourney_v7_draft"); + assert_serialization(InferenceModelType::MidjourneyV7DraftRaw, "midjourney_v7_draft_raw"); + assert_serialization(InferenceModelType::MidjourneyV7Raw, "midjourney_v7_raw"); + assert_serialization(InferenceModelType::Midjourney7, "midjourney_7"); + assert_serialization(InferenceModelType::Midjourney7Niji, "midjourney_7_niji"); + assert_serialization(InferenceModelType::Midjourney8, "midjourney_8"); + + // Video models + assert_serialization(InferenceModelType::GrokVideo, "grok_video"); + assert_serialization(InferenceModelType::GrokImagineVideo, "grok_imagine_video"); + assert_serialization(InferenceModelType::GrokImagineVideo1p5, "grok_imagine_video_1p5"); + assert_serialization(InferenceModelType::Kling16Pro, "kling_1p6_pro"); + assert_serialization(InferenceModelType::Kling21Pro, "kling_2p1_pro"); + assert_serialization(InferenceModelType::Kling21Master, "kling_2p1_master"); + assert_serialization(InferenceModelType::Kling2p5TurboPro, "kling_2p5_turbo_pro"); + assert_serialization(InferenceModelType::Kling2p6Pro, "kling_2p6_pro"); + assert_serialization(InferenceModelType::Kling3p0Standard, "kling_3p0_standard"); + assert_serialization(InferenceModelType::Kling3p0Pro, "kling_3p0_pro"); + assert_serialization(InferenceModelType::HappyHorse1p0, "happy_horse_1p0"); + assert_serialization(InferenceModelType::Seedance10Lite, "seedance_1p0_lite"); + assert_serialization(InferenceModelType::Seedance10Pro, "seedance_1p0_pro"); + assert_serialization(InferenceModelType::Seedance1p5Pro, "seedance_1p5_pro"); + assert_serialization(InferenceModelType::Seedance2p0, "seedance_2p0"); + assert_serialization(InferenceModelType::Seedance2p0Fast, "seedance_2p0_fast"); + assert_serialization(InferenceModelType::Seedance2p0BytePlus, "seedance_2p0_bp"); + assert_serialization(InferenceModelType::Seedance2p0BytePlusFast, "seedance_2p0_bp_fast"); + assert_serialization(InferenceModelType::Seedance2p0Ultra, "seedance_2p0_u"); + assert_serialization(InferenceModelType::Seedance2p0UltraFast, "seedance_2p0_u_fast"); + assert_serialization(InferenceModelType::Seedance2p0BytePlusUltra, "seedance_2p0_bpu"); + assert_serialization(InferenceModelType::Seedance2p0BytePlusUltraFast, "seedance_2p0_bpu_fast"); + assert_serialization(InferenceModelType::Seedance2p0Mini, "seedance_2p0_mini"); + assert_serialization(InferenceModelType::Seedance2p0BytePlusMini, "seedance_2p0_bp_mini"); + assert_serialization(InferenceModelType::Seedance2p0BytePlusUltraMini, "seedance_2p0_bpu_mini"); + assert_serialization(InferenceModelType::Sora2, "sora_2"); + assert_serialization(InferenceModelType::Sora2Pro, "sora_2_pro"); + assert_serialization(InferenceModelType::Veo2, "veo_2"); + assert_serialization(InferenceModelType::Veo3, "veo_3"); + assert_serialization(InferenceModelType::Veo3Fast, "veo_3_fast"); + assert_serialization(InferenceModelType::Veo3p1, "veo_3p1"); + assert_serialization(InferenceModelType::Veo3p1Fast, "veo_3p1_fast"); + assert_serialization(InferenceModelType::Veo3p1Lite, "veo_3p1_lite"); + assert_serialization(InferenceModelType::ViduQ3, "vidu_q3"); + assert_serialization(InferenceModelType::ViduQ3Turbo, "vidu_q3_turbo"); + // Audio models + assert_serialization(InferenceModelType::SunoMusic, "suno_music"); + assert_serialization(InferenceModelType::SunoRemix, "suno_remix"); + assert_serialization(InferenceModelType::SunoSounds, "suno_sounds"); + assert_serialization(InferenceModelType::SunoSample, "suno_sample"); + assert_serialization(InferenceModelType::SeedAudio1p0, "seed_audio_1p0"); + assert_serialization(InferenceModelType::PreviewModel, "preview_model"); + assert_serialization(InferenceModelType::PreviewModelFast, "preview_model_fast"); + assert_serialization(InferenceModelType::SwitchX, "switch_x"); + + // 3D Object generation models + assert_serialization(InferenceModelType::Hunyuan3d2_0, "hunyuan_3d_2p0"); + assert_serialization(InferenceModelType::Hunyuan3d2_1, "hunyuan_3d_2p1"); + assert_serialization(InferenceModelType::Hunyuan3d3, "hunyuan_3d_3"); + assert_serialization(InferenceModelType::Hunyuan3d3_1Pro, "hunyuan_3d_3p1_pro"); + assert_serialization(InferenceModelType::Hunyuan3d3_1Rapid, "hunyuan_3d_3p1_rapid"); + assert_serialization(InferenceModelType::Hunyuan3d3_1Part, "hunyuan_3d_3p1_part"); + assert_serialization(InferenceModelType::Hunyuan3d3_1SmartTopology, "hunyuan_3d_3p1_topology"); + assert_serialization(InferenceModelType::Tripo3dH3_1, "tripo3d_h3p1"); + assert_serialization(InferenceModelType::MeshyV6, "meshy_v6"); + assert_serialization(InferenceModelType::Rodin2_5Fast, "rodin_2p5_fast"); + + // Splat generation models (World Labs) + assert_serialization(InferenceModelType::Marble0p1Mini, "marble_0p1_mini"); + assert_serialization(InferenceModelType::Marble0p1Plus, "marble_0p1_plus"); + assert_serialization(InferenceModelType::Marble1p0, "marble_1p0"); + assert_serialization(InferenceModelType::Marble1p0Draft, "marble_1p0_draft"); + assert_serialization(InferenceModelType::Marble1p1, "marble_1p1"); + assert_serialization(InferenceModelType::Marble1p1Plus, "marble_1p1_plus"); + assert_serialization(InferenceModelType::TripoSplat, "triposplat"); + } + + #[test] + fn to_str() { + // Legacy variants + assert_eq!(InferenceModelType::ComfyUi.to_str(), "comfy_ui"); + assert_eq!(InferenceModelType::RvcV2.to_str(), "rvc_v2"); + assert_eq!(InferenceModelType::SadTalker.to_str(), "sad_talker"); + assert_eq!(InferenceModelType::SoVitsSvc.to_str(), "so_vits_svc"); + assert_eq!(InferenceModelType::SeedVc.to_str(), "seed_vc"); + assert_eq!(InferenceModelType::ImageGenApi.to_str(), "image_gen_api"); + assert_eq!(InferenceModelType::Tacotron2.to_str(), "tacotron2"); + assert_eq!(InferenceModelType::Vits.to_str(), "vits"); + assert_eq!(InferenceModelType::VallEX.to_str(), "vall_e_x"); + assert_eq!(InferenceModelType::RerenderAVideo.to_str(), "rerender_a_video"); + assert_eq!(InferenceModelType::StableDiffusion.to_str(), "stable_diffusion"); + assert_eq!(InferenceModelType::MocapNet.to_str(), "mocap_net"); + assert_eq!(InferenceModelType::StyleTTS2.to_str(), "styletts2"); + assert_eq!(InferenceModelType::ConvertFbxToGltf.to_str(), "convert_fbx_gltf"); + assert_eq!(InferenceModelType::BvhToWorkflow.to_str(), "bvh_to_workflow"); + + // Image models (mirror of CommonModelType) + assert_eq!(InferenceModelType::Flux1Dev.to_str(), "flux_1_dev"); + assert_eq!(InferenceModelType::Flux1Schnell.to_str(), "flux_1_schnell"); + assert_eq!(InferenceModelType::FluxDevJuggernaut.to_str(), "flux_dev_juggernaut"); + assert_eq!(InferenceModelType::FluxPro1.to_str(), "flux_pro_1"); + assert_eq!(InferenceModelType::FluxPro11.to_str(), "flux_pro_1p1"); + assert_eq!(InferenceModelType::FluxPro11Ultra.to_str(), "flux_pro_1p1_ultra"); + assert_eq!(InferenceModelType::FluxProKontextMax.to_str(), "flux_pro_kontext_max"); + assert_eq!(InferenceModelType::Flux2LoraAngles.to_str(), "flux_2_lora_angles"); + assert_eq!(InferenceModelType::GptImage1.to_str(), "gpt_image_1"); + assert_eq!(InferenceModelType::GptImage1p5.to_str(), "gpt_image_1p5"); + assert_eq!(InferenceModelType::GptImage2.to_str(), "gpt_image_2"); + assert_eq!(InferenceModelType::GrokImage.to_str(), "grok_image"); + assert_eq!(InferenceModelType::GrokImagineImage.to_str(), "grok_imagine_image"); + assert_eq!(InferenceModelType::GrokImagineImageQuality.to_str(), "grok_imagine_image_q"); + assert_eq!(InferenceModelType::Recraft3.to_str(), "recraft_3"); + assert_eq!(InferenceModelType::SeedEdit3.to_str(), "seededit_3"); + assert_eq!(InferenceModelType::Qwen.to_str(), "qwen"); + assert_eq!(InferenceModelType::QwenEdit2511Angles.to_str(), "qwen_edit_2511_angles"); + assert_eq!(InferenceModelType::Gemini25Flash.to_str(), "gemini_25_flash"); + assert_eq!(InferenceModelType::NanoBanana.to_str(), "nano_banana"); + assert_eq!(InferenceModelType::NanoBanana2.to_str(), "nano_banana_2"); + assert_eq!(InferenceModelType::NanoBananaPro.to_str(), "nano_banana_pro"); + assert_eq!(InferenceModelType::Seedream4.to_str(), "seedream_4"); + assert_eq!(InferenceModelType::Seedream4p5.to_str(), "seedream_4p5"); + assert_eq!(InferenceModelType::Seedream5Lite.to_str(), "seedream_5_lite"); + assert_eq!(InferenceModelType::Seedream5p0Pro.to_str(), "seedream_5p0_pro"); + assert_eq!(InferenceModelType::Midjourney.to_str(), "midjourney"); + assert_eq!(InferenceModelType::MidjourneyV6.to_str(), "midjourney_v6"); + assert_eq!(InferenceModelType::MidjourneyV6p1.to_str(), "midjourney_v6p1"); + assert_eq!(InferenceModelType::MidjourneyV6p1Raw.to_str(), "midjourney_v6p1_raw"); + assert_eq!(InferenceModelType::MidjourneyV7.to_str(), "midjourney_v7"); + assert_eq!(InferenceModelType::MidjourneyV7Draft.to_str(), "midjourney_v7_draft"); + assert_eq!(InferenceModelType::MidjourneyV7DraftRaw.to_str(), "midjourney_v7_draft_raw"); + assert_eq!(InferenceModelType::MidjourneyV7Raw.to_str(), "midjourney_v7_raw"); + assert_eq!(InferenceModelType::Midjourney7.to_str(), "midjourney_7"); + assert_eq!(InferenceModelType::Midjourney7Niji.to_str(), "midjourney_7_niji"); + assert_eq!(InferenceModelType::Midjourney8.to_str(), "midjourney_8"); + + // Video models + assert_eq!(InferenceModelType::GrokVideo.to_str(), "grok_video"); + assert_eq!(InferenceModelType::GrokImagineVideo.to_str(), "grok_imagine_video"); + assert_eq!(InferenceModelType::GrokImagineVideo1p5.to_str(), "grok_imagine_video_1p5"); + assert_eq!(InferenceModelType::Kling16Pro.to_str(), "kling_1p6_pro"); + assert_eq!(InferenceModelType::Kling21Pro.to_str(), "kling_2p1_pro"); + assert_eq!(InferenceModelType::Kling21Master.to_str(), "kling_2p1_master"); + assert_eq!(InferenceModelType::Kling2p5TurboPro.to_str(), "kling_2p5_turbo_pro"); + assert_eq!(InferenceModelType::Kling2p6Pro.to_str(), "kling_2p6_pro"); + assert_eq!(InferenceModelType::Kling3p0Standard.to_str(), "kling_3p0_standard"); + assert_eq!(InferenceModelType::Kling3p0Pro.to_str(), "kling_3p0_pro"); + assert_eq!(InferenceModelType::HappyHorse1p0.to_str(), "happy_horse_1p0"); + assert_eq!(InferenceModelType::Seedance10Lite.to_str(), "seedance_1p0_lite"); + assert_eq!(InferenceModelType::Seedance10Pro.to_str(), "seedance_1p0_pro"); + assert_eq!(InferenceModelType::Seedance1p5Pro.to_str(), "seedance_1p5_pro"); + assert_eq!(InferenceModelType::Seedance2p0.to_str(), "seedance_2p0"); + assert_eq!(InferenceModelType::Seedance2p0Fast.to_str(), "seedance_2p0_fast"); + assert_eq!(InferenceModelType::Seedance2p0BytePlus.to_str(), "seedance_2p0_bp"); + assert_eq!(InferenceModelType::Seedance2p0BytePlusFast.to_str(), "seedance_2p0_bp_fast"); + assert_eq!(InferenceModelType::Seedance2p0Ultra.to_str(), "seedance_2p0_u"); + assert_eq!(InferenceModelType::Seedance2p0UltraFast.to_str(), "seedance_2p0_u_fast"); + assert_eq!(InferenceModelType::Seedance2p0BytePlusUltra.to_str(), "seedance_2p0_bpu"); + assert_eq!(InferenceModelType::Seedance2p0BytePlusUltraFast.to_str(), "seedance_2p0_bpu_fast"); + assert_eq!(InferenceModelType::Seedance2p0Mini.to_str(), "seedance_2p0_mini"); + assert_eq!(InferenceModelType::Seedance2p0BytePlusMini.to_str(), "seedance_2p0_bp_mini"); + assert_eq!(InferenceModelType::Seedance2p0BytePlusUltraMini.to_str(), "seedance_2p0_bpu_mini"); + assert_eq!(InferenceModelType::Sora2.to_str(), "sora_2"); + assert_eq!(InferenceModelType::Sora2Pro.to_str(), "sora_2_pro"); + assert_eq!(InferenceModelType::Veo2.to_str(), "veo_2"); + assert_eq!(InferenceModelType::Veo3.to_str(), "veo_3"); + assert_eq!(InferenceModelType::Veo3Fast.to_str(), "veo_3_fast"); + assert_eq!(InferenceModelType::Veo3p1.to_str(), "veo_3p1"); + assert_eq!(InferenceModelType::Veo3p1Fast.to_str(), "veo_3p1_fast"); + assert_eq!(InferenceModelType::Veo3p1Lite.to_str(), "veo_3p1_lite"); + assert_eq!(InferenceModelType::ViduQ3.to_str(), "vidu_q3"); + assert_eq!(InferenceModelType::ViduQ3Turbo.to_str(), "vidu_q3_turbo"); + + // Audio models + assert_eq!(InferenceModelType::SunoMusic.to_str(), "suno_music"); + assert_eq!(InferenceModelType::SunoRemix.to_str(), "suno_remix"); + assert_eq!(InferenceModelType::SunoSounds.to_str(), "suno_sounds"); + assert_eq!(InferenceModelType::SunoSample.to_str(), "suno_sample"); + assert_eq!(InferenceModelType::SeedAudio1p0.to_str(), "seed_audio_1p0"); + + assert_eq!(InferenceModelType::PreviewModel.to_str(), "preview_model"); + assert_eq!(InferenceModelType::PreviewModelFast.to_str(), "preview_model_fast"); + assert_eq!(InferenceModelType::SwitchX.to_str(), "switch_x"); + + // 3D Object generation models + assert_eq!(InferenceModelType::Hunyuan3d2_0.to_str(), "hunyuan_3d_2p0"); + assert_eq!(InferenceModelType::Hunyuan3d2_1.to_str(), "hunyuan_3d_2p1"); + assert_eq!(InferenceModelType::Hunyuan3d3.to_str(), "hunyuan_3d_3"); + assert_eq!(InferenceModelType::Hunyuan3d3_1Pro.to_str(), "hunyuan_3d_3p1_pro"); + assert_eq!(InferenceModelType::Hunyuan3d3_1Rapid.to_str(), "hunyuan_3d_3p1_rapid"); + assert_eq!(InferenceModelType::Hunyuan3d3_1Part.to_str(), "hunyuan_3d_3p1_part"); + assert_eq!(InferenceModelType::Hunyuan3d3_1SmartTopology.to_str(), "hunyuan_3d_3p1_topology"); + assert_eq!(InferenceModelType::Tripo3dH3_1.to_str(), "tripo3d_h3p1"); + assert_eq!(InferenceModelType::MeshyV6.to_str(), "meshy_v6"); + assert_eq!(InferenceModelType::Rodin2_5Fast.to_str(), "rodin_2p5_fast"); + + // Splat generation models (World Labs) + assert_eq!(InferenceModelType::Marble0p1Mini.to_str(), "marble_0p1_mini"); + assert_eq!(InferenceModelType::Marble0p1Plus.to_str(), "marble_0p1_plus"); + assert_eq!(InferenceModelType::Marble1p0.to_str(), "marble_1p0"); + assert_eq!(InferenceModelType::Marble1p0Draft.to_str(), "marble_1p0_draft"); + assert_eq!(InferenceModelType::Marble1p1.to_str(), "marble_1p1"); + assert_eq!(InferenceModelType::Marble1p1Plus.to_str(), "marble_1p1_plus"); + assert_eq!(InferenceModelType::TripoSplat.to_str(), "triposplat"); + } + + #[test] + fn from_str() { + // Legacy variants + assert_eq!(InferenceModelType::from_str("comfy_ui").unwrap(), InferenceModelType::ComfyUi); + assert_eq!(InferenceModelType::from_str("rvc_v2").unwrap(), InferenceModelType::RvcV2); + assert_eq!(InferenceModelType::from_str("sad_talker").unwrap(), InferenceModelType::SadTalker); + assert_eq!(InferenceModelType::from_str("so_vits_svc").unwrap(), InferenceModelType::SoVitsSvc); + assert_eq!(InferenceModelType::from_str("seed_vc").unwrap(), InferenceModelType::SeedVc); + assert_eq!(InferenceModelType::from_str("image_gen_api").unwrap(), InferenceModelType::ImageGenApi); + assert_eq!(InferenceModelType::from_str("tacotron2").unwrap(), InferenceModelType::Tacotron2); + assert_eq!(InferenceModelType::from_str("vits").unwrap(), InferenceModelType::Vits); + assert_eq!(InferenceModelType::from_str("vall_e_x").unwrap(), InferenceModelType::VallEX); + assert_eq!(InferenceModelType::from_str("rerender_a_video").unwrap(), InferenceModelType::RerenderAVideo); + assert_eq!(InferenceModelType::from_str("stable_diffusion").unwrap(), InferenceModelType::StableDiffusion); + assert_eq!(InferenceModelType::from_str("mocap_net").unwrap(), InferenceModelType::MocapNet); + assert_eq!(InferenceModelType::from_str("styletts2").unwrap(), InferenceModelType::StyleTTS2); + assert_eq!(InferenceModelType::from_str("convert_fbx_gltf").unwrap(), InferenceModelType::ConvertFbxToGltf); + assert_eq!(InferenceModelType::from_str("bvh_to_workflow").unwrap(), InferenceModelType::BvhToWorkflow); + + // Image models (mirror of CommonModelType) + assert_eq!(InferenceModelType::from_str("flux_1_dev").unwrap(), InferenceModelType::Flux1Dev); + assert_eq!(InferenceModelType::from_str("flux_1_schnell").unwrap(), InferenceModelType::Flux1Schnell); + assert_eq!(InferenceModelType::from_str("flux_dev_juggernaut").unwrap(), InferenceModelType::FluxDevJuggernaut); + assert_eq!(InferenceModelType::from_str("flux_pro_1").unwrap(), InferenceModelType::FluxPro1); + assert_eq!(InferenceModelType::from_str("flux_pro_1p1").unwrap(), InferenceModelType::FluxPro11); + assert_eq!(InferenceModelType::from_str("flux_pro_1p1_ultra").unwrap(), InferenceModelType::FluxPro11Ultra); + assert_eq!(InferenceModelType::from_str("flux_pro_kontext_max").unwrap(), InferenceModelType::FluxProKontextMax); + assert_eq!(InferenceModelType::from_str("flux_2_lora_angles").unwrap(), InferenceModelType::Flux2LoraAngles); + assert_eq!(InferenceModelType::from_str("gpt_image_1").unwrap(), InferenceModelType::GptImage1); + assert_eq!(InferenceModelType::from_str("gpt_image_1p5").unwrap(), InferenceModelType::GptImage1p5); + assert_eq!(InferenceModelType::from_str("gpt_image_2").unwrap(), InferenceModelType::GptImage2); + assert_eq!(InferenceModelType::from_str("grok_image").unwrap(), InferenceModelType::GrokImage); + assert_eq!(InferenceModelType::from_str("grok_imagine_image").unwrap(), InferenceModelType::GrokImagineImage); + assert_eq!(InferenceModelType::from_str("grok_imagine_image_q").unwrap(), InferenceModelType::GrokImagineImageQuality); + assert_eq!(InferenceModelType::from_str("recraft_3").unwrap(), InferenceModelType::Recraft3); + assert_eq!(InferenceModelType::from_str("seededit_3").unwrap(), InferenceModelType::SeedEdit3); + assert_eq!(InferenceModelType::from_str("qwen").unwrap(), InferenceModelType::Qwen); + assert_eq!(InferenceModelType::from_str("qwen_edit_2511_angles").unwrap(), InferenceModelType::QwenEdit2511Angles); + assert_eq!(InferenceModelType::from_str("gemini_25_flash").unwrap(), InferenceModelType::Gemini25Flash); + assert_eq!(InferenceModelType::from_str("nano_banana").unwrap(), InferenceModelType::NanoBanana); + assert_eq!(InferenceModelType::from_str("nano_banana_2").unwrap(), InferenceModelType::NanoBanana2); + assert_eq!(InferenceModelType::from_str("nano_banana_pro").unwrap(), InferenceModelType::NanoBananaPro); + assert_eq!(InferenceModelType::from_str("seedream_4").unwrap(), InferenceModelType::Seedream4); + assert_eq!(InferenceModelType::from_str("seedream_4p5").unwrap(), InferenceModelType::Seedream4p5); + assert_eq!(InferenceModelType::from_str("seedream_5_lite").unwrap(), InferenceModelType::Seedream5Lite); + assert_eq!(InferenceModelType::from_str("seedream_5p0_pro").unwrap(), InferenceModelType::Seedream5p0Pro); + assert_eq!(InferenceModelType::from_str("midjourney").unwrap(), InferenceModelType::Midjourney); + assert_eq!(InferenceModelType::from_str("midjourney_v6").unwrap(), InferenceModelType::MidjourneyV6); + assert_eq!(InferenceModelType::from_str("midjourney_v6p1").unwrap(), InferenceModelType::MidjourneyV6p1); + assert_eq!(InferenceModelType::from_str("midjourney_v6p1_raw").unwrap(), InferenceModelType::MidjourneyV6p1Raw); + assert_eq!(InferenceModelType::from_str("midjourney_v7").unwrap(), InferenceModelType::MidjourneyV7); + assert_eq!(InferenceModelType::from_str("midjourney_v7_draft").unwrap(), InferenceModelType::MidjourneyV7Draft); + assert_eq!(InferenceModelType::from_str("midjourney_v7_draft_raw").unwrap(), InferenceModelType::MidjourneyV7DraftRaw); + assert_eq!(InferenceModelType::from_str("midjourney_v7_raw").unwrap(), InferenceModelType::MidjourneyV7Raw); + assert_eq!(InferenceModelType::from_str("midjourney_7").unwrap(), InferenceModelType::Midjourney7); + assert_eq!(InferenceModelType::from_str("midjourney_7_niji").unwrap(), InferenceModelType::Midjourney7Niji); + assert_eq!(InferenceModelType::from_str("midjourney_8").unwrap(), InferenceModelType::Midjourney8); + + // Video models + assert_eq!(InferenceModelType::from_str("grok_video").unwrap(), InferenceModelType::GrokVideo); + assert_eq!(InferenceModelType::from_str("grok_imagine_video").unwrap(), InferenceModelType::GrokImagineVideo); + assert_eq!(InferenceModelType::from_str("grok_imagine_video_1p5").unwrap(), InferenceModelType::GrokImagineVideo1p5); + assert_eq!(InferenceModelType::from_str("kling_1p6_pro").unwrap(), InferenceModelType::Kling16Pro); + assert_eq!(InferenceModelType::from_str("kling_2p1_pro").unwrap(), InferenceModelType::Kling21Pro); + assert_eq!(InferenceModelType::from_str("kling_2p1_master").unwrap(), InferenceModelType::Kling21Master); + assert_eq!(InferenceModelType::from_str("kling_2p5_turbo_pro").unwrap(), InferenceModelType::Kling2p5TurboPro); + assert_eq!(InferenceModelType::from_str("kling_2p6_pro").unwrap(), InferenceModelType::Kling2p6Pro); + assert_eq!(InferenceModelType::from_str("kling_3p0_standard").unwrap(), InferenceModelType::Kling3p0Standard); + assert_eq!(InferenceModelType::from_str("kling_3p0_pro").unwrap(), InferenceModelType::Kling3p0Pro); + assert_eq!(InferenceModelType::from_str("happy_horse_1p0").unwrap(), InferenceModelType::HappyHorse1p0); + assert_eq!(InferenceModelType::from_str("seedance_1p0_lite").unwrap(), InferenceModelType::Seedance10Lite); + assert_eq!(InferenceModelType::from_str("seedance_1p0_pro").unwrap(), InferenceModelType::Seedance10Pro); + assert_eq!(InferenceModelType::from_str("seedance_1p5_pro").unwrap(), InferenceModelType::Seedance1p5Pro); + assert_eq!(InferenceModelType::from_str("seedance_2p0").unwrap(), InferenceModelType::Seedance2p0); + assert_eq!(InferenceModelType::from_str("seedance_2p0_fast").unwrap(), InferenceModelType::Seedance2p0Fast); + assert_eq!(InferenceModelType::from_str("seedance_2p0_bp").unwrap(), InferenceModelType::Seedance2p0BytePlus); + assert_eq!(InferenceModelType::from_str("seedance_2p0_bp_fast").unwrap(), InferenceModelType::Seedance2p0BytePlusFast); + assert_eq!(InferenceModelType::from_str("seedance_2p0_u").unwrap(), InferenceModelType::Seedance2p0Ultra); + assert_eq!(InferenceModelType::from_str("seedance_2p0_u_fast").unwrap(), InferenceModelType::Seedance2p0UltraFast); + assert_eq!(InferenceModelType::from_str("seedance_2p0_bpu").unwrap(), InferenceModelType::Seedance2p0BytePlusUltra); + assert_eq!(InferenceModelType::from_str("seedance_2p0_bpu_fast").unwrap(), InferenceModelType::Seedance2p0BytePlusUltraFast); + assert_eq!(InferenceModelType::from_str("seedance_2p0_mini").unwrap(), InferenceModelType::Seedance2p0Mini); + assert_eq!(InferenceModelType::from_str("seedance_2p0_bp_mini").unwrap(), InferenceModelType::Seedance2p0BytePlusMini); + assert_eq!(InferenceModelType::from_str("seedance_2p0_bpu_mini").unwrap(), InferenceModelType::Seedance2p0BytePlusUltraMini); + assert_eq!(InferenceModelType::from_str("sora_2").unwrap(), InferenceModelType::Sora2); + assert_eq!(InferenceModelType::from_str("sora_2_pro").unwrap(), InferenceModelType::Sora2Pro); + assert_eq!(InferenceModelType::from_str("veo_2").unwrap(), InferenceModelType::Veo2); + assert_eq!(InferenceModelType::from_str("veo_3").unwrap(), InferenceModelType::Veo3); + assert_eq!(InferenceModelType::from_str("veo_3_fast").unwrap(), InferenceModelType::Veo3Fast); + assert_eq!(InferenceModelType::from_str("veo_3p1").unwrap(), InferenceModelType::Veo3p1); + assert_eq!(InferenceModelType::from_str("veo_3p1_fast").unwrap(), InferenceModelType::Veo3p1Fast); + assert_eq!(InferenceModelType::from_str("veo_3p1_lite").unwrap(), InferenceModelType::Veo3p1Lite); + assert_eq!(InferenceModelType::from_str("vidu_q3").unwrap(), InferenceModelType::ViduQ3); + assert_eq!(InferenceModelType::from_str("vidu_q3_turbo").unwrap(), InferenceModelType::ViduQ3Turbo); + // Audio models + assert_eq!(InferenceModelType::from_str("suno_music").unwrap(), InferenceModelType::SunoMusic); + assert_eq!(InferenceModelType::from_str("suno_remix").unwrap(), InferenceModelType::SunoRemix); + assert_eq!(InferenceModelType::from_str("suno_sounds").unwrap(), InferenceModelType::SunoSounds); + assert_eq!(InferenceModelType::from_str("suno_sample").unwrap(), InferenceModelType::SunoSample); + assert_eq!(InferenceModelType::from_str("seed_audio_1p0").unwrap(), InferenceModelType::SeedAudio1p0); + assert_eq!(InferenceModelType::from_str("preview_model").unwrap(), InferenceModelType::PreviewModel); + assert_eq!(InferenceModelType::from_str("preview_model_fast").unwrap(), InferenceModelType::PreviewModelFast); + assert_eq!(InferenceModelType::from_str("switch_x").unwrap(), InferenceModelType::SwitchX); + + // 3D Object generation models + assert_eq!(InferenceModelType::from_str("hunyuan_3d_2p0").unwrap(), InferenceModelType::Hunyuan3d2_0); + assert_eq!(InferenceModelType::from_str("hunyuan_3d_2p1").unwrap(), InferenceModelType::Hunyuan3d2_1); + assert_eq!(InferenceModelType::from_str("hunyuan_3d_3").unwrap(), InferenceModelType::Hunyuan3d3); + assert_eq!(InferenceModelType::from_str("hunyuan_3d_3p1_pro").unwrap(), InferenceModelType::Hunyuan3d3_1Pro); + assert_eq!(InferenceModelType::from_str("hunyuan_3d_3p1_rapid").unwrap(), InferenceModelType::Hunyuan3d3_1Rapid); + assert_eq!(InferenceModelType::from_str("hunyuan_3d_3p1_part").unwrap(), InferenceModelType::Hunyuan3d3_1Part); + assert_eq!(InferenceModelType::from_str("hunyuan_3d_3p1_topology").unwrap(), InferenceModelType::Hunyuan3d3_1SmartTopology); + assert_eq!(InferenceModelType::from_str("tripo3d_h3p1").unwrap(), InferenceModelType::Tripo3dH3_1); + assert_eq!(InferenceModelType::from_str("meshy_v6").unwrap(), InferenceModelType::MeshyV6); + assert_eq!(InferenceModelType::from_str("rodin_2p5_fast").unwrap(), InferenceModelType::Rodin2_5Fast); + + // Splat generation models (World Labs) + assert_eq!(InferenceModelType::from_str("marble_0p1_mini").unwrap(), InferenceModelType::Marble0p1Mini); + assert_eq!(InferenceModelType::from_str("marble_0p1_plus").unwrap(), InferenceModelType::Marble0p1Plus); + assert_eq!(InferenceModelType::from_str("marble_1p0").unwrap(), InferenceModelType::Marble1p0); + assert_eq!(InferenceModelType::from_str("marble_1p0_draft").unwrap(), InferenceModelType::Marble1p0Draft); + assert_eq!(InferenceModelType::from_str("marble_1p1").unwrap(), InferenceModelType::Marble1p1); + assert_eq!(InferenceModelType::from_str("marble_1p1_plus").unwrap(), InferenceModelType::Marble1p1Plus); + assert_eq!(InferenceModelType::from_str("triposplat").unwrap(), InferenceModelType::TripoSplat); + } + + #[test] + fn from_str_unknown_value_errors() { + assert!(InferenceModelType::from_str("not_a_real_model").is_err()); + } + + #[test] + fn all_variants() { + // 15 legacy variants + every CommonModelType variant we mirror. + let variants = InferenceModelType::all_variants(); + assert_eq!(variants.len(), 15 + CommonModelType::all_variants().len()); + + // BTreeSet sort order is enum Ord = declaration order. The legacy + // block is declared first, so ComfyUi is always pop_first, and the + // legacy block is exhausted before the mirrored block begins. + assert_eq!(variants.iter().next(), Some(&InferenceModelType::ComfyUi)); + + // Every variant must be reachable via from_str(to_str(.)) — round-trip + // is the structural guarantee we actually care about here. + for variant in &variants { + assert_eq!(*variant, InferenceModelType::from_str(variant.to_str()).unwrap()); + } + } + } + + mod from_common_model_type_tests { + use super::*; + + #[test] + fn round_trip_via_serialized_string() { + // Every CommonModelType maps to an InferenceModelType whose + // serialization matches exactly. This proves the 1:1 mapping + // is consistent (no swapped variants). + for common in CommonModelType::all_variants() { + let inference = InferenceModelType::from_common_model_type(common); + assert_eq!( + common.to_str(), + inference.to_str(), + "mismatch: CommonModelType::{:?} -> InferenceModelType::{:?}", + common, inference, + ); + } + } + + #[test] + fn every_common_variant_is_covered() { + // If a CommonModelType variant is missing from the match in + // from_common_model_type, this would fail to compile. The runtime + // assertion is a belt-and-suspenders sanity check. + let count = CommonModelType::all_variants().len(); + assert!(count > 0); + for common in CommonModelType::all_variants() { + let _ = InferenceModelType::from_common_model_type(common); + } + } + + #[test] + fn spot_check_specific_mappings() { + assert_eq!( + InferenceModelType::from_common_model_type(CommonModelType::Flux1Dev), + InferenceModelType::Flux1Dev, + ); + assert_eq!( + InferenceModelType::from_common_model_type(CommonModelType::Sora2Pro), + InferenceModelType::Sora2Pro, + ); + assert_eq!( + InferenceModelType::from_common_model_type(CommonModelType::Marble0p1Plus), + InferenceModelType::Marble0p1Plus, + ); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(InferenceModelType::all_variants().len(), InferenceModelType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in InferenceModelType::all_variants() { + assert_eq!(variant, InferenceModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, InferenceModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, InferenceModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in InferenceModelType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long ({} chars)", variant, serialized.len()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_result_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_result_type.rs new file mode 100644 index 00000000..5c7c2eab --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/inference_result_type.rs @@ -0,0 +1,136 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_inference_jobs` table in `VARCHAR(32)` field `on_success_result_entity_type`. +/// +/// Our "generic inference" pipeline supports a wide variety of output types. +/// Each "result type" is identified by the following enum variants. +/// +/// These types are present in the HTTP API and database columns as serialized here. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum InferenceResultType { + /// Result is stored in the "media_files" table. + /// (The upstream model could have produced any type of media - image, video, audio. That is irrelevant.) + #[serde(rename = "media_file")] + MediaFile, + + #[serde(rename = "text_to_speech")] + TextToSpeech, + + #[serde(rename = "voice_conversion")] + VoiceConversion, + + #[serde(rename = "zs_voice_embedding")] + ZeroShotVoiceEmbedding, + + #[serde(rename = "upload_model")] + UploadModel, + + /// Result is a character record. + #[serde(rename = "character")] + Character, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(InferenceResultType); + +/// NB: Legacy API for older code. +impl InferenceResultType { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaFile => "media_file", + Self::TextToSpeech => "text_to_speech", + Self::VoiceConversion => "voice_conversion", + Self::ZeroShotVoiceEmbedding => "zs_voice_embedding", + Self::UploadModel => "upload_model", + Self::Character => "character", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_file" => Ok(Self::MediaFile), + "text_to_speech" => Ok(Self::TextToSpeech), + "voice_conversion" => Ok(Self::VoiceConversion), + "zs_voice_embedding" => Ok(Self::ZeroShotVoiceEmbedding), + "upload_model" => Ok(Self::UploadModel), + "character" => Ok(Self::Character), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + InferenceResultType::MediaFile, + InferenceResultType::TextToSpeech, + InferenceResultType::VoiceConversion, + InferenceResultType::ZeroShotVoiceEmbedding, + InferenceResultType::UploadModel, + InferenceResultType::Character, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_inference_jobs::inference_result_type::InferenceResultType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(InferenceResultType::MediaFile, "media_file"); + assert_serialization(InferenceResultType::TextToSpeech, "text_to_speech"); + assert_serialization(InferenceResultType::VoiceConversion, "voice_conversion"); + assert_serialization(InferenceResultType::ZeroShotVoiceEmbedding, "zs_voice_embedding"); + assert_serialization(InferenceResultType::UploadModel, "upload_model"); + assert_serialization(InferenceResultType::Character, "character"); + } + + #[test] + fn to_str() { + assert_eq!(InferenceResultType::MediaFile.to_str(), "media_file"); + assert_eq!(InferenceResultType::TextToSpeech.to_str(), "text_to_speech"); + assert_eq!(InferenceResultType::VoiceConversion.to_str(), "voice_conversion"); + assert_eq!(InferenceResultType::ZeroShotVoiceEmbedding.to_str(), "zs_voice_embedding"); + assert_eq!(InferenceResultType::UploadModel.to_str(), "upload_model"); + assert_eq!(InferenceResultType::Character.to_str(), "character"); + } + + #[test] + fn from_str() { + assert_eq!(InferenceResultType::from_str("media_file").unwrap(), InferenceResultType::MediaFile); + assert_eq!(InferenceResultType::from_str("text_to_speech").unwrap(), InferenceResultType::TextToSpeech); + assert_eq!(InferenceResultType::from_str("voice_conversion").unwrap(), InferenceResultType::VoiceConversion); + assert_eq!(InferenceResultType::from_str("zs_voice_embedding").unwrap(), InferenceResultType::ZeroShotVoiceEmbedding); + assert_eq!(InferenceResultType::from_str("upload_model").unwrap(), InferenceResultType::UploadModel); + assert_eq!(InferenceResultType::from_str("character").unwrap(), InferenceResultType::Character); + assert_eq!(InferenceResultType::from_str("invalid").is_err(), true); + } + + #[test] + fn all_variants() { + // Static check + let mut variants = InferenceResultType::all_variants(); + assert_eq!(variants.len(), 6); + assert_eq!(variants.pop_first(), Some(InferenceResultType::MediaFile)); + assert_eq!(variants.pop_first(), Some(InferenceResultType::TextToSpeech)); + assert_eq!(variants.pop_first(), Some(InferenceResultType::VoiceConversion)); + assert_eq!(variants.pop_first(), Some(InferenceResultType::ZeroShotVoiceEmbedding)); + assert_eq!(variants.pop_first(), Some(InferenceResultType::UploadModel)); + assert_eq!(variants.pop_first(), Some(InferenceResultType::Character)); + assert_eq!(variants.pop_first(), None); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(InferenceResultType::all_variants().len(), InferenceResultType::iter().len()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/mod.rs new file mode 100644 index 00000000..ab12b4e3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_inference_jobs/mod.rs @@ -0,0 +1,8 @@ +pub mod frontend_failure_category; +pub mod inference_category; +pub mod inference_input_source_token_type; +pub mod inference_job_external_third_party; +pub mod inference_job_product_category; +pub mod inference_job_type; +pub mod inference_model_type; +pub mod inference_result_type; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_synthetic_ids/id_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_synthetic_ids/id_category.rs new file mode 100644 index 00000000..b6ae0688 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_synthetic_ids/id_category.rs @@ -0,0 +1,258 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `generic_synthetic_ids` table in `VARCHAR(32)` field `id_category`. +/// +/// This lets us create synthetic increment IDs on a per-user, per-category basis. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum IdCategory { + /// media_files table + #[serde(rename = "media_file")] + MediaFile, + + /// Results from lipsync animations (which may live in the media_files table) + #[serde(rename = "lipsync_animation")] + LipsyncAnimationResult, + + /// Results from face fusion + #[serde(rename = "face_fusion")] + FaceFusionResult, + + /// Results from video filters + #[serde(rename = "video_filter")] + VideoFilterResult, + + /// Results from Live Portrait + #[serde(rename = "live_portrait")] + LivePortraitResult, + + /// Studio Renders + #[serde(rename = "studio_render")] + StudioRender, + + /// Results from mocap + #[serde(rename = "mocap")] + MocapResult, + + /// Results from workflows + #[serde(rename = "workflow")] + WorkflowResult, + + /// Results from tacotron2 + /// Applies for RVC and SVC + #[serde(rename = "tts_result")] + TtsResult, + + /// Results from voice conversion (which may live in the media_files table) + /// Applies for RVC and SVC + #[serde(rename = "voice_conversion")] + VoiceConversionResult, + + /// Results from the zero shot tts (which may live in the media_files table) + #[serde(rename = "zs_tts_result")] + ZeroShotTtsResult, + + /// Zs dataset which lives in the zs_voice_datasets table + #[serde(rename = "zs_dataset")] + ZeroShotVoiceDataset, + + /// Zs voice which lives in the zs_voices table + #[serde(rename = "zs_voice")] + ZeroShotVoiceEmbedding, + + #[serde(rename = "model_weights")] + ModelWeights, + + /// Files that are uploaded with no general product area they belong to. (Eg. local dev testing) + #[serde(rename = "file_upload")] + FileUpload, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(IdCategory); + +/// NB: Legacy API for older code. +impl IdCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaFile => "media_file", + Self::LipsyncAnimationResult => "lipsync_animation", + Self::FaceFusionResult => "face_fusion", + Self::TtsResult => "tts_result", + Self::VoiceConversionResult => "voice_conversion", + Self::ZeroShotVoiceDataset => "zs_dataset", + Self::ZeroShotVoiceEmbedding => "zs_voice", + Self::ZeroShotTtsResult => "zs_tts_result", + Self::VideoFilterResult => "video_filter", + Self::LivePortraitResult => "live_portrait", + Self::StudioRender => "studio_render", + Self::ModelWeights => "model_weights", + Self::FileUpload => "file_upload", + Self::MocapResult => "mocap", + Self::WorkflowResult => "workflow", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_file" => Ok(Self::MediaFile), + "lipsync_animation" => Ok(Self::LipsyncAnimationResult), + "face_fusion" => Ok(Self::FaceFusionResult), + "tts_result" => Ok(Self::TtsResult), + "voice_conversion" => Ok(Self::VoiceConversionResult), + "zs_dataset" => Ok(Self::ZeroShotVoiceDataset), + "zs_voice" => Ok(Self::ZeroShotVoiceEmbedding), + "zs_tts_result" => Ok(Self::ZeroShotTtsResult), + "video_filter" => Ok(Self::VideoFilterResult), + "live_portrait" => Ok(Self::LivePortraitResult), + "studio_render" => Ok(Self::StudioRender), + "model_weights" => Ok(Self::ModelWeights), + "file_upload" => Ok(Self::FileUpload), + "mocap" => Ok(Self::MocapResult), + "workflow" => Ok(Self::WorkflowResult), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::MediaFile, + Self::LipsyncAnimationResult, + Self::FaceFusionResult, + Self::VideoFilterResult, + Self::LivePortraitResult, + Self::StudioRender, + Self::TtsResult, + Self::VoiceConversionResult, + Self::ZeroShotTtsResult, + Self::ZeroShotVoiceDataset, + Self::ZeroShotVoiceEmbedding, + Self::ModelWeights, + Self::FileUpload, + Self::MocapResult, + Self::WorkflowResult, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::generic_synthetic_ids::id_category::IdCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(IdCategory::MediaFile, "media_file"); + assert_serialization(IdCategory::LipsyncAnimationResult, "lipsync_animation"); + assert_serialization(IdCategory::FaceFusionResult, "face_fusion"); + assert_serialization(IdCategory::VideoFilterResult, "video_filter"); + assert_serialization(IdCategory::LivePortraitResult, "live_portrait"); + assert_serialization(IdCategory::StudioRender, "studio_render"); + assert_serialization(IdCategory::TtsResult, "tts_result"); + assert_serialization(IdCategory::VoiceConversionResult, "voice_conversion"); + assert_serialization(IdCategory::ZeroShotVoiceDataset, "zs_dataset"); + assert_serialization(IdCategory::ZeroShotVoiceEmbedding, "zs_voice"); + assert_serialization(IdCategory::ZeroShotTtsResult, "zs_tts_result"); + assert_serialization(IdCategory::ModelWeights, "model_weights"); + assert_serialization(IdCategory::FileUpload, "file_upload"); + assert_serialization(IdCategory::MocapResult, "mocap"); + assert_serialization(IdCategory::WorkflowResult, "workflow"); + } + + #[test] + fn to_str() { + assert_eq!(IdCategory::MediaFile.to_str(), "media_file"); + assert_eq!(IdCategory::LipsyncAnimationResult.to_str(), "lipsync_animation"); + assert_eq!(IdCategory::FaceFusionResult.to_str(), "face_fusion"); + assert_eq!(IdCategory::VideoFilterResult.to_str(), "video_filter"); + assert_eq!(IdCategory::LivePortraitResult.to_str(), "live_portrait"); + assert_eq!(IdCategory::StudioRender.to_str(), "studio_render"); + assert_eq!(IdCategory::TtsResult.to_str(), "tts_result"); + assert_eq!(IdCategory::VoiceConversionResult.to_str(), "voice_conversion"); + assert_eq!(IdCategory::ZeroShotVoiceDataset.to_str(), "zs_dataset"); + assert_eq!(IdCategory::ZeroShotVoiceEmbedding.to_str(), "zs_voice"); + assert_eq!(IdCategory::ZeroShotTtsResult.to_str(), "zs_tts_result"); + assert_eq!(IdCategory::ModelWeights.to_str(), "model_weights"); + assert_eq!(IdCategory::FileUpload.to_str(), "file_upload"); + assert_eq!(IdCategory::MocapResult.to_str(), "mocap"); + assert_eq!(IdCategory::WorkflowResult.to_str(), "workflow"); + } + + #[test] + fn from_str() { + assert_eq!(IdCategory::from_str("media_file").unwrap(), IdCategory::MediaFile); + assert_eq!(IdCategory::from_str("lipsync_animation").unwrap(), IdCategory::LipsyncAnimationResult); + assert_eq!(IdCategory::from_str("face_fusion").unwrap(), IdCategory::FaceFusionResult); + assert_eq!(IdCategory::from_str("video_filter").unwrap(), IdCategory::VideoFilterResult); + assert_eq!(IdCategory::from_str("live_portrait").unwrap(), IdCategory::LivePortraitResult); + assert_eq!(IdCategory::from_str("studio_render").unwrap(), IdCategory::StudioRender); + assert_eq!(IdCategory::from_str("tts_result").unwrap(), IdCategory::TtsResult); + assert_eq!(IdCategory::from_str("voice_conversion").unwrap(), IdCategory::VoiceConversionResult); + assert_eq!(IdCategory::from_str("zs_dataset").unwrap(), IdCategory::ZeroShotVoiceDataset); + assert_eq!(IdCategory::from_str("zs_voice").unwrap(), IdCategory::ZeroShotVoiceEmbedding); + assert_eq!(IdCategory::from_str("zs_tts_result").unwrap(), IdCategory::ZeroShotTtsResult); + assert_eq!(IdCategory::from_str("model_weights").unwrap(), IdCategory::ModelWeights); + assert_eq!(IdCategory::from_str("file_upload").unwrap(), IdCategory::FileUpload); + assert_eq!(IdCategory::from_str("mocap").unwrap(), IdCategory::MocapResult); + assert_eq!(IdCategory::from_str("workflow").unwrap(), IdCategory::WorkflowResult); + } + + #[test] + fn all_variants() { + // Static check + let mut variants = IdCategory::all_variants(); + assert_eq!(variants.len(), 15); + assert_eq!(variants.pop_first(), Some(IdCategory::MediaFile)); + assert_eq!(variants.pop_first(), Some(IdCategory::LipsyncAnimationResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::FaceFusionResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::VideoFilterResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::LivePortraitResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::StudioRender)); + assert_eq!(variants.pop_first(), Some(IdCategory::MocapResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::WorkflowResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::TtsResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::VoiceConversionResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::ZeroShotTtsResult)); + assert_eq!(variants.pop_first(), Some(IdCategory::ZeroShotVoiceDataset)); + assert_eq!(variants.pop_first(), Some(IdCategory::ZeroShotVoiceEmbedding)); + assert_eq!(variants.pop_first(), Some(IdCategory::ModelWeights)); + assert_eq!(variants.pop_first(), Some(IdCategory::FileUpload)); + assert_eq!(variants.pop_first(), None); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(IdCategory::all_variants().len(), IdCategory::iter().len()); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(IdCategory::all_variants().len(), IdCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in IdCategory::all_variants() { + assert_eq!(variant, IdCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, IdCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, IdCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/generic_synthetic_ids/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/generic_synthetic_ids/mod.rs new file mode 100644 index 00000000..17a815f8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/generic_synthetic_ids/mod.rs @@ -0,0 +1 @@ +pub mod id_category; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_animation_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_animation_type.rs new file mode 100644 index 00000000..dc1473ec --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_animation_type.rs @@ -0,0 +1,242 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileAnimationType { + /// Body: No body animation or rig. + /// Face: Rig supporting ARKit face blendshapes, or ARKit data + ArKit, + + /// Body: Animation or rig for MikuMikuDance (MMD). + /// Face: No face animation. + MikuMikuDance, + + /// Body: Animation or rig for MikuMikuDance (MMD). + /// Face: Animation blendshapes for ARKit. + MikuMikuDanceArKit, + + /// Body: Animation or rig for Mixamo + /// Face: No face animation. + Mixamo, + + /// Body: Animation or rig for Mixamo + /// Face: Animation blendshapes for ARKit. + MixamoArKit, + + /// Body: Animation or rig by MocapNet + /// Face: No face animation. + MocapNet, + + /// Body: Animation or rig for MocapNet + /// Face: Animation blendshapes for ARKit. + MocapNetArKit, + + /// Body: Animation or rig by Move.ai + /// Face: No face animation. + MoveAi, + + /// Body: Animation or rig for Move.ai + /// Face: Animation blendshapes for ARKit. + MoveAiArKit, + + /// Body: Animation or rig for Rigify. + /// Face: No face animation. + Rigify, + + /// Body: Animation or rig for Rigify. + /// Face: Animation blendshapes for ARKit. + RigifyArKit, + + /// Body: Animation or rig for Rokoko. + /// Face: No face animation. + Rokoko, + + /// Body: Animation or rig for Rokoko. + /// Face: Animation blendshapes for ARKit. + RokokoArKit, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileAnimationType); + +/// NB: Legacy API for older code. +impl MediaFileAnimationType { + pub fn to_str(&self) -> &'static str { + match self { + Self::ArKit => "ar_kit", + Self::MikuMikuDance => "miku_miku_dance", + Self::MikuMikuDanceArKit => "miku_miku_dance_ar_kit", + Self::Mixamo => "mixamo", + Self::MixamoArKit => "mixamo_ar_kit", + Self::MocapNet => "mocap_net", + Self::MocapNetArKit => "mocap_net_ar_kit", + Self::MoveAi => "move_ai", + Self::MoveAiArKit => "move_ai_ar_kit", + Self::Rigify => "rigify", + Self::RigifyArKit => "rigify_ar_kit", + Self::Rokoko => "rokoko", + Self::RokokoArKit => "rokoko_ar_kit", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "ar_kit" => Ok(Self::ArKit), + "miku_miku_dance" => Ok(Self::MikuMikuDance), + "miku_miku_dance_ar_kit" => Ok(Self::MikuMikuDanceArKit), + "mixamo" => Ok(Self::Mixamo), + "mixamo_ar_kit" => Ok(Self::MixamoArKit), + "mocap_net" => Ok(Self::MocapNet), + "mocap_net_ar_kit" => Ok(Self::MocapNetArKit), + "move_ai" => Ok(Self::MoveAi), + "move_ai_ar_kit" => Ok(Self::MoveAiArKit), + "rigify" => Ok(Self::Rigify), + "rigify_ar_kit" => Ok(Self::RigifyArKit), + "rokoko" => Ok(Self::Rokoko), + "rokoko_ar_kit" => Ok(Self::RokokoArKit), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ArKit, + Self::MikuMikuDance, + Self::MikuMikuDanceArKit, + Self::Mixamo, + Self::MixamoArKit, + Self::MocapNet, + Self::MocapNetArKit, + Self::MoveAi, + Self::MoveAiArKit, + Self::Rigify, + Self::RigifyArKit, + Self::Rokoko, + Self::RokokoArKit, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_animation_type::MediaFileAnimationType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileAnimationType::ArKit, "ar_kit"); + assert_serialization(MediaFileAnimationType::MikuMikuDance, "miku_miku_dance"); + assert_serialization(MediaFileAnimationType::MikuMikuDanceArKit, "miku_miku_dance_ar_kit"); + assert_serialization(MediaFileAnimationType::Mixamo, "mixamo"); + assert_serialization(MediaFileAnimationType::MixamoArKit, "mixamo_ar_kit"); + assert_serialization(MediaFileAnimationType::MocapNet, "mocap_net"); + assert_serialization(MediaFileAnimationType::MocapNetArKit, "mocap_net_ar_kit"); + assert_serialization(MediaFileAnimationType::MoveAi, "move_ai"); + assert_serialization(MediaFileAnimationType::MoveAiArKit, "move_ai_ar_kit"); + assert_serialization(MediaFileAnimationType::Rigify, "rigify"); + assert_serialization(MediaFileAnimationType::RigifyArKit, "rigify_ar_kit"); + assert_serialization(MediaFileAnimationType::Rokoko, "rokoko"); + assert_serialization(MediaFileAnimationType::RokokoArKit, "rokoko_ar_kit"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaFileAnimationType::ArKit.to_str(), "ar_kit"); + assert_eq!(MediaFileAnimationType::MikuMikuDance.to_str(), "miku_miku_dance"); + assert_eq!(MediaFileAnimationType::MikuMikuDanceArKit.to_str(), "miku_miku_dance_ar_kit"); + assert_eq!(MediaFileAnimationType::Mixamo.to_str(), "mixamo"); + assert_eq!(MediaFileAnimationType::MixamoArKit.to_str(), "mixamo_ar_kit"); + assert_eq!(MediaFileAnimationType::MocapNet.to_str(), "mocap_net"); + assert_eq!(MediaFileAnimationType::MocapNetArKit.to_str(), "mocap_net_ar_kit"); + assert_eq!(MediaFileAnimationType::MoveAi.to_str(), "move_ai"); + assert_eq!(MediaFileAnimationType::MoveAiArKit.to_str(), "move_ai_ar_kit"); + assert_eq!(MediaFileAnimationType::Rigify.to_str(), "rigify"); + assert_eq!(MediaFileAnimationType::RigifyArKit.to_str(), "rigify_ar_kit"); + assert_eq!(MediaFileAnimationType::Rokoko.to_str(), "rokoko"); + assert_eq!(MediaFileAnimationType::RokokoArKit.to_str(), "rokoko_ar_kit"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaFileAnimationType::from_str("ar_kit").unwrap(), MediaFileAnimationType::ArKit); + assert_eq!(MediaFileAnimationType::from_str("miku_miku_dance").unwrap(), MediaFileAnimationType::MikuMikuDance); + assert_eq!(MediaFileAnimationType::from_str("miku_miku_dance_ar_kit").unwrap(), MediaFileAnimationType::MikuMikuDanceArKit); + assert_eq!(MediaFileAnimationType::from_str("mixamo").unwrap(), MediaFileAnimationType::Mixamo); + assert_eq!(MediaFileAnimationType::from_str("mixamo_ar_kit").unwrap(), MediaFileAnimationType::MixamoArKit); + assert_eq!(MediaFileAnimationType::from_str("mocap_net").unwrap(), MediaFileAnimationType::MocapNet); + assert_eq!(MediaFileAnimationType::from_str("mocap_net_ar_kit").unwrap(), MediaFileAnimationType::MocapNetArKit); + assert_eq!(MediaFileAnimationType::from_str("move_ai").unwrap(), MediaFileAnimationType::MoveAi); + assert_eq!(MediaFileAnimationType::from_str("move_ai_ar_kit").unwrap(), MediaFileAnimationType::MoveAiArKit); + assert_eq!(MediaFileAnimationType::from_str("rigify").unwrap(), MediaFileAnimationType::Rigify); + assert_eq!(MediaFileAnimationType::from_str("rigify_ar_kit").unwrap(), MediaFileAnimationType::RigifyArKit); + assert_eq!(MediaFileAnimationType::from_str("rokoko").unwrap(), MediaFileAnimationType::Rokoko); + assert_eq!(MediaFileAnimationType::from_str("rokoko_ar_kit").unwrap(), MediaFileAnimationType::RokokoArKit); + assert!(MediaFileAnimationType::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = MediaFileAnimationType::all_variants(); + assert_eq!(variants.len(), 13); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::ArKit)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MikuMikuDance)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MikuMikuDanceArKit)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::Mixamo)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MixamoArKit)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MocapNet)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MocapNetArKit)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MoveAi)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::MoveAiArKit)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::Rigify)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::RigifyArKit)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::Rokoko)); + assert_eq!(variants.pop_first(), Some(MediaFileAnimationType::RokokoArKit)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileAnimationType::all_variants().len(), MediaFileAnimationType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileAnimationType::all_variants() { + assert_eq!(variant, MediaFileAnimationType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileAnimationType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileAnimationType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in MediaFileAnimationType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_class.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_class.rs new file mode 100644 index 00000000..134adcc5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_class.rs @@ -0,0 +1,191 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in a `VARCHAR(16)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileClass { + /// Unknown (default value) + /// This will be present until we migrate all old files. + Unknown, + + /// Audio files: wav, mp3, etc. + Audio, + + /// Image files: png, jpeg, etc. + Image, + + /// Video files: mp4, etc. + Video, + + /// 3D engine data: glb, gltf, etc. + /// Being split into `Mesh`, `Splat`, and `Project`. Do not write new records + /// with this value; it remains readable until existing rows are backfilled. + #[deprecated(note = "Split into Mesh, Splat, and Project. Read-only until backfilled.")] + Dimensional, + + /// 3D mesh assets: glb, gltf, fbx, obj, pmx, pmd, etc. + Mesh, + + /// Gaussian splats: spz, etc. + Splat, + + /// Internal Artcraft project documents (JSON): 3D editor scenes, mood boards, + /// graph workflows, video editor timelines, etc. + /// The specific kind is stored in `maybe_project_type`. + Project, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileClass); + +/// NB: Legacy API for older code. +impl MediaFileClass { + pub const fn to_str(&self) -> &'static str { + match self { + Self::Unknown => "unknown", + Self::Audio => "audio", + Self::Image => "image", + Self::Video => "video", + Self::Dimensional => "dimensional", + Self::Mesh => "mesh", + Self::Splat => "splat", + Self::Project => "project", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "unknown" => Ok(Self::Unknown), + "audio" => Ok(Self::Audio), + "image" => Ok(Self::Image), + "video" => Ok(Self::Video), + "dimensional" => Ok(Self::Dimensional), + "mesh" => Ok(Self::Mesh), + "splat" => Ok(Self::Splat), + "project" => Ok(Self::Project), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Unknown, + Self::Audio, + Self::Image, + Self::Video, + Self::Dimensional, + Self::Mesh, + Self::Splat, + Self::Project, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_class::MediaFileClass; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileClass::Unknown, "unknown"); + assert_serialization(MediaFileClass::Audio, "audio"); + assert_serialization(MediaFileClass::Image, "image"); + assert_serialization(MediaFileClass::Video, "video"); + assert_serialization(MediaFileClass::Dimensional, "dimensional"); + assert_serialization(MediaFileClass::Mesh, "mesh"); + assert_serialization(MediaFileClass::Splat, "splat"); + assert_serialization(MediaFileClass::Project, "project"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(MediaFileClass::Unknown.to_str(), "unknown"); + assert_eq!(MediaFileClass::Audio.to_str(), "audio"); + assert_eq!(MediaFileClass::Image.to_str(), "image"); + assert_eq!(MediaFileClass::Video.to_str(), "video"); + assert_eq!(MediaFileClass::Dimensional.to_str(), "dimensional"); + assert_eq!(MediaFileClass::Mesh.to_str(), "mesh"); + assert_eq!(MediaFileClass::Splat.to_str(), "splat"); + assert_eq!(MediaFileClass::Project.to_str(), "project"); + } + + #[test] + fn from_str() { + assert_eq!(MediaFileClass::from_str("unknown").unwrap(), MediaFileClass::Unknown); + assert_eq!(MediaFileClass::from_str("audio").unwrap(), MediaFileClass::Audio); + assert_eq!(MediaFileClass::from_str("image").unwrap(), MediaFileClass::Image); + assert_eq!(MediaFileClass::from_str("video").unwrap(), MediaFileClass::Video); + assert_eq!(MediaFileClass::from_str("dimensional").unwrap(), MediaFileClass::Dimensional); + assert_eq!(MediaFileClass::from_str("mesh").unwrap(), MediaFileClass::Mesh); + assert_eq!(MediaFileClass::from_str("splat").unwrap(), MediaFileClass::Splat); + assert_eq!(MediaFileClass::from_str("project").unwrap(), MediaFileClass::Project); + assert!(MediaFileClass::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = MediaFileClass::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Unknown)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Audio)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Image)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Video)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Dimensional)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Mesh)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Splat)); + assert_eq!(variants.pop_first(), Some(MediaFileClass::Project)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileClass::all_variants().len(), MediaFileClass::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileClass::all_variants() { + assert_eq!(variant, MediaFileClass::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileClass::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileClass::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in MediaFileClass::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_engine_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_engine_category.rs new file mode 100644 index 00000000..ce97d13f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_engine_category.rs @@ -0,0 +1,216 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileEngineCategory { + /// A 3D scene full of objects, characters, animations, etc. + Scene, + + /// A 3D character model. + Character, + + /// A 3D non-humanoid model, e.g. dragon, wolf, slime creature, etc. + /// These may or may not have a skeleton that can be animated with IK/FK. + Creature, + + /// A 3D skeletal animation sequence that can be applied to a character, + /// creature, etc. Typically, these use Mixamo or Move.ai. + Animation, + + /// A facial blend shape / shape key animation. Currently, these + /// are 100% ARKit. + Expression, + + /// A large 3D object that can be used as a backdrop for a scene, + /// a.k.a. "set", "stage", etc. These are typically self-contained + /// locations, buildings, or environments. + Location, + + /// All items used to add atmosphere to a scene, e.g. furniture, plants, + /// vehicles, radios, and certain props. (We'll reserve the word props for + /// "hand props" later.) + SetDressing, + + /// A 3D object that doesn't fit with the other types. + Object, + + /// A 3D skybox. + Skybox, + + /// An Image Plane (texture that spawns as an object) + ImagePlane, + + /// A Video Plane (texture that spawns as an object) + VideoPlane, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileEngineCategory); + +/// NB: Legacy API for older code. +impl MediaFileEngineCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::Scene => "scene", + Self::Character => "character", + Self::Creature => "creature", + Self::Animation => "animation", + Self::Expression => "expression", + Self::Location => "location", + Self::SetDressing => "set_dressing", + Self::Object => "object", + Self::Skybox => "skybox", + Self::ImagePlane => "image_plane", + Self::VideoPlane => "video_plane", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "scene" => Ok(Self::Scene), + "character" => Ok(Self::Character), + "creature" => Ok(Self::Creature), + "animation" => Ok(Self::Animation), + "expression" => Ok(Self::Expression), + "location" => Ok(Self::Location), + "set_dressing" => Ok(Self::SetDressing), + "object" => Ok(Self::Object), + "skybox" => Ok(Self::Skybox), + "image_plane" => Ok(Self::ImagePlane), + "video_plane" => Ok(Self::VideoPlane), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Scene, + Self::Character, + Self::Creature, + Self::Animation, + Self::Expression, + Self::Location, + Self::SetDressing, + Self::Object, + Self::Skybox, + Self::ImagePlane, + Self::VideoPlane, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_engine_category::MediaFileEngineCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileEngineCategory::Scene, "scene"); + assert_serialization(MediaFileEngineCategory::Character, "character"); + assert_serialization(MediaFileEngineCategory::Creature, "creature"); + assert_serialization(MediaFileEngineCategory::Animation, "animation"); + assert_serialization(MediaFileEngineCategory::Expression, "expression"); + assert_serialization(MediaFileEngineCategory::Location, "location"); + assert_serialization(MediaFileEngineCategory::SetDressing, "set_dressing"); + assert_serialization(MediaFileEngineCategory::Object, "object"); + assert_serialization(MediaFileEngineCategory::Skybox, "skybox"); + assert_serialization(MediaFileEngineCategory::ImagePlane, "image_plane"); + assert_serialization(MediaFileEngineCategory::VideoPlane, "video_plane"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaFileEngineCategory::Scene.to_str(), "scene"); + assert_eq!(MediaFileEngineCategory::Character.to_str(), "character"); + assert_eq!(MediaFileEngineCategory::Creature.to_str(), "creature"); + assert_eq!(MediaFileEngineCategory::Animation.to_str(), "animation"); + assert_eq!(MediaFileEngineCategory::Expression.to_str(), "expression"); + assert_eq!(MediaFileEngineCategory::Location.to_str(), "location"); + assert_eq!(MediaFileEngineCategory::SetDressing.to_str(), "set_dressing"); + assert_eq!(MediaFileEngineCategory::Object.to_str(), "object"); + assert_eq!(MediaFileEngineCategory::Skybox.to_str(), "skybox"); + assert_eq!(MediaFileEngineCategory::ImagePlane.to_str(), "image_plane"); + assert_eq!(MediaFileEngineCategory::VideoPlane.to_str(), "video_plane"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaFileEngineCategory::from_str("scene").unwrap(), MediaFileEngineCategory::Scene); + assert_eq!(MediaFileEngineCategory::from_str("character").unwrap(), MediaFileEngineCategory::Character); + assert_eq!(MediaFileEngineCategory::from_str("creature").unwrap(), MediaFileEngineCategory::Creature); + assert_eq!(MediaFileEngineCategory::from_str("animation").unwrap(), MediaFileEngineCategory::Animation); + assert_eq!(MediaFileEngineCategory::from_str("expression").unwrap(), MediaFileEngineCategory::Expression); + assert_eq!(MediaFileEngineCategory::from_str("location").unwrap(), MediaFileEngineCategory::Location); + assert_eq!(MediaFileEngineCategory::from_str("set_dressing").unwrap(), MediaFileEngineCategory::SetDressing); + assert_eq!(MediaFileEngineCategory::from_str("object").unwrap(), MediaFileEngineCategory::Object); + assert_eq!(MediaFileEngineCategory::from_str("skybox").unwrap(), MediaFileEngineCategory::Skybox); + assert_eq!(MediaFileEngineCategory::from_str("image_plane").unwrap(), MediaFileEngineCategory::ImagePlane); + assert_eq!(MediaFileEngineCategory::from_str("video_plane").unwrap(), MediaFileEngineCategory::VideoPlane); + assert!(MediaFileEngineCategory::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = MediaFileEngineCategory::all_variants(); + assert_eq!(variants.len(), 11); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Scene)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Character)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Creature)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Animation)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Expression)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Location)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::SetDressing)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Object)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::Skybox)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::ImagePlane)); + assert_eq!(variants.pop_first(), Some(MediaFileEngineCategory::VideoPlane)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileEngineCategory::all_variants().len(), MediaFileEngineCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileEngineCategory::all_variants() { + assert_eq!(variant, MediaFileEngineCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileEngineCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileEngineCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in MediaFileEngineCategory::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_category.rs new file mode 100644 index 00000000..1a4f57fb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_category.rs @@ -0,0 +1,172 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileOriginCategory { + /// ML model inference output - uploaded models or zero shot. + Inference, + + /// Third-party inference output (e.g. FAL, Replicate). + /// The file was generated by a third-party AI service and uploaded by the client. + #[serde(rename = "inference3rd")] + ThirdPartyInference, + + /// Processed results - (we don't have these systems yet, but eg. trim, transcode, etc). + Processed, + + /// User uploaded files (from their filesystem) + Upload, + + /// User uploaded files recorded directly from their device (browser, mobile), typically using device APIs. + DeviceApi, + + /// From Storyteller Studio Engine + #[deprecated(note="This db field should only denote file provenance, not the product.")] + #[serde(rename = "studio")] + StorytellerStudio, + + /// From Storyteller Studio Engine + #[deprecated(note = "DO NOT USE. Originally deprecated in favor of `StorytellerStudio`.")] + StoryEngine, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileOriginCategory); + +/// NB: Legacy API for older code. +impl MediaFileOriginCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::Inference => "inference", + Self::ThirdPartyInference => "inference3rd", + Self::Processed => "processed", + Self::Upload => "upload", + Self::DeviceApi => "device_api", + Self::StorytellerStudio => "studio", + Self::StoryEngine => "story_engine", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "inference" => Ok(Self::Inference), + "inference3rd" => Ok(Self::ThirdPartyInference), + "processed" => Ok(Self::Processed), + "upload" => Ok(Self::Upload), + "device_api" => Ok(Self::DeviceApi), + "studio" => Ok(Self::StorytellerStudio), + "story_engine" => Ok(Self::StoryEngine), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Inference, + Self::ThirdPartyInference, + Self::Processed, + Self::Upload, + Self::DeviceApi, + Self::StorytellerStudio, + Self::StoryEngine, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_origin_category::MediaFileOriginCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileOriginCategory::Inference, "inference"); + assert_serialization(MediaFileOriginCategory::ThirdPartyInference, "inference3rd"); + assert_serialization(MediaFileOriginCategory::Processed, "processed"); + assert_serialization(MediaFileOriginCategory::Upload, "upload"); + assert_serialization(MediaFileOriginCategory::DeviceApi, "device_api"); + assert_serialization(MediaFileOriginCategory::StorytellerStudio, "studio"); + assert_serialization(MediaFileOriginCategory::StoryEngine, "story_engine"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaFileOriginCategory::Inference.to_str(), "inference"); + assert_eq!(MediaFileOriginCategory::ThirdPartyInference.to_str(), "inference3rd"); + assert_eq!(MediaFileOriginCategory::Processed.to_str(), "processed"); + assert_eq!(MediaFileOriginCategory::Upload.to_str(), "upload"); + assert_eq!(MediaFileOriginCategory::DeviceApi.to_str(), "device_api"); + assert_eq!(MediaFileOriginCategory::StorytellerStudio.to_str(), "studio"); + assert_eq!(MediaFileOriginCategory::StoryEngine.to_str(), "story_engine"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaFileOriginCategory::from_str("inference").unwrap(), MediaFileOriginCategory::Inference); + assert_eq!(MediaFileOriginCategory::from_str("inference3rd").unwrap(), MediaFileOriginCategory::ThirdPartyInference); + assert_eq!(MediaFileOriginCategory::from_str("processed").unwrap(), MediaFileOriginCategory::Processed); + assert_eq!(MediaFileOriginCategory::from_str("upload").unwrap(), MediaFileOriginCategory::Upload); + assert_eq!(MediaFileOriginCategory::from_str("device_api").unwrap(), MediaFileOriginCategory::DeviceApi); + assert_eq!(MediaFileOriginCategory::from_str("studio").unwrap(), MediaFileOriginCategory::StorytellerStudio); + assert_eq!(MediaFileOriginCategory::from_str("story_engine").unwrap(), MediaFileOriginCategory::StoryEngine); + assert!(MediaFileOriginCategory::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = MediaFileOriginCategory::all_variants(); + assert_eq!(variants.len(), 7); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::Inference)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::ThirdPartyInference)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::Processed)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::Upload)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::DeviceApi)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::StorytellerStudio)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginCategory::StoryEngine)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileOriginCategory::all_variants().len(), MediaFileOriginCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileOriginCategory::all_variants() { + assert_eq!(variant, MediaFileOriginCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileOriginCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileOriginCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in MediaFileOriginCategory::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_model_type.rs new file mode 100644 index 00000000..a5a71b77 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_model_type.rs @@ -0,0 +1,269 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileOriginModelType { + #[serde(rename = "face_fusion")] + FaceFusion, + + #[serde(rename = "f5_tts")] + F5TTS, + + #[serde(rename = "live_portrait")] + LivePortrait, + + /// RVC (v2) voice conversion models + #[serde(rename = "rvc_v2")] + RvcV2, + + /// SadTalker -- v1, we may add another enum value for future versions + #[serde(rename = "sad_talker")] + SadTalker, + + /// so-vits-svc voice conversion models + #[serde(rename = "so_vits_svc")] + SoVitsSvc, + + #[serde(rename = "tacotron2")] + Tacotron2, + + #[serde(rename = "mocap_net")] + MocapNet, + + #[serde(rename = "seed_vc")] + SeedVc, + + #[serde(rename = "styletts2")] + StyleTTS2, + + #[serde(rename = "stable_diffusion_1_5")] + StableDiffusion15, + + #[serde(rename = "gpt_sovits")] + GptSovits, + + #[serde(rename = "studio")] + StorytellerStudio, + + #[serde(rename = "studio_ig")] + StorytellerStudioImageGen, + + #[serde(rename = "vst")] + VideoStyleTransfer, + + #[deprecated(note = "This is not a model type!")] + #[serde(rename = "comfy_ui")] + ComfyUi, + + #[deprecated(note = "We don't use this anymore")] + #[serde(rename = "vall_e_x")] + VallEX, + + #[deprecated(note = "We don't use this anymore")] + #[serde(rename = "rerender")] + Rerender, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileOriginModelType); + +/// NB: Legacy API for older code. +impl MediaFileOriginModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::FaceFusion => "face_fusion", + Self::F5TTS => "f5_tts", + Self::LivePortrait => "live_portrait", + Self::RvcV2 => "rvc_v2", + Self::SadTalker => "sad_talker", + Self::SeedVc => "seed_vc", + Self::SoVitsSvc => "so_vits_svc", + Self::Tacotron2 => "tacotron2", + Self::MocapNet => "mocap_net", + Self::StyleTTS2 => "styletts2", + Self::StableDiffusion15 => "stable_diffusion_1_5", + Self::StorytellerStudioImageGen => "studio_ig", + Self::GptSovits => "gpt_sovits", + Self::StorytellerStudio => "studio", + Self::VideoStyleTransfer => "vst", + Self::ComfyUi => "comfy_ui", + Self::VallEX => "vall_e_x", + Self::Rerender => "rerender", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "face_fusion" => Ok(Self::FaceFusion), + "f5_tts" => Ok(Self::F5TTS), + "live_portrait" => Ok(Self::LivePortrait), + "rvc_v2" => Ok(Self::RvcV2), + "sad_talker" => Ok(Self::SadTalker), + "seed_vc" => Ok(Self::SeedVc), + "so_vits_svc" => Ok(Self::SoVitsSvc), + "tacotron2" => Ok(Self::Tacotron2), + "mocap_net" => Ok(Self::MocapNet), + "styletts2" => Ok(Self::StyleTTS2), + "stable_diffusion_1_5" => Ok(Self::StableDiffusion15), + "studio_ig" => Ok(Self::StorytellerStudioImageGen), + "gpt_sovits" => Ok(Self::GptSovits), + "studio" => Ok(Self::StorytellerStudio), + "vst" => Ok(Self::VideoStyleTransfer), + "comfy_ui" => Ok(Self::ComfyUi), + "vall_e_x" => Ok(Self::VallEX), + "rerender" => Ok(Self::Rerender), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::FaceFusion, + Self::F5TTS, + Self::LivePortrait, + Self::RvcV2, + Self::SadTalker, + Self::SeedVc, + Self::SoVitsSvc, + Self::Tacotron2, + Self::MocapNet, + Self::StyleTTS2, + Self::StableDiffusion15, + Self::GptSovits, + Self::StorytellerStudio, + Self::StorytellerStudioImageGen, + Self::VideoStyleTransfer, + Self::ComfyUi, + Self::VallEX, + Self::Rerender, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_origin_model_type::MediaFileOriginModelType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileOriginModelType::FaceFusion, "face_fusion"); + assert_serialization(MediaFileOriginModelType::SadTalker, "sad_talker"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaFileOriginModelType::FaceFusion.to_str(), "face_fusion"); + assert_eq!(MediaFileOriginModelType::F5TTS.to_str(), "f5_tts"); + assert_eq!(MediaFileOriginModelType::LivePortrait.to_str(), "live_portrait"); + assert_eq!(MediaFileOriginModelType::RvcV2.to_str(), "rvc_v2"); + assert_eq!(MediaFileOriginModelType::SadTalker.to_str(), "sad_talker"); + assert_eq!(MediaFileOriginModelType::SeedVc.to_str(), "seed_vc"); + assert_eq!(MediaFileOriginModelType::SoVitsSvc.to_str(), "so_vits_svc"); + assert_eq!(MediaFileOriginModelType::Tacotron2.to_str(), "tacotron2"); + assert_eq!(MediaFileOriginModelType::MocapNet.to_str(), "mocap_net"); + assert_eq!(MediaFileOriginModelType::StyleTTS2.to_str(), "styletts2"); + assert_eq!(MediaFileOriginModelType::StableDiffusion15.to_str(), "stable_diffusion_1_5"); + assert_eq!(MediaFileOriginModelType::GptSovits.to_str(), "gpt_sovits"); + assert_eq!(MediaFileOriginModelType::StorytellerStudio.to_str(), "studio"); + assert_eq!(MediaFileOriginModelType::VideoStyleTransfer.to_str(), "vst"); + assert_eq!(MediaFileOriginModelType::ComfyUi.to_str(), "comfy_ui"); + assert_eq!(MediaFileOriginModelType::VallEX.to_str(), "vall_e_x"); + assert_eq!(MediaFileOriginModelType::Rerender.to_str(), "rerender"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaFileOriginModelType::from_str("face_fusion").unwrap(), MediaFileOriginModelType::FaceFusion); + assert_eq!(MediaFileOriginModelType::from_str("f5_tts").unwrap(), MediaFileOriginModelType::F5TTS); + assert_eq!(MediaFileOriginModelType::from_str("live_portrait").unwrap(), MediaFileOriginModelType::LivePortrait); + assert_eq!(MediaFileOriginModelType::from_str("rvc_v2").unwrap(), MediaFileOriginModelType::RvcV2); + assert_eq!(MediaFileOriginModelType::from_str("sad_talker").unwrap(), MediaFileOriginModelType::SadTalker); + assert_eq!(MediaFileOriginModelType::from_str("seed_vc").unwrap(), MediaFileOriginModelType::SeedVc); + assert_eq!(MediaFileOriginModelType::from_str("so_vits_svc").unwrap(), MediaFileOriginModelType::SoVitsSvc); + assert_eq!(MediaFileOriginModelType::from_str("tacotron2").unwrap(), MediaFileOriginModelType::Tacotron2); + assert_eq!(MediaFileOriginModelType::from_str("mocap_net").unwrap(), MediaFileOriginModelType::MocapNet); + assert_eq!(MediaFileOriginModelType::from_str("styletts2").unwrap(), MediaFileOriginModelType::StyleTTS2); + assert_eq!(MediaFileOriginModelType::from_str("stable_diffusion_1_5").unwrap(), MediaFileOriginModelType::StableDiffusion15); + assert_eq!(MediaFileOriginModelType::from_str("gpt_sovits").unwrap(), MediaFileOriginModelType::GptSovits); + assert_eq!(MediaFileOriginModelType::from_str("studio").unwrap(), MediaFileOriginModelType::StorytellerStudio); + assert_eq!(MediaFileOriginModelType::from_str("vst").unwrap(), MediaFileOriginModelType::VideoStyleTransfer); + assert_eq!(MediaFileOriginModelType::from_str("comfy_ui").unwrap(), MediaFileOriginModelType::ComfyUi); + assert_eq!(MediaFileOriginModelType::from_str("vall_e_x").unwrap(), MediaFileOriginModelType::VallEX); + assert_eq!(MediaFileOriginModelType::from_str("rerender").unwrap(), MediaFileOriginModelType::Rerender); + assert!(MediaFileOriginModelType::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = MediaFileOriginModelType::all_variants(); + assert_eq!(variants.len(), 18); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::FaceFusion)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::F5TTS)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::LivePortrait)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::RvcV2)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::SadTalker)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::SoVitsSvc)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::Tacotron2)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::MocapNet)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::SeedVc)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::StyleTTS2)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::StableDiffusion15)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::GptSovits)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::StorytellerStudio)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::StorytellerStudioImageGen)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::VideoStyleTransfer)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::ComfyUi)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::VallEX)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginModelType::Rerender)); + assert_eq!(variants.pop_first(), None); + } + } + + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileOriginModelType::all_variants().len(), MediaFileOriginModelType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileOriginModelType::all_variants() { + assert_eq!(variant, MediaFileOriginModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileOriginModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileOriginModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + // NB: The media_files table has allocated width for VARCHAR(32), but let's slim it down to 24. + const MAX_LENGTH : usize = 24; + for variant in MediaFileOriginModelType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_product_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_product_category.rs new file mode 100644 index 00000000..8567f9aa --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_origin_product_category.rs @@ -0,0 +1,287 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in `VARCHAR(16)` field `origin_product_category`. +/// +/// This value indicates what product originally created the media file. (Not the ML model or +/// user upload process.) This will let us scope media files to the product that generated them +/// and filter them out of unrelated products if necessary (eg. a user probably doesn't want +/// "Voice Designer" dataset samples in a video generation flow.) +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum MediaFileOriginProductCategory { + /// Unknown which product is attached to the file (generated the file, the file was + /// uploaded on behalf of, etc.) + #[serde(rename = "unknown")] + Unknown, + + /// Media files created by (or uploaded for) the Face Animator product. + /// The underlying model could be SadTalker, Wav2Lip, or some future model + #[serde(rename = "face_animator")] + FaceAnimator, + + /// Media files created by Face Fusion (lipsync) + #[serde(rename = "face_fusion")] + FaceFusion, + + /// Media files created by Face Mirror (currently powered by Live Portrait) + #[serde(rename = "face_mirror")] + FaceMirror, + + /// Video style transfer + #[serde(rename = "vst")] + VideoStyleTransfer, + + /// Image Studio + #[serde(rename = "image_studio")] + ImageStudio, + + /// Storyteller Studio + #[serde(rename = "studio")] + StorytellerStudio, + + /// Text to speech (Tacotron2, not voice designer / VallE-X) + #[serde(rename = "tts")] + TextToSpeech, + + /// Voice conversion (either RVC or SVC) + #[serde(rename = "voice_conversion")] + VoiceConversion, + + /// Media files created by (or uploaded for) the Zero Shot voice product. + #[serde(rename = "zs_voice")] + ZeroShotVoice, + + // Mocap + #[serde(rename = "mocap")] + Mocap, + + #[serde(rename = "image_gen")] + ImageGeneration, + + #[serde(rename = "video_gen")] + VideoGeneration, + + #[serde(rename = "video_edit")] + VideoEdit, + + #[serde(rename = "world_gen")] + WorldGeneration, + + // Media files for video filters + #[deprecated(note = "This isn't relevant product surface area anymore")] + #[serde(rename = "video_filter")] + VideoFilter, + + // Workflow + #[deprecated(note = "Use studio and VST instead.")] + #[serde(rename = "workflow")] + Workflow, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileOriginProductCategory); + +/// NB: Legacy API for older code. +impl MediaFileOriginProductCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::Unknown => "unknown", + Self::FaceAnimator => "face_animator", + Self::FaceFusion => "face_fusion", + Self::FaceMirror => "face_mirror", + Self::VideoStyleTransfer => "vst", + Self::ImageStudio => "image_studio", + Self::StorytellerStudio => "studio", + Self::TextToSpeech => "tts", + Self::VoiceConversion => "voice_conversion", + Self::ZeroShotVoice => "zs_voice", + Self::Mocap => "mocap", + Self::ImageGeneration => "image_gen", + Self::VideoGeneration => "video_gen", + Self::VideoEdit => "video_edit", + Self::WorldGeneration => "world_gen", + Self::VideoFilter => "video_filter", + Self::Workflow => "workflow", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "unknown" => Ok(Self::Unknown), + "face_animator" => Ok(Self::FaceAnimator), + "face_fusion" => Ok(Self::FaceFusion), + "face_mirror" => Ok(Self::FaceMirror), + "vst" => Ok(Self::VideoStyleTransfer), + "image_studio" => Ok(Self::ImageStudio), + "studio" => Ok(Self::StorytellerStudio), + "tts" => Ok(Self::TextToSpeech), + "voice_conversion" => Ok(Self::VoiceConversion), + "zs_voice" => Ok(Self::ZeroShotVoice), + "mocap" => Ok(Self::Mocap), + "image_gen" => Ok(Self::ImageGeneration), + "video_gen" => Ok(Self::VideoGeneration), + "video_edit" => Ok(Self::VideoEdit), + "world_gen" => Ok(Self::WorldGeneration), + "video_filter" => Ok(Self::VideoFilter), + "workflow" => Ok(Self::Workflow), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Unknown, + Self::FaceAnimator, + Self::FaceFusion, + Self::FaceMirror, + Self::VideoStyleTransfer, + Self::ImageStudio, + Self::StorytellerStudio, + Self::TextToSpeech, + Self::VoiceConversion, + Self::ZeroShotVoice, + Self::Mocap, + Self::ImageGeneration, + Self::VideoGeneration, + Self::VideoEdit, + Self::WorldGeneration, + Self::VideoFilter, + Self::Workflow, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_origin_product_category::MediaFileOriginProductCategory; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileOriginProductCategory::Unknown, "unknown"); + assert_serialization(MediaFileOriginProductCategory::FaceAnimator, "face_animator"); + assert_serialization(MediaFileOriginProductCategory::FaceFusion, "face_fusion"); + assert_serialization(MediaFileOriginProductCategory::FaceMirror, "face_mirror"); + assert_serialization(MediaFileOriginProductCategory::VideoStyleTransfer, "vst"); + assert_serialization(MediaFileOriginProductCategory::ImageStudio, "image_studio"); + assert_serialization(MediaFileOriginProductCategory::StorytellerStudio, "studio"); + assert_serialization(MediaFileOriginProductCategory::TextToSpeech, "tts"); + assert_serialization(MediaFileOriginProductCategory::VoiceConversion, "voice_conversion"); + assert_serialization(MediaFileOriginProductCategory::ZeroShotVoice, "zs_voice"); + assert_serialization(MediaFileOriginProductCategory::Mocap, "mocap"); + assert_serialization(MediaFileOriginProductCategory::ImageGeneration, "image_gen"); + assert_serialization(MediaFileOriginProductCategory::VideoGeneration, "video_gen"); + assert_serialization(MediaFileOriginProductCategory::VideoEdit, "video_edit"); + assert_serialization(MediaFileOriginProductCategory::WorldGeneration, "world_gen"); + assert_serialization(MediaFileOriginProductCategory::VideoFilter, "video_filter"); + assert_serialization(MediaFileOriginProductCategory::Workflow, "workflow"); + } + + #[test] + fn to_str() { + assert_eq!(MediaFileOriginProductCategory::Unknown.to_str(), "unknown"); + assert_eq!(MediaFileOriginProductCategory::FaceAnimator.to_str(), "face_animator"); + assert_eq!(MediaFileOriginProductCategory::FaceFusion.to_str(), "face_fusion"); + assert_eq!(MediaFileOriginProductCategory::FaceMirror.to_str(), "face_mirror"); + assert_eq!(MediaFileOriginProductCategory::VideoStyleTransfer.to_str(), "vst"); + assert_eq!(MediaFileOriginProductCategory::ImageStudio.to_str(), "image_studio"); + assert_eq!(MediaFileOriginProductCategory::StorytellerStudio.to_str(), "studio"); + assert_eq!(MediaFileOriginProductCategory::TextToSpeech.to_str(), "tts"); + assert_eq!(MediaFileOriginProductCategory::VoiceConversion.to_str(), "voice_conversion"); + assert_eq!(MediaFileOriginProductCategory::ZeroShotVoice.to_str(), "zs_voice"); + assert_eq!(MediaFileOriginProductCategory::Mocap.to_str(), "mocap"); + assert_eq!(MediaFileOriginProductCategory::ImageGeneration.to_str(), "image_gen"); + assert_eq!(MediaFileOriginProductCategory::VideoGeneration.to_str(), "video_gen"); + assert_eq!(MediaFileOriginProductCategory::VideoEdit.to_str(), "video_edit"); + assert_eq!(MediaFileOriginProductCategory::WorldGeneration.to_str(), "world_gen"); + assert_eq!(MediaFileOriginProductCategory::VideoFilter.to_str(), "video_filter"); + assert_eq!(MediaFileOriginProductCategory::Workflow.to_str(), "workflow"); + } + + #[test] + fn from_str() { + assert_eq!(MediaFileOriginProductCategory::from_str("unknown").unwrap(), MediaFileOriginProductCategory::Unknown); + assert_eq!(MediaFileOriginProductCategory::from_str("face_animator").unwrap(), MediaFileOriginProductCategory::FaceAnimator); + assert_eq!(MediaFileOriginProductCategory::from_str("face_fusion").unwrap(), MediaFileOriginProductCategory::FaceFusion); + assert_eq!(MediaFileOriginProductCategory::from_str("face_mirror").unwrap(), MediaFileOriginProductCategory::FaceMirror); + assert_eq!(MediaFileOriginProductCategory::from_str("vst").unwrap(), MediaFileOriginProductCategory::VideoStyleTransfer); + assert_eq!(MediaFileOriginProductCategory::from_str("image_studio").unwrap(), MediaFileOriginProductCategory::ImageStudio); + assert_eq!(MediaFileOriginProductCategory::from_str("studio").unwrap(), MediaFileOriginProductCategory::StorytellerStudio); + assert_eq!(MediaFileOriginProductCategory::from_str("tts").unwrap(), MediaFileOriginProductCategory::TextToSpeech); + assert_eq!(MediaFileOriginProductCategory::from_str("voice_conversion").unwrap(), MediaFileOriginProductCategory::VoiceConversion); + assert_eq!(MediaFileOriginProductCategory::from_str("zs_voice").unwrap(), MediaFileOriginProductCategory::ZeroShotVoice); + assert_eq!(MediaFileOriginProductCategory::from_str("mocap").unwrap(), MediaFileOriginProductCategory::Mocap); + assert_eq!(MediaFileOriginProductCategory::from_str("image_gen").unwrap(),MediaFileOriginProductCategory::ImageGeneration); + assert_eq!(MediaFileOriginProductCategory::from_str("video_gen").unwrap(), MediaFileOriginProductCategory::VideoGeneration); + assert_eq!(MediaFileOriginProductCategory::from_str("video_edit").unwrap(), MediaFileOriginProductCategory::VideoEdit); + assert_eq!(MediaFileOriginProductCategory::from_str("world_gen").unwrap(), MediaFileOriginProductCategory::WorldGeneration); + assert_eq!(MediaFileOriginProductCategory::from_str("video_filter").unwrap(), MediaFileOriginProductCategory::VideoFilter); + assert_eq!(MediaFileOriginProductCategory::from_str("workflow").unwrap(), MediaFileOriginProductCategory::Workflow); + } + + #[test] + fn all_variants() { + let mut variants = MediaFileOriginProductCategory::all_variants(); + assert_eq!(variants.len(), 17); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::Unknown)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::FaceAnimator)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::FaceFusion)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::FaceMirror)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::VideoStyleTransfer)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::ImageStudio)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::StorytellerStudio)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::TextToSpeech)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::VoiceConversion)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::ZeroShotVoice)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::Mocap)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::ImageGeneration)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::VideoGeneration)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::VideoEdit)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::WorldGeneration)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::VideoFilter)); + assert_eq!(variants.pop_first(), Some(MediaFileOriginProductCategory::Workflow)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileOriginProductCategory::all_variants().len(), MediaFileOriginProductCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileOriginProductCategory::all_variants() { + assert_eq!(variant, MediaFileOriginProductCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileOriginProductCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileOriginProductCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in MediaFileOriginProductCategory::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_project_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_project_type.rs new file mode 100644 index 00000000..9a060c40 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_project_type.rs @@ -0,0 +1,165 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in the nullable `maybe_project_type` +/// VARCHAR(32) field. +/// +/// Identifies which kind of internal Artcraft project document a media file is. +/// Only set when `media_class = 'project'`. The file format lives in +/// `media_type` (`json` / legacy `scene_json`); the JSON payload carries its +/// own schema version. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileProjectType { + /// 3D editor scene descriptor: objects with locations, skyboxes, animations, + /// etc. — a full editable 3D scene. + /// NB: serde's snake_case renames this to "scene3d" (no underscore before + /// the digit), so the rename must be explicit. + #[serde(rename = "scene_3d")] + Scene3d, + + /// Mood board: a collection of images on a lightweight graph. + MoodBoard, + + /// Graph workflow: a node-graph pipeline of image and video generation steps. + Workflow, + + /// Video editor project: a nonlinear video editing timeline. + VideoTimeline, + + /// 2D editor project: a 2D image editing document. + /// NB: serde's snake_case renames this to "editor2d" (no underscore before + /// the digit), so the rename must be explicit. + #[serde(rename = "editor_2d")] + Editor2d, +} + +impl_enum_display_and_debug_using_to_str!(MediaFileProjectType); + +impl MediaFileProjectType { + pub const fn to_str(&self) -> &'static str { + match self { + Self::Scene3d => "scene_3d", + Self::MoodBoard => "mood_board", + Self::Workflow => "workflow", + Self::VideoTimeline => "video_timeline", + Self::Editor2d => "editor_2d", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "scene_3d" => Ok(Self::Scene3d), + "mood_board" => Ok(Self::MoodBoard), + "workflow" => Ok(Self::Workflow), + "video_timeline" => Ok(Self::VideoTimeline), + "editor_2d" => Ok(Self::Editor2d), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + BTreeSet::from([ + Self::Scene3d, + Self::MoodBoard, + Self::Workflow, + Self::VideoTimeline, + Self::Editor2d, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_project_type::MediaFileProjectType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileProjectType::Scene3d, "scene_3d"); + assert_serialization(MediaFileProjectType::MoodBoard, "mood_board"); + assert_serialization(MediaFileProjectType::Workflow, "workflow"); + assert_serialization(MediaFileProjectType::VideoTimeline, "video_timeline"); + assert_serialization(MediaFileProjectType::Editor2d, "editor_2d"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(MediaFileProjectType::Scene3d.to_str(), "scene_3d"); + assert_eq!(MediaFileProjectType::MoodBoard.to_str(), "mood_board"); + assert_eq!(MediaFileProjectType::Workflow.to_str(), "workflow"); + assert_eq!(MediaFileProjectType::VideoTimeline.to_str(), "video_timeline"); + assert_eq!(MediaFileProjectType::Editor2d.to_str(), "editor_2d"); + } + + #[test] + fn from_str() { + assert_eq!(MediaFileProjectType::from_str("scene_3d").unwrap(), MediaFileProjectType::Scene3d); + assert_eq!(MediaFileProjectType::from_str("mood_board").unwrap(), MediaFileProjectType::MoodBoard); + assert_eq!(MediaFileProjectType::from_str("workflow").unwrap(), MediaFileProjectType::Workflow); + assert_eq!(MediaFileProjectType::from_str("video_timeline").unwrap(), MediaFileProjectType::VideoTimeline); + assert_eq!(MediaFileProjectType::from_str("editor_2d").unwrap(), MediaFileProjectType::Editor2d); + assert!(MediaFileProjectType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = MediaFileProjectType::all_variants(); + assert_eq!(variants.len(), 5); + assert_eq!(variants.pop_first(), Some(MediaFileProjectType::Scene3d)); + assert_eq!(variants.pop_first(), Some(MediaFileProjectType::MoodBoard)); + assert_eq!(variants.pop_first(), Some(MediaFileProjectType::Workflow)); + assert_eq!(variants.pop_first(), Some(MediaFileProjectType::VideoTimeline)); + assert_eq!(variants.pop_first(), Some(MediaFileProjectType::Editor2d)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileProjectType::all_variants().len(), MediaFileProjectType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileProjectType::all_variants() { + assert_eq!(variant, MediaFileProjectType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileProjectType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileProjectType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in MediaFileProjectType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_subtype.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_subtype.rs new file mode 100644 index 00000000..1bd4a257 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_subtype.rs @@ -0,0 +1,221 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_files` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +#[deprecated(note = "This was primarily for Bevy")] +pub enum MediaFileSubtype { + /// NB: MediaFileSubtype is deprecated. + /// This should signal that the field / enum is fully deprecated. + Deprecated, + + // TODO(bt,2024-04-22): Deprecated (migrate) + /// Animation file from Mixamo + /// Primarily used for FBX and GLB. + Mixamo, + + // TODO(bt,2024-04-22): Deprecated (migrate) + /// Animation file from MocapNet + /// Primarily used for BVH. + MocapNet, + + // TODO(bt,2024-04-22): Deprecated + /// Generic animation case + /// Used for BVH files, but can also pertain to animation-only files of other types. + AnimationOnly, + + // TODO(bt,2024-04-22): Deprecated + /// Generic 3D scene file. + /// Can pertain to glTF, glB, FBX, etc. + SceneImport, + + // TODO(bt,2024-04-22): Deprecated + /// Native Storyteller scene format. + /// Typically stored in a `.scn.ron` file. + StorytellerScene, + + /// A 3D scene full of objects, characters, animations, etc. + Scene, + + /// A 3D character model. + Character, + + /// A 3D animation. + Animation, + + /// A 3D object that doesn't fit with the other types. + Object, + + /// A 3D skybox. + Skybox, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileSubtype); + +/// NB: Legacy API for older code. +impl MediaFileSubtype { + pub fn to_str(&self) -> &'static str { + match self { + Self::Deprecated => "deprecated", + Self::Mixamo => "mixamo", + Self::MocapNet => "mocap_net", + Self::AnimationOnly => "animation_only", + Self::SceneImport => "scene_import", + Self::StorytellerScene => "storyteller_scene", + Self::Scene => "scene", + Self::Character => "character", + Self::Animation => "animation", + Self::Object => "object", + Self::Skybox => "skybox", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "deprecated" => Ok(Self::Deprecated), + "mixamo" => Ok(Self::Mixamo), + "mocap_net" => Ok(Self::MocapNet), + "animation_only" => Ok(Self::AnimationOnly), + "scene_import" => Ok(Self::SceneImport), + "storyteller_scene" => Ok(Self::StorytellerScene), + "scene" => Ok(Self::Scene), + "character" => Ok(Self::Character), + "animation" => Ok(Self::Animation), + "object" => Ok(Self::Object), + "skybox" => Ok(Self::Skybox), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Deprecated, + Self::Mixamo, + Self::MocapNet, + Self::AnimationOnly, + Self::SceneImport, + Self::StorytellerScene, + Self::Scene, + Self::Character, + Self::Animation, + Self::Object, + Self::Skybox, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_subtype::MediaFileSubtype; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileSubtype::Deprecated, "deprecated"); + assert_serialization(MediaFileSubtype::Mixamo, "mixamo"); + assert_serialization(MediaFileSubtype::MocapNet, "mocap_net"); + assert_serialization(MediaFileSubtype::AnimationOnly, "animation_only"); + assert_serialization(MediaFileSubtype::SceneImport, "scene_import"); + assert_serialization(MediaFileSubtype::StorytellerScene, "storyteller_scene"); + assert_serialization(MediaFileSubtype::Scene, "scene"); + assert_serialization(MediaFileSubtype::Character, "character"); + assert_serialization(MediaFileSubtype::Animation, "animation"); + assert_serialization(MediaFileSubtype::Object, "object"); + assert_serialization(MediaFileSubtype::Skybox, "skybox"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaFileSubtype::Deprecated.to_str(), "deprecated"); + assert_eq!(MediaFileSubtype::Mixamo.to_str(), "mixamo"); + assert_eq!(MediaFileSubtype::MocapNet.to_str(), "mocap_net"); + assert_eq!(MediaFileSubtype::AnimationOnly.to_str(), "animation_only"); + assert_eq!(MediaFileSubtype::SceneImport.to_str(), "scene_import"); + assert_eq!(MediaFileSubtype::StorytellerScene.to_str(), "storyteller_scene"); + assert_eq!(MediaFileSubtype::Scene.to_str(), "scene"); + assert_eq!(MediaFileSubtype::Character.to_str(), "character"); + assert_eq!(MediaFileSubtype::Animation.to_str(), "animation"); + assert_eq!(MediaFileSubtype::Object.to_str(), "object"); + assert_eq!(MediaFileSubtype::Skybox.to_str(), "skybox"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaFileSubtype::from_str("deprecated").unwrap(), MediaFileSubtype::Deprecated); + assert_eq!(MediaFileSubtype::from_str("mixamo").unwrap(), MediaFileSubtype::Mixamo); + assert_eq!(MediaFileSubtype::from_str("mocap_net").unwrap(), MediaFileSubtype::MocapNet); + assert_eq!(MediaFileSubtype::from_str("animation_only").unwrap(), MediaFileSubtype::AnimationOnly); + assert_eq!(MediaFileSubtype::from_str("scene_import").unwrap(), MediaFileSubtype::SceneImport); + assert_eq!(MediaFileSubtype::from_str("storyteller_scene").unwrap(), MediaFileSubtype::StorytellerScene); + assert_eq!(MediaFileSubtype::from_str("scene").unwrap(), MediaFileSubtype::Scene); + assert_eq!(MediaFileSubtype::from_str("character").unwrap(), MediaFileSubtype::Character); + assert_eq!(MediaFileSubtype::from_str("animation").unwrap(), MediaFileSubtype::Animation); + assert_eq!(MediaFileSubtype::from_str("object").unwrap(), MediaFileSubtype::Object); + assert_eq!(MediaFileSubtype::from_str("skybox").unwrap(), MediaFileSubtype::Skybox); + assert!(MediaFileSubtype::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = MediaFileSubtype::all_variants(); + assert_eq!(variants.len(), 11); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Deprecated)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Mixamo)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::MocapNet)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::AnimationOnly)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::SceneImport)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::StorytellerScene)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Scene)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Character)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Animation)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Object)); + assert_eq!(variants.pop_first(), Some(MediaFileSubtype::Skybox)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileSubtype::all_variants().len(), MediaFileSubtype::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileSubtype::all_variants() { + assert_eq!(variant, MediaFileSubtype::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileSubtype::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileSubtype::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in MediaFileSubtype::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_type.rs new file mode 100644 index 00000000..8c9f5421 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/media_file_type.rs @@ -0,0 +1,805 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::by_table::media_files::media_file_class::MediaFileClass; + +/// Used in the `media_files` table in a `VARCHAR(16)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum MediaFileType { + // TODO(bt): Deprecate and split into audio mime types; use media_class to represent broadly + /// Audio files: wav, mp3, etc. + #[deprecated] + Audio, + + // TODO(bt): Deprecate and split into image mime types; use media_class to represent broadly + /// Image files: png, jpeg, etc. + #[deprecated] + Image, + + // TODO(bt): Deprecate and split into video mime types; use media_class to represent broadly + /// Video files: mp4, etc. + #[deprecated] + Video, + + /// BVH files (for Bevy) + /// NB: This is the new type to migrate to. + Bvh, + + /// FBX files (for Bevy) + Fbx, + + /// Wavefront OBJ mesh files + Obj, + + /// PLY (polygon file format) files; also used for Gaussian splats. + Ply, + + /// glTF binary files (for Bevy) + Glb, + + /// glTF files (for Bevy) + Gltf, + + /// Spz Gaussian splats + /// This is a standard file format for Gaussian Splats, used by World Labs. + /// The mime type is application/gzip. + Spz, + + /// Bevy's scene files (in RON; Rusty Object Notation) + /// This will be replaced with another format in future versions of Bevy + SceneRon, + + /// Alternate scene files. + SceneJson, + + /// Mood board project documents (JSON). + MoodJson, + + /// Video editor timeline project documents (JSON). + TimelineJson, + + /// 2D editor project documents (JSON). + EditorJson, + + /// "Polygon Model Data", character data for MikuMikuDance + /// See: https://mikumikudance.fandom.com/wiki/MMD:Polygon_Model_Data + Pmd, + + /// "Vocaloid Motion Data", animation data for MikuMikuDance + /// See: https://mikumikudance.fandom.com/wiki/VMD_file_format + Vmd, + + /// "Polygon Model eXtend", character data from MikuMikuDance + /// NB: this is often associated with external files for textures, which + /// we'll store in the same bucket path. + /// See: https://mikumikudance.fandom.com/wiki/MMD:Polygon_Model_eXtend + Pmx, + + /// CSV format. (We use these for ArKit) + Csv, + + /// Jpeg images + Jpg, + + /// Png images + Png, + + /// Gif images + Gif, + + /// Mp4 videos + Mp4, + + /// Wav audio + Wav, + + /// Mp3 audio + Mp3, + + // ========================= LESS SUPPORT FOR THE FILES BELOW THIS LINE ========================= // + + /// Webp images + Webp, + + /// Webm videos + Webm, + + /// QuickTime videos + Mov, + + /// Opus audio + Opus, + + /// Ogg audio + Ogg, + + /// AAC audio + Aac, + + /// M4a audio + M4a, + + /// FLAC audio + Flac, + + /// Generic JSON documents (eg. internal project files). + /// NB: 3D scene files predate this and use `scene_json` instead. + Json, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaFileType); + +/// NB: Legacy API for older code. +impl MediaFileType { + + /// Jpeg and Png are the most widely supported static image formats for AI inference. + /// Webp, Webm, and Gif aren't as widely supported, so we don't include them here. + pub fn is_jpg_or_png(&self) -> bool { + matches!(self, Self::Jpg | Self::Png) + } + + /// A little bit less strict than `is_jpg_or_png`, this includes the legacy `Image` type. + pub fn is_jpg_or_png_or_legacy_image(&self) -> bool { + matches!(self, Self::Jpg | Self::Png | Self::Image) + } + + /// Any image format, including the legacy coarse `Image` type. + pub fn is_image(&self) -> bool { + matches!(self, Self::Image | Self::Jpg | Self::Png | Self::Gif | Self::Webp) + } + + /// The broad `media_class` this file format belongs to. + pub fn to_media_class(&self) -> MediaFileClass { + match self { + Self::Audio + | Self::Wav + | Self::Mp3 + | Self::Opus + | Self::Ogg + | Self::Aac + | Self::M4a + | Self::Flac => MediaFileClass::Audio, + + Self::Image + | Self::Jpg + | Self::Png + | Self::Gif + | Self::Webp => MediaFileClass::Image, + + Self::Video + | Self::Mp4 + | Self::Webm + | Self::Mov => MediaFileClass::Video, + + Self::Fbx + | Self::Obj + | Self::Glb + | Self::Gltf + | Self::Pmd + | Self::Pmx => MediaFileClass::Mesh, + + Self::Spz + | Self::Ply => MediaFileClass::Splat, + + // Animation and auxiliary data formats with no dedicated class yet. + #[allow(deprecated)] + Self::Bvh + | Self::Vmd + | Self::Csv => MediaFileClass::Dimensional, + + Self::SceneRon + | Self::SceneJson + | Self::MoodJson + | Self::TimelineJson + | Self::EditorJson + | Self::Json => MediaFileClass::Project, + } + } + + /// Returns the `MediaFileType` if the mime type matches one of the known types. + /// This is not exhaustive. + /// (NB: In general we shouldn't keep much application logic in the `enums` crate, + /// but this is a good case for it.) + pub fn try_from_mime_type(mime_type: &str) -> Option { + match mime_type { + "image/jpeg" => Some(Self::Jpg), + "image/png" => Some(Self::Png), + "image/gif" => Some(Self::Gif), + "image/webp" => Some(Self::Webp), + "video/mp4" => Some(Self::Mp4), + "video/webm" => Some(Self::Webm), + "video/quicktime" => Some(Self::Mov), + "audio/wav" => Some(Self::Wav), + "audio/x-wav" => Some(Self::Wav), + "audio/wave" => Some(Self::Wav), + "audio/mpeg" => Some(Self::Mp3), + "audio/mp3" => Some(Self::Mp3), + "audio/opus" => Some(Self::Opus), + "audio/ogg" => Some(Self::Ogg), + "audio/aac" => Some(Self::Aac), + "audio/m4a" => Some(Self::M4a), + "audio/x-m4a" => Some(Self::M4a), + "audio/mp4" => Some(Self::M4a), + "audio/flac" => Some(Self::Flac), + "audio/x-flac" => Some(Self::Flac), + "model/gltf-binary" => Some(Self::Glb), + "model/gltf+json" => Some(Self::Gltf), + "model/fbx" => Some(Self::Fbx), + "application/fbx" => Some(Self::Fbx), + "model/obj" => Some(Self::Obj), + "model/ply" => Some(Self::Ply), + _ => None, + } + } + + /// Tries the input as a filename first, then as a bare extension. + /// Useful as a fallback when `try_from_mime_type` fails. + pub fn try_from_filename_or_extension(filename_or_extension: &str) -> Option { + Self::try_from_filename(filename_or_extension) + .or_else(|| Self::try_from_extension(filename_or_extension)) + } + + /// Returns the `MediaFileType` for a filename by examining its extension. + pub fn try_from_filename(filename: &str) -> Option { + let (_, extension) = filename.trim().rsplit_once('.')?; + Self::try_from_extension(extension) + } + + /// Returns the `MediaFileType` for a known file extension. + /// Accepts extensions with or without a leading dot, in any letter case. + pub fn try_from_extension(extension: &str) -> Option { + let extension = extension.trim().trim_start_matches('.').to_ascii_lowercase(); + match extension.as_str() { + "jpg" | "jpeg" => Some(Self::Jpg), + "png" => Some(Self::Png), + "gif" => Some(Self::Gif), + "webp" => Some(Self::Webp), + "mp4" => Some(Self::Mp4), + "webm" => Some(Self::Webm), + "mov" => Some(Self::Mov), + "wav" => Some(Self::Wav), + "mp3" => Some(Self::Mp3), + "opus" => Some(Self::Opus), + "ogg" => Some(Self::Ogg), + "aac" => Some(Self::Aac), + "m4a" => Some(Self::M4a), + "flac" => Some(Self::Flac), + "bvh" => Some(Self::Bvh), + "fbx" => Some(Self::Fbx), + "obj" => Some(Self::Obj), + "glb" => Some(Self::Glb), + "gltf" => Some(Self::Gltf), + "spz" => Some(Self::Spz), + "pmd" => Some(Self::Pmd), + "vmd" => Some(Self::Vmd), + "pmx" => Some(Self::Pmx), + "csv" => Some(Self::Csv), + "json" => Some(Self::Json), + _ => None, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::Audio => "audio", + Self::Image => "image", + Self::Video => "video", + Self::Bvh => "bvh", + Self::Fbx => "fbx", + Self::Obj => "obj", + Self::Ply => "ply", + Self::Glb => "glb", + Self::Gltf => "gltf", + Self::Spz => "spz", + Self::SceneRon => "scene_ron", + Self::SceneJson => "scene_json", + Self::MoodJson => "mood_json", + Self::TimelineJson => "timeline_json", + Self::EditorJson => "editor_json", + Self::Pmd => "pmd", + Self::Vmd => "vmd", + Self::Pmx => "pmx", + Self::Csv => "csv", + Self::Jpg => "jpg", + Self::Png => "png", + Self::Gif => "gif", + Self::Mp4 => "mp4", + Self::Wav => "wav", + Self::Mp3 => "mp3", + Self::Webp => "webp", + Self::Webm => "webm", + Self::Mov => "mov", + Self::Opus => "opus", + Self::Ogg => "ogg", + Self::Aac => "aac", + Self::M4a => "m4a", + Self::Flac => "flac", + Self::Json => "json", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "audio" => Ok(Self::Audio), + "image" => Ok(Self::Image), + "video" => Ok(Self::Video), + "bvh" => Ok(Self::Bvh), + "fbx" => Ok(Self::Fbx), + "obj" => Ok(Self::Obj), + "ply" => Ok(Self::Ply), + "glb" => Ok(Self::Glb), + "gltf" => Ok(Self::Gltf), + "spz" => Ok(Self::Spz), + "scene_ron" => Ok(Self::SceneRon), + "scene_json" => Ok(Self::SceneJson), + "mood_json" => Ok(Self::MoodJson), + "timeline_json" => Ok(Self::TimelineJson), + "editor_json" => Ok(Self::EditorJson), + "pmd" => Ok(Self::Pmd), + "vmd" => Ok(Self::Vmd), + "pmx" => Ok(Self::Pmx), + "csv" => Ok(Self::Csv), + "jpg" => Ok(Self::Jpg), + "png" => Ok(Self::Png), + "gif" => Ok(Self::Gif), + "mp4" => Ok(Self::Mp4), + "wav" => Ok(Self::Wav), + "mp3" => Ok(Self::Mp3), + "webp" => Ok(Self::Webp), + "webm" => Ok(Self::Webm), + "mov" => Ok(Self::Mov), + "opus" => Ok(Self::Opus), + "ogg" => Ok(Self::Ogg), + "aac" => Ok(Self::Aac), + "m4a" => Ok(Self::M4a), + "flac" => Ok(Self::Flac), + "json" => Ok(Self::Json), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Audio, + Self::Image, + Self::Video, + Self::Bvh, + Self::Fbx, + Self::Obj, + Self::Ply, + Self::Glb, + Self::Gltf, + Self::Spz, + Self::SceneRon, + Self::SceneJson, + Self::MoodJson, + Self::TimelineJson, + Self::EditorJson, + Self::Pmd, + Self::Vmd, + Self::Pmx, + Self::Csv, + Self::Jpg, + Self::Png, + Self::Gif, + Self::Mp4, + Self::Wav, + Self::Mp3, + Self::Webp, + Self::Webm, + Self::Mov, + Self::Opus, + Self::Ogg, + Self::Aac, + Self::M4a, + Self::Flac, + Self::Json, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_files::media_file_class::MediaFileClass; + use crate::enums::by_table::media_files::media_file_type::MediaFileType; + use crate::enums::test_helpers::assert_serialization; + + mod utility { + use super::*; + + #[test] + fn test_jpg_or_png() { + // True + assert!(MediaFileType::Jpg.is_jpg_or_png()); + assert!(MediaFileType::Png.is_jpg_or_png()); + + // Assert these image types are false + assert!(!MediaFileType::Gif.is_jpg_or_png()); + assert!(!MediaFileType::Image.is_jpg_or_png()); + + // Everything else is false + for variant in MediaFileType::all_variants() { + if matches!(variant, MediaFileType::Jpg | MediaFileType::Png) { + continue; + } + assert!(!variant.is_jpg_or_png(), "Expected {:?} to not be jpg or png", variant); + } + } + } + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(MediaFileType::Audio, "audio"); + assert_serialization(MediaFileType::Image, "image"); + assert_serialization(MediaFileType::Video, "video"); + assert_serialization(MediaFileType::Bvh, "bvh"); + assert_serialization(MediaFileType::Fbx, "fbx"); + assert_serialization(MediaFileType::Obj, "obj"); + assert_serialization(MediaFileType::Ply, "ply"); + assert_serialization(MediaFileType::Glb, "glb"); + assert_serialization(MediaFileType::Gltf, "gltf"); + assert_serialization(MediaFileType::Spz, "spz"); + assert_serialization(MediaFileType::SceneRon, "scene_ron"); + assert_serialization(MediaFileType::SceneJson, "scene_json"); + assert_serialization(MediaFileType::MoodJson, "mood_json"); + assert_serialization(MediaFileType::TimelineJson, "timeline_json"); + assert_serialization(MediaFileType::EditorJson, "editor_json"); + assert_serialization(MediaFileType::Pmd, "pmd"); + assert_serialization(MediaFileType::Vmd, "vmd"); + assert_serialization(MediaFileType::Pmx, "pmx"); + assert_serialization(MediaFileType::Csv, "csv"); + assert_serialization(MediaFileType::Jpg, "jpg"); + assert_serialization(MediaFileType::Png, "png"); + assert_serialization(MediaFileType::Gif, "gif"); + assert_serialization(MediaFileType::Mp4, "mp4"); + assert_serialization(MediaFileType::Wav, "wav"); + assert_serialization(MediaFileType::Mp3, "mp3"); + assert_serialization(MediaFileType::Webp, "webp"); + assert_serialization(MediaFileType::Webm, "webm"); + assert_serialization(MediaFileType::Mov, "mov"); + assert_serialization(MediaFileType::Opus, "opus"); + assert_serialization(MediaFileType::Ogg, "ogg"); + assert_serialization(MediaFileType::Aac, "aac"); + assert_serialization(MediaFileType::M4a, "m4a"); + assert_serialization(MediaFileType::Flac, "flac"); + assert_serialization(MediaFileType::Json, "json"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(MediaFileType::Audio.to_str(), "audio"); + assert_eq!(MediaFileType::Image.to_str(), "image"); + assert_eq!(MediaFileType::Video.to_str(), "video"); + assert_eq!(MediaFileType::Bvh.to_str(), "bvh"); + assert_eq!(MediaFileType::Fbx.to_str(), "fbx"); + assert_eq!(MediaFileType::Glb.to_str(), "glb"); + assert_eq!(MediaFileType::Gltf.to_str(), "gltf"); + assert_eq!(MediaFileType::Spz.to_str(), "spz"); + assert_eq!(MediaFileType::SceneRon.to_str(), "scene_ron"); + assert_eq!(MediaFileType::SceneJson.to_str(), "scene_json"); + assert_eq!(MediaFileType::MoodJson.to_str(), "mood_json"); + assert_eq!(MediaFileType::TimelineJson.to_str(), "timeline_json"); + assert_eq!(MediaFileType::EditorJson.to_str(), "editor_json"); + assert_eq!(MediaFileType::Pmd.to_str(), "pmd"); + assert_eq!(MediaFileType::Vmd.to_str(), "vmd"); + assert_eq!(MediaFileType::Pmx.to_str(), "pmx"); + assert_eq!(MediaFileType::Csv.to_str(), "csv"); + assert_eq!(MediaFileType::Jpg.to_str(), "jpg"); + assert_eq!(MediaFileType::Png.to_str(), "png"); + assert_eq!(MediaFileType::Gif.to_str(), "gif"); + assert_eq!(MediaFileType::Mp4.to_str(), "mp4"); + assert_eq!(MediaFileType::Wav.to_str(), "wav"); + assert_eq!(MediaFileType::Mp3.to_str(), "mp3"); + assert_eq!(MediaFileType::Webp.to_str(), "webp"); + assert_eq!(MediaFileType::Webm.to_str(), "webm"); + assert_eq!(MediaFileType::Mov.to_str(), "mov"); + assert_eq!(MediaFileType::Opus.to_str(), "opus"); + assert_eq!(MediaFileType::Ogg.to_str(), "ogg"); + assert_eq!(MediaFileType::Aac.to_str(), "aac"); + assert_eq!(MediaFileType::M4a.to_str(), "m4a"); + assert_eq!(MediaFileType::Flac.to_str(), "flac"); + assert_eq!(MediaFileType::Json.to_str(), "json"); + } + + #[test] + fn from_str() { + assert_eq!(MediaFileType::from_str("audio").unwrap(), MediaFileType::Audio); + assert_eq!(MediaFileType::from_str("image").unwrap(), MediaFileType::Image); + assert_eq!(MediaFileType::from_str("video").unwrap(), MediaFileType::Video); + assert_eq!(MediaFileType::from_str("bvh").unwrap(), MediaFileType::Bvh); + assert_eq!(MediaFileType::from_str("fbx").unwrap(), MediaFileType::Fbx); + assert_eq!(MediaFileType::from_str("glb").unwrap(), MediaFileType::Glb); + assert_eq!(MediaFileType::from_str("gltf").unwrap(), MediaFileType::Gltf); + assert_eq!(MediaFileType::from_str("spz").unwrap(), MediaFileType::Spz); + assert_eq!(MediaFileType::from_str("scene_ron").unwrap(), MediaFileType::SceneRon); + assert_eq!(MediaFileType::from_str("scene_json").unwrap(), MediaFileType::SceneJson); + assert_eq!(MediaFileType::from_str("mood_json").unwrap(), MediaFileType::MoodJson); + assert_eq!(MediaFileType::from_str("timeline_json").unwrap(), MediaFileType::TimelineJson); + assert_eq!(MediaFileType::from_str("editor_json").unwrap(), MediaFileType::EditorJson); + assert_eq!(MediaFileType::from_str("pmd").unwrap(), MediaFileType::Pmd); + assert_eq!(MediaFileType::from_str("vmd").unwrap(), MediaFileType::Vmd); + assert_eq!(MediaFileType::from_str("pmx").unwrap(), MediaFileType::Pmx); + assert_eq!(MediaFileType::from_str("csv").unwrap(), MediaFileType::Csv); + assert_eq!(MediaFileType::from_str("jpg").unwrap(), MediaFileType::Jpg); + assert_eq!(MediaFileType::from_str("png").unwrap(), MediaFileType::Png); + assert_eq!(MediaFileType::from_str("gif").unwrap(), MediaFileType::Gif); + assert_eq!(MediaFileType::from_str("mp4").unwrap(), MediaFileType::Mp4); + assert_eq!(MediaFileType::from_str("wav").unwrap(), MediaFileType::Wav); + assert_eq!(MediaFileType::from_str("mp3").unwrap(), MediaFileType::Mp3); + assert_eq!(MediaFileType::from_str("webp").unwrap(), MediaFileType::Webp); + assert_eq!(MediaFileType::from_str("webm").unwrap(), MediaFileType::Webm); + assert_eq!(MediaFileType::from_str("mov").unwrap(), MediaFileType::Mov); + assert_eq!(MediaFileType::from_str("opus").unwrap(), MediaFileType::Opus); + assert_eq!(MediaFileType::from_str("ogg").unwrap(), MediaFileType::Ogg); + assert_eq!(MediaFileType::from_str("aac").unwrap(), MediaFileType::Aac); + assert_eq!(MediaFileType::from_str("m4a").unwrap(), MediaFileType::M4a); + assert_eq!(MediaFileType::from_str("flac").unwrap(), MediaFileType::Flac); + assert_eq!(MediaFileType::from_str("json").unwrap(), MediaFileType::Json); + assert!(MediaFileType::from_str("foo").is_err()); + } + + #[test] + fn to_media_class() { + assert_eq!(MediaFileType::Audio.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Image.to_media_class(), MediaFileClass::Image); + assert_eq!(MediaFileType::Video.to_media_class(), MediaFileClass::Video); + assert_eq!(MediaFileType::Bvh.to_media_class(), MediaFileClass::Dimensional); + assert_eq!(MediaFileType::Fbx.to_media_class(), MediaFileClass::Mesh); + assert_eq!(MediaFileType::Obj.to_media_class(), MediaFileClass::Mesh); + assert_eq!(MediaFileType::Glb.to_media_class(), MediaFileClass::Mesh); + assert_eq!(MediaFileType::Gltf.to_media_class(), MediaFileClass::Mesh); + assert_eq!(MediaFileType::Spz.to_media_class(), MediaFileClass::Splat); + assert_eq!(MediaFileType::Ply.to_media_class(), MediaFileClass::Splat); + assert_eq!(MediaFileType::SceneRon.to_media_class(), MediaFileClass::Project); + assert_eq!(MediaFileType::SceneJson.to_media_class(), MediaFileClass::Project); + assert_eq!(MediaFileType::MoodJson.to_media_class(), MediaFileClass::Project); + assert_eq!(MediaFileType::TimelineJson.to_media_class(), MediaFileClass::Project); + assert_eq!(MediaFileType::EditorJson.to_media_class(), MediaFileClass::Project); + assert_eq!(MediaFileType::Pmd.to_media_class(), MediaFileClass::Mesh); + assert_eq!(MediaFileType::Vmd.to_media_class(), MediaFileClass::Dimensional); + assert_eq!(MediaFileType::Pmx.to_media_class(), MediaFileClass::Mesh); + assert_eq!(MediaFileType::Csv.to_media_class(), MediaFileClass::Dimensional); + assert_eq!(MediaFileType::Jpg.to_media_class(), MediaFileClass::Image); + assert_eq!(MediaFileType::Png.to_media_class(), MediaFileClass::Image); + assert_eq!(MediaFileType::Gif.to_media_class(), MediaFileClass::Image); + assert_eq!(MediaFileType::Webp.to_media_class(), MediaFileClass::Image); + assert_eq!(MediaFileType::Mp4.to_media_class(), MediaFileClass::Video); + assert_eq!(MediaFileType::Webm.to_media_class(), MediaFileClass::Video); + assert_eq!(MediaFileType::Mov.to_media_class(), MediaFileClass::Video); + assert_eq!(MediaFileType::Wav.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Mp3.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Opus.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Ogg.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Aac.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::M4a.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Flac.to_media_class(), MediaFileClass::Audio); + assert_eq!(MediaFileType::Json.to_media_class(), MediaFileClass::Project); + } + } + + mod format_detection { + use super::*; + + #[test] + fn try_from_mime_type() { + assert_eq!(MediaFileType::try_from_mime_type("image/jpeg"), Some(MediaFileType::Jpg)); + assert_eq!(MediaFileType::try_from_mime_type("image/png"), Some(MediaFileType::Png)); + assert_eq!(MediaFileType::try_from_mime_type("image/gif"), Some(MediaFileType::Gif)); + assert_eq!(MediaFileType::try_from_mime_type("image/webp"), Some(MediaFileType::Webp)); + assert_eq!(MediaFileType::try_from_mime_type("video/mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_mime_type("video/webm"), Some(MediaFileType::Webm)); + assert_eq!(MediaFileType::try_from_mime_type("video/quicktime"), Some(MediaFileType::Mov)); + assert_eq!(MediaFileType::try_from_mime_type("audio/wav"), Some(MediaFileType::Wav)); + assert_eq!(MediaFileType::try_from_mime_type("audio/x-wav"), Some(MediaFileType::Wav)); + assert_eq!(MediaFileType::try_from_mime_type("audio/wave"), Some(MediaFileType::Wav)); + assert_eq!(MediaFileType::try_from_mime_type("audio/mpeg"), Some(MediaFileType::Mp3)); + assert_eq!(MediaFileType::try_from_mime_type("audio/mp3"), Some(MediaFileType::Mp3)); + assert_eq!(MediaFileType::try_from_mime_type("audio/opus"), Some(MediaFileType::Opus)); + assert_eq!(MediaFileType::try_from_mime_type("audio/ogg"), Some(MediaFileType::Ogg)); + assert_eq!(MediaFileType::try_from_mime_type("audio/aac"), Some(MediaFileType::Aac)); + assert_eq!(MediaFileType::try_from_mime_type("audio/m4a"), Some(MediaFileType::M4a)); + assert_eq!(MediaFileType::try_from_mime_type("audio/x-m4a"), Some(MediaFileType::M4a)); + assert_eq!(MediaFileType::try_from_mime_type("audio/mp4"), Some(MediaFileType::M4a)); + assert_eq!(MediaFileType::try_from_mime_type("audio/flac"), Some(MediaFileType::Flac)); + assert_eq!(MediaFileType::try_from_mime_type("audio/x-flac"), Some(MediaFileType::Flac)); + assert_eq!(MediaFileType::try_from_mime_type("model/gltf-binary"), Some(MediaFileType::Glb)); + assert_eq!(MediaFileType::try_from_mime_type("model/gltf+json"), Some(MediaFileType::Gltf)); + assert_eq!(MediaFileType::try_from_mime_type("model/fbx"), Some(MediaFileType::Fbx)); + assert_eq!(MediaFileType::try_from_mime_type("application/fbx"), Some(MediaFileType::Fbx)); + assert_eq!(MediaFileType::try_from_mime_type("model/obj"), Some(MediaFileType::Obj)); + } + + #[test] + fn try_from_mime_type_unknown_mimes() { + // NB: application/json is deliberately unmapped — scene JSON, mood boards, + // and other project files can't be told apart by mime alone. + assert_eq!(MediaFileType::try_from_mime_type("application/json"), None); + // NB: application/gzip is the mime for spz splats, but gzip isn't + // necessarily a splat, so it stays unmapped. + assert_eq!(MediaFileType::try_from_mime_type("application/gzip"), None); + assert_eq!(MediaFileType::try_from_mime_type("application/octet-stream"), None); + assert_eq!(MediaFileType::try_from_mime_type("text/plain"), None); + assert_eq!(MediaFileType::try_from_mime_type(""), None); + assert_eq!(MediaFileType::try_from_mime_type("IMAGE/PNG"), None); + } + + #[test] + fn try_from_extension() { + assert_eq!(MediaFileType::try_from_extension("jpg"), Some(MediaFileType::Jpg)); + assert_eq!(MediaFileType::try_from_extension("jpeg"), Some(MediaFileType::Jpg)); + assert_eq!(MediaFileType::try_from_extension("png"), Some(MediaFileType::Png)); + assert_eq!(MediaFileType::try_from_extension("gif"), Some(MediaFileType::Gif)); + assert_eq!(MediaFileType::try_from_extension("webp"), Some(MediaFileType::Webp)); + assert_eq!(MediaFileType::try_from_extension("mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_extension("webm"), Some(MediaFileType::Webm)); + assert_eq!(MediaFileType::try_from_extension("mov"), Some(MediaFileType::Mov)); + assert_eq!(MediaFileType::try_from_extension("wav"), Some(MediaFileType::Wav)); + assert_eq!(MediaFileType::try_from_extension("mp3"), Some(MediaFileType::Mp3)); + assert_eq!(MediaFileType::try_from_extension("opus"), Some(MediaFileType::Opus)); + assert_eq!(MediaFileType::try_from_extension("ogg"), Some(MediaFileType::Ogg)); + assert_eq!(MediaFileType::try_from_extension("aac"), Some(MediaFileType::Aac)); + assert_eq!(MediaFileType::try_from_extension("m4a"), Some(MediaFileType::M4a)); + assert_eq!(MediaFileType::try_from_extension("flac"), Some(MediaFileType::Flac)); + assert_eq!(MediaFileType::try_from_extension("bvh"), Some(MediaFileType::Bvh)); + assert_eq!(MediaFileType::try_from_extension("fbx"), Some(MediaFileType::Fbx)); + assert_eq!(MediaFileType::try_from_extension("obj"), Some(MediaFileType::Obj)); + assert_eq!(MediaFileType::try_from_extension("glb"), Some(MediaFileType::Glb)); + assert_eq!(MediaFileType::try_from_extension("gltf"), Some(MediaFileType::Gltf)); + assert_eq!(MediaFileType::try_from_extension("spz"), Some(MediaFileType::Spz)); + assert_eq!(MediaFileType::try_from_extension("pmd"), Some(MediaFileType::Pmd)); + assert_eq!(MediaFileType::try_from_extension("vmd"), Some(MediaFileType::Vmd)); + assert_eq!(MediaFileType::try_from_extension("pmx"), Some(MediaFileType::Pmx)); + assert_eq!(MediaFileType::try_from_extension("csv"), Some(MediaFileType::Csv)); + assert_eq!(MediaFileType::try_from_extension("json"), Some(MediaFileType::Json)); + } + + #[test] + fn try_from_extension_normalization() { + // Leading dot + assert_eq!(MediaFileType::try_from_extension(".mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_extension(".spz"), Some(MediaFileType::Spz)); + // Case insensitivity + assert_eq!(MediaFileType::try_from_extension("JPG"), Some(MediaFileType::Jpg)); + assert_eq!(MediaFileType::try_from_extension(".WebP"), Some(MediaFileType::Webp)); + // Whitespace + assert_eq!(MediaFileType::try_from_extension(" png "), Some(MediaFileType::Png)); + assert_eq!(MediaFileType::try_from_extension(" .glb "), Some(MediaFileType::Glb)); + } + + #[test] + fn try_from_extension_unknown_extensions() { + assert_eq!(MediaFileType::try_from_extension("ron"), None); + assert_eq!(MediaFileType::try_from_extension("exe"), None); + assert_eq!(MediaFileType::try_from_extension("scene_json"), None); + assert_eq!(MediaFileType::try_from_extension("audio"), None); + assert_eq!(MediaFileType::try_from_extension(""), None); + assert_eq!(MediaFileType::try_from_extension("."), None); + } + + #[test] + fn try_from_filename() { + assert_eq!(MediaFileType::try_from_filename("photo.jpg"), Some(MediaFileType::Jpg)); + assert_eq!(MediaFileType::try_from_filename("PHOTO.JPEG"), Some(MediaFileType::Jpg)); + assert_eq!(MediaFileType::try_from_filename("clip.final.mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_filename("model.GLB"), Some(MediaFileType::Glb)); + assert_eq!(MediaFileType::try_from_filename("scene.spz"), Some(MediaFileType::Spz)); + assert_eq!(MediaFileType::try_from_filename("data.json"), Some(MediaFileType::Json)); + assert_eq!(MediaFileType::try_from_filename(" padded.png "), Some(MediaFileType::Png)); + // Failures + assert_eq!(MediaFileType::try_from_filename("archive.tar.gz"), None); + assert_eq!(MediaFileType::try_from_filename("noextension"), None); + assert_eq!(MediaFileType::try_from_filename("file."), None); + assert_eq!(MediaFileType::try_from_filename(".gitignore"), None); + assert_eq!(MediaFileType::try_from_filename(""), None); + // NB: a bare extension is not a filename (no dot separator) + assert_eq!(MediaFileType::try_from_filename("mp4"), None); + } + + #[test] + fn try_from_filename_or_extension() { + // Filenames + assert_eq!(MediaFileType::try_from_filename_or_extension("movie.mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_filename_or_extension("track.FLAC"), Some(MediaFileType::Flac)); + // Bare extensions, with and without a leading dot + assert_eq!(MediaFileType::try_from_filename_or_extension("mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_filename_or_extension(".mp4"), Some(MediaFileType::Mp4)); + assert_eq!(MediaFileType::try_from_filename_or_extension("webp"), Some(MediaFileType::Webp)); + // Failures + assert_eq!(MediaFileType::try_from_filename_or_extension("movie.xyz"), None); + assert_eq!(MediaFileType::try_from_filename_or_extension("unknown"), None); + assert_eq!(MediaFileType::try_from_filename_or_extension(""), None); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = MediaFileType::all_variants(); + assert_eq!(variants.len(), 34); + assert_eq!(variants.pop_first(), Some(MediaFileType::Audio)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Image)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Video)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Bvh)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Fbx)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Obj)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Ply)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Glb)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Gltf)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Spz)); + assert_eq!(variants.pop_first(), Some(MediaFileType::SceneRon)); + assert_eq!(variants.pop_first(), Some(MediaFileType::SceneJson)); + assert_eq!(variants.pop_first(), Some(MediaFileType::MoodJson)); + assert_eq!(variants.pop_first(), Some(MediaFileType::TimelineJson)); + assert_eq!(variants.pop_first(), Some(MediaFileType::EditorJson)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Pmd)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Vmd)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Pmx)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Csv)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Jpg)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Png)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Gif)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Mp4)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Wav)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Mp3)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Webp)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Webm)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Mov)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Opus)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Ogg)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Aac)); + assert_eq!(variants.pop_first(), Some(MediaFileType::M4a)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Flac)); + assert_eq!(variants.pop_first(), Some(MediaFileType::Json)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(MediaFileType::all_variants().len(), MediaFileType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in MediaFileType::all_variants() { + assert_eq!(variant, MediaFileType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, MediaFileType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, MediaFileType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in MediaFileType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_files/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/mod.rs new file mode 100644 index 00000000..ceded741 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_files/mod.rs @@ -0,0 +1,9 @@ +pub mod media_file_animation_type; +pub mod media_file_class; +pub mod media_file_engine_category; +pub mod media_file_origin_category; +pub mod media_file_origin_model_type; +pub mod media_file_origin_product_category; +pub mod media_file_project_type; +pub mod media_file_subtype; +pub mod media_file_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/media_upload_source.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/media_upload_source.rs new file mode 100644 index 00000000..4e08414c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/media_upload_source.rs @@ -0,0 +1,76 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_uploads` table in a `VARCHAR` field `media_source`. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +pub enum MediaUploadSource { + /// Eg. browser javascript APIs to access the microphone, webcam, etc. + #[serde(rename = "device_api")] + DeviceApi, + + /// Uploaded files from the filesystem + #[serde(rename = "file")] + File, + + /// Unknown sources + #[serde(rename = "unknown")] + Unknown, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaUploadSource); + +/// NB: Legacy API for older code. +impl MediaUploadSource { + pub fn to_str(&self) -> &'static str { + match self { + Self::DeviceApi => "device_api", + Self::File => "file", + Self::Unknown => "unknown", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "device_api" => Ok(Self::DeviceApi), + "file" => Ok(Self::File), + "unknown" => Ok(Self::Unknown), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_uploads::media_upload_source::MediaUploadSource; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(MediaUploadSource::DeviceApi, "device_api"); + assert_serialization(MediaUploadSource::File, "file"); + assert_serialization(MediaUploadSource::Unknown, "unknown"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaUploadSource::DeviceApi.to_str(), "device_api"); + assert_eq!(MediaUploadSource::File.to_str(), "file"); + assert_eq!(MediaUploadSource::Unknown.to_str(), "unknown"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaUploadSource::from_str("device_api").unwrap(), MediaUploadSource::DeviceApi); + assert_eq!(MediaUploadSource::from_str("file").unwrap(), MediaUploadSource::File); + assert_eq!(MediaUploadSource::from_str("unknown").unwrap(), MediaUploadSource::Unknown); + assert!(MediaUploadSource::from_str("foo").is_err()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/media_upload_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/media_upload_type.rs new file mode 100644 index 00000000..fa5cf15b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/media_upload_type.rs @@ -0,0 +1,82 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `media_uploads` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +#[serde(rename_all = "lowercase")] +pub enum MediaUploadType { + /// Audio files: wav, mp3, etc. + Audio, + + /// Image files: png, jpeg, etc. + Image, + + /// Video files: mp4, etc. + Video, + + // Binary files: safetensors ... weights, etc. + Binary, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(MediaUploadType); + +/// NB: Legacy API for older code. +impl MediaUploadType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Audio => "audio", + Self::Image => "image", + Self::Video => "video", + Self::Binary => "binary", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "audio" => Ok(Self::Audio), + "image" => Ok(Self::Image), + "video" => Ok(Self::Video), + "binary" => Ok(Self::Binary), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::media_uploads::media_upload_type::MediaUploadType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(MediaUploadType::Audio, "audio"); + assert_serialization(MediaUploadType::Image, "image"); + assert_serialization(MediaUploadType::Video, "video"); + assert_serialization(MediaUploadType::Binary, "binary"); + } + + #[test] + fn test_to_str() { + assert_eq!(MediaUploadType::Audio.to_str(), "audio"); + assert_eq!(MediaUploadType::Image.to_str(), "image"); + assert_eq!(MediaUploadType::Video.to_str(), "video"); + assert_eq!(MediaUploadType::Binary.to_str(), "binary"); + } + + #[test] + fn test_from_str() { + assert_eq!(MediaUploadType::from_str("audio").unwrap(), MediaUploadType::Audio); + assert_eq!(MediaUploadType::from_str("image").unwrap(), MediaUploadType::Image); + assert_eq!(MediaUploadType::from_str("video").unwrap(), MediaUploadType::Video); + assert_eq!(MediaUploadType::from_str("binary").unwrap(), MediaUploadType::Binary); + assert!(MediaUploadType::from_str("foo").is_err()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/mod.rs new file mode 100644 index 00000000..d3698b60 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/media_uploads/mod.rs @@ -0,0 +1,2 @@ +pub mod media_upload_type; +pub mod media_upload_source; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/mod.rs new file mode 100644 index 00000000..57321c92 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/mod.rs @@ -0,0 +1,38 @@ +// ===== MySql ===== +pub mod audit_logs; +pub mod batch_generations; +pub mod characters; +pub mod beta_keys; +pub mod comments; +pub mod debug_logs; +pub mod email_sender_jobs; +pub mod entity_stats; +pub mod featured_items; +pub mod generic_download_jobs; +pub mod generic_inference_jobs; +pub mod generic_synthetic_ids; +pub mod media_files; +pub mod media_uploads; +pub mod model_categories; +pub mod model_weights; +pub mod prompt_context_items; +pub mod prompts; +pub mod staff_audit_logs; +pub mod trending_model_analytics; +pub mod tts_models; +pub mod uploaded_video_notes; +pub mod uploaded_videos; +pub mod usages; +pub mod user_bookmarks; +pub mod user_ratings; +pub mod user_spend_events; +pub mod users; +pub mod voice_conversion_models; +pub mod voice_conversion_results; +pub mod wallet_ledger_entries; +pub mod zs_voices; + +// ===== Sqlite ===== +pub mod tts_render_tasks; +pub mod web_rendition_targets; +pub mod web_scraping_targets; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/model_categories/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/model_categories/mod.rs new file mode 100644 index 00000000..5a53f2e0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/model_categories/mod.rs @@ -0,0 +1 @@ +pub mod model_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/model_categories/model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/model_categories/model_type.rs new file mode 100644 index 00000000..37693c3f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/model_categories/model_type.rs @@ -0,0 +1,64 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `model_categories` table in an `ENUM` field. +/// (*WE WANT TO STOP USING ENUM FIELDS DUE TO MIGRATION ISSUES*) +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +#[serde(rename_all = "lowercase")] +pub enum ModelType { + Tts, + W2l, +} + +// TODO(bt, 2023-01-16): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(ModelType); + +/// NB: Legacy API for older code. +impl ModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Tts => "tts", + Self::W2l => "w2l", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "tts" => Ok(Self::Tts), + "w2l" => Ok(Self::W2l), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::model_categories::model_type::ModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(ModelType::Tts, "tts"); + assert_serialization(ModelType::W2l, "w2l"); + } + + #[test] + fn test_to_str() { + assert_eq!(ModelType::Tts.to_str(), "tts"); + assert_eq!(ModelType::W2l.to_str(), "w2l"); + } + + #[test] + fn test_from_str() { + assert_eq!(ModelType::from_str("tts").unwrap(), ModelType::Tts); + assert_eq!(ModelType::from_str("w2l").unwrap(), ModelType::W2l); + assert!(ModelType::from_str("foo").is_err()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/mod.rs new file mode 100644 index 00000000..07551314 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/mod.rs @@ -0,0 +1,3 @@ +pub mod weights_types; +pub mod weights_category; +pub mod weights_file_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_category.rs new file mode 100644 index 00000000..923a3b45 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_category.rs @@ -0,0 +1,90 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum WeightsCategory { + #[serde(rename = "image_generation")] + ImageGeneration, + #[serde(rename = "text_to_speech")] + TextToSpeech, + #[serde(rename = "vocoder")] + Vocoder, + #[serde(rename = "voice_conversion")] + VoiceConversion, + #[serde(rename = "workflow_config")] + WorkflowConfig, +} + +impl WeightsCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::ImageGeneration => "image_generation", + Self::TextToSpeech => "text_to_speech", + Self::Vocoder => "vocoder", + Self::VoiceConversion => "voice_conversion", + Self::WorkflowConfig => "workflow_config", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "image_generation" => Ok(Self::ImageGeneration), + "text_to_speech" => Ok(Self::TextToSpeech), + "vocoder" => Ok(Self::Vocoder), + "voice_conversion" => Ok(Self::VoiceConversion), + "workflow_config" => Ok(Self::WorkflowConfig), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::ImageGeneration, + Self::TextToSpeech, + Self::Vocoder, + Self::VoiceConversion, + Self::WorkflowConfig, + ]) + } +} +impl_enum_display_and_debug_using_to_str!(WeightsCategory); + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(WeightsCategory::ImageGeneration.to_str(), "image_generation"); + assert_eq!(WeightsCategory::TextToSpeech.to_str(), "text_to_speech"); + assert_eq!(WeightsCategory::Vocoder.to_str(), "vocoder"); + assert_eq!(WeightsCategory::VoiceConversion.to_str(), "voice_conversion"); + assert_eq!(WeightsCategory::WorkflowConfig.to_str(), "workflow_config"); + } + + #[test] + fn test_from_str() { + assert_eq!(WeightsCategory::from_str("image_generation").unwrap(), WeightsCategory::ImageGeneration); + assert_eq!(WeightsCategory::from_str("text_to_speech").unwrap(), WeightsCategory::TextToSpeech); + assert_eq!(WeightsCategory::from_str("vocoder").unwrap(), WeightsCategory::Vocoder); + assert_eq!(WeightsCategory::from_str("voice_conversion").unwrap(), WeightsCategory::VoiceConversion); + assert_eq!(WeightsCategory::from_str("workflow_config").unwrap(), WeightsCategory::WorkflowConfig); + assert!(WeightsCategory::from_str("invalid").is_err()); + } + + #[test] + fn test_all_variants() { + let variants = WeightsCategory::all_variants(); + assert_eq!(variants.len(), 5); + assert!(variants.contains(&WeightsCategory::ImageGeneration)); + assert!(variants.contains(&WeightsCategory::TextToSpeech)); + assert!(variants.contains(&WeightsCategory::Vocoder)); + assert!(variants.contains(&WeightsCategory::VoiceConversion)); + assert!(variants.contains(&WeightsCategory::WorkflowConfig)); + } +} \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_file_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_file_type.rs new file mode 100644 index 00000000..8d9b4d8f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_file_type.rs @@ -0,0 +1,68 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +// TODO we will need to scan the checkpoints for malicious code. We can't just trust the file extension. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum WeightsFileType { + #[serde(rename = "checkpoint")] + Checkpoint, + #[serde(rename = "safetensors")] + SafeTensors, +} + +impl WeightsFileType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Checkpoint => "checkpoint", + Self::SafeTensors => "safetensors", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "checkpoint" => Ok(Self::Checkpoint), + "safetensors" => Ok(Self::SafeTensors), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Checkpoint, + Self::SafeTensors, + ]) + } +} + +impl_enum_display_and_debug_using_to_str!(WeightsFileType); + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(WeightsFileType::Checkpoint.to_str(), "checkpoint"); + assert_eq!(WeightsFileType::SafeTensors.to_str(), "safetensors"); + } + + #[test] + fn test_from_str() { + assert_eq!(WeightsFileType::from_str("checkpoint").unwrap(), WeightsFileType::Checkpoint); + assert_eq!(WeightsFileType::from_str("safetensors").unwrap(), WeightsFileType::SafeTensors); + assert!(WeightsFileType::from_str("invalid").is_err()); + } + + #[test] + fn test_all_variants() { + let variants = WeightsFileType::all_variants(); + assert_eq!(variants.len(), 2); + assert!(variants.contains(&WeightsFileType::Checkpoint)); + assert!(variants.contains(&WeightsFileType::SafeTensors)); + } +} \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_types.rs b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_types.rs new file mode 100644 index 00000000..e1ee81fa --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/model_weights/weights_types.rs @@ -0,0 +1,162 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum WeightsType { + #[serde(rename = "hifigan_tt2")] + HifiganTacotron2, + #[serde(rename = "rvc_v2")] + RvcV2, + #[serde(rename = "sd_1.5")] + StableDiffusion15, + #[serde(rename = "sdxl")] + StableDiffusionXL, + #[serde(rename = "so_vits_svc")] + SoVitsSvc, + #[serde(rename = "tt2")] + Tacotron2, + #[serde(rename = "loRA")] + LoRA, + #[serde(rename = "vall_e")] + VallE, + #[serde(rename = "comfy_ui")] + ComfyUi, + + #[serde(rename = "gpt_so_vits")] + GptSoVits, +} + + +impl WeightsType { + pub fn to_str(&self) -> &'static str { + match self { + Self::HifiganTacotron2 => "hifigan_tt2", + Self::RvcV2 => "rvc_v2", + Self::StableDiffusion15 => "sd_1.5", + Self::StableDiffusionXL => "sdxl", + Self::SoVitsSvc => "so_vits_svc", + Self::Tacotron2 => "tt2", + Self::LoRA => "loRA", + Self::VallE => "vall_e", + Self::ComfyUi => "comfy_ui", + Self::GptSoVits => "gpt_so_vits", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "hifigan_tt2" => Ok(Self::HifiganTacotron2), + "rvc_v2" => Ok(Self::RvcV2), + "sd_1.5" => Ok(Self::StableDiffusion15), + "sdxl" => Ok(Self::StableDiffusionXL), + "so_vits_svc" => Ok(Self::SoVitsSvc), + "tt2" => Ok(Self::Tacotron2), + "loRA" => Ok(Self::LoRA), + "vall_e" => Ok(Self::VallE), + "comfy_ui" => Ok(Self::ComfyUi), + "gpt_so_vits" => Ok(Self::GptSoVits), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::HifiganTacotron2, + Self::RvcV2, + Self::StableDiffusion15, + Self::StableDiffusionXL, + Self::SoVitsSvc, + Self::Tacotron2, + Self::LoRA, + Self::VallE, + Self::ComfyUi, + Self::GptSoVits, + ]) + } +} + +impl_enum_display_and_debug_using_to_str!(WeightsType); + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(WeightsType::HifiganTacotron2.to_str(), "hifigan_tt2"); + assert_eq!(WeightsType::RvcV2.to_str(), "rvc_v2"); + assert_eq!(WeightsType::StableDiffusion15.to_str(), "sd_1.5"); + assert_eq!(WeightsType::StableDiffusionXL.to_str(), "sdxl"); + assert_eq!(WeightsType::SoVitsSvc.to_str(), "so_vits_svc"); + assert_eq!(WeightsType::Tacotron2.to_str(), "tt2"); + assert_eq!(WeightsType::LoRA.to_str(), "loRA"); + assert_eq!(WeightsType::VallE.to_str(), "vall_e"); + assert_eq!(WeightsType::ComfyUi.to_str(), "comfy_ui"); + assert_eq!(WeightsType::GptSoVits.to_str(), "gpt_so_vits"); + } + + #[test] + fn test_from_str() { + assert_eq!(WeightsType::from_str("hifigan_tt2").unwrap(), WeightsType::HifiganTacotron2); + assert_eq!(WeightsType::from_str("rvc_v2").unwrap(), WeightsType::RvcV2); + assert_eq!(WeightsType::from_str("sd_1.5").unwrap(), WeightsType::StableDiffusion15); + assert_eq!(WeightsType::from_str("sdxl").unwrap(), WeightsType::StableDiffusionXL); + assert_eq!(WeightsType::from_str("so_vits_svc").unwrap(), WeightsType::SoVitsSvc); + assert_eq!(WeightsType::from_str("tt2").unwrap(), WeightsType::Tacotron2); + assert_eq!(WeightsType::from_str("loRA").unwrap(), WeightsType::LoRA); + assert_eq!(WeightsType::from_str("vall_e").unwrap(), WeightsType::VallE); + assert_eq!(WeightsType::from_str("comfy_ui").unwrap(), WeightsType::ComfyUi); + assert_eq!(WeightsType::from_str("gpt_so_vits").unwrap(), WeightsType::GptSoVits); + assert!(WeightsType::from_str("invalid").is_err()); + } + + #[test] + fn test_all_variants() { + let variants = WeightsType::all_variants(); + assert_eq!(variants.len(), 10); + assert!(variants.contains(&WeightsType::HifiganTacotron2)); + assert!(variants.contains(&WeightsType::RvcV2)); + assert!(variants.contains(&WeightsType::StableDiffusion15)); + assert!(variants.contains(&WeightsType::StableDiffusionXL)); + assert!(variants.contains(&WeightsType::SoVitsSvc)); + assert!(variants.contains(&WeightsType::Tacotron2)); + assert!(variants.contains(&WeightsType::LoRA)); + assert!(variants.contains(&WeightsType::VallE)); + assert!(variants.contains(&WeightsType::ComfyUi)); + assert!(variants.contains(&WeightsType::GptSoVits)); + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(WeightsType::all_variants().len(), WeightsType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in WeightsType::all_variants() { + assert_eq!(variant, WeightsType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, WeightsType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, WeightsType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in WeightsType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/prompt_context_items/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/prompt_context_items/mod.rs new file mode 100644 index 00000000..d460910c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/prompt_context_items/mod.rs @@ -0,0 +1 @@ +pub mod prompt_context_semantic_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/prompt_context_items/prompt_context_semantic_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/prompt_context_items/prompt_context_semantic_type.rs new file mode 100644 index 00000000..18ca2db6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/prompt_context_items/prompt_context_semantic_type.rs @@ -0,0 +1,212 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/* +Current DB values - this is in conflict with API serializations. Need to fix! +imgref +imgsrc +imgmask +vid_start_frame +vid_end_frame +vidref +*/ + +/// Used in the `prompt_context_items` table in a `VARCHAR(16)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum PromptContextSemanticType { + /// Image-to-Video starting frame + VidStartFrame, + + /// Image-to-Video ending frame + VidEndFrame, + + /// Reference image for video generation (e.g. Seedance "vidref" mode) + VidRef, + + /// Source image, eg. for inpainting. + Imgsrc, + + /// Image mask, eg. for inpainting. + Imgmask, + + /// Standard image reference without a semantic type (e.g. Sora/ChatGPT 4o/gpt-image-1) + Imgref, + + ImgrefCharacter, + ImgrefStyle, + ImgrefBg, + + /// Audio reference (e.g. for audio-to-video generation) + Audioref, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(PromptContextSemanticType); + +/// NB: Legacy API for older code. +impl PromptContextSemanticType { + pub fn to_str(&self) -> &'static str { + match self { + Self::VidStartFrame => "vid_start_frame", + Self::VidEndFrame => "vid_end_frame", + Self::VidRef => "vidref", + Self::Imgsrc => "imgsrc", + Self::Imgmask => "imgmask", + Self::Imgref => "imgref", + Self::ImgrefCharacter => "imgref_character", + Self::ImgrefStyle => "imgref_style", + Self::ImgrefBg => "imgref_bg", + Self::Audioref => "audioref", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "vid_start_frame" => Ok(Self::VidStartFrame), + "vid_end_frame" => Ok(Self::VidEndFrame), + "vidref" => Ok(Self::VidRef), + "imgsrc" => Ok(Self::Imgsrc), + "imgmask" => Ok(Self::Imgmask), + "imgref" => Ok(Self::Imgref), + "imgref_character" => Ok(Self::ImgrefCharacter), + "imgref_style" => Ok(Self::ImgrefStyle), + "imgref_bg" => Ok(Self::ImgrefBg), + "audioref" => Ok(Self::Audioref), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::VidStartFrame, + Self::VidEndFrame, + Self::VidRef, + Self::Imgsrc, + Self::Imgmask, + Self::Imgref, + Self::ImgrefCharacter, + Self::ImgrefStyle, + Self::ImgrefBg, + Self::Audioref, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::prompt_context_items::prompt_context_semantic_type::PromptContextSemanticType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PromptContextSemanticType::VidStartFrame, "vid_start_frame"); + assert_serialization(PromptContextSemanticType::VidEndFrame, "vid_end_frame"); + // NB: serde serialization ("vid_ref") intentionally differs from to_str()/the DB value + // ("vidref"); see the "Current DB values" comment at the top of this file. + assert_serialization(PromptContextSemanticType::VidRef, "vid_ref"); + assert_serialization(PromptContextSemanticType::Imgsrc, "imgsrc"); + assert_serialization(PromptContextSemanticType::Imgmask, "imgmask"); + assert_serialization(PromptContextSemanticType::Imgref, "imgref"); + assert_serialization(PromptContextSemanticType::ImgrefCharacter, "imgref_character"); + assert_serialization(PromptContextSemanticType::ImgrefStyle, "imgref_style"); + assert_serialization(PromptContextSemanticType::ImgrefBg, "imgref_bg"); + assert_serialization(PromptContextSemanticType::Audioref, "audioref"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(PromptContextSemanticType::VidStartFrame.to_str(), "vid_start_frame"); + assert_eq!(PromptContextSemanticType::VidEndFrame.to_str(), "vid_end_frame"); + assert_eq!(PromptContextSemanticType::VidRef.to_str(), "vidref"); + assert_eq!(PromptContextSemanticType::Imgsrc.to_str(), "imgsrc"); + assert_eq!(PromptContextSemanticType::Imgmask.to_str(), "imgmask"); + assert_eq!(PromptContextSemanticType::Imgref.to_str(), "imgref"); + assert_eq!(PromptContextSemanticType::ImgrefCharacter.to_str(), "imgref_character"); + assert_eq!(PromptContextSemanticType::ImgrefStyle.to_str(), "imgref_style"); + assert_eq!(PromptContextSemanticType::ImgrefBg.to_str(), "imgref_bg"); + assert_eq!(PromptContextSemanticType::Audioref.to_str(), "audioref"); + } + + #[test] + fn from_str() { + assert_eq!(PromptContextSemanticType::from_str("vid_start_frame").unwrap(), PromptContextSemanticType::VidStartFrame); + assert_eq!(PromptContextSemanticType::from_str("vid_end_frame").unwrap(), PromptContextSemanticType::VidEndFrame); + assert_eq!(PromptContextSemanticType::from_str("vidref").unwrap(), PromptContextSemanticType::VidRef); + assert_eq!(PromptContextSemanticType::from_str("imgsrc").unwrap(), PromptContextSemanticType::Imgsrc); + assert_eq!(PromptContextSemanticType::from_str("imgmask").unwrap(), PromptContextSemanticType::Imgmask); + assert_eq!(PromptContextSemanticType::from_str("imgref").unwrap(), PromptContextSemanticType::Imgref); + assert_eq!(PromptContextSemanticType::from_str("imgref_character").unwrap(), PromptContextSemanticType::ImgrefCharacter); + assert_eq!(PromptContextSemanticType::from_str("imgref_style").unwrap(), PromptContextSemanticType::ImgrefStyle); + assert_eq!(PromptContextSemanticType::from_str("imgref_bg").unwrap(), PromptContextSemanticType::ImgrefBg); + assert_eq!(PromptContextSemanticType::from_str("audioref").unwrap(), PromptContextSemanticType::Audioref); + assert!(PromptContextSemanticType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = PromptContextSemanticType::all_variants(); + assert_eq!(variants.len(), 10); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::VidStartFrame)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::VidEndFrame)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::VidRef)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::Imgsrc)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::Imgmask)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::Imgref)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::ImgrefCharacter)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::ImgrefStyle)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::ImgrefBg)); + assert_eq!(variants.pop_first(), Some(PromptContextSemanticType::Audioref)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PromptContextSemanticType::all_variants().len(), PromptContextSemanticType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PromptContextSemanticType::all_variants() { + assert_eq!(variant, PromptContextSemanticType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PromptContextSemanticType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PromptContextSemanticType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in PromptContextSemanticType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/prompts/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/prompts/mod.rs new file mode 100644 index 00000000..6f7977d6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/prompts/mod.rs @@ -0,0 +1 @@ +pub mod prompt_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/prompts/prompt_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/prompts/prompt_type.rs new file mode 100644 index 00000000..e84e947e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/prompts/prompt_type.rs @@ -0,0 +1,137 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `prompts` table in a `VARCHAR(16)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum PromptType { + /// Artcraft (App) + ArtcraftApp, + + /// Stable diffusion + #[deprecated] + StableDiffusion, + + /// Comfy UI + #[deprecated] + ComfyUi, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(PromptType); + +/// NB: Legacy API for older code. +impl PromptType { + pub fn to_str(&self) -> &'static str { + match self { + Self::ArtcraftApp => "artcraft_app", + Self::StableDiffusion => "stable_diffusion", + Self::ComfyUi => "comfy_ui", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "artcraft_app" => Ok(Self::ArtcraftApp), + "stable_diffusion" => Ok(Self::StableDiffusion), + "comfy_ui" => Ok(Self::ComfyUi), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ArtcraftApp, + Self::StableDiffusion, + Self::ComfyUi, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::prompts::prompt_type::PromptType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PromptType::ArtcraftApp, "artcraft_app"); + assert_serialization(PromptType::StableDiffusion, "stable_diffusion"); + assert_serialization(PromptType::ComfyUi, "comfy_ui"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(PromptType::ArtcraftApp.to_str(), "artcraft_app"); + assert_eq!(PromptType::StableDiffusion.to_str(), "stable_diffusion"); + assert_eq!(PromptType::ComfyUi.to_str(), "comfy_ui"); + } + + #[test] + fn from_str() { + assert_eq!(PromptType::from_str("artcraft_app").unwrap(), PromptType::ArtcraftApp); + assert_eq!(PromptType::from_str("stable_diffusion").unwrap(), PromptType::StableDiffusion); + assert_eq!(PromptType::from_str("comfy_ui").unwrap(), PromptType::ComfyUi); + assert!(PromptType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = PromptType::all_variants(); + assert_eq!(variants.len(), 3); + assert_eq!(variants.pop_first(), Some(PromptType::ArtcraftApp)); + assert_eq!(variants.pop_first(), Some(PromptType::StableDiffusion)); + assert_eq!(variants.pop_first(), Some(PromptType::ComfyUi)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PromptType::all_variants().len(), PromptType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PromptType::all_variants() { + assert_eq!(variant, PromptType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PromptType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PromptType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in PromptType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/mod.rs new file mode 100644 index 00000000..b7eaa8b4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/mod.rs @@ -0,0 +1,2 @@ +pub mod staff_audit_action; +pub mod staff_audit_entity_type; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/staff_audit_action.rs b/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/staff_audit_action.rs new file mode 100644 index 00000000..4b1009da --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/staff_audit_action.rs @@ -0,0 +1,173 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `staff_audit_logs` table in `VARCHAR(32)` field `entity_action`. +/// +/// The type of staff action that was performed. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum StaffAuditAction { + /// Staff initiated an impersonation request for a user. + #[serde(rename = "impersonate_user_request")] + ImpersonateUserRequest, + + /// Staff redeemed an impersonation request, creating a session. + #[serde(rename = "impersonate_user_redeem")] + ImpersonateUserRedeem, + + /// Staff banned a user. + #[serde(rename = "ban_user")] + BanUser, + + /// Staff unbanned a user. + #[serde(rename = "unban_user")] + UnbanUser, + + /// Staff added banked balance to a wallet. + #[serde(rename = "add_wallet_banked_balance")] + AddWalletBankedBalance, + + /// Staff sent a manual alert via the pager system. + #[serde(rename = "send_alert")] + SendAlert, + + /// Staff edited a user's feature flags. + #[serde(rename = "edit_user_feature_flags")] + EditUserFeatureFlags, + + /// Staff changed a user's email address. + #[serde(rename = "change_user_email")] + ChangeUserEmail, +} + +impl_enum_display_and_debug_using_to_str!(StaffAuditAction); + +impl StaffAuditAction { + pub fn to_str(&self) -> &'static str { + match self { + Self::ImpersonateUserRequest => "impersonate_user_request", + Self::ImpersonateUserRedeem => "impersonate_user_redeem", + Self::BanUser => "ban_user", + Self::UnbanUser => "unban_user", + Self::AddWalletBankedBalance => "add_wallet_banked_balance", + Self::SendAlert => "send_alert", + Self::EditUserFeatureFlags => "edit_user_feature_flags", + Self::ChangeUserEmail => "change_user_email", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "impersonate_user_request" => Ok(Self::ImpersonateUserRequest), + "impersonate_user_redeem" => Ok(Self::ImpersonateUserRedeem), + "ban_user" => Ok(Self::BanUser), + "unban_user" => Ok(Self::UnbanUser), + "add_wallet_banked_balance" => Ok(Self::AddWalletBankedBalance), + "send_alert" => Ok(Self::SendAlert), + "edit_user_feature_flags" => Ok(Self::EditUserFeatureFlags), + "change_user_email" => Ok(Self::ChangeUserEmail), + _ => Err(format!("invalid StaffAuditAction value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::ImpersonateUserRequest, + Self::ImpersonateUserRedeem, + Self::BanUser, + Self::UnbanUser, + Self::AddWalletBankedBalance, + Self::SendAlert, + Self::EditUserFeatureFlags, + Self::ChangeUserEmail, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::staff_audit_logs::staff_audit_action::StaffAuditAction; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(StaffAuditAction::ImpersonateUserRequest, "impersonate_user_request"); + assert_serialization(StaffAuditAction::ImpersonateUserRedeem, "impersonate_user_redeem"); + assert_serialization(StaffAuditAction::BanUser, "ban_user"); + assert_serialization(StaffAuditAction::UnbanUser, "unban_user"); + assert_serialization(StaffAuditAction::AddWalletBankedBalance, "add_wallet_banked_balance"); + assert_serialization(StaffAuditAction::SendAlert, "send_alert"); + assert_serialization(StaffAuditAction::EditUserFeatureFlags, "edit_user_feature_flags"); + assert_serialization(StaffAuditAction::ChangeUserEmail, "change_user_email"); + } + + #[test] + fn to_str() { + assert_eq!(StaffAuditAction::ImpersonateUserRequest.to_str(), "impersonate_user_request"); + assert_eq!(StaffAuditAction::ImpersonateUserRedeem.to_str(), "impersonate_user_redeem"); + assert_eq!(StaffAuditAction::BanUser.to_str(), "ban_user"); + assert_eq!(StaffAuditAction::UnbanUser.to_str(), "unban_user"); + assert_eq!(StaffAuditAction::AddWalletBankedBalance.to_str(), "add_wallet_banked_balance"); + assert_eq!(StaffAuditAction::SendAlert.to_str(), "send_alert"); + assert_eq!(StaffAuditAction::EditUserFeatureFlags.to_str(), "edit_user_feature_flags"); + assert_eq!(StaffAuditAction::ChangeUserEmail.to_str(), "change_user_email"); + } + + #[test] + fn from_str() { + assert_eq!(StaffAuditAction::from_str("impersonate_user_request").unwrap(), StaffAuditAction::ImpersonateUserRequest); + assert_eq!(StaffAuditAction::from_str("impersonate_user_redeem").unwrap(), StaffAuditAction::ImpersonateUserRedeem); + assert_eq!(StaffAuditAction::from_str("ban_user").unwrap(), StaffAuditAction::BanUser); + assert_eq!(StaffAuditAction::from_str("unban_user").unwrap(), StaffAuditAction::UnbanUser); + assert_eq!(StaffAuditAction::from_str("add_wallet_banked_balance").unwrap(), StaffAuditAction::AddWalletBankedBalance); + assert_eq!(StaffAuditAction::from_str("send_alert").unwrap(), StaffAuditAction::SendAlert); + assert_eq!(StaffAuditAction::from_str("edit_user_feature_flags").unwrap(), StaffAuditAction::EditUserFeatureFlags); + assert_eq!(StaffAuditAction::from_str("change_user_email").unwrap(), StaffAuditAction::ChangeUserEmail); + assert!(StaffAuditAction::from_str("invalid").is_err()); + } + + #[test] + fn all_variants() { + const EXPECTED_COUNT: usize = 8; + assert_eq!(StaffAuditAction::all_variants().len(), EXPECTED_COUNT); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(StaffAuditAction::all_variants().len(), StaffAuditAction::iter().len()); + } + + #[test] + fn round_trip() { + for variant in StaffAuditAction::all_variants() { + assert_eq!(variant, StaffAuditAction::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, StaffAuditAction::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, StaffAuditAction::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in StaffAuditAction::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long for VARCHAR({})", variant, MAX_LENGTH); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/staff_audit_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/staff_audit_entity_type.rs new file mode 100644 index 00000000..4aa678cf --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/staff_audit_logs/staff_audit_entity_type.rs @@ -0,0 +1,113 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `staff_audit_logs` table in `VARCHAR(32)` field `entity_type`. +/// +/// The type of entity that a staff action was performed on. +/// +/// YOU CAN ADD NEW VALUES, BUT DO NOT CHANGE EXISTING VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum StaffAuditEntityType { + /// A user account. + #[serde(rename = "user")] + User, + + /// A wallet. + #[serde(rename = "wallet")] + Wallet, +} + +impl_enum_display_and_debug_using_to_str!(StaffAuditEntityType); + +impl StaffAuditEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::User => "user", + Self::Wallet => "wallet", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "user" => Ok(Self::User), + "wallet" => Ok(Self::Wallet), + _ => Err(format!("invalid StaffAuditEntityType value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::User, + Self::Wallet, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::staff_audit_logs::staff_audit_entity_type::StaffAuditEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(StaffAuditEntityType::User, "user"); + assert_serialization(StaffAuditEntityType::Wallet, "wallet"); + } + + #[test] + fn to_str() { + assert_eq!(StaffAuditEntityType::User.to_str(), "user"); + assert_eq!(StaffAuditEntityType::Wallet.to_str(), "wallet"); + } + + #[test] + fn from_str() { + assert_eq!(StaffAuditEntityType::from_str("user").unwrap(), StaffAuditEntityType::User); + assert_eq!(StaffAuditEntityType::from_str("wallet").unwrap(), StaffAuditEntityType::Wallet); + assert!(StaffAuditEntityType::from_str("invalid").is_err()); + } + + #[test] + fn all_variants() { + const EXPECTED_COUNT: usize = 2; + assert_eq!(StaffAuditEntityType::all_variants().len(), EXPECTED_COUNT); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(StaffAuditEntityType::all_variants().len(), StaffAuditEntityType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in StaffAuditEntityType::all_variants() { + assert_eq!(variant, StaffAuditEntityType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, StaffAuditEntityType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, StaffAuditEntityType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in StaffAuditEntityType::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long for VARCHAR({})", variant, MAX_LENGTH); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/mod.rs new file mode 100644 index 00000000..fcb0d46e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/mod.rs @@ -0,0 +1,2 @@ +pub mod model_type; +pub mod window_name; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/model_type.rs new file mode 100644 index 00000000..a7f20f92 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/model_type.rs @@ -0,0 +1,61 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `trending_model_analytics` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +#[serde(rename_all = "lowercase")] +pub enum ModelType { + /// TTS models + Tts, + + // NB: It's assumed we'll use this same system to track + // trending VC models too, so the next type would be "VC". +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(ModelType); + +/// NB: Legacy API for older code. +impl ModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Tts => "tts", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "tts" => Ok(Self::Tts), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::trending_model_analytics::model_type::ModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(ModelType::Tts, "tts"); + } + + #[test] + fn test_to_str() { + assert_eq!(ModelType::Tts.to_str(), "tts"); + } + + #[test] + fn test_from_str() { + assert_eq!(ModelType::from_str("tts").unwrap(), ModelType::Tts); + assert!(ModelType::from_str("foo").is_err()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/window_name.rs b/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/window_name.rs new file mode 100644 index 00000000..547ab1ee --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/trending_model_analytics/window_name.rs @@ -0,0 +1,86 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `window_name` table in a `VARCHAR` field. +/// +/// Contrary to most of this crate and unlike most "enum"-types +/// that are inflexible, new window names can be added/removed +/// without breaking too much. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum WindowName { + /// Analytics over the last three hours + #[serde(rename = "last_3_hours")] + Last3Hours, + + /// Analytics over the last three hours + #[serde(rename = "last_3_days")] + Last3Days, + + /// Analytics over all historical records + #[serde(rename = "all_time")] + AllTime, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(WindowName); + +/// NB: Legacy API for older code. +impl WindowName { + pub fn to_str(&self) -> &'static str { + match self { + Self::Last3Hours => "last_3_hours", + Self::Last3Days => "last_3_days", + Self::AllTime => "all_time", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "last_3_hours" => Ok(Self::Last3Hours), + "last_3_days" => Ok(Self::Last3Days), + "all_time" => Ok(Self::AllTime), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::trending_model_analytics::window_name::WindowName; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(WindowName::Last3Hours, "last_3_hours"); + assert_serialization(WindowName::Last3Days, "last_3_days"); + assert_serialization(WindowName::AllTime, "all_time"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(WindowName::Last3Hours.to_str(), "last_3_hours"); + assert_eq!(WindowName::Last3Days.to_str(), "last_3_days"); + assert_eq!(WindowName::AllTime.to_str(), "all_time"); + } + + #[test] + fn test_from_str() { + assert_eq!(WindowName::from_str("last_3_hours").unwrap(), WindowName::Last3Hours); + assert_eq!(WindowName::from_str("last_3_days").unwrap(), WindowName::Last3Days); + assert_eq!(WindowName::from_str("all_time").unwrap(), WindowName::AllTime); + assert!(WindowName::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/tts_models/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/tts_models/mod.rs new file mode 100644 index 00000000..49cb0e29 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/tts_models/mod.rs @@ -0,0 +1 @@ +pub mod tts_model_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/tts_models/tts_model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/tts_models/tts_model_type.rs new file mode 100644 index 00000000..36b1900d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/tts_models/tts_model_type.rs @@ -0,0 +1,66 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `tts_models` table in an `ENUM` field. +/// -- Furthermore -- not all enum values are represented !! +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +pub enum TtsModelType { + #[serde(rename = "tacotron2")] + Tacotron2, + + #[serde(rename = "vits")] + Vits, +} + +// TODO(bt, 2023-04-03): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(TtsModelType); + +/// NB: Legacy API for older code. +impl TtsModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Tacotron2 => "tacotron2", + Self::Vits => "vits", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "tacotron2" => Ok(Self::Tacotron2), + "vits" => Ok(Self::Vits), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::tts_models::tts_model_type::TtsModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(TtsModelType::Tacotron2, "tacotron2"); + assert_serialization(TtsModelType::Vits, "vits"); + } + + #[test] + fn test_to_str() { + assert_eq!(TtsModelType::Tacotron2.to_str(), "tacotron2"); + assert_eq!(TtsModelType::Vits.to_str(), "vits"); + } + + #[test] + fn test_from_str() { + assert_eq!(TtsModelType::from_str("tacotron2").unwrap(), TtsModelType::Tacotron2); + assert_eq!(TtsModelType::from_str("vits").unwrap(), TtsModelType::Vits); + assert!(TtsModelType::from_str("foo").is_err()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/tts_render_tasks/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/tts_render_tasks/mod.rs new file mode 100644 index 00000000..1eb03572 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/tts_render_tasks/mod.rs @@ -0,0 +1 @@ +pub mod tts_render_status; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/tts_render_tasks/tts_render_status.rs b/crates/api_clients/artcraft_client/src/enums/by_table/tts_render_tasks/tts_render_status.rs new file mode 100644 index 00000000..934f3cb8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/tts_render_tasks/tts_render_status.rs @@ -0,0 +1,104 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the SqLite `tts_render_tasks` table in a `TEXT` field named `tts_render_status`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum TtsRenderStatus { + #[serde(rename = "new")] + New, + + // TODO: Added to fix a big. This whole enum should die. + #[serde(rename = "processing")] + Processing, + + #[serde(rename = "skipped")] + Skipped, + + #[serde(rename = "failed")] + Failed, + + #[serde(rename = "permanently_failed")] + PermanentlyFailed, + + #[serde(rename = "success")] + Success, +} + +// TODO(bt, 2023-01-17): This desperately needs Sqlite integration tests! +impl_enum_display_and_debug_using_to_str!(TtsRenderStatus); + +/// NB: Legacy API for older code. +impl TtsRenderStatus { + pub fn to_str(&self) -> &'static str { + match self { + Self::New => "new", + Self::Processing => "processing", + Self::Skipped => "skipped", + Self::Failed => "failed", + Self::PermanentlyFailed => "permanently_failed", + Self::Success => "success", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "new" => Ok(Self::New), + "processing" => Ok(Self::Processing), + "skipped" => Ok(Self::Skipped), + "failed" => Ok(Self::Failed), + "permanently_failed" => Ok(Self::PermanentlyFailed), + "success" => Ok(Self::Success), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::tts_render_tasks::tts_render_status::TtsRenderStatus; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(TtsRenderStatus::New, "new"); + assert_serialization(TtsRenderStatus::Processing, "processing"); + assert_serialization(TtsRenderStatus::Skipped, "skipped"); + assert_serialization(TtsRenderStatus::Failed, "failed"); + assert_serialization(TtsRenderStatus::PermanentlyFailed, "permanently_failed"); + assert_serialization(TtsRenderStatus::Success, "success"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(TtsRenderStatus::New.to_str(), "new"); + assert_eq!(TtsRenderStatus::Processing.to_str(), "processing"); + assert_eq!(TtsRenderStatus::Skipped.to_str(), "skipped"); + assert_eq!(TtsRenderStatus::Failed.to_str(), "failed"); + assert_eq!(TtsRenderStatus::PermanentlyFailed.to_str(), "permanently_failed"); + assert_eq!(TtsRenderStatus::Success.to_str(), "success"); + } + + #[test] + fn test_from_str() { + assert_eq!(TtsRenderStatus::from_str("new").unwrap(), TtsRenderStatus::New); + assert_eq!(TtsRenderStatus::from_str("processing").unwrap(), TtsRenderStatus::Processing); + assert_eq!(TtsRenderStatus::from_str("skipped").unwrap(), TtsRenderStatus::Skipped); + assert_eq!(TtsRenderStatus::from_str("failed").unwrap(), TtsRenderStatus::Failed); + assert_eq!(TtsRenderStatus::from_str("permanently_failed").unwrap(), TtsRenderStatus::PermanentlyFailed); + assert_eq!(TtsRenderStatus::from_str("success").unwrap(), TtsRenderStatus::Success); + assert!(TtsRenderStatus::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/mod.rs new file mode 100644 index 00000000..42912c9d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/mod.rs @@ -0,0 +1,2 @@ +pub mod uploaded_video_note_reported_model_type; +pub mod uploaded_video_note_reported_website; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/uploaded_video_note_reported_model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/uploaded_video_note_reported_model_type.rs new file mode 100644 index 00000000..6882957f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/uploaded_video_note_reported_model_type.rs @@ -0,0 +1,250 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `uploaded_video_notes` table in a `VARCHAR(32)` field. +/// +/// The model the note's submitter claims the video is. The variant set mirrors +/// [`crate::enums::common::generation::common_video_model::CommonVideoModel`]. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum UploadedVideoNoteReportedModelType { + #[serde(rename = "grok_video")] + GrokVideo, + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + #[serde(rename = "kling_2p1_master")] + Kling21Master, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + // `preview_model` is a retired alias that collapses onto Seedance 2.0. + #[serde(rename = "seedance_2p0", alias = "preview_model")] + Seedance2p0, + // `preview_model_fast` is a retired alias that collapses onto Seedance 2.0 Fast. + #[serde(rename = "seedance_2p0_fast", alias = "preview_model_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, +} + +impl_enum_display_and_debug_using_to_str!(UploadedVideoNoteReportedModelType); + +impl UploadedVideoNoteReportedModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::GrokVideo => "grok_video", + Self::GrokImagineVideo => "grok_imagine_video", + Self::GrokImagineVideo1p5 => "grok_imagine_video_1p5", + Self::Kling16Pro => "kling_1p6_pro", + Self::Kling21Pro => "kling_2p1_pro", + Self::Kling21Master => "kling_2p1_master", + Self::Kling2p5TurboPro => "kling_2p5_turbo_pro", + Self::Kling2p6Pro => "kling_2p6_pro", + Self::Kling3p0Standard => "kling_3p0_standard", + Self::Kling3p0Pro => "kling_3p0_pro", + Self::HappyHorse1p0 => "happy_horse_1p0", + Self::Seedance10Lite => "seedance_1p0_lite", + Self::Seedance1p5Pro => "seedance_1p5_pro", + Self::Seedance2p0 => "seedance_2p0", + Self::Seedance2p0Fast => "seedance_2p0_fast", + Self::Seedance2p0BytePlus => "seedance_2p0_bp", + Self::Seedance2p0BytePlusFast => "seedance_2p0_bp_fast", + Self::Seedance2p0Ultra => "seedance_2p0_u", + Self::Seedance2p0UltraFast => "seedance_2p0_u_fast", + Self::Seedance2p0BytePlusUltra => "seedance_2p0_bpu", + Self::Seedance2p0BytePlusUltraFast => "seedance_2p0_bpu_fast", + Self::Sora2 => "sora_2", + Self::Sora2Pro => "sora_2_pro", + Self::Veo2 => "veo_2", + Self::Veo3 => "veo_3", + Self::Veo3Fast => "veo_3_fast", + Self::Veo3p1 => "veo_3p1", + Self::Veo3p1Fast => "veo_3p1_fast", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "grok_video" => Ok(Self::GrokVideo), + "grok_imagine_video" => Ok(Self::GrokImagineVideo), + "grok_imagine_video_1p5" => Ok(Self::GrokImagineVideo1p5), + "kling_1p6_pro" => Ok(Self::Kling16Pro), + "kling_2p1_pro" => Ok(Self::Kling21Pro), + "kling_2p1_master" => Ok(Self::Kling21Master), + "kling_2p5_turbo_pro" => Ok(Self::Kling2p5TurboPro), + "kling_2p6_pro" => Ok(Self::Kling2p6Pro), + "kling_3p0_standard" => Ok(Self::Kling3p0Standard), + "kling_3p0_pro" => Ok(Self::Kling3p0Pro), + "happy_horse_1p0" => Ok(Self::HappyHorse1p0), + "seedance_1p0_lite" => Ok(Self::Seedance10Lite), + "seedance_1p5_pro" => Ok(Self::Seedance1p5Pro), + "seedance_2p0" => Ok(Self::Seedance2p0), + "seedance_2p0_fast" => Ok(Self::Seedance2p0Fast), + "seedance_2p0_bp" => Ok(Self::Seedance2p0BytePlus), + "seedance_2p0_bp_fast" => Ok(Self::Seedance2p0BytePlusFast), + "seedance_2p0_u" => Ok(Self::Seedance2p0Ultra), + "seedance_2p0_u_fast" => Ok(Self::Seedance2p0UltraFast), + "seedance_2p0_bpu" => Ok(Self::Seedance2p0BytePlusUltra), + "seedance_2p0_bpu_fast" => Ok(Self::Seedance2p0BytePlusUltraFast), + "sora_2" => Ok(Self::Sora2), + "sora_2_pro" => Ok(Self::Sora2Pro), + "veo_2" => Ok(Self::Veo2), + "veo_3" => Ok(Self::Veo3), + "veo_3_fast" => Ok(Self::Veo3Fast), + "veo_3p1" => Ok(Self::Veo3p1), + "veo_3p1_fast" => Ok(Self::Veo3p1Fast), + // Retired values: collapse onto the Seedance 2.0 equivalents. + "preview_model" => Ok(Self::Seedance2p0), + "preview_model_fast" => Ok(Self::Seedance2p0Fast), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::GrokVideo, + Self::GrokImagineVideo, + Self::GrokImagineVideo1p5, + Self::Kling16Pro, + Self::Kling21Pro, + Self::Kling21Master, + Self::Kling2p5TurboPro, + Self::Kling2p6Pro, + Self::Kling3p0Standard, + Self::Kling3p0Pro, + Self::HappyHorse1p0, + Self::Seedance10Lite, + Self::Seedance1p5Pro, + Self::Seedance2p0, + Self::Seedance2p0Fast, + Self::Seedance2p0BytePlus, + Self::Seedance2p0BytePlusFast, + Self::Seedance2p0Ultra, + Self::Seedance2p0UltraFast, + Self::Seedance2p0BytePlusUltra, + Self::Seedance2p0BytePlusUltraFast, + Self::Sora2, + Self::Sora2Pro, + Self::Veo2, + Self::Veo3, + Self::Veo3Fast, + Self::Veo3p1, + Self::Veo3p1Fast, + ]) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trip() { + for variant in UploadedVideoNoteReportedModelType::all_variants() { + assert_eq!(variant, UploadedVideoNoteReportedModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UploadedVideoNoteReportedModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UploadedVideoNoteReportedModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + assert!(UploadedVideoNoteReportedModelType::from_str("foo").is_err()); + } + + #[test] + fn serde_round_trip() { + for variant in UploadedVideoNoteReportedModelType::all_variants() { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: UploadedVideoNoteReportedModelType = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized); + } + } + + /// The MySQL string (to_str) and the JSON string (serde) must stay aligned. + #[test] + fn to_str_matches_serde() { + for variant in UploadedVideoNoteReportedModelType::all_variants() { + let json = serde_json::to_string(&variant).unwrap(); + assert_eq!(json, format!("\"{}\"", variant.to_str())); + } + } + + #[test] + fn variant_count() { + use strum::IntoEnumIterator; + assert_eq!(UploadedVideoNoteReportedModelType::all_variants().len(), UploadedVideoNoteReportedModelType::iter().len()); + assert_eq!(UploadedVideoNoteReportedModelType::COUNT, 28); + } + + /// Retired `preview_model*` values must still decode, collapsing onto Seedance 2.0. + #[test] + fn legacy_preview_values_map_to_seedance() { + assert_eq!( + UploadedVideoNoteReportedModelType::from_str("preview_model").unwrap(), + UploadedVideoNoteReportedModelType::Seedance2p0 + ); + assert_eq!( + UploadedVideoNoteReportedModelType::from_str("preview_model_fast").unwrap(), + UploadedVideoNoteReportedModelType::Seedance2p0Fast + ); + let decoded: UploadedVideoNoteReportedModelType = + serde_json::from_str("\"preview_model\"").unwrap(); + assert_eq!(decoded, UploadedVideoNoteReportedModelType::Seedance2p0); + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in UploadedVideoNoteReportedModelType::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/uploaded_video_note_reported_website.rs b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/uploaded_video_note_reported_website.rs new file mode 100644 index 00000000..1ac101e1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_video_notes/uploaded_video_note_reported_website.rs @@ -0,0 +1,119 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `uploaded_video_notes` table in a `VARCHAR(32)` field. +/// +/// The website / platform the note's submitter says the video came from. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum UploadedVideoNoteReportedWebsite { + Runway, + Higgsfield, + Krea, + OpenArt, + Artcraft, + Magnific, + FreePik, +} + +impl_enum_display_and_debug_using_to_str!(UploadedVideoNoteReportedWebsite); + +impl UploadedVideoNoteReportedWebsite { + pub fn to_str(&self) -> &'static str { + match self { + Self::Runway => "runway", + Self::Higgsfield => "higgsfield", + Self::Krea => "krea", + Self::OpenArt => "open_art", + Self::Artcraft => "artcraft", + Self::Magnific => "magnific", + Self::FreePik => "free_pik", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "runway" => Ok(Self::Runway), + "higgsfield" => Ok(Self::Higgsfield), + "krea" => Ok(Self::Krea), + "open_art" => Ok(Self::OpenArt), + "artcraft" => Ok(Self::Artcraft), + "magnific" => Ok(Self::Magnific), + "free_pik" => Ok(Self::FreePik), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Runway, + Self::Higgsfield, + Self::Krea, + Self::OpenArt, + Self::Artcraft, + Self::Magnific, + Self::FreePik, + ]) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(UploadedVideoNoteReportedWebsite::Runway, "runway"); + assert_serialization(UploadedVideoNoteReportedWebsite::Higgsfield, "higgsfield"); + assert_serialization(UploadedVideoNoteReportedWebsite::Krea, "krea"); + assert_serialization(UploadedVideoNoteReportedWebsite::OpenArt, "open_art"); + assert_serialization(UploadedVideoNoteReportedWebsite::Artcraft, "artcraft"); + assert_serialization(UploadedVideoNoteReportedWebsite::Magnific, "magnific"); + assert_serialization(UploadedVideoNoteReportedWebsite::FreePik, "free_pik"); + } + + #[test] + fn round_trip() { + for variant in UploadedVideoNoteReportedWebsite::all_variants() { + assert_eq!(variant, UploadedVideoNoteReportedWebsite::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UploadedVideoNoteReportedWebsite::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UploadedVideoNoteReportedWebsite::from_str(&format!("{:?}", variant)).unwrap()); + } + assert!(UploadedVideoNoteReportedWebsite::from_str("foo").is_err()); + } + + #[test] + fn to_str_matches_serde() { + for variant in UploadedVideoNoteReportedWebsite::all_variants() { + let json = serde_json::to_string(&variant).unwrap(); + assert_eq!(json, format!("\"{}\"", variant.to_str())); + } + } + + #[test] + fn variant_count() { + use strum::IntoEnumIterator; + assert_eq!(UploadedVideoNoteReportedWebsite::all_variants().len(), UploadedVideoNoteReportedWebsite::iter().len()); + assert_eq!(UploadedVideoNoteReportedWebsite::COUNT, 7); + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in UploadedVideoNoteReportedWebsite::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/mod.rs new file mode 100644 index 00000000..c6f2f0c5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/mod.rs @@ -0,0 +1,2 @@ +pub mod uploaded_video_detected_model_family; +pub mod uploaded_video_detected_model_type; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/uploaded_video_detected_model_family.rs b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/uploaded_video_detected_model_family.rs new file mode 100644 index 00000000..7ef23b72 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/uploaded_video_detected_model_family.rs @@ -0,0 +1,114 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `uploaded_videos` table in a `VARCHAR(32)` field. +/// +/// The detected provenance family of an uploaded video. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum UploadedVideoDetectedModelFamily { + Seedance, + Veo, + Sora, + Kling, + Grok, + HappyHorse, +} + +impl_enum_display_and_debug_using_to_str!(UploadedVideoDetectedModelFamily); + +impl UploadedVideoDetectedModelFamily { + pub fn to_str(&self) -> &'static str { + match self { + Self::Seedance => "seedance", + Self::Veo => "veo", + Self::Sora => "sora", + Self::Kling => "kling", + Self::Grok => "grok", + Self::HappyHorse => "happy_horse", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "seedance" => Ok(Self::Seedance), + "veo" => Ok(Self::Veo), + "sora" => Ok(Self::Sora), + "kling" => Ok(Self::Kling), + "grok" => Ok(Self::Grok), + "happy_horse" => Ok(Self::HappyHorse), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Seedance, + Self::Veo, + Self::Sora, + Self::Kling, + Self::Grok, + Self::HappyHorse, + ]) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(UploadedVideoDetectedModelFamily::Seedance, "seedance"); + assert_serialization(UploadedVideoDetectedModelFamily::Veo, "veo"); + assert_serialization(UploadedVideoDetectedModelFamily::Sora, "sora"); + assert_serialization(UploadedVideoDetectedModelFamily::Kling, "kling"); + assert_serialization(UploadedVideoDetectedModelFamily::Grok, "grok"); + assert_serialization(UploadedVideoDetectedModelFamily::HappyHorse, "happy_horse"); + } + + #[test] + fn round_trip() { + for variant in UploadedVideoDetectedModelFamily::all_variants() { + assert_eq!(variant, UploadedVideoDetectedModelFamily::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UploadedVideoDetectedModelFamily::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UploadedVideoDetectedModelFamily::from_str(&format!("{:?}", variant)).unwrap()); + } + assert!(UploadedVideoDetectedModelFamily::from_str("foo").is_err()); + } + + #[test] + fn to_str_matches_serde() { + for variant in UploadedVideoDetectedModelFamily::all_variants() { + let json = serde_json::to_string(&variant).unwrap(); + assert_eq!(json, format!("\"{}\"", variant.to_str())); + } + } + + #[test] + fn variant_count() { + use strum::IntoEnumIterator; + assert_eq!(UploadedVideoDetectedModelFamily::all_variants().len(), UploadedVideoDetectedModelFamily::iter().len()); + assert_eq!(UploadedVideoDetectedModelFamily::COUNT, 6); + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in UploadedVideoDetectedModelFamily::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/uploaded_video_detected_model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/uploaded_video_detected_model_type.rs new file mode 100644 index 00000000..a99b5c37 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/uploaded_videos/uploaded_video_detected_model_type.rs @@ -0,0 +1,250 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `uploaded_videos` table in a `VARCHAR(32)` field. +/// +/// The detected model / variant of an uploaded video. The variant set mirrors +/// [`crate::enums::common::generation::common_video_model::CommonVideoModel`]. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum UploadedVideoDetectedModelType { + #[serde(rename = "grok_video")] + GrokVideo, + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + #[serde(rename = "kling_2p1_master")] + Kling21Master, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + // `preview_model` is a retired alias that collapses onto Seedance 2.0. + #[serde(rename = "seedance_2p0", alias = "preview_model")] + Seedance2p0, + // `preview_model_fast` is a retired alias that collapses onto Seedance 2.0 Fast. + #[serde(rename = "seedance_2p0_fast", alias = "preview_model_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, +} + +impl_enum_display_and_debug_using_to_str!(UploadedVideoDetectedModelType); + +impl UploadedVideoDetectedModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::GrokVideo => "grok_video", + Self::GrokImagineVideo => "grok_imagine_video", + Self::GrokImagineVideo1p5 => "grok_imagine_video_1p5", + Self::Kling16Pro => "kling_1p6_pro", + Self::Kling21Pro => "kling_2p1_pro", + Self::Kling21Master => "kling_2p1_master", + Self::Kling2p5TurboPro => "kling_2p5_turbo_pro", + Self::Kling2p6Pro => "kling_2p6_pro", + Self::Kling3p0Standard => "kling_3p0_standard", + Self::Kling3p0Pro => "kling_3p0_pro", + Self::HappyHorse1p0 => "happy_horse_1p0", + Self::Seedance10Lite => "seedance_1p0_lite", + Self::Seedance1p5Pro => "seedance_1p5_pro", + Self::Seedance2p0 => "seedance_2p0", + Self::Seedance2p0Fast => "seedance_2p0_fast", + Self::Seedance2p0BytePlus => "seedance_2p0_bp", + Self::Seedance2p0BytePlusFast => "seedance_2p0_bp_fast", + Self::Seedance2p0Ultra => "seedance_2p0_u", + Self::Seedance2p0UltraFast => "seedance_2p0_u_fast", + Self::Seedance2p0BytePlusUltra => "seedance_2p0_bpu", + Self::Seedance2p0BytePlusUltraFast => "seedance_2p0_bpu_fast", + Self::Sora2 => "sora_2", + Self::Sora2Pro => "sora_2_pro", + Self::Veo2 => "veo_2", + Self::Veo3 => "veo_3", + Self::Veo3Fast => "veo_3_fast", + Self::Veo3p1 => "veo_3p1", + Self::Veo3p1Fast => "veo_3p1_fast", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "grok_video" => Ok(Self::GrokVideo), + "grok_imagine_video" => Ok(Self::GrokImagineVideo), + "grok_imagine_video_1p5" => Ok(Self::GrokImagineVideo1p5), + "kling_1p6_pro" => Ok(Self::Kling16Pro), + "kling_2p1_pro" => Ok(Self::Kling21Pro), + "kling_2p1_master" => Ok(Self::Kling21Master), + "kling_2p5_turbo_pro" => Ok(Self::Kling2p5TurboPro), + "kling_2p6_pro" => Ok(Self::Kling2p6Pro), + "kling_3p0_standard" => Ok(Self::Kling3p0Standard), + "kling_3p0_pro" => Ok(Self::Kling3p0Pro), + "happy_horse_1p0" => Ok(Self::HappyHorse1p0), + "seedance_1p0_lite" => Ok(Self::Seedance10Lite), + "seedance_1p5_pro" => Ok(Self::Seedance1p5Pro), + "seedance_2p0" => Ok(Self::Seedance2p0), + "seedance_2p0_fast" => Ok(Self::Seedance2p0Fast), + "seedance_2p0_bp" => Ok(Self::Seedance2p0BytePlus), + "seedance_2p0_bp_fast" => Ok(Self::Seedance2p0BytePlusFast), + "seedance_2p0_u" => Ok(Self::Seedance2p0Ultra), + "seedance_2p0_u_fast" => Ok(Self::Seedance2p0UltraFast), + "seedance_2p0_bpu" => Ok(Self::Seedance2p0BytePlusUltra), + "seedance_2p0_bpu_fast" => Ok(Self::Seedance2p0BytePlusUltraFast), + "sora_2" => Ok(Self::Sora2), + "sora_2_pro" => Ok(Self::Sora2Pro), + "veo_2" => Ok(Self::Veo2), + "veo_3" => Ok(Self::Veo3), + "veo_3_fast" => Ok(Self::Veo3Fast), + "veo_3p1" => Ok(Self::Veo3p1), + "veo_3p1_fast" => Ok(Self::Veo3p1Fast), + // Retired values: collapse onto the Seedance 2.0 equivalents. + "preview_model" => Ok(Self::Seedance2p0), + "preview_model_fast" => Ok(Self::Seedance2p0Fast), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::GrokVideo, + Self::GrokImagineVideo, + Self::GrokImagineVideo1p5, + Self::Kling16Pro, + Self::Kling21Pro, + Self::Kling21Master, + Self::Kling2p5TurboPro, + Self::Kling2p6Pro, + Self::Kling3p0Standard, + Self::Kling3p0Pro, + Self::HappyHorse1p0, + Self::Seedance10Lite, + Self::Seedance1p5Pro, + Self::Seedance2p0, + Self::Seedance2p0Fast, + Self::Seedance2p0BytePlus, + Self::Seedance2p0BytePlusFast, + Self::Seedance2p0Ultra, + Self::Seedance2p0UltraFast, + Self::Seedance2p0BytePlusUltra, + Self::Seedance2p0BytePlusUltraFast, + Self::Sora2, + Self::Sora2Pro, + Self::Veo2, + Self::Veo3, + Self::Veo3Fast, + Self::Veo3p1, + Self::Veo3p1Fast, + ]) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trip() { + for variant in UploadedVideoDetectedModelType::all_variants() { + assert_eq!(variant, UploadedVideoDetectedModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UploadedVideoDetectedModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UploadedVideoDetectedModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + assert!(UploadedVideoDetectedModelType::from_str("foo").is_err()); + } + + #[test] + fn serde_round_trip() { + for variant in UploadedVideoDetectedModelType::all_variants() { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: UploadedVideoDetectedModelType = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized); + } + } + + /// The MySQL string (to_str) and the JSON string (serde) must stay aligned. + #[test] + fn to_str_matches_serde() { + for variant in UploadedVideoDetectedModelType::all_variants() { + let json = serde_json::to_string(&variant).unwrap(); + assert_eq!(json, format!("\"{}\"", variant.to_str())); + } + } + + #[test] + fn variant_count() { + use strum::IntoEnumIterator; + assert_eq!(UploadedVideoDetectedModelType::all_variants().len(), UploadedVideoDetectedModelType::iter().len()); + assert_eq!(UploadedVideoDetectedModelType::COUNT, 28); + } + + /// Retired `preview_model*` values must still decode, collapsing onto Seedance 2.0. + #[test] + fn legacy_preview_values_map_to_seedance() { + assert_eq!( + UploadedVideoDetectedModelType::from_str("preview_model").unwrap(), + UploadedVideoDetectedModelType::Seedance2p0 + ); + assert_eq!( + UploadedVideoDetectedModelType::from_str("preview_model_fast").unwrap(), + UploadedVideoDetectedModelType::Seedance2p0Fast + ); + let decoded: UploadedVideoDetectedModelType = + serde_json::from_str("\"preview_model\"").unwrap(); + assert_eq!(decoded, UploadedVideoDetectedModelType::Seedance2p0); + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in UploadedVideoDetectedModelType::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty(), "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/usages/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/usages/mod.rs new file mode 100644 index 00000000..52bd9896 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/usages/mod.rs @@ -0,0 +1 @@ +pub mod usages_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/usages/usages_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/usages/usages_type.rs new file mode 100644 index 00000000..13ef3cdb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/usages/usages_type.rs @@ -0,0 +1,125 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `usages` table in a `VARCHAR(16)` field. (Two fields!) +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum UsagesType { + /// Represents a foreign key link against a model_weights record + ModelWeight, + + /// Represents a foreign key link against a media_files record + MediaFile, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(UsagesType); + +/// NB: Legacy API for older code. +impl UsagesType { + pub fn to_str(&self) -> &'static str { + match self { + Self::ModelWeight => "model_weight", + Self::MediaFile => "media_file", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "model_weight" => Ok(Self::ModelWeight), + "media_file" => Ok(Self::MediaFile), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ModelWeight, + Self::MediaFile, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::usages::usages_type::UsagesType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(UsagesType::ModelWeight, "model_weight"); + assert_serialization(UsagesType::MediaFile, "media_file"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(UsagesType::ModelWeight.to_str(), "model_weight"); + assert_eq!(UsagesType::MediaFile.to_str(), "media_file"); + } + + #[test] + fn from_str() { + assert_eq!(UsagesType::from_str("model_weight").unwrap(), UsagesType::ModelWeight); + assert_eq!(UsagesType::from_str("media_file").unwrap(), UsagesType::MediaFile); + assert!(UsagesType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = UsagesType::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(UsagesType::ModelWeight)); + assert_eq!(variants.pop_first(), Some(UsagesType::MediaFile)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(UsagesType::all_variants().len(), UsagesType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in UsagesType::all_variants() { + assert_eq!(variant, UsagesType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UsagesType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UsagesType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in UsagesType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_bookmarks/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_bookmarks/mod.rs new file mode 100644 index 00000000..c3c539aa --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_bookmarks/mod.rs @@ -0,0 +1 @@ +pub mod user_bookmark_entity_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_bookmarks/user_bookmark_entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_bookmarks/user_bookmark_entity_type.rs new file mode 100644 index 00000000..e57e35c0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_bookmarks/user_bookmark_entity_type.rs @@ -0,0 +1,136 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `user_bookmarks` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum UserBookmarkEntityType { + /// User + #[serde(rename = "user")] + User, + + /// TTS model (architecture does not matter) + #[serde(rename = "tts_model")] + TtsModel, + + /// TTS result (architecture does not matter) + #[serde(rename = "tts_result")] + TtsResult, + + /// W2L template + #[serde(rename = "w2l_template")] + W2lTemplate, + + /// W2L result + #[serde(rename = "w2l_result")] + W2lResult, + + /// MediaFile + #[serde(rename = "media_file")] + MediaFile, + + /// ModelWeight (the new way to store models) + #[serde(rename = "model_weight")] + ModelWeight, + + /// VoiceConversionModel + #[serde(rename = "voice_conversion_model")] + VoiceConversionModel, + + /// ZsVoice + #[serde(rename = "zs_voice")] + ZsVoice, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(UserBookmarkEntityType); + +/// NB: Legacy API for older code. +impl UserBookmarkEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::User => "user", + Self::TtsModel => "tts_model", + Self::TtsResult => "tts_result", + Self::W2lTemplate => "w2l_template", + Self::W2lResult => "w2l_result", + Self::MediaFile => "media_file", + Self::ModelWeight => "model_weight", + Self::VoiceConversionModel => "voice_conversion_model", + Self::ZsVoice => "zs_voice", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "user" => Ok(Self::User), + "tts_model" => Ok(Self::TtsModel), + "tts_result" => Ok(Self::TtsResult), + "w2l_template" => Ok(Self::W2lTemplate), + "w2l_result" => Ok(Self::W2lResult), + "media_file" => Ok(Self::MediaFile), + "model_weight" => Ok(Self::ModelWeight), + "voice_conversion_model" => Ok(Self::VoiceConversionModel), + "zs_voice" => Ok(Self::ZsVoice), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::user_bookmarks::user_bookmark_entity_type::UserBookmarkEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(UserBookmarkEntityType::User, "user"); + assert_serialization(UserBookmarkEntityType::TtsModel, "tts_model"); + assert_serialization(UserBookmarkEntityType::TtsResult, "tts_result"); + assert_serialization(UserBookmarkEntityType::W2lTemplate, "w2l_template"); + assert_serialization(UserBookmarkEntityType::W2lResult, "w2l_result"); + assert_serialization(UserBookmarkEntityType::MediaFile, "media_file"); + assert_serialization(UserBookmarkEntityType::ModelWeight, "model_weight"); + assert_serialization(UserBookmarkEntityType::VoiceConversionModel, "voice_conversion_model"); + assert_serialization(UserBookmarkEntityType::ZsVoice, "zs_voice"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(UserBookmarkEntityType::User.to_str(), "user"); + assert_eq!(UserBookmarkEntityType::TtsModel.to_str(), "tts_model"); + assert_eq!(UserBookmarkEntityType::TtsResult.to_str(), "tts_result"); + assert_eq!(UserBookmarkEntityType::W2lTemplate.to_str(), "w2l_template"); + assert_eq!(UserBookmarkEntityType::W2lResult.to_str(), "w2l_result"); + assert_eq!(UserBookmarkEntityType::MediaFile.to_str(), "media_file"); + assert_eq!(UserBookmarkEntityType::ModelWeight.to_str(), "model_weight"); + assert_eq!(UserBookmarkEntityType::VoiceConversionModel.to_str(), "voice_conversion_model"); + assert_eq!(UserBookmarkEntityType::ZsVoice.to_str(), "zs_voice"); + } + + #[test] + fn test_from_str() { + assert_eq!(UserBookmarkEntityType::from_str("user").unwrap(), UserBookmarkEntityType::User); + assert_eq!(UserBookmarkEntityType::from_str("tts_model").unwrap(), UserBookmarkEntityType::TtsModel); + assert_eq!(UserBookmarkEntityType::from_str("tts_result").unwrap(), UserBookmarkEntityType::TtsResult); + assert_eq!(UserBookmarkEntityType::from_str("w2l_template").unwrap(), UserBookmarkEntityType::W2lTemplate); + assert_eq!(UserBookmarkEntityType::from_str("w2l_result").unwrap(), UserBookmarkEntityType::W2lResult); + assert_eq!(UserBookmarkEntityType::from_str("media_file").unwrap(), UserBookmarkEntityType::MediaFile); + assert_eq!(UserBookmarkEntityType::from_str("model_weight").unwrap(), UserBookmarkEntityType::ModelWeight); + assert_eq!(UserBookmarkEntityType::from_str("voice_conversion_model").unwrap(), UserBookmarkEntityType::VoiceConversionModel); + assert_eq!(UserBookmarkEntityType::from_str("zs_voice").unwrap(), UserBookmarkEntityType::ZsVoice); + assert!(UserBookmarkEntityType::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/entity_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/entity_type.rs new file mode 100644 index 00000000..4e42cd42 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/entity_type.rs @@ -0,0 +1,109 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `user_ratings` table in a `VARCHAR(32)` field named `entity_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum UserRatingEntityType { + /// Media files (inference results, uploads, etc.) + #[serde(rename = "media_file")] + MediaFile, + + /// Model weights (modern, polymorphic, type agnostic) + #[serde(rename = "model_weight")] + ModelWeight, + + /// TTS model (architecture does not matter) + #[serde(rename = "tts_model")] + TtsModel, + + /// TTS result (architecture does not matter) + #[serde(rename = "tts_result")] + TtsResult, + + /// W2L template + #[serde(rename = "w2l_template")] + W2lTemplate, + + /// W2L result + #[serde(rename = "w2l_result")] + W2lResult, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(UserRatingEntityType); + +/// NB: Legacy API for older code. +impl UserRatingEntityType { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaFile => "media_file", + Self::ModelWeight => "model_weight", + Self::TtsModel => "tts_model", + Self::TtsResult => "tts_result", + Self::W2lTemplate => "w2l_template", + Self::W2lResult => "w2l_result", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_file" => Ok(Self::MediaFile), + "model_weight" => Ok(Self::ModelWeight), + "tts_model" => Ok(Self::TtsModel), + "tts_result" => Ok(Self::TtsResult), + "w2l_template" => Ok(Self::W2lTemplate), + "w2l_result" => Ok(Self::W2lResult), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::user_ratings::entity_type::UserRatingEntityType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(UserRatingEntityType::MediaFile, "media_file"); + assert_serialization(UserRatingEntityType::ModelWeight, "model_weight"); + assert_serialization(UserRatingEntityType::TtsModel, "tts_model"); + assert_serialization(UserRatingEntityType::TtsResult, "tts_result"); + assert_serialization(UserRatingEntityType::W2lTemplate, "w2l_template"); + assert_serialization(UserRatingEntityType::W2lResult, "w2l_result"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(UserRatingEntityType::MediaFile.to_str(), "media_file"); + assert_eq!(UserRatingEntityType::ModelWeight.to_str(), "model_weight"); + assert_eq!(UserRatingEntityType::TtsModel.to_str(), "tts_model"); + assert_eq!(UserRatingEntityType::TtsResult.to_str(), "tts_result"); + assert_eq!(UserRatingEntityType::W2lTemplate.to_str(), "w2l_template"); + assert_eq!(UserRatingEntityType::W2lResult.to_str(), "w2l_result"); + } + + #[test] + fn test_from_str() { + assert_eq!(UserRatingEntityType::from_str("media_file").unwrap(), UserRatingEntityType::MediaFile); + assert_eq!(UserRatingEntityType::from_str("model_weight").unwrap(), UserRatingEntityType::ModelWeight); + assert_eq!(UserRatingEntityType::from_str("tts_model").unwrap(), UserRatingEntityType::TtsModel); + assert_eq!(UserRatingEntityType::from_str("tts_result").unwrap(), UserRatingEntityType::TtsResult); + assert_eq!(UserRatingEntityType::from_str("w2l_template").unwrap(), UserRatingEntityType::W2lTemplate); + assert_eq!(UserRatingEntityType::from_str("w2l_result").unwrap(), UserRatingEntityType::W2lResult); + assert!(UserRatingEntityType::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/mod.rs new file mode 100644 index 00000000..5f3a6ed2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/mod.rs @@ -0,0 +1,2 @@ +pub mod entity_type; +pub mod rating_value; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/rating_value.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/rating_value.rs new file mode 100644 index 00000000..6bd038bd --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_ratings/rating_value.rs @@ -0,0 +1,160 @@ +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// UserRatingValue +/// +/// - Used in the `user_ratings` table as an `ENUM` field named `rating_type`. +/// - Used in the HTTP API. +/// +/// To use this in a query, the query must have type annotations. +/// See: https://www.gitmemory.com/issue/launchbadge/sqlx/1241/847154375 +/// eg. preferred_tts_result_visibility as `rating_type: crate::enums::by_table::user_ratings::rating_type::UserRatingValue` +/// +/// See also: https://docs.rs/sqlx/0.4.0-beta.1/sqlx/trait.Type.html +/// +/// *DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY!* +/// +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[serde(rename_all = "lowercase")] +pub enum UserRatingValue { + /// This is considered a ratings "soft deletion" and does not count towards a total score. + /// This is the default rating. + Neutral, + /// This is a positive vote / upvote / like. + /// They are available to non-logged-in users as long as they have the URL. + Positive, + /// This is a negative vote / downvote / dislike. + Negative, +} + + +impl_enum_display_and_debug_using_to_str!(UserRatingValue); + +impl Default for UserRatingValue { + fn default() -> Self { Self::Neutral } +} + +/// NB: Legacy API for older code. +impl UserRatingValue { + pub fn to_str(&self) -> &'static str { + match self { + Self::Neutral => "neutral", + Self::Positive => "positive", + Self::Negative => "negative", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "neutral" => Ok(Self::Neutral), + "positive" => Ok(Self::Positive), + "negative" => Ok(Self::Negative), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::user_ratings::rating_value::UserRatingValue; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(UserRatingValue::Neutral, "neutral"); + assert_serialization(UserRatingValue::Positive, "positive"); + assert_serialization(UserRatingValue::Negative, "negative"); + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(UserRatingValue::Neutral.to_str(), "neutral"); + assert_eq!(UserRatingValue::Positive.to_str(), "positive"); + assert_eq!(UserRatingValue::Negative.to_str(), "negative"); + } + + #[test] + fn from_str() { + assert_eq!(UserRatingValue::from_str("neutral").unwrap(), UserRatingValue::Neutral); + assert_eq!(UserRatingValue::from_str("positive").unwrap(), UserRatingValue::Positive); + assert_eq!(UserRatingValue::from_str("negative").unwrap(), UserRatingValue::Negative); + assert!(UserRatingValue::from_str("foo").is_err()); + } + } + + mod traits { + use super::*; + + #[test] + fn default() { + assert_eq!(UserRatingValue::default(), UserRatingValue::Neutral); + } + + #[test] + fn display() { + let visibility = UserRatingValue::Positive; + assert_eq!(format!("{}", visibility), "positive".to_string()); + } + + #[test] + fn debug() { + let visibility = UserRatingValue::Negative; + assert_eq!(format!("{:?}", visibility), "negative".to_string()); + } + } + + #[derive(Serialize, Deserialize, PartialEq, Debug)] + struct CompositeType { + visibility: UserRatingValue, + string: String, + } + + mod serde_serialization { + use super::*; + + #[test] + fn serialize() { + let expected = "\"positive\"".to_string(); // NB: Quoted + + assert_eq!(expected, serde_json::to_string(&UserRatingValue::Positive).unwrap()); + + // Just to show this serializes the same as a string + assert_eq!(expected, serde_json::to_string("positive").unwrap()); + } + + #[test] + fn nested_serialize() { + let value = CompositeType { visibility: UserRatingValue::Negative, string: "bar".to_string() }; + let expected = r#"{"visibility":"negative","string":"bar"}"#.to_string(); + assert_eq!(expected, serde_json::to_string(&value).unwrap()); + } + } + + mod serde_deserialization { + use super::*; + + #[test] + fn deserialize() { + let payload = "\"positive\""; // NB: Quoted + let value: UserRatingValue = serde_json::from_str(payload).unwrap(); + assert_eq!(value, UserRatingValue::Positive); + } + + #[test] + fn nested_deserialize() { + let payload = r#"{"visibility":"neutral","string":"bar"}"#.to_string(); + let expected = CompositeType { + visibility: UserRatingValue::Neutral, + string: "bar".to_string(), + }; + + assert_eq!(expected, serde_json::from_str::(&payload).unwrap()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/mod.rs new file mode 100644 index 00000000..d8ce5e91 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/mod.rs @@ -0,0 +1,2 @@ +pub mod payment_event_type; +pub mod payment_source; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/payment_event_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/payment_event_type.rs new file mode 100644 index 00000000..00b6c60c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/payment_event_type.rs @@ -0,0 +1,208 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `user_spend_events` table in a `VARCHAR(32)` field. +/// +/// Splits subscription revenue from credit-pack revenue, plus the +/// money-out (refund/chargeback) and non-revenue (manual / monthly refill) cases. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum PaymentEventType { + /// First paid invoice of a new subscription. + #[serde(rename = "subscription_initial")] + SubscriptionInitial, + + /// Recurring paid invoice (monthly, or annual once per year). + #[serde(rename = "subscription_renewal")] + SubscriptionRenewal, + + /// Proration charge from a mid-cycle upgrade (positive amount). + #[serde(rename = "subscription_proration_upgrade")] + SubscriptionProrationUpgrade, + + /// Proration credit from a mid-cycle downgrade (typically a balance credit; + /// rare as a standalone settled event). NB: "subscription_proration_downgrade" + /// is 32 chars -- exactly the event_type VARCHAR(32) limit (zero headroom). + #[serde(rename = "subscription_proration_downgrade")] + SubscriptionProrationDowngrade, + + /// One-time credit pack purchase (the ~10x-volume case). + #[serde(rename = "credit_pack_purchase")] + CreditPackPurchase, + + /// Refund (amount negative). + #[serde(rename = "refund")] + Refund, + + /// Dispute / chargeback (amount negative). + #[serde(rename = "chargeback")] + Chargeback, + + /// Staff / console correction (payment_source = 'manual'). + #[serde(rename = "manual_adjustment")] + ManualAdjustment, + + /// Non-revenue event for annual-plan monthly credit refills (amount 0). + #[serde(rename = "subscription_monthly_refill")] + SubscriptionMonthlyRefill, +} + +impl_enum_display_and_debug_using_to_str!(PaymentEventType); + +/// NB: Legacy API for older code. +impl PaymentEventType { + pub fn to_str(&self) -> &'static str { + match self { + Self::SubscriptionInitial => "subscription_initial", + Self::SubscriptionRenewal => "subscription_renewal", + Self::SubscriptionProrationUpgrade => "subscription_proration_upgrade", + Self::SubscriptionProrationDowngrade => "subscription_proration_downgrade", + Self::CreditPackPurchase => "credit_pack_purchase", + Self::Refund => "refund", + Self::Chargeback => "chargeback", + Self::ManualAdjustment => "manual_adjustment", + Self::SubscriptionMonthlyRefill => "subscription_monthly_refill", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "subscription_initial" => Ok(Self::SubscriptionInitial), + "subscription_renewal" => Ok(Self::SubscriptionRenewal), + "subscription_proration_upgrade" => Ok(Self::SubscriptionProrationUpgrade), + "subscription_proration_downgrade" => Ok(Self::SubscriptionProrationDowngrade), + "credit_pack_purchase" => Ok(Self::CreditPackPurchase), + "refund" => Ok(Self::Refund), + "chargeback" => Ok(Self::Chargeback), + "manual_adjustment" => Ok(Self::ManualAdjustment), + "subscription_monthly_refill" => Ok(Self::SubscriptionMonthlyRefill), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::SubscriptionInitial, + Self::SubscriptionRenewal, + Self::SubscriptionProrationUpgrade, + Self::SubscriptionProrationDowngrade, + Self::CreditPackPurchase, + Self::Refund, + Self::Chargeback, + Self::ManualAdjustment, + Self::SubscriptionMonthlyRefill, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::user_spend_events::payment_event_type::PaymentEventType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PaymentEventType::SubscriptionInitial, "subscription_initial"); + assert_serialization(PaymentEventType::SubscriptionRenewal, "subscription_renewal"); + assert_serialization(PaymentEventType::SubscriptionProrationUpgrade, "subscription_proration_upgrade"); + assert_serialization(PaymentEventType::SubscriptionProrationDowngrade, "subscription_proration_downgrade"); + assert_serialization(PaymentEventType::CreditPackPurchase, "credit_pack_purchase"); + assert_serialization(PaymentEventType::Refund, "refund"); + assert_serialization(PaymentEventType::Chargeback, "chargeback"); + assert_serialization(PaymentEventType::ManualAdjustment, "manual_adjustment"); + assert_serialization(PaymentEventType::SubscriptionMonthlyRefill, "subscription_monthly_refill"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(PaymentEventType::SubscriptionInitial.to_str(), "subscription_initial"); + assert_eq!(PaymentEventType::SubscriptionRenewal.to_str(), "subscription_renewal"); + assert_eq!(PaymentEventType::SubscriptionProrationUpgrade.to_str(), "subscription_proration_upgrade"); + assert_eq!(PaymentEventType::SubscriptionProrationDowngrade.to_str(), "subscription_proration_downgrade"); + assert_eq!(PaymentEventType::CreditPackPurchase.to_str(), "credit_pack_purchase"); + assert_eq!(PaymentEventType::Refund.to_str(), "refund"); + assert_eq!(PaymentEventType::Chargeback.to_str(), "chargeback"); + assert_eq!(PaymentEventType::ManualAdjustment.to_str(), "manual_adjustment"); + assert_eq!(PaymentEventType::SubscriptionMonthlyRefill.to_str(), "subscription_monthly_refill"); + } + + #[test] + fn from_str() { + assert_eq!(PaymentEventType::from_str("subscription_initial").unwrap(), PaymentEventType::SubscriptionInitial); + assert_eq!(PaymentEventType::from_str("subscription_renewal").unwrap(), PaymentEventType::SubscriptionRenewal); + assert_eq!(PaymentEventType::from_str("subscription_proration_upgrade").unwrap(), PaymentEventType::SubscriptionProrationUpgrade); + assert_eq!(PaymentEventType::from_str("subscription_proration_downgrade").unwrap(), PaymentEventType::SubscriptionProrationDowngrade); + assert_eq!(PaymentEventType::from_str("credit_pack_purchase").unwrap(), PaymentEventType::CreditPackPurchase); + assert_eq!(PaymentEventType::from_str("refund").unwrap(), PaymentEventType::Refund); + assert_eq!(PaymentEventType::from_str("chargeback").unwrap(), PaymentEventType::Chargeback); + assert_eq!(PaymentEventType::from_str("manual_adjustment").unwrap(), PaymentEventType::ManualAdjustment); + assert_eq!(PaymentEventType::from_str("subscription_monthly_refill").unwrap(), PaymentEventType::SubscriptionMonthlyRefill); + assert!(PaymentEventType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = PaymentEventType::all_variants(); + assert_eq!(variants.len(), 9); + assert_eq!(variants.pop_first(), Some(PaymentEventType::SubscriptionInitial)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::SubscriptionRenewal)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::SubscriptionProrationUpgrade)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::SubscriptionProrationDowngrade)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::CreditPackPurchase)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::Refund)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::Chargeback)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::ManualAdjustment)); + assert_eq!(variants.pop_first(), Some(PaymentEventType::SubscriptionMonthlyRefill)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PaymentEventType::all_variants().len(), PaymentEventType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PaymentEventType::all_variants() { + assert_eq!(variant, PaymentEventType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PaymentEventType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PaymentEventType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in PaymentEventType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/payment_source.rs b/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/payment_source.rs new file mode 100644 index 00000000..4439857c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/user_spend_events/payment_source.rs @@ -0,0 +1,129 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `user_spend_events` table in a `VARCHAR(16)` field. +/// +/// Where a spend event came from. USD/Stripe only for the foreseeable future; +/// `manual` covers staff/console adjustments (which carry a NULL source_object_id). +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum PaymentSource { + /// Stripe (the source for essentially all rows). + #[serde(rename = "stripe")] + Stripe, + + /// Manual staff / console adjustment (no provider object). + #[serde(rename = "manual")] + Manual, +} + +impl_enum_display_and_debug_using_to_str!(PaymentSource); + +/// NB: Legacy API for older code. +impl PaymentSource { + pub fn to_str(&self) -> &'static str { + match self { + Self::Stripe => "stripe", + Self::Manual => "manual", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "stripe" => Ok(Self::Stripe), + "manual" => Ok(Self::Manual), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Stripe, + Self::Manual, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::user_spend_events::payment_source::PaymentSource; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PaymentSource::Stripe, "stripe"); + assert_serialization(PaymentSource::Manual, "manual"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(PaymentSource::Stripe.to_str(), "stripe"); + assert_eq!(PaymentSource::Manual.to_str(), "manual"); + } + + #[test] + fn from_str() { + assert_eq!(PaymentSource::from_str("stripe").unwrap(), PaymentSource::Stripe); + assert_eq!(PaymentSource::from_str("manual").unwrap(), PaymentSource::Manual); + assert!(PaymentSource::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = PaymentSource::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(PaymentSource::Stripe)); + assert_eq!(variants.pop_first(), Some(PaymentSource::Manual)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PaymentSource::all_variants().len(), PaymentSource::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PaymentSource::all_variants() { + assert_eq!(variant, PaymentSource::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PaymentSource::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PaymentSource::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 16; + for variant in PaymentSource::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/users/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/users/mod.rs new file mode 100644 index 00000000..486ee107 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/users/mod.rs @@ -0,0 +1,3 @@ +pub mod user_feature_flag; +pub mod user_signup_method; +pub mod user_signup_source; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/users/user_feature_flag.rs b/crates/api_clients/artcraft_client/src/enums/by_table/users/user_feature_flag.rs new file mode 100644 index 00000000..9f92eda6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/users/user_feature_flag.rs @@ -0,0 +1,225 @@ +use std::collections::BTreeSet; + +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `users` table in a `VARCHAR` field (stored as comma separated set). +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum UserFeatureFlag { + /// Grants a user the ability to list media + /// (For now, it's hidden until we get an NSFW filter.) + ExploreMedia, + + + /// Access to studio features + Studio, + + /// Whether users are allowed to upload 3D models + #[serde(rename = "upload_3d")] + Upload3d, + + /// Access to video style transfer + VideoStyleTransfer, + + /// Access to the faster Seedance 2.0 whitelist + #[serde(rename = "sd_wl")] + SeedanceWhitelist, + + /// Access to Happy Horse + #[serde(rename = "hh")] + HappyHorse, + + /// Access to Happy Horse (with a rate limit) + #[serde(rename = "hh_rl")] + HappyHorseRateLimit, + + /// Access to the referrals program + #[serde(rename = "referrals")] + ReferralsProgram, + + /// Access to API key creation + #[serde(rename = "api_key")] + ApiKey, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(UserFeatureFlag); + +/// NB: Legacy API for older code. +impl UserFeatureFlag { + pub fn to_str(&self) -> &'static str { + match self { + Self::ExploreMedia => "explore_media", + Self::Studio => "studio", + Self::Upload3d => "upload_3d", + Self::VideoStyleTransfer => "video_style_transfer", + Self::SeedanceWhitelist => "sd_wl", + Self::HappyHorse => "hh", + Self::HappyHorseRateLimit => "hh_rl", + Self::ReferralsProgram => "referrals", + Self::ApiKey => "api_key", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "explore_media" => Ok(Self::ExploreMedia), + "studio" => Ok(Self::Studio), + "upload_3d" => Ok(Self::Upload3d), + "video_style_transfer" => Ok(Self::VideoStyleTransfer), + "sd_wl" => Ok(Self::SeedanceWhitelist), + "hh" => Ok(Self::HappyHorse), + "hh_rl" => Ok(Self::HappyHorseRateLimit), + "referrals" => Ok(Self::ReferralsProgram), + "api_key" => Ok(Self::ApiKey), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn name(&self) -> &'static str { + match self { + Self::ExploreMedia => "Explore Media", + Self::Studio => "Storyteller Studio", + Self::Upload3d => "Upload 3D", + Self::VideoStyleTransfer => "Video Style Transfer", + Self::SeedanceWhitelist => "DO NOT USE: Seedance Whitelist (legacy)", + Self::HappyHorse => "Happy Horse (no Rate Limit)", + Self::HappyHorseRateLimit => "Happy Horse (with Rate Limit)", + Self::ReferralsProgram => "Referrals Program", + Self::ApiKey => "API Keys", + } + } + + pub fn description(&self) -> &'static str { + match self { + Self::ExploreMedia => "Grants a user the ability to list media on FakeYou (admin permission)", + Self::Studio => "Access to Storyteller Studio product", + Self::Upload3d => "Whether users are allowed to upload 3D models", + Self::VideoStyleTransfer => "Access to video style transfer on Storyteller", + Self::SeedanceWhitelist => "DO NOT USE THIS. IT WILL BREAK ACCOUNTS.", + Self::HappyHorse => "Access to Happy Horse (without a rate limit - dangerous)", + Self::HappyHorseRateLimit => "Access to Happy Horse (with a rate limit)", + Self::ReferralsProgram => "Access to the referrals program", + Self::ApiKey => "Access to API key creation", + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ExploreMedia, + Self::Studio, + Self::Upload3d, + Self::VideoStyleTransfer, + Self::SeedanceWhitelist, + Self::HappyHorse, + Self::HappyHorseRateLimit, + Self::ReferralsProgram, + Self::ApiKey, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::users::user_feature_flag::UserFeatureFlag; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(UserFeatureFlag::ExploreMedia, "explore_media"); + assert_serialization(UserFeatureFlag::Studio, "studio"); + assert_serialization(UserFeatureFlag::Upload3d, "upload_3d"); + assert_serialization(UserFeatureFlag::VideoStyleTransfer, "video_style_transfer"); + assert_serialization(UserFeatureFlag::SeedanceWhitelist, "sd_wl"); + assert_serialization(UserFeatureFlag::HappyHorse, "hh"); + assert_serialization(UserFeatureFlag::HappyHorseRateLimit, "hh_rl"); + assert_serialization(UserFeatureFlag::ReferralsProgram, "referrals"); + assert_serialization(UserFeatureFlag::ApiKey, "api_key"); + } + + #[test] + fn test_to_str() { + assert_eq!(UserFeatureFlag::ExploreMedia.to_str(), "explore_media"); + assert_eq!(UserFeatureFlag::Studio.to_str(), "studio"); + assert_eq!(UserFeatureFlag::Upload3d.to_str(), "upload_3d"); + assert_eq!(UserFeatureFlag::VideoStyleTransfer.to_str(), "video_style_transfer"); + assert_eq!(UserFeatureFlag::SeedanceWhitelist.to_str(), "sd_wl"); + assert_eq!(UserFeatureFlag::HappyHorse.to_str(), "hh"); + assert_eq!(UserFeatureFlag::HappyHorseRateLimit.to_str(), "hh_rl"); + assert_eq!(UserFeatureFlag::ReferralsProgram.to_str(), "referrals"); + assert_eq!(UserFeatureFlag::ApiKey.to_str(), "api_key"); + } + + #[test] + fn test_from_str() { + assert_eq!(UserFeatureFlag::from_str("explore_media").unwrap(), UserFeatureFlag::ExploreMedia); + assert_eq!(UserFeatureFlag::from_str("studio").unwrap(), UserFeatureFlag::Studio); + assert_eq!(UserFeatureFlag::from_str("upload_3d").unwrap(), UserFeatureFlag::Upload3d); + assert_eq!(UserFeatureFlag::from_str("video_style_transfer").unwrap(), UserFeatureFlag::VideoStyleTransfer); + assert_eq!(UserFeatureFlag::from_str("sd_wl").unwrap(), UserFeatureFlag::SeedanceWhitelist); + assert_eq!(UserFeatureFlag::from_str("hh").unwrap(), UserFeatureFlag::HappyHorse); + assert_eq!(UserFeatureFlag::from_str("hh_rl").unwrap(), UserFeatureFlag::HappyHorseRateLimit); + assert_eq!(UserFeatureFlag::from_str("referrals").unwrap(), UserFeatureFlag::ReferralsProgram); + assert_eq!(UserFeatureFlag::from_str("api_key").unwrap(), UserFeatureFlag::ApiKey); + assert!(UserFeatureFlag::from_str("foo").is_err()); + } + + #[test] + fn all_variants() { + let mut variants = UserFeatureFlag::all_variants(); + assert_eq!(variants.len(), 9); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::ExploreMedia)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::Studio)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::Upload3d)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::VideoStyleTransfer)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::SeedanceWhitelist)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::HappyHorse)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::HappyHorseRateLimit)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::ReferralsProgram)); + assert_eq!(variants.pop_first(), Some(UserFeatureFlag::ApiKey)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(UserFeatureFlag::all_variants().len(), UserFeatureFlag::iter().len()); + } + + #[test] + fn round_trip() { + for variant in UserFeatureFlag::all_variants() { + assert_eq!(variant, UserFeatureFlag::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UserFeatureFlag::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UserFeatureFlag::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in UserFeatureFlag::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/users/user_signup_method.rs b/crates/api_clients/artcraft_client/src/enums/by_table/users/user_signup_method.rs new file mode 100644 index 00000000..fa4cd416 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/users/user_signup_method.rs @@ -0,0 +1,137 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `users` table in a `VARCHAR(16)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum UserSignupMethod { + /// Email + Password + EmailPassword, + + /// "Sign in With Google" SSO + GoogleSignIn, + + /// Stripe Checkout flow, where we provision user accounts for users with a + /// synthetic/fake email address and no password. After checkout completes, + /// the user gets a real email and password - or the user can set them. + StripeCheckout, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(UserSignupMethod); + +/// NB: Legacy API for older code. +impl UserSignupMethod { + pub fn to_str(&self) -> &'static str { + match self { + Self::EmailPassword => "email_password", + Self::GoogleSignIn=> "google_sign_in", + Self::StripeCheckout => "stripe_checkout", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "email_password" => Ok(Self::EmailPassword), + "google_sign_in" => Ok(Self::GoogleSignIn), + "stripe_checkout" => Ok(Self::StripeCheckout), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::EmailPassword, + Self::GoogleSignIn, + Self::StripeCheckout, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::users::user_signup_method::UserSignupMethod; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(UserSignupMethod::EmailPassword, "email_password"); + assert_serialization(UserSignupMethod::GoogleSignIn, "google_sign_in"); + assert_serialization(UserSignupMethod::StripeCheckout, "stripe_checkout"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(UserSignupMethod::EmailPassword.to_str(), "email_password"); + assert_eq!(UserSignupMethod::GoogleSignIn.to_str(), "google_sign_in"); + assert_eq!(UserSignupMethod::StripeCheckout.to_str(), "stripe_checkout"); + } + + #[test] + fn from_str() { + assert_eq!(UserSignupMethod::from_str("email_password").unwrap(), UserSignupMethod::EmailPassword); + assert_eq!(UserSignupMethod::from_str("google_sign_in").unwrap(), UserSignupMethod::GoogleSignIn); + assert_eq!(UserSignupMethod::from_str("stripe_checkout").unwrap(), UserSignupMethod::StripeCheckout); + assert!(UserSignupMethod::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = UserSignupMethod::all_variants(); + assert_eq!(variants.len(), 3); + assert_eq!(variants.pop_first(), Some(UserSignupMethod::EmailPassword)); + assert_eq!(variants.pop_first(), Some(UserSignupMethod::GoogleSignIn)); + assert_eq!(variants.pop_first(), Some(UserSignupMethod::StripeCheckout)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(UserSignupMethod::all_variants().len(), UserSignupMethod::iter().len()); + } + + #[test] + fn round_trip() { + for variant in UserSignupMethod::all_variants() { + assert_eq!(variant, UserSignupMethod::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UserSignupMethod::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UserSignupMethod::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in UserSignupMethod::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/users/user_signup_source.rs b/crates/api_clients/artcraft_client/src/enums/by_table/users/user_signup_source.rs new file mode 100644 index 00000000..8b2c54d6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/users/user_signup_source.rs @@ -0,0 +1,190 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `users` table in a `VARCHAR(255)` (which should be a `VARCHAR(16)`) field, `maybe_source`. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum UserSignupSource { + #[deprecated(since = "2026-01-30", note = "Use other Artcraft* enum variants instead")] + #[serde(rename = "artcraft")] + ArtCraft, + + /// ArtCraft Tauri App Onboard Flow + #[serde(rename = "artcraft_app")] + ArtCraftApp, + + /// artcraft.ai normal onboard flow + #[serde(rename = "artcraft_ai_web")] + ArtCraftAiWeb, + + /// artcraft.ai stripe checkout flow + #[serde(rename = "artcraft_ai_s")] + ArtCraftAiStripe, + + /// getartcraft.com normal onboard flow + #[serde(rename = "artcraft_get_web")] + ArtCraftGetWeb, + + /// getartcraft.com stripe checkout flow + #[serde(rename = "artcraft_get_s")] + ArtCraftGetStripe, + + #[serde(rename = "fakeyou")] + FakeYou, + + #[serde(rename = "storyteller")] + Storyteller, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(UserSignupSource); + +/// NB: Legacy API for older code. +impl UserSignupSource { + pub fn to_str(&self) -> &'static str { + match self { + Self::ArtCraft => "artcraft", + Self::ArtCraftApp => "artcraft_app", + Self::ArtCraftAiWeb => "artcraft_ai_web", + Self::ArtCraftAiStripe => "artcraft_ai_s", + Self::ArtCraftGetWeb => "artcraft_get_web", + Self::ArtCraftGetStripe => "artcraft_get_s", + Self::FakeYou => "fakeyou", + Self::Storyteller => "storyteller", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "artcraft" => Ok(Self::ArtCraft), + "artcraft_app" => Ok(Self::ArtCraftApp), + "artcraft_ai_web" => Ok(Self::ArtCraftAiWeb), + "artcraft_ai_s" => Ok(Self::ArtCraftAiStripe), + "artcraft_get_web" => Ok(Self::ArtCraftGetWeb), + "artcraft_get_s" => Ok(Self::ArtCraftGetStripe), + "fakeyou" => Ok(Self::FakeYou), + "storyteller" => Ok(Self::Storyteller), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ArtCraft, + Self::ArtCraftApp, + Self::ArtCraftAiWeb, + Self::ArtCraftAiStripe, + Self::ArtCraftGetWeb, + Self::ArtCraftGetStripe, + Self::FakeYou, + Self::Storyteller, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::users::user_signup_source::UserSignupSource; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(UserSignupSource::ArtCraft, "artcraft"); + assert_serialization(UserSignupSource::ArtCraftApp, "artcraft_app"); + assert_serialization(UserSignupSource::ArtCraftAiWeb, "artcraft_ai_web"); + assert_serialization(UserSignupSource::ArtCraftAiStripe, "artcraft_ai_s"); + assert_serialization(UserSignupSource::ArtCraftGetWeb, "artcraft_get_web"); + assert_serialization(UserSignupSource::ArtCraftGetStripe, "artcraft_get_s"); + assert_serialization(UserSignupSource::FakeYou, "fakeyou"); + assert_serialization(UserSignupSource::Storyteller, "storyteller"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(UserSignupSource::ArtCraft.to_str(), "artcraft"); + assert_eq!(UserSignupSource::ArtCraftApp.to_str(), "artcraft_app"); + assert_eq!(UserSignupSource::ArtCraftAiWeb.to_str(), "artcraft_ai_web"); + assert_eq!(UserSignupSource::ArtCraftAiStripe.to_str(), "artcraft_ai_s"); + assert_eq!(UserSignupSource::ArtCraftGetWeb.to_str(), "artcraft_get_web"); + assert_eq!(UserSignupSource::FakeYou.to_str(), "fakeyou"); + assert_eq!(UserSignupSource::Storyteller.to_str(), "storyteller"); + } + + #[test] + fn from_str() { + assert_eq!(UserSignupSource::from_str("artcraft").unwrap(), UserSignupSource::ArtCraft); + assert_eq!(UserSignupSource::from_str("artcraft_app").unwrap(), UserSignupSource::ArtCraftApp); + assert_eq!(UserSignupSource::from_str("artcraft_ai_web").unwrap(), UserSignupSource::ArtCraftAiWeb); + assert_eq!(UserSignupSource::from_str("artcraft_ai_s").unwrap(), UserSignupSource::ArtCraftAiStripe); + assert_eq!(UserSignupSource::from_str("artcraft_get_web").unwrap(), UserSignupSource::ArtCraftGetWeb); + assert_eq!(UserSignupSource::from_str("artcraft_get_s").unwrap(), UserSignupSource::ArtCraftGetStripe); + assert_eq!(UserSignupSource::from_str("fakeyou").unwrap(), UserSignupSource::FakeYou); + assert_eq!(UserSignupSource::from_str("storyteller").unwrap(), UserSignupSource::Storyteller); + assert!(UserSignupSource::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = UserSignupSource::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(UserSignupSource::ArtCraft)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::ArtCraftApp)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::ArtCraftAiWeb)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::ArtCraftAiStripe)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::ArtCraftGetWeb)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::ArtCraftGetStripe)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::FakeYou)); + assert_eq!(variants.pop_first(), Some(UserSignupSource::Storyteller)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(UserSignupSource::all_variants().len(), UserSignupSource::iter().len()); + } + + #[test] + fn round_trip() { + for variant in UserSignupSource::all_variants() { + assert_eq!(variant, UserSignupSource::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, UserSignupSource::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, UserSignupSource::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in UserSignupSource::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_models/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_models/mod.rs new file mode 100644 index 00000000..e29f2152 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_models/mod.rs @@ -0,0 +1 @@ +pub mod voice_conversion_model_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_models/voice_conversion_model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_models/voice_conversion_model_type.rs new file mode 100644 index 00000000..1dac1216 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_models/voice_conversion_model_type.rs @@ -0,0 +1,99 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `voice_conversion_models` table in `VARCHAR(32)` field `model_type`. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum VoiceConversionModelType { + // We're skipping RVC "v1" models as "v2" are much higher quality. + // Future incompatible upgrades may deserve a different enum variant. + #[serde(rename = "rvc_v2")] + RvcV2, + + #[serde(rename = "soft_vc")] + SoftVc, + + #[serde(rename = "so_vits_svc")] + SoVitsSvc, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(VoiceConversionModelType); + +/// NB: Legacy API for older code. +impl VoiceConversionModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::RvcV2 => "rvc_v2", + Self::SoftVc => "soft_vc", + Self::SoVitsSvc => "so_vits_svc", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "rvc_v2" => Ok(Self::RvcV2), + "soft_vc" => Ok(Self::SoftVc), + "so_vits_svc" => Ok(Self::SoVitsSvc), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::RvcV2, + Self::SoftVc, + Self::SoVitsSvc, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::voice_conversion_models::voice_conversion_model_type::VoiceConversionModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(VoiceConversionModelType::RvcV2, "rvc_v2"); + assert_serialization(VoiceConversionModelType::SoftVc, "soft_vc"); + assert_serialization(VoiceConversionModelType::SoVitsSvc, "so_vits_svc"); + } + + #[test] + fn to_str() { + assert_eq!(VoiceConversionModelType::RvcV2.to_str(), "rvc_v2"); + assert_eq!(VoiceConversionModelType::SoftVc.to_str(), "soft_vc"); + assert_eq!(VoiceConversionModelType::SoVitsSvc.to_str(), "so_vits_svc"); + } + + #[test] + fn from_str() { + assert_eq!(VoiceConversionModelType::from_str("rvc_v2").unwrap(), VoiceConversionModelType::RvcV2); + assert_eq!(VoiceConversionModelType::from_str("soft_vc").unwrap(), VoiceConversionModelType::SoftVc); + assert_eq!(VoiceConversionModelType::from_str("so_vits_svc").unwrap(), VoiceConversionModelType::SoVitsSvc); + } + + #[test] + fn all_variants() { + // Static check + let mut variants = VoiceConversionModelType::all_variants(); + assert_eq!(variants.len(), 3); + assert_eq!(variants.pop_first(), Some(VoiceConversionModelType::RvcV2)); + assert_eq!(variants.pop_first(), Some(VoiceConversionModelType::SoftVc)); + assert_eq!(variants.pop_first(), Some(VoiceConversionModelType::SoVitsSvc)); + assert_eq!(variants.pop_first(), None); + + // Generated check + use strum::IntoEnumIterator; + assert_eq!(VoiceConversionModelType::all_variants().len(), VoiceConversionModelType::iter().len()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_results/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_results/mod.rs new file mode 100644 index 00000000..b1edddf9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_results/mod.rs @@ -0,0 +1 @@ +pub mod voice_conversion_media_token_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_results/voice_conversion_media_token_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_results/voice_conversion_media_token_type.rs new file mode 100644 index 00000000..d150a8cb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/voice_conversion_results/voice_conversion_media_token_type.rs @@ -0,0 +1,58 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `voice_conversion_results` table in a `VARCHAR` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum VoiceConversionMediaTokenType { + /// Media token refers to record in `media_uploads` table. + MediaUpload, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(VoiceConversionMediaTokenType); + +/// NB: Legacy API for older code. +impl VoiceConversionMediaTokenType { + pub fn to_str(&self) -> &'static str { + match self { + Self::MediaUpload => "media_upload", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "media_upload" => Ok(Self::MediaUpload), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::voice_conversion_results::voice_conversion_media_token_type::VoiceConversionMediaTokenType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(VoiceConversionMediaTokenType::MediaUpload, "media_upload"); + } + + #[test] + fn test_to_str() { + assert_eq!(VoiceConversionMediaTokenType::MediaUpload.to_str(), "media_upload"); + } + + #[test] + fn test_from_str() { + assert_eq!(VoiceConversionMediaTokenType::from_str("media_upload").unwrap(), VoiceConversionMediaTokenType::MediaUpload); + assert!(VoiceConversionMediaTokenType::from_str("foo").is_err()); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/wallet_ledger_entries/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/wallet_ledger_entries/mod.rs new file mode 100644 index 00000000..618223e1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/wallet_ledger_entries/mod.rs @@ -0,0 +1 @@ +pub mod wallet_ledger_entry_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/wallet_ledger_entries/wallet_ledger_entry_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/wallet_ledger_entries/wallet_ledger_entry_type.rs new file mode 100644 index 00000000..ecda5b3f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/wallet_ledger_entries/wallet_ledger_entry_type.rs @@ -0,0 +1,201 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `wallet_ledger_entries` table in a `VARCHAR(16)` field. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum WalletLedgerEntryType { + /// Wallet created + #[serde(rename = "create")] + Create, + + /// Credit durable banked balance + #[serde(rename = "credit_banked")] + CreditBanked, + + /// Credit monthly refill + #[serde(rename = "credit_monthly")] + CreditMonthly, + + /// Deduct credits (mixed durable and monthly deduction) + #[serde(rename = "deduct_mixed")] + DeductMixed, + + /// Deduct durable banked credits + #[serde(rename = "deduct_banked")] + DeductBanked, + + /// Deduct monthly credits + #[serde(rename = "deduct_monthly")] + DeductMonthly, + + /// Refund banked credits + #[serde(rename = "refund_banked")] + RefundBanked, + + /// Support staff manually credit account + #[serde(rename = "staff_add_banked")] + StaffAddBanked, + + // TODO: No clean way to do "mixed" refunds yet, and if we + // refund close to the cutoff it might be unfair. Let's + // just not do monthly refunds yet and instead credit our + // users with banked credits. + // /// Refund monthly credits + // #[serde(rename = "refund_monthly")] + // RefundMonthly, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(WalletLedgerEntryType); + +/// NB: Legacy API for older code. +impl WalletLedgerEntryType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Create => "create", + Self::CreditBanked => "credit_banked", + Self::CreditMonthly => "credit_monthly", + Self::DeductMixed => "deduct_mixed", + Self::DeductBanked => "deduct_banked", + Self::DeductMonthly => "deduct_monthly", + Self::RefundBanked => "refund_banked", + Self::StaffAddBanked => "staff_add_banked", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "create" => Ok(Self::Create), + "credit_banked" => Ok(Self::CreditBanked), + "credit_monthly" => Ok(Self::CreditMonthly), + "deduct_mixed" => Ok(Self::DeductMixed), + "deduct_banked" => Ok(Self::DeductBanked), + "deduct_monthly" => Ok(Self::DeductMonthly), + "refund_banked" => Ok(Self::RefundBanked), + "staff_add_banked" => Ok(Self::StaffAddBanked), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Create, + Self::CreditBanked, + Self::CreditMonthly, + Self::DeductMixed, + Self::DeductBanked, + Self::DeductMonthly, + Self::RefundBanked, + Self::StaffAddBanked, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::wallet_ledger_entries::wallet_ledger_entry_type::WalletLedgerEntryType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(WalletLedgerEntryType::Create, "create"); + assert_serialization(WalletLedgerEntryType::CreditBanked, "credit_banked"); + assert_serialization(WalletLedgerEntryType::CreditMonthly, "credit_monthly"); + assert_serialization(WalletLedgerEntryType::DeductMixed, "deduct_mixed"); + assert_serialization(WalletLedgerEntryType::DeductBanked, "deduct_banked"); + assert_serialization(WalletLedgerEntryType::DeductMonthly, "deduct_monthly"); + assert_serialization(WalletLedgerEntryType::RefundBanked, "refund_banked"); + assert_serialization(WalletLedgerEntryType::StaffAddBanked, "staff_add_banked"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(WalletLedgerEntryType::Create.to_str(), "create"); + assert_eq!(WalletLedgerEntryType::CreditBanked.to_str(), "credit_banked"); + assert_eq!(WalletLedgerEntryType::CreditMonthly.to_str(), "credit_monthly"); + assert_eq!(WalletLedgerEntryType::DeductMixed.to_str(), "deduct_mixed"); + assert_eq!(WalletLedgerEntryType::DeductBanked.to_str(), "deduct_banked"); + assert_eq!(WalletLedgerEntryType::DeductMonthly.to_str(), "deduct_monthly"); + assert_eq!(WalletLedgerEntryType::RefundBanked.to_str(), "refund_banked"); + assert_eq!(WalletLedgerEntryType::StaffAddBanked.to_str(), "staff_add_banked"); + } + + #[test] + fn from_str() { + assert_eq!(WalletLedgerEntryType::from_str("create").unwrap(), WalletLedgerEntryType::Create); + assert_eq!(WalletLedgerEntryType::from_str("credit_banked").unwrap(), WalletLedgerEntryType::CreditBanked); + assert_eq!(WalletLedgerEntryType::from_str("credit_monthly").unwrap(), WalletLedgerEntryType::CreditMonthly); + assert_eq!(WalletLedgerEntryType::from_str("deduct_mixed").unwrap(), WalletLedgerEntryType::DeductMixed); + assert_eq!(WalletLedgerEntryType::from_str("deduct_banked").unwrap(), WalletLedgerEntryType::DeductBanked); + assert_eq!(WalletLedgerEntryType::from_str("deduct_monthly").unwrap(), WalletLedgerEntryType::DeductMonthly); + assert_eq!(WalletLedgerEntryType::from_str("refund_banked").unwrap(), WalletLedgerEntryType::RefundBanked); + assert_eq!(WalletLedgerEntryType::from_str("staff_add_banked").unwrap(), WalletLedgerEntryType::StaffAddBanked); + assert!(WalletLedgerEntryType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = WalletLedgerEntryType::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::Create)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::CreditBanked)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::CreditMonthly)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::DeductMixed)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::DeductBanked)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::DeductMonthly)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::RefundBanked)); + assert_eq!(variants.pop_first(), Some(WalletLedgerEntryType::StaffAddBanked)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(WalletLedgerEntryType::all_variants().len(), WalletLedgerEntryType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in WalletLedgerEntryType::all_variants() { + assert_eq!(variant, WalletLedgerEntryType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, WalletLedgerEntryType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, WalletLedgerEntryType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in WalletLedgerEntryType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/web_rendition_targets/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/web_rendition_targets/mod.rs new file mode 100644 index 00000000..371fe4d3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/web_rendition_targets/mod.rs @@ -0,0 +1 @@ +pub mod rendition_status; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/web_rendition_targets/rendition_status.rs b/crates/api_clients/artcraft_client/src/enums/by_table/web_rendition_targets/rendition_status.rs new file mode 100644 index 00000000..c3372da7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/web_rendition_targets/rendition_status.rs @@ -0,0 +1,95 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the SqLite `web_scraping_targets` table in a `TEXT` field named `scraping_status`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum RenditionStatus { + #[serde(rename = "new")] + New, + + #[serde(rename = "skipped")] + Skipped, + + #[serde(rename = "failed")] + Failed, + + #[serde(rename = "permanently_failed")] + PermanentlyFailed, + + #[serde(rename = "success")] + Success, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(RenditionStatus); + +/// NB: Legacy API for older code. +impl RenditionStatus { + pub fn to_str(&self) -> &'static str { + match self { + Self::New => "new", + Self::Skipped => "skipped", + Self::Failed => "failed", + Self::PermanentlyFailed => "permanently_failed", + Self::Success => "success", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "new" => Ok(Self::New), + "skipped" => Ok(Self::Skipped), + "failed" => Ok(Self::Failed), + "permanently_failed" => Ok(Self::PermanentlyFailed), + "success" => Ok(Self::Success), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::web_rendition_targets::rendition_status::RenditionStatus; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(RenditionStatus::New, "new"); + assert_serialization(RenditionStatus::Skipped, "skipped"); + assert_serialization(RenditionStatus::Failed, "failed"); + assert_serialization(RenditionStatus::PermanentlyFailed, "permanently_failed"); + assert_serialization(RenditionStatus::Success, "success"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(RenditionStatus::New.to_str(), "new"); + assert_eq!(RenditionStatus::Skipped.to_str(), "skipped"); + assert_eq!(RenditionStatus::Failed.to_str(), "failed"); + assert_eq!(RenditionStatus::PermanentlyFailed.to_str(), "permanently_failed"); + assert_eq!(RenditionStatus::Success.to_str(), "success"); + } + + #[test] + fn test_from_str() { + assert_eq!(RenditionStatus::from_str("new").unwrap(), RenditionStatus::New); + assert_eq!(RenditionStatus::from_str("skipped").unwrap(), RenditionStatus::Skipped); + assert_eq!(RenditionStatus::from_str("failed").unwrap(), RenditionStatus::Failed); + assert_eq!(RenditionStatus::from_str("permanently_failed").unwrap(), RenditionStatus::PermanentlyFailed); + assert_eq!(RenditionStatus::from_str("success").unwrap(), RenditionStatus::Success); + assert!(RenditionStatus::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/web_scraping_targets/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/web_scraping_targets/mod.rs new file mode 100644 index 00000000..2dea4d45 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/web_scraping_targets/mod.rs @@ -0,0 +1 @@ +pub mod scraping_status; diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/web_scraping_targets/scraping_status.rs b/crates/api_clients/artcraft_client/src/enums/by_table/web_scraping_targets/scraping_status.rs new file mode 100644 index 00000000..0c905b8d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/web_scraping_targets/scraping_status.rs @@ -0,0 +1,95 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the SqLite `web_scraping_targets` table in a `TEXT` field named `scraping_status`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum ScrapingStatus { + #[serde(rename = "new")] + New, + + #[serde(rename = "skipped")] + Skipped, + + #[serde(rename = "failed")] + Failed, + + #[serde(rename = "permanently_failed")] + PermanentlyFailed, + + #[serde(rename = "success")] + Success, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(ScrapingStatus); + +/// NB: Legacy API for older code. +impl ScrapingStatus { + pub fn to_str(&self) -> &'static str { + match self { + Self::New => "new", + Self::Skipped => "skipped", + Self::Failed => "failed", + Self::PermanentlyFailed => "permanently_failed", + Self::Success => "success", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "new" => Ok(Self::New), + "skipped" => Ok(Self::Skipped), + "failed" => Ok(Self::Failed), + "permanently_failed" => Ok(Self::PermanentlyFailed), + "success" => Ok(Self::Success), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::web_scraping_targets::scraping_status::ScrapingStatus; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ScrapingStatus::New, "new"); + assert_serialization(ScrapingStatus::Skipped, "skipped"); + assert_serialization(ScrapingStatus::Failed, "failed"); + assert_serialization(ScrapingStatus::PermanentlyFailed, "permanently_failed"); + assert_serialization(ScrapingStatus::Success, "success"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(ScrapingStatus::New.to_str(), "new"); + assert_eq!(ScrapingStatus::Skipped.to_str(), "skipped"); + assert_eq!(ScrapingStatus::Failed.to_str(), "failed"); + assert_eq!(ScrapingStatus::PermanentlyFailed.to_str(), "permanently_failed"); + assert_eq!(ScrapingStatus::Success.to_str(), "success"); + } + + #[test] + fn test_from_str() { + assert_eq!(ScrapingStatus::from_str("new").unwrap(), ScrapingStatus::New); + assert_eq!(ScrapingStatus::from_str("skipped").unwrap(), ScrapingStatus::Skipped); + assert_eq!(ScrapingStatus::from_str("failed").unwrap(), ScrapingStatus::Failed); + assert_eq!(ScrapingStatus::from_str("permanently_failed").unwrap(), ScrapingStatus::PermanentlyFailed); + assert_eq!(ScrapingStatus::from_str("success").unwrap(), ScrapingStatus::Success); + assert!(ScrapingStatus::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/encoding_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/encoding_type.rs new file mode 100644 index 00000000..73b48408 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/encoding_type.rs @@ -0,0 +1,107 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `zs_voices` table in a `VARCHAR(16)` field named `encoding_type`. +/// +/// This indicates what type of features are used in the embeddings. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum ZsVoiceEncodingType { + /// Encodec features + #[serde(rename = "encodec")] + Encodec, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(ZsVoiceEncodingType); + +/// NB: Legacy API for older code. +impl ZsVoiceEncodingType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Encodec => "encodec", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "encodec" => Ok(Self::Encodec), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Encodec, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::zs_voices::encoding_type::ZsVoiceEncodingType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ZsVoiceEncodingType::Encodec, "encodec"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(ZsVoiceEncodingType::Encodec.to_str(), "encodec"); + } + + #[test] + fn from_str() { + assert_eq!(ZsVoiceEncodingType::from_str("encodec").unwrap(), ZsVoiceEncodingType::Encodec); + assert!(ZsVoiceEncodingType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = ZsVoiceEncodingType::all_variants(); + assert_eq!(variants.len(), 1); + assert_eq!(variants.pop_first(), Some(ZsVoiceEncodingType::Encodec)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(ZsVoiceEncodingType::all_variants().len(), ZsVoiceEncodingType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in ZsVoiceEncodingType::all_variants() { + assert_eq!(variant, ZsVoiceEncodingType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, ZsVoiceEncodingType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, ZsVoiceEncodingType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/mod.rs b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/mod.rs new file mode 100644 index 00000000..67a116c3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/mod.rs @@ -0,0 +1,3 @@ +pub mod encoding_type; +pub mod model_category; +pub mod model_type; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/model_category.rs b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/model_category.rs new file mode 100644 index 00000000..ad9c5273 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/model_category.rs @@ -0,0 +1,107 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `zs_voices` table in a `VARCHAR(16)` field named `model_category`. +/// +/// This indicates what type of features are used in the embeddings. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum ZsVoiceModelCategory { + /// TTS-type zero shot models + #[serde(rename = "tts")] + Tts, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(ZsVoiceModelCategory); + +/// NB: Legacy API for older code. +impl ZsVoiceModelCategory { + pub fn to_str(&self) -> &'static str { + match self { + Self::Tts => "tts", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "tts" => Ok(Self::Tts), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Tts, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::zs_voices::model_category::ZsVoiceModelCategory; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ZsVoiceModelCategory::Tts, "tts"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(ZsVoiceModelCategory::Tts.to_str(), "tts"); + } + + #[test] + fn from_str() { + assert_eq!(ZsVoiceModelCategory::from_str("tts").unwrap(), ZsVoiceModelCategory::Tts); + assert!(ZsVoiceModelCategory::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = ZsVoiceModelCategory::all_variants(); + assert_eq!(variants.len(), 1); + assert_eq!(variants.pop_first(), Some(ZsVoiceModelCategory::Tts)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(ZsVoiceModelCategory::all_variants().len(), ZsVoiceModelCategory::iter().len()); + } + + #[test] + fn round_trip() { + for variant in ZsVoiceModelCategory::all_variants() { + assert_eq!(variant, ZsVoiceModelCategory::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, ZsVoiceModelCategory::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, ZsVoiceModelCategory::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/model_type.rs b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/model_type.rs new file mode 100644 index 00000000..bd7cd116 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/by_table/zs_voices/model_type.rs @@ -0,0 +1,115 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the `zs_voices` table in a `VARCHAR(16)` field named `model_type`. +/// +/// This indicates what type of features are used in the embeddings. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Deserialize, Serialize)] +pub enum ZsVoiceModelType { + /// TTS-type zero shot models + #[serde(rename = "vall-e-x")] + VallEX, + #[serde(rename = "styletts2")] + StyleTTS2, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(ZsVoiceModelType); + +/// NB: Legacy API for older code. +impl ZsVoiceModelType { + pub fn to_str(&self) -> &'static str { + match self { + Self::VallEX=> "vall-e-x", + Self::StyleTTS2 => "styletts2", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "vall-e-x" => Ok(Self::VallEX), + "styletts2" => Ok(Self::StyleTTS2), + _ => Err(format!("invalid value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::VallEX, + Self::StyleTTS2, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::by_table::zs_voices::model_type::ZsVoiceModelType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ZsVoiceModelType::VallEX, "vall-e-x"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(ZsVoiceModelType::VallEX.to_str(), "vall-e-x"); + assert_eq!(ZsVoiceModelType::StyleTTS2.to_str(), "styletts2"); + } + + #[test] + fn from_str() { + assert_eq!(ZsVoiceModelType::from_str("vall-e-x").unwrap(), ZsVoiceModelType::VallEX); + assert_eq!(ZsVoiceModelType::from_str("styletts2").unwrap(), ZsVoiceModelType::StyleTTS2); + assert!(ZsVoiceModelType::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let mut variants = ZsVoiceModelType::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(ZsVoiceModelType::VallEX)); + assert_eq!(variants.pop_first(), Some(ZsVoiceModelType::StyleTTS2)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(ZsVoiceModelType::all_variants().len(), ZsVoiceModelType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in ZsVoiceModelType::all_variants() { + assert_eq!(variant, ZsVoiceModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, ZsVoiceModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, ZsVoiceModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/artcraft_credits_pack_slug.rs b/crates/api_clients/artcraft_client/src/enums/common/artcraft_credits_pack_slug.rs new file mode 100644 index 00000000..9ac3a210 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/artcraft_credits_pack_slug.rs @@ -0,0 +1,152 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// NB: This will be used by a variety of tables (MySQL and sqlite)! +/// Keep the max length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum ArtcraftCreditsPackSlug { + #[serde(rename= "artcraft_1000")] + Artcraft1000, + #[serde(rename= "artcraft_2500")] + Artcraft2500, + #[serde(rename= "artcraft_5000")] + Artcraft5000, + #[serde(rename= "artcraft_10000")] + Artcraft10000, + #[serde(rename= "artcraft_25000")] + Artcraft25000, + #[serde(rename= "artcraft_50000")] + Artcraft50000, +} + +impl_enum_display_and_debug_using_to_str!(ArtcraftCreditsPackSlug); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl ArtcraftCreditsPackSlug { + pub fn to_str(&self) -> &'static str { + match self { + Self::Artcraft1000 => "artcraft_1000", + Self::Artcraft2500 => "artcraft_2500", + Self::Artcraft5000 => "artcraft_5000", + Self::Artcraft10000 => "artcraft_10000", + Self::Artcraft25000 => "artcraft_25000", + Self::Artcraft50000 => "artcraft_50000", + } + } + + pub fn from_str(s: &str) -> Result { + match s { + "artcraft_1000" => Ok(Self::Artcraft1000), + "artcraft_2500" => Ok(Self::Artcraft2500), + "artcraft_5000" => Ok(Self::Artcraft5000), + "artcraft_10000" => Ok(Self::Artcraft10000), + "artcraft_25000" => Ok(Self::Artcraft25000), + "artcraft_50000" => Ok(Self::Artcraft50000), + _ => Err(format!("invalid artcraft_credits_pack_slug: {:?}", s)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Artcraft1000, + Self::Artcraft2500, + Self::Artcraft5000, + Self::Artcraft10000, + Self::Artcraft25000, + Self::Artcraft50000, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::test_helpers::assert_serialization; + use crate::enums::common::artcraft_credits_pack_slug::ArtcraftCreditsPackSlug; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ArtcraftCreditsPackSlug::Artcraft1000, "artcraft_1000"); + assert_serialization(ArtcraftCreditsPackSlug::Artcraft2500, "artcraft_2500"); + assert_serialization(ArtcraftCreditsPackSlug::Artcraft5000, "artcraft_5000"); + assert_serialization(ArtcraftCreditsPackSlug::Artcraft10000, "artcraft_10000"); + assert_serialization(ArtcraftCreditsPackSlug::Artcraft25000, "artcraft_25000"); + assert_serialization(ArtcraftCreditsPackSlug::Artcraft50000, "artcraft_50000"); + } + + #[test] + fn to_str() { + assert_eq!(ArtcraftCreditsPackSlug::Artcraft1000.to_str(), "artcraft_1000"); + assert_eq!(ArtcraftCreditsPackSlug::Artcraft2500.to_str(), "artcraft_2500"); + assert_eq!(ArtcraftCreditsPackSlug::Artcraft5000.to_str(), "artcraft_5000"); + assert_eq!(ArtcraftCreditsPackSlug::Artcraft10000.to_str(), "artcraft_10000"); + assert_eq!(ArtcraftCreditsPackSlug::Artcraft25000.to_str(), "artcraft_25000"); + assert_eq!(ArtcraftCreditsPackSlug::Artcraft50000.to_str(), "artcraft_50000"); + } + + #[test] + fn from_str() { + assert_eq!(ArtcraftCreditsPackSlug::from_str("artcraft_1000").unwrap(), ArtcraftCreditsPackSlug::Artcraft1000); + assert_eq!(ArtcraftCreditsPackSlug::from_str("artcraft_2500").unwrap(), ArtcraftCreditsPackSlug::Artcraft2500); + assert_eq!(ArtcraftCreditsPackSlug::from_str("artcraft_5000").unwrap(), ArtcraftCreditsPackSlug::Artcraft5000); + assert_eq!(ArtcraftCreditsPackSlug::from_str("artcraft_10000").unwrap(), ArtcraftCreditsPackSlug::Artcraft10000); + assert_eq!(ArtcraftCreditsPackSlug::from_str("artcraft_25000").unwrap(), ArtcraftCreditsPackSlug::Artcraft25000); + assert_eq!(ArtcraftCreditsPackSlug::from_str("artcraft_50000").unwrap(), ArtcraftCreditsPackSlug::Artcraft50000); + + } + + #[test] + fn all_variants() { + let mut variants = ArtcraftCreditsPackSlug::all_variants(); + assert_eq!(variants.len(), 6); + assert_eq!(variants.pop_first(), Some(ArtcraftCreditsPackSlug::Artcraft1000)); + assert_eq!(variants.pop_first(), Some(ArtcraftCreditsPackSlug::Artcraft2500)); + assert_eq!(variants.pop_first(), Some(ArtcraftCreditsPackSlug::Artcraft5000)); + assert_eq!(variants.pop_first(), Some(ArtcraftCreditsPackSlug::Artcraft10000)); + assert_eq!(variants.pop_first(), Some(ArtcraftCreditsPackSlug::Artcraft25000)); + assert_eq!(variants.pop_first(), Some(ArtcraftCreditsPackSlug::Artcraft50000)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(ArtcraftCreditsPackSlug::all_variants().len(), ArtcraftCreditsPackSlug::iter().len()); + } + + #[test] + fn round_trip() { + for variant in ArtcraftCreditsPackSlug::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, ArtcraftCreditsPackSlug::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, ArtcraftCreditsPackSlug::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, ArtcraftCreditsPackSlug::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in ArtcraftCreditsPackSlug::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/artcraft_subscription_slug.rs b/crates/api_clients/artcraft_client/src/enums/common/artcraft_subscription_slug.rs new file mode 100644 index 00000000..f5e118c6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/artcraft_subscription_slug.rs @@ -0,0 +1,121 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// NB: This will be used by a variety of tables (MySQL and sqlite)! +/// Keep the max length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum ArtcraftSubscriptionSlug { + ArtcraftBasic, + ArtcraftPro, + ArtcraftMax, +} + +impl_enum_display_and_debug_using_to_str!(ArtcraftSubscriptionSlug); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl ArtcraftSubscriptionSlug { + pub fn to_str(&self) -> &'static str { + match self { + Self::ArtcraftBasic => "artcraft_basic", + Self::ArtcraftPro => "artcraft_pro", + Self::ArtcraftMax => "artcraft_max", + } + } + + pub fn from_str(s: &str) -> Result { + match s { + "artcraft_basic" => Ok(Self::ArtcraftBasic), + "artcraft_pro" => Ok(Self::ArtcraftPro), + "artcraft_max" => Ok(Self::ArtcraftMax), + _ => Err(format!("invalid artcraft_subscription_slug: {:?}", s)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ArtcraftBasic, + Self::ArtcraftPro, + Self::ArtcraftMax, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::artcraft_subscription_slug::ArtcraftSubscriptionSlug; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ArtcraftSubscriptionSlug::ArtcraftBasic, "artcraft_basic"); + assert_serialization(ArtcraftSubscriptionSlug::ArtcraftPro, "artcraft_pro"); + assert_serialization(ArtcraftSubscriptionSlug::ArtcraftMax, "artcraft_max"); + } + + #[test] + fn to_str() { + assert_eq!(ArtcraftSubscriptionSlug::ArtcraftBasic.to_str(), "artcraft_basic"); + assert_eq!(ArtcraftSubscriptionSlug::ArtcraftPro.to_str(), "artcraft_pro"); + assert_eq!(ArtcraftSubscriptionSlug::ArtcraftMax.to_str(), "artcraft_max"); + } + + #[test] + fn from_str() { + assert_eq!(ArtcraftSubscriptionSlug::from_str("artcraft_basic").unwrap(), ArtcraftSubscriptionSlug::ArtcraftBasic); + assert_eq!(ArtcraftSubscriptionSlug::from_str("artcraft_pro").unwrap(), ArtcraftSubscriptionSlug::ArtcraftPro); + assert_eq!(ArtcraftSubscriptionSlug::from_str("artcraft_max").unwrap(), ArtcraftSubscriptionSlug::ArtcraftMax); + } + + #[test] + fn all_variants() { + let mut variants = ArtcraftSubscriptionSlug::all_variants(); + assert_eq!(variants.len(), 3); + assert_eq!(variants.pop_first(), Some(ArtcraftSubscriptionSlug::ArtcraftBasic)); + assert_eq!(variants.pop_first(), Some(ArtcraftSubscriptionSlug::ArtcraftPro)); + assert_eq!(variants.pop_first(), Some(ArtcraftSubscriptionSlug::ArtcraftMax)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(ArtcraftSubscriptionSlug::all_variants().len(), ArtcraftSubscriptionSlug::iter().len()); + } + + #[test] + fn round_trip() { + for variant in ArtcraftSubscriptionSlug::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, ArtcraftSubscriptionSlug::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, ArtcraftSubscriptionSlug::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, ArtcraftSubscriptionSlug::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in ArtcraftSubscriptionSlug::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_aspect_ratio.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_aspect_ratio.rs new file mode 100644 index 00000000..f594bd9d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_aspect_ratio.rs @@ -0,0 +1,268 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +pub const MAX_LENGTH: usize = 24; + +/// Common aspect ratios for image and video generation. +/// +/// NB: Keep the max serialized length to 24 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonAspectRatio { + Auto, + Square, + WideThreeByTwo, + WideFourByThree, + WideFiveByFour, + WideSixteenByNine, + WideTwentyOneByNine, + TallTwoByThree, + TallThreeByFour, + TallFourByFive, + TallNineBySixteen, + TallNineByTwentyOne, + Wide, + Tall, + #[serde(rename = "auto_2k")] + Auto2k, + #[serde(rename = "auto_3k")] + Auto3k, + #[serde(rename = "auto_4k")] + Auto4k, + SquareHd, +} + +impl_enum_display_and_debug_using_to_str!(CommonAspectRatio); + +impl CommonAspectRatio { + pub fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::Square => "square", + Self::WideThreeByTwo => "wide_three_by_two", + Self::WideFourByThree => "wide_four_by_three", + Self::WideFiveByFour => "wide_five_by_four", + Self::WideSixteenByNine => "wide_sixteen_by_nine", + Self::WideTwentyOneByNine => "wide_twenty_one_by_nine", + Self::TallTwoByThree => "tall_two_by_three", + Self::TallThreeByFour => "tall_three_by_four", + Self::TallFourByFive => "tall_four_by_five", + Self::TallNineBySixteen => "tall_nine_by_sixteen", + Self::TallNineByTwentyOne => "tall_nine_by_twenty_one", + Self::Wide => "wide", + Self::Tall => "tall", + Self::Auto2k => "auto_2k", + Self::Auto3k => "auto_3k", + Self::Auto4k => "auto_4k", + Self::SquareHd => "square_hd", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "auto" => Ok(Self::Auto), + "square" => Ok(Self::Square), + "wide_three_by_two" => Ok(Self::WideThreeByTwo), + "wide_four_by_three" => Ok(Self::WideFourByThree), + "wide_five_by_four" => Ok(Self::WideFiveByFour), + "wide_sixteen_by_nine" => Ok(Self::WideSixteenByNine), + "wide_twenty_one_by_nine" => Ok(Self::WideTwentyOneByNine), + "tall_two_by_three" => Ok(Self::TallTwoByThree), + "tall_three_by_four" => Ok(Self::TallThreeByFour), + "tall_four_by_five" => Ok(Self::TallFourByFive), + "tall_nine_by_sixteen" => Ok(Self::TallNineBySixteen), + "tall_nine_by_twenty_one" => Ok(Self::TallNineByTwentyOne), + "wide" => Ok(Self::Wide), + "tall" => Ok(Self::Tall), + "auto_2k" => Ok(Self::Auto2k), + "auto_3k" => Ok(Self::Auto3k), + "auto_4k" => Ok(Self::Auto4k), + "square_hd" => Ok(Self::SquareHd), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Auto, + Self::Square, + Self::WideThreeByTwo, + Self::WideFourByThree, + Self::WideFiveByFour, + Self::WideSixteenByNine, + Self::WideTwentyOneByNine, + Self::TallTwoByThree, + Self::TallThreeByFour, + Self::TallFourByFive, + Self::TallNineBySixteen, + Self::TallNineByTwentyOne, + Self::Wide, + Self::Tall, + Self::Auto2k, + Self::Auto3k, + Self::Auto4k, + Self::SquareHd, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_aspect_ratio::CommonAspectRatio; + use crate::enums::common::generation::common_aspect_ratio::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(CommonAspectRatio::Auto, "auto"); + assert_serialization(CommonAspectRatio::Square, "square"); + assert_serialization(CommonAspectRatio::WideThreeByTwo, "wide_three_by_two"); + assert_serialization(CommonAspectRatio::WideFourByThree, "wide_four_by_three"); + assert_serialization(CommonAspectRatio::WideFiveByFour, "wide_five_by_four"); + assert_serialization(CommonAspectRatio::WideSixteenByNine, "wide_sixteen_by_nine"); + assert_serialization(CommonAspectRatio::WideTwentyOneByNine, "wide_twenty_one_by_nine"); + assert_serialization(CommonAspectRatio::TallTwoByThree, "tall_two_by_three"); + assert_serialization(CommonAspectRatio::TallThreeByFour, "tall_three_by_four"); + assert_serialization(CommonAspectRatio::TallFourByFive, "tall_four_by_five"); + assert_serialization(CommonAspectRatio::TallNineBySixteen, "tall_nine_by_sixteen"); + assert_serialization(CommonAspectRatio::TallNineByTwentyOne, "tall_nine_by_twenty_one"); + assert_serialization(CommonAspectRatio::Wide, "wide"); + assert_serialization(CommonAspectRatio::Tall, "tall"); + assert_serialization(CommonAspectRatio::Auto2k, "auto_2k"); + assert_serialization(CommonAspectRatio::Auto3k, "auto_3k"); + assert_serialization(CommonAspectRatio::Auto4k, "auto_4k"); + assert_serialization(CommonAspectRatio::SquareHd, "square_hd"); + } + + #[test] + fn to_str() { + assert_eq!(CommonAspectRatio::Auto.to_str(), "auto"); + assert_eq!(CommonAspectRatio::Square.to_str(), "square"); + assert_eq!(CommonAspectRatio::WideThreeByTwo.to_str(), "wide_three_by_two"); + assert_eq!(CommonAspectRatio::WideFourByThree.to_str(), "wide_four_by_three"); + assert_eq!(CommonAspectRatio::WideFiveByFour.to_str(), "wide_five_by_four"); + assert_eq!(CommonAspectRatio::WideSixteenByNine.to_str(), "wide_sixteen_by_nine"); + assert_eq!(CommonAspectRatio::WideTwentyOneByNine.to_str(), "wide_twenty_one_by_nine"); + assert_eq!(CommonAspectRatio::TallTwoByThree.to_str(), "tall_two_by_three"); + assert_eq!(CommonAspectRatio::TallThreeByFour.to_str(), "tall_three_by_four"); + assert_eq!(CommonAspectRatio::TallFourByFive.to_str(), "tall_four_by_five"); + assert_eq!(CommonAspectRatio::TallNineBySixteen.to_str(), "tall_nine_by_sixteen"); + assert_eq!(CommonAspectRatio::TallNineByTwentyOne.to_str(), "tall_nine_by_twenty_one"); + assert_eq!(CommonAspectRatio::Wide.to_str(), "wide"); + assert_eq!(CommonAspectRatio::Tall.to_str(), "tall"); + assert_eq!(CommonAspectRatio::Auto2k.to_str(), "auto_2k"); + assert_eq!(CommonAspectRatio::Auto3k.to_str(), "auto_3k"); + assert_eq!(CommonAspectRatio::Auto4k.to_str(), "auto_4k"); + assert_eq!(CommonAspectRatio::SquareHd.to_str(), "square_hd"); + } + + #[test] + fn from_str() { + assert_eq!(CommonAspectRatio::from_str("auto").unwrap(), CommonAspectRatio::Auto); + assert_eq!(CommonAspectRatio::from_str("square").unwrap(), CommonAspectRatio::Square); + assert_eq!(CommonAspectRatio::from_str("wide_three_by_two").unwrap(), CommonAspectRatio::WideThreeByTwo); + assert_eq!(CommonAspectRatio::from_str("wide_four_by_three").unwrap(), CommonAspectRatio::WideFourByThree); + assert_eq!(CommonAspectRatio::from_str("wide_five_by_four").unwrap(), CommonAspectRatio::WideFiveByFour); + assert_eq!(CommonAspectRatio::from_str("wide_sixteen_by_nine").unwrap(), CommonAspectRatio::WideSixteenByNine); + assert_eq!(CommonAspectRatio::from_str("wide_twenty_one_by_nine").unwrap(), CommonAspectRatio::WideTwentyOneByNine); + assert_eq!(CommonAspectRatio::from_str("tall_two_by_three").unwrap(), CommonAspectRatio::TallTwoByThree); + assert_eq!(CommonAspectRatio::from_str("tall_three_by_four").unwrap(), CommonAspectRatio::TallThreeByFour); + assert_eq!(CommonAspectRatio::from_str("tall_four_by_five").unwrap(), CommonAspectRatio::TallFourByFive); + assert_eq!(CommonAspectRatio::from_str("tall_nine_by_sixteen").unwrap(), CommonAspectRatio::TallNineBySixteen); + assert_eq!(CommonAspectRatio::from_str("tall_nine_by_twenty_one").unwrap(), CommonAspectRatio::TallNineByTwentyOne); + assert_eq!(CommonAspectRatio::from_str("wide").unwrap(), CommonAspectRatio::Wide); + assert_eq!(CommonAspectRatio::from_str("tall").unwrap(), CommonAspectRatio::Tall); + assert_eq!(CommonAspectRatio::from_str("auto_2k").unwrap(), CommonAspectRatio::Auto2k); + assert_eq!(CommonAspectRatio::from_str("auto_3k").unwrap(), CommonAspectRatio::Auto3k); + assert_eq!(CommonAspectRatio::from_str("auto_4k").unwrap(), CommonAspectRatio::Auto4k); + assert_eq!(CommonAspectRatio::from_str("square_hd").unwrap(), CommonAspectRatio::SquareHd); + } + + #[test] + fn from_str_err() { + let result = CommonAspectRatio::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let variants = CommonAspectRatio::all_variants(); + assert_eq!(variants.len(), 18); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonAspectRatio::all_variants().len(), CommonAspectRatio::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonAspectRatio::all_variants() { + assert_eq!(variant, CommonAspectRatio::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonAspectRatio::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonAspectRatio::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonAspectRatio::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long via to_str()", variant); + } + for variant in CommonAspectRatio::all_variants() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(json.len() <= MAX_LENGTH, "variant {:?} is too long via JSON: {:?}", variant, json); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonAspectRatio::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonAspectRatio::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_audio_model.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_audio_model.rs new file mode 100644 index 00000000..0d392984 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_audio_model.rs @@ -0,0 +1,96 @@ + +/// Audio models available for generation. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonAudioModel { + #[serde(rename = "suno_music")] + SunoMusic, + + #[serde(rename = "suno_remix")] + SunoRemix, + + #[serde(rename = "suno_sounds")] + SunoSounds, + + #[serde(rename = "suno_sample")] + SunoSample, + + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, +} + +impl CommonAudioModel { + pub fn to_common_model_type(&self) -> crate::enums::common::generation::common_model_type::CommonModelType { + use crate::enums::common::generation::common_model_type::CommonModelType; + match self { + Self::SunoMusic => CommonModelType::SunoMusic, + Self::SunoRemix => CommonModelType::SunoRemix, + Self::SunoSounds => CommonModelType::SunoSounds, + Self::SunoSample => CommonModelType::SunoSample, + Self::SeedAudio1p0 => CommonModelType::SeedAudio1p0, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonAudioModel::SunoMusic, "suno_music"); + assert_serialization(CommonAudioModel::SunoRemix, "suno_remix"); + assert_serialization(CommonAudioModel::SunoSounds, "suno_sounds"); + assert_serialization(CommonAudioModel::SunoSample, "suno_sample"); + assert_serialization(CommonAudioModel::SeedAudio1p0, "seed_audio_1p0"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("suno_music", CommonAudioModel::SunoMusic), + ("suno_remix", CommonAudioModel::SunoRemix), + ("suno_sounds", CommonAudioModel::SunoSounds), + ("suno_sample", CommonAudioModel::SunoSample), + ("seed_audio_1p0", CommonAudioModel::SeedAudio1p0), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonAudioModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [ + CommonAudioModel::SunoMusic, + CommonAudioModel::SunoRemix, + CommonAudioModel::SunoSounds, + CommonAudioModel::SunoSample, + CommonAudioModel::SeedAudio1p0, + ]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonAudioModel = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } + + #[test] + fn all_audio_models_convert_to_common_model_type() { + let models = [ + (CommonAudioModel::SunoMusic, CommonModelType::SunoMusic), + (CommonAudioModel::SunoRemix, CommonModelType::SunoRemix), + (CommonAudioModel::SunoSounds, CommonModelType::SunoSounds), + (CommonAudioModel::SunoSample, CommonModelType::SunoSample), + (CommonAudioModel::SeedAudio1p0, CommonModelType::SeedAudio1p0), + ]; + for (audio_model, expected) in models { + assert_eq!(audio_model.to_common_model_type(), expected); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_bitrate.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_bitrate.rs new file mode 100644 index 00000000..b395fad4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_bitrate.rs @@ -0,0 +1,159 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +pub const MAX_LENGTH: usize = 16; + +/// Common output bitrate levels for generation. +/// +/// Most models default to `Normal`; `High` requests a higher bitrate where the +/// model supports it. Models that don't support it simply ignore the value. +/// +/// NB: Keep the max serialized length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonBitrate { + Normal, + High, +} + +impl_enum_display_and_debug_using_to_str!(CommonBitrate); + +impl CommonBitrate { + pub fn to_str(&self) -> &'static str { + match self { + Self::Normal => "normal", + Self::High => "high", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "normal" => Ok(Self::Normal), + "high" => Ok(Self::High), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Normal, + Self::High, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_bitrate::CommonBitrate; + use crate::enums::common::generation::common_bitrate::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(CommonBitrate::Normal, "normal"); + assert_serialization(CommonBitrate::High, "high"); + } + + #[test] + fn to_str() { + assert_eq!(CommonBitrate::Normal.to_str(), "normal"); + assert_eq!(CommonBitrate::High.to_str(), "high"); + } + + #[test] + fn from_str() { + assert_eq!(CommonBitrate::from_str("normal").unwrap(), CommonBitrate::Normal); + assert_eq!(CommonBitrate::from_str("high").unwrap(), CommonBitrate::High); + } + + #[test] + fn from_str_err() { + let result = CommonBitrate::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = CommonBitrate::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(CommonBitrate::Normal)); + assert_eq!(variants.pop_first(), Some(CommonBitrate::High)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonBitrate::all_variants().len(), CommonBitrate::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonBitrate::all_variants() { + assert_eq!(variant, CommonBitrate::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonBitrate::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonBitrate::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonBitrate::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long via to_str()", variant); + } + for variant in CommonBitrate::all_variants() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(json.len() <= MAX_LENGTH, "variant {:?} is too long via JSON: {:?}", variant, json); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonBitrate::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonBitrate::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_generation_mode.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_generation_mode.rs new file mode 100644 index 00000000..32dee5f5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_generation_mode.rs @@ -0,0 +1,202 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +/// Stored in the `prompts` table (`maybe_generation_mode` column) as VARCHAR(24). +pub const MAX_LENGTH: usize = 24; + +/// The generation mode describes how the user wants to generate content. +/// +/// Stored in the `prompts` table (`maybe_generation_mode` column). +/// +/// NB: Keep the max serialized length to 24 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonGenerationMode { + /// Generate from a keyframe (eg. image-to-video with a start/end frame) + Keyframe, + + /// Generate using a reference image or style + Reference, + + /// Edit an existing image or video + Edit, + + /// Inpaint a masked region of an image + Inpaint, + + /// Outpaint / extend beyond the borders of an image + Outpaint, + + /// Generate from a text prompt only (no image input) + Text, +} + +impl_enum_display_and_debug_using_to_str!(CommonGenerationMode); + +impl CommonGenerationMode { + pub fn to_str(&self) -> &'static str { + match self { + Self::Keyframe => "keyframe", + Self::Reference => "reference", + Self::Edit => "edit", + Self::Inpaint => "inpaint", + Self::Outpaint => "outpaint", + Self::Text => "text", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "keyframe" => Ok(Self::Keyframe), + "reference" => Ok(Self::Reference), + "edit" => Ok(Self::Edit), + "inpaint" => Ok(Self::Inpaint), + "outpaint" => Ok(Self::Outpaint), + "text" => Ok(Self::Text), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Keyframe, + Self::Reference, + Self::Edit, + Self::Inpaint, + Self::Outpaint, + Self::Text, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_generation_mode::CommonGenerationMode; + use crate::enums::common::generation::common_generation_mode::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(CommonGenerationMode::Keyframe, "keyframe"); + assert_serialization(CommonGenerationMode::Reference, "reference"); + assert_serialization(CommonGenerationMode::Edit, "edit"); + assert_serialization(CommonGenerationMode::Inpaint, "inpaint"); + assert_serialization(CommonGenerationMode::Outpaint, "outpaint"); + assert_serialization(CommonGenerationMode::Text, "text"); + } + + #[test] + fn to_str() { + assert_eq!(CommonGenerationMode::Keyframe.to_str(), "keyframe"); + assert_eq!(CommonGenerationMode::Reference.to_str(), "reference"); + assert_eq!(CommonGenerationMode::Edit.to_str(), "edit"); + assert_eq!(CommonGenerationMode::Inpaint.to_str(), "inpaint"); + assert_eq!(CommonGenerationMode::Outpaint.to_str(), "outpaint"); + assert_eq!(CommonGenerationMode::Text.to_str(), "text"); + } + + #[test] + fn from_str() { + assert_eq!(CommonGenerationMode::from_str("keyframe").unwrap(), CommonGenerationMode::Keyframe); + assert_eq!(CommonGenerationMode::from_str("reference").unwrap(), CommonGenerationMode::Reference); + assert_eq!(CommonGenerationMode::from_str("edit").unwrap(), CommonGenerationMode::Edit); + assert_eq!(CommonGenerationMode::from_str("inpaint").unwrap(), CommonGenerationMode::Inpaint); + assert_eq!(CommonGenerationMode::from_str("outpaint").unwrap(), CommonGenerationMode::Outpaint); + assert_eq!(CommonGenerationMode::from_str("text").unwrap(), CommonGenerationMode::Text); + } + + #[test] + fn from_str_err() { + let result = CommonGenerationMode::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = CommonGenerationMode::all_variants(); + assert_eq!(variants.len(), 6); + assert_eq!(variants.pop_first(), Some(CommonGenerationMode::Keyframe)); + assert_eq!(variants.pop_first(), Some(CommonGenerationMode::Reference)); + assert_eq!(variants.pop_first(), Some(CommonGenerationMode::Edit)); + assert_eq!(variants.pop_first(), Some(CommonGenerationMode::Inpaint)); + assert_eq!(variants.pop_first(), Some(CommonGenerationMode::Outpaint)); + assert_eq!(variants.pop_first(), Some(CommonGenerationMode::Text)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonGenerationMode::all_variants().len(), CommonGenerationMode::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonGenerationMode::all_variants() { + assert_eq!(variant, CommonGenerationMode::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonGenerationMode::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonGenerationMode::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonGenerationMode::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long via to_str()", variant); + } + for variant in CommonGenerationMode::all_variants() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(json.len() <= MAX_LENGTH, "variant {:?} is too long via JSON: {:?}", variant, json); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonGenerationMode::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonGenerationMode::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_image_model.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_image_model.rs new file mode 100644 index 00000000..0d56455b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_image_model.rs @@ -0,0 +1,212 @@ + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Image models available for generation. +/// Mirrors artcraft_router::api::router_image_model::RouterImageModel. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[serde(rename_all = "snake_case")] +pub enum CommonImageModel { + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_pro_1p1")] + FluxPro11, + #[serde(rename = "flux_pro_1p1_ultra")] + FluxPro11Ultra, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + #[serde(rename = "grok_imagine_image")] + GrokImagineImage, + #[serde(rename = "grok_imagine_image_q")] + GrokImagineImageQuality, + #[serde(rename = "midjourney_7")] + Midjourney7, + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + #[serde(rename = "midjourney_8")] + Midjourney8, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, +} + +impl CommonImageModel { + pub fn to_common_model_type(&self) -> crate::enums::common::generation::common_model_type::CommonModelType { + use crate::enums::common::generation::common_model_type::CommonModelType; + match self { + Self::Flux1Dev => CommonModelType::Flux1Dev, + Self::Flux1Schnell => CommonModelType::Flux1Schnell, + Self::FluxPro11 => CommonModelType::FluxPro11, + Self::FluxPro11Ultra => CommonModelType::FluxPro11Ultra, + Self::GptImage1 => CommonModelType::GptImage1, + Self::GptImage1p5 => CommonModelType::GptImage1p5, + Self::GptImage2 => CommonModelType::GptImage2, + Self::GrokImagineImage => CommonModelType::GrokImagineImage, + Self::GrokImagineImageQuality => CommonModelType::GrokImagineImageQuality, + Self::Midjourney7 => CommonModelType::Midjourney7, + Self::Midjourney7Niji => CommonModelType::Midjourney7Niji, + Self::Midjourney8 => CommonModelType::Midjourney8, + Self::NanoBanana => CommonModelType::NanoBanana, + Self::NanoBanana2 => CommonModelType::NanoBanana2, + Self::NanoBananaPro => CommonModelType::NanoBananaPro, + Self::Seedream4 => CommonModelType::Seedream4, + Self::Seedream4p5 => CommonModelType::Seedream4p5, + Self::Seedream5Lite => CommonModelType::Seedream5Lite, + Self::Seedream5p0Pro => CommonModelType::Seedream5p0Pro, + Self::Seedream5p0ProUltra => CommonModelType::Seedream5p0ProUltra, + Self::QwenEdit2511Angles => CommonModelType::QwenEdit2511Angles, + Self::Flux2LoraAngles => CommonModelType::Flux2LoraAngles, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::common::generation::common_model_class::CommonModelClass; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn serialization() { + assert_serialization(CommonImageModel::Flux1Dev, "flux_1_dev"); + assert_serialization(CommonImageModel::Flux1Schnell, "flux_1_schnell"); + assert_serialization(CommonImageModel::FluxPro11, "flux_pro_1p1"); + assert_serialization(CommonImageModel::FluxPro11Ultra, "flux_pro_1p1_ultra"); + assert_serialization(CommonImageModel::GptImage1, "gpt_image_1"); + assert_serialization(CommonImageModel::GptImage1p5, "gpt_image_1p5"); + assert_serialization(CommonImageModel::GptImage2, "gpt_image_2"); + assert_serialization(CommonImageModel::GrokImagineImage, "grok_imagine_image"); + assert_serialization(CommonImageModel::GrokImagineImageQuality, "grok_imagine_image_q"); + assert_serialization(CommonImageModel::Midjourney7, "midjourney_7"); + assert_serialization(CommonImageModel::Midjourney7Niji, "midjourney_7_niji"); + assert_serialization(CommonImageModel::Midjourney8, "midjourney_8"); + assert_serialization(CommonImageModel::NanoBanana, "nano_banana"); + assert_serialization(CommonImageModel::NanoBanana2, "nano_banana_2"); + assert_serialization(CommonImageModel::NanoBananaPro, "nano_banana_pro"); + assert_serialization(CommonImageModel::Seedream4, "seedream_4"); + assert_serialization(CommonImageModel::Seedream4p5, "seedream_4p5"); + assert_serialization(CommonImageModel::Seedream5Lite, "seedream_5_lite"); + assert_serialization(CommonImageModel::Seedream5p0Pro, "seedream_5p0_pro"); + assert_serialization(CommonImageModel::Seedream5p0ProUltra, "seedream_5p0_pro_u"); + assert_serialization(CommonImageModel::QwenEdit2511Angles, "qwen_edit_2511_angles"); + assert_serialization(CommonImageModel::Flux2LoraAngles, "flux_2_lora_angles"); + } + + #[test] + fn all_image_models_convert_to_common_model_type() { + let models = [ + (CommonImageModel::Flux1Dev, CommonModelType::Flux1Dev), + (CommonImageModel::Flux1Schnell, CommonModelType::Flux1Schnell), + (CommonImageModel::FluxPro11, CommonModelType::FluxPro11), + (CommonImageModel::FluxPro11Ultra, CommonModelType::FluxPro11Ultra), + (CommonImageModel::GptImage1, CommonModelType::GptImage1), + (CommonImageModel::GptImage1p5, CommonModelType::GptImage1p5), + (CommonImageModel::GptImage2, CommonModelType::GptImage2), + (CommonImageModel::GrokImagineImage, CommonModelType::GrokImagineImage), + (CommonImageModel::GrokImagineImageQuality, CommonModelType::GrokImagineImageQuality), + (CommonImageModel::Midjourney7, CommonModelType::Midjourney7), + (CommonImageModel::Midjourney7Niji, CommonModelType::Midjourney7Niji), + (CommonImageModel::Midjourney8, CommonModelType::Midjourney8), + (CommonImageModel::NanoBanana, CommonModelType::NanoBanana), + (CommonImageModel::NanoBanana2, CommonModelType::NanoBanana2), + (CommonImageModel::NanoBananaPro, CommonModelType::NanoBananaPro), + (CommonImageModel::Seedream4, CommonModelType::Seedream4), + (CommonImageModel::Seedream4p5, CommonModelType::Seedream4p5), + (CommonImageModel::Seedream5Lite, CommonModelType::Seedream5Lite), + (CommonImageModel::Seedream5p0Pro, CommonModelType::Seedream5p0Pro), + (CommonImageModel::Seedream5p0ProUltra, CommonModelType::Seedream5p0ProUltra), + (CommonImageModel::QwenEdit2511Angles, CommonModelType::QwenEdit2511Angles), + (CommonImageModel::Flux2LoraAngles, CommonModelType::Flux2LoraAngles), + ]; + for (image_model, expected) in models { + assert_eq!(image_model.to_common_model_type(), expected); + } + } + + #[test] + fn all_image_models_map_to_image_class() { + use strum::IntoEnumIterator; + for variant in CommonImageModel::iter() { + let model_type = variant.to_common_model_type(); + assert_eq!( + model_type.get_model_class(), CommonModelClass::Image, + "{:?} mapped to {:?} which has class {:?}, expected Image", + variant, model_type, model_type.get_model_class(), + ); + } + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_count() { + use strum::IntoEnumIterator; + assert_eq!(CommonImageModel::iter().len(), 22); + } + + #[test] + fn serde_round_trip() { + use strum::IntoEnumIterator; + for variant in CommonImageModel::iter() { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonImageModel = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "round-trip failed for {:?}", variant); + } + } + + #[test] + fn serialized_names_are_lowercase_alphanumeric_underscore() { + use strum::IntoEnumIterator; + let valid = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + for variant in CommonImageModel::iter() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!( + valid.is_match(&json), + "{:?} serializes to {:?} which contains invalid characters", + variant, json, + ); + } + } + + #[test] + fn to_common_model_type_covers_all_variants() { + use strum::IntoEnumIterator; + // This test ensures to_common_model_type doesn't panic for any variant. + for variant in CommonImageModel::iter() { + let _ = variant.to_common_model_type(); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_model.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_model.rs new file mode 100644 index 00000000..82bdcc35 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_model.rs @@ -0,0 +1,161 @@ + +/// Mesh (3D object) models available for generation. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonMeshModel { + #[serde(rename = "hunyuan_3d_2p0")] + Hunyuan3d2p0, + + #[serde(rename = "hunyuan_3d_2p1")] + Hunyuan3d2p1, + + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + + /// Hunyuan 3D v3 in sketch-to-3D mode. Same underlying model as + /// [`Self::Hunyuan3d3`], but takes a sketch image as input. + #[serde(rename = "hunyuan_3d_3_sketch")] + Hunyuan3d3Sketch, + + /// Hunyuan 3D v3.1 Pro: text or (multi-view) image input. + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3p1Pro, + + /// Hunyuan 3D v3.1 Rapid: the fast, low-cost tier. Text or single-image + /// input. + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3p1Rapid, + + /// Hunyuan 3D v3.1 Part: splits an existing mesh into semantic parts. + /// Takes a mesh file as input, not text/images. + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3p1Part, + + /// Hunyuan 3D v3.1 Smart Topology: retopologizes an existing mesh. + /// Takes a mesh file as input, not text/images. + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3p1SmartTopology, + + /// Tripo3D H3.1: text, single-image, or multi-view image input. + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3p1, + + /// Meshy 6: text or single-image input. + #[serde(rename = "meshy_v6")] + MeshyV6, + + /// Hyper3D Rodin v2.5 Fast: text or image(s) input. + #[serde(rename = "rodin_2p5_fast")] + Rodin2p5Fast, +} + +impl CommonMeshModel { + pub fn to_common_model_type(&self) -> crate::enums::common::generation::common_model_type::CommonModelType { + use crate::enums::common::generation::common_model_type::CommonModelType; + match self { + Self::Hunyuan3d2p0 => CommonModelType::Hunyuan3d2_0, + Self::Hunyuan3d2p1 => CommonModelType::Hunyuan3d2_1, + Self::Hunyuan3d3 => CommonModelType::Hunyuan3d3, + // Sketch mode is the same model, just a different input mode. + Self::Hunyuan3d3Sketch => CommonModelType::Hunyuan3d3, + Self::Hunyuan3d3p1Pro => CommonModelType::Hunyuan3d3_1Pro, + Self::Hunyuan3d3p1Rapid => CommonModelType::Hunyuan3d3_1Rapid, + Self::Hunyuan3d3p1Part => CommonModelType::Hunyuan3d3_1Part, + Self::Hunyuan3d3p1SmartTopology => CommonModelType::Hunyuan3d3_1SmartTopology, + Self::Tripo3dH3p1 => CommonModelType::Tripo3dH3_1, + Self::MeshyV6 => CommonModelType::MeshyV6, + Self::Rodin2p5Fast => CommonModelType::Rodin2_5Fast, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::test_helpers::assert_serialization; + + const ALL_VARIANTS: [CommonMeshModel; 11] = [ + CommonMeshModel::Hunyuan3d2p0, + CommonMeshModel::Hunyuan3d2p1, + CommonMeshModel::Hunyuan3d3, + CommonMeshModel::Hunyuan3d3Sketch, + CommonMeshModel::Hunyuan3d3p1Pro, + CommonMeshModel::Hunyuan3d3p1Rapid, + CommonMeshModel::Hunyuan3d3p1Part, + CommonMeshModel::Hunyuan3d3p1SmartTopology, + CommonMeshModel::Tripo3dH3p1, + CommonMeshModel::MeshyV6, + CommonMeshModel::Rodin2p5Fast, + ]; + + #[test] + fn test_serialization() { + assert_serialization(CommonMeshModel::Hunyuan3d2p0, "hunyuan_3d_2p0"); + assert_serialization(CommonMeshModel::Hunyuan3d2p1, "hunyuan_3d_2p1"); + assert_serialization(CommonMeshModel::Hunyuan3d3, "hunyuan_3d_3"); + assert_serialization(CommonMeshModel::Hunyuan3d3Sketch, "hunyuan_3d_3_sketch"); + assert_serialization(CommonMeshModel::Hunyuan3d3p1Pro, "hunyuan_3d_3p1_pro"); + assert_serialization(CommonMeshModel::Hunyuan3d3p1Rapid, "hunyuan_3d_3p1_rapid"); + assert_serialization(CommonMeshModel::Hunyuan3d3p1Part, "hunyuan_3d_3p1_part"); + assert_serialization(CommonMeshModel::Hunyuan3d3p1SmartTopology, "hunyuan_3d_3p1_topology"); + assert_serialization(CommonMeshModel::Tripo3dH3p1, "tripo3d_h3p1"); + assert_serialization(CommonMeshModel::MeshyV6, "meshy_v6"); + assert_serialization(CommonMeshModel::Rodin2p5Fast, "rodin_2p5_fast"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("hunyuan_3d_2p0", CommonMeshModel::Hunyuan3d2p0), + ("hunyuan_3d_2p1", CommonMeshModel::Hunyuan3d2p1), + ("hunyuan_3d_3", CommonMeshModel::Hunyuan3d3), + ("hunyuan_3d_3_sketch", CommonMeshModel::Hunyuan3d3Sketch), + ("hunyuan_3d_3p1_pro", CommonMeshModel::Hunyuan3d3p1Pro), + ("hunyuan_3d_3p1_rapid", CommonMeshModel::Hunyuan3d3p1Rapid), + ("hunyuan_3d_3p1_part", CommonMeshModel::Hunyuan3d3p1Part), + ("hunyuan_3d_3p1_topology", CommonMeshModel::Hunyuan3d3p1SmartTopology), + ("tripo3d_h3p1", CommonMeshModel::Tripo3dH3p1), + ("meshy_v6", CommonMeshModel::MeshyV6), + ("rodin_2p5_fast", CommonMeshModel::Rodin2p5Fast), + ]; + assert_eq!(cases.len(), ALL_VARIANTS.len()); + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonMeshModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + for variant in ALL_VARIANTS { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonMeshModel = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } + + #[test] + fn all_mesh_models_convert_to_common_model_type() { + let models = [ + (CommonMeshModel::Hunyuan3d2p0, CommonModelType::Hunyuan3d2_0), + (CommonMeshModel::Hunyuan3d2p1, CommonModelType::Hunyuan3d2_1), + (CommonMeshModel::Hunyuan3d3, CommonModelType::Hunyuan3d3), + // Sketch mode maps to the same underlying model. + (CommonMeshModel::Hunyuan3d3Sketch, CommonModelType::Hunyuan3d3), + (CommonMeshModel::Hunyuan3d3p1Pro, CommonModelType::Hunyuan3d3_1Pro), + (CommonMeshModel::Hunyuan3d3p1Rapid, CommonModelType::Hunyuan3d3_1Rapid), + (CommonMeshModel::Hunyuan3d3p1Part, CommonModelType::Hunyuan3d3_1Part), + (CommonMeshModel::Hunyuan3d3p1SmartTopology, CommonModelType::Hunyuan3d3_1SmartTopology), + (CommonMeshModel::Tripo3dH3p1, CommonModelType::Tripo3dH3_1), + (CommonMeshModel::MeshyV6, CommonModelType::MeshyV6), + (CommonMeshModel::Rodin2p5Fast, CommonModelType::Rodin2_5Fast), + ]; + assert_eq!(models.len(), ALL_VARIANTS.len()); + for (mesh_model, expected) in models { + assert_eq!(mesh_model.to_common_model_type(), expected); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_output_type.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_output_type.rs new file mode 100644 index 00000000..a41fd2c4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_output_type.rs @@ -0,0 +1,59 @@ + +/// Mesh output types for 3D object generation. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonMeshOutputType { + /// A standard, fully-detailed mesh. + #[serde(rename = "normal")] + Normal, + + /// A reduced-polygon mesh suitable for real-time rendering. + #[serde(rename = "low_poly")] + LowPoly, + + /// Geometry only, without textures/materials. + #[serde(rename = "geometry")] + Geometry, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonMeshOutputType::Normal, "normal"); + assert_serialization(CommonMeshOutputType::LowPoly, "low_poly"); + assert_serialization(CommonMeshOutputType::Geometry, "geometry"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("normal", CommonMeshOutputType::Normal), + ("low_poly", CommonMeshOutputType::LowPoly), + ("geometry", CommonMeshOutputType::Geometry), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonMeshOutputType = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [ + CommonMeshOutputType::Normal, + CommonMeshOutputType::LowPoly, + CommonMeshOutputType::Geometry, + ]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonMeshOutputType = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_quality.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_quality.rs new file mode 100644 index 00000000..c6e6047d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_mesh_quality.rs @@ -0,0 +1,48 @@ + +/// Quality level for a mesh generation sub-feature (e.g. texture quality or +/// geometry quality). Some models charge extra for `Detailed`. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonMeshQuality { + #[serde(rename = "standard")] + Standard, + + #[serde(rename = "detailed")] + Detailed, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonMeshQuality::Standard, "standard"); + assert_serialization(CommonMeshQuality::Detailed, "detailed"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("standard", CommonMeshQuality::Standard), + ("detailed", CommonMeshQuality::Detailed), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonMeshQuality = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [CommonMeshQuality::Standard, CommonMeshQuality::Detailed]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonMeshQuality = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_model_class.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_model_class.rs new file mode 100644 index 00000000..03ab0298 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_model_class.rs @@ -0,0 +1,216 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for future database storage. +pub const MAX_LENGTH: usize = 24; + +/// The broad class of model (image, video, audio, 3D, etc.) +/// +/// NB: This is not currently stored in the database, so it does not need +/// `impl_mysql_enum_coders!` or `impl_mysql_from_row!` macros. If it is +/// stored in the future, add those macros and a migration. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +pub enum CommonModelClass { + #[serde(rename = "image")] + Image, + + #[serde(rename = "video")] + Video, + + #[serde(rename = "audio")] + Audio, + + #[serde(rename = "audio_music")] + AudioMusic, + + #[serde(rename = "audio_voice")] + AudioVoice, + + #[serde(rename = "3d")] + Dimensional, + + #[serde(rename = "3d_mesh")] + DimensionalMesh, + + #[serde(rename = "3d_splat")] + DimensionalSplat, +} + +impl_enum_display_and_debug_using_to_str!(CommonModelClass); + +impl CommonModelClass { + pub fn to_str(&self) -> &'static str { + match self { + Self::Image => "image", + Self::Video => "video", + Self::Audio => "audio", + Self::AudioMusic => "audio_music", + Self::AudioVoice => "audio_voice", + Self::Dimensional => "3d", + Self::DimensionalMesh => "3d_mesh", + Self::DimensionalSplat => "3d_splat", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "image" => Ok(Self::Image), + "video" => Ok(Self::Video), + "audio" => Ok(Self::Audio), + "audio_music" => Ok(Self::AudioMusic), + "audio_voice" => Ok(Self::AudioVoice), + "3d" => Ok(Self::Dimensional), + "3d_mesh" => Ok(Self::DimensionalMesh), + "3d_splat" => Ok(Self::DimensionalSplat), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Image, + Self::Video, + Self::Audio, + Self::AudioMusic, + Self::AudioVoice, + Self::Dimensional, + Self::DimensionalMesh, + Self::DimensionalSplat, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_model_class::CommonModelClass; + use crate::enums::common::generation::common_model_class::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(CommonModelClass::Image, "image"); + assert_serialization(CommonModelClass::Video, "video"); + assert_serialization(CommonModelClass::Audio, "audio"); + assert_serialization(CommonModelClass::AudioMusic, "audio_music"); + assert_serialization(CommonModelClass::AudioVoice, "audio_voice"); + assert_serialization(CommonModelClass::Dimensional, "3d"); + assert_serialization(CommonModelClass::DimensionalMesh, "3d_mesh"); + assert_serialization(CommonModelClass::DimensionalSplat, "3d_splat"); + } + + #[test] + fn to_str() { + assert_eq!(CommonModelClass::Image.to_str(), "image"); + assert_eq!(CommonModelClass::Video.to_str(), "video"); + assert_eq!(CommonModelClass::Audio.to_str(), "audio"); + assert_eq!(CommonModelClass::AudioMusic.to_str(), "audio_music"); + assert_eq!(CommonModelClass::AudioVoice.to_str(), "audio_voice"); + assert_eq!(CommonModelClass::Dimensional.to_str(), "3d"); + assert_eq!(CommonModelClass::DimensionalMesh.to_str(), "3d_mesh"); + assert_eq!(CommonModelClass::DimensionalSplat.to_str(), "3d_splat"); + } + + #[test] + fn from_str() { + assert_eq!(CommonModelClass::from_str("image").unwrap(), CommonModelClass::Image); + assert_eq!(CommonModelClass::from_str("video").unwrap(), CommonModelClass::Video); + assert_eq!(CommonModelClass::from_str("audio").unwrap(), CommonModelClass::Audio); + assert_eq!(CommonModelClass::from_str("audio_music").unwrap(), CommonModelClass::AudioMusic); + assert_eq!(CommonModelClass::from_str("audio_voice").unwrap(), CommonModelClass::AudioVoice); + assert_eq!(CommonModelClass::from_str("3d").unwrap(), CommonModelClass::Dimensional); + assert_eq!(CommonModelClass::from_str("3d_mesh").unwrap(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelClass::from_str("3d_splat").unwrap(), CommonModelClass::DimensionalSplat); + } + + #[test] + fn from_str_err() { + let result = CommonModelClass::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = CommonModelClass::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(CommonModelClass::Image)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::Video)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::Audio)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::AudioMusic)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::AudioVoice)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::Dimensional)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::DimensionalMesh)); + assert_eq!(variants.pop_first(), Some(CommonModelClass::DimensionalSplat)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonModelClass::all_variants().len(), CommonModelClass::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonModelClass::all_variants() { + assert_eq!(variant, CommonModelClass::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonModelClass::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonModelClass::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonModelClass::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonModelClass::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonModelClass::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_model_type.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_model_type.rs new file mode 100644 index 00000000..c8f1bd4b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_model_type.rs @@ -0,0 +1,1271 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::common::generation::common_model_class::CommonModelClass; + +/// Maximum serialized string length for database storage. +/// Stored in the `prompts` table (`maybe_model_type` column) as VARCHAR(24). +pub const MAX_LENGTH: usize = 24; + +/// Common model type enum used across image, video, 3D, and splat generation. +/// This forms part of our core data model for generative models. +/// +/// This is used in the MySQL database, the HTTP API, and throughout +/// ArtCraft (the Tauri app). +/// +/// Stored in the `prompts` table (`maybe_model_type` column). +/// Also used by other tables and the sqlite tasks table. +/// +/// NB: This will be used by a variety of tables (MySQL and sqlite)! +/// Keep the max length to 24 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonModelType { + // Image models + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_dev_juggernaut")] + FluxDevJuggernaut, + #[serde(rename = "flux_pro_1")] + FluxPro1, + #[serde(rename = "flux_pro_1p1")] + FluxPro11, + #[serde(rename = "flux_pro_1p1_ultra")] + FluxPro11Ultra, + #[serde(rename = "flux_pro_kontext_max")] + FluxProKontextMax, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + // Generic grok image model without a version + #[serde(rename = "grok_image")] + GrokImage, + // xAI's Grok Imagine image model (grok-imagine-image), standard tier. + #[serde(rename = "grok_imagine_image")] + GrokImagineImage, + // xAI's Grok Imagine image model (grok-imagine-image-quality), high-quality tier. + #[serde(rename = "grok_imagine_image_q")] + GrokImagineImageQuality, + #[serde(rename = "recraft_3")] + Recraft3, + #[serde(rename = "seededit_3")] + SeedEdit3, + #[serde(rename = "qwen")] + Qwen, + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + /// Gemini 2.5 Flash, AKA "Nano Banana" + #[serde(rename = "gemini_25_flash")] + Gemini25Flash, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + /// Seedream 5.0 Pro as routed via kinovi + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + /// Seedream 5.0 Pro as routed via the kinovi ultra account + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + + /// Midjourney without distinguishing a model type or version + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "midjourney_v6")] + MidjourneyV6, + #[serde(rename = "midjourney_v6p1")] + MidjourneyV6p1, + #[serde(rename = "midjourney_v6p1_raw")] + MidjourneyV6p1Raw, + #[serde(rename = "midjourney_v7")] + MidjourneyV7, + #[serde(rename = "midjourney_v7_draft")] + MidjourneyV7Draft, + #[serde(rename = "midjourney_v7_draft_raw")] + MidjourneyV7DraftRaw, + #[serde(rename = "midjourney_v7_raw")] + MidjourneyV7Raw, + /// Midjourney v7 as routed via kinovi + #[serde(rename = "midjourney_7")] + Midjourney7, + /// Midjourney v7 niji as routed via kinovi + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + /// Midjourney v8 as routed via kinovi + #[serde(rename = "midjourney_8")] + Midjourney8, + + //// Image Infill models + //#[serde(rename = "flux_pro_1_infill")] + //FluxPro1Infill, + + // Video models + + /// Generic grok video model without a version + /// NB: This was for the consumer web login API + #[deprecated(note = "use GrokImagineVideo instead")] + #[serde(rename = "grok_video")] + GrokVideo, + /// xAI's Grok Imagine video model (grok-imagine-video). + /// This is for the API-based version. + /// No version is specified. + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + /// xAI's Grok Imagine video 1.5 preview model (grok-imagine-video-1.5-preview). + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + #[serde(rename = "kling_2p1_master")] + Kling21Master, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p0_pro")] + Seedance10Pro, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + #[serde(rename = "seedance_2p0")] + Seedance2p0, + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + #[serde(rename = "seedance_2p0_bp_mini")] + Seedance2p0BytePlusMini, + #[serde(rename = "seedance_2p0_bpu_mini")] + Seedance2p0BytePlusUltraMini, + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + #[serde(rename = "vidu_q3")] + ViduQ3, + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, + + // Audio models + #[serde(rename = "suno_music")] + SunoMusic, + #[serde(rename = "suno_remix")] + SunoRemix, + #[serde(rename = "suno_sounds")] + SunoSounds, + #[serde(rename = "suno_sample")] + SunoSample, + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, + + #[serde(rename = "preview_model")] + PreviewModel, + #[serde(rename = "preview_model_fast")] + PreviewModelFast, + #[serde(rename = "switch_x")] + SwitchX, + + // 3D Object generation models + #[serde(rename = "hunyuan_3d_2p0")] + Hunyuan3d2_0, + #[serde(rename = "hunyuan_3d_2p1")] + Hunyuan3d2_1, + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3_1Pro, + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3_1Rapid, + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3_1Part, + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3_1SmartTopology, + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3_1, + #[serde(rename = "meshy_v6")] + MeshyV6, + #[serde(rename = "rodin_2p5_fast")] + Rodin2_5Fast, + + // Splat generation models (World Labs) + #[serde(rename = "marble_0p1_mini")] + Marble0p1Mini, + #[serde(rename = "marble_0p1_plus")] + Marble0p1Plus, + #[serde(rename = "marble_1p0")] + Marble1p0, + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + #[serde(rename = "marble_1p1")] + Marble1p1, + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + #[serde(rename = "triposplat")] + TripoSplat, +} + +impl_enum_display_and_debug_using_to_str!(CommonModelType); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl CommonModelType { + pub fn to_str(&self) -> &'static str { + match self { + // Image models + Self::Flux1Dev => "flux_1_dev", + Self::Flux1Schnell => "flux_1_schnell", + Self::FluxDevJuggernaut => "flux_dev_juggernaut", + Self::FluxPro1 => "flux_pro_1", + Self::FluxPro11 => "flux_pro_1p1", + Self::FluxPro11Ultra => "flux_pro_1p1_ultra", + Self::FluxProKontextMax => "flux_pro_kontext_max", + Self::Flux2LoraAngles => "flux_2_lora_angles", + Self::GptImage1 => "gpt_image_1", + Self::GptImage1p5 => "gpt_image_1p5", + Self::GptImage2 => "gpt_image_2", + Self::GrokImage => "grok_image", + Self::GrokImagineImage => "grok_imagine_image", + Self::GrokImagineImageQuality => "grok_imagine_image_q", + Self::Recraft3 => "recraft_3", + Self::SeedEdit3 => "seededit_3", + Self::Qwen => "qwen", + Self::QwenEdit2511Angles => "qwen_edit_2511_angles", + Self::Gemini25Flash => "gemini_25_flash", + Self::NanoBanana => "nano_banana", + Self::NanoBanana2 => "nano_banana_2", + Self::NanoBananaPro => "nano_banana_pro", + Self::Seedream4 => "seedream_4", + Self::Seedream4p5 => "seedream_4p5", + Self::Seedream5Lite => "seedream_5_lite", + Self::Seedream5p0Pro => "seedream_5p0_pro", + Self::Seedream5p0ProUltra => "seedream_5p0_pro_u", + Self::Midjourney => "midjourney", + Self::MidjourneyV6 => "midjourney_v6", + Self::MidjourneyV6p1 => "midjourney_v6p1", + Self::MidjourneyV6p1Raw => "midjourney_v6p1_raw", + Self::MidjourneyV7 => "midjourney_v7", + Self::MidjourneyV7Draft => "midjourney_v7_draft", + Self::MidjourneyV7DraftRaw => "midjourney_v7_draft_raw", + Self::MidjourneyV7Raw => "midjourney_v7_raw", + Self::Midjourney7 => "midjourney_7", + Self::Midjourney7Niji => "midjourney_7_niji", + Self::Midjourney8 => "midjourney_8", + + // Video models + Self::GrokVideo => "grok_video", + Self::GrokImagineVideo => "grok_imagine_video", + Self::GrokImagineVideo1p5 => "grok_imagine_video_1p5", + Self::Kling16Pro => "kling_1p6_pro", + Self::Kling21Pro => "kling_2p1_pro", + Self::Kling21Master => "kling_2p1_master", + Self::Kling2p5TurboPro => "kling_2p5_turbo_pro", + Self::Kling2p6Pro => "kling_2p6_pro", + Self::Kling3p0Standard => "kling_3p0_standard", + Self::Kling3p0Pro => "kling_3p0_pro", + Self::HappyHorse1p0 => "happy_horse_1p0", + Self::Seedance10Lite => "seedance_1p0_lite", + Self::Seedance10Pro => "seedance_1p0_pro", + Self::Seedance1p5Pro => "seedance_1p5_pro", + Self::Seedance2p0 => "seedance_2p0", + Self::Seedance2p0Fast => "seedance_2p0_fast", + Self::Seedance2p0BytePlus => "seedance_2p0_bp", + Self::Seedance2p0BytePlusFast => "seedance_2p0_bp_fast", + Self::Seedance2p0Ultra => "seedance_2p0_u", + Self::Seedance2p0UltraFast => "seedance_2p0_u_fast", + Self::Seedance2p0BytePlusUltra => "seedance_2p0_bpu", + Self::Seedance2p0BytePlusUltraFast => "seedance_2p0_bpu_fast", + Self::Seedance2p0Mini => "seedance_2p0_mini", + Self::Seedance2p0BytePlusMini => "seedance_2p0_bp_mini", + Self::Seedance2p0BytePlusUltraMini => "seedance_2p0_bpu_mini", + Self::Sora2 => "sora_2", + Self::Sora2Pro => "sora_2_pro", + Self::Veo2 => "veo_2", + Self::Veo3 => "veo_3", + Self::Veo3Fast => "veo_3_fast", + Self::Veo3p1 => "veo_3p1", + Self::Veo3p1Fast => "veo_3p1_fast", + Self::Veo3p1Lite => "veo_3p1_lite", + Self::ViduQ3 => "vidu_q3", + Self::ViduQ3Turbo => "vidu_q3_turbo", + + // Audio models + Self::SunoMusic => "suno_music", + Self::SunoRemix => "suno_remix", + Self::SunoSounds => "suno_sounds", + Self::SunoSample => "suno_sample", + Self::SeedAudio1p0 => "seed_audio_1p0", + + Self::PreviewModel => "preview_model", + Self::PreviewModelFast => "preview_model_fast", + Self::SwitchX => "switch_x", + + // 3D Object generation models + Self::Hunyuan3d2_0 => "hunyuan_3d_2p0", + Self::Hunyuan3d2_1 => "hunyuan_3d_2p1", + Self::Hunyuan3d3 => "hunyuan_3d_3", + Self::Hunyuan3d3_1Pro => "hunyuan_3d_3p1_pro", + Self::Hunyuan3d3_1Rapid => "hunyuan_3d_3p1_rapid", + Self::Hunyuan3d3_1Part => "hunyuan_3d_3p1_part", + Self::Hunyuan3d3_1SmartTopology => "hunyuan_3d_3p1_topology", + Self::Tripo3dH3_1 => "tripo3d_h3p1", + Self::MeshyV6 => "meshy_v6", + Self::Rodin2_5Fast => "rodin_2p5_fast", + + // Splat generation models (World Labs) + Self::Marble0p1Mini => "marble_0p1_mini", + Self::Marble0p1Plus => "marble_0p1_plus", + Self::Marble1p0 => "marble_1p0", + Self::Marble1p0Draft => "marble_1p0_draft", + Self::Marble1p1 => "marble_1p1", + Self::Marble1p1Plus => "marble_1p1_plus", + Self::TripoSplat => "triposplat", + } + } + + pub fn from_str(job_status: &str) -> Result { + match job_status { + // Image models + "flux_1_dev" => Ok(Self::Flux1Dev), + "flux_1_schnell" => Ok(Self::Flux1Schnell), + "flux_dev_juggernaut" => Ok(Self::FluxDevJuggernaut), + "flux_pro_1" => Ok(Self::FluxPro1), + "flux_pro_1p1" => Ok(Self::FluxPro11), + "flux_pro_1p1_ultra" => Ok(Self::FluxPro11Ultra), + "flux_pro_kontext_max" => Ok(Self::FluxProKontextMax), + "flux_2_lora_angles" => Ok(Self::Flux2LoraAngles), + "gpt_image_1" => Ok(Self::GptImage1), + "gpt_image_1p5" => Ok(Self::GptImage1p5), + "gpt_image_2" => Ok(Self::GptImage2), + "grok_image" => Ok(Self::GrokImage), + "grok_imagine_image" => Ok(Self::GrokImagineImage), + "grok_imagine_image_q" => Ok(Self::GrokImagineImageQuality), + "recraft_3" => Ok(Self::Recraft3), + "seededit_3" => Ok(Self::SeedEdit3), + "qwen" => Ok(Self::Qwen), + "qwen_edit_2511_angles" => Ok(Self::QwenEdit2511Angles), + "gemini_25_flash" => Ok(Self::Gemini25Flash), + "nano_banana" => Ok(Self::NanoBanana), + "nano_banana_2" => Ok(Self::NanoBanana2), + "nano_banana_pro" => Ok(Self::NanoBananaPro), + "seedream_4" => Ok(Self::Seedream4), + "seedream_4p5" => Ok(Self::Seedream4p5), + "seedream_5_lite" => Ok(Self::Seedream5Lite), + "seedream_5p0_pro" => Ok(Self::Seedream5p0Pro), + "seedream_5p0_pro_u" => Ok(Self::Seedream5p0ProUltra), + "midjourney" => Ok(Self::Midjourney), + "midjourney_v6" => Ok(Self::MidjourneyV6), + "midjourney_v6p1" => Ok(Self::MidjourneyV6p1), + "midjourney_v6p1_raw" => Ok(Self::MidjourneyV6p1Raw), + "midjourney_v7" => Ok(Self::MidjourneyV7), + "midjourney_v7_draft" => Ok(Self::MidjourneyV7Draft), + "midjourney_v7_draft_raw" => Ok(Self::MidjourneyV7DraftRaw), + "midjourney_v7_raw" => Ok(Self::MidjourneyV7Raw), + "midjourney_7" => Ok(Self::Midjourney7), + "midjourney_7_niji" => Ok(Self::Midjourney7Niji), + "midjourney_8" => Ok(Self::Midjourney8), + + // Video models + "grok_video" => Ok(Self::GrokVideo), + "grok_imagine_video" => Ok(Self::GrokImagineVideo), + "grok_imagine_video_1p5" => Ok(Self::GrokImagineVideo1p5), + "kling_1p6_pro" => Ok(Self::Kling16Pro), + "kling_2p1_pro" => Ok(Self::Kling21Pro), + "kling_2p1_master" => Ok(Self::Kling21Master), + "kling_2p5_turbo_pro" => Ok(Self::Kling2p5TurboPro), + "kling_2p6_pro" => Ok(Self::Kling2p6Pro), + "kling_3p0_standard" => Ok(Self::Kling3p0Standard), + "kling_3p0_pro" => Ok(Self::Kling3p0Pro), + "happy_horse_1p0" => Ok(Self::HappyHorse1p0), + "seedance_1p0_lite" => Ok(Self::Seedance10Lite), + "seedance_1p0_pro" => Ok(Self::Seedance10Pro), + "seedance_1p5_pro" => Ok(Self::Seedance1p5Pro), + "seedance_2p0" => Ok(Self::Seedance2p0), + "seedance_2p0_fast" => Ok(Self::Seedance2p0Fast), + "seedance_2p0_bp" => Ok(Self::Seedance2p0BytePlus), + "seedance_2p0_bp_fast" => Ok(Self::Seedance2p0BytePlusFast), + "seedance_2p0_u" => Ok(Self::Seedance2p0Ultra), + "seedance_2p0_u_fast" => Ok(Self::Seedance2p0UltraFast), + "seedance_2p0_bpu" => Ok(Self::Seedance2p0BytePlusUltra), + "seedance_2p0_bpu_fast" => Ok(Self::Seedance2p0BytePlusUltraFast), + "seedance_2p0_mini" => Ok(Self::Seedance2p0Mini), + "seedance_2p0_bp_mini" => Ok(Self::Seedance2p0BytePlusMini), + "seedance_2p0_bpu_mini" => Ok(Self::Seedance2p0BytePlusUltraMini), + "sora_2" => Ok(Self::Sora2), + "sora_2_pro" => Ok(Self::Sora2Pro), + "veo_2" => Ok(Self::Veo2), + "veo_3" => Ok(Self::Veo3), + "veo_3_fast" => Ok(Self::Veo3Fast), + "veo_3p1" => Ok(Self::Veo3p1), + "veo_3p1_fast" => Ok(Self::Veo3p1Fast), + "veo_3p1_lite" => Ok(Self::Veo3p1Lite), + "vidu_q3" => Ok(Self::ViduQ3), + "vidu_q3_turbo" => Ok(Self::ViduQ3Turbo), + + // Audio models + "suno_music" => Ok(Self::SunoMusic), + "suno_remix" => Ok(Self::SunoRemix), + "suno_sounds" => Ok(Self::SunoSounds), + "suno_sample" => Ok(Self::SunoSample), + "seed_audio_1p0" => Ok(Self::SeedAudio1p0), + + "preview_model" => Ok(Self::PreviewModel), + "preview_model_fast" => Ok(Self::PreviewModelFast), + "switch_x" => Ok(Self::SwitchX), + + // 3D Object generation models + "hunyuan_3d_2p0" => Ok(Self::Hunyuan3d2_0), + "hunyuan_3d_2p1" => Ok(Self::Hunyuan3d2_1), + "hunyuan_3d_3" => Ok(Self::Hunyuan3d3), + "hunyuan_3d_3p1_pro" => Ok(Self::Hunyuan3d3_1Pro), + "hunyuan_3d_3p1_rapid" => Ok(Self::Hunyuan3d3_1Rapid), + "hunyuan_3d_3p1_part" => Ok(Self::Hunyuan3d3_1Part), + "hunyuan_3d_3p1_topology" => Ok(Self::Hunyuan3d3_1SmartTopology), + "tripo3d_h3p1" => Ok(Self::Tripo3dH3_1), + "meshy_v6" => Ok(Self::MeshyV6), + "rodin_2p5_fast" => Ok(Self::Rodin2_5Fast), + + // Splat generation models (World Labs) + "marble_0p1_mini" => Ok(Self::Marble0p1Mini), + "marble_0p1_plus" => Ok(Self::Marble0p1Plus), + "marble_1p0" => Ok(Self::Marble1p0), + "marble_1p0_draft" => Ok(Self::Marble1p0Draft), + "marble_1p1" => Ok(Self::Marble1p1), + "marble_1p1_plus" => Ok(Self::Marble1p1Plus), + "triposplat" => Ok(Self::TripoSplat), + + _ => Err(format!("invalid model_type: {:?}", job_status)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + // Image models + Self::Flux1Dev, + Self::Flux1Schnell, + Self::FluxDevJuggernaut, + Self::FluxPro1, + Self::FluxPro11, + Self::FluxPro11Ultra, + Self::FluxProKontextMax, + Self::Flux2LoraAngles, + Self::GptImage1, + Self::GptImage1p5, + Self::GptImage2, + Self::GrokImage, + Self::GrokImagineImage, + Self::GrokImagineImageQuality, + Self::Recraft3, + Self::SeedEdit3, + Self::Qwen, + Self::QwenEdit2511Angles, + Self::Gemini25Flash, + Self::NanoBanana, + Self::NanoBanana2, + Self::NanoBananaPro, + Self::Seedream4, + Self::Seedream4p5, + Self::Seedream5Lite, + Self::Seedream5p0Pro, + Self::Seedream5p0ProUltra, + Self::Midjourney, + Self::MidjourneyV6, + Self::MidjourneyV6p1, + Self::MidjourneyV6p1Raw, + Self::MidjourneyV7, + Self::MidjourneyV7Draft, + Self::MidjourneyV7DraftRaw, + Self::MidjourneyV7Raw, + Self::Midjourney7, + Self::Midjourney7Niji, + Self::Midjourney8, + + // Video models + Self::GrokVideo, + Self::GrokImagineVideo, + Self::GrokImagineVideo1p5, + Self::Kling16Pro, + Self::Kling21Pro, + Self::Kling21Master, + Self::Kling2p5TurboPro, + Self::Kling2p6Pro, + Self::Kling3p0Standard, + Self::Kling3p0Pro, + Self::HappyHorse1p0, + Self::Seedance10Lite, + Self::Seedance10Pro, + Self::Seedance1p5Pro, + Self::Seedance2p0, + Self::Seedance2p0Fast, + Self::Seedance2p0BytePlus, + Self::Seedance2p0BytePlusFast, + Self::Seedance2p0Ultra, + Self::Seedance2p0UltraFast, + Self::Seedance2p0BytePlusUltra, + Self::Seedance2p0BytePlusUltraFast, + Self::Seedance2p0Mini, + Self::Seedance2p0BytePlusMini, + Self::Seedance2p0BytePlusUltraMini, + Self::Sora2, + Self::Sora2Pro, + Self::Veo2, + Self::Veo3, + Self::Veo3Fast, + Self::Veo3p1, + Self::Veo3p1Fast, + Self::Veo3p1Lite, + Self::ViduQ3, + Self::ViduQ3Turbo, + + // Audio models + Self::SunoMusic, + Self::SunoRemix, + Self::SunoSounds, + Self::SunoSample, + Self::SeedAudio1p0, + + Self::PreviewModel, + Self::PreviewModelFast, + Self::SwitchX, + + // 3D Object generation models + Self::Hunyuan3d2_0, + Self::Hunyuan3d2_1, + Self::Hunyuan3d3, + Self::Hunyuan3d3_1Pro, + Self::Hunyuan3d3_1Rapid, + Self::Hunyuan3d3_1Part, + Self::Hunyuan3d3_1SmartTopology, + Self::Tripo3dH3_1, + Self::MeshyV6, + Self::Rodin2_5Fast, + + // Splat generation models (World Labs) + Self::Marble0p1Mini, + Self::Marble0p1Plus, + Self::Marble1p0, + Self::Marble1p0Draft, + Self::Marble1p1, + Self::Marble1p1Plus, + Self::TripoSplat, + ]) + } + + /// Returns the broad model class for this model type. + pub fn get_model_class(&self) -> CommonModelClass { + match self { + // Image models + Self::Flux1Dev => CommonModelClass::Image, + Self::Flux1Schnell => CommonModelClass::Image, + Self::FluxDevJuggernaut => CommonModelClass::Image, + Self::FluxPro1 => CommonModelClass::Image, + Self::FluxPro11 => CommonModelClass::Image, + Self::FluxPro11Ultra => CommonModelClass::Image, + Self::FluxProKontextMax => CommonModelClass::Image, + Self::Flux2LoraAngles => CommonModelClass::Image, + Self::GptImage1 => CommonModelClass::Image, + Self::GptImage1p5 => CommonModelClass::Image, + Self::GptImage2 => CommonModelClass::Image, + Self::GrokImage => CommonModelClass::Image, + Self::GrokImagineImage => CommonModelClass::Image, + Self::GrokImagineImageQuality => CommonModelClass::Image, + Self::Recraft3 => CommonModelClass::Image, + Self::SeedEdit3 => CommonModelClass::Image, + Self::Qwen => CommonModelClass::Image, + Self::QwenEdit2511Angles => CommonModelClass::Image, + Self::Gemini25Flash => CommonModelClass::Image, + Self::NanoBanana => CommonModelClass::Image, + Self::NanoBanana2 => CommonModelClass::Image, + Self::NanoBananaPro => CommonModelClass::Image, + Self::Seedream4 => CommonModelClass::Image, + Self::Seedream4p5 => CommonModelClass::Image, + Self::Seedream5Lite => CommonModelClass::Image, + Self::Seedream5p0Pro => CommonModelClass::Image, + Self::Seedream5p0ProUltra => CommonModelClass::Image, + Self::Midjourney => CommonModelClass::Image, + Self::MidjourneyV6 => CommonModelClass::Image, + Self::MidjourneyV6p1 => CommonModelClass::Image, + Self::MidjourneyV6p1Raw => CommonModelClass::Image, + Self::MidjourneyV7 => CommonModelClass::Image, + Self::MidjourneyV7Draft => CommonModelClass::Image, + Self::MidjourneyV7DraftRaw => CommonModelClass::Image, + Self::MidjourneyV7Raw => CommonModelClass::Image, + Self::Midjourney7 => CommonModelClass::Image, + Self::Midjourney7Niji => CommonModelClass::Image, + Self::Midjourney8 => CommonModelClass::Image, + + // Video models + Self::GrokVideo => CommonModelClass::Video, + Self::GrokImagineVideo => CommonModelClass::Video, + Self::GrokImagineVideo1p5 => CommonModelClass::Video, + Self::Kling16Pro => CommonModelClass::Video, + Self::Kling21Pro => CommonModelClass::Video, + Self::Kling21Master => CommonModelClass::Video, + Self::Kling2p5TurboPro => CommonModelClass::Video, + Self::Kling2p6Pro => CommonModelClass::Video, + Self::Kling3p0Standard => CommonModelClass::Video, + Self::Kling3p0Pro => CommonModelClass::Video, + Self::HappyHorse1p0 => CommonModelClass::Video, + Self::Seedance10Lite => CommonModelClass::Video, + Self::Seedance10Pro => CommonModelClass::Video, + Self::Seedance1p5Pro => CommonModelClass::Video, + Self::Seedance2p0 => CommonModelClass::Video, + Self::Seedance2p0Fast => CommonModelClass::Video, + Self::Seedance2p0BytePlus => CommonModelClass::Video, + Self::Seedance2p0BytePlusFast => CommonModelClass::Video, + Self::Seedance2p0Ultra => CommonModelClass::Video, + Self::Seedance2p0UltraFast => CommonModelClass::Video, + Self::Seedance2p0BytePlusUltra => CommonModelClass::Video, + Self::Seedance2p0BytePlusUltraFast => CommonModelClass::Video, + Self::Seedance2p0Mini => CommonModelClass::Video, + Self::Seedance2p0BytePlusMini => CommonModelClass::Video, + Self::Seedance2p0BytePlusUltraMini => CommonModelClass::Video, + Self::Sora2 => CommonModelClass::Video, + Self::Sora2Pro => CommonModelClass::Video, + Self::Veo2 => CommonModelClass::Video, + Self::Veo3 => CommonModelClass::Video, + Self::Veo3Fast => CommonModelClass::Video, + Self::Veo3p1 => CommonModelClass::Video, + Self::Veo3p1Fast => CommonModelClass::Video, + Self::Veo3p1Lite => CommonModelClass::Video, + Self::ViduQ3 => CommonModelClass::Video, + Self::ViduQ3Turbo => CommonModelClass::Video, + + // Audio models + Self::SunoMusic => CommonModelClass::Audio, + Self::SunoRemix => CommonModelClass::Audio, + Self::SunoSounds => CommonModelClass::Audio, + Self::SunoSample => CommonModelClass::Audio, + Self::SeedAudio1p0 => CommonModelClass::Audio, + + Self::PreviewModel => CommonModelClass::Video, + Self::PreviewModelFast => CommonModelClass::Video, + Self::SwitchX => CommonModelClass::Video, + + // 3D Object generation models (mesh) + Self::Hunyuan3d2_0 => CommonModelClass::DimensionalMesh, + Self::Hunyuan3d2_1 => CommonModelClass::DimensionalMesh, + Self::Hunyuan3d3 => CommonModelClass::DimensionalMesh, + Self::Hunyuan3d3_1Pro => CommonModelClass::DimensionalMesh, + Self::Hunyuan3d3_1Rapid => CommonModelClass::DimensionalMesh, + Self::Hunyuan3d3_1Part => CommonModelClass::DimensionalMesh, + Self::Hunyuan3d3_1SmartTopology => CommonModelClass::DimensionalMesh, + Self::Tripo3dH3_1 => CommonModelClass::DimensionalMesh, + Self::MeshyV6 => CommonModelClass::DimensionalMesh, + Self::Rodin2_5Fast => CommonModelClass::DimensionalMesh, + + // Splat generation models (World Labs) + Self::Marble0p1Mini => CommonModelClass::DimensionalSplat, + Self::Marble0p1Plus => CommonModelClass::DimensionalSplat, + Self::Marble1p0 => CommonModelClass::DimensionalSplat, + Self::Marble1p0Draft => CommonModelClass::DimensionalSplat, + Self::Marble1p1 => CommonModelClass::DimensionalSplat, + Self::Marble1p1Plus => CommonModelClass::DimensionalSplat, + Self::TripoSplat => CommonModelClass::DimensionalSplat, + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_model_class::CommonModelClass; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::common::generation::common_model_type::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + // Image models + assert_serialization(CommonModelType::Flux1Dev, "flux_1_dev"); + assert_serialization(CommonModelType::Flux1Schnell, "flux_1_schnell"); + assert_serialization(CommonModelType::FluxDevJuggernaut, "flux_dev_juggernaut"); + assert_serialization(CommonModelType::FluxPro1, "flux_pro_1"); + assert_serialization(CommonModelType::FluxPro11, "flux_pro_1p1"); + assert_serialization(CommonModelType::FluxPro11Ultra, "flux_pro_1p1_ultra"); + assert_serialization(CommonModelType::FluxProKontextMax, "flux_pro_kontext_max"); + assert_serialization(CommonModelType::Flux2LoraAngles, "flux_2_lora_angles"); + assert_serialization(CommonModelType::GptImage1, "gpt_image_1"); + assert_serialization(CommonModelType::GptImage1p5, "gpt_image_1p5"); + assert_serialization(CommonModelType::GptImage2, "gpt_image_2"); + assert_serialization(CommonModelType::GrokImage, "grok_image"); + assert_serialization(CommonModelType::GrokImagineImage, "grok_imagine_image"); + assert_serialization(CommonModelType::GrokImagineImageQuality, "grok_imagine_image_q"); + assert_serialization(CommonModelType::Recraft3, "recraft_3"); + assert_serialization(CommonModelType::SeedEdit3, "seededit_3"); + assert_serialization(CommonModelType::Qwen, "qwen"); + assert_serialization(CommonModelType::QwenEdit2511Angles, "qwen_edit_2511_angles"); + assert_serialization(CommonModelType::Gemini25Flash, "gemini_25_flash"); + assert_serialization(CommonModelType::NanoBanana, "nano_banana"); + assert_serialization(CommonModelType::NanoBanana2, "nano_banana_2"); + assert_serialization(CommonModelType::NanoBananaPro, "nano_banana_pro"); + assert_serialization(CommonModelType::Seedream4, "seedream_4"); + assert_serialization(CommonModelType::Seedream4p5, "seedream_4p5"); + assert_serialization(CommonModelType::Seedream5Lite, "seedream_5_lite"); + assert_serialization(CommonModelType::Seedream5p0Pro, "seedream_5p0_pro"); + assert_serialization(CommonModelType::Seedream5p0ProUltra, "seedream_5p0_pro_u"); + assert_serialization(CommonModelType::Midjourney, "midjourney"); + assert_serialization(CommonModelType::MidjourneyV6, "midjourney_v6"); + assert_serialization(CommonModelType::MidjourneyV6p1, "midjourney_v6p1"); + assert_serialization(CommonModelType::MidjourneyV6p1Raw, "midjourney_v6p1_raw"); + assert_serialization(CommonModelType::MidjourneyV7, "midjourney_v7"); + assert_serialization(CommonModelType::MidjourneyV7Draft, "midjourney_v7_draft"); + assert_serialization(CommonModelType::MidjourneyV7DraftRaw, "midjourney_v7_draft_raw"); + assert_serialization(CommonModelType::MidjourneyV7Raw, "midjourney_v7_raw"); + assert_serialization(CommonModelType::Midjourney7, "midjourney_7"); + assert_serialization(CommonModelType::Midjourney7Niji, "midjourney_7_niji"); + assert_serialization(CommonModelType::Midjourney8, "midjourney_8"); + // Video models + assert_serialization(CommonModelType::GrokVideo, "grok_video"); + assert_serialization(CommonModelType::GrokImagineVideo, "grok_imagine_video"); + assert_serialization(CommonModelType::GrokImagineVideo1p5, "grok_imagine_video_1p5"); + assert_serialization(CommonModelType::Kling16Pro, "kling_1p6_pro"); + assert_serialization(CommonModelType::Kling21Pro, "kling_2p1_pro"); + assert_serialization(CommonModelType::Kling21Master, "kling_2p1_master"); + assert_serialization(CommonModelType::Kling2p5TurboPro, "kling_2p5_turbo_pro"); + assert_serialization(CommonModelType::Kling2p6Pro, "kling_2p6_pro"); + assert_serialization(CommonModelType::Kling3p0Standard, "kling_3p0_standard"); + assert_serialization(CommonModelType::Kling3p0Pro, "kling_3p0_pro"); + assert_serialization(CommonModelType::HappyHorse1p0, "happy_horse_1p0"); + assert_serialization(CommonModelType::Seedance10Lite, "seedance_1p0_lite"); + assert_serialization(CommonModelType::Seedance10Pro, "seedance_1p0_pro"); + assert_serialization(CommonModelType::Seedance1p5Pro, "seedance_1p5_pro"); + assert_serialization(CommonModelType::Seedance2p0, "seedance_2p0"); + assert_serialization(CommonModelType::Seedance2p0Fast, "seedance_2p0_fast"); + assert_serialization(CommonModelType::Seedance2p0BytePlus, "seedance_2p0_bp"); + assert_serialization(CommonModelType::Seedance2p0BytePlusFast, "seedance_2p0_bp_fast"); + assert_serialization(CommonModelType::Seedance2p0Ultra, "seedance_2p0_u"); + assert_serialization(CommonModelType::Seedance2p0UltraFast, "seedance_2p0_u_fast"); + assert_serialization(CommonModelType::Seedance2p0BytePlusUltra, "seedance_2p0_bpu"); + assert_serialization(CommonModelType::Seedance2p0BytePlusUltraFast, "seedance_2p0_bpu_fast"); + assert_serialization(CommonModelType::Seedance2p0Mini, "seedance_2p0_mini"); + assert_serialization(CommonModelType::Seedance2p0BytePlusMini, "seedance_2p0_bp_mini"); + assert_serialization(CommonModelType::Seedance2p0BytePlusUltraMini, "seedance_2p0_bpu_mini"); + assert_serialization(CommonModelType::Sora2, "sora_2"); + assert_serialization(CommonModelType::Sora2Pro, "sora_2_pro"); + assert_serialization(CommonModelType::Veo2, "veo_2"); + assert_serialization(CommonModelType::Veo3, "veo_3"); + assert_serialization(CommonModelType::Veo3Fast, "veo_3_fast"); + assert_serialization(CommonModelType::Veo3p1, "veo_3p1"); + assert_serialization(CommonModelType::Veo3p1Fast, "veo_3p1_fast"); + assert_serialization(CommonModelType::Veo3p1Lite, "veo_3p1_lite"); + assert_serialization(CommonModelType::ViduQ3, "vidu_q3"); + assert_serialization(CommonModelType::ViduQ3Turbo, "vidu_q3_turbo"); + // Audio models + assert_serialization(CommonModelType::SunoMusic, "suno_music"); + assert_serialization(CommonModelType::SunoRemix, "suno_remix"); + assert_serialization(CommonModelType::SunoSounds, "suno_sounds"); + assert_serialization(CommonModelType::SunoSample, "suno_sample"); + assert_serialization(CommonModelType::SeedAudio1p0, "seed_audio_1p0"); + assert_serialization(CommonModelType::PreviewModel, "preview_model"); + assert_serialization(CommonModelType::PreviewModelFast, "preview_model_fast"); + assert_serialization(CommonModelType::SwitchX, "switch_x"); + // 3D Object generation models + assert_serialization(CommonModelType::Hunyuan3d2_0, "hunyuan_3d_2p0"); + assert_serialization(CommonModelType::Hunyuan3d2_1, "hunyuan_3d_2p1"); + assert_serialization(CommonModelType::Hunyuan3d3, "hunyuan_3d_3"); + assert_serialization(CommonModelType::Hunyuan3d3_1Pro, "hunyuan_3d_3p1_pro"); + assert_serialization(CommonModelType::Hunyuan3d3_1Rapid, "hunyuan_3d_3p1_rapid"); + assert_serialization(CommonModelType::Hunyuan3d3_1Part, "hunyuan_3d_3p1_part"); + assert_serialization(CommonModelType::Hunyuan3d3_1SmartTopology, "hunyuan_3d_3p1_topology"); + assert_serialization(CommonModelType::Tripo3dH3_1, "tripo3d_h3p1"); + assert_serialization(CommonModelType::MeshyV6, "meshy_v6"); + assert_serialization(CommonModelType::Rodin2_5Fast, "rodin_2p5_fast"); + // Splat generation models (World Labs) + assert_serialization(CommonModelType::Marble0p1Mini, "marble_0p1_mini"); + assert_serialization(CommonModelType::Marble0p1Plus, "marble_0p1_plus"); + assert_serialization(CommonModelType::Marble1p0, "marble_1p0"); + assert_serialization(CommonModelType::Marble1p0Draft, "marble_1p0_draft"); + assert_serialization(CommonModelType::Marble1p1, "marble_1p1"); + assert_serialization(CommonModelType::Marble1p1Plus, "marble_1p1_plus"); + assert_serialization(CommonModelType::TripoSplat, "triposplat"); + } + + #[test] + fn to_str() { + // Image models + assert_eq!(CommonModelType::Flux1Dev.to_str(), "flux_1_dev"); + assert_eq!(CommonModelType::Flux1Schnell.to_str(), "flux_1_schnell"); + assert_eq!(CommonModelType::FluxDevJuggernaut.to_str(), "flux_dev_juggernaut"); + assert_eq!(CommonModelType::FluxPro1.to_str(), "flux_pro_1"); + assert_eq!(CommonModelType::FluxPro11.to_str(), "flux_pro_1p1"); + assert_eq!(CommonModelType::FluxPro11Ultra.to_str(), "flux_pro_1p1_ultra"); + assert_eq!(CommonModelType::FluxProKontextMax.to_str(), "flux_pro_kontext_max"); + assert_eq!(CommonModelType::Flux2LoraAngles.to_str(), "flux_2_lora_angles"); + assert_eq!(CommonModelType::GptImage1.to_str(), "gpt_image_1"); + assert_eq!(CommonModelType::GptImage1p5.to_str(), "gpt_image_1p5"); + assert_eq!(CommonModelType::GptImage2.to_str(), "gpt_image_2"); + assert_eq!(CommonModelType::GrokImage.to_str(), "grok_image"); + assert_eq!(CommonModelType::GrokImagineImage.to_str(), "grok_imagine_image"); + assert_eq!(CommonModelType::GrokImagineImageQuality.to_str(), "grok_imagine_image_q"); + assert_eq!(CommonModelType::Recraft3.to_str(), "recraft_3"); + assert_eq!(CommonModelType::SeedEdit3.to_str(), "seededit_3"); + assert_eq!(CommonModelType::Qwen.to_str(), "qwen"); + assert_eq!(CommonModelType::QwenEdit2511Angles.to_str(), "qwen_edit_2511_angles"); + assert_eq!(CommonModelType::Gemini25Flash.to_str(), "gemini_25_flash"); + assert_eq!(CommonModelType::NanoBanana.to_str(), "nano_banana"); + assert_eq!(CommonModelType::NanoBanana2.to_str(), "nano_banana_2"); + assert_eq!(CommonModelType::NanoBananaPro.to_str(), "nano_banana_pro"); + assert_eq!(CommonModelType::Seedream4.to_str(), "seedream_4"); + assert_eq!(CommonModelType::Seedream4p5.to_str(), "seedream_4p5"); + assert_eq!(CommonModelType::Seedream5Lite.to_str(), "seedream_5_lite"); + assert_eq!(CommonModelType::Seedream5p0Pro.to_str(), "seedream_5p0_pro"); + assert_eq!(CommonModelType::Seedream5p0ProUltra.to_str(), "seedream_5p0_pro_u"); + assert_eq!(CommonModelType::Midjourney.to_str(), "midjourney"); + assert_eq!(CommonModelType::MidjourneyV6.to_str(), "midjourney_v6"); + assert_eq!(CommonModelType::MidjourneyV6p1.to_str(), "midjourney_v6p1"); + assert_eq!(CommonModelType::MidjourneyV6p1Raw.to_str(), "midjourney_v6p1_raw"); + assert_eq!(CommonModelType::MidjourneyV7.to_str(), "midjourney_v7"); + assert_eq!(CommonModelType::MidjourneyV7Draft.to_str(), "midjourney_v7_draft"); + assert_eq!(CommonModelType::MidjourneyV7DraftRaw.to_str(), "midjourney_v7_draft_raw"); + assert_eq!(CommonModelType::MidjourneyV7Raw.to_str(), "midjourney_v7_raw"); + assert_eq!(CommonModelType::Midjourney7.to_str(), "midjourney_7"); + assert_eq!(CommonModelType::Midjourney7Niji.to_str(), "midjourney_7_niji"); + assert_eq!(CommonModelType::Midjourney8.to_str(), "midjourney_8"); + + // Video models + assert_eq!(CommonModelType::GrokVideo.to_str(), "grok_video"); + assert_eq!(CommonModelType::GrokImagineVideo.to_str(), "grok_imagine_video"); + assert_eq!(CommonModelType::GrokImagineVideo1p5.to_str(), "grok_imagine_video_1p5"); + assert_eq!(CommonModelType::Kling16Pro.to_str(), "kling_1p6_pro"); + assert_eq!(CommonModelType::Kling21Pro.to_str(), "kling_2p1_pro"); + assert_eq!(CommonModelType::Kling21Master.to_str(), "kling_2p1_master"); + assert_eq!(CommonModelType::Kling2p5TurboPro.to_str(), "kling_2p5_turbo_pro"); + assert_eq!(CommonModelType::Kling2p6Pro.to_str(), "kling_2p6_pro"); + assert_eq!(CommonModelType::Kling3p0Standard.to_str(), "kling_3p0_standard"); + assert_eq!(CommonModelType::Kling3p0Pro.to_str(), "kling_3p0_pro"); + assert_eq!(CommonModelType::HappyHorse1p0.to_str(), "happy_horse_1p0"); + assert_eq!(CommonModelType::Seedance10Lite.to_str(), "seedance_1p0_lite"); + assert_eq!(CommonModelType::Seedance10Pro.to_str(), "seedance_1p0_pro"); + assert_eq!(CommonModelType::Seedance1p5Pro.to_str(), "seedance_1p5_pro"); + assert_eq!(CommonModelType::Seedance2p0.to_str(), "seedance_2p0"); + assert_eq!(CommonModelType::Seedance2p0Fast.to_str(), "seedance_2p0_fast"); + assert_eq!(CommonModelType::Seedance2p0BytePlus.to_str(), "seedance_2p0_bp"); + assert_eq!(CommonModelType::Seedance2p0BytePlusFast.to_str(), "seedance_2p0_bp_fast"); + assert_eq!(CommonModelType::Seedance2p0Ultra.to_str(), "seedance_2p0_u"); + assert_eq!(CommonModelType::Seedance2p0UltraFast.to_str(), "seedance_2p0_u_fast"); + assert_eq!(CommonModelType::Seedance2p0BytePlusUltra.to_str(), "seedance_2p0_bpu"); + assert_eq!(CommonModelType::Seedance2p0BytePlusUltraFast.to_str(), "seedance_2p0_bpu_fast"); + assert_eq!(CommonModelType::Seedance2p0Mini.to_str(), "seedance_2p0_mini"); + assert_eq!(CommonModelType::Seedance2p0BytePlusMini.to_str(), "seedance_2p0_bp_mini"); + assert_eq!(CommonModelType::Seedance2p0BytePlusUltraMini.to_str(), "seedance_2p0_bpu_mini"); + assert_eq!(CommonModelType::Sora2.to_str(), "sora_2"); + assert_eq!(CommonModelType::Sora2Pro.to_str(), "sora_2_pro"); + assert_eq!(CommonModelType::Veo2.to_str(), "veo_2"); + assert_eq!(CommonModelType::Veo3.to_str(), "veo_3"); + assert_eq!(CommonModelType::Veo3Fast.to_str(), "veo_3_fast"); + assert_eq!(CommonModelType::Veo3p1.to_str(), "veo_3p1"); + assert_eq!(CommonModelType::Veo3p1Fast.to_str(), "veo_3p1_fast"); + assert_eq!(CommonModelType::Veo3p1Lite.to_str(), "veo_3p1_lite"); + assert_eq!(CommonModelType::ViduQ3.to_str(), "vidu_q3"); + assert_eq!(CommonModelType::ViduQ3Turbo.to_str(), "vidu_q3_turbo"); + + // Audio models + assert_eq!(CommonModelType::SunoMusic.to_str(), "suno_music"); + assert_eq!(CommonModelType::SunoRemix.to_str(), "suno_remix"); + assert_eq!(CommonModelType::SunoSounds.to_str(), "suno_sounds"); + assert_eq!(CommonModelType::SunoSample.to_str(), "suno_sample"); + assert_eq!(CommonModelType::SeedAudio1p0.to_str(), "seed_audio_1p0"); + + assert_eq!(CommonModelType::PreviewModel.to_str(), "preview_model"); + assert_eq!(CommonModelType::PreviewModelFast.to_str(), "preview_model_fast"); + assert_eq!(CommonModelType::SwitchX.to_str(), "switch_x"); + + // 3D Object generation models + assert_eq!(CommonModelType::Hunyuan3d2_0.to_str(), "hunyuan_3d_2p0"); + assert_eq!(CommonModelType::Hunyuan3d2_1.to_str(), "hunyuan_3d_2p1"); + assert_eq!(CommonModelType::Hunyuan3d3.to_str(), "hunyuan_3d_3"); + assert_eq!(CommonModelType::Hunyuan3d3_1Pro.to_str(), "hunyuan_3d_3p1_pro"); + assert_eq!(CommonModelType::Hunyuan3d3_1Rapid.to_str(), "hunyuan_3d_3p1_rapid"); + assert_eq!(CommonModelType::Hunyuan3d3_1Part.to_str(), "hunyuan_3d_3p1_part"); + assert_eq!(CommonModelType::Hunyuan3d3_1SmartTopology.to_str(), "hunyuan_3d_3p1_topology"); + assert_eq!(CommonModelType::Tripo3dH3_1.to_str(), "tripo3d_h3p1"); + assert_eq!(CommonModelType::MeshyV6.to_str(), "meshy_v6"); + assert_eq!(CommonModelType::Rodin2_5Fast.to_str(), "rodin_2p5_fast"); + // Splat generation models (World Labs) + assert_eq!(CommonModelType::Marble0p1Mini.to_str(), "marble_0p1_mini"); + assert_eq!(CommonModelType::Marble0p1Plus.to_str(), "marble_0p1_plus"); + assert_eq!(CommonModelType::Marble1p0.to_str(), "marble_1p0"); + assert_eq!(CommonModelType::Marble1p0Draft.to_str(), "marble_1p0_draft"); + assert_eq!(CommonModelType::Marble1p1.to_str(), "marble_1p1"); + assert_eq!(CommonModelType::Marble1p1Plus.to_str(), "marble_1p1_plus"); + assert_eq!(CommonModelType::TripoSplat.to_str(), "triposplat"); + } + + #[test] + fn from_str() { + // Image models + assert_eq!(CommonModelType::from_str("flux_1_dev").unwrap(), CommonModelType::Flux1Dev); + assert_eq!(CommonModelType::from_str("flux_1_schnell").unwrap(), CommonModelType::Flux1Schnell); + assert_eq!(CommonModelType::from_str("flux_dev_juggernaut").unwrap(), CommonModelType::FluxDevJuggernaut); + assert_eq!(CommonModelType::from_str("flux_pro_1").unwrap(), CommonModelType::FluxPro1); + assert_eq!(CommonModelType::from_str("flux_pro_1p1").unwrap(), CommonModelType::FluxPro11); + assert_eq!(CommonModelType::from_str("flux_pro_1p1_ultra").unwrap(), CommonModelType::FluxPro11Ultra); + assert_eq!(CommonModelType::from_str("flux_pro_kontext_max").unwrap(), CommonModelType::FluxProKontextMax); + assert_eq!(CommonModelType::from_str("flux_2_lora_angles").unwrap(), CommonModelType::Flux2LoraAngles); + assert_eq!(CommonModelType::from_str("gpt_image_1").unwrap(), CommonModelType::GptImage1); + assert_eq!(CommonModelType::from_str("gpt_image_1p5").unwrap(), CommonModelType::GptImage1p5); + assert_eq!(CommonModelType::from_str("gpt_image_2").unwrap(), CommonModelType::GptImage2); + assert_eq!(CommonModelType::from_str("grok_image").unwrap(), CommonModelType::GrokImage); + assert_eq!(CommonModelType::from_str("grok_imagine_image").unwrap(), CommonModelType::GrokImagineImage); + assert_eq!(CommonModelType::from_str("grok_imagine_image_q").unwrap(), CommonModelType::GrokImagineImageQuality); + assert_eq!(CommonModelType::from_str("recraft_3").unwrap(), CommonModelType::Recraft3); + assert_eq!(CommonModelType::from_str("seededit_3").unwrap(), CommonModelType::SeedEdit3); + assert_eq!(CommonModelType::from_str("qwen").unwrap(), CommonModelType::Qwen); + assert_eq!(CommonModelType::from_str("qwen_edit_2511_angles").unwrap(), CommonModelType::QwenEdit2511Angles); + assert_eq!(CommonModelType::from_str("gemini_25_flash").unwrap(), CommonModelType::Gemini25Flash); + assert_eq!(CommonModelType::from_str("nano_banana").unwrap(), CommonModelType::NanoBanana); + assert_eq!(CommonModelType::from_str("nano_banana_2").unwrap(), CommonModelType::NanoBanana2); + assert_eq!(CommonModelType::from_str("nano_banana_pro").unwrap(), CommonModelType::NanoBananaPro); + assert_eq!(CommonModelType::from_str("seedream_4").unwrap(), CommonModelType::Seedream4); + assert_eq!(CommonModelType::from_str("seedream_4p5").unwrap(), CommonModelType::Seedream4p5); + assert_eq!(CommonModelType::from_str("seedream_5_lite").unwrap(), CommonModelType::Seedream5Lite); + assert_eq!(CommonModelType::from_str("seedream_5p0_pro").unwrap(), CommonModelType::Seedream5p0Pro); + assert_eq!(CommonModelType::from_str("seedream_5p0_pro_u").unwrap(), CommonModelType::Seedream5p0ProUltra); + assert_eq!(CommonModelType::from_str("midjourney").unwrap(), CommonModelType::Midjourney); + assert_eq!(CommonModelType::from_str("midjourney_v6").unwrap(), CommonModelType::MidjourneyV6); + assert_eq!(CommonModelType::from_str("midjourney_v6p1").unwrap(), CommonModelType::MidjourneyV6p1); + assert_eq!(CommonModelType::from_str("midjourney_v6p1_raw").unwrap(), CommonModelType::MidjourneyV6p1Raw); + assert_eq!(CommonModelType::from_str("midjourney_v7").unwrap(), CommonModelType::MidjourneyV7); + assert_eq!(CommonModelType::from_str("midjourney_v7_draft").unwrap(), CommonModelType::MidjourneyV7Draft); + assert_eq!(CommonModelType::from_str("midjourney_v7_draft_raw").unwrap(), CommonModelType::MidjourneyV7DraftRaw); + assert_eq!(CommonModelType::from_str("midjourney_v7_raw").unwrap(), CommonModelType::MidjourneyV7Raw); + assert_eq!(CommonModelType::from_str("midjourney_7").unwrap(), CommonModelType::Midjourney7); + assert_eq!(CommonModelType::from_str("midjourney_7_niji").unwrap(), CommonModelType::Midjourney7Niji); + assert_eq!(CommonModelType::from_str("midjourney_8").unwrap(), CommonModelType::Midjourney8); + // Video models + assert_eq!(CommonModelType::from_str("grok_video").unwrap(), CommonModelType::GrokVideo); + assert_eq!(CommonModelType::from_str("grok_imagine_video").unwrap(), CommonModelType::GrokImagineVideo); + assert_eq!(CommonModelType::from_str("grok_imagine_video_1p5").unwrap(), CommonModelType::GrokImagineVideo1p5); + assert_eq!(CommonModelType::from_str("kling_1p6_pro").unwrap(), CommonModelType::Kling16Pro); + assert_eq!(CommonModelType::from_str("kling_2p1_pro").unwrap(), CommonModelType::Kling21Pro); + assert_eq!(CommonModelType::from_str("kling_2p1_master").unwrap(), CommonModelType::Kling21Master); + assert_eq!(CommonModelType::from_str("kling_2p5_turbo_pro").unwrap(), CommonModelType::Kling2p5TurboPro); + assert_eq!(CommonModelType::from_str("kling_2p6_pro").unwrap(), CommonModelType::Kling2p6Pro); + assert_eq!(CommonModelType::from_str("kling_3p0_standard").unwrap(), CommonModelType::Kling3p0Standard); + assert_eq!(CommonModelType::from_str("kling_3p0_pro").unwrap(), CommonModelType::Kling3p0Pro); + assert_eq!(CommonModelType::from_str("happy_horse_1p0").unwrap(), CommonModelType::HappyHorse1p0); + assert_eq!(CommonModelType::from_str("seedance_1p0_lite").unwrap(), CommonModelType::Seedance10Lite); + assert_eq!(CommonModelType::from_str("seedance_1p0_pro").unwrap(), CommonModelType::Seedance10Pro); + assert_eq!(CommonModelType::from_str("seedance_1p5_pro").unwrap(), CommonModelType::Seedance1p5Pro); + assert_eq!(CommonModelType::from_str("seedance_2p0").unwrap(), CommonModelType::Seedance2p0); + assert_eq!(CommonModelType::from_str("seedance_2p0_fast").unwrap(), CommonModelType::Seedance2p0Fast); + assert_eq!(CommonModelType::from_str("seedance_2p0_bp").unwrap(), CommonModelType::Seedance2p0BytePlus); + assert_eq!(CommonModelType::from_str("seedance_2p0_bp_fast").unwrap(), CommonModelType::Seedance2p0BytePlusFast); + assert_eq!(CommonModelType::from_str("seedance_2p0_u").unwrap(), CommonModelType::Seedance2p0Ultra); + assert_eq!(CommonModelType::from_str("seedance_2p0_u_fast").unwrap(), CommonModelType::Seedance2p0UltraFast); + assert_eq!(CommonModelType::from_str("seedance_2p0_bpu").unwrap(), CommonModelType::Seedance2p0BytePlusUltra); + assert_eq!(CommonModelType::from_str("seedance_2p0_bpu_fast").unwrap(), CommonModelType::Seedance2p0BytePlusUltraFast); + assert_eq!(CommonModelType::from_str("seedance_2p0_mini").unwrap(), CommonModelType::Seedance2p0Mini); + assert_eq!(CommonModelType::from_str("seedance_2p0_bp_mini").unwrap(), CommonModelType::Seedance2p0BytePlusMini); + assert_eq!(CommonModelType::from_str("seedance_2p0_bpu_mini").unwrap(), CommonModelType::Seedance2p0BytePlusUltraMini); + assert_eq!(CommonModelType::from_str("sora_2").unwrap(), CommonModelType::Sora2); + assert_eq!(CommonModelType::from_str("sora_2_pro").unwrap(), CommonModelType::Sora2Pro); + assert_eq!(CommonModelType::from_str("veo_2").unwrap(), CommonModelType::Veo2); + assert_eq!(CommonModelType::from_str("veo_3").unwrap(), CommonModelType::Veo3); + assert_eq!(CommonModelType::from_str("veo_3_fast").unwrap(), CommonModelType::Veo3Fast); + assert_eq!(CommonModelType::from_str("veo_3p1").unwrap(), CommonModelType::Veo3p1); + assert_eq!(CommonModelType::from_str("veo_3p1_fast").unwrap(), CommonModelType::Veo3p1Fast); + assert_eq!(CommonModelType::from_str("veo_3p1_lite").unwrap(), CommonModelType::Veo3p1Lite); + assert_eq!(CommonModelType::from_str("vidu_q3").unwrap(), CommonModelType::ViduQ3); + assert_eq!(CommonModelType::from_str("vidu_q3_turbo").unwrap(), CommonModelType::ViduQ3Turbo); + // Audio models + assert_eq!(CommonModelType::from_str("suno_music").unwrap(), CommonModelType::SunoMusic); + assert_eq!(CommonModelType::from_str("suno_remix").unwrap(), CommonModelType::SunoRemix); + assert_eq!(CommonModelType::from_str("suno_sounds").unwrap(), CommonModelType::SunoSounds); + assert_eq!(CommonModelType::from_str("suno_sample").unwrap(), CommonModelType::SunoSample); + assert_eq!(CommonModelType::from_str("seed_audio_1p0").unwrap(), CommonModelType::SeedAudio1p0); + assert_eq!(CommonModelType::from_str("preview_model").unwrap(), CommonModelType::PreviewModel); + assert_eq!(CommonModelType::from_str("preview_model_fast").unwrap(), CommonModelType::PreviewModelFast); + assert_eq!(CommonModelType::from_str("switch_x").unwrap(), CommonModelType::SwitchX); + + // 3D Object generation models + assert_eq!(CommonModelType::from_str("hunyuan_3d_2p0").unwrap(), CommonModelType::Hunyuan3d2_0); + assert_eq!(CommonModelType::from_str("hunyuan_3d_2p1").unwrap(), CommonModelType::Hunyuan3d2_1); + assert_eq!(CommonModelType::from_str("hunyuan_3d_3").unwrap(), CommonModelType::Hunyuan3d3); + assert_eq!(CommonModelType::from_str("hunyuan_3d_3p1_pro").unwrap(), CommonModelType::Hunyuan3d3_1Pro); + assert_eq!(CommonModelType::from_str("hunyuan_3d_3p1_rapid").unwrap(), CommonModelType::Hunyuan3d3_1Rapid); + assert_eq!(CommonModelType::from_str("hunyuan_3d_3p1_part").unwrap(), CommonModelType::Hunyuan3d3_1Part); + assert_eq!(CommonModelType::from_str("hunyuan_3d_3p1_topology").unwrap(), CommonModelType::Hunyuan3d3_1SmartTopology); + assert_eq!(CommonModelType::from_str("tripo3d_h3p1").unwrap(), CommonModelType::Tripo3dH3_1); + assert_eq!(CommonModelType::from_str("meshy_v6").unwrap(), CommonModelType::MeshyV6); + assert_eq!(CommonModelType::from_str("rodin_2p5_fast").unwrap(), CommonModelType::Rodin2_5Fast); + // Splat generation models (World Labs) + assert_eq!(CommonModelType::from_str("marble_0p1_mini").unwrap(), CommonModelType::Marble0p1Mini); + assert_eq!(CommonModelType::from_str("marble_0p1_plus").unwrap(), CommonModelType::Marble0p1Plus); + assert_eq!(CommonModelType::from_str("marble_1p0").unwrap(), CommonModelType::Marble1p0); + assert_eq!(CommonModelType::from_str("marble_1p0_draft").unwrap(), CommonModelType::Marble1p0Draft); + assert_eq!(CommonModelType::from_str("marble_1p1").unwrap(), CommonModelType::Marble1p1); + assert_eq!(CommonModelType::from_str("marble_1p1_plus").unwrap(), CommonModelType::Marble1p1Plus); + assert_eq!(CommonModelType::from_str("triposplat").unwrap(), CommonModelType::TripoSplat); + } + + #[test] + fn all_variants() { + let mut variants = CommonModelType::all_variants(); + assert_eq!(variants.len(), 98); + // Image models + assert_eq!(variants.pop_first(), Some(CommonModelType::Flux1Dev)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Flux1Schnell)); + assert_eq!(variants.pop_first(), Some(CommonModelType::FluxDevJuggernaut)); + assert_eq!(variants.pop_first(), Some(CommonModelType::FluxPro1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::FluxPro11)); + assert_eq!(variants.pop_first(), Some(CommonModelType::FluxPro11Ultra)); + assert_eq!(variants.pop_first(), Some(CommonModelType::FluxProKontextMax)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Flux2LoraAngles)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GptImage1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GptImage1p5)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GptImage2)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GrokImage)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GrokImagineImage)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GrokImagineImageQuality)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Recraft3)); + assert_eq!(variants.pop_first(), Some(CommonModelType::SeedEdit3)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Qwen)); + assert_eq!(variants.pop_first(), Some(CommonModelType::QwenEdit2511Angles)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Gemini25Flash)); + assert_eq!(variants.pop_first(), Some(CommonModelType::NanoBanana)); + assert_eq!(variants.pop_first(), Some(CommonModelType::NanoBanana2)); + assert_eq!(variants.pop_first(), Some(CommonModelType::NanoBananaPro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedream4)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedream4p5)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedream5Lite)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedream5p0Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedream5p0ProUltra)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Midjourney)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV6)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV6p1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV6p1Raw)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV7)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV7Draft)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV7DraftRaw)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MidjourneyV7Raw)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Midjourney7)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Midjourney7Niji)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Midjourney8)); + // Video models + assert_eq!(variants.pop_first(), Some(CommonModelType::GrokVideo)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GrokImagineVideo)); + assert_eq!(variants.pop_first(), Some(CommonModelType::GrokImagineVideo1p5)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling16Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling21Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling21Master)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling2p5TurboPro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling2p6Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling3p0Standard)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Kling3p0Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::HappyHorse1p0)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance10Lite)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance10Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance1p5Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0Fast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0BytePlus)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0BytePlusFast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0Ultra)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0UltraFast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0BytePlusUltra)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0BytePlusUltraFast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0Mini)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0BytePlusMini)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Seedance2p0BytePlusUltraMini)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Sora2)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Sora2Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Veo2)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Veo3)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Veo3Fast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Veo3p1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Veo3p1Fast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Veo3p1Lite)); + assert_eq!(variants.pop_first(), Some(CommonModelType::ViduQ3)); + assert_eq!(variants.pop_first(), Some(CommonModelType::ViduQ3Turbo)); + // Audio models + assert_eq!(variants.pop_first(), Some(CommonModelType::SunoMusic)); + assert_eq!(variants.pop_first(), Some(CommonModelType::SunoRemix)); + assert_eq!(variants.pop_first(), Some(CommonModelType::SunoSounds)); + assert_eq!(variants.pop_first(), Some(CommonModelType::SunoSample)); + assert_eq!(variants.pop_first(), Some(CommonModelType::SeedAudio1p0)); + assert_eq!(variants.pop_first(), Some(CommonModelType::PreviewModel)); + assert_eq!(variants.pop_first(), Some(CommonModelType::PreviewModelFast)); + assert_eq!(variants.pop_first(), Some(CommonModelType::SwitchX)); + // 3D Object generation models + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d2_0)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d2_1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d3)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d3_1Pro)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d3_1Rapid)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d3_1Part)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Hunyuan3d3_1SmartTopology)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Tripo3dH3_1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::MeshyV6)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Rodin2_5Fast)); + // Splat generation models (World Labs) + assert_eq!(variants.pop_first(), Some(CommonModelType::Marble0p1Mini)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Marble0p1Plus)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Marble1p0)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Marble1p0Draft)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Marble1p1)); + assert_eq!(variants.pop_first(), Some(CommonModelType::Marble1p1Plus)); + assert_eq!(variants.pop_first(), Some(CommonModelType::TripoSplat)); + + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonModelType::all_variants().len(), CommonModelType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonModelType::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, CommonModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonModelType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonModelType::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonModelType::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + + #[test] + fn every_variant_has_a_model_class() { + for variant in CommonModelType::all_variants() { + let class = variant.get_model_class(); + // Verify the class is a known value (not panicking is the main test) + assert!(CommonModelClass::all_variants().contains(&class), + "get_model_class() for {:?} returned {:?} which is not a known CommonModelClass variant", variant, class); + } + } + + #[test] + fn image_models_return_image_class() { + assert_eq!(CommonModelType::Flux1Dev.get_model_class(), CommonModelClass::Image); + assert_eq!(CommonModelType::GptImage1.get_model_class(), CommonModelClass::Image); + assert_eq!(CommonModelType::Midjourney.get_model_class(), CommonModelClass::Image); + } + + #[test] + fn video_models_return_video_class() { + assert_eq!(CommonModelType::Veo3.get_model_class(), CommonModelClass::Video); + assert_eq!(CommonModelType::Sora2.get_model_class(), CommonModelClass::Video); + assert_eq!(CommonModelType::Kling3p0Pro.get_model_class(), CommonModelClass::Video); + assert_eq!(CommonModelType::Seedance2p0Mini.get_model_class(), CommonModelClass::Video); + assert_eq!(CommonModelType::Seedance2p0BytePlusMini.get_model_class(), CommonModelClass::Video); + assert_eq!(CommonModelType::Seedance2p0BytePlusUltraMini.get_model_class(), CommonModelClass::Video); + } + + #[test] + fn dimensional_models_return_correct_class() { + assert_eq!(CommonModelType::Hunyuan3d2_0.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Hunyuan3d3.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Hunyuan3d3_1Pro.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Hunyuan3d3_1Rapid.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Hunyuan3d3_1Part.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Hunyuan3d3_1SmartTopology.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Tripo3dH3_1.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::MeshyV6.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Rodin2_5Fast.get_model_class(), CommonModelClass::DimensionalMesh); + assert_eq!(CommonModelType::Marble0p1Mini.get_model_class(), CommonModelClass::DimensionalSplat); + assert_eq!(CommonModelType::Marble0p1Plus.get_model_class(), CommonModelClass::DimensionalSplat); + assert_eq!(CommonModelType::Marble1p0.get_model_class(), CommonModelClass::DimensionalSplat); + assert_eq!(CommonModelType::Marble1p0Draft.get_model_class(), CommonModelClass::DimensionalSplat); + assert_eq!(CommonModelType::Marble1p1.get_model_class(), CommonModelClass::DimensionalSplat); + assert_eq!(CommonModelType::Marble1p1Plus.get_model_class(), CommonModelClass::DimensionalSplat); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_musical_key.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_musical_key.rs new file mode 100644 index 00000000..ac127d57 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_musical_key.rs @@ -0,0 +1,119 @@ + +/// Musical keys available for audio generation (eg. Suno Sounds). +/// +/// NB: There are intentionally no E keys, per product spec. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonMusicalKey { + /// Let the model pick the key. + #[serde(rename = "auto")] + Auto, + + #[serde(rename = "c_major")] + CMajor, + + #[serde(rename = "c_minor")] + CMinor, + + #[serde(rename = "d_major")] + DMajor, + + #[serde(rename = "d_minor")] + DMinor, + + #[serde(rename = "f_major")] + FMajor, + + #[serde(rename = "f_minor")] + FMinor, + + #[serde(rename = "g_major")] + GMajor, + + #[serde(rename = "g_minor")] + GMinor, + + #[serde(rename = "a_major")] + AMajor, + + #[serde(rename = "a_minor")] + AMinor, + + #[serde(rename = "b_major")] + BMajor, + + #[serde(rename = "b_minor")] + BMinor, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonMusicalKey::Auto, "auto"); + assert_serialization(CommonMusicalKey::CMajor, "c_major"); + assert_serialization(CommonMusicalKey::CMinor, "c_minor"); + assert_serialization(CommonMusicalKey::DMajor, "d_major"); + assert_serialization(CommonMusicalKey::DMinor, "d_minor"); + assert_serialization(CommonMusicalKey::FMajor, "f_major"); + assert_serialization(CommonMusicalKey::FMinor, "f_minor"); + assert_serialization(CommonMusicalKey::GMajor, "g_major"); + assert_serialization(CommonMusicalKey::GMinor, "g_minor"); + assert_serialization(CommonMusicalKey::AMajor, "a_major"); + assert_serialization(CommonMusicalKey::AMinor, "a_minor"); + assert_serialization(CommonMusicalKey::BMajor, "b_major"); + assert_serialization(CommonMusicalKey::BMinor, "b_minor"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("auto", CommonMusicalKey::Auto), + ("c_major", CommonMusicalKey::CMajor), + ("c_minor", CommonMusicalKey::CMinor), + ("d_major", CommonMusicalKey::DMajor), + ("d_minor", CommonMusicalKey::DMinor), + ("f_major", CommonMusicalKey::FMajor), + ("f_minor", CommonMusicalKey::FMinor), + ("g_major", CommonMusicalKey::GMajor), + ("g_minor", CommonMusicalKey::GMinor), + ("a_major", CommonMusicalKey::AMajor), + ("a_minor", CommonMusicalKey::AMinor), + ("b_major", CommonMusicalKey::BMajor), + ("b_minor", CommonMusicalKey::BMinor), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonMusicalKey = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [ + CommonMusicalKey::Auto, + CommonMusicalKey::CMajor, + CommonMusicalKey::CMinor, + CommonMusicalKey::DMajor, + CommonMusicalKey::DMinor, + CommonMusicalKey::FMajor, + CommonMusicalKey::FMinor, + CommonMusicalKey::GMajor, + CommonMusicalKey::GMinor, + CommonMusicalKey::AMajor, + CommonMusicalKey::AMinor, + CommonMusicalKey::BMajor, + CommonMusicalKey::BMinor, + ]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonMusicalKey = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_polygon_type.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_polygon_type.rs new file mode 100644 index 00000000..12ef0348 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_polygon_type.rs @@ -0,0 +1,50 @@ + +/// Polygon types for generated meshes. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonPolygonType { + #[serde(rename = "triangle")] + Triangle, + + #[serde(rename = "quad")] + Quad, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonPolygonType::Triangle, "triangle"); + assert_serialization(CommonPolygonType::Quad, "quad"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("triangle", CommonPolygonType::Triangle), + ("quad", CommonPolygonType::Quad), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonPolygonType = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [ + CommonPolygonType::Triangle, + CommonPolygonType::Quad, + ]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonPolygonType = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_quality.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_quality.rs new file mode 100644 index 00000000..74a1c86e --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_quality.rs @@ -0,0 +1,164 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +pub const MAX_LENGTH: usize = 16; + +/// Common quality levels for generation. +/// +/// NB: Keep the max serialized length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonQuality { + High, + Medium, + Low, +} + +impl_enum_display_and_debug_using_to_str!(CommonQuality); + +impl CommonQuality { + pub fn to_str(&self) -> &'static str { + match self { + Self::High => "high", + Self::Medium => "medium", + Self::Low => "low", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "high" => Ok(Self::High), + "medium" => Ok(Self::Medium), + "low" => Ok(Self::Low), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::High, + Self::Medium, + Self::Low, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_quality::CommonQuality; + use crate::enums::common::generation::common_quality::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(CommonQuality::High, "high"); + assert_serialization(CommonQuality::Medium, "medium"); + assert_serialization(CommonQuality::Low, "low"); + } + + #[test] + fn to_str() { + assert_eq!(CommonQuality::High.to_str(), "high"); + assert_eq!(CommonQuality::Medium.to_str(), "medium"); + assert_eq!(CommonQuality::Low.to_str(), "low"); + } + + #[test] + fn from_str() { + assert_eq!(CommonQuality::from_str("high").unwrap(), CommonQuality::High); + assert_eq!(CommonQuality::from_str("medium").unwrap(), CommonQuality::Medium); + assert_eq!(CommonQuality::from_str("low").unwrap(), CommonQuality::Low); + } + + #[test] + fn from_str_err() { + let result = CommonQuality::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = CommonQuality::all_variants(); + assert_eq!(variants.len(), 3); + assert_eq!(variants.pop_first(), Some(CommonQuality::High)); + assert_eq!(variants.pop_first(), Some(CommonQuality::Medium)); + assert_eq!(variants.pop_first(), Some(CommonQuality::Low)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonQuality::all_variants().len(), CommonQuality::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonQuality::all_variants() { + assert_eq!(variant, CommonQuality::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonQuality::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonQuality::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonQuality::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long via to_str()", variant); + } + for variant in CommonQuality::all_variants() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(json.len() <= MAX_LENGTH, "variant {:?} is too long via JSON: {:?}", variant, json); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonQuality::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonQuality::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_resolution.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_resolution.rs new file mode 100644 index 00000000..a17136f9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_resolution.rs @@ -0,0 +1,212 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +use crate::enums::error::enum_error::EnumError; + +/// Maximum serialized string length for database storage. +pub const MAX_LENGTH: usize = 16; + +/// Common resolutions for generation. +/// +/// NB: Keep the max serialized length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonResolution { + OneK, + TwoK, + ThreeK, + FourK, + + /// Used by Nano Banana 2 (and others) + HalfK, + + /// Used by the Seedance family (and others) + FourEightyP, + + /// Used by the Seedance family (and others) + SevenTwentyP, + + /// Used by the Seedance family (and others) + TenEightyP, +} + +impl_enum_display_and_debug_using_to_str!(CommonResolution); + +impl CommonResolution { + pub fn to_str(&self) -> &'static str { + match self { + Self::OneK => "one_k", + Self::TwoK => "two_k", + Self::ThreeK => "three_k", + Self::FourK => "four_k", + Self::HalfK => "half_k", + Self::FourEightyP => "four_eighty_p", + Self::SevenTwentyP => "seven_twenty_p", + Self::TenEightyP => "ten_eighty_p", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "one_k" => Ok(Self::OneK), + "two_k" => Ok(Self::TwoK), + "three_k" => Ok(Self::ThreeK), + "four_k" => Ok(Self::FourK), + "half_k" => Ok(Self::HalfK), + "four_eighty_p" => Ok(Self::FourEightyP), + "seven_twenty_p" => Ok(Self::SevenTwentyP), + "ten_eighty_p" => Ok(Self::TenEightyP), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::OneK, + Self::TwoK, + Self::ThreeK, + Self::FourK, + Self::HalfK, + Self::FourEightyP, + Self::SevenTwentyP, + Self::TenEightyP, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::common_resolution::CommonResolution; + use crate::enums::common::generation::common_resolution::MAX_LENGTH; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::error::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(CommonResolution::OneK, "one_k"); + assert_serialization(CommonResolution::TwoK, "two_k"); + assert_serialization(CommonResolution::ThreeK, "three_k"); + assert_serialization(CommonResolution::FourK, "four_k"); + assert_serialization(CommonResolution::HalfK, "half_k"); + assert_serialization(CommonResolution::FourEightyP, "four_eighty_p"); + assert_serialization(CommonResolution::SevenTwentyP, "seven_twenty_p"); + assert_serialization(CommonResolution::TenEightyP, "ten_eighty_p"); + } + + #[test] + fn to_str() { + assert_eq!(CommonResolution::OneK.to_str(), "one_k"); + assert_eq!(CommonResolution::TwoK.to_str(), "two_k"); + assert_eq!(CommonResolution::ThreeK.to_str(), "three_k"); + assert_eq!(CommonResolution::FourK.to_str(), "four_k"); + assert_eq!(CommonResolution::HalfK.to_str(), "half_k"); + assert_eq!(CommonResolution::FourEightyP.to_str(), "four_eighty_p"); + assert_eq!(CommonResolution::SevenTwentyP.to_str(), "seven_twenty_p"); + assert_eq!(CommonResolution::TenEightyP.to_str(), "ten_eighty_p"); + } + + #[test] + fn from_str() { + assert_eq!(CommonResolution::from_str("one_k").unwrap(), CommonResolution::OneK); + assert_eq!(CommonResolution::from_str("two_k").unwrap(), CommonResolution::TwoK); + assert_eq!(CommonResolution::from_str("three_k").unwrap(), CommonResolution::ThreeK); + assert_eq!(CommonResolution::from_str("four_k").unwrap(), CommonResolution::FourK); + assert_eq!(CommonResolution::from_str("half_k").unwrap(), CommonResolution::HalfK); + assert_eq!(CommonResolution::from_str("four_eighty_p").unwrap(), CommonResolution::FourEightyP); + assert_eq!(CommonResolution::from_str("seven_twenty_p").unwrap(), CommonResolution::SevenTwentyP); + assert_eq!(CommonResolution::from_str("ten_eighty_p").unwrap(), CommonResolution::TenEightyP); + } + + #[test] + fn from_str_err() { + let result = CommonResolution::from_str("invalid"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "invalid"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = CommonResolution::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(CommonResolution::OneK)); + assert_eq!(variants.pop_first(), Some(CommonResolution::TwoK)); + assert_eq!(variants.pop_first(), Some(CommonResolution::ThreeK)); + assert_eq!(variants.pop_first(), Some(CommonResolution::FourK)); + assert_eq!(variants.pop_first(), Some(CommonResolution::HalfK)); + assert_eq!(variants.pop_first(), Some(CommonResolution::FourEightyP)); + assert_eq!(variants.pop_first(), Some(CommonResolution::SevenTwentyP)); + assert_eq!(variants.pop_first(), Some(CommonResolution::TenEightyP)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(CommonResolution::all_variants().len(), CommonResolution::iter().len()); + } + + #[test] + fn round_trip() { + for variant in CommonResolution::all_variants() { + assert_eq!(variant, CommonResolution::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, CommonResolution::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, CommonResolution::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + for variant in CommonResolution::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long via to_str()", variant); + } + for variant in CommonResolution::all_variants() { + let json = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(json.len() <= MAX_LENGTH, "variant {:?} is too long via JSON: {:?}", variant, json); + } + } + + #[test] + fn serialized_names_must_not_contain_dots() { + for variant in CommonResolution::all_variants() { + let to_str_value = variant.to_str(); + assert!(!to_str_value.contains('.'), "to_str() for {:?} contains a dot: {:?}", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(!json_value.contains('.'), "JSON serialization for {:?} contains a dot: {:?}", variant, json_value); + } + } + + #[test] + fn serialized_names_must_only_contain_lowercase_alphanumeric_and_underscore() { + let valid_pattern = regex::Regex::new(r"^[a-z0-9_]+$").unwrap(); + + for variant in CommonResolution::all_variants() { + let to_str_value = variant.to_str(); + assert!(valid_pattern.is_match(to_str_value), + "to_str() for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, to_str_value); + + let json_value = serde_json::to_string(&variant).unwrap().replace('"', ""); + assert!(valid_pattern.is_match(&json_value), + "JSON serialization for {:?} contains invalid characters: {:?} (only a-z, 0-9, _ allowed)", variant, json_value); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_splat_model.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_splat_model.rs new file mode 100644 index 00000000..5061592d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_splat_model.rs @@ -0,0 +1,113 @@ + +/// Splat models available for generation. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonSplatModel { + #[serde(rename = "marble_0p1_mini")] + Marble0p1Mini, + + #[serde(rename = "marble_0p1_plus")] + Marble0p1Plus, + + #[serde(rename = "marble_1p0")] + Marble1p0, + + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + + #[serde(rename = "marble_1p1")] + Marble1p1, + + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + + /// TripoSplat: single-image to 3D Gaussian splat (via Fal). + #[serde(rename = "triposplat")] + TripoSplat, +} + +impl CommonSplatModel { + pub fn to_common_model_type(&self) -> crate::enums::common::generation::common_model_type::CommonModelType { + use crate::enums::common::generation::common_model_type::CommonModelType; + match self { + Self::Marble0p1Mini => CommonModelType::Marble0p1Mini, + Self::Marble0p1Plus => CommonModelType::Marble0p1Plus, + Self::Marble1p0 => CommonModelType::Marble1p0, + Self::Marble1p0Draft => CommonModelType::Marble1p0Draft, + Self::Marble1p1 => CommonModelType::Marble1p1, + Self::Marble1p1Plus => CommonModelType::Marble1p1Plus, + Self::TripoSplat => CommonModelType::TripoSplat, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonSplatModel::Marble0p1Mini, "marble_0p1_mini"); + assert_serialization(CommonSplatModel::Marble0p1Plus, "marble_0p1_plus"); + assert_serialization(CommonSplatModel::Marble1p0, "marble_1p0"); + assert_serialization(CommonSplatModel::Marble1p0Draft, "marble_1p0_draft"); + assert_serialization(CommonSplatModel::Marble1p1, "marble_1p1"); + assert_serialization(CommonSplatModel::Marble1p1Plus, "marble_1p1_plus"); + assert_serialization(CommonSplatModel::TripoSplat, "triposplat"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("marble_0p1_mini", CommonSplatModel::Marble0p1Mini), + ("marble_0p1_plus", CommonSplatModel::Marble0p1Plus), + ("marble_1p0", CommonSplatModel::Marble1p0), + ("marble_1p0_draft", CommonSplatModel::Marble1p0Draft), + ("marble_1p1", CommonSplatModel::Marble1p1), + ("marble_1p1_plus", CommonSplatModel::Marble1p1Plus), + ("triposplat", CommonSplatModel::TripoSplat), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonSplatModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [ + CommonSplatModel::Marble0p1Mini, + CommonSplatModel::Marble0p1Plus, + CommonSplatModel::Marble1p0, + CommonSplatModel::Marble1p0Draft, + CommonSplatModel::Marble1p1, + CommonSplatModel::Marble1p1Plus, + CommonSplatModel::TripoSplat, + ]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonSplatModel = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } + + #[test] + fn all_splat_models_convert_to_common_model_type() { + let models = [ + (CommonSplatModel::Marble0p1Mini, CommonModelType::Marble0p1Mini), + (CommonSplatModel::Marble0p1Plus, CommonModelType::Marble0p1Plus), + (CommonSplatModel::Marble1p0, CommonModelType::Marble1p0), + (CommonSplatModel::Marble1p0Draft, CommonModelType::Marble1p0Draft), + (CommonSplatModel::Marble1p1, CommonModelType::Marble1p1), + (CommonSplatModel::Marble1p1Plus, CommonModelType::Marble1p1Plus), + (CommonSplatModel::TripoSplat, CommonModelType::TripoSplat), + ]; + for (splat_model, expected) in models { + assert_eq!(splat_model.to_common_model_type(), expected); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/common_video_model.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/common_video_model.rs new file mode 100644 index 00000000..334cfc70 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/common_video_model.rs @@ -0,0 +1,352 @@ + +/// Video models available for generation. +/// Mirrors artcraft_router::api::router_video_model::RouterVideoModel. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonVideoModel { + /// NB: This was for the web login version + #[deprecated = "Use `GrokImagineVideo` instead."] + #[serde(rename = "grok_video")] + GrokVideo, + + /// NB: This is for the API version + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + + #[serde(rename = "kling_2p1_master")] + Kling21Master, + + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + + #[serde(rename = "seedance_2p0")] + Seedance2p0, + + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + + #[serde(rename = "seedance_2p0_bp_mini")] + Seedance2p0BytePlusMini, + + #[serde(rename = "seedance_2p0_bpu_mini")] + Seedance2p0BytePlusUltraMini, + + #[serde(rename = "sora_2")] + Sora2, + + #[serde(rename = "sora_2_pro")] + Sora2Pro, + + #[serde(rename = "veo_2")] + Veo2, + + #[serde(rename = "veo_3")] + Veo3, + + #[serde(rename = "veo_3_fast")] + Veo3Fast, + + #[serde(rename = "veo_3p1")] + Veo3p1, + + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + + #[serde(rename = "vidu_q3")] + ViduQ3, + + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, + + // NB: Temporary model rollout. Previously used for "Seedance 2.0 BytePlus". + // This can be reused in the future. + #[serde(rename = "preview_model")] + PreviewModel, + + // NB: Temporary model rollout. Previously used for "Seedance 2.0 BytePlus Fast". + // This can be reused in the future. + #[serde(rename = "preview_model_fast")] + PreviewModelFast, +} + +impl CommonVideoModel { + pub fn to_common_model_type(&self) -> crate::enums::common::generation::common_model_type::CommonModelType { + use crate::enums::common::generation::common_model_type::CommonModelType; + match self { + Self::GrokVideo => CommonModelType::GrokVideo, + Self::GrokImagineVideo => CommonModelType::GrokImagineVideo, + Self::GrokImagineVideo1p5 => CommonModelType::GrokImagineVideo1p5, + Self::Kling16Pro => CommonModelType::Kling16Pro, + Self::Kling21Pro => CommonModelType::Kling21Pro, + Self::Kling21Master => CommonModelType::Kling21Master, + Self::Kling2p5TurboPro => CommonModelType::Kling2p5TurboPro, + Self::Kling2p6Pro => CommonModelType::Kling2p6Pro, + Self::Kling3p0Standard => CommonModelType::Kling3p0Standard, + Self::Kling3p0Pro => CommonModelType::Kling3p0Pro, + Self::HappyHorse1p0 => CommonModelType::HappyHorse1p0, + Self::Seedance10Lite => CommonModelType::Seedance10Lite, + Self::Seedance1p5Pro => CommonModelType::Seedance1p5Pro, + Self::Seedance2p0 => CommonModelType::Seedance2p0, + Self::Seedance2p0Fast => CommonModelType::Seedance2p0Fast, + Self::Seedance2p0BytePlus => CommonModelType::Seedance2p0BytePlus, + Self::Seedance2p0BytePlusFast => CommonModelType::Seedance2p0BytePlusFast, + Self::Seedance2p0Ultra => CommonModelType::Seedance2p0Ultra, + Self::Seedance2p0UltraFast => CommonModelType::Seedance2p0UltraFast, + Self::Seedance2p0BytePlusUltra => CommonModelType::Seedance2p0BytePlusUltra, + Self::Seedance2p0BytePlusUltraFast => CommonModelType::Seedance2p0BytePlusUltraFast, + Self::Seedance2p0Mini => CommonModelType::Seedance2p0Mini, + Self::Seedance2p0BytePlusMini => CommonModelType::Seedance2p0BytePlusMini, + Self::Seedance2p0BytePlusUltraMini => CommonModelType::Seedance2p0BytePlusUltraMini, + Self::Sora2 => CommonModelType::Sora2, + Self::Sora2Pro => CommonModelType::Sora2Pro, + Self::Veo2 => CommonModelType::Veo2, + Self::Veo3 => CommonModelType::Veo3, + Self::Veo3Fast => CommonModelType::Veo3Fast, + Self::Veo3p1 => CommonModelType::Veo3p1, + Self::Veo3p1Fast => CommonModelType::Veo3p1Fast, + Self::Veo3p1Lite => CommonModelType::Veo3p1Lite, + Self::ViduQ3 => CommonModelType::ViduQ3, + Self::ViduQ3Turbo => CommonModelType::ViduQ3Turbo, + Self::PreviewModel => CommonModelType::PreviewModel, + Self::PreviewModelFast => CommonModelType::PreviewModelFast, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::enums::common::generation::common_model_type::CommonModelType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(CommonVideoModel::GrokVideo, "grok_video"); + assert_serialization(CommonVideoModel::GrokImagineVideo, "grok_imagine_video"); + assert_serialization(CommonVideoModel::GrokImagineVideo1p5, "grok_imagine_video_1p5"); + assert_serialization(CommonVideoModel::Kling16Pro, "kling_1p6_pro"); + assert_serialization(CommonVideoModel::Kling21Pro, "kling_2p1_pro"); + assert_serialization(CommonVideoModel::Kling21Master, "kling_2p1_master"); + assert_serialization(CommonVideoModel::Kling2p5TurboPro, "kling_2p5_turbo_pro"); + assert_serialization(CommonVideoModel::Kling2p6Pro, "kling_2p6_pro"); + assert_serialization(CommonVideoModel::Kling3p0Standard, "kling_3p0_standard"); + assert_serialization(CommonVideoModel::Kling3p0Pro, "kling_3p0_pro"); + assert_serialization(CommonVideoModel::HappyHorse1p0, "happy_horse_1p0"); + assert_serialization(CommonVideoModel::Seedance10Lite, "seedance_1p0_lite"); + assert_serialization(CommonVideoModel::Seedance1p5Pro, "seedance_1p5_pro"); + assert_serialization(CommonVideoModel::Seedance2p0, "seedance_2p0"); + assert_serialization(CommonVideoModel::Seedance2p0Fast, "seedance_2p0_fast"); + assert_serialization(CommonVideoModel::Seedance2p0BytePlus, "seedance_2p0_bp"); + assert_serialization(CommonVideoModel::Seedance2p0BytePlusFast, "seedance_2p0_bp_fast"); + assert_serialization(CommonVideoModel::Seedance2p0Ultra, "seedance_2p0_u"); + assert_serialization(CommonVideoModel::Seedance2p0UltraFast, "seedance_2p0_u_fast"); + assert_serialization(CommonVideoModel::Seedance2p0BytePlusUltra, "seedance_2p0_bpu"); + assert_serialization(CommonVideoModel::Seedance2p0BytePlusUltraFast, "seedance_2p0_bpu_fast"); + assert_serialization(CommonVideoModel::Seedance2p0Mini, "seedance_2p0_mini"); + assert_serialization(CommonVideoModel::Seedance2p0BytePlusMini, "seedance_2p0_bp_mini"); + assert_serialization(CommonVideoModel::Seedance2p0BytePlusUltraMini, "seedance_2p0_bpu_mini"); + assert_serialization(CommonVideoModel::Sora2, "sora_2"); + assert_serialization(CommonVideoModel::Sora2Pro, "sora_2_pro"); + assert_serialization(CommonVideoModel::Veo2, "veo_2"); + assert_serialization(CommonVideoModel::Veo3, "veo_3"); + assert_serialization(CommonVideoModel::Veo3Fast, "veo_3_fast"); + assert_serialization(CommonVideoModel::Veo3p1, "veo_3p1"); + assert_serialization(CommonVideoModel::Veo3p1Fast, "veo_3p1_fast"); + assert_serialization(CommonVideoModel::Veo3p1Lite, "veo_3p1_lite"); + assert_serialization(CommonVideoModel::ViduQ3, "vidu_q3"); + assert_serialization(CommonVideoModel::ViduQ3Turbo, "vidu_q3_turbo"); + assert_serialization(CommonVideoModel::PreviewModel, "preview_model"); + assert_serialization(CommonVideoModel::PreviewModelFast, "preview_model_fast"); + } + + #[test] + fn test_deserialization() { + let cases = [ + ("grok_video", CommonVideoModel::GrokVideo), + ("grok_imagine_video", CommonVideoModel::GrokImagineVideo), + ("grok_imagine_video_1p5", CommonVideoModel::GrokImagineVideo1p5), + ("kling_1p6_pro", CommonVideoModel::Kling16Pro), + ("kling_2p1_pro", CommonVideoModel::Kling21Pro), + ("kling_2p1_master", CommonVideoModel::Kling21Master), + ("kling_2p5_turbo_pro", CommonVideoModel::Kling2p5TurboPro), + ("kling_2p6_pro", CommonVideoModel::Kling2p6Pro), + ("kling_3p0_standard", CommonVideoModel::Kling3p0Standard), + ("kling_3p0_pro", CommonVideoModel::Kling3p0Pro), + ("happy_horse_1p0", CommonVideoModel::HappyHorse1p0), + ("seedance_1p0_lite", CommonVideoModel::Seedance10Lite), + ("seedance_1p5_pro", CommonVideoModel::Seedance1p5Pro), + ("seedance_2p0", CommonVideoModel::Seedance2p0), + ("seedance_2p0_fast", CommonVideoModel::Seedance2p0Fast), + ("seedance_2p0_bp", CommonVideoModel::Seedance2p0BytePlus), + ("seedance_2p0_bp_fast", CommonVideoModel::Seedance2p0BytePlusFast), + ("seedance_2p0_u", CommonVideoModel::Seedance2p0Ultra), + ("seedance_2p0_u_fast", CommonVideoModel::Seedance2p0UltraFast), + ("seedance_2p0_bpu", CommonVideoModel::Seedance2p0BytePlusUltra), + ("seedance_2p0_bpu_fast", CommonVideoModel::Seedance2p0BytePlusUltraFast), + ("seedance_2p0_mini", CommonVideoModel::Seedance2p0Mini), + ("seedance_2p0_bp_mini", CommonVideoModel::Seedance2p0BytePlusMini), + ("seedance_2p0_bpu_mini", CommonVideoModel::Seedance2p0BytePlusUltraMini), + ("sora_2", CommonVideoModel::Sora2), + ("sora_2_pro", CommonVideoModel::Sora2Pro), + ("veo_2", CommonVideoModel::Veo2), + ("veo_3", CommonVideoModel::Veo3), + ("veo_3_fast", CommonVideoModel::Veo3Fast), + ("veo_3p1", CommonVideoModel::Veo3p1), + ("veo_3p1_fast", CommonVideoModel::Veo3p1Fast), + ("veo_3p1_lite", CommonVideoModel::Veo3p1Lite), + ("vidu_q3", CommonVideoModel::ViduQ3), + ("vidu_q3_turbo", CommonVideoModel::ViduQ3Turbo), + ("preview_model", CommonVideoModel::PreviewModel), + ("preview_model_fast", CommonVideoModel::PreviewModelFast), + ]; + for (json_str, expected) in cases { + let json = format!("\"{}\"", json_str); + let deserialized: CommonVideoModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to deserialize {:?}: {}", json_str, e)); + assert_eq!(deserialized, expected, "Failed for {:?}", json_str); + } + } + + #[test] + fn test_round_trip() { + let all = [ + CommonVideoModel::GrokVideo, + CommonVideoModel::GrokImagineVideo, + CommonVideoModel::GrokImagineVideo1p5, + CommonVideoModel::Kling16Pro, + CommonVideoModel::Kling21Pro, + CommonVideoModel::Kling21Master, + CommonVideoModel::Kling2p5TurboPro, + CommonVideoModel::Kling2p6Pro, + CommonVideoModel::Kling3p0Standard, + CommonVideoModel::Kling3p0Pro, + CommonVideoModel::HappyHorse1p0, + CommonVideoModel::Seedance10Lite, + CommonVideoModel::Seedance1p5Pro, + CommonVideoModel::Seedance2p0, + CommonVideoModel::Seedance2p0Fast, + CommonVideoModel::Seedance2p0BytePlus, + CommonVideoModel::Seedance2p0BytePlusFast, + CommonVideoModel::Seedance2p0Ultra, + CommonVideoModel::Seedance2p0UltraFast, + CommonVideoModel::Seedance2p0BytePlusUltra, + CommonVideoModel::Seedance2p0BytePlusUltraFast, + CommonVideoModel::Seedance2p0Mini, + CommonVideoModel::Seedance2p0BytePlusMini, + CommonVideoModel::Seedance2p0BytePlusUltraMini, + CommonVideoModel::Sora2, + CommonVideoModel::Sora2Pro, + CommonVideoModel::Veo2, + CommonVideoModel::Veo3, + CommonVideoModel::Veo3Fast, + CommonVideoModel::Veo3p1, + CommonVideoModel::Veo3p1Fast, + CommonVideoModel::Veo3p1Lite, + CommonVideoModel::ViduQ3, + CommonVideoModel::ViduQ3Turbo, + CommonVideoModel::PreviewModel, + CommonVideoModel::PreviewModelFast, + ]; + for variant in all { + let json = serde_json::to_string(&variant).unwrap(); + let deserialized: CommonVideoModel = serde_json::from_str(&json).unwrap(); + assert_eq!(variant, deserialized, "Round-trip failed for {:?}", variant); + } + } + + #[test] + fn all_video_models_convert_to_common_model_type() { + let models = [ + (CommonVideoModel::GrokVideo, CommonModelType::GrokVideo), + (CommonVideoModel::GrokImagineVideo, CommonModelType::GrokImagineVideo), + (CommonVideoModel::GrokImagineVideo1p5, CommonModelType::GrokImagineVideo1p5), + (CommonVideoModel::Kling16Pro, CommonModelType::Kling16Pro), + (CommonVideoModel::Kling21Pro, CommonModelType::Kling21Pro), + (CommonVideoModel::Kling21Master, CommonModelType::Kling21Master), + (CommonVideoModel::Kling2p5TurboPro, CommonModelType::Kling2p5TurboPro), + (CommonVideoModel::Kling2p6Pro, CommonModelType::Kling2p6Pro), + (CommonVideoModel::Kling3p0Standard, CommonModelType::Kling3p0Standard), + (CommonVideoModel::Kling3p0Pro, CommonModelType::Kling3p0Pro), + (CommonVideoModel::HappyHorse1p0, CommonModelType::HappyHorse1p0), + (CommonVideoModel::Seedance10Lite, CommonModelType::Seedance10Lite), + (CommonVideoModel::Seedance1p5Pro, CommonModelType::Seedance1p5Pro), + (CommonVideoModel::Seedance2p0, CommonModelType::Seedance2p0), + (CommonVideoModel::Seedance2p0Fast, CommonModelType::Seedance2p0Fast), + (CommonVideoModel::Seedance2p0BytePlus, CommonModelType::Seedance2p0BytePlus), + (CommonVideoModel::Seedance2p0BytePlusFast, CommonModelType::Seedance2p0BytePlusFast), + (CommonVideoModel::Seedance2p0Ultra, CommonModelType::Seedance2p0Ultra), + (CommonVideoModel::Seedance2p0UltraFast, CommonModelType::Seedance2p0UltraFast), + (CommonVideoModel::Seedance2p0BytePlusUltra, CommonModelType::Seedance2p0BytePlusUltra), + (CommonVideoModel::Seedance2p0BytePlusUltraFast, CommonModelType::Seedance2p0BytePlusUltraFast), + (CommonVideoModel::Seedance2p0Mini, CommonModelType::Seedance2p0Mini), + (CommonVideoModel::Seedance2p0BytePlusMini, CommonModelType::Seedance2p0BytePlusMini), + (CommonVideoModel::Seedance2p0BytePlusUltraMini, CommonModelType::Seedance2p0BytePlusUltraMini), + (CommonVideoModel::Sora2, CommonModelType::Sora2), + (CommonVideoModel::Sora2Pro, CommonModelType::Sora2Pro), + (CommonVideoModel::Veo2, CommonModelType::Veo2), + (CommonVideoModel::Veo3, CommonModelType::Veo3), + (CommonVideoModel::Veo3Fast, CommonModelType::Veo3Fast), + (CommonVideoModel::Veo3p1, CommonModelType::Veo3p1), + (CommonVideoModel::Veo3p1Fast, CommonModelType::Veo3p1Fast), + (CommonVideoModel::Veo3p1Lite, CommonModelType::Veo3p1Lite), + (CommonVideoModel::ViduQ3, CommonModelType::ViduQ3), + (CommonVideoModel::ViduQ3Turbo, CommonModelType::ViduQ3Turbo), + (CommonVideoModel::PreviewModel, CommonModelType::PreviewModel), + (CommonVideoModel::PreviewModelFast, CommonModelType::PreviewModelFast), + ]; + for (video_model, expected) in models { + assert_eq!(video_model.to_common_model_type(), expected); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/mod.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/mod.rs new file mode 100644 index 00000000..d8a346ed --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/mod.rs @@ -0,0 +1,17 @@ +pub mod common_aspect_ratio; +pub mod common_audio_model; +pub mod common_bitrate; +pub mod common_generation_mode; +pub mod common_image_model; +pub mod common_mesh_model; +pub mod common_mesh_output_type; +pub mod common_mesh_quality; +pub mod common_musical_key; +pub mod common_polygon_type; +pub mod common_quality; +pub mod common_model_class; +pub mod common_model_type; +pub mod model_creator; +pub mod common_resolution; +pub mod common_splat_model; +pub mod common_video_model; diff --git a/crates/api_clients/artcraft_client/src/enums/common/generation/model_creator.rs b/crates/api_clients/artcraft_client/src/enums/common/generation/model_creator.rs new file mode 100644 index 00000000..0183dba8 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/generation/model_creator.rs @@ -0,0 +1,307 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// The company or organization that created a model. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +pub enum ModelCreator { + #[serde(rename = "alibaba")] + Alibaba, + #[serde(rename = "artcraft")] + ArtCraft, + #[serde(rename = "black_forest_labs")] + BlackForestLabs, + #[serde(rename = "bytedance")] + Bytedance, + #[serde(rename = "deemos")] + Deemos, + #[serde(rename = "fal")] + Fal, + #[serde(rename = "google")] + Google, + #[serde(rename = "grok")] + Grok, + #[serde(rename = "hailuo")] + Hailuo, + #[serde(rename = "higgsfield")] + Higgsfield, + #[serde(rename = "kling")] + Kling, + #[serde(rename = "krea")] + Krea, + #[serde(rename = "meshy")] + Meshy, + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "open_ai")] + OpenAi, + #[serde(rename = "open_art")] + OpenArt, + #[serde(rename = "recraft")] + Recraft, + #[serde(rename = "replicate")] + Replicate, + #[serde(rename = "runway")] + Runway, + #[serde(rename = "stability")] + Stability, + #[serde(rename = "suno")] + Suno, + #[serde(rename = "tencent")] + Tencent, + #[serde(rename = "tensor_art")] + TensorArt, + #[serde(rename = "tripo")] + Tripo, + #[serde(rename = "vidu")] + Vidu, + #[serde(rename = "world_labs")] + WorldLabs, +} + +impl ModelCreator { + /// Returns the properly formatted human-readable name. + pub fn get_name(&self) -> &'static str { + match self { + Self::Alibaba => "Alibaba", + Self::ArtCraft => "ArtCraft", + Self::BlackForestLabs => "Black Forest Labs", + Self::Bytedance => "ByteDance", + Self::Deemos => "Deemos", + Self::Fal => "fal", + Self::Google => "Google", + Self::Grok => "Grok", + Self::Hailuo => "Hailuo", + Self::Higgsfield => "Higgsfield", + Self::Kling => "Kling", + Self::Krea => "Krea", + Self::Meshy => "Meshy", + Self::Midjourney => "Midjourney", + Self::OpenAi => "OpenAI", + Self::OpenArt => "OpenArt", + Self::Recraft => "Recraft", + Self::Replicate => "Replicate", + Self::Runway => "Runway", + Self::Stability => "Stability AI", + Self::Suno => "Suno", + Self::Tencent => "Tencent", + Self::TensorArt => "TensorArt", + Self::Tripo => "Tripo", + Self::Vidu => "Vidu", + Self::WorldLabs => "World Labs", + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::Alibaba => "alibaba", + Self::ArtCraft => "artcraft", + Self::BlackForestLabs => "black_forest_labs", + Self::Bytedance => "bytedance", + Self::Deemos => "deemos", + Self::Fal => "fal", + Self::Google => "google", + Self::Grok => "grok", + Self::Hailuo => "hailuo", + Self::Higgsfield => "higgsfield", + Self::Kling => "kling", + Self::Krea => "krea", + Self::Meshy => "meshy", + Self::Midjourney => "midjourney", + Self::OpenAi => "open_ai", + Self::OpenArt => "open_art", + Self::Recraft => "recraft", + Self::Replicate => "replicate", + Self::Runway => "runway", + Self::Stability => "stability", + Self::Suno => "suno", + Self::Tencent => "tencent", + Self::TensorArt => "tensor_art", + Self::Tripo => "tripo", + Self::Vidu => "vidu", + Self::WorldLabs => "world_labs", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "alibaba" => Ok(Self::Alibaba), + "artcraft" => Ok(Self::ArtCraft), + "black_forest_labs" => Ok(Self::BlackForestLabs), + "bytedance" => Ok(Self::Bytedance), + "deemos" => Ok(Self::Deemos), + "fal" => Ok(Self::Fal), + "google" => Ok(Self::Google), + "grok" => Ok(Self::Grok), + "hailuo" => Ok(Self::Hailuo), + "higgsfield" => Ok(Self::Higgsfield), + "kling" => Ok(Self::Kling), + "krea" => Ok(Self::Krea), + "meshy" => Ok(Self::Meshy), + "midjourney" => Ok(Self::Midjourney), + "open_ai" => Ok(Self::OpenAi), + "open_art" => Ok(Self::OpenArt), + "recraft" => Ok(Self::Recraft), + "replicate" => Ok(Self::Replicate), + "runway" => Ok(Self::Runway), + "stability" => Ok(Self::Stability), + "suno" => Ok(Self::Suno), + "tencent" => Ok(Self::Tencent), + "tensor_art" => Ok(Self::TensorArt), + "tripo" => Ok(Self::Tripo), + "vidu" => Ok(Self::Vidu), + "world_labs" => Ok(Self::WorldLabs), + _ => Err(format!("invalid ModelCreator value: {:?}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Alibaba, + Self::ArtCraft, + Self::BlackForestLabs, + Self::Bytedance, + Self::Deemos, + Self::Fal, + Self::Google, + Self::Grok, + Self::Hailuo, + Self::Higgsfield, + Self::Kling, + Self::Krea, + Self::Meshy, + Self::Midjourney, + Self::OpenAi, + Self::OpenArt, + Self::Recraft, + Self::Replicate, + Self::Runway, + Self::Stability, + Self::Suno, + Self::Tencent, + Self::TensorArt, + Self::Tripo, + Self::Vidu, + Self::WorldLabs, + ]) + } +} + +impl_enum_display_and_debug_using_to_str!(ModelCreator); + +#[cfg(test)] +mod tests { + use crate::enums::common::generation::model_creator::ModelCreator; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ModelCreator::Alibaba, "alibaba"); + assert_serialization(ModelCreator::ArtCraft, "artcraft"); + assert_serialization(ModelCreator::BlackForestLabs, "black_forest_labs"); + assert_serialization(ModelCreator::Bytedance, "bytedance"); + assert_serialization(ModelCreator::Fal, "fal"); + assert_serialization(ModelCreator::Google, "google"); + assert_serialization(ModelCreator::Grok, "grok"); + assert_serialization(ModelCreator::Hailuo, "hailuo"); + assert_serialization(ModelCreator::Higgsfield, "higgsfield"); + assert_serialization(ModelCreator::Kling, "kling"); + assert_serialization(ModelCreator::Krea, "krea"); + assert_serialization(ModelCreator::Midjourney, "midjourney"); + assert_serialization(ModelCreator::OpenAi, "open_ai"); + assert_serialization(ModelCreator::OpenArt, "open_art"); + assert_serialization(ModelCreator::Recraft, "recraft"); + assert_serialization(ModelCreator::Replicate, "replicate"); + assert_serialization(ModelCreator::Runway, "runway"); + assert_serialization(ModelCreator::Stability, "stability"); + assert_serialization(ModelCreator::Suno, "suno"); + assert_serialization(ModelCreator::Tencent, "tencent"); + assert_serialization(ModelCreator::TensorArt, "tensor_art"); + assert_serialization(ModelCreator::Vidu, "vidu"); + assert_serialization(ModelCreator::WorldLabs, "world_labs"); + } + + #[test] + fn to_str() { + assert_eq!(ModelCreator::Alibaba.to_str(), "alibaba"); + assert_eq!(ModelCreator::ArtCraft.to_str(), "artcraft"); + assert_eq!(ModelCreator::BlackForestLabs.to_str(), "black_forest_labs"); + assert_eq!(ModelCreator::OpenAi.to_str(), "open_ai"); + assert_eq!(ModelCreator::Suno.to_str(), "suno"); + assert_eq!(ModelCreator::WorldLabs.to_str(), "world_labs"); + } + + #[test] + fn from_str() { + assert_eq!(ModelCreator::from_str("alibaba").unwrap(), ModelCreator::Alibaba); + assert_eq!(ModelCreator::from_str("artcraft").unwrap(), ModelCreator::ArtCraft); + assert_eq!(ModelCreator::from_str("black_forest_labs").unwrap(), ModelCreator::BlackForestLabs); + assert_eq!(ModelCreator::from_str("open_ai").unwrap(), ModelCreator::OpenAi); + assert_eq!(ModelCreator::from_str("suno").unwrap(), ModelCreator::Suno); + assert_eq!(ModelCreator::from_str("world_labs").unwrap(), ModelCreator::WorldLabs); + assert!(ModelCreator::from_str("invalid").is_err()); + } + + #[test] + fn get_name() { + assert_eq!(ModelCreator::Alibaba.get_name(), "Alibaba"); + assert_eq!(ModelCreator::ArtCraft.get_name(), "ArtCraft"); + assert_eq!(ModelCreator::BlackForestLabs.get_name(), "Black Forest Labs"); + assert_eq!(ModelCreator::Bytedance.get_name(), "ByteDance"); + assert_eq!(ModelCreator::Fal.get_name(), "fal"); + assert_eq!(ModelCreator::Google.get_name(), "Google"); + assert_eq!(ModelCreator::OpenAi.get_name(), "OpenAI"); + assert_eq!(ModelCreator::Stability.get_name(), "Stability AI"); + assert_eq!(ModelCreator::Suno.get_name(), "Suno"); + assert_eq!(ModelCreator::WorldLabs.get_name(), "World Labs"); + } + + #[test] + fn all_variants() { + const EXPECTED_COUNT: usize = 26; + assert_eq!(ModelCreator::all_variants().len(), EXPECTED_COUNT); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(ModelCreator::all_variants().len(), ModelCreator::iter().len()); + } + + #[test] + fn round_trip() { + for variant in ModelCreator::all_variants() { + assert_eq!(variant, ModelCreator::from_str(variant.to_str()).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH: usize = 32; + for variant in ModelCreator::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty()); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long for VARCHAR({})", variant, MAX_LENGTH); + } + } + + #[test] + fn every_variant_has_a_human_name() { + for variant in ModelCreator::all_variants() { + let name = variant.get_name(); + assert!(!name.is_empty(), "variant {:?} has empty name", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/job_status.rs b/crates/api_clients/artcraft_client/src/enums/common/job_status.rs new file mode 100644 index 00000000..212395ae --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/job_status.rs @@ -0,0 +1,146 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// This is used in nearly every job system as an actual MySQL ENUM value: +/// +/// - tts_download_job +/// - tts_inference_job +/// - w2l_download_job +/// - w2l_inference_job +/// - generic_download_job +/// - (NOT generic_inference_job, which uses JobStatusPlus) +/// +/// See the documentation on the table for usage. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. + +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[serde(rename_all = "snake_case")] +pub enum JobStatus { + Pending, + Started, + CompleteSuccess, + CompleteFailure, + AttemptFailed, + Dead, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(JobStatus); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl JobStatus { + pub fn to_str(&self) -> &'static str { + match self { + Self::Pending => "pending", + Self::Started => "started", + Self::CompleteSuccess => "complete_success", + Self::CompleteFailure => "complete_failure", + Self::AttemptFailed => "attempt_failed", + Self::Dead => "dead", + } + } + + pub fn from_str(job_status: &str) -> Result { + match job_status { + "pending" => Ok(Self::Pending), + "started" => Ok(Self::Started), + "complete_success" => Ok(Self::CompleteSuccess), + "complete_failure" => Ok(Self::CompleteFailure), + "attempt_failed" => Ok(Self::AttemptFailed), + "dead" => Ok(Self::Dead), + _ => Err(format!("invalid job_status: {:?}", job_status)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Pending, + Self::Started, + Self::CompleteSuccess, + Self::CompleteFailure, + Self::AttemptFailed, + Self::Dead, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::job_status::JobStatus; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(JobStatus::Pending, "pending"); + assert_serialization(JobStatus::Started, "started"); + assert_serialization(JobStatus::CompleteSuccess, "complete_success"); + assert_serialization(JobStatus::CompleteFailure, "complete_failure"); + assert_serialization(JobStatus::AttemptFailed, "attempt_failed"); + assert_serialization(JobStatus::Dead, "dead"); + } + + #[test] + fn to_str() { + assert_eq!(JobStatus::Pending.to_str(), "pending"); + assert_eq!(JobStatus::Started.to_str(), "started"); + assert_eq!(JobStatus::CompleteSuccess.to_str(), "complete_success"); + assert_eq!(JobStatus::CompleteFailure.to_str(), "complete_failure"); + assert_eq!(JobStatus::AttemptFailed.to_str(), "attempt_failed"); + assert_eq!(JobStatus::Dead.to_str(), "dead"); + } + + #[test] + fn from_str() { + assert_eq!(JobStatus::from_str("pending").unwrap(), JobStatus::Pending); + assert_eq!(JobStatus::from_str("started").unwrap(), JobStatus::Started); + assert_eq!(JobStatus::from_str("complete_success").unwrap(), JobStatus::CompleteSuccess); + assert_eq!(JobStatus::from_str("complete_failure").unwrap(), JobStatus::CompleteFailure); + assert_eq!(JobStatus::from_str("attempt_failed").unwrap(), JobStatus::AttemptFailed); + assert_eq!(JobStatus::from_str("dead").unwrap(), JobStatus::Dead); + } + + #[test] + fn all_variants() { + let mut variants = JobStatus::all_variants(); + assert_eq!(variants.len(), 6); + assert_eq!(variants.pop_first(), Some(JobStatus::Pending)); + assert_eq!(variants.pop_first(), Some(JobStatus::Started)); + assert_eq!(variants.pop_first(), Some(JobStatus::CompleteSuccess)); + assert_eq!(variants.pop_first(), Some(JobStatus::CompleteFailure)); + assert_eq!(variants.pop_first(), Some(JobStatus::AttemptFailed)); + assert_eq!(variants.pop_first(), Some(JobStatus::Dead)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(JobStatus::all_variants().len(), JobStatus::iter().len()); + } + + #[test] + fn round_trip() { + for variant in JobStatus::all_variants() { + assert_eq!(variant, JobStatus::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, JobStatus::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, JobStatus::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/job_status_plus.rs b/crates/api_clients/artcraft_client/src/enums/common/job_status_plus.rs new file mode 100644 index 00000000..ac8bf63c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/job_status_plus.rs @@ -0,0 +1,170 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// This is used in newer jobs (that add additional enum states) +/// +/// - generic_inference_job +/// - (no other jobs yet) +/// +/// See the documentation on the table for usage. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum JobStatusPlus { + Pending, + Started, + CompleteSuccess, + CompleteFailure, + AttemptFailed, + Dead, + CancelledByUser, + CancelledBySystem, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(JobStatusPlus); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl Default for JobStatusPlus { + fn default() -> Self { + Self::Pending + } +} + +impl JobStatusPlus { + pub const fn to_str(&self) -> &'static str { + match self { + Self::Pending => "pending", + Self::Started => "started", + Self::CompleteSuccess => "complete_success", + Self::CompleteFailure => "complete_failure", + Self::AttemptFailed => "attempt_failed", + Self::Dead => "dead", + Self::CancelledByUser => "cancelled_by_user", + Self::CancelledBySystem => "cancelled_by_system", + } + } + + pub fn from_str(job_status: &str) -> Result { + match job_status { + "pending" => Ok(Self::Pending), + "started" => Ok(Self::Started), + "complete_success" => Ok(Self::CompleteSuccess), + "complete_failure" => Ok(Self::CompleteFailure), + "attempt_failed" => Ok(Self::AttemptFailed), + "dead" => Ok(Self::Dead), + "cancelled_by_user" => Ok(Self::CancelledByUser), + "cancelled_by_system" => Ok(Self::CancelledBySystem), + _ => Err(format!("invalid job_status: {:?}", job_status)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Pending, + Self::Started, + Self::CompleteSuccess, + Self::CompleteFailure, + Self::AttemptFailed, + Self::Dead, + Self::CancelledByUser, + Self::CancelledBySystem, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::job_status_plus::JobStatusPlus; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_default() { + assert_eq!(JobStatusPlus::default(), JobStatusPlus::Pending); + } + + #[test] + fn test_serialization() { + assert_serialization(JobStatusPlus::Pending, "pending"); + assert_serialization(JobStatusPlus::Started, "started"); + assert_serialization(JobStatusPlus::CompleteSuccess, "complete_success"); + assert_serialization(JobStatusPlus::CompleteFailure, "complete_failure"); + assert_serialization(JobStatusPlus::AttemptFailed, "attempt_failed"); + assert_serialization(JobStatusPlus::Dead, "dead"); + assert_serialization(JobStatusPlus::CancelledByUser, "cancelled_by_user"); + assert_serialization(JobStatusPlus::CancelledBySystem, "cancelled_by_system"); + } + + #[test] + fn to_str() { + assert_eq!(JobStatusPlus::Pending.to_str(), "pending"); + assert_eq!(JobStatusPlus::Started.to_str(), "started"); + assert_eq!(JobStatusPlus::CompleteSuccess.to_str(), "complete_success"); + assert_eq!(JobStatusPlus::CompleteFailure.to_str(), "complete_failure"); + assert_eq!(JobStatusPlus::AttemptFailed.to_str(), "attempt_failed"); + assert_eq!(JobStatusPlus::Dead.to_str(), "dead"); + assert_eq!(JobStatusPlus::CancelledByUser.to_str(), "cancelled_by_user"); + assert_eq!(JobStatusPlus::CancelledBySystem.to_str(), "cancelled_by_system"); + } + + #[test] + fn from_str() { + assert_eq!(JobStatusPlus::from_str("pending").unwrap(), JobStatusPlus::Pending); + assert_eq!(JobStatusPlus::from_str("started").unwrap(), JobStatusPlus::Started); + assert_eq!(JobStatusPlus::from_str("complete_success").unwrap(), JobStatusPlus::CompleteSuccess); + assert_eq!(JobStatusPlus::from_str("complete_failure").unwrap(), JobStatusPlus::CompleteFailure); + assert_eq!(JobStatusPlus::from_str("attempt_failed").unwrap(), JobStatusPlus::AttemptFailed); + assert_eq!(JobStatusPlus::from_str("dead").unwrap(), JobStatusPlus::Dead); + assert_eq!(JobStatusPlus::from_str("cancelled_by_user").unwrap(), JobStatusPlus::CancelledByUser); + assert_eq!(JobStatusPlus::from_str("cancelled_by_system").unwrap(), JobStatusPlus::CancelledBySystem); + } + + #[test] + fn all_variants() { + let mut variants = JobStatusPlus::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::Pending)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::Started)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::CompleteSuccess)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::CompleteFailure)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::AttemptFailed)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::Dead)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::CancelledByUser)); + assert_eq!(variants.pop_first(), Some(JobStatusPlus::CancelledBySystem)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(JobStatusPlus::all_variants().len(), JobStatusPlus::iter().len()); + } + + #[test] + fn round_trip() { + for variant in JobStatusPlus::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, JobStatusPlus::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, JobStatusPlus::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, JobStatusPlus::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/mod.rs b/crates/api_clients/artcraft_client/src/enums/common/mod.rs new file mode 100644 index 00000000..a06d519b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/mod.rs @@ -0,0 +1,14 @@ +pub mod artcraft_credits_pack_slug; +pub mod artcraft_subscription_slug; +pub mod generation; +pub mod job_status; +pub mod job_status_plus; +pub mod payments_namespace; +pub mod platform_type; +pub mod stripe_subscription_status; +pub mod view_as; +pub mod visibility; +pub mod vocoder_type; + +// Sqlite specific types. +pub mod sqlite; diff --git a/crates/api_clients/artcraft_client/src/enums/common/payments_namespace.rs b/crates/api_clients/artcraft_client/src/enums/common/payments_namespace.rs new file mode 100644 index 00000000..c4c7f442 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/payments_namespace.rs @@ -0,0 +1,115 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// NB: This will be used by a variety of tables (MySQL and sqlite)! +/// Keep the max length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum PaymentsNamespace { + #[serde(rename = "artcraft")] + Artcraft, + #[serde(rename = "fakeyou")] + FakeYou, +} + +impl_enum_display_and_debug_using_to_str!(PaymentsNamespace); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl PaymentsNamespace { + pub const fn to_str(&self) -> &'static str { + match self { + Self::Artcraft => "artcraft", + Self::FakeYou => "fakeyou", + } + } + + pub fn from_str(s: &str) -> Result { + match s { + "artcraft" => Ok(Self::Artcraft), + "fakeyou" => Ok(Self::FakeYou), + _ => Err(format!("invalid subscription_namespace: {:?}", s)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Artcraft, + Self::FakeYou, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::test_helpers::assert_serialization; + use crate::enums::common::payments_namespace::PaymentsNamespace; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PaymentsNamespace::Artcraft, "artcraft"); + assert_serialization(PaymentsNamespace::FakeYou, "fakeyou"); + } + + #[test] + fn to_str() { + assert_eq!(PaymentsNamespace::Artcraft.to_str(), "artcraft"); + assert_eq!(PaymentsNamespace::FakeYou.to_str(), "fakeyou"); + } + + #[test] + fn from_str() { + assert_eq!(PaymentsNamespace::from_str("artcraft").unwrap(), PaymentsNamespace::Artcraft); + assert_eq!(PaymentsNamespace::from_str("fakeyou").unwrap(), PaymentsNamespace::FakeYou); + } + + #[test] + fn all_variants() { + let mut variants = PaymentsNamespace::all_variants(); + assert_eq!(variants.len(), 2); + assert_eq!(variants.pop_first(), Some(PaymentsNamespace::Artcraft)); + assert_eq!(variants.pop_first(), Some(PaymentsNamespace::FakeYou)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PaymentsNamespace::all_variants().len(), PaymentsNamespace::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PaymentsNamespace::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, PaymentsNamespace::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PaymentsNamespace::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PaymentsNamespace::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in PaymentsNamespace::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/platform_type.rs b/crates/api_clients/artcraft_client/src/enums/common/platform_type.rs new file mode 100644 index 00000000..6b210341 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/platform_type.rs @@ -0,0 +1,170 @@ +//! The platform a request originated from, inferred from the User-Agent header. +//! +//! Stored on `generic_inference_jobs` (set at enqueue time) and copied to the +//! resulting `media_files` rows when jobs complete. + +use std::collections::BTreeSet; + +use crate::enums::error::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// NB: This is used by multiple tables (`generic_inference_jobs`, `media_files`). +/// Keep the max length to 16 characters. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum PlatformType { + // ========== Our clients ========== + + /// Website users + Web, + + /// Desktop app users + DesktopApp, + + /// Requests authenticated via an `Authorization` header API key (the Omni API surface). + ApiKey, + + // ========== Other clients ========== + + Curl, + PythonRequests, + Postman, +} + +impl_enum_display_and_debug_using_to_str!(PlatformType); + +impl PlatformType { + pub fn to_str(&self) -> &'static str { + match self { + Self::Web => "web", + Self::DesktopApp => "desktop_app", + Self::ApiKey => "api_key", + Self::Curl => "curl", + Self::PythonRequests => "python_requests", + Self::Postman => "postman", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "web" => Ok(Self::Web), + "desktop_app" => Ok(Self::DesktopApp), + "api_key" => Ok(Self::ApiKey), + "curl" => Ok(Self::Curl), + "python_requests" => Ok(Self::PythonRequests), + "postman" => Ok(Self::Postman), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + BTreeSet::from([ + Self::Web, + Self::DesktopApp, + Self::ApiKey, + Self::Curl, + Self::PythonRequests, + Self::Postman, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::platform_type::PlatformType; + use crate::enums::error::enum_error::EnumError; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PlatformType::Web, "web"); + assert_serialization(PlatformType::DesktopApp, "desktop_app"); + assert_serialization(PlatformType::ApiKey, "api_key"); + assert_serialization(PlatformType::Curl, "curl"); + assert_serialization(PlatformType::PythonRequests, "python_requests"); + assert_serialization(PlatformType::Postman, "postman"); + } + + #[test] + fn to_str() { + assert_eq!(PlatformType::Web.to_str(), "web"); + assert_eq!(PlatformType::DesktopApp.to_str(), "desktop_app"); + assert_eq!(PlatformType::ApiKey.to_str(), "api_key"); + assert_eq!(PlatformType::Curl.to_str(), "curl"); + assert_eq!(PlatformType::PythonRequests.to_str(), "python_requests"); + assert_eq!(PlatformType::Postman.to_str(), "postman"); + } + + #[test] + fn from_str() { + assert_eq!(PlatformType::from_str("web").unwrap(), PlatformType::Web); + assert_eq!(PlatformType::from_str("desktop_app").unwrap(), PlatformType::DesktopApp); + assert_eq!(PlatformType::from_str("api_key").unwrap(), PlatformType::ApiKey); + assert_eq!(PlatformType::from_str("curl").unwrap(), PlatformType::Curl); + assert_eq!(PlatformType::from_str("python_requests").unwrap(), PlatformType::PythonRequests); + assert_eq!(PlatformType::from_str("postman").unwrap(), PlatformType::Postman); + } + + #[test] + fn from_str_err() { + let result = PlatformType::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = PlatformType::all_variants(); + assert_eq!(variants.len(), 6); + assert_eq!(variants.pop_first(), Some(PlatformType::Web)); + assert_eq!(variants.pop_first(), Some(PlatformType::DesktopApp)); + assert_eq!(variants.pop_first(), Some(PlatformType::ApiKey)); + assert_eq!(variants.pop_first(), Some(PlatformType::Curl)); + assert_eq!(variants.pop_first(), Some(PlatformType::PythonRequests)); + assert_eq!(variants.pop_first(), Some(PlatformType::Postman)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PlatformType::all_variants().len(), PlatformType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PlatformType::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, PlatformType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PlatformType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PlatformType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 16; + for variant in PlatformType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/sqlite/awaitable_job_status.rs b/crates/api_clients/artcraft_client/src/enums/common/sqlite/awaitable_job_status.rs new file mode 100644 index 00000000..d82f7931 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/sqlite/awaitable_job_status.rs @@ -0,0 +1,112 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the following SqLite tables and columns: +/// `web_scraping_targets` . `maybe_skip_reason`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum AwaitableJobStatus { + #[serde(rename = "not_ready")] + NotReady, + + #[serde(rename = "ready_waiting")] + ReadyWaiting, + + #[serde(rename = "processing")] + Processing, + + #[serde(rename = "retryably_failed")] + RetryablyFailed, + + #[serde(rename = "permanently_failed")] + PermanentlyFailed, + + #[serde(rename = "skipped")] + Skipped, + + #[serde(rename = "done")] + Done, +} + +// TODO(bt, 2023-02-08): This desperately needs Sqlite integration tests! +impl_enum_display_and_debug_using_to_str!(AwaitableJobStatus); + +/// NB: Legacy API for older code. +impl AwaitableJobStatus { + pub fn to_str(&self) -> &'static str { + match self { + Self::NotReady => "not_ready", + Self::ReadyWaiting => "ready_waiting", + Self::Processing => "processing", + Self::RetryablyFailed => "retryably_failed", + Self::PermanentlyFailed => "permanently_failed", + Self::Skipped => "skipped", + Self::Done => "done", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "not_ready" => Ok(Self::NotReady), + "ready_waiting" => Ok(Self::ReadyWaiting), + "processing" => Ok(Self::Processing), + "retryably_failed" => Ok(Self::RetryablyFailed), + "permanently_failed" => Ok(Self::PermanentlyFailed), + "skipped" => Ok(Self::Skipped), + "done" => Ok(Self::Done), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::sqlite::awaitable_job_status::AwaitableJobStatus; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(AwaitableJobStatus::NotReady, "not_ready"); + assert_serialization(AwaitableJobStatus::ReadyWaiting, "ready_waiting"); + assert_serialization(AwaitableJobStatus::Processing, "processing"); + assert_serialization(AwaitableJobStatus::RetryablyFailed, "retryably_failed"); + assert_serialization(AwaitableJobStatus::PermanentlyFailed, "permanently_failed"); + assert_serialization(AwaitableJobStatus::Skipped, "skipped"); + assert_serialization(AwaitableJobStatus::Done, "done"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(AwaitableJobStatus::NotReady.to_str(), "not_ready"); + assert_eq!(AwaitableJobStatus::ReadyWaiting.to_str(), "ready_waiting"); + assert_eq!(AwaitableJobStatus::Processing.to_str(), "processing"); + assert_eq!(AwaitableJobStatus::RetryablyFailed.to_str(), "retryably_failed"); + assert_eq!(AwaitableJobStatus::PermanentlyFailed.to_str(), "permanently_failed"); + assert_eq!(AwaitableJobStatus::Skipped.to_str(), "skipped"); + assert_eq!(AwaitableJobStatus::Done.to_str(), "done"); + } + + #[test] + fn test_from_str() { + assert_eq!(AwaitableJobStatus::from_str("not_ready").unwrap(), AwaitableJobStatus::NotReady); + assert_eq!(AwaitableJobStatus::from_str("ready_waiting").unwrap(), AwaitableJobStatus::ReadyWaiting); + assert_eq!(AwaitableJobStatus::from_str("processing").unwrap(), AwaitableJobStatus::Processing); + assert_eq!(AwaitableJobStatus::from_str("retryably_failed").unwrap(), AwaitableJobStatus::RetryablyFailed); + assert_eq!(AwaitableJobStatus::from_str("permanently_failed").unwrap(), AwaitableJobStatus::PermanentlyFailed); + assert_eq!(AwaitableJobStatus::from_str("skipped").unwrap(), AwaitableJobStatus::Skipped); + assert_eq!(AwaitableJobStatus::from_str("done").unwrap(), AwaitableJobStatus::Done); + assert!(AwaitableJobStatus::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/sqlite/chatbot_job_status.rs b/crates/api_clients/artcraft_client/src/enums/common/sqlite/chatbot_job_status.rs new file mode 100644 index 00000000..b70cd2b2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/sqlite/chatbot_job_status.rs @@ -0,0 +1,95 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the SqLite `web_scraping_targets` table in a `TEXT` field named `scraping_status`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum ChatbotJobStatus { + #[serde(rename = "new")] + New, + + #[serde(rename = "skipped")] + Skipped, + + #[serde(rename = "failed")] + Failed, + + #[serde(rename = "permanently_failed")] + PermanentlyFailed, + + #[serde(rename = "success")] + Success, +} + +// TODO(bt, 2023-02-10): This desperately needs Sqlite integration tests! +impl_enum_display_and_debug_using_to_str!(ChatbotJobStatus); + +/// NB: Legacy API for older code. +impl ChatbotJobStatus { + pub fn to_str(&self) -> &'static str { + match self { + Self::New => "new", + Self::Skipped => "skipped", + Self::Failed => "failed", + Self::PermanentlyFailed => "permanently_failed", + Self::Success => "success", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "new" => Ok(Self::New), + "skipped" => Ok(Self::Skipped), + "failed" => Ok(Self::Failed), + "permanently_failed" => Ok(Self::PermanentlyFailed), + "success" => Ok(Self::Success), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::sqlite::chatbot_job_status::ChatbotJobStatus; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(ChatbotJobStatus::New, "new"); + assert_serialization(ChatbotJobStatus::Skipped, "skipped"); + assert_serialization(ChatbotJobStatus::Failed, "failed"); + assert_serialization(ChatbotJobStatus::PermanentlyFailed, "permanently_failed"); + assert_serialization(ChatbotJobStatus::Success, "success"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(ChatbotJobStatus::New.to_str(), "new"); + assert_eq!(ChatbotJobStatus::Skipped.to_str(), "skipped"); + assert_eq!(ChatbotJobStatus::Failed.to_str(), "failed"); + assert_eq!(ChatbotJobStatus::PermanentlyFailed.to_str(), "permanently_failed"); + assert_eq!(ChatbotJobStatus::Success.to_str(), "success"); + } + + #[test] + fn test_from_str() { + assert_eq!(ChatbotJobStatus::from_str("new").unwrap(), ChatbotJobStatus::New); + assert_eq!(ChatbotJobStatus::from_str("skipped").unwrap(), ChatbotJobStatus::Skipped); + assert_eq!(ChatbotJobStatus::from_str("failed").unwrap(), ChatbotJobStatus::Failed); + assert_eq!(ChatbotJobStatus::from_str("permanently_failed").unwrap(), ChatbotJobStatus::PermanentlyFailed); + assert_eq!(ChatbotJobStatus::from_str("success").unwrap(), ChatbotJobStatus::Success); + assert!(ChatbotJobStatus::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/sqlite/mod.rs b/crates/api_clients/artcraft_client/src/enums/common/sqlite/mod.rs new file mode 100644 index 00000000..7659a1e0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/sqlite/mod.rs @@ -0,0 +1,4 @@ +pub mod awaitable_job_status; +pub mod chatbot_job_status; +pub mod skip_reason; +pub mod web_content_type; diff --git a/crates/api_clients/artcraft_client/src/enums/common/sqlite/skip_reason.rs b/crates/api_clients/artcraft_client/src/enums/common/sqlite/skip_reason.rs new file mode 100644 index 00000000..6866473a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/sqlite/skip_reason.rs @@ -0,0 +1,104 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the following SqLite tables and columns: +/// `web_scraping_targets` . `maybe_skip_reason`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum SkipReason { + #[serde(rename = "empty_content")] + EmptyContent, + + #[serde(rename = "advertisement")] + Advertisement, + + #[serde(rename = "video_content")] + VideoContent, + + #[serde(rename = "filtered_topic")] + FilteredTopic, + + #[serde(rename = "filtered_topic_politics")] + FilteredTopicPolitics, + + #[serde(rename = "nobody_cares")] + NobodyCares, +} + +// TODO(bt, 2023-02-08): This desperately needs Sqlite integration tests! +impl_enum_display_and_debug_using_to_str!(SkipReason); + +/// NB: Legacy API for older code. +impl SkipReason { + pub fn to_str(&self) -> &'static str { + match self { + Self::EmptyContent => "empty_content", + Self::Advertisement => "advertisement", + Self::VideoContent => "video_content", + Self::FilteredTopic => "filtered_topic", + Self::FilteredTopicPolitics => "filtered_topic_politics", + Self::NobodyCares => "nobody_cares", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "empty_content" => Ok(Self::EmptyContent), + "advertisement" => Ok(Self::Advertisement), + "video_content" => Ok(Self::VideoContent), + "filtered_topic" => Ok(Self::FilteredTopic), + "filtered_topic_politics" => Ok(Self::FilteredTopicPolitics), + "nobody_cares" => Ok(Self::NobodyCares), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::sqlite::skip_reason::SkipReason; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(SkipReason::EmptyContent, "empty_content"); + assert_serialization(SkipReason::Advertisement, "advertisement"); + assert_serialization(SkipReason::VideoContent, "video_content"); + assert_serialization(SkipReason::FilteredTopic, "filtered_topic"); + assert_serialization(SkipReason::FilteredTopicPolitics, "filtered_topic_politics"); + assert_serialization(SkipReason::NobodyCares, "nobody_cares"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(SkipReason::EmptyContent.to_str(), "empty_content"); + assert_eq!(SkipReason::Advertisement.to_str(), "advertisement"); + assert_eq!(SkipReason::VideoContent.to_str(), "video_content"); + assert_eq!(SkipReason::FilteredTopic.to_str(), "filtered_topic"); + assert_eq!(SkipReason::FilteredTopicPolitics.to_str(), "filtered_topic_politics"); + assert_eq!(SkipReason::NobodyCares.to_str(), "nobody_cares"); + } + + #[test] + fn test_from_str() { + assert_eq!(SkipReason::from_str("empty_content").unwrap(), SkipReason::EmptyContent); + assert_eq!(SkipReason::from_str("advertisement").unwrap(), SkipReason::Advertisement); + assert_eq!(SkipReason::from_str("video_content").unwrap(), SkipReason::VideoContent); + assert_eq!(SkipReason::from_str("filtered_topic").unwrap(), SkipReason::FilteredTopic); + assert_eq!(SkipReason::from_str("filtered_topic_politics").unwrap(), SkipReason::FilteredTopicPolitics); + assert_eq!(SkipReason::from_str("nobody_cares").unwrap(), SkipReason::NobodyCares); + assert!(SkipReason::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/sqlite/web_content_type.rs b/crates/api_clients/artcraft_client/src/enums/common/sqlite/web_content_type.rs new file mode 100644 index 00000000..21971e86 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/sqlite/web_content_type.rs @@ -0,0 +1,137 @@ +use serde::Deserialize; +use serde::Serialize; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Used in the SqLite `web_scraping_targets` table in a `TEXT` field named `web_content_type`. +/// Used in the SqLite `news_story_productions` table in a `TEXT` field named `web_content_type`. +/// Used in the SqLite `news_stories` table in a `TEXT` field named `web_content_type`. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Hash, Deserialize, Serialize)] +pub enum WebContentType { + #[serde(rename = "cbs_news_article")] + CbsNewsArticle, + + #[serde(rename = "cnn_article")] + CnnArticle, + + #[serde(rename = "gizmodo_article")] + GizmodoArticle, + + #[serde(rename = "hacker_news_thread")] + HackerNewsThread, + + #[serde(rename = "kotaku_article")] + KotakuArticle, + + #[serde(rename = "reddit_thread")] + RedditThread, + + #[serde(rename = "slashdot_article")] + SlashdotArticle, + + #[serde(rename = "substack_post")] + SubstackPost, + + #[serde(rename = "techcrunch_article")] + TechCrunchArticle, + + #[serde(rename = "the_guardian_article")] + TheGuardianArticle, +} + +// TODO(bt, 2023-01-17): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(WebContentType); + +/// NB: Legacy API for older code. +impl WebContentType { + pub fn to_str(&self) -> &'static str { + match self { + Self::CbsNewsArticle => "cbs_news_article", + Self::CnnArticle => "cnn_article", + Self::GizmodoArticle => "gizmodo_article", + Self::HackerNewsThread => "hacker_news_thread", + Self::KotakuArticle => "kotaku_article", + Self::RedditThread => "reddit_thread", + Self::SlashdotArticle => "slashdot_article", + Self::SubstackPost => "substack_post", + Self::TechCrunchArticle => "techcrunch_article", + Self::TheGuardianArticle => "the_guardian_article", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "cbs_news_article" => Ok(Self::CbsNewsArticle), + "cnn_article" => Ok(Self::CnnArticle), + "gizmodo_article" => Ok(Self::GizmodoArticle), + "hacker_news_thread" => Ok(Self::HackerNewsThread), + "kotaku_article" => Ok(Self::KotakuArticle), + "reddit_thread" => Ok(Self::RedditThread), + "slashdot_article" => Ok(Self::SlashdotArticle), + "substack_post" => Ok(Self::SubstackPost), + "techcrunch_article" => Ok(Self::TechCrunchArticle), + "the_guardian_article" => Ok(Self::TheGuardianArticle), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::sqlite::web_content_type::WebContentType; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(WebContentType::CbsNewsArticle, "cbs_news_article"); + assert_serialization(WebContentType::CnnArticle, "cnn_article"); + assert_serialization(WebContentType::GizmodoArticle, "gizmodo_article"); + assert_serialization(WebContentType::HackerNewsThread, "hacker_news_thread"); + assert_serialization(WebContentType::KotakuArticle, "kotaku_article"); + assert_serialization(WebContentType::RedditThread, "reddit_thread"); + assert_serialization(WebContentType::SlashdotArticle, "slashdot_article"); + assert_serialization(WebContentType::SubstackPost, "substack_post"); + assert_serialization(WebContentType::TechCrunchArticle, "techcrunch_article"); + assert_serialization(WebContentType::TheGuardianArticle, "the_guardian_article"); + } + } + + mod impl_methods { + use super::*; + + #[test] + fn test_to_str() { + assert_eq!(WebContentType::CbsNewsArticle.to_str(), "cbs_news_article"); + assert_eq!(WebContentType::CnnArticle.to_str(), "cnn_article"); + assert_eq!(WebContentType::GizmodoArticle.to_str(), "gizmodo_article"); + assert_eq!(WebContentType::HackerNewsThread.to_str(), "hacker_news_thread"); + assert_eq!(WebContentType::KotakuArticle.to_str(), "kotaku_article"); + assert_eq!(WebContentType::RedditThread.to_str(), "reddit_thread"); + assert_eq!(WebContentType::SlashdotArticle.to_str(), "slashdot_article"); + assert_eq!(WebContentType::SubstackPost.to_str(), "substack_post"); + assert_eq!(WebContentType::TechCrunchArticle.to_str(), "techcrunch_article"); + assert_eq!(WebContentType::TheGuardianArticle.to_str(), "the_guardian_article"); + } + + #[test] + fn test_from_str() { + assert_eq!(WebContentType::from_str("cbs_news_article").unwrap(), WebContentType::CbsNewsArticle); + assert_eq!(WebContentType::from_str("cnn_article").unwrap(), WebContentType::CnnArticle); + assert_eq!(WebContentType::from_str("gizmodo_article").unwrap(), WebContentType::GizmodoArticle); + assert_eq!(WebContentType::from_str("hacker_news_thread").unwrap(), WebContentType::HackerNewsThread); + assert_eq!(WebContentType::from_str("kotaku_article").unwrap(), WebContentType::KotakuArticle); + assert_eq!(WebContentType::from_str("reddit_thread").unwrap(), WebContentType::RedditThread); + assert_eq!(WebContentType::from_str("slashdot_article").unwrap(), WebContentType::SlashdotArticle); + assert_eq!(WebContentType::from_str("substack_post").unwrap(), WebContentType::SubstackPost); + assert_eq!(WebContentType::from_str("techcrunch_article").unwrap(), WebContentType::TechCrunchArticle); + assert_eq!(WebContentType::from_str("the_guardian_article").unwrap(), WebContentType::TheGuardianArticle); + assert!(WebContentType::from_str("foo").is_err()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/stripe_subscription_status.rs b/crates/api_clients/artcraft_client/src/enums/common/stripe_subscription_status.rs new file mode 100644 index 00000000..0f22c029 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/stripe_subscription_status.rs @@ -0,0 +1,245 @@ +//! This is copied from the stripe crate's `SubscriptionStatus`, +//! and then from `reusable_types`. + +// There are three changes from the source create: +// - Renamed the struct from SubscriptionStatus to StripeSubscriptionStatus +// - Added StripeSubscriptionStatus::from_str() +// - Added derive sqlx::Type and sqlx(rename_all) +// - Added Deref impl +// - Added tests +// +// Then, moving into enums: +// - Changed derives +// - as_st() -> to_str() (gross! but convention as of now...) +// - from_str() : changed error from string to EnumError +// - Added all_variants() +// - commented out all other impls. +// + +use std::collections::BTreeSet; + +use crate::enums::error::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + + +// NB: Added "sqlx::Type". +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum StripeSubscriptionStatus { + Active, + Canceled, + Incomplete, + IncompleteExpired, + PastDue, + Trialing, + Unpaid, + Paused, +} + +impl_enum_display_and_debug_using_to_str!(StripeSubscriptionStatus); + +impl StripeSubscriptionStatus { + pub fn to_str(self) -> &'static str { + match self { + Self::Active => "active", + Self::Canceled => "canceled", + Self::Incomplete => "incomplete", + Self::IncompleteExpired => "incomplete_expired", + Self::PastDue => "past_due", + Self::Trialing => "trialing", + Self::Unpaid => "unpaid", + Self::Paused => "paused" + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "active" => Ok(Self::Active), + "canceled" => Ok(Self::Canceled), + "incomplete" => Ok(Self::Incomplete), + "incomplete_expired" => Ok(Self::IncompleteExpired), + "past_due" => Ok(Self::PastDue), + "trialing" => Ok(Self::Trialing), + "unpaid" => Ok(Self::Unpaid), + "paused" => Ok(Self::Paused), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Active, + Self::Canceled, + Self::Incomplete, + Self::IncompleteExpired, + Self::PastDue, + Self::Trialing, + Self::Unpaid, + Self::Paused, + ]) + } +} + +//impl AsRef for StripeSubscriptionStatus { +// fn as_ref(&self) -> &str { +// self.as_str() +// } +//} +// +//// NB: Added by us. +//impl std::ops::Deref for StripeSubscriptionStatus { +// type Target = str; +// +// fn deref(&self) -> &Self::Target { +// self.as_str() +// } +//} +// +//impl std::fmt::Display for StripeSubscriptionStatus { +// fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { +// self.as_str().fmt(f) +// } +//} +// +//impl std::default::Default for StripeSubscriptionStatus { +// fn default() -> Self { +// Self::Active +// } +//} + +#[cfg(test)] +mod tests { + use crate::enums::error::enum_error::EnumError; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::common::stripe_subscription_status::StripeSubscriptionStatus; + + #[test] + fn test_serialization() { + assert_serialization(StripeSubscriptionStatus::Active, "active"); + assert_serialization(StripeSubscriptionStatus::Canceled, "canceled"); + assert_serialization(StripeSubscriptionStatus::Incomplete, "incomplete"); + assert_serialization(StripeSubscriptionStatus::IncompleteExpired, "incomplete_expired"); + assert_serialization(StripeSubscriptionStatus::PastDue, "past_due"); + assert_serialization(StripeSubscriptionStatus::Trialing, "trialing"); + assert_serialization(StripeSubscriptionStatus::Unpaid, "unpaid"); + assert_serialization(StripeSubscriptionStatus::Paused, "paused"); + } + + #[test] + fn to_str() { + assert_eq!(StripeSubscriptionStatus::Active.to_str(), "active"); + assert_eq!(StripeSubscriptionStatus::Canceled.to_str(), "canceled"); + assert_eq!(StripeSubscriptionStatus::Incomplete.to_str(), "incomplete"); + assert_eq!(StripeSubscriptionStatus::IncompleteExpired.to_str(), "incomplete_expired"); + assert_eq!(StripeSubscriptionStatus::PastDue.to_str(), "past_due"); + assert_eq!(StripeSubscriptionStatus::Trialing.to_str(), "trialing"); + assert_eq!(StripeSubscriptionStatus::Unpaid.to_str(), "unpaid"); + assert_eq!(StripeSubscriptionStatus::Paused.to_str(), "paused"); + } + + #[test] + fn from_str() { + assert_eq!(StripeSubscriptionStatus::from_str("active").unwrap(), StripeSubscriptionStatus::Active); + assert_eq!(StripeSubscriptionStatus::from_str("canceled").unwrap(), StripeSubscriptionStatus::Canceled); + assert_eq!(StripeSubscriptionStatus::from_str("incomplete").unwrap(), StripeSubscriptionStatus::Incomplete); + assert_eq!(StripeSubscriptionStatus::from_str("incomplete_expired").unwrap(), StripeSubscriptionStatus::IncompleteExpired); + assert_eq!(StripeSubscriptionStatus::from_str("past_due").unwrap(), StripeSubscriptionStatus::PastDue); + assert_eq!(StripeSubscriptionStatus::from_str("trialing").unwrap(), StripeSubscriptionStatus::Trialing); + assert_eq!(StripeSubscriptionStatus::from_str("unpaid").unwrap(), StripeSubscriptionStatus::Unpaid); + assert_eq!(StripeSubscriptionStatus::from_str("paused").unwrap(), StripeSubscriptionStatus::Paused); + } + + #[test] + fn from_str_err() { + let result = StripeSubscriptionStatus::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = StripeSubscriptionStatus::all_variants(); + assert_eq!(variants.len(), 8); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::Active)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::Canceled)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::Incomplete)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::IncompleteExpired)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::PastDue)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::Trialing)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::Unpaid)); + assert_eq!(variants.pop_first(), Some(StripeSubscriptionStatus::Paused)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use crate::enums::common::stripe_subscription_status::StripeSubscriptionStatus; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(StripeSubscriptionStatus::all_variants().len(), StripeSubscriptionStatus::iter().len()); + } + + #[test] + fn round_trip() { + for variant in StripeSubscriptionStatus::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, StripeSubscriptionStatus::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, StripeSubscriptionStatus::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, StripeSubscriptionStatus::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 32; + for variant in StripeSubscriptionStatus::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/crates/api_clients/artcraft_client/src/enums/common/view_as.rs b/crates/api_clients/artcraft_client/src/enums/common/view_as.rs new file mode 100644 index 00000000..d8c77392 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/view_as.rs @@ -0,0 +1,149 @@ +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[serde(rename_all = "snake_case")] +pub enum ViewAs { + /// Public entities are able to be listed in public lists. + /// It does not mean that they necessarily will be (eg. they could be "mod unapproved" or deleted). + Author, + /// Hidden entities are not shown in public lists, but the URL to them may be given out freely. + /// They are available to non-logged-in users as long as they have the URL. + Moderator, + /// Private entities should only be available to the creator, a list of approved users, and + /// website moderation staff. + AnotherUser, +} + + +impl_enum_display_and_debug_using_to_str!(ViewAs); + +impl Default for ViewAs { + fn default() -> Self { Self::AnotherUser } +} + +/// NB: Legacy API for older code. +impl ViewAs { + pub fn to_str(&self) -> &'static str { + match self { + Self::Author => "author", + Self::Moderator => "moderator", + Self::AnotherUser => "another_user", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "author" => Ok(Self::Author), + "moderator" => Ok(Self::Moderator), + "another_user" => Ok(Self::AnotherUser), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::view_as::ViewAs; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_default() { + assert_eq!(ViewAs::default(), ViewAs::AnotherUser); + + } + + #[test] + fn test_serialization() { + assert_serialization(ViewAs::Author, "author"); + assert_serialization(ViewAs::Moderator, "moderator"); + assert_serialization(ViewAs::AnotherUser, "another_user"); + } + + #[test] + fn test_to_str() { + assert_eq!(ViewAs::Author.to_str(), "author"); + assert_eq!(ViewAs::Moderator.to_str(), "moderator"); + assert_eq!(ViewAs::AnotherUser.to_str(), "another_user"); + } + + #[test] + fn test_from_str() { + assert_eq!(ViewAs::from_str("author").unwrap(), ViewAs::Author); + assert_eq!(ViewAs::from_str("moderator").unwrap(), ViewAs::Moderator); + assert_eq!(ViewAs::from_str("another_user").unwrap(), ViewAs::AnotherUser); + assert!(ViewAs::from_str("foo").is_err()); + } + + mod traits { + use crate::enums::common::view_as::ViewAs; + + #[test] + fn display() { + let view_as = ViewAs::Moderator; + assert_eq!(format!("{}", view_as), "moderator".to_string()); + } + + #[test] + fn debug() { + let view_as = ViewAs::Moderator; + assert_eq!(format!("{:?}", view_as), "moderator".to_string()); + } + } + + #[derive(Serialize, Deserialize, PartialEq, Debug)] + struct CompositeType { + view_as: ViewAs, + string: String, + } + + mod serde_serialization { + use crate::enums::common::view_as::ViewAs; + + use super::CompositeType; + + #[test] + fn serialize() { + let expected = "\"author\"".to_string(); // NB: Quoted + + assert_eq!(expected, serde_json::to_string(&ViewAs::Author).unwrap()); + + // Just to show this serializes the same as a string + assert_eq!(expected, serde_json::to_string("author").unwrap()); + } + + #[test] + fn nested_serialize() { + let value = CompositeType { view_as: ViewAs::Moderator, string: "bar".to_string() }; + let expected = r#"{"view_as":"moderator","string":"bar"}"#.to_string(); + assert_eq!(expected, serde_json::to_string(&value).unwrap()); + } + } + + mod serde_deserialization { + use crate::enums::common::view_as::ViewAs; + + use super::CompositeType; + + #[test] + fn deserialize() { + let payload = "\"another_user\""; // NB: Quoted + let value: ViewAs = serde_json::from_str(payload).unwrap(); + assert_eq!(value, ViewAs::AnotherUser); + } + + #[test] + fn nested_deserialize() { + let payload = r#"{"view_as":"another_user","string":"bar"}"#.to_string(); + let expected = CompositeType { + view_as: ViewAs::AnotherUser, + string: "bar".to_string(), + }; + + assert_eq!(expected, serde_json::from_str::(&payload).unwrap()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/visibility.rs b/crates/api_clients/artcraft_client/src/enums/common/visibility.rs new file mode 100644 index 00000000..fbd693eb --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/visibility.rs @@ -0,0 +1,190 @@ +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; +/// Visibility +/// +/// Used in various database tables (as enums! careful!) and the HTTP API to convey +/// how the associated entity should be made visible to the public. +/// +/// To use this in a query, the query must have type annotations. +/// See: https://www.gitmemory.com/issue/launchbadge/sqlx/1241/847154375 +/// eg. preferred_tts_result_visibility as `preferred_tts_result_visibility: crate::enums::common::visibility::Visibility` +/// +/// See also: https://docs.rs/sqlx/0.4.0-beta.1/sqlx/trait.Type.html +/// +/// *DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY!* + + +#[derive(Clone, Copy, Eq, PartialEq, Deserialize, Serialize)] +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[serde(rename_all = "lowercase")] +pub enum Visibility { + /// Public entities are able to be listed in public lists. + /// It does not mean that they necessarily will be (eg. they could be "mod unapproved" or deleted). + Public, + /// Hidden entities are not shown in public lists, but the URL to them may be given out freely. + /// They are available to non-logged-in users as long as they have the URL. + Hidden, + /// Private entities should only be available to the creator, a list of approved users, and + /// website moderation staff. + Private, + + // TODO(bt, 2022-12-20): We need a "Shared" option where users can share it with a specified group. + // This should perhaps be its own type, eg. VisibilityV2., so that we don't use it in tables that + // have not yet been migrated to this scheme. +} + + +impl_enum_display_and_debug_using_to_str!(Visibility); + +// For reference, here's what the serde implementation might be if manually written. +// This may be useful for designing composite types in the future: +// +// use serde::{Deserializer, Serializer}; +// +// impl serde::Serialize for UserToken { +// fn serialize(&self, serializer: S) -> Result { +// serializer.serialize_str(&self.0) +// } +// } +// +// impl<'de> serde::Deserialize<'de> for UserToken { +// fn deserialize>(d: D) -> Result { +// let s = String::deserialize(d)?; +// Ok(UserToken(s)) +// } +// } + +//impl sqlx::Type for Visibility { +// fn type_info() -> sqlx_core::database::TypeInfo { +// todo!() +// } +//} + +impl Default for Visibility { + fn default() -> Self { Self::Public } +} + +/// NB: Legacy API for older code. +impl Visibility { + pub fn to_str(&self) -> &'static str { + match self { + Self::Public => "public", + Self::Hidden => "hidden", + Self::Private => "private", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "public" => Ok(Self::Public), + "hidden" => Ok(Self::Hidden), + "private" => Ok(Self::Private), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::visibility::Visibility; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_default() { + assert_eq!(Visibility::default(), Visibility::Public); + + } + + #[test] + fn test_serialization() { + assert_serialization(Visibility::Public, "public"); + assert_serialization(Visibility::Hidden, "hidden"); + assert_serialization(Visibility::Private, "private"); + } + + #[test] + fn test_to_str() { + assert_eq!(Visibility::Public.to_str(), "public"); + assert_eq!(Visibility::Hidden.to_str(), "hidden"); + assert_eq!(Visibility::Private.to_str(), "private"); + } + + #[test] + fn test_from_str() { + assert_eq!(Visibility::from_str("public").unwrap(), Visibility::Public); + assert_eq!(Visibility::from_str("hidden").unwrap(), Visibility::Hidden); + assert_eq!(Visibility::from_str("private").unwrap(), Visibility::Private); + assert!(Visibility::from_str("foo").is_err()); + } + + mod traits { + use crate::enums::common::visibility::Visibility; + + #[test] + fn display() { + let visibility = Visibility::Hidden; + assert_eq!(format!("{}", visibility), "hidden".to_string()); + } + + #[test] + fn debug() { + let visibility = Visibility::Private; + assert_eq!(format!("{:?}", visibility), "private".to_string()); + } + } + + #[derive(Serialize, Deserialize, PartialEq, Debug)] + struct CompositeType { + visibility: Visibility, + string: String, + } + + mod serde_serialization { + use crate::enums::common::visibility::Visibility; + + use super::CompositeType; + + #[test] + fn serialize() { + let expected = "\"public\"".to_string(); // NB: Quoted + + assert_eq!(expected, serde_json::to_string(&Visibility::Public).unwrap()); + + // Just to show this serializes the same as a string + assert_eq!(expected, serde_json::to_string("public").unwrap()); + } + + #[test] + fn nested_serialize() { + let value = CompositeType { visibility: Visibility::Hidden, string: "bar".to_string() }; + let expected = r#"{"visibility":"hidden","string":"bar"}"#.to_string(); + assert_eq!(expected, serde_json::to_string(&value).unwrap()); + } + } + + mod serde_deserialization { + use crate::enums::common::visibility::Visibility; + + use super::CompositeType; + + #[test] + fn deserialize() { + let payload = "\"private\""; // NB: Quoted + let value: Visibility = serde_json::from_str(payload).unwrap(); + assert_eq!(value, Visibility::Private); + } + + #[test] + fn nested_deserialize() { + let payload = r#"{"visibility":"hidden","string":"bar"}"#.to_string(); + let expected = CompositeType { + visibility: Visibility::Hidden, + string: "bar".to_string(), + }; + + assert_eq!(expected, serde_json::from_str::(&payload).unwrap()); + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/common/vocoder_type.rs b/crates/api_clients/artcraft_client/src/enums/common/vocoder_type.rs new file mode 100644 index 00000000..e52c749d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/common/vocoder_type.rs @@ -0,0 +1,64 @@ +#[derive(Clone, Copy, Eq, PartialEq, Debug, Deserialize, Serialize)] +pub enum VocoderType { + /// NB: Note - this is hifigan for Tacotron2. + /// Some work will be needed to unify this with other hifigan types. + #[serde(rename = "hifigan")] + HifiGan, + + #[serde(rename = "hifigan-superres")] + HifiGanSuperResolution, + + /// NB: Note - this is hifigan for SoftVC (our internal codename is "rocketvc"). + /// Some work will need to be done to unify this with other hifigan types. + /// NB(bt, 2025-07-09): It was so silly to try to obscure this. Both FakeYou and Uberduck are irrelevant now. + #[serde(rename = "hifigan_rocket_vc")] + HifiGanRocketVc, + +} + +/// NB: Legacy API for older code. +impl VocoderType { + pub fn to_str(&self) -> &'static str { + match self { + Self::HifiGan=> "hifigan", + Self::HifiGanSuperResolution => "hifigan-superres", + Self::HifiGanRocketVc => "hifigan_rocket_vc", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "hifigan" => Ok(Self::HifiGan), + "hifigan-superres" => Ok(Self::HifiGanSuperResolution), + "hifigan_rocket_vc" => Ok(Self::HifiGanRocketVc), + _ => Err(format!("invalid value: {:?}", value)), + } + } +} + +#[cfg(test)] +mod tests { + use crate::enums::common::vocoder_type::VocoderType; + use crate::enums::test_helpers::assert_serialization; + + #[test] + fn test_serialization() { + assert_serialization(VocoderType::HifiGan, "hifigan"); + assert_serialization(VocoderType::HifiGanSuperResolution, "hifigan-superres"); + assert_serialization(VocoderType::HifiGanRocketVc, "hifigan_rocket_vc"); + } + + #[test] + fn to_str() { + assert_eq!(VocoderType::HifiGan.to_str(), "hifigan"); + assert_eq!(VocoderType::HifiGanSuperResolution.to_str(), "hifigan-superres"); + assert_eq!(VocoderType::HifiGanRocketVc.to_str(), "hifigan_rocket_vc"); + } + + #[test] + fn from_str() { + assert_eq!(VocoderType::from_str("hifigan").unwrap(), VocoderType::HifiGan); + assert_eq!(VocoderType::from_str("hifigan-superres").unwrap(), VocoderType::HifiGanSuperResolution); + assert_eq!(VocoderType::from_str("hifigan_rocket_vc").unwrap(), VocoderType::HifiGanRocketVc); + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/error/enum_error.rs b/crates/api_clients/artcraft_client/src/enums/error/enum_error.rs new file mode 100644 index 00000000..a86cf4ed --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/error/enum_error.rs @@ -0,0 +1,18 @@ +use std::error::Error; + +#[derive(Debug)] +pub enum EnumError { + CouldNotConvertFromString(String), +} + +impl Error for EnumError {} + +impl std::fmt::Display for EnumError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + EnumError::CouldNotConvertFromString(value) => { + write!(f, "Could not convert from string: {}", value) + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/error/mod.rs b/crates/api_clients/artcraft_client/src/enums/error/mod.rs new file mode 100644 index 00000000..4f9259a4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/error/mod.rs @@ -0,0 +1 @@ +pub mod enum_error; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/macros/impl_enum_display_and_debug_using_to_str.rs b/crates/api_clients/artcraft_client/src/enums/macros/impl_enum_display_and_debug_using_to_str.rs new file mode 100644 index 00000000..356b8a75 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/macros/impl_enum_display_and_debug_using_to_str.rs @@ -0,0 +1,44 @@ + +/// Implement `Display` and `Debug` for enums that have a `.to_str()` method. +/// This ensures that the casing follows whatever `.to_str()` specifies. +macro_rules! impl_enum_display_and_debug_using_to_str { + ($t:ident) => { + + // Debug trait. + // Requires that the type has `.to_str()`. + impl std::fmt::Debug for $t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.to_str()) + } + } + + // Display trait. + // Requires that the type has `.to_str()`. + impl std::fmt::Display for $t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.to_str()) + } + } + + // NB: This test requires `strum::{EnumIter}` on the enum + #[cfg(test)] + #[test] + fn test_display_trait_matches_to_str() { + use strum::IntoEnumIterator; + for variant in $t::iter() { + assert_eq!(format!("{}", variant), variant.to_str()); + } + } + + // NB: This test requires `strum::{EnumIter}` on the enum + #[cfg(test)] + #[test] + fn test_debug_trait_matches_to_str() { + use strum::IntoEnumIterator; + for variant in $t::iter() { + assert_eq!(format!("{:?}", variant), variant.to_str()); + } + } + } +} + diff --git a/crates/api_clients/artcraft_client/src/enums/macros/mod.rs b/crates/api_clients/artcraft_client/src/enums/macros/mod.rs new file mode 100644 index 00000000..40c7e1c3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/macros/mod.rs @@ -0,0 +1 @@ +#[macro_use] pub mod impl_enum_display_and_debug_using_to_str; diff --git a/crates/api_clients/artcraft_client/src/enums/mod.rs b/crates/api_clients/artcraft_client/src/enums/mod.rs new file mode 100644 index 00000000..758bb2d0 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/mod.rs @@ -0,0 +1,22 @@ +//! enums +//! +//! The purpose of this library is to have a strongly-typed MySQL enum-type wrapper. +//! This should also work for CHAR/VARCHAR fields that work similarly to enums (typically +//! as part of a composite key) +//! +//! These types should also be friendly for API usage in JSON payloads. +//! +//! In the future this should be *CODEGEN DRIVEN* and should get checked into source control. +//! + +#[macro_use] +mod macros; + +#[cfg(test)] pub mod test_helpers; + +pub mod by_table; +pub mod common; +pub mod error; +pub mod no_table; +pub mod tauri; +pub mod api_safe; diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/mod.rs b/crates/api_clients/artcraft_client/src/enums/no_table/mod.rs new file mode 100644 index 00000000..977ace7d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/mod.rs @@ -0,0 +1,3 @@ +pub mod premium_product; +pub mod style_transfer; +pub mod video_dimensions; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/premium_product/mod.rs b/crates/api_clients/artcraft_client/src/enums/no_table/premium_product/mod.rs new file mode 100644 index 00000000..c6890ee9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/premium_product/mod.rs @@ -0,0 +1 @@ +pub mod premium_product_name; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/premium_product/premium_product_name.rs b/crates/api_clients/artcraft_client/src/enums/no_table/premium_product/premium_product_name.rs new file mode 100644 index 00000000..9d2430c2 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/premium_product/premium_product_name.rs @@ -0,0 +1,133 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// This enum is not backed by a particular database table. +/// This is used to count premium product uses for free and paid users. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum PremiumProductName { + // NB: These keys are kept short to preserve space + #[serde(rename = "fa")] + FaceAnimator, + // NB: These keys are kept short to preserve space + #[serde(rename = "fm")] + FaceMirror, + // NB: These keys are kept short to preserve space + #[serde(rename = "lip")] + Lipsync, + // NB: These keys are kept short to preserve space + #[serde(rename = "vst")] + VideoStyleTransfer, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(PremiumProductName); +//impl_mysql_enum_coders!(PremiumProductName); +//impl_mysql_from_row!(PremiumProductName); + +/// NB: Legacy API for older code. +impl PremiumProductName { + pub fn to_str(&self) -> &'static str { + match self { + Self::FaceAnimator => "fa", + Self::FaceMirror => "fm", + Self::Lipsync => "lip", + Self::VideoStyleTransfer => "vst", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "fa" => Ok(Self::FaceAnimator), + "fm" => Ok(Self::FaceMirror), + "lip" => Ok(Self::Lipsync), + "vst" => Ok(Self::VideoStyleTransfer), + _ => Err(format!("Unknown PremiumProductName: {}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::FaceAnimator, + Self::FaceMirror, + Self::Lipsync, + Self::VideoStyleTransfer, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::no_table::premium_product::premium_product_name::PremiumProductName; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(PremiumProductName::FaceAnimator, "fa"); + assert_serialization(PremiumProductName::FaceMirror, "fm"); + assert_serialization(PremiumProductName::Lipsync, "lip"); + assert_serialization(PremiumProductName::VideoStyleTransfer, "vst"); + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(PremiumProductName::FaceAnimator.to_str(), "fa"); + assert_eq!(PremiumProductName::FaceMirror.to_str(), "fm"); + assert_eq!(PremiumProductName::Lipsync.to_str(), "lip"); + assert_eq!(PremiumProductName::VideoStyleTransfer.to_str(), "vst"); + } + + #[test] + fn from_str() { + assert_eq!(PremiumProductName::from_str("fa").unwrap(), PremiumProductName::FaceAnimator); + assert_eq!(PremiumProductName::from_str("fm").unwrap(), PremiumProductName::FaceMirror); + assert_eq!(PremiumProductName::from_str("lip").unwrap(), PremiumProductName::Lipsync); + assert_eq!(PremiumProductName::from_str("vst").unwrap(), PremiumProductName::VideoStyleTransfer); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let variants = PremiumProductName::all_variants(); + assert_eq!(variants.len(), 4); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(PremiumProductName::all_variants().len(), PremiumProductName::iter().len()); + } + + #[test] + fn round_trip() { + for variant in PremiumProductName::all_variants() { + assert_eq!(variant, PremiumProductName::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, PremiumProductName::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, PremiumProductName::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/style_transfer/mod.rs b/crates/api_clients/artcraft_client/src/enums/no_table/style_transfer/mod.rs new file mode 100644 index 00000000..84c0a980 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/style_transfer/mod.rs @@ -0,0 +1 @@ +pub mod style_transfer_name; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/style_transfer/style_transfer_name.rs b/crates/api_clients/artcraft_client/src/enums/no_table/style_transfer/style_transfer_name.rs new file mode 100644 index 00000000..dd270133 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/style_transfer/style_transfer_name.rs @@ -0,0 +1,430 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// This enum is not backed by a particular database table. +/// It's used in APIs and Jobs to agree upon ComfyUI style transfer style configurations. +/// +/// DO NOT CHANGE VALUES WITHOUT A MIGRATION STRATEGY. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum StyleTransferName { + #[serde(rename = "anime_2_5d")] + Anime2_5D, + #[serde(rename = "anime_2d_flat")] + Anime2DFlat, + #[serde(rename = "cartoon_3d")] + Cartoon3D, + #[serde(rename = "comic_book")] + ComicBook, + #[serde(rename = "anime_ghibli")] + AnimeGhibli, + #[serde(rename = "ink_punk")] + InkPunk, + #[serde(rename = "ink_splash")] + InkSplash, + #[serde(rename = "ink_bw_style")] + InkBWStyle, + #[serde(rename = "jojo_style")] + JojoStyle, + #[serde(rename = "paper_origami")] + PaperOrigami, + #[serde(rename = "pixel_art")] + PixelArt, + #[serde(rename = "pop_art")] + PopArt, + #[serde(rename = "realistic_1")] + Realistic1, + #[serde(rename = "realistic_2")] + Realistic2, + #[serde(rename = "anime_retro_neon")] + AnimeRetroNeon, + #[serde(rename = "anime_standard")] + AnimeStandard, + + // New Styles (2024-05-03) + + #[serde(rename = "hr_giger")] + HrGiger, + #[serde(rename = "simpsons")] + Simpsons, + #[serde(rename = "carnage")] + Carnage, + #[serde(rename = "pastel_cute_anime")] // TODO: Rename + AnimePastelCute, + #[serde(rename = "bloom_lighting")] + BloomLighting, + #[serde(rename = "25d_horror")] // TODO: Rename + Horror2_5D, + #[serde(rename = "creepy")] + Creepy, + #[serde(rename = "creepy_vhs")] + CreepyVhs, + #[serde(rename = "trail_cam_footage")] + TrailCamFootage, + #[serde(rename = "old_black_white_movie")] + OldBlackWhiteMovie, + #[serde(rename = "horror_noir_black_white")] + HorrorNoirBlackWhite, + #[serde(rename = "techno_noir_black_white")] + TechnoNoirBlackWhite, + #[serde(rename = "black_white_20s")] + BlackWhite20s, + #[serde(rename = "cyberpunk_anime")] + CyberpunkAnime, + #[serde(rename = "dragonball")] + Dragonball, + #[serde(rename = "realistic_matrix")] + RealisticMatrix, + #[serde(rename = "realistic_cyberpunk")] + RealisticCyberpunk, + + // New Styles (2024-06-27) + + #[serde(rename = "dreamer")] // TODO: Land this in Gitub + Dreamer, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(StyleTransferName); +//impl_mysql_enum_coders!(StyleTransferName); +//impl_mysql_from_row!(StyleTransferName); + +/// NB: Legacy API for older code. +impl StyleTransferName { + pub fn to_str(&self) -> &'static str { + match self { + Self::Anime2_5D => "anime_2_5d", + Self::Anime2DFlat => "anime_2d_flat", + Self::Cartoon3D => "cartoon_3d", + Self::ComicBook => "comic_book", + Self::AnimeGhibli => "anime_ghibli", + Self::InkPunk => "ink_punk", + Self::InkSplash => "ink_splash", + Self::InkBWStyle => "ink_bw_style", + Self::JojoStyle => "jojo_style", + Self::PaperOrigami => "paper_origami", + Self::PixelArt => "pixel_art", + Self::PopArt => "pop_art", + Self::Realistic1 => "realistic_1", + Self::Realistic2 => "realistic_2", + Self::AnimeRetroNeon => "anime_retro_neon", + Self::AnimeStandard => "anime_standard", + + // New Styles (2024-05-03) + Self::HrGiger => "hr_giger", + Self::Simpsons => "simpsons", + Self::Carnage => "carnage", + Self::AnimePastelCute => "pastel_cute_anime", // TODO: Rename + Self::BloomLighting => "bloom_lighting", + Self::Horror2_5D => "25d_horror", // TODO: Rename + Self::Creepy => "creepy", + Self::CreepyVhs => "creepy_vhs", + Self::TrailCamFootage => "trail_cam_footage", + Self::OldBlackWhiteMovie => "old_black_white_movie", + Self::HorrorNoirBlackWhite => "horror_noir_black_white", + Self::TechnoNoirBlackWhite => "techno_noir_black_white", + Self::BlackWhite20s => "black_white_20s", + Self::CyberpunkAnime => "cyberpunk_anime", + Self::Dragonball => "dragonball", + Self::RealisticMatrix => "realistic_matrix", + Self::RealisticCyberpunk => "realistic_cyberpunk", + + // New Styles (2024-06-27) + Self::Dreamer => "dreamer", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "anime_2_5d" => Ok(Self::Anime2_5D), + "anime_2d_flat" => Ok(Self::Anime2DFlat), + "cartoon_3d" => Ok(Self::Cartoon3D), + "comic_book" => Ok(Self::ComicBook), + "anime_ghibli" => Ok(Self::AnimeGhibli), + "ink_punk" => Ok(Self::InkPunk), + "ink_splash" => Ok(Self::InkSplash), + "ink_bw_style" => Ok(Self::InkBWStyle), + "jojo_style" => Ok(Self::JojoStyle), + "paper_origami" => Ok(Self::PaperOrigami), + "pixel_art" => Ok(Self::PixelArt), + "pop_art" => Ok(Self::PopArt), + "realistic_1" => Ok(Self::Realistic1), + "realistic_2" => Ok(Self::Realistic2), + "anime_retro_neon" => Ok(Self::AnimeRetroNeon), + "anime_standard" => Ok(Self::AnimeStandard), + // New styles + "hr_giger" => Ok(Self::HrGiger), + "simpsons" => Ok(Self::Simpsons), + "carnage" => Ok(Self::Carnage), + "pastel_cute_anime" => Ok(Self::AnimePastelCute), // TODO: Rename + "bloom_lighting" => Ok(Self::BloomLighting), + "25d_horror" => Ok(Self::Horror2_5D), // TODO: Rename + "creepy" => Ok(Self::Creepy), + "creepy_vhs" => Ok(Self::CreepyVhs), + "trail_cam_footage" => Ok(Self::TrailCamFootage), + "old_black_white_movie" => Ok(Self::OldBlackWhiteMovie), + "horror_noir_black_white" => Ok(Self::HorrorNoirBlackWhite), + "techno_noir_black_white" => Ok(Self::TechnoNoirBlackWhite), + "black_white_20s" => Ok(Self::BlackWhite20s), + "cyberpunk_anime" => Ok(Self::CyberpunkAnime), + "dragonball" => Ok(Self::Dragonball), + "realistic_matrix" => Ok(Self::RealisticMatrix), + "realistic_cyberpunk" => Ok(Self::RealisticCyberpunk), + "dreamer" => Ok(Self::Dreamer), + _ => Err(format!("Unknown StyleTransferName: {}", value)), + } + } + + pub fn to_filename(&self) -> &'static str { + match self { + Self::Anime2_5D => "1_2.5d_anime_model.json", + Self::Anime2DFlat => "2_2d_flat_anime_model.json", + Self::Cartoon3D => "3_3d_cartoon_style.json", + Self::ComicBook => "4_comic_book_model.json", + Self::AnimeGhibli => "5_ghibli_anime_model.json", + Self::InkPunk => "6_ink_punk.json", + Self::InkSplash => "7_ink_splash.json", + Self::InkBWStyle => "8_ink_w_and_b_style.json", + Self::JojoStyle => "9_jojo_style.json", + Self::PaperOrigami => "10_paper_origami.json", + Self::PixelArt => "11_pixel_art.json", + Self::PopArt => "12_pop_art.json", + Self::Realistic1 => "13_realistic_1.json", + Self::Realistic2 => "14_realistic_2.json", + Self::AnimeRetroNeon => "15_retro_neon_anime_90.json", + Self::AnimeStandard => "16_standard_anime_model.json", + + Self::HrGiger => "17_hr_giger.json", + Self::Simpsons => "18_simpsons.json", + Self::Carnage => "19_carnage.json", + Self::AnimePastelCute => "20_pastel_cute_anime.json", + Self::BloomLighting => "21_bloom_lighting.json", + Self::Horror2_5D => "22_25D_Horror.json", + Self::Creepy => "23_creepy.json", + Self::CreepyVhs => "24_creepy_vhs.json", + Self::TrailCamFootage => "25_trail_cam_footage.json", + Self::OldBlackWhiteMovie => "26_old_black_white_movie.json", + Self::HorrorNoirBlackWhite => "27_horror_noir_black_white.json", + Self::TechnoNoirBlackWhite => "28_techno_noir_black_white.json", + Self::BlackWhite20s => "29_black_white_20s.json", + Self::CyberpunkAnime => "30_cyberpunk_anime.json", + Self::Dragonball => "31_dragonball.json", + Self::RealisticMatrix => "32_realistic_matrix.json", + Self::RealisticCyberpunk => "33_realistic_cyberpunk.json", + Self::Dreamer => "34_dreamer.json", + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Anime2_5D, + Self::Anime2DFlat, + Self::Cartoon3D, + Self::ComicBook, + Self::AnimeGhibli, + Self::InkPunk, + Self::InkSplash, + Self::InkBWStyle, + Self::JojoStyle, + Self::PaperOrigami, + Self::PixelArt, + Self::PopArt, + Self::Realistic1, + Self::Realistic2, + Self::AnimeRetroNeon, + Self::AnimeStandard, + + Self::HrGiger, + Self::Simpsons, + Self::Carnage, + Self::AnimePastelCute, + Self::BloomLighting, + Self::Horror2_5D, + Self::Creepy, + Self::CreepyVhs, + Self::TrailCamFootage, + Self::OldBlackWhiteMovie, + Self::HorrorNoirBlackWhite, + Self::TechnoNoirBlackWhite, + Self::BlackWhite20s, + Self::CyberpunkAnime, + Self::Dragonball, + Self::RealisticMatrix, + Self::RealisticCyberpunk, + + Self::Dreamer, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::no_table::style_transfer::style_transfer_name::StyleTransferName; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(StyleTransferName::Anime2_5D, "anime_2_5d"); + assert_serialization(StyleTransferName::Anime2DFlat, "anime_2d_flat"); + assert_serialization(StyleTransferName::Cartoon3D, "cartoon_3d"); + assert_serialization(StyleTransferName::ComicBook, "comic_book"); + assert_serialization(StyleTransferName::AnimeGhibli, "anime_ghibli"); + assert_serialization(StyleTransferName::InkPunk, "ink_punk"); + assert_serialization(StyleTransferName::InkSplash, "ink_splash"); + assert_serialization(StyleTransferName::InkBWStyle, "ink_bw_style"); + assert_serialization(StyleTransferName::JojoStyle, "jojo_style"); + assert_serialization(StyleTransferName::PaperOrigami, "paper_origami"); + assert_serialization(StyleTransferName::PixelArt, "pixel_art"); + assert_serialization(StyleTransferName::PopArt, "pop_art"); + assert_serialization(StyleTransferName::Realistic1, "realistic_1"); + assert_serialization(StyleTransferName::Realistic2, "realistic_2"); + assert_serialization(StyleTransferName::AnimeRetroNeon, "anime_retro_neon"); + assert_serialization(StyleTransferName::AnimeStandard, "anime_standard"); + + assert_serialization(StyleTransferName::HrGiger, "hr_giger"); + assert_serialization(StyleTransferName::Simpsons, "simpsons"); + assert_serialization(StyleTransferName::Carnage, "carnage"); + assert_serialization(StyleTransferName::AnimePastelCute, "pastel_cute_anime"); + assert_serialization(StyleTransferName::BloomLighting, "bloom_lighting"); + assert_serialization(StyleTransferName::Horror2_5D, "25d_horror"); + assert_serialization(StyleTransferName::Creepy, "creepy"); + assert_serialization(StyleTransferName::CreepyVhs, "creepy_vhs"); + assert_serialization(StyleTransferName::TrailCamFootage, "trail_cam_footage"); + assert_serialization(StyleTransferName::OldBlackWhiteMovie, "old_black_white_movie"); + assert_serialization(StyleTransferName::HorrorNoirBlackWhite, "horror_noir_black_white"); + assert_serialization(StyleTransferName::TechnoNoirBlackWhite, "techno_noir_black_white"); + assert_serialization(StyleTransferName::BlackWhite20s, "black_white_20s"); + assert_serialization(StyleTransferName::CyberpunkAnime, "cyberpunk_anime"); + assert_serialization(StyleTransferName::Dragonball, "dragonball"); + assert_serialization(StyleTransferName::RealisticMatrix, "realistic_matrix"); + assert_serialization(StyleTransferName::RealisticCyberpunk, "realistic_cyberpunk"); + + assert_serialization(StyleTransferName::Dreamer, "dreamer"); + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(StyleTransferName::Anime2_5D.to_str(), "anime_2_5d"); + assert_eq!(StyleTransferName::Anime2DFlat.to_str(), "anime_2d_flat"); + assert_eq!(StyleTransferName::Cartoon3D.to_str(), "cartoon_3d"); + assert_eq!(StyleTransferName::ComicBook.to_str(), "comic_book"); + assert_eq!(StyleTransferName::AnimeGhibli.to_str(), "anime_ghibli"); + assert_eq!(StyleTransferName::InkPunk.to_str(), "ink_punk"); + assert_eq!(StyleTransferName::InkSplash.to_str(), "ink_splash"); + assert_eq!(StyleTransferName::InkBWStyle.to_str(), "ink_bw_style"); + assert_eq!(StyleTransferName::JojoStyle.to_str(), "jojo_style"); + assert_eq!(StyleTransferName::PaperOrigami.to_str(), "paper_origami"); + assert_eq!(StyleTransferName::PixelArt.to_str(), "pixel_art"); + assert_eq!(StyleTransferName::PopArt.to_str(), "pop_art"); + assert_eq!(StyleTransferName::Realistic1.to_str(), "realistic_1"); + assert_eq!(StyleTransferName::Realistic2.to_str(), "realistic_2"); + assert_eq!(StyleTransferName::AnimeRetroNeon.to_str(), "anime_retro_neon"); + assert_eq!(StyleTransferName::AnimeStandard.to_str(), "anime_standard"); + + assert_eq!(StyleTransferName::HrGiger.to_str(), "hr_giger"); + assert_eq!(StyleTransferName::Simpsons.to_str(), "simpsons"); + assert_eq!(StyleTransferName::Carnage.to_str(), "carnage"); + assert_eq!(StyleTransferName::AnimePastelCute.to_str(), "pastel_cute_anime"); + assert_eq!(StyleTransferName::BloomLighting.to_str(), "bloom_lighting"); + assert_eq!(StyleTransferName::Horror2_5D.to_str(), "25d_horror"); + assert_eq!(StyleTransferName::Creepy.to_str(), "creepy"); + assert_eq!(StyleTransferName::CreepyVhs.to_str(), "creepy_vhs"); + assert_eq!(StyleTransferName::TrailCamFootage.to_str(), "trail_cam_footage"); + assert_eq!(StyleTransferName::OldBlackWhiteMovie.to_str(), "old_black_white_movie"); + assert_eq!(StyleTransferName::HorrorNoirBlackWhite.to_str(), "horror_noir_black_white"); + assert_eq!(StyleTransferName::TechnoNoirBlackWhite.to_str(), "techno_noir_black_white"); + assert_eq!(StyleTransferName::BlackWhite20s.to_str(), "black_white_20s"); + assert_eq!(StyleTransferName::CyberpunkAnime.to_str(), "cyberpunk_anime"); + assert_eq!(StyleTransferName::Dragonball.to_str(), "dragonball"); + assert_eq!(StyleTransferName::RealisticMatrix.to_str(), "realistic_matrix"); + assert_eq!(StyleTransferName::RealisticCyberpunk.to_str(), "realistic_cyberpunk"); + + assert_eq!(StyleTransferName::Dreamer.to_str(), "dreamer"); + } + + #[test] + fn from_str() { + assert_eq!(StyleTransferName::from_str("anime_2_5d").unwrap(), StyleTransferName::Anime2_5D); + assert_eq!(StyleTransferName::from_str("anime_2d_flat").unwrap(), StyleTransferName::Anime2DFlat); + assert_eq!(StyleTransferName::from_str("cartoon_3d").unwrap(), StyleTransferName::Cartoon3D); + assert_eq!(StyleTransferName::from_str("comic_book").unwrap(), StyleTransferName::ComicBook); + assert_eq!(StyleTransferName::from_str("anime_ghibli").unwrap(), StyleTransferName::AnimeGhibli); + assert_eq!(StyleTransferName::from_str("ink_punk").unwrap(), StyleTransferName::InkPunk); + assert_eq!(StyleTransferName::from_str("ink_splash").unwrap(), StyleTransferName::InkSplash); + assert_eq!(StyleTransferName::from_str("ink_bw_style").unwrap(), StyleTransferName::InkBWStyle); + assert_eq!(StyleTransferName::from_str("jojo_style").unwrap(), StyleTransferName::JojoStyle); + assert_eq!(StyleTransferName::from_str("paper_origami").unwrap(), StyleTransferName::PaperOrigami); + assert_eq!(StyleTransferName::from_str("pixel_art").unwrap(), StyleTransferName::PixelArt); + assert_eq!(StyleTransferName::from_str("pop_art").unwrap(), StyleTransferName::PopArt); + assert_eq!(StyleTransferName::from_str("realistic_1").unwrap(), StyleTransferName::Realistic1); + assert_eq!(StyleTransferName::from_str("realistic_2").unwrap(), StyleTransferName::Realistic2); + assert_eq!(StyleTransferName::from_str("anime_retro_neon").unwrap(), StyleTransferName::AnimeRetroNeon); + assert_eq!(StyleTransferName::from_str("anime_standard").unwrap(), StyleTransferName::AnimeStandard); + + assert_eq!(StyleTransferName::from_str("hr_giger").unwrap(), StyleTransferName::HrGiger); + assert_eq!(StyleTransferName::from_str("simpsons").unwrap(), StyleTransferName::Simpsons); + assert_eq!(StyleTransferName::from_str("carnage").unwrap(), StyleTransferName::Carnage); + assert_eq!(StyleTransferName::from_str("pastel_cute_anime").unwrap(), StyleTransferName::AnimePastelCute); + assert_eq!(StyleTransferName::from_str("bloom_lighting").unwrap(), StyleTransferName::BloomLighting); + assert_eq!(StyleTransferName::from_str("25d_horror").unwrap(), StyleTransferName::Horror2_5D); + assert_eq!(StyleTransferName::from_str("creepy").unwrap(), StyleTransferName::Creepy); + assert_eq!(StyleTransferName::from_str("creepy_vhs").unwrap(), StyleTransferName::CreepyVhs); + assert_eq!(StyleTransferName::from_str("trail_cam_footage").unwrap(), StyleTransferName::TrailCamFootage); + assert_eq!(StyleTransferName::from_str("old_black_white_movie").unwrap(), StyleTransferName::OldBlackWhiteMovie); + assert_eq!(StyleTransferName::from_str("horror_noir_black_white").unwrap(), StyleTransferName::HorrorNoirBlackWhite); + assert_eq!(StyleTransferName::from_str("techno_noir_black_white").unwrap(), StyleTransferName::TechnoNoirBlackWhite); + assert_eq!(StyleTransferName::from_str("black_white_20s").unwrap(), StyleTransferName::BlackWhite20s); + assert_eq!(StyleTransferName::from_str("cyberpunk_anime").unwrap(), StyleTransferName::CyberpunkAnime); + assert_eq!(StyleTransferName::from_str("dragonball").unwrap(), StyleTransferName::Dragonball); + assert_eq!(StyleTransferName::from_str("realistic_matrix").unwrap(), StyleTransferName::RealisticMatrix); + assert_eq!(StyleTransferName::from_str("realistic_cyberpunk").unwrap(), StyleTransferName::RealisticCyberpunk); + + assert_eq!(StyleTransferName::from_str("dreamer").unwrap(), StyleTransferName::Dreamer); + + assert!(StyleTransferName::from_str("foo").is_err()); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let variants = StyleTransferName::all_variants(); + assert_eq!(variants.len(), 34); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(StyleTransferName::all_variants().len(), StyleTransferName::iter().len()); + } + + #[test] + fn round_trip() { + for variant in StyleTransferName::all_variants() { + assert_eq!(variant, StyleTransferName::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, StyleTransferName::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, StyleTransferName::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } + } +} \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/video_dimensions/mod.rs b/crates/api_clients/artcraft_client/src/enums/no_table/video_dimensions/mod.rs new file mode 100644 index 00000000..6f8ed896 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/video_dimensions/mod.rs @@ -0,0 +1 @@ +mod video_dimensions; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/no_table/video_dimensions/video_dimensions.rs b/crates/api_clients/artcraft_client/src/enums/no_table/video_dimensions/video_dimensions.rs new file mode 100644 index 00000000..3a048fec --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/no_table/video_dimensions/video_dimensions.rs @@ -0,0 +1,116 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// This enum is not backed by a particular database table. +/// This is used to determine the video generation size. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum VideoDimensions { + Landscape, + Portrait, + Square, +} + +// TODO(bt, 2022-12-21): This desperately needs MySQL integration tests! +impl_enum_display_and_debug_using_to_str!(VideoDimensions); +//impl_mysql_enum_coders!(VideoDimensions); +//impl_mysql_from_row!(VideoDimensions); + +/// NB: Legacy API for older code. +impl VideoDimensions { + pub fn to_str(&self) -> &'static str { + match self { + Self::Landscape => "landscape", + Self::Portrait => "portrait", + Self::Square => "square", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "landscape" => Ok(Self::Landscape), + "portrait" => Ok(Self::Portrait), + "square" => Ok(Self::Square), + _ => Err(format!("Unknown VideoDimensions: {}", value)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Landscape, + Self::Portrait, + Self::Square, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::no_table::video_dimensions::video_dimensions::VideoDimensions; + use crate::enums::test_helpers::assert_serialization; + + mod serde { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(VideoDimensions::Landscape, "landscape"); + assert_serialization(VideoDimensions::Portrait, "portrait"); + assert_serialization(VideoDimensions::Square, "square"); + } + + mod impl_methods { + use super::*; + + #[test] + fn to_str() { + assert_eq!(VideoDimensions::Landscape.to_str(), "landscape"); + assert_eq!(VideoDimensions::Portrait.to_str(), "portrait"); + assert_eq!(VideoDimensions::Square.to_str(), "square"); + } + + #[test] + fn from_str() { + assert_eq!(VideoDimensions::from_str("landscape").unwrap(), VideoDimensions::Landscape); + assert_eq!(VideoDimensions::from_str("portrait").unwrap(), VideoDimensions::Portrait); + assert_eq!(VideoDimensions::from_str("square").unwrap(), VideoDimensions::Square); + } + } + + mod manual_variant_checks { + use super::*; + + #[test] + fn all_variants() { + let variants = VideoDimensions::all_variants(); + assert_eq!(variants.len(), 3); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(VideoDimensions::all_variants().len(), VideoDimensions::iter().len()); + } + + #[test] + fn round_trip() { + for variant in VideoDimensions::all_variants() { + assert_eq!(variant, VideoDimensions::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, VideoDimensions::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, VideoDimensions::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/tauri/mod.rs b/crates/api_clients/artcraft_client/src/enums/tauri/mod.rs new file mode 100644 index 00000000..84e618ad --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/tauri/mod.rs @@ -0,0 +1 @@ +pub mod ux; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/enums/tauri/ux/mod.rs b/crates/api_clients/artcraft_client/src/enums/tauri/ux/mod.rs new file mode 100644 index 00000000..e1c18292 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/tauri/ux/mod.rs @@ -0,0 +1 @@ +pub mod tauri_event_name; diff --git a/crates/api_clients/artcraft_client/src/enums/tauri/ux/tauri_event_name.rs b/crates/api_clients/artcraft_client/src/enums/tauri/ux/tauri_event_name.rs new file mode 100644 index 00000000..3a8144b4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/tauri/ux/tauri_event_name.rs @@ -0,0 +1,333 @@ +use std::collections::BTreeSet; + +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Defines the names of the Tauri-sent events that the frontend subscribes to. +/// These event names are also stored in the database, so keep them short-ish. +/// +/// NB: Events should end in "_event" so they're easy to grep for in Javascript. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TauriEventName { + // TODO: Get rid of kebab case. + /// General purpose event: + /// Generation enqueued + #[serde(rename = "generation-enqueue-success-event")] + GenerationEnqueueSuccessEvent, + + // TODO: Get rid of kebab case. + /// General purpose event: + /// Generation failed to enqueue + #[serde(rename = "generation-enqueue-failure-event")] + GenerationEnqueueFailureEvent, + + // TODO: Get rid of kebab case. + /// General purpose event: + /// Generation completed successfully + #[serde(rename = "generation-complete-event")] + GenerationCompleteEvent, + + // TODO: Get rid of kebab case. + /// General purpose event: + /// Generation failed + #[serde(rename = "generation-failed-event")] + GenerationFailedEvent, + + /// Informational event: + /// Credits were purchased or spent (but we don't know how much) + #[serde(rename = "credits_balance_changed_event")] + CreditsBalanceChangedEvent, + + /// Informational event: + /// The app preferences were saved; re-read them. + #[serde(rename = "app_preferences_changed_event")] + AppPreferencesChangedEvent, + + /// Informational event: + /// Subscription was changed (but we don't know the details - upgrade, cancel, etc.) + #[serde(rename = "subscription_plan_changed_event")] + SubscriptionPlanChangedEvent, + + /// Special event: + /// Image generation is complete + #[serde(rename = "text_to_image_generation_complete_event")] + TextToImageGenerationCompleteEvent, + + /// Special event: + /// Object (3D mesh) generation is complete + #[serde(rename = "object_generation_complete_event")] + ObjectGenerationCompleteEvent, + + /// Special event: + /// Gaussian generation is complete + #[serde(rename = "gaussian_generation_complete_event")] + GaussianGenerationCompleteEvent, + + /// Special event: + /// Video generation is complete + #[serde(rename = "video_generation_complete_event")] + VideoGenerationCompleteEvent, + + /// Special event: + /// Refresh account states + #[serde(rename = "refresh_account_state_event")] + RefreshAccountStateEvent, + + /// Special event: + /// The thumbnail worker produced a thumbnail for a downloaded file + #[serde(rename = "local_thumbnail_ready_event")] + LocalThumbnailReadyEvent, + + /// Special event: + /// Show a billing modal (a suggestion to pay, etc. for a specific provider) + #[serde(rename = "show_provider_billing_modal_event")] + ShowProviderBillingModalEvent, + + /// Special event: + /// Show a dismissable modal explaining a credential problem (missing, + /// unknown, or unusable credential for a generation request) + #[serde(rename = "show_credential_error_modal_event")] + ShowCredentialErrorModalEvent, + + /// Notice event: + /// Flash an informational (non-error) message, e.g. "Your library was + /// refreshed". + #[serde(rename = "flash_notice_event")] + FlashNoticeEvent, + + /// Notice event: + /// A long-running backend step started or finished, e.g. Higgsfield's + /// IP/likeness check on uploaded media. The frontend shows a progress + /// toast on `started` and takes it down on `finished`. + #[serde(rename = "progress_notice_event")] + ProgressNoticeEvent, + + /// Warning event: + /// Flash a user input error message + #[serde(rename = "flash_user_input_error_event")] + FlashUserInputErrorEvent, + + /// Warning event: + /// File with that name was already downloaded + #[serde(rename = "flash_file_download_error_event")] + FlashFileDownloadErrorEvent, +} + +impl_enum_display_and_debug_using_to_str!(TauriEventName); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl TauriEventName { + pub fn to_str(&self) -> &'static str { + match self { + Self::GenerationEnqueueSuccessEvent => "generation-enqueue-success-event", + Self::GenerationEnqueueFailureEvent => "generation-enqueue-failure-event", + Self::GenerationCompleteEvent => "generation-complete-event", + Self::GenerationFailedEvent => "generation-failed-event", + Self::CreditsBalanceChangedEvent => "credits_balance_changed_event", + Self::AppPreferencesChangedEvent => "app_preferences_changed_event", + Self::SubscriptionPlanChangedEvent => "subscription_plan_changed_event", + Self::TextToImageGenerationCompleteEvent => "text_to_image_generation_complete_event", + Self::ObjectGenerationCompleteEvent => "object_generation_complete_event", + Self::GaussianGenerationCompleteEvent => "gaussian_generation_complete_event", + Self::VideoGenerationCompleteEvent => "video_generation_complete_event", + Self::RefreshAccountStateEvent => "refresh_account_state_event", + Self::LocalThumbnailReadyEvent => "local_thumbnail_ready_event", + Self::ShowProviderBillingModalEvent => "show_provider_billing_modal_event", + Self::ShowCredentialErrorModalEvent => "show_credential_error_modal_event", + Self::FlashNoticeEvent => "flash_notice_event", + Self::ProgressNoticeEvent => "progress_notice_event", + Self::FlashUserInputErrorEvent => "flash_user_input_error_event", + Self::FlashFileDownloadErrorEvent => "flash_file_download_error_event", + } + } + + pub fn from_str(job_status: &str) -> Result { + match job_status { + "generation-enqueue-success-event" => Ok(Self::GenerationEnqueueSuccessEvent), + "generation-enqueue-failure-event" => Ok(Self::GenerationEnqueueFailureEvent), + "generation-complete-event" => Ok(Self::GenerationCompleteEvent), + "generation-failed-event" => Ok(Self::GenerationFailedEvent), + "credits_balance_changed_event" => Ok(Self::CreditsBalanceChangedEvent), + "app_preferences_changed_event" => Ok(Self::AppPreferencesChangedEvent), + "subscription_plan_changed_event" => Ok(Self::SubscriptionPlanChangedEvent), + "text_to_image_generation_complete_event" => Ok(Self::TextToImageGenerationCompleteEvent), + "object_generation_complete_event" => Ok(Self::ObjectGenerationCompleteEvent), + "gaussian_generation_complete_event" => Ok(Self::GaussianGenerationCompleteEvent), + "video_generation_complete_event" => Ok(Self::VideoGenerationCompleteEvent), + "refresh_account_state_event" => Ok(Self::RefreshAccountStateEvent), + "local_thumbnail_ready_event" => Ok(Self::LocalThumbnailReadyEvent), + "show_provider_billing_modal_event" => Ok(Self::ShowProviderBillingModalEvent), + "show_credential_error_modal_event" => Ok(Self::ShowCredentialErrorModalEvent), + "flash_notice_event" => Ok(Self::FlashNoticeEvent), + "progress_notice_event" => Ok(Self::ProgressNoticeEvent), + "flash_user_input_error_event" => Ok(Self::FlashUserInputErrorEvent), + "flash_file_download_error_event" => Ok(Self::FlashFileDownloadErrorEvent), + _ => Err(format!("invalid tauri_event_name: {:?}", job_status)), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::GenerationEnqueueSuccessEvent, + Self::GenerationEnqueueFailureEvent, + Self::GenerationCompleteEvent, + Self::GenerationFailedEvent, + Self::CreditsBalanceChangedEvent, + Self::AppPreferencesChangedEvent, + Self::SubscriptionPlanChangedEvent, + Self::TextToImageGenerationCompleteEvent, + Self::ObjectGenerationCompleteEvent, + Self::GaussianGenerationCompleteEvent, + Self::VideoGenerationCompleteEvent, + Self::RefreshAccountStateEvent, + Self::LocalThumbnailReadyEvent, + Self::ShowProviderBillingModalEvent, + Self::ShowCredentialErrorModalEvent, + Self::FlashNoticeEvent, + Self::ProgressNoticeEvent, + Self::FlashUserInputErrorEvent, + Self::FlashFileDownloadErrorEvent, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::tauri::ux::tauri_event_name::TauriEventName; + use crate::enums::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(TauriEventName::GenerationEnqueueSuccessEvent, "generation-enqueue-success-event"); + assert_serialization(TauriEventName::GenerationEnqueueFailureEvent, "generation-enqueue-failure-event"); + assert_serialization(TauriEventName::GenerationCompleteEvent, "generation-complete-event"); + assert_serialization(TauriEventName::GenerationFailedEvent, "generation-failed-event"); + assert_serialization(TauriEventName::CreditsBalanceChangedEvent, "credits_balance_changed_event"); + assert_serialization(TauriEventName::AppPreferencesChangedEvent, "app_preferences_changed_event"); + assert_serialization(TauriEventName::SubscriptionPlanChangedEvent, "subscription_plan_changed_event"); + assert_serialization(TauriEventName::TextToImageGenerationCompleteEvent, "text_to_image_generation_complete_event"); + assert_serialization(TauriEventName::ObjectGenerationCompleteEvent, "object_generation_complete_event"); + assert_serialization(TauriEventName::GaussianGenerationCompleteEvent, "gaussian_generation_complete_event"); + assert_serialization(TauriEventName::VideoGenerationCompleteEvent, "video_generation_complete_event"); + assert_serialization(TauriEventName::RefreshAccountStateEvent, "refresh_account_state_event"); + assert_serialization(TauriEventName::LocalThumbnailReadyEvent, "local_thumbnail_ready_event"); + assert_serialization(TauriEventName::ShowProviderBillingModalEvent, "show_provider_billing_modal_event"); + assert_serialization(TauriEventName::ShowCredentialErrorModalEvent, "show_credential_error_modal_event"); + assert_serialization(TauriEventName::FlashNoticeEvent, "flash_notice_event"); + assert_serialization(TauriEventName::ProgressNoticeEvent, "progress_notice_event"); + assert_serialization(TauriEventName::FlashUserInputErrorEvent, "flash_user_input_error_event"); + assert_serialization(TauriEventName::FlashFileDownloadErrorEvent, "flash_file_download_error_event"); + } + + #[test] + fn to_str() { + assert_eq!(TauriEventName::GenerationEnqueueSuccessEvent.to_str(), "generation-enqueue-success-event"); + assert_eq!(TauriEventName::GenerationEnqueueFailureEvent.to_str(), "generation-enqueue-failure-event"); + assert_eq!(TauriEventName::GenerationCompleteEvent.to_str(), "generation-complete-event"); + assert_eq!(TauriEventName::GenerationFailedEvent.to_str(), "generation-failed-event"); + assert_eq!(TauriEventName::CreditsBalanceChangedEvent.to_str(), "credits_balance_changed_event"); + assert_eq!(TauriEventName::AppPreferencesChangedEvent.to_str(), "app_preferences_changed_event"); + assert_eq!(TauriEventName::SubscriptionPlanChangedEvent.to_str(), "subscription_plan_changed_event"); + assert_eq!(TauriEventName::TextToImageGenerationCompleteEvent.to_str(), "text_to_image_generation_complete_event"); + assert_eq!(TauriEventName::ObjectGenerationCompleteEvent.to_str(), "object_generation_complete_event"); + assert_eq!(TauriEventName::GaussianGenerationCompleteEvent.to_str(), "gaussian_generation_complete_event"); + assert_eq!(TauriEventName::VideoGenerationCompleteEvent.to_str(), "video_generation_complete_event"); + assert_eq!(TauriEventName::RefreshAccountStateEvent.to_str(), "refresh_account_state_event"); + assert_eq!(TauriEventName::LocalThumbnailReadyEvent.to_str(), "local_thumbnail_ready_event"); + assert_eq!(TauriEventName::ShowProviderBillingModalEvent.to_str(), "show_provider_billing_modal_event"); + assert_eq!(TauriEventName::FlashNoticeEvent.to_str(), "flash_notice_event"); + assert_eq!(TauriEventName::ProgressNoticeEvent.to_str(), "progress_notice_event"); + assert_eq!(TauriEventName::FlashUserInputErrorEvent.to_str(), "flash_user_input_error_event"); + assert_eq!(TauriEventName::FlashFileDownloadErrorEvent.to_str(), "flash_file_download_error_event"); + } + + #[test] + fn from_str() { + assert_eq!(TauriEventName::from_str("generation-enqueue-success-event").unwrap(), TauriEventName::GenerationEnqueueSuccessEvent); + assert_eq!(TauriEventName::from_str("generation-enqueue-failure-event").unwrap(), TauriEventName::GenerationEnqueueFailureEvent); + assert_eq!(TauriEventName::from_str("generation-complete-event").unwrap(), TauriEventName::GenerationCompleteEvent); + assert_eq!(TauriEventName::from_str("generation-failed-event").unwrap(), TauriEventName::GenerationFailedEvent); + assert_eq!(TauriEventName::from_str("credits_balance_changed_event").unwrap(), TauriEventName::CreditsBalanceChangedEvent); + assert_eq!(TauriEventName::from_str("app_preferences_changed_event").unwrap(), TauriEventName::AppPreferencesChangedEvent); + assert_eq!(TauriEventName::from_str("subscription_plan_changed_event").unwrap(), TauriEventName::SubscriptionPlanChangedEvent); + assert_eq!(TauriEventName::from_str("text_to_image_generation_complete_event").unwrap(), TauriEventName::TextToImageGenerationCompleteEvent); + assert_eq!(TauriEventName::from_str("object_generation_complete_event").unwrap(), TauriEventName::ObjectGenerationCompleteEvent); + assert_eq!(TauriEventName::from_str("gaussian_generation_complete_event").unwrap(), TauriEventName::GaussianGenerationCompleteEvent); + assert_eq!(TauriEventName::from_str("video_generation_complete_event").unwrap(), TauriEventName::VideoGenerationCompleteEvent); + assert_eq!(TauriEventName::from_str("refresh_account_state_event").unwrap(), TauriEventName::RefreshAccountStateEvent); + assert_eq!(TauriEventName::from_str("local_thumbnail_ready_event").unwrap(), TauriEventName::LocalThumbnailReadyEvent); + assert_eq!(TauriEventName::from_str("show_provider_billing_modal_event").unwrap(), TauriEventName::ShowProviderBillingModalEvent); + assert_eq!(TauriEventName::from_str("show_credential_error_modal_event").unwrap(), TauriEventName::ShowCredentialErrorModalEvent); + assert_eq!(TauriEventName::from_str("flash_notice_event").unwrap(), TauriEventName::FlashNoticeEvent); + assert_eq!(TauriEventName::from_str("progress_notice_event").unwrap(), TauriEventName::ProgressNoticeEvent); + assert_eq!(TauriEventName::from_str("flash_user_input_error_event").unwrap(), TauriEventName::FlashUserInputErrorEvent); + assert_eq!(TauriEventName::from_str("flash_file_download_error_event").unwrap(), TauriEventName::FlashFileDownloadErrorEvent); + } + + #[test] + fn all_variants() { + let mut variants = TauriEventName::all_variants(); + assert_eq!(variants.len(), 19); + assert_eq!(variants.pop_first(), Some(TauriEventName::GenerationEnqueueSuccessEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::GenerationEnqueueFailureEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::GenerationCompleteEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::GenerationFailedEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::CreditsBalanceChangedEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::AppPreferencesChangedEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::SubscriptionPlanChangedEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::TextToImageGenerationCompleteEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::ObjectGenerationCompleteEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::GaussianGenerationCompleteEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::VideoGenerationCompleteEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::RefreshAccountStateEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::LocalThumbnailReadyEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::ShowProviderBillingModalEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::ShowCredentialErrorModalEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::FlashNoticeEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::ProgressNoticeEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::FlashUserInputErrorEvent)); + assert_eq!(variants.pop_first(), Some(TauriEventName::FlashFileDownloadErrorEvent)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + use strum::IntoEnumIterator; + + #[test] + fn variant_length() { + assert_eq!(TauriEventName::all_variants().len(), TauriEventName::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TauriEventName::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, TauriEventName::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TauriEventName::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TauriEventName::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + //#[test] + //fn serialized_length_ok_for_database() { + // const MAX_LENGTH : usize = 16; + // for variant in TauriEventName::all_variants() { + // let serialized = variant.to_str(); + // assert!(serialized.len() > 0, "variant {:?} is too short", variant); + // assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + // } + //} + } +} diff --git a/crates/api_clients/artcraft_client/src/enums/test_helpers.rs b/crates/api_clients/artcraft_client/src/enums/test_helpers.rs new file mode 100644 index 00000000..fdb23e0a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/enums/test_helpers.rs @@ -0,0 +1,27 @@ +//! Only imported in tests + +use serde::Serialize; + +pub fn to_toml(t: &T) -> String { + match toml::to_string(t) { + Ok(s) => s.replace("\"", ""), // JSON values are quoted, so we remove quotes + Err(err) => { + panic!("serialization error: {}", err); + } + } +} + +pub fn to_json(t: &T) -> String { + serde_json::to_string(t) + .expect("serialization error") + .replace("\"", "") // JSON values are quoted, so we remove quotes +} + +/// Assert that the Serialize is represented by the expected string value. +/// This is useful for ensuring stability of serialization. +pub fn assert_serialization(t: T, expected: &str) { + // TODO: See if there's a way to check the sqlx serialization + // TODO(bt,2024-06-27): Something broke with serde toml serialization, so we're disabling it + // assert_eq!(&to_toml(&t), expected); + assert_eq!(&to_json(&t), expected); +} diff --git a/crates/api_clients/artcraft_client/src/error/api_error.rs b/crates/api_clients/artcraft_client/src/error/api_error.rs new file mode 100644 index 00000000..cca046f7 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/error/api_error.rs @@ -0,0 +1,129 @@ +use cloudflare_errors::cloudflare_error::CloudflareError; +use errors::AnyhowError; +use reqwest::StatusCode; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::io; + +#[derive(Debug)] +pub enum ApiError { + /// 400. The request was invalid. + InvalidRequest(String), + + /// 401. The request was not authorized. + Unauthorized(String), + + // 402. Payment required. + PaymentRequired(String), + + /// 403. The request was forbidden. + Forbidden(String), + + /// 404. The requested resource was not found. + NotFound(String), + + /// 429. Too many requests. + TooManyRequests(String), + + /// 500. An internal server error occurred. + InternalServerError { + body: String, + backend_hostname: Option, + }, + + /// An uncategorized bad HTTP response with status code and body. + UncategorizedBadResponseWithStatusAndBody { + status_code: StatusCode, + body: String, + }, + + /// Cloudflare errors. + CloudflareError(CloudflareError), + + /// A deserialization error with the response. + DeserializationError(serde_json::Error), + + /// The request timed out. + Timeout(String), + + /// A network error occurred. + NetworkError(String), + + /// Uncategorized reqwest error. + OtherReqwestError(reqwest::Error), + + /// An error doing file I/O (on our side) + IoError(io::Error), + + /// Another type of error. + Other(AnyhowError), +} + +impl Error for ApiError {} + +impl Display for ApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + // Server response code errors + ApiError::InvalidRequest(msg) => write!(f, "Invalid request: {}", msg), + ApiError::PaymentRequired(msg) => write!(f, "Payment required: {}", msg), + ApiError::Unauthorized(msg) => write!(f, "Unauthorized: {}", msg), + ApiError::Forbidden(msg) => write!(f, "Forbidden: {}", msg), + ApiError::NotFound(msg) => write!(f, "Not found: {}", msg), + ApiError::TooManyRequests(msg) => write!(f, "Too many requests to Storyteller backend: {}", msg), + ApiError::InternalServerError {body, backend_hostname} => + write!(f, "Internal Server Error; backend hostname: {:?} ; body: {}; ", backend_hostname, body), + ApiError::UncategorizedBadResponseWithStatusAndBody { status_code, body } => + write!(f, "Uncategorized bad response with status code {} and body: {}", status_code, body), + // Server response handling errors + ApiError::DeserializationError(error) => write!(f, "Deserialization error: {}", error), + // Network errors + ApiError::Timeout(msg) => write!(f, "Timeout: {}", msg), + ApiError::NetworkError(msg) => write!(f, "Network error: {}", msg), + // Cloudflare errors + ApiError::CloudflareError(error) => write!(f, "Cloudflare Error: {}", error), + // I/O errors + ApiError::IoError(error) => write!(f, "IO error: {}", error), + // Other + ApiError::OtherReqwestError(error) => write!(f, "Reqwest error: {}", error), + ApiError::Other(error) => write!(f, "Other error: {}", error), + } + } +} + +impl From for ApiError { + fn from(error: reqwest::Error) -> Self { + if let Some(status) = error.status() { + let status = status.as_u16(); + match status { + 402 => return ApiError::PaymentRequired(error.to_string()), + _ => {} // NB: Fallthrough. + } + } + if error.is_timeout() { + ApiError::Timeout(error.to_string()) + } else if error.is_connect() { + ApiError::NetworkError(error.to_string()) + } else { + ApiError::OtherReqwestError(error) + } + } +} + +impl From for ApiError { + fn from(error: serde_json::Error) -> Self { + ApiError::DeserializationError(error) + } +} + +impl From for ApiError { + fn from(error: io::Error) -> Self { + ApiError::IoError(error) + } +} + +impl From for ApiError { + fn from(error: CloudflareError) -> Self { + ApiError::CloudflareError(error) + } +} diff --git a/crates/api_clients/artcraft_client/src/error/client_error.rs b/crates/api_clients/artcraft_client/src/error/client_error.rs new file mode 100644 index 00000000..75dc554c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/error/client_error.rs @@ -0,0 +1,60 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::io; +use std::path::PathBuf; +use crate::error::api_error::ApiError; + +/// An error arising from the client, either before or after the request is sent. +#[derive(Debug)] +pub enum ClientError { + /// An invalid request was detected before it was sent. + InvalidPreflightRequest(String), + + /// Could not determine the filetype for the file. + FileTypeNotKnown(PathBuf), + + /// Could not handle the file type. + FileTypeNotHandled(PathBuf), + + /// An error doing file I/O (on our side) + IoError(io::Error), + + /// An error setting up the client + ReqwestError(reqwest::Error), + + /// A serialization error with the request. + SerializationError(serde_json::Error), +} + +impl Error for ClientError {} + +impl Display for ClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::InvalidPreflightRequest(msg) => write!(f, "Invalid preflight request: {}", msg), + Self::FileTypeNotKnown(path) => write!(f, "Could not determine the filetype for the file: {:?}", path), + Self::FileTypeNotHandled(path) => write!(f, "Could not handle the file type for the file: {:?}", path), + Self::IoError(err) => write!(f, "IO error: {}", err), + Self::ReqwestError(err) => write!(f, "Reqwest client error: {}", err), + Self::SerializationError(err) => write!(f, "Request serialization error: {}", err), + } + } +} + +impl From for ClientError { + fn from(error: io::Error) -> Self { + ClientError::IoError(error) + } +} + +impl From for ClientError { + fn from(error: serde_json::Error) -> Self { + ClientError::SerializationError(error) + } +} + +impl From for ClientError { + fn from(error: reqwest::Error) -> Self { + ClientError::ReqwestError(error) + } +} diff --git a/crates/api_clients/artcraft_client/src/error/mod.rs b/crates/api_clients/artcraft_client/src/error/mod.rs new file mode 100644 index 00000000..4b238e77 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/error/mod.rs @@ -0,0 +1,3 @@ +pub mod api_error; +pub mod client_error; +pub mod storyteller_error; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/error/storyteller_error.rs b/crates/api_clients/artcraft_client/src/error/storyteller_error.rs new file mode 100644 index 00000000..30dbf854 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/error/storyteller_error.rs @@ -0,0 +1,32 @@ +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use std::error::Error; + +#[derive(Debug)] +pub enum StorytellerError { + Api(ApiError), + Client(ClientError), +} + +impl Error for StorytellerError {} + +impl std::fmt::Display for StorytellerError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + StorytellerError::Api(e) => write!(f, "Storyteller API error: {:?}", e), + StorytellerError::Client(e) => write!(f, "Storyteller Client error: {:?}", e), + } + } +} + +impl From for StorytellerError { + fn from(error: ApiError) -> Self { + StorytellerError::Api(error) + } +} + +impl From for StorytellerError { + fn from(error: ClientError) -> Self { + StorytellerError::Client(error) + } +} diff --git a/crates/api_clients/artcraft_client/src/lib.rs b/crates/api_clients/artcraft_client/src/lib.rs new file mode 100644 index 00000000..0f70fbaf --- /dev/null +++ b/crates/api_clients/artcraft_client/src/lib.rs @@ -0,0 +1,14 @@ +//! An API client for Artcraft / Storyteller / FakeYou + +#[macro_use] +extern crate serde_derive; + +pub mod api_defs; +pub mod credentials; +pub mod datatypes; +pub mod endpoints; +pub mod enums; +pub mod error; +pub mod recipes; +pub mod tokens; +pub mod utils; diff --git a/crates/api_clients/artcraft_client/src/recipes/download_media_file.rs b/crates/api_clients/artcraft_client/src/recipes/download_media_file.rs new file mode 100644 index 00000000..74f00b86 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/recipes/download_media_file.rs @@ -0,0 +1,157 @@ +use std::fs; +use std::io::Write; +use std::path::{Path, PathBuf}; + +use log::{info, warn}; +use reqwest::Client; +use url::Url; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::endpoints::media_files::get_media_file::{get_media_file, GetMediaFileSuccessResponse}; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; + +pub struct DownloadMediaFileArgs<'a, P: AsRef> { + pub media_token: &'a MediaFileToken, + pub api_host: &'a ApiHost, + pub download_path: DownloadPath

, +} + +pub enum DownloadPath> { + /// Write the file to this exact path. + ExactFilename(P), + /// Write the file into this directory, generating a filename from the CDN URL extension. + Directory(P), +} + +pub struct DownloadMediaFileResult { + /// The path the file was written to. + pub downloaded_file_path: PathBuf, + + /// The full media file response from the API. + pub media_file_response: GetMediaFileSuccessResponse, + + /// Size of downloaded file in bytes. + pub filesize_bytes: usize, +} + +pub async fn download_media_file>( + args: DownloadMediaFileArgs<'_, P>, +) -> Result { + let DownloadMediaFileArgs { + media_token, + api_host, + download_path + } = args; + + // 1. Fetch media file info from the API. + let response = get_media_file(api_host, media_token).await?; + let media_class = &response.media_file.media_class; + let cdn_url = &response.media_file.media_links.cdn_url; + + info!("Downloading media file {} of class {} from CDN: {}", + media_token.as_str(), media_class.to_str(), cdn_url); + + // 2. Determine the output file path. + let output_path = match &download_path { + DownloadPath::ExactFilename(path) => path.as_ref().to_path_buf(), + DownloadPath::Directory(dir) => { + let filename = derive_filename_from_url(cdn_url, &media_token); + dir.as_ref().join(filename) + } + }; + + // 3. Download the bytes from the CDN. + let bytes = download_bytes(cdn_url).await?; + + // 4. Write to disk. + let mut file = fs::File::create(&output_path) + .map_err(|err| StorytellerError::Client(ClientError::IoError(err)))?; + + file.write_all(&bytes) + .map_err(|err| StorytellerError::Client(ClientError::IoError(err)))?; + + file.flush() + .map_err(|err| StorytellerError::Client(ClientError::IoError(err)))?; + + info!("Downloaded {} bytes to {:?}", bytes.len(), output_path); + + Ok(DownloadMediaFileResult { + downloaded_file_path: output_path, + media_file_response: response, + filesize_bytes: bytes.len(), + }) +} + +// ── Helpers ── + +async fn download_bytes(url: &Url) -> Result, StorytellerError> { + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::ReqwestError(err)))?; + + let response = client.get(url.as_str()) + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::OtherReqwestError(err)))?; + + let status_code = response.status(); + + if !status_code.is_success() { + let body = response.text().await.unwrap_or_else(|err| { + warn!("Failed to retrieve response body: {}", err); + "".to_string() + }); + return Err(StorytellerError::Api(ApiError::UncategorizedBadResponseWithStatusAndBody { + status_code, + body, + })); + } + + let bytes = response.bytes() + .await + .map_err(|err| StorytellerError::Client(ClientError::ReqwestError(err)))?; + + Ok(bytes.to_vec()) +} + +/// Derive a filename from the CDN URL's path extension, falling back to the media token. +fn derive_filename_from_url(url: &Url, media_token: &MediaFileToken) -> String { + let path = url.path(); + let extension = Path::new(path) + .extension() // NB: without dot '.' + .and_then(|ext| ext.to_str()) + .unwrap_or("bin"); + + format!("{}.{}", media_token.as_str(), extension) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn derive_filename_from_url_extracts_extension() { + let url = Url::parse("https://cdn.example.com/files/abc123.png").unwrap(); + let token = MediaFileToken::new_from_str("mf_test123"); + assert_eq!(derive_filename_from_url(&url, &token), "mf_test123.png"); + } + + #[test] + fn derive_filename_from_url_handles_no_extension() { + let url = Url::parse("https://cdn.example.com/files/abc123").unwrap(); + let token = MediaFileToken::new_from_str("mf_test123"); + assert_eq!(derive_filename_from_url(&url, &token), "mf_test123.bin"); + } + + #[test] + fn derive_filename_from_url_handles_query_params() { + let url = Url::parse("https://cdn.example.com/files/abc123.mp4?token=xyz").unwrap(); + let token = MediaFileToken::new_from_str("mf_test123"); + assert_eq!(derive_filename_from_url(&url, &token), "mf_test123.mp4"); + } +} diff --git a/crates/api_clients/artcraft_client/src/recipes/mod.rs b/crates/api_clients/artcraft_client/src/recipes/mod.rs new file mode 100644 index 00000000..f007a12f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/recipes/mod.rs @@ -0,0 +1,2 @@ +pub mod download_media_file; +pub mod upload_media_file_from_file; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/recipes/upload_media_file_from_file.rs b/crates/api_clients/artcraft_client/src/recipes/upload_media_file_from_file.rs new file mode 100644 index 00000000..33c4b54f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/recipes/upload_media_file_from_file.rs @@ -0,0 +1,80 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::endpoints::media_files::upload_image_media_file_from_file::{upload_image_media_file_from_file, UploadImageFromFileArgs}; +use crate::endpoints::media_files::upload_new_engine_asset_from_file::upload_new_engine_asset_from_file; +use crate::endpoints::media_files::upload_video_media_file_from_file::{upload_video_media_file_from_file, UploadVideoFromFileArgs}; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use mimetypes::mimetype_info::file_extension::FileExtension; +use mimetypes::mimetype_info::mimetype_info::MimetypeInfo; +use serde_derive::Deserialize; +use std::path::Path; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; + +#[derive(Deserialize, Debug)] +pub struct UploadMediaFileSuccessResponse { + pub success: bool, + pub media_file_token: MediaFileToken, +} + +/// Upload an image media file from a file. +pub async fn upload_media_file_from_file>( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + path: P, + maybe_prompt_token: Option<&PromptToken>, +) -> Result { + + let maybe_type = MimetypeInfo::get_for_path(path.as_ref()) + .map_err(|err| ClientError::from(err))? + .map(|mime| mime.file_extension()) + .flatten(); + + match maybe_type { + Some(FileExtension::Glb) => { + match upload_new_engine_asset_from_file(api_host, maybe_creds, path, None).await { + Ok(result) => Ok(UploadMediaFileSuccessResponse { + success: result.success, + media_file_token: result.media_file_token, + }), + Err(err) => Err(StorytellerError::Api(err)), + } + } + Some(FileExtension::Mp4) => { + match upload_video_media_file_from_file(UploadVideoFromFileArgs { + api_host, + maybe_creds, + path, + maybe_prompt_token, + maybe_generation_provider: None, + }).await { + Ok(result) => Ok(UploadMediaFileSuccessResponse { + success: result.success, + media_file_token: result.media_file_token, + }), + Err(err) => Err(StorytellerError::Api(err)), + } + } + Some(FileExtension::Png) | Some(FileExtension::Jpg) | Some(FileExtension::Gif) | Some(FileExtension::Webp) => { + let result = upload_image_media_file_from_file(UploadImageFromFileArgs { + api_host, + maybe_creds, + path, + is_intermediate_system_file: false, + maybe_prompt_token, + maybe_batch_token: None, + maybe_generation_provider: None, + }).await; + match result { + Ok(result) => Ok(UploadMediaFileSuccessResponse { + success: result.success, + media_file_token: result.media_file_token, + }), + Err(err) => Err(err), + } + } + Some(_) => Err(StorytellerError::Client(ClientError::FileTypeNotHandled(path.as_ref().to_path_buf()))), + None => Err(StorytellerError::Client(ClientError::FileTypeNotKnown(path.as_ref().to_path_buf()))), + } +} diff --git a/crates/api_clients/artcraft_client/src/tokens/api_keys.rs b/crates/api_clients/artcraft_client/src/tokens/api_keys.rs new file mode 100644 index 00000000..712cea6c --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/api_keys.rs @@ -0,0 +1,10 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for api_keys. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize, Default)] +pub struct ApiKeyToken(pub String); +impl_client_token!(ApiKeyToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/app_session.rs b/crates/api_clients/artcraft_client/src/tokens/app_session.rs new file mode 100644 index 00000000..f318edc6 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/app_session.rs @@ -0,0 +1,10 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for users. +#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize, Default)] +pub struct AppSessionToken(pub String); +impl_client_token!(AppSessionToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/characters.rs b/crates/api_clients/artcraft_client/src/tokens/characters.rs new file mode 100644 index 00000000..4bd60e28 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/characters.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for Characters +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct CharacterToken(pub String); + +impl_client_token!(CharacterToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/folders.rs b/crates/api_clients/artcraft_client/src/tokens/folders.rs new file mode 100644 index 00000000..aab32c79 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/folders.rs @@ -0,0 +1,10 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for folders. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize, Default)] +pub struct FolderToken(pub String); +impl_client_token!(FolderToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/generic_inference_jobs.rs b/crates/api_clients/artcraft_client/src/tokens/generic_inference_jobs.rs new file mode 100644 index 00000000..91c49e7f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/generic_inference_jobs.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for "generic" inference jobs. +#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize, Default)] +pub struct InferenceJobToken(String); + +impl_client_token!(InferenceJobToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/mod.rs b/crates/api_clients/artcraft_client/src/tokens/mod.rs new file mode 100644 index 00000000..32d0eaba --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/mod.rs @@ -0,0 +1,53 @@ +//! Strongly-typed identifier tokens from the Artcraft/Storyteller API +//! (Stripe-like prefixes, e.g. `user_`, `jinf_`). +//! +//! These are OPAQUE string wrappers: the server mints them, the client only +//! carries them around. There is deliberately no token generation here. + +/// Implement the standard client-side token surface for a string wrapper +/// type: constructors from server-provided strings, accessors, and `Display`. +macro_rules! impl_client_token { + ($t:ident) => { + impl $t { + #[inline] + pub fn new(value: String) -> Self { + $t(value) + } + + #[inline] + pub fn new_from_str(value: &str) -> Self { + $t(value.to_string()) + } + + #[inline] + pub fn as_str(&self) -> &str { + &self.0 + } + } + + impl std::fmt::Display for $t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.0) + } + } + } +} + +pub mod api_keys; +pub mod app_session; +pub mod characters; +pub mod folders; +pub mod generic_inference_jobs; +pub mod model_weights; +pub mod tags; +pub mod uploaded_video_notes; +pub mod uploaded_videos; +pub mod user_referral_codes; +pub mod user_spend_events; +pub mod user_subscriptions; +pub mod users; +pub mod wallet_ledger_entries; +pub mod wallets; + +// Non-unique tokens (used as indices, not primary keys) +pub mod non_unique; diff --git a/crates/api_clients/artcraft_client/src/tokens/model_weights.rs b/crates/api_clients/artcraft_client/src/tokens/model_weights.rs new file mode 100644 index 00000000..2a902cad --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/model_weights.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for the "model_weights" table. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct ModelWeightToken(pub String); + +impl_client_token!(ModelWeightToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/non_unique/debug_logs_event_token.rs b/crates/api_clients/artcraft_client/src/tokens/non_unique/debug_logs_event_token.rs new file mode 100644 index 00000000..022a308f --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/non_unique/debug_logs_event_token.rs @@ -0,0 +1,10 @@ +use serde::Deserialize; +use serde::Serialize; + + +/// A non-unique event token for the `debug_logs` table. +/// Multiple log rows can share the same event token. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct DebugLogEventToken(pub String); + +impl_client_token!(DebugLogEventToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/non_unique/mod.rs b/crates/api_clients/artcraft_client/src/tokens/non_unique/mod.rs new file mode 100644 index 00000000..382dc89d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/non_unique/mod.rs @@ -0,0 +1 @@ +pub mod debug_logs_event_token; diff --git a/crates/api_clients/artcraft_client/src/tokens/tags.rs b/crates/api_clients/artcraft_client/src/tokens/tags.rs new file mode 100644 index 00000000..651e92fc --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/tags.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for Prompts +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct TagToken(pub String); + +impl_client_token!(TagToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/uploaded_video_notes.rs b/crates/api_clients/artcraft_client/src/tokens/uploaded_video_notes.rs new file mode 100644 index 00000000..422c04f9 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/uploaded_video_notes.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for uploaded_video_notes. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct UploadVideoNoteToken(pub String); + +impl_client_token!(UploadVideoNoteToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/uploaded_videos.rs b/crates/api_clients/artcraft_client/src/tokens/uploaded_videos.rs new file mode 100644 index 00000000..f123adc3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/uploaded_videos.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for uploaded_videos. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct UploadedVideoToken(pub String); + +impl_client_token!(UploadedVideoToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/user_referral_codes.rs b/crates/api_clients/artcraft_client/src/tokens/user_referral_codes.rs new file mode 100644 index 00000000..ea2b482d --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/user_referral_codes.rs @@ -0,0 +1,8 @@ +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for user referral codes. +#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize, Default)] +pub struct UserReferralCodeToken(pub String); +impl_client_token!(UserReferralCodeToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/user_spend_events.rs b/crates/api_clients/artcraft_client/src/tokens/user_spend_events.rs new file mode 100644 index 00000000..1f8af475 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/user_spend_events.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for user_spend_events +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct UserSpendEventToken(pub String); + +impl_client_token!(UserSpendEventToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/user_subscriptions.rs b/crates/api_clients/artcraft_client/src/tokens/user_subscriptions.rs new file mode 100644 index 00000000..1d765666 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/user_subscriptions.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// Primary key for the `user_subscriptions` table. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct UserSubscriptionToken(pub String); + +impl_client_token!(UserSubscriptionToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/users.rs b/crates/api_clients/artcraft_client/src/tokens/users.rs new file mode 100644 index 00000000..f1bffdd1 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/users.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for users. +#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize, Default)] +pub struct UserToken(pub String); +impl_client_token!(UserToken); +// NB: Older user tokens were under this regime: 15 characters, "U:" prefix, Crockford Upper. diff --git a/crates/api_clients/artcraft_client/src/tokens/wallet_ledger_entries.rs b/crates/api_clients/artcraft_client/src/tokens/wallet_ledger_entries.rs new file mode 100644 index 00000000..ea77334b --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/wallet_ledger_entries.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for wallet_ledger_entries +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct WalletLedgerEntryToken(pub String); + +impl_client_token!(WalletLedgerEntryToken); diff --git a/crates/api_clients/artcraft_client/src/tokens/wallets.rs b/crates/api_clients/artcraft_client/src/tokens/wallets.rs new file mode 100644 index 00000000..bdb9fee4 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/tokens/wallets.rs @@ -0,0 +1,11 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for wallets +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct WalletToken(pub String); + +impl_client_token!(WalletToken); diff --git a/crates/api_clients/artcraft_client/src/utils/api_host.rs b/crates/api_clients/artcraft_client/src/utils/api_host.rs new file mode 100644 index 00000000..f8fd711a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/api_host.rs @@ -0,0 +1,37 @@ + +const HTTP_SCHEME: &str = "http"; + +const HTTPS_SCHEME: &str = "https"; + +#[derive(Clone, Debug)] +pub enum ApiHost { + Storyteller, + FakeYou, + Localhost { port: u32 }, +} + +impl ApiHost { + pub fn to_api_hostname(&self) -> String { + match self { + ApiHost::Storyteller => "api.storyteller.ai".to_string(), + ApiHost::FakeYou => "api.fakeyou.com".to_string(), + ApiHost::Localhost { port } => format!("localhost:{}", port), + } + } + + pub fn to_api_hostname_and_scheme(&self) -> String { + match self { + ApiHost::Storyteller => "https://api.storyteller.ai".to_string(), + ApiHost::FakeYou => "https://api.fakeyou.com".to_string(), + ApiHost::Localhost { port } => format!("http://localhost:{}", port), + } + } + + pub fn scheme(&self) -> &'static str { + match self { + ApiHost::Storyteller => HTTPS_SCHEME, + ApiHost::FakeYou => HTTPS_SCHEME, + ApiHost::Localhost { .. } => HTTP_SCHEME, + } + } +} diff --git a/crates/api_clients/artcraft_client/src/utils/api_or_web_json_post_request.rs b/crates/api_clients/artcraft_client/src/utils/api_or_web_json_post_request.rs new file mode 100644 index 00000000..0ea21b21 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/api_or_web_json_post_request.rs @@ -0,0 +1,91 @@ +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use log::{debug, info}; +use reqwest::Client; +use serde::de::DeserializeOwned; +use serde::Serialize; + +/// JSON POST that authenticates as either a web session (`Cookie` header) or +/// an API key (`Authorization` header). +pub async fn api_or_web_json_post_request( + api_host: &ApiHost, + route_path: &str, + maybe_creds: Option<&ApiOrWebCreds>, + request: &Req, +) -> Result { + + let url = get_route(api_host, route_path); + + // NB: We record lightweight analytics telemetry to understand which areas + // of the tool are useful and which models and services are important. + let debug_log = url.ends_with("/v1/analytics/active_user_v2"); + + // Suppress "spammy" logs at the debug level. + if debug_log { + debug!("Requesting {:?}", &url); + } else { + info!("Requesting {:?}", &url); + } + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON) + .header("Content-Type", APPLICATION_JSON); + + if let Some(creds) = maybe_creds { + if let Some((header_name, header_value)) = creds.maybe_as_header() { + request_builder = request_builder.header(header_name, header_value); + } + } + + let request_body = serde_json::to_string(request) + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + debug!("Request body: {:?}", request_body); + + let response = request_builder + .body(request_body) + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let hostname = response.headers().get("x-backend-hostname") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + let build_sha = response.headers().get("x-build-sha") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + debug!("[server] x-backend-hostname: {:?}, x-build-sha: {:?}", hostname, build_sha); + + let response = filter_bad_response(response) + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response_body = &response.text() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + debug!("Response body: {:?}", response_body); + + let response = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(response) +} + +fn get_route(api_host: &ApiHost, route_path: &str) -> String { + let api_hostname = api_host.to_api_hostname_and_scheme(); + format!("{}{}", api_hostname, route_path) +} diff --git a/crates/api_clients/artcraft_client/src/utils/basic_json_delete_request.rs b/crates/api_clients/artcraft_client/src/utils/basic_json_delete_request.rs new file mode 100644 index 00000000..fbdddaa5 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/basic_json_delete_request.rs @@ -0,0 +1,80 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use log::{debug, info}; +use reqwest::Client; +use serde::de::DeserializeOwned; +use serde::{Deserialize, Serialize}; + +pub async fn basic_json_delete_request( + api_host: &ApiHost, + route_path: &str, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Req, +) -> Result { + + let url = get_route(api_host, route_path); + + info!("DELETE {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let mut request_builder = client.delete(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON) + .header("Content-Type", APPLICATION_JSON); + + if let Some(creds) = maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let request_body = serde_json::to_string(&request) + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + debug!("Request body: {:?}", request_body); + + let response = request_builder + .body(request_body) + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let hostname = response.headers().get("x-backend-hostname") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + let build_sha = response.headers().get("x-build-sha") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + debug!("[server] x-backend-hostname: {:?}, x-build-sha: {:?}", hostname, build_sha); + + let response = filter_bad_response(response) + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response_body = &response.text() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + debug!("Response body: {:?}", response_body); + + let response = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(response) +} + +fn get_route(api_host: &ApiHost, route_path: &str) -> String { + let api_hostname = api_host.to_api_hostname_and_scheme(); + format!("{}{}", api_hostname, route_path) +} diff --git a/crates/api_clients/artcraft_client/src/utils/basic_json_get_request.rs b/crates/api_clients/artcraft_client/src/utils/basic_json_get_request.rs new file mode 100644 index 00000000..2d033bf3 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/basic_json_get_request.rs @@ -0,0 +1,72 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use log::{debug, info}; +use reqwest::Client; +use serde::de::DeserializeOwned; +use serde::{Deserialize, Serialize}; + +pub async fn basic_json_get_request( + api_host: &ApiHost, + route_path: &str, + maybe_creds: Option<&StorytellerCredentialSet>, +) -> Result { + + let url = get_route(api_host, route_path); + + debug!("Requesting {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let mut request_builder = client.get(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let hostname = response.headers().get("x-backend-hostname") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + let build_sha = response.headers().get("x-build-sha") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + debug!("[server] x-backend-hostname: {:?}, x-build-sha: {:?}", hostname, build_sha); + + let response = filter_bad_response(response) + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response_body = &response.text() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + debug!("Response body: {:?}", response_body); + + let response = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(response) +} + +fn get_route(api_host: &ApiHost, route_path: &str) -> String { + let api_hostname = api_host.to_api_hostname_and_scheme(); + format!("{}{}", api_hostname, route_path) +} diff --git a/crates/api_clients/artcraft_client/src/utils/basic_json_post_request.rs b/crates/api_clients/artcraft_client/src/utils/basic_json_post_request.rs new file mode 100644 index 00000000..eac5b319 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/basic_json_post_request.rs @@ -0,0 +1,26 @@ +use crate::credentials::api_or_web_creds::ApiOrWebCreds; +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::api_or_web_json_post_request::api_or_web_json_post_request; +use serde::de::DeserializeOwned; +use serde::Serialize; + +/// JSON POST authenticated by web session cookies only. Thin wrapper over +/// [`api_or_web_json_post_request`] for endpoints not yet migrated to +/// [`ApiOrWebCreds`]. +pub async fn basic_json_post_request( + api_host: &ApiHost, + route_path: &str, + maybe_creds: Option<&StorytellerCredentialSet>, + request: Req, +) -> Result { + let maybe_api_or_web_creds = maybe_creds.map(ApiOrWebCreds::from); + + api_or_web_json_post_request( + api_host, + route_path, + maybe_api_or_web_creds.as_ref(), + &request, + ).await +} diff --git a/crates/api_clients/artcraft_client/src/utils/basic_query_string_post_request.rs b/crates/api_clients/artcraft_client/src/utils/basic_query_string_post_request.rs new file mode 100644 index 00000000..2a15d097 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/basic_query_string_post_request.rs @@ -0,0 +1,146 @@ +use crate::credentials::storyteller_credential_set::StorytellerCredentialSet; +use crate::error::api_error::ApiError; +use crate::error::client_error::ClientError; +use crate::error::storyteller_error::StorytellerError; +use crate::utils::api_host::ApiHost; +use crate::utils::constants::{APPLICATION_JSON, USER_AGENT}; +use crate::utils::filter_bad_response::filter_bad_response; +use errors::AnyhowResult; +use log::{debug, info}; +use reqwest::Client; +use serde::de::DeserializeOwned; +use serde::{Deserialize, Serialize}; +use std::collections::HashMap; +use url::Url; +use url_builder::URLBuilder; + +pub async fn basic_query_string_post_request( + api_host: &ApiHost, + route_path: &str, + maybe_creds: Option<&StorytellerCredentialSet>, + query_params: &HashMap, +) -> Result { + + // TODO: Please stop using this URL Builder library. It's not very safe or intuitive. + let url = get_route(api_host, route_path, query_params); + + debug!("Requesting {:?}", &url); + + let client = Client::builder() + .gzip(true) + .build() + .map_err(|err| StorytellerError::Client(ClientError::from(err)))?; + + let mut request_builder = client.post(url) + .header("User-Agent", USER_AGENT) + .header("Accept", APPLICATION_JSON); + + if let Some(creds) = maybe_creds { + if let Some(header) = &creds.maybe_as_cookie_header() { + request_builder = request_builder.header("Cookie", header); + } + } + + let response = request_builder + .send() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let hostname = response.headers().get("x-backend-hostname") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + let build_sha = response.headers().get("x-build-sha") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + + debug!("[server] x-backend-hostname: {:?}, x-build-sha: {:?}", hostname, build_sha); + + let response = filter_bad_response(response) + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + let response_body = &response.text() + .await + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + debug!("Response body: {:?}", response_body); + + let response = serde_json::from_str(&response_body) + .map_err(|err| StorytellerError::Api(ApiError::from(err)))?; + + Ok(response) +} + +// TODO: Please stop using this URL Builder library. It's not very safe or intuitive. +fn get_route(api_host: &ApiHost, route_path: &str, query_params: &HashMap) -> String { + let mut builder = URLBuilder::new(); + + builder.set_protocol(api_host.scheme()) + .set_host(&api_host.to_api_hostname()); + + // NB: This stupid library auto-inserts a starting slash, so we need to remove it. + // This is a bad code smell. I shouldn't be using this thing. + match route_path.split_once("/") { + None => { + builder.add_route(route_path); + } + Some((_slash, rest)) => { + builder.add_route(rest); + } + } + + // NB: This is not safe. It doesn't handle URL encoding, "?", "&", etc. + for (key, value) in query_params { + let value = filter_string(value); + builder.add_param(key, &value); + } + + // NB: This isn't very safe. + builder.build() +} + +// TODO: Please stop using this URL Builder library. It's not very safe or intuitive. +fn filter_string(string: &str) -> String { + string.trim() + .replace(" ", "") + .replace("&", "") + .replace("=", "") + .replace("?", "") +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashMap; + + #[test] + fn test_get_route() { + let api_host = ApiHost::Storyteller; + let route_path = "/v1/test"; + let mut query_params = HashMap::new(); + query_params.insert("param1".to_string(), "value1".to_string()); + query_params.insert("param2".to_string(), "value2".to_string()); + + let url = get_route(&api_host, route_path, &query_params); + + assert!(url.starts_with("https://api.storyteller.ai/v1/test?")); + assert!(url.contains("param1=value1")); + assert!(url.contains("param2=value2")); + } + + #[test] + fn test_get_localhost_route() { + let api_host = ApiHost::Localhost { port: 12345 }; + let route_path = "/v1/test"; + let mut query_params = HashMap::new(); + query_params.insert("param1".to_string(), "value1".to_string()); + query_params.insert("param2".to_string(), "value2".to_string()); + + let url = get_route(&api_host, route_path, &query_params); + + assert!(url.starts_with("http://localhost:12345/v1/test?")); + assert!(url.contains("param1=value1")); + assert!(url.contains("param2=value2")); + } +} \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/utils/constants.rs b/crates/api_clients/artcraft_client/src/utils/constants.rs new file mode 100644 index 00000000..ce9bdc5a --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/constants.rs @@ -0,0 +1,4 @@ + +pub const USER_AGENT: &str = "storyteller-client/1.0"; + +pub const APPLICATION_JSON : &str = "application/json"; diff --git a/crates/api_clients/artcraft_client/src/utils/filter_bad_response.rs b/crates/api_clients/artcraft_client/src/utils/filter_bad_response.rs new file mode 100644 index 00000000..c9717470 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/filter_bad_response.rs @@ -0,0 +1,48 @@ +use crate::error::api_error::ApiError; +use crate::utils::status_codes::*; +use anyhow::anyhow; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use log::error; + +/// Pass request errors to this method for standard error handling behavior. +/// This function needs to take temporary ownership, but will return it to the caller. +/// +/// Example use: +/// let response = client.get().await?; +/// let response = filter_bad_response(response).await?; +/// ... 200 or other valid response +pub async fn filter_bad_response(response: reqwest::Response) -> Result { + let status = response.status(); + + if status.is_success() { + return Ok(response); + } + + // The host in the fleet that handled the request. + let backend_hostname= response.headers() + .get("x-backend-hostname") + .map(|header| header.to_str().unwrap_or_else(|err| { + error!("Failed to parse x-backend-hostname header: {:?}", err); + "unknown" + })) + .map(|s| s.to_string()); + + let response_body = match response.text().await { + Ok(text) => text.to_string(), + Err(err) => format!("Could not read response body: {:?}", err), + }; + + let status_code = status.as_u16(); + + filter_cloudflare_errors(status_code, &response_body)?; + + match status_code { + STATUS_401_UNAUTHORIZED => Err(ApiError::Unauthorized(response_body)), + STATUS_402_PAYMENT_REQUIRED => Err(ApiError::PaymentRequired(response_body)), + STATUS_403_FORBIDDEN => Err(ApiError::Forbidden(response_body)), + STATUS_404_NOT_FOUND => Err(ApiError::NotFound(response_body)), + STATUS_429_TOO_MANY_REQUESTS => Err(ApiError::TooManyRequests(response_body)), + STATUS_500_INTERNAL_SERVER_ERROR => Err(ApiError::InternalServerError { body: response_body, backend_hostname }), + _ => Err(ApiError::Other(anyhow!("Bad status code: {}; message: {:?}", status, response_body))), + } +} diff --git a/crates/api_clients/artcraft_client/src/utils/http_get_anonymous.rs b/crates/api_clients/artcraft_client/src/utils/http_get_anonymous.rs new file mode 100644 index 00000000..f4c66d20 --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/http_get_anonymous.rs @@ -0,0 +1,18 @@ +use crate::error::api_error::ApiError; +use reqwest::Client; +const USER_AGENT: &str = "storyteller-client/1.0"; + +pub async fn http_get_anonymous(url: String) -> Result { + let client = Client::builder() + .gzip(true) + .build()?; + + let response = client.get(url) + .header("User-Agent", USER_AGENT) + .header("Accept", "application/json") + //.header("Accept-Encoding", "gzip, deflate, br") + .send() + .await?; + + Ok(response) +} diff --git a/crates/api_clients/artcraft_client/src/utils/mod.rs b/crates/api_clients/artcraft_client/src/utils/mod.rs new file mode 100644 index 00000000..164c62aa --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/mod.rs @@ -0,0 +1,10 @@ +pub (crate) mod api_or_web_json_post_request; +pub (crate) mod basic_json_delete_request; +pub (crate) mod basic_json_get_request; +pub (crate) mod basic_json_post_request; +pub (crate) mod basic_query_string_post_request; +pub (crate) mod filter_bad_response; +pub (crate) mod http_get_anonymous; +pub mod api_host; +pub mod constants; +pub mod status_codes; \ No newline at end of file diff --git a/crates/api_clients/artcraft_client/src/utils/status_codes.rs b/crates/api_clients/artcraft_client/src/utils/status_codes.rs new file mode 100644 index 00000000..e2bf44bf --- /dev/null +++ b/crates/api_clients/artcraft_client/src/utils/status_codes.rs @@ -0,0 +1,25 @@ +pub const STATUS_401_UNAUTHORIZED : u16 = 401u16; + +pub const STATUS_402_PAYMENT_REQUIRED : u16 = 402u16; +pub const STATUS_403_FORBIDDEN : u16 = 403u16; + +pub const STATUS_404_NOT_FOUND : u16 = 404u16; + +pub const STATUS_429_TOO_MANY_REQUESTS : u16 = 429u16; + +pub const STATUS_500_INTERNAL_SERVER_ERROR : u16 = 500u16; + +#[cfg(test)] +mod tests { + use crate::utils::status_codes::*; + + #[test] + pub fn test_codes() { + assert_eq!(STATUS_401_UNAUTHORIZED, 401); + assert_eq!(STATUS_402_PAYMENT_REQUIRED, 402); + assert_eq!(STATUS_403_FORBIDDEN, 403); + assert_eq!(STATUS_404_NOT_FOUND, 404); + assert_eq!(STATUS_429_TOO_MANY_REQUESTS, 429); + assert_eq!(STATUS_500_INTERNAL_SERVER_ERROR, 500); + } +} diff --git a/crates/api_clients/fal_client/Cargo.toml b/crates/api_clients/fal_client/Cargo.toml new file mode 100644 index 00000000..32017398 --- /dev/null +++ b/crates/api_clients/fal_client/Cargo.toml @@ -0,0 +1,41 @@ +[package] +name = "fal_client" +edition = "2021" +rust-version = "1.75" # MSRV: async traits +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "fal_client" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true +file_to_base64_url.workspace = true + +# External +anyhow.workspace = true +futures.workspace = true +log.workspace = true +reqwest.workspace = true +serde.workspace = true +serde_json.workspace = true +strum.workspace = true +thiserror.workspace = true +tokio.workspace = true +url.workspace = true + +[dev-dependencies] +# Internal Dev +test_utils.workspace = true +test_data.workspace = true + +# External Dev +# (None yet) diff --git a/crates/api_clients/fal_client/src/creds/fal_api_key.rs b/crates/api_clients/fal_client/src/creds/fal_api_key.rs new file mode 100644 index 00000000..2e1e9cc7 --- /dev/null +++ b/crates/api_clients/fal_client/src/creds/fal_api_key.rs @@ -0,0 +1,14 @@ + +#[derive(Clone)] +pub struct FalApiKey(pub String); + +impl FalApiKey { + pub fn new(api_key: String) -> Self { + Self(api_key) + } + + pub fn from_str(api_key: &str) -> Self { + let api_key = api_key.trim().to_string(); + Self(api_key) + } +} diff --git a/crates/api_clients/fal_client/src/creds/mod.rs b/crates/api_clients/fal_client/src/creds/mod.rs new file mode 100644 index 00000000..092bf413 --- /dev/null +++ b/crates/api_clients/fal_client/src/creds/mod.rs @@ -0,0 +1,2 @@ +pub mod fal_api_key; +pub mod open_ai_api_key; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/creds/open_ai_api_key.rs b/crates/api_clients/fal_client/src/creds/open_ai_api_key.rs new file mode 100644 index 00000000..92b9d16c --- /dev/null +++ b/crates/api_clients/fal_client/src/creds/open_ai_api_key.rs @@ -0,0 +1,15 @@ + +/// This is for Fal's OpenAI "Bring Your Own Key" (BYOK) endpoints. +#[derive(Clone)] +pub struct OpenAiApiKey(pub String); + +impl OpenAiApiKey { + pub fn new(api_key: String) -> Self { + Self(api_key) + } + + pub fn from_str(api_key: &str) -> Self { + let api_key = api_key.trim().to_string(); + Self(api_key) + } +} diff --git a/crates/api_clients/fal_client/src/error/api_generic_error.rs b/crates/api_clients/fal_client/src/error/api_generic_error.rs new file mode 100644 index 00000000..fbb7c678 --- /dev/null +++ b/crates/api_clients/fal_client/src/error/api_generic_error.rs @@ -0,0 +1,34 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; +use reqwest::StatusCode; + +#[derive(Debug)] +pub enum FalGenericApiError { + /// serde_json::Error, likely from JSON deserialization schema mismatch. + /// Includes the original body. + SerdeResponseParseErrorWithBody { + error: serde_json::Error, + body: String, + }, + + /// An uncategorized bad HTTP response. + UncategorizedBadResponseWithStatusAndBody { + status_code: StatusCode, + body: String, + }, +} + +impl Error for FalGenericApiError {} + +impl Display for FalGenericApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::SerdeResponseParseErrorWithBody { error, body } => { + write!(f, "Failed to parse response body: {:?}. Body: {}", error, body) + } + Self::UncategorizedBadResponseWithStatusAndBody { status_code, body } => { + write!(f, "Uncategorized bad response: status code {}, body: {}", status_code, body) + } + } + } +} diff --git a/crates/api_clients/fal_client/src/error/api_specific_error.rs b/crates/api_clients/fal_client/src/error/api_specific_error.rs new file mode 100644 index 00000000..7b2fa608 --- /dev/null +++ b/crates/api_clients/fal_client/src/error/api_specific_error.rs @@ -0,0 +1,19 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum FalSpecificApiError { + /// The job is still in progress. The response URL is not ready yet. + /// Contains the detail message from the FAL API (e.g. "Request is still in progress"). + IncompleteJob(String), +} + +impl Error for FalSpecificApiError {} + +impl Display for FalSpecificApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::IncompleteJob(detail) => write!(f, "Job is incomplete: {}", detail), + } + } +} diff --git a/crates/api_clients/fal_client/src/error/classify_fal_error.rs b/crates/api_clients/fal_client/src/error/classify_fal_error.rs new file mode 100644 index 00000000..f473618d --- /dev/null +++ b/crates/api_clients/fal_client/src/error/classify_fal_error.rs @@ -0,0 +1,27 @@ +use crate::error::fal_error::FalError; +use crate::error::fal_error_plus::FalErrorPlus; + +const BILLING_ERROR : &str = "{\"detail\": \"User is locked. Reason: Exhausted balance. Top up your balance at fal.ai/dashboard/billing.\"}"; + +/// Better classify the `FalError` into a more user-friendly `FalErrorPlus`. +pub fn classify_fal_error(err: FalError) -> FalErrorPlus { + match err { + FalError::RequestError(_) => FalErrorPlus::FalError(err), + FalError::SerializeError(_) => FalErrorPlus::FalError(err), + FalError::Other(ref inner) => { + if inner == BILLING_ERROR { + FalErrorPlus::FalBillingError(inner.to_string()) + } else if inner.contains("billing") { + FalErrorPlus::FalBillingError(inner.to_string()) + } else if inner.contains("balance") { + FalErrorPlus::FalBillingError(inner.to_string()) + } else if inner.contains("Invalid Key Authorization header format") { + FalErrorPlus::FalApiKeyError(inner.to_string()) + } else if inner.contains("No user found for Key ID and Secret") { + FalErrorPlus::FalApiKeyError(inner.to_string()) + } else { + FalErrorPlus::FalError(err) + } + } + } +} diff --git a/crates/api_clients/fal_client/src/error/client_error.rs b/crates/api_clients/fal_client/src/error/client_error.rs new file mode 100644 index 00000000..8439c58b --- /dev/null +++ b/crates/api_clients/fal_client/src/error/client_error.rs @@ -0,0 +1,18 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum FalClientError { + /// The URL provided was invalid or pointed to an unexpected host. + InvalidUrl(String), +} + +impl Error for FalClientError {} + +impl Display for FalClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::InvalidUrl(msg) => write!(f, "Invalid URL: {}", msg), + } + } +} diff --git a/crates/api_clients/fal_client/src/error/fal_error.rs b/crates/api_clients/fal_client/src/error/fal_error.rs new file mode 100644 index 00000000..4a3521f9 --- /dev/null +++ b/crates/api_clients/fal_client/src/error/fal_error.rs @@ -0,0 +1,21 @@ +/// Error type for Fal API interactions. +/// +/// Originally from the vendored `fal` crate (`fal::FalError`). +/// Copied here so `fal_client` can be independent of the vendored crate. +#[derive(Debug, thiserror::Error)] +pub enum FalError { + #[error("fal request failed: {0}")] + RequestError(#[from] reqwest::Error), + + #[error("serialization error: {0}")] + SerializeError(#[from] serde_json::Error), + + #[error("error: {0}")] + Other(String), +} + +impl From for FalError { + fn from(s: String) -> Self { + FalError::Other(s) + } +} diff --git a/crates/api_clients/fal_client/src/error/fal_error_plus.rs b/crates/api_clients/fal_client/src/error/fal_error_plus.rs new file mode 100644 index 00000000..506ba35c --- /dev/null +++ b/crates/api_clients/fal_client/src/error/fal_error_plus.rs @@ -0,0 +1,85 @@ +use crate::error::api_generic_error::FalGenericApiError; +use crate::error::api_specific_error::FalSpecificApiError; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::client_error::FalClientError; +use crate::error::fal_error::FalError; +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// Additional errors that aren't included in `crate::error::fal_error::FalError`. +#[derive(Debug)] +pub enum FalErrorPlus { + // =============== Newer error types =============== + + /// A client-side error (invalid input, bad URL, etc.). + ClientError(FalClientError), + + /// A generic API error (bad response, parse failure, etc.). + ApiGeneric(FalGenericApiError), + + /// A specific, categorized API error (incomplete job, etc.). + ApiSpecific(FalSpecificApiError), + + // =============== Older error types (gradually replace these) =============== + + /// An error arising in the `fal` crate. + FalError(crate::error::fal_error::FalError), + /// The fal API key is invalid. + FalApiKeyError(String), + /// The fal account has a billing issue + FalBillingError(String), + /// Error with an invalid polling URL. + InvalidPollingUrl(String), + /// Another error we didn't handle. + AnyhowError(anyhow::Error), + /// URL parse errors. + UrlParseError(url::ParseError), + /// An endpoint we don't support yet. + UnhandledEndpoint(String), + /// Error from the `reqwest` crate. + ReqwestError(reqwest::Error), +} + +impl Display for FalErrorPlus { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::ClientError(err) => write!(f, "FalErrorPlus::ClientError: {}", err), + Self::ApiGeneric(err) => write!(f, "FalErrorPlus::ApiGeneric: {}", err), + Self::ApiSpecific(err) => write!(f, "FalErrorPlus::ApiSpecific: {}", err), + Self::FalError(err) => write!(f, "FalErrorPlus::FalError: {:?}", err), + Self::FalApiKeyError(reason) => write!(f, "FalErrorPlus::FalApiKeyError: {}", reason), + Self::FalBillingError(reason) => write!(f, "FalErrorPlus::FalBillingError: {}", reason), + Self::InvalidPollingUrl(url) => write!(f, "FalErrorPlus::InvalidPollingUrl: {}", url), + Self::AnyhowError(err) => write!(f, "FalErrorPlus::AnyhowError: {:?}", err), + Self::UrlParseError(err) => write!(f, "FalErrorPlus::UrlParseError: {:?}", err), + Self::UnhandledEndpoint(endpoint) => write!(f, "FalErrorPlus::UnhandledEndpoint: {:?}", endpoint), + Self::ReqwestError(err) => write!(f, "FalErrorPlus::ReqwestError: {:?}", err), + } + } +} + +impl Error for FalErrorPlus {} + +impl From for FalErrorPlus { + fn from(err: FalError) -> Self { + classify_fal_error(err) + } +} + +impl From for FalErrorPlus { + fn from(err: anyhow::Error) -> Self { + FalErrorPlus::AnyhowError(err) + } +} + +impl From for FalErrorPlus { + fn from(err: url::ParseError) -> Self { + FalErrorPlus::UrlParseError(err) + } +} + +impl From for FalErrorPlus { + fn from(err: reqwest::Error) -> Self { + FalErrorPlus::ReqwestError(err) + } +} diff --git a/crates/api_clients/fal_client/src/error/mod.rs b/crates/api_clients/fal_client/src/error/mod.rs new file mode 100644 index 00000000..261dd155 --- /dev/null +++ b/crates/api_clients/fal_client/src/error/mod.rs @@ -0,0 +1,6 @@ +pub mod api_generic_error; +pub mod api_specific_error; +pub mod classify_fal_error; +pub mod client_error; +pub mod fal_error; +pub mod fal_error_plus; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/lib.rs b/crates/api_clients/fal_client/src/lib.rs new file mode 100644 index 00000000..132dd21f --- /dev/null +++ b/crates/api_clients/fal_client/src/lib.rs @@ -0,0 +1,9 @@ +//! A fal wrapper + +pub mod creds; +pub mod error; +pub mod polling; +pub mod requests; +pub mod requests_old; +pub mod utils; +pub mod webhook_payload; diff --git a/crates/api_clients/fal_client/src/polling/mod.rs b/crates/api_clients/fal_client/src/polling/mod.rs new file mode 100644 index 00000000..8f6960df --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/mod.rs @@ -0,0 +1,2 @@ +pub mod poll_job_status; +pub mod poll_job_response; diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/mod.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/mod.rs new file mode 100644 index 00000000..06d719e6 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/mod.rs @@ -0,0 +1,3 @@ +pub mod poll_job_response; +pub mod raw_response; +pub mod success_case_extractors; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/poll_job_response.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/poll_job_response.rs new file mode 100644 index 00000000..83fd1c48 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/poll_job_response.rs @@ -0,0 +1,428 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::api_generic_error::FalGenericApiError; +use crate::error::api_specific_error::FalSpecificApiError; +use crate::error::client_error::FalClientError; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::polling::poll_job_response::raw_response::RawIncompleteJobResponse; +use crate::polling::poll_job_response::success_case_extractors::{ + extract_contents_from_response, PollResponseExtractedContents, +}; +use log::info; +use serde_json::Value; +use url::Url; + +const EXPECTED_HOST: &str = "queue.fal.run"; + +pub struct PollJobResponseArgs<'a> { + /// This is the "response" URL (not the "status" URL). + /// This fetches the actual results of a completed job. + /// If the job is not complete, this call will fail in error. + pub response_url: &'a str, + + pub api_key: &'a FalApiKey, +} + +/// Parsed response from fetching a completed FAL job's results. +#[derive(Debug)] +pub struct PollJobResponse { + /// The raw JSON payload as a serde_json::Value, for full access. + pub payload: Value, + + /// Extracted known content fields (images, video, model_glb, thumbnail). + /// `None` if no recognized content keys were found in the payload. + pub extracted_contents: Option, + + /// The raw JSON response body, preserved for debugging. + pub raw_body: String, +} + +/// Fetch the results of a completed FAL job. +/// +/// The `response_url` must point to `queue.fal.run`. +/// +/// Returns `FalErrorPlus::ApiSpecific(IncompleteJob)` if the job is still +/// in progress (FAL returns HTTP 400 with `"detail": "Request is still in progress"`). +pub async fn poll_job_response(args: PollJobResponseArgs<'_>) -> Result { + let parsed = Url::parse(args.response_url)?; + + let host = parsed.host_str().unwrap_or(""); + + if host != EXPECTED_HOST { + return Err(FalErrorPlus::ClientError(FalClientError::InvalidUrl(format!( + "Expected host '{}' but got '{}' in response URL: {}", + EXPECTED_HOST, + host, + args.response_url, + )))); + } + + info!("Polling FAL job response: {}", args.response_url); + + let response = reqwest::Client::new() + .get(args.response_url) + .header("Authorization", format!("Key {}", args.api_key.0)) + .send() + .await?; + + let http_status = response.status(); + let body = response.text().await?; + + if !http_status.is_success() { + return Err(classify_error_response(http_status, &body)); + } + + let payload: Value = serde_json::from_str(&body) + .map_err(|err| FalErrorPlus::ApiGeneric( + FalGenericApiError::SerdeResponseParseErrorWithBody { + error: err, + body: body.clone(), + }, + ))?; + + let extracted_contents = extract_contents_from_response(&payload); + + Ok(PollJobResponse { + payload, + extracted_contents, + raw_body: body, + }) +} + +// ── Helpers ── + +/// Classify a non-2xx response. If it's a 400 with "Request is still in progress", +/// return the specific `IncompleteJob` error. Otherwise fall through to a generic error. +fn classify_error_response( + status_code: reqwest::StatusCode, + body: &str, +) -> FalErrorPlus { + if status_code == reqwest::StatusCode::BAD_REQUEST { + if let Ok(raw) = serde_json::from_str::(body) { + if let Some(detail) = raw.detail { + if detail.contains("still in progress") { + return FalErrorPlus::ApiSpecific(FalSpecificApiError::IncompleteJob(detail)); + } + } + } + } + + FalErrorPlus::ApiGeneric( + FalGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code, + body: body.to_string(), + }, + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + // ── Unit tests (no network) ── + + #[tokio::test] + async fn rejects_wrong_host() { + let api_key = FalApiKey::from_str("test-key"); + let args = PollJobResponseArgs { + response_url: "https://evil.example.com/fal-ai/flux/requests/abc123", + api_key: &api_key, + }; + let result = poll_job_response(args).await; + assert!(result.is_err()); + let err = format!("{}", result.unwrap_err()); + assert!(err.contains("evil.example.com"), "error should mention the bad host: {}", err); + } + + #[tokio::test] + async fn rejects_invalid_url() { + let api_key = FalApiKey::from_str("test-key"); + let args = PollJobResponseArgs { + response_url: "not a url at all", + api_key: &api_key, + }; + let result = poll_job_response(args).await; + assert!(result.is_err()); + } + + mod classify_error { + use super::*; + + #[test] + fn incomplete_job_400() { + let body = r#"{"cancel_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/abc/cancel","detail":"Request is still in progress","request_id":"abc","response_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/abc","status_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/abc/status"}"#; + let err = classify_error_response(reqwest::StatusCode::BAD_REQUEST, body); + assert!(matches!(err, FalErrorPlus::ApiSpecific(FalSpecificApiError::IncompleteJob(_)))); + } + + #[test] + fn other_400_is_generic() { + let body = r#"{"detail":"Some other error"}"#; + let err = classify_error_response(reqwest::StatusCode::BAD_REQUEST, body); + assert!(matches!(err, FalErrorPlus::ApiGeneric(FalGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. }))); + } + + #[test] + fn non_400_is_generic() { + let body = "Internal Server Error"; + let err = classify_error_response(reqwest::StatusCode::INTERNAL_SERVER_ERROR, body); + assert!(matches!(err, FalErrorPlus::ApiGeneric(FalGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. }))); + } + } + + mod extract_payloads { + use super::*; + + #[test] + fn extract_image_payload() { + let json = r#"{"images":[{"url":"https://v3b.fal.media/files/b/img.jpg","width":1024,"height":768,"content_type":"image/jpeg"}],"timings":{"inference":1.19},"seed":1248735483,"has_nsfw_concepts":[false],"prompt":"a giant robot"}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).unwrap(); + let images = extracted.images.unwrap(); + assert_eq!(images.len(), 1); + assert_eq!(images[0].url.as_deref(), Some("https://v3b.fal.media/files/b/img.jpg")); + assert_eq!(images[0].width, Some(1024)); + assert_eq!(images[0].height, Some(768)); + } + + #[test] + fn extract_glb_mesh_payload() { + let json = r#"{"model_glb":{"url":"https://v3b.fal.media/files/b/model.glb","content_type":"model/gltf-binary","file_name":"model.glb","file_size":33352724},"thumbnail":{"url":"https://v3b.fal.media/files/b/preview.png","content_type":"image/png","file_name":"preview.png","file_size":99797},"model_urls":{"glb":{"url":"https://v3b.fal.media/files/b/model.glb"},"fbx":null,"obj":{"url":"https://v3b.fal.media/files/b/model.obj"},"usdz":null},"seed":null}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).unwrap(); + + let glb = extracted.model_glb.unwrap(); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/model.glb")); + assert_eq!(glb.file_size, Some(33352724)); + + let thumb = extracted.thumbnail.unwrap(); + assert_eq!(thumb.url.as_deref(), Some("https://v3b.fal.media/files/b/preview.png")); + + assert!(extracted.images.is_none()); + assert!(extracted.video.is_none()); + } + + #[test] + fn no_known_keys_returns_none() { + let json = r#"{"some_unknown_field": "value"}"#; + let value: Value = serde_json::from_str(json).unwrap(); + assert!(extract_contents_from_response(&value).is_none()); + } + + #[test] + fn parse_real_image_response_offline() { + let json = r#"{"images":[{"url":"https://v3b.fal.media/files/b/0a99d392/qzx8aXgWTbf5tVcYEF0S8.jpg","width":1024,"height":768,"content_type":"image/jpeg"}],"timings":{"inference":1.1978995269964798},"seed":1248735483,"has_nsfw_concepts":[false],"prompt":"a giant robot fighting a dragon in a futuristic city"}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).expect("should extract contents"); + + // Should have images, not video or mesh + assert!(extracted.video.is_none()); + assert!(extracted.model_glb.is_none()); + assert!(extracted.thumbnail.is_none()); + + let images = extracted.images.expect("should have images"); + assert_eq!(images.len(), 1); + + let image = &images[0]; + assert_eq!(image.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d392/qzx8aXgWTbf5tVcYEF0S8.jpg")); + assert_eq!(image.width, Some(1024)); + assert_eq!(image.height, Some(768)); + assert_eq!(image.content_type.as_deref(), Some("image/jpeg")); + + // Verify raw payload also has seed, prompt, timings + assert_eq!(value.get("seed").and_then(|v| v.as_u64()), Some(1248735483)); + assert_eq!(value.get("prompt").and_then(|v| v.as_str()), Some("a giant robot fighting a dragon in a futuristic city")); + let inference_time = value.get("timings").and_then(|v| v.get("inference")).and_then(|v| v.as_f64()).unwrap(); + assert!((inference_time - 1.198).abs() < 0.001); + } + + #[test] + fn parse_real_mesh_response_offline() { + let json = r#"{"model_glb":{"url":"https://v3b.fal.media/files/b/0a99d693/98becABi5mxR6w5Svy4oB_model.glb","content_type":"model/gltf-binary","file_name":"model.glb","file_size":33352724},"thumbnail":{"url":"https://v3b.fal.media/files/b/0a99d693/_wB78l-a_WmrlAzaKyTWy_preview.png","content_type":"image/png","file_name":"preview.png","file_size":99797},"model_urls":{"glb":{"url":"https://v3b.fal.media/files/b/0a99d693/98becABi5mxR6w5Svy4oB_model.glb","content_type":"model/gltf-binary","file_name":"model.glb","file_size":33352724},"fbx":null,"obj":{"url":"https://v3b.fal.media/files/b/0a99d693/_sxg6RiOiz_N9Eut1uFQo_model.obj","content_type":"text/plain","file_name":"model.obj","file_size":26194790},"usdz":null},"seed":null}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).expect("should extract contents"); + + // Should have model_glb + thumbnail, not images or video + assert!(extracted.images.is_none()); + assert!(extracted.video.is_none()); + + let glb = extracted.model_glb.expect("should have model_glb"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d693/98becABi5mxR6w5Svy4oB_model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("model.glb")); + assert_eq!(glb.file_size, Some(33352724)); + + let thumbnail = extracted.thumbnail.expect("should have thumbnail"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d693/_wB78l-a_WmrlAzaKyTWy_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(99797)); + + // Verify raw payload also has model_urls with OBJ + let obj = value.get("model_urls").and_then(|v| v.get("obj")).unwrap(); + assert_eq!(obj.get("url").and_then(|v| v.as_str()), Some("https://v3b.fal.media/files/b/0a99d693/_sxg6RiOiz_N9Eut1uFQo_model.obj")); + assert_eq!(obj.get("content_type").and_then(|v| v.as_str()), Some("text/plain")); + assert_eq!(obj.get("file_name").and_then(|v| v.as_str()), Some("model.obj")); + assert_eq!(obj.get("file_size").and_then(|v| v.as_u64()), Some(26194790)); + + // FBX and USDZ are null + assert!(value.get("model_urls").and_then(|v| v.get("fbx")).and_then(|v| v.as_object()).is_none()); + assert!(value.get("model_urls").and_then(|v| v.get("usdz")).and_then(|v| v.as_object()).is_none()); + } + + #[test] + fn parse_real_kling3_video_response_offline() { + let json = r#"{"video":{"url":"https://v3b.fal.media/files/b/0a99d90a/v1tQEfvnY2bVcn38IvmfD_output.mp4","content_type":"video/mp4","file_name":"output.mp4","file_size":3096422}}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).expect("should extract contents"); + + // Should have video, not images or mesh + assert!(extracted.image.is_none()); + assert!(extracted.images.is_none()); + assert!(extracted.model_glb.is_none()); + assert!(extracted.thumbnail.is_none()); + + let video = extracted.video.expect("should have video"); + assert_eq!(video.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d90a/v1tQEfvnY2bVcn38IvmfD_output.mp4")); + assert_eq!(video.content_type.as_deref(), Some("video/mp4")); + assert_eq!(video.file_name.as_deref(), Some("output.mp4")); + assert_eq!(video.file_size, Some(3096422)); + } + + #[test] + fn parse_real_nano_banana_pro_edit_response_offline() { + let json = r#"{"images":[{"url":"https://v3b.fal.media/files/b/0a99d90e/IXN1B_4MHnozvltxEHfvX_BwTMO9xM.png","content_type":"image/png","file_name":"IXN1B_4MHnozvltxEHfvX_BwTMO9xM.png","file_size":null,"width":null,"height":null},{"url":"https://v3b.fal.media/files/b/0a99d90e/aj_Xu0cIUoVSZ6qSSxaZf_wy3l60NO.png","content_type":"image/png","file_name":"aj_Xu0cIUoVSZ6qSSxaZf_wy3l60NO.png","file_size":null,"width":null,"height":null}],"description":"**Developing Spooky Atmosphere**\n\ntest description"}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).expect("should extract contents"); + + // Should have images, not video or mesh + assert!(extracted.image.is_none()); + assert!(extracted.video.is_none()); + assert!(extracted.model_glb.is_none()); + assert!(extracted.thumbnail.is_none()); + + let images = extracted.images.expect("should have images"); + assert_eq!(images.len(), 2); + + assert_eq!(images[0].url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d90e/IXN1B_4MHnozvltxEHfvX_BwTMO9xM.png")); + assert_eq!(images[0].content_type.as_deref(), Some("image/png")); + assert!(images[0].width.is_none(), "nano banana pro edit returns null width"); + assert!(images[0].height.is_none(), "nano banana pro edit returns null height"); + assert!(images[0].file_size.is_none(), "nano banana pro edit returns null file_size"); + + assert_eq!(images[1].url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d90e/aj_Xu0cIUoVSZ6qSSxaZf_wy3l60NO.png")); + assert_eq!(images[1].content_type.as_deref(), Some("image/png")); + } + + #[test] + fn parse_real_flux_angle_lora_response_offline() { + let json = r#"{"images":[{"url":"https://v3b.fal.media/files/b/0a99d915/_61CGILQXk8A7A6FrAbdu_uytUbw2B.png","content_type":"image/png","file_name":"_61CGILQXk8A7A6FrAbdu_uytUbw2B.png","file_size":null,"width":1024,"height":1024}],"seed":225652535,"prompt":" front-right quarter view elevated shot medium shot"}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).expect("should extract contents"); + + // Should have images, not video or mesh + assert!(extracted.image.is_none()); + assert!(extracted.video.is_none()); + assert!(extracted.model_glb.is_none()); + assert!(extracted.thumbnail.is_none()); + + let images = extracted.images.expect("should have images"); + assert_eq!(images.len(), 1); + + let image = &images[0]; + assert_eq!(image.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d915/_61CGILQXk8A7A6FrAbdu_uytUbw2B.png")); + assert_eq!(image.content_type.as_deref(), Some("image/png")); + assert_eq!(image.width, Some(1024)); + assert_eq!(image.height, Some(1024)); + assert!(image.file_size.is_none()); + + // Verify raw payload fields + assert_eq!(value.get("seed").and_then(|v| v.as_u64()), Some(225652535)); + assert_eq!(value.get("prompt").and_then(|v| v.as_str()), Some(" front-right quarter view elevated shot medium shot")); + } + + #[test] + fn parse_real_remove_bg_response_offline() { + let json = r#"{"image":{"url":"https://v3b.fal.media/files/b/0a99d916/J7OyBamMKRI_RUbkUxnJE_f5b8faa705534b19ad87bc3d48b5c6c5.png","content_type":"image/png","file_name":"f5b8faa705534b19ad87bc3d48b5c6c5.png","file_size":496291,"width":1000,"height":664}}"#; + let value: Value = serde_json::from_str(json).unwrap(); + let extracted = extract_contents_from_response(&value).expect("should extract contents"); + + // Should have single image, not images (plural), video, or mesh + assert!(extracted.images.is_none()); + assert!(extracted.video.is_none()); + assert!(extracted.model_glb.is_none()); + assert!(extracted.thumbnail.is_none()); + + let image = extracted.image.expect("should have single image"); + assert_eq!(image.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d916/J7OyBamMKRI_RUbkUxnJE_f5b8faa705534b19ad87bc3d48b5c6c5.png")); + assert_eq!(image.content_type.as_deref(), Some("image/png")); + assert_eq!(image.file_name.as_deref(), Some("f5b8faa705534b19ad87bc3d48b5c6c5.png")); + assert_eq!(image.file_size, Some(496291)); + assert_eq!(image.width, Some(1000)); + assert_eq!(image.height, Some(664)); + } + } + + // ── Live tests ── + + #[tokio::test] + #[ignore] // requires real API key + async fn poll_completed_image_job() { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal.api_key.txt") + .expect("Failed to read fal.api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + + let args = PollJobResponseArgs { + response_url: "https://queue.fal.run/fal-ai/flux/requests/019e18d8-8c36-7bc1-aa77-2bc2f70268c6", + api_key: &api_key, + }; + + let result = poll_job_response(args).await.expect("poll should succeed"); + let extracted = result.extracted_contents.expect("should have extracted contents"); + + // Should have images, not video or mesh + assert!(extracted.video.is_none()); + assert!(extracted.model_glb.is_none()); + assert!(extracted.thumbnail.is_none()); + + let images = extracted.images.expect("should have images"); + assert_eq!(images.len(), 1); + + let image = &images[0]; + assert_eq!(image.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d392/qzx8aXgWTbf5tVcYEF0S8.jpg")); + assert_eq!(image.width, Some(1024)); + assert_eq!(image.height, Some(768)); + assert_eq!(image.content_type.as_deref(), Some("image/jpeg")); + } + + #[tokio::test] + #[ignore] // requires real API key + async fn poll_completed_mesh_job() { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal.api_key.txt") + .expect("Failed to read fal.api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + + let args = PollJobResponseArgs { + response_url: "https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e194b-f69a-77b1-bada-3f56d7d3c87d", + api_key: &api_key, + }; + + let result = poll_job_response(args).await.expect("poll should succeed"); + let extracted = result.extracted_contents.expect("should have extracted contents"); + + // Should have model_glb + thumbnail, not images or video + assert!(extracted.images.is_none()); + assert!(extracted.video.is_none()); + + let glb = extracted.model_glb.expect("should have model_glb"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d693/98becABi5mxR6w5Svy4oB_model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("model.glb")); + assert_eq!(glb.file_size, Some(33352724)); + + let thumbnail = extracted.thumbnail.expect("should have thumbnail"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0a99d693/_wB78l-a_WmrlAzaKyTWy_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(99797)); + } +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/raw_response.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/raw_response.rs new file mode 100644 index 00000000..11b81fb8 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/raw_response.rs @@ -0,0 +1,12 @@ +use serde::Deserialize; + +/// Raw JSON response returned by the FAL queue response endpoint +/// when the job is still in progress (HTTP 400). +#[derive(Debug, Deserialize)] +pub struct RawIncompleteJobResponse { + pub detail: Option, + pub request_id: Option, + pub response_url: Option, + pub status_url: Option, + pub cancel_url: Option, +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_image.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_image.rs new file mode 100644 index 00000000..a49e9647 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_image.rs @@ -0,0 +1,17 @@ +use serde::Deserialize; +use serde_json::Value; + +#[derive(Debug, Clone, Deserialize)] +pub struct PollResponseSingleImageData { + pub url: Option, + pub width: Option, + pub height: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, +} + +pub fn extract_image(value: &Value) -> Option { + let image = value.get("image")?; + serde_json::from_value(image.clone()).ok() +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_images.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_images.rs new file mode 100644 index 00000000..76191295 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_images.rs @@ -0,0 +1,20 @@ +use serde::Deserialize; +use serde_json::Value; + +#[derive(Debug, Clone, Deserialize)] +pub struct PollResponseImageEntry { + pub url: Option, + pub width: Option, + pub height: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, +} + +pub fn extract_images(value: &Value) -> Option> { + let arr = value.get("images")?.as_array()?; + let images: Vec = arr.iter() + .filter_map(|v| serde_json::from_value(v.clone()).ok()) + .collect(); + if images.is_empty() { None } else { Some(images) } +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_model_glb.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_model_glb.rs new file mode 100644 index 00000000..4b121153 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_model_glb.rs @@ -0,0 +1,15 @@ +use serde::Deserialize; +use serde_json::Value; + +#[derive(Debug, Clone, Deserialize)] +pub struct PollResponseModelGlbData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, +} + +pub fn extract_model_glb(value: &Value) -> Option { + let model_glb = value.get("model_glb")?; + serde_json::from_value(model_glb.clone()).ok() +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_thumbnail.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_thumbnail.rs new file mode 100644 index 00000000..0d643c13 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_thumbnail.rs @@ -0,0 +1,15 @@ +use serde::Deserialize; +use serde_json::Value; + +#[derive(Debug, Clone, Deserialize)] +pub struct PollResponseThumbnailData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, +} + +pub fn extract_thumbnail(value: &Value) -> Option { + let thumbnail = value.get("thumbnail")?; + serde_json::from_value(thumbnail.clone()).ok() +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_video.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_video.rs new file mode 100644 index 00000000..326c60d1 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/extract_video.rs @@ -0,0 +1,15 @@ +use serde::Deserialize; +use serde_json::Value; + +#[derive(Debug, Clone, Deserialize)] +pub struct PollResponseVideoData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, +} + +pub fn extract_video(value: &Value) -> Option { + let video = value.get("video")?; + serde_json::from_value(video.clone()).ok() +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/mod.rs b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/mod.rs new file mode 100644 index 00000000..260eccfb --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_response/success_case_extractors/mod.rs @@ -0,0 +1,49 @@ +pub mod extract_image; +pub mod extract_images; +pub mod extract_model_glb; +pub mod extract_thumbnail; +pub mod extract_video; + +use serde_json::Value; + +use crate::polling::poll_job_response::success_case_extractors::extract_image::PollResponseSingleImageData; +use crate::polling::poll_job_response::success_case_extractors::extract_images::PollResponseImageEntry; +use crate::polling::poll_job_response::success_case_extractors::extract_model_glb::PollResponseModelGlbData; +use crate::polling::poll_job_response::success_case_extractors::extract_thumbnail::PollResponseThumbnailData; +use crate::polling::poll_job_response::success_case_extractors::extract_video::PollResponseVideoData; + +/// Extracted content fields from a successful job response. +/// Multiple fields can be populated simultaneously (e.g. model_glb + thumbnail). +#[derive(Debug, Clone)] +pub struct PollResponseExtractedContents { + /// Parsed from `payload.image` (single image result, e.g. background removal). + pub image: Option, + /// Parsed from `payload.images` (batch image results). + pub images: Option>, + pub video: Option, + pub model_glb: Option, + pub thumbnail: Option, +} + +/// Try to extract known content keys from a success response payload. +pub fn extract_contents_from_response(value: &Value) -> Option { + let image = extract_image::extract_image(value); + let images = extract_images::extract_images(value); + let video = extract_video::extract_video(value); + let model_glb = extract_model_glb::extract_model_glb(value); + let thumbnail = extract_thumbnail::extract_thumbnail(value); + + if image.is_none() && images.is_none() && video.is_none() + && model_glb.is_none() && thumbnail.is_none() + { + return None; + } + + Some(PollResponseExtractedContents { + image, + images, + video, + model_glb, + thumbnail, + }) +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_status/mod.rs b/crates/api_clients/fal_client/src/polling/poll_job_status/mod.rs new file mode 100644 index 00000000..5d53f26e --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_status/mod.rs @@ -0,0 +1,2 @@ +pub mod poll_job_status; +pub mod raw_response; diff --git a/crates/api_clients/fal_client/src/polling/poll_job_status/poll_job_status.rs b/crates/api_clients/fal_client/src/polling/poll_job_status/poll_job_status.rs new file mode 100644 index 00000000..5e114956 --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_status/poll_job_status.rs @@ -0,0 +1,245 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::api_generic_error::FalGenericApiError; +use crate::error::client_error::FalClientError; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::polling::poll_job_status::raw_response::RawPollJobStatusResponse; +use log::info; +use url::Url; + +const EXPECTED_HOST: &str = "queue.fal.run"; + +pub struct PollJobStatusArgs<'a> { + /// This is the "status" URL, not the "response" URL. + /// This only gives us the progress of the job, not details of the final results upon completion. + pub status_url: &'a str, + + pub api_key: &'a FalApiKey, +} + +/// The parsed status of a FAL queue job. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum FalJobStatus { + /// Request is queued, waiting for a runner. + InQueue, + /// A runner is actively processing the request. + InProgress, + /// Processing is complete; results are available at the response URL. + Completed, + /// A status value we haven't mapped yet. + Unknown(String), +} + +/// Parsed response from polling a FAL job's status. +#[derive(Debug)] +pub struct PollJobStatusResponse { + /// The job's current status. + pub status: FalJobStatus, + /// The request ID for this job. + pub request_id: Option, + /// URL to retrieve the completed result. + pub response_url: Option, + /// Queue position (only present when status is InQueue). + pub maybe_queue_position: Option, + /// Inference time in seconds (only present when status is Completed). + pub maybe_inference_time: Option, + /// The raw JSON response body, preserved for debugging or further parsing. + pub raw_body: String, +} + +/// Poll the status of a queued FAL job. +/// +/// The `status_url` must point to `queue.fal.run`. +pub async fn poll_job_status(args: PollJobStatusArgs<'_>) -> Result { + let parsed = Url::parse(args.status_url)?; + + let host = parsed.host_str().unwrap_or(""); + + if host != EXPECTED_HOST { + return Err(FalErrorPlus::ClientError(FalClientError::InvalidUrl(format!( + "Expected host '{}' but got '{}' in status URL: {}", + EXPECTED_HOST, + host, + args.status_url, + )))); + } + + info!("Polling FAL job status: {}", args.status_url); + + let response = reqwest::Client::new() + .get(args.status_url) + .header("Authorization", format!("Key {}", args.api_key.0)) + .send() + .await?; + + let http_status = response.status(); + let body = response.text().await?; + + if !http_status.is_success() { + return Err(FalErrorPlus::ApiGeneric( + FalGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: http_status, + body, + }, + )); + } + + let raw: RawPollJobStatusResponse = serde_json::from_str(&body) + .map_err(|err| FalErrorPlus::ApiGeneric( + FalGenericApiError::SerdeResponseParseErrorWithBody { + error: err, + body: body.clone(), + }, + ))?; + + let status = match raw.status.as_str() { + "IN_QUEUE" => FalJobStatus::InQueue, + "IN_PROGRESS" => FalJobStatus::InProgress, + "COMPLETED" => FalJobStatus::Completed, + other => FalJobStatus::Unknown(other.to_string()), + }; + + let maybe_inference_time = raw.metrics + .and_then(|m| m.inference_time); + + Ok(PollJobStatusResponse { + status, + request_id: raw.request_id, + response_url: raw.response_url, + maybe_queue_position: raw.queue_position, + maybe_inference_time, + raw_body: body, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // ── Unit tests (no network) ── + + #[tokio::test] + async fn rejects_wrong_host() { + let api_key = FalApiKey::from_str("test-key"); + let args = PollJobStatusArgs { + status_url: "https://evil.example.com/fal-ai/flux/requests/abc123", + api_key: &api_key, + }; + let result = poll_job_status(args).await; + assert!(result.is_err()); + let err = format!("{}", result.unwrap_err()); + assert!(err.contains("evil.example.com"), "error should mention the bad host: {}", err); + } + + #[tokio::test] + async fn rejects_invalid_url() { + let api_key = FalApiKey::from_str("test-key"); + let args = PollJobStatusArgs { + status_url: "not a url at all", + api_key: &api_key, + }; + let result = poll_job_status(args).await; + assert!(result.is_err()); + } + + #[test] + fn accepts_valid_host() { + let parsed = Url::parse("https://queue.fal.run/fal-ai/flux/requests/019e18d8-8c36-7bc1-aa77-2bc2f70268c6").unwrap(); + assert_eq!(parsed.host_str(), Some(EXPECTED_HOST)); + } + + // ── Parsing tests ── + + mod parsing { + use super::*; + use crate::polling::poll_job_status::raw_response::RawPollJobStatusResponse; + + #[test] + fn parse_completed_response() { + let json = r#"{"status":"COMPLETED","request_id":"019e194b-f69a-77b1-bada-3f56d7d3c87d","response_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e194b-f69a-77b1-bada-3f56d7d3c87d","status_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e194b-f69a-77b1-bada-3f56d7d3c87d/status","cancel_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e194b-f69a-77b1-bada-3f56d7d3c87d/cancel","logs":null,"metrics":{"inference_time":126.701406955719}}"#; + let raw: RawPollJobStatusResponse = serde_json::from_str(json).unwrap(); + assert_eq!(raw.status, "COMPLETED"); + assert_eq!(raw.request_id.as_deref(), Some("019e194b-f69a-77b1-bada-3f56d7d3c87d")); + assert!(raw.response_url.is_some()); + assert!(raw.queue_position.is_none()); + assert!((raw.metrics.unwrap().inference_time.unwrap() - 126.7).abs() < 1.0); + } + + #[test] + fn parse_in_queue_response() { + let json = r#"{"status":"IN_QUEUE","request_id":"019e1951-c778-7120-9c82-16efcf40ec82","response_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e1951-c778-7120-9c82-16efcf40ec82","status_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e1951-c778-7120-9c82-16efcf40ec82/status","cancel_url":"https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e1951-c778-7120-9c82-16efcf40ec82/cancel","logs":null,"metrics":{},"queue_position":0}"#; + let raw: RawPollJobStatusResponse = serde_json::from_str(json).unwrap(); + assert_eq!(raw.status, "IN_QUEUE"); + assert_eq!(raw.queue_position, Some(0)); + assert!(raw.metrics.unwrap().inference_time.is_none()); + } + + #[test] + fn status_enum_mapping() { + assert_eq!( + match "IN_QUEUE" { "IN_QUEUE" => FalJobStatus::InQueue, _ => unreachable!() }, + FalJobStatus::InQueue + ); + assert_eq!( + match "IN_PROGRESS" { "IN_PROGRESS" => FalJobStatus::InProgress, _ => unreachable!() }, + FalJobStatus::InProgress + ); + assert_eq!( + match "COMPLETED" { "COMPLETED" => FalJobStatus::Completed, _ => unreachable!() }, + FalJobStatus::Completed + ); + } + + #[test] + fn unknown_status_preserved() { + let status = match "SOMETHING_NEW" { + "IN_QUEUE" => FalJobStatus::InQueue, + "IN_PROGRESS" => FalJobStatus::InProgress, + "COMPLETED" => FalJobStatus::Completed, + other => FalJobStatus::Unknown(other.to_string()), + }; + assert_eq!(status, FalJobStatus::Unknown("SOMETHING_NEW".to_string())); + } + } + + // ── Live tests ── + + #[tokio::test] + #[ignore] // requires real API key + async fn poll_single_image_job() { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal.api_key.txt") + .expect("Failed to read fal.api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + + let args = PollJobStatusArgs { + status_url: "https://queue.fal.run/fal-ai/flux/requests/019e18d8-8c36-7bc1-aa77-2bc2f70268c6", + api_key: &api_key, + }; + + let result = poll_job_status(args).await.expect("poll should succeed"); + println!("Status: {:?}", result.status); + println!("Response URL: {:?}", result.response_url); + println!("Inference time: {:?}", result.maybe_inference_time); + assert_eq!(result.status, FalJobStatus::Completed); + assert!(result.response_url.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key + async fn poll_single_mesh_status_job() { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal.api_key.txt") + .expect("Failed to read fal.api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + + let args = PollJobStatusArgs { + status_url: "https://queue.fal.run/fal-ai/hunyuan3d-v3/requests/019e194b-f69a-77b1-bada-3f56d7d3c87d/status", + api_key: &api_key, + }; + + let result = poll_job_status(args).await.expect("poll should succeed"); + println!("Status: {:?}", result.status); + println!("Response URL: {:?}", result.response_url); + println!("Inference time: {:?}", result.maybe_inference_time); + println!("Raw body: {}", result.raw_body); + assert_eq!(result.status, FalJobStatus::Completed); + } +} diff --git a/crates/api_clients/fal_client/src/polling/poll_job_status/raw_response.rs b/crates/api_clients/fal_client/src/polling/poll_job_status/raw_response.rs new file mode 100644 index 00000000..8266709f --- /dev/null +++ b/crates/api_clients/fal_client/src/polling/poll_job_status/raw_response.rs @@ -0,0 +1,29 @@ +use serde::Deserialize; + +/// Raw JSON response from the FAL queue status endpoint. +/// +/// See: https://fal.ai/docs/documentation/model-apis/inference/queue +#[derive(Debug, Deserialize)] +pub struct RawPollJobStatusResponse { + pub status: String, + pub request_id: Option, + pub response_url: Option, + pub status_url: Option, + pub cancel_url: Option, + pub queue_position: Option, + pub logs: Option>, + pub metrics: Option, +} + +#[derive(Debug, Deserialize)] +pub struct RawPollJobStatusLog { + pub message: Option, + pub level: Option, + pub source: Option, + pub timestamp: Option, +} + +#[derive(Debug, Deserialize)] +pub struct RawPollJobStatusMetrics { + pub inference_time: Option, +} diff --git a/crates/api_clients/fal_client/src/requests/api/audio/mod.rs b/crates/api_clients/fal_client/src/requests/api/audio/mod.rs new file mode 100644 index 00000000..603cfcb3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/audio/mod.rs @@ -0,0 +1 @@ +pub mod omni; diff --git a/crates/api_clients/fal_client/src/requests/api/audio/omni/mod.rs b/crates/api_clients/fal_client/src/requests/api/audio/omni/mod.rs new file mode 100644 index 00000000..b93956a4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/audio/omni/mod.rs @@ -0,0 +1 @@ +pub mod seed_audio_1p0; diff --git a/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/api.rs b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/api.rs new file mode 100644 index 00000000..a05c9a14 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/api.rs @@ -0,0 +1,459 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::audio::omni::seed_audio_1p0::raw_request::{ + SeedAudio1p0Input, SeedAudio1p0Output, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// ByteDance Seed Audio 1.0: omni audio generation (speech, drama, ambience) +/// with voice presets, voice cloning, and audio/image references. +#[derive(Clone, Debug)] +pub struct SeedAudio1p0Request { + /// Text to synthesize. Reference audio clips supplied via `audio_urls` are + /// cited in the prompt as `@Audio1`, `@Audio2`, `@Audio3`. + pub prompt: String, + + /// Voice to synthesize with: a preset or a cloned voice id. + /// The model picks a voice when `None`. + pub voice: Option, + + /// Up to 3 reference audio URLs, cited in the prompt as `@Audio1`–`@Audio3`. + /// Each clip: ≤30 seconds, ≤10MB, wav/mp3/pcm/ogg_opus. + pub audio_urls: Option>, + + /// A single reference image URL (jpeg/png/webp, ≤10MB) to condition the + /// generation on (e.g. a scene to voice over). + /// NB: fal rejects requests that combine an image reference with audio + /// references — set `image_url` or `audio_urls`, not both. + pub image_url: Option, + + /// Output container. fal's default is mp3 when `None`. + pub output_format: Option, + + /// Output sample rate. fal's default is 24 kHz when `None`. + pub sample_rate: Option, + + /// Speech speed multiplier. Valid range 0.5–2.0; fal's default is 1.0 + /// when `None`. + pub speed: Option, + + /// Volume multiplier. Valid range 0.5–2.0; fal's default is 1.0 when `None`. + pub volume: Option, + + /// Pitch shift in semitones. Valid range −12 to +12; fal's default is 0 + /// when `None`. + pub pitch: Option, +} + +/// A voice for Seed Audio: either one of fal's preset voices or a cloned +/// voice id. +#[derive(Clone, Debug, Eq, PartialEq)] +pub enum SeedAudio1p0Voice { + Preset(SeedAudio1p0VoicePreset), + /// The id of a cloned voice. + Custom(String), +} + +impl SeedAudio1p0Voice { + fn to_wire_string(&self) -> String { + match self { + Self::Preset(preset) => preset.to_str().to_string(), + Self::Custom(voice_id) => voice_id.clone(), + } + } +} + +/// fal's preset voices. The suffixes name the languages each voice supports +/// (en = English, zh = Chinese, ja = Japanese, es = Spanish, id = Indonesian, +/// pt = Portuguese). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum SeedAudio1p0VoicePreset { + ViviMixedEnZhJaEsId, + MindyEnEsIdPtZh, + KianEnZh, + CedricEnZh, + SophieEnZh, + JeanEnZh, + MagnusEnZh, + MabelEnZh, + NadiaEnZh, + OpalEnZh, + PearlEnZh, + QuentinEnZh, + CorinneMixedEnZh, + EstherMixedEnZh, + LylaMixedEnZh, + TracyEsZh, + SandyEsMixedEnZh, + FelixZh, + CelesteZh, + MonkeyKingZh, +} + +impl SeedAudio1p0VoicePreset { + pub fn to_str(&self) -> &'static str { + match self { + Self::ViviMixedEnZhJaEsId => "vivi_mixed_en_zh_ja_es_id", + Self::MindyEnEsIdPtZh => "mindy_en_es_id_pt_zh", + Self::KianEnZh => "kian_en_zh", + Self::CedricEnZh => "cedric_en_zh", + Self::SophieEnZh => "sophie_en_zh", + Self::JeanEnZh => "jean_en_zh", + Self::MagnusEnZh => "magnus_en_zh", + Self::MabelEnZh => "mabel_en_zh", + Self::NadiaEnZh => "nadia_en_zh", + Self::OpalEnZh => "opal_en_zh", + Self::PearlEnZh => "pearl_en_zh", + Self::QuentinEnZh => "quentin_en_zh", + Self::CorinneMixedEnZh => "corinne_mixed_en_zh", + Self::EstherMixedEnZh => "esther_mixed_en_zh", + Self::LylaMixedEnZh => "lyla_mixed_en_zh", + Self::TracyEsZh => "tracy_es_zh", + Self::SandyEsMixedEnZh => "sandy_es_mixed_en_zh", + Self::FelixZh => "felix_zh", + Self::CelesteZh => "celeste_zh", + Self::MonkeyKingZh => "monkey_king_zh", + } + } + + pub fn all() -> [Self; 20] { + [ + Self::ViviMixedEnZhJaEsId, + Self::MindyEnEsIdPtZh, + Self::KianEnZh, + Self::CedricEnZh, + Self::SophieEnZh, + Self::JeanEnZh, + Self::MagnusEnZh, + Self::MabelEnZh, + Self::NadiaEnZh, + Self::OpalEnZh, + Self::PearlEnZh, + Self::QuentinEnZh, + Self::CorinneMixedEnZh, + Self::EstherMixedEnZh, + Self::LylaMixedEnZh, + Self::TracyEsZh, + Self::SandyEsMixedEnZh, + Self::FelixZh, + Self::CelesteZh, + Self::MonkeyKingZh, + ] + } +} + +/// Output audio container. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum SeedAudio1p0OutputFormat { + Wav, + /// fal's default. + Mp3, + Pcm, + OggOpus, +} + +impl SeedAudio1p0OutputFormat { + fn to_str(&self) -> &'static str { + match self { + Self::Wav => "wav", + Self::Mp3 => "mp3", + Self::Pcm => "pcm", + Self::OggOpus => "ogg_opus", + } + } +} + +/// Output sample rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum SeedAudio1p0SampleRate { + Hz8000, + Hz16000, + /// fal's default. + Hz24000, + Hz32000, + Hz44100, + Hz48000, +} + +impl SeedAudio1p0SampleRate { + fn as_hz(&self) -> u32 { + match self { + Self::Hz8000 => 8_000, + Self::Hz16000 => 16_000, + Self::Hz24000 => 24_000, + Self::Hz32000 => 32_000, + Self::Hz44100 => 44_100, + Self::Hz48000 => 48_000, + } + } +} + +impl FalEndpoint for SeedAudio1p0Request { + const ENDPOINT: &str = "bytedance/seed-audio-1.0"; + + type RawRequest = SeedAudio1p0Input; + type RawResponse = SeedAudio1p0Output; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + voice: self.voice.as_ref().map(|voice| voice.to_wire_string()), + audio_urls: self.audio_urls.clone(), + image_url: self.image_url.clone(), + output_format: self.output_format.map(|format| format.to_str().to_string()), + sample_rate: self.sample_rate.map(|rate| rate.as_hz()), + speed: self.speed, + volume: self.volume, + pitch: self.pitch, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_seed_audio_queue_minimal() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = SeedAudio1p0Request { + prompt: "Generate a short suspense radio drama in a late-night convenience store.".to_string(), + voice: None, + audio_urls: None, + image_url: None, + output_format: None, + sample_rate: None, + speed: None, + volume: None, + pitch: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_seed_audio_queue_preset_voice_tuned() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = SeedAudio1p0Request { + prompt: "Welcome aboard the midnight express. Please keep your arms inside the train at all times.".to_string(), + voice: Some(SeedAudio1p0Voice::Preset(SeedAudio1p0VoicePreset::MagnusEnZh)), + audio_urls: None, + image_url: None, + output_format: Some(SeedAudio1p0OutputFormat::Wav), + sample_rate: Some(SeedAudio1p0SampleRate::Hz44100), + speed: Some(0.9), + volume: Some(1.2), + pitch: Some(-2), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_seed_audio_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = SeedAudio1p0Request { + prompt: "A calm narrator describes ocean waves rolling onto a moonlit beach.".to_string(), + voice: Some(SeedAudio1p0Voice::Preset(SeedAudio1p0VoicePreset::SophieEnZh)), + audio_urls: None, + image_url: None, + output_format: Some(SeedAudio1p0OutputFormat::Mp3), + sample_rate: None, + speed: None, + volume: None, + pitch: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = SeedAudio1p0Request { + prompt: "Read @Audio1 in this voice.".to_string(), + voice: Some(SeedAudio1p0Voice::Preset(SeedAudio1p0VoicePreset::ViviMixedEnZhJaEsId)), + audio_urls: Some(vec![ + "https://example.com/a1.mp3".to_string(), + "https://example.com/a2.wav".to_string(), + "https://example.com/a3.ogg".to_string(), + ]), + image_url: None, + output_format: Some(SeedAudio1p0OutputFormat::OggOpus), + sample_rate: Some(SeedAudio1p0SampleRate::Hz48000), + speed: Some(1.5), + volume: Some(0.5), + pitch: Some(12), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "Read @Audio1 in this voice."); + assert_eq!(raw.voice.as_deref(), Some("vivi_mixed_en_zh_ja_es_id")); + assert_eq!(raw.audio_urls.as_ref().map(|urls| urls.len()), Some(3)); + assert_eq!(raw.image_url, None); + assert_eq!(raw.output_format.as_deref(), Some("ogg_opus")); + assert_eq!(raw.sample_rate, Some(48_000)); + assert_eq!(raw.speed, Some(1.5)); + assert_eq!(raw.volume, Some(0.5)); + assert_eq!(raw.pitch, Some(12)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = SeedAudio1p0Request { + prompt: "minimal".to_string(), + voice: None, + audio_urls: None, + image_url: None, + output_format: None, + sample_rate: None, + speed: None, + volume: None, + pitch: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn custom_voice_id_passes_through_verbatim() { + let request = SeedAudio1p0Request { + prompt: "p".to_string(), + voice: Some(SeedAudio1p0Voice::Custom("my_cloned_voice_id_123".to_string())), + audio_urls: None, + image_url: None, + output_format: None, + sample_rate: None, + speed: None, + volume: None, + pitch: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.voice.as_deref(), Some("my_cloned_voice_id_123")); + } + + #[test] + fn image_url_serializes_when_set() { + let request = SeedAudio1p0Request { + prompt: "Narrate this scene.".to_string(), + voice: None, + audio_urls: None, + image_url: Some("https://example.com/scene.png".to_string()), + output_format: None, + sample_rate: None, + speed: None, + volume: None, + pitch: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "Narrate this scene.", + "image_url": "https://example.com/scene.png", + }), + ); + } + + #[test] + fn negative_pitch_serializes() { + let request = SeedAudio1p0Request { + prompt: "p".to_string(), + voice: None, + audio_urls: None, + image_url: None, + output_format: None, + sample_rate: None, + speed: None, + volume: None, + pitch: Some(-12), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("pitch").and_then(|p| p.as_i64()), Some(-12)); + } + + #[test] + fn every_voice_preset_maps_to_wire_string() { + let expected = [ + "vivi_mixed_en_zh_ja_es_id", + "mindy_en_es_id_pt_zh", + "kian_en_zh", + "cedric_en_zh", + "sophie_en_zh", + "jean_en_zh", + "magnus_en_zh", + "mabel_en_zh", + "nadia_en_zh", + "opal_en_zh", + "pearl_en_zh", + "quentin_en_zh", + "corinne_mixed_en_zh", + "esther_mixed_en_zh", + "lyla_mixed_en_zh", + "tracy_es_zh", + "sandy_es_mixed_en_zh", + "felix_zh", + "celeste_zh", + "monkey_king_zh", + ]; + for (preset, expected) in SeedAudio1p0VoicePreset::all().iter().zip(expected) { + assert_eq!(preset.to_str(), expected, "wire value for {preset:?}"); + } + } + + #[test] + fn every_output_format_maps_to_wire_string() { + for (variant, expected) in [ + (SeedAudio1p0OutputFormat::Wav, "wav"), + (SeedAudio1p0OutputFormat::Mp3, "mp3"), + (SeedAudio1p0OutputFormat::Pcm, "pcm"), + (SeedAudio1p0OutputFormat::OggOpus, "ogg_opus"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn every_sample_rate_maps_to_hz() { + for (variant, expected) in [ + (SeedAudio1p0SampleRate::Hz8000, 8_000), + (SeedAudio1p0SampleRate::Hz16000, 16_000), + (SeedAudio1p0SampleRate::Hz24000, 24_000), + (SeedAudio1p0SampleRate::Hz32000, 32_000), + (SeedAudio1p0SampleRate::Hz44100, 44_100), + (SeedAudio1p0SampleRate::Hz48000, 48_000), + ] { + assert_eq!(variant.as_hz(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(SeedAudio1p0Request::ENDPOINT, "bytedance/seed-audio-1.0"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/cost.rs b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/cost.rs new file mode 100644 index 00000000..1213a3db --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/cost.rs @@ -0,0 +1,128 @@ +use crate::requests::api::audio::omni::seed_audio_1p0::api::SeedAudio1p0Request; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Seed Audio 1.0 pricing (see https://fal.ai/models/bytedance/seed-audio-1.0): +// "Your request will cost $0.1875 per minute." +// +// fal bills per minute of GENERATED audio, and no request parameter fixes the +// output duration — it depends on the prompt. The rate is stored in +// hundredths-of-a-cent per minute (exact), and per-duration costs are rounded +// UP to whole cents so the user is never undercharged. + +/// $0.1875 per minute, in hundredths of a cent. +pub const SEED_AUDIO_1P0_RATE_HUNDREDTH_CENTS_PER_MINUTE: u64 = 1_875; + +/// The duration assumed by the parameterless [`FalRequestCostCalculator`] +/// estimate (the output length isn't knowable at request time). +pub const SEED_AUDIO_1P0_ESTIMATED_DURATION_SECONDS: u64 = 60; + +/// Cost in whole cents for a known output duration: +/// ceil(1875 hundredth-cents/min × seconds / 60 / 100). +pub fn seed_audio_1p0_cost_cents_for_duration_seconds(duration_seconds: u64) -> UsdCents { + (SEED_AUDIO_1P0_RATE_HUNDREDTH_CENTS_PER_MINUTE * duration_seconds).div_ceil(6_000) +} + +impl FalRequestCostCalculator for SeedAudio1p0Request { + /// The output duration isn't known until the audio is generated, so this + /// estimates one minute of output. Use + /// [`seed_audio_1p0_cost_cents_for_duration_seconds`] to price the actual + /// generated duration once it is known. + fn calculate_cost_in_cents(&self) -> UsdCents { + seed_audio_1p0_cost_cents_for_duration_seconds(SEED_AUDIO_1P0_ESTIMATED_DURATION_SECONDS) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod duration_cost_table { + use super::*; + + // (duration_seconds, expected_cents) + // Math: ceil($0.1875/min × seconds), i.e. ceil(18.75¢ × secs / 60). + const COST_TABLE: &[(u64, u64)] = &[ + (0, 0), + (1, 1), // 0.3125 → 1 + (10, 4), // 3.125 → 4 + (30, 10), // 9.375 → 10 + (32, 10), // exactly 10.0 + (60, 19), // 18.75 → 19 + (61, 20), // 19.0625 → 20 + (90, 29), // 28.125 → 29 + (96, 30), // exactly 30.0 + (120, 38), // 37.5 → 38 + (300, 94), // 93.75 → 94 + (600, 188), // 187.5 → 188 + ]; + + #[test] + fn matches_cost_table() { + for &(duration_seconds, expected) in COST_TABLE { + let got = seed_audio_1p0_cost_cents_for_duration_seconds(duration_seconds); + assert_eq!(got, expected, "duration_seconds={duration_seconds}"); + } + } + + #[test] + fn cost_scales_with_duration() { + let c30 = seed_audio_1p0_cost_cents_for_duration_seconds(30); + let c60 = seed_audio_1p0_cost_cents_for_duration_seconds(60); + let c120 = seed_audio_1p0_cost_cents_for_duration_seconds(120); + assert!(c30 < c60); + assert!(c60 < c120); + } + + #[test] + fn exact_minute_multiples_never_round() { + // 16 minutes = exactly 300¢ ($3.00): 1875 × 960 / 6000 = 300. + assert_eq!(seed_audio_1p0_cost_cents_for_duration_seconds(960), 300); + } + } + + mod request_estimate { + use super::*; + + fn make_request() -> SeedAudio1p0Request { + SeedAudio1p0Request { + prompt: "test".to_string(), + voice: None, + audio_urls: None, + image_url: None, + output_format: None, + sample_rate: None, + speed: None, + volume: None, + pitch: None, + } + } + + #[test] + fn estimates_one_minute() { + // 60s at $0.1875/min = 18.75¢ → rounds up to 19¢. + assert_eq!(make_request().calculate_cost_in_cents(), 19); + assert_eq!( + make_request().calculate_cost_in_cents(), + seed_audio_1p0_cost_cents_for_duration_seconds(SEED_AUDIO_1P0_ESTIMATED_DURATION_SECONDS), + ); + } + + #[test] + fn request_options_do_not_affect_the_estimate() { + use crate::requests::api::audio::omni::seed_audio_1p0::api::{ + SeedAudio1p0OutputFormat, SeedAudio1p0SampleRate, SeedAudio1p0Voice, + SeedAudio1p0VoicePreset, + }; + + let mut tuned = make_request(); + tuned.voice = Some(SeedAudio1p0Voice::Preset(SeedAudio1p0VoicePreset::FelixZh)); + tuned.output_format = Some(SeedAudio1p0OutputFormat::Wav); + tuned.sample_rate = Some(SeedAudio1p0SampleRate::Hz48000); + tuned.speed = Some(2.0); + tuned.volume = Some(0.5); + tuned.pitch = Some(-12); + + assert_eq!(tuned.calculate_cost_in_cents(), make_request().calculate_cost_in_cents()); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/mod.rs b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/raw_request.rs new file mode 100644 index 00000000..e763c50b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/audio/omni/seed_audio_1p0/raw_request.rs @@ -0,0 +1,61 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `bytedance/seed-audio-1.0`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedAudio1p0Input { + /// Text to synthesize. Reference audio clips are cited in the prompt as + /// `@Audio1`, `@Audio2`, `@Audio3`. + pub prompt: String, + + /// Voice to use: a preset voice name or a cloned voice id. + #[serde(skip_serializing_if = "Option::is_none")] + pub voice: Option, + + /// Up to 3 reference audio URLs (each ≤30s and ≤10MB; wav/mp3/pcm/ogg_opus). + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_urls: Option>, + + /// A single reference image URL (jpeg/png/webp, ≤10MB). + /// Cannot be combined with audio references. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_url: Option, + + /// Output container. + /// Possible values: "wav", "mp3", "pcm", "ogg_opus". fal default: "mp3". + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + /// Output sample rate in Hz. + /// Possible values: 8000, 16000, 24000, 32000, 44100, 48000. fal default: 24000. + #[serde(skip_serializing_if = "Option::is_none")] + pub sample_rate: Option, + + /// Speech speed multiplier. Range 0.5–2.0. fal default: 1.0. + #[serde(skip_serializing_if = "Option::is_none")] + pub speed: Option, + + /// Volume multiplier. Range 0.5–2.0. fal default: 1.0. + #[serde(skip_serializing_if = "Option::is_none")] + pub volume: Option, + + /// Pitch shift in semitones. Range −12 to +12. fal default: 0. + #[serde(skip_serializing_if = "Option::is_none")] + pub pitch: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedAudio1p0AudioFile { + pub url: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub content_type: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub file_name: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub file_size: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedAudio1p0Output { + pub audio: SeedAudio1p0AudioFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/api.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/api.rs new file mode 100644 index 00000000..6ddb7d71 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/api.rs @@ -0,0 +1,156 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::angle::flux_2_lora_edit_image_angle::raw_request::{Flux2LoraEditImageAngleInput, Flux2LoraEditImageAngleOutput}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + + +#[derive(Clone, Debug)] +pub struct Flux2LoraEditImageAngleRequest { + // Request required + pub image_urls: Vec, + + // Camera parameters + pub horizontal_angle: Option, + pub vertical_angle: Option, + pub zoom: Option, + + // Optional args + pub num_images: Option, + pub image_size: Option, + pub lora_scale: Option, + pub guidance_scale: Option, + pub num_inference_steps: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux2LoraAngleNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux2LoraAngleImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, +} + +impl FalEndpoint for Flux2LoraEditImageAngleRequest { + const ENDPOINT : &str = "fal-ai/flux-2-lora-gallery/multiple-angles"; + + type RawRequest = Flux2LoraEditImageAngleInput; + type RawResponse = Flux2LoraEditImageAngleOutput; + + fn to_raw_request(&self) -> Result { + let num_images = self.num_images + .map(|n| match n { + Flux2LoraAngleNumImages::One => 1, + Flux2LoraAngleNumImages::Two => 2, + Flux2LoraAngleNumImages::Three => 3, + Flux2LoraAngleNumImages::Four => 4, + }); + + let image_size = self.image_size + .map(|s| match s { + Flux2LoraAngleImageSize::Square => "square", + Flux2LoraAngleImageSize::SquareHd => "square_hd", + Flux2LoraAngleImageSize::PortraitFourThree => "portrait_4_3", + Flux2LoraAngleImageSize::PortraitSixteenNine => "portrait_16_9", + Flux2LoraAngleImageSize::LandscapeFourThree => "landscape_4_3", + Flux2LoraAngleImageSize::LandscapeSixteenNine => "landscape_16_9", + }) + .map(|s| s.to_string()); + + Ok(Self::RawRequest { + image_urls: self.image_urls.clone(), + horizontal_angle: self.horizontal_angle, + vertical_angle: self.vertical_angle, + zoom: self.zoom, + lora_scale: self.lora_scale, + guidance_scale: self.guidance_scale, + num_inference_steps: self.num_inference_steps, + image_size, + num_images, + // Constants + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + // Unused + seed: None, + }) + } +} + + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test_single() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux2LoraEditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(15.0), + zoom: Some(5.0), + num_images: Some(Flux2LoraAngleNumImages::One), + image_size: Some(Flux2LoraAngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {:?}", result.request_id); + Ok(()) + } + + /// Enqueues 27 angle combinations: 3 horizontal x 3 vertical x 3 zoom levels. + #[tokio::test] + #[ignore] + async fn test_angle_grid() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let horizontal_angles: [f64; 3] = [-45.0, 0.0, 45.0]; + let vertical_angles: [f64; 3] = [-30.0, 0.0, 30.0]; + let zoom_levels: [f64; 3] = [0.0, 1.0, 3.0]; + + for &h in &horizontal_angles { + for &v in &vertical_angles { + for &z in &zoom_levels { + let request = Flux2LoraEditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(h), + vertical_angle: Some(v), + zoom: Some(z), + num_images: Some(Flux2LoraAngleNumImages::One), + image_size: Some(Flux2LoraAngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Enqueued: h={}, v={}, z={}, request_id={:?}", h, v, z, result.request_id); + } + } + } + + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/cost.rs new file mode 100644 index 00000000..8f2df6bc --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/cost.rs @@ -0,0 +1,62 @@ +use crate::requests::api::image::angle::flux_2_lora_edit_image_angle::api::{Flux2LoraAngleNumImages, Flux2LoraEditImageAngleRequest}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Flux2LoraEditImageAngleRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.021 per megapixel. + // For a 1024x1024 image (~1 MP), that's ~2 cents per image. + let unit_cost = 2; + let cost = match self.num_images { + None => unit_cost, + Some(Flux2LoraAngleNumImages::One) => unit_cost, + Some(Flux2LoraAngleNumImages::Two) => unit_cost * 2, + Some(Flux2LoraAngleNumImages::Three) => unit_cost * 3, + Some(Flux2LoraAngleNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request(num_images: Option) -> Flux2LoraEditImageAngleRequest { + Flux2LoraEditImageAngleRequest { + image_urls: vec!["https://example.com/image.jpg".to_string()], + horizontal_angle: None, + vertical_angle: None, + zoom: None, + num_images, + image_size: None, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + } + } + + #[test] + fn cost_default_one_image() { + assert_eq!(make_request(None).calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_one_image() { + assert_eq!(make_request(Some(Flux2LoraAngleNumImages::One)).calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_two_images() { + assert_eq!(make_request(Some(Flux2LoraAngleNumImages::Two)).calculate_cost_in_cents(), 4); + } + + #[test] + fn cost_three_images() { + assert_eq!(make_request(Some(Flux2LoraAngleNumImages::Three)).calculate_cost_in_cents(), 6); + } + + #[test] + fn cost_four_images() { + assert_eq!(make_request(Some(Flux2LoraAngleNumImages::Four)).calculate_cost_in_cents(), 8); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/mod.rs new file mode 100644 index 00000000..acd14d2f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/mod.rs @@ -0,0 +1,3 @@ +mod raw_request; +pub mod api; +pub mod cost; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/raw_request.rs new file mode 100644 index 00000000..116d841e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/flux_2_lora_edit_image_angle/raw_request.rs @@ -0,0 +1,75 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux2LoraEditImageAngleInput { + /// The URL of the image to adjust camera angle for. + pub image_urls: Vec, + + /// Horizontal rotation angle around the object in degrees. + /// 0°=front view, 90°=right side, 180°=back view, 270°=left side. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub horizontal_angle: Option, + + /// Vertical camera angle in degrees. + /// 0°=eye-level shot, 30°=elevated shot, 60°=high-angle shot. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub vertical_angle: Option, + + /// Camera zoom/distance. 0=wide shot, 5=medium shot, 10=close-up. + /// Default: 5 + #[serde(skip_serializing_if = "Option::is_none")] + pub zoom: Option, + + /// The strength of the multiple angles effect. + /// Default: 1, range: 0-2 + #[serde(skip_serializing_if = "Option::is_none")] + pub lora_scale: Option, + + /// The size of the generated image. + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default: 2.5, range: 0-20 + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// The number of inference steps to perform. + /// Default: 40, range: 1-50 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Random seed for reproducibility. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Number of images to generate. + /// Default: 1, max: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// Whether to enable the safety checker. + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Output format: png, jpeg, webp. + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux2LoraEditImageAngleFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux2LoraEditImageAngleOutput { + pub images: Vec, + pub seed: u64, + pub prompt: Option, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/mod.rs new file mode 100644 index 00000000..bcb20e27 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/mod.rs @@ -0,0 +1,2 @@ +pub mod flux_2_lora_edit_image_angle; +pub mod qwen_edit_2511_edit_image_angle; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/api.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/api.rs new file mode 100644 index 00000000..b77b53bd --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/api.rs @@ -0,0 +1,162 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::angle::qwen_edit_2511_edit_image_angle::raw_request::{ + QwenEdit2511EditImageAngleInput, QwenEdit2511EditImageAngleOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct QwenEdit2511EditImageAngleRequest { + // Request required + pub image_urls: Vec, + + // Camera parameters + pub horizontal_angle: Option, + pub vertical_angle: Option, + pub zoom: Option, + + // Optional args + pub additional_prompt: Option, + pub num_images: Option, + pub image_size: Option, + pub lora_scale: Option, + pub guidance_scale: Option, + pub num_inference_steps: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum QwenEdit2511AngleNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum QwenEdit2511AngleImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, +} + +impl FalEndpoint for QwenEdit2511EditImageAngleRequest { + const ENDPOINT: &str = "fal-ai/qwen-image-edit-2511-multiple-angles"; + + type RawRequest = QwenEdit2511EditImageAngleInput; + type RawResponse = QwenEdit2511EditImageAngleOutput; + + fn to_raw_request(&self) -> Result { + let num_images = self.num_images + .map(|n| match n { + QwenEdit2511AngleNumImages::One => 1, + QwenEdit2511AngleNumImages::Two => 2, + QwenEdit2511AngleNumImages::Three => 3, + QwenEdit2511AngleNumImages::Four => 4, + }); + + let image_size = self.image_size + .map(|s| match s { + QwenEdit2511AngleImageSize::Square => "square", + QwenEdit2511AngleImageSize::SquareHd => "square_hd", + QwenEdit2511AngleImageSize::PortraitFourThree => "portrait_4_3", + QwenEdit2511AngleImageSize::PortraitSixteenNine => "portrait_16_9", + QwenEdit2511AngleImageSize::LandscapeFourThree => "landscape_4_3", + QwenEdit2511AngleImageSize::LandscapeSixteenNine => "landscape_16_9", + }) + .map(|s| s.to_string()); + + Ok(Self::RawRequest { + image_urls: self.image_urls.clone(), + horizontal_angle: self.horizontal_angle, + vertical_angle: self.vertical_angle, + zoom: self.zoom, + additional_prompt: self.additional_prompt.clone(), + lora_scale: self.lora_scale, + guidance_scale: self.guidance_scale, + num_inference_steps: self.num_inference_steps, + image_size, + num_images, + // Constants + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + // Unused + negative_prompt: None, + seed: None, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_single() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = QwenEdit2511EditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(15.0), + zoom: Some(5.0), + additional_prompt: Some("cinematic lighting".to_string()), + num_images: Some(QwenEdit2511AngleNumImages::One), + image_size: Some(QwenEdit2511AngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {:?}", result.request_id); + Ok(()) + } + + /// Enqueues 27 angle combinations: 3 horizontal x 3 vertical x 3 zoom levels. + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_angle_grid() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let horizontal_angles: [f64; 3] = [-45.0, 0.0, 45.0]; + let vertical_angles: [f64; 3] = [-30.0, 0.0, 30.0]; + let zoom_levels: [f64; 3] = [0.0, 1.0, 3.0]; + + for &h in &horizontal_angles { + for &v in &vertical_angles { + for &z in &zoom_levels { + let request = QwenEdit2511EditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(h), + vertical_angle: Some(v), + zoom: Some(z), + additional_prompt: None, + num_images: Some(QwenEdit2511AngleNumImages::One), + image_size: Some(QwenEdit2511AngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Enqueued: h={}, v={}, z={}, request_id={:?}", h, v, z, result.request_id); + } + } + } + + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/cost.rs new file mode 100644 index 00000000..a9f90bd3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/cost.rs @@ -0,0 +1,76 @@ +use crate::requests::api::image::angle::qwen_edit_2511_edit_image_angle::api::{ + QwenEdit2511AngleNumImages, QwenEdit2511EditImageAngleRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for QwenEdit2511EditImageAngleRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.035 per megapixel. + // For a 1024x1024 image (~1 MP), that's ~4 cents per image. + let unit_cost = 4; + let cost = match self.num_images { + None => unit_cost, + Some(QwenEdit2511AngleNumImages::One) => unit_cost, + Some(QwenEdit2511AngleNumImages::Two) => unit_cost * 2, + Some(QwenEdit2511AngleNumImages::Three) => unit_cost * 3, + Some(QwenEdit2511AngleNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn cost_default_one_image() { + let request = QwenEdit2511EditImageAngleRequest { + image_urls: vec!["https://example.com/image.jpg".to_string()], + horizontal_angle: None, + vertical_angle: None, + zoom: None, + additional_prompt: None, + num_images: None, + image_size: None, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 4); + } + + #[test] + fn cost_one_image() { + let request = QwenEdit2511EditImageAngleRequest { + image_urls: vec!["https://example.com/image.jpg".to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(15.0), + zoom: Some(5.0), + additional_prompt: None, + num_images: Some(QwenEdit2511AngleNumImages::One), + image_size: None, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 4); + } + + #[test] + fn cost_four_images() { + let request = QwenEdit2511EditImageAngleRequest { + image_urls: vec!["https://example.com/image.jpg".to_string()], + horizontal_angle: None, + vertical_angle: None, + zoom: None, + additional_prompt: None, + num_images: Some(QwenEdit2511AngleNumImages::Four), + image_size: None, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 16); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/raw_request.rs new file mode 100644 index 00000000..2d927334 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/angle/qwen_edit_2511_edit_image_angle/raw_request.rs @@ -0,0 +1,81 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct QwenEdit2511EditImageAngleInput { + /// The URL(s) of the image(s) to adjust camera angle for. + pub image_urls: Vec, + + /// Horizontal rotation angle around the object in degrees. 0°=front view. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub horizontal_angle: Option, + + /// Vertical camera angle in degrees. -30°=low-angle shot, 30°=high-angle shot. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub vertical_angle: Option, + + /// Camera zoom/distance. 0=wide shot, 5=medium shot, 10=close-up. + /// Default: 5 + #[serde(skip_serializing_if = "Option::is_none")] + pub zoom: Option, + + /// Additional text to append to the automatically generated prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_prompt: Option, + + /// The scale factor for the LoRA model. Controls the strength of the effect. + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub lora_scale: Option, + + /// The size of the generated image. + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default: 4.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// The number of inference steps to perform. + /// Default: 28 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// The negative prompt for the generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Random seed for reproducibility. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Number of images to generate. + /// Default: 1, max: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// Whether to enable the safety checker. + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Output format: png, jpeg, webp. + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QwenEdit2511EditImageAngleFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QwenEdit2511EditImageAngleOutput { + pub images: Vec, + pub seed: u64, + pub prompt: Option, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/background/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/background/mod.rs new file mode 100644 index 00000000..791f160f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/background/mod.rs @@ -0,0 +1 @@ +pub mod rembg_remove_background; diff --git a/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/api.rs b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/api.rs new file mode 100644 index 00000000..487e2645 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/api.rs @@ -0,0 +1,53 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::background::rembg_remove_background::raw_request::{ + RembgRemoveBackgroundInput, RembgRemoveBackgroundOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct RembgRemoveBackgroundRequest { + /// URL of the image to remove the background from. + pub image_url: String, +} + +impl FalEndpoint for RembgRemoveBackgroundRequest { + const ENDPOINT: &str = "fal-ai/imageutils/rembg"; + + type RawRequest = RembgRemoveBackgroundInput; + type RawResponse = RembgRemoveBackgroundOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + image_url: self.image_url.clone(), + crop_to_bbox: None, + sync_mode: None, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_remove_background() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = RembgRemoveBackgroundRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {:?}", result.request_id); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/cost.rs new file mode 100644 index 00000000..c5561507 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/cost.rs @@ -0,0 +1,23 @@ +use crate::requests::api::image::background::rembg_remove_background::api::RembgRemoveBackgroundRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for RembgRemoveBackgroundRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.004 per image (less than 1 cent). + // We round up to 0 cents for now + 0 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn cost_is_one_cent() { + let request = RembgRemoveBackgroundRequest { + image_url: "https://example.com/image.jpg".to_string(), + }; + assert_eq!(request.calculate_cost_in_cents(), 0); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/raw_request.rs new file mode 100644 index 00000000..282c58e4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/background/rembg_remove_background/raw_request.rs @@ -0,0 +1,22 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct RembgRemoveBackgroundInput { + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub crop_to_bbox: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct RembgRemoveBackgroundFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct RembgRemoveBackgroundOutput { + pub image: RembgRemoveBackgroundFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/common/gpt_image_2_resolution.rs b/crates/api_clients/fal_client/src/requests/api/image/common/gpt_image_2_resolution.rs new file mode 100644 index 00000000..a8d48340 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/common/gpt_image_2_resolution.rs @@ -0,0 +1,206 @@ +use serde::{Deserialize, Serialize}; + +/// Our synthetic resolution tiers for GPT Image 2. When combined with an +/// aspect ratio (image_size), we compute a concrete width x height that +/// satisfies all GPT Image 2 constraints: +/// +/// - Maximum edge length <= 3840px +/// - Both edges must be multiples of 16px +/// - Long-to-short ratio must not exceed 3:1 +/// - Total pixels: 655,360 <= w*h <= 8,294,400 +#[derive(Copy, Clone, Debug)] +pub enum GptImage2Resolution { + /// ~1K on the long edge (1024px baseline) + OneK, + /// ~2K on the long edge (2048px baseline) + TwoK, + /// ~3K on the long edge (3072px baseline) + ThreeK, + /// ~4K on the long edge (max edge, up to 3840px) + FourK, +} + +/// The aspect ratios supported by GPT Image 2 (the standard image_size enum +/// values that carry aspect-ratio semantics). +#[derive(Copy, Clone, Debug)] +pub enum GptImage2AspectRatio { + /// 1:1 + Square, + /// 1:1 (HD variant — same ratio, higher default res) + SquareHd, + /// 4:3 + Landscape4x3, + /// 16:9 + Landscape16x9, + /// 3:4 + Portrait4x3, + /// 9:16 + Portrait16x9, +} + +/// A custom image size with explicit width and height, serialisable as the +/// JSON object `{"width": N, "height": N}` that Fal accepts. +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct CustomImageSize { + pub width: u32, + pub height: u32, +} + +const MIN_PIXELS: u64 = 655_360; +const MAX_PIXELS: u64 = 8_294_400; +const MAX_EDGE: u32 = 3840; + +/// Given an aspect ratio and a resolution tier, compute a concrete +/// `CustomImageSize`. The returned dimensions are guaranteed to satisfy all +/// GPT Image 2 constraints. +pub fn compute_custom_image_size(aspect: GptImage2AspectRatio, resolution: GptImage2Resolution) -> CustomImageSize { + // Aspect ratio as (w_ratio, h_ratio) + let (w_ratio, h_ratio): (u32, u32) = match aspect { + GptImage2AspectRatio::Square | GptImage2AspectRatio::SquareHd => (1, 1), + GptImage2AspectRatio::Landscape4x3 => (4, 3), + GptImage2AspectRatio::Landscape16x9 => (16, 9), + GptImage2AspectRatio::Portrait4x3 => (3, 4), + GptImage2AspectRatio::Portrait16x9 => (9, 16), + }; + + // Target long-edge pixels for each tier + let target_long_edge: u32 = match resolution { + GptImage2Resolution::OneK => 1024, + GptImage2Resolution::TwoK => 2048, + GptImage2Resolution::ThreeK => 3072, + GptImage2Resolution::FourK => 3840, + }; + + // Compute raw dimensions from the target long edge and the aspect ratio. + // The long edge gets `target_long_edge`; the short edge is derived. + let (raw_w, raw_h) = if w_ratio >= h_ratio { + // Landscape or square: width is the long edge + let w = target_long_edge; + let h = (w as u64 * h_ratio as u64 / w_ratio as u64) as u32; + (w, h) + } else { + // Portrait: height is the long edge + let h = target_long_edge; + let w = (h as u64 * w_ratio as u64 / h_ratio as u64) as u32; + (w, h) + }; + + // Round both dimensions down to nearest multiple of 16 + let mut w = (raw_w / 16) * 16; + let mut h = (raw_h / 16) * 16; + + // Clamp each edge to MAX_EDGE + w = w.min(MAX_EDGE); + h = h.min(MAX_EDGE); + + // Ensure minimum pixels by scaling up if needed + let pixels = w as u64 * h as u64; + if pixels < MIN_PIXELS { + // Scale up uniformly + let scale = ((MIN_PIXELS as f64) / (pixels as f64)).sqrt(); + w = (((w as f64 * scale).ceil() as u32 + 15) / 16) * 16; + h = (((h as f64 * scale).ceil() as u32 + 15) / 16) * 16; + } + + // Ensure maximum pixels by scaling down if needed + let pixels = w as u64 * h as u64; + if pixels > MAX_PIXELS { + let scale = ((MAX_PIXELS as f64) / (pixels as f64)).sqrt(); + w = ((w as f64 * scale).floor() as u32 / 16) * 16; + h = ((h as f64 * scale).floor() as u32 / 16) * 16; + } + + // Final clamp + w = w.min(MAX_EDGE); + h = h.min(MAX_EDGE); + + CustomImageSize { width: w, height: h } +} + +#[cfg(test)] +mod tests { + use super::*; + + const ALL_ASPECTS: &[GptImage2AspectRatio] = &[ + GptImage2AspectRatio::Square, + GptImage2AspectRatio::SquareHd, + GptImage2AspectRatio::Landscape4x3, + GptImage2AspectRatio::Landscape16x9, + GptImage2AspectRatio::Portrait4x3, + GptImage2AspectRatio::Portrait16x9, + ]; + + const ALL_RESOLUTIONS: &[GptImage2Resolution] = &[ + GptImage2Resolution::OneK, + GptImage2Resolution::TwoK, + GptImage2Resolution::ThreeK, + GptImage2Resolution::FourK, + ]; + + #[test] + fn all_combinations_satisfy_constraints() { + for &aspect in ALL_ASPECTS { + for &resolution in ALL_RESOLUTIONS { + let size = compute_custom_image_size(aspect, resolution); + let pixels = size.width as u64 * size.height as u64; + let max_edge = size.width.max(size.height); + let min_edge = size.width.min(size.height); + + assert!(size.width % 16 == 0, "width {} not multiple of 16 for {:?} {:?}", size.width, aspect, resolution); + assert!(size.height % 16 == 0, "height {} not multiple of 16 for {:?} {:?}", size.height, aspect, resolution); + assert!(max_edge <= MAX_EDGE, "max edge {} exceeds 3840 for {:?} {:?}", max_edge, aspect, resolution); + assert!(max_edge as f64 / min_edge as f64 <= 3.0, "ratio {:.2} exceeds 3:1 for {:?} {:?} ({}x{})", max_edge as f64 / min_edge as f64, aspect, resolution, size.width, size.height); + assert!(pixels >= MIN_PIXELS, "pixels {} < 655360 for {:?} {:?} ({}x{})", pixels, aspect, resolution, size.width, size.height); + assert!(pixels <= MAX_PIXELS, "pixels {} > 8294400 for {:?} {:?} ({}x{})", pixels, aspect, resolution, size.width, size.height); + } + } + } + + #[test] + fn all_combinations_dimensions_snapshot() { + // Print all dimensions for manual review / documentation + for &aspect in ALL_ASPECTS { + for &resolution in ALL_RESOLUTIONS { + let size = compute_custom_image_size(aspect, resolution); + let pixels = size.width as u64 * size.height as u64; + println!("{:?} + {:?} => {}x{} ({} pixels)", aspect, resolution, size.width, size.height, pixels); + } + } + } + + mod specific_dimensions { + use super::*; + + #[test] + fn square_1k() { + let s = compute_custom_image_size(GptImage2AspectRatio::Square, GptImage2Resolution::OneK); + assert_eq!(s.width, 1024); + assert_eq!(s.height, 1024); + } + + #[test] + fn square_4k() { + let s = compute_custom_image_size(GptImage2AspectRatio::Square, GptImage2Resolution::FourK); + // sqrt(8294400) ~= 2880, but 3840 * 3840 = 14745600 > MAX, so it gets clamped + assert!(s.width <= MAX_EDGE); + assert!(s.height <= MAX_EDGE); + assert!(s.width as u64 * s.height as u64 <= MAX_PIXELS); + } + + #[test] + fn landscape_16x9_1k() { + // 1024x576 = 589,824 < MIN_PIXELS, so gets scaled up to 1088x608 + let s = compute_custom_image_size(GptImage2AspectRatio::Landscape16x9, GptImage2Resolution::OneK); + assert_eq!(s.width, 1088); + assert_eq!(s.height, 608); + } + + #[test] + fn portrait_16x9_4k() { + let s = compute_custom_image_size(GptImage2AspectRatio::Portrait16x9, GptImage2Resolution::FourK); + assert!(s.width <= MAX_EDGE); + assert!(s.height <= MAX_EDGE); + assert!(s.width as u64 * s.height as u64 <= MAX_PIXELS); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/common/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/common/mod.rs new file mode 100644 index 00000000..b2f0f88d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/common/mod.rs @@ -0,0 +1 @@ +pub mod gpt_image_2_resolution; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/api.rs new file mode 100644 index 00000000..212353f7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/api.rs @@ -0,0 +1,100 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::edit::flux_1_dev_edit_image::raw_request::{ + Flux1DevEditImageInput, Flux1DevEditImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Flux1DevEditImageRequest { + /// Text prompt describing the desired edit. + pub prompt: String, + + /// URL of the source image to edit. + pub image_url: String, + + /// Number of images to generate. + pub num_images: Flux1DevEditImageNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1DevEditImageNumImages { + One, + Two, + Three, + Four, +} + +impl FalEndpoint for Flux1DevEditImageRequest { + const ENDPOINT: &str = "fal-ai/flux/dev/image-to-image"; + + type RawRequest = Flux1DevEditImageInput; + type RawResponse = Flux1DevEditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + Flux1DevEditImageNumImages::One => 1, + Flux1DevEditImageNumImages::Two => 2, + Flux1DevEditImageNumImages::Three => 3, + Flux1DevEditImageNumImages::Four => 4, + }; + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + num_images: Some(num_images), + // Constants + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + // Defaults + ..Default::default() + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::GHOST_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_single_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux1DevEditImageRequest { + prompt: "make this image look like a watercolor painting".to_string(), + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1DevEditImageNumImages::One, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {:?}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_batch_two() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux1DevEditImageRequest { + prompt: "turn this into a cyberpunk scene with neon lights".to_string(), + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1DevEditImageNumImages::Two, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {:?}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/cost.rs new file mode 100644 index 00000000..7e92774b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/cost.rs @@ -0,0 +1,52 @@ +use crate::requests::api::image::edit::flux_1_dev_edit_image::api::{ + Flux1DevEditImageNumImages, Flux1DevEditImageRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Flux1DevEditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.025 per megapixel. + // For a 1024x1024 image (~1 MP), that's ~3 cents per image. + let unit_cost = 3; + let cost = match self.num_images { + Flux1DevEditImageNumImages::One => unit_cost, + Flux1DevEditImageNumImages::Two => unit_cost * 2, + Flux1DevEditImageNumImages::Three => unit_cost * 3, + Flux1DevEditImageNumImages::Four => unit_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request(num_images: Flux1DevEditImageNumImages) -> Flux1DevEditImageRequest { + Flux1DevEditImageRequest { + prompt: "test".to_string(), + image_url: "https://example.com/image.jpg".to_string(), + num_images, + } + } + + #[test] + fn cost_one_image() { + assert_eq!(make_request(Flux1DevEditImageNumImages::One).calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_two_images() { + assert_eq!(make_request(Flux1DevEditImageNumImages::Two).calculate_cost_in_cents(), 6); + } + + #[test] + fn cost_three_images() { + assert_eq!(make_request(Flux1DevEditImageNumImages::Three).calculate_cost_in_cents(), 9); + } + + #[test] + fn cost_four_images() { + assert_eq!(make_request(Flux1DevEditImageNumImages::Four).calculate_cost_in_cents(), 12); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/raw_request.rs new file mode 100644 index 00000000..ef3af630 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_dev_edit_image/raw_request.rs @@ -0,0 +1,47 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1DevEditImageInput { + pub prompt: String, + + pub image_url: String, + + /// 0.0 - 1.0 + /// Default: 0.95 + #[serde(skip_serializing_if = "Option::is_none")] + pub strength: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Options: jpeg, png + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevEditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevEditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/api.rs new file mode 100644 index 00000000..37eee91d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/api.rs @@ -0,0 +1,117 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::edit::flux_1_schnell_edit_image::raw_request::{ + Flux1SchnellEditImageInput, Flux1SchnellEditImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Flux1SchnellEditImageRequest { + /// URL of the source image to edit. + pub image_url: String, + + /// Number of images to generate. + pub num_images: Flux1SchnellEditImageNumImages, + + /// Output image size. + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellEditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellEditImageSize { + Square, + SquareHd, + LandscapeFourByThree, + LandscapeSixteenByNine, + PortraitThreeByFour, + PortraitNineBySixteen, +} + +impl FalEndpoint for Flux1SchnellEditImageRequest { + const ENDPOINT: &str = "fal-ai/flux/schnell/redux"; + + type RawRequest = Flux1SchnellEditImageInput; + type RawResponse = Flux1SchnellEditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + Flux1SchnellEditImageNumImages::One => 1, + Flux1SchnellEditImageNumImages::Two => 2, + Flux1SchnellEditImageNumImages::Three => 3, + Flux1SchnellEditImageNumImages::Four => 4, + }; + + let image_size = self.image_size.map(|s| match s { + Flux1SchnellEditImageSize::Square => "square", + Flux1SchnellEditImageSize::SquareHd => "square_hd", + Flux1SchnellEditImageSize::LandscapeFourByThree => "landscape_4_3", + Flux1SchnellEditImageSize::LandscapeSixteenByNine => "landscape_16_9", + Flux1SchnellEditImageSize::PortraitThreeByFour => "portrait_4_3", + Flux1SchnellEditImageSize::PortraitNineBySixteen => "portrait_16_9", + }.to_string()); + + Ok(Self::RawRequest { + image_url: self.image_url.clone(), + num_images: Some(num_images), + image_size, + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + ..Default::default() + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::GHOST_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_single_image_no_size() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux1SchnellEditImageRequest { + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1SchnellEditImageNumImages::One, + image_size: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_with_landscape_size() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux1SchnellEditImageRequest { + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1SchnellEditImageNumImages::Two, + image_size: Some(Flux1SchnellEditImageSize::LandscapeSixteenByNine), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/cost.rs new file mode 100644 index 00000000..c2995ebe --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/cost.rs @@ -0,0 +1,53 @@ +use crate::requests::api::image::edit::flux_1_schnell_edit_image::api::{ + Flux1SchnellEditImageNumImages, Flux1SchnellEditImageRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Flux1SchnellEditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.003 per megapixel. + // For a 1024x1024 image (~1 MP), that's less than 1 cent per image. + // We round up to 1 cent per image. + let unit_cost = 1; + let cost = match self.num_images { + Flux1SchnellEditImageNumImages::One => unit_cost, + Flux1SchnellEditImageNumImages::Two => unit_cost * 2, + Flux1SchnellEditImageNumImages::Three => unit_cost * 3, + Flux1SchnellEditImageNumImages::Four => unit_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request(num_images: Flux1SchnellEditImageNumImages) -> Flux1SchnellEditImageRequest { + Flux1SchnellEditImageRequest { + image_url: "https://example.com/image.jpg".to_string(), + num_images, + image_size: None, + } + } + + #[test] + fn cost_one_image() { + assert_eq!(make_request(Flux1SchnellEditImageNumImages::One).calculate_cost_in_cents(), 1); + } + + #[test] + fn cost_two_images() { + assert_eq!(make_request(Flux1SchnellEditImageNumImages::Two).calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_three_images() { + assert_eq!(make_request(Flux1SchnellEditImageNumImages::Three).calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_four_images() { + assert_eq!(make_request(Flux1SchnellEditImageNumImages::Four).calculate_cost_in_cents(), 4); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/raw_request.rs new file mode 100644 index 00000000..46b8826c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/flux_1_schnell_edit_image/raw_request.rs @@ -0,0 +1,41 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1SchnellEditImageInput { + pub image_url: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Options: jpeg, png + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellEditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellEditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/api.rs new file mode 100644 index 00000000..d587a479 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/api.rs @@ -0,0 +1,207 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::edit::gpt_image_1_edit_image::raw_request::{ + GptImage1EditImageInput, GptImage1EditImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct GptImage1EditImageRequest { + /// Text prompt describing the edit to make. + pub prompt: String, + + /// One or more source image URLs to edit. + pub image_urls: Vec, + + /// Number of images to generate. + pub num_images: GptImage1EditImageNumImages, + + /// Optional mask URL indicating what part of the image to edit. + pub mask_image_url: Option, + + /// Output image size. + pub image_size: Option, + + /// Quality level. + pub quality: Option, + + /// Input fidelity level. + pub input_fidelity: Option, + + /// Background mode. + pub background: Option, + + /// Output format. + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1EditImageSize { + Auto, + /// 1024x1024 + Square, + /// 1536x1024 + Horizontal, + /// 1024x1536 + Vertical, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1EditImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1EditImageInputFidelity { + Low, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1EditImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1EditImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalEndpoint for GptImage1EditImageRequest { + const ENDPOINT: &str = "fal-ai/gpt-image-1/edit-image"; + + type RawRequest = GptImage1EditImageInput; + type RawResponse = GptImage1EditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + GptImage1EditImageNumImages::One => 1, + GptImage1EditImageNumImages::Two => 2, + GptImage1EditImageNumImages::Three => 3, + GptImage1EditImageNumImages::Four => 4, + }; + + let image_size = self.image_size.map(|s| match s { + GptImage1EditImageSize::Auto => "auto", + GptImage1EditImageSize::Square => "1024x1024", + GptImage1EditImageSize::Horizontal => "1536x1024", + GptImage1EditImageSize::Vertical => "1024x1536", + }.to_string()); + + let quality = self.quality.map(|q| match q { + GptImage1EditImageQuality::Low => "low", + GptImage1EditImageQuality::Medium => "medium", + GptImage1EditImageQuality::High => "high", + }.to_string()); + + let input_fidelity = self.input_fidelity.map(|f| match f { + GptImage1EditImageInputFidelity::Low => "low", + GptImage1EditImageInputFidelity::High => "high", + }.to_string()); + + let background = self.background.map(|b| match b { + GptImage1EditImageBackground::Auto => "auto", + GptImage1EditImageBackground::Transparent => "transparent", + GptImage1EditImageBackground::Opaque => "opaque", + }.to_string()); + + let output_format = Some(match self.output_format { + Some(GptImage1EditImageOutputFormat::Jpeg) => "jpeg", + Some(GptImage1EditImageOutputFormat::Png) => "png", + Some(GptImage1EditImageOutputFormat::Webp) => "webp", + None => "png", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + num_images: Some(num_images), + mask_image_url: self.mask_image_url.clone(), + image_size, + quality, + input_fidelity, + background, + output_format, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1EditImageRequest { + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + num_images: GptImage1EditImageNumImages::One, + mask_image_url: None, + image_size: Some(GptImage1EditImageSize::Horizontal), + quality: Some(GptImage1EditImageQuality::Medium), + input_fidelity: None, + background: None, + output_format: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1EditImageRequest { + image_urls: vec![GHOST_IMAGE_URL.to_string()], + prompt: "make the ghost wear a top hat".to_string(), + num_images: GptImage1EditImageNumImages::One, + mask_image_url: None, + image_size: None, + quality: Some(GptImage1EditImageQuality::High), + input_fidelity: None, + background: None, + output_format: Some(GptImage1EditImageOutputFormat::Png), + }; + + let result = request.send_webhook_request( + &api_key, + "https://example.com/webhook", + ).await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/cost.rs new file mode 100644 index 00000000..e943ef80 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/cost.rs @@ -0,0 +1,182 @@ +use crate::requests::api::image::edit::gpt_image_1_edit_image::api::{ + GptImage1EditImageNumImages, GptImage1EditImageQuality, + GptImage1EditImageRequest, GptImage1EditImageSize, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for GptImage1EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Per fal docs (fal-ai/gpt-image-1/edit-image): + // Low: $0.011 (1024x1024) / $0.016 (other) per image + // Medium: $0.042 (1024x1024) / $0.063 (other) per image + // High: $0.167 (1024x1024) / $0.25 (other) per image + let use_quality = self.quality.unwrap_or(GptImage1EditImageQuality::Medium); + let is_square = matches!( + self.image_size, + None | Some(GptImage1EditImageSize::Square) | Some(GptImage1EditImageSize::Auto) + ); + + let base_cost: u64 = match (use_quality, is_square) { + (GptImage1EditImageQuality::Low, true) => 2, + (GptImage1EditImageQuality::Low, false) => 2, + (GptImage1EditImageQuality::Medium, true) => 5, + (GptImage1EditImageQuality::Medium, false) => 7, + (GptImage1EditImageQuality::High, true) => 17, + (GptImage1EditImageQuality::High, false) => 25, + }; + + let n: u64 = match self.num_images { + GptImage1EditImageNumImages::One => 1, + GptImage1EditImageNumImages::Two => 2, + GptImage1EditImageNumImages::Three => 3, + GptImage1EditImageNumImages::Four => 4, + }; + base_cost * n + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: GptImage1EditImageNumImages, + quality: Option, + image_size: Option, + ) -> GptImage1EditImageRequest { + GptImage1EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.png".to_string()], + num_images, + mask_image_url: None, + image_size, + quality, + input_fidelity: None, + background: None, + output_format: None, + } + } + + mod default_tests { + use super::*; + + #[test] + fn cost_defaults_one_image() { + // Default quality=Medium, size=Square => 5 cents + assert_eq!( + make_request(GptImage1EditImageNumImages::One, None, None) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_defaults_four_images() { + assert_eq!( + make_request(GptImage1EditImageNumImages::Four, None, None) + .calculate_cost_in_cents(), 20); + } + } + + mod low_quality_tests { + use super::*; + + #[test] + fn cost_low_square_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Square)) + .calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_low_horizontal_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Horizontal)) + .calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_low_auto_four_images() { + // Auto is treated as square + assert_eq!( + make_request(GptImage1EditImageNumImages::Four, Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Auto)) + .calculate_cost_in_cents(), 8); + } + } + + mod medium_quality_tests { + use super::*; + + #[test] + fn cost_medium_square_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Square)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_auto_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Auto)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_horizontal_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Horizontal)) + .calculate_cost_in_cents(), 7); + } + + #[test] + fn cost_medium_vertical_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Vertical)) + .calculate_cost_in_cents(), 7); + } + + #[test] + fn cost_medium_horizontal_three_images() { + assert_eq!( + make_request(GptImage1EditImageNumImages::Three, Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Horizontal)) + .calculate_cost_in_cents(), 21); + } + } + + mod high_quality_tests { + use super::*; + + #[test] + fn cost_high_square_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Square)) + .calculate_cost_in_cents(), 17); + } + + #[test] + fn cost_high_horizontal_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Horizontal)) + .calculate_cost_in_cents(), 25); + } + + #[test] + fn cost_high_vertical_one_image() { + assert_eq!( + make_request(GptImage1EditImageNumImages::One, Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Vertical)) + .calculate_cost_in_cents(), 25); + } + + #[test] + fn cost_high_square_two_images() { + assert_eq!( + make_request(GptImage1EditImageNumImages::Two, Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Square)) + .calculate_cost_in_cents(), 34); + } + + #[test] + fn cost_high_horizontal_four_images() { + assert_eq!( + make_request(GptImage1EditImageNumImages::Four, Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Horizontal)) + .calculate_cost_in_cents(), 100); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/raw_request.rs new file mode 100644 index 00000000..b7efaea2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1_edit_image/raw_request.rs @@ -0,0 +1,48 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// The URL of the mask image indicating what part of the image to edit. + #[serde(skip_serializing_if = "Option::is_none")] + pub mask_image_url: Option, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// "low", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub input_fidelity: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1EditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/api.rs new file mode 100644 index 00000000..b0e232e1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/api.rs @@ -0,0 +1,205 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::edit::gpt_image_1p5_edit_image::raw_request::{ + GptImage1p5EditImageInput, GptImage1p5EditImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct GptImage1p5EditImageRequest { + /// Text prompt describing the edit to make. + pub prompt: String, + + /// One or more source image URLs to edit. + pub image_urls: Vec, + + /// Number of images to generate. + pub num_images: GptImage1p5EditImageNumImages, + + /// Optional mask URL indicating what part of the image to edit. + pub mask_image_url: Option, + + /// Output image size. + pub image_size: Option, + + /// Background mode. + pub background: Option, + + /// Quality level. + pub quality: Option, + + /// Input fidelity level. + pub input_fidelity: Option, + + /// Output format. + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5EditImageSize { + /// 1024x1024 + Square, + /// 1536x1024 + Wide, + /// 1024x1536 + Tall, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5EditImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5EditImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5EditImageInputFidelity { + Low, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5EditImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalEndpoint for GptImage1p5EditImageRequest { + const ENDPOINT: &str = "fal-ai/gpt-image-1.5/edit"; + + type RawRequest = GptImage1p5EditImageInput; + type RawResponse = GptImage1p5EditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + GptImage1p5EditImageNumImages::One => 1, + GptImage1p5EditImageNumImages::Two => 2, + GptImage1p5EditImageNumImages::Three => 3, + GptImage1p5EditImageNumImages::Four => 4, + }; + + let image_size = self.image_size.map(|s| match s { + GptImage1p5EditImageSize::Square => "1024x1024", + GptImage1p5EditImageSize::Wide => "1536x1024", + GptImage1p5EditImageSize::Tall => "1024x1536", + }.to_string()); + + let background = self.background.map(|b| match b { + GptImage1p5EditImageBackground::Auto => "auto", + GptImage1p5EditImageBackground::Transparent => "transparent", + GptImage1p5EditImageBackground::Opaque => "opaque", + }.to_string()); + + let quality = self.quality.map(|q| match q { + GptImage1p5EditImageQuality::Low => "low", + GptImage1p5EditImageQuality::Medium => "medium", + GptImage1p5EditImageQuality::High => "high", + }.to_string()); + + let input_fidelity = self.input_fidelity.map(|f| match f { + GptImage1p5EditImageInputFidelity::Low => "low", + GptImage1p5EditImageInputFidelity::High => "high", + }.to_string()); + + let output_format = Some(match self.output_format { + Some(GptImage1p5EditImageOutputFormat::Jpeg) => "jpeg", + Some(GptImage1p5EditImageOutputFormat::Png) => "png", + Some(GptImage1p5EditImageOutputFormat::Webp) => "webp", + None => "png", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + num_images: Some(num_images), + mask_image_url: self.mask_image_url.clone(), + image_size, + background, + quality, + input_fidelity, + output_format, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1p5EditImageRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + num_images: GptImage1p5EditImageNumImages::Two, + mask_image_url: None, + image_size: None, + background: None, + quality: None, + input_fidelity: None, + output_format: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1p5EditImageRequest { + image_urls: vec![GHOST_IMAGE_URL.to_string()], + prompt: "make the ghost wear a top hat".to_string(), + num_images: GptImage1p5EditImageNumImages::One, + mask_image_url: None, + image_size: Some(GptImage1p5EditImageSize::Square), + background: None, + quality: Some(GptImage1p5EditImageQuality::High), + input_fidelity: None, + output_format: Some(GptImage1p5EditImageOutputFormat::Png), + }; + + let result = request.send_webhook_request( + &api_key, + "https://example.com/webhook", + ).await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/cost.rs new file mode 100644 index 00000000..c7012f97 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/cost.rs @@ -0,0 +1,171 @@ +use crate::requests::api::image::edit::gpt_image_1p5_edit_image::api::{ + GptImage1p5EditImageNumImages, GptImage1p5EditImageQuality, + GptImage1p5EditImageRequest, GptImage1p5EditImageSize, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for GptImage1p5EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Per fal docs (fal-ai/gpt-image-1.5/edit): + // Low: $0.009 (1024x1024) / $0.013 (other) per image + // Medium: $0.034 (1024x1024) / $0.050-$0.051 (other) per image + // High: $0.133 (1024x1024) / $0.199-$0.200 (other) per image + let use_quality = self.quality.unwrap_or(GptImage1p5EditImageQuality::Medium); + let use_size = self.image_size.unwrap_or(GptImage1p5EditImageSize::Square); + + let base_cost = match (use_quality, use_size) { + (GptImage1p5EditImageQuality::Low, GptImage1p5EditImageSize::Square) => 1, + (GptImage1p5EditImageQuality::Low, _) => 1, + (GptImage1p5EditImageQuality::Medium, GptImage1p5EditImageSize::Square) => 3, + (GptImage1p5EditImageQuality::Medium, _) => 5, + (GptImage1p5EditImageQuality::High, GptImage1p5EditImageSize::Square) => 13, + (GptImage1p5EditImageQuality::High, _) => 20, + }; + + let cost = match self.num_images { + GptImage1p5EditImageNumImages::One => base_cost, + GptImage1p5EditImageNumImages::Two => base_cost * 2, + GptImage1p5EditImageNumImages::Three => base_cost * 3, + GptImage1p5EditImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: GptImage1p5EditImageNumImages, + quality: Option, + image_size: Option, + ) -> GptImage1p5EditImageRequest { + GptImage1p5EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.png".to_string()], + num_images, + mask_image_url: None, + image_size, + background: None, + quality, + input_fidelity: None, + output_format: None, + } + } + + mod default_tests { + use super::*; + + #[test] + fn cost_defaults_one_image() { + // Default quality=Medium, size=Square => 3 cents + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, None, None) + .calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_defaults_four_images() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::Four, None, None) + .calculate_cost_in_cents(), 12); + } + } + + mod low_quality_tests { + use super::*; + + #[test] + fn cost_low_square_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::Low), Some(GptImage1p5EditImageSize::Square)) + .calculate_cost_in_cents(), 1); + } + + #[test] + fn cost_low_wide_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::Low), Some(GptImage1p5EditImageSize::Wide)) + .calculate_cost_in_cents(), 1); + } + + #[test] + fn cost_low_tall_four_images() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::Four, Some(GptImage1p5EditImageQuality::Low), Some(GptImage1p5EditImageSize::Tall)) + .calculate_cost_in_cents(), 4); + } + } + + mod medium_quality_tests { + use super::*; + + #[test] + fn cost_medium_square_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Square)) + .calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_medium_wide_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Wide)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_tall_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Tall)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_wide_three_images() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::Three, Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Wide)) + .calculate_cost_in_cents(), 15); + } + } + + mod high_quality_tests { + use super::*; + + #[test] + fn cost_high_square_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Square)) + .calculate_cost_in_cents(), 13); + } + + #[test] + fn cost_high_wide_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Wide)) + .calculate_cost_in_cents(), 20); + } + + #[test] + fn cost_high_tall_one_image() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::One, Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Tall)) + .calculate_cost_in_cents(), 20); + } + + #[test] + fn cost_high_square_two_images() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::Two, Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Square)) + .calculate_cost_in_cents(), 26); + } + + #[test] + fn cost_high_wide_four_images() { + assert_eq!( + make_request(GptImage1p5EditImageNumImages::Four, Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Wide)) + .calculate_cost_in_cents(), 80); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/raw_request.rs new file mode 100644 index 00000000..d17609e1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_1p5_edit_image/raw_request.rs @@ -0,0 +1,48 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1p5EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// The URL of the mask image indicating what part of the image to edit. + #[serde(skip_serializing_if = "Option::is_none")] + pub mask_image_url: Option, + + /// "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// "low", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub input_fidelity: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5EditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/api.rs new file mode 100644 index 00000000..007ffc87 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/api.rs @@ -0,0 +1,371 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::common::gpt_image_2_resolution::{ + compute_custom_image_size, GptImage2AspectRatio, GptImage2Resolution, +}; +use crate::requests::api::image::edit::gpt_image_2_edit_image::raw_request::{ + GptImage2EditImageInput, GptImage2EditImageOutput, ImageSizeParam, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct GptImage2EditImageRequest { + /// Text prompt describing the edit to make. + pub prompt: String, + + /// One or more source image URLs to edit. + pub image_urls: Vec, + + /// Number of images to generate. + pub num_images: GptImage2EditImageNumImages, + + /// Optional mask URL indicating what part of the image to edit. + pub mask_url: Option, + + /// Output image size (aspect ratio preset). + pub image_size: Option, + + /// Optional resolution tier. When present, a custom width x height is + /// computed from the aspect ratio and this resolution, overriding the + /// standard preset dimensions. Not applicable when image_size is Auto. + pub resolution: Option, + + /// Quality level. + pub quality: Option, + + /// Output format. + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2EditImageSize { + SquareHd, + Square, + Portrait4x3, + Portrait16x9, + Landscape4x3, + Landscape16x9, + Auto, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2EditImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2EditImageOutputFormat { + Jpeg, + Png, + Webp, +} + +/// Map image_size to GptImage2AspectRatio. Returns None for Auto (no +/// meaningful aspect ratio to compute custom dimensions from). +fn size_to_aspect(size: GptImage2EditImageSize) -> Option { + match size { + GptImage2EditImageSize::Square => Some(GptImage2AspectRatio::Square), + GptImage2EditImageSize::SquareHd => Some(GptImage2AspectRatio::SquareHd), + GptImage2EditImageSize::Landscape4x3 => Some(GptImage2AspectRatio::Landscape4x3), + GptImage2EditImageSize::Landscape16x9 => Some(GptImage2AspectRatio::Landscape16x9), + GptImage2EditImageSize::Portrait4x3 => Some(GptImage2AspectRatio::Portrait4x3), + GptImage2EditImageSize::Portrait16x9 => Some(GptImage2AspectRatio::Portrait16x9), + GptImage2EditImageSize::Auto => None, + } +} + +fn size_to_preset_str(size: GptImage2EditImageSize) -> &'static str { + match size { + GptImage2EditImageSize::SquareHd => "square_hd", + GptImage2EditImageSize::Square => "square", + GptImage2EditImageSize::Portrait4x3 => "portrait_4_3", + GptImage2EditImageSize::Portrait16x9 => "portrait_16_9", + GptImage2EditImageSize::Landscape4x3 => "landscape_4_3", + GptImage2EditImageSize::Landscape16x9 => "landscape_16_9", + GptImage2EditImageSize::Auto => "auto", + } +} + +impl FalEndpoint for GptImage2EditImageRequest { + const ENDPOINT: &str = "openai/gpt-image-2/edit"; + + type RawRequest = GptImage2EditImageInput; + type RawResponse = GptImage2EditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + GptImage2EditImageNumImages::One => 1, + GptImage2EditImageNumImages::Two => 2, + GptImage2EditImageNumImages::Three => 3, + GptImage2EditImageNumImages::Four => 4, + }; + + let image_size = match (self.image_size, self.resolution) { + // Resolution present with a non-Auto size: compute custom dimensions + (Some(size), Some(resolution)) => { + match size_to_aspect(size) { + Some(aspect) => { + let custom = compute_custom_image_size(aspect, resolution); + Some(ImageSizeParam::Custom(custom)) + } + // Auto + resolution: can't compute dimensions, fall back to preset + None => Some(ImageSizeParam::Preset(size_to_preset_str(size).to_string())), + } + } + // Resolution present but no image_size: default to Square + (None, Some(resolution)) => { + let custom = compute_custom_image_size(GptImage2AspectRatio::Square, resolution); + Some(ImageSizeParam::Custom(custom)) + } + // No resolution: use the standard preset string + (Some(size), None) => { + Some(ImageSizeParam::Preset(size_to_preset_str(size).to_string())) + } + // Neither: let the API default + (None, None) => None, + }; + + let quality = self.quality.map(|q| match q { + GptImage2EditImageQuality::Low => "low", + GptImage2EditImageQuality::Medium => "medium", + GptImage2EditImageQuality::High => "high", + }.to_string()); + + let output_format = Some(match self.output_format { + Some(GptImage2EditImageOutputFormat::Jpeg) => "jpeg", + Some(GptImage2EditImageOutputFormat::Png) => "png", + Some(GptImage2EditImageOutputFormat::Webp) => "webp", + None => "png", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + num_images: Some(num_images), + mask_url: self.mask_url.clone(), + image_size, + quality, + output_format, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::api::image::common::gpt_image_2_resolution::GptImage2Resolution; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage2EditImageRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + num_images: GptImage2EditImageNumImages::Two, + mask_url: None, + image_size: None, + resolution: None, + quality: None, + output_format: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage2EditImageRequest { + image_urls: vec![GHOST_IMAGE_URL.to_string()], + prompt: "make the ghost wear a top hat".to_string(), + num_images: GptImage2EditImageNumImages::One, + mask_url: None, + image_size: Some(GptImage2EditImageSize::Square), + resolution: None, + quality: Some(GptImage2EditImageQuality::High), + output_format: Some(GptImage2EditImageOutputFormat::Png), + }; + + let result = request.send_webhook_request( + &api_key, + "https://example.com/webhook", + ).await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + /// Combinatorial test: every (image_size, resolution) pair for edit-image. + /// Uses a test_data source image and prompts to include the test parameters + /// as text in the output. + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_combinatorial_size_and_resolution() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let sizes = [ + ("square", GptImage2EditImageSize::Square), + ("square_hd", GptImage2EditImageSize::SquareHd), + ("landscape_4x3", GptImage2EditImageSize::Landscape4x3), + ("landscape_16x9", GptImage2EditImageSize::Landscape16x9), + ("portrait_4x3", GptImage2EditImageSize::Portrait4x3), + ("portrait_16x9", GptImage2EditImageSize::Portrait16x9), + ]; + + let resolutions = [ + ("1K", GptImage2Resolution::OneK), + ("2K", GptImage2Resolution::TwoK), + ("3K", GptImage2Resolution::ThreeK), + ("4K", GptImage2Resolution::FourK), + ]; + + let surfaces = ["t-shirt", "sign", "monitor", "billboard", "coffee mug", "poster"]; + let mut surface_idx = 0; + + for (size_name, size) in &sizes { + for (res_name, resolution) in &resolutions { + let surface = surfaces[surface_idx % surfaces.len()]; + surface_idx += 1; + + let prompt = format!( + "Edit this image: add a {} with the text \"{} {}\" prominently displayed, studio lighting", + surface, size_name, res_name, + ); + + let request = GptImage2EditImageRequest { + prompt, + image_urls: vec![GHOST_IMAGE_URL.to_string()], + num_images: GptImage2EditImageNumImages::One, + mask_url: None, + image_size: Some(*size), + resolution: Some(*resolution), + quality: Some(GptImage2EditImageQuality::Medium), + output_format: Some(GptImage2EditImageOutputFormat::Png), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("[{} + {}] Request ID: {}", size_name, res_name, result.request_id); + assert!(!result.request_id.is_empty()); + } + } + + Ok(()) + } + + mod to_raw_request_tests { + use super::*; + use crate::requests::api::image::edit::gpt_image_2_edit_image::raw_request::ImageSizeParam; + + fn make_request( + image_size: Option, + resolution: Option, + ) -> GptImage2EditImageRequest { + GptImage2EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.png".to_string()], + num_images: GptImage2EditImageNumImages::One, + mask_url: None, + image_size, + resolution, + quality: None, + output_format: None, + } + } + + #[test] + fn preset_without_resolution() { + let raw = make_request(Some(GptImage2EditImageSize::Square), None) + .to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Preset(s) => assert_eq!(s, "square"), + ImageSizeParam::Custom(_) => panic!("expected preset"), + } + } + + #[test] + fn auto_without_resolution() { + let raw = make_request(Some(GptImage2EditImageSize::Auto), None) + .to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Preset(s) => assert_eq!(s, "auto"), + ImageSizeParam::Custom(_) => panic!("expected preset"), + } + } + + #[test] + fn custom_with_resolution() { + let raw = make_request( + Some(GptImage2EditImageSize::Landscape16x9), + Some(GptImage2Resolution::TwoK), + ).to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Custom(c) => { + assert_eq!(c.width, 2048); + assert_eq!(c.height, 1152); + } + ImageSizeParam::Preset(_) => panic!("expected custom"), + } + } + + #[test] + fn auto_with_resolution_falls_back_to_preset() { + let raw = make_request( + Some(GptImage2EditImageSize::Auto), + Some(GptImage2Resolution::TwoK), + ).to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Preset(s) => assert_eq!(s, "auto"), + ImageSizeParam::Custom(_) => panic!("expected preset for Auto + resolution"), + } + } + + #[test] + fn resolution_without_image_size_defaults_to_square() { + let raw = make_request(None, Some(GptImage2Resolution::TwoK)) + .to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Custom(c) => { + assert_eq!(c.width, 2048); + assert_eq!(c.height, 2048); + } + ImageSizeParam::Preset(_) => panic!("expected custom"), + } + } + + #[test] + fn neither_size_nor_resolution() { + let raw = make_request(None, None).to_raw_request().unwrap(); + assert!(raw.image_size.is_none()); + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/cost.rs new file mode 100644 index 00000000..205f278d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/cost.rs @@ -0,0 +1,443 @@ +use crate::requests::api::image::common::gpt_image_2_resolution::{ + compute_custom_image_size, GptImage2AspectRatio, GptImage2Resolution, +}; +use crate::requests::api::image::edit::gpt_image_2_edit_image::api::{ + GptImage2EditImageNumImages, GptImage2EditImageQuality, + GptImage2EditImageRequest, GptImage2EditImageSize, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for GptImage2EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + let quality = self.quality.unwrap_or(GptImage2EditImageQuality::High); + let total_pixels = estimate_total_pixels(self.image_size, self.resolution); + let megapixels = total_pixels as f64 / 1_000_000.0; + + // Fal's GPT Image 2 edit-image pricing has two components: + // + // 1. A base request cost (prompt processing, API overhead) + // 2. A per-pixel generation cost that scales with output resolution + // + // Both components increase with quality level. All rates are in + // tenths of a US cent, derived from Fal's published pricing. + // + // Edit-image is slightly cheaper than text-to-image at the base level, + // but scales at a similar per-pixel rate at medium and high quality. + let (base_tenths, per_megapixel_tenths): (f64, f64) = match quality { + GptImage2EditImageQuality::Low => ( 3.0, 1.0), + GptImage2EditImageQuality::Medium => (25.0, 9.0), + GptImage2EditImageQuality::High => (110.0, 35.0), + }; + + let tenths_per_image = (base_tenths + per_megapixel_tenths * megapixels).ceil() as u64; + let cents_per_image = tenths_per_image.div_ceil(10); + let num = num_images_u64(self.num_images); + + cents_per_image * num + } +} + +fn estimate_total_pixels( + image_size: Option, + resolution: Option, +) -> u64 { + match (image_size, resolution) { + // Auto: no meaningful aspect ratio, use conservative max-size estimate + (Some(GptImage2EditImageSize::Auto), _) => 3840 * 2160, // 8,294,400 + (Some(size), Some(res)) => { + let aspect = size_to_aspect(size); + let dims = compute_custom_image_size(aspect, res); + dims.width as u64 * dims.height as u64 + } + (None, Some(res)) => { + let dims = compute_custom_image_size(GptImage2AspectRatio::Square, res); + dims.width as u64 * dims.height as u64 + } + (Some(size), None) => preset_pixel_count(size), + (None, None) => preset_pixel_count(GptImage2EditImageSize::Square), + } +} + +fn size_to_aspect(size: GptImage2EditImageSize) -> GptImage2AspectRatio { + match size { + GptImage2EditImageSize::Square => GptImage2AspectRatio::Square, + GptImage2EditImageSize::SquareHd => GptImage2AspectRatio::SquareHd, + GptImage2EditImageSize::Landscape4x3 => GptImage2AspectRatio::Landscape4x3, + GptImage2EditImageSize::Landscape16x9 => GptImage2AspectRatio::Landscape16x9, + GptImage2EditImageSize::Portrait4x3 => GptImage2AspectRatio::Portrait4x3, + GptImage2EditImageSize::Portrait16x9 => GptImage2AspectRatio::Portrait16x9, + GptImage2EditImageSize::Auto => GptImage2AspectRatio::Square, + } +} + +/// Standard preset pixel counts when no custom resolution is specified. +fn preset_pixel_count(size: GptImage2EditImageSize) -> u64 { + match size { + GptImage2EditImageSize::Square => 1024 * 1024, // 1,048,576 + GptImage2EditImageSize::SquareHd => 2048 * 2048, // 4,194,304 + GptImage2EditImageSize::Landscape4x3 => 1024 * 768, // 786,432 + GptImage2EditImageSize::Landscape16x9 => 1920 * 1080, // 2,073,600 + GptImage2EditImageSize::Portrait4x3 => 768 * 1024, // 786,432 + GptImage2EditImageSize::Portrait16x9 => 1080 * 1920, // 2,073,600 + GptImage2EditImageSize::Auto => 3840 * 2160, // 8,294,400 (conservative) + } +} + +fn num_images_u64(num: GptImage2EditImageNumImages) -> u64 { + match num { + GptImage2EditImageNumImages::One => 1, + GptImage2EditImageNumImages::Two => 2, + GptImage2EditImageNumImages::Three => 3, + GptImage2EditImageNumImages::Four => 4, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: GptImage2EditImageNumImages, + quality: Option, + image_size: Option, + resolution: Option, + ) -> GptImage2EditImageRequest { + GptImage2EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.png".to_string()], + num_images, + mask_url: None, + image_size, + resolution, + quality, + output_format: None, + } + } + + use GptImage2EditImageNumImages::*; + use GptImage2EditImageQuality::*; + use GptImage2EditImageSize::*; + use GptImage2Resolution::*; + + mod preset_pricing_tests { + use super::*; + + // Table: (size, low, medium, high) — expected cents per image + const PRESET_CASES: &[(GptImage2EditImageSize, u64, u64, u64)] = &[ + // Low Med High + (Landscape4x3, 1, 4, 14), + (Portrait4x3, 1, 4, 14), + (Square, 1, 4, 15), + (Landscape16x9, 1, 5, 19), + (Portrait16x9, 1, 5, 19), + (SquareHd, 1, 7, 26), + (Auto, 2, 10, 41), + ]; + + #[test] + fn preset_costs_at_each_quality() { + for &(size, expected_low, expected_med, expected_high) in PRESET_CASES { + let cases = [ + (Low, expected_low), + (Medium, expected_med), + (High, expected_high), + ]; + for (quality, expected) in cases { + let actual = make_request(One, Some(quality), Some(size), None) + .calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {quality:?}"); + } + } + } + + #[test] + fn defaults_to_high_quality_square() { + assert_eq!( + make_request(One, None, None, None).calculate_cost_in_cents(), + 15, + ); + } + } + + mod custom_resolution_pricing_tests { + use super::*; + + // Table: (size, resolution, low, medium, high) — expected cents per image + const RESOLUTION_CASES: &[(GptImage2EditImageSize, GptImage2Resolution, u64, u64, u64)] = &[ + // Square aspect + (Square, OneK, 1, 4, 15), + (Square, TwoK, 1, 7, 26), + (Square, ThreeK, 2, 10, 41), + (Square, FourK, 2, 10, 41), // capped at max pixels + + // SquareHd (same aspect as Square) + (SquareHd, OneK, 1, 4, 15), + (SquareHd, TwoK, 1, 7, 26), + (SquareHd, ThreeK, 2, 10, 41), + (SquareHd, FourK, 2, 10, 41), + + // Landscape 4:3 + (Landscape4x3, OneK, 1, 4, 14), + (Landscape4x3, TwoK, 1, 6, 23), + (Landscape4x3, ThreeK, 2, 9, 36), + (Landscape4x3, FourK, 2, 10, 40), + + // Landscape 16:9 + (Landscape16x9, OneK, 1, 4, 14), + (Landscape16x9, TwoK, 1, 5, 20), + (Landscape16x9, ThreeK, 1, 8, 30), + (Landscape16x9, FourK, 2, 10, 41), + + // Portrait 4:3 + (Portrait4x3, OneK, 1, 4, 14), + (Portrait4x3, TwoK, 1, 6, 23), + (Portrait4x3, ThreeK, 2, 9, 36), + (Portrait4x3, FourK, 2, 10, 40), + + // Portrait 16:9 + (Portrait16x9, OneK, 1, 4, 14), + (Portrait16x9, TwoK, 1, 5, 20), + (Portrait16x9, ThreeK, 1, 8, 30), + (Portrait16x9, FourK, 2, 10, 41), + ]; + + #[test] + fn resolution_costs_at_each_quality() { + for &(size, res, expected_low, expected_med, expected_high) in RESOLUTION_CASES { + let cases = [ + (Low, expected_low), + (Medium, expected_med), + (High, expected_high), + ]; + for (quality, expected) in cases { + let actual = make_request(One, Some(quality), Some(size), Some(res)) + .calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {res:?} {quality:?}"); + } + } + } + + #[test] + fn resolution_without_size_defaults_to_square() { + assert_eq!( + make_request(One, Some(High), None, Some(TwoK)).calculate_cost_in_cents(), + make_request(One, Some(High), Some(Square), Some(TwoK)).calculate_cost_in_cents(), + ); + } + + #[test] + fn auto_ignores_resolution_and_uses_max_estimate() { + // Auto always uses the conservative 3840x2160 estimate + let auto_cost = make_request(One, Some(High), Some(Auto), Some(OneK)) + .calculate_cost_in_cents(); + let auto_no_res = make_request(One, Some(High), Some(Auto), None) + .calculate_cost_in_cents(); + assert_eq!(auto_cost, auto_no_res); + } + } + + mod num_images_tests { + use super::*; + + const ALL_BATCH_SIZES: &[(GptImage2EditImageNumImages, u64)] = &[ + (One, 1), (Two, 2), (Three, 3), (Four, 4), + ]; + + const ALL_SIZES: &[GptImage2EditImageSize] = &[ + Square, SquareHd, Landscape4x3, Landscape16x9, Portrait4x3, Portrait16x9, Auto, + ]; + + const ALL_RESOLUTIONS: &[GptImage2Resolution] = &[OneK, TwoK, ThreeK, FourK]; + + #[test] + fn batch_scales_linearly_for_all_presets() { + for &size in ALL_SIZES { + let per_image = make_request(One, Some(High), Some(size), None) + .calculate_cost_in_cents(); + for &(num, n) in ALL_BATCH_SIZES { + let actual = make_request(num, Some(High), Some(size), None) + .calculate_cost_in_cents(); + assert_eq!(actual, per_image * n, "{size:?} x{n}"); + } + } + } + + #[test] + fn batch_scales_linearly_for_all_resolutions() { + for &size in &[Square, SquareHd, Landscape4x3, Landscape16x9, Portrait4x3, Portrait16x9] { + for &res in ALL_RESOLUTIONS { + let per_image = make_request(One, Some(High), Some(size), Some(res)) + .calculate_cost_in_cents(); + for &(num, n) in ALL_BATCH_SIZES { + let actual = make_request(num, Some(High), Some(size), Some(res)) + .calculate_cost_in_cents(); + assert_eq!(actual, per_image * n, "{size:?} {res:?} x{n}"); + } + } + } + } + } + + mod exhaustive_preset_batch_tests { + use super::*; + + // (size, quality, num_images, expected_cents) + const CASES: &[(GptImage2EditImageSize, GptImage2EditImageQuality, GptImage2EditImageNumImages, u64)] = &[ + (Square, Low, One, 1), (Square, Low, Two, 2), (Square, Low, Three, 3), (Square, Low, Four, 4), + (Square, Medium, One, 4), (Square, Medium, Two, 8), (Square, Medium, Three, 12), (Square, Medium, Four, 16), + (Square, High, One, 15), (Square, High, Two, 30), (Square, High, Three, 45), (Square, High, Four, 60), + (SquareHd, Low, One, 1), (SquareHd, Low, Two, 2), (SquareHd, Low, Three, 3), (SquareHd, Low, Four, 4), + (SquareHd, Medium, One, 7), (SquareHd, Medium, Two, 14), (SquareHd, Medium, Three, 21), (SquareHd, Medium, Four, 28), + (SquareHd, High, One, 26), (SquareHd, High, Two, 52), (SquareHd, High, Three, 78), (SquareHd, High, Four, 104), + (Landscape4x3, Low, One, 1), (Landscape4x3, Low, Two, 2), (Landscape4x3, Low, Three, 3), (Landscape4x3, Low, Four, 4), + (Landscape4x3, Medium, One, 4), (Landscape4x3, Medium, Two, 8), (Landscape4x3, Medium, Three, 12), (Landscape4x3, Medium, Four, 16), + (Landscape4x3, High, One, 14), (Landscape4x3, High, Two, 28), (Landscape4x3, High, Three, 42), (Landscape4x3, High, Four, 56), + (Landscape16x9, Low, One, 1), (Landscape16x9, Low, Two, 2), (Landscape16x9, Low, Three, 3), (Landscape16x9, Low, Four, 4), + (Landscape16x9, Medium, One, 5), (Landscape16x9, Medium, Two, 10), (Landscape16x9, Medium, Three, 15), (Landscape16x9, Medium, Four, 20), + (Landscape16x9, High, One, 19), (Landscape16x9, High, Two, 38), (Landscape16x9, High, Three, 57), (Landscape16x9, High, Four, 76), + (Portrait4x3, Low, One, 1), (Portrait4x3, Low, Two, 2), (Portrait4x3, Low, Three, 3), (Portrait4x3, Low, Four, 4), + (Portrait4x3, Medium, One, 4), (Portrait4x3, Medium, Two, 8), (Portrait4x3, Medium, Three, 12), (Portrait4x3, Medium, Four, 16), + (Portrait4x3, High, One, 14), (Portrait4x3, High, Two, 28), (Portrait4x3, High, Three, 42), (Portrait4x3, High, Four, 56), + (Portrait16x9, Low, One, 1), (Portrait16x9, Low, Two, 2), (Portrait16x9, Low, Three, 3), (Portrait16x9, Low, Four, 4), + (Portrait16x9, Medium, One, 5), (Portrait16x9, Medium, Two, 10), (Portrait16x9, Medium, Three, 15), (Portrait16x9, Medium, Four, 20), + (Portrait16x9, High, One, 19), (Portrait16x9, High, Two, 38), (Portrait16x9, High, Three, 57), (Portrait16x9, High, Four, 76), + (Auto, Low, One, 2), (Auto, Low, Two, 4), (Auto, Low, Three, 6), (Auto, Low, Four, 8), + (Auto, Medium, One, 10), (Auto, Medium, Two, 20), (Auto, Medium, Three, 30), (Auto, Medium, Four, 40), + (Auto, High, One, 41), (Auto, High, Two, 82), (Auto, High, Three, 123), (Auto, High, Four, 164), + ]; + + #[test] + fn all_preset_batch_costs() { + for &(size, quality, num, expected) in CASES { + let actual = make_request(num, Some(quality), Some(size), None).calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {quality:?} {num:?}"); + } + } + } + + mod exhaustive_resolution_batch_tests { + use super::*; + + // (size, resolution, quality, num_images, expected_cents) + const CASES: &[(GptImage2EditImageSize, GptImage2Resolution, GptImage2EditImageQuality, GptImage2EditImageNumImages, u64)] = &[ + // Square + (Square, OneK, Low, One, 1), (Square, OneK, Low, Two, 2), (Square, OneK, Low, Three, 3), (Square, OneK, Low, Four, 4), + (Square, OneK, Medium, One, 4), (Square, OneK, Medium, Two, 8), (Square, OneK, Medium, Three, 12), (Square, OneK, Medium, Four, 16), + (Square, OneK, High, One, 15), (Square, OneK, High, Two, 30), (Square, OneK, High, Three, 45), (Square, OneK, High, Four, 60), + (Square, TwoK, Low, One, 1), (Square, TwoK, Low, Two, 2), (Square, TwoK, Low, Three, 3), (Square, TwoK, Low, Four, 4), + (Square, TwoK, Medium, One, 7), (Square, TwoK, Medium, Two, 14), (Square, TwoK, Medium, Three, 21), (Square, TwoK, Medium, Four, 28), + (Square, TwoK, High, One, 26), (Square, TwoK, High, Two, 52), (Square, TwoK, High, Three, 78), (Square, TwoK, High, Four, 104), + (Square, ThreeK, Low, One, 2), (Square, ThreeK, Low, Two, 4), (Square, ThreeK, Low, Three, 6), (Square, ThreeK, Low, Four, 8), + (Square, ThreeK, Medium, One, 10), (Square, ThreeK, Medium, Two, 20), (Square, ThreeK, Medium, Three, 30), (Square, ThreeK, Medium, Four, 40), + (Square, ThreeK, High, One, 41), (Square, ThreeK, High, Two, 82), (Square, ThreeK, High, Three, 123), (Square, ThreeK, High, Four, 164), + (Square, FourK, Low, One, 2), (Square, FourK, Low, Two, 4), (Square, FourK, Low, Three, 6), (Square, FourK, Low, Four, 8), + (Square, FourK, Medium, One, 10), (Square, FourK, Medium, Two, 20), (Square, FourK, Medium, Three, 30), (Square, FourK, Medium, Four, 40), + (Square, FourK, High, One, 41), (Square, FourK, High, Two, 82), (Square, FourK, High, Three, 123), (Square, FourK, High, Four, 164), + // SquareHd + (SquareHd, OneK, Low, One, 1), (SquareHd, OneK, Low, Two, 2), (SquareHd, OneK, Low, Three, 3), (SquareHd, OneK, Low, Four, 4), + (SquareHd, OneK, Medium, One, 4), (SquareHd, OneK, Medium, Two, 8), (SquareHd, OneK, Medium, Three, 12), (SquareHd, OneK, Medium, Four, 16), + (SquareHd, OneK, High, One, 15), (SquareHd, OneK, High, Two, 30), (SquareHd, OneK, High, Three, 45), (SquareHd, OneK, High, Four, 60), + (SquareHd, TwoK, Low, One, 1), (SquareHd, TwoK, Low, Two, 2), (SquareHd, TwoK, Low, Three, 3), (SquareHd, TwoK, Low, Four, 4), + (SquareHd, TwoK, Medium, One, 7), (SquareHd, TwoK, Medium, Two, 14), (SquareHd, TwoK, Medium, Three, 21), (SquareHd, TwoK, Medium, Four, 28), + (SquareHd, TwoK, High, One, 26), (SquareHd, TwoK, High, Two, 52), (SquareHd, TwoK, High, Three, 78), (SquareHd, TwoK, High, Four, 104), + (SquareHd, ThreeK, Low, One, 2), (SquareHd, ThreeK, Low, Two, 4), (SquareHd, ThreeK, Low, Three, 6), (SquareHd, ThreeK, Low, Four, 8), + (SquareHd, ThreeK, Medium, One, 10), (SquareHd, ThreeK, Medium, Two, 20), (SquareHd, ThreeK, Medium, Three, 30), (SquareHd, ThreeK, Medium, Four, 40), + (SquareHd, ThreeK, High, One, 41), (SquareHd, ThreeK, High, Two, 82), (SquareHd, ThreeK, High, Three, 123), (SquareHd, ThreeK, High, Four, 164), + (SquareHd, FourK, Low, One, 2), (SquareHd, FourK, Low, Two, 4), (SquareHd, FourK, Low, Three, 6), (SquareHd, FourK, Low, Four, 8), + (SquareHd, FourK, Medium, One, 10), (SquareHd, FourK, Medium, Two, 20), (SquareHd, FourK, Medium, Three, 30), (SquareHd, FourK, Medium, Four, 40), + (SquareHd, FourK, High, One, 41), (SquareHd, FourK, High, Two, 82), (SquareHd, FourK, High, Three, 123), (SquareHd, FourK, High, Four, 164), + // Landscape4x3 + (Landscape4x3, OneK, Low, One, 1), (Landscape4x3, OneK, Low, Two, 2), (Landscape4x3, OneK, Low, Three, 3), (Landscape4x3, OneK, Low, Four, 4), + (Landscape4x3, OneK, Medium, One, 4), (Landscape4x3, OneK, Medium, Two, 8), (Landscape4x3, OneK, Medium, Three, 12), (Landscape4x3, OneK, Medium, Four, 16), + (Landscape4x3, OneK, High, One, 14), (Landscape4x3, OneK, High, Two, 28), (Landscape4x3, OneK, High, Three, 42), (Landscape4x3, OneK, High, Four, 56), + (Landscape4x3, TwoK, Low, One, 1), (Landscape4x3, TwoK, Low, Two, 2), (Landscape4x3, TwoK, Low, Three, 3), (Landscape4x3, TwoK, Low, Four, 4), + (Landscape4x3, TwoK, Medium, One, 6), (Landscape4x3, TwoK, Medium, Two, 12), (Landscape4x3, TwoK, Medium, Three, 18), (Landscape4x3, TwoK, Medium, Four, 24), + (Landscape4x3, TwoK, High, One, 23), (Landscape4x3, TwoK, High, Two, 46), (Landscape4x3, TwoK, High, Three, 69), (Landscape4x3, TwoK, High, Four, 92), + (Landscape4x3, ThreeK, Low, One, 2), (Landscape4x3, ThreeK, Low, Two, 4), (Landscape4x3, ThreeK, Low, Three, 6), (Landscape4x3, ThreeK, Low, Four, 8), + (Landscape4x3, ThreeK, Medium, One, 9), (Landscape4x3, ThreeK, Medium, Two, 18), (Landscape4x3, ThreeK, Medium, Three, 27), (Landscape4x3, ThreeK, Medium, Four, 36), + (Landscape4x3, ThreeK, High, One, 36), (Landscape4x3, ThreeK, High, Two, 72), (Landscape4x3, ThreeK, High, Three, 108), (Landscape4x3, ThreeK, High, Four, 144), + (Landscape4x3, FourK, Low, One, 2), (Landscape4x3, FourK, Low, Two, 4), (Landscape4x3, FourK, Low, Three, 6), (Landscape4x3, FourK, Low, Four, 8), + (Landscape4x3, FourK, Medium, One, 10), (Landscape4x3, FourK, Medium, Two, 20), (Landscape4x3, FourK, Medium, Three, 30), (Landscape4x3, FourK, Medium, Four, 40), + (Landscape4x3, FourK, High, One, 40), (Landscape4x3, FourK, High, Two, 80), (Landscape4x3, FourK, High, Three, 120), (Landscape4x3, FourK, High, Four, 160), + // Landscape16x9 + (Landscape16x9, OneK, Low, One, 1), (Landscape16x9, OneK, Low, Two, 2), (Landscape16x9, OneK, Low, Three, 3), (Landscape16x9, OneK, Low, Four, 4), + (Landscape16x9, OneK, Medium, One, 4), (Landscape16x9, OneK, Medium, Two, 8), (Landscape16x9, OneK, Medium, Three, 12), (Landscape16x9, OneK, Medium, Four, 16), + (Landscape16x9, OneK, High, One, 14), (Landscape16x9, OneK, High, Two, 28), (Landscape16x9, OneK, High, Three, 42), (Landscape16x9, OneK, High, Four, 56), + (Landscape16x9, TwoK, Low, One, 1), (Landscape16x9, TwoK, Low, Two, 2), (Landscape16x9, TwoK, Low, Three, 3), (Landscape16x9, TwoK, Low, Four, 4), + (Landscape16x9, TwoK, Medium, One, 5), (Landscape16x9, TwoK, Medium, Two, 10), (Landscape16x9, TwoK, Medium, Three, 15), (Landscape16x9, TwoK, Medium, Four, 20), + (Landscape16x9, TwoK, High, One, 20), (Landscape16x9, TwoK, High, Two, 40), (Landscape16x9, TwoK, High, Three, 60), (Landscape16x9, TwoK, High, Four, 80), + (Landscape16x9, ThreeK, Low, One, 1), (Landscape16x9, ThreeK, Low, Two, 2), (Landscape16x9, ThreeK, Low, Three, 3), (Landscape16x9, ThreeK, Low, Four, 4), + (Landscape16x9, ThreeK, Medium, One, 8), (Landscape16x9, ThreeK, Medium, Two, 16), (Landscape16x9, ThreeK, Medium, Three, 24), (Landscape16x9, ThreeK, Medium, Four, 32), + (Landscape16x9, ThreeK, High, One, 30), (Landscape16x9, ThreeK, High, Two, 60), (Landscape16x9, ThreeK, High, Three, 90), (Landscape16x9, ThreeK, High, Four, 120), + (Landscape16x9, FourK, Low, One, 2), (Landscape16x9, FourK, Low, Two, 4), (Landscape16x9, FourK, Low, Three, 6), (Landscape16x9, FourK, Low, Four, 8), + (Landscape16x9, FourK, Medium, One, 10), (Landscape16x9, FourK, Medium, Two, 20), (Landscape16x9, FourK, Medium, Three, 30), (Landscape16x9, FourK, Medium, Four, 40), + (Landscape16x9, FourK, High, One, 41), (Landscape16x9, FourK, High, Two, 82), (Landscape16x9, FourK, High, Three, 123), (Landscape16x9, FourK, High, Four, 164), + // Portrait4x3 + (Portrait4x3, OneK, Low, One, 1), (Portrait4x3, OneK, Low, Two, 2), (Portrait4x3, OneK, Low, Three, 3), (Portrait4x3, OneK, Low, Four, 4), + (Portrait4x3, OneK, Medium, One, 4), (Portrait4x3, OneK, Medium, Two, 8), (Portrait4x3, OneK, Medium, Three, 12), (Portrait4x3, OneK, Medium, Four, 16), + (Portrait4x3, OneK, High, One, 14), (Portrait4x3, OneK, High, Two, 28), (Portrait4x3, OneK, High, Three, 42), (Portrait4x3, OneK, High, Four, 56), + (Portrait4x3, TwoK, Low, One, 1), (Portrait4x3, TwoK, Low, Two, 2), (Portrait4x3, TwoK, Low, Three, 3), (Portrait4x3, TwoK, Low, Four, 4), + (Portrait4x3, TwoK, Medium, One, 6), (Portrait4x3, TwoK, Medium, Two, 12), (Portrait4x3, TwoK, Medium, Three, 18), (Portrait4x3, TwoK, Medium, Four, 24), + (Portrait4x3, TwoK, High, One, 23), (Portrait4x3, TwoK, High, Two, 46), (Portrait4x3, TwoK, High, Three, 69), (Portrait4x3, TwoK, High, Four, 92), + (Portrait4x3, ThreeK, Low, One, 2), (Portrait4x3, ThreeK, Low, Two, 4), (Portrait4x3, ThreeK, Low, Three, 6), (Portrait4x3, ThreeK, Low, Four, 8), + (Portrait4x3, ThreeK, Medium, One, 9), (Portrait4x3, ThreeK, Medium, Two, 18), (Portrait4x3, ThreeK, Medium, Three, 27), (Portrait4x3, ThreeK, Medium, Four, 36), + (Portrait4x3, ThreeK, High, One, 36), (Portrait4x3, ThreeK, High, Two, 72), (Portrait4x3, ThreeK, High, Three, 108), (Portrait4x3, ThreeK, High, Four, 144), + (Portrait4x3, FourK, Low, One, 2), (Portrait4x3, FourK, Low, Two, 4), (Portrait4x3, FourK, Low, Three, 6), (Portrait4x3, FourK, Low, Four, 8), + (Portrait4x3, FourK, Medium, One, 10), (Portrait4x3, FourK, Medium, Two, 20), (Portrait4x3, FourK, Medium, Three, 30), (Portrait4x3, FourK, Medium, Four, 40), + (Portrait4x3, FourK, High, One, 40), (Portrait4x3, FourK, High, Two, 80), (Portrait4x3, FourK, High, Three, 120), (Portrait4x3, FourK, High, Four, 160), + // Portrait16x9 + (Portrait16x9, OneK, Low, One, 1), (Portrait16x9, OneK, Low, Two, 2), (Portrait16x9, OneK, Low, Three, 3), (Portrait16x9, OneK, Low, Four, 4), + (Portrait16x9, OneK, Medium, One, 4), (Portrait16x9, OneK, Medium, Two, 8), (Portrait16x9, OneK, Medium, Three, 12), (Portrait16x9, OneK, Medium, Four, 16), + (Portrait16x9, OneK, High, One, 14), (Portrait16x9, OneK, High, Two, 28), (Portrait16x9, OneK, High, Three, 42), (Portrait16x9, OneK, High, Four, 56), + (Portrait16x9, TwoK, Low, One, 1), (Portrait16x9, TwoK, Low, Two, 2), (Portrait16x9, TwoK, Low, Three, 3), (Portrait16x9, TwoK, Low, Four, 4), + (Portrait16x9, TwoK, Medium, One, 5), (Portrait16x9, TwoK, Medium, Two, 10), (Portrait16x9, TwoK, Medium, Three, 15), (Portrait16x9, TwoK, Medium, Four, 20), + (Portrait16x9, TwoK, High, One, 20), (Portrait16x9, TwoK, High, Two, 40), (Portrait16x9, TwoK, High, Three, 60), (Portrait16x9, TwoK, High, Four, 80), + (Portrait16x9, ThreeK, Low, One, 1), (Portrait16x9, ThreeK, Low, Two, 2), (Portrait16x9, ThreeK, Low, Three, 3), (Portrait16x9, ThreeK, Low, Four, 4), + (Portrait16x9, ThreeK, Medium, One, 8), (Portrait16x9, ThreeK, Medium, Two, 16), (Portrait16x9, ThreeK, Medium, Three, 24), (Portrait16x9, ThreeK, Medium, Four, 32), + (Portrait16x9, ThreeK, High, One, 30), (Portrait16x9, ThreeK, High, Two, 60), (Portrait16x9, ThreeK, High, Three, 90), (Portrait16x9, ThreeK, High, Four, 120), + (Portrait16x9, FourK, Low, One, 2), (Portrait16x9, FourK, Low, Two, 4), (Portrait16x9, FourK, Low, Three, 6), (Portrait16x9, FourK, Low, Four, 8), + (Portrait16x9, FourK, Medium, One, 10), (Portrait16x9, FourK, Medium, Two, 20), (Portrait16x9, FourK, Medium, Three, 30), (Portrait16x9, FourK, Medium, Four, 40), + (Portrait16x9, FourK, High, One, 41), (Portrait16x9, FourK, High, Two, 82), (Portrait16x9, FourK, High, Three, 123), (Portrait16x9, FourK, High, Four, 164), + ]; + + #[test] + fn all_resolution_batch_costs() { + for &(size, res, quality, num, expected) in CASES { + let actual = make_request(num, Some(quality), Some(size), Some(res)).calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {res:?} {quality:?} {num:?}"); + } + } + } + + mod monotonicity_tests { + use super::*; + + #[test] + fn higher_quality_costs_more() { + for &size in &[Square, Landscape16x9, Portrait4x3, Auto] { + let low = make_request(One, Some(Low), Some(size), None).calculate_cost_in_cents(); + let med = make_request(One, Some(Medium), Some(size), None).calculate_cost_in_cents(); + let high = make_request(One, Some(High), Some(size), None).calculate_cost_in_cents(); + assert!(low <= med, "{size:?}: low ({low}) should be <= medium ({med})"); + assert!(med <= high, "{size:?}: medium ({med}) should be <= high ({high})"); + } + } + + #[test] + fn higher_resolution_costs_at_least_as_much() { + for &size in &[Square, Landscape16x9, Portrait4x3] { + let resolutions = [OneK, TwoK, ThreeK, FourK]; + for pair in resolutions.windows(2) { + let lower = make_request(One, Some(High), Some(size), Some(pair[0])) + .calculate_cost_in_cents(); + let higher = make_request(One, Some(High), Some(size), Some(pair[1])) + .calculate_cost_in_cents(); + assert!( + lower <= higher, + "{size:?}: {pair:?} — lower res ({lower}¢) should be <= higher res ({higher}¢)", + ); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/raw_request.rs new file mode 100644 index 00000000..b2b0c547 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/gpt_image_2_edit_image/raw_request.rs @@ -0,0 +1,52 @@ +use serde::{Deserialize, Serialize}; +use crate::requests::api::image::common::gpt_image_2_resolution::CustomImageSize; + +/// The `image_size` field can be either a string enum value (e.g. "square") +/// or a custom object with explicit width/height. +#[derive(Debug, Serialize, Deserialize, Clone)] +#[serde(untagged)] +pub enum ImageSizeParam { + Preset(String), + Custom(CustomImageSize), +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// The URL of the mask image to use for the generation. + /// This indicates what part of the image to edit. + #[serde(skip_serializing_if = "Option::is_none")] + pub mask_url: Option, + + /// square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto + /// OR a custom { width, height } object. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2EditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/mod.rs new file mode 100644 index 00000000..f80cf974 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/mod.rs @@ -0,0 +1,7 @@ +pub mod flux_1_dev_edit_image; +pub mod flux_1_schnell_edit_image; +pub mod gpt_image_1_edit_image; +pub mod gpt_image_1p5_edit_image; +pub mod gpt_image_2_edit_image; +pub mod nano_banana_2_edit_image; +pub mod nano_banana_pro_edit_image; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/api.rs new file mode 100644 index 00000000..85c5208d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/api.rs @@ -0,0 +1,188 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::edit::nano_banana_2_edit_image::raw_request::{ + NanoBanana2EditImageInput, NanoBanana2EditImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct NanoBanana2EditImageRequest { + /// Text prompt describing the desired edit. + pub prompt: String, + + /// URL(s) of the source image(s) to edit. + pub image_urls: Vec, + + /// Number of images to generate. + pub num_images: NanoBanana2EditImageNumImages, + + /// Output resolution. + pub resolution: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBanana2EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBanana2EditImageResolution { + HalfK, + OneK, + TwoK, + FourK, +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +#[derive(Copy, Clone, Debug)] +pub enum NanoBanana2EditImageAspectRatio { + Auto, + OneByOne, + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + +impl FalEndpoint for NanoBanana2EditImageRequest { + const ENDPOINT: &str = "fal-ai/nano-banana-2/edit"; + + type RawRequest = NanoBanana2EditImageInput; + type RawResponse = NanoBanana2EditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + NanoBanana2EditImageNumImages::One => 1, + NanoBanana2EditImageNumImages::Two => 2, + NanoBanana2EditImageNumImages::Three => 3, + NanoBanana2EditImageNumImages::Four => 4, + }; + + let resolution = self.resolution.map(|r| match r { + NanoBanana2EditImageResolution::HalfK => "0.5K", + NanoBanana2EditImageResolution::OneK => "1K", + NanoBanana2EditImageResolution::TwoK => "2K", + NanoBanana2EditImageResolution::FourK => "4K", + }.to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + NanoBanana2EditImageAspectRatio::Auto => "auto", + NanoBanana2EditImageAspectRatio::OneByOne => "1:1", + NanoBanana2EditImageAspectRatio::FiveByFour => "5:4", + NanoBanana2EditImageAspectRatio::FourByThree => "4:3", + NanoBanana2EditImageAspectRatio::ThreeByTwo => "3:2", + NanoBanana2EditImageAspectRatio::SixteenByNine => "16:9", + NanoBanana2EditImageAspectRatio::TwentyOneByNine => "21:9", + NanoBanana2EditImageAspectRatio::FourByFive => "4:5", + NanoBanana2EditImageAspectRatio::ThreeByFour => "3:4", + NanoBanana2EditImageAspectRatio::TwoByThree => "2:3", + NanoBanana2EditImageAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + num_images: Some(num_images), + aspect_ratio, + resolution, + output_format: Some("png".to_string()), + safety_tolerance: Some("6".to_string()), + limit_generations: None, + enable_web_search: None, + seed: None, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ + ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL, + WHITE_HOUSE_SUNSET_IMAGE_URL, + }; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = NanoBanana2EditImageRequest { + prompt: "make this image look like a watercolor painting".to_string(), + image_urls: vec![GHOST_IMAGE_URL.to_string()], + num_images: NanoBanana2EditImageNumImages::One, + resolution: Some(NanoBanana2EditImageResolution::OneK), + aspect_ratio: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_multi_image_spooky() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = NanoBanana2EditImageRequest { + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + num_images: NanoBanana2EditImageNumImages::Two, + resolution: Some(NanoBanana2EditImageResolution::TwoK), + aspect_ratio: Some(NanoBanana2EditImageAspectRatio::SixteenByNine), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_multi_image_white_house() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = NanoBanana2EditImageRequest { + prompt: "Put the scared man and the t-rex in front of the white house scene. Make the man afraid of the t-rex.".to_string(), + image_urls: vec![ + WHITE_HOUSE_SUNSET_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + num_images: NanoBanana2EditImageNumImages::Two, + resolution: Some(NanoBanana2EditImageResolution::TwoK), + aspect_ratio: Some(NanoBanana2EditImageAspectRatio::SixteenByNine), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/cost.rs new file mode 100644 index 00000000..bbe03ba8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/cost.rs @@ -0,0 +1,78 @@ +use crate::requests::api::image::edit::nano_banana_2_edit_image::api::{ + NanoBanana2EditImageNumImages, NanoBanana2EditImageRequest, NanoBanana2EditImageResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for NanoBanana2EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // TODO(bt): Verify actual pricing for Nano Banana 2 edit on fal.ai. + // 4K outputs may be charged at double the standard rate. + let base_cost = match self.resolution { + None => 15, + Some(NanoBanana2EditImageResolution::HalfK) => 8, + Some(NanoBanana2EditImageResolution::OneK) => 15, + Some(NanoBanana2EditImageResolution::TwoK) => 15, + Some(NanoBanana2EditImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + NanoBanana2EditImageNumImages::One => base_cost, + NanoBanana2EditImageNumImages::Two => base_cost * 2, + NanoBanana2EditImageNumImages::Three => base_cost * 3, + NanoBanana2EditImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: NanoBanana2EditImageNumImages, + resolution: Option, + ) -> NanoBanana2EditImageRequest { + NanoBanana2EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.jpg".to_string()], + num_images, + resolution, + aspect_ratio: None, + } + } + + #[test] + fn cost_default_resolution_one_image() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::One, None).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_half_k_one_image() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::One, Some(NanoBanana2EditImageResolution::HalfK)).calculate_cost_in_cents(), 8); + } + + #[test] + fn cost_one_k_one_image() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::One, Some(NanoBanana2EditImageResolution::OneK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_two_k_one_image() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::One, Some(NanoBanana2EditImageResolution::TwoK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_four_k_one_image() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::One, Some(NanoBanana2EditImageResolution::FourK)).calculate_cost_in_cents(), 30); + } + + #[test] + fn cost_one_k_four_images() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::Four, Some(NanoBanana2EditImageResolution::OneK)).calculate_cost_in_cents(), 60); + } + + #[test] + fn cost_four_k_two_images() { + assert_eq!(make_request(NanoBanana2EditImageNumImages::Two, Some(NanoBanana2EditImageResolution::FourK)).calculate_cost_in_cents(), 60); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/raw_request.rs new file mode 100644 index 00000000..234c97e7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_2_edit_image/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBanana2EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Eg. "0.5K", "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// The safety tolerance level. 1 = most strict, 6 = least strict. + /// Default: "4" + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// Limit generations per round of prompting to 1. + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub limit_generations: Option, + + /// Enable web search for image generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_web_search: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2EditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/api.rs new file mode 100644 index 00000000..4baf9edc --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/api.rs @@ -0,0 +1,137 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::edit::nano_banana_pro_edit_image::raw_request::{ + NanoBananaProEditImageInput, NanoBananaProEditImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct NanoBananaProEditImageRequest { + /// Text prompt describing the desired edit. + pub prompt: String, + + /// URL(s) of the source image(s) to edit. + pub image_urls: Vec, + + /// Number of images to generate. + pub num_images: NanoBananaProEditImageNumImages, + + /// Output resolution. + pub resolution: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBananaProEditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBananaProEditImageResolution { + OneK, + TwoK, + FourK, +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +#[derive(Copy, Clone, Debug)] +pub enum NanoBananaProEditImageAspectRatio { + Auto, + OneByOne, + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + +impl FalEndpoint for NanoBananaProEditImageRequest { + const ENDPOINT: &str = "fal-ai/nano-banana-pro/edit"; + + type RawRequest = NanoBananaProEditImageInput; + type RawResponse = NanoBananaProEditImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + NanoBananaProEditImageNumImages::One => 1, + NanoBananaProEditImageNumImages::Two => 2, + NanoBananaProEditImageNumImages::Three => 3, + NanoBananaProEditImageNumImages::Four => 4, + }; + + let resolution = self.resolution.map(|r| match r { + NanoBananaProEditImageResolution::OneK => "1K", + NanoBananaProEditImageResolution::TwoK => "2K", + NanoBananaProEditImageResolution::FourK => "4K", + }.to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + NanoBananaProEditImageAspectRatio::Auto => "auto", + NanoBananaProEditImageAspectRatio::OneByOne => "1:1", + NanoBananaProEditImageAspectRatio::FiveByFour => "5:4", + NanoBananaProEditImageAspectRatio::FourByThree => "4:3", + NanoBananaProEditImageAspectRatio::ThreeByTwo => "3:2", + NanoBananaProEditImageAspectRatio::SixteenByNine => "16:9", + NanoBananaProEditImageAspectRatio::TwentyOneByNine => "21:9", + NanoBananaProEditImageAspectRatio::FourByFive => "4:5", + NanoBananaProEditImageAspectRatio::ThreeByFour => "3:4", + NanoBananaProEditImageAspectRatio::TwoByThree => "2:3", + NanoBananaProEditImageAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + num_images: Some(num_images), + aspect_ratio, + resolution, + output_format: Some("png".to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ + ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL, + }; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_edit_multi_image_spooky() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = NanoBananaProEditImageRequest { + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + num_images: NanoBananaProEditImageNumImages::Two, + resolution: Some(NanoBananaProEditImageResolution::TwoK), + aspect_ratio: Some(NanoBananaProEditImageAspectRatio::SixteenByNine), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/cost.rs new file mode 100644 index 00000000..550cc663 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/cost.rs @@ -0,0 +1,73 @@ +use crate::requests::api::image::edit::nano_banana_pro_edit_image::api::{ + NanoBananaProEditImageNumImages, NanoBananaProEditImageRequest, + NanoBananaProEditImageResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for NanoBananaProEditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.15 per image. + // 4K outputs will be charged at double the standard rate. + let base_cost = match self.resolution { + None => 15, + Some(NanoBananaProEditImageResolution::OneK) => 15, + Some(NanoBananaProEditImageResolution::TwoK) => 15, + Some(NanoBananaProEditImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + NanoBananaProEditImageNumImages::One => base_cost, + NanoBananaProEditImageNumImages::Two => base_cost * 2, + NanoBananaProEditImageNumImages::Three => base_cost * 3, + NanoBananaProEditImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: NanoBananaProEditImageNumImages, + resolution: Option, + ) -> NanoBananaProEditImageRequest { + NanoBananaProEditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.jpg".to_string()], + num_images, + resolution, + aspect_ratio: None, + } + } + + #[test] + fn cost_default_resolution_one_image() { + assert_eq!(make_request(NanoBananaProEditImageNumImages::One, None).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_one_k_one_image() { + assert_eq!(make_request(NanoBananaProEditImageNumImages::One, Some(NanoBananaProEditImageResolution::OneK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_two_k_one_image() { + assert_eq!(make_request(NanoBananaProEditImageNumImages::One, Some(NanoBananaProEditImageResolution::TwoK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_four_k_one_image() { + assert_eq!(make_request(NanoBananaProEditImageNumImages::One, Some(NanoBananaProEditImageResolution::FourK)).calculate_cost_in_cents(), 30); + } + + #[test] + fn cost_one_k_four_images() { + assert_eq!(make_request(NanoBananaProEditImageNumImages::Four, Some(NanoBananaProEditImageResolution::OneK)).calculate_cost_in_cents(), 60); + } + + #[test] + fn cost_four_k_two_images() { + assert_eq!(make_request(NanoBananaProEditImageNumImages::Two, Some(NanoBananaProEditImageResolution::FourK)).calculate_cost_in_cents(), 60); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/raw_request.rs new file mode 100644 index 00000000..8f4dcb63 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/edit/nano_banana_pro_edit_image/raw_request.rs @@ -0,0 +1,38 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBananaProEditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Eg. "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProEditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProEditImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/mod.rs new file mode 100644 index 00000000..21fe362b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/mod.rs @@ -0,0 +1,5 @@ +pub mod angle; +pub mod background; +pub mod common; +pub mod edit; +pub mod text; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/api.rs new file mode 100644 index 00000000..5c6a488a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/api.rs @@ -0,0 +1,97 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::text::flux_1_dev_text_to_image::raw_request::{ + Flux1DevTextToImageInput, Flux1DevTextToImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Flux1DevTextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Aspect ratio / image size. + pub aspect_ratio: Flux1DevTextToImageAspectRatio, + + /// Number of images to generate. + pub num_images: Flux1DevTextToImageNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1DevTextToImageAspectRatio { + Square, + SquareHd, + LandscapeFourByThree, + LandscapeSixteenByNine, + PortraitThreeByFour, + PortraitNineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1DevTextToImageNumImages { + One, + Two, + Three, + Four, +} + +impl FalEndpoint for Flux1DevTextToImageRequest { + const ENDPOINT: &str = "fal-ai/flux/dev"; + + type RawRequest = Flux1DevTextToImageInput; + type RawResponse = Flux1DevTextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + Flux1DevTextToImageNumImages::One => 1, + Flux1DevTextToImageNumImages::Two => 2, + Flux1DevTextToImageNumImages::Three => 3, + Flux1DevTextToImageNumImages::Four => 4, + }; + + let image_size = match self.aspect_ratio { + Flux1DevTextToImageAspectRatio::Square => "square", + Flux1DevTextToImageAspectRatio::SquareHd => "square_hd", + Flux1DevTextToImageAspectRatio::LandscapeFourByThree => "landscape_4_3", + Flux1DevTextToImageAspectRatio::LandscapeSixteenByNine => "landscape_16_9", + Flux1DevTextToImageAspectRatio::PortraitThreeByFour => "portrait_4_3", + Flux1DevTextToImageAspectRatio::PortraitNineBySixteen => "portrait_16_9", + }; + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + image_size: Some(image_size.to_string()), + enable_safety_checker: Some(false), + ..Default::default() + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux1DevTextToImageRequest { + prompt: "a giant robot fighting a dragon in a futuristic city".to_string(), + num_images: Flux1DevTextToImageNumImages::One, + aspect_ratio: Flux1DevTextToImageAspectRatio::LandscapeFourByThree, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/cost.rs new file mode 100644 index 00000000..3fd7ab51 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/cost.rs @@ -0,0 +1,52 @@ +use crate::requests::api::image::text::flux_1_dev_text_to_image::api::{ + Flux1DevTextToImageAspectRatio, Flux1DevTextToImageNumImages, Flux1DevTextToImageRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Flux1DevTextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.025 per megapixel. + // For a 1024x1024 image (~1 MP), that's ~3 cents per image. + let unit_cost = 3; + let cost = match self.num_images { + Flux1DevTextToImageNumImages::One => unit_cost, + Flux1DevTextToImageNumImages::Two => unit_cost * 2, + Flux1DevTextToImageNumImages::Three => unit_cost * 3, + Flux1DevTextToImageNumImages::Four => unit_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request(num_images: Flux1DevTextToImageNumImages) -> Flux1DevTextToImageRequest { + Flux1DevTextToImageRequest { + prompt: "test".to_string(), + aspect_ratio: Flux1DevTextToImageAspectRatio::Square, + num_images, + } + } + + #[test] + fn cost_one_image() { + assert_eq!(make_request(Flux1DevTextToImageNumImages::One).calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_two_images() { + assert_eq!(make_request(Flux1DevTextToImageNumImages::Two).calculate_cost_in_cents(), 6); + } + + #[test] + fn cost_three_images() { + assert_eq!(make_request(Flux1DevTextToImageNumImages::Three).calculate_cost_in_cents(), 9); + } + + #[test] + fn cost_four_images() { + assert_eq!(make_request(Flux1DevTextToImageNumImages::Four).calculate_cost_in_cents(), 12); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/raw_request.rs new file mode 100644 index 00000000..b1b09171 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_dev_text_to_image/raw_request.rs @@ -0,0 +1,40 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1DevTextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevTextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/api.rs new file mode 100644 index 00000000..c6eef685 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/api.rs @@ -0,0 +1,97 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::text::flux_1_schnell_text_to_image::raw_request::{ + Flux1SchnellTextToImageInput, Flux1SchnellTextToImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Flux1SchnellTextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Aspect ratio / image size. + pub aspect_ratio: Flux1SchnellTextToImageAspectRatio, + + /// Number of images to generate. + pub num_images: Flux1SchnellTextToImageNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellTextToImageAspectRatio { + Square, + SquareHd, + LandscapeFourByThree, + LandscapeSixteenByNine, + PortraitThreeByFour, + PortraitNineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellTextToImageNumImages { + One, + Two, + Three, + Four, +} + +impl FalEndpoint for Flux1SchnellTextToImageRequest { + const ENDPOINT: &str = "fal-ai/flux/schnell"; + + type RawRequest = Flux1SchnellTextToImageInput; + type RawResponse = Flux1SchnellTextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + Flux1SchnellTextToImageNumImages::One => 1, + Flux1SchnellTextToImageNumImages::Two => 2, + Flux1SchnellTextToImageNumImages::Three => 3, + Flux1SchnellTextToImageNumImages::Four => 4, + }; + + let image_size = match self.aspect_ratio { + Flux1SchnellTextToImageAspectRatio::Square => "square", + Flux1SchnellTextToImageAspectRatio::SquareHd => "square_hd", + Flux1SchnellTextToImageAspectRatio::LandscapeFourByThree => "landscape_4_3", + Flux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine => "landscape_16_9", + Flux1SchnellTextToImageAspectRatio::PortraitThreeByFour => "portrait_4_3", + Flux1SchnellTextToImageAspectRatio::PortraitNineBySixteen => "portrait_16_9", + }; + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + image_size: Some(image_size.to_string()), + enable_safety_checker: Some(false), + ..Default::default() + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Flux1SchnellTextToImageRequest { + prompt: "a giant robot fighting a dragon in a futuristic city".to_string(), + num_images: Flux1SchnellTextToImageNumImages::One, + aspect_ratio: Flux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/cost.rs new file mode 100644 index 00000000..0b57d8ba --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/cost.rs @@ -0,0 +1,54 @@ +use crate::requests::api::image::text::flux_1_schnell_text_to_image::api::{ + Flux1SchnellTextToImageAspectRatio, Flux1SchnellTextToImageNumImages, + Flux1SchnellTextToImageRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Flux1SchnellTextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.003 per megapixel. + // For a 1024x1024 image (~1 MP), that's less than 1 cent per image. + // We round up to 1 cent per image. + let unit_cost = 1; + let cost = match self.num_images { + Flux1SchnellTextToImageNumImages::One => unit_cost, + Flux1SchnellTextToImageNumImages::Two => unit_cost * 2, + Flux1SchnellTextToImageNumImages::Three => unit_cost * 3, + Flux1SchnellTextToImageNumImages::Four => unit_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request(num_images: Flux1SchnellTextToImageNumImages) -> Flux1SchnellTextToImageRequest { + Flux1SchnellTextToImageRequest { + prompt: "test".to_string(), + aspect_ratio: Flux1SchnellTextToImageAspectRatio::Square, + num_images, + } + } + + #[test] + fn cost_one_image() { + assert_eq!(make_request(Flux1SchnellTextToImageNumImages::One).calculate_cost_in_cents(), 1); + } + + #[test] + fn cost_two_images() { + assert_eq!(make_request(Flux1SchnellTextToImageNumImages::Two).calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_three_images() { + assert_eq!(make_request(Flux1SchnellTextToImageNumImages::Three).calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_four_images() { + assert_eq!(make_request(Flux1SchnellTextToImageNumImages::Four).calculate_cost_in_cents(), 4); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/raw_request.rs new file mode 100644 index 00000000..312faa2e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/flux_1_schnell_text_to_image/raw_request.rs @@ -0,0 +1,37 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1SchnellTextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellTextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/api.rs new file mode 100644 index 00000000..9532d4f5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/api.rs @@ -0,0 +1,173 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::text::gpt_image_1_text_to_image::raw_request::{ + GptImage1TextToImageInput, GptImage1TextToImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct GptImage1TextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Number of images to generate. + pub num_images: GptImage1TextToImageNumImages, + + /// Output image size. + pub image_size: Option, + + /// Quality level. + pub quality: Option, + + /// Background mode. + pub background: Option, + + /// Output format. + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1TextToImageSize { + Auto, + /// 1024x1024 + Square, + /// 1536x1024 + Horizontal, + /// 1024x1536 + Vertical, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1TextToImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1TextToImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1TextToImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalEndpoint for GptImage1TextToImageRequest { + const ENDPOINT: &str = "fal-ai/gpt-image-1/text-to-image"; + + type RawRequest = GptImage1TextToImageInput; + type RawResponse = GptImage1TextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + GptImage1TextToImageNumImages::One => 1, + GptImage1TextToImageNumImages::Two => 2, + GptImage1TextToImageNumImages::Three => 3, + GptImage1TextToImageNumImages::Four => 4, + }; + + let image_size = self.image_size.map(|s| match s { + GptImage1TextToImageSize::Auto => "auto", + GptImage1TextToImageSize::Square => "1024x1024", + GptImage1TextToImageSize::Horizontal => "1536x1024", + GptImage1TextToImageSize::Vertical => "1024x1536", + }.to_string()); + + let quality = self.quality.map(|q| match q { + GptImage1TextToImageQuality::Low => "low", + GptImage1TextToImageQuality::Medium => "medium", + GptImage1TextToImageQuality::High => "high", + }.to_string()); + + let background = self.background.map(|b| match b { + GptImage1TextToImageBackground::Auto => "auto", + GptImage1TextToImageBackground::Transparent => "transparent", + GptImage1TextToImageBackground::Opaque => "opaque", + }.to_string()); + + let output_format = Some(match self.output_format { + Some(GptImage1TextToImageOutputFormat::Jpeg) => "jpeg", + Some(GptImage1TextToImageOutputFormat::Png) => "png", + Some(GptImage1TextToImageOutputFormat::Webp) => "webp", + None => "png", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + image_size, + quality, + background, + output_format, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: GptImage1TextToImageNumImages::One, + image_size: Some(GptImage1TextToImageSize::Horizontal), + quality: Some(GptImage1TextToImageQuality::Medium), + background: None, + output_format: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1TextToImageRequest { + prompt: "a corgi wearing sunglasses at the beach".to_string(), + num_images: GptImage1TextToImageNumImages::Two, + image_size: Some(GptImage1TextToImageSize::Square), + quality: Some(GptImage1TextToImageQuality::High), + background: Some(GptImage1TextToImageBackground::Opaque), + output_format: Some(GptImage1TextToImageOutputFormat::Png), + }; + + let result = request.send_webhook_request( + &api_key, + "https://example.com/webhook", + ).await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/cost.rs new file mode 100644 index 00000000..fce8ec7e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/cost.rs @@ -0,0 +1,179 @@ +use crate::requests::api::image::text::gpt_image_1_text_to_image::api::{ + GptImage1TextToImageNumImages, GptImage1TextToImageQuality, + GptImage1TextToImageRequest, GptImage1TextToImageSize, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for GptImage1TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Per fal docs (fal-ai/gpt-image-1/text-to-image): + // Low: $0.011 (1024x1024) / $0.016 (other) per image + // Medium: $0.042 (1024x1024) / $0.063 (other) per image + // High: $0.167 (1024x1024) / $0.25 (other) per image + // Default quality is Medium when unspecified, square when size unspecified. + let use_quality = self.quality.unwrap_or(GptImage1TextToImageQuality::Medium); + let is_square = matches!( + self.image_size, + None | Some(GptImage1TextToImageSize::Square) | Some(GptImage1TextToImageSize::Auto) + ); + + let base_cost: u64 = match (use_quality, is_square) { + (GptImage1TextToImageQuality::Low, true) => 2, + (GptImage1TextToImageQuality::Low, false) => 2, + (GptImage1TextToImageQuality::Medium, true) => 5, + (GptImage1TextToImageQuality::Medium, false) => 7, + (GptImage1TextToImageQuality::High, true) => 17, + (GptImage1TextToImageQuality::High, false) => 25, + }; + + let n: u64 = match self.num_images { + GptImage1TextToImageNumImages::One => 1, + GptImage1TextToImageNumImages::Two => 2, + GptImage1TextToImageNumImages::Three => 3, + GptImage1TextToImageNumImages::Four => 4, + }; + base_cost * n + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: GptImage1TextToImageNumImages, + quality: Option, + image_size: Option, + ) -> GptImage1TextToImageRequest { + GptImage1TextToImageRequest { + prompt: "test".to_string(), + num_images, + image_size, + quality, + background: None, + output_format: None, + } + } + + mod default_tests { + use super::*; + + #[test] + fn cost_defaults_one_image() { + // Default quality=Medium, size=Square => 5 cents + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, None, None) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_defaults_four_images() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::Four, None, None) + .calculate_cost_in_cents(), 20); + } + } + + mod low_quality_tests { + use super::*; + + #[test] + fn cost_low_square_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Square)) + .calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_low_horizontal_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Horizontal)) + .calculate_cost_in_cents(), 2); + } + + #[test] + fn cost_low_auto_four_images() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::Four, Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Auto)) + .calculate_cost_in_cents(), 8); + } + } + + mod medium_quality_tests { + use super::*; + + #[test] + fn cost_medium_square_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Square)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_auto_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Auto)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_horizontal_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Horizontal)) + .calculate_cost_in_cents(), 7); + } + + #[test] + fn cost_medium_vertical_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Vertical)) + .calculate_cost_in_cents(), 7); + } + + #[test] + fn cost_medium_horizontal_three_images() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::Three, Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Horizontal)) + .calculate_cost_in_cents(), 21); + } + } + + mod high_quality_tests { + use super::*; + + #[test] + fn cost_high_square_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Square)) + .calculate_cost_in_cents(), 17); + } + + #[test] + fn cost_high_horizontal_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Horizontal)) + .calculate_cost_in_cents(), 25); + } + + #[test] + fn cost_high_vertical_one_image() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::One, Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Vertical)) + .calculate_cost_in_cents(), 25); + } + + #[test] + fn cost_high_square_two_images() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::Two, Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Square)) + .calculate_cost_in_cents(), 34); + } + + #[test] + fn cost_high_vertical_four_images() { + assert_eq!( + make_request(GptImage1TextToImageNumImages::Four, Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Vertical)) + .calculate_cost_in_cents(), 100); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/raw_request.rs new file mode 100644 index 00000000..58eb9160 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1_text_to_image/raw_request.rs @@ -0,0 +1,38 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1TextToImageInput { + pub prompt: String, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1TextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/api.rs new file mode 100644 index 00000000..09d74343 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/api.rs @@ -0,0 +1,171 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::text::gpt_image_1p5_text_to_image::raw_request::{ + GptImage1p5TextToImageInput, GptImage1p5TextToImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct GptImage1p5TextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Number of images to generate. + pub num_images: GptImage1p5TextToImageNumImages, + + /// Output image size. + pub image_size: Option, + + /// Background mode. + pub background: Option, + + /// Quality level. + pub quality: Option, + + /// Output format. + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5TextToImageSize { + /// 1024x1024 + Square, + /// 1536x1024 + Wide, + /// 1024x1536 + Tall, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5TextToImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5TextToImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage1p5TextToImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalEndpoint for GptImage1p5TextToImageRequest { + const ENDPOINT: &str = "fal-ai/gpt-image-1.5"; + + type RawRequest = GptImage1p5TextToImageInput; + type RawResponse = GptImage1p5TextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + GptImage1p5TextToImageNumImages::One => 1, + GptImage1p5TextToImageNumImages::Two => 2, + GptImage1p5TextToImageNumImages::Three => 3, + GptImage1p5TextToImageNumImages::Four => 4, + }; + + let image_size = self.image_size.map(|s| match s { + GptImage1p5TextToImageSize::Square => "1024x1024", + GptImage1p5TextToImageSize::Wide => "1536x1024", + GptImage1p5TextToImageSize::Tall => "1024x1536", + }.to_string()); + + let background = self.background.map(|b| match b { + GptImage1p5TextToImageBackground::Auto => "auto", + GptImage1p5TextToImageBackground::Transparent => "transparent", + GptImage1p5TextToImageBackground::Opaque => "opaque", + }.to_string()); + + let quality = self.quality.map(|q| match q { + GptImage1p5TextToImageQuality::Low => "low", + GptImage1p5TextToImageQuality::Medium => "medium", + GptImage1p5TextToImageQuality::High => "high", + }.to_string()); + + let output_format = Some(match self.output_format { + Some(GptImage1p5TextToImageOutputFormat::Jpeg) => "jpeg", + Some(GptImage1p5TextToImageOutputFormat::Png) => "png", + Some(GptImage1p5TextToImageOutputFormat::Webp) => "webp", + None => "png", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + image_size, + background, + quality, + output_format, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1p5TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: GptImage1p5TextToImageNumImages::One, + image_size: None, + background: None, + quality: None, + output_format: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage1p5TextToImageRequest { + prompt: "a corgi wearing sunglasses at the beach".to_string(), + num_images: GptImage1p5TextToImageNumImages::Two, + image_size: Some(GptImage1p5TextToImageSize::Wide), + background: None, + quality: Some(GptImage1p5TextToImageQuality::High), + output_format: Some(GptImage1p5TextToImageOutputFormat::Png), + }; + + let result = request.send_webhook_request( + &api_key, + "https://example.com/webhook", + ).await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/cost.rs new file mode 100644 index 00000000..be31d8f3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/cost.rs @@ -0,0 +1,168 @@ +use crate::requests::api::image::text::gpt_image_1p5_text_to_image::api::{ + GptImage1p5TextToImageNumImages, GptImage1p5TextToImageQuality, + GptImage1p5TextToImageRequest, GptImage1p5TextToImageSize, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for GptImage1p5TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Per fal docs (fal-ai/gpt-image-1.5): + // Low: $0.009 (1024x1024) / $0.013 (other) per image + // Medium: $0.034 (1024x1024) / $0.050-$0.051 (other) per image + // High: $0.133 (1024x1024) / $0.199-$0.200 (other) per image + let use_quality = self.quality.unwrap_or(GptImage1p5TextToImageQuality::Medium); + let use_size = self.image_size.unwrap_or(GptImage1p5TextToImageSize::Square); + + let base_cost = match (use_quality, use_size) { + (GptImage1p5TextToImageQuality::Low, GptImage1p5TextToImageSize::Square) => 1, + (GptImage1p5TextToImageQuality::Low, _) => 1, + (GptImage1p5TextToImageQuality::Medium, GptImage1p5TextToImageSize::Square) => 3, + (GptImage1p5TextToImageQuality::Medium, _) => 5, + (GptImage1p5TextToImageQuality::High, GptImage1p5TextToImageSize::Square) => 13, + (GptImage1p5TextToImageQuality::High, _) => 20, + }; + + let cost = match self.num_images { + GptImage1p5TextToImageNumImages::One => base_cost, + GptImage1p5TextToImageNumImages::Two => base_cost * 2, + GptImage1p5TextToImageNumImages::Three => base_cost * 3, + GptImage1p5TextToImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: GptImage1p5TextToImageNumImages, + quality: Option, + image_size: Option, + ) -> GptImage1p5TextToImageRequest { + GptImage1p5TextToImageRequest { + prompt: "test".to_string(), + num_images, + image_size, + background: None, + quality, + output_format: None, + } + } + + mod default_tests { + use super::*; + + #[test] + fn cost_defaults_one_image() { + // Default quality=Medium, size=Square => 3 cents + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, None, None) + .calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_defaults_four_images() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::Four, None, None) + .calculate_cost_in_cents(), 12); + } + } + + mod low_quality_tests { + use super::*; + + #[test] + fn cost_low_square_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::Low), Some(GptImage1p5TextToImageSize::Square)) + .calculate_cost_in_cents(), 1); + } + + #[test] + fn cost_low_wide_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::Low), Some(GptImage1p5TextToImageSize::Wide)) + .calculate_cost_in_cents(), 1); + } + + #[test] + fn cost_low_tall_four_images() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::Four, Some(GptImage1p5TextToImageQuality::Low), Some(GptImage1p5TextToImageSize::Tall)) + .calculate_cost_in_cents(), 4); + } + } + + mod medium_quality_tests { + use super::*; + + #[test] + fn cost_medium_square_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Square)) + .calculate_cost_in_cents(), 3); + } + + #[test] + fn cost_medium_wide_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Wide)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_tall_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Tall)) + .calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_medium_square_three_images() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::Three, Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Square)) + .calculate_cost_in_cents(), 9); + } + } + + mod high_quality_tests { + use super::*; + + #[test] + fn cost_high_square_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Square)) + .calculate_cost_in_cents(), 13); + } + + #[test] + fn cost_high_wide_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Wide)) + .calculate_cost_in_cents(), 20); + } + + #[test] + fn cost_high_tall_one_image() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::One, Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Tall)) + .calculate_cost_in_cents(), 20); + } + + #[test] + fn cost_high_square_two_images() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::Two, Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Square)) + .calculate_cost_in_cents(), 26); + } + + #[test] + fn cost_high_wide_four_images() { + assert_eq!( + make_request(GptImage1p5TextToImageNumImages::Four, Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Wide)) + .calculate_cost_in_cents(), 80); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/raw_request.rs new file mode 100644 index 00000000..b02a4407 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_1p5_text_to_image/raw_request.rs @@ -0,0 +1,38 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1p5TextToImageInput { + pub prompt: String, + + /// "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5TextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/api.rs new file mode 100644 index 00000000..348f3616 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/api.rs @@ -0,0 +1,330 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::common::gpt_image_2_resolution::{ + compute_custom_image_size, GptImage2AspectRatio, GptImage2Resolution, +}; +use crate::requests::api::image::text::gpt_image_2_text_to_image::raw_request::{ + GptImage2TextToImageInput, GptImage2TextToImageOutput, ImageSizeParam, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct GptImage2TextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Number of images to generate. + pub num_images: GptImage2TextToImageNumImages, + + /// Output image size (aspect ratio preset). + pub image_size: Option, + + /// Optional resolution tier. When present, a custom width x height is + /// computed from the aspect ratio and this resolution, overriding the + /// standard preset dimensions. + pub resolution: Option, + + /// Quality level. + pub quality: Option, + + /// Output format. + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2TextToImageSize { + SquareHd, + Square, + Portrait4x3, + Portrait16x9, + Landscape4x3, + Landscape16x9, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2TextToImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptImage2TextToImageOutputFormat { + Jpeg, + Png, + Webp, +} + +/// Map our image_size enum to the GptImage2AspectRatio used by the resolution +/// calculator. +fn size_to_aspect(size: GptImage2TextToImageSize) -> GptImage2AspectRatio { + match size { + GptImage2TextToImageSize::Square => GptImage2AspectRatio::Square, + GptImage2TextToImageSize::SquareHd => GptImage2AspectRatio::SquareHd, + GptImage2TextToImageSize::Landscape4x3 => GptImage2AspectRatio::Landscape4x3, + GptImage2TextToImageSize::Landscape16x9 => GptImage2AspectRatio::Landscape16x9, + GptImage2TextToImageSize::Portrait4x3 => GptImage2AspectRatio::Portrait4x3, + GptImage2TextToImageSize::Portrait16x9 => GptImage2AspectRatio::Portrait16x9, + } +} + +impl FalEndpoint for GptImage2TextToImageRequest { + const ENDPOINT: &str = "openai/gpt-image-2"; + + type RawRequest = GptImage2TextToImageInput; + type RawResponse = GptImage2TextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + GptImage2TextToImageNumImages::One => 1, + GptImage2TextToImageNumImages::Two => 2, + GptImage2TextToImageNumImages::Three => 3, + GptImage2TextToImageNumImages::Four => 4, + }; + + let image_size = match (self.image_size, self.resolution) { + // Resolution present: compute custom dimensions from aspect + resolution + (Some(size), Some(resolution)) => { + let aspect = size_to_aspect(size); + let custom = compute_custom_image_size(aspect, resolution); + Some(ImageSizeParam::Custom(custom)) + } + // Resolution present but no image_size: default to Square + (None, Some(resolution)) => { + let custom = compute_custom_image_size(GptImage2AspectRatio::Square, resolution); + Some(ImageSizeParam::Custom(custom)) + } + // No resolution: use the standard preset string + (Some(size), None) => { + let preset = match size { + GptImage2TextToImageSize::SquareHd => "square_hd", + GptImage2TextToImageSize::Square => "square", + GptImage2TextToImageSize::Portrait4x3 => "portrait_4_3", + GptImage2TextToImageSize::Portrait16x9 => "portrait_16_9", + GptImage2TextToImageSize::Landscape4x3 => "landscape_4_3", + GptImage2TextToImageSize::Landscape16x9 => "landscape_16_9", + }; + Some(ImageSizeParam::Preset(preset.to_string())) + } + // Neither: let the API default + (None, None) => None, + }; + + let quality = self.quality.map(|q| match q { + GptImage2TextToImageQuality::Low => "low", + GptImage2TextToImageQuality::Medium => "medium", + GptImage2TextToImageQuality::High => "high", + }.to_string()); + + let output_format = Some(match self.output_format { + Some(GptImage2TextToImageOutputFormat::Jpeg) => "jpeg", + Some(GptImage2TextToImageOutputFormat::Png) => "png", + Some(GptImage2TextToImageOutputFormat::Webp) => "webp", + None => "png", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + image_size, + quality, + output_format, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::api::image::common::gpt_image_2_resolution::GptImage2Resolution; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage2TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: GptImage2TextToImageNumImages::One, + image_size: None, + resolution: None, + quality: None, + output_format: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = GptImage2TextToImageRequest { + prompt: "a corgi wearing sunglasses at the beach".to_string(), + num_images: GptImage2TextToImageNumImages::Two, + image_size: Some(GptImage2TextToImageSize::Landscape16x9), + resolution: None, + quality: Some(GptImage2TextToImageQuality::High), + output_format: Some(GptImage2TextToImageOutputFormat::Png), + }; + + let result = request.send_webhook_request( + &api_key, + "https://example.com/webhook", + ).await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + /// Combinatorial test: every (image_size, resolution) pair. + /// The prompt embeds the test parameters so the output image documents + /// which combination was used. + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_combinatorial_size_and_resolution() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let sizes = [ + ("square", GptImage2TextToImageSize::Square), + ("square_hd", GptImage2TextToImageSize::SquareHd), + ("landscape_4x3", GptImage2TextToImageSize::Landscape4x3), + ("landscape_16x9", GptImage2TextToImageSize::Landscape16x9), + ("portrait_4x3", GptImage2TextToImageSize::Portrait4x3), + ("portrait_16x9", GptImage2TextToImageSize::Portrait16x9), + ]; + + let resolutions = [ + ("1K", GptImage2Resolution::OneK), + ("2K", GptImage2Resolution::TwoK), + ("3K", GptImage2Resolution::ThreeK), + ("4K", GptImage2Resolution::FourK), + ]; + + let surfaces = ["t-shirt", "sign", "monitor", "billboard", "coffee mug", "poster"]; + let mut surface_idx = 0; + + for (size_name, size) in &sizes { + for (res_name, resolution) in &resolutions { + let surface = surfaces[surface_idx % surfaces.len()]; + surface_idx += 1; + + let prompt = format!( + "A photorealistic {} with the text \"{} {}\" printed on it, studio lighting, white background", + surface, size_name, res_name, + ); + + let request = GptImage2TextToImageRequest { + prompt, + num_images: GptImage2TextToImageNumImages::One, + image_size: Some(*size), + resolution: Some(*resolution), + quality: Some(GptImage2TextToImageQuality::Medium), + output_format: Some(GptImage2TextToImageOutputFormat::Png), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("[{} + {}] Request ID: {}", size_name, res_name, result.request_id); + assert!(!result.request_id.is_empty()); + } + } + + Ok(()) + } + + mod to_raw_request_tests { + use super::*; + use crate::requests::api::image::text::gpt_image_2_text_to_image::raw_request::ImageSizeParam; + + #[test] + fn preset_without_resolution() { + let request = GptImage2TextToImageRequest { + prompt: "test".to_string(), + num_images: GptImage2TextToImageNumImages::One, + image_size: Some(GptImage2TextToImageSize::Square), + resolution: None, + quality: None, + output_format: None, + }; + let raw = request.to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Preset(s) => assert_eq!(s, "square"), + ImageSizeParam::Custom(_) => panic!("expected preset"), + } + } + + #[test] + fn custom_with_resolution() { + let request = GptImage2TextToImageRequest { + prompt: "test".to_string(), + num_images: GptImage2TextToImageNumImages::One, + image_size: Some(GptImage2TextToImageSize::Landscape16x9), + resolution: Some(GptImage2Resolution::TwoK), + quality: None, + output_format: None, + }; + let raw = request.to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Custom(c) => { + assert_eq!(c.width, 2048); + assert_eq!(c.height, 1152); + } + ImageSizeParam::Preset(_) => panic!("expected custom"), + } + } + + #[test] + fn resolution_without_image_size_defaults_to_square() { + let request = GptImage2TextToImageRequest { + prompt: "test".to_string(), + num_images: GptImage2TextToImageNumImages::One, + image_size: None, + resolution: Some(GptImage2Resolution::TwoK), + quality: None, + output_format: None, + }; + let raw = request.to_raw_request().unwrap(); + match raw.image_size.unwrap() { + ImageSizeParam::Custom(c) => { + assert_eq!(c.width, 2048); + assert_eq!(c.height, 2048); + } + ImageSizeParam::Preset(_) => panic!("expected custom"), + } + } + + #[test] + fn neither_size_nor_resolution() { + let request = GptImage2TextToImageRequest { + prompt: "test".to_string(), + num_images: GptImage2TextToImageNumImages::One, + image_size: None, + resolution: None, + quality: None, + output_format: None, + }; + let raw = request.to_raw_request().unwrap(); + assert!(raw.image_size.is_none()); + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/cost.rs new file mode 100644 index 00000000..a673f446 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/cost.rs @@ -0,0 +1,423 @@ +use crate::requests::api::image::common::gpt_image_2_resolution::{ + compute_custom_image_size, GptImage2AspectRatio, GptImage2Resolution, +}; +use crate::requests::api::image::text::gpt_image_2_text_to_image::api::{ + GptImage2TextToImageNumImages, GptImage2TextToImageQuality, + GptImage2TextToImageRequest, GptImage2TextToImageSize, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for GptImage2TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + let quality = self.quality.unwrap_or(GptImage2TextToImageQuality::High); + let total_pixels = estimate_total_pixels(self.image_size, self.resolution); + let megapixels = total_pixels as f64 / 1_000_000.0; + + // Fal's GPT Image 2 text-to-image pricing has two components: + // + // 1. A base request cost (prompt processing, API overhead) + // 2. A per-pixel generation cost that scales with output resolution + // + // Both components increase with quality level. All rates are in + // tenths of a US cent, derived from Fal's published pricing. + // + // The base cost dominates at small resolutions (~1K); the per-pixel + // cost dominates at large resolutions (~4K). + let (base_tenths, per_megapixel_tenths): (f64, f64) = match quality { + GptImage2TextToImageQuality::Low => ( 8.0, 1.5), + GptImage2TextToImageQuality::Medium => (35.0, 9.5), + GptImage2TextToImageQuality::High => (120.0, 35.0), + }; + + let tenths_per_image = (base_tenths + per_megapixel_tenths * megapixels).ceil() as u64; + let cents_per_image = tenths_per_image.div_ceil(10); + let num = num_images_u64(self.num_images); + + cents_per_image * num + } +} + +fn estimate_total_pixels( + image_size: Option, + resolution: Option, +) -> u64 { + match (image_size, resolution) { + (Some(size), Some(res)) => { + let aspect = size_to_aspect(size); + let dims = compute_custom_image_size(aspect, res); + dims.width as u64 * dims.height as u64 + } + (None, Some(res)) => { + let dims = compute_custom_image_size(GptImage2AspectRatio::Square, res); + dims.width as u64 * dims.height as u64 + } + (Some(size), None) => preset_pixel_count(size), + (None, None) => preset_pixel_count(GptImage2TextToImageSize::Square), + } +} + +fn size_to_aspect(size: GptImage2TextToImageSize) -> GptImage2AspectRatio { + match size { + GptImage2TextToImageSize::Square => GptImage2AspectRatio::Square, + GptImage2TextToImageSize::SquareHd => GptImage2AspectRatio::SquareHd, + GptImage2TextToImageSize::Landscape4x3 => GptImage2AspectRatio::Landscape4x3, + GptImage2TextToImageSize::Landscape16x9 => GptImage2AspectRatio::Landscape16x9, + GptImage2TextToImageSize::Portrait4x3 => GptImage2AspectRatio::Portrait4x3, + GptImage2TextToImageSize::Portrait16x9 => GptImage2AspectRatio::Portrait16x9, + } +} + +/// Standard preset pixel counts when no custom resolution is specified. +fn preset_pixel_count(size: GptImage2TextToImageSize) -> u64 { + match size { + GptImage2TextToImageSize::Square => 1024 * 1024, // 1,048,576 + GptImage2TextToImageSize::SquareHd => 2048 * 2048, // 4,194,304 + GptImage2TextToImageSize::Landscape4x3 => 1024 * 768, // 786,432 + GptImage2TextToImageSize::Landscape16x9 => 1920 * 1080, // 2,073,600 + GptImage2TextToImageSize::Portrait4x3 => 768 * 1024, // 786,432 + GptImage2TextToImageSize::Portrait16x9 => 1080 * 1920, // 2,073,600 + } +} + +fn num_images_u64(num: GptImage2TextToImageNumImages) -> u64 { + match num { + GptImage2TextToImageNumImages::One => 1, + GptImage2TextToImageNumImages::Two => 2, + GptImage2TextToImageNumImages::Three => 3, + GptImage2TextToImageNumImages::Four => 4, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: GptImage2TextToImageNumImages, + quality: Option, + image_size: Option, + resolution: Option, + ) -> GptImage2TextToImageRequest { + GptImage2TextToImageRequest { + prompt: "test".to_string(), + num_images, + image_size, + resolution, + quality, + output_format: None, + } + } + + use GptImage2TextToImageNumImages::*; + use GptImage2TextToImageQuality::*; + use GptImage2TextToImageSize::*; + use GptImage2Resolution::*; + + mod preset_pricing_tests { + use super::*; + + // Table: (size, low, medium, high) — expected cents per image + const PRESET_CASES: &[(GptImage2TextToImageSize, u64, u64, u64)] = &[ + // Low Med High + (Landscape4x3, 1, 5, 15), + (Portrait4x3, 1, 5, 15), + (Square, 1, 5, 16), + (Landscape16x9, 2, 6, 20), + (Portrait16x9, 2, 6, 20), + (SquareHd, 2, 8, 27), + ]; + + #[test] + fn preset_costs_at_each_quality() { + for &(size, expected_low, expected_med, expected_high) in PRESET_CASES { + let cases = [ + (Low, expected_low), + (Medium, expected_med), + (High, expected_high), + ]; + for (quality, expected) in cases { + let actual = make_request(One, Some(quality), Some(size), None) + .calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {quality:?}"); + } + } + } + + #[test] + fn defaults_to_high_quality_square() { + assert_eq!( + make_request(One, None, None, None).calculate_cost_in_cents(), + 16, + ); + } + } + + mod custom_resolution_pricing_tests { + use super::*; + + // Table: (size, resolution, low, medium, high) — expected cents per image + const RESOLUTION_CASES: &[(GptImage2TextToImageSize, GptImage2Resolution, u64, u64, u64)] = &[ + // Square aspect + (Square, OneK, 1, 5, 16), + (Square, TwoK, 2, 8, 27), + (Square, ThreeK, 3, 12, 42), + (Square, FourK, 3, 12, 42), // capped at max pixels + + // SquareHd (same aspect as Square) + (SquareHd, OneK, 1, 5, 16), + (SquareHd, TwoK, 2, 8, 27), + (SquareHd, ThreeK, 3, 12, 42), + (SquareHd, FourK, 3, 12, 42), + + // Landscape 4:3 + (Landscape4x3, OneK, 1, 5, 15), + (Landscape4x3, TwoK, 2, 7, 24), + (Landscape4x3, ThreeK, 2, 11, 37), + (Landscape4x3, FourK, 3, 12, 41), + + // Landscape 16:9 + (Landscape16x9, OneK, 1, 5, 15), + (Landscape16x9, TwoK, 2, 6, 21), + (Landscape16x9, ThreeK, 2, 9, 31), + (Landscape16x9, FourK, 3, 12, 42), + + // Portrait 4:3 + (Portrait4x3, OneK, 1, 5, 15), + (Portrait4x3, TwoK, 2, 7, 24), + (Portrait4x3, ThreeK, 2, 11, 37), + (Portrait4x3, FourK, 3, 12, 41), + + // Portrait 16:9 + (Portrait16x9, OneK, 1, 5, 15), + (Portrait16x9, TwoK, 2, 6, 21), + (Portrait16x9, ThreeK, 2, 9, 31), + (Portrait16x9, FourK, 3, 12, 42), + ]; + + #[test] + fn resolution_costs_at_each_quality() { + for &(size, res, expected_low, expected_med, expected_high) in RESOLUTION_CASES { + let cases = [ + (Low, expected_low), + (Medium, expected_med), + (High, expected_high), + ]; + for (quality, expected) in cases { + let actual = make_request(One, Some(quality), Some(size), Some(res)) + .calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {res:?} {quality:?}"); + } + } + } + + #[test] + fn resolution_without_size_defaults_to_square() { + assert_eq!( + make_request(One, Some(High), None, Some(TwoK)).calculate_cost_in_cents(), + make_request(One, Some(High), Some(Square), Some(TwoK)).calculate_cost_in_cents(), + ); + } + } + + mod num_images_tests { + use super::*; + + const ALL_BATCH_SIZES: &[(GptImage2TextToImageNumImages, u64)] = &[ + (One, 1), (Two, 2), (Three, 3), (Four, 4), + ]; + + const ALL_SIZES: &[GptImage2TextToImageSize] = &[ + Square, SquareHd, Landscape4x3, Landscape16x9, Portrait4x3, Portrait16x9, + ]; + + const ALL_RESOLUTIONS: &[GptImage2Resolution] = &[OneK, TwoK, ThreeK, FourK]; + + #[test] + fn batch_scales_linearly_for_all_presets() { + for &size in ALL_SIZES { + let per_image = make_request(One, Some(High), Some(size), None) + .calculate_cost_in_cents(); + for &(num, n) in ALL_BATCH_SIZES { + let actual = make_request(num, Some(High), Some(size), None) + .calculate_cost_in_cents(); + assert_eq!(actual, per_image * n, "{size:?} x{n}"); + } + } + } + + #[test] + fn batch_scales_linearly_for_all_resolutions() { + for &size in ALL_SIZES { + for &res in ALL_RESOLUTIONS { + let per_image = make_request(One, Some(High), Some(size), Some(res)) + .calculate_cost_in_cents(); + for &(num, n) in ALL_BATCH_SIZES { + let actual = make_request(num, Some(High), Some(size), Some(res)) + .calculate_cost_in_cents(); + assert_eq!(actual, per_image * n, "{size:?} {res:?} x{n}"); + } + } + } + } + } + + mod exhaustive_preset_batch_tests { + use super::*; + + // (size, quality, num_images, expected_cents) + const CASES: &[(GptImage2TextToImageSize, GptImage2TextToImageQuality, GptImage2TextToImageNumImages, u64)] = &[ + (Square, Low, One, 1), (Square, Low, Two, 2), (Square, Low, Three, 3), (Square, Low, Four, 4), + (Square, Medium, One, 5), (Square, Medium, Two, 10), (Square, Medium, Three, 15), (Square, Medium, Four, 20), + (Square, High, One, 16), (Square, High, Two, 32), (Square, High, Three, 48), (Square, High, Four, 64), + (SquareHd, Low, One, 2), (SquareHd, Low, Two, 4), (SquareHd, Low, Three, 6), (SquareHd, Low, Four, 8), + (SquareHd, Medium, One, 8), (SquareHd, Medium, Two, 16), (SquareHd, Medium, Three, 24), (SquareHd, Medium, Four, 32), + (SquareHd, High, One, 27), (SquareHd, High, Two, 54), (SquareHd, High, Three, 81), (SquareHd, High, Four, 108), + (Landscape4x3, Low, One, 1), (Landscape4x3, Low, Two, 2), (Landscape4x3, Low, Three, 3), (Landscape4x3, Low, Four, 4), + (Landscape4x3, Medium, One, 5), (Landscape4x3, Medium, Two, 10), (Landscape4x3, Medium, Three, 15), (Landscape4x3, Medium, Four, 20), + (Landscape4x3, High, One, 15), (Landscape4x3, High, Two, 30), (Landscape4x3, High, Three, 45), (Landscape4x3, High, Four, 60), + (Landscape16x9, Low, One, 2), (Landscape16x9, Low, Two, 4), (Landscape16x9, Low, Three, 6), (Landscape16x9, Low, Four, 8), + (Landscape16x9, Medium, One, 6), (Landscape16x9, Medium, Two, 12), (Landscape16x9, Medium, Three, 18), (Landscape16x9, Medium, Four, 24), + (Landscape16x9, High, One, 20), (Landscape16x9, High, Two, 40), (Landscape16x9, High, Three, 60), (Landscape16x9, High, Four, 80), + (Portrait4x3, Low, One, 1), (Portrait4x3, Low, Two, 2), (Portrait4x3, Low, Three, 3), (Portrait4x3, Low, Four, 4), + (Portrait4x3, Medium, One, 5), (Portrait4x3, Medium, Two, 10), (Portrait4x3, Medium, Three, 15), (Portrait4x3, Medium, Four, 20), + (Portrait4x3, High, One, 15), (Portrait4x3, High, Two, 30), (Portrait4x3, High, Three, 45), (Portrait4x3, High, Four, 60), + (Portrait16x9, Low, One, 2), (Portrait16x9, Low, Two, 4), (Portrait16x9, Low, Three, 6), (Portrait16x9, Low, Four, 8), + (Portrait16x9, Medium, One, 6), (Portrait16x9, Medium, Two, 12), (Portrait16x9, Medium, Three, 18), (Portrait16x9, Medium, Four, 24), + (Portrait16x9, High, One, 20), (Portrait16x9, High, Two, 40), (Portrait16x9, High, Three, 60), (Portrait16x9, High, Four, 80), + ]; + + #[test] + fn all_preset_batch_costs() { + for &(size, quality, num, expected) in CASES { + let actual = make_request(num, Some(quality), Some(size), None).calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {quality:?} {num:?}"); + } + } + } + + mod exhaustive_resolution_batch_tests { + use super::*; + + // (size, resolution, quality, num_images, expected_cents) + const CASES: &[(GptImage2TextToImageSize, GptImage2Resolution, GptImage2TextToImageQuality, GptImage2TextToImageNumImages, u64)] = &[ + // Square + (Square, OneK, Low, One, 1), (Square, OneK, Low, Two, 2), (Square, OneK, Low, Three, 3), (Square, OneK, Low, Four, 4), + (Square, OneK, Medium, One, 5), (Square, OneK, Medium, Two, 10), (Square, OneK, Medium, Three, 15), (Square, OneK, Medium, Four, 20), + (Square, OneK, High, One, 16), (Square, OneK, High, Two, 32), (Square, OneK, High, Three, 48), (Square, OneK, High, Four, 64), + (Square, TwoK, Low, One, 2), (Square, TwoK, Low, Two, 4), (Square, TwoK, Low, Three, 6), (Square, TwoK, Low, Four, 8), + (Square, TwoK, Medium, One, 8), (Square, TwoK, Medium, Two, 16), (Square, TwoK, Medium, Three, 24), (Square, TwoK, Medium, Four, 32), + (Square, TwoK, High, One, 27), (Square, TwoK, High, Two, 54), (Square, TwoK, High, Three, 81), (Square, TwoK, High, Four, 108), + (Square, ThreeK, Low, One, 3), (Square, ThreeK, Low, Two, 6), (Square, ThreeK, Low, Three, 9), (Square, ThreeK, Low, Four, 12), + (Square, ThreeK, Medium, One, 12), (Square, ThreeK, Medium, Two, 24), (Square, ThreeK, Medium, Three, 36), (Square, ThreeK, Medium, Four, 48), + (Square, ThreeK, High, One, 42), (Square, ThreeK, High, Two, 84), (Square, ThreeK, High, Three, 126), (Square, ThreeK, High, Four, 168), + (Square, FourK, Low, One, 3), (Square, FourK, Low, Two, 6), (Square, FourK, Low, Three, 9), (Square, FourK, Low, Four, 12), + (Square, FourK, Medium, One, 12), (Square, FourK, Medium, Two, 24), (Square, FourK, Medium, Three, 36), (Square, FourK, Medium, Four, 48), + (Square, FourK, High, One, 42), (Square, FourK, High, Two, 84), (Square, FourK, High, Three, 126), (Square, FourK, High, Four, 168), + // SquareHd + (SquareHd, OneK, Low, One, 1), (SquareHd, OneK, Low, Two, 2), (SquareHd, OneK, Low, Three, 3), (SquareHd, OneK, Low, Four, 4), + (SquareHd, OneK, Medium, One, 5), (SquareHd, OneK, Medium, Two, 10), (SquareHd, OneK, Medium, Three, 15), (SquareHd, OneK, Medium, Four, 20), + (SquareHd, OneK, High, One, 16), (SquareHd, OneK, High, Two, 32), (SquareHd, OneK, High, Three, 48), (SquareHd, OneK, High, Four, 64), + (SquareHd, TwoK, Low, One, 2), (SquareHd, TwoK, Low, Two, 4), (SquareHd, TwoK, Low, Three, 6), (SquareHd, TwoK, Low, Four, 8), + (SquareHd, TwoK, Medium, One, 8), (SquareHd, TwoK, Medium, Two, 16), (SquareHd, TwoK, Medium, Three, 24), (SquareHd, TwoK, Medium, Four, 32), + (SquareHd, TwoK, High, One, 27), (SquareHd, TwoK, High, Two, 54), (SquareHd, TwoK, High, Three, 81), (SquareHd, TwoK, High, Four, 108), + (SquareHd, ThreeK, Low, One, 3), (SquareHd, ThreeK, Low, Two, 6), (SquareHd, ThreeK, Low, Three, 9), (SquareHd, ThreeK, Low, Four, 12), + (SquareHd, ThreeK, Medium, One, 12), (SquareHd, ThreeK, Medium, Two, 24), (SquareHd, ThreeK, Medium, Three, 36), (SquareHd, ThreeK, Medium, Four, 48), + (SquareHd, ThreeK, High, One, 42), (SquareHd, ThreeK, High, Two, 84), (SquareHd, ThreeK, High, Three, 126), (SquareHd, ThreeK, High, Four, 168), + (SquareHd, FourK, Low, One, 3), (SquareHd, FourK, Low, Two, 6), (SquareHd, FourK, Low, Three, 9), (SquareHd, FourK, Low, Four, 12), + (SquareHd, FourK, Medium, One, 12), (SquareHd, FourK, Medium, Two, 24), (SquareHd, FourK, Medium, Three, 36), (SquareHd, FourK, Medium, Four, 48), + (SquareHd, FourK, High, One, 42), (SquareHd, FourK, High, Two, 84), (SquareHd, FourK, High, Three, 126), (SquareHd, FourK, High, Four, 168), + // Landscape4x3 + (Landscape4x3, OneK, Low, One, 1), (Landscape4x3, OneK, Low, Two, 2), (Landscape4x3, OneK, Low, Three, 3), (Landscape4x3, OneK, Low, Four, 4), + (Landscape4x3, OneK, Medium, One, 5), (Landscape4x3, OneK, Medium, Two, 10), (Landscape4x3, OneK, Medium, Three, 15), (Landscape4x3, OneK, Medium, Four, 20), + (Landscape4x3, OneK, High, One, 15), (Landscape4x3, OneK, High, Two, 30), (Landscape4x3, OneK, High, Three, 45), (Landscape4x3, OneK, High, Four, 60), + (Landscape4x3, TwoK, Low, One, 2), (Landscape4x3, TwoK, Low, Two, 4), (Landscape4x3, TwoK, Low, Three, 6), (Landscape4x3, TwoK, Low, Four, 8), + (Landscape4x3, TwoK, Medium, One, 7), (Landscape4x3, TwoK, Medium, Two, 14), (Landscape4x3, TwoK, Medium, Three, 21), (Landscape4x3, TwoK, Medium, Four, 28), + (Landscape4x3, TwoK, High, One, 24), (Landscape4x3, TwoK, High, Two, 48), (Landscape4x3, TwoK, High, Three, 72), (Landscape4x3, TwoK, High, Four, 96), + (Landscape4x3, ThreeK, Low, One, 2), (Landscape4x3, ThreeK, Low, Two, 4), (Landscape4x3, ThreeK, Low, Three, 6), (Landscape4x3, ThreeK, Low, Four, 8), + (Landscape4x3, ThreeK, Medium, One, 11), (Landscape4x3, ThreeK, Medium, Two, 22), (Landscape4x3, ThreeK, Medium, Three, 33), (Landscape4x3, ThreeK, Medium, Four, 44), + (Landscape4x3, ThreeK, High, One, 37), (Landscape4x3, ThreeK, High, Two, 74), (Landscape4x3, ThreeK, High, Three, 111), (Landscape4x3, ThreeK, High, Four, 148), + (Landscape4x3, FourK, Low, One, 3), (Landscape4x3, FourK, Low, Two, 6), (Landscape4x3, FourK, Low, Three, 9), (Landscape4x3, FourK, Low, Four, 12), + (Landscape4x3, FourK, Medium, One, 12), (Landscape4x3, FourK, Medium, Two, 24), (Landscape4x3, FourK, Medium, Three, 36), (Landscape4x3, FourK, Medium, Four, 48), + (Landscape4x3, FourK, High, One, 41), (Landscape4x3, FourK, High, Two, 82), (Landscape4x3, FourK, High, Three, 123), (Landscape4x3, FourK, High, Four, 164), + // Landscape16x9 + (Landscape16x9, OneK, Low, One, 1), (Landscape16x9, OneK, Low, Two, 2), (Landscape16x9, OneK, Low, Three, 3), (Landscape16x9, OneK, Low, Four, 4), + (Landscape16x9, OneK, Medium, One, 5), (Landscape16x9, OneK, Medium, Two, 10), (Landscape16x9, OneK, Medium, Three, 15), (Landscape16x9, OneK, Medium, Four, 20), + (Landscape16x9, OneK, High, One, 15), (Landscape16x9, OneK, High, Two, 30), (Landscape16x9, OneK, High, Three, 45), (Landscape16x9, OneK, High, Four, 60), + (Landscape16x9, TwoK, Low, One, 2), (Landscape16x9, TwoK, Low, Two, 4), (Landscape16x9, TwoK, Low, Three, 6), (Landscape16x9, TwoK, Low, Four, 8), + (Landscape16x9, TwoK, Medium, One, 6), (Landscape16x9, TwoK, Medium, Two, 12), (Landscape16x9, TwoK, Medium, Three, 18), (Landscape16x9, TwoK, Medium, Four, 24), + (Landscape16x9, TwoK, High, One, 21), (Landscape16x9, TwoK, High, Two, 42), (Landscape16x9, TwoK, High, Three, 63), (Landscape16x9, TwoK, High, Four, 84), + (Landscape16x9, ThreeK, Low, One, 2), (Landscape16x9, ThreeK, Low, Two, 4), (Landscape16x9, ThreeK, Low, Three, 6), (Landscape16x9, ThreeK, Low, Four, 8), + (Landscape16x9, ThreeK, Medium, One, 9), (Landscape16x9, ThreeK, Medium, Two, 18), (Landscape16x9, ThreeK, Medium, Three, 27), (Landscape16x9, ThreeK, Medium, Four, 36), + (Landscape16x9, ThreeK, High, One, 31), (Landscape16x9, ThreeK, High, Two, 62), (Landscape16x9, ThreeK, High, Three, 93), (Landscape16x9, ThreeK, High, Four, 124), + (Landscape16x9, FourK, Low, One, 3), (Landscape16x9, FourK, Low, Two, 6), (Landscape16x9, FourK, Low, Three, 9), (Landscape16x9, FourK, Low, Four, 12), + (Landscape16x9, FourK, Medium, One, 12), (Landscape16x9, FourK, Medium, Two, 24), (Landscape16x9, FourK, Medium, Three, 36), (Landscape16x9, FourK, Medium, Four, 48), + (Landscape16x9, FourK, High, One, 42), (Landscape16x9, FourK, High, Two, 84), (Landscape16x9, FourK, High, Three, 126), (Landscape16x9, FourK, High, Four, 168), + // Portrait4x3 + (Portrait4x3, OneK, Low, One, 1), (Portrait4x3, OneK, Low, Two, 2), (Portrait4x3, OneK, Low, Three, 3), (Portrait4x3, OneK, Low, Four, 4), + (Portrait4x3, OneK, Medium, One, 5), (Portrait4x3, OneK, Medium, Two, 10), (Portrait4x3, OneK, Medium, Three, 15), (Portrait4x3, OneK, Medium, Four, 20), + (Portrait4x3, OneK, High, One, 15), (Portrait4x3, OneK, High, Two, 30), (Portrait4x3, OneK, High, Three, 45), (Portrait4x3, OneK, High, Four, 60), + (Portrait4x3, TwoK, Low, One, 2), (Portrait4x3, TwoK, Low, Two, 4), (Portrait4x3, TwoK, Low, Three, 6), (Portrait4x3, TwoK, Low, Four, 8), + (Portrait4x3, TwoK, Medium, One, 7), (Portrait4x3, TwoK, Medium, Two, 14), (Portrait4x3, TwoK, Medium, Three, 21), (Portrait4x3, TwoK, Medium, Four, 28), + (Portrait4x3, TwoK, High, One, 24), (Portrait4x3, TwoK, High, Two, 48), (Portrait4x3, TwoK, High, Three, 72), (Portrait4x3, TwoK, High, Four, 96), + (Portrait4x3, ThreeK, Low, One, 2), (Portrait4x3, ThreeK, Low, Two, 4), (Portrait4x3, ThreeK, Low, Three, 6), (Portrait4x3, ThreeK, Low, Four, 8), + (Portrait4x3, ThreeK, Medium, One, 11), (Portrait4x3, ThreeK, Medium, Two, 22), (Portrait4x3, ThreeK, Medium, Three, 33), (Portrait4x3, ThreeK, Medium, Four, 44), + (Portrait4x3, ThreeK, High, One, 37), (Portrait4x3, ThreeK, High, Two, 74), (Portrait4x3, ThreeK, High, Three, 111), (Portrait4x3, ThreeK, High, Four, 148), + (Portrait4x3, FourK, Low, One, 3), (Portrait4x3, FourK, Low, Two, 6), (Portrait4x3, FourK, Low, Three, 9), (Portrait4x3, FourK, Low, Four, 12), + (Portrait4x3, FourK, Medium, One, 12), (Portrait4x3, FourK, Medium, Two, 24), (Portrait4x3, FourK, Medium, Three, 36), (Portrait4x3, FourK, Medium, Four, 48), + (Portrait4x3, FourK, High, One, 41), (Portrait4x3, FourK, High, Two, 82), (Portrait4x3, FourK, High, Three, 123), (Portrait4x3, FourK, High, Four, 164), + // Portrait16x9 + (Portrait16x9, OneK, Low, One, 1), (Portrait16x9, OneK, Low, Two, 2), (Portrait16x9, OneK, Low, Three, 3), (Portrait16x9, OneK, Low, Four, 4), + (Portrait16x9, OneK, Medium, One, 5), (Portrait16x9, OneK, Medium, Two, 10), (Portrait16x9, OneK, Medium, Three, 15), (Portrait16x9, OneK, Medium, Four, 20), + (Portrait16x9, OneK, High, One, 15), (Portrait16x9, OneK, High, Two, 30), (Portrait16x9, OneK, High, Three, 45), (Portrait16x9, OneK, High, Four, 60), + (Portrait16x9, TwoK, Low, One, 2), (Portrait16x9, TwoK, Low, Two, 4), (Portrait16x9, TwoK, Low, Three, 6), (Portrait16x9, TwoK, Low, Four, 8), + (Portrait16x9, TwoK, Medium, One, 6), (Portrait16x9, TwoK, Medium, Two, 12), (Portrait16x9, TwoK, Medium, Three, 18), (Portrait16x9, TwoK, Medium, Four, 24), + (Portrait16x9, TwoK, High, One, 21), (Portrait16x9, TwoK, High, Two, 42), (Portrait16x9, TwoK, High, Three, 63), (Portrait16x9, TwoK, High, Four, 84), + (Portrait16x9, ThreeK, Low, One, 2), (Portrait16x9, ThreeK, Low, Two, 4), (Portrait16x9, ThreeK, Low, Three, 6), (Portrait16x9, ThreeK, Low, Four, 8), + (Portrait16x9, ThreeK, Medium, One, 9), (Portrait16x9, ThreeK, Medium, Two, 18), (Portrait16x9, ThreeK, Medium, Three, 27), (Portrait16x9, ThreeK, Medium, Four, 36), + (Portrait16x9, ThreeK, High, One, 31), (Portrait16x9, ThreeK, High, Two, 62), (Portrait16x9, ThreeK, High, Three, 93), (Portrait16x9, ThreeK, High, Four, 124), + (Portrait16x9, FourK, Low, One, 3), (Portrait16x9, FourK, Low, Two, 6), (Portrait16x9, FourK, Low, Three, 9), (Portrait16x9, FourK, Low, Four, 12), + (Portrait16x9, FourK, Medium, One, 12), (Portrait16x9, FourK, Medium, Two, 24), (Portrait16x9, FourK, Medium, Three, 36), (Portrait16x9, FourK, Medium, Four, 48), + (Portrait16x9, FourK, High, One, 42), (Portrait16x9, FourK, High, Two, 84), (Portrait16x9, FourK, High, Three, 126), (Portrait16x9, FourK, High, Four, 168), + ]; + + #[test] + fn all_resolution_batch_costs() { + for &(size, res, quality, num, expected) in CASES { + let actual = make_request(num, Some(quality), Some(size), Some(res)).calculate_cost_in_cents(); + assert_eq!(actual, expected, "{size:?} {res:?} {quality:?} {num:?}"); + } + } + } + + mod monotonicity_tests { + use super::*; + + #[test] + fn higher_quality_costs_more() { + for &size in &[Square, Landscape16x9, Portrait4x3] { + let low = make_request(One, Some(Low), Some(size), None).calculate_cost_in_cents(); + let med = make_request(One, Some(Medium), Some(size), None).calculate_cost_in_cents(); + let high = make_request(One, Some(High), Some(size), None).calculate_cost_in_cents(); + assert!(low <= med, "{size:?}: low ({low}) should be <= medium ({med})"); + assert!(med <= high, "{size:?}: medium ({med}) should be <= high ({high})"); + } + } + + #[test] + fn higher_resolution_costs_at_least_as_much() { + for &size in &[Square, Landscape16x9, Portrait4x3] { + let resolutions = [OneK, TwoK, ThreeK, FourK]; + for pair in resolutions.windows(2) { + let lower = make_request(One, Some(High), Some(size), Some(pair[0])) + .calculate_cost_in_cents(); + let higher = make_request(One, Some(High), Some(size), Some(pair[1])) + .calculate_cost_in_cents(); + assert!( + lower <= higher, + "{size:?}: {pair:?} — lower res ({lower}¢) should be <= higher res ({higher}¢)", + ); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/raw_request.rs new file mode 100644 index 00000000..56472bfa --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/gpt_image_2_text_to_image/raw_request.rs @@ -0,0 +1,45 @@ +use serde::{Deserialize, Serialize}; +use crate::requests::api::image::common::gpt_image_2_resolution::CustomImageSize; + +/// The `image_size` field can be either a string enum value (e.g. "square") +/// or a custom object with explicit width/height. +#[derive(Debug, Serialize, Deserialize, Clone)] +#[serde(untagged)] +pub enum ImageSizeParam { + Preset(String), + Custom(CustomImageSize), +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2TextToImageInput { + pub prompt: String, + + /// square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + /// OR a custom { width, height } object. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2TextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/mod.rs new file mode 100644 index 00000000..076ab1b3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/mod.rs @@ -0,0 +1,7 @@ +pub mod flux_1_dev_text_to_image; +pub mod flux_1_schnell_text_to_image; +pub mod gpt_image_1_text_to_image; +pub mod gpt_image_1p5_text_to_image; +pub mod gpt_image_2_text_to_image; +pub mod nano_banana_2_text_to_image; +pub mod nano_banana_pro_text_to_image; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/api.rs new file mode 100644 index 00000000..9a6f6133 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/api.rs @@ -0,0 +1,131 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::text::nano_banana_2_text_to_image::raw_request::{ + NanoBanana2TextToImageInput, NanoBanana2TextToImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct NanoBanana2TextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Number of images to generate. + pub num_images: NanoBanana2TextToImageNumImages, + + /// Output resolution. + pub resolution: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBanana2TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBanana2TextToImageResolution { + HalfK, // "0.5K" + OneK, // "1K" (default) + TwoK, // "2K" + FourK, // "4K" +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +#[derive(Copy, Clone, Debug)] +pub enum NanoBanana2TextToImageAspectRatio { + Auto, + OneByOne, + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + +impl FalEndpoint for NanoBanana2TextToImageRequest { + const ENDPOINT: &str = "fal-ai/nano-banana-2"; + + type RawRequest = NanoBanana2TextToImageInput; + type RawResponse = NanoBanana2TextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + NanoBanana2TextToImageNumImages::One => 1, + NanoBanana2TextToImageNumImages::Two => 2, + NanoBanana2TextToImageNumImages::Three => 3, + NanoBanana2TextToImageNumImages::Four => 4, + }; + + let resolution = self.resolution.map(|r| match r { + NanoBanana2TextToImageResolution::HalfK => "0.5K", + NanoBanana2TextToImageResolution::OneK => "1K", + NanoBanana2TextToImageResolution::TwoK => "2K", + NanoBanana2TextToImageResolution::FourK => "4K", + }.to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + NanoBanana2TextToImageAspectRatio::Auto => "auto", + NanoBanana2TextToImageAspectRatio::OneByOne => "1:1", + NanoBanana2TextToImageAspectRatio::FiveByFour => "5:4", + NanoBanana2TextToImageAspectRatio::FourByThree => "4:3", + NanoBanana2TextToImageAspectRatio::ThreeByTwo => "3:2", + NanoBanana2TextToImageAspectRatio::SixteenByNine => "16:9", + NanoBanana2TextToImageAspectRatio::TwentyOneByNine => "21:9", + NanoBanana2TextToImageAspectRatio::FourByFive => "4:5", + NanoBanana2TextToImageAspectRatio::ThreeByFour => "3:4", + NanoBanana2TextToImageAspectRatio::TwoByThree => "2:3", + NanoBanana2TextToImageAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + aspect_ratio, + resolution, + output_format: Some("png".to_string()), + safety_tolerance: Some("6".to_string()), + limit_generations: None, + enable_web_search: None, + seed: None, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = NanoBanana2TextToImageRequest { + prompt: "a corgi wearing sunglasses at the beach".to_string(), + num_images: NanoBanana2TextToImageNumImages::One, + resolution: Some(NanoBanana2TextToImageResolution::OneK), + aspect_ratio: Some(NanoBanana2TextToImageAspectRatio::SixteenByNine), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/cost.rs new file mode 100644 index 00000000..b14dae37 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/cost.rs @@ -0,0 +1,78 @@ +use crate::requests::api::image::text::nano_banana_2_text_to_image::api::{ + NanoBanana2TextToImageNumImages, NanoBanana2TextToImageRequest, + NanoBanana2TextToImageResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for NanoBanana2TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // TODO(bt): Verify actual pricing for Nano Banana 2 on fal.ai. + // 4K outputs may be charged at double the standard rate. + let base_cost = match self.resolution { + None => 15, + Some(NanoBanana2TextToImageResolution::HalfK) => 8, + Some(NanoBanana2TextToImageResolution::OneK) => 15, + Some(NanoBanana2TextToImageResolution::TwoK) => 15, + Some(NanoBanana2TextToImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + NanoBanana2TextToImageNumImages::One => base_cost, + NanoBanana2TextToImageNumImages::Two => base_cost * 2, + NanoBanana2TextToImageNumImages::Three => base_cost * 3, + NanoBanana2TextToImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: NanoBanana2TextToImageNumImages, + resolution: Option, + ) -> NanoBanana2TextToImageRequest { + NanoBanana2TextToImageRequest { + prompt: "test".to_string(), + num_images, + resolution, + aspect_ratio: None, + } + } + + #[test] + fn cost_default_resolution_one_image() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::One, None).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_half_k_one_image() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::One, Some(NanoBanana2TextToImageResolution::HalfK)).calculate_cost_in_cents(), 8); + } + + #[test] + fn cost_one_k_one_image() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::One, Some(NanoBanana2TextToImageResolution::OneK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_two_k_one_image() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::One, Some(NanoBanana2TextToImageResolution::TwoK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_four_k_one_image() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::One, Some(NanoBanana2TextToImageResolution::FourK)).calculate_cost_in_cents(), 30); + } + + #[test] + fn cost_one_k_four_images() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::Four, Some(NanoBanana2TextToImageResolution::OneK)).calculate_cost_in_cents(), 60); + } + + #[test] + fn cost_four_k_two_images() { + assert_eq!(make_request(NanoBanana2TextToImageNumImages::Two, Some(NanoBanana2TextToImageResolution::FourK)).calculate_cost_in_cents(), 60); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/raw_request.rs new file mode 100644 index 00000000..56d287ee --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_2_text_to_image/raw_request.rs @@ -0,0 +1,54 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBanana2TextToImageInput { + pub prompt: String, + + /// Eg. "auto", "16:9", "1:1", etc. + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Eg. "0.5K", "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// The safety tolerance level. 1 = most strict, 6 = least strict. + /// Default: "4" + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Limit generations per round of prompting to 1. + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub limit_generations: Option, + + /// Enable web search for image generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_web_search: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2ImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2TextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/api.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/api.rs new file mode 100644 index 00000000..5f97d64d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/api.rs @@ -0,0 +1,123 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::image::text::nano_banana_pro_text_to_image::raw_request::{ + NanoBananaProTextToImageInput, NanoBananaProTextToImageOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct NanoBananaProTextToImageRequest { + /// Text prompt describing the image to generate. + pub prompt: String, + + /// Number of images to generate. + pub num_images: NanoBananaProTextToImageNumImages, + + /// Output resolution. + pub resolution: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBananaProTextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum NanoBananaProTextToImageResolution { + OneK, + TwoK, + FourK, +} + +/// 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +#[derive(Copy, Clone, Debug)] +pub enum NanoBananaProTextToImageAspectRatio { + OneByOne, + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + +impl FalEndpoint for NanoBananaProTextToImageRequest { + const ENDPOINT: &str = "fal-ai/nano-banana-pro"; + + type RawRequest = NanoBananaProTextToImageInput; + type RawResponse = NanoBananaProTextToImageOutput; + + fn to_raw_request(&self) -> Result { + let num_images = match self.num_images { + NanoBananaProTextToImageNumImages::One => 1, + NanoBananaProTextToImageNumImages::Two => 2, + NanoBananaProTextToImageNumImages::Three => 3, + NanoBananaProTextToImageNumImages::Four => 4, + }; + + let resolution = self.resolution.map(|r| match r { + NanoBananaProTextToImageResolution::OneK => "1K", + NanoBananaProTextToImageResolution::TwoK => "2K", + NanoBananaProTextToImageResolution::FourK => "4K", + }.to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + NanoBananaProTextToImageAspectRatio::OneByOne => "1:1", + NanoBananaProTextToImageAspectRatio::FiveByFour => "5:4", + NanoBananaProTextToImageAspectRatio::FourByThree => "4:3", + NanoBananaProTextToImageAspectRatio::ThreeByTwo => "3:2", + NanoBananaProTextToImageAspectRatio::SixteenByNine => "16:9", + NanoBananaProTextToImageAspectRatio::TwentyOneByNine => "21:9", + NanoBananaProTextToImageAspectRatio::FourByFive => "4:5", + NanoBananaProTextToImageAspectRatio::ThreeByFour => "3:4", + NanoBananaProTextToImageAspectRatio::TwoByThree => "2:3", + NanoBananaProTextToImageAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + num_images: Some(num_images), + aspect_ratio, + resolution, + output_format: Some("png".to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually test — requires real API key, incurs costs + async fn test_text_to_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = NanoBananaProTextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: NanoBananaProTextToImageNumImages::One, + resolution: Some(NanoBananaProTextToImageResolution::TwoK), + aspect_ratio: Some(NanoBananaProTextToImageAspectRatio::SixteenByNine), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/test").await?; + println!("Request ID: {:?}", result.request_id); + assert!(result.request_id.is_some()); + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/cost.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/cost.rs new file mode 100644 index 00000000..deb93c2a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/cost.rs @@ -0,0 +1,72 @@ +use crate::requests::api::image::text::nano_banana_pro_text_to_image::api::{ + NanoBananaProTextToImageNumImages, NanoBananaProTextToImageRequest, + NanoBananaProTextToImageResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for NanoBananaProTextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.15 per image. + // 4K outputs will be charged at double the standard rate. + let base_cost = match self.resolution { + None => 15, + Some(NanoBananaProTextToImageResolution::OneK) => 15, + Some(NanoBananaProTextToImageResolution::TwoK) => 15, + Some(NanoBananaProTextToImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + NanoBananaProTextToImageNumImages::One => base_cost, + NanoBananaProTextToImageNumImages::Two => base_cost * 2, + NanoBananaProTextToImageNumImages::Three => base_cost * 3, + NanoBananaProTextToImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + num_images: NanoBananaProTextToImageNumImages, + resolution: Option, + ) -> NanoBananaProTextToImageRequest { + NanoBananaProTextToImageRequest { + prompt: "test".to_string(), + num_images, + resolution, + aspect_ratio: None, + } + } + + #[test] + fn cost_default_resolution_one_image() { + assert_eq!(make_request(NanoBananaProTextToImageNumImages::One, None).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_one_k_one_image() { + assert_eq!(make_request(NanoBananaProTextToImageNumImages::One, Some(NanoBananaProTextToImageResolution::OneK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_two_k_one_image() { + assert_eq!(make_request(NanoBananaProTextToImageNumImages::One, Some(NanoBananaProTextToImageResolution::TwoK)).calculate_cost_in_cents(), 15); + } + + #[test] + fn cost_four_k_one_image() { + assert_eq!(make_request(NanoBananaProTextToImageNumImages::One, Some(NanoBananaProTextToImageResolution::FourK)).calculate_cost_in_cents(), 30); + } + + #[test] + fn cost_one_k_four_images() { + assert_eq!(make_request(NanoBananaProTextToImageNumImages::Four, Some(NanoBananaProTextToImageResolution::OneK)).calculate_cost_in_cents(), 60); + } + + #[test] + fn cost_four_k_two_images() { + assert_eq!(make_request(NanoBananaProTextToImageNumImages::Two, Some(NanoBananaProTextToImageResolution::FourK)).calculate_cost_in_cents(), 60); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/mod.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/raw_request.rs new file mode 100644 index 00000000..a85c7156 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/image/text/nano_banana_pro_text_to_image/raw_request.rs @@ -0,0 +1,36 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBananaProTextToImageInput { + pub prompt: String, + + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProTextToImageOutput { + pub images: Vec, +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/api.rs new file mode 100644 index 00000000..3e68bcf0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/api.rs @@ -0,0 +1,228 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::hunyuan3d_3_image_to_mesh::raw_request::{ + Hunyuan3d3ImageToMeshInput, Hunyuan3d3ImageToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Hunyuan3d3ImageToMeshRequest { + /// URL of the input image. + pub image_url: String, + + /// Optional back-view image URL for multi-view generation. + pub back_image_url: Option, + + /// Optional left-view image URL for multi-view generation. + pub left_image_url: Option, + + /// Optional right-view image URL for multi-view generation. + pub right_image_url: Option, + + /// Target face count for the output mesh. + pub face_count: Option, + + /// Generation type. + pub generate_type: Option, + + /// Polygon type for the output mesh. + pub polygon_type: Option, + + /// Whether to enable PBR (physically-based rendering) materials. + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3ImageToMeshGenerateType { + Normal, + LowPoly, + Geometry, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3ImageToMeshPolygonType { + Triangle, + Quadrilateral, +} + +impl FalEndpoint for Hunyuan3d3ImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan3d-v3/image-to-3d"; + + type RawRequest = Hunyuan3d3ImageToMeshInput; + type RawResponse = Hunyuan3d3ImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + let generate_type = self.generate_type.map(|t| match t { + Hunyuan3d3ImageToMeshGenerateType::Normal => "Normal", + Hunyuan3d3ImageToMeshGenerateType::LowPoly => "LowPoly", + Hunyuan3d3ImageToMeshGenerateType::Geometry => "Geometry", + }.to_string()); + + let polygon_type = self.polygon_type.map(|t| match t { + Hunyuan3d3ImageToMeshPolygonType::Triangle => "triangle", + Hunyuan3d3ImageToMeshPolygonType::Quadrilateral => "quadrilateral", + }.to_string()); + + Ok(Self::RawRequest { + input_image_url: self.image_url.clone(), + back_image_url: self.back_image_url.clone(), + left_image_url: self.left_image_url.clone(), + right_image_url: self.right_image_url.clone(), + face_count: self.face_count, + generate_type, + polygon_type, + enable_pbr: self.enable_pbr, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d3ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d3ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3ImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + back_image_url: Some("https://example.com/back.jpg".to_string()), + left_image_url: Some("https://example.com/left.jpg".to_string()), + right_image_url: Some("https://example.com/right.jpg".to_string()), + face_count: Some(100_000), + generate_type: Some(Hunyuan3d3ImageToMeshGenerateType::LowPoly), + polygon_type: Some(Hunyuan3d3ImageToMeshPolygonType::Quadrilateral), + enable_pbr: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/front.jpg", + "back_image_url": "https://example.com/back.jpg", + "left_image_url": "https://example.com/left.jpg", + "right_image_url": "https://example.com/right.jpg", + "face_count": 100_000, + "generate_type": "LowPoly", + "polygon_type": "quadrilateral", + "enable_pbr": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3ImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_image_url": "https://example.com/front.jpg" }), + ); + } + + #[test] + fn every_generate_type_maps_to_wire_string() { + for (variant, expected) in [ + (Hunyuan3d3ImageToMeshGenerateType::Normal, "Normal"), + (Hunyuan3d3ImageToMeshGenerateType::LowPoly, "LowPoly"), + (Hunyuan3d3ImageToMeshGenerateType::Geometry, "Geometry"), + ] { + let mut request = base_wire_request(); + request.generate_type = Some(variant); + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.generate_type.as_deref(), Some(expected)); + } + } + + #[test] + fn every_polygon_type_maps_to_wire_string() { + for (variant, expected) in [ + (Hunyuan3d3ImageToMeshPolygonType::Triangle, "triangle"), + (Hunyuan3d3ImageToMeshPolygonType::Quadrilateral, "quadrilateral"), + ] { + let mut request = base_wire_request(); + request.polygon_type = Some(variant); + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.polygon_type.as_deref(), Some(expected)); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Hunyuan3d3ImageToMeshRequest::ENDPOINT, "fal-ai/hunyuan3d-v3/image-to-3d"); + } + + // NB: Pricing tests are in cost.rs + + fn base_wire_request() -> Hunyuan3d3ImageToMeshRequest { + Hunyuan3d3ImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/cost.rs new file mode 100644 index 00000000..e34bcef7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/cost.rs @@ -0,0 +1,162 @@ +use crate::requests::api::mesh::image::hunyuan3d_3_image_to_mesh::api::{ + Hunyuan3d3ImageToMeshGenerateType, Hunyuan3d3ImageToMeshRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3ImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Base cost by generation type: + // Normal: $0.375 → 38¢ (rounded up) + // LowPoly: $0.45 → 45¢ + // Geometry: $0.225 → 23¢ (rounded up) + // + // Add-ons (each +$0.15 = 15¢): + // - PBR materials enabled + // - Custom face count specified + // - Multi-view images (any of back/left/right) + let mut cost: u64 = match self.generate_type { + None => 38, + Some(Hunyuan3d3ImageToMeshGenerateType::Normal) => 38, + Some(Hunyuan3d3ImageToMeshGenerateType::Geometry) => 23, + Some(Hunyuan3d3ImageToMeshGenerateType::LowPoly) => 45, + }; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + let use_multi_view = self.left_image_url.is_some() + || self.right_image_url.is_some() + || self.back_image_url.is_some(); + if use_multi_view { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Hunyuan3d3ImageToMeshRequest { + Hunyuan3d3ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + } + } + + mod base_costs { + use super::*; + + #[test] + fn default_generate_type() { + assert_eq!(base_request().calculate_cost_in_cents(), 38); + } + + #[test] + fn normal() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3ImageToMeshGenerateType::Normal); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + + #[test] + fn low_poly() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3ImageToMeshGenerateType::LowPoly); + assert_eq!(req.calculate_cost_in_cents(), 45); + } + + #[test] + fn geometry() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3ImageToMeshGenerateType::Geometry); + assert_eq!(req.calculate_cost_in_cents(), 23); + } + } + + mod add_ons { + use super::*; + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn pbr_false_no_extra() { + let mut req = base_request(); + req.enable_pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + + #[test] + fn face_count_adds_fifteen() { + let mut req = base_request(); + req.face_count = Some(50_000); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn back_image_adds_fifteen() { + let mut req = base_request(); + req.back_image_url = Some("https://example.com/back.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn left_image_adds_fifteen() { + let mut req = base_request(); + req.left_image_url = Some("https://example.com/left.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn right_image_adds_fifteen() { + let mut req = base_request(); + req.right_image_url = Some("https://example.com/right.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn multi_view_only_adds_fifteen_once() { + let mut req = base_request(); + req.back_image_url = Some("https://example.com/back.jpg".to_string()); + req.left_image_url = Some("https://example.com/left.jpg".to_string()); + req.right_image_url = Some("https://example.com/right.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn all_add_ons_stack() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3ImageToMeshGenerateType::LowPoly); + req.enable_pbr = Some(true); + req.face_count = Some(100_000); + req.back_image_url = Some("https://example.com/back.jpg".to_string()); + // LowPoly(45) + PBR(15) + face_count(15) + multi_view(15) = 90 + assert_eq!(req.calculate_cost_in_cents(), 90); + } + + #[test] + fn geometry_with_all_add_ons() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3ImageToMeshGenerateType::Geometry); + req.enable_pbr = Some(true); + req.face_count = Some(10_000); + req.left_image_url = Some("https://example.com/left.jpg".to_string()); + // Geometry(23) + PBR(15) + face_count(15) + multi_view(15) = 68 + assert_eq!(req.calculate_cost_in_cents(), 68); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..1ddd9102 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan3d_3_image_to_mesh/raw_request.rs @@ -0,0 +1,32 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3ImageToMeshInput { + pub input_image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub back_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub left_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub right_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + /// Options: "Normal", "LowPoly", "Geometry" + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Options: "triangle", "quadrilateral" + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_type: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3ImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/api.rs new file mode 100644 index 00000000..9f29ef90 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/api.rs @@ -0,0 +1,151 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::hunyuan_3d_2p0_image_to_mesh::raw_request::{ + Hunyuan3d2p0ImageToMeshInput, Hunyuan3d2p0ImageToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan3D 2.0 image-to-3D: turns a single image into a 3D mesh, +/// optionally textured. +#[derive(Clone, Debug)] +pub struct Hunyuan3d2p0ImageToMeshRequest { + /// URL of the input image. + pub image_url: String, + + /// Whether to generate a textured mesh instead of a white (untextured) + /// mesh. fal's default is false when `None`. Textured costs 3x. + pub textured_mesh: Option, + + /// Guidance scale for the model. fal's default is 7.5 when `None`. + pub guidance_scale: Option, + + /// Number of inference steps. fal's default is 50 when `None`. + pub num_inference_steps: Option, + + /// Octree resolution for the mesh. fal's default is 256 when `None`. + pub octree_resolution: Option, + + /// Seed for reproducible generation. Random when `None`. + pub seed: Option, +} + +impl FalEndpoint for Hunyuan3d2p0ImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan3d/v2"; + + type RawRequest = Hunyuan3d2p0ImageToMeshInput; + type RawResponse = Hunyuan3d2p0ImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + input_image_url: self.image_url.clone(), + textured_mesh: self.textured_mesh, + guidance_scale: self.guidance_scale, + num_inference_steps: self.num_inference_steps, + octree_resolution: self.octree_resolution, + seed: self.seed, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d2p0ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + textured_mesh: Some(true), + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d2p0ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + textured_mesh: Some(true), + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d2p0ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + textured_mesh: Some(true), + guidance_scale: Some(5.0), + num_inference_steps: Some(30), + octree_resolution: Some(512), + seed: Some(42), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/image.jpg", + "textured_mesh": true, + "guidance_scale": 5.0, + "num_inference_steps": 30, + "octree_resolution": 512, + "seed": 42, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d2p0ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + textured_mesh: None, + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_image_url": "https://example.com/image.jpg" }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Hunyuan3d2p0ImageToMeshRequest::ENDPOINT, "fal-ai/hunyuan3d/v2"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/cost.rs new file mode 100644 index 00000000..c751f612 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/cost.rs @@ -0,0 +1,67 @@ +use crate::requests::api::mesh::image::hunyuan_3d_2p0_image_to_mesh::api::Hunyuan3d2p0ImageToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d2p0ImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan3d/v2): + // "Your request will cost $0.16 per generation." (white mesh) + // Textured mesh is charged at 3x the white mesh price: $0.48. + // + // White mesh: $0.16 → 16¢ + // Textured mesh: $0.48 → 48¢ + if self.textured_mesh.unwrap_or(false) { + 48 + } else { + 16 + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod cost_table { + use super::*; + + #[test] + fn white_mesh_by_default() { + assert_eq!(base_request().calculate_cost_in_cents(), 16); + } + + #[test] + fn white_mesh_explicit() { + let mut req = base_request(); + req.textured_mesh = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 16); + } + + #[test] + fn textured_mesh_costs_three_times_white() { + let mut req = base_request(); + req.textured_mesh = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 48); + } + + #[test] + fn tuning_parameters_do_not_affect_cost() { + let mut req = base_request(); + req.guidance_scale = Some(10.0); + req.num_inference_steps = Some(25); + req.octree_resolution = Some(512); + req.seed = Some(7); + assert_eq!(req.calculate_cost_in_cents(), 16); + } + } + + fn base_request() -> Hunyuan3d2p0ImageToMeshRequest { + Hunyuan3d2p0ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + textured_mesh: None, + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..61a3cc06 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p0_image_to_mesh/raw_request.rs @@ -0,0 +1,34 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan3d/v2`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d2p0ImageToMeshInput { + /// URL of the image to use while generating the 3D model. + pub input_image_url: String, + + /// If true, a textured mesh is generated and the price charged is 3x + /// that of a white (untextured) mesh. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub textured_mesh: Option, + + /// Guidance scale for the model. fal default: 7.5. + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// Number of inference steps to perform. fal default: 50. + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Octree resolution for the model. fal default: 256. + #[serde(skip_serializing_if = "Option::is_none")] + pub octree_resolution: Option, + + /// The same seed and prompt given to the same model version produce the + /// same output. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d2p0ImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/api.rs new file mode 100644 index 00000000..009b1407 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/api.rs @@ -0,0 +1,153 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::hunyuan_3d_2p1_image_to_mesh::raw_request::{ + Hunyuan3d2p1ImageToMeshInput, Hunyuan3d2p1ImageToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan3D 2.1 image-to-3D: turns a single image into a 3D mesh, +/// optionally with PBR textures. +/// +/// NB: fal lists this endpoint as deprecated, but it is still callable. +#[derive(Clone, Debug)] +pub struct Hunyuan3d2p1ImageToMeshRequest { + /// URL of the input image. + pub image_url: String, + + /// Whether to generate a textured (PBR) mesh instead of a white + /// (untextured) mesh. fal's default is false when `None`. Textured costs 3x. + pub textured_mesh: Option, + + /// Guidance scale for the model. fal's default is 7.5 when `None`. + pub guidance_scale: Option, + + /// Number of inference steps. fal's default is 50 when `None`. + pub num_inference_steps: Option, + + /// Octree resolution for the mesh. fal's default is 256 when `None`. + pub octree_resolution: Option, + + /// Seed for reproducible generation. Random when `None`. + pub seed: Option, +} + +impl FalEndpoint for Hunyuan3d2p1ImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan3d-v21"; + + type RawRequest = Hunyuan3d2p1ImageToMeshInput; + type RawResponse = Hunyuan3d2p1ImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + input_image_url: self.image_url.clone(), + textured_mesh: self.textured_mesh, + guidance_scale: self.guidance_scale, + num_inference_steps: self.num_inference_steps, + octree_resolution: self.octree_resolution, + seed: self.seed, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d2p1ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + textured_mesh: Some(true), + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d2p1ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + textured_mesh: Some(true), + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d2p1ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + textured_mesh: Some(true), + guidance_scale: Some(5.0), + num_inference_steps: Some(30), + octree_resolution: Some(512), + seed: Some(42), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/image.jpg", + "textured_mesh": true, + "guidance_scale": 5.0, + "num_inference_steps": 30, + "octree_resolution": 512, + "seed": 42, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d2p1ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + textured_mesh: None, + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_image_url": "https://example.com/image.jpg" }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Hunyuan3d2p1ImageToMeshRequest::ENDPOINT, "fal-ai/hunyuan3d-v21"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/cost.rs new file mode 100644 index 00000000..7435417b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/cost.rs @@ -0,0 +1,68 @@ +use crate::requests::api::mesh::image::hunyuan_3d_2p1_image_to_mesh::api::Hunyuan3d2p1ImageToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d2p1ImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan3d-v21): + // "Your request will cost $0.3 per generation." (white mesh) + // Per fal's input schema, textured mesh is charged at 3x the white + // mesh price: $0.90. + // + // White mesh: $0.30 → 30¢ + // Textured mesh: $0.90 → 90¢ + if self.textured_mesh.unwrap_or(false) { + 90 + } else { + 30 + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod cost_table { + use super::*; + + #[test] + fn white_mesh_by_default() { + assert_eq!(base_request().calculate_cost_in_cents(), 30); + } + + #[test] + fn white_mesh_explicit() { + let mut req = base_request(); + req.textured_mesh = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 30); + } + + #[test] + fn textured_mesh_costs_three_times_white() { + let mut req = base_request(); + req.textured_mesh = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 90); + } + + #[test] + fn tuning_parameters_do_not_affect_cost() { + let mut req = base_request(); + req.guidance_scale = Some(10.0); + req.num_inference_steps = Some(25); + req.octree_resolution = Some(512); + req.seed = Some(7); + assert_eq!(req.calculate_cost_in_cents(), 30); + } + } + + fn base_request() -> Hunyuan3d2p1ImageToMeshRequest { + Hunyuan3d2p1ImageToMeshRequest { + image_url: "https://example.com/image.jpg".to_string(), + textured_mesh: None, + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..f6c2b9e1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_2p1_image_to_mesh/raw_request.rs @@ -0,0 +1,36 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan3d-v21`. +/// fal's schema: +/// +/// NB: fal lists this endpoint as deprecated, but it is still callable. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d2p1ImageToMeshInput { + /// URL of the image to use while generating the 3D model. + pub input_image_url: String, + + /// If true, a textured (PBR) mesh is generated and the price charged is + /// 3x that of a white (untextured) mesh. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub textured_mesh: Option, + + /// Guidance scale for the model. fal default: 7.5. + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// Number of inference steps to perform. fal default: 50. + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Octree resolution for the model. fal default: 256. + #[serde(skip_serializing_if = "Option::is_none")] + pub octree_resolution: Option, + + /// The same seed and prompt given to the same model version produce the + /// same output. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d2p1ImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/api.rs new file mode 100644 index 00000000..0001d7a7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/api.rs @@ -0,0 +1,226 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::hunyuan_3d_3p1_pro_image_to_mesh::raw_request::{ + Hunyuan3d3p1ProImageToMeshInput, Hunyuan3d3p1ProImageToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan 3D v3.1 Pro image-to-3D. +/// +/// v3.1 expands multi-view input to seven optional extra views (back, left, +/// right, top, bottom, left-front 45°, right-front 45°) and drops the v3 +/// `LowPoly` generation type and `polygon_type` parameter. +#[derive(Clone, Debug)] +pub struct Hunyuan3d3p1ProImageToMeshRequest { + /// URL of the front-view input image (required). + pub image_url: String, + + /// Optional back-view image URL for multi-view generation. + pub back_image_url: Option, + + /// Optional left-view image URL for multi-view generation. + pub left_image_url: Option, + + /// Optional right-view image URL for multi-view generation. + pub right_image_url: Option, + + /// Optional top-view image URL (v3.1 exclusive). + pub top_image_url: Option, + + /// Optional bottom-view image URL (v3.1 exclusive). + pub bottom_image_url: Option, + + /// Optional left-front 45° image URL (v3.1 exclusive). + pub left_front_image_url: Option, + + /// Optional right-front 45° image URL (v3.1 exclusive). + pub right_front_image_url: Option, + + /// Generation type. fal's default is `Normal` when `None`. + pub generate_type: Option, + + /// Target face count for the output mesh. Range 40000-1500000; + /// fal's default is 500000 when `None`. Setting a custom value adds cost. + pub face_count: Option, + + /// Whether to enable PBR (physically-based rendering) materials. + /// fal's default is false when `None`. Enabling adds cost. + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3p1ProImageToMeshGenerateType { + Normal, + Geometry, +} + +impl Hunyuan3d3p1ProImageToMeshRequest { + /// True when any of the optional extra views is provided (billed as the + /// multi-view add-on). + pub fn uses_multi_view(&self) -> bool { + self.back_image_url.is_some() + || self.left_image_url.is_some() + || self.right_image_url.is_some() + || self.top_image_url.is_some() + || self.bottom_image_url.is_some() + || self.left_front_image_url.is_some() + || self.right_front_image_url.is_some() + } +} + +impl FalEndpoint for Hunyuan3d3p1ProImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan-3d/v3.1/pro/image-to-3d"; + + type RawRequest = Hunyuan3d3p1ProImageToMeshInput; + type RawResponse = Hunyuan3d3p1ProImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + let generate_type = self.generate_type.map(|t| match t { + Hunyuan3d3p1ProImageToMeshGenerateType::Normal => "Normal", + Hunyuan3d3p1ProImageToMeshGenerateType::Geometry => "Geometry", + }.to_string()); + + Ok(Self::RawRequest { + input_image_url: self.image_url.clone(), + back_image_url: self.back_image_url.clone(), + left_image_url: self.left_image_url.clone(), + right_image_url: self.right_image_url.clone(), + top_image_url: self.top_image_url.clone(), + bottom_image_url: self.bottom_image_url.clone(), + left_front_image_url: self.left_front_image_url.clone(), + right_front_image_url: self.right_front_image_url.clone(), + generate_type, + face_count: self.face_count, + enable_pbr: self.enable_pbr, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + fn base_request() -> Hunyuan3d3p1ProImageToMeshRequest { + Hunyuan3d3p1ProImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + top_image_url: None, + bottom_image_url: None, + left_front_image_url: None, + right_front_image_url: None, + generate_type: None, + face_count: None, + enable_pbr: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1ProImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1ProImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3p1ProImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + back_image_url: Some("https://example.com/back.jpg".to_string()), + left_image_url: Some("https://example.com/left.jpg".to_string()), + right_image_url: Some("https://example.com/right.jpg".to_string()), + top_image_url: Some("https://example.com/top.jpg".to_string()), + bottom_image_url: Some("https://example.com/bottom.jpg".to_string()), + left_front_image_url: Some("https://example.com/lf.jpg".to_string()), + right_front_image_url: Some("https://example.com/rf.jpg".to_string()), + generate_type: Some(Hunyuan3d3p1ProImageToMeshGenerateType::Geometry), + face_count: Some(100_000), + enable_pbr: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/front.jpg", + "back_image_url": "https://example.com/back.jpg", + "left_image_url": "https://example.com/left.jpg", + "right_image_url": "https://example.com/right.jpg", + "top_image_url": "https://example.com/top.jpg", + "bottom_image_url": "https://example.com/bottom.jpg", + "left_front_image_url": "https://example.com/lf.jpg", + "right_front_image_url": "https://example.com/rf.jpg", + "generate_type": "Geometry", + "face_count": 100_000, + "enable_pbr": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let json = serde_json::to_value(base_request().to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_image_url": "https://example.com/front.jpg" }), + ); + } + + #[test] + fn uses_multi_view_detects_every_extra_view() { + assert!(!base_request().uses_multi_view()); + let setters: Vec = vec![ + |r| r.back_image_url = Some("u".to_string()), + |r| r.left_image_url = Some("u".to_string()), + |r| r.right_image_url = Some("u".to_string()), + |r| r.top_image_url = Some("u".to_string()), + |r| r.bottom_image_url = Some("u".to_string()), + |r| r.left_front_image_url = Some("u".to_string()), + |r| r.right_front_image_url = Some("u".to_string()), + ]; + for set in setters { + let mut req = base_request(); + set(&mut req); + assert!(req.uses_multi_view()); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Hunyuan3d3p1ProImageToMeshRequest::ENDPOINT, + "fal-ai/hunyuan-3d/v3.1/pro/image-to-3d", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/cost.rs new file mode 100644 index 00000000..c7106afb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/cost.rs @@ -0,0 +1,101 @@ +use crate::requests::api::mesh::image::hunyuan_3d_3p1_pro_image_to_mesh::api::Hunyuan3d3p1ProImageToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3p1ProImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan-3d/v3.1/pro/image-to-3d): + // "Your request will cost $0.375 per generation. Enabling PBR materials + // adds $0.15. Using multi-view images adds $0.15. Custom face count + // adds $0.15." + // + // Base: $0.375 → 38¢ (rounded up). Unlike v3, the v3.1 pro pricing has no + // per-generation-type price deltas — Geometry bills the same base. + let mut cost: u64 = 38; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + if self.uses_multi_view() { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::mesh::image::hunyuan_3d_3p1_pro_image_to_mesh::api::Hunyuan3d3p1ProImageToMeshGenerateType; + + fn base_request() -> Hunyuan3d3p1ProImageToMeshRequest { + Hunyuan3d3p1ProImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + top_image_url: None, + bottom_image_url: None, + left_front_image_url: None, + right_front_image_url: None, + generate_type: None, + face_count: None, + enable_pbr: None, + } + } + + #[test] + fn base_cost() { + assert_eq!(base_request().calculate_cost_in_cents(), 38); + } + + #[test] + fn generate_type_does_not_change_cost() { + for t in [ + Hunyuan3d3p1ProImageToMeshGenerateType::Normal, + Hunyuan3d3p1ProImageToMeshGenerateType::Geometry, + ] { + let mut req = base_request(); + req.generate_type = Some(t); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + } + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn face_count_adds_fifteen() { + let mut req = base_request(); + req.face_count = Some(50_000); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn any_extra_view_adds_fifteen_once() { + // v3.1-exclusive views must also trigger the multi-view add-on. + let mut req = base_request(); + req.top_image_url = Some("https://example.com/top.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + + // Stacking more views doesn't add more. + req.back_image_url = Some("https://example.com/back.jpg".to_string()); + req.left_front_image_url = Some("https://example.com/lf.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn all_add_ons_stack() { + let mut req = base_request(); + req.enable_pbr = Some(true); + req.face_count = Some(100_000); + req.right_front_image_url = Some("https://example.com/rf.jpg".to_string()); + // 38 + 15 + 15 + 15 = 83 + assert_eq!(req.calculate_cost_in_cents(), 83); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..e3f431d6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_pro_image_to_mesh/raw_request.rs @@ -0,0 +1,48 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan-3d/v3.1/pro/image-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3p1ProImageToMeshInput { + /// Front-view image (required). 128-5000px, max 8MB, JPG/PNG/WEBP. + pub input_image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub back_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub left_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub right_image_url: Option, + + /// Top view (v3.1 exclusive). + #[serde(skip_serializing_if = "Option::is_none")] + pub top_image_url: Option, + + /// Bottom view (v3.1 exclusive). + #[serde(skip_serializing_if = "Option::is_none")] + pub bottom_image_url: Option, + + /// Left-front 45° view (v3.1 exclusive). + #[serde(skip_serializing_if = "Option::is_none")] + pub left_front_image_url: Option, + + /// Right-front 45° view (v3.1 exclusive). + #[serde(skip_serializing_if = "Option::is_none")] + pub right_front_image_url: Option, + + /// Options: "Normal", "Geometry" (no LowPoly on v3.1). + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Range 40000-1500000. fal default: 500000. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3p1ProImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/api.rs new file mode 100644 index 00000000..ae0bb553 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/api.rs @@ -0,0 +1,125 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::hunyuan_3d_3p1_rapid_image_to_mesh::raw_request::{ + Hunyuan3d3p1RapidImageToMeshInput, Hunyuan3d3p1RapidImageToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan 3D v3.1 Rapid image-to-3D — the fast, low-cost tier. +/// +/// NB: the rapid schema is minimal — single input image (no multi-view), no +/// `generate_type`, `face_count`, or `polygon_type`. Geometry-only output is +/// a boolean (`enable_geometry`). +#[derive(Clone, Debug)] +pub struct Hunyuan3d3p1RapidImageToMeshRequest { + /// URL of the input image (required). + pub image_url: String, + + /// Whether to enable PBR (physically-based rendering) materials. + /// fal's default is false when `None`. Enabling adds cost. + pub enable_pbr: Option, + + /// Generate a geometry-only white model without textures. + /// fal's default is false when `None`. Disables PBR output. + pub enable_geometry: Option, +} + +impl FalEndpoint for Hunyuan3d3p1RapidImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan-3d/v3.1/rapid/image-to-3d"; + + type RawRequest = Hunyuan3d3p1RapidImageToMeshInput; + type RawResponse = Hunyuan3d3p1RapidImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + input_image_url: self.image_url.clone(), + enable_pbr: self.enable_pbr, + enable_geometry: self.enable_geometry, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1RapidImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + enable_pbr: None, + enable_geometry: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1RapidImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + enable_pbr: None, + enable_geometry: None, + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3p1RapidImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + enable_pbr: Some(true), + enable_geometry: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/front.jpg", + "enable_pbr": true, + "enable_geometry": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3p1RapidImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + enable_pbr: None, + enable_geometry: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_image_url": "https://example.com/front.jpg" }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Hunyuan3d3p1RapidImageToMeshRequest::ENDPOINT, + "fal-ai/hunyuan-3d/v3.1/rapid/image-to-3d", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/cost.rs new file mode 100644 index 00000000..980e5b17 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/cost.rs @@ -0,0 +1,49 @@ +use crate::requests::api::mesh::image::hunyuan_3d_3p1_rapid_image_to_mesh::api::Hunyuan3d3p1RapidImageToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3p1RapidImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan-3d/v3.1/rapid/image-to-3d): + // "Base generation (text or image to 3D) costs $0.225. Enabling PBR + // materials adds $0.15." + // + // Base: $0.225 → 23¢ (rounded up). + let mut cost: u64 = 23; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Hunyuan3d3p1RapidImageToMeshRequest { + Hunyuan3d3p1RapidImageToMeshRequest { + image_url: "https://example.com/front.jpg".to_string(), + enable_pbr: None, + enable_geometry: None, + } + } + + #[test] + fn base_cost() { + assert_eq!(base_request().calculate_cost_in_cents(), 23); + } + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 23 + 15); + } + + #[test] + fn geometry_does_not_change_cost() { + let mut req = base_request(); + req.enable_geometry = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 23); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..296902be --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/hunyuan_3d_3p1_rapid_image_to_mesh/raw_request.rs @@ -0,0 +1,20 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan-3d/v3.1/rapid/image-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3p1RapidImageToMeshInput { + /// Front-view image (required). 128-5000px, max 8MB, JPG/PNG/WEBP. + pub input_image_url: String, + + /// Generate PBR textures (metallic, roughness, normal). fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, + + /// Generate a geometry-only white model without textures. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_geometry: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3p1RapidImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/api.rs new file mode 100644 index 00000000..70dd43c2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/api.rs @@ -0,0 +1,184 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::meshy_v6_image_to_mesh::raw_request::{ + MeshyV6ImageToMeshInput, MeshyV6ImageToMeshOutput, +}; +use crate::requests::api::mesh::text::meshy_v6_text_to_mesh::api::{ + MeshyV6ModelType, MeshyV6PoseMode, MeshyV6SymmetryMode, MeshyV6Topology, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Meshy 6 image-to-3D. Shares its option enums with the text binding. +/// +/// NB: unlike text-to-3d, the image schema has no `mode`, `seed`, or +/// `enable_prompt_expansion`, and adds `should_texture`. +#[derive(Clone, Debug)] +pub struct MeshyV6ImageToMeshRequest { + /// URL of the input image (required). + pub image_url: String, + + /// Model type. fal's default is `Standard` when `None`. + pub model_type: Option, + + /// Mesh topology. fal's default is `Triangle` when `None`. + pub topology: Option, + + /// Target polygon count. Range 100-300000; fal's default is 30000. + pub target_polycount: Option, + + /// Symmetry mode. fal's default is `Auto` when `None`. + pub symmetry_mode: Option, + + /// Whether to remesh the output. fal's default is true when `None`. + pub should_remesh: Option, + + /// Whether to texture the output. fal's default is true when `None`. + pub should_texture: Option, + + /// Whether to generate PBR materials. fal's default is false when `None`. + pub enable_pbr: Option, + + /// Character pose mode. Unspecified when `None` (fal's default). + pub pose_mode: Option, + + /// Optional texture-specific prompt. + pub texture_prompt: Option, + + /// Optional texture reference image URL. + pub texture_image_url: Option, + + /// Rig the generated character. fal's default is false when `None`. + pub enable_rigging: Option, + + /// Character height for rigging, in meters. fal's default is 1.7. + pub rigging_height_meters: Option, + + /// Animate the rigged character. fal's default is false when `None`. + pub enable_animation: Option, + + /// Animation action ID. Range 0-696; fal's default is 92. + pub animation_action_id: Option, + + /// fal's default is true when `None`. + pub enable_safety_checker: Option, +} + +impl FalEndpoint for MeshyV6ImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/meshy/v6/image-to-3d"; + + type RawRequest = MeshyV6ImageToMeshInput; + type RawResponse = MeshyV6ImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + image_url: self.image_url.clone(), + model_type: self.model_type.map(|m| m.to_str().to_string()), + topology: self.topology.map(|t| t.to_str().to_string()), + target_polycount: self.target_polycount, + symmetry_mode: self.symmetry_mode.map(|s| s.to_str().to_string()), + should_remesh: self.should_remesh, + should_texture: self.should_texture, + enable_pbr: self.enable_pbr, + pose_mode: self.pose_mode.map(|p| p.to_str().to_string()), + texture_prompt: self.texture_prompt.clone(), + texture_image_url: self.texture_image_url.clone(), + enable_rigging: self.enable_rigging, + rigging_height_meters: self.rigging_height_meters, + enable_animation: self.enable_animation, + animation_action_id: self.animation_action_id, + enable_safety_checker: self.enable_safety_checker, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + fn base_request() -> MeshyV6ImageToMeshRequest { + MeshyV6ImageToMeshRequest { + image_url: "https://example.com/input.jpg".to_string(), + model_type: None, + topology: None, + target_polycount: None, + symmetry_mode: None, + should_remesh: None, + should_texture: None, + enable_pbr: None, + pose_mode: None, + texture_prompt: None, + texture_image_url: None, + enable_rigging: None, + rigging_height_meters: None, + enable_animation: None, + animation_action_id: None, + enable_safety_checker: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = MeshyV6ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = MeshyV6ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_core_fields() { + let request = MeshyV6ImageToMeshRequest { + model_type: Some(MeshyV6ModelType::LowPoly), + topology: Some(MeshyV6Topology::Quad), + should_texture: Some(false), + enable_pbr: Some(true), + ..base_request() + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json["image_url"], "https://example.com/input.jpg"); + assert_eq!(json["model_type"], "lowpoly"); + assert_eq!(json["topology"], "quad"); + assert_eq!(json["should_texture"], false); + assert_eq!(json["enable_pbr"], true); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let json = serde_json::to_value(base_request().to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "image_url": "https://example.com/input.jpg" })); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(MeshyV6ImageToMeshRequest::ENDPOINT, "fal-ai/meshy/v6/image-to-3d"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/cost.rs new file mode 100644 index 00000000..b3dde0c1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/cost.rs @@ -0,0 +1,42 @@ +use crate::requests::api::mesh::image::meshy_v6_image_to_mesh::api::MeshyV6ImageToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for MeshyV6ImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/meshy/v6/image-to-3d): + // "Your request will cost $0.8 per generation." + 80 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn flat_cost_regardless_of_options() { + let mut request = MeshyV6ImageToMeshRequest { + image_url: "https://example.com/input.jpg".to_string(), + model_type: None, + topology: None, + target_polycount: None, + symmetry_mode: None, + should_remesh: None, + should_texture: None, + enable_pbr: None, + pose_mode: None, + texture_prompt: None, + texture_image_url: None, + enable_rigging: None, + rigging_height_meters: None, + enable_animation: None, + animation_action_id: None, + enable_safety_checker: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 80); + + request.should_texture = Some(false); + request.enable_pbr = Some(true); + assert_eq!(request.calculate_cost_in_cents(), 80); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..2d90ddf4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/meshy_v6_image_to_mesh/raw_request.rs @@ -0,0 +1,70 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/meshy/v6/image-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct MeshyV6ImageToMeshInput { + /// URL of the input image (.jpg/.jpeg/.png/AVIF/HEIF). + pub image_url: String, + + /// Options: "standard", "lowpoly". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub model_type: Option, + + /// Options: "quad", "triangle". fal default: "triangle". + #[serde(skip_serializing_if = "Option::is_none")] + pub topology: Option, + + /// Range 100-300000. fal default: 30000. + #[serde(skip_serializing_if = "Option::is_none")] + pub target_polycount: Option, + + /// Options: "off", "auto", "on". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub symmetry_mode: Option, + + /// fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub should_remesh: Option, + + /// fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub should_texture: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, + + /// Options: "a-pose", "t-pose". fal default: "" (unspecified). + #[serde(skip_serializing_if = "Option::is_none")] + pub pose_mode: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_image_url: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_rigging: Option, + + /// fal default: 1.7. + #[serde(skip_serializing_if = "Option::is_none")] + pub rigging_height_meters: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_animation: Option, + + /// Range 0-696. fal default: 92. + #[serde(skip_serializing_if = "Option::is_none")] + pub animation_action_id: Option, + + /// fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeshyV6ImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/mod.rs new file mode 100644 index 00000000..b0766f2b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/mod.rs @@ -0,0 +1,8 @@ +pub mod hunyuan_3d_2p0_image_to_mesh; +pub mod hunyuan_3d_2p1_image_to_mesh; +pub mod hunyuan3d_3_image_to_mesh; +pub mod hunyuan_3d_3p1_pro_image_to_mesh; +pub mod hunyuan_3d_3p1_rapid_image_to_mesh; +pub mod meshy_v6_image_to_mesh; +pub mod rodin_2p5_fast_image_to_mesh; +pub mod tripo3d_h3p1_image_to_mesh; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/api.rs new file mode 100644 index 00000000..f9a5fc8a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/api.rs @@ -0,0 +1,191 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::rodin_2p5_fast_image_to_mesh::raw_request::{ + Rodin2p5FastImageToMeshInput, Rodin2p5FastImageToMeshOutput, +}; +use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::api::{ + Rodin2p5FastGeometryFileFormat, Rodin2p5FastMaterial, Rodin2p5FastQualityMeshOption, + Rodin2p5FastTextureMode, Rodin2p5FastTier, +}; +use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::raw_request::Rodin2p5FastBboxCondition; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hyper3D Rodin v2.5 Fast image-to-3D. Shares its option enums with the +/// text binding. +#[derive(Clone, Debug)] +pub struct Rodin2p5FastImageToMeshRequest { + /// Up to 5 input images of the object. + pub image_urls: Vec, + + /// Optional guidance prompt. Auto-generated from the images when `None`. + pub prompt: Option, + + /// Preserve the transparency channel of the input. fal's default is false. + pub use_original_alpha: Option, + + /// Generation tier. fal's default is `ExtremeLow` when `None`. + pub tier: Option, + + /// Seed for reproducibility. Range 0-65535. + pub seed: Option, + + /// Output geometry format. fal's default is `Glb` when `None`. + pub geometry_file_format: Option, + + /// Material type. fal's default is `Shaded` when `None`. + pub material: Option, + + /// Mesh quality/topology preset. fal's default is `Auto` when `None`. + pub quality_mesh_option: Option, + + /// Texture resolution mode. fal's default is tier-dependent when `None`. + pub texture_mode: Option, + + /// Enhanced generative robustness. fal's default is false when `None`. + pub enable_creative_mode: Option, + + /// Enhanced texture post-processing. fal's default is false when `None`. + pub hd_texture: Option, + + /// Removes baked lighting from textures. fal's default is false when `None`. + pub texture_delight: Option, + + /// Finer geometric detail. fal's default is false when `None`. + pub is_micro: Option, + + /// Generate in T/A-pose for rigging/animation. fal's default is false. + pub ta_pose: Option, + + /// Bounding-box controlnet limiting the maximum model size. + pub bbox_condition: Option, + + /// Generate a preview render image. fal's default is false when `None`. + pub preview_render: Option, +} + +impl FalEndpoint for Rodin2p5FastImageToMeshRequest { + const ENDPOINT: &str = "fal-ai/hyper3d/rodin/v2.5/fast"; + + type RawRequest = Rodin2p5FastImageToMeshInput; + type RawResponse = Rodin2p5FastImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + image_urls: self.image_urls.clone(), + prompt: self.prompt.clone(), + use_original_alpha: self.use_original_alpha, + tier: self.tier.map(|t| t.to_str().to_string()), + seed: self.seed, + geometry_file_format: self.geometry_file_format.map(|f| f.to_str().to_string()), + material: self.material.map(|m| m.to_str().to_string()), + quality_mesh_option: self.quality_mesh_option.map(|q| q.to_str().to_string()), + texture_mode: self.texture_mode.map(|t| t.to_str().to_string()), + enable_creative_mode: self.enable_creative_mode, + hd_texture: self.hd_texture, + texture_delight: self.texture_delight, + is_micro: self.is_micro, + ta_pose: self.ta_pose, + bbox_condition: self.bbox_condition.clone(), + preview_render: self.preview_render, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + fn base_request() -> Rodin2p5FastImageToMeshRequest { + Rodin2p5FastImageToMeshRequest { + image_urls: vec!["https://example.com/input.jpg".to_string()], + prompt: None, + use_original_alpha: None, + tier: None, + seed: None, + geometry_file_format: None, + material: None, + quality_mesh_option: None, + texture_mode: None, + enable_creative_mode: None, + hd_texture: None, + texture_delight: None, + is_micro: None, + ta_pose: None, + bbox_condition: None, + preview_render: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Rodin2p5FastImageToMeshRequest { + image_urls: vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()], + ..base_request() + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Rodin2p5FastImageToMeshRequest { + image_urls: vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()], + ..base_request() + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_core_fields() { + let request = Rodin2p5FastImageToMeshRequest { + prompt: Some("a robot".to_string()), + use_original_alpha: Some(true), + tier: Some(Rodin2p5FastTier::Minimum), + quality_mesh_option: Some(Rodin2p5FastQualityMeshOption::Triangle20k), + ta_pose: Some(true), + preview_render: Some(true), + ..base_request() + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json["image_urls"], serde_json::json!(["https://example.com/input.jpg"])); + assert_eq!(json["prompt"], "a robot"); + assert_eq!(json["use_original_alpha"], true); + assert_eq!(json["tier"], "Gen-2.5-Minimum"); + assert_eq!(json["quality_mesh_option"], "20K Triangle"); + assert_eq!(json["TAPose"], true); + assert_eq!(json["preview_render"], true); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let json = serde_json::to_value(base_request().to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "image_urls": ["https://example.com/input.jpg"] }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Rodin2p5FastImageToMeshRequest::ENDPOINT, "fal-ai/hyper3d/rodin/v2.5/fast"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/cost.rs new file mode 100644 index 00000000..74c27426 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/cost.rs @@ -0,0 +1,44 @@ +use crate::requests::api::mesh::image::rodin_2p5_fast_image_to_mesh::api::Rodin2p5FastImageToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Rodin2p5FastImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hyper3d/rodin/v2.5/fast): + // "Your request will cost $0.1 per generation." + 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::api::Rodin2p5FastMaterial; + + #[test] + fn flat_cost_regardless_of_options() { + let mut request = Rodin2p5FastImageToMeshRequest { + image_urls: vec!["https://example.com/input.jpg".to_string()], + prompt: None, + use_original_alpha: None, + tier: None, + seed: None, + geometry_file_format: None, + material: None, + quality_mesh_option: None, + texture_mode: None, + enable_creative_mode: None, + hd_texture: None, + texture_delight: None, + is_micro: None, + ta_pose: None, + bbox_condition: None, + preview_render: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 10); + + request.material = Some(Rodin2p5FastMaterial::Pbr); + request.hd_texture = Some(true); + request.image_urls.push("https://example.com/second.jpg".to_string()); + assert_eq!(request.calculate_cost_in_cents(), 10); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..53e10de6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/rodin_2p5_fast_image_to_mesh/raw_request.rs @@ -0,0 +1,76 @@ +use serde::{Deserialize, Serialize}; + +use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::raw_request::Rodin2p5FastBboxCondition; + +/// Over-the-wire input shape for `fal-ai/hyper3d/rodin/v2.5/fast` +/// (image-to-3D mode). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Rodin2p5FastImageToMeshInput { + /// Up to 5 input images for image-to-3D. + pub image_urls: Vec, + + /// Optional guidance prompt. Auto-generated from images when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt: Option, + + /// Preserve the transparency channel of the input. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub use_original_alpha: Option, + + /// Options: "Gen-2.5-Minimum", "Gen-2.5-Extreme-Low", "Gen-2.5-Low". + /// fal default: "Gen-2.5-Extreme-Low". + #[serde(skip_serializing_if = "Option::is_none")] + pub tier: Option, + + /// Range 0-65535. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Options: "glb", "usdz", "fbx", "obj", "stl". fal default: "glb". + #[serde(skip_serializing_if = "Option::is_none")] + pub geometry_file_format: Option, + + /// Options: "PBR", "Shaded", "All", "None". fal default: "Shaded". + #[serde(skip_serializing_if = "Option::is_none")] + pub material: Option, + + /// See the text binding for the full option list. fal default: "Auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub quality_mesh_option: Option, + + /// Options: "legacy", "extreme-low", "low", "medium", "high". + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_mode: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_creative_mode: Option, + + /// Enhanced texture post-processing. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub hd_texture: Option, + + /// Removes baked lighting from textures. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_delight: Option, + + /// Finer geometric detail. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_micro: Option, + + /// Generate in T/A-pose for rigging/animation. fal default: false. + /// NB: fal's field name is literally "TAPose". + #[serde(rename = "TAPose", skip_serializing_if = "Option::is_none")] + pub ta_pose: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub bbox_condition: Option, + + /// Generate a preview render image. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub preview_render: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Rodin2p5FastImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/api.rs new file mode 100644 index 00000000..9ecade17 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/api.rs @@ -0,0 +1,240 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::tripo3d_h3p1_image_to_mesh::raw_request::{ + Tripo3dH3p1ImageToMeshInput, Tripo3dH3p1ImageToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Tripo3D H3.1 image-to-3D. +#[derive(Clone, Debug)] +pub struct Tripo3dH3p1ImageToMeshRequest { + /// URL of the input image (required). + pub image_url: String, + + /// Maximum face count. Range 1000-2000000; adaptive when `None`. + pub face_limit: Option, + + /// Enable texture generation. fal's default is true when `None`. + /// Disabling drops to the cheaper no-texture price tier. + pub texture: Option, + + /// Enable PBR materials (implies texture). fal's default is true when `None`. + pub pbr: Option, + + /// Seed for geometry reproducibility. + pub model_seed: Option, + + /// Seed for texture reproducibility. + pub texture_seed: Option, + + /// Texture quality. `Detailed` bills at the HD-texture price tier. + /// fal's default is `Standard` when `None`. + pub texture_quality: Option, + + /// Geometry quality. `Detailed` adds cost. fal's default is `Standard`. + pub geometry_quality: Option, + + /// How textures align to the source. fal's default is `OriginalImage`. + pub texture_alignment: Option, + + /// Auto-scale the model to real-world dimensions (meters). fal default: false. + pub auto_size: Option, + + /// Model orientation. fal's default is `Default` when `None`. + pub orientation: Option, + + /// Generate quad mesh topology instead of triangles (returns FBX). + /// Adds cost. fal's default is false when `None`. + pub quad: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Tripo3dH3p1ImageTextureQuality { + Standard, + Detailed, +} + +impl Tripo3dH3p1ImageTextureQuality { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Standard => "standard", + Self::Detailed => "detailed", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Tripo3dH3p1ImageGeometryQuality { + Standard, + Detailed, +} + +impl Tripo3dH3p1ImageGeometryQuality { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Standard => "standard", + Self::Detailed => "detailed", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Tripo3dH3p1TextureAlignment { + OriginalImage, + Geometry, +} + +impl Tripo3dH3p1TextureAlignment { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::OriginalImage => "original_image", + Self::Geometry => "geometry", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Tripo3dH3p1Orientation { + Default, + AlignImage, +} + +impl Tripo3dH3p1Orientation { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Default => "default", + Self::AlignImage => "align_image", + } + } +} + +impl FalEndpoint for Tripo3dH3p1ImageToMeshRequest { + const ENDPOINT: &str = "tripo3d/h3.1/image-to-3d"; + + type RawRequest = Tripo3dH3p1ImageToMeshInput; + type RawResponse = Tripo3dH3p1ImageToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + image_url: self.image_url.clone(), + face_limit: self.face_limit, + texture: self.texture, + pbr: self.pbr, + model_seed: self.model_seed, + texture_seed: self.texture_seed, + texture_quality: self.texture_quality.map(|q| q.to_str().to_string()), + geometry_quality: self.geometry_quality.map(|q| q.to_str().to_string()), + texture_alignment: self.texture_alignment.map(|a| a.to_str().to_string()), + auto_size: self.auto_size, + orientation: self.orientation.map(|o| o.to_str().to_string()), + quad: self.quad, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + fn base_request() -> Tripo3dH3p1ImageToMeshRequest { + Tripo3dH3p1ImageToMeshRequest { + image_url: "https://example.com/input.jpg".to_string(), + face_limit: None, + texture: None, + pbr: None, + model_seed: None, + texture_seed: None, + texture_quality: None, + geometry_quality: None, + texture_alignment: None, + auto_size: None, + orientation: None, + quad: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Tripo3dH3p1ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Tripo3dH3p1ImageToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Tripo3dH3p1ImageToMeshRequest { + image_url: "https://example.com/input.jpg".to_string(), + face_limit: Some(50_000), + texture: Some(true), + pbr: Some(false), + model_seed: Some(1), + texture_seed: Some(3), + texture_quality: Some(Tripo3dH3p1ImageTextureQuality::Detailed), + geometry_quality: Some(Tripo3dH3p1ImageGeometryQuality::Detailed), + texture_alignment: Some(Tripo3dH3p1TextureAlignment::Geometry), + auto_size: Some(true), + orientation: Some(Tripo3dH3p1Orientation::AlignImage), + quad: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "image_url": "https://example.com/input.jpg", + "face_limit": 50_000, + "texture": true, + "pbr": false, + "model_seed": 1, + "texture_seed": 3, + "texture_quality": "detailed", + "geometry_quality": "detailed", + "texture_alignment": "geometry", + "auto_size": true, + "orientation": "align_image", + "quad": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let json = serde_json::to_value(base_request().to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "image_url": "https://example.com/input.jpg" })); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Tripo3dH3p1ImageToMeshRequest::ENDPOINT, "tripo3d/h3.1/image-to-3d"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/cost.rs new file mode 100644 index 00000000..1516cfb7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/cost.rs @@ -0,0 +1,110 @@ +use crate::requests::api::mesh::image::tripo3d_h3p1_image_to_mesh::api::{ + Tripo3dH3p1ImageGeometryQuality, Tripo3dH3p1ImageTextureQuality, Tripo3dH3p1ImageToMeshRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Tripo3dH3p1ImageToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/tripo3d/h3.1/image-to-3d): + // "Your request will cost $0.20 (without textures), $0.30 (with standard + // textures), or $0.40 (with HD textures), plus an additional $0.20 for + // detailed geometry and $0.05 for quad mesh if selected." + // + // NB: the image endpoint's texture tiers are 10¢ above the text/multiview + // endpoints'. `texture` defaults to true → standard tier is the default. + // `pbr` implies texturing and ALSO defaults to true, so the cheap + // untextured tier only applies when both `texture` and `pbr` are + // explicitly disabled. Anything else may texture server-side; bill the + // textured tier so we never undercharge. + let texture_enabled = self.texture.unwrap_or(true) || self.pbr.unwrap_or(true); + let mut cost: u64 = if !texture_enabled { + 20 + } else { + match self.texture_quality { + Some(Tripo3dH3p1ImageTextureQuality::Detailed) => 40, + None | Some(Tripo3dH3p1ImageTextureQuality::Standard) => 30, + } + }; + if matches!(self.geometry_quality, Some(Tripo3dH3p1ImageGeometryQuality::Detailed)) { + cost += 20; + } + if self.quad.unwrap_or(false) { + cost += 5; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Tripo3dH3p1ImageToMeshRequest { + Tripo3dH3p1ImageToMeshRequest { + image_url: "https://example.com/input.jpg".to_string(), + face_limit: None, + texture: None, + pbr: None, + model_seed: None, + texture_seed: None, + texture_quality: None, + geometry_quality: None, + texture_alignment: None, + auto_size: None, + orientation: None, + quad: None, + } + } + + #[test] + fn default_is_standard_textures() { + assert_eq!(base_request().calculate_cost_in_cents(), 30); + } + + #[test] + fn no_texture_requires_pbr_off_too() { + let mut req = base_request(); + req.texture = Some(false); + req.pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 20); + } + + #[test] + fn texture_off_but_pbr_default_bills_textured_tier() { + // `pbr` defaults to true and implies texturing. + let mut req = base_request(); + req.texture = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 30); + } + + #[test] + fn detailed_texture() { + let mut req = base_request(); + req.texture_quality = Some(Tripo3dH3p1ImageTextureQuality::Detailed); + assert_eq!(req.calculate_cost_in_cents(), 40); + } + + #[test] + fn detailed_geometry_adds_twenty() { + let mut req = base_request(); + req.geometry_quality = Some(Tripo3dH3p1ImageGeometryQuality::Detailed); + assert_eq!(req.calculate_cost_in_cents(), 30 + 20); + } + + #[test] + fn quad_adds_five() { + let mut req = base_request(); + req.quad = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 30 + 5); + } + + #[test] + fn everything_stacks() { + let mut req = base_request(); + req.texture_quality = Some(Tripo3dH3p1ImageTextureQuality::Detailed); + req.geometry_quality = Some(Tripo3dH3p1ImageGeometryQuality::Detailed); + req.quad = Some(true); + // 40 + 20 + 5 = 65 + assert_eq!(req.calculate_cost_in_cents(), 65); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/raw_request.rs new file mode 100644 index 00000000..17a77312 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/image/tripo3d_h3p1_image_to_mesh/raw_request.rs @@ -0,0 +1,54 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `tripo3d/h3.1/image-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Tripo3dH3p1ImageToMeshInput { + /// URL of the input image. + pub image_url: String, + + /// Range 1000-2000000. Adaptive when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_limit: Option, + + /// Enable texture generation. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture: Option, + + /// Enable PBR materials (implies texture). fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub pbr: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_seed: Option, + + /// Options: "standard", "detailed". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_quality: Option, + + /// Options: "standard", "detailed". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub geometry_quality: Option, + + /// Options: "original_image", "geometry". fal default: "original_image". + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_alignment: Option, + + /// Auto-scale the model to real-world dimensions (meters). fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_size: Option, + + /// Options: "default", "align_image". fal default: "default". + #[serde(skip_serializing_if = "Option::is_none")] + pub orientation: Option, + + /// Generate quad mesh topology instead of triangles. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub quad: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Tripo3dH3p1ImageToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/mod.rs new file mode 100644 index 00000000..41b07483 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/mod.rs @@ -0,0 +1,6 @@ +pub mod image; +pub mod multiview; +pub mod part; +pub mod sketch; +pub mod text; +pub mod topology; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/multiview/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/mod.rs new file mode 100644 index 00000000..5548eb02 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/mod.rs @@ -0,0 +1 @@ +pub mod tripo3d_h3p1_multiview_to_mesh; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/api.rs new file mode 100644 index 00000000..cc5b44af --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/api.rs @@ -0,0 +1,181 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::image::tripo3d_h3p1_image_to_mesh::api::{ + Tripo3dH3p1ImageGeometryQuality, Tripo3dH3p1ImageTextureQuality, Tripo3dH3p1Orientation, + Tripo3dH3p1TextureAlignment, +}; +use crate::requests::api::mesh::multiview::tripo3d_h3p1_multiview_to_mesh::raw_request::{ + Tripo3dH3p1MultiviewToMeshInput, Tripo3dH3p1MultiviewToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Tripo3D H3.1 multiview-to-3D: reconstructs a mesh from 2-4 views of the +/// same object. Shares its option enums with the single-image binding. +#[derive(Clone, Debug)] +pub struct Tripo3dH3p1MultiviewToMeshRequest { + /// 2 to 4 image URLs of the same object from different angles. + /// Order: [front, left, back, right]. + pub image_urls: Vec, + + /// Maximum face count. Range 1000-2000000; adaptive when `None`. + pub face_limit: Option, + + /// Enable texture generation. fal's default is true when `None`. + /// Disabling drops to the cheaper no-texture price tier. + pub texture: Option, + + /// Enable PBR materials (implies texture). fal's default is true when `None`. + pub pbr: Option, + + /// Seed for geometry reproducibility. + pub model_seed: Option, + + /// Seed for texture reproducibility. + pub texture_seed: Option, + + /// Texture quality. `Detailed` bills at the HD-texture price tier. + pub texture_quality: Option, + + /// Geometry quality. `Detailed` adds cost. + pub geometry_quality: Option, + + /// How textures align to the source. fal's default is `OriginalImage`. + pub texture_alignment: Option, + + /// Auto-scale the model to real-world dimensions (meters). fal default: false. + pub auto_size: Option, + + /// Model orientation. fal's default is `Default` when `None`. + pub orientation: Option, + + /// Generate quad mesh topology instead of triangles (returns FBX). + /// Adds cost. fal's default is false when `None`. + pub quad: Option, +} + +impl FalEndpoint for Tripo3dH3p1MultiviewToMeshRequest { + const ENDPOINT: &str = "tripo3d/h3.1/multiview-to-3d"; + + type RawRequest = Tripo3dH3p1MultiviewToMeshInput; + type RawResponse = Tripo3dH3p1MultiviewToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + image_urls: self.image_urls.clone(), + face_limit: self.face_limit, + texture: self.texture, + pbr: self.pbr, + model_seed: self.model_seed, + texture_seed: self.texture_seed, + texture_quality: self.texture_quality.map(|q| q.to_str().to_string()), + geometry_quality: self.geometry_quality.map(|q| q.to_str().to_string()), + texture_alignment: self.texture_alignment.map(|a| a.to_str().to_string()), + auto_size: self.auto_size, + orientation: self.orientation.map(|o| o.to_str().to_string()), + quad: self.quad, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, JUNO_AT_LAKE_IMAGE_URL}; + + fn base_request() -> Tripo3dH3p1MultiviewToMeshRequest { + Tripo3dH3p1MultiviewToMeshRequest { + image_urls: vec![ + "https://example.com/front.jpg".to_string(), + "https://example.com/left.jpg".to_string(), + ], + face_limit: None, + texture: None, + pbr: None, + model_seed: None, + texture_seed: None, + texture_quality: None, + geometry_quality: None, + texture_alignment: None, + auto_size: None, + orientation: None, + quad: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_multiview_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Tripo3dH3p1MultiviewToMeshRequest { + image_urls: vec![ + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + ..base_request() + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_multiview_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Tripo3dH3p1MultiviewToMeshRequest { + image_urls: vec![ + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + ..base_request() + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_core_fields() { + let request = Tripo3dH3p1MultiviewToMeshRequest { + texture_quality: Some(Tripo3dH3p1ImageTextureQuality::Detailed), + quad: Some(true), + ..base_request() + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "image_urls": ["https://example.com/front.jpg", "https://example.com/left.jpg"], + "texture_quality": "detailed", + "quad": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let json = serde_json::to_value(base_request().to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "image_urls": ["https://example.com/front.jpg", "https://example.com/left.jpg"], + }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Tripo3dH3p1MultiviewToMeshRequest::ENDPOINT, "tripo3d/h3.1/multiview-to-3d"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/cost.rs new file mode 100644 index 00000000..a3eacb91 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/cost.rs @@ -0,0 +1,107 @@ +use crate::requests::api::mesh::image::tripo3d_h3p1_image_to_mesh::api::{ + Tripo3dH3p1ImageGeometryQuality, Tripo3dH3p1ImageTextureQuality, +}; +use crate::requests::api::mesh::multiview::tripo3d_h3p1_multiview_to_mesh::api::Tripo3dH3p1MultiviewToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Tripo3dH3p1MultiviewToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/tripo3d/h3.1/multiview-to-3d): + // "Your request will cost $0.10 (without textures), $0.20 (with standard + // textures), or $0.30 (with HD textures), plus an additional $0.20 for + // detailed geometry and $0.05 for quad mesh if selected." + // + // Same tiers as text-to-3d (NOT the +10¢ image-to-3d tiers). + // `pbr` implies texturing and ALSO defaults to true, so the cheap + // untextured tier only applies when both `texture` and `pbr` are + // explicitly disabled. Anything else may texture server-side; bill the + // textured tier so we never undercharge. + let texture_enabled = self.texture.unwrap_or(true) || self.pbr.unwrap_or(true); + let mut cost: u64 = if !texture_enabled { + 10 + } else { + match self.texture_quality { + Some(Tripo3dH3p1ImageTextureQuality::Detailed) => 30, + None | Some(Tripo3dH3p1ImageTextureQuality::Standard) => 20, + } + }; + if matches!(self.geometry_quality, Some(Tripo3dH3p1ImageGeometryQuality::Detailed)) { + cost += 20; + } + if self.quad.unwrap_or(false) { + cost += 5; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Tripo3dH3p1MultiviewToMeshRequest { + Tripo3dH3p1MultiviewToMeshRequest { + image_urls: vec![ + "https://example.com/front.jpg".to_string(), + "https://example.com/left.jpg".to_string(), + ], + face_limit: None, + texture: None, + pbr: None, + model_seed: None, + texture_seed: None, + texture_quality: None, + geometry_quality: None, + texture_alignment: None, + auto_size: None, + orientation: None, + quad: None, + } + } + + #[test] + fn default_is_standard_textures() { + assert_eq!(base_request().calculate_cost_in_cents(), 20); + } + + #[test] + fn no_texture_requires_pbr_off_too() { + let mut req = base_request(); + req.texture = Some(false); + req.pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 10); + } + + #[test] + fn texture_off_but_pbr_default_bills_textured_tier() { + // `pbr` defaults to true and implies texturing. + let mut req = base_request(); + req.texture = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 20); + } + + #[test] + fn detailed_texture() { + let mut req = base_request(); + req.texture_quality = Some(Tripo3dH3p1ImageTextureQuality::Detailed); + assert_eq!(req.calculate_cost_in_cents(), 30); + } + + #[test] + fn image_count_does_not_change_cost() { + let mut req = base_request(); + req.image_urls.push("https://example.com/back.jpg".to_string()); + req.image_urls.push("https://example.com/right.jpg".to_string()); + assert_eq!(req.calculate_cost_in_cents(), 20); + } + + #[test] + fn everything_stacks() { + let mut req = base_request(); + req.texture_quality = Some(Tripo3dH3p1ImageTextureQuality::Detailed); + req.geometry_quality = Some(Tripo3dH3p1ImageGeometryQuality::Detailed); + req.quad = Some(true); + // 30 + 20 + 5 = 55 + assert_eq!(req.calculate_cost_in_cents(), 55); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/raw_request.rs new file mode 100644 index 00000000..a774b33c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/multiview/tripo3d_h3p1_multiview_to_mesh/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `tripo3d/h3.1/multiview-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Tripo3dH3p1MultiviewToMeshInput { + /// 2 to 4 image URLs of the same object from different angles. + /// Order: [front, left, back, right]. + pub image_urls: Vec, + + /// Range 1000-2000000. Adaptive when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_limit: Option, + + /// Enable texture generation. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture: Option, + + /// Enable PBR materials (implies texture). fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub pbr: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_seed: Option, + + /// Options: "standard", "detailed". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_quality: Option, + + /// Options: "standard", "detailed". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub geometry_quality: Option, + + /// Options: "original_image", "geometry". fal default: "original_image". + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_alignment: Option, + + /// Auto-scale the model to real-world dimensions (meters). fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_size: Option, + + /// Options: "default", "align_image". fal default: "default". + #[serde(skip_serializing_if = "Option::is_none")] + pub orientation: Option, + + /// Generate quad mesh topology instead of triangles. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub quad: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Tripo3dH3p1MultiviewToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/api.rs new file mode 100644 index 00000000..c69b1fae --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/api.rs @@ -0,0 +1,87 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::part::hunyuan_3d_3p1_part::raw_request::{ + Hunyuan3d3p1PartInput, Hunyuan3d3p1PartOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan 3D v3.1 Part: splits an existing 3D mesh into semantically +/// meaningful parts (returned as a list of FBX files). +/// +/// Input constraints: FBX only, max 100MB, face count ≤ 30,000. Designed for +/// AIGC-generated models. +#[derive(Clone, Debug)] +pub struct Hunyuan3d3p1PartRequest { + /// URL of the input mesh file (FBX). + pub input_file_url: String, +} + +impl FalEndpoint for Hunyuan3d3p1PartRequest { + const ENDPOINT: &str = "fal-ai/hunyuan-3d/v3.1/part"; + + type RawRequest = Hunyuan3d3p1PartInput; + type RawResponse = Hunyuan3d3p1PartOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + input_file_url: self.input_file_url.clone(), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost; needs a real FBX URL + async fn test_part_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1PartRequest { + input_file_url: "https://example.com/model.fbx".to_string(), + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost; needs a real FBX URL + async fn test_part_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1PartRequest { + input_file_url: "https://example.com/model.fbx".to_string(), + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_is_just_input_file_url() { + let request = Hunyuan3d3p1PartRequest { + input_file_url: "https://example.com/model.fbx".to_string(), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_file_url": "https://example.com/model.fbx" }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Hunyuan3d3p1PartRequest::ENDPOINT, "fal-ai/hunyuan-3d/v3.1/part"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/cost.rs new file mode 100644 index 00000000..f965b41a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/cost.rs @@ -0,0 +1,23 @@ +use crate::requests::api::mesh::part::hunyuan_3d_3p1_part::api::Hunyuan3d3p1PartRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3p1PartRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan-3d/v3.1/part): + // "Your request will cost $0.45 per generation." + 45 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn flat_cost() { + let request = Hunyuan3d3p1PartRequest { + input_file_url: "https://example.com/model.fbx".to_string(), + }; + assert_eq!(request.calculate_cost_in_cents(), 45); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/raw_request.rs new file mode 100644 index 00000000..ec0d0cea --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/part/hunyuan_3d_3p1_part/raw_request.rs @@ -0,0 +1,13 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan-3d/v3.1/part`. +/// Splits a 3D mesh into semantically meaningful parts. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3p1PartInput { + /// URL of the input mesh. FBX only, max 100MB, face count ≤ 30,000. + pub input_file_url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3p1PartOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/part/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/part/mod.rs new file mode 100644 index 00000000..59ba9c6b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/part/mod.rs @@ -0,0 +1 @@ +pub mod hunyuan_3d_3p1_part; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/api.rs new file mode 100644 index 00000000..3cd24e27 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/api.rs @@ -0,0 +1,142 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::sketch::hunyuan3d_3_sketch_to_mesh::raw_request::{ + Hunyuan3d3SketchToMeshInput, Hunyuan3d3SketchToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan3D V3 sketch-to-3D: turns a sketch or line-art image plus a text +/// prompt into a textured 3D mesh. +/// +/// NB: unlike the v3 image-to-3d and text-to-3d endpoints, fal's published +/// sketch-to-3d schema has no `generate_type` or `polygon_type` parameters. +#[derive(Clone, Debug)] +pub struct Hunyuan3d3SketchToMeshRequest { + /// URL of the sketch or line-art image. Resolution must be between + /// 128x128 and 5000x5000 pixels. + pub image_url: String, + + /// Text prompt describing the 3D content attributes such as color, + /// category, and material. + pub prompt: String, + + /// Target face count for the output mesh. Range 40000-1500000; + /// fal's default is 500000 when `None`. Setting a custom value adds cost. + pub face_count: Option, + + /// Whether to enable PBR (physically-based rendering) materials. + /// fal's default is false when `None`. Enabling adds cost. + pub enable_pbr: Option, +} + +impl FalEndpoint for Hunyuan3d3SketchToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan3d-v3/sketch-to-3d"; + + type RawRequest = Hunyuan3d3SketchToMeshInput; + type RawResponse = Hunyuan3d3SketchToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + input_image_url: self.image_url.clone(), + prompt: self.prompt.clone(), + face_count: self.face_count, + enable_pbr: self.enable_pbr, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_sketch_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d3SketchToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + prompt: "A cute robot".to_string(), + face_count: None, + enable_pbr: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_sketch_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d3SketchToMeshRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + prompt: "A cute robot".to_string(), + face_count: None, + enable_pbr: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3SketchToMeshRequest { + image_url: "https://example.com/sketch.png".to_string(), + prompt: "A red ceramic teapot".to_string(), + face_count: Some(100_000), + enable_pbr: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/sketch.png", + "prompt": "A red ceramic teapot", + "face_count": 100_000, + "enable_pbr": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3SketchToMeshRequest { + image_url: "https://example.com/sketch.png".to_string(), + prompt: "minimal".to_string(), + face_count: None, + enable_pbr: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_image_url": "https://example.com/sketch.png", + "prompt": "minimal", + }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Hunyuan3d3SketchToMeshRequest::ENDPOINT, "fal-ai/hunyuan3d-v3/sketch-to-3d"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/cost.rs new file mode 100644 index 00000000..7ab955a2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/cost.rs @@ -0,0 +1,78 @@ +use crate::requests::api::mesh::sketch::hunyuan3d_3_sketch_to_mesh::api::Hunyuan3d3SketchToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3SketchToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan3d-v3/sketch-to-3d): + // "Your request will cost $0.375 per generation." + // + // Base: $0.375 → 38¢ (rounded up). Sketch-to-3d has no generate_type + // parameter, so the LowPoly/Geometry prices of the other v3 endpoints + // do not apply here. + // + // Add-ons (each +$0.15 = 15¢): + // - PBR materials enabled + // - Custom face count specified + let mut cost: u64 = 38; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod cost_table { + use super::*; + + #[test] + fn base_cost() { + assert_eq!(base_request().calculate_cost_in_cents(), 38); + } + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn pbr_false_no_extra() { + let mut req = base_request(); + req.enable_pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + + #[test] + fn face_count_adds_fifteen() { + let mut req = base_request(); + req.face_count = Some(50_000); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn all_add_ons_stack() { + let mut req = base_request(); + req.enable_pbr = Some(true); + req.face_count = Some(100_000); + // Base(38) + PBR(15) + face_count(15) = 68 + assert_eq!(req.calculate_cost_in_cents(), 68); + } + } + + fn base_request() -> Hunyuan3d3SketchToMeshRequest { + Hunyuan3d3SketchToMeshRequest { + image_url: "https://example.com/sketch.png".to_string(), + prompt: "test".to_string(), + face_count: None, + enable_pbr: None, + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/raw_request.rs new file mode 100644 index 00000000..cb3d700a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/hunyuan3d_3_sketch_to_mesh/raw_request.rs @@ -0,0 +1,28 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan3d-v3/sketch-to-3d`. +/// fal's schema: +/// +/// NB: unlike the v3 image-to-3d and text-to-3d endpoints, fal's published +/// sketch-to-3d schema has no `generate_type` or `polygon_type` parameters. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3SketchToMeshInput { + /// URL of the sketch or line-art image to transform into a 3D model. + /// Image resolution must be between 128x128 and 5000x5000 pixels. + pub input_image_url: String, + + /// Text prompt describing the 3D content attributes such as color, + /// category, and material. + pub prompt: String, + + /// Target face count. Range: 40000-1500000. fal default: 500000. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + /// Whether to enable PBR material generation. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3SketchToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/sketch/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/mod.rs new file mode 100644 index 00000000..b3d854f8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/sketch/mod.rs @@ -0,0 +1 @@ +pub mod hunyuan3d_3_sketch_to_mesh; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/api.rs new file mode 100644 index 00000000..b9f49c05 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/api.rs @@ -0,0 +1,194 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::text::hunyuan3d_3_text_to_mesh::raw_request::{ + Hunyuan3d3TextToMeshInput, Hunyuan3d3TextToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Hunyuan3d3TextToMeshRequest { + /// Text prompt describing the 3D object to generate. + pub prompt: String, + + /// Target face count for the output mesh. + pub face_count: Option, + + /// Generation type. + pub generate_type: Option, + + /// Polygon type for the output mesh. + pub polygon_type: Option, + + /// Whether to enable PBR (physically-based rendering) materials. + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3TextToMeshGenerateType { + Normal, + LowPoly, + Geometry, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3TextToMeshPolygonType { + Triangle, + Quadrilateral, +} + +impl FalEndpoint for Hunyuan3d3TextToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan3d-v3/text-to-3d"; + + type RawRequest = Hunyuan3d3TextToMeshInput; + type RawResponse = Hunyuan3d3TextToMeshOutput; + + fn to_raw_request(&self) -> Result { + let generate_type = self.generate_type.map(|t| match t { + Hunyuan3d3TextToMeshGenerateType::Normal => "Normal", + Hunyuan3d3TextToMeshGenerateType::LowPoly => "LowPoly", + Hunyuan3d3TextToMeshGenerateType::Geometry => "Geometry", + }.to_string()); + + let polygon_type = self.polygon_type.map(|t| match t { + Hunyuan3d3TextToMeshPolygonType::Triangle => "triangle", + Hunyuan3d3TextToMeshPolygonType::Quadrilateral => "quadrilateral", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + face_count: self.face_count, + generate_type, + polygon_type, + enable_pbr: self.enable_pbr, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d3TextToMeshRequest { + prompt: "A velociraptor with an open mouth full of sharp teeth. Large claws, ready to strike.".to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Hunyuan3d3TextToMeshRequest { + prompt: "A velociraptor with an open mouth full of sharp teeth. Large claws, ready to strike.".to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3TextToMeshRequest { + prompt: "A red ceramic teapot".to_string(), + face_count: Some(100_000), + generate_type: Some(Hunyuan3d3TextToMeshGenerateType::LowPoly), + polygon_type: Some(Hunyuan3d3TextToMeshPolygonType::Quadrilateral), + enable_pbr: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "A red ceramic teapot", + "face_count": 100_000, + "generate_type": "LowPoly", + "polygon_type": "quadrilateral", + "enable_pbr": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3TextToMeshRequest { + prompt: "minimal".to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn every_generate_type_maps_to_wire_string() { + for (variant, expected) in [ + (Hunyuan3d3TextToMeshGenerateType::Normal, "Normal"), + (Hunyuan3d3TextToMeshGenerateType::LowPoly, "LowPoly"), + (Hunyuan3d3TextToMeshGenerateType::Geometry, "Geometry"), + ] { + let mut request = base_wire_request(); + request.generate_type = Some(variant); + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.generate_type.as_deref(), Some(expected)); + } + } + + #[test] + fn every_polygon_type_maps_to_wire_string() { + for (variant, expected) in [ + (Hunyuan3d3TextToMeshPolygonType::Triangle, "triangle"), + (Hunyuan3d3TextToMeshPolygonType::Quadrilateral, "quadrilateral"), + ] { + let mut request = base_wire_request(); + request.polygon_type = Some(variant); + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.polygon_type.as_deref(), Some(expected)); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Hunyuan3d3TextToMeshRequest::ENDPOINT, "fal-ai/hunyuan3d-v3/text-to-3d"); + } + + // NB: Pricing tests are in cost.rs + + fn base_wire_request() -> Hunyuan3d3TextToMeshRequest { + Hunyuan3d3TextToMeshRequest { + prompt: "test".to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/cost.rs new file mode 100644 index 00000000..e85b8ca4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/cost.rs @@ -0,0 +1,122 @@ +use crate::requests::api::mesh::text::hunyuan3d_3_text_to_mesh::api::{ + Hunyuan3d3TextToMeshGenerateType, Hunyuan3d3TextToMeshRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3TextToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Base cost by generation type: + // Normal: $0.375 → 38¢ (rounded up) + // LowPoly: $0.45 → 45¢ + // Geometry: $0.225 → 23¢ (rounded up) + // + // Add-ons (each +$0.15 = 15¢): + // - PBR materials enabled + // - Custom face count specified + // + // Note: text-to-mesh has no multi-view add-on (no image inputs). + let mut cost: u64 = match self.generate_type { + None => 38, + Some(Hunyuan3d3TextToMeshGenerateType::Normal) => 38, + Some(Hunyuan3d3TextToMeshGenerateType::Geometry) => 23, + Some(Hunyuan3d3TextToMeshGenerateType::LowPoly) => 45, + }; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Hunyuan3d3TextToMeshRequest { + Hunyuan3d3TextToMeshRequest { + prompt: "test".to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + } + } + + mod base_costs { + use super::*; + + #[test] + fn default_generate_type() { + assert_eq!(base_request().calculate_cost_in_cents(), 38); + } + + #[test] + fn normal() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3TextToMeshGenerateType::Normal); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + + #[test] + fn low_poly() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3TextToMeshGenerateType::LowPoly); + assert_eq!(req.calculate_cost_in_cents(), 45); + } + + #[test] + fn geometry() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3TextToMeshGenerateType::Geometry); + assert_eq!(req.calculate_cost_in_cents(), 23); + } + } + + mod add_ons { + use super::*; + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn pbr_false_no_extra() { + let mut req = base_request(); + req.enable_pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + + #[test] + fn face_count_adds_fifteen() { + let mut req = base_request(); + req.face_count = Some(50_000); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn all_add_ons_stack() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3TextToMeshGenerateType::LowPoly); + req.enable_pbr = Some(true); + req.face_count = Some(100_000); + // LowPoly(45) + PBR(15) + face_count(15) = 75 + assert_eq!(req.calculate_cost_in_cents(), 75); + } + + #[test] + fn geometry_with_all_add_ons() { + let mut req = base_request(); + req.generate_type = Some(Hunyuan3d3TextToMeshGenerateType::Geometry); + req.enable_pbr = Some(true); + req.face_count = Some(10_000); + // Geometry(23) + PBR(15) + face_count(15) = 53 + assert_eq!(req.calculate_cost_in_cents(), 53); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/raw_request.rs new file mode 100644 index 00000000..ac199a44 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan3d_3_text_to_mesh/raw_request.rs @@ -0,0 +1,23 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3TextToMeshInput { + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + /// Options: "Normal", "LowPoly", "Geometry" + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Options: "triangle", "quadrilateral" + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_type: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3TextToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/api.rs new file mode 100644 index 00000000..f235bebd --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/api.rs @@ -0,0 +1,140 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::text::hunyuan_3d_3p1_pro_text_to_mesh::raw_request::{ + Hunyuan3d3p1ProTextToMeshInput, Hunyuan3d3p1ProTextToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan 3D v3.1 Pro text-to-3D. +/// +/// NB: v3.1 drops the v3 `LowPoly` generation type (only Normal/Geometry) and +/// has no `polygon_type` parameter. +#[derive(Clone, Debug)] +pub struct Hunyuan3d3p1ProTextToMeshRequest { + /// Text prompt describing the 3D object (max 1024 UTF-8 characters). + pub prompt: String, + + /// Generation type. fal's default is `Normal` when `None`. + pub generate_type: Option, + + /// Target face count for the output mesh. Range 40000-1500000; + /// fal's default is 500000 when `None`. Setting a custom value adds cost. + pub face_count: Option, + + /// Whether to enable PBR (physically-based rendering) materials. + /// fal's default is false when `None`. Enabling adds cost. + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3p1ProTextToMeshGenerateType { + Normal, + Geometry, +} + +impl FalEndpoint for Hunyuan3d3p1ProTextToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan-3d/v3.1/pro/text-to-3d"; + + type RawRequest = Hunyuan3d3p1ProTextToMeshInput; + type RawResponse = Hunyuan3d3p1ProTextToMeshOutput; + + fn to_raw_request(&self) -> Result { + let generate_type = self.generate_type.map(|t| match t { + Hunyuan3d3p1ProTextToMeshGenerateType::Normal => "Normal", + Hunyuan3d3p1ProTextToMeshGenerateType::Geometry => "Geometry", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + generate_type, + face_count: self.face_count, + enable_pbr: self.enable_pbr, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1ProTextToMeshRequest { + prompt: "a small ceramic teapot with a bamboo handle".to_string(), + generate_type: None, + face_count: None, + enable_pbr: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1ProTextToMeshRequest { + prompt: "a wooden rocking chair".to_string(), + generate_type: None, + face_count: None, + enable_pbr: None, + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3p1ProTextToMeshRequest { + prompt: "p".to_string(), + generate_type: Some(Hunyuan3d3p1ProTextToMeshGenerateType::Geometry), + face_count: Some(100_000), + enable_pbr: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "p", + "generate_type": "Geometry", + "face_count": 100_000, + "enable_pbr": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3p1ProTextToMeshRequest { + prompt: "p".to_string(), + generate_type: None, + face_count: None, + enable_pbr: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "p" })); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Hunyuan3d3p1ProTextToMeshRequest::ENDPOINT, + "fal-ai/hunyuan-3d/v3.1/pro/text-to-3d", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/cost.rs new file mode 100644 index 00000000..28e4da05 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/cost.rs @@ -0,0 +1,77 @@ +use crate::requests::api::mesh::text::hunyuan_3d_3p1_pro_text_to_mesh::api::Hunyuan3d3p1ProTextToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3p1ProTextToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan-3d/v3.1/pro/text-to-3d): + // "Your request will cost $0.375 per generation. Enabling PBR materials + // adds $0.15. Using multi-view images adds $0.15. Custom face count + // adds $0.15." + // + // Base: $0.375 → 38¢ (rounded up). Unlike v3, the v3.1 pro pricing has no + // per-generation-type price deltas — Geometry bills the same base. + // Text-to-3d has no image inputs, so no multi-view add-on here. + let mut cost: u64 = 38; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::mesh::text::hunyuan_3d_3p1_pro_text_to_mesh::api::Hunyuan3d3p1ProTextToMeshGenerateType; + + fn base_request() -> Hunyuan3d3p1ProTextToMeshRequest { + Hunyuan3d3p1ProTextToMeshRequest { + prompt: "p".to_string(), + generate_type: None, + face_count: None, + enable_pbr: None, + } + } + + #[test] + fn base_cost() { + assert_eq!(base_request().calculate_cost_in_cents(), 38); + } + + #[test] + fn generate_type_does_not_change_cost() { + for t in [ + Hunyuan3d3p1ProTextToMeshGenerateType::Normal, + Hunyuan3d3p1ProTextToMeshGenerateType::Geometry, + ] { + let mut req = base_request(); + req.generate_type = Some(t); + assert_eq!(req.calculate_cost_in_cents(), 38); + } + } + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn face_count_adds_fifteen() { + let mut req = base_request(); + req.face_count = Some(50_000); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15); + } + + #[test] + fn add_ons_stack() { + let mut req = base_request(); + req.enable_pbr = Some(true); + req.face_count = Some(100_000); + assert_eq!(req.calculate_cost_in_cents(), 38 + 15 + 15); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/raw_request.rs new file mode 100644 index 00000000..359f1d35 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_pro_text_to_mesh/raw_request.rs @@ -0,0 +1,23 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan-3d/v3.1/pro/text-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3p1ProTextToMeshInput { + /// Text prompt (max 1024 UTF-8 characters). + pub prompt: String, + + /// Options: "Normal", "Geometry" (no LowPoly on v3.1). + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Range 40000-1500000. fal default: 500000. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3p1ProTextToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/api.rs new file mode 100644 index 00000000..6da03bb4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/api.rs @@ -0,0 +1,117 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::text::hunyuan_3d_3p1_rapid_text_to_mesh::raw_request::{ + Hunyuan3d3p1RapidTextToMeshInput, Hunyuan3d3p1RapidTextToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan 3D v3.1 Rapid text-to-3D — the fast, low-cost tier. +/// +/// NB: the rapid schema is minimal — no `generate_type`, `face_count`, or +/// `polygon_type`. Geometry-only output is a boolean (`enable_geometry`) +/// rather than a generation-type enum. +#[derive(Clone, Debug)] +pub struct Hunyuan3d3p1RapidTextToMeshRequest { + /// Text prompt describing the 3D object (max 200 UTF-8 characters). + pub prompt: String, + + /// Whether to enable PBR (physically-based rendering) materials. + /// fal's default is false when `None`. Enabling adds cost. + pub enable_pbr: Option, + + /// Generate a geometry-only white model without textures. + /// fal's default is false when `None`. Disables PBR output. + pub enable_geometry: Option, +} + +impl FalEndpoint for Hunyuan3d3p1RapidTextToMeshRequest { + const ENDPOINT: &str = "fal-ai/hunyuan-3d/v3.1/rapid/text-to-3d"; + + type RawRequest = Hunyuan3d3p1RapidTextToMeshInput; + type RawResponse = Hunyuan3d3p1RapidTextToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + enable_pbr: self.enable_pbr, + enable_geometry: self.enable_geometry, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1RapidTextToMeshRequest { + prompt: "a small ceramic teapot".to_string(), + enable_pbr: None, + enable_geometry: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1RapidTextToMeshRequest { + prompt: "a wooden rocking chair".to_string(), + enable_pbr: None, + enable_geometry: None, + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3p1RapidTextToMeshRequest { + prompt: "p".to_string(), + enable_pbr: Some(true), + enable_geometry: Some(false), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "enable_pbr": true, "enable_geometry": false }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3p1RapidTextToMeshRequest { + prompt: "p".to_string(), + enable_pbr: None, + enable_geometry: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "p" })); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Hunyuan3d3p1RapidTextToMeshRequest::ENDPOINT, + "fal-ai/hunyuan-3d/v3.1/rapid/text-to-3d", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/cost.rs new file mode 100644 index 00000000..1cc3fc77 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/cost.rs @@ -0,0 +1,49 @@ +use crate::requests::api::mesh::text::hunyuan_3d_3p1_rapid_text_to_mesh::api::Hunyuan3d3p1RapidTextToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3p1RapidTextToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan-3d/v3.1/rapid/text-to-3d): + // "Base generation (text or image to 3D) costs $0.225. Enabling PBR + // materials adds $0.15." + // + // Base: $0.225 → 23¢ (rounded up). + let mut cost: u64 = 23; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Hunyuan3d3p1RapidTextToMeshRequest { + Hunyuan3d3p1RapidTextToMeshRequest { + prompt: "p".to_string(), + enable_pbr: None, + enable_geometry: None, + } + } + + #[test] + fn base_cost() { + assert_eq!(base_request().calculate_cost_in_cents(), 23); + } + + #[test] + fn pbr_adds_fifteen() { + let mut req = base_request(); + req.enable_pbr = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 23 + 15); + } + + #[test] + fn geometry_does_not_change_cost() { + let mut req = base_request(); + req.enable_geometry = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 23); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/raw_request.rs new file mode 100644 index 00000000..ab389f1c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/hunyuan_3d_3p1_rapid_text_to_mesh/raw_request.rs @@ -0,0 +1,20 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan-3d/v3.1/rapid/text-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3p1RapidTextToMeshInput { + /// Text prompt (max 200 UTF-8 characters). + pub prompt: String, + + /// Generate PBR textures (metallic, roughness, normal). fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, + + /// Generate a geometry-only white model without textures. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_geometry: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3p1RapidTextToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/api.rs new file mode 100644 index 00000000..d1f9e728 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/api.rs @@ -0,0 +1,279 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::text::meshy_v6_text_to_mesh::raw_request::{ + MeshyV6TextToMeshInput, MeshyV6TextToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Meshy 6 text-to-3D. +#[derive(Clone, Debug)] +pub struct MeshyV6TextToMeshRequest { + /// Text prompt describing the 3D object (max 600 characters). + pub prompt: String, + + /// Generation mode. fal's default is `Full` when `None`. + pub mode: Option, + + /// Seed for reproducibility. + pub seed: Option, + + /// Model type. fal's default is `Standard` when `None`. + pub model_type: Option, + + /// Mesh topology. fal's default is `Triangle` when `None`. + pub topology: Option, + + /// Target polygon count. Range 100-300000; fal's default is 30000. + pub target_polycount: Option, + + /// Whether to remesh the output. fal's default is true when `None`. + pub should_remesh: Option, + + /// Symmetry mode. fal's default is `Auto` when `None`. + pub symmetry_mode: Option, + + /// Whether to generate PBR materials. fal's default is false when `None`. + pub enable_pbr: Option, + + /// Character pose mode. Unspecified when `None` (fal's default). + pub pose_mode: Option, + + /// Let Meshy expand/rewrite the prompt. fal's default is false when `None`. + pub enable_prompt_expansion: Option, + + /// Optional texture-specific prompt. + pub texture_prompt: Option, + + /// Optional texture reference image URL. + pub texture_image_url: Option, + + /// Rig the generated character. fal's default is false when `None`. + pub enable_rigging: Option, + + /// Character height for rigging, in meters. fal's default is 1.7. + pub rigging_height_meters: Option, + + /// Animate the rigged character. fal's default is false when `None`. + pub enable_animation: Option, + + /// Animation action ID. Range 0-696; fal's default is 92. + pub animation_action_id: Option, + + /// fal's default is true when `None`. + pub enable_safety_checker: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum MeshyV6Mode { + Preview, + Full, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum MeshyV6ModelType { + Standard, + LowPoly, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum MeshyV6Topology { + Quad, + Triangle, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum MeshyV6SymmetryMode { + Off, + Auto, + On, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum MeshyV6PoseMode { + APose, + TPose, +} + +impl MeshyV6Mode { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Preview => "preview", + Self::Full => "full", + } + } +} + +impl MeshyV6ModelType { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Standard => "standard", + Self::LowPoly => "lowpoly", + } + } +} + +impl MeshyV6Topology { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Quad => "quad", + Self::Triangle => "triangle", + } + } +} + +impl MeshyV6SymmetryMode { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Off => "off", + Self::Auto => "auto", + Self::On => "on", + } + } +} + +impl MeshyV6PoseMode { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::APose => "a-pose", + Self::TPose => "t-pose", + } + } +} + +impl FalEndpoint for MeshyV6TextToMeshRequest { + const ENDPOINT: &str = "fal-ai/meshy/v6/text-to-3d"; + + type RawRequest = MeshyV6TextToMeshInput; + type RawResponse = MeshyV6TextToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + mode: self.mode.map(|m| m.to_str().to_string()), + seed: self.seed, + model_type: self.model_type.map(|m| m.to_str().to_string()), + topology: self.topology.map(|t| t.to_str().to_string()), + target_polycount: self.target_polycount, + should_remesh: self.should_remesh, + symmetry_mode: self.symmetry_mode.map(|s| s.to_str().to_string()), + enable_pbr: self.enable_pbr, + pose_mode: self.pose_mode.map(|p| p.to_str().to_string()), + enable_prompt_expansion: self.enable_prompt_expansion, + texture_prompt: self.texture_prompt.clone(), + texture_image_url: self.texture_image_url.clone(), + enable_rigging: self.enable_rigging, + rigging_height_meters: self.rigging_height_meters, + enable_animation: self.enable_animation, + animation_action_id: self.animation_action_id, + enable_safety_checker: self.enable_safety_checker, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + fn base_request() -> MeshyV6TextToMeshRequest { + MeshyV6TextToMeshRequest { + prompt: "a small ceramic teapot".to_string(), + mode: None, + seed: None, + model_type: None, + topology: None, + target_polycount: None, + should_remesh: None, + symmetry_mode: None, + enable_pbr: None, + pose_mode: None, + enable_prompt_expansion: None, + texture_prompt: None, + texture_image_url: None, + enable_rigging: None, + rigging_height_meters: None, + enable_animation: None, + animation_action_id: None, + enable_safety_checker: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let result = base_request().send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let result = base_request().send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_core_fields() { + let request = MeshyV6TextToMeshRequest { + mode: Some(MeshyV6Mode::Preview), + model_type: Some(MeshyV6ModelType::LowPoly), + topology: Some(MeshyV6Topology::Quad), + target_polycount: Some(5_000), + symmetry_mode: Some(MeshyV6SymmetryMode::On), + enable_pbr: Some(true), + pose_mode: Some(MeshyV6PoseMode::TPose), + ..base_request() + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json["mode"], "preview"); + assert_eq!(json["model_type"], "lowpoly"); + assert_eq!(json["topology"], "quad"); + assert_eq!(json["target_polycount"], 5_000); + assert_eq!(json["symmetry_mode"], "on"); + assert_eq!(json["enable_pbr"], true); + assert_eq!(json["pose_mode"], "t-pose"); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = MeshyV6TextToMeshRequest { prompt: "p".to_string(), ..base_request() }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "p" })); + } + + #[test] + fn every_symmetry_mode_maps_to_wire_string() { + for (variant, expected) in [ + (MeshyV6SymmetryMode::Off, "off"), + (MeshyV6SymmetryMode::Auto, "auto"), + (MeshyV6SymmetryMode::On, "on"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn pose_modes_use_hyphenated_wire_strings() { + assert_eq!(MeshyV6PoseMode::APose.to_str(), "a-pose"); + assert_eq!(MeshyV6PoseMode::TPose.to_str(), "t-pose"); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(MeshyV6TextToMeshRequest::ENDPOINT, "fal-ai/meshy/v6/text-to-3d"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/cost.rs new file mode 100644 index 00000000..5c5777e4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/cost.rs @@ -0,0 +1,46 @@ +use crate::requests::api::mesh::text::meshy_v6_text_to_mesh::api::MeshyV6TextToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for MeshyV6TextToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/meshy/v6/text-to-3d): + // "Your request will cost $0.8 per generation." + 80 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::mesh::text::meshy_v6_text_to_mesh::api::MeshyV6ModelType; + + #[test] + fn flat_cost_regardless_of_options() { + let mut request = MeshyV6TextToMeshRequest { + prompt: "p".to_string(), + mode: None, + seed: None, + model_type: None, + topology: None, + target_polycount: None, + should_remesh: None, + symmetry_mode: None, + enable_pbr: None, + pose_mode: None, + enable_prompt_expansion: None, + texture_prompt: None, + texture_image_url: None, + enable_rigging: None, + rigging_height_meters: None, + enable_animation: None, + animation_action_id: None, + enable_safety_checker: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 80); + + request.enable_pbr = Some(true); + request.model_type = Some(MeshyV6ModelType::LowPoly); + request.enable_rigging = Some(true); + assert_eq!(request.calculate_cost_in_cents(), 80); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/raw_request.rs new file mode 100644 index 00000000..00052d7e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/meshy_v6_text_to_mesh/raw_request.rs @@ -0,0 +1,77 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/meshy/v6/text-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct MeshyV6TextToMeshInput { + /// Text prompt (max 600 characters). + pub prompt: String, + + /// Options: "preview", "full". fal default: "full". + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Options: "standard", "lowpoly". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub model_type: Option, + + /// Options: "quad", "triangle". fal default: "triangle". + #[serde(skip_serializing_if = "Option::is_none")] + pub topology: Option, + + /// Range 100-300000. fal default: 30000. + #[serde(skip_serializing_if = "Option::is_none")] + pub target_polycount: Option, + + /// fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub should_remesh: Option, + + /// Options: "off", "auto", "on". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub symmetry_mode: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, + + /// Options: "a-pose", "t-pose". fal default: "" (unspecified). + #[serde(skip_serializing_if = "Option::is_none")] + pub pose_mode: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_prompt_expansion: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_image_url: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_rigging: Option, + + /// fal default: 1.7. + #[serde(skip_serializing_if = "Option::is_none")] + pub rigging_height_meters: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_animation: Option, + + /// Range 0-696. fal default: 92. + #[serde(skip_serializing_if = "Option::is_none")] + pub animation_action_id: Option, + + /// fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeshyV6TextToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/mod.rs new file mode 100644 index 00000000..2448a177 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/mod.rs @@ -0,0 +1,6 @@ +pub mod hunyuan3d_3_text_to_mesh; +pub mod hunyuan_3d_3p1_pro_text_to_mesh; +pub mod hunyuan_3d_3p1_rapid_text_to_mesh; +pub mod meshy_v6_text_to_mesh; +pub mod rodin_2p5_fast_text_to_mesh; +pub mod tripo3d_h3p1_text_to_mesh; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/api.rs new file mode 100644 index 00000000..4d0eaa7c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/api.rs @@ -0,0 +1,305 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::raw_request::{ + Rodin2p5FastBboxCondition, Rodin2p5FastTextToMeshInput, Rodin2p5FastTextToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hyper3D Rodin v2.5 Fast text-to-3D. +#[derive(Clone, Debug)] +pub struct Rodin2p5FastTextToMeshRequest { + /// Text prompt describing the 3D object. + pub prompt: String, + + /// Generation tier. fal's default is `ExtremeLow` when `None`. + pub tier: Option, + + /// Seed for reproducibility. Range 0-65535. + pub seed: Option, + + /// Output geometry format. fal's default is `Glb` when `None`. + pub geometry_file_format: Option, + + /// Material type. fal's default is `Shaded` when `None`. + pub material: Option, + + /// Mesh quality/topology preset. fal's default is `Auto` when `None`. + pub quality_mesh_option: Option, + + /// Texture resolution mode. fal's default is tier-dependent when `None`. + pub texture_mode: Option, + + /// Enhanced generative robustness. fal's default is false when `None`. + pub enable_creative_mode: Option, + + /// Enhanced texture post-processing. fal's default is false when `None`. + pub hd_texture: Option, + + /// Removes baked lighting from textures. fal's default is false when `None`. + pub texture_delight: Option, + + /// Finer geometric detail. fal's default is false when `None`. + pub is_micro: Option, + + /// Generate in T/A-pose for rigging/animation. fal's default is false. + pub ta_pose: Option, + + /// Bounding-box controlnet limiting the maximum model size. + pub bbox_condition: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Rodin2p5FastTier { + Minimum, + ExtremeLow, + Low, +} + +impl Rodin2p5FastTier { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Minimum => "Gen-2.5-Minimum", + Self::ExtremeLow => "Gen-2.5-Extreme-Low", + Self::Low => "Gen-2.5-Low", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Rodin2p5FastGeometryFileFormat { + Glb, + Usdz, + Fbx, + Obj, + Stl, +} + +impl Rodin2p5FastGeometryFileFormat { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Glb => "glb", + Self::Usdz => "usdz", + Self::Fbx => "fbx", + Self::Obj => "obj", + Self::Stl => "stl", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Rodin2p5FastMaterial { + Pbr, + Shaded, + All, + /// No material — fal's literal "None" option. + NoMaterial, +} + +impl Rodin2p5FastMaterial { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Pbr => "PBR", + Self::Shaded => "Shaded", + Self::All => "All", + Self::NoMaterial => "None", + } + } +} + +/// Mesh quality/topology presets. Wire values contain spaces (e.g. "1K Quad"). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Rodin2p5FastQualityMeshOption { + Auto, + Quad1k, + Quad4k, + Quad8k, + Quad18k, + Quad20k, + Triangle2k, + Triangle4k, + Triangle8k, + Triangle10k, + Triangle20k, +} + +impl Rodin2p5FastQualityMeshOption { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Auto => "Auto", + Self::Quad1k => "1K Quad", + Self::Quad4k => "4K Quad", + Self::Quad8k => "8K Quad", + Self::Quad18k => "18K Quad", + Self::Quad20k => "20K Quad", + Self::Triangle2k => "2K Triangle", + Self::Triangle4k => "4K Triangle", + Self::Triangle8k => "8K Triangle", + Self::Triangle10k => "10K Triangle", + Self::Triangle20k => "20K Triangle", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Rodin2p5FastTextureMode { + Legacy, + ExtremeLow, + Low, + Medium, + High, +} + +impl Rodin2p5FastTextureMode { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Legacy => "legacy", + Self::ExtremeLow => "extreme-low", + Self::Low => "low", + Self::Medium => "medium", + Self::High => "high", + } + } +} + +impl FalEndpoint for Rodin2p5FastTextToMeshRequest { + const ENDPOINT: &str = "fal-ai/hyper3d/rodin/v2.5/text-to-3d/fast"; + + type RawRequest = Rodin2p5FastTextToMeshInput; + type RawResponse = Rodin2p5FastTextToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + tier: self.tier.map(|t| t.to_str().to_string()), + seed: self.seed, + geometry_file_format: self.geometry_file_format.map(|f| f.to_str().to_string()), + material: self.material.map(|m| m.to_str().to_string()), + quality_mesh_option: self.quality_mesh_option.map(|q| q.to_str().to_string()), + texture_mode: self.texture_mode.map(|t| t.to_str().to_string()), + enable_creative_mode: self.enable_creative_mode, + hd_texture: self.hd_texture, + texture_delight: self.texture_delight, + is_micro: self.is_micro, + ta_pose: self.ta_pose, + bbox_condition: self.bbox_condition.clone(), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + fn base_request() -> Rodin2p5FastTextToMeshRequest { + Rodin2p5FastTextToMeshRequest { + prompt: "a futuristic robot with sleek metallic design".to_string(), + tier: None, + seed: None, + geometry_file_format: None, + material: None, + quality_mesh_option: None, + texture_mode: None, + enable_creative_mode: None, + hd_texture: None, + texture_delight: None, + is_micro: None, + ta_pose: None, + bbox_condition: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let result = base_request().send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let result = base_request().send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_core_fields() { + let request = Rodin2p5FastTextToMeshRequest { + tier: Some(Rodin2p5FastTier::Low), + geometry_file_format: Some(Rodin2p5FastGeometryFileFormat::Fbx), + material: Some(Rodin2p5FastMaterial::Pbr), + quality_mesh_option: Some(Rodin2p5FastQualityMeshOption::Quad4k), + texture_mode: Some(Rodin2p5FastTextureMode::High), + ta_pose: Some(true), + bbox_condition: Some(Rodin2p5FastBboxCondition { width: 10, height: 20, length: 30 }), + ..base_request() + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json["tier"], "Gen-2.5-Low"); + assert_eq!(json["geometry_file_format"], "fbx"); + assert_eq!(json["material"], "PBR"); + assert_eq!(json["quality_mesh_option"], "4K Quad"); + assert_eq!(json["texture_mode"], "high"); + // fal's field name is literally "TAPose". + assert_eq!(json["TAPose"], true); + assert!(json.get("ta_pose").is_none()); + assert_eq!(json["bbox_condition"], serde_json::json!({ "width": 10, "height": 20, "length": 30 })); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Rodin2p5FastTextToMeshRequest { + prompt: "p".to_string(), + ..base_request() + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "p" })); + } + + #[test] + fn every_quality_mesh_option_maps_to_wire_string() { + for (variant, expected) in [ + (Rodin2p5FastQualityMeshOption::Auto, "Auto"), + (Rodin2p5FastQualityMeshOption::Quad1k, "1K Quad"), + (Rodin2p5FastQualityMeshOption::Quad4k, "4K Quad"), + (Rodin2p5FastQualityMeshOption::Quad8k, "8K Quad"), + (Rodin2p5FastQualityMeshOption::Quad18k, "18K Quad"), + (Rodin2p5FastQualityMeshOption::Quad20k, "20K Quad"), + (Rodin2p5FastQualityMeshOption::Triangle2k, "2K Triangle"), + (Rodin2p5FastQualityMeshOption::Triangle4k, "4K Triangle"), + (Rodin2p5FastQualityMeshOption::Triangle8k, "8K Triangle"), + (Rodin2p5FastQualityMeshOption::Triangle10k, "10K Triangle"), + (Rodin2p5FastQualityMeshOption::Triangle20k, "20K Triangle"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn material_none_maps_to_capitalized_none() { + assert_eq!(Rodin2p5FastMaterial::NoMaterial.to_str(), "None"); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Rodin2p5FastTextToMeshRequest::ENDPOINT, + "fal-ai/hyper3d/rodin/v2.5/text-to-3d/fast", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/cost.rs new file mode 100644 index 00000000..baa9f6d0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/cost.rs @@ -0,0 +1,43 @@ +use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::api::Rodin2p5FastTextToMeshRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Rodin2p5FastTextToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hyper3d/rodin/v2.5/text-to-3d/fast): + // "Your request will cost $0.1 per generation." + 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::api::{ + Rodin2p5FastMaterial, Rodin2p5FastTier, + }; + + #[test] + fn flat_cost_regardless_of_options() { + let mut request = Rodin2p5FastTextToMeshRequest { + prompt: "p".to_string(), + tier: None, + seed: None, + geometry_file_format: None, + material: None, + quality_mesh_option: None, + texture_mode: None, + enable_creative_mode: None, + hd_texture: None, + texture_delight: None, + is_micro: None, + ta_pose: None, + bbox_condition: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 10); + + request.tier = Some(Rodin2p5FastTier::Low); + request.material = Some(Rodin2p5FastMaterial::Pbr); + request.hd_texture = Some(true); + assert_eq!(request.calculate_cost_in_cents(), 10); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/raw_request.rs new file mode 100644 index 00000000..56bc9aaf --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/rodin_2p5_fast_text_to_mesh/raw_request.rs @@ -0,0 +1,75 @@ +use serde::{Deserialize, Serialize}; + +/// Bounding-box controlnet limiting the maximum size of the generated model. +#[derive(Clone, Debug, Serialize, Deserialize, Default)] +pub struct Rodin2p5FastBboxCondition { + /// Width (x axis) dimension for the bounding box constraint. + pub width: u32, + /// Height (y axis) dimension for the bounding box constraint. + pub height: u32, + /// Length (z axis) dimension for the bounding box constraint. + pub length: u32, +} + +/// Over-the-wire input shape for `fal-ai/hyper3d/rodin/v2.5/text-to-3d/fast`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Rodin2p5FastTextToMeshInput { + /// Text prompt describing the 3D object. + pub prompt: String, + + /// Options: "Gen-2.5-Minimum", "Gen-2.5-Extreme-Low", "Gen-2.5-Low". + /// fal default: "Gen-2.5-Extreme-Low". + #[serde(skip_serializing_if = "Option::is_none")] + pub tier: Option, + + /// Range 0-65535. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Options: "glb", "usdz", "fbx", "obj", "stl". fal default: "glb". + #[serde(skip_serializing_if = "Option::is_none")] + pub geometry_file_format: Option, + + /// Options: "PBR", "Shaded", "All", "None". fal default: "Shaded". + #[serde(skip_serializing_if = "Option::is_none")] + pub material: Option, + + /// Options: "Auto", "1K Quad", "4K Quad", "8K Quad", "18K Quad", "20K Quad", + /// "2K Triangle", "4K Triangle", "8K Triangle", "10K Triangle", + /// "20K Triangle". fal default: "Auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub quality_mesh_option: Option, + + /// Options: "legacy", "extreme-low", "low", "medium", "high". + /// fal default is tier-dependent. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_mode: Option, + + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_creative_mode: Option, + + /// Enhanced texture post-processing. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub hd_texture: Option, + + /// Removes baked lighting from textures. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_delight: Option, + + /// Finer geometric detail. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub is_micro: Option, + + /// Generate in T/A-pose for rigging/animation. fal default: false. + /// NB: fal's field name is literally "TAPose". + #[serde(rename = "TAPose", skip_serializing_if = "Option::is_none")] + pub ta_pose: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub bbox_condition: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Rodin2p5FastTextToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/api.rs new file mode 100644 index 00000000..915ccac5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/api.rs @@ -0,0 +1,202 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::text::tripo3d_h3p1_text_to_mesh::raw_request::{ + Tripo3dH3p1TextToMeshInput, Tripo3dH3p1TextToMeshOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Tripo3D H3.1 text-to-3D. +#[derive(Clone, Debug)] +pub struct Tripo3dH3p1TextToMeshRequest { + /// Text prompt describing the 3D object (max 1024 characters). + pub prompt: String, + + /// Features to avoid in the generated model. + pub negative_prompt: Option, + + /// Maximum face count. Range 1000-2000000; adaptive when `None`. + pub face_limit: Option, + + /// Enable texture generation. fal's default is true when `None`. + /// Disabling drops to the cheaper no-texture price tier. + pub texture: Option, + + /// Enable PBR materials (implies texture). fal's default is true when `None`. + pub pbr: Option, + + /// Seed for geometry reproducibility. + pub model_seed: Option, + + /// Seed for the internal text-to-image step. + pub image_seed: Option, + + /// Seed for texture reproducibility. + pub texture_seed: Option, + + /// Texture quality. `Detailed` bills at the HD-texture price tier. + /// fal's default is `Standard` when `None`. + pub texture_quality: Option, + + /// Geometry quality. `Detailed` adds cost. fal's default is `Standard`. + pub geometry_quality: Option, + + /// Auto-scale the model to real-world dimensions (meters). fal default: false. + pub auto_size: Option, + + /// Generate quad mesh topology instead of triangles (returns FBX). + /// Adds cost. fal's default is false when `None`. + pub quad: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Tripo3dH3p1TextureQuality { + Standard, + Detailed, +} + +impl Tripo3dH3p1TextureQuality { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Standard => "standard", + Self::Detailed => "detailed", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Tripo3dH3p1GeometryQuality { + Standard, + Detailed, +} + +impl Tripo3dH3p1GeometryQuality { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Standard => "standard", + Self::Detailed => "detailed", + } + } +} + +impl FalEndpoint for Tripo3dH3p1TextToMeshRequest { + const ENDPOINT: &str = "tripo3d/h3.1/text-to-3d"; + + type RawRequest = Tripo3dH3p1TextToMeshInput; + type RawResponse = Tripo3dH3p1TextToMeshOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + negative_prompt: self.negative_prompt.clone(), + face_limit: self.face_limit, + texture: self.texture, + pbr: self.pbr, + model_seed: self.model_seed, + image_seed: self.image_seed, + texture_seed: self.texture_seed, + texture_quality: self.texture_quality.map(|q| q.to_str().to_string()), + geometry_quality: self.geometry_quality.map(|q| q.to_str().to_string()), + auto_size: self.auto_size, + quad: self.quad, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + fn base_request() -> Tripo3dH3p1TextToMeshRequest { + Tripo3dH3p1TextToMeshRequest { + prompt: "a small ceramic teapot".to_string(), + negative_prompt: None, + face_limit: None, + texture: None, + pbr: None, + model_seed: None, + image_seed: None, + texture_seed: None, + texture_quality: None, + geometry_quality: None, + auto_size: None, + quad: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let result = base_request().send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_mesh_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let result = base_request().send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Tripo3dH3p1TextToMeshRequest { + prompt: "p".to_string(), + negative_prompt: Some("blurry".to_string()), + face_limit: Some(50_000), + texture: Some(true), + pbr: Some(false), + model_seed: Some(1), + image_seed: Some(2), + texture_seed: Some(3), + texture_quality: Some(Tripo3dH3p1TextureQuality::Detailed), + geometry_quality: Some(Tripo3dH3p1GeometryQuality::Detailed), + auto_size: Some(true), + quad: Some(true), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "p", + "negative_prompt": "blurry", + "face_limit": 50_000, + "texture": true, + "pbr": false, + "model_seed": 1, + "image_seed": 2, + "texture_seed": 3, + "texture_quality": "detailed", + "geometry_quality": "detailed", + "auto_size": true, + "quad": true, + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Tripo3dH3p1TextToMeshRequest { prompt: "p".to_string(), ..base_request() }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "p" })); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Tripo3dH3p1TextToMeshRequest::ENDPOINT, "tripo3d/h3.1/text-to-3d"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/cost.rs new file mode 100644 index 00000000..5ed10773 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/cost.rs @@ -0,0 +1,137 @@ +use crate::requests::api::mesh::text::tripo3d_h3p1_text_to_mesh::api::{ + Tripo3dH3p1GeometryQuality, Tripo3dH3p1TextToMeshRequest, Tripo3dH3p1TextureQuality, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Tripo3dH3p1TextToMeshRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/tripo3d/h3.1/text-to-3d): + // "Your request will cost $0.10 (without textures), $0.20 (with standard + // textures), or $0.30 (with HD textures), plus an additional $0.20 for + // detailed geometry and $0.05 for quad mesh if selected." + // + // `texture` defaults to true, so the standard-texture tier is the default. + // "HD textures" = texture_quality "detailed". + // `pbr` implies texturing and ALSO defaults to true, so the cheap + // untextured tier only applies when both `texture` and `pbr` are + // explicitly disabled. Anything else may texture server-side; bill the + // textured tier so we never undercharge. + let texture_enabled = self.texture.unwrap_or(true) || self.pbr.unwrap_or(true); + let mut cost: u64 = if !texture_enabled { + 10 + } else { + match self.texture_quality { + Some(Tripo3dH3p1TextureQuality::Detailed) => 30, + None | Some(Tripo3dH3p1TextureQuality::Standard) => 20, + } + }; + if matches!(self.geometry_quality, Some(Tripo3dH3p1GeometryQuality::Detailed)) { + cost += 20; + } + if self.quad.unwrap_or(false) { + cost += 5; + } + cost + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> Tripo3dH3p1TextToMeshRequest { + Tripo3dH3p1TextToMeshRequest { + prompt: "p".to_string(), + negative_prompt: None, + face_limit: None, + texture: None, + pbr: None, + model_seed: None, + image_seed: None, + texture_seed: None, + texture_quality: None, + geometry_quality: None, + auto_size: None, + quad: None, + } + } + + mod texture_tiers { + use super::*; + + #[test] + fn default_is_standard_textures() { + // texture defaults to true → $0.20 + assert_eq!(base_request().calculate_cost_in_cents(), 20); + } + + #[test] + fn no_texture_requires_pbr_off_too() { + let mut req = base_request(); + req.texture = Some(false); + req.pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 10); + } + + #[test] + fn texture_off_but_pbr_default_bills_textured_tier() { + // `pbr` defaults to true and implies texturing. + let mut req = base_request(); + req.texture = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 20); + } + + #[test] + fn detailed_texture() { + let mut req = base_request(); + req.texture_quality = Some(Tripo3dH3p1TextureQuality::Detailed); + assert_eq!(req.calculate_cost_in_cents(), 30); + } + } + + mod add_ons { + use super::*; + + #[test] + fn detailed_geometry_adds_twenty() { + let mut req = base_request(); + req.geometry_quality = Some(Tripo3dH3p1GeometryQuality::Detailed); + assert_eq!(req.calculate_cost_in_cents(), 20 + 20); + } + + #[test] + fn quad_adds_five() { + let mut req = base_request(); + req.quad = Some(true); + assert_eq!(req.calculate_cost_in_cents(), 20 + 5); + } + + #[test] + fn everything_stacks() { + let mut req = base_request(); + req.texture_quality = Some(Tripo3dH3p1TextureQuality::Detailed); + req.geometry_quality = Some(Tripo3dH3p1GeometryQuality::Detailed); + req.quad = Some(true); + // 30 + 20 + 5 = 55 + assert_eq!(req.calculate_cost_in_cents(), 55); + } + + #[test] + fn no_texture_with_add_ons() { + let mut req = base_request(); + req.texture = Some(false); + req.pbr = Some(false); + req.geometry_quality = Some(Tripo3dH3p1GeometryQuality::Detailed); + req.quad = Some(true); + // 10 + 20 + 5 = 35 + assert_eq!(req.calculate_cost_in_cents(), 35); + } + + #[test] + fn pbr_does_not_change_cost() { + let mut req = base_request(); + req.pbr = Some(false); + assert_eq!(req.calculate_cost_in_cents(), 20); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/raw_request.rs new file mode 100644 index 00000000..17f2d24e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/text/tripo3d_h3p1_text_to_mesh/raw_request.rs @@ -0,0 +1,53 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `tripo3d/h3.1/text-to-3d`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Tripo3dH3p1TextToMeshInput { + /// Text prompt (max 1024 characters). + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Range 1000-2000000. Adaptive when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub face_limit: Option, + + /// Enable texture generation. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub texture: Option, + + /// Enable PBR materials (implies texture). fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub pbr: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model_seed: Option, + + /// Seed for the internal text-to-image step. + #[serde(skip_serializing_if = "Option::is_none")] + pub image_seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_seed: Option, + + /// Options: "standard", "detailed". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub texture_quality: Option, + + /// Options: "standard", "detailed". fal default: "standard". + #[serde(skip_serializing_if = "Option::is_none")] + pub geometry_quality: Option, + + /// Auto-scale the model to real-world dimensions (meters). fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_size: Option, + + /// Generate quad mesh topology instead of triangles. fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub quad: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Tripo3dH3p1TextToMeshOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/api.rs b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/api.rs new file mode 100644 index 00000000..c35b6c7e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/api.rs @@ -0,0 +1,183 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::mesh::topology::hunyuan_3d_3p1_smart_topology::raw_request::{ + Hunyuan3d3p1SmartTopologyInput, Hunyuan3d3p1SmartTopologyOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// Hunyuan 3D v3.1 Smart Topology: retopologizes an existing 3D mesh into a +/// cleaner, more efficient topology. +/// +/// Input constraints: GLB or OBJ, max 200MB. +#[derive(Clone, Debug)] +pub struct Hunyuan3d3p1SmartTopologyRequest { + /// URL of the input mesh file (GLB or OBJ). + pub input_file_url: String, + + /// Format of the input file. fal's default is `Glb` when `None`. + pub input_file_type: Option, + + /// Output polygon type. fal's default is `Triangle` when `None`. + pub polygon_type: Option, + + /// Output detail level. fal's default is `Medium` when `None`. + pub face_level: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3p1SmartTopologyInputFileType { + Glb, + Obj, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3p1SmartTopologyPolygonType { + Triangle, + Quadrilateral, +} + +#[derive(Copy, Clone, Debug)] +pub enum Hunyuan3d3p1SmartTopologyFaceLevel { + High, + Medium, + Low, +} + +impl FalEndpoint for Hunyuan3d3p1SmartTopologyRequest { + const ENDPOINT: &str = "fal-ai/hunyuan-3d/v3.1/smart-topology"; + + type RawRequest = Hunyuan3d3p1SmartTopologyInput; + type RawResponse = Hunyuan3d3p1SmartTopologyOutput; + + fn to_raw_request(&self) -> Result { + let input_file_type = self.input_file_type.map(|t| match t { + Hunyuan3d3p1SmartTopologyInputFileType::Glb => "glb", + Hunyuan3d3p1SmartTopologyInputFileType::Obj => "obj", + }.to_string()); + + let polygon_type = self.polygon_type.map(|t| match t { + Hunyuan3d3p1SmartTopologyPolygonType::Triangle => "triangle", + Hunyuan3d3p1SmartTopologyPolygonType::Quadrilateral => "quadrilateral", + }.to_string()); + + let face_level = self.face_level.map(|l| match l { + Hunyuan3d3p1SmartTopologyFaceLevel::High => "high", + Hunyuan3d3p1SmartTopologyFaceLevel::Medium => "medium", + Hunyuan3d3p1SmartTopologyFaceLevel::Low => "low", + }.to_string()); + + Ok(Self::RawRequest { + input_file_url: self.input_file_url.clone(), + input_file_type, + polygon_type, + face_level, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost; needs a real GLB URL + async fn test_smart_topology_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url: "https://example.com/model.glb".to_string(), + input_file_type: None, + polygon_type: None, + face_level: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost; needs a real GLB URL + async fn test_smart_topology_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url: "https://example.com/model.glb".to_string(), + input_file_type: None, + polygon_type: None, + face_level: None, + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url: "https://example.com/model.obj".to_string(), + input_file_type: Some(Hunyuan3d3p1SmartTopologyInputFileType::Obj), + polygon_type: Some(Hunyuan3d3p1SmartTopologyPolygonType::Quadrilateral), + face_level: Some(Hunyuan3d3p1SmartTopologyFaceLevel::Low), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "input_file_url": "https://example.com/model.obj", + "input_file_type": "obj", + "polygon_type": "quadrilateral", + "face_level": "low", + }), + ); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url: "https://example.com/model.glb".to_string(), + input_file_type: None, + polygon_type: None, + face_level: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "input_file_url": "https://example.com/model.glb" }), + ); + } + + #[test] + fn every_face_level_maps_to_wire_string() { + for (variant, expected) in [ + (Hunyuan3d3p1SmartTopologyFaceLevel::High, "high"), + (Hunyuan3d3p1SmartTopologyFaceLevel::Medium, "medium"), + (Hunyuan3d3p1SmartTopologyFaceLevel::Low, "low"), + ] { + let request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url: "https://example.com/model.glb".to_string(), + input_file_type: None, + polygon_type: None, + face_level: Some(variant), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.face_level.as_deref(), Some(expected)); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Hunyuan3d3p1SmartTopologyRequest::ENDPOINT, + "fal-ai/hunyuan-3d/v3.1/smart-topology", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/cost.rs b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/cost.rs new file mode 100644 index 00000000..6be5a58d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/cost.rs @@ -0,0 +1,33 @@ +use crate::requests::api::mesh::topology::hunyuan_3d_3p1_smart_topology::api::Hunyuan3d3p1SmartTopologyRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Hunyuan3d3p1SmartTopologyRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/fal-ai/hunyuan-3d/v3.1/smart-topology): + // "Your request will cost $0.75 per generation." + 75 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::mesh::topology::hunyuan_3d_3p1_smart_topology::api::{ + Hunyuan3d3p1SmartTopologyFaceLevel, Hunyuan3d3p1SmartTopologyPolygonType, + }; + + #[test] + fn flat_cost_regardless_of_options() { + let mut request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url: "https://example.com/model.glb".to_string(), + input_file_type: None, + polygon_type: None, + face_level: None, + }; + assert_eq!(request.calculate_cost_in_cents(), 75); + + request.polygon_type = Some(Hunyuan3d3p1SmartTopologyPolygonType::Quadrilateral); + request.face_level = Some(Hunyuan3d3p1SmartTopologyFaceLevel::High); + assert_eq!(request.calculate_cost_in_cents(), 75); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/raw_request.rs new file mode 100644 index 00000000..e63512ab --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/topology/hunyuan_3d_3p1_smart_topology/raw_request.rs @@ -0,0 +1,26 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/hunyuan-3d/v3.1/smart-topology`. +/// Retopologizes a 3D mesh into a more efficient topology. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3d3p1SmartTopologyInput { + /// URL of the input mesh. GLB or OBJ, max 200MB. + pub input_file_url: String, + + /// Options: "glb", "obj". fal default: "glb". + #[serde(skip_serializing_if = "Option::is_none")] + pub input_file_type: Option, + + /// Options: "triangle" (triangles only), "quadrilateral" (mixed quads and + /// triangles). fal default: "triangle". + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_type: Option, + + /// Options: "high", "medium", "low". fal default: "medium". + #[serde(skip_serializing_if = "Option::is_none")] + pub face_level: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3d3p1SmartTopologyOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/mesh/topology/mod.rs b/crates/api_clients/fal_client/src/requests/api/mesh/topology/mod.rs new file mode 100644 index 00000000..dda35c91 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mesh/topology/mod.rs @@ -0,0 +1 @@ +pub mod hunyuan_3d_3p1_smart_topology; diff --git a/crates/api_clients/fal_client/src/requests/api/mod.rs b/crates/api_clients/fal_client/src/requests/api/mod.rs new file mode 100644 index 00000000..8272f043 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/mod.rs @@ -0,0 +1,5 @@ +pub mod audio; +pub mod image; +pub mod mesh; +pub mod splat; +pub mod video; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests/api/splat/image/mod.rs b/crates/api_clients/fal_client/src/requests/api/splat/image/mod.rs new file mode 100644 index 00000000..82f15156 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/splat/image/mod.rs @@ -0,0 +1 @@ +pub mod triposplat_image_to_splat; diff --git a/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/api.rs b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/api.rs new file mode 100644 index 00000000..7e7b9ac9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/api.rs @@ -0,0 +1,160 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::splat::image::triposplat_image_to_splat::raw_request::{ + TripoSplatImageToSplatInput, TripoSplatImageToSplatOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +/// TripoSplat image-to-Gaussian-splat: reconstructs a 3D Gaussian splat from +/// a single input image. +#[derive(Clone, Debug)] +pub struct TripoSplatImageToSplatRequest { + /// URL of the input image (required). + pub image_url: String, + + /// Number of Gaussians to generate. Range 32768-262144; + /// fal's default is 262144 when `None`. + pub num_gaussians: Option, + + /// Number of inference steps. Range 1-50; fal's default is 20 when `None`. + pub num_inference_steps: Option, + + /// Guidance scale. Range 0-10; fal's default is 3 when `None`. + pub guidance_scale: Option, + + /// Output file format. fal's default is `Ply` when `None`. + pub output_format: Option, + + /// Seed for reproducibility. fal picks a random seed when `None`. + pub seed: Option, + + /// fal's default is true when `None`. + pub enable_safety_checker: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum TripoSplatOutputFormat { + Ply, + Splat, +} + +impl TripoSplatOutputFormat { + pub(crate) fn to_str(&self) -> &'static str { + match self { + Self::Ply => "ply", + Self::Splat => "splat", + } + } +} + +impl FalEndpoint for TripoSplatImageToSplatRequest { + const ENDPOINT: &str = "tripo3d/triposplat"; + + type RawRequest = TripoSplatImageToSplatInput; + type RawResponse = TripoSplatImageToSplatOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + image_url: self.image_url.clone(), + num_gaussians: self.num_gaussians, + num_inference_steps: self.num_inference_steps, + guidance_scale: self.guidance_scale, + output_format: self.output_format.map(|f| f.to_str().to_string()), + seed: self.seed, + enable_safety_checker: self.enable_safety_checker, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + mod serialization_tests { + use super::*; + + #[test] + fn minimal_request_serializes_image_url_only() { + let raw = base_request().to_raw_request().expect("to_raw_request"); + let json = serde_json::to_value(&raw).unwrap(); + let obj = json.as_object().unwrap(); + assert_eq!(obj.len(), 1, "only image_url should serialize: {json}"); + assert_eq!(json["image_url"], "https://example.com/input.png"); + } + + #[test] + fn output_format_wire_values() { + assert_eq!(TripoSplatOutputFormat::Ply.to_str(), "ply"); + assert_eq!(TripoSplatOutputFormat::Splat.to_str(), "splat"); + } + + #[test] + fn full_request_serializes_all_fields() { + let request = TripoSplatImageToSplatRequest { + num_gaussians: Some(131_072), + num_inference_steps: Some(30), + guidance_scale: Some(5.0), + output_format: Some(TripoSplatOutputFormat::Ply), + seed: Some(42), + enable_safety_checker: Some(false), + ..base_request() + }; + let raw = request.to_raw_request().expect("to_raw_request"); + let json = serde_json::to_value(&raw).unwrap(); + assert_eq!(json["num_gaussians"], 131_072); + assert_eq!(json["num_inference_steps"], 30); + assert_eq!(json["guidance_scale"], 5.0); + assert_eq!(json["output_format"], "ply"); + assert_eq!(json["seed"], 42); + assert_eq!(json["enable_safety_checker"], false); + } + } + + // ── Helpers ── + + fn base_request() -> TripoSplatImageToSplatRequest { + TripoSplatImageToSplatRequest { + image_url: "https://example.com/input.png".to_string(), + num_gaussians: None, + num_inference_steps: None, + guidance_scale: None, + output_format: None, + seed: None, + enable_safety_checker: None, + } + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_splat_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = TripoSplatImageToSplatRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_splat_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + let request = TripoSplatImageToSplatRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ..base_request() + }; + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/cost.rs b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/cost.rs new file mode 100644 index 00000000..8baaed87 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/cost.rs @@ -0,0 +1,47 @@ +use crate::requests::api::splat::image::triposplat_image_to_splat::api::TripoSplatImageToSplatRequest; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for TripoSplatImageToSplatRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing (see https://fal.ai/models/tripo3d/triposplat): + // "Price: $0.05 per generations" + 5 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::splat::image::triposplat_image_to_splat::api::TripoSplatOutputFormat; + + fn base_request() -> TripoSplatImageToSplatRequest { + TripoSplatImageToSplatRequest { + image_url: "https://example.com/input.png".to_string(), + num_gaussians: None, + num_inference_steps: None, + guidance_scale: None, + output_format: None, + seed: None, + enable_safety_checker: None, + } + } + + #[test] + fn flat_five_cents() { + assert_eq!(base_request().calculate_cost_in_cents(), 5); + } + + #[test] + fn options_do_not_change_cost() { + let request = TripoSplatImageToSplatRequest { + num_gaussians: Some(32_768), + num_inference_steps: Some(50), + guidance_scale: Some(10.0), + output_format: Some(TripoSplatOutputFormat::Splat), + seed: Some(7), + enable_safety_checker: Some(false), + ..base_request() + }; + assert_eq!(request.calculate_cost_in_cents(), 5); + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/mod.rs b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/raw_request.rs new file mode 100644 index 00000000..906bb24e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/splat/image/triposplat_image_to_splat/raw_request.rs @@ -0,0 +1,37 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `tripo3d/triposplat` (image-to-Gaussian-splat). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct TripoSplatImageToSplatInput { + /// URL of the input image. + pub image_url: String, + + /// Number of Gaussians to generate. Range 32768-262144. + /// fal default: 262144. + #[serde(skip_serializing_if = "Option::is_none")] + pub num_gaussians: Option, + + /// Number of inference steps. Range 1-50. fal default: 20. + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Guidance scale. Range 0-10. fal default: 3. + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// Options: "ply", "splat". fal default: "ply". + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + /// Seed for reproducibility. fal default: random. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct TripoSplatImageToSplatOutput {} diff --git a/crates/api_clients/fal_client/src/requests/api/splat/mod.rs b/crates/api_clients/fal_client/src/requests/api/splat/mod.rs new file mode 100644 index 00000000..14995d42 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/splat/mod.rs @@ -0,0 +1 @@ +pub mod image; diff --git a/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/api.rs new file mode 100644 index 00000000..c27c95e6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/api.rs @@ -0,0 +1,257 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::elements::kling_1p6_pro_elements_to_video::raw_request::{ + Kling1p6ProElementsToVideoInput, Kling1p6ProElementsToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling1p6ProElementsToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Image URLs that drive the generation. fal documents support for up + /// to 4 images; passing more is rejected upstream rather than here. + pub input_image_urls: Vec, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// Video duration. Kling 1.6 Pro Elements supports 5 or 10 seconds only. + pub duration: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling1p6ProElementsToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling1p6ProElementsToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling1p6ProElementsToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +impl FalEndpoint for Kling1p6ProElementsToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v1.6/pro/elements"; + + type RawRequest = Kling1p6ProElementsToVideoInput; + type RawResponse = Kling1p6ProElementsToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling1p6ProElementsToVideoAspectRatio::Square => "1:1", + Kling1p6ProElementsToVideoAspectRatio::SixteenByNine => "16:9", + Kling1p6ProElementsToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + input_image_urls: self.input_image_urls.clone(), + aspect_ratio, + duration, + negative_prompt: self.negative_prompt.clone(), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_elements_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling1p6ProElementsToVideoRequest { + prompt: "the two dogs run side by side across a sunlit meadow".to_string(), + input_image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + negative_prompt: None, + duration: Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_elements_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling1p6ProElementsToVideoRequest { + prompt: "the dogs play together in a snowy field".to_string(), + input_image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + negative_prompt: None, + duration: Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling1p6ProElementsToVideoAspectRatio::Square, + Kling1p6ProElementsToVideoAspectRatio::SixteenByNine, + Kling1p6ProElementsToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling1p6ProElementsToVideoRequest { + prompt: "the dogs play together in a snowy field".to_string(), + input_image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + negative_prompt: None, + duration: Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), + aspect_ratio: Some(ar), + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling1p6ProElementsToVideoDuration::FiveSeconds, + Kling1p6ProElementsToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling1p6ProElementsToVideoRequest { + prompt: "the dogs leap through tall grass in golden hour light".to_string(), + input_image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_aspect_ratio_uses_colon_format() { + let request = Kling1p6ProElementsToVideoRequest { + prompt: "p".to_string(), + input_image_urls: vec!["https://example.com/a.png".to_string()], + negative_prompt: None, + duration: Some(Kling1p6ProElementsToVideoDuration::TenSeconds), + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::Square), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.aspect_ratio.as_deref(), Some("1:1")); + assert_eq!(raw.duration.as_deref(), Some("10")); + } + + #[test] + fn raw_request_passes_through_input_image_urls() { + let urls = vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + "https://example.com/d.png".to_string(), + ]; + let request = Kling1p6ProElementsToVideoRequest { + prompt: "p".to_string(), + input_image_urls: urls.clone(), + negative_prompt: None, + duration: None, + aspect_ratio: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.input_image_urls, urls); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Kling1p6ProElementsToVideoRequest { + prompt: "p".to_string(), + input_image_urls: vec!["https://example.com/a.png".to_string()], + negative_prompt: None, + duration: None, + aspect_ratio: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert!(raw.aspect_ratio.is_none()); + assert!(raw.duration.is_none()); + assert!(raw.negative_prompt.is_none()); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Kling1p6ProElementsToVideoRequest::ENDPOINT, + "fal-ai/kling-video/v1.6/pro/elements", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/cost.rs new file mode 100644 index 00000000..dbc20023 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/cost.rs @@ -0,0 +1,261 @@ +use crate::requests::api::video::elements::kling_1p6_pro_elements_to_video::api::{ + Kling1p6ProElementsToVideoDuration, Kling1p6ProElementsToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling1p6ProElementsToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 1.6 Pro elements-to-video: $0.098/second + // (see https://fal.ai/models/fal-ai/kling-video/v1.6/pro/elements). + // + // Same per-second rate as the v1.6 Pro text-to-video variant. Rate held + // in tenths-of-cents and rounded up to whole cents at the end so the + // user is never undercharged. + let duration_secs = self.duration + .unwrap_or(Kling1p6ProElementsToVideoDuration::FiveSeconds) + .to_seconds(); + (98u64 * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::elements::kling_1p6_pro_elements_to_video::api::{ + Kling1p6ProElementsToVideoAspectRatio, Kling1p6ProElementsToVideoDuration, + }; + + fn make_request( + duration: Option, + ) -> Kling1p6ProElementsToVideoRequest { + Kling1p6ProElementsToVideoRequest { + prompt: "test".to_string(), + input_image_urls: vec!["https://example.com/a.png".to_string()], + negative_prompt: None, + duration, + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + } + } + + // Pricing: $0.098/sec = 98 tenths-of-cents/sec. + // Cents per duration = ceil(98 × secs / 10). + + #[test] + fn five_seconds() { + // (98 * 5 + 9) / 10 = 49 + assert_eq!( + make_request(Some(Kling1p6ProElementsToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 49, + ); + } + + #[test] + fn ten_seconds() { + // (98 * 10 + 9) / 10 = 98 + assert_eq!( + make_request(Some(Kling1p6ProElementsToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 98, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None → 5s → 49¢ + assert_eq!(make_request(None).calculate_cost_in_cents(), 49); + } + + #[test] + fn ten_seconds_costs_more_than_five() { + let five = make_request(Some(Kling1p6ProElementsToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(); + let ten = make_request(Some(Kling1p6ProElementsToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(); + assert!(five < ten, "five={five}¢ < ten={ten}¢"); + } + + #[test] + fn input_image_count_does_not_affect_cost() { + // fal bills per second of output, not per input image. Build matched + // pairs differing only in input_image_urls length and confirm cost + // matches exactly. + let base = Kling1p6ProElementsToVideoRequest { + prompt: "p".to_string(), + input_image_urls: vec!["https://example.com/a.png".to_string()], + negative_prompt: None, + duration: Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + }; + let baseline_cost = base.calculate_cost_in_cents(); + for n in 1..=4usize { + let urls: Vec = (0..n).map(|i| format!("https://example.com/{i}.png")).collect(); + let req = Kling1p6ProElementsToVideoRequest { input_image_urls: urls, ..base.clone() }; + assert_eq!( + req.calculate_cost_in_cents(), + baseline_cost, + "image count {n} should not change cost", + ); + } + } + + /// Exhaustive cost-table tests: every permutation of cost-relevant + /// configuration for elements-to-video. There is no direct legacy + /// equivalent (the legacy `enqueue_kling_v1p6_pro_image_to_video_webhook` + /// is image-to-video at a slightly lower rate), so the parity here is + /// against the canonical $0.098/sec formula. A separate sub-test + /// cross-references the legacy image-to-video function to confirm the + /// expected per-duration premium ($0.003/sec). + mod cost_table { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use crate::requests_old::webhook::video::image::enqueue_kling_v1p6_pro_image_to_video_webhook::{ + Kling1p6ProAspectRatio as LegacyAspectRatio, + Kling1p6ProDuration as LegacyDuration, + Kling1p6ProRequest as LegacyRequest, + }; + + fn new_request( + duration: Option, + aspect_ratio: Option, + ) -> Kling1p6ProElementsToVideoRequest { + Kling1p6ProElementsToVideoRequest { + prompt: "test".to_string(), + input_image_urls: vec!["https://example.com/a.png".to_string()], + negative_prompt: None, + duration, + aspect_ratio, + } + } + + // (duration, aspect_ratio, expected_cents) + // + // Math: ceil(98 × secs / 10) where 5s → 49¢ and 10s → 98¢. + // duration=None defaults to 5s. + // Aspect ratio is irrelevant to cost; iterated only to assert it. + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + // duration=None → 5s default → 49¢ + (None, None, 49), + (None, Some(Kling1p6ProElementsToVideoAspectRatio::Square), 49), + (None, Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), 49), + (None, Some(Kling1p6ProElementsToVideoAspectRatio::NineBySixteen), 49), + // duration=5s → 49¢ + (Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), None, 49), + (Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), Some(Kling1p6ProElementsToVideoAspectRatio::Square), 49), + (Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), 49), + (Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), Some(Kling1p6ProElementsToVideoAspectRatio::NineBySixteen), 49), + // duration=10s → 98¢ + (Some(Kling1p6ProElementsToVideoDuration::TenSeconds), None, 98), + (Some(Kling1p6ProElementsToVideoDuration::TenSeconds), Some(Kling1p6ProElementsToVideoAspectRatio::Square), 98), + (Some(Kling1p6ProElementsToVideoDuration::TenSeconds), Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), 98), + (Some(Kling1p6ProElementsToVideoDuration::TenSeconds), Some(Kling1p6ProElementsToVideoAspectRatio::NineBySixteen), 98), + ]; + + #[test] + fn new_module_matches_cost_table() { + for &(duration, aspect_ratio, expected) in COST_TABLE { + let got = new_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "new module: duration={duration:?} aspect_ratio={aspect_ratio:?}", + ); + } + } + + /// Aspect ratio is not part of the billing formula — every row in the + /// cost table must produce the same value for any aspect-ratio choice. + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + None, + Some(Kling1p6ProElementsToVideoAspectRatio::Square), + Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + Some(Kling1p6ProElementsToVideoAspectRatio::NineBySixteen), + ]; + let durations = [ + None, + Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), + Some(Kling1p6ProElementsToVideoDuration::TenSeconds), + ]; + for duration in durations { + let baseline = new_request(duration, aspect_ratios[0]).calculate_cost_in_cents(); + for &ar in &aspect_ratios[1..] { + let cost = new_request(duration, ar).calculate_cost_in_cents(); + assert_eq!(cost, baseline, "duration={duration:?} ar={ar:?}"); + } + } + } + + /// Cross-check against the legacy image-to-video function. Elements-to-video + /// is `$0.098/sec` and the legacy image-to-video is `$0.095/sec`, so at + /// each duration the cost difference equals `ceil(0.003 × secs)`: + /// 5s: 49¢ − 48¢ = 1¢ + /// 10s: 98¢ − 95¢ = 3¢ + /// If a future change to the legacy image-to-video rate breaks this + /// invariant, this test calls it out. + #[test] + fn premium_over_legacy_image_to_video_is_as_expected() { + fn legacy_image(secs_variant: LegacyDuration) -> u64 { + LegacyRequest { + image_url: "https://example.com/i.png".to_string(), + end_frame_image_url: None, + prompt: "test".to_string(), + duration: secs_variant, + aspect_ratio: LegacyAspectRatio::WideSixteenNine, + }.calculate_cost_in_cents() + } + + // (elements duration, equivalent legacy image duration, expected premium in cents) + let cases = [ + (Kling1p6ProElementsToVideoDuration::FiveSeconds, LegacyDuration::FiveSeconds, 1u64), + (Kling1p6ProElementsToVideoDuration::TenSeconds, LegacyDuration::TenSeconds, 3u64), + ]; + + for (elements_d, legacy_d, expected_premium) in cases { + let elements_cost = new_request(Some(elements_d), None).calculate_cost_in_cents(); + let image_cost = legacy_image(legacy_d); + let premium = elements_cost.saturating_sub(image_cost); + assert_eq!( + premium, expected_premium, + "{elements_d:?}: elements={elements_cost}¢ legacy_image={image_cost}¢ premium={premium}¢ (want {expected_premium}¢)", + ); + } + } + + /// Elements and text-to-video share the same $0.098/sec rate — cells + /// should match exactly at every duration. Documents the rate-equality + /// expectation, so if either rate drifts in the future this test fires. + #[test] + fn matches_text_to_video_cost_at_each_duration() { + use crate::requests::api::video::text::kling_1p6_pro_text_to_video::api::{ + Kling1p6ProTextToVideoAspectRatio, Kling1p6ProTextToVideoDuration, + Kling1p6ProTextToVideoRequest, + }; + fn t2v(duration: Kling1p6ProTextToVideoDuration) -> u64 { + Kling1p6ProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration: Some(duration), + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }.calculate_cost_in_cents() + } + let pairs = [ + (Kling1p6ProElementsToVideoDuration::FiveSeconds, Kling1p6ProTextToVideoDuration::FiveSeconds), + (Kling1p6ProElementsToVideoDuration::TenSeconds, Kling1p6ProTextToVideoDuration::TenSeconds), + ]; + for (e_d, t_d) in pairs { + let elements_cost = new_request(Some(e_d), None).calculate_cost_in_cents(); + let text_cost = t2v(t_d); + assert_eq!( + elements_cost, text_cost, + "{e_d:?} vs {t_d:?}: elements={elements_cost}¢ text={text_cost}¢ — rates should match at $0.098/sec", + ); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/raw_request.rs new file mode 100644 index 00000000..4e4d7a2e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/elements/kling_1p6_pro_elements_to_video/raw_request.rs @@ -0,0 +1,37 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v1.6/pro/elements`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling1p6ProElementsToVideoInput { + pub prompt: String, + + /// List of image URLs that drive the generation. fal documents support + /// for up to 4 images. + pub input_image_urls: Vec, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling1p6ProElementsToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling1p6ProElementsToVideoOutput { + pub video: Kling1p6ProElementsToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/elements/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/elements/mod.rs new file mode 100644 index 00000000..1dbfd194 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/elements/mod.rs @@ -0,0 +1 @@ +pub mod kling_1p6_pro_elements_to_video; diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/mod.rs new file mode 100644 index 00000000..4bd3c72f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/mod.rs @@ -0,0 +1,2 @@ +pub mod veo_3p1; +pub mod veo_3p1_fast; diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/api.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/api.rs new file mode 100644 index 00000000..c3f7ff63 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/api.rs @@ -0,0 +1,288 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::extend::veo_3p1::raw_request::{ + Veo3p1ExtendVideoInput, Veo3p1ExtendVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1ExtendVideoRequest { + /// Text prompt describing how the video should be extended. + pub prompt: String, + + /// URL of the video to extend (720p/1080p, 16:9 or 9:16). + pub video_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Extension duration. fal's default is `7s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ExtendVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1ExtendVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +/// Extension duration. fal documents only the `7s` default for extend-video +/// (no explicit enum). We expose `7s` plus the standard Veo 3.1 family +/// durations (`4s`/`6s`/`8s`) so callers stay strongly typed; if fal rejects +/// a value, trim this enum. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ExtendVideoDuration { + FourSeconds, + SixSeconds, + /// fal's documented default for extend-video. + SevenSeconds, + EightSeconds, +} + +impl Veo3p1ExtendVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::SevenSeconds => "7s", + Self::EightSeconds => "8s", + } + } +} + +/// Extend-video documents only 720p/1080p (no 4k tier), so this enum omits 4k. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ExtendVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3p1ExtendVideoResolution { + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ExtendVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1ExtendVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1ExtendVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/extend-video"; + + type RawRequest = Veo3p1ExtendVideoInput; + type RawResponse = Veo3p1ExtendVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + video_url: self.video_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::video_urls::ANGRY_SHIBA_VIDEO_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_extend_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1ExtendVideoRequest { + prompt: "the scene continues naturally, keeping the same motion and style".to_string(), + video_url: ANGRY_SHIBA_VIDEO_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1ExtendVideoDuration::SevenSeconds), + resolution: Some(Veo3p1ExtendVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_extend_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1ExtendVideoRequest { + prompt: "the camera pulls back to reveal more of the landscape".to_string(), + video_url: ANGRY_SHIBA_VIDEO_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1ExtendVideoDuration::SevenSeconds), + resolution: Some(Veo3p1ExtendVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1ExtendVideoRequest { + prompt: "p".to_string(), + video_url: "https://example.com/in.mp4".to_string(), + aspect_ratio: Some(Veo3p1ExtendVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1ExtendVideoDuration::SevenSeconds), + resolution: Some(Veo3p1ExtendVideoResolution::TenEightyP), + negative_prompt: Some("nope".to_string()), + generate_audio: Some(true), + seed: Some(3), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1ExtendVideoSafetyTolerance::Level4), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.video_url, "https://example.com/in.mp4"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("16:9")); + assert_eq!(raw.duration.as_deref(), Some("7s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(3)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("4")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1ExtendVideoRequest { + prompt: "p".to_string(), + video_url: "https://example.com/in.mp4".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "video_url": "https://example.com/in.mp4" }), + ); + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo3p1ExtendVideoDuration::FourSeconds, "4s", 4), + (Veo3p1ExtendVideoDuration::SixSeconds, "6s", 6), + (Veo3p1ExtendVideoDuration::SevenSeconds, "7s", 7), + (Veo3p1ExtendVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1ExtendVideoRequest::ENDPOINT, + "fal-ai/veo3.1/extend-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/cost.rs new file mode 100644 index 00000000..b6980ebc --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/cost.rs @@ -0,0 +1,109 @@ +use crate::requests::api::video::extend::veo_3p1::api::{ + Veo3p1ExtendVideoDuration, Veo3p1ExtendVideoRequest, +}; +use crate::requests::api::video::text::veo_3p1::cost::{ + veo_3p1_cost_cents, veo_3p1_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Extend-video pricing (see https://fal.ai/models/fal-ai/veo3.1/extend-video): +// $0.20/sec (audio off), $0.40/sec (audio on). +// +// Extend exposes only 720p/1080p (no 4k tier), so it always bills at the +// family's SD rate — `four_k` is fixed to `false`. + +impl FalRequestCostCalculator for Veo3p1ExtendVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 7s, audio = on. Resolution does not + // affect price here (720p and 1080p bill identically). + let duration_secs = self.duration + .unwrap_or(Veo3p1ExtendVideoDuration::SevenSeconds) + .to_seconds(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_rate_tenth_cents_per_sec(false, audio_on); + veo_3p1_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::extend::veo_3p1::api::Veo3p1ExtendVideoResolution; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Veo3p1ExtendVideoRequest { + Veo3p1ExtendVideoRequest { + prompt: "test".to_string(), + video_url: "https://example.com/in.mp4".to_string(), + aspect_ratio: None, + duration, + resolution: None, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1ExtendVideoDuration::FourSeconds), Some(false), 80), + (Some(Veo3p1ExtendVideoDuration::FourSeconds), Some(true), 160), + (Some(Veo3p1ExtendVideoDuration::SevenSeconds), Some(false), 140), + (Some(Veo3p1ExtendVideoDuration::SevenSeconds), Some(true), 280), + (Some(Veo3p1ExtendVideoDuration::EightSeconds), Some(false), 160), + (Some(Veo3p1ExtendVideoDuration::EightSeconds), Some(true), 320), + // Defaults: 7s, audio on + (None, None, 280), + (None, Some(false), 140), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, generate_audio).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} audio={generate_audio:?}"); + } + } + + /// fal: "a 5s video with audio on will cost $2" → 5s × $0.40 = 200¢. + #[test] + fn matches_documented_5s_audio_on_example() { + let rate = veo_3p1_rate_tenth_cents_per_sec(false, true); + assert_eq!(veo_3p1_cost_cents(rate, 5), 200); + } + + #[test] + fn default_duration_is_seven_seconds() { + // duration=None, audio=on → 7s @ $0.40 = 280¢ + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 280); + } + + /// Resolution (720p vs 1080p) must not change the bill for extend. + #[test] + fn cost_is_independent_of_resolution() { + for audio in [Some(false), Some(true), None] { + let base = make_request(Some(Veo3p1ExtendVideoDuration::SevenSeconds), audio) + .calculate_cost_in_cents(); + for res in [Veo3p1ExtendVideoResolution::SevenTwentyP, Veo3p1ExtendVideoResolution::TenEightyP] { + let cost = Veo3p1ExtendVideoRequest { + resolution: Some(res), + ..make_request(Some(Veo3p1ExtendVideoDuration::SevenSeconds), audio) + }.calculate_cost_in_cents(); + assert_eq!(cost, base, "audio={audio:?} res={res:?}"); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/raw_request.rs new file mode 100644 index 00000000..b7b7afc4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1/raw_request.rs @@ -0,0 +1,59 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/extend-video`. +/// Extends an existing video by generating a continuation. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1ExtendVideoInput { + pub prompt: String, + + /// URL of the video to extend. Should be 720p or 1080p, 16:9 or 9:16. + pub video_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). fal default: "7s". fal documents no + /// explicit enum for this endpoint (only the default), so it is sent as a + /// free-form string. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. fal default: "720p" (the docs describe 720p/1080p + /// source requirements and list no 4k tier for extend). + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ExtendVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ExtendVideoOutput { + pub video: Veo3p1ExtendVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/api.rs new file mode 100644 index 00000000..2331a195 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/api.rs @@ -0,0 +1,288 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::extend::veo_3p1_fast::raw_request::{ + Veo3p1FastExtendVideoInput, Veo3p1FastExtendVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1FastExtendVideoRequest { + /// Text prompt describing how the video should be extended. + pub prompt: String, + + /// URL of the video to extend (720p/1080p, 16:9 or 9:16). + pub video_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Extension duration. fal's default is `7s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastExtendVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1FastExtendVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +/// Extension duration. fal documents only the `7s` default for extend-video +/// (no explicit enum). We expose `7s` plus the standard Veo 3.1 Fast family +/// durations (`4s`/`6s`/`8s`) so callers stay strongly typed; if fal rejects +/// a value, trim this enum. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastExtendVideoDuration { + FourSeconds, + SixSeconds, + /// fal's documented default for extend-video. + SevenSeconds, + EightSeconds, +} + +impl Veo3p1FastExtendVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::SevenSeconds => "7s", + Self::EightSeconds => "8s", + } + } +} + +/// Extend-video documents only 720p/1080p (no 4k tier), so this enum omits 4k. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastExtendVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3p1FastExtendVideoResolution { + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastExtendVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1FastExtendVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1FastExtendVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/fast/extend-video"; + + type RawRequest = Veo3p1FastExtendVideoInput; + type RawResponse = Veo3p1FastExtendVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + video_url: self.video_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::video_urls::ANGRY_SHIBA_VIDEO_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_extend_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastExtendVideoRequest { + prompt: "the scene continues naturally, keeping the same motion and style".to_string(), + video_url: ANGRY_SHIBA_VIDEO_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1FastExtendVideoDuration::SevenSeconds), + resolution: Some(Veo3p1FastExtendVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_extend_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastExtendVideoRequest { + prompt: "the camera pulls back to reveal more of the landscape".to_string(), + video_url: ANGRY_SHIBA_VIDEO_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1FastExtendVideoDuration::SevenSeconds), + resolution: Some(Veo3p1FastExtendVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1FastExtendVideoRequest { + prompt: "p".to_string(), + video_url: "https://example.com/in.mp4".to_string(), + aspect_ratio: Some(Veo3p1FastExtendVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastExtendVideoDuration::SevenSeconds), + resolution: Some(Veo3p1FastExtendVideoResolution::TenEightyP), + negative_prompt: Some("nope".to_string()), + generate_audio: Some(true), + seed: Some(3), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1FastExtendVideoSafetyTolerance::Level4), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.video_url, "https://example.com/in.mp4"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("16:9")); + assert_eq!(raw.duration.as_deref(), Some("7s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(3)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("4")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1FastExtendVideoRequest { + prompt: "p".to_string(), + video_url: "https://example.com/in.mp4".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "video_url": "https://example.com/in.mp4" }), + ); + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo3p1FastExtendVideoDuration::FourSeconds, "4s", 4), + (Veo3p1FastExtendVideoDuration::SixSeconds, "6s", 6), + (Veo3p1FastExtendVideoDuration::SevenSeconds, "7s", 7), + (Veo3p1FastExtendVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1FastExtendVideoRequest::ENDPOINT, + "fal-ai/veo3.1/fast/extend-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..6f76b847 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/cost.rs @@ -0,0 +1,102 @@ +use crate::requests::api::video::extend::veo_3p1_fast::api::{ + Veo3p1FastExtendVideoDuration, Veo3p1FastExtendVideoRequest, +}; +use crate::requests::api::video::text::veo_3p1_fast::cost::{ + veo_3p1_fast_cost_cents, veo_3p1_fast_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Extend-video pricing (see https://fal.ai/models/fal-ai/veo3.1/fast/extend-video): +// $0.10/sec (audio off), $0.15/sec (audio on). +// +// Extend exposes only 720p/1080p (no 4k tier), so it always bills at the +// family's SD rate — `four_k` is fixed to `false`. + +impl FalRequestCostCalculator for Veo3p1FastExtendVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 7s, audio = on. Resolution does not + // affect price here (720p and 1080p bill identically). + let duration_secs = self.duration + .unwrap_or(Veo3p1FastExtendVideoDuration::SevenSeconds) + .to_seconds(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_fast_rate_tenth_cents_per_sec(false, audio_on); + veo_3p1_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::extend::veo_3p1_fast::api::Veo3p1FastExtendVideoResolution; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Veo3p1FastExtendVideoRequest { + Veo3p1FastExtendVideoRequest { + prompt: "test".to_string(), + video_url: "https://example.com/in.mp4".to_string(), + aspect_ratio: None, + duration, + resolution: None, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1FastExtendVideoDuration::FourSeconds), Some(false), 40), + (Some(Veo3p1FastExtendVideoDuration::FourSeconds), Some(true), 60), + (Some(Veo3p1FastExtendVideoDuration::SevenSeconds), Some(false), 70), + (Some(Veo3p1FastExtendVideoDuration::SevenSeconds), Some(true), 105), + (Some(Veo3p1FastExtendVideoDuration::EightSeconds), Some(false), 80), + (Some(Veo3p1FastExtendVideoDuration::EightSeconds), Some(true), 120), + // Defaults: 7s, audio on + (None, None, 105), + (None, Some(false), 70), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, generate_audio).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} audio={generate_audio:?}"); + } + } + + #[test] + fn default_duration_is_seven_seconds() { + // duration=None, audio=on → 7s @ $0.15 = 105¢ + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 105); + } + + /// Resolution (720p vs 1080p) must not change the bill for extend. + #[test] + fn cost_is_independent_of_resolution() { + for audio in [Some(false), Some(true), None] { + let base = make_request(Some(Veo3p1FastExtendVideoDuration::SevenSeconds), audio) + .calculate_cost_in_cents(); + for res in [Veo3p1FastExtendVideoResolution::SevenTwentyP, Veo3p1FastExtendVideoResolution::TenEightyP] { + let cost = Veo3p1FastExtendVideoRequest { + resolution: Some(res), + ..make_request(Some(Veo3p1FastExtendVideoDuration::SevenSeconds), audio) + }.calculate_cost_in_cents(); + assert_eq!(cost, base, "audio={audio:?} res={res:?}"); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/raw_request.rs new file mode 100644 index 00000000..b6da8ff7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/extend/veo_3p1_fast/raw_request.rs @@ -0,0 +1,59 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/fast/extend-video`. +/// Extends an existing video by generating a continuation. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastExtendVideoInput { + pub prompt: String, + + /// URL of the video to extend. Should be 720p or 1080p, 16:9 or 9:16. + pub video_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). fal default: "7s". fal documents no + /// explicit enum for this endpoint (only the default), so it is sent as a + /// free-form string. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. fal default: "720p" (the docs describe 720p/1080p + /// source requirements and list no 4k tier for extend). + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastExtendVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastExtendVideoOutput { + pub video: Veo3p1FastExtendVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/api.rs new file mode 100644 index 00000000..ba17fa6b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/api.rs @@ -0,0 +1,236 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::kling_1p6_pro_image_to_video::raw_request::{ + Kling1p6ProImageToVideoInput, Kling1p6ProImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling1p6ProImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Starting frame image URL. + pub image_url: String, + + /// Optional end-frame image URL. + pub end_image_url: Option, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// Video duration. Kling 1.6 Pro supports 5 or 10 seconds only. + pub duration: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, + + /// CFG scale. Defaults to fal's `0.5` when `None`. + pub cfg_scale: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling1p6ProImageToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling1p6ProImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling1p6ProImageToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +impl FalEndpoint for Kling1p6ProImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v1.6/pro/image-to-video"; + + type RawRequest = Kling1p6ProImageToVideoInput; + type RawResponse = Kling1p6ProImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling1p6ProImageToVideoAspectRatio::Square => "1:1", + Kling1p6ProImageToVideoAspectRatio::SixteenByNine => "16:9", + Kling1p6ProImageToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + // fal's schema names this `tail_image_url`; our public API uses + // `end_image_url` for consistency with the other Kling modules. + tail_image_url: self.end_image_url.clone(), + aspect_ratio, + duration, + negative_prompt: self.negative_prompt.clone(), + cfg_scale: self.cfg_scale, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling1p6ProImageToVideoRequest { + prompt: "shiba in glasses runs to the lake and stands by the shore".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_image_url: Some(JUNO_AT_LAKE_IMAGE_URL.to_string()), + negative_prompt: None, + duration: Some(Kling1p6ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling1p6ProImageToVideoRequest { + prompt: "shiba bounds across the meadow chasing a falling leaf".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_image_url: None, + negative_prompt: None, + duration: Some(Kling1p6ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling1p6ProImageToVideoAspectRatio::Square, + Kling1p6ProImageToVideoAspectRatio::SixteenByNine, + Kling1p6ProImageToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling1p6ProImageToVideoRequest { + prompt: "shiba bounds across the meadow chasing a falling leaf".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_image_url: None, + negative_prompt: None, + duration: Some(Kling1p6ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(ar), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling1p6ProImageToVideoDuration::FiveSeconds, + Kling1p6ProImageToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling1p6ProImageToVideoRequest { + prompt: "shiba bounds across the meadow chasing a falling leaf".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_image_url: None, + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_aspect_ratio_uses_colon_format() { + let request = Kling1p6ProImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/i.png".to_string(), + end_image_url: None, + negative_prompt: None, + duration: Some(Kling1p6ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.aspect_ratio.as_deref(), Some("16:9")); + assert_eq!(raw.duration.as_deref(), Some("5")); + } + + #[test] + fn raw_request_translates_end_image_url_to_tail_image_url() { + let request = Kling1p6ProImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/i.png".to_string(), + end_image_url: Some("https://example.com/end.png".to_string()), + negative_prompt: None, + duration: None, + aspect_ratio: None, + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.tail_image_url.as_deref(), Some("https://example.com/end.png")); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/cost.rs new file mode 100644 index 00000000..1af3f5ee --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/cost.rs @@ -0,0 +1,236 @@ +use crate::requests::api::video::image::kling_1p6_pro_image_to_video::api::{ + Kling1p6ProImageToVideoDuration, Kling1p6ProImageToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling1p6ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 1.6 Pro image-to-video: $0.095/second. + // + // Rate is 95 tenths-of-cents per second; round up to whole cents at the + // end so the user is never undercharged. + let duration_secs = self.duration + .unwrap_or(Kling1p6ProImageToVideoDuration::FiveSeconds) + .to_seconds(); + (95u64 * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::kling_1p6_pro_image_to_video::api::{ + Kling1p6ProImageToVideoAspectRatio, Kling1p6ProImageToVideoDuration, + }; + + fn make_request( + duration: Option, + ) -> Kling1p6ProImageToVideoRequest { + Kling1p6ProImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/image.jpg".to_string(), + end_image_url: None, + negative_prompt: None, + duration, + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + } + } + + // Pricing: $0.095/sec = 95 tenths-of-cents/sec. + // Cents per duration = ceil(95 × secs / 10). + + #[test] + fn five_seconds() { + // (95 * 5 + 9) / 10 = 48 (round up from 47.5¢) + assert_eq!( + make_request(Some(Kling1p6ProImageToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 48, + ); + } + + #[test] + fn ten_seconds() { + // (95 * 10 + 9) / 10 = 95 + assert_eq!( + make_request(Some(Kling1p6ProImageToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 95, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None → 5s → 48¢ + assert_eq!(make_request(None).calculate_cost_in_cents(), 48); + } + + #[test] + fn ten_seconds_costs_more_than_five() { + let five = make_request(Some(Kling1p6ProImageToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(); + let ten = make_request(Some(Kling1p6ProImageToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(); + assert!(five < ten, "five={five}¢ < ten={ten}¢"); + } + + /// Exhaustive cost-table tests: every permutation of cost-relevant + /// configuration, asserted both against the legacy + /// `enqueue_kling_v1p6_pro_image_to_video_webhook` cost function and + /// against the canonical $0.095/sec rate (`(95 * secs + 9) / 10`). + /// + /// Aspect ratio is included in the cross product as a sanity check — + /// neither the new nor legacy implementation reads it for billing, so + /// every cell in a given row must agree. + mod legacy_parity { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use crate::requests_old::webhook::video::image::enqueue_kling_v1p6_pro_image_to_video_webhook::{ + Kling1p6ProAspectRatio as LegacyAspectRatio, + Kling1p6ProDuration as LegacyDuration, + Kling1p6ProRequest as LegacyRequest, + }; + + // ── Mapping helpers from the new strongly-typed API to the legacy one ── + + fn legacy_duration_for(d: Option) -> LegacyDuration { + match d { + // The legacy `Default` variant means "5 seconds" semantically — same + // as the new module's `None` default. + None => LegacyDuration::Default, + Some(Kling1p6ProImageToVideoDuration::FiveSeconds) => LegacyDuration::FiveSeconds, + Some(Kling1p6ProImageToVideoDuration::TenSeconds) => LegacyDuration::TenSeconds, + } + } + + fn legacy_aspect_ratio_for(ar: Option) -> LegacyAspectRatio { + // The legacy API has no "None" — pick 16:9 as the default when the + // new request leaves it unset, mirroring fal's documented server + // default. + match ar { + None | Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine) => LegacyAspectRatio::WideSixteenNine, + Some(Kling1p6ProImageToVideoAspectRatio::Square) => LegacyAspectRatio::Square, + Some(Kling1p6ProImageToVideoAspectRatio::NineBySixteen) => LegacyAspectRatio::TallNineSixteen, + } + } + + fn new_request( + duration: Option, + aspect_ratio: Option, + ) -> Kling1p6ProImageToVideoRequest { + Kling1p6ProImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/image.jpg".to_string(), + end_image_url: None, + negative_prompt: None, + duration, + aspect_ratio, + cfg_scale: None, + } + } + + fn legacy_request( + duration: Option, + aspect_ratio: Option, + ) -> LegacyRequest { + LegacyRequest { + image_url: "https://example.com/image.jpg".to_string(), + end_frame_image_url: None, + prompt: "test".to_string(), + duration: legacy_duration_for(duration), + aspect_ratio: legacy_aspect_ratio_for(aspect_ratio), + } + } + + // (new_duration, new_aspect_ratio, expected_cents) + // + // Math: ceil(95 × secs / 10) where 5s → 48¢ and 10s → 95¢. + // duration=None defaults to 5s in both the new and legacy modules. + // Aspect ratio is irrelevant to cost; iterated only to assert it. + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + // duration=None → 5s default → 48¢ + (None, None, 48), + (None, Some(Kling1p6ProImageToVideoAspectRatio::Square), 48), + (None, Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), 48), + (None, Some(Kling1p6ProImageToVideoAspectRatio::NineBySixteen), 48), + // duration=5s → 48¢ + (Some(Kling1p6ProImageToVideoDuration::FiveSeconds), None, 48), + (Some(Kling1p6ProImageToVideoDuration::FiveSeconds), Some(Kling1p6ProImageToVideoAspectRatio::Square), 48), + (Some(Kling1p6ProImageToVideoDuration::FiveSeconds), Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), 48), + (Some(Kling1p6ProImageToVideoDuration::FiveSeconds), Some(Kling1p6ProImageToVideoAspectRatio::NineBySixteen), 48), + // duration=10s → 95¢ + (Some(Kling1p6ProImageToVideoDuration::TenSeconds), None, 95), + (Some(Kling1p6ProImageToVideoDuration::TenSeconds), Some(Kling1p6ProImageToVideoAspectRatio::Square), 95), + (Some(Kling1p6ProImageToVideoDuration::TenSeconds), Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), 95), + (Some(Kling1p6ProImageToVideoDuration::TenSeconds), Some(Kling1p6ProImageToVideoAspectRatio::NineBySixteen), 95), + ]; + + #[test] + fn new_module_matches_cost_table() { + for &(duration, aspect_ratio, expected) in COST_TABLE { + let got = new_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "new module: duration={duration:?} aspect_ratio={aspect_ratio:?}", + ); + } + } + + #[test] + fn legacy_function_matches_cost_table() { + for &(duration, aspect_ratio, expected) in COST_TABLE { + let got = legacy_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "legacy function: duration={duration:?} aspect_ratio={aspect_ratio:?}", + ); + } + } + + /// The headline parity check: at every permutation of the legacy's + /// cost-relevant configuration, the new and legacy + /// `calculate_cost_in_cents` return the same value. If this fails, the + /// new module's pricing has drifted from what shipped previously. + #[test] + fn new_module_matches_legacy_at_every_combo() { + for &(duration, aspect_ratio, _) in COST_TABLE { + let new_cost = new_request(duration, aspect_ratio).calculate_cost_in_cents(); + let legacy_cost = legacy_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + new_cost, legacy_cost, + "parity mismatch at duration={duration:?} aspect_ratio={aspect_ratio:?}: \ + new={new_cost}¢ vs legacy={legacy_cost}¢", + ); + } + } + + /// Aspect ratio is not part of the billing formula — every row in the + /// cost table must produce the same value for any aspect-ratio choice. + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + None, + Some(Kling1p6ProImageToVideoAspectRatio::Square), + Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + Some(Kling1p6ProImageToVideoAspectRatio::NineBySixteen), + ]; + let durations = [ + None, + Some(Kling1p6ProImageToVideoDuration::FiveSeconds), + Some(Kling1p6ProImageToVideoDuration::TenSeconds), + ]; + for duration in durations { + let baseline = new_request(duration, aspect_ratios[0]).calculate_cost_in_cents(); + for &ar in &aspect_ratios[1..] { + let cost = new_request(duration, ar).calculate_cost_in_cents(); + assert_eq!(cost, baseline, "duration={duration:?} ar={ar:?}"); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/raw_request.rs new file mode 100644 index 00000000..9b415b8d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_1p6_pro_image_to_video/raw_request.rs @@ -0,0 +1,51 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v1.6/pro/image-to-video`. +/// xAI's schema: +/// +/// NB: `tail_image_url` is xAI's name for the end-frame keyframe. Our public +/// API surface (`Kling1p6ProImageToVideoRequest::end_image_url`) uses the +/// `end_image_url` name to match the convention in other Kling modules; we +/// translate at the [`crate::requests::traits::fal_endpoint_trait::FalEndpoint::to_raw_request`] +/// boundary. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling1p6ProImageToVideoInput { + pub prompt: String, + + /// Starting frame image URL. + pub image_url: String, + + /// Optional end-frame image URL (the fal schema calls this `tail_image_url`). + #[serde(skip_serializing_if = "Option::is_none")] + pub tail_image_url: Option, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling1p6ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling1p6ProImageToVideoOutput { + pub video: Kling1p6ProImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/api.rs new file mode 100644 index 00000000..2b2c39c1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/api.rs @@ -0,0 +1,324 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::kling_2p5_turbo_pro_image_to_video::raw_request::{ + Kling2p5TurboProImageToVideoInput, Kling2p5TurboProImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling2p5TurboProImageToVideoRequest { + /// Text prompt describing the desired video content. + pub prompt: String, + + /// URL of the image used as the first frame. + pub image_url: String, + + /// Optional URL of the image used as the last frame. + pub tail_image_url: Option, + + /// Video duration. Kling 2.5 Turbo Pro supports 5 or 10 seconds only. + pub duration: Option, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// CFG scale. Defaults to fal's `0.5` when `None`. + pub cfg_scale: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling2p5TurboProImageToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling2p5TurboProImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +impl FalEndpoint for Kling2p5TurboProImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v2.5-turbo/pro/image-to-video"; + + type RawRequest = Kling2p5TurboProImageToVideoInput; + type RawResponse = Kling2p5TurboProImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + duration, + tail_image_url: self.tail_image_url.clone(), + negative_prompt: self.negative_prompt.clone(), + cfg_scale: self.cfg_scale, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p5TurboProImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + tail_image_url: None, + duration: Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + cfg_scale: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p5TurboProImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + tail_image_url: None, + duration: Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + cfg_scale: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling2p5TurboProImageToVideoDuration::FiveSeconds, + Kling2p5TurboProImageToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling2p5TurboProImageToVideoRequest { + prompt: "the dog wags its tail".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + tail_image_url: None, + duration: Some(dur), + negative_prompt: None, + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_uses_canonical_field_names() { + let request = Kling2p5TurboProImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + tail_image_url: Some("https://example.com/end.png".to_string()), + duration: Some(Kling2p5TurboProImageToVideoDuration::TenSeconds), + negative_prompt: Some("nope".to_string()), + cfg_scale: Some(0.5), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.tail_image_url.as_deref(), Some("https://example.com/end.png")); + assert_eq!(raw.duration.as_deref(), Some("10")); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.cfg_scale, Some(0.5)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Kling2p5TurboProImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + tail_image_url: None, + duration: None, + negative_prompt: None, + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert!(raw.tail_image_url.is_none()); + assert!(raw.duration.is_none()); + assert!(raw.negative_prompt.is_none()); + assert!(raw.cfg_scale.is_none()); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Kling2p5TurboProImageToVideoRequest::ENDPOINT, + "fal-ai/kling-video/v2.5-turbo/pro/image-to-video", + ); + } + + /// Wire-shape and endpoint parity vs the legacy + /// `requests_old/http/video/image/http_kling_v2p5_turbo_pro_image_to_video.rs`. + /// + /// No legacy *pro* webhook exists for image-to-video (only the legacy + /// `enqueue_kling_v2p5_turbo_standard_image_to_video_webhook` ships, and + /// that targets the `standard` model with a different pricing tier — cost + /// parity for the pro model is asserted in `cost.rs` against the + /// documented pricing instead. + mod legacy_parity { + use super::*; + use crate::requests_old::http::video::image::http_kling_v2p5_turbo_pro_image_to_video::{ + kling_v2p5_turbo_pro_image_to_video, KlingV2p5TurboProImageToVideoInput, + }; + + /// Same `fal-ai/kling-video/v2.5-turbo/pro/image-to-video` path. + #[test] + fn endpoint_path_matches_legacy() { + let legacy = kling_v2p5_turbo_pro_image_to_video(KlingV2p5TurboProImageToVideoInput { + prompt: "p".to_string(), + image_url: "https://example.com/x.png".to_string(), + ..Default::default() + }); + assert_eq!( + Kling2p5TurboProImageToVideoRequest::ENDPOINT, + legacy.endpoint, + ); + } + + /// At a representative fully-populated case, the new module's serialized + /// `RawRequest` must equal the legacy `Input`'s JSON. + #[test] + fn wire_json_matches_legacy_fully_populated() { + let new = Kling2p5TurboProImageToVideoRequest { + prompt: "shared prompt".to_string(), + image_url: "https://example.com/start.png".to_string(), + tail_image_url: Some("https://example.com/end.png".to_string()), + duration: Some(Kling2p5TurboProImageToVideoDuration::TenSeconds), + negative_prompt: Some("blurry".to_string()), + cfg_scale: Some(0.5), + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p5TurboProImageToVideoInput { + prompt: "shared prompt".to_string(), + image_url: "https://example.com/start.png".to_string(), + duration: Some("10".to_string()), + tail_image_url: Some("https://example.com/end.png".to_string()), + negative_prompt: Some("blurry".to_string()), + cfg_scale: Some(0.5), + }; + let legacy_json = serde_json::to_value(&legacy).unwrap(); + + assert_eq!(new_json, legacy_json); + } + + /// Minimal case (prompt + image_url only): unset optionals must be + /// omitted on the wire just like the legacy struct. + #[test] + fn wire_json_matches_legacy_minimal() { + let new = Kling2p5TurboProImageToVideoRequest { + prompt: "minimal".to_string(), + image_url: "https://example.com/x.png".to_string(), + tail_image_url: None, + duration: None, + negative_prompt: None, + cfg_scale: None, + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p5TurboProImageToVideoInput { + prompt: "minimal".to_string(), + image_url: "https://example.com/x.png".to_string(), + ..Default::default() + }; + let legacy_json = serde_json::to_value(&legacy).unwrap(); + + assert_eq!(new_json, legacy_json); + assert_eq!( + new_json, + serde_json::json!({ + "prompt": "minimal", + "image_url": "https://example.com/x.png", + }), + ); + } + + /// Cross product over duration × tail_image_url presence: every cell's + /// wire JSON must match the legacy `Input`. + #[test] + fn wire_json_matches_legacy_at_every_combo() { + let durations = [ + (None, None), + (Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), Some("5")), + (Some(Kling2p5TurboProImageToVideoDuration::TenSeconds), Some("10")), + ]; + let tail_urls: [Option<&str>; 2] = [None, Some("https://example.com/tail.png")]; + + for (d_new, d_legacy) in durations { + for tail in tail_urls { + let new = Kling2p5TurboProImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/x.png".to_string(), + tail_image_url: tail.map(String::from), + duration: d_new, + negative_prompt: None, + cfg_scale: None, + }; + let legacy = KlingV2p5TurboProImageToVideoInput { + prompt: "p".to_string(), + image_url: "https://example.com/x.png".to_string(), + duration: d_legacy.map(String::from), + tail_image_url: tail.map(String::from), + negative_prompt: None, + cfg_scale: None, + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + let legacy_json = serde_json::to_value(&legacy).unwrap(); + assert_eq!( + new_json, legacy_json, + "duration={d_new:?} tail_image_url={tail:?}", + ); + } + } + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/cost.rs new file mode 100644 index 00000000..86d7554f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/cost.rs @@ -0,0 +1,215 @@ +use crate::requests::api::video::image::kling_2p5_turbo_pro_image_to_video::api::{ + Kling2p5TurboProImageToVideoDuration, Kling2p5TurboProImageToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling2p5TurboProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 2.5 Turbo Pro image-to-video pricing + // (see https://fal.ai/models/fal-ai/kling-video/v2.5-turbo/pro/image-to-video): + // "For 5s video your request will cost $0.35. + // For every additional second you will be charged $0.07." + // + // That works out to a flat $0.07/second rate, identical to the + // text-to-video pro variant. Rate is held in tenths-of-cents and + // rounded up to whole cents so the user is never undercharged. + let duration_secs = self.duration + .unwrap_or(Kling2p5TurboProImageToVideoDuration::FiveSeconds) + .to_seconds(); + (70u64 * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + ) -> Kling2p5TurboProImageToVideoRequest { + Kling2p5TurboProImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + tail_image_url: None, + duration, + negative_prompt: None, + cfg_scale: None, + } + } + + // Pricing: flat $0.07/sec = 70 tenths-of-cents/sec. + // Cents per duration = ceil(70 × secs / 10). + + #[test] + fn five_seconds() { + // (70 * 5 + 9) / 10 = 35 — matches fal's "$0.35 for 5s" base rate + assert_eq!( + make_request(Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 35, + ); + } + + #[test] + fn ten_seconds() { + // (70 * 10 + 9) / 10 = 70 — matches "$0.35 + 5×$0.07 = $0.70" + assert_eq!( + make_request(Some(Kling2p5TurboProImageToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 70, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None → 5s → 35¢ + assert_eq!(make_request(None).calculate_cost_in_cents(), 35); + } + + #[test] + fn ten_seconds_costs_more_than_five() { + let five = make_request(Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(); + let ten = make_request(Some(Kling2p5TurboProImageToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(); + assert!(five < ten, "five={five}¢ < ten={ten}¢"); + } + + /// Exhaustive cost-table tests. No legacy *pro* webhook exists for + /// image-to-video — only the legacy `standard` webhook ships — so this is + /// parity against the *documented* fal pricing and against the + /// text-to-video pro rate, which fal sets at the same $0.07/sec. + mod cost_table { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + + fn new_request( + duration: Option, + tail_image_url: Option<&str>, + ) -> Kling2p5TurboProImageToVideoRequest { + Kling2p5TurboProImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + tail_image_url: tail_image_url.map(String::from), + duration, + negative_prompt: None, + cfg_scale: None, + } + } + + // (duration, tail_image_url_present, expected_cents) + // + // Math: ceil(70 × secs / 10). 5s → 35¢; 10s → 70¢. + // duration=None defaults to 5s; tail_image_url is irrelevant to cost. + const COST_TABLE: &[( + Option, + bool, + u64, + )] = &[ + // duration=None → 5s default → 35¢ + (None, false, 35), + (None, true, 35), + // duration=5s → 35¢ + (Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), false, 35), + (Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), true, 35), + // duration=10s → 70¢ + (Some(Kling2p5TurboProImageToVideoDuration::TenSeconds), false, 70), + (Some(Kling2p5TurboProImageToVideoDuration::TenSeconds), true, 70), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, tail_present, expected) in COST_TABLE { + let tail = if tail_present { Some("https://example.com/tail.png") } else { None }; + let got = new_request(duration, tail).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} tail_present={tail_present}", + ); + } + } + + /// tail_image_url is not part of the billing formula — every choice + /// must produce the same value for fixed duration. + #[test] + fn cost_is_independent_of_tail_image_url() { + let durations = [ + None, + Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), + Some(Kling2p5TurboProImageToVideoDuration::TenSeconds), + ]; + for duration in durations { + let without = new_request(duration, None).calculate_cost_in_cents(); + let with = new_request(duration, Some("https://example.com/tail.png")) + .calculate_cost_in_cents(); + assert_eq!(with, without, "duration={duration:?}"); + } + } + + /// cfg_scale is not part of the billing formula. + #[test] + fn cost_is_independent_of_cfg_scale() { + for cfg in [None, Some(0.0_f32), Some(0.5), Some(1.0)] { + let req = Kling2p5TurboProImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + tail_image_url: None, + duration: Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + cfg_scale: cfg, + }; + assert_eq!(req.calculate_cost_in_cents(), 35, "cfg_scale={cfg:?}"); + } + } + + /// Image-to-video and text-to-video pro share the same $0.07/sec rate + /// per fal's docs — costs must match exactly at every duration. If + /// either rate drifts in the future this test fires. + #[test] + fn matches_text_to_video_pro_cost_at_each_duration() { + use crate::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::api::{ + Kling2p5TurboProTextToVideoAspectRatio, Kling2p5TurboProTextToVideoDuration, + Kling2p5TurboProTextToVideoRequest, + }; + fn t2v(duration: Kling2p5TurboProTextToVideoDuration) -> u64 { + Kling2p5TurboProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration: Some(duration), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }.calculate_cost_in_cents() + } + let pairs = [ + (Kling2p5TurboProImageToVideoDuration::FiveSeconds, Kling2p5TurboProTextToVideoDuration::FiveSeconds), + (Kling2p5TurboProImageToVideoDuration::TenSeconds, Kling2p5TurboProTextToVideoDuration::TenSeconds), + ]; + for (i2v_d, t2v_d) in pairs { + let image_cost = new_request(Some(i2v_d), None).calculate_cost_in_cents(); + let text_cost = t2v(t2v_d); + assert_eq!( + image_cost, text_cost, + "{i2v_d:?} vs {t2v_d:?}: image={image_cost}¢ text={text_cost}¢ — rates should match at $0.07/sec", + ); + } + } + + /// Sanity-check fal's documented examples: + /// "For 5s video your request will cost $0.35" + /// "For every additional second you will be charged $0.07" + /// → 10s costs $0.35 + 5 × $0.07 = $0.70 + #[test] + fn matches_documented_examples() { + assert_eq!( + make_request(Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 35, + ); + assert_eq!( + make_request(Some(Kling2p5TurboProImageToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 70, + ); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/raw_request.rs new file mode 100644 index 00000000..40486c3e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p5_turbo_pro_image_to_video/raw_request.rs @@ -0,0 +1,40 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v2.5-turbo/pro/image-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling2p5TurboProImageToVideoInput { + pub prompt: String, + + /// URL of the image to be used for the video. + pub image_url: String, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" (fal default: "5") + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// URL of the image to be used for the end of the video. + #[serde(skip_serializing_if = "Option::is_none")] + pub tail_image_url: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p5TurboProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p5TurboProImageToVideoOutput { + pub video: Kling2p5TurboProImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/api.rs new file mode 100644 index 00000000..62334625 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/api.rs @@ -0,0 +1,311 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::kling_2p6_pro_image_to_video::raw_request::{ + Kling2p6ProImageToVideoInput, Kling2p6ProImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling2p6ProImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the first frame. + pub start_image_url: String, + + /// URL of the image used as the last frame (optional). + pub end_image_url: Option, + + /// Video duration. Kling 2.6 Pro supports 5 or 10 seconds only. + pub duration: Option, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Voice IDs to use for the generated audio. Maximum of 2 voices per task; + /// reference them in the prompt as `<<>>` and `<<>>`. + /// + /// Note: supplying voice IDs along with `generate_audio = Some(true)` + /// activates fal's "audio + voice control" pricing tier ($0.168/sec). + pub voice_ids: Option>, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling2p6ProImageToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling2p6ProImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +impl FalEndpoint for Kling2p6ProImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v2.6/pro/image-to-video"; + + type RawRequest = Kling2p6ProImageToVideoInput; + type RawResponse = Kling2p6ProImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + start_image_url: self.start_image_url.clone(), + end_image_url: self.end_image_url.clone(), + duration, + negative_prompt: self.negative_prompt.clone(), + generate_audio: self.generate_audio, + voice_ids: self.voice_ids.clone(), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p6ProImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + start_image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + generate_audio: Some(false), + voice_ids: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p6ProImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + start_image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + generate_audio: Some(false), + voice_ids: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling2p6ProImageToVideoDuration::FiveSeconds, + Kling2p6ProImageToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling2p6ProImageToVideoRequest { + prompt: "the dog wags its tail".to_string(), + start_image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(dur), + negative_prompt: None, + generate_audio: Some(false), + voice_ids: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_uses_canonical_field_names() { + let request = Kling2p6ProImageToVideoRequest { + prompt: "p".to_string(), + start_image_url: "https://example.com/start.png".to_string(), + end_image_url: Some("https://example.com/end.png".to_string()), + duration: Some(Kling2p6ProImageToVideoDuration::TenSeconds), + negative_prompt: Some("nope".to_string()), + generate_audio: Some(true), + voice_ids: Some(vec!["voice_a".to_string(), "voice_b".to_string()]), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.start_image_url, "https://example.com/start.png"); + assert_eq!(raw.end_image_url.as_deref(), Some("https://example.com/end.png")); + assert_eq!(raw.duration.as_deref(), Some("10")); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.voice_ids.as_deref(), Some(&["voice_a".to_string(), "voice_b".to_string()][..])); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Kling2p6ProImageToVideoRequest { + prompt: "p".to_string(), + start_image_url: "https://example.com/start.png".to_string(), + end_image_url: None, + duration: None, + negative_prompt: None, + generate_audio: None, + voice_ids: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.start_image_url, "https://example.com/start.png"); + assert!(raw.end_image_url.is_none()); + assert!(raw.duration.is_none()); + assert!(raw.negative_prompt.is_none()); + assert!(raw.generate_audio.is_none()); + assert!(raw.voice_ids.is_none()); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Kling2p6ProImageToVideoRequest::ENDPOINT, + "fal-ai/kling-video/v2.6/pro/image-to-video", + ); + } + + /// Parity vs the legacy + /// `requests_old/http/video/image/http_kling_v2p6_pro_image_to_video.rs`. + /// + /// The legacy has no cost calculator, so cost parity is N/A. The wire + /// shape *intentionally diverges*: fal renamed the image field from + /// `image_url` (legacy) to `start_image_url` (current docs), and the + /// legacy gained no concept of `voice_ids` or `end_image_url`. These + /// tests document the differences and pin the endpoint URL, so we'll + /// notice if fal ever flips back or further changes the schema. + mod legacy_parity { + use super::*; + use crate::requests_old::http::video::image::http_kling_v2p6_pro_image_to_video::{ + kling_v2p6_pro_image_to_video, KlingV2p6ProImageToVideoInput, + }; + + /// Same `fal-ai/kling-video/v2.6/pro/image-to-video` path. + #[test] + fn endpoint_path_matches_legacy() { + let legacy = kling_v2p6_pro_image_to_video(KlingV2p6ProImageToVideoInput { + prompt: "p".to_string(), + image_url: "https://example.com/x.png".to_string(), + ..Default::default() + }); + assert_eq!( + Kling2p6ProImageToVideoRequest::ENDPOINT, + legacy.endpoint, + ); + } + + /// The image-URL field was renamed by fal: legacy `image_url` → + /// current `start_image_url`. This test pins the new module to the + /// current name and confirms the legacy field name is *not* emitted. + #[test] + fn new_module_emits_start_image_url_not_image_url() { + let new = Kling2p6ProImageToVideoRequest { + prompt: "p".to_string(), + start_image_url: "https://example.com/x.png".to_string(), + end_image_url: None, + duration: None, + negative_prompt: None, + generate_audio: None, + voice_ids: None, + }; + let json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + assert!(json.get("start_image_url").is_some(), "missing start_image_url: {json}"); + assert!(json.get("image_url").is_none(), "unexpected legacy image_url: {json}"); + } + + /// Legacy struct still emits the *old* `image_url` field name — + /// asserting this here flags any future schema drift in the legacy + /// archive (it shouldn't change; if it does we want to know). + #[test] + fn legacy_module_still_emits_image_url() { + let legacy = KlingV2p6ProImageToVideoInput { + prompt: "p".to_string(), + image_url: "https://example.com/x.png".to_string(), + ..Default::default() + }; + let json = serde_json::to_value(&legacy).unwrap(); + assert!(json.get("image_url").is_some(), "missing image_url: {json}"); + assert!(json.get("start_image_url").is_none(), "unexpected start_image_url: {json}"); + } + + /// On fields that *did* survive the rename (prompt, duration, + /// negative_prompt, generate_audio), wire JSON must match between + /// new and legacy when populated with the same values. + #[test] + fn surviving_fields_match_legacy_wire_shape() { + let new = Kling2p6ProImageToVideoRequest { + prompt: "shared prompt".to_string(), + start_image_url: "https://example.com/x.png".to_string(), + end_image_url: None, + duration: Some(Kling2p6ProImageToVideoDuration::TenSeconds), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(false), + voice_ids: None, + }; + let mut new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p6ProImageToVideoInput { + prompt: "shared prompt".to_string(), + image_url: "https://example.com/x.png".to_string(), + duration: Some("10".to_string()), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(false), + }; + let mut legacy_json = serde_json::to_value(&legacy).unwrap(); + + // Strip the renamed image-URL field from each side, then compare. + // (`voice_ids` and `end_image_url` are new in 2.6 — neither is set + // in this test, so they don't appear in JSON.) + new_json.as_object_mut().unwrap().remove("start_image_url"); + legacy_json.as_object_mut().unwrap().remove("image_url"); + assert_eq!(new_json, legacy_json); + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/cost.rs new file mode 100644 index 00000000..3822077e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/cost.rs @@ -0,0 +1,314 @@ +use crate::requests::api::video::image::kling_2p6_pro_image_to_video::api::{ + Kling2p6ProImageToVideoDuration, Kling2p6ProImageToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling2p6ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 2.6 Pro image-to-video pricing + // (see https://fal.ai/models/fal-ai/kling-video/v2.6/pro/image-to-video): + // $0.07/sec — audio off + // $0.14/sec — audio on, no voice control + // $0.168/sec — audio on with voice IDs (voice control) + // + // `generate_audio` defaults to `true` on fal's server, so `None` bills as + // audio-on. Voice control is active when audio is on and `voice_ids` + // contains at least one entry. + // + // Rate is held in tenths-of-cents and rounded up to whole cents so the + // user is never undercharged. + let duration_secs = self.duration + .unwrap_or(Kling2p6ProImageToVideoDuration::FiveSeconds) + .to_seconds(); + + let audio_on = self.generate_audio.unwrap_or(true); + let has_voice = self.voice_ids.as_ref().is_some_and(|v| !v.is_empty()); + + let rate_tenth_cents_per_sec: u64 = match (audio_on, has_voice) { + (false, _) => 70, // $0.07/sec — audio off + (true, false) => 140, // $0.14/sec — audio on, no voice control + (true, true) => 168, // $0.168/sec — audio + voice control + }; + + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + generate_audio: Option, + voice_ids: Option>, + ) -> Kling2p6ProImageToVideoRequest { + Kling2p6ProImageToVideoRequest { + prompt: "test".to_string(), + start_image_url: "https://example.com/start.png".to_string(), + end_image_url: None, + duration, + negative_prompt: None, + generate_audio, + voice_ids, + } + } + + // Pricing tiers in tenths-of-cents per second: + // audio off → 70 + // audio on (no voice) → 140 + // audio on + voice control → 168 + // Cents per duration = ceil(rate × secs / 10). + + #[test] + fn five_seconds_audio_off() { + // (70 * 5 + 9) / 10 = 35 + assert_eq!( + make_request(Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(false), None) + .calculate_cost_in_cents(), + 35, + ); + } + + #[test] + fn five_seconds_audio_on_no_voice() { + // (140 * 5 + 9) / 10 = 70 — matches fal's "$0.70 for 5s with audio" example + assert_eq!( + make_request(Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(true), None) + .calculate_cost_in_cents(), + 70, + ); + } + + #[test] + fn five_seconds_audio_on_with_voice() { + // (168 * 5 + 9) / 10 = 84 + assert_eq!( + make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + Some(vec!["voice_a".to_string()]), + ) + .calculate_cost_in_cents(), + 84, + ); + } + + #[test] + fn ten_seconds_audio_off() { + // (70 * 10 + 9) / 10 = 70 + assert_eq!( + make_request(Some(Kling2p6ProImageToVideoDuration::TenSeconds), Some(false), None) + .calculate_cost_in_cents(), + 70, + ); + } + + #[test] + fn ten_seconds_audio_on_no_voice() { + // (140 * 10 + 9) / 10 = 140 + assert_eq!( + make_request(Some(Kling2p6ProImageToVideoDuration::TenSeconds), Some(true), None) + .calculate_cost_in_cents(), + 140, + ); + } + + #[test] + fn ten_seconds_audio_on_with_voice() { + // (168 * 10 + 9) / 10 = 168 — matches fal's "$1.68 for 10s with audio + voice" example + assert_eq!( + make_request( + Some(Kling2p6ProImageToVideoDuration::TenSeconds), + Some(true), + Some(vec!["voice_a".to_string()]), + ) + .calculate_cost_in_cents(), + 168, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None, audio=on (default), no voice → 5s @ $0.14 = 70¢ + assert_eq!(make_request(None, None, None).calculate_cost_in_cents(), 70); + } + + #[test] + fn default_audio_is_on() { + let none_default = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + None, + None, + ).calculate_cost_in_cents(); + let explicit_on = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + None, + ).calculate_cost_in_cents(); + assert_eq!(none_default, explicit_on); + } + + #[test] + fn empty_voice_ids_does_not_trigger_voice_tier() { + // `Some(vec![])` is semantically "no voices supplied" — it should bill at + // the $0.14/sec audio-on rate, not the $0.168/sec voice-control rate. + let with_empty = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + Some(vec![]), + ).calculate_cost_in_cents(); + let with_none = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + None, + ).calculate_cost_in_cents(); + assert_eq!(with_empty, with_none, "empty voice_ids should match None"); + assert_eq!(with_empty, 70); + } + + #[test] + fn voice_ids_with_audio_off_does_not_change_cost() { + // Audio is off → voice control is meaningless. Pricing must stay at the + // $0.07/sec floor. (fal silently ignores voice_ids if audio is off.) + let with_voice = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(false), + Some(vec!["voice_a".to_string()]), + ).calculate_cost_in_cents(); + let without_voice = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(false), + None, + ).calculate_cost_in_cents(); + assert_eq!(with_voice, without_voice); + assert_eq!(with_voice, 35); + } + + #[test] + fn pricing_tiers_are_strictly_ascending() { + // At each duration: audio_off < audio_on < audio_on+voice + for d in [ + Kling2p6ProImageToVideoDuration::FiveSeconds, + Kling2p6ProImageToVideoDuration::TenSeconds, + ] { + let off = make_request(Some(d), Some(false), None).calculate_cost_in_cents(); + let on = make_request(Some(d), Some(true), None).calculate_cost_in_cents(); + let vc = make_request(Some(d), Some(true), Some(vec!["v".to_string()])) + .calculate_cost_in_cents(); + assert!(off < on, "duration={d:?}: audio_off={off}¢ < audio_on={on}¢"); + assert!(on < vc, "duration={d:?}: audio_on={on}¢ < voice_ctrl={vc}¢"); + } + } + + /// Exhaustive cost-table tests: every permutation of cost-relevant + /// configuration (duration × generate_audio × voice_ids presence). + mod cost_table { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + + // (duration, generate_audio, voice_ids_present, expected_cents) + // + // Tenths-of-cents/sec by tier: off=70, on=140, voice=168. + // Cents per duration = ceil(rate × secs / 10). + // duration=None defaults to 5s; generate_audio=None defaults to true. + const COST_TABLE: &[( + Option, + Option, + bool, // voice_ids non-empty + u64, + )] = &[ + // duration=None → 5s default + (None, Some(false), false, 35), + (None, Some(false), true, 35), // voice ignored when audio off + (None, Some(true), false, 70), + (None, Some(true), true, 84), + (None, None, false, 70), // audio default = on + (None, None, true, 84), + // duration=5s + (Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(false), false, 35), + (Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(false), true, 35), + (Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(true), false, 70), + (Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(true), true, 84), + (Some(Kling2p6ProImageToVideoDuration::FiveSeconds), None, false, 70), + (Some(Kling2p6ProImageToVideoDuration::FiveSeconds), None, true, 84), + // duration=10s + (Some(Kling2p6ProImageToVideoDuration::TenSeconds), Some(false), false, 70), + (Some(Kling2p6ProImageToVideoDuration::TenSeconds), Some(false), true, 70), + (Some(Kling2p6ProImageToVideoDuration::TenSeconds), Some(true), false, 140), + (Some(Kling2p6ProImageToVideoDuration::TenSeconds), Some(true), true, 168), + (Some(Kling2p6ProImageToVideoDuration::TenSeconds), None, false, 140), + (Some(Kling2p6ProImageToVideoDuration::TenSeconds), None, true, 168), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, voice_present, expected) in COST_TABLE { + let voice_ids = if voice_present { Some(vec!["voice_a".to_string()]) } else { None }; + let got = make_request(duration, generate_audio, voice_ids).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} audio={generate_audio:?} voice={voice_present}", + ); + } + } + + /// Number of voice IDs (1 vs 2) doesn't affect cost — only the presence + /// of at least one. Tests 1 and 2 voices (fal's max). + #[test] + fn voice_count_does_not_affect_cost() { + let one = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + Some(vec!["voice_a".to_string()]), + ).calculate_cost_in_cents(); + let two = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + Some(vec!["voice_a".to_string(), "voice_b".to_string()]), + ).calculate_cost_in_cents(); + assert_eq!(one, two); + assert_eq!(one, 84); + } + + /// end_image_url is not part of the billing formula. + #[test] + fn cost_is_independent_of_end_image_url() { + let with_end = Kling2p6ProImageToVideoRequest { + end_image_url: Some("https://example.com/end.png".to_string()), + ..make_request(Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(true), None) + }; + let without_end = make_request( + Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + Some(true), + None, + ); + assert_eq!( + with_end.calculate_cost_in_cents(), + without_end.calculate_cost_in_cents(), + ); + } + + /// Sanity-check fal's documented examples: + /// "a 5-second video with audio costs $0.70" + /// "a 10-second video with audio and voice control costs $1.68" + #[test] + fn matches_documented_examples() { + // 5s + audio = $0.70 + assert_eq!( + make_request(Some(Kling2p6ProImageToVideoDuration::FiveSeconds), Some(true), None) + .calculate_cost_in_cents(), + 70, + ); + // 10s + audio + voice = $1.68 + assert_eq!( + make_request( + Some(Kling2p6ProImageToVideoDuration::TenSeconds), + Some(true), + Some(vec!["voice_a".to_string()]), + ).calculate_cost_in_cents(), + 168, + ); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/raw_request.rs new file mode 100644 index 00000000..125101c7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_2p6_pro_image_to_video/raw_request.rs @@ -0,0 +1,45 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v2.6/pro/image-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling2p6ProImageToVideoInput { + pub prompt: String, + + /// URL of the image used as the first frame. + pub start_image_url: String, + + /// URL of the image used as the last frame (optional). + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Whether to generate native audio for the video. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Voice IDs for video generation. Reference them in the prompt with + /// `<<>>` and `<<>>` — maximum of 2 voices per task. + /// Sourced from fal's `create-voice` endpoint. + #[serde(skip_serializing_if = "Option::is_none")] + pub voice_ids: Option>, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p6ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p6ProImageToVideoOutput { + pub video: Kling2p6ProImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/api.rs new file mode 100644 index 00000000..967a78d7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/api.rs @@ -0,0 +1,294 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::kling_3p0_standard_image_to_video::raw_request::{ + Kling3p0StandardImageToVideoInput, Kling3p0StandardImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling3p0StandardImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Starting frame image URL. + pub image_url: String, + + /// Optional end frame image URL. + pub end_image_url: Option, + + /// Whether to generate audio. Defaults to true if not specified. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Video duration. + pub duration: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, + + /// Shot type for multi-shot generation. + pub shot_type: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling3p0StandardImageToVideoDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +impl Kling3p0StandardImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::ThreeSeconds => 3, + Self::FourSeconds => 4, + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + Self::NineSeconds => 9, + Self::TenSeconds => 10, + Self::ElevenSeconds => 11, + Self::TwelveSeconds => 12, + Self::ThirteenSeconds => 13, + Self::FourteenSeconds => 14, + Self::FifteenSeconds => 15, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSeconds => "3", + Self::FourSeconds => "4", + Self::FiveSeconds => "5", + Self::SixSeconds => "6", + Self::SevenSeconds => "7", + Self::EightSeconds => "8", + Self::NineSeconds => "9", + Self::TenSeconds => "10", + Self::ElevenSeconds => "11", + Self::TwelveSeconds => "12", + Self::ThirteenSeconds => "13", + Self::FourteenSeconds => "14", + Self::FifteenSeconds => "15", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling3p0StandardImageToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling3p0StandardImageToVideoShotType { + Customize, + Intelligent, +} + +impl FalEndpoint for Kling3p0StandardImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v3/standard/image-to-video"; + + type RawRequest = Kling3p0StandardImageToVideoInput; + type RawResponse = Kling3p0StandardImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling3p0StandardImageToVideoAspectRatio::Square => "1:1", + Kling3p0StandardImageToVideoAspectRatio::SixteenByNine => "16:9", + Kling3p0StandardImageToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + let shot_type = self.shot_type.map(|st| match st { + Kling3p0StandardImageToVideoShotType::Customize => "customize", + Kling3p0StandardImageToVideoShotType::Intelligent => "intelligent", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + end_image_url: self.end_image_url.clone(), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + duration, + aspect_ratio, + shot_type, + cfg_scale: None, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking toward the camera".to_string(), + duration: Some(Kling3p0StandardImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(true), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton comes alive and roars at the camera".to_string(), + duration: Some(Kling3p0StandardImageToVideoDuration::ThreeSeconds), + aspect_ratio: Some(Kling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling3p0StandardImageToVideoAspectRatio::Square, + Kling3p0StandardImageToVideoAspectRatio::SixteenByNine, + Kling3p0StandardImageToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton comes alive and roars at the camera".to_string(), + duration: Some(Kling3p0StandardImageToVideoDuration::ThreeSeconds), + aspect_ratio: Some(ar), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling3p0StandardImageToVideoDuration::ThreeSeconds, + Kling3p0StandardImageToVideoDuration::FourSeconds, + Kling3p0StandardImageToVideoDuration::FiveSeconds, + Kling3p0StandardImageToVideoDuration::SixSeconds, + Kling3p0StandardImageToVideoDuration::SevenSeconds, + Kling3p0StandardImageToVideoDuration::EightSeconds, + Kling3p0StandardImageToVideoDuration::NineSeconds, + Kling3p0StandardImageToVideoDuration::TenSeconds, + Kling3p0StandardImageToVideoDuration::ElevenSeconds, + Kling3p0StandardImageToVideoDuration::TwelveSeconds, + Kling3p0StandardImageToVideoDuration::ThirteenSeconds, + Kling3p0StandardImageToVideoDuration::FourteenSeconds, + Kling3p0StandardImageToVideoDuration::FifteenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly turns its head and opens its jaw".to_string(), + duration: Some(dur), + aspect_ratio: Some(Kling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_shot_types() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let shot_types = [ + Kling3p0StandardImageToVideoShotType::Customize, + Kling3p0StandardImageToVideoShotType::Intelligent, + ]; + + for st in shot_types { + println!("--- shot type: {:?} ---", st); + let request = Kling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton lurches forward dramatically".to_string(), + duration: Some(Kling3p0StandardImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(true), + negative_prompt: None, + end_image_url: None, + shot_type: Some(st), + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/cost.rs new file mode 100644 index 00000000..9adb31b8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/cost.rs @@ -0,0 +1,110 @@ +use crate::requests::api::video::image::kling_3p0_standard_image_to_video::api::{ + Kling3p0StandardImageToVideoDuration, Kling3p0StandardImageToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling3p0StandardImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Same pricing as text-to-video for Kling 3.0 Standard: + // Audio off: $0.168/second + // Audio on: $0.252/second + let generate_audio = self.generate_audio.unwrap_or(true); + let duration_secs = self.duration + .unwrap_or(Kling3p0StandardImageToVideoDuration::FiveSeconds) + .to_seconds(); + + // Rate in tenths-of-cents per second, rounded up + let rate = if generate_audio { 252u64 } else { 168u64 }; + (rate * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::kling_3p0_standard_image_to_video::api::{ + Kling3p0StandardImageToVideoAspectRatio, Kling3p0StandardImageToVideoDuration, + }; + + fn make_request( + generate_audio: Option, + duration: Option, + ) -> Kling3p0StandardImageToVideoRequest { + Kling3p0StandardImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/image.jpg".to_string(), + end_image_url: None, + generate_audio, + negative_prompt: None, + duration, + aspect_ratio: Some(Kling3p0StandardImageToVideoAspectRatio::SixteenByNine), + shot_type: None, + } + } + + mod audio_off { + use super::*; + + // Audio off: $0.168/sec → rate = 168 tenths-of-cents/sec + + #[test] + fn five_seconds() { + // (168 * 5 + 9) / 10 = 84 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardImageToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 84); + } + + #[test] + fn ten_seconds() { + // (168 * 10 + 9) / 10 = 168 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardImageToVideoDuration::TenSeconds)).calculate_cost_in_cents(), 168); + } + + #[test] + fn fifteen_seconds() { + // (168 * 15 + 9) / 10 = 252 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardImageToVideoDuration::FifteenSeconds)).calculate_cost_in_cents(), 252); + } + } + + mod audio_on { + use super::*; + + // Audio on: $0.252/sec → rate = 252 tenths-of-cents/sec + + #[test] + fn five_seconds() { + // (252 * 5 + 9) / 10 = 126 + assert_eq!(make_request(Some(true), Some(Kling3p0StandardImageToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 126); + } + + #[test] + fn ten_seconds() { + // (252 * 10 + 9) / 10 = 252 + assert_eq!(make_request(Some(true), Some(Kling3p0StandardImageToVideoDuration::TenSeconds)).calculate_cost_in_cents(), 252); + } + } + + mod defaults { + use super::*; + + #[test] + fn default_audio_is_on() { + // generate_audio=None defaults to true (audio on) + // duration=5s: (252 * 5 + 9) / 10 = 126 + assert_eq!(make_request(None, Some(Kling3p0StandardImageToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 126); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None defaults to 5s + // audio off: (168 * 5 + 9) / 10 = 84 + assert_eq!(make_request(Some(false), None).calculate_cost_in_cents(), 84); + } + + #[test] + fn both_defaults() { + // audio on + 5s: (252 * 5 + 9) / 10 = 126 + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 126); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/raw_request.rs new file mode 100644 index 00000000..cab12ca3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/kling_3p0_standard_image_to_video/raw_request.rs @@ -0,0 +1,51 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling3p0StandardImageToVideoInput { + pub prompt: String, + + /// Starting frame image URL. + pub image_url: String, + + /// Optional end frame image URL. + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Whether to generate audio alongside the video. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds (as a string). + /// Options: "3" through "15" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Shot type for multi-shot video generation. + /// Possible values: "customize", "intelligent" + #[serde(skip_serializing_if = "Option::is_none")] + pub shot_type: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardImageToVideoOutput { + pub video: Kling3p0StandardImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/mod.rs new file mode 100644 index 00000000..b41bd9b1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/mod.rs @@ -0,0 +1,12 @@ +pub mod kling_1p6_pro_image_to_video; +pub mod kling_2p5_turbo_pro_image_to_video; +pub mod kling_2p6_pro_image_to_video; +pub mod kling_3p0_standard_image_to_video; +pub mod veo_2; +pub mod veo_3; +pub mod veo_3_fast; +pub mod veo_3p1; +pub mod veo_3p1_fast; +pub mod veo_3p1_lite; +pub mod vidu_q3; +pub mod vidu_q3_turbo; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/api.rs new file mode 100644 index 00000000..1b7ad602 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/api.rs @@ -0,0 +1,158 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::veo_2::raw_request::{ + Veo2ImageToVideoInput, Veo2ImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo2ImageToVideoRequest { + /// Text prompt describing how the image should be animated. + pub prompt: String, + + /// URL of the input image to animate (720p+, 16:9 or 9:16). + pub image_url: String, + + /// Video duration. fal's default is `5s` when `None`. + pub duration: Option, +} + +/// Veo 2 supports 5–8 second durations (default 5s). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo2ImageToVideoDuration { + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, +} + +impl Veo2ImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5s", + Self::SixSeconds => "6s", + Self::SevenSeconds => "7s", + Self::EightSeconds => "8s", + } + } +} + +impl FalEndpoint for Veo2ImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo2/image-to-video"; + + type RawRequest = Veo2ImageToVideoInput; + type RawResponse = Veo2ImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + duration: self.duration.map(|d| d.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo2ImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + duration: Some(Veo2ImageToVideoDuration::FiveSeconds), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo2ImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + duration: Some(Veo2ImageToVideoDuration::FiveSeconds), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo2ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + duration: Some(Veo2ImageToVideoDuration::EightSeconds), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.duration.as_deref(), Some("8s")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo2ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + duration: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo2ImageToVideoDuration::FiveSeconds, "5s", 5), + (Veo2ImageToVideoDuration::SixSeconds, "6s", 6), + (Veo2ImageToVideoDuration::SevenSeconds, "7s", 7), + (Veo2ImageToVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo2ImageToVideoRequest::ENDPOINT, "fal-ai/veo2/image-to-video"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/cost.rs new file mode 100644 index 00000000..91680db4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/cost.rs @@ -0,0 +1,62 @@ +use crate::requests::api::video::image::veo_2::api::{Veo2ImageToVideoDuration, Veo2ImageToVideoRequest}; +use crate::requests::api::video::text::veo_2::cost::veo_2_cost_cents; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Veo 2 pricing (see the text module for the +// canonical formula): $2.50 base for 5s, +$0.50 per additional second. + +impl FalRequestCostCalculator for Veo2ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal default when unset: duration = 5s. + let duration_secs = self.duration + .unwrap_or(Veo2ImageToVideoDuration::FiveSeconds) + .to_seconds(); + veo_2_cost_cents(duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request(duration: Option) -> Veo2ImageToVideoRequest { + Veo2ImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + duration, + } + } + + mod cost_table { + use super::*; + + // (duration, expected_cents): 250 base + 50 per second over 5s. + const COST_TABLE: &[(Option, u64)] = &[ + (Some(Veo2ImageToVideoDuration::FiveSeconds), 250), + (Some(Veo2ImageToVideoDuration::SixSeconds), 300), + (Some(Veo2ImageToVideoDuration::SevenSeconds), 350), + (Some(Veo2ImageToVideoDuration::EightSeconds), 400), + // Default: duration=None → 5s + (None, 250), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, expected) in COST_TABLE { + assert_eq!( + make_request(duration).calculate_cost_in_cents(), + expected, + "duration={duration:?}", + ); + } + } + + /// Image-to-video must bill identically to text-to-video at every duration. + #[test] + fn matches_text_to_video_pricing() { + for (secs, expected) in [(5, 250), (6, 300), (7, 350), (8, 400)] { + assert_eq!(veo_2_cost_cents(secs), expected, "secs={secs}"); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/raw_request.rs new file mode 100644 index 00000000..eb6afd3a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_2/raw_request.rs @@ -0,0 +1,31 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo2/image-to-video`. +/// fal's schema: +/// +/// NB: Veo 2 image-to-video has a minimal schema — only `prompt`, `image_url`, +/// and `duration`. There is no aspect_ratio, negative_prompt, seed, auto_fix, +/// enhance_prompt, resolution, or generate_audio (aspect ratio is taken from +/// the input image). +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo2ImageToVideoInput { + pub prompt: String, + + /// URL of the input image to animate (720p+, 16:9 or 9:16). + pub image_url: String, + + /// Duration in seconds (as a string). + /// Possible values: "5s", "6s", "7s", "8s". fal default: "5s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2ImageToVideoOutput { + pub video: Veo2ImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/api.rs new file mode 100644 index 00000000..22cd69d1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/api.rs @@ -0,0 +1,276 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::veo_3::raw_request::{ + Veo3ImageToVideoInput, Veo3ImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3ImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` for image-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3ImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3ImageToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3ImageToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3ImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3 exposes only 720p/1080p (no 4k tier). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3ImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3ImageToVideoResolution { + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3ImageToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3ImageToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3ImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3/image-to-video"; + + type RawRequest = Veo3ImageToVideoInput; + type RawResponse = Veo3ImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3ImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3ImageToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3ImageToVideoDuration::FourSeconds), + resolution: Some(Veo3ImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3ImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3ImageToVideoDuration::FourSeconds), + resolution: Some(Veo3ImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: Some(Veo3ImageToVideoAspectRatio::Auto), + duration: Some(Veo3ImageToVideoDuration::SixSeconds), + resolution: Some(Veo3ImageToVideoResolution::TenEightyP), + generate_audio: Some(false), + negative_prompt: Some("nope".to_string()), + seed: Some(7), + auto_fix: Some(true), + safety_tolerance: Some(Veo3ImageToVideoSafetyTolerance::Level2), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("auto")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.generate_audio, Some(false)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(7)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("2")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3ImageToVideoAspectRatio::Auto, "auto"), + (Veo3ImageToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3ImageToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo3ImageToVideoRequest::ENDPOINT, "fal-ai/veo3/image-to-video"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/cost.rs new file mode 100644 index 00000000..d9bbe0be --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/cost.rs @@ -0,0 +1,90 @@ +use crate::requests::api::video::image::veo_3::api::{ + Veo3ImageToVideoDuration, Veo3ImageToVideoRequest, +}; +use crate::requests::api::video::text::veo_3::cost::{veo_3_cost_cents, veo_3_rate_tenth_cents_per_sec}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Veo 3 (non-fast) per-second pricing (see the text +// module for the canonical rate table): $0.20/sec (audio off), $0.40/sec +// (audio on). Flat — resolution does not affect the price. + +impl FalRequestCostCalculator for Veo3ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3ImageToVideoDuration::EightSeconds) + .to_seconds(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3_rate_tenth_cents_per_sec(audio_on); + veo_3_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::veo_3::api::Veo3ImageToVideoAspectRatio; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Veo3ImageToVideoRequest { + Veo3ImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + aspect_ratio: None, + duration, + resolution: None, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + (Some(Veo3ImageToVideoDuration::FourSeconds), Some(false), 80), + (Some(Veo3ImageToVideoDuration::FourSeconds), Some(true), 160), + (Some(Veo3ImageToVideoDuration::EightSeconds), Some(false), 160), + (Some(Veo3ImageToVideoDuration::EightSeconds), Some(true), 320), + // Defaults: 8s, audio on + (None, None, 320), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, generate_audio).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} audio={generate_audio:?}"); + } + } + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let baseline = { + let mut r = make_request(Some(Veo3ImageToVideoDuration::EightSeconds), Some(true)); + r.aspect_ratio = Some(Veo3ImageToVideoAspectRatio::Auto); + r.calculate_cost_in_cents() + }; + for ar in [ + Veo3ImageToVideoAspectRatio::Auto, + Veo3ImageToVideoAspectRatio::SixteenByNine, + Veo3ImageToVideoAspectRatio::NineBySixteen, + ] { + let mut r = make_request(Some(Veo3ImageToVideoDuration::EightSeconds), Some(true)); + r.aspect_ratio = Some(ar); + assert_eq!(r.calculate_cost_in_cents(), baseline, "ar={ar:?}"); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/raw_request.rs new file mode 100644 index 00000000..7432fff6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3/raw_request.rs @@ -0,0 +1,57 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3/image-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3ImageToVideoInput { + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false (image-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3ImageToVideoOutput { + pub video: Veo3ImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/api.rs new file mode 100644 index 00000000..91e4161a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/api.rs @@ -0,0 +1,279 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::veo_3_fast::raw_request::{ + Veo3FastImageToVideoInput, Veo3FastImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3FastImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` for image-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3FastImageToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastImageToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3FastImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3 Fast exposes only 720p/1080p (no 4k tier). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3FastImageToVideoResolution { + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastImageToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3FastImageToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3FastImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3/fast/image-to-video"; + + type RawRequest = Veo3FastImageToVideoInput; + type RawResponse = Veo3FastImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3FastImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3FastImageToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3FastImageToVideoDuration::FourSeconds), + resolution: Some(Veo3FastImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3FastImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3FastImageToVideoDuration::FourSeconds), + resolution: Some(Veo3FastImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3FastImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: Some(Veo3FastImageToVideoAspectRatio::Auto), + duration: Some(Veo3FastImageToVideoDuration::SixSeconds), + resolution: Some(Veo3FastImageToVideoResolution::TenEightyP), + generate_audio: Some(false), + negative_prompt: Some("nope".to_string()), + seed: Some(7), + auto_fix: Some(true), + safety_tolerance: Some(Veo3FastImageToVideoSafetyTolerance::Level2), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("auto")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.generate_audio, Some(false)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(7)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("2")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3FastImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3FastImageToVideoAspectRatio::Auto, "auto"), + (Veo3FastImageToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3FastImageToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3FastImageToVideoRequest::ENDPOINT, + "fal-ai/veo3/fast/image-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/cost.rs new file mode 100644 index 00000000..fa1e72fd --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/cost.rs @@ -0,0 +1,92 @@ +use crate::requests::api::video::image::veo_3_fast::api::{ + Veo3FastImageToVideoDuration, Veo3FastImageToVideoRequest, +}; +use crate::requests::api::video::text::veo_3_fast::cost::{ + veo_3_fast_cost_cents, veo_3_fast_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Veo 3 Fast per-second pricing (see the text module +// for the canonical rate table): $0.10/sec (audio off), $0.15/sec (audio on). +// Flat — resolution does not affect the price. + +impl FalRequestCostCalculator for Veo3FastImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3FastImageToVideoDuration::EightSeconds) + .to_seconds(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3_fast_rate_tenth_cents_per_sec(audio_on); + veo_3_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::veo_3_fast::api::Veo3FastImageToVideoAspectRatio; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Veo3FastImageToVideoRequest { + Veo3FastImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + aspect_ratio: None, + duration, + resolution: None, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + (Some(Veo3FastImageToVideoDuration::FourSeconds), Some(false), 40), + (Some(Veo3FastImageToVideoDuration::FourSeconds), Some(true), 60), + (Some(Veo3FastImageToVideoDuration::EightSeconds), Some(false), 80), + (Some(Veo3FastImageToVideoDuration::EightSeconds), Some(true), 120), + // Defaults: 8s, audio on + (None, None, 120), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, generate_audio).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} audio={generate_audio:?}"); + } + } + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let baseline = { + let mut r = make_request(Some(Veo3FastImageToVideoDuration::EightSeconds), Some(true)); + r.aspect_ratio = Some(Veo3FastImageToVideoAspectRatio::Auto); + r.calculate_cost_in_cents() + }; + for ar in [ + Veo3FastImageToVideoAspectRatio::Auto, + Veo3FastImageToVideoAspectRatio::SixteenByNine, + Veo3FastImageToVideoAspectRatio::NineBySixteen, + ] { + let mut r = make_request(Some(Veo3FastImageToVideoDuration::EightSeconds), Some(true)); + r.aspect_ratio = Some(ar); + assert_eq!(r.calculate_cost_in_cents(), baseline, "ar={ar:?}"); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/raw_request.rs new file mode 100644 index 00000000..ceabad96 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3_fast/raw_request.rs @@ -0,0 +1,57 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3/fast/image-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3FastImageToVideoInput { + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false (image-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3FastImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3FastImageToVideoOutput { + pub video: Veo3FastImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/api.rs new file mode 100644 index 00000000..c0041da2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/api.rs @@ -0,0 +1,285 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::veo_3p1::raw_request::{ + Veo3p1ImageToVideoInput, Veo3p1ImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1ImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` for image-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1ImageToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ImageToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1ImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ImageToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1ImageToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ImageToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1ImageToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1ImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/image-to-video"; + + type RawRequest = Veo3p1ImageToVideoInput; + type RawResponse = Veo3p1ImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1ImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3p1ImageToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1ImageToVideoDuration::FourSeconds), + resolution: Some(Veo3p1ImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1ImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1ImageToVideoDuration::FourSeconds), + resolution: Some(Veo3p1ImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: Some(Veo3p1ImageToVideoAspectRatio::Auto), + duration: Some(Veo3p1ImageToVideoDuration::SixSeconds), + resolution: Some(Veo3p1ImageToVideoResolution::TenEightyP), + generate_audio: Some(false), + negative_prompt: Some("nope".to_string()), + seed: Some(7), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1ImageToVideoSafetyTolerance::Level2), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("auto")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.generate_audio, Some(false)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(7)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("2")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3p1ImageToVideoAspectRatio::Auto, "auto"), + (Veo3p1ImageToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3p1ImageToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1ImageToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/image-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/cost.rs new file mode 100644 index 00000000..e1287595 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/cost.rs @@ -0,0 +1,112 @@ +use crate::requests::api::video::image::veo_3p1::api::{ + Veo3p1ImageToVideoDuration, Veo3p1ImageToVideoRequest, Veo3p1ImageToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1::cost::{ + veo_3p1_cost_cents, veo_3p1_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Veo 3.1 (non-fast) per-second pricing (see the +// text module for the canonical rate table): +// 720p / 1080p: $0.20/sec (audio off), $0.40/sec (audio on) +// 4k: $0.40/sec (audio off), $0.60/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1ImageToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1ImageToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::veo_3p1::api::Veo3p1ImageToVideoAspectRatio; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1ImageToVideoRequest { + Veo3p1ImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + aspect_ratio: Some(Veo3p1ImageToVideoAspectRatio::SixteenByNine), + duration, + resolution, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1ImageToVideoDuration::FourSeconds), Some(Veo3p1ImageToVideoResolution::SevenTwentyP), Some(false), 80), + (Some(Veo3p1ImageToVideoDuration::FourSeconds), Some(Veo3p1ImageToVideoResolution::SevenTwentyP), Some(true), 160), + (Some(Veo3p1ImageToVideoDuration::EightSeconds), Some(Veo3p1ImageToVideoResolution::TenEightyP), Some(false), 160), + (Some(Veo3p1ImageToVideoDuration::EightSeconds), Some(Veo3p1ImageToVideoResolution::TenEightyP), Some(true), 320), + (Some(Veo3p1ImageToVideoDuration::EightSeconds), Some(Veo3p1ImageToVideoResolution::FourK), Some(false), 320), + (Some(Veo3p1ImageToVideoDuration::EightSeconds), Some(Veo3p1ImageToVideoResolution::FourK), Some(true), 480), + // Defaults: 8s, 720p, audio on + (None, None, None, 320), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + Veo3p1ImageToVideoAspectRatio::Auto, + Veo3p1ImageToVideoAspectRatio::SixteenByNine, + Veo3p1ImageToVideoAspectRatio::NineBySixteen, + ]; + let baseline = { + let mut r = make_request( + Some(Veo3p1ImageToVideoDuration::EightSeconds), + Some(Veo3p1ImageToVideoResolution::TenEightyP), + Some(true), + ); + r.aspect_ratio = Some(aspect_ratios[0]); + r.calculate_cost_in_cents() + }; + for ar in aspect_ratios { + let mut r = make_request( + Some(Veo3p1ImageToVideoDuration::EightSeconds), + Some(Veo3p1ImageToVideoResolution::TenEightyP), + Some(true), + ); + r.aspect_ratio = Some(ar); + assert_eq!(r.calculate_cost_in_cents(), baseline, "ar={ar:?}"); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/raw_request.rs new file mode 100644 index 00000000..4fb1f8a9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1/raw_request.rs @@ -0,0 +1,58 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/image-to-video` +/// (single start-frame keyframe). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1ImageToVideoInput { + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false (image-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ImageToVideoOutput { + pub video: Veo3p1ImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/api.rs new file mode 100644 index 00000000..08b3f88c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/api.rs @@ -0,0 +1,286 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::veo_3p1_fast::raw_request::{ + Veo3p1FastImageToVideoInput, Veo3p1FastImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1FastImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` for image-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1FastImageToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastImageToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1FastImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastImageToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1FastImageToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastImageToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1FastImageToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1FastImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/fast/image-to-video"; + + type RawRequest = Veo3p1FastImageToVideoInput; + type RawResponse = Veo3p1FastImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3p1FastImageToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastImageToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1FastImageToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1FastImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: Some(Veo3p1FastImageToVideoAspectRatio::Auto), + duration: Some(Veo3p1FastImageToVideoDuration::SixSeconds), + resolution: Some(Veo3p1FastImageToVideoResolution::TenEightyP), + generate_audio: Some(false), + negative_prompt: Some("nope".to_string()), + seed: Some(7), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1FastImageToVideoSafetyTolerance::Level2), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("auto")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.generate_audio, Some(false)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(7)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("2")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1FastImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + // Only the two required fields remain on the wire. + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3p1FastImageToVideoAspectRatio::Auto, "auto"), + (Veo3p1FastImageToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3p1FastImageToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1FastImageToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/fast/image-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..856b4d0b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/cost.rs @@ -0,0 +1,112 @@ +use crate::requests::api::video::image::veo_3p1_fast::api::{ + Veo3p1FastImageToVideoDuration, Veo3p1FastImageToVideoRequest, Veo3p1FastImageToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1_fast::cost::{ + veo_3p1_fast_cost_cents, veo_3p1_fast_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Veo 3.1 Fast per-second pricing (see the text +// module for the canonical rate table): +// 720p / 1080p: $0.10/sec (audio off), $0.15/sec (audio on) +// 4k: $0.30/sec (audio off), $0.35/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1FastImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1FastImageToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1FastImageToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_fast_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::veo_3p1_fast::api::Veo3p1FastImageToVideoAspectRatio; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1FastImageToVideoRequest { + Veo3p1FastImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + aspect_ratio: Some(Veo3p1FastImageToVideoAspectRatio::SixteenByNine), + duration, + resolution, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1FastImageToVideoDuration::FourSeconds), Some(Veo3p1FastImageToVideoResolution::SevenTwentyP), Some(false), 40), + (Some(Veo3p1FastImageToVideoDuration::FourSeconds), Some(Veo3p1FastImageToVideoResolution::SevenTwentyP), Some(true), 60), + (Some(Veo3p1FastImageToVideoDuration::EightSeconds), Some(Veo3p1FastImageToVideoResolution::TenEightyP), Some(false), 80), + (Some(Veo3p1FastImageToVideoDuration::EightSeconds), Some(Veo3p1FastImageToVideoResolution::TenEightyP), Some(true), 120), + (Some(Veo3p1FastImageToVideoDuration::EightSeconds), Some(Veo3p1FastImageToVideoResolution::FourK), Some(false), 240), + (Some(Veo3p1FastImageToVideoDuration::EightSeconds), Some(Veo3p1FastImageToVideoResolution::FourK), Some(true), 280), + // Defaults: 8s, 720p, audio on + (None, None, None, 120), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + Veo3p1FastImageToVideoAspectRatio::Auto, + Veo3p1FastImageToVideoAspectRatio::SixteenByNine, + Veo3p1FastImageToVideoAspectRatio::NineBySixteen, + ]; + let baseline = { + let mut r = make_request( + Some(Veo3p1FastImageToVideoDuration::EightSeconds), + Some(Veo3p1FastImageToVideoResolution::TenEightyP), + Some(true), + ); + r.aspect_ratio = Some(aspect_ratios[0]); + r.calculate_cost_in_cents() + }; + for ar in aspect_ratios { + let mut r = make_request( + Some(Veo3p1FastImageToVideoDuration::EightSeconds), + Some(Veo3p1FastImageToVideoResolution::TenEightyP), + Some(true), + ); + r.aspect_ratio = Some(ar); + assert_eq!(r.calculate_cost_in_cents(), baseline, "ar={ar:?}"); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/raw_request.rs new file mode 100644 index 00000000..5eb7bde5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_fast/raw_request.rs @@ -0,0 +1,58 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/fast/image-to-video` +/// (single start-frame keyframe). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastImageToVideoInput { + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false (image-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastImageToVideoOutput { + pub video: Veo3p1FastImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/api.rs new file mode 100644 index 00000000..434dc2be --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/api.rs @@ -0,0 +1,285 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::veo_3p1_lite::raw_request::{ + Veo3p1LiteImageToVideoInput, Veo3p1LiteImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1LiteImageToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` for image-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1LiteImageToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteImageToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1LiteImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3.1 Lite exposes only 720p/1080p (no 4k tier). Both resolution AND +/// audio affect the per-second price. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3p1LiteImageToVideoResolution { + /// 1080p is billed at a higher per-second rate than 720p. + pub fn is_ten_eighty_p(&self) -> bool { + matches!(self, Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteImageToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1LiteImageToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1LiteImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/lite/image-to-video"; + + type RawRequest = Veo3p1LiteImageToVideoInput; + type RawResponse = Veo3p1LiteImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1LiteImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3p1LiteImageToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1LiteImageToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1LiteImageToVideoRequest { + prompt: "wind moves through the trees".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1LiteImageToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteImageToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1LiteImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: Some(Veo3p1LiteImageToVideoAspectRatio::Auto), + duration: Some(Veo3p1LiteImageToVideoDuration::SixSeconds), + resolution: Some(Veo3p1LiteImageToVideoResolution::TenEightyP), + generate_audio: Some(false), + negative_prompt: Some("nope".to_string()), + seed: Some(7), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1LiteImageToVideoSafetyTolerance::Level2), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("auto")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.generate_audio, Some(false)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(7)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("2")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1LiteImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3p1LiteImageToVideoAspectRatio::Auto, "auto"), + (Veo3p1LiteImageToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3p1LiteImageToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1LiteImageToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/lite/image-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/cost.rs new file mode 100644 index 00000000..0116c2ce --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/cost.rs @@ -0,0 +1,102 @@ +use crate::requests::api::video::image::veo_3p1_lite::api::{ + Veo3p1LiteImageToVideoDuration, Veo3p1LiteImageToVideoRequest, Veo3p1LiteImageToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1_lite::cost::{ + veo_3p1_lite_cost_cents, veo_3p1_lite_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Veo 3.1 Lite per-second pricing (see the text +// module for the canonical rate table). Both resolution and audio matter: +// 720p: $0.03/sec (audio off), $0.05/sec (audio on) +// 1080p: $0.05/sec (audio off), $0.08/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1LiteImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1LiteImageToVideoDuration::EightSeconds) + .to_seconds(); + let is_1080p = self.resolution + .unwrap_or(Veo3p1LiteImageToVideoResolution::SevenTwentyP) + .is_ten_eighty_p(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_lite_rate_tenth_cents_per_sec(is_1080p, audio_on); + veo_3p1_lite_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::image::veo_3p1_lite::api::Veo3p1LiteImageToVideoAspectRatio; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1LiteImageToVideoRequest { + Veo3p1LiteImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + aspect_ratio: None, + duration, + resolution, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1LiteImageToVideoDuration::FourSeconds), Some(Veo3p1LiteImageToVideoResolution::SevenTwentyP), Some(false), 12), + (Some(Veo3p1LiteImageToVideoDuration::FourSeconds), Some(Veo3p1LiteImageToVideoResolution::SevenTwentyP), Some(true), 20), + (Some(Veo3p1LiteImageToVideoDuration::EightSeconds), Some(Veo3p1LiteImageToVideoResolution::SevenTwentyP), Some(true), 40), + (Some(Veo3p1LiteImageToVideoDuration::EightSeconds), Some(Veo3p1LiteImageToVideoResolution::TenEightyP), Some(false), 40), + (Some(Veo3p1LiteImageToVideoDuration::EightSeconds), Some(Veo3p1LiteImageToVideoResolution::TenEightyP), Some(true), 64), + // Defaults: 8s, 720p, audio on + (None, None, None, 40), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let baseline = { + let mut r = make_request(Some(Veo3p1LiteImageToVideoDuration::EightSeconds), Some(Veo3p1LiteImageToVideoResolution::TenEightyP), Some(true)); + r.aspect_ratio = Some(Veo3p1LiteImageToVideoAspectRatio::Auto); + r.calculate_cost_in_cents() + }; + for ar in [ + Veo3p1LiteImageToVideoAspectRatio::Auto, + Veo3p1LiteImageToVideoAspectRatio::SixteenByNine, + Veo3p1LiteImageToVideoAspectRatio::NineBySixteen, + ] { + let mut r = make_request(Some(Veo3p1LiteImageToVideoDuration::EightSeconds), Some(Veo3p1LiteImageToVideoResolution::TenEightyP), Some(true)); + r.aspect_ratio = Some(ar); + assert_eq!(r.calculate_cost_in_cents(), baseline, "ar={ar:?}"); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/raw_request.rs new file mode 100644 index 00000000..4c0ccd78 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/veo_3p1_lite/raw_request.rs @@ -0,0 +1,58 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/lite/image-to-video` +/// (single start-frame keyframe). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1LiteImageToVideoInput { + pub prompt: String, + + /// URL of the image used as the starting frame. + pub image_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false (image-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1LiteImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1LiteImageToVideoOutput { + pub video: Veo3p1LiteImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/api.rs new file mode 100644 index 00000000..5ed499fc --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/api.rs @@ -0,0 +1,197 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::vidu_q3::raw_request::{ + ViduQ3ImageToVideoInput, ViduQ3ImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct ViduQ3ImageToVideoRequest { + /// Text prompt (max 2000 characters). Optional server-side; pass an empty + /// string for a pure image-to-video generation. + pub prompt: String, + + /// URL of the image used as the starting frame (URL or base64). + pub image_url: String, + + /// Optional URL of an ending frame, for start→end transition videos. + pub end_image_url: Option, + + /// Duration in seconds. Valid range 1–16; fal's default is `5` when `None`. + pub duration: Option, + + /// Seed for reproducibility. Random when `None`. + pub seed: Option, + + /// Output resolution. fal's default is `720p` when `None`. Note fal rejects + /// `360p` when `end_image_url` is set. + pub resolution: Option, + + /// Whether to generate audio. fal's server default is `true` when `None`. + pub audio: Option, +} + +/// Vidu Q3 resolutions. 720p/1080p bill at 2.2× the 360p/540p per-second rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3ImageToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +impl ViduQ3ImageToVideoResolution { + /// 720p and 1080p are billed at the higher (2.2×) per-second rate. + pub fn is_high_res(&self) -> bool { + matches!(self, Self::SevenTwentyP | Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSixtyP => "360p", + Self::FiveFortyP => "540p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +impl FalEndpoint for ViduQ3ImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/vidu/q3/image-to-video"; + + type RawRequest = ViduQ3ImageToVideoInput; + type RawResponse = ViduQ3ImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + end_image_url: self.end_image_url.clone(), + duration: self.duration, + seed: self.seed, + resolution: self.resolution.map(|r| r.to_str().to_string()), + audio: self.audio, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3ImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(5), + seed: None, + resolution: Some(ViduQ3ImageToVideoResolution::SevenTwentyP), + audio: Some(false), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_with_end_frame_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3ImageToVideoRequest { + prompt: "a smooth transition between the two frames".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_image_url: Some(JUNO_AT_LAKE_IMAGE_URL.to_string()), + duration: Some(5), + seed: Some(1234), + resolution: Some(ViduQ3ImageToVideoResolution::SevenTwentyP), + audio: Some(false), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = ViduQ3ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + end_image_url: Some("https://example.com/end.png".to_string()), + duration: Some(7), + seed: Some(42), + resolution: Some(ViduQ3ImageToVideoResolution::TenEightyP), + audio: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.end_image_url.as_deref(), Some("https://example.com/end.png")); + assert_eq!(raw.duration, Some(7)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.audio, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = ViduQ3ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + end_image_url: None, + duration: None, + seed: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn seed_serializes_when_set() { + let request = ViduQ3ImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + end_image_url: None, + duration: None, + seed: Some(777), + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("seed").and_then(|s| s.as_i64()), Some(777)); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + ViduQ3ImageToVideoRequest::ENDPOINT, + "fal-ai/vidu/q3/image-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/cost.rs new file mode 100644 index 00000000..6f1db4bd --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/cost.rs @@ -0,0 +1,78 @@ +use crate::requests::api::video::image::vidu_q3::api::{ + ViduQ3ImageToVideoRequest, ViduQ3ImageToVideoResolution, +}; +use crate::requests::api::video::text::vidu_q3::cost::{vidu_q3_cost_cents, vidu_q3_rate_tenth_cents_per_sec}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Vidu Q3 per-second pricing (see the text module for +// the canonical rate table): +// 360p / 540p: $0.07/sec +// 720p / 1080p: $0.154/sec (2.2×) +// Pricing depends on resolution and duration only. + +impl FalRequestCostCalculator for ViduQ3ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 5s, resolution = 720p. + let duration_secs = u64::from(self.duration.unwrap_or(5)); + let is_high_res = self.resolution + .unwrap_or(ViduQ3ImageToVideoResolution::SevenTwentyP) + .is_high_res(); + + let rate = vidu_q3_rate_tenth_cents_per_sec(is_high_res); + vidu_q3_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + ) -> ViduQ3ImageToVideoRequest { + ViduQ3ImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + end_image_url: None, + duration, + seed: None, + resolution, + audio: Some(true), + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, expected_cents) + const COST_TABLE: &[(Option, Option, u64)] = &[ + (Some(5), Some(ViduQ3ImageToVideoResolution::ThreeSixtyP), 35), + (Some(5), Some(ViduQ3ImageToVideoResolution::FiveFortyP), 35), + (Some(5), Some(ViduQ3ImageToVideoResolution::SevenTwentyP), 77), + (Some(5), Some(ViduQ3ImageToVideoResolution::TenEightyP), 77), + (Some(10), Some(ViduQ3ImageToVideoResolution::SevenTwentyP), 154), + // Defaults: duration=None→5s, resolution=None→720p + (None, None, 77), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, expected) in COST_TABLE { + let got = make_request(duration, resolution).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} resolution={resolution:?}"); + } + } + + /// An end frame does not change the bill (only resolution + duration do). + #[test] + fn cost_is_independent_of_end_frame() { + let without = make_request(Some(8), Some(ViduQ3ImageToVideoResolution::SevenTwentyP)).calculate_cost_in_cents(); + let with = ViduQ3ImageToVideoRequest { + end_image_url: Some("https://example.com/end.png".to_string()), + ..make_request(Some(8), Some(ViduQ3ImageToVideoResolution::SevenTwentyP)) + }.calculate_cost_in_cents(); + assert_eq!(without, with); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/raw_request.rs new file mode 100644 index 00000000..7bab26cb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3/raw_request.rs @@ -0,0 +1,47 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/vidu/q3/image-to-video`. +/// fal's schema: +/// +/// NB: this endpoint has no `aspect_ratio` (it is derived from the input +/// image). A `prompt` is optional server-side but always sent here. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct ViduQ3ImageToVideoInput { + /// Text prompt (max 2000 characters). Optional server-side. + pub prompt: String, + + /// URL of the image used as the starting frame (URL or base64). + pub image_url: String, + + /// Optional URL of an ending frame, for start→end transition videos. + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Duration in seconds. Range 1–16. fal default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Seed for reproducibility. Random when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Output resolution. + /// Possible values: "360p", "540p", "720p", "1080p". fal default: "720p". + /// (360p is unavailable when `end_image_url` is set.) + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3ImageToVideoOutput { + pub video: ViduQ3ImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/api.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/api.rs new file mode 100644 index 00000000..0b2bfbe6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/api.rs @@ -0,0 +1,197 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::image::vidu_q3_turbo::raw_request::{ + ViduQ3TurboImageToVideoInput, ViduQ3TurboImageToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct ViduQ3TurboImageToVideoRequest { + /// Text prompt (max 2000 characters). Optional server-side; pass an empty + /// string for a pure image-to-video generation. + pub prompt: String, + + /// URL of the image used as the starting frame (URL or base64). + pub image_url: String, + + /// Optional URL of an ending frame, for start→end transition videos. + pub end_image_url: Option, + + /// Duration in seconds. Valid range 1–16; fal's default is `5` when `None`. + pub duration: Option, + + /// Seed for reproducibility. Random when `None`. + pub seed: Option, + + /// Output resolution. fal's default is `720p` when `None`. Note fal rejects + /// `360p` when `end_image_url` is set. + pub resolution: Option, + + /// Whether to generate audio. fal's server default is `true` when `None`. + pub audio: Option, +} + +/// Vidu Q3 Turbo resolutions. 720p/1080p bill at 2.2× the 360p/540p rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3TurboImageToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +impl ViduQ3TurboImageToVideoResolution { + /// 720p and 1080p are billed at the higher (2.2×) per-second rate. + pub fn is_high_res(&self) -> bool { + matches!(self, Self::SevenTwentyP | Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSixtyP => "360p", + Self::FiveFortyP => "540p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +impl FalEndpoint for ViduQ3TurboImageToVideoRequest { + const ENDPOINT: &str = "fal-ai/vidu/q3/image-to-video/turbo"; + + type RawRequest = ViduQ3TurboImageToVideoInput; + type RawResponse = ViduQ3TurboImageToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_url: self.image_url.clone(), + end_image_url: self.end_image_url.clone(), + duration: self.duration, + seed: self.seed, + resolution: self.resolution.map(|r| r.to_str().to_string()), + audio: self.audio, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3TurboImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples and dappled sunlight".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(5), + seed: None, + resolution: Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP), + audio: Some(false), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_image_to_video_with_end_frame_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3TurboImageToVideoRequest { + prompt: "a smooth transition between the two frames".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_image_url: Some(JUNO_AT_LAKE_IMAGE_URL.to_string()), + duration: Some(5), + seed: Some(1234), + resolution: Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP), + audio: Some(false), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = ViduQ3TurboImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + end_image_url: Some("https://example.com/end.png".to_string()), + duration: Some(7), + seed: Some(42), + resolution: Some(ViduQ3TurboImageToVideoResolution::TenEightyP), + audio: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.image_url, "https://example.com/start.png"); + assert_eq!(raw.end_image_url.as_deref(), Some("https://example.com/end.png")); + assert_eq!(raw.duration, Some(7)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.audio, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = ViduQ3TurboImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + end_image_url: None, + duration: None, + seed: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_url": "https://example.com/start.png" }), + ); + } + + #[test] + fn seed_serializes_when_set() { + let request = ViduQ3TurboImageToVideoRequest { + prompt: "p".to_string(), + image_url: "https://example.com/start.png".to_string(), + end_image_url: None, + duration: None, + seed: Some(777), + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("seed").and_then(|s| s.as_i64()), Some(777)); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + ViduQ3TurboImageToVideoRequest::ENDPOINT, + "fal-ai/vidu/q3/image-to-video/turbo", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/cost.rs new file mode 100644 index 00000000..f674cd75 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/cost.rs @@ -0,0 +1,80 @@ +use crate::requests::api::video::image::vidu_q3_turbo::api::{ + ViduQ3TurboImageToVideoRequest, ViduQ3TurboImageToVideoResolution, +}; +use crate::requests::api::video::text::vidu_q3_turbo::cost::{ + vidu_q3_turbo_cost_cents, vidu_q3_turbo_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Image-to-video shares the Vidu Q3 Turbo per-second pricing (see the text +// module for the canonical rate table): +// 360p / 540p: $0.035/sec +// 720p / 1080p: $0.077/sec (2.2×) +// Pricing depends on resolution and duration only. + +impl FalRequestCostCalculator for ViduQ3TurboImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 5s, resolution = 720p. + let duration_secs = u64::from(self.duration.unwrap_or(5)); + let is_high_res = self.resolution + .unwrap_or(ViduQ3TurboImageToVideoResolution::SevenTwentyP) + .is_high_res(); + + let rate = vidu_q3_turbo_rate_tenth_cents_per_sec(is_high_res); + vidu_q3_turbo_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + ) -> ViduQ3TurboImageToVideoRequest { + ViduQ3TurboImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/x.png".to_string(), + end_image_url: None, + duration, + seed: None, + resolution, + audio: Some(true), + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, expected_cents) + const COST_TABLE: &[(Option, Option, u64)] = &[ + (Some(5), Some(ViduQ3TurboImageToVideoResolution::ThreeSixtyP), 18), // 17.5 → 18 + (Some(5), Some(ViduQ3TurboImageToVideoResolution::FiveFortyP), 18), + (Some(5), Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP), 39), // 38.5 → 39 + (Some(5), Some(ViduQ3TurboImageToVideoResolution::TenEightyP), 39), + (Some(10), Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP), 77), + // Defaults: duration=None→5s, resolution=None→720p + (None, None, 39), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, expected) in COST_TABLE { + let got = make_request(duration, resolution).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} resolution={resolution:?}"); + } + } + + /// An end frame does not change the bill (only resolution + duration do). + #[test] + fn cost_is_independent_of_end_frame() { + let without = make_request(Some(8), Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP)).calculate_cost_in_cents(); + let with = ViduQ3TurboImageToVideoRequest { + end_image_url: Some("https://example.com/end.png".to_string()), + ..make_request(Some(8), Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP)) + }.calculate_cost_in_cents(); + assert_eq!(without, with); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/raw_request.rs new file mode 100644 index 00000000..a1d59532 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/image/vidu_q3_turbo/raw_request.rs @@ -0,0 +1,47 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/vidu/q3/image-to-video/turbo`. +/// fal's schema: +/// +/// NB: this endpoint has no `aspect_ratio` (derived from the input image). +/// A `prompt` is optional server-side but always sent here. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct ViduQ3TurboImageToVideoInput { + /// Text prompt (max 2000 characters). Optional server-side. + pub prompt: String, + + /// URL of the image used as the starting frame (URL or base64). + pub image_url: String, + + /// Optional URL of an ending frame, for start→end transition videos. + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Duration in seconds. Range 1–16. fal default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Seed for reproducibility. Random when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Output resolution. + /// Possible values: "360p", "540p", "720p", "1080p". fal default: "720p". + /// (360p is unavailable when `end_image_url` is set.) + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3TurboImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3TurboImageToVideoOutput { + pub video: ViduQ3TurboImageToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/images/mod.rs new file mode 100644 index 00000000..df6085c4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/mod.rs @@ -0,0 +1,3 @@ +pub mod veo_3p1; +pub mod veo_3p1_fast; +pub mod veo_3p1_lite; diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/api.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/api.rs new file mode 100644 index 00000000..9f4a8703 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/api.rs @@ -0,0 +1,286 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::images::veo_3p1::raw_request::{ + Veo3p1FirstLastFrameToVideoInput, Veo3p1FirstLastFrameToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1FirstLastFrameToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the first frame. + pub first_frame_url: String, + + /// URL of the image used as the last frame. + pub last_frame_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FirstLastFrameToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1FirstLastFrameToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FirstLastFrameToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1FirstLastFrameToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FirstLastFrameToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1FirstLastFrameToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FirstLastFrameToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1FirstLastFrameToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1FirstLastFrameToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/first-last-frame-to-video"; + + type RawRequest = Veo3p1FirstLastFrameToVideoInput; + type RawResponse = Veo3p1FirstLastFrameToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + first_frame_url: self.first_frame_url.clone(), + last_frame_url: self.last_frame_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_first_last_frame_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FirstLastFrameToVideoRequest { + prompt: "a smooth transition from the first scene to the last".to_string(), + first_frame_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + last_frame_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3p1FirstLastFrameToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_first_last_frame_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FirstLastFrameToVideoRequest { + prompt: "morph between the two frames".to_string(), + first_frame_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + last_frame_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1FirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1FirstLastFrameToVideoRequest { + prompt: "p".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: Some(Veo3p1FirstLastFrameToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(true), + negative_prompt: Some("nope".to_string()), + seed: Some(1), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1FirstLastFrameToVideoSafetyTolerance::Level3), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.first_frame_url, "https://example.com/first.png"); + assert_eq!(raw.last_frame_url, "https://example.com/last.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("16:9")); + assert_eq!(raw.duration.as_deref(), Some("4s")); + assert_eq!(raw.resolution.as_deref(), Some("720p")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(1)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("3")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1FirstLastFrameToVideoRequest { + prompt: "p".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "p", + "first_frame_url": "https://example.com/first.png", + "last_frame_url": "https://example.com/last.png", + }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1FirstLastFrameToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/first-last-frame-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/cost.rs new file mode 100644 index 00000000..b5b58392 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/cost.rs @@ -0,0 +1,85 @@ +use crate::requests::api::video::images::veo_3p1::api::{ + Veo3p1FirstLastFrameToVideoDuration, Veo3p1FirstLastFrameToVideoRequest, + Veo3p1FirstLastFrameToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1::cost::{ + veo_3p1_cost_cents, veo_3p1_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// First-last-frame-to-video shares the Veo 3.1 (non-fast) per-second pricing +// (see the text module for the canonical rate table): +// 720p / 1080p: $0.20/sec (audio off), $0.40/sec (audio on) +// 4k: $0.40/sec (audio off), $0.60/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1FirstLastFrameToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1FirstLastFrameToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1FirstLastFrameToVideoRequest { + Veo3p1FirstLastFrameToVideoRequest { + prompt: "test".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: None, + duration, + resolution, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1FirstLastFrameToVideoDuration::FourSeconds), Some(Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP), Some(false), 80), + (Some(Veo3p1FirstLastFrameToVideoDuration::SixSeconds), Some(Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP), Some(true), 240), + (Some(Veo3p1FirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FirstLastFrameToVideoResolution::TenEightyP), Some(false), 160), + (Some(Veo3p1FirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FirstLastFrameToVideoResolution::TenEightyP), Some(true), 320), + (Some(Veo3p1FirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FirstLastFrameToVideoResolution::FourK), Some(false), 320), + (Some(Veo3p1FirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FirstLastFrameToVideoResolution::FourK), Some(true), 480), + (None, None, None, 320), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/raw_request.rs new file mode 100644 index 00000000..3ae7e494 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1/raw_request.rs @@ -0,0 +1,61 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/first-last-frame-to-video` +/// (start + end keyframes). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FirstLastFrameToVideoInput { + pub prompt: String, + + /// URL of the image used as the first frame. + pub first_frame_url: String, + + /// URL of the image used as the last frame. + pub last_frame_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FirstLastFrameToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FirstLastFrameToVideoOutput { + pub video: Veo3p1FirstLastFrameToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/api.rs new file mode 100644 index 00000000..f0b40cc6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/api.rs @@ -0,0 +1,286 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::images::veo_3p1_fast::raw_request::{ + Veo3p1FastFirstLastFrameToVideoInput, Veo3p1FastFirstLastFrameToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1FastFirstLastFrameToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the first frame. + pub first_frame_url: String, + + /// URL of the image used as the last frame. + pub last_frame_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastFirstLastFrameToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1FastFirstLastFrameToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastFirstLastFrameToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1FastFirstLastFrameToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastFirstLastFrameToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1FastFirstLastFrameToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastFirstLastFrameToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1FastFirstLastFrameToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1FastFirstLastFrameToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/fast/first-last-frame-to-video"; + + type RawRequest = Veo3p1FastFirstLastFrameToVideoInput; + type RawResponse = Veo3p1FastFirstLastFrameToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + first_frame_url: self.first_frame_url.clone(), + last_frame_url: self.last_frame_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_first_last_frame_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastFirstLastFrameToVideoRequest { + prompt: "a smooth transition from the first scene to the last".to_string(), + first_frame_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + last_frame_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3p1FastFirstLastFrameToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastFirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_first_last_frame_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastFirstLastFrameToVideoRequest { + prompt: "morph between the two frames".to_string(), + first_frame_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + last_frame_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1FastFirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1FastFirstLastFrameToVideoRequest { + prompt: "p".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: Some(Veo3p1FastFirstLastFrameToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastFirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(true), + negative_prompt: Some("nope".to_string()), + seed: Some(1), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1FastFirstLastFrameToVideoSafetyTolerance::Level3), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.first_frame_url, "https://example.com/first.png"); + assert_eq!(raw.last_frame_url, "https://example.com/last.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("16:9")); + assert_eq!(raw.duration.as_deref(), Some("4s")); + assert_eq!(raw.resolution.as_deref(), Some("720p")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(1)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("3")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1FastFirstLastFrameToVideoRequest { + prompt: "p".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "p", + "first_frame_url": "https://example.com/first.png", + "last_frame_url": "https://example.com/last.png", + }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1FastFirstLastFrameToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/fast/first-last-frame-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..90b92038 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/cost.rs @@ -0,0 +1,85 @@ +use crate::requests::api::video::images::veo_3p1_fast::api::{ + Veo3p1FastFirstLastFrameToVideoDuration, Veo3p1FastFirstLastFrameToVideoRequest, + Veo3p1FastFirstLastFrameToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1_fast::cost::{ + veo_3p1_fast_cost_cents, veo_3p1_fast_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// First-last-frame-to-video shares the Veo 3.1 Fast per-second pricing (see the +// text module for the canonical rate table): +// 720p / 1080p: $0.10/sec (audio off), $0.15/sec (audio on) +// 4k: $0.30/sec (audio off), $0.35/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1FastFirstLastFrameToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1FastFirstLastFrameToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_fast_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1FastFirstLastFrameToVideoRequest { + Veo3p1FastFirstLastFrameToVideoRequest { + prompt: "test".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: None, + duration, + resolution, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1FastFirstLastFrameToVideoDuration::FourSeconds), Some(Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP), Some(false), 40), + (Some(Veo3p1FastFirstLastFrameToVideoDuration::SixSeconds), Some(Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP), Some(true), 90), + (Some(Veo3p1FastFirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FastFirstLastFrameToVideoResolution::TenEightyP), Some(false), 80), + (Some(Veo3p1FastFirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FastFirstLastFrameToVideoResolution::TenEightyP), Some(true), 120), + (Some(Veo3p1FastFirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FastFirstLastFrameToVideoResolution::FourK), Some(false), 240), + (Some(Veo3p1FastFirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1FastFirstLastFrameToVideoResolution::FourK), Some(true), 280), + (None, None, None, 120), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/raw_request.rs new file mode 100644 index 00000000..6dc26af1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_fast/raw_request.rs @@ -0,0 +1,61 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/fast/first-last-frame-to-video` +/// (start + end keyframes). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastFirstLastFrameToVideoInput { + pub prompt: String, + + /// URL of the image used as the first frame. + pub first_frame_url: String, + + /// URL of the image used as the last frame. + pub last_frame_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastFirstLastFrameToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastFirstLastFrameToVideoOutput { + pub video: Veo3p1FastFirstLastFrameToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/api.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/api.rs new file mode 100644 index 00000000..6a49bfb8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/api.rs @@ -0,0 +1,286 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::images::veo_3p1_lite::raw_request::{ + Veo3p1LiteFirstLastFrameToVideoInput, Veo3p1LiteFirstLastFrameToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1LiteFirstLastFrameToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// URL of the image used as the first frame. + pub first_frame_url: String, + + /// URL of the image used as the last frame. + pub last_frame_url: String, + + /// Aspect ratio. fal's default is `auto` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteFirstLastFrameToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1LiteFirstLastFrameToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteFirstLastFrameToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1LiteFirstLastFrameToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3.1 Lite exposes only 720p/1080p (no 4k tier). Both resolution AND +/// audio affect the per-second price. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteFirstLastFrameToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3p1LiteFirstLastFrameToVideoResolution { + /// 1080p is billed at a higher per-second rate than 720p. + pub fn is_ten_eighty_p(&self) -> bool { + matches!(self, Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteFirstLastFrameToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1LiteFirstLastFrameToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1LiteFirstLastFrameToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/lite/first-last-frame-to-video"; + + type RawRequest = Veo3p1LiteFirstLastFrameToVideoInput; + type RawResponse = Veo3p1LiteFirstLastFrameToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + first_frame_url: self.first_frame_url.clone(), + last_frame_url: self.last_frame_url.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_first_last_frame_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1LiteFirstLastFrameToVideoRequest { + prompt: "a smooth transition from the first scene to the last".to_string(), + first_frame_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + last_frame_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: Some(Veo3p1LiteFirstLastFrameToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1LiteFirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_first_last_frame_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1LiteFirstLastFrameToVideoRequest { + prompt: "morph between the two frames".to_string(), + first_frame_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + last_frame_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3p1LiteFirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1LiteFirstLastFrameToVideoRequest { + prompt: "p".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: Some(Veo3p1LiteFirstLastFrameToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1LiteFirstLastFrameToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP), + generate_audio: Some(true), + negative_prompt: Some("nope".to_string()), + seed: Some(1), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1LiteFirstLastFrameToVideoSafetyTolerance::Level3), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.first_frame_url, "https://example.com/first.png"); + assert_eq!(raw.last_frame_url, "https://example.com/last.png"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("16:9")); + assert_eq!(raw.duration.as_deref(), Some("4s")); + assert_eq!(raw.resolution.as_deref(), Some("720p")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.negative_prompt.as_deref(), Some("nope")); + assert_eq!(raw.seed, Some(1)); + assert_eq!(raw.auto_fix, Some(true)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("3")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1LiteFirstLastFrameToVideoRequest { + prompt: "p".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "prompt": "p", + "first_frame_url": "https://example.com/first.png", + "last_frame_url": "https://example.com/last.png", + }), + ); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1LiteFirstLastFrameToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/lite/first-last-frame-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/cost.rs new file mode 100644 index 00000000..d449c3f6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/cost.rs @@ -0,0 +1,85 @@ +use crate::requests::api::video::images::veo_3p1_lite::api::{ + Veo3p1LiteFirstLastFrameToVideoDuration, Veo3p1LiteFirstLastFrameToVideoRequest, + Veo3p1LiteFirstLastFrameToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1_lite::cost::{ + veo_3p1_lite_cost_cents, veo_3p1_lite_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// First-last-frame-to-video shares the Veo 3.1 Lite per-second pricing (see the +// text module for the canonical rate table). Both resolution and audio matter: +// 720p: $0.03/sec (audio off), $0.05/sec (audio on) +// 1080p: $0.05/sec (audio off), $0.08/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1LiteFirstLastFrameToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1LiteFirstLastFrameToVideoDuration::EightSeconds) + .to_seconds(); + let is_1080p = self.resolution + .unwrap_or(Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP) + .is_ten_eighty_p(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_lite_rate_tenth_cents_per_sec(is_1080p, audio_on); + veo_3p1_lite_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1LiteFirstLastFrameToVideoRequest { + Veo3p1LiteFirstLastFrameToVideoRequest { + prompt: "test".to_string(), + first_frame_url: "https://example.com/first.png".to_string(), + last_frame_url: "https://example.com/last.png".to_string(), + aspect_ratio: None, + duration, + resolution, + generate_audio, + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1LiteFirstLastFrameToVideoDuration::FourSeconds), Some(Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP), Some(false), 12), + (Some(Veo3p1LiteFirstLastFrameToVideoDuration::FourSeconds), Some(Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP), Some(true), 20), + (Some(Veo3p1LiteFirstLastFrameToVideoDuration::SixSeconds), Some(Veo3p1LiteFirstLastFrameToVideoResolution::TenEightyP), Some(true), 48), + (Some(Veo3p1LiteFirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1LiteFirstLastFrameToVideoResolution::TenEightyP), Some(false), 40), + (Some(Veo3p1LiteFirstLastFrameToVideoDuration::EightSeconds), Some(Veo3p1LiteFirstLastFrameToVideoResolution::TenEightyP), Some(true), 64), + // Defaults: 8s, 720p, audio on + (None, None, None, 40), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/raw_request.rs new file mode 100644 index 00000000..bc487c87 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/images/veo_3p1_lite/raw_request.rs @@ -0,0 +1,61 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/lite/first-last-frame-to-video` +/// (start + end keyframes). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1LiteFirstLastFrameToVideoInput { + pub prompt: String, + + /// URL of the image used as the first frame. + pub first_frame_url: String, + + /// URL of the image used as the last frame. + pub last_frame_url: String, + + /// Aspect ratio. + /// Possible values: "auto", "16:9", "9:16". fal default: "auto". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1LiteFirstLastFrameToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1LiteFirstLastFrameToVideoOutput { + pub video: Veo3p1LiteFirstLastFrameToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/mod.rs new file mode 100644 index 00000000..b2dfb590 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/mod.rs @@ -0,0 +1,6 @@ +pub mod elements; +pub mod extend; +pub mod image; +pub mod images; +pub mod reference; +pub mod text; diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/mod.rs new file mode 100644 index 00000000..ef70095d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/mod.rs @@ -0,0 +1,4 @@ +pub mod veo_3p1; +pub mod veo_3p1_fast; +pub mod vidu_q3_reference_to_video; +pub mod vidu_q3_reference_to_video_mix; diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/api.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/api.rs new file mode 100644 index 00000000..87a17045 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/api.rs @@ -0,0 +1,275 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::reference::veo_3p1::raw_request::{ + Veo3p1ReferenceToVideoInput, Veo3p1ReferenceToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1ReferenceToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Reference image URLs used for consistent subject appearance. + pub image_urls: Vec, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ReferenceToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1ReferenceToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ReferenceToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1ReferenceToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ReferenceToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1ReferenceToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1ReferenceToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1ReferenceToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1ReferenceToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/reference-to-video"; + + type RawRequest = Veo3p1ReferenceToVideoInput; + type RawResponse = Veo3p1ReferenceToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1ReferenceToVideoRequest { + prompt: "the two dogs run side by side across a sunlit meadow".to_string(), + image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + aspect_ratio: Some(Veo3p1ReferenceToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1ReferenceToVideoDuration::FourSeconds), + resolution: Some(Veo3p1ReferenceToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1ReferenceToVideoRequest { + prompt: "the dogs play together in a snowy field".to_string(), + image_urls: vec![TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string()], + aspect_ratio: None, + duration: Some(Veo3p1ReferenceToVideoDuration::FourSeconds), + resolution: Some(Veo3p1ReferenceToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1ReferenceToVideoRequest { + prompt: "p".to_string(), + image_urls: vec!["https://example.com/a.png".to_string(), "https://example.com/b.png".to_string()], + aspect_ratio: Some(Veo3p1ReferenceToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1ReferenceToVideoDuration::SixSeconds), + resolution: Some(Veo3p1ReferenceToVideoResolution::FourK), + generate_audio: Some(true), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1ReferenceToVideoSafetyTolerance::Level5), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.image_urls.len(), 2); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("4k")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("5")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1ReferenceToVideoRequest { + prompt: "p".to_string(), + image_urls: vec!["https://example.com/a.png".to_string()], + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_urls": ["https://example.com/a.png"] }), + ); + } + + /// This endpoint's schema has no `negative_prompt`/`seed` fields, so they + /// must never appear on the wire regardless of other settings. + #[test] + fn raw_request_never_emits_negative_prompt_or_seed() { + let request = Veo3p1ReferenceToVideoRequest { + prompt: "p".to_string(), + image_urls: vec!["https://example.com/a.png".to_string()], + aspect_ratio: Some(Veo3p1ReferenceToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1ReferenceToVideoDuration::EightSeconds), + resolution: Some(Veo3p1ReferenceToVideoResolution::TenEightyP), + generate_audio: Some(true), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1ReferenceToVideoSafetyTolerance::Level4), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert!(json.get("negative_prompt").is_none(), "unexpected negative_prompt: {json}"); + assert!(json.get("seed").is_none(), "unexpected seed: {json}"); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1ReferenceToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/reference-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/cost.rs new file mode 100644 index 00000000..d89dee06 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/cost.rs @@ -0,0 +1,112 @@ +use crate::requests::api::video::reference::veo_3p1::api::{ + Veo3p1ReferenceToVideoDuration, Veo3p1ReferenceToVideoRequest, Veo3p1ReferenceToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1::cost::{ + veo_3p1_cost_cents, veo_3p1_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Reference-to-video shares the Veo 3.1 (non-fast) per-second pricing (see the +// text module for the canonical rate table). fal's reference-to-video docs +// explicitly document the 4k tier for this endpoint: +// 720p / 1080p: $0.20/sec (audio off), $0.40/sec (audio on) +// 4k: $0.40/sec (audio off), $0.60/sec (audio on) + +impl FalRequestCostCalculator for Veo3p1ReferenceToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1ReferenceToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1ReferenceToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1ReferenceToVideoRequest { + Veo3p1ReferenceToVideoRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/a.png".to_string()], + aspect_ratio: None, + duration, + resolution, + generate_audio, + auto_fix: None, + safety_tolerance: None, + } + } + + /// fal reference-to-video docs: "8 second video at 1080p with audio on will + /// cost $3.20" → 8s × $0.40 = 320¢. + #[test] + fn matches_documented_8s_1080p_audio_on_example() { + let cost = make_request( + Some(Veo3p1ReferenceToVideoDuration::EightSeconds), + Some(Veo3p1ReferenceToVideoResolution::TenEightyP), + Some(true), + ).calculate_cost_in_cents(); + assert_eq!(cost, 320); + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + (Some(Veo3p1ReferenceToVideoDuration::FourSeconds), Some(Veo3p1ReferenceToVideoResolution::SevenTwentyP), Some(false), 80), + (Some(Veo3p1ReferenceToVideoDuration::FourSeconds), Some(Veo3p1ReferenceToVideoResolution::SevenTwentyP), Some(true), 160), + (Some(Veo3p1ReferenceToVideoDuration::EightSeconds), Some(Veo3p1ReferenceToVideoResolution::TenEightyP), Some(false), 160), + (Some(Veo3p1ReferenceToVideoDuration::EightSeconds), Some(Veo3p1ReferenceToVideoResolution::TenEightyP), Some(true), 320), + (Some(Veo3p1ReferenceToVideoDuration::EightSeconds), Some(Veo3p1ReferenceToVideoResolution::FourK), Some(false), 320), + (Some(Veo3p1ReferenceToVideoDuration::EightSeconds), Some(Veo3p1ReferenceToVideoResolution::FourK), Some(true), 480), + (None, None, None, 320), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + /// The number of reference images does not affect the bill. + #[test] + fn cost_is_independent_of_image_count() { + let one = Veo3p1ReferenceToVideoRequest { + image_urls: vec!["https://example.com/a.png".to_string()], + ..make_request(Some(Veo3p1ReferenceToVideoDuration::EightSeconds), Some(Veo3p1ReferenceToVideoResolution::TenEightyP), Some(true)) + }.calculate_cost_in_cents(); + let many = Veo3p1ReferenceToVideoRequest { + image_urls: vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + ], + ..make_request(Some(Veo3p1ReferenceToVideoDuration::EightSeconds), Some(Veo3p1ReferenceToVideoResolution::TenEightyP), Some(true)) + }.calculate_cost_in_cents(); + assert_eq!(one, many); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/raw_request.rs new file mode 100644 index 00000000..448e3e42 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1/raw_request.rs @@ -0,0 +1,53 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/reference-to-video`. +/// Reference images drive subject/appearance consistency. +/// fal's schema: +/// +/// NB: unlike the other Veo 3.1 modalities, this endpoint's schema does NOT +/// expose `negative_prompt` or `seed`. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1ReferenceToVideoInput { + pub prompt: String, + + /// URLs of the reference images used for consistent subject appearance. + pub image_urls: Vec, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ReferenceToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ReferenceToVideoOutput { + pub video: Veo3p1ReferenceToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/api.rs new file mode 100644 index 00000000..0ebf7ec2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/api.rs @@ -0,0 +1,275 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::reference::veo_3p1_fast::raw_request::{ + Veo3p1FastReferenceToVideoInput, Veo3p1FastReferenceToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1FastReferenceToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Reference image URLs used for consistent subject appearance. + pub image_urls: Vec, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `false` when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastReferenceToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1FastReferenceToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastReferenceToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1FastReferenceToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastReferenceToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1FastReferenceToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastReferenceToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1FastReferenceToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1FastReferenceToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/fast/reference-to-video"; + + type RawRequest = Veo3p1FastReferenceToVideoInput; + type RawResponse = Veo3p1FastReferenceToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + image_urls: self.image_urls.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastReferenceToVideoRequest { + prompt: "the two dogs run side by side across a sunlit meadow".to_string(), + image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + aspect_ratio: Some(Veo3p1FastReferenceToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastReferenceToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastReferenceToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastReferenceToVideoRequest { + prompt: "the dogs play together in a snowy field".to_string(), + image_urls: vec![TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string()], + aspect_ratio: None, + duration: Some(Veo3p1FastReferenceToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastReferenceToVideoResolution::SevenTwentyP), + generate_audio: Some(false), + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1FastReferenceToVideoRequest { + prompt: "p".to_string(), + image_urls: vec!["https://example.com/a.png".to_string(), "https://example.com/b.png".to_string()], + aspect_ratio: Some(Veo3p1FastReferenceToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1FastReferenceToVideoDuration::SixSeconds), + resolution: Some(Veo3p1FastReferenceToVideoResolution::FourK), + generate_audio: Some(true), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1FastReferenceToVideoSafetyTolerance::Level5), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.image_urls.len(), 2); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("6s")); + assert_eq!(raw.resolution.as_deref(), Some("4k")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("5")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1FastReferenceToVideoRequest { + prompt: "p".to_string(), + image_urls: vec!["https://example.com/a.png".to_string()], + aspect_ratio: None, + duration: None, + resolution: None, + generate_audio: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "image_urls": ["https://example.com/a.png"] }), + ); + } + + /// This endpoint's schema has no `negative_prompt`/`seed` fields, so they + /// must never appear on the wire regardless of other settings. + #[test] + fn raw_request_never_emits_negative_prompt_or_seed() { + let request = Veo3p1FastReferenceToVideoRequest { + prompt: "p".to_string(), + image_urls: vec!["https://example.com/a.png".to_string()], + aspect_ratio: Some(Veo3p1FastReferenceToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), + resolution: Some(Veo3p1FastReferenceToVideoResolution::TenEightyP), + generate_audio: Some(true), + auto_fix: Some(true), + safety_tolerance: Some(Veo3p1FastReferenceToVideoSafetyTolerance::Level4), + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert!(json.get("negative_prompt").is_none(), "unexpected negative_prompt: {json}"); + assert!(json.get("seed").is_none(), "unexpected seed: {json}"); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Veo3p1FastReferenceToVideoRequest::ENDPOINT, + "fal-ai/veo3.1/fast/reference-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..49bfe46c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/cost.rs @@ -0,0 +1,109 @@ +use crate::requests::api::video::reference::veo_3p1_fast::api::{ + Veo3p1FastReferenceToVideoDuration, Veo3p1FastReferenceToVideoRequest, + Veo3p1FastReferenceToVideoResolution, +}; +use crate::requests::api::video::text::veo_3p1_fast::cost::{ + veo_3p1_fast_cost_cents, veo_3p1_fast_rate_tenth_cents_per_sec, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// PRICING NOTE — reference-to-video: +// +// fal's reference-to-video llms.txt documents a FLAT rate of $0.10/sec (audio +// off) / $0.15/sec (audio on) and does NOT mention a separate 4k tier — even +// though the endpoint exposes a "4k" resolution option. The sibling +// text/image/first-last endpoints DO document the 4k surcharge +// ($0.30/$0.35). Rather than risk undercharging on 4k reference generations, +// we mirror the rest of the Veo 3.1 Fast family and apply the 4k surcharge +// here too. For 720p/1080p this is identical to fal's documented flat rate; +// only 4k differs. If fal confirms reference-to-video is truly flat at 4k, +// drop the `four_k` branch and always bill the SD rate. + +impl FalRequestCostCalculator for Veo3p1FastReferenceToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1FastReferenceToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1FastReferenceToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_fast_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1FastReferenceToVideoRequest { + Veo3p1FastReferenceToVideoRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/a.png".to_string()], + aspect_ratio: None, + duration, + resolution, + generate_audio, + auto_fix: None, + safety_tolerance: None, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + // 720p/1080p match fal's documented flat rate + (Some(Veo3p1FastReferenceToVideoDuration::FourSeconds), Some(Veo3p1FastReferenceToVideoResolution::SevenTwentyP), Some(false), 40), + (Some(Veo3p1FastReferenceToVideoDuration::FourSeconds), Some(Veo3p1FastReferenceToVideoResolution::SevenTwentyP), Some(true), 60), + (Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), Some(Veo3p1FastReferenceToVideoResolution::TenEightyP), Some(false), 80), + (Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), Some(Veo3p1FastReferenceToVideoResolution::TenEightyP), Some(true), 120), + // 4k applies the family surcharge (see PRICING NOTE) + (Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), Some(Veo3p1FastReferenceToVideoResolution::FourK), Some(false), 240), + (Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), Some(Veo3p1FastReferenceToVideoResolution::FourK), Some(true), 280), + (None, None, None, 120), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + /// The number of reference images does not affect the bill. + #[test] + fn cost_is_independent_of_image_count() { + let one = Veo3p1FastReferenceToVideoRequest { + image_urls: vec!["https://example.com/a.png".to_string()], + ..make_request(Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), Some(Veo3p1FastReferenceToVideoResolution::TenEightyP), Some(true)) + }.calculate_cost_in_cents(); + let many = Veo3p1FastReferenceToVideoRequest { + image_urls: vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + ], + ..make_request(Some(Veo3p1FastReferenceToVideoDuration::EightSeconds), Some(Veo3p1FastReferenceToVideoResolution::TenEightyP), Some(true)) + }.calculate_cost_in_cents(); + assert_eq!(one, many); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/raw_request.rs new file mode 100644 index 00000000..2b0ebfb2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/veo_3p1_fast/raw_request.rs @@ -0,0 +1,53 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/fast/reference-to-video`. +/// Reference images drive subject/appearance consistency. +/// fal's schema: +/// +/// NB: unlike the other Veo 3.1 Fast modalities, this endpoint's schema does +/// NOT expose `negative_prompt` or `seed`. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastReferenceToVideoInput { + pub prompt: String, + + /// URLs of the reference images used for consistent subject appearance. + pub image_urls: Vec, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Whether to automatically rewrite prompts that fail moderation. + /// fal default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance, "1" (strictest) .. "6" (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastReferenceToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastReferenceToVideoOutput { + pub video: Veo3p1FastReferenceToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/api.rs new file mode 100644 index 00000000..2996efda --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/api.rs @@ -0,0 +1,232 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::reference::vidu_q3_reference_to_video::raw_request::{ + ViduQ3ReferenceToVideoInput, ViduQ3ReferenceToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct ViduQ3ReferenceToVideoRequest { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// Reference image URLs (1 to 4) used for subject consistency. + pub reference_image_urls: Vec, + + /// Duration in seconds. Valid range 1–16; fal's default is `5` when `None`. + pub duration: Option, + + /// Seed for reproducibility. Random when `None`. + pub seed: Option, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate audio. fal's server default is `true` when `None`. + pub audio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3ReferenceToVideoAspectRatio { + SixteenByNine, + NineBySixteen, + FourByThree, + ThreeByFour, + Square, +} + +impl ViduQ3ReferenceToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + Self::FourByThree => "4:3", + Self::ThreeByFour => "3:4", + Self::Square => "1:1", + } + } +} + +/// Vidu Q3 resolutions. 720p/1080p bill at 2.2× the 360p/540p per-second rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3ReferenceToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +impl ViduQ3ReferenceToVideoResolution { + /// 720p and 1080p are billed at the higher (2.2×) per-second rate. + pub fn is_high_res(&self) -> bool { + matches!(self, Self::SevenTwentyP | Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSixtyP => "360p", + Self::FiveFortyP => "540p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +impl FalEndpoint for ViduQ3ReferenceToVideoRequest { + const ENDPOINT: &str = "fal-ai/vidu/q3/reference-to-video"; + + type RawRequest = ViduQ3ReferenceToVideoInput; + type RawResponse = ViduQ3ReferenceToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + reference_image_urls: self.reference_image_urls.clone(), + duration: self.duration, + seed: self.seed, + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + audio: self.audio, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3ReferenceToVideoRequest { + prompt: "the two dogs run side by side across a sunlit meadow".to_string(), + reference_image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + duration: Some(5), + seed: None, + aspect_ratio: Some(ViduQ3ReferenceToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3ReferenceToVideoResolution::SevenTwentyP), + audio: Some(false), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3ReferenceToVideoRequest { + prompt: "the dogs play together in a snowy field".to_string(), + reference_image_urls: vec![TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string()], + duration: Some(5), + seed: Some(1234), + aspect_ratio: None, + resolution: Some(ViduQ3ReferenceToVideoResolution::ThreeSixtyP), + audio: Some(false), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = ViduQ3ReferenceToVideoRequest { + prompt: "p".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string(), "https://example.com/b.png".to_string()], + duration: Some(12), + seed: Some(42), + aspect_ratio: Some(ViduQ3ReferenceToVideoAspectRatio::FourByThree), + resolution: Some(ViduQ3ReferenceToVideoResolution::TenEightyP), + audio: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.reference_image_urls.len(), 2); + assert_eq!(raw.duration, Some(12)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.aspect_ratio.as_deref(), Some("4:3")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.audio, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = ViduQ3ReferenceToVideoRequest { + prompt: "p".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string()], + duration: None, + seed: None, + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "reference_image_urls": ["https://example.com/a.png"] }), + ); + } + + #[test] + fn seed_serializes_when_set() { + let request = ViduQ3ReferenceToVideoRequest { + prompt: "p".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string()], + duration: None, + seed: Some(777), + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("seed").and_then(|s| s.as_i64()), Some(777)); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (ViduQ3ReferenceToVideoAspectRatio::SixteenByNine, "16:9"), + (ViduQ3ReferenceToVideoAspectRatio::NineBySixteen, "9:16"), + (ViduQ3ReferenceToVideoAspectRatio::FourByThree, "4:3"), + (ViduQ3ReferenceToVideoAspectRatio::ThreeByFour, "3:4"), + (ViduQ3ReferenceToVideoAspectRatio::Square, "1:1"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + ViduQ3ReferenceToVideoRequest::ENDPOINT, + "fal-ai/vidu/q3/reference-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/cost.rs new file mode 100644 index 00000000..a8af3fc7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/cost.rs @@ -0,0 +1,84 @@ +use crate::requests::api::video::reference::vidu_q3_reference_to_video::api::{ + ViduQ3ReferenceToVideoRequest, ViduQ3ReferenceToVideoResolution, +}; +use crate::requests::api::video::text::vidu_q3::cost::{vidu_q3_cost_cents, vidu_q3_rate_tenth_cents_per_sec}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Reference-to-video shares the Vidu Q3 per-second pricing (see the text module +// for the canonical rate table): +// 360p / 540p: $0.07/sec +// 720p / 1080p: $0.154/sec (2.2×) +// Pricing depends on resolution and duration only. + +impl FalRequestCostCalculator for ViduQ3ReferenceToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 5s, resolution = 720p. + let duration_secs = u64::from(self.duration.unwrap_or(5)); + let is_high_res = self.resolution + .unwrap_or(ViduQ3ReferenceToVideoResolution::SevenTwentyP) + .is_high_res(); + + let rate = vidu_q3_rate_tenth_cents_per_sec(is_high_res); + vidu_q3_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + ) -> ViduQ3ReferenceToVideoRequest { + ViduQ3ReferenceToVideoRequest { + prompt: "test".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string()], + duration, + seed: None, + aspect_ratio: None, + resolution, + audio: Some(true), + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, expected_cents) + const COST_TABLE: &[(Option, Option, u64)] = &[ + (Some(5), Some(ViduQ3ReferenceToVideoResolution::ThreeSixtyP), 35), + (Some(5), Some(ViduQ3ReferenceToVideoResolution::FiveFortyP), 35), + (Some(5), Some(ViduQ3ReferenceToVideoResolution::SevenTwentyP), 77), + (Some(5), Some(ViduQ3ReferenceToVideoResolution::TenEightyP), 77), + (Some(10), Some(ViduQ3ReferenceToVideoResolution::SevenTwentyP), 154), + (Some(3), Some(ViduQ3ReferenceToVideoResolution::SevenTwentyP), 47), // 46.2 → 47 + // Defaults: duration=None→5s, resolution=None→720p + (None, None, 77), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, expected) in COST_TABLE { + let got = make_request(duration, resolution).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} resolution={resolution:?}"); + } + } + + /// The number of reference images does not affect the bill. + #[test] + fn cost_is_independent_of_image_count() { + let one = make_request(Some(8), Some(ViduQ3ReferenceToVideoResolution::SevenTwentyP)).calculate_cost_in_cents(); + let four = ViduQ3ReferenceToVideoRequest { + reference_image_urls: vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + "https://example.com/d.png".to_string(), + ], + ..make_request(Some(8), Some(ViduQ3ReferenceToVideoResolution::SevenTwentyP)) + }.calculate_cost_in_cents(); + assert_eq!(one, four); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/raw_request.rs new file mode 100644 index 00000000..ec79f129 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video/raw_request.rs @@ -0,0 +1,44 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/vidu/q3/reference-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct ViduQ3ReferenceToVideoInput { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// URLs of the reference images (1 to 4) used for subject consistency. + pub reference_image_urls: Vec, + + /// Duration in seconds. Range 1–16. fal default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Seed for reproducibility. Random when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "4:3", "3:4", "1:1". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Output resolution. + /// Possible values: "360p", "540p", "720p", "1080p". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3ReferenceToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3ReferenceToVideoOutput { + pub video: ViduQ3ReferenceToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/api.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/api.rs new file mode 100644 index 00000000..39b57bc8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/api.rs @@ -0,0 +1,219 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::reference::vidu_q3_reference_to_video_mix::raw_request::{ + ViduQ3ReferenceToVideoMixInput, ViduQ3ReferenceToVideoMixOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct ViduQ3ReferenceToVideoMixRequest { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// Reference image URLs (1 to 4) used for subject consistency. + pub reference_image_urls: Vec, + + /// Duration in seconds. Valid range 1–16; fal's default is `5` when `None`. + pub duration: Option, + + /// Seed for reproducibility. Random when `None`. + pub seed: Option, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate audio. fal's server default is `true` when `None`. + pub audio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3ReferenceToVideoMixAspectRatio { + SixteenByNine, + NineBySixteen, + FourByThree, + ThreeByFour, + Square, +} + +impl ViduQ3ReferenceToVideoMixAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + Self::FourByThree => "4:3", + Self::ThreeByFour => "3:4", + Self::Square => "1:1", + } + } +} + +/// Vidu Q3 resolutions. 720p/1080p bill at 2.2× the 360p/540p per-second rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3ReferenceToVideoMixResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +impl ViduQ3ReferenceToVideoMixResolution { + /// 720p and 1080p are billed at the higher (2.2×) per-second rate. + pub fn is_high_res(&self) -> bool { + matches!(self, Self::SevenTwentyP | Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSixtyP => "360p", + Self::FiveFortyP => "540p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +impl FalEndpoint for ViduQ3ReferenceToVideoMixRequest { + const ENDPOINT: &str = "fal-ai/vidu/q3/reference-to-video/mix"; + + type RawRequest = ViduQ3ReferenceToVideoMixInput; + type RawResponse = ViduQ3ReferenceToVideoMixOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + reference_image_urls: self.reference_image_urls.clone(), + duration: self.duration, + seed: self.seed, + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + audio: self.audio, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_mix_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3ReferenceToVideoMixRequest { + prompt: "the two dogs run side by side across a sunlit meadow".to_string(), + reference_image_urls: vec![ + TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + JUNO_AT_LAKE_IMAGE_URL.to_string(), + ], + duration: Some(5), + seed: None, + aspect_ratio: Some(ViduQ3ReferenceToVideoMixAspectRatio::SixteenByNine), + resolution: Some(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP), + audio: Some(false), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_reference_to_video_mix_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3ReferenceToVideoMixRequest { + prompt: "the dogs play together in a snowy field".to_string(), + reference_image_urls: vec![TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string()], + duration: Some(5), + seed: Some(1234), + aspect_ratio: None, + resolution: Some(ViduQ3ReferenceToVideoMixResolution::ThreeSixtyP), + audio: Some(false), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = ViduQ3ReferenceToVideoMixRequest { + prompt: "p".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string(), "https://example.com/b.png".to_string()], + duration: Some(12), + seed: Some(42), + aspect_ratio: Some(ViduQ3ReferenceToVideoMixAspectRatio::FourByThree), + resolution: Some(ViduQ3ReferenceToVideoMixResolution::TenEightyP), + audio: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.reference_image_urls.len(), 2); + assert_eq!(raw.duration, Some(12)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.aspect_ratio.as_deref(), Some("4:3")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.audio, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = ViduQ3ReferenceToVideoMixRequest { + prompt: "p".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string()], + duration: None, + seed: None, + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!( + json, + serde_json::json!({ "prompt": "p", "reference_image_urls": ["https://example.com/a.png"] }), + ); + } + + #[test] + fn seed_serializes_when_set() { + let request = ViduQ3ReferenceToVideoMixRequest { + prompt: "p".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string()], + duration: None, + seed: Some(777), + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("seed").and_then(|s| s.as_i64()), Some(777)); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + ViduQ3ReferenceToVideoMixRequest::ENDPOINT, + "fal-ai/vidu/q3/reference-to-video/mix", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/cost.rs new file mode 100644 index 00000000..fefb104a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/cost.rs @@ -0,0 +1,84 @@ +use crate::requests::api::video::reference::vidu_q3_reference_to_video_mix::api::{ + ViduQ3ReferenceToVideoMixRequest, ViduQ3ReferenceToVideoMixResolution, +}; +use crate::requests::api::video::text::vidu_q3::cost::{vidu_q3_cost_cents, vidu_q3_rate_tenth_cents_per_sec}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// The "mix" variant shares the Vidu Q3 per-second pricing (see the text module +// for the canonical rate table): +// 360p / 540p: $0.07/sec +// 720p / 1080p: $0.154/sec (2.2×) +// Pricing depends on resolution and duration only. + +impl FalRequestCostCalculator for ViduQ3ReferenceToVideoMixRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 5s, resolution = 720p. + let duration_secs = u64::from(self.duration.unwrap_or(5)); + let is_high_res = self.resolution + .unwrap_or(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP) + .is_high_res(); + + let rate = vidu_q3_rate_tenth_cents_per_sec(is_high_res); + vidu_q3_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn make_request( + duration: Option, + resolution: Option, + ) -> ViduQ3ReferenceToVideoMixRequest { + ViduQ3ReferenceToVideoMixRequest { + prompt: "test".to_string(), + reference_image_urls: vec!["https://example.com/a.png".to_string()], + duration, + seed: None, + aspect_ratio: None, + resolution, + audio: Some(true), + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, expected_cents) — identical to base Vidu Q3. + const COST_TABLE: &[(Option, Option, u64)] = &[ + (Some(5), Some(ViduQ3ReferenceToVideoMixResolution::ThreeSixtyP), 35), + (Some(5), Some(ViduQ3ReferenceToVideoMixResolution::FiveFortyP), 35), + (Some(5), Some(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP), 77), + (Some(5), Some(ViduQ3ReferenceToVideoMixResolution::TenEightyP), 77), + (Some(10), Some(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP), 154), + (Some(3), Some(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP), 47), // 46.2 → 47 + // Defaults: duration=None→5s, resolution=None→720p + (None, None, 77), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, expected) in COST_TABLE { + let got = make_request(duration, resolution).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} resolution={resolution:?}"); + } + } + + /// The number of reference images does not affect the bill. + #[test] + fn cost_is_independent_of_image_count() { + let one = make_request(Some(8), Some(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP)).calculate_cost_in_cents(); + let four = ViduQ3ReferenceToVideoMixRequest { + reference_image_urls: vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + "https://example.com/d.png".to_string(), + ], + ..make_request(Some(8), Some(ViduQ3ReferenceToVideoMixResolution::SevenTwentyP)) + }.calculate_cost_in_cents(); + assert_eq!(one, four); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/raw_request.rs new file mode 100644 index 00000000..0c2df131 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/reference/vidu_q3_reference_to_video_mix/raw_request.rs @@ -0,0 +1,47 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/vidu/q3/reference-to-video/mix`. +/// fal's schema: +/// +/// The "mix" variant shares the base reference-to-video input schema; it +/// differs only in the server-side generation behavior. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct ViduQ3ReferenceToVideoMixInput { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// URLs of the reference images (1 to 4) used for subject consistency. + pub reference_image_urls: Vec, + + /// Duration in seconds. Range 1–16. fal default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Seed for reproducibility. Random when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "4:3", "3:4", "1:1". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Output resolution. + /// Possible values: "360p", "540p", "720p", "1080p". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3ReferenceToVideoMixVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3ReferenceToVideoMixOutput { + pub video: ViduQ3ReferenceToVideoMixVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/api.rs new file mode 100644 index 00000000..25fd8cef --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/api.rs @@ -0,0 +1,225 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::kling_1p6_pro_text_to_video::raw_request::{ + Kling1p6ProTextToVideoInput, Kling1p6ProTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling1p6ProTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// Video duration. Kling 1.6 Pro supports 5 or 10 seconds only. + pub duration: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, + + /// CFG scale. Defaults to fal's `0.5` when `None`. + pub cfg_scale: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling1p6ProTextToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling1p6ProTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling1p6ProTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +impl FalEndpoint for Kling1p6ProTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v1.6/pro/text-to-video"; + + type RawRequest = Kling1p6ProTextToVideoInput; + type RawResponse = Kling1p6ProTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling1p6ProTextToVideoAspectRatio::Square => "1:1", + Kling1p6ProTextToVideoAspectRatio::SixteenByNine => "16:9", + Kling1p6ProTextToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio, + duration, + negative_prompt: self.negative_prompt.clone(), + cfg_scale: self.cfg_scale, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling1p6ProTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow, cinematic slow motion".to_string(), + negative_prompt: None, + duration: Some(Kling1p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling1p6ProTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + negative_prompt: None, + duration: Some(Kling1p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling1p6ProTextToVideoAspectRatio::Square, + Kling1p6ProTextToVideoAspectRatio::SixteenByNine, + Kling1p6ProTextToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling1p6ProTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + negative_prompt: None, + duration: Some(Kling1p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(ar), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling1p6ProTextToVideoDuration::FiveSeconds, + Kling1p6ProTextToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling1p6ProTextToVideoRequest { + prompt: "a candle flame flickers in a dark room".to_string(), + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_aspect_ratio_uses_colon_format() { + let request = Kling1p6ProTextToVideoRequest { + prompt: "p".to_string(), + negative_prompt: None, + duration: Some(Kling1p6ProTextToVideoDuration::TenSeconds), + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::NineBySixteen), + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("10")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Kling1p6ProTextToVideoRequest { + prompt: "p".to_string(), + negative_prompt: None, + duration: None, + aspect_ratio: None, + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert!(raw.aspect_ratio.is_none()); + assert!(raw.duration.is_none()); + assert!(raw.negative_prompt.is_none()); + assert!(raw.cfg_scale.is_none()); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Kling1p6ProTextToVideoRequest::ENDPOINT, + "fal-ai/kling-video/v1.6/pro/text-to-video", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/cost.rs new file mode 100644 index 00000000..6a300c43 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/cost.rs @@ -0,0 +1,236 @@ +use crate::requests::api::video::text::kling_1p6_pro_text_to_video::api::{ + Kling1p6ProTextToVideoDuration, Kling1p6ProTextToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling1p6ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 1.6 Pro text-to-video: $0.098/second + // (see https://fal.ai/models/fal-ai/kling-video/v1.6/pro/text-to-video). + // + // Slightly pricier than the image-to-video variant of the same model + // (which is $0.095/sec). Rate held in tenths-of-cents and rounded up to + // whole cents at the end so the user is never undercharged. + let duration_secs = self.duration + .unwrap_or(Kling1p6ProTextToVideoDuration::FiveSeconds) + .to_seconds(); + (98u64 * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::kling_1p6_pro_text_to_video::api::{ + Kling1p6ProTextToVideoAspectRatio, Kling1p6ProTextToVideoDuration, + }; + use crate::requests::api::video::image::kling_1p6_pro_image_to_video::api::{ + Kling1p6ProImageToVideoAspectRatio, Kling1p6ProImageToVideoDuration, + Kling1p6ProImageToVideoRequest, + }; + + fn make_request( + duration: Option, + ) -> Kling1p6ProTextToVideoRequest { + Kling1p6ProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration, + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + } + } + + // Pricing: $0.098/sec = 98 tenths-of-cents/sec. + // Cents per duration = ceil(98 × secs / 10). + + #[test] + fn five_seconds() { + // (98 * 5 + 9) / 10 = 49 (round up from 49.0¢) + assert_eq!( + make_request(Some(Kling1p6ProTextToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 49, + ); + } + + #[test] + fn ten_seconds() { + // (98 * 10 + 9) / 10 = 98 + assert_eq!( + make_request(Some(Kling1p6ProTextToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 98, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None → 5s → 49¢ + assert_eq!(make_request(None).calculate_cost_in_cents(), 49); + } + + #[test] + fn ten_seconds_costs_more_than_five() { + let five = make_request(Some(Kling1p6ProTextToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(); + let ten = make_request(Some(Kling1p6ProTextToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(); + assert!(five < ten, "five={five}¢ < ten={ten}¢"); + } + + /// Sanity: text-to-video should be slightly more expensive than + /// image-to-video at every supported duration ($0.098 vs $0.095 per + /// second). Protects against accidentally swapping the rates. + #[test] + fn text_to_video_is_pricier_than_image_to_video_at_each_duration() { + fn i2v(duration: Kling1p6ProImageToVideoDuration) -> u64 { + Kling1p6ProImageToVideoRequest { + prompt: "test".to_string(), + image_url: "https://example.com/i.png".to_string(), + end_image_url: None, + negative_prompt: None, + duration: Some(duration), + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }.calculate_cost_in_cents() + } + let pairs = [ + (Kling1p6ProTextToVideoDuration::FiveSeconds, Kling1p6ProImageToVideoDuration::FiveSeconds), + (Kling1p6ProTextToVideoDuration::TenSeconds, Kling1p6ProImageToVideoDuration::TenSeconds), + ]; + for (t, i) in pairs { + let text = make_request(Some(t)).calculate_cost_in_cents(); + let image = i2v(i); + assert!(text > image, "text-to-video ({text}¢) must be > image-to-video ({image}¢) at {t:?}"); + } + } + + /// Exhaustive cost-table tests: every permutation of cost-relevant + /// configuration for text-to-video. There is no direct legacy + /// equivalent (the legacy `enqueue_kling_v1p6_pro_image_to_video_webhook` + /// is image-to-video at a slightly lower rate), so the parity here is + /// against the canonical $0.098/sec formula. A separate sub-test + /// cross-references the legacy image-to-video function to confirm the + /// expected per-duration premium ($0.003/sec rounded). + mod cost_table { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use crate::requests_old::webhook::video::image::enqueue_kling_v1p6_pro_image_to_video_webhook::{ + Kling1p6ProAspectRatio as LegacyAspectRatio, + Kling1p6ProDuration as LegacyDuration, + Kling1p6ProRequest as LegacyRequest, + }; + + fn new_request( + duration: Option, + aspect_ratio: Option, + ) -> Kling1p6ProTextToVideoRequest { + Kling1p6ProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration, + aspect_ratio, + cfg_scale: None, + } + } + + // (duration, aspect_ratio, expected_cents) + // + // Math: ceil(98 × secs / 10) where 5s → 49¢ and 10s → 98¢. + // duration=None defaults to 5s. + // Aspect ratio is irrelevant to cost; iterated only to assert it. + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + // duration=None → 5s default → 49¢ + (None, None, 49), + (None, Some(Kling1p6ProTextToVideoAspectRatio::Square), 49), + (None, Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), 49), + (None, Some(Kling1p6ProTextToVideoAspectRatio::NineBySixteen), 49), + // duration=5s → 49¢ + (Some(Kling1p6ProTextToVideoDuration::FiveSeconds), None, 49), + (Some(Kling1p6ProTextToVideoDuration::FiveSeconds), Some(Kling1p6ProTextToVideoAspectRatio::Square), 49), + (Some(Kling1p6ProTextToVideoDuration::FiveSeconds), Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), 49), + (Some(Kling1p6ProTextToVideoDuration::FiveSeconds), Some(Kling1p6ProTextToVideoAspectRatio::NineBySixteen), 49), + // duration=10s → 98¢ + (Some(Kling1p6ProTextToVideoDuration::TenSeconds), None, 98), + (Some(Kling1p6ProTextToVideoDuration::TenSeconds), Some(Kling1p6ProTextToVideoAspectRatio::Square), 98), + (Some(Kling1p6ProTextToVideoDuration::TenSeconds), Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), 98), + (Some(Kling1p6ProTextToVideoDuration::TenSeconds), Some(Kling1p6ProTextToVideoAspectRatio::NineBySixteen), 98), + ]; + + #[test] + fn new_module_matches_cost_table() { + for &(duration, aspect_ratio, expected) in COST_TABLE { + let got = new_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "new module: duration={duration:?} aspect_ratio={aspect_ratio:?}", + ); + } + } + + /// Aspect ratio is not part of the billing formula — every row in the + /// cost table must produce the same value for any aspect-ratio choice. + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + None, + Some(Kling1p6ProTextToVideoAspectRatio::Square), + Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + Some(Kling1p6ProTextToVideoAspectRatio::NineBySixteen), + ]; + let durations = [ + None, + Some(Kling1p6ProTextToVideoDuration::FiveSeconds), + Some(Kling1p6ProTextToVideoDuration::TenSeconds), + ]; + for duration in durations { + let baseline = new_request(duration, aspect_ratios[0]).calculate_cost_in_cents(); + for &ar in &aspect_ratios[1..] { + let cost = new_request(duration, ar).calculate_cost_in_cents(); + assert_eq!(cost, baseline, "duration={duration:?} ar={ar:?}"); + } + } + } + + /// Cross-check against the legacy image-to-video function. Text-to-video + /// is `$0.098/sec` and image-to-video is `$0.095/sec`, so at each + /// duration the cost difference equals `ceil(0.003 × secs)`: + /// 5s: 49¢ − 48¢ = 1¢ (≈ $0.015 difference before rounding) + /// 10s: 98¢ − 95¢ = 3¢ + /// If a future change to the legacy image-to-video rate breaks this + /// invariant, this test calls it out. + #[test] + fn premium_over_legacy_image_to_video_is_as_expected() { + fn legacy_image(secs_variant: LegacyDuration) -> u64 { + LegacyRequest { + image_url: "https://example.com/i.png".to_string(), + end_frame_image_url: None, + prompt: "test".to_string(), + duration: secs_variant, + aspect_ratio: LegacyAspectRatio::WideSixteenNine, + }.calculate_cost_in_cents() + } + + // (text duration, equivalent legacy image duration, expected premium in cents) + let cases = [ + (Kling1p6ProTextToVideoDuration::FiveSeconds, LegacyDuration::FiveSeconds, 1u64), + (Kling1p6ProTextToVideoDuration::TenSeconds, LegacyDuration::TenSeconds, 3u64), + ]; + + for (text_d, legacy_d, expected_premium) in cases { + let text_cost = new_request(Some(text_d), None).calculate_cost_in_cents(); + let image_cost = legacy_image(legacy_d); + let premium = text_cost.saturating_sub(image_cost); + assert_eq!( + premium, expected_premium, + "{text_d:?}: text={text_cost}¢ legacy_image={image_cost}¢ premium={premium}¢ (want {expected_premium}¢)", + ); + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/raw_request.rs new file mode 100644 index 00000000..f3d4ec42 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_1p6_pro_text_to_video/raw_request.rs @@ -0,0 +1,38 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v1.6/pro/text-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling1p6ProTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling1p6ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling1p6ProTextToVideoOutput { + pub video: Kling1p6ProTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/api.rs new file mode 100644 index 00000000..8a0e41de --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/api.rs @@ -0,0 +1,335 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::raw_request::{ + Kling2p5TurboProTextToVideoInput, Kling2p5TurboProTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling2p5TurboProTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// Video duration. Kling 2.5 Turbo Pro supports 5 or 10 seconds only. + pub duration: Option, + + /// Aspect ratio. fal's default is `16:9` when this is `None`. + pub aspect_ratio: Option, + + /// CFG scale. Defaults to fal's `0.5` when `None`. + pub cfg_scale: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling2p5TurboProTextToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling2p5TurboProTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling2p5TurboProTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +impl FalEndpoint for Kling2p5TurboProTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v2.5-turbo/pro/text-to-video"; + + type RawRequest = Kling2p5TurboProTextToVideoInput; + type RawResponse = Kling2p5TurboProTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling2p5TurboProTextToVideoAspectRatio::Square => "1:1", + Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine => "16:9", + Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio, + negative_prompt: self.negative_prompt.clone(), + duration, + cfg_scale: self.cfg_scale, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p5TurboProTextToVideoRequest { + prompt: "an owl flies past an abandoned castle at dusk, fireflies dance in the trees".to_string(), + negative_prompt: None, + duration: Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p5TurboProTextToVideoRequest { + prompt: "a candle flickers in a dark stone hall".to_string(), + negative_prompt: None, + duration: Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling2p5TurboProTextToVideoAspectRatio::Square, + Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine, + Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling2p5TurboProTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + negative_prompt: None, + duration: Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(ar), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling2p5TurboProTextToVideoDuration::FiveSeconds, + Kling2p5TurboProTextToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling2p5TurboProTextToVideoRequest { + prompt: "a candle flame flickers in a dark room".to_string(), + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_aspect_ratio_uses_colon_format() { + let request = Kling2p5TurboProTextToVideoRequest { + prompt: "p".to_string(), + negative_prompt: None, + duration: Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("10")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Kling2p5TurboProTextToVideoRequest { + prompt: "p".to_string(), + negative_prompt: None, + duration: None, + aspect_ratio: None, + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert!(raw.aspect_ratio.is_none()); + assert!(raw.duration.is_none()); + assert!(raw.negative_prompt.is_none()); + assert!(raw.cfg_scale.is_none()); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Kling2p5TurboProTextToVideoRequest::ENDPOINT, + "fal-ai/kling-video/v2.5-turbo/pro/text-to-video", + ); + } + + /// Wire-shape, endpoint, and cost parity vs the legacy modules: + /// `requests_old/http/video/text/http_kling_v2p5_turbo_pro_text_to_video.rs` + /// `requests_old/webhook/video/text/enqueue_kling_v2p5_turbo_pro_text_to_video_webhook.rs` + mod legacy_parity { + use super::*; + use crate::requests_old::http::video::text::http_kling_v2p5_turbo_pro_text_to_video::{ + kling_v2p5_turbo_pro_text_to_video, KlingV2p5TurboProTextToVideoInput, + }; + + /// Same `fal-ai/kling-video/v2.5-turbo/pro/text-to-video` path. + #[test] + fn endpoint_path_matches_legacy() { + let legacy = kling_v2p5_turbo_pro_text_to_video(KlingV2p5TurboProTextToVideoInput::default()); + assert_eq!( + Kling2p5TurboProTextToVideoRequest::ENDPOINT, + legacy.endpoint, + ); + } + + /// At a representative fully-populated case, the new module's serialized + /// `RawRequest` must equal the legacy `Input`'s JSON. + #[test] + fn wire_json_matches_legacy_fully_populated() { + let new = Kling2p5TurboProTextToVideoRequest { + prompt: "a wave at dawn".to_string(), + negative_prompt: Some("blurry".to_string()), + duration: Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), + cfg_scale: Some(0.5), + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p5TurboProTextToVideoInput { + prompt: "a wave at dawn".to_string(), + aspect_ratio: Some("9:16".to_string()), + negative_prompt: Some("blurry".to_string()), + duration: Some("10".to_string()), + cfg_scale: Some(0.5), + }; + let legacy_json = serde_json::to_value(&legacy).unwrap(); + + assert_eq!(new_json, legacy_json); + } + + /// Minimal case (prompt only): unset optionals must be omitted on the + /// wire just like the legacy struct. + #[test] + fn wire_json_matches_legacy_minimal() { + let new = Kling2p5TurboProTextToVideoRequest { + prompt: "minimal".to_string(), + negative_prompt: None, + duration: None, + aspect_ratio: None, + cfg_scale: None, + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p5TurboProTextToVideoInput { + prompt: "minimal".to_string(), + ..Default::default() + }; + let legacy_json = serde_json::to_value(&legacy).unwrap(); + + assert_eq!(new_json, legacy_json); + assert_eq!(new_json, serde_json::json!({ "prompt": "minimal" })); + } + + /// Cross product over duration × aspect_ratio: every cell's wire JSON + /// must match the equivalent legacy `Input`. + #[test] + fn wire_json_matches_legacy_at_every_combo() { + let durations = [ + (None, None), + (Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), Some("5")), + (Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), Some("10")), + ]; + let aspect_ratios = [ + (None, None), + (Some(Kling2p5TurboProTextToVideoAspectRatio::Square), Some("1:1")), + (Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), Some("16:9")), + (Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), Some("9:16")), + ]; + + for (d_new, d_legacy) in durations { + for (ar_new, ar_legacy) in aspect_ratios { + let new = Kling2p5TurboProTextToVideoRequest { + prompt: "p".to_string(), + negative_prompt: None, + duration: d_new, + aspect_ratio: ar_new, + cfg_scale: None, + }; + let legacy = KlingV2p5TurboProTextToVideoInput { + prompt: "p".to_string(), + aspect_ratio: ar_legacy.map(String::from), + negative_prompt: None, + duration: d_legacy.map(String::from), + cfg_scale: None, + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + let legacy_json = serde_json::to_value(&legacy).unwrap(); + assert_eq!( + new_json, legacy_json, + "duration={d_new:?} aspect_ratio={ar_new:?}", + ); + } + } + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/cost.rs new file mode 100644 index 00000000..0a95ef30 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/cost.rs @@ -0,0 +1,261 @@ +use crate::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::api::{ + Kling2p5TurboProTextToVideoDuration, Kling2p5TurboProTextToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling2p5TurboProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 2.5 Turbo Pro text-to-video pricing + // (see https://fal.ai/models/fal-ai/kling-video/v2.5-turbo/pro/text-to-video): + // "For 5s video your request will cost $0.35. + // For every additional second you will be charged $0.07." + // + // That works out to a flat $0.07/second rate. Rate is held in + // tenths-of-cents and rounded up to whole cents so the user is never + // undercharged. + let duration_secs = self.duration + .unwrap_or(Kling2p5TurboProTextToVideoDuration::FiveSeconds) + .to_seconds(); + (70u64 * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::api::{ + Kling2p5TurboProTextToVideoAspectRatio, Kling2p5TurboProTextToVideoDuration, + }; + + fn make_request( + duration: Option, + ) -> Kling2p5TurboProTextToVideoRequest { + Kling2p5TurboProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration, + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + } + } + + // Pricing: flat $0.07/sec = 70 tenths-of-cents/sec. + // Cents per duration = ceil(70 × secs / 10). + + #[test] + fn five_seconds() { + // (70 * 5 + 9) / 10 = 35 — matches fal's "$0.35 for 5s" base rate + assert_eq!( + make_request(Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 35, + ); + } + + #[test] + fn ten_seconds() { + // (70 * 10 + 9) / 10 = 70 — matches "$0.35 + 5×$0.07 = $0.70" + assert_eq!( + make_request(Some(Kling2p5TurboProTextToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 70, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None → 5s → 35¢ + assert_eq!(make_request(None).calculate_cost_in_cents(), 35); + } + + #[test] + fn ten_seconds_costs_more_than_five() { + let five = make_request(Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(); + let ten = make_request(Some(Kling2p5TurboProTextToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(); + assert!(five < ten, "five={five}¢ < ten={ten}¢"); + } + + /// Exhaustive cost-table tests and cross-checks against the legacy + /// `enqueue_kling_v2p5_turbo_pro_text_to_video_webhook` calculator. + mod legacy_parity { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use crate::requests_old::webhook::video::text::enqueue_kling_v2p5_turbo_pro_text_to_video_webhook::{ + EnqueueKlingV2p5TurboProTextToVideoAspectRatio as LegacyAspectRatio, + EnqueueKlingV2p5TurboProTextToVideoDurationSeconds as LegacyDuration, + EnqueueKlingV2p5TurboProTextToVideoRequest as LegacyRequest, + }; + + // ── Mapping helpers from the new strongly-typed API to the legacy one ── + + fn legacy_duration_for(d: Option) -> Option { + match d { + None => None, + Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds) => Some(LegacyDuration::Five), + Some(Kling2p5TurboProTextToVideoDuration::TenSeconds) => Some(LegacyDuration::Ten), + } + } + + fn legacy_aspect_ratio_for( + ar: Option, + ) -> Option { + match ar { + None => None, + Some(Kling2p5TurboProTextToVideoAspectRatio::Square) => Some(LegacyAspectRatio::Square), + Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine) => Some(LegacyAspectRatio::SixteenByNine), + Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen) => Some(LegacyAspectRatio::NineBySixteen), + } + } + + fn new_request( + duration: Option, + aspect_ratio: Option, + ) -> Kling2p5TurboProTextToVideoRequest { + Kling2p5TurboProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration, + aspect_ratio, + cfg_scale: None, + } + } + + fn legacy_request( + duration: Option, + aspect_ratio: Option, + ) -> LegacyRequest { + LegacyRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration: legacy_duration_for(duration), + aspect_ratio: legacy_aspect_ratio_for(aspect_ratio), + } + } + + // (new_duration, new_aspect_ratio, expected_cents) + // + // Math: ceil(70 × secs / 10). 5s → 35¢; 10s → 70¢. + // duration=None defaults to 5s in both new and legacy modules. + // Aspect ratio is irrelevant to cost; iterated only to assert it. + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + // duration=None → 5s default → 35¢ + (None, None, 35), + (None, Some(Kling2p5TurboProTextToVideoAspectRatio::Square), 35), + (None, Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), 35), + (None, Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), 35), + // duration=5s → 35¢ + (Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), None, 35), + (Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), Some(Kling2p5TurboProTextToVideoAspectRatio::Square), 35), + (Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), 35), + (Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), 35), + // duration=10s → 70¢ + (Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), None, 70), + (Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), Some(Kling2p5TurboProTextToVideoAspectRatio::Square), 70), + (Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), 70), + (Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), 70), + ]; + + #[test] + fn new_module_matches_cost_table() { + for &(duration, aspect_ratio, expected) in COST_TABLE { + let got = new_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "new module: duration={duration:?} aspect_ratio={aspect_ratio:?}", + ); + } + } + + #[test] + fn legacy_function_matches_cost_table() { + for &(duration, aspect_ratio, expected) in COST_TABLE { + let got = legacy_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "legacy function: duration={duration:?} aspect_ratio={aspect_ratio:?}", + ); + } + } + + /// Headline parity check: new vs legacy give identical cents at every + /// permutation. If this fails, pricing has drifted. + #[test] + fn new_module_matches_legacy_at_every_combo() { + for &(duration, aspect_ratio, _) in COST_TABLE { + let new_cost = new_request(duration, aspect_ratio).calculate_cost_in_cents(); + let legacy_cost = legacy_request(duration, aspect_ratio).calculate_cost_in_cents(); + assert_eq!( + new_cost, legacy_cost, + "parity mismatch at duration={duration:?} aspect_ratio={aspect_ratio:?}: \ + new={new_cost}¢ vs legacy={legacy_cost}¢", + ); + } + } + + /// Aspect ratio is not part of the billing formula — every aspect-ratio + /// choice (including `None`) must produce the same value for fixed + /// duration. + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + None, + Some(Kling2p5TurboProTextToVideoAspectRatio::Square), + Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + Some(Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen), + ]; + let durations = [ + None, + Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), + Some(Kling2p5TurboProTextToVideoDuration::TenSeconds), + ]; + for duration in durations { + let baseline = new_request(duration, aspect_ratios[0]).calculate_cost_in_cents(); + for &ar in &aspect_ratios[1..] { + let cost = new_request(duration, ar).calculate_cost_in_cents(); + assert_eq!(cost, baseline, "duration={duration:?} ar={ar:?}"); + } + } + } + + /// cfg_scale is not part of the billing formula. + #[test] + fn cost_is_independent_of_cfg_scale() { + for cfg in [None, Some(0.0_f32), Some(0.5), Some(1.0)] { + let req = Kling2p5TurboProTextToVideoRequest { + prompt: "test".to_string(), + negative_prompt: None, + duration: Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: cfg, + }; + assert_eq!(req.calculate_cost_in_cents(), 35, "cfg_scale={cfg:?}"); + } + } + + /// Sanity-check fal's documented examples: + /// "For 5s video your request will cost $0.35" + /// "For every additional second you will be charged $0.07" + /// → 10s costs $0.35 + 5 × $0.07 = $0.70 + #[test] + fn matches_documented_examples() { + assert_eq!( + make_request(Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds)) + .calculate_cost_in_cents(), + 35, + "5s should be $0.35 per fal's docs", + ); + assert_eq!( + make_request(Some(Kling2p5TurboProTextToVideoDuration::TenSeconds)) + .calculate_cost_in_cents(), + 70, + "10s should be $0.70 per fal's docs", + ); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/raw_request.rs new file mode 100644 index 00000000..c06edfde --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p5_turbo_pro_text_to_video/raw_request.rs @@ -0,0 +1,38 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v2.5-turbo/pro/text-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling2p5TurboProTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" (fal default: "16:9") + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" (fal default: "5") + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p5TurboProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p5TurboProTextToVideoOutput { + pub video: Kling2p5TurboProTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/api.rs new file mode 100644 index 00000000..e42cacba --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/api.rs @@ -0,0 +1,358 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::kling_2p6_pro_text_to_video::raw_request::{ + Kling2p6ProTextToVideoInput, Kling2p6ProTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling2p6ProTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Optional negative prompt. fal's default is + /// `"blur, distort, and low quality"` when this is `None`. + pub negative_prompt: Option, + + /// Video duration. Kling 2.6 Pro supports 5 or 10 seconds only. + pub duration: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, + + /// CFG scale. Defaults to fal's `0.5` when `None`. + pub cfg_scale: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling2p6ProTextToVideoDuration { + FiveSeconds, + TenSeconds, +} + +impl Kling2p6ProTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::TenSeconds => 10, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5", + Self::TenSeconds => "10", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling2p6ProTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +impl FalEndpoint for Kling2p6ProTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v2.6/pro/text-to-video"; + + type RawRequest = Kling2p6ProTextToVideoInput; + type RawResponse = Kling2p6ProTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling2p6ProTextToVideoAspectRatio::Square => "1:1", + Kling2p6ProTextToVideoAspectRatio::SixteenByNine => "16:9", + Kling2p6ProTextToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio, + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + duration, + cfg_scale: self.cfg_scale, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p6ProTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(Kling2p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling2p6ProTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(Kling2p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling2p6ProTextToVideoAspectRatio::Square, + Kling2p6ProTextToVideoAspectRatio::SixteenByNine, + Kling2p6ProTextToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling2p6ProTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(Kling2p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(ar), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling2p6ProTextToVideoDuration::FiveSeconds, + Kling2p6ProTextToVideoDuration::TenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling2p6ProTextToVideoRequest { + prompt: "a candle flame flickers in a dark room".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // ── Wire-shape sanity ── + + #[test] + fn raw_request_aspect_ratio_uses_colon_format() { + let request = Kling2p6ProTextToVideoRequest { + prompt: "p".to_string(), + generate_audio: None, + negative_prompt: None, + duration: Some(Kling2p6ProTextToVideoDuration::TenSeconds), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::NineBySixteen), + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("10")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Kling2p6ProTextToVideoRequest { + prompt: "p".to_string(), + generate_audio: None, + negative_prompt: None, + duration: None, + aspect_ratio: None, + cfg_scale: None, + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert!(raw.aspect_ratio.is_none()); + assert!(raw.duration.is_none()); + assert!(raw.generate_audio.is_none()); + assert!(raw.negative_prompt.is_none()); + assert!(raw.cfg_scale.is_none()); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + Kling2p6ProTextToVideoRequest::ENDPOINT, + "fal-ai/kling-video/v2.6/pro/text-to-video", + ); + } + + /// Wire-shape and endpoint parity vs the legacy + /// `requests_old/http/video/text/http_kling_v2p6_pro_text_to_video.rs`. + /// The legacy module has no cost calculator, so cost parity is N/A; + /// these tests verify the *shape sent on the wire* hasn't drifted. + mod legacy_parity { + use super::*; + use crate::requests_old::http::video::text::http_kling_v2p6_pro_text_to_video::{ + kling_v2p6_pro_text_to_video, KlingV2p6ProTextToVideoInput, + }; + + /// Same `fal-ai/kling-video/v2.6/pro/text-to-video` path. + #[test] + fn endpoint_path_matches_legacy() { + let legacy = kling_v2p6_pro_text_to_video(KlingV2p6ProTextToVideoInput::default()); + assert_eq!( + Kling2p6ProTextToVideoRequest::ENDPOINT, + legacy.endpoint, + ); + } + + /// At a representative populated case, the new module's serialized + /// `RawRequest` must equal the legacy `Input`'s JSON byte-for-byte + /// (modulo serde field ordering, which is stable within each struct). + #[test] + fn wire_json_matches_legacy_fully_populated() { + let new = Kling2p6ProTextToVideoRequest { + prompt: "a wave at dawn".to_string(), + generate_audio: Some(true), + negative_prompt: Some("blurry".to_string()), + duration: Some(Kling2p6ProTextToVideoDuration::TenSeconds), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::NineBySixteen), + cfg_scale: Some(0.5), + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p6ProTextToVideoInput { + prompt: "a wave at dawn".to_string(), + aspect_ratio: Some("9:16".to_string()), + generate_audio: Some(true), + negative_prompt: Some("blurry".to_string()), + duration: Some("10".to_string()), + cfg_scale: Some(0.5), + }; + let legacy_json = serde_json::to_value(&legacy).unwrap(); + + assert_eq!(new_json, legacy_json); + } + + /// At minimum (prompt only), unset optionals must be omitted on the + /// wire just like the legacy struct. + #[test] + fn wire_json_matches_legacy_minimal() { + let new = Kling2p6ProTextToVideoRequest { + prompt: "minimal".to_string(), + generate_audio: None, + negative_prompt: None, + duration: None, + aspect_ratio: None, + cfg_scale: None, + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + + let legacy = KlingV2p6ProTextToVideoInput { + prompt: "minimal".to_string(), + ..Default::default() + }; + let legacy_json = serde_json::to_value(&legacy).unwrap(); + + assert_eq!(new_json, legacy_json); + // And the minimal payload should literally be `{"prompt": "minimal"}`. + assert_eq!(new_json, serde_json::json!({ "prompt": "minimal" })); + } + + /// Cross product over duration × aspect_ratio × audio: every cell's wire + /// JSON must match the equivalent legacy `Input`. + #[test] + fn wire_json_matches_legacy_at_every_combo() { + let durations = [ + (None, None), + (Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some("5")), + (Some(Kling2p6ProTextToVideoDuration::TenSeconds), Some("10")), + ]; + let aspect_ratios = [ + (None, None), + (Some(Kling2p6ProTextToVideoAspectRatio::Square), Some("1:1")), + (Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), Some("16:9")), + (Some(Kling2p6ProTextToVideoAspectRatio::NineBySixteen), Some("9:16")), + ]; + let audio_options = [None, Some(false), Some(true)]; + + for (d_new, d_legacy) in durations { + for (ar_new, ar_legacy) in aspect_ratios { + for audio in audio_options { + let new = Kling2p6ProTextToVideoRequest { + prompt: "p".to_string(), + generate_audio: audio, + negative_prompt: None, + duration: d_new, + aspect_ratio: ar_new, + cfg_scale: None, + }; + let legacy = KlingV2p6ProTextToVideoInput { + prompt: "p".to_string(), + aspect_ratio: ar_legacy.map(String::from), + generate_audio: audio, + negative_prompt: None, + duration: d_legacy.map(String::from), + cfg_scale: None, + }; + let new_json = serde_json::to_value(new.to_raw_request().unwrap()).unwrap(); + let legacy_json = serde_json::to_value(&legacy).unwrap(); + assert_eq!( + new_json, legacy_json, + "duration={d_new:?} aspect_ratio={ar_new:?} audio={audio:?}", + ); + } + } + } + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/cost.rs new file mode 100644 index 00000000..192e08a0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/cost.rs @@ -0,0 +1,247 @@ +use crate::requests::api::video::text::kling_2p6_pro_text_to_video::api::{ + Kling2p6ProTextToVideoDuration, Kling2p6ProTextToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling2p6ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 2.6 Pro text-to-video pricing + // (see https://fal.ai/models/fal-ai/kling-video/v2.6/pro/text-to-video): + // $0.07/sec when audio is off + // $0.14/sec when audio is on + // + // generate_audio defaults to `true` on fal's server, so `None` is billed + // as audio-on. Rate stored in tenths-of-cents and rounded up to whole + // cents so the user is never undercharged. + let duration_secs = self.duration + .unwrap_or(Kling2p6ProTextToVideoDuration::FiveSeconds) + .to_seconds(); + + let audio_on = self.generate_audio.unwrap_or(true); + let rate_tenth_cents_per_sec: u64 = if audio_on { 140 } else { 70 }; + + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::kling_2p6_pro_text_to_video::api::{ + Kling2p6ProTextToVideoAspectRatio, Kling2p6ProTextToVideoDuration, + }; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Kling2p6ProTextToVideoRequest { + Kling2p6ProTextToVideoRequest { + prompt: "test".to_string(), + generate_audio, + negative_prompt: None, + duration, + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + } + } + + // Pricing: $0.07/sec audio off, $0.14/sec audio on. + // Cents per duration = ceil(rate × secs / 10) where rate is in tenths-of-cents. + + #[test] + fn five_seconds_audio_off() { + // (70 * 5 + 9) / 10 = 35 + assert_eq!( + make_request(Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some(false)) + .calculate_cost_in_cents(), + 35, + ); + } + + #[test] + fn five_seconds_audio_on() { + // (140 * 5 + 9) / 10 = 70 — matches fal's $0.70 example + assert_eq!( + make_request(Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some(true)) + .calculate_cost_in_cents(), + 70, + ); + } + + #[test] + fn ten_seconds_audio_off() { + // (70 * 10 + 9) / 10 = 70 + assert_eq!( + make_request(Some(Kling2p6ProTextToVideoDuration::TenSeconds), Some(false)) + .calculate_cost_in_cents(), + 70, + ); + } + + #[test] + fn ten_seconds_audio_on() { + // (140 * 10 + 9) / 10 = 140 + assert_eq!( + make_request(Some(Kling2p6ProTextToVideoDuration::TenSeconds), Some(true)) + .calculate_cost_in_cents(), + 140, + ); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None, audio=on (default) → 5s @ $0.14 = 70¢ + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 70); + } + + #[test] + fn default_audio_is_on() { + // duration=5s, audio=None → audio_on=true → 70¢ + let none_default = make_request(Some(Kling2p6ProTextToVideoDuration::FiveSeconds), None) + .calculate_cost_in_cents(); + let explicit_on = make_request(Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some(true)) + .calculate_cost_in_cents(); + assert_eq!(none_default, explicit_on); + } + + #[test] + fn audio_on_costs_twice_as_much_as_off() { + // $0.14 / $0.07 = 2x at every duration + let durations = [ + Kling2p6ProTextToVideoDuration::FiveSeconds, + Kling2p6ProTextToVideoDuration::TenSeconds, + ]; + for d in durations { + let off = make_request(Some(d), Some(false)).calculate_cost_in_cents(); + let on = make_request(Some(d), Some(true)).calculate_cost_in_cents(); + assert_eq!(on, off * 2, "duration={d:?}: audio_on={on}¢ should be 2× audio_off={off}¢"); + } + } + + #[test] + fn ten_seconds_costs_more_than_five() { + // At a given audio setting, 10s > 5s. + for audio in [Some(false), Some(true), None] { + let five = make_request(Some(Kling2p6ProTextToVideoDuration::FiveSeconds), audio) + .calculate_cost_in_cents(); + let ten = make_request(Some(Kling2p6ProTextToVideoDuration::TenSeconds), audio) + .calculate_cost_in_cents(); + assert!(five < ten, "audio={audio:?}: five={five}¢ < ten={ten}¢"); + } + } + + /// Exhaustive cost-table tests: every permutation of cost-relevant + /// configuration (duration × generate_audio). Aspect ratio is in the cross + /// product as a sanity check — it must not affect the bill. + mod cost_table { + use super::*; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + + fn new_request( + duration: Option, + generate_audio: Option, + aspect_ratio: Option, + ) -> Kling2p6ProTextToVideoRequest { + Kling2p6ProTextToVideoRequest { + prompt: "test".to_string(), + generate_audio, + negative_prompt: None, + duration, + aspect_ratio, + cfg_scale: None, + } + } + + // (duration, generate_audio, expected_cents) + // + // Math: ceil(rate × secs / 10) where rate is 70 (audio off) or 140 (audio on). + // duration=None defaults to 5s; generate_audio=None defaults to true. + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + // duration=None → 5s default + (None, Some(false), 35), + (None, Some(true), 70), + (None, None, 70), // audio default = on + // duration=5s + (Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some(false), 35), + (Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some(true), 70), + (Some(Kling2p6ProTextToVideoDuration::FiveSeconds), None, 70), + // duration=10s + (Some(Kling2p6ProTextToVideoDuration::TenSeconds), Some(false), 70), + (Some(Kling2p6ProTextToVideoDuration::TenSeconds), Some(true), 140), + (Some(Kling2p6ProTextToVideoDuration::TenSeconds), None, 140), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = new_request(duration, generate_audio, None).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} generate_audio={generate_audio:?}", + ); + } + } + + /// Aspect ratio is not part of the billing formula — every aspect-ratio + /// choice (including `None`) must produce the same value for fixed + /// (duration, generate_audio). + #[test] + fn cost_is_independent_of_aspect_ratio() { + let aspect_ratios = [ + None, + Some(Kling2p6ProTextToVideoAspectRatio::Square), + Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + Some(Kling2p6ProTextToVideoAspectRatio::NineBySixteen), + ]; + let durations = [ + None, + Some(Kling2p6ProTextToVideoDuration::FiveSeconds), + Some(Kling2p6ProTextToVideoDuration::TenSeconds), + ]; + let audio_options = [None, Some(false), Some(true)]; + + for duration in durations { + for audio in audio_options { + let baseline = new_request(duration, audio, aspect_ratios[0]).calculate_cost_in_cents(); + for &ar in &aspect_ratios[1..] { + let cost = new_request(duration, audio, ar).calculate_cost_in_cents(); + assert_eq!( + cost, baseline, + "duration={duration:?} audio={audio:?} ar={ar:?}: cost={cost}¢ != baseline={baseline}¢", + ); + } + } + } + } + + /// cfg_scale is not part of the billing formula — every choice must produce + /// the same value for fixed (duration, generate_audio). + #[test] + fn cost_is_independent_of_cfg_scale() { + for cfg in [None, Some(0.0_f32), Some(0.5), Some(1.0)] { + let req = Kling2p6ProTextToVideoRequest { + prompt: "test".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(Kling2p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: cfg, + }; + assert_eq!(req.calculate_cost_in_cents(), 70, "cfg_scale={cfg:?}"); + } + } + + /// Sanity-check the documented examples from fal: + /// "a 5s video with audio on will cost $0.70" + #[test] + fn matches_documented_examples() { + let cost = make_request(Some(Kling2p6ProTextToVideoDuration::FiveSeconds), Some(true)) + .calculate_cost_in_cents(); + assert_eq!(cost, 70, "5s audio-on should be $0.70 per fal's docs"); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/raw_request.rs new file mode 100644 index 00000000..91347fbb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_2p6_pro_text_to_video/raw_request.rs @@ -0,0 +1,42 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/kling-video/v2.6/pro/text-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling2p6ProTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Whether to generate native audio for the video. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + /// fal's default: "blur, distort, and low quality" + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p6ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling2p6ProTextToVideoOutput { + pub video: Kling2p6ProTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/api.rs new file mode 100644 index 00000000..5b492e70 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/api.rs @@ -0,0 +1,275 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::kling_3p0_standard_text_to_video::raw_request::{ + Kling3p0StandardTextToVideoInput, Kling3p0StandardTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Kling3p0StandardTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Whether to generate audio. Defaults to true if not specified. + pub generate_audio: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Video duration. + pub duration: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, + + /// Shot type for multi-shot generation. + pub shot_type: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling3p0StandardTextToVideoDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +impl Kling3p0StandardTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::ThreeSeconds => 3, + Self::FourSeconds => 4, + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + Self::NineSeconds => 9, + Self::TenSeconds => 10, + Self::ElevenSeconds => 11, + Self::TwelveSeconds => 12, + Self::ThirteenSeconds => 13, + Self::FourteenSeconds => 14, + Self::FifteenSeconds => 15, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSeconds => "3", + Self::FourSeconds => "4", + Self::FiveSeconds => "5", + Self::SixSeconds => "6", + Self::SevenSeconds => "7", + Self::EightSeconds => "8", + Self::NineSeconds => "9", + Self::TenSeconds => "10", + Self::ElevenSeconds => "11", + Self::TwelveSeconds => "12", + Self::ThirteenSeconds => "13", + Self::FourteenSeconds => "14", + Self::FifteenSeconds => "15", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling3p0StandardTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Kling3p0StandardTextToVideoShotType { + Customize, + Intelligent, +} + +impl FalEndpoint for Kling3p0StandardTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/kling-video/v3/standard/text-to-video"; + + type RawRequest = Kling3p0StandardTextToVideoInput; + type RawResponse = Kling3p0StandardTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + let duration = self.duration.map(|d| d.to_str().to_string()); + + let aspect_ratio = self.aspect_ratio.map(|ar| match ar { + Kling3p0StandardTextToVideoAspectRatio::Square => "1:1", + Kling3p0StandardTextToVideoAspectRatio::SixteenByNine => "16:9", + Kling3p0StandardTextToVideoAspectRatio::NineBySixteen => "9:16", + }.to_string()); + + let shot_type = self.shot_type.map(|st| match st { + Kling3p0StandardTextToVideoShotType::Customize => "customize", + Kling3p0StandardTextToVideoShotType::Intelligent => "intelligent", + }.to_string()); + + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + generate_audio: self.generate_audio, + negative_prompt: self.negative_prompt.clone(), + duration, + aspect_ratio, + shot_type, + cfg_scale: None, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling3p0StandardTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow, cinematic slow motion".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(Kling3p0StandardTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Kling3p0StandardTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(Kling3p0StandardTextToVideoDuration::ThreeSeconds), + aspect_ratio: Some(Kling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let aspect_ratios = [ + Kling3p0StandardTextToVideoAspectRatio::Square, + Kling3p0StandardTextToVideoAspectRatio::SixteenByNine, + Kling3p0StandardTextToVideoAspectRatio::NineBySixteen, + ]; + + for ar in aspect_ratios { + println!("--- aspect ratio: {:?} ---", ar); + let request = Kling3p0StandardTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(Kling3p0StandardTextToVideoDuration::ThreeSeconds), + aspect_ratio: Some(ar), + shot_type: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let durations = [ + Kling3p0StandardTextToVideoDuration::ThreeSeconds, + Kling3p0StandardTextToVideoDuration::FourSeconds, + Kling3p0StandardTextToVideoDuration::FiveSeconds, + Kling3p0StandardTextToVideoDuration::SixSeconds, + Kling3p0StandardTextToVideoDuration::SevenSeconds, + Kling3p0StandardTextToVideoDuration::EightSeconds, + Kling3p0StandardTextToVideoDuration::NineSeconds, + Kling3p0StandardTextToVideoDuration::TenSeconds, + Kling3p0StandardTextToVideoDuration::ElevenSeconds, + Kling3p0StandardTextToVideoDuration::TwelveSeconds, + Kling3p0StandardTextToVideoDuration::ThirteenSeconds, + Kling3p0StandardTextToVideoDuration::FourteenSeconds, + Kling3p0StandardTextToVideoDuration::FifteenSeconds, + ]; + + for dur in durations { + println!("--- duration: {:?} ---", dur); + let request = Kling3p0StandardTextToVideoRequest { + prompt: "a candle flame flickers in a dark room".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(Kling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_shot_types() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let shot_types = [ + Kling3p0StandardTextToVideoShotType::Customize, + Kling3p0StandardTextToVideoShotType::Intelligent, + ]; + + for st in shot_types { + println!("--- shot type: {:?} ---", st); + let request = Kling3p0StandardTextToVideoRequest { + prompt: "a bird takes flight from a tree branch".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(Kling3p0StandardTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: Some(st), + }; + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/cost.rs new file mode 100644 index 00000000..3287194f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/cost.rs @@ -0,0 +1,120 @@ +use crate::requests::api::video::text::kling_3p0_standard_text_to_video::api::{ + Kling3p0StandardTextToVideoDuration, Kling3p0StandardTextToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +impl FalRequestCostCalculator for Kling3p0StandardTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 3.0 Standard pricing: + // Audio off: $0.168/second + // Audio on: $0.252/second + let generate_audio = self.generate_audio.unwrap_or(true); + let duration_secs = self.duration + .unwrap_or(Kling3p0StandardTextToVideoDuration::FiveSeconds) + .to_seconds(); + + // Rate in tenths-of-cents per second, rounded up + let rate = if generate_audio { 252u64 } else { 168u64 }; + (rate * duration_secs + 9) / 10 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::kling_3p0_standard_text_to_video::api::{ + Kling3p0StandardTextToVideoAspectRatio, Kling3p0StandardTextToVideoDuration, + }; + + fn make_request( + generate_audio: Option, + duration: Option, + ) -> Kling3p0StandardTextToVideoRequest { + Kling3p0StandardTextToVideoRequest { + prompt: "test".to_string(), + generate_audio, + negative_prompt: None, + duration, + aspect_ratio: Some(Kling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + } + } + + mod audio_off { + use super::*; + + // Audio off: $0.168/sec → rate = 168 tenths-of-cents/sec + + #[test] + fn three_seconds() { + // (168 * 3 + 9) / 10 = 51 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardTextToVideoDuration::ThreeSeconds)).calculate_cost_in_cents(), 51); + } + + #[test] + fn five_seconds() { + // (168 * 5 + 9) / 10 = 84 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardTextToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 84); + } + + #[test] + fn ten_seconds() { + // (168 * 10 + 9) / 10 = 168 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardTextToVideoDuration::TenSeconds)).calculate_cost_in_cents(), 168); + } + + #[test] + fn fifteen_seconds() { + // (168 * 15 + 9) / 10 = 252 + assert_eq!(make_request(Some(false), Some(Kling3p0StandardTextToVideoDuration::FifteenSeconds)).calculate_cost_in_cents(), 252); + } + } + + mod audio_on { + use super::*; + + // Audio on: $0.252/sec → rate = 252 tenths-of-cents/sec + + #[test] + fn five_seconds() { + // (252 * 5 + 9) / 10 = 126 + assert_eq!(make_request(Some(true), Some(Kling3p0StandardTextToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 126); + } + + #[test] + fn ten_seconds() { + // (252 * 10 + 9) / 10 = 252 + assert_eq!(make_request(Some(true), Some(Kling3p0StandardTextToVideoDuration::TenSeconds)).calculate_cost_in_cents(), 252); + } + + #[test] + fn fifteen_seconds() { + // (252 * 15 + 9) / 10 = 378 + assert_eq!(make_request(Some(true), Some(Kling3p0StandardTextToVideoDuration::FifteenSeconds)).calculate_cost_in_cents(), 378); + } + } + + mod defaults { + use super::*; + + #[test] + fn default_audio_is_on() { + // generate_audio=None defaults to true (audio on) + // duration=5s default: (252 * 5 + 9) / 10 = 126 + assert_eq!(make_request(None, Some(Kling3p0StandardTextToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 126); + } + + #[test] + fn default_duration_is_five_seconds() { + // duration=None defaults to 5s + // audio off: (168 * 5 + 9) / 10 = 84 + assert_eq!(make_request(Some(false), None).calculate_cost_in_cents(), 84); + } + + #[test] + fn both_defaults() { + // audio on + 5s: (252 * 5 + 9) / 10 = 126 + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 126); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/raw_request.rs new file mode 100644 index 00000000..c4cc5e1c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/kling_3p0_standard_text_to_video/raw_request.rs @@ -0,0 +1,44 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling3p0StandardTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Whether to generate audio alongside the video. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds (as a string). + /// Options: "3" through "15" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Shot type for multi-shot video generation. + /// Possible values: "customize", "intelligent" + #[serde(skip_serializing_if = "Option::is_none")] + pub shot_type: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardTextToVideoOutput { + pub video: Kling3p0StandardTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/mod.rs new file mode 100644 index 00000000..a69e090f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/mod.rs @@ -0,0 +1,12 @@ +pub mod kling_1p6_pro_text_to_video; +pub mod kling_2p5_turbo_pro_text_to_video; +pub mod kling_2p6_pro_text_to_video; +pub mod kling_3p0_standard_text_to_video; +pub mod veo_2; +pub mod veo_3; +pub mod veo_3_fast; +pub mod veo_3p1; +pub mod veo_3p1_fast; +pub mod veo_3p1_lite; +pub mod vidu_q3; +pub mod vidu_q3_turbo; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/api.rs new file mode 100644 index 00000000..aeed324e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/api.rs @@ -0,0 +1,221 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::veo_2::raw_request::{ + Veo2TextToVideoInput, Veo2TextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo2TextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `5s` when `None`. + pub duration: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to enhance the prompt before generation. fal's default is `true` + /// when `None`. + pub enhance_prompt: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `true` when `None`. + pub auto_fix: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo2TextToVideoAspectRatio { + NineBySixteen, + SixteenByNine, + Square, +} + +impl Veo2TextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::NineBySixteen => "9:16", + Self::SixteenByNine => "16:9", + Self::Square => "1:1", + } + } +} + +/// Veo 2 supports 5–8 second durations (default 5s), unlike the Veo 3 family's +/// 4/6/8. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo2TextToVideoDuration { + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, +} + +impl Veo2TextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FiveSeconds => "5s", + Self::SixSeconds => "6s", + Self::SevenSeconds => "7s", + Self::EightSeconds => "8s", + } + } +} + +impl FalEndpoint for Veo2TextToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo2"; + + type RawRequest = Veo2TextToVideoInput; + type RawResponse = Veo2TextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + enhance_prompt: self.enhance_prompt, + seed: self.seed, + auto_fix: self.auto_fix, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo2TextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + aspect_ratio: Some(Veo2TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo2TextToVideoDuration::FiveSeconds), + negative_prompt: None, + enhance_prompt: None, + seed: None, + auto_fix: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo2TextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + aspect_ratio: Some(Veo2TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo2TextToVideoDuration::FiveSeconds), + negative_prompt: None, + enhance_prompt: None, + seed: None, + auto_fix: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo2TextToVideoRequest { + prompt: "p".to_string(), + aspect_ratio: Some(Veo2TextToVideoAspectRatio::Square), + duration: Some(Veo2TextToVideoDuration::EightSeconds), + negative_prompt: Some("blurry".to_string()), + enhance_prompt: Some(false), + seed: Some(42), + auto_fix: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("1:1")); + assert_eq!(raw.duration.as_deref(), Some("8s")); + assert_eq!(raw.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(raw.enhance_prompt, Some(false)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.auto_fix, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo2TextToVideoRequest { + prompt: "minimal".to_string(), + aspect_ratio: None, + duration: None, + negative_prompt: None, + enhance_prompt: None, + seed: None, + auto_fix: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo2TextToVideoAspectRatio::NineBySixteen, "9:16"), + (Veo2TextToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo2TextToVideoAspectRatio::Square, "1:1"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo2TextToVideoDuration::FiveSeconds, "5s", 5), + (Veo2TextToVideoDuration::SixSeconds, "6s", 6), + (Veo2TextToVideoDuration::SevenSeconds, "7s", 7), + (Veo2TextToVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo2TextToVideoRequest::ENDPOINT, "fal-ai/veo2"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/cost.rs new file mode 100644 index 00000000..a9681a2c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/cost.rs @@ -0,0 +1,110 @@ +use crate::requests::api::video::text::veo_2::api::{Veo2TextToVideoDuration, Veo2TextToVideoRequest}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Veo 2 pricing (see https://fal.ai/models/fal-ai/veo2): +// "For 5s video your request will cost $2.50. For every additional second +// you will be charged $0.50." +// +// This is a flat base + per-extra-second model (NOT the per-second-rate model +// the Veo 3 family uses), and it does not vary by audio, resolution, or aspect +// ratio. All amounts are exact whole cents. Shared by text + image modalities. +const BASE_COST_CENTS: UsdCents = 250; // 5s +const ADDITIONAL_SECOND_COST_CENTS: UsdCents = 50; +const BASE_DURATION_SECS: u64 = 5; + +/// Veo 2 cost in whole cents for a given duration in seconds. +/// `250 + (secs - 5) × 50`; durations below 5s (not reachable via the typed +/// enum) clamp to the base. +pub(crate) fn veo_2_cost_cents(duration_secs: u64) -> UsdCents { + let extra_secs = duration_secs.saturating_sub(BASE_DURATION_SECS); + BASE_COST_CENTS + extra_secs * ADDITIONAL_SECOND_COST_CENTS +} + +impl FalRequestCostCalculator for Veo2TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal default when unset: duration = 5s. + let duration_secs = self.duration + .unwrap_or(Veo2TextToVideoDuration::FiveSeconds) + .to_seconds(); + veo_2_cost_cents(duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::veo_2::api::Veo2TextToVideoAspectRatio; + + fn make_request(duration: Option) -> Veo2TextToVideoRequest { + Veo2TextToVideoRequest { + prompt: "test".to_string(), + aspect_ratio: Some(Veo2TextToVideoAspectRatio::SixteenByNine), + duration, + negative_prompt: None, + enhance_prompt: None, + seed: None, + auto_fix: None, + } + } + + /// fal: "For 5s video your request will cost $2.50" → 250¢. + #[test] + fn matches_documented_5s_example() { + assert_eq!(make_request(Some(Veo2TextToVideoDuration::FiveSeconds)).calculate_cost_in_cents(), 250); + } + + /// fal i2v example: a 6-second video costs $3.00 ($2.50 + $0.50) → 300¢. + #[test] + fn matches_documented_6s_example() { + assert_eq!(make_request(Some(Veo2TextToVideoDuration::SixSeconds)).calculate_cost_in_cents(), 300); + } + + mod cost_table { + use super::*; + + // (duration, expected_cents): 250 base + 50 per second over 5s. + const COST_TABLE: &[(Option, u64)] = &[ + (Some(Veo2TextToVideoDuration::FiveSeconds), 250), + (Some(Veo2TextToVideoDuration::SixSeconds), 300), + (Some(Veo2TextToVideoDuration::SevenSeconds), 350), + (Some(Veo2TextToVideoDuration::EightSeconds), 400), + // Default: duration=None → 5s + (None, 250), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, expected) in COST_TABLE { + assert_eq!( + make_request(duration).calculate_cost_in_cents(), + expected, + "duration={duration:?}", + ); + } + } + + #[test] + fn each_extra_second_adds_fifty_cents() { + let five = make_request(Some(Veo2TextToVideoDuration::FiveSeconds)).calculate_cost_in_cents(); + let six = make_request(Some(Veo2TextToVideoDuration::SixSeconds)).calculate_cost_in_cents(); + assert_eq!(six - five, 50); + } + + /// Aspect ratio, negative prompt, enhance_prompt, seed, and auto_fix must + /// not affect the bill. + #[test] + fn cost_ignores_non_billing_fields() { + let baseline = make_request(Some(Veo2TextToVideoDuration::EightSeconds)).calculate_cost_in_cents(); + let embellished = Veo2TextToVideoRequest { + prompt: "different".to_string(), + aspect_ratio: Some(Veo2TextToVideoAspectRatio::Square), + duration: Some(Veo2TextToVideoDuration::EightSeconds), + negative_prompt: Some("noise".to_string()), + enhance_prompt: Some(false), + seed: Some(99), + auto_fix: Some(false), + }.calculate_cost_in_cents(); + assert_eq!(baseline, embellished); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/raw_request.rs new file mode 100644 index 00000000..2e735f10 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_2/raw_request.rs @@ -0,0 +1,48 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo2` (text-to-video). +/// fal's schema: +/// +/// NB: Veo 2 has no `generate_audio`, `resolution`, or `safety_tolerance` +/// fields (unlike the Veo 3 family), and it *does* carry `enhance_prompt`. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo2TextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "9:16", "16:9", "1:1". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "5s", "6s", "7s", "8s". fal default: "5s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Whether to enhance the prompt before generation. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub enhance_prompt: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail content policy / + /// validation checks. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2TextToVideoOutput { + pub video: Veo2TextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/api.rs new file mode 100644 index 00000000..f4237e1e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/api.rs @@ -0,0 +1,262 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::veo_3::raw_request::{ + Veo3TextToVideoInput, Veo3TextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3TextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `true` for text-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3TextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3TextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3TextToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3TextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3 exposes only 720p/1080p (no 4k tier). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3TextToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3TextToVideoResolution { + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3TextToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3TextToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3TextToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3"; + + type RawRequest = Veo3TextToVideoInput; + type RawResponse = Veo3TextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3TextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + aspect_ratio: Some(Veo3TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3TextToVideoDuration::FourSeconds), + resolution: Some(Veo3TextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(true), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3TextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + aspect_ratio: Some(Veo3TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3TextToVideoDuration::FourSeconds), + resolution: Some(Veo3TextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3TextToVideoRequest { + prompt: "p".to_string(), + aspect_ratio: Some(Veo3TextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3TextToVideoDuration::EightSeconds), + resolution: Some(Veo3TextToVideoResolution::TenEightyP), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(true), + seed: Some(42), + auto_fix: Some(false), + safety_tolerance: Some(Veo3TextToVideoSafetyTolerance::Level6), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("8s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("6")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3TextToVideoRequest { + prompt: "minimal".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo3TextToVideoDuration::FourSeconds, "4s", 4), + (Veo3TextToVideoDuration::SixSeconds, "6s", 6), + (Veo3TextToVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo3TextToVideoRequest::ENDPOINT, "fal-ai/veo3"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/cost.rs new file mode 100644 index 00000000..6e40b3fa --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/cost.rs @@ -0,0 +1,140 @@ +use crate::requests::api::video::text::veo_3::api::{ + Veo3TextToVideoDuration, Veo3TextToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Veo 3 (non-fast) pricing (see https://fal.ai/models/fal-ai/veo3): +// $0.20/sec (audio off), $0.40/sec (audio on). Flat — Veo 3 has no 4k tier +// and resolution (720p/1080p) does not change the price. +// +// Rates are stored in tenths-of-a-cent per second, multiplied by duration and +// rounded UP to whole cents so the user is never undercharged. These helpers +// are the canonical Veo 3 rate table, reused by the image-to-video modality. +const RATE_AUDIO_OFF: u64 = 200; // $0.20/sec +const RATE_AUDIO_ON: u64 = 400; // $0.40/sec + +/// Per-second rate in tenths-of-a-cent for the Veo 3 (non-fast) family. +pub(crate) fn veo_3_rate_tenth_cents_per_sec(audio_on: bool) -> u64 { + if audio_on { RATE_AUDIO_ON } else { RATE_AUDIO_OFF } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn veo_3_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for Veo3TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, audio = on. Resolution does not + // affect price. + let duration_secs = self.duration + .unwrap_or(Veo3TextToVideoDuration::EightSeconds) + .to_seconds(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3_rate_tenth_cents_per_sec(audio_on); + veo_3_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::veo_3::api::{ + Veo3TextToVideoAspectRatio, Veo3TextToVideoResolution, Veo3TextToVideoSafetyTolerance, + }; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Veo3TextToVideoRequest { + Veo3TextToVideoRequest { + prompt: "test".to_string(), + aspect_ratio: Some(Veo3TextToVideoAspectRatio::SixteenByNine), + duration, + resolution: None, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + /// fal: "a 5s video with audio on will cost $2" → 5s × $0.40 = 200¢. + #[test] + fn matches_documented_5s_audio_on_example() { + let rate = veo_3_rate_tenth_cents_per_sec(true); + assert_eq!(veo_3_cost_cents(rate, 5), 200); + } + + mod cost_table { + use super::*; + + // (duration, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + (Some(Veo3TextToVideoDuration::FourSeconds), Some(false), 80), + (Some(Veo3TextToVideoDuration::FourSeconds), Some(true), 160), + (Some(Veo3TextToVideoDuration::SixSeconds), Some(true), 240), + (Some(Veo3TextToVideoDuration::EightSeconds), Some(false), 160), + (Some(Veo3TextToVideoDuration::EightSeconds), Some(true), 320), + // Defaults: duration=None→8s, audio=None→on + (None, None, 320), + (None, Some(false), 160), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, generate_audio).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} audio={generate_audio:?}"); + } + } + + #[test] + fn audio_on_costs_twice_as_much_as_off() { + for d in [Veo3TextToVideoDuration::FourSeconds, Veo3TextToVideoDuration::EightSeconds] { + let off = make_request(Some(d), Some(false)).calculate_cost_in_cents(); + let on = make_request(Some(d), Some(true)).calculate_cost_in_cents(); + assert_eq!(on, off * 2, "duration={d:?}"); + } + } + + /// Resolution (720p vs 1080p) must not change the bill for Veo 3. + #[test] + fn cost_is_independent_of_resolution() { + for audio in [Some(false), Some(true), None] { + let base = make_request(Some(Veo3TextToVideoDuration::EightSeconds), audio).calculate_cost_in_cents(); + for res in [Veo3TextToVideoResolution::SevenTwentyP, Veo3TextToVideoResolution::TenEightyP] { + let cost = Veo3TextToVideoRequest { + resolution: Some(res), + ..make_request(Some(Veo3TextToVideoDuration::EightSeconds), audio) + }.calculate_cost_in_cents(); + assert_eq!(cost, base, "audio={audio:?} res={res:?}"); + } + } + } + + /// Neither aspect ratio, seed, auto_fix, nor safety tolerance affect the bill. + #[test] + fn cost_ignores_non_billing_fields() { + let baseline = make_request(Some(Veo3TextToVideoDuration::EightSeconds), Some(true)).calculate_cost_in_cents(); + let embellished = Veo3TextToVideoRequest { + prompt: "different".to_string(), + aspect_ratio: Some(Veo3TextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3TextToVideoDuration::EightSeconds), + resolution: Some(Veo3TextToVideoResolution::TenEightyP), + negative_prompt: Some("noise".to_string()), + generate_audio: Some(true), + seed: Some(99), + auto_fix: Some(false), + safety_tolerance: Some(Veo3TextToVideoSafetyTolerance::Level1), + }.calculate_cost_in_cents(); + assert_eq!(baseline, embellished); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/raw_request.rs new file mode 100644 index 00000000..100773d2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3` (text-to-video). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3TextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail content policy / + /// validation checks. fal default: true (text-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance for content moderation, "1" (strictest) .. "6" + /// (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3TextToVideoOutput { + pub video: Veo3TextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/api.rs new file mode 100644 index 00000000..b4c54e8b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/api.rs @@ -0,0 +1,250 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::veo_3_fast::raw_request::{ + Veo3FastTextToVideoInput, Veo3FastTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3FastTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `true` for text-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastTextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3FastTextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastTextToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3FastTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3 Fast exposes only 720p/1080p (no 4k tier). +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastTextToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3FastTextToVideoResolution { + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3FastTextToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3FastTextToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3FastTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3/fast"; + + type RawRequest = Veo3FastTextToVideoInput; + type RawResponse = Veo3FastTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3FastTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + aspect_ratio: Some(Veo3FastTextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3FastTextToVideoDuration::FourSeconds), + resolution: Some(Veo3FastTextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(true), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3FastTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + aspect_ratio: Some(Veo3FastTextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3FastTextToVideoDuration::FourSeconds), + resolution: Some(Veo3FastTextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3FastTextToVideoRequest { + prompt: "p".to_string(), + aspect_ratio: Some(Veo3FastTextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3FastTextToVideoDuration::EightSeconds), + resolution: Some(Veo3FastTextToVideoResolution::TenEightyP), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(true), + seed: Some(42), + auto_fix: Some(false), + safety_tolerance: Some(Veo3FastTextToVideoSafetyTolerance::Level6), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("8s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("6")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3FastTextToVideoRequest { + prompt: "minimal".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo3FastTextToVideoRequest::ENDPOINT, "fal-ai/veo3/fast"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/cost.rs new file mode 100644 index 00000000..f52b7ed6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/cost.rs @@ -0,0 +1,129 @@ +use crate::requests::api::video::text::veo_3_fast::api::{ + Veo3FastTextToVideoDuration, Veo3FastTextToVideoRequest, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Veo 3 Fast pricing (see https://fal.ai/models/fal-ai/veo3/fast): +// $0.10/sec (audio off), $0.15/sec (audio on). Flat — Veo 3 Fast has no 4k +// tier and resolution (720p/1080p) does not change the price. +// +// Rates are stored in tenths-of-a-cent per second, multiplied by duration and +// rounded UP to whole cents so the user is never undercharged. These helpers +// are the canonical Veo 3 Fast rate table, reused by the image-to-video modality. +const RATE_AUDIO_OFF: u64 = 100; // $0.10/sec +const RATE_AUDIO_ON: u64 = 150; // $0.15/sec + +/// Per-second rate in tenths-of-a-cent for the Veo 3 Fast family. +pub(crate) fn veo_3_fast_rate_tenth_cents_per_sec(audio_on: bool) -> u64 { + if audio_on { RATE_AUDIO_ON } else { RATE_AUDIO_OFF } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn veo_3_fast_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for Veo3FastTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, audio = on. Resolution does not + // affect price. + let duration_secs = self.duration + .unwrap_or(Veo3FastTextToVideoDuration::EightSeconds) + .to_seconds(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3_fast_rate_tenth_cents_per_sec(audio_on); + veo_3_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::veo_3_fast::api::{ + Veo3FastTextToVideoAspectRatio, Veo3FastTextToVideoResolution, Veo3FastTextToVideoSafetyTolerance, + }; + + fn make_request( + duration: Option, + generate_audio: Option, + ) -> Veo3FastTextToVideoRequest { + Veo3FastTextToVideoRequest { + prompt: "test".to_string(), + aspect_ratio: Some(Veo3FastTextToVideoAspectRatio::SixteenByNine), + duration, + resolution: None, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + /// fal: "a 5s video with audio on will cost $0.75" → 5s × $0.15 = 75¢. + #[test] + fn matches_documented_5s_audio_on_example() { + let rate = veo_3_fast_rate_tenth_cents_per_sec(true); + assert_eq!(veo_3_fast_cost_cents(rate, 5), 75); + } + + mod cost_table { + use super::*; + + // (duration, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + u64, + )] = &[ + (Some(Veo3FastTextToVideoDuration::FourSeconds), Some(false), 40), + (Some(Veo3FastTextToVideoDuration::FourSeconds), Some(true), 60), + (Some(Veo3FastTextToVideoDuration::SixSeconds), Some(false), 60), + (Some(Veo3FastTextToVideoDuration::EightSeconds), Some(false), 80), + (Some(Veo3FastTextToVideoDuration::EightSeconds), Some(true), 120), + // Defaults: duration=None→8s, audio=None→on + (None, None, 120), + (None, Some(false), 80), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, generate_audio).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} audio={generate_audio:?}"); + } + } + + #[test] + fn cost_is_independent_of_resolution() { + for audio in [Some(false), Some(true), None] { + let base = make_request(Some(Veo3FastTextToVideoDuration::EightSeconds), audio).calculate_cost_in_cents(); + for res in [Veo3FastTextToVideoResolution::SevenTwentyP, Veo3FastTextToVideoResolution::TenEightyP] { + let cost = Veo3FastTextToVideoRequest { + resolution: Some(res), + ..make_request(Some(Veo3FastTextToVideoDuration::EightSeconds), audio) + }.calculate_cost_in_cents(); + assert_eq!(cost, base, "audio={audio:?} res={res:?}"); + } + } + } + + #[test] + fn cost_ignores_non_billing_fields() { + let baseline = make_request(Some(Veo3FastTextToVideoDuration::EightSeconds), Some(true)).calculate_cost_in_cents(); + let embellished = Veo3FastTextToVideoRequest { + prompt: "different".to_string(), + aspect_ratio: Some(Veo3FastTextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3FastTextToVideoDuration::EightSeconds), + resolution: Some(Veo3FastTextToVideoResolution::TenEightyP), + negative_prompt: Some("noise".to_string()), + generate_audio: Some(true), + seed: Some(99), + auto_fix: Some(false), + safety_tolerance: Some(Veo3FastTextToVideoSafetyTolerance::Level1), + }.calculate_cost_in_cents(); + assert_eq!(baseline, embellished); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/raw_request.rs new file mode 100644 index 00000000..c84ae781 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3_fast/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3/fast` (text-to-video). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3FastTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail content policy / + /// validation checks. fal default: true (text-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance for content moderation, "1" (strictest) .. "6" + /// (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3FastTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3FastTextToVideoOutput { + pub video: Veo3FastTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/api.rs new file mode 100644 index 00000000..460260b4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/api.rs @@ -0,0 +1,290 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::veo_3p1::raw_request::{ + Veo3p1TextToVideoInput, Veo3p1TextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1TextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `true` for text-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1TextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1TextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1TextToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1TextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1TextToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1TextToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1TextToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1TextToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1TextToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1"; + + type RawRequest = Veo3p1TextToVideoInput; + type RawResponse = Veo3p1TextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1TextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + aspect_ratio: Some(Veo3p1TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1TextToVideoDuration::FourSeconds), + resolution: Some(Veo3p1TextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(true), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1TextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + aspect_ratio: Some(Veo3p1TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1TextToVideoDuration::FourSeconds), + resolution: Some(Veo3p1TextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1TextToVideoRequest { + prompt: "p".to_string(), + aspect_ratio: Some(Veo3p1TextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1TextToVideoDuration::EightSeconds), + resolution: Some(Veo3p1TextToVideoResolution::FourK), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(true), + seed: Some(42), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1TextToVideoSafetyTolerance::Level6), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("8s")); + assert_eq!(raw.resolution.as_deref(), Some("4k")); + assert_eq!(raw.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("6")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1TextToVideoRequest { + prompt: "minimal".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3p1TextToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3p1TextToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo3p1TextToVideoDuration::FourSeconds, "4s", 4), + (Veo3p1TextToVideoDuration::SixSeconds, "6s", 6), + (Veo3p1TextToVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn every_resolution_maps_to_wire_string() { + for (variant, expected, four_k) in [ + (Veo3p1TextToVideoResolution::SevenTwentyP, "720p", false), + (Veo3p1TextToVideoResolution::TenEightyP, "1080p", false), + (Veo3p1TextToVideoResolution::FourK, "4k", true), + ] { + assert_eq!(variant.to_str(), expected); + assert_eq!(variant.is_four_k(), four_k); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo3p1TextToVideoRequest::ENDPOINT, "fal-ai/veo3.1"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/cost.rs new file mode 100644 index 00000000..7704e46a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/cost.rs @@ -0,0 +1,187 @@ +use crate::requests::api::video::text::veo_3p1::api::{ + Veo3p1TextToVideoDuration, Veo3p1TextToVideoRequest, Veo3p1TextToVideoResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Veo 3.1 (non-fast) pricing (see https://fal.ai/models/fal-ai/veo3.1): +// 720p / 1080p: $0.20/sec (audio off), $0.40/sec (audio on) +// 4k: $0.40/sec (audio off), $0.60/sec (audio on) +// +// Rates are stored in tenths-of-a-cent per second, multiplied by duration and +// rounded UP to whole cents so the user is never undercharged. These helpers +// are the canonical Veo 3.1 rate table, reused by the image/images/reference/ +// extend modalities. +const RATE_SD_AUDIO_OFF: u64 = 200; // $0.20/sec +const RATE_SD_AUDIO_ON: u64 = 400; // $0.40/sec +const RATE_4K_AUDIO_OFF: u64 = 400; // $0.40/sec +const RATE_4K_AUDIO_ON: u64 = 600; // $0.60/sec + +/// Per-second rate in tenths-of-a-cent for the Veo 3.1 (non-fast) family. +/// `four_k` selects the higher 4k tier; `audio_on` selects the audio surcharge. +pub(crate) fn veo_3p1_rate_tenth_cents_per_sec(four_k: bool, audio_on: bool) -> u64 { + match (four_k, audio_on) { + (false, false) => RATE_SD_AUDIO_OFF, + (false, true) => RATE_SD_AUDIO_ON, + (true, false) => RATE_4K_AUDIO_OFF, + (true, true) => RATE_4K_AUDIO_ON, + } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn veo_3p1_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for Veo3p1TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1TextToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1TextToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::veo_3p1::api::{ + Veo3p1TextToVideoAspectRatio, Veo3p1TextToVideoSafetyTolerance, + }; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1TextToVideoRequest { + Veo3p1TextToVideoRequest { + prompt: "test".to_string(), + aspect_ratio: Some(Veo3p1TextToVideoAspectRatio::SixteenByNine), + duration, + resolution, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + /// fal: "a 5 second video at 1080p with audio on will cost $2.00". + /// The enum has no 5s variant, but the same $0.40/sec (1080p audio-on) rate + /// must reproduce it: 5s × 400 tenth-cents / 10 = 200¢. + #[test] + fn matches_documented_5s_1080p_audio_on_example() { + let rate = veo_3p1_rate_tenth_cents_per_sec(false, true); + assert_eq!(veo_3p1_cost_cents(rate, 5), 200); + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + // 720p, audio off ($0.20/s) + (Some(Veo3p1TextToVideoDuration::FourSeconds), Some(Veo3p1TextToVideoResolution::SevenTwentyP), Some(false), 80), + (Some(Veo3p1TextToVideoDuration::SixSeconds), Some(Veo3p1TextToVideoResolution::SevenTwentyP), Some(false), 120), + (Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::SevenTwentyP), Some(false), 160), + // 720p, audio on ($0.40/s) + (Some(Veo3p1TextToVideoDuration::FourSeconds), Some(Veo3p1TextToVideoResolution::SevenTwentyP), Some(true), 160), + (Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::SevenTwentyP), Some(true), 320), + // 1080p bills the same as 720p + (Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::TenEightyP), Some(false), 160), + (Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::TenEightyP), Some(true), 320), + // 4k, audio off ($0.40/s) and on ($0.60/s) + (Some(Veo3p1TextToVideoDuration::FourSeconds), Some(Veo3p1TextToVideoResolution::FourK), Some(false), 160), + (Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::FourK), Some(false), 320), + (Some(Veo3p1TextToVideoDuration::FourSeconds), Some(Veo3p1TextToVideoResolution::FourK), Some(true), 240), + (Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::FourK), Some(true), 480), + // Defaults: duration=None→8s, resolution=None→720p, audio=None→on + (None, None, None, 320), + (None, None, Some(false), 160), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + #[test] + fn audio_on_is_more_expensive_than_off() { + for res in [ + Veo3p1TextToVideoResolution::SevenTwentyP, + Veo3p1TextToVideoResolution::TenEightyP, + Veo3p1TextToVideoResolution::FourK, + ] { + let off = make_request(Some(Veo3p1TextToVideoDuration::EightSeconds), Some(res), Some(false)) + .calculate_cost_in_cents(); + let on = make_request(Some(Veo3p1TextToVideoDuration::EightSeconds), Some(res), Some(true)) + .calculate_cost_in_cents(); + assert!(on > off, "resolution={res:?}: audio_on={on}¢ should exceed audio_off={off}¢"); + } + } + + #[test] + fn four_k_is_more_expensive_than_sd() { + for audio in [Some(false), Some(true)] { + let sd = make_request(Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::TenEightyP), audio) + .calculate_cost_in_cents(); + let four_k = make_request(Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::FourK), audio) + .calculate_cost_in_cents(); + assert!(four_k > sd, "audio={audio:?}: 4k={four_k}¢ should exceed 1080p={sd}¢"); + } + } + + #[test] + fn seven_twenty_and_ten_eighty_cost_the_same() { + for audio in [Some(false), Some(true), None] { + let sd = make_request(Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::SevenTwentyP), audio) + .calculate_cost_in_cents(); + let hd = make_request(Some(Veo3p1TextToVideoDuration::EightSeconds), Some(Veo3p1TextToVideoResolution::TenEightyP), audio) + .calculate_cost_in_cents(); + assert_eq!(sd, hd, "audio={audio:?}: 720p and 1080p should bill the same"); + } + } + + /// Neither aspect ratio, seed, auto_fix, nor safety tolerance affect the bill. + #[test] + fn cost_ignores_non_billing_fields() { + let baseline = make_request( + Some(Veo3p1TextToVideoDuration::EightSeconds), + Some(Veo3p1TextToVideoResolution::TenEightyP), + Some(true), + ).calculate_cost_in_cents(); + + let embellished = Veo3p1TextToVideoRequest { + prompt: "different prompt".to_string(), + aspect_ratio: Some(Veo3p1TextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1TextToVideoDuration::EightSeconds), + resolution: Some(Veo3p1TextToVideoResolution::TenEightyP), + negative_prompt: Some("noise".to_string()), + generate_audio: Some(true), + seed: Some(99), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1TextToVideoSafetyTolerance::Level1), + }.calculate_cost_in_cents(); + + assert_eq!(baseline, embellished); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/raw_request.rs new file mode 100644 index 00000000..b9198dda --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1` (text-to-video). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1TextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail content policy / + /// validation checks. fal default: true (text-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance for content moderation, "1" (strictest) .. "6" + /// (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1TextToVideoOutput { + pub video: Veo3p1TextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/api.rs new file mode 100644 index 00000000..8ad17d4a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/api.rs @@ -0,0 +1,291 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::veo_3p1_fast::raw_request::{ + Veo3p1FastTextToVideoInput, Veo3p1FastTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1FastTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `true` for text-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastTextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1FastTextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastTextToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1FastTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastTextToVideoResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +impl Veo3p1FastTextToVideoResolution { + /// 4k output is billed at a higher per-second rate than 720p/1080p. + pub fn is_four_k(&self) -> bool { + matches!(self, Self::FourK) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + Self::FourK => "4k", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1FastTextToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1FastTextToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1FastTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/fast"; + + type RawRequest = Veo3p1FastTextToVideoInput; + type RawResponse = Veo3p1FastTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + aspect_ratio: Some(Veo3p1FastTextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastTextToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(true), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1FastTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + aspect_ratio: Some(Veo3p1FastTextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1FastTextToVideoDuration::FourSeconds), + resolution: Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1FastTextToVideoRequest { + prompt: "p".to_string(), + aspect_ratio: Some(Veo3p1FastTextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1FastTextToVideoDuration::EightSeconds), + resolution: Some(Veo3p1FastTextToVideoResolution::FourK), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(true), + seed: Some(42), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1FastTextToVideoSafetyTolerance::Level6), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("8s")); + assert_eq!(raw.resolution.as_deref(), Some("4k")); + assert_eq!(raw.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("6")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1FastTextToVideoRequest { + prompt: "minimal".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + // Minimal payload must be literally `{"prompt": "minimal"}`. + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (Veo3p1FastTextToVideoAspectRatio::SixteenByNine, "16:9"), + (Veo3p1FastTextToVideoAspectRatio::NineBySixteen, "9:16"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo3p1FastTextToVideoDuration::FourSeconds, "4s", 4), + (Veo3p1FastTextToVideoDuration::SixSeconds, "6s", 6), + (Veo3p1FastTextToVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn every_resolution_maps_to_wire_string() { + for (variant, expected, four_k) in [ + (Veo3p1FastTextToVideoResolution::SevenTwentyP, "720p", false), + (Veo3p1FastTextToVideoResolution::TenEightyP, "1080p", false), + (Veo3p1FastTextToVideoResolution::FourK, "4k", true), + ] { + assert_eq!(variant.to_str(), expected); + assert_eq!(variant.is_four_k(), four_k); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo3p1FastTextToVideoRequest::ENDPOINT, "fal-ai/veo3.1/fast"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..417e2714 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/cost.rs @@ -0,0 +1,195 @@ +use crate::requests::api::video::text::veo_3p1_fast::api::{ + Veo3p1FastTextToVideoDuration, Veo3p1FastTextToVideoRequest, Veo3p1FastTextToVideoResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Veo 3.1 Fast pricing (see https://fal.ai/models/fal-ai/veo3.1/fast): +// 720p / 1080p: $0.10/sec (audio off), $0.15/sec (audio on) +// 4k: $0.30/sec (audio off), $0.35/sec (audio on) +// +// Rates are stored in tenths-of-a-cent per second so the per-second price is +// exact, then multiplied by duration and rounded UP to whole cents so the +// user is never undercharged. +const RATE_SD_AUDIO_OFF: u64 = 100; // $0.10/sec +const RATE_SD_AUDIO_ON: u64 = 150; // $0.15/sec +const RATE_4K_AUDIO_OFF: u64 = 300; // $0.30/sec +const RATE_4K_AUDIO_ON: u64 = 350; // $0.35/sec + +/// Per-second rate in tenths-of-a-cent for the Veo 3.1 Fast family. +/// `four_k` selects the higher 4k tier; `audio_on` selects the audio surcharge. +pub(crate) fn veo_3p1_fast_rate_tenth_cents_per_sec(four_k: bool, audio_on: bool) -> u64 { + match (four_k, audio_on) { + (false, false) => RATE_SD_AUDIO_OFF, + (false, true) => RATE_SD_AUDIO_ON, + (true, false) => RATE_4K_AUDIO_OFF, + (true, true) => RATE_4K_AUDIO_ON, + } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn veo_3p1_fast_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for Veo3p1FastTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1FastTextToVideoDuration::EightSeconds) + .to_seconds(); + let four_k = self.resolution + .unwrap_or(Veo3p1FastTextToVideoResolution::SevenTwentyP) + .is_four_k(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_fast_rate_tenth_cents_per_sec(four_k, audio_on); + veo_3p1_fast_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::veo_3p1_fast::api::{ + Veo3p1FastTextToVideoAspectRatio, Veo3p1FastTextToVideoSafetyTolerance, + }; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1FastTextToVideoRequest { + Veo3p1FastTextToVideoRequest { + prompt: "test".to_string(), + aspect_ratio: Some(Veo3p1FastTextToVideoAspectRatio::SixteenByNine), + duration, + resolution, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + // ── Documented example ── + + /// fal: "a 5 second video at 1080p with audio on will cost $0.75". + /// The enum has no 5s variant, but the same $0.15/sec (1080p audio-on) rate + /// must reproduce it: 5s × 150 tenth-cents / 10 = 75¢. + #[test] + fn matches_documented_5s_1080p_audio_on_example() { + let rate = veo_3p1_fast_rate_tenth_cents_per_sec(false, true); + assert_eq!(veo_3p1_fast_cost_cents(rate, 5), 75); + } + + // ── Cost table over every cost-relevant permutation ── + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + // 720p, audio off ($0.10/s) + (Some(Veo3p1FastTextToVideoDuration::FourSeconds), Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), Some(false), 40), + (Some(Veo3p1FastTextToVideoDuration::SixSeconds), Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), Some(false), 60), + (Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), Some(false), 80), + // 720p, audio on ($0.15/s) + (Some(Veo3p1FastTextToVideoDuration::FourSeconds), Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), Some(true), 60), + (Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), Some(true), 120), + // 1080p bills the same as 720p + (Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::TenEightyP), Some(false), 80), + (Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::TenEightyP), Some(true), 120), + // 4k, audio off ($0.30/s) and on ($0.35/s) + (Some(Veo3p1FastTextToVideoDuration::FourSeconds), Some(Veo3p1FastTextToVideoResolution::FourK), Some(false), 120), + (Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::FourK), Some(false), 240), + (Some(Veo3p1FastTextToVideoDuration::FourSeconds), Some(Veo3p1FastTextToVideoResolution::FourK), Some(true), 140), + (Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::FourK), Some(true), 280), + // Defaults: duration=None→8s, resolution=None→720p, audio=None→on + (None, None, None, 120), + (None, None, Some(false), 80), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + #[test] + fn defaults_match_8s_720p_audio_on() { + assert_eq!(make_request(None, None, None).calculate_cost_in_cents(), 120); + } + + #[test] + fn audio_on_is_more_expensive_than_off() { + for res in [ + Veo3p1FastTextToVideoResolution::SevenTwentyP, + Veo3p1FastTextToVideoResolution::TenEightyP, + Veo3p1FastTextToVideoResolution::FourK, + ] { + let off = make_request(Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(res), Some(false)) + .calculate_cost_in_cents(); + let on = make_request(Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(res), Some(true)) + .calculate_cost_in_cents(); + assert!(on > off, "resolution={res:?}: audio_on={on}¢ should exceed audio_off={off}¢"); + } + } + + #[test] + fn four_k_is_more_expensive_than_sd() { + for audio in [Some(false), Some(true)] { + let sd = make_request(Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::TenEightyP), audio) + .calculate_cost_in_cents(); + let four_k = make_request(Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::FourK), audio) + .calculate_cost_in_cents(); + assert!(four_k > sd, "audio={audio:?}: 4k={four_k}¢ should exceed 1080p={sd}¢"); + } + } + + #[test] + fn seven_twenty_and_ten_eighty_cost_the_same() { + for audio in [Some(false), Some(true), None] { + let sd = make_request(Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::SevenTwentyP), audio) + .calculate_cost_in_cents(); + let hd = make_request(Some(Veo3p1FastTextToVideoDuration::EightSeconds), Some(Veo3p1FastTextToVideoResolution::TenEightyP), audio) + .calculate_cost_in_cents(); + assert_eq!(sd, hd, "audio={audio:?}: 720p and 1080p should bill the same"); + } + } + + /// Neither aspect ratio, seed, auto_fix, nor safety tolerance affect the bill. + #[test] + fn cost_ignores_non_billing_fields() { + let baseline = make_request( + Some(Veo3p1FastTextToVideoDuration::EightSeconds), + Some(Veo3p1FastTextToVideoResolution::TenEightyP), + Some(true), + ).calculate_cost_in_cents(); + + let embellished = Veo3p1FastTextToVideoRequest { + prompt: "different prompt".to_string(), + aspect_ratio: Some(Veo3p1FastTextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1FastTextToVideoDuration::EightSeconds), + resolution: Some(Veo3p1FastTextToVideoResolution::TenEightyP), + negative_prompt: Some("noise".to_string()), + generate_audio: Some(true), + seed: Some(99), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1FastTextToVideoSafetyTolerance::Level1), + }.calculate_cost_in_cents(); + + assert_eq!(baseline, embellished); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/raw_request.rs new file mode 100644 index 00000000..0cea3fd3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_fast/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/fast` (text-to-video). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p", "4k". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail content policy / + /// validation checks. fal default: true (text-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance for content moderation, "1" (strictest) .. "6" + /// (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastTextToVideoOutput { + pub video: Veo3p1FastTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/api.rs new file mode 100644 index 00000000..f8009cc4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/api.rs @@ -0,0 +1,280 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::veo_3p1_lite::raw_request::{ + Veo3p1LiteTextToVideoInput, Veo3p1LiteTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct Veo3p1LiteTextToVideoRequest { + /// Text prompt describing the video to generate. + pub prompt: String, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Video duration. fal's default is `8s` when `None`. + pub duration: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Optional negative prompt. + pub negative_prompt: Option, + + /// Whether to generate native audio. fal's server default is `true` when + /// this is `None`. + pub generate_audio: Option, + + /// Seed for the random number generator. + pub seed: Option, + + /// Whether to auto-rewrite prompts that fail moderation. fal's default is + /// `true` for text-to-video when `None`. + pub auto_fix: Option, + + /// Safety tolerance. fal's default is `4` when `None`. + pub safety_tolerance: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteTextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, +} + +impl Veo3p1LiteTextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteTextToVideoDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +impl Veo3p1LiteTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::FourSeconds => 4, + Self::SixSeconds => 6, + Self::EightSeconds => 8, + } + } + + fn to_str(&self) -> &'static str { + match self { + Self::FourSeconds => "4s", + Self::SixSeconds => "6s", + Self::EightSeconds => "8s", + } + } +} + +/// Veo 3.1 Lite exposes only 720p/1080p (no 4k tier). Both resolution AND +/// audio affect the per-second price, so `is_ten_eighty_p()` feeds the cost +/// calculator. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteTextToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl Veo3p1LiteTextToVideoResolution { + /// 1080p is billed at a higher per-second rate than 720p. + pub fn is_ten_eighty_p(&self) -> bool { + matches!(self, Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Veo3p1LiteTextToVideoSafetyTolerance { + /// "1" — strictest. + Level1, + Level2, + Level3, + /// "4" — fal default. + Level4, + Level5, + /// "6" — least strict. + Level6, +} + +impl Veo3p1LiteTextToVideoSafetyTolerance { + fn to_str(&self) -> &'static str { + match self { + Self::Level1 => "1", + Self::Level2 => "2", + Self::Level3 => "3", + Self::Level4 => "4", + Self::Level5 => "5", + Self::Level6 => "6", + } + } +} + +impl FalEndpoint for Veo3p1LiteTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/veo3.1/lite"; + + type RawRequest = Veo3p1LiteTextToVideoInput; + type RawResponse = Veo3p1LiteTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + duration: self.duration.map(|d| d.to_str().to_string()), + negative_prompt: self.negative_prompt.clone(), + resolution: self.resolution.map(|r| r.to_str().to_string()), + generate_audio: self.generate_audio, + seed: self.seed, + auto_fix: self.auto_fix, + safety_tolerance: self.safety_tolerance.map(|s| s.to_str().to_string()), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1LiteTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + aspect_ratio: Some(Veo3p1LiteTextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1LiteTextToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(true), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = Veo3p1LiteTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + aspect_ratio: Some(Veo3p1LiteTextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo3p1LiteTextToVideoDuration::FourSeconds), + resolution: Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(false), + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = Veo3p1LiteTextToVideoRequest { + prompt: "p".to_string(), + aspect_ratio: Some(Veo3p1LiteTextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1LiteTextToVideoDuration::EightSeconds), + resolution: Some(Veo3p1LiteTextToVideoResolution::TenEightyP), + negative_prompt: Some("blurry".to_string()), + generate_audio: Some(true), + seed: Some(42), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1LiteTextToVideoSafetyTolerance::Level6), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.aspect_ratio.as_deref(), Some("9:16")); + assert_eq!(raw.duration.as_deref(), Some("8s")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(raw.generate_audio, Some(true)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.auto_fix, Some(false)); + assert_eq!(raw.safety_tolerance.as_deref(), Some("6")); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = Veo3p1LiteTextToVideoRequest { + prompt: "minimal".to_string(), + aspect_ratio: None, + duration: None, + resolution: None, + negative_prompt: None, + generate_audio: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn every_duration_maps_to_wire_string_and_seconds() { + for (variant, s, secs) in [ + (Veo3p1LiteTextToVideoDuration::FourSeconds, "4s", 4), + (Veo3p1LiteTextToVideoDuration::SixSeconds, "6s", 6), + (Veo3p1LiteTextToVideoDuration::EightSeconds, "8s", 8), + ] { + assert_eq!(variant.to_str(), s); + assert_eq!(variant.to_seconds(), secs); + } + } + + #[test] + fn every_resolution_maps_to_wire_string() { + for (variant, expected, hd) in [ + (Veo3p1LiteTextToVideoResolution::SevenTwentyP, "720p", false), + (Veo3p1LiteTextToVideoResolution::TenEightyP, "1080p", true), + ] { + assert_eq!(variant.to_str(), expected); + assert_eq!(variant.is_ten_eighty_p(), hd); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(Veo3p1LiteTextToVideoRequest::ENDPOINT, "fal-ai/veo3.1/lite"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/cost.rs new file mode 100644 index 00000000..f45cec90 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/cost.rs @@ -0,0 +1,169 @@ +use crate::requests::api::video::text::veo_3p1_lite::api::{ + Veo3p1LiteTextToVideoDuration, Veo3p1LiteTextToVideoRequest, Veo3p1LiteTextToVideoResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Veo 3.1 Lite pricing (see https://fal.ai/models/fal-ai/veo3.1/lite): +// 720p: $0.03/sec (audio off), $0.05/sec (audio on) +// 1080p: $0.05/sec (audio off), $0.08/sec (audio on) +// +// Unlike the other Veo models, BOTH resolution and audio move the per-second +// price (and there is no 4k tier). Rates are stored in tenths-of-a-cent per +// second, multiplied by duration and rounded UP to whole cents so the user is +// never undercharged. These helpers are the canonical Veo 3.1 Lite rate table, +// reused by the image/images modalities. +const RATE_720P_AUDIO_OFF: u64 = 30; // $0.03/sec +const RATE_720P_AUDIO_ON: u64 = 50; // $0.05/sec +const RATE_1080P_AUDIO_OFF: u64 = 50; // $0.05/sec +const RATE_1080P_AUDIO_ON: u64 = 80; // $0.08/sec + +/// Per-second rate in tenths-of-a-cent for Veo 3.1 Lite. +/// `is_1080p` selects the 1080p tier; `audio_on` selects the audio surcharge. +pub(crate) fn veo_3p1_lite_rate_tenth_cents_per_sec(is_1080p: bool, audio_on: bool) -> u64 { + match (is_1080p, audio_on) { + (false, false) => RATE_720P_AUDIO_OFF, + (false, true) => RATE_720P_AUDIO_ON, + (true, false) => RATE_1080P_AUDIO_OFF, + (true, true) => RATE_1080P_AUDIO_ON, + } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn veo_3p1_lite_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for Veo3p1LiteTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 8s, resolution = 720p, audio = on. + let duration_secs = self.duration + .unwrap_or(Veo3p1LiteTextToVideoDuration::EightSeconds) + .to_seconds(); + let is_1080p = self.resolution + .unwrap_or(Veo3p1LiteTextToVideoResolution::SevenTwentyP) + .is_ten_eighty_p(); + let audio_on = self.generate_audio.unwrap_or(true); + + let rate = veo_3p1_lite_rate_tenth_cents_per_sec(is_1080p, audio_on); + veo_3p1_lite_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::veo_3p1_lite::api::{ + Veo3p1LiteTextToVideoAspectRatio, Veo3p1LiteTextToVideoSafetyTolerance, + }; + + fn make_request( + duration: Option, + resolution: Option, + generate_audio: Option, + ) -> Veo3p1LiteTextToVideoRequest { + Veo3p1LiteTextToVideoRequest { + prompt: "test".to_string(), + aspect_ratio: Some(Veo3p1LiteTextToVideoAspectRatio::SixteenByNine), + duration, + resolution, + negative_prompt: None, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + } + } + + /// fal: "a 4 second video at 720p with audio will cost $0.20". + #[test] + fn matches_documented_4s_720p_audio_on_example() { + let cost = make_request( + Some(Veo3p1LiteTextToVideoDuration::FourSeconds), + Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), + Some(true), + ).calculate_cost_in_cents(); + assert_eq!(cost, 20); + } + + mod cost_table { + use super::*; + + // (duration, resolution, generate_audio, expected_cents) + // Math: ceil(rate × secs / 10) where rate (tenth-cents) is + // 720p: 30 off / 50 on; 1080p: 50 off / 80 on. + const COST_TABLE: &[( + Option, + Option, + Option, + u64, + )] = &[ + // 720p audio off ($0.03/s) + (Some(Veo3p1LiteTextToVideoDuration::FourSeconds), Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), Some(false), 12), + (Some(Veo3p1LiteTextToVideoDuration::SixSeconds), Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), Some(false), 18), + (Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), Some(false), 24), + // 720p audio on ($0.05/s) + (Some(Veo3p1LiteTextToVideoDuration::FourSeconds), Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), Some(true), 20), + (Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), Some(true), 40), + // 1080p audio off ($0.05/s) + (Some(Veo3p1LiteTextToVideoDuration::FourSeconds), Some(Veo3p1LiteTextToVideoResolution::TenEightyP), Some(false), 20), + (Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(Veo3p1LiteTextToVideoResolution::TenEightyP), Some(false), 40), + // 1080p audio on ($0.08/s) + (Some(Veo3p1LiteTextToVideoDuration::FourSeconds), Some(Veo3p1LiteTextToVideoResolution::TenEightyP), Some(true), 32), + (Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(Veo3p1LiteTextToVideoResolution::TenEightyP), Some(true), 64), + // Defaults: duration=None→8s, resolution=None→720p, audio=None→on + (None, None, None, 40), + (None, None, Some(false), 24), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, generate_audio, expected) in COST_TABLE { + let got = make_request(duration, resolution, generate_audio).calculate_cost_in_cents(); + assert_eq!( + got, expected, + "duration={duration:?} resolution={resolution:?} audio={generate_audio:?}", + ); + } + } + + #[test] + fn audio_on_is_more_expensive_than_off() { + for res in [Veo3p1LiteTextToVideoResolution::SevenTwentyP, Veo3p1LiteTextToVideoResolution::TenEightyP] { + let off = make_request(Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(res), Some(false)).calculate_cost_in_cents(); + let on = make_request(Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(res), Some(true)).calculate_cost_in_cents(); + assert!(on > off, "res={res:?}: on={on}¢ should exceed off={off}¢"); + } + } + + #[test] + fn ten_eighty_p_is_more_expensive_than_seven_twenty() { + for audio in [Some(false), Some(true)] { + let sd = make_request(Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP), audio).calculate_cost_in_cents(); + let hd = make_request(Some(Veo3p1LiteTextToVideoDuration::EightSeconds), Some(Veo3p1LiteTextToVideoResolution::TenEightyP), audio).calculate_cost_in_cents(); + assert!(hd > sd, "audio={audio:?}: 1080p={hd}¢ should exceed 720p={sd}¢"); + } + } + + /// Neither aspect ratio, seed, auto_fix, nor safety tolerance affect the bill. + #[test] + fn cost_ignores_non_billing_fields() { + let baseline = make_request( + Some(Veo3p1LiteTextToVideoDuration::EightSeconds), + Some(Veo3p1LiteTextToVideoResolution::TenEightyP), + Some(true), + ).calculate_cost_in_cents(); + let embellished = Veo3p1LiteTextToVideoRequest { + prompt: "different".to_string(), + aspect_ratio: Some(Veo3p1LiteTextToVideoAspectRatio::NineBySixteen), + duration: Some(Veo3p1LiteTextToVideoDuration::EightSeconds), + resolution: Some(Veo3p1LiteTextToVideoResolution::TenEightyP), + negative_prompt: Some("noise".to_string()), + generate_audio: Some(true), + seed: Some(99), + auto_fix: Some(false), + safety_tolerance: Some(Veo3p1LiteTextToVideoSafetyTolerance::Level1), + }.calculate_cost_in_cents(); + assert_eq!(baseline, embellished); + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/raw_request.rs new file mode 100644 index 00000000..6e259e52 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/veo_3p1_lite/raw_request.rs @@ -0,0 +1,55 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/veo3.1/lite` (text-to-video). +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1LiteTextToVideoInput { + pub prompt: String, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (as a string). + /// Possible values: "4s", "6s", "8s". fal default: "8s". + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Output resolution. + /// Possible values: "720p", "1080p" (no 4k tier). fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate native audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Seed for the random number generator. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to automatically rewrite prompts that fail content policy / + /// validation checks. fal default: true (text-to-video). + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Safety tolerance for content moderation, "1" (strictest) .. "6" + /// (least strict). fal default: "4". + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1LiteTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1LiteTextToVideoOutput { + pub video: Veo3p1LiteTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/api.rs new file mode 100644 index 00000000..1bcd3e5f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/api.rs @@ -0,0 +1,225 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::vidu_q3::raw_request::{ + ViduQ3TextToVideoInput, ViduQ3TextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct ViduQ3TextToVideoRequest { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// Duration in seconds. Valid range 1–16; fal's default is `5` when `None`. + pub duration: Option, + + /// Seed for reproducibility. Random when `None`. + pub seed: Option, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate audio. fal's server default is `true` when `None`. + pub audio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3TextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, + FourByThree, + ThreeByFour, + Square, +} + +impl ViduQ3TextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + Self::FourByThree => "4:3", + Self::ThreeByFour => "3:4", + Self::Square => "1:1", + } + } +} + +/// Vidu Q3 resolutions. 720p/1080p bill at 2.2× the 360p/540p per-second rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3TextToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +impl ViduQ3TextToVideoResolution { + /// 720p and 1080p are billed at the higher (2.2×) per-second rate. + pub fn is_high_res(&self) -> bool { + matches!(self, Self::SevenTwentyP | Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSixtyP => "360p", + Self::FiveFortyP => "540p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +impl FalEndpoint for ViduQ3TextToVideoRequest { + const ENDPOINT: &str = "fal-ai/vidu/q3/text-to-video"; + + type RawRequest = ViduQ3TextToVideoInput; + type RawResponse = ViduQ3TextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + duration: self.duration, + seed: self.seed, + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + audio: self.audio, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3TextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + duration: Some(5), + seed: None, + aspect_ratio: Some(ViduQ3TextToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3TextToVideoResolution::SevenTwentyP), + audio: Some(true), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3TextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + duration: Some(5), + seed: Some(1234), + aspect_ratio: Some(ViduQ3TextToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3TextToVideoResolution::ThreeSixtyP), + audio: Some(false), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = ViduQ3TextToVideoRequest { + prompt: "p".to_string(), + duration: Some(12), + seed: Some(42), + aspect_ratio: Some(ViduQ3TextToVideoAspectRatio::FourByThree), + resolution: Some(ViduQ3TextToVideoResolution::TenEightyP), + audio: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.duration, Some(12)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.aspect_ratio.as_deref(), Some("4:3")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.audio, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = ViduQ3TextToVideoRequest { + prompt: "minimal".to_string(), + duration: None, + seed: None, + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn seed_serializes_when_set() { + let request = ViduQ3TextToVideoRequest { + prompt: "p".to_string(), + duration: None, + seed: Some(777), + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("seed").and_then(|s| s.as_i64()), Some(777)); + } + + #[test] + fn every_aspect_ratio_maps_to_wire_string() { + for (variant, expected) in [ + (ViduQ3TextToVideoAspectRatio::SixteenByNine, "16:9"), + (ViduQ3TextToVideoAspectRatio::NineBySixteen, "9:16"), + (ViduQ3TextToVideoAspectRatio::FourByThree, "4:3"), + (ViduQ3TextToVideoAspectRatio::ThreeByFour, "3:4"), + (ViduQ3TextToVideoAspectRatio::Square, "1:1"), + ] { + assert_eq!(variant.to_str(), expected); + } + } + + #[test] + fn every_resolution_maps_to_wire_string() { + for (variant, expected, high) in [ + (ViduQ3TextToVideoResolution::ThreeSixtyP, "360p", false), + (ViduQ3TextToVideoResolution::FiveFortyP, "540p", false), + (ViduQ3TextToVideoResolution::SevenTwentyP, "720p", true), + (ViduQ3TextToVideoResolution::TenEightyP, "1080p", true), + ] { + assert_eq!(variant.to_str(), expected); + assert_eq!(variant.is_high_res(), high); + } + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!(ViduQ3TextToVideoRequest::ENDPOINT, "fal-ai/vidu/q3/text-to-video"); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/cost.rs new file mode 100644 index 00000000..5c79c8b9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/cost.rs @@ -0,0 +1,125 @@ +use crate::requests::api::video::text::vidu_q3::api::{ + ViduQ3TextToVideoRequest, ViduQ3TextToVideoResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Vidu Q3 pricing (see https://fal.ai/models/fal-ai/vidu/q3/text-to-video): +// "0.07 $ per video second for 360p and 540p, cost will be 2.2x for 720p and +// 1080p resolution." +// 360p / 540p: $0.07/sec +// 720p / 1080p: $0.154/sec (2.2 × $0.07) +// +// Pricing depends on resolution and duration only (audio/aspect ratio are +// free). Rates are stored in tenths-of-a-cent per second (both exact), then +// rounded UP to whole cents so the user is never undercharged. Shared by the +// text + image modalities. +const RATE_LOW_RES_TENTH_CENTS: u64 = 70; // $0.07/sec (360p/540p) +const RATE_HIGH_RES_TENTH_CENTS: u64 = 154; // $0.154/sec (720p/1080p) + +/// Per-second rate in tenths-of-a-cent for Vidu Q3. `is_high_res` selects the +/// 2.2× 720p/1080p tier. +pub(crate) fn vidu_q3_rate_tenth_cents_per_sec(is_high_res: bool) -> u64 { + if is_high_res { RATE_HIGH_RES_TENTH_CENTS } else { RATE_LOW_RES_TENTH_CENTS } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn vidu_q3_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for ViduQ3TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 5s, resolution = 720p. + let duration_secs = u64::from(self.duration.unwrap_or(5)); + let is_high_res = self.resolution + .unwrap_or(ViduQ3TextToVideoResolution::SevenTwentyP) + .is_high_res(); + + let rate = vidu_q3_rate_tenth_cents_per_sec(is_high_res); + vidu_q3_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::vidu_q3::api::ViduQ3TextToVideoAspectRatio; + + fn make_request( + duration: Option, + resolution: Option, + audio: Option, + ) -> ViduQ3TextToVideoRequest { + ViduQ3TextToVideoRequest { + prompt: "test".to_string(), + duration, + seed: None, + aspect_ratio: Some(ViduQ3TextToVideoAspectRatio::SixteenByNine), + resolution, + audio, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, expected_cents) + // Math: ceil(rate × secs / 10) where rate (tenth-cents) = 70 (360p/540p) + // or 154 (720p/1080p). + const COST_TABLE: &[(Option, Option, u64)] = &[ + // 360p / 540p → $0.07/s + (Some(5), Some(ViduQ3TextToVideoResolution::ThreeSixtyP), 35), + (Some(5), Some(ViduQ3TextToVideoResolution::FiveFortyP), 35), + (Some(16), Some(ViduQ3TextToVideoResolution::ThreeSixtyP), 112), + // 720p / 1080p → $0.154/s + (Some(5), Some(ViduQ3TextToVideoResolution::SevenTwentyP), 77), + (Some(5), Some(ViduQ3TextToVideoResolution::TenEightyP), 77), + (Some(10), Some(ViduQ3TextToVideoResolution::SevenTwentyP), 154), + (Some(3), Some(ViduQ3TextToVideoResolution::SevenTwentyP), 47), // 46.2 → 47 + // Defaults: duration=None→5s, resolution=None→720p + (None, None, 77), + (Some(1), Some(ViduQ3TextToVideoResolution::ThreeSixtyP), 7), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, expected) in COST_TABLE { + let got = make_request(duration, resolution, Some(true)).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} resolution={resolution:?}"); + } + } + + #[test] + fn high_res_is_more_expensive_than_low_res() { + let low = make_request(Some(8), Some(ViduQ3TextToVideoResolution::FiveFortyP), Some(true)).calculate_cost_in_cents(); + let high = make_request(Some(8), Some(ViduQ3TextToVideoResolution::SevenTwentyP), Some(true)).calculate_cost_in_cents(); + assert!(high > low, "high={high}¢ should exceed low={low}¢"); + } + + #[test] + fn cost_scales_linearly_with_duration() { + let five = make_request(Some(5), Some(ViduQ3TextToVideoResolution::ThreeSixtyP), Some(true)).calculate_cost_in_cents(); + let ten = make_request(Some(10), Some(ViduQ3TextToVideoResolution::ThreeSixtyP), Some(true)).calculate_cost_in_cents(); + assert_eq!(ten, five * 2); + } + + /// Audio and aspect ratio do not affect the bill (only resolution + duration do). + #[test] + fn cost_ignores_audio_and_aspect_ratio() { + let baseline = make_request(Some(8), Some(ViduQ3TextToVideoResolution::SevenTwentyP), Some(true)).calculate_cost_in_cents(); + for audio in [None, Some(false), Some(true)] { + for ar in [ + ViduQ3TextToVideoAspectRatio::SixteenByNine, + ViduQ3TextToVideoAspectRatio::Square, + ViduQ3TextToVideoAspectRatio::ThreeByFour, + ] { + let cost = ViduQ3TextToVideoRequest { + aspect_ratio: Some(ar), + ..make_request(Some(8), Some(ViduQ3TextToVideoResolution::SevenTwentyP), audio) + }.calculate_cost_in_cents(); + assert_eq!(cost, baseline, "audio={audio:?} ar={ar:?}"); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/raw_request.rs new file mode 100644 index 00000000..e5e476b4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3/raw_request.rs @@ -0,0 +1,41 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/vidu/q3/text-to-video`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct ViduQ3TextToVideoInput { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// Duration in seconds. Range 1–16. fal default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Seed for reproducibility. Random when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "4:3", "3:4", "1:1". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Output resolution. + /// Possible values: "360p", "540p", "720p", "1080p". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3TextToVideoOutput { + pub video: ViduQ3TextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/api.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/api.rs new file mode 100644 index 00000000..6e9d5fc7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/api.rs @@ -0,0 +1,202 @@ +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::api::video::text::vidu_q3_turbo::raw_request::{ + ViduQ3TurboTextToVideoInput, ViduQ3TurboTextToVideoOutput, +}; +use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + +#[derive(Clone, Debug)] +pub struct ViduQ3TurboTextToVideoRequest { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// Duration in seconds. Valid range 1–16; fal's default is `5` when `None`. + pub duration: Option, + + /// Seed for reproducibility. Random when `None`. + pub seed: Option, + + /// Aspect ratio. fal's default is `16:9` when `None`. + pub aspect_ratio: Option, + + /// Output resolution. fal's default is `720p` when `None`. + pub resolution: Option, + + /// Whether to generate audio. fal's server default is `true` when `None`. + pub audio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3TurboTextToVideoAspectRatio { + SixteenByNine, + NineBySixteen, + FourByThree, + ThreeByFour, + Square, +} + +impl ViduQ3TurboTextToVideoAspectRatio { + fn to_str(&self) -> &'static str { + match self { + Self::SixteenByNine => "16:9", + Self::NineBySixteen => "9:16", + Self::FourByThree => "4:3", + Self::ThreeByFour => "3:4", + Self::Square => "1:1", + } + } +} + +/// Vidu Q3 Turbo resolutions. 720p/1080p bill at 2.2× the 360p/540p rate. +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum ViduQ3TurboTextToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +impl ViduQ3TurboTextToVideoResolution { + /// 720p and 1080p are billed at the higher (2.2×) per-second rate. + pub fn is_high_res(&self) -> bool { + matches!(self, Self::SevenTwentyP | Self::TenEightyP) + } + + fn to_str(&self) -> &'static str { + match self { + Self::ThreeSixtyP => "360p", + Self::FiveFortyP => "540p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +impl FalEndpoint for ViduQ3TurboTextToVideoRequest { + const ENDPOINT: &str = "fal-ai/vidu/q3/text-to-video/turbo"; + + type RawRequest = ViduQ3TurboTextToVideoInput; + type RawResponse = ViduQ3TurboTextToVideoOutput; + + fn to_raw_request(&self) -> Result { + Ok(Self::RawRequest { + prompt: self.prompt.clone(), + duration: self.duration, + seed: self.seed, + aspect_ratio: self.aspect_ratio.map(|ar| ar.to_str().to_string()), + resolution: self.resolution.map(|r| r.to_str().to_string()), + audio: self.audio, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_endpoint_trait::FalEndpoint; + use errors::AnyhowResult; + use std::fs::read_to_string; + + // ── Real requests (manually run; require a live key and cost money) ── + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_webhook() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3TurboTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow".to_string(), + duration: Some(5), + seed: None, + aspect_ratio: Some(ViduQ3TurboTextToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), + audio: Some(true), + }; + + let result = request.send_webhook_request(&api_key, "https://example.com/webhook").await?; + println!("Webhook result: {:?}", result); + assert!(result.request_id.is_some() || result.gateway_request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test_text_to_video_queue() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let request = ViduQ3TurboTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + duration: Some(5), + seed: Some(1234), + aspect_ratio: Some(ViduQ3TurboTextToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3TurboTextToVideoResolution::ThreeSixtyP), + audio: Some(false), + }; + + let result = request.send_queue_request(&api_key).await?; + println!("Queue result — request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── Wire-shape sanity (no API calls) ── + + #[test] + fn raw_request_maps_all_fields() { + let request = ViduQ3TurboTextToVideoRequest { + prompt: "p".to_string(), + duration: Some(12), + seed: Some(42), + aspect_ratio: Some(ViduQ3TurboTextToVideoAspectRatio::FourByThree), + resolution: Some(ViduQ3TurboTextToVideoResolution::TenEightyP), + audio: Some(false), + }; + let raw = request.to_raw_request().unwrap(); + assert_eq!(raw.prompt, "p"); + assert_eq!(raw.duration, Some(12)); + assert_eq!(raw.seed, Some(42)); + assert_eq!(raw.aspect_ratio.as_deref(), Some("4:3")); + assert_eq!(raw.resolution.as_deref(), Some("1080p")); + assert_eq!(raw.audio, Some(false)); + } + + #[test] + fn raw_request_omits_unset_optionals() { + let request = ViduQ3TurboTextToVideoRequest { + prompt: "minimal".to_string(), + duration: None, + seed: None, + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json, serde_json::json!({ "prompt": "minimal" })); + } + + #[test] + fn seed_serializes_when_set() { + let request = ViduQ3TurboTextToVideoRequest { + prompt: "p".to_string(), + duration: None, + seed: Some(777), + aspect_ratio: None, + resolution: None, + audio: None, + }; + let json = serde_json::to_value(request.to_raw_request().unwrap()).unwrap(); + assert_eq!(json.get("seed").and_then(|s| s.as_i64()), Some(777)); + } + + #[test] + fn endpoint_path_is_canonical() { + assert_eq!( + ViduQ3TurboTextToVideoRequest::ENDPOINT, + "fal-ai/vidu/q3/text-to-video/turbo", + ); + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/cost.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/cost.rs new file mode 100644 index 00000000..886b46ce --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/cost.rs @@ -0,0 +1,131 @@ +use crate::requests::api::video::text::vidu_q3_turbo::api::{ + ViduQ3TurboTextToVideoRequest, ViduQ3TurboTextToVideoResolution, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +// Vidu Q3 Turbo pricing (see https://fal.ai/models/fal-ai/vidu/q3/text-to-video/turbo): +// "0.035 $ per video second for 360p and 540p, cost will be 2.2x for 720p +// and 1080p resolution." +// 360p / 540p: $0.035/sec +// 720p / 1080p: $0.077/sec (2.2 × $0.035) +// +// Half the Vidu Q3 rate. Pricing depends on resolution and duration only. +// Rates are stored in tenths-of-a-cent per second (both exact), then rounded +// UP to whole cents so the user is never undercharged. Shared by text + image. +const RATE_LOW_RES_TENTH_CENTS: u64 = 35; // $0.035/sec (360p/540p) +const RATE_HIGH_RES_TENTH_CENTS: u64 = 77; // $0.077/sec (720p/1080p) + +/// Per-second rate in tenths-of-a-cent for Vidu Q3 Turbo. `is_high_res` +/// selects the 2.2× 720p/1080p tier. +pub(crate) fn vidu_q3_turbo_rate_tenth_cents_per_sec(is_high_res: bool) -> u64 { + if is_high_res { RATE_HIGH_RES_TENTH_CENTS } else { RATE_LOW_RES_TENTH_CENTS } +} + +/// ceil(rate_tenth_cents × seconds / 10) → whole cents. +pub(crate) fn vidu_q3_turbo_cost_cents(rate_tenth_cents_per_sec: u64, duration_secs: u64) -> UsdCents { + (rate_tenth_cents_per_sec * duration_secs + 9) / 10 +} + +impl FalRequestCostCalculator for ViduQ3TurboTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // fal defaults when unset: duration = 5s, resolution = 720p. + let duration_secs = u64::from(self.duration.unwrap_or(5)); + let is_high_res = self.resolution + .unwrap_or(ViduQ3TurboTextToVideoResolution::SevenTwentyP) + .is_high_res(); + + let rate = vidu_q3_turbo_rate_tenth_cents_per_sec(is_high_res); + vidu_q3_turbo_cost_cents(rate, duration_secs) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::text::vidu_q3_turbo::api::ViduQ3TurboTextToVideoAspectRatio; + + fn make_request( + duration: Option, + resolution: Option, + audio: Option, + ) -> ViduQ3TurboTextToVideoRequest { + ViduQ3TurboTextToVideoRequest { + prompt: "test".to_string(), + duration, + seed: None, + aspect_ratio: Some(ViduQ3TurboTextToVideoAspectRatio::SixteenByNine), + resolution, + audio, + } + } + + mod cost_table { + use super::*; + + // (duration, resolution, expected_cents) + // Math: ceil(rate × secs / 10) where rate (tenth-cents) = 35 (360p/540p) + // or 77 (720p/1080p). + const COST_TABLE: &[(Option, Option, u64)] = &[ + // 360p / 540p → $0.035/s (rounds up) + (Some(5), Some(ViduQ3TurboTextToVideoResolution::ThreeSixtyP), 18), // 17.5 → 18 + (Some(5), Some(ViduQ3TurboTextToVideoResolution::FiveFortyP), 18), + (Some(16), Some(ViduQ3TurboTextToVideoResolution::ThreeSixtyP), 56), + (Some(1), Some(ViduQ3TurboTextToVideoResolution::ThreeSixtyP), 4), // 3.5 → 4 + // 720p / 1080p → $0.077/s (rounds up) + (Some(5), Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), 39), // 38.5 → 39 + (Some(5), Some(ViduQ3TurboTextToVideoResolution::TenEightyP), 39), + (Some(10), Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), 77), + (Some(3), Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), 24), // 23.1 → 24 + // Defaults: duration=None→5s, resolution=None→720p + (None, None, 39), + ]; + + #[test] + fn matches_cost_table() { + for &(duration, resolution, expected) in COST_TABLE { + let got = make_request(duration, resolution, Some(true)).calculate_cost_in_cents(); + assert_eq!(got, expected, "duration={duration:?} resolution={resolution:?}"); + } + } + + /// Turbo is roughly half the price of Q3 at the same settings (both round + /// up to whole cents, so it is not exactly half at every cell). + #[test] + fn turbo_high_res_rate_is_half_of_q3() { + use crate::requests::api::video::text::vidu_q3::cost::vidu_q3_rate_tenth_cents_per_sec; + assert_eq!( + vidu_q3_turbo_rate_tenth_cents_per_sec(true) * 2, + vidu_q3_rate_tenth_cents_per_sec(true), + ); + assert_eq!( + vidu_q3_turbo_rate_tenth_cents_per_sec(false) * 2, + vidu_q3_rate_tenth_cents_per_sec(false), + ); + } + + #[test] + fn high_res_is_more_expensive_than_low_res() { + let low = make_request(Some(8), Some(ViduQ3TurboTextToVideoResolution::FiveFortyP), Some(true)).calculate_cost_in_cents(); + let high = make_request(Some(8), Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), Some(true)).calculate_cost_in_cents(); + assert!(high > low, "high={high}¢ should exceed low={low}¢"); + } + + /// Audio and aspect ratio do not affect the bill. + #[test] + fn cost_ignores_audio_and_aspect_ratio() { + let baseline = make_request(Some(8), Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), Some(true)).calculate_cost_in_cents(); + for audio in [None, Some(false), Some(true)] { + for ar in [ + ViduQ3TurboTextToVideoAspectRatio::SixteenByNine, + ViduQ3TurboTextToVideoAspectRatio::Square, + ] { + let cost = ViduQ3TurboTextToVideoRequest { + aspect_ratio: Some(ar), + ..make_request(Some(8), Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), audio) + }.calculate_cost_in_cents(); + assert_eq!(cost, baseline, "audio={audio:?} ar={ar:?}"); + } + } + } + } +} diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/mod.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/mod.rs new file mode 100644 index 00000000..3bfb6c86 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod cost; +pub mod raw_request; diff --git a/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/raw_request.rs b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/raw_request.rs new file mode 100644 index 00000000..b259e559 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/api/video/text/vidu_q3_turbo/raw_request.rs @@ -0,0 +1,41 @@ +use serde::{Deserialize, Serialize}; + +/// Over-the-wire input shape for `fal-ai/vidu/q3/text-to-video/turbo`. +/// fal's schema: +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct ViduQ3TurboTextToVideoInput { + /// Text prompt (max 2000 characters). + pub prompt: String, + + /// Duration in seconds. Range 1–16. fal default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Seed for reproducibility. Random when omitted. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Aspect ratio. + /// Possible values: "16:9", "9:16", "4:3", "3:4", "1:1". fal default: "16:9". + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Output resolution. + /// Possible values: "360p", "540p", "720p", "1080p". fal default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Whether to generate audio for the video. fal default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3TurboTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct ViduQ3TurboTextToVideoOutput { + pub video: ViduQ3TurboTextToVideoVideoFile, +} diff --git a/crates/api_clients/fal_client/src/requests/core_api/fal_request.rs b/crates/api_clients/fal_client/src/requests/core_api/fal_request.rs new file mode 100644 index 00000000..99da819e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/core_api/fal_request.rs @@ -0,0 +1,164 @@ +use std::marker::PhantomData; + +use reqwest::IntoUrl; +use serde::{de::DeserializeOwned, Serialize}; +use log::info; + +use crate::error::fal_error::FalError; +use crate::requests::core_api::queue::Queue; +use crate::requests::core_api::queue_response::QueueResponse; +use crate::requests::core_api::webhook_response::WebhookResponse; + +/// A request to the FAL API. +/// +/// Originally from the vendored `fal` crate (`fal::request::FalRequest`). +/// Copied here so `fal_client` can be independent of the vendored crate. +#[derive(Debug)] +pub struct FalRequest { + /// The Reqwest Client to use to make requests + pub client: reqwest::Client, + /// The endpoint to make the request to + pub endpoint: String, + /// The parameters to send to the endpoint + pub params: Params, + /// The API key to use to make the request. + /// If not provided, the `FAL_API_KEY` environment variable will be used. + pub api_key: Option, + phantom: PhantomData, +} + +impl FalRequest { + pub fn new(endpoint: impl Into, params: Params) -> Self { + Self { + client: reqwest::Client::new(), + endpoint: endpoint.into(), + params, + api_key: std::env::var("FAL_API_KEY").ok(), + phantom: PhantomData, + } + } + + /// Use a specific Reqwest Client to make requests + pub fn with_client(mut self, client: reqwest::Client) -> Self { + self.client = client; + self + } + + /// Use a specific API key to make requests + pub fn with_api_key(mut self, api_key: impl Into) -> Self { + self.api_key = Some(api_key.into()); + self + } + + /// Send the request and wait for the response + pub async fn send(self) -> Result { + let response = self + .client + .post(format!("https://fal.run/{}", self.endpoint)) + .json(&self.params) + .header( + "Authorization", + format!( + "Key {}", + self.api_key.expect( + "No fal API key provided, and FAL_API_KEY environment variable is not set" + ) + ), + ) + .header("Content-Type", "application/json") + .send() + .await?; + + if response.status() != 200 { + let error = response.text().await?; + return Err(error.into()); + } + + Ok(response.error_for_status()?.json().await?) + } + + /// Submit the request to the Fal queue system. + pub async fn queue(self) -> Result, FalError> { + let key = self + .api_key + .expect("No fal API key provided, and FAL_API_KEY environment variable is not set"); + + let response = self + .client + .post(format!("https://queue.fal.run/{}", self.endpoint)) + .json(&self.params) + .header("Authorization", format!("Key {}", &key)) + .header("Content-Type", "application/json") + .send() + .await?; + + if response.status() != 200 { + let error = response.text().await?; + return Err(error.into()); + } + + let payload: QueueResponse = response.error_for_status()?.json().await?; + + Ok(Queue::new(self.client, self.endpoint, key, payload)) + } + + /// Submit the request to the Fal queue with a webhook callback URL. + pub async fn queue_webhook(self, url: U) -> Result { + let key = self + .api_key + .expect("No fal API key provided, and FAL_API_KEY environment variable is not set"); + + let url_encoded = url.into_url()?; + + let request_url = format!("https://queue.fal.run/{}?fal_webhook={}", self.endpoint, url_encoded); + + info!("Sending request to FAL queue webhook: {}", request_url); + + let response = self + .client + .post(request_url) + .json(&self.params) + .header("Authorization", format!("Key {}", &key)) + .header("Content-Type", "application/json") + .send() + .await?; + + if response.status() != 200 { + let error = response.text().await?; + return Err(error.into()); + } + + let payload: WebhookResponse = response.error_for_status()?.json().await?; + + Ok(payload) + } + + /// Submit the request to the Fal queue system. + pub async fn queue_request(self) -> Result { + let key = self + .api_key + .expect("No fal API key provided, and FAL_API_KEY environment variable is not set"); + + let response = self + .client + .post(format!("https://queue.fal.run/{}", self.endpoint)) + .json(&self.params) + .header("Authorization", format!("Key {}", &key)) + .header("Content-Type", "application/json") + .send() + .await?; + + if response.status() != 200 { + let error = response.text().await?; + return Err(error.into()); + } + + let body = response.text().await?; + + println!("Queue response: {}", body); + + let payload: QueueResponse = serde_json::from_str(&body)?; + + Ok(payload) + } +} diff --git a/crates/api_clients/fal_client/src/requests/core_api/mod.rs b/crates/api_clients/fal_client/src/requests/core_api/mod.rs new file mode 100644 index 00000000..6aee79d0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/core_api/mod.rs @@ -0,0 +1,5 @@ +pub mod fal_request; +pub mod queue; +pub mod queue_response; +pub mod queue_status; +pub mod webhook_response; diff --git a/crates/api_clients/fal_client/src/requests/core_api/queue.rs b/crates/api_clients/fal_client/src/requests/core_api/queue.rs new file mode 100644 index 00000000..b87cc0a9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/core_api/queue.rs @@ -0,0 +1,86 @@ +use std::marker::PhantomData; + +use serde::{de::DeserializeOwned, Deserialize, Serialize}; + +use crate::error::fal_error::FalError; +use crate::requests::core_api::queue_response::QueueResponse; +use crate::requests::core_api::queue_status::QueueStatus; + +#[derive(Debug, Serialize, Deserialize)] +pub struct Queue { + #[serde(skip)] + pub client: Option, + pub endpoint: String, + pub api_key: String, + pub payload: QueueResponse, + phantom: PhantomData, +} + +impl Queue { + pub fn new( + client: reqwest::Client, + endpoint: impl Into, + api_key: String, + payload: QueueResponse, + ) -> Self { + Self { + client: Some(client), + endpoint: endpoint.into(), + api_key, + payload, + phantom: PhantomData, + } + } + + /// Get the status of the Queue request + pub async fn status(&self, show_logs: bool) -> Result { + let response = self + .client + .as_ref() + .unwrap() + .get(&self.payload.status_url) + .query(&[("logs", if show_logs { "1" } else { "0" })]) + .header("Authorization", format!("Key {}", self.api_key)) + .header("Content-Type", "application/json") + .send() + .await?; + + Ok(response.error_for_status()?.json().await?) + } + + /// Get the response of the Queue request, if the request is Completed + pub async fn response(&self) -> Result { + let response = self + .client + .as_ref() + .unwrap() + .get(&self.payload.response_url) + .header("Authorization", format!("Key {}", self.api_key)) + .header("Content-Type", "application/json") + .send() + .await?; + + if response.status() != 200 { + let error = response.text().await?; + return Err(error.into()); + } + + Ok(response.error_for_status()?.json().await?) + } + + /// Cancel the Queue request + pub async fn cancel(&self) -> Result<(), FalError> { + let response = self + .client + .as_ref() + .unwrap() + .put(&self.payload.cancel_url) + .header("Authorization", format!("Key {}", self.api_key)) + .send() + .await?; + + response.error_for_status()?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests/core_api/queue_response.rs b/crates/api_clients/fal_client/src/requests/core_api/queue_response.rs new file mode 100644 index 00000000..8bc56d07 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/core_api/queue_response.rs @@ -0,0 +1,9 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize)] +pub struct QueueResponse { + pub request_id: String, + pub response_url: String, + pub status_url: String, + pub cancel_url: String, +} diff --git a/crates/api_clients/fal_client/src/requests/core_api/queue_status.rs b/crates/api_clients/fal_client/src/requests/core_api/queue_status.rs new file mode 100644 index 00000000..eb629ab5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/core_api/queue_status.rs @@ -0,0 +1,29 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum Status { + InQueue, + InProgress, + Completed, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct RequestLog { + pub timestamp: String, + pub level: Option, + pub source: Option, + pub message: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QueueStatus { + /// The status of the Queue request + pub status: Status, + /// The position of the request in the queue + pub queue_position: Option, + /// The URL of the response + pub response_url: String, + /// The logs of the request, if `show_logs` is `true` + pub logs: Option>, +} diff --git a/crates/api_clients/fal_client/src/requests/core_api/webhook_response.rs b/crates/api_clients/fal_client/src/requests/core_api/webhook_response.rs new file mode 100644 index 00000000..40dbc30b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/core_api/webhook_response.rs @@ -0,0 +1,8 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Clone)] +pub struct WebhookResponse { + pub status: Option, + pub request_id: Option, + pub gateway_request_id: Option, +} diff --git a/crates/api_clients/fal_client/src/requests/mod.rs b/crates/api_clients/fal_client/src/requests/mod.rs new file mode 100644 index 00000000..079b1044 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +pub mod core_api; +pub mod traits; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests/traits/fal_endpoint_trait.rs b/crates/api_clients/fal_client/src/requests/traits/fal_endpoint_trait.rs new file mode 100644 index 00000000..eacc3489 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/traits/fal_endpoint_trait.rs @@ -0,0 +1,45 @@ +use reqwest::IntoUrl; +use crate::creds::fal_api_key::FalApiKey; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::core_api::fal_request::FalRequest; +use crate::requests::core_api::queue_response::QueueResponse; +use crate::requests::core_api::webhook_response::WebhookResponse; +use serde::de::DeserializeOwned; +use serde::Serialize; + +pub trait FalEndpoint { + /// Fal endpoint, eg. `fal-ai/flux-2-lora-gallery/multiple-angles` + const ENDPOINT : &'static str; + + /// Shape of the Fal request for the endpoint + type RawRequest : Serialize; + + /// Shape of the Fal response for the endpoint + type RawResponse : DeserializeOwned; + + fn get_endpoint() -> &'static str { + Self::ENDPOINT + } + + async fn send_webhook_request(&self, api_key: &FalApiKey, webhook_url: U) -> Result { + let request = self.to_raw_request()?; + let request = FalRequest::::new(Self::ENDPOINT, request); + let result = request.with_api_key(&api_key.0) + .queue_webhook(webhook_url) + .await?; + Ok(result) + } + + async fn send_queue_request(&self, api_key: &FalApiKey) -> Result { + let request = self.to_raw_request()?; + let request = FalRequest::::new(Self::ENDPOINT, request); + let result = request.with_api_key(&api_key.0) + .queue_request() + .await?; + Ok(result) + } + + /// Convert request to the over-the-wire representation + /// This allows us to change the shape, types, etc. + fn to_raw_request(&self) -> Result; +} diff --git a/crates/api_clients/fal_client/src/requests/traits/fal_request_cost_calculator_trait.rs b/crates/api_clients/fal_client/src/requests/traits/fal_request_cost_calculator_trait.rs new file mode 100644 index 00000000..7982946e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/traits/fal_request_cost_calculator_trait.rs @@ -0,0 +1,9 @@ + +/// Cost in pennies. +pub type UsdCents = u64; + +pub trait FalRequestCostCalculator { + + /// Calculate the cost of the request. + fn calculate_cost_in_cents(&self) -> UsdCents; +} diff --git a/crates/api_clients/fal_client/src/requests/traits/mod.rs b/crates/api_clients/fal_client/src/requests/traits/mod.rs new file mode 100644 index 00000000..7e1b7e0e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests/traits/mod.rs @@ -0,0 +1,2 @@ +pub mod fal_endpoint_trait; +pub mod fal_request_cost_calculator_trait; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/angle/http_flux_2_lora_edit_image_angle.rs b/crates/api_clients/fal_client/src/requests_old/http/image/angle/http_flux_2_lora_edit_image_angle.rs new file mode 100644 index 00000000..71989a62 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/angle/http_flux_2_lora_edit_image_angle.rs @@ -0,0 +1,82 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux2LoraEditImageAngleInput { + /// The URL of the image to adjust camera angle for. + pub image_urls: Vec, + + /// Horizontal rotation angle around the object in degrees. + /// 0°=front view, 90°=right side, 180°=back view, 270°=left side. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub horizontal_angle: Option, + + /// Vertical camera angle in degrees. + /// 0°=eye-level shot, 30°=elevated shot, 60°=high-angle shot. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub vertical_angle: Option, + + /// Camera zoom/distance. 0=wide shot, 5=medium shot, 10=close-up. + /// Default: 5 + #[serde(skip_serializing_if = "Option::is_none")] + pub zoom: Option, + + /// The strength of the multiple angles effect. + /// Default: 1, range: 0-2 + #[serde(skip_serializing_if = "Option::is_none")] + pub lora_scale: Option, + + /// The size of the generated image. + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default: 2.5, range: 0-20 + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// The number of inference steps to perform. + /// Default: 40, range: 1-50 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Random seed for reproducibility. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Number of images to generate. + /// Default: 1, max: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// Whether to enable the safety checker. + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Output format: png, jpeg, webp. + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux2LoraEditImageAngleFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux2LoraEditImageAngleOutput { + pub images: Vec, + pub seed: u64, + pub prompt: Option, +} + +pub fn http_flux_2_lora_edit_image_angle( + params: Flux2LoraEditImageAngleInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux-2-lora-gallery/multiple-angles", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/angle/http_qwen_edit_2511_edit_image_angle.rs b/crates/api_clients/fal_client/src/requests_old/http/image/angle/http_qwen_edit_2511_edit_image_angle.rs new file mode 100644 index 00000000..2bd64cb5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/angle/http_qwen_edit_2511_edit_image_angle.rs @@ -0,0 +1,88 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct QwenEdit2511EditImageAngleInput { + /// The URL of the image to adjust camera angle for. + pub image_urls: Vec, + + /// Horizontal rotation angle around the object in degrees. 0°=front view. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub horizontal_angle: Option, + + /// Vertical camera angle in degrees. -30°=low-angle shot, 30°=high-angle shot. + /// Default: 0 + #[serde(skip_serializing_if = "Option::is_none")] + pub vertical_angle: Option, + + /// Camera zoom/distance. 0=wide shot, 5=medium shot, 10=close-up. + /// Default: 5 + #[serde(skip_serializing_if = "Option::is_none")] + pub zoom: Option, + + /// Additional text to append to the automatically generated prompt. + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_prompt: Option, + + /// The scale factor for the LoRA model. Controls the strength of the effect. + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub lora_scale: Option, + + /// The size of the generated image. + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default: 4.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// The number of inference steps to perform. + /// Default: 28 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// The negative prompt for the generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Random seed for reproducibility. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Number of images to generate. + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// Whether to enable the safety checker. + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Output format: png, jpeg, webp. + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QwenEdit2511EditImageAngleFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QwenEdit2511EditImageAngleOutput { + pub images: Vec, + pub seed: u64, + pub prompt: Option, +} + +pub fn http_qwen_edit_2511_edit_image_angle( + params: QwenEdit2511EditImageAngleInput, +) -> FalRequest { + FalRequest::new("fal-ai/qwen-image-edit-2511-multiple-angles", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/angle/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/image/angle/mod.rs new file mode 100644 index 00000000..c5f7d8ee --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/angle/mod.rs @@ -0,0 +1,2 @@ +pub mod http_flux_2_lora_edit_image_angle; +pub mod http_qwen_edit_2511_edit_image_angle; diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/background/http_rembg_remove_background.rs b/crates/api_clients/fal_client/src/requests_old/http/image/background/http_rembg_remove_background.rs new file mode 100644 index 00000000..023c9a2b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/background/http_rembg_remove_background.rs @@ -0,0 +1,29 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct RembgRemoveBackgroundInput { + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub crop_to_bbox: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct RembgRemoveBackgroundFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct RembgRemoveBackgroundOutput { + pub image: RembgRemoveBackgroundFile, +} + +pub fn rembg_remove_background( + params: RembgRemoveBackgroundInput, +) -> FalRequest { + FalRequest::new("fal-ai/imageutils/rembg", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/background/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/image/background/mod.rs new file mode 100644 index 00000000..3aad3bc7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/background/mod.rs @@ -0,0 +1 @@ +pub mod http_rembg_remove_background; diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_1_dev_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_1_dev_edit_image.rs new file mode 100644 index 00000000..23f7d14c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_1_dev_edit_image.rs @@ -0,0 +1,54 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1DevEditImageInput { + pub prompt: String, + + pub image_url: String, + + /// 0.0 - 1.0 + /// Default: 0.95 + #[serde(skip_serializing_if = "Option::is_none")] + pub strength: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Options: jpeg, png + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevEditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevEditImageOutput { + pub images: Vec, +} + +pub fn flux_1_dev_edit_image( + params: Flux1DevEditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux/dev/image-to-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_1_schnell_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_1_schnell_edit_image.rs new file mode 100644 index 00000000..9c6b3c80 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_1_schnell_edit_image.rs @@ -0,0 +1,48 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1SchnellEditImageInput { + pub image_url: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Options: jpeg, png + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellEditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellEditImageOutput { + pub images: Vec, +} + +pub fn flux_1_schnell_edit_image( + params: Flux1SchnellEditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux/schnell/redux", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_pro_kontext_max_edit.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_pro_kontext_max_edit.rs new file mode 100644 index 00000000..233ebe93 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_flux_pro_kontext_max_edit.rs @@ -0,0 +1,50 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct FluxProKontextMaxEditInput { + pub prompt: String, + + pub image_url: String, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "png" or "jpeg" + /// Default: "jpeg" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + /// Aspect ratio for the generated image. + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// The safety tolerance level for content moderation. + /// "1" (most strict) to "5" (most permissive). + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxProKontextMaxEditFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxProKontextMaxEditOutput { + pub images: Vec, +} + +pub fn flux_pro_kontext_max_edit( + params: FluxProKontextMaxEditInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux-pro/kontext/max", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gemini_25_flash_edit.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gemini_25_flash_edit.rs new file mode 100644 index 00000000..98c580bf --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gemini_25_flash_edit.rs @@ -0,0 +1,41 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Gemini25FlashEditInput { + pub prompt: String, + + pub image_urls: Vec, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg" or "png" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + /// Aspect ratio for the generated image. + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Gemini25FlashEditFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Gemini25FlashEditOutput { + pub images: Vec, +} + +pub fn gemini_25_flash_edit( + params: Gemini25FlashEditInput, +) -> FalRequest { + FalRequest::new("fal-ai/gemini-25-flash-image/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1_byok_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1_byok_edit_image.rs new file mode 100644 index 00000000..3ad26434 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1_byok_edit_image.rs @@ -0,0 +1,32 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1ByokEditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + pub image_size: String, + + /// 1 - 4 + pub num_images: u8, + + /// "auto", "low", "medium", "high" + pub quality: String, + + /// BYOK - caller supplies their own OpenAI API key + pub openai_api_key: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1ByokEditImageOutput { + // Response fields parsed elsewhere +} + +pub fn gpt_image_1_byok_edit_image( + params: GptImage1ByokEditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gpt-image-1/edit-image/byok", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1_edit_image.rs new file mode 100644 index 00000000..49b7b61d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1_edit_image.rs @@ -0,0 +1,57 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +/// Non-BYOK edit-image (image-to-image) binding for +/// `fal-ai/gpt-image-1/edit-image`. Fal hosts this model directly; pricing is +/// billed by Fal at their published rates. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + #[serde(skip_serializing_if = "Option::is_none")] + pub mask_image_url: Option, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// "low", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub input_fidelity: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1EditImageOutput { + pub images: Vec, +} + +pub fn gpt_image_1_edit_image( + params: GptImage1EditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gpt-image-1/edit-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1p5_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1p5_edit_image.rs new file mode 100644 index 00000000..5399ee1b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_1p5_edit_image.rs @@ -0,0 +1,54 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1p5EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + #[serde(skip_serializing_if = "Option::is_none")] + pub mask_image_url: Option, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// "low", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub input_fidelity: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5EditImageOutput { + pub images: Vec, +} + +pub fn gpt_image_1p5_edit_image( + params: GptImage1p5EditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gpt-image-1.5/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_2_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_2_edit_image.rs new file mode 100644 index 00000000..4a890404 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_gpt_image_2_edit_image.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage2EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// The URL of the mask image to use for the generation. This indicates what part of the image to edit. + #[serde(skip_serializing_if = "Option::is_none")] + pub mask_url: Option, + + /// Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2EditImageOutput { + pub images: Vec, +} + +pub fn gpt_image_2_edit_image( + params: GptImage2EditImageInput, +) -> FalRequest { + FalRequest::new("openai/gpt-image-2/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_nano_banana_2_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_nano_banana_2_edit_image.rs new file mode 100644 index 00000000..3563fcfe --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_nano_banana_2_edit_image.rs @@ -0,0 +1,79 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBanana2EditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// Eg. "auto", "16:9", "1:1", etc. + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Eg. "0.5K", "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// The safety tolerance level for content moderation. + /// 1 is the most strict (blocks most content), 6 is the least strict. + /// Default value: "4" + /// + /// Possible enum values: 1, 2, 3, 4, 5, 6 + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// Experimental parameter to limit the number of generations from each round + /// of prompting to 1. Set to True to to disregard any instructions in the + /// prompt regarding the number of images to generate and ignore any + /// intermediate images generated by the model. This may affect generation + /// quality. + /// + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub limit_generations: Option, + + /// Enable web search for the image generation task. This will allow + /// the model to use the latest information from the web to generate + /// the image. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_web_search: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2EditImageFile { + pub url: String, + //pub content_type: Option, + //pub file_name: Option, + //pub file_size: Option, + //pub width: Option, + //pub height: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2EditImageOutput { + pub images: Vec, + //pub description: String, +} + +pub fn nano_banana_2_edit_image( + params: NanoBanana2EditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/nano-banana-2/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_nano_banana_pro_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_nano_banana_pro_edit_image.rs new file mode 100644 index 00000000..6198cf61 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_nano_banana_pro_edit_image.rs @@ -0,0 +1,46 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBananaProEditImageInput { + pub prompt: String, + + pub image_urls: Vec, + + /// Eg. "auto", "16:9", "1:1", etc. + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Eg. "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProEditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProEditImageOutput { + pub images: Vec, +} + +pub fn nano_banana_pro_edit_image( + params: NanoBananaProEditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/nano-banana-pro/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_qwen_image_edit.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_qwen_image_edit.rs new file mode 100644 index 00000000..f747f0bb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_qwen_image_edit.rs @@ -0,0 +1,62 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct QwenImageEditInput { + pub prompt: String, + + pub image_url: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg" or "png" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Default: 30 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Default: 4.0 + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Options: "none", "regular", "high" + /// Default: "none" + #[serde(skip_serializing_if = "Option::is_none")] + pub acceleration: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QwenImageEditFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct QwenImageEditOutput { + pub images: Vec, +} + +pub fn qwen_image_edit( + params: QwenImageEditInput, +) -> FalRequest { + FalRequest::new("fal-ai/qwen-image-edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seededit_v3_edit.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seededit_v3_edit.rs new file mode 100644 index 00000000..bf7847a4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seededit_v3_edit.rs @@ -0,0 +1,31 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedEditV3EditInput { + pub prompt: String, + + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedEditV3EditFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedEditV3EditOutput { + pub image: Vec, +} + +pub fn seededit_v3_edit( + params: SeedEditV3EditInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seededit/v3/edit-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_4_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_4_edit_image.rs new file mode 100644 index 00000000..0544d0f1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_4_edit_image.rs @@ -0,0 +1,50 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedreamV4EditImageInput { + pub prompt: String, + + /// Maximum 10 images. Excess images are ignored. + pub image_urls: Vec, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto, auto_2K, auto_4K + /// Default: "auto_2K" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub max_images: Option, + + /// Enum: "standard", "fast" + /// Default: "standard" + #[serde(skip_serializing_if = "Option::is_none")] + pub enhance_prompt_mode: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4EditImageOutput { + pub images: Vec, +} + +pub fn seedream_4_edit_image( + params: SeedreamV4EditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedream/v4/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_4p5_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_4p5_edit_image.rs new file mode 100644 index 00000000..c24c534c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_4p5_edit_image.rs @@ -0,0 +1,48 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedreamV4p5EditImageInput { + pub prompt: String, + + /// Maximum 10 images. Excess images are ignored. + pub image_urls: Vec, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto_2K, auto_4K + /// Default: "auto_2K" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub max_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4p5EditImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4p5EditImageOutput { + pub images: Vec, +} + +pub fn seedream_4p5_edit_image( + params: SeedreamV4p5EditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedream/v4.5/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_5_edit_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_5_edit_image.rs new file mode 100644 index 00000000..5b5485a3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/http_seedream_5_edit_image.rs @@ -0,0 +1,49 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedreamV5LiteEditImageInput { + pub prompt: String, + + /// Maximum 10 images. Excess images are ignored. + pub image_urls: Vec, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto_2K, auto_3K + /// Default: "auto_2K" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub max_images: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV5LiteEditImageFile { + pub url: String, + //pub content_type: Option, + //pub file_name: Option, + //pub file_size: Option, + //pub width: Option, + //pub height: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV5LiteEditImageOutput { + pub images: Vec, + pub seed: u64, +} + +pub fn http_seedream_5_edit_image( + params: SeedreamV5LiteEditImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedream/v5/lite/edit", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/edit/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/image/edit/mod.rs new file mode 100644 index 00000000..326291db --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/edit/mod.rs @@ -0,0 +1,15 @@ +pub mod http_flux_1_dev_edit_image; +pub mod http_flux_1_schnell_edit_image; +pub mod http_flux_pro_kontext_max_edit; +pub mod http_gemini_25_flash_edit; +pub mod http_gpt_image_1_byok_edit_image; +pub mod http_gpt_image_1_edit_image; +pub mod http_gpt_image_1p5_edit_image; +pub mod http_gpt_image_2_edit_image; +pub mod http_nano_banana_2_edit_image; +pub mod http_nano_banana_pro_edit_image; +pub mod http_qwen_image_edit; +pub mod http_seedream_4_edit_image; +pub mod http_seedream_4p5_edit_image; +pub mod http_seedream_5_edit_image; +pub mod http_seededit_v3_edit; diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/infill/http_flux_dev_juggernaut_infill.rs b/crates/api_clients/fal_client/src/requests_old/http/image/infill/http_flux_dev_juggernaut_infill.rs new file mode 100644 index 00000000..0637732a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/infill/http_flux_dev_juggernaut_infill.rs @@ -0,0 +1,59 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct FluxDevJuggernautInfillInput { + pub prompt: String, + + pub image_url: String, + + pub mask_url: String, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "png" or "jpeg" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// 0.0 - 1.0. 1.0 completely remakes the image, 0.0 preserves the original. + #[serde(skip_serializing_if = "Option::is_none")] + pub strength: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxDevJuggernautInfillFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxDevJuggernautInfillOutput { + pub images: Vec, +} + +pub fn flux_dev_juggernaut_infill( + params: FluxDevJuggernautInfillInput, +) -> FalRequest { + FalRequest::new("rundiffusion-fal/juggernaut-flux-lora/inpainting", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/infill/http_flux_pro_1_infill.rs b/crates/api_clients/fal_client/src/requests_old/http/image/infill/http_flux_pro_1_infill.rs new file mode 100644 index 00000000..cb3d91ab --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/infill/http_flux_pro_1_infill.rs @@ -0,0 +1,46 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct FluxPro1InfillInput { + pub prompt: String, + + pub image_url: String, + + pub mask_url: String, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "1" (most strict) to "5" (most permissive) + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// "png" or "jpeg" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxPro1InfillFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxPro1InfillOutput { + pub images: Vec, +} + +pub fn flux_pro_1_infill( + params: FluxPro1InfillInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux-pro/v1/fill", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/infill/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/image/infill/mod.rs new file mode 100644 index 00000000..755a49e5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/infill/mod.rs @@ -0,0 +1,2 @@ +pub mod http_flux_dev_juggernaut_infill; +pub mod http_flux_pro_1_infill; diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/image/mod.rs new file mode 100644 index 00000000..50c1d0b2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/mod.rs @@ -0,0 +1,5 @@ +pub mod angle; +pub mod background; +pub mod edit; +pub mod infill; +pub mod text; diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_1_dev_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_1_dev_text_to_image.rs new file mode 100644 index 00000000..c2a73e21 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_1_dev_text_to_image.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1DevTextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1DevTextToImageOutput { + pub images: Vec, +} + +pub fn flux_1_dev_text_to_image( + params: Flux1DevTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux/dev", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_1_schnell_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_1_schnell_text_to_image.rs new file mode 100644 index 00000000..8fc63760 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_1_schnell_text_to_image.rs @@ -0,0 +1,44 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Flux1SchnellTextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Flux1SchnellTextToImageOutput { + pub images: Vec, +} + +pub fn flux_1_schnell_text_to_image( + params: Flux1SchnellTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux/schnell", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_pro_11_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_pro_11_text_to_image.rs new file mode 100644 index 00000000..180f9726 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_pro_11_text_to_image.rs @@ -0,0 +1,50 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct FluxPro11TextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// "1" (most strict) to "5" (most permissive) + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// "png" or "jpeg" + /// Default: "jpeg" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxPro11TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxPro11TextToImageOutput { + pub images: Vec, +} + +pub fn flux_pro_11_text_to_image( + params: FluxPro11TextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux-pro/v1.1", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_pro_11_ultra_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_pro_11_ultra_text_to_image.rs new file mode 100644 index 00000000..082ebe38 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_flux_pro_11_ultra_text_to_image.rs @@ -0,0 +1,55 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct FluxPro11UltraTextToImageInput { + pub prompt: String, + + /// Options: 21:9, 16:9, 4:3, 3:2, 1:1, 2:3, 3:4, 9:16, 9:21 + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Generate less processed, more natural-looking images. + /// Default: false + #[serde(skip_serializing_if = "Option::is_none")] + pub raw: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// "1" (most strict) to "5" (most permissive) + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// "png" or "jpeg" + /// Default: "jpeg" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_mode: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxPro11UltraTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FluxPro11UltraTextToImageOutput { + pub images: Vec, +} + +pub fn flux_pro_11_ultra_text_to_image( + params: FluxPro11UltraTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/flux-pro/v1.1-ultra", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gemini_25_flash_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gemini_25_flash_text_to_image.rs new file mode 100644 index 00000000..839539dd --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gemini_25_flash_text_to_image.rs @@ -0,0 +1,38 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Gemini25FlashTextToImageInput { + pub prompt: String, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg" or "png" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + /// Options: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Gemini25FlashTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Gemini25FlashTextToImageOutput { + pub images: Vec, +} + +pub fn gemini_25_flash_text_to_image( + params: Gemini25FlashTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gemini-25-flash-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1_byok_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1_byok_text_to_image.rs new file mode 100644 index 00000000..6dec9797 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1_byok_text_to_image.rs @@ -0,0 +1,30 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1ByokTextToImageInput { + pub prompt: String, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + pub image_size: String, + + /// 1 - 4 + pub num_images: u8, + + /// "auto", "low", "medium", "high" + pub quality: String, + + /// BYOK - caller supplies their own OpenAI API key + pub openai_api_key: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1ByokTextToImageOutput { + // Response fields parsed elsewhere +} + +pub fn gpt_image_1_byok_text_to_image( + params: GptImage1ByokTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gpt-image-1/text-to-image/byok", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1_text_to_image.rs new file mode 100644 index 00000000..f564a725 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1_text_to_image.rs @@ -0,0 +1,49 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +/// Non-BYOK text-to-image binding for `fal-ai/gpt-image-1/text-to-image`. +/// +/// Fal hosts this model directly (no caller-supplied OpenAI API key); pricing +/// is billed by Fal at their published rates. +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1TextToImageInput { + pub prompt: String, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1TextToImageOutput { + pub images: Vec, +} + +pub fn gpt_image_1_text_to_image( + params: GptImage1TextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gpt-image-1/text-to-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1p5_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1p5_text_to_image.rs new file mode 100644 index 00000000..2dc14fca --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_1p5_text_to_image.rs @@ -0,0 +1,45 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage1p5TextToImageInput { + pub prompt: String, + + /// "auto", "1024x1024", "1536x1024", "1024x1536" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "auto", "transparent", "opaque" + #[serde(skip_serializing_if = "Option::is_none")] + pub background: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage1p5TextToImageOutput { + pub images: Vec, +} + +pub fn gpt_image_1p5_text_to_image( + params: GptImage1p5TextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/gpt-image-1.5", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_2_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_2_text_to_image.rs new file mode 100644 index 00000000..29ef0540 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_gpt_image_2_text_to_image.rs @@ -0,0 +1,41 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct GptImage2TextToImageInput { + pub prompt: String, + + /// square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9 + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// "low", "medium", "high" + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GptImage2TextToImageOutput { + pub images: Vec, +} + +pub fn gpt_image_2_text_to_image( + params: GptImage2TextToImageInput, +) -> FalRequest { + FalRequest::new("openai/gpt-image-2", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_nano_banana_2_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_nano_banana_2_text_to_image.rs new file mode 100644 index 00000000..47a9b69b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_nano_banana_2_text_to_image.rs @@ -0,0 +1,77 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBanana2TextToImageInput { + pub prompt: String, + + /// Eg. "auto", "16:9", "1:1", etc. + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Eg. "0.5K", "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// The safety tolerance level for content moderation. + /// 1 is the most strict (blocks most content), 6 is the least strict. + /// Default value: "4" + /// + /// Possible enum values: 1, 2, 3, 4, 5, 6 + #[serde(skip_serializing_if = "Option::is_none")] + pub safety_tolerance: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Experimental parameter to limit the number of generations from each round + /// of prompting to 1. Set to True to to disregard any instructions in the + /// prompt regarding the number of images to generate and ignore any + /// intermediate images generated by the model. This may affect generation + /// quality. + /// + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub limit_generations: Option, + + /// Enable web search for the image generation task. This will allow + /// the model to use the latest information from the web to generate + /// the image. + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_web_search: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2ImageFile { + pub url: String, + //pub content_type: Option, + //pub file_name: Option, + //pub file_size: Option, + //pub width: Option, + //pub height: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBanana2TextToImageOutput { + pub images: Vec, + //pub description: String, +} + +pub fn nano_banana_2_text_to_image( + params: NanoBanana2TextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/nano-banana-2", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_nano_banana_pro_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_nano_banana_pro_text_to_image.rs new file mode 100644 index 00000000..75908f65 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_nano_banana_pro_text_to_image.rs @@ -0,0 +1,43 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct NanoBananaProTextToImageInput { + pub prompt: String, + + /// Options: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 + /// Default: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// "1K", "2K", "4K" + /// Default: "1K" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// "jpeg", "png", "webp" + /// Default: "png" + #[serde(skip_serializing_if = "Option::is_none")] + pub output_format: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProTextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct NanoBananaProTextToImageOutput { + pub images: Vec, +} + +pub fn nano_banana_pro_text_to_image( + params: NanoBananaProTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/nano-banana-pro", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_4_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_4_text_to_image.rs new file mode 100644 index 00000000..0bfe99df --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_4_text_to_image.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedreamV4TextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto, auto_2K, auto_4K + /// Default: "auto_2K" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub max_images: Option, + + /// Enum: "standard", "fast" + /// Default: "standard" + #[serde(skip_serializing_if = "Option::is_none")] + pub enhance_prompt_mode: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4TextToImageOutput { + pub images: Vec, +} + +pub fn seedream_4_text_to_image( + params: SeedreamV4TextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedream/v4/text-to-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_4p5_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_4p5_text_to_image.rs new file mode 100644 index 00000000..a2295e3c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_4p5_text_to_image.rs @@ -0,0 +1,45 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedreamV4p5TextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto_2K, auto_4K + /// Default: "auto_2K" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// 1 - 4 + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub max_images: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4p5TextToImageFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV4p5TextToImageOutput { + pub images: Vec, +} + +pub fn seedream_4p5_text_to_image( + params: SeedreamV4p5TextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedream/v4.5/text-to-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_5_text_to_image.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_5_text_to_image.rs new file mode 100644 index 00000000..e2b7dcdf --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/http_seedream_5_text_to_image.rs @@ -0,0 +1,46 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct SeedreamV5LiteTextToImageInput { + pub prompt: String, + + /// Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto_2K, auto_3K + /// Default: "auto_2K" + #[serde(skip_serializing_if = "Option::is_none")] + pub image_size: Option, + + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub num_images: Option, + + /// Default: 1 + #[serde(skip_serializing_if = "Option::is_none")] + pub max_images: Option, + + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV5LiteImageFile { + pub url: String, + //pub content_type: Option, + //pub file_name: Option, + //pub file_size: Option, + //pub width: Option, + //pub height: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct SeedreamV5LiteTextToImageOutput { + pub images: Vec, + pub seed: u64, +} + +pub fn http_seedream_5_text_to_image( + params: SeedreamV5LiteTextToImageInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedream/v5/lite/text-to-image", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/image/text/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/image/text/mod.rs new file mode 100644 index 00000000..3c7f5da2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/image/text/mod.rs @@ -0,0 +1,14 @@ +pub mod http_flux_1_dev_text_to_image; +pub mod http_flux_1_schnell_text_to_image; +pub mod http_flux_pro_11_text_to_image; +pub mod http_flux_pro_11_ultra_text_to_image; +pub mod http_gemini_25_flash_text_to_image; +pub mod http_gpt_image_1_text_to_image; +pub mod http_gpt_image_1_byok_text_to_image; +pub mod http_gpt_image_1p5_text_to_image; +pub mod http_gpt_image_2_text_to_image; +pub mod http_nano_banana_2_text_to_image; +pub mod http_nano_banana_pro_text_to_image; +pub mod http_seedream_4_text_to_image; +pub mod http_seedream_4p5_text_to_image; +pub mod http_seedream_5_text_to_image; diff --git a/crates/api_clients/fal_client/src/requests_old/http/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/mod.rs new file mode 100644 index 00000000..0027a16d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/mod.rs @@ -0,0 +1,3 @@ +pub mod image; +pub mod object; +pub mod video; diff --git a/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v21_image_to_3d.rs b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v21_image_to_3d.rs new file mode 100644 index 00000000..33b01096 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v21_image_to_3d.rs @@ -0,0 +1,31 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3dV21ImageTo3dInput { + pub input_image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub textured_mesh: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub octree_resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3dV21ImageTo3dOutput {} + +pub fn hunyuan3d_v21_image_to_3d( + params: Hunyuan3dV21ImageTo3dInput, +) -> FalRequest { + FalRequest::new("fal-ai/hunyuan3d-v21", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v2_image_to_3d.rs b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v2_image_to_3d.rs new file mode 100644 index 00000000..bf0871c4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v2_image_to_3d.rs @@ -0,0 +1,31 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3dV2ImageTo3dInput { + pub input_image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub textured_mesh: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub guidance_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub num_inference_steps: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub octree_resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3dV2ImageTo3dOutput {} + +pub fn hunyuan3d_v2_image_to_3d( + params: Hunyuan3dV2ImageTo3dInput, +) -> FalRequest { + FalRequest::new("fal-ai/hunyuan3d/v2", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_image_to_3d.rs b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_image_to_3d.rs new file mode 100644 index 00000000..ca582929 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_image_to_3d.rs @@ -0,0 +1,39 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3dV3ImageTo3dInput { + pub input_image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub back_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub left_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub right_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + /// Options: "Normal", "LowPoly", "Geometry" + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Options: "triangle", "quadrilateral" + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_type: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3dV3ImageTo3dOutput {} + +pub fn hunyuan3d_v3_image_to_3d( + params: Hunyuan3dV3ImageTo3dInput, +) -> FalRequest { + FalRequest::new("fal-ai/hunyuan3d-v3/image-to-3d", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_sketch_to_3d.rs b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_sketch_to_3d.rs new file mode 100644 index 00000000..306a2b17 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_sketch_to_3d.rs @@ -0,0 +1,32 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3dV3SketchTo3dInput { + pub prompt: String, + + pub input_image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + /// Options: "Normal", "LowPoly", "Geometry" + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Options: "triangle", "quadrilateral" + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_type: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3dV3SketchTo3dOutput {} + +pub fn hunyuan3d_v3_sketch_to_3d( + params: Hunyuan3dV3SketchTo3dInput, +) -> FalRequest { + FalRequest::new("fal-ai/hunyuan3d-v3/sketch-to-3d", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_text_to_3d.rs b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_text_to_3d.rs new file mode 100644 index 00000000..15073be2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/object/http_hunyuan3d_v3_text_to_3d.rs @@ -0,0 +1,30 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Hunyuan3dV3TextTo3dInput { + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub face_count: Option, + + /// Options: "Normal", "LowPoly", "Geometry" + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_type: Option, + + /// Options: "triangle", "quadrilateral" + #[serde(skip_serializing_if = "Option::is_none")] + pub polygon_type: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_pbr: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Hunyuan3dV3TextTo3dOutput {} + +pub fn hunyuan3d_v3_text_to_3d( + params: Hunyuan3dV3TextTo3dInput, +) -> FalRequest { + FalRequest::new("fal-ai/hunyuan3d-v3/text-to-3d", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/object/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/object/mod.rs new file mode 100644 index 00000000..b488ef9c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/object/mod.rs @@ -0,0 +1,5 @@ +pub mod http_hunyuan3d_v2_image_to_3d; +pub mod http_hunyuan3d_v21_image_to_3d; +pub mod http_hunyuan3d_v3_image_to_3d; +pub mod http_hunyuan3d_v3_sketch_to_3d; +pub mod http_hunyuan3d_v3_text_to_3d; diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_hailuo_v2p3_fast_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_hailuo_v2p3_fast_pro_image_to_video.rs new file mode 100644 index 00000000..da56711b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_hailuo_v2p3_fast_pro_image_to_video.rs @@ -0,0 +1,28 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct HailuoV2p3FastProImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt_optimizer: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct HailuoV2p3FastProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct HailuoV2p3FastProImageToVideoOutput { + pub video: HailuoV2p3FastProImageToVideoVideoFile, +} + +pub fn hailuo_v2p3_fast_pro_image_to_video( + params: HailuoV2p3FastProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/minimax/hailuo-2.3-fast/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_hailuo_v2p3_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_hailuo_v2p3_pro_image_to_video.rs new file mode 100644 index 00000000..da12f55b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_hailuo_v2p3_pro_image_to_video.rs @@ -0,0 +1,28 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct HailuoV2p3ProImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt_optimizer: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct HailuoV2p3ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct HailuoV2p3ProImageToVideoOutput { + pub video: HailuoV2p3ProImageToVideoVideoFile, +} + +pub fn hailuo_v2p3_pro_image_to_video( + params: HailuoV2p3ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/minimax/hailuo-2.3/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_3p0_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_3p0_pro_image_to_video.rs new file mode 100644 index 00000000..d6c2553d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_3p0_pro_image_to_video.rs @@ -0,0 +1,58 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling3p0ProImageToVideoInput { + pub prompt: String, + + /// Starting frame image URL + pub image_url: String, + + /// Optional end frame image URL + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Aspect ratio + /// Possible enum values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Generate audio + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "3" through "15" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Shot type for multi-shot video generation. + /// Possible enum values: "customize", "intelligent" + #[serde(skip_serializing_if = "Option::is_none")] + pub shot_type: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0ProImageToVideoOutput { + pub video: Kling3p0ProImageToVideoVideoFile, +} + +pub fn kling_3p0_pro_image_to_video( + params: Kling3p0ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v3/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_3p0_standard_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_3p0_standard_image_to_video.rs new file mode 100644 index 00000000..e4a18d28 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_3p0_standard_image_to_video.rs @@ -0,0 +1,58 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling3p0StandardImageToVideoInput { + pub prompt: String, + + /// Starting frame image URL + pub image_url: String, + + /// Optional end frame image URL + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Aspect ratio + /// Possible enum values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Generate audio + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "3" through "15" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Shot type for multi-shot video generation. + /// Possible enum values: "customize", "intelligent" + #[serde(skip_serializing_if = "Option::is_none")] + pub shot_type: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardImageToVideoOutput { + pub video: Kling3p0StandardImageToVideoVideoFile, +} + +pub fn kling_3p0_standard_image_to_video( + params: Kling3p0StandardImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v3/standard/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v1p6_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v1p6_pro_image_to_video.rs new file mode 100644 index 00000000..4b50d8f0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v1p6_pro_image_to_video.rs @@ -0,0 +1,42 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV1p6ProImageToVideoInput { + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub tail_image_url: Option, + + pub prompt: String, + + /// Options: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV1p6ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV1p6ProImageToVideoOutput { + pub video: KlingV1p6ProImageToVideoVideoFile, +} + +pub fn kling_v1p6_pro_image_to_video( + params: KlingV1p6ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v1.6/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p1_master_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p1_master_image_to_video.rs new file mode 100644 index 00000000..1bedb79f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p1_master_image_to_video.rs @@ -0,0 +1,42 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p1MasterImageToVideoInput { + pub image_url: String, + + pub prompt: String, + + /// Options: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub tail_image_url: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p1MasterImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p1MasterImageToVideoOutput { + pub video: KlingV2p1MasterImageToVideoVideoFile, +} + +pub fn kling_v2p1_master_image_to_video( + params: KlingV2p1MasterImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.1/master/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p1_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p1_pro_image_to_video.rs new file mode 100644 index 00000000..15162b61 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p1_pro_image_to_video.rs @@ -0,0 +1,42 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p1ProImageToVideoInput { + pub image_url: String, + + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub tail_image_url: Option, + + /// Options: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p1ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p1ProImageToVideoOutput { + pub video: KlingV2p1ProImageToVideoVideoFile, +} + +pub fn kling_v2p1_pro_image_to_video( + params: KlingV2p1ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.1/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p5_turbo_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p5_turbo_pro_image_to_video.rs new file mode 100644 index 00000000..c2ff7616 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p5_turbo_pro_image_to_video.rs @@ -0,0 +1,38 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p5TurboProImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub tail_image_url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p5TurboProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p5TurboProImageToVideoOutput { + pub video: KlingV2p5TurboProImageToVideoVideoFile, +} + +pub fn kling_v2p5_turbo_pro_image_to_video( + params: KlingV2p5TurboProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.5-turbo/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p5_turbo_standard_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p5_turbo_standard_image_to_video.rs new file mode 100644 index 00000000..47a4bcfe --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p5_turbo_standard_image_to_video.rs @@ -0,0 +1,35 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p5TurboStandardImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p5TurboStandardImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p5TurboStandardImageToVideoOutput { + pub video: KlingV2p5TurboStandardImageToVideoVideoFile, +} + +pub fn kling_v2p5_turbo_standard_image_to_video( + params: KlingV2p5TurboStandardImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.5-turbo/standard/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p6_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p6_pro_image_to_video.rs new file mode 100644 index 00000000..98d9e153 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_kling_v2p6_pro_image_to_video.rs @@ -0,0 +1,35 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p6ProImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p6ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p6ProImageToVideoOutput { + pub video: KlingV2p6ProImageToVideoVideoFile, +} + +pub fn kling_v2p6_pro_image_to_video( + params: KlingV2p6ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.6/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_pixverse_v5_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_pixverse_v5_image_to_video.rs new file mode 100644 index 00000000..6b6801ae --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_pixverse_v5_image_to_video.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct PixverseV5ImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + /// Options: "5", "8" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Options: "16:9", "4:3", "1:1", "3:4", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "360p", "540p", "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Options: "anime", "3d_animation", "clay", "comic", "cyberpunk" + #[serde(skip_serializing_if = "Option::is_none")] + pub style: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct PixverseV5ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct PixverseV5ImageToVideoOutput { + pub video: PixverseV5ImageToVideoVideoFile, +} + +pub fn pixverse_v5_image_to_video( + params: PixverseV5ImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/pixverse/v5/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1_lite_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1_lite_image_to_video.rs new file mode 100644 index 00000000..f4b2eb14 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1_lite_image_to_video.rs @@ -0,0 +1,48 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Seedance1LiteImageToVideoInput { + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + pub prompt: String, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "480p", "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Options: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub camera_fixed: Option, + + pub seed: i64, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1LiteImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1LiteImageToVideoOutput { + pub video: Seedance1LiteImageToVideoVideoFile, +} + +pub fn seedance_1_lite_image_to_video( + params: Seedance1LiteImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedance/v1/lite/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1_pro_image_to_video.rs new file mode 100644 index 00000000..81f7b9f9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1_pro_image_to_video.rs @@ -0,0 +1,39 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Seedance1ProImageToVideoInput { + pub image_url: String, + + pub prompt: String, + + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "480p", "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub camera_fixed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1ProImageToVideoOutput { + pub video: Seedance1ProImageToVideoVideoFile, +} + +pub fn seedance_1_pro_image_to_video( + params: Seedance1ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedance/v1/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1p5_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1p5_pro_image_to_video.rs new file mode 100644 index 00000000..6b0d175f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_seedance_1p5_pro_image_to_video.rs @@ -0,0 +1,63 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Seedance1p5ProImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + /// URL of the final frame (optional). + #[serde(skip_serializing_if = "Option::is_none")] + pub end_image_url: Option, + + /// Possible enum values: 480p, 720p, 1080p + /// Default value: "720p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Possible enum values: 21:9, 16:9, 4:3, 1:1, 3:4, 9:16, auto + /// Default value: "16:9" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds. + /// Possible enum values: 4, 5, 6, 7, 8, 9, 10, 11, 12 + /// Default value: "5" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Fix camera position during animation. + #[serde(skip_serializing_if = "Option::is_none")] + pub camera_fixed: Option, + + /// Random seed. Use -1 for random generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Enable content safety filtering. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Generate accompanying audio. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1p5ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1p5ProImageToVideoOutput { + pub video: Seedance1p5ProImageToVideoVideoFile, +} + +pub fn seedance_1p5_pro_image_to_video( + params: Seedance1p5ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedance/v1.5/pro/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_sora_2_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_sora_2_image_to_video.rs new file mode 100644 index 00000000..c016d990 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_sora_2_image_to_video.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Sora2ImageToVideoInput { + pub prompt: String, + + /// Starting frame image URL. + pub image_url: String, + + /// Possible enum values: auto, 720p + /// Default value: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Possible enum values: auto, 9:16, 16:9 + /// Default value: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds. + /// Possible enum values: 4, 8, 12 + /// Default value: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Whether to delete the video after generation for privacy reasons. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub delete_video: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2ImageToVideoOutput { + pub video: Sora2ImageToVideoVideoFile, +} + +pub fn sora_2_image_to_video( + params: Sora2ImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/sora-2/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_sora_2_pro_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_sora_2_pro_image_to_video.rs new file mode 100644 index 00000000..c15f6910 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_sora_2_pro_image_to_video.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Sora2ProImageToVideoInput { + pub prompt: String, + + /// Starting frame image URL. + pub image_url: String, + + /// Possible enum values: auto, 720p, 1080p + /// Default value: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Possible enum values: auto, 9:16, 16:9 + /// Default value: "auto" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds. + /// Possible enum values: 4, 8, 12 + /// Default value: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Whether to delete the video after generation for privacy reasons. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub delete_video: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2ProImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2ProImageToVideoOutput { + pub video: Sora2ProImageToVideoVideoFile, +} + +pub fn sora_2_pro_image_to_video( + params: Sora2ProImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/sora-2/image-to-video/pro", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_2_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_2_image_to_video.rs new file mode 100644 index 00000000..aeec5ec8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_2_image_to_video.rs @@ -0,0 +1,29 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo2ImageToVideoInput { + pub image_url: String, + + pub prompt: String, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2ImageToVideoOutput { + pub video: Veo2ImageToVideoVideoFile, +} + +pub fn veo_2_image_to_video( + params: Veo2ImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo2/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3_fast_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3_fast_image_to_video.rs new file mode 100644 index 00000000..e7531866 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3_fast_image_to_video.rs @@ -0,0 +1,40 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3FastImageToVideoInput { + pub image_url: String, + + pub prompt: String, + + /// Options: "auto", "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3FastImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3FastImageToVideoOutput { + pub video: Veo3FastImageToVideoVideoFile, +} + +pub fn veo_3_fast_image_to_video( + params: Veo3FastImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3/fast/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3_image_to_video.rs new file mode 100644 index 00000000..bd40b96a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3_image_to_video.rs @@ -0,0 +1,40 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3ImageToVideoInput { + pub image_url: String, + + pub prompt: String, + + /// Options: "auto", "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3ImageToVideoOutput { + pub video: Veo3ImageToVideoVideoFile, +} + +pub fn veo_3_image_to_video( + params: Veo3ImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_fast_first_last_frame_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_fast_first_last_frame_image_to_video.rs new file mode 100644 index 00000000..30385dfa --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_fast_first_last_frame_image_to_video.rs @@ -0,0 +1,42 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastFirstLastFrameImageToVideoInput { + pub prompt: String, + + pub first_frame_url: String, + + pub last_frame_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "auto", "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastFirstLastFrameImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastFirstLastFrameImageToVideoOutput { + pub video: Veo3p1FastFirstLastFrameImageToVideoVideoFile, +} + +pub fn veo_3p1_fast_first_last_frame_image_to_video( + params: Veo3p1FastFirstLastFrameImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3.1/fast/first-last-frame-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_fast_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_fast_image_to_video.rs new file mode 100644 index 00000000..c36635a3 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_fast_image_to_video.rs @@ -0,0 +1,40 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "auto", "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastImageToVideoOutput { + pub video: Veo3p1FastImageToVideoVideoFile, +} + +pub fn veo_3p1_fast_image_to_video( + params: Veo3p1FastImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3.1/fast/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_first_last_frame_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_first_last_frame_image_to_video.rs new file mode 100644 index 00000000..baa9aba1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_first_last_frame_image_to_video.rs @@ -0,0 +1,42 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FirstLastFrameImageToVideoInput { + pub prompt: String, + + pub first_frame_url: String, + + pub last_frame_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "auto", "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FirstLastFrameImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FirstLastFrameImageToVideoOutput { + pub video: Veo3p1FirstLastFrameImageToVideoVideoFile, +} + +pub fn veo_3p1_first_last_frame_image_to_video( + params: Veo3p1FirstLastFrameImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3.1/first-last-frame-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_image_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_image_to_video.rs new file mode 100644 index 00000000..0cdcf08c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/http_veo_3p1_image_to_video.rs @@ -0,0 +1,40 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1ImageToVideoInput { + pub prompt: String, + + pub image_url: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "auto", "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ImageToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1ImageToVideoOutput { + pub video: Veo3p1ImageToVideoVideoFile, +} + +pub fn veo_3p1_image_to_video( + params: Veo3p1ImageToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3.1/image-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/image/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/video/image/mod.rs new file mode 100644 index 00000000..e0165baf --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/image/mod.rs @@ -0,0 +1,23 @@ +pub mod http_hailuo_v2p3_fast_pro_image_to_video; +pub mod http_hailuo_v2p3_pro_image_to_video; +pub mod http_kling_3p0_pro_image_to_video; +pub mod http_kling_3p0_standard_image_to_video; +pub mod http_kling_v1p6_pro_image_to_video; +pub mod http_kling_v2p1_master_image_to_video; +pub mod http_kling_v2p1_pro_image_to_video; +pub mod http_kling_v2p5_turbo_pro_image_to_video; +pub mod http_kling_v2p5_turbo_standard_image_to_video; +pub mod http_kling_v2p6_pro_image_to_video; +pub mod http_pixverse_v5_image_to_video; +pub mod http_seedance_1_lite_image_to_video; +pub mod http_seedance_1_pro_image_to_video; +pub mod http_seedance_1p5_pro_image_to_video; +pub mod http_sora_2_image_to_video; +pub mod http_sora_2_pro_image_to_video; +pub mod http_veo_2_image_to_video; +pub mod http_veo_3_fast_image_to_video; +pub mod http_veo_3_image_to_video; +pub mod http_veo_3p1_fast_first_last_frame_image_to_video; +pub mod http_veo_3p1_fast_image_to_video; +pub mod http_veo_3p1_first_last_frame_image_to_video; +pub mod http_veo_3p1_image_to_video; diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/video/mod.rs new file mode 100644 index 00000000..ab1ed425 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/mod.rs @@ -0,0 +1,2 @@ +pub mod image; +pub mod text; diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_hailuo_v2p3_pro_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_hailuo_v2p3_pro_text_to_video.rs new file mode 100644 index 00000000..23f96dd9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_hailuo_v2p3_pro_text_to_video.rs @@ -0,0 +1,26 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct HailuoV2p3ProTextToVideoInput { + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub prompt_optimizer: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct HailuoV2p3ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct HailuoV2p3ProTextToVideoOutput { + pub video: HailuoV2p3ProTextToVideoVideoFile, +} + +pub fn hailuo_v2p3_pro_text_to_video( + params: HailuoV2p3ProTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/minimax/hailuo-2.3/pro/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_3p0_pro_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_3p0_pro_text_to_video.rs new file mode 100644 index 00000000..436764d2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_3p0_pro_text_to_video.rs @@ -0,0 +1,51 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling3p0ProTextToVideoInput { + pub prompt: String, + + /// Aspect ratio + /// Possible enum values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Generate audio + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "3" through "15" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Shot type for multi-shot video generation. + /// Possible enum values: "customize", "intelligent" + #[serde(skip_serializing_if = "Option::is_none")] + pub shot_type: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0ProTextToVideoOutput { + pub video: Kling3p0ProTextToVideoVideoFile, +} + +pub fn kling_3p0_pro_text_to_video( + params: Kling3p0ProTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v3/pro/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_3p0_standard_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_3p0_standard_text_to_video.rs new file mode 100644 index 00000000..82f38ee4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_3p0_standard_text_to_video.rs @@ -0,0 +1,51 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Kling3p0StandardTextToVideoInput { + pub prompt: String, + + /// Aspect ratio + /// Possible enum values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Generate audio + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "3" through "15" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Shot type for multi-shot video generation. + /// Possible enum values: "customize", "intelligent" + #[serde(skip_serializing_if = "Option::is_none")] + pub shot_type: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Kling3p0StandardTextToVideoOutput { + pub video: Kling3p0StandardTextToVideoVideoFile, +} + +pub fn kling_3p0_standard_text_to_video( + params: Kling3p0StandardTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v3/standard/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_v2p5_turbo_pro_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_v2p5_turbo_pro_text_to_video.rs new file mode 100644 index 00000000..7bcfaf94 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_v2p5_turbo_pro_text_to_video.rs @@ -0,0 +1,41 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p5TurboProTextToVideoInput { + pub prompt: String, + + /// Possible enum values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p5TurboProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p5TurboProTextToVideoOutput { + pub video: KlingV2p5TurboProTextToVideoVideoFile, +} + +pub fn kling_v2p5_turbo_pro_text_to_video( + params: KlingV2p5TurboProTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.5-turbo/pro/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_v2p6_pro_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_v2p6_pro_text_to_video.rs new file mode 100644 index 00000000..906c1b98 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_kling_v2p6_pro_text_to_video.rs @@ -0,0 +1,45 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct KlingV2p6ProTextToVideoInput { + pub prompt: String, + + /// Possible enum values: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Generate audio + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "5", "10" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// The CFG (Classifier Free Guidance) scale. + /// Default value: 0.5 + #[serde(skip_serializing_if = "Option::is_none")] + pub cfg_scale: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p6ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct KlingV2p6ProTextToVideoOutput { + pub video: KlingV2p6ProTextToVideoVideoFile, +} + +pub fn kling_v2p6_pro_text_to_video( + params: KlingV2p6ProTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/kling-video/v2.6/pro/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_pixverse_v5_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_pixverse_v5_text_to_video.rs new file mode 100644 index 00000000..8585cebb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_pixverse_v5_text_to_video.rs @@ -0,0 +1,47 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct PixverseV5TextToVideoInput { + pub prompt: String, + + /// Options: "360p", "540p", "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Options: "16:9", "4:3", "1:1", "3:4", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Duration in seconds + /// Options: "5", "8" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Options: "anime", "3d_animation", "clay", "comic", "cyberpunk" + #[serde(skip_serializing_if = "Option::is_none")] + pub style: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct PixverseV5TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct PixverseV5TextToVideoOutput { + pub video: PixverseV5TextToVideoVideoFile, +} + +pub fn pixverse_v5_text_to_video( + params: PixverseV5TextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/pixverse/v5/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_seedance_1p5_pro_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_seedance_1p5_pro_text_to_video.rs new file mode 100644 index 00000000..d020eee0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_seedance_1p5_pro_text_to_video.rs @@ -0,0 +1,57 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Seedance1p5ProTextToVideoInput { + pub prompt: String, + + /// Possible enum values: 480p, 720p, 1080p + /// Default value: "720p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Possible enum values: 21:9, 16:9, 4:3, 1:1, 3:4, 9:16, auto + /// Default value: "16:9" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds. + /// Possible enum values: 4, 5, 6, 7, 8, 9, 10, 11, 12 + /// Default value: "5" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Fix camera position during animation. + #[serde(skip_serializing_if = "Option::is_none")] + pub camera_fixed: Option, + + /// Random seed. Use -1 for random generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Enable content safety filtering. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub enable_safety_checker: Option, + + /// Generate accompanying audio. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1p5ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance1p5ProTextToVideoOutput { + pub video: Seedance1p5ProTextToVideoVideoFile, +} + +pub fn seedance_1p5_pro_text_to_video( + params: Seedance1p5ProTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/bytedance/seedance/v1.5/pro/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_sora_2_pro_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_sora_2_pro_text_to_video.rs new file mode 100644 index 00000000..d522eca0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_sora_2_pro_text_to_video.rs @@ -0,0 +1,44 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Sora2ProTextToVideoInput { + pub prompt: String, + + /// Possible enum values: 720p, 1080p + /// Default value: "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Possible enum values: 9:16, 16:9 + /// Default value: "16:9" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds. + /// Possible enum values: 4, 8, 12 + /// Default value: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Whether to delete the video after generation for privacy reasons. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub delete_video: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2ProTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2ProTextToVideoOutput { + pub video: Sora2ProTextToVideoVideoFile, +} + +pub fn sora_2_pro_text_to_video( + params: Sora2ProTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/sora-2/text-to-video/pro", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_sora_2_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_sora_2_text_to_video.rs new file mode 100644 index 00000000..ae4709fb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_sora_2_text_to_video.rs @@ -0,0 +1,44 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Sora2TextToVideoInput { + pub prompt: String, + + /// Possible enum values: 720p + /// Default value: "720p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Possible enum values: 9:16, 16:9 + /// Default value: "16:9" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds. + /// Possible enum values: 4, 8, 12 + /// Default value: 4 + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Whether to delete the video after generation for privacy reasons. + /// Default value: true + #[serde(skip_serializing_if = "Option::is_none")] + pub delete_video: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Sora2TextToVideoOutput { + pub video: Sora2TextToVideoVideoFile, +} + +pub fn sora_2_text_to_video( + params: Sora2TextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/sora-2/text-to-video", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_2_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_2_text_to_video.rs new file mode 100644 index 00000000..5b61bce5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_2_text_to_video.rs @@ -0,0 +1,34 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo2TextToVideoInput { + pub prompt: String, + + /// Options: "16:9", "9:16", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "5s", "6s", "7s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo2TextToVideoOutput { + pub video: Veo2TextToVideoVideoFile, +} + +pub fn veo_2_text_to_video( + params: Veo2TextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo2", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3_text_to_video.rs new file mode 100644 index 00000000..63c93d10 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3_text_to_video.rs @@ -0,0 +1,41 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3TextToVideoInput { + pub prompt: String, + + /// Options: "16:9", "9:16" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3TextToVideoOutput { + pub video: Veo3TextToVideoVideoFile, +} + +pub fn veo_3_text_to_video( + params: Veo3TextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3p1_fast_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3p1_fast_text_to_video.rs new file mode 100644 index 00000000..192ad369 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3p1_fast_text_to_video.rs @@ -0,0 +1,51 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1FastTextToVideoInput { + pub prompt: String, + + /// Options: "auto", "9:16", "16:9", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enhance_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastTextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1FastTextToVideoOutput { + pub video: Veo3p1FastTextToVideoVideoFile, +} + +pub fn veo_3p1_fast_text_to_video( + params: Veo3p1FastTextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3.1/fast", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3p1_text_to_video.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3p1_text_to_video.rs new file mode 100644 index 00000000..6c52b1cb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/http_veo_3p1_text_to_video.rs @@ -0,0 +1,51 @@ +use crate::requests::core_api::fal_request::FalRequest; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Serialize, Deserialize, Default)] +pub struct Veo3p1TextToVideoInput { + pub prompt: String, + + /// Options: "auto", "9:16", "16:9", "1:1" + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Options: "4s", "6s", "8s" + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Optional negative prompt + #[serde(skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub enhance_prompt: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub auto_fix: Option, + + /// Options: "720p", "1080p" + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1TextToVideoVideoFile { + pub url: String, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct Veo3p1TextToVideoOutput { + pub video: Veo3p1TextToVideoVideoFile, +} + +pub fn veo_3p1_text_to_video( + params: Veo3p1TextToVideoInput, +) -> FalRequest { + FalRequest::new("fal-ai/veo3.1", params) +} diff --git a/crates/api_clients/fal_client/src/requests_old/http/video/text/mod.rs b/crates/api_clients/fal_client/src/requests_old/http/video/text/mod.rs new file mode 100644 index 00000000..03891ea1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/http/video/text/mod.rs @@ -0,0 +1,13 @@ +pub mod http_hailuo_v2p3_pro_text_to_video; +pub mod http_kling_3p0_pro_text_to_video; +pub mod http_kling_3p0_standard_text_to_video; +pub mod http_kling_v2p5_turbo_pro_text_to_video; +pub mod http_kling_v2p6_pro_text_to_video; +pub mod http_pixverse_v5_text_to_video; +pub mod http_seedance_1p5_pro_text_to_video; +pub mod http_sora_2_pro_text_to_video; +pub mod http_sora_2_text_to_video; +pub mod http_veo_2_text_to_video; +pub mod http_veo_3_text_to_video; +pub mod http_veo_3p1_fast_text_to_video; +pub mod http_veo_3p1_text_to_video; diff --git a/crates/api_clients/fal_client/src/requests_old/mod.rs b/crates/api_clients/fal_client/src/requests_old/mod.rs new file mode 100644 index 00000000..5a7eeb3c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/mod.rs @@ -0,0 +1,2 @@ +pub mod http; +pub mod webhook; diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/enqueue_flux_2_lora_edit_image_angle_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/enqueue_flux_2_lora_edit_image_angle_webhook.rs new file mode 100644 index 00000000..8ea94e14 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/enqueue_flux_2_lora_edit_image_angle_webhook.rs @@ -0,0 +1,189 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::angle::http_flux_2_lora_edit_image_angle::{http_flux_2_lora_edit_image_angle, Flux2LoraEditImageAngleInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueFlux2LoraEditImageAngleArgs<'a, R: IntoUrl> { + pub request: EnqueueFlux2LoraEditImageAngleRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueFlux2LoraEditImageAngleRequest { + // Request required + pub image_urls: Vec, + + // Camera parameters + pub horizontal_angle: Option, + pub vertical_angle: Option, + pub zoom: Option, + + // Optional args + pub num_images: Option, + pub image_size: Option, + pub lora_scale: Option, + pub guidance_scale: Option, + pub num_inference_steps: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueFlux2LoraAngleNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueFlux2LoraAngleImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, +} + +impl FalRequestCostCalculator for EnqueueFlux2LoraEditImageAngleRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.021 per megapixel. + // For a 1024x1024 image (~1 MP), that's ~2 cents per image. + let unit_cost = 2; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueFlux2LoraAngleNumImages::One) => unit_cost, + Some(EnqueueFlux2LoraAngleNumImages::Two) => unit_cost * 2, + Some(EnqueueFlux2LoraAngleNumImages::Three) => unit_cost * 3, + Some(EnqueueFlux2LoraAngleNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_flux_2_lora_edit_image_angle_webhook( + args: EnqueueFlux2LoraEditImageAngleArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = req.num_images + .map(|n| match n { + EnqueueFlux2LoraAngleNumImages::One => 1, + EnqueueFlux2LoraAngleNumImages::Two => 2, + EnqueueFlux2LoraAngleNumImages::Three => 3, + EnqueueFlux2LoraAngleNumImages::Four => 4, + }); + + let image_size = req.image_size + .map(|s| match s { + EnqueueFlux2LoraAngleImageSize::Square => "square", + EnqueueFlux2LoraAngleImageSize::SquareHd => "square_hd", + EnqueueFlux2LoraAngleImageSize::PortraitFourThree => "portrait_4_3", + EnqueueFlux2LoraAngleImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueFlux2LoraAngleImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueFlux2LoraAngleImageSize::LandscapeSixteenNine => "landscape_16_9", + }) + .map(|s| s.to_string()); + + let request = Flux2LoraEditImageAngleInput { + image_urls: req.image_urls, + horizontal_angle: req.horizontal_angle, + vertical_angle: req.vertical_angle, + zoom: req.zoom, + lora_scale: req.lora_scale, + image_size, + guidance_scale: req.guidance_scale, + num_inference_steps: req.num_inference_steps, + num_images, + // Constants + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + // Unused + seed: None, + }; + + let result = http_flux_2_lora_edit_image_angle(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::angle::enqueue_flux_2_lora_edit_image_angle_webhook::{enqueue_flux_2_lora_edit_image_angle_webhook, EnqueueFlux2LoraEditImageAngleArgs, EnqueueFlux2LoraEditImageAngleRequest, EnqueueFlux2LoraAngleNumImages, EnqueueFlux2LoraAngleImageSize}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test_single() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueFlux2LoraEditImageAngleArgs { + request: EnqueueFlux2LoraEditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(15.0), + zoom: Some(5.0), + num_images: Some(EnqueueFlux2LoraAngleNumImages::One), + image_size: Some(EnqueueFlux2LoraAngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_flux_2_lora_edit_image_angle_webhook(args).await?; + Ok(()) + } + + /// Enqueues 27 angle combinations: 3 horizontal x 3 vertical x 3 zoom levels. + #[tokio::test] + #[ignore] + async fn test_angle_grid() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let horizontal_angles: [f64; 3] = [-45.0, 0.0, 45.0]; + let vertical_angles: [f64; 3] = [-30.0, 0.0, 30.0]; + let zoom_levels: [f64; 3] = [0.0, 1.0, 3.0]; + + for &h in &horizontal_angles { + for &v in &vertical_angles { + for &z in &zoom_levels { + let args = EnqueueFlux2LoraEditImageAngleArgs { + request: EnqueueFlux2LoraEditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(h), + vertical_angle: Some(v), + zoom: Some(z), + num_images: Some(EnqueueFlux2LoraAngleNumImages::One), + image_size: Some(EnqueueFlux2LoraAngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_flux_2_lora_edit_image_angle_webhook(args).await?; + println!("Enqueued: h={}, v={}, z={}", h, v, z); + } + } + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/enqueue_qwen_edit_2511_edit_image_angle_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/enqueue_qwen_edit_2511_edit_image_angle_webhook.rs new file mode 100644 index 00000000..b3886455 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/enqueue_qwen_edit_2511_edit_image_angle_webhook.rs @@ -0,0 +1,196 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::angle::http_qwen_edit_2511_edit_image_angle::{http_qwen_edit_2511_edit_image_angle, QwenEdit2511EditImageAngleInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueQwenEdit2511EditImageAngleArgs<'a, R: IntoUrl> { + pub request: EnqueueQwenEdit2511EditImageAngleRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueQwenEdit2511EditImageAngleRequest { + // Request required + pub image_urls: Vec, + + // Camera parameters + pub horizontal_angle: Option, + pub vertical_angle: Option, + pub zoom: Option, + + // Optional args + pub additional_prompt: Option, + pub num_images: Option, + pub image_size: Option, + pub lora_scale: Option, + pub guidance_scale: Option, + pub num_inference_steps: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueQwenEdit2511AngleNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueQwenEdit2511AngleImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, +} + +impl FalRequestCostCalculator for EnqueueQwenEdit2511EditImageAngleRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.035 per megapixel. + // For a 1024x1024 image (~1 MP), that's ~4 cents per image. + let unit_cost = 4; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueQwenEdit2511AngleNumImages::One) => unit_cost, + Some(EnqueueQwenEdit2511AngleNumImages::Two) => unit_cost * 2, + Some(EnqueueQwenEdit2511AngleNumImages::Three) => unit_cost * 3, + Some(EnqueueQwenEdit2511AngleNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_qwen_edit_2511_edit_image_angle_webhook( + args: EnqueueQwenEdit2511EditImageAngleArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = req.num_images + .map(|n| match n { + EnqueueQwenEdit2511AngleNumImages::One => 1, + EnqueueQwenEdit2511AngleNumImages::Two => 2, + EnqueueQwenEdit2511AngleNumImages::Three => 3, + EnqueueQwenEdit2511AngleNumImages::Four => 4, + }); + + let image_size = req.image_size + .map(|s| match s { + EnqueueQwenEdit2511AngleImageSize::Square => "square", + EnqueueQwenEdit2511AngleImageSize::SquareHd => "square_hd", + EnqueueQwenEdit2511AngleImageSize::PortraitFourThree => "portrait_4_3", + EnqueueQwenEdit2511AngleImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueQwenEdit2511AngleImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueQwenEdit2511AngleImageSize::LandscapeSixteenNine => "landscape_16_9", + }) + .map(|s| s.to_string()); + + let request = QwenEdit2511EditImageAngleInput { + image_urls: req.image_urls, + horizontal_angle: req.horizontal_angle, + vertical_angle: req.vertical_angle, + zoom: req.zoom, + additional_prompt: req.additional_prompt, + lora_scale: req.lora_scale, + image_size, + guidance_scale: req.guidance_scale, + num_inference_steps: req.num_inference_steps, + num_images, + // Constants + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + // Unused + negative_prompt: None, + seed: None, + }; + + let result = http_qwen_edit_2511_edit_image_angle(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::angle::enqueue_qwen_edit_2511_edit_image_angle_webhook::{enqueue_qwen_edit_2511_edit_image_angle_webhook, EnqueueQwenEdit2511EditImageAngleArgs, EnqueueQwenEdit2511EditImageAngleRequest, EnqueueQwenEdit2511AngleNumImages, EnqueueQwenEdit2511AngleImageSize}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test_single() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueQwenEdit2511EditImageAngleArgs { + request: EnqueueQwenEdit2511EditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(15.0), + zoom: Some(5.0), + additional_prompt: Some("cinematic lighting".to_string()), + num_images: Some(EnqueueQwenEdit2511AngleNumImages::One), + image_size: Some(EnqueueQwenEdit2511AngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_qwen_edit_2511_edit_image_angle_webhook(args).await?; + Ok(()) + } + + /// Enqueues 9 angle combinations: 3 horizontal x 3 vertical x 3 zoom levels. + /// Each combination generates one image, for a total of 27 enqueued requests. + #[tokio::test] + #[ignore] + async fn test_angle_grid() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let horizontal_angles: [f64; 3] = [-45.0, 0.0, 45.0]; + let vertical_angles: [f64; 3] = [-30.0, 0.0, 30.0]; + let zoom_levels: [f64; 3] = [0.0, 1.0, 3.0]; + + for &h in &horizontal_angles { + for &v in &vertical_angles { + for &z in &zoom_levels { + let args = EnqueueQwenEdit2511EditImageAngleArgs { + request: EnqueueQwenEdit2511EditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(h), + vertical_angle: Some(v), + zoom: Some(z), + additional_prompt: None, + num_images: Some(EnqueueQwenEdit2511AngleNumImages::One), + image_size: Some(EnqueueQwenEdit2511AngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_qwen_edit_2511_edit_image_angle_webhook(args).await?; + println!("Enqueued: h={}, v={}, z={}", h, v, z); + } + } + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/mod.rs new file mode 100644 index 00000000..6cf5971a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/angle/mod.rs @@ -0,0 +1,2 @@ +pub mod enqueue_flux_2_lora_edit_image_angle_webhook; +pub mod enqueue_qwen_edit_2511_edit_image_angle_webhook; diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/background/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/background/mod.rs new file mode 100644 index 00000000..ce42b624 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/background/mod.rs @@ -0,0 +1 @@ +pub mod remove_background_rembg_webhook; diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/background/remove_background_rembg_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/background/remove_background_rembg_webhook.rs new file mode 100644 index 00000000..7c291fa8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/background/remove_background_rembg_webhook.rs @@ -0,0 +1,68 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::background::http_rembg_remove_background::{rembg_remove_background, RembgRemoveBackgroundInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct RemoveBackgroundRembgWebhookArgs<'a, V: IntoUrl> { + pub request: RemoveBackgroundRembgWebhookRequest, + pub webhook_url: V, + pub api_key: &'a FalApiKey +} + +#[derive(Clone, Debug)] +pub struct RemoveBackgroundRembgWebhookRequest { + pub image_url: String, +} + +pub async fn remove_background_rembg_webhook( + args: RemoveBackgroundRembgWebhookArgs<'_, V> +) -> Result { + + let req = args.request; + + let request = RembgRemoveBackgroundInput { + image_url: req.image_url, + crop_to_bbox: None, + sync_mode: None + }; + + let result = rembg_remove_background(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::background::remove_background_rembg_webhook::remove_background_rembg_webhook; + use crate::requests_old::webhook::image::background::remove_background_rembg_webhook::{RemoveBackgroundRembgWebhookArgs, RemoveBackgroundRembgWebhookRequest}; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] // NB: Manually test, don't run in CI! + async fn test() -> anyhow::Result<()> { + // XXX: Don't commit secrets! + let api_key = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&api_key); + + let args = RemoveBackgroundRembgWebhookArgs { + request: RemoveBackgroundRembgWebhookRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + }, + webhook_url: "https://api.storyteller.ai/webhook", + api_key: &api_key, + }; + + let response = remove_background_rembg_webhook(args).await?; + + println!("{:?}", response); + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v4_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v4_edit_image_webhook.rs new file mode 100644 index 00000000..287cca08 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v4_edit_image_webhook.rs @@ -0,0 +1,149 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_seedream_4_edit_image::{seedream_4_edit_image, SeedreamV4EditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueBytedanceSeedreamV4EditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueBytedanceSeedreamV4EditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueBytedanceSeedreamV4EditImageRequest { + pub prompt: String, + pub image_urls: Vec, + pub num_images: Option, + pub max_images: Option, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4EditImageMaxImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4EditImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, + Auto, + Auto2k, + Auto4k, +} + +impl FalRequestCostCalculator for EnqueueBytedanceSeedreamV4EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.03 per image. + let unit_cost = 3; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::One) => unit_cost, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Two) => unit_cost * 2, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Three) => unit_cost * 3, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_bytedance_seedream_v4_edit_image_webhook( + args: EnqueueBytedanceSeedreamV4EditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = req.num_images + .map(|n| match n { + EnqueueBytedanceSeedreamV4EditImageNumImages::One => 1, + EnqueueBytedanceSeedreamV4EditImageNumImages::Two => 2, + EnqueueBytedanceSeedreamV4EditImageNumImages::Three => 3, + EnqueueBytedanceSeedreamV4EditImageNumImages::Four => 4, + }); + + let max_images = req.max_images + .map(|n| match n { + EnqueueBytedanceSeedreamV4EditImageMaxImages::One => 1, + EnqueueBytedanceSeedreamV4EditImageMaxImages::Two => 2, + EnqueueBytedanceSeedreamV4EditImageMaxImages::Three => 3, + EnqueueBytedanceSeedreamV4EditImageMaxImages::Four => 4, + }); + + let image_size = req.image_size + .map(|s| match s { + EnqueueBytedanceSeedreamV4EditImageSize::Square => "square", + EnqueueBytedanceSeedreamV4EditImageSize::SquareHd => "square_hd", + EnqueueBytedanceSeedreamV4EditImageSize::PortraitFourThree => "portrait_4_3", + EnqueueBytedanceSeedreamV4EditImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueBytedanceSeedreamV4EditImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueBytedanceSeedreamV4EditImageSize::LandscapeSixteenNine => "landscape_16_9", + EnqueueBytedanceSeedreamV4EditImageSize::Auto => "auto", + EnqueueBytedanceSeedreamV4EditImageSize::Auto2k => "auto_2K", + EnqueueBytedanceSeedreamV4EditImageSize::Auto4k => "auto_4K", + }) + .map(|s| s.to_string()); + + let input = SeedreamV4EditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images, + max_images, + image_size, + enhance_prompt_mode: Some("standard".to_string()), + enable_safety_checker: Some(false), + }; + + seedream_4_edit_image(input) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await + .map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueBytedanceSeedreamV4EditImageArgs { + request: EnqueueBytedanceSeedreamV4EditImageRequest { + prompt: "add the ghost to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![GHOST_IMAGE_URL.to_string(), TREX_SKELETON_IMAGE_URL.to_string()], + num_images: Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Two), + max_images: Some(EnqueueBytedanceSeedreamV4EditImageMaxImages::Two), + image_size: Some(EnqueueBytedanceSeedreamV4EditImageSize::Auto2k), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_bytedance_seedream_v4_edit_image_webhook(args).await?; + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v4p5_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v4p5_edit_image_webhook.rs new file mode 100644 index 00000000..b6746c44 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v4p5_edit_image_webhook.rs @@ -0,0 +1,147 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_seedream_4p5_edit_image::{seedream_4p5_edit_image, SeedreamV4p5EditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueBytedanceSeedreamV4p5EditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueBytedanceSeedreamV4p5EditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueBytedanceSeedreamV4p5EditImageRequest { + pub prompt: String, + pub image_urls: Vec, + pub num_images: Option, + pub max_images: Option, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4p5EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4p5EditImageMaxImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4p5EditImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, + Auto2k, + Auto4k, +} + +impl FalRequestCostCalculator for EnqueueBytedanceSeedreamV4p5EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.04 per image. + let unit_cost = 4; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::One) => unit_cost, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Two) => unit_cost * 2, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Three) => unit_cost * 3, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_bytedance_seedream_v4p5_edit_image_webhook( + args: EnqueueBytedanceSeedreamV4p5EditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = req.num_images + .map(|n| match n { + EnqueueBytedanceSeedreamV4p5EditImageNumImages::One => 1, + EnqueueBytedanceSeedreamV4p5EditImageNumImages::Two => 2, + EnqueueBytedanceSeedreamV4p5EditImageNumImages::Three => 3, + EnqueueBytedanceSeedreamV4p5EditImageNumImages::Four => 4, + }); + + let max_images = req.max_images + .map(|n| match n { + EnqueueBytedanceSeedreamV4p5EditImageMaxImages::One => 1, + EnqueueBytedanceSeedreamV4p5EditImageMaxImages::Two => 2, + EnqueueBytedanceSeedreamV4p5EditImageMaxImages::Three => 3, + EnqueueBytedanceSeedreamV4p5EditImageMaxImages::Four => 4, + }); + + let image_size = req.image_size + .map(|s| match s { + EnqueueBytedanceSeedreamV4p5EditImageSize::Square => "square", + EnqueueBytedanceSeedreamV4p5EditImageSize::SquareHd => "square_hd", + EnqueueBytedanceSeedreamV4p5EditImageSize::PortraitFourThree => "portrait_4_3", + EnqueueBytedanceSeedreamV4p5EditImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueBytedanceSeedreamV4p5EditImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueBytedanceSeedreamV4p5EditImageSize::LandscapeSixteenNine => "landscape_16_9", + EnqueueBytedanceSeedreamV4p5EditImageSize::Auto2k => "auto_2K", + EnqueueBytedanceSeedreamV4p5EditImageSize::Auto4k => "auto_4K", + }) + .map(|s| s.to_string()); + + let input = SeedreamV4p5EditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images, + max_images, + image_size, + enable_safety_checker: Some(false), + seed: None, + }; + + seedream_4p5_edit_image(input) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await + .map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueBytedanceSeedreamV4p5EditImageArgs { + request: EnqueueBytedanceSeedreamV4p5EditImageRequest { + prompt: "add the ghost to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![GHOST_IMAGE_URL.to_string(), TREX_SKELETON_IMAGE_URL.to_string()], + num_images: Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Two), + max_images: Some(EnqueueBytedanceSeedreamV4p5EditImageMaxImages::Two), + image_size: Some(EnqueueBytedanceSeedreamV4p5EditImageSize::Auto2k), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_bytedance_seedream_v4p5_edit_image_webhook(args).await?; + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v5_lite_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v5_lite_edit_image_webhook.rs new file mode 100644 index 00000000..7fb7724a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_bytedance_seedream_v5_lite_edit_image_webhook.rs @@ -0,0 +1,146 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::edit::http_seedream_5_edit_image::{http_seedream_5_edit_image, SeedreamV5LiteEditImageInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueBytedanceSeedreamV5LiteEditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueBytedanceSeedreamV5LiteEditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueBytedanceSeedreamV5LiteEditImageRequest { + pub prompt: String, + pub image_urls: Vec, + pub num_images: Option, + pub max_images: Option, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV5LiteEditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV5LiteEditImageMaxImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV5LiteEditImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, + Auto2k, + Auto3k, // NB: v5 uses auto_3K instead of v4's auto_4K +} + +impl FalRequestCostCalculator for EnqueueBytedanceSeedreamV5LiteEditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // TODO(bt): Verify actual pricing for Seedream v5 Lite on fal.ai. + let unit_cost = 4; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::One) => unit_cost, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Two) => unit_cost * 2, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Three) => unit_cost * 3, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_bytedance_seedream_v5_lite_edit_image_webhook( + args: EnqueueBytedanceSeedreamV5LiteEditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = req.num_images + .map(|n| match n { + EnqueueBytedanceSeedreamV5LiteEditImageNumImages::One => 1, + EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Two => 2, + EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Three => 3, + EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Four => 4, + }); + + let max_images = req.max_images + .map(|n| match n { + EnqueueBytedanceSeedreamV5LiteEditImageMaxImages::One => 1, + EnqueueBytedanceSeedreamV5LiteEditImageMaxImages::Two => 2, + EnqueueBytedanceSeedreamV5LiteEditImageMaxImages::Three => 3, + EnqueueBytedanceSeedreamV5LiteEditImageMaxImages::Four => 4, + }); + + let image_size = req.image_size + .map(|s| match s { + EnqueueBytedanceSeedreamV5LiteEditImageSize::Square => "square", + EnqueueBytedanceSeedreamV5LiteEditImageSize::SquareHd => "square_hd", + EnqueueBytedanceSeedreamV5LiteEditImageSize::PortraitFourThree => "portrait_4_3", + EnqueueBytedanceSeedreamV5LiteEditImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueBytedanceSeedreamV5LiteEditImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueBytedanceSeedreamV5LiteEditImageSize::LandscapeSixteenNine => "landscape_16_9", + EnqueueBytedanceSeedreamV5LiteEditImageSize::Auto2k => "auto_2K", + EnqueueBytedanceSeedreamV5LiteEditImageSize::Auto3k => "auto_3K", + }) + .map(|s| s.to_string()); + + let input = SeedreamV5LiteEditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images, + max_images, + image_size, + enable_safety_checker: Some(false), + }; + + http_seedream_5_edit_image(input) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await + .map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueBytedanceSeedreamV5LiteEditImageArgs { + request: EnqueueBytedanceSeedreamV5LiteEditImageRequest { + prompt: "add the ghost to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![GHOST_IMAGE_URL.to_string(), TREX_SKELETON_IMAGE_URL.to_string()], + num_images: Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Two), + max_images: Some(EnqueueBytedanceSeedreamV5LiteEditImageMaxImages::Two), + image_size: Some(EnqueueBytedanceSeedreamV5LiteEditImageSize::Auto2k), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_bytedance_seedream_v5_lite_edit_image_webhook(args).await?; + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_1_dev_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_1_dev_edit_image_webhook.rs new file mode 100644 index 00000000..4861a47d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_1_dev_edit_image_webhook.rs @@ -0,0 +1,110 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::edit::http_flux_1_dev_edit_image::{flux_1_dev_edit_image, Flux1DevEditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Flux1DevEditImageArgs<'a, U: IntoUrl> { + pub request: Flux1DevEditImageRequest, + pub webhook_url: U, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Flux1DevEditImageRequest { + pub prompt: String, + pub image_url: String, + pub num_images: Flux1DevEditImageNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1DevEditImageNumImages { + One, + Two, + Three, + Four, +} + +pub async fn enqueue_flux_1_dev_edit_image_webhook( + args: Flux1DevEditImageArgs<'_, U> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + Flux1DevEditImageNumImages::One => 1, + Flux1DevEditImageNumImages::Two => 2, + Flux1DevEditImageNumImages::Three => 3, + Flux1DevEditImageNumImages::Four => 4, + }; + + let request = Flux1DevEditImageInput { + prompt: req.prompt, + image_url: req.image_url, + num_images: Some(num_images), + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + ..Default::default() + }; + + let result = flux_1_dev_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_flux_1_dev_edit_image_webhook::{ + enqueue_flux_1_dev_edit_image_webhook, Flux1DevEditImageArgs, Flux1DevEditImageNumImages, + Flux1DevEditImageRequest, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::GHOST_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real Fal API request + async fn test_single_image() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Flux1DevEditImageArgs { + request: Flux1DevEditImageRequest { + prompt: "make this image look like a watercolor painting".to_string(), + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1DevEditImageNumImages::One, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_1_dev_edit_image_webhook(args).await?; + assert!(result.request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real Fal API request + async fn test_batch_two() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Flux1DevEditImageArgs { + request: Flux1DevEditImageRequest { + prompt: "turn this into a cyberpunk scene with neon lights".to_string(), + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1DevEditImageNumImages::Two, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_1_dev_edit_image_webhook(args).await?; + assert!(result.request_id.is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_1_schnell_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_1_schnell_edit_image_webhook.rs new file mode 100644 index 00000000..d04d679f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_1_schnell_edit_image_webhook.rs @@ -0,0 +1,129 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::edit::http_flux_1_schnell_edit_image::{flux_1_schnell_edit_image, Flux1SchnellEditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Flux1SchnellEditImageArgs<'a, U: IntoUrl> { + pub request: Flux1SchnellEditImageRequest, + pub webhook_url: U, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Flux1SchnellEditImageRequest { + pub image_url: String, + pub num_images: Flux1SchnellEditImageNumImages, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellEditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellEditImageSize { + Square, + SquareHd, + LandscapeFourByThree, + LandscapeSixteenByNine, + PortraitThreeByFour, + PortraitNineBySixteen, +} + +pub async fn enqueue_flux_1_schnell_edit_image_webhook( + args: Flux1SchnellEditImageArgs<'_, U> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + Flux1SchnellEditImageNumImages::One => 1, + Flux1SchnellEditImageNumImages::Two => 2, + Flux1SchnellEditImageNumImages::Three => 3, + Flux1SchnellEditImageNumImages::Four => 4, + }; + + let image_size = req.image_size.map(|s| match s { + Flux1SchnellEditImageSize::Square => "square", + Flux1SchnellEditImageSize::SquareHd => "square_hd", + Flux1SchnellEditImageSize::LandscapeFourByThree => "landscape_4_3", + Flux1SchnellEditImageSize::LandscapeSixteenByNine => "landscape_16_9", + Flux1SchnellEditImageSize::PortraitThreeByFour => "portrait_4_3", + Flux1SchnellEditImageSize::PortraitNineBySixteen => "portrait_16_9", + }.to_string()); + + let request = Flux1SchnellEditImageInput { + image_url: req.image_url, + num_images: Some(num_images), + image_size, + enable_safety_checker: Some(false), + output_format: Some("png".to_string()), + ..Default::default() + }; + + let result = flux_1_schnell_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_flux_1_schnell_edit_image_webhook::{ + enqueue_flux_1_schnell_edit_image_webhook, Flux1SchnellEditImageArgs, + Flux1SchnellEditImageNumImages, Flux1SchnellEditImageRequest, Flux1SchnellEditImageSize, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::GHOST_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real Fal API request + async fn test_single_image_no_size() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Flux1SchnellEditImageArgs { + request: Flux1SchnellEditImageRequest { + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1SchnellEditImageNumImages::One, + image_size: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_1_schnell_edit_image_webhook(args).await?; + assert!(result.request_id.is_some()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real Fal API request + async fn test_with_landscape_size() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Flux1SchnellEditImageArgs { + request: Flux1SchnellEditImageRequest { + image_url: GHOST_IMAGE_URL.to_string(), + num_images: Flux1SchnellEditImageNumImages::Two, + image_size: Some(Flux1SchnellEditImageSize::LandscapeSixteenByNine), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_1_schnell_edit_image_webhook(args).await?; + assert!(result.request_id.is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_pro_kontext_max_edit_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_pro_kontext_max_edit_webhook.rs new file mode 100644 index 00000000..99640985 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_flux_pro_kontext_max_edit_webhook.rs @@ -0,0 +1,94 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::edit::http_flux_pro_kontext_max_edit::{flux_pro_kontext_max_edit, FluxProKontextMaxEditInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct FluxProKontextMaxArgs<'a, R: IntoUrl> { + pub request: FluxProKontextMaxRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct FluxProKontextMaxRequest { + pub prompt: String, + pub image_url: String, + pub num_images: FluxProKontextMaxNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum FluxProKontextMaxNumImages { + One, // Default + Two, + Three, + Four, +} + +pub async fn enqueue_flux_pro_kontext_max_edit_webhook( + args: FluxProKontextMaxArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + FluxProKontextMaxNumImages::One => 1, + FluxProKontextMaxNumImages::Two => 2, + FluxProKontextMaxNumImages::Three => 3, + FluxProKontextMaxNumImages::Four => 4, + }; + + let request = FluxProKontextMaxEditInput { + prompt: req.prompt, + image_url: req.image_url, + num_images: Some(num_images), + + // Maybe expose + aspect_ratio: None, + safety_tolerance: Some("5".to_string()), // NB: 5 is most tolerant + output_format: Some("png".to_string()), // png or jpeg + seed: None, + + // Constants + sync_mode: None, // Synchronous / slow + }; + + let result = flux_pro_kontext_max_edit(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_flux_pro_kontext_max_edit_webhook::{enqueue_flux_pro_kontext_max_edit_webhook, FluxProKontextMaxArgs, FluxProKontextMaxNumImages, FluxProKontextMaxRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TALL_MOCHI_WITH_GLASSES_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = FluxProKontextMaxArgs { + request: FluxProKontextMaxRequest { + prompt: "turn the glasses into sunglasses, make them sleek sunglasses with black rims, square shaped".to_string(), + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + num_images: FluxProKontextMaxNumImages::One, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_pro_kontext_max_edit_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gemini_25_flash_edit_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gemini_25_flash_edit_webhook.rs new file mode 100644 index 00000000..848677c5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gemini_25_flash_edit_webhook.rs @@ -0,0 +1,151 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_gemini_25_flash_edit::{gemini_25_flash_edit, Gemini25FlashEditInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Gemini25FlashEditArgs<'a, R: IntoUrl> { + pub request: Gemini25FlashEditRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Gemini25FlashEditRequest { + pub prompt: String, + pub image_urls: Vec, + pub num_images: Gemini25FlashEditNumImages, + + // Optional + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Gemini25FlashEditNumImages { + One, + Two, + Three, + Four, +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +/// Default is "auto" +#[derive(Copy, Clone, Debug)] +pub enum Gemini25FlashEditAspectRatio { + // Automatic (default) + Auto, + // Square + OneByOne, + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, // NB: No NineByTwentyOne ? +} + + +impl FalRequestCostCalculator for Gemini25FlashEditRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.039 per image. For $1.00, you can run this model 25 times. + match self.num_images { + Gemini25FlashEditNumImages::One => 4, + Gemini25FlashEditNumImages::Two => 8, + Gemini25FlashEditNumImages::Three => 12, + Gemini25FlashEditNumImages::Four => 16, + } + } +} + + +pub async fn enqueue_gemini_25_flash_edit_webhook( + args: Gemini25FlashEditArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + Gemini25FlashEditNumImages::One => 1, + Gemini25FlashEditNumImages::Two => 2, + Gemini25FlashEditNumImages::Three => 3, + Gemini25FlashEditNumImages::Four => 4, + }; + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + // Auto + Gemini25FlashEditAspectRatio::Auto => "auto", + // Square + Gemini25FlashEditAspectRatio::OneByOne => "1:1", + // Wide + Gemini25FlashEditAspectRatio::FiveByFour => "5:4", + Gemini25FlashEditAspectRatio::FourByThree => "4:3", + Gemini25FlashEditAspectRatio::ThreeByTwo => "3:2", + Gemini25FlashEditAspectRatio::SixteenByNine => "16:9", + Gemini25FlashEditAspectRatio::TwentyOneByNine => "21:9", + // Tall + Gemini25FlashEditAspectRatio::FourByFive => "4:5", + Gemini25FlashEditAspectRatio::ThreeByFour => "3:4", + Gemini25FlashEditAspectRatio::TwoByThree => "2:3", + Gemini25FlashEditAspectRatio::NineBySixteen => "9:16", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let request = Gemini25FlashEditInput { + prompt: req.prompt, + image_urls: req.image_urls, + aspect_ratio, + // Constants + num_images: Some(num_images), + output_format: Some("png".to_string()), + }; + + let result = gemini_25_flash_edit(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::{enqueue_gemini_25_flash_edit_webhook, Gemini25FlashEditArgs, Gemini25FlashEditNumImages, Gemini25FlashEditRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Gemini25FlashEditArgs { + request: Gemini25FlashEditRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ], + num_images: Gemini25FlashEditNumImages::Two, + aspect_ratio: None, + prompt: "add the ghost to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_gemini_25_flash_edit_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1_byok_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1_byok_edit_image_webhook.rs new file mode 100644 index 00000000..224bb738 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1_byok_edit_image_webhook.rs @@ -0,0 +1,166 @@ +//! Deprecated BYOK (bring-your-own-OpenAI-key) edit-image binding for +//! `fal-ai/gpt-image-1/edit-image/byok`. The non-BYOK replacement lives in +//! `enqueue_gpt_image_1_edit_image_webhook.rs`. Kept for the legacy +//! `gpt_image_1_edit_image_handler` storyteller-web endpoint. + +use crate::creds::fal_api_key::FalApiKey; +use crate::creds::open_ai_api_key::OpenAiApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_gpt_image_1_byok_edit_image::{gpt_image_1_byok_edit_image, GptImage1ByokEditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct GptEditImageByokArgs<'a, V: IntoUrl> { + pub request: GptEditImageByokRequest, + + // Fulfillment + pub api_key: &'a FalApiKey, + pub openai_api_key: &'a OpenAiApiKey, + pub webhook_url: V, +} + +#[derive(Clone, Debug)] +pub struct GptEditImageByokRequest { + pub image_urls: Vec, + pub prompt: String, + pub image_size: GptEditImageSize, + pub num_images: GptEditImageNumImages, + pub quality: GptEditImageQuality, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptEditImageSize { + Auto, + Square, + Horizontal, + Vertical, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptEditImageQuality { + Auto, + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptEditImageNumImages{ + One, + Two, + Three, + Four, +} + + +// NB: These are BYOK, so they're not Fal's prices +impl FalRequestCostCalculator for GptEditImageByokRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + let base_cost = match self.quality { + GptEditImageQuality::Auto => 17, + GptEditImageQuality::Low => 1, + GptEditImageQuality::Medium => 4, + GptEditImageQuality::High => 17, + }; + let cost = match self.num_images { + GptEditImageNumImages::One => base_cost, + GptEditImageNumImages::Two => base_cost * 2, + GptEditImageNumImages::Three => base_cost * 3, + GptEditImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_gpt_image_1_byok_edit_image_webhook( + args: GptEditImageByokArgs<'_, V> +) -> Result { + let req = args.request; + + let image_size = match req.image_size { + GptEditImageSize::Auto => "auto", + GptEditImageSize::Square => "1024x1024", + GptEditImageSize::Horizontal => "1536x1024", + GptEditImageSize::Vertical => "1024x1536", + }; + + let quality = match req.quality { + GptEditImageQuality::Auto => "auto", + GptEditImageQuality::Low => "low", + GptEditImageQuality::Medium => "medium", + GptEditImageQuality::High => "high", + }; + + let num_images = match req.num_images { + GptEditImageNumImages::One => 1, + GptEditImageNumImages::Two => 2, + GptEditImageNumImages::Three => 3, + GptEditImageNumImages::Four => 4, + }; + + let request = GptImage1ByokEditImageInput { + image_urls: req.image_urls, + prompt: req.prompt, + image_size: image_size.to_string(), + num_images, + quality: quality.to_string(), + openai_api_key: args.openai_api_key.0.to_string(), + }; + + let result = gpt_image_1_byok_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::creds::open_ai_api_key::OpenAiApiKey; + use crate::requests_old::webhook::image::edit::enqueue_gpt_image_1_byok_edit_image_webhook::{ + enqueue_gpt_image_1_byok_edit_image_webhook, GptEditImageByokArgs, GptEditImageByokRequest, + GptEditImageNumImages, GptEditImageQuality, GptEditImageSize, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ + ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL, + }; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let fal_secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let fal_api_key = FalApiKey::from_str(&fal_secret); + + let openai_secret = read_to_string("/Users/bt/Artcraft/credentials/openai_api_key.txt")?; + let openai_api_key = OpenAiApiKey::from_str(&openai_secret); + + let args = GptEditImageByokArgs { + request: GptEditImageByokRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_size: GptEditImageSize::Horizontal, + num_images: GptEditImageNumImages::One, + quality: GptEditImageQuality::High, + }, + api_key: &fal_api_key, + openai_api_key: &openai_api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_gpt_image_1_byok_edit_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1_edit_image_webhook.rs new file mode 100644 index 00000000..87ce6fc1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1_edit_image_webhook.rs @@ -0,0 +1,240 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::core_api::webhook_response::WebhookResponse; +use crate::requests_old::http::image::edit::http_gpt_image_1_edit_image::{ + gpt_image_1_edit_image, GptImage1EditImageInput, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{ + FalRequestCostCalculator, UsdCents, +}; +use reqwest::IntoUrl; + +/// Typed args for the non-BYOK `fal-ai/gpt-image-1/edit-image` endpoint. +/// +/// (The BYOK variant lives in `enqueue_gpt_image_1_byok_edit_image_webhook.rs` +/// and is deprecated.) +pub struct EnqueueGptImage1EditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueGptImage1EditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueGptImage1EditImageRequest { + // Required + pub prompt: String, + pub image_urls: Vec, + pub num_images: EnqueueGptImage1EditImageNumImages, + + // Optional + pub mask_image_url: Option, + pub image_size: Option, + pub quality: Option, + pub input_fidelity: Option, + pub background: Option, + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1EditImageSize { + Auto, + /// 1024x1024 + Square, + /// 1536x1024 + Horizontal, + /// 1024x1536 + Vertical, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1EditImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1EditImageInputFidelity { + Low, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1EditImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1EditImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalRequestCostCalculator for EnqueueGptImage1EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Per fal docs (fal-ai/gpt-image-1/edit-image), pricing matches + // text-to-image (input image tokens are billed separately and not included + // in this base estimate): + // Low: $0.011 (1024x1024) / $0.016 (other) per image + // Medium: $0.042 (1024x1024) / $0.063 (other) per image + // High: $0.167 (1024x1024) / $0.25 (other) per image + let use_quality = self + .quality + .unwrap_or(EnqueueGptImage1EditImageQuality::Medium); + let is_square = matches!( + self.image_size, + None | Some(EnqueueGptImage1EditImageSize::Square) | Some(EnqueueGptImage1EditImageSize::Auto) + ); + let base_cost: u64 = match (use_quality, is_square) { + (EnqueueGptImage1EditImageQuality::Low, true) => 2, + (EnqueueGptImage1EditImageQuality::Low, false) => 2, + (EnqueueGptImage1EditImageQuality::Medium, true) => 5, + (EnqueueGptImage1EditImageQuality::Medium, false) => 7, + (EnqueueGptImage1EditImageQuality::High, true) => 17, + (EnqueueGptImage1EditImageQuality::High, false) => 25, + }; + let n: u64 = match self.num_images { + EnqueueGptImage1EditImageNumImages::One => 1, + EnqueueGptImage1EditImageNumImages::Two => 2, + EnqueueGptImage1EditImageNumImages::Three => 3, + EnqueueGptImage1EditImageNumImages::Four => 4, + }; + base_cost * n + } +} + +pub async fn enqueue_gpt_image_1_edit_image_webhook( + args: EnqueueGptImage1EditImageArgs<'_, R>, +) -> Result { + let req = args.request; + + let num_images: u8 = match req.num_images { + EnqueueGptImage1EditImageNumImages::One => 1, + EnqueueGptImage1EditImageNumImages::Two => 2, + EnqueueGptImage1EditImageNumImages::Three => 3, + EnqueueGptImage1EditImageNumImages::Four => 4, + }; + + let image_size = req.image_size.map(|s| { + match s { + EnqueueGptImage1EditImageSize::Auto => "auto", + EnqueueGptImage1EditImageSize::Square => "1024x1024", + EnqueueGptImage1EditImageSize::Horizontal => "1536x1024", + EnqueueGptImage1EditImageSize::Vertical => "1024x1536", + } + .to_string() + }); + + let quality = req.quality.map(|q| { + match q { + EnqueueGptImage1EditImageQuality::Low => "low", + EnqueueGptImage1EditImageQuality::Medium => "medium", + EnqueueGptImage1EditImageQuality::High => "high", + } + .to_string() + }); + + let input_fidelity = req.input_fidelity.map(|f| { + match f { + EnqueueGptImage1EditImageInputFidelity::Low => "low", + EnqueueGptImage1EditImageInputFidelity::High => "high", + } + .to_string() + }); + + let background = req.background.map(|b| { + match b { + EnqueueGptImage1EditImageBackground::Auto => "auto", + EnqueueGptImage1EditImageBackground::Transparent => "transparent", + EnqueueGptImage1EditImageBackground::Opaque => "opaque", + } + .to_string() + }); + + let output_format = req.output_format.map(|f| { + match f { + EnqueueGptImage1EditImageOutputFormat::Jpeg => "jpeg", + EnqueueGptImage1EditImageOutputFormat::Png => "png", + EnqueueGptImage1EditImageOutputFormat::Webp => "webp", + } + .to_string() + }); + + let request = GptImage1EditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + mask_image_url: req.mask_image_url, + num_images: Some(num_images), + image_size, + quality, + input_fidelity, + background, + output_format, + }; + + let result = gpt_image_1_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_gpt_image_1_edit_image_webhook::{ + enqueue_gpt_image_1_edit_image_webhook, EnqueueGptImage1EditImageArgs, + EnqueueGptImage1EditImageNumImages, EnqueueGptImage1EditImageQuality, + EnqueueGptImage1EditImageRequest, EnqueueGptImage1EditImageSize, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ + ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL, + }; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueGptImage1EditImageArgs { + request: EnqueueGptImage1EditImageRequest { + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + num_images: EnqueueGptImage1EditImageNumImages::One, + mask_image_url: None, + image_size: Some(EnqueueGptImage1EditImageSize::Horizontal), + quality: Some(EnqueueGptImage1EditImageQuality::Medium), + input_fidelity: None, + background: None, + output_format: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_gpt_image_1_edit_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1p5_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1p5_edit_image_webhook.rs new file mode 100644 index 00000000..c0e62bef --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_1p5_edit_image_webhook.rs @@ -0,0 +1,218 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_gpt_image_1p5_edit_image::{gpt_image_1p5_edit_image, GptImage1p5EditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueGptImage1p5EditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueGptImage1p5EditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueGptImage1p5EditImageRequest { + // Required + pub prompt: String, + pub image_urls: Vec, + pub num_images: EnqueueGptImage1p5EditImageNumImages, + + // Optional + pub mask_image_url: Option, + pub image_size: Option, + pub background: Option, + pub quality: Option, + pub input_fidelity: Option, + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5EditImageSize { + /// 1024x1024 + Square, + /// 1536x1024 + Wide, + /// 1024x1536 + Tall, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5EditImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5EditImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5EditImageInputFidelity { + Low, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5EditImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalRequestCostCalculator for EnqueueGptImage1p5EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost different amounts based on the number of images, quality, and size. + // For low quality, you will be charged $0.009 for 1024x1024 or $0.013 for any other size per image. + // For medium quality, you will be charged $0.034 for 1024x1024, $0.051 for 1024x1536 and $0.050 for 1536x1024 per image. + // For high quality, you will be charged $0.133 for 1024x1024, $0.200 for 1024x1536 or $0.199 for 1536x1024 per image. + let use_quality = self.quality.unwrap_or(EnqueueGptImage1p5EditImageQuality::Medium); + let use_size = self.image_size.unwrap_or(EnqueueGptImage1p5EditImageSize::Square); + let base_cost = match (use_quality, use_size) { + (EnqueueGptImage1p5EditImageQuality::Low, EnqueueGptImage1p5EditImageSize::Square) => 1, + (EnqueueGptImage1p5EditImageQuality::Low, _) => 1, + (EnqueueGptImage1p5EditImageQuality::Medium, EnqueueGptImage1p5EditImageSize::Square) => 3, + (EnqueueGptImage1p5EditImageQuality::Medium, _) => 5, + (EnqueueGptImage1p5EditImageQuality::High, EnqueueGptImage1p5EditImageSize::Square) => 13, + (EnqueueGptImage1p5EditImageQuality::High, _) => 20, + }; + let cost = match self.num_images { + EnqueueGptImage1p5EditImageNumImages::One => base_cost, + EnqueueGptImage1p5EditImageNumImages::Two => base_cost * 2, + EnqueueGptImage1p5EditImageNumImages::Three => base_cost * 3, + EnqueueGptImage1p5EditImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_gpt_image_1p5_image_edit_webhook( + args: EnqueueGptImage1p5EditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + EnqueueGptImage1p5EditImageNumImages::One => 1, + EnqueueGptImage1p5EditImageNumImages::Two => 2, + EnqueueGptImage1p5EditImageNumImages::Three => 3, + EnqueueGptImage1p5EditImageNumImages::Four => 4, + }; + + let image_size = req.image_size + .map(|s| match s { + EnqueueGptImage1p5EditImageSize::Square => "1024x1024", + EnqueueGptImage1p5EditImageSize::Wide => "1536x1024", + EnqueueGptImage1p5EditImageSize::Tall => "1024x1536", + }) + .map(|resolution| resolution.to_string()); + + let background = req.background + .map(|s| match s { + EnqueueGptImage1p5EditImageBackground::Auto => "auto", + EnqueueGptImage1p5EditImageBackground::Transparent => "transparent", + EnqueueGptImage1p5EditImageBackground::Opaque => "opaque", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let quality = req.quality + .map(|s| match s { + EnqueueGptImage1p5EditImageQuality::Low => "low", + EnqueueGptImage1p5EditImageQuality::Medium => "medium", + EnqueueGptImage1p5EditImageQuality::High => "high", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let input_fidelity = req.input_fidelity + .map(|s| match s { + EnqueueGptImage1p5EditImageInputFidelity::Low => "low", + EnqueueGptImage1p5EditImageInputFidelity::High => "high", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let output_format = req.output_format + .map(|s| match s { + EnqueueGptImage1p5EditImageOutputFormat::Jpeg => "jpeg", + EnqueueGptImage1p5EditImageOutputFormat::Png => "png", + EnqueueGptImage1p5EditImageOutputFormat::Webp => "webp", + }) + .map(|aspect_ratio| aspect_ratio.to_string()) + .unwrap_or_else(|| "png".to_string()); + + let request = GptImage1p5EditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images: Some(num_images), + output_format: Some(output_format), + // Optionals + mask_image_url: req.mask_image_url, + image_size, + background, + quality, + input_fidelity, + }; + + let result = gpt_image_1p5_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_gpt_image_1p5_edit_image_webhook::{ + enqueue_gpt_image_1p5_image_edit_webhook, EnqueueGptImage1p5EditImageArgs, + EnqueueGptImage1p5EditImageNumImages, EnqueueGptImage1p5EditImageRequest, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueGptImage1p5EditImageArgs { + request: EnqueueGptImage1p5EditImageRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + num_images: EnqueueGptImage1p5EditImageNumImages::Two, + mask_image_url: None, + image_size: None, + background: None, + quality: None, + input_fidelity: None, + output_format: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_gpt_image_1p5_image_edit_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_2_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_2_edit_image_webhook.rs new file mode 100644 index 00000000..c6642cee --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_gpt_image_2_edit_image_webhook.rs @@ -0,0 +1,205 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_gpt_image_2_edit_image::{gpt_image_2_edit_image, GptImage2EditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; +use crate::requests_old::webhook::image::edit::enqueue_gpt_image_2_edit_image_webhook::EnqueueGptImage2EditImageQuality::{High, Medium}; +use crate::requests_old::webhook::image::edit::enqueue_gpt_image_2_edit_image_webhook::EnqueueGptImage2EditImageSize::SquareHd; + +pub struct EnqueueGptImage2EditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueGptImage2EditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueGptImage2EditImageRequest { + // Required + pub prompt: String, + pub image_urls: Vec, + pub num_images: EnqueueGptImage2EditImageNumImages, + + // Optional + pub mask_url: Option, + pub image_size: Option, + pub quality: Option, + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2EditImageSize { + SquareHd, + Square, + Portrait4x3, + Portrait16x9, + Landscape4x3, + Landscape16x9, + Auto, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2EditImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2EditImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalRequestCostCalculator for EnqueueGptImage2EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Cost table (per image) by approximate pixel dimensions: + // + // landscape_4_3 (~1024x768): low=$0.01, medium=$0.04, high=$0.15 + // square (~1024x1024): low=$0.01, medium=$0.06, high=$0.22 + // portrait_4_3 (~768x1024): low=$0.01, medium=$0.04, high=$0.15 + // landscape_16_9(~1920x1080): low=$0.01, medium=$0.04, high=$0.16 + // portrait_16_9 (~1080x1920): low=$0.01, medium=$0.04, high=$0.16 + // square_hd (~2048x2048): low=$0.01, medium=$0.06, high=$0.23 + // auto (varies): estimated as square + let use_quality = self.quality.unwrap_or(EnqueueGptImage2EditImageQuality::High); + let use_size = self.image_size.unwrap_or(EnqueueGptImage2EditImageSize::Square); + + use EnqueueGptImage2EditImageQuality::*; + use EnqueueGptImage2EditImageSize::*; + + let base_cost = match (use_quality, use_size) { + (Low, _) => 1, + (Medium, Landscape4x3 | Portrait4x3 | Landscape16x9 | Portrait16x9) => 4, + (Medium, Square) => 6, + (Medium, SquareHd) => 6, + (Medium, Auto) => 6, // TODO(bt): Unknown + (High, Landscape4x3 | Portrait4x3) => 15, + (High, Landscape16x9 | Portrait16x9) => 16, + (High, Square) => 22, + (High, SquareHd) => 23, + (High, Auto) => 23, // TODO(bt): Unknown + }; + + let cost = match self.num_images { + EnqueueGptImage2EditImageNumImages::One => base_cost, + EnqueueGptImage2EditImageNumImages::Two => base_cost * 2, + EnqueueGptImage2EditImageNumImages::Three => base_cost * 3, + EnqueueGptImage2EditImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_gpt_image_2_edit_image_webhook( + args: EnqueueGptImage2EditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + EnqueueGptImage2EditImageNumImages::One => 1, + EnqueueGptImage2EditImageNumImages::Two => 2, + EnqueueGptImage2EditImageNumImages::Three => 3, + EnqueueGptImage2EditImageNumImages::Four => 4, + }; + + let image_size = req.image_size + .map(|s| match s { + EnqueueGptImage2EditImageSize::SquareHd => "square_hd", + EnqueueGptImage2EditImageSize::Square => "square", + EnqueueGptImage2EditImageSize::Portrait4x3 => "portrait_4_3", + EnqueueGptImage2EditImageSize::Portrait16x9 => "portrait_16_9", + EnqueueGptImage2EditImageSize::Landscape4x3 => "landscape_4_3", + EnqueueGptImage2EditImageSize::Landscape16x9 => "landscape_16_9", + EnqueueGptImage2EditImageSize::Auto => "auto", + }) + .map(|size| size.to_string()); + + let quality = req.quality + .map(|s| match s { + EnqueueGptImage2EditImageQuality::Low => "low", + EnqueueGptImage2EditImageQuality::Medium => "medium", + EnqueueGptImage2EditImageQuality::High => "high", + }) + .map(|quality| quality.to_string()); + + let output_format = req.output_format + .map(|s| match s { + EnqueueGptImage2EditImageOutputFormat::Jpeg => "jpeg", + EnqueueGptImage2EditImageOutputFormat::Png => "png", + EnqueueGptImage2EditImageOutputFormat::Webp => "webp", + }) + .map(|format| format.to_string()) + .unwrap_or_else(|| "png".to_string()); + + let request = GptImage2EditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images: Some(num_images), + output_format: Some(output_format), + // Optionals + mask_url: req.mask_url, + image_size, + quality, + }; + + let result = gpt_image_2_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_gpt_image_2_edit_image_webhook::{ + enqueue_gpt_image_2_edit_image_webhook, EnqueueGptImage2EditImageArgs, + EnqueueGptImage2EditImageNumImages, EnqueueGptImage2EditImageRequest, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueGptImage2EditImageArgs { + request: EnqueueGptImage2EditImageRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + num_images: EnqueueGptImage2EditImageNumImages::Two, + mask_url: None, + image_size: None, + quality: None, + output_format: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_gpt_image_2_edit_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_nano_banana_2_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_nano_banana_2_edit_image_webhook.rs new file mode 100644 index 00000000..9777f4c5 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_nano_banana_2_edit_image_webhook.rs @@ -0,0 +1,218 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::edit::http_nano_banana_2_edit_image::{nano_banana_2_edit_image, NanoBanana2EditImageInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueNanoBanana2EditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueNanoBanana2EditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueNanoBanana2EditImageRequest { + // Required + pub prompt: String, + pub image_urls: Vec, + pub num_images: EnqueueNanoBanana2EditImageNumImages, + + // Optional + pub resolution: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBanana2EditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBanana2EditImageResolution { + HalfK, // "0.5K" + OneK, // "1K" (default) + TwoK, // "2K" + FourK, // "4K" +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +/// Default: "auto" +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBanana2EditImageAspectRatio { + // Automatic (default) + Auto, + // Square + OneByOne, + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + +impl FalRequestCostCalculator for EnqueueNanoBanana2EditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // TODO(bt): Verify actual pricing for Nano Banana 2 on fal.ai. + // 4K outputs may be charged at double the standard rate. + let cost = match self.resolution { + None => 15, + Some(EnqueueNanoBanana2EditImageResolution::HalfK) => 8, + Some(EnqueueNanoBanana2EditImageResolution::OneK) => 15, + Some(EnqueueNanoBanana2EditImageResolution::TwoK) => 15, + Some(EnqueueNanoBanana2EditImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + EnqueueNanoBanana2EditImageNumImages::One => cost, + EnqueueNanoBanana2EditImageNumImages::Two => cost * 2, + EnqueueNanoBanana2EditImageNumImages::Three => cost * 3, + EnqueueNanoBanana2EditImageNumImages::Four => cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_nano_banana_2_edit_image_webhook( + args: EnqueueNanoBanana2EditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + EnqueueNanoBanana2EditImageNumImages::One => 1, + EnqueueNanoBanana2EditImageNumImages::Two => 2, + EnqueueNanoBanana2EditImageNumImages::Three => 3, + EnqueueNanoBanana2EditImageNumImages::Four => 4, + }; + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueNanoBanana2EditImageResolution::HalfK => "0.5K", + EnqueueNanoBanana2EditImageResolution::OneK => "1K", + EnqueueNanoBanana2EditImageResolution::TwoK => "2K", + EnqueueNanoBanana2EditImageResolution::FourK => "4K", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + // Auto + EnqueueNanoBanana2EditImageAspectRatio::Auto => "auto", + // Square + EnqueueNanoBanana2EditImageAspectRatio::OneByOne => "1:1", + // Wide + EnqueueNanoBanana2EditImageAspectRatio::FiveByFour => "5:4", + EnqueueNanoBanana2EditImageAspectRatio::FourByThree => "4:3", + EnqueueNanoBanana2EditImageAspectRatio::ThreeByTwo => "3:2", + EnqueueNanoBanana2EditImageAspectRatio::SixteenByNine => "16:9", + EnqueueNanoBanana2EditImageAspectRatio::TwentyOneByNine => "21:9", + // Tall + EnqueueNanoBanana2EditImageAspectRatio::FourByFive => "4:5", + EnqueueNanoBanana2EditImageAspectRatio::ThreeByFour => "3:4", + EnqueueNanoBanana2EditImageAspectRatio::TwoByThree => "2:3", + EnqueueNanoBanana2EditImageAspectRatio::NineBySixteen => "9:16", + }) + .map(|ar| ar.to_string()); + + let request = NanoBanana2EditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images: Some(num_images), + // Optionals + aspect_ratio, + resolution, + // Constants + output_format: Some("png".to_string()), + safety_tolerance: Some("6".to_string()), + limit_generations: None, + enable_web_search: None, + seed: None, + }; + + let result = nano_banana_2_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_nano_banana_2_edit_image_webhook::{ + enqueue_nano_banana_2_edit_image_webhook, EnqueueNanoBanana2EditImageArgs, + EnqueueNanoBanana2EditImageAspectRatio, EnqueueNanoBanana2EditImageNumImages, + EnqueueNanoBanana2EditImageRequest, EnqueueNanoBanana2EditImageResolution, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL, WHITE_HOUSE_SUNSET_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueNanoBanana2EditImageArgs { + request: EnqueueNanoBanana2EditImageRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + num_images: EnqueueNanoBanana2EditImageNumImages::Two, + aspect_ratio: Some(EnqueueNanoBanana2EditImageAspectRatio::SixteenByNine), + resolution: Some(EnqueueNanoBanana2EditImageResolution::TwoK), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_nano_banana_2_edit_image_webhook(args).await?; + + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_2() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueNanoBanana2EditImageArgs { + request: EnqueueNanoBanana2EditImageRequest { + image_urls: vec![ + WHITE_HOUSE_SUNSET_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "Put the scared man and the t-rex in front of the white house scene. Make the man afraid of the t-rex.".to_string(), + num_images: EnqueueNanoBanana2EditImageNumImages::Two, + aspect_ratio: Some(EnqueueNanoBanana2EditImageAspectRatio::SixteenByNine), + resolution: Some(EnqueueNanoBanana2EditImageResolution::TwoK), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_nano_banana_2_edit_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_nano_banana_pro_edit_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_nano_banana_pro_edit_image_webhook.rs new file mode 100644 index 00000000..3dcb3410 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_nano_banana_pro_edit_image_webhook.rs @@ -0,0 +1,181 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_nano_banana_pro_edit_image::{nano_banana_pro_edit_image, NanoBananaProEditImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueNanoBananaProEditImageArgs<'a, R: IntoUrl> { + pub request: EnqueueNanoBananaProEditImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueNanoBananaProEditImageRequest { + pub prompt: String, + pub image_urls: Vec, + pub num_images: EnqueueNanoBananaProEditImageNumImages, + + // Optional args + pub resolution: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBananaProEditImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBananaProEditImageResolution { + OneK, // Default value "1K" + TwoK, + FourK, +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +/// Default is "auto" +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBananaProEditImageAspectRatio { + // Automatic (default) + Auto, + // Square + OneByOne, + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, // NB: No NineByTwentyOne ? +} + + +impl FalRequestCostCalculator for EnqueueNanoBananaProEditImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.15 per image. + // For $1.00, you can run this model 7 times. + // 4K outputs will be charged at double the standard rate. + // If web search is used, an additional $0.015 will be charged. + // Note: Pricing may change in the future. + let cost = match self.resolution { + None => 15, + Some(EnqueueNanoBananaProEditImageResolution::OneK) => 15, + Some(EnqueueNanoBananaProEditImageResolution::TwoK) => 15, + Some(EnqueueNanoBananaProEditImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + EnqueueNanoBananaProEditImageNumImages::One => cost, + EnqueueNanoBananaProEditImageNumImages::Two => cost * 2, + EnqueueNanoBananaProEditImageNumImages::Three => cost * 3, + EnqueueNanoBananaProEditImageNumImages::Four => cost * 4, + }; + cost as UsdCents + } +} + +pub async fn enqueue_nano_banana_pro_image_edit_webhook( + args: EnqueueNanoBananaProEditImageArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = match req.num_images { + EnqueueNanoBananaProEditImageNumImages::One => 1, + EnqueueNanoBananaProEditImageNumImages::Two => 2, + EnqueueNanoBananaProEditImageNumImages::Three => 3, + EnqueueNanoBananaProEditImageNumImages::Four => 4, + }; + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueNanoBananaProEditImageResolution::OneK => "1K", + EnqueueNanoBananaProEditImageResolution::TwoK => "2K", + EnqueueNanoBananaProEditImageResolution::FourK => "4K", + }) + .map(|resolution| resolution.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + // Auto + EnqueueNanoBananaProEditImageAspectRatio::Auto => "auto", + // Square + EnqueueNanoBananaProEditImageAspectRatio::OneByOne => "1:1", + // Wide + EnqueueNanoBananaProEditImageAspectRatio::FiveByFour => "5:4", + EnqueueNanoBananaProEditImageAspectRatio::FourByThree => "4:3", + EnqueueNanoBananaProEditImageAspectRatio::ThreeByTwo => "3:2", + EnqueueNanoBananaProEditImageAspectRatio::SixteenByNine => "16:9", + EnqueueNanoBananaProEditImageAspectRatio::TwentyOneByNine => "21:9", + // Tall + EnqueueNanoBananaProEditImageAspectRatio::FourByFive => "4:5", + EnqueueNanoBananaProEditImageAspectRatio::ThreeByFour => "3:4", + EnqueueNanoBananaProEditImageAspectRatio::TwoByThree => "2:3", + EnqueueNanoBananaProEditImageAspectRatio::NineBySixteen => "9:16", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let request = NanoBananaProEditImageInput { + prompt: req.prompt, + image_urls: req.image_urls, + num_images: Some(num_images), + // Optionals + aspect_ratio, + resolution, + // Constants + output_format: Some("png".to_string()), + }; + + let result = nano_banana_pro_edit_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_nano_banana_pro_edit_image_webhook::{enqueue_nano_banana_pro_image_edit_webhook, EnqueueNanoBananaProEditImageArgs, EnqueueNanoBananaProEditImageAspectRatio, EnqueueNanoBananaProEditImageNumImages, EnqueueNanoBananaProEditImageRequest, EnqueueNanoBananaProEditImageResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, GHOST_IMAGE_URL, TREX_SKELETON_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueNanoBananaProEditImageArgs { + request: EnqueueNanoBananaProEditImageRequest { + image_urls: vec![ + GHOST_IMAGE_URL.to_string(), + TREX_SKELETON_IMAGE_URL.to_string(), + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ], + prompt: "add the ghost and scared man to the image of the t-rex skeleton, make it look spooky but friendly".to_string(), + num_images: EnqueueNanoBananaProEditImageNumImages::Two, + aspect_ratio: Some(EnqueueNanoBananaProEditImageAspectRatio::SixteenByNine), + resolution: Some(EnqueueNanoBananaProEditImageResolution::TwoK), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_nano_banana_pro_image_edit_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_qwen_image_edit_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_qwen_image_edit_webhook.rs new file mode 100644 index 00000000..0c699fa0 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_qwen_image_edit_webhook.rs @@ -0,0 +1,152 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::edit::http_qwen_image_edit::{qwen_image_edit, QwenImageEditInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct QwenImageEditArgs<'a, R: IntoUrl> { + pub request: QwenImageEditRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct QwenImageEditRequest { + pub prompt: String, + pub image_url: String, + + // Request optional + pub num_images: Option, + pub image_size: Option, + + pub negative_prompt: Option, + + /// Acceleration level for image generation. + /// Options: 'none', 'regular'. Higher acceleration increases speed. + /// 'regular' balances speed and quality. Default value: "none" + pub acceleration: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum QwenImageEditNumImages { + One, // Default + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum QwenImageEditSize { + Square, // 1:1 + SquareHd, // 1:1 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + + +impl FalRequestCostCalculator for QwenImageEditRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.03 per megapixel. -- Ugh, not calculating that + let base_cost = 3; + let cost = match self.num_images { + None => base_cost, + Some(QwenImageEditNumImages::One) => base_cost, + Some(QwenImageEditNumImages::Two) => base_cost * 2, + Some(QwenImageEditNumImages::Three) => base_cost * 3, + Some(QwenImageEditNumImages::Four) => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_qwen_image_edit_webhook( + args: QwenImageEditArgs<'_, R> +) -> Result { + let req = args.request; + + let num_images = req.num_images + .map(|num| match num { + QwenImageEditNumImages::One => 1, + QwenImageEditNumImages::Two => 2, + QwenImageEditNumImages::Three => 3, + QwenImageEditNumImages::Four => 4, + }); + + let image_size = req.image_size + .map(|size| match size { + QwenImageEditSize::Square => "square", + QwenImageEditSize::SquareHd => "square_hd", + QwenImageEditSize::LandscapeFourByThree => "landscape_4_3", + QwenImageEditSize::LandscapeSixteenByNine => "landscape_16_9", + QwenImageEditSize::PortraitThreeByFour => "portrait_4_3", // NB: I think they made a mistake + QwenImageEditSize::PortraitNineBySixteen => "portrait_16_9", // NB: I think they made a mistake + }) + .map(|size| size.to_string()); + + let request = QwenImageEditInput { + prompt: req.prompt, + image_url: req.image_url, + image_size, + num_images, + + // Maybe expose + output_format: Some("png".to_string()), // png or jpeg + negative_prompt: None, + seed: None, + + // Constants + //sync_mode: None, // Synchronous / slow + num_inference_steps: None, + guidance_scale: None, + enable_safety_checker: None, + acceleration: None, + }; + + let result = qwen_image_edit(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_qwen_image_edit_webhook::{enqueue_qwen_image_edit_webhook, QwenImageEditArgs, QwenImageEditNumImages, QwenImageEditRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::MOUNTAIN_TREE_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = QwenImageEditArgs { + request: QwenImageEditRequest { + prompt: "put christmas lights on the tree, add snow to the mountains".to_string(), + image_url: MOUNTAIN_TREE_IMAGE_URL.to_string(), + num_images: Some(QwenImageEditNumImages::One), + image_size: None, + negative_prompt: None, + acceleration: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_qwen_image_edit_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_seededit_v3_edit_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_seededit_v3_edit_webhook.rs new file mode 100644 index 00000000..159a95ba --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/enqueue_seededit_v3_edit_webhook.rs @@ -0,0 +1,71 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::edit::http_seededit_v3_edit::{seededit_v3_edit, SeedEditV3EditInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct SeedEditV3EditArgs<'a, R: IntoUrl> { + pub request: SeedEditV3EditRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct SeedEditV3EditRequest { + pub prompt: String, + pub image_url: String, +} + +pub async fn enqueue_seededit_v3_edit_webhook( + args: SeedEditV3EditArgs<'_, R> +) -> Result { + let req = args.request; + + let request = SeedEditV3EditInput { + prompt: req.prompt, + image_url: req.image_url, + + // Constants + guidance_scale: None, + enable_safety_checker: None, + }; + + let result = seededit_v3_edit(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::edit::enqueue_seededit_v3_edit_webhook::{enqueue_seededit_v3_edit_webhook, SeedEditV3EditArgs, SeedEditV3EditRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::MOUNTAIN_TREE_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = SeedEditV3EditArgs { + request: SeedEditV3EditRequest { + prompt: "put christmas lights on the tree, add snow to the mountains".to_string(), + image_url: MOUNTAIN_TREE_IMAGE_URL.to_string(), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_seededit_v3_edit_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/mod.rs new file mode 100644 index 00000000..34016527 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/edit/mod.rs @@ -0,0 +1,15 @@ +pub mod enqueue_flux_1_dev_edit_image_webhook; +pub mod enqueue_flux_1_schnell_edit_image_webhook; +pub mod enqueue_bytedance_seedream_v4_edit_image_webhook; +pub mod enqueue_bytedance_seedream_v4p5_edit_image_webhook; +pub mod enqueue_bytedance_seedream_v5_lite_edit_image_webhook; +pub mod enqueue_nano_banana_2_edit_image_webhook; +pub mod enqueue_flux_pro_kontext_max_edit_webhook; +pub mod enqueue_gemini_25_flash_edit_webhook; +pub mod enqueue_gpt_image_1_byok_edit_image_webhook; +pub mod enqueue_gpt_image_1_edit_image_webhook; +pub mod enqueue_gpt_image_1p5_edit_image_webhook; +pub mod enqueue_gpt_image_2_edit_image_webhook; +pub mod enqueue_nano_banana_pro_edit_image_webhook; +pub mod enqueue_qwen_image_edit_webhook; +pub mod enqueue_seededit_v3_edit_webhook; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/enqueue_flux_dev_juggernaut_infill_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/enqueue_flux_dev_juggernaut_infill_webhook.rs new file mode 100644 index 00000000..f0a80140 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/enqueue_flux_dev_juggernaut_infill_webhook.rs @@ -0,0 +1,101 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::infill::http_flux_dev_juggernaut_infill::{flux_dev_juggernaut_infill, FluxDevJuggernautInfillInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct FluxDevJuggernautInfillArgs<'a, R: IntoUrl> { + pub request: FluxDevJuggernautInfillRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct FluxDevJuggernautInfillRequest { + pub prompt: String, + pub image_url: String, + pub mask_url: String, + pub num_images: FluxDevJuggernautInfillNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum FluxDevJuggernautInfillNumImages { + One, // Default + Two, + Three, + Four, +} + +pub async fn enqueue_flux_dev_juggernaut_infill_webhook( + args: FluxDevJuggernautInfillArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + FluxDevJuggernautInfillNumImages::One => 1, + FluxDevJuggernautInfillNumImages::Two => 2, + FluxDevJuggernautInfillNumImages::Three => 3, + FluxDevJuggernautInfillNumImages::Four => 4, + }; + + let request = FluxDevJuggernautInfillInput { + prompt: req.prompt, + image_url: req.image_url, + mask_url: req.mask_url, + num_images: Some(num_images), + + // Maybe expose + output_format: Some("png".to_string()), // png or jpeg + seed: None, + strength: None, + num_inference_steps: None, + image_size: None, + enable_safety_checker: None, + guidance_scale: None, + + // Constants + sync_mode: None, // Synchronous / slow + }; + + let result = flux_dev_juggernaut_infill(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::infill::enqueue_flux_dev_juggernaut_infill_webhook::{enqueue_flux_dev_juggernaut_infill_webhook, FluxDevJuggernautInfillArgs, FluxDevJuggernautInfillRequest, FluxDevJuggernautInfillNumImages}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{TALL_MOCHI_WITH_GLASSES_GLASSES_MASK_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = FluxDevJuggernautInfillArgs { + request: FluxDevJuggernautInfillRequest { + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + mask_url: TALL_MOCHI_WITH_GLASSES_GLASSES_MASK_IMAGE_URL.to_string(), + prompt: "slick sunglasses, cool glasses, reflection in glasses lenses".to_string(), + num_images: FluxDevJuggernautInfillNumImages::Two, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_dev_juggernaut_infill_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/enqueue_flux_pro_1_infill_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/enqueue_flux_pro_1_infill_webhook.rs new file mode 100644 index 00000000..e05fd370 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/enqueue_flux_pro_1_infill_webhook.rs @@ -0,0 +1,97 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::infill::http_flux_pro_1_infill::{flux_pro_1_infill, FluxPro1InfillInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct FluxPro1InfillArgs<'a, R: IntoUrl> { + pub request: FluxPro1InfillRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct FluxPro1InfillRequest { + pub prompt: String, + pub image_url: String, + pub mask_url: String, + pub num_images: FluxPro1InfillNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum FluxPro1InfillNumImages { + One, // Default + Two, + Three, + Four, +} + +pub async fn enqueue_flux_pro_1_infill_webhook( + args: FluxPro1InfillArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + FluxPro1InfillNumImages::One => 1, + FluxPro1InfillNumImages::Two => 2, + FluxPro1InfillNumImages::Three => 3, + FluxPro1InfillNumImages::Four => 4, + }; + + let request = FluxPro1InfillInput { + prompt: req.prompt, + image_url: req.image_url, + mask_url: req.mask_url, + num_images: Some(num_images), + + // Maybe expose + safety_tolerance: Some("5".to_string()), // NB: 5 is most tolerant + output_format: Some("png".to_string()), // png or jpeg + seed: None, + + // Constants + sync_mode: None, // Synchronous / slow + }; + + let result = flux_pro_1_infill(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::infill::enqueue_flux_pro_1_infill_webhook::{enqueue_flux_pro_1_infill_webhook, FluxPro1InfillArgs, FluxPro1InfillRequest, FluxPro1InfillNumImages}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{TALL_MOCHI_WITH_GLASSES_GLASSES_MASK_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = FluxPro1InfillArgs { + request: FluxPro1InfillRequest { + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + mask_url: TALL_MOCHI_WITH_GLASSES_GLASSES_MASK_IMAGE_URL.to_string(), + prompt: "slick sunglasses, cool glasses, reflection in glasses lenses".to_string(), + num_images: FluxPro1InfillNumImages::One, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_pro_1_infill_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/mod.rs new file mode 100644 index 00000000..9bf0945e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/infill/mod.rs @@ -0,0 +1,2 @@ +pub mod enqueue_flux_dev_juggernaut_infill_webhook; +pub mod enqueue_flux_pro_1_infill_webhook; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/mod.rs new file mode 100644 index 00000000..50c1d0b2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/mod.rs @@ -0,0 +1,5 @@ +pub mod angle; +pub mod background; +pub mod edit; +pub mod infill; +pub mod text; diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v4_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v4_text_to_image_webhook.rs new file mode 100644 index 00000000..d37f8cb8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v4_text_to_image_webhook.rs @@ -0,0 +1,162 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::text::http_seedream_4_text_to_image::{seedream_4_text_to_image, SeedreamV4TextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueBytedanceSeedreamV4TextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueBytedanceSeedreamV4TextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueBytedanceSeedreamV4TextToImageRequest { + // Request required + pub prompt: String, + + // Optional args + pub num_images: Option, + pub max_images: Option, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4TextToImageMaxImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4TextToImageSize { + // Square + Square, + SquareHd, + // Tall + PortraitFourThree, + PortraitSixteenNine, + // Wide + LandscapeFourThree, + LandscapeSixteenNine, + // Auto + Auto, + Auto2k, + Auto4k, +} + + +impl FalRequestCostCalculator for EnqueueBytedanceSeedreamV4TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Copied from edit image version + // Your request will cost $0.03 per image. + let unit_cost = 3; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::One) => unit_cost, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Two) => unit_cost * 2, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Three) => unit_cost * 3, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_bytedance_seedream_v4_text_to_image_webhook( + args: EnqueueBytedanceSeedreamV4TextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = req.num_images + .map(|num_images| match num_images { + EnqueueBytedanceSeedreamV4TextToImageNumImages::One => 1, + EnqueueBytedanceSeedreamV4TextToImageNumImages::Two => 2, + EnqueueBytedanceSeedreamV4TextToImageNumImages::Three => 3, + EnqueueBytedanceSeedreamV4TextToImageNumImages::Four => 4, + }); + + let max_images = req.max_images + .map(|num_images| match num_images { + EnqueueBytedanceSeedreamV4TextToImageMaxImages::One => 1, + EnqueueBytedanceSeedreamV4TextToImageMaxImages::Two => 2, + EnqueueBytedanceSeedreamV4TextToImageMaxImages::Three => 3, + EnqueueBytedanceSeedreamV4TextToImageMaxImages::Four => 4, + }); + + let image_size = req.image_size + .map(|image_size| match image_size { + EnqueueBytedanceSeedreamV4TextToImageSize::Square => "square", + EnqueueBytedanceSeedreamV4TextToImageSize::SquareHd => "square_hd", + EnqueueBytedanceSeedreamV4TextToImageSize::PortraitFourThree => "portrait_4_3", + EnqueueBytedanceSeedreamV4TextToImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueBytedanceSeedreamV4TextToImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueBytedanceSeedreamV4TextToImageSize::LandscapeSixteenNine => "landscape_16_9", + EnqueueBytedanceSeedreamV4TextToImageSize::Auto => "auto", + EnqueueBytedanceSeedreamV4TextToImageSize::Auto2k => "auto_2K", + EnqueueBytedanceSeedreamV4TextToImageSize::Auto4k => "auto_4K", + }) + .map(|resolution| resolution.to_string()); + + let request = SeedreamV4TextToImageInput { + prompt: req.prompt, + // Optionals + num_images, + max_images, + image_size, + // Constants + enhance_prompt_mode: Some("standard".to_string()), + enable_safety_checker: Some(false), + }; + + let result = seedream_4_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4_text_to_image_webhook::{enqueue_bytedance_seedream_v4_text_to_image_webhook, EnqueueBytedanceSeedreamV4TextToImageArgs, EnqueueBytedanceSeedreamV4TextToImageMaxImages, EnqueueBytedanceSeedreamV4TextToImageNumImages, EnqueueBytedanceSeedreamV4TextToImageRequest, EnqueueBytedanceSeedreamV4TextToImageSize}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueBytedanceSeedreamV4TextToImageArgs { + request: EnqueueBytedanceSeedreamV4TextToImageRequest { + prompt: "an anime girl is riding a t-rex in the forest".to_string(), + num_images: Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Two), + max_images: Some(EnqueueBytedanceSeedreamV4TextToImageMaxImages::Two), + image_size: Some(EnqueueBytedanceSeedreamV4TextToImageSize::LandscapeSixteenNine), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_bytedance_seedream_v4_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v4p5_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v4p5_text_to_image_webhook.rs new file mode 100644 index 00000000..67a1271a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v4p5_text_to_image_webhook.rs @@ -0,0 +1,161 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_seedream_4p5_text_to_image::{seedream_4p5_text_to_image, SeedreamV4p5TextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4p5_edit_image_webhook::{EnqueueBytedanceSeedreamV4p5EditImageArgs, EnqueueBytedanceSeedreamV4p5EditImageNumImages}; + +pub struct EnqueueBytedanceSeedreamV4p5TextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueBytedanceSeedreamV4p5TextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueBytedanceSeedreamV4p5TextToImageRequest { + // Request required + pub prompt: String, + + // Optional args + pub num_images: Option, + pub max_images: Option, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4p5TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4p5TextToImageMaxImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV4p5TextToImageSize { + // Square + Square, + SquareHd, + // Tall + PortraitFourThree, + PortraitSixteenNine, + // Wide + LandscapeFourThree, + LandscapeSixteenNine, + // Auto + Auto2k, + Auto4k, +} + + +impl FalRequestCostCalculator for EnqueueBytedanceSeedreamV4p5TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // NB: Copied from edit image costs + // Your request will cost $0.04 per image. + let unit_cost = 4; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::One) => unit_cost, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two) => unit_cost * 2, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Three) => unit_cost * 3, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_bytedance_seedream_v4p5_text_to_image_webhook( + args: EnqueueBytedanceSeedreamV4p5TextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = req.num_images + .map(|num_images| match num_images { + EnqueueBytedanceSeedreamV4p5TextToImageNumImages::One => 1, + EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two => 2, + EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Three => 3, + EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Four => 4, + }); + + let max_images = req.max_images + .map(|num_images| match num_images { + EnqueueBytedanceSeedreamV4p5TextToImageMaxImages::One => 1, + EnqueueBytedanceSeedreamV4p5TextToImageMaxImages::Two => 2, + EnqueueBytedanceSeedreamV4p5TextToImageMaxImages::Three => 3, + EnqueueBytedanceSeedreamV4p5TextToImageMaxImages::Four => 4, + }); + + let image_size = req.image_size + .map(|image_size| match image_size { + EnqueueBytedanceSeedreamV4p5TextToImageSize::Square => "square", + EnqueueBytedanceSeedreamV4p5TextToImageSize::SquareHd => "square_hd", + EnqueueBytedanceSeedreamV4p5TextToImageSize::PortraitFourThree => "portrait_4_3", + EnqueueBytedanceSeedreamV4p5TextToImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueBytedanceSeedreamV4p5TextToImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueBytedanceSeedreamV4p5TextToImageSize::LandscapeSixteenNine => "landscape_16_9", + EnqueueBytedanceSeedreamV4p5TextToImageSize::Auto2k => "auto_2K", + EnqueueBytedanceSeedreamV4p5TextToImageSize::Auto4k => "auto_4K", + }) + .map(|resolution| resolution.to_string()); + + let request = SeedreamV4p5TextToImageInput { + prompt: req.prompt, + // Optionals + num_images, + max_images, + image_size, + // Constants + enable_safety_checker: Some(false), + seed: None, + }; + + let result = seedream_4p5_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4p5_text_to_image_webhook::{enqueue_bytedance_seedream_v4p5_text_to_image_webhook, EnqueueBytedanceSeedreamV4p5TextToImageArgs, EnqueueBytedanceSeedreamV4p5TextToImageMaxImages, EnqueueBytedanceSeedreamV4p5TextToImageNumImages, EnqueueBytedanceSeedreamV4p5TextToImageRequest, EnqueueBytedanceSeedreamV4p5TextToImageSize}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueBytedanceSeedreamV4p5TextToImageArgs { + request: EnqueueBytedanceSeedreamV4p5TextToImageRequest { + prompt: "an anime girl is riding a t-rex in the forest".to_string(), + num_images: Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two), + max_images: Some(EnqueueBytedanceSeedreamV4p5TextToImageMaxImages::Two), + image_size: Some(EnqueueBytedanceSeedreamV4p5TextToImageSize::LandscapeSixteenNine), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_bytedance_seedream_v4p5_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v5_lite_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v5_lite_text_to_image_webhook.rs new file mode 100644 index 00000000..9b08002f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_bytedance_seedream_v5_lite_text_to_image_webhook.rs @@ -0,0 +1,158 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_seedream_5_text_to_image::{http_seedream_5_text_to_image, SeedreamV5LiteTextToImageInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueBytedanceSeedreamV5LiteTextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueBytedanceSeedreamV5LiteTextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + // Request required + pub prompt: String, + + // Optional args + pub num_images: Option, + pub max_images: Option, + pub image_size: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV5LiteTextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueBytedanceSeedreamV5LiteTextToImageSize { + // Square + Square, + SquareHd, + // Tall + PortraitFourThree, + PortraitSixteenNine, + // Wide + LandscapeFourThree, + LandscapeSixteenNine, + // Auto + Auto2k, + Auto3k, // NB: v5 uses auto_3K instead of v4's auto_4K +} + + +impl FalRequestCostCalculator for EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // TODO(bt): Verify actual pricing for Seedream v5 Lite on fal.ai. + let unit_cost = 4; + let cost = match self.num_images { + None => unit_cost, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::One) => unit_cost, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two) => unit_cost * 2, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Three) => unit_cost * 3, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Four) => unit_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_bytedance_seedream_v5_lite_text_to_image_webhook( + args: EnqueueBytedanceSeedreamV5LiteTextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = req.num_images + .map(|n| match n { + EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::One => 1, + EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two => 2, + EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Three => 3, + EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Four => 4, + }); + + let max_images = req.max_images + .map(|n| match n { + EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages::One => 1, + EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages::Two => 2, + EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages::Three => 3, + EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages::Four => 4, + }); + + let image_size = req.image_size + .map(|s| match s { + EnqueueBytedanceSeedreamV5LiteTextToImageSize::Square => "square", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::SquareHd => "square_hd", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::PortraitFourThree => "portrait_4_3", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::PortraitSixteenNine => "portrait_16_9", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::LandscapeFourThree => "landscape_4_3", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::LandscapeSixteenNine => "landscape_16_9", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::Auto2k => "auto_2K", + EnqueueBytedanceSeedreamV5LiteTextToImageSize::Auto3k => "auto_3K", + }) + .map(|s| s.to_string()); + + let request = SeedreamV5LiteTextToImageInput { + prompt: req.prompt, + // Optionals + num_images, + max_images, + image_size, + // Constants + enable_safety_checker: Some(false), + }; + + let result = http_seedream_5_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_bytedance_seedream_v5_lite_text_to_image_webhook::{enqueue_bytedance_seedream_v5_lite_text_to_image_webhook, EnqueueBytedanceSeedreamV5LiteTextToImageArgs, EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages, EnqueueBytedanceSeedreamV5LiteTextToImageNumImages, EnqueueBytedanceSeedreamV5LiteTextToImageRequest, EnqueueBytedanceSeedreamV5LiteTextToImageSize}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueBytedanceSeedreamV5LiteTextToImageArgs { + request: EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + prompt: "an anime girl is riding a t-rex in the forest".to_string(), + num_images: Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two), + max_images: Some(EnqueueBytedanceSeedreamV5LiteTextToImageMaxImages::Two), + image_size: Some(EnqueueBytedanceSeedreamV5LiteTextToImageSize::LandscapeSixteenNine), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_bytedance_seedream_v5_lite_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_1_dev_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_1_dev_text_to_image_webhook.rs new file mode 100644 index 00000000..985c998b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_1_dev_text_to_image_webhook.rs @@ -0,0 +1,113 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_flux_1_dev_text_to_image::{flux_1_dev_text_to_image, Flux1DevTextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Flux1DevArgs<'a, U: IntoUrl> { + pub request: Flux1DevRequest, + pub webhook_url: U, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Flux1DevRequest { + pub prompt: String, + pub aspect_ratio: Flux1DevAspectRatio, + pub num_images: Flux1DevNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1DevAspectRatio { + Square, // 1:1 + SquareHd, // 1:1 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1DevNumImages { + One, // Default + Two, + Three, + Four, +} + +pub async fn enqueue_flux_1_dev_text_to_image_webhook( + args: Flux1DevArgs<'_, U> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + Flux1DevNumImages::One => 1, + Flux1DevNumImages::Two => 2, + Flux1DevNumImages::Three => 3, + Flux1DevNumImages::Four => 4, + }; + + let image_size = match req.aspect_ratio { + Flux1DevAspectRatio::Square => "square", + Flux1DevAspectRatio::SquareHd => "square_hd", + Flux1DevAspectRatio::LandscapeFourByThree => "landscape_4_3", + Flux1DevAspectRatio::LandscapeSixteenByNine => "landscape_16_9", + Flux1DevAspectRatio::PortraitThreeByFour => "portrait_4_3", + Flux1DevAspectRatio::PortraitNineBySixteen => "portrait_16_9", + }; + + let request = Flux1DevTextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + image_size: Some(image_size.to_string()), + // Maybe abstract + enable_safety_checker: Some(false), + // Maybe expose + seed: None, + guidance_scale: None, + num_inference_steps: None, + // Constants + sync_mode: None, // Synchronous / slow + }; + + let result = flux_1_dev_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_flux_1_dev_text_to_image_webhook::{enqueue_flux_1_dev_text_to_image_webhook, Flux1DevArgs, Flux1DevAspectRatio, Flux1DevNumImages, Flux1DevRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Flux1DevArgs { + request: Flux1DevRequest { + prompt: "a giant robot fighting a dragon in a futuristic city".to_string(), + num_images: Flux1DevNumImages::One, + aspect_ratio: Flux1DevAspectRatio::LandscapeFourByThree, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_1_dev_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_1_schnell_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_1_schnell_text_to_image_webhook.rs new file mode 100644 index 00000000..b2e0e81b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_1_schnell_text_to_image_webhook.rs @@ -0,0 +1,112 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_flux_1_schnell_text_to_image::{flux_1_schnell_text_to_image, Flux1SchnellTextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Flux1SchnellArgs<'a, U: IntoUrl> { + pub request: Flux1SchnellRequest, + pub webhook_url: U, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Flux1SchnellRequest { + pub prompt: String, + pub aspect_ratio: Flux1SchnellAspectRatio, + pub num_images: Flux1SchnellNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellAspectRatio { + Square, // 1:1 + SquareHd, // 1:1 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug)] +pub enum Flux1SchnellNumImages { + One, // Default + Two, + Three, + Four, +} + +pub async fn enqueue_flux_1_schnell_text_to_image_webhook( + args: Flux1SchnellArgs<'_, U> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + Flux1SchnellNumImages::One => 1, + Flux1SchnellNumImages::Two => 2, + Flux1SchnellNumImages::Three => 3, + Flux1SchnellNumImages::Four => 4, + }; + + let image_size = match req.aspect_ratio { + Flux1SchnellAspectRatio::Square => "square", + Flux1SchnellAspectRatio::SquareHd => "square_hd", + Flux1SchnellAspectRatio::LandscapeFourByThree => "landscape_4_3", + Flux1SchnellAspectRatio::LandscapeSixteenByNine => "landscape_16_9", + Flux1SchnellAspectRatio::PortraitThreeByFour => "portrait_4_3", + Flux1SchnellAspectRatio::PortraitNineBySixteen => "portrait_16_9", + }; + + let request = Flux1SchnellTextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + image_size: Some(image_size.to_string()), + // Maybe abstract + enable_safety_checker: Some(false), + // Maybe expose + seed: None, + num_inference_steps: None, + // Constants + sync_mode: None, // Synchronous / slow + }; + + let result = flux_1_schnell_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_flux_1_schnell_text_to_image_webhook::{enqueue_flux_1_schnell_text_to_image_webhook, Flux1SchnellArgs, Flux1SchnellAspectRatio, Flux1SchnellNumImages, Flux1SchnellRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Flux1SchnellArgs { + request: Flux1SchnellRequest { + prompt: "a giant robot fighting a dragon in a futuristic city".to_string(), + num_images: Flux1SchnellNumImages::One, + aspect_ratio: Flux1SchnellAspectRatio::LandscapeSixteenByNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_1_schnell_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_pro_11_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_pro_11_text_to_image_webhook.rs new file mode 100644 index 00000000..37d9375c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_pro_11_text_to_image_webhook.rs @@ -0,0 +1,132 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::text::http_flux_pro_11_text_to_image::{flux_pro_11_text_to_image, FluxPro11TextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct FluxPro11Args<'a, U: IntoUrl> { + pub request: FluxPro11Request, + pub webhook_url: U, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct FluxPro11Request { + pub prompt: String, + pub aspect_ratio: FluxPro11AspectRatio, + pub num_images: FluxPro11NumImages, +} + +// TODO(bt,2026-01-01): This seems to disagree between Fal.ai and Fal.rs client libraries. +#[derive(Copy, Clone, Debug)] +pub enum FluxPro11AspectRatio { + Square, // 1:1 + SquareHd, // 1:1 (TODO: Is this in the API? I checked recently and don't see it.) + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug)] +pub enum FluxPro11NumImages { + One, // Default + Two, + Three, + Four, +} + + +impl FalRequestCostCalculator for FluxPro11Request { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.04 per megapixel, billed by rounding up to the nearest + // megapixel. Default image_size values are ~1MP, so 4 cents per image. + let base_cost = 4; + let cost = match self.num_images { + FluxPro11NumImages::One => base_cost, + FluxPro11NumImages::Two => base_cost * 2, + FluxPro11NumImages::Three => base_cost * 3, + FluxPro11NumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_flux_pro_11_text_to_image_webhook( + args: FluxPro11Args<'_, U> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + FluxPro11NumImages::One => 1, + FluxPro11NumImages::Two => 2, + FluxPro11NumImages::Three => 3, + FluxPro11NumImages::Four => 4, + }; + + let image_size = match req.aspect_ratio { + FluxPro11AspectRatio::Square => "square", + FluxPro11AspectRatio::SquareHd => "square_hd", + FluxPro11AspectRatio::LandscapeFourByThree => "landscape_4_3", + FluxPro11AspectRatio::LandscapeSixteenByNine => "landscape_16_9", + FluxPro11AspectRatio::PortraitThreeByFour => "portrait_4_3", + FluxPro11AspectRatio::PortraitNineBySixteen => "portrait_16_9", + }; + + let request = FluxPro11TextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + image_size: Some(image_size.to_string()), + // Maybe expose + seed: None, + // Maybe abstract + enable_safety_checker: Some(false), + safety_tolerance: Some("5".to_string()), // 1 is most strict, 5 is most permissive + // Constants + output_format: Some("png".to_string()), + sync_mode: None, // Synchronous / slow + }; + + let result = flux_pro_11_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_flux_pro_11_text_to_image_webhook::{enqueue_flux_pro_11_text_to_image_webhook, FluxPro11Args, FluxPro11AspectRatio, FluxPro11NumImages, FluxPro11Request}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = FluxPro11Args { + request: FluxPro11Request { + prompt: "a giant red panda fighting a dragon in a futuristic city".to_string(), + num_images: FluxPro11NumImages::One, + aspect_ratio: FluxPro11AspectRatio::LandscapeSixteenByNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_pro_11_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_pro_11_ultra_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_pro_11_ultra_text_to_image_webhook.rs new file mode 100644 index 00000000..8e0cfc23 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_flux_pro_11_ultra_text_to_image_webhook.rs @@ -0,0 +1,137 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::text::http_flux_pro_11_ultra_text_to_image::{flux_pro_11_ultra_text_to_image, FluxPro11UltraTextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct FluxPro11UltraArgs<'a, U: IntoUrl> { + pub request: FluxPro11UltraRequest, + pub webhook_url: U, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct FluxPro11UltraRequest { + pub prompt: String, + pub aspect_ratio: FluxPro11UltraAspectRatio, + pub num_images: FluxPro11UltraNumImages, +} + +#[derive(Copy, Clone, Debug)] +pub enum FluxPro11UltraAspectRatio { + Square, // 1:1 + LandscapeThreeByTwo, // 3:2 + LandscapeFourByThree, // 4:3 + LandscapeSixteenByNine, // 16:9 + LandscapeTwentyOneByNine, // 21:9 + PortraitTwoByThree, // 2:3 + PortraitThreeByFour, // 3:4 + PortraitNineBySixteen, // 9:16 + PortraitNineByTwentyOne, // 9:21 + //Custom { width: u32, height: u32 }, // TODO +} + +#[derive(Copy, Clone, Debug)] +pub enum FluxPro11UltraNumImages { + One, // Default + Two, + Three, + Four, +} + + +impl FalRequestCostCalculator for FluxPro11UltraRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.06 per image. + let base_cost = 6; + let cost = match self.num_images { + FluxPro11UltraNumImages::One => base_cost, + FluxPro11UltraNumImages::Two => base_cost * 2, + FluxPro11UltraNumImages::Three => base_cost * 3, + FluxPro11UltraNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_flux_pro_11_ultra_text_to_image_webhook( + args: FluxPro11UltraArgs<'_, U> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + FluxPro11UltraNumImages::One => 1, + FluxPro11UltraNumImages::Two => 2, + FluxPro11UltraNumImages::Three => 3, + FluxPro11UltraNumImages::Four => 4, + }; + + let aspect_ratio = match req.aspect_ratio { + FluxPro11UltraAspectRatio::Square => "1:1", + FluxPro11UltraAspectRatio::LandscapeThreeByTwo => "3:2", + FluxPro11UltraAspectRatio::LandscapeFourByThree => "4:3", + FluxPro11UltraAspectRatio::LandscapeSixteenByNine => "16:9", + FluxPro11UltraAspectRatio::LandscapeTwentyOneByNine => "21:9", + FluxPro11UltraAspectRatio::PortraitTwoByThree => "2:3", + FluxPro11UltraAspectRatio::PortraitThreeByFour => "3:4", + FluxPro11UltraAspectRatio::PortraitNineBySixteen => "9:16", + FluxPro11UltraAspectRatio::PortraitNineByTwentyOne => "9:21", + }; + + let request = FluxPro11UltraTextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + aspect_ratio: Some(aspect_ratio.to_string()), + // Maybe expose + seed: None, + raw: Some(true), // Generate less processed, more natural-looking images. Default is false. + // Maybe abstract + enable_safety_checker: Some(false), + safety_tolerance: Some("5".to_string()), // 1 is most strict, 5 is most permissive + // Constants + output_format: Some("png".to_string()), + sync_mode: None, // Synchronous / slow + }; + + let result = flux_pro_11_ultra_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_flux_pro_11_ultra_text_to_image_webhook::{enqueue_flux_pro_11_ultra_text_to_image_webhook, FluxPro11UltraArgs, FluxPro11UltraAspectRatio, FluxPro11UltraNumImages, FluxPro11UltraRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = FluxPro11UltraArgs { + request: FluxPro11UltraRequest { + prompt: "a giant robot fighting a dragon in a futuristic city".to_string(), + num_images: FluxPro11UltraNumImages::One, + aspect_ratio: FluxPro11UltraAspectRatio::LandscapeSixteenByNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_flux_pro_11_ultra_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gemini_25_flash_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gemini_25_flash_text_to_image_webhook.rs new file mode 100644 index 00000000..eb5fb976 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gemini_25_flash_text_to_image_webhook.rs @@ -0,0 +1,144 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_gemini_25_flash_text_to_image::{gemini_25_flash_text_to_image, Gemini25FlashTextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::{Gemini25FlashEditArgs, Gemini25FlashEditNumImages}; + +pub struct Gemini25FlashTextToImageArgs<'a, R: IntoUrl> { + pub request: Gemini25FlashTextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Gemini25FlashTextToImageRequest { + // Required + pub prompt: String, + pub num_images: Gemini25FlashTextToImageNumImages, + + // Optional + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum Gemini25FlashTextToImageNumImages { + One, + Two, + Three, + Four, +} + +/// 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +/// Default is "1:1" +#[derive(Copy, Clone, Debug)] +pub enum Gemini25FlashTextToImageAspectRatio { + // Square + OneByOne, + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, // NB: No NineByTwentyOne ? +} + + +impl FalRequestCostCalculator for Gemini25FlashTextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // NB: This was copied from the image-to-image case. + // Your request will cost $0.039 per image. For $1.00, you can run this model 25 times. + match self.num_images { + Gemini25FlashTextToImageNumImages::One => 4, + Gemini25FlashTextToImageNumImages::Two => 8, + Gemini25FlashTextToImageNumImages::Three => 12, + Gemini25FlashTextToImageNumImages::Four => 16, + } + } +} + + +pub async fn enqueue_gemini_25_flash_text_to_image_webhook( + args: Gemini25FlashTextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + Gemini25FlashTextToImageNumImages::One => 1, + Gemini25FlashTextToImageNumImages::Two => 2, + Gemini25FlashTextToImageNumImages::Three => 3, + Gemini25FlashTextToImageNumImages::Four => 4, + }; + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + // Square + Gemini25FlashTextToImageAspectRatio::OneByOne => "1:1", + // Wide + Gemini25FlashTextToImageAspectRatio::FiveByFour => "5:4", + Gemini25FlashTextToImageAspectRatio::FourByThree => "4:3", + Gemini25FlashTextToImageAspectRatio::ThreeByTwo => "3:2", + Gemini25FlashTextToImageAspectRatio::SixteenByNine => "16:9", + Gemini25FlashTextToImageAspectRatio::TwentyOneByNine => "21:9", + // Tall + Gemini25FlashTextToImageAspectRatio::FourByFive => "4:5", + Gemini25FlashTextToImageAspectRatio::ThreeByFour => "3:4", + Gemini25FlashTextToImageAspectRatio::TwoByThree => "2:3", + Gemini25FlashTextToImageAspectRatio::NineBySixteen => "9:16", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let request = Gemini25FlashTextToImageInput { + prompt: req.prompt, + aspect_ratio, + // Constants + num_images: Some(num_images), + output_format: Some("png".to_string()), + }; + + let result = gemini_25_flash_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_gemini_25_flash_text_to_image_webhook::{enqueue_gemini_25_flash_text_to_image_webhook, Gemini25FlashTextToImageArgs, Gemini25FlashTextToImageNumImages, Gemini25FlashTextToImageRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Gemini25FlashTextToImageArgs { + request: Gemini25FlashTextToImageRequest { + prompt: "a warrior on the field of battle, final fantasy style, lots of hungry raptors rushing the heroes".to_string(), + num_images: Gemini25FlashTextToImageNumImages::Two, + aspect_ratio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_gemini_25_flash_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1_byok_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1_byok_text_to_image_webhook.rs new file mode 100644 index 00000000..68660baa --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1_byok_text_to_image_webhook.rs @@ -0,0 +1,163 @@ +//! Deprecated BYOK (bring-your-own-OpenAI-key) text-to-image binding for +//! `fal-ai/gpt-image-1/text-to-image/byok`. The non-BYOK replacement lives in +//! `enqueue_gpt_image_1_text_to_image_webhook.rs`. Kept for the legacy +//! `generate_gpt_image_1_text_to_image_handler` storyteller-web endpoint. + +use crate::creds::fal_api_key::FalApiKey; +use crate::creds::open_ai_api_key::OpenAiApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::text::http_gpt_image_1_byok_text_to_image::{gpt_image_1_byok_text_to_image, GptImage1ByokTextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct GptTextToImageByokArgs<'a, V: IntoUrl> { + pub request: GptTextToImageByokRequest, + + // Fulfillment + pub api_key: &'a FalApiKey, + pub openai_api_key: &'a OpenAiApiKey, + pub webhook_url: V, +} + +#[derive(Clone, Debug)] +pub struct GptTextToImageByokRequest { + pub prompt: String, + pub image_size: GptTextToImageSize, + pub num_images: GptTextToImageNumImages, + pub quality: GptTextToImageQuality, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptTextToImageSize{ + Auto, + Square, + Horizontal, + Vertical, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptTextToImageQuality { + Auto, + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum GptTextToImageNumImages{ + One, + Two, + Three, + Four, +} + + +// NB: These are BYOK, so they're not Fal's prices +impl FalRequestCostCalculator for GptTextToImageByokRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Can't find details, so using this: https://www.reddit.com/r/OpenAI/comments/1krfwa1/pricing_gpt_image_1_model/ + // Prompts are billed similarly to other GPT models. Image outputs cost approximately $0.01 (low), $0.04 (medium), + // and $0.17 (high) for square images. + // We're likely losing money on this, but that's okay. Will adjust in the future to be fair to users and us. + let base_cost = match self.quality { + GptTextToImageQuality::Auto => 17, + GptTextToImageQuality::Low => 1, + GptTextToImageQuality::Medium => 4, + GptTextToImageQuality::High => 17, + }; + let cost = match self.num_images { + GptTextToImageNumImages::One => base_cost, + GptTextToImageNumImages::Two => base_cost * 2, + GptTextToImageNumImages::Three => base_cost * 3, + GptTextToImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_gpt_image_1_byok_text_to_image_webhook( + args: GptTextToImageByokArgs<'_, V> +) -> Result { + + let req = args.request; + + // auto, 1024x1024, 1536x1024, 1024x1536 + let image_size = match req.image_size { + GptTextToImageSize::Auto => "auto", + GptTextToImageSize::Square => "1024x1024", + GptTextToImageSize::Horizontal => "1536x1024", + GptTextToImageSize::Vertical => "1024x1536", + }; + + let quality = match req.quality { + GptTextToImageQuality::Auto => "auto", + GptTextToImageQuality::Low => "low", + GptTextToImageQuality::Medium => "medium", + GptTextToImageQuality::High => "high", + }; + + let num_images = match req.num_images { + GptTextToImageNumImages::One => 1, + GptTextToImageNumImages::Two => 2, + GptTextToImageNumImages::Three => 3, + GptTextToImageNumImages::Four => 4, + }; + + let request = GptImage1ByokTextToImageInput { + prompt: req.prompt, + image_size: image_size.to_string(), + num_images, + quality: quality.to_string(), + openai_api_key: args.openai_api_key.0.to_string(), + }; + + let result = gpt_image_1_byok_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::creds::open_ai_api_key::OpenAiApiKey; + use crate::requests_old::webhook::image::text::enqueue_gpt_image_1_byok_text_to_image_webhook::{ + enqueue_gpt_image_1_byok_text_to_image_webhook, GptTextToImageByokArgs, + GptTextToImageByokRequest, GptTextToImageNumImages, GptTextToImageQuality, + GptTextToImageSize, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let fal_secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let fal_api_key = FalApiKey::from_str(&fal_secret); + + let openai_secret = read_to_string("/Users/bt/Artcraft/credentials/openai_api_key.txt")?; + let openai_api_key = OpenAiApiKey::from_str(&openai_secret); + + let args = GptTextToImageByokArgs { + request: GptTextToImageByokRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + image_size: GptTextToImageSize::Horizontal, + num_images: GptTextToImageNumImages::One, + quality: GptTextToImageQuality::High, + }, + api_key: &fal_api_key, + openai_api_key: &openai_api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_gpt_image_1_byok_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1_text_to_image_webhook.rs new file mode 100644 index 00000000..3c25a30c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1_text_to_image_webhook.rs @@ -0,0 +1,209 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::core_api::webhook_response::WebhookResponse; +use crate::requests_old::http::image::text::http_gpt_image_1_text_to_image::{ + gpt_image_1_text_to_image, GptImage1TextToImageInput, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{ + FalRequestCostCalculator, UsdCents, +}; +use reqwest::IntoUrl; + +/// Typed args for the non-BYOK `fal-ai/gpt-image-1/text-to-image` endpoint. +/// +/// (The BYOK variant lives in `enqueue_gpt_image_1_byok_text_to_image_webhook.rs` +/// and is deprecated.) +pub struct EnqueueGptImage1TextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueGptImage1TextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueGptImage1TextToImageRequest { + // Required + pub prompt: String, + pub num_images: EnqueueGptImage1TextToImageNumImages, + + // Optional + pub image_size: Option, + pub quality: Option, + pub background: Option, + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1TextToImageSize { + Auto, + /// 1024x1024 + Square, + /// 1536x1024 + Horizontal, + /// 1024x1536 + Vertical, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1TextToImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1TextToImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1TextToImageOutputFormat { + Jpeg, + Png, + Webp, +} + +impl FalRequestCostCalculator for EnqueueGptImage1TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Per fal docs (fal-ai/gpt-image-1/text-to-image): + // Low: $0.011 (1024x1024) / $0.016 (other) per image + // Medium: $0.042 (1024x1024) / $0.063 (other) per image + // High: $0.167 (1024x1024) / $0.25 (other) per image + // Default quality is Medium when unspecified, square when size unspecified. + let use_quality = self + .quality + .unwrap_or(EnqueueGptImage1TextToImageQuality::Medium); + let is_square = matches!( + self.image_size, + None | Some(EnqueueGptImage1TextToImageSize::Square) | Some(EnqueueGptImage1TextToImageSize::Auto) + ); + let base_cost: u64 = match (use_quality, is_square) { + (EnqueueGptImage1TextToImageQuality::Low, true) => 2, + (EnqueueGptImage1TextToImageQuality::Low, false) => 2, + (EnqueueGptImage1TextToImageQuality::Medium, true) => 5, + (EnqueueGptImage1TextToImageQuality::Medium, false) => 7, + (EnqueueGptImage1TextToImageQuality::High, true) => 17, + (EnqueueGptImage1TextToImageQuality::High, false) => 25, + }; + let n: u64 = match self.num_images { + EnqueueGptImage1TextToImageNumImages::One => 1, + EnqueueGptImage1TextToImageNumImages::Two => 2, + EnqueueGptImage1TextToImageNumImages::Three => 3, + EnqueueGptImage1TextToImageNumImages::Four => 4, + }; + base_cost * n + } +} + +pub async fn enqueue_gpt_image_1_text_to_image_webhook( + args: EnqueueGptImage1TextToImageArgs<'_, R>, +) -> Result { + let req = args.request; + + let num_images: u8 = match req.num_images { + EnqueueGptImage1TextToImageNumImages::One => 1, + EnqueueGptImage1TextToImageNumImages::Two => 2, + EnqueueGptImage1TextToImageNumImages::Three => 3, + EnqueueGptImage1TextToImageNumImages::Four => 4, + }; + + let image_size = req.image_size.map(|s| { + match s { + EnqueueGptImage1TextToImageSize::Auto => "auto", + EnqueueGptImage1TextToImageSize::Square => "1024x1024", + EnqueueGptImage1TextToImageSize::Horizontal => "1536x1024", + EnqueueGptImage1TextToImageSize::Vertical => "1024x1536", + } + .to_string() + }); + + let quality = req.quality.map(|q| { + match q { + EnqueueGptImage1TextToImageQuality::Low => "low", + EnqueueGptImage1TextToImageQuality::Medium => "medium", + EnqueueGptImage1TextToImageQuality::High => "high", + } + .to_string() + }); + + let background = req.background.map(|b| { + match b { + EnqueueGptImage1TextToImageBackground::Auto => "auto", + EnqueueGptImage1TextToImageBackground::Transparent => "transparent", + EnqueueGptImage1TextToImageBackground::Opaque => "opaque", + } + .to_string() + }); + + let output_format = req.output_format.map(|f| { + match f { + EnqueueGptImage1TextToImageOutputFormat::Jpeg => "jpeg", + EnqueueGptImage1TextToImageOutputFormat::Png => "png", + EnqueueGptImage1TextToImageOutputFormat::Webp => "webp", + } + .to_string() + }); + + let request = GptImage1TextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + image_size, + quality, + background, + output_format, + }; + + let result = gpt_image_1_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_gpt_image_1_text_to_image_webhook::{ + enqueue_gpt_image_1_text_to_image_webhook, EnqueueGptImage1TextToImageArgs, + EnqueueGptImage1TextToImageNumImages, EnqueueGptImage1TextToImageQuality, + EnqueueGptImage1TextToImageRequest, EnqueueGptImage1TextToImageSize, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueGptImage1TextToImageArgs { + request: EnqueueGptImage1TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: EnqueueGptImage1TextToImageNumImages::One, + image_size: Some(EnqueueGptImage1TextToImageSize::Horizontal), + quality: Some(EnqueueGptImage1TextToImageQuality::Medium), + background: None, + output_format: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_gpt_image_1_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1p5_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1p5_text_to_image_webhook.rs new file mode 100644 index 00000000..55b6c7dc --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_1p5_text_to_image_webhook.rs @@ -0,0 +1,192 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::text::http_gpt_image_1p5_text_to_image::{gpt_image_1p5_text_to_image, GptImage1p5TextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueGptImage1p5TextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueGptImage1p5TextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueGptImage1p5TextToImageRequest { + // Required + pub prompt: String, + pub num_images: EnqueueGptImage1p5TextToImageNumImages, + + // Optional + pub image_size: Option, + pub background: Option, + pub quality: Option, + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5TextToImageSize { + /// 1024x1024 + Square, + /// 1536x1024 + Wide, + /// 1024x1536 + Tall, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5TextToImageBackground { + Auto, + Transparent, + Opaque, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5TextToImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage1p5TextToImageOutputFormat { + Jpeg, + Png, + Webp, +} + + +impl FalRequestCostCalculator for EnqueueGptImage1p5TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // NB: copied from edit image case - should be correct, but not verified. + // Your request will cost different amounts based on the number of images, quality, and size. + // For low quality, you will be charged $0.009 for 1024x1024 or $0.013 for any other size per image. + // For medium quality, you will be charged $0.034 for 1024x1024, $0.051 for 1024x1536 and $0.050 for 1536x1024 per image. + // For high quality, you will be charged $0.133 for 1024x1024, $0.200 for 1024x1536 or $0.199 for 1536x1024 per image. + let use_quality = self.quality.unwrap_or(EnqueueGptImage1p5TextToImageQuality::Medium); + let use_size = self.image_size.unwrap_or(EnqueueGptImage1p5TextToImageSize::Square); + let base_cost = match (use_quality, use_size) { + (EnqueueGptImage1p5TextToImageQuality::Low, EnqueueGptImage1p5TextToImageSize::Square) => 1, + (EnqueueGptImage1p5TextToImageQuality::Low, _) => 1, + (EnqueueGptImage1p5TextToImageQuality::Medium, EnqueueGptImage1p5TextToImageSize::Square) => 3, + (EnqueueGptImage1p5TextToImageQuality::Medium, _) => 5, + (EnqueueGptImage1p5TextToImageQuality::High, EnqueueGptImage1p5TextToImageSize::Square) => 13, + (EnqueueGptImage1p5TextToImageQuality::High, _) => 20, + }; + let cost = match self.num_images { + EnqueueGptImage1p5TextToImageNumImages::One => base_cost, + EnqueueGptImage1p5TextToImageNumImages::Two => base_cost * 2, + EnqueueGptImage1p5TextToImageNumImages::Three => base_cost * 3, + EnqueueGptImage1p5TextToImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_gpt_image_1p5_text_to_image_webhook( + args: EnqueueGptImage1p5TextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + EnqueueGptImage1p5TextToImageNumImages::One => 1, + EnqueueGptImage1p5TextToImageNumImages::Two => 2, + EnqueueGptImage1p5TextToImageNumImages::Three => 3, + EnqueueGptImage1p5TextToImageNumImages::Four => 4, + }; + + let image_size = req.image_size + .map(|s| match s { + EnqueueGptImage1p5TextToImageSize::Square => "1024x1024", + EnqueueGptImage1p5TextToImageSize::Wide => "1536x1024", + EnqueueGptImage1p5TextToImageSize::Tall => "1024x1536", + }) + .map(|resolution| resolution.to_string()); + + let background = req.background + .map(|s| match s { + EnqueueGptImage1p5TextToImageBackground::Auto => "auto", + EnqueueGptImage1p5TextToImageBackground::Transparent => "transparent", + EnqueueGptImage1p5TextToImageBackground::Opaque => "opaque", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let quality = req.quality + .map(|s| match s { + EnqueueGptImage1p5TextToImageQuality::Low => "low", + EnqueueGptImage1p5TextToImageQuality::Medium => "medium", + EnqueueGptImage1p5TextToImageQuality::High => "high", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let output_format = req.output_format + .map(|s| match s { + EnqueueGptImage1p5TextToImageOutputFormat::Jpeg => "jpeg", + EnqueueGptImage1p5TextToImageOutputFormat::Png => "png", + EnqueueGptImage1p5TextToImageOutputFormat::Webp => "webp", + }) + .map(|aspect_ratio| aspect_ratio.to_string()) + .unwrap_or_else(|| "png".to_string()); + + let request = GptImage1p5TextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + output_format: Some(output_format), + // Optionals + image_size, + background, + quality, + }; + + let result = gpt_image_1p5_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_gpt_image_1p5_text_to_image_webhook::{enqueue_gpt_image_1p5_text_to_image_webhook, EnqueueGptImage1p5TextToImageArgs, EnqueueGptImage1p5TextToImageNumImages, EnqueueGptImage1p5TextToImageRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueGptImage1p5TextToImageArgs { + request: EnqueueGptImage1p5TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: EnqueueGptImage1p5TextToImageNumImages::Two, + image_size: None, + background: None, + quality: None, + output_format: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_gpt_image_1p5_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_2_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_2_text_to_image_webhook.rs new file mode 100644 index 00000000..50d1c5fe --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_gpt_image_2_text_to_image_webhook.rs @@ -0,0 +1,188 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::image::text::http_gpt_image_2_text_to_image::{gpt_image_2_text_to_image, GptImage2TextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueGptImage2TextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueGptImage2TextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueGptImage2TextToImageRequest { + // Required + pub prompt: String, + pub num_images: EnqueueGptImage2TextToImageNumImages, + + // Optional + pub image_size: Option, + pub quality: Option, + pub output_format: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2TextToImageSize { + SquareHd, + Square, + Portrait4x3, + Portrait16x9, + Landscape4x3, + Landscape16x9, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2TextToImageQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueGptImage2TextToImageOutputFormat { + Jpeg, + Png, + Webp, +} + + +impl FalRequestCostCalculator for EnqueueGptImage2TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Cost table (per image) by approximate pixel dimensions: + // + // landscape_4_3 (~1024x768): low=$0.01, medium=$0.04, high=$0.15 + // square (~1024x1024): low=$0.01, medium=$0.06, high=$0.22 + // portrait_4_3 (~768x1024): low=$0.01, medium=$0.04, high=$0.15 + // landscape_16_9(~1920x1080): low=$0.01, medium=$0.04, high=$0.16 + // portrait_16_9 (~1080x1920): low=$0.01, medium=$0.04, high=$0.16 + // square_hd (~2048x2048): low=$0.01, medium=$0.06, high=$0.23 + // auto (varies): estimated as square + let use_quality = self.quality.unwrap_or(EnqueueGptImage2TextToImageQuality::High); + let use_size = self.image_size.unwrap_or(EnqueueGptImage2TextToImageSize::Square); + + use EnqueueGptImage2TextToImageQuality::*; + use EnqueueGptImage2TextToImageSize::*; + + let base_cost = match (use_quality, use_size) { + (Low, _) => 1, + (Medium, Landscape4x3 | Portrait4x3 | Landscape16x9 | Portrait16x9) => 4, + (Medium, Square) => 6, + (Medium, SquareHd) => 6, + (High, Landscape4x3 | Portrait4x3) => 15, + (High, Landscape16x9 | Portrait16x9) => 16, + (High, Square) => 22, + (High, SquareHd) => 23, + }; + + let cost = match self.num_images { + EnqueueGptImage2TextToImageNumImages::One => base_cost, + EnqueueGptImage2TextToImageNumImages::Two => base_cost * 2, + EnqueueGptImage2TextToImageNumImages::Three => base_cost * 3, + EnqueueGptImage2TextToImageNumImages::Four => base_cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_gpt_image_2_text_to_image_webhook( + args: EnqueueGptImage2TextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + EnqueueGptImage2TextToImageNumImages::One => 1, + EnqueueGptImage2TextToImageNumImages::Two => 2, + EnqueueGptImage2TextToImageNumImages::Three => 3, + EnqueueGptImage2TextToImageNumImages::Four => 4, + }; + + let image_size = req.image_size + .map(|s| match s { + EnqueueGptImage2TextToImageSize::SquareHd => "square_hd", + EnqueueGptImage2TextToImageSize::Square => "square", + EnqueueGptImage2TextToImageSize::Portrait4x3 => "portrait_4_3", + EnqueueGptImage2TextToImageSize::Portrait16x9 => "portrait_16_9", + EnqueueGptImage2TextToImageSize::Landscape4x3 => "landscape_4_3", + EnqueueGptImage2TextToImageSize::Landscape16x9 => "landscape_16_9", + }) + .map(|size| size.to_string()); + + let quality = req.quality + .map(|s| match s { + EnqueueGptImage2TextToImageQuality::Low => "low", + EnqueueGptImage2TextToImageQuality::Medium => "medium", + EnqueueGptImage2TextToImageQuality::High => "high", + }) + .map(|quality| quality.to_string()); + + let output_format = req.output_format + .map(|s| match s { + EnqueueGptImage2TextToImageOutputFormat::Jpeg => "jpeg", + EnqueueGptImage2TextToImageOutputFormat::Png => "png", + EnqueueGptImage2TextToImageOutputFormat::Webp => "webp", + }) + .map(|format| format.to_string()) + .unwrap_or_else(|| "png".to_string()); + + let request = GptImage2TextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + output_format: Some(output_format), + // Optionals + image_size, + quality, + }; + + let result = gpt_image_2_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_gpt_image_2_text_to_image_webhook::{enqueue_gpt_image_2_text_to_image_webhook, EnqueueGptImage2TextToImageArgs, EnqueueGptImage2TextToImageNumImages, EnqueueGptImage2TextToImageRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueGptImage2TextToImageArgs { + request: EnqueueGptImage2TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: EnqueueGptImage2TextToImageNumImages::Two, + image_size: None, + quality: None, + output_format: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_gpt_image_2_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_nano_banana_2_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_nano_banana_2_text_to_image_webhook.rs new file mode 100644 index 00000000..105dbf6c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_nano_banana_2_text_to_image_webhook.rs @@ -0,0 +1,180 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_nano_banana_2_text_to_image::{nano_banana_2_text_to_image, NanoBanana2TextToImageInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueNanoBanana2TextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueNanoBanana2TextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueNanoBanana2TextToImageRequest { + // Required + pub prompt: String, + pub num_images: EnqueueNanoBanana2TextToImageNumImages, + + // Optional + pub resolution: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBanana2TextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBanana2TextToImageResolution { + HalfK, // "0.5K" + OneK, // "1K" (default) + TwoK, // "2K" + FourK, // "4K" +} + +/// auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +/// Default: "auto" +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBanana2TextToImageAspectRatio { + // Automatic (default) + Auto, + // Square + OneByOne, + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, +} + + +impl FalRequestCostCalculator for EnqueueNanoBanana2TextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // TODO(bt): Verify actual pricing for Nano Banana 2 on fal.ai. + // 4K outputs may be charged at double the standard rate. + let cost = match self.resolution { + None => 15, + Some(EnqueueNanoBanana2TextToImageResolution::HalfK) => 8, + Some(EnqueueNanoBanana2TextToImageResolution::OneK) => 15, + Some(EnqueueNanoBanana2TextToImageResolution::TwoK) => 15, + Some(EnqueueNanoBanana2TextToImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + EnqueueNanoBanana2TextToImageNumImages::One => cost, + EnqueueNanoBanana2TextToImageNumImages::Two => cost * 2, + EnqueueNanoBanana2TextToImageNumImages::Three => cost * 3, + EnqueueNanoBanana2TextToImageNumImages::Four => cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_nano_banana_2_text_to_image_webhook( + args: EnqueueNanoBanana2TextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + EnqueueNanoBanana2TextToImageNumImages::One => 1, + EnqueueNanoBanana2TextToImageNumImages::Two => 2, + EnqueueNanoBanana2TextToImageNumImages::Three => 3, + EnqueueNanoBanana2TextToImageNumImages::Four => 4, + }; + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueNanoBanana2TextToImageResolution::HalfK => "0.5K", + EnqueueNanoBanana2TextToImageResolution::OneK => "1K", + EnqueueNanoBanana2TextToImageResolution::TwoK => "2K", + EnqueueNanoBanana2TextToImageResolution::FourK => "4K", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + // Auto + EnqueueNanoBanana2TextToImageAspectRatio::Auto => "auto", + // Square + EnqueueNanoBanana2TextToImageAspectRatio::OneByOne => "1:1", + // Wide + EnqueueNanoBanana2TextToImageAspectRatio::FiveByFour => "5:4", + EnqueueNanoBanana2TextToImageAspectRatio::FourByThree => "4:3", + EnqueueNanoBanana2TextToImageAspectRatio::ThreeByTwo => "3:2", + EnqueueNanoBanana2TextToImageAspectRatio::SixteenByNine => "16:9", + EnqueueNanoBanana2TextToImageAspectRatio::TwentyOneByNine => "21:9", + // Tall + EnqueueNanoBanana2TextToImageAspectRatio::FourByFive => "4:5", + EnqueueNanoBanana2TextToImageAspectRatio::ThreeByFour => "3:4", + EnqueueNanoBanana2TextToImageAspectRatio::TwoByThree => "2:3", + EnqueueNanoBanana2TextToImageAspectRatio::NineBySixteen => "9:16", + }) + .map(|ar| ar.to_string()); + + let request = NanoBanana2TextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + // Optionals + aspect_ratio, + resolution, + // Constants + output_format: Some("png".to_string()), + limit_generations: None, + safety_tolerance: Some("6".to_string()), + enable_web_search: None, + seed: None, + }; + + let result = nano_banana_2_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_nano_banana_2_text_to_image_webhook::{enqueue_nano_banana_2_text_to_image_webhook, EnqueueNanoBanana2TextToImageArgs, EnqueueNanoBanana2TextToImageAspectRatio, EnqueueNanoBanana2TextToImageNumImages, EnqueueNanoBanana2TextToImageRequest, EnqueueNanoBanana2TextToImageResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueNanoBanana2TextToImageArgs { + request: EnqueueNanoBanana2TextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: EnqueueNanoBanana2TextToImageNumImages::One, + aspect_ratio: Some(EnqueueNanoBanana2TextToImageAspectRatio::SixteenByNine), + resolution: Some(EnqueueNanoBanana2TextToImageResolution::TwoK), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_nano_banana_2_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_nano_banana_pro_text_to_image_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_nano_banana_pro_text_to_image_webhook.rs new file mode 100644 index 00000000..0f343268 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/enqueue_nano_banana_pro_text_to_image_webhook.rs @@ -0,0 +1,173 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::image::text::http_nano_banana_pro_text_to_image::{nano_banana_pro_text_to_image, NanoBananaProTextToImageInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::webhook::image::edit::enqueue_nano_banana_pro_edit_image_webhook::{EnqueueNanoBananaProEditImageArgs, EnqueueNanoBananaProEditImageNumImages, EnqueueNanoBananaProEditImageResolution}; + +pub struct EnqueueNanoBananaProTextToImageArgs<'a, R: IntoUrl> { + pub request: EnqueueNanoBananaProTextToImageRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueNanoBananaProTextToImageRequest { + // Required + pub prompt: String, + pub num_images: EnqueueNanoBananaProTextToImageNumImages, + + // Optional + pub resolution: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBananaProTextToImageNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBananaProTextToImageResolution { + OneK, + TwoK, + FourK, +} + +/// 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 +/// Default is "1:1" +#[derive(Copy, Clone, Debug)] +pub enum EnqueueNanoBananaProTextToImageAspectRatio { + // Square + OneByOne, + // Wide + FiveByFour, + FourByThree, + ThreeByTwo, + SixteenByNine, + TwentyOneByNine, + // Tall + FourByFive, + ThreeByFour, + TwoByThree, + NineBySixteen, // NB: No NineByTwentyOne ? +} + + +impl FalRequestCostCalculator for EnqueueNanoBananaProTextToImageRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Your request will cost $0.15 per image. + // For $1.00, you can run this model 7 times. + // 4K outputs will be charged at double the standard rate. + // If web search is used, an additional $0.015 will be charged. + // Note: Pricing may change in the future. + let cost = match self.resolution { + None => 15, + Some(EnqueueNanoBananaProTextToImageResolution::OneK) => 15, + Some(EnqueueNanoBananaProTextToImageResolution::TwoK) => 15, + Some(EnqueueNanoBananaProTextToImageResolution::FourK) => 30, + }; + let cost = match self.num_images { + EnqueueNanoBananaProTextToImageNumImages::One => cost, + EnqueueNanoBananaProTextToImageNumImages::Two => cost * 2, + EnqueueNanoBananaProTextToImageNumImages::Three => cost * 3, + EnqueueNanoBananaProTextToImageNumImages::Four => cost * 4, + }; + cost as UsdCents + } +} + + +pub async fn enqueue_nano_banana_pro_text_to_image_webhook( + args: EnqueueNanoBananaProTextToImageArgs<'_, R> +) -> Result { + + let req = args.request; + + let num_images = match req.num_images { + EnqueueNanoBananaProTextToImageNumImages::One => 1, + EnqueueNanoBananaProTextToImageNumImages::Two => 2, + EnqueueNanoBananaProTextToImageNumImages::Three => 3, + EnqueueNanoBananaProTextToImageNumImages::Four => 4, + }; + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueNanoBananaProTextToImageResolution::OneK => "1K", + EnqueueNanoBananaProTextToImageResolution::TwoK => "2K", + EnqueueNanoBananaProTextToImageResolution::FourK => "4K", + }) + .map(|resolution| resolution.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + // Square + EnqueueNanoBananaProTextToImageAspectRatio::OneByOne => "1:1", + // Wide + EnqueueNanoBananaProTextToImageAspectRatio::FiveByFour => "5:4", + EnqueueNanoBananaProTextToImageAspectRatio::FourByThree => "4:3", + EnqueueNanoBananaProTextToImageAspectRatio::ThreeByTwo => "3:2", + EnqueueNanoBananaProTextToImageAspectRatio::SixteenByNine => "16:9", + EnqueueNanoBananaProTextToImageAspectRatio::TwentyOneByNine => "21:9", + // Tall + EnqueueNanoBananaProTextToImageAspectRatio::FourByFive => "4:5", + EnqueueNanoBananaProTextToImageAspectRatio::ThreeByFour => "3:4", + EnqueueNanoBananaProTextToImageAspectRatio::TwoByThree => "2:3", + EnqueueNanoBananaProTextToImageAspectRatio::NineBySixteen => "9:16", + }) + .map(|aspect_ratio| aspect_ratio.to_string()); + + let request = NanoBananaProTextToImageInput { + prompt: req.prompt, + num_images: Some(num_images), + // Optionals + aspect_ratio, + resolution, + // Constants + output_format: Some("png".to_string()), + }; + + let result = nano_banana_pro_text_to_image(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::image::text::enqueue_nano_banana_pro_text_to_image_webhook::{enqueue_nano_banana_pro_text_to_image_webhook, EnqueueNanoBananaProTextToImageArgs, EnqueueNanoBananaProTextToImageAspectRatio, EnqueueNanoBananaProTextToImageNumImages, EnqueueNanoBananaProTextToImageRequest, EnqueueNanoBananaProTextToImageResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueNanoBananaProTextToImageArgs { + request: EnqueueNanoBananaProTextToImageRequest { + prompt: "an anime girl riding on the back of a t-rex".to_string(), + num_images: EnqueueNanoBananaProTextToImageNumImages::One, + aspect_ratio: Some(EnqueueNanoBananaProTextToImageAspectRatio::SixteenByNine), + resolution: Some(EnqueueNanoBananaProTextToImageResolution::TwoK), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_nano_banana_pro_text_to_image_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/image/text/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/mod.rs new file mode 100644 index 00000000..31991229 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/image/text/mod.rs @@ -0,0 +1,14 @@ +pub mod enqueue_bytedance_seedream_v4_text_to_image_webhook; +pub mod enqueue_bytedance_seedream_v4p5_text_to_image_webhook; +pub mod enqueue_bytedance_seedream_v5_lite_text_to_image_webhook; +pub mod enqueue_nano_banana_2_text_to_image_webhook; +pub mod enqueue_flux_1_dev_text_to_image_webhook; +pub mod enqueue_flux_1_schnell_text_to_image_webhook; +pub mod enqueue_flux_pro_11_text_to_image_webhook; +pub mod enqueue_flux_pro_11_ultra_text_to_image_webhook; +pub mod enqueue_gemini_25_flash_text_to_image_webhook; +pub mod enqueue_gpt_image_1_byok_text_to_image_webhook; +pub mod enqueue_gpt_image_1_text_to_image_webhook; +pub mod enqueue_gpt_image_1p5_text_to_image_webhook; +pub mod enqueue_gpt_image_2_text_to_image_webhook; +pub mod enqueue_nano_banana_pro_text_to_image_webhook; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/mod.rs new file mode 100644 index 00000000..c70c64e6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/mod.rs @@ -0,0 +1,3 @@ +pub mod image; +pub mod object; +pub mod video; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_image_to_3d_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_image_to_3d_webhook.rs new file mode 100644 index 00000000..3a8bec7f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_image_to_3d_webhook.rs @@ -0,0 +1,155 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::object::http_hunyuan3d_v3_image_to_3d::{hunyuan3d_v3_image_to_3d, Hunyuan3dV3ImageTo3dInput}; + +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueHunyuan3dV3ImageTo3dArgs<'a, R: IntoUrl> { + pub request: EnqueueHunyuan3dV3ImageTo3dRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueHunyuan3dV3ImageTo3dRequest { + // Required + pub image_url: String, + + // Optional + pub back_image_url: Option, + pub left_image_url: Option, + pub right_image_url: Option, + pub face_count: Option, + pub generate_type: Option, + pub polygon_type: Option, + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueHunyuan3dV3ImageTo3dGenerateType { + Normal, + LowPoly, + Geometry, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueHunyuan3dV3ImageTo3dPolygonType { + Triangle, + Quadrilateral, +} + +impl FalRequestCostCalculator for EnqueueHunyuan3dV3ImageTo3dRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "Your request will cost $0.375 per generation. + // For $1.00, you can run this model 2 times. + // Generation types: Normal costs $0.375, + // LowPoly costs $0.45, + // Geometry costs $0.225. + // Enabling PBR materials adds $0.15. + // Using multi-view images (back/left/right) adds $0.15. + // Custom face count adds $0.15. + let mut cost = match self.generate_type{ + None => 38, // Round up from $0.375 + Some(EnqueueHunyuan3dV3ImageTo3dGenerateType::Normal) => 38, // Round up + Some(EnqueueHunyuan3dV3ImageTo3dGenerateType::Geometry) => 23, // Round up + Some(EnqueueHunyuan3dV3ImageTo3dGenerateType::LowPoly) => 45, + }; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + let use_multi_view = self.left_image_url.is_some() + || self.right_image_url.is_some() + || self.back_image_url.is_some(); + if use_multi_view { + cost += 15; + } + cost + } +} + + +/// Veo 3.1 Image-to-Video +/// https://fal.ai/models/fal-ai/veo3.1/image-to-video +pub async fn enqueue_hunyuan3d_v3_image_to_3d_webhook( + args: EnqueueHunyuan3dV3ImageTo3dArgs<'_, R> +) -> Result { + + let req = args.request; + + let generate_type = req.generate_type + .map(|t| match t { + EnqueueHunyuan3dV3ImageTo3dGenerateType::Normal => "Normal", + EnqueueHunyuan3dV3ImageTo3dGenerateType::LowPoly => "LowPoly", + EnqueueHunyuan3dV3ImageTo3dGenerateType::Geometry => "Geometry", + }) + .map(|s| s.to_string()); + + let polygon_type = req.polygon_type + .map(|t| match t { + EnqueueHunyuan3dV3ImageTo3dPolygonType::Triangle => "triangle", + EnqueueHunyuan3dV3ImageTo3dPolygonType::Quadrilateral => "quadrilateral", + }) + .map(|s| s.to_string()); + + let request = Hunyuan3dV3ImageTo3dInput { + input_image_url: req.image_url, + // Optionals + back_image_url: req.back_image_url, + left_image_url: req.left_image_url, + right_image_url: req.right_image_url, + face_count: req.face_count, + generate_type, + polygon_type, + enable_pbr: req.enable_pbr, + }; + + let result = hunyuan3d_v3_image_to_3d(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::object::enqueue_hunyuan3d_v3_image_to_3d_webhook::{enqueue_hunyuan3d_v3_image_to_3d_webhook, EnqueueHunyuan3dV3ImageTo3dArgs, EnqueueHunyuan3dV3ImageTo3dRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueHunyuan3dV3ImageTo3dArgs { + request: EnqueueHunyuan3dV3ImageTo3dRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + back_image_url: None, + left_image_url: None, + right_image_url: None, + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hunyuan3d_v3_image_to_3d_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_sketch_to_3d_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_sketch_to_3d_webhook.rs new file mode 100644 index 00000000..d8ee3ad8 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_sketch_to_3d_webhook.rs @@ -0,0 +1,140 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::object::http_hunyuan3d_v3_sketch_to_3d::{hunyuan3d_v3_sketch_to_3d, Hunyuan3dV3SketchTo3dInput}; + +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueHunyuan3dV3SketchTo3dArgs<'a, R: IntoUrl> { + pub request: EnqueueHunyuan3dV3SketchTo3dRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueHunyuan3dV3SketchTo3dRequest { + // Required + pub prompt: String, + pub image_url: String, + + // Optional + pub face_count: Option, + pub generate_type: Option, + pub polygon_type: Option, + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueHunyuan3dV3SketchTo3dGenerateType { + Normal, + LowPoly, + Geometry, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueHunyuan3dV3SketchTo3dPolygonType { + Triangle, + Quadrilateral, +} + +impl FalRequestCostCalculator for EnqueueHunyuan3dV3SketchTo3dRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Generation types: Normal costs $0.375, + // LowPoly costs $0.45, + // Geometry costs $0.225. + // Enabling PBR materials adds $0.15. + // Custom face count adds $0.15. + let mut cost = match self.generate_type { + None => 38, // Round up from $0.375 + Some(EnqueueHunyuan3dV3SketchTo3dGenerateType::Normal) => 38, // Round up + Some(EnqueueHunyuan3dV3SketchTo3dGenerateType::Geometry) => 23, // Round up + Some(EnqueueHunyuan3dV3SketchTo3dGenerateType::LowPoly) => 45, + }; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + cost + } +} + + +/// Hunyuan3D V3 Sketch-to-3D +/// https://fal.ai/models/fal-ai/hunyuan3d-v3/sketch-to-3d +pub async fn enqueue_hunyuan3d_v3_sketch_to_3d_webhook( + args: EnqueueHunyuan3dV3SketchTo3dArgs<'_, R> +) -> Result { + + let req = args.request; + + let generate_type = req.generate_type + .map(|t| match t { + EnqueueHunyuan3dV3SketchTo3dGenerateType::Normal => "Normal", + EnqueueHunyuan3dV3SketchTo3dGenerateType::LowPoly => "LowPoly", + EnqueueHunyuan3dV3SketchTo3dGenerateType::Geometry => "Geometry", + }) + .map(|s| s.to_string()); + + let polygon_type = req.polygon_type + .map(|t| match t { + EnqueueHunyuan3dV3SketchTo3dPolygonType::Triangle => "triangle", + EnqueueHunyuan3dV3SketchTo3dPolygonType::Quadrilateral => "quadrilateral", + }) + .map(|s| s.to_string()); + + let request = Hunyuan3dV3SketchTo3dInput { + prompt: req.prompt, + input_image_url: req.image_url, + // Optionals + face_count: req.face_count, + generate_type, + polygon_type, + enable_pbr: req.enable_pbr, + }; + + let result = hunyuan3d_v3_sketch_to_3d(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::object::enqueue_hunyuan3d_v3_sketch_to_3d_webhook::{enqueue_hunyuan3d_v3_sketch_to_3d_webhook, EnqueueHunyuan3dV3SketchTo3dArgs, EnqueueHunyuan3dV3SketchTo3dRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueHunyuan3dV3SketchTo3dArgs { + request: EnqueueHunyuan3dV3SketchTo3dRequest { + prompt: "A cute robot".to_string(), + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hunyuan3d_v3_sketch_to_3d_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_text_to_3d_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_text_to_3d_webhook.rs new file mode 100644 index 00000000..29f4d133 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan3d_v3_text_to_3d_webhook.rs @@ -0,0 +1,136 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::object::http_hunyuan3d_v3_text_to_3d::{hunyuan3d_v3_text_to_3d, Hunyuan3dV3TextTo3dInput}; + +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueHunyuan3dV3TextTo3dArgs<'a, R: IntoUrl> { + pub request: EnqueueHunyuan3dV3TextTo3dRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueHunyuan3dV3TextTo3dRequest { + // Required + pub prompt: String, + + // Optional + pub face_count: Option, + pub generate_type: Option, + pub polygon_type: Option, + pub enable_pbr: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueHunyuan3dV3TextTo3dGenerateType { + Normal, + LowPoly, + Geometry, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueHunyuan3dV3TextTo3dPolygonType { + Triangle, + Quadrilateral, +} + +impl FalRequestCostCalculator for EnqueueHunyuan3dV3TextTo3dRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Generation types: Normal costs $0.375, + // LowPoly costs $0.45, + // Geometry costs $0.225. + // Enabling PBR materials adds $0.15. + // Custom face count adds $0.15. + let mut cost = match self.generate_type { + None => 38, // Round up from $0.375 + Some(EnqueueHunyuan3dV3TextTo3dGenerateType::Normal) => 38, // Round up + Some(EnqueueHunyuan3dV3TextTo3dGenerateType::Geometry) => 23, // Round up + Some(EnqueueHunyuan3dV3TextTo3dGenerateType::LowPoly) => 45, + }; + if self.enable_pbr.unwrap_or(false) { + cost += 15; + } + if self.face_count.is_some() { + cost += 15; + } + cost + } +} + + +/// Hunyuan3D V3 Text-to-3D +/// https://fal.ai/models/fal-ai/hunyuan3d-v3/text-to-3d +pub async fn enqueue_hunyuan3d_v3_text_to_3d_webhook( + args: EnqueueHunyuan3dV3TextTo3dArgs<'_, R> +) -> Result { + + let req = args.request; + + let generate_type = req.generate_type + .map(|t| match t { + EnqueueHunyuan3dV3TextTo3dGenerateType::Normal => "Normal", + EnqueueHunyuan3dV3TextTo3dGenerateType::LowPoly => "LowPoly", + EnqueueHunyuan3dV3TextTo3dGenerateType::Geometry => "Geometry", + }) + .map(|s| s.to_string()); + + let polygon_type = req.polygon_type + .map(|t| match t { + EnqueueHunyuan3dV3TextTo3dPolygonType::Triangle => "triangle", + EnqueueHunyuan3dV3TextTo3dPolygonType::Quadrilateral => "quadrilateral", + }) + .map(|s| s.to_string()); + + let request = Hunyuan3dV3TextTo3dInput { + prompt: req.prompt, + // Optionals + face_count: req.face_count, + generate_type, + polygon_type, + enable_pbr: req.enable_pbr, + }; + + let result = hunyuan3d_v3_text_to_3d(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::object::enqueue_hunyuan3d_v3_text_to_3d_webhook::{enqueue_hunyuan3d_v3_text_to_3d_webhook, EnqueueHunyuan3dV3TextTo3dArgs, EnqueueHunyuan3dV3TextTo3dRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueHunyuan3dV3TextTo3dArgs { + request: EnqueueHunyuan3dV3TextTo3dRequest { + prompt: "A velociraptor with an open mouth full of sharp teeth. Large claws, ready to strike.".to_string(), + face_count: None, + generate_type: None, + polygon_type: None, + enable_pbr: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hunyuan3d_v3_text_to_3d_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan_3d_21_image_to_3d_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan_3d_21_image_to_3d_webhook.rs new file mode 100644 index 00000000..34d1e095 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan_3d_21_image_to_3d_webhook.rs @@ -0,0 +1,71 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::object::http_hunyuan3d_v21_image_to_3d::{hunyuan3d_v21_image_to_3d, Hunyuan3dV21ImageTo3dInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Hunyuan3d21Args<'a, R: IntoUrl> { + pub request: Hunyuan3d21Request, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Hunyuan3d21Request { + pub image_url: String, +} + +pub async fn enqueue_hunyuan_3d_2_1_image_to_3d_webhook( + args: Hunyuan3d21Args<'_, R> +) -> Result { + let req = args.request; + + let request = Hunyuan3dV21ImageTo3dInput { + input_image_url: req.image_url, + textured_mesh: Some(true), + // TODO: Maybe expose these later + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + let result = hunyuan3d_v21_image_to_3d(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::object::enqueue_hunyuan_3d_21_image_to_3d_webhook::{enqueue_hunyuan_3d_2_1_image_to_3d_webhook, Hunyuan3d21Args, Hunyuan3d21Request}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test_hunyuan3d_21() -> AnyhowResult<()> { + let image_url = "https://cdn-2.fakeyou.com/media/p/a/c/7/j/pac7jgp2tkehm7j7sm4sky1fpnkrnbve/image_pac7jgp2tkehm7j7sm4sky1fpnkrnbve.png"; + + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Hunyuan3d21Args { + request: Hunyuan3d21Request { + image_url: image_url.to_string(), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hunyuan_3d_2_1_image_to_3d_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan_3d_2_image_to_3d_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan_3d_2_image_to_3d_webhook.rs new file mode 100644 index 00000000..377c07a2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/object/enqueue_hunyuan_3d_2_image_to_3d_webhook.rs @@ -0,0 +1,39 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::object::http_hunyuan3d_v2_image_to_3d::{hunyuan3d_v2_image_to_3d, Hunyuan3dV2ImageTo3dInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Hunyuan3d2Args<'a, R: IntoUrl> { + pub request: Hunyuan3d2Request, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Hunyuan3d2Request { + pub image_url: String, +} + +pub async fn enqueue_hunyuan_3d_2_image_to_3d_webhook( + args: Hunyuan3d2Args<'_, R> +) -> Result { + let req = args.request; + + let request = Hunyuan3dV2ImageTo3dInput { + input_image_url: req.image_url, + textured_mesh: Some(true), + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + let result = hunyuan3d_v2_image_to_3d(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/object/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/object/mod.rs new file mode 100644 index 00000000..c1c8ed49 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/object/mod.rs @@ -0,0 +1,5 @@ +pub mod enqueue_hunyuan_3d_2_image_to_3d_webhook; +pub mod enqueue_hunyuan_3d_21_image_to_3d_webhook; +pub mod enqueue_hunyuan3d_v3_image_to_3d_webhook; +pub mod enqueue_hunyuan3d_v3_sketch_to_3d_webhook; +pub mod enqueue_hunyuan3d_v3_text_to_3d_webhook; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..3e4e81f4 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook.rs @@ -0,0 +1,87 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_hailuo_v2p3_fast_pro_image_to_video::{hailuo_v2p3_fast_pro_image_to_video, HailuoV2p3FastProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueHailuoV2p3FastProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueHailuoV2p3FastProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueHailuoV2p3FastProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub prompt_optimizer: Option, +} + +impl FalRequestCostCalculator for EnqueueHailuoV2p3FastProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + /// "Your request will cost $0.33 per video." + 33 + } +} + + +/// Hailuo 2.3 Fast Pro Image-to-Video +/// https://fal.ai/models/fal-ai/minimax/hailuo-2.3-fast/pro/image-to-video +pub async fn enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook( + args: EnqueueHailuoV2p3FastProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + let prompt_optimizer = req.prompt_optimizer.unwrap_or(true); + + let request = HailuoV2p3FastProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + // Optionals + prompt_optimizer: Some(prompt_optimizer), + }; + + let result = hailuo_v2p3_fast_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook::{enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook, EnqueueHailuoV2p3FastProImageToVideoArgs, EnqueueHailuoV2p3FastProImageToVideoRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueHailuoV2p3FastProImageToVideoArgs { + request: EnqueueHailuoV2p3FastProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + prompt_optimizer: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_hailuo_v2p3_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_hailuo_v2p3_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..4be35887 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_hailuo_v2p3_pro_image_to_video_webhook.rs @@ -0,0 +1,87 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_hailuo_v2p3_pro_image_to_video::{hailuo_v2p3_pro_image_to_video, HailuoV2p3ProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueHailuoV2p3ProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueHailuoV2p3ProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueHailuoV2p3ProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub prompt_optimizer: Option, +} + +impl FalRequestCostCalculator for EnqueueHailuoV2p3ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + /// "Your request will cost $0.49 per video generation." + 49 + } +} + + +/// Hailuo 2.3 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/minimax/hailuo-2.3/pro/image-to-video +pub async fn enqueue_hailuo_v2p3_pro_image_to_video_webhook( + args: EnqueueHailuoV2p3ProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + let prompt_optimizer = req.prompt_optimizer.unwrap_or(true); + + let request = HailuoV2p3ProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + // Optionals + prompt_optimizer: Some(prompt_optimizer), + }; + + let result = hailuo_v2p3_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_hailuo_v2p3_pro_image_to_video_webhook::{enqueue_hailuo_v2p3_pro_image_to_video_webhook, EnqueueHailuoV2p3ProImageToVideoArgs, EnqueueHailuoV2p3ProImageToVideoRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueHailuoV2p3ProImageToVideoArgs { + request: EnqueueHailuoV2p3ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + prompt_optimizer: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hailuo_v2p3_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_3p0_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_3p0_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..9ffee997 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_3p0_pro_image_to_video_webhook.rs @@ -0,0 +1,319 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_3p0_pro_image_to_video::{kling_3p0_pro_image_to_video, Kling3p0ProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKling3p0ProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKling3p0ProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKling3p0ProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub end_image_url: Option, + pub generate_audio: Option, + pub negative_prompt: Option, + pub duration: Option, + pub aspect_ratio: Option, + pub shot_type: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0ProImageToVideoDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +impl EnqueueKling3p0ProImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::ThreeSeconds => 3, + Self::FourSeconds => 4, + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + Self::NineSeconds => 9, + Self::TenSeconds => 10, + Self::ElevenSeconds => 11, + Self::TwelveSeconds => 12, + Self::ThirteenSeconds => 13, + Self::FourteenSeconds => 14, + Self::FifteenSeconds => 15, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::ThreeSeconds => "3", + Self::FourSeconds => "4", + Self::FiveSeconds => "5", + Self::SixSeconds => "6", + Self::SevenSeconds => "7", + Self::EightSeconds => "8", + Self::NineSeconds => "9", + Self::TenSeconds => "10", + Self::ElevenSeconds => "11", + Self::TwelveSeconds => "12", + Self::ThirteenSeconds => "13", + Self::FourteenSeconds => "14", + Self::FifteenSeconds => "15", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0ProImageToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0ProImageToVideoShotType { + Customize, + Intelligent, +} + +impl FalRequestCostCalculator for EnqueueKling3p0ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Same pricing as text-to-video for Kling 3.0 Pro: + // Audio off: $0.224/second + // Audio on: $0.336/second + let generate_audio = self.generate_audio.unwrap_or(true); + let duration_secs = self.duration + .unwrap_or(EnqueueKling3p0ProImageToVideoDuration::FiveSeconds) + .to_seconds(); + + let rate = if generate_audio { 336u64 } else { 224u64 }; + (rate * duration_secs + 9) / 10 + } +} + +/// Kling 3.0 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v3/pro/image-to-video +pub async fn enqueue_kling_3p0_pro_image_to_video_webhook( + args: EnqueueKling3p0ProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| d.to_str().to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueKling3p0ProImageToVideoAspectRatio::Square => "1:1", + EnqueueKling3p0ProImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueKling3p0ProImageToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let shot_type = req.shot_type + .map(|st| match st { + EnqueueKling3p0ProImageToVideoShotType::Customize => "customize", + EnqueueKling3p0ProImageToVideoShotType::Intelligent => "intelligent", + }) + .map(|s| s.to_string()); + + let request = Kling3p0ProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + end_image_url: req.end_image_url, + aspect_ratio, + generate_audio: req.generate_audio, + duration, + negative_prompt: req.negative_prompt, + shot_type, + cfg_scale: None, + }; + + let result = kling_3p0_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[test] + fn test_cost() { + let mut req = EnqueueKling3p0ProImageToVideoRequest { + prompt: "the t-rex skeleton leaps off the podium and charges".to_string(), + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + end_image_url: None, + generate_audio: Some(false), + negative_prompt: None, + duration: Some(EnqueueKling3p0ProImageToVideoDuration::FiveSeconds), + aspect_ratio: None, + shot_type: None, + }; + + // Audio off: $0.224/sec + // 5s: (224 * 5 + 9) / 10 = 1129 / 10 = 112 + assert_eq!(req.calculate_cost_in_cents(), 112); + + // 10s: (224 * 10 + 9) / 10 = 2249 / 10 = 224 + req.duration = Some(EnqueueKling3p0ProImageToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 224); + + // 15s: (224 * 15 + 9) / 10 = 3369 / 10 = 336 + req.duration = Some(EnqueueKling3p0ProImageToVideoDuration::FifteenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 336); + + // Audio on: $0.336/sec + req.generate_audio = Some(true); + + // 5s: (336 * 5 + 9) / 10 = 1689 / 10 = 168 + req.duration = Some(EnqueueKling3p0ProImageToVideoDuration::FiveSeconds); + assert_eq!(req.calculate_cost_in_cents(), 168); + + // 10s: (336 * 10 + 9) / 10 = 3369 / 10 = 336 + req.duration = Some(EnqueueKling3p0ProImageToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 336); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKling3p0ProImageToVideoArgs { + request: EnqueueKling3p0ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera, then bites".to_string(), + duration: Some(EnqueueKling3p0ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0ProImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(true), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_3p0_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueKling3p0ProImageToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueKling3p0ProImageToVideoArgs { + request: EnqueueKling3p0ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton comes alive and roars at the camera".to_string(), + duration: Some(EnqueueKling3p0ProImageToVideoDuration::ThreeSeconds), + aspect_ratio: Some(ar), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueKling3p0ProImageToVideoDuration::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueKling3p0ProImageToVideoArgs { + request: EnqueueKling3p0ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly turns its head and roars".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueKling3p0ProImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_shot_types() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for st in EnqueueKling3p0ProImageToVideoShotType::iter() { + println!("--- shot type: {:?} ---", st); + let args = EnqueueKling3p0ProImageToVideoArgs { + request: EnqueueKling3p0ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton lurches forward and snaps its jaws".to_string(), + duration: Some(EnqueueKling3p0ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0ProImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(true), + negative_prompt: None, + end_image_url: None, + shot_type: Some(st), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_3p0_standard_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_3p0_standard_image_to_video_webhook.rs new file mode 100644 index 00000000..3c10a682 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_3p0_standard_image_to_video_webhook.rs @@ -0,0 +1,319 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_3p0_standard_image_to_video::{kling_3p0_standard_image_to_video, Kling3p0StandardImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKling3p0StandardImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKling3p0StandardImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKling3p0StandardImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub end_image_url: Option, + pub generate_audio: Option, + pub negative_prompt: Option, + pub duration: Option, + pub aspect_ratio: Option, + pub shot_type: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0StandardImageToVideoDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +impl EnqueueKling3p0StandardImageToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::ThreeSeconds => 3, + Self::FourSeconds => 4, + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + Self::NineSeconds => 9, + Self::TenSeconds => 10, + Self::ElevenSeconds => 11, + Self::TwelveSeconds => 12, + Self::ThirteenSeconds => 13, + Self::FourteenSeconds => 14, + Self::FifteenSeconds => 15, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::ThreeSeconds => "3", + Self::FourSeconds => "4", + Self::FiveSeconds => "5", + Self::SixSeconds => "6", + Self::SevenSeconds => "7", + Self::EightSeconds => "8", + Self::NineSeconds => "9", + Self::TenSeconds => "10", + Self::ElevenSeconds => "11", + Self::TwelveSeconds => "12", + Self::ThirteenSeconds => "13", + Self::FourteenSeconds => "14", + Self::FifteenSeconds => "15", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0StandardImageToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0StandardImageToVideoShotType { + Customize, + Intelligent, +} + +impl FalRequestCostCalculator for EnqueueKling3p0StandardImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Same pricing as text-to-video for Kling 3.0 Standard: + // Audio off: $0.168/second + // Audio on: $0.252/second + let generate_audio = self.generate_audio.unwrap_or(true); + let duration_secs = self.duration + .unwrap_or(EnqueueKling3p0StandardImageToVideoDuration::FiveSeconds) + .to_seconds(); + + let rate = if generate_audio { 252u64 } else { 168u64 }; + (rate * duration_secs + 9) / 10 + } +} + +/// Kling 3.0 Standard Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v3/standard/image-to-video +pub async fn enqueue_kling_3p0_standard_image_to_video_webhook( + args: EnqueueKling3p0StandardImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| d.to_str().to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueKling3p0StandardImageToVideoAspectRatio::Square => "1:1", + EnqueueKling3p0StandardImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueKling3p0StandardImageToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let shot_type = req.shot_type + .map(|st| match st { + EnqueueKling3p0StandardImageToVideoShotType::Customize => "customize", + EnqueueKling3p0StandardImageToVideoShotType::Intelligent => "intelligent", + }) + .map(|s| s.to_string()); + + let request = Kling3p0StandardImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + end_image_url: req.end_image_url, + aspect_ratio, + generate_audio: req.generate_audio, + duration, + negative_prompt: req.negative_prompt, + shot_type, + cfg_scale: None, + }; + + let result = kling_3p0_standard_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[test] + fn test_cost() { + let mut req = EnqueueKling3p0StandardImageToVideoRequest { + prompt: "the t-rex skeleton comes alive and roars".to_string(), + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + end_image_url: None, + generate_audio: Some(false), + negative_prompt: None, + duration: Some(EnqueueKling3p0StandardImageToVideoDuration::FiveSeconds), + aspect_ratio: None, + shot_type: None, + }; + + // Audio off: $0.168/sec + // 5s: (168 * 5 + 9) / 10 = 849 / 10 = 84 + assert_eq!(req.calculate_cost_in_cents(), 84); + + // 10s: (168 * 10 + 9) / 10 = 1689 / 10 = 168 + req.duration = Some(EnqueueKling3p0StandardImageToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 168); + + // 15s: (168 * 15 + 9) / 10 = 2529 / 10 = 252 + req.duration = Some(EnqueueKling3p0StandardImageToVideoDuration::FifteenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 252); + + // Audio on: $0.252/sec + req.generate_audio = Some(true); + + // 5s: (252 * 5 + 9) / 10 = 1269 / 10 = 126 + req.duration = Some(EnqueueKling3p0StandardImageToVideoDuration::FiveSeconds); + assert_eq!(req.calculate_cost_in_cents(), 126); + + // 10s: (252 * 10 + 9) / 10 = 2529 / 10 = 252 + req.duration = Some(EnqueueKling3p0StandardImageToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 252); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKling3p0StandardImageToVideoArgs { + request: EnqueueKling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking toward the camera".to_string(), + duration: Some(EnqueueKling3p0StandardImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(true), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_3p0_standard_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueKling3p0StandardImageToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueKling3p0StandardImageToVideoArgs { + request: EnqueueKling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton comes alive and roars at the camera".to_string(), + duration: Some(EnqueueKling3p0StandardImageToVideoDuration::ThreeSeconds), + aspect_ratio: Some(ar), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_standard_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueKling3p0StandardImageToVideoDuration::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueKling3p0StandardImageToVideoArgs { + request: EnqueueKling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly turns its head and opens its jaw".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueKling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(false), + negative_prompt: None, + end_image_url: None, + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_standard_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_shot_types() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for st in EnqueueKling3p0StandardImageToVideoShotType::iter() { + println!("--- shot type: {:?} ---", st); + let args = EnqueueKling3p0StandardImageToVideoArgs { + request: EnqueueKling3p0StandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton lurches forward dramatically".to_string(), + duration: Some(EnqueueKling3p0StandardImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0StandardImageToVideoAspectRatio::SixteenByNine), + generate_audio: Some(true), + negative_prompt: None, + end_image_url: None, + shot_type: Some(st), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_standard_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v1p6_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v1p6_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..4e3deb7e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v1p6_pro_image_to_video_webhook.rs @@ -0,0 +1,120 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_v1p6_pro_image_to_video::{kling_v1p6_pro_image_to_video, KlingV1p6ProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Kling1p6ProArgs<'a, R: IntoUrl> { + pub request: Kling1p6ProRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Kling1p6ProRequest { + pub image_url: String, + pub end_frame_image_url: Option, + pub prompt: String, + pub duration: Kling1p6ProDuration, + pub aspect_ratio: Kling1p6ProAspectRatio, +} + +#[derive(Copy, Clone, Debug)] +pub enum Kling1p6ProDuration { + Default, + FiveSeconds, + TenSeconds, +} + +#[derive(Copy, Clone, Debug)] +pub enum Kling1p6ProAspectRatio { + Square, // 1:1 + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +impl FalRequestCostCalculator for Kling1p6ProRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "Your request will cost $0.095 per second." + match self.duration { + Kling1p6ProDuration::Default => 48, // $0.095 * 5 = $0.475 (round up) + Kling1p6ProDuration::FiveSeconds => 48, // $0.095 * 5 = $0.475 (round up) + Kling1p6ProDuration::TenSeconds => 95, // $0.095 * 10 = $0.95 + } + } +} + + +/// Kling 1.6 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v1.6/pro/image-to-video +pub async fn enqueue_kling_v1p6_pro_image_to_video_webhook( + args: Kling1p6ProArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Kling1p6ProDuration::Default => None, // defaults to "5" + Kling1p6ProDuration::FiveSeconds => Some("5".to_string()), // Gross... + Kling1p6ProDuration::TenSeconds => Some("10".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Kling1p6ProAspectRatio::Square => Some("1:1".to_string()), + Kling1p6ProAspectRatio::WideSixteenNine => Some("16:9".to_string()), + Kling1p6ProAspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let request = KlingV1p6ProImageToVideoInput { + image_url: req.image_url, + tail_image_url: req.end_frame_image_url, + prompt: req.prompt, + aspect_ratio, + duration, + // Maybe expose these later + cfg_scale: None, + negative_prompt: None, + }; + + let result = kling_v1p6_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_kling_v1p6_pro_image_to_video_webhook::{enqueue_kling_v1p6_pro_image_to_video_webhook, Kling1p6ProArgs, Kling1p6ProRequest, Kling1p6ProAspectRatio, Kling1p6ProDuration}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Kling1p6ProArgs { + request: Kling1p6ProRequest { + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_frame_image_url: Some(JUNO_AT_LAKE_IMAGE_URL.to_string()), + prompt: "shiba in glasses runs to the lake and stands by the shore".to_string(), + duration: Kling1p6ProDuration::Default, + aspect_ratio: Kling1p6ProAspectRatio::WideSixteenNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v1p6_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p1_master_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p1_master_image_to_video_webhook.rs new file mode 100644 index 00000000..76cdc89b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p1_master_image_to_video_webhook.rs @@ -0,0 +1,121 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::image::http_kling_v2p1_master_image_to_video::{kling_v2p1_master_image_to_video, KlingV2p1MasterImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; + +pub struct Kling2p1MasterArgs<'a, R: IntoUrl> { + pub request: Kling2p1MasterRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Kling2p1MasterRequest { + pub image_url: String, + pub prompt: String, + pub duration: Kling2p1MasterDuration, + pub aspect_ratio: Kling2p1MasterAspectRatio, +} + +#[derive(Copy, Clone, Debug)] +pub enum Kling2p1MasterDuration { + Default, + FiveSeconds, + TenSeconds, +} + +#[derive(Copy, Clone, Debug)] +pub enum Kling2p1MasterAspectRatio { + Square, // 1:1 + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +impl FalRequestCostCalculator for Kling2p1MasterRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost $1.40. + // For every additional second you will be charged $0.28." + match self.duration { + Kling2p1MasterDuration::Default => 140, // $1.40 for 5 seconds + Kling2p1MasterDuration::FiveSeconds => 140, // $1.40 for 5 seconds + Kling2p1MasterDuration::TenSeconds => 280, // $1.40 + (0.28 * 5) = $2.80 + } + } +} + + +/// Kling 2.1 Master Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.1/master/image-to-video +pub async fn enqueue_kling_v2p1_master_image_to_video_webhook( + args: Kling2p1MasterArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Kling2p1MasterDuration::Default => None, // defaults to "5" + Kling2p1MasterDuration::FiveSeconds => Some("5".to_string()), // Gross... + Kling2p1MasterDuration::TenSeconds => Some("10".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Kling2p1MasterAspectRatio::Square => Some("1:1".to_string()), + Kling2p1MasterAspectRatio::WideSixteenNine => Some("16:9".to_string()), + Kling2p1MasterAspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let request = KlingV2p1MasterImageToVideoInput { + image_url: req.image_url, + prompt: req.prompt, + aspect_ratio, + duration, + // Maybe expose these later + cfg_scale: None, + negative_prompt: None, + tail_image_url: None, + }; + + let result = kling_v2p1_master_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_kling_v2p1_master_image_to_video_webhook::{enqueue_kling_v2p1_master_image_to_video_webhook, Kling2p1MasterArgs, Kling2p1MasterRequest, Kling2p1MasterAspectRatio, Kling2p1MasterDuration}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test_kling21_master_video() -> AnyhowResult<()> { + let image_url = "https://cdn-2.fakeyou.com/media/3/4/h/f/s/34hfsmt8e38rvne6mwa4pwbxr6292sgy/image_34hfsmt8e38rvne6mwa4pwbxr6292sgy.png"; + + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Kling2p1MasterArgs { + request: Kling2p1MasterRequest { + image_url: image_url.to_string(), + prompt: "a shot of the mountains, the camera rotates around to show the mountain range, the sun begins to set, and the moon becomes visible".to_string(), + duration: Kling2p1MasterDuration::Default, + aspect_ratio: Kling2p1MasterAspectRatio::WideSixteenNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p1_master_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p1_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p1_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..b8f15beb --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p1_pro_image_to_video_webhook.rs @@ -0,0 +1,120 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_v2p1_pro_image_to_video::{kling_v2p1_pro_image_to_video, KlingV2p1ProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Kling2p1ProArgs<'a, R: IntoUrl> { + pub request: Kling2p1ProRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Kling2p1ProRequest { + pub image_url: String, + pub end_frame_image_url: Option, + pub prompt: String, + pub duration: Kling2p1ProDuration, + pub aspect_ratio: Kling2p1ProAspectRatio, +} + +#[derive(Copy, Clone, Debug)] +pub enum Kling2p1ProDuration { + Default, + FiveSeconds, + TenSeconds, +} + +#[derive(Copy, Clone, Debug)] +pub enum Kling2p1ProAspectRatio { + Square, // 1:1 + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +impl FalRequestCostCalculator for Kling2p1ProRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost $0.45. + // For every additional second you will be charged $0.09." + match self.duration { + Kling2p1ProDuration::Default => 45, // $0.45 + Kling2p1ProDuration::FiveSeconds => 45, // $0.45 + Kling2p1ProDuration::TenSeconds => 90, // $0.45 + (5 * 0.09) = $0.90 + } + } +} + +/// Kling 2.1 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.1/pro/image-to-video +pub async fn enqueue_kling_v2p1_pro_image_to_video_webhook( + args: Kling2p1ProArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Kling2p1ProDuration::Default => None, // Defaults to 5 seconds + Kling2p1ProDuration::FiveSeconds => Some("5".to_string()), // Gross... + Kling2p1ProDuration::TenSeconds => Some("10".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Kling2p1ProAspectRatio::Square => Some("1:1".to_string()), + Kling2p1ProAspectRatio::WideSixteenNine => Some("16:9".to_string()), + Kling2p1ProAspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let request = KlingV2p1ProImageToVideoInput { + image_url: req.image_url, + prompt: req.prompt, + tail_image_url: req.end_frame_image_url, + aspect_ratio, + duration, + // Maybe expose these later + cfg_scale: None, + negative_prompt: None, + }; + + let result = kling_v2p1_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_kling_v2p1_pro_image_to_video_webhook::{enqueue_kling_v2p1_pro_image_to_video_webhook, Kling2p1ProArgs, Kling2p1ProRequest, Kling2p1ProAspectRatio, Kling2p1ProDuration}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, SUPER_WIDE_FALL_MOUNTAINS_IMAGE_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Kling2p1ProArgs { + request: Kling2p1ProRequest { + image_url: SUPER_WIDE_FALL_MOUNTAINS_IMAGE_URL.to_string(), + end_frame_image_url: Some(JUNO_AT_LAKE_IMAGE_URL.to_string()), + prompt: "a shot of the mountains, the camera pulls back to show a corgi waiting to jump into the lake".to_string(), + duration: Kling2p1ProDuration::Default, + aspect_ratio: Kling2p1ProAspectRatio::WideSixteenNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p1_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p5_turbo_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p5_turbo_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..3abb2c2a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p5_turbo_pro_image_to_video_webhook.rs @@ -0,0 +1,114 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_v2p5_turbo_pro_image_to_video::{kling_v2p5_turbo_pro_image_to_video, KlingV2p5TurboProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKlingV2p5TurboProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKlingV2p5TurboProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKlingV2p5TurboProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub tail_image_url: Option, + pub negative_prompt: Option, + + pub duration: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p5TurboProImageToVideoDurationSeconds { + Five, + Ten, +} + +impl FalRequestCostCalculator for EnqueueKlingV2p5TurboProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost $0.35. + // For every additional second you will be charged $0.07." + match self.duration { + None => 35, // $0.35 + Some(EnqueueKlingV2p5TurboProImageToVideoDurationSeconds::Five) => 35, // $0.35 + Some(EnqueueKlingV2p5TurboProImageToVideoDurationSeconds::Ten) => 70, // $0.35 + (5 * $0.07) = $0.70 + } + } +} + + +/// Kling 2.5 Turbo Pro Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.5-turbo/pro/image-to-video +pub async fn enqueue_kling_v2p5_turbo_pro_image_to_video_webhook( + args: EnqueueKlingV2p5TurboProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + // NB: Defaults to 5 seconds + let duration = req.duration + .map(|resolution| match resolution { + EnqueueKlingV2p5TurboProImageToVideoDurationSeconds::Five => "5", + EnqueueKlingV2p5TurboProImageToVideoDurationSeconds::Ten => "10", + }) + .map(|resolution| resolution.to_string()); + + let request = KlingV2p5TurboProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + // Optionals + duration, + tail_image_url: req.tail_image_url, + negative_prompt: req.negative_prompt, + // Constants + cfg_scale: None, + }; + + let result = kling_v2p5_turbo_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_kling_v2p5_turbo_pro_image_to_video_webhook::{enqueue_kling_v2p5_turbo_pro_image_to_video_webhook, EnqueueKlingV2p5TurboProImageToVideoArgs, EnqueueKlingV2p5TurboProImageToVideoRequest, EnqueueKlingV2p5TurboProImageToVideoDurationSeconds}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKlingV2p5TurboProImageToVideoArgs { + request: EnqueueKlingV2p5TurboProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + negative_prompt: None, + tail_image_url: None, + duration: Some(EnqueueKlingV2p5TurboProImageToVideoDurationSeconds::Five), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p5_turbo_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p5_turbo_standard_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p5_turbo_standard_image_to_video_webhook.rs new file mode 100644 index 00000000..d3511325 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p5_turbo_standard_image_to_video_webhook.rs @@ -0,0 +1,110 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_v2p5_turbo_standard_image_to_video::{kling_v2p5_turbo_standard_image_to_video, KlingV2p5TurboStandardImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKlingV2p5TurboStandardImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKlingV2p5TurboStandardImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKlingV2p5TurboStandardImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub negative_prompt: Option, + pub duration: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds { + Five, + Ten, +} + + +impl FalRequestCostCalculator for EnqueueKlingV2p5TurboStandardImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost $0.21. + // For every additional second you will be charged $0.042." + match self.duration { + None => 21, // $0.21 + Some(EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds::Five) => 21, // $0.21 + Some(EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds::Ten) => 42, // $0.21 + (5 * $0.042) = $0.42 + } + } +} + +/// Kling 2.5 Turbo Standard Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.5-turbo/standard/image-to-video +pub async fn enqueue_kling_v2p5_turbo_standard_image_to_video_webhook( + args: EnqueueKlingV2p5TurboStandardImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + // NB: Defaults to 5 seconds. + let duration = req.duration + .map(|resolution| match resolution { + EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds::Five => "5", + EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds::Ten => "10", + }) + .map(|resolution| resolution.to_string()); + + let request = KlingV2p5TurboStandardImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + // Optionals + duration, + negative_prompt: req.negative_prompt, + // Constants + cfg_scale: None, + }; + + let result = kling_v2p5_turbo_standard_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_kling_v2p5_turbo_standard_image_to_video_webhook::{enqueue_kling_v2p5_turbo_standard_image_to_video_webhook, EnqueueKlingV2p5TurboStandardImageToVideoArgs, EnqueueKlingV2p5TurboStandardImageToVideoRequest, EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKlingV2p5TurboStandardImageToVideoArgs { + request: EnqueueKlingV2p5TurboStandardImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + negative_prompt: None, + duration: Some(EnqueueKlingV2p5TurboStandardImageToVideoDurationSeconds::Five), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p5_turbo_standard_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p6_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p6_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..446b6cca --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_kling_v2p6_pro_image_to_video_webhook.rs @@ -0,0 +1,120 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_kling_v2p6_pro_image_to_video::{kling_v2p6_pro_image_to_video, KlingV2p6ProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKlingV2p6ProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKlingV2p6ProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKlingV2p6ProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + + /// NB: Generate audio defaults to true, and it costs twice as much. + pub generate_audio: Option, + + pub negative_prompt: Option, + + /// NB: Duration defaults to 5 seconds + pub duration: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p6ProImageToVideoDurationSeconds { + Five, + Ten, +} + +impl FalRequestCostCalculator for EnqueueKlingV2p6ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be + // charged $0.07 (audio off) or $0.14 (audio on). + // For example, a 5s video with audio on will cost $0.70" + let generate_audio = self.generate_audio.unwrap_or(true); + let duration = self.duration.unwrap_or(EnqueueKlingV2p6ProImageToVideoDurationSeconds::Five); + + match (generate_audio, duration) { + (false, EnqueueKlingV2p6ProImageToVideoDurationSeconds::Five) => 35, // audio off: $0.07 * 5 = $0.35 + (false, EnqueueKlingV2p6ProImageToVideoDurationSeconds::Ten) => 70, // audio off: $0.07 * 10 = $0.70 + (true, EnqueueKlingV2p6ProImageToVideoDurationSeconds::Five) => 70, // audio on: $0.14 * 5 = $0.70 + (true, EnqueueKlingV2p6ProImageToVideoDurationSeconds::Ten) => 140, // audio on: $0.14 * 10 = $1.40 + } + } +} + + +/// Kling 2.6 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.6/pro/image-to-video +pub async fn enqueue_kling_v2p6_pro_image_to_video_webhook( + args: EnqueueKlingV2p6ProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueKlingV2p6ProImageToVideoDurationSeconds::Five => "5", + EnqueueKlingV2p6ProImageToVideoDurationSeconds::Ten => "10", + }) + .map(|resolution| resolution.to_string()); + + let request = KlingV2p6ProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + // Optionals + duration, + negative_prompt: req.negative_prompt, + generate_audio: req.generate_audio, + }; + + let result = kling_v2p6_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_kling_v2p6_pro_image_to_video_webhook::{enqueue_kling_v2p6_pro_image_to_video_webhook, EnqueueKlingV2p6ProImageToVideoArgs, EnqueueKlingV2p6ProImageToVideoRequest, EnqueueKlingV2p6ProImageToVideoDurationSeconds}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKlingV2p6ProImageToVideoArgs { + request: EnqueueKlingV2p6ProImageToVideoRequest { + image_url: ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + prompt: "the man says, 'these ghosts sure are scary!' and then runs. behind him, a group of ghosts appear from the trees and chase him. the camera tracks the action. finally, the man yells, 'go away ghosts'.".to_string(), + negative_prompt: None, + generate_audio: Some(true), + duration: Some(EnqueueKlingV2p6ProImageToVideoDurationSeconds::Ten), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p6_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_pixverse_v5_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_pixverse_v5_image_to_video_webhook.rs new file mode 100644 index 00000000..d602c10e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_pixverse_v5_image_to_video_webhook.rs @@ -0,0 +1,190 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_pixverse_v5_image_to_video::{pixverse_v5_image_to_video, PixverseV5ImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueuePixverseV5ImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueuePixverseV5ImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueuePixverseV5ImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub negative_prompt: Option, + + // NB: eight-second videos do not work with 1080P + // NB: Defaults to 5 seconds + pub duration: Option, + pub aspect_ratio: Option, + + // NB: Defaults to 720p + pub resolution: Option, + pub style: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5ImageToVideoDurationSeconds { + Five, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5ImageToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5ImageToVideoAspectRatio { + Square, + SixteenByNine, + FourByThree, + NineBySixteen, + ThreeByFour, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5ImageToVideoStyle { + Anime, + Animation3d, + Clay, + Comic, + Cyberpunk, +} + +impl FalRequestCostCalculator for EnqueuePixverseV5ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost + // $0.15 for 360p and 540p, + // $0.2 for 720p and + // $0.4 for 1080p. + // For $1 you can run this model with approximately 2 times." + let duration = self.duration.unwrap_or(EnqueuePixverseV5ImageToVideoDurationSeconds::Five); + let resolution = self.resolution.unwrap_or(EnqueuePixverseV5ImageToVideoResolution::SevenTwentyP); + match (duration, resolution) { + // Five seconds + (EnqueuePixverseV5ImageToVideoDurationSeconds::Five, EnqueuePixverseV5ImageToVideoResolution::ThreeSixtyP) => 15, // $0.15 + (EnqueuePixverseV5ImageToVideoDurationSeconds::Five, EnqueuePixverseV5ImageToVideoResolution::FiveFortyP) => 15, // $0.15 + (EnqueuePixverseV5ImageToVideoDurationSeconds::Five, EnqueuePixverseV5ImageToVideoResolution::SevenTwentyP) => 20, // $0.20 + (EnqueuePixverseV5ImageToVideoDurationSeconds::Five, EnqueuePixverseV5ImageToVideoResolution::TenEightyP) => 40, // $0.40 + // Ten seconds + (EnqueuePixverseV5ImageToVideoDurationSeconds::Eight, EnqueuePixverseV5ImageToVideoResolution::ThreeSixtyP) => 30, // NB: Doubling since unclear + (EnqueuePixverseV5ImageToVideoDurationSeconds::Eight, EnqueuePixverseV5ImageToVideoResolution::FiveFortyP) => 30, // NB: Doubling since unclear + (EnqueuePixverseV5ImageToVideoDurationSeconds::Eight, EnqueuePixverseV5ImageToVideoResolution::SevenTwentyP) => 40, // NB: Doubling since unclear + (EnqueuePixverseV5ImageToVideoDurationSeconds::Eight, EnqueuePixverseV5ImageToVideoResolution::TenEightyP) => 80, // NB: Doubling since unclear + } + } +} + + +/// Pixverse 5 Image-to-Video +/// https://fal.ai/models/fal-ai/pixverse/v5/image-to-video +pub async fn enqueue_pixverse_v5_image_to_video_webhook( + args: EnqueuePixverseV5ImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueuePixverseV5ImageToVideoDurationSeconds::Five => "5", + EnqueuePixverseV5ImageToVideoDurationSeconds::Eight=> "8", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueuePixverseV5ImageToVideoAspectRatio::Square => "1:1", + EnqueuePixverseV5ImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueuePixverseV5ImageToVideoAspectRatio::FourByThree => "4:3", + EnqueuePixverseV5ImageToVideoAspectRatio::NineBySixteen => "9:16", + EnqueuePixverseV5ImageToVideoAspectRatio::ThreeByFour => "3:4", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueuePixverseV5ImageToVideoResolution::ThreeSixtyP => "360p", + EnqueuePixverseV5ImageToVideoResolution::FiveFortyP => "540p", + EnqueuePixverseV5ImageToVideoResolution::SevenTwentyP => "720p", + EnqueuePixverseV5ImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let style = req.style + .map(|style| match style { + EnqueuePixverseV5ImageToVideoStyle::Anime => "anime", + EnqueuePixverseV5ImageToVideoStyle::Animation3d => "3d_animation", + EnqueuePixverseV5ImageToVideoStyle::Clay => "clay", + EnqueuePixverseV5ImageToVideoStyle::Comic => "comic", + EnqueuePixverseV5ImageToVideoStyle::Cyberpunk => "cyberpunk", + }) + .map(|s| s.to_string()); + + let request = PixverseV5ImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + // Optionals + duration, + negative_prompt: req.negative_prompt, + aspect_ratio, + resolution, + style, + // Constant + seed: None, + }; + + let result = pixverse_v5_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_pixverse_v5_image_to_video_webhook::{enqueue_pixverse_v5_image_to_video_webhook, EnqueuePixverseV5ImageToVideoArgs, EnqueuePixverseV5ImageToVideoAspectRatio, EnqueuePixverseV5ImageToVideoDurationSeconds, EnqueuePixverseV5ImageToVideoRequest, EnqueuePixverseV5ImageToVideoResolution, EnqueuePixverseV5ImageToVideoStyle}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueuePixverseV5ImageToVideoArgs { + request: EnqueuePixverseV5ImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + negative_prompt: None, + duration: Some(EnqueuePixverseV5ImageToVideoDurationSeconds::Five), + style: Some(EnqueuePixverseV5ImageToVideoStyle::Cyberpunk), + aspect_ratio: Some(EnqueuePixverseV5ImageToVideoAspectRatio::FourByThree), + resolution: Some(EnqueuePixverseV5ImageToVideoResolution::TenEightyP), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_pixverse_v5_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1_lite_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1_lite_image_to_video_webhook.rs new file mode 100644 index 00000000..07e66ff1 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1_lite_image_to_video_webhook.rs @@ -0,0 +1,219 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_seedance_1_lite_image_to_video::{seedance_1_lite_image_to_video, Seedance1LiteImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Seedance1LiteArgs<'a, V: IntoUrl> { + pub request: Seedance1LiteRequest, + pub api_key: &'a FalApiKey, + pub webhook_url: V, +} + +#[derive(Clone, Debug)] +pub struct Seedance1LiteRequest { + pub image_url: String, + pub end_frame_image_url: Option, + pub prompt: String, + pub duration: Seedance1LiteDuration, + pub resolution: Seedance1LiteResolution, + pub aspect_ratio: Option, + pub camera_fixed: bool, + pub seed: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Seedance1LiteDuration { + FiveSeconds, + TenSeconds, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Seedance1LiteResolution { + FourEightyP, // 480p + SevenTwentyP, // 720p + TenEightyP, // 1080p +} + +/// Possible enum values: 21:9, 16:9, 4:3, 1:1, 3:4, 9:16, auto +#[derive(Copy, Clone, Debug)] +pub enum Seedance1LiteAspectRatio { + Auto, + TwentyOneByNine, + SixteenByNine, + FourByThree, + Square, + ThreeByFour, + NineBySixteen, +} + + +impl FalRequestCostCalculator for Seedance1LiteRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "Each 720p 5 second video costs $0.18. + // For other resolutions, 1 million video tokens costs $1.8. + // tokens(video) = (height x width x FPS x duration) / 1024." + + if self.resolution == Seedance1LiteResolution::SevenTwentyP + && self.duration == Seedance1LiteDuration::FiveSeconds + { + return 18; + } + + // TODO: Only correct for some aspect ratios for now. + let (width, height) = match self.resolution { + Seedance1LiteResolution::FourEightyP => (640u32, 480u32), // NB: Only for 4:3 ! + Seedance1LiteResolution::SevenTwentyP => (1280, 720), // NB: Only for 16:9 ! + Seedance1LiteResolution::TenEightyP => (1920, 1080), + }; + + let duration = match self.duration { + Seedance1LiteDuration::FiveSeconds => 5.0, + Seedance1LiteDuration::TenSeconds => 10.0, + }; + + // TODO: Not sure if FPS is right. + // Inferred from https://help.scenario.com/en/articles/seedance-models-the-essentials/ + const FPS : f64 = 30.0; + + let tokens = (height as f64) * (width as f64) * FPS * duration; + let tokens = tokens / 1024.0; + + let cost = tokens * 1.8 / 1_000_000.0; + let cost = cost * 100.0; // Dollars to cents. + let cost = cost.ceil(); // NB: This is probably what Fal does. + + cost as UsdCents + } +} + + +/// Seedance 1.0 Lite Image-to-Video +/// https://fal.ai/models/fal-ai/bytedance/seedance/v1/lite/image-to-video +pub async fn enqueue_seedance_1_lite_image_to_video_webhook( + args: Seedance1LiteArgs<'_, V> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Seedance1LiteDuration::FiveSeconds => Some("5".to_string()), + Seedance1LiteDuration::TenSeconds => Some("10".to_string()), + }; + + let resolution = match req.resolution { + Seedance1LiteResolution::FourEightyP => Some("480p".to_string()), + Seedance1LiteResolution::SevenTwentyP => Some("720p".to_string()), + Seedance1LiteResolution::TenEightyP => Some("1080p".to_string()), + }; + + /// Possible enum values: 21:9, 16:9, 4:3, 1:1, 3:4, 9:16, auto + let aspect_ratio = req.aspect_ratio + .map(|r| match r { + Seedance1LiteAspectRatio::Auto => "auto", + Seedance1LiteAspectRatio::TwentyOneByNine => "21:9", + Seedance1LiteAspectRatio::SixteenByNine => "16:9", + Seedance1LiteAspectRatio::FourByThree => "4:3", + Seedance1LiteAspectRatio::Square => "1:1", + Seedance1LiteAspectRatio::ThreeByFour => "3:4", + Seedance1LiteAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let request = Seedance1LiteImageToVideoInput { + image_url: req.image_url, + end_image_url: req.end_frame_image_url, + prompt: req.prompt, + duration, + resolution, + aspect_ratio, + // TODO: Add these later + camera_fixed: None, + seed: -1, + // Static + enable_safety_checker: Some(false), + }; + + let result = seedance_1_lite_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_seedance_1_lite_image_to_video_webhook::{enqueue_seedance_1_lite_image_to_video_webhook, Seedance1LiteArgs, Seedance1LiteDuration, Seedance1LiteRequest, Seedance1LiteResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + + #[test] + fn test_cost() { + let mut req = Seedance1LiteRequest { + image_url: String::new(), + end_frame_image_url: Some(String::new()), + prompt: String::new(), + camera_fixed: false, + duration: Seedance1LiteDuration::FiveSeconds, + resolution: Seedance1LiteResolution::SevenTwentyP, + aspect_ratio: None, + seed: None, + }; + + // NB: Constant value specified by FAL + req.duration = Seedance1LiteDuration::FiveSeconds; + req.resolution = Seedance1LiteResolution::SevenTwentyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 18); + + // NB: Calculations follow... + req.duration = Seedance1LiteDuration::FiveSeconds; + req.resolution = Seedance1LiteResolution::TenEightyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 55); + + req.duration = Seedance1LiteDuration::FiveSeconds; + req.resolution = Seedance1LiteResolution::FourEightyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 9); + + req.duration = Seedance1LiteDuration::TenSeconds; + req.resolution = Seedance1LiteResolution::TenEightyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 110); + } + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Seedance1LiteArgs { + request: Seedance1LiteRequest { + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + end_frame_image_url: Some(JUNO_AT_LAKE_IMAGE_URL.to_string()), + prompt: "shiba in glasses runs to the lake and stands by the shore".to_string(), + camera_fixed: false, + duration: Seedance1LiteDuration::FiveSeconds, + resolution: Seedance1LiteResolution::SevenTwentyP, + aspect_ratio: None, + seed: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_seedance_1_lite_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..5c957112 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1_pro_image_to_video_webhook.rs @@ -0,0 +1,208 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_seedance_1_pro_image_to_video::{seedance_1_pro_image_to_video, Seedance1ProImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Seedance1ProArgs<'a, V: IntoUrl> { + pub request: Seedance1ProRequest, + pub webhook_url: V, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Seedance1ProRequest { + pub image_url: String, + pub prompt: String, + pub camera_fixed: bool, + pub duration: Seedance1ProDuration, + pub resolution: Seedance1ProResolution, + pub seed: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Seedance1ProDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum Seedance1ProResolution { + FourEightyP, // 480p + SevenTwentyP, // 720p + TenEightyP, // 1080p +} + + +impl FalRequestCostCalculator for Seedance1ProRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "Each 1080p 5 second video costs roughly $0.62. + // For other resolutions, 1 million video tokens costs $2.5. + // tokens(video) = (height x width x FPS x duration) / 1024." + + if self.resolution == Seedance1ProResolution::TenEightyP + && self.duration == Seedance1ProDuration::FiveSeconds + { + return 62; + } + + // TODO: Only correct for some aspect ratios for now. + let (width, height) = match self.resolution { + Seedance1ProResolution::FourEightyP => (640u32, 480u32), // NB: Only for 4:3 ! + Seedance1ProResolution::SevenTwentyP => (1280, 720), // NB: Only for 16:9 ! + Seedance1ProResolution::TenEightyP => (1920, 1080), + }; + + let duration = match self.duration { + Seedance1ProDuration::ThreeSeconds => 3.0, + Seedance1ProDuration::FourSeconds => 4.0, + Seedance1ProDuration::FiveSeconds => 5.0, + Seedance1ProDuration::SixSeconds => 6.0, + Seedance1ProDuration::SevenSeconds => 7.0, + Seedance1ProDuration::EightSeconds => 8.0, + Seedance1ProDuration::NineSeconds => 9.0, + Seedance1ProDuration::TenSeconds => 10.0, + Seedance1ProDuration::ElevenSeconds => 11.0, + Seedance1ProDuration::TwelveSeconds => 12.0, + }; + + // TODO: Not sure if FPS is right. + // Inferred from https://help.scenario.com/en/articles/seedance-models-the-essentials/ + const FPS : f64 = 30.0; + + let tokens = (height as f64) * (width as f64) * FPS * duration; + let tokens = tokens / 1024.0; + + let cost = tokens * 2.5 / 1_000_000.0; + let cost = cost * 100.0; // Dollars to cents. + let cost = cost.ceil(); // NB: This is probably what Fal does. + + cost as UsdCents + } +} + +/// Seedance 1.0 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/bytedance/seedance/v1/pro/image-to-video +pub async fn enqueue_seedance_1_pro_image_to_video_webhook( + args: Seedance1ProArgs<'_, V> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Seedance1ProDuration::ThreeSeconds => Some("3".to_string()), + Seedance1ProDuration::FourSeconds => Some("4".to_string()), + Seedance1ProDuration::FiveSeconds => Some("5".to_string()), + Seedance1ProDuration::SixSeconds => Some("6".to_string()), + Seedance1ProDuration::SevenSeconds => Some("7".to_string()), + Seedance1ProDuration::EightSeconds => Some("8".to_string()), + Seedance1ProDuration::NineSeconds => Some("9".to_string()), + Seedance1ProDuration::TenSeconds => Some("10".to_string()), + Seedance1ProDuration::ElevenSeconds => Some("11".to_string()), + Seedance1ProDuration::TwelveSeconds => Some("12".to_string()), + }; + + let resolution = match req.resolution { + Seedance1ProResolution::FourEightyP => Some("480p".to_string()), + Seedance1ProResolution::SevenTwentyP => Some("720p".to_string()), + Seedance1ProResolution::TenEightyP => Some("1080p".to_string()), + }; + + let request = Seedance1ProImageToVideoInput { + image_url: req.image_url, + prompt: req.prompt, + duration, + resolution, + // TODO: Add these later + camera_fixed: None, + // Static + enable_safety_checker: Some(false), + }; + + let result = seedance_1_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use crate::requests_old::webhook::video::image::enqueue_seedance_1_pro_image_to_video_webhook::{enqueue_seedance_1_pro_image_to_video_webhook, Seedance1ProArgs, Seedance1ProDuration, Seedance1ProRequest, Seedance1ProResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TALL_MOCHI_WITH_GLASSES_IMAGE_URL; + + #[test] + fn test_cost() { + let mut req = Seedance1ProRequest { + image_url: String::new(), + prompt: String::new(), + camera_fixed: false, + duration: Seedance1ProDuration::FiveSeconds, + resolution: Seedance1ProResolution::TenEightyP, + seed: None, + }; + + // NB: Constant value specified by FAL + req.duration = Seedance1ProDuration::FiveSeconds; + req.resolution = Seedance1ProResolution::TenEightyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 62); + + // NB: Calculations follow... + req.duration = Seedance1ProDuration::FiveSeconds; + req.resolution = Seedance1ProResolution::SevenTwentyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 34); + + req.duration = Seedance1ProDuration::TenSeconds; + req.resolution = Seedance1ProResolution::SevenTwentyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 68); + + req.duration = Seedance1ProDuration::TenSeconds; + req.resolution = Seedance1ProResolution::TenEightyP; + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 152); + } + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Seedance1ProArgs { + request: Seedance1ProRequest { + image_url: TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string(), + prompt: "shiba in glasses runs to the lake and stands by the shore".to_string(), + camera_fixed: false, + duration: Seedance1ProDuration::FiveSeconds, + resolution: Seedance1ProResolution::SevenTwentyP, + seed: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_seedance_1_pro_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1p5_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1p5_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..4fb05e17 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_seedance_1p5_pro_image_to_video_webhook.rs @@ -0,0 +1,358 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::image::http_seedance_1p5_pro_image_to_video::{seedance_1p5_pro_image_to_video, Seedance1p5ProImageToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueSeedance1p5ProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueSeedance1p5ProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueSeedance1p5ProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub end_image_url: Option, + pub resolution: Option, + pub duration: Option, + pub aspect_ratio: Option, + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueSeedance1p5ProImageToVideoDuration { + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueSeedance1p5ProImageToVideoResolution { + FourEightyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueSeedance1p5ProImageToVideoAspectRatio { + TwentyOneByNine, + SixteenByNine, + FourByThree, + Square, + ThreeByFour, + NineBySixteen, + Auto, +} + +impl FalRequestCostCalculator for EnqueueSeedance1p5ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "Each 720p 5 second video with audio costs roughly $0.26. + // For other resolutions, 1 million video tokens with audio costs $2.4. + // tokens(video) = (height x width x FPS x duration) / 1024." + + let resolution = self.resolution.unwrap_or(EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP); + let duration = self.duration.unwrap_or(EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds); + + let audio = self.generate_audio.unwrap_or(true); + let dollars_per_million_tokens = if audio { 2.4 } else { 1.2 }; + + if resolution == EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP + && duration == EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds + { + return if audio { 26 } else { 13 }; + } + + // TODO: Only correct for some aspect ratios for now. + let (width, height) = match resolution { + EnqueueSeedance1p5ProImageToVideoResolution::FourEightyP => (640u32, 480u32), // NB: Only for 4:3 ! + EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP => (1280, 720), // NB: Only for 16:9 ! + EnqueueSeedance1p5ProImageToVideoResolution::TenEightyP => (1920, 1080), + }; + + let duration_secs = match duration { + EnqueueSeedance1p5ProImageToVideoDuration::FourSeconds => 4.0, + EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds => 5.0, + EnqueueSeedance1p5ProImageToVideoDuration::SixSeconds => 6.0, + EnqueueSeedance1p5ProImageToVideoDuration::SevenSeconds => 7.0, + EnqueueSeedance1p5ProImageToVideoDuration::EightSeconds => 8.0, + EnqueueSeedance1p5ProImageToVideoDuration::NineSeconds => 9.0, + EnqueueSeedance1p5ProImageToVideoDuration::TenSeconds => 10.0, + EnqueueSeedance1p5ProImageToVideoDuration::ElevenSeconds => 11.0, + EnqueueSeedance1p5ProImageToVideoDuration::TwelveSeconds => 12.0, + }; + + const FPS: f64 = 30.0; + + let tokens = (height as f64) * (width as f64) * FPS * duration_secs; + let tokens = tokens / 1024.0; + + let cost = tokens * dollars_per_million_tokens / 1_000_000.0; + let cost = cost * 100.0; // Dollars to cents. + let cost = cost.ceil(); + + cost as UsdCents + } +} + +/// Seedance 1.5 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/bytedance/seedance/v1.5/pro/image-to-video +pub async fn enqueue_seedance_1p5_pro_image_to_video_webhook( + args: EnqueueSeedance1p5ProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| match d { + EnqueueSeedance1p5ProImageToVideoDuration::FourSeconds => "4", + EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds => "5", + EnqueueSeedance1p5ProImageToVideoDuration::SixSeconds => "6", + EnqueueSeedance1p5ProImageToVideoDuration::SevenSeconds => "7", + EnqueueSeedance1p5ProImageToVideoDuration::EightSeconds => "8", + EnqueueSeedance1p5ProImageToVideoDuration::NineSeconds => "9", + EnqueueSeedance1p5ProImageToVideoDuration::TenSeconds => "10", + EnqueueSeedance1p5ProImageToVideoDuration::ElevenSeconds => "11", + EnqueueSeedance1p5ProImageToVideoDuration::TwelveSeconds => "12", + }) + .map(|d| d.to_string()); + + let resolution = req.resolution + .map(|r| match r { + EnqueueSeedance1p5ProImageToVideoResolution::FourEightyP => "480p", + EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP => "720p", + EnqueueSeedance1p5ProImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueSeedance1p5ProImageToVideoAspectRatio::TwentyOneByNine => "21:9", + EnqueueSeedance1p5ProImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueSeedance1p5ProImageToVideoAspectRatio::FourByThree => "4:3", + EnqueueSeedance1p5ProImageToVideoAspectRatio::Square => "1:1", + EnqueueSeedance1p5ProImageToVideoAspectRatio::ThreeByFour => "3:4", + EnqueueSeedance1p5ProImageToVideoAspectRatio::NineBySixteen => "9:16", + EnqueueSeedance1p5ProImageToVideoAspectRatio::Auto => "auto", + }) + .map(|ar| ar.to_string()); + + let request = Seedance1p5ProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + end_image_url: req.end_image_url, + duration, + resolution, + aspect_ratio, + camera_fixed: None, + seed: None, + enable_safety_checker: Some(false), + generate_audio: Some(req.generate_audio.unwrap_or(true)), + }; + + let result = seedance_1p5_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[test] + fn test_cost() { + let mut req = EnqueueSeedance1p5ProImageToVideoRequest { + prompt: String::new(), + image_url: String::new(), + end_image_url: None, + duration: Some(EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds), + resolution: Some(EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP), + aspect_ratio: None, + generate_audio: None, + }; + + // NB: Constant value specified by Fal + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 26); + + // Calculated values + req.duration = Some(EnqueueSeedance1p5ProImageToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 65); + + req.duration = Some(EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds); + req.resolution = Some(EnqueueSeedance1p5ProImageToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 73); + + req.duration = Some(EnqueueSeedance1p5ProImageToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProImageToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 146); + } + + #[test] + fn test_cost_audio_off() { + let mut req = EnqueueSeedance1p5ProImageToVideoRequest { + prompt: String::new(), + image_url: String::new(), + end_image_url: None, + duration: Some(EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds), + resolution: Some(EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP), + aspect_ratio: None, + generate_audio: Some(false), + }; + + // 720p 5s without audio = half of 26 + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 13); + + // Calculated values — half of audio-on costs (ceil) + req.duration = Some(EnqueueSeedance1p5ProImageToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 33); + + req.duration = Some(EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds); + req.resolution = Some(EnqueueSeedance1p5ProImageToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 37); + + req.duration = Some(EnqueueSeedance1p5ProImageToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProImageToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 73); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueSeedance1p5ProImageToVideoArgs { + request: EnqueueSeedance1p5ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera".to_string(), + duration: Some(EnqueueSeedance1p5ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueSeedance1p5ProImageToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueSeedance1p5ProImageToVideoResolution::SevenTwentyP), + end_image_url: None, + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_seedance_1p5_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueSeedance1p5ProImageToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueSeedance1p5ProImageToVideoArgs { + request: EnqueueSeedance1p5ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton comes alive and roars at the camera".to_string(), + duration: Some(EnqueueSeedance1p5ProImageToVideoDuration::FourSeconds), + aspect_ratio: Some(ar), + resolution: None, + end_image_url: None, + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_seedance_1p5_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueSeedance1p5ProImageToVideoDuration::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueSeedance1p5ProImageToVideoArgs { + request: EnqueueSeedance1p5ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly turns its head".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueSeedance1p5ProImageToVideoAspectRatio::SixteenByNine), + resolution: None, + end_image_url: None, + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_seedance_1p5_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_resolutions() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for res in EnqueueSeedance1p5ProImageToVideoResolution::iter() { + println!("--- resolution: {:?} ---", res); + let args = EnqueueSeedance1p5ProImageToVideoArgs { + request: EnqueueSeedance1p5ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly comes alive".to_string(), + duration: Some(EnqueueSeedance1p5ProImageToVideoDuration::FourSeconds), + aspect_ratio: Some(EnqueueSeedance1p5ProImageToVideoAspectRatio::SixteenByNine), + resolution: Some(res), + end_image_url: None, + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_seedance_1p5_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_sora_2_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_sora_2_image_to_video_webhook.rs new file mode 100644 index 00000000..f15cb2d7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_sora_2_image_to_video_webhook.rs @@ -0,0 +1,216 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::image::http_sora_2_image_to_video::{sora_2_image_to_video, Sora2ImageToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueSora2ImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueSora2ImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueSora2ImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub duration: Option, + pub resolution: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ImageToVideoDurationSeconds { + Four, + Eight, + Twelve, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ImageToVideoResolution { + Auto, + SevenTwentyP, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ImageToVideoAspectRatio { + Auto, + NineBySixteen, + SixteenByNine, +} + +impl FalRequestCostCalculator for EnqueueSora2ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "The pricing is $0.1/s for Sora 2." + let duration = self.duration.unwrap_or(EnqueueSora2ImageToVideoDurationSeconds::Four); + match duration { + EnqueueSora2ImageToVideoDurationSeconds::Four => 40, // $0.10 * 4 + EnqueueSora2ImageToVideoDurationSeconds::Eight => 80, // $0.10 * 8 + EnqueueSora2ImageToVideoDurationSeconds::Twelve => 120 // $0.10 * 12 + } + } +} + +/// Sora 2 Image-to-Video +/// https://fal.ai/models/fal-ai/sora-2/image-to-video +pub async fn enqueue_sora_2_image_to_video_webhook( + args: EnqueueSora2ImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| match d { + EnqueueSora2ImageToVideoDurationSeconds::Four => 4, + EnqueueSora2ImageToVideoDurationSeconds::Eight => 8, + EnqueueSora2ImageToVideoDurationSeconds::Twelve => 12, + }); + + let resolution = req.resolution + .map(|r| match r { + EnqueueSora2ImageToVideoResolution::Auto => "auto", + EnqueueSora2ImageToVideoResolution::SevenTwentyP => "720p", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueSora2ImageToVideoAspectRatio::Auto => "auto", + EnqueueSora2ImageToVideoAspectRatio::NineBySixteen => "9:16", + EnqueueSora2ImageToVideoAspectRatio::SixteenByNine => "16:9", + }) + .map(|ar| ar.to_string()); + + let request = Sora2ImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + duration, + resolution, + aspect_ratio, + delete_video: Some(false), + }; + + let result = sora_2_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueSora2ImageToVideoArgs { + request: EnqueueSora2ImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + duration: Some(EnqueueSora2ImageToVideoDurationSeconds::Twelve), + aspect_ratio: Some(EnqueueSora2ImageToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueSora2ImageToVideoResolution::SevenTwentyP), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_sora_2_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueSora2ImageToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueSora2ImageToVideoArgs { + request: EnqueueSora2ImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton comes alive and roars at the camera".to_string(), + duration: Some(EnqueueSora2ImageToVideoDurationSeconds::Four), + aspect_ratio: Some(ar), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueSora2ImageToVideoDurationSeconds::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueSora2ImageToVideoArgs { + request: EnqueueSora2ImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly turns its head".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueSora2ImageToVideoAspectRatio::SixteenByNine), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_resolutions() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for res in EnqueueSora2ImageToVideoResolution::iter() { + println!("--- resolution: {:?} ---", res); + let args = EnqueueSora2ImageToVideoArgs { + request: EnqueueSora2ImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly comes alive".to_string(), + duration: Some(EnqueueSora2ImageToVideoDurationSeconds::Four), + aspect_ratio: Some(EnqueueSora2ImageToVideoAspectRatio::SixteenByNine), + resolution: Some(res), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_sora_2_pro_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_sora_2_pro_image_to_video_webhook.rs new file mode 100644 index 00000000..26730974 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_sora_2_pro_image_to_video_webhook.rs @@ -0,0 +1,226 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::image::http_sora_2_pro_image_to_video::{sora_2_pro_image_to_video, Sora2ProImageToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueSora2ProImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueSora2ProImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueSora2ProImageToVideoRequest { + // Request required + pub prompt: String, + pub image_url: String, + + // Optional args + pub resolution: Option, + pub duration: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ProImageToVideoDurationSeconds { + Four, + Eight, + Twelve, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ProImageToVideoResolution { + Auto, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ProImageToVideoAspectRatio { + Auto, + NineBySixteen, + SixteenByNine, +} + +impl FalRequestCostCalculator for EnqueueSora2ProImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.30/s for 720p and $0.50/s for 1080p. + let duration = self.duration.unwrap_or(EnqueueSora2ProImageToVideoDurationSeconds::Four); + let resolution = self.resolution.unwrap_or(EnqueueSora2ProImageToVideoResolution::Auto); + + match (duration, resolution) { + (EnqueueSora2ProImageToVideoDurationSeconds::Four, EnqueueSora2ProImageToVideoResolution::Auto) => 120, + (EnqueueSora2ProImageToVideoDurationSeconds::Four, EnqueueSora2ProImageToVideoResolution::SevenTwentyP) => 120, + (EnqueueSora2ProImageToVideoDurationSeconds::Four, EnqueueSora2ProImageToVideoResolution::TenEightyP) => 200, + (EnqueueSora2ProImageToVideoDurationSeconds::Eight, EnqueueSora2ProImageToVideoResolution::Auto) => 240, + (EnqueueSora2ProImageToVideoDurationSeconds::Eight, EnqueueSora2ProImageToVideoResolution::SevenTwentyP) => 240, + (EnqueueSora2ProImageToVideoDurationSeconds::Eight, EnqueueSora2ProImageToVideoResolution::TenEightyP) => 400, + (EnqueueSora2ProImageToVideoDurationSeconds::Twelve, EnqueueSora2ProImageToVideoResolution::Auto) => 360, + (EnqueueSora2ProImageToVideoDurationSeconds::Twelve, EnqueueSora2ProImageToVideoResolution::SevenTwentyP) => 360, + (EnqueueSora2ProImageToVideoDurationSeconds::Twelve, EnqueueSora2ProImageToVideoResolution::TenEightyP) => 600, + } + } +} + +/// Sora 2 Pro Image-to-Video +/// https://fal.ai/models/fal-ai/sora-2/image-to-video/pro +pub async fn enqueue_sora_2_pro_image_to_video_webhook( + args: EnqueueSora2ProImageToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| match d { + EnqueueSora2ProImageToVideoDurationSeconds::Four => 4, + EnqueueSora2ProImageToVideoDurationSeconds::Eight => 8, + EnqueueSora2ProImageToVideoDurationSeconds::Twelve => 12, + }); + + let resolution = req.resolution + .map(|r| match r { + EnqueueSora2ProImageToVideoResolution::Auto => "auto", + EnqueueSora2ProImageToVideoResolution::SevenTwentyP => "720p", + EnqueueSora2ProImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueSora2ProImageToVideoAspectRatio::Auto => "auto", + EnqueueSora2ProImageToVideoAspectRatio::NineBySixteen => "9:16", + EnqueueSora2ProImageToVideoAspectRatio::SixteenByNine => "16:9", + }) + .map(|ar| ar.to_string()); + + let request = Sora2ProImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + duration, + resolution, + aspect_ratio, + delete_video: Some(false), + }; + + let result = sora_2_pro_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueSora2ProImageToVideoArgs { + request: EnqueueSora2ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton gets off the podium and begins walking to the camera. the camera orbits slightly. The t-rex gets close and then bites.".to_string(), + duration: Some(EnqueueSora2ProImageToVideoDurationSeconds::Twelve), + aspect_ratio: Some(EnqueueSora2ProImageToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueSora2ProImageToVideoResolution::TenEightyP), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_sora_2_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueSora2ProImageToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueSora2ProImageToVideoArgs { + request: EnqueueSora2ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton comes alive and roars at the camera".to_string(), + duration: Some(EnqueueSora2ProImageToVideoDurationSeconds::Four), + aspect_ratio: Some(ar), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueSora2ProImageToVideoDurationSeconds::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueSora2ProImageToVideoArgs { + request: EnqueueSora2ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly turns its head".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueSora2ProImageToVideoAspectRatio::SixteenByNine), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_resolutions() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for res in EnqueueSora2ProImageToVideoResolution::iter() { + println!("--- resolution: {:?} ---", res); + let args = EnqueueSora2ProImageToVideoArgs { + request: EnqueueSora2ProImageToVideoRequest { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the skeleton slowly comes alive".to_string(), + duration: Some(EnqueueSora2ProImageToVideoDurationSeconds::Four), + aspect_ratio: Some(EnqueueSora2ProImageToVideoAspectRatio::SixteenByNine), + resolution: Some(res), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_pro_image_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_2_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_2_image_to_video_webhook.rs new file mode 100644 index 00000000..40f3762e --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_2_image_to_video_webhook.rs @@ -0,0 +1,119 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::core_api::webhook_response::WebhookResponse; +use crate::requests_old::http::video::image::http_veo_2_image_to_video::{veo_2_image_to_video, Veo2ImageToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use reqwest::IntoUrl; + +pub struct Veo2Args<'a, R: IntoUrl> { + pub request: Veo2Request, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +/// Args for Veo 2 image-to-video. Note: image-to-video does NOT support +/// aspect_ratio — the output inherits the source image's aspect ratio. +#[derive(Clone, Debug)] +pub struct Veo2Request { + pub image_url: String, + pub prompt: String, + pub duration: Veo2Duration, +} + +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum Veo2Duration { + Default, // NB: Default is 5 seconds + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, +} + +/// Aspect ratio enum — used by the text-to-video endpoint only. +/// Kept here because it's the canonical location that the text-to-video +/// webhook and the router plan both re-export from. +#[derive(Copy, Clone, Debug)] +pub enum Veo2AspectRatio { + Auto, + AutoPreferPortrait, + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +impl FalRequestCostCalculator for Veo2Request { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost $2.50. + // For every aditional second you will be charged $0.50." + match self.duration { + Veo2Duration::Default => 250, + Veo2Duration::FiveSeconds => 250, + Veo2Duration::SixSeconds => 300, + Veo2Duration::SevenSeconds => 350, + Veo2Duration::EightSeconds => 400, + } + } +} + + +/// Veo 2 Image-to-Video +/// https://fal.ai/models/fal-ai/veo2/image-to-video +pub async fn enqueue_veo_2_image_to_video_webhook( + args: Veo2Args<'_, R> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Veo2Duration::Default => None, // NB: Default is 5 seconds. + Veo2Duration::FiveSeconds => Some("5s".to_string()), + Veo2Duration::SixSeconds => Some("6s".to_string()), + Veo2Duration::SevenSeconds => Some("7s".to_string()), + Veo2Duration::EightSeconds => Some("8s".to_string()), + }; + + let request = Veo2ImageToVideoInput { + image_url: req.image_url, + prompt: req.prompt, + duration, + }; + + let result = veo_2_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_2_image_to_video_webhook::{enqueue_veo_2_image_to_video_webhook, Veo2Args, Veo2Duration, Veo2Request}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::MOUNTAIN_TREE_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test_veo_2_image_to_video() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Veo2Args { + request: Veo2Request { + image_url: MOUNTAIN_TREE_IMAGE_URL.to_string(), + prompt: "a shot of the mountains as the sun sets and reveals the moon and stars".to_string(), + duration: Veo2Duration::Default, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_2_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3_fast_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3_fast_image_to_video_webhook.rs new file mode 100644 index 00000000..c5365f23 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3_fast_image_to_video_webhook.rs @@ -0,0 +1,145 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_veo_3_fast_image_to_video::{veo_3_fast_image_to_video, Veo3FastImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Veo3FastArgs<'a, R: IntoUrl> { + pub request: Veo3FastRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Veo3FastRequest { + pub prompt: String, + pub image_url: String, + pub aspect_ratio: Veo3FastAspectRatio, + pub duration: Veo3FastDuration, + pub resolution: Veo3FastResolution, + pub generate_audio: bool, +} + +#[derive(Copy, Clone, Debug)] +pub enum Veo3FastDuration { + Default, // NB: Defaults to 8 seconds. + FourSeconds, + SixSeconds, + EightSeconds, +} + +#[derive(Copy, Clone, Debug)] +pub enum Veo3FastAspectRatio { + Auto, + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +#[derive(Copy, Clone, Debug)] +pub enum Veo3FastResolution { + Default, + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for Veo3FastRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.10 (audio off) or $0.15 (audio on). + // For example, a 5s video with audio on will cost $0.75." + match (self.duration, self.generate_audio) { + (Veo3FastDuration::FourSeconds, false) => 40, + (Veo3FastDuration::SixSeconds, false) => 60, + (Veo3FastDuration::EightSeconds, false) => 80, + (Veo3FastDuration::Default, false) => 80, // NB: Default is 8 seconds + (Veo3FastDuration::FourSeconds, true) => 60, + (Veo3FastDuration::SixSeconds, true) => 90, + (Veo3FastDuration::EightSeconds, true) => 120, + (Veo3FastDuration::Default, true) => 120, // NB: Default is 8 seconds + } + } +} + + +/// Veo 3 Fast Image-to-Video +/// https://fal.ai/models/fal-ai/veo3/fast/image-to-video +pub async fn enqueue_veo_3_fast_image_to_video_webhook( + args: Veo3FastArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Veo3FastDuration::Default => None, // NB: Defaults to 8. + Veo3FastDuration::FourSeconds => Some("4s".to_string()), + Veo3FastDuration::SixSeconds => Some("6s".to_string()), + Veo3FastDuration::EightSeconds => Some("8s".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Veo3FastAspectRatio::Auto => Some("auto".to_string()), + Veo3FastAspectRatio::WideSixteenNine => Some("16:9".to_string()), + Veo3FastAspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let resolution = match req.resolution { + Veo3FastResolution::Default => None, + Veo3FastResolution::SevenTwentyP => Some("720p".to_string()), + Veo3FastResolution::TenEightyP => Some("1080p".to_string()), + }; + + let request = Veo3FastImageToVideoInput { + image_url: req.image_url, + prompt: req.prompt, + aspect_ratio, + resolution, + duration, + generate_audio: Some(req.generate_audio), + }; + + let result = veo_3_fast_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_3_fast_image_to_video_webhook::{enqueue_veo_3_fast_image_to_video_webhook, Veo3FastArgs, Veo3FastAspectRatio, Veo3FastDuration, Veo3FastRequest, Veo3FastResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::ERNEST_GHOST_TREX_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + let image_url = ERNEST_GHOST_TREX_IMAGE_URL; + + // XXX: Don't commit secrets! + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = Veo3FastArgs { + request: Veo3FastRequest { + image_url: image_url.to_string(), + prompt: "man is standing next to a ghost and t-rex, they begin to chase him as the camera pulls back to show the wider scene".to_string(), + aspect_ratio: Veo3FastAspectRatio::WideSixteenNine, + duration: Veo3FastDuration::EightSeconds, + generate_audio: true, + resolution: Veo3FastResolution::TenEightyP, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3_fast_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3_image_to_video_webhook.rs new file mode 100644 index 00000000..6f6a591d --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3_image_to_video_webhook.rs @@ -0,0 +1,149 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_veo_3_image_to_video::{veo_3_image_to_video, Veo3ImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct Veo3Args<'a, R: IntoUrl> { + pub request: Veo3Request, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Veo3Request { + pub image_url: String, + pub prompt: String, + pub duration: Veo3I2vDuration, + pub aspect_ratio: Veo3I2vAspectRatio, + pub resolution: Veo3I2vResolution, + pub generate_audio: bool, +} + +/// Duration for Veo 3 image-to-video. Default is 8 seconds. +#[derive(Copy, Clone, Debug)] +pub enum Veo3I2vDuration { + Default, // Default is 8 seconds + FourSeconds, + SixSeconds, + EightSeconds, +} + +/// Aspect ratio for Veo 3 image-to-video. +/// Supports Auto (inherit source), 16:9, and 9:16. No Square. +#[derive(Copy, Clone, Debug)] +pub enum Veo3I2vAspectRatio { + Auto, + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +/// Resolution for Veo 3 image-to-video. +#[derive(Copy, Clone, Debug)] +pub enum Veo3I2vResolution { + Default, + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for Veo3Request { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.20 (audio off) or + // $0.40 (audio on). + // For example, a 5s video with audio on will cost $2." + + match (self.duration, self.generate_audio) { + (Veo3I2vDuration::FourSeconds, false) => 80, + (Veo3I2vDuration::SixSeconds, false) => 120, + (Veo3I2vDuration::EightSeconds, false) => 160, + (Veo3I2vDuration::Default, false) => 160, + (Veo3I2vDuration::FourSeconds, true) => 160, + (Veo3I2vDuration::SixSeconds, true) => 240, + (Veo3I2vDuration::EightSeconds, true) => 320, + (Veo3I2vDuration::Default, true) => 320, + } + } +} + + +/// Veo 3 Image-to-Video +/// https://fal.ai/models/fal-ai/veo3/image-to-video +pub async fn enqueue_veo_3_image_to_video_webhook( + args: Veo3Args<'_, R> +) -> Result { + let req = args.request; + + let duration = match req.duration { + Veo3I2vDuration::Default => None, + Veo3I2vDuration::FourSeconds => Some("4s".to_string()), + Veo3I2vDuration::SixSeconds => Some("6s".to_string()), + Veo3I2vDuration::EightSeconds => Some("8s".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Veo3I2vAspectRatio::Auto => Some("auto".to_string()), + Veo3I2vAspectRatio::WideSixteenNine => Some("16:9".to_string()), + Veo3I2vAspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let resolution = match req.resolution { + Veo3I2vResolution::Default => None, + Veo3I2vResolution::SevenTwentyP => Some("720p".to_string()), + Veo3I2vResolution::TenEightyP => Some("1080p".to_string()), + }; + + let request = Veo3ImageToVideoInput { + image_url: req.image_url, + prompt: req.prompt, + aspect_ratio, + resolution, + duration, + generate_audio: Some(req.generate_audio), + }; + + let result = veo_3_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_3_image_to_video_webhook::{ + enqueue_veo_3_image_to_video_webhook, Veo3Args, Veo3I2vAspectRatio, Veo3I2vDuration, + Veo3I2vResolution, Veo3Request, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TREX_SKELETON_IMAGE_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Veo3Args { + request: Veo3Request { + image_url: TREX_SKELETON_IMAGE_URL.to_string(), + prompt: "the t-rex skeleton starts walking towards the camera and roars".to_string(), + duration: Veo3I2vDuration::EightSeconds, + aspect_ratio: Veo3I2vAspectRatio::WideSixteenNine, + resolution: Veo3I2vResolution::TenEightyP, + generate_audio: true, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_veo_3_image_to_video_webhook(args).await?; + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook.rs new file mode 100644 index 00000000..9424eb1b --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook.rs @@ -0,0 +1,165 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_veo_3p1_fast_first_last_frame_image_to_video::{veo_3p1_fast_first_last_frame_image_to_video, Veo3p1FastFirstLastFrameImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueVeo3p1FastFirstLastFrameImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueVeo3p1FastFirstLastFrameImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueVeo3p1FastFirstLastFrameImageToVideoRequest { + // Request required + pub prompt: String, + + // Starting frame + pub first_frame_url: String, + + // Ending frame + pub last_frame_url: String, + + // Optional args follow + + // NB: Defaults to 8 seconds + pub duration: Option, + + pub aspect_ratio: Option, + + pub resolution: Option, + + // NB: Defaults to true. Costs more to generate audio. + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds { + Four, + Six, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastFirstLastFrameImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastFirstLastFrameImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for EnqueueVeo3p1FastFirstLastFrameImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.10 (audio off) or + // $0.15 (audio on). + // For example, a 5s video with audio on will cost $0.75." + let duration = self.duration + .unwrap_or(EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Eight); + + let generate_audio = self.generate_audio.unwrap_or(true); + + match (duration, generate_audio) { + (EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Four, false) => 40, + (EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Six, false) => 60, + (EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Eight, false) => 80, + (EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Four, true) => 60, + (EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Six, true) => 90, + (EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Eight, true) => 120, + } + } +} + + +/// Veo 3.1 Fast First Frame / Last Frame Image-to-Video +/// https://fal.ai/models/fal-ai/veo3.1/fast/first-last-frame-to-video +pub async fn enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook( + args: EnqueueVeo3p1FastFirstLastFrameImageToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Four => "4s", + EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Six => "6s", + EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Eight=> "8s", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueueVeo3p1FastFirstLastFrameImageToVideoAspectRatio::Auto => "auto", + EnqueueVeo3p1FastFirstLastFrameImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueVeo3p1FastFirstLastFrameImageToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueVeo3p1FastFirstLastFrameImageToVideoResolution::SevenTwentyP => "720p", + EnqueueVeo3p1FastFirstLastFrameImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let request = Veo3p1FastFirstLastFrameImageToVideoInput { + prompt: req.prompt, + first_frame_url: req.first_frame_url, + last_frame_url: req.last_frame_url, + generate_audio: req.generate_audio, + // Optionals + duration, + aspect_ratio, + resolution, + }; + + let result = veo_3p1_fast_first_last_frame_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook::{enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook, EnqueueVeo3p1FastFirstLastFrameImageToVideoArgs, EnqueueVeo3p1FastFirstLastFrameImageToVideoAspectRatio, EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds, EnqueueVeo3p1FastFirstLastFrameImageToVideoRequest, EnqueueVeo3p1FastFirstLastFrameImageToVideoResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{TALL_CORGI_SHIBA_TREASURE_OCEAN_URL, TALL_CORGI_SHIBA_TREASURE_SKY_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueVeo3p1FastFirstLastFrameImageToVideoArgs { + request: EnqueueVeo3p1FastFirstLastFrameImageToVideoRequest { + first_frame_url: TALL_CORGI_SHIBA_TREASURE_OCEAN_URL.to_string(), + last_frame_url: TALL_CORGI_SHIBA_TREASURE_SKY_URL.to_string(), + prompt: "There is a tiny ocean island with a corgi and shiba and treasure chest on it. The corgi and shiba are barking at the chest, when suddenly the island launches itself into the air. The camera tracks the island and follows it up high in the sky. The sun beams over the horizon. The dogs are happy and bark. The gold coins gleam in the sun.".to_string(), + duration: Some(EnqueueVeo3p1FastFirstLastFrameImageToVideoDurationSeconds::Six), + aspect_ratio: Some(EnqueueVeo3p1FastFirstLastFrameImageToVideoAspectRatio::NineBySixteen), + resolution: Some(EnqueueVeo3p1FastFirstLastFrameImageToVideoResolution::SevenTwentyP), + generate_audio: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_fast_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_fast_image_to_video_webhook.rs new file mode 100644 index 00000000..955316f2 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_fast_image_to_video_webhook.rs @@ -0,0 +1,155 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_veo_3p1_fast_image_to_video::{veo_3p1_fast_image_to_video, Veo3p1FastImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueVeo3p1FastImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueVeo3p1FastImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueVeo3p1FastImageToVideoRequest { + // Request required + pub prompt: String, + + // Starting frame + pub image_url: String, + + // Optional args + pub duration: Option, + pub aspect_ratio: Option, + pub resolution: Option, + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastImageToVideoDurationSeconds { + Four, + Six, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + + +impl FalRequestCostCalculator for EnqueueVeo3p1FastImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.10 (audio off) or + // $0.15 (audio on). + // For example, a 5s video with audio on will cost $0.75." + let duration = self.duration + .unwrap_or(EnqueueVeo3p1FastImageToVideoDurationSeconds::Eight); + + let generate_audio = self.generate_audio.unwrap_or(true); + + match (duration, generate_audio) { + (EnqueueVeo3p1FastImageToVideoDurationSeconds::Four, false) => 40, + (EnqueueVeo3p1FastImageToVideoDurationSeconds::Six, false) => 60, + (EnqueueVeo3p1FastImageToVideoDurationSeconds::Eight, false) => 80, + (EnqueueVeo3p1FastImageToVideoDurationSeconds::Four, true) => 60, + (EnqueueVeo3p1FastImageToVideoDurationSeconds::Six, true) => 90, + (EnqueueVeo3p1FastImageToVideoDurationSeconds::Eight, true) => 120, + } + } +} + + +/// Veo 3.1 Fast Image-to-Video +/// https://fal.ai/models/fal-ai/veo3.1/fast/image-to-video +pub async fn enqueue_veo_3p1_fast_image_to_video_webhook( + args: EnqueueVeo3p1FastImageToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueVeo3p1FastImageToVideoDurationSeconds::Four => "4s", + EnqueueVeo3p1FastImageToVideoDurationSeconds::Six => "6s", + EnqueueVeo3p1FastImageToVideoDurationSeconds::Eight=> "8s", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueueVeo3p1FastImageToVideoAspectRatio::Auto => "auto", + EnqueueVeo3p1FastImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueVeo3p1FastImageToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueVeo3p1FastImageToVideoResolution::SevenTwentyP => "720p", + EnqueueVeo3p1FastImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let request = Veo3p1FastImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + generate_audio: req.generate_audio, + // Optionals + duration, + aspect_ratio, + resolution, + }; + + let result = veo_3p1_fast_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_3p1_fast_image_to_video_webhook::{enqueue_veo_3p1_fast_image_to_video_webhook, EnqueueVeo3p1FastImageToVideoArgs, EnqueueVeo3p1FastImageToVideoAspectRatio, EnqueueVeo3p1FastImageToVideoDurationSeconds, EnqueueVeo3p1FastImageToVideoRequest, EnqueueVeo3p1FastImageToVideoResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TALL_CORGI_SHIBA_TREASURE_OCEAN_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueVeo3p1FastImageToVideoArgs { + request: EnqueueVeo3p1FastImageToVideoRequest { + image_url: TALL_CORGI_SHIBA_TREASURE_OCEAN_URL.to_string(), + prompt: "There is a tiny ocean island with a corgi and shiba and treasure chest on it. The corgi and shiba are barking at the chest, when suddenly the island launches itself into the air. The camera tracks the island and follows it up high in the sky. The sun beams over the horizon. The dogs are happy and bark. The gold coins gleam in the sun.".to_string(), + duration: Some(EnqueueVeo3p1FastImageToVideoDurationSeconds::Four), + aspect_ratio: Some(EnqueueVeo3p1FastImageToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueVeo3p1FastImageToVideoResolution::TenEightyP), + generate_audio: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3p1_fast_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_first_last_frame_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_first_last_frame_image_to_video_webhook.rs new file mode 100644 index 00000000..40467ad7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_first_last_frame_image_to_video_webhook.rs @@ -0,0 +1,159 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_veo_3p1_first_last_frame_image_to_video::{veo_3p1_first_last_frame_image_to_video, Veo3p1FirstLastFrameImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueVeo3p1FirstLastFrameImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueVeo3p1FirstLastFrameImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueVeo3p1FirstLastFrameImageToVideoRequest { + // Request required + pub prompt: String, + + // Starting frame + pub first_frame_url: String, + + // Ending frame + pub last_frame_url: String, + + // Optional args + pub duration: Option, + pub aspect_ratio: Option, + pub resolution: Option, + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds { + Four, + Six, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FirstLastFrameImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FirstLastFrameImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for EnqueueVeo3p1FirstLastFrameImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.20 (audio off) or + // $0.40 (audio on). + // For example, a 5s video with audio on will cost $2." + let duration = self.duration + .unwrap_or(EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Eight); + + let generate_audio = self.generate_audio.unwrap_or(true); + + match (duration, generate_audio) { + (EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Four, false) => 80, + (EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Six, false) => 120, + (EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Eight, false) => 160, + (EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Four, true) => 160, + (EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Six, true) => 240, + (EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Eight, true) => 320, + } + } +} + + +/// Veo 3.1 First Frame / Last Frame Image-to-Video +/// https://fal.ai/models/fal-ai/veo3.1/first-last-frame-to-video +pub async fn enqueue_veo_3p1_first_last_frame_image_to_video_webhook( + args: EnqueueVeo3p1FirstLastFrameImageToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Four => "4s", + EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Six => "6s", + EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Eight=> "8s", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueueVeo3p1FirstLastFrameImageToVideoAspectRatio::Auto => "auto", + EnqueueVeo3p1FirstLastFrameImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueVeo3p1FirstLastFrameImageToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueVeo3p1FirstLastFrameImageToVideoResolution::SevenTwentyP => "720p", + EnqueueVeo3p1FirstLastFrameImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let request = Veo3p1FirstLastFrameImageToVideoInput { + prompt: req.prompt, + first_frame_url: req.first_frame_url, + last_frame_url: req.last_frame_url, + generate_audio: req.generate_audio, + // Optionals + duration, + aspect_ratio, + resolution, + }; + + let result = veo_3p1_first_last_frame_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_3p1_first_last_frame_image_to_video_webhook::{enqueue_veo_3p1_first_last_frame_image_to_video_webhook, EnqueueVeo3p1FirstLastFrameImageToVideoArgs, EnqueueVeo3p1FirstLastFrameImageToVideoAspectRatio, EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds, EnqueueVeo3p1FirstLastFrameImageToVideoRequest, EnqueueVeo3p1FirstLastFrameImageToVideoResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::{TALL_CORGI_SHIBA_TREASURE_OCEAN_URL, TALL_CORGI_SHIBA_TREASURE_SKY_URL}; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueVeo3p1FirstLastFrameImageToVideoArgs { + request: EnqueueVeo3p1FirstLastFrameImageToVideoRequest { + first_frame_url: TALL_CORGI_SHIBA_TREASURE_OCEAN_URL.to_string(), + last_frame_url: TALL_CORGI_SHIBA_TREASURE_SKY_URL.to_string(), + prompt: "There is a tiny ocean island with a corgi and shiba and treasure chest on it. The corgi and shiba are barking at the chest, when suddenly the island launches itself into the air. The camera tracks the island and follows it up high in the sky. The sun beams over the horizon. The dogs are happy and bark. The gold coins gleam in the sun.".to_string(), + duration: Some(EnqueueVeo3p1FirstLastFrameImageToVideoDurationSeconds::Eight), + aspect_ratio: Some(EnqueueVeo3p1FirstLastFrameImageToVideoAspectRatio::NineBySixteen), + resolution: Some(EnqueueVeo3p1FirstLastFrameImageToVideoResolution::TenEightyP), + generate_audio: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3p1_first_last_frame_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_image_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_image_to_video_webhook.rs new file mode 100644 index 00000000..74363963 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/enqueue_veo_3p1_image_to_video_webhook.rs @@ -0,0 +1,154 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::image::http_veo_3p1_image_to_video::{veo_3p1_image_to_video, Veo3p1ImageToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueVeo3p1ImageToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueVeo3p1ImageToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueVeo3p1ImageToVideoRequest { + // Request required + pub prompt: String, + + // Starting frame + pub image_url: String, + + // Optional args + pub duration: Option, + pub aspect_ratio: Option, + pub resolution: Option, + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1ImageToVideoDurationSeconds { + Four, + Six, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1ImageToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1ImageToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for EnqueueVeo3p1ImageToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.20 (audio off) or + // $0.40 (audio on). + // For example, a 5s video with audio on will cost $2." + let duration = self.duration + .unwrap_or(EnqueueVeo3p1ImageToVideoDurationSeconds::Eight); + + let generate_audio = self.generate_audio.unwrap_or(true); + + match (duration, generate_audio) { + (EnqueueVeo3p1ImageToVideoDurationSeconds::Four, false) => 80, + (EnqueueVeo3p1ImageToVideoDurationSeconds::Six, false) => 120, + (EnqueueVeo3p1ImageToVideoDurationSeconds::Eight, false) => 160, + (EnqueueVeo3p1ImageToVideoDurationSeconds::Four, true) => 160, + (EnqueueVeo3p1ImageToVideoDurationSeconds::Six, true) => 240, + (EnqueueVeo3p1ImageToVideoDurationSeconds::Eight, true) => 320, + } + } +} + + +/// Veo 3.1 Image-to-Video +/// https://fal.ai/models/fal-ai/veo3.1/image-to-video +pub async fn enqueue_veo_3p1_image_to_video_webhook( + args: EnqueueVeo3p1ImageToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueVeo3p1ImageToVideoDurationSeconds::Four => "4s", + EnqueueVeo3p1ImageToVideoDurationSeconds::Six => "6s", + EnqueueVeo3p1ImageToVideoDurationSeconds::Eight=> "8s", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueueVeo3p1ImageToVideoAspectRatio::Auto => "auto", + EnqueueVeo3p1ImageToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueVeo3p1ImageToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueVeo3p1ImageToVideoResolution::SevenTwentyP => "720p", + EnqueueVeo3p1ImageToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let request = Veo3p1ImageToVideoInput { + prompt: req.prompt, + image_url: req.image_url, + generate_audio: req.generate_audio, + // Optionals + duration, + aspect_ratio, + resolution, + }; + + let result = veo_3p1_image_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::image::enqueue_veo_3p1_image_to_video_webhook::{enqueue_veo_3p1_image_to_video_webhook, EnqueueVeo3p1ImageToVideoArgs, EnqueueVeo3p1ImageToVideoAspectRatio, EnqueueVeo3p1ImageToVideoDurationSeconds, EnqueueVeo3p1ImageToVideoRequest, EnqueueVeo3p1ImageToVideoResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + use test_data::web::image_urls::TALL_CORGI_SHIBA_TREASURE_OCEAN_URL; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueVeo3p1ImageToVideoArgs { + request: EnqueueVeo3p1ImageToVideoRequest { + image_url: TALL_CORGI_SHIBA_TREASURE_OCEAN_URL.to_string(), + prompt: "There is a tiny ocean island with a corgi and shiba and treasure chest on it. The corgi and shiba are barking at the chest, when suddenly the island launches itself into the air. The camera tracks the island and follows it up high in the sky. The sun beams over the horizon. The dogs are happy and bark. The gold coins gleam in the sun.".to_string(), + duration: Some(EnqueueVeo3p1ImageToVideoDurationSeconds::Eight), + aspect_ratio: Some(EnqueueVeo3p1ImageToVideoAspectRatio::NineBySixteen), + resolution: Some(EnqueueVeo3p1ImageToVideoResolution::TenEightyP), + generate_audio: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3p1_image_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/image/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/mod.rs new file mode 100644 index 00000000..c25ae055 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/image/mod.rs @@ -0,0 +1,23 @@ +pub mod enqueue_hailuo_v2p3_fast_pro_image_to_video_webhook; +pub mod enqueue_hailuo_v2p3_pro_image_to_video_webhook; +pub mod enqueue_kling_v1p6_pro_image_to_video_webhook; +pub mod enqueue_kling_v2p1_master_image_to_video_webhook; +pub mod enqueue_kling_v2p1_pro_image_to_video_webhook; +pub mod enqueue_kling_v2p5_turbo_pro_image_to_video_webhook; +pub mod enqueue_kling_v2p5_turbo_standard_image_to_video_webhook; +pub mod enqueue_kling_v2p6_pro_image_to_video_webhook; +pub mod enqueue_kling_3p0_pro_image_to_video_webhook; +pub mod enqueue_kling_3p0_standard_image_to_video_webhook; +pub mod enqueue_pixverse_v5_image_to_video_webhook; +pub mod enqueue_seedance_1_lite_image_to_video_webhook; +pub mod enqueue_seedance_1_pro_image_to_video_webhook; +pub mod enqueue_seedance_1p5_pro_image_to_video_webhook; +pub mod enqueue_sora_2_image_to_video_webhook; +pub mod enqueue_sora_2_pro_image_to_video_webhook; +pub mod enqueue_veo_2_image_to_video_webhook; +pub mod enqueue_veo_3_fast_image_to_video_webhook; +pub mod enqueue_veo_3_image_to_video_webhook; +pub mod enqueue_veo_3p1_fast_first_last_frame_image_to_video_webhook; +pub mod enqueue_veo_3p1_fast_image_to_video_webhook; +pub mod enqueue_veo_3p1_first_last_frame_image_to_video_webhook; +pub mod enqueue_veo_3p1_image_to_video_webhook; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/mod.rs new file mode 100644 index 00000000..70e79218 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/mod.rs @@ -0,0 +1,2 @@ +pub mod image; +pub mod text; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_hailuo_v2p3_pro_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_hailuo_v2p3_pro_text_to_video_webhook.rs new file mode 100644 index 00000000..065bf75a --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_hailuo_v2p3_pro_text_to_video_webhook.rs @@ -0,0 +1,83 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_hailuo_v2p3_pro_text_to_video::{hailuo_v2p3_pro_text_to_video, HailuoV2p3ProTextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueHailuoV2p3ProTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueHailuoV2p3ProTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueHailuoV2p3ProTextToVideoRequest { + // Request required + pub prompt: String, + + // Optional args + pub prompt_optimizer: Option, +} + +impl FalRequestCostCalculator for EnqueueHailuoV2p3ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + /// "Your request will cost $0.49 per video generation." + 49 + } +} + + +/// Hailuo 2.3 Pro Text-to-Video +/// https://fal.ai/models/fal-ai/minimax/hailuo-2.3/pro/text-to-video +pub async fn enqueue_hailuo_v2p3_pro_text_to_video_webhook( + args: EnqueueHailuoV2p3ProTextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + let prompt_optimizer = req.prompt_optimizer.unwrap_or(true); + + let request = HailuoV2p3ProTextToVideoInput { + prompt: req.prompt, + // Optionals + prompt_optimizer: Some(prompt_optimizer), + }; + + let result = hailuo_v2p3_pro_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_hailuo_v2p3_pro_text_to_video_webhook::{enqueue_hailuo_v2p3_pro_text_to_video_webhook, EnqueueHailuoV2p3ProTextToVideoArgs, EnqueueHailuoV2p3ProTextToVideoRequest}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueHailuoV2p3ProTextToVideoArgs { + request: EnqueueHailuoV2p3ProTextToVideoRequest { + prompt: "a gray alien with big eyes dressed in an american flag tank top gives the peace symbol, it then barbecues some hot dogs on the grill".to_string(), + prompt_optimizer: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_hailuo_v2p3_pro_text_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_3p0_pro_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_3p0_pro_text_to_video_webhook.rs new file mode 100644 index 00000000..86213d38 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_3p0_pro_text_to_video_webhook.rs @@ -0,0 +1,311 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_kling_3p0_pro_text_to_video::{kling_3p0_pro_text_to_video, Kling3p0ProTextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKling3p0ProTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKling3p0ProTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKling3p0ProTextToVideoRequest { + pub prompt: String, + + // Optional args + pub generate_audio: Option, + pub negative_prompt: Option, + pub duration: Option, + pub aspect_ratio: Option, + pub shot_type: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0ProTextToVideoDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +impl EnqueueKling3p0ProTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::ThreeSeconds => 3, + Self::FourSeconds => 4, + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + Self::NineSeconds => 9, + Self::TenSeconds => 10, + Self::ElevenSeconds => 11, + Self::TwelveSeconds => 12, + Self::ThirteenSeconds => 13, + Self::FourteenSeconds => 14, + Self::FifteenSeconds => 15, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::ThreeSeconds => "3", + Self::FourSeconds => "4", + Self::FiveSeconds => "5", + Self::SixSeconds => "6", + Self::SevenSeconds => "7", + Self::EightSeconds => "8", + Self::NineSeconds => "9", + Self::TenSeconds => "10", + Self::ElevenSeconds => "11", + Self::TwelveSeconds => "12", + Self::ThirteenSeconds => "13", + Self::FourteenSeconds => "14", + Self::FifteenSeconds => "15", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0ProTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0ProTextToVideoShotType { + Customize, + Intelligent, +} + +impl FalRequestCostCalculator for EnqueueKling3p0ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 3.0 Pro pricing: + // Audio off: $0.224/second + // Audio on: $0.336/second + let generate_audio = self.generate_audio.unwrap_or(true); + let duration_secs = self.duration + .unwrap_or(EnqueueKling3p0ProTextToVideoDuration::FiveSeconds) + .to_seconds(); + + let rate = if generate_audio { 336u64 } else { 224u64 }; + (rate * duration_secs + 9) / 10 + } +} + +/// Kling 3.0 Pro Text-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v3/pro/text-to-video +pub async fn enqueue_kling_3p0_pro_text_to_video_webhook( + args: EnqueueKling3p0ProTextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| d.to_str().to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect| match aspect { + EnqueueKling3p0ProTextToVideoAspectRatio::Square => "1:1", + EnqueueKling3p0ProTextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueKling3p0ProTextToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let shot_type = req.shot_type + .map(|st| match st { + EnqueueKling3p0ProTextToVideoShotType::Customize => "customize", + EnqueueKling3p0ProTextToVideoShotType::Intelligent => "intelligent", + }) + .map(|s| s.to_string()); + + let request = Kling3p0ProTextToVideoInput { + prompt: req.prompt, + generate_audio: req.generate_audio, + duration, + aspect_ratio, + negative_prompt: req.negative_prompt, + shot_type, + cfg_scale: None, + }; + + let result = kling_3p0_pro_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + + #[test] + fn test_cost() { + let mut req = EnqueueKling3p0ProTextToVideoRequest { + prompt: "a spacecraft drifts through an asteroid field, dramatic lighting".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(EnqueueKling3p0ProTextToVideoDuration::FiveSeconds), + aspect_ratio: None, + shot_type: None, + }; + + // Audio off: $0.224/sec + // 5s: (224 * 5 + 9) / 10 = 1129 / 10 = 112 + assert_eq!(req.calculate_cost_in_cents(), 112); + + // 3s: (224 * 3 + 9) / 10 = 681 / 10 = 68 + req.duration = Some(EnqueueKling3p0ProTextToVideoDuration::ThreeSeconds); + assert_eq!(req.calculate_cost_in_cents(), 68); + + // 10s: (224 * 10 + 9) / 10 = 2249 / 10 = 224 + req.duration = Some(EnqueueKling3p0ProTextToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 224); + + // 15s: (224 * 15 + 9) / 10 = 3369 / 10 = 336 + req.duration = Some(EnqueueKling3p0ProTextToVideoDuration::FifteenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 336); + + // Audio on: $0.336/sec + req.generate_audio = Some(true); + + // 5s: (336 * 5 + 9) / 10 = 1689 / 10 = 168 + req.duration = Some(EnqueueKling3p0ProTextToVideoDuration::FiveSeconds); + assert_eq!(req.calculate_cost_in_cents(), 168); + + // 10s: (336 * 10 + 9) / 10 = 3369 / 10 = 336 + req.duration = Some(EnqueueKling3p0ProTextToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 336); + + // 15s: (336 * 15 + 9) / 10 = 5049 / 10 = 504 + req.duration = Some(EnqueueKling3p0ProTextToVideoDuration::FifteenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 504); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKling3p0ProTextToVideoArgs { + request: EnqueueKling3p0ProTextToVideoRequest { + prompt: "a samurai draws a katana in a bamboo forest, cherry blossoms falling in slow motion".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(EnqueueKling3p0ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0ProTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_3p0_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueKling3p0ProTextToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueKling3p0ProTextToVideoArgs { + request: EnqueueKling3p0ProTextToVideoRequest { + prompt: "a lighthouse beam sweeps across a stormy sea at night".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(EnqueueKling3p0ProTextToVideoDuration::ThreeSeconds), + aspect_ratio: Some(ar), + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueKling3p0ProTextToVideoDuration::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueKling3p0ProTextToVideoArgs { + request: EnqueueKling3p0ProTextToVideoRequest { + prompt: "a hot air balloon rises over misty mountains at dawn".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(EnqueueKling3p0ProTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_shot_types() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for st in EnqueueKling3p0ProTextToVideoShotType::iter() { + println!("--- shot type: {:?} ---", st); + let args = EnqueueKling3p0ProTextToVideoArgs { + request: EnqueueKling3p0ProTextToVideoRequest { + prompt: "an eagle soars over a snow-capped mountain range".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(EnqueueKling3p0ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0ProTextToVideoAspectRatio::SixteenByNine), + shot_type: Some(st), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_3p0_standard_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_3p0_standard_text_to_video_webhook.rs new file mode 100644 index 00000000..7f3dab8c --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_3p0_standard_text_to_video_webhook.rs @@ -0,0 +1,312 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_kling_3p0_standard_text_to_video::{kling_3p0_standard_text_to_video, Kling3p0StandardTextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKling3p0StandardTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKling3p0StandardTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKling3p0StandardTextToVideoRequest { + pub prompt: String, + + // Optional args + pub generate_audio: Option, + pub negative_prompt: Option, + pub duration: Option, + pub aspect_ratio: Option, + pub shot_type: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0StandardTextToVideoDuration { + ThreeSeconds, + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, + ThirteenSeconds, + FourteenSeconds, + FifteenSeconds, +} + +impl EnqueueKling3p0StandardTextToVideoDuration { + pub fn to_seconds(&self) -> u64 { + match self { + Self::ThreeSeconds => 3, + Self::FourSeconds => 4, + Self::FiveSeconds => 5, + Self::SixSeconds => 6, + Self::SevenSeconds => 7, + Self::EightSeconds => 8, + Self::NineSeconds => 9, + Self::TenSeconds => 10, + Self::ElevenSeconds => 11, + Self::TwelveSeconds => 12, + Self::ThirteenSeconds => 13, + Self::FourteenSeconds => 14, + Self::FifteenSeconds => 15, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::ThreeSeconds => "3", + Self::FourSeconds => "4", + Self::FiveSeconds => "5", + Self::SixSeconds => "6", + Self::SevenSeconds => "7", + Self::EightSeconds => "8", + Self::NineSeconds => "9", + Self::TenSeconds => "10", + Self::ElevenSeconds => "11", + Self::TwelveSeconds => "12", + Self::ThirteenSeconds => "13", + Self::FourteenSeconds => "14", + Self::FifteenSeconds => "15", + } + } +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0StandardTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueKling3p0StandardTextToVideoShotType { + Customize, + Intelligent, +} + +impl FalRequestCostCalculator for EnqueueKling3p0StandardTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Kling 3.0 Standard pricing: + // Audio off: $0.168/second + // Audio on: $0.252/second + let generate_audio = self.generate_audio.unwrap_or(true); + let duration_secs = self.duration + .unwrap_or(EnqueueKling3p0StandardTextToVideoDuration::FiveSeconds) + .to_seconds(); + + // Rate in tenths-of-cents per second + let rate = if generate_audio { 252u64 } else { 168u64 }; + (rate * duration_secs + 9) / 10 + } +} + +/// Kling 3.0 Standard Text-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v3/standard/text-to-video +pub async fn enqueue_kling_3p0_standard_text_to_video_webhook( + args: EnqueueKling3p0StandardTextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| d.to_str().to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect| match aspect { + EnqueueKling3p0StandardTextToVideoAspectRatio::Square => "1:1", + EnqueueKling3p0StandardTextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueKling3p0StandardTextToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let shot_type = req.shot_type + .map(|st| match st { + EnqueueKling3p0StandardTextToVideoShotType::Customize => "customize", + EnqueueKling3p0StandardTextToVideoShotType::Intelligent => "intelligent", + }) + .map(|s| s.to_string()); + + let request = Kling3p0StandardTextToVideoInput { + prompt: req.prompt, + generate_audio: req.generate_audio, + duration, + aspect_ratio, + negative_prompt: req.negative_prompt, + shot_type, + cfg_scale: None, + }; + + let result = kling_3p0_standard_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + + #[test] + fn test_cost() { + let mut req = EnqueueKling3p0StandardTextToVideoRequest { + prompt: "a cat sitting on a windowsill watching rain".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(EnqueueKling3p0StandardTextToVideoDuration::FiveSeconds), + aspect_ratio: None, + shot_type: None, + }; + + // Audio off: $0.168/sec + // 5s: (168 * 5 + 9) / 10 = 849 / 10 = 84 + assert_eq!(req.calculate_cost_in_cents(), 84); + + // 3s: (168 * 3 + 9) / 10 = 513 / 10 = 51 + req.duration = Some(EnqueueKling3p0StandardTextToVideoDuration::ThreeSeconds); + assert_eq!(req.calculate_cost_in_cents(), 51); + + // 10s: (168 * 10 + 9) / 10 = 1689 / 10 = 168 + req.duration = Some(EnqueueKling3p0StandardTextToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 168); + + // 15s: (168 * 15 + 9) / 10 = 2529 / 10 = 252 + req.duration = Some(EnqueueKling3p0StandardTextToVideoDuration::FifteenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 252); + + // Audio on: $0.252/sec + req.generate_audio = Some(true); + + // 5s: (252 * 5 + 9) / 10 = 1269 / 10 = 126 + req.duration = Some(EnqueueKling3p0StandardTextToVideoDuration::FiveSeconds); + assert_eq!(req.calculate_cost_in_cents(), 126); + + // 10s: (252 * 10 + 9) / 10 = 2529 / 10 = 252 + req.duration = Some(EnqueueKling3p0StandardTextToVideoDuration::TenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 252); + + // 15s: (252 * 15 + 9) / 10 = 3789 / 10 = 378 + req.duration = Some(EnqueueKling3p0StandardTextToVideoDuration::FifteenSeconds); + assert_eq!(req.calculate_cost_in_cents(), 378); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKling3p0StandardTextToVideoArgs { + request: EnqueueKling3p0StandardTextToVideoRequest { + prompt: "a golden retriever puppy chases butterflies through a sunlit meadow, cinematic slow motion".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(EnqueueKling3p0StandardTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_3p0_standard_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueKling3p0StandardTextToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueKling3p0StandardTextToVideoArgs { + request: EnqueueKling3p0StandardTextToVideoRequest { + prompt: "a wave crashes against a rocky shoreline at sunset".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(EnqueueKling3p0StandardTextToVideoDuration::ThreeSeconds), + aspect_ratio: Some(ar), + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_standard_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueKling3p0StandardTextToVideoDuration::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueKling3p0StandardTextToVideoArgs { + request: EnqueueKling3p0StandardTextToVideoRequest { + prompt: "a candle flame flickers in a dark room".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(dur), + aspect_ratio: Some(EnqueueKling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_standard_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_shot_types() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for st in EnqueueKling3p0StandardTextToVideoShotType::iter() { + println!("--- shot type: {:?} ---", st); + let args = EnqueueKling3p0StandardTextToVideoArgs { + request: EnqueueKling3p0StandardTextToVideoRequest { + prompt: "a bird takes flight from a tree branch".to_string(), + generate_audio: Some(true), + negative_prompt: None, + duration: Some(EnqueueKling3p0StandardTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueKling3p0StandardTextToVideoAspectRatio::SixteenByNine), + shot_type: Some(st), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_kling_3p0_standard_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_v2p5_turbo_pro_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_v2p5_turbo_pro_text_to_video_webhook.rs new file mode 100644 index 00000000..800eab87 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_v2p5_turbo_pro_text_to_video_webhook.rs @@ -0,0 +1,124 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_kling_v2p5_turbo_pro_text_to_video::{kling_v2p5_turbo_pro_text_to_video, KlingV2p5TurboProTextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKlingV2p5TurboProTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKlingV2p5TurboProTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKlingV2p5TurboProTextToVideoRequest { + // Request required + pub prompt: String, + + // Optional args + pub negative_prompt: Option, + pub duration: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p5TurboProTextToVideoDurationSeconds { + Five, + Ten, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p5TurboProTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + + +impl FalRequestCostCalculator for EnqueueKlingV2p5TurboProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For 5s video your request will cost $0.35. + // For every additional second you will be charged $0.07." + match self.duration { + None => 35, // $0.35 + Some(EnqueueKlingV2p5TurboProTextToVideoDurationSeconds::Five) => 35, // $0.35 + Some(EnqueueKlingV2p5TurboProTextToVideoDurationSeconds::Ten) => 70, // $0.35 + (5 * $0.07) = $0.70 + } + } +} + + +/// Kling 2.5 Turbo Pro Text-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.5-turbo/pro/text-to-video +pub async fn enqueue_kling_v2p5_turbo_pro_text_to_video_webhook( + args: EnqueueKlingV2p5TurboProTextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueKlingV2p5TurboProTextToVideoDurationSeconds::Five => "5", + EnqueueKlingV2p5TurboProTextToVideoDurationSeconds::Ten => "10", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect| match aspect { + EnqueueKlingV2p5TurboProTextToVideoAspectRatio::Square => "1:1", + EnqueueKlingV2p5TurboProTextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueKlingV2p5TurboProTextToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let request = KlingV2p5TurboProTextToVideoInput { + prompt: req.prompt, + // Optionals + duration, + aspect_ratio, + negative_prompt: req.negative_prompt, + // Constants + cfg_scale: None, + }; + + let result = kling_v2p5_turbo_pro_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_kling_v2p5_turbo_pro_text_to_video_webhook::{enqueue_kling_v2p5_turbo_pro_text_to_video_webhook, EnqueueKlingV2p5TurboProTextToVideoArgs, EnqueueKlingV2p5TurboProTextToVideoRequest, EnqueueKlingV2p5TurboProTextToVideoAspectRatio, EnqueueKlingV2p5TurboProTextToVideoDurationSeconds}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKlingV2p5TurboProTextToVideoArgs { + request: EnqueueKlingV2p5TurboProTextToVideoRequest { + prompt: "an owl flies by an abandoned castle at dusk. the camera tracks the flying owl. the castle stones are damp and gritty. there are lots of trees. fireflies dance over the fields".to_string(), + negative_prompt: None, + aspect_ratio: Some(EnqueueKlingV2p5TurboProTextToVideoAspectRatio::SixteenByNine), + duration: Some(EnqueueKlingV2p5TurboProTextToVideoDurationSeconds::Five), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p5_turbo_pro_text_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_v2p6_pro_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_v2p6_pro_text_to_video_webhook.rs new file mode 100644 index 00000000..a16019ad --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_kling_v2p6_pro_text_to_video_webhook.rs @@ -0,0 +1,131 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_kling_v2p6_pro_text_to_video::{kling_v2p6_pro_text_to_video, KlingV2p6ProTextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueKlingV2p6ProTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueKlingV2p6ProTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueKlingV2p6ProTextToVideoRequest { + // Request required + pub prompt: String, + + // Optional args + pub generate_audio: Option, + pub negative_prompt: Option, + pub duration: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p6ProTextToVideoDurationSeconds { + Five, + Ten, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueKlingV2p6ProTextToVideoAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +impl FalRequestCostCalculator for EnqueueKlingV2p6ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be + // charged $0.07 (audio off) or $0.14 (audio on). + // For example, a 5s video with audio on will cost $0.70" + let generate_audio = self.generate_audio.unwrap_or(true); + let duration = self.duration.unwrap_or(EnqueueKlingV2p6ProTextToVideoDurationSeconds::Five); + + match (generate_audio, duration) { + (false, EnqueueKlingV2p6ProTextToVideoDurationSeconds::Five) => 35, // audio off: $0.07 * 5 = $0.35 + (false, EnqueueKlingV2p6ProTextToVideoDurationSeconds::Ten) => 70, // audio off: $0.07 * 10 = $0.70 + (true, EnqueueKlingV2p6ProTextToVideoDurationSeconds::Five) => 70, // audio on: $0.14 * 5 = $0.70 + (true, EnqueueKlingV2p6ProTextToVideoDurationSeconds::Ten) => 140, // audio on: $0.14 * 10 = $1.40 + } + } +} + + +/// Kling 2.6 Pro Text-to-Video +/// https://fal.ai/models/fal-ai/kling-video/v2.6/pro/text-to-video +pub async fn enqueue_kling_v2p6_pro_text_to_video_webhook( + args: EnqueueKlingV2p6ProTextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueKlingV2p6ProTextToVideoDurationSeconds::Five => "5", + EnqueueKlingV2p6ProTextToVideoDurationSeconds::Ten => "10", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect| match aspect { + EnqueueKlingV2p6ProTextToVideoAspectRatio::Square => "1:1", + EnqueueKlingV2p6ProTextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueKlingV2p6ProTextToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let request = KlingV2p6ProTextToVideoInput { + prompt: req.prompt, + // Optionals + generate_audio: req.generate_audio, + duration, + aspect_ratio, + negative_prompt: req.negative_prompt, + // Constants + cfg_scale: None, + }; + + let result = kling_v2p6_pro_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_kling_v2p6_pro_text_to_video_webhook::{enqueue_kling_v2p6_pro_text_to_video_webhook, EnqueueKlingV2p6ProTextToVideoArgs, EnqueueKlingV2p6ProTextToVideoRequest, EnqueueKlingV2p6ProTextToVideoAspectRatio, EnqueueKlingV2p6ProTextToVideoDurationSeconds}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueKlingV2p6ProTextToVideoArgs { + request: EnqueueKlingV2p6ProTextToVideoRequest { + prompt: "a humanoid lizard creature walks around on the surface of an alien planet. the sky is purple and there are yellow plants. The lizard says, 'You should consider day trading'. Suddenly a giant t-rex comes in from off screen and eats the lizard creature.".to_string(), + negative_prompt: None, + aspect_ratio: Some(EnqueueKlingV2p6ProTextToVideoAspectRatio::SixteenByNine), + duration: Some(EnqueueKlingV2p6ProTextToVideoDurationSeconds::Ten), + generate_audio: Some(true), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_kling_v2p6_pro_text_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_pixverse_v5_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_pixverse_v5_text_to_video_webhook.rs new file mode 100644 index 00000000..88d90799 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_pixverse_v5_text_to_video_webhook.rs @@ -0,0 +1,155 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::text::http_pixverse_v5_text_to_video::{pixverse_v5_text_to_video, PixverseV5TextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueuePixverseV5TextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueuePixverseV5TextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueuePixverseV5TextToVideoRequest { + // Request required + pub prompt: String, + + // Optional args + pub negative_prompt: Option, + + // NB: eight-second videos do not work with 1080P + pub duration: Option, + pub aspect_ratio: Option, + pub resolution: Option, + pub style: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5TextToVideoDurationSeconds { + Five, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5TextToVideoResolution { + ThreeSixtyP, + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5TextToVideoAspectRatio { + Square, + SixteenByNine, + FourByThree, + NineBySixteen, + ThreeByFour, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueuePixverseV5TextToVideoStyle { + Anime, + Animation3d, + Clay, + Comic, + Cyberpunk, +} + +pub async fn enqueue_pixverse_v5_text_to_video_webhook( + args: EnqueuePixverseV5TextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueuePixverseV5TextToVideoDurationSeconds::Five => "5", + EnqueuePixverseV5TextToVideoDurationSeconds::Eight=> "8", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueuePixverseV5TextToVideoAspectRatio::Square => "1:1", + EnqueuePixverseV5TextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueuePixverseV5TextToVideoAspectRatio::FourByThree => "4:3", + EnqueuePixverseV5TextToVideoAspectRatio::NineBySixteen => "9:16", + EnqueuePixverseV5TextToVideoAspectRatio::ThreeByFour => "3:4", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueuePixverseV5TextToVideoResolution::ThreeSixtyP => "360p", + EnqueuePixverseV5TextToVideoResolution::FiveFortyP => "540p", + EnqueuePixverseV5TextToVideoResolution::SevenTwentyP => "720p", + EnqueuePixverseV5TextToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let style = req.style + .map(|style| match style { + EnqueuePixverseV5TextToVideoStyle::Anime => "anime", + EnqueuePixverseV5TextToVideoStyle::Animation3d => "3d_animation", + EnqueuePixverseV5TextToVideoStyle::Clay => "clay", + EnqueuePixverseV5TextToVideoStyle::Comic => "comic", + EnqueuePixverseV5TextToVideoStyle::Cyberpunk => "cyberpunk", + }) + .map(|s| s.to_string()); + + let request = PixverseV5TextToVideoInput { + prompt: req.prompt, + // Optionals + duration, + negative_prompt: req.negative_prompt, + aspect_ratio, + resolution, + style, + // Constant + seed: None, + }; + + let result = pixverse_v5_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_pixverse_v5_text_to_video_webhook::{enqueue_pixverse_v5_text_to_video_webhook, EnqueuePixverseV5TextToVideoArgs, EnqueuePixverseV5TextToVideoRequest, EnqueuePixverseV5TextToVideoAspectRatio, EnqueuePixverseV5TextToVideoDurationSeconds, EnqueuePixverseV5TextToVideoResolution, EnqueuePixverseV5TextToVideoStyle}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueuePixverseV5TextToVideoArgs { + request: EnqueuePixverseV5TextToVideoRequest { + prompt: "an angry racoon shakes its fist at the garbage truck as it drives away, the camera orbits the racoon. the racoon sighs".to_string(), + negative_prompt: None, + duration: Some(EnqueuePixverseV5TextToVideoDurationSeconds::Eight), + style: Some(EnqueuePixverseV5TextToVideoStyle::Anime), + aspect_ratio: Some(EnqueuePixverseV5TextToVideoAspectRatio::FourByThree), + resolution: Some(EnqueuePixverseV5TextToVideoResolution::SevenTwentyP), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_pixverse_v5_text_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_seedance_1p5_pro_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_seedance_1p5_pro_text_to_video_webhook.rs new file mode 100644 index 00000000..e8e55ca6 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_seedance_1p5_pro_text_to_video_webhook.rs @@ -0,0 +1,343 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::text::http_seedance_1p5_pro_text_to_video::{seedance_1p5_pro_text_to_video, Seedance1p5ProTextToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueSeedance1p5ProTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueSeedance1p5ProTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueSeedance1p5ProTextToVideoRequest { + // Request required + pub prompt: String, + + // Optional args + pub resolution: Option, + pub duration: Option, + pub aspect_ratio: Option, + pub generate_audio: Option, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueSeedance1p5ProTextToVideoDuration { + FourSeconds, + FiveSeconds, + SixSeconds, + SevenSeconds, + EightSeconds, + NineSeconds, + TenSeconds, + ElevenSeconds, + TwelveSeconds, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueSeedance1p5ProTextToVideoResolution { + FourEightyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::EnumIter)] +pub enum EnqueueSeedance1p5ProTextToVideoAspectRatio { + TwentyOneByNine, + SixteenByNine, + FourByThree, + Square, + ThreeByFour, + NineBySixteen, + Auto, +} + +impl FalRequestCostCalculator for EnqueueSeedance1p5ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Fal: + // "Each 720p 5 second video with audio costs roughly $0.26. + // For other resolutions, 1 million video tokens with audio costs $2.4. + // Without audio, the price is 1.2 per million tokens. + // tokens(video) = (height x width x FPS x duration) / 1024." + + let resolution = self.resolution.unwrap_or(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP); + let duration = self.duration.unwrap_or(EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds); + + let audio = self.generate_audio.unwrap_or(true); + let dollars_per_million_tokens = if audio { 2.4 } else { 1.2 }; + + if resolution == EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP + && duration == EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds + { + return if audio { 26 } else { 13 }; + } + + // TODO: Only correct for some aspect ratios for now. + let (width, height) = match resolution { + EnqueueSeedance1p5ProTextToVideoResolution::FourEightyP => (640u32, 480u32), // NB: Only for 4:3 ! + EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP => (1280, 720), // NB: Only for 16:9 ! + EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP => (1920, 1080), + }; + + let duration_secs = match duration { + EnqueueSeedance1p5ProTextToVideoDuration::FourSeconds => 4.0, + EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds => 5.0, + EnqueueSeedance1p5ProTextToVideoDuration::SixSeconds => 6.0, + EnqueueSeedance1p5ProTextToVideoDuration::SevenSeconds => 7.0, + EnqueueSeedance1p5ProTextToVideoDuration::EightSeconds => 8.0, + EnqueueSeedance1p5ProTextToVideoDuration::NineSeconds => 9.0, + EnqueueSeedance1p5ProTextToVideoDuration::TenSeconds => 10.0, + EnqueueSeedance1p5ProTextToVideoDuration::ElevenSeconds => 11.0, + EnqueueSeedance1p5ProTextToVideoDuration::TwelveSeconds => 12.0, + }; + + const FPS: f64 = 30.0; + + let tokens = (height as f64) * (width as f64) * FPS * duration_secs; + let tokens = tokens / 1024.0; + + let cost = tokens * dollars_per_million_tokens / 1_000_000.0; + let cost = cost * 100.0; // Dollars to cents. + let cost = cost.ceil(); + + cost as UsdCents + } +} + +/// Seedance 1.5 Pro Text-to-Video +/// https://fal.ai/models/fal-ai/bytedance/seedance/v1.5/pro/text-to-video +pub async fn enqueue_seedance_1p5_pro_text_to_video_webhook( + args: EnqueueSeedance1p5ProTextToVideoArgs<'_, R> +) -> Result { + + let req = args.request; + + let duration = req.duration + .map(|d| match d { + EnqueueSeedance1p5ProTextToVideoDuration::FourSeconds => "4", + EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds => "5", + EnqueueSeedance1p5ProTextToVideoDuration::SixSeconds => "6", + EnqueueSeedance1p5ProTextToVideoDuration::SevenSeconds => "7", + EnqueueSeedance1p5ProTextToVideoDuration::EightSeconds => "8", + EnqueueSeedance1p5ProTextToVideoDuration::NineSeconds => "9", + EnqueueSeedance1p5ProTextToVideoDuration::TenSeconds => "10", + EnqueueSeedance1p5ProTextToVideoDuration::ElevenSeconds => "11", + EnqueueSeedance1p5ProTextToVideoDuration::TwelveSeconds => "12", + }) + .map(|d| d.to_string()); + + let resolution = req.resolution + .map(|r| match r { + EnqueueSeedance1p5ProTextToVideoResolution::FourEightyP => "480p", + EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP => "720p", + EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP => "1080p", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueSeedance1p5ProTextToVideoAspectRatio::TwentyOneByNine => "21:9", + EnqueueSeedance1p5ProTextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueSeedance1p5ProTextToVideoAspectRatio::FourByThree => "4:3", + EnqueueSeedance1p5ProTextToVideoAspectRatio::Square => "1:1", + EnqueueSeedance1p5ProTextToVideoAspectRatio::ThreeByFour => "3:4", + EnqueueSeedance1p5ProTextToVideoAspectRatio::NineBySixteen => "9:16", + EnqueueSeedance1p5ProTextToVideoAspectRatio::Auto => "auto", + }) + .map(|ar| ar.to_string()); + + let request = Seedance1p5ProTextToVideoInput { + prompt: req.prompt, + duration, + resolution, + aspect_ratio, + camera_fixed: None, + seed: None, + enable_safety_checker: Some(false), + generate_audio: Some(req.generate_audio.unwrap_or(true)), + }; + + let result = seedance_1p5_pro_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use crate::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + + #[test] + fn test_cost() { + let mut req = EnqueueSeedance1p5ProTextToVideoRequest { + prompt: String::new(), + duration: Some(EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds), + resolution: Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP), + aspect_ratio: None, + generate_audio: None, + }; + + // NB: Constant value specified by Fal + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 26); + + // Calculated values + req.duration = Some(EnqueueSeedance1p5ProTextToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 65); + + req.duration = Some(EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds); + req.resolution = Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 73); + + req.duration = Some(EnqueueSeedance1p5ProTextToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 146); + } + + #[test] + fn test_cost_audio_off() { + let mut req = EnqueueSeedance1p5ProTextToVideoRequest { + prompt: String::new(), + duration: Some(EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds), + resolution: Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP), + aspect_ratio: None, + generate_audio: Some(false), + }; + + // 720p 5s without audio = half of 26 + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 13); + + // Calculated values — half of audio-on costs (ceil) + req.duration = Some(EnqueueSeedance1p5ProTextToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 33); + + req.duration = Some(EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds); + req.resolution = Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 37); + + req.duration = Some(EnqueueSeedance1p5ProTextToVideoDuration::TenSeconds); + req.resolution = Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP); + let cost = req.calculate_cost_in_cents(); + assert_eq!(cost, 73); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueSeedance1p5ProTextToVideoArgs { + request: EnqueueSeedance1p5ProTextToVideoRequest { + prompt: "a dinosaur walks through a misty forest at dawn, cinematic lighting".to_string(), + duration: Some(EnqueueSeedance1p5ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP), + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_seedance_1p5_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueSeedance1p5ProTextToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueSeedance1p5ProTextToVideoArgs { + request: EnqueueSeedance1p5ProTextToVideoRequest { + prompt: "a corgi runs along a beach at golden hour".to_string(), + duration: Some(EnqueueSeedance1p5ProTextToVideoDuration::FourSeconds), + aspect_ratio: Some(ar), + resolution: None, + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_seedance_1p5_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueSeedance1p5ProTextToVideoDuration::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueSeedance1p5ProTextToVideoArgs { + request: EnqueueSeedance1p5ProTextToVideoRequest { + prompt: "a corgi runs along a beach at golden hour".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::SixteenByNine), + resolution: None, + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_seedance_1p5_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_resolutions() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for res in EnqueueSeedance1p5ProTextToVideoResolution::iter() { + println!("--- resolution: {:?} ---", res); + let args = EnqueueSeedance1p5ProTextToVideoArgs { + request: EnqueueSeedance1p5ProTextToVideoRequest { + prompt: "a bird flying over an ocean at golden hour".to_string(), + duration: Some(EnqueueSeedance1p5ProTextToVideoDuration::FourSeconds), + aspect_ratio: Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::SixteenByNine), + resolution: Some(res), + generate_audio: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_seedance_1p5_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_sora_2_pro_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_sora_2_pro_text_to_video_webhook.rs new file mode 100644 index 00000000..41983a73 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_sora_2_pro_text_to_video_webhook.rs @@ -0,0 +1,209 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::text::http_sora_2_pro_text_to_video::{sora_2_pro_text_to_video, Sora2ProTextToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueSora2ProTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueSora2ProTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueSora2ProTextToVideoRequest { + pub prompt: String, + pub resolution: Option, + pub duration: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ProTextToVideoDurationSeconds { + Four, + Eight, + Twelve, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ProTextToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2ProTextToVideoAspectRatio { + NineBySixteen, + SixteenByNine, +} + + +impl FalRequestCostCalculator for EnqueueSora2ProTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Pricing: $0.30/s for 720p and $0.50/s for 1080p. + let duration = self.duration.unwrap_or(EnqueueSora2ProTextToVideoDurationSeconds::Four); + let resolution = self.resolution.unwrap_or(EnqueueSora2ProTextToVideoResolution::TenEightyP); + + match (duration, resolution) { + (EnqueueSora2ProTextToVideoDurationSeconds::Four, EnqueueSora2ProTextToVideoResolution::SevenTwentyP) => 120, + (EnqueueSora2ProTextToVideoDurationSeconds::Four, EnqueueSora2ProTextToVideoResolution::TenEightyP) => 200, + (EnqueueSora2ProTextToVideoDurationSeconds::Eight, EnqueueSora2ProTextToVideoResolution::SevenTwentyP) => 240, + (EnqueueSora2ProTextToVideoDurationSeconds::Eight, EnqueueSora2ProTextToVideoResolution::TenEightyP) => 400, + (EnqueueSora2ProTextToVideoDurationSeconds::Twelve, EnqueueSora2ProTextToVideoResolution::SevenTwentyP) => 360, + (EnqueueSora2ProTextToVideoDurationSeconds::Twelve, EnqueueSora2ProTextToVideoResolution::TenEightyP) => 600, + } + } +} + +/// Sora 2 Pro Text-to-Video +/// https://fal.ai/models/fal-ai/sora-2/text-to-video/pro +pub async fn enqueue_sora_2_pro_text_to_video_webhook( + args: EnqueueSora2ProTextToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|d| match d { + EnqueueSora2ProTextToVideoDurationSeconds::Four => 4, + EnqueueSora2ProTextToVideoDurationSeconds::Eight => 8, + EnqueueSora2ProTextToVideoDurationSeconds::Twelve => 12, + }); + + let resolution = req.resolution + .map(|r| match r { + EnqueueSora2ProTextToVideoResolution::SevenTwentyP => "720p", + EnqueueSora2ProTextToVideoResolution::TenEightyP => "1080p", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueSora2ProTextToVideoAspectRatio::NineBySixteen => "9:16", + EnqueueSora2ProTextToVideoAspectRatio::SixteenByNine => "16:9", + }) + .map(|ar| ar.to_string()); + + let request = Sora2ProTextToVideoInput { + prompt: req.prompt, + duration, + resolution, + aspect_ratio, + delete_video: Some(false), + }; + + let result = sora_2_pro_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueSora2ProTextToVideoArgs { + request: EnqueueSora2ProTextToVideoRequest { + prompt: "a dinosaur turns to the camera and asks, 'do you have adequate car insurance?' it then stomps off and attacks a brontosaurus".to_string(), + duration: Some(EnqueueSora2ProTextToVideoDurationSeconds::Eight), + aspect_ratio: Some(EnqueueSora2ProTextToVideoAspectRatio::NineBySixteen), + resolution: Some(EnqueueSora2ProTextToVideoResolution::SevenTwentyP), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_sora_2_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueSora2ProTextToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueSora2ProTextToVideoArgs { + request: EnqueueSora2ProTextToVideoRequest { + prompt: "a serene mountain lake at sunset with gentle ripples".to_string(), + duration: Some(EnqueueSora2ProTextToVideoDurationSeconds::Four), + aspect_ratio: Some(ar), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueSora2ProTextToVideoDurationSeconds::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueSora2ProTextToVideoArgs { + request: EnqueueSora2ProTextToVideoRequest { + prompt: "Suspenseful Hollywood movie. Interior, night. Customers are eating at a city diner. Suddenly a t-rex bursts its head through the large windows. The customers run.".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueSora2ProTextToVideoAspectRatio::SixteenByNine), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_resolutions() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for res in EnqueueSora2ProTextToVideoResolution::iter() { + println!("--- resolution: {:?} ---", res); + let args = EnqueueSora2ProTextToVideoArgs { + request: EnqueueSora2ProTextToVideoRequest { + prompt: "a bird flying over an ocean at golden hour".to_string(), + duration: Some(EnqueueSora2ProTextToVideoDurationSeconds::Four), + aspect_ratio: Some(EnqueueSora2ProTextToVideoAspectRatio::SixteenByNine), + resolution: Some(res), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_pro_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_sora_2_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_sora_2_text_to_video_webhook.rs new file mode 100644 index 00000000..9a01a6d9 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_sora_2_text_to_video_webhook.rs @@ -0,0 +1,177 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests_old::http::video::text::http_sora_2_text_to_video::{sora_2_text_to_video, Sora2TextToVideoInput}; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueSora2TextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueSora2TextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueSora2TextToVideoRequest { + pub prompt: String, + pub resolution: Option, + pub duration: Option, + pub aspect_ratio: Option, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2TextToVideoDurationSeconds { + Four, + Eight, + Twelve, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2TextToVideoResolution { + SevenTwentyP, +} + +#[derive(Copy, Clone, Debug, strum::EnumIter)] +pub enum EnqueueSora2TextToVideoAspectRatio { + NineBySixteen, + SixteenByNine, +} + + +impl FalRequestCostCalculator for EnqueueSora2TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "The pricing is $0.1/s for Sora 2." + let duration = self.duration.unwrap_or(EnqueueSora2TextToVideoDurationSeconds::Four); + match duration { + EnqueueSora2TextToVideoDurationSeconds::Four => 40, // $0.10 * 4 + EnqueueSora2TextToVideoDurationSeconds::Eight => 80, // $0.10 * 8 + EnqueueSora2TextToVideoDurationSeconds::Twelve => 120 // $0.10 * 12 + } + } +} + +/// Sora 2 Text-to-Video +/// https://fal.ai/models/fal-ai/sora-2/text-to-video +pub async fn enqueue_sora_2_text_to_video_webhook( + args: EnqueueSora2TextToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|d| match d { + EnqueueSora2TextToVideoDurationSeconds::Four => 4, + EnqueueSora2TextToVideoDurationSeconds::Eight => 8, + EnqueueSora2TextToVideoDurationSeconds::Twelve => 12, + }); + + let resolution = req.resolution + .map(|r| match r { + EnqueueSora2TextToVideoResolution::SevenTwentyP => "720p", + }) + .map(|r| r.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|ar| match ar { + EnqueueSora2TextToVideoAspectRatio::NineBySixteen => "9:16", + EnqueueSora2TextToVideoAspectRatio::SixteenByNine => "16:9", + }) + .map(|ar| ar.to_string()); + + let request = Sora2TextToVideoInput { + prompt: req.prompt, + duration, + resolution, + aspect_ratio, + delete_video: Some(false), + }; + + let result = sora_2_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::fal_api_key::FalApiKey; + use errors::AnyhowResult; + use std::fs::read_to_string; + use strum::IntoEnumIterator; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn test() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueSora2TextToVideoArgs { + request: EnqueueSora2TextToVideoRequest { + prompt: "a dinosaur turns to the camera and asks, 'do you have adequate car insurance?' it then stomps off and attacks a brontosaurus".to_string(), + duration: Some(EnqueueSora2TextToVideoDurationSeconds::Eight), + aspect_ratio: Some(EnqueueSora2TextToVideoAspectRatio::NineBySixteen), + resolution: Some(EnqueueSora2TextToVideoResolution::SevenTwentyP), + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_sora_2_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_aspect_ratios() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for ar in EnqueueSora2TextToVideoAspectRatio::iter() { + println!("--- aspect ratio: {:?} ---", ar); + let args = EnqueueSora2TextToVideoArgs { + request: EnqueueSora2TextToVideoRequest { + prompt: "a snowy mountain cabin at sunrise".to_string(), + duration: Some(EnqueueSora2TextToVideoDurationSeconds::Four), + aspect_ratio: Some(ar), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request per variant (expensive) + async fn test_all_durations() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + for dur in EnqueueSora2TextToVideoDurationSeconds::iter() { + println!("--- duration: {:?} ---", dur); + let args = EnqueueSora2TextToVideoArgs { + request: EnqueueSora2TextToVideoRequest { + prompt: "a corgi walks in front of a giant windmill in a beautiful village at sunrise".to_string(), + duration: Some(dur), + aspect_ratio: Some(EnqueueSora2TextToVideoAspectRatio::SixteenByNine), + resolution: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + let result = enqueue_sora_2_text_to_video_webhook(args).await?; + println!("result: {:?}", result); + } + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_2_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_2_text_to_video_webhook.rs new file mode 100644 index 00000000..66c97673 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_2_text_to_video_webhook.rs @@ -0,0 +1,113 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::core_api::webhook_response::WebhookResponse; +use crate::requests_old::http::video::text::http_veo_2_text_to_video::{ + veo_2_text_to_video, Veo2TextToVideoInput, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{ + FalRequestCostCalculator, UsdCents, +}; +// Re-use the same duration/aspect-ratio enums as image-to-video. +pub use crate::requests_old::webhook::video::image::enqueue_veo_2_image_to_video_webhook::{ + Veo2AspectRatio, Veo2Duration, +}; +use reqwest::IntoUrl; + +pub struct Veo2TextToVideoArgs<'a, V: IntoUrl> { + pub request: Veo2TextToVideoRequest, + pub webhook_url: V, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Veo2TextToVideoRequest { + pub prompt: String, + pub negative_prompt: Option, + pub duration: Veo2Duration, + pub aspect_ratio: Veo2AspectRatio, +} + +impl FalRequestCostCalculator for Veo2TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // Same pricing as image-to-video: + // "For 5s video your request will cost $2.50. + // For every additional second you will be charged $0.50." + match self.duration { + Veo2Duration::Default => 250, + Veo2Duration::FiveSeconds => 250, + Veo2Duration::SixSeconds => 300, + Veo2Duration::SevenSeconds => 350, + Veo2Duration::EightSeconds => 400, + } + } +} + +/// Veo 2 Text-to-Video +/// https://fal.ai/models/fal-ai/veo2 +pub async fn enqueue_veo_2_text_to_video_webhook( + args: Veo2TextToVideoArgs<'_, V>, +) -> Result { + let req = args.request; + + let duration = match req.duration { + Veo2Duration::Default => None, + Veo2Duration::FiveSeconds => Some("5s".to_string()), + Veo2Duration::SixSeconds => Some("6s".to_string()), + Veo2Duration::SevenSeconds => Some("7s".to_string()), + Veo2Duration::EightSeconds => Some("8s".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Veo2AspectRatio::Auto => None, // Let the API default (16:9) + Veo2AspectRatio::AutoPreferPortrait => Some("9:16".to_string()), + Veo2AspectRatio::WideSixteenNine => Some("16:9".to_string()), + Veo2AspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let request = Veo2TextToVideoInput { + prompt: req.prompt, + aspect_ratio, + duration, + negative_prompt: req.negative_prompt, + }; + + let result = veo_2_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_veo_2_text_to_video_webhook::{ + enqueue_veo_2_text_to_video_webhook, Veo2TextToVideoArgs, Veo2TextToVideoRequest, + Veo2AspectRatio, Veo2Duration, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test_veo_2_text_to_video() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Veo2TextToVideoArgs { + request: Veo2TextToVideoRequest { + prompt: "a drone shot of a coastal sunset with waves crashing on rocks".to_string(), + negative_prompt: None, + duration: Veo2Duration::FiveSeconds, + aspect_ratio: Veo2AspectRatio::WideSixteenNine, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_veo_2_text_to_video_webhook(args).await?; + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3_text_to_video_webhook.rs new file mode 100644 index 00000000..a3ed5998 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3_text_to_video_webhook.rs @@ -0,0 +1,146 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::core_api::webhook_response::WebhookResponse; +use crate::requests_old::http::video::text::http_veo_3_text_to_video::{ + veo_3_text_to_video, Veo3TextToVideoInput, +}; +use crate::requests::traits::fal_request_cost_calculator_trait::{ + FalRequestCostCalculator, UsdCents, +}; +use reqwest::IntoUrl; + +pub struct Veo3TextToVideoArgs<'a, V: IntoUrl> { + pub request: Veo3TextToVideoRequest, + pub webhook_url: V, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct Veo3TextToVideoRequest { + pub prompt: String, + pub negative_prompt: Option, + pub duration: Veo3T2vDuration, + pub aspect_ratio: Veo3T2vAspectRatio, + pub resolution: Veo3T2vResolution, + pub generate_audio: bool, +} + +/// Duration for Veo 3 text-to-video. Default is 8 seconds. +#[derive(Copy, Clone, Debug)] +pub enum Veo3T2vDuration { + Default, // Default is 8 seconds + FourSeconds, + SixSeconds, + EightSeconds, +} + +/// Aspect ratio for Veo 3 text-to-video. +/// Only 16:9 and 9:16 are supported. No Auto, no Square. +#[derive(Copy, Clone, Debug)] +pub enum Veo3T2vAspectRatio { + Default, // Default is 16:9 + WideSixteenNine, // 16:9 + TallNineSixteen, // 9:16 +} + +/// Resolution for Veo 3 text-to-video. +#[derive(Copy, Clone, Debug)] +pub enum Veo3T2vResolution { + Default, + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for Veo3TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // $0.20/sec audio off, $0.40/sec audio on. + match (self.duration, self.generate_audio) { + (Veo3T2vDuration::FourSeconds, false) => 80, + (Veo3T2vDuration::SixSeconds, false) => 120, + (Veo3T2vDuration::EightSeconds, false) => 160, + (Veo3T2vDuration::Default, false) => 160, + (Veo3T2vDuration::FourSeconds, true) => 160, + (Veo3T2vDuration::SixSeconds, true) => 240, + (Veo3T2vDuration::EightSeconds, true) => 320, + (Veo3T2vDuration::Default, true) => 320, + } + } +} + +/// Veo 3 Text-to-Video +/// https://fal.ai/models/fal-ai/veo3 +pub async fn enqueue_veo_3_text_to_video_webhook( + args: Veo3TextToVideoArgs<'_, V>, +) -> Result { + let req = args.request; + + let duration = match req.duration { + Veo3T2vDuration::Default => None, + Veo3T2vDuration::FourSeconds => Some("4s".to_string()), + Veo3T2vDuration::SixSeconds => Some("6s".to_string()), + Veo3T2vDuration::EightSeconds => Some("8s".to_string()), + }; + + let aspect_ratio = match req.aspect_ratio { + Veo3T2vAspectRatio::Default => None, + Veo3T2vAspectRatio::WideSixteenNine => Some("16:9".to_string()), + Veo3T2vAspectRatio::TallNineSixteen => Some("9:16".to_string()), + }; + + let resolution = match req.resolution { + Veo3T2vResolution::Default => None, + Veo3T2vResolution::SevenTwentyP => Some("720p".to_string()), + Veo3T2vResolution::TenEightyP => Some("1080p".to_string()), + }; + + let request = Veo3TextToVideoInput { + prompt: req.prompt, + aspect_ratio, + resolution, + duration, + generate_audio: Some(req.generate_audio), + negative_prompt: req.negative_prompt, + }; + + let result = veo_3_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_veo_3_text_to_video_webhook::{ + enqueue_veo_3_text_to_video_webhook, Veo3TextToVideoArgs, Veo3TextToVideoRequest, + Veo3T2vAspectRatio, Veo3T2vDuration, Veo3T2vResolution, + }; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test_veo_3_text_to_video() -> AnyhowResult<()> { + let secret = read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt")?; + let api_key = FalApiKey::from_str(&secret); + + let args = Veo3TextToVideoArgs { + request: Veo3TextToVideoRequest { + prompt: "a drone shot of a coastal sunset with waves crashing on rocks".to_string(), + negative_prompt: None, + duration: Veo3T2vDuration::EightSeconds, + aspect_ratio: Veo3T2vAspectRatio::WideSixteenNine, + resolution: Veo3T2vResolution::TenEightyP, + generate_audio: true, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let _result = enqueue_veo_3_text_to_video_webhook(args).await?; + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3p1_fast_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3p1_fast_text_to_video_webhook.rs new file mode 100644 index 00000000..1e1b7c56 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3p1_fast_text_to_video_webhook.rs @@ -0,0 +1,157 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_veo_3p1_fast_text_to_video::{veo_3p1_fast_text_to_video, Veo3p1FastTextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueVeo3p1FastTextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueVeo3p1FastTextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueVeo3p1FastTextToVideoRequest { + pub prompt: String, + pub duration: Option, + pub aspect_ratio: Option, + pub resolution: Option, + pub generate_audio: Option, + pub enhance_prompt: Option, + pub negative_prompt: Option, + pub seed: Option, + pub auto_fix: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastTextToVideoDurationSeconds { + Four, + Six, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastTextToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1FastTextToVideoResolution { + SevenTwentyP, + TenEightyP, +} + +impl FalRequestCostCalculator for EnqueueVeo3p1FastTextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.10 (audio off) or + // $0.15 (audio on). + // For example, a 5s video with audio on will cost $0.75." + let duration = self.duration + .unwrap_or(EnqueueVeo3p1FastTextToVideoDurationSeconds::Eight); + + let generate_audio = self.generate_audio.unwrap_or(true); + + match (duration, generate_audio) { + (EnqueueVeo3p1FastTextToVideoDurationSeconds::Four, false) => 40, + (EnqueueVeo3p1FastTextToVideoDurationSeconds::Six, false) => 60, + (EnqueueVeo3p1FastTextToVideoDurationSeconds::Eight, false) => 80, + (EnqueueVeo3p1FastTextToVideoDurationSeconds::Four, true) => 60, + (EnqueueVeo3p1FastTextToVideoDurationSeconds::Six, true) => 90, + (EnqueueVeo3p1FastTextToVideoDurationSeconds::Eight, true) => 120, + } + } +} + + +/// Veo 3.1 Fast Text-to-Video +/// https://fal.ai/models/fal-ai/veo3.1/fast +pub async fn enqueue_veo_3p1_fast_text_to_video_webhook( + args: EnqueueVeo3p1FastTextToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueVeo3p1FastTextToVideoDurationSeconds::Four => "4s", + EnqueueVeo3p1FastTextToVideoDurationSeconds::Six => "6s", + EnqueueVeo3p1FastTextToVideoDurationSeconds::Eight=> "8s", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueueVeo3p1FastTextToVideoAspectRatio::Auto => "auto", + EnqueueVeo3p1FastTextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueVeo3p1FastTextToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueVeo3p1FastTextToVideoResolution::SevenTwentyP => "720p", + EnqueueVeo3p1FastTextToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let request = Veo3p1FastTextToVideoInput { + prompt: req.prompt, + // Optionals + duration, + aspect_ratio, + resolution, + negative_prompt: req.negative_prompt, + generate_audio: req.generate_audio, + enhance_prompt: req.enhance_prompt, + seed: req.seed, + auto_fix: req.auto_fix, + }; + + let result = veo_3p1_fast_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_veo_3p1_fast_text_to_video_webhook::{enqueue_veo_3p1_fast_text_to_video_webhook, EnqueueVeo3p1FastTextToVideoArgs, EnqueueVeo3p1FastTextToVideoRequest, EnqueueVeo3p1FastTextToVideoAspectRatio, EnqueueVeo3p1FastTextToVideoDurationSeconds, EnqueueVeo3p1FastTextToVideoResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueVeo3p1FastTextToVideoArgs { + request: EnqueueVeo3p1FastTextToVideoRequest { + prompt: "An alien space ship hovers over new york city. it looks ominous, ready to attack. suddenly, it drops a bunch of ping pong balls on the city".to_string(), + duration: Some(EnqueueVeo3p1FastTextToVideoDurationSeconds::Eight), + aspect_ratio: Some(EnqueueVeo3p1FastTextToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueVeo3p1FastTextToVideoResolution::TenEightyP), + generate_audio: Some(true), + negative_prompt: None, + enhance_prompt: Some(true), + auto_fix: Some(true), + seed: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3p1_fast_text_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3p1_text_to_video_webhook.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3p1_text_to_video_webhook.rs new file mode 100644 index 00000000..590cc58f --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/enqueue_veo_3p1_text_to_video_webhook.rs @@ -0,0 +1,158 @@ +use crate::creds::fal_api_key::FalApiKey; +use crate::error::classify_fal_error::classify_fal_error; +use crate::error::fal_error_plus::FalErrorPlus; +use crate::requests::traits::fal_request_cost_calculator_trait::{FalRequestCostCalculator, UsdCents}; +use crate::requests_old::http::video::text::http_veo_3p1_text_to_video::{veo_3p1_text_to_video, Veo3p1TextToVideoInput}; +use crate::requests::core_api::webhook_response::WebhookResponse; +use reqwest::IntoUrl; + +pub struct EnqueueVeo3p1TextToVideoArgs<'a, R: IntoUrl> { + pub request: EnqueueVeo3p1TextToVideoRequest, + pub webhook_url: R, + pub api_key: &'a FalApiKey, +} + +#[derive(Clone, Debug)] +pub struct EnqueueVeo3p1TextToVideoRequest { + pub prompt: String, + pub duration: Option, + pub aspect_ratio: Option, + pub resolution: Option, + pub generate_audio: Option, + pub enhance_prompt: Option, + pub negative_prompt: Option, + pub seed: Option, + pub auto_fix: Option, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1TextToVideoDurationSeconds { + Four, + Six, + Eight, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1TextToVideoAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Copy, Clone, Debug)] +pub enum EnqueueVeo3p1TextToVideoResolution { + SevenTwentyP, + TenEightyP, +} + + +impl FalRequestCostCalculator for EnqueueVeo3p1TextToVideoRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + // "For every second of video you generated, you will be charged + // $0.20 (audio off) or + // $0.40 (audio on). + // For example, a 5s video with audio on will cost $2." + let duration = self.duration + .unwrap_or(EnqueueVeo3p1TextToVideoDurationSeconds::Eight); + + let generate_audio = self.generate_audio.unwrap_or(true); + + match (duration, generate_audio) { + (EnqueueVeo3p1TextToVideoDurationSeconds::Four, false) => 80, + (EnqueueVeo3p1TextToVideoDurationSeconds::Six, false) => 120, + (EnqueueVeo3p1TextToVideoDurationSeconds::Eight, false) => 160, + (EnqueueVeo3p1TextToVideoDurationSeconds::Four, true) => 160, + (EnqueueVeo3p1TextToVideoDurationSeconds::Six, true) => 240, + (EnqueueVeo3p1TextToVideoDurationSeconds::Eight, true) => 320, + } + } +} + + +/// Veo 3.1 Text-to-Video +/// https://fal.ai/models/fal-ai/veo3.1 +pub async fn enqueue_veo_3p1_text_to_video_webhook( + args: EnqueueVeo3p1TextToVideoArgs<'_, R> +) -> Result { + let req = args.request; + + let duration = req.duration + .map(|resolution| match resolution { + EnqueueVeo3p1TextToVideoDurationSeconds::Four => "4s", + EnqueueVeo3p1TextToVideoDurationSeconds::Six => "6s", + EnqueueVeo3p1TextToVideoDurationSeconds::Eight=> "8s", + }) + .map(|s| s.to_string()); + + let aspect_ratio = req.aspect_ratio + .map(|aspect_ratio| match aspect_ratio { + EnqueueVeo3p1TextToVideoAspectRatio::Auto => "auto", + EnqueueVeo3p1TextToVideoAspectRatio::SixteenByNine => "16:9", + EnqueueVeo3p1TextToVideoAspectRatio::NineBySixteen => "9:16", + }) + .map(|s| s.to_string()); + + let resolution = req.resolution + .map(|resolution| match resolution { + EnqueueVeo3p1TextToVideoResolution::SevenTwentyP => "720p", + EnqueueVeo3p1TextToVideoResolution::TenEightyP => "1080p", + }) + .map(|s| s.to_string()); + + let request = Veo3p1TextToVideoInput { + prompt: req.prompt, + // Optionals + duration, + aspect_ratio, + resolution, + negative_prompt: req.negative_prompt, + generate_audio: req.generate_audio, + enhance_prompt: req.enhance_prompt, + seed: req.seed, + auto_fix: req.auto_fix, + }; + + let result = veo_3p1_text_to_video(request) + .with_api_key(&args.api_key.0) + .queue_webhook(args.webhook_url) + .await; + + result.map_err(|err| classify_fal_error(err)) +} + +#[cfg(test)] +mod tests { + use crate::creds::fal_api_key::FalApiKey; + use crate::requests_old::webhook::video::text::enqueue_veo_3p1_text_to_video_webhook::{enqueue_veo_3p1_text_to_video_webhook, EnqueueVeo3p1TextToVideoArgs, EnqueueVeo3p1TextToVideoRequest, EnqueueVeo3p1TextToVideoAspectRatio, EnqueueVeo3p1TextToVideoDurationSeconds, EnqueueVeo3p1TextToVideoResolution}; + use errors::AnyhowResult; + use std::fs::read_to_string; + + #[tokio::test] + #[ignore] + async fn test() -> AnyhowResult<()> { + // XXX: Don't commit secrets! + let secret = read_to_string("/home/bt/Artcraft/credentials/fal_api_key.txt")?; + + let api_key = FalApiKey::from_str(&secret); + + let args = EnqueueVeo3p1TextToVideoArgs { + request: EnqueueVeo3p1TextToVideoRequest { + prompt: "An alien space ship hovers over new york city. it looks ominous, ready to attack. suddenly, it drops a bunch of ping pong balls on the city".to_string(), + duration: Some(EnqueueVeo3p1TextToVideoDurationSeconds::Eight), + aspect_ratio: Some(EnqueueVeo3p1TextToVideoAspectRatio::SixteenByNine), + resolution: Some(EnqueueVeo3p1TextToVideoResolution::TenEightyP), + generate_audio: Some(true), + negative_prompt: None, + enhance_prompt: Some(true), + auto_fix: Some(true), + seed: None, + }, + api_key: &api_key, + webhook_url: "https://example.com/webhook", + }; + + let result = enqueue_veo_3p1_text_to_video_webhook(args).await?; + + Ok(()) + } +} diff --git a/crates/api_clients/fal_client/src/requests_old/webhook/video/text/mod.rs b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/mod.rs new file mode 100644 index 00000000..8023ecc7 --- /dev/null +++ b/crates/api_clients/fal_client/src/requests_old/webhook/video/text/mod.rs @@ -0,0 +1,13 @@ +pub mod enqueue_hailuo_v2p3_pro_text_to_video_webhook; +pub mod enqueue_kling_v2p5_turbo_pro_text_to_video_webhook; +pub mod enqueue_kling_v2p6_pro_text_to_video_webhook; +pub mod enqueue_kling_3p0_pro_text_to_video_webhook; +pub mod enqueue_kling_3p0_standard_text_to_video_webhook; +pub mod enqueue_pixverse_v5_text_to_video_webhook; +pub mod enqueue_seedance_1p5_pro_text_to_video_webhook; +pub mod enqueue_sora_2_pro_text_to_video_webhook; +pub mod enqueue_sora_2_text_to_video_webhook; +pub mod enqueue_veo_2_text_to_video_webhook; +pub mod enqueue_veo_3_text_to_video_webhook; +pub mod enqueue_veo_3p1_fast_text_to_video_webhook; +pub mod enqueue_veo_3p1_text_to_video_webhook; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/utils/clone_queue_payload.rs b/crates/api_clients/fal_client/src/utils/clone_queue_payload.rs new file mode 100644 index 00000000..4d9c3eac --- /dev/null +++ b/crates/api_clients/fal_client/src/utils/clone_queue_payload.rs @@ -0,0 +1,8 @@ +use crate::requests::core_api::queue::Queue; +use crate::requests::core_api::queue_response::QueueResponse; +use crate::utils::clone_queue_response::clone_queue_response; +use serde::de::DeserializeOwned; + +pub fn clone_queue_payload(queue: &Queue) -> QueueResponse { + clone_queue_response(&queue.payload) +} diff --git a/crates/api_clients/fal_client/src/utils/clone_queue_response.rs b/crates/api_clients/fal_client/src/utils/clone_queue_response.rs new file mode 100644 index 00000000..1600b7d0 --- /dev/null +++ b/crates/api_clients/fal_client/src/utils/clone_queue_response.rs @@ -0,0 +1,10 @@ +use crate::requests::core_api::queue_response::QueueResponse; + +pub fn clone_queue_response(response: &QueueResponse) -> QueueResponse { + QueueResponse { + request_id: response.request_id.clone(), + response_url: response.response_url.clone(), + status_url: response.status_url.clone(), + cancel_url: response.cancel_url.clone(), + } +} diff --git a/crates/api_clients/fal_client/src/utils/mod.rs b/crates/api_clients/fal_client/src/utils/mod.rs new file mode 100644 index 00000000..18c0af1e --- /dev/null +++ b/crates/api_clients/fal_client/src/utils/mod.rs @@ -0,0 +1,2 @@ +pub mod clone_queue_payload; +pub mod clone_queue_response; \ No newline at end of file diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrate_webhook_contents.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrate_webhook_contents.rs new file mode 100644 index 00000000..b25a58d4 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrate_webhook_contents.rs @@ -0,0 +1,308 @@ +use serde_json::Value; + +use crate::webhook_payload::raw::webhook_error_type::WebhookErrorType; +use crate::webhook_payload::hydrated::hydrated_webhook_contents::{ErrorData, PayloadErrorData, WebhookSuccessData, HydratedWebhookContents}; +use crate::webhook_payload::raw::raw_webhook_payload::{RawWebhookPayload, RawWebhookStatus}; +use crate::webhook_payload::hydrated::success_case_extractors::extract_contents_from_payload; + +/// Parse the inner payload of a FAL webhook into one of three cases. +/// +/// 1. If status is ERROR, parse out the first `detail` entry's `msg` and `type`. +/// 2. If status is OK but there's no payload and there is a `payload_error`, return PayloadError. +/// 3. Otherwise, return Success with the payload. +pub fn hydrate_webhook_contents(webhook: &RawWebhookPayload) -> HydratedWebhookContents { + match webhook.status { + RawWebhookStatus::Error => { + let (message, error_type) = extract_error_first_detail(&webhook.payload); + + HydratedWebhookContents::Error(ErrorData { + message, + error_type, + }) + } + RawWebhookStatus::Ok => { + // Check for `payload_error` case: status=OK but no payload, has payload_error. + if webhook.payload.is_none() { + if let Some(ref payload_error) = webhook.payload_error { + return HydratedWebhookContents::PayloadError(PayloadErrorData { + payload_error: payload_error.clone(), + }); + } + } + + let value = webhook.payload + .clone() + .unwrap_or(Value::Null); + + let extracted_contents = extract_contents_from_payload(&value); + + HydratedWebhookContents::Success(WebhookSuccessData { + payload: value, + extracted_contents, + }) + } + } +} + +/// Extract the first `msg` and `type` from `payload.detail[]`. +fn extract_error_first_detail(payload: &Option) -> (Option, Option) { + let payload = match payload { + Some(p) => p, + None => return (None, None), + }; + + let detail_array = match payload.get("detail").and_then(|v| v.as_array()) { + Some(arr) => arr, + None => return (None, None), + }; + + let first = match detail_array.first() { + Some(item) => item, + None => return (None, None), + }; + + let message = first.get("msg").and_then(|v| v.as_str()).map(|s| s.to_string()); + + let error_type = first + .get("type") + .and_then(|v| v.as_str()) + .map(WebhookErrorType::from_str); + + (message, error_type) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn gpt_image_1p5_content_policy_violation() { + let webhook = load_test_webhook("failure/gpt_image_1p5_fail_content_policy.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::ContentPolicyViolation), + ); + assert_eq!( + data.message.as_deref(), + Some("The content could not be processed because it contained material flagged by a content checker."), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn gpt_image_invalid_api_key() { + let webhook = load_test_webhook("failure/gpt_image_fail_invalid_api_key.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::InvalidApiKey), + ); + assert_eq!( + data.message.as_deref(), + Some("Invalid API key"), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn kling_1p6_pro_file_too_large() { + let webhook = load_test_webhook("failure/kling_1p6_pro_file_too_large_error.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::FileTooLarge), + ); + assert_eq!( + data.message.as_deref(), + Some("File size exceeds the maximum allowed size of 10485760 bytes. Please upload a smaller file."), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn kling_3p0_pro_content_policy_violation() { + let webhook = load_test_webhook("failure/kling_3p0_pro_fail_content_policy.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::ContentPolicyViolation), + ); + assert_eq!( + data.message.as_deref(), + Some("The content could not be processed because it contained material flagged by a content checker."), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn nano_banana_pro_no_media_generated() { + let webhook = load_test_webhook("failure/nano_banana_pro_fail_no_media_generated.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::NoMediaGenerated), + ); + assert!( + data.message.as_deref().unwrap().starts_with("The model did not generate"), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn hunyuan_3d_part_format_not_supported() { + let webhook = load_test_webhook("failure/hunyuan_3d_3p1_part_fail_format_not_supported.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::ValueError), + ); + assert_eq!( + data.message.as_deref(), + Some("Part generation only supports FBX format. Please provide an FBX file or use /convert-format to convert your model to FBX first."), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn triposplat_no_foreground_subject() { + let webhook = load_test_webhook("failure/triposplat_fail_no_foreground_subject.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::InputValueError), + ); + assert_eq!( + data.message.as_deref(), + Some("No foreground subject could be detected in the input image after background removal. Provide an image with a clear, visible subject against a plain or distinct background."), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn payload_error_case() { + let webhook = RawWebhookPayload { + request_id: "test-123".to_string(), + gateway_request_id: "test-123".to_string(), + status: RawWebhookStatus::Ok, + error: None, + payload: None, + payload_error: Some("encoding error occurred".to_string()), + }; + + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::PayloadError(data) => { + assert_eq!(data.payload_error, "encoding error occurred"); + } + other => panic!("Expected HydratedWebhookContents::PayloadError, got {:?}", other), + } + } + + #[test] + fn success_case() { + let webhook = RawWebhookPayload { + request_id: "test-456".to_string(), + gateway_request_id: "test-456".to_string(), + status: RawWebhookStatus::Ok, + error: None, + payload: Some(serde_json::json!({"images": [{"url": "https://example.com/img.png"}]})), + payload_error: None, + }; + + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Success(data) => { + assert!(data.payload.get("images").is_some()); + } + other => panic!("Expected HydratedWebhookContents::Success, got {:?}", other), + } + } + + #[test] + fn seedream_partner_validation_failed() { + let webhook = load_test_webhook("failure/seedream_partner_validation_failed.json"); + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!( + data.error_type, + Some(WebhookErrorType::ContentPolicyViolation), + ); + assert_eq!( + data.message.as_deref(), + Some("The content could not be processed because it contained material flagged by a content checker."), + ); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } + + #[test] + fn error_with_no_payload() { + let webhook = RawWebhookPayload { + request_id: "test-789".to_string(), + gateway_request_id: "test-789".to_string(), + status: RawWebhookStatus::Error, + error: Some("Internal server error".to_string()), + payload: None, + payload_error: None, + }; + + let result = hydrate_webhook_contents(&webhook); + + match result { + HydratedWebhookContents::Error(data) => { + assert_eq!(data.message, None); + assert_eq!(data.error_type, None); + } + other => panic!("Expected HydratedWebhookContents::Error, got {:?}", other), + } + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/hydrated_webhook_contents.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/hydrated_webhook_contents.rs new file mode 100644 index 00000000..8487e683 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/hydrated_webhook_contents.rs @@ -0,0 +1,232 @@ +use serde::Deserialize; +use serde_json::Value; + +use crate::webhook_payload::raw::webhook_error_type::WebhookErrorType; + +/// The parsed inner payload of a FAL webhook. +#[derive(Debug)] +pub enum HydratedWebhookContents { + /// The webhook reported success and has a payload. + Success(WebhookSuccessData), + + /// The webhook reported an error (status=ERROR) with optional detail info. + Error(ErrorData), + + /// The webhook reported as "success" but (1) had no payload and (2) had a payload_error. + /// In rare instances of an "OK" response, there may be an error on Fal's end with encoding + /// the payload. If that happens, the "payload_error" field may be set, and this enum variant + /// represents that failure case. + PayloadError(PayloadErrorData), +} + +#[derive(Debug)] +pub struct WebhookSuccessData { + /// The success data is polymorphic, so we're returning a JSON `Value` for now. + /// This will allow for downstream handlers to parse the payload as needed. + /// This is the entire raw success payload. + pub payload: Value, + + /// If there are any extracted sub-payload contents, such as "images" or "video", + /// then they are included here. This may not be fully inclusive of future + /// payload types. + pub extracted_contents: Option, +} + +#[derive(Debug)] +pub struct ExtractedContents { + /// Parsed from `payload.image` (single image result). + pub image: Option, + + /// Parsed from `payload.images` (batch image results). + pub images: Option>, + + /// Parsed from `payload.video`. + pub video: Option, + + /// Parsed from `payload.audio` (e.g. Seed Audio 1.0 speech results). + pub audio: Option, + + /// Parsed from `payload.model_glb`. + pub model_glb: Option, + + /// Parsed from `payload.model_glb_pbr` (e.g. Hunyuan 3D 2.1's PBR-textured + /// GLB variant, sent alongside `model_glb`). + pub model_glb_pbr: Option, + + /// Parsed from `payload.model_urls` (e.g. Hunyuan 3D 3.0's per-format file + /// map, sent alongside `model_glb`). + pub model_urls: Option, + + /// Parsed from `payload.model_mesh`. + /// NB: `triposplat` ply gaussian splat files also arrive via this payload handler. + /// These are decidedly *not* "mesh" files! + pub model_mesh: Option, + + /// Parsed from `payload.model_obj` (e.g. Hunyuan 3D v3.1 Rapid's OBJ output). + pub model_obj: Option, + + /// Parsed from `payload.result_files` (e.g. Hunyuan 3D v3.1 Part's FBX part files). + pub result_files: Option>, + + /// Parsed from `payload.thumbnail`. + pub thumbnail: Option, + + /// Parsed from `payload.rendered_image` (e.g. Tripo 3D's preview image, + /// used as a cover image like `thumbnail`). + pub rendered_image: Option, + + /// Parsed from `payload.preprocessed_image` (e.g. TripoSplat's segmented + /// input image, usable as a cover image for the splat result). + pub preprocessed_image: Option, +} + +/// Data under `payload.image`: +#[derive(Debug, Deserialize)] +pub struct ImageData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub height: Option, + pub width: Option, +} + +/// Data under `payload.images` (a list of these): +#[derive(Debug, Deserialize)] +pub struct ImagesData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub height: Option, + pub width: Option, +} + +/// Data under `payload.video`: +#[derive(Debug, Deserialize)] +pub struct VideoData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, +} + +/// Data under `payload.audio` (e.g. Seed Audio 1.0): +#[derive(Debug, Deserialize)] +pub struct AudioData { + pub url: Option, + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub bitrate: Option, + pub channels: Option, + /// Duration in seconds. + pub duration: Option, + pub sample_rate: Option, +} + +/// Data under `payload.model_glb` (there may be other sibling keys too). +/// Also used for `payload.model_glb_pbr`, which has the same shape. +#[derive(Debug, Deserialize)] +pub struct ModelGlbData { + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub url: Option, +} + +/// Data under `payload.model_mesh` (there may be other sibling keys too) +/// NB: `triposplat` ply gaussian splat files also arrive via this payload. +/// These are decidedly *not* "mesh" files! +#[derive(Debug, Deserialize)] +pub struct ModelMeshData { + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub url: Option, +} + +/// Data under `payload.model_urls` (e.g. Hunyuan 3D 3.0 / 3.1, Tripo 3D): a +/// map of the generation's output files by format. Any slot may be null or +/// absent. The `glb` entry frequently duplicates the top-level model key +/// (same URL), but may point to a different file. Slots may also duplicate +/// each other's URLs (e.g. Tripo 3D's `glb` and `pbr_model`). +#[derive(Debug, Deserialize)] +pub struct ModelUrlsData { + /// Untextured base model (Tripo 3D). + pub base_model: Option, + /// Blender project file (Meshy). + pub blend: Option, + pub fbx: Option, + pub glb: Option, + /// OBJ material file (Hunyuan 3D 3.1). + pub mtl: Option, + pub obj: Option, + /// PBR-textured model (Tripo 3D). + pub pbr_model: Option, + /// STL model (Meshy). + pub stl: Option, + /// PBR texture image for the OBJ (Hunyuan 3D 3.1). + pub texture: Option, + pub usdz: Option, +} + +/// Data under `payload.model_obj` (there may be other sibling keys too). +/// Some endpoints (e.g. Hunyuan 3D v3.1 Rapid text-to-3d) return an OBJ +/// model instead of (or alongside) a GLB. +#[derive(Debug, Deserialize)] +pub struct ModelObjData { + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub url: Option, +} + +/// An entry under `payload.result_files` (a list of these). +/// Used by endpoints returning multiple output files, e.g. Hunyuan 3D v3.1 +/// Part's per-part FBX files. +#[derive(Debug, Deserialize)] +pub struct ResultFileData { + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub url: Option, +} + +/// Data under `payload.thumbnail` (there may be other sibling keys too) +/// Frequently seen together with `model_glb`. +/// Also used for `payload.rendered_image` (Tripo 3D), which has the same shape. +#[derive(Debug, Deserialize)] +pub struct ThumbnailData { + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub url: Option, +} + +/// Data under `payload.preprocessed_image` (there may be other sibling keys too). +/// Seen together with `model_mesh` in TripoSplat results: the segmented input +/// image, which we use as a cover image for the splat. +#[derive(Debug, Deserialize)] +pub struct PreprocessedImageData { + pub content_type: Option, + pub file_name: Option, + pub file_size: Option, + pub height: Option, + pub url: Option, + pub width: Option, +} + +#[derive(Debug)] +pub struct ErrorData { + /// The first human-readable message from `payload.detail[].msg`, if any. + pub message: Option, + + /// The first machine-readable error type from `payload.detail[].type`, if any. + pub error_type: Option, +} + +#[derive(Debug)] +pub struct PayloadErrorData { + pub payload_error: String, +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/mod.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/mod.rs new file mode 100644 index 00000000..0a599d4a --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/mod.rs @@ -0,0 +1,2 @@ +pub mod hydrated_webhook_contents; +pub mod success_case_extractors; diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_audio_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_audio_payload.rs new file mode 100644 index 00000000..b965a9a2 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_audio_payload.rs @@ -0,0 +1,103 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::AudioData; + +/// Extract and deserialize the `audio` key from a webhook success payload +/// (e.g. Seed Audio 1.0 speech results). +pub(crate) fn extract_audio(obj: &Map) -> Option { + let value = obj.get("audio")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn audio_from_seed_audio_1p0_test_file() { + let webhook = load_test_webhook("success/seed_audio_1p0_audio_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let audio = contents.audio.expect("audio should be Some"); + assert_eq!(audio.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bc36/vOSCcxsbibkZIiXR9BIZn_speech.mp3")); + assert_eq!(audio.content_type.as_deref(), Some("audio/mpeg")); + assert_eq!(audio.file_name.as_deref(), Some("speech.mp3")); + assert_eq!(audio.file_size, Some(53612)); + assert_eq!(audio.duration, Some(6.63995)); + assert_eq!(audio.sample_rate, Some(24000)); + assert!(audio.bitrate.is_none()); + assert!(audio.channels.is_none()); + + // No other content types in this payload. + assert!(contents.image.is_none()); + assert!(contents.images.is_none()); + assert!(contents.video.is_none()); + assert!(contents.model_glb.is_none()); + assert!(contents.thumbnail.is_none()); + } + + #[test] + fn synthetic_audio_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "audio": { + "url": "https://cdn.example.com/speech.mp3", + "content_type": "audio/mpeg", + "file_name": "speech.mp3", + "file_size": 12345, + "bitrate": 128000, + "channels": 2, + "duration": 3.5, + "sample_rate": 44100 + } + }"#).unwrap(); + + let audio = extract_audio(&obj).expect("should extract audio"); + assert_eq!(audio.url.as_deref(), Some("https://cdn.example.com/speech.mp3")); + assert_eq!(audio.content_type.as_deref(), Some("audio/mpeg")); + assert_eq!(audio.file_name.as_deref(), Some("speech.mp3")); + assert_eq!(audio.file_size, Some(12345)); + assert_eq!(audio.bitrate, Some(128000)); + assert_eq!(audio.channels, Some(2)); + assert_eq!(audio.duration, Some(3.5)); + assert_eq!(audio.sample_rate, Some(44100)); + } + + #[test] + fn audio_url_only() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "audio": {"url": "https://cdn.example.com/speech.wav"} + }"#).unwrap(); + + let audio = extract_audio(&obj).expect("should extract audio"); + assert_eq!(audio.url.as_deref(), Some("https://cdn.example.com/speech.wav")); + assert!(audio.content_type.is_none()); + assert!(audio.duration.is_none()); + } + + #[test] + fn missing_audio_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "video": {"url": "https://example.com/video.mp4"} + }"#).unwrap(); + + assert!(extract_audio(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_image_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_image_payload.rs new file mode 100644 index 00000000..53fe92f4 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_image_payload.rs @@ -0,0 +1,100 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ImageData; + +/// Extract and deserialize the `image` key from a webhook success payload. +pub (crate) fn extract_image(obj: &Map) -> Option { + let value = obj.get("image")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::{RawWebhookPayload, RawWebhookStatus}; + + #[test] + fn payload_without_known_keys_has_none_extracted_contents() { + let webhook = RawWebhookPayload { + request_id: "test-no-keys".to_string(), + gateway_request_id: "test-no-keys".to_string(), + status: RawWebhookStatus::Ok, + error: None, + payload: Some(serde_json::json!({"some_other_key": "value"})), + payload_error: None, + }; + + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + assert!(data.extracted_contents.is_none()); + } + + #[test] + fn null_payload_has_none_extracted_contents() { + let webhook = RawWebhookPayload { + request_id: "test-null".to_string(), + gateway_request_id: "test-null".to_string(), + status: RawWebhookStatus::Ok, + error: None, + payload: None, + payload_error: None, + }; + + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + assert!(data.extracted_contents.is_none()); + } + + #[test] + fn synthetic_image_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "image": { + "url": "https://cdn.example.com/single.png", + "content_type": "image/png", + "file_name": "single.png", + "file_size": 98765, + "width": 512, + "height": 512 + } + }"#).unwrap(); + + let image = extract_image(&obj).expect("should extract image"); + assert_eq!(image.url.as_deref(), Some("https://cdn.example.com/single.png")); + assert_eq!(image.content_type.as_deref(), Some("image/png")); + assert_eq!(image.file_name.as_deref(), Some("single.png")); + assert_eq!(image.file_size, Some(98765)); + assert_eq!(image.width, Some(512)); + assert_eq!(image.height, Some(512)); + } + + #[test] + fn synthetic_image_url_only() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "image": {"url": "https://cdn.example.com/img.jpg"} + }"#).unwrap(); + + let image = extract_image(&obj).expect("should extract image"); + assert_eq!(image.url.as_deref(), Some("https://cdn.example.com/img.jpg")); + assert!(image.content_type.is_none()); + assert!(image.file_size.is_none()); + } + + #[test] + fn missing_image_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "images": [{"url": "https://example.com/img.png"}] + }"#).unwrap(); + + assert!(extract_image(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_images_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_images_payload.rs new file mode 100644 index 00000000..393fdc92 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_images_payload.rs @@ -0,0 +1,96 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ImagesData; + +/// Extract and deserialize the `images` key from a webhook success payload. +pub (crate) fn extract_images(obj: &Map) -> Option> { + let value = obj.get("images")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn images_payload_from_test_file() { + let webhook = load_test_webhook("success/images_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let images = contents.images.expect("images should be Some"); + assert_eq!(images.len(), 2); + + assert_eq!(images[0].url.as_deref(), Some("https://v3b.fal.media/files/b/01234567/name1.png")); + assert_eq!(images[0].content_type.as_deref(), Some("image/png")); + assert_eq!(images[0].file_name.as_deref(), Some("name1.png")); + assert_eq!(images[0].file_size, Some(11500002)); + + assert_eq!(images[1].url.as_deref(), Some("https://v3b.fal.media/files/b/01234567/name2.png")); + assert_eq!(images[1].file_size, Some(13499999)); + + assert!(contents.image.is_none()); + assert!(contents.video.is_none()); + assert!(contents.model_glb.is_none()); + assert!(contents.model_mesh.is_none()); + } + + #[test] + fn synthetic_images_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "images": [ + {"url": "https://example.com/a.png", "content_type": "image/png", "width": 1024, "height": 768}, + {"url": "https://example.com/b.jpg", "content_type": "image/jpeg", "file_size": 54321} + ] + }"#).unwrap(); + + let images = extract_images(&obj).expect("should extract images"); + assert_eq!(images.len(), 2); + + assert_eq!(images[0].url.as_deref(), Some("https://example.com/a.png")); + assert_eq!(images[0].width, Some(1024)); + assert_eq!(images[0].height, Some(768)); + assert!(images[0].file_size.is_none()); + + assert_eq!(images[1].url.as_deref(), Some("https://example.com/b.jpg")); + assert_eq!(images[1].content_type.as_deref(), Some("image/jpeg")); + assert_eq!(images[1].file_size, Some(54321)); + assert!(images[1].width.is_none()); + } + + #[test] + fn empty_images_array_returns_empty_vec() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "images": [] + }"#).unwrap(); + + let images = extract_images(&obj).expect("should extract empty images"); + assert!(images.is_empty()); + } + + #[test] + fn missing_images_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "video": {"url": "https://example.com/v.mp4"} + }"#).unwrap(); + + assert!(extract_images(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_glb_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_glb_payload.rs new file mode 100644 index 00000000..2eeaf3e3 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_glb_payload.rs @@ -0,0 +1,91 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ModelGlbData; + +/// Extract and deserialize the `model_glb` key from a webhook success payload. +pub (crate) fn extract_model_glb(obj: &Map) -> Option { + let value = obj.get("model_glb")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn model_glb_from_test_file() { + let webhook = load_test_webhook("success/model_glb_urls_and_thumbnail_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let glb = contents.model_glb.expect("model_glb should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0a95eb37/f7UaAhyfcx0BAnYy0GpFM_model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("model.glb")); + assert_eq!(glb.file_size, Some(66284788)); + + // This payload also has a thumbnail. + assert!(contents.thumbnail.is_some()); + + // No image/images/video/mesh in this payload. + assert!(contents.image.is_none()); + assert!(contents.images.is_none()); + assert!(contents.video.is_none()); + assert!(contents.model_mesh.is_none()); + } + + #[test] + fn synthetic_model_glb_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb": { + "url": "https://cdn.example.com/model.glb", + "content_type": "model/gltf-binary", + "file_name": "output.glb", + "file_size": 5432100 + } + }"#).unwrap(); + + let glb = extract_model_glb(&obj).expect("should extract model_glb"); + assert_eq!(glb.url.as_deref(), Some("https://cdn.example.com/model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("output.glb")); + assert_eq!(glb.file_size, Some(5432100)); + } + + #[test] + fn model_glb_url_only() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb": {"url": "https://cdn.example.com/m.glb"} + }"#).unwrap(); + + let glb = extract_model_glb(&obj).expect("should extract model_glb"); + assert_eq!(glb.url.as_deref(), Some("https://cdn.example.com/m.glb")); + assert!(glb.content_type.is_none()); + } + + #[test] + fn missing_model_glb_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "video": {"url": "https://example.com/v.mp4"} + }"#).unwrap(); + + assert!(extract_model_glb(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_glb_pbr_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_glb_pbr_payload.rs new file mode 100644 index 00000000..83a48470 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_glb_pbr_payload.rs @@ -0,0 +1,87 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ModelGlbData; + +/// Extract and deserialize the `model_glb_pbr` key from a webhook success +/// payload. Sent alongside `model_glb` by e.g. Hunyuan 3D 2.1; same shape. +pub(crate) fn extract_model_glb_pbr(obj: &Map) -> Option { + let value = obj.get("model_glb_pbr")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn model_glbs_from_hunyuan_3d_2p1_test_file() { + let webhook = load_test_webhook("success/hunyuan_3d_2p1_model_glbs_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let glb = contents.model_glb.expect("model_glb should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b916/QKdBTd8WJW_rtPB3IwlEN_demo_textured.glb")); + assert_eq!(glb.content_type.as_deref(), Some("application/octet-stream")); + assert_eq!(glb.file_name.as_deref(), Some("demo_textured.glb")); + assert_eq!(glb.file_size, Some(1574216)); + + let glb_pbr = contents.model_glb_pbr.expect("model_glb_pbr should be Some"); + assert_eq!(glb_pbr.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b921/SJw7AARzkc4l9QG5Lrvmu_demo_textured_pbr.glb")); + assert_eq!(glb_pbr.content_type.as_deref(), Some("application/octet-stream")); + assert_eq!(glb_pbr.file_name.as_deref(), Some("demo_textured_pbr.glb")); + assert_eq!(glb_pbr.file_size, Some(7512760)); + + // The payload also carries a `model_mesh` zip archive of the whole + // generation. It parses out, but the webhook handler prefers the GLBs. + let mesh = contents.model_mesh.expect("model_mesh should be Some"); + assert_eq!(mesh.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b915/B25DrTdiZJNV-60RaUh4u_3d_model.zip")); + assert_eq!(mesh.file_name.as_deref(), Some("3d_model.zip")); + + assert!(contents.thumbnail.is_none()); + assert!(contents.preprocessed_image.is_none()); + } + + #[test] + fn synthetic_model_glb_pbr_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb_pbr": { + "url": "https://cdn.example.com/model_pbr.glb", + "content_type": "model/gltf-binary", + "file_name": "model_pbr.glb", + "file_size": 7654321 + } + }"#).unwrap(); + + let glb_pbr = extract_model_glb_pbr(&obj).expect("should extract model_glb_pbr"); + assert_eq!(glb_pbr.url.as_deref(), Some("https://cdn.example.com/model_pbr.glb")); + assert_eq!(glb_pbr.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb_pbr.file_name.as_deref(), Some("model_pbr.glb")); + assert_eq!(glb_pbr.file_size, Some(7654321)); + } + + #[test] + fn missing_model_glb_pbr_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb": {"url": "https://example.com/model.glb"} + }"#).unwrap(); + + assert!(extract_model_glb_pbr(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_mesh_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_mesh_payload.rs new file mode 100644 index 00000000..d8e1f5c2 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_mesh_payload.rs @@ -0,0 +1,116 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ModelMeshData; + +/// Extract and deserialize the `model_mesh` key from a webhook success payload. +pub (crate) fn extract_model_mesh(obj: &Map) -> Option { + let value = obj.get("model_mesh")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn model_mesh_from_test_file() { + let webhook = load_test_webhook("success/model_mesh_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let mesh = contents.model_mesh.expect("model_mesh should be Some"); + assert_eq!(mesh.url.as_deref(), Some("https://v3b.fal.media/files/b/0a95eb2d/XCpH7fk-tZVXr1XMUr7DY_mesh-1775972273-765284.glb")); + assert_eq!(mesh.content_type.as_deref(), Some("application/octet-stream")); + assert_eq!(mesh.file_name.as_deref(), Some("mesh-1775972273-765284.glb")); + assert_eq!(mesh.file_size, Some(3886928)); + + // No other content types in this payload. + assert!(contents.image.is_none()); + assert!(contents.images.is_none()); + assert!(contents.video.is_none()); + assert!(contents.model_glb.is_none()); + assert!(contents.thumbnail.is_none()); + } + + #[test] + fn triposplat_ply_splat_from_test_file() { + // TripoSplat sends its PLY gaussian splat under `model_mesh`. + let webhook = load_test_webhook("success/triposplat_splat_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let mesh = contents.model_mesh.expect("model_mesh should be Some"); + assert_eq!(mesh.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b77c/hEzg5xn9A-1qrLsnywjN4_output.ply")); + assert_eq!(mesh.content_type.as_deref(), Some("application/octet-stream")); + assert_eq!(mesh.file_name.as_deref(), Some("output.ply")); + assert_eq!(mesh.file_size, Some(17826208)); + + // The segmented input image rides along as `preprocessed_image`. + assert!(contents.preprocessed_image.is_some()); + + assert!(contents.model_glb.is_none()); + assert!(contents.model_glb_pbr.is_none()); + assert!(contents.thumbnail.is_none()); + } + + #[test] + fn synthetic_model_mesh_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_mesh": { + "url": "https://cdn.example.com/mesh.obj", + "content_type": "model/obj", + "file_name": "output.obj", + "file_size": 1234567 + } + }"#).unwrap(); + + let mesh = extract_model_mesh(&obj).expect("should extract model_mesh"); + assert_eq!(mesh.url.as_deref(), Some("https://cdn.example.com/mesh.obj")); + assert_eq!(mesh.content_type.as_deref(), Some("model/obj")); + assert_eq!(mesh.file_name.as_deref(), Some("output.obj")); + assert_eq!(mesh.file_size, Some(1234567)); + } + + #[test] + fn model_mesh_url_only() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_mesh": {"url": "https://cdn.example.com/m.obj"} + }"#).unwrap(); + + let mesh = extract_model_mesh(&obj).expect("should extract model_mesh"); + assert_eq!(mesh.url.as_deref(), Some("https://cdn.example.com/m.obj")); + assert!(mesh.content_type.is_none()); + } + + #[test] + fn missing_model_mesh_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "image": {"url": "https://example.com/img.png"} + }"#).unwrap(); + + assert!(extract_model_mesh(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_obj_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_obj_payload.rs new file mode 100644 index 00000000..c60ba552 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_obj_payload.rs @@ -0,0 +1,52 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ModelObjData; + +/// Extract and deserialize the `model_obj` key from a webhook success payload. +pub (crate) fn extract_model_obj(obj: &Map) -> Option { + let value = obj.get("model_obj")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn synthetic_model_obj_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_obj": { + "url": "https://cdn.example.com/model.obj", + "content_type": "model/obj", + "file_name": "model.obj", + "file_size": 654321 + } + }"#).unwrap(); + + let model_obj = extract_model_obj(&obj).expect("should extract model_obj"); + assert_eq!(model_obj.url.as_deref(), Some("https://cdn.example.com/model.obj")); + assert_eq!(model_obj.content_type.as_deref(), Some("model/obj")); + assert_eq!(model_obj.file_name.as_deref(), Some("model.obj")); + assert_eq!(model_obj.file_size, Some(654321)); + } + + #[test] + fn model_obj_url_only() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_obj": {"url": "https://cdn.example.com/m.obj"} + }"#).unwrap(); + + let model_obj = extract_model_obj(&obj).expect("should extract model_obj"); + assert_eq!(model_obj.url.as_deref(), Some("https://cdn.example.com/m.obj")); + assert!(model_obj.content_type.is_none()); + } + + #[test] + fn missing_model_obj_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_mesh": {"url": "https://example.com/mesh.glb"} + }"#).unwrap(); + + assert!(extract_model_obj(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_urls_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_urls_payload.rs new file mode 100644 index 00000000..cb5c63b4 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_model_urls_payload.rs @@ -0,0 +1,327 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ModelUrlsData; + +/// Extract and deserialize the `model_urls` key from a webhook success +/// payload (e.g. Hunyuan 3D 3.0's per-format file map). +pub(crate) fn extract_model_urls(obj: &Map) -> Option { + let value = obj.get("model_urls")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn model_urls_from_hunyuan_3d_3p0_test_file() { + let webhook = load_test_webhook("success/hunyuan_3d_3p0_model_urls_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let glb = contents.model_glb.expect("model_glb should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b969/k5FZWmTsKxHH71404bBR__model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("model.glb")); + assert_eq!(glb.file_size, Some(51001160)); + + let model_urls = contents.model_urls.expect("model_urls should be Some"); + + // The `glb` slot duplicates `model_glb` in this payload (same URL). + let urls_glb = model_urls.glb.expect("model_urls.glb should be Some"); + assert_eq!(urls_glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b969/k5FZWmTsKxHH71404bBR__model.glb")); + + let urls_obj = model_urls.obj.expect("model_urls.obj should be Some"); + assert_eq!(urls_obj.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b968/xngvKxLugXUlNh89Fp0K4_model.obj")); + assert_eq!(urls_obj.content_type.as_deref(), Some("text/plain")); + assert_eq!(urls_obj.file_name.as_deref(), Some("model.obj")); + assert_eq!(urls_obj.file_size, Some(41107268)); + + assert!(model_urls.fbx.is_none()); + assert!(model_urls.mtl.is_none()); + assert!(model_urls.texture.is_none()); + assert!(model_urls.usdz.is_none()); + + let thumbnail = contents.thumbnail.expect("thumbnail should be Some"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b969/EPgha8Kee7YZCAccjFUU7_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(136476)); + + assert!(contents.model_glb_pbr.is_none()); + assert!(contents.model_mesh.is_none()); + assert!(contents.preprocessed_image.is_none()); + } + + #[test] + fn model_urls_and_thumbnail_from_hunyuan_3d_3p1_test_file() { + let webhook = load_test_webhook("success/hunyuan_3d_3p1_model_urls_thumbnail_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let glb = contents.model_glb.expect("model_glb should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1ba44/OdgIv8M9EkaBP_Mh4TVAB_model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("model.glb")); + assert_eq!(glb.file_size, Some(64261364)); + + let model_urls = contents.model_urls.expect("model_urls should be Some"); + + // The `glb` slot duplicates `model_glb` in this payload (same URL). + let urls_glb = model_urls.glb.expect("model_urls.glb should be Some"); + assert_eq!(urls_glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1ba44/OdgIv8M9EkaBP_Mh4TVAB_model.glb")); + + let urls_obj = model_urls.obj.expect("model_urls.obj should be Some"); + assert_eq!(urls_obj.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1ba43/WxPMNbzsDxaGRCmGNgNAL_c3a871e997ecd5f889bf671630de23b4.obj")); + assert_eq!(urls_obj.content_type.as_deref(), Some("model/obj")); + assert_eq!(urls_obj.file_size, Some(34563830)); + + // 3.1 additionally ships the OBJ's material and PBR texture files. + let urls_mtl = model_urls.mtl.expect("model_urls.mtl should be Some"); + assert_eq!(urls_mtl.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1ba42/1T5VCp_xD0zCJlTLE96iK_material.mtl")); + assert_eq!(urls_mtl.content_type.as_deref(), Some("text/plain")); + assert_eq!(urls_mtl.file_name.as_deref(), Some("material.mtl")); + assert_eq!(urls_mtl.file_size, Some(245)); + + let urls_texture = model_urls.texture.expect("model_urls.texture should be Some"); + assert_eq!(urls_texture.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1ba43/aKp3mMB9nrhlKfV2KVf0S_texture_pbr_20250901.png")); + assert_eq!(urls_texture.content_type.as_deref(), Some("image/png")); + assert_eq!(urls_texture.file_name.as_deref(), Some("texture_pbr_20250901.png")); + assert_eq!(urls_texture.file_size, Some(22794575)); + + assert!(model_urls.fbx.is_none()); + assert!(model_urls.usdz.is_none()); + + // The thumbnail is attached to the GLB as its cover image downstream. + let thumbnail = contents.thumbnail.expect("thumbnail should be Some"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1ba44/njq8zYhYahJNNQkGGiEZW_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(141254)); + + assert!(contents.model_glb_pbr.is_none()); + assert!(contents.model_mesh.is_none()); + assert!(contents.preprocessed_image.is_none()); + } + + #[test] + fn obj_and_thumbnail_from_hunyuan_3d_3p1_rapid_test_file() { + let webhook = load_test_webhook("success/hunyuan_3d_3p1_rapid_obj_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + // NB: Hunyuan 3D 3.1 Rapid puts an OBJ under the `model_glb` key. The + // key name doesn't matter downstream: the webhook handler resolves the + // real file type from content_type / file name, so it uploads as an OBJ + // mesh. + let glb = contents.model_glb.expect("model_glb should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bae3/22zStkYp8-q6npG9dsMs5_23dce35fc95b34722f15a7329061d5df.obj")); + assert_eq!(glb.content_type.as_deref(), Some("model/obj")); + assert_eq!(glb.file_name.as_deref(), Some("23dce35fc95b34722f15a7329061d5df.obj")); + assert_eq!(glb.file_size, Some(3258750)); + + let model_urls = contents.model_urls.expect("model_urls should be Some"); + + // The `glb` slot is null here; `obj` duplicates `model_glb` (same URL). + assert!(model_urls.glb.is_none()); + assert!(model_urls.fbx.is_none()); + assert!(model_urls.usdz.is_none()); + + let urls_obj = model_urls.obj.expect("model_urls.obj should be Some"); + assert_eq!(urls_obj.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bae3/22zStkYp8-q6npG9dsMs5_23dce35fc95b34722f15a7329061d5df.obj")); + assert_eq!(urls_obj.content_type.as_deref(), Some("model/obj")); + assert_eq!(urls_obj.file_size, Some(3258750)); + + let urls_mtl = model_urls.mtl.expect("model_urls.mtl should be Some"); + assert_eq!(urls_mtl.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bae3/5cbE-q28i44GUOO6YeZPH_material.mtl")); + assert_eq!(urls_mtl.file_size, Some(229)); + + let urls_texture = model_urls.texture.expect("model_urls.texture should be Some"); + assert_eq!(urls_texture.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bae3/7eBRddTHf6U8SUg2QOIHw_texture_pbr_v128.png")); + assert_eq!(urls_texture.file_name.as_deref(), Some("texture_pbr_v128.png")); + assert_eq!(urls_texture.file_size, Some(5503289)); + + // The thumbnail is attached to the mesh as its cover image downstream. + let thumbnail = contents.thumbnail.expect("thumbnail should be Some"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bae3/IO3aspD4ijEadoFxSF504_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(120530)); + + assert!(contents.model_glb_pbr.is_none()); + assert!(contents.model_mesh.is_none()); + assert!(contents.model_obj.is_none()); + assert!(contents.preprocessed_image.is_none()); + } + + #[test] + fn model_urls_and_rendered_image_from_tripo3d_test_file() { + let webhook = load_test_webhook("success/tripo3d_model_urls_rendered_image_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + // Tripo 3D sends its GLB under `model_mesh` (not `model_glb`); the + // webhook handler picks `model_urls.glb` as the primary GLB instead. + assert!(contents.model_glb.is_none()); + let mesh = contents.model_mesh.expect("model_mesh should be Some"); + assert_eq!(mesh.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbdb/d8ATWvvXYHY-8zj-lQecf_model.glb")); + assert_eq!(mesh.content_type.as_deref(), Some("model/gltf-binary")); + + let model_urls = contents.model_urls.expect("model_urls should be Some"); + + // `glb` and `pbr_model` duplicate each other (same URL) in this payload; + // the webhook handler dedupes by URL and uploads the file only once. + let urls_glb = model_urls.glb.expect("model_urls.glb should be Some"); + assert_eq!(urls_glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbdb/d8ATWvvXYHY-8zj-lQecf_model.glb")); + assert_eq!(urls_glb.file_size, Some(43981280)); + + let urls_pbr_model = model_urls.pbr_model.expect("model_urls.pbr_model should be Some"); + assert_eq!(urls_pbr_model.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbdb/d8ATWvvXYHY-8zj-lQecf_model.glb")); + + assert!(model_urls.base_model.is_none()); + assert!(model_urls.fbx.is_none()); + assert!(model_urls.mtl.is_none()); + assert!(model_urls.obj.is_none()); + assert!(model_urls.texture.is_none()); + assert!(model_urls.usdz.is_none()); + + // The preview arrives as `rendered_image` (no `thumbnail` key) and is + // attached to the mesh as its cover image downstream. + let rendered_image = contents.rendered_image.expect("rendered_image should be Some"); + assert_eq!(rendered_image.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbd0/MblV2S5R6CeskRABMS7-V_preview.png")); + assert!(contents.thumbnail.is_none()); + + assert!(contents.model_glb_pbr.is_none()); + assert!(contents.preprocessed_image.is_none()); + } + + #[test] + fn model_urls_and_thumbnail_from_meshy_test_file() { + let webhook = load_test_webhook("success/meshy_model_urls_thumbnail_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let glb = contents.model_glb.expect("model_glb should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbe1/0vrf9NUhVxKZO4GScA0EI_model.glb")); + assert_eq!(glb.content_type.as_deref(), Some("model/gltf-binary")); + assert_eq!(glb.file_name.as_deref(), Some("model.glb")); + assert_eq!(glb.file_size, Some(15943768)); + + let model_urls = contents.model_urls.expect("model_urls should be Some"); + + // The `glb` slot duplicates `model_glb` (same URL); the webhook handler + // dedupes by URL so the file uploads only once. + let urls_glb = model_urls.glb.expect("model_urls.glb should be Some"); + assert_eq!(urls_glb.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbe1/0vrf9NUhVxKZO4GScA0EI_model.glb")); + + // Alternate formats of the same model; parsed but not uploaded. + let urls_fbx = model_urls.fbx.expect("model_urls.fbx should be Some"); + assert_eq!(urls_fbx.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbed/yKO-HOjBnWA-LZpRLHHSB_model.fbx")); + assert_eq!(urls_fbx.file_size, Some(13665964)); + + let urls_obj = model_urls.obj.expect("model_urls.obj should be Some"); + assert_eq!(urls_obj.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbe2/NBmqIWBS8LuY_BPYWkOOf_model.obj")); + + let urls_stl = model_urls.stl.expect("model_urls.stl should be Some"); + assert_eq!(urls_stl.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbe2/3wtOE6iEeVHZFvwAGN6Rl_model.stl")); + assert_eq!(urls_stl.content_type.as_deref(), Some("application/octet-stream")); + assert_eq!(urls_stl.file_size, Some(1508384)); + + let urls_usdz = model_urls.usdz.expect("model_urls.usdz should be Some"); + assert_eq!(urls_usdz.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbed/BsniPBo6Uev85V4hLFACR_model.usdz")); + assert_eq!(urls_usdz.content_type.as_deref(), Some("model/vnd.usdz+zip")); + + assert!(model_urls.base_model.is_none()); + assert!(model_urls.blend.is_none()); + assert!(model_urls.mtl.is_none()); + assert!(model_urls.pbr_model.is_none()); + assert!(model_urls.texture.is_none()); + + // The thumbnail is attached to the GLB as its cover image downstream. + let thumbnail = contents.thumbnail.expect("thumbnail should be Some"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbe3/tn1qfOr12oGXecA4mRtlI_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(192910)); + + assert!(contents.model_glb_pbr.is_none()); + assert!(contents.model_mesh.is_none()); + assert!(contents.rendered_image.is_none()); + assert!(contents.preprocessed_image.is_none()); + } + + #[test] + fn synthetic_model_urls_payload_with_distinct_glb() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_urls": { + "fbx": null, + "glb": { + "url": "https://cdn.example.com/model_alt.glb", + "content_type": "model/gltf-binary", + "file_name": "model_alt.glb", + "file_size": 1234567 + }, + "obj": null, + "usdz": null + } + }"#).unwrap(); + + let model_urls = extract_model_urls(&obj).expect("should extract model_urls"); + let glb = model_urls.glb.expect("glb slot should be Some"); + assert_eq!(glb.url.as_deref(), Some("https://cdn.example.com/model_alt.glb")); + assert_eq!(glb.file_size, Some(1234567)); + assert!(model_urls.fbx.is_none()); + assert!(model_urls.obj.is_none()); + assert!(model_urls.usdz.is_none()); + } + + #[test] + fn missing_model_urls_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb": {"url": "https://example.com/model.glb"} + }"#).unwrap(); + + assert!(extract_model_urls(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_preprocessed_image_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_preprocessed_image_payload.rs new file mode 100644 index 00000000..bffba985 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_preprocessed_image_payload.rs @@ -0,0 +1,84 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::PreprocessedImageData; + +/// Extract and deserialize the `preprocessed_image` key from a webhook success payload. +pub(crate) fn extract_preprocessed_image(obj: &Map) -> Option { + let value = obj.get("preprocessed_image")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn preprocessed_image_from_triposplat_test_file() { + let webhook = load_test_webhook("success/triposplat_splat_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let image = contents.preprocessed_image.expect("preprocessed_image should be Some"); + assert_eq!(image.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b77c/YyJ19g7lJsRNXmvZvahTE_61fc73dbe84446b08b1fcce2167b71d5.png")); + assert_eq!(image.content_type.as_deref(), Some("image/png")); + assert_eq!(image.file_name.as_deref(), Some("61fc73dbe84446b08b1fcce2167b71d5.png")); + assert_eq!(image.file_size, Some(952754)); + assert_eq!(image.width, Some(1024)); + assert_eq!(image.height, Some(1024)); + + // The splat itself arrives under `model_mesh`. + let mesh = contents.model_mesh.expect("model_mesh should be Some"); + assert_eq!(mesh.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1b77c/hEzg5xn9A-1qrLsnywjN4_output.ply")); + assert_eq!(mesh.content_type.as_deref(), Some("application/octet-stream")); + assert_eq!(mesh.file_name.as_deref(), Some("output.ply")); + assert_eq!(mesh.file_size, Some(17826208)); + } + + #[test] + fn synthetic_preprocessed_image_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "preprocessed_image": { + "url": "https://cdn.example.com/segmented.png", + "content_type": "image/png", + "file_name": "segmented.png", + "file_size": 12345, + "width": 1024, + "height": 1024 + } + }"#).unwrap(); + + let image = extract_preprocessed_image(&obj).expect("should extract preprocessed_image"); + assert_eq!(image.url.as_deref(), Some("https://cdn.example.com/segmented.png")); + assert_eq!(image.content_type.as_deref(), Some("image/png")); + assert_eq!(image.file_name.as_deref(), Some("segmented.png")); + assert_eq!(image.file_size, Some(12345)); + assert_eq!(image.width, Some(1024)); + assert_eq!(image.height, Some(1024)); + } + + #[test] + fn missing_preprocessed_image_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_mesh": {"url": "https://example.com/output.ply"} + }"#).unwrap(); + + assert!(extract_preprocessed_image(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_rendered_image_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_rendered_image_payload.rs new file mode 100644 index 00000000..a2ab444d --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_rendered_image_payload.rs @@ -0,0 +1,76 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ThumbnailData; + +/// Extract and deserialize the `rendered_image` key from a webhook success +/// payload (e.g. Tripo 3D's preview image). Same shape as `thumbnail`, and +/// used the same way: as a cover image for the model. +pub(crate) fn extract_rendered_image(obj: &Map) -> Option { + let value = obj.get("rendered_image")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn rendered_image_from_tripo3d_test_file() { + let webhook = load_test_webhook("success/tripo3d_model_urls_rendered_image_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let rendered_image = contents.rendered_image.expect("rendered_image should be Some"); + assert_eq!(rendered_image.url.as_deref(), Some("https://v3b.fal.media/files/b/0aa1bbd0/MblV2S5R6CeskRABMS7-V_preview.png")); + assert_eq!(rendered_image.content_type.as_deref(), Some("image/png")); + assert_eq!(rendered_image.file_name.as_deref(), Some("preview.png")); + assert_eq!(rendered_image.file_size, Some(30970)); + + // Tripo has no `thumbnail` key; the preview only arrives here. + assert!(contents.thumbnail.is_none()); + } + + #[test] + fn synthetic_rendered_image_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "rendered_image": { + "url": "https://cdn.example.com/preview.png", + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 12345 + } + }"#).unwrap(); + + let image = extract_rendered_image(&obj).expect("should extract rendered_image"); + assert_eq!(image.url.as_deref(), Some("https://cdn.example.com/preview.png")); + assert_eq!(image.content_type.as_deref(), Some("image/png")); + assert_eq!(image.file_name.as_deref(), Some("preview.png")); + assert_eq!(image.file_size, Some(12345)); + } + + #[test] + fn missing_rendered_image_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "thumbnail": {"url": "https://example.com/preview.png"} + }"#).unwrap(); + + assert!(extract_rendered_image(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_result_files_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_result_files_payload.rs new file mode 100644 index 00000000..76554773 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_result_files_payload.rs @@ -0,0 +1,68 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ResultFileData; + +/// Extract and deserialize the `result_files` key (a list of output files) +/// from a webhook success payload. +/// +/// Returns `None` for a missing/unparseable key AND for an empty list — an +/// empty result set is not actionable, so callers can treat `Some` as +/// "there is at least one file". +pub (crate) fn extract_result_files(obj: &Map) -> Option> { + let value = obj.get("result_files")?; + let files: Vec = serde_json::from_value(value.clone()).ok()?; + if files.is_empty() { + return None; + } + Some(files) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn synthetic_result_files_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "result_files": [ + { + "url": "https://cdn.example.com/part_1.fbx", + "content_type": "application/octet-stream", + "file_name": "part_1.fbx", + "file_size": 111111 + }, + { + "url": "https://cdn.example.com/part_2.fbx", + "content_type": "application/octet-stream", + "file_name": "part_2.fbx", + "file_size": 222222 + } + ] + }"#).unwrap(); + + let files = extract_result_files(&obj).expect("should extract result_files"); + assert_eq!(files.len(), 2); + assert_eq!(files[0].url.as_deref(), Some("https://cdn.example.com/part_1.fbx")); + assert_eq!(files[0].file_size, Some(111111)); + assert_eq!(files[1].url.as_deref(), Some("https://cdn.example.com/part_2.fbx")); + assert_eq!(files[1].file_name.as_deref(), Some("part_2.fbx")); + } + + #[test] + fn empty_result_files_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "result_files": [] + }"#).unwrap(); + + assert!(extract_result_files(&obj).is_none()); + } + + #[test] + fn missing_result_files_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb": {"url": "https://example.com/mesh.glb"} + }"#).unwrap(); + + assert!(extract_result_files(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_thumbnail_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_thumbnail_payload.rs new file mode 100644 index 00000000..6737b470 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_thumbnail_payload.rs @@ -0,0 +1,86 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ThumbnailData; + +/// Extract and deserialize the `thumbnail` key from a webhook success payload. +pub(crate) fn extract_thumbnail(obj: &Map) -> Option { + let value = obj.get("thumbnail")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn thumbnail_from_model_glb_test_file() { + let webhook = load_test_webhook("success/model_glb_urls_and_thumbnail_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let thumbnail = contents.thumbnail.expect("thumbnail should be Some"); + assert_eq!(thumbnail.url.as_deref(), Some("https://v3b.fal.media/files/b/0a95eb38/yvwGJWZV9TkWZuZvjxZNj_preview.png")); + assert_eq!(thumbnail.content_type.as_deref(), Some("image/png")); + assert_eq!(thumbnail.file_name.as_deref(), Some("preview.png")); + assert_eq!(thumbnail.file_size, Some(93436)); + } + + #[test] + fn synthetic_thumbnail_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "thumbnail": { + "url": "https://cdn.example.com/thumb.png", + "content_type": "image/png", + "file_name": "thumb.png", + "file_size": 12345 + } + }"#).unwrap(); + + let thumb = extract_thumbnail(&obj).expect("should extract thumbnail"); + assert_eq!(thumb.url.as_deref(), Some("https://cdn.example.com/thumb.png")); + assert_eq!(thumb.content_type.as_deref(), Some("image/png")); + assert_eq!(thumb.file_name.as_deref(), Some("thumb.png")); + assert_eq!(thumb.file_size, Some(12345)); + } + + #[test] + fn missing_thumbnail_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "model_glb": {"url": "https://example.com/model.glb"} + }"#).unwrap(); + + assert!(extract_thumbnail(&obj).is_none()); + } + + #[test] + fn model_mesh_payload_has_no_thumbnail() { + let webhook = load_test_webhook("success/model_mesh_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + assert!(contents.thumbnail.is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_video_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_video_payload.rs new file mode 100644 index 00000000..9c405c02 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/extract_video_payload.rs @@ -0,0 +1,90 @@ +use serde_json::{Map, Value}; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::VideoData; + +/// Extract and deserialize the `video` key from a webhook success payload. +pub (crate) fn extract_video(obj: &Map) -> Option { + let value = obj.get("video")?; + serde_json::from_value(value.clone()).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::webhook_payload::hydrate_webhook_contents::hydrate_webhook_contents; + use crate::webhook_payload::hydrated::hydrated_webhook_contents::HydratedWebhookContents; + use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + + fn load_test_webhook(filename: &str) -> RawWebhookPayload { + let path = format!("test_data/webhooks/{}", filename); + let json = std::fs::read_to_string(&path) + .unwrap_or_else(|e| panic!("Failed to read {}: {}", path, e)); + serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("Failed to parse {}: {}", path, e)) + } + + #[test] + fn video_payload_from_test_file() { + let webhook = load_test_webhook("success/video_payload_1.json"); + let result = hydrate_webhook_contents(&webhook); + + let HydratedWebhookContents::Success(data) = result else { + panic!("Expected Success, got {:?}", result); + }; + + let contents = data.extracted_contents + .expect("extracted_contents should be Some"); + + let video = contents.video.expect("video should be Some"); + + assert_eq!(video.url.as_deref(), Some("https://v3b.fal.media/files/b/0abcdef0/AB-CDE_123456789abcde_output.mp4")); + assert_eq!(video.content_type.as_deref(), Some("video/mp4")); + assert_eq!(video.file_name.as_deref(), Some("output.mp4")); + assert_eq!(video.file_size, Some(6226845)); + + assert!(contents.image.is_none()); + assert!(contents.images.is_none()); + assert!(contents.model_glb.is_none()); + assert!(contents.model_mesh.is_none()); + } + + #[test] + fn synthetic_video_payload() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "video": { + "url": "https://cdn.example.com/output.mp4", + "content_type": "video/mp4", + "file_name": "clip.mp4", + "file_size": 12345678 + } + }"#).unwrap(); + + let video = extract_video(&obj).expect("should extract video"); + assert_eq!(video.url.as_deref(), Some("https://cdn.example.com/output.mp4")); + assert_eq!(video.content_type.as_deref(), Some("video/mp4")); + assert_eq!(video.file_name.as_deref(), Some("clip.mp4")); + assert_eq!(video.file_size, Some(12345678)); + } + + #[test] + fn synthetic_video_url_only() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "video": {"url": "https://cdn.example.com/v.mp4"} + }"#).unwrap(); + + let video = extract_video(&obj).expect("should extract video"); + assert_eq!(video.url.as_deref(), Some("https://cdn.example.com/v.mp4")); + assert!(video.content_type.is_none()); + assert!(video.file_name.is_none()); + assert!(video.file_size.is_none()); + } + + #[test] + fn missing_video_key_returns_none() { + let obj: serde_json::Map = serde_json::from_str(r#"{ + "images": [{"url": "https://example.com/img.png"}] + }"#).unwrap(); + + assert!(extract_video(&obj).is_none()); + } +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/mod.rs b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/mod.rs new file mode 100644 index 00000000..06578003 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/hydrated/success_case_extractors/mod.rs @@ -0,0 +1,69 @@ +pub mod extract_audio_payload; +pub mod extract_image_payload; +pub mod extract_images_payload; +pub mod extract_video_payload; +pub mod extract_model_glb_payload; +pub mod extract_model_glb_pbr_payload; +pub mod extract_model_mesh_payload; +pub mod extract_model_obj_payload; +pub mod extract_model_urls_payload; +pub mod extract_preprocessed_image_payload; +pub mod extract_rendered_image_payload; +pub mod extract_result_files_payload; +pub mod extract_thumbnail_payload; + +use serde_json::Value; + +use crate::webhook_payload::hydrated::hydrated_webhook_contents::ExtractedContents; + +/// Try to extract known content keys from a success payload. +/// +/// Checks the payload (as a JSON object) for any of: `image`, `images`, +/// `video`, `audio`, `model_glb`, `model_glb_pbr`, `model_urls`, +/// `model_mesh`, `model_obj`, `result_files`, `thumbnail`, `rendered_image`, +/// `preprocessed_image`. If at least one is found, returns +/// `Some(ExtractedContents)` with copies of the relevant values. Multiple +/// keys can be populated simultaneously. Returns `None` if the payload is +/// not an object or none of the known keys are present. +pub fn extract_contents_from_payload(payload: &Value) -> Option { + let obj = payload.as_object()?; + + let image = extract_image_payload::extract_image(obj); + let images = extract_images_payload::extract_images(obj); + let video = extract_video_payload::extract_video(obj); + let audio = extract_audio_payload::extract_audio(obj); + let model_glb = extract_model_glb_payload::extract_model_glb(obj); + let model_glb_pbr = extract_model_glb_pbr_payload::extract_model_glb_pbr(obj); + let model_urls = extract_model_urls_payload::extract_model_urls(obj); + let model_mesh = extract_model_mesh_payload::extract_model_mesh(obj); + let model_obj = extract_model_obj_payload::extract_model_obj(obj); + let result_files = extract_result_files_payload::extract_result_files(obj); + let thumbnail = extract_thumbnail_payload::extract_thumbnail(obj); + let rendered_image = extract_rendered_image_payload::extract_rendered_image(obj); + let preprocessed_image = extract_preprocessed_image_payload::extract_preprocessed_image(obj); + + if image.is_none() && images.is_none() && video.is_none() && audio.is_none() + && model_glb.is_none() && model_glb_pbr.is_none() && model_urls.is_none() + && model_mesh.is_none() && model_obj.is_none() + && result_files.is_none() && thumbnail.is_none() && rendered_image.is_none() + && preprocessed_image.is_none() + { + return None; + } + + Some(ExtractedContents { + image, + images, + video, + audio, + model_glb, + model_glb_pbr, + model_urls, + model_mesh, + model_obj, + result_files, + thumbnail, + rendered_image, + preprocessed_image, + }) +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/mod.rs b/crates/api_clients/fal_client/src/webhook_payload/mod.rs new file mode 100644 index 00000000..eaaaac6d --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/mod.rs @@ -0,0 +1,4 @@ +pub mod raw; +pub mod hydrated; +pub mod hydrate_webhook_contents; +pub mod parse_raw_webhook_payload; diff --git a/crates/api_clients/fal_client/src/webhook_payload/parse_raw_webhook_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/parse_raw_webhook_payload.rs new file mode 100644 index 00000000..1b54efb6 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/parse_raw_webhook_payload.rs @@ -0,0 +1,5 @@ +use crate::webhook_payload::raw::raw_webhook_payload::RawWebhookPayload; + +pub fn parse_raw_webhook_payload(json: &str) -> Result { + serde_json::from_str(json) +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/raw/mod.rs b/crates/api_clients/fal_client/src/webhook_payload/raw/mod.rs new file mode 100644 index 00000000..f141a2c3 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/raw/mod.rs @@ -0,0 +1,2 @@ +pub mod webhook_error_type; +pub mod raw_webhook_payload; diff --git a/crates/api_clients/fal_client/src/webhook_payload/raw/raw_webhook_payload.rs b/crates/api_clients/fal_client/src/webhook_payload/raw/raw_webhook_payload.rs new file mode 100644 index 00000000..fedf703a --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/raw/raw_webhook_payload.rs @@ -0,0 +1,43 @@ +use serde::Deserialize; +use serde_json::Value; + +/// The value FAL sends to webhook endpoints. +#[derive(Deserialize, Debug, Clone)] +pub struct RawWebhookPayload { + /// Value originally used in the queue API + pub request_id: String, + + /// Mostly the same as `request_id`, but if the request failed and was retried, + /// then gateway_request_id will have the value of the last tried request, + /// while request_id will be the value used in the queue API. + pub gateway_request_id: String, + + /// Status of the request: OK or ERROR. + pub status: RawWebhookStatus, + + /// When an error happens, the status will be ERROR. + /// The error property will contain a message and payload will contain the error details. + /// eg. ""Invalid status code: 422" + pub error: Option, + + /// Payload of the webhook (typically present) + /// THIS FIELD IS HIGHLY VARIABLE JSON. + /// This is present for both *success* and *failure* cases, + /// though the payload differs. Sometimes it is absent. + pub payload: Option, + + /// In rare instances, if there was an error encoding the payload, + /// this may be set. This can seemingly be set on "OK" responses. + pub payload_error: Option, +} + +#[derive(Deserialize, Debug, Clone, Copy)] +pub enum RawWebhookStatus { + /// Success case + #[serde(alias = "OK")] + Ok, + + /// Failure case + #[serde(alias = "ERROR")] + Error +} diff --git a/crates/api_clients/fal_client/src/webhook_payload/raw/webhook_error_type.rs b/crates/api_clients/fal_client/src/webhook_payload/raw/webhook_error_type.rs new file mode 100644 index 00000000..26d3a194 --- /dev/null +++ b/crates/api_clients/fal_client/src/webhook_payload/raw/webhook_error_type.rs @@ -0,0 +1,114 @@ +use serde::Deserialize; + +/// Machine-readable error type from FAL webhook error payloads. +/// +/// These are the `type` field values from the `detail` array in FAL error responses. +/// See: https://fal.ai/docs/documentation/model-apis/errors +#[derive(Clone, Debug, Eq, PartialEq, Hash, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum WebhookErrorType { + FileTooLarge, + InternalServerError, + GenerationTimeout, + DownstreamServiceError, + DownstreamServiceUnavailable, + ContentPolicyViolation, + NoMediaGenerated, + ImageTooSmall, + ImageTooLarge, + ImageLoadError, + FileDownloadError, + FaceDetectionError, + /// Generic input validation error. The `msg` field carries the specifics + /// (e.g. TripoSplat's "No foreground subject could be detected..."). + InputValueError, + /// Generic validation error. The `msg` field carries the specifics (e.g. + /// Hunyuan 3D Part's "Part generation only supports FBX format..."). + ValueError, + GreaterThan, + GreaterThanEqual, + LessThan, + LessThanEqual, + MultipleOf, + SequenceTooShort, + SequenceTooLong, + OneOf, + FeatureNotSupported, + InvalidArchive, + ArchiveFileCountBelowMinimum, + ArchiveFileCountExceedsMaximum, + InvalidApiKey, + + /// Catch-all for unrecognized error types from FAL. + #[serde(untagged)] + Unknown(String), +} + +impl WebhookErrorType { + pub fn from_str(value: &str) -> Self { + serde_json::from_value(serde_json::Value::String(value.to_string())) + .unwrap_or_else(|_| Self::Unknown(value.to_string())) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn deserialize_known_types() { + let cases = vec![ + ("\"file_too_large\"", WebhookErrorType::FileTooLarge), + ("\"internal_server_error\"", WebhookErrorType::InternalServerError), + ("\"generation_timeout\"", WebhookErrorType::GenerationTimeout), + ("\"downstream_service_error\"", WebhookErrorType::DownstreamServiceError), + ("\"downstream_service_unavailable\"", WebhookErrorType::DownstreamServiceUnavailable), + ("\"content_policy_violation\"", WebhookErrorType::ContentPolicyViolation), + ("\"no_media_generated\"", WebhookErrorType::NoMediaGenerated), + ("\"image_too_small\"", WebhookErrorType::ImageTooSmall), + ("\"image_too_large\"", WebhookErrorType::ImageTooLarge), + ("\"image_load_error\"", WebhookErrorType::ImageLoadError), + ("\"file_download_error\"", WebhookErrorType::FileDownloadError), + ("\"face_detection_error\"", WebhookErrorType::FaceDetectionError), + ("\"input_value_error\"", WebhookErrorType::InputValueError), + ("\"value_error\"", WebhookErrorType::ValueError), + ("\"greater_than\"", WebhookErrorType::GreaterThan), + ("\"greater_than_equal\"", WebhookErrorType::GreaterThanEqual), + ("\"less_than\"", WebhookErrorType::LessThan), + ("\"less_than_equal\"", WebhookErrorType::LessThanEqual), + ("\"multiple_of\"", WebhookErrorType::MultipleOf), + ("\"sequence_too_short\"", WebhookErrorType::SequenceTooShort), + ("\"sequence_too_long\"", WebhookErrorType::SequenceTooLong), + ("\"one_of\"", WebhookErrorType::OneOf), + ("\"feature_not_supported\"", WebhookErrorType::FeatureNotSupported), + ("\"invalid_archive\"", WebhookErrorType::InvalidArchive), + ("\"archive_file_count_below_minimum\"", WebhookErrorType::ArchiveFileCountBelowMinimum), + ("\"archive_file_count_exceeds_maximum\"", WebhookErrorType::ArchiveFileCountExceedsMaximum), + ("\"invalid_api_key\"", WebhookErrorType::InvalidApiKey), + ]; + + for (json, expected) in cases { + let deserialized: WebhookErrorType = serde_json::from_str(json).unwrap(); + assert_eq!(deserialized, expected, "failed for {}", json); + } + } + + #[test] + fn deserialize_unknown_type() { + let deserialized: WebhookErrorType = serde_json::from_str("\"some_new_error_type\"").unwrap(); + assert_eq!(deserialized, WebhookErrorType::Unknown("some_new_error_type".to_string())); + } + + #[test] + fn from_str_known() { + assert_eq!(WebhookErrorType::from_str("content_policy_violation"), WebhookErrorType::ContentPolicyViolation); + assert_eq!(WebhookErrorType::from_str("face_detection_error"), WebhookErrorType::FaceDetectionError); + assert_eq!(WebhookErrorType::from_str("input_value_error"), WebhookErrorType::InputValueError); + assert_eq!(WebhookErrorType::from_str("value_error"), WebhookErrorType::ValueError); + } + + #[test] + fn from_str_unknown() { + assert_eq!(WebhookErrorType::from_str("brand_new_type"), WebhookErrorType::Unknown("brand_new_type".to_string())); + } +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/gpt_image_1p5_fail_content_policy.json b/crates/api_clients/fal_client/test_data/webhooks/failure/gpt_image_1p5_fail_content_policy.json new file mode 100644 index 00000000..2b2dd02c --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/gpt_image_1p5_fail_content_policy.json @@ -0,0 +1,29 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019d4756-130b-7141-a16c-8f411b785844", + "payload": { + "detail": [ + { + "input": { + "background": "auto", + "image_size": "1536x1024", + "input_fidelity": null, + "num_images": 1, + "openai_api_key": null, + "output_format": "png", + "prompt": "[redacted nsfw query]", + "quality": "medium" + }, + "loc": [ + "body", + "prompt" + ], + "msg": "The content could not be processed because it contained material flagged by a content checker.", + "type": "content_policy_violation", + "url": "https://docs.fal.ai/errors#content_policy_violation" + } + ] + }, + "request_id": "019d4756-130b-7141-a16c-8f411b785844", + "status": "ERROR" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/gpt_image_fail_invalid_api_key.json b/crates/api_clients/fal_client/test_data/webhooks/failure/gpt_image_fail_invalid_api_key.json new file mode 100644 index 00000000..3d56fe9c --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/gpt_image_fail_invalid_api_key.json @@ -0,0 +1,29 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019d4771-5b51-7480-afc6-67e6e74b9f22", + "payload": { + "detail": [ + { + "input": { + "background": "auto", + "image_size": "1536x1024", + "input_fidelity": null, + "num_images": 1, + "openai_api_key": "REDACTED", + "output_format": "png", + "prompt": "[redacted]", + "quality": "high" + }, + "loc": [ + "body", + "openai_api_key" + ], + "msg": "Invalid API key", + "type": "invalid_api_key", + "url": "https://docs.fal.ai/errors#invalid_api_key" + } + ] + }, + "request_id": "019d4771-5b51-7480-afc6-67e6e74b9f22", + "status": "ERROR" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/hunyuan_3d_3p1_part_fail_format_not_supported.json b/crates/api_clients/fal_client/test_data/webhooks/failure/hunyuan_3d_3p1_part_fail_format_not_supported.json new file mode 100644 index 00000000..96e5bb9c --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/hunyuan_3d_3p1_part_fail_format_not_supported.json @@ -0,0 +1,18 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019f4dad-7ff7-7902-b206-cb11bf1ef843", + "payload": { + "detail": [ + { + "loc": [ + "body", + "input_file_url" + ], + "msg": "Part generation only supports FBX format. Please provide an FBX file or use /convert-format to convert your model to FBX first.", + "type": "value_error" + } + ] + }, + "request_id": "019f4dad-7ff7-7902-b206-cb11bf1ef843", + "status": "ERROR" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/kling_1p6_pro_file_too_large_error.json b/crates/api_clients/fal_client/test_data/webhooks/failure/kling_1p6_pro_file_too_large_error.json new file mode 100644 index 00000000..bdb0818d --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/kling_1p6_pro_file_too_large_error.json @@ -0,0 +1,23 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019d477e-c123-7120-81c7-30d6b58a6720", + "payload": { + "detail": [ + { + "ctx": { + "max_size": 10485760 + }, + "input": "[redacted]", + "loc": [ + "body", + "image_url" + ], + "msg": "File size exceeds the maximum allowed size of 10485760 bytes. Please upload a smaller file.", + "type": "file_too_large", + "url": "https://docs.fal.ai/errors#file_too_large" + } + ] + }, + "request_id": "019d477e-c123-7120-81c7-30d6b58a6720", + "status": "ERROR" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/kling_3p0_pro_fail_content_policy.json b/crates/api_clients/fal_client/test_data/webhooks/failure/kling_3p0_pro_fail_content_policy.json new file mode 100644 index 00000000..8f8c619a --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/kling_3p0_pro_fail_content_policy.json @@ -0,0 +1,29 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019d4761-035d-7b50-8c42-1521efdd4f34", + "payload": { + "detail": [ + { + "input": { + "aspect_ratio": "16:9", + "cfg_scale": 0.5, + "duration": "3", + "generate_audio": false, + "multi_prompt": null, + "negative_prompt": "blur, distort, and low quality", + "prompt": "[redacted prompt]", + "shot_type": "customize", + "voice_ids": null + }, + "loc": [ + "body" + ], + "msg": "The content could not be processed because it contained material flagged by a content checker.", + "type": "content_policy_violation", + "url": "https://docs.fal.ai/errors#content_policy_violation" + } + ] + }, + "request_id": "019d4761-035d-7b50-8c42-1521efdd4f34", + "status": "ERROR" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/nano_banana_pro_fail_no_media_generated.json b/crates/api_clients/fal_client/test_data/webhooks/failure/nano_banana_pro_fail_no_media_generated.json new file mode 100644 index 00000000..f9404fed --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/nano_banana_pro_fail_no_media_generated.json @@ -0,0 +1,30 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019d475a-291a-7681-81dc-b27d2489beae", + "payload": { + "detail": [ + { + "input": { + "aspect_ratio": "16:9", + "enable_web_search": false, + "limit_generations": false, + "num_images": 1, + "output_format": "png", + "prompt": "[nsfw prompt redacted]", + "resolution": "1K", + "safety_tolerance": "4", + "seed": null, + "sync_mode": false + }, + "loc": [ + "body" + ], + "msg": "The model did not generate the expected output for this prompt. This may occur for several reasons, including unsafe content, a prompt that is incompatible with the selected media type (e.g., prompting an image model to generate audio), references to missing attachments, or other cases where the input cannot be processed as the requested output type. Please review your inputs and try again. If the issue persists, contact support.", + "type": "no_media_generated", + "url": "https://docs.fal.ai/errors#no_media_generated" + } + ] + }, + "request_id": "019d475a-291a-7681-81dc-b27d2489beae", + "status": "ERROR" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/seedream_partner_validation_failed.json b/crates/api_clients/fal_client/test_data/webhooks/failure/seedream_partner_validation_failed.json new file mode 100644 index 00000000..8d441a09 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/seedream_partner_validation_failed.json @@ -0,0 +1,35 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019d8079-baa1-75c0-a2da-7347ee642909", + "payload": { + "detail": [ + { + "ctx": { + "extra_info": { + "reason": "partner_validation_failed" + } + }, + "input": { + "enable_safety_checker": false, + "image_size": "landscape_16_9", + "image_urls": [ + "https://pub-c8a4a5bdbdb048f286b77bdf9f786ff2.r2.dev/media/w/k/5/k/8/wk5k8p47fwsw4hvgyj6gsb7nczcqeh58/snapshot_wk5k8p47fwsw4hvgyj6gsb7nczcqeh58.png" + ], + "max_images": 1, + "num_images": 4, + "prompt": "Add a giant monster in the distance", + "sync_mode": false + }, + "loc": [ + "body", + "image" + ], + "msg": "The content could not be processed because it contained material flagged by a content checker.", + "type": "content_policy_violation", + "url": "https://docs.fal.ai/errors#content_policy_violation" + } + ] + }, + "request_id": "019d8079-baa1-75c0-a2da-7347ee642909", + "status": "ERROR" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/failure/triposplat_fail_no_foreground_subject.json b/crates/api_clients/fal_client/test_data/webhooks/failure/triposplat_fail_no_foreground_subject.json new file mode 100644 index 00000000..2153e77d --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/failure/triposplat_fail_no_foreground_subject.json @@ -0,0 +1,19 @@ +{ + "error": "Unexpected status code: 422", + "gateway_request_id": "019f4d0e-3f44-7ed1-bb12-f2f834bdde7b", + "payload": { + "detail": [ + { + "input": "https://cdn-2.fakeyou.com/media/f/d/6/f/6/fd6f6czv21gkrdqhptz6nj072wh7w06y/artcraft_fd6f6czv21gkrdqhptz6nj072wh7w06y.png", + "loc": [ + "body" + ], + "msg": "No foreground subject could be detected in the input image after background removal. Provide an image with a clear, visible subject against a plain or distinct background.", + "type": "input_value_error", + "url": "https://docs.fal.ai/errors#input_value_error" + } + ] + }, + "request_id": "019f4d0e-3f44-7ed1-bb12-f2f834bdde7b", + "status": "ERROR" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_2p1_model_glbs_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_2p1_model_glbs_payload_1.json new file mode 100644 index 00000000..d1940822 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_2p1_model_glbs_payload_1.json @@ -0,0 +1,27 @@ +{ + "error": null, + "gateway_request_id": "019f4d49-6859-77b3-aaac-3b91b248481a", + "payload": { + "model_glb": { + "content_type": "application/octet-stream", + "file_name": "demo_textured.glb", + "file_size": 1574216, + "url": "https://v3b.fal.media/files/b/0aa1b916/QKdBTd8WJW_rtPB3IwlEN_demo_textured.glb" + }, + "model_glb_pbr": { + "content_type": "application/octet-stream", + "file_name": "demo_textured_pbr.glb", + "file_size": 7512760, + "url": "https://v3b.fal.media/files/b/0aa1b921/SJw7AARzkc4l9QG5Lrvmu_demo_textured_pbr.glb" + }, + "model_mesh": { + "content_type": "application/octet-stream", + "file_name": "3d_model.zip", + "file_size": 16332900, + "url": "https://v3b.fal.media/files/b/0aa1b915/B25DrTdiZJNV-60RaUh4u_3d_model.zip" + }, + "seed": 283904 + }, + "request_id": "019f4d49-6859-77b3-aaac-3b91b248481a", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p0_model_urls_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p0_model_urls_payload_1.json new file mode 100644 index 00000000..e99b3212 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p0_model_urls_payload_1.json @@ -0,0 +1,37 @@ +{ + "error": null, + "gateway_request_id": "019f4d58-0e11-7aa0-aa79-e0294bf9ff16", + "payload": { + "model_glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 51001160, + "url": "https://v3b.fal.media/files/b/0aa1b969/k5FZWmTsKxHH71404bBR__model.glb" + }, + "model_urls": { + "fbx": null, + "glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 51001160, + "url": "https://v3b.fal.media/files/b/0aa1b969/k5FZWmTsKxHH71404bBR__model.glb" + }, + "obj": { + "content_type": "text/plain", + "file_name": "model.obj", + "file_size": 41107268, + "url": "https://v3b.fal.media/files/b/0aa1b968/xngvKxLugXUlNh89Fp0K4_model.obj" + }, + "usdz": null + }, + "seed": null, + "thumbnail": { + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 136476, + "url": "https://v3b.fal.media/files/b/0aa1b969/EPgha8Kee7YZCAccjFUU7_preview.png" + } + }, + "request_id": "019f4d58-0e11-7aa0-aa79-e0294bf9ff16", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p1_model_urls_thumbnail_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p1_model_urls_thumbnail_payload_1.json new file mode 100644 index 00000000..ff839985 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p1_model_urls_thumbnail_payload_1.json @@ -0,0 +1,49 @@ +{ + "error": null, + "gateway_request_id": "019f4d79-35fd-7462-85be-359c8232f56e", + "payload": { + "model_glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 64261364, + "url": "https://v3b.fal.media/files/b/0aa1ba44/OdgIv8M9EkaBP_Mh4TVAB_model.glb" + }, + "model_urls": { + "fbx": null, + "glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 64261364, + "url": "https://v3b.fal.media/files/b/0aa1ba44/OdgIv8M9EkaBP_Mh4TVAB_model.glb" + }, + "mtl": { + "content_type": "text/plain", + "file_name": "material.mtl", + "file_size": 245, + "url": "https://v3b.fal.media/files/b/0aa1ba42/1T5VCp_xD0zCJlTLE96iK_material.mtl" + }, + "obj": { + "content_type": "model/obj", + "file_name": "c3a871e997ecd5f889bf671630de23b4.obj", + "file_size": 34563830, + "url": "https://v3b.fal.media/files/b/0aa1ba43/WxPMNbzsDxaGRCmGNgNAL_c3a871e997ecd5f889bf671630de23b4.obj" + }, + "texture": { + "content_type": "image/png", + "file_name": "texture_pbr_20250901.png", + "file_size": 22794575, + "url": "https://v3b.fal.media/files/b/0aa1ba43/aKp3mMB9nrhlKfV2KVf0S_texture_pbr_20250901.png" + }, + "usdz": null + }, + "seed": null, + "thumbnail": { + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 141254, + "url": "https://v3b.fal.media/files/b/0aa1ba44/njq8zYhYahJNNQkGGiEZW_preview.png" + } + }, + "request_id": "019f4d79-35fd-7462-85be-359c8232f56e", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p1_rapid_obj_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p1_rapid_obj_payload_1.json new file mode 100644 index 00000000..83e31056 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/hunyuan_3d_3p1_rapid_obj_payload_1.json @@ -0,0 +1,55 @@ +{ + "error": null, + "gateway_request_id": "019f4d93-5a68-7a23-b2e7-8a1bc55e50f8", + "payload": { + "material_mtl": { + "content_type": "text/plain", + "file_name": "material.mtl", + "file_size": 229, + "url": "https://v3b.fal.media/files/b/0aa1bae3/5cbE-q28i44GUOO6YeZPH_material.mtl" + }, + "model_glb": { + "content_type": "model/obj", + "file_name": "23dce35fc95b34722f15a7329061d5df.obj", + "file_size": 3258750, + "url": "https://v3b.fal.media/files/b/0aa1bae3/22zStkYp8-q6npG9dsMs5_23dce35fc95b34722f15a7329061d5df.obj" + }, + "model_urls": { + "fbx": null, + "glb": null, + "mtl": { + "content_type": "text/plain", + "file_name": "material.mtl", + "file_size": 229, + "url": "https://v3b.fal.media/files/b/0aa1bae3/5cbE-q28i44GUOO6YeZPH_material.mtl" + }, + "obj": { + "content_type": "model/obj", + "file_name": "23dce35fc95b34722f15a7329061d5df.obj", + "file_size": 3258750, + "url": "https://v3b.fal.media/files/b/0aa1bae3/22zStkYp8-q6npG9dsMs5_23dce35fc95b34722f15a7329061d5df.obj" + }, + "texture": { + "content_type": "image/png", + "file_name": "texture_pbr_v128.png", + "file_size": 5503289, + "url": "https://v3b.fal.media/files/b/0aa1bae3/7eBRddTHf6U8SUg2QOIHw_texture_pbr_v128.png" + }, + "usdz": null + }, + "texture": { + "content_type": "image/png", + "file_name": "texture_pbr_v128.png", + "file_size": 5503289, + "url": "https://v3b.fal.media/files/b/0aa1bae3/7eBRddTHf6U8SUg2QOIHw_texture_pbr_v128.png" + }, + "thumbnail": { + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 120530, + "url": "https://v3b.fal.media/files/b/0aa1bae3/IO3aspD4ijEadoFxSF504_preview.png" + } + }, + "request_id": "019f4d93-5a68-7a23-b2e7-8a1bc55e50f8", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/images_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/images_payload_1.json new file mode 100644 index 00000000..3d4fdea8 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/images_payload_1.json @@ -0,0 +1,26 @@ +{ + "error": null, + "gateway_request_id": "11111111-2222-3333-4444-555555555555", + "payload": { + "images": [ + { + "content_type": "image/png", + "file_name": "name1.png", + "file_size": 11500002, + "height": null, + "url": "https://v3b.fal.media/files/b/01234567/name1.png", + "width": null + }, + { + "content_type": "image/png", + "file_name": "name2.png", + "file_size": 13499999, + "height": null, + "url": "https://v3b.fal.media/files/b/01234567/name2.png", + "width": null + } + ] + }, + "request_id": "11111111-2222-3333-4444-555555555555", + "status": "OK" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/meshy_model_urls_thumbnail_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/meshy_model_urls_thumbnail_payload_1.json new file mode 100644 index 00000000..e04c303c --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/meshy_model_urls_thumbnail_payload_1.json @@ -0,0 +1,88 @@ +{ + "error": null, + "gateway_request_id": "019f4db7-e55c-78d1-9719-0303ca50a961", + "payload": { + "animation_fbx": null, + "animation_glb": null, + "basic_animations": null, + "model_glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 15943768, + "url": "https://v3b.fal.media/files/b/0aa1bbe1/0vrf9NUhVxKZO4GScA0EI_model.glb" + }, + "model_urls": { + "blend": null, + "fbx": { + "content_type": "application/octet-stream", + "file_name": "model.fbx", + "file_size": 13665964, + "url": "https://v3b.fal.media/files/b/0aa1bbed/yKO-HOjBnWA-LZpRLHHSB_model.fbx" + }, + "glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 15943768, + "url": "https://v3b.fal.media/files/b/0aa1bbe1/0vrf9NUhVxKZO4GScA0EI_model.glb" + }, + "obj": { + "content_type": "text/plain", + "file_name": "model.obj", + "file_size": 3083671, + "url": "https://v3b.fal.media/files/b/0aa1bbe2/NBmqIWBS8LuY_BPYWkOOf_model.obj" + }, + "stl": { + "content_type": "application/octet-stream", + "file_name": "model.stl", + "file_size": 1508384, + "url": "https://v3b.fal.media/files/b/0aa1bbe2/3wtOE6iEeVHZFvwAGN6Rl_model.stl" + }, + "usdz": { + "content_type": "model/vnd.usdz+zip", + "file_name": "model.usdz", + "file_size": 16861118, + "url": "https://v3b.fal.media/files/b/0aa1bbed/BsniPBo6Uev85V4hLFACR_model.usdz" + } + }, + "rig_task_id": null, + "rigged_character_fbx": null, + "rigged_character_glb": null, + "seed": 274321742, + "texture_urls": [ + { + "base_color": { + "content_type": "image/png", + "file_name": "texture_0.png", + "file_size": 7539838, + "url": "https://v3b.fal.media/files/b/0aa1bbe3/EXWiAuAYPobYiJPnW66mQ_texture_0.png" + }, + "metallic": { + "content_type": "image/png", + "file_name": "texture_0_metallic.png", + "file_size": 858941, + "url": "https://v3b.fal.media/files/b/0aa1bbee/RTZIZRCDQTvN7jdl4EL_C_texture_0_metallic.png" + }, + "normal": { + "content_type": "image/png", + "file_name": "texture_0_normal.png", + "file_size": 8236038, + "url": "https://v3b.fal.media/files/b/0aa1bbe3/yNk-S5Dhw2xc9fb3fIjwD_texture_0_normal.png" + }, + "roughness": { + "content_type": "image/png", + "file_name": "texture_0_roughness.png", + "file_size": 1184908, + "url": "https://v3b.fal.media/files/b/0aa1bbe3/nnT25g7wgul2oDTRlI_jX_texture_0_roughness.png" + } + } + ], + "thumbnail": { + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 192910, + "url": "https://v3b.fal.media/files/b/0aa1bbe3/tn1qfOr12oGXecA4mRtlI_preview.png" + } + }, + "request_id": "019f4db7-e55c-78d1-9719-0303ca50a961", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/model_glb_urls_and_thumbnail_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/model_glb_urls_and_thumbnail_1.json new file mode 100644 index 00000000..f3e0287c --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/model_glb_urls_and_thumbnail_1.json @@ -0,0 +1,37 @@ +{ + "error": null, + "gateway_request_id": "019d8031-ede2-7932-a18f-9b2865908c0e", + "payload": { + "model_glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 66284788, + "url": "https://v3b.fal.media/files/b/0a95eb37/f7UaAhyfcx0BAnYy0GpFM_model.glb" + }, + "model_urls": { + "fbx": null, + "glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 66284788, + "url": "https://v3b.fal.media/files/b/0a95eb37/f7UaAhyfcx0BAnYy0GpFM_model.glb" + }, + "obj": { + "content_type": "text/plain", + "file_name": "model.obj", + "file_size": 55806533, + "url": "https://v3b.fal.media/files/b/0a95eb38/vfrPPtdTXNEYh_ExY-adN_model.obj" + }, + "usdz": null + }, + "seed": null, + "thumbnail": { + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 93436, + "url": "https://v3b.fal.media/files/b/0a95eb38/yvwGJWZV9TkWZuZvjxZNj_preview.png" + } + }, + "request_id": "019d8031-ede2-7932-a18f-9b2865908c0e", + "status": "OK" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/model_mesh_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/model_mesh_payload_1.json new file mode 100644 index 00000000..5cb7f66a --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/model_mesh_payload_1.json @@ -0,0 +1,15 @@ +{ + "error": null, + "gateway_request_id": "019d8032-38cb-7161-8dd8-0b4adf10fa72", + "payload": { + "model_mesh": { + "content_type": "application/octet-stream", + "file_name": "mesh-1775972273-765284.glb", + "file_size": 3886928, + "url": "https://v3b.fal.media/files/b/0a95eb2d/XCpH7fk-tZVXr1XMUr7DY_mesh-1775972273-765284.glb" + }, + "seed": 765284 + }, + "request_id": "019d8032-38cb-7161-8dd8-0b4adf10fa72", + "status": "OK" +} \ No newline at end of file diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/seed_audio_1p0_audio_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/seed_audio_1p0_audio_payload_1.json new file mode 100644 index 00000000..0b84c749 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/seed_audio_1p0_audio_payload_1.json @@ -0,0 +1,18 @@ +{ + "error": null, + "gateway_request_id": "019f4dc7-e98b-7f90-94c5-a8b131ff2660", + "payload": { + "audio": { + "bitrate": null, + "channels": null, + "content_type": "audio/mpeg", + "duration": 6.63995, + "file_name": "speech.mp3", + "file_size": 53612, + "sample_rate": 24000, + "url": "https://v3b.fal.media/files/b/0aa1bc36/vOSCcxsbibkZIiXR9BIZn_speech.mp3" + } + }, + "request_id": "019f4dc7-e98b-7f90-94c5-a8b131ff2660", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/tripo3d_model_urls_rendered_image_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/tripo3d_model_urls_rendered_image_payload_1.json new file mode 100644 index 00000000..5e13d19e --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/tripo3d_model_urls_rendered_image_payload_1.json @@ -0,0 +1,36 @@ +{ + "error": null, + "gateway_request_id": "019f4db5-aadd-76c3-8122-ff1ba53fe48c", + "payload": { + "model_mesh": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 43981280, + "url": "https://v3b.fal.media/files/b/0aa1bbdb/d8ATWvvXYHY-8zj-lQecf_model.glb" + }, + "model_urls": { + "base_model": null, + "fbx": null, + "glb": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 43981280, + "url": "https://v3b.fal.media/files/b/0aa1bbdb/d8ATWvvXYHY-8zj-lQecf_model.glb" + }, + "pbr_model": { + "content_type": "model/gltf-binary", + "file_name": "model.glb", + "file_size": 43981280, + "url": "https://v3b.fal.media/files/b/0aa1bbdb/d8ATWvvXYHY-8zj-lQecf_model.glb" + } + }, + "rendered_image": { + "content_type": "image/png", + "file_name": "preview.png", + "file_size": 30970, + "url": "https://v3b.fal.media/files/b/0aa1bbd0/MblV2S5R6CeskRABMS7-V_preview.png" + } + }, + "request_id": "019f4db5-aadd-76c3-8122-ff1ba53fe48c", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/triposplat_splat_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/triposplat_splat_payload_1.json new file mode 100644 index 00000000..1f1fe1d6 --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/triposplat_splat_payload_1.json @@ -0,0 +1,28 @@ +{ + "error": null, + "gateway_request_id": "019f4d0f-4cf2-76d3-b99b-c400641b3844", + "payload": { + "model_mesh": { + "content_type": "application/octet-stream", + "file_name": "output.ply", + "file_size": 17826208, + "url": "https://v3b.fal.media/files/b/0aa1b77c/hEzg5xn9A-1qrLsnywjN4_output.ply" + }, + "num_gaussians": 262144, + "preprocessed_image": { + "content_type": "image/png", + "file_name": "61fc73dbe84446b08b1fcce2167b71d5.png", + "file_size": 952754, + "height": 1024, + "url": "https://v3b.fal.media/files/b/0aa1b77c/YyJ19g7lJsRNXmvZvahTE_61fc73dbe84446b08b1fcce2167b71d5.png", + "width": 1024 + }, + "seed": 1637204116, + "timings": { + "export": 0.794984320000367, + "inference": 4.911052849000043 + } + }, + "request_id": "019f4d0f-4cf2-76d3-b99b-c400641b3844", + "status": "OK" +} diff --git a/crates/api_clients/fal_client/test_data/webhooks/success/video_payload_1.json b/crates/api_clients/fal_client/test_data/webhooks/success/video_payload_1.json new file mode 100644 index 00000000..413f59db --- /dev/null +++ b/crates/api_clients/fal_client/test_data/webhooks/success/video_payload_1.json @@ -0,0 +1,14 @@ +{ + "error": null, + "gateway_request_id": "01234560-1230-1230-1230-122233344455", + "payload": { + "video": { + "content_type": "video/mp4", + "file_name": "output.mp4", + "file_size": 6226845, + "url": "https://v3b.fal.media/files/b/0abcdef0/AB-CDE_123456789abcde_output.mp4" + } + }, + "request_id": "01234560-1230-1230-1230-122233344455", + "status": "OK" +} \ No newline at end of file diff --git a/crates/api_clients/gmicloud_client/Cargo.toml b/crates/api_clients/gmicloud_client/Cargo.toml new file mode 100644 index 00000000..2fe2c194 --- /dev/null +++ b/crates/api_clients/gmicloud_client/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "gmicloud_client" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "gmicloud_client" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true + +# External +log.workspace = true +reqwest.workspace = true +serde.workspace = true +serde_derive.workspace = true +serde_json.workspace = true + +[dev-dependencies] +test_data = { path = "../../testing/test_data" } +test_utils = { path = "../../testing/test_utils" } +tokio = { version = "1", features = ["full"] } diff --git a/crates/api_clients/gmicloud_client/src/creds/gmicloud_api_key.rs b/crates/api_clients/gmicloud_client/src/creds/gmicloud_api_key.rs new file mode 100644 index 00000000..d1c30426 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/creds/gmicloud_api_key.rs @@ -0,0 +1,17 @@ +/// A GmiCloud API key used for Bearer token authentication. +#[derive(Clone)] +pub struct GmiCloudApiKey(pub String); + +impl GmiCloudApiKey { + pub fn new(api_key: String) -> Self { + Self(api_key.trim().to_string()) + } + + pub fn from_str(api_key: &str) -> Self { + Self(api_key.trim().to_string()) + } + + pub fn as_str(&self) -> &str { + &self.0 + } +} diff --git a/crates/api_clients/gmicloud_client/src/creds/mod.rs b/crates/api_clients/gmicloud_client/src/creds/mod.rs new file mode 100644 index 00000000..471a13fe --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/creds/mod.rs @@ -0,0 +1 @@ +pub mod gmicloud_api_key; diff --git a/crates/api_clients/gmicloud_client/src/error/gmicloud_client_error.rs b/crates/api_clients/gmicloud_client/src/error/gmicloud_client_error.rs new file mode 100644 index 00000000..e2acccad --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/error/gmicloud_client_error.rs @@ -0,0 +1,23 @@ +use std::fmt; + +/// Errors that occur client-side before/during request construction. +#[derive(Debug)] +pub enum GmiCloudClientError { + /// The API key was not provided or is empty. + NoApiKeyPresent, + + /// A reqwest client-level error. + ReqwestError(reqwest::Error), +} + +impl fmt::Display for GmiCloudClientError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{:?}", self) + } +} + +impl From for GmiCloudClientError { + fn from(err: reqwest::Error) -> Self { + Self::ReqwestError(err) + } +} diff --git a/crates/api_clients/gmicloud_client/src/error/gmicloud_error.rs b/crates/api_clients/gmicloud_client/src/error/gmicloud_error.rs new file mode 100644 index 00000000..eef5221f --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/error/gmicloud_error.rs @@ -0,0 +1,37 @@ +use std::fmt; + +use crate::error::gmicloud_client_error::GmiCloudClientError; +use crate::error::gmicloud_generic_api_error::GmiCloudGenericApiError; +use crate::error::gmicloud_specific_api_error::GmiCloudSpecificApiError; + +/// Top-level error type for the GmiCloud client. +#[derive(Debug)] +pub enum GmiCloudError { + Client(GmiCloudClientError), + ApiSpecific(GmiCloudSpecificApiError), + ApiGeneric(GmiCloudGenericApiError), +} + +impl fmt::Display for GmiCloudError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{:?}", self) + } +} + +impl From for GmiCloudError { + fn from(err: GmiCloudClientError) -> Self { + Self::Client(err) + } +} + +impl From for GmiCloudError { + fn from(err: GmiCloudSpecificApiError) -> Self { + Self::ApiSpecific(err) + } +} + +impl From for GmiCloudError { + fn from(err: GmiCloudGenericApiError) -> Self { + Self::ApiGeneric(err) + } +} diff --git a/crates/api_clients/gmicloud_client/src/error/gmicloud_generic_api_error.rs b/crates/api_clients/gmicloud_client/src/error/gmicloud_generic_api_error.rs new file mode 100644 index 00000000..cc9d7e32 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/error/gmicloud_generic_api_error.rs @@ -0,0 +1,26 @@ +use std::fmt; + +/// Server-side errors with unknown or generic causes. +#[derive(Debug)] +pub enum GmiCloudGenericApiError { + /// Failed to parse the JSON response body. + SerdeResponseParseErrorWithBody(serde_json::Error, String), + + /// Non-200 response that couldn't be classified. + UncategorizedBadResponseWithStatusAndBody { status_code: u16, body: String }, + + /// A reqwest transport error. + ReqwestError(reqwest::Error), +} + +impl fmt::Display for GmiCloudGenericApiError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{:?}", self) + } +} + +impl From for GmiCloudGenericApiError { + fn from(err: reqwest::Error) -> Self { + Self::ReqwestError(err) + } +} diff --git a/crates/api_clients/gmicloud_client/src/error/gmicloud_specific_api_error.rs b/crates/api_clients/gmicloud_client/src/error/gmicloud_specific_api_error.rs new file mode 100644 index 00000000..27eac68a --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/error/gmicloud_specific_api_error.rs @@ -0,0 +1,23 @@ +use std::fmt; + +/// Well-known server-side errors with specific causes. +#[derive(Debug)] +pub enum GmiCloudSpecificApiError { + /// The API key is invalid or expired. + Unauthorized, + + /// The request was rejected due to content policy. + ContentPolicyViolation(String), + + /// The input image was rejected because it may contain a real person. + ContentContainsRealPerson(String), + + /// The account has insufficient credits or a billing issue. + BillingError { status_code: u16, body: String }, +} + +impl fmt::Display for GmiCloudSpecificApiError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{:?}", self) + } +} diff --git a/crates/api_clients/gmicloud_client/src/error/mod.rs b/crates/api_clients/gmicloud_client/src/error/mod.rs new file mode 100644 index 00000000..a3317b57 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/error/mod.rs @@ -0,0 +1,4 @@ +pub mod gmicloud_client_error; +pub mod gmicloud_error; +pub mod gmicloud_generic_api_error; +pub mod gmicloud_specific_api_error; diff --git a/crates/api_clients/gmicloud_client/src/lib.rs b/crates/api_clients/gmicloud_client/src/lib.rs new file mode 100644 index 00000000..f062f8d0 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/lib.rs @@ -0,0 +1,7 @@ +pub mod creds; +pub mod error; +pub mod requests; +pub mod traits; + +#[cfg(test)] +mod test_utils; diff --git a/crates/api_clients/gmicloud_client/src/requests/api/mod.rs b/crates/api_clients/gmicloud_client/src/requests/api/mod.rs new file mode 100644 index 00000000..b04b953e --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/mod.rs @@ -0,0 +1 @@ +pub mod video; diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/mod.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/mod.rs new file mode 100644 index 00000000..c3032250 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/mod.rs @@ -0,0 +1,2 @@ +pub mod seedance_2_0_260128; +pub mod seedance_2_0_fast_260128; diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/api.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/api.rs new file mode 100644 index 00000000..9ac0b5ea --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/api.rs @@ -0,0 +1,401 @@ +use crate::creds::gmicloud_api_key::GmiCloudApiKey; +use crate::error::gmicloud_error::GmiCloudError; +use crate::requests::api::video::seedance_2_0_260128::raw_request::Seedance20Payload; +use crate::requests::common::create_request::{ + create_gmicloud_request, create_gmicloud_request_with_context, + GmiCloudCreateRequest, GmiCloudCreateResponse, +}; +use crate::requests::context::request_context::RequestContext; + +const MODEL_ID: &str = "seedance-2-0-260128"; + +/// User-facing request for the Seedance 2.0 model via GmiCloud. +#[derive(Clone, Debug)] +pub struct Seedance20Request { + /// Text prompt describing the video to generate. Required. + pub prompt: String, + + /// Video duration in seconds (4–15). Default: 5. + pub duration: Option, + + /// Output resolution. + pub resolution: Option, + + /// Aspect ratio of the output video. + pub ratio: Option, + + /// Random seed for reproducibility (0–4294967295). + pub seed: Option, + + /// Whether to embed a watermark. Default: false. + pub watermark: Option, + + /// Whether to synthesize audio. Default: true. + pub generate_audio: Option, + + /// Whether to enable web search grounding. Default: false. + pub web_search: Option, + + /// First frame image URL for image-to-video generation. + pub first_frame: Option, + + /// Last frame image URL for image-to-video generation. + pub last_frame: Option, + + /// Reference image URLs. + pub reference_images: Option>, + + /// Reference video URLs. + pub reference_videos: Option>, + + /// Reference audio file URLs. + pub reference_audios: Option>, + + /// Pre-uploaded asset IDs. + pub reference_asset_ids: Option>, +} + +#[derive(Copy, Clone, Debug, PartialEq)] +pub enum Seedance20Resolution { + FourEightyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Copy, Clone, Debug, PartialEq)] +pub enum Seedance20Ratio { + /// 16:9 (landscape) + Landscape16x9, + /// 4:3 + Standard4x3, + /// 1:1 (square) + Square, + /// 3:4 + Portrait3x4, + /// 9:16 (portrait) + Portrait9x16, + /// 21:9 (ultra-wide) + UltraWide21x9, + /// Adaptive (inferred from input) + Adaptive, +} + +impl Seedance20Request { + pub fn to_raw_payload(&self) -> Seedance20Payload { + Seedance20Payload { + prompt: self.prompt.clone(), + duration: self.duration, + resolution: self.resolution.map(|r| match r { + Seedance20Resolution::FourEightyP => "480p", + Seedance20Resolution::SevenTwentyP => "720p", + Seedance20Resolution::TenEightyP => "1080p", + }.to_string()), + ratio: self.ratio.map(|r| match r { + Seedance20Ratio::Landscape16x9 => "16:9", + Seedance20Ratio::Standard4x3 => "4:3", + Seedance20Ratio::Square => "1:1", + Seedance20Ratio::Portrait3x4 => "3:4", + Seedance20Ratio::Portrait9x16 => "9:16", + Seedance20Ratio::UltraWide21x9 => "21:9", + Seedance20Ratio::Adaptive => "adaptive", + }.to_string()), + seed: self.seed, + watermark: self.watermark, + generate_audio: self.generate_audio, + web_search: self.web_search, + first_frame: self.first_frame.clone(), + last_frame: self.last_frame.clone(), + reference_images: self.reference_images.clone(), + reference_videos: self.reference_videos.clone(), + reference_audios: self.reference_audios.clone(), + reference_asset_ids: self.reference_asset_ids.clone(), + } + } + + pub async fn send_request( + &self, + api_key: &GmiCloudApiKey, + ) -> Result { + let context = RequestContext { + api_key, + maybe_timeout: None, + }; + self.send_request_with_context(&context).await + } + + pub async fn send_request_with_context( + &self, + context: &RequestContext<'_>, + ) -> Result { + let body = GmiCloudCreateRequest { + model: MODEL_ID.to_string(), + payload: self.to_raw_payload(), + }; + create_gmicloud_request_with_context(context, &body).await + } + + pub fn model_id() -> &'static str { + MODEL_ID + } + + /// The effective duration in seconds for cost calculation. + pub fn effective_duration_seconds(&self) -> u8 { + self.duration.unwrap_or(5) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn minimal_request() -> Seedance20Request { + Seedance20Request { + prompt: "a dog running through a field".to_string(), + duration: None, + resolution: None, + ratio: None, + seed: None, + watermark: None, + generate_audio: None, + web_search: None, + first_frame: None, + last_frame: None, + reference_images: None, + reference_videos: None, + reference_audios: None, + reference_asset_ids: None, + } + } + + mod raw_payload_tests { + use super::*; + + #[test] + fn minimal_request_serializes_only_prompt() { + let request = minimal_request(); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["prompt"], "a dog running through a field"); + // All optional fields should be absent + assert!(json.get("duration").is_none()); + assert!(json.get("resolution").is_none()); + assert!(json.get("ratio").is_none()); + assert!(json.get("seed").is_none()); + assert!(json.get("watermark").is_none()); + assert!(json.get("generate_audio").is_none()); + assert!(json.get("web_search").is_none()); + assert!(json.get("first_frame").is_none()); + assert!(json.get("last_frame").is_none()); + assert!(json.get("reference_images").is_none()); + assert!(json.get("reference_videos").is_none()); + assert!(json.get("reference_audios").is_none()); + assert!(json.get("reference_asset_ids").is_none()); + } + + #[test] + fn full_request_serializes_all_fields() { + let request = Seedance20Request { + prompt: "a cat sitting on a windowsill".to_string(), + duration: Some(10), + resolution: Some(Seedance20Resolution::TenEightyP), + ratio: Some(Seedance20Ratio::Landscape16x9), + seed: Some(42), + watermark: Some(false), + generate_audio: Some(true), + web_search: Some(true), + first_frame: Some("https://example.com/first.png".to_string()), + last_frame: Some("https://example.com/last.png".to_string()), + reference_images: Some(vec!["https://example.com/ref1.png".to_string()]), + reference_videos: Some(vec!["https://example.com/ref1.mp4".to_string()]), + reference_audios: Some(vec!["https://example.com/ref1.wav".to_string()]), + reference_asset_ids: Some(vec!["asset_123".to_string()]), + }; + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["prompt"], "a cat sitting on a windowsill"); + assert_eq!(json["duration"], 10); + assert_eq!(json["resolution"], "1080p"); + assert_eq!(json["ratio"], "16:9"); + assert_eq!(json["seed"], 42); + assert_eq!(json["watermark"], false); + assert_eq!(json["generate_audio"], true); + assert_eq!(json["web_search"], true); + assert_eq!(json["first_frame"], "https://example.com/first.png"); + assert_eq!(json["last_frame"], "https://example.com/last.png"); + assert_eq!(json["reference_images"][0], "https://example.com/ref1.png"); + assert_eq!(json["reference_videos"][0], "https://example.com/ref1.mp4"); + assert_eq!(json["reference_audios"][0], "https://example.com/ref1.wav"); + assert_eq!(json["reference_asset_ids"][0], "asset_123"); + } + + #[test] + fn all_ratios_serialize() { + let cases = [ + (Seedance20Ratio::Landscape16x9, "16:9"), + (Seedance20Ratio::Standard4x3, "4:3"), + (Seedance20Ratio::Square, "1:1"), + (Seedance20Ratio::Portrait3x4, "3:4"), + (Seedance20Ratio::Portrait9x16, "9:16"), + (Seedance20Ratio::UltraWide21x9, "21:9"), + (Seedance20Ratio::Adaptive, "adaptive"), + ]; + for (ratio, expected) in cases { + let mut request = minimal_request(); + request.ratio = Some(ratio); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["ratio"], expected, "{ratio:?}"); + } + } + + #[test] + fn all_resolutions_serialize() { + let cases = [ + (Seedance20Resolution::FourEightyP, "480p"), + (Seedance20Resolution::SevenTwentyP, "720p"), + (Seedance20Resolution::TenEightyP, "1080p"), + ]; + for (resolution, expected) in cases { + let mut request = minimal_request(); + request.resolution = Some(resolution); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["resolution"], expected, "{resolution:?}"); + } + } + + #[test] + fn duration_is_integer() { + let mut request = minimal_request(); + request.duration = Some(7); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["duration"], 7); + assert!(json["duration"].is_number()); + } + + #[test] + fn create_request_body_shape() { + let mut request = minimal_request(); + request.prompt = "test".to_string(); + request.duration = Some(5); + request.ratio = Some(Seedance20Ratio::Square); + let body = GmiCloudCreateRequest { + model: Seedance20Request::model_id().to_string(), + payload: request.to_raw_payload(), + }; + let json = serde_json::to_value(&body).unwrap(); + assert_eq!(json["model"], "seedance-2-0-260128"); + assert_eq!(json["payload"]["prompt"], "test"); + assert_eq!(json["payload"]["duration"], 5); + assert_eq!(json["payload"]["ratio"], "1:1"); + } + + #[test] + fn image_to_video_with_first_frame() { + let mut request = minimal_request(); + request.first_frame = Some("https://example.com/cat.png".to_string()); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["first_frame"], "https://example.com/cat.png"); + assert!(json.get("last_frame").is_none()); + } + + #[test] + fn keyframe_with_first_and_last() { + let mut request = minimal_request(); + request.first_frame = Some("https://example.com/start.png".to_string()); + request.last_frame = Some("https://example.com/end.png".to_string()); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["first_frame"], "https://example.com/start.png"); + assert_eq!(json["last_frame"], "https://example.com/end.png"); + } + } + + mod effective_duration_tests { + use super::*; + + #[test] + fn defaults_to_five() { + assert_eq!(minimal_request().effective_duration_seconds(), 5); + } + + #[test] + fn respects_explicit_value() { + let mut request = minimal_request(); + request.duration = Some(12); + assert_eq!(request.effective_duration_seconds(), 12); + } + } + + mod live_api_tests { + use super::*; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_text_to_video() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "a golden retriever puppy playing in autumn leaves".to_string(); + request.duration = Some(5); + request.ratio = Some(Seedance20Ratio::Landscape16x9); + let result = request.send_request(&api_key).await.unwrap(); + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + + // Balance was $49.75 before running this. + // [480p] Request ID: 4a0efe0d-990f-480d-9792-5bb71dd26b85 + // Balance was $49.51 after running this. + // 24 cents = 2.4 cents per second + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_480p() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "the dog in this photo starts running and splashing in the lake water".to_string(); + request.duration = Some(10); + request.resolution = Some(Seedance20Resolution::FourEightyP); + request.first_frame = Some(JUNO_AT_LAKE_IMAGE_URL.to_string()); + let result = request.send_request(&api_key).await.unwrap(); + println!("[480p] Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + + // Balance was $49.51 before running this. + // [720p] Request ID: 40f63632-dd9d-4725-ab73-5bb764e773be + // Balance was $48.99 after running this. + // 52 cents = 5.2 cents per second + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_720p() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "the dog in this photo starts running and splashing in the lake water".to_string(); + request.duration = Some(10); + request.resolution = Some(Seedance20Resolution::SevenTwentyP); + request.first_frame = Some(JUNO_AT_LAKE_IMAGE_URL.to_string()); + let result = request.send_request(&api_key).await.unwrap(); + println!("[720p] Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + + // Balance was $48.99 before running this. + // Balance is $47.83 after running this + // 116 cents = 11.6 cents per second + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_1080p() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "the dog in this photo starts running and splashing in the lake water".to_string(); + request.duration = Some(10); + request.resolution = Some(Seedance20Resolution::TenEightyP); + request.first_frame = Some(JUNO_AT_LAKE_IMAGE_URL.to_string()); + let result = request.send_request(&api_key).await.unwrap(); + println!("[1080p] Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/cost.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/cost.rs new file mode 100644 index 00000000..dee90b4c --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/cost.rs @@ -0,0 +1,162 @@ +use crate::requests::api::video::seedance_2_0_260128::api::{ + Seedance20Request, Seedance20Resolution, +}; +use crate::traits::gmicloud_request_cost_calculator_trait::{ + GmiCloudRequestCostCalculator, UsdCents, +}; + +impl GmiCloudRequestCostCalculator for Seedance20Request { + fn calculate_cost_in_cents(&self) -> UsdCents { + let duration_seconds = self.effective_duration_seconds() as u64; + + // Cost per second in US cents, by resolution. + // Observed from GmiCloud billing: + // 480p: $0.024/s = 2.4 ¢/s + // 720p: $0.052/s = 5.2 ¢/s (default) + // 1080p: $0.116/s = 11.6 ¢/s + let cents_per_second: f64 = match self.resolution { + Some(Seedance20Resolution::FourEightyP) => 2.4, + Some(Seedance20Resolution::SevenTwentyP) | None => 5.2, + Some(Seedance20Resolution::TenEightyP) => 11.6, + }; + + (cents_per_second * duration_seconds as f64).ceil() as u64 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::seedance_2_0_260128::api::Seedance20Ratio; + + fn make_request(duration: Option, resolution: Option) -> Seedance20Request { + Seedance20Request { + prompt: "test".to_string(), + duration, + resolution, + ratio: None, + seed: None, + watermark: None, + generate_audio: None, + web_search: None, + first_frame: None, + last_frame: None, + reference_images: None, + reference_videos: None, + reference_audios: None, + reference_asset_ids: None, + } + } + + mod default_resolution_tests { + use super::*; + + #[test] + fn cost_default_5s() { + // 720p: 5.2 * 5 = 26 ¢ + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 26); + } + + #[test] + fn cost_default_10s() { + // 5.2 * 10 = 52 ¢ + assert_eq!(make_request(Some(10), None).calculate_cost_in_cents(), 52); + } + + #[test] + fn cost_default_15s() { + // 5.2 * 15 = 78 ¢ + assert_eq!(make_request(Some(15), None).calculate_cost_in_cents(), 78); + } + } + + mod resolution_480p_tests { + use super::*; + + #[test] + fn cost_480p_5s() { + // 2.4 * 5 = 12 ¢ + assert_eq!(make_request(Some(5), Some(Seedance20Resolution::FourEightyP)).calculate_cost_in_cents(), 12); + } + + #[test] + fn cost_480p_10s() { + // 2.4 * 10 = 24 ¢ + assert_eq!(make_request(Some(10), Some(Seedance20Resolution::FourEightyP)).calculate_cost_in_cents(), 24); + } + + #[test] + fn cost_480p_15s() { + // 2.4 * 15 = 36 ¢ + assert_eq!(make_request(Some(15), Some(Seedance20Resolution::FourEightyP)).calculate_cost_in_cents(), 36); + } + } + + mod resolution_720p_tests { + use super::*; + + #[test] + fn cost_720p_5s() { + // 5.2 * 5 = 26 ¢ + assert_eq!(make_request(Some(5), Some(Seedance20Resolution::SevenTwentyP)).calculate_cost_in_cents(), 26); + } + + #[test] + fn cost_720p_10s() { + // 5.2 * 10 = 52 ¢ + assert_eq!(make_request(Some(10), Some(Seedance20Resolution::SevenTwentyP)).calculate_cost_in_cents(), 52); + } + + #[test] + fn cost_720p_15s() { + // 5.2 * 15 = 78 ¢ + assert_eq!(make_request(Some(15), Some(Seedance20Resolution::SevenTwentyP)).calculate_cost_in_cents(), 78); + } + } + + mod resolution_1080p_tests { + use super::*; + + #[test] + fn cost_1080p_5s() { + // 11.6 * 5 = 58 ¢ + assert_eq!(make_request(Some(5), Some(Seedance20Resolution::TenEightyP)).calculate_cost_in_cents(), 58); + } + + #[test] + fn cost_1080p_10s() { + // 11.6 * 10 = 116 ¢ + assert_eq!(make_request(Some(10), Some(Seedance20Resolution::TenEightyP)).calculate_cost_in_cents(), 116); + } + + #[test] + fn cost_1080p_15s() { + // 11.6 * 15 = 174 ¢ + assert_eq!(make_request(Some(15), Some(Seedance20Resolution::TenEightyP)).calculate_cost_in_cents(), 174); + } + } + + mod ratio_independence_tests { + use super::*; + + #[test] + fn cost_is_independent_of_ratio() { + let ratios = [ + Seedance20Ratio::Landscape16x9, + Seedance20Ratio::Portrait9x16, + Seedance20Ratio::Square, + Seedance20Ratio::Standard4x3, + Seedance20Ratio::Portrait3x4, + Seedance20Ratio::UltraWide21x9, + Seedance20Ratio::Adaptive, + ]; + let base = make_request(Some(10), Some(Seedance20Resolution::SevenTwentyP)) + .calculate_cost_in_cents(); + for ratio in ratios { + let mut request = make_request(Some(10), Some(Seedance20Resolution::SevenTwentyP)); + request.ratio = Some(ratio); + assert_eq!(request.calculate_cost_in_cents(), base, "{ratio:?}"); + } + } + } +} diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/mod.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/raw_request.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/raw_request.rs new file mode 100644 index 00000000..31f2091c --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_260128/raw_request.rs @@ -0,0 +1,59 @@ +use serde::{Deserialize, Serialize}; + +/// The payload sent inside `GmiCloudCreateRequest.payload` for seedance-2-0-260128. +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance20Payload { + pub prompt: String, + + /// Duration in seconds (4–15). Default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution: "480p", "720p", "1080p". Default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Aspect ratio: "16:9", "4:3", "1:1", "3:4", "9:16", "21:9", "adaptive". + #[serde(skip_serializing_if = "Option::is_none")] + pub ratio: Option, + + /// Random seed for reproducibility (0–4294967295). + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to embed a watermark. Default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub watermark: Option, + + /// Whether to synthesize audio. Default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Whether to enable web search grounding. Default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub web_search: Option, + + /// First frame image URL for image-to-video generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub first_frame: Option, + + /// Last frame image URL for image-to-video generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub last_frame: Option, + + /// Reference image URLs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_images: Option>, + + /// Reference video URLs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_videos: Option>, + + /// Reference audio file URLs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_audios: Option>, + + /// Pre-uploaded asset IDs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_asset_ids: Option>, +} diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/api.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/api.rs new file mode 100644 index 00000000..3d836e9f --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/api.rs @@ -0,0 +1,306 @@ +use crate::creds::gmicloud_api_key::GmiCloudApiKey; +use crate::error::gmicloud_error::GmiCloudError; +use crate::requests::api::video::seedance_2_0_fast_260128::raw_request::Seedance20FastPayload; +use crate::requests::common::create_request::{ + create_gmicloud_request, create_gmicloud_request_with_context, + GmiCloudCreateRequest, GmiCloudCreateResponse, +}; +use crate::requests::context::request_context::RequestContext; + +const MODEL_ID: &str = "seedance-2-0-fast-260128"; + +/// User-facing request for the Seedance 2.0 Fast model via GmiCloud. +#[derive(Clone, Debug)] +pub struct Seedance20FastRequest { + /// Text prompt describing the video to generate. Required. + pub prompt: String, + + /// Video duration in seconds (4–15). Default: 5. + pub duration: Option, + + /// Output resolution. + pub resolution: Option, + + /// Aspect ratio of the output video. + pub ratio: Option, + + /// Random seed for reproducibility (0–4294967295). + pub seed: Option, + + /// Whether to embed a watermark. Default: false. + pub watermark: Option, + + /// Whether to synthesize audio. Default: true. + pub generate_audio: Option, + + /// Whether to enable web search grounding. Default: false. + pub web_search: Option, + + /// First frame image URL for image-to-video generation. + pub first_frame: Option, + + /// Last frame image URL for image-to-video generation. + pub last_frame: Option, + + /// Reference image URLs. + pub reference_images: Option>, + + /// Reference video URLs. + pub reference_videos: Option>, + + /// Reference audio file URLs. + pub reference_audios: Option>, + + /// Pre-uploaded asset IDs. + pub reference_asset_ids: Option>, +} + +#[derive(Copy, Clone, Debug, PartialEq)] +pub enum Seedance20FastResolution { + FourEightyP, + SevenTwentyP, +} + +#[derive(Copy, Clone, Debug, PartialEq)] +pub enum Seedance20FastRatio { + /// 16:9 (landscape) + Landscape16x9, + /// 4:3 + Standard4x3, + /// 1:1 (square) + Square, + /// 3:4 + Portrait3x4, + /// 9:16 (portrait) + Portrait9x16, + /// 21:9 (ultra-wide) + UltraWide21x9, + /// Adaptive (inferred from input) + Adaptive, +} + +impl Seedance20FastRequest { + pub fn to_raw_payload(&self) -> Seedance20FastPayload { + Seedance20FastPayload { + prompt: self.prompt.clone(), + duration: self.duration, + resolution: self.resolution.map(|r| match r { + Seedance20FastResolution::FourEightyP => "480p", + Seedance20FastResolution::SevenTwentyP => "720p", + }.to_string()), + ratio: self.ratio.map(|r| match r { + Seedance20FastRatio::Landscape16x9 => "16:9", + Seedance20FastRatio::Standard4x3 => "4:3", + Seedance20FastRatio::Square => "1:1", + Seedance20FastRatio::Portrait3x4 => "3:4", + Seedance20FastRatio::Portrait9x16 => "9:16", + Seedance20FastRatio::UltraWide21x9 => "21:9", + Seedance20FastRatio::Adaptive => "adaptive", + }.to_string()), + seed: self.seed, + watermark: self.watermark, + generate_audio: self.generate_audio, + web_search: self.web_search, + first_frame: self.first_frame.clone(), + last_frame: self.last_frame.clone(), + reference_images: self.reference_images.clone(), + reference_videos: self.reference_videos.clone(), + reference_audios: self.reference_audios.clone(), + reference_asset_ids: self.reference_asset_ids.clone(), + } + } + + pub async fn send_request( + &self, + api_key: &GmiCloudApiKey, + ) -> Result { + let context = RequestContext { + api_key, + maybe_timeout: None, + }; + self.send_request_with_context(&context).await + } + + pub async fn send_request_with_context( + &self, + context: &RequestContext<'_>, + ) -> Result { + let body = GmiCloudCreateRequest { + model: MODEL_ID.to_string(), + payload: self.to_raw_payload(), + }; + create_gmicloud_request_with_context(context, &body).await + } + + pub fn model_id() -> &'static str { + MODEL_ID + } + + /// The effective duration in seconds for cost calculation. + pub fn effective_duration_seconds(&self) -> u8 { + self.duration.unwrap_or(5) + } +} + +fn minimal_request() -> Seedance20FastRequest { + Seedance20FastRequest { + prompt: "test".to_string(), + duration: None, + resolution: None, + ratio: None, + seed: None, + watermark: None, + generate_audio: None, + web_search: None, + first_frame: None, + last_frame: None, + reference_images: None, + reference_videos: None, + reference_audios: None, + reference_asset_ids: None, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod raw_payload_tests { + use super::*; + + #[test] + fn minimal_request_serializes_only_prompt() { + let request = minimal_request(); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["prompt"], "test"); + assert!(json.get("duration").is_none()); + assert!(json.get("resolution").is_none()); + assert!(json.get("ratio").is_none()); + } + + #[test] + fn full_request_serializes_all_fields() { + let request = Seedance20FastRequest { + prompt: "a cat sitting on a windowsill".to_string(), + duration: Some(10), + resolution: Some(Seedance20FastResolution::SevenTwentyP), + ratio: Some(Seedance20FastRatio::Portrait9x16), + seed: Some(123), + watermark: Some(true), + generate_audio: Some(false), + web_search: Some(true), + first_frame: Some("https://example.com/first.png".to_string()), + last_frame: Some("https://example.com/last.png".to_string()), + reference_images: Some(vec!["https://example.com/ref.png".to_string()]), + reference_videos: Some(vec!["https://example.com/ref.mp4".to_string()]), + reference_audios: Some(vec!["https://example.com/ref.wav".to_string()]), + reference_asset_ids: Some(vec!["asset_456".to_string()]), + }; + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["prompt"], "a cat sitting on a windowsill"); + assert_eq!(json["duration"], 10); + assert_eq!(json["resolution"], "720p"); + assert_eq!(json["ratio"], "9:16"); + assert_eq!(json["seed"], 123); + assert_eq!(json["watermark"], true); + assert_eq!(json["generate_audio"], false); + assert_eq!(json["web_search"], true); + assert_eq!(json["first_frame"], "https://example.com/first.png"); + assert_eq!(json["last_frame"], "https://example.com/last.png"); + } + + #[test] + fn all_ratios_serialize() { + let cases = [ + (Seedance20FastRatio::Landscape16x9, "16:9"), + (Seedance20FastRatio::Standard4x3, "4:3"), + (Seedance20FastRatio::Square, "1:1"), + (Seedance20FastRatio::Portrait3x4, "3:4"), + (Seedance20FastRatio::Portrait9x16, "9:16"), + (Seedance20FastRatio::UltraWide21x9, "21:9"), + (Seedance20FastRatio::Adaptive, "adaptive"), + ]; + for (ratio, expected) in cases { + let mut request = minimal_request(); + request.ratio = Some(ratio); + let json = serde_json::to_value(&request.to_raw_payload()).unwrap(); + assert_eq!(json["ratio"], expected, "{ratio:?}"); + } + } + + #[test] + fn create_request_body_shape() { + let mut request = minimal_request(); + request.duration = Some(5); + request.ratio = Some(Seedance20FastRatio::Square); + let body = GmiCloudCreateRequest { + model: Seedance20FastRequest::model_id().to_string(), + payload: request.to_raw_payload(), + }; + let json = serde_json::to_value(&body).unwrap(); + assert_eq!(json["model"], "seedance-2-0-fast-260128"); + assert_eq!(json["payload"]["prompt"], "test"); + assert_eq!(json["payload"]["duration"], 5); + assert_eq!(json["payload"]["ratio"], "1:1"); + } + } + + mod live_api_tests { + use super::*; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_text_to_video() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "a golden retriever puppy playing in autumn leaves".to_string(); + request.duration = Some(5); + request.ratio = Some(Seedance20FastRatio::Landscape16x9); + let result = request.send_request(&api_key).await.unwrap(); + println!("Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + + // $47.83 before run + // [fast 480p] Request ID: 1b654a85-d99e-4380-b615-c7a8985ed15b + // $47.73 after run + // $0.10 = $0.01 per second + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_480p() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "the dog in this photo starts running and splashing in the lake water".to_string(); + request.duration = Some(10); + request.resolution = Some(Seedance20FastResolution::FourEightyP); + request.first_frame = Some(JUNO_AT_LAKE_IMAGE_URL.to_string()); + let result = request.send_request(&api_key).await.unwrap(); + println!("[fast 480p] Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + + // $47.73 before run + // [fast 720p] Request ID: 2fbbe377-7c92-482e-b1eb-92fd296b0a68 + // $47.52 after run + // $0.31 = $0.031 per second + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_720p() { + let api_key = crate::test_utils::load_api_key(); + let mut request = minimal_request(); + request.prompt = "the dog in this photo starts running and splashing in the lake water".to_string(); + request.duration = Some(10); + request.resolution = Some(Seedance20FastResolution::SevenTwentyP); + request.first_frame = Some(JUNO_AT_LAKE_IMAGE_URL.to_string()); + let result = request.send_request(&api_key).await.unwrap(); + println!("[fast 720p] Request ID: {}", result.request_id); + assert!(!result.request_id.is_empty()); + assert_eq!(result.model, MODEL_ID); + } + } + + // NB: Pricing tests are in cost.rs +} diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/cost.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/cost.rs new file mode 100644 index 00000000..74517199 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/cost.rs @@ -0,0 +1,185 @@ +use crate::requests::api::video::seedance_2_0_fast_260128::api::{ + Seedance20FastRequest, Seedance20FastResolution, +}; +use crate::traits::gmicloud_request_cost_calculator_trait::{ + GmiCloudRequestCostCalculator, UsdCents, +}; + +impl GmiCloudRequestCostCalculator for Seedance20FastRequest { + fn calculate_cost_in_cents(&self) -> UsdCents { + let duration_seconds = self.effective_duration_seconds() as u64; + + // Cost per second in US cents, by resolution. + // Observed from GmiCloud billing: + // 480p: $0.01/s = 1.0 ¢/s + // 720p: $0.031/s = 3.1 ¢/s (default) + let cents_per_second: f64 = match self.resolution { + Some(Seedance20FastResolution::FourEightyP) => 1.0, + Some(Seedance20FastResolution::SevenTwentyP) | None => 3.1, + }; + + (cents_per_second * duration_seconds as f64).ceil() as u64 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::requests::api::video::seedance_2_0_fast_260128::api::Seedance20FastRatio; + + fn make_request(duration: Option, resolution: Option) -> Seedance20FastRequest { + Seedance20FastRequest { + prompt: "test".to_string(), + duration, + resolution, + ratio: None, + seed: None, + watermark: None, + generate_audio: None, + web_search: None, + first_frame: None, + last_frame: None, + reference_images: None, + reference_videos: None, + reference_audios: None, + reference_asset_ids: None, + } + } + + mod default_resolution_tests { + use super::*; + + #[test] + fn cost_default_5s() { + // 720p: 3.1 * 5 = 15.5 → ceil = 16¢ + assert_eq!(make_request(None, None).calculate_cost_in_cents(), 16); + } + + #[test] + fn cost_default_10s() { + // 3.1 * 10 = 31¢ + assert_eq!(make_request(Some(10), None).calculate_cost_in_cents(), 31); + } + + #[test] + fn cost_default_15s() { + // 3.1 * 15 = 46.5 → ceil = 47¢ + assert_eq!(make_request(Some(15), None).calculate_cost_in_cents(), 47); + } + } + + mod resolution_480p_tests { + use super::*; + + #[test] + fn cost_480p_5s() { + // 1.0 * 5 = 5¢ + assert_eq!(make_request(Some(5), Some(Seedance20FastResolution::FourEightyP)).calculate_cost_in_cents(), 5); + } + + #[test] + fn cost_480p_10s() { + // 1.0 * 10 = 10¢ + assert_eq!(make_request(Some(10), Some(Seedance20FastResolution::FourEightyP)).calculate_cost_in_cents(), 10); + } + + #[test] + fn cost_480p_15s() { + // 1.0 * 15 = 15¢ + assert_eq!(make_request(Some(15), Some(Seedance20FastResolution::FourEightyP)).calculate_cost_in_cents(), 15); + } + } + + mod resolution_720p_tests { + use super::*; + + #[test] + fn cost_720p_5s() { + // 3.1 * 5 = 15.5 → ceil = 16¢ + assert_eq!(make_request(Some(5), Some(Seedance20FastResolution::SevenTwentyP)).calculate_cost_in_cents(), 16); + } + + #[test] + fn cost_720p_10s() { + // 3.1 * 10 = 31¢ + assert_eq!(make_request(Some(10), Some(Seedance20FastResolution::SevenTwentyP)).calculate_cost_in_cents(), 31); + } + + #[test] + fn cost_720p_15s() { + // 3.1 * 15 = 46.5 → ceil = 47¢ + assert_eq!(make_request(Some(15), Some(Seedance20FastResolution::SevenTwentyP)).calculate_cost_in_cents(), 47); + } + } + + mod ratio_independence_tests { + use super::*; + + #[test] + fn cost_is_independent_of_ratio() { + let ratios = [ + Seedance20FastRatio::Landscape16x9, + Seedance20FastRatio::Portrait9x16, + Seedance20FastRatio::Square, + Seedance20FastRatio::Standard4x3, + Seedance20FastRatio::Portrait3x4, + Seedance20FastRatio::UltraWide21x9, + Seedance20FastRatio::Adaptive, + ]; + let base = make_request(Some(10), Some(Seedance20FastResolution::SevenTwentyP)) + .calculate_cost_in_cents(); + for ratio in ratios { + let mut request = make_request(Some(10), Some(Seedance20FastResolution::SevenTwentyP)); + request.ratio = Some(ratio); + assert_eq!(request.calculate_cost_in_cents(), base, "{ratio:?}"); + } + } + } + + mod comparison_tests { + use super::*; + + #[test] + fn fast_is_cheaper_than_standard_at_720p() { + use crate::requests::api::video::seedance_2_0_260128::api::{ + Seedance20Request, Seedance20Resolution, + }; + use crate::traits::gmicloud_request_cost_calculator_trait::GmiCloudRequestCostCalculator; + + let standard = Seedance20Request { + prompt: "test".to_string(), + duration: Some(10), + resolution: Some(Seedance20Resolution::SevenTwentyP), + ratio: None, + seed: None, + watermark: None, + generate_audio: None, + web_search: None, + first_frame: None, + last_frame: None, + reference_images: None, + reference_videos: None, + reference_audios: None, + reference_asset_ids: None, + }; + + let fast = make_request(Some(10), Some(Seedance20FastResolution::SevenTwentyP)); + + assert!( + fast.calculate_cost_in_cents() < standard.calculate_cost_in_cents(), + "Fast 720p ({}¢) should be cheaper than Standard 720p ({}¢)", + fast.calculate_cost_in_cents(), + standard.calculate_cost_in_cents(), + ); + } + + #[test] + fn higher_resolution_costs_more() { + let cost_480 = make_request(Some(10), Some(Seedance20FastResolution::FourEightyP)) + .calculate_cost_in_cents(); + let cost_720 = make_request(Some(10), Some(Seedance20FastResolution::SevenTwentyP)) + .calculate_cost_in_cents(); + assert!(cost_480 < cost_720, "480p ({}¢) should be cheaper than 720p ({}¢)", cost_480, cost_720); + } + } +} diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/mod.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/mod.rs new file mode 100644 index 00000000..a0a589f2 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/mod.rs @@ -0,0 +1,3 @@ +pub mod api; +mod raw_request; +mod cost; diff --git a/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/raw_request.rs b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/raw_request.rs new file mode 100644 index 00000000..c6ebf342 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/api/video/seedance_2_0_fast_260128/raw_request.rs @@ -0,0 +1,59 @@ +use serde::{Deserialize, Serialize}; + +/// The payload sent inside `GmiCloudCreateRequest.payload` for seedance-2-0-fast-260128. +#[derive(Debug, Serialize, Deserialize)] +pub struct Seedance20FastPayload { + pub prompt: String, + + /// Duration in seconds (4–15). Default: 5. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution: "480p", "720p", "1080p". Default: "720p". + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Aspect ratio: "16:9", "4:3", "1:1", "3:4", "9:16", "21:9", "adaptive". + #[serde(skip_serializing_if = "Option::is_none")] + pub ratio: Option, + + /// Random seed for reproducibility (0–4294967295). + #[serde(skip_serializing_if = "Option::is_none")] + pub seed: Option, + + /// Whether to embed a watermark. Default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub watermark: Option, + + /// Whether to synthesize audio. Default: true. + #[serde(skip_serializing_if = "Option::is_none")] + pub generate_audio: Option, + + /// Whether to enable web search grounding. Default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub web_search: Option, + + /// First frame image URL for image-to-video generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub first_frame: Option, + + /// Last frame image URL for image-to-video generation. + #[serde(skip_serializing_if = "Option::is_none")] + pub last_frame: Option, + + /// Reference image URLs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_images: Option>, + + /// Reference video URLs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_videos: Option>, + + /// Reference audio file URLs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_audios: Option>, + + /// Pre-uploaded asset IDs. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_asset_ids: Option>, +} diff --git a/crates/api_clients/gmicloud_client/src/requests/common/create_request.rs b/crates/api_clients/gmicloud_client/src/requests/common/create_request.rs new file mode 100644 index 00000000..bdbe8912 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/common/create_request.rs @@ -0,0 +1,117 @@ +use std::time::Duration; + +use log::warn; +use serde::{Deserialize, Serialize}; + +use crate::creds::gmicloud_api_key::GmiCloudApiKey; +use crate::error::gmicloud_error::GmiCloudError; +use crate::error::gmicloud_generic_api_error::GmiCloudGenericApiError; +use crate::error::gmicloud_specific_api_error::GmiCloudSpecificApiError; +use crate::requests::context::request_context::RequestContext; + +const BASE_URL: &str = "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey"; + +/// Default request timeout. Video requests return quickly (async queue), +/// but image requests block until completion and can take 60+ seconds. +const DEFAULT_TIMEOUT: Duration = Duration::from_secs(180); + +/// The top-level request body sent to `POST /requests`. +#[derive(Debug, Serialize)] +pub struct GmiCloudCreateRequest { + pub model: String, + pub payload: P, +} + +/// The response from `POST /requests`. +#[derive(Debug, Deserialize)] +pub struct GmiCloudCreateResponse { + pub request_id: String, + pub model: String, + pub status: String, +} + +/// Submit a request to GmiCloud using just an API key (default timeout). +pub async fn create_gmicloud_request( + api_key: &GmiCloudApiKey, + body: &GmiCloudCreateRequest

, +) -> Result { + let context = RequestContext { + api_key, + maybe_timeout: None, + }; + create_gmicloud_request_with_context(&context, body).await +} + +/// Submit a request to GmiCloud with explicit context (custom timeout, etc.). +pub async fn create_gmicloud_request_with_context( + context: &RequestContext<'_>, + body: &GmiCloudCreateRequest

, +) -> Result { + let url = format!("{}/requests", BASE_URL); + let timeout = context.maybe_timeout.unwrap_or(DEFAULT_TIMEOUT); + + let client = reqwest::Client::builder() + .timeout(timeout) + .build() + .map_err(GmiCloudGenericApiError::from)?; + + let response = client + .post(&url) + .header("Authorization", format!("Bearer {}", context.api_key.as_str())) + .json(body) + .send() + .await + .map_err(GmiCloudGenericApiError::from)?; + + let status = response.status(); + let body_text = response.text().await + .map_err(GmiCloudGenericApiError::from)?; + + if status == reqwest::StatusCode::UNAUTHORIZED { + return Err(GmiCloudSpecificApiError::Unauthorized.into()); + } + + if !status.is_success() { + warn!("GmiCloud API error: status={}, body={}", status, body_text); + + // Detect specific error codes embedded in the response body. + if let Some(specific) = classify_error_body(&body_text) { + return Err(specific.into()); + } + + return Err(GmiCloudGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status.as_u16(), + body: body_text, + }.into()); + } + + let parsed: GmiCloudCreateResponse = serde_json::from_str(&body_text) + .map_err(|err| GmiCloudGenericApiError::SerdeResponseParseErrorWithBody(err, body_text))?; + + Ok(parsed) +} + +/// Attempt to classify an error response body into a specific error type. +/// GmiCloud sometimes wraps inner API errors as a JSON string within `{"error": "..."}`. +fn classify_error_body(body: &str) -> Option { + if body.contains("InputImageSensitiveContentDetected") { + let message = extract_inner_message(body) + .unwrap_or_else(|| "Input image may contain a real person".to_string()); + return Some(GmiCloudSpecificApiError::ContentContainsRealPerson(message)); + } + None +} + +/// Extract the inner `message` field from a doubly-encoded GmiCloud error response. +/// Expected shape: `{"error":"API request failed with status 400: {\"error\":{\"message\":\"...\"}}"}` +fn extract_inner_message(body: &str) -> Option { + let outer: serde_json::Value = serde_json::from_str(body).ok()?; + let error_str = outer.get("error")?.as_str()?; + + // The inner JSON is embedded after "status NNN: " + let inner_json_start = error_str.find('{')?; + let inner_str = &error_str[inner_json_start..]; + let inner: serde_json::Value = serde_json::from_str(inner_str).ok()?; + + inner.get("error")?.get("message")?.as_str().map(|s| s.to_string()) +} diff --git a/crates/api_clients/gmicloud_client/src/requests/common/mod.rs b/crates/api_clients/gmicloud_client/src/requests/common/mod.rs new file mode 100644 index 00000000..4d39c7e4 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/common/mod.rs @@ -0,0 +1 @@ +pub mod create_request; diff --git a/crates/api_clients/gmicloud_client/src/requests/context/mod.rs b/crates/api_clients/gmicloud_client/src/requests/context/mod.rs new file mode 100644 index 00000000..c5c6f6fa --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/context/mod.rs @@ -0,0 +1 @@ +pub mod request_context; diff --git a/crates/api_clients/gmicloud_client/src/requests/context/request_context.rs b/crates/api_clients/gmicloud_client/src/requests/context/request_context.rs new file mode 100644 index 00000000..a3af8291 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/context/request_context.rs @@ -0,0 +1,8 @@ +use std::time::Duration; + +use crate::creds::gmicloud_api_key::GmiCloudApiKey; + +pub struct RequestContext<'a> { + pub api_key: &'a GmiCloudApiKey, + pub maybe_timeout: Option, +} diff --git a/crates/api_clients/gmicloud_client/src/requests/mod.rs b/crates/api_clients/gmicloud_client/src/requests/mod.rs new file mode 100644 index 00000000..b698f1a5 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/mod.rs @@ -0,0 +1,4 @@ +pub mod api; +pub mod common; +pub mod context; +pub mod poll_request_queue; diff --git a/crates/api_clients/gmicloud_client/src/requests/poll_request_queue/mod.rs b/crates/api_clients/gmicloud_client/src/requests/poll_request_queue/mod.rs new file mode 100644 index 00000000..ee008f24 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/poll_request_queue/mod.rs @@ -0,0 +1 @@ +pub mod poll_request_queue; diff --git a/crates/api_clients/gmicloud_client/src/requests/poll_request_queue/poll_request_queue.rs b/crates/api_clients/gmicloud_client/src/requests/poll_request_queue/poll_request_queue.rs new file mode 100644 index 00000000..551b5d78 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/requests/poll_request_queue/poll_request_queue.rs @@ -0,0 +1,281 @@ +use log::warn; +use serde::Deserialize; + +use crate::creds::gmicloud_api_key::GmiCloudApiKey; +use crate::error::gmicloud_error::GmiCloudError; +use crate::error::gmicloud_generic_api_error::GmiCloudGenericApiError; +use crate::error::gmicloud_specific_api_error::GmiCloudSpecificApiError; + +const BASE_URL: &str = "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey"; + +/// The response from `GET /requests/{request_id}`. +#[derive(Debug, Deserialize)] +pub struct GmiCloudPollResponse { + pub request_id: String, + pub org_id: Option, + pub user_id: Option, + pub model: String, + pub status: String, + pub is_public: Option, + pub payload: Option, + pub outcome: Option, + pub created_at: Option, + pub updated_at: Option, + pub queued_at: Option, +} + +/// The outcome of a completed request. +#[derive(Debug, Deserialize, PartialEq)] +pub struct GmiCloudOutcome { + pub video_url: Option, + pub thumbnail_image_url: Option, +} + +impl GmiCloudPollResponse { + /// Whether the request has completed successfully. + pub fn is_success(&self) -> bool { + self.status == "success" + } + + /// Whether the request is still in progress (dispatched or processing). + pub fn is_in_progress(&self) -> bool { + self.status == "dispatched" || self.status == "processing" + } + + /// Whether the request has failed. + pub fn is_failed(&self) -> bool { + self.status == "failed" + } + + /// Get the video URL if the request completed successfully. + pub fn video_url(&self) -> Option<&str> { + self.outcome.as_ref()?.video_url.as_deref() + } + + /// Get the thumbnail URL if the request completed successfully. + pub fn thumbnail_url(&self) -> Option<&str> { + self.outcome.as_ref()?.thumbnail_image_url.as_deref() + } +} + +/// Poll the status of a GmiCloud request. +pub async fn poll_gmicloud_request( + api_key: &GmiCloudApiKey, + request_id: &str, +) -> Result { + let url = format!("{}/requests/{}", BASE_URL, request_id); + + let client = reqwest::Client::new(); + let response = client + .get(&url) + .header("Authorization", format!("Bearer {}", api_key.as_str())) + .send() + .await + .map_err(GmiCloudGenericApiError::from)?; + + let status = response.status(); + let body_text = response.text().await + .map_err(GmiCloudGenericApiError::from)?; + + if status == reqwest::StatusCode::UNAUTHORIZED { + return Err(GmiCloudSpecificApiError::Unauthorized.into()); + } + + if !status.is_success() { + warn!("GmiCloud poll error: status={}, body={}", status, body_text); + return Err(GmiCloudGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status.as_u16(), + body: body_text, + }.into()); + } + + let parsed: GmiCloudPollResponse = serde_json::from_str(&body_text) + .map_err(|err| GmiCloudGenericApiError::SerdeResponseParseErrorWithBody(err, body_text))?; + + Ok(parsed) +} + +#[cfg(test)] +mod tests { + use super::*; + + mod deserialization_tests { + use super::*; + + #[test] + fn deserialize_success_response() { + let json = r#"{ + "request_id": "40f63632-dd9d-4725-ab73-5bb764e773be", + "org_id": "3e7939ae-467e-4c5d-ae35-fd6097cee454", + "user_id": "07e393c5-f2f1-45fe-8838-cc4046837693", + "model": "seedance-2-0-260128", + "status": "success", + "is_public": false, + "payload": { + "duration": 10, + "first_frame": "https://example.com/image.jpg", + "prompt": "a dog running", + "resolution": "720p" + }, + "outcome": { + "thumbnail_image_url": "https://example.com/thumb.jpg", + "video_url": "https://example.com/video.mp4" + }, + "created_at": 1778928208, + "updated_at": 1778928397, + "queued_at": 1778928208 + }"#; + + let response: GmiCloudPollResponse = serde_json::from_str(json).unwrap(); + assert_eq!(response.request_id, "40f63632-dd9d-4725-ab73-5bb764e773be"); + assert_eq!(response.model, "seedance-2-0-260128"); + assert!(response.is_success()); + assert!(!response.is_in_progress()); + assert!(!response.is_failed()); + assert_eq!(response.video_url(), Some("https://example.com/video.mp4")); + assert_eq!(response.thumbnail_url(), Some("https://example.com/thumb.jpg")); + assert_eq!(response.created_at, Some(1778928208)); + assert_eq!(response.updated_at, Some(1778928397)); + } + + #[test] + fn deserialize_processing_response() { + let json = r#"{ + "request_id": "6fb2b474-fb3a-480f-a142-f200537c6de4", + "org_id": "63729242-1870-4ff4-80b0-d485980ae31c", + "model": "seedance-2-0-260128", + "status": "processing", + "is_public": false, + "payload": { + "prompt": "a dog running", + "duration": 5 + }, + "outcome": null, + "created_at": 1753468514, + "updated_at": 1753468514, + "queued_at": 1753468514 + }"#; + + let response: GmiCloudPollResponse = serde_json::from_str(json).unwrap(); + assert!(!response.is_success()); + assert!(response.is_in_progress()); + assert!(!response.is_failed()); + assert_eq!(response.video_url(), None); + assert_eq!(response.outcome, None); + } + + #[test] + fn deserialize_dispatched_response() { + let json = r#"{ + "request_id": "abc", + "model": "seedance-2-0-fast-260128", + "status": "dispatched", + "outcome": null + }"#; + + let response: GmiCloudPollResponse = serde_json::from_str(json).unwrap(); + assert!(response.is_in_progress()); + assert!(!response.is_success()); + } + + #[test] + fn deserialize_failed_response() { + let json = r#"{ + "request_id": "abc", + "model": "seedance-2-0-260128", + "status": "failed", + "outcome": null + }"#; + + let response: GmiCloudPollResponse = serde_json::from_str(json).unwrap(); + assert!(response.is_failed()); + assert!(!response.is_success()); + assert!(!response.is_in_progress()); + } + } + + mod live_api_tests { + use super::*; + + // seedance-2-0-260128, 10s 720p, image-to-video + #[tokio::test] + #[ignore] // requires real API key + async fn poll_seedance_20_720p() { + let api_key = crate::test_utils::load_api_key(); + let response = poll_gmicloud_request(&api_key, "40f63632-dd9d-4725-ab73-5bb764e773be") + .await.unwrap(); + + assert_eq!(response.request_id, "40f63632-dd9d-4725-ab73-5bb764e773be"); + assert_eq!(response.model, "seedance-2-0-260128"); + assert!(response.is_success()); + + let payload = response.payload.as_ref().unwrap(); + assert_eq!(payload["prompt"], "the dog in this photo starts running and splashing in the lake water"); + assert_eq!(payload["duration"], 10); + assert_eq!(payload["resolution"], "720p"); + assert!(payload["first_frame"].as_str().unwrap().contains("svcpp441gyb6mjtt8413kf5zxw1ehy4t")); + + assert!(response.video_url().unwrap().ends_with(".mp4")); + } + + // seedance-2-0-260128, 10s 480p, image-to-video + #[tokio::test] + #[ignore] // requires real API key + async fn poll_seedance_20_480p() { + let api_key = crate::test_utils::load_api_key(); + let response = poll_gmicloud_request(&api_key, "4a0efe0d-990f-480d-9792-5bb71dd26b85") + .await.unwrap(); + + assert_eq!(response.request_id, "4a0efe0d-990f-480d-9792-5bb71dd26b85"); + assert_eq!(response.model, "seedance-2-0-260128"); + assert!(response.is_success()); + + let payload = response.payload.as_ref().unwrap(); + assert_eq!(payload["prompt"], "the dog in this photo starts running and splashing in the lake water"); + assert_eq!(payload["duration"], 10); + assert_eq!(payload["resolution"], "480p"); + + assert!(response.video_url().unwrap().ends_with(".mp4")); + } + + // seedance-2-0-fast-260128, 10s 720p, image-to-video + #[tokio::test] + #[ignore] // requires real API key + async fn poll_seedance_20_fast_720p() { + let api_key = crate::test_utils::load_api_key(); + let response = poll_gmicloud_request(&api_key, "2fbbe377-7c92-482e-b1eb-92fd296b0a68") + .await.unwrap(); + + assert_eq!(response.request_id, "2fbbe377-7c92-482e-b1eb-92fd296b0a68"); + assert_eq!(response.model, "seedance-2-0-fast-260128"); + assert!(response.is_success()); + + let payload = response.payload.as_ref().unwrap(); + assert_eq!(payload["prompt"], "the dog in this photo starts running and splashing in the lake water"); + assert_eq!(payload["duration"], 10); + assert_eq!(payload["resolution"], "720p"); + + assert!(response.video_url().unwrap().ends_with(".mp4")); + } + + // seedance-2-0-fast-260128, 10s 480p, image-to-video + #[tokio::test] + #[ignore] // requires real API key + async fn poll_seedance_20_fast_480p() { + let api_key = crate::test_utils::load_api_key(); + let response = poll_gmicloud_request(&api_key, "1b654a85-d99e-4380-b615-c7a8985ed15b") + .await.unwrap(); + + assert_eq!(response.request_id, "1b654a85-d99e-4380-b615-c7a8985ed15b"); + assert_eq!(response.model, "seedance-2-0-fast-260128"); + assert!(response.is_success()); + + let payload = response.payload.as_ref().unwrap(); + assert_eq!(payload["prompt"], "the dog in this photo starts running and splashing in the lake water"); + assert_eq!(payload["duration"], 10); + assert_eq!(payload["resolution"], "480p"); + + assert!(response.video_url().unwrap().ends_with(".mp4")); + } + } +} diff --git a/crates/api_clients/gmicloud_client/src/test_utils/mod.rs b/crates/api_clients/gmicloud_client/src/test_utils/mod.rs new file mode 100644 index 00000000..8749608c --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/test_utils/mod.rs @@ -0,0 +1,10 @@ +use crate::creds::gmicloud_api_key::GmiCloudApiKey; +use std::fs::read_to_string; + +const API_KEY_PATH: &str = "/Users/bt/Artcraft/credentials/gmicloud_api_key.txt"; + +pub fn load_api_key() -> GmiCloudApiKey { + let secret = read_to_string(API_KEY_PATH) + .expect("Failed to read GmiCloud API key file"); + GmiCloudApiKey::from_str(&secret) +} diff --git a/crates/api_clients/gmicloud_client/src/traits/gmicloud_request_cost_calculator_trait.rs b/crates/api_clients/gmicloud_client/src/traits/gmicloud_request_cost_calculator_trait.rs new file mode 100644 index 00000000..ad5b8cd1 --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/traits/gmicloud_request_cost_calculator_trait.rs @@ -0,0 +1,7 @@ +/// Cost in US cents (1¢ = 1 unit). +pub type UsdCents = u64; + +/// Implemented on request types to estimate the cost of a GmiCloud API call. +pub trait GmiCloudRequestCostCalculator { + fn calculate_cost_in_cents(&self) -> UsdCents; +} diff --git a/crates/api_clients/gmicloud_client/src/traits/mod.rs b/crates/api_clients/gmicloud_client/src/traits/mod.rs new file mode 100644 index 00000000..b6a09dfd --- /dev/null +++ b/crates/api_clients/gmicloud_client/src/traits/mod.rs @@ -0,0 +1 @@ +pub mod gmicloud_request_cost_calculator_trait; diff --git a/crates/api_clients/grok_api_client/Cargo.toml b/crates/api_clients/grok_api_client/Cargo.toml new file mode 100644 index 00000000..a22a2c60 --- /dev/null +++ b/crates/api_clients/grok_api_client/Cargo.toml @@ -0,0 +1,34 @@ +[package] +name = "grok_api_client" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "grok_api_client" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true + +# External +log.workspace = true +# `multipart` is enabled on top of the workspace feature set so we can use +# `reqwest::multipart` for POST /v1/files uploads. +reqwest = { workspace = true, features = ["multipart"] } +serde.workspace = true +serde_derive.workspace = true +serde_json.workspace = true + +[dev-dependencies] +anyhow.workspace = true +env_logger.workspace = true +test_data.workspace = true +tokio = { version = "1", features = ["full"] } diff --git a/crates/api_clients/grok_api_client/src/api/mod.rs b/crates/api_clients/grok_api_client/src/api/mod.rs new file mode 100644 index 00000000..1b24f16c --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/mod.rs @@ -0,0 +1,3 @@ +pub mod requests; +pub mod traits; +pub mod types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/delete_file.rs b/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/delete_file.rs new file mode 100644 index 00000000..ac4aa039 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/delete_file.rs @@ -0,0 +1,115 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::files::delete_file::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`delete_file`]. Borrows the API key separately from +/// the request body so callers can log/save [`DeleteFileRequest`] without +/// leaking the credential. +#[derive(Clone, Debug)] +pub struct DeleteFileArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: DeleteFileRequest, +} + +/// The material part of a delete-file request. Derives [`Serialize`]. +#[derive(Clone, Debug, Serialize)] +pub struct DeleteFileRequest { + pub file_id: String, +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct DeleteFileSuccess { + pub file_id: Option, + /// Should be `true` after a successful delete. + pub deleted: bool, +} + +// ── Implementation ── + +/// DELETE https://api.x.ai/v1/files/{file_id} — delete a previously-uploaded +/// file. After deletion the `file_id` becomes invalid and cannot be +/// referenced in further requests. +/// +/// Docs: +pub async fn delete_file(args: DeleteFileArgs<'_>) -> Result { + let req = args.request; + let url = format!("{}/v1/files/{}", XAI_API_BASE_URL, req.file_id); + + info!("Grok delete_file: file_id={}", req.file_id); + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.delete(&url) + .header("Authorization", bearer) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok delete_file response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: DeleteFileResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(DeleteFileSuccess { + file_id: parsed.id, + deleted: parsed.deleted.unwrap_or(false), + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn response_body_deserializes_success() { + // serde drops the `object` field on parse; only `id` and `deleted` are + // load-bearing for our DTO. + let json = r#"{ "id": "file_abc", "object": "file", "deleted": true }"#; + let parsed: DeleteFileResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.id.as_deref(), Some("file_abc")); + assert_eq!(parsed.deleted, Some(true)); + } + + #[test] + fn response_body_deserializes_minimal() { + // xAI may omit some fields; only `deleted` is load-bearing. + let json = r#"{ "deleted": true }"#; + let parsed: DeleteFileResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.deleted, Some(true)); + assert!(parsed.id.is_none()); + } + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = DeleteFileArgs { + api_key: &key, + request: DeleteFileRequest { file_id: "file_abc".to_string() }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak")); + assert!(json.contains("\"file_id\":\"file_abc\"")); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/mod.rs new file mode 100644 index 00000000..d909d0ba --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/mod.rs @@ -0,0 +1,2 @@ +pub mod delete_file; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/request_types.rs new file mode 100644 index 00000000..b88ed7ef --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/delete_file/request_types.rs @@ -0,0 +1,12 @@ +use serde_derive::Deserialize; + +/// Response shape for DELETE /v1/files/{file_id}. +/// +/// Docs: +#[derive(Deserialize, Debug, Clone)] +pub(crate) struct DeleteFileResponseBody { + pub id: Option, + + /// xAI returns `true` on a successful delete. + pub deleted: Option, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/download_file/download_file.rs b/crates/api_clients/grok_api_client/src/api/requests/files/download_file/download_file.rs new file mode 100644 index 00000000..5b25990e --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/download_file/download_file.rs @@ -0,0 +1,144 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`download_file`]. Borrows the API key separately +/// from the request body so callers can log/save [`DownloadFileRequest`] +/// without leaking the credential. +#[derive(Clone, Debug)] +pub struct DownloadFileArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: DownloadFileRequest, +} + +/// The material part of a download-file request. Derives [`Serialize`]. +#[derive(Clone, Debug, Serialize)] +pub struct DownloadFileRequest { + pub file_id: String, + + /// Optional `?format=` query — `"original"` returns the bytes as uploaded; + /// `"text"` returns a textual transcription where applicable. Omit for the + /// xAI default. + #[serde(skip_serializing_if = "Option::is_none")] + pub format: Option, +} + +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum DownloadFormat { + Original, + Text, +} + +impl DownloadFormat { + pub fn as_str(&self) -> &'static str { + match self { + Self::Original => "original", + Self::Text => "text", + } + } +} + +// Serialize as the wire string ("original" or "text"). +impl serde::Serialize for DownloadFormat { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct DownloadFileSuccess { + /// Raw file content. The xAI response Content-Type is `application/octet-stream`. + pub bytes: Vec, +} + +// ── Implementation ── + +/// GET https://api.x.ai/v1/files/{file_id}/content — download the raw bytes +/// of a previously-uploaded file. +/// +/// Docs: +pub async fn download_file(args: DownloadFileArgs<'_>) -> Result { + let req = args.request; + let mut url = format!("{}/v1/files/{}/content", XAI_API_BASE_URL, req.file_id); + if let Some(fmt) = req.format { + url.push_str("?format="); + url.push_str(fmt.as_str()); + } + + info!("Grok download_file: file_id={}", req.file_id); + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.get(&url) + .header("Authorization", bearer) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + + // On error, read as text so the classifier can quote it back. + if !status.is_success() { + let body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + classify_grok_http_error(status, Some(&body))?; + // classify_grok_http_error always returns Err on non-success. + unreachable!(); + } + + let bytes = response.bytes() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok download_file response: status={}, bytes={}", status, bytes.len()); + + Ok(DownloadFileSuccess { bytes: bytes.to_vec() }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn download_format_serializes() { + assert_eq!(DownloadFormat::Original.as_str(), "original"); + assert_eq!(DownloadFormat::Text.as_str(), "text"); + } + + #[test] + fn download_format_serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&DownloadFormat::Original).unwrap(), "\"original\""); + assert_eq!(serde_json::to_string(&DownloadFormat::Text).unwrap(), "\"text\""); + } + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = DownloadFileArgs { + api_key: &key, + request: DownloadFileRequest { + file_id: "file_abc".to_string(), + format: Some(DownloadFormat::Original), + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak")); + assert!(json.contains("\"file_id\":\"file_abc\"")); + assert!(json.contains("\"format\":\"original\"")); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/download_file/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/files/download_file/mod.rs new file mode 100644 index 00000000..db2beffd --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/download_file/mod.rs @@ -0,0 +1 @@ +pub mod download_file; diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/get_file_metadata.rs b/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/get_file_metadata.rs new file mode 100644 index 00000000..eedaa8e0 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/get_file_metadata.rs @@ -0,0 +1,141 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::files::get_file_metadata::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`get_file_metadata`]. Borrows the API key separately +/// from the request body so callers can log/save [`GetFileMetadataRequest`] +/// without leaking the credential. +#[derive(Clone, Debug)] +pub struct GetFileMetadataArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: GetFileMetadataRequest, +} + +/// The material part of a get-file-metadata request. Derives [`Serialize`]. +#[derive(Clone, Debug, Serialize)] +pub struct GetFileMetadataRequest { + pub file_id: String, +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct FileMetadata { + pub file_id: String, + pub bytes: Option, + pub created_at: Option, + pub expires_at: Option, + pub filename: Option, + pub purpose: Option, +} + +// ── Implementation ── + +/// GET https://api.x.ai/v1/files/{file_id} — fetch metadata for an uploaded +/// file (no content; use `download_file` for that). +/// +/// Docs: +pub async fn get_file_metadata(args: GetFileMetadataArgs<'_>) -> Result { + let req = args.request; + let url = format!("{}/v1/files/{}", XAI_API_BASE_URL, req.file_id); + + info!("Grok get_file_metadata: file_id={}", req.file_id); + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.get(&url) + .header("Authorization", bearer) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok get_file_metadata response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: FileMetadataResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(FileMetadata { + file_id: parsed.id, + bytes: parsed.bytes, + created_at: parsed.created_at, + expires_at: parsed.expires_at, + filename: parsed.filename, + purpose: parsed.purpose, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + use crate::error::grok_specific_api_error::GrokSpecificApiError; + + #[test] + fn response_body_deserializes() { + let json = r#"{ + "id": "file_abc123", + "object": "file", + "bytes": 4096, + "created_at": 1716489600, + "expires_at": 1719081600, + "filename": "photo.png", + "purpose": "vision" + }"#; + let parsed: FileMetadataResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.id, "file_abc123"); + assert_eq!(parsed.expires_at, Some(1719081600)); + } + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = GetFileMetadataArgs { + api_key: &key, + request: GetFileMetadataRequest { file_id: "file_abc".to_string() }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak")); + assert!(json.contains("\"file_id\":\"file_abc\"")); + } + + #[tokio::test] + #[ignore] // manually test — requires real API key + valid file_id + async fn live_test_unknown_file_returns_not_found() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = get_file_metadata(GetFileMetadataArgs { + api_key: &api_key, + request: GetFileMetadataRequest { + file_id: "file_doesnotexist000000".to_string(), + }, + }).await; + let err = result.unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::NotFound { .. })), + "expected NotFound, got: {:?}", err); + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/mod.rs new file mode 100644 index 00000000..28a25301 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/mod.rs @@ -0,0 +1,2 @@ +pub mod get_file_metadata; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/request_types.rs new file mode 100644 index 00000000..2a59ffd0 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/get_file_metadata/request_types.rs @@ -0,0 +1,15 @@ +use serde_derive::Deserialize; + +/// Response shape for GET /v1/files/{file_id}. Same envelope as the upload +/// response (xAI returns identical file objects from both endpoints). +/// +/// Docs: +#[derive(Deserialize, Debug, Clone)] +pub(crate) struct FileMetadataResponseBody { + pub id: String, + pub bytes: Option, + pub created_at: Option, + pub expires_at: Option, + pub filename: Option, + pub purpose: Option, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/files/mod.rs new file mode 100644 index 00000000..9c1d3f5f --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/mod.rs @@ -0,0 +1,4 @@ +pub mod delete_file; +pub mod download_file; +pub mod get_file_metadata; +pub mod upload_file; diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/mod.rs new file mode 100644 index 00000000..ffc5d71d --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/mod.rs @@ -0,0 +1,2 @@ +pub mod upload_file; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/request_types.rs new file mode 100644 index 00000000..4bbebb28 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/request_types.rs @@ -0,0 +1,14 @@ +use serde_derive::Deserialize; + +/// Response shape for POST /v1/files. Matches OpenAI-style file objects. +/// +/// Docs: +#[derive(Deserialize, Debug, Clone)] +pub(crate) struct UploadFileResponseBody { + pub id: String, + pub bytes: Option, + pub created_at: Option, + pub expires_at: Option, + pub filename: Option, + pub purpose: Option, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/upload_file.rs b/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/upload_file.rs new file mode 100644 index 00000000..b842b2f1 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/files/upload_file/upload_file.rs @@ -0,0 +1,312 @@ +use std::fmt; + +use log::info; +use reqwest::multipart::{Form, Part}; +use serde_derive::Serialize; + +use crate::api::requests::files::upload_file::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +const MAX_FILE_BYTES: u64 = 50 * 1024 * 1024; + +// ── Public args ── + +/// Top-level argument to [`upload_file`]. Borrows the API key separately from +/// the request body so callers can log/save [`UploadFileRequest`] without +/// leaking the credential. +#[derive(Clone, Debug)] +pub struct UploadFileArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: UploadFileRequest, +} + +/// The material part of a file-upload request. +/// +/// Derives [`Serialize`] for log/audit, BUT `file_bytes` is skipped during +/// serialization (a megabyte-scale binary blob shouldn't end up in a JSON +/// log). [`Debug`] is implemented manually to print the byte length instead +/// of the raw contents, so accidental `{:?}` formatting can't dump the file. +#[derive(Clone, Serialize)] +pub struct UploadFileRequest { + /// Raw bytes of the file. xAI caps uploads at 50 MB. Skipped from both + /// `Serialize` and `Debug` output — log/save the rest of the request and + /// recover the bytes from disk or cache out-of-band. + #[serde(skip)] + pub file_bytes: Vec, + + /// Original filename. xAI extracts this from the multipart + /// `Content-Disposition: filename=...` header and surfaces it back in the + /// response. + pub filename: String, + + /// Optional MIME type. If `None`, reqwest uses `application/octet-stream`. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_content_type: Option, + + /// Time-to-live in seconds (3600 – 2_592_000, i.e. 1 hour to 30 days). If + /// `None`, the file persists indefinitely until explicitly deleted. + #[serde(skip_serializing_if = "Option::is_none")] + pub expires_after_seconds: Option, + + /// OpenAI-compatibility label. xAI accepts but doesn't enforce this — set + /// it if porting code that already uses OpenAI's Files API. + #[serde(skip_serializing_if = "Option::is_none")] + pub purpose: Option, +} + +impl fmt::Debug for UploadFileRequest { + // Print byte-length, not raw bytes — derived Debug on Vec would dump + // the entire file into the log line. + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("UploadFileRequest") + .field("file_bytes_len", &self.file_bytes.len()) + .field("filename", &self.filename) + .field("maybe_content_type", &self.maybe_content_type) + .field("expires_after_seconds", &self.expires_after_seconds) + .field("purpose", &self.purpose) + .finish() + } +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct UploadFileSuccess { + /// The xAI file identifier. Use this in the `FileId(_)` variant of + /// [`crate::api::requests::images::image_edit::image_edit::ImageSource`], + /// [`crate::api::requests::videos::video_generation::video_generation::VideoImageSource`], + /// [`crate::api::requests::videos::video_edit::video_edit::VideoSource`], or + /// [`crate::api::requests::videos::video_extension::video_extension::VideoExtensionSource`]. + pub file_id: String, + + pub bytes: Option, + pub created_at: Option, + pub expires_at: Option, + pub filename: Option, + pub purpose: Option, +} + +// ── Implementation ── + +/// POST https://api.x.ai/v1/files — upload a file and receive a `file_id` +/// you can reference in subsequent image/video edit, generation, or +/// extension calls. +/// +/// xAI documentation: +/// - +pub async fn upload_file(args: UploadFileArgs<'_>) -> Result { + let req = args.request; + + if req.file_bytes.is_empty() { + return Err(GrokClientError::InvalidRequest( + "upload_file: file_bytes is empty".to_string(), + ).into()); + } + if req.file_bytes.len() as u64 > MAX_FILE_BYTES { + return Err(GrokClientError::InvalidRequest( + format!("upload_file: file_bytes is {} bytes, exceeds xAI's 50 MB limit", req.file_bytes.len()), + ).into()); + } + + let url = format!("{}/v1/files", XAI_API_BASE_URL); + + info!( + "Grok upload_file: filename={}, bytes={}, expires_after={:?}, purpose={:?}", + req.filename, req.file_bytes.len(), req.expires_after_seconds, req.purpose + ); + + let mut file_part = Part::bytes(req.file_bytes).file_name(req.filename.clone()); + if let Some(ct) = req.maybe_content_type.as_deref() { + file_part = file_part.mime_str(ct) + .map_err(GrokClientError::ReqwestClientError)?; + } + + let mut form = Form::new().part("file", file_part); + if let Some(secs) = req.expires_after_seconds { + form = form.text("expires_after", secs.to_string()); + } + if let Some(purpose) = req.purpose { + form = form.text("purpose", purpose); + } + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.post(&url) + .header("Authorization", bearer) + .multipart(form) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok upload_file response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: UploadFileResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(UploadFileSuccess { + file_id: parsed.id, + bytes: parsed.bytes, + created_at: parsed.created_at, + expires_at: parsed.expires_at, + filename: parsed.filename, + purpose: parsed.purpose, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + use crate::error::grok_specific_api_error::GrokSpecificApiError; + + // ── Client-side validation ── + + #[tokio::test] + async fn empty_bytes_returns_bad_request() { + let api_key = GrokApiKey::new("dummy".to_string()); + let result = upload_file(UploadFileArgs { + api_key: &api_key, + request: UploadFileRequest { + file_bytes: vec![], + filename: "x.png".to_string(), + maybe_content_type: None, + expires_after_seconds: None, + purpose: None, + }, + }).await; + let err = result.unwrap_err(); + assert!(matches!(err, GrokError::Client(GrokClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn over_size_limit_returns_bad_request() { + let api_key = GrokApiKey::new("dummy".to_string()); + let oversized: Vec = vec![0u8; (MAX_FILE_BYTES + 1) as usize]; + let result = upload_file(UploadFileArgs { + api_key: &api_key, + request: UploadFileRequest { + file_bytes: oversized, + filename: "x.png".to_string(), + maybe_content_type: None, + expires_after_seconds: None, + purpose: None, + }, + }).await; + let err = result.unwrap_err(); + assert!(matches!(err, GrokError::Client(GrokClientError::InvalidRequest(_)))); + } + + // ── Public Request shape — must not leak api_key OR file_bytes ── + + #[test] + fn request_serializes_without_api_key_and_without_file_bytes() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = UploadFileArgs { + api_key: &key, + request: UploadFileRequest { + file_bytes: vec![0x89, 0x50, 0x4E, 0x47], // "PNG" header — recognizable + filename: "photo.png".to_string(), + maybe_content_type: Some("image/png".to_string()), + expires_after_seconds: Some(3600), + purpose: None, + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak"), "api_key leaked in: {}", json); + assert!(!json.contains("PNG"), "file_bytes leaked in: {}", json); + assert!(!json.contains("file_bytes"), "file_bytes field present in: {}", json); + assert!(json.contains("\"filename\":\"photo.png\"")); + assert!(json.contains("\"maybe_content_type\":\"image/png\"")); + assert!(json.contains("\"expires_after_seconds\":3600")); + assert!(!json.contains("\"purpose\"")); + } + + #[test] + fn debug_does_not_dump_file_bytes() { + let req = UploadFileRequest { + file_bytes: vec![0u8; 1_000_000], + filename: "huge.bin".to_string(), + maybe_content_type: None, + expires_after_seconds: None, + purpose: None, + }; + let debug = format!("{:?}", req); + assert!(debug.contains("file_bytes_len: 1000000"), "expected length, got: {}", debug); + assert!(!debug.contains(", 0, 0, 0, 0"), "raw bytes leaked into Debug: {}", debug); + } + + // ── Response parsing ── + + #[test] + fn response_body_deserializes() { + let json = r#"{ + "id": "file_abc123", + "object": "file", + "bytes": 1024, + "created_at": 1716489600, + "expires_at": null, + "filename": "photo.png", + "purpose": "vision" + }"#; + let parsed: UploadFileResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.id, "file_abc123"); + assert_eq!(parsed.bytes, Some(1024)); + assert_eq!(parsed.filename.as_deref(), Some("photo.png")); + } + + // ── Live API tests ── + + #[tokio::test] + #[ignore] // manually test — requires real API key + async fn live_test_upload_small_png() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + // 1x1 transparent PNG + let png_bytes: Vec = vec![ + 0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A, + 0x00, 0x00, 0x00, 0x0D, 0x49, 0x48, 0x44, 0x52, + 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, + 0x08, 0x06, 0x00, 0x00, 0x00, 0x1F, 0x15, 0xC4, + 0x89, 0x00, 0x00, 0x00, 0x0D, 0x49, 0x44, 0x41, + 0x54, 0x78, 0x9C, 0x63, 0x00, 0x01, 0x00, 0x00, + 0x05, 0x00, 0x01, 0x0D, 0x0A, 0x2D, 0xB4, 0x00, + 0x00, 0x00, 0x00, 0x49, 0x45, 0x4E, 0x44, 0xAE, + 0x42, 0x60, 0x82, + ]; + + let api_key = get_test_api_key()?; + let result = upload_file(UploadFileArgs { + api_key: &api_key, + request: UploadFileRequest { + file_bytes: png_bytes, + filename: "test_1x1.png".to_string(), + maybe_content_type: Some("image/png".to_string()), + expires_after_seconds: Some(3600), + purpose: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Uploaded file_id={}, bytes={:?}", result.file_id, result.bytes); + assert!(!result.file_id.is_empty()); + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/cost.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/cost.rs new file mode 100644 index 00000000..44198ff2 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/cost.rs @@ -0,0 +1,299 @@ +use crate::api::requests::images::image_edit::image_edit::ImageEditRequest; +use crate::api::requests::images::image_generation::cost::output_mills_per_image; +use crate::api::traits::grok_request_cost_calculator_trait::{GrokRequestCostCalculator, UsdMills}; +use crate::api::types::image_types::image_model::ImageModel; +use crate::api::types::image_types::image_resolution::ImageResolution; + +// `image_edit` bills BOTH input (per source image fed in) AND output (per +// generated image). Per : +// +// grok-imagine-image input $0.002/img → 2 mills/img +// grok-imagine-image-quality input $0.010/img → 10 mills/img +// +// Output rates match `image_generation` (shared helper `output_mills_per_image`). + +impl GrokRequestCostCalculator for ImageEditRequest { + fn calculate_cost_in_mills(&self) -> UsdMills { + let model = self.model.clone().unwrap_or(ImageModel::GrokImagineImageQuality); + let resolution = self.resolution.unwrap_or(ImageResolution::OneK); + + let input_mills_per_img = input_mills_per_image(&model); + let output_mills_per_img = output_mills_per_image(&model, resolution); + + let n = self.number_images.unwrap_or(1) as u64; + let source_count = self.source_images.len() as u64; + + (input_mills_per_img * source_count) + (output_mills_per_img * n) + } +} + +/// Input rate in mills per source image, by model. +fn input_mills_per_image(model: &ImageModel) -> UsdMills { + match model { + ImageModel::GrokImagineImage => 2, + ImageModel::GrokImagineImageQuality => 10, + // Custom: conservatively assume the more expensive `-quality` tier. + ImageModel::Custom(_) => 10, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::requests::images::image_edit::image_edit::ImageSource; + use crate::api::types::image_types::image_aspect_ratio::ImageAspectRatio; + + fn make_request( + model: Option, + resolution: Option, + number_images: Option, + source_count: usize, + ) -> ImageEditRequest { + ImageEditRequest { + prompt: "test".to_string(), + source_images: (0..source_count) + .map(|i| ImageSource::Url(format!("https://example.com/{i}.png"))) + .collect(), + model, + number_images, + aspect_ratio: None, + resolution, + response_format: None, + user: None, + } + } + + // ── Per-rate components ── + + mod per_rate_components { + use super::*; + + #[test] + fn standard_input_is_2_mills_per_source() { + assert_eq!(input_mills_per_image(&ImageModel::GrokImagineImage), 2); + } + + #[test] + fn quality_input_is_10_mills_per_source() { + assert_eq!(input_mills_per_image(&ImageModel::GrokImagineImageQuality), 10); + } + + #[test] + fn custom_input_defaults_to_quality_rate() { + assert_eq!(input_mills_per_image(&ImageModel::Custom("anything".to_string())), 10); + } + } + + // ── Single source + single output, every (model, resolution) pair ── + + mod single_source_single_output { + use super::*; + + #[test] + fn standard_1k() { + // input 2 + output 20 = 22 mills, 3¢ (ceil) + let req = make_request(Some(ImageModel::GrokImagineImage), Some(ImageResolution::OneK), Some(1), 1); + assert_eq!(req.calculate_cost_in_mills(), 22); + assert_eq!(req.calculate_cost_in_cents(), 3); + } + + #[test] + fn standard_2k() { + // input 2 + output 20 = 22 mills, 3¢ + let req = make_request(Some(ImageModel::GrokImagineImage), Some(ImageResolution::TwoK), Some(1), 1); + assert_eq!(req.calculate_cost_in_mills(), 22); + assert_eq!(req.calculate_cost_in_cents(), 3); + } + + #[test] + fn quality_1k() { + // input 10 + output 50 = 60 mills, 6¢ + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 1); + assert_eq!(req.calculate_cost_in_mills(), 60); + assert_eq!(req.calculate_cost_in_cents(), 6); + } + + #[test] + fn quality_2k() { + // input 10 + output 70 = 80 mills, 8¢ + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(1), 1); + assert_eq!(req.calculate_cost_in_mills(), 80); + assert_eq!(req.calculate_cost_in_cents(), 8); + } + } + + // ── Multi-source edit (up to 3 per xAI's docs) ── + + mod multi_source { + use super::*; + + #[test] + fn quality_1k_three_sources_one_output() { + // input 10 × 3 = 30, output 50, total 80 mills, 8¢ + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 3); + assert_eq!(req.calculate_cost_in_mills(), 80); + assert_eq!(req.calculate_cost_in_cents(), 8); + } + + #[test] + fn standard_1k_three_sources_two_outputs() { + // input 2 × 3 = 6, output 20 × 2 = 40, total 46 mills, 5¢ (ceil) + let req = make_request(Some(ImageModel::GrokImagineImage), Some(ImageResolution::OneK), Some(2), 3); + assert_eq!(req.calculate_cost_in_mills(), 46); + assert_eq!(req.calculate_cost_in_cents(), 5); + } + } + + // ── Batch output scaling (n > 1) ── + + mod batch_scaling { + use super::*; + + #[test] + fn batch_scales_only_output_not_input() { + let single = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(1), 1) + .calculate_cost_in_mills(); // 10 + 70 = 80 + let quad = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(4), 1) + .calculate_cost_in_mills(); // 10 + 70 × 4 = 290 + assert_eq!(single, 80); + assert_eq!(quad, 290); + // Input doesn't scale with n. + assert_ne!(quad, single * 4); + } + + #[test] + fn quality_1k_scaling_1_through_8() { + for n in 1u32..=8 { + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(n), 1); + assert_eq!(req.calculate_cost_in_mills(), 10 + 50 * n as u64, "n={n}"); + } + } + } + + // ── Defaults ── + + mod defaults { + use super::*; + + #[test] + fn fully_default_with_one_source() { + // model=quality, res=1k, n=1, sources=1 → 10 + 50 = 60 mills + let req = make_request(None, None, None, 1); + assert_eq!(req.calculate_cost_in_mills(), 60); + assert_eq!(req.calculate_cost_in_cents(), 6); + } + } + + // ── Independence from non-pricing fields ── + + mod independence { + use super::*; + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let mut base = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 1); + let base_cost = base.calculate_cost_in_mills(); + for ar in [ + ImageAspectRatio::Square, + ImageAspectRatio::Landscape16x9, + ImageAspectRatio::Portrait9x16, + ImageAspectRatio::Auto, + ] { + base.aspect_ratio = Some(ar); + assert_eq!(base.calculate_cost_in_mills(), base_cost, "{ar:?}"); + } + } + + #[test] + fn cost_is_independent_of_source_url_content() { + let mut req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 0); + req.source_images = vec![ + ImageSource::Url("https://example.com/a.png".to_string()), + ImageSource::FileId("file_abc".to_string()), + ]; + // 10 × 2 + 50 = 70 mills + assert_eq!(req.calculate_cost_in_mills(), 70); + } + } + + // ── Exhaustive matrix ── + + mod exhaustive_matrix { + use super::*; + + // (model, resolution, n, sources, expected_mills) + const CASES: &[(ImageModelKind, ImageResolution, u32, usize, u64)] = &[ + // grok-imagine-image (standard) — input 2/img, output 20/img regardless of resolution + (ImageModelKind::Standard, ImageResolution::OneK, 1, 1, 22), + (ImageModelKind::Standard, ImageResolution::OneK, 1, 2, 24), + (ImageModelKind::Standard, ImageResolution::OneK, 1, 3, 26), + (ImageModelKind::Standard, ImageResolution::OneK, 2, 1, 42), + (ImageModelKind::Standard, ImageResolution::OneK, 4, 1, 82), + (ImageModelKind::Standard, ImageResolution::TwoK, 1, 1, 22), + (ImageModelKind::Standard, ImageResolution::TwoK, 2, 2, 44), + (ImageModelKind::Standard, ImageResolution::TwoK, 3, 3, 66), + // grok-imagine-image-quality — input 10/img, output 50/img (1k) or 70/img (2k) + (ImageModelKind::Quality, ImageResolution::OneK, 1, 1, 60), + (ImageModelKind::Quality, ImageResolution::OneK, 1, 2, 70), + (ImageModelKind::Quality, ImageResolution::OneK, 1, 3, 80), + (ImageModelKind::Quality, ImageResolution::OneK, 2, 1, 110), + (ImageModelKind::Quality, ImageResolution::OneK, 4, 1, 210), + (ImageModelKind::Quality, ImageResolution::TwoK, 1, 1, 80), + (ImageModelKind::Quality, ImageResolution::TwoK, 2, 2, 160), + (ImageModelKind::Quality, ImageResolution::TwoK, 3, 3, 240), + (ImageModelKind::Quality, ImageResolution::TwoK, 4, 3, 310), + ]; + + #[derive(Copy, Clone, Debug)] + enum ImageModelKind { Standard, Quality } + + fn to_model(kind: ImageModelKind) -> ImageModel { + match kind { + ImageModelKind::Standard => ImageModel::GrokImagineImage, + ImageModelKind::Quality => ImageModel::GrokImagineImageQuality, + } + } + + #[test] + fn all_matrix_cases() { + for &(kind, res, n, sources, expected) in CASES { + let req = make_request(Some(to_model(kind)), Some(res), Some(n), sources); + assert_eq!(req.calculate_cost_in_mills(), expected, + "model={:?} res={:?} n={} sources={}", kind, res, n, sources); + } + } + } + + // ── Monotonicity ── + + mod monotonicity { + use super::*; + + #[test] + fn more_sources_cost_more() { + let one = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 1) + .calculate_cost_in_mills(); + let three = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 3) + .calculate_cost_in_mills(); + assert!(one < three); + } + + #[test] + fn more_outputs_cost_more() { + let one = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1), 1) + .calculate_cost_in_mills(); + let four = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(4), 1) + .calculate_cost_in_mills(); + assert!(one < four); + } + + #[test] + fn quality_costs_more_than_standard() { + for res in [ImageResolution::OneK, ImageResolution::TwoK] { + let std = make_request(Some(ImageModel::GrokImagineImage), Some(res), Some(2), 2).calculate_cost_in_mills(); + let qua = make_request(Some(ImageModel::GrokImagineImageQuality), Some(res), Some(2), 2).calculate_cost_in_mills(); + assert!(std < qua, "standard ({std}) should be < quality ({qua}) at {res:?}"); + } + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/image_edit.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/image_edit.rs new file mode 100644 index 00000000..c15b4d83 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/image_edit.rs @@ -0,0 +1,372 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::images::image_edit::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::api::types::image_types::image_aspect_ratio::ImageAspectRatio; +use crate::api::types::image_types::image_model::ImageModel; +use crate::api::types::image_types::image_resolution::ImageResolution; +use crate::api::types::image_types::image_response_format::ImageResponseFormat; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::error::grok_specific_api_error::GrokSpecificApiError; + +// ── Public args ── + +/// Top-level argument to [`image_edit`]. Borrows the API key separately from +/// the request body so callers can log/save [`ImageEditRequest`] without +/// leaking the credential. +#[derive(Clone, Debug)] +pub struct ImageEditArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: ImageEditRequest, +} + +/// The material part of an image-edit request. Derives [`Serialize`] so it +/// can be persisted to a log or audit store independently of the API key. +#[derive(Clone, Debug, Serialize)] +pub struct ImageEditRequest { + /// Edit instruction. Required. + pub prompt: String, + + /// One or more source images. xAI supports up to 3. + /// The output aspect ratio follows the first input image unless overridden. + pub source_images: Vec, + + /// Model identifier. Defaults to [`ImageModel::GrokImagineImageQuality`] when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + /// Number of edited images to render. Server default is 1 when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub number_images: Option, + + /// Aspect ratio. See [`ImageAspectRatio`]. When `None`, xAI defaults to + /// matching the first input image. + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Output resolution tier. See [`ImageResolution`]. + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// `Url` (default) or `B64Json`. + #[serde(skip_serializing_if = "Option::is_none")] + pub response_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +/// Source image — pick by URL or by `file_id` (from a prior upload). +#[derive(Clone, Debug, Serialize)] +pub enum ImageSource { + /// Either a public HTTPS URL or a `data:` URI containing base64-encoded + /// image bytes. + Url(String), + + /// xAI file identifier (`file_...`) obtained from a successful upload via + /// [`crate::api::requests::files::upload_file::upload_file::upload_file`]. The file + /// must still exist at request time (it has not been deleted and any + /// `expires_after` has not lapsed). + /// + /// Docs: + /// - + /// - + FileId(String), +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct ImageEditSuccess { + pub images: Vec, +} + +#[derive(Debug, Clone)] +pub struct EditedImage { + pub url: Option, + pub b64_json: Option, + pub revised_prompt: Option, +} + +// ── Implementation ── + +/// POST https://api.x.ai/v1/images/edits — edit one or more source images +/// according to a text prompt. +/// +/// Docs: +/// - +/// - +pub async fn image_edit(args: ImageEditArgs<'_>) -> Result { + let req = args.request; + + if req.source_images.is_empty() { + return Err(GrokClientError::InvalidRequest( + "image_edit requires at least one source image".to_string(), + ).into()); + } + + let url = format!("{}/v1/images/edits", XAI_API_BASE_URL); + let model = req.model.unwrap_or(ImageModel::GrokImagineImageQuality); + + info!( + "Grok image_edit: model={}, sources={}, aspect_ratio={:?}, resolution={:?}", + model.as_str(), req.source_images.len(), + req.aspect_ratio.map(|a| a.as_str()), + req.resolution.map(|r| r.as_str()), + ); + + // Single source → `image`. Multiple sources → `images`. + let (image, images) = if req.source_images.len() == 1 { + (Some(to_image_ref(&req.source_images[0])), None) + } else { + (None, Some(req.source_images.iter().map(to_image_ref).collect())) + }; + + let request_body = ImageEditRequestBody { + prompt: req.prompt, + image, + images, + model: Some(model.as_str().to_string()), + n: req.number_images, + aspect_ratio: req.aspect_ratio.map(|a| a.as_str().to_string()), + resolution: req.resolution.map(|r| r.as_str().to_string()), + response_format: req.response_format.map(|f| f.as_str().to_string()), + user: req.user, + }; + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.post(&url) + .header("Authorization", bearer) + .header("Content-Type", "application/json") + .json(&request_body) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok image_edit response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: ImageEditResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(ImageEditSuccess { + images: parsed.data.into_iter().map(|d| EditedImage { + url: d.url, + b64_json: d.b64_json, + revised_prompt: d.revised_prompt, + }).collect(), + }) +} + +fn to_image_ref(source: &ImageSource) -> ImageRef { + match source { + ImageSource::Url(u) => ImageRef { url: Some(u.clone()), file_id: None }, + ImageSource::FileId(id) => ImageRef { url: None, file_id: Some(id.clone()) }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + // ── Wire-format shape tests (against the internal ImageEditRequestBody) ── + + #[test] + fn wire_body_single_source_uses_image_field() { + let body = ImageEditRequestBody { + prompt: "make it sepia".to_string(), + image: Some(ImageRef { url: Some("https://example.com/a.png".to_string()), file_id: None }), + images: None, + model: Some("grok-imagine-image-quality".to_string()), + n: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"image\":{")); + assert!(!json.contains("\"images\"")); + assert!(json.contains("\"url\":\"https://example.com/a.png\"")); + } + + #[test] + fn wire_body_multi_source_uses_images_array() { + let body = ImageEditRequestBody { + prompt: "combine these".to_string(), + image: None, + images: Some(vec![ + ImageRef { url: Some("https://example.com/a.png".to_string()), file_id: None }, + ImageRef { url: None, file_id: Some("file_xyz".to_string()) }, + ]), + model: None, + n: None, + aspect_ratio: Some("1:1".to_string()), + resolution: None, + response_format: None, + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"images\":[")); + assert!(!json.contains("\"image\":{")); + assert!(json.contains("\"file_id\":\"file_xyz\"")); + assert!(json.contains("\"aspect_ratio\":\"1:1\"")); + } + + // ── Public-API shape tests: ImageEditRequest must serialize cleanly ── + + #[test] + fn request_serializes_with_typed_enums() { + let req = ImageEditRequest { + prompt: "edit me".to_string(), + source_images: vec![ImageSource::Url("https://example.com/a.png".to_string())], + model: Some(ImageModel::GrokImagineImageQuality), + number_images: Some(2), + aspect_ratio: Some(ImageAspectRatio::Landscape16x9), + resolution: Some(ImageResolution::TwoK), + response_format: Some(ImageResponseFormat::B64Json), + user: Some("user_xyz".to_string()), + }; + let json = serde_json::to_string(&req).unwrap(); + assert!(json.contains("\"prompt\":\"edit me\"")); + assert!(json.contains("\"model\":\"grok-imagine-image-quality\"")); + assert!(json.contains("\"aspect_ratio\":\"16:9\"")); + assert!(json.contains("\"resolution\":\"2k\"")); + assert!(json.contains("\"response_format\":\"b64_json\"")); + assert!(json.contains("\"number_images\":2")); + } + + #[test] + fn request_omits_none_fields() { + let req = ImageEditRequest { + prompt: "p".to_string(), + source_images: vec![ImageSource::FileId("file_abc".to_string())], + model: None, + number_images: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }; + let json = serde_json::to_string(&req).unwrap(); + assert!(!json.contains("\"model\"")); + assert!(!json.contains("\"aspect_ratio\"")); + assert!(!json.contains("\"resolution\"")); + assert!(!json.contains("\"user\"")); + assert!(!json.contains("\"number_images\"")); + } + + #[test] + fn request_does_not_serialize_api_key() { + let key = GrokApiKey::new("secret_value_must_not_leak".to_string()); + let args = ImageEditArgs { + api_key: &key, + request: ImageEditRequest { + prompt: "p".to_string(), + source_images: vec![ImageSource::Url("u".to_string())], + model: None, + number_images: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_value_must_not_leak"), + "serialized request must not contain the API key. got: {}", json); + } + + #[tokio::test] + async fn empty_sources_returns_bad_request() { + let api_key = GrokApiKey::new("dummy".to_string()); + let result = image_edit(ImageEditArgs { + api_key: &api_key, + request: ImageEditRequest { + prompt: "edit".to_string(), + source_images: vec![], + model: None, + number_images: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }, + }).await; + let err = result.unwrap_err(); + assert!(matches!(err, GrokError::Client(GrokClientError::InvalidRequest(_)))); + } + + #[test] + fn response_body_deserializes_url() { + let json = r#"{ "data": [ { "url": "https://imagine.x.ai/edit.png" } ] }"#; + let parsed: ImageEditResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.data[0].url.as_deref(), Some("https://imagine.x.ai/edit.png")); + } + + #[test] + fn image_ref_url_only() { + let r = ImageRef { url: Some("u".to_string()), file_id: None }; + let json = serde_json::to_string(&r).unwrap(); + assert!(json.contains("\"url\":\"u\"")); + assert!(!json.contains("\"file_id\"")); + } + + #[test] + fn image_ref_file_id_only() { + let r = ImageRef { url: None, file_id: Some("f".to_string()) }; + let json = serde_json::to_string(&r).unwrap(); + assert!(json.contains("\"file_id\":\"f\"")); + assert!(!json.contains("\"url\"")); + } + + // ── Live API tests ── + + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_image_edit_single() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = image_edit(ImageEditArgs { + api_key: &api_key, + request: ImageEditRequest { + prompt: "Render this as a pencil sketch with detailed shading".to_string(), + source_images: vec![ImageSource::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())], + model: None, + number_images: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Edited {} image(s)", result.images.len()); + for (i, img) in result.images.iter().enumerate() { + println!(" [{}] url={:?}", i, img.url); + } + assert!(!result.images.is_empty()); + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/mod.rs new file mode 100644 index 00000000..b01b824a --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/mod.rs @@ -0,0 +1,3 @@ +pub mod cost; +pub mod image_edit; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/request_types.rs new file mode 100644 index 00000000..d7fa4c26 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_edit/request_types.rs @@ -0,0 +1,57 @@ +use serde_derive::{Deserialize, Serialize}; + +// ── Request ── + +#[derive(Serialize, Debug)] +pub(crate) struct ImageEditRequestBody { + pub prompt: String, + + /// Exactly one of `image` or `images` is sent (single vs. multi-image edit). + #[serde(skip_serializing_if = "Option::is_none")] + pub image: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub images: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub n: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub response_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +/// xAI image reference — exactly one of `url` or `file_id` is set. +#[derive(Serialize, Debug, Clone)] +pub(crate) struct ImageRef { + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub file_id: Option, +} + +// ── Response ── + +#[derive(Deserialize, Debug)] +pub(crate) struct ImageEditResponseBody { + pub data: Vec, +} + +#[derive(Deserialize, Debug)] +pub(crate) struct ImageEditResponseDatum { + pub url: Option, + pub b64_json: Option, + pub revised_prompt: Option, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/cost.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/cost.rs new file mode 100644 index 00000000..f83f6241 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/cost.rs @@ -0,0 +1,249 @@ +use crate::api::requests::images::image_generation::image_generation::ImageGenerationRequest; +use crate::api::traits::grok_request_cost_calculator_trait::{GrokRequestCostCalculator, UsdMills}; +use crate::api::types::image_types::image_model::ImageModel; +use crate::api::types::image_types::image_resolution::ImageResolution; + +// xAI published rates as of these docs: +// +// grok-imagine-image 1K $0.02/img, 2K $0.02/img (input $0.002/img) +// grok-imagine-image-quality 1K $0.05/img, 2K $0.07/img (input $0.010/img) +// +// In mills (1¢ = 10 mills): +// +// grok-imagine-image: 1K 20 mills/img, 2K 20 mills/img +// grok-imagine-image-quality: 1K 50 mills/img, 2K 70 mills/img +// +// `image_generation` has no INPUT cost (it's pure text → image) — only output. + +impl GrokRequestCostCalculator for ImageGenerationRequest { + fn calculate_cost_in_mills(&self) -> UsdMills { + let model = self.model.clone().unwrap_or(ImageModel::GrokImagineImageQuality); + let resolution = self.resolution.unwrap_or(ImageResolution::OneK); + + let mills_per_image = output_mills_per_image(&model, resolution); + + // Server default for `n` is 1. + let n = self.number_images.unwrap_or(1) as u64; + + mills_per_image * n + } +} + +/// Output rate in mills per generated image. Used by both +/// `image_generation` and `image_edit` (same output side). +pub(crate) fn output_mills_per_image(model: &ImageModel, resolution: ImageResolution) -> UsdMills { + match (model, resolution) { + (ImageModel::GrokImagineImage, ImageResolution::OneK) => 20, + (ImageModel::GrokImagineImage, ImageResolution::TwoK) => 20, + (ImageModel::GrokImagineImageQuality, ImageResolution::OneK) => 50, + (ImageModel::GrokImagineImageQuality, ImageResolution::TwoK) => 70, + // Custom: conservatively assume the more expensive `-quality` tier. + (ImageModel::Custom(_), ImageResolution::OneK) => 50, + (ImageModel::Custom(_), ImageResolution::TwoK) => 70, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::types::image_types::image_aspect_ratio::ImageAspectRatio; + use crate::api::types::image_types::image_response_format::ImageResponseFormat; + + fn make_request( + model: Option, + resolution: Option, + number_images: Option, + ) -> ImageGenerationRequest { + ImageGenerationRequest { + prompt: "test".to_string(), + model, + number_images, + aspect_ratio: None, + resolution, + response_format: None, + user: None, + } + } + + // ── Per-image rate at each (model, resolution) combo ── + + mod per_image_rates { + use super::*; + + #[test] + fn standard_1k_is_20_mills() { + let req = make_request(Some(ImageModel::GrokImagineImage), Some(ImageResolution::OneK), Some(1)); + assert_eq!(req.calculate_cost_in_mills(), 20); + // 20 mills = 2¢ (ceiling) + assert_eq!(req.calculate_cost_in_cents(), 2); + } + + #[test] + fn standard_2k_is_20_mills() { + let req = make_request(Some(ImageModel::GrokImagineImage), Some(ImageResolution::TwoK), Some(1)); + assert_eq!(req.calculate_cost_in_mills(), 20); + assert_eq!(req.calculate_cost_in_cents(), 2); + } + + #[test] + fn quality_1k_is_50_mills() { + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + assert_eq!(req.calculate_cost_in_mills(), 50); + assert_eq!(req.calculate_cost_in_cents(), 5); + } + + #[test] + fn quality_2k_is_70_mills() { + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(1)); + assert_eq!(req.calculate_cost_in_mills(), 70); + assert_eq!(req.calculate_cost_in_cents(), 7); + } + } + + // ── Defaults ── + + mod defaults { + use super::*; + + #[test] + fn default_model_is_quality() { + let r1 = make_request(None, Some(ImageResolution::OneK), Some(1)); + let r2 = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + assert_eq!(r1.calculate_cost_in_mills(), r2.calculate_cost_in_mills()); + } + + #[test] + fn default_resolution_is_one_k() { + let r1 = make_request(Some(ImageModel::GrokImagineImageQuality), None, Some(1)); + let r2 = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + assert_eq!(r1.calculate_cost_in_mills(), r2.calculate_cost_in_mills()); + } + + #[test] + fn default_n_is_one() { + let r1 = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), None); + let r2 = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + assert_eq!(r1.calculate_cost_in_mills(), r2.calculate_cost_in_mills()); + } + + #[test] + fn fully_default_request_costs_50_mills() { + // All defaults = grok-imagine-image-quality, 1k, n=1 → 50 mills + let req = make_request(None, None, None); + assert_eq!(req.calculate_cost_in_mills(), 50); + assert_eq!(req.calculate_cost_in_cents(), 5); + } + } + + // ── Batch scaling ── + + mod batch_scaling { + use super::*; + + #[test] + fn n_scales_linearly_standard_1k() { + for n in 1u32..=10 { + let req = make_request(Some(ImageModel::GrokImagineImage), Some(ImageResolution::OneK), Some(n)); + assert_eq!(req.calculate_cost_in_mills(), 20 * n as u64, "n={n}"); + } + } + + #[test] + fn n_scales_linearly_quality_2k() { + for n in 1u32..=10 { + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(n)); + assert_eq!(req.calculate_cost_in_mills(), 70 * n as u64, "n={n}"); + } + } + + #[test] + fn batch_of_four_quality_2k() { + let req = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(4)); + // 70 mills × 4 = 280 mills = 28¢ + assert_eq!(req.calculate_cost_in_mills(), 280); + assert_eq!(req.calculate_cost_in_cents(), 28); + } + } + + // ── Custom model (forward-compat) ── + + mod custom_model { + use super::*; + + #[test] + fn custom_model_uses_quality_rate() { + let custom = ImageModel::Custom("grok-imagine-image-future".to_string()); + let r_custom_1k = make_request(Some(custom.clone()), Some(ImageResolution::OneK), Some(1)); + let r_quality_1k = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + assert_eq!(r_custom_1k.calculate_cost_in_mills(), r_quality_1k.calculate_cost_in_mills()); + + let r_custom_2k = make_request(Some(custom), Some(ImageResolution::TwoK), Some(1)); + let r_quality_2k = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::TwoK), Some(1)); + assert_eq!(r_custom_2k.calculate_cost_in_mills(), r_quality_2k.calculate_cost_in_mills()); + } + } + + // ── Cost doesn't depend on irrelevant fields ── + + mod independence { + use super::*; + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let mut base = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + let base_cost = base.calculate_cost_in_mills(); + for ar in [ + ImageAspectRatio::Square, + ImageAspectRatio::Landscape16x9, + ImageAspectRatio::Portrait9x16, + ImageAspectRatio::Landscape20x9, + ImageAspectRatio::Auto, + ] { + base.aspect_ratio = Some(ar); + assert_eq!(base.calculate_cost_in_mills(), base_cost, "{ar:?}"); + } + } + + #[test] + fn cost_is_independent_of_response_format() { + let mut base = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + let base_cost = base.calculate_cost_in_mills(); + base.response_format = Some(ImageResponseFormat::Url); + assert_eq!(base.calculate_cost_in_mills(), base_cost); + base.response_format = Some(ImageResponseFormat::B64Json); + assert_eq!(base.calculate_cost_in_mills(), base_cost); + } + + #[test] + fn cost_is_independent_of_user_field() { + let mut base = make_request(Some(ImageModel::GrokImagineImageQuality), Some(ImageResolution::OneK), Some(1)); + let base_cost = base.calculate_cost_in_mills(); + base.user = Some("any-user-id".to_string()); + assert_eq!(base.calculate_cost_in_mills(), base_cost); + } + } + + // ── Monotonicity sanity checks ── + + mod monotonicity { + use super::*; + + #[test] + fn quality_is_at_least_as_expensive_as_standard() { + for res in [ImageResolution::OneK, ImageResolution::TwoK] { + let std = make_request(Some(ImageModel::GrokImagineImage), Some(res), Some(1)).calculate_cost_in_mills(); + let q = make_request(Some(ImageModel::GrokImagineImageQuality), Some(res), Some(1)).calculate_cost_in_mills(); + assert!(std <= q, "standard ({std}) should be <= quality ({q}) at {res:?}"); + } + } + + #[test] + fn two_k_is_at_least_as_expensive_as_one_k() { + for model in [ImageModel::GrokImagineImage, ImageModel::GrokImagineImageQuality] { + let lo = make_request(Some(model.clone()), Some(ImageResolution::OneK), Some(1)).calculate_cost_in_mills(); + let hi = make_request(Some(model.clone()), Some(ImageResolution::TwoK), Some(1)).calculate_cost_in_mills(); + assert!(lo <= hi, "1k ({lo}) should be <= 2k ({hi}) for {:?}", model.as_str()); + } + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/image_generation.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/image_generation.rs new file mode 100644 index 00000000..beb802cf --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/image_generation.rs @@ -0,0 +1,293 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::images::image_generation::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::api::types::image_types::image_aspect_ratio::ImageAspectRatio; +use crate::api::types::image_types::image_model::ImageModel; +use crate::api::types::image_types::image_resolution::ImageResolution; +use crate::api::types::image_types::image_response_format::ImageResponseFormat; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`image_generation`]. Borrows the API key separately +/// from the request body so callers can log/save [`ImageGenerationRequest`] +/// without leaking the credential. +#[derive(Clone, Debug)] +pub struct ImageGenerationArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: ImageGenerationRequest, +} + +/// The material part of an image-generation request. Derives [`Serialize`] so +/// it can be persisted to a log or audit store independently of the API key. +#[derive(Clone, Debug, Serialize)] +pub struct ImageGenerationRequest { + /// Text prompt describing the image. Required. + pub prompt: String, + + /// Model identifier. Defaults to [`ImageModel::GrokImagineImageQuality`] + /// when `None`. Use [`ImageModel::Custom`] for identifiers not yet listed + /// in the enum. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + /// Number of images to render in this request. xAI's docs don't state a + /// hard maximum; server default is 1 when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub number_images: Option, + + /// Aspect ratio. See [`ImageAspectRatio`] for the closed set of accepted + /// values. Server default when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Output resolution tier. See [`ImageResolution`]. Server default when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + /// Url (default) or b64 inline. See [`ImageResponseFormat`]. + #[serde(skip_serializing_if = "Option::is_none")] + pub response_format: Option, + + /// Optional opaque user identifier for usage attribution. + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct ImageGenerationSuccess { + /// One entry per generated image. Order matches the order xAI returned. + pub images: Vec, +} + +#[derive(Debug, Clone)] +pub struct GeneratedImage { + /// URL to the rendered image. Present when `response_format` was `"url"` + /// (the default). xAI URLs are time-limited. + pub url: Option, + + /// Base64-encoded image bytes. Present when `response_format` was `"b64_json"`. + pub b64_json: Option, + + /// xAI's revised version of the input prompt, if it edited it. + pub revised_prompt: Option, +} + +// ── Implementation ── + +/// POST https://api.x.ai/v1/images/generations — generate one or more images +/// from a text prompt using xAI's Imagine API. +/// +/// Docs: +pub async fn image_generation(args: ImageGenerationArgs<'_>) -> Result { + let req = args.request; + + let url = format!("{}/v1/images/generations", XAI_API_BASE_URL); + let model = req.model.unwrap_or(ImageModel::GrokImagineImageQuality); + + info!( + "Grok image_generation: model={}, number_images={:?}, aspect_ratio={:?}, resolution={:?}", + model.as_str(), req.number_images, + req.aspect_ratio.map(|a| a.as_str()), + req.resolution.map(|r| r.as_str()), + ); + + let request_body = ImageGenerationRequestBody { + prompt: req.prompt, + model: Some(model.as_str().to_string()), + n: req.number_images, + aspect_ratio: req.aspect_ratio.map(|a| a.as_str().to_string()), + resolution: req.resolution.map(|r| r.as_str().to_string()), + response_format: req.response_format.map(|f| f.as_str().to_string()), + user: req.user, + }; + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.post(&url) + .header("Authorization", bearer) + .header("Content-Type", "application/json") + .json(&request_body) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok image_generation response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: ImageGenerationResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(ImageGenerationSuccess { + images: parsed.data.into_iter().map(|d| GeneratedImage { + url: d.url, + b64_json: d.b64_json, + revised_prompt: d.revised_prompt, + }).collect(), + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + // ── Wire-format shape tests (internal ImageGenerationRequestBody) ── + + #[test] + fn wire_body_serializes_minimal() { + let body = ImageGenerationRequestBody { + prompt: "a cat".to_string(), + model: Some("grok-imagine-image-quality".to_string()), + n: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"prompt\":\"a cat\"")); + assert!(json.contains("\"model\":\"grok-imagine-image-quality\"")); + assert!(!json.contains("\"n\"")); + assert!(!json.contains("\"aspect_ratio\"")); + assert!(!json.contains("\"user\"")); + } + + #[test] + fn wire_body_serializes_full() { + let body = ImageGenerationRequestBody { + prompt: "a cat".to_string(), + model: Some("grok-imagine-image-quality".to_string()), + n: Some(2), + aspect_ratio: Some("16:9".to_string()), + resolution: Some("2k".to_string()), + response_format: Some("b64_json".to_string()), + user: Some("user_abc".to_string()), + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"n\":2")); + assert!(json.contains("\"aspect_ratio\":\"16:9\"")); + assert!(json.contains("\"resolution\":\"2k\"")); + assert!(json.contains("\"response_format\":\"b64_json\"")); + assert!(json.contains("\"user\":\"user_abc\"")); + } + + // ── Public-API shape tests: ImageGenerationRequest must serialize cleanly ── + + #[test] + fn request_serializes_with_typed_enums() { + let req = ImageGenerationRequest { + prompt: "a serene lake".to_string(), + model: Some(ImageModel::GrokImagineImageQuality), + number_images: Some(3), + aspect_ratio: Some(ImageAspectRatio::Landscape16x9), + resolution: Some(ImageResolution::OneK), + response_format: Some(ImageResponseFormat::Url), + user: None, + }; + let json = serde_json::to_string(&req).unwrap(); + assert!(json.contains("\"prompt\":\"a serene lake\"")); + assert!(json.contains("\"model\":\"grok-imagine-image-quality\"")); + assert!(json.contains("\"number_images\":3")); + assert!(json.contains("\"aspect_ratio\":\"16:9\"")); + assert!(json.contains("\"resolution\":\"1k\"")); + assert!(json.contains("\"response_format\":\"url\"")); + assert!(!json.contains("\"user\"")); + } + + #[test] + fn request_does_not_serialize_api_key() { + let key = GrokApiKey::new("secret_value_must_not_leak".to_string()); + let args = ImageGenerationArgs { + api_key: &key, + request: ImageGenerationRequest { + prompt: "p".to_string(), + model: None, + number_images: None, + aspect_ratio: None, + resolution: None, + response_format: None, + user: None, + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_value_must_not_leak"), + "serialized request must not contain the API key. got: {}", json); + } + + #[test] + fn response_body_deserializes_url() { + let json = r#"{ + "data": [ + { "url": "https://imagine.x.ai/abc.png", "revised_prompt": "a cat" } + ] + }"#; + let parsed: ImageGenerationResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.data.len(), 1); + assert_eq!(parsed.data[0].url.as_deref(), Some("https://imagine.x.ai/abc.png")); + assert!(parsed.data[0].b64_json.is_none()); + assert_eq!(parsed.data[0].revised_prompt.as_deref(), Some("a cat")); + } + + #[test] + fn response_body_deserializes_b64_json() { + let json = r#"{ + "data": [ + { "b64_json": "iVBORw0KGgo=" } + ] + }"#; + let parsed: ImageGenerationResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.data[0].b64_json.as_deref(), Some("iVBORw0KGgo=")); + assert!(parsed.data[0].url.is_none()); + } + + // ── Live API tests (ignored — incur cost) ── + + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_image_generation_simple() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = image_generation(ImageGenerationArgs { + api_key: &api_key, + request: ImageGenerationRequest { + prompt: "A serene mountain lake at sunrise, photorealistic".to_string(), + model: None, + number_images: None, + aspect_ratio: Some(ImageAspectRatio::Landscape16x9), + resolution: Some(ImageResolution::OneK), + response_format: None, + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Generated {} image(s)", result.images.len()); + for (i, img) in result.images.iter().enumerate() { + println!(" [{}] url={:?} revised_prompt={:?}", i, img.url, img.revised_prompt); + } + assert!(!result.images.is_empty()); + assert!(result.images[0].url.is_some(), "expected url-format response by default"); + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/mod.rs new file mode 100644 index 00000000..01ec9a1c --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/mod.rs @@ -0,0 +1,3 @@ +pub mod cost; +pub mod image_generation; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/request_types.rs new file mode 100644 index 00000000..7d966720 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/image_generation/request_types.rs @@ -0,0 +1,43 @@ +use serde_derive::{Deserialize, Serialize}; + +// ── Request ── + +#[derive(Serialize, Debug)] +pub(crate) struct ImageGenerationRequestBody { + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub n: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub response_format: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +// ── Response ── + +#[derive(Deserialize, Debug)] +pub(crate) struct ImageGenerationResponseBody { + pub data: Vec, +} + +#[derive(Deserialize, Debug)] +pub(crate) struct ImageGenerationResponseDatum { + pub url: Option, + pub b64_json: Option, + + /// xAI may revise the prompt (their docs call this "revised_prompt" in + /// OpenAI-compat responses). Optional, included if present. + pub revised_prompt: Option, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/images/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/images/mod.rs new file mode 100644 index 00000000..40488120 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/images/mod.rs @@ -0,0 +1,2 @@ +pub mod image_edit; +pub mod image_generation; diff --git a/crates/api_clients/grok_api_client/src/api/requests/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/mod.rs new file mode 100644 index 00000000..578c5b56 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/mod.rs @@ -0,0 +1,5 @@ +pub mod files; +pub mod images; +pub mod videos; + +pub(crate) mod xai_host; diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/mod.rs new file mode 100644 index 00000000..23ffa791 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/mod.rs @@ -0,0 +1,4 @@ +pub mod video_edit; +pub mod video_extension; +pub mod video_generation; +pub mod video_status; diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/cost.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/cost.rs new file mode 100644 index 00000000..6980d42c --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/cost.rs @@ -0,0 +1,177 @@ +use crate::api::requests::videos::video_edit::video_edit::VideoEditRequest; +use crate::api::requests::videos::video_generation::cost::{ + output_mills_per_second, + DEFAULT_VIDEO_DURATION_SECONDS, + INPUT_MILLS_PER_SECOND_OF_SOURCE_VIDEO, +}; +use crate::api::traits::grok_request_cost_calculator_trait::{GrokRequestCostCalculator, UsdMills}; +use crate::api::types::video_types::video_resolution::VideoResolution; + +/// Resolution we assume for both input and output. Video edits inherit +/// source resolution capped at 720p, so 720p is also the worst case +/// (output rate is higher at 720p than 480p). +const ASSUMED_RESOLUTION: VideoResolution = VideoResolution::SevenTwentyP; + +// `video_edit` cost depends entirely on the source video's duration: +// +// Input: 10 mills/sec × source_duration (resolution-independent) +// Output: 70 mills/sec × source_duration (720p, the assumed cap) +// Total: 80 mills/sec × source_duration +// +// xAI documents that video edits re-render the ENTIRE source video — output +// duration mirrors source duration, output resolution mirrors source +// resolution (capped at 720p, which is also our max-supported variant). +// +// Source duration isn't in the request body, but callers can populate the +// `source_video_duration_seconds_hint` field on `VideoEditRequest` for an +// accurate estimate. Without it we fall back to xAI's 8-second generation +// default so callers don't get a misleadingly-free quote. + +impl GrokRequestCostCalculator for VideoEditRequest { + /// Uses [`VideoEditRequest::source_video_duration_seconds_hint`] when set + /// (the caller-supplied source duration drives both the input AND output + /// billing); otherwise falls back to [`DEFAULT_VIDEO_DURATION_SECONDS`] + /// (8s, matching xAI's `/v1/videos/generations` default). + /// + /// Resolution is always assumed to be 720p — the request body can't + /// carry the source's actual resolution and 720p is both xAI's cap and + /// the worst case for cost. + /// + /// Formula: `secs × (10 input + 70 output@720p) = 80 × secs` mills. + /// + /// At the 8-second default: 8 × 80 = **640 mills (64¢)**. + fn calculate_cost_in_mills(&self) -> UsdMills { + let secs = self + .source_video_duration_seconds_hint + .unwrap_or(DEFAULT_VIDEO_DURATION_SECONDS) as u64; + let per_second = INPUT_MILLS_PER_SECOND_OF_SOURCE_VIDEO + output_mills_per_second(ASSUMED_RESOLUTION); + per_second * secs + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::requests::videos::video_edit::video_edit::{VideoEditRequest, VideoSource}; + use crate::api::types::video_types::video_model::VideoModel; + + fn make_request(source_video: VideoSource, model: Option) -> VideoEditRequest { + VideoEditRequest { + prompt: "test edit".to_string(), + source_video, + source_video_duration_seconds_hint: None, + model, + user: None, + } + } + + // Default base-trait estimate assumes 8s source @ 720p, so: + // 8 × (10 input + 70 output) = 640 mills = 64¢ + const EXPECTED_BASE_ESTIMATE_MILLS: u64 = 640; + const EXPECTED_BASE_ESTIMATE_CENTS: u64 = 64; + + #[test] + fn base_estimate_is_conservative_eight_seconds_seven_twenty_p() { + let cases = [ + VideoSource::Url("https://example.com/v.mp4".to_string()), + VideoSource::FileId("file_abc".to_string()), + ]; + for source in cases { + let req = make_request(source, None); + assert_eq!(req.calculate_cost_in_mills(), EXPECTED_BASE_ESTIMATE_MILLS); + assert_eq!(req.calculate_cost_in_cents(), EXPECTED_BASE_ESTIMATE_CENTS); + } + } + + #[test] + fn base_estimate_is_independent_of_model() { + let r_default = make_request(VideoSource::Url("u".to_string()), None).calculate_cost_in_mills(); + let r_known = make_request(VideoSource::Url("u".to_string()), Some(VideoModel::GrokImagineVideo)).calculate_cost_in_mills(); + let r_custom = make_request(VideoSource::Url("u".to_string()), + Some(VideoModel::Custom("future".to_string()))).calculate_cost_in_mills(); + assert_eq!(r_default, EXPECTED_BASE_ESTIMATE_MILLS); + assert_eq!(r_known, EXPECTED_BASE_ESTIMATE_MILLS); + assert_eq!(r_custom, EXPECTED_BASE_ESTIMATE_MILLS); + } + + #[test] + fn base_estimate_is_independent_of_prompt_or_user() { + let mut req = make_request(VideoSource::Url("u".to_string()), None); + req.prompt = "an enormously long prompt with many tokens".repeat(100); + req.user = Some("user-id".to_string()); + assert_eq!(req.calculate_cost_in_mills(), EXPECTED_BASE_ESTIMATE_MILLS); + } + + #[test] + fn base_estimate_is_nonzero() { + // Sanity guard against accidentally regressing to the old return-0 footgun. + let req = make_request(VideoSource::Url("u".to_string()), None); + assert!(req.calculate_cost_in_mills() > 0); + assert!(req.calculate_cost_in_cents() > 0); + } + + // ── source_video_duration_seconds_hint hint ── + + mod duration_hint { + use super::*; + + #[test] + fn hint_overrides_default_duration() { + let mut req = make_request(VideoSource::Url("u".to_string()), None); + req.source_video_duration_seconds_hint = Some(5); + // 5 × 80 = 400 mills (vs the 640 mills default) + assert_eq!(req.calculate_cost_in_mills(), 400); + assert_eq!(req.calculate_cost_in_cents(), 40); + } + + #[test] + fn one_second_hint() { + let mut req = make_request(VideoSource::Url("u".to_string()), None); + req.source_video_duration_seconds_hint = Some(1); + assert_eq!(req.calculate_cost_in_mills(), 80); // 1 × 80 + assert_eq!(req.calculate_cost_in_cents(), 8); + } + + #[test] + fn fifteen_second_hint() { + let mut req = make_request(VideoSource::Url("u".to_string()), None); + req.source_video_duration_seconds_hint = Some(15); + assert_eq!(req.calculate_cost_in_mills(), 1200); // 15 × 80 + assert_eq!(req.calculate_cost_in_cents(), 120); + } + + #[test] + fn unset_hint_falls_back_to_default() { + let req = make_request(VideoSource::Url("u".to_string()), None); + assert_eq!(req.source_video_duration_seconds_hint, None); + // Default = 8s @ 720p = 640 mills. + assert_eq!(req.calculate_cost_in_mills(), 640); + } + + #[test] + fn zero_second_hint_costs_zero() { + // Edge case: 0-second source is meaningless but shouldn't panic. + let mut req = make_request(VideoSource::Url("u".to_string()), None); + req.source_video_duration_seconds_hint = Some(0); + assert_eq!(req.calculate_cost_in_mills(), 0); + } + + #[test] + fn hint_scales_linearly() { + for secs in 1u32..=20 { + let mut req = make_request(VideoSource::Url("u".to_string()), None); + req.source_video_duration_seconds_hint = Some(secs); + assert_eq!(req.calculate_cost_in_mills(), 80 * secs as u64, "secs={secs}"); + } + } + + #[test] + fn hint_is_independent_of_source_kind() { + let mut url_req = make_request(VideoSource::Url("u".to_string()), None); + let mut file_req = make_request(VideoSource::FileId("f".to_string()), None); + url_req.source_video_duration_seconds_hint = Some(7); + file_req.source_video_duration_seconds_hint = Some(7); + assert_eq!(url_req.calculate_cost_in_mills(), file_req.calculate_cost_in_mills()); + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/mod.rs new file mode 100644 index 00000000..0aa9ef93 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/mod.rs @@ -0,0 +1,3 @@ +pub mod cost; +pub mod video_edit; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/request_types.rs new file mode 100644 index 00000000..52539dd0 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/request_types.rs @@ -0,0 +1,32 @@ +use serde_derive::{Deserialize, Serialize}; + +// ── Request ── + +#[derive(Serialize, Debug)] +pub(crate) struct VideoEditRequestBody { + pub prompt: String, + + pub video: VideoSourceRef, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +#[derive(Serialize, Debug, Clone)] +pub(crate) struct VideoSourceRef { + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub file_id: Option, +} + +// ── Response ── + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoEditResponseBody { + pub request_id: String, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/video_edit.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/video_edit.rs new file mode 100644 index 00000000..1fc7a3e3 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_edit/video_edit.rs @@ -0,0 +1,257 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::videos::video_edit::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::api::types::video_types::video_model::VideoModel; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`video_edit`]. Borrows the API key separately from +/// the request body so callers can log/save [`VideoEditRequest`] without +/// leaking the credential. +#[derive(Clone, Debug)] +pub struct VideoEditArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: VideoEditRequest, +} + +/// The material part of a video-edit request. Derives [`Serialize`] so it +/// can be persisted to a log or audit store independently of the API key. +#[derive(Clone, Debug, Serialize)] +pub struct VideoEditRequest { + /// Edit instruction. Required. + pub prompt: String, + + /// Source video to modify (xAI reads this as the input). + pub source_video: VideoSource, + + /// **Cost-estimation hint — NOT sent to xAI, has zero effect on the + /// actual HTTP request.** Duration in whole seconds of the video at + /// [`source_video`](Self::source_video). When set, the + /// [`crate::api::traits::grok_request_cost_calculator_trait::GrokRequestCostCalculator`] + /// impl uses it for an accurate cost estimate; when `None`, the impl + /// falls back to a conservative default (xAI's 8-second generation + /// default). Populate this field if you already know the source's + /// runtime (e.g. from ffprobe or an upstream generate call) so internal + /// cost tracking stays correct. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_video_duration_seconds_hint: Option, + + /// Model identifier. Defaults to [`VideoModel::GrokImagineVideo`] when `None`. + /// Use [`VideoModel::Custom`] for identifiers not yet listed in the enum. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +/// Source video to edit. Pick by public URL or by a previously-uploaded +/// xAI file_id. +#[derive(Clone, Debug, Serialize)] +pub enum VideoSource { + /// Public HTTPS URL pointing to the source video. xAI fetches the bytes + /// on its end. + Url(String), + + /// xAI file identifier (`file_...`) obtained from a successful upload via + /// [`crate::api::requests::files::upload_file::upload_file::upload_file`]. + /// + /// Docs: + /// - + /// - + FileId(String), +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct VideoEditSuccess { + /// Use this with `video_status` to poll for completion. + pub request_id: String, +} + +// ── Implementation ── + +/// POST https://api.x.ai/v1/videos/edits — modify an existing video based on +/// a text prompt. Asynchronous; poll `video_status` for completion. +/// +/// xAI states the `duration`, `aspectRatio`, and `resolution` parameters are +/// ignored for video edits — the output mirrors the source video. +/// +/// Docs: +pub async fn video_edit(args: VideoEditArgs<'_>) -> Result { + let req = args.request; + + let url = format!("{}/v1/videos/edits", XAI_API_BASE_URL); + let model = req.model.unwrap_or(VideoModel::GrokImagineVideo); + + info!("Grok video_edit: model={}", model.as_str()); + + let request_body = VideoEditRequestBody { + prompt: req.prompt, + video: to_video_source_ref(&req.source_video), + model: Some(model.as_str().to_string()), + user: req.user, + }; + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.post(&url) + .header("Authorization", bearer) + .header("Content-Type", "application/json") + .json(&request_body) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok video_edit response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: VideoEditResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(VideoEditSuccess { request_id: parsed.request_id }) +} + +fn to_video_source_ref(source: &VideoSource) -> VideoSourceRef { + match source { + VideoSource::Url(u) => VideoSourceRef { url: Some(u.clone()), file_id: None }, + VideoSource::FileId(id) => VideoSourceRef { url: None, file_id: Some(id.clone()) }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + // ── Wire-format shape tests ── + + #[test] + fn wire_body_serializes_url_source() { + let body = VideoEditRequestBody { + prompt: "make it stormy".to_string(), + video: VideoSourceRef { url: Some("https://example.com/v.mp4".to_string()), file_id: None }, + model: Some("grok-imagine-video".to_string()), + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"prompt\":\"make it stormy\"")); + assert!(json.contains("\"video\":{\"url\":\"https://example.com/v.mp4\"}")); + assert!(json.contains("\"model\":\"grok-imagine-video\"")); + assert!(!json.contains("\"file_id\"")); + } + + #[test] + fn wire_body_serializes_file_id_source() { + let body = VideoEditRequestBody { + prompt: "p".to_string(), + video: VideoSourceRef { url: None, file_id: Some("file_v".to_string()) }, + model: None, + user: Some("u".to_string()), + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"video\":{\"file_id\":\"file_v\"}")); + assert!(json.contains("\"user\":\"u\"")); + } + + // ── Public Request shape ── + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = VideoEditArgs { + api_key: &key, + request: VideoEditRequest { + prompt: "p".to_string(), + source_video: VideoSource::FileId("file_abc".to_string()), + source_video_duration_seconds_hint: None, + model: None, + user: None, + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak")); + assert!(json.contains("\"source_video\":{\"FileId\":\"file_abc\"}")); + // Hint omitted when None. + assert!(!json.contains("source_video_duration_seconds_hint")); + } + + #[test] + fn source_duration_hint_serializes_when_set() { + let req = VideoEditRequest { + prompt: "p".to_string(), + source_video: VideoSource::Url("u".to_string()), + source_video_duration_seconds_hint: Some(12), + model: None, + user: None, + }; + let json = serde_json::to_string(&req).unwrap(); + assert!(json.contains("\"source_video_duration_seconds_hint\":12")); + } + + #[test] + fn source_duration_hint_is_not_in_wire_body() { + // The internal wire body (what actually gets POSTed to xAI) doesn't + // carry the hint — it's intentionally absent from VideoEditRequestBody. + let body = VideoEditRequestBody { + prompt: "p".to_string(), + video: VideoSourceRef { url: Some("u".to_string()), file_id: None }, + model: None, + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(!json.contains("source_video_duration_seconds_hint")); + } + + #[test] + fn response_body_deserializes() { + let json = r#"{ "request_id": "0199c33d-3afa-7000-b400-deadbeefcafe" }"#; + let parsed: VideoEditResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.request_id, "0199c33d-3afa-7000-b400-deadbeefcafe"); + } + + // ── Live API tests ── + + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_video_edit() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + use test_data::web::video_urls::ANGRY_SHIBA_VIDEO_URL; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_edit(VideoEditArgs { + api_key: &api_key, + request: VideoEditRequest { + prompt: "Change the lighting to midnight. Starry sky with the mily way overhead. Add some shooting stars. Everything is glowing under the starlight.".to_string(), + source_video: VideoSource::Url(ANGRY_SHIBA_VIDEO_URL.to_string()), + source_video_duration_seconds_hint: None, + model: None, + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Edit request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/cost.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/cost.rs new file mode 100644 index 00000000..9315b968 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/cost.rs @@ -0,0 +1,209 @@ +use crate::api::requests::videos::video_extension::video_extension::VideoExtensionRequest; +use crate::api::requests::videos::video_generation::cost::{ + output_mills_per_second, + INPUT_MILLS_PER_SECOND_OF_SOURCE_VIDEO, +}; +use crate::api::traits::grok_request_cost_calculator_trait::{GrokRequestCostCalculator, UsdMills}; +use crate::api::types::video_types::video_resolution::VideoResolution; + +// `video_extension` charges: +// +// Output: 70 mills/sec × extension_duration (assumed 720p, since output +// inherits the source's resolution capped at 720p) +// Input: 10 mills/sec × source_duration (only billed when caller +// supplies a duration hint) +// +// `extension_duration` is the `duration` field on the request (xAI default +// is 6 seconds; range 1–10). `source_duration` isn't in the wire body, but +// callers can populate `source_video_duration_seconds_hint` on the public +// Request to drive the input-side billing. + +/// xAI default duration for video_extension when `duration` is omitted. +const DEFAULT_EXTENSION_DURATION_SECONDS: u32 = 6; + +/// Assumed output resolution. xAI caps extension output at 720p, so this +/// is the worst case for cost. +const ASSUMED_RESOLUTION: VideoResolution = VideoResolution::SevenTwentyP; + +impl GrokRequestCostCalculator for VideoExtensionRequest { + /// Output portion (always billed): extension duration × 70 mills/sec at + /// the assumed 720p output. + /// + /// Input portion (billed only when + /// [`VideoExtensionRequest::source_video_duration_seconds_hint`] is set): + /// 10 mills/sec × hinted source duration. + /// + /// Formula: + /// - hint unset: `extension_duration × 70` + /// - hint set: `extension_duration × 70 + source_duration × 10` + fn calculate_cost_in_mills(&self) -> UsdMills { + let extension_duration = self.duration.unwrap_or(DEFAULT_EXTENSION_DURATION_SECONDS) as u64; + let output_mills = output_mills_per_second(ASSUMED_RESOLUTION) * extension_duration; + let input_mills = self + .source_video_duration_seconds_hint + .map(|secs| INPUT_MILLS_PER_SECOND_OF_SOURCE_VIDEO * secs as u64) + .unwrap_or(0); + output_mills + input_mills + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::requests::videos::video_extension::video_extension::{ + VideoExtensionRequest, VideoExtensionSource, + }; + use crate::api::types::video_types::video_model::VideoModel; + + fn make_request( + duration: Option, + source: VideoExtensionSource, + model: Option, + ) -> VideoExtensionRequest { + VideoExtensionRequest { + prompt: "test".to_string(), + source_video: source, + source_video_duration_seconds_hint: None, + model, + duration, + } + } + + fn url_source() -> VideoExtensionSource { + VideoExtensionSource::Url("https://example.com/v.mp4".to_string()) + } + + // ── Output portion (the part we CAN compute) ── + + mod output_portion { + use super::*; + + #[test] + fn default_duration_is_6_seconds() { + // 70 × 6 = 420 mills = 42¢ + let req = make_request(None, url_source(), None); + assert_eq!(req.calculate_cost_in_mills(), 420); + assert_eq!(req.calculate_cost_in_cents(), 42); + } + + #[test] + fn one_second_extension() { + // 70 × 1 = 70 mills = 7¢ + let req = make_request(Some(1), url_source(), None); + assert_eq!(req.calculate_cost_in_mills(), 70); + assert_eq!(req.calculate_cost_in_cents(), 7); + } + + #[test] + fn five_second_extension() { + // 70 × 5 = 350 mills = 35¢ + let req = make_request(Some(5), url_source(), None); + assert_eq!(req.calculate_cost_in_mills(), 350); + assert_eq!(req.calculate_cost_in_cents(), 35); + } + + #[test] + fn ten_second_extension_is_max() { + // 70 × 10 = 700 mills = 70¢ + let req = make_request(Some(10), url_source(), None); + assert_eq!(req.calculate_cost_in_mills(), 700); + assert_eq!(req.calculate_cost_in_cents(), 70); + } + } + + // ── Scaling ── + + mod scaling { + use super::*; + + #[test] + fn duration_scales_linearly() { + for d in 1u32..=10 { + let req = make_request(Some(d), url_source(), None); + assert_eq!(req.calculate_cost_in_mills(), 70 * d as u64, "d={d}"); + } + } + } + + // ── Independence from non-pricing fields ── + + mod independence { + use super::*; + + #[test] + fn cost_is_independent_of_source_kind() { + let url = make_request(Some(5), VideoExtensionSource::Url("u".to_string()), None); + let file = make_request(Some(5), VideoExtensionSource::FileId("f".to_string()), None); + assert_eq!(url.calculate_cost_in_mills(), file.calculate_cost_in_mills()); + } + + #[test] + fn cost_is_independent_of_model_variant() { + let mut base = make_request(Some(5), url_source(), None); + let base_cost = base.calculate_cost_in_mills(); + base.model = Some(VideoModel::GrokImagineVideo); + assert_eq!(base.calculate_cost_in_mills(), base_cost); + base.model = Some(VideoModel::Custom("future".to_string())); + assert_eq!(base.calculate_cost_in_mills(), base_cost); + } + + #[test] + fn cost_is_independent_of_prompt_length() { + let mut base = make_request(Some(5), url_source(), None); + let base_cost = base.calculate_cost_in_mills(); + base.prompt = "a much longer prompt with many more words to influence pricing... or not".to_string(); + assert_eq!(base.calculate_cost_in_mills(), base_cost); + } + } + + + // ── source_video_duration_seconds_hint hint ── + + mod duration_hint { + use super::*; + + #[test] + fn unset_hint_returns_output_only() { + // ext=5s @ 720p, no hint → just output portion: 70 × 5 = 350 + let req = make_request(Some(5), url_source(), None); + assert_eq!(req.source_video_duration_seconds_hint, None); + assert_eq!(req.calculate_cost_in_mills(), 350); + } + + #[test] + fn set_hint_adds_input_portion() { + // ext=5s @ 720p, source=10s → output 350 + input 100 = 450 + let mut req = make_request(Some(5), url_source(), None); + req.source_video_duration_seconds_hint = Some(10); + assert_eq!(req.calculate_cost_in_mills(), 450); + assert_eq!(req.calculate_cost_in_cents(), 45); + } + + #[test] + fn hint_zero_is_treated_as_zero_input() { + // ext=5s @ 720p, source=0 → output 350 + 0 = 350 + let mut req = make_request(Some(5), url_source(), None); + req.source_video_duration_seconds_hint = Some(0); + assert_eq!(req.calculate_cost_in_mills(), 350); + } + + #[test] + fn default_extension_with_hint() { + // ext default=6s @ 720p (output 420), source=5s (input 50) → 470 + let mut req = make_request(None, url_source(), None); + req.source_video_duration_seconds_hint = Some(5); + assert_eq!(req.calculate_cost_in_mills(), 470); + assert_eq!(req.calculate_cost_in_cents(), 47); + } + + #[test] + fn hint_scales_linearly() { + // Fix ext=5s (output 350); vary hint from 0..30. + for source_secs in 0u32..=30 { + let mut req = make_request(Some(5), url_source(), None); + req.source_video_duration_seconds_hint = Some(source_secs); + assert_eq!(req.calculate_cost_in_mills(), 350 + 10 * source_secs as u64, "source_secs={source_secs}"); + } + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/mod.rs new file mode 100644 index 00000000..3769e452 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/mod.rs @@ -0,0 +1,3 @@ +pub mod cost; +pub mod video_extension; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/request_types.rs new file mode 100644 index 00000000..d43b42e2 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/request_types.rs @@ -0,0 +1,34 @@ +use serde_derive::{Deserialize, Serialize}; + +// ── Request ── + +#[derive(Serialize, Debug)] +pub(crate) struct VideoExtensionRequestBody { + pub prompt: String, + + pub video: VideoExtensionSourceRef, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + /// Length of the *extension only*, not the total output. xAI default is 6 + /// seconds; range 1–10. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, +} + +#[derive(Serialize, Debug, Clone)] +pub(crate) struct VideoExtensionSourceRef { + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub file_id: Option, +} + +// ── Response ── + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoExtensionResponseBody { + pub request_id: String, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/video_extension.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/video_extension.rs new file mode 100644 index 00000000..8db1d0e4 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_extension/video_extension.rs @@ -0,0 +1,258 @@ +use log::info; +use serde_derive::Serialize; + +use crate::api::requests::videos::video_extension::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::api::types::video_types::video_model::VideoModel; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`video_extension`]. Borrows the API key separately +/// from the request body so callers can log/save [`VideoExtensionRequest`] +/// without leaking the credential. +#[derive(Clone, Debug)] +pub struct VideoExtensionArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: VideoExtensionRequest, +} + +/// The material part of a video-extension request. Derives [`Serialize`] so +/// it can be persisted to a log or audit store independently of the API key. +#[derive(Clone, Debug, Serialize)] +pub struct VideoExtensionRequest { + /// Prompt describing what should happen in the extension. + pub prompt: String, + + /// Source video to extend. + pub source_video: VideoExtensionSource, + + /// **Cost-estimation hint — NOT sent to xAI, has zero effect on the + /// actual HTTP request.** Duration in whole seconds of the video at + /// [`source_video`](Self::source_video). When set, the + /// [`crate::api::traits::grok_request_cost_calculator_trait::GrokRequestCostCalculator`] + /// impl includes the input-side billing (10 mills/sec × source duration) + /// in the estimate; when `None`, the impl returns the output portion + /// only (extension duration × output rate). Populate this field if you + /// already know the source's runtime (e.g. from ffprobe or an upstream + /// generate call) so internal cost tracking reflects the true total. + #[serde(skip_serializing_if = "Option::is_none")] + pub source_video_duration_seconds_hint: Option, + + /// Model identifier. Defaults to [`VideoModel::GrokImagineVideo`] when `None`. + /// Use [`VideoModel::Custom`] for identifiers not yet listed in the enum. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + /// Length of the *extension only*, not the total output. xAI default is 6 + /// seconds; range 1–10. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, +} + +/// Source video to extend. Pick by public URL or by a previously-uploaded +/// xAI file_id. +#[derive(Clone, Debug, Serialize)] +pub enum VideoExtensionSource { + /// Public HTTPS URL pointing to the source video. + Url(String), + + /// xAI file identifier (`file_...`) obtained from a successful upload via + /// [`crate::api::requests::files::upload_file::upload_file::upload_file`]. + /// + /// Docs: + /// - + /// - + FileId(String), +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct VideoExtensionSuccess { + /// Use this with `video_status` to poll for completion. + pub request_id: String, +} + +// ── Implementation ── + +/// POST https://api.x.ai/v1/videos/extensions — extend an existing video with +/// additional generated content. +/// +/// Asynchronous; poll `video_status` for completion. +/// +/// Docs: +pub async fn video_extension(args: VideoExtensionArgs<'_>) -> Result { + let req = args.request; + + let url = format!("{}/v1/videos/extensions", XAI_API_BASE_URL); + let model = req.model.unwrap_or(VideoModel::GrokImagineVideo); + + info!("Grok video_extension: model={}, duration={:?}", model.as_str(), req.duration); + + let request_body = VideoExtensionRequestBody { + prompt: req.prompt, + video: to_extension_source_ref(&req.source_video), + model: Some(model.as_str().to_string()), + duration: req.duration, + }; + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.post(&url) + .header("Authorization", bearer) + .header("Content-Type", "application/json") + .json(&request_body) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok video_extension response: status={}", status); + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: VideoExtensionResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(VideoExtensionSuccess { request_id: parsed.request_id }) +} + +fn to_extension_source_ref(source: &VideoExtensionSource) -> VideoExtensionSourceRef { + match source { + VideoExtensionSource::Url(u) => VideoExtensionSourceRef { url: Some(u.clone()), file_id: None }, + VideoExtensionSource::FileId(id) => VideoExtensionSourceRef { url: None, file_id: Some(id.clone()) }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + // ── Wire-format shape tests ── + + #[test] + fn wire_body_serializes_minimal() { + let body = VideoExtensionRequestBody { + prompt: "keep walking".to_string(), + video: VideoExtensionSourceRef { url: Some("https://example.com/v.mp4".to_string()), file_id: None }, + model: Some("grok-imagine-video".to_string()), + duration: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"prompt\":\"keep walking\"")); + assert!(json.contains("\"video\":{\"url\":\"https://example.com/v.mp4\"}")); + assert!(json.contains("\"model\":\"grok-imagine-video\"")); + assert!(!json.contains("\"duration\"")); + } + + #[test] + fn wire_body_serializes_with_duration() { + let body = VideoExtensionRequestBody { + prompt: "p".to_string(), + video: VideoExtensionSourceRef { url: None, file_id: Some("file_v".to_string()) }, + model: None, + duration: Some(8), + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"duration\":8")); + assert!(json.contains("\"video\":{\"file_id\":\"file_v\"}")); + } + + // ── Public Request shape ── + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = VideoExtensionArgs { + api_key: &key, + request: VideoExtensionRequest { + prompt: "p".to_string(), + source_video: VideoExtensionSource::Url("u".to_string()), + source_video_duration_seconds_hint: None, + model: None, + duration: Some(5), + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak")); + assert!(json.contains("\"duration\":5")); + assert!(json.contains("\"source_video\":{\"Url\":\"u\"}")); + // Hint omitted when None. + assert!(!json.contains("source_video_duration_seconds_hint")); + } + + #[test] + fn source_duration_hint_serializes_when_set() { + let req = VideoExtensionRequest { + prompt: "p".to_string(), + source_video: VideoExtensionSource::Url("u".to_string()), + source_video_duration_seconds_hint: Some(7), + model: None, + duration: Some(5), + }; + let json = serde_json::to_string(&req).unwrap(); + assert!(json.contains("\"source_video_duration_seconds_hint\":7")); + } + + #[test] + fn source_duration_hint_is_not_in_wire_body() { + // The internal wire body (what actually gets POSTed to xAI) doesn't + // carry the hint — it's intentionally absent from VideoExtensionRequestBody. + let body = VideoExtensionRequestBody { + prompt: "p".to_string(), + video: VideoExtensionSourceRef { url: Some("u".to_string()), file_id: None }, + model: None, + duration: Some(5), + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(!json.contains("source_video_duration_seconds_hint")); + } + + #[test] + fn response_body_deserializes() { + let json = r#"{ "request_id": "ext-abc-123" }"#; + let parsed: VideoExtensionResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.request_id, "ext-abc-123"); + } + + // ── Live API tests ── + + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_video_extension() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + use test_data::web::video_urls::ANGRY_SHIBA_VIDEO_URL; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_extension(VideoExtensionArgs { + api_key: &api_key, + request: VideoExtensionRequest { + prompt: "Continue the walk down the same street".to_string(), + source_video: VideoExtensionSource::Url(ANGRY_SHIBA_VIDEO_URL.to_string()), + source_video_duration_seconds_hint: None, + model: None, + duration: Some(5), + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Extension request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/cost.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/cost.rs new file mode 100644 index 00000000..925c546b --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/cost.rs @@ -0,0 +1,518 @@ +use crate::api::requests::videos::video_generation::video_generation::VideoGenerationRequest; +use crate::api::traits::grok_request_cost_calculator_trait::{GrokRequestCostCalculator, UsdMills}; +use crate::api::types::video_types::video_model::{VideoModel, VideoModelPricingTier}; +use crate::api::types::video_types::video_resolution::VideoResolution; + +// xAI pricing per and +// : +// +// grok-imagine-video (v1) +// Output: 480p $0.05/sec, 720p $0.07/sec +// Input: $0.01/sec (source video) + $0.002/img (source images) +// +// grok-imagine-video-1.5 (v1.5) +// Output: 480p $0.08/sec, 720p $0.14/sec, 1080p $0.25/sec +// Input: $0.01/img (source images) +// +// In mills (1¢ = 10 mills): +// +// v1 output: 480p 50 mills/sec, 720p 70 mills/sec +// v1 input: 10 mills/sec (video), 2 mills/img +// v1.5 output: 480p 80 mills/sec, 720p 140 mills/sec, 1080p 250 mills/sec +// v1.5 input: 10 mills/img +// +// video_generation has NO input video — only optional input images. xAI +// defaults: `duration` = 8 seconds, `resolution` = "480p" (the server side; +// our local default below is 720p — see DEFAULT comments in the impl). + +/// xAI default duration for video_generation when `duration` is omitted. +pub(crate) const DEFAULT_VIDEO_DURATION_SECONDS: u32 = 8; + +/// Per-source-image input rate (v1 tier), in mills. +pub(crate) const INPUT_MILLS_PER_IMAGE: UsdMills = 2; + +/// Per-source-image input rate (v1.5 tier), in mills. +const INPUT_MILLS_PER_IMAGE_V1P5: UsdMills = 10; + +/// Per-source-second input rate (when a source video is supplied) for video +/// endpoints, in mills. Not used by `video_generation` (which has no source +/// video) but referenced by `video_edit` and `video_extension`. +pub(crate) const INPUT_MILLS_PER_SECOND_OF_SOURCE_VIDEO: UsdMills = 10; + +impl GrokRequestCostCalculator for VideoGenerationRequest { + fn calculate_cost_in_mills(&self) -> UsdMills { + let duration = self.duration.unwrap_or(DEFAULT_VIDEO_DURATION_SECONDS) as u64; + let resolution = self.resolution.unwrap_or(VideoResolution::SevenTwentyP); + let tier = self.model + .as_ref() + .map(VideoModel::pricing_tier) + .unwrap_or(VideoModelPricingTier::V1); + + let output_mills = output_mills_per_second_for_tier(resolution, tier) * duration; + + // Source image count = `image` (image-to-video) + len(`reference_images`) + // (reference-to-video). These are mutually exclusive at call time but the + // cost math doesn't need to enforce that — it just counts. + let source_image_count: u64 = + (self.image.is_some() as u64) + + (self.reference_images.as_ref().map(|v| v.len() as u64).unwrap_or(0)); + + let input_mills = input_mills_per_image(tier) * source_image_count; + + output_mills + input_mills + } +} + +/// Output rate in mills per second of generated video at v1 rates, by +/// resolution. Kept for cross-module use by `video_edit` and +/// `video_extension`, which both assume v1 pricing and do not currently take +/// a model into account in their cost calculators. +pub(crate) fn output_mills_per_second(resolution: VideoResolution) -> UsdMills { + output_mills_per_second_for_tier(resolution, VideoModelPricingTier::V1) +} + +/// Output rate in mills per second of generated video, by resolution AND +/// pricing tier. Used by `video_generation`. +fn output_mills_per_second_for_tier( + resolution: VideoResolution, + tier: VideoModelPricingTier, +) -> UsdMills { + match (tier, resolution) { + (VideoModelPricingTier::V1, VideoResolution::FourEightyP) => 50, + (VideoModelPricingTier::V1, VideoResolution::SevenTwentyP) => 70, + // v1 doesn't produce 1080p output (it downsizes to 720p); price at 720p. + (VideoModelPricingTier::V1, VideoResolution::TenEightyP) => 70, + (VideoModelPricingTier::V1p5, VideoResolution::FourEightyP) => 80, + (VideoModelPricingTier::V1p5, VideoResolution::SevenTwentyP) => 140, + (VideoModelPricingTier::V1p5, VideoResolution::TenEightyP) => 250, + } +} + +fn input_mills_per_image(tier: VideoModelPricingTier) -> UsdMills { + match tier { + VideoModelPricingTier::V1 => INPUT_MILLS_PER_IMAGE, + VideoModelPricingTier::V1p5 => INPUT_MILLS_PER_IMAGE_V1P5, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::requests::videos::video_generation::video_generation::VideoImageSource; + use crate::api::types::video_types::video_aspect_ratio::VideoAspectRatio; + use crate::api::types::video_types::video_model::VideoModel; + + fn make_request( + duration: Option, + resolution: Option, + image: Option, + reference_images: Option>, + ) -> VideoGenerationRequest { + VideoGenerationRequest { + prompt: "test".to_string(), + model: None, + image, + reference_images, + aspect_ratio: None, + duration, + resolution, + user: None, + } + } + + fn url_source() -> VideoImageSource { + VideoImageSource::Url("https://example.com/img.png".to_string()) + } + + // ── Output rate sanity ── + + mod output_rate { + use super::*; + + #[test] + fn rate_480p_is_50_mills_per_sec() { + assert_eq!(output_mills_per_second(VideoResolution::FourEightyP), 50); + } + + #[test] + fn rate_720p_is_70_mills_per_sec() { + assert_eq!(output_mills_per_second(VideoResolution::SevenTwentyP), 70); + } + } + + // ── Pure text-to-video (no input images) ── + + mod text_to_video { + use super::*; + + #[test] + fn fully_default_is_8s_720p() { + // Default duration 8s, default resolution 720p (per our defaults in cost.rs). + // 70 × 8 = 560 mills = 56¢ + let req = make_request(None, None, None, None); + assert_eq!(req.calculate_cost_in_mills(), 560); + assert_eq!(req.calculate_cost_in_cents(), 56); + } + + #[test] + fn five_seconds_480p() { + // 50 × 5 = 250 mills = 25¢ + let req = make_request(Some(5), Some(VideoResolution::FourEightyP), None, None); + assert_eq!(req.calculate_cost_in_mills(), 250); + assert_eq!(req.calculate_cost_in_cents(), 25); + } + + #[test] + fn five_seconds_720p() { + // 70 × 5 = 350 mills = 35¢ + let req = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None); + assert_eq!(req.calculate_cost_in_mills(), 350); + assert_eq!(req.calculate_cost_in_cents(), 35); + } + + #[test] + fn fifteen_seconds_720p_is_max_duration() { + // 70 × 15 = 1050 mills = $1.05 + let req = make_request(Some(15), Some(VideoResolution::SevenTwentyP), None, None); + assert_eq!(req.calculate_cost_in_mills(), 1050); + assert_eq!(req.calculate_cost_in_cents(), 105); + } + } + + // ── Image-to-video (single source image) ── + + mod image_to_video { + use super::*; + + #[test] + fn five_seconds_480p_one_source_image() { + // 50 × 5 + 2 × 1 = 252 mills = 26¢ (ceil) + let req = make_request(Some(5), Some(VideoResolution::FourEightyP), Some(url_source()), None); + assert_eq!(req.calculate_cost_in_mills(), 252); + assert_eq!(req.calculate_cost_in_cents(), 26); + } + + #[test] + fn five_seconds_720p_one_source_image() { + // 70 × 5 + 2 = 352 mills = 36¢ (ceil) + let req = make_request(Some(5), Some(VideoResolution::SevenTwentyP), Some(url_source()), None); + assert_eq!(req.calculate_cost_in_mills(), 352); + assert_eq!(req.calculate_cost_in_cents(), 36); + } + } + + // ── Reference-to-video (multiple source images) ── + + mod reference_to_video { + use super::*; + + #[test] + fn five_seconds_720p_two_reference_images() { + // 70 × 5 + 2 × 2 = 354 mills = 36¢ (ceil) + let req = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, Some(vec![url_source(), url_source()])); + assert_eq!(req.calculate_cost_in_mills(), 354); + assert_eq!(req.calculate_cost_in_cents(), 36); + } + + #[test] + fn five_seconds_720p_three_reference_images() { + // 70 × 5 + 2 × 3 = 356 mills + let req = make_request( + Some(5), Some(VideoResolution::SevenTwentyP), + None, Some(vec![url_source(), url_source(), url_source()]), + ); + assert_eq!(req.calculate_cost_in_mills(), 356); + } + + #[test] + fn input_image_count_scales_linearly() { + let base = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None).calculate_cost_in_mills(); + for n in 1usize..=5 { + let imgs: Vec<_> = (0..n).map(|_| url_source()).collect(); + let req = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, Some(imgs)); + assert_eq!(req.calculate_cost_in_mills(), base + INPUT_MILLS_PER_IMAGE * n as u64, "n={n}"); + } + } + } + + // ── Defaults ── + + mod defaults { + use super::*; + + #[test] + fn default_duration_is_8_seconds() { + let r1 = make_request(None, Some(VideoResolution::FourEightyP), None, None); + let r2 = make_request(Some(8), Some(VideoResolution::FourEightyP), None, None); + assert_eq!(r1.calculate_cost_in_mills(), r2.calculate_cost_in_mills()); + } + + #[test] + fn default_resolution_is_720p() { + let r1 = make_request(Some(5), None, None, None); + let r2 = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None); + assert_eq!(r1.calculate_cost_in_mills(), r2.calculate_cost_in_mills()); + } + } + + // ── Independence from non-pricing fields ── + + mod independence { + use super::*; + + #[test] + fn cost_is_independent_of_aspect_ratio() { + let mut base = make_request(Some(5), Some(VideoResolution::FourEightyP), None, None); + let base_cost = base.calculate_cost_in_mills(); + for ar in [ + VideoAspectRatio::Square, + VideoAspectRatio::Landscape16x9, + VideoAspectRatio::Portrait9x16, + VideoAspectRatio::Portrait2x3, + ] { + base.aspect_ratio = Some(ar); + assert_eq!(base.calculate_cost_in_mills(), base_cost, "{ar:?}"); + } + } + + #[test] + fn cost_within_v1_tier_is_independent_of_model_variant() { + // Within the v1 pricing tier (default + unrecognized Custom strings), + // model variant must not affect cost. + let mut base = make_request(Some(5), Some(VideoResolution::FourEightyP), None, None); + let base_cost = base.calculate_cost_in_mills(); + for m in [ + VideoModel::GrokImagineVideo, + VideoModel::Custom("grok-imagine-video-future".to_string()), + ] { + base.model = Some(m.clone()); + assert_eq!(base.calculate_cost_in_mills(), base_cost, "{:?}", m.as_str()); + } + } + } + + // ── grok-imagine-video-1.5-preview pricing ── + // + // v1.5 rates per the model's docs page: + // 480p: 80 mills/sec, 720p: 140 mills/sec, 10 mills per source image. + + mod v1p5_preview { + use super::*; + + fn make_v1p5_request( + duration: Option, + resolution: Option, + image: Option, + reference_images: Option>, + ) -> VideoGenerationRequest { + let mut req = make_request(duration, resolution, image, reference_images); + req.model = Some(VideoModel::GrokImagineVideo1p5); + req + } + + #[test] + fn five_seconds_480p_text_only() { + // 80 × 5 = 400 mills = 40¢ + let req = make_v1p5_request(Some(5), Some(VideoResolution::FourEightyP), None, None); + assert_eq!(req.calculate_cost_in_mills(), 400); + assert_eq!(req.calculate_cost_in_cents(), 40); + } + + #[test] + fn five_seconds_720p_text_only() { + // 140 × 5 = 700 mills = 70¢ + let req = make_v1p5_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None); + assert_eq!(req.calculate_cost_in_mills(), 700); + assert_eq!(req.calculate_cost_in_cents(), 70); + } + + #[test] + fn five_seconds_1080p_text_only() { + // 250 × 5 = 1250 mills = $1.25 + let req = make_v1p5_request(Some(5), Some(VideoResolution::TenEightyP), None, None); + assert_eq!(req.calculate_cost_in_mills(), 1250); + assert_eq!(req.calculate_cost_in_cents(), 125); + } + + #[test] + fn five_seconds_1080p_one_source_image() { + // 250 × 5 + 10 = 1260 mills = $1.26 + let req = make_v1p5_request(Some(5), Some(VideoResolution::TenEightyP), Some(url_source()), None); + assert_eq!(req.calculate_cost_in_mills(), 1260); + assert_eq!(req.calculate_cost_in_cents(), 126); + } + + #[test] + fn five_seconds_720p_one_source_image() { + // 140 × 5 + 10 × 1 = 710 mills = 71¢ + let req = make_v1p5_request(Some(5), Some(VideoResolution::SevenTwentyP), Some(url_source()), None); + assert_eq!(req.calculate_cost_in_mills(), 710); + assert_eq!(req.calculate_cost_in_cents(), 71); + } + + #[test] + fn five_seconds_480p_three_reference_images() { + // 80 × 5 + 10 × 3 = 430 mills = 43¢ + let req = make_v1p5_request( + Some(5), Some(VideoResolution::FourEightyP), + None, Some(vec![url_source(), url_source(), url_source()]), + ); + assert_eq!(req.calculate_cost_in_mills(), 430); + assert_eq!(req.calculate_cost_in_cents(), 43); + } + + #[test] + fn dated_alias_via_custom_is_billed_as_v1p5() { + // xAI accepts the dated alias as a synonym; cost must match the + // canonical 1.5 variant exactly. + let canonical = { + let mut req = make_v1p5_request(Some(5), Some(VideoResolution::SevenTwentyP), Some(url_source()), None); + req.model = Some(VideoModel::GrokImagineVideo1p5); + req.calculate_cost_in_mills() + }; + let via_alias = { + let mut req = make_v1p5_request(Some(5), Some(VideoResolution::SevenTwentyP), Some(url_source()), None); + req.model = Some(VideoModel::Custom("grok-imagine-video-1.5-2026-05-30".to_string())); + req.calculate_cost_in_mills() + }; + assert_eq!(canonical, via_alias); + } + + #[test] + fn custom_with_canonical_1p5_name_is_billed_as_v1p5() { + let via_custom = { + let mut req = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None); + req.model = Some(VideoModel::Custom("grok-imagine-video-1.5-preview".to_string())); + req.calculate_cost_in_mills() + }; + let via_enum = make_v1p5_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None) + .calculate_cost_in_mills(); + assert_eq!(via_custom, via_enum); + } + + #[test] + fn v1p5_costs_more_than_v1_at_same_settings() { + let v1 = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None).calculate_cost_in_mills(); + let v1p5 = make_v1p5_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None).calculate_cost_in_mills(); + assert!(v1 < v1p5, "v1={v1} v1p5={v1p5}"); + } + + // (duration, resolution, has_image, ref_count, expected_mills) + const V1P5_CASES: &[(u32, VideoResolution, bool, usize, u64)] = &[ + // 480p text-only + ( 1, VideoResolution::FourEightyP, false, 0, 80), + ( 8, VideoResolution::FourEightyP, false, 0, 640), + (15, VideoResolution::FourEightyP, false, 0, 1200), + // 720p text-only + ( 1, VideoResolution::SevenTwentyP, false, 0, 140), + ( 8, VideoResolution::SevenTwentyP, false, 0, 1120), + (15, VideoResolution::SevenTwentyP, false, 0, 2100), + // 480p with image-to-video + ( 5, VideoResolution::FourEightyP, true, 0, 410), + (10, VideoResolution::FourEightyP, true, 0, 810), + // 720p with image-to-video + ( 5, VideoResolution::SevenTwentyP, true, 0, 710), + // 720p with reference images + ( 5, VideoResolution::SevenTwentyP, false, 2, 720), + ( 5, VideoResolution::SevenTwentyP, false, 3, 730), + // 1080p (250 mills/sec) + ( 1, VideoResolution::TenEightyP, false, 0, 250), + ( 5, VideoResolution::TenEightyP, false, 0, 1250), + (15, VideoResolution::TenEightyP, false, 0, 3750), + ( 5, VideoResolution::TenEightyP, true, 0, 1260), + ( 5, VideoResolution::TenEightyP, false, 2, 1270), + ]; + + #[test] + fn v1p5_matrix() { + for &(duration, res, has_image, ref_count, expected) in V1P5_CASES { + let image = if has_image { Some(url_source()) } else { None }; + let refs = if ref_count > 0 { + Some((0..ref_count).map(|_| url_source()).collect()) + } else { None }; + let req = make_v1p5_request(Some(duration), Some(res), image, refs); + assert_eq!( + req.calculate_cost_in_mills(), expected, + "duration={duration} res={res:?} has_image={has_image} ref_count={ref_count}", + ); + } + } + } + + // ── Exhaustive matrix ── + + mod exhaustive_matrix { + use super::*; + + // (duration_s, resolution, image_to_video_source, reference_image_count, expected_mills) + const CASES: &[(u32, VideoResolution, bool, usize, u64)] = &[ + // 480p, no input images + ( 1, VideoResolution::FourEightyP, false, 0, 50), + ( 5, VideoResolution::FourEightyP, false, 0, 250), + ( 8, VideoResolution::FourEightyP, false, 0, 400), + (15, VideoResolution::FourEightyP, false, 0, 750), + // 720p, no input images + ( 1, VideoResolution::SevenTwentyP, false, 0, 70), + ( 5, VideoResolution::SevenTwentyP, false, 0, 350), + ( 8, VideoResolution::SevenTwentyP, false, 0, 560), + (15, VideoResolution::SevenTwentyP, false, 0, 1050), + // 480p with image-to-video source (1 input image) + ( 5, VideoResolution::FourEightyP, true, 0, 252), + (10, VideoResolution::FourEightyP, true, 0, 502), + // 720p with image-to-video source (1 input image) + ( 5, VideoResolution::SevenTwentyP, true, 0, 352), + (10, VideoResolution::SevenTwentyP, true, 0, 702), + // 480p with reference_images (no image-to-video) + ( 5, VideoResolution::FourEightyP, false, 1, 252), + ( 5, VideoResolution::FourEightyP, false, 2, 254), + ( 5, VideoResolution::FourEightyP, false, 3, 256), + // 720p with reference_images + ( 5, VideoResolution::SevenTwentyP, false, 1, 352), + ( 5, VideoResolution::SevenTwentyP, false, 2, 354), + ( 5, VideoResolution::SevenTwentyP, false, 3, 356), + ]; + + #[test] + fn all_matrix_cases() { + for &(duration, res, has_image, ref_count, expected) in CASES { + let image = if has_image { Some(url_source()) } else { None }; + let refs = if ref_count > 0 { + Some((0..ref_count).map(|_| url_source()).collect()) + } else { None }; + let req = make_request(Some(duration), Some(res), image, refs); + assert_eq!( + req.calculate_cost_in_mills(), expected, + "duration={duration} res={res:?} has_image={has_image} ref_count={ref_count}", + ); + } + } + } + + // ── Monotonicity ── + + mod monotonicity { + use super::*; + + #[test] + fn longer_duration_costs_more() { + let short = make_request(Some(1), Some(VideoResolution::FourEightyP), None, None).calculate_cost_in_mills(); + let long = make_request(Some(15), Some(VideoResolution::FourEightyP), None, None).calculate_cost_in_mills(); + assert!(short < long); + } + + #[test] + fn higher_resolution_costs_more() { + let p480 = make_request(Some(8), Some(VideoResolution::FourEightyP), None, None).calculate_cost_in_mills(); + let p720 = make_request(Some(8), Some(VideoResolution::SevenTwentyP), None, None).calculate_cost_in_mills(); + assert!(p480 < p720); + } + + #[test] + fn more_reference_images_cost_more() { + let zero = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, None).calculate_cost_in_mills(); + let three = make_request(Some(5), Some(VideoResolution::SevenTwentyP), None, + Some(vec![url_source(), url_source(), url_source()])).calculate_cost_in_mills(); + assert!(zero < three); + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/mod.rs new file mode 100644 index 00000000..9509b242 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/mod.rs @@ -0,0 +1,3 @@ +pub mod cost; +pub mod video_generation; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/request_types.rs new file mode 100644 index 00000000..97d3559f --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/request_types.rs @@ -0,0 +1,49 @@ +use serde_derive::{Deserialize, Serialize}; + +// ── Request ── + +#[derive(Serialize, Debug)] +pub(crate) struct VideoGenerationRequestBody { + pub prompt: String, + + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + /// Image-to-video: single source image. Mutually exclusive with + /// `reference_images`. + #[serde(skip_serializing_if = "Option::is_none")] + pub image: Option, + + /// Reference-to-video: array of reference images. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_images: Option>, + + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +/// xAI image/video reference — exactly one of `url` or `file_id` is set. +#[derive(Serialize, Debug, Clone)] +pub(crate) struct VideoImageRef { + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub file_id: Option, +} + +// ── Response ── + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoGenerationResponseBody { + pub request_id: String, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/video_generation.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/video_generation.rs new file mode 100644 index 00000000..1e760722 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_generation/video_generation.rs @@ -0,0 +1,516 @@ +use log::{info, warn}; +use serde_derive::Serialize; + +use crate::api::requests::videos::video_generation::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::api::types::video_types::video_aspect_ratio::VideoAspectRatio; +use crate::api::types::video_types::video_model::VideoModel; +use crate::api::types::video_types::video_resolution::VideoResolution; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::classify_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::error::grok_specific_api_error::GrokSpecificApiError; + +// ── Public args ── + +/// Top-level argument to [`video_generation`]. Borrows the API key separately +/// from the request body so callers can log/save [`VideoGenerationRequest`] +/// without leaking the credential. +#[derive(Clone, Debug)] +pub struct VideoGenerationArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: VideoGenerationRequest, +} + +/// The material part of a video-generation request. Derives [`Serialize`] so +/// it can be persisted to a log or audit store independently of the API key. +#[derive(Clone, Debug, Serialize)] +pub struct VideoGenerationRequest { + /// Text prompt. Required. + pub prompt: String, + + /// Model identifier. Defaults to [`VideoModel::GrokImagineVideo`] when `None`. + /// Use [`VideoModel::Custom`] for identifiers not yet listed in the enum. + #[serde(skip_serializing_if = "Option::is_none")] + pub model: Option, + + /// Image-to-video: a single source image. Mutually exclusive with + /// `reference_images` — supplying both returns a `BadRequest` before the + /// HTTP call. + #[serde(skip_serializing_if = "Option::is_none")] + pub image: Option, + + /// Reference-to-video: zero or more reference images. + #[serde(skip_serializing_if = "Option::is_none")] + pub reference_images: Option>, + + /// Aspect ratio. See [`VideoAspectRatio`] for the closed set of accepted + /// values (7 ratios — note the video endpoint accepts fewer than image + /// endpoints). Server default is `16:9` when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option, + + /// Duration in seconds (1–15). xAI default is 8. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration: Option, + + /// Output resolution tier. See [`VideoResolution`] (`480p` or `720p`). + /// Server default is `480p` when `None`. + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, +} + +/// Source image for `image` (image-to-video) or `reference_images` +/// (reference-to-video). +#[derive(Clone, Debug, Serialize)] +pub enum VideoImageSource { + /// Either a public HTTPS URL or a `data:` URI containing base64-encoded + /// image bytes. + Url(String), + + /// xAI file identifier (`file_...`) obtained from a successful upload via + /// [`crate::api::requests::files::upload_file::upload_file::upload_file`]. The file + /// must still exist at request time. + /// + /// Docs: + /// - + /// - + FileId(String), +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct VideoGenerationSuccess { + /// Use this with `video_status::video_status` to poll for completion. + pub request_id: String, +} + +// ── Implementation ── + +/// POST https://api.x.ai/v1/videos/generations — start a video generation +/// job. The video is rendered asynchronously; poll +/// `video_status::video_status(request_id)` until it returns `done` or +/// `failed`. +/// +/// Docs: +/// - +/// - +/// - +pub async fn video_generation(args: VideoGenerationArgs<'_>) -> Result { + let req = args.request; + + if req.image.is_some() && req.reference_images.as_ref().is_some_and(|v| !v.is_empty()) { + return Err(GrokClientError::InvalidRequest( + "video_generation cannot combine `image` (image-to-video) with `reference_images` (reference-to-video) in the same request".to_string(), + ).into()); + } + + let url = format!("{}/v1/videos/generations", XAI_API_BASE_URL); + let model = req.model.unwrap_or(VideoModel::GrokImagineVideo); + + info!( + "Grok video_generation: model={}, has_image={}, ref_imgs={}, aspect_ratio={:?}, duration={:?}, resolution={:?}", + model.as_str(), + req.image.is_some(), + req.reference_images.as_ref().map(|v| v.len()).unwrap_or(0), + req.aspect_ratio.map(|a| a.as_str()), + req.duration, + req.resolution.map(|r| r.as_str()), + ); + + let request_body = VideoGenerationRequestBody { + prompt: req.prompt, + model: Some(model.as_str().to_string()), + image: req.image.as_ref().map(to_video_image_ref), + reference_images: req.reference_images.map(|v| v.iter().map(to_video_image_ref).collect()), + aspect_ratio: req.aspect_ratio.map(|a| a.as_str().to_string()), + duration: req.duration, + resolution: req.resolution.map(|r| r.as_str().to_string()), + user: req.user, + }; + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + // DEBUG: log exactly what we send (request body has no secrets — the API key + // travels in the Authorization header, not the body). Helps confirm the wire + // shape when diagnosing 4xx responses. + match serde_json::to_string(&request_body) { + Ok(body_json) => info!("Grok video_generation request: POST {url} body={body_json}"), + Err(err) => warn!("Grok video_generation: failed to serialize request body for logging: {err}"), + } + + let response = client.post(&url) + .header("Authorization", bearer) + .header("Content-Type", "application/json") + .json(&request_body) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let status = response.status(); + // Capture headers BEFORE `.text()` consumes the response. Response headers + // reveal WAF/CDN blocks (e.g. `server: cloudflare`, `cf-ray`, `cf-mitigated`) + // vs. genuine API errors, and any rate-limit / retry hints. + let response_headers = format!("{:#?}", response.headers()); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok video_generation response: status={}", status); + + if !status.is_success() { + // The response body now travels in the returned error (`raw_http_body`), + // so log the HEADERS here — those aren't captured in the error type and + // reveal CDN/WAF context (e.g. `server: cloudflare`, `cf-ray`) vs. a + // genuine API rejection. + warn!( + "Grok video_generation FAILED: status={status} ({} body bytes)\n--- response headers ---\n{response_headers}", + response_body.len(), + ); + } + + classify_grok_http_error(status, Some(&response_body))?; + + let parsed: VideoGenerationResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + Ok(VideoGenerationSuccess { request_id: parsed.request_id }) +} + +fn to_video_image_ref(source: &VideoImageSource) -> VideoImageRef { + match source { + VideoImageSource::Url(u) => VideoImageRef { url: Some(u.clone()), file_id: None }, + VideoImageSource::FileId(id) => VideoImageRef { url: None, file_id: Some(id.clone()) }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use test_data::web::image_urls::{SUPER_WIDE_FALL_MOUNTAINS_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL, WHITE_HOUSE_SUNSET_IMAGE_URL}; + + // ── Wire-format shape tests ── + + #[test] + fn wire_body_serializes_text_only() { + let body = VideoGenerationRequestBody { + prompt: "a cat dancing".to_string(), + model: Some("grok-imagine-video".to_string()), + image: None, + reference_images: None, + aspect_ratio: Some("16:9".to_string()), + duration: Some(5), + resolution: Some("720p".to_string()), + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"prompt\":\"a cat dancing\"")); + assert!(json.contains("\"duration\":5")); + assert!(json.contains("\"resolution\":\"720p\"")); + assert!(!json.contains("\"image\"")); + assert!(!json.contains("\"reference_images\"")); + } + + #[test] + fn wire_body_serializes_image_to_video() { + let body = VideoGenerationRequestBody { + prompt: "animate this".to_string(), + model: None, + image: Some(VideoImageRef { url: Some("https://example.com/a.png".to_string()), file_id: None }), + reference_images: None, + aspect_ratio: None, + duration: None, + resolution: None, + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"image\":{")); + assert!(json.contains("\"url\":\"https://example.com/a.png\"")); + } + + #[test] + fn wire_body_serializes_reference_to_video() { + let body = VideoGenerationRequestBody { + prompt: " walking".to_string(), + model: None, + image: None, + reference_images: Some(vec![ + VideoImageRef { url: Some("https://example.com/a.png".to_string()), file_id: None }, + VideoImageRef { url: None, file_id: Some("file_xyz".to_string()) }, + ]), + aspect_ratio: None, + duration: None, + resolution: None, + user: None, + }; + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains("\"reference_images\":[")); + assert!(json.contains("\"file_id\":\"file_xyz\"")); + } + + // ── Public Request shape ── + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = VideoGenerationArgs { + api_key: &key, + request: VideoGenerationRequest { + prompt: "p".to_string(), + model: Some(VideoModel::GrokImagineVideo), + image: Some(VideoImageSource::Url("u".to_string())), + reference_images: None, + aspect_ratio: Some(VideoAspectRatio::Landscape16x9), + duration: Some(8), + resolution: Some(VideoResolution::SevenTwentyP), + user: None, + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak"), + "serialized request must not contain the API key. got: {}", json); + assert!(json.contains("\"prompt\":\"p\"")); + assert!(json.contains("\"model\":\"grok-imagine-video\"")); + assert!(json.contains("\"image\":{\"Url\":\"u\"}")); + assert!(json.contains("\"aspect_ratio\":\"16:9\"")); + assert!(json.contains("\"resolution\":\"720p\"")); + } + + #[tokio::test] + async fn image_plus_reference_images_returns_bad_request() { + let api_key = GrokApiKey::new("dummy".to_string()); + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "x".to_string(), + model: None, + image: Some(VideoImageSource::Url("u".to_string())), + reference_images: Some(vec![VideoImageSource::Url("v".to_string())]), + aspect_ratio: None, + duration: None, + resolution: None, + user: None, + }, + }).await; + let err = result.unwrap_err(); + assert!(matches!(err, GrokError::Client(GrokClientError::InvalidRequest(_)))); + } + + #[test] + fn response_body_deserializes() { + let json = r#"{ "request_id": "d97415a1-5796-b7ec-379f-4e6819e08fdf" }"#; + let parsed: VideoGenerationResponseBody = serde_json::from_str(json).unwrap(); + assert_eq!(parsed.request_id, "d97415a1-5796-b7ec-379f-4e6819e08fdf"); + } + + // ── Live API tests ── + + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_video_generation_text_only() -> AnyhowResult<()> { + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "A glowing crystal rocket launching from Mars".to_string(), + model: None, + image: None, + reference_images: None, + aspect_ratio: Some(VideoAspectRatio::Landscape16x9), + duration: Some(5), + resolution: Some(VideoResolution::FourEightyP), + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Video request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + + Ok(()) + } + + /// First-frame-to-video: a single source image becomes the opening frame + /// and the prompt drives the animation. Uses `image` (NOT + /// `reference_images`) — that's the xAI distinction between + /// image-to-video and reference-to-video. + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_video_generation_first_frame_to_video() -> AnyhowResult<()> { + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "The camera slowly pushes in toward the building as the sun sinks below the horizon. Soft golden light, gentle breeze rustling the trees.".to_string(), + model: None, + image: Some(VideoImageSource::Url(WHITE_HOUSE_SUNSET_IMAGE_URL.to_string())), + reference_images: None, + aspect_ratio: Some(VideoAspectRatio::Landscape16x9), + duration: Some(5), + resolution: Some(VideoResolution::SevenTwentyP), + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("First-frame video request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + /// Reference-to-video: multiple source images influence the generated + /// video. xAI accepts up to 3. The prompt references them by index using + /// ``, ``, … placeholders per xAI's reference-to-video + /// docs. + /// + /// Different aspect ratio than the first-frame test (portrait 9:16 + /// instead of landscape 16:9) so the two live tests don't accidentally + /// share a code path. + #[tokio::test] + #[ignore] // manually test — requires real API key and incurs costs + async fn live_test_video_generation_reference_images() -> AnyhowResult<()> { + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "The dogs from in the scene from . Make them play together.".to_string(), + model: None, + image: None, + reference_images: Some(vec![ + VideoImageSource::Url(TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string()), + VideoImageSource::Url(SUPER_WIDE_FALL_MOUNTAINS_IMAGE_URL.to_string()), + ]), + aspect_ratio: Some(VideoAspectRatio::Portrait9x16), + duration: Some(5), + resolution: Some(VideoResolution::SevenTwentyP), + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("Reference-to-video request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + // ── grok-imagine-video-1.5-preview live API tests ── + // + // All three exercise the v1.5 preview model at 480p / 5s. They're + // `#[ignore]` because they hit xAI's billed endpoint — run them with + // `cargo test -p grok_api_client -- --ignored grok_imagine_1p5`. xAI's + // model docs page advertises `text, image → video` for this model, so + // text-to-video SHOULD work in principle even though earlier ad-hoc curl + // experiments returned a "Text-to-video is not supported" 400 — these + // tests are the source of truth for what xAI actually accepts today. + + mod grok_imagine_1p5_tests { + use super::*; + + const TEST_DURATION_SECONDS: u32 = 5; + const TEST_RESOLUTION: VideoResolution = VideoResolution::FourEightyP; + + /// Text-to-video at 480p / 5s. The only image-related fields are + /// omitted, so this is a pure text-only request. + #[tokio::test] + #[ignore] // costs money — run manually + async fn live_test_grok_imagine_1p5_text_to_video() -> AnyhowResult<()> { + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "Timelapse of a flower blooming in a sunlit garden.".to_string(), + model: Some(VideoModel::GrokImagineVideo1p5), + image: None, + reference_images: None, + aspect_ratio: Some(VideoAspectRatio::Landscape16x9), + duration: Some(TEST_DURATION_SECONDS), + resolution: Some(TEST_RESOLUTION), + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("v1.5 text-to-video request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + /// Image-to-video (keyframe) at 480p / 5s. The source image becomes the + /// opening frame and the prompt drives the animation. + #[tokio::test] + #[ignore] // costs money — run manually + async fn live_test_grok_imagine_1p5_image_to_video_keyframe() -> AnyhowResult<()> { + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "The camera slowly pushes in toward the building as the sun sinks below the horizon. Soft golden light, gentle breeze rustling the trees.".to_string(), + model: Some(VideoModel::GrokImagineVideo1p5), + image: Some(VideoImageSource::Url(WHITE_HOUSE_SUNSET_IMAGE_URL.to_string())), + reference_images: None, + aspect_ratio: Some(VideoAspectRatio::Landscape16x9), + duration: Some(TEST_DURATION_SECONDS), + resolution: Some(TEST_RESOLUTION), + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("v1.5 image-to-video request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + + /// Reference-images-to-video at 480p / 5s. Two reference images + /// influence the generated video; the prompt references them by index. + /// + /// xAI's v1.5 preview has been observed to reject `reference_images` + /// outright at runtime (despite the docs implying support). This test + /// is the canonical way to detect when xAI changes that behavior. + #[tokio::test] + #[ignore] // costs money — run manually + async fn live_test_grok_imagine_1p5_reference_images_to_video() -> AnyhowResult<()> { + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_generation(VideoGenerationArgs { + api_key: &api_key, + request: VideoGenerationRequest { + prompt: "The dogs from in the scene from . Make them play together.".to_string(), + model: Some(VideoModel::GrokImagineVideo1p5), + image: None, + reference_images: Some(vec![ + VideoImageSource::Url(TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string()), + VideoImageSource::Url(SUPER_WIDE_FALL_MOUNTAINS_IMAGE_URL.to_string()), + ]), + aspect_ratio: Some(VideoAspectRatio::Landscape16x9), + duration: Some(TEST_DURATION_SECONDS), + resolution: Some(TEST_RESOLUTION), + user: None, + }, + }).await.map_err(|e| anyhow::anyhow!("{}", e))?; + + println!("v1.5 reference-to-video request_id: {}", result.request_id); + assert!(!result.request_id.is_empty()); + Ok(()) + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/mod.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/mod.rs new file mode 100644 index 00000000..3ce4f799 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/mod.rs @@ -0,0 +1,2 @@ +pub mod video_status; +pub(crate) mod request_types; diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/request_types.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/request_types.rs new file mode 100644 index 00000000..6c59eeef --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/request_types.rs @@ -0,0 +1,34 @@ +use serde_derive::Deserialize; + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoStatusResponseBody { + pub status: String, + + pub progress: Option, + + pub model: Option, + + pub video: Option, + + pub error: Option, + + pub usage: Option, +} + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoStatusVideo { + pub url: Option, + pub duration: Option, + pub respect_moderation: Option, +} + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoStatusError { + pub code: String, + pub message: String, +} + +#[derive(Deserialize, Debug)] +pub(crate) struct VideoStatusUsage { + pub cost_in_usd_ticks: Option, +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/video_status.rs b/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/video_status.rs new file mode 100644 index 00000000..5e37599c --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/videos/video_status/video_status.rs @@ -0,0 +1,562 @@ +use log::info; +use serde_derive::Serialize; +use serde_json::Value as JsonValue; + +use crate::api::requests::videos::video_status::request_types::*; +use crate::api::requests::xai_host::XAI_API_BASE_URL; +use crate::creds::grok_api_key::GrokApiKey; +use crate::error::classify_grok_http_error::{body_indicates_moderation, classify_grok_http_error}; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; + +// ── Public args ── + +/// Top-level argument to [`video_status`]. Borrows the API key separately from +/// the request body so callers can log/save [`VideoStatusRequest`] without +/// leaking the credential. +#[derive(Clone, Debug)] +pub struct VideoStatusArgs<'a> { + pub api_key: &'a GrokApiKey, + pub request: VideoStatusRequest, +} + +/// The material part of a video-status poll. Derives [`Serialize`] so it +/// can be persisted to a log or audit store independently of the API key. +#[derive(Clone, Debug, Serialize)] +pub struct VideoStatusRequest { + /// The `request_id` returned by a prior `video_generation`, + /// `video_edit`, or `video_extension` call. + pub request_id: String, +} + +// ── Public response ── + +#[derive(Debug, Clone)] +pub struct VideoStatusResponse { + pub status: VideoStatus, +} + +/// The lifecycle state of a video job. `Failed` is a *status*, not an error — +/// xAI accepted the job and (usually) billed for it, but didn't produce a +/// usable video. +#[derive(Debug, Clone)] +pub enum VideoStatus { + /// Still working. `progress` is 0–100 when xAI provides it. + Pending { + progress: Option, + }, + /// Finished successfully — `video.url` is typically populated. + Complete { + model: Option, + video: Option, + cost_in_usd_ticks: Option, + }, + /// xAI couldn't render this. `reason` is our best classification; the + /// remaining fields surface whatever xAI told us so the caller can log, + /// mark the row failed, and (where applicable) refund / surface a + /// user-facing message. + Failed { + reason: FailureReason, + code: Option, + error: Option, + cost_in_usd_ticks: Option, + full_error_json_payload: Option, + }, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum FailureReason { + /// xAI's safety filter rejected the prompt or the generated video. + ContentModerated, + /// Anything else: invalid argument we can't recover from, internal error, + /// expired job, etc. + Unknown, +} + +#[derive(Debug, Clone)] +pub struct VideoOutputInfo { + /// Temporary xAI-hosted URL, or the caller-supplied upload URL once xAI has + /// finished uploading. + pub url: Option, + pub duration: Option, + pub respect_moderation: Option, +} + +// ── Implementation ── + +/// GET https://api.x.ai/v1/videos/{request_id} — poll a video generation / +/// edit / extension job for its current status. +/// +/// Returns `Ok(VideoStatusResponse)` for any well-formed xAI response, +/// including jobs that failed or were moderated — those come back as +/// `VideoStatus::Failed`. Only infrastructure problems (auth, network, 404 +/// for unknown request_id, 5xx) bubble up as `Err(GrokError)`. +/// +/// Docs: +pub async fn video_status(args: VideoStatusArgs<'_>) -> Result { + let req = args.request; + let url = format!("{}/v1/videos/{}", XAI_API_BASE_URL, req.request_id); + + info!("Grok video_status: request_id={}", req.request_id); + + let client = reqwest::Client::builder() + .build() + .map_err(GrokClientError::ReqwestClientError)?; + + let bearer = format!("Bearer {}", args.api_key.api_key); + + let response = client.get(&url) + .header("Authorization", bearer) + .send() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + let http_status = response.status(); + let response_body = response.text() + .await + .map_err(GrokGenericApiError::ReqwestError)?; + + info!("Grok video_status response: http_status={}", http_status); + + if http_status.is_success() { + let parsed: VideoStatusResponseBody = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + return classify_status_field(&parsed, &response_body); + } + + // Non-2xx. xAI returns 4xx for some failure modes that are really "the job + // failed" rather than "something is wrong with your request" — most + // notably content moderation. Recognize those and return them as a Failed + // status so callers don't have to thread an error path. + if body_indicates_moderation(&response_body) { + return Ok(build_moderated_failed_response(&response_body)); + } + + // Anything else (401, 402, 404, 429, plain 400/403, 5xx) is a real error. + Err(unwrap_classify_err(classify_grok_http_error(http_status, Some(&response_body)))) +} + +fn classify_status_field( + parsed: &VideoStatusResponseBody, + raw_body: &str, +) -> Result { + let cost = parsed.usage.as_ref().and_then(|u| u.cost_in_usd_ticks); + + match parsed.status.as_str() { + "pending" | "queued" | "in_progress" | "processing" => Ok(VideoStatusResponse { + status: VideoStatus::Pending { progress: parsed.progress }, + }), + "done" | "completed" | "succeeded" => { + let video = parsed.video.as_ref().map(|v| VideoOutputInfo { + url: v.url.clone(), + duration: v.duration, + respect_moderation: v.respect_moderation, + }); + Ok(VideoStatusResponse { + status: VideoStatus::Complete { + model: parsed.model.clone(), + video, + cost_in_usd_ticks: cost, + }, + }) + } + "failed" => { + let code = parsed.error.as_ref().map(|e| e.code.clone()); + let error_msg = parsed.error.as_ref().map(|e| e.message.clone()); + let reason = if text_indicates_moderation(error_msg.as_deref()) + || body_indicates_moderation(raw_body) + { + FailureReason::ContentModerated + } else { + FailureReason::Unknown + }; + Ok(VideoStatusResponse { + status: VideoStatus::Failed { + reason, + code, + error: error_msg, + cost_in_usd_ticks: cost, + full_error_json_payload: Some(raw_body.to_string()), + }, + }) + } + "expired" => Ok(VideoStatusResponse { + status: VideoStatus::Failed { + reason: FailureReason::Unknown, + code: Some("expired".to_string()), + error: Some("video job expired".to_string()), + cost_in_usd_ticks: cost, + full_error_json_payload: Some(raw_body.to_string()), + }, + }), + other => Err(GrokGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: reqwest::StatusCode::OK, + body: format!("unknown video status: {:?}", other), + }.into()), + } +} + +fn build_moderated_failed_response(raw_body: &str) -> VideoStatusResponse { + let (code, error_msg, cost) = parse_error_body(raw_body); + VideoStatusResponse { + status: VideoStatus::Failed { + reason: FailureReason::ContentModerated, + code, + error: error_msg, + cost_in_usd_ticks: cost, + full_error_json_payload: Some(raw_body.to_string()), + }, + } +} + +/// Best-effort extraction of `{code, error, usage.cost_in_usd_ticks}` from +/// the two error-body shapes xAI uses: +/// +/// 1. Status-poll 4xx: +/// `{"code":"...", "error":"", "usage":{"cost_in_usd_ticks":...}}` +/// 2. OpenAI-compatible: +/// `{"error":{"code":"...", "message":"..."}}` +fn parse_error_body(body: &str) -> (Option, Option, Option) { + let parsed: JsonValue = match serde_json::from_str(body) { + Ok(v) => v, + Err(_) => return (None, None, None), + }; + + let top_level_code = parsed.get("code") + .and_then(JsonValue::as_str) + .map(str::to_string); + + let (error_msg, nested_code) = match parsed.get("error") { + Some(JsonValue::String(s)) => (Some(s.clone()), None), + Some(obj @ JsonValue::Object(_)) => { + let msg = obj.get("message").and_then(JsonValue::as_str).map(str::to_string); + let nested = obj.get("code").and_then(JsonValue::as_str).map(str::to_string); + (msg, nested) + } + _ => (None, None), + }; + + let code = top_level_code.or(nested_code); + + let cost = parsed.get("usage") + .and_then(|u| u.get("cost_in_usd_ticks")) + .and_then(JsonValue::as_u64); + + (code, error_msg, cost) +} + +fn text_indicates_moderation(maybe_text: Option<&str>) -> bool { + maybe_text.map(body_indicates_moderation).unwrap_or(false) +} + +/// `classify_grok_http_error` always returns `Err` when the status is non-2xx, +/// so this is infallible in our call path. Spelled out for clarity at the call +/// site rather than `.unwrap_err()` on the inline expression. +fn unwrap_classify_err(result: Result<(), GrokError>) -> GrokError { + match result { + Ok(()) => GrokGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: reqwest::StatusCode::OK, + body: "classify_grok_http_error returned Ok for a non-2xx response".to_string(), + }.into(), + Err(err) => err, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use errors::AnyhowResult; + + use crate::error::grok_specific_api_error::GrokSpecificApiError; + + // ── Status-field dispatch (HTTP 200) ── + + #[test] + fn pending_response_classifies_as_pending() { + let json = r#"{ "status": "pending", "progress": 12, "model": "grok-imagine-video" }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + match result.status { + VideoStatus::Pending { progress } => assert_eq!(progress, Some(12)), + other => panic!("expected Pending, got: {:?}", other), + } + } + + #[test] + fn pending_response_with_v1p5_model_does_not_break_dispatch() { + // `model` doesn't surface on Pending; it flows through on Complete only. + let json = r#"{ "status": "pending", "progress": 5, "model": "grok-imagine-video-1.5" }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + assert!(matches!(result.status, VideoStatus::Pending { .. })); + } + + #[test] + fn done_response_classifies_as_complete_with_video() { + let json = r#"{ + "status": "done", + "progress": 100, + "model": "grok-imagine-video", + "video": { "url": "https://imagine.x.ai/v.mp4", "duration": 5, "respect_moderation": true }, + "usage": { "cost_in_usd_ticks": 42 } + }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + match result.status { + VideoStatus::Complete { model, video, cost_in_usd_ticks } => { + assert_eq!(model.as_deref(), Some("grok-imagine-video")); + let video = video.unwrap(); + assert_eq!(video.url.as_deref(), Some("https://imagine.x.ai/v.mp4")); + assert_eq!(video.duration, Some(5)); + assert_eq!(video.respect_moderation, Some(true)); + assert_eq!(cost_in_usd_ticks, Some(42)); + } + other => panic!("expected Complete, got: {:?}", other), + } + } + + #[test] + fn failed_response_returns_ok_failed_unknown() { + let json = r#"{ + "status": "failed", + "progress": 50, + "error": { "code": "invalid_argument", "message": "duration too long" }, + "usage": { "cost_in_usd_ticks": 7 } + }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + match result.status { + VideoStatus::Failed { reason, code, error, cost_in_usd_ticks, full_error_json_payload } => { + assert_eq!(reason, FailureReason::Unknown); + assert_eq!(code.as_deref(), Some("invalid_argument")); + assert_eq!(error.as_deref(), Some("duration too long")); + assert_eq!(cost_in_usd_ticks, Some(7)); + assert_eq!(full_error_json_payload.as_deref(), Some(json)); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + #[test] + fn failed_response_with_moderation_message_is_classified_as_content_moderated() { + let json = r#"{ + "status": "failed", + "error": { "code": "permission_denied", "message": "Video rejected by safety moderation" }, + "usage": { "cost_in_usd_ticks": 11 } + }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + match result.status { + VideoStatus::Failed { reason, code, cost_in_usd_ticks, .. } => { + assert_eq!(reason, FailureReason::ContentModerated); + assert_eq!(code.as_deref(), Some("permission_denied")); + assert_eq!(cost_in_usd_ticks, Some(11)); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + #[test] + fn failed_response_without_error_object_yields_none_code_and_error() { + let json = r#"{ "status": "failed", "progress": 0 }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + match result.status { + VideoStatus::Failed { reason, code, error, .. } => { + assert_eq!(reason, FailureReason::Unknown); + assert!(code.is_none()); + assert!(error.is_none()); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + #[test] + fn expired_response_classifies_as_failed_unknown() { + let json = r#"{ "status": "expired", "usage": { "cost_in_usd_ticks": 3 } }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let result = classify_status_field(&parsed, json).unwrap(); + match result.status { + VideoStatus::Failed { reason, code, cost_in_usd_ticks, .. } => { + assert_eq!(reason, FailureReason::Unknown); + assert_eq!(code.as_deref(), Some("expired")); + assert_eq!(cost_in_usd_ticks, Some(3)); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + #[test] + fn unknown_status_field_returns_generic_error() { + let json = r#"{ "status": "magnificent" }"#; + let parsed: VideoStatusResponseBody = serde_json::from_str(json).unwrap(); + let err = classify_status_field(&parsed, json).unwrap_err(); + assert!(matches!(err, GrokError::ApiGeneric(_))); + } + + // ── Error-body dispatch (HTTP 4xx) ── + + #[test] + fn moderation_4xx_body_becomes_failed_content_moderated() { + // The real-world body that previously surfaced as + // `Err(GrokSpecificApiError::PromptModerated { .. })`. It should now be + // an Ok(Failed { ContentModerated }) with all fields populated from + // the JSON. + let body = r#"{"code":"Client specified an invalid argument","error":"Generated video rejected by content moderation.","usage":{"cost_in_usd_ticks":11300000000}}"#; + let response = build_moderated_failed_response(body); + match response.status { + VideoStatus::Failed { reason, code, error, cost_in_usd_ticks, full_error_json_payload } => { + assert_eq!(reason, FailureReason::ContentModerated); + assert_eq!(code.as_deref(), Some("Client specified an invalid argument")); + assert_eq!(error.as_deref(), Some("Generated video rejected by content moderation.")); + assert_eq!(cost_in_usd_ticks, Some(11_300_000_000)); + assert_eq!(full_error_json_payload.as_deref(), Some(body)); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + #[test] + fn moderation_openai_shape_body_extracts_nested_code_and_message() { + let body = r#"{"error":{"code":"content_policy","message":"Content moderation blocked this prompt"}}"#; + let response = build_moderated_failed_response(body); + match response.status { + VideoStatus::Failed { reason, code, error, .. } => { + assert_eq!(reason, FailureReason::ContentModerated); + assert_eq!(code.as_deref(), Some("content_policy")); + assert_eq!(error.as_deref(), Some("Content moderation blocked this prompt")); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + #[test] + fn moderation_unparseable_body_still_yields_failed_with_payload() { + let body = "totally not json but mentions moderation"; + let response = build_moderated_failed_response(body); + match response.status { + VideoStatus::Failed { reason, code, error, full_error_json_payload, .. } => { + assert_eq!(reason, FailureReason::ContentModerated); + assert!(code.is_none()); + assert!(error.is_none()); + assert_eq!(full_error_json_payload.as_deref(), Some(body)); + } + other => panic!("expected Failed, got: {:?}", other), + } + } + + // ── Public Request shape ── + + #[test] + fn request_serializes_without_api_key() { + let key = GrokApiKey::new("secret_must_not_leak".to_string()); + let args = VideoStatusArgs { + api_key: &key, + request: VideoStatusRequest { + request_id: "req_abc".to_string(), + }, + }; + let json = serde_json::to_string(&args.request).unwrap(); + assert!(!json.contains("secret_must_not_leak")); + assert!(json.contains("\"request_id\":\"req_abc\"")); + } + + // ── Live API tests ── + + #[tokio::test] + #[ignore] // manually test — requires real API key + an existing request_id + async fn live_test_video_status_unknown_id_is_not_found() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let api_key = get_test_api_key()?; + // Random UUID — should yield 404. + let result = video_status(VideoStatusArgs { + api_key: &api_key, + request: VideoStatusRequest { + request_id: "00000000-0000-0000-0000-000000000000".to_string(), + }, + }).await; + + println!("Result: {:?}", result.as_ref().map(|r| &r.status)); + let err = result.unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::NotFound { .. })), + "expected NotFound, got: {:?}", err); + Ok(()) + } + + /// Polls a known request_id and prints the result. Doesn't assert a + /// specific status — depending on when the test runs, the job may be + /// pending, complete, or failed. The point is to exercise the + /// happy-path against the real xAI API. + #[tokio::test] + #[ignore] // manually test — requires real API key + async fn live_test_video_status_known_id() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_status(VideoStatusArgs { + api_key: &api_key, + request: VideoStatusRequest { + request_id: "ce681bd0-133d-9cf3-975c-422d292d4e8e".to_string(), + }, + }).await; + + match &result { + Ok(r) => println!("status: {:?}", r.status), + Err(e) => println!("status error: {:?}", e), + } + Ok(()) + } + + /// Polls another known request_id. Same lax assertions as the test above + /// — status varies with time. + #[tokio::test] + #[ignore] // manually test — requires real API key + async fn live_test_video_status_known_id_2() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_status(VideoStatusArgs { + api_key: &api_key, + request: VideoStatusRequest { + request_id: "7b2fa3dc-8e63-9100-b117-faffb3178773".to_string(), + }, + }).await; + + match &result { + Ok(r) => println!("status: {:?}", r.status), + Err(e) => println!("status error: {:?}", e), + } + Ok(()) + } + + /// Polls yet another known request_id. + #[tokio::test] + #[ignore] // manually test — requires real API key + async fn live_test_video_status_known_id_3() -> AnyhowResult<()> { + use crate::test_utils::get_test_api_key::get_test_api_key; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let api_key = get_test_api_key()?; + let result = video_status(VideoStatusArgs { + api_key: &api_key, + request: VideoStatusRequest { + request_id: "4d4a6185-209e-95f3-942b-510042637839".to_string(), + }, + }).await; + + match &result { + Ok(r) => println!("status: {:?}", r.status), + Err(e) => println!("status error: {:?}", e), + } + Ok(()) + } +} diff --git a/crates/api_clients/grok_api_client/src/api/requests/xai_host.rs b/crates/api_clients/grok_api_client/src/api/requests/xai_host.rs new file mode 100644 index 00000000..3aeefe42 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/requests/xai_host.rs @@ -0,0 +1,2 @@ +/// Base URL for the xAI Imagine API. Every request is `{XAI_API_BASE_URL}/v1/...`. +pub(crate) const XAI_API_BASE_URL: &str = "https://api.x.ai"; diff --git a/crates/api_clients/grok_api_client/src/api/traits/grok_request_cost_calculator_trait.rs b/crates/api_clients/grok_api_client/src/api/traits/grok_request_cost_calculator_trait.rs new file mode 100644 index 00000000..a5f2ee32 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/traits/grok_request_cost_calculator_trait.rs @@ -0,0 +1,36 @@ +//! Cost-estimation trait for xAI (Grok) API requests. +//! +//! Implementations live next to each Request type in +//! `api/requests///cost.rs`. Implemented on the public +//! `*Request` type (NOT the `*Args` wrapper), since the request body is what +//! drives the bill. +//! +//! All math is performed in mills (tenths of a US cent), which is the +//! natural unit for xAI's published rates — an image edit at the cheap tier +//! is $0.002/img = 2 mills, well below cent resolution. + +/// Cost in US cents (1¢ = 1 unit). +pub type UsdCents = u64; + +/// Cost in mills (1¢ = 10 mills). Use this when sub-cent precision matters +/// — many xAI rates are below 1 cent. +pub type UsdMills = u64; + +/// Implemented on `*Request` types to estimate the cost of a Grok API call +/// without actually making it. +/// +/// The estimate is derived from fields present in the request body. Some +/// endpoints (notably `video_edit` and the input-cost portion of +/// `video_extension`) depend on the source video's duration, which is NOT +/// part of the request. Those impls document their limitations. +pub trait GrokRequestCostCalculator { + /// Estimated cost rounded up to the nearest whole cent. + fn calculate_cost_in_cents(&self) -> UsdCents { + // Default impl: derive from mills via ceiling division. + self.calculate_cost_in_mills().div_ceil(10) + } + + /// Estimated cost in mills (tenths of a cent). This is the canonical + /// method — implementations should override this one. + fn calculate_cost_in_mills(&self) -> UsdMills; +} diff --git a/crates/api_clients/grok_api_client/src/api/traits/mod.rs b/crates/api_clients/grok_api_client/src/api/traits/mod.rs new file mode 100644 index 00000000..db0afc65 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/traits/mod.rs @@ -0,0 +1 @@ +pub mod grok_request_cost_calculator_trait; diff --git a/crates/api_clients/grok_api_client/src/api/types/image_types/image_aspect_ratio.rs b/crates/api_clients/grok_api_client/src/api/types/image_types/image_aspect_ratio.rs new file mode 100644 index 00000000..b8129d92 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/image_types/image_aspect_ratio.rs @@ -0,0 +1,128 @@ +/// Aspect ratios accepted by the xAI image endpoints. +/// +/// The wire format is `":"` — e.g. `Square` serialises as +/// `"1:1"`, `Cinematic20x9` as `"20:9"`. `Auto` defers to xAI to pick. +/// +/// xAI documents this closed set; see +/// . +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum ImageAspectRatio { + /// 1:1 square. + Square, + + /// 3:4 portrait (slight tall). + Portrait3x4, + + /// 4:3 landscape (slight wide). + Landscape4x3, + + /// 9:16 portrait (phone/vertical-video). + Portrait9x16, + + /// 16:9 landscape (widescreen / YouTube). + Landscape16x9, + + /// 2:3 portrait (photo). + Portrait2x3, + + /// 3:2 landscape (photo). + Landscape3x2, + + /// 9:19.5 portrait (modern phone screens). + Portrait9x19_5, + + /// 19.5:9 landscape (modern phone screens, rotated). + Landscape19_5x9, + + /// 9:20 portrait (taller phone). + Portrait9x20, + + /// 20:9 landscape (taller phone, rotated). + Landscape20x9, + + /// 1:2 ultra-portrait. + Portrait1x2, + + /// 2:1 ultra-landscape. + Landscape2x1, + + /// Let xAI pick the aspect ratio (typically matches the source image for edits). + Auto, +} + +impl ImageAspectRatio { + /// Wire representation — the exact string xAI expects in the + /// `"aspect_ratio"` field. + pub fn as_str(&self) -> &'static str { + match self { + Self::Square => "1:1", + Self::Portrait3x4 => "3:4", + Self::Landscape4x3 => "4:3", + Self::Portrait9x16 => "9:16", + Self::Landscape16x9 => "16:9", + Self::Portrait2x3 => "2:3", + Self::Landscape3x2 => "3:2", + Self::Portrait9x19_5 => "9:19.5", + Self::Landscape19_5x9 => "19.5:9", + Self::Portrait9x20 => "9:20", + Self::Landscape20x9 => "20:9", + Self::Portrait1x2 => "1:2", + Self::Landscape2x1 => "2:1", + Self::Auto => "auto", + } + } +} + +// Serialize as the wire string ("1:1", "16:9", "auto", …) rather than the +// default external-tag enum form. Lets request structs round-trip cleanly +// through a log/audit pipeline. +impl serde::Serialize for ImageAspectRatio { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn every_variant_maps_to_a_distinct_string() { + let all = [ + ImageAspectRatio::Square, + ImageAspectRatio::Portrait3x4, + ImageAspectRatio::Landscape4x3, + ImageAspectRatio::Portrait9x16, + ImageAspectRatio::Landscape16x9, + ImageAspectRatio::Portrait2x3, + ImageAspectRatio::Landscape3x2, + ImageAspectRatio::Portrait9x19_5, + ImageAspectRatio::Landscape19_5x9, + ImageAspectRatio::Portrait9x20, + ImageAspectRatio::Landscape20x9, + ImageAspectRatio::Portrait1x2, + ImageAspectRatio::Landscape2x1, + ImageAspectRatio::Auto, + ]; + let mut strs: Vec<&str> = all.iter().map(|v| v.as_str()).collect(); + strs.sort(); + strs.dedup(); + assert_eq!(strs.len(), 14, "expected 14 distinct wire values, got {:?}", strs); + } + + #[test] + fn matches_docs_strings() { + assert_eq!(ImageAspectRatio::Square.as_str(), "1:1"); + assert_eq!(ImageAspectRatio::Landscape16x9.as_str(), "16:9"); + assert_eq!(ImageAspectRatio::Portrait9x19_5.as_str(), "9:19.5"); + assert_eq!(ImageAspectRatio::Landscape19_5x9.as_str(), "19.5:9"); + assert_eq!(ImageAspectRatio::Auto.as_str(), "auto"); + } + + #[test] + fn serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&ImageAspectRatio::Square).unwrap(), "\"1:1\""); + assert_eq!(serde_json::to_string(&ImageAspectRatio::Portrait9x19_5).unwrap(), "\"9:19.5\""); + assert_eq!(serde_json::to_string(&ImageAspectRatio::Auto).unwrap(), "\"auto\""); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/types/image_types/image_model.rs b/crates/api_clients/grok_api_client/src/api/types/image_types/image_model.rs new file mode 100644 index 00000000..6db84c74 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/image_types/image_model.rs @@ -0,0 +1,96 @@ +/// Models accepted by the xAI image endpoints (`/v1/images/generations` and +/// `/v1/images/edits`). Both endpoints accept all variants here. +/// +/// xAI may add or deprecate models faster than this crate ships releases, so +/// the [`ImageModel::Custom`] escape hatch lets callers pass an arbitrary +/// identifier without waiting for a code change. +/// +/// Docs: +/// - Models list: +/// - +/// - +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum ImageModel { + /// `grok-imagine-image` — the standard image model. $0.02 / image as of + /// the docs at time of writing; lower cost and faster than the `-quality` + /// variant, at the expense of fidelity. + GrokImagineImage, + + /// `grok-imagine-image-quality` — the higher-quality image model. $0.05 / + /// image as of the docs at time of writing. xAI recommends this as the + /// default for new requests. + GrokImagineImageQuality, + + /// Escape hatch for model identifiers not yet enumerated here. + /// + /// Useful for forward compat and for legacy/deprecated identifiers (e.g. + /// `grok-imagine-image-pro`, deprecated as of 2026-05-15) that still + /// function until xAI removes them. + Custom(String), +} + +impl ImageModel { + /// Wire representation — the exact string xAI expects in the `"model"` field. + pub fn as_str(&self) -> &str { + match self { + Self::GrokImagineImage => "grok-imagine-image", + Self::GrokImagineImageQuality => "grok-imagine-image-quality", + Self::Custom(s) => s.as_str(), + } + } +} + +// Serialize as the wire string ("grok-imagine-image", "grok-imagine-image-quality", +// or the Custom inner string) rather than the default external-tag enum format. +// Lets `ImageGenerationRequest` / `ImageEditRequest` round-trip through any +// log/audit pipeline as readable JSON. +impl serde::Serialize for ImageModel { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn standard_model_serializes() { + assert_eq!(ImageModel::GrokImagineImage.as_str(), "grok-imagine-image"); + } + + #[test] + fn quality_model_serializes() { + assert_eq!(ImageModel::GrokImagineImageQuality.as_str(), "grok-imagine-image-quality"); + } + + #[test] + fn custom_model_passes_through() { + let m = ImageModel::Custom("grok-imagine-image-future".to_string()); + assert_eq!(m.as_str(), "grok-imagine-image-future"); + } + + #[test] + fn deprecated_pro_model_still_usable_via_custom() { + let m = ImageModel::Custom("grok-imagine-image-pro".to_string()); + assert_eq!(m.as_str(), "grok-imagine-image-pro"); + } + + #[test] + fn standard_and_quality_are_distinct_strings() { + assert_ne!( + ImageModel::GrokImagineImage.as_str(), + ImageModel::GrokImagineImageQuality.as_str() + ); + } + + #[test] + fn serializes_as_plain_wire_string() { + let m = ImageModel::GrokImagineImageQuality; + assert_eq!(serde_json::to_string(&m).unwrap(), "\"grok-imagine-image-quality\""); + let m = ImageModel::GrokImagineImage; + assert_eq!(serde_json::to_string(&m).unwrap(), "\"grok-imagine-image\""); + let m = ImageModel::Custom("grok-imagine-image-pro".to_string()); + assert_eq!(serde_json::to_string(&m).unwrap(), "\"grok-imagine-image-pro\""); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/types/image_types/image_resolution.rs b/crates/api_clients/grok_api_client/src/api/types/image_types/image_resolution.rs new file mode 100644 index 00000000..16d237e8 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/image_types/image_resolution.rs @@ -0,0 +1,51 @@ +/// Output resolution for xAI image endpoints. +/// +/// xAI's actual pixel counts depend on the chosen `aspect_ratio` — the `1k` +/// and `2k` labels denote the *target* size class (roughly 1024-px and +/// 2048-px on the longest edge). When omitted, xAI falls back to its server +/// default (currently 1k as of these docs). +/// +/// Docs: +/// - +/// - +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum ImageResolution { + /// `"1k"` — ~1024-px class (faster, cheaper). + OneK, + /// `"2k"` — ~2048-px class (higher fidelity, slower, more expensive). + TwoK, +} + +impl ImageResolution { + /// Wire representation — the exact string xAI expects in the `"resolution"` field. + pub fn as_str(&self) -> &'static str { + match self { + Self::OneK => "1k", + Self::TwoK => "2k", + } + } +} + +// Serialize as the wire string ("1k", "2k"). +impl serde::Serialize for ImageResolution { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_docs_strings() { + assert_eq!(ImageResolution::OneK.as_str(), "1k"); + assert_eq!(ImageResolution::TwoK.as_str(), "2k"); + } + + #[test] + fn serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&ImageResolution::OneK).unwrap(), "\"1k\""); + assert_eq!(serde_json::to_string(&ImageResolution::TwoK).unwrap(), "\"2k\""); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/types/image_types/image_response_format.rs b/crates/api_clients/grok_api_client/src/api/types/image_types/image_response_format.rs new file mode 100644 index 00000000..c4a91583 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/image_types/image_response_format.rs @@ -0,0 +1,48 @@ +/// Wire format for returned images. +/// +/// - `Url` (default) — xAI returns a temporary CDN URL in `data[].url`. +/// - `B64Json` — xAI returns the raw image bytes inlined as base64 in +/// `data[].b64_json`. Use this when you can't / don't want to make a +/// follow-up HTTP request to fetch the image. +/// +/// Docs: +/// - +/// - +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum ImageResponseFormat { + Url, + B64Json, +} + +impl ImageResponseFormat { + pub fn as_str(&self) -> &'static str { + match self { + Self::Url => "url", + Self::B64Json => "b64_json", + } + } +} + +// Serialize as the wire string ("url" or "b64_json"). +impl serde::Serialize for ImageResponseFormat { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_docs_strings() { + assert_eq!(ImageResponseFormat::Url.as_str(), "url"); + assert_eq!(ImageResponseFormat::B64Json.as_str(), "b64_json"); + } + + #[test] + fn serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&ImageResponseFormat::Url).unwrap(), "\"url\""); + assert_eq!(serde_json::to_string(&ImageResponseFormat::B64Json).unwrap(), "\"b64_json\""); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/types/image_types/mod.rs b/crates/api_clients/grok_api_client/src/api/types/image_types/mod.rs new file mode 100644 index 00000000..93ae0603 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/image_types/mod.rs @@ -0,0 +1,10 @@ +//! Shared image-endpoint enums (model, aspect ratio, resolution, response format). +//! +//! These are reused by both [`crate::api::requests::image_generation`] and +//! [`crate::api::requests::image_edit`] so callers can pass type-safe values +//! instead of memorising the allowed strings. + +pub mod image_aspect_ratio; +pub mod image_model; +pub mod image_resolution; +pub mod image_response_format; diff --git a/crates/api_clients/grok_api_client/src/api/types/mod.rs b/crates/api_clients/grok_api_client/src/api/types/mod.rs new file mode 100644 index 00000000..e0eae8aa --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/mod.rs @@ -0,0 +1,2 @@ +pub mod image_types; +pub mod video_types; diff --git a/crates/api_clients/grok_api_client/src/api/types/video_types/mod.rs b/crates/api_clients/grok_api_client/src/api/types/video_types/mod.rs new file mode 100644 index 00000000..685e6873 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/video_types/mod.rs @@ -0,0 +1,14 @@ +//! Shared video-endpoint enums (model, aspect ratio, resolution). +//! +//! `VideoModel` is reused by every video endpoint +//! ([`crate::api::requests::videos::video_generation`], +//! [`crate::api::requests::videos::video_edit`], +//! [`crate::api::requests::videos::video_extension`]). +//! +//! `VideoAspectRatio` and `VideoResolution` are accepted only by +//! [`crate::api::requests::videos::video_generation`] — the edit and +//! extension endpoints inherit dimensions from the source video. + +pub mod video_aspect_ratio; +pub mod video_model; +pub mod video_resolution; diff --git a/crates/api_clients/grok_api_client/src/api/types/video_types/video_aspect_ratio.rs b/crates/api_clients/grok_api_client/src/api/types/video_types/video_aspect_ratio.rs new file mode 100644 index 00000000..490a7056 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/video_types/video_aspect_ratio.rs @@ -0,0 +1,101 @@ +/// Aspect ratios accepted by `/v1/videos/generations`. +/// +/// The wire format is `":"` — e.g. [`VideoAspectRatio::Square`] +/// serialises as `"1:1"`, [`VideoAspectRatio::Landscape16x9`] as `"16:9"`. +/// +/// Note: the video endpoint accepts FEWER aspect ratios than image endpoints +/// — there's no `auto`, no ultra-portrait `9:19.5` or `9:20`, no `1:2`/`2:1`. +/// xAI documents this closed set of 7. +/// +/// Video edits (`/v1/videos/edits`) and extensions (`/v1/videos/extensions`) +/// don't accept this field — they inherit the source video's dimensions. +/// +/// Docs: +/// - +/// - +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum VideoAspectRatio { + /// 1:1 square. + Square, + + /// 16:9 landscape (widescreen / YouTube). xAI default. + Landscape16x9, + + /// 9:16 portrait (phone / vertical video). + Portrait9x16, + + /// 4:3 landscape (classic TV). + Landscape4x3, + + /// 3:4 portrait. + Portrait3x4, + + /// 3:2 landscape (photo). + Landscape3x2, + + /// 2:3 portrait (photo). + Portrait2x3, +} + +impl VideoAspectRatio { + /// Wire representation — the exact string xAI expects in the + /// `"aspect_ratio"` field. + pub fn as_str(&self) -> &'static str { + match self { + Self::Square => "1:1", + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::Landscape4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Landscape3x2 => "3:2", + Self::Portrait2x3 => "2:3", + } + } +} + +// Serialize as the wire string ("1:1", "16:9", …) rather than the default +// external-tag enum form. +impl serde::Serialize for VideoAspectRatio { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn every_variant_maps_to_a_distinct_string() { + let all = [ + VideoAspectRatio::Square, + VideoAspectRatio::Landscape16x9, + VideoAspectRatio::Portrait9x16, + VideoAspectRatio::Landscape4x3, + VideoAspectRatio::Portrait3x4, + VideoAspectRatio::Landscape3x2, + VideoAspectRatio::Portrait2x3, + ]; + let mut strs: Vec<&str> = all.iter().map(|v| v.as_str()).collect(); + strs.sort(); + strs.dedup(); + assert_eq!(strs.len(), 7, "expected 7 distinct wire values, got {:?}", strs); + } + + #[test] + fn matches_docs_strings() { + assert_eq!(VideoAspectRatio::Square.as_str(), "1:1"); + assert_eq!(VideoAspectRatio::Landscape16x9.as_str(), "16:9"); + assert_eq!(VideoAspectRatio::Portrait9x16.as_str(), "9:16"); + assert_eq!(VideoAspectRatio::Landscape4x3.as_str(), "4:3"); + assert_eq!(VideoAspectRatio::Portrait3x4.as_str(), "3:4"); + assert_eq!(VideoAspectRatio::Landscape3x2.as_str(), "3:2"); + assert_eq!(VideoAspectRatio::Portrait2x3.as_str(), "2:3"); + } + + #[test] + fn serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&VideoAspectRatio::Landscape16x9).unwrap(), "\"16:9\""); + assert_eq!(serde_json::to_string(&VideoAspectRatio::Square).unwrap(), "\"1:1\""); + } +} diff --git a/crates/api_clients/grok_api_client/src/api/types/video_types/video_model.rs b/crates/api_clients/grok_api_client/src/api/types/video_types/video_model.rs new file mode 100644 index 00000000..bf09fe63 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/video_types/video_model.rs @@ -0,0 +1,165 @@ +/// Models accepted by the xAI video endpoints (`/v1/videos/generations`, +/// `/v1/videos/edits`, `/v1/videos/extensions`). All three endpoints accept +/// the same model identifier. +/// +/// xAI may add or deprecate models faster than this crate ships releases, so +/// the [`VideoModel::Custom`] escape hatch lets callers pass an arbitrary +/// identifier without waiting for a code change. +/// +/// Docs: +/// - Models list: +/// - +/// - +/// - +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum VideoModel { + /// `grok-imagine-video` — the original Imagine video model. Used by + /// generation, editing, and extension endpoints. + GrokImagineVideo, + + /// `grok-imagine-video-1.5` — the GA 1.5 model (formerly + /// `grok-imagine-video-1.5-preview`). xAI still accepts the old `-preview` + /// name and the dated alias `grok-imagine-video-1.5-2026-05-30` as synonyms + /// server-side; this variant serializes to the new canonical name. + GrokImagineVideo1p5, + + /// Escape hatch for model identifiers not yet enumerated here. + Custom(String), +} + +impl VideoModel { + /// Wire representation — the exact string xAI expects in the `"model"` field. + pub fn as_str(&self) -> &str { + match self { + Self::GrokImagineVideo => "grok-imagine-video", + Self::GrokImagineVideo1p5 => "grok-imagine-video-1.5", + Self::Custom(s) => s.as_str(), + } + } + + /// Pricing tier this model bills under. Includes recognition of the dated + /// alias `grok-imagine-video-1.5-2026-05-30` passed via [`Self::Custom`], + /// which xAI treats as a synonym for `grok-imagine-video-1.5-preview` and + /// therefore charges at the 1.5 rates. + pub fn pricing_tier(&self) -> VideoModelPricingTier { + match self { + Self::GrokImagineVideo => VideoModelPricingTier::V1, + Self::GrokImagineVideo1p5 => VideoModelPricingTier::V1p5, + Self::Custom(s) => match s.as_str() { + "grok-imagine-video-1.5" + | "grok-imagine-video-1.5-preview" + | "grok-imagine-video-1.5-2026-05-30" => { + VideoModelPricingTier::V1p5 + } + _ => VideoModelPricingTier::V1, + }, + } + } +} + +/// Pricing tier identifier used by the per-request cost calculators. xAI +/// publishes different per-second and per-image rates for each tier — see +/// `video_generation/cost.rs`. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum VideoModelPricingTier { + /// `grok-imagine-video` and any unrecognized identifier that defaults + /// to v1 rates. + V1, + /// `grok-imagine-video-1.5` (and its old `-preview` / dated aliases). + V1p5, +} + +// Serialize as the wire string ("grok-imagine-video" or the Custom inner +// string) rather than the default external-tag enum format. Lets the public +// VideoGeneration/Edit/ExtensionRequest types round-trip through any +// log/audit pipeline as readable JSON. +impl serde::Serialize for VideoModel { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_model_serializes() { + assert_eq!(VideoModel::GrokImagineVideo.as_str(), "grok-imagine-video"); + } + + #[test] + fn one_point_five_preview_serializes_canonical_name() { + assert_eq!( + VideoModel::GrokImagineVideo1p5.as_str(), + "grok-imagine-video-1.5", + ); + assert_eq!( + serde_json::to_string(&VideoModel::GrokImagineVideo1p5).unwrap(), + "\"grok-imagine-video-1.5\"", + ); + } + + #[test] + fn custom_model_passes_through() { + let m = VideoModel::Custom("grok-imagine-video-future".to_string()); + assert_eq!(m.as_str(), "grok-imagine-video-future"); + } + + #[test] + fn serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&VideoModel::GrokImagineVideo).unwrap(), "\"grok-imagine-video\""); + let m = VideoModel::Custom("grok-imagine-video-v2".to_string()); + assert_eq!(serde_json::to_string(&m).unwrap(), "\"grok-imagine-video-v2\""); + } + + // ── Pricing tier classification ── + + mod pricing_tier { + use super::*; + + #[test] + fn grok_imagine_video_is_v1() { + assert_eq!(VideoModel::GrokImagineVideo.pricing_tier(), VideoModelPricingTier::V1); + } + + #[test] + fn one_point_five_preview_enum_is_v1p5() { + assert_eq!( + VideoModel::GrokImagineVideo1p5.pricing_tier(), + VideoModelPricingTier::V1p5, + ); + } + + #[test] + fn custom_with_canonical_1p5_name_is_v1p5() { + let m = VideoModel::Custom("grok-imagine-video-1.5".to_string()); + assert_eq!(m.pricing_tier(), VideoModelPricingTier::V1p5); + } + + #[test] + fn custom_with_old_preview_name_is_still_v1p5() { + let m = VideoModel::Custom("grok-imagine-video-1.5-preview".to_string()); + assert_eq!(m.pricing_tier(), VideoModelPricingTier::V1p5); + } + + #[test] + fn custom_with_dated_1p5_alias_is_v1p5() { + // xAI treats this alias as a synonym for the 1.5 preview model. + let m = VideoModel::Custom("grok-imagine-video-1.5-2026-05-30".to_string()); + assert_eq!(m.pricing_tier(), VideoModelPricingTier::V1p5); + } + + #[test] + fn custom_unknown_defaults_to_v1() { + let m = VideoModel::Custom("grok-imagine-video-future".to_string()); + assert_eq!(m.pricing_tier(), VideoModelPricingTier::V1); + } + + #[test] + fn custom_with_v1_name_is_v1() { + let m = VideoModel::Custom("grok-imagine-video".to_string()); + assert_eq!(m.pricing_tier(), VideoModelPricingTier::V1); + } + } +} diff --git a/crates/api_clients/grok_api_client/src/api/types/video_types/video_resolution.rs b/crates/api_clients/grok_api_client/src/api/types/video_types/video_resolution.rs new file mode 100644 index 00000000..f7e0d167 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/api/types/video_types/video_resolution.rs @@ -0,0 +1,61 @@ +/// Output resolution for `/v1/videos/generations`. +/// +/// `480p` (server default), `720p`, and `1080p`. The 1.5 model produces +/// genuine 1080p output (the original `grok-imagine-video` capped at 720p). +/// +/// Video edits (`/v1/videos/edits`) and extensions (`/v1/videos/extensions`) +/// don't accept this field — they inherit the source video's resolution +/// (capped at 720p). +/// +/// Docs: +/// - +/// - +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum VideoResolution { + /// `"480p"` — standard definition, faster processing. Server default. + FourEightyP, + + /// `"720p"` — HD quality. + SevenTwentyP, + + /// `"1080p"` — full HD. Supported by `grok-imagine-video-1.5`. + TenEightyP, +} + +impl VideoResolution { + /// Wire representation — the exact string xAI expects in the + /// `"resolution"` field. + pub fn as_str(&self) -> &'static str { + match self { + Self::FourEightyP => "480p", + Self::SevenTwentyP => "720p", + Self::TenEightyP => "1080p", + } + } +} + +// Serialize as the wire string ("480p", "720p", "1080p"). +impl serde::Serialize for VideoResolution { + fn serialize(&self, s: S) -> Result { + s.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_docs_strings() { + assert_eq!(VideoResolution::FourEightyP.as_str(), "480p"); + assert_eq!(VideoResolution::SevenTwentyP.as_str(), "720p"); + assert_eq!(VideoResolution::TenEightyP.as_str(), "1080p"); + } + + #[test] + fn serializes_as_plain_wire_string() { + assert_eq!(serde_json::to_string(&VideoResolution::FourEightyP).unwrap(), "\"480p\""); + assert_eq!(serde_json::to_string(&VideoResolution::SevenTwentyP).unwrap(), "\"720p\""); + assert_eq!(serde_json::to_string(&VideoResolution::TenEightyP).unwrap(), "\"1080p\""); + } +} diff --git a/crates/api_clients/grok_api_client/src/creds/grok_api_key.rs b/crates/api_clients/grok_api_client/src/creds/grok_api_key.rs new file mode 100644 index 00000000..0f3399ae --- /dev/null +++ b/crates/api_clients/grok_api_client/src/creds/grok_api_key.rs @@ -0,0 +1,21 @@ +/// Holds the API key for authenticating with the Grok (xAI Imagine) API. +/// +/// Sent on every request as `Authorization: Bearer `. +#[derive(Clone)] +pub struct GrokApiKey { + pub(crate) api_key: String, +} + +impl GrokApiKey { + pub fn new(api_key: String) -> Self { + Self { api_key } + } +} + +// Debug is redacted so the key can't end up in a log line via accidental +// `{:?}` on an enclosing args struct. +impl std::fmt::Debug for GrokApiKey { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "GrokApiKey()") + } +} diff --git a/crates/api_clients/grok_api_client/src/creds/mod.rs b/crates/api_clients/grok_api_client/src/creds/mod.rs new file mode 100644 index 00000000..a5900cda --- /dev/null +++ b/crates/api_clients/grok_api_client/src/creds/mod.rs @@ -0,0 +1 @@ +pub mod grok_api_key; diff --git a/crates/api_clients/grok_api_client/src/error/classify_grok_http_error.rs b/crates/api_clients/grok_api_client/src/error/classify_grok_http_error.rs new file mode 100644 index 00000000..a37b9d20 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/error/classify_grok_http_error.rs @@ -0,0 +1,200 @@ +use reqwest::StatusCode; + +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::error::grok_specific_api_error::GrokSpecificApiError; + +/// Convert a non-2xx HTTP response into a `GrokError`. +/// +/// On 2xx returns `Ok(())`; on any error status returns the most-specific +/// `GrokError` variant we can classify from the status code and (optional) +/// response body. +pub fn classify_grok_http_error(status_code: StatusCode, maybe_body: Option<&str>) -> Result<(), GrokError> { + if status_code.is_success() { + return Ok(()); + } + + // Owned copy of the raw response body, attached to every error variant so + // downstream logging/alerting/pages have the full upstream context. + let raw_body = || maybe_body.map(|b| b.to_string()); + + match status_code { + StatusCode::UNAUTHORIZED => return Err(GrokSpecificApiError::Unauthorized { raw_http_body: raw_body() }.into()), + StatusCode::PAYMENT_REQUIRED => return Err(GrokSpecificApiError::InsufficientCredits { raw_http_body: raw_body() }.into()), + StatusCode::NOT_FOUND => return Err(GrokSpecificApiError::NotFound { raw_http_body: raw_body() }.into()), + StatusCode::TOO_MANY_REQUESTS => return Err(GrokSpecificApiError::RateLimited { raw_http_body: raw_body() }.into()), + _ => {} + } + + // 403 is Forbidden unless the body indicates content moderation. + if status_code == StatusCode::FORBIDDEN { + if let Some(body) = maybe_body { + if body_indicates_moderation(body) { + let message = extract_xai_error_message(body).unwrap_or_else(|| body.to_string()); + return Err(GrokSpecificApiError::PromptModerated { reason: message, raw_http_body: raw_body() }.into()); + } + } + return Err(GrokSpecificApiError::Forbidden { raw_http_body: raw_body() }.into()); + } + + // 400 Bad Request is usually a malformed body or moderation rejection. + if status_code == StatusCode::BAD_REQUEST { + if let Some(body) = maybe_body { + if body_indicates_moderation(body) { + let message = extract_xai_error_message(body).unwrap_or_else(|| body.to_string()); + return Err(GrokSpecificApiError::PromptModerated { reason: message, raw_http_body: raw_body() }.into()); + } + let message = extract_xai_error_message(body).unwrap_or_else(|| body.to_string()); + return Err(GrokSpecificApiError::BadRequest { reason: message, raw_http_body: raw_body() }.into()); + } + return Err(GrokSpecificApiError::BadRequest { reason: String::new(), raw_http_body: None }.into()); + } + + // Everything else falls through to the generic catch-all. + Err(GrokGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code, + body: maybe_body.unwrap_or("").to_string(), + }.into()) +} + +/// xAI returns OpenAI-compatible error envelopes: +/// +/// ```json +/// { "error": { "code": "...", "message": "..." } } +/// ``` +/// +/// Extract `error.message` if present. +fn extract_xai_error_message(body: &str) -> Option { + let parsed: serde_json::Value = serde_json::from_str(body).ok()?; + parsed.get("error")?.get("message")?.as_str().map(|s| s.to_string()) +} + +/// Heuristic: does this response body mention content moderation? xAI's +/// safety filter rejections include words like "moderation", "safety", +/// "content_policy", or "blocked". +pub(crate) fn body_indicates_moderation(body: &str) -> bool { + let lower = body.to_lowercase(); + lower.contains("moderat") // moderation / moderated + || lower.contains("safety") + || lower.contains("content_policy") + || lower.contains("content policy") + || lower.contains("blocked by") + || lower.contains("disallowed") +} + +#[cfg(test)] +mod tests { + use super::*; + + // ── Success ── + + #[test] + fn ok_200_returns_ok() { + assert!(classify_grok_http_error(StatusCode::OK, None).is_ok()); + } + + #[test] + fn created_201_returns_ok() { + assert!(classify_grok_http_error(StatusCode::CREATED, Some("{}")).is_ok()); + } + + // ── Direct status mappings ── + + #[test] + fn unauthorized_401() { + let err = classify_grok_http_error(StatusCode::UNAUTHORIZED, None).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::Unauthorized { .. }))); + } + + #[test] + fn payment_required_402() { + let err = classify_grok_http_error(StatusCode::PAYMENT_REQUIRED, None).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::InsufficientCredits { .. }))); + } + + #[test] + fn not_found_404() { + let err = classify_grok_http_error(StatusCode::NOT_FOUND, None).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::NotFound { .. }))); + } + + #[test] + fn rate_limited_429() { + let err = classify_grok_http_error(StatusCode::TOO_MANY_REQUESTS, None).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::RateLimited { .. }))); + } + + // ── 403 Forbidden ── + + #[test] + fn plain_403_is_forbidden() { + let err = classify_grok_http_error(StatusCode::FORBIDDEN, Some(r#"{"error":{"message":"Forbidden"}}"#)).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::Forbidden { .. }))); + } + + #[test] + fn moderation_403_is_prompt_moderated() { + let body = r#"{"error":{"message":"Content moderation blocked this prompt","code":"content_policy"}}"#; + let err = classify_grok_http_error(StatusCode::FORBIDDEN, Some(body)).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::PromptModerated { .. }))); + } + + // ── 400 Bad Request ── + + #[test] + fn bad_request_400_extracts_message() { + let body = r#"{"error":{"code":"invalid_argument","message":"unknown field 'foo'"}}"#; + let err = classify_grok_http_error(StatusCode::BAD_REQUEST, Some(body)).unwrap_err(); + match err { + GrokError::ApiSpecific(GrokSpecificApiError::BadRequest { reason: msg, .. }) => { + assert_eq!(msg, "unknown field 'foo'"); + } + other => panic!("expected BadRequest, got: {:?}", other), + } + } + + #[test] + fn bad_request_400_unparseable_body_falls_back_to_raw() { + let body = "definitely not json"; + let err = classify_grok_http_error(StatusCode::BAD_REQUEST, Some(body)).unwrap_err(); + match err { + GrokError::ApiSpecific(GrokSpecificApiError::BadRequest { reason: msg, .. }) => { + assert_eq!(msg, "definitely not json"); + } + other => panic!("expected BadRequest, got: {:?}", other), + } + } + + #[test] + fn bad_request_400_no_body_is_empty_string() { + let err = classify_grok_http_error(StatusCode::BAD_REQUEST, None).unwrap_err(); + match err { + GrokError::ApiSpecific(GrokSpecificApiError::BadRequest { reason: msg, .. }) => { + assert!(msg.is_empty()); + } + other => panic!("expected BadRequest, got: {:?}", other), + } + } + + #[test] + fn moderation_400_is_prompt_moderated() { + // Some APIs return moderation as 400 rather than 403. + let body = r#"{"error":{"message":"Safety filter blocked this request"}}"#; + let err = classify_grok_http_error(StatusCode::BAD_REQUEST, Some(body)).unwrap_err(); + assert!(matches!(err, GrokError::ApiSpecific(GrokSpecificApiError::PromptModerated { .. }))); + } + + // ── Generic fallback ── + + #[test] + fn server_error_500_is_generic() { + let err = classify_grok_http_error(StatusCode::INTERNAL_SERVER_ERROR, Some("oops")).unwrap_err(); + assert!(matches!(err, GrokError::ApiGeneric(GrokGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. }))); + } + + #[test] + fn bad_gateway_502_is_generic() { + let err = classify_grok_http_error(StatusCode::BAD_GATEWAY, None).unwrap_err(); + assert!(matches!(err, GrokError::ApiGeneric(GrokGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. }))); + } +} diff --git a/crates/api_clients/grok_api_client/src/error/grok_client_error.rs b/crates/api_clients/grok_api_client/src/error/grok_client_error.rs new file mode 100644 index 00000000..e662b312 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/error/grok_client_error.rs @@ -0,0 +1,34 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// Errors that happen entirely on the client side — before or independent of +/// the HTTP request reaching xAI's servers. +#[derive(Debug)] +pub enum GrokClientError { + /// No API key is present. + NoApiKeyPresent, + + /// An error was encountered building the reqwest client. + ReqwestClientError(reqwest::Error), + + /// The request body could not be serialized to JSON. + RequestSerializationError(serde_json::Error), + + /// The request failed our own validation before being sent to xAI — e.g. + /// mutually-exclusive fields supplied together, a required input missing, or + /// an oversize payload. Detected client-side; no HTTP call was made. + InvalidRequest(String), +} + +impl Error for GrokClientError {} + +impl Display for GrokClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::NoApiKeyPresent => write!(f, "No API key present."), + Self::ReqwestClientError(err) => write!(f, "Reqwest client error (during client creation): {}", err), + Self::RequestSerializationError(err) => write!(f, "Failed to serialize request body to JSON: {}", err), + Self::InvalidRequest(msg) => write!(f, "Invalid request (rejected client-side before sending): {}", msg), + } + } +} diff --git a/crates/api_clients/grok_api_client/src/error/grok_error.rs b/crates/api_clients/grok_api_client/src/error/grok_error.rs new file mode 100644 index 00000000..d33e238f --- /dev/null +++ b/crates/api_clients/grok_api_client/src/error/grok_error.rs @@ -0,0 +1,44 @@ +use std::error::Error; + +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::error::grok_specific_api_error::GrokSpecificApiError; + +/// Top-level error for the Grok API client. Sum of every failure mode any +/// endpoint can produce. +#[derive(Debug)] +pub enum GrokError { + Client(GrokClientError), + ApiSpecific(GrokSpecificApiError), + ApiGeneric(GrokGenericApiError), +} + +impl Error for GrokError {} + +impl std::fmt::Display for GrokError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Client(e) => write!(f, "GrokClientError: {:?}", e), + Self::ApiSpecific(e) => write!(f, "GrokSpecificApiError: {:?}", e), + Self::ApiGeneric(e) => write!(f, "GrokGenericApiError: {:?}", e), + } + } +} + +impl From for GrokError { + fn from(error: GrokClientError) -> Self { + Self::Client(error) + } +} + +impl From for GrokError { + fn from(error: GrokSpecificApiError) -> Self { + Self::ApiSpecific(error) + } +} + +impl From for GrokError { + fn from(error: GrokGenericApiError) -> Self { + Self::ApiGeneric(error) + } +} diff --git a/crates/api_clients/grok_api_client/src/error/grok_generic_api_error.rs b/crates/api_clients/grok_api_client/src/error/grok_generic_api_error.rs new file mode 100644 index 00000000..4bc16892 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/error/grok_generic_api_error.rs @@ -0,0 +1,37 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +use reqwest::StatusCode; + +/// Grab-bag for server-side responses that don't map to a `GrokSpecificApiError`. +#[derive(Debug)] +pub enum GrokGenericApiError { + /// Response body didn't deserialize against the expected schema. Includes + /// the original body so we can diagnose drift. + SerdeResponseParseErrorWithBody(serde_json::Error, String), + + /// An uncategorized bad HTTP response with status code and body. + UncategorizedBadResponseWithStatusAndBody { + status_code: StatusCode, + body: String, + }, + + /// An uncaught error from the HTTP client (e.g. network/IO). + ReqwestError(reqwest::Error), +} + +impl Error for GrokGenericApiError {} + +impl Display for GrokGenericApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::SerdeResponseParseErrorWithBody(err, body) => { + write!(f, "Failed to parse Grok API response body: {:?}. Body: {}", err, body) + } + Self::UncategorizedBadResponseWithStatusAndBody { status_code, body } => { + write!(f, "Uncategorized Grok API response: status code {}, body: {}", status_code, body) + } + Self::ReqwestError(err) => write!(f, "Reqwest error during Grok API call: {}", err), + } + } +} diff --git a/crates/api_clients/grok_api_client/src/error/grok_specific_api_error.rs b/crates/api_clients/grok_api_client/src/error/grok_specific_api_error.rs new file mode 100644 index 00000000..ba0adc02 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/error/grok_specific_api_error.rs @@ -0,0 +1,100 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// Well-known, classifiable error responses from the xAI Imagine API. +/// +/// Distinguishes things like "your key is bad" from generic 5xx so callers can +/// react appropriately (retry vs. surface to user vs. alert). +/// +/// Every variant carries the raw HTTP response body (`raw_http_body`) when one +/// was available, so downstream logging, alerting, and pages have the full +/// upstream context — not just our classification. It's `None` for errors we +/// raise client-side before making the HTTP call (e.g. pre-flight validation). +#[derive(Debug)] +pub enum GrokSpecificApiError { + /// 401 Unauthorized — API key is missing, invalid, or revoked. + Unauthorized { + raw_http_body: Option, + }, + + /// 402 Payment Required / insufficient credits to fulfill the request. + InsufficientCredits { + raw_http_body: Option, + }, + + /// 403 Forbidden — the API key is valid but lacks permission for this + /// resource/model (also covers team-level "out of credits / over spending + /// limit" responses, which xAI returns as 403 `permission-denied`). + Forbidden { + raw_http_body: Option, + }, + + /// 404 Not Found — typically returned for an unknown `request_id` on the + /// video status endpoint. + NotFound { + raw_http_body: Option, + }, + + /// 429 Too Many Requests — rate limit exceeded. + RateLimited { + raw_http_body: Option, + }, + + /// The prompt was rejected by xAI's content moderation. + PromptModerated { + /// The reason we parsed out of the response (e.g. the `error.message`). + reason: String, + /// The raw HTTP response body. + raw_http_body: Option, + }, + + /// 400 Bad Request — the request body shape was invalid (e.g. missing + /// required field, unsupported model, invalid aspect ratio). + BadRequest { + /// The reason we parsed out of the response (or the raw body when it + /// wasn't parseable). For client-side pre-flight failures, the message + /// we generated. + reason: String, + /// The raw HTTP response body. `None` for client-side pre-flight failures. + raw_http_body: Option, + }, +} + +impl Error for GrokSpecificApiError {} + +impl Display for GrokSpecificApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::Unauthorized { raw_http_body } => { + write!(f, "Grok API: Unauthorized (invalid or missing API key){}", fmt_raw_body(raw_http_body)) + } + Self::InsufficientCredits { raw_http_body } => { + write!(f, "Grok API: Insufficient credits{}", fmt_raw_body(raw_http_body)) + } + Self::Forbidden { raw_http_body } => { + write!(f, "Grok API: Forbidden{}", fmt_raw_body(raw_http_body)) + } + Self::NotFound { raw_http_body } => { + write!(f, "Grok API: Not found{}", fmt_raw_body(raw_http_body)) + } + Self::RateLimited { raw_http_body } => { + write!(f, "Grok API: Rate limited{}", fmt_raw_body(raw_http_body)) + } + Self::PromptModerated { reason, raw_http_body } => { + write!(f, "Grok API: Prompt moderated: {}{}", reason, fmt_raw_body(raw_http_body)) + } + Self::BadRequest { reason, raw_http_body } => { + write!(f, "Grok API: Bad request: {}{}", reason, fmt_raw_body(raw_http_body)) + } + } + } +} + +/// Append the raw HTTP body to a `Display` message when one is present, so +/// `{}`-formatted logs/pages carry the upstream context. Empty when absent. +fn fmt_raw_body(raw_http_body: &Option) -> String { + match raw_http_body { + Some(body) if !body.is_empty() => format!(" [raw http body: {}]", body), + _ => String::new(), + } +} diff --git a/crates/api_clients/grok_api_client/src/error/mod.rs b/crates/api_clients/grok_api_client/src/error/mod.rs new file mode 100644 index 00000000..e4da34d1 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/error/mod.rs @@ -0,0 +1,5 @@ +pub mod classify_grok_http_error; +pub mod grok_client_error; +pub mod grok_error; +pub mod grok_generic_api_error; +pub mod grok_specific_api_error; diff --git a/crates/api_clients/grok_api_client/src/lib.rs b/crates/api_clients/grok_api_client/src/lib.rs new file mode 100644 index 00000000..ed30825f --- /dev/null +++ b/crates/api_clients/grok_api_client/src/lib.rs @@ -0,0 +1,7 @@ +#[cfg(test)] +pub(crate) mod test_utils; + +// Public API +pub mod api; +pub mod creds; +pub mod error; diff --git a/crates/api_clients/grok_api_client/src/test_utils/get_test_api_key.rs b/crates/api_clients/grok_api_client/src/test_utils/get_test_api_key.rs new file mode 100644 index 00000000..ca9efea7 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/test_utils/get_test_api_key.rs @@ -0,0 +1,19 @@ +use std::fs::read_to_string; + +use errors::AnyhowResult; + +use crate::creds::grok_api_key::GrokApiKey; + +const GROK_API_KEY_PATH: &str = "/Users/bt/Artcraft/credentials/grok_api_key.txt"; + +/// Load a Grok (xAI) API key from the local credentials file. Whitespace is +/// trimmed because base64-style key files often pick up a trailing newline. +#[cfg(test)] +pub fn get_test_api_key() -> AnyhowResult { + let raw = read_to_string(GROK_API_KEY_PATH)?; + let trimmed = raw.trim().to_string(); + if trimmed.is_empty() { + anyhow::bail!("Grok API key file is empty: {}", GROK_API_KEY_PATH); + } + Ok(GrokApiKey::new(trimmed)) +} diff --git a/crates/api_clients/grok_api_client/src/test_utils/mod.rs b/crates/api_clients/grok_api_client/src/test_utils/mod.rs new file mode 100644 index 00000000..25f5e48d --- /dev/null +++ b/crates/api_clients/grok_api_client/src/test_utils/mod.rs @@ -0,0 +1,5 @@ +#[cfg(test)] +pub(crate) mod get_test_api_key; + +#[cfg(test)] +pub(crate) mod setup_test_logging; diff --git a/crates/api_clients/grok_api_client/src/test_utils/setup_test_logging.rs b/crates/api_clients/grok_api_client/src/test_utils/setup_test_logging.rs new file mode 100644 index 00000000..53194d93 --- /dev/null +++ b/crates/api_clients/grok_api_client/src/test_utils/setup_test_logging.rs @@ -0,0 +1,15 @@ +use std::sync::Once; + +static INIT: Once = Once::new(); + +/// Initialize env_logger so live-API tests print request/response details. +/// Idempotent — safe to call from every test. +#[cfg(test)] +pub fn setup_test_logging() { + INIT.call_once(|| { + let _ = env_logger::builder() + .filter_level(log::LevelFilter::Info) + .is_test(true) + .try_init(); + }); +} diff --git a/crates/api_clients/grok_consumer_client/Cargo.toml b/crates/api_clients/grok_consumer_client/Cargo.toml new file mode 100644 index 00000000..1ff64707 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/Cargo.toml @@ -0,0 +1,52 @@ +[package] +name = "grok_consumer_client" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "grok_consumer_client" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +cloudflare_errors.workspace = true +cloudflare_mitigation.workspace = true +errors.workspace = true + +# External +anyhow.workspace = true +base64.workspace = true +bstr.workspace = true +byteorder.workspace = true +chrono.workspace = true +futures.workspace = true +log.workspace = true +once_cell.workspace = true +regex.workspace = true +scraper = "0.24.0" +serde.workspace = true +serde_json.workspace = true +sha2.workspace = true +tokio = { version = "1", features = ["full"] } +url.workspace = true +uuid = { workspace = true, features = ["v4"] } +wreq-util.workspace = true +wreq.workspace = true + +[dev-dependencies] +toml.workspace = true +filesys.workspace = true +test_data.workspace = true +test_utils.workspace = true +log4rs = "1.4.0" +env_logger.workspace = true +env.workspace = true +chrono.workspace = true + diff --git a/crates/api_clients/grok_consumer_client/src/client/browser_user_agents.rs b/crates/api_clients/grok_consumer_client/src/client/browser_user_agents.rs new file mode 100644 index 00000000..94f3923b --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/client/browser_user_agents.rs @@ -0,0 +1,10 @@ + +/// Firefox 139 (2025) on macOS, which matches wreq's Emulation::Firefox139 +pub const FIREFOX_139_MAC_USER_AGENT : &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:139.0) Gecko/20100101 Firefox/139.0"; + +pub const FIREFOX_143_MAC_USER_AGENT : &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:143.0) Gecko/20100101 Firefox/143.0"; + +pub const FIREFOX_144_MAC_USER_AGENT_UNSUPPORTED_TLS_FINGERPRINTING : &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:144.0) Gecko/20100101 Firefox/144.0"; diff --git a/crates/api_clients/grok_consumer_client/src/client/grok_domain.rs b/crates/api_clients/grok_consumer_client/src/client/grok_domain.rs new file mode 100644 index 00000000..a33c46eb --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/client/grok_domain.rs @@ -0,0 +1,42 @@ +/// The scheme + host requests are sent to, e.g. `https://grok.com`. +const DEFAULT_DOMAIN: &str = "https://grok.com"; + +/// The Grok website domain endpoint bindings send requests to. +/// +/// Overridable per-request so calls can be routed through a proxy, and so +/// tests can point at a local mock server instead of the real website. +#[derive(Clone, Debug, Default, Eq, PartialEq)] +pub enum GrokDomain { + /// The real website, `https://grok.com`. + #[default] + DefaultDomain, + /// A full scheme + host override, e.g. `http://localhost:8080`. + Custom(String), +} + +impl GrokDomain { + /// The scheme + host to prefix request paths with (no trailing slash). + pub fn get_domain(&self) -> &str { + match self { + Self::DefaultDomain => DEFAULT_DOMAIN, + Self::Custom(domain) => domain, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn default_domain_is_the_real_website() { + assert_eq!(GrokDomain::DefaultDomain.get_domain(), "https://grok.com"); + assert_eq!(GrokDomain::default(), GrokDomain::DefaultDomain); + } + + #[test] + fn custom_domain_is_returned_verbatim() { + let domain = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!(domain.get_domain(), "http://localhost:8080"); + } +} diff --git a/crates/api_clients/grok_consumer_client/src/client/mod.rs b/crates/api_clients/grok_consumer_client/src/client/mod.rs new file mode 100644 index 00000000..151bcffc --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/client/mod.rs @@ -0,0 +1,2 @@ +pub mod browser_user_agents; +pub mod grok_domain; diff --git a/crates/api_clients/grok_consumer_client/src/credentials/grok_client_secrets.rs b/crates/api_clients/grok_consumer_client/src/credentials/grok_client_secrets.rs new file mode 100644 index 00000000..1a3f5201 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/credentials/grok_client_secrets.rs @@ -0,0 +1,22 @@ +use crate::datatypes::api::baggage::Baggage; +use crate::datatypes::api::sentry_trace::SentryTrace; +use crate::datatypes::api::user_email::UserEmail; +use crate::datatypes::api::user_id::UserId; + +/// Per-session values Grok's web app reads out of `index.html`. The +/// `x-statsig-id` signature is *not* here — it is minted by a real browser (see +/// the `grok_consumer_statsig` crate). +#[derive(Clone)] +pub struct GrokClientSecrets { + /// `` tag tracing data from index.html. + pub baggage: Baggage, + + /// `` tag tracing data from index.html. + pub sentry_trace: SentryTrace, + + /// From index.html. Typically needed to generate URLs. + pub user_id: UserId, + + /// From index.html. Not needed, but returned alongside other details. + pub user_email: Option, +} diff --git a/crates/api_clients/grok_consumer_client/src/credentials/grok_cookies.rs b/crates/api_clients/grok_consumer_client/src/credentials/grok_cookies.rs new file mode 100644 index 00000000..d7ebcad9 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/credentials/grok_cookies.rs @@ -0,0 +1,24 @@ + +#[derive(Clone)] +pub struct GrokCookies { + /// The entire cookies header (for now) + cookies: String, +} + +impl GrokCookies { + pub fn new(cookies: String) -> Self { + Self { cookies } + } + + pub fn as_str(&self) -> &str { + &self.cookies + } + + pub fn as_bytes(&self) -> &[u8] { + self.cookies.as_bytes() + } + + pub fn to_string(&self) -> String { + self.cookies.clone() + } +} diff --git a/crates/api_clients/grok_consumer_client/src/credentials/grok_full_credentials.rs b/crates/api_clients/grok_consumer_client/src/credentials/grok_full_credentials.rs new file mode 100644 index 00000000..0b37a18a --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/credentials/grok_full_credentials.rs @@ -0,0 +1,30 @@ +use crate::credentials::grok_client_secrets::GrokClientSecrets; +use crate::credentials::grok_cookies::GrokCookies; +use crate::datatypes::api::user_id::UserId; + +/// Includes the cookies and all the magic other bits needed to call the API. +#[derive(Clone)] +pub struct GrokFullCredentials { + /// Entire cookie payload + pub cookies: GrokCookies, + + /// Secrets from `index.html` and the xsid javascript. + /// Required for video generation. + pub client_secrets: GrokClientSecrets, +} + +impl GrokFullCredentials { + pub fn from_cookies_and_client_secrets( + cookies: GrokCookies, + client_secrets: GrokClientSecrets + ) -> Self { + Self { + cookies, + client_secrets, + } + } + + pub fn get_user_id_ref(&self) -> &UserId { + &self.client_secrets.user_id + } +} diff --git a/crates/api_clients/grok_consumer_client/src/credentials/grok_request_headers.rs b/crates/api_clients/grok_consumer_client/src/credentials/grok_request_headers.rs new file mode 100644 index 00000000..2bfe7b99 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/credentials/grok_request_headers.rs @@ -0,0 +1,36 @@ +use wreq::RequestBuilder; + +/// Per-request header secrets captured from a real browser session: +/// the statsig signature plus the tracing ids Grok's web app sends. +/// +/// Every field is optional so a partial set still applies. Currently used to +/// replay captured values in live-wire tests; a future change will generate +/// `statsig_id` from fresh cookies. +/// +/// NB: `xai_request_id` is sent as the `x-xai-request-id` header. +#[derive(Clone, Debug, Default)] +pub struct GrokRequestHeaders { + pub statsig_id: Option, + pub xai_request_id: Option, + pub traceparent: Option, + pub sentry_trace: Option, +} + +impl GrokRequestHeaders { + /// Attach whichever headers are present to a request builder. + pub fn apply(&self, mut builder: RequestBuilder) -> RequestBuilder { + if let Some(statsig_id) = &self.statsig_id { + builder = builder.header("x-statsig-id", statsig_id); + } + if let Some(xai_request_id) = &self.xai_request_id { + builder = builder.header("x-xai-request-id", xai_request_id); + } + if let Some(traceparent) = &self.traceparent { + builder = builder.header("traceparent", traceparent); + } + if let Some(sentry_trace) = &self.sentry_trace { + builder = builder.header("sentry-trace", sentry_trace); + } + builder + } +} diff --git a/crates/api_clients/grok_consumer_client/src/credentials/grok_user_data.rs b/crates/api_clients/grok_consumer_client/src/credentials/grok_user_data.rs new file mode 100644 index 00000000..8b9f28b5 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/credentials/grok_user_data.rs @@ -0,0 +1,22 @@ +use crate::datatypes::api::user_email::UserEmail; +use crate::datatypes::api::user_id::UserId; + +#[derive(Clone)] +pub struct GrokUserData { + /// From index.html + /// Not strictly needed to sign requests, but typically needed to generate URLs. + pub user_id: UserId, + + /// From index.html + /// Not needed, but returned alongside other details. + pub user_email: Option, +} + +impl GrokUserData { + pub fn from_id_and_email(id: String, email: Option) -> Self { + Self { + user_id: UserId(id), + user_email: email.map(|email| UserEmail(email)), + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/credentials/mod.rs b/crates/api_clients/grok_consumer_client/src/credentials/mod.rs new file mode 100644 index 00000000..5f79eee5 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/credentials/mod.rs @@ -0,0 +1,5 @@ +pub mod grok_client_secrets; +pub mod grok_cookies; +pub mod grok_full_credentials; +pub mod grok_request_headers; +pub mod grok_user_data; diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/aspect_ratio.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/aspect_ratio.rs new file mode 100644 index 00000000..614e4515 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/aspect_ratio.rs @@ -0,0 +1,13 @@ +use serde::Serialize; + +#[derive(Serialize, Clone, Copy, Debug)] +pub enum AspectRatio { + #[serde(rename = "2:3")] + TallTwoByThree, + + #[serde(rename = "3:2")] + WideThreeByTwo, + + #[serde(rename = "1:1")] + Square, +} diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/baggage.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/baggage.rs new file mode 100644 index 00000000..0264b43a --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/baggage.rs @@ -0,0 +1,4 @@ + +/// "baggage" data from the tags +#[derive(Debug, Clone)] +pub struct Baggage(pub(crate) String); diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/file_id.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/file_id.rs new file mode 100644 index 00000000..b262a287 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/file_id.rs @@ -0,0 +1,5 @@ + +/// Type for File IDs. +/// File IDs are UUIds. +#[derive(Clone, Debug)] +pub struct FileId(pub String); diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/mod.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/mod.rs new file mode 100644 index 00000000..23c27f8f --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/mod.rs @@ -0,0 +1,8 @@ +pub mod aspect_ratio; +pub mod baggage; +pub mod file_id; +pub mod post_id; +pub mod request_id; +pub mod sentry_trace; +pub mod user_email; +pub mod user_id; diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/post_id.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/post_id.rs new file mode 100644 index 00000000..3315dc9b --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/post_id.rs @@ -0,0 +1,12 @@ + +/// Type for Post IDs. +/// Post IDs are UUIds. +/// These are often shared with media/image uploads' `FileId`s, but seldom video generation `FileId`s +#[derive(Clone, Debug)] +pub struct PostId(pub String); + +impl PostId { + pub fn to_string(&self) -> String { + self.0.clone() + } +} diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/request_id.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/request_id.rs new file mode 100644 index 00000000..1e06ece4 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/request_id.rs @@ -0,0 +1,13 @@ + +/// Request IDs. +/// Type for image websocket "tasks" +/// These are for image generation websockets. +/// Request IDs are UUIds. +#[derive(Clone, Debug)] +pub struct RequestId(pub String); + +impl RequestId { + pub fn to_string(&self) -> String { + self.0.clone() + } +} diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/sentry_trace.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/sentry_trace.rs new file mode 100644 index 00000000..8d81c7c8 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/sentry_trace.rs @@ -0,0 +1,40 @@ +use uuid::Uuid; + +/// "sentry trace" data from the tags +#[derive(Debug, Clone)] +pub struct SentryTrace(pub (crate) String); + +impl SentryTrace { + + /// Generate the format of trace sent in the HTTP request headers + pub fn to_http_request_header(&self) -> String { + // Python reference: + // f'{self.sentry_trace}-{str(uuid4()).replace("-", "")[:16]}-0', + // Inner bit: + // str(uuid4()).replace("-", "")[:16] + let sentry_start = &self.0; + let sentry_uuid = Uuid::new_v4().to_string(); + let sentry_inner = sentry_uuid.replace("-", "")[..16].to_string(); + + format!("{sentry_start}-{sentry_inner}-0") + } +} + +#[cfg(test)] +mod tests { + use crate::datatypes::api::sentry_trace::SentryTrace; + + #[test] + fn test_real_trace() { + let short = SentryTrace("d6d7c55e4a489c0dabaed06e5c7b257b".to_string()); + let header = short.to_http_request_header(); + assert_eq!(header.len(), 51); + } + + #[test] + fn test_invalid_trace() { + let short = SentryTrace("".to_string()); + let header = short.to_http_request_header(); + assert_eq!(header.len(), 19); // header is invalid, we're just making sure Rust doesn't panic + } +} diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/user_email.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/user_email.rs new file mode 100644 index 00000000..a6ba535a --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/user_email.rs @@ -0,0 +1,9 @@ +/// Type for User Emails +#[derive(Clone, Debug)] +pub struct UserEmail(pub String); + +impl UserEmail { + pub fn to_string(&self) -> String { + self.0.clone() + } +} diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/api/user_id.rs b/crates/api_clients/grok_consumer_client/src/datatypes/api/user_id.rs new file mode 100644 index 00000000..c7e522fd --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/api/user_id.rs @@ -0,0 +1,12 @@ + +/// Type for User IDs. +/// User IDs are UUIDs. +#[derive(Clone, Debug)] +pub struct UserId(pub String); + +impl UserId { + pub fn to_string(&self) -> String { + self.0.clone() + } +} + diff --git a/crates/api_clients/grok_consumer_client/src/datatypes/mod.rs b/crates/api_clients/grok_consumer_client/src/datatypes/mod.rs new file mode 100644 index 00000000..e5fdf85e --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/datatypes/mod.rs @@ -0,0 +1 @@ +pub mod api; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/grok_generate_image_websocket.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/grok_generate_image_websocket.rs new file mode 100644 index 00000000..d5fb54f7 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/grok_generate_image_websocket.rs @@ -0,0 +1,482 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::datatypes::api::request_id::RequestId; +use crate::endpoint_bindings::generate_image_websocket::messages::websocket_client_message::{FastAspectRatio, QualityAspectRatio, WebsocketClientMessage}; +use crate::endpoint_bindings::generate_image_websocket::messages::websocket_server_message::{ErrorMessage, ERR_CODE_RATE_LIMIT_EXCEEDED, WebsocketServerMessage}; +use crate::error::grok_specific_api_error::GrokSpecificApiError; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::prompt_flags::PromptFlags; +use cloudflare_mitigation::headers::firefox_websocket_http_1_1_headers::get_firefox_websocket_http_1_1_headers; +use futures::TryStreamExt; +use log::warn; +use serde::Serialize; +use std::sync::Arc; +use std::time::{Duration, Instant}; +use tokio::sync::Mutex; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, CACHE_CONTROL, COOKIE, ORIGIN, PRAGMA, SEC_WEBSOCKET_EXTENSIONS, USER_AGENT}; +use wreq::ws::message::Message; +use wreq::ws::WebSocket; +use wreq::Client; +use wreq_util::Emulation; + +const WEBSOCKET_URL: &str = "wss://grok.com/ws/imagine/listen"; + +const CONNECT_TIMEOUT: Duration = Duration::from_secs(30); + +/// Completed images expected per prompt when the caller doesn't say otherwise. +/// Mirrors the client message's `num_generations`. +pub const DEFAULT_IMAGE_COUNT: usize = 2; + +/// How long each receive poll waits before looping (also the granularity at +/// which the shared socket lock is released for senders). +const RECEIVE_POLL_INTERVAL: Duration = Duration::from_millis(500); + +/// Attempts (including the first) for a prompt send before giving up. +const SEND_ATTEMPTS: usize = 3; + +/// A finished image produced by a prompt. +#[derive(Clone, Debug)] +pub struct CompletedImage { + /// Identifies the prompt/task that produced the image. Sibling images from + /// one prompt share it. + pub request_id: RequestId, + /// Where to download the image. + pub url: String, + /// The prompt the user typed. + pub user_prompt: String, + /// The model-enriched prompt. + pub enriched_prompt: String, +} + +/// One thing the imagine websocket told us while polling: a finished image, +/// or an error frame (e.g. out of quota) for a prompt. +#[derive(Clone, Debug)] +pub enum ImageWebsocketEvent { + /// A finished (100%) image with a download URL. + Completed(CompletedImage), + /// Grok rejected or aborted a prompt. `request_id` is `None` when the frame + /// didn't say which prompt it concerns. + Failed { + request_id: Option, + /// User-facing message from the frame, if any. + message: Option, + /// Grok's error code from the frame, if any. + err_code: Option, + /// The raw frame, for logs. + raw_frame: String, + }, +} + +/// A live connection to Grok's "imagine" image websocket. +/// +/// Cheap to clone and safe to share across tasks — the socket lives behind an +/// `Arc>`, so every method takes `&self`. Open one with [`connect`], +/// push prompts with [`send_fast_image_prompt`] / [`send_quality_image_prompt`] +/// (or the `_with_retry` variants, which reconnect on failure), read typed +/// frames with [`next_message`], or wait for finished images with +/// [`collect_images`]. +/// +/// [`connect`]: Self::connect +/// [`send_fast_image_prompt`]: Self::send_fast_image_prompt +/// [`send_quality_image_prompt`]: Self::send_quality_image_prompt +/// [`next_message`]: Self::next_message +/// [`collect_images`]: Self::collect_images +#[derive(Clone)] +pub struct GrokImageWebsocket { + /// Kept so the socket can transparently reconnect after a dropped send. + cookies: Arc, + socket: Arc>, +} + +impl GrokImageWebsocket { + /// Open a fresh imagine websocket authenticated with the given cookie header. + pub async fn connect(cookies: &str) -> Result { + let socket = open_socket(cookies).await?; + Ok(Self { + cookies: Arc::from(cookies), + socket: Arc::new(Mutex::new(socket)), + }) + } + + /// Reconnect in place. All clones share the same handle, so they all see the + /// new connection. + pub async fn reconnect(&self) -> Result<(), GrokError> { + let fresh = open_socket(&self.cookies).await?; + *self.socket.lock().await = fresh; + Ok(()) + } + + /// Send a **fast** ("speed") image prompt. Fast mode supports the + /// [`FastAspectRatio`] set. `flags` appends any `--` long args (e.g. + /// `--mode`) to the prompt; pass `&PromptFlags::default()` for none. + /// + /// Returns the prompt's request id, which every resulting frame carries. + pub async fn send_fast_image_prompt( + &self, + prompt: &str, + aspect_ratio: FastAspectRatio, + flags: &PromptFlags, + ) -> Result { + let message = WebsocketClientMessage::new_fast_image_prompt(prompt, aspect_ratio, flags); + self.send_json(&message).await?; + Ok(message.request_id()) + } + + /// [`send_fast_image_prompt`], reconnecting and retrying if the send fails + /// (e.g. the socket dropped between prompts). + /// + /// [`send_fast_image_prompt`]: Self::send_fast_image_prompt + pub async fn send_fast_image_prompt_with_retry( + &self, + prompt: &str, + aspect_ratio: FastAspectRatio, + flags: &PromptFlags, + ) -> Result { + self.send_with_retry(WebsocketClientMessage::new_fast_image_prompt(prompt, aspect_ratio, flags)).await + } + + /// Send a **quality** ("pro") image prompt — slower, higher quality. Quality + /// mode supports the larger [`QualityAspectRatio`] set. + pub async fn send_quality_image_prompt( + &self, + prompt: &str, + aspect_ratio: QualityAspectRatio, + flags: &PromptFlags, + ) -> Result { + let message = WebsocketClientMessage::new_quality_image_prompt(prompt, aspect_ratio, flags); + self.send_json(&message).await?; + Ok(message.request_id()) + } + + /// [`send_quality_image_prompt`], reconnecting and retrying if the send + /// fails. + /// + /// [`send_quality_image_prompt`]: Self::send_quality_image_prompt + pub async fn send_quality_image_prompt_with_retry( + &self, + prompt: &str, + aspect_ratio: QualityAspectRatio, + flags: &PromptFlags, + ) -> Result { + self.send_with_retry(WebsocketClientMessage::new_quality_image_prompt(prompt, aspect_ratio, flags)).await + } + + /// Send a prepared message, reconnecting and retrying on failure. + async fn send_with_retry(&self, message: WebsocketClientMessage) -> Result { + let mut last_error = None; + + for attempt in 1..=SEND_ATTEMPTS { + match self.send_json(&message).await { + Ok(()) => return Ok(message.request_id()), + Err(err) => { + warn!("Grok image prompt send failed (attempt {attempt}/{SEND_ATTEMPTS}): {err}"); + last_error = Some(err); + if attempt < SEND_ATTEMPTS { + self.reconnect().await?; + } + } + } + } + + Err(last_error.expect("loop runs at least once")) + } + + /// Serialize and send any client message as a text frame. + pub async fn send_json(&self, message: &T) -> Result<(), GrokError> { + let json = serde_json::to_string(message) + .map_err(GrokClientError::WebsocketRequestSerializationError)?; + let mut socket = self.socket.lock().await; + socket.send(Message::text(json)) + .await + .map_err(GrokClientError::WebsocketSendError)?; + Ok(()) + } + + /// Receive the next parsed server message, or `None` if `timeout` elapses, + /// the stream closes, or a non-text frame arrives. + pub async fn next_message(&self, timeout: Duration) -> Result, GrokError> { + match self.next_text(timeout).await? { + Some(text) => Ok(Some(WebsocketServerMessage::from_json_str(&text)?)), + None => Ok(None), + } + } + + /// Drain whatever the socket has to say for up to `budget`, returning the + /// finished images and error frames seen (in order). Never blocks past the + /// budget, so a polling thread can share one socket across many prompts and + /// key each event on its request id. Progress / session / blob frames are + /// skipped. + /// + /// Unlike [`collect_images`], an error frame is returned as an event rather + /// than failing the call, since it concerns one prompt, not the socket. + /// + /// [`collect_images`]: Self::collect_images + pub async fn poll_events(&self, budget: Duration) -> Result, GrokError> { + let deadline = Instant::now() + budget; + let mut events = Vec::new(); + + while Instant::now() < deadline { + let remaining = deadline.saturating_duration_since(Instant::now()).min(RECEIVE_POLL_INTERVAL); + let Some(text) = self.next_text(remaining).await? else { + continue; + }; + + let Ok(message) = WebsocketServerMessage::from_json_str(&text) else { + continue; + }; + + match &message { + WebsocketServerMessage::Error(error) => events.push(ImageWebsocketEvent::Failed { + request_id: error.request_id.clone().map(RequestId), + message: error.err_msg.clone(), + err_code: error.err_code.clone(), + raw_frame: text, + }), + _ => { + if let Some(image) = completed_image(&message) { + events.push(ImageWebsocketEvent::Completed(image)); + } + } + } + } + + Ok(events) + } + + /// Wait for [`DEFAULT_IMAGE_COUNT`] completed images or until `timeout`. + pub async fn collect_images(&self, timeout: Duration) -> Result, GrokError> { + self.collect_n_images(DEFAULT_IMAGE_COUNT, timeout).await + } + + /// Poll until `image_count` completed images arrive or `timeout` elapses. + /// Non-image frames (progress updates, session notices, blobs) are skipped. + pub async fn collect_n_images( + &self, + image_count: usize, + timeout: Duration, + ) -> Result, GrokError> { + let deadline = Instant::now() + timeout; + let mut images = Vec::new(); + + while images.len() < image_count && Instant::now() < deadline { + let text = match self.next_text(RECEIVE_POLL_INTERVAL).await? { + Some(text) => text, + None => continue, + }; + + // Parse leniently — the stream interleaves progress, session, and image + // frames, and we only care about finished images. + let Ok(message) = WebsocketServerMessage::from_json_str(&text) else { + continue; + }; + + // An error frame (e.g. out-of-quota) means no images are coming; fail + // fast with a typed error carrying the raw frame. + if let WebsocketServerMessage::Error(error) = &message { + return Err(error_frame_to_grok_error(error, &text)); + } + + if let Some(image) = completed_image(&message) { + images.push(image); + } + } + + Ok(images) + } + + /// Receive the next text frame, or `None` on timeout / close / non-text. + async fn next_text(&self, timeout: Duration) -> Result, GrokError> { + let mut socket = self.socket.lock().await; + match tokio::time::timeout(timeout, socket.try_next()).await { + Err(_elapsed) => Ok(None), + Ok(result) => match result.map_err(GrokClientError::WebsocketReadError)? { + Some(Message::Text(text)) => Ok(Some(text.to_string())), + Some(_) => { + warn!("Received non-text websocket message; ignoring."); + Ok(None) + } + None => Ok(None), + }, + } + } +} + +/// Map a server error frame (plus its raw body) to a typed error. Quota / +/// rate-limit exhaustion gets its own [`GrokSpecificApiError`] variant; any +/// other code is surfaced generically. Both carry the full raw frame. +fn error_frame_to_grok_error(error: &ErrorMessage, raw_frame: &str) -> GrokError { + match error.err_code.as_deref() { + Some(ERR_CODE_RATE_LIMIT_EXCEEDED) => { + GrokSpecificApiError::ImageRateLimitExceeded { body: raw_frame.to_string() }.into() + } + _ => { + GrokGenericApiError::UnexpectedWebsocketErrorFrame { body: raw_frame.to_string() }.into() + } + } +} + +/// The completed-image view of a server message, if it is a finished image +/// (100%) that carries a URL. +fn completed_image(message: &WebsocketServerMessage) -> Option { + let WebsocketServerMessage::Image(image) = message else { + return None; + }; + + if image.percentage_complete? < 100.0 { + return None; + } + + Some(CompletedImage { + request_id: RequestId(image.request_id.clone().unwrap_or_default()), + url: image.url.clone()?, + user_prompt: image.prompt.clone().unwrap_or_default(), + enriched_prompt: image.full_prompt.clone().unwrap_or_default(), + }) +} + +/// Open a raw imagine websocket. HTTP/1.1 websocket handshakes are sensitive to +/// header casing and order, and Cloudflare rejects lowercased names, so we send +/// an explicit, ordered header set (via `default_headers(false)`). +async fn open_socket(cookies: &str) -> Result { + let client = Client::builder() + .emulation(Emulation::Firefox143) + .connection_verbose(true) + .connect_timeout(CONNECT_TIMEOUT) + .build() + .map_err(GrokClientError::WreqClientError)?; + + let response = client.websocket(WEBSOCKET_URL) + .default_headers(false) + .orig_headers(get_firefox_websocket_http_1_1_headers()) + .header(COOKIE, cookies) + .header(ORIGIN, "https://grok.com") + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(SEC_WEBSOCKET_EXTENSIONS, "permessage-deflate") + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "websocket") + .header("Sec-Fetch-Site", "same-origin") + .header(PRAGMA, "no-cache") + .header(CACHE_CONTROL, "no-cache") + .send() + .await + .map_err(GrokClientError::WreqClientError)?; + + let status = response.status(); + match status.as_u16() { + 101 => {} + 401 => return Err(GrokGenericApiError::LikelyWebsocketAuthentication401.into()), + 403 => return Err(GrokGenericApiError::LikelyWebsocketCloudflare403.into()), + _ => return Err(GrokGenericApiError::UnexpectedWebsocketUpgradeStatusCode(status).into()), + } + + response.into_websocket() + .await + .map_err(|err| GrokGenericApiError::WreqWebsocketUpgradeError(err).into()) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::error::grok_generic_api_error::GrokGenericApiError; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::{info, LevelFilter}; + + // Cargo runs tests with the crate root as the working directory. + fn ws_frame(file_name: &str) -> String { + std::fs::read_to_string(format!("test_data/websocket_messages/{file_name}")).unwrap() + } + + fn parse_frame(file_name: &str) -> WebsocketServerMessage { + WebsocketServerMessage::from_json_str(&ws_frame(file_name)).unwrap() + } + + // These exercise the handling that turns parsed frames into the `Ok`/`Err` + // results `collect_images` yields, using real captured frames. + + #[test] + fn completed_image_from_real_frame() { + let image = completed_image(&parse_frame("real_image_complete.json")) + .expect("a finished (100%) image with a url"); + + assert_eq!(image.request_id.to_string(), "ab3fa8e9-92ed-4f1b-a350-7a897e264d54"); + assert!(image.url.starts_with("https://imagine-public.x.ai/")); + assert_eq!(image.user_prompt, "A dead tree stump in the middle of a forest meadow"); + assert_eq!(image.enriched_prompt, "A dead tree stump in the middle of a forest meadow"); + } + + #[test] + fn completed_image_ignores_progress_and_session_frames() { + assert!(completed_image(&parse_frame("real_json_progress.json")).is_none()); + assert!(completed_image(&parse_frame("real_session_notice.json")).is_none()); + } + + #[test] + fn rate_limit_error_frame_maps_to_quota_error() { + let raw = ws_frame("real_rate_limit_error.json"); + let WebsocketServerMessage::Error(error) = parse_frame("real_rate_limit_error.json") else { + panic!("expected an error frame"); + }; + + match error_frame_to_grok_error(&error, &raw) { + GrokError::ApiSpecific(GrokSpecificApiError::ImageRateLimitExceeded { body }) => { + // The distinct error carries the full raw frame. + assert!(body.contains("rate_limit_exceeded")); + assert!(body.contains("Image rate limit exceeded")); + } + other => panic!("expected ImageRateLimitExceeded, got {:?}", other), + } + } + + #[test] + fn unknown_error_code_maps_to_generic_error() { + let raw = r#"{"type":"error","err_code":"some_new_code","err_msg":"nope"}"#; + let WebsocketServerMessage::Error(error) = WebsocketServerMessage::from_json_str(raw).unwrap() else { + panic!("expected an error frame"); + }; + + match error_frame_to_grok_error(&error, raw) { + GrokError::ApiGeneric(GrokGenericApiError::UnexpectedWebsocketErrorFrame { body }) => { + assert_eq!(body, raw); + } + other => panic!("expected UnexpectedWebsocketErrorFrame, got {:?}", other), + } + } + + #[tokio::test] + #[ignore] // Opens a real websocket and spends image-generation quota. + async fn connect_prompt_and_collect() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let websocket = GrokImageWebsocket::connect(secrets.cookies.as_str()).await?; + + websocket.send_fast_image_prompt_with_retry( + "A dinosaur on stilts walking on the beach", + FastAspectRatio::WideThreeByTwo, + &PromptFlags::default(), + ).await?; + + match websocket.collect_images(Duration::from_secs(30)).await { + Ok(images) => { + info!("Collected {} image(s).", images.len()); + for image in &images { + info!("Image: {} ({})", image.url, image.request_id.to_string()); + } + assert!(!images.is_empty(), "expected at least one completed image"); + } + // Out of quota is a valid "the plumbing works" outcome; surface it + // clearly rather than failing. + Err(GrokError::ApiSpecific(GrokSpecificApiError::ImageRateLimitExceeded { body })) => { + info!("Image rate limit / quota exhausted (expected when out of quota): {body}"); + } + Err(err) => return Err(err.into()), + } + + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/mod.rs new file mode 100644 index 00000000..a8f9ece5 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/mod.rs @@ -0,0 +1,2 @@ +pub mod websocket_client_message; +pub mod websocket_server_message; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/websocket_client_message.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/websocket_client_message.rs new file mode 100644 index 00000000..2b84cd6a --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/websocket_client_message.rs @@ -0,0 +1,322 @@ +use crate::datatypes::api::request_id::RequestId; +use crate::prompt_flags::PromptFlags; +use chrono::Utc; +use serde::Serialize; +use uuid::Uuid; + +/// Number of images requested per prompt. The web app pairs this with +/// `enable_side_by_side` to render a 2-up result (observed 2026-08-23). +const DEFAULT_NUM_GENERATIONS: usize = 2; + +/// The web app requests two side-by-side images by default. +const DEFAULT_ENABLE_SIDE_BY_SIDE: bool = true; + +/// The web app does not request a watermark. +const DEFAULT_ENABLE_WATERMARK: bool = false; + +/// Aspect ratios available in **fast** ("speed") image mode (`enable_pro: +/// false`). Grok's fast mode supports a smaller set than quality mode. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum FastAspectRatio { + /// 1:1 + Square, + /// 2:3 + TallTwoByThree, + /// 3:2 + WideThreeByTwo, + /// 16:9 + WideSixteenByNine, + /// 9:16 + TallNineBySixteen, +} + +impl FastAspectRatio { + /// The Grok wire string, e.g. `"16:9"`. + pub fn as_grok_str(self) -> &'static str { + match self { + Self::Square => "1:1", + Self::TallTwoByThree => "2:3", + Self::WideThreeByTwo => "3:2", + Self::WideSixteenByNine => "16:9", + Self::TallNineBySixteen => "9:16", + } + } +} + +/// Aspect ratios available in **quality** ("pro") image mode (`enable_pro: +/// true`). A superset of the fast ratios plus 4:3, 21:9, and 5:2. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum QualityAspectRatio { + /// 1:1 + Square, + /// 9:16 + TallNineBySixteen, + /// 16:9 + WideSixteenByNine, + /// 2:3 + TallTwoByThree, + /// 3:2 + WideThreeByTwo, + /// 4:3 + WideFourByThree, + /// 21:9 + WideTwentyOneByNine, + /// 5:2 + WideFiveByTwo, +} + +impl QualityAspectRatio { + /// The Grok wire string, e.g. `"21:9"`. + pub fn as_grok_str(self) -> &'static str { + match self { + Self::Square => "1:1", + Self::TallNineBySixteen => "9:16", + Self::WideSixteenByNine => "16:9", + Self::TallTwoByThree => "2:3", + Self::WideThreeByTwo => "3:2", + Self::WideFourByThree => "4:3", + Self::WideTwentyOneByNine => "21:9", + Self::WideFiveByTwo => "5:2", + } + } +} + +#[derive(Serialize)] +pub struct WebsocketClientMessage { + /// Type of message + /// eg. "conversation.item.create" + pub r#type: String, + + /// Unix timestamp + pub timestamp: u64, + + pub item: ClientMessageItem, +} + +#[derive(Serialize)] +pub struct ClientMessageItem { + /// Type of item + /// eg. "message" + pub r#type: String, + + pub content: Vec, +} + +#[derive(Serialize)] +pub struct ClientMessageItemContent { + /// UUID + #[serde(rename="requestId")] + pub request_id: String, + + /// Type of item content + /// eg. "input_text" + pub r#type: String, + + /// The prompt for the request + pub text: String, + + pub properties: ClientMessageItemContentProperties, +} + +/// Field order mirrors the web app's wire payload (observed 2026-08-23). +#[derive(Serialize)] +pub struct ClientMessageItemContentProperties { + pub section_count: usize, + pub is_kids_mode: bool, + pub enable_nsfw: bool, + pub skip_upsampler: bool, + pub enable_side_by_side: bool, + pub is_initial: bool, + /// The Grok aspect-ratio string, e.g. "2:3" or "21:9". + pub aspect_ratio: String, + /// Quality flag: `true` selects "pro"/quality (slow); `false` is fast. + pub enable_pro: bool, + pub num_generations: usize, + pub enable_watermark: bool, +} + +impl WebsocketClientMessage { + /// A **fast** ("speed") image prompt (`enable_pro: false`). + /// + /// `flags` appends any `--` long args (e.g. `--mode=extremely-spicy-or-crazy`) + /// to the prompt text; [`PromptFlags::default()`] leaves the prompt untouched, + /// matching the plain-prompt captures. Mirrors the web app's + /// `conversation.item.create` send frame (see + /// `external/requests/sites/grok.com/2026-08-23-imagine/14_same_websocket_low_quality_fast_images.har.json` + /// and `21_spicey_image_gen_test.har.json`). + pub fn new_fast_image_prompt(prompt: &str, aspect_ratio: FastAspectRatio, flags: &PromptFlags) -> Self { + Self::new_image_prompt(prompt, aspect_ratio.as_grok_str(), false, flags) + } + + /// A **quality** ("pro") image prompt (`enable_pro: true`). + /// + /// Mirrors the web app's send frame (see + /// `external/requests/sites/grok.com/2026-08-23-imagine/13_image_high_quality_websocket.har.json`). + pub fn new_quality_image_prompt(prompt: &str, aspect_ratio: QualityAspectRatio, flags: &PromptFlags) -> Self { + Self::new_image_prompt(prompt, aspect_ratio.as_grok_str(), true, flags) + } + + /// The generated `requestId` of this prompt. Grok tags every progress / + /// image / error frame for the prompt with it, so callers key results on it. + pub fn request_id(&self) -> RequestId { + RequestId( + self.item.content.first() + .map(|content| content.request_id.clone()) + .unwrap_or_default(), + ) + } + + fn new_image_prompt(prompt: &str, aspect_ratio: &str, enable_pro: bool, flags: &PromptFlags) -> Self { + Self { + r#type: "conversation.item.create".to_string(), + timestamp: Utc::now().timestamp_millis() as u64, + item: ClientMessageItem { + r#type: "message".to_string(), + content: vec![ + ClientMessageItemContent { + request_id: Uuid::new_v4().to_string(), + r#type: "input_text".to_string(), + text: flags.apply_to(prompt), + properties: ClientMessageItemContentProperties { + section_count: 0, + is_kids_mode: false, + enable_nsfw: true, + skip_upsampler: false, + enable_side_by_side: DEFAULT_ENABLE_SIDE_BY_SIDE, + is_initial: false, + aspect_ratio: aspect_ratio.to_string(), + enable_pro, + num_generations: DEFAULT_NUM_GENERATIONS, + enable_watermark: DEFAULT_ENABLE_WATERMARK, + }, + } + ], + }, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + // Cargo runs tests with the crate root as the working directory. + fn load_send_frame(file_name: &str) -> serde_json::Value { + serde_json::from_str( + &std::fs::read_to_string(format!("test_data/websocket_messages/{file_name}")).unwrap(), + ).unwrap() + } + + /// Assert our serialized message matches a captured send frame property for + /// property (ignoring `requestId`/`timestamp`, which we generate). + fn assert_matches_capture(ours: &serde_json::Value, captured: &serde_json::Value) { + assert_eq!(ours["type"], captured["type"]); + assert_eq!(ours["item"]["type"], captured["item"]["type"]); + + let ours_content = &ours["item"]["content"][0]; + let captured_content = &captured["item"]["content"][0]; + assert_eq!(ours_content["type"], captured_content["type"]); + assert_eq!(ours_content["text"], captured_content["text"]); + assert!(ours_content["requestId"].as_str().is_some()); + + let captured_props = captured_content["properties"].as_object().unwrap(); + let ours_props = &ours_content["properties"]; + for (key, value) in captured_props { + assert_eq!(&ours_props[key], value, "property `{key}` differs from the real frame"); + } + } + + // A `--mode` flag is appended to the image prompt text, matching the real + // spicy capture (21_spicey_image_gen_test.har.json). + #[test] + fn mode_flag_appended_to_image_prompt() { + use crate::prompt_flags::GenerationMode; + let value = serde_json::to_value( + WebsocketClientMessage::new_fast_image_prompt( + "woman on beach", + FastAspectRatio::WideSixteenByNine, + &PromptFlags::with_mode(GenerationMode::Spicy), + ), + ).unwrap(); + assert_eq!( + value["item"]["content"][0]["text"], + "woman on beach --mode=extremely-spicy-or-crazy", + ); + } + + mod fast_mode_tests { + use super::*; + + #[test] + fn wire_format() { + let value = serde_json::to_value( + WebsocketClientMessage::new_fast_image_prompt("a cat", FastAspectRatio::TallTwoByThree, &PromptFlags::default()), + ).unwrap(); + let properties = &value["item"]["content"][0]["properties"]; + + assert_eq!(value["type"], "conversation.item.create"); + assert_eq!(properties["aspect_ratio"], "2:3"); + assert_eq!(properties["enable_pro"], false); + assert_eq!(properties["enable_side_by_side"], true); + assert_eq!(properties["num_generations"], 2); + assert_eq!(properties["enable_watermark"], false); + assert_eq!(properties["skip_upsampler"], false); + } + + // Real fast send frame: "Race car", 3:2 (from capture 14). + #[test] + fn matches_real_captured_frame() { + let ours = serde_json::to_value( + WebsocketClientMessage::new_fast_image_prompt("Race car", FastAspectRatio::WideThreeByTwo, &PromptFlags::default()), + ).unwrap(); + assert_matches_capture(&ours, &load_send_frame("real_fast_image_prompt_request.json")); + } + + #[test] + fn aspect_ratios_serialize_to_grok_strings() { + assert_eq!(FastAspectRatio::Square.as_grok_str(), "1:1"); + assert_eq!(FastAspectRatio::TallTwoByThree.as_grok_str(), "2:3"); + assert_eq!(FastAspectRatio::WideThreeByTwo.as_grok_str(), "3:2"); + assert_eq!(FastAspectRatio::WideSixteenByNine.as_grok_str(), "16:9"); + assert_eq!(FastAspectRatio::TallNineBySixteen.as_grok_str(), "9:16"); + } + } + + mod quality_mode_tests { + use super::*; + + #[test] + fn wire_format() { + let value = serde_json::to_value( + WebsocketClientMessage::new_quality_image_prompt("a cat", QualityAspectRatio::WideTwentyOneByNine, &PromptFlags::default()), + ).unwrap(); + let properties = &value["item"]["content"][0]["properties"]; + + assert_eq!(properties["aspect_ratio"], "21:9"); + assert_eq!(properties["enable_pro"], true); + assert_eq!(properties["enable_side_by_side"], true); + assert_eq!(properties["num_generations"], 2); + } + + // Real quality send frame: "luxury car", 21:9 (from capture 13). + #[test] + fn matches_real_captured_frame() { + let ours = serde_json::to_value( + WebsocketClientMessage::new_quality_image_prompt("luxury car", QualityAspectRatio::WideTwentyOneByNine, &PromptFlags::default()), + ).unwrap(); + assert_matches_capture(&ours, &load_send_frame("real_quality_image_prompt_request.json")); + } + + #[test] + fn aspect_ratios_serialize_to_grok_strings() { + assert_eq!(QualityAspectRatio::Square.as_grok_str(), "1:1"); + assert_eq!(QualityAspectRatio::TallNineBySixteen.as_grok_str(), "9:16"); + assert_eq!(QualityAspectRatio::WideSixteenByNine.as_grok_str(), "16:9"); + assert_eq!(QualityAspectRatio::TallTwoByThree.as_grok_str(), "2:3"); + assert_eq!(QualityAspectRatio::WideThreeByTwo.as_grok_str(), "3:2"); + assert_eq!(QualityAspectRatio::WideFourByThree.as_grok_str(), "4:3"); + assert_eq!(QualityAspectRatio::WideTwentyOneByNine.as_grok_str(), "21:9"); + assert_eq!(QualityAspectRatio::WideFiveByTwo.as_grok_str(), "5:2"); + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/websocket_server_message.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/websocket_server_message.rs new file mode 100644 index 00000000..3e25fc2c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/messages/websocket_server_message.rs @@ -0,0 +1,274 @@ +use crate::error::grok_generic_api_error::GrokGenericApiError; +use serde::Deserialize; + +#[derive(Deserialize, Clone, Debug)] +#[serde(tag = "type")] +pub enum WebsocketServerMessage { + /// Json with root `type = "image"` + #[serde(rename = "image")] + Image(ImageDataMessage), + + /// Json with root `type = "json"` + #[serde(rename = "json")] + Json(JsonDataMessage), + + /// An error frame, root `type = "error"`. e.g. when the image rate limit / + /// quota is exhausted. + #[serde(rename = "error")] + Error(ErrorMessage), + + /// Captures any other JSON messages. + #[serde(untagged)] + Unknown(serde_json::Value), + //Unknown(String), +} + +/// An error the server sends over the socket instead of generating. +/// +/// e.g. rate limiting: +/// `{"type":"error","err_code":"rate_limit_exceeded","err_msg":"Image rate limit exceeded","request_id":"..."}` +#[derive(Deserialize, Clone, Debug)] +pub struct ErrorMessage { + /// Machine-readable code, e.g. "rate_limit_exceeded". + pub err_code: Option, + + /// Human-readable message, e.g. "Image rate limit exceeded". + pub err_msg: Option, + + /// UUID of the request this error is a response to. + pub request_id: Option, +} + +/// The `err_code` on an [`ErrorMessage`] when the account's image quota / rate +/// limit is exhausted. +pub const ERR_CODE_RATE_LIMIT_EXCEEDED: &str = "rate_limit_exceeded"; + +/// Images with a binary blob and URLs. +/// We may receive several of these for a single prompt. +#[derive(Deserialize, Clone, Debug)] +pub struct ImageDataMessage { + /// UUID. + pub id: Option, + + /// UUID. + pub job_id: Option, + + /// UUID. + pub request_id: Option, + + /// Eg. "0", "50", "100" + pub percentage_complete: Option, + + pub prompt: Option, + + /// The enriched prompt + pub full_prompt: Option, + + /// Base64 encoded image blob. + pub blob: Option, + + /// URL to the image. + pub url: Option, + + /// NSFW flag + pub r_rated: Option, + + /// Name of the model used to generate the image + /// eg. "imagine_h_1" + pub model_name: Option, +} + +#[derive(Deserialize, Clone, Debug)] +pub struct JsonDataMessage { + /// UUID. + pub job_id: Option, + + /// UUID. + pub request_id: Option, + + /// Eg. "0", "50", "100" + pub percentage_complete: Option, + + pub prompt: Option, + pub full_prompt: Option, + + /// NSFW flag + pub r_rated: Option, + + /// UUID. + /// NB: This is observed to be nullable. + pub image_id: Option, +} + +impl WebsocketServerMessage { + pub fn from_json_str(json_str: &str) -> Result { + Ok(serde_json::from_str(json_str) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, json_str.to_string()))?) + } +} + +#[cfg(test)] +mod tests { + use crate::endpoint_bindings::generate_image_websocket::messages::websocket_server_message::{ERR_CODE_RATE_LIMIT_EXCEEDED, WebsocketServerMessage}; + + fn json_path(file_name: &str) -> String { + // NB: Cargo runs tests with the crate root as the working directory. + format!("test_data/websocket_messages/{}", file_name) + } + + #[test] + fn parses_real_image_complete_frame() -> anyhow::Result<()> { + let data = std::fs::read_to_string(json_path("real_image_complete.json"))?; + match WebsocketServerMessage::from_json_str(&data)? { + WebsocketServerMessage::Image(image) => { + assert_eq!(image.percentage_complete, Some(100.0)); + assert_eq!(image.request_id.as_deref(), Some("ab3fa8e9-92ed-4f1b-a350-7a897e264d54")); + assert!(image.url.as_deref().unwrap().starts_with("https://imagine-public.x.ai/")); + assert_eq!(image.prompt.as_deref(), Some("A dead tree stump in the middle of a forest meadow")); + } + other => panic!("Expected Image message, got {:?}", other), + } + Ok(()) + } + + #[test] + fn parses_real_rate_limit_error_frame() -> anyhow::Result<()> { + let data = std::fs::read_to_string(json_path("real_rate_limit_error.json"))?; + match WebsocketServerMessage::from_json_str(&data)? { + WebsocketServerMessage::Error(error) => { + assert_eq!(error.err_code.as_deref(), Some(ERR_CODE_RATE_LIMIT_EXCEEDED)); + assert_eq!(error.err_msg.as_deref(), Some("Image rate limit exceeded")); + assert!(error.request_id.is_some()); + } + other => panic!("Expected Error message, got {:?}", other), + } + Ok(()) + } + + #[test] + fn real_session_notice_frame_is_unknown() -> anyhow::Result<()> { + // The `type: "session"` frame isn't a modeled variant, so it lands in + // `Unknown` (and the listeners skip it). + let data = std::fs::read_to_string(json_path("real_session_notice.json"))?; + match WebsocketServerMessage::from_json_str(&data)? { + WebsocketServerMessage::Unknown(value) => { + assert_eq!(value["type"], "session"); + assert!(value["conversation_id"].is_string()); + } + other => panic!("Expected Unknown message, got {:?}", other), + } + Ok(()) + } + + #[test] + fn test_image_complete() -> anyhow::Result<()> { + let path = json_path("create_image_complete_response.json"); + let data = std::fs::read_to_string(path)?; + //let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Image(image_data) => { + assert_eq!(image_data.percentage_complete, Some(50.0)); + assert!(image_data.url.is_some()); + }, + _ => panic!("Expected ImageData message"), + } + + Ok(()) + } + + #[test] + fn test_image_status_complete() -> anyhow::Result<()> { + let path = json_path("create_image_complete_status_notification.json"); + let data = std::fs::read_to_string(path)?; + //let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Json(image_data) => { + assert_eq!(image_data.percentage_complete, Some(100.0)); + }, + _ => panic!("Expected JsonData message"), + } + + Ok(()) + } + + #[test] + fn test_in_progress() -> anyhow::Result<()> { + let path = json_path("create_image_in_progress_response.json"); + let data = std::fs::read_to_string(path)?; + //let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Json(image_data) => { + assert_eq!(image_data.percentage_complete, Some(0.0)); + }, + _ => panic!("Expected JsonData message"), + } + + Ok(()) + } + + #[test] + fn test_wire() -> anyhow::Result<()> { + let path = json_path("wire.json"); + let data = std::fs::read_to_string(path)?; + //let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Json(_value)=> {}, + _ => panic!("Expected Json message"), + } + + Ok(()) + } + + #[test] + fn test_wire_formatted() -> anyhow::Result<()> { + let path = json_path("wire_formatted.json"); + let data = std::fs::read_to_string(path)?; + //let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Json(_value)=> {}, + _ => panic!("Expected Json message"), + } + + Ok(()) + } + + #[test] + fn test_empty() -> anyhow::Result<()> { + let path = json_path("empty.json"); + let data = std::fs::read_to_string(path)?; + //let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Unknown(_value)=> {}, + _ => panic!("Expected Unknown message"), + } + + Ok(()) + } + + #[test] + fn test_other_type() -> anyhow::Result<()> { + let path = json_path("other_type.json"); + let data = std::fs::read_to_string(path)?; + ///let message: WebsocketServerMessage = serde_json::from_str(&data)?; + let message = WebsocketServerMessage::from_json_str(&data)?; + + match message { + WebsocketServerMessage::Unknown(_value)=> {}, + _ => panic!("Expected Unknown message"), + } + + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/mod.rs new file mode 100644 index 00000000..ebc65997 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_image_websocket/mod.rs @@ -0,0 +1,2 @@ +pub mod grok_generate_image_websocket; +pub mod messages; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_video/generate_video.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_video/generate_video.rs new file mode 100644 index 00000000..af1e5ec5 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_video/generate_video.rs @@ -0,0 +1,819 @@ +//! `POST /rest/app-chat/conversations/new` — generate a video from an input +//! image (image-to-video). Captured 2026-08-23 in +//! `15_generate_video_from_generation.txt` (no prompt / "normal" mode) and +//! `16_generate_video_from_upload.txt` (with prompt / "custom" mode). +//! +//! The response is a stream of newline-delimited JSON: a conversation frame, +//! the echoed user message, then `streamingVideoGenerationResponse` frames +//! whose `progress` climbs 0 → 100. The final (100%) frame carries the +//! `videoUrl` / `assetId` / thumbnail. Reading the body waits for the whole +//! stream, i.e. until generation finishes. + +use crate::client::grok_domain::GrokDomain; +use crate::credentials::grok_cookies::GrokCookies; +use crate::credentials::grok_request_headers::GrokRequestHeaders; +use crate::datatypes::api::file_id::FileId; +use crate::error::categorize_grok_http_error::categorize_grok_http_error; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::prompt_flags::{GenerationMode, PromptFlags}; +use crate::utils::create_firefox_client::create_firefox_client; +use log::{error, info}; +use serde::{Deserialize, Serialize}; +use std::time::Duration; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, CONTENT_TYPE, COOKIE, ORIGIN, REFERER, USER_AGENT}; + +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; + +const NEW_CONVERSATION_PATH: &str = "/rest/app-chat/conversations/new"; + +/// The imagine video model. +const VIDEO_MODEL_NAME: &str = "imagine-video-gen"; + +const CONVERSATION_KIND_IMAGINE: &str = "CONVERSATION_KIND_IMAGINE"; + +/// Aspect ratios for generated video. Only `3:2` is confirmed from captures; +/// the others mirror the image aspect ratios and are included for parity. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum VideoAspectRatio { + /// 1:1 + Square, + /// 2:3 + TallTwoByThree, + /// 3:2 + WideThreeByTwo, + /// 16:9 + WideSixteenByNine, + /// 9:16 + TallNineBySixteen, +} + +impl VideoAspectRatio { + pub fn as_grok_str(self) -> &'static str { + match self { + Self::Square => "1:1", + Self::TallTwoByThree => "2:3", + Self::WideThreeByTwo => "3:2", + Self::WideSixteenByNine => "16:9", + Self::TallNineBySixteen => "9:16", + } + } +} + +/// Output resolution for generated video. `1080p` may be gated to certain +/// plans; the live `full_hd_no_audio_ten_seconds` test probes whether this +/// account can use it. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum VideoResolution { + /// 480p + Sd480p, + /// 720p + Hd720p, + /// 1080p (may require a higher-tier plan) + FullHd1080p, +} + +impl VideoResolution { + pub fn as_grok_str(self) -> &'static str { + match self { + Self::Sd480p => "480p", + Self::Hd720p => "720p", + Self::FullHd1080p => "1080p", + } + } +} + +/// Length of the generated video. Grok offers a fixed set of durations. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum VideoDuration { + /// 6 seconds + SixSeconds, + /// 10 seconds + TenSeconds, + /// 15 seconds + FifteenSeconds, +} + +impl VideoDuration { + pub fn as_seconds(self) -> u32 { + match self { + Self::SixSeconds => 6, + Self::TenSeconds => 10, + Self::FifteenSeconds => 15, + } + } +} + +/// What the video is generated from. +pub enum VideoSource<'a> { + /// Text-to-video: generate from a prompt alone (no input image). + Text { prompt: &'a str }, + /// Image-to-video: animate an input image asset (a Grok-generated image or + /// an uploaded, untrusted one — the wire shape is identical). An optional + /// prompt guides the motion. + Image { input_asset_id: &'a str, prompt: Option<&'a str> }, +} + +pub struct GenerateVideoRequest<'a> { + pub source: VideoSource<'a>, + pub aspect_ratio: VideoAspectRatio, + pub resolution: VideoResolution, + pub duration: VideoDuration, + + /// Whether the video has generated audio. `false` sends `skipAudio: true`. + pub enable_audio: bool, + + /// Optional `--` prompt flags (e.g. `--mode`). When `mode` is unset, the + /// binding picks the source's default (`custom` for a prompt, `normal` for a + /// bare image-to-video). See [`PromptFlags`]. + pub flags: PromptFlags, +} + +pub struct GenerateVideoArgs<'a> { + pub request: GenerateVideoRequest<'a>, + pub credentials: &'a GrokCookies, + /// Optional captured statsig/tracing headers (see [`GrokRequestHeaders`]). + pub request_headers: Option<&'a GrokRequestHeaders>, + pub domain_override: Option<&'a GrokDomain>, + pub request_timeout: Option, +} + +/// The result of a completed generation stream. +#[derive(Clone, Debug, Default)] +pub struct GenerateVideoResponse { + pub conversation_id: Option, + /// Available as soon as generation starts. + pub video_id: Option, + /// Bucket path of the finished video (present once progress reaches 100). + pub video_url: Option, + /// Bucket path of the preview image. + pub thumbnail_url: Option, + pub asset_id: Option, + pub width: Option, + pub height: Option, + /// Highest progress seen in the stream (100 when finished). + pub progress: Option, +} + +/// Send the request and wait for the streamed generation to finish, returning +/// the completed [`GenerateVideoResponse`]. +pub async fn generate_video(args: GenerateVideoArgs<'_>) -> Result { + let domain = args.domain_override.unwrap_or(&GrokDomain::DefaultDomain); + let client = create_firefox_client()?; + + let mut request_builder = client.post(request_url(domain)) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(CONTENT_TYPE, "application/json") + .header(ORIGIN, "https://grok.com") + .header(REFERER, "https://grok.com/imagine") + .header(COOKIE, args.credentials.to_string()) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin"); + + if let Some(headers) = args.request_headers { + request_builder = headers.apply(request_builder); + } + + if let Some(timeout) = args.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let wire = GenerateVideoWireRequest::from_request(&args.request); + + let http_request = request_builder.json(&wire) + .build() + .map_err(|err| { + error!("Error building generate_video request: {:?}", err); + GrokClientError::WreqClientError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error sending generate_video request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + info!("generate_video enqueue status: {}", status.as_u16()); + + // Reading the body waits for the whole stream, i.e. until generation is done. + let body = response.text() + .await + .map_err(|err| { + error!("Error reading generate_video response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + if !status.is_success() { + error!("generate_video returned an error (code {}): {:?}", status.as_u16(), body); + return Err(categorize_grok_http_error(status, Some(&body))); + } + + Ok(parse_generate_video_stream(&body)) +} + +fn request_url(domain: &GrokDomain) -> String { + format!("{}{}", domain.get_domain(), NEW_CONVERSATION_PATH) +} + +/// Parse the newline-delimited JSON stream into a [`GenerateVideoResponse`]. +/// Unparseable lines (e.g. a truncated final chunk) are skipped. +pub fn parse_generate_video_stream(body: &str) -> GenerateVideoResponse { + let mut response = GenerateVideoResponse::default(); + + for line in body.lines() { + let line = line.trim(); + if line.is_empty() { + continue; + } + + let Ok(frame) = serde_json::from_str::(line) else { + continue; + }; + let Some(result) = frame.result else { + continue; + }; + + if let Some(conversation) = result.conversation { + if conversation.conversation_id.is_some() { + response.conversation_id = conversation.conversation_id; + } + } + + if let Some(video) = result.response.and_then(|r| r.streaming_video) { + if video.video_id.is_some() { + response.video_id = video.video_id.map(FileId); + } + if video.progress.is_some() { + response.progress = video.progress; + } + // The 100% frame carries the finished-video fields. + if video.video_url.is_some() { + response.video_url = video.video_url; + response.asset_id = video.asset_id; + response.thumbnail_url = video.thumbnail_url; + response.width = video.width; + response.height = video.height; + } + } + } + + response +} + +// ----- Wire request ----- + +/// Field order mirrors the web app's wire payload (observed 2026-08-23). +#[derive(Serialize)] +struct GenerateVideoWireRequest { + #[serde(rename = "modelName")] + model_name: &'static str, + message: String, + #[serde(rename = "enableImageStreaming")] + enable_image_streaming: bool, + #[serde(rename = "enableSideBySide")] + enable_side_by_side: bool, + #[serde(rename = "sendFinalMetadata")] + send_final_metadata: bool, + #[serde(rename = "responseMetadata")] + response_metadata: ResponseMetadata, + #[serde(rename = "mediaGenInput")] + media_gen_input: MediaGenInput, + kind: &'static str, +} + +#[derive(Serialize)] +struct ResponseMetadata { + experiments: Vec, + #[serde(rename = "modelConfigOverride")] + model_config_override: ModelConfigOverride, +} + +#[derive(Serialize)] +struct ModelConfigOverride { + #[serde(rename = "modelMap")] + model_map: ModelMap, +} + +/// Serializes to an empty object `{}`. +#[derive(Serialize)] +struct ModelMap {} + +#[derive(Serialize)] +struct MediaGenInput { + #[serde(rename = "imageToVideo", skip_serializing_if = "Option::is_none")] + image_to_video: Option, + #[serde(rename = "textToVideo", skip_serializing_if = "Option::is_none")] + text_to_video: Option, +} + +#[derive(Serialize)] +struct ImageToVideo { + #[serde(rename = "prompt", skip_serializing_if = "Option::is_none")] + prompt: Option, + #[serde(rename = "inputAssets")] + input_assets: Vec, + #[serde(rename = "aspectRatio")] + aspect_ratio: &'static str, + duration: u32, + #[serde(rename = "resolutionName")] + resolution_name: &'static str, + mode: &'static str, + // Present only when audio is off; audio-on requests omit it (matching the + // web app / captured requests). + #[serde(rename = "skipAudio", skip_serializing_if = "is_false")] + skip_audio: bool, +} + +#[derive(Serialize)] +struct TextToVideo { + prompt: String, + #[serde(rename = "aspectRatio")] + aspect_ratio: &'static str, + duration: u32, + #[serde(rename = "resolutionName")] + resolution_name: &'static str, + #[serde(rename = "skipAudio", skip_serializing_if = "is_false")] + skip_audio: bool, +} + +fn is_false(value: &bool) -> bool { + !*value +} + +impl GenerateVideoWireRequest { + fn from_request(request: &GenerateVideoRequest) -> Self { + let aspect_ratio = request.aspect_ratio.as_grok_str(); + let resolution_name = request.resolution.as_grok_str(); + let duration = request.duration.as_seconds(); + let skip_audio = !request.enable_audio; + + // The base prompt and default `--mode` come from the source (custom for a + // prompt, normal for a bare image-to-video); a caller-supplied `flags.mode` + // overrides it. The `message` is the prompt with all flags applied. + let (base_prompt, default_mode): (&str, GenerationMode) = match &request.source { + VideoSource::Text { prompt } => (prompt, GenerationMode::Custom), + VideoSource::Image { prompt: Some(prompt), .. } => (prompt, GenerationMode::Custom), + VideoSource::Image { prompt: None, .. } => ("", GenerationMode::Normal), + }; + let mode = request.flags.mode.unwrap_or(default_mode); + + let mut flags = request.flags.clone(); + flags.mode = Some(mode); + let message = flags.apply_to(base_prompt); + + let media_gen_input = match &request.source { + VideoSource::Text { prompt } => MediaGenInput { + image_to_video: None, + text_to_video: Some(TextToVideo { + prompt: prompt.to_string(), + aspect_ratio, + duration, + resolution_name, + skip_audio, + }), + }, + VideoSource::Image { input_asset_id, prompt } => MediaGenInput { + image_to_video: Some(ImageToVideo { + prompt: prompt.map(str::to_string), + input_assets: vec![input_asset_id.to_string()], + aspect_ratio, + duration, + resolution_name, + mode: mode.as_flag_value(), + skip_audio, + }), + text_to_video: None, + }, + }; + + Self { + model_name: VIDEO_MODEL_NAME, + message, + enable_image_streaming: true, + enable_side_by_side: true, + send_final_metadata: true, + response_metadata: ResponseMetadata { + experiments: Vec::new(), + model_config_override: ModelConfigOverride { model_map: ModelMap {} }, + }, + media_gen_input, + kind: CONVERSATION_KIND_IMAGINE, + } + } +} + +// ----- Wire response (streamed frames) ----- + +#[derive(Deserialize)] +struct StreamFrame { + result: Option, +} + +#[derive(Deserialize)] +struct StreamResult { + conversation: Option, + response: Option, +} + +#[derive(Deserialize)] +struct StreamConversation { + #[serde(rename = "conversationId")] + conversation_id: Option, +} + +#[derive(Deserialize)] +struct StreamResponse { + #[serde(rename = "streamingVideoGenerationResponse")] + streaming_video: Option, +} + +#[derive(Deserialize)] +struct StreamingVideo { + #[serde(rename = "videoId")] + video_id: Option, + progress: Option, + #[serde(rename = "assetId")] + asset_id: Option, + #[serde(rename = "videoUrl")] + video_url: Option, + #[serde(rename = "thumbnailImageUrl")] + thumbnail_url: Option, + width: Option, + height: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + // Cargo runs tests with the crate root as the working directory. + fn load(file_name: &str) -> String { + std::fs::read_to_string(format!("test_data/endpoint_responses/{file_name}")).unwrap() + } + + mod wire_format_tests { + use super::*; + + #[test] + fn url_uses_domain() { + assert_eq!( + request_url(&GrokDomain::DefaultDomain), + "https://grok.com/rest/app-chat/conversations/new", + ); + let custom = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!(request_url(&custom), "http://localhost:8080/rest/app-chat/conversations/new"); + } + + #[test] + fn aspect_ratio_and_resolution_strings() { + assert_eq!(VideoAspectRatio::Square.as_grok_str(), "1:1"); + assert_eq!(VideoAspectRatio::TallTwoByThree.as_grok_str(), "2:3"); + assert_eq!(VideoAspectRatio::WideThreeByTwo.as_grok_str(), "3:2"); + assert_eq!(VideoAspectRatio::WideSixteenByNine.as_grok_str(), "16:9"); + assert_eq!(VideoAspectRatio::TallNineBySixteen.as_grok_str(), "9:16"); + assert_eq!(VideoResolution::Sd480p.as_grok_str(), "480p"); + assert_eq!(VideoResolution::Hd720p.as_grok_str(), "720p"); + assert_eq!(VideoResolution::FullHd1080p.as_grok_str(), "1080p"); + assert_eq!(VideoDuration::SixSeconds.as_seconds(), 6); + assert_eq!(VideoDuration::TenSeconds.as_seconds(), 10); + assert_eq!(VideoDuration::FifteenSeconds.as_seconds(), 15); + } + + // Audio off adds `skipAudio: true`; audio on omits the field entirely. + #[test] + fn skip_audio_only_serialized_when_audio_off() { + let no_audio = GenerateVideoRequest { + source: VideoSource::Text { prompt: "x" }, + aspect_ratio: VideoAspectRatio::WideThreeByTwo, + resolution: VideoResolution::FullHd1080p, + duration: VideoDuration::TenSeconds, + enable_audio: false, + flags: PromptFlags::default(), + }; + let value = serde_json::to_value(GenerateVideoWireRequest::from_request(&no_audio)).unwrap(); + let text_to_video = &value["mediaGenInput"]["textToVideo"]; + assert_eq!(text_to_video["skipAudio"], serde_json::json!(true)); + assert_eq!(text_to_video["duration"], serde_json::json!(10)); + assert_eq!(text_to_video["resolutionName"], serde_json::json!("1080p")); + + let with_audio = GenerateVideoRequest { enable_audio: true, ..no_audio }; + let value = serde_json::to_value(GenerateVideoWireRequest::from_request(&with_audio)).unwrap(); + assert!(value["mediaGenInput"]["textToVideo"].get("skipAudio").is_none()); + } + + // A caller-supplied `--mode` flows into the text-to-video message. + #[test] + fn caller_mode_flag_flows_into_message() { + let request = GenerateVideoRequest { + source: VideoSource::Text { prompt: "woman on beach" }, + aspect_ratio: VideoAspectRatio::WideThreeByTwo, + resolution: VideoResolution::Sd480p, + duration: VideoDuration::SixSeconds, + enable_audio: true, + flags: PromptFlags::with_mode(GenerationMode::Spicy), + }; + let value = serde_json::to_value(GenerateVideoWireRequest::from_request(&request)).unwrap(); + assert_eq!(value["message"], "woman on beach --mode=extremely-spicy-or-crazy"); + } + + // For image-to-video, a caller mode overrides the default in BOTH the + // message text and the structured `mode` field. + #[test] + fn caller_mode_overrides_default_for_image_to_video() { + let request = GenerateVideoRequest { + source: VideoSource::Image { input_asset_id: "abc", prompt: None }, + aspect_ratio: VideoAspectRatio::WideThreeByTwo, + resolution: VideoResolution::Sd480p, + duration: VideoDuration::SixSeconds, + enable_audio: true, + flags: PromptFlags::with_mode(GenerationMode::Spicy), + }; + let value = serde_json::to_value(GenerateVideoWireRequest::from_request(&request)).unwrap(); + assert_eq!(value["message"], "--mode=extremely-spicy-or-crazy"); + assert_eq!(value["mediaGenInput"]["imageToVideo"]["mode"], "extremely-spicy-or-crazy"); + } + + // Real image-to-video "from generation" send frame (no prompt, normal, 480p). + #[test] + fn image_to_video_normal_mode_matches_capture() { + let request = GenerateVideoRequest { + source: VideoSource::Image { + input_asset_id: "11111111-1111-4111-8111-111111111111", + prompt: None, + }, + aspect_ratio: VideoAspectRatio::WideThreeByTwo, + resolution: VideoResolution::Sd480p, + duration: VideoDuration::SixSeconds, + enable_audio: true, + flags: PromptFlags::default(), + }; + let ours = serde_json::to_value(GenerateVideoWireRequest::from_request(&request)).unwrap(); + let captured: serde_json::Value = + serde_json::from_str(&load("generate_video_from_generation_request.json")).unwrap(); + assert_eq!(ours, captured); + } + + // Real image-to-video "from upload" send frame (with prompt, custom, 720p). + #[test] + fn image_to_video_custom_mode_matches_capture() { + let request = GenerateVideoRequest { + source: VideoSource::Image { + input_asset_id: "22222222-2222-4222-8222-222222222222", + prompt: Some("Windmill spins as the camera orbits the night scene. Stars above."), + }, + aspect_ratio: VideoAspectRatio::WideThreeByTwo, + resolution: VideoResolution::Hd720p, + duration: VideoDuration::SixSeconds, + enable_audio: true, + flags: PromptFlags::default(), + }; + let ours = serde_json::to_value(GenerateVideoWireRequest::from_request(&request)).unwrap(); + let captured: serde_json::Value = + serde_json::from_str(&load("generate_video_from_upload_request.json")).unwrap(); + assert_eq!(ours, captured); + } + + // Real text-to-video send frame (prompt only, 2:3, 480p) — capture 18. + #[test] + fn text_to_video_matches_capture() { + let request = GenerateVideoRequest { + source: VideoSource::Text { prompt: "An asteroid hits the city." }, + aspect_ratio: VideoAspectRatio::TallTwoByThree, + resolution: VideoResolution::Sd480p, + duration: VideoDuration::SixSeconds, + enable_audio: true, + flags: PromptFlags::default(), + }; + let ours = serde_json::to_value(GenerateVideoWireRequest::from_request(&request)).unwrap(); + let captured: serde_json::Value = + serde_json::from_str(&load("generate_video_from_text_request.json")).unwrap(); + assert_eq!(ours, captured); + } + } + + mod response_parsing_tests { + use super::*; + + #[test] + fn parses_real_streamed_response() { + let response = parse_generate_video_stream(&load("generate_video_response.txt")); + + assert_eq!( + response.conversation_id.as_deref(), + Some("8b592ec5-b3ec-4cb4-b1f3-ddfd87b20625"), + ); + assert_eq!( + response.video_id.as_ref().map(|id| id.0.as_str()), + Some("1622a562-971d-479b-b4be-44c96f3cd813"), + ); + assert_eq!(response.progress, Some(100)); + assert!(response.video_url.as_deref().unwrap().ends_with("generated_video.mp4")); + assert_eq!( + response.asset_id.as_deref(), + Some("1622a562-971d-479b-b4be-44c96f3cd813"), + ); + assert!(response.thumbnail_url.as_deref().unwrap().ends_with("preview_image.jpg")); + assert_eq!(response.width, Some(832)); + assert_eq!(response.height, Some(352)); + } + + #[test] + fn truncated_lines_are_skipped() { + // A conversation frame plus a garbage/truncated line. + let body = "{\"result\":{\"conversation\":{\"conversationId\":\"abc\"}}}\n{\"result\":{\"resp"; + let response = parse_generate_video_stream(body); + assert_eq!(response.conversation_id.as_deref(), Some("abc")); + assert!(response.video_id.is_none()); + } + } + + mod real_wire_tests { + use super::*; + use crate::endpoint_bindings::list_assets::list_assets::{ListAssetsArgs, ListAssetsRequest}; + use crate::endpoint_bindings::upload_file::grok_upload_file::{grok_upload_file, GrokUploadFileArgs, GrokUploadFileRequest, PathOrFile}; + use crate::error::grok_specific_api_error::GrokSpecificApiError; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::{info, LevelFilter}; + use std::path::Path; + + const TEST_IMAGE_PATH: &str = "test_data/images/test_upload.png"; + const VIDEO_TIMEOUT: Duration = Duration::from_secs(180); + + /// Headers carrying a real, browser-minted statsig for this endpoint. + /// + /// Grok rejects headlessly-computed signatures, so these tests need one + /// harvested from a real browser (see the `harvest_statsig` binary / + /// `grok_consumer_statsig`). Pass it via `GROK_STATSIG=`; it is + /// time-bound, so harvest it right before running. The fallback is a stale + /// placeholder that will 403 with a clear message. + fn captured_statsig_headers() -> GrokRequestHeaders { + let statsig = std::env::var("GROK_STATSIG").unwrap_or_else(|_| + "PASTE_A_FRESH_x-statsig-id_OR_SET_GROK_STATSIG".to_string()); + GrokRequestHeaders { + statsig_id: Some(statsig), + ..Default::default() + } + } + + /// Generate a video from `source` at the given resolution/duration/audio and + /// assert a finished video URL comes back. A statsig rejection surfaces as + /// [`GrokSpecificApiError::StatsigSignatureRejected`]. + async fn generate_and_assert( + source: VideoSource<'_>, + resolution: VideoResolution, + duration: VideoDuration, + enable_audio: bool, + headers: &GrokRequestHeaders, + ) -> AnyhowResult<()> { + let secrets = load_grok_test_secrets()?; + + let result = generate_video(GenerateVideoArgs { + request: GenerateVideoRequest { + source, + aspect_ratio: VideoAspectRatio::TallTwoByThree, + resolution, + duration, + enable_audio, + flags: PromptFlags::default(), + }, + credentials: &secrets.cookies, + request_headers: Some(headers), + domain_override: None, + request_timeout: Some(VIDEO_TIMEOUT), + }).await; + + match result { + Ok(response) => { + info!("generate_video response: {:?}", response); + assert_eq!(response.progress, Some(100), "video did not finish"); + assert!(response.video_url.is_some(), "expected a finished video url"); + Ok(()) + } + Err(GrokError::ApiSpecific(GrokSpecificApiError::StatsigSignatureRejected { status_code, body })) => { + panic!("x-statsig-id rejected (HTTP {status_code}). Body: {body}"); + } + Err(err) => Err(err.into()), + } + } + + // Way 1: text-to-video (from a text prompt alone). Uses a browser-harvested + // statsig (set `GROK_STATSIG`); this is the isolation test that a fresh + // signature drives the whole video request end-to-end. + #[tokio::test] + #[ignore] // Hits the real website; spends video quota; needs a fresh GROK_STATSIG. + async fn generate_video_from_text_prompt() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + generate_and_assert( + VideoSource::Text { prompt: "a lone lighthouse on a cliff at dusk, the light beam sweeps across the water" }, + VideoResolution::Sd480p, + VideoDuration::SixSeconds, + true, + &captured_statsig_headers(), + ).await + } + + // 1080p, audio off, 10 seconds — exercises the new resolution/duration/audio + // controls end-to-end. 1080p is plan-gated; on a lower tier the server + // returns a concrete `VideoResolutionNotAllowed` (verified here) instead of + // a silent failure. A finished video is also accepted (higher-tier plans). + #[tokio::test] + #[ignore] // Hits the real website; spends video quota; needs a fresh GROK_STATSIG. + async fn full_hd_no_audio_ten_seconds() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + let headers = captured_statsig_headers(); + + let result = generate_video(GenerateVideoArgs { + request: GenerateVideoRequest { + source: VideoSource::Text { prompt: "a red kite flying over a green field" }, + aspect_ratio: VideoAspectRatio::WideThreeByTwo, + resolution: VideoResolution::FullHd1080p, + duration: VideoDuration::TenSeconds, + enable_audio: false, + flags: PromptFlags::default(), + }, + credentials: &secrets.cookies, + request_headers: Some(&headers), + domain_override: None, + request_timeout: Some(VIDEO_TIMEOUT), + }).await; + + match result { + Ok(response) => { + info!("1080p video finished (plan allows it): {:?}", response); + assert_eq!(response.progress, Some(100), "video did not finish"); + assert!(response.video_url.is_some(), "expected a finished video url"); + Ok(()) + } + Err(GrokError::ApiSpecific(GrokSpecificApiError::VideoResolutionNotAllowed { status_code, body })) => { + info!("1080p correctly reported as plan-gated (HTTP {status_code}): {body}"); + Ok(()) + } + Err(GrokError::ApiSpecific(GrokSpecificApiError::StatsigSignatureRejected { status_code, body })) => { + panic!("x-statsig-id rejected (HTTP {status_code}) — harvest a fresh GROK_STATSIG. Body: {body}"); + } + Err(err) => Err(err.into()), + } + } + + // Way 2: from an existing generated image (fetched from the asset list). + #[tokio::test] + #[ignore] // Hits the real website; spends video quota. + async fn generate_video_from_generated_image() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let assets = ListAssetsArgs { + request: ListAssetsRequest { page_size: Some(20) }, + credentials: &secrets.cookies, + domain_override: None, + request_headers: Some(&secrets.headers), + request_timeout: None, + }.send().await?; + + let image = assets.assets.iter() + .find(|a| a.mime_type.as_deref() == Some("image/jpeg")) + .expect("expected at least one generated image asset"); + + generate_and_assert( + VideoSource::Image { input_asset_id: &image.asset_id, prompt: None }, + VideoResolution::Sd480p, + VideoDuration::SixSeconds, + true, + &captured_statsig_headers(), + ).await + } + + // Way 3: from an uploaded (untrusted) image. + #[tokio::test] + #[ignore] // Hits the real website; spends video quota. + async fn generate_video_from_uploaded_image() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let upload = grok_upload_file(GrokUploadFileArgs { + request: GrokUploadFileRequest { file: PathOrFile::Path(Path::new(TEST_IMAGE_PATH)) }, + cookie: secrets.cookies.as_str(), + domain_override: None, + request_timeout: Some(Duration::from_secs(30)), + }).await?; + let asset_id = upload.file_id.expect("upload should yield a file id").0; + + generate_and_assert( + VideoSource::Image { input_asset_id: &asset_id, prompt: Some("slow cinematic zoom") }, + VideoResolution::Sd480p, + VideoDuration::SixSeconds, + true, + &captured_statsig_headers(), + ).await + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_video/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_video/mod.rs new file mode 100644 index 00000000..2492e000 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/generate_video/mod.rs @@ -0,0 +1 @@ +pub mod generate_video; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_assets/list_assets.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_assets/list_assets.rs new file mode 100644 index 00000000..268f816c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_assets/list_assets.rs @@ -0,0 +1,358 @@ +//! `GET /rest/assets` — list the user's generated imagine assets (newest +//! first). Captured in +//! `external/requests/sites/grok.com/2026-08-23-imagine/11_list_assets.txt`. + +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::client::grok_domain::GrokDomain; +use crate::credentials::grok_cookies::GrokCookies; +use crate::credentials::grok_request_headers::GrokRequestHeaders; +use crate::error::categorize_grok_http_error::categorize_grok_http_error; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::utils::create_firefox_client::create_firefox_client; +use log::error; +use serde::Deserialize; +use std::collections::HashMap; +use std::time::Duration; +use wreq::StatusCode; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, COOKIE, HeaderMap, REFERER, USER_AGENT}; + +const LIST_ASSETS_PATH: &str = "/rest/assets"; + +/// Page size used when the request doesn't specify one (the website's own). +const DEFAULT_PAGE_SIZE: u32 = 40; + +/// Fixed query parameters observed in the capture. +const ORDER_BY: &str = "ORDER_BY_CREATE_TIME"; +const WORKSPACE_KIND: &str = "WORKSPACE_KIND_IMAGINE_ALL"; + +#[derive(Clone, Debug, Default)] +pub struct ListAssetsRequest { + /// Number of assets per page. Defaults to 40 (the website's own). + pub page_size: Option, +} + +pub struct ListAssetsArgs<'a> { + pub request: ListAssetsRequest, + pub credentials: &'a GrokCookies, + pub domain_override: Option<&'a GrokDomain>, + /// Optional captured statsig/tracing headers (see [`GrokRequestHeaders`]). + pub request_headers: Option<&'a GrokRequestHeaders>, + pub request_timeout: Option, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct ListAssetsResponse { + pub assets: Vec, +} + +/// One generated (or uploaded) file. Also appears as `latestAssetMetadata` +/// in the imagine conversation listing. +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GrokAsset { + pub asset_id: String, + /// e.g. "image/jpeg", "video/mp4" + pub mime_type: Option, + /// e.g. "image.jpg", "generated_video.mp4" + pub name: Option, + pub size_bytes: Option, + /// RFC 3339, e.g. "2026-08-23T20:01:10.223Z" + pub create_time: Option, + /// Bucket path of the primary file, + /// e.g. `users/{user_id}/generated/{asset_id}/image.jpg`. + pub key: Option, + /// Extra file paths and flags, e.g. "preview-image", "original-image", + /// "thumbhash", "moderated". + #[serde(default)] + pub aux_keys: HashMap, + pub response_id: Option, + pub is_deleted: Option, + pub is_latest: Option, + pub source_conversation_id: Option, + pub width: Option, + pub height: Option, + /// The generation request that produced the asset. Shape varies by mode + /// (`textToImage`, `imageToVideo`, ...), so it stays untyped for now. + pub media_gen_input: Option, +} + +/// The raw HTTP response, before status interpretation or JSON parsing. +/// Exposed by [`ListAssetsArgs::fetch_raw`] so callers (e.g. diagnostic tests) +/// can inspect the status, headers, and body when a request goes wrong. +pub struct RawListAssetsResponse { + pub status: StatusCode, + pub headers: HeaderMap, + pub body: String, +} + +impl ListAssetsArgs<'_> { + pub async fn send(&self) -> Result { + let raw = self.fetch_raw().await?; + + if !raw.status.is_success() { + error!("list_assets returned an error (code {}): {:?}", raw.status.as_u16(), raw.body); + return Err(categorize_grok_http_error(raw.status, Some(&raw.body))); + } + + parse_response(&raw.body) + } + + /// Send the request and return the raw response parts without interpreting + /// the status or parsing the body. + pub async fn fetch_raw(&self) -> Result { + let domain = self.domain_override.unwrap_or(&GrokDomain::DefaultDomain); + let client = create_firefox_client()?; + + let mut request_builder = client.get(request_url(domain, &self.request)) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(REFERER, "https://grok.com/imagine/saved") + .header(COOKIE, self.credentials.to_string()) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin"); + + if let Some(headers) = self.request_headers { + request_builder = headers.apply(request_builder); + } + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let http_request = request_builder + .build() + .map_err(|err| { + error!("Error building list_assets request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error sending list_assets request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + let headers = response.headers().clone(); + + let body = response.text() + .await + .map_err(|err| { + error!("Error reading list_assets response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + Ok(RawListAssetsResponse { status, headers, body }) + } +} + +fn request_url(domain: &GrokDomain, request: &ListAssetsRequest) -> String { + let page_size = request.page_size.unwrap_or(DEFAULT_PAGE_SIZE); + format!( + "{}{}?pageSize={}&orderBy={}&workspaceKind={}", + domain.get_domain(), LIST_ASSETS_PATH, page_size, ORDER_BY, WORKSPACE_KIND, + ) +} + +fn parse_response(body: &str) -> Result { + serde_json::from_str(body) + .map_err(|err| { + GrokGenericApiError::SerdeResponseParseErrorWithBody(err, body.to_string()).into() + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // Cargo runs tests with the crate root as the working directory. + fn load_response(file_name: &str) -> String { + std::fs::read_to_string(format!("test_data/endpoint_responses/{file_name}")).unwrap() + } + + mod wire_format_tests { + use super::*; + + #[test] + fn url_defaults_to_page_size_40() { + let request = ListAssetsRequest { page_size: None }; + assert_eq!( + request_url(&GrokDomain::DefaultDomain, &request), + "https://grok.com/rest/assets?pageSize=40&orderBy=ORDER_BY_CREATE_TIME&workspaceKind=WORKSPACE_KIND_IMAGINE_ALL", + ); + } + + #[test] + fn url_respects_page_size_and_domain_overrides() { + let request = ListAssetsRequest { page_size: Some(7) }; + let domain = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!( + request_url(&domain, &request), + "http://localhost:8080/rest/assets?pageSize=7&orderBy=ORDER_BY_CREATE_TIME&workspaceKind=WORKSPACE_KIND_IMAGINE_ALL", + ); + } + } + + mod response_parsing_tests { + use super::*; + + #[test] + fn parses_real_assets_response() { + let response = parse_response(&load_response("list_assets.json")).unwrap(); + assert_eq!(response.assets.len(), 2); + + let video = &response.assets[0]; + assert_eq!(video.asset_id, "98db6014-be3a-4c92-9aec-91c80123ccac"); + assert_eq!(video.mime_type.as_deref(), Some("video/mp4")); + assert_eq!(video.name.as_deref(), Some("generated_video.mp4")); + assert_eq!(video.size_bytes, Some(5800655)); + assert_eq!(video.width, Some(736)); + assert_eq!(video.height, Some(400)); + assert_eq!(video.is_deleted, Some(false)); + assert_eq!( + video.aux_keys.get("preview-image").map(String::as_str), + Some("users/00000000-0000-4000-8000-000000000000/generated/98db6014-be3a-4c92-9aec-91c80123ccac/preview_image.jpg"), + ); + let video_input = video.media_gen_input.as_ref().unwrap(); + assert_eq!(video_input["imageToVideo"]["duration"], 6); + + let image = &response.assets[1]; + assert_eq!(image.asset_id, "8d0b3727-f040-4b33-abf0-16e7d4364e6c"); + assert_eq!(image.mime_type.as_deref(), Some("image/jpeg")); + assert_eq!( + image.source_conversation_id.as_deref(), + Some("e851b4f1-0605-4a41-b624-d629c2c1638d"), + ); + let image_input = image.media_gen_input.as_ref().unwrap(); + assert_eq!( + image_input["textToImage"]["prompt"], + "A pirate ship in the middle of the forest", + ); + } + + #[test] + fn missing_required_assets_is_an_error() { + // `assets` is required, so an object without it fails to parse. + let result = parse_response("{}"); + assert!(matches!( + result, + Err(GrokError::ApiGeneric(GrokGenericApiError::SerdeResponseParseErrorWithBody(_, _))), + )); + } + } + + mod real_wire_tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_assets() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let page_size: u32 = 5; + let args = ListAssetsArgs { + request: ListAssetsRequest { page_size: Some(page_size) }, + credentials: &secrets.cookies, + domain_override: None, + request_headers: Some(&secrets.headers), + request_timeout: None, + }; + + // Fetch raw so we can print the whole body and spot fields the typed + // response might be dropping. + let raw = args.fetch_raw().await?; + println!("[test] full response body:\n{}", pretty_json(&raw.body)); + assert!(raw.status.is_success(), "expected 2xx, got {}", raw.status); + + let response: ListAssetsResponse = serde_json::from_str(&raw.body)?; + for asset in &response.assets { + println!("[test] asset: {} ({:?})", asset.asset_id, asset.mime_type); + } + + assert_list_assets(&response, page_size); + Ok(()) + } + + // Same request and assertions as above, but WITHOUT the captured + // statsig/tracing headers — just the cookies. Tells us whether those + // headers are actually required. On any failure (non-2xx, parse error, or + // a failed assertion) it dumps the response status, headers, and body. + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_assets_cookies_only() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let page_size = 5; + let args = ListAssetsArgs { + request: ListAssetsRequest { page_size: Some(page_size) }, + credentials: &secrets.cookies, + domain_override: None, + request_headers: None, // cookies only — no statsig / tracing headers + request_timeout: None, + }; + + let raw = args.fetch_raw().await?; + println!("[test] full response body:\n{}", pretty_json(&raw.body)); + + let dump = || { + println!("[test] status: {}", raw.status); + println!("[test] response headers: {:#?}", raw.headers); + println!("[test] response body: {}", raw.body); + }; + + if !raw.status.is_success() { + dump(); + panic!("list_assets (cookies only) expected 2xx, got {}", raw.status); + } + + let response: ListAssetsResponse = match serde_json::from_str(&raw.body) { + Ok(response) => response, + Err(err) => { + dump(); + panic!("list_assets (cookies only) failed to parse body: {err}"); + } + }; + for asset in &response.assets { + println!("[test] asset: {} ({:?})", asset.asset_id, asset.mime_type); + } + + if !list_assets_assertions_pass(&response, page_size) { + dump(); + panic!("list_assets (cookies only) assertions failed"); + } + Ok(()) + } + + /// Pretty-print a JSON body for inspection, falling back to the raw string. + fn pretty_json(body: &str) -> String { + serde_json::from_str::(body) + .and_then(|value| serde_json::to_string_pretty(&value)) + .unwrap_or_else(|_| body.to_string()) + } + + // The account under test has generated media, so expect a non-empty page + // whose entries carry the structural fields. (No PII asserted.) + fn list_assets_assertions_pass(response: &ListAssetsResponse, page_size: u32) -> bool { + !response.assets.is_empty() + && response.assets.len() <= page_size as usize + && response.assets.iter().all(|asset| { + !asset.asset_id.is_empty() && asset.mime_type.is_some() + }) + } + + fn assert_list_assets(response: &ListAssetsResponse, page_size: u32) { + assert!(!response.assets.is_empty(), "expected at least one asset"); + assert!(list_assets_assertions_pass(response, page_size), "asset assertions failed"); + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_assets/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_assets/mod.rs new file mode 100644 index 00000000..4a306dd7 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_assets/mod.rs @@ -0,0 +1 @@ +pub mod list_assets; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_imagine_assets/list_imagine_assets.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_imagine_assets/list_imagine_assets.rs new file mode 100644 index 00000000..1f8b0886 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_imagine_assets/list_imagine_assets.rs @@ -0,0 +1,357 @@ +//! `GET /rest/app-chat/conversations?kind=CONVERSATION_KIND_IMAGINE` — list +//! the user's imagine conversations, each carrying its latest generated +//! asset. Captured in +//! `external/requests/sites/grok.com/2026-08-23-imagine/10_list_imagine_conversations.txt`. + +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::client::grok_domain::GrokDomain; +use crate::credentials::grok_cookies::GrokCookies; +use crate::credentials::grok_request_headers::GrokRequestHeaders; +use crate::endpoint_bindings::list_assets::list_assets::GrokAsset; +use crate::error::categorize_grok_http_error::categorize_grok_http_error; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::utils::create_firefox_client::create_firefox_client; +use log::error; +use serde::Deserialize; +use std::time::Duration; +use wreq::StatusCode; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, COOKIE, HeaderMap, REFERER, USER_AGENT}; + +const LIST_IMAGINE_ASSETS_PATH: &str = "/rest/app-chat/conversations"; + +/// Page size used when the request doesn't specify one (the website's own). +const DEFAULT_PAGE_SIZE: u32 = 40; + +/// Fixed query parameter observed in the capture. +const CONVERSATION_KIND: &str = "CONVERSATION_KIND_IMAGINE"; + +#[derive(Clone, Debug, Default)] +pub struct ListImagineAssetsRequest { + /// Number of conversations per page. Defaults to 40 (the website's own). + pub page_size: Option, +} + +pub struct ListImagineAssetsArgs<'a> { + pub request: ListImagineAssetsRequest, + pub credentials: &'a GrokCookies, + pub domain_override: Option<&'a GrokDomain>, + /// Optional captured statsig/tracing headers (see [`GrokRequestHeaders`]). + pub request_headers: Option<&'a GrokRequestHeaders>, + pub request_timeout: Option, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct ListImagineAssetsResponse { + pub conversations: Vec, +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ImagineConversation { + pub conversation_id: String, + /// Often empty for imagine conversations. + pub title: Option, + pub starred: Option, + /// RFC 3339, e.g. "2026-08-23T20:00:41.151254Z" + pub create_time: Option, + pub modify_time: Option, + /// e.g. "CONVERSATION_KIND_IMAGINE" + pub kind: Option, + /// The conversation's most recent generated asset. + pub latest_asset_metadata: Option, +} + +/// The raw HTTP response, before status interpretation or JSON parsing. +/// Exposed by [`ListImagineAssetsArgs::fetch_raw`] so callers (e.g. diagnostic +/// tests) can inspect the status, headers, and body when a request goes wrong. +pub struct RawListImagineAssetsResponse { + pub status: StatusCode, + pub headers: HeaderMap, + pub body: String, +} + +impl ListImagineAssetsArgs<'_> { + pub async fn send(&self) -> Result { + let raw = self.fetch_raw().await?; + + if !raw.status.is_success() { + error!("list_imagine_assets returned an error (code {}): {:?}", raw.status.as_u16(), raw.body); + return Err(categorize_grok_http_error(raw.status, Some(&raw.body))); + } + + parse_response(&raw.body) + } + + /// Send the request and return the raw response parts without interpreting + /// the status or parsing the body. + pub async fn fetch_raw(&self) -> Result { + let domain = self.domain_override.unwrap_or(&GrokDomain::DefaultDomain); + let client = create_firefox_client()?; + + let mut request_builder = client.get(request_url(domain, &self.request)) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(REFERER, "https://grok.com/imagine/saved") + .header(COOKIE, self.credentials.to_string()) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin"); + + if let Some(headers) = self.request_headers { + request_builder = headers.apply(request_builder); + } + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let http_request = request_builder + .build() + .map_err(|err| { + error!("Error building list_imagine_assets request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error sending list_imagine_assets request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + let headers = response.headers().clone(); + + let body = response.text() + .await + .map_err(|err| { + error!("Error reading list_imagine_assets response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + Ok(RawListImagineAssetsResponse { status, headers, body }) + } +} + +fn request_url(domain: &GrokDomain, request: &ListImagineAssetsRequest) -> String { + let page_size = request.page_size.unwrap_or(DEFAULT_PAGE_SIZE); + format!( + "{}{}?pageSize={}&kind={}", + domain.get_domain(), LIST_IMAGINE_ASSETS_PATH, page_size, CONVERSATION_KIND, + ) +} + +fn parse_response(body: &str) -> Result { + serde_json::from_str(body) + .map_err(|err| { + GrokGenericApiError::SerdeResponseParseErrorWithBody(err, body.to_string()).into() + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // Cargo runs tests with the crate root as the working directory. + fn load_response(file_name: &str) -> String { + std::fs::read_to_string(format!("test_data/endpoint_responses/{file_name}")).unwrap() + } + + mod wire_format_tests { + use super::*; + + #[test] + fn url_defaults_to_page_size_40() { + let request = ListImagineAssetsRequest { page_size: None }; + assert_eq!( + request_url(&GrokDomain::DefaultDomain, &request), + "https://grok.com/rest/app-chat/conversations?pageSize=40&kind=CONVERSATION_KIND_IMAGINE", + ); + } + + #[test] + fn url_respects_page_size_and_domain_overrides() { + let request = ListImagineAssetsRequest { page_size: Some(12) }; + let domain = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!( + request_url(&domain, &request), + "http://localhost:8080/rest/app-chat/conversations?pageSize=12&kind=CONVERSATION_KIND_IMAGINE", + ); + } + } + + mod response_parsing_tests { + use super::*; + + #[test] + fn parses_real_conversations_response() { + let response = parse_response(&load_response("list_imagine_assets.json")).unwrap(); + assert_eq!(response.conversations.len(), 2); + + let video_conversation = &response.conversations[0]; + assert_eq!( + video_conversation.conversation_id, + "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + ); + assert_eq!( + video_conversation.title.as_deref(), + Some("Video Generation with AI"), + ); + assert_eq!(video_conversation.starred, Some(false)); + assert_eq!( + video_conversation.kind.as_deref(), + Some("CONVERSATION_KIND_IMAGINE"), + ); + + let video_asset = video_conversation.latest_asset_metadata.as_ref().unwrap(); + assert_eq!(video_asset.asset_id, "98db6014-be3a-4c92-9aec-91c80123ccac"); + assert_eq!(video_asset.mime_type.as_deref(), Some("video/mp4")); + + let image_conversation = &response.conversations[1]; + assert_eq!(image_conversation.title.as_deref(), Some("")); + let image_asset = image_conversation.latest_asset_metadata.as_ref().unwrap(); + assert_eq!(image_asset.asset_id, "8d0b3727-f040-4b33-abf0-16e7d4364e6c"); + let image_input = image_asset.media_gen_input.as_ref().unwrap(); + assert_eq!( + image_input["textToImage"]["prompt"], + "A pirate ship in the middle of the forest", + ); + } + + #[test] + fn missing_required_conversations_is_an_error() { + // `conversations` is required, so an object without it fails to parse. + let result = parse_response("{}"); + assert!(matches!( + result, + Err(GrokError::ApiGeneric(GrokGenericApiError::SerdeResponseParseErrorWithBody(_, _))), + )); + } + } + + mod real_wire_tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_imagine_conversations() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let page_size: u32 = 5; + let args = ListImagineAssetsArgs { + request: ListImagineAssetsRequest { page_size: Some(page_size) }, + credentials: &secrets.cookies, + domain_override: None, + request_headers: Some(&secrets.headers), + request_timeout: None, + }; + + // Fetch raw so we can print the whole body and spot fields the typed + // response might be dropping. + let raw = args.fetch_raw().await?; + println!("[test] full response body:\n{}", pretty_json(&raw.body)); + assert!(raw.status.is_success(), "expected 2xx, got {}", raw.status); + + let response: ListImagineAssetsResponse = serde_json::from_str(&raw.body)?; + print_conversations(&response); + + assert_list_imagine_assets(&response, page_size); + Ok(()) + } + + // Same request and assertions as above, but WITHOUT the captured + // statsig/tracing headers — just the cookies. Tells us whether those + // headers are actually required. On any failure (non-2xx, parse error, or + // a failed assertion) it dumps the response status, headers, and body. + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_imagine_conversations_cookies_only() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let page_size = 5; + let args = ListImagineAssetsArgs { + request: ListImagineAssetsRequest { page_size: Some(page_size) }, + credentials: &secrets.cookies, + domain_override: None, + request_headers: None, // cookies only — no statsig / tracing headers + request_timeout: None, + }; + + let raw = args.fetch_raw().await?; + println!("[test] full response body:\n{}", pretty_json(&raw.body)); + + let dump = || { + println!("[test] status: {}", raw.status); + println!("[test] response headers: {:#?}", raw.headers); + println!("[test] response body: {}", raw.body); + }; + + if !raw.status.is_success() { + dump(); + panic!("list_imagine_assets (cookies only) expected 2xx, got {}", raw.status); + } + + let response: ListImagineAssetsResponse = match serde_json::from_str(&raw.body) { + Ok(response) => response, + Err(err) => { + dump(); + panic!("list_imagine_assets (cookies only) failed to parse body: {err}"); + } + }; + print_conversations(&response); + + if !list_imagine_assets_assertions_pass(&response, page_size) { + dump(); + panic!("list_imagine_assets (cookies only) assertions failed"); + } + Ok(()) + } + + /// Pretty-print a JSON body for inspection, falling back to the raw string. + fn pretty_json(body: &str) -> String { + serde_json::from_str::(body) + .and_then(|value| serde_json::to_string_pretty(&value)) + .unwrap_or_else(|_| body.to_string()) + } + + fn print_conversations(response: &ListImagineAssetsResponse) { + for conversation in &response.conversations { + println!( + "[test] conversation: {} (latest asset: {:?})", + conversation.conversation_id, + conversation.latest_asset_metadata.as_ref().map(|a| &a.asset_id), + ); + } + } + + // The account under test has imagine conversations; expect a non-empty + // page of the imagine kind. (No PII asserted.) + fn list_imagine_assets_assertions_pass( + response: &ListImagineAssetsResponse, + page_size: u32, + ) -> bool { + !response.conversations.is_empty() + && response.conversations.len() <= page_size as usize + && response.conversations.iter().all(|conversation| { + !conversation.conversation_id.is_empty() + && conversation.kind.as_deref().is_none_or(|kind| kind == "CONVERSATION_KIND_IMAGINE") + }) + } + + fn assert_list_imagine_assets(response: &ListImagineAssetsResponse, page_size: u32) { + assert!(!response.conversations.is_empty(), "expected a conversation"); + assert!( + list_imagine_assets_assertions_pass(response, page_size), + "conversation assertions failed", + ); + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_imagine_assets/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_imagine_assets/mod.rs new file mode 100644 index 00000000..10be131a --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/list_imagine_assets/mod.rs @@ -0,0 +1 @@ +pub mod list_imagine_assets; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/mod.rs new file mode 100644 index 00000000..077ff38d --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/mod.rs @@ -0,0 +1,8 @@ +pub mod generate_image_websocket; +pub mod generate_video; +pub mod list_assets; +pub mod list_imagine_assets; +pub mod old_bindings; +pub mod quota_info; +pub mod session_info; +pub mod upload_file; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/download_video_file.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/download_video_file.rs new file mode 100644 index 00000000..c923a960 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/download_video_file.rs @@ -0,0 +1,125 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::datatypes::api::file_id::FileId; +use crate::datatypes::api::user_id::UserId; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::utils::user_and_file_id_to_video_url::user_and_file_id_to_video_url; +use log::{error, info, warn}; +use std::time::Duration; +use wreq::header::{ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, CACHE_CONTROL, CONNECTION, CONTENT_TYPE, COOKIE, ORIGIN, REFERER, TE, UPGRADE_INSECURE_REQUESTS, USER_AGENT}; +use wreq::Client; +use wreq_util::Emulation; + +pub struct DownloadVideoFileArgs<'a> { + pub cookies: &'a str, + pub user_id: &'a UserId, + pub file_id: &'a FileId, + pub request_timeout: Option, +} + +pub struct VideoFile { + pub bytes: Vec, +} + +pub async fn download_video_file(args: DownloadVideoFileArgs<'_>) -> Result { + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| GrokClientError::WreqClientError(err))?; + + let video_url = user_and_file_id_to_video_url(&args.user_id, &args.file_id, false); + + info!("Video file URL: {}", video_url); + + let mut request_builder = client.get(&video_url) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(ACCEPT_ENCODING, "gzip, deflate, br, zstd") + .header(REFERER, "https://grok.com/") + .header("Sec-GPC", "1") + .header(CONNECTION, "keep-alive") + .header(COOKIE, args.cookies) + .header(UPGRADE_INSECURE_REQUESTS, "1") + .header("sec-fetch-dest", "document") + .header("sec-fetch-mode", "navigate") + .header("sec-fetch-site", "same-site") + .header("sec-fetch-user", "?1") + .header("priority", "u=0, i"); + + + if let Some(timeout) = args.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let response = request_builder.send() + .await + .map_err(|err| GrokGenericApiError::WreqError(err))?; + + let status = response.status(); + + info!("Download video status: {:?}", status); + + let download_bytes = &response.bytes() + .await + .map_err(|err| { + error!("Error reading Grok create media response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + // TODO: Classify errors + if !status.is_success() { + warn!("Not successful liking media (status: {:?})", status); + // error!("Upload file request returned an error (code {}) : {:?}", status.as_u16(), response_body); + // return Err(classify_general_http_status_code_and_body(status, response_body)); + } + + Ok(VideoFile { + bytes: download_bytes.to_vec(), + }) +} + +#[cfg(test)] +mod tests { + use std::fs::File; + use std::io::Write; + use crate::datatypes::api::file_id::FileId; + use crate::recipes::request_client_secrets::{request_client_secrets, RequestClientSecretsArgs}; + use crate::endpoint_bindings::old_bindings::download_video_file::download_video_file::{download_video_file, DownloadVideoFileArgs}; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Client side tests only + async fn test_download() -> AnyhowResult<()> { + //setup_test_logging(LevelFilter::Trace); + + let cookies = load_grok_test_secrets()?.cookies; + + let file_id = FileId("d9b300c6-9562-4e24-a87a-3ede2a53f0bc".to_string()); // Ernest + + let secrets = request_client_secrets(RequestClientSecretsArgs { + cookies: &cookies, + }).await?; + + println!("Sentry Trace: {:?}", secrets.sentry_trace); + println!("Baggage: {:?}", secrets.baggage); + + let download = download_video_file(DownloadVideoFileArgs { + cookies: cookies.as_str(), + user_id: &secrets.user_id, + file_id: &file_id, + request_timeout: None, + }).await?; + + println!("Video byte length: {:?}", download.bytes.len()); + + let mut file = File::create("download_video_file.test.mp4")?; + file.write_all(&download.bytes)?; + + assert_eq!(1, 2); + Ok(()) + } +} \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/grok_download_video.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/grok_download_video.rs new file mode 100644 index 00000000..b4856a66 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/grok_download_video.rs @@ -0,0 +1,168 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::datatypes::api::file_id::FileId; +use crate::datatypes::api::user_id::UserId; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::utils::user_and_file_id_to_video_url::user_and_file_id_to_video_url; +use futures::{StreamExt, TryStreamExt}; +use log::{error, info, warn}; +use std::io::Write; +use std::path::Path; +use std::time::Duration; +use tokio::fs::File; +use tokio::io::AsyncWriteExt; +use wreq::header::{ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, CACHE_CONTROL, CONNECTION, CONTENT_TYPE, COOKIE, ORIGIN, REFERER, TE, UPGRADE_INSECURE_REQUESTS, USER_AGENT}; +use wreq::{Client, Request, Response}; +use wreq_util::Emulation; + +pub struct GrokDownloadVideo<'a> { + pub cookies: &'a str, + pub user_id: &'a UserId, + pub file_id: &'a FileId, + pub request_timeout: Option, +} + +pub struct DownloadedVideoBytes { + pub bytes: Vec, +} + +impl <'a> GrokDownloadVideo<'a> { + + pub async fn download_to_path>(&self, path: P) -> Result<(), GrokError> { + let response = self.send_request().await?; + + let mut stream = response.bytes_stream(); + + let mut file = File::create(&path) + .await + .map_err(|err| GrokClientError::CannotOpenLocalFileForWriting(err))?; + + //let _r = stream.for_each_concurrent(None, |chunk_result| async { + // match chunk_result { + // Ok(chunk) => { + // file; + // //if let Err(e) = file.write_all(&chunk).await { + // // //error!("Error writing to file: {}", e); + // //} + // } + // Err(e) => { + // //error!("Error in stream: {}", e); + // } + // } + //}).await; + + while let Some(chunk) = stream.try_next() + .await + .map_err(|err| GrokGenericApiError::WreqError(err))? + { + file.write_all(&chunk) + .await + .map_err(|err| GrokClientError::CannotOpenLocalFileForWriting(err))? + } + + file.flush().await.unwrap(); + + Ok(()) + } + + pub async fn download_bytes(&self) -> Result { + let response = self.send_request().await?; + + let download_bytes = response.bytes() + .await + .map_err(|err| { + error!("Error reading Grok create media response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + Ok(DownloadedVideoBytes { + bytes: download_bytes.to_vec(), + }) + } + + async fn send_request(&self) -> Result { + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| GrokClientError::WreqClientError(err))?; + + let video_url = user_and_file_id_to_video_url(&self.user_id, &self.file_id, false); + + info!("Video file URL: {}", video_url); + + let mut request_builder = client.get(&video_url) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(ACCEPT_ENCODING, "gzip, deflate, br, zstd") + .header(REFERER, "https://grok.com/") + .header("Sec-GPC", "1") + .header(CONNECTION, "keep-alive") + .header(COOKIE, self.cookies.to_string()) + .header(UPGRADE_INSECURE_REQUESTS, "1") + .header("sec-fetch-dest", "document") + .header("sec-fetch-mode", "navigate") + .header("sec-fetch-site", "same-site") + .header("sec-fetch-user", "?1") + .header("priority", "u=0, i"); + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let response = request_builder.send() + .await + .map_err(|err| GrokGenericApiError::WreqError(err))?; + + let status = response.status(); + + // TODO: Classify errors + if !status.is_success() { + warn!("Not successful liking media (status: {:?})", status); + // error!("Upload file request returned an error (code {}) : {:?}", status.as_u16(), response_body); + // return Err(classify_general_http_status_code_and_body(status, response_body)); + } + + Ok(response) + } +} + +#[cfg(test)] +mod tests { + use crate::datatypes::api::file_id::FileId; + use crate::recipes::request_client_secrets::{request_client_secrets, RequestClientSecretsArgs}; + use crate::endpoint_bindings::old_bindings::download_video_file::download_video_file::{download_video_file, DownloadVideoFileArgs}; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Client side tests only + async fn test_download() -> AnyhowResult<()> { + //setup_test_logging(LevelFilter::Trace); + + let cookies = load_grok_test_secrets()?.cookies; + + let file_id = FileId("d9b300c6-9562-4e24-a87a-3ede2a53f0bc".to_string()); // Ernest + + let secrets = request_client_secrets(RequestClientSecretsArgs { + cookies: &cookies, + }).await?; + + println!("Sentry Trace: {:?}", secrets.sentry_trace); + println!("Baggage: {:?}", secrets.baggage); + + // TDOO: This implementation is untested. + //let download = download_video_file(DownloadVideoFileArgs { + // cookies: cookies.as_str(), + // user_id: &secrets.user_id, + // file_id: &file_id, + // request_timeout: None, + //}).await?; + + //println!("Video byte length: {:?}", download.bytes.len()); + + assert_eq!(1, 2); + Ok(()) + } +} \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/mod.rs new file mode 100644 index 00000000..bb83484e --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/download_video_file/mod.rs @@ -0,0 +1,2 @@ +pub mod download_video_file; +pub mod grok_download_video; \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/get_index_page.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/get_index_page.rs new file mode 100644 index 00000000..9a06af9c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/get_index_page.rs @@ -0,0 +1,102 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use log::info; +use std::ops::Deref; +use wreq::header::{ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, CACHE_CONTROL, CONNECTION, CONTENT_TYPE, COOKIE, ORIGIN, PRAGMA, REFERER, TE, UPGRADE, USER_AGENT}; +use wreq::ws::message::Message; +use wreq::Client; +use wreq_util::Emulation; + +const INDEX_URL: &str = "https://grok.com"; + +pub struct GetIndexPageArgs<'a> { + pub cookie: &'a str, +} + +pub struct IndexPage { + pub body: String, +} + +pub async fn get_index(args: GetIndexPageArgs<'_>) -> Result { + info!("Building client..."); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| GrokClientError::WreqClientError(err))?; + + info!("Configuring client..."); + + let builder = client.get(INDEX_URL) + .header("User-Agent", FIREFOX_143_MAC_USER_AGENT) + .header("Accept", "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Accept-Language", "en-US,en;q=0.5") + .header("Connection", "keep-alive") + .header("Sec-Fetch-Dest", "document") + .header("Sec-Fetch-Mode", "navigate") + .header("Sec-Fetch-Site", "none") + .header("Sec-Fetch-User", "?1") + .header("Sec-GPC", "1") + .header("priority", "u=0, i") + .header("Pragma", "no-cache") + .header("Cache-Control", "no-cache") + .header("Cookie", args.cookie.to_string()) + .header("TE", "trailers"); + + info!("Sending request for index page..."); + + let response = builder.send() + .await + .map_err(|err| GrokClientError::WreqClientError(err))?; + + let status = response.status(); + println!("Status: {}", status); + + //let body = response.text() + // .await + // .map_err(|err| GrokGenericApiError::WreqError(err))?; + + // stblid=08552693-0377-49d3-b17f-8e4c68b153ec + for cookie in response.cookies() { + println!("Cookie: {}={}", cookie.name(), cookie.value()); + } + + for (name, value) in response.headers() { + println!("Header: {}: {}", name.as_str(), value.to_str().unwrap()); + } + + let body = response.text() + .await + .map_err(|err| GrokClientError::WreqClientError(err))?; + + Ok(IndexPage { + body, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // manually test + async fn test() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let cookie = load_grok_test_secrets()?.cookies.to_string(); + let args = GetIndexPageArgs { + cookie: &cookie, + }; + let result = get_index(args).await?; + println!("Body:\n\n"); + println!("{}", result.body); + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/mod.rs new file mode 100644 index 00000000..e113fe35 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/mod.rs @@ -0,0 +1,2 @@ +pub mod get_index_page; +pub mod parsers; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/mod.rs new file mode 100644 index 00000000..cfc1ffa2 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/mod.rs @@ -0,0 +1,4 @@ +pub mod parse_index_baggage; +pub mod parse_index_sentry_trace; +pub mod parse_index_user_email; +pub mod parse_index_user_id; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_baggage.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_baggage.rs new file mode 100644 index 00000000..90c749e2 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_baggage.rs @@ -0,0 +1,44 @@ +use once_cell::sync::Lazy; +use scraper::{Html, Selector}; +use crate::datatypes::api::baggage::Baggage; +// + +static BAGGAGE_SELECTOR : Lazy = Lazy::new(|| { + Selector::parse("meta[name=baggage]") + .expect("HTML selector should parse") +}); + + +pub fn parse_index_baggage(html: &str) -> Option { + let document = Html::parse_document(html); + let selected = document.select(&BAGGAGE_SELECTOR); + let mut values = selected + .filter_map(|node| node.attr("content")) + .map(|s| s.to_string()) + .collect::>(); + values.pop().map(|b| Baggage(b)) +} + +#[cfg(test)] +mod tests { + use crate::endpoint_bindings::old_bindings::index_page::get_index_page::{get_index, GetIndexPageArgs}; + use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_baggage::parse_index_baggage; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Manual test invocation + async fn test() -> AnyhowResult<()> { + let cookie = load_grok_test_secrets()?.cookies.to_string(); + let index = get_index(GetIndexPageArgs { + cookie: &cookie, + }).await?; + + let baggage = parse_index_baggage(&index.body); + + println!("Baggage: {:?}", baggage); + + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_sentry_trace.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_sentry_trace.rs new file mode 100644 index 00000000..18b5ad04 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_sentry_trace.rs @@ -0,0 +1,85 @@ +use crate::datatypes::api::sentry_trace::SentryTrace; +use once_cell::sync::Lazy; +use scraper::{Html, Selector}; + +/// eg. +static SENTRY_TRACE_SELECTOR : Lazy = Lazy::new(|| { + Selector::parse("meta[name=sentry-trace]") + .expect("HTML selector should parse") +}); + + +/// Extract the sentry trace, then process it. +/// The Python library discards the latter half of the trace. +pub fn parse_index_sentry_trace(html: &str) -> Option { + get_meta_value(html) + .map(|trace| split_sentry_trace(&trace)) + .map(|trace| SentryTrace(trace)) +} + +fn get_meta_value(html: &str) -> Option { + let document = Html::parse_document(html); + let selected = document.select(&SENTRY_TRACE_SELECTOR); + let mut values = selected + .filter_map(|node| node.attr("content")) + .map(|s| s.to_string()) + .collect::>(); + values.pop() +} + +fn split_sentry_trace(trace: &str) -> String { + trace.split("-") + .next() + .map(|v| v.to_string()) + .unwrap_or_else(|| trace.to_string()) +} + +#[cfg(test)] +mod tests { + use crate::endpoint_bindings::old_bindings::index_page::get_index_page::{get_index, GetIndexPageArgs}; + use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_sentry_trace::parse_index_sentry_trace; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + mod test_request { + use super::*; + + #[tokio::test] + #[ignore] // Manual test invocation + async fn test() -> AnyhowResult<()> { + let cookie = load_grok_test_secrets()?.cookies.to_string(); + let index = get_index(GetIndexPageArgs { + cookie: &cookie, + }).await?; + + let sentry_trace = parse_index_sentry_trace(&index.body); + + println!("Sentry trace: {:?}", sentry_trace); + + assert_eq!(1, 2); + Ok(()) + } + } + + mod test_sentry_split { + use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_sentry_trace::split_sentry_trace; + + #[test] + fn test_production_case() { + let result = split_sentry_trace("d6d7c55e4a489c0dabaed06e5c7b257b-d2391b601d54494f-0"); + assert_eq!(&result, "d6d7c55e4a489c0dabaed06e5c7b257b"); + } + + #[test] + fn fallback_case_1() { + let result = split_sentry_trace("asdf"); + assert_eq!(&result, "asdf"); + } + + #[test] + fn fallback_case_2() { + let result = split_sentry_trace(""); + assert_eq!(&result, ""); + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_user_email.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_user_email.rs new file mode 100644 index 00000000..a6cdc043 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_user_email.rs @@ -0,0 +1,50 @@ +use crate::datatypes::api::user_email::UserEmail; +use once_cell::sync::Lazy; +use regex::Regex; + +/// Find the user email in the index.html payload +/// eg. +static JSON_REGEX: Lazy = Lazy::new(|| { + Regex::new(r#"\\?"email\\?":\s*\\?"([^"\\]+)\\?",?"#) + .expect("Regex should parse") +}); + +/// Parse the user email from the index.html +pub fn parse_index_user_email(html: &str) -> Option { + let maybe_meta = scrape_user_email_via_regex(html); + + if let Some(meta) = maybe_meta { + return Some(UserEmail(meta)) + } + + None +} + +fn scrape_user_email_via_regex(html: &str) -> Option { + let captures = JSON_REGEX.captures(html)?; + let capture = captures.get(1)?; + Some(capture.as_str().to_string()) +} + +#[cfg(test)] +mod tests { + use crate::endpoint_bindings::old_bindings::index_page::get_index_page::{get_index, GetIndexPageArgs}; + use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_user_email::parse_index_user_email; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Manual test invocation + async fn test() -> AnyhowResult<()> { + let cookie = load_grok_test_secrets()?.cookies.to_string(); + let index = get_index(GetIndexPageArgs { + cookie: &cookie, + }).await?; + + let user_email = parse_index_user_email(&index.body); + println!("User Email : {:?}", user_email); + + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_user_id.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_user_id.rs new file mode 100644 index 00000000..b5ec01dd --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/index/parse_index_user_id.rs @@ -0,0 +1,50 @@ +use crate::datatypes::api::user_id::UserId; +use once_cell::sync::Lazy; +use regex::Regex; + +/// Find the user id in the index.html payload +/// eg. \"userId\":\"85980643-ffab-4984-a3de-59a608c47d7f\", +static JSON_REGEX: Lazy = Lazy::new(|| { + Regex::new(r#"\\?"userI[dD]\\?":\s*\\?"([a-zA-Z0-9-]{25,})\\?",?"#) + .expect("Regex should parse") +}); + +/// Parse the user id from the index.html +pub fn parse_index_user_id(html: &str) -> Option { + let maybe_meta = scrape_user_id_via_regex(html); + + if let Some(meta) = maybe_meta { + return Some(UserId(meta)) + } + + None +} + +fn scrape_user_id_via_regex(html: &str) -> Option { + let captures = JSON_REGEX.captures(html)?; + let capture = captures.get(1)?; + Some(capture.as_str().to_string()) +} + +#[cfg(test)] +mod tests { + use crate::endpoint_bindings::old_bindings::index_page::get_index_page::{get_index, GetIndexPageArgs}; + use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_user_id::parse_index_user_id; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Manual test invocation + async fn test() -> AnyhowResult<()> { + let cookie = load_grok_test_secrets()?.cookies.to_string(); + let index = get_index(GetIndexPageArgs { + cookie: &cookie, + }).await?; + + let user_id = parse_index_user_id(&index.body); + println!("User ID : {:?}", user_id); + + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/mod.rs new file mode 100644 index 00000000..33edc959 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/index_page/parsers/mod.rs @@ -0,0 +1 @@ +pub mod index; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/grok_create_media_post.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/grok_create_media_post.rs new file mode 100644 index 00000000..97c65fee --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/grok_create_media_post.rs @@ -0,0 +1,164 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::datatypes::api::file_id::FileId; +use crate::datatypes::api::post_id::PostId; +use crate::datatypes::api::user_id::UserId; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::endpoint_bindings::old_bindings::media_posts::create_media_post::request::CreateMediaPostWireRequest; +use crate::endpoint_bindings::old_bindings::media_posts::create_media_post::response::CreateMediaPostRawResponse; +use crate::utils::user_and_file_id_to_image_url::user_and_file_id_to_image_url; +use log::{error, info}; +use std::time::Duration; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, CACHE_CONTROL, CONTENT_TYPE, COOKIE, ORIGIN, PRAGMA, REFERER, USER_AGENT}; +use wreq::Client; +use wreq_util::Emulation; + +const CREATE_MEDIA_POST_URL : &str = "https://grok.com/rest/media/post/create"; + +/// Request builder +pub struct GrokCreateMediaPost<'a> { + pub user_id: &'a UserId, + pub file_id: &'a FileId, + pub media_type: MediaPostType, + pub cookie: &'a str, + pub request_timeout: Option, +} + +#[derive(Debug, Copy, Clone)] +pub enum MediaPostType { + UserUploadedImage, + GrokGeneratedImage, + Video, +} + +/// Response type +#[derive(Debug, Clone)] +pub struct GrokCreateMediaPostResponse { + pub post_id: PostId, +} + +impl <'a> GrokCreateMediaPost<'a> { + pub async fn send(&self) -> Result { + info!("Configuring client..."); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| GrokClientError::WreqClientError(err))?; + + // TODO: Headers were from Chromium, not Firefox. Partial implementation. + let mut request_builder = client.post(CREATE_MEDIA_POST_URL) + // TODO: Missing header "baggage" + // TODO: Missing header "sentry-trace" + // TODO: Missing header "traceparent" + // TODO: Missing header "traceparent" + // TODO: Missing header "x-statsig-id" + // TODO: Missing header "x-xai-request-id" + //.header("sec-ch-ua", "") // NB: Not present in firefox + //.header("sec-ch-ua-mobile", "") // NB: Not present in firefox + //.header("sec-ch-ua-platform", "") // NB: Not present in firefox + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(CACHE_CONTROL, "no-cache") + .header(CONTENT_TYPE, "application/json") + .header(COOKIE, self.cookie.to_string()) + .header(ORIGIN, "https://grok.com") + .header(PRAGMA, "no-cache") + .header("priority", "u=1, i") + .header(REFERER, "https://grok.com/imagine/favorites") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT); + + //info!("Sending..."); + //let response = builder.send() + // .await + // .map_err(|err| GrokClientError::WreqClientError(err))?; + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let media_url = match self.media_type { + MediaPostType::UserUploadedImage => user_and_file_id_to_image_url(self.user_id, self.file_id), + MediaPostType::GrokGeneratedImage => unimplemented!("implement for generated images"), + MediaPostType::Video => unimplemented!("implement for videos"), + }; + + let request_body = CreateMediaPostWireRequest { + media_type: "MEDIA_POST_TYPE_IMAGE".to_string(), + media_url, + }; + + let http_request = request_builder.json(&request_body) + .build() + .map_err(|err| { + error!("Error building create media request: {:?}", err); + GrokClientError::WreqClientError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error during create media: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + + let response_body = response.text() + .await + .map_err(|err| { + error!("Error reading Grok create media response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + // TODO: Handle errors (Cloudflare, Grok, etc.) + if !status.is_success() { + error!("Upload file request returned an error (code {}) : {:?}", status.as_u16(), response_body); + //return Err(classify_general_http_status_code_and_body(status, response_body)); + } + + let response : CreateMediaPostRawResponse = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.to_string()))?; + + Ok(GrokCreateMediaPostResponse { + post_id: PostId(response.post.id), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Client side tests only + async fn create_media_post() -> AnyhowResult<()> { + //setup_test_logging(LevelFilter::Trace); + let cookies = load_grok_test_secrets()?.cookies.to_string(); + + let user_id = UserId("85980643-ffab-4984-a3de-59a608c47d7f".to_string()); // User + let file_id = FileId("990ddf90-8f34-42b1-81a5-39c509d62ff7".to_string()); // Mochi + + let request = GrokCreateMediaPost { + user_id: &user_id, + file_id: &file_id, + media_type: MediaPostType::UserUploadedImage, + cookie: &cookies, + request_timeout: None, + }; + + let result = request.send().await?; + + println!("Result: {:?}", result); + println!("Post ID: {:?}", result.post_id); + + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/mod.rs new file mode 100644 index 00000000..9fc4c9c3 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/mod.rs @@ -0,0 +1,3 @@ +pub mod grok_create_media_post; +pub (super) mod request; +mod response; \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/request.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/request.rs new file mode 100644 index 00000000..e812cb43 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/request.rs @@ -0,0 +1,10 @@ +use serde::Serialize; + +#[derive(Serialize)] +pub (super) struct CreateMediaPostWireRequest { + #[serde(rename = "mediaType")] + pub (super) media_type: String, + + #[serde(rename = "mediaUrl")] + pub (super) media_url: String, +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/response.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/response.rs new file mode 100644 index 00000000..feb01ffc --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/create_media_post/response.rs @@ -0,0 +1,28 @@ +use serde::Deserialize; + +#[derive(Deserialize)] +pub struct CreateMediaPostRawResponse { + pub post: PostData, +} + +#[derive(Deserialize)] +pub struct PostData { + /// The identifier for the post + pub id: String, +} + +/* +{ + "post": { + "id": "3c896963-8e6b-4e71-83e1-4253b2bf2ac8", + "userId":"85980643-ffab-4984-a3de-59a608c47d7f", + "createTime":"2025-10-30T23:22:19.528702688Z", + "prompt":"", + "mediaType":"MEDIA_POST_TYPE_IMAGE", + "mediaUrl":"https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/3c896963-8e6b-4e71-83e1-4253b2bf2ac8/content", + "mimeType":"image/jpeg", + "audioUrls":[], + "childPosts":[] + } +} +*/ diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/grok_list_media_posts.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/grok_list_media_posts.rs new file mode 100644 index 00000000..a9d1a237 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/grok_list_media_posts.rs @@ -0,0 +1,223 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::datatypes::api::file_id::FileId; +use crate::datatypes::api::post_id::PostId; +use crate::datatypes::api::user_id::UserId; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::endpoint_bindings::old_bindings::media_posts::list_media_posts::request::{FilterData, MediaPostListRawRequest}; +use crate::endpoint_bindings::old_bindings::media_posts::list_media_posts::response::{PostItem, PostListRawResponse}; +use crate::utils::user_and_file_id_to_image_url::user_and_file_id_to_image_url; +use log::{error, info}; +use std::time::Duration; +use wreq::header::{ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, CACHE_CONTROL, CONNECTION, CONTENT_TYPE, COOKIE, ORIGIN, PRAGMA, REFERER, TE, USER_AGENT}; +use wreq::Client; +use wreq_util::Emulation; + +const MEDIA_LIST_URL: &str = "https://grok.com/rest/media/post/list"; + +/// Request builder +pub struct GrokMediaPostListRequest<'a> { + pub cookie: &'a str, + + /// Optional cursor + pub cursor: Option, + + pub request_timeout: Option, +} + +/// Response type +#[derive(Debug, Clone)] +pub struct GrokMediaPostList { + /// List of posts + pub posts: Vec, + + /// Cursor for the next items. + pub next_cursor: Option, +} + +#[derive(Debug, Clone)] +pub struct MediaPost { + pub post_id: PostId, + + /// Only populated if there's a video and all the video data is present. + pub video_data: Option +} + +#[derive(Debug, Clone)] +pub struct VideoData { + pub file_id: FileId, + pub video_url: String, + pub prompt: Option, +} + +impl <'a> GrokMediaPostListRequest<'a> { + + pub async fn send(&self) -> Result { + info!("Configuring client..."); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| GrokClientError::WreqClientError(err))?; + + // TODO: Headers were from Chromium, not Firefox. Partial implementation. + let mut request_builder = client.post(MEDIA_LIST_URL) + // TODO: Missing header "baggage" + // TODO: Missing header "sentry-trace" + // TODO: Missing header "traceparent" + // TODO: Missing header "x-statsig-id" + // TODO: Missing header "x-xai-request-id" + //.header(CACHE_CONTROL, "no-cache") // NB: Not present in firefox + //.header(PRAGMA, "no-cache") // NB: Not present in firefox + //.header("sec-ch-ua", "") // NB: Not present in firefox + //.header("sec-ch-ua-mobile", "") // NB: Not present in firefox + //.header("sec-ch-ua-platform", "") // NB: Not present in firefox + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(ACCEPT_ENCODING, "gzip, deflate, br, zstd") + .header(REFERER, "https://grok.com/imagine/favorites") + .header(CONTENT_TYPE, "application/json") + .header(ORIGIN, "https://grok.com") + .header("Sec-GPC", "1") + .header(CONNECTION, "keep-alive") + .header(COOKIE, self.cookie.to_string()) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header("Priority", "u=4") + .header(TE, "trailers"); + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let request_body = MediaPostListRawRequest { + limit: 40, + filter: FilterData { + source: "MEDIA_POST_SOURCE_LIKED".to_string(), + }, + }; + + let http_request = request_builder.json(&request_body) + .build() + .map_err(|err| { + error!("Error building create media request: {:?}", err); + GrokClientError::WreqClientError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error during create media: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + + let response_body = response.text() + .await + .map_err(|err| { + error!("Error reading Grok create media response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + // TODO: Handle errors (Cloudflare, Grok, etc.) + if !status.is_success() { + error!("Upload file request returned an error (code {}) : {:?}", status.as_u16(), response_body); + //return Err(classify_general_http_status_code_and_body(status, response_body)); + } + + let response : PostListRawResponse = serde_json::from_str(&response_body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.to_string()))?; + + let mut posts = Vec::new(); + + for post in response.posts.into_iter() { + let post_id = post.id; + + // If the child video doesn't have a prompt, this parent prompt could + // be a VLM-based auto-prompt we can copy to the video. + let maybe_parent_prompt = empty_to_none(post.prompt); + + let mut video_data = None; + + for child in post.child_posts.into_iter() { + // Maybe children can have more than one video? + if let Some(url) = child.media_url { + let mut has_video = false; + if url.to_lowercase().contains(".mp4") { + has_video = true; + } + if has_video { + let mut maybe_video_prompt = empty_to_none(child.original_prompt); + + if maybe_video_prompt.is_none() { + maybe_video_prompt = maybe_parent_prompt.clone(); + } + + video_data = Some(VideoData { + file_id: FileId(child.id), + video_url: url, + prompt: maybe_video_prompt, + }); + } + } + } + + posts.push(MediaPost { + post_id: PostId(post_id), + video_data, + }) + } + + Ok(GrokMediaPostList { + posts, + next_cursor: response.next_cursor, + }) + } +} + +pub fn empty_to_none(opt: Option) -> Option { + match opt.as_deref() { + None => None, + Some("") => None, + _ => opt, + } +} + + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Client side tests only + async fn create_media_post() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + + let cookies = load_grok_test_secrets()?.cookies.to_string(); + + let request = GrokMediaPostListRequest { + cookie: &cookies, + request_timeout: None, + cursor: None, + }; + + let result = request.send().await?; + + println!("[test] Next Cursor: {:?}", result.next_cursor); + + for post in result.posts { + println!("[test] Post : {:?}", post); + } + + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/mod.rs new file mode 100644 index 00000000..2f3476f8 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/mod.rs @@ -0,0 +1,3 @@ +mod response; +mod request; +pub mod grok_list_media_posts; \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/request.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/request.rs new file mode 100644 index 00000000..89d9a471 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/request.rs @@ -0,0 +1,24 @@ +use serde::Serialize; + +#[derive(Serialize)] +pub struct MediaPostListRawRequest { + /// eg. 40 + pub limit: usize, + pub filter: FilterData, +} + +#[derive(Serialize)] +pub struct FilterData { + /// eg. "MEDIA_POST_SOURCE_LIKED" + pub source: String, +} + +/* +{ + "limit":40, + "filter":{ + "source":"MEDIA_POST_SOURCE_LIKED" + } +} +*/ + diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/response.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/response.rs new file mode 100644 index 00000000..2d6eac94 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/list_media_posts/response.rs @@ -0,0 +1,88 @@ +use serde::Deserialize; + +#[derive(Deserialize, Debug)] +pub (crate) struct PostListRawResponse { + pub posts: Vec, + + #[serde(rename = "nextCursor")] + pub next_cursor: Option, +} + +#[derive(Deserialize, Debug)] +pub (crate) struct PostItem { + /// The "id" of the post. + /// This is how we assert video task completion + pub id: String, + + /// Sometimes this is a VLM-generated prompt + /// This might become the prompt of the video if the video has no prompt. + pub prompt: Option, + + /// eg. `MEDIA_POST_TYPE_IMAGE` + #[serde(rename = "mediaType")] + pub media_type: Option, + + /// eg. "https://imagine-public.x.ai/imagine-public/share-images/abd9331b-c5ac-49cc-8bec-c410c7efde98.jpg" + #[serde(rename = "mediaUrl")] + pub media_url: Option, + + #[serde(rename = "childPosts")] + pub child_posts: Vec, +} + +#[derive(Deserialize, Debug)] +pub (crate) struct ChildPostItem { + pub id: String, + + /// eg. `MEDIA_POST_TYPE_VIDEO` + #[serde(rename = "mediaType")] + pub media_type: Option, + + /// eg. "https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/generated/ecec690e-15bd-4f5f-b4e9-9b8733c3fd69/generated_video.mp4" + #[serde(rename = "mediaUrl")] + pub media_url: Option, + + /// The unmodified user prompt + #[serde(rename = "originalPrompt")] + pub original_prompt: Option, +} + +/* +{ + "posts": [ + { + "id": "abd9331b-c5ac-49cc-8bec-c410c7efde98", + "userId": "85980643-ffab-4984-a3de-59a608c47d7f", + "createTime": "2025-10-30T23:49:37.583477Z", + "prompt": "", + "mediaType": "MEDIA_POST_TYPE_IMAGE", + "mediaUrl": "https://imagine-public.x.ai/imagine-public/share-images/abd9331b-c5ac-49cc-8bec-c410c7efde98.jpg", + "mimeType": "image/jpeg", + "audioUrls": [], + "childPosts": [ + { + "id": "ecec690e-15bd-4f5f-b4e9-9b8733c3fd69", + "userId": "85980643-ffab-4984-a3de-59a608c47d7f", + "createTime": "2025-10-30T23:50:04.862487Z", + "prompt": "", + "mediaType": "MEDIA_POST_TYPE_VIDEO", + "mediaUrl": "https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/generated/ecec690e-15bd-4f5f-b4e9-9b8733c3fd69/generated_video.mp4", + "mimeType": "video/mp4", + "originalPostId": "abd9331b-c5ac-49cc-8bec-c410c7efde98", + "audioUrls": [], + "childPosts": [], + "originalPrompt": "an anime girl runs away from a giant t-rex", + "mode": "custom", + "modelName": "imagine_xdit_1" + } + ], + "originalPrompt": "", + "userInteractionStatus": { + "likeStatus": true + }, + "modelName": "imagine_h_1", + "thumbnailImageUrl": "https://imagine-public.x.ai/cdn-cgi/image/width=500,fit=scale-down,format=auto/imagine-public/share-images/abd9331b-c5ac-49cc-8bec-c410c7efde98.jpg" + }, + { + "id": "3c896963-8e6b-4e71-83e1-4253b2bf2ac8", + */ \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/mod.rs new file mode 100644 index 00000000..b6c8d0df --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/media_posts/mod.rs @@ -0,0 +1,2 @@ +pub mod create_media_post; +pub mod list_media_posts; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/mod.rs new file mode 100644 index 00000000..222e2f7d --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/old_bindings/mod.rs @@ -0,0 +1,3 @@ +pub mod download_video_file; +pub mod index_page; +pub mod media_posts; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/quota_info/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/quota_info/mod.rs new file mode 100644 index 00000000..c275020f --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/quota_info/mod.rs @@ -0,0 +1 @@ +pub mod quota_info; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/quota_info/quota_info.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/quota_info/quota_info.rs new file mode 100644 index 00000000..f393cdb6 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/quota_info/quota_info.rs @@ -0,0 +1,322 @@ +//! `POST /rest/media/imagine/quota_info` — remaining imagine generation +//! quota per media kind. Captured in +//! `external/requests/sites/grok.com/2026-08-23-imagine/12_quota_info.txt`. + +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::client::grok_domain::GrokDomain; +use crate::credentials::grok_cookies::GrokCookies; +use crate::credentials::grok_request_headers::GrokRequestHeaders; +use crate::error::categorize_grok_http_error::categorize_grok_http_error; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::utils::create_firefox_client::create_firefox_client; +use log::error; +use serde::{Deserialize, Serialize}; +use std::time::Duration; +use wreq::StatusCode; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, CONTENT_TYPE, COOKIE, HeaderMap, ORIGIN, REFERER, USER_AGENT}; + +const QUOTA_INFO_PATH: &str = "/rest/media/imagine/quota_info"; + +/// Request arguments. The endpoint currently takes none (the body is `{}`); +/// this exists so arguments slot in without changing call sites. +#[derive(Clone, Debug, Default)] +pub struct QuotaInfoRequest {} + +pub struct QuotaInfoArgs<'a> { + pub request: QuotaInfoRequest, + pub credentials: &'a GrokCookies, + pub domain_override: Option<&'a GrokDomain>, + /// Optional captured statsig/tracing headers (see [`GrokRequestHeaders`]). + pub request_headers: Option<&'a GrokRequestHeaders>, + pub request_timeout: Option, +} + +/// Quota per media kind. Kinds the account has no quota line for are `null`. +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct QuotaInfoResponse { + pub image: Option, + pub image_pro: Option, + pub image_edit: Option, + pub video: Option, + #[serde(rename = "video720p")] + pub video_720p: Option, +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct QuotaInfoBucket { + pub available: bool, + pub remaining_queries: u64, + /// The rolling quota window, e.g. 86400 (one day). + pub window_size_seconds: u64, + /// RFC 3339 timestamp; present when the bucket is exhausted. + pub next_available_at: Option, +} + +/// Wire body — always the empty object. +#[derive(Serialize)] +struct QuotaInfoRawRequest {} + +/// The raw HTTP response, before status interpretation or JSON parsing. +/// Exposed by [`QuotaInfoArgs::fetch_raw`] so callers (e.g. diagnostic tests) +/// can inspect the status, headers, and body when a request goes wrong. +pub struct RawQuotaInfoResponse { + pub status: StatusCode, + pub headers: HeaderMap, + pub body: String, +} + +impl QuotaInfoArgs<'_> { + pub async fn send(&self) -> Result { + let raw = self.fetch_raw().await?; + + if !raw.status.is_success() { + error!("quota_info returned an error (code {}): {:?}", raw.status.as_u16(), raw.body); + return Err(categorize_grok_http_error(raw.status, Some(&raw.body))); + } + + parse_response(&raw.body) + } + + /// Send the request and return the raw response parts without interpreting + /// the status or parsing the body. + pub async fn fetch_raw(&self) -> Result { + let domain = self.domain_override.unwrap_or(&GrokDomain::DefaultDomain); + let client = create_firefox_client()?; + + let mut request_builder = client.post(request_url(domain)) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(CONTENT_TYPE, "application/json") + .header(ORIGIN, "https://grok.com") + .header(REFERER, "https://grok.com/imagine/saved") + .header(COOKIE, self.credentials.to_string()) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin"); + + if let Some(headers) = self.request_headers { + request_builder = headers.apply(request_builder); + } + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let http_request = request_builder.json(&QuotaInfoRawRequest {}) + .build() + .map_err(|err| { + error!("Error building quota_info request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error sending quota_info request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + let headers = response.headers().clone(); + + let body = response.text() + .await + .map_err(|err| { + error!("Error reading quota_info response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + Ok(RawQuotaInfoResponse { status, headers, body }) + } +} + +fn request_url(domain: &GrokDomain) -> String { + format!("{}{}", domain.get_domain(), QUOTA_INFO_PATH) +} + +fn parse_response(body: &str) -> Result { + serde_json::from_str(body) + .map_err(|err| { + GrokGenericApiError::SerdeResponseParseErrorWithBody(err, body.to_string()).into() + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // Cargo runs tests with the crate root as the working directory. + fn load_response(file_name: &str) -> String { + std::fs::read_to_string(format!("test_data/endpoint_responses/{file_name}")).unwrap() + } + + mod wire_format_tests { + use super::*; + + #[test] + fn url_uses_the_default_domain() { + assert_eq!( + request_url(&GrokDomain::DefaultDomain), + "https://grok.com/rest/media/imagine/quota_info", + ); + } + + #[test] + fn url_respects_a_domain_override() { + let domain = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!( + request_url(&domain), + "http://localhost:8080/rest/media/imagine/quota_info", + ); + } + + #[test] + fn body_is_the_empty_object() { + let body = serde_json::to_string(&QuotaInfoRawRequest {}).unwrap(); + assert_eq!(body, "{}"); + } + } + + mod response_parsing_tests { + use super::*; + + #[test] + fn parses_real_quota_response() { + let response = parse_response(&load_response("quota_info.json")).unwrap(); + + assert!(response.image.is_none()); + assert!(response.image_edit.is_none()); + assert!(response.video.is_none()); + + let image_pro = response.image_pro.unwrap(); + assert!(image_pro.available); + assert_eq!(image_pro.remaining_queries, 4); + assert_eq!(image_pro.window_size_seconds, 86400); + assert!(image_pro.next_available_at.is_none()); + + let video_720p = response.video_720p.unwrap(); + assert!(video_720p.available); + assert_eq!(video_720p.remaining_queries, 0); + assert_eq!( + video_720p.next_available_at.as_deref(), + Some("2026-08-24T21:00:41.230702760Z"), + ); + } + + #[test] + fn malformed_json_is_an_error() { + let result = parse_response("{ this is not json"); + assert!(matches!( + result, + Err(GrokError::ApiGeneric(GrokGenericApiError::SerdeResponseParseErrorWithBody(_, _))), + )); + } + } + + mod real_wire_tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + // Reaching `Ok` here means `send` saw a 2xx (it returns `Err` otherwise), + // so a successful parse is the 200 assertion. + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_quota_info() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let args = QuotaInfoArgs { + request: QuotaInfoRequest::default(), + credentials: &secrets.cookies, + domain_override: None, + request_headers: Some(&secrets.headers), + request_timeout: None, + }; + + let response = args.send().await?; + println!("[test] quota_info: {:?}", response); + + assert_quota_info(&response); + Ok(()) + } + + // Same request and assertions as above, but WITHOUT the captured + // statsig/tracing headers — just the cookies. Tells us whether those + // headers are actually required. On any failure (non-2xx, parse error, or + // a failed assertion) it dumps the response status, headers, and body. + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_quota_info_cookies_only() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let args = QuotaInfoArgs { + request: QuotaInfoRequest::default(), + credentials: &secrets.cookies, + domain_override: None, + request_headers: None, // cookies only — no statsig / tracing headers + request_timeout: None, + }; + + let raw = args.fetch_raw().await?; + + let dump = || { + println!("[test] status: {}", raw.status); + println!("[test] response headers: {:#?}", raw.headers); + println!("[test] response body: {}", raw.body); + }; + + if !raw.status.is_success() { + dump(); + panic!("quota_info (cookies only) expected 2xx, got {}", raw.status); + } + + let response: QuotaInfoResponse = match serde_json::from_str(&raw.body) { + Ok(response) => response, + Err(err) => { + dump(); + panic!("quota_info (cookies only) failed to parse body: {err}"); + } + }; + println!("[test] quota_info (cookies only): {:?}", response); + + if !quota_info_assertions_pass(&response) { + dump(); + panic!("quota_info (cookies only) assertions failed"); + } + Ok(()) + } + + // At least one media kind should report a quota bucket, and every present + // bucket has a positive rolling window. (No PII / account id.) + fn quota_info_assertions_pass(response: &QuotaInfoResponse) -> bool { + let buckets = quota_buckets(response); + buckets.iter().any(|bucket| bucket.is_some()) + && buckets.into_iter().flatten().all(|bucket| bucket.window_size_seconds > 0) + } + + fn assert_quota_info(response: &QuotaInfoResponse) { + assert!( + quota_info_assertions_pass(response), + "expected at least one quota bucket with a positive window", + ); + } + + fn quota_buckets(response: &QuotaInfoResponse) -> [&Option; 5] { + [ + &response.image, + &response.image_pro, + &response.image_edit, + &response.video, + &response.video_720p, + ] + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/session_info/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/session_info/mod.rs new file mode 100644 index 00000000..497c5bdc --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/session_info/mod.rs @@ -0,0 +1 @@ +pub mod session_info; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/session_info/session_info.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/session_info/session_info.rs new file mode 100644 index 00000000..1c02efe2 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/session_info/session_info.rs @@ -0,0 +1,298 @@ +//! `GET /api/auth/session` — who the cookies authenticate as. Captured in +//! `external/requests/sites/grok.com/2026-08-23-imagine/09_session_info.txt`. + +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::client::grok_domain::GrokDomain; +use crate::credentials::grok_cookies::GrokCookies; +use crate::credentials::grok_request_headers::GrokRequestHeaders; +use crate::error::categorize_grok_http_error::categorize_grok_http_error; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::utils::create_firefox_client::create_firefox_client; +use log::error; +use serde::Deserialize; +use std::time::Duration; +use wreq::StatusCode; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, COOKIE, HeaderMap, REFERER, USER_AGENT}; + +const SESSION_INFO_PATH: &str = "/api/auth/session"; + +/// The session's `status` value when the cookies are valid. +const STATUS_AUTHENTICATED: &str = "authenticated"; + +/// Request arguments. The endpoint currently takes none; this exists so +/// arguments slot in without changing call sites. +#[derive(Clone, Debug, Default)] +pub struct SessionInfoRequest {} + +pub struct SessionInfoArgs<'a> { + pub request: SessionInfoRequest, + pub credentials: &'a GrokCookies, + pub domain_override: Option<&'a GrokDomain>, + /// Optional captured statsig/tracing headers (see [`GrokRequestHeaders`]). + pub request_headers: Option<&'a GrokRequestHeaders>, + pub request_timeout: Option, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct SessionInfoResponse { + /// e.g. "authenticated" + pub status: String, + pub session: Option, +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SessionInfo { + pub user_id: String, + pub email: Option, + pub email_confirmed: Option, + pub given_name: Option, + pub family_name: Option, + /// Bucket path of the profile picture, if any. + pub profile_image: Option, + pub session_id: Option, + /// Epoch milliseconds of account creation. + pub create_time: Option, +} + +impl SessionInfoResponse { + pub fn is_authenticated(&self) -> bool { + self.status == STATUS_AUTHENTICATED && self.session.is_some() + } +} + +/// The raw HTTP response, before status interpretation or JSON parsing. +/// Exposed by [`SessionInfoArgs::fetch_raw`] so callers (e.g. diagnostic +/// tests) can inspect the status, headers, and body when a request goes wrong. +pub struct RawSessionInfoResponse { + pub status: StatusCode, + pub headers: HeaderMap, + pub body: String, +} + +impl SessionInfoArgs<'_> { + pub async fn send(&self) -> Result { + let raw = self.fetch_raw().await?; + + if !raw.status.is_success() { + error!("session_info returned an error (code {}): {:?}", raw.status.as_u16(), raw.body); + return Err(categorize_grok_http_error(raw.status, Some(&raw.body))); + } + + parse_response(&raw.body) + } + + /// Send the request and return the raw response parts without interpreting + /// the status or parsing the body. + pub async fn fetch_raw(&self) -> Result { + let domain = self.domain_override.unwrap_or(&GrokDomain::DefaultDomain); + let client = create_firefox_client()?; + + let mut request_builder = client.get(request_url(domain)) + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(REFERER, "https://grok.com/imagine/saved") + .header(COOKIE, self.credentials.to_string()) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin"); + + if let Some(headers) = self.request_headers { + request_builder = headers.apply(request_builder); + } + + if let Some(timeout) = self.request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let http_request = request_builder + .build() + .map_err(|err| { + error!("Error building session_info request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error sending session_info request: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + let headers = response.headers().clone(); + + let body = response.text() + .await + .map_err(|err| { + error!("Error reading session_info response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + Ok(RawSessionInfoResponse { status, headers, body }) + } +} + +fn request_url(domain: &GrokDomain) -> String { + format!("{}{}", domain.get_domain(), SESSION_INFO_PATH) +} + +fn parse_response(body: &str) -> Result { + serde_json::from_str(body) + .map_err(|err| { + GrokGenericApiError::SerdeResponseParseErrorWithBody(err, body.to_string()).into() + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // Cargo runs tests with the crate root as the working directory. + fn load_response(file_name: &str) -> String { + std::fs::read_to_string(format!("test_data/endpoint_responses/{file_name}")).unwrap() + } + + mod wire_format_tests { + use super::*; + + #[test] + fn url_uses_the_default_domain() { + assert_eq!( + request_url(&GrokDomain::DefaultDomain), + "https://grok.com/api/auth/session", + ); + } + + #[test] + fn url_respects_a_domain_override() { + let domain = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!(request_url(&domain), "http://localhost:8080/api/auth/session"); + } + } + + mod response_parsing_tests { + use super::*; + + #[test] + fn parses_real_session_response() { + let response = parse_response(&load_response("session_info.json")).unwrap(); + + assert_eq!(response.status, "authenticated"); + assert!(response.is_authenticated()); + + let session = response.session.unwrap(); + assert_eq!(session.user_id, "00000000-0000-4000-8000-000000000000"); + assert_eq!(session.email.as_deref(), Some("user@example.com")); + assert_eq!(session.email_confirmed, Some(true)); + assert_eq!(session.given_name.as_deref(), Some("Test")); + assert_eq!(session.family_name.as_deref(), Some("User")); + assert_eq!( + session.session_id.as_deref(), + Some("88888888-8888-4888-8888-888888888888"), + ); + assert_eq!(session.create_time, Some(1787514616739)); + } + + #[test] + fn missing_required_status_is_an_error() { + // `status` is required, so an object without it fails to parse. + let result = parse_response("{}"); + assert!(matches!( + result, + Err(GrokError::ApiGeneric(GrokGenericApiError::SerdeResponseParseErrorWithBody(_, _))), + )); + } + } + + mod real_wire_tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + // Reaching `Ok` here means `send` saw a 2xx (it returns `Err` otherwise), + // so a successful parse is the 200 assertion. + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_session_info() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let args = SessionInfoArgs { + request: SessionInfoRequest::default(), + credentials: &secrets.cookies, + domain_override: None, + request_headers: Some(&secrets.headers), + request_timeout: None, + }; + + let response = args.send().await?; + println!("[test] session_info: {:?}", response); + + // The cookies should authenticate to *some* account. (Assert the shape, + // not the specific user id / email.) + assert_eq!(response.status, "authenticated"); + assert!(response.is_authenticated()); + let session = response.session.as_ref().expect("session present"); + assert!(!session.user_id.is_empty()); + Ok(()) + } + + // Same request and assertions as above, but WITHOUT the captured + // statsig/tracing headers — just the cookies. Tells us whether those + // headers are actually required. On any failure (non-2xx, parse error, or + // a failed assertion) it dumps the response status, headers, and body. + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn fetch_session_info_cookies_only() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let args = SessionInfoArgs { + request: SessionInfoRequest::default(), + credentials: &secrets.cookies, + domain_override: None, + request_headers: None, // cookies only — no statsig / tracing headers + request_timeout: None, + }; + + let raw = args.fetch_raw().await?; + + let dump = || { + println!("[test] status: {}", raw.status); + println!("[test] response headers: {:#?}", raw.headers); + println!("[test] response body: {}", raw.body); + }; + + if !raw.status.is_success() { + dump(); + panic!("session_info (cookies only) expected 2xx, got {}", raw.status); + } + + let response: SessionInfoResponse = match serde_json::from_str(&raw.body) { + Ok(response) => response, + Err(err) => { + dump(); + panic!("session_info (cookies only) failed to parse body: {err}"); + } + }; + println!("[test] session_info (cookies only): {:?}", response); + + // Same assertions as fetch_session_info, but dump diagnostics on failure. + let assertions_pass = response.status == "authenticated" + && response.is_authenticated() + && response.session.as_ref().is_some_and(|session| !session.user_id.is_empty()); + + if !assertions_pass { + dump(); + panic!("session_info (cookies only) assertions failed"); + } + + Ok(()) + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/grok_upload_file.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/grok_upload_file.rs new file mode 100644 index 00000000..7a4d434d --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/grok_upload_file.rs @@ -0,0 +1,293 @@ +use crate::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use crate::client::grok_domain::GrokDomain; +use crate::datatypes::api::file_id::FileId; +use crate::endpoint_bindings::upload_file::response::GrokApiUploadFileResponse; +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use log::{error, info}; +use std::path::Path; +use std::time::Duration; +use tokio::fs::File; +use tokio::io::AsyncReadExt; +use wreq::header::{ACCEPT, ACCEPT_LANGUAGE, COOKIE, ORIGIN, REFERER, USER_AGENT}; +use wreq::multipart::{Form, Part}; +use wreq::Client; +use wreq_util::Emulation; + +/// The upload path (appended to the [`GrokDomain`]). As of 2026-08-23 this is a +/// `multipart/form-data` upload of the raw bytes (previously a JSON body with +/// base64 `content`). +const UPLOAD_FILE_PATH: &str = "/http/upload-file-v2/direct"; + +/// The multipart field name the web app uses for the file part. +const FILE_FIELD_NAME: &str = "file"; + +/// Try to prevent buffer reallocations. +const INITIAL_BUFFER_SIZE: usize = 1024 * 1024; + +/// The file to upload: a path to read from disk, or in-memory bytes. +pub enum PathOrFile<'a> { + /// A path to a file on disk. Its name and MIME type are derived from the path. + Path(&'a Path), + /// In-memory bytes with an explicit name and MIME type. + File { + bytes: Vec, + file_name: String, + mime_type: String, + }, +} + +pub struct GrokUploadFileRequest<'a> { + pub file: PathOrFile<'a>, +} + +pub struct GrokUploadFileArgs<'a> { + pub request: GrokUploadFileRequest<'a>, + pub cookie: &'a str, + pub domain_override: Option<&'a GrokDomain>, + pub request_timeout: Option, +} + +#[derive(Clone, Debug)] +pub struct GrokUploadFileResponse { + pub file_id: Option, + pub file_uri: Option, +} + +/// Upload a file to Grok. +pub async fn grok_upload_file(args: GrokUploadFileArgs<'_>) -> Result { + let (bytes, file_name, mime_type) = match args.request.file { + PathOrFile::Path(path) => read_file_for_upload(path).await?, + PathOrFile::File { bytes, file_name, mime_type } => (bytes, file_name, mime_type), + }; + + let domain = args.domain_override.unwrap_or(&GrokDomain::DefaultDomain); + + do_upload(domain, args.cookie, args.request_timeout, bytes, file_name, mime_type).await +} + +async fn do_upload( + domain: &GrokDomain, + cookie: &str, + request_timeout: Option, + bytes: Vec, + file_name: String, + mime_type: String, +) -> Result { + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(GrokClientError::WreqClientError)?; + + info!("Uploading {} ({} bytes) to Grok...", file_name, bytes.len()); + + // Raw bytes in a single `file` part. `.multipart()` sets the + // `content-type: multipart/form-data; boundary=...` header itself. + let part = Part::bytes(bytes) + .file_name(file_name) + .mime_str(&mime_type) + .map_err(GrokClientError::WreqClientError)?; + let form = Form::new().part(FILE_FIELD_NAME, part); + + let mut request_builder = client.post(request_url(domain)) + .header(ACCEPT, "*/*") + .header(ACCEPT_LANGUAGE, "en-US,en;q=0.5") + .header(COOKIE, cookie) + .header(ORIGIN, "https://grok.com") + .header(REFERER, "https://grok.com/imagine") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header(USER_AGENT, FIREFOX_143_MAC_USER_AGENT) + .multipart(form); + + if let Some(timeout) = request_timeout { + request_builder = request_builder.timeout(timeout); + } + + let http_request = request_builder + .build() + .map_err(|err| { + error!("Error building image upload request: {:?}", err); + GrokClientError::WreqClientError(err) + })?; + + let response = client.execute(http_request) + .await + .map_err(|err| { + error!("Error during image upload: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + let status = response.status(); + + let response_body = response.text() + .await + .map_err(|err| { + error!("Error reading Grok image upload response body: {:?}", err); + GrokGenericApiError::WreqError(err) + })?; + + if !status.is_success() { + error!("Upload file request returned an error (code {}): {:?}", status.as_u16(), response_body); + // TODO: Categorize Cloudflare / auth / rate-limit errors. + } + + parse_upload_response(&response_body) +} + +fn request_url(domain: &GrokDomain) -> String { + format!("{}{}", domain.get_domain(), UPLOAD_FILE_PATH) +} + +/// Read a file into memory and derive its upload name and MIME type. +async fn read_file_for_upload(file_path: &Path) -> Result<(Vec, String, String), GrokError> { + let mut file = File::open(file_path) + .await + .map_err(|err| { + error!("Failed to open file for upload: {}", err); + GrokClientError::CannotOpenLocalFileForUpload(err) + })?; + + let mut buffer = Vec::with_capacity(INITIAL_BUFFER_SIZE); + file.read_to_end(&mut buffer) + .await + .map_err(|err| { + error!("Failed to read file for upload: {}", err); + GrokClientError::CannotReadLocalFileForUpload(err) + })?; + + let file_name = file_path + .file_name() + .ok_or(GrokClientError::FileForUploadHasInvalidPath)? + .to_string_lossy() + .to_string(); + + let mime_type = mime_type_for_extension(file_path.extension().and_then(|e| e.to_str())); + + Ok((buffer, file_name, mime_type.to_string())) +} + +/// Best-effort MIME type from a file extension. +// TODO: Read file magic bytes first, then fall back to this. +fn mime_type_for_extension(extension: Option<&str>) -> &'static str { + match extension { + Some("jpg") | Some("jpeg") => "image/jpeg", + Some("png") => "image/png", + Some("webp") => "image/webp", + Some("gif") => "image/gif", + _ => "application/octet-stream", + } +} + +/// Parse the upload response into the public [`GrokUploadFileResponse`]. The +/// file id and uri now live under `fileMetadata`. +fn parse_upload_response(body: &str) -> Result { + let response: GrokApiUploadFileResponse = serde_json::from_str(body) + .map_err(|err| GrokGenericApiError::SerdeResponseParseErrorWithBody(err, body.to_string()))?; + + let metadata = response.file_metadata; + + Ok(GrokUploadFileResponse { + file_id: metadata.as_ref().and_then(|m| m.file_metadata_id.clone()).map(FileId), + file_uri: metadata.and_then(|m| m.file_uri), + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // Wire-format tests below are deliberately image-free — they exercise the + // URL, the MIME mapping, and response parsing without embedding a payload. + + mod wire_format_tests { + use super::*; + + #[test] + fn url_uses_the_default_domain() { + assert_eq!( + request_url(&GrokDomain::DefaultDomain), + "https://grok.com/http/upload-file-v2/direct", + ); + } + + #[test] + fn url_respects_a_domain_override() { + let domain = GrokDomain::Custom("http://localhost:8080".to_string()); + assert_eq!(request_url(&domain), "http://localhost:8080/http/upload-file-v2/direct"); + } + + #[test] + fn mime_type_is_derived_from_extension() { + assert_eq!(mime_type_for_extension(Some("jpg")), "image/jpeg"); + assert_eq!(mime_type_for_extension(Some("jpeg")), "image/jpeg"); + assert_eq!(mime_type_for_extension(Some("png")), "image/png"); + assert_eq!(mime_type_for_extension(Some("webp")), "image/webp"); + assert_eq!(mime_type_for_extension(None), "application/octet-stream"); + assert_eq!(mime_type_for_extension(Some("xyz")), "application/octet-stream"); + } + + #[test] + fn parses_real_upload_response() { + // Real response from 17_upload_image.txt, user id scrubbed. + let body = std::fs::read_to_string("test_data/endpoint_responses/upload_file.json").unwrap(); + + let response = parse_upload_response(&body).unwrap(); + + assert_eq!( + response.file_id.as_ref().map(|id| id.0.as_str()), + Some("a0a1a02e-6236-41be-b213-eaa2ac7bd7f2"), + ); + assert_eq!( + response.file_uri.as_deref(), + Some("users/00000000-0000-4000-8000-000000000000/a0a1a02e-6236-41be-b213-eaa2ac7bd7f2/content"), + ); + } + + #[test] + fn malformed_response_is_an_error() { + let result = parse_upload_response("{ not json"); + assert!(matches!( + result, + Err(GrokError::ApiGeneric(GrokGenericApiError::SerdeResponseParseErrorWithBody(_, _))), + )); + } + } + + mod real_wire_tests { + use super::*; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + // A real (non-trivial) PNG lives here — Grok's upload pipeline rejects + // degenerate images. Cargo runs tests from the crate root. + const TEST_IMAGE_PATH: &str = "test_data/images/test_upload.png"; + + #[tokio::test] + #[ignore] // Hits the real website; requires external/credentials/grok. + async fn upload_file() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let secrets = load_grok_test_secrets()?; + + let result = grok_upload_file(GrokUploadFileArgs { + request: GrokUploadFileRequest { + file: PathOrFile::Path(Path::new(TEST_IMAGE_PATH)), + }, + cookie: secrets.cookies.as_str(), + domain_override: None, + request_timeout: Some(Duration::from_secs(30)), + }).await?; + + println!("Upload result: {:?}", result); + + assert!(result.file_id.is_some(), "expected a file id from the upload"); + assert!(result.file_uri.is_some(), "expected a file uri from the upload"); + Ok(()) + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/mod.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/mod.rs new file mode 100644 index 00000000..87ba7a7c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/mod.rs @@ -0,0 +1,3 @@ +pub mod grok_upload_file; + +pub (super) mod response; diff --git a/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/response.rs b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/response.rs new file mode 100644 index 00000000..31a743ef --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/endpoint_bindings/upload_file/response.rs @@ -0,0 +1,38 @@ +use serde::Deserialize; + +/// The `/http/upload-file-v2/direct` response (2026-08-23): +/// +/// ```json +/// { +/// "uploadId": "304e7eb0-7a7b-40af-afe5-4e28eeeb0270", +/// "fileMetadata": { +/// "fileMetadataId": "a0a1a02e-6236-41be-b213-eaa2ac7bd7f2", +/// "fileMimeType": "image/png", +/// "fileName": "moon_door.png", +/// "fileUri": "users/{user_id}/{file_id}/content", +/// "parsedFileUri": "", +/// "createTime": "2026-08-23T22:46:22.235616548Z", +/// "fileSource": "SELF_UPLOAD_FILE_SOURCE" +/// } +/// } +/// ``` +#[derive(Deserialize)] +pub (super) struct GrokApiUploadFileResponse { + #[serde(rename = "uploadId")] + pub upload_id: Option, + + #[serde(rename = "fileMetadata")] + pub file_metadata: Option, +} + +#[derive(Deserialize)] +pub (super) struct GrokApiUploadFileMetadata { + /// The uploaded file id, used to reference the file later. + #[serde(rename = "fileMetadataId")] + pub file_metadata_id: Option, + + /// Partial path to the media file, not a full URI. + /// eg. `users/{user_id}/{file_id}/content` + #[serde(rename = "fileUri")] + pub file_uri: Option, +} diff --git a/crates/api_clients/grok_consumer_client/src/error/categorize_grok_http_error.rs b/crates/api_clients/grok_consumer_client/src/error/categorize_grok_http_error.rs new file mode 100644 index 00000000..4ddc2e1d --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/error/categorize_grok_http_error.rs @@ -0,0 +1,115 @@ +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::error::grok_specific_api_error::GrokSpecificApiError; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use wreq::StatusCode; + +/// We know the response is an error at this point. +/// We're just turning it into the right error. +pub fn categorize_grok_http_error(status_code: StatusCode, maybe_body: Option<&str>) -> GrokError { + + if let Some(body) = maybe_body { + if let Err(err) = filter_cloudflare_errors(status_code.as_u16(), body) { + return GrokGenericApiError::CloudflareError(err).into(); + } + + // Match against a lowercased copy but keep `body` (original case) for the + // error payloads, so callers see exactly what the server sent. + let lowered = body.to_lowercase(); + + // Statsig (x-statsig-id) rejection. The signature must be produced by a + // real browser DOM; a missing/stale/invalid one yields this 403 notice. + if is_statsig_rejection(&lowered) { + return GrokSpecificApiError::StatsigSignatureRejected { + status_code: status_code.as_u16(), + body: body.to_string(), + }.into(); + } + + // Resolution gated to a higher plan, e.g. "1080p video generation is not + // available on your current plan. Use 720p instead." (Same 403/code 7 shape + // as the statsig notice, so this must come after `is_statsig_rejection`.) + if is_resolution_not_allowed(&lowered) { + return GrokSpecificApiError::VideoResolutionNotAllowed { + status_code: status_code.as_u16(), + body: body.to_string(), + }.into(); + } + + let anti_bot = lowered.contains("anti-bot") || lowered.contains("rejected"); + + if anti_bot { + return GrokSpecificApiError::AutomationBlocked.into(); + } + + match status_code { + StatusCode::TOO_MANY_REQUESTS => { + return GrokSpecificApiError::TooManyVideos.into(); + } + _ => {}, + } + + return GrokGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code, + body: body.to_string(), + }.into(); + } + + GrokGenericApiError::UncategorizedBadResponseWithStatus(status_code).into() +} + +/// Whether a (lowercased) response body reads like an `x-statsig-id` rejection. +/// Grok's current notice is "This page is out of date. Reload to continue."; +/// the extra needles catch adjacent phrasings without over-matching. +fn is_statsig_rejection(lowered_body: &str) -> bool { + lowered_body.contains("out of date") + || lowered_body.contains("reload to continue") + || lowered_body.contains("x-statsig") +} + +/// Whether a (lowercased) response body reads like a plan-gated resolution +/// (e.g. 1080p on a lower tier). +fn is_resolution_not_allowed(lowered_body: &str) -> bool { + lowered_body.contains("not available on your current plan") +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::error::grok_error::GrokError; + + // Real 403 body observed when sending a stale/invalid x-statsig-id. + const STATSIG_403_BODY: &str = + r#"{"error":{"code":7,"message":"This page is out of date. Reload to continue.","details":[]}}"#; + + // Real 403 body observed when requesting 1080p on a lower-tier plan. + const RESOLUTION_403_BODY: &str = + r#"{"error":{"code":7,"message":"1080p video generation is not available on your current plan. Use 720p instead.","details":[]}}"#; + + #[test] + fn statsig_rejection_is_categorized_with_status_and_body() { + let error = categorize_grok_http_error(StatusCode::FORBIDDEN, Some(STATSIG_403_BODY)); + match error { + GrokError::ApiSpecific(GrokSpecificApiError::StatsigSignatureRejected { status_code, body }) => { + assert_eq!(status_code, 403); + // The full, original-case body is preserved for debugging new notices. + assert_eq!(body, STATSIG_403_BODY); + assert!(body.contains("out of date")); + } + other => panic!("expected StatsigSignatureRejected, got {:?}", other), + } + } + + #[test] + fn plan_gated_resolution_is_categorized_with_status_and_body() { + let error = categorize_grok_http_error(StatusCode::FORBIDDEN, Some(RESOLUTION_403_BODY)); + match error { + GrokError::ApiSpecific(GrokSpecificApiError::VideoResolutionNotAllowed { status_code, body }) => { + assert_eq!(status_code, 403); + assert_eq!(body, RESOLUTION_403_BODY); + assert!(body.contains("not available on your current plan")); + } + other => panic!("expected VideoResolutionNotAllowed, got {:?}", other), + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/error/grok_client_error.rs b/crates/api_clients/grok_consumer_client/src/error/grok_client_error.rs new file mode 100644 index 00000000..2099ae43 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/error/grok_client_error.rs @@ -0,0 +1,83 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum GrokClientError { + + /// An error was encountered in building the Wreq client + WreqClientError(wreq::Error), + + /// Error serializing a message to send the websocket + WebsocketRequestSerializationError(serde_json::Error), + + /// Error locking the websocket for sending/receiving + WebsocketLockError, + + /// Error reading from a websocket. + WebsocketReadError(wreq::Error), + + /// Error sending to an open websocket. + WebsocketSendError(wreq::Error), + + /// Can't open a local file for uploading. + CannotOpenLocalFileForUpload(std::io::Error), + + /// Can't read a local file for uploading. + CannotReadLocalFileForUpload(std::io::Error), + + /// Couldn't write to the file + CannotOpenLocalFileForWriting(std::io::Error), + + /// Couldn't write to the file + CannotWriteLocalFile(std::io::Error), + + /// File for upload has an invalid path. + FileForUploadHasInvalidPath, + + /// Error parsing HTML + HtmlParsingError, + + /// Our script logic is out of date + ScriptLogicOutOfDate, + + /// Our script logic is out of date (script 1) + Script1LogicOutOfDate, + + /// Our script logic is out of date (script 2) + Script2LogicOutOfDate, + + /// Something is broken with timeout math + TimeoutMathBroken, + + /// Can't make request because cookies aren't present + NoCookiesPresent, + + /// Unknown error generating video + ErrorGeneratingVideo, +} + +impl Error for GrokClientError {} + +impl Display for GrokClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::WreqClientError(err) => write!(f, "Wreq client error (during client creation): {}", err), + Self::WebsocketRequestSerializationError(err) => write!(f, "Websocket request serialization error: {}", err), + Self::WebsocketLockError => write!(f, "Websocket lock error"), + Self::WebsocketReadError(err) => write!(f, "Websocket read error: {}", err), + Self::WebsocketSendError(err) => write!(f, "Websocket send error: {}", err), + Self::CannotOpenLocalFileForUpload(err) => write!(f, "Cannot open local file for upload: {}", err), + Self::CannotReadLocalFileForUpload(err) => write!(f, "Cannot read local file for upload: {}", err), + Self::CannotOpenLocalFileForWriting(err) => write!(f, "Cannot open local file for writing: {}", err), + Self::CannotWriteLocalFile(err) => write!(f, "Cannot write local file: {}", err), + Self::FileForUploadHasInvalidPath => write!(f, "File for upload has invalid path"), + Self::HtmlParsingError => write!(f, "Html parsing error"), + Self::ScriptLogicOutOfDate => write!(f, "Script logic out of date"), + Self::Script1LogicOutOfDate => write!(f, "Script logic out of date (script 1)"), + Self::Script2LogicOutOfDate => write!(f, "Script logic out of date (script 2)"), + Self::TimeoutMathBroken => write!(f, "Timeout math is broken"), + Self::NoCookiesPresent => write!(f, "No cookies present"), + Self::ErrorGeneratingVideo => write!(f, "Error generating video"), + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/error/grok_error.rs b/crates/api_clients/grok_consumer_client/src/error/grok_error.rs new file mode 100644 index 00000000..93436f1d --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/error/grok_error.rs @@ -0,0 +1,62 @@ +use crate::error::grok_client_error::GrokClientError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::error::grok_specific_api_error::GrokSpecificApiError; +use cloudflare_errors::cloudflare_error::CloudflareError; +use std::error::Error; + +#[derive(Debug)] +pub enum GrokError { + Client(GrokClientError), + ApiSpecific(GrokSpecificApiError), + ApiGeneric(GrokGenericApiError), +} + +impl GrokError { + /// Cloudflare reports the origin (grok.com) is failing — wait and retry. + pub fn is_grok_having_downtime_issues(&self) -> bool { + match self { + Self::ApiGeneric(GrokGenericApiError::CloudflareError(err)) => err.is_origin_failure(), + _ => false, + } + } + + /// Cloudflare challenged this client: the cookies (notably `cf_clearance`) + /// need re-earning in the login window, under the same User-Agent the + /// client sends. + pub fn is_cloudflare_challenge(&self) -> bool { + matches!( + self, + Self::ApiGeneric(GrokGenericApiError::CloudflareError(CloudflareError::ChallengeInterstitial403)), + ) + } +} + +impl Error for GrokError {} + +impl std::fmt::Display for GrokError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Client(e) => write!(f, "GrokClientError: {:?}", e), + Self::ApiSpecific(e) => write!(f, "GrokSpecificApiError: {:?}", e), + Self::ApiGeneric(e) => write!(f, "GrokGenericApiError: {:?}", e), + } + } +} + +impl From for GrokError { + fn from(error: GrokClientError) -> Self { + Self::Client(error) + } +} + +impl From for GrokError { + fn from(error: GrokSpecificApiError) -> Self { + Self::ApiSpecific(error) + } +} + +impl From for GrokError { + fn from(error: GrokGenericApiError) -> Self { + Self::ApiGeneric(error) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/error/grok_generic_api_error.rs b/crates/api_clients/grok_consumer_client/src/error/grok_generic_api_error.rs new file mode 100644 index 00000000..4c2880ae --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/error/grok_generic_api_error.rs @@ -0,0 +1,89 @@ +use cloudflare_errors::cloudflare_error::CloudflareError; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use wreq::StatusCode; + +#[derive(Debug)] +pub enum GrokGenericApiError { + /// Specific Cloudflare errors. + CloudflareError(CloudflareError), + + /// The downloaded index.html did not include the expected data. + /// This is necessary for handshakes between client and server. + IndexHtmlDidNotIncludeExpectedData { + message: String, + }, + + /// The downloaded javascript did not include the expected data. + /// This is necessary for handshakes between client and server. + ScriptBodyDidNotIncludeExpectedData { + message: String, + }, + + /// Error creating the websocket due to 401 Unauthorized, likely an authentication error with Grok. + /// Unfortunately we can't read the response body text to diagnose more because wreq has some API design issues. + LikelyWebsocketAuthentication401, + + /// We received a 403 on websocket upgrade, likely from Cloudflare. + /// Unfortunately we can't read the response body text to diagnose more because wreq has some API design issues. + LikelyWebsocketCloudflare403, + + /// Unknown status code on websocket upgrade. + UnexpectedWebsocketUpgradeStatusCode(StatusCode), + + /// serde_json::Error, likely from JSON deserialization schema mismatch. + /// Includes the original body. + SerdeResponseParseErrorWithBody(serde_json::Error, String), + + /// serde_json::Error, likely from JSON deserialization schema mismatch. + /// Includes the original body. + /// Specifically, this is for non-200 (error) responses. + SerdeParseErrorWithBodyOnNon200(serde_json::Error, String), + + /// An uncategorized bad HTTP response from Grok. + UncategorizedBadResponseWithStatus(StatusCode), + + /// An uncategorized bad HTTP response from Grok. + UncategorizedBadResponseWithStatusAndBody { + status_code: StatusCode, + body: String, + }, + + /// Our previous upload failed + UploadFailed, + + /// The image websocket returned an error frame we don't specifically handle. + /// Carries the full raw error frame. + UnexpectedWebsocketErrorFrame { + body: String, + }, + + /// An error upgrading the connection to a websocket. + WreqWebsocketUpgradeError(wreq::Error), + + /// An uncaught error from the API client. + WreqError(wreq::Error), +} + +impl Error for GrokGenericApiError {} + +impl Display for GrokGenericApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::CloudflareError(err) => write!(f, "Cloudflare error: {}", err), + Self::IndexHtmlDidNotIncludeExpectedData { message } => write!(f, "IndexHtmlDidNotIncludeExpectedData ( message: {} )", message), + Self::ScriptBodyDidNotIncludeExpectedData { message } => write!(f, "ScriptBodyDidNotIncludeExpectedData ( message: {} )", message), + Self::LikelyWebsocketAuthentication401 => write!(f, "Likely websocket authentication 401 error (probably Grok authentication issue with cookies)"), + Self::LikelyWebsocketCloudflare403 => write!(f, "Likely Cloudflare 403 error on websocket upgrade"), + Self::UnexpectedWebsocketUpgradeStatusCode(status) => write!(f, "Unexpected websocket upgrade status code: {}", status), + Self::SerdeResponseParseErrorWithBody(err, body) => write!(f, "Failed to parse response body: {:?}. Body: {}", err, body), + Self::SerdeParseErrorWithBodyOnNon200(err, body) => write!(f, "Failed to parse non-200 response body: {:?}. Body: {}", err, body), + Self::UncategorizedBadResponseWithStatus(status) => write!(f, "Uncategorized with status code: {}", status), + Self::UncategorizedBadResponseWithStatusAndBody { status_code, body } => write!(f, "Uncategorized bad response: status code {}, body: {}", status_code, body), + Self::UploadFailed => write!(f, "Upload failed"), + Self::UnexpectedWebsocketErrorFrame { body } => write!(f, "Unexpected websocket error frame: {}", body), + Self::WreqWebsocketUpgradeError(err) => write!(f, "Websocket upgrade error: {}", err), + Self::WreqError(err) => write!(f, "Wreq client error: {}", err), + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/error/grok_specific_api_error.rs b/crates/api_clients/grok_consumer_client/src/error/grok_specific_api_error.rs new file mode 100644 index 00000000..70310177 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/error/grok_specific_api_error.rs @@ -0,0 +1,108 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum GrokSpecificApiError { + /// Grok is detecting and blocking our bot, likely due to new secrets use. + AutomationBlocked, + + /// Too many videos are being generated. + TooManyVideos, + + /// The image websocket rejected the prompt because the account's image + /// generation rate limit / quota is exhausted. Carries the full raw error + /// frame the server sent. + ImageRateLimitExceeded { + body: String, + }, + + /// The `x-statsig-id` request signature was missing, stale, or invalid. + /// Grok gates its chat/generation POST endpoints on a signature that can + /// only be produced inside a real browser DOM (see the `grok_consumer_statsig` crate), + /// so this fires when we send a bad one — e.g. the 403 "This page is out of + /// date. Reload to continue." Carries the HTTP status and full response body + /// so new/changed notices can be inspected. + StatsigSignatureRejected { + status_code: u16, + body: String, + }, + + /// The requested video resolution (e.g. `1080p`) is not available on the + /// account's current plan. Observed as a 403 whose body reads + /// "1080p video generation is not available on your current plan. Use 720p + /// instead." Carries the HTTP status and full response body. + VideoResolutionNotAllowed { + status_code: u16, + body: String, + }, + + +// /// Failed to generate a bearer token despite the `200 OK` response. +// /// This has been generated by sending old/expired session cookies or empty cookies. +// FailedToGenerateBearerToken, +// +// /// The endpoint told us we used an invalid JWT. +// InvalidJwt, +// +// /// Sora has responded with "sentinel block". +// /// This usually means we need to refresh our sentinel token. +// SentinelBlockError, +// +// /// Sora requires users to set up an account username before they can generate images. +// /// This requires the user to set up that username. +// SoraUsernameNotYetCreated, +// +// /// Sora has responded with "token expired". +// /// This (probably?) means we need to refresh our JWT bearer token. +// TokenExpiredError, +// +// /// We're sending too many tasks to Sora. +// /// Sora is telling us to cool it. +// TooManyConcurrentTasks, +// +// // TODO: Try to make concrete error types for these distinct cases. +// /// Unauthorized, cookie and/or bearer token expired. We'll need to ask for a refreshed login. +// /// +// /// Example message, e.g. from the upload endpoint: +// /// { +// /// "error": { +// /// "message": "Your authentication token has expired. Please try signing in again.", +// /// "type": "invalid_request_error", +// /// "param": null, +// /// "code": "token_expired" +// /// } +// /// } +// UnauthorizedCookieOrBearerExpired, +// +// /// The Sora sentinel token response is missing fields +// SentinelResponseIsMissingFields { +// missing_token: bool, +// missing_turnstile: bool, +// raw_response: String, +// }, +} + +impl Error for GrokSpecificApiError {} + +impl Display for GrokSpecificApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::AutomationBlocked => write!(f, "Automation blocked"), + Self::TooManyVideos => write!(f, "Too many videos are being generated"), + Self::ImageRateLimitExceeded { body } => write!(f, "Image rate limit / quota exceeded. Raw frame: {}", body), + Self::StatsigSignatureRejected { status_code, body } => write!(f, "Statsig (x-statsig-id) signature rejected (HTTP {}). Body: {}", status_code, body), + Self::VideoResolutionNotAllowed { status_code, body } => write!(f, "Video resolution not available on the current plan (HTTP {}). Body: {}", status_code, body), + + //Self::FailedToGenerateBearerToken => write!(f, "Failed to generate bearer token. Probably invalid or expired session cookies."), + //Self::InvalidJwt => write!(f, "Invalid JWT token. Please refresh the token."), + //Self::SentinelBlockError => write!(f, "Request blocked by Sentinel Token Block. Please refresh the sentinel token."), + //Self::SoraUsernameNotYetCreated => write!(f, "Sora username not yet created. Please create a username in the Sora app or website."), + //Self::TokenExpiredError => write!(f, "JWT token has expired. Please refresh the token."), + //Self::TooManyConcurrentTasks => write!(f, "Too many concurrent tasks. Please wait."), + //Self::UnauthorizedCookieOrBearerExpired => write!(f, "Unauthorized: cookie and/or bearer token expired"), + //Self::SentinelResponseIsMissingFields { missing_token: token_missing, missing_turnstile: turnstile_missing, raw_response } => { + // write!(f, "Sentinel response is missing fields. token_missing: {}, turnstile_missing: {}. Raw response: {}", token_missing, turnstile_missing, raw_response) + //}, + } + } +} diff --git a/crates/api_clients/grok_consumer_client/src/error/mod.rs b/crates/api_clients/grok_consumer_client/src/error/mod.rs new file mode 100644 index 00000000..97c7749f --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/error/mod.rs @@ -0,0 +1,5 @@ +pub mod grok_client_error; +pub mod grok_error; +pub mod grok_generic_api_error; +pub mod grok_specific_api_error; +pub (crate) mod categorize_grok_http_error; \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/src/lib.rs b/crates/api_clients/grok_consumer_client/src/lib.rs new file mode 100644 index 00000000..f9e4095c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/lib.rs @@ -0,0 +1,16 @@ +//! A Grok API client. + +#[cfg(test)] +pub (crate) mod test_utils; + +// Library utils +pub mod client; + +// User lib +pub mod credentials; +pub mod datatypes; +pub mod error; +pub mod recipes; +pub mod endpoint_bindings; +pub mod prompt_flags; +pub mod utils; diff --git a/crates/api_clients/grok_consumer_client/src/prompt_flags/generation_mode.rs b/crates/api_clients/grok_consumer_client/src/prompt_flags/generation_mode.rs new file mode 100644 index 00000000..3665081e --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/prompt_flags/generation_mode.rs @@ -0,0 +1,45 @@ +/// The `--mode` selector Grok appends to an image/video prompt to choose the +/// generation style. Wire values confirmed from real Imagine captures +/// (2026-08-24): image gen sends e.g. `"woman on beach --mode=extremely-spicy-or-crazy"`, +/// and video gen sends `" --mode=custom"` / `"--mode=normal"`. +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum GenerationMode { + /// `--mode=normal` — the default, safe style. + Normal, + + /// `--mode=extremely-crazy` — the "fun" style. + Fun, + + /// `--mode=extremely-spicy-or-crazy` — the "spicy" / NSFW style. + Spicy, + + /// `--mode=custom` — honors the caller's text prompt (the other modes lean on + /// their own styling). Video text-to-video uses this. + Custom, +} + +impl GenerationMode { + /// The value used after `--mode=` (and, for image-to-video, in the structured + /// `mode` field). + pub fn as_flag_value(self) -> &'static str { + match self { + Self::Normal => "normal", + Self::Fun => "extremely-crazy", + Self::Spicy => "extremely-spicy-or-crazy", + Self::Custom => "custom", + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn flag_values_match_captures() { + assert_eq!(GenerationMode::Normal.as_flag_value(), "normal"); + assert_eq!(GenerationMode::Fun.as_flag_value(), "extremely-crazy"); + assert_eq!(GenerationMode::Spicy.as_flag_value(), "extremely-spicy-or-crazy"); + assert_eq!(GenerationMode::Custom.as_flag_value(), "custom"); + } +} diff --git a/crates/api_clients/grok_consumer_client/src/prompt_flags/mod.rs b/crates/api_clients/grok_consumer_client/src/prompt_flags/mod.rs new file mode 100644 index 00000000..b745010c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/prompt_flags/mod.rs @@ -0,0 +1,12 @@ +//! Grok "Imagine" prompt flags: the `--flag=value` long args Grok reads out of +//! the prompt *text* to control image/video generation (e.g. `--mode`). +//! +//! Build a final prompt with [`PromptFlags::apply_to`]; both the image websocket +//! and the video binding funnel their prompt construction through this so it is +//! defined and tested in one place. + +mod generation_mode; +mod prompt_flags; + +pub use generation_mode::GenerationMode; +pub use prompt_flags::PromptFlags; diff --git a/crates/api_clients/grok_consumer_client/src/prompt_flags/prompt_flags.rs b/crates/api_clients/grok_consumer_client/src/prompt_flags/prompt_flags.rs new file mode 100644 index 00000000..7e72be58 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/prompt_flags/prompt_flags.rs @@ -0,0 +1,106 @@ +use crate::prompt_flags::generation_mode::GenerationMode; + +/// Long-argument flags Grok reads out of the *prompt text* itself. The web app +/// mutates a prompt into e.g. `"woman on beach --mode=extremely-spicy-or-crazy"` +/// before sending it, for both image and video generation. +/// +/// Callers set the flags they want and call [`apply_to`](Self::apply_to) to get +/// the final prompt string. This keeps prompt construction in one place and +/// unit-testable, separate from the request wire structs. +/// +/// `Default` is "no flags" — [`apply_to`](Self::apply_to) then returns the +/// prompt unchanged (trimmed). +#[derive(Clone, Debug, Default, PartialEq, Eq)] +pub struct PromptFlags { + /// `--mode=` — the generation style. `None` appends no `--mode`. + pub mode: Option, + // Additional `--flag` long args go here as they are confirmed from captures / + // reference clients; `long_args` and `apply_to` pick them up automatically. +} + +impl PromptFlags { + /// Flags carrying just a `--mode`. + pub fn with_mode(mode: GenerationMode) -> Self { + Self { mode: Some(mode) } + } + + /// Whether no flags are set (so [`apply_to`](Self::apply_to) is a no-op). + pub fn is_empty(&self) -> bool { + self.long_args().is_empty() + } + + /// Append the set flags to `prompt`, yielding the final text Grok expects, + /// e.g. `apply_to("woman on beach")` → `"woman on beach --mode=..."`. + /// + /// The prompt is trimmed; flags are space-separated after it. An empty prompt + /// yields just the flags (no leading space), matching the web app's bare + /// image-to-video frame `"--mode=normal"`. + pub fn apply_to(&self, prompt: &str) -> String { + append_long_args(prompt, &self.long_args()) + } + + /// The ordered `(name, value)` long args this set produces. Order is fixed so + /// output is deterministic (and testable). + fn long_args(&self) -> Vec<(&'static str, LongArgValue)> { + let mut args: Vec<(&'static str, LongArgValue)> = Vec::new(); + if let Some(mode) = self.mode { + args.push(("mode", LongArgValue::Equals(mode.as_flag_value()))); + } + args + } +} + +/// A `--flag` may be bare (`--foo`) or take a value (`--foo=bar`). +enum LongArgValue { + #[allow(dead_code)] // used once a bare-flag is added + Bare, + Equals(&'static str), +} + +/// Append `--name` / `--name=value` long args to `prompt`. Shared mechanical +/// core so the string-building rules live (and are tested) in one place. +fn append_long_args(prompt: &str, args: &[(&str, LongArgValue)]) -> String { + let mut out = prompt.trim().to_string(); + for (name, value) in args { + if !out.is_empty() { + out.push(' '); + } + out.push_str("--"); + out.push_str(name); + if let LongArgValue::Equals(value) = value { + out.push('='); + out.push_str(value); + } + } + out +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn no_flags_returns_trimmed_prompt() { + assert_eq!(PromptFlags::default().apply_to(" a red kite "), "a red kite"); + assert!(PromptFlags::default().is_empty()); + } + + #[test] + fn mode_is_appended_as_long_arg() { + assert_eq!( + PromptFlags::with_mode(GenerationMode::Spicy).apply_to("woman on beach"), + "woman on beach --mode=extremely-spicy-or-crazy", + ); + assert_eq!( + PromptFlags::with_mode(GenerationMode::Custom).apply_to("An asteroid hits the city."), + "An asteroid hits the city. --mode=custom", + ); + } + + #[test] + fn empty_prompt_yields_bare_flags() { + // Matches the web app's bare image-to-video frame. + assert_eq!(PromptFlags::with_mode(GenerationMode::Normal).apply_to(""), "--mode=normal"); + assert_eq!(PromptFlags::with_mode(GenerationMode::Normal).apply_to(" "), "--mode=normal"); + } +} diff --git a/crates/api_clients/grok_consumer_client/src/recipes/_metadata/video_gen_request_flows.md b/crates/api_clients/grok_consumer_client/src/recipes/_metadata/video_gen_request_flows.md new file mode 100644 index 00000000..e6e7290d --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/recipes/_metadata/video_gen_request_flows.md @@ -0,0 +1,93 @@ +Upload Image -> Video Flow +========================== + +1. Upload Image + + Endpoint: https://grok.com/rest/app-chat/upload-file + + Response Fields: + { + **"fileMetadataId": "21a79085-e206-4b0b-88ac-5f2b7a453e45",** + **"fileUri": "users/85980643-ffab-4984-a3de-59a608c47d7f/21a79085-e206-4b0b-88ac-5f2b7a453e45/content",** + "fileMimeType": "image/jpeg", + "fileName": "0_0.jpeg", + "parsedFileUri": "", + "createTime": "2025-10-21T23:40:41.784448Z", + "fileSource": "SELF_UPLOAD_FILE_SOURCE" + } + + + File becomes a 480x640 copy: + + https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/21a79085-e206-4b0b-88ac-5f2b7a453e45/content + +2. "Create Media Post" **(needed?)** + + Endpoint: https://grok.com/rest/media/post/create + + Request Fields: + { + "mediaType": "MEDIA_POST_TYPE_IMAGE", + "mediaUrl": "https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/21a79085-e206-4b0b-88ac-5f2b7a453e45/content" + } + + Response: + { + "post": { + "id": "21a79085-e206-4b0b-88ac-5f2b7a453e45", + "userId": "85980643-ffab-4984-a3de-59a608c47d7f", + "createTime": "2025-10-21T23:40:41.993980477Z", + "prompt": "", + "mediaType": "MEDIA_POST_TYPE_IMAGE", + "mediaUrl": "https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/21a79085-e206-4b0b-88ac-5f2b7a453e45/content", + "mimeType": "image/jpeg", + "audioUrls": [], + "childPosts": [] + } + } + +3. Chat Conversation for Video + + Endpoint: https://grok.com/rest/app-chat/conversations/new + + Request: + { + "temporary":true, + "modelName":"grok-3", + "message":"https://assets.grok.com/users/85980643-ffab-4984-a3de-59a608c47d7f/21a79085-e206-4b0b-88ac-5f2b7a453e45/content --mode=normal", + "fileAttachments":["21a79085-e206-4b0b-88ac-5f2b7a453e45"], + "toolOverrides": { + "videoGen":true + } + } + +Header 'x-xai-request-id: 7cb93340-5fb6-4fb3-b88d-ff9f5d99d456' is just a random UUID and it can be changed. + + +Generate Image -> Video Flow +============================ + +(TODO) + +2. Create Media Post + + Request + { + "mediaType": "MEDIA_POST_TYPE_IMAGE", + "mediaUrl":"https://imagine-public.x.ai/imagine-public/images/2d8260d7-3b7c-4bc1-84ca-6e82dd892c39.png" + } + + +3. Chat Conversation for Video + + Endpoint: https://grok.com/rest/app-chat/conversations/new + + Request: + { + "temporary": true, + "modelName": "grok-3", + "message": "https://imagine-public.x.ai/imagine-public/images/2d8260d7-3b7c-4bc1-84ca-6e82dd892c39.png alien walks down the hallway --mode=custom", + "toolOverrides": { + "videoGen":true + } + } diff --git a/crates/api_clients/grok_consumer_client/src/recipes/mod.rs b/crates/api_clients/grok_consumer_client/src/recipes/mod.rs new file mode 100644 index 00000000..52e71093 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/recipes/mod.rs @@ -0,0 +1 @@ +pub mod request_client_secrets; diff --git a/crates/api_clients/grok_consumer_client/src/recipes/request_client_secrets.rs b/crates/api_clients/grok_consumer_client/src/recipes/request_client_secrets.rs new file mode 100644 index 00000000..c14f9d06 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/recipes/request_client_secrets.rs @@ -0,0 +1,75 @@ +use crate::credentials::grok_client_secrets::GrokClientSecrets; +use crate::credentials::grok_cookies::GrokCookies; +use crate::error::grok_error::GrokError; +use crate::error::grok_generic_api_error::GrokGenericApiError; +use crate::endpoint_bindings::old_bindings::index_page::get_index_page::{get_index, GetIndexPageArgs}; +use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_baggage::parse_index_baggage; +use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_sentry_trace::parse_index_sentry_trace; +use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_user_email::parse_index_user_email; +use crate::endpoint_bindings::old_bindings::index_page::parsers::index::parse_index_user_id::parse_index_user_id; + +pub struct RequestClientSecretsArgs<'a> { + pub cookies: &'a GrokCookies, +} + +/// Load the per-session secrets Grok's web app reads out of `index.html`: +/// tracing headers (`baggage`, `sentry_trace`) and the signed-in user's +/// id/email. The `x-statsig-id` request signature is *not* derived here — it is +/// minted by a real browser (see the `grok_consumer_statsig` crate) and passed +/// through [`GrokRequestHeaders`](crate::credentials::grok_request_headers). +pub async fn request_client_secrets(args: RequestClientSecretsArgs<'_>) -> Result { + let index = get_index(GetIndexPageArgs { + cookie: args.cookies.as_str(), + }).await?; + let html = &index.body; + + let baggage = parse_index_baggage(html) + .ok_or_else(|| GrokGenericApiError::IndexHtmlDidNotIncludeExpectedData { + message: "Index did not include baggage.".to_string() + })?; + + let sentry_trace = parse_index_sentry_trace(html) + .ok_or_else(|| GrokGenericApiError::IndexHtmlDidNotIncludeExpectedData { + message: "Index did not include sentry trace.".to_string() + })?; + + let user_id = parse_index_user_id(html) + .ok_or_else(|| GrokGenericApiError::IndexHtmlDidNotIncludeExpectedData { + message: "Index did not include user id.".to_string() + })?; + + // NB: Optional. + let maybe_user_email = parse_index_user_email(html); + + Ok(GrokClientSecrets { + baggage, + sentry_trace, + user_id, + user_email: maybe_user_email, + }) +} + +#[cfg(test)] +mod tests { + use crate::recipes::request_client_secrets::{request_client_secrets, RequestClientSecretsArgs}; + use crate::test_utils::grok_test_secrets::load_grok_test_secrets; + use errors::AnyhowResult; + + #[tokio::test] + #[ignore] // Manual test invocation + async fn test() -> AnyhowResult<()> { + let cookies = load_grok_test_secrets()?.cookies; + + let secrets = request_client_secrets(RequestClientSecretsArgs { + cookies: &cookies, + }).await?; + + println!("Baggage: {:?}", secrets.baggage); + println!("Sentry trace: {:?}", secrets.sentry_trace); + println!("User ID: {:?}", secrets.user_id); + println!("User Email: {:?}", secrets.user_email); + + assert_eq!(1, 2); + Ok(()) + } +} diff --git a/crates/api_clients/grok_consumer_client/src/test_utils/grok_test_secrets.rs b/crates/api_clients/grok_consumer_client/src/test_utils/grok_test_secrets.rs new file mode 100644 index 00000000..877d023c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/test_utils/grok_test_secrets.rs @@ -0,0 +1,66 @@ +//! Test-only loader for the browser-captured Grok secrets kept off to the +//! side in the (gitignored) `external/credentials/grok` directory. +//! +//! Live-wire tests load these to talk to the real website. The files hold a +//! single real session's cookies and header secrets; regenerate them when +//! they expire. + +use crate::credentials::grok_cookies::GrokCookies; +use crate::credentials::grok_request_headers::GrokRequestHeaders; +use errors::AnyhowResult; +use serde::Deserialize; +use std::fs::read_to_string; + +/// Repo-root-relative directory holding the captured secrets. Resolved from +/// this crate's manifest dir (`crates/api_clients/grok_consumer_client`), so +/// tests work regardless of the shell's working directory. +const SECRETS_DIR: &str = concat!( + env!("CARGO_MANIFEST_DIR"), + "/../../../external/credentials/grok", +); + +/// A loaded browser session: cookies plus the captured request headers. +pub struct GrokTestSecrets { + pub cookies: GrokCookies, + pub headers: GrokRequestHeaders, +} + +/// TOML shape of `external/credentials/grok/headers.toml`. +#[derive(Deserialize)] +struct HeadersToml { + statsig_id: Option, + xai_request_id: Option, + traceparent: Option, + sentry_trace: Option, +} + +/// Load the captured cookies and header secrets. +/// +/// Errors (with a pointer to the directory) if the files are missing — that +/// means the secrets haven't been captured yet, which is expected on a fresh +/// checkout since they're gitignored. +pub fn load_grok_test_secrets() -> AnyhowResult { + let cookies_path = format!("{SECRETS_DIR}/cookies.txt"); + let headers_path = format!("{SECRETS_DIR}/headers.toml"); + + let cookies_raw = read_to_string(&cookies_path).map_err(|err| { + anyhow::anyhow!("Could not read Grok test cookies at {cookies_path}: {err}") + })?; + let cookies = GrokCookies::new(cookies_raw.trim().to_string()); + + let headers_raw = read_to_string(&headers_path).map_err(|err| { + anyhow::anyhow!("Could not read Grok test headers at {headers_path}: {err}") + })?; + let parsed: HeadersToml = toml::from_str(&headers_raw).map_err(|err| { + anyhow::anyhow!("Could not parse Grok test headers at {headers_path}: {err}") + })?; + + let headers = GrokRequestHeaders { + statsig_id: parsed.statsig_id, + xai_request_id: parsed.xai_request_id, + traceparent: parsed.traceparent, + sentry_trace: parsed.sentry_trace, + }; + + Ok(GrokTestSecrets { cookies, headers }) +} diff --git a/crates/api_clients/grok_consumer_client/src/test_utils/mod.rs b/crates/api_clients/grok_consumer_client/src/test_utils/mod.rs new file mode 100644 index 00000000..6b22e9d6 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/test_utils/mod.rs @@ -0,0 +1,5 @@ +#[cfg(test)] +pub (crate) mod grok_test_secrets; + +#[cfg(test)] +pub (crate) mod setup_test_logging; diff --git a/crates/api_clients/grok_consumer_client/src/test_utils/setup_test_logging.rs b/crates/api_clients/grok_consumer_client/src/test_utils/setup_test_logging.rs new file mode 100644 index 00000000..5691b9e4 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/test_utils/setup_test_logging.rs @@ -0,0 +1,54 @@ +use chrono::Local; +use env_logger::Builder; +use log::{debug, error, info, trace, warn, LevelFilter}; +use std::io::Write; + +const RUST_LOG : &str = "RUST_LOG"; + +pub fn setup_test_logging(level: LevelFilter) { + let level_str = get_level_str(level); + + println!("Previous log level: {:?}", env::var(RUST_LOG)); + + let is_unsafe = env::set_var(RUST_LOG, level_str); + + if is_unsafe.is_none() { + println!("Unsafely setting Rust Log Level..."); + unsafe { std::env::set_var(RUST_LOG, level_str) } + } + + println!("Log level: {:?}", env::var(RUST_LOG)); + + // `try_init` (not `init`) so repeated calls are a no-op instead of a panic + // — several tests in one process (e.g. `--test-threads=1`) each call this. + let _ = Builder::new() + .is_test(true) + .format(|buf, record| { + writeln!(buf, + "{} [{}] - {}", + Local::now().format("%H:%M:%S%.6f"), + record.level(), + record.args() + ) + }) + .filter(None, level) + .filter_level(level) + .try_init(); + + trace!("Test trace log"); + debug!("Test debug log"); + info!("Test info log"); + warn!("Test warn log"); + error!("Test error log"); +} + +fn get_level_str(level: LevelFilter) -> &'static str { + match level { + LevelFilter::Error => "error", + LevelFilter::Warn => "warn", + LevelFilter::Info => "info", + LevelFilter::Debug => "debug", + LevelFilter::Trace => "trace", + LevelFilter::Off => "off", + } +} diff --git a/crates/api_clients/grok_consumer_client/src/utils/create_firefox_client.rs b/crates/api_clients/grok_consumer_client/src/utils/create_firefox_client.rs new file mode 100644 index 00000000..c3ade7e3 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/utils/create_firefox_client.rs @@ -0,0 +1,10 @@ +use crate::error::grok_client_error::GrokClientError; +use wreq::Client; +use wreq_util::Emulation; + +pub fn create_firefox_client() -> Result { + Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| GrokClientError::WreqClientError(err)) +} diff --git a/crates/api_clients/grok_consumer_client/src/utils/mod.rs b/crates/api_clients/grok_consumer_client/src/utils/mod.rs new file mode 100644 index 00000000..22c38941 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/utils/mod.rs @@ -0,0 +1,6 @@ +pub mod user_and_file_id_to_image_url; +pub mod user_and_file_id_to_video_url; + +// Just for the crate +pub (crate) mod create_firefox_client; +pub (crate) mod scrub_blobs_for_debug_logging; diff --git a/crates/api_clients/grok_consumer_client/src/utils/scrub_blobs_for_debug_logging.rs b/crates/api_clients/grok_consumer_client/src/utils/scrub_blobs_for_debug_logging.rs new file mode 100644 index 00000000..fa1d3404 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/utils/scrub_blobs_for_debug_logging.rs @@ -0,0 +1,12 @@ +use once_cell::sync::Lazy; +use regex::Regex; + +static LARGE_BLOB_REGEX: Lazy = Lazy::new(|| { + Regex::new(r#"[^"]{100,}"#) + .expect("Regex should parse") +}); + +/// Helpful for debugging large websocket payloads with in-stream base64-encoded image binaries. +pub fn scrub_blobs_for_debug_logging(blob: &str) -> String { + LARGE_BLOB_REGEX.replace(blob, "...").to_string() +} diff --git a/crates/api_clients/grok_consumer_client/src/utils/user_and_file_id_to_image_url.rs b/crates/api_clients/grok_consumer_client/src/utils/user_and_file_id_to_image_url.rs new file mode 100644 index 00000000..f2a594c2 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/utils/user_and_file_id_to_image_url.rs @@ -0,0 +1,25 @@ +use crate::datatypes::api::file_id::FileId; +use crate::datatypes::api::user_id::UserId; + +/// Return media URLs to images given the user and file IDs. +/// These are non-public and will return 403s unless you're logged in. +pub fn user_and_file_id_to_image_url(user: &UserId, file: &FileId) -> String { + let user_id = &user.0; + let file_id = &file.0; + format!("https://assets.grok.com/users/{user_id}/{file_id}/content") +} + +#[cfg(test)] +mod tests { + use crate::datatypes::api::file_id::FileId; + use crate::datatypes::api::user_id::UserId; + use crate::utils::user_and_file_id_to_image_url::user_and_file_id_to_image_url; + + #[test] + fn test_url() { + let user = UserId(String::from("USER_UUID")); + let file = FileId(String::from("FILE_UUID")); + let url = user_and_file_id_to_image_url(&user, &file); + assert_eq!(&url, "https://assets.grok.com/users/USER_UUID/FILE_UUID/content"); + } +} diff --git a/crates/api_clients/grok_consumer_client/src/utils/user_and_file_id_to_video_url.rs b/crates/api_clients/grok_consumer_client/src/utils/user_and_file_id_to_video_url.rs new file mode 100644 index 00000000..07fa4387 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/src/utils/user_and_file_id_to_video_url.rs @@ -0,0 +1,32 @@ +use crate::datatypes::api::file_id::FileId; +use crate::datatypes::api::user_id::UserId; + +/// Return media URLs to images given the user and file IDs. +/// These are non-public and will return 403s unless you're logged in. +pub fn user_and_file_id_to_video_url(user: &UserId, file: &FileId, cache_bust: bool) -> String { + let user_id = &user.0; + let file_id = &file.0; + if cache_bust { + format!("https://assets.grok.com/users/{user_id}/generated/{file_id}/generated_video.mp4?cache=1") + } else { + format!("https://assets.grok.com/users/{user_id}/generated/{file_id}/generated_video.mp4") + } +} + +#[cfg(test)] +mod tests { + use crate::datatypes::api::file_id::FileId; + use crate::datatypes::api::user_id::UserId; + use crate::utils::user_and_file_id_to_video_url::user_and_file_id_to_video_url; + + #[test] + fn test_url() { + let user = UserId(String::from("USER_UUID")); + let file = FileId(String::from("FILE_UUID")); + let url = user_and_file_id_to_video_url(&user, &file, false); + assert_eq!(&url, "https://assets.grok.com/users/USER_UUID/generated/FILE_UUID/generated_video.mp4"); + + let url = user_and_file_id_to_video_url(&user, &file, true); + assert_eq!(&url, "https://assets.grok.com/users/USER_UUID/generated/FILE_UUID/generated_video.mp4?cache=1"); + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_generation_request.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_generation_request.json new file mode 100644 index 00000000..981daf7e --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_generation_request.json @@ -0,0 +1,25 @@ +{ + "modelName": "imagine-video-gen", + "message": "--mode=normal", + "enableImageStreaming": true, + "enableSideBySide": true, + "sendFinalMetadata": true, + "responseMetadata": { + "experiments": [], + "modelConfigOverride": { + "modelMap": {} + } + }, + "mediaGenInput": { + "imageToVideo": { + "inputAssets": [ + "11111111-1111-4111-8111-111111111111" + ], + "aspectRatio": "3:2", + "duration": 6, + "resolutionName": "480p", + "mode": "normal" + } + }, + "kind": "CONVERSATION_KIND_IMAGINE" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_text_request.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_text_request.json new file mode 100644 index 00000000..cb62bdd6 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_text_request.json @@ -0,0 +1,22 @@ +{ + "modelName": "imagine-video-gen", + "message": "An asteroid hits the city. --mode=custom", + "enableImageStreaming": true, + "enableSideBySide": true, + "sendFinalMetadata": true, + "responseMetadata": { + "experiments": [], + "modelConfigOverride": { + "modelMap": {} + } + }, + "mediaGenInput": { + "textToVideo": { + "prompt": "An asteroid hits the city.", + "aspectRatio": "2:3", + "duration": 6, + "resolutionName": "480p" + } + }, + "kind": "CONVERSATION_KIND_IMAGINE" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_upload_request.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_upload_request.json new file mode 100644 index 00000000..35e2c71a --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_from_upload_request.json @@ -0,0 +1,26 @@ +{ + "modelName": "imagine-video-gen", + "message": "Windmill spins as the camera orbits the night scene. Stars above. --mode=custom", + "enableImageStreaming": true, + "enableSideBySide": true, + "sendFinalMetadata": true, + "responseMetadata": { + "experiments": [], + "modelConfigOverride": { + "modelMap": {} + } + }, + "mediaGenInput": { + "imageToVideo": { + "prompt": "Windmill spins as the camera orbits the night scene. Stars above.", + "inputAssets": [ + "22222222-2222-4222-8222-222222222222" + ], + "aspectRatio": "3:2", + "duration": 6, + "resolutionName": "720p", + "mode": "custom" + } + }, + "kind": "CONVERSATION_KIND_IMAGINE" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_response.txt b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_response.txt new file mode 100644 index 00000000..ee146d07 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/generate_video_response.txt @@ -0,0 +1,6 @@ +{"result":{"conversation":{"conversationId":"8b592ec5-b3ec-4cb4-b1f3-ddfd87b20625","title":"New conversation","starred":false,"createTime":"2026-08-23T22:41:35.874748Z","modifyTime":"2026-08-23T22:41:35.875128Z","systemPromptName":"","temporary":false,"mediaTypes":[],"workspaces":[],"taskResult":null,"latestAssetMetadata":null,"viewerIsOwner":true,"kind":"CONVERSATION_KIND_IMAGINE"}}} +{"result":{"response":{"userResponse":{"responseId":"7426dbb7-d581-46b4-86cd-65b60bef9777","message":"--mode=normal","sender":"human","createTime":"2026-08-23T22:41:35.903Z","manual":false,"partial":false,"shared":false,"query":"","queryType":"","webSearchResults":[],"xpostIds":[],"xposts":[],"generatedImageUrls":[],"imageAttachments":[],"fileAttachments":["1e4ad316-b2dd-4d66-83f0-3ec719263ec1"],"cardAttachmentsJson":[],"fileUris":[],"fileAttachmentsMetadata":[],"isControl":false,"steps":[],"imageEditUris":[],"mediaTypes":[],"webpageUrls":[],"metadata":{"experiments":[],"modelConfigOverride":{"modelMap":{"videoGenModelConfig":{"aspectRatio":"3:2","imageReferences":["https://assets.grok.com/users/_/1e4ad316-b2dd-4d66-83f0-3ec719263ec1/content"],"isRootCelebrity":false,"isRootUserUploaded":false,"isVideoExtension":false,"isVideoRemix":false,"parentPostId":null,"resolutionName":"480p","resolvedImageReferences":["https://assets.grok.com/users/00000000-0000-4000-8000-000000000000/generated/1e4ad316-b2dd-4d66-83f0-3ec719263ec1/image.jpg"],"videoLength":6}}}},"citedWebSearchResults":[],"toolResponses":[],"model":"imagine-video-gen","ragResults":[],"citedRagResults":[],"searchProductResults":[],"connectorSearchResults":[],"collectionSearchResults":[],"streamErrors":[],"citedXposts":[],"citedConnectorSearchResults":[],"citedCollectionSearchResults":[],"inputChunks":[],"outputChunks":[],"mediaGenInput":{"imageToVideo":{"inputAssets":["1e4ad316-b2dd-4d66-83f0-3ec719263ec1"],"aspectRatio":"3:2","duration":6,"resolutionName":"480p","modelName":"imagine-video-gen","mode":"normal","skipAudio":false}},"fileAttachmentAssetMetadata":[],"fileIds":[]},"isThinking":false,"isSoftStop":false,"responseId":"7426dbb7-d581-46b4-86cd-65b60bef9777"}}} +{"result":{"response":{"streamingVideoGenerationResponse":{"videoId":"1622a562-971d-479b-b4be-44c96f3cd813","progress":1,"audioUrls":[],"videoPrompt":"","imageReference":"https://assets.grok.com/users/00000000-0000-4000-8000-000000000000/generated/1e4ad316-b2dd-4d66-83f0-3ec719263ec1/image.jpg","audioTranscripts":[],"moderated":false,"mode":"normal","videoPostId":"1622a562-971d-479b-b4be-44c96f3cd813","height":352,"width":832,"resolutionName":"480p"},"isThinking":false,"isSoftStop":false,"responseId":"208cf8e0-bd51-4e22-832a-1c388b36ba23"}}} +{"result":{"response":{"streamingVideoGenerationResponse":{"videoId":"1622a562-971d-479b-b4be-44c96f3cd813","progress":50,"audioUrls":[],"videoPrompt":"","imageReference":"https://assets.grok.com/users/00000000-0000-4000-8000-000000000000/generated/1e4ad316-b2dd-4d66-83f0-3ec719263ec1/image.jpg","audioTranscripts":[],"moderated":false,"mode":"normal","videoPostId":"1622a562-971d-479b-b4be-44c96f3cd813","height":352,"width":832,"resolutionName":"480p"},"isThinking":false,"isSoftStop":false,"responseId":"208cf8e0-bd51-4e22-832a-1c388b36ba23"}}} +{"result":{"response":{"streamingVideoGenerationResponse":{"videoId":"1622a562-971d-479b-b4be-44c96f3cd813","progress":100,"assetId":"1622a562-971d-479b-b4be-44c96f3cd813","videoUrl":"users/00000000-0000-4000-8000-000000000000/generated/1622a562-971d-479b-b4be-44c96f3cd813/generated_video.mp4","audioUrls":[],"videoPrompt":"","imageReference":"https://assets.grok.com/users/00000000-0000-4000-8000-000000000000/generated/1e4ad316-b2dd-4d66-83f0-3ec719263ec1/image.jpg","audioTranscripts":[],"moderated":false,"mode":"normal","thumbnailImageUrl":"users/00000000-0000-4000-8000-000000000000/generated/1622a562-971d-479b-b4be-44c96f3cd813/preview_image.jpg","videoPostId":"1622a562-971d-479b-b4be-44c96f3cd813","rRated":false,"height":352,"width":832,"resolutionName":"480p","isRootUserUploaded":false},"isThinking":false,"isSoftStop":false,"responseId":"208cf8e0-bd51-4e22-832a-1c388b36ba23"}}} +{"result":{"title":{"newTitle":"Video Generation with AI Mode"}}} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/list_assets.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/list_assets.json new file mode 100644 index 00000000..853f24d1 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/list_assets.json @@ -0,0 +1,100 @@ +{ + "assets": [ + { + "assetId": "98db6014-be3a-4c92-9aec-91c80123ccac", + "mimeType": "video/mp4", + "name": "generated_video.mp4", + "sizeBytes": 5800655, + "createTime": "2026-08-23T20:01:10.223Z", + "lastUseTime": "2026-08-23T20:01:10.235Z", + "summary": "", + "previewImageKey": "", + "key": "users/00000000-0000-4000-8000-000000000000/generated/98db6014-be3a-4c92-9aec-91c80123ccac/generated_video.mp4", + "auxKeys": { + "image_edit_is_root_user_uploaded": "false", + "image_references": "[\"https://assets.grok.com/users/00000000-0000-4000-8000-000000000000/generated/d3d5e751-b4a7-4683-9d09-df7d5bc37f74/image.jpg\"]", + "is_ext": "false", + "is_root_celebrity": "false", + "moderated": "false", + "preview-image": "users/00000000-0000-4000-8000-000000000000/generated/98db6014-be3a-4c92-9aec-91c80123ccac/preview_image.jpg", + "thumbhash": "DvgJBIAHZ4iOhImJhnn2cY0Ldw==" + }, + "responseId": "07091ea3-8286-4e37-a517-871c4820ab31", + "isDeleted": false, + "fileSource": "IMAGINE_GENERATED_FILE_SOURCE", + "sourceConversationId": "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + "isModelGenerated": true, + "updateTime": "2026-08-23T20:01:10.235Z", + "isLatest": true, + "inlineStatus": "DEFAULT_ARTIFACT_INLINE_STATUS", + "isRootAssetCreatedByModel": true, + "rootAssetSourceConversationId": "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + "sharedWithTeam": false, + "sharedWithUserIds": [], + "isPublic": false, + "width": 736, + "height": 400, + "rRated": false, + "thumbhash": "DvgJBIAHZ4iOhImJhnn2cY0Ldw==", + "mediaGenInput": { + "imageToVideo": { + "inputAssets": [ + "d3d5e751-b4a7-4683-9d09-df7d5bc37f74" + ], + "aspectRatio": "16:9", + "duration": 6, + "resolutionName": "480p", + "modelName": "imagine-video-gen", + "mode": "normal", + "skipAudio": false + } + }, + "ownerUserId": "00000000-0000-4000-8000-000000000000" + }, + { + "assetId": "8d0b3727-f040-4b33-abf0-16e7d4364e6c", + "mimeType": "image/jpeg", + "name": "image.jpg", + "sizeBytes": 517902, + "createTime": "2026-08-23T19:56:19.599Z", + "lastUseTime": "2026-08-23T19:56:19.599Z", + "summary": "", + "previewImageKey": "", + "key": "users/00000000-0000-4000-8000-000000000000/generated/8d0b3727-f040-4b33-abf0-16e7d4364e6c/image.jpg", + "auxKeys": { + "image_edit_is_root_user_uploaded": "false", + "is_root_celebrity": "false", + "moderated": "false", + "original-image": "users/00000000-0000-4000-8000-000000000000/generated/8d0b3727-f040-4b33-abf0-16e7d4364e6c/original_image.jpg", + "thumbhash": "DvgJBIAYV3iPdIeIdnjSV28HVQ==" + }, + "responseId": "781acbe5-14bc-412c-9c3d-4610b19b627d", + "isDeleted": false, + "fileSource": "IMAGINE_GENERATED_FILE_SOURCE", + "sourceConversationId": "e851b4f1-0605-4a41-b624-d629c2c1638d", + "isModelGenerated": true, + "updateTime": "2026-08-23T19:56:19.599Z", + "isLatest": true, + "inlineStatus": "DEFAULT_ARTIFACT_INLINE_STATUS", + "isRootAssetCreatedByModel": true, + "rootAssetSourceConversationId": "e851b4f1-0605-4a41-b624-d629c2c1638d", + "sharedWithTeam": false, + "sharedWithUserIds": [], + "isPublic": false, + "width": 1280, + "height": 720, + "rRated": false, + "thumbhash": "DvgJBIAYV3iPdIeIdnjSV28HVQ==", + "mediaGenInput": { + "textToImage": { + "prompt": "A pirate ship in the middle of the forest", + "numOfImages": 2, + "aspectRatio": "16:9", + "modelName": "imagine-image-gen", + "mode": "quality" + } + }, + "ownerUserId": "00000000-0000-4000-8000-000000000000" + } + ] +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/list_imagine_assets.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/list_imagine_assets.json new file mode 100644 index 00000000..6618e7aa --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/list_imagine_assets.json @@ -0,0 +1,127 @@ +{ + "conversations": [ + { + "conversationId": "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + "title": "Video Generation with AI", + "starred": false, + "createTime": "2026-08-23T20:00:41.151254Z", + "modifyTime": "2026-08-23T20:01:10.569116Z", + "systemPromptName": "", + "temporary": false, + "mediaTypes": [], + "workspaces": [], + "taskResult": {}, + "latestAssetMetadata": { + "assetId": "98db6014-be3a-4c92-9aec-91c80123ccac", + "mimeType": "video/mp4", + "name": "generated_video.mp4", + "sizeBytes": 5800655, + "createTime": "2026-08-23T20:01:10.223Z", + "lastUseTime": "2026-08-23T20:01:10.235Z", + "summary": "", + "previewImageKey": "", + "key": "users/00000000-0000-4000-8000-000000000000/generated/98db6014-be3a-4c92-9aec-91c80123ccac/generated_video.mp4", + "auxKeys": { + "image_edit_is_root_user_uploaded": "false", + "image_references": "[\"https://assets.grok.com/users/00000000-0000-4000-8000-000000000000/generated/d3d5e751-b4a7-4683-9d09-df7d5bc37f74/image.jpg\"]", + "is_ext": "false", + "is_root_celebrity": "false", + "moderated": "false", + "preview-image": "users/00000000-0000-4000-8000-000000000000/generated/98db6014-be3a-4c92-9aec-91c80123ccac/preview_image.jpg", + "thumbhash": "DvgJBIAHZ4iOhImJhnn2cY0Ldw==" + }, + "responseId": "07091ea3-8286-4e37-a517-871c4820ab31", + "isDeleted": false, + "fileSource": "IMAGINE_GENERATED_FILE_SOURCE", + "currentConversationId": "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + "sourceConversationId": "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + "isModelGenerated": true, + "updateTime": "2026-08-23T20:01:10.235Z", + "isLatest": true, + "inlineStatus": "DEFAULT_ARTIFACT_INLINE_STATUS", + "isRootAssetCreatedByModel": true, + "rootAssetSourceConversationId": "9db05fac-a4df-4a42-aa81-4dee6d37f4a8", + "sharedWithTeam": false, + "sharedWithUserIds": [], + "width": 736, + "height": 400, + "rRated": false, + "thumbhash": "DvgJBIAHZ4iOhImJhnn2cY0Ldw==", + "mediaGenInput": { + "imageToVideo": { + "inputAssets": [ + "d3d5e751-b4a7-4683-9d09-df7d5bc37f74" + ], + "aspectRatio": "16:9", + "duration": 6, + "resolutionName": "480p", + "modelName": "imagine-video-gen", + "mode": "normal", + "skipAudio": false + } + }, + "ownerUserId": "00000000-0000-4000-8000-000000000000" + }, + "kind": "CONVERSATION_KIND_IMAGINE" + }, + { + "conversationId": "e851b4f1-0605-4a41-b624-d629c2c1638d", + "title": "", + "starred": false, + "createTime": "2026-08-23T19:56:02.282356Z", + "modifyTime": "2026-08-23T19:56:02.284Z", + "systemPromptName": "", + "temporary": false, + "mediaTypes": [], + "workspaces": [], + "taskResult": {}, + "latestAssetMetadata": { + "assetId": "8d0b3727-f040-4b33-abf0-16e7d4364e6c", + "mimeType": "image/jpeg", + "name": "image.jpg", + "sizeBytes": 517902, + "createTime": "2026-08-23T19:56:19.599Z", + "lastUseTime": "2026-08-23T19:56:19.599Z", + "summary": "", + "previewImageKey": "", + "key": "users/00000000-0000-4000-8000-000000000000/generated/8d0b3727-f040-4b33-abf0-16e7d4364e6c/image.jpg", + "auxKeys": { + "image_edit_is_root_user_uploaded": "false", + "is_root_celebrity": "false", + "moderated": "false", + "original-image": "users/00000000-0000-4000-8000-000000000000/generated/8d0b3727-f040-4b33-abf0-16e7d4364e6c/original_image.jpg", + "thumbhash": "DvgJBIAYV3iPdIeIdnjSV28HVQ==" + }, + "responseId": "781acbe5-14bc-412c-9c3d-4610b19b627d", + "isDeleted": false, + "fileSource": "IMAGINE_GENERATED_FILE_SOURCE", + "currentConversationId": "e851b4f1-0605-4a41-b624-d629c2c1638d", + "sourceConversationId": "e851b4f1-0605-4a41-b624-d629c2c1638d", + "isModelGenerated": true, + "updateTime": "2026-08-23T19:56:19.599Z", + "isLatest": true, + "inlineStatus": "DEFAULT_ARTIFACT_INLINE_STATUS", + "isRootAssetCreatedByModel": true, + "rootAssetSourceConversationId": "e851b4f1-0605-4a41-b624-d629c2c1638d", + "sharedWithTeam": false, + "sharedWithUserIds": [], + "width": 1280, + "height": 720, + "rRated": false, + "thumbhash": "DvgJBIAYV3iPdIeIdnjSV28HVQ==", + "mediaGenInput": { + "textToImage": { + "prompt": "A pirate ship in the middle of the forest", + "numOfImages": 2, + "aspectRatio": "16:9", + "modelName": "imagine-image-gen", + "mode": "quality" + } + }, + "ownerUserId": "00000000-0000-4000-8000-000000000000" + }, + "kind": "CONVERSATION_KIND_IMAGINE" + } + ], + "textSearchMatches": [] +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/quota_info.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/quota_info.json new file mode 100644 index 00000000..0ad5496b --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/quota_info.json @@ -0,0 +1,16 @@ +{ + "image": null, + "imagePro": { + "available": true, + "remainingQueries": 4, + "windowSizeSeconds": 86400 + }, + "imageEdit": null, + "video": null, + "video720p": { + "available": true, + "remainingQueries": 0, + "windowSizeSeconds": 86400, + "nextAvailableAt": "2026-08-24T21:00:41.230702760Z" + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/session_info.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/session_info.json new file mode 100644 index 00000000..67a2cd44 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/session_info.json @@ -0,0 +1,25 @@ +{ + "status": "authenticated", + "session": { + "userId": "00000000-0000-4000-8000-000000000000", + "email": "user@example.com", + "emailDomain": "example.com", + "givenName": "Test", + "familyName": "User", + "profileImage": "users/00000000-0000-4000-8000-000000000000/scrubbed-profile-picture.webp", + "xUserId": "", + "organizationId": "", + "organizationRole": 0, + "organizationType": 0, + "organizationKind": 0, + "isOrgAdmin": false, + "hasPassword": false, + "emailConfirmed": true, + "googleEmail": "user@example.com", + "xSubscriptionType": "", + "createTime": 1787514616739, + "sessionId": "88888888-8888-4888-8888-888888888888", + "signInMethod": 2, + "isIntegrationSession": false + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/upload_file.json b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/upload_file.json new file mode 100644 index 00000000..5b6f36ff --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/endpoint_responses/upload_file.json @@ -0,0 +1,12 @@ +{ + "uploadId": "304e7eb0-7a7b-40af-afe5-4e28eeeb0270", + "fileMetadata": { + "fileMetadataId": "a0a1a02e-6236-41be-b213-eaa2ac7bd7f2", + "fileMimeType": "image/png", + "fileName": "moon_door.png", + "fileUri": "users/00000000-0000-4000-8000-000000000000/a0a1a02e-6236-41be-b213-eaa2ac7bd7f2/content", + "parsedFileUri": "", + "createTime": "2026-08-23T22:46:22.235616548Z", + "fileSource": "SELF_UPLOAD_FILE_SOURCE" + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/images/test_upload.png b/crates/api_clients/grok_consumer_client/test_data/images/test_upload.png new file mode 100644 index 00000000..dbf53783 Binary files /dev/null and b/crates/api_clients/grok_consumer_client/test_data/images/test_upload.png differ diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_complete_response.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_complete_response.json new file mode 100644 index 00000000..ee9ac6b9 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_complete_response.json @@ -0,0 +1,18 @@ +{ + "type": "image", + "blob": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCATgA0ADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDpBThTRThTJHinimCn0hjhS00U6kMKWkoqQFpRSUtAx1LTaWgB1LTaXNAxaSiigANNpTQaZIlJS0UxCUUuKSmAUtAooGFFFFIYYopaKAEpKWimJjTSU40lBI2ilxRikIQU8UgFKKBjhTxTBTxSGLS0lFMYtNNLSGgBppppxpKAGGkxTqKBCYoFLiigBRThSCnCmAtLSUtMYtFFFABRRRSASig0lJjCkNFJUgJSUppppAFJS0UCEpaKUUigpRRSigYopaQUopgLTqbS00SxRSikopiFzRmkozQAZpKM0maQAabS5pKBiGkNBpKYCUUUlMBaM0lGaBDqKSloAWlpKKAFptLSUxCUhpaQ0ANNJS0lACUlLijFIY2inYpMUgDFGKXFLipYxKdRilFJgUxTxTRTxWpI4U4U0U4UhjhS0gpaQwpaSjNIBaWkooAWlpKKYDqWm0tAC0tJRQAUUUYpkhikpcUUwEooooAKKKKQwpaSloGFLikFLQAlFLSUCEpMU6kpiG4oxTsUYpCsJSgUYpRQMUU4UgpaAFooooGFJS0lIBDTadSUANopaKAExS4oxS0AGKWilFMApaSloAKWiimAUlKaSkMSiikpAIaTNBpKACkoopAFFFFIApaKWgApaQUtIYtKKSlpgLS02lqhC0UlFMQtJmikoAWkopKQBSUUlAAaaaU0hoGJSZpaSmAUUUUALRSUtAC0uaSimAZooooEJSUtJQMSkpaKQCUUtLQA3FLilxS4pANxS4pcUYqRiYpaMUtICpilFLilxWhICnCkFLikMWloFLSGFFFFABRRRTELS02loAdS0gpaBBmlpKWmAtFFFMQUUYooASilooAbRS0UhiUtFFIYtFFFAgopaKYCYpKdikoASilooCwlLS0UAFLRS0gCilooASg0tJQA2ilopANxRilooGJS0UUAFLSUtMAFLQKBQAtFFFAAaaaWkNACGmmnGmmgBKSlNJSGFFFFAgpRSUtAgpaSlpDFFFJRQMWlpKKYDqKSlpiFzRmkopiCkoooAKSikoAKSlpKBiUhpaSkAlFLSUAFFFFMYUtFFABS0YooAKSlpKAENFKaSgAxRiiigApaKWgAxRS0UhhiilxRSASiiikBXxS4p2KMVZIgFGKdiikMSloooAKKKKQBRRRTAKWkpaBCinU0U4UAFKKBRTELS0lKKYgooooAMUlLRQMSkpaKQxKWiikAUtJS0AFFFFMAooooAKKKKACloooAWlpKUUgFopKKBBQaKDQAlJS0lAwNJRRSAKKSgUALS0lLTAWiiigBaSiigApKWkpAIaaadSUANoxS0UhiUUtGKYhKKXFFAhKKWkoAXNGaSigYtLTaWgBaWkpaYC5pKKKYBQaKQ0AFJSmkoASiiigBKSlopAJRRiigAooooAKWiimAUuKKKQxMUUtFADaKXFFMBMUUuKKACgUUtACiikpaBhRRRSGFFFJSAbikxTsUVRA2ilooASilpMUhhSUtFACUUtFACUtFLigApRSUtAhaWkpaBC0tNpaYC0UlLQAUUUtACUUtFAxKKXFGKQCUUtFACUUtFACUUUUwCikzRmgBc0uaZmjNIY/NGaZmlzQA/NGaZmlzQA7NFNzS5oEFFFFACUUUUAFFFFAwpaSloAWiiigQUUUUAFFFFIBKTFLRikA3FGKdijFACYoxS0UxCYpKdSGgBtJSmkNACUUUZoAWikzRTGOpabS0AOopKKYhaSiigYUlLSGgApKWikAlJS0UAJRS4pKACiiigBaKBRQAuKKKKQBRilpKAEopaTFMAooopgFFFFABRRRQMWikpaQxKKWigYlJRmimZgaSlpKBhRRRSAKKKKBhRRilxSASjFLRigAooooAKWkopiFpabRTAdS02loAdRSUtAC0UUUgCiiigAooozQAUlFJmgBc03NBNNJoAXNJmmlqaWoGPLUm6oy1N30ATbqN1Qb6N9IZY3Uu6q4enB6AJ91LmoQ1ODUxEuaWow1OBoAdRSZpaYBRRRQAUtFFAC0UUUAFAoopCA0UUUCCjFFLSASilooASkNLTSaBAaQmgmmk0wAmkJpCaaTQMXNGaZuo3UDH5ozTN1LmgB+admo80uaAJM0ZpmaXNMB+aKbmlzQAuaSiigAooooAKSlopAJRRSGkAUUUUCFFFJRQA6ikpaACiiigAooopgFJS0UAJRS0lMYUYopaAExS0UuKQwoopaBkWaM03NGaCB1FJRQMWikFLQAUtFFAC0UUtIBKKWigBKSlpKAEzRRmkzTAWikzRmmA6lzTc0uaAHUtNBpc0AOozSZozSAdmkzTc0ZpAOzSZpuaTNADs00mkJppagYpamlqaWqNmoAeWphao2eo2egCQvTS9QGSmGSgZZ8yk8yqvmUeZSGXBJThJVIS08SUAXQ9PD1SWSpVemIthqeGqqr1KrUxFgGlBqINTgaYEmaWmZpc0CHUuabmjNAx1GabmjNADs0ZpmaN1IQ/NGaZupc0CHZpc0zNGaQD80Zpm6k3UAOJppNNLU0tTEOLUwtTC9Rl6BkhamlqiL0wvQMm3Ubqg30b6Bk+6l3VBvpQ9ICwGpwaq4enB6AJwaXNQhqcGpgS5pc1GGpQaYiTNLTAaXNAD6KbmloELQaKQ0gCkpTSUhhRRSUCDNGaKKQC0tNpaYDs0ZptLmmIKKTNFAxc0tJRQAtFJS0AFFFFAwpaKKAFpcUlLSGVc0ZpuaXNAh1LTacKAFpaaKcKYhaWkFLQAUtFFABSUpppNAwJppNBNNJoAXNJmmk03dQA/NLmo91G6gCTNLmo91LupgS5pc1Fuo3UgJc0m6o91IWpAS7qTdUW+k30AS7qaWqIvTS9AyUvTS9Ql6YZKBkrPUbPUTSVE0lAErPULSVG0lQtJSAlaSozJUDS1E0tAy0Zab5tVDLTfNoGXhLTxLWeJaeJfegDSWWplkrMWWpklpiNNZKmV6zkkqdJKYi8r1IGqmslSq9MRaDU7dVcPS76AJ91G6od9JvoAm3Ubqg30m+kBY3Um6oPMo30AT76XfVffS76AJ99Luqvvpd9IRNupC1Ql6aXoCxKXpjPURkqNpKYWJWeomkqJpKiaSgCYyUwyVAZKYZKBlnzKPMqp5lL5lIZbD04PVMSU8SUDLgenB6piSniSgC2Hp4eqgenh6BFsPTg1Vg9PD0xFgNTwarhqeGpiJgacDUQanA0ASUU3NGaQhaKTNGaQC0lGaSgAopM0UALS03NLmgBaM0maM0xC5opKKYx1FJRQA6ikpaQxaKKKQC0UlFIYtLTaM0DKmacDTKcKCRwpwpopwpgOFLSCloEKKdSUtMAoopDQAE0wmlJphNACE0wtQzVEzUDHFqaWqMvTC9AE2+jfVffR5lAFnfS76q+ZS+ZQBZ30u+q3mUnmUgLJekL1WMlNMlAFkvTTJVYyU0y0hlkyUwyVWMtMMtAyyZKYZKrGX3pjS0DLDSVC0tQNLUTSUATNLULS1E0lQPLQMmaWomlqBpKiaSgCwZab5vvVUyUzzKALwlpwlqgJacJaANJZanSWstJanSWmI1UlqyktZSS1YSWmI01kqZZKzklqZZKYi+JKd5lUxJTvMpAW/MpPMqr5lHmUAWfMpPMqsZKb5lAFrzKPMqr5lJ5lAy35lL5lU/MpfMpAW/MpfMqn5tL5tAWLXmUhkqr5tIZaAsTmSo2kqAyVG0lMLEzSVC0lRNJUTSUCsTGSmGSq5kphkoGWvMo8yqnmUokpDLgkpwkqmJKeJKQy4JKeJKpCSniSgC8JKeJKpCSpFkpiLoepFeqQkqRZKYi8r1IGqkslSq9Ai2Gp4aqoenh6BFkNS5qAPTg9AEuaM1Huo3UhEmaM1Huo3UDJM0maZuozQIfmjNMzRmgCTNGaZupc0wH5ozTM0uaYx2aWm5pc0AOpabS0gHZopuaWkAtFJRmpGGaM0lGaBlYU4U0U4VRI4U4U0U8UAKKdSClpgLS0lFABSE0E00mgBCaiY05jULNQAjNULPQ7VA70AOZ6iMlRs9QtJSGWDJTfMqqZaaZaALvmUebVLzfejzvekBd82jzapebSeb70AXDLTTLVQy00y0AWzLTDLVQy0wy0DLZlphlqqZaYZaALRlphl96qmWmGSgZZaWomlqAyVG0lAyZpKhaSomkqFpKAJWkqJpKiaSomegCYyU3zKrl6bvoAteZThJVMPTw9AF5ZKnSSs5XqdHpiNJJKsJJWYklWEkpiNNJKmWSs5JKmWSmBoCSniSqIkp4kpCLfme9HmVU8yjzKALRkpvmVWMlIZKYFrzKTzKq+ZR5lIZa8yjzKqeZS+ZQMt+ZR5lVPMo8ykMt+ZTTJVXzKaZKYFkyVG0lQGSmGSgRK0lRNJUTPTC9AEpemF6hL00vQBY30u+q2+l30hlkPTg9VQ9OD0AWxJThJVQPTg9IC4JKkWSqQepBJQIvLJUiyVRWSpVkpiLyyVKslUFkqVZKAL6yVIJKoLJUglpiLokp4kqkJKcJKQFwSUu+qglpfNoEW99G+qvmUeZQBa30b6reZS+ZQOxY30u6q4kpQ9AWLIalBquHp4amBODS5qINTgaYEmaUUwGnA0CH0tNFLSAdRSUtIAooopDEpKWilYCuKcKQCnAVYhwpwpop4oGKKUUgpRQAtJQaQ0CEJpjGnE1ExoAazVA7U92qu7UAMd6rO9Okaqsj0hg8lV2kpsklVnkoAmaWmGX3qs0tRmWkMueb70nm+9UvNo82gC75vvR5tUfNo82mBdMvvTTLVMy0hloAtGWmmWqpkppkoAtGWmmSq3mU0yUAWTJTDJVcvTS9IZOZKjaSoi9Rs9AyVpKiZ6jZ6jLUAPZ6jL00tUZagQ8tSbqjLUm6gCXdTg1QZpwNAFlWqZXqopqVWpgXFerCPVFWqZHpiL6yVMslUVeplegRdElPElUw9PD0wLW+jfVbfS76BE5ekL1Bvo3UwJt9G+oN1G6gZPvo31Buo3UWGTb6N9QbqN1IZPvppeod1IWpDJS9ML1EWppagQ8vTC9MLUwtQA8tSbqjLU3dQBLuo31Duo3UAT76cHqvupQ1AFkPTg9Vg1ODUgLQenh6qB6kD0AW1epFkqmHp4egC6slSCSqQeniSgRdEtPEtURJThLQBfEvvThLVAS0ol96YjQEtKJfeqAm96XzvekBoebS+bWf51OEtAy/5tKJPeqIlpRL70AXxJThJVES1IsnvQMvB6er1SWSplegRcVqkVqqK1TK1MRYBpwNRKaeDQIlFKKaKcKAHClFIKUUAFFFLRYBKKWiiwFcU4UgpRTGOFOFNFOFAC0tJRQAtNNKaaTSAaxqFzUjGoHNAEbtVWRqmkaqkjUgIZXqnI9TStVKV6Bkcj1Wd6WR6qu9ADmkqIyVGz1EXoAnMlJ5lVy9JvoAs+ZR5lVt9G+gCz5lJ5lV99G+gCcvTd9Q7qTdQBNvoL1DupN1AEpeml6jLUhagY8vTC1NLUwtSAcWphakJphNMBSaYTSE00mkIUmjNNopgOBp4NRinCkBKpqVTUANSKaYFhTUqtVZTUqmgC0rVKrVUVqlDUwLQenh6rBqeGpiJ91LuqANTt1AiXdRuqLdS5pgSbqN1R5ozTAk3UbqjzRmgY/dRupmaM0ih26kJpuaTNIBSaYTQTTSaAAmmE0pNMJoAQmkJpCaaTQIdmk3Uwmk3UASbqXdUW6jdSAnDU4NUAalDUAWA1PDVXDU8NQBYDU8PVYNTw1ICwHpweq+6l3UAWPMpfMqtvo30wLXmUvm1T8yjzKYF0S0vm1S8yl8ykBdEtOEvvVHzaUS0AXhLTxLWeJakEtIZfEtSrJWeslSrJSGaKyVOj1nJJViN6BGij1OjVQR6so1MRcVqlU1WRqmU0yScGnio1NSCmA8UtNFOFAhaXFIKWnYAopaMUCK9LRilpFgKcKSloABS0lFAgNMJpTTTQMYxqBzUrVA5pAV5DVSQ1ZkNU5TQMqytVGVqtSmqMppDK8jVVdqlkNVXNIBjNUZahjUZNMBxak3UzNJmgCTdRuqPNGaYiTdRuqPNGaAH7qN1MzSZoAk3UbqjzRmkA/NNJpM0maBik00mkJpCaAAmmE0pppoEJSUtJQAlLRRQAopRSUopAPFPBpgpwoAlBp4NRA08GmBMpqQNUANPBpgThqeGqAGng0CJw1KGqEGng0wJc0uaYDThTELmlzSUtMBc0maKKADNGaSkpFC0lFJQMDTTSmmmkAhphpxphoENNMJpxphoAaTSE0Gmk0CFzRmm5pM0wJM04Gos04GkBMDTwagBp4NAEwanBqiBpQaAJt1G6o80maBkm6kL1HmkJoESbqTfURak3UwJt9G+oN1G+gCx5lL5lVt1LvpDLIkqRZKph6eHpDLqyVMklUFepkepGaKPVmN6zo3qzG1AGlG9Wo2rPjarcbUEsvI1WENU4zVlDVCLSmpBUKGpVNMRKKcKYKeKYhwpaQUtMQoooopgQUCloqCgooooAWiikpgIaYaeaaaQETVXkqw1QPQBUkqlL3q7IKpSikUUZqoy1flqjKKQylJVV6tSCqr0gK7VGakaozTAbSUppKACikpaYgzRmkooELmkzSUUALmjNNzRQMXNGaSikMKSg0UAIaaadSUCG0lOpKAEpaKWgAFKKKUUgFFOFNFOFMBwpwNMFOFADwaeDUYpQaAJQaeDUQNPBpgSg1IDUS1ItAiUU4U1akApiFFLilAp2KYDMUmKkxSEUARmkpxFNoGJSUpppoGFIaM0hNIBDTDTjTTQAw1GakNRmgBhpppxphoASkzRSZpiHZpQaZSg0ASg04GowacDQBKDTs1GDTgaAH5ozTc0maAHE00mkJpCaAAmmk0E00mmIXNJmm5pM0AP3UbqZmjNIZKGpwaoAaeDUjLCtUyNVVTUyGkxl1Gq1G1UENW4zSAvxNVyI1nxGrsRoAvxmrSGqURq3HTJLSGplqBKmWqETCnCmLTxTEPFLSCloELS0gopgRUUUVIwooooAKKKKAGmmmn00igZEwqBxVlhUDigCnIKpyir8gqpKKQzNlFUZRWlKKoyrSAzpBVVxV2UVVkFAyowqIip3FRMKBkRpKcRSUAJSUtFAhKSlpKoApKWkoEFFFFIAooxRQMKMUtFIY2kxTqSgQ2jFLijFADcUuKXFGKADFLijFLigAApaKXFAAKdSUtAC0tJS0AOFPFMFPWmBKtSrUa1MgoESKKmUUxBU6rQIAtO208LTttMRFtphFTlaYy0wISKjNTMKiYUDIzTTTjTDQMDTc0pppoGBNNNKaaTSAQ1GaeaYaAGGmGnmmGgBppKU000CFopKWmA4GnA0wU4UASA0uaYKdQA7NGaSigBc00mikNMQGmmg0hoAQmkzQaTNAgozSUZpDFzTgaZThSGSqamQ1AtTJUsZajNWo6qR1bipDLkVXYqpRVeiFAFyKrkdVIhVuOmhFlKmWoUFTrTJJFp4pgp4pgOpaQUtAhaWkoouBHRRRSAKKKKACiiloASkNOpDQBGwqFxU5FRsKYypIKqSrV5xVWRaQGbKtUZVrTlWqMq0AZsq1TkFaEq1TkWkMpOKhYVYcVCwoGQkU01IRTCKBjaSnUlAhKSnUlMBtFLSYpiExS0YoxQAUUtFIYmKKWikAlJTsUmKAEpMU6igQmKKXFGKADFLijFLimAUtFGKACloopDClopRQAoqRaYKkUUwJVFToKiQVZQUCJUWrCLUca1ZRaCQC07bT1Wn7aYEBWmMtWCtRsKYiqwqFhVlxUDigZA1RmpWqJqBjCaQ0pptAxCaQ0GkpAIaYacaaaQxpphpxppoAaaaaU0lACUopKBTEOFPFMFOFADxS00U6mAtFFJQIKQ0UhpgIaaaU000CA0maCaaTQAZozSUZpDHU4UwU4UgJVqdKgWp0FIZZjq5EKqRirsQpDLcQq9EKqRCrsQpAW4hVuMVWiFW4xTEToKmWolFTKKAHinimCnimIWlpKWgBc0UlFAhtFFLSASilpKYBRRRigApDS0UDGmo2FSmmMKAKziq0gq44qtIKYFCVaozLWlKKoyrQBmSiqcq1oyrVGQUAUZBVdhVyQVWcUhlcimmpGFMIpDGUlONJQA2ilxRTAbRilpMUAJijFLRQAYooooEGKMUUUAJijFLRQAmKXFLijFAhKKdijFMBKKWigAopaSkMMUtFFAwpRSCnCkA4VKgqNamQUwJkFWYxUCCrUYoETxirKLUUYqygoJHKtO205RTsUxERFQuKssKhcUwKriq7irTiqz0xldqhap3qFqBkRpppxpppDGmm04000gENNNKaaaQxppppxpppANNNpTSUAFAooFMBwpwpop4oAUU4U0U4UxBRS0lMBDTTTjTTQIaaaacaaaYDTSUppDSAM0lFFIBRTxTBUi0DJUqeMVCgqzGKQFiIVeiFVIhV6JaQFuIVeiFVIlq9EKQFmMVbQVXjFWkFAEqipRUa1KKYDhThTRS0ALS0lGaAFopM0ZoELiinUmKRIlFLRTGJRS0lAwopcUhoGIRTDUhphpgQuKryCrTCq8gpiKUoqlKK0JBVKUUAZ0q1RlFaUq1RlWgChIKrOKuyLVZxQMqsKjIqdhUZFICIim4qQimkUAMop2KbQAlJS0lACGig0UAFJRRmgApaSgUCFpcUCnAUwExS4pQKXFAhMUYp2KMUAMxRTsUmKBiUlOpKBgKKKKQwFOFJThSAetTIKiWpkFAFiMVbjFVY6tximIsxirSCq8Yq0gpiJFFLigCnUySNhUD1YaoHpiK0lVnqzJVd6CkV3qBqnaoWoKIjTDTzTDSAaaaacaaaQxpphp5ppqQGGmmnGmmgBppKU0lABQKKBQA4U4U0U4UwHCnU0UopiHUlLSUCEpppxpDTAYaaaeaYaAGmkpxptIBKKMUuKQwFSqKYBUqigCVBVmMVAgq3EtAFmJavQrVWJavwrSEWolq7EKrRLV2NaAJ4xVlBUKCrCigB61IKYKeKBjqWkooAWikozQAuaM03NJmgCxRiiikQJiilpKBhSUtJQUFBooNAxDTTTjTTTAjaoHFWGqFxTEU5BVSUVekFVJBTEZ8q1SlWtGVapSrQBnyLVZ1q9ItVXWkMqMKiIqw4qFhQBCRTSKkIppFAEZppp5phoAQ02lNNJoACabmgmm5oEOzSUmaKYDqUU0U4UCHCniminimAoFOxSAU4CgQmKMU7FGKBjMUmKkxSYpFDMUmKfijbSuMjxRin4oxSuMbinCjFKBRcB61MlRLUyUAWI6tx1Vjq3HQItR1aSq0dWUpkslFKaQUpqhDGqB6maoHpiK71WerMlVnoKRA1QtUzVE1IoiIphqQimkUhkZppqQimEUgGEUw1IaYaQhhphp5pppAMNJSmkoAKKKTNMBwpwpgpwNMB4pwpgNKDQIfRTc0uaYgpDRQaAGmmmn000ANNNp5pMUhjcUYp2KUCgYKKmQUxRU6LQBJGtW4lqKNauRJSETwrV+FarRLV6JaBFmJauRiq8S1bjFICZBUyio0FSimA8U4U0U6mAtFJRQMXNJmkzSZpALmkzSZozQMt0UmaXNIzCkNLSUFBSUtJQMKDSUUDA000ppDTEMaomqY1G1MCs4qrIKuOKrSCgRQkWqcq1oyLVOVaBmfItVHWr8i1VkWgCk4qFhVpxUDCmBXYVGRUzCo2FAERqM1K1RNQIYaYacaYaAEJpM0E03NAC5pabSigQ8U4UwVIKYDxTxTBUgoEOApwFIKeBTATFLilxS4pFIbijbT8Uu2pZSI9tJtqbbRtqGykiDbRtqfbTStK47EO2lAqQrSbaLhYRRUyVGBUqimInjq1HVVKsx1RJcjqyhqohqyhpkk4pSaYDSk0xDWNQOalY1C5pgQPVd6neoGouUiFhUTCpmFMIpXKSISKaRUpFNIqbjsREUwipiKYRSuBCRTDUpFMIoEREUw1IaYaYhhptONNNACUUUlAC0uabS0xDwaXNMzS5piH5pc0wGlzQA7NFJmloAKQ0tFIY2jFLijFACYpwFAFSKKQwVasItMRasxrQBLEtXYkqCJKvRJQImiSr0S1BElXYlpATRrVlBUca1YQUAPUVIKaop4FMQtFLRQAZpKKKYxKSlpKQxKSlpKQFvNGabmlzQZjqKbmloGFBopKBhRRSUxhSUtFMQw0xqkNMYUAQOKruKtMKgcUAU5BVOVavyCqkgoGZ8i1VkWr8gqpIKAKTiq7irbiqzimMrMKiap2FQtQIhaomqZqhagRGajNPaozQAhptKabSAWnCm04UxDhUi0wVItAD1qRRTFFSAUxDxThSCnCmAoFOApAKeBUspCAU4LSgU8CoZaGhaXbUgFOC1m2aJEOykK1PtpClTcdiuVpu2pytMK00xNEWKetLigCrRLJVqwhqstToapEMtoasKaqIanVqoRZDUpaoQ1LuoEKxqJzSlqjY0XGiNqiapGNRmlcpIjIppFSEUmKlstIiIppFTYppFK4WICKYwqdhUbCi4FdhUbVMwqJhVEsiNMNSNUbUyRhpppxpppgNpKcaSgQlFFJTAXNKDTaWgQ4GlBpmaXNAEgNLTAacDQA6ikzS0hhSgUClFACgVIopFFSoKQx6LVqNaijWrcS0ATRJV6JKgiWrsS0CJ4lq5GtQxLVuNaQEiLVhRTEFTKKYhQKdigCnYoATFJTsUlACUlOpKBjaSnYoxSGMop2KTFAEuaXNNBpRQZjqWkFKKBhRSijFACUUUUxiUUYpcUxDTTSKfTSKAIWFQOKssKhcUDKkgqrIKuuKqyCgZQkFVJBV6QVUkFAFKQVWcVckFVXFAyq4qB6suKrvTEQNULVM1QtQBE1RmntTDQIYaSlNFIAFPApAKeBTAcoqRRTVFSKKAHKKkApqipAKYhQKcKAKcBQIBTxTRTxSZSHAVIopgp61mzRDwKeBTRUgrNmiExQVp+KCKgohZajIqcioyKaJZCRSYp5FNrREMUVKpqIU9TVohllDUytVVTUoaqEWA1LuqENRuoESFqYxppamk1LKQE02gmipbLQYoxRS1DZaG4ppFSU00XAhYVEwqdqiamiWQNULVM1RNVolkTVEalaozVEjDTTTzTTTEMpMU+kpgNppp9NoEJRRSUALS5ptFADwacDUYNOBpDHg04UwGlBoAkFOFMFSLQA9RU6ColqdBQMnjFXIlqvGKuRCkBaiWrsS1WiFXYhQIsRLVtBUEYqygoESqKlApiipAKBDgKWgUtACUYpcUUDG4oxTsUmKBjcUmKfijFAxmKMU7FGKLCGilFIKUVJA4U6kFLTAWiiloGJRS0UwExSYp1JimAlNNPppoAjYVC4qdhUTigZVcVVkFXHFVpBQMoyCqkgq7IKqSCgZSkFVZKuSCqkgoAqvVZ6svVd6AK71C1TvULUCIWqM1K1MIoER4pcUuKUCmAAU9RSAVIooAcoqRRSKtSKKAFAp4FAFPApiAClxSgUuKAEpwpKUUmNDhUgqMU4GoZaJlNSCoQaeDWbRaZKDS0wGlzUWKuIajank0xjTSFcjamGnk0w1aJYU4GmZpQa0RDJlNSBqgBp4NMRNuo3VFupc0ASFqbupmaTNQxokzQDTM0oNQzREmaXNMzS5qSkOppoJppNADGqJqkY1ExqkSyJqiapWqJq0RDImphqQ0w1RJGaQ0402gQ2kxTqMUwG4pMU7FJigBhFJTyKaRQA2ig0lIBaUGm0uaBjwacDUYNOBoAlFSLUS1KtAyZKsx1XSrMdIC1EKuRCqkVXYhQBciFXYhVOKrsVAi3HVlKrR1ZSgRMtSCo1qQUCHClFIKWgBaKKKBhRRS0DExRiloxTATFGKXFGKqwiEU4UgpRWQhwpwpopwpgLS0lLQAUUtFMBKTFLRTASkNOppoAjaomFTNUTUDK7iq0gq09VpKBlKQVUkFXZBVOWkMpSVUkq5LVSSgZUeq71Zeq70wKzVC1WGFQsKBEJFNIqQikxQIjxShafinBaYDQtSKtKq1Iq0CBVqQLSqtPC0AAFOApwFKBQIbilxT8UmKAGYop2KTFAAKcKZSg1LKRIDTwahzTg1Q0UmTBqXdUQajdU2KuSFqYTTS1NLU7BcUmmE0E03NUiWLThTKcKpEjwacDTBThQA7NLmm0UALmkzSGkzSY0PzSg1HmlzUNFolBpc1HmjdU2KuSbqaTTd1NJp2C4rGomNOJqMmqSJY1qjanmmGqRDIzTDUhppqhEZFNxUhFNIoENxSYp2KMUANpMU/FJigBhFMNSEU0igCM02nkU00ANooopDHCnA00U4UwJFqZahWplpFE6VZjqslWY6ALcVXYqpR1dipBYuxVdiqlFVyOgLFuM1ZQ1VjqyhoJJ1qQVEpqQUxDxTqYKcKBDqKSloGApwpop1MYUYpaKaAMUUtFUhEAFKKXFLWIgFOFJSimAopaSlzTAKKM0UwCkpaSgApppaQmgBjVE1SMaiY0DIXqtJVhzVaQ0ikVZaqS1akNVJKBlSSqklW5KqSUDKslVnqy9V3FAiBhURFTMKYRTEQkUm2pdtG2gCMLTwtPC08JQAxVqVVpypUipQFhqrUgWlC08LQIaFp22nhaXbTAjxRipNtJigRERTSKmIphFAEZFNp5FNNIBM0ZpDSZpWGP3UbqjzSZpWHck3UmajzRmiwXH5ozTM0op2AeKcKYKkAoEKKeBSAU8CgBMUU7FIRQAw0008imGgYlGaSkzSsO4/NG6o80bqVirkm6mlqbupM0WC4pNITSZpKdiQNMNONJTEMNNIp+KQigRGRSYqQikxQBHijFPxRigBmKTFPxSYpARkU0ipSKYRQBERTSKlIphFMRGRSU8ikxQMSnCkxThQMetTJUK1MtIpE6VZjqslWY6Q7FuOrkVU46tx0XHYuxVcjNUojVyM0CLcZqyhqohqyhoJZYU1IDUKmpVNMkkFOFMFOFMQ6lptLQA6lFNFOoGOopKWqAWlpBS0wIsUtLiisyBKWiimMWikopgLRSUUALSZpM0maYCk00mgmmE0DEY1ExpzGoXakMjc1XkNSO1VpGqRohkNVJDU8jVUkagogkNVZDU8hqs5oAgeoGqZjURpgQkU0ipSKTbQIi204LUgWnBKVx2IwlSBKkCVIEouFiIJUgWpAlOC0XCwwLTgtPC07FAhgFLin4oxTJGYpCKkxQRTAhIphFTEUwimIhIqMipiKjYUwIjTDUjVGaQDSaTNBppoGLmjNNpRSAcDTxTBUiigByipVFNUVKooAUCnhaVVqQLQBHtpCKm200igCBhUbCp2FRMKAIjTTTjTDRYYhNNzQTTc0WGOzRmmZozRYB+aKbmlpALRRRQAmKTFPpMUCGYpMU/FGKQDMUmKfijFAxmKTFSYoxSAiIppFTFaQrRcRXK0wirBWmFaYWICKaRUxWmEUAMxSgU7FGKYxVqZajWpFpDROlWEqulWEqSi3HVuOqcdW46Qy5HVuM1TjNWozQJlyM1YQ1VjNWUNUSywtSrUK1KtMgkFPFMFOFMB1LSUUAOp1Mp1ADqWm0tFxjhS00UoouAlBoooMxKKKKBhRSUUwFpKKSmAE00mgmmk0DAmoyaUmo2agBrNULtTnaoHakUhkjVVkapHaq0jVJRHI1VJGqSRqrSNQMjdqrOakdqgY0ANY1GacTTaBCYpQtKBUirRcY0LUgSnKtTKlTcdiMJTwlSqlPCUrjsRBaXbUu2jbRcRFtpcU8ikqkSxuKKWkqkSFJS0lMQ00winmmGmIjaomqVqjamBC1RmpmFRkUDIjTTUhFMIoAbSilxSgUgFUVIopqipVFIB6ip1FMQVOi0AKoqQLQq1IFpiGbaaRU22mlaAKzCoWFWmFQOKBlZhUTVOwqFqAIzTCac1MNABmjNJRmgY7NOBpmaUGkMeKWmg0opAOooopAFGKWikAmKMU7FLigY3FG2pAKXbUgRbaQrU+2k20XCxWK0wrVopUbLTuFiqVphWrLLUbLTuKxARRinkU3FMBRT1pgp60DJkqxGarrU6GpKLcdWozVOM1ajNIZdjNW4zVKM1bjNAmW4zVlDVWM1ZQ1RLLKGpVqFDUq0ySUU8UwU8UCFFLSUtAC0tJS0DFpaQUooGKKdTRSigAopKKZmFJRRQAUUUUDEpDS000wENMJpxqMmmA1jUTGnMahY0hjHaq7tT3aq7tSKRHI1VZGqWRqqyNSKI5Gqq7VLI1VnagCN2qFjTmNRk0AGaUU2nCgQ9RUqrTVFTotSykOVKmVKEWp1WpbGhoSnbakC07bU3KIStNIqYio2FUiWREUw1I1RmrRLGmkpTTapEBmjNJmkqhAaaaU000wGmozUhphoAiIphFSEU0igCIim4qUik20hke2nBadtpwWkAirUqrQq1Kq0AORanRaYi1Oi0xDlWnhaVVqQCgRHtprCpiKYwpgVnFQOKtOKruKQFVxUDVZcVA4oGV2qM1KwqM0ANozQaSkMXNOBplLQMeDTgaYDThUgPpaaKUUgHUtNFOFAxRTgKQU4UgHAU4CkAqQCpYxNtG2pAtO20hlcrTGWrRWo2Wi4WKjLULLVtlqF1q0xFVhTCKmYVERTENp4plOFMCZTU6Gqymp0NIZajNWozVOM1ajNIZdjNW4zVKM1ajNAi7GasoaqRmrMZpklpDUy1XQ1OppiJlp4qNTTxQIeKWkFLQMWgUUUgFFOFNpaAHClpBS0AJSUZpM1ZItFJmkzSAdmkpM0maAFNNJoJppNMBCajY05jULGgBrmoHanu1QO1BSI3aq8jVI7VWkakUiJ2qs5qZzVZzSGQuaruamc1Xc0wImNRmntTKBAKkWmCpEpATIKsxioIxVqMVLKRMi1Oq1GgqdRWbKQoFGKeBQRSGRMKiapmqJqpCZC1RGpmqJhWiIZGabTyKaapEjaSnUlUIaaQ04imkUwGGmmpCKaRQBGRSYqTFG2kBFto21LtpQtICILTglShKcEpARqtSqtOCVKqUwEVanVaRVqZVpiBVqQLShadigQwimMKmIpjLQBWcVXcVcdarutAyk4qu4q461XdaQFRhUTCrLLULLRcZCabUhFNIpANpaKKBjhThTRSikA8UopopwpAOFKKQUopAPFPFRipFoGSLUiimLUq1LKQ8CnYoUU8CpGhhWo2WpyKjYUhlZ1qu4q24qu4q0Syo4qJqncVC1WiSM0Cg0CmIetToarrUyUAWkNWYzVNDVqM0DLsZq1GapRmrUZoAvRmrMZqlGasxmgRdQ1MhqqhqwhoJLCmpAahU1KDQBIKUU0U4UALS0lLQMWlpKUUAOFLSCnCgRFmjNNzSZqgHZpM00mmlqQD80maZupC1Ah5amFqaWphagBzNULNQzVEzUDEdqru1OdqgZqBjHaoHNPdqgc0DInNQOalc1A9BRC5qBqnaoGoERNTKkamYpiAVKlRgVKgpMCxHVqMVVSrUdZspFlKnWoEqZahlokFBoFIakYxqiYVMaiYVSEyFhUZFTEUwitESyEimkVMVpNtUmSQ4pNtTbaTZVXEQ4pMVMVppWi4EWKTbUu2k20XCxFto21NtpQlICILTglShKcEoAiCU8JUoSnhKQEQSpFSpAlSKlMQxUqRVpwSpAtMQ0LTttPC07bTERbaaVqcrTGWgCq61A61cZagdaQyi61XdavOtV3SpGUnWoWWrjrUDLRcdiqy0wirDLUZWlcdiHFGKkK0m2i4WGgU4ClxSgUgAClpQKXFACClFLilApAAqRaaBTxQBItSrUa1KtSykSrTxTFp4qWUhajYVJTGoGQOKruKsPVd6pEsrOKgarD1A1aIhkRpKU0lUIcKlWohUi0AWENWENVkqdDSGW4zVqNqpIasoaAL0bVZjaqUbVZjagReQ1OhqojVYQ0CLampVNV0NTKaBEwpwpgNPFADqWkFOpgKKUUgpwoELS0lLQBV3Uhaoi9NL0FEpamlqiL0wvQIlLUheoS9MMlMCYvTC9RGSozJQBKz1Ez1G0lRM9IBzvULNSM9RM1AwZqhZqVmqJjSGIxqJqeTUbUwImqJqmYVGwpgQEU3FSEU00CEFSLUY61ItJgTpVlDVVKsIazZaLSGp1NVkNTKahlomBpaYDS5qRgaYRT6SmgIiKbtqbFJtq0yWiLbSbKn20bKdxEGyk2VY2UmyquIrFKaUq0UppSi4FbZSbasFKTZTuBDspwSpQlOCUARBKeEqYJUgjoEQhKkEdTLHTxHTEQCOnhKnEdOCUxEISnBKmCUoWmIjC0bal20baAIttMK1ORTStICsy1C61bZaiZaTGUnSq7pV9kqB0qRlB0qBkq+6VA6UiiiyVGUq4yVEyUrjsVStG2pylJspXHYh20u2pdtLtouKxFtpdtS7KNtFwsRYpcVJto20XCw0CnAUuKcBRcLCqKlUUwCpBSGPFSCmCnVJSFpjU40xjQBC9V3qw9V3qkSyu9QNU71C1aIhkRpKcetNqhCipFpgp60ASpU6GoFqZaBlhDVlDVRDVhDSAuRtVlGqkhqyhoEXo2qyhqlGasxmgTLiGp1NVkNTqaBE61IKjWpBQIeKcKaKcKYhRThSUtAC0tAoFAGQXppeoDJTDJSNLE5eoy9QmSozJTAnMlMMlQGSmGSmInMlMMlQGSmGSgCZpKjL1EXphekBIXphaoy9NLUDHFqaTTc0ZoADTTS0hoERmo2FTEUwimBARTCKmIphFAiOnrTcUopMaJlNTIarqamQ1DLRaQ1MpqqpqZTWbLRYBp2aiBp4NSUPpaaKcKAFxS4pRTgKdxWGhadtpwFPC07isRbaTbU+2k207isQFKaUqwVpCtNMVitso2VPspQtVcCAJTwlShKkCUxESpUix1KqVKqUxEIjqQR1MqU8JTEQBKXZVjZRspkkGyjbU22kK0wIttJipSKbigCMimkVIRSYpAQlajZasEUxlqRoqstQulXGWoWWpZSKTpUDpV9kqBkpMpFFkqJkq6yVEyVNyioUpNlWSlJsqbjsVtlLsqfZRsouFiDZRtqxspNlFwsQbaNtTbaTbRcViLbSgU/bRtp3CwgFOApQKUUrhYUU6kpc0ihDTGNONRtTQiNzVd6mc1A9UiWQvUDVM9QtVoljDSUppKskUU8UwU8UCJFqZahWpVoGTrUyGoFqVTQMtIasoapoasoaQi7GatRmqUZq1GaBF2M1YQ1UjNWUNAiytSrUKVKtMRIKeKYKeKBDhS0gpRTAWloFLQByRkphlqsZaaZKk2LBkqNpKrmSozJTEWDJTDJVcyU0yUxFgyU0yVXMlJvoAnL00vUW6jdSAk3UmajzS5oAfmlpgNOFIB1FApaYhpFMIqTFIRTEQMKYRUzCo2FAERpKcRSUmNCg1KpqGng1DLRYU1MrVWU1KpqGWiypqQGoFNSqahlkwp4qJTUimkBIKkFRg1ItFwHgU8Cminii4rBilxSilouKwzbSbakxRirTER7aNlS7acFqkIjCVIqU8LUipVoljFSpVSnqlSKlUJjAlPCVIFpdtMkj20m2pcUhFAiEimkVKajNAEZFNIqQ0w0AMIpMU6kpANIppFPNIRSGiErUbLVgimEUmNFVlqFkq4y1Ey1DLRTZKjKVbZaiK1DLRVKUhSrJWmlallFfZSbKn20baVwINtIVqfbTStMCErTSKmK00igLEJFJipSKbimFhuKXFLRQAmKKKTNIBDUbGnk1ExpoTI3NQOalc1A5q0QyJzULVIxqJjVohjTSUUVRI4U8UwU9aYEi1ItRipFoGSqalU1CtSrQBYQ1YQ1VQ1YQ0gLkZq1GapRmrcZoEXYzVpDVKM1ajNAi0hqZagQ1MtMRMKeKjFPFAh4pwpopwpgOFLigUooA85MlMMlQGSmGSpNycyVGZKhL00vTETF6TfUG+jdTETb6N1Q7qUNSAm3UuaiBpwNICQGnA1GKeKBjxThTBTxQIeKcKaKcKYgxSEU6kIpiIyKjYVMRUbCgRARTcVKwphFJjQynCkxS1LKRIpqRTUIqRTWbNEWFNSqarqalU1DLROpqVTUCmpVNSMmU1KtQKalU0gJlNPFRA1IDSESCnCmCnCmhDqXFApwFWhABTwtAFSKK0RLBVqVVoVakArREMFWpAtAFPAqiWIBS4paQmmIaaYacTUZNIQhqNjSsajJoGITTSaCaaTSAXNJSZpM0ALRSZooGBppFOpDSGiIimMtTEUwioZSK5Wo2WrJWoytQzRFcrTStTlaaRWbKIStNIqUimkUhkZFMIqU0w0wIyKYRUhFMNMCM0008000ANpKU00mgBc00mgmmE0CBjUTGnE1ExqkSxjGoHNSMahY1SIZGxqImnsaiJrREMSgUUVQh4p61GKeKAJVqRajWpBQBItSLUQqQGgZMpqdDVZTU6GkBcjNWozVKM1ajNAi9GatRmqUZq1GaALiGp1NVUNWFNAidakFQqalFMRIKeKjFPFMQ8U4U0U4UAeSl6aXqItSbqk3JC1NLVGWpM0xEm6lzUeaUGgRIDTgajFPFICQGnioxUgpDHinimCnigdh4pwpgp4oAeKcKYKeKZI4UlApaYmNIphFSEU0imSQsKjIqdhTCKQyEijFPIpMVLKQgp4puKeKhloetSqaiWpVrNlolWpVqJalWpKJVNSrUS1ItICUVIKiFSLSAkFPFMFPFNCHingUwVKoq0Sx6ipFFNUVIorVEMeoqRRTVFSCtEQxRTqSkzVkik0xjQTUbNQIGao2akZqiZ6QCs1MLUxmphepGPLU3dUZak3UASbqM1Fuo3UDJc0uaiDU4GgCTNFNBpc0gFppFOpDUspEZFMIqUimkVmy0QkUwipSKYRUMtERFRmpWqM1JQw0w081GaYxhphp5qM0ANNMNONMNACE0wmnE1GTQICaYTQTTCaYhCaiY05mqFjVIhiOahY05jUTGrRDGsajJpSaaatEsKBSUoqiR4p4pgp4oGSLUgqNakFADxTxTBTxSAlWp0qutTpQMsxmrUZqpHVqOgRcjNWozVOOrUdAFtDVhDVZKnSmIsLUq1CtSrTESinioxTxTAkFOFMFOFAjxvNJmiiszcKKKXFAgFKKAKcBQAop4poFPAoActSCmAVIKRQ4U8U0CngUhjhThTRTqYhwpwpgpRVIlklLTAadTJYtIRS0uKZJGRTCKmIppFICErTdtTFabtqWUiPFKBT9tKFqGWgAqRRSAVIoqGWhVFSrTVWpVWpHccoqVRTVFSKKVh3HAVIBTQKeBRYVxwqQCmgU8CmkK49RUi0xRUiirSJbJFFSqKjUVKtaJENjxTxTRS5rREsXNITSE0xjVkgzVEzUM1QM9ACs9Qs9NZ6hZ6lgPZ6YXqNnqMvSGTF6bvqEvSb6AJ91LuqvvpQ9AFgNTw1Vg9PDUDLAang1AGp4akBNmlpgNOzUsaENNNPpprNlojNRNUrVG1Qy0RNUbVI1RGpLQw1Gae1MNAxhphpxphoAYaYaeaY1ADCajJp5qNqBDWNRMae1RsapEsYxqJjTmNRtVohjGNRsac1MNWiGMNNpxpKtEiU4UmKcBTEKKeKaBUiikMctSCmCpBQA4VIKYKkUUhj1qdKiUVOgoAmSrMdQIKsoKBFiOrUdVoxVmOgRZSp0qBBU6UxE61KtRLUq0wJFqQVGKeKYDxThTRSigDx3FAFSbaXbWRuMxS7aeFpdtAhgFKBT9tKFoAaBTwKULTgKQABUgFIBTwKBiinCkApwFIYtKKKKYBS0lFUiWPBpwNRg04GqIY8U6mA08UyRcUmKcKXFAiMrSbalxRtqWUiLbShal20oWpaLTIwtSKtOC1Iq1DRVxqrUqrSqtSKtKw7gq1Iq0qrUgWlYLiBaeBShacBTsK4gFPApQKcBTsTcVRUiikAqRRVJCuOUVIKaop4FWkTcUUtFIatCEJqJmpzGoXNUIY7VA7U52qs7UAI71Az0jvUDvUgPZ6YXqJnqMvSGTF6TfVcyUnmUAWt9KHqp5lOD0AXA9PV6pq9Sq9AFxWqVWqorVMrUhloGng1ApqQGpYyTNNNGaQ1LKQ1qiapDUTVDLTI2qJqkao2qbFpkZphp5phpFDDTDTyKaRSAjNMNSkUwigCI1E1TEVGwpkkLVE1TMKiYVSJZC1RmpmFRkVaJZCRTCKlIppWrRDIiKTFSbaNtWSMxSgU7FLigBAKeKQCngUDFFSKKaBT1FIB6ipVFMUVKopAPUVOi0xBU6LQBIi1ZQVGi1YRaBEiCrKCokWrCCgRKgqdaiQVMopiJVqVaiWpVpiJBTxTBThTGPFOpgpwoA8o2UuypglKErI6CEJTtlShKdsoEQbKXbU2yjZSAi20oWpNtLtoAYBTwKULTgKQxAKXFOApcUhjcUYp2KTFFxDaSnEUhqkxMKUGm0oqkyGSCng1GKepqkSyQU4U0U8VRI4Cl20oFOApDGhacFp4WnhalopMjC1IFpwWpFWpaHcaq1Iq04LUirSsO40LUgWnBaeFpWFcaFpwFOC04CnYVxgWnAU4CnAU7CuIBUgFIBTwKpIVxQKeKQCnVSEFNNOpjVQEbmoHNSuaryGmBBI1VZGqaQ1UkagCN2qu70sjVWdqQCs9Rl6Yz1EXpDJS9J5lQF6bvpAWd9OD1V304PQBcV6lV6pq9TI1AF5GqwjVRRqso1IC4pqUGqyGp1NJjJM0E0goNSxoa1RtTzUbVLLTI2qM1I1RkVLLTIzTTUhFNIqSkyM00ipCKQikMiIphFTEUwigCFhUTCrBWmFaCSswqNlqyy1Ey1aJZWK0wrVkrTCtWiWVitNK1YKU0rVollcrSbanKUm2mIh20uKk20mKYDMU4ClxRQMUU9aaKetICRanQVEtTpSAlQVZRahQVZjFAiVFqyi1FGKsotAh6LVhBUaip1FAh6ipVFMUVIBTEPWpBTBTxTAeKeKYKcKAHinUwUuaBnnOynbKseXS+XWZsV9lLsqx5dGygCvspNlWdlJsoAr7aNtT7KTZSAh207bUm2l21IyPbRipNtG2kMjxSEVJikIoAiIppqQimkU0JjKKXFJVIhjhThTBTxVolkq1ItRLUq1SJJVqQCo1qVaYDwKeFpFFSqKAALT1WlValValodxAtPC0oWpAtTYLiBacFpwFOApWFcaFpcU/FGKBXG4pQKXFKBTEAFPFIBThVIBwpaBS00AhqNqkNRtVAQOaqyGrMlVJDTArSmqUrValNUpTQMryNVV2qaQ1VdqQDGaoWah2qJmpDHF6TfURak3Uhkwanq1Vw1PU0CLStVhGqmhqwhoAuxmrUZqlGatx0AW0NTqarx1OtICUUUDpS1IxhpjVIRTCKllIiNMIqUimEVLLTIyKbipcUmKllJkRFJipdtJtqR3ISKaVqcrTStAEBWmFasFaYVpiKxWoytWStMK1SEVitMK1aK1GVq0SyuVphWrBWmlapCK5WmlanK0wiqEQkU0ipSKYRQBHRS0lAxRTxTBTlNICdKnSq6GrCUCLMdW4xVWOrcdAixGKtIKrx1ZSgRMoqZRUaVMtADgKkFNFPFMQ4U4U0U4UxDhThTBThQMfmlzTM0uaQHH+XS7KseXS7Kk0uV9lGyrGyjZQMrFKQpVnZTdlICtso2VYKUmykMr7aNtT7aaVpMaIdtJtqbbSFakZCRTSKmIphFICEimEVMRUZFNCIyKaRUhFNIqkSxtOFJSirRLJFqVaiWpVq0STLUy1CtTrVCJVFTKKiSp1FAh6ipAKRRUiikAoWpAKQCngVIXACnYoxS0hCYpaWikAlAopRTAUU4U0U4UwHClzTRS1SADUT1IaiamIgkqpLVqSqktMCnKaoymrstUpaQynIaqyGrUlVJKQyu5qJjUr1C1AxhNJmlNNxSGOBqRajFSKKBEyVZjqulWYxQBajq1HVWMVbjFAFqOp1qGMVOopASCloAp2KljGEU0ipCKaRUsaIyKaRUhFJipZRFijbUm2jbUspEe2k21LtpNtIoiK00ipitNK0BcgK0wrU5WmkU0K5XK0wrU5FRkVaJISKYRUxFMIqkIhIphFSmmGmIhIphFStUTUwI2qI1K1RtQBGaSlNMNAxaetRinrQBOlWEqstWI6Qi3HVuOqcdW46BFyOrKVVjNWUNAFlKmWoENTKaYiUU8VGDTxTEPFKKaKdTAcKWminUALRmkpaQzD2Umyp9tG2ixVyDZRsqbbSbaQEO2mlan20hWkMgK03bU5WmlaTGQlaaVqYrTSKljRCVppFTEUwikUQkUwipSKYRSAhIphFSsKYRTEREU0ipCKaRVIljMUAU7FKBVITACpVpoFSKKpEkqVOgqFBVhBVCJUFToKiQVOopkkiipFFMUVKKBDgKeBTRTxSEFLRRSAKKKSkAUUUZpDFpQabmlzTAeDRmm5ozTAUmo2pxNRsaoCF6qy1aeqslAFKWqcoq9LVOQUhlGQVVkFXZFqs60DKTiomFWmWoWWkMgIpMVKVpNtIBgFSKKULUirTEOQVZjFRItWY1oAnjFW4xVeMVajFAE6CrCioUFTqKQx4p1IKdUgJimkU+kxUjGYpMU/FGKkYzFGKfijFIoZikxUmKQilYdyMimEVKRTDTsFyIimEVIajaqSFcjao2qRqiY1SRNxjVGTTmNRsadhDTUZNKxphNMBrVG1OJqNjQAxqjNPamGgYw000402gYCnLSAU8CkBItTpUC1OlIC1HVqOqkdWozQIuRmrKGqkZqyhpiLSGplNV0NTKaaETg08GolNSA1QDxThTAacKBD6WminCgBaBRSikBn7aTbUmKTFVYdyPbSEVIRSEVIERFNIqUimkUhkeKaRUhFNNIojIphFSkUwipGREUwipSKYRSsO5CRTGFSkVGRRYLkRFMIqUimEU7CIiKbipCKTFMBmKUCnYpwWmIRRUiihVqVVqhCqKnQUxVqZRVEskUVMoqNRUyimSyRakFMWnigkeKUU0U6gBaWkzRSEFFFJSGFJRSUhi5pc02jNAx2aXNMzRmgBxNRsaUmmE0xEbmq8lTsagei4yrIKqyCrjiqzii4ylItV3WrrrUDrSApMtRMlW2SoylAyqUpNlWClJsoAhCVIqU8JUipQAiLVhFpqpVhFpiHxrVlBUaLVhBSGSIKnWo1FSrSAcKdSClpDCkpaKkBKKXFFIYmKMUtFIYlNNOpposA01G1PNRsadguMaomNPY1ExqkhXGMahY052qFmqrCuIxqJmoZqiZqYhWaoy1IWqMtQA4mmE0hNNzSADTTSk0lAxppMU7FLikUNAp4FAWnhaQCqKmQUxRUqikBMlWUqulWEoAspVlDVVDVhDVIRZQ1OpquhqZTVIROpqQGoVNSg0xEgNOFMFOBoAeKcKYDTgaBDhThTM07NICrikxT6StLE3GEU0ipKaRUsq5GRSEU8ikIqRkZFNIqQimkUh3IyKaRUhFNIpWHciIqMipitMK0WHcgIphFTFaYVosFyAimkVKRTSKLAREUmKkIpMUAM204LTgtPC0wEVakVaFFSBaYhVWplFNUVKBTJHKKkFNAp4pkseKeKYKUGmIkFLmmA0uaBD80U3NLSAWkoooASiikpDCkzQaSkMXNJmkzSZoACaaTQTTSaB2GtUTVIajalcdiF6gcVO1RMKLhYrOtQstWmFRMtIZUZKYUq0VphSmBVKUbKslKTZQIgCU5UqYJTwlMCNUqdFoVKmVaABFqdRTVWplFADlFSCmgU8UgFFLSUtIYUUUlIBaKSikMWkozSZpAFNJoJphNMBGNRsaVmqFmqkgEZqgdqczVA7UxCO1QM1KzVCzUxCM1RM1KzVEzUABamFqQmmk0gFJozTc0ZoGOooFKKQwxTgKAKeBU3GIBTwKAKeBSuMFFSqKaBTxQMkUVOtQrUy0CJ0qdDVdKnU1SEWUNTqarIanU1SJJ1NSKahU1KDVCJRTgajBpwNAEgNKDTM0uaYh+aXNR5pc0gG0UtFaszTG4pCKfikxUsq5HikIqQikxUjuREUhFS4ppFIdyIimkVMRTStKwXIStMK1OVppWgdyuRUZWrJWomWiwXK5WmEVYIqMikO5CRRinkUmKChAKcBQBTwKABRUqimgVIKBDlFSAUwU8UyWPFOFNFLmmIeKWmZpwNBI4GnA1HmnA0xD80tNBpaAHZpKKKACkpaSkMaaQ0ppDQMSmmnGmmkMQ000ppppDGmozTzTTSGRMKYwqU0wilcCEioytTkUwigZAVppSrBWm7aAINlGyp9tG2mIhCU4JUu2nBaYEYWpFWnBaeFoECrUgFAFOApAKBThSAU6gAooopDCkopKAFpM0U3NIYpNNJoJphNACk1GzUM1RM1MQM1Qs1DNULNVIBHaoHaldqhZqYhGaoWalZqjY0AIxqImnE0w0gGk03NOpKVxiU4UlKKVxiinimingUrjSHAU8CkFPFSUKBTgKQU4UhjgKcKaKdTAkWpFNQg1IppoTLCmp1NVVNTqapElpDUymqyGpkNUIsqalU1ApqVTTESg04GowadmmIkzRmmZozQA/NGaZmk3UAWMUuKXFLitmYjcUYp2KXFSxkeKQipMUYqRkW2k21LikxSHci20hWpcUmKAIStNK1ORTCKQFdlqJhVlhULCgZAwqNhUzVC1IpEZpppzGmE0ikOFOBqPNOBpFEoqQGoQaeDQImFPBqEGng07isS5pQajBpc0XJsPzTgaYDS0xDwacKYDThTEOFOpopRTJHUtNpaYC0lFFIY00hp1NNIYhppp9NNSykMNNNPNNNIYw00inkU0ipGRkU0ipCKQigCIimkVKRTcUAR7aTbUmKMUwI9tLtp+2lxQAwLShafilAoAaFp4FKBSgUCAClApaWmAUUUUgCiikoAKSikoAKaTQaaTQMQmmE0rGo2NADWaomalZqhdqYDXaoWaldqgZqYgZqhZqGaoyaYATTCaCabQAhppFPpMVLGMxSYqTFG2pHYjxTgKdtpcUrjsIBTxSAU4CpuMcKcKaKcKBjhTs0zNLmgY/NGaZmjdTESg08NUAanhqaEyyrVOjVTVqmVqokuI1WEaqSNVhGpiLamplNVUap1NMRODTs1EDTgaYEmaTNNzRmgBc0maTNNzTEaeKXFLilArYxExS4p2KMVLAbikxUmKTFIYzFJipMUmKQyPFIRUmKQikBERUbCpiKjagCFqgep2qBzSGQOahY1I5qB2pFIaxqMtSM1RlqRSJN1KGqDfSh6RZZDU8NVUPTw9IC2Gp4aqoepA1AFgNTgagDU8NQSTA08GogaeDVCZIKcKYKeKaJHCnCmilqiR1FJmlpiFpM0UZpDCkoopDEpDTqSpZSGGkIp1IakZGRSU8imkUhjCKaRTzSGgBhFJin4pMUAMxRinYoxQA3FLinYoxQAmKXFLRQAUtFFMApaSigQtFJRQAUlFJmgApDS000AIaYTTjTCaBjWNRMaexqFjQBG5qBzUrmq7mmBG5qFjT2NQsaYDWNRmnGmGgAoxRTgKAG4pdtPApQtSxjNtG2pNtLtqWMi20YqTbSYqShmKdS4opDEpc0lJmgB2aTNNJpC1MB+6k3VGWpN1MkmDU4NVfdTg1UhFtWqZWqkrVMjUxF5GqwjVRRqso1MRdRqnU1URqnQ0AWVNPBqFTUgNAD80UgopiCkpTSUwNjFLijFLWxgFLiilqQDFJTqSkMTFIRS0UAMpDTjTTSGMaoWqVqhc0AROarSGp3NVZDQMhkNVnapZGqrI1IpDWaoWekZqiZqRSJC9G+oN9JvqRotB6kD1TD08PSKLivUqvVJXqVXpAXFapVaqitUytQIsqakU1XVqmU0xE4NPFRKaeDVJkskFOpgNKDVXJY6jNJmjNMQuaXNNpc0ALRSUUhhRRRUsYlIaWkNJjGmmkU8000hjTTSKeabSGNxSYp1FADcUYp2KTFACUYpaKADFFFJQAuaSikpgLmikzRmgQuaTNJmjNAC0lGaSgApDRSGgBDTDTjTGoAY1QtUrVC1AyFzUD1O9V3pgQNUTVM1REUARmm4p5FJigYgFOAoAp4FAABTgKUCngUmMbtoxT8UYqRkZFJipCKaRUjGEU0080w0hjTTSaU0wmgBCaYWoJphNNCFLUm6mE00tVCJd1KGqDdTg1Mksq1To1U1apkamIvI1WY2qjG1WY2oAvI1WUNUo2qyhpgWlNSg1ApqZTQBIKWminUAFJinUYpiNiloorYwFpaSlpAFJS0lIYUlLSUANNNNONMNIZG1QualaoHNAyCQ1VkNWJDVSQ0DK8hqpI1WJDVSQ0hkLtULNT3NQMaQwLUm6mE03NIZOHp4eqwanq1IotK1TK1U1aplapGXEap0aqaNVhDSAtK1TqaqoamU0XCxZU1IDUCmpAadybEoNOzUQNOzVJktEmaM0zNGadxWH5pc0zNGaYh+aWmZpc0AOopM0uaACkpc0lIYhpDS0lIoaaSnUlIBtFLRQMSkxTqSkAlIadSUAIaSlNNoAKTNFJTAM0ZpM0maAHZozTc0ZoAXNFJS0CCkNLSGgBppjU8000ARNULVM1RNQBA1QOKsNULCgZXYVGRU7CoyKYyIikxUpFJtoAaBTwKAKeBSGIBTwKAKXFIYYpMU6kqWMaaYakNMNIZGaYakNRmkBG1RsakaomoEMJqNjT2qJjTENJppNBNMJqhDs04Go80oNMROpqZDVVTU6GgRbjarUbVSjNWozTAvRmrKGqUZq3GaALaGplquhqdaYEwp4qNakFMQtLiilxSEa1FFFbGItFFFABRRmkoGFJRRSAQ1G1PNMNAyNqrvU7VXekMrSVVkq09VJKRRUkqpJVuSqsgpDKr1A1WHqBhSGRGm5pzUw0AKDTlNMpwpDJlNTIagWpkqWUiwhqwhqslTpUNlWLKGp1NVlqZTSuFidTUgaoQacDRcViYNTt1Qg0u6qTFYm3Uu6od1LuqkyWiXNLmog1OzVJk2JQaUGogacDVCJM0uaYDS5oEPopuaXNAwoNFJSGJSUpopDEpMU6kpDEopaSgBKSlpKQDTSGlNNNMBDSGlNNNACUUUlAC0UlKKAFopBS0CFpDS0GgBpphp5ppoAiaomqZqiamBAwqJhU7VEwpDIWFMIqUimkUDIsUmKkxSYoGNApwFKBS0hhS0UUmxhSUtJUtjGmmmnmmGpGMNRtUpFRsKLgQtUTVMwqJhTEQtUTVM1RMKaJIjTDT2phFUISlFJSimIepqZDUK1KtAFlDVqM1USrMdAF2M1ajNU4zVqM0xFxDVhKqoasIaYiwtSColNSimA4U4U0U4UhGrRS0YrUwAUlLSUDCkoooGFITRSE0AIaY1ONMY0DI3NQPUrGoXpFFeSqslWnqrJUsoqSCqzirbiqzikMqOKgYVacVAwpDK7CmEVMy00rQBHinAUuKcFpMYqipkFNVamRalspD0FToKjQVOorNspIkUVItMUVIKm5VhwpwNNpc0XFYdml3UzNGaaYrEm6jdUeaN1WmS0TBqUNUIanBqtMlomDU4GoQ1ODVSIJgacDUQNOBqhEoNLmowacDQA/NGabmjNAxaKTNFIAooopDA0lFJSGFIaKSgBDTTSmkNADTTTTjTTQAlFFFMApaKKQC0UUUCFpKKKAENNNKaaaYDGqJqkNMNAETVG1SNUbUDIyKYRUhphpDG4pKWikMSlopaTKExS4opcVLYxMUlOxRipuMYRTSKkxSEVNxkRFRsKnIqMigRXYVEwqyy1Ey00IrMKiYVZZaiZatElYimkVMVphWqQiLFAFSbaMVQhAKlUU0CpFFAEqVYjqBBVhKALMdW46qR1ajoEWkNWENVkNWENMRYU1MpqBTUqmmIlFOFMBpwpAbFJinUYrUxG0lOpDQA2kpaQ0DENIaU000DEJqNjTiajY0DQxjULmpGNQOakoieqz1Yc1XekMrvVdxVl6gYVJRWcVCy1ZYVEy0gK5WmlanK00rQMh204LUgSnBaTZSGqtTKtCrUypUNlIFWplWhVqVVrNlABTwKULTsVIxuKSn4pMUANpKcRTSKpEsTNGaDSVaEx2aUGo80uapEMlDU4NUINOBq0SyYNTw1QBqcGqkSThqcGqENTgaYE2aXNRA04GmBJmjNMzS5pDHUUmaM0gCkzRSUgFzSGkpCaQAaaaUmkNMYhpppxpKAEooooAKKKKAFopKTNAC5pCaTNITQApNMJoJppNACE0wmlJqNmoAaxqM05jUZNACGmGlJppNIoKKTNFSNC0tApQKljFxRilAp2KkY3FGKfil21IyPFJipdtJtpDIStNK1OVppWgCsy1Ey1aZajZaaEVGWoWWrjLUTJVoRUK0wrVlkphWqRJX20bam20baoRGFp6inBacFpiFUVOgqNRUyigCZKspVZKsJQIsoasIaqoasIaYiypqVTUCmpVNMCYGng1EDTwaAN2kNLRWhgNNJTqQ0DGmmmnGmmmA000mnGmGkMYxqNjTmNRsaRSI2NQsakY1CxpMpEbmoGNSMahY1I0RtULVK1MNIZCwqMrUxFJtqRkJWm7an20baQ0QhKcEqUJTwlJspEapUypTlSpFSobKQirUqrShakC1LKGhaXbUgWl20gIttIVqbbSFaEibkBFNIqcrTStWkK5ARTcVMVphFUkTcipKeRTSKaEJmlBpDSVSESA04NUOaUNVCJw1ODVAGpwaqEWA1ODVXDU8NQBMGpwNQhqcGoAlzRmmA0uaAH5pKbmlzUgFJRSUAFJS0lMApKWkoAKKKKAEooppNIBSaaTQTTSaBgTTS1IWphagBxamFqaWphagBxaoy1NLUwtQA4tTC1NLUwtSGOJpM0zNGaQx9KKaKeKQxwFPApFFSqKkYgWnBaeFp4WpC5HtpdtShaNtILkW2k21PtpNtKw7kBWmlasFaaVpDKxWoytWitMK0wKjJUTJVtkqNkpoCmyUwpVopTClWmTYqlKTbVgpTdtO4iLbTgtP20uKYhoFSKKQCngUxEi1MlQrUy0xE61OhqutTKaYiwpqZTVdTUymgZMDTwaiBp4NMDoaKTNFamAUhpaQ0ANNIaU0hoGMNRtUhqNqQ0RNUTVK1RNSGQsahapWqFqllETVC1StURqSkRmmmnmm4pMYzFGKfil21IyPbS7KkC08LUtjREEqQJTwlSBKlspEYSpFSpAlPCUihgWnhakC04LSAYFpdtSbaXbRYTZFtpCtTbaNtUkS2VytNK1YK00rVJEtlYrTCtWStRstVYVysVphFWGWomFOwrkJFMNSsKjIpgNzSZoNMJoAk3U4NUOaA1MCwGp4aq4anBqYFkNTg1QBqeGoETg0uaiDUoagCXNGaYDS5pAPzSUmaM0ALRSUtMQUUUUwEpKWkpAITTSaUmmE0DEJphNDGmE0gAtUZakZqjZqBilqYWprNUZagBxamFqaWphagBxamlqYWpM0hkmaUGowacKQEoqVRUS1OgpDuSKKmVaai1Oi0guCrUgWnKtSBaVguRhaXbUoSl20rBch20m2p9tJtosO5BtppWrBWmlaVh3KxWmFaslaYy0rDKrLUTLVplqNloGVWWoytWmWoytMCsVppWrBWmFadxEG2jFSlaTFVckZinAUuKUCmIVakWmAVIopkkq1MtQrUq0wJlNTKagWplpgSrUgNRCng0DOiopKK3OcWkoooASmmnU00gGmo2qQ0xqTGiFqiap2FQsKllIgcVA1WWFQsKRSK7CoyKnYVGRUlEJFJipCKTFSxjMU4CnbacFqWMaFp4WnBaeFqWMQLTwtOVakC1JSGhakC0oWpAtIY0LTgtPC04LTFcj20u2pNtLtqkhNkW2kK1LigiqSIbIStNK1MRTStVYm5AVqMrVkrTCtMVyqy1Ey1aZahZaAKrComFWXFQOKBkDVGalYVC1AxCaTNIabmgCUNTg1Qg04GgCwGp4aq4apA1AE4anBqhDU4NTETA07NQg04GgCXNLmowadmmA8GlpgNLmmIdRSUZoAKQ0ZppNIBCaYTTiajY0ANY1ExpzGomNIY1jUbGlY1ExoGIzUwmgmmE0AITTCaCaaaQC5opKUUAOFSKKYoqVRQBIgqwgqJFqzGtILkqLVhFqNFqwi0guOVakC0KtShaLCuNC0u2nhaXFFguRbaTbU2KTFFh3IStNK1MVppWlYdyArTCtWCtRstTYpMrstRMtWWWo2WkUVmWoytWWWoitIZXK00rU5WmEUwIStNxUxFNK0yWRYpcU/FLtqkJjQKeBQFp4FUSKoqVRTVFSqKYDlFSrTFFSAUAPFOFNFPFAzoKKKK6DlCiiikAUlLSUDGmmGpDTSKQ0RMKiYVMRUbCpKIGFQstWWFRMtJjRWYUwrVgrTCtSy0VytG2pStJtqWNEe2nAU7bSgVDKEAqQCkAp4FSxjlFSAU1RUiipGOAqQLSKKeBTC4BacBTgKcBVJE3G7aMU/FGKpIlsjxSYqTFNIqiWyPFIRUhFNIpkkRFMIqYimEUxEDComFWGFRMKBlVxUDirbiq7igZUcVAwq04qu4pDIDTTUhFRkUhhmlBptKKAJAaeDUQpwNMCYGnA1EDTwaAJQacDUQNPBpiJAacDUYNPBpgSA0uaYDS5piHZozTc0ZoAXNITRTTSAQmo2NPNRmkBG1RtUjVGaBkTVE1SsKjIoGRGmGpCKYRQBGaTFSbaNtICPFOC08LTwtMBqrUyLQqVOiUCFRasotNRasItIQ9FqdFpqLUyigByipAKRRTwKADFLilooAbijFOpKLANIppFSUlFhkRFRkVORTCKloaZXZajYVYIqNhUtFJldhUbLU7CoyKktEBFMIqYimEUDISKTbUpFJtoQiLbS7ak20oWqJGBaeFpwWnhaoQ0LUirShakC0xCAU8CgCngUwEApwoxS4pjN+iiitjmCiiigAooxRQAlNIp9IRQMjIqNhUxFMIqWMgIqNlqwRUZFSykVytNK1OVphWpZSICtJtqYrTStQykRYpcU/FGKhlDQKcBRinAUhiipFpgqVaLAPUVKoqNalFNIVx4FOApAKeKpIlsTFJinYoqiRmKaaeaaaYhhppp5ptMkaaYRTzTTQBGwqJhUxqJqAK7ioHFWWFQuKBlRxUDirTioHFIaKrCmEVOy1GRQURYpMU8ijFIY0U4UuKUCmAop4poFOApiHCnimgU4UxDhThTRTxTEKKUUCloAKWjFFAhKQ0tIaAGmmGpCKYRSGRMKjIqYimEUhkDCmEVOVphWgZXK0hWpytJsoAg20oSptlKEoAiCU8JUoSnqlAhipUyJT1SplSgBESp0WhUqZVoECrUyikVakApAKBTqQCloAKKKSmAtFJRmmAUlLSUgENNIp1NNJgRsKjIqY1GwqWikQsKjYVMwqMioZaZCRTCKlIppFIojxSYqTFJigBm2nBadinAVQmNC08LTgKcBTRIgWngUoFOAqhCAU4ClApcUwExRinYpcUwNqlxSUtanOFFFFMAopcUUwEpCKdSUhjCKaRUhppFICMioyKmIphFSykREUwipiKaRUMpEJFNIqUimkVDKIyKTFPIpMVJQzFKBS4pQKVhigVItMAqRadhXHrUq1GtSrVJEtjxThTRThVWFcWkNLSGgQ00004mmE0CGmmmlNNJoADTTQTTSaYhDUTU8mo2NAEbVC9TNUTUDIGFQsKsNULCkUiuy1GVqwwqMigZCVpNtSlaTFAyPFKBT8UYpoBoFOApwFKBVEgBTgKUCnAUxCAU8CgCnAUCEpcUuKXFAhuKMU7FGKAG0Yp2KMUhjMU0ipMUYpAQlaaVqbFIVoGVytNK1YK03bQMrlaNlT7aNtAEGynBKm20oWgCMJUipUipUipSAYqVKqU9UqRVoEIqVIq05Vp4WgBAKcBSgU7FIBuKKWkNAAaSg00mgBc0maTNJmmA7NGabmjNAC0lGaSgBDTGp5phqWNEZqMipTUZqWWiMimkU800ipKuNxRilxS4oHcQCngUAU4CmSAFPAoApwFUhABTgKUClApkhilxS0uKoBuKXFOxRimK5rUCiitTEWlFJRQMWijNJmmAtJRSUCCkNGaQmkMQ0w04mmk1LGNNNNONNNQykNIppFPNNNQ0UhhFNxTzTTSsMSiloFFh3FAqQUwVIoppCuPWpFpi1IKqwhwp1NFLQIWmk0pNMJoEBNMJoJphNIYE00mgmmE0CFJppNITTSaYATTCaCaYTQAjGomp5NRsaBjGqM08mmGkURkUwipDTTQMjIpMU80lMYzFLilopoQYpwFJThVEigU4CkFOFMQ4ClxSCnUEhilxRS0AJijFLRQAmKMUtFIBMUYp2KMUAMxSYp+KTFKw7jCtN21LSYoAj20bafilxQMYFpwWnAU4CgBFWpFWlAp4FIQKtSBaAKkAoAAKcBSgUuKQwxRS0GkA2mmnmmGgY00wmnGmGgAJpM0hNJmgB2aM0zNGaYD80ZpuaTNACk00mlpppDENMNOJppqRoYaaaeabSsUJilAopRRYAFPApop4p2EOApwFIKeBTRLACnAUAU4CqEIBS4pcU7FMQ3FLinYoxTA0aXNJRWpmLRmkozQAuaM03NJmgQ7NJmmlqaWoAeTTS1MLU0tSAfupC1RlqaXpMaJCaaTTC1NLVLRQ8mkJqMtSbqmw7kmaTNR7qN1KwySlFRhqcDRYCQU8VGDUgNFgJBTxUYNPBpgPpc03NGaAFJphNBNMJpABNMJoY0wmkAE0wmgmmk0DAmmk0hNNLUABNMLUhamFqAAmmE0hNNLUhgTTCaC1NJoGKTTCaCaaTTGBNJmkJppagB2aM0zdRuqhEmacDUQalDUySYGnA1CGpwaqEyYGnA1EGpd1BJLmlzUe6jdQBJmjNM3UbqBD80uaj3UbqAJM0Zpm6jdQA/NGaZupN1IY+imbqN1ADqWmbqUNQMeKeKjBpwNAEoqRaiBqQGkBIKkFRA1IDSAeKdTAadmkMdSGkzRmkAhphpxNMJoGNNMNOJphNACGkzQTTc0ALRmm5ozQMdmjNMzRmmA7NNJpM0hNIYE0maQmkJoAKSkJpM0rAOpRTM04GiwXHinimCninYVx4p4pgqQUxDgKcBSAU8CmIAKXFLS0xCYpcUUtAFyikorYzFpM0hNNJpAKTTS1IWqNmpAOLUwvTGeoy9AiUvTS9Ql6YZKAJy9NL1AZKaZKBk5emmSq5kppkpWHcs76TfVbzKPMqbFFnfQHqt5lOD0rBcshqkDVVD1Ir0DuWVNSKarq1Sq1ICcGng1CGp4agZJmgmmbqTdSAcTTCaQtTC1IBWamE00tTC1AxxamFqaWppakMUmmk00tTC1IBSaYWpC1Rs1MYpamFqaWphakA4tSFqjLU0tTGPLU0tUZeml6AJC1NLVEXppemBLuo3VAXpN9MRZD0oeq2+lD1RJaD04PVUPTg9MRaD04PVUPThJTEWQ9Lvqtvo8ygRZ30b6r+ZR5lMRY30u+q3mUb6ALO+l31W8yjzKQFjfRvqt5lHmUDLG+jfVbzKPMoAtb6UPVXzKcJKALQepA1Uw9SB6QFxWqRWqor1Ir0AWw1PDVVV6kD0gLIanbqrh6cGpDJt1Gai3UbqQyQmmE0hamFqQxSaYTSFqaWoAUmmk0hamk0DHZpM03dSbqYD80maZupC1Ax5amlqYWpC1IB5amlqYWppamA/dRmot1G6gRNupQ1QhqcGoETg1KpqupqVTQBOtSrUKmpVpiJBTxTRTxTEKBS4oFLigQmKXFLRQBYzSZpM0hNbECk0wmgmmM1IBGao2ahmqFmpADPUTPTXaoWegRIXqMvUbPUZegCYyU0yVAXphegCcyU0yVAXppegZY8yk8yq2+jfSGWhJTxJVMPTlekMvK9Sq9UVeplekMvK9Sq1UleplekMuK1PDVUV6eHpDLG6gvUG+k30hkxaoy1Rl6YXpASFqYWqMvTC9ICQtTC1Rl6aXoGPLUwtUZemF6QyQvUTPTC9Rl6AJC9RlqjL0wvQMlL0wvUReml6YEhemF6iL0wvQBMXpheoi9ML0xExek31Bvo30xFjfSh6rb6cHpiLIelD1WD0oemItb6USVWD0u+mBZ8yl8yqu+l30xFrzKPMqrvo30CLXmUeZVbfR5lMCz5lHmVV8yjzKQFnzKTzKreZSeZQBa8yjzKq+ZR5lAy2JKcJKpiSnCSgC6JKkWSqIkqRZKQi8slSrJVBZKkWSgC+slSCSqKyVIJKQy8JKcHqkJKeJKQFzfRvqr5lL5lIZZ300vUHmUhegCYtTC1RF6aXoGTFqaWqIvSb6Bku6k3VDvpN9AE26kLVCXpC9AyUtTS1RF6YXoAlL0heoS9JvpiZLvo3VDvo30yScNTw1Vw1PVqALStUymqitU6NSAtqamU1VQ1YU0xE6mpBUKmpVoESClpopwoELiiilpgOzTSaTNNJrQkUmo2agtUTNSARmqB2pztUDtQA12qFmpXaoGagAZqjLUjNUZagBxamlqYWphagB5eml6YWppagB5ajfUW6k3UDJw9OD1XDU4NSGW1epVeqatUqvSGXVepleqKvUqyUhl4SU4SVTElO8ypGW/MpDJVbzKQyUDLBkppkquZKaZKQE5emF6gMlMMlICcvTC9Ql6YZKQyYvUZkqEyUwyUATNJUZeoTJUZkpgTF6YXqEvTS9ICUvTC9RF6aXoHckL0wvUZamlqYrkhemlqiLUm6mFyXdSbqi3UbqYrk26l3VDmlzTETbqXdUOaXdTAm30u+od1G6gRNvo31Duo3UwJ99G+oN1G6gCffRvqDdRuoETb6N9Q7qTdQBMXpN9Q7qTdQBPvo31Bupd1AycPTg9Vw1KGoAtB6eHqoGp4ekBcElSLJVEPUgkoAvLJUgkqgJKeJKQF8SU8S1QElPEtIZeEtL5lUhLSiWgC75lJ5lVPMo8ykBaMlIZKreZSeZQMsF6TzKr+ZSGSgCx5lJvqt5lJ5lAyyXppeoPMpu+gCwXppeoN9JvoAmL0m+ot1Jupkku6lDVDupQ1MROGqRWquDUimmBaVqnQ1UU1OhpAXENToaqIasIaALSmplNVkNTKaBEwp4qNakFMQ4UtIKdQIgJppamlqYWrQQ5mqJmoZqiZqQxrtUDtTnaoHagBrtULGnM1QsaAEY1GTSk0wmgBCaaTQaaaQCE00mlNNNABmkzRSUDHZpQajzS5pDJg1PVqgBpwagCyHqQPVUNTg9IZbElL5lVd9HmUgLXmUhkqt5lIZKBlkyU0yVWMlNMlICwZKaZKrmSmmSkMsGSmGSoDJTC9AE5kqMyVCXpheiwEpkphkqEvTC9AExkppeoS9JuoAlL0heot1JuoAkLU0tTc0madhXHE0mabmjNOwrjs0uaZS0wH5pc0yloAdmlzTaKAHZozTaTNMB+aTNNzRmgB+aTNNzSZoAfmjdTM0ZoAfupN1MzRmgB2aM0zNGaBD80uaZmjNMB+aUNTM0ZpAShqcGqHNLmgCYNTw9V80oakMsh6cHqtupd9IC0JKcJKqB6UPSGXBJSiWqfmUvmUAXPNpfMqn5lO8ygC15lHmVV8yjzKALPmUhkqvvppegCwZKTzKrl6TfQMs76TfVffRvoAsb6N1QBqcGoAm3UZqMGnA0xD804GmCnCmIkBqRTUQqRaAJ0NToarKanQ0AWkNWENVENWENIC0hqdTVZDU6mgRYU1IKhU1KKZJIKcKaKcKBGeWphamlqYWrQBWaomahmqJmpDEZqgZqczVCzUAIzVExpWNRk0AITTSaCaQ0hiGmmlNNNACGmmnGmmkMSkpaMUAJRRRQMWlzTaM0gH7qXdUeaTNAEu6jfUO6k3UxExeml6hLUhelYCUvSF6hL00vSsMmL00vUJeml6LDJi9NL1CXpC1ICQvTC9MLUwtQMeXppamE0hNADt1G6mZozQIfmjNNpaYhc0UlLQAUtJS0xBS0YpcU7AAoFFLQAUUUUAFFFFACUUUUAJRRRTAKSg0UgCkoooAKKKKYC0UUUCFooopDClzSUUALmjNJSZpDH7qN1MzSZoGSbqXdUWaN1IRLvpd9Q7qN1AE4el31X3Uu6gCxvo31Buo3UATb6TfUW6k3UAS76TfUW6jdQBNupQ1QA08GiwyYNTwahBqRaYEoNPFRrUi0CHinimCnimA4VItMFPFAEq1MhqBalU0gLKGp0NVkNToaALSGp1NVkNToaBFlDUy1XQ1OtAiVaeKjFSCkIxS1RlqaWphatRCs1RM1DNUbNQAjNUTGlY1GxpDEJphNKTTCaAA0lFJSGIaQ0tIaQDTSUppKBiUUtFIYlJS0UAJSUtJQAhppNKaaaYgJppNBppoACaYTQTTSaBAWppakJppNAxS1NLUhNNJpDHE0mabmigYuaaTRSUDAmkNFFAhKUUYpcUAApwpAKcBQIBS0Yp2KYhMUYpcUYpgFFLiigAoopaACiiikAUlLRTASjFLSUAJSU6koASkp1JQAlFLRQAlFLijFAhKWijFABRRRQAUUUUhiUlLSUDEpKWkoATNGaKSgAzRmkopAOzRmm5ooEPzRmmZozQA7NGabmkzQMdmjNNpRTAeDThTBT1oAkWpVqJalWgCValWolqVaAHiniminikAop4popwoAkFSKaiBp6mgCwpqZDVZTU6GkBaQ1YQ1UQ1YQ0CLSGp1NVkNTKaBFhTUgNQqakBpAc8WphNBNMJrYkRjUbGnE1GTQA0mmE0rGmE0hiE00mg000DDNFJRmkAUlFFACGg0UUhiUUUtACUlLRSGJTTTjTTQIaaaacaaaYDTTDTjTTTEMNNNONNNADDTDTzTDQA00lOpKQxtFLilxQMbRinYoxQMbijFOxRigBuKXFLilxQAgFOAoxS4oEAFLQKWmITFLRRQIKKKKACiiigYUUUUgFpKWigBKKKKYAaSlpKADFJS0UAJRilxS4pgNxRinYpKQhKKWkxQAUlLRQAlFFBoGJSUtFAxtJTqSgBtJSmikIbRS0YoAbilpaMUAJSUuKKAEooxRigApRRilAoAUVIKaBTxQA9akWoxUq0DJFqVahWpAaAJRTxUYNPBpAPBpwNRg04GgCQGng1EDTwaQE6mplNVlNTKaALSGrCGqaNVhGoEW0NTqaqI1Tq1AFpTTwagVqeGpCMAmmk0pNMJrYkQmmGnE0w0DGGmGnGmGkMaaQ0pNNJoASkzRmigAopKKQC0UlLSAKSlooGJRRSUAJSGlNNNAhDTTTjTDTAaaaacaaaBDTTDTzTTQAwimEVIRTSKBjKTFPxSYoGNxS4pcU7FAxmKXFOxRigY3FGKdijFADMUuKWikITFLRRQIWiiimIKKKKACikooAWkoopDFopKM0DFoozRmgQUUmaM0wFoozRQAYooooAKWiimAYpKWikAlJSmg0ANNFLSUAJRRRQMSiikoAKSlNJQAhpKWigQlFLRigBKKXFGKAExSYp2KMUANxRinYoxQAmKUClxTgKAEAp4FAFOAoAUU8U0U4UAPFSA1EDTwaQyUGng1CDTwaQEoNOBqMGnA0ASA04GowacDQBKDUqmoAakU0gLKNU6NVRWqZGoEXUaplaqaNUytSAtq1SBqqq1SBqQGQTTSaCaaTW5AGoyacTTCaBoaaYacTTDQMaaaacaaaBiUmaDSUALRSUUhC0tJRSAXNFFFABSUUhoAQ0hpTTTTEIaaaU000AIabTqSkA0000+mkUANIppFPxSYoGMxSYp+KMUANxRinYpcUDG4pcUuKMUDG4pKfikoAZSGnGkoASiiigQUUUUCFpKKKACkzRRSGFLmkooGLmjNJRQAuaM0lFAhc0maKKAFopKWgBaKSlpgLRSUtABRRRSAKSlpKBiUlOpKAG0UtJTASkpaSgBDRS0lABSUtFABS4opcUCEoxS0YoATFGKXFLigBuKXFLilxQAmKUClxS4oATFOoxS0AFLRRQA4U4GmClFIZIDTwaiBp4NAEgNPBqIGng0gJAacDUYNOBoAkBp4NRA04GgCwrVKrVVVqlVqALatU6tVNWqZWpAW1apA1VVapA1IDOLUmaZupC1bmYpNNJpC1NJpDAmmk0hNNJoKAmkJpCaQmgAJpKTNJmgB1GabmjNIQ7NLmmZp2aAHUU3NGaQC0hNGaTNMANNNBNIaBCGkopKBBSUuaSkMKSlooAbikxTqSkA3FGKdikpjExRS0UAJiilopjEppp1IaAGmm040lACUlLSUgCkpaSgAoopM0gFpKKKACiiigAooooAKKKKYBS0lLQAUUUUgFopKM0wFpaSigBaWkpaQBRQKWgYlJS0lACU2nUlMQ2kp1JQAlFGKXFAxKKWloEJS0YpaAExS4pcUUAJilxS4oxQAmKXFLilxQAmKXFLRQAYooxRQIKKKKBhS0lKKAHCnCmCnCkMkBpwNMBpwNADwaUGmZpc0CJAacDUQNKDSGTBqkVqrg1IrUAWVap1aqimpkNIZaVqlDVWU1KpoAziaaWppNITWxkOJppNNzSE0ihSaaTSE00mgBSaQmkJpM0ALmkzTc0maAHZozTM0ZpASZpc1HmlBoAkzRmmZpc0gHZpM0maTNMBSaaaKSgQUlFJmgQtFJRSGLRSZooAKKKKQCUUtFMY3FFLRQAlFFFMBDSUppDQAlIacaaaAG0lONJikAlJTqSgY3FFLRSASiiigBKWiigAoopcUxCUClxS4oASjFLijFAxMUuKXFJigBKKWigBBS0UUALS0lLQAUtFFABikpaTFACUlOpKYhtJTqMUANxRTsUmKAExS0YpcUhiUtLijFIAopcUuKAEpaMUuKYBilxRijFAgopaKAEpDS0UwEpKU0lIYUtJRQA4U4GmU4UhjwadmowaXNAD80uaZmlzQIfmlBpmaUGgCQGnqaiBp60DLCmpkNV0qZKQywpqVTUK1KtIZm001IRTSK3MhhpppxFNIpANJppNKaaaQwJppNBppoEGaM0lJQAuaM02igB2acDTKUUhjwaWmilFAC5oooxQAGkpcUmKBCUlOIpMUANozS4oxSAKKXFGKACijFGKBiUU7FJigBMUlOxRimA2kxT8UmKBDaSn4pMUDGYpMU/FGKQEeKMU/FG2gCPFJipMUmKQxmKTFSbaTbQAzFGKfto20AMxRin7aXbTER4pcU/bS7aYiPFLipNtG2gYzFGKk20baQEeKMU/bRtoGR4oxT9tG2mBHilxT9tG2gQ3FGKdilxQA3FGKdijFADcUU7FGKAGYpMVJto20wI8UmKl20baBEeKMVJto20gI8UYqTbRtpDGYoxT9tLtpAMxS4p2KNtADcUuKdtpcUwG4oxT8UYoAZijFPxSYoAZSU/FJimAykp+KTFAxtFLijFIBBThSYooAdS02loAWlpKWkIWnCkApwFAxRUi00CpVFAD0FToKiQVYRaCh6iplFMValVaQyiUppWrRSmFK1MSoVphWrbJUbJQMqlaYRVkpTClAFcimkVOUppWgCAikxUxWk20AQ4oxUu2jbSAjxTgKfspQlAxoFKBTwlOCUgI8Uu2pQlLsoAh20m2p9lJsoEQ7aTbU+yk2UAQbaNtTbKNtAEW2jbUuyl2UDIdtLtqXZS7KQEO2jbU2yjZQBDto21NspdlMCDbSban2UbKBEG2k21Pso2UAV9tG2p9lGykMr7aNtT7KNlAEG2k2VZ2UmykMr7aNlWPLo8ugRX2UbKseXRspgV9lGyrHl0vl0xFfZS7KseXS+XQBX2UbKs+XR5dAFfZRsqx5dHl0DK2yk2Va8uk8ugCtspNlWfLo8ugZW20baseXR5ftQIr7aNtWPLo8umBX20u2p/Lo8ukBBto21P5dLspgV9tLsqfy6Xy6BFfZRsqz5dHl0wK2yjZVny6PLpAVtlGyrPl0eXSArbKNtWPLo2UgK+2l21Pso8ugCDbS7am2UuygCDbRtqfZRsoAg20m2rGyk2UwK5Wk21YKUmygZWK0m2rBSkKUxlfbRiptlJsoAhxRipdlLspARYoxUuyjZQIjApwFPCU8JSAYFpwWpAlPVKAGqtSqtOVKlVKQxFSp0WlRKmVKBiKtSqtOVKkCUDK5jphjq4UphStDIpmOo2jq8Y6jMdAyiY6jMdXmjqMx0CKRSmFKumOmmOgCkUo8urZipPLoAqeXR5dW/LpfKoGVPLpwjq0IqURUgKwjpwjq0IqcIqAKojpfLq0IqXyqAKnl0nl1c8qjyqAKfl0nl1c8qk8qgCn5dHl1b8qjyqAKnl0vl1b8qjyqQyp5dL5dW/KpfKoAqeXR5dW/KpfKoEU/Lo8urnlUeVTAp+XR5dXPKo8qgCl5dHl1c8qk8qkBT8uk8urnlUeXSAp+XR5dXPLo8ugZT8ujy6ueXR5VAFTy6Ty6ueVR5VAin5dHlVd8qjyqYFPy6Xyqt+VS+VQBT8uneVVvyqXyqBFTy6PKq55VL5VAyl5VHl1d8qk8r2oApeXR5VXPKo8qgZS8qk8qrvlUeV7UAUvKo8qrvlUeVQBS8ujy6ueVR5VMCn5VJ5ftV3yqPK9qBFPy6PLq55XtR5VAFTy6XyqueVS+VQBT8ql8qrnlUvlUxFLyvak8qr3le1HlUgKPlUnlVe8qk8qgCl5dJ5dXfKo8qkBS8ujy6ueVR5XtQBT8ul8urflUvlUDKfl0eXVzyqPKoEU/LpPLq55VHlUxlIx03y6vGKmmKgCkY6aY6umOmmKmMpeXSeXV0xUnlUAUvLo8urnle1J5VICp5dHl1b8ql8qkIqiOnCOrQipRFQBXEdSrHUwiqVY6QECx1MsdTLHUqx0DIljqZUqRY6lWOgdyNUqQJUoSnhKQXINlNKVY20myrIKxSmGOreykKUAUjHTDFV4x00x0wKBippiq+YqaYqBFHyqTyqveVSeVQMpeVR5VXfKo8qkBTEVOEVWxFThFTAqCKnCKrYipRFSAq+VS+VVvyqXyqYFPyqTyqu+VR5VAFHyqPKq75VJ5VAFPyqPKq55dL5VAFLyqPKq75VHlUhlPyqPKq55dL5VAFPyqPKq55VL5VAin5VHle1XPKpfKoApeVR5VXfKo8qgCj5VJ5VXvKpPKpAUfKpPKq8YqTyqAKXlUeVVzyqPKoAp+V7UeVVzy6Xy6AKflUeVVzy6Xy6AKflUeVV3yqPKoAp+VR5VXfKo8qgCn5VL5VXPLo8ugCp5VHlVc8ujy6AKfl0eVVzy6Ty6BlPyqTyqu+XR5dAFLyvajyqueXR5dAFPyqPKq75VHlUAUvKo8qrvlUnl0wKXlUeV7Vd8uk8ugCn5XtS+VVvy6Xy6BFPyqXyqt+XS+XQBU8ql8qrfl0vl0wKnlUeVVzy6Ty6AKflUnlVd8uk8ukBS8qjyqu+XSeXQBS8r2o8qrnl0eXQBT8r2o8qrnl0vle1ICl5VHlVd8ujy6AKXlUeVVzy6Ty6YFIxU0xVeMdIY6YygYqQxVeMdNMVMCl5VJ5VXfKpPKpAUvK9qPK9qu+V7UeV7UgKXlUvlVd8qjyqAKYipwiq35VOEVIRUEVSLFVkRU8R0AV1jqRY6nEdPEdAyJUqRUqUJTwlAEYSnBakC04LQBX20bakxS7aBEWyk2VPto20AV9lIY6s7KNlAFUx0nl1a2UmymIq+XSeXVrZSbKAK3l0eXVnZRsoGVvLpwjqxspQlAEAjpRHU4SnBKAIBHS+XU+yl2UCK/l+1Hl1Z2UbKYFby6Ty6tbKNlAFXy6PLqzso2Uhlby6PLqzso2UAVvLpfLqxto2UAV/Lo2VY2UbKBEGyjZVjZRsoAg8ujy6sbKNtAFby6PLqzspClICqY6Ty6slKTZQMreXR5dWNlGygCvso8urGyl2UxFfy6Xy6sbKXZQBW8ul8urGyl2UgK/l+1Hl1Y20bKBlfy6NlWNtG2gCDZR5dT7aNtAEGyk2VY20baYFfZRsqfbRtoAg2UbKn20baQEGyjZU+2jbQBBspNlWNtG2gCv5dGyrG2k2UwK+yl2VPto20AQbKXZU22l20CIdlGypttLtpgQ7KNlTbaXbQBBspNlT7aNtAFfZRsqxtpNtAFfZRsqxto20gINlHl1Pto20AQeXR5dWNtJtpDK+yk2VZ20hWmBW2UmyrG2k20wKxjpPLqztpNlAFby6PLqzto2UDK3l0vl1Z2UBKQFby6Xy6s7KXZQIreXSiOrOyjZSAriOnCOp9lLtoAhCU4JUu2l20AMC04LTsUuKBDQtOxS4paBlcClxSgU4CgQgFLtpwFKBQMbto21JijFAEe2k21LikxQBFtpNtS4pMUAR7aNtSYoxQMj20u2n4pcUAM20oWn4pcUxDQtLtpwFOxQAzbRtp+KXFAiPbRtqXFG2gRFto21LtoxQMh20bal20mKAI9tG2pMUmKAGbaNtPxRigBm2l207FLigBm2jbT8UUgGbaTbUmKMUhkW2k21LikxQBHto21JijFAEe2jbUm2lxTER7aXbUmKXFMRHto21JikxSGM20m2pMUmKAGYpMU+koAbijFOooAbijFOopgNxRinYoxQA3FGKdijFIY3FGKdijFADcUYp1FADMUYp+KSgBuKMU6imA3FGKdiigQ3FLilpaAG4oxTqMUwG4oxTsUUANxSYp+KSgBuKXFLS0AMxS4p1FIBuKMU7FFIYzFJipKSmBHik21JikxQBHto21JikxQAzbRtp+KXFAxm2l20/FGKAGbaXbT8UuKBDNtLtp+KMUAM20Yp+KMUgGYoxTqSgBKWkopgLRTc0ZoAaBTgKQU4UhCgUooFLQMKWiloASkpaQ0DENJSmkzQOwlFGaM0BYKWkzS0AKKWkFOFMQopaSnCgQoFKBRSigQYoxTsUuKBDMUYp+KTFADMUmKfikxQMZikxT8UlADcUYpaSkMMUUlGaAFzRSZozSAWim5ozQMWikzS0AJS0UtABilxQKWmITFLilooEJSU4000AJTTSmmk0DCkoJpuaAHZopuaXNMBaWm0tAC0UUUCCiiigAoopKQxaSiimAUUUlABRRRmgAoozRSAWiiii4BS0UUAFFJRTAKKTNFMQtFJS5oAKWkzRmkMXNJRmikAUlKaSgYGkpaSmAUUUUAFFFFAC0tJS0AKKdTRTqYgxSYpaKQCUlLSUAIaaaUmmk0DCkzQTSZoAXNJmkzSZoAkpRSUtIQ6lpBSigBaKBSUDA0hpaaaBgTTc0E03NIYtFJmjNMYuacDTKUGmIfThTKcKCR9OFMFPFMQ8Uopop4oEKKdikFOoEJikNOpDQA002nmmmgY00004000hiUlBpDSGJSUE0maQxc0ZpM0maQDs0U3NLmgBaWm5paAHUtNFKKYDqWkFLQIWiiimAhpppTTTQIQmmk0pNMJoAQmkzSE0maYDs0optKKAHUtIKWmAtLSUtAgoopKACiiikMSiiigYUUlFABRSUUCFopKWpGLS0lKKBhRRRQAUlFJVIQUUlFMQtFJRQA6ikopDFopKM0gFzSZpM0uaACiiigApKWkpjClpKKAHUtNpaBDgaWmilpiFoopKADNITQaaTQMCaaTQTTSaQATTc0E0lMBc0maSigD//2Q==", + "job_id": "4123b4ec-ea71-49f4-b7e2-ad86d622b947", + "grid_index": 0, + "is_alteration": false, + "order": 2, + "section_id": 0, + "request_id": "fc39cefd-fcf9-4775-b490-7e17ce670060", + "url": "https://imagine-public.x.ai/imagine-public/images/7693b927-1c34-488c-8ccc-6750367c66b1.png", + "id": "7693b927-1c34-488c-8ccc-6750367c66b1", + "prompt": "a dog typing on a keyboard", + "full_prompt": "a dog typing on a keyboard", + "percentage_complete": 50, + "model_name": "imagine_h_1", + "suggested_moderation_rule": null, + "r_rated": false +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_complete_status_notification.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_complete_status_notification.json new file mode 100644 index 00000000..fcbeb216 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_complete_status_notification.json @@ -0,0 +1,25 @@ +{ + "type": "json", + "current_status": "completed", + "percentage_complete": 100, + "job_id": "c1bed796-3f05-4716-8ef0-a4d4900dfc6e", + "elapsed": null, + "prompt": "a dog typing on a keyboard", + "confirmation": "Drew a dog typing", + "full_prompt": "a dog typing on a keyboard", + "flags": null, + "is_alteration": false, + "section_id": 0, + "input_type": "text", + "request_id": "fc39cefd-fcf9-4775-b490-7e17ce670060", + "asr_transcript": null, + "asr_accepted": null, + "seed": null, + "image_reference": null, + "is_image_edit": null, + "moderated": false, + "r_rated": false, + "order": 1, + "model_name": "imagine_h_1", + "image_id": "78b3e6ef-defc-41a6-a9ac-b7a370d26ce5" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_in_progress_response.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_in_progress_response.json new file mode 100644 index 00000000..e84278d1 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_in_progress_response.json @@ -0,0 +1,25 @@ +{ + "type": "json", + "current_status": "start_stage", + "percentage_complete": 0, + "job_id": "57baeffe-d5cf-483b-a5bb-7794899f905c", + "elapsed": null, + "prompt": "a dog typing on a keyboard", + "confirmation": "Drew a dog typing", + "full_prompt": "a dog typing on a keyboard", + "flags": null, + "is_alteration": true, + "section_id": 0, + "input_type": "text", + "request_id": "fc39cefd-fcf9-4775-b490-7e17ce670060", + "asr_transcript": null, + "asr_accepted": null, + "seed": null, + "image_reference": null, + "is_image_edit": null, + "moderated": false, + "r_rated": null, + "order": 7, + "model_name": "imagine_h_1", + "image_id": null +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_request.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_request.json new file mode 100644 index 00000000..5ea498f9 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/create_image_request.json @@ -0,0 +1,21 @@ +{ + "type": "conversation.item.create", + "timestamp": 1761010203630, + "item": { + "type": "message", + "content": [ + { + "requestId": "fc39cefd-fcf9-4775-b490-7e17ce670060", + "text": "a dog typing on a keyboard", + "type": "input_text", + "properties": { + "section_count": 0, + "is_kids_mode": false, + "enable_nsfw": true, + "skip_upsampler": false, + "is_initial": false + } + } + ] + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/empty.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/empty.json new file mode 100644 index 00000000..9e26dfee --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/other_type.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/other_type.json new file mode 100644 index 00000000..9bb5b894 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/other_type.json @@ -0,0 +1,4 @@ +{ + "type": "other_type", + "foo": "bar" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_fast_image_prompt_request.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_fast_image_prompt_request.json new file mode 100644 index 00000000..cbb06f3c --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_fast_image_prompt_request.json @@ -0,0 +1,26 @@ +{ + "type": "conversation.item.create", + "timestamp": 1787523809686, + "item": { + "type": "message", + "content": [ + { + "requestId": "2542de9d-9018-4b13-bef9-74f1fc8c4422", + "text": "Race car", + "type": "input_text", + "properties": { + "section_count": 0, + "is_kids_mode": false, + "enable_nsfw": true, + "skip_upsampler": false, + "enable_side_by_side": true, + "is_initial": false, + "aspect_ratio": "3:2", + "enable_pro": false, + "num_generations": 2, + "enable_watermark": false + } + } + ] + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_image_complete.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_image_complete.json new file mode 100644 index 00000000..776ed3b6 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_image_complete.json @@ -0,0 +1,26 @@ +{ + "type": "image", + "blob": "/9j/4QKQRXhpZgAASUkqAAgAAAADAA4BAgAMAQAAMgAAADsBAgAlAAAAPgEAAGmHBAABAAAAYwEAAAAAAABTaWduYXR1cmU6IGNEdS9YWHJISTZuc3o0d1lM", + "job_id": "044f77e6-b23e-4d4e-b5cc-0f4b04d39b64", + "grid_index": 0, + "is_alteration": false, + "order": 1, + "section_id": 0, + "request_id": "ab3fa8e9-92ed-4f1b-a350-7a897e264d54", + "url": "https://imagine-public.x.ai/imagine-public/images/044f77e6-b23e-4d4e-b5cc-0f4b04d39b64.jpg", + "id": "044f77e6-b23e-4d4e-b5cc-0f4b04d39b64", + "prompt": "A dead tree stump in the middle of a forest meadow", + "full_prompt": "A dead tree stump in the middle of a forest meadow", + "percentage_complete": 100.0, + "model_name": "imagine-x-1", + "r_rated": false, + "moderated": false, + "side_by_side_index": null, + "confirmation": null, + "width": 768, + "height": 1152, + "has_watermark": null, + "is_jurisdiction_restricted": null, + "is_pro": null, + "mode": "fast" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_image_prompt_request.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_image_prompt_request.json new file mode 100644 index 00000000..648b2942 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_image_prompt_request.json @@ -0,0 +1,26 @@ +{ + "type": "conversation.item.create", + "timestamp": 1787514844375, + "item": { + "type": "message", + "content": [ + { + "requestId": "ab3fa8e9-92ed-4f1b-a350-7a897e264d54", + "text": "A dead tree stump in the middle of a forest meadow", + "type": "input_text", + "properties": { + "section_count": 0, + "is_kids_mode": false, + "enable_nsfw": true, + "skip_upsampler": false, + "enable_side_by_side": true, + "is_initial": false, + "aspect_ratio": "2:3", + "enable_pro": false, + "num_generations": 2, + "enable_watermark": false + } + } + ] + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_json_progress.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_json_progress.json new file mode 100644 index 00000000..c14261c0 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_json_progress.json @@ -0,0 +1,28 @@ +{ + "type": "json", + "current_status": "start_stage", + "percentage_complete": 0.0, + "job_id": "44cc8719-af91-4ae9-afb8-9b203a773bd9", + "elapsed": null, + "prompt": "A dead tree stump in the middle of a forest meadow", + "confirmation": null, + "full_prompt": "A dead tree stump in the middle of a forest meadow", + "flags": null, + "is_alteration": false, + "section_id": 0, + "input_type": "text", + "request_id": "ab3fa8e9-92ed-4f1b-a350-7a897e264d54", + "asr_transcript": null, + "asr_accepted": null, + "seed": null, + "image_reference": null, + "is_image_edit": null, + "moderated": null, + "r_rated": null, + "order": 0, + "model_name": "imagine-x-1", + "image_id": "44cc8719-af91-4ae9-afb8-9b203a773bd9", + "side_by_side_index": null, + "width": 768, + "height": 1152 +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_quality_image_prompt_request.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_quality_image_prompt_request.json new file mode 100644 index 00000000..0322a9d3 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_quality_image_prompt_request.json @@ -0,0 +1,26 @@ +{ + "type": "conversation.item.create", + "timestamp": 1787523733731, + "item": { + "type": "message", + "content": [ + { + "requestId": "10c55492-82d8-4eff-ba7b-0d14cb4d5fe2", + "text": "luxury car", + "type": "input_text", + "properties": { + "section_count": 0, + "is_kids_mode": false, + "enable_nsfw": true, + "skip_upsampler": false, + "enable_side_by_side": true, + "is_initial": false, + "aspect_ratio": "21:9", + "enable_pro": true, + "num_generations": 2, + "enable_watermark": false + } + } + ] + } +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_rate_limit_error.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_rate_limit_error.json new file mode 100644 index 00000000..afd926a6 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_rate_limit_error.json @@ -0,0 +1,6 @@ +{ + "type": "error", + "err_code": "rate_limit_exceeded", + "err_msg": "Image rate limit exceeded", + "request_id": "5c8fdd50-11ab-4e7c-9f64-301902eb6678" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_session_notice.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_session_notice.json new file mode 100644 index 00000000..650e626e --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/real_session_notice.json @@ -0,0 +1,4 @@ +{ + "type": "session", + "conversation_id": "e39c482a-b1e4-4b70-afd3-0172581a27c8" +} diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/wire.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/wire.json new file mode 100644 index 00000000..a7900b55 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/wire.json @@ -0,0 +1 @@ +{"type":"json","current_status":"start_stage","percentage_complete":0.0,"job_id":"0080eaac-f7f7-4369-90a2-346491939c1b","elapsed":null,"prompt":"a dog riding a motorcycle","confirmation":"Drew a dog riding a motorcycle","full_prompt":"a dog riding a motorcycle","flags":null,"is_alteration":false,"section_id":0,"input_type":"text","request_id":"bbc15402-3257-4415-922e-b156c151f3c2","asr_transcript":null,"asr_accepted":null,"seed":null,"image_reference":null,"is_image_edit":null,"moderated":false,"r_rated":null,"order":0,"model_name":"imagine_h_1","image_id":null} \ No newline at end of file diff --git a/crates/api_clients/grok_consumer_client/test_data/websocket_messages/wire_formatted.json b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/wire_formatted.json new file mode 100644 index 00000000..2f458d51 --- /dev/null +++ b/crates/api_clients/grok_consumer_client/test_data/websocket_messages/wire_formatted.json @@ -0,0 +1,25 @@ +{ + "type": "json", + "current_status": "start_stage", + "percentage_complete": 0, + "job_id": "0080eaac-f7f7-4369-90a2-346491939c1b", + "elapsed": null, + "prompt": "a dog riding a motorcycle", + "confirmation": "Drew a dog riding a motorcycle", + "full_prompt": "a dog riding a motorcycle", + "flags": null, + "is_alteration": false, + "section_id": 0, + "input_type": "text", + "request_id": "bbc15402-3257-4415-922e-b156c151f3c2", + "asr_transcript": null, + "asr_accepted": null, + "seed": null, + "image_reference": null, + "is_image_edit": null, + "moderated": false, + "r_rated": null, + "order": 0, + "model_name": "imagine_h_1", + "image_id": null +} diff --git a/crates/api_clients/grok_consumer_statsig/Cargo.toml b/crates/api_clients/grok_consumer_statsig/Cargo.toml new file mode 100644 index 00000000..85844e41 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/Cargo.toml @@ -0,0 +1,44 @@ +[package] +name = "grok_consumer_statsig" +edition = "2024" +version = "0.0.1" +publish = false + +[lib] +name = "grok_consumer_statsig" +path = "src/lib.rs" + +# Live statsig harvester. Launches a real WebView, so it is gated behind the +# `webview-harvest` feature that pulls in wry/tao. +[[bin]] +name = "harvest_statsig" +path = "src/bin/harvest_statsig.rs" +required-features = ["webview-harvest"] + +[features] +# Pull in the WebView stack (wry/tao) for the live statsig harvester. Off by +# default so ordinary library builds stay lean. +webview-harvest = ["dep:wry", "dep:tao", "dep:env_logger"] + +[dependencies] +# Internal +errors.workspace = true + +# External +base64.workspace = true +chrono.workspace = true +log.workspace = true +serde = { workspace = true, features = ["derive"] } +serde_json.workspace = true +sha2.workspace = true +thiserror.workspace = true +tokio = { version = "1", features = ["sync", "time", "macros", "rt"] } +toml.workspace = true + +# Harvest (live): only compiled with `--features webview-harvest`. +wry = { version = "0.55", optional = true } +tao = { version = "0.35", optional = true } +env_logger = { workspace = true, optional = true } + +[dev-dependencies] +tokio = { version = "1", features = ["sync", "time", "macros", "rt", "rt-multi-thread"] } diff --git a/crates/api_clients/grok_consumer_statsig/src/bin/harvest_statsig.rs b/crates/api_clients/grok_consumer_statsig/src/bin/harvest_statsig.rs new file mode 100644 index 00000000..30384a7a --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/bin/harvest_statsig.rs @@ -0,0 +1,44 @@ +//! `harvest_statsig` — tool 2. +//! +//! Opens a real Grok WebView, observes the `x-statsig-id` signatures the page +//! emits, and writes them (with every decoded piece) to `statsig.toml`. +//! +//! ```sh +//! cargo run -p grok_consumer_statsig --features webview-harvest --bin harvest_statsig -- [out.toml] [seconds] +//! ``` +//! +//! Log in and start a chat in the window to emit a `POST /conversations/new` +//! signature (the one video generation needs); other endpoints are captured +//! automatically as the page loads. + +use errors::AnyhowResult; +use grok_consumer_statsig::harvest_via_webview::{harvest_statsigs, HarvestConfig}; +use grok_consumer_statsig::statsig_cache_file::StatsigCacheFile; + +const DEFAULT_OUTPUT: &str = "statsig.toml"; + +fn main() -> AnyhowResult<()> { + env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); + + let mut args = std::env::args().skip(1); + let output_path = args.next().unwrap_or_else(|| DEFAULT_OUTPUT.to_string()); + let capture_secs = args.next().and_then(|s| s.parse().ok()).unwrap_or(90); + + let captures = harvest_statsigs(HarvestConfig { + capture_secs, + ..Default::default() + })?; + + let now = chrono::Utc::now().timestamp(); + let mut file = StatsigCacheFile::new(now); + for entry in captures { + file.upsert(entry); + } + file.save(&output_path)?; + + println!("wrote {} signature(s) to {output_path}", file.captured.len()); + for entry in &file.captured { + println!(" {} {}", entry.method, entry.path); + } + Ok(()) +} diff --git a/crates/api_clients/grok_consumer_statsig/src/browser_context.rs b/crates/api_clients/grok_consumer_statsig/src/browser_context.rs new file mode 100644 index 00000000..ced89523 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/browser_context.rs @@ -0,0 +1,36 @@ +/// Default WebView User-Agent. Must match the UA that obtained `cf_clearance` +/// and the one the `grok_consumer_client` HTTP client uses (Cloudflare binds +/// `cf_clearance` to the UA). +pub const DEFAULT_USER_AGENT: &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:143.0) Gecko/20100101 Firefox/143.0"; + +/// What a WebView needs so its grok.com page load passes Cloudflare and can run +/// Grok's signer. +/// +/// Neither field is folded into the signature itself (see the crate docs); they +/// exist only to make the *page load* succeed. In the app the natural source is +/// the existing xAI login window's WebKit session — same cookie store, same UA. +#[derive(Clone, Debug, Default)] +pub struct BrowserContext { + /// User-Agent for the WebView. Must match the UA that obtained `cf_clearance` + /// (Cloudflare binds `cf_clearance` to the UA) and the UA the + /// `grok_consumer_client` HTTP client uses. `None` keeps the WebView default. + pub user_agent: Option, + + /// Cookies to seed into the WebView before navigating, as raw + /// `name=value` pairs scoped to grok.com. Usually left empty when the WebView + /// already shares the logged-in WebKit data store; supply them explicitly + /// when driving an isolated WebView. + pub cookies: Vec, +} + +impl BrowserContext { + /// A context that only pins the User-Agent, relying on the shared WebKit + /// cookie store for the session. + pub fn with_user_agent(user_agent: impl Into) -> Self { + Self { + user_agent: Some(user_agent.into()), + cookies: Vec::new(), + } + } +} diff --git a/crates/api_clients/grok_consumer_statsig/src/harvest_via_webview.rs b/crates/api_clients/grok_consumer_statsig/src/harvest_via_webview.rs new file mode 100644 index 00000000..d5a16479 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/harvest_via_webview.rs @@ -0,0 +1,176 @@ +//! Live statsig harvester: open a real Grok WebView, inject the observing +//! harness, and collect every `x-statsig-id` the page emits. +//! +//! Compiled only with `--features webview-harvest` (pulls in wry/tao). A native +//! event loop must own its thread, so this drives the loop with `run_return` +//! and returns the captures once the observation window closes — usable from +//! both the `harvest_statsig` binary (main thread) and an `#[ignore]` test +//! (`any_thread`). + +use crate::browser_context::DEFAULT_USER_AGENT; +use crate::mint_harness::MINT_HARNESS_SCRIPT; +use crate::statsig_cache_file::{decode_statsig, CapturedStatsig}; +use errors::AnyhowResult; +use log::{debug, info, warn}; +use serde::Deserialize; +use std::sync::{Arc, Mutex}; +use std::time::{Duration, Instant}; +use tao::event::{Event, WindowEvent}; +use tao::event_loop::{ControlFlow, EventLoopBuilder}; +use tao::platform::run_return::EventLoopExtRunReturn; +use tao::window::WindowBuilder; +use wry::WebViewBuilder; + +const GROK_URL: &str = "https://grok.com/"; +const DEFAULT_CAPTURE_SECS: u64 = 90; + +/// How the harvester should drive the WebView. +#[derive(Clone, Debug)] +pub struct HarvestConfig { + /// Where the WebView starts. Defaults to grok.com. + pub start_url: String, + + /// User-Agent for the WebView. Must match the UA that obtained `cf_clearance` + /// and the one the HTTP client uses. Defaults to the crate's Firefox UA. + pub user_agent: Option, + + /// How long to keep observing before returning, in seconds. + pub capture_secs: u64, + + /// Show the window so a human can log in / start a chat (which is what emits + /// the `POST /conversations/new` signature). + pub visible: bool, + + /// Allow building the event loop off the main thread. Required to call this + /// from a `cargo test` worker; leave `false` for the binary (`main`). + pub any_thread: bool, +} + +impl Default for HarvestConfig { + fn default() -> Self { + Self { + start_url: GROK_URL.to_string(), + user_agent: Some(DEFAULT_USER_AGENT.to_string()), + capture_secs: DEFAULT_CAPTURE_SECS, + visible: true, + any_thread: false, + } + } +} + +/// What the injected harness posts back for each observed request. +#[derive(Deserialize)] +struct HarnessReport { + method: String, + path: String, + #[serde(rename = "statsigId")] + statsig_id: String, + #[serde(rename = "capturedAt")] + captured_at_ms: i64, +} + +/// Open the WebView, observe for `config.capture_secs`, and return every +/// signature captured (one raw entry per observation; callers dedupe). +pub fn harvest_statsigs(config: HarvestConfig) -> AnyhowResult> { + let captures: Arc>> = Arc::new(Mutex::new(Vec::new())); + + let mut event_loop = { + let mut builder = EventLoopBuilder::new(); + // Only Unix/Windows can create an event loop off the main thread; on macOS + // it must be the main thread, so `any_thread` is a no-op there (use the + // `harvest_statsig` binary, whose `main` already is the main thread). + #[cfg(all(unix, not(target_os = "macos")))] + { + use tao::platform::unix::EventLoopBuilderExtUnix; + builder.with_any_thread(config.any_thread); + } + #[cfg(target_os = "windows")] + { + use tao::platform::windows::EventLoopBuilderExtWindows; + builder.with_any_thread(config.any_thread); + } + #[cfg(target_os = "macos")] + let _ = config.any_thread; + builder.build() + }; + + let window = WindowBuilder::new() + .with_title("Grok statsig harvester") + .with_visible(config.visible) + .build(&event_loop)?; + + let sink = captures.clone(); + let ipc_handler = move |request: wry::http::Request| { + match serde_json::from_str::(request.body()) { + Ok(report) => { + let captured_at_unix = report.captured_at_ms / 1000; + match decode_statsig(&report.statsig_id, &report.method, &report.path, captured_at_unix) { + Ok(entry) => { + info!("captured statsig: {} {}", entry.method, entry.path); + sink.lock().expect("harvest sink poisoned").push(entry); + } + Err(err) => debug!("ignoring unparseable statsig report: {err}"), + } + } + Err(err) => debug!("ignoring non-report IPC message: {err}"), + } + }; + + let mut builder = WebViewBuilder::new() + .with_url(&config.start_url) + .with_initialization_script(MINT_HARNESS_SCRIPT) + .with_ipc_handler(ipc_handler); + if let Some(user_agent) = &config.user_agent { + builder = builder.with_user_agent(user_agent); + } + let _webview = builder.build(&window)?; + + info!("harvesting statsigs from {} for {}s…", config.start_url, config.capture_secs); + let deadline = Instant::now() + Duration::from_secs(config.capture_secs); + + event_loop.run_return(move |event, _target, control_flow| { + *control_flow = ControlFlow::WaitUntil(deadline); + + if let Event::WindowEvent { event: WindowEvent::CloseRequested, .. } = event { + *control_flow = ControlFlow::Exit; + } + if Instant::now() >= deadline { + *control_flow = ControlFlow::Exit; + } + }); + + let result = captures.lock().expect("harvest sink poisoned").clone(); + if result.is_empty() { + warn!("no statsigs captured — did the page load and emit any signed requests?"); + } + Ok(result) +} + +#[cfg(test)] +mod tests { + use super::*; + + // Tool 1 (live): open a real Grok WebView, harvest, and print. Manual: log in + // and start a chat in the window to emit a POST /conversations/new signature. + // Run with: + // cargo test -p grok_consumer_statsig --features webview-harvest \ + // harvest_and_print -- --ignored --nocapture + #[test] + #[ignore] + fn harvest_and_print() { + let captures = harvest_statsigs(HarvestConfig { + capture_secs: 60, + any_thread: true, + ..Default::default() + }).expect("harvest failed"); + + println!("\ncaptured {} statsig(s):", captures.len()); + for entry in &captures { + println!("\n{} {}", entry.method, entry.path); + println!(" x-statsig-id : {}", entry.statsig_id); + println!(" seed (b64) : {}", entry.seed_b64); + println!(" signed_at : {} (unix)", entry.signed_at_unix); + println!(" digest[..16] : {}", entry.digest_hex); + } + } +} diff --git a/crates/api_clients/grok_consumer_statsig/src/lib.rs b/crates/api_clients/grok_consumer_statsig/src/lib.rs new file mode 100644 index 00000000..1dacc38c --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/lib.rs @@ -0,0 +1,77 @@ +//! # grok_consumer_statsig +//! +//! Mints valid `x-statsig-id` request signatures for grok.com by running Grok's +//! own client-side signer inside a real browser (the app's Tauri WebView), then +//! caches the result so it can be reused across HTTP requests made by +//! [`grok_consumer_client`]. +//! +//! ## Why a browser is required +//! +//! grok.com gates its chat / media-generation POST endpoints (e.g. +//! `POST /rest/app-chat/conversations/new`) behind an `x-statsig-id` anti-bot +//! header. The header folds in a "genuine HEX" fingerprint that Grok's current +//! signer derives by sampling an actually-rendered, CSS-animated SVG via +//! `getComputedStyle` + `requestAnimationFrame`. That is a real-DOM +//! measurement: a headless re-implementation only works against a frozen +//! snapshot of Grok's (rotating) path constants and drifts out of date. That +//! dated headless port was removed from `grok_consumer_client`; running Grok's +//! real JS in a WebView sidesteps the whole rotation problem. +//! +//! ## What the signature needs (and does not) +//! +//! - **Login: not required by the algorithm.** The payload encodes only +//! `(seed, timestamp, sha256(method!path!…), mark)` — no user id, cookie, or +//! token. Grok attaches `x-statsig-id` to pre-login requests too. A logged-in +//! session is only useful so the WebView loads grok.com's bundles *past +//! Cloudflare* smoothly; the app's existing xAI login already persists that +//! session in WebKit, so the statsig WebView inherits it. +//! - **Browser fingerprint / UA: not part of the signature.** The genuine-hex +//! is spec-defined CSS interpolation, consistent across engines, so a +//! WKWebView is fine. The one constraint is that the WebView's User-Agent +//! must match the one that obtained `cf_clearance` (Cloudflare binds +//! `cf_clearance` to the UA), which is the same rule the login flow follows. +//! +//! ## Architecture +//! +//! This crate is a leaf: it owns the Rust-side pieces (request identity, TTL / +//! freshness, the per-endpoint cache) and defines a single [`StatsigOracle`] +//! seam. On macOS a WebView must be driven from the app's main run loop, so the +//! crate never spins up its own event loop — `artcraftx` implements +//! [`StatsigOracle`] against a hidden Tauri WebView and hands it to +//! [`StatsigMinter`]. +//! +//! ```text +//! grok_consumer_client ──needs a statsig──▶ StatsigMinter (this crate) +//! │ cache hit? return it +//! │ else ▼ +//! StatsigOracle (impl in artcraftx) +//! │ drive hidden grok.com WebView, +//! │ run MINT_HARNESS_SCRIPT, read back +//! ▼ +//! MintedStatsig { statsig_id, minted_at, ttl } +//! ``` +//! +//! [`grok_consumer_client`]: https://docs.rs/grok_consumer_client + +mod browser_context; +mod mint_harness; +mod minted_statsig; +mod statsig; +mod statsig_material; +mod statsig_minter; +mod statsig_oracle; +mod statsig_request; + +// Harvesting fresh signatures from a real browser and caching them. +pub mod statsig_cache_file; +#[cfg(feature = "webview-harvest")] +pub mod harvest_via_webview; + +pub use browser_context::{BrowserContext, DEFAULT_USER_AGENT}; +pub use mint_harness::MINT_HARNESS_SCRIPT; +pub use minted_statsig::MintedStatsig; +pub use statsig::Statsig; +pub use statsig_material::StatsigMaterial; +pub use statsig_minter::{MinterConfig, StatsigMinter}; +pub use statsig_oracle::{StatsigError, StatsigOracle}; +pub use statsig_request::StatsigRequest; diff --git a/crates/api_clients/grok_consumer_statsig/src/mint_harness.rs b/crates/api_clients/grok_consumer_statsig/src/mint_harness.rs new file mode 100644 index 00000000..46c1827a --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/mint_harness.rs @@ -0,0 +1,114 @@ +/// JavaScript injected into a loaded grok.com WebView to harvest `x-statsig-id` +/// signatures. +/// +/// # How it works +/// +/// Rather than re-implement or call Grok's (obfuscated, rotating) signer, the +/// harness *observes*: it wraps `fetch` and `XMLHttpRequest` and, for every +/// outgoing request that already carries an `x-statsig-id` header, reports the +/// tuple `{ method, path, statsigId, capturedAt }` back to the host. The header +/// is produced by Grok's own code inside its own DOM, so it is always current +/// and valid — the harness never derives anything. +/// +/// The page emits a `POST /rest/app-chat/conversations/new` signature whenever +/// it starts a chat or generation, so the app's oracle keeps a hidden grok.com +/// WebView warm and (for a cold cache) nudges it to begin — then immediately +/// abort — a trivial conversation to force that request. Each captured +/// signature is short-lived (see [`MintedStatsig`](crate::MintedStatsig)), so +/// the host caches the most recent one per endpoint. +/// +/// # Host contract +/// +/// The harness delivers each capture by calling, in preference order: +/// 1. `window.__grokStatsigReport(jsonString)` — define this from a Tauri +/// init script that forwards to a command / channel; **recommended**. +/// 2. `window.ipc.postMessage(jsonString)` — the wry IPC fallback. +/// +/// The `jsonString` is `{"method","path","statsigId","capturedAt"}` where +/// `capturedAt` is browser `Date.now()` in ms. Installing the harness twice is +/// a no-op (it guards on a global flag), so it is safe to re-inject after a +/// document swap. +pub const MINT_HARNESS_SCRIPT: &str = r#" +(function () { + if (window.__grokStatsigHarnessInstalled) return; + window.__grokStatsigHarnessInstalled = true; + + var HEADER = "x-statsig-id"; + + function report(method, url, statsigId) { + if (!statsigId) return; + var path; + try { path = new URL(url, location.href).pathname; } catch (e) { path = String(url); } + var payload = JSON.stringify({ + method: String(method || "GET").toUpperCase(), + path: path, + statsigId: statsigId, + capturedAt: Date.now() + }); + try { + if (typeof window.__grokStatsigReport === "function") { + window.__grokStatsigReport(payload); + } else if (window.ipc && typeof window.ipc.postMessage === "function") { + window.ipc.postMessage(payload); + } + } catch (e) { /* never let reporting break the page's own request */ } + } + + // Read a header value out of whatever init.headers shape fetch() was given. + function headerFrom(init) { + if (!init || !init.headers) return null; + var h = init.headers; + try { + if (typeof Headers !== "undefined" && h instanceof Headers) return h.get(HEADER); + if (Array.isArray(h)) { + for (var i = 0; i < h.length; i++) { + if (String(h[i][0]).toLowerCase() === HEADER) return h[i][1]; + } + return null; + } + for (var k in h) { + if (Object.prototype.hasOwnProperty.call(h, k) && k.toLowerCase() === HEADER) return h[k]; + } + } catch (e) { /* fall through */ } + return null; + } + + var origFetch = window.fetch; + if (typeof origFetch === "function") { + window.fetch = function (input, init) { + try { + var method = (init && init.method) || (input && input.method) || "GET"; + var url = (input && input.url) || input; + var statsig = headerFrom(init); + // A Request object may carry the header on itself. + if (!statsig && input && input.headers && typeof input.headers.get === "function") { + statsig = input.headers.get(HEADER); + } + report(method, url, statsig); + } catch (e) { /* observation must never break fetch */ } + return origFetch.apply(this, arguments); + }; + } + + var OrigXHR = window.XMLHttpRequest; + if (typeof OrigXHR === "function") { + var open = OrigXHR.prototype.open; + var setHeader = OrigXHR.prototype.setRequestHeader; + var send = OrigXHR.prototype.send; + OrigXHR.prototype.open = function (method, url) { + this.__statsigMethod = method; + this.__statsigUrl = url; + return open.apply(this, arguments); + }; + OrigXHR.prototype.setRequestHeader = function (name, value) { + if (String(name).toLowerCase() === HEADER) this.__statsigId = value; + return setHeader.apply(this, arguments); + }; + OrigXHR.prototype.send = function () { + try { report(this.__statsigMethod, this.__statsigUrl, this.__statsigId); } + catch (e) { /* ignore */ } + return send.apply(this, arguments); + }; + } +})(); +"#; diff --git a/crates/api_clients/grok_consumer_statsig/src/minted_statsig.rs b/crates/api_clients/grok_consumer_statsig/src/minted_statsig.rs new file mode 100644 index 00000000..34326e6b --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/minted_statsig.rs @@ -0,0 +1,89 @@ +use crate::statsig_request::StatsigRequest; +use serde::{Deserialize, Serialize}; + +/// A freshly-minted `x-statsig-id` and the metadata needed to decide when it +/// goes stale. +/// +/// The signature embeds a second-precision timestamp (`number = unix - epoch`) +/// that Grok only accepts inside a freshness window, so a minted signature is +/// reusable for a short time after [`minted_at_unix`](Self::minted_at_unix) and +/// then must be re-minted. Treat [`statsig_id`](Self::statsig_id) as an opaque +/// string — this crate never re-derives or mutates it. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct MintedStatsig { + /// The endpoint this signature was minted for. A signature is only valid for + /// the `(method, path)` it was signed against. + pub request: StatsigRequest, + + /// The opaque `x-statsig-id` header value (base64, ~94 chars). + pub statsig_id: String, + + /// Unix seconds when the browser produced the signature. + pub minted_at_unix: i64, + + /// How long after minting the signature is considered usable, in seconds. + /// Grok's exact acceptance window is not published; the minter supplies a + /// conservative default (see [`MinterConfig`](crate::MinterConfig)). + pub ttl_secs: u64, +} + +impl MintedStatsig { + pub fn new(request: StatsigRequest, statsig_id: impl Into, minted_at_unix: i64, ttl_secs: u64) -> Self { + Self { + request, + statsig_id: statsig_id.into(), + minted_at_unix, + ttl_secs, + } + } + + /// Whether the signature is still within its freshness window at `now_unix`. + /// A clock that has moved backwards (`now < minted_at`) counts as stale, so a + /// bad clock re-mints rather than serving something Grok will reject. + pub fn is_fresh(&self, now_unix: i64) -> bool { + let age = now_unix.saturating_sub(self.minted_at_unix); + age >= 0 && (age as u64) < self.ttl_secs + } + + /// Seconds of freshness left at `now_unix` (0 once stale). + pub fn remaining_secs(&self, now_unix: i64) -> u64 { + let age = now_unix.saturating_sub(self.minted_at_unix); + if age < 0 { + return 0; + } + self.ttl_secs.saturating_sub(age as u64) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const TTL: u64 = 90; + const MINTED_AT: i64 = 1_787_535_086; + + fn minted() -> MintedStatsig { + MintedStatsig::new(StatsigRequest::new_conversation(), "sig", MINTED_AT, TTL) + } + + #[test] + fn fresh_within_window_stale_after() { + let statsig = minted(); + assert!(statsig.is_fresh(MINTED_AT)); + assert!(statsig.is_fresh(MINTED_AT + (TTL as i64) - 1)); + assert!(!statsig.is_fresh(MINTED_AT + TTL as i64)); + } + + #[test] + fn backwards_clock_is_stale() { + assert!(!minted().is_fresh(MINTED_AT - 5)); + } + + #[test] + fn remaining_secs_counts_down_to_zero() { + let statsig = minted(); + assert_eq!(statsig.remaining_secs(MINTED_AT), TTL); + assert_eq!(statsig.remaining_secs(MINTED_AT + 30), TTL - 30); + assert_eq!(statsig.remaining_secs(MINTED_AT + TTL as i64 + 10), 0); + } +} diff --git a/crates/api_clients/grok_consumer_statsig/src/statsig.rs b/crates/api_clients/grok_consumer_statsig/src/statsig.rs new file mode 100644 index 00000000..68fc0487 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/statsig.rs @@ -0,0 +1,22 @@ +use chrono::{DateTime, Utc}; +use serde::{Deserialize, Serialize}; + +/// A concrete, ready-to-send `x-statsig-id`, minted for one endpoint at one +/// time from [`StatsigMaterial`](crate::StatsigMaterial). +/// +/// The embedded timestamp ages out, so a `Statsig` is short-lived — regenerate +/// per request rather than caching it for long. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct Statsig { + /// The header value to send as `x-statsig-id`. + pub statsig: String, + + /// When it was generated (this is the timestamp baked into the signature). + pub generated_at: DateTime, + + /// The HTTP method the signature is bound to (uppercase). + pub method: String, + + /// The request path the signature is bound to. + pub path: String, +} diff --git a/crates/api_clients/grok_consumer_statsig/src/statsig_cache_file.rs b/crates/api_clients/grok_consumer_statsig/src/statsig_cache_file.rs new file mode 100644 index 00000000..f53541cd --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/statsig_cache_file.rs @@ -0,0 +1,248 @@ +//! The `statsig.toml` cache: harvested `x-statsig-id` signatures plus every +//! piece we can decode out of them, so a future pure-Rust minter has its +//! substrate ready. +//! +//! # What is (and is not) reusable +//! +//! A signature is only reusable *whole*, and only within its freshness window +//! (its embedded second-precision timestamp). We can decode the seed, key, +//! timestamp, and digest from a captured signature, but **not** the genuine-hex +//! fingerprint — it lives inside the SHA-256 and Grok re-derives it from the +//! seed server-side. Minting a brand-new signature (fresh timestamp) therefore +//! still needs the signer's `seed -> hex` function, which only the live browser +//! has. We cache what we can observe; the browser minting lives in the +//! `grok_consumer_statsig` crate. + +use base64::prelude::BASE64_STANDARD_NO_PAD; +use base64::Engine; +use errors::{bail, AnyhowResult}; +use serde::{Deserialize, Serialize}; +use std::path::Path; + +// Payload-layout constants. The signature is minted by a real browser (see +// `grok_consumer_statsig`); we only *decode* a captured one here, so these +// describe the byte layout rather than any (dated, removed) signing algorithm. + +/// Seed length in bytes. +const SEED_LEN: usize = 48; + +/// Unix-time reference the embedded `number` counts from (2023-05-01). +const STATSIG_EPOCH: i64 = 1_682_924_400; + +/// Salt the signer folds into the message (best-known; absent from live bundles). +const STATSIG_SALT: &str = "obfiowerehiring"; + +/// Trailing marker byte of the assembled payload. +const STATSIG_MARK: u8 = 0x03; + +/// Assembled payload length: `key(1) + seed(48) + number(4) + digest(16) + mark(1)`. +const PAYLOAD_LEN: usize = 1 + SEED_LEN + 4 + 16 + 1; + +/// The whole `statsig.toml` document. +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct StatsigCacheFile { + /// The salt the signer folds into the message. Stable until Grok rotates it + /// (it is currently absent from live bundles, so treat as best-known). + pub salt: String, + + /// Unix-time reference the embedded `number` counts from. + pub epoch_unix: i64, + + /// When this file was written (unix seconds). + pub harvested_at_unix: i64, + + /// One entry per `(method, path)` observed, freshest wins. + #[serde(default)] + pub captured: Vec, +} + +/// One harvested signature and everything decodable from it. +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct CapturedStatsig { + /// Uppercase HTTP method the signature was minted for. + pub method: String, + + /// Request path the signature was minted for. + pub path: String, + + /// The full opaque `x-statsig-id` header value (reusable while fresh). + pub statsig_id: String, + + /// When we observed it in the browser (unix seconds). + pub captured_at_unix: i64, + + // --- decoded pieces (informational + substrate for a future pure minter) --- + /// The one-byte XOR mask that masks every region after byte 0. + pub key: u8, + + /// The 48-byte seed the fingerprint is derived from (base64). + pub seed_b64: String, + + /// `signed_at_unix - epoch_unix`, as embedded in the payload. + pub number: u32, + + /// Absolute time the browser signed at (`number + epoch`). + pub signed_at_unix: i64, + + /// The `sha256(method!path!)[..16]` prefix (hex). The hex + /// fingerprint itself is not recoverable from this. + pub digest_hex: String, + + /// The trailing marker byte (expected `3`). + pub mark: u8, +} + +impl StatsigCacheFile { + /// A fresh document stamped at `harvested_at_unix`. + pub fn new(harvested_at_unix: i64) -> Self { + Self { + salt: STATSIG_SALT.to_string(), + epoch_unix: STATSIG_EPOCH, + harvested_at_unix, + captured: Vec::new(), + } + } + + /// Insert or replace the entry for a `(method, path)`, keeping whichever + /// signature was captured most recently. + pub fn upsert(&mut self, entry: CapturedStatsig) { + match self.captured.iter_mut().find(|e| e.method == entry.method && e.path == entry.path) { + Some(existing) if entry.captured_at_unix >= existing.captured_at_unix => *existing = entry, + Some(_) => {} + None => self.captured.push(entry), + } + } + + pub fn to_toml(&self) -> AnyhowResult { + Ok(toml::to_string_pretty(self)?) + } + + pub fn save(&self, path: impl AsRef) -> AnyhowResult<()> { + std::fs::write(path, self.to_toml()?)?; + Ok(()) + } + + pub fn load(path: impl AsRef) -> AnyhowResult { + Ok(toml::from_str(&std::fs::read_to_string(path)?)?) + } +} + +/// Decode a captured `x-statsig-id` into its parts. +/// +/// The payload is base64 (standard alphabet, no padding); byte 0 is the key and +/// every later region is XOR-masked by it: +/// `[key][seed^key (48)][number_LE^key (4)][digest[..16]^key (16)][mark^key (1)]`. +pub fn decode_statsig( + statsig_id: &str, + method: &str, + path: &str, + captured_at_unix: i64, +) -> AnyhowResult { + let raw = BASE64_STANDARD_NO_PAD.decode(statsig_id.trim())?; + if raw.len() != PAYLOAD_LEN { + bail!("statsig payload is {} bytes, expected {PAYLOAD_LEN}", raw.len()); + } + + let key = raw[0]; + let unmask = |slice: &[u8]| -> Vec { slice.iter().map(|b| b ^ key).collect() }; + + let seed = unmask(&raw[1..1 + SEED_LEN]); + let number_bytes = unmask(&raw[1 + SEED_LEN..1 + SEED_LEN + 4]); + let number = u32::from_le_bytes([number_bytes[0], number_bytes[1], number_bytes[2], number_bytes[3]]); + let digest = unmask(&raw[1 + SEED_LEN + 4..1 + SEED_LEN + 4 + 16]); + let mark = raw[PAYLOAD_LEN - 1] ^ key; + + Ok(CapturedStatsig { + method: method.trim().to_ascii_uppercase(), + path: path.trim().to_string(), + statsig_id: statsig_id.trim().to_string(), + captured_at_unix, + key, + seed_b64: BASE64_STANDARD_NO_PAD.encode(&seed), + number, + signed_at_unix: number as i64 + STATSIG_EPOCH, + digest_hex: to_hex(&digest), + mark, + }) +} + +fn to_hex(bytes: &[u8]) -> String { + let mut out = String::with_capacity(bytes.len() * 2); + for byte in bytes { + out.push_str(&format!("{byte:02x}")); + } + out +} + +#[cfg(test)] +mod tests { + use super::*; + + // A known-good, browser-captured signature for POST /conversations/new + // (external/requests/.../18_generate_video.txt) — it generated a real video. + const CAPTURE_18: &str = + "XbHvyYh7hmNc+8sVAGnrpcuHN/MK+mgN63cmnBljOJaoCKu6zTPVw6C7HVv1wculKCNmYVum+L1h0IjFmtyZD/C53M+ZXg"; + const NEW_CONVERSATION: &str = "/rest/app-chat/conversations/new"; + + #[test] + fn decodes_known_capture_layout() { + let decoded = decode_statsig(CAPTURE_18, "POST", NEW_CONVERSATION, 1_787_535_100).unwrap(); + assert_eq!(decoded.key, 93); + assert_eq!(decoded.mark, STATSIG_MARK, "trailing marker should decode to 3"); + assert_eq!(decoded.number, 104_610_686); + assert_eq!(decoded.signed_at_unix, 104_610_686 + STATSIG_EPOCH); + assert_eq!(decoded.digest_hex.len(), 32, "16 digest bytes -> 32 hex chars"); + // Seed is 48 bytes -> 64 base64 chars (no padding). + assert_eq!(BASE64_STANDARD_NO_PAD.decode(&decoded.seed_b64).unwrap().len(), SEED_LEN); + } + + #[test] + fn rejects_wrong_length() { + assert!(decode_statsig("YWJj", "POST", "/x", 0).is_err()); + } + + #[test] + fn upsert_keeps_the_freshest_per_endpoint() { + let mut file = StatsigCacheFile::new(1_000); + let older = decode_statsig(CAPTURE_18, "POST", NEW_CONVERSATION, 1_000).unwrap(); + let mut newer = older.clone(); + newer.captured_at_unix = 2_000; + file.upsert(older); + file.upsert(newer); + assert_eq!(file.captured.len(), 1); + assert_eq!(file.captured[0].captured_at_unix, 2_000); + } + + #[test] + fn toml_round_trips() { + let mut file = StatsigCacheFile::new(1_787_535_100); + file.upsert(decode_statsig(CAPTURE_18, "POST", NEW_CONVERSATION, 1_787_535_100).unwrap()); + let text = file.to_toml().unwrap(); + let parsed: StatsigCacheFile = toml::from_str(&text).unwrap(); + assert_eq!(parsed.captured.len(), 1); + assert_eq!(parsed.captured[0].statsig_id, CAPTURE_18); + } + + // Tool 1 (offline): run the decode + serialize pipeline on a real capture and + // print the signature and every cacheable piece. This is the same code the + // `harvest_statsig` binary writes to statsig.toml; the live capture happens in + // that binary (a native event loop cannot cleanly run inside `cargo test`). + #[test] + fn print_statsig_and_cacheable_pieces() { + let mut file = StatsigCacheFile::new(1_787_535_100); + file.upsert(decode_statsig(CAPTURE_18, "POST", NEW_CONVERSATION, 1_787_535_100).unwrap()); + + let entry = &file.captured[0]; + println!("\n===== harvested statsig ====="); + println!("x-statsig-id : {}", entry.statsig_id); + println!("method/path : {} {}", entry.method, entry.path); + println!("--- decoded (cacheable) pieces ---"); + println!("key : {}", entry.key); + println!("seed (b64) : {}", entry.seed_b64); + println!("number : {}", entry.number); + println!("signed_at : {} (unix)", entry.signed_at_unix); + println!("digest[..16] : {}", entry.digest_hex); + println!("mark : {}", entry.mark); + println!("--- statsig.toml ---\n{}", file.to_toml().unwrap()); + } +} diff --git a/crates/api_clients/grok_consumer_statsig/src/statsig_material.rs b/crates/api_clients/grok_consumer_statsig/src/statsig_material.rs new file mode 100644 index 00000000..ee9b7a2d --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/statsig_material.rs @@ -0,0 +1,149 @@ +//! [`StatsigMaterial`] — the reusable, per-session material an +//! `x-statsig-id` is minted from, plus the pure signature assembly. + +use crate::statsig::Statsig; +use base64::prelude::BASE64_STANDARD_NO_PAD; +use base64::Engine; +use chrono::{DateTime, Utc}; +use serde::{Deserialize, Serialize}; +use sha2::{Digest, Sha256}; + +/// Unix-time reference the embedded `number` counts from (2023-05-01). +const STATSIG_EPOCH: i64 = 1_682_924_400; + +/// Salt folded into the signed message (best-known; absent from current bundles). +const STATSIG_SALT: &str = "obfiowerehiring"; + +/// Trailing marker byte of the assembled payload. +const STATSIG_MARK: u8 = 0x03; + +/// The reusable material an `x-statsig-id` is minted from, independent of the +/// endpoint. A signature binds `method`, `path`, and a timestamp — all +/// per-request — around a "genuine hex" fingerprint **derived from the seed**. +/// So the one thing worth storing across requests is the 48-byte **seed** +/// (decoded from a real captured signature): with it we can mint a fresh +/// signature for any endpoint via [`generate_statsig`](Self::generate_statsig), +/// no browser required — see the caveat there. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct StatsigMaterial { + /// The 48-byte seed, base64 (standard alphabet, no padding). + pub seed_b64: String, +} + +impl StatsigMaterial { + pub fn from_seed_b64(seed_b64: impl Into) -> Self { + Self { seed_b64: seed_b64.into() } + } + + /// Mint a signature for `method` + `path` stamped at `generated_at`. + /// + /// # Caveat: needs the seed → hex fingerprint + /// + /// The signature folds in a "genuine hex" that Grok derives from the seed by + /// sampling a CSS-animated SVG in-browser, rotating the constants over time. + /// [`compute_genuine_hex`] — the headless port of that — is currently + /// unavailable (stale + out of scope to extract), so this returns `None`. + /// The *assembly* around it ([`assemble`]) is complete and tested, so the + /// moment a real fingerprint lands, on-the-fly generation works. + pub fn generate_statsig(&self, method: &str, path: &str, generated_at: DateTime) -> Option { + let seed = BASE64_STANDARD_NO_PAD.decode(self.seed_b64.trim()).ok()?; + let genuine_hex = compute_genuine_hex(&seed)?; + Some(assemble(&seed, method, path, generated_at, &genuine_hex)) + } +} + +/// Assemble the 70-byte payload from every input (pure, deterministic). +/// +/// Layout: `[key][seed^key (48)][number_LE^key (4)][sha256(msg)[..16]^key (16)][mark^key]`, +/// where `msg = METHOD!path!` and +/// `number = generated_at - epoch`. +fn assemble(seed: &[u8], method: &str, path: &str, generated_at: DateTime, genuine_hex: &str) -> Statsig { + let method = method.trim().to_ascii_uppercase(); + let path = path.trim(); + let number = generated_at.timestamp().saturating_sub(STATSIG_EPOCH).max(0) as u32; + + let message = format!("{method}!{path}!{number}{STATSIG_SALT}{genuine_hex}"); + let digest = Sha256::digest(message.as_bytes()); + + // Any byte works as the XOR mask; derive one deterministically from the seed + // and timestamp so output is reproducible. + let key = seed.first().copied().unwrap_or(0) ^ (number as u8); + + let number_bytes = number.to_le_bytes(); + let mut out = Vec::with_capacity(70); + out.push(key); + out.extend(seed.iter().map(|byte| byte ^ key)); + out.extend(number_bytes.iter().map(|byte| byte ^ key)); + out.extend(digest[..16].iter().map(|byte| byte ^ key)); + out.push(STATSIG_MARK ^ key); + + Statsig { + statsig: BASE64_STANDARD_NO_PAD.encode(out), + generated_at, + method, + path: path.to_string(), + } +} + +/// Grok's seed → "genuine hex" fingerprint. Currently unavailable: Grok derives +/// it in-browser by sampling a rotating CSS-animated SVG, and the headless port +/// is stale (extracting the live one is out of scope / blocked). Until this +/// returns a real value, [`StatsigMaterial::generate_statsig`] yields `None`. +/// This is the single missing piece — the assembly around it is done. +fn compute_genuine_hex(_seed: &[u8]) -> Option { + None +} + +#[cfg(test)] +mod tests { + use super::*; + + const SEED: [u8; 48] = [7u8; 48]; + const NEW_CONVERSATION: &str = "/rest/app-chat/conversations/new"; + + #[test] + fn assemble_produces_a_self_consistent_signature() { + let generated_at = DateTime::from_timestamp(1_787_535_100, 0).unwrap(); + let hex = "3bab9506b851eb85"; // any fingerprint; the assembly is what's under test + + let signature = assemble(&SEED, "post", NEW_CONVERSATION, generated_at, hex); + assert_eq!(signature.method, "POST"); + assert_eq!(signature.path, NEW_CONVERSATION); + + // Decode the payload and check every region reconstructs its input. + let raw = BASE64_STANDARD_NO_PAD.decode(&signature.statsig).unwrap(); + assert_eq!(raw.len(), 70); + let key = raw[0]; + let unmask = |slice: &[u8]| -> Vec { slice.iter().map(|b| b ^ key).collect() }; + + assert_eq!(unmask(&raw[1..49]), SEED); + + let number_bytes = unmask(&raw[49..53]); + let number = u32::from_le_bytes([number_bytes[0], number_bytes[1], number_bytes[2], number_bytes[3]]); + assert_eq!(number as i64, 1_787_535_100 - STATSIG_EPOCH); + + let digest = unmask(&raw[53..69]); + let expected = &Sha256::digest( + format!("POST!{NEW_CONVERSATION}!{number}{STATSIG_SALT}{hex}").as_bytes(), + )[..16]; + assert_eq!(digest, expected); + + assert_eq!(raw[69] ^ key, STATSIG_MARK); + } + + #[test] + fn same_seed_different_endpoints_differ() { + let at = DateTime::from_timestamp(1_787_535_100, 0).unwrap(); + let a = assemble(&SEED, "POST", "/a", at, "beef"); + let b = assemble(&SEED, "POST", "/b", at, "beef"); + assert_ne!(a.statsig, b.statsig, "different paths must sign differently"); + } + + #[test] + fn generate_statsig_is_none_until_fingerprint_available() { + // The seed is present, but the seed -> hex fingerprint is not, so no + // signature can be minted yet. + let material = StatsigMaterial::from_seed_b64(BASE64_STANDARD_NO_PAD.encode(SEED)); + assert!(material.generate_statsig("POST", NEW_CONVERSATION, Utc::now()).is_none()); + } +} diff --git a/crates/api_clients/grok_consumer_statsig/src/statsig_minter.rs b/crates/api_clients/grok_consumer_statsig/src/statsig_minter.rs new file mode 100644 index 00000000..62e6d3d0 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/statsig_minter.rs @@ -0,0 +1,225 @@ +use crate::minted_statsig::MintedStatsig; +use crate::statsig_oracle::{StatsigError, StatsigOracle}; +use crate::statsig_request::StatsigRequest; +use log::{debug, info}; +use std::collections::HashMap; +use tokio::sync::Mutex; + +/// Default freshness window applied to a minted signature. Conservative: Grok's +/// real acceptance window is not published, so we re-mint well before a +/// second-precision timestamp could plausibly age out. +const DEFAULT_TTL_SECS: u64 = 90; + +/// Default slack: serve a cached signature only while it has more than this many +/// seconds of freshness left, so a request never goes out on a signature about +/// to expire mid-flight. +const DEFAULT_REFRESH_MARGIN_SECS: u64 = 20; + +/// Caches one [`MintedStatsig`] per endpoint and re-mints through a +/// [`StatsigOracle`] when the cached one is missing or about to expire. +/// +/// Cheap, hot path: a fresh cache hit is a map lookup under a short-held lock. +/// The slow path (driving the browser) runs *without* the lock held, so a mint +/// for one endpoint never blocks a cache read for another; the trade-off is +/// that a burst of misses for the *same* endpoint may mint more than once, +/// which is harmless. +pub struct StatsigMinter { + oracle: O, + config: MinterConfig, + cache: Mutex>, + clock: Box i64 + Send + Sync>, +} + +/// Freshness policy for a [`StatsigMinter`]. This crate owns the TTL: whatever +/// the oracle returns, the minter stamps [`ttl_secs`](Self::ttl_secs) onto it +/// so the policy lives in one place. +#[derive(Clone, Copy, Debug)] +pub struct MinterConfig { + /// Seconds a freshly-minted signature is treated as usable. + pub ttl_secs: u64, + + /// Re-mint once a cached signature has fewer than this many seconds left. + pub refresh_margin_secs: u64, +} + +impl Default for MinterConfig { + fn default() -> Self { + Self { + ttl_secs: DEFAULT_TTL_SECS, + refresh_margin_secs: DEFAULT_REFRESH_MARGIN_SECS, + } + } +} + +impl StatsigMinter { + /// Build a minter over `oracle` with the default freshness policy. + pub fn new(oracle: O) -> Self { + Self::with_config(oracle, MinterConfig::default()) + } + + pub fn with_config(oracle: O, config: MinterConfig) -> Self { + Self { + oracle, + config, + cache: Mutex::new(HashMap::new()), + clock: Box::new(default_now_unix), + } + } + + /// Return a usable `x-statsig-id` string for `request`, serving a fresh + /// cached signature when possible and minting a new one otherwise. + pub async fn statsig_for(&self, request: &StatsigRequest) -> Result { + let now = (self.clock)(); + + if let Some(fresh) = self.cached_fresh(request, now).await { + debug!("statsig cache hit for {} {}", request.method, request.path); + return Ok(fresh); + } + + info!("minting statsig for {} {}", request.method, request.path); + let mut minted = self.oracle.mint(request).await?; + // The minter owns TTL policy; normalize whatever the oracle reported. + minted.ttl_secs = self.config.ttl_secs; + + let statsig_id = minted.statsig_id.clone(); + self.cache.lock().await.insert(request.clone(), minted); + Ok(statsig_id) + } + + /// Drop any cached signature for `request` (e.g. after the server rejects it + /// with a `StatsigSignatureRejected`, so the next call re-mints). + pub async fn invalidate(&self, request: &StatsigRequest) { + self.cache.lock().await.remove(request); + } + + /// A cached signature for `request` if it still has more than the refresh + /// margin of freshness left. + async fn cached_fresh(&self, request: &StatsigRequest, now: i64) -> Option { + let cache = self.cache.lock().await; + let minted = cache.get(request)?; + if minted.remaining_secs(now) > self.config.refresh_margin_secs { + Some(minted.statsig_id.clone()) + } else { + None + } + } +} + +fn default_now_unix() -> i64 { + chrono::Utc::now().timestamp() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::minted_statsig::MintedStatsig; + use std::sync::Arc; + use std::sync::atomic::{AtomicI64, AtomicUsize, Ordering}; + + const BASE: i64 = 1_787_535_086; + + #[tokio::test] + async fn mints_once_then_serves_from_cache() { + let oracle = CountingOracle::new(); + let minter = minter_at(oracle.clone(), BASE); + + let request = StatsigRequest::new_conversation(); + let first = minter.statsig_for(&request).await.unwrap(); + let second = minter.statsig_for(&request).await.unwrap(); + + assert_eq!(first, second); + assert_eq!(oracle.calls(), 1, "second call should hit the cache"); + } + + #[tokio::test] + async fn re_mints_once_the_margin_is_crossed() { + let oracle = CountingOracle::new(); + let clock = Arc::new(AtomicI64::new(BASE)); + let minter = minter_with_clock(oracle.clone(), clock.clone()); + + let request = StatsigRequest::new_conversation(); + minter.statsig_for(&request).await.unwrap(); + + // Still fresh (well inside ttl - margin): cached. + clock.store(BASE + 30, Ordering::SeqCst); + minter.statsig_for(&request).await.unwrap(); + assert_eq!(oracle.calls(), 1); + + // Past ttl - margin (90 - 20 = 70): re-mint. + clock.store(BASE + 75, Ordering::SeqCst); + minter.statsig_for(&request).await.unwrap(); + assert_eq!(oracle.calls(), 2); + } + + #[tokio::test] + async fn distinct_endpoints_are_cached_separately() { + let oracle = CountingOracle::new(); + let minter = minter_at(oracle.clone(), BASE); + + minter.statsig_for(&StatsigRequest::new("POST", "/a")).await.unwrap(); + minter.statsig_for(&StatsigRequest::new("POST", "/b")).await.unwrap(); + assert_eq!(oracle.calls(), 2); + } + + #[tokio::test] + async fn invalidate_forces_a_re_mint() { + let oracle = CountingOracle::new(); + let minter = minter_at(oracle.clone(), BASE); + + let request = StatsigRequest::new_conversation(); + minter.statsig_for(&request).await.unwrap(); + minter.invalidate(&request).await; + minter.statsig_for(&request).await.unwrap(); + assert_eq!(oracle.calls(), 2); + } + + #[tokio::test] + async fn propagates_oracle_errors() { + let minter = minter_at(FailingOracle, BASE); + let error = minter.statsig_for(&StatsigRequest::new_conversation()).await.unwrap_err(); + assert!(matches!(error, StatsigError::WebviewUnavailable)); + } + + fn minter_at(oracle: O, now: i64) -> StatsigMinter { + let mut minter = StatsigMinter::new(oracle); + minter.clock = Box::new(move || now); + minter + } + + fn minter_with_clock(oracle: O, clock: Arc) -> StatsigMinter { + let mut minter = StatsigMinter::new(oracle); + minter.clock = Box::new(move || clock.load(Ordering::SeqCst)); + minter + } + + #[derive(Clone)] + struct CountingOracle { + calls: Arc, + } + + impl CountingOracle { + fn new() -> Self { + Self { calls: Arc::new(AtomicUsize::new(0)) } + } + + fn calls(&self) -> usize { + self.calls.load(Ordering::SeqCst) + } + } + + impl StatsigOracle for CountingOracle { + async fn mint(&self, request: &StatsigRequest) -> Result { + let n = self.calls.fetch_add(1, Ordering::SeqCst); + // A distinct value per mint so cache hits vs re-mints are observable. + Ok(MintedStatsig::new(request.clone(), format!("sig-{n}"), BASE, 1)) + } + } + + struct FailingOracle; + + impl StatsigOracle for FailingOracle { + async fn mint(&self, _request: &StatsigRequest) -> Result { + Err(StatsigError::WebviewUnavailable) + } + } +} diff --git a/crates/api_clients/grok_consumer_statsig/src/statsig_oracle.rs b/crates/api_clients/grok_consumer_statsig/src/statsig_oracle.rs new file mode 100644 index 00000000..d0d8ad15 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/statsig_oracle.rs @@ -0,0 +1,48 @@ +use crate::minted_statsig::MintedStatsig; +use crate::statsig_request::StatsigRequest; + +/// Drives a real browser to produce one `x-statsig-id` for a given endpoint. +/// +/// This is the seam between this (platform-agnostic) crate and the app. +/// `artcraftx` implements it against a hidden Tauri WebView: navigate to +/// grok.com, inject [`MINT_HARNESS_SCRIPT`](crate::MINT_HARNESS_SCRIPT), and +/// read the value back over the WebView's IPC channel. Because macOS requires +/// WebView work on the main run loop, the implementation — not this crate — +/// owns the event loop; the minter only calls [`mint`](Self::mint). +/// +/// Implementations should be cheap to call repeatedly (reuse one hidden WebView +/// rather than spawning one per call) and must be cancellation-safe: a dropped +/// `mint` future should abandon the pending signature, not wedge the WebView. +pub trait StatsigOracle { + /// Produce a fresh signature for `request`, or explain why it could not. + fn mint( + &self, + request: &StatsigRequest, + ) -> impl std::future::Future> + Send; +} + +/// Why minting a signature failed. +#[derive(Debug, thiserror::Error)] +pub enum StatsigError { + /// No WebView was available to run the signer (e.g. the app is headless or + /// the hidden window was torn down). + #[error("no webview available to mint a statsig")] + WebviewUnavailable, + + /// The grok.com page never reached a state where the signer could run — + /// typically a Cloudflare challenge or a failed/blocked navigation. + #[error("grok.com did not become ready to sign (page load / cloudflare): {0}")] + PageNotReady(String), + + /// The harness ran but did not return a usable signature before the deadline. + #[error("timed out waiting for the browser to return a statsig")] + Timeout, + + /// The harness returned, but the value was empty or malformed. + #[error("browser returned an invalid statsig: {0}")] + InvalidResult(String), + + /// Any other implementation-specific failure (IPC error, eval error, …). + #[error("statsig oracle failed: {0}")] + Other(String), +} diff --git a/crates/api_clients/grok_consumer_statsig/src/statsig_request.rs b/crates/api_clients/grok_consumer_statsig/src/statsig_request.rs new file mode 100644 index 00000000..b40fd825 --- /dev/null +++ b/crates/api_clients/grok_consumer_statsig/src/statsig_request.rs @@ -0,0 +1,49 @@ +use serde::{Deserialize, Serialize}; + +/// The `x-statsig-id` binds the HTTP method and path it was minted for +/// (`msg = method!path!…`), so a signature for one endpoint is not valid for +/// another. A `StatsigRequest` is therefore the cache key: one minted signature +/// per `(method, path)`. +#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub struct StatsigRequest { + /// Uppercase HTTP method, e.g. `"POST"`. + pub method: String, + + /// Request path only (no origin / query), e.g. + /// `"/rest/app-chat/conversations/new"`. + pub path: String, +} + +impl StatsigRequest { + /// Build a request, normalizing the method to uppercase and trimming both + /// fields so `(" post ", …)` and `("POST", …)` share a cache entry. + pub fn new(method: impl AsRef, path: impl Into) -> Self { + Self { + method: method.as_ref().trim().to_ascii_uppercase(), + path: path.into().trim().to_string(), + } + } + + /// The endpoint that starts every chat / media-generation stream, including + /// video generation. This is the signature the video binding needs. + pub fn new_conversation() -> Self { + Self::new("POST", "/rest/app-chat/conversations/new") + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn new_normalizes_method_and_trims() { + let request = StatsigRequest::new(" post ", " /rest/app-chat/conversations/new "); + assert_eq!(request.method, "POST"); + assert_eq!(request.path, "/rest/app-chat/conversations/new"); + } + + #[test] + fn equal_requests_hash_and_compare_equal() { + assert_eq!(StatsigRequest::new("post", "/p"), StatsigRequest::new("POST", "/p")); + } +} diff --git a/crates/api_clients/higgsfield_client/Cargo.toml b/crates/api_clients/higgsfield_client/Cargo.toml new file mode 100644 index 00000000..bff0352e --- /dev/null +++ b/crates/api_clients/higgsfield_client/Cargo.toml @@ -0,0 +1,41 @@ +[package] +name = "higgsfield_client" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "higgsfield_client" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +browser_emulation.workspace = true +cloudflare_errors.workspace = true +cloudflare_mitigation.workspace = true +datadome_errors.workspace = true +datadome_mitigation.workspace = true +errors.workspace = true +jwt_light.workspace = true + +# External +chrono.workspace = true +log.workspace = true +rand.workspace = true +serde.workspace = true +serde_json.workspace = true +tokio = { version = "1", features = ["sync", "time"] } +wreq.workspace = true + +[dev-dependencies] +anyhow.workspace = true +base64.workspace = true +toml.workspace = true +env_logger.workspace = true +tokio = { version = "1", features = ["full"] } diff --git a/crates/api_clients/higgsfield_client/src/client/clerk_host.rs b/crates/api_clients/higgsfield_client/src/client/clerk_host.rs new file mode 100644 index 00000000..99a85682 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/client/clerk_host.rs @@ -0,0 +1,60 @@ +/// Which Clerk "frontend API" host mints session tokens for Higgsfield. +/// +/// Higgsfield's auth is Clerk; its production frontend API lives at +/// `clerk.higgsfield.ai` (the `iss` claim on every session JWT). +#[derive(Clone, Debug, PartialEq, Eq, Default)] +pub enum ClerkHost { + #[default] + Higgsfield, + + /// A custom base URL, e.g. `http://localhost:8081`. A trailing slash is + /// tolerated and stripped. + Custom(String), +} + +const PRODUCTION_CLERK_BASE_URL: &str = "https://clerk.higgsfield.ai"; + +/// Clerk's frontend API is versioned by these two query parameters. The +/// values mirror what the web app's clerk-js sends; Clerk tolerates older +/// ones. +pub(crate) const CLERK_API_VERSION: &str = "2025-04-10"; +pub(crate) const CLERK_JS_VERSION: &str = "5.98.0"; + +impl ClerkHost { + /// Base URL without a trailing slash; endpoint paths (`/v1/...`) are + /// appended directly. + pub fn base_url(&self) -> &str { + match self { + Self::Higgsfield => PRODUCTION_CLERK_BASE_URL, + Self::Custom(base_url) => base_url.trim_end_matches('/'), + } + } + + /// Build a full URL for an API path (which must start with `/`), with the + /// version query parameters attached. + pub(crate) fn url(&self, path: &str) -> String { + format!( + "{}{}?__clerk_api_version={}&_clerk_js_version={}", + self.base_url(), path, CLERK_API_VERSION, CLERK_JS_VERSION, + ) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn production_url_carries_versions() { + let url = ClerkHost::Higgsfield.url("/v1/client"); + assert!(url.starts_with("https://clerk.higgsfield.ai/v1/client?")); + assert!(url.contains("__clerk_api_version=2025-04-10")); + assert!(url.contains("_clerk_js_version=5.98.0")); + } + + #[test] + fn custom_base_url_strips_trailing_slash() { + let host = ClerkHost::Custom("http://localhost:8081/".to_string()); + assert!(host.url("/v1/client").starts_with("http://localhost:8081/v1/client?")); + } +} diff --git a/crates/api_clients/higgsfield_client/src/client/higgsfield_browser_profile.rs b/crates/api_clients/higgsfield_client/src/client/higgsfield_browser_profile.rs new file mode 100644 index 00000000..f9e63c53 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/client/higgsfield_browser_profile.rs @@ -0,0 +1,43 @@ +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_mitigation::clearance::clearance_binding::profile_for_captured_user_agent; + +/// The User-Agent to use for BOTH the Higgsfield login webview and every +/// Higgsfield HTTP call when no captured UA is recorded. +/// +/// It must be identical in both places: Cloudflare's `cf_clearance` and +/// DataDome's `datadome` cookies (captured by the webview) are bound to the +/// exact User-Agent, and both check it against the TLS/HTTP fingerprint. A +/// mainstream desktop Safari UA on a Safari fingerprint matches the macOS +/// WKWebView that does the capturing. +pub const HIGGSFIELD_USER_AGENT: &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15"; + +/// The browser profile for Higgsfield traffic: the captured User-Agent when +/// the credential recorded one, else [`HIGGSFIELD_USER_AGENT`] — always on a +/// fingerprint matching the UA's browser family. +pub fn higgsfield_browser_profile(maybe_captured_user_agent: Option<&str>) -> BrowserProfile { + profile_for_captured_user_agent( + maybe_captured_user_agent, + BrowserProfile::safari_macos_with_user_agent(HIGGSFIELD_USER_AGENT), + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn default_is_safari_with_pinned_ua() { + let profile = higgsfield_browser_profile(None); + assert_eq!(profile.maybe_user_agent_override(), Some(HIGGSFIELD_USER_AGENT)); + assert!(profile.label().contains("Safari18"), "{}", profile.label()); + } + + #[test] + fn captured_ua_is_honored_on_its_own_family() { + let chrome = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"; + let profile = higgsfield_browser_profile(Some(chrome)); + assert_eq!(profile.maybe_user_agent_override(), Some(chrome)); + assert!(profile.label().contains("Chrome145"), "{}", profile.label()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/client/higgsfield_host.rs b/crates/api_clients/higgsfield_client/src/client/higgsfield_host.rs new file mode 100644 index 00000000..3fbffdc3 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/client/higgsfield_host.rs @@ -0,0 +1,60 @@ +/// Which Higgsfield API host to talk to. +/// +/// [`HiggsfieldHost::Higgsfield`] is the real service. [`HiggsfieldHost::Custom`] +/// points every request at another base URL — a local mock for tests, a +/// recording proxy, a staging environment, etc. +#[derive(Clone, Debug, PartialEq, Eq, Default)] +pub enum HiggsfieldHost { + /// The production API gateway, `https://fnf-api-gw.higgsfield.ai`. + #[default] + Higgsfield, + + /// A custom base URL, e.g. `http://localhost:8080`. A trailing slash is + /// tolerated and stripped. + Custom(String), +} + +const PRODUCTION_API_BASE_URL: &str = "https://fnf-api-gw.higgsfield.ai"; + +/// The web app's origin; sent as `origin` / `referer` so requests look like +/// they came from the site, which is what the gateway expects. +pub(crate) const WEB_ORIGIN: &str = "https://higgsfield.ai"; + +impl HiggsfieldHost { + /// Base URL without a trailing slash; endpoint paths (`/fnf/...`) are + /// appended directly. + pub fn api_base_url(&self) -> &str { + match self { + Self::Higgsfield => PRODUCTION_API_BASE_URL, + Self::Custom(base_url) => base_url.trim_end_matches('/'), + } + } + + /// Build a full URL for an API path (which must start with `/`). + pub(crate) fn url(&self, path: &str) -> String { + format!("{}{}", self.api_base_url(), path) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn production_base_url() { + assert_eq!(HiggsfieldHost::Higgsfield.api_base_url(), "https://fnf-api-gw.higgsfield.ai"); + assert_eq!(HiggsfieldHost::Higgsfield.url("/fnf/user"), "https://fnf-api-gw.higgsfield.ai/fnf/user"); + } + + #[test] + fn custom_base_url_strips_trailing_slash() { + let host = HiggsfieldHost::Custom("http://localhost:8080/".to_string()); + assert_eq!(host.api_base_url(), "http://localhost:8080"); + assert_eq!(host.url("/fnf/user"), "http://localhost:8080/fnf/user"); + } + + #[test] + fn default_is_production() { + assert_eq!(HiggsfieldHost::default(), HiggsfieldHost::Higgsfield); + } +} diff --git a/crates/api_clients/higgsfield_client/src/client/mod.rs b/crates/api_clients/higgsfield_client/src/client/mod.rs new file mode 100644 index 00000000..9f0022cf --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/client/mod.rs @@ -0,0 +1,4 @@ +pub mod clerk_host; +pub mod higgsfield_browser_profile; +pub mod higgsfield_host; +pub(crate) mod send_request; diff --git a/crates/api_clients/higgsfield_client/src/client/send_request.rs b/crates/api_clients/higgsfield_client/src/client/send_request.rs new file mode 100644 index 00000000..6232d8a5 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/client/send_request.rs @@ -0,0 +1,299 @@ +//! The one HTTP path every endpoint uses: build an emulated-browser client +//! matching the capturing browser, attach the session headers, send, classify +//! the status (bot protection first), and deserialize. + +use crate::client::clerk_host::ClerkHost; +use crate::client::higgsfield_browser_profile::higgsfield_browser_profile; +use crate::client::higgsfield_host::{HiggsfieldHost, WEB_ORIGIN}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::credentials::higgsfield_cookies::HiggsfieldCookies; +use crate::error::classify_higgsfield_http_error::{classify_higgsfield_http_response, HttpResponseSignals}; +use crate::error::higgsfield_api_error::HiggsfieldApiError; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use log::{debug, info}; +use serde::Serialize; +use serde::de::DeserializeOwned; +use std::time::Duration; +use wreq::header::HeaderMap; + +const REQUEST_TIMEOUT: Duration = Duration::from_secs(60); + +/// Uploads carry whole files; give them longer than an API call. +const UPLOAD_TIMEOUT: Duration = Duration::from_secs(5 * 60); + +#[derive(Clone, Copy)] +pub(crate) enum HttpMethod { + Get, + Post, +} + +impl HttpMethod { + fn as_str(self) -> &'static str { + match self { + Self::Get => "GET", + Self::Post => "POST", + } + } +} + +/// How a request proves who it is. +pub(crate) enum RequestCredential<'a> { + /// The API gateway: `authorization: Bearer ` (+ optional cookies and + /// DataDome id). + Bearer(&'a HiggsfieldAuth), + + /// Clerk's frontend API: just the browser cookies (`__client`). + Cookies { + cookies: &'a HiggsfieldCookies, + /// The capturing browser's UA, for the same reason as on the gateway. + maybe_user_agent: Option<&'a str>, + }, +} + +impl RequestCredential<'_> { + fn maybe_user_agent(&self) -> Option<&str> { + match self { + Self::Bearer(auth) => auth.maybe_user_agent.as_deref(), + Self::Cookies { maybe_user_agent, .. } => *maybe_user_agent, + } + } +} + +pub(crate) enum RequestBody<'a, Body: Serialize> { + None, + Json(&'a Body), + Form(&'a Body), +} + +/// Send a JSON request to the Higgsfield API gateway and parse a JSON +/// response. `maybe_body` is serialized for POSTs; pass `None::<&()>` for +/// GETs. +pub(crate) async fn send_json_request( + method: HttpMethod, + path: &str, + auth: &HiggsfieldAuth, + host: &HiggsfieldHost, + maybe_body: Option<&Body>, +) -> Result +where + Response: DeserializeOwned, + Body: Serialize, +{ + auth.validate()?; + let body = match maybe_body { + Some(body) => RequestBody::Json(body), + None => RequestBody::None, + }; + send_request(method, host.url(path), RequestCredential::Bearer(auth), body).await +} + +/// Send a request to Clerk's frontend API (cookie-authenticated) and parse a +/// JSON response. +pub(crate) async fn send_clerk_request( + method: HttpMethod, + path: &str, + cookies: &HiggsfieldCookies, + maybe_user_agent: Option<&str>, + host: &ClerkHost, + body: RequestBody<'_, Body>, +) -> Result +where + Response: DeserializeOwned, + Body: Serialize, +{ + cookies.validate()?; + send_request(method, host.url(path), RequestCredential::Cookies { cookies, maybe_user_agent }, body).await +} + +/// Upload raw bytes to a presigned storage URL (the `upload_url` from the +/// media presign endpoints). No Higgsfield auth is involved — the signature +/// in the URL is the credential — but the browser identity is kept, since +/// the bucket's CORS policy and the presign were both made for the web app. +/// +/// Storage answers an empty `200`; any other status is classified like a +/// gateway response so callers get the same error vocabulary. +pub(crate) async fn send_presigned_upload( + upload_url: &str, + content_type: &str, + bytes: Vec, + maybe_user_agent: Option<&str>, +) -> Result<(), HiggsfieldError> { + let browser_profile = higgsfield_browser_profile(maybe_user_agent); + + let client = browser_profile + .configure_client_builder(wreq::Client::builder()) + .timeout(UPLOAD_TIMEOUT) + .build() + .map_err(HiggsfieldClientError::WreqClientBuild)?; + + let byte_count = bytes.len(); + let request = client.put(upload_url) + .header("accept", "*/*") + .header("accept-language", "en") + .header("content-type", content_type) + .header("origin", WEB_ORIGIN) + .header("referer", format!("{WEB_ORIGIN}/")) + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "cross-site") + .body(bytes) + .build() + .map_err(HiggsfieldClientError::WreqRequestBuild)?; + + // NB: the URL carries the signature; log only its host and path. + let url_for_log = upload_url.split('?').next().unwrap_or(upload_url); + info!("Higgsfield media upload: PUT {} ({} bytes, {})", url_for_log, byte_count, content_type); + + let response = client.execute(request) + .await + .map_err(HiggsfieldApiError::from_transport_error)?; + + let status = response.status(); + let protection_headers = ProtectionHeaders::from_headers(response.headers()); + let response_body = response.text() + .await + .map_err(HiggsfieldApiError::from_transport_error)?; + + info!("Higgsfield media upload response: status={} ({} bytes)", status, response_body.len()); + debug!("Higgsfield media upload response body: {}", response_body); + + classify_higgsfield_http_response(&HttpResponseSignals { + status_code: status.as_u16(), + body: &response_body, + maybe_server_header: protection_headers.server.as_deref(), + maybe_cf_ray: protection_headers.cf_ray.as_deref(), + maybe_cf_mitigated: protection_headers.cf_mitigated.as_deref(), + maybe_x_datadome: protection_headers.x_datadome.as_deref(), + maybe_x_dd_b: protection_headers.x_dd_b.as_deref(), + context: url_for_log, + }) +} + +async fn send_request( + method: HttpMethod, + url: String, + credential: RequestCredential<'_>, + body: RequestBody<'_, Body>, +) -> Result +where + Response: DeserializeOwned, + Body: Serialize, +{ + // Present the browser that earned the cookies (or our pinned default). + let browser_profile = higgsfield_browser_profile(credential.maybe_user_agent()); + + let client = browser_profile + .configure_client_builder(wreq::Client::builder()) + .timeout(REQUEST_TIMEOUT) + .build() + .map_err(HiggsfieldClientError::WreqClientBuild)?; + + let request_builder = match method { + HttpMethod::Get => client.get(&url), + HttpMethod::Post => client.post(&url), + }; + + // NB: Browser-identity headers (user-agent, sec-ch-ua*) come from the + // emulation on the client; only request-context headers are set here. + let mut request_builder = request_builder + .header("accept", "*/*") + .header("accept-language", "en") + .header("origin", WEB_ORIGIN) + .header("referer", format!("{WEB_ORIGIN}/")) + .header("cache-control", "no-cache") + .header("pragma", "no-cache") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-site"); + + match &credential { + RequestCredential::Bearer(auth) => { + request_builder = request_builder.header("authorization", auth.bearer_header_value()); + if let Some(cookie_header) = auth.maybe_cookie_header.as_deref() { + request_builder = request_builder.header("cookie", cookie_header); + } + if let Some(datadome_client_id) = auth.maybe_datadome_client_id.as_deref() { + request_builder = request_builder.header("x-datadome-clientid", datadome_client_id); + } + } + RequestCredential::Cookies { cookies, .. } => { + request_builder = request_builder.header("cookie", cookies.as_header_value()); + } + } + + match body { + RequestBody::None => {} + RequestBody::Json(body) => { + let body_json = serde_json::to_string(body) + .map_err(HiggsfieldClientError::RequestSerialization)?; + debug!("Higgsfield request body: {}", body_json); + request_builder = request_builder + .header("content-type", "application/json") + .body(body_json); + } + RequestBody::Form(body) => { + request_builder = request_builder.form(body); + } + } + + let request = request_builder + .build() + .map_err(HiggsfieldClientError::WreqRequestBuild)?; + + info!("Higgsfield request: {} {} (browser: {})", method.as_str(), url, browser_profile.label()); + + let response = client.execute(request) + .await + .map_err(HiggsfieldApiError::from_transport_error)?; + + let status = response.status(); + let protection_headers = ProtectionHeaders::from_headers(response.headers()); + + let response_body = response.text() + .await + .map_err(HiggsfieldApiError::from_transport_error)?; + + info!("Higgsfield response: status={} ({} bytes)", status, response_body.len()); + debug!("Higgsfield response body: {}", response_body); + + classify_higgsfield_http_response(&HttpResponseSignals { + status_code: status.as_u16(), + body: &response_body, + maybe_server_header: protection_headers.server.as_deref(), + maybe_cf_ray: protection_headers.cf_ray.as_deref(), + maybe_cf_mitigated: protection_headers.cf_mitigated.as_deref(), + maybe_x_datadome: protection_headers.x_datadome.as_deref(), + maybe_x_dd_b: protection_headers.x_dd_b.as_deref(), + context: &url, + })?; + + let parsed = serde_json::from_str::(&response_body) + .map_err(|err| HiggsfieldApiError::deserialization(err, &response_body))?; + + Ok(parsed) +} + +/// The response headers Cloudflare and DataDome use to announce themselves, +/// copied out before the body is consumed. +struct ProtectionHeaders { + server: Option, + cf_ray: Option, + cf_mitigated: Option, + x_datadome: Option, + x_dd_b: Option, +} + +impl ProtectionHeaders { + fn from_headers(headers: &HeaderMap) -> Self { + let get = |name: &str| headers.get(name).and_then(|value| value.to_str().ok()).map(|s| s.to_string()); + Self { + server: get("server"), + cf_ray: get("cf-ray"), + cf_mitigated: get("cf-mitigated"), + x_datadome: get("x-datadome"), + x_dd_b: get("x-dd-b"), + } + } +} diff --git a/crates/api_clients/higgsfield_client/src/credentials/clerk_session_token.rs b/crates/api_clients/higgsfield_client/src/credentials/clerk_session_token.rs new file mode 100644 index 00000000..2dce0633 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/credentials/clerk_session_token.rs @@ -0,0 +1,172 @@ +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::types::ids::{UserId, WorkspaceId}; +use chrono::{DateTime, Duration, Utc}; +use jwt_light::common_claims::CommonClaims; +use jwt_light::error::JwtError; +use jwt_light::parse_jwt_claims_trait::ParseJwtClaims; +use serde_json::{Map, Value}; + +/// A Clerk session JWT with its (unverified) claims decoded. +/// +/// This is the bearer token the API gateway wants. Clerk issues them with a +/// ~60 second lifetime; use [`Self::is_fresh`] before sending one. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct ClerkSessionToken { + jwt: String, + claims: ClerkSessionClaims, +} + +/// The claims we care about. NB: decoded without signature verification — +/// fine for reading our own session's metadata, never for trusting input. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct ClerkSessionClaims { + pub issued_at: DateTime, + pub expires_at: DateTime, + + /// Clerk session id (`sid`), e.g. `sess_...`. Needed to mint new tokens. + pub session_id: String, + + /// Clerk user id (`sub`), e.g. `user_...`. + pub user_id: UserId, + + /// Issuer (`iss`), e.g. `https://clerk.higgsfield.ai`. + pub maybe_issuer: Option, + + pub maybe_email: Option, + + pub maybe_full_name: Option, + + /// Higgsfield's custom `workspace_id` claim. + pub maybe_workspace_id: Option, +} + +impl ClerkSessionToken { + /// Decode a raw JWT. Fails if it isn't a three-part JWT with `exp`, `iat`, + /// `sid`, and `sub` claims. + pub fn parse(jwt: impl Into) -> Result { + let jwt = jwt.into().trim().to_string(); + let claims = ClerkSessionClaims::parse_claims(&jwt) + .map_err(|err| HiggsfieldClientError::InvalidSessionToken(format!("{:?}", err)))?; + Ok(Self { jwt, claims }) + } + + pub fn jwt(&self) -> &str { + &self.jwt + } + + pub fn into_jwt(self) -> String { + self.jwt + } + + pub fn claims(&self) -> &ClerkSessionClaims { + &self.claims + } + + pub fn session_id(&self) -> &str { + &self.claims.session_id + } + + pub fn expires_at(&self) -> DateTime { + self.claims.expires_at + } + + /// Whether the token is still good for at least `margin` more. Callers + /// mint a new one when this is false. + pub fn is_fresh(&self, now: DateTime, margin: Duration) -> bool { + now + margin < self.claims.expires_at + } + + /// Time left before expiry (zero once expired). + pub fn remaining(&self, now: DateTime) -> Duration { + (self.claims.expires_at - now).max(Duration::zero()) + } +} + +impl ParseJwtClaims for ClerkSessionClaims { + fn extract_claims(common_claims: CommonClaims, extra_claims: Map) -> Result { + let string_claim = |name: &str| -> Option { + extra_claims.get(name).and_then(|value| value.as_str()).map(|s| s.to_string()) + }; + + let session_id = string_claim("sid") + .ok_or_else(|| JwtError::CustomClaimsFieldError("no sid claim".to_string()))?; + let user_id = string_claim("sub") + .ok_or_else(|| JwtError::CustomClaimsFieldError("no sub claim".to_string()))?; + + Ok(Self { + issued_at: common_claims.created, + expires_at: common_claims.expiration, + session_id, + user_id: UserId::new(user_id), + maybe_issuer: string_claim("iss"), + maybe_email: string_claim("email"), + maybe_full_name: string_claim("full_name"), + maybe_workspace_id: string_claim("workspace_id").map(WorkspaceId::new), + }) + } +} + +#[cfg(test)] +pub(crate) mod tests { + use super::*; + use base64::Engine; + use base64::prelude::BASE64_URL_SAFE_NO_PAD; + + /// Build an unsigned JWT with the given claims, shaped like Clerk's. + pub(crate) fn fake_clerk_jwt(claims: &Value) -> String { + let header = BASE64_URL_SAFE_NO_PAD.encode(r#"{"alg":"RS256","kid":"ins_TEST","typ":"JWT"}"#); + let payload = BASE64_URL_SAFE_NO_PAD.encode(claims.to_string()); + format!("{header}.{payload}.signature") + } + + /// A token that expires at `exp` (epoch seconds), issued 60s earlier. + pub(crate) fn fake_clerk_token(exp: i64) -> ClerkSessionToken { + let jwt = fake_clerk_jwt(&serde_json::json!({ + "azp": "https://higgsfield.ai", + "email": "user@example.com", + "exp": exp, + "full_name": "Test User", + "iat": exp - 60, + "iss": "https://clerk.higgsfield.ai", + "jti": "0000000000000000000000", + "nbf": exp - 70, + "sid": "sess_TESTSESSION000000000000000", + "sts": "active", + "sub": "user_TESTUSER0000000000000000000", + "workspace_id": "00000000-0000-0000-0000-00000000aaaa" + })); + ClerkSessionToken::parse(jwt).unwrap() + } + + #[test] + fn parses_clerk_shaped_claims() { + let token = fake_clerk_token(1_788_147_273); + let claims = token.claims(); + assert_eq!(claims.session_id, "sess_TESTSESSION000000000000000"); + assert_eq!(claims.user_id.as_str(), "user_TESTUSER0000000000000000000"); + assert_eq!(claims.maybe_email.as_deref(), Some("user@example.com")); + assert_eq!(claims.maybe_full_name.as_deref(), Some("Test User")); + assert_eq!(claims.maybe_issuer.as_deref(), Some("https://clerk.higgsfield.ai")); + assert_eq!(claims.maybe_workspace_id.as_ref().unwrap().as_str(), "00000000-0000-0000-0000-00000000aaaa"); + assert_eq!(claims.expires_at, DateTime::from_timestamp(1_788_147_273, 0).unwrap()); + assert_eq!(claims.issued_at, DateTime::from_timestamp(1_788_147_213, 0).unwrap()); + } + + #[test] + fn freshness_uses_margin() { + let token = fake_clerk_token(1_000_000); + let expires = DateTime::from_timestamp(1_000_000, 0).unwrap(); + assert!(token.is_fresh(expires - Duration::seconds(30), Duration::seconds(10))); + assert!(!token.is_fresh(expires - Duration::seconds(5), Duration::seconds(10))); + assert!(!token.is_fresh(expires + Duration::seconds(1), Duration::zero())); + assert_eq!(token.remaining(expires - Duration::seconds(30)), Duration::seconds(30)); + assert_eq!(token.remaining(expires + Duration::seconds(30)), Duration::zero()); + } + + #[test] + fn rejects_non_jwt_and_missing_claims() { + assert!(matches!(ClerkSessionToken::parse("not-a-jwt"), Err(HiggsfieldClientError::InvalidSessionToken(_)))); + let no_sid = fake_clerk_jwt(&serde_json::json!({"exp": 10, "iat": 5, "sub": "user_x"})); + assert!(matches!(ClerkSessionToken::parse(no_sid), Err(HiggsfieldClientError::InvalidSessionToken(_)))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/credentials/higgsfield_auth.rs b/crates/api_clients/higgsfield_client/src/credentials/higgsfield_auth.rs new file mode 100644 index 00000000..ee7285f9 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/credentials/higgsfield_auth.rs @@ -0,0 +1,126 @@ +use crate::error::higgsfield_client_error::HiggsfieldClientError; + +/// Everything needed to act as a logged-in higgsfield.ai session. +/// +/// The gateway authenticates with a Clerk-issued JWT sent as +/// `authorization: Bearer `. These tokens are short-lived (about a +/// minute in captured sessions) — the web app mints a fresh one from the +/// Clerk session cookie before each burst of requests, so callers should +/// expect to refresh `bearer_token` regularly. +/// +/// The cookie header and DataDome client id are optional extras captured +/// from the same browser session; sending them makes requests look more like +/// the web app's and can matter for bot detection. +#[derive(Clone)] +pub struct HiggsfieldAuth { + /// The Clerk session JWT (without the `Bearer ` prefix). + pub bearer_token: String, + + /// The browser's `cookie` header for higgsfield.ai, if available. + pub maybe_cookie_header: Option, + + /// The `x-datadome-clientid` header value from the browser session, if + /// available. + pub maybe_datadome_client_id: Option, + + /// The User-Agent of the browser that captured the cookies. Bot-protection + /// cookies (`cf_clearance`, `datadome`) are bound to it, so requests + /// replaying them present the same string. When `None`, the client's + /// pinned default is used. + pub maybe_user_agent: Option, +} + +impl HiggsfieldAuth { + pub fn new(bearer_token: impl Into) -> Self { + Self { + bearer_token: bearer_token.into().trim().to_string(), + maybe_cookie_header: None, + maybe_datadome_client_id: None, + maybe_user_agent: None, + } + } + + pub fn with_cookie_header(mut self, cookie_header: impl Into) -> Self { + self.maybe_cookie_header = Some(cookie_header.into().trim().to_string()); + self + } + + pub fn with_datadome_client_id(mut self, datadome_client_id: impl Into) -> Self { + self.maybe_datadome_client_id = Some(datadome_client_id.into().trim().to_string()); + self + } + + pub fn with_user_agent(mut self, user_agent: impl Into) -> Self { + self.maybe_user_agent = Some(user_agent.into().trim().to_string()); + self + } + + /// Cheap pre-flight checks so an obviously bad session fails before any + /// HTTP round trip. + pub(crate) fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.bearer_token.is_empty() { + return Err(HiggsfieldClientError::MissingBearerToken); + } + if self.bearer_token.chars().any(|c| c.is_control() || c.is_whitespace()) { + return Err(HiggsfieldClientError::InvalidBearerToken); + } + Ok(()) + } + + pub(crate) fn bearer_header_value(&self) -> String { + format!("Bearer {}", self.bearer_token) + } +} + +// Debug is redacted so the session can't end up in a log line via an +// accidental `{:?}` on an enclosing args struct. +impl std::fmt::Debug for HiggsfieldAuth { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("HiggsfieldAuth") + .field("bearer_token", &"") + .field("maybe_cookie_header", &self.maybe_cookie_header.as_ref().map(|_| "")) + .field("maybe_datadome_client_id", &self.maybe_datadome_client_id.as_ref().map(|_| "")) + .field("maybe_user_agent", &self.maybe_user_agent) + .finish() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn new_trims_token() { + let auth = HiggsfieldAuth::new(" abc.def.ghi\n"); + assert_eq!(auth.bearer_token, "abc.def.ghi"); + assert_eq!(auth.bearer_header_value(), "Bearer abc.def.ghi"); + } + + #[test] + fn empty_token_is_rejected() { + assert!(matches!( + HiggsfieldAuth::new(" ").validate(), + Err(HiggsfieldClientError::MissingBearerToken), + )); + } + + #[test] + fn token_with_whitespace_is_rejected() { + assert!(matches!( + HiggsfieldAuth::new("abc def").validate(), + Err(HiggsfieldClientError::InvalidBearerToken), + )); + } + + #[test] + fn debug_is_redacted() { + let auth = HiggsfieldAuth::new("super-secret-token") + .with_cookie_header("__session=secret-cookie") + .with_datadome_client_id("secret-datadome"); + let debug = format!("{:?}", auth); + assert!(!debug.contains("super-secret-token")); + assert!(!debug.contains("secret-cookie")); + assert!(!debug.contains("secret-datadome")); + assert!(debug.contains("")); + } +} diff --git a/crates/api_clients/higgsfield_client/src/credentials/higgsfield_cookies.rs b/crates/api_clients/higgsfield_client/src/credentials/higgsfield_cookies.rs new file mode 100644 index 00000000..2e914575 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/credentials/higgsfield_cookies.rs @@ -0,0 +1,123 @@ +use crate::error::higgsfield_client_error::HiggsfieldClientError; + +/// Clerk's client cookie: the long-lived credential that mints session JWTs. +/// It's an HttpOnly cookie on the Clerk frontend-API host +/// (`clerk.higgsfield.ai`), which the login webview capture keeps because it +/// keeps every cookie under `higgsfield.ai`. +pub const CLERK_CLIENT_COOKIE: &str = "__client"; + +/// The current session JWT as a cookie on `higgsfield.ai`. Short-lived, but +/// useful as a seed: even expired it carries the session id. +pub const CLERK_SESSION_COOKIE: &str = "__session"; + +/// A browser session's cookies for higgsfield.ai (all hosts under it), as +/// one `cookie` header value: `name=value; name2=value2`. +/// +/// This is the long-lived credential. The API gateway itself wants a Clerk +/// JWT, which these cookies can mint — see +/// [`HiggsfieldSession`](crate::session::higgsfield_session::HiggsfieldSession). +#[derive(Clone, PartialEq, Eq)] +pub struct HiggsfieldCookies { + cookie_header: String, +} + +impl HiggsfieldCookies { + /// From a `cookie` header value. Whitespace is trimmed. + pub fn from_cookie_header(cookie_header: impl Into) -> Self { + Self { cookie_header: cookie_header.into().trim().to_string() } + } + + pub fn as_header_value(&self) -> &str { + &self.cookie_header + } + + /// The value of one cookie, if present. + pub fn cookie_value(&self, name: &str) -> Option<&str> { + self.cookie_header + .split(';') + .map(str::trim) + .filter_map(|pair| pair.split_once('=')) + .find(|(cookie_name, _)| cookie_name.trim() == name) + .map(|(_, value)| value.trim()) + } + + /// Whether the Clerk client cookie is present — without it no token can + /// be minted. + pub fn has_clerk_client_cookie(&self) -> bool { + self.cookie_value(CLERK_CLIENT_COOKIE).is_some_and(|value| !value.is_empty()) + } + + /// The `__session` JWT, if the capture included one. + pub fn maybe_session_jwt(&self) -> Option<&str> { + self.cookie_value(CLERK_SESSION_COOKIE).filter(|value| !value.is_empty()) + } + + pub(crate) fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.cookie_header.is_empty() { + return Err(HiggsfieldClientError::MissingCookies); + } + if self.cookie_header.chars().any(|c| c.is_control()) { + return Err(HiggsfieldClientError::InvalidCookies); + } + if !self.has_clerk_client_cookie() { + return Err(HiggsfieldClientError::MissingClerkClientCookie); + } + Ok(()) + } +} + +// Debug is redacted so the cookies can't end up in a log line. +impl std::fmt::Debug for HiggsfieldCookies { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let names = self.cookie_header + .split(';') + .filter_map(|pair| pair.trim().split_once('=')) + .map(|(name, _)| name.trim()) + .collect::>(); + f.debug_struct("HiggsfieldCookies") + .field("cookie_names", &names) + .field("values", &"") + .finish() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const HEADER: &str = "__client_uat=1788147196; __client=eyJhbGciOi.client.sig; __session=eyJhbGciOi.session.sig; ph_id=abc"; + + #[test] + fn parses_cookie_values() { + let cookies = HiggsfieldCookies::from_cookie_header(HEADER); + assert_eq!(cookies.cookie_value("__client"), Some("eyJhbGciOi.client.sig")); + assert_eq!(cookies.cookie_value("ph_id"), Some("abc")); + assert_eq!(cookies.cookie_value("missing"), None); + assert!(cookies.has_clerk_client_cookie()); + assert_eq!(cookies.maybe_session_jwt(), Some("eyJhbGciOi.session.sig")); + assert!(cookies.validate().is_ok()); + } + + #[test] + fn missing_client_cookie_is_rejected() { + let cookies = HiggsfieldCookies::from_cookie_header("__session=abc"); + assert!(!cookies.has_clerk_client_cookie()); + assert!(matches!(cookies.validate(), Err(HiggsfieldClientError::MissingClerkClientCookie))); + } + + #[test] + fn empty_is_rejected() { + assert!(matches!( + HiggsfieldCookies::from_cookie_header(" ").validate(), + Err(HiggsfieldClientError::MissingCookies), + )); + } + + #[test] + fn debug_lists_names_only() { + let debug = format!("{:?}", HiggsfieldCookies::from_cookie_header(HEADER)); + assert!(debug.contains("__client")); + assert!(!debug.contains("client.sig")); + assert!(debug.contains("")); + } +} diff --git a/crates/api_clients/higgsfield_client/src/credentials/mod.rs b/crates/api_clients/higgsfield_client/src/credentials/mod.rs new file mode 100644 index 00000000..35fd6177 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/credentials/mod.rs @@ -0,0 +1,3 @@ +pub mod clerk_session_token; +pub mod higgsfield_auth; +pub mod higgsfield_cookies; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/auth/clerk_client.rs b/crates/api_clients/higgsfield_client/src/endpoints/auth/clerk_client.rs new file mode 100644 index 00000000..cf61817c --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/auth/clerk_client.rs @@ -0,0 +1,258 @@ +//! GET `https://clerk.higgsfield.ai/v1/client` — Clerk's view of this +//! browser "client": its sessions and, for each, a freshly minted session +//! JWT (`last_active_token`). Cookie-authenticated (`__client`). + +use crate::client::clerk_host::ClerkHost; +use crate::client::send_request::{send_clerk_request, HttpMethod, RequestBody}; +use crate::credentials::clerk_session_token::ClerkSessionToken; +use crate::credentials::higgsfield_cookies::HiggsfieldCookies; +use crate::error::higgsfield_api_error::HiggsfieldApiError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::UserId; +use crate::types::string_enum::string_enum; +use serde::Deserialize; + +const PATH: &str = "/v1/client"; + +string_enum! { + ClerkSessionStatus { + Active => "active", + Expired => "expired", + Removed => "removed", + Revoked => "revoked", + Abandoned => "abandoned", + Ended => "ended", + Pending => "pending", + } +} + +pub struct ClerkClientArgs<'a> { + pub request: ClerkClientRequest, + pub cookies: &'a HiggsfieldCookies, + /// The User-Agent of the browser that captured the cookies (see + /// `HiggsfieldSession::with_user_agent`); `None` uses the pinned default. + pub maybe_user_agent: Option<&'a str>, + pub host: &'a ClerkHost, +} + +/// No parameters; kept for uniformity with the other endpoints. +#[derive(Clone, Debug, Default)] +pub struct ClerkClientRequest; + +#[derive(Clone, Debug)] +pub struct ClerkClientResponse { + /// Clerk client id (`client_...`). + pub id: String, + + pub sessions: Vec, + + /// Which session the web app was using last. + pub maybe_last_active_session_id: Option, +} + +impl ClerkClientResponse { + /// The session to mint tokens for: the last active one if it's still + /// active, else the first active session. + pub fn active_session(&self) -> Option<&ClerkSession> { + let is_active = |session: &&ClerkSession| session.status == ClerkSessionStatus::Active; + self.maybe_last_active_session_id.as_deref() + .and_then(|id| self.sessions.iter().find(|session| session.id == id)) + .filter(is_active) + .or_else(|| self.sessions.iter().find(is_active)) + } +} + +#[derive(Clone, Debug)] +pub struct ClerkSession { + /// `sess_...` + pub id: String, + + pub status: ClerkSessionStatus, + + /// Unix epoch milliseconds. + pub maybe_expire_at: Option, + + /// A session JWT Clerk minted while answering this request. Fresh, so it + /// can be used immediately. + pub maybe_last_active_token: Option, + + pub maybe_user_id: Option, +} + +/// Fetch the client. Fails with +/// [`HiggsfieldApiError::NoActiveSession`] when Clerk knows the client but +/// it has no active session (signed out / expired). +pub async fn clerk_client(args: ClerkClientArgs<'_>) -> Result { + let raw: ClerkClientEnvelope = send_clerk_request( + HttpMethod::Get, + PATH, + args.cookies, + args.maybe_user_agent, + args.host, + RequestBody::<()>::None, + ).await?; + + let Some(client) = raw.response else { + return Err(HiggsfieldApiError::NoActiveSession { raw_http_body: "{\"response\":null}".to_string() }.into()); + }; + + let sessions = client.sessions.into_iter().map(|session| ClerkSession { + id: session.id, + status: session.status, + maybe_expire_at: session.expire_at, + // A token that doesn't parse is treated as absent; the caller will mint + // one explicitly instead. + maybe_last_active_token: session.last_active_token + .and_then(|token| token.jwt) + .and_then(|jwt| ClerkSessionToken::parse(jwt).ok()), + maybe_user_id: session.user.map(|user| user.id), + }).collect::>(); + + let response = ClerkClientResponse { + id: client.id, + sessions, + maybe_last_active_session_id: client.last_active_session_id, + }; + + if response.active_session().is_none() { + return Err(HiggsfieldApiError::NoActiveSession { + raw_http_body: format!("client {} has {} session(s), none active", response.id, response.sessions.len()), + }.into()); + } + + Ok(response) +} + +// ── Wire format ── + +/// Clerk wraps the client: `{"response": {...}, "client": null}`. +#[derive(Deserialize)] +struct ClerkClientEnvelope { + #[serde(default)] + response: Option, +} + +#[derive(Deserialize)] +struct RawClerkClient { + id: String, + + #[serde(default)] + sessions: Vec, + + #[serde(default)] + last_active_session_id: Option, +} + +#[derive(Deserialize)] +struct RawClerkSession { + id: String, + + status: ClerkSessionStatus, + + #[serde(default)] + expire_at: Option, + + #[serde(default)] + last_active_token: Option, + + #[serde(default)] + user: Option, +} + +#[derive(Deserialize)] +struct RawClerkToken { + #[serde(default)] + jwt: Option, +} + +#[derive(Deserialize)] +struct RawClerkUser { + id: UserId, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::clerk_session_token::tests::fake_clerk_jwt; + + fn envelope(sessions_json: &str, last_active: Option<&str>) -> String { + let last_active = match last_active { + Some(id) => format!("\"{id}\""), + None => "null".to_string(), + }; + format!(r#"{{"response":{{"object":"client","id":"client_TEST","sessions":[{sessions_json}],"sign_in":null,"sign_up":null,"last_active_session_id":{last_active},"cookie_expires_at":null,"created_at":1788147000000,"updated_at":1788147200000}},"client":null}}"#) + } + + fn session_json(id: &str, status: &str, jwt: Option<&str>) -> String { + let token = match jwt { + Some(jwt) => format!(r#"{{"object":"token","jwt":"{jwt}"}}"#), + None => "null".to_string(), + }; + format!(r#"{{"object":"session","id":"{id}","status":"{status}","expire_at":1788751996000,"abandon_at":1790739196000,"last_active_at":1788147196000,"last_active_organization_id":null,"actor":null,"user":{{"id":"user_TESTUSER0000000000000000000","object":"user"}},"public_user_data":{{"identifier":"user@example.com"}},"created_at":1788147196000,"updated_at":1788147196000,"last_active_token":{token}}}"#) + } + + fn parse(body: &str) -> ClerkClientEnvelope { + serde_json::from_str(body).unwrap() + } + + #[test] + fn envelope_parses_with_token() { + let jwt = fake_clerk_jwt(&serde_json::json!({"exp": 1_788_147_273, "iat": 1_788_147_213, "sid": "sess_A", "sub": "user_TESTUSER0000000000000000000"})); + let body = envelope(&session_json("sess_A", "active", Some(&jwt)), Some("sess_A")); + let raw = parse(&body).response.unwrap(); + assert_eq!(raw.id, "client_TEST"); + assert_eq!(raw.sessions.len(), 1); + assert_eq!(raw.sessions[0].status, ClerkSessionStatus::Active); + assert_eq!(raw.sessions[0].last_active_token.as_ref().unwrap().jwt.as_deref(), Some(jwt.as_str())); + assert_eq!(raw.sessions[0].user.as_ref().unwrap().id.as_str(), "user_TESTUSER0000000000000000000"); + assert_eq!(raw.last_active_session_id.as_deref(), Some("sess_A")); + } + + #[test] + fn signed_out_client_has_null_response() { + let raw = parse(r#"{"response":null,"client":null}"#); + assert!(raw.response.is_none()); + } + + #[test] + fn active_session_prefers_last_active_then_first_active() { + let sessions = vec![ + ClerkSession { id: "sess_expired".into(), status: ClerkSessionStatus::Expired, maybe_expire_at: None, maybe_last_active_token: None, maybe_user_id: None }, + ClerkSession { id: "sess_B".into(), status: ClerkSessionStatus::Active, maybe_expire_at: None, maybe_last_active_token: None, maybe_user_id: None }, + ClerkSession { id: "sess_C".into(), status: ClerkSessionStatus::Active, maybe_expire_at: None, maybe_last_active_token: None, maybe_user_id: None }, + ]; + + let response = ClerkClientResponse { id: "client_TEST".into(), sessions: sessions.clone(), maybe_last_active_session_id: Some("sess_C".into()) }; + assert_eq!(response.active_session().unwrap().id, "sess_C"); + + // Last active points at a dead session: fall back to the first active. + let response = ClerkClientResponse { id: "client_TEST".into(), sessions: sessions.clone(), maybe_last_active_session_id: Some("sess_expired".into()) }; + assert_eq!(response.active_session().unwrap().id, "sess_B"); + + let response = ClerkClientResponse { id: "client_TEST".into(), sessions: vec![sessions[0].clone()], maybe_last_active_session_id: None }; + assert!(response.active_session().is_none()); + } + + // ── Live (ignored: needs captured cookies) ── + + #[tokio::test] + #[ignore] + async fn live_clerk_client() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let cookies = load_higgsfield_test_cookies()?; + let response = clerk_client(ClerkClientArgs { + request: ClerkClientRequest, + cookies: &cookies, + maybe_user_agent: None, + host: &ClerkHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let session = response.active_session().unwrap(); + println!("Active session {} (status {}), token expires {:?}", session.id, session.status, session.maybe_last_active_token.as_ref().map(|t| t.expires_at())); + assert!(session.maybe_last_active_token.is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/auth/clerk_session_tokens.rs b/crates/api_clients/higgsfield_client/src/endpoints/auth/clerk_session_tokens.rs new file mode 100644 index 00000000..1c08cbac --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/auth/clerk_session_tokens.rs @@ -0,0 +1,155 @@ +//! POST `https://clerk.higgsfield.ai/v1/client/sessions/{session_id}/tokens` +//! — mint a fresh session JWT. Cookie-authenticated (`__client`). This is +//! what clerk-js calls in the background roughly once a minute. + +use crate::client::clerk_host::ClerkHost; +use crate::client::send_request::{send_clerk_request, HttpMethod, RequestBody}; +use crate::credentials::clerk_session_token::ClerkSessionToken; +use crate::credentials::higgsfield_cookies::HiggsfieldCookies; +use crate::error::higgsfield_api_error::HiggsfieldApiError; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use serde::{Deserialize, Serialize}; + +pub struct ClerkSessionTokensArgs<'a> { + pub request: ClerkSessionTokensRequest, + pub cookies: &'a HiggsfieldCookies, + /// The User-Agent of the browser that captured the cookies (see + /// `HiggsfieldSession::with_user_agent`); `None` uses the pinned default. + pub maybe_user_agent: Option<&'a str>, + pub host: &'a ClerkHost, +} + +#[derive(Clone, Debug)] +pub struct ClerkSessionTokensRequest { + /// `sess_...` — from a previous token's `sid` claim or from + /// [`clerk_client`](crate::endpoints::auth::clerk_client::clerk_client). + pub session_id: String, + + /// Mint the token for an organization context. Higgsfield's web app + /// doesn't use this; leave `None`. + pub maybe_organization_id: Option, +} + +pub async fn clerk_session_tokens(args: ClerkSessionTokensArgs<'_>) -> Result { + let session_id = args.request.session_id.trim(); + if session_id.is_empty() || !session_id.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') { + return Err(HiggsfieldClientError::InvalidRequest(format!("session_id {:?} is not a Clerk session id", session_id)).into()); + } + + let path = format!("/v1/client/sessions/{}/tokens", session_id); + + // clerk-js sends this form-encoded; an empty form when there's no org. + let form = TokensForm { organization_id: args.request.maybe_organization_id }; + + let raw: TokenEnvelope = send_clerk_request( + HttpMethod::Post, + &path, + args.cookies, + args.maybe_user_agent, + args.host, + RequestBody::Form(&form), + ).await?; + + let Some(jwt) = raw.jwt() else { + return Err(HiggsfieldApiError::NoActiveSession { raw_http_body: "token response had no jwt".to_string() }.into()); + }; + + Ok(ClerkSessionToken::parse(jwt)?) +} + +// ── Wire format ── + +#[derive(Serialize)] +struct TokensForm { + #[serde(skip_serializing_if = "Option::is_none")] + organization_id: Option, +} + +/// `{"object":"token","jwt":"..."}` — but tolerate Clerk's +/// `{"response": {...}}` envelope too. +#[derive(Deserialize)] +struct TokenEnvelope { + #[serde(default)] + jwt: Option, + + #[serde(default)] + response: Option, +} + +#[derive(Deserialize)] +struct TokenBody { + #[serde(default)] + jwt: Option, +} + +impl TokenEnvelope { + fn jwt(self) -> Option { + self.jwt.or_else(|| self.response.and_then(|body| body.jwt)) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn form_omits_absent_organization() { + let form = TokensForm { organization_id: None }; + assert_eq!(serde_json::to_value(&form).unwrap(), serde_json::json!({})); + let form = TokensForm { organization_id: Some("org_1".into()) }; + assert_eq!(serde_json::to_value(&form).unwrap(), serde_json::json!({"organization_id": "org_1"})); + } + + #[test] + fn token_envelope_parses_both_shapes() { + let flat: TokenEnvelope = serde_json::from_str(r#"{"object":"token","jwt":"a.b.c"}"#).unwrap(); + assert_eq!(flat.jwt().as_deref(), Some("a.b.c")); + + let wrapped: TokenEnvelope = serde_json::from_str(r#"{"response":{"object":"token","jwt":"d.e.f"},"client":null}"#).unwrap(); + assert_eq!(wrapped.jwt().as_deref(), Some("d.e.f")); + + let empty: TokenEnvelope = serde_json::from_str(r#"{"object":"token","jwt":null}"#).unwrap(); + assert_eq!(empty.jwt(), None); + } + + #[tokio::test] + async fn bad_session_id_fails_before_any_http() { + let cookies = HiggsfieldCookies::from_cookie_header("__client=x"); + let host = ClerkHost::Custom("http://127.0.0.1:9".to_string()); + let err = clerk_session_tokens(ClerkSessionTokensArgs { + request: ClerkSessionTokensRequest { session_id: "../evil".into(), maybe_organization_id: None }, + cookies: &cookies, + maybe_user_agent: None, + host: &host, + }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + // ── Live (ignored: needs captured cookies) ── + + #[tokio::test] + #[ignore] + async fn live_mint_session_token() -> anyhow::Result<()> { + use crate::endpoints::auth::clerk_client::{clerk_client, ClerkClientArgs, ClerkClientRequest}; + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let cookies = load_higgsfield_test_cookies()?; + let client = clerk_client(ClerkClientArgs { request: ClerkClientRequest, cookies: &cookies, maybe_user_agent: None, host: &ClerkHost::Higgsfield }) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + let session_id = client.active_session().unwrap().id.clone(); + + let token = clerk_session_tokens(ClerkSessionTokensArgs { + request: ClerkSessionTokensRequest { session_id, maybe_organization_id: None }, + cookies: &cookies, + maybe_user_agent: None, + host: &ClerkHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Minted token for {} expiring {}", token.session_id(), token.expires_at()); + assert!(token.is_fresh(chrono::Utc::now(), chrono::Duration::seconds(10))); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/auth/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/auth/mod.rs new file mode 100644 index 00000000..9003c149 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/auth/mod.rs @@ -0,0 +1,5 @@ +//! Clerk frontend-API bindings: how a browser session's cookies turn into +//! the short-lived JWT the Higgsfield gateway wants. + +pub mod clerk_client; +pub mod clerk_session_tokens; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/gpt_image_2.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/gpt_image_2.rs new file mode 100644 index 00000000..f634d6de --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/gpt_image_2.rs @@ -0,0 +1,488 @@ +//! POST `/fnf/jobs/v2/gpt_image_2` — enqueue a GPT Image 2 job (the web +//! app's "GPT Image 2"; job set type `gpt_image_2`). +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 9 aspect ratios (incl. Auto), Low/Medium/High quality, +//! 1K (1024px) / 2K (2048px) / 4K (4096px), 1–4 images. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_quality::ImageQuality; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_dimensions::ImageDimensions; +use crate::types::image_resolution::ImageResolution; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::string_enum::string_enum; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/gpt_image_2"; + +/// The `model` field the web app sends on this endpoint. +const MODEL: &str = "gpt_image_2"; + +string_enum! { + /// The backend variant behind GPT Image 2. The web app currently always + /// sends `videotape-alpha`; it's echoed back as `params.model`. + GptImage2SubModel { + VideotapeAlpha => "videotape-alpha", + } +} + +impl Default for GptImage2SubModel { + fn default() -> Self { + Self::VideotapeAlpha + } +} + +/// The aspect ratios the web app offers for GPT Image 2, in its menu order. +/// (No 4:5 / 5:4, unlike Nano Banana Pro.) +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub enum GptImage2AspectRatio { + /// Let the model pick (meant for reference-image workflows). + Auto, + Square1x1, + Landscape3x2, + Portrait2x3, + Landscape16x9, + Portrait9x16, + Landscape4x3, + Portrait3x4, + Landscape21x9, +} + +impl GptImage2AspectRatio { + pub fn all() -> [Self; 9] { + [ + Self::Auto, Self::Square1x1, Self::Landscape3x2, Self::Portrait2x3, Self::Landscape16x9, + Self::Portrait9x16, Self::Landscape4x3, Self::Portrait3x4, Self::Landscape21x9, + ] + } + + /// The wire vocabulary value. + pub fn to_image_aspect_ratio(self) -> ImageAspectRatio { + match self { + Self::Auto => ImageAspectRatio::Auto, + Self::Square1x1 => ImageAspectRatio::Square1x1, + Self::Landscape3x2 => ImageAspectRatio::Landscape3x2, + Self::Portrait2x3 => ImageAspectRatio::Portrait2x3, + Self::Landscape16x9 => ImageAspectRatio::Landscape16x9, + Self::Portrait9x16 => ImageAspectRatio::Portrait9x16, + Self::Landscape4x3 => ImageAspectRatio::Landscape4x3, + Self::Portrait3x4 => ImageAspectRatio::Portrait3x4, + Self::Landscape21x9 => ImageAspectRatio::Landscape21x9, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Auto => "auto", + Self::Square1x1 => "1:1", + Self::Landscape3x2 => "3:2", + Self::Portrait2x3 => "2:3", + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::Landscape4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Landscape21x9 => "21:9", + } + } +} + +impl Serialize for GptImage2AspectRatio { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +/// Quality tiers the web app offers for GPT Image 2 ("Fastest and +/// cheapest" / "Balanced visuals" / "Best visual fidelity"). +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum GptImage2Quality { + Low, + #[default] + Medium, + High, +} + +impl GptImage2Quality { + pub fn all() -> [Self; 3] { + [Self::Low, Self::Medium, Self::High] + } + + pub fn to_image_quality(self) -> ImageQuality { + match self { + Self::Low => ImageQuality::Low, + Self::Medium => ImageQuality::Medium, + Self::High => ImageQuality::High, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Low => "low", + Self::Medium => "medium", + Self::High => "high", + } + } +} + +impl Serialize for GptImage2Quality { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +/// Resolution tiers the web app offers for GPT Image 2, with the pixel +/// size it labels each with. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum GptImage2Resolution { + /// 1024px + #[default] + OneK, + /// 2048px + TwoK, + /// 4096px + FourK, +} + +impl GptImage2Resolution { + pub fn all() -> [Self; 3] { + [Self::OneK, Self::TwoK, Self::FourK] + } + + /// The pixel size the web app's menu shows for the tier. + pub fn labeled_pixels(self) -> u32 { + match self { + Self::OneK => 1024, + Self::TwoK => 2048, + Self::FourK => 4096, + } + } + + pub fn to_image_resolution(self) -> ImageResolution { + match self { + Self::OneK => ImageResolution::OneK, + Self::TwoK => ImageResolution::TwoK, + Self::FourK => ImageResolution::FourK, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::OneK => "1k", + Self::TwoK => "2k", + Self::FourK => "4k", + } + } +} + +impl Serialize for GptImage2Resolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +pub struct GptImage2Args<'a> { + pub request: GptImage2Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a GPT Image 2 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct GptImage2Request { + pub prompt: String, + + pub aspect_ratio: GptImage2AspectRatio, + + pub quality: GptImage2Quality, + + pub resolution: GptImage2Resolution, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image. Sent as `medias` with role `image`. + /// + /// The web app refuses references under 300px on a side for this model + /// ("Image is too small"). With a reference and `Auto` aspect it sends + /// the reference's pixel size as `width`/`height`; this client keeps its + /// derived size (or `maybe_dimensions`). + pub reference_images: Vec, + + pub sub_model: GptImage2SubModel, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, the size + /// the web app would send for `aspect_ratio` + `resolution` is used. + pub maybe_dimensions: Option, +} + +impl GptImage2Request { + /// A text-to-image request with the web app's defaults (1 image, credits). + pub fn text_to_image( + prompt: impl Into, + aspect_ratio: GptImage2AspectRatio, + quality: GptImage2Quality, + resolution: GptImage2Resolution, + ) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + quality, + resolution, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + sub_model: GptImage2SubModel::default(), + use_unlim: false, + maybe_dimensions: None, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + ImageDimensions::for_aspect_ratio(&self.aspect_ratio.to_image_aspect_ratio(), &self.resolution.to_image_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest(format!( + "can't derive dimensions for aspect ratio {} at {}; pass maybe_dimensions", + self.aspect_ratio.as_str(), self.resolution.as_str(), + ))) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(GptImage2RequestBody { + params: GptImage2Params { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + quality: self.quality, + resolution: self.resolution, + sub_model: self.sub_model.clone(), + batch_size: self.batch_size, + model: MODEL, + width: dimensions.width, + height: dimensions.height, + medias: self.reference_images.iter().cloned().map(MediaReference::image).collect(), + }, + use_unlim: self.use_unlim, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn gpt_image_2(args: GptImage2Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct GptImage2RequestBody { + params: GptImage2Params, + use_unlim: bool, +} + +#[derive(Serialize)] +struct GptImage2Params { + prompt: String, + aspect_ratio: GptImage2AspectRatio, + quality: GptImage2Quality, + resolution: GptImage2Resolution, + sub_model: GptImage2SubModel, + batch_size: ImageBatchSize, + model: &'static str, + width: u32, + height: u32, + medias: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + // ── Option sets ── + + #[test] + fn aspect_ratios_match_the_web_app_menu() { + let wire: Vec<&str> = GptImage2AspectRatio::all().iter().map(|a| a.as_str()).collect(); + assert_eq!(wire, ["auto", "1:1", "3:2", "2:3", "16:9", "9:16", "4:3", "3:4", "21:9"]); + for ratio in GptImage2AspectRatio::all() { + assert_eq!(ratio.to_image_aspect_ratio().as_str(), ratio.as_str()); + } + } + + #[test] + fn quality_and_resolution_match_the_web_app_menus() { + let qualities: Vec<&str> = GptImage2Quality::all().iter().map(|q| q.as_str()).collect(); + assert_eq!(qualities, ["low", "medium", "high"]); + for quality in GptImage2Quality::all() { + assert_eq!(quality.to_image_quality().as_str(), quality.as_str()); + } + + let resolutions: Vec<(&str, u32)> = GptImage2Resolution::all().iter().map(|r| (r.as_str(), r.labeled_pixels())).collect(); + assert_eq!(resolutions, [("1k", 1024), ("2k", 2048), ("4k", 4096)]); + } + + // ── Outbound shape ── + + #[test] + fn wire_body_matches_captured_request() { + // Captured from the web app: 9:16 at 2k, high quality, one image. + let request = GptImage2Request::text_to_image("a corgi on a bike", GptImage2AspectRatio::Portrait9x16, GptImage2Quality::High, GptImage2Resolution::TwoK); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"9:16","quality":"high","resolution":"2k","sub_model":"videotape-alpha","batch_size":1,"model":"gpt_image_2","width":1152,"height":2048,"medias":[]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed): Auto aspect, low + // quality, 4k, one reference as `medias[].role = "image"`. The web app + // sent the reference's own 640x640 as width/height; this client sends + // its derived Auto size (or `maybe_dimensions`). + let request = GptImage2Request::text_to_image("a corgi on a bike", GptImage2AspectRatio::Auto, GptImage2Quality::Low, GptImage2Resolution::FourK) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let dimensions = request.dimensions().unwrap(); + let expected_json = r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"auto","quality":"low","resolution":"4k","sub_model":"videotape-alpha","batch_size":1,"model":"gpt_image_2","width":W,"height":H,"medias":[{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}]},"use_unlim":false}"# + .replace("\"width\":W", &format!("\"width\":{}", dimensions.width)).replace("\"height\":H", &format!("\"height\":{}", dimensions.height)); + let expected: Value = serde_json::from_str(&expected_json).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn every_option_combination_derives_dimensions() { + for ratio in GptImage2AspectRatio::all() { + for resolution in GptImage2Resolution::all() { + let request = GptImage2Request::text_to_image("p", ratio, GptImage2Quality::Low, resolution); + request.dimensions().unwrap_or_else(|err| panic!("{} @ {}: {err}", ratio.as_str(), resolution.as_str())); + } + } + } + + #[test] + fn public_request_serializes_with_typed_enums() { + let mut request = GptImage2Request::text_to_image("a cat", GptImage2AspectRatio::Square1x1, GptImage2Quality::Medium, GptImage2Resolution::OneK); + request.batch_size = ImageBatchSize::Two; + let value = serde_json::to_value(&request).unwrap(); + assert_eq!(value["quality"], json!("medium")); + assert_eq!(value["sub_model"], json!("videotape-alpha")); + assert_eq!(value["aspect_ratio"], json!("1:1")); + assert_eq!(value["batch_size"], json!(2)); + } + + // ── Validation ── + + #[test] + fn empty_prompt_is_rejected() { + let request = GptImage2Request::text_to_image("", GptImage2AspectRatio::Square1x1, GptImage2Quality::Low, GptImage2Resolution::OneK); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = GptImage2Request::text_to_image(" ", GptImage2AspectRatio::Square1x1, GptImage2Quality::Low, GptImage2Resolution::OneK); + + let err = gpt_image_2(GptImage2Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + // ── Inbound shape ── + + #[test] + fn enqueue_response_parses() { + use crate::types::enqueue_jobs_response::tests::GPT_IMAGE_ENQUEUE_RESPONSE; + use crate::types::job_set_type::JobSetType; + let response: EnqueueJobsResponse = serde_json::from_str(GPT_IMAGE_ENQUEUE_RESPONSE).unwrap(); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::GptImage2); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_gpt_image_2() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let response = gpt_image_2(GptImage2Args { + request: GptImage2Request::text_to_image("a corgi on a bike", GptImage2AspectRatio::Portrait9x16, GptImage2Quality::High, GptImage2Resolution::TwoK), + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Enqueued job ids: {:?}", response.job_ids()); + println!("Wallet: {:?}", response.wallet); + assert!(!response.job_ids().is_empty()); + Ok(()) + } + + /// Enqueues a GPT Image 2 job off the desktop app's saved Higgsfield + /// login (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`), + /// prints the enqueue response, then follows the job through the status + /// endpoints until it completes. Cheapest settings (1 image, 1k, low). + #[tokio::test] + #[ignore] + async fn live_enqueue_gpt_image_2_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("minting a session token failed: {err}"))?; + + let request = GptImage2Request::text_to_image("a corgi on a bike", GptImage2AspectRatio::Square1x1, GptImage2Quality::Low, GptImage2Resolution::OneK); + println!("\n===== request =====\n{:#?}", request); + + let response = gpt_image_2(GptImage2Args { + request, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("\n===== POST /fnf/jobs/v2/gpt_image_2 =====\n{:#?}", response); + let job_ids = response.job_ids(); + println!("job ids: {:?}", job_ids); + assert_eq!(job_ids.len(), 1); + assert_eq!(response.first_job_set().unwrap().job_set_type, crate::types::job_set_type::JobSetType::GptImage2); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some(), "completed job should have a result url"); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/live_model_matrix.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/live_model_matrix.rs new file mode 100644 index 00000000..be506778 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/live_model_matrix.rs @@ -0,0 +1,134 @@ +//! Live, credit-spending tests that exercise every image binding through +//! [`HiggsfieldSession`](crate::session::higgsfield_session::HiggsfieldSession) +//! off the desktop app's saved login, then follow each job through the +//! status endpoints. One test per model so failures isolate; run them +//! serially so the output stays readable: +//! +//! ```text +//! cargo test -p higgsfield_client live_matrix -- --ignored --nocapture --test-threads=1 +//! ``` +//! +//! Mix: single images at the high end of each quality menu, and maximum +//! batches (4) at the low end. + +use crate::endpoints::generate::image::gpt_image_2::{GptImage2AspectRatio, GptImage2Quality, GptImage2Request, GptImage2Resolution}; +use crate::endpoints::generate::image::nano_banana_2::{NanoBanana2Request, NanoBanana2Resolution}; +use crate::endpoints::generate::image::nano_banana_2_lite::{NanoBanana2LiteQuality, NanoBanana2LiteRequest}; +use crate::endpoints::generate::image::nano_banana_pro::{NanoBananaProRequest, NanoBananaProResolution}; +use crate::endpoints::generate::image::seedream_4p5::{Seedream4p5Request, Seedream4p5Resolution}; +use crate::endpoints::generate::image::seedream_5p0_lite::{Seedream5p0LiteRequest, Seedream5p0LiteResolution}; +use crate::endpoints::generate::image::seedream_5p0_pro::{Seedream5p0ProRequest, Seedream5p0ProResolution}; +use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; +use crate::test_utils::poll_job_to_completion::poll_jobs_to_completion; +use crate::test_utils::setup_test_logging::setup_test_logging; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::job_set_type::JobSetType; +use crate::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; +use crate::types::seedream_aspect_ratio::SeedreamAspectRatio; +use crate::session::higgsfield_session::HiggsfieldSession; + +const PROMPT_SKATEBOARD: &str = "a shiba inu doing a kickflip on a skateboard at a skate park, golden hour"; +const PROMPT_SURF: &str = "a shiba inu surfing a big wave, action photo"; +const PROMPT_SOCCER: &str = "a shiba inu scoring a goal in a soccer match, stadium lights"; +const PROMPT_BASKETBALL: &str = "a shiba inu dunking a basketball, slow motion"; +const PROMPT_SKI: &str = "a shiba inu skiing down a mountain, spraying powder"; +const PROMPT_TENNIS: &str = "a shiba inu serving a tennis ball at Wimbledon"; +const PROMPT_CYCLING: &str = "a shiba inu winning a bicycle race, crossing the finish line"; + +fn session() -> anyhow::Result { + setup_test_logging(); + load_higgsfield_session_from_app_credential() +} + +/// Print the enqueue, check the job set, and follow every job to completion. +async fn follow(session: &HiggsfieldSession, label: &str, expected_type: JobSetType, expected_jobs: usize, response: EnqueueJobsResponse) -> anyhow::Result<()> { + let job_set = response.first_job_set().ok_or_else(|| anyhow::anyhow!("no job set"))?; + println!( + "\n##### {label}: enqueued job set {} type={} cost={:?} jobs={} server size={:?}x{:?}", + job_set.id, job_set.job_set_type, job_set.cost, job_set.jobs.len(), job_set.params.width, job_set.params.height, + ); + println!("wallet after: {:?}", response.wallet.as_ref().map(|w| (w.credits_balance, w.subscription_balance))); + assert_eq!(job_set.job_set_type, expected_type); + assert_eq!(job_set.jobs.len(), expected_jobs, "batch size should fan out into one job per image"); + + let job_ids = response.job_ids(); + let jobs = poll_jobs_to_completion(session, &job_ids).await?; + assert_eq!(jobs.len(), expected_jobs); + for job in &jobs { + assert_eq!(job.job_set_type, expected_type); + assert!(job.result_url().is_some(), "job {} has no result url", job.id); + } + println!("##### {label}: {} image(s) done", jobs.len()); + Ok(()) +} + +// ── High quality, single image ── + +#[tokio::test] +#[ignore] +async fn live_matrix_seedream_5p0_pro_2k() -> anyhow::Result<()> { + let session = session()?; + let request = Seedream5p0ProRequest::text_to_image(PROMPT_SKATEBOARD, SeedreamAspectRatio::Landscape16x9, Seedream5p0ProResolution::TwoK); + let response = session.seedream_5p0_pro(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedream 5.0 Pro @ 2K", JobSetType::SeedreamV5Pro, 1, response).await +} + +#[tokio::test] +#[ignore] +async fn live_matrix_seedream_5p0_lite_4k_ultra() -> anyhow::Result<()> { + let session = session()?; + let request = Seedream5p0LiteRequest::text_to_image(PROMPT_SURF, SeedreamAspectRatio::Landscape3x2, Seedream5p0LiteResolution::FourK); + let response = session.seedream_5p0_lite(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedream 5.0 lite @ 4K (ultra)", JobSetType::SeedreamV5Lite, 1, response).await +} + +#[tokio::test] +#[ignore] +async fn live_matrix_nano_banana_pro_2k() -> anyhow::Result<()> { + let session = session()?; + let request = NanoBananaProRequest::text_to_image(PROMPT_SOCCER, NanoBananaAspectRatio::Landscape16x9, NanoBananaProResolution::TwoK); + let response = session.nano_banana_pro(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Nano Banana Pro @ 2K", JobSetType::NanoBanana2, 1, response).await +} + +#[tokio::test] +#[ignore] +async fn live_matrix_gpt_image_2_high_1k() -> anyhow::Result<()> { + let session = session()?; + let request = GptImage2Request::text_to_image(PROMPT_BASKETBALL, GptImage2AspectRatio::Portrait3x4, GptImage2Quality::High, GptImage2Resolution::OneK); + let response = session.gpt_image_2(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "GPT Image 2 @ 1K high", JobSetType::GptImage2, 1, response).await +} + +// ── Maximum batch (4), low quality ── + +#[tokio::test] +#[ignore] +async fn live_matrix_seedream_4p5_2k_batch_of_4() -> anyhow::Result<()> { + let session = session()?; + let mut request = Seedream4p5Request::text_to_image(PROMPT_SKI, SeedreamAspectRatio::Square1x1, Seedream4p5Resolution::TwoK); + request.batch_size = ImageBatchSize::Four; + let response = session.seedream_4p5(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedream 4.5 @ 2K (basic) x4", JobSetType::SeedreamV4p5, 4, response).await +} + +#[tokio::test] +#[ignore] +async fn live_matrix_nano_banana_2_1k_batch_of_4() -> anyhow::Result<()> { + let session = session()?; + let mut request = NanoBanana2Request::text_to_image(PROMPT_TENNIS, NanoBananaAspectRatio::Portrait3x4, NanoBanana2Resolution::OneK); + request.batch_size = ImageBatchSize::Four; + let response = session.nano_banana_2(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Nano Banana 2 @ 1K x4", JobSetType::NanoBananaFlash, 4, response).await +} + +#[tokio::test] +#[ignore] +async fn live_matrix_nano_banana_2_lite_minimal_batch_of_4() -> anyhow::Result<()> { + let session = session()?; + let mut request = NanoBanana2LiteRequest::text_to_image(PROMPT_CYCLING, NanoBananaAspectRatio::Landscape4x3, NanoBanana2LiteQuality::Minimal); + request.batch_size = ImageBatchSize::Four; + let response = session.nano_banana_2_lite(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Nano Banana 2 Lite (MINIMAL) x4", JobSetType::NanoBanana2Lite, 4, response).await +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/mod.rs new file mode 100644 index 00000000..f7d00e70 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/mod.rs @@ -0,0 +1,10 @@ +pub mod gpt_image_2; +pub mod nano_banana_2; +pub mod nano_banana_2_lite; +pub mod nano_banana_pro; +pub mod seedream_4p5; +pub mod seedream_5p0_lite; +pub mod seedream_5p0_pro; + +#[cfg(test)] +mod live_model_matrix; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_2.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_2.rs new file mode 100644 index 00000000..f6a7f179 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_2.rs @@ -0,0 +1,273 @@ +//! POST `/fnf/jobs/v2/nano_banana_flash` — enqueue a Nano Banana 2 image +//! job. "Nano Banana 2" is the web app's name for the pipeline the API +//! calls `nano_banana_flash` (job set type `nano_banana_flash`). +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 11 aspect ratios (incl. Auto), 1K / 2K / 4K, 1–4 images. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_dimensions::ImageDimensions; +use crate::types::image_resolution::ImageResolution; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/nano_banana_flash"; + +/// The resolution tiers the web app offers for Nano Banana 2. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum NanoBanana2Resolution { + #[default] + OneK, + TwoK, + FourK, +} + +impl NanoBanana2Resolution { + pub fn all() -> [Self; 3] { + [Self::OneK, Self::TwoK, Self::FourK] + } + + pub fn to_image_resolution(self) -> ImageResolution { + match self { + Self::OneK => ImageResolution::OneK, + Self::TwoK => ImageResolution::TwoK, + Self::FourK => ImageResolution::FourK, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::OneK => "1k", + Self::TwoK => "2k", + Self::FourK => "4k", + } + } +} + +impl Serialize for NanoBanana2Resolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +pub struct NanoBanana2Args<'a> { + pub request: NanoBanana2Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Nano Banana 2 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct NanoBanana2Request { + pub prompt: String, + + pub aspect_ratio: NanoBananaAspectRatio, + + pub resolution: NanoBanana2Resolution, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image (then `medias` is omitted, as the web app + /// does). Sent as `medias` with role `image`. + pub reference_images: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one (this model is offered on it). + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, the size + /// the web app would send for `aspect_ratio` + `resolution` is used. + pub maybe_dimensions: Option, +} + +impl NanoBanana2Request { + /// A text-to-image request with the web app's defaults (1 image, credits). + pub fn text_to_image(prompt: impl Into, aspect_ratio: NanoBananaAspectRatio, resolution: NanoBanana2Resolution) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + ImageDimensions::for_aspect_ratio(&self.aspect_ratio.to_image_aspect_ratio(), &self.resolution.to_image_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest(format!( + "can't derive dimensions for aspect ratio {} at {}; pass maybe_dimensions", + self.aspect_ratio.as_str(), self.resolution.as_str(), + ))) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(NanoBanana2RequestBody { + params: NanoBanana2Params { + prompt: self.prompt.clone(), + medias: self.reference_images.iter().cloned().map(MediaReference::image).collect(), + aspect_ratio: self.aspect_ratio, + resolution: self.resolution, + batch_size: self.batch_size, + use_unlim: self.use_unlim, + width: dimensions.width, + height: dimensions.height, + }, + use_unlim: self.use_unlim, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn nano_banana_2(args: NanoBanana2Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct NanoBanana2RequestBody { + params: NanoBanana2Params, + use_unlim: bool, +} + +#[derive(Serialize)] +struct NanoBanana2Params { + prompt: String, + #[serde(skip_serializing_if = "Vec::is_empty")] + medias: Vec, + aspect_ratio: NanoBananaAspectRatio, + resolution: NanoBanana2Resolution, + batch_size: ImageBatchSize, + use_unlim: bool, + width: u32, + height: u32, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + /// Captured enqueue response, ids / user scrubbed. + const ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-0000000068dc","type":"nano_banana_flash","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788154942.202193,"parent_id":null,"cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","cost":150.0,"params":{"width":864,"height":1184,"aspect_ratio":"3:4","resolution":"1k","batch_size":1,"is_inpaint":false,"prompt":"a corgi on a bike","medias":[],"reference_elements":[]},"jobs":[{"id":"00000000-0000-0000-0000-0000a7ee94f9","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788154942.210965,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-0000a7ee94f9","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":118600,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec<&str> = NanoBanana2Resolution::all().iter().map(|r| r.as_str()).collect(); + assert_eq!(wire, ["1k", "2k", "4k"]); + } + + #[test] + fn wire_body_matches_captured_request() { + let request = NanoBanana2Request::text_to_image("a corgi on a bike", NanoBananaAspectRatio::Portrait3x4, NanoBanana2Resolution::OneK); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","resolution":"1k","batch_size":1,"use_unlim":false,"width":896,"height":1200},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn every_option_combination_derives_dimensions() { + for ratio in NanoBananaAspectRatio::all() { + for resolution in NanoBanana2Resolution::all() { + NanoBanana2Request::text_to_image("p", ratio, resolution).dimensions() + .unwrap_or_else(|err| panic!("{} @ {}: {err}", ratio.as_str(), resolution.as_str())); + } + } + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed). + let request = NanoBanana2Request::text_to_image("a corgi on a bike", NanoBananaAspectRatio::Portrait3x4, NanoBanana2Resolution::OneK) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","medias":[{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}],"aspect_ratio":"3:4","resolution":"1k","batch_size":1,"use_unlim":false,"width":896,"height":1200},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn empty_prompt_is_rejected() { + let request = NanoBanana2Request::text_to_image(" ", NanoBananaAspectRatio::Square1x1, NanoBanana2Resolution::OneK); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = NanoBanana2Request::text_to_image("", NanoBananaAspectRatio::Square1x1, NanoBanana2Resolution::OneK); + let err = nano_banana_2(NanoBanana2Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(ENQUEUE_RESPONSE).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::NanoBananaFlash); + assert_eq!(job_set.cost, Some(150.0)); + assert_eq!(job_set.params.resolution, Some(ImageResolution::OneK)); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_nano_banana_2_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = NanoBanana2Request::text_to_image("a corgi on a bike", NanoBananaAspectRatio::Portrait3x4, NanoBanana2Resolution::OneK); + println!("\n===== request =====\n{:#?}", request); + + let response = nano_banana_2(NanoBanana2Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + let job_ids = response.job_ids(); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::NanoBananaFlash); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_2_lite.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_2_lite.rs new file mode 100644 index 00000000..fd571d69 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_2_lite.rs @@ -0,0 +1,275 @@ +//! POST `/fnf/jobs/v2/nano_banana_2_lite` — enqueue a Nano Banana 2 Lite +//! image job (job set type `nano_banana_2_lite`). +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 11 aspect ratios (incl. Auto), a High / Minimal quality menu +//! sent as `thinking`, 1–4 images. There is no resolution menu — the app +//! always sends `resolution: "1k"`. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_dimensions::ImageDimensions; +use crate::types::image_resolution::ImageResolution; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; +use crate::types::thinking_level::ThinkingLevel; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/nano_banana_2_lite"; + +/// The only resolution this pipeline runs at. +const RESOLUTION: ImageResolution = ImageResolution::OneK; + +/// The web app's quality menu for Nano Banana 2 Lite ("High" / "Minimal"), +/// sent as the model's `thinking` level. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum NanoBanana2LiteQuality { + #[default] + High, + Minimal, +} + +impl NanoBanana2LiteQuality { + pub fn all() -> [Self; 2] { + [Self::High, Self::Minimal] + } + + pub fn to_thinking_level(self) -> ThinkingLevel { + match self { + Self::High => ThinkingLevel::High, + Self::Minimal => ThinkingLevel::Minimal, + } + } +} + +/// Serializes as the wire `thinking` value. +impl Serialize for NanoBanana2LiteQuality { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.to_thinking_level().as_str()) + } +} + +pub struct NanoBanana2LiteArgs<'a> { + pub request: NanoBanana2LiteRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Nano Banana 2 Lite request. Serializable so it +/// can be logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct NanoBanana2LiteRequest { + pub prompt: String, + + pub aspect_ratio: NanoBananaAspectRatio, + + pub quality: NanoBanana2LiteQuality, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image (then `medias` is omitted, as the web app + /// does). Sent as `medias` with role `image`. + pub reference_images: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, the size + /// the web app would send for `aspect_ratio` at 1k is used. + pub maybe_dimensions: Option, +} + +impl NanoBanana2LiteRequest { + /// A text-to-image request with the web app's defaults (1 image, credits). + pub fn text_to_image(prompt: impl Into, aspect_ratio: NanoBananaAspectRatio, quality: NanoBanana2LiteQuality) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + quality, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + ImageDimensions::for_aspect_ratio(&self.aspect_ratio.to_image_aspect_ratio(), &RESOLUTION) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest(format!( + "can't derive dimensions for aspect ratio {}; pass maybe_dimensions", self.aspect_ratio.as_str(), + ))) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(NanoBanana2LiteRequestBody { + params: NanoBanana2LiteParams { + prompt: self.prompt.clone(), + medias: self.reference_images.iter().cloned().map(MediaReference::image).collect(), + aspect_ratio: self.aspect_ratio, + resolution: RESOLUTION, + thinking: self.quality.to_thinking_level(), + batch_size: self.batch_size, + width: dimensions.width, + height: dimensions.height, + }, + use_unlim: self.use_unlim, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn nano_banana_2_lite(args: NanoBanana2LiteArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct NanoBanana2LiteRequestBody { + params: NanoBanana2LiteParams, + use_unlim: bool, +} + +/// NB: unlike the other Nano Banana endpoints, the web app does NOT put +/// `use_unlim` inside `params` here. +#[derive(Serialize)] +struct NanoBanana2LiteParams { + prompt: String, + #[serde(skip_serializing_if = "Vec::is_empty")] + medias: Vec, + aspect_ratio: NanoBananaAspectRatio, + resolution: ImageResolution, + thinking: ThinkingLevel, + batch_size: ImageBatchSize, + width: u32, + height: u32, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + /// Captured enqueue response (MINIMAL), ids / user scrubbed. + const ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-00000000943d","type":"nano_banana_2_lite","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788155026.294231,"parent_id":null,"cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","cost":100,"params":{"width":864,"height":1184,"aspect_ratio":"3:4","batch_size":1,"thinking":"MINIMAL","is_inpaint":false,"prompt":"a corgi on a bike","medias":[],"reference_elements":[]},"jobs":[{"id":"00000000-0000-0000-0000-00005900ddea","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788155026.303344,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00005900ddea","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":118500,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + #[test] + fn quality_menu_maps_to_thinking() { + let mapping: Vec = NanoBanana2LiteQuality::all().iter().map(|q| q.to_thinking_level().to_string()).collect(); + assert_eq!(mapping, ["HIGH", "MINIMAL"]); + } + + #[test] + fn wire_bodies_match_captured_requests() { + let cases = [ + (NanoBanana2LiteQuality::Minimal, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","resolution":"1k","thinking":"MINIMAL","batch_size":1,"width":896,"height":1200},"use_unlim":false}"#), + (NanoBanana2LiteQuality::High, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","resolution":"1k","thinking":"HIGH","batch_size":1,"width":896,"height":1200},"use_unlim":false}"#), + ]; + for (quality, expected) in cases { + let request = NanoBanana2LiteRequest::text_to_image("a corgi on a bike", NanoBananaAspectRatio::Portrait3x4, quality); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(expected).unwrap(); + assert_eq!(actual, expected, "{:?}", quality); + } + } + + #[test] + fn every_aspect_derives_dimensions() { + for ratio in NanoBananaAspectRatio::all() { + NanoBanana2LiteRequest::text_to_image("p", ratio, NanoBanana2LiteQuality::High).dimensions() + .unwrap_or_else(|err| panic!("{}: {err}", ratio.as_str())); + } + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed). + let request = NanoBanana2LiteRequest::text_to_image("a corgi on a bike", NanoBananaAspectRatio::Portrait3x4, NanoBanana2LiteQuality::High) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","medias":[{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}],"aspect_ratio":"3:4","resolution":"1k","thinking":"HIGH","batch_size":1,"width":896,"height":1200},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn empty_prompt_is_rejected() { + let request = NanoBanana2LiteRequest::text_to_image("", NanoBananaAspectRatio::Square1x1, NanoBanana2LiteQuality::High); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = NanoBanana2LiteRequest::text_to_image("", NanoBananaAspectRatio::Square1x1, NanoBanana2LiteQuality::High); + let err = nano_banana_2_lite(NanoBanana2LiteArgs { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(ENQUEUE_RESPONSE).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::NanoBanana2Lite); + assert_eq!(job_set.params.thinking, Some(ThinkingLevel::Minimal)); + assert!(job_set.params.resolution.is_none(), "the server drops resolution from the echoed params"); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_nano_banana_2_lite_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = NanoBanana2LiteRequest::text_to_image("a corgi on a bike", NanoBananaAspectRatio::Portrait3x4, NanoBanana2LiteQuality::Minimal); + println!("\n===== request =====\n{:#?}", request); + + let response = nano_banana_2_lite(NanoBanana2LiteArgs { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + let job_ids = response.job_ids(); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::NanoBanana2Lite); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_pro.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_pro.rs new file mode 100644 index 00000000..1453d99a --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/nano_banana_pro.rs @@ -0,0 +1,353 @@ +//! POST `/fnf/jobs/nano-banana-2` — enqueue a Nano Banana Pro image job. +//! +//! "Nano Banana Pro" is the web app's name for the pipeline the API calls +//! `nano-banana-2` (job set type `nano_banana_2`). +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 11 aspect ratios (incl. Auto), 1K/2K/4K, 1–4 images. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_dimensions::ImageDimensions; +use crate::types::image_resolution::ImageResolution; +use crate::types::media_input::MediaInput; +use crate::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/nano-banana-2"; + +/// Nano Banana Pro offers the same aspect menu as the other Nano Banana +/// models. +pub type NanoBananaProAspectRatio = NanoBananaAspectRatio; + +/// The resolution tiers the web app offers for Nano Banana Pro. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum NanoBananaProResolution { + #[default] + OneK, + TwoK, + FourK, +} + +impl NanoBananaProResolution { + pub fn all() -> [Self; 3] { + [Self::OneK, Self::TwoK, Self::FourK] + } + + pub fn to_image_resolution(self) -> ImageResolution { + match self { + Self::OneK => ImageResolution::OneK, + Self::TwoK => ImageResolution::TwoK, + Self::FourK => ImageResolution::FourK, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::OneK => "1k", + Self::TwoK => "2k", + Self::FourK => "4k", + } + } +} + +impl Serialize for NanoBananaProResolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +pub struct NanoBananaProArgs<'a> { + pub request: NanoBananaProRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Nano Banana Pro request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct NanoBananaProRequest { + pub prompt: String, + + pub aspect_ratio: NanoBananaProAspectRatio, + + pub resolution: NanoBananaProResolution, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image. Sent as `input_images` (this endpoint + /// predates the role-tagged `medias` list). One reference raised the + /// price from 150 to 200 credits at 1k. + pub reference_images: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, the size + /// the web app would send for `aspect_ratio` + `resolution` is used. + pub maybe_dimensions: Option, +} + +impl NanoBananaProRequest { + /// A text-to-image request with the web app's defaults (1 image, credits). + pub fn text_to_image(prompt: impl Into, aspect_ratio: NanoBananaProAspectRatio, resolution: NanoBananaProResolution) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + ImageDimensions::for_aspect_ratio(&self.aspect_ratio.to_image_aspect_ratio(), &self.resolution.to_image_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest(format!( + "can't derive dimensions for aspect ratio {} at {}; pass maybe_dimensions", + self.aspect_ratio.as_str(), self.resolution.as_str(), + ))) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(NanoBananaProRequestBody { + params: NanoBananaProParams { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + resolution: self.resolution, + batch_size: self.batch_size, + is_storyboard: false, + is_zoom_control: false, + use_unlim: self.use_unlim, + width: dimensions.width, + height: dimensions.height, + input_images: self.reference_images.clone(), + }, + use_unlim: self.use_unlim, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn nano_banana_pro(args: NanoBananaProArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct NanoBananaProRequestBody { + params: NanoBananaProParams, + use_unlim: bool, +} + +#[derive(Serialize)] +struct NanoBananaProParams { + prompt: String, + aspect_ratio: NanoBananaProAspectRatio, + resolution: NanoBananaProResolution, + batch_size: ImageBatchSize, + is_storyboard: bool, + is_zoom_control: bool, + use_unlim: bool, + width: u32, + height: u32, + input_images: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use serde_json::{json, Value}; + + // ── Option sets ── + + #[test] + fn aspect_ratios_match_the_web_app_menu() { + let wire: Vec<&str> = NanoBananaProAspectRatio::all().iter().map(|a| a.as_str()).collect(); + assert_eq!(wire, ["auto", "1:1", "3:4", "4:3", "2:3", "3:2", "9:16", "16:9", "5:4", "4:5", "21:9"]); + } + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec<&str> = NanoBananaProResolution::all().iter().map(|r| r.as_str()).collect(); + assert_eq!(wire, ["1k", "2k", "4k"]); + assert_eq!(NanoBananaProResolution::default(), NanoBananaProResolution::OneK); + } + + // ── Outbound shape ── + + #[test] + fn wire_body_matches_captured_request() { + // Captured from the web app: 3:4 at 1k, one image. + let request = NanoBananaProRequest::text_to_image("a dinosaur on a skateboard", NanoBananaProAspectRatio::Portrait3x4, NanoBananaProResolution::OneK); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a dinosaur on a skateboard","aspect_ratio":"3:4","resolution":"1k","batch_size":1,"is_storyboard":false,"is_zoom_control":false,"use_unlim":false,"width":896,"height":1200,"input_images":[]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed): one uploaded + // reference goes out as a bare descriptor in `input_images`. The web app + // sent 1376x768 for 16:9@1k; this client's derivation is asserted. + let request = NanoBananaProRequest::text_to_image("a corgi on a bike", NanoBananaProAspectRatio::Landscape16x9, NanoBananaProResolution::OneK) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let dimensions = request.dimensions().unwrap(); + let expected_json = r#"{"params":{"prompt":"a corgi on a bike","input_images":[{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}],"aspect_ratio":"16:9","resolution":"1k","batch_size":1,"is_storyboard":false,"is_zoom_control":false,"use_unlim":false,"width":W,"height":H},"use_unlim":false}"# + .replace("\"width\":W", &format!("\"width\":{}", dimensions.width)).replace("\"height\":H", &format!("\"height\":{}", dimensions.height)); + let expected: Value = serde_json::from_str(&expected_json).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_4k_landscape_matches_captured_request() { + let request = NanoBananaProRequest::text_to_image("a dinosaur on a skateboard", NanoBananaProAspectRatio::Landscape16x9, NanoBananaProResolution::FourK); + let dimensions = request.dimensions().unwrap(); + assert_eq!((dimensions.width, dimensions.height), (5504, 3072)); + } + + #[test] + fn every_option_combination_derives_dimensions() { + for ratio in NanoBananaProAspectRatio::all() { + for resolution in NanoBananaProResolution::all() { + let request = NanoBananaProRequest::text_to_image("p", ratio, resolution); + request.dimensions().unwrap_or_else(|err| panic!("{} @ {}: {err}", ratio.as_str(), resolution.as_str())); + } + } + } + + #[test] + fn explicit_dimensions_override_derived_ones() { + let mut request = NanoBananaProRequest::text_to_image("p", NanoBananaProAspectRatio::Square1x1, NanoBananaProResolution::OneK); + request.maybe_dimensions = Some(ImageDimensions::new(1024, 1024)); + assert_eq!(request.dimensions().unwrap(), ImageDimensions::new(1024, 1024)); + } + + #[test] + fn public_request_serializes_with_typed_enums() { + let mut request = NanoBananaProRequest::text_to_image("a cat", NanoBananaProAspectRatio::Landscape16x9, NanoBananaProResolution::TwoK); + request.batch_size = ImageBatchSize::Four; + let value = serde_json::to_value(&request).unwrap(); + assert_eq!(value["aspect_ratio"], json!("16:9")); + assert_eq!(value["resolution"], json!("2k")); + assert_eq!(value["batch_size"], json!(4)); + } + + // ── Validation ── + + #[test] + fn empty_prompt_is_rejected() { + let request = NanoBananaProRequest::text_to_image(" ", NanoBananaProAspectRatio::Square1x1, NanoBananaProResolution::OneK); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + // No network: an unroutable custom host would fail differently. + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = NanoBananaProRequest::text_to_image("", NanoBananaProAspectRatio::Square1x1, NanoBananaProResolution::OneK); + + let err = nano_banana_pro(NanoBananaProArgs { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + // ── Inbound shape ── + + #[test] + fn enqueue_response_parses() { + use crate::types::enqueue_jobs_response::tests::NANO_BANANA_ENQUEUE_RESPONSE; + let response: EnqueueJobsResponse = serde_json::from_str(NANO_BANANA_ENQUEUE_RESPONSE).unwrap(); + assert_eq!(response.job_ids().len(), 1); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_nano_banana_pro() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let response = nano_banana_pro(NanoBananaProArgs { + request: NanoBananaProRequest::text_to_image("a dinosaur on a skateboard", NanoBananaProAspectRatio::Portrait3x4, NanoBananaProResolution::OneK), + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Enqueued job ids: {:?}", response.job_ids()); + println!("Wallet: {:?}", response.wallet); + assert!(!response.job_ids().is_empty()); + Ok(()) + } + + /// Enqueues a Nano Banana Pro job off the desktop app's saved Higgsfield + /// login (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`), + /// prints the enqueue response, then follows the job through the status + /// endpoints until it completes. Cheapest settings (1 image, 1k). + #[tokio::test] + #[ignore] + async fn live_enqueue_nano_banana_pro_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("minting a session token failed: {err}"))?; + + let request = NanoBananaProRequest::text_to_image("a dinosaur on a skateboard", NanoBananaProAspectRatio::Portrait3x4, NanoBananaProResolution::OneK); + println!("\n===== request =====\n{:#?}", request); + + let response = nano_banana_pro(NanoBananaProArgs { + request, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("\n===== POST /fnf/jobs/nano-banana-2 =====\n{:#?}", response); + let job_ids = response.job_ids(); + println!("job ids: {:?}", job_ids); + assert_eq!(job_ids.len(), 1); + assert_eq!(response.first_job_set().unwrap().job_set_type, crate::types::job_set_type::JobSetType::NanoBanana2); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some(), "completed job should have a result url"); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_4p5.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_4p5.rs new file mode 100644 index 00000000..64ff495b --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_4p5.rs @@ -0,0 +1,283 @@ +//! POST `/fnf/jobs/seedream-v4-5` — enqueue a Seedream 4.5 image job (job +//! set type `seedream_v4_5`). NB: not under `/v2/`, unlike the 5.0 models. +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 8 aspect ratios, a 2K / 4K menu sent as `quality` basic / +//! high, 1–4 images. The app always sends `width`/`height` 1024×1024 and an +//! `input_images` list (reference images); the server derives the real size. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_quality::ImageQuality; +use crate::types::image_seed::ImageSeed; +use crate::types::media_input::MediaInput; +use crate::types::seedream_aspect_ratio::SeedreamAspectRatio; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/seedream-v4-5"; + +/// The `model` field the web app sends on this endpoint. +const MODEL: &str = "seedream_v4_5"; + +/// The placeholder size the web app always sends; the server ignores it. +const PLACEHOLDER_WIDTH: u32 = 1024; +const PLACEHOLDER_HEIGHT: u32 = 1024; + +/// The web app's resolution menu for Seedream 4.5. It goes out as the +/// `quality` param. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Seedream4p5Resolution { + /// 2K → `basic` + #[default] + TwoK, + /// 4K → `high` + FourK, +} + +impl Seedream4p5Resolution { + pub fn all() -> [Self; 2] { + [Self::TwoK, Self::FourK] + } + + /// The menu label. + pub fn label(self) -> &'static str { + match self { + Self::TwoK => "2K", + Self::FourK => "4K", + } + } + + /// The `quality` the web app sends for this tier. + pub fn to_image_quality(self) -> ImageQuality { + match self { + Self::TwoK => ImageQuality::Basic, + Self::FourK => ImageQuality::High, + } + } +} + +/// Serializes as the menu label ("2K" / "4K") so a logged request reads +/// the way the user chose it; the wire `quality` is derived at send. +impl Serialize for Seedream4p5Resolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.label()) + } +} + +pub struct Seedream4p5Args<'a> { + pub request: Seedream4p5Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedream 4.5 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Seedream4p5Request { + pub prompt: String, + + pub aspect_ratio: SeedreamAspectRatio, + + pub resolution: Seedream4p5Resolution, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image. Sent as `input_images` (this endpoint + /// predates the role-tagged `medias` list). + /// + /// NB: with a reference the web app sends the reference's pixel size as + /// `width`/`height` instead of the placeholder; the server derives the + /// real output size from `quality` either way, so this client keeps the + /// placeholder. + pub reference_images: Vec, + + /// Pin the generation seed; `None` sends a fresh random one, as the web + /// app does. + pub maybe_seed: Option, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one (this model is offered on it). + pub use_unlim: bool, +} + +impl Seedream4p5Request { + /// A text-to-image request with the web app's defaults (1 image, random + /// seed, credits). + pub fn text_to_image(prompt: impl Into, aspect_ratio: SeedreamAspectRatio, resolution: Seedream4p5Resolution) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + maybe_seed: None, + use_unlim: false, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn to_body(&self) -> Seedream4p5RequestBody { + Seedream4p5RequestBody { + params: Seedream4p5Params { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + quality: self.resolution.to_image_quality(), + batch_size: self.batch_size, + use_unlim: self.use_unlim, + seed: self.maybe_seed.unwrap_or_else(ImageSeed::random), + model: MODEL, + width: PLACEHOLDER_WIDTH, + height: PLACEHOLDER_HEIGHT, + input_images: self.reference_images.clone(), + }, + use_unlim: self.use_unlim, + } + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn seedream_4p5(args: Seedream4p5Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedream4p5RequestBody { + params: Seedream4p5Params, + use_unlim: bool, +} + +#[derive(Serialize)] +struct Seedream4p5Params { + prompt: String, + aspect_ratio: SeedreamAspectRatio, + quality: ImageQuality, + batch_size: ImageBatchSize, + use_unlim: bool, + seed: ImageSeed, + model: &'static str, + width: u32, + height: u32, + input_images: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + /// Captured enqueue response (2K / basic), ids / user scrubbed. NB: no + /// `cluster_hash` on this pipeline. + const ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-0000000020bd","type":"seedream_v4_5","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788154912.273379,"parent_id":null,"cost":100,"params":{"prompt":"a corgi on a bike","batch_size":1,"quality":"basic","aspect_ratio":"3:4","seed":447696,"width":1728,"height":2304,"input_images":[],"use_unlim":false,"reference_elements":[]},"jobs":[{"id":"00000000-0000-0000-0000-000087a44a5a","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788154912.278016,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-000087a44a5a","folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":118750,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + #[test] + fn resolution_menu_maps_to_quality() { + let mapping: Vec<(&str, String)> = Seedream4p5Resolution::all().iter().map(|r| (r.label(), r.to_image_quality().to_string())).collect(); + assert_eq!(mapping.iter().map(|(l, q)| (*l, q.as_str())).collect::>(), [("2K", "basic"), ("4K", "high")]); + } + + #[test] + fn wire_bodies_match_captured_requests() { + let cases = [ + (Seedream4p5Resolution::TwoK, 447696u32, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"basic","batch_size":1,"use_unlim":false,"seed":447696,"model":"seedream_v4_5","width":1024,"height":1024,"input_images":[]},"use_unlim":false}"#), + (Seedream4p5Resolution::FourK, 69127, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"high","batch_size":1,"use_unlim":false,"seed":69127,"model":"seedream_v4_5","width":1024,"height":1024,"input_images":[]},"use_unlim":false}"#), + ]; + for (resolution, seed, expected) in cases { + let mut request = Seedream4p5Request::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, resolution); + request.maybe_seed = Some(ImageSeed::new(seed)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(expected).unwrap(); + assert_eq!(actual, expected, "{}", resolution.label()); + } + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed): bare descriptors + // in `input_images`. The web app sent the reference's 640x640 as + // width/height; this client keeps the placeholder. + let mut request = Seedream4p5Request::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream4p5Resolution::FourK) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + request.maybe_seed = Some(ImageSeed::new(275906)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"high","batch_size":1,"use_unlim":false,"seed":275906,"model":"seedream_v4_5","width":1024,"height":1024,"input_images":[{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn empty_prompt_is_rejected() { + let request = Seedream4p5Request::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream4p5Resolution::TwoK); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Seedream4p5Request::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream4p5Resolution::TwoK); + let err = seedream_4p5(Seedream4p5Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(ENQUEUE_RESPONSE).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::SeedreamV4p5); + assert_eq!(job_set.params.quality, Some(ImageQuality::Basic)); + assert_eq!(job_set.params.seed, Some(ImageSeed::new(447696))); + assert!(job_set.jobs[0].cluster_hash.is_none()); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_seedream_4p5_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedream4p5Request::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream4p5Resolution::TwoK); + println!("\n===== request =====\n{:#?}", request); + + let response = seedream_4p5(Seedream4p5Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + let job_ids = response.job_ids(); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::SeedreamV4p5); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_5p0_lite.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_5p0_lite.rs new file mode 100644 index 00000000..0dfc4ea5 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_5p0_lite.rs @@ -0,0 +1,291 @@ +//! POST `/fnf/jobs/v2/seedream_v5_lite` — enqueue a Seedream 5.0 lite +//! image job (job set type `seedream_v5_lite`). +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 8 aspect ratios, a 2K / 3K / 4K menu that the app sends as +//! `quality` basic / high / ultra, 1–4 images. The app always sends +//! `width`/`height` 1024×1024 with it; the server derives the real size. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_quality::ImageQuality; +use crate::types::image_seed::ImageSeed; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::seedream_aspect_ratio::SeedreamAspectRatio; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/seedream_v5_lite"; + +/// The `model` field the web app sends on this endpoint. +const MODEL: &str = "seedream_v5_lite"; + +/// The placeholder size the web app always sends; the server ignores it. +const PLACEHOLDER_WIDTH: u32 = 1024; +const PLACEHOLDER_HEIGHT: u32 = 1024; + +/// The web app's resolution menu for Seedream 5.0 lite. It goes out as the +/// `quality` param. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Seedream5p0LiteResolution { + /// 2K → `basic` + #[default] + TwoK, + /// 3K → `high` + ThreeK, + /// 4K → `ultra` + FourK, +} + +impl Seedream5p0LiteResolution { + pub fn all() -> [Self; 3] { + [Self::TwoK, Self::ThreeK, Self::FourK] + } + + /// The menu label. + pub fn label(self) -> &'static str { + match self { + Self::TwoK => "2K", + Self::ThreeK => "3K", + Self::FourK => "4K", + } + } + + /// The `quality` the web app sends for this tier. + pub fn to_image_quality(self) -> ImageQuality { + match self { + Self::TwoK => ImageQuality::Basic, + Self::ThreeK => ImageQuality::High, + Self::FourK => ImageQuality::Ultra, + } + } +} + +/// Serializes as the menu label ("2K" / "3K" / "4K") so a logged request +/// reads the way the user chose it; the wire `quality` is derived at send. +impl Serialize for Seedream5p0LiteResolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.label()) + } +} + +pub struct Seedream5p0LiteArgs<'a> { + pub request: Seedream5p0LiteRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedream 5.0 lite request. Serializable so it can +/// be logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Seedream5p0LiteRequest { + pub prompt: String, + + pub aspect_ratio: SeedreamAspectRatio, + + pub resolution: Seedream5p0LiteResolution, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image (then `medias` is omitted, as the web app + /// does). Sent as `medias` with role `image`. + /// + /// NB: with a reference the web app sends the reference's pixel size as + /// `width`/`height` instead of the placeholder; the server derives the + /// real output size from `quality` either way, so this client keeps the + /// placeholder. + pub reference_images: Vec, + + /// Pin the generation seed; `None` sends a fresh random one, as the web + /// app does. + pub maybe_seed: Option, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one (this model is offered on it). + pub use_unlim: bool, +} + +impl Seedream5p0LiteRequest { + /// A text-to-image request with the web app's defaults (1 image, random + /// seed, credits). + pub fn text_to_image(prompt: impl Into, aspect_ratio: SeedreamAspectRatio, resolution: Seedream5p0LiteResolution) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + maybe_seed: None, + use_unlim: false, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn to_body(&self) -> Seedream5p0LiteRequestBody { + Seedream5p0LiteRequestBody { + params: Seedream5p0LiteParams { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + quality: self.resolution.to_image_quality(), + batch_size: self.batch_size, + use_unlim: self.use_unlim, + medias: self.reference_images.iter().cloned().map(MediaReference::image).collect(), + model: MODEL, + width: PLACEHOLDER_WIDTH, + height: PLACEHOLDER_HEIGHT, + seed: self.maybe_seed.unwrap_or_else(ImageSeed::random), + }, + use_unlim: self.use_unlim, + } + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn seedream_5p0_lite(args: Seedream5p0LiteArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedream5p0LiteRequestBody { + params: Seedream5p0LiteParams, + use_unlim: bool, +} + +#[derive(Serialize)] +struct Seedream5p0LiteParams { + prompt: String, + aspect_ratio: SeedreamAspectRatio, + quality: ImageQuality, + batch_size: ImageBatchSize, + use_unlim: bool, + #[serde(skip_serializing_if = "Vec::is_empty")] + medias: Vec, + model: &'static str, + width: u32, + height: u32, + seed: ImageSeed, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + /// Captured enqueue response (2K / basic), ids / user scrubbed. + const ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-000000003940","type":"seedream_v5_lite","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788154819.250387,"parent_id":null,"cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","cost":100,"params":{"prompt":"a corgi on a bike","medias":[],"batch_size":1,"aspect_ratio":"3:4","width":1728,"height":2304,"quality":"basic","seed":12745,"reference_elements":[]},"jobs":[{"id":"00000000-0000-0000-0000-0000f8f09c15","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788154819.252099,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-0000f8f09c15","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":118850,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + #[test] + fn resolution_menu_maps_to_quality() { + let mapping: Vec<(&str, String)> = Seedream5p0LiteResolution::all().iter().map(|r| (r.label(), r.to_image_quality().to_string())).collect(); + assert_eq!(mapping.iter().map(|(l, q)| (*l, q.as_str())).collect::>(), [("2K", "basic"), ("3K", "high"), ("4K", "ultra")]); + } + + #[test] + fn wire_bodies_match_captured_requests() { + // 2K / basic, 3K / high, 4K / ultra — each captured from the web app. + let cases = [ + (Seedream5p0LiteResolution::TwoK, 12745u32, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"basic","batch_size":1,"use_unlim":false,"model":"seedream_v5_lite","width":1024,"height":1024,"seed":12745},"use_unlim":false}"#), + (Seedream5p0LiteResolution::ThreeK, 375239, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"high","batch_size":1,"use_unlim":false,"model":"seedream_v5_lite","width":1024,"height":1024,"seed":375239},"use_unlim":false}"#), + (Seedream5p0LiteResolution::FourK, 98746, r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"ultra","batch_size":1,"use_unlim":false,"model":"seedream_v5_lite","width":1024,"height":1024,"seed":98746},"use_unlim":false}"#), + ]; + for (resolution, seed, expected) in cases { + let mut request = Seedream5p0LiteRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, resolution); + request.maybe_seed = Some(ImageSeed::new(seed)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(expected).unwrap(); + assert_eq!(actual, expected, "{}", resolution.label()); + } + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed). The web app sent + // the reference's 640x640 as width/height; this client keeps the + // placeholder (the server derives the real size from `quality`). + let mut request = Seedream5p0LiteRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream5p0LiteResolution::FourK) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + request.maybe_seed = Some(ImageSeed::new(366541)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","quality":"ultra","batch_size":1,"use_unlim":false,"medias":[{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}],"model":"seedream_v5_lite","width":1024,"height":1024,"seed":366541},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn empty_prompt_is_rejected() { + let request = Seedream5p0LiteRequest::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream5p0LiteResolution::TwoK); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Seedream5p0LiteRequest::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream5p0LiteResolution::TwoK); + let err = seedream_5p0_lite(Seedream5p0LiteArgs { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(ENQUEUE_RESPONSE).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::SeedreamV5Lite); + assert_eq!(job_set.cost, Some(100.0)); + assert_eq!(job_set.params.quality, Some(ImageQuality::Basic)); + // The server ignores the 1024x1024 placeholder and derives the size. + assert_eq!((job_set.params.width, job_set.params.height), (Some(1728), Some(2304))); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_seedream_5p0_lite_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedream5p0LiteRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream5p0LiteResolution::TwoK); + println!("\n===== request =====\n{:#?}", request); + + let response = seedream_5p0_lite(Seedream5p0LiteArgs { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + let job_ids = response.job_ids(); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::SeedreamV5Lite); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_5p0_pro.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_5p0_pro.rs new file mode 100644 index 00000000..67f43509 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/image/seedream_5p0_pro.rs @@ -0,0 +1,266 @@ +//! POST `/fnf/jobs/v2/seedream_v5_pro` — enqueue a Seedream 5.0 Pro image +//! job (job set type `seedream_v5_pro`). +//! +//! Option sets below were read off the web app's image generator on +//! 2026-08-31: 8 aspect ratios, 1K / 1.5K / 2K, 1–4 images. Unlike the Nano +//! Banana endpoints, no width/height is sent — the server derives the size. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::image_seed::ImageSeed; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::seedream_aspect_ratio::SeedreamAspectRatio; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/seedream_v5_pro"; + +/// The resolution tiers the web app offers for Seedream 5.0 Pro. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Seedream5p0ProResolution { + #[default] + OneK, + OnePointFiveK, + TwoK, +} + +impl Seedream5p0ProResolution { + pub fn all() -> [Self; 3] { + [Self::OneK, Self::OnePointFiveK, Self::TwoK] + } + + pub fn as_str(self) -> &'static str { + match self { + Self::OneK => "1k", + Self::OnePointFiveK => "1.5k", + Self::TwoK => "2k", + } + } +} + +impl Serialize for Seedream5p0ProResolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +pub struct Seedream5p0ProArgs<'a> { + pub request: Seedream5p0ProRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedream 5.0 Pro request. Serializable so it can +/// be logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Seedream5p0ProRequest { + pub prompt: String, + + pub aspect_ratio: SeedreamAspectRatio, + + pub resolution: Seedream5p0ProResolution, + + /// How many images to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Reference images (image-to-image), uploaded first via + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`. + /// Empty for text-to-image (then `medias` is omitted, as the web app + /// does). Sent as `medias` with role `image`. + pub reference_images: Vec, + + /// Pin the generation seed; `None` sends a fresh random one, as the web + /// app does. + pub maybe_seed: Option, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, +} + +impl Seedream5p0ProRequest { + /// A text-to-image request with the web app's defaults (1 image, random + /// seed, credits). + pub fn text_to_image(prompt: impl Into, aspect_ratio: SeedreamAspectRatio, resolution: Seedream5p0ProResolution) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + batch_size: ImageBatchSize::One, + reference_images: Vec::new(), + maybe_seed: None, + use_unlim: false, + } + } + + /// Add reference images (image-to-image). + pub fn with_reference_images(mut self, reference_images: Vec) -> Self { + self.reference_images = reference_images; + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + Ok(()) + } + + fn to_body(&self) -> Seedream5p0ProRequestBody { + Seedream5p0ProRequestBody { + params: Seedream5p0ProParams { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + resolution: self.resolution, + batch_size: self.batch_size, + use_unlim: self.use_unlim, + medias: self.reference_images.iter().cloned().map(MediaReference::image).collect(), + seed: self.maybe_seed.unwrap_or_else(ImageSeed::random), + }, + use_unlim: self.use_unlim, + } + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`). +pub async fn seedream_5p0_pro(args: Seedream5p0ProArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedream5p0ProRequestBody { + params: Seedream5p0ProParams, + use_unlim: bool, +} + +#[derive(Serialize)] +struct Seedream5p0ProParams { + prompt: String, + aspect_ratio: SeedreamAspectRatio, + resolution: Seedream5p0ProResolution, + batch_size: ImageBatchSize, + use_unlim: bool, + #[serde(skip_serializing_if = "Vec::is_empty")] + medias: Vec, + seed: ImageSeed, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + /// Captured enqueue response, ids / user scrubbed. + const ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-000000005f0e","type":"seedream_v5_pro","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788154712.937005,"parent_id":null,"cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","cost":150,"params":{"prompt":"a corgi on a bike","medias":[],"batch_size":1,"aspect_ratio":"3:4","width":880,"height":1168,"resolution":"1k","seed":158368,"is_inpaint":false,"remove_bg":false,"reference_elements":[]},"jobs":[{"id":"00000000-0000-0000-0000-0000b78db500","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788154712.944875,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-0000b78db500","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":118950,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec<&str> = Seedream5p0ProResolution::all().iter().map(|r| r.as_str()).collect(); + assert_eq!(wire, ["1k", "1.5k", "2k"]); + } + + #[test] + fn wire_body_matches_captured_request() { + // Captured from the web app: 3:4 at 1k, seed pinned to the captured one. + let mut request = Seedream5p0ProRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream5p0ProResolution::OneK); + request.maybe_seed = Some(ImageSeed::new(158368)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","resolution":"1k","batch_size":1,"use_unlim":false,"seed":158368},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_1p5k_matches_captured_request() { + let mut request = Seedream5p0ProRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream5p0ProResolution::OnePointFiveK); + request.maybe_seed = Some(ImageSeed::new(132934)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","resolution":"1.5k","batch_size":1,"use_unlim":false,"seed":132934},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn unpinned_seed_is_random_and_in_range() { + let request = Seedream5p0ProRequest::text_to_image("p", SeedreamAspectRatio::Square1x1, Seedream5p0ProResolution::OneK); + let body: Value = serde_json::to_value(request.to_body()).unwrap(); + let seed = body["params"]["seed"].as_u64().unwrap(); + assert!(seed < 1_000_000); + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed). + let mut request = Seedream5p0ProRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream5p0ProResolution::OnePointFiveK) + .with_reference_images(vec![MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")]); + request.maybe_seed = Some(ImageSeed::new(192164)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a corgi on a bike","aspect_ratio":"3:4","resolution":"1.5k","batch_size":1,"use_unlim":false,"medias":[{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}],"seed":192164},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn empty_prompt_is_rejected() { + let request = Seedream5p0ProRequest::text_to_image(" ", SeedreamAspectRatio::Square1x1, Seedream5p0ProResolution::OneK); + assert!(matches!(request.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Seedream5p0ProRequest::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream5p0ProResolution::OneK); + let err = seedream_5p0_pro(Seedream5p0ProArgs { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(ENQUEUE_RESPONSE).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::SeedreamV5Pro); + assert_eq!(job_set.cost, Some(150.0)); + assert_eq!(job_set.params.seed, Some(ImageSeed::new(158368))); + assert_eq!((job_set.params.width, job_set.params.height), (Some(880), Some(1168))); + assert_eq!(response.job_ids().len(), 1); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + /// Enqueues off the desktop app's saved Higgsfield login, prints the + /// enqueue response, then follows the job to completion. Cheapest + /// settings (1 image, 1k). + #[tokio::test] + #[ignore] + async fn live_enqueue_seedream_5p0_pro_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedream5p0ProRequest::text_to_image("a corgi on a bike", SeedreamAspectRatio::Portrait3x4, Seedream5p0ProResolution::OneK); + println!("\n===== request =====\n{:#?}", request); + + let response = seedream_5p0_pro(Seedream5p0ProArgs { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + let job_ids = response.job_ids(); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::SeedreamV5Pro); + + let job = poll_job_to_completion(&session, &job_ids[0]).await?; + assert!(job.result_url().is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/live_image_to_video_matrix.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/live_image_to_video_matrix.rs new file mode 100644 index 00000000..2675b33f --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/live_image_to_video_matrix.rs @@ -0,0 +1,326 @@ +//! Live, credit-spending image-to-video matrix over real photos: a +//! character (a red panda), a living room with a Christmas tree, and a +//! 1980s mall sign, run through every Seedance / MiniMax binding in each +//! of the three image-to-video modalities: +//! +//! 1. references — all three photos as role `image`, a prompt that ties +//! them together; +//! 2. start frame — the character as `start_image`, nothing else; +//! 3. keyframes — the character as `start_image`, the mall as `end_image`. +//! +//! Seedance 2.5 Edit is video-to-video: it runs last, editing the Seedance +//! 2.5 start-frame result with the three photos as references. +//! +//! The photos live outside the repo in `external/test_media/` (see its +//! `SOURCES.md`; real photographs only — synthetic test images trip the +//! service's filters). The character defaults to `red_panda.jpg`; set +//! `HIGGSFIELD_I2V_CHARACTER` to another file name in that directory. +//! (Photos of Jim Varney as Ernest were the original character; Higgsfield's +//! IP check flags them as protected content — `ip_detected`, then `404 +//! Media input not found` on enqueue — so they can't be used.) +//! Each job's outcome is appended to +//! `external/test_media/outputs/results.tsv` (`model modality job_id +//! status url`), so the clips can be pulled down afterwards. +//! +//! ```text +//! cargo test -p higgsfield_client live_i2v -- --ignored --nocapture --test-threads=1 +//! ``` + +use crate::endpoints::generate::video::minimax_h3::MinimaxH3Request; +use crate::endpoints::generate::video::seedance_2p0::{Seedance2p0Request, Seedance2p0Resolution}; +use crate::endpoints::generate::video::seedance_2p0_mini::{Seedance2p0MiniRequest, Seedance2p0MiniResolution}; +use crate::endpoints::generate::video::seedance_2p5::{Seedance2p5Request, Seedance2p5Resolution}; +use crate::endpoints::generate::video::seedance_2p5_edit::Seedance2p5EditRequest; +use crate::endpoints::jobs::job_status::JobStatusResponse; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::session::upload_media::ReferenceMediaFile; +use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_session; +use crate::test_utils::poll_job_to_completion::poll_job_to_completion; +use crate::test_utils::setup_test_logging::setup_test_logging; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::media_role::MediaRole; +use crate::types::video_aspect_ratio::SeedanceVideoAspectRatio; +use crate::types::video_duration::VideoDurationSeconds; +use std::fs::{read, read_to_string, OpenOptions}; +use std::io::Write; +use std::path::PathBuf; + +const MEDIA_DIR: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/../../../external/test_media"); + +const PROMPT_REFERENCES: &str = "The red panda from the first image is sitting in the cozy brick living room from the second image, right beside the lit Christmas tree. It bats a red ornament with its paw, then looks straight at the camera; through the window behind it the sunlit 1980s Sarasota Square shopping mall sign and palm trees from the third image are visible."; + +const PROMPT_START_FRAME: &str = "The red panda on the branch turns its head to the camera, yawns wide, stretches, then scampers along the branch and out of frame to the right."; + +const PROMPT_KEYFRAMES: &str = "The red panda hops off the branch and trots to the right; the camera follows it out into bright Florida sunshine and cranes up to reveal the Sarasota Square shopping mall sign standing among tall palm trees."; + +const PROMPT_EDIT: &str = "Keep the red panda exactly as it is, but replace the background with the cozy brick living room and lit Christmas tree from the reference photo, and put the sunlit Sarasota Square mall sign with palm trees outside the window behind it."; + +/// The three uploaded photos. +struct Photos { + character: MediaInput, + tree: MediaInput, + mall: MediaInput, +} + +impl Photos { + fn references(&self) -> [MediaReference; 3] { + [MediaReference::image(self.character.clone()), MediaReference::image(self.tree.clone()), MediaReference::image(self.mall.clone())] + } +} + +fn session() -> anyhow::Result { + setup_test_logging(); + load_higgsfield_test_session() +} + +fn media_path(name: &str) -> PathBuf { + PathBuf::from(MEDIA_DIR).join(name) +} + +/// Upload the photos with the IP check (Seedance insists on it). +async fn upload_photos(session: &HiggsfieldSession) -> anyhow::Result { + let character = std::env::var("HIGGSFIELD_I2V_CHARACTER").unwrap_or_else(|_| "red_panda.jpg".to_string()); + let mut uploaded = Vec::with_capacity(3); + for name in [character.as_str(), "christmas_tree.jpg", "mall_1980s.jpg"] { + let bytes = read(media_path(name)).map_err(|err| anyhow::anyhow!("read {}: {err} (see external/test_media/SOURCES.md)", media_path(name).display()))?; + let input = session.upload_reference_media(ReferenceMediaFile::from_file_name(name, bytes)?.with_ip_check()) + .await.map_err(|err| anyhow::anyhow!("{name}: {err}"))?; + println!("uploaded {name} => {} {}", input.id, input.url); + uploaded.push(input); + } + let mall = uploaded.pop().unwrap(); + let tree = uploaded.pop().unwrap(); + let character = uploaded.pop().unwrap(); + Ok(Photos { character, tree, mall }) +} + +/// Seedance's catch-all failure. Seen on jobs that succeeded verbatim a +/// few minutes later, so it's treated as transient. +const GENERIC_FAILURE: &str = "Something went wrong"; + +type EnqueueFuture<'a> = std::pin::Pin> + Send + 'a>>; + +/// Enqueue, follow the job, check the echoed roles, and record the outcome. +/// On the generic model-stage failure the session token is refreshed and +/// the same request enqueued once more (credits for failed jobs are +/// refunded), and both attempts are recorded — so the log shows whether a +/// fresh session is what fixes it. +async fn run(session: &HiggsfieldSession, model: &str, modality: &str, expected_roles: &[MediaRole], enqueue: F) -> anyhow::Result +where + F: for<'a> Fn(&'a HiggsfieldSession) -> EnqueueFuture<'a>, +{ + for attempt in 1..=2 { + let response = enqueue(session).await.map_err(|err| anyhow::anyhow!("{err}"))?; + let job_set = response.first_job_set().ok_or_else(|| anyhow::anyhow!("no job set"))?; + let echoed: Vec = job_set.params.medias.iter().map(|m| m.role.clone()).collect(); + println!( + "\n##### {model} / {modality} (attempt {attempt}): job set {} cost={:?} server size={:?}x{:?} aspect={:?} medias={:?}", + job_set.id, job_set.cost, job_set.params.width, job_set.params.height, job_set.params.aspect_ratio, echoed, + ); + assert_eq!(echoed, expected_roles, "server should echo the reference roles"); + + let job_id = response.job_ids().into_iter().next().ok_or_else(|| anyhow::anyhow!("no job"))?; + match poll_job_to_completion(session, &job_id).await { + Ok(job) => { + record(model, modality, job_id.as_str(), &format!("completed (attempt {attempt})"), job.result_url().unwrap_or("")); + return Ok(job); + } + Err(err) => { + let reason = err.to_string().replace(['\t', '\n'], " "); + record(model, modality, job_id.as_str(), &format!("failed (attempt {attempt})"), &reason); + if attempt == 1 && reason.contains(GENERIC_FAILURE) { + let token = session.refresh().await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("##### {model} / {modality}: generic failure; refreshed session token (expires {}) and retrying once", token.expires_at()); + continue; + } + return Err(err); + } + } + } + unreachable!("the loop returns on the second attempt") +} + +fn record(model: &str, modality: &str, job_id: &str, status: &str, url: &str) { + let path = media_path("outputs/results.tsv"); + if let Ok(mut file) = OpenOptions::new().create(true).append(true).open(&path) { + let _ = writeln!(file, "{model}\t{modality}\t{job_id}\t{status}\t{url}"); + } +} + +/// The Seedance 2.5 start-frame clip, as recorded by an earlier test in +/// this file, for the edit test to work on. +fn recorded_edit_source() -> anyhow::Result { + let tsv = read_to_string(media_path("outputs/results.tsv"))?; + for line in tsv.lines().rev() { + let fields: Vec<&str> = line.split('\t').collect(); + if fields.len() == 5 && fields[0] == "seedance_2p5" && fields[1] == "start_frame" && fields[3].starts_with("completed") { + return Ok(MediaInput::from_video_job(fields[2], fields[4])); + } + } + anyhow::bail!("no completed seedance_2p5 start_frame job in outputs/results.tsv; run live_i2v_seedance_2p5_2_start_frame first") +} + +const FOUR_SECONDS: VideoDurationSeconds = VideoDurationSeconds::new(4); +const FIVE_SECONDS: VideoDurationSeconds = VideoDurationSeconds::new(5); + +// ── Seedance 2.5 ── + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p5_1_references() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let mut request = Seedance2p5Request::text_to_video(PROMPT_REFERENCES, SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, FOUR_SECONDS); + request.medias = photos.references().to_vec(); + run(&session, "seedance_2p5", "references", &[MediaRole::Image, MediaRole::Image, MediaRole::Image], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p5(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p5_2_start_frame() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = Seedance2p5Request::text_to_video(PROMPT_START_FRAME, SeedanceVideoAspectRatio::Landscape4x3, Seedance2p5Resolution::P480, FOUR_SECONDS) + .with_media(MediaReference::start_frame(photos.character)); + run(&session, "seedance_2p5", "start_frame", &[MediaRole::StartImage], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p5(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p5_3_keyframes() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = Seedance2p5Request::text_to_video(PROMPT_KEYFRAMES, SeedanceVideoAspectRatio::Landscape4x3, Seedance2p5Resolution::P480, FOUR_SECONDS) + .with_media(MediaReference::start_frame(photos.character)) + .with_media(MediaReference::end_frame(photos.mall)); + run(&session, "seedance_2p5", "keyframes", &[MediaRole::StartImage, MediaRole::EndImage], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p5(request).await }) }).await?; + Ok(()) +} + +// ── Seedance 2.0 ── + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p0_1_references() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let mut request = Seedance2p0Request::text_to_video(PROMPT_REFERENCES, SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, FOUR_SECONDS); + request.medias = photos.references().to_vec(); + run(&session, "seedance_2p0", "references", &[MediaRole::Image, MediaRole::Image, MediaRole::Image], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p0(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p0_2_start_frame() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = Seedance2p0Request::text_to_video(PROMPT_START_FRAME, SeedanceVideoAspectRatio::Landscape4x3, Seedance2p0Resolution::P480, FOUR_SECONDS) + .with_media(MediaReference::start_frame(photos.character)); + run(&session, "seedance_2p0", "start_frame", &[MediaRole::StartImage], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p0(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p0_3_keyframes() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = Seedance2p0Request::text_to_video(PROMPT_KEYFRAMES, SeedanceVideoAspectRatio::Landscape4x3, Seedance2p0Resolution::P480, FOUR_SECONDS) + .with_media(MediaReference::start_frame(photos.character)) + .with_media(MediaReference::end_frame(photos.mall)); + run(&session, "seedance_2p0", "keyframes", &[MediaRole::StartImage, MediaRole::EndImage], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p0(request).await }) }).await?; + Ok(()) +} + +// ── Seedance 2.0 Mini ── + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p0_mini_1_references() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let mut request = Seedance2p0MiniRequest::text_to_video(PROMPT_REFERENCES, SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0MiniResolution::P480, FOUR_SECONDS); + request.medias = photos.references().to_vec(); + run(&session, "seedance_2p0_mini", "references", &[MediaRole::Image, MediaRole::Image, MediaRole::Image], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p0_mini(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p0_mini_2_start_frame() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = Seedance2p0MiniRequest::text_to_video(PROMPT_START_FRAME, SeedanceVideoAspectRatio::Landscape4x3, Seedance2p0MiniResolution::P480, FOUR_SECONDS) + .with_media(MediaReference::start_frame(photos.character)); + run(&session, "seedance_2p0_mini", "start_frame", &[MediaRole::StartImage], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p0_mini(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_seedance_2p0_mini_3_keyframes() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = Seedance2p0MiniRequest::text_to_video(PROMPT_KEYFRAMES, SeedanceVideoAspectRatio::Landscape4x3, Seedance2p0MiniResolution::P480, FOUR_SECONDS) + .with_media(MediaReference::start_frame(photos.character)) + .with_media(MediaReference::end_frame(photos.mall)); + run(&session, "seedance_2p0_mini", "keyframes", &[MediaRole::StartImage, MediaRole::EndImage], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p0_mini(request).await }) }).await?; + Ok(()) +} + +// ── MiniMax H3 ── + +#[tokio::test] +#[ignore] +async fn live_i2v_minimax_h3_1_references() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let mut request = MinimaxH3Request::text_to_video(PROMPT_REFERENCES, FIVE_SECONDS); + request.medias = photos.references().to_vec(); + run(&session, "minimax_h3", "references", &[MediaRole::Image, MediaRole::Image, MediaRole::Image], |session| { let request = request.clone(); Box::pin(async move { session.minimax_h3(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_minimax_h3_2_start_frame() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = MinimaxH3Request::text_to_video(PROMPT_START_FRAME, FIVE_SECONDS) + .with_media(MediaReference::start_frame(photos.character)); + run(&session, "minimax_h3", "start_frame", &[MediaRole::StartImage], |session| { let request = request.clone(); Box::pin(async move { session.minimax_h3(request).await }) }).await?; + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_i2v_minimax_h3_3_keyframes() -> anyhow::Result<()> { + let session = session()?; + let photos = upload_photos(&session).await?; + let request = MinimaxH3Request::text_to_video(PROMPT_KEYFRAMES, FIVE_SECONDS) + .with_media(MediaReference::start_frame(photos.character)) + .with_media(MediaReference::end_frame(photos.mall)); + run(&session, "minimax_h3", "keyframes", &[MediaRole::StartImage, MediaRole::EndImage], |session| { let request = request.clone(); Box::pin(async move { session.minimax_h3(request).await }) }).await?; + Ok(()) +} + +// ── Seedance 2.5 Edit (video-to-video; runs last) ── + +#[tokio::test] +#[ignore] +async fn live_i2v_z_seedance_2p5_edit_references() -> anyhow::Result<()> { + let session = session()?; + let source = recorded_edit_source()?; + println!("editing {} ({})", source.id, source.url); + let photos = upload_photos(&session).await?; + let mut request = Seedance2p5EditRequest::new(PROMPT_EDIT, source, Seedance2p5Resolution::P480); + request.references = photos.references().to_vec(); + run(&session, "seedance_2p5_edit", "references", &[MediaRole::Video, MediaRole::Image, MediaRole::Image, MediaRole::Image], |session| { let request = request.clone(); Box::pin(async move { session.seedance_2p5_edit(request).await }) }).await?; + Ok(()) +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/live_reference_media.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/live_reference_media.rs new file mode 100644 index 00000000..c033dbc2 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/live_reference_media.rs @@ -0,0 +1,343 @@ +//! Live, credit-spending tests for reference media: upload the fixtures in +//! `test_assets/` through [`HiggsfieldSession`], then feed them to the +//! bindings as reference images, start / end frames, and (upload only) +//! video and audio. Each job is followed through the status endpoints and +//! its echoed `params.medias` / `params.input_images` checked. +//! +//! ```text +//! cargo test -p higgsfield_client live_reference -- --ignored --nocapture --test-threads=1 +//! ``` +//! +//! Cheapest settings throughout; the upload-only test is free. + +use crate::endpoints::generate::image::gpt_image_2::{GptImage2AspectRatio, GptImage2Quality, GptImage2Request, GptImage2Resolution}; +use crate::endpoints::generate::image::nano_banana_2::{NanoBanana2Request, NanoBanana2Resolution}; +use crate::endpoints::generate::image::nano_banana_2_lite::{NanoBanana2LiteQuality, NanoBanana2LiteRequest}; +use crate::endpoints::generate::image::nano_banana_pro::{NanoBananaProRequest, NanoBananaProResolution}; +use crate::endpoints::generate::image::seedream_4p5::{Seedream4p5Request, Seedream4p5Resolution}; +use crate::endpoints::generate::image::seedream_5p0_lite::{Seedream5p0LiteRequest, Seedream5p0LiteResolution}; +use crate::endpoints::generate::image::seedream_5p0_pro::{Seedream5p0ProRequest, Seedream5p0ProResolution}; +use crate::endpoints::generate::video::grok_imagine_1p5::{GrokImagine1p5Request, GrokImagine1p5Resolution}; +use crate::endpoints::generate::video::kling_3p0::{Kling3p0Request, Kling3p0Resolution}; +use crate::endpoints::generate::video::minimax_h3::MinimaxH3Request; +use crate::endpoints::generate::video::seedance_2p0::{Seedance2p0Request, Seedance2p0Resolution}; +use crate::endpoints::generate::video::seedance_2p0_mini::{Seedance2p0MiniRequest, Seedance2p0MiniResolution}; +use crate::endpoints::generate::video::seedance_2p5::{Seedance2p5Request, Seedance2p5Resolution}; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::session::upload_media::ReferenceMediaFile; +use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_session; +use crate::test_utils::poll_job_to_completion::poll_jobs_to_completion; +use crate::test_utils::setup_test_logging::setup_test_logging; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::job_set_type::JobSetType; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::session::wait_for_job::WaitForJobOptions; +use crate::types::media_input::{MediaInput, MediaInputKind}; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::media_reference::MediaReference; +use crate::types::media_role::MediaRole; +use crate::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; +use crate::types::seedream_aspect_ratio::SeedreamAspectRatio; +use crate::types::video_aspect_ratio::{KlingAspectRatio, SeedanceVideoAspectRatio}; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::VideoDurationSeconds; + +/// 640x640 PNG: teal background, orange disc. Over GPT Image 2's 300px +/// minimum. +const REFERENCE_PNG: &[u8] = include_bytes!("../../../test_assets/reference_640.png"); + +/// 4s, 8kHz mono 440Hz tone with a slow tremolo. (A 1s tone was rejected +/// by Seedance: "Input audio duration is not supported".) +const TONE_WAV: &[u8] = include_bytes!("../../../test_assets/tone_4s.wav"); + +/// 4s, 256x256 H.264 clip: an orange square sliding over teal. +const CLIP_MP4: &[u8] = include_bytes!("../../../test_assets/clip_4s.mp4"); + +const PROMPT_IMAGE: &str = "the orange disc from the reference, but as a shiba inu's face, flat vector style"; +const PROMPT_VIDEO: &str = "the orange disc rolls off screen to the right"; + +fn session() -> anyhow::Result { + setup_test_logging(); + load_higgsfield_test_session() +} + +async fn upload_png(session: &HiggsfieldSession, name: &str) -> anyhow::Result { + let input = session.upload_reference_media(ReferenceMediaFile::new(name, MediaMimeType::ImagePng, REFERENCE_PNG.to_vec())) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("uploaded {name} => id={} url={}", input.id, input.url); + Ok(input) +} + +/// Seedance refuses media whose IP check hasn't run; upload with it. +async fn upload_png_ip_checked(session: &HiggsfieldSession, name: &str) -> anyhow::Result { + let input = session.upload_reference_media(ReferenceMediaFile::new(name, MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()).with_ip_check()) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("uploaded {name} (IP checked) => id={} url={}", input.id, input.url); + Ok(input) +} + +/// Follow the job(s) and check the server echoed our references back. +async fn follow(session: &HiggsfieldSession, label: &str, expected_type: JobSetType, expected_roles: &[MediaRole], expected_input_images: usize, response: EnqueueJobsResponse) -> anyhow::Result<()> { + let job_set = response.first_job_set().ok_or_else(|| anyhow::anyhow!("no job set"))?; + println!( + "\n##### {label}: enqueued job set {} type={} cost={:?} medias={:?} input_images={}", + job_set.id, job_set.job_set_type, job_set.cost, + job_set.params.medias.iter().map(|m| m.role.as_str()).collect::>(), job_set.params.input_images.len(), + ); + assert_eq!(job_set.job_set_type, expected_type); + let echoed_roles: Vec = job_set.params.medias.iter().map(|m| m.role.clone()).collect(); + assert_eq!(echoed_roles, expected_roles, "server should echo the reference roles"); + assert_eq!(job_set.params.input_images.len(), expected_input_images); + + let jobs = poll_jobs_to_completion(session, &response.job_ids()).await?; + for job in &jobs { + assert!(job.result_url().is_some(), "job {} has no result url", job.id); + assert_eq!(job.params.medias.len(), expected_roles.len()); + assert_eq!(job.params.input_images.len(), expected_input_images); + } + println!("##### {label}: done ({} job(s))", jobs.len()); + Ok(()) +} + +// ── Upload only (free) ── + +#[tokio::test] +#[ignore] +async fn live_reference_upload_png_single_and_batch_with_video_and_audio() -> anyhow::Result<()> { + let session = session()?; + + let single = upload_png(&session, "reference_640.png").await?; + assert!(single.url.ends_with(".png")); + + let batch = session.upload_reference_media_batch(vec![ + ReferenceMediaFile::new("start_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()), + ReferenceMediaFile::new("end_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()), + ]).await.map_err(|err| anyhow::anyhow!("{err}"))?; + for input in &batch { + println!("batch uploaded => id={} url={}", input.id, input.url); + } + assert_eq!(batch.len(), 2); + assert!(batch.iter().all(|input| input.url.ends_with(".png"))); + + // Video and audio go through the single-file presign. + let clip = session.upload_reference_media(ReferenceMediaFile::new("clip_4s.mp4", MediaMimeType::VideoMp4, CLIP_MP4.to_vec())) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("uploaded clip_1s.mp4 => id={} url={}", clip.id, clip.url); + assert!(clip.url.ends_with(".mp4")); + + let tone = session.upload_reference_media(ReferenceMediaFile::new("tone_4s.wav", MediaMimeType::AudioWav, TONE_WAV.to_vec())) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("uploaded tone_1s.wav => id={} url={}", tone.id, tone.url); + assert!(tone.url.ends_with(".wav")); + Ok(()) +} + +// ── Image models ── + +#[tokio::test] +#[ignore] +async fn live_reference_nano_banana_2_lite_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = NanoBanana2LiteRequest::text_to_image(PROMPT_IMAGE, NanoBananaAspectRatio::Square1x1, NanoBanana2LiteQuality::Minimal) + .with_reference_images(vec![reference]); + let response = session.nano_banana_2_lite(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Nano Banana 2 Lite + reference", JobSetType::NanoBanana2Lite, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_nano_banana_2_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = NanoBanana2Request::text_to_image(PROMPT_IMAGE, NanoBananaAspectRatio::Square1x1, NanoBanana2Resolution::OneK) + .with_reference_images(vec![reference]); + let response = session.nano_banana_2(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Nano Banana 2 + reference", JobSetType::NanoBananaFlash, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_nano_banana_pro_input_image() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = NanoBananaProRequest::text_to_image(PROMPT_IMAGE, NanoBananaAspectRatio::Square1x1, NanoBananaProResolution::OneK) + .with_reference_images(vec![reference]); + let response = session.nano_banana_pro(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Nano Banana Pro + input image", JobSetType::NanoBanana2, &[], 1, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_gpt_image_2_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = GptImage2Request::text_to_image(PROMPT_IMAGE, GptImage2AspectRatio::Auto, GptImage2Quality::Low, GptImage2Resolution::OneK) + .with_reference_images(vec![reference]); + let response = session.gpt_image_2(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "GPT Image 2 + reference", JobSetType::GptImage2, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedream_5p0_pro_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = Seedream5p0ProRequest::text_to_image(PROMPT_IMAGE, SeedreamAspectRatio::Square1x1, Seedream5p0ProResolution::OneK) + .with_reference_images(vec![reference]); + let response = session.seedream_5p0_pro(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedream 5.0 Pro + reference", JobSetType::SeedreamV5Pro, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedream_5p0_lite_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = Seedream5p0LiteRequest::text_to_image(PROMPT_IMAGE, SeedreamAspectRatio::Square1x1, Seedream5p0LiteResolution::TwoK) + .with_reference_images(vec![reference]); + let response = session.seedream_5p0_lite(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedream 5.0 lite + reference", JobSetType::SeedreamV5Lite, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedream_4p5_input_image() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png(&session, "reference_640.png").await?; + let request = Seedream4p5Request::text_to_image(PROMPT_IMAGE, SeedreamAspectRatio::Square1x1, Seedream4p5Resolution::TwoK) + .with_reference_images(vec![reference]); + let response = session.seedream_4p5(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedream 4.5 + input image", JobSetType::SeedreamV4p5, &[], 1, response).await +} + +// ── Video models ── + +#[tokio::test] +#[ignore] +async fn live_reference_grok_imagine_1p5_start_frame() -> anyhow::Result<()> { + let session = session()?; + let frame = upload_png(&session, "start_frame.png").await?; + let request = GrokImagine1p5Request::text_to_video(PROMPT_VIDEO, GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(1)) + .with_media(MediaReference::start_frame(frame)); + let response = session.grok_imagine_1p5(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Grok Imagine 1.5 + start frame", JobSetType::GrokVideoV15, &[MediaRole::StartImage], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedance_2p0_mini_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png_ip_checked(&session, "reference_640.png").await?; + let request = Seedance2p0MiniRequest::text_to_video(PROMPT_VIDEO, SeedanceVideoAspectRatio::Square1x1, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::image(reference)); + let response = session.seedance_2p0_mini(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedance 2.0 Mini + reference image", JobSetType::Seedance2p0Mini, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedance_2p0_mini_start_and_end_frames() -> anyhow::Result<()> { + let session = session()?; + let frames = session.upload_reference_media_batch(vec![ + ReferenceMediaFile::new("start_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()).with_ip_check(), + ReferenceMediaFile::new("end_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()).with_ip_check(), + ]).await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedance2p0MiniRequest::text_to_video(PROMPT_VIDEO, SeedanceVideoAspectRatio::Square1x1, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::start_frame(frames[0].clone())) + .with_media(MediaReference::end_frame(frames[1].clone())); + let response = session.seedance_2p0_mini(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedance 2.0 Mini + frames", JobSetType::Seedance2p0Mini, &[MediaRole::StartImage, MediaRole::EndImage], 0, response).await +} + +/// Video + audio references (roles from the web app's bundle, not a +/// browser capture): the cheapest model that takes them. +/// +/// The wire contract is what this asserts: the enqueue is accepted with +/// `video_input` / `audio_input` descriptors and the roles are echoed. The +/// job itself has failed at the model stage on the synthetic fixtures +/// (2026-08-31: "Input audio duration is not supported" for a 1s tone, +/// then a generic "change your input files" for the 4s clip + tone), so +/// a model-stage failure is reported, not treated as a client bug. Swap +/// in real footage / a real track to see it complete. +#[tokio::test] +#[ignore] +async fn live_reference_seedance_2p0_mini_video_and_audio_refs() -> anyhow::Result<()> { + let session = session()?; + let clip = session.upload_reference_media(ReferenceMediaFile::new("clip_4s.mp4", MediaMimeType::VideoMp4, CLIP_MP4.to_vec()).with_ip_check()) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + let tone = session.upload_reference_media(ReferenceMediaFile::new("tone_4s.wav", MediaMimeType::AudioWav, TONE_WAV.to_vec()).with_ip_check()) + .await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedance2p0MiniRequest::text_to_video(PROMPT_VIDEO, SeedanceVideoAspectRatio::Square1x1, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::video(clip)) + .with_media(MediaReference::audio(tone)); + let response = session.seedance_2p0_mini(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + let job_set = response.first_job_set().ok_or_else(|| anyhow::anyhow!("no job set"))?; + let echoed: Vec<(MediaRole, MediaInputKind)> = job_set.params.medias.iter().map(|m| (m.role.clone(), m.data.kind.clone())).collect(); + println!("\n##### Seedance 2.0 Mini + video + audio: enqueued job set {} cost={:?} medias={:?}", job_set.id, job_set.cost, echoed); + assert_eq!(echoed, vec![(MediaRole::Video, MediaInputKind::VideoInput), (MediaRole::Audio, MediaInputKind::AudioInput)]); + + let job_id = response.job_ids().into_iter().next().unwrap(); + match session.wait_for_job(&job_id, WaitForJobOptions::default()).await { + Ok(job) => println!("##### completed: {:?}", job.result_url()), + Err(HiggsfieldError::Client(HiggsfieldClientError::JobFailed { maybe_reason: Some(reason), .. })) => + println!("##### model-stage failure on the synthetic fixtures (not a wire problem): {reason}"), + Err(err) => return Err(anyhow::anyhow!("{err}")), + } + Ok(()) +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedance_2p0_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png_ip_checked(&session, "reference_640.png").await?; + let request = Seedance2p0Request::text_to_video(PROMPT_VIDEO, SeedanceVideoAspectRatio::Square1x1, Seedance2p0Resolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::image(reference)); + let response = session.seedance_2p0(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedance 2.0 + reference image", JobSetType::Seedance2p0, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_seedance_2p5_image_ref() -> anyhow::Result<()> { + let session = session()?; + let reference = upload_png_ip_checked(&session, "reference_640.png").await?; + let request = Seedance2p5Request::text_to_video(PROMPT_VIDEO, SeedanceVideoAspectRatio::Square1x1, Seedance2p5Resolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::image(reference)); + let response = session.seedance_2p5(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Seedance 2.5 + reference image", JobSetType::Seedance2p5, &[MediaRole::Image], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_kling_3p0_start_and_end_frames() -> anyhow::Result<()> { + let session = session()?; + let frames = session.upload_reference_media_batch(vec![ + ReferenceMediaFile::new("start_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()), + ReferenceMediaFile::new("end_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()), + ]).await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Kling3p0Request::text_to_video(PROMPT_VIDEO, KlingAspectRatio::Square1x1, Kling3p0Resolution::P720, VideoDurationSeconds::new(3)) + .with_media(MediaReference::start_frame(frames[0].clone())) + .with_media(MediaReference::end_frame(frames[1].clone())); + let response = session.kling_3p0(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "Kling 3.0 + frames", JobSetType::Kling3p0, &[MediaRole::StartImage, MediaRole::EndImage], 0, response).await +} + +#[tokio::test] +#[ignore] +async fn live_reference_minimax_h3_start_and_end_frames() -> anyhow::Result<()> { + let session = session()?; + let frames = session.upload_reference_media_batch(vec![ + ReferenceMediaFile::new("start_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()), + ReferenceMediaFile::new("end_frame.png", MediaMimeType::ImagePng, REFERENCE_PNG.to_vec()), + ]).await.map_err(|err| anyhow::anyhow!("{err}"))?; + let mut request = MinimaxH3Request::text_to_video(PROMPT_VIDEO, VideoDurationSeconds::new(5)) + .with_media(MediaReference::start_frame(frames[0].clone())) + .with_media(MediaReference::end_frame(frames[1].clone())); + // Square frames: the web app sends a square 2K canvas. + request.maybe_dimensions = Some(VideoDimensions::new(2048, 2048)); + let response = session.minimax_h3(request).await.map_err(|err| anyhow::anyhow!("{err}"))?; + follow(&session, "MiniMax H3 + frames", JobSetType::MinimaxH3, &[MediaRole::StartImage, MediaRole::EndImage], 0, response).await +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/mod.rs new file mode 100644 index 00000000..fba82d0d --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/mod.rs @@ -0,0 +1,8 @@ +pub mod image; +pub mod video; + +#[cfg(test)] +mod live_reference_media; + +#[cfg(test)] +mod live_image_to_video_matrix; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/grok_imagine_1p5.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/grok_imagine_1p5.rs new file mode 100644 index 00000000..af172c58 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/grok_imagine_1p5.rs @@ -0,0 +1,267 @@ +//! POST `/fnf/jobs/v2/grok_video_v15` — enqueue a Grok Imagine 1.5 video job +//! (job set type `grok_video_v15`). +//! +//! Options read off the web app on 2026-08-31: duration 1–15 s, 480p / +//! 720p / 1080p; aspect is locked to Auto for text-to-video (it follows the +//! start frame otherwise); optional start frame and references. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use crate::types::video_resolution::VideoResolution; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/grok_video_v15"; + +/// The resolution tiers the web app offers for Grok Imagine 1.5. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum GrokImagine1p5Resolution { + #[default] + P480, + P720, + P1080, +} + +impl GrokImagine1p5Resolution { + pub fn all() -> [Self; 3] { + [Self::P480, Self::P720, Self::P1080] + } + + pub fn to_video_resolution(self) -> VideoResolution { + match self { + Self::P480 => VideoResolution::P480, + Self::P720 => VideoResolution::P720, + Self::P1080 => VideoResolution::P1080, + } + } +} + +impl Serialize for GrokImagine1p5Resolution { + fn serialize(&self, serializer: S) -> Result { + self.to_video_resolution().serialize(serializer) + } +} + +pub struct GrokImagine1p5Args<'a> { + pub request: GrokImagine1p5Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Grok Imagine 1.5 request. Serializable so it can +/// be logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct GrokImagine1p5Request { + pub prompt: String, + + pub resolution: GrokImagine1p5Resolution, + + /// Clip length; see [`Self::DURATION`]. + pub duration: VideoDurationSeconds, + + /// Reference media (frames, reference images / clips / audio), uploaded + /// first via `endpoints::media` / `HiggsfieldSession::upload_reference_media` + /// and tagged with a role. The web app offers a start frame OR up to 7 reference images (role `image`). Roles this + /// model takes: [`Self::MEDIA_ROLES`]. Empty for text-to-video. + pub medias: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, the 16:9 + /// frame for `resolution` the web app sends. + pub maybe_dimensions: Option, +} + +impl GrokImagine1p5Request { + /// The web app's duration slider range. + pub const DURATION: VideoDurationRange = VideoDurationRange::new(1, 15); + + /// The media roles this model accepts. + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::StartImage, MediaRole::Image]; + + /// A text-to-video request with the web app's defaults (credits). + pub fn text_to_video(prompt: impl Into, resolution: GrokImagine1p5Resolution, duration: VideoDurationSeconds) -> Self { + Self { + prompt: prompt.into(), + resolution, + duration, + medias: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + validate_media_roles(&self.medias, Self::MEDIA_ROLES, "Grok Imagine 1.5")?; + Self::DURATION.validate(self.duration) + } + + /// Add one reference (see [`MediaReference`]'s constructors: + /// `start_frame`, `end_frame`, `image`, `video`, `audio`). + pub fn with_media(mut self, reference: MediaReference) -> Self { + self.medias.push(reference); + self + } + + fn to_body(&self) -> GrokImagine1p5RequestBody { + let dimensions = self.maybe_dimensions + .or_else(|| VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Auto, &self.resolution.to_video_resolution())) + .expect("auto dimensions are derivable for every known resolution"); + GrokImagine1p5RequestBody { + params: GrokImagine1p5Params { + prompt: self.prompt.clone(), + resolution: self.resolution, + aspect_ratio: ImageAspectRatio::Auto, + width: dimensions.width, + height: dimensions.height, + duration: self.duration, + medias: self.medias.clone(), + }, + use_unlim: self.use_unlim, + } + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn grok_imagine_1p5(args: GrokImagine1p5Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct GrokImagine1p5RequestBody { + params: GrokImagine1p5Params, + use_unlim: bool, +} + +#[derive(Serialize)] +struct GrokImagine1p5Params { + prompt: String, + resolution: GrokImagine1p5Resolution, + aspect_ratio: ImageAspectRatio, + width: u32, + height: u32, + duration: VideoDurationSeconds, + medias: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::endpoints::generate::video::test_fixtures::enqueue_response; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + const SERVER_PARAMS: &str = r#"{"width":854,"height":480,"prompt":"a shiba inu skateboarding down a hill","medias":[],"duration":1,"resolution":"480p","aspect_ratio":"auto"}"#; + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec = GrokImagine1p5Resolution::all().iter().map(|r| r.to_video_resolution().to_string()).collect(); + assert_eq!(wire, ["480p", "720p", "1080p"]); + assert_eq!(GrokImagine1p5Request::DURATION, VideoDurationRange::new(1, 15)); + } + + #[test] + fn wire_body_matches_captured_request() { + let request = GrokImagine1p5Request::text_to_video("a shiba inu skateboarding down a hill", GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(1)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","resolution":"480p","aspect_ratio":"auto","width":854,"height":480,"duration":1,"medias":[]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_with_start_frame_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed). The web app also + // sends `ipCheckFinished` / `ipStatus` inside `data`; the server drops + // them, so they're not part of the expected body. + let request = GrokImagine1p5Request::text_to_video("a shiba inu skateboarding down a hill", GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(1)) + .with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","resolution":"480p","aspect_ratio":"auto","width":854,"height":480,"duration":1,"medias":[{"role":"start_image","data":{"id":"00000000-0000-4000-8000-0000000000b1","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"}}]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_with_reference_image_matches_captured_request() { + let request = GrokImagine1p5Request::text_to_video("a shiba inu skateboarding down a hill", GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(1)) + .with_media(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","resolution":"480p","aspect_ratio":"auto","width":854,"height":480,"duration":1,"medias":[{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn media_roles() { + assert_eq!(GrokImagine1p5Request::MEDIA_ROLES, &[MediaRole::StartImage, MediaRole::Image]); + let base = || GrokImagine1p5Request::text_to_video("p", GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(1)); + assert!(base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))).validate().is_ok()); + let end = base().with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + assert!(matches!(end.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let two_starts = base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + assert!(matches!(two_starts.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + let bad = GrokImagine1p5Request::text_to_video("p", GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(0)); + assert!(matches!(bad.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = GrokImagine1p5Request::text_to_video("", GrokImagine1p5Resolution::P480, VideoDurationSeconds::new(1)); + let err = grok_imagine_1p5(GrokImagine1p5Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(&enqueue_response("grok_video_v15", 250, SERVER_PARAMS, true)).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::GrokVideoV15); + assert_eq!(job_set.cost, Some(250.0)); + assert_eq!(job_set.params.duration, Some(1)); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_grok_imagine_1p5_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = GrokImagine1p5Request::text_to_video("a shiba inu winning a bicycle race", GrokImagine1p5Resolution::P480, GrokImagine1p5Request::DURATION.shortest()); + println!("\n===== request =====\n{:#?}", request); + let response = grok_imagine_1p5(GrokImagine1p5Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::GrokVideoV15); + let job = poll_job_to_completion(&session, &response.job_ids()[0]).await?; + assert!(job.result_url().unwrap().ends_with(".mp4")); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/kling_3p0.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/kling_3p0.rs new file mode 100644 index 00000000..770e1850 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/kling_3p0.rs @@ -0,0 +1,323 @@ +//! POST `/fnf/jobs/v2/kling3_0` — enqueue a Kling 3.0 video job (job set +//! type `kling3_0`). +//! +//! Options read off the web app on 2026-08-31: duration 3–15 s, aspect +//! 16:9 / 9:16 / 1:1, a 720p / 1080p / 4K menu the app sends as `mode` +//! `std` / `pro` / `4k`, prompt enhancement, sound on/off, Kling elements, +//! multi-shot, optional start / end frames. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::video_aspect_ratio::KlingAspectRatio; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use crate::types::video_mode::VideoMode; +use crate::types::video_resolution::VideoResolution; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/kling3_0"; + +/// The web app's resolution menu for Kling 3.0. It goes out as the `mode` +/// param (from the app's bundle: `4k` → 4K, `pro` → 1080p, else 720p). +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Kling3p0Resolution { + /// 720p → `std` + #[default] + P720, + /// 1080p → `pro` + P1080, + /// 4K → `4k` + FourK, +} + +impl Kling3p0Resolution { + pub fn all() -> [Self; 3] { + [Self::P720, Self::P1080, Self::FourK] + } + + pub fn label(self) -> &'static str { + match self { + Self::P720 => "720p", + Self::P1080 => "1080p", + Self::FourK => "4K", + } + } + + pub fn to_video_mode(self) -> VideoMode { + match self { + Self::P720 => VideoMode::Std, + Self::P1080 => VideoMode::Pro, + Self::FourK => VideoMode::FourK, + } + } + + fn to_video_resolution(self) -> VideoResolution { + match self { + Self::P720 => VideoResolution::P720, + Self::P1080 => VideoResolution::P1080, + Self::FourK => VideoResolution::FourK, + } + } +} + +/// Serializes as the menu label so a logged request reads the way the user +/// chose it; the wire `mode` is derived at send. +impl Serialize for Kling3p0Resolution { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.label()) + } +} + +pub struct Kling3p0Args<'a> { + pub request: Kling3p0Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Kling 3.0 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Kling3p0Request { + pub prompt: String, + + pub aspect_ratio: KlingAspectRatio, + + pub resolution: Kling3p0Resolution, + + /// Clip length; see [`Self::DURATION`]. + pub duration: VideoDurationSeconds, + + /// Let Kling rewrite the prompt (the web app's "Enhance"). + pub enhance_prompt: bool, + + /// Generate sound (the web app's audio "On"). + pub sound: bool, + + /// Kling "elements" (consistent characters/objects) to include. + pub kling_element_ids: Vec, + + /// Reference media (frames, reference images / clips / audio), uploaded + /// first via `endpoints::media` / `HiggsfieldSession::upload_reference_media` + /// and tagged with a role. The web app offers start + end frames (no free references; consistent subjects go through `kling_element_ids`). With a frame set the web app hides the aspect menu and sends the frame's aspect (e.g. `1:1`, 720×720); set `aspect_ratio` / `maybe_dimensions` to match your frame. Roles this + /// model takes: [`Self::MEDIA_ROLES`]. Empty for text-to-video. + pub medias: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, derived + /// from `aspect_ratio` + `resolution` the way the web app does. + pub maybe_dimensions: Option, +} + +impl Kling3p0Request { + /// The web app's duration slider range. + pub const DURATION: VideoDurationRange = VideoDurationRange::new(3, 15); + + /// The media roles this model accepts. + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::StartImage, MediaRole::EndImage]; + + /// A text-to-video request with the web app's defaults (enhance on, sound + /// on, credits). + pub fn text_to_video(prompt: impl Into, aspect_ratio: KlingAspectRatio, resolution: Kling3p0Resolution, duration: VideoDurationSeconds) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + duration, + enhance_prompt: true, + sound: true, + kling_element_ids: Vec::new(), + medias: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + validate_media_roles(&self.medias, Self::MEDIA_ROLES, "Kling 3.0")?; + Self::DURATION.validate(self.duration) + } + + /// Add one reference (see [`MediaReference`]'s constructors: + /// `start_frame`, `end_frame`, `image`, `video`, `audio`). + pub fn with_media(mut self, reference: MediaReference) -> Self { + self.medias.push(reference); + self + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + VideoDimensions::for_aspect_ratio(&self.aspect_ratio.to_image_aspect_ratio(), &self.resolution.to_video_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest("can't derive video dimensions; pass maybe_dimensions".to_string())) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(Kling3p0RequestBody { + params: Kling3p0Params { + prompt: self.prompt.clone(), + enhance_prompt: self.enhance_prompt, + aspect_ratio: self.aspect_ratio, + mode: self.resolution.to_video_mode(), + sound: if self.sound { "on" } else { "off" }, + duration: self.duration, + multi_shots: false, + multi_shot_mode: "auto", + kling_element_ids: self.kling_element_ids.clone(), + medias: self.medias.clone(), + width: dimensions.width, + height: dimensions.height, + }, + use_unlim: self.use_unlim, + use_free_gens: false, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn kling_3p0(args: Kling3p0Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Kling3p0RequestBody { + params: Kling3p0Params, + use_unlim: bool, + use_free_gens: bool, +} + +#[derive(Serialize)] +struct Kling3p0Params { + prompt: String, + enhance_prompt: bool, + aspect_ratio: KlingAspectRatio, + mode: VideoMode, + sound: &'static str, + duration: VideoDurationSeconds, + multi_shots: bool, + multi_shot_mode: &'static str, + kling_element_ids: Vec, + medias: Vec, + width: u32, + height: u32, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::endpoints::generate::video::test_fixtures::enqueue_response; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + const SERVER_PARAMS: &str = r#"{"width":1280,"height":720,"prompt":"a shiba inu skateboarding down a hill","medias":[],"duration":3,"aspect_ratio":"16:9","multi_shots":false,"multi_prompt":[],"sound":"on","cfg_scale":0.5,"mode":"std","kling_elements":[],"kling_element_ids":[],"multi_shot_mode":"auto","reference_elements":[],"enhance_prompt":true}"#; + + #[test] + fn resolution_menu_maps_to_mode() { + let mapping: Vec<(&str, String)> = Kling3p0Resolution::all().iter().map(|r| (r.label(), r.to_video_mode().to_string())).collect(); + assert_eq!(mapping.iter().map(|(l, m)| (*l, m.as_str())).collect::>(), [("720p", "std"), ("1080p", "pro"), ("4K", "4k")]); + assert_eq!(Kling3p0Request::DURATION, VideoDurationRange::new(3, 15)); + } + + #[test] + fn wire_body_matches_captured_request() { + let request = Kling3p0Request::text_to_video("a shiba inu skateboarding down a hill", KlingAspectRatio::Landscape16x9, Kling3p0Resolution::P720, VideoDurationSeconds::new(3)); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","enhance_prompt":true,"aspect_ratio":"16:9","mode":"std","sound":"on","duration":3,"multi_shots":false,"multi_shot_mode":"auto","kling_element_ids":[],"medias":[],"width":1280,"height":720},"use_unlim":false,"use_free_gens":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn sound_off_and_pro_mode() { + let mut request = Kling3p0Request::text_to_video("p", KlingAspectRatio::Portrait9x16, Kling3p0Resolution::P1080, VideoDurationSeconds::new(5)); + request.sound = false; + let body: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + assert_eq!(body["params"]["sound"], "off"); + assert_eq!(body["params"]["mode"], "pro"); + assert_eq!((body["params"]["width"].as_u64(), body["params"]["height"].as_u64()), (Some(1080), Some(1920))); + } + + #[test] + fn wire_body_with_start_and_end_frames_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed): with square + // frames the web app sent `1:1` and 720x720 at 720p. + let request = Kling3p0Request::text_to_video("a shiba inu skateboarding down a hill", KlingAspectRatio::Square1x1, Kling3p0Resolution::P720, VideoDurationSeconds::new(3)) + .with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))) + .with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","enhance_prompt":true,"aspect_ratio":"1:1","mode":"std","sound":"on","duration":3,"multi_shots":false,"multi_shot_mode":"auto","kling_element_ids":[],"medias":[{"role":"start_image","data":{"id":"00000000-0000-4000-8000-0000000000b1","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"}},{"role":"end_image","data":{"id":"00000000-0000-4000-8000-0000000000b2","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"}}],"width":720,"height":720},"use_unlim":false,"use_free_gens":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn media_roles() { + assert_eq!(Kling3p0Request::MEDIA_ROLES, &[MediaRole::StartImage, MediaRole::EndImage]); + let base = || Kling3p0Request::text_to_video("p", KlingAspectRatio::Landscape16x9, Kling3p0Resolution::P720, VideoDurationSeconds::new(3)); + let reference = base().with_media(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))); + assert!(matches!(reference.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + let bad = Kling3p0Request::text_to_video("p", KlingAspectRatio::Square1x1, Kling3p0Resolution::P720, VideoDurationSeconds::new(2)); + assert!(matches!(bad.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Kling3p0Request::text_to_video("", KlingAspectRatio::Square1x1, Kling3p0Resolution::P720, VideoDurationSeconds::new(3)); + let err = kling_3p0(Kling3p0Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(&enqueue_response("kling3_0", 600, SERVER_PARAMS, true)).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::Kling3p0); + assert_eq!(job_set.params.mode, Some(VideoMode::Std)); + assert_eq!(job_set.params.extra.get("sound"), Some(&Value::String("on".to_string()))); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_kling_3p0_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Kling3p0Request::text_to_video("a shiba inu serving a tennis ball", KlingAspectRatio::Landscape16x9, Kling3p0Resolution::P720, Kling3p0Request::DURATION.shortest()); + println!("\n===== request =====\n{:#?}", request); + let response = kling_3p0(Kling3p0Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::Kling3p0); + let job = poll_job_to_completion(&session, &response.job_ids()[0]).await?; + assert!(job.result_url().unwrap().ends_with(".mp4")); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/minimax_h3.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/minimax_h3.rs new file mode 100644 index 00000000..9284cf57 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/minimax_h3.rs @@ -0,0 +1,227 @@ +//! POST `/fnf/jobs/v2/minimax_h3` — enqueue a MiniMax H3 video job (job set +//! type `minimax_h3`). +//! +//! Options read off the web app on 2026-08-31: duration 5–15 s; 2K only +//! (the app sends 2560×1440); aspect is locked to Auto for text-to-video +//! (it follows the start frame otherwise); optional start / end frames and +//! references. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use crate::types::video_resolution::VideoResolution; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/minimax_h3"; + +/// The only resolution this pipeline runs at. +const RESOLUTION: VideoResolution = VideoResolution::TwoK; + +pub struct MinimaxH3Args<'a> { + pub request: MinimaxH3Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a MiniMax H3 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct MinimaxH3Request { + pub prompt: String, + + /// Clip length; see [`Self::DURATION`]. + pub duration: VideoDurationSeconds, + + /// Reference media (frames, reference images / clips / audio), uploaded + /// first via `endpoints::media` / `HiggsfieldSession::upload_reference_media` + /// and tagged with a role. The web app offers start + end frames, or references ("up to 9 images and elements, 3 videos, and 3 audio files"). Roles this + /// model takes: [`Self::MEDIA_ROLES`]. Empty for text-to-video. + pub medias: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, the 2K + /// 16:9 frame the web app sends (2560×1440). + pub maybe_dimensions: Option, +} + +impl MinimaxH3Request { + /// The web app's duration slider range. + pub const DURATION: VideoDurationRange = VideoDurationRange::new(5, 15); + + /// The media roles this model accepts. `video` / `audio` are + /// from the web app's bundle; only image roles have been sent live. + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::StartImage, MediaRole::EndImage, MediaRole::Image, MediaRole::Video, MediaRole::Audio]; + + /// A text-to-video request with the web app's defaults (credits). + pub fn text_to_video(prompt: impl Into, duration: VideoDurationSeconds) -> Self { + Self { + prompt: prompt.into(), + duration, + medias: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + validate_media_roles(&self.medias, Self::MEDIA_ROLES, "MiniMax H3")?; + Self::DURATION.validate(self.duration) + } + + /// Add one reference (see [`MediaReference`]'s constructors: + /// `start_frame`, `end_frame`, `image`, `video`, `audio`). + pub fn with_media(mut self, reference: MediaReference) -> Self { + self.medias.push(reference); + self + } + + fn to_body(&self) -> MinimaxH3RequestBody { + let dimensions = self.maybe_dimensions + .or_else(|| VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Auto, &RESOLUTION)) + .expect("2K auto dimensions are derivable"); + MinimaxH3RequestBody { + params: MinimaxH3Params { + prompt: self.prompt.clone(), + duration: self.duration, + aspect_ratio: ImageAspectRatio::Auto, + resolution: RESOLUTION, + width: dimensions.width, + height: dimensions.height, + medias: self.medias.clone(), + }, + use_unlim: self.use_unlim, + } + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn minimax_h3(args: MinimaxH3Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct MinimaxH3RequestBody { + params: MinimaxH3Params, + use_unlim: bool, +} + +#[derive(Serialize)] +struct MinimaxH3Params { + prompt: String, + duration: VideoDurationSeconds, + aspect_ratio: ImageAspectRatio, + resolution: VideoResolution, + width: u32, + height: u32, + medias: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::endpoints::generate::video::test_fixtures::enqueue_response; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + const SERVER_PARAMS: &str = r#"{"width":2560,"height":1440,"prompt":"a shiba inu skateboarding down a hill","medias":[],"reference_elements":[],"duration":5,"resolution":"2K","aspect_ratio":"auto","aigc_watermark":false,"batch_size":1}"#; + + #[test] + fn wire_body_matches_captured_request() { + let request = MinimaxH3Request::text_to_video("a shiba inu skateboarding down a hill", VideoDurationSeconds::new(5)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","duration":5,"aspect_ratio":"auto","resolution":"2K","width":2560,"height":1440,"medias":[]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn wire_body_with_start_and_end_frames_matches_captured_request() { + // Captured from the web app 2026-08-31 (ids scrubbed): with square + // frames the web app sent 2048x2048; pass `maybe_dimensions` to match. + let mut request = MinimaxH3Request::text_to_video("a shiba inu skateboarding down a hill", VideoDurationSeconds::new(5)) + .with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))) + .with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + request.maybe_dimensions = Some(VideoDimensions::new(2048, 2048)); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","duration":5,"aspect_ratio":"auto","resolution":"2K","width":2048,"height":2048,"medias":[{"role":"start_image","data":{"id":"00000000-0000-4000-8000-0000000000b1","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"}},{"role":"end_image","data":{"id":"00000000-0000-4000-8000-0000000000b2","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"}}]},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn media_roles() { + assert_eq!(MinimaxH3Request::MEDIA_ROLES, &[MediaRole::StartImage, MediaRole::EndImage, MediaRole::Image, MediaRole::Video, MediaRole::Audio]); + let base = || MinimaxH3Request::text_to_video("p", VideoDurationSeconds::new(5)); + assert!(base().with_media(MediaReference::video(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))).with_media(MediaReference::audio(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))).validate().is_ok()); + let two_ends = base().with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + assert!(matches!(two_ends.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + assert_eq!(MinimaxH3Request::DURATION, VideoDurationRange::new(5, 15)); + let bad = MinimaxH3Request::text_to_video("p", VideoDurationSeconds::new(4)); + assert!(matches!(bad.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let empty = MinimaxH3Request::text_to_video("", VideoDurationSeconds::new(5)); + assert!(matches!(empty.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = MinimaxH3Request::text_to_video("p", VideoDurationSeconds::new(16)); + let err = minimax_h3(MinimaxH3Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(&enqueue_response("minimax_h3", 1000, SERVER_PARAMS, true)).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::MinimaxH3); + assert_eq!(job_set.params.aspect_ratio, Some(ImageAspectRatio::Auto)); + assert_eq!(job_set.params.duration, Some(5)); + assert_eq!(job_set.params.extra.get("aigc_watermark"), Some(&Value::Bool(false))); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_minimax_h3_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = MinimaxH3Request::text_to_video("a shiba inu skiing down a mountain", MinimaxH3Request::DURATION.shortest()); + println!("\n===== request =====\n{:#?}", request); + let response = minimax_h3(MinimaxH3Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::MinimaxH3); + let job = poll_job_to_completion(&session, &response.job_ids()[0]).await?; + assert!(job.result_url().unwrap().ends_with(".mp4")); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/mod.rs new file mode 100644 index 00000000..889635d1 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/mod.rs @@ -0,0 +1,20 @@ +//! Video generation bindings. Every model here is text-to-video (plus +//! optional reference media the web app calls `medias`); each exposes +//! duration as a one-second slider with its own range, and the shared +//! [`VideoDurationRange`](crate::types::video_duration::VideoDurationRange) +//! constant on each request type says which. +//! +//! Completed video jobs come back through the same status endpoints as +//! images; `results.raw` / `results.min` are `type: "video"` `.mp4` URLs +//! with a `thumbnail_url` poster frame. + +pub mod grok_imagine_1p5; +pub mod kling_3p0; +pub mod minimax_h3; +pub mod seedance_2p0; +pub mod seedance_2p0_mini; +pub mod seedance_2p5; +pub mod seedance_2p5_edit; + +#[cfg(test)] +pub(crate) mod test_fixtures; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p0.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p0.rs new file mode 100644 index 00000000..13770bcc --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p0.rs @@ -0,0 +1,328 @@ +//! POST `/fnf/jobs/v2/seedance_2_0` — enqueue a Seedance 2.0 video job (job +//! set type `seedance_2_0`). +//! +//! Options read off the web app on 2026-08-31: duration 4–15 s, aspect +//! Auto / 16:9 / 9:16 / 4:3 / 3:4 / 1:1 / 21:9, 480p / 720p / 1080p / 4k, +//! audio on/off, bitrate High / Standard, uploaded media. The app sends +//! `mode: "std"`. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::video_aspect_ratio::SeedanceVideoAspectRatio; +use crate::types::video_bitrate_mode::VideoBitrateMode; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use crate::types::video_mode::VideoMode; +use crate::types::video_resolution::VideoResolution; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/seedance_2_0"; + +/// The `model` field the web app sends on this endpoint. +const MODEL: &str = "seedance_2_0"; + +/// The resolution tiers the web app offers for Seedance 2.0. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Seedance2p0Resolution { + #[default] + P480, + P720, + P1080, + FourK, +} + +impl Seedance2p0Resolution { + pub fn all() -> [Self; 4] { + [Self::P480, Self::P720, Self::P1080, Self::FourK] + } + + pub fn to_video_resolution(self) -> VideoResolution { + match self { + Self::P480 => VideoResolution::P480, + Self::P720 => VideoResolution::P720, + Self::P1080 => VideoResolution::P1080, + Self::FourK => VideoResolution::FourK, + } + } +} + +impl Serialize for Seedance2p0Resolution { + fn serialize(&self, serializer: S) -> Result { + self.to_video_resolution().serialize(serializer) + } +} + +pub struct Seedance2p0Args<'a> { + pub request: Seedance2p0Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedance 2.0 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Seedance2p0Request { + pub prompt: String, + + /// `Auto` follows the reference media; for text-to-video the web app + /// sends it as `16:9`, and so do we. + pub aspect_ratio: SeedanceVideoAspectRatio, + + pub resolution: Seedance2p0Resolution, + + /// Clip length; see [`Self::DURATION`]. + pub duration: VideoDurationSeconds, + + /// How many clips to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Generate a soundtrack (the web app's audio "On"). + pub generate_audio: bool, + + pub bitrate_mode: VideoBitrateMode, + + /// The quality mode; the web app sends `std`. + pub mode: VideoMode, + + /// Reference media (frames, reference images / clips / audio), uploaded + /// first via `endpoints::media` / `HiggsfieldSession::upload_reference_media` + /// and tagged with a role. The web app's "Upload media" takes images, video and audio (video / audio roles from its bundle; only image roles have been sent live). Roles this + /// model takes: [`Self::MEDIA_ROLES`]. Empty for text-to-video. + pub medias: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, derived + /// from `aspect_ratio` + `resolution` the way the web app does. + pub maybe_dimensions: Option, +} + +impl Seedance2p0Request { + /// The web app's duration slider range. + pub const DURATION: VideoDurationRange = VideoDurationRange::new(4, 15); + + /// The media roles this model accepts. + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::Image, MediaRole::StartImage, MediaRole::EndImage, MediaRole::Video, MediaRole::Audio]; + + /// A text-to-video request with the web app's defaults (1 clip, audio on, + /// high bitrate, `std` mode, credits). + pub fn text_to_video(prompt: impl Into, aspect_ratio: SeedanceVideoAspectRatio, resolution: Seedance2p0Resolution, duration: VideoDurationSeconds) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + duration, + batch_size: ImageBatchSize::One, + generate_audio: true, + bitrate_mode: VideoBitrateMode::High, + mode: VideoMode::Std, + medias: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + validate_media_roles(&self.medias, Self::MEDIA_ROLES, "Seedance 2.0")?; + Self::DURATION.validate(self.duration) + } + + /// Add one reference (see [`MediaReference`]'s constructors: + /// `start_frame`, `end_frame`, `image`, `video`, `audio`). + pub fn with_media(mut self, reference: MediaReference) -> Self { + self.medias.push(reference); + self + } + + /// `Auto` with no reference media goes out as `16:9`, as observed from + /// the web app. + fn wire_aspect_ratio(&self) -> ImageAspectRatio { + match self.aspect_ratio { + SeedanceVideoAspectRatio::Auto if self.medias.is_empty() => ImageAspectRatio::Landscape16x9, + other => other.to_image_aspect_ratio(), + } + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + VideoDimensions::for_aspect_ratio(&self.wire_aspect_ratio(), &self.resolution.to_video_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest("can't derive video dimensions; pass maybe_dimensions".to_string())) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(Seedance2p0RequestBody { + params: Seedance2p0Params { + model: MODEL, + mode: self.mode.clone(), + batch_size: self.batch_size, + duration: self.duration, + aspect_ratio: self.wire_aspect_ratio(), + resolution: self.resolution, + width: dimensions.width, + height: dimensions.height, + generate_audio: self.generate_audio, + bitrate_mode: self.bitrate_mode.clone(), + prompt: self.prompt.clone(), + medias: self.medias.clone(), + }, + use_unlim: self.use_unlim, + use_free_gens: false, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn seedance_2p0(args: Seedance2p0Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedance2p0RequestBody { + params: Seedance2p0Params, + use_unlim: bool, + use_free_gens: bool, +} + +#[derive(Serialize)] +struct Seedance2p0Params { + model: &'static str, + mode: VideoMode, + batch_size: ImageBatchSize, + duration: VideoDurationSeconds, + aspect_ratio: ImageAspectRatio, + resolution: Seedance2p0Resolution, + width: u32, + height: u32, + generate_audio: bool, + bitrate_mode: VideoBitrateMode, + prompt: String, + medias: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::endpoints::generate::video::test_fixtures::enqueue_response; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + const SERVER_PARAMS: &str = r#"{"width":854,"height":480,"prompt":"a shiba inu skateboarding down a hill","genre":"auto","medias":[],"duration":8,"resolution":"480p","aspect_ratio":"16:9","generate_audio":true,"multi_shots":false,"multi_shot_mode":"custom","multi_prompt":[],"speedramp":"auto","reference_elements":[],"prompt_language":"en","mode":"std","model":"seedance_2_0","bitrate_mode":"high"}"#; + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec = Seedance2p0Resolution::all().iter().map(|r| r.to_video_resolution().to_string()).collect(); + assert_eq!(wire, ["480p", "720p", "1080p", "4k"]); + assert_eq!(Seedance2p0Request::DURATION, VideoDurationRange::new(4, 15)); + } + + #[test] + fn wire_body_matches_captured_request() { + // Captured with the menu on "Auto" and no media: the app sent 16:9. + let request = Seedance2p0Request::text_to_video("a shiba inu skateboarding down a hill", SeedanceVideoAspectRatio::Auto, Seedance2p0Resolution::P480, VideoDurationSeconds::new(8)); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"model":"seedance_2_0","mode":"std","batch_size":1,"duration":8,"aspect_ratio":"16:9","resolution":"480p","width":854,"height":480,"generate_audio":true,"bitrate_mode":"high","prompt":"a shiba inu skateboarding down a hill","medias":[]},"use_unlim":false,"use_free_gens":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn auto_stays_auto_with_reference_media() { + let mut request = Seedance2p0Request::text_to_video("p", SeedanceVideoAspectRatio::Auto, Seedance2p0Resolution::P480, VideoDurationSeconds::new(4)); + request.medias = vec![MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-000000000001", "https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000001.png"))]; + assert_eq!(request.wire_aspect_ratio(), ImageAspectRatio::Auto); + } + + #[test] + fn reference_media_serialize_with_roles() { + // Not browser-captured for this model (its upload picker is gated by a + // media-upload agreement); the shape and roles come from the web app's + // bundle and match the other models' captured bodies. + let request = Seedance2p0Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))) + .with_media(MediaReference::audio(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + let body: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let medias = body["params"]["medias"].as_array().unwrap(); + assert_eq!(medias.len(), 2); + assert_eq!(medias[0]["role"], "image"); + assert_eq!(medias[0]["data"], serde_json::from_str::(r#"{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}"#).unwrap()); + assert_eq!(medias[1]["role"], "audio"); + } + + #[test] + fn media_roles() { + assert_eq!(Seedance2p0Request::MEDIA_ROLES, &[MediaRole::Image, MediaRole::StartImage, MediaRole::EndImage, MediaRole::Video, MediaRole::Audio]); + let base = || Seedance2p0Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, VideoDurationSeconds::new(4)); + assert!(base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))).validate().is_ok()); + let two_starts = base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + assert!(matches!(two_starts.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + let bad = Seedance2p0Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, VideoDurationSeconds::new(16)); + assert!(matches!(bad.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let empty = Seedance2p0Request::text_to_video("", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, VideoDurationSeconds::new(4)); + assert!(matches!(empty.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Seedance2p0Request::text_to_video("", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, VideoDurationSeconds::new(4)); + let err = seedance_2p0(Seedance2p0Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(&enqueue_response("seedance_2_0", 2400, SERVER_PARAMS, true)).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::Seedance2p0); + assert_eq!(job_set.params.mode, Some(VideoMode::Std)); + assert_eq!(job_set.params.duration, Some(8)); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_seedance_2p0_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedance2p0Request::text_to_video("a shiba inu scoring a soccer goal", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, Seedance2p0Request::DURATION.shortest()); + println!("\n===== request =====\n{:#?}", request); + let response = seedance_2p0(Seedance2p0Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::Seedance2p0); + let job = poll_job_to_completion(&session, &response.job_ids()[0]).await?; + assert!(job.result_url().unwrap().ends_with(".mp4")); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p0_mini.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p0_mini.rs new file mode 100644 index 00000000..0a2e26e1 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p0_mini.rs @@ -0,0 +1,298 @@ +//! POST `/fnf/jobs/v2/seedance_2_0_mini` — enqueue a Seedance 2.0 Mini video +//! job (job set type `seedance_2_0_mini`). +//! +//! Options read off the web app on 2026-08-31: duration 4–15 s, aspect +//! Auto / 16:9 / 9:16 / 4:3 / 3:4 / 1:1 / 21:9, 480p / 720p, audio on/off, +//! uploaded media. No bitrate control. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::video_aspect_ratio::SeedanceVideoAspectRatio; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use crate::types::video_resolution::VideoResolution; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/seedance_2_0_mini"; + +/// The `model` field the web app sends on this endpoint. +const MODEL: &str = "seedance_2_0_mini"; + +/// The resolution tiers the web app offers for Seedance 2.0 Mini. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Seedance2p0MiniResolution { + #[default] + P480, + P720, +} + +impl Seedance2p0MiniResolution { + pub fn all() -> [Self; 2] { + [Self::P480, Self::P720] + } + + pub fn to_video_resolution(self) -> VideoResolution { + match self { + Self::P480 => VideoResolution::P480, + Self::P720 => VideoResolution::P720, + } + } +} + +impl Serialize for Seedance2p0MiniResolution { + fn serialize(&self, serializer: S) -> Result { + self.to_video_resolution().serialize(serializer) + } +} + +pub struct Seedance2p0MiniArgs<'a> { + pub request: Seedance2p0MiniRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedance 2.0 Mini request. Serializable so it +/// can be logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Seedance2p0MiniRequest { + pub prompt: String, + + /// `Auto` follows the reference media; for text-to-video the web app + /// sends it as `16:9`, and so do we. + pub aspect_ratio: SeedanceVideoAspectRatio, + + pub resolution: Seedance2p0MiniResolution, + + /// Clip length; see [`Self::DURATION`]. + pub duration: VideoDurationSeconds, + + /// How many clips to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Generate a soundtrack (the web app's audio "On"). + pub generate_audio: bool, + + /// Reference media (frames, reference images / clips / audio), uploaded + /// first via `endpoints::media` / `HiggsfieldSession::upload_reference_media` + /// and tagged with a role. The web app's "Upload media" takes images, video and audio (video / audio roles from its bundle; only image roles have been sent live). Roles this + /// model takes: [`Self::MEDIA_ROLES`]. Empty for text-to-video. + pub medias: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, derived + /// from `aspect_ratio` + `resolution` the way the web app does. + pub maybe_dimensions: Option, +} + +impl Seedance2p0MiniRequest { + /// The web app's duration slider range. + pub const DURATION: VideoDurationRange = VideoDurationRange::new(4, 15); + + /// The media roles this model accepts. + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::Image, MediaRole::StartImage, MediaRole::EndImage, MediaRole::Video, MediaRole::Audio]; + + /// A text-to-video request with the web app's defaults (1 clip, audio on, + /// credits). + pub fn text_to_video(prompt: impl Into, aspect_ratio: SeedanceVideoAspectRatio, resolution: Seedance2p0MiniResolution, duration: VideoDurationSeconds) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + duration, + batch_size: ImageBatchSize::One, + generate_audio: true, + medias: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + validate_media_roles(&self.medias, Self::MEDIA_ROLES, "Seedance 2.0 Mini")?; + Self::DURATION.validate(self.duration) + } + + /// Add one reference (see [`MediaReference`]'s constructors: + /// `start_frame`, `end_frame`, `image`, `video`, `audio`). + pub fn with_media(mut self, reference: MediaReference) -> Self { + self.medias.push(reference); + self + } + + fn wire_aspect_ratio(&self) -> ImageAspectRatio { + match self.aspect_ratio { + SeedanceVideoAspectRatio::Auto if self.medias.is_empty() => ImageAspectRatio::Landscape16x9, + other => other.to_image_aspect_ratio(), + } + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + VideoDimensions::for_aspect_ratio(&self.wire_aspect_ratio(), &self.resolution.to_video_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest("can't derive video dimensions; pass maybe_dimensions".to_string())) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(Seedance2p0MiniRequestBody { + params: Seedance2p0MiniParams { + prompt: self.prompt.clone(), + batch_size: self.batch_size, + duration: self.duration, + generate_audio: self.generate_audio, + model: MODEL, + aspect_ratio: self.wire_aspect_ratio(), + resolution: self.resolution, + width: dimensions.width, + height: dimensions.height, + medias: self.medias.clone(), + }, + use_unlim: self.use_unlim, + use_free_gens: false, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn seedance_2p0_mini(args: Seedance2p0MiniArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedance2p0MiniRequestBody { + params: Seedance2p0MiniParams, + use_unlim: bool, + use_free_gens: bool, +} + +#[derive(Serialize)] +struct Seedance2p0MiniParams { + prompt: String, + batch_size: ImageBatchSize, + duration: VideoDurationSeconds, + generate_audio: bool, + model: &'static str, + aspect_ratio: ImageAspectRatio, + resolution: Seedance2p0MiniResolution, + width: u32, + height: u32, + medias: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::endpoints::generate::video::test_fixtures::enqueue_response; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + const SERVER_PARAMS: &str = r#"{"width":854,"height":480,"prompt":"a shiba inu skateboarding down a hill","genre":"auto","medias":[],"duration":4,"resolution":"480p","aspect_ratio":"16:9","generate_audio":true,"multi_shots":false,"multi_shot_mode":"custom","multi_prompt":[],"speedramp":"auto","reference_elements":[],"prompt_language":"en"}"#; + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec = Seedance2p0MiniResolution::all().iter().map(|r| r.to_video_resolution().to_string()).collect(); + assert_eq!(wire, ["480p", "720p"]); + assert_eq!(Seedance2p0MiniRequest::DURATION, VideoDurationRange::new(4, 15)); + } + + #[test] + fn wire_body_matches_captured_request() { + let request = Seedance2p0MiniRequest::text_to_video("a shiba inu skateboarding down a hill", SeedanceVideoAspectRatio::Auto, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","batch_size":1,"duration":4,"generate_audio":true,"model":"seedance_2_0_mini","aspect_ratio":"16:9","resolution":"480p","width":854,"height":480,"medias":[]},"use_unlim":false,"use_free_gens":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn reference_media_serialize_with_roles() { + // Not browser-captured for this model (its upload picker is gated by a + // media-upload agreement); the shape and roles come from the web app's + // bundle and match the other models' captured bodies. + let request = Seedance2p0MiniRequest::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))) + .with_media(MediaReference::audio(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + let body: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let medias = body["params"]["medias"].as_array().unwrap(); + assert_eq!(medias.len(), 2); + assert_eq!(medias[0]["role"], "image"); + assert_eq!(medias[0]["data"], serde_json::from_str::(r#"{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}"#).unwrap()); + assert_eq!(medias[1]["role"], "audio"); + } + + #[test] + fn media_roles() { + assert_eq!(Seedance2p0MiniRequest::MEDIA_ROLES, &[MediaRole::Image, MediaRole::StartImage, MediaRole::EndImage, MediaRole::Video, MediaRole::Audio]); + let base = || Seedance2p0MiniRequest::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)); + assert!(base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))).validate().is_ok()); + let two_starts = base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + assert!(matches!(two_starts.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + let bad = Seedance2p0MiniRequest::text_to_video("p", SeedanceVideoAspectRatio::Square1x1, Seedance2p0MiniResolution::P720, VideoDurationSeconds::new(3)); + assert!(matches!(bad.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Seedance2p0MiniRequest::text_to_video("", SeedanceVideoAspectRatio::Square1x1, Seedance2p0MiniResolution::P480, VideoDurationSeconds::new(4)); + let err = seedance_2p0_mini(Seedance2p0MiniArgs { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(&enqueue_response("seedance_2_0_mini", 400, SERVER_PARAMS, true)).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::Seedance2p0Mini); + assert_eq!(job_set.cost, Some(400.0)); + assert!(job_set.params.bitrate_mode.is_none()); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_seedance_2p0_mini_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedance2p0MiniRequest::text_to_video("a shiba inu dunking a basketball", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0MiniResolution::P480, Seedance2p0MiniRequest::DURATION.shortest()); + println!("\n===== request =====\n{:#?}", request); + let response = seedance_2p0_mini(Seedance2p0MiniArgs { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::Seedance2p0Mini); + let job = poll_job_to_completion(&session, &response.job_ids()[0]).await?; + assert!(job.result_url().unwrap().ends_with(".mp4")); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p5.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p5.rs new file mode 100644 index 00000000..b9731386 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p5.rs @@ -0,0 +1,308 @@ +//! POST `/fnf/jobs/v2/seedance_2_5` — enqueue a Seedance 2.5 video job (job +//! set type `seedance_2_5`). +//! +//! Options read off the web app on 2026-08-31: duration 4–30 s, aspect +//! 21:9 / 16:9 / 4:3 / 1:1 / 3:4 / 9:16, 480p / 720p / 1080p, audio on/off, +//! bitrate High / Standard, reference media (image, video or audio). + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::video_aspect_ratio::SeedanceVideoAspectRatio; +use crate::types::video_bitrate_mode::VideoBitrateMode; +use crate::types::video_dimensions::VideoDimensions; +use crate::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use crate::types::video_resolution::VideoResolution; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/seedance_2_5"; + +/// The `model` field the web app sends on this endpoint. +const MODEL: &str = "default"; + +/// The resolution tiers the web app offers for Seedance 2.5. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum Seedance2p5Resolution { + #[default] + P480, + P720, + P1080, +} + +impl Seedance2p5Resolution { + pub fn all() -> [Self; 3] { + [Self::P480, Self::P720, Self::P1080] + } + + pub fn to_video_resolution(self) -> VideoResolution { + match self { + Self::P480 => VideoResolution::P480, + Self::P720 => VideoResolution::P720, + Self::P1080 => VideoResolution::P1080, + } + } +} + +impl Serialize for Seedance2p5Resolution { + fn serialize(&self, serializer: S) -> Result { + self.to_video_resolution().serialize(serializer) + } +} + +pub struct Seedance2p5Args<'a> { + pub request: Seedance2p5Request, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedance 2.5 request. Serializable so it can be +/// logged or persisted separately from the session. +#[derive(Clone, Debug, Serialize)] +pub struct Seedance2p5Request { + pub prompt: String, + + /// `Auto` isn't on this model's menu and is rejected. + pub aspect_ratio: SeedanceVideoAspectRatio, + + pub resolution: Seedance2p5Resolution, + + /// Clip length; see [`Self::DURATION`]. + pub duration: VideoDurationSeconds, + + /// How many clips to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Generate a soundtrack (the web app's audio "On"). + pub generate_audio: bool, + + pub bitrate_mode: VideoBitrateMode, + + /// Reference media (frames, reference images / clips / audio), uploaded + /// first via `endpoints::media` / `HiggsfieldSession::upload_reference_media` + /// and tagged with a role. The web app's "Upload media" takes images, video and audio (video / audio roles from its bundle; only image roles have been sent live). Roles this + /// model takes: [`Self::MEDIA_ROLES`]. Empty for text-to-video. + pub medias: Vec, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// Override the pixel size sent with the request. When `None`, derived + /// from `aspect_ratio` + `resolution` the way the web app does. + pub maybe_dimensions: Option, +} + +impl Seedance2p5Request { + /// The web app's duration slider range. + pub const DURATION: VideoDurationRange = VideoDurationRange::new(4, 30); + + /// The media roles this model accepts. + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::Image, MediaRole::StartImage, MediaRole::EndImage, MediaRole::Video, MediaRole::Audio]; + + /// A text-to-video request with the web app's defaults (1 clip, audio on, + /// high bitrate, credits). + pub fn text_to_video(prompt: impl Into, aspect_ratio: SeedanceVideoAspectRatio, resolution: Seedance2p5Resolution, duration: VideoDurationSeconds) -> Self { + Self { + prompt: prompt.into(), + aspect_ratio, + resolution, + duration, + batch_size: ImageBatchSize::One, + generate_audio: true, + bitrate_mode: VideoBitrateMode::High, + medias: Vec::new(), + use_unlim: false, + maybe_dimensions: None, + } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + if self.aspect_ratio == SeedanceVideoAspectRatio::Auto { + return Err(HiggsfieldClientError::InvalidRequest("Seedance 2.5 has no Auto aspect ratio; pick one".to_string())); + } + validate_media_roles(&self.medias, Self::MEDIA_ROLES, "Seedance 2.5")?; + Self::DURATION.validate(self.duration) + } + + /// Add one reference (see [`MediaReference`]'s constructors: + /// `start_frame`, `end_frame`, `image`, `video`, `audio`). + pub fn with_media(mut self, reference: MediaReference) -> Self { + self.medias.push(reference); + self + } + + fn dimensions(&self) -> Result { + if let Some(dimensions) = self.maybe_dimensions { + return Ok(dimensions); + } + VideoDimensions::for_aspect_ratio(&self.aspect_ratio.to_image_aspect_ratio(), &self.resolution.to_video_resolution()) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest("can't derive video dimensions; pass maybe_dimensions".to_string())) + } + + fn to_body(&self) -> Result { + let dimensions = self.dimensions()?; + Ok(Seedance2p5RequestBody { + params: Seedance2p5Params { + prompt: self.prompt.clone(), + width: dimensions.width, + height: dimensions.height, + medias: self.medias.clone(), + resolution: self.resolution, + generate_audio: self.generate_audio, + bitrate_mode: self.bitrate_mode.clone(), + batch_size: self.batch_size, + model: MODEL, + use_unlim: self.use_unlim, + duration: self.duration, + aspect_ratio: self.aspect_ratio, + }, + use_unlim: self.use_unlim, + }) + } +} + +/// Enqueue the job. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn seedance_2p5(args: Seedance2p5Args<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedance2p5RequestBody { + params: Seedance2p5Params, + use_unlim: bool, +} + +#[derive(Serialize)] +struct Seedance2p5Params { + prompt: String, + width: u32, + height: u32, + medias: Vec, + resolution: Seedance2p5Resolution, + generate_audio: bool, + bitrate_mode: VideoBitrateMode, + batch_size: ImageBatchSize, + model: &'static str, + use_unlim: bool, + duration: VideoDurationSeconds, + aspect_ratio: SeedanceVideoAspectRatio, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInput; + use crate::endpoints::generate::video::test_fixtures::enqueue_response; + use crate::types::job_set_type::JobSetType; + use serde_json::Value; + + const SERVER_PARAMS: &str = r#"{"width":854,"height":480,"prompt":"a shiba inu skateboarding down a hill","genre":"auto","medias":[],"duration":4,"resolution":"480p","aspect_ratio":"16:9","generate_audio":true,"multi_shots":false,"multi_shot_mode":"custom","multi_prompt":[],"speedramp":"auto","reference_elements":[],"prompt_language":"en","model":"default","extension_mode":null,"bitrate_mode":"high"}"#; + + #[test] + fn resolutions_match_the_web_app_menu() { + let wire: Vec = Seedance2p5Resolution::all().iter().map(|r| r.to_video_resolution().to_string()).collect(); + assert_eq!(wire, ["480p", "720p", "1080p"]); + assert_eq!(Seedance2p5Request::DURATION, VideoDurationRange::new(4, 30)); + } + + #[test] + fn wire_body_matches_captured_request() { + let request = Seedance2p5Request::text_to_video("a shiba inu skateboarding down a hill", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(4)); + let actual: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"a shiba inu skateboarding down a hill","width":854,"height":480,"medias":[],"resolution":"480p","generate_audio":true,"bitrate_mode":"high","batch_size":1,"model":"default","use_unlim":false,"duration":4,"aspect_ratio":"16:9"},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn reference_media_serialize_with_roles() { + // Not browser-captured for this model (its upload picker is gated by a + // media-upload agreement); the shape and roles come from the web app's + // bundle and match the other models' captured bodies. + let request = Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(4)) + .with_media(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))) + .with_media(MediaReference::audio(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + let body: Value = serde_json::to_value(request.to_body().unwrap()).unwrap(); + let medias = body["params"]["medias"].as_array().unwrap(); + assert_eq!(medias.len(), 2); + assert_eq!(medias[0]["role"], "image"); + assert_eq!(medias[0]["data"], serde_json::from_str::(r#"{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}"#).unwrap()); + assert_eq!(medias[1]["role"], "audio"); + } + + #[test] + fn media_roles() { + assert_eq!(Seedance2p5Request::MEDIA_ROLES, &[MediaRole::Image, MediaRole::StartImage, MediaRole::EndImage, MediaRole::Video, MediaRole::Audio]); + let base = || Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(4)); + assert!(base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::end_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))).validate().is_ok()); + let two_starts = base().with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b1", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b1.png"))).with_media(MediaReference::start_frame(MediaInput::uploaded("00000000-0000-4000-8000-0000000000b2", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000b2.png"))); + assert!(matches!(two_starts.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + let ok = Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(30)); + assert!(ok.validate().is_ok()); + let too_long = Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(31)); + assert!(matches!(too_long.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let auto = Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Auto, Seedance2p5Resolution::P480, VideoDurationSeconds::new(4)); + assert!(matches!(auto.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let empty = Seedance2p5Request::text_to_video(" ", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(4)); + assert!(matches!(empty.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let request = Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, VideoDurationSeconds::new(3)); + let err = seedance_2p5(Seedance2p5Args { request, auth: &auth, host: &host }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(&enqueue_response("seedance_2_5", 1000, SERVER_PARAMS, true)).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::Seedance2p5); + assert_eq!(job_set.cost, Some(1000.0)); + assert_eq!(job_set.params.duration, Some(4)); + assert_eq!(job_set.params.generate_audio, Some(true)); + assert_eq!(job_set.params.bitrate_mode, Some(VideoBitrateMode::High)); + } + + // ── Live (ignored: needs a real session and spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_enqueue_seedance_2p5_from_app_credential_and_poll() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::poll_job_to_completion::poll_job_to_completion; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let request = Seedance2p5Request::text_to_video("a shiba inu surfing a wave", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, Seedance2p5Request::DURATION.shortest()); + println!("\n===== request =====\n{:#?}", request); + let response = seedance_2p5(Seedance2p5Args { request, auth: &auth, host: &HiggsfieldHost::Higgsfield }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("\n===== POST {PATH} =====\n{:#?}", response); + assert_eq!(response.first_job_set().unwrap().job_set_type, JobSetType::Seedance2p5); + let job = poll_job_to_completion(&session, &response.job_ids()[0]).await?; + assert!(job.result_url().unwrap().ends_with(".mp4")); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p5_edit.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p5_edit.rs new file mode 100644 index 00000000..ad5aa9ee --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/seedance_2p5_edit.rs @@ -0,0 +1,207 @@ +//! POST `/fnf/jobs/v2/seedance_2_5` with `model: "video_edit"` — the web +//! app's "Seedance 2.5 Edit": rewrite an existing clip (≤30 s) from a prompt +//! plus optional image / audio references. Same job set type as Seedance +//! 2.5 (`seedance_2_5`); the web app's picker labels the variant +//! `seedance_2_5_edit` but posts it to the base pipeline. +//! +//! Shape from the web app's bundle (2026-08-31): the edit body is the +//! Seedance 2.5 body minus `duration` and `aspect_ratio` (the clip decides +//! both), with the source clip in `medias` as role `video`. The Edit tab's +//! upload picker is gated by a media-upload agreement, so this was not +//! browser-captured; the live test below is the verification. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::endpoints::generate::video::seedance_2p5::Seedance2p5Resolution; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::image_batch_size::ImageBatchSize; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::{validate_media_roles, MediaReference}; +use crate::types::media_role::MediaRole; +use crate::types::video_bitrate_mode::VideoBitrateMode; +use crate::types::video_dimensions::VideoDimensions; +use serde::Serialize; + +const PATH: &str = "/fnf/jobs/v2/seedance_2_5"; + +/// The `model` field that selects the edit pipeline (the web app's +/// `videoEdit` constant; text-to-video sends `default`). +const MODEL: &str = "video_edit"; + +pub struct Seedance2p5EditArgs<'a> { + pub request: Seedance2p5EditRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// The material part of a Seedance 2.5 Edit request. +#[derive(Clone, Debug, Serialize)] +pub struct Seedance2p5EditRequest { + /// What to change. + pub prompt: String, + + /// The clip to edit (≤30 s): an uploaded `video_input` or a previous + /// generation as `video_job`. Sent first in `medias` with role `video`. + pub source_video: MediaInput, + + pub resolution: Seedance2p5Resolution, + + /// Image / audio references ("elements or references", up to 50). Roles + /// this model takes: [`Self::MEDIA_ROLES`]. + pub references: Vec, + + /// How many edits to generate (1–4). Each costs credits. + pub batch_size: ImageBatchSize, + + /// Generate a soundtrack (the web app's audio "On"). + pub generate_audio: bool, + + pub bitrate_mode: VideoBitrateMode, + + /// Spend from the plan's "unlimited" pool instead of credits, if the plan + /// has one. + pub use_unlim: bool, + + /// The pixel size sent with the request. The web app derives it from the + /// clip; with `None` a 16:9 frame at `resolution` is sent, which the + /// server treats as advisory. + pub maybe_dimensions: Option, +} + +impl Seedance2p5EditRequest { + /// Reference roles the edit form takes ("up to 50 image or audio"). + pub const MEDIA_ROLES: &'static [MediaRole] = &[MediaRole::Image, MediaRole::Audio]; + + /// An edit with the web app's defaults (1 clip, audio on, high bitrate, + /// credits). + pub fn new(prompt: impl Into, source_video: MediaInput, resolution: Seedance2p5Resolution) -> Self { + Self { + prompt: prompt.into(), + source_video, + resolution, + references: Vec::new(), + batch_size: ImageBatchSize::One, + generate_audio: true, + bitrate_mode: VideoBitrateMode::High, + use_unlim: false, + maybe_dimensions: None, + } + } + + /// Add one image / audio reference. + pub fn with_reference(mut self, reference: MediaReference) -> Self { + self.references.push(reference); + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.prompt.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("prompt is empty".to_string())); + } + validate_media_roles(&self.references, Self::MEDIA_ROLES, "Seedance 2.5 Edit") + } + + fn dimensions(&self) -> VideoDimensions { + self.maybe_dimensions + .or_else(|| VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Landscape16x9, &self.resolution.to_video_resolution())) + .expect("16:9 dimensions are derivable for every known resolution") + } + + fn to_body(&self) -> Seedance2p5EditRequestBody { + let dimensions = self.dimensions(); + let mut medias = Vec::with_capacity(self.references.len() + 1); + medias.push(MediaReference::video(self.source_video.clone())); + medias.extend(self.references.iter().cloned()); + Seedance2p5EditRequestBody { + params: Seedance2p5EditParams { + prompt: self.prompt.clone(), + width: dimensions.width, + height: dimensions.height, + medias, + resolution: self.resolution, + generate_audio: self.generate_audio, + bitrate_mode: self.bitrate_mode.clone(), + batch_size: self.batch_size, + model: MODEL, + use_unlim: self.use_unlim, + }, + use_unlim: self.use_unlim, + } + } +} + +/// Enqueue the edit. The response's job ids are what to poll (see +/// `endpoints::jobs`); a finished job's `results.raw.url` is the `.mp4`. +pub async fn seedance_2p5_edit(args: Seedance2p5EditArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct Seedance2p5EditRequestBody { + params: Seedance2p5EditParams, + use_unlim: bool, +} + +/// The Seedance 2.5 params without `duration` / `aspect_ratio`. +#[derive(Serialize)] +struct Seedance2p5EditParams { + prompt: String, + width: u32, + height: u32, + medias: Vec, + resolution: Seedance2p5Resolution, + generate_audio: bool, + bitrate_mode: VideoBitrateMode, + batch_size: ImageBatchSize, + model: &'static str, + use_unlim: bool, +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::Value; + + fn source() -> MediaInput { + MediaInput::uploaded_video("00000000-0000-4000-8000-0000000000cc", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000cc.mp4") + } + + #[test] + fn wire_body_matches_the_bundles_edit_shape() { + let request = Seedance2p5EditRequest::new("make it snow", source(), Seedance2p5Resolution::P480) + .with_reference(MediaReference::image(MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"))); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + let expected: Value = serde_json::from_str(r#"{"params":{"prompt":"make it snow","width":854,"height":480,"medias":[{"role":"video","data":{"id":"00000000-0000-4000-8000-0000000000cc","type":"video_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000cc.mp4"}},{"role":"image","data":{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}}],"resolution":"480p","generate_audio":true,"bitrate_mode":"high","batch_size":1,"model":"video_edit","use_unlim":false},"use_unlim":false}"#).unwrap(); + assert_eq!(actual, expected); + assert!(actual["params"].get("duration").is_none()); + assert!(actual["params"].get("aspect_ratio").is_none()); + } + + #[test] + fn validation() { + assert!(matches!(Seedance2p5EditRequest::new(" ", source(), Seedance2p5Resolution::P480).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let frame = Seedance2p5EditRequest::new("p", source(), Seedance2p5Resolution::P480) + .with_reference(MediaReference::start_frame(MediaInput::uploaded("a", "https://cdn.example.com/a.png"))); + assert!(matches!(frame.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert!(Seedance2p5EditRequest::new("p", source(), Seedance2p5Resolution::P480).validate().is_ok()); + } + + #[tokio::test] + async fn invalid_request_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let err = seedance_2p5_edit(Seedance2p5EditArgs { + request: Seedance2p5EditRequest::new("", source(), Seedance2p5Resolution::P480), + auth: &auth, + host: &HiggsfieldHost::Custom("http://127.0.0.1:9".into()), + }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/generate/video/test_fixtures.rs b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/test_fixtures.rs new file mode 100644 index 00000000..83f283ff --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/generate/video/test_fixtures.rs @@ -0,0 +1,10 @@ +//! Builds a scrubbed enqueue response around a captured `job_sets[0]` +//! (server-normalized params), so each binding's parse test uses the real +//! shape without repeating the wallet / workspace boilerplate. + +pub fn enqueue_response(job_set_type: &str, cost: u32, params_json: &str, with_cluster_hash: bool) -> String { + let cluster_hash = if with_cluster_hash { r#""cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","# } else { "" }; + format!( + r#"{{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{{"id":"00000000-0000-0000-0000-00000000bbbb","type":"{job_set_type}","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788155400.1,"parent_id":null,{cluster_hash}"cost":{cost},"params":{params_json},"jobs":[{{"id":"00000000-0000-0000-0000-00000000cccc","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{{}},"created_at":1788155400.2,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000cccc","representation":null,"folder_ids":[],"is_favourite":false}}],"client_meta":null,"chain_id":null}}],"has_more":false,"wallet":{{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":110000,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90}},"workspace_details":{{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null}},"free_gens_v2":{{"items":[]}},"generation_seconds":{{"items":[]}},"folder_credits":null}}"# + ) +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/jobs/job_status.rs b/crates/api_clients/higgsfield_client/src/endpoints/jobs/job_status.rs new file mode 100644 index 00000000..6fc57794 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/jobs/job_status.rs @@ -0,0 +1,268 @@ +//! GET `/fnf/jobs/{job_id}` — the full state of one job, including its +//! result URLs once complete. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::{JobId, JobSetId, UserId}; +use crate::types::job_media::JobResults; +use crate::types::job_params::JobParams; +use crate::types::job_set_type::JobSetType; +use crate::types::job_status::JobStatus; +use serde::Deserialize; +use serde_json::Value; + +pub struct JobStatusArgs<'a> { + pub request: JobStatusRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug)] +pub struct JobStatusRequest { + pub job_id: JobId, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct JobStatusResponse { + pub id: JobId, + + pub status: JobStatus, + + pub job_set_type: JobSetType, + + pub job_set_id: JobSetId, + + #[serde(default)] + pub job_set_parent_id: Option, + + /// The server's normalized parameters. Note `width` / `height` can change + /// between "in progress" and "completed". + #[serde(default)] + pub params: JobParams, + + /// Present once `status` is `completed`. + #[serde(default)] + pub results: Option, + + /// Legacy single-result slot; `null` in every capture so far. + #[serde(default)] + pub result: Option, + + /// Server-side notes; a failed job's `fail_reason` lives here (see + /// [`Self::fail_reason`]). + #[serde(default)] + pub meta: serde_json::Map, + + /// Whether the IP (intellectual property) check has run. + #[serde(default)] + pub ip_check_finished: Option, + + /// Whether the IP check flagged the output. + #[serde(default)] + pub ip_detected: Option, + + /// Unix epoch seconds (fractional). + pub created_at: f64, + + #[serde(default)] + pub published_at: Option, + + #[serde(default)] + pub user_id: Option, + + #[serde(default)] + pub trace_id: Option, + + #[serde(default)] + pub cluster_hash: Option, + + #[serde(default)] + pub user: Option, + + #[serde(default)] + pub board_ids: Vec, + + #[serde(default)] + pub folder_ids: Vec, + + #[serde(default)] + pub is_favourite: bool, + + #[serde(default)] + pub is_viewed: bool, +} + +impl JobStatusResponse { + /// Why a `failed` job failed, when the server says (e.g. "Input audio + /// duration is not supported. Please try a shorter audio."). + pub fn fail_reason(&self) -> Option<&str> { + self.meta.get("fail_reason").and_then(Value::as_str) + } + + /// The full-resolution output URL, once the job completed. + pub fn result_url(&self) -> Option<&str> { + self.results.as_ref().map(|results| results.raw.url.as_str()) + } +} + +/// The job's owner, as embedded in the status response. +#[derive(Clone, Debug, Deserialize)] +pub struct JobUser { + pub id: UserId, + + #[serde(default)] + pub full_name: Option, + + #[serde(default)] + pub username: Option, + + #[serde(default)] + pub avatar_url: Option, +} + +pub async fn job_status(args: JobStatusArgs<'_>) -> Result { + let path = format!("/fnf/jobs/{}", args.request.job_id.as_str()); + send_json_request(HttpMethod::Get, &path, args.auth, args.host, None::<&()>).await +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn failed_job_exposes_its_reason() { + // Live 2026-08-31 (ids scrubbed): a Seedance job rejected for its audio reference. + let json = r#"{"board_ids":[],"cluster_hash":"65b161afd05ea0a6f0de6b28848b60aa","created_at":1788160267.405772,"folder_ids":[],"id":"00000000-0000-0000-0000-00000000ffff","ip_check_finished":false,"ip_detected":null,"is_favourite":false,"is_viewed":false,"job_set_client_meta":null,"job_set_id":"00000000-0000-0000-0000-00000000bbbb","job_set_parent_id":null,"job_set_type":"seedance_2_0_mini","meta":{"fail_reason":"Input audio duration is not supported. Please try a shorter audio."},"published_at":null,"representation":null,"result":null,"results":null,"status":"failed","trace_id":"00000000-0000-0000-0000-00000000ffff","user_id":"user_TESTUSER0000000000000000000","params":{"aspect_ratio":"1:1","duration":4,"medias":[{"data":{"id":"00000000-0000-4000-8000-0000000000cc","type":"video_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000cc.mp4"},"role":"video"},{"data":{"id":"00000000-0000-4000-8000-0000000000dd","type":"audio_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000dd.wav"},"role":"audio"}],"prompt":"p","resolution":"480p","width":480,"height":480}}"#; + let job: JobStatusResponse = serde_json::from_str(json).unwrap(); + assert_eq!(job.status, JobStatus::Failed); + assert_eq!(job.fail_reason(), Some("Input audio duration is not supported. Please try a shorter audio.")); + assert_eq!(job.params.medias[0].data.kind, crate::types::media_input::MediaInputKind::VideoInput); + assert_eq!(job.params.medias[1].data.kind, crate::types::media_input::MediaInputKind::AudioInput); + } + use crate::types::image_quality::ImageQuality; + use crate::types::image_aspect_ratio::ImageAspectRatio; + use crate::types::job_media::JobMediaType; + + // Captured responses, with ids / user details scrubbed. + + const NANO_BANANA_IN_PROGRESS: &str = r#"{"job_set_type":"nano_banana_2","job_set_id":"00000000-0000-0000-0000-00000000bbbb","job_set_parent_id":null,"job_set_client_meta":null,"board_ids":[],"params":{"width":864,"height":1184,"aspect_ratio":"3:4","resolution":"1k","batch_size":1,"input_images":[],"input_image":null,"application":null,"surface":null,"prompt":"a dinosaur on a skateboard"},"meta":{},"id":"00000000-0000-0000-0000-00000000cccc","status":"in_progress","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"published_at":null,"created_at":1788147223.626676,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000cccc","user":{"id":"user_TESTUSER0000000000000000000","full_name":"Test User","username":"testuser","avatar_url":null},"folder_ids":[],"is_favourite":false,"is_viewed":false}"#; + + const NANO_BANANA_COMPLETED: &str = r#"{"job_set_type":"nano_banana_2","job_set_id":"00000000-0000-0000-0000-00000000bbbb","job_set_parent_id":null,"job_set_client_meta":null,"board_ids":[],"params":{"width":5504,"height":3072,"aspect_ratio":"16:9","resolution":"4k","batch_size":1,"input_images":[],"input_image":null,"application":null,"surface":null,"prompt":"a dinosaur on a skateboard"},"meta":{},"id":"00000000-0000-0000-0000-00000000cccc","status":"completed","ip_check_finished":true,"ip_detected":false,"result":null,"results":{"raw":{"type":"image","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/hf_20260831_034933_00000000-0000-0000-0000-00000000cccc.png"},"min":{"type":"image","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/hf_20260831_034933_00000000-0000-0000-0000-00000000cccc_min.webp"}},"published_at":null,"created_at":1788148173.993516,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000cccc","user":{"id":"user_TESTUSER0000000000000000000","full_name":"Test User","username":"testuser","avatar_url":null},"folder_ids":[],"is_favourite":false,"is_viewed":false}"#; + + const GPT_IMAGE_IN_PROGRESS: &str = r#"{"job_set_type":"gpt_image_2","job_set_id":"00000000-0000-0000-0000-00000000dddd","job_set_parent_id":null,"job_set_client_meta":null,"board_ids":[],"params":{"width":1152,"height":2048,"prompt":"a corgi on a bike","medias":[],"aspect_ratio":"9:16","quality":"high","resolution":"2k","model":"videotape-alpha","remove_bg":false,"reference_elements":[]},"meta":{},"id":"00000000-0000-0000-0000-00000000eeee","status":"in_progress","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"published_at":null,"created_at":1788148993.971706,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000eeee","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"user":{"id":"user_TESTUSER0000000000000000000","full_name":"Test User","username":"testuser","avatar_url":null},"folder_ids":[],"is_favourite":false,"is_viewed":false}"#; + + const GPT_IMAGE_COMPLETED: &str = r#"{"job_set_type":"gpt_image_2","job_set_id":"00000000-0000-0000-0000-00000000dddd","job_set_parent_id":null,"job_set_client_meta":null,"board_ids":[],"params":{"width":1520,"height":2688,"prompt":"a corgi on a bike","medias":[],"aspect_ratio":"9:16","quality":"high","resolution":"2k","model":"videotape-alpha","remove_bg":false,"reference_elements":[]},"meta":{},"id":"00000000-0000-0000-0000-00000000eeee","status":"completed","ip_check_finished":true,"ip_detected":false,"result":null,"results":{"raw":{"type":"image","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/hf_20260831_040313_00000000-0000-0000-0000-00000000eeee.png"},"min":{"type":"image","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/hf_20260831_040313_00000000-0000-0000-0000-00000000eeee.png"}},"published_at":null,"created_at":1788148993.971706,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000eeee","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"user":{"id":"user_TESTUSER0000000000000000000","full_name":"Test User","username":"testuser","avatar_url":null},"folder_ids":[],"is_favourite":false,"is_viewed":false}"#; + + #[test] + fn in_progress_nano_banana_parses() { + let response: JobStatusResponse = serde_json::from_str(NANO_BANANA_IN_PROGRESS).unwrap(); + assert_eq!(response.id.as_str(), "00000000-0000-0000-0000-00000000cccc"); + assert_eq!(response.status, JobStatus::InProgress); + assert!(!response.status.is_terminal()); + assert_eq!(response.job_set_type, JobSetType::NanoBanana2); + assert_eq!(response.job_set_id.as_str(), "00000000-0000-0000-0000-00000000bbbb"); + assert!(response.results.is_none()); + assert_eq!(response.result_url(), None); + assert_eq!(response.params.aspect_ratio, Some(ImageAspectRatio::Portrait3x4)); + assert_eq!(response.user.as_ref().unwrap().username.as_deref(), Some("testuser")); + assert_eq!(response.ip_check_finished, None); + } + + #[test] + fn completed_nano_banana_has_results() { + let response: JobStatusResponse = serde_json::from_str(NANO_BANANA_COMPLETED).unwrap(); + assert_eq!(response.status, JobStatus::Completed); + assert!(response.status.is_terminal()); + assert_eq!(response.ip_check_finished, Some(true)); + assert_eq!(response.ip_detected, Some(false)); + + let results = response.results.as_ref().unwrap(); + assert_eq!(results.raw.media_type, JobMediaType::Image); + assert!(results.raw.url.ends_with(".png")); + assert!(results.min.url.ends_with("_min.webp")); + assert_eq!(response.result_url(), Some(results.raw.url.as_str())); + + // The server re-derived the size at completion. + assert_eq!((response.params.width, response.params.height), (Some(5504), Some(3072))); + } + + #[test] + fn in_progress_gpt_image_parses() { + let response: JobStatusResponse = serde_json::from_str(GPT_IMAGE_IN_PROGRESS).unwrap(); + assert_eq!(response.job_set_type, JobSetType::GptImage2); + assert_eq!(response.params.quality, Some(ImageQuality::High)); + assert_eq!(response.cluster_hash.as_deref(), Some("d8cd56aedaaaeedac3a5ed262f5eed0e")); + } + + #[test] + fn completed_gpt_image_min_may_equal_raw() { + let response: JobStatusResponse = serde_json::from_str(GPT_IMAGE_COMPLETED).unwrap(); + assert_eq!(response.status, JobStatus::Completed); + let results = response.results.unwrap(); + assert_eq!(results.raw.url, results.min.url); + } + + #[test] + fn unknown_status_does_not_fail_parsing() { + let json = NANO_BANANA_IN_PROGRESS.replace("\"status\":\"in_progress\"", "\"status\":\"some_new_state\""); + let response: JobStatusResponse = serde_json::from_str(&json).unwrap(); + assert_eq!(response.status, JobStatus::Other("some_new_state".to_string())); + } + + // ── Live (ignored: needs a real session and a real job id) ── + + /// Drives the binding off the desktop app's saved Higgsfield login + /// (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`) against + /// the job ids in `external/credentials/higgsfield/job_ids.txt`, printing + /// each full record. + #[tokio::test] + #[ignore] + async fn live_job_status_from_app_credential() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_job_ids; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("minting a session token failed: {err}"))?; + + for job_id in load_higgsfield_test_job_ids()? { + let response = job_status(JobStatusArgs { + request: JobStatusRequest { job_id: job_id.clone() }, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("job {job_id}: {err}"))?; + + println!("\n===== /fnf/jobs/{job_id} =====\n{:#?}", response); + println!("result_url = {:?}", response.result_url()); + + assert_eq!(response.id, job_id); + assert!(response.status.is_terminal(), "job {job_id} should be done by now, got {}", response.status); + if response.status.is_success() { + assert!(response.result_url().is_some(), "completed job {job_id} should have a result url"); + } + } + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn live_job_status() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::{load_higgsfield_test_auth, load_higgsfield_test_job_id}; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let job_id = load_higgsfield_test_job_id()?; + let response = job_status(JobStatusArgs { + request: JobStatusRequest { job_id }, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Job {} status={} results={:?}", response.id, response.status, response.results); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/jobs/job_status_batch.rs b/crates/api_clients/higgsfield_client/src/endpoints/jobs/job_status_batch.rs new file mode 100644 index 00000000..603a5f08 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/jobs/job_status_batch.rs @@ -0,0 +1,177 @@ +//! POST `/fnf/jobs/status-batch` — lightweight status for many jobs at once. +//! Returns just the status (no params or results); use +//! [`job_status`](crate::endpoints::jobs::job_status) to fetch a finished +//! job's outputs. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::JobId; +use crate::types::job_set_type::JobSetType; +use crate::types::job_status::JobStatus; +use serde::{Deserialize, Serialize}; + +const PATH: &str = "/fnf/jobs/status-batch"; + +pub struct JobStatusBatchArgs<'a> { + pub request: JobStatusBatchRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug, Serialize)] +pub struct JobStatusBatchRequest { + pub ids: Vec, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct JobStatusBatchResponse { + /// One entry per known job, in the order the server chose. + pub items: Vec, + + /// Requested ids the server doesn't know. + #[serde(default)] + pub missing: Vec, +} + +impl JobStatusBatchResponse { + pub fn find(&self, job_id: &JobId) -> Option<&JobStatusBatchItem> { + self.items.iter().find(|item| &item.id == job_id) + } +} + +#[derive(Clone, Debug, Deserialize)] +pub struct JobStatusBatchItem { + pub id: JobId, + + pub status: JobStatus, + + #[serde(default)] + pub job_set_type: Option, + + #[serde(default)] + pub ip_check_finished: Option, + + #[serde(default)] + pub ip_detected: Option, +} + +pub async fn job_status_batch(args: JobStatusBatchArgs<'_>) -> Result { + if args.request.ids.is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("ids is empty".to_string()).into()); + } + + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&args.request)).await +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::Value; + + // Captured, with ids scrubbed. + const IN_PROGRESS_RESPONSE: &str = r#"{"items":[{"id":"00000000-0000-0000-0000-00000000cccc","status":"in_progress","ip_check_finished":null,"ip_detected":null,"job_set_type":"nano_banana_2"}],"missing":[]}"#; + + #[test] + fn wire_body_matches_captured_request() { + let request = JobStatusBatchRequest { ids: vec![JobId::new("00000000-0000-0000-0000-00000000cccc")] }; + let actual: Value = serde_json::to_value(&request).unwrap(); + let expected: Value = serde_json::from_str(r#"{"ids":["00000000-0000-0000-0000-00000000cccc"]}"#).unwrap(); + assert_eq!(actual, expected); + } + + #[test] + fn response_parses() { + let response: JobStatusBatchResponse = serde_json::from_str(IN_PROGRESS_RESPONSE).unwrap(); + assert_eq!(response.items.len(), 1); + assert!(response.missing.is_empty()); + + let job_id = JobId::new("00000000-0000-0000-0000-00000000cccc"); + let item = response.find(&job_id).unwrap(); + assert_eq!(item.status, JobStatus::InProgress); + assert_eq!(item.job_set_type, Some(JobSetType::NanoBanana2)); + assert!(response.find(&JobId::new("nope")).is_none()); + } + + #[test] + fn missing_ids_parse() { + let json = r#"{"items":[],"missing":["00000000-0000-0000-0000-00000000ffff"]}"#; + let response: JobStatusBatchResponse = serde_json::from_str(json).unwrap(); + assert!(response.items.is_empty()); + assert_eq!(response.missing, vec![JobId::new("00000000-0000-0000-0000-00000000ffff")]); + } + + #[tokio::test] + async fn empty_ids_fails_before_any_http() { + let auth = HiggsfieldAuth::new("token"); + let host = HiggsfieldHost::Custom("http://127.0.0.1:9".to_string()); + let err = job_status_batch(JobStatusBatchArgs { + request: JobStatusBatchRequest { ids: vec![] }, + auth: &auth, + host: &host, + }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + // ── Live (ignored: needs a real session and a real job id) ── + + /// Drives the binding off the desktop app's saved Higgsfield login + /// (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`) against + /// the job ids in `external/credentials/higgsfield/job_ids.txt` — plus one + /// made-up id, to show the `missing` list working — printing the whole + /// response. + #[tokio::test] + #[ignore] + async fn live_job_status_batch_from_app_credential() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_job_ids; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("minting a session token failed: {err}"))?; + + let unknown = JobId::new("00000000-0000-4000-8000-000000000000"); + let mut ids = load_higgsfield_test_job_ids()?; + ids.push(unknown.clone()); + + let response = job_status_batch(JobStatusBatchArgs { + request: JobStatusBatchRequest { ids: ids.clone() }, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("\n===== /fnf/jobs/status-batch ({} ids) =====\n{:#?}", ids.len(), response); + for item in &response.items { + println!("{} => {} ({:?})", item.id, item.status, item.job_set_type); + } + println!("missing => {:?}", response.missing); + + for job_id in load_higgsfield_test_job_ids()? { + let item = response.find(&job_id).unwrap_or_else(|| panic!("known job {job_id} absent from batch response")); + assert!(item.status.is_terminal(), "job {job_id} should be done by now, got {}", item.status); + } + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn live_job_status_batch() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::{load_higgsfield_test_auth, load_higgsfield_test_job_id}; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let job_id = load_higgsfield_test_job_id()?; + let response = job_status_batch(JobStatusBatchArgs { + request: JobStatusBatchRequest { ids: vec![job_id] }, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Batch status: {:?}", response); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/jobs/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/jobs/mod.rs new file mode 100644 index 00000000..39c533c0 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/jobs/mod.rs @@ -0,0 +1,2 @@ +pub mod job_status; +pub mod job_status_batch; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_audio_upload.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_audio_upload.rs new file mode 100644 index 00000000..578d5599 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_audio_upload.rs @@ -0,0 +1,71 @@ +//! POST `/fnf/audio/{id}/upload` — tell the gateway an audio slot has its +//! bytes. The web app sends no body fields of its own. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::endpoints::media::confirm_media_upload::ConfirmMediaUploadResponse; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::MediaId; +use serde::Serialize; + +pub struct ConfirmAudioUploadArgs<'a> { + pub request: ConfirmAudioUploadRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug)] +pub struct ConfirmAudioUploadRequest { + pub media_id: MediaId, +} + +impl ConfirmAudioUploadRequest { + pub fn new(media_id: MediaId) -> Self { + Self { media_id } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.media_id.as_str().trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("media_id is empty".to_string())); + } + Ok(()) + } + + fn path(&self) -> String { + format!("/fnf/audio/{}/upload", self.media_id) + } +} + +/// Confirm the upload. The response has the same shape as the image +/// confirm (`{id, status, ip_check_finished}`). +pub async fn confirm_audio_upload(args: ConfirmAudioUploadArgs<'_>) -> Result { + args.request.validate()?; + send_json_request(HttpMethod::Post, &args.request.path(), args.auth, args.host, Some(&EmptyBody {})).await +} + +// ── Wire format ── + +/// `{}` — the web app spreads its (empty) `extra` here. +#[derive(Serialize)] +struct EmptyBody {} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn path_and_body_match_the_web_apps_adapter() { + let request = ConfirmAudioUploadRequest::new(MediaId::new("00000000-0000-4000-8000-0000000000dd")); + assert_eq!(request.path(), "/fnf/audio/00000000-0000-4000-8000-0000000000dd/upload"); + let body: Value = serde_json::to_value(EmptyBody {}).unwrap(); + assert_eq!(body, json!({})); + } + + #[test] + fn validation() { + assert!(matches!(ConfirmAudioUploadRequest::new(MediaId::new(" ")).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_media_upload.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_media_upload.rs new file mode 100644 index 00000000..ca582f35 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_media_upload.rs @@ -0,0 +1,174 @@ +//! POST `/fnf/media/{id}/upload` — tell the gateway a presigned slot has its +//! bytes. Until this is called the media doesn't exist as far as generation +//! requests are concerned. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::{JobId, MediaId}; +use crate::types::string_enum::string_enum; +use serde::{Deserialize, Serialize}; +use serde_json::Value; + +pub struct ConfirmMediaUploadArgs<'a> { + pub request: ConfirmMediaUploadRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug)] +pub struct ConfirmMediaUploadRequest { + pub media_id: MediaId, + + /// The original file name, shown in the web app's media library. + pub filename: String, + + /// The web app always sends `true`. + pub force_nsfw_check: bool, + + /// The web app sends `false`. + pub force_ip_check: bool, + + /// The web app passes a job id when the "upload" is really a previous + /// generation being registered as reference media. Omitted otherwise. + pub maybe_job_id: Option, +} + +impl ConfirmMediaUploadRequest { + /// The web app's defaults (NSFW check on, IP check off). + pub fn new(media_id: MediaId, filename: impl Into) -> Self { + Self { media_id, filename: filename.into(), force_nsfw_check: true, force_ip_check: false, maybe_job_id: None } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.media_id.as_str().trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("media_id is empty".to_string())); + } + if self.filename.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("filename is empty".to_string())); + } + Ok(()) + } + + fn path(&self) -> String { + format!("/fnf/media/{}/upload", self.media_id) + } + + fn to_body(&self) -> ConfirmMediaUploadBody<'_> { + ConfirmMediaUploadBody { + maybe_job_id: self.maybe_job_id.as_ref(), + filename: &self.filename, + force_nsfw_check: self.force_nsfw_check, + force_ip_check: self.force_ip_check, + } + } +} + +string_enum! { + /// Where the media is in its lifecycle. + MediaUploadStatus { + /// Usable as a reference. + Uploaded => "uploaded", + + /// The IP / likeness check flagged the file as protected content (a + /// recognised public figure or copyrighted still — observed live on + /// photos of Jim Varney as Ernest). The media stays listed but every + /// generation that references it answers `404 "Media input not + /// found"`; the web app shows "Protected content is not allowed". + IpDetected => "ip_detected", + + Pending => "pending", + Failed => "failed", + } +} + +impl MediaUploadStatus { + /// The server will refuse this media in generation requests. + pub fn is_blocked(&self) -> bool { + matches!(self, Self::IpDetected | Self::Failed) + } +} + +#[derive(Clone, Debug, Deserialize)] +pub struct ConfirmMediaUploadResponse { + pub id: MediaId, + + pub status: MediaUploadStatus, + + /// `null` until the IP check has run (it runs asynchronously, and only + /// when requested). + #[serde(default)] + pub ip_check_finished: Option, + + #[serde(flatten)] + pub extra: serde_json::Map, +} + +impl ConfirmMediaUploadResponse { + pub fn is_uploaded(&self) -> bool { + self.status == MediaUploadStatus::Uploaded + } + + /// Flagged as protected content; see [`MediaUploadStatus::IpDetected`]. + pub fn is_ip_detected(&self) -> bool { + self.status == MediaUploadStatus::IpDetected + } +} + +/// Confirm the upload. On success the file can be referenced from +/// generation requests immediately. +pub async fn confirm_media_upload(args: ConfirmMediaUploadArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, &args.request.path(), args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct ConfirmMediaUploadBody<'a> { + #[serde(rename = "job_id", skip_serializing_if = "Option::is_none")] + maybe_job_id: Option<&'a JobId>, + filename: &'a str, + force_nsfw_check: bool, + force_ip_check: bool, +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::json; + + #[test] + fn wire_body_and_path_match_captured_request() { + let request = ConfirmMediaUploadRequest::new(MediaId::new("00000000-0000-4000-8000-0000000000aa"), "shiba_ref.png"); + assert_eq!(request.path(), "/fnf/media/00000000-0000-4000-8000-0000000000aa/upload"); + let actual: Value = serde_json::to_value(request.to_body()).unwrap(); + assert_eq!(actual, json!({"filename": "shiba_ref.png", "force_nsfw_check": true, "force_ip_check": false})); + } + + #[test] + fn validation() { + assert!(matches!(ConfirmMediaUploadRequest::new(MediaId::new(""), "a.png").validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert!(matches!(ConfirmMediaUploadRequest::new(MediaId::new("m"), " ").validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn response_parses() { + let response: ConfirmMediaUploadResponse = serde_json::from_str(r#"{"id":"00000000-0000-4000-8000-0000000000aa","status":"uploaded","ip_check_finished":null}"#).unwrap(); + assert!(response.is_uploaded()); + assert_eq!(response.ip_check_finished, None); + + // Live 2026-08-31: a photo of a public figure, confirmed with force_ip_check. + let flagged: ConfirmMediaUploadResponse = serde_json::from_str(r#"{"id":"00000000-0000-4000-8000-0000000000ab","ip_check_finished":true,"status":"ip_detected"}"#).unwrap(); + assert!(flagged.is_ip_detected()); + assert!(flagged.status.is_blocked()); + assert!(!flagged.is_uploaded()); + + let unknown: ConfirmMediaUploadResponse = serde_json::from_str(r#"{"id":"x","status":"quarantined","ip_check_finished":true,"note":"n"}"#).unwrap(); + assert_eq!(unknown.status, MediaUploadStatus::Other("quarantined".to_string())); + assert!(unknown.extra.contains_key("note")); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_video_upload.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_video_upload.rs new file mode 100644 index 00000000..ace45dc9 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/confirm_video_upload.rs @@ -0,0 +1,135 @@ +//! POST `/fnf/video/{id}/upload` — tell the gateway a video slot has its +//! bytes. Optionally trims the clip (`?start_seconds=&end_seconds=`). + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::endpoints::media::confirm_media_upload::ConfirmMediaUploadResponse; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::MediaId; +use serde::Serialize; + +pub struct ConfirmVideoUploadArgs<'a> { + pub request: ConfirmVideoUploadRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug)] +pub struct ConfirmVideoUploadRequest { + pub media_id: MediaId, + + /// The web app sends `true`. + pub force_nsfw_check: bool, + + /// Omitted by the web app unless set. + pub maybe_force_ip_check: Option, + + /// Trim: keep from this offset (seconds). Sent as a query parameter. + pub maybe_start_seconds: Option, + + /// Trim: keep up to this offset (seconds). Sent as a query parameter. + pub maybe_end_seconds: Option, +} + +impl ConfirmVideoUploadRequest { + /// The web app's defaults (NSFW check on, no trim). + pub fn new(media_id: MediaId) -> Self { + Self { media_id, force_nsfw_check: true, maybe_force_ip_check: None, maybe_start_seconds: None, maybe_end_seconds: None } + } + + /// Keep only `[start, end]` seconds of the clip. + pub fn trimmed(mut self, start_seconds: f64, end_seconds: f64) -> Self { + self.maybe_start_seconds = Some(start_seconds); + self.maybe_end_seconds = Some(end_seconds); + self + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.media_id.as_str().trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("media_id is empty".to_string())); + } + if let (Some(start), Some(end)) = (self.maybe_start_seconds, self.maybe_end_seconds) { + if !(start >= 0.0 && end > start) { + return Err(HiggsfieldClientError::InvalidRequest(format!("trim range {start}..{end} is not 0 <= start < end"))); + } + } + Ok(()) + } + + fn path(&self) -> String { + let mut path = format!("/fnf/video/{}/upload", self.media_id); + let mut query = Vec::new(); + if let Some(start) = self.maybe_start_seconds { + query.push(format!("start_seconds={start}")); + } + if let Some(end) = self.maybe_end_seconds { + query.push(format!("end_seconds={end}")); + } + if !query.is_empty() { + path.push('?'); + path.push_str(&query.join("&")); + } + path + } + + fn to_body(&self) -> ConfirmVideoUploadBody { + ConfirmVideoUploadBody { force_nsfw_check: self.force_nsfw_check, maybe_force_ip_check: self.maybe_force_ip_check } + } +} + +/// Confirm the upload. The response is the image confirm's shape (`{id, +/// status, ip_check_finished}`) plus the clip's probed metadata (`duration`, +/// `frame_rate`, `frames_count`, `width`, `height`, `size_bytes`, +/// `thumbnail_url`, `url`) in `extra`. +pub async fn confirm_video_upload(args: ConfirmVideoUploadArgs<'_>) -> Result { + args.request.validate()?; + let body = args.request.to_body(); + send_json_request(HttpMethod::Post, &args.request.path(), args.auth, args.host, Some(&body)).await +} + +// ── Wire format ── + +#[derive(Serialize)] +struct ConfirmVideoUploadBody { + force_nsfw_check: bool, + #[serde(rename = "force_ip_check", skip_serializing_if = "Option::is_none")] + maybe_force_ip_check: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn path_and_body_match_the_web_apps_adapter() { + let request = ConfirmVideoUploadRequest::new(MediaId::new("00000000-0000-4000-8000-0000000000cc")); + assert_eq!(request.path(), "/fnf/video/00000000-0000-4000-8000-0000000000cc/upload"); + let body: Value = serde_json::to_value(request.to_body()).unwrap(); + assert_eq!(body, json!({"force_nsfw_check": true})); + + let mut trimmed = request.clone().trimmed(1.5, 4.0); + trimmed.maybe_force_ip_check = Some(false); + assert_eq!(trimmed.path(), "/fnf/video/00000000-0000-4000-8000-0000000000cc/upload?start_seconds=1.5&end_seconds=4"); + let body: Value = serde_json::to_value(trimmed.to_body()).unwrap(); + assert_eq!(body, json!({"force_nsfw_check": true, "force_ip_check": false})); + } + + #[test] + fn response_parses() { + // Live 2026-08-31 (ids / hosts scrubbed), confirmed with force_ip_check. + let response: ConfirmMediaUploadResponse = serde_json::from_str(r#"{"duration":1.0,"frame_rate":25.0,"frames_count":25,"height":64,"id":"00000000-0000-4000-8000-0000000000cc","ip_check_finished":false,"size":2246,"size_bytes":2246,"status":"uploaded","thumbnail_url":"https://cdn.example.com/00000000-0000-4000-8000-0000000000cc_thumb.webp","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000cc.mp4","width":64}"#).unwrap(); + assert!(response.is_uploaded()); + assert_eq!(response.ip_check_finished, Some(false)); + assert_eq!(response.extra.get("frames_count"), Some(&Value::from(25))); + } + + #[test] + fn validation() { + assert!(matches!(ConfirmVideoUploadRequest::new(MediaId::new("")).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + let backwards = ConfirmVideoUploadRequest::new(MediaId::new("m")).trimmed(4.0, 1.0); + assert!(matches!(backwards.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/create_audio_upload.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/create_audio_upload.rs new file mode 100644 index 00000000..6b04a24c --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/create_audio_upload.rs @@ -0,0 +1,134 @@ +//! POST `/fnf/audio` — allocate an upload slot for an audio track. Keyed by +//! file extension rather than MIME type; the web app only presigns `wav`, +//! `mp3` and `webm`. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::presigned_media_upload::PresignedMediaUpload; +use crate::types::string_enum::string_enum; +use serde::Serialize; + +const PATH: &str = "/fnf/audio"; + +string_enum! { + /// The audio formats the web app will presign ("Audio uploads support + /// only wav, mp3 or webm"). + AudioUploadExtension { + Wav => "wav", + Mp3 => "mp3", + Webm => "webm", + } +} + +impl AudioUploadExtension { + /// The extension for an audio MIME type, if it's one the web app takes. + pub fn for_mime_type(mime_type: &MediaMimeType) -> Option { + match mime_type { + MediaMimeType::AudioWav | MediaMimeType::AudioXWav => Some(Self::Wav), + MediaMimeType::AudioMpeg => Some(Self::Mp3), + MediaMimeType::AudioWebm => Some(Self::Webm), + _ => None, + } + } +} + +pub struct CreateAudioUploadArgs<'a> { + pub request: CreateAudioUploadRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug, Serialize)] +pub struct CreateAudioUploadRequest { + pub extension: AudioUploadExtension, + + /// The file name (the web app falls back to `upload.`). + pub name: String, +} + +impl CreateAudioUploadRequest { + pub fn new(extension: AudioUploadExtension, name: impl Into) -> Self { + Self { extension, name: name.into() } + } + + /// With the web app's fallback name. + pub fn unnamed(extension: AudioUploadExtension) -> Self { + let name = format!("upload.{extension}"); + Self { extension, name } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.name.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("name is empty".to_string())); + } + Ok(()) + } +} + +/// Allocate the slot. NB: the slot's `content_type` is what the server +/// chose (`audio/x-wav` for a `wav`); `PUT` with that. Next: +/// `upload_media_bytes`, then `confirm_audio_upload`. +pub async fn create_audio_upload(args: CreateAudioUploadArgs<'_>) -> Result { + args.request.validate()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&args.request)).await +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn wire_body_matches_the_web_apps_adapter() { + let actual: Value = serde_json::to_value(CreateAudioUploadRequest::new(AudioUploadExtension::Wav, "tone_1s.wav")).unwrap(); + assert_eq!(actual, json!({"extension": "wav", "name": "tone_1s.wav"})); + let unnamed: Value = serde_json::to_value(CreateAudioUploadRequest::unnamed(AudioUploadExtension::Mp3)).unwrap(); + assert_eq!(unnamed, json!({"extension": "mp3", "name": "upload.mp3"})); + } + + #[test] + fn extension_from_mime_type() { + assert_eq!(AudioUploadExtension::for_mime_type(&MediaMimeType::AudioWav), Some(AudioUploadExtension::Wav)); + assert_eq!(AudioUploadExtension::for_mime_type(&MediaMimeType::AudioMpeg), Some(AudioUploadExtension::Mp3)); + assert_eq!(AudioUploadExtension::for_mime_type(&MediaMimeType::AudioAac), None); + assert_eq!(AudioUploadExtension::for_mime_type(&MediaMimeType::VideoMp4), None); + } + + #[test] + fn validation() { + assert!(matches!(CreateAudioUploadRequest::new(AudioUploadExtension::Wav, " ").validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn response_parses() { + // Live 2026-08-31 (ids / signatures scrubbed): note `audio/x-wav`. + let json = r#"{"content_type":"audio/x-wav","id":"00000000-0000-4000-8000-0000000000dd","upload_url":"https://input-bucket.s3.amazonaws.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000dd.wav?X-Amz-Signature=deadbeef","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000dd.wav"}"#; + let slot: PresignedMediaUpload = serde_json::from_str(json).unwrap(); + assert_eq!(slot.content_type, MediaMimeType::AudioXWav); + assert!(slot.url.ends_with(".wav")); + } + + // ── Live (ignored: needs captured cookies; free) ── + + #[tokio::test] + #[ignore] + async fn live_create_audio_upload_slot() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let slot = create_audio_upload(CreateAudioUploadArgs { + request: CreateAudioUploadRequest::new(AudioUploadExtension::Wav, "tone_1s.wav"), + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("Allocated audio slot {} at {} ({})", slot.id, slot.url, slot.content_type); + assert!(slot.content_type.is_audio()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/create_media_batch.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/create_media_batch.rs new file mode 100644 index 00000000..93112c02 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/create_media_batch.rs @@ -0,0 +1,152 @@ +//! POST `/fnf/media/batch` — allocate upload slots for several image files +//! at once. This is the presign the video generator's frame and reference +//! pickers use (also for a single file). Images only: the server's 422 +//! lists jpeg / jpg / png / webp / gif / heic / heif / avif. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::presigned_media_upload::PresignedMediaUpload; +use crate::types::string_enum::string_enum; +use serde::Serialize; + +const PATH: &str = "/fnf/media/batch"; + +string_enum! { + /// Where an upload comes from, as the server files it. The generators' + /// pickers send `user_upload`; the rest are the server's 422 list + /// (other surfaces of the web app). + MediaUploadSource { + UserUpload => "user_upload", + Grid => "grid", + Inpaint => "inpaint", + ElementUpload => "elem_upload", + Ignore => "ignore", + ColorGrade => "color_grade", + Chat => "chat", + Community => "community", + MarketingStudioProduct => "ms_product", + MarketingStudioAvatar => "ms_avatar", + MarketingStudioV2Logo => "ms_v2_logo", + Agent => "agent", + StoryboardPanel => "sb_panel", + SoulUpload => "soul_upload", + ViralHubRender => "viral_hub_render", + VideoFrame => "video_frame", + } +} + +impl Default for MediaUploadSource { + fn default() -> Self { + Self::UserUpload + } +} + +pub struct CreateMediaBatchArgs<'a> { + pub request: CreateMediaBatchRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug, Serialize)] +pub struct CreateMediaBatchRequest { + /// One entry per file, in order; the response has one slot per entry in + /// the same order. Image types only. + #[serde(rename = "mimetypes")] + pub mime_types: Vec, + + /// How the server files the upload; the generators send `user_upload`. + pub source: MediaUploadSource, + + /// Ask for an intellectual-property check up front. The web app sends + /// `false` here and lets the confirm step decide. + pub force_ip_check: bool, +} + +impl CreateMediaBatchRequest { + /// The web app's defaults (`source: user_upload`, `force_ip_check: + /// false`). + pub fn new(mime_types: Vec) -> Self { + Self { mime_types, source: MediaUploadSource::default(), force_ip_check: false } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.mime_types.is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("mime_types is empty".to_string())); + } + if let Some(non_image) = self.mime_types.iter().find(|mime| !mime.is_image()) { + return Err(HiggsfieldClientError::InvalidRequest(format!( + "/fnf/media/batch only presigns images; {non_image} must go through /fnf/reference-media", + ))); + } + Ok(()) + } +} + +/// Allocate the slots. Next, per slot: `PUT` the bytes to `upload_url` +/// (`upload_media_bytes`), then `confirm_media_upload`. +pub async fn create_media_batch(args: CreateMediaBatchArgs<'_>) -> Result, HiggsfieldError> { + args.request.validate()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&args.request)).await +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn wire_body_matches_captured_request() { + let request = CreateMediaBatchRequest::new(vec![MediaMimeType::ImagePng]); + let actual: Value = serde_json::to_value(request).unwrap(); + assert_eq!(actual, json!({"mimetypes": ["image/png"], "source": "user_upload", "force_ip_check": false})); + } + + #[test] + fn validation() { + assert!(matches!(CreateMediaBatchRequest::new(vec![]).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + // Live 2026-08-31: video/audio types are a 422 on this endpoint. + let err = CreateMediaBatchRequest::new(vec![MediaMimeType::ImagePng, MediaMimeType::VideoMp4]).validate().unwrap_err(); + assert!(err.to_string().contains("reference-media"), "{err}"); + assert!(CreateMediaBatchRequest::new(vec![MediaMimeType::ImageGif, MediaMimeType::ImageAvif]).validate().is_ok()); + } + + #[test] + fn response_parses() { + // Captured 2026-08-31 (ids and hosts scrubbed). + let json = r#"[{"id":"00000000-0000-4000-8000-0000000000bb","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000bb.png","upload_url":"https://input-bucket.s3.amazonaws.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000bb.png?X-Amz-Signature=deadbeef","content_type":"image/png"}]"#; + let slots: Vec = serde_json::from_str(json).unwrap(); + assert_eq!(slots.len(), 1); + assert_eq!(slots[0].to_media_input().id.as_str(), "00000000-0000-4000-8000-0000000000bb"); + } + + // ── Live (ignored: needs captured cookies; free) ── + + #[tokio::test] + #[ignore] + async fn live_create_media_batch_slots() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_session; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_test_session()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let slots = create_media_batch(CreateMediaBatchArgs { + request: CreateMediaBatchRequest::new(vec![MediaMimeType::ImagePng, MediaMimeType::ImageJpeg]), + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + for slot in &slots { + println!("Allocated media slot {} at {} (content_type {})", slot.id, slot.url, slot.content_type); + } + assert_eq!(slots.len(), 2); + assert_eq!(slots[0].content_type, MediaMimeType::ImagePng); + assert_eq!(slots[1].content_type, MediaMimeType::ImageJpeg); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/create_reference_media.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/create_reference_media.rs new file mode 100644 index 00000000..2f3b4cdd --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/create_reference_media.rs @@ -0,0 +1,82 @@ +//! POST `/fnf/reference-media` — allocate one upload slot. This is the +//! presign the image generator's reference picker uses. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::presigned_media_upload::PresignedMediaUpload; +use serde::Serialize; + +const PATH: &str = "/fnf/reference-media"; + +pub struct CreateReferenceMediaArgs<'a> { + pub request: CreateReferenceMediaRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug, Serialize)] +pub struct CreateReferenceMediaRequest { + /// The file's type; it becomes the slot's `content_type` and the CDN + /// URL's extension. + #[serde(rename = "mimetype")] + pub mime_type: MediaMimeType, +} + +impl CreateReferenceMediaRequest { + pub fn new(mime_type: MediaMimeType) -> Self { + Self { mime_type } + } +} + +/// Allocate a slot. Next: `PUT` the bytes to `upload_url` +/// (`upload_media_bytes`), then `confirm_media_upload`. +pub async fn create_reference_media(args: CreateReferenceMediaArgs<'_>) -> Result { + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&args.request)).await +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn wire_body_matches_captured_request() { + let actual: Value = serde_json::to_value(CreateReferenceMediaRequest::new(MediaMimeType::ImagePng)).unwrap(); + assert_eq!(actual, json!({"mimetype": "image/png"})); + } + + #[test] + fn response_parses() { + // Captured 2026-08-31 (ids and hosts scrubbed). + let json = r#"{"id":"00000000-0000-4000-8000-0000000000aa","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png","upload_url":"https://input-bucket.s3.amazonaws.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Signature=deadbeef","content_type":"image/png"}"#; + let slot: PresignedMediaUpload = serde_json::from_str(json).unwrap(); + assert_eq!(slot.id.as_str(), "00000000-0000-4000-8000-0000000000aa"); + assert!(slot.url.ends_with(".png")); + assert_eq!(slot.content_type, MediaMimeType::ImagePng); + } + + // ── Live (ignored: needs captured cookies; free) ── + + #[tokio::test] + #[ignore] + async fn live_create_reference_media_slot() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let slot = create_reference_media(CreateReferenceMediaArgs { + request: CreateReferenceMediaRequest::new(MediaMimeType::ImagePng), + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Allocated media slot {} at {} (content_type {})", slot.id, slot.url, slot.content_type); + assert!(slot.upload_url.starts_with("https://")); + assert_eq!(slot.content_type, MediaMimeType::ImagePng); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/create_video_upload.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/create_video_upload.rs new file mode 100644 index 00000000..eaf134b2 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/create_video_upload.rs @@ -0,0 +1,101 @@ +//! POST `/fnf/video` — allocate an upload slot for a video clip. (The +//! image presigns reject video types; this is the web app's video path.) + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::presigned_media_upload::PresignedMediaUpload; +use serde::Serialize; + +const PATH: &str = "/fnf/video"; + +pub struct CreateVideoUploadArgs<'a> { + pub request: CreateVideoUploadRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug, Serialize)] +pub struct CreateVideoUploadRequest { + /// The clip's type; the web app defaults to `video/mp4`. + #[serde(rename = "mimetype")] + pub mime_type: MediaMimeType, +} + +impl CreateVideoUploadRequest { + pub fn new(mime_type: MediaMimeType) -> Self { + Self { mime_type } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if !self.mime_type.is_video() { + return Err(HiggsfieldClientError::InvalidRequest(format!("/fnf/video presigns video clips, not {}", self.mime_type))); + } + Ok(()) + } +} + +impl Default for CreateVideoUploadRequest { + fn default() -> Self { + Self::new(MediaMimeType::VideoMp4) + } +} + +/// Allocate the slot (its `thumbnail_url` is where the server will put the +/// poster frame). Next: `PUT` the bytes to `upload_url` +/// (`upload_media_bytes`), then `confirm_video_upload`. +pub async fn create_video_upload(args: CreateVideoUploadArgs<'_>) -> Result { + args.request.validate()?; + send_json_request(HttpMethod::Post, PATH, args.auth, args.host, Some(&args.request)).await +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn wire_body_matches_the_web_apps_adapter() { + let actual: Value = serde_json::to_value(CreateVideoUploadRequest::default()).unwrap(); + assert_eq!(actual, json!({"mimetype": "video/mp4"})); + } + + #[test] + fn validation() { + assert!(matches!(CreateVideoUploadRequest::new(MediaMimeType::ImagePng).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert!(CreateVideoUploadRequest::new(MediaMimeType::VideoQuicktime).validate().is_ok()); + } + + #[test] + fn response_parses() { + // Live 2026-08-31 (ids / signatures scrubbed). + let json = r#"{"content_type":"video/mp4","id":"00000000-0000-4000-8000-0000000000cc","thumbnail_url":"https://cdn.example.com/00000000-0000-4000-8000-0000000000cc_thumb.webp","upload_url":"https://input-bucket.s3.amazonaws.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000cc.mp4?X-Amz-Signature=deadbeef","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000cc.mp4"}"#; + let slot: PresignedMediaUpload = serde_json::from_str(json).unwrap(); + assert_eq!(slot.content_type, MediaMimeType::VideoMp4); + assert!(slot.url.ends_with(".mp4")); + assert!(slot.thumbnail_url.is_some()); + } + + // ── Live (ignored: needs captured cookies; free) ── + + #[tokio::test] + #[ignore] + async fn live_create_video_upload_slot() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let slot = create_video_upload(CreateVideoUploadArgs { + request: CreateVideoUploadRequest::default(), + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("Allocated video slot {} at {} (thumbnail {:?})", slot.id, slot.url, slot.thumbnail_url); + assert_eq!(slot.content_type, MediaMimeType::VideoMp4); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/get_input_media.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/get_input_media.rs new file mode 100644 index 00000000..69a591ce --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/get_input_media.rs @@ -0,0 +1,113 @@ +//! GET `/fnf/input-images/{id}`, `/fnf/input-videos/{id}`, +//! `/fnf/input-audios/{id}` — look up an uploaded file's descriptor by id +//! (what the web app calls `getMedia`). Handy for re-using an upload from +//! an earlier session without keeping its URL around. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::MediaId; +use crate::types::media_input::{MediaInput, MediaInputKind}; +use serde::Deserialize; +use serde_json::Value; + +/// Which collection the id lives in (uploads are filed by family). +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum InputMediaFamily { + Image, + Video, + Audio, +} + +impl InputMediaFamily { + fn path_segment(self) -> &'static str { + match self { + Self::Image => "input-images", + Self::Video => "input-videos", + Self::Audio => "input-audios", + } + } +} + +pub struct GetInputMediaArgs<'a> { + pub request: GetInputMediaRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +#[derive(Clone, Debug)] +pub struct GetInputMediaRequest { + pub family: InputMediaFamily, + pub media_id: MediaId, +} + +impl GetInputMediaRequest { + pub fn new(family: InputMediaFamily, media_id: MediaId) -> Self { + Self { family, media_id } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.media_id.as_str().trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("media_id is empty".to_string())); + } + Ok(()) + } + + fn path(&self) -> String { + format!("/fnf/{}/{}", self.family.path_segment(), self.media_id) + } +} + +/// The descriptor plus whatever else the family reports (videos: `hls_url`, +/// `storyboard`, `width`/`height`; audio: `duration`, `waveform_url`, ...). +#[derive(Clone, Debug, Deserialize)] +pub struct GetInputMediaResponse { + pub id: MediaId, + + #[serde(rename = "type")] + pub kind: MediaInputKind, + + pub url: String, + + #[serde(flatten)] + pub extra: serde_json::Map, +} + +impl GetInputMediaResponse { + pub fn to_media_input(&self) -> MediaInput { + MediaInput { id: self.id.clone(), kind: self.kind.clone(), url: self.url.clone() } + } +} + +pub async fn get_input_media(args: GetInputMediaArgs<'_>) -> Result { + args.request.validate()?; + send_json_request(HttpMethod::Get, &args.request.path(), args.auth, args.host, None::<&()>).await +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn paths() { + let id = MediaId::new("00000000-0000-4000-8000-0000000000aa"); + assert_eq!(GetInputMediaRequest::new(InputMediaFamily::Image, id.clone()).path(), "/fnf/input-images/00000000-0000-4000-8000-0000000000aa"); + assert_eq!(GetInputMediaRequest::new(InputMediaFamily::Video, id.clone()).path(), "/fnf/input-videos/00000000-0000-4000-8000-0000000000aa"); + assert_eq!(GetInputMediaRequest::new(InputMediaFamily::Audio, id).path(), "/fnf/input-audios/00000000-0000-4000-8000-0000000000aa"); + assert!(matches!(GetInputMediaRequest::new(InputMediaFamily::Image, MediaId::new(" ")).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn responses_parse() { + // Live 2026-08-31 (ids / hosts scrubbed). + let image: GetInputMediaResponse = serde_json::from_str(r#"{"id":"00000000-0000-4000-8000-0000000000aa","type":"media_input","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png"}"#).unwrap(); + assert_eq!(image.to_media_input(), MediaInput::uploaded("00000000-0000-4000-8000-0000000000aa", "https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000aa.png")); + + // The audio confirm echoes the same record shape. + let audio: GetInputMediaResponse = serde_json::from_str(r#"{"id":"00000000-0000-4000-8000-0000000000dd","type":"audio_input","name":"tone_1s.wav","filename":"tone_1s.wav","url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000dd.wav","download_url":"https://cdn.example.com/user_TESTUSER0000000000000000000/00000000-0000-4000-8000-0000000000dd.wav?download=tone_1s.wav","user_id":"user_TESTUSER0000000000000000000","waveform_url":"https://waveforms.example.com/waveform/00000000-0000-4000-8000-0000000000ee.json","duration":1.0,"extension":"wav","size_bytes":16044,"prompt":null,"status":"uploaded","created_at":1788159896.552181,"uploaded_at":1788159896.552181,"last_used_at":null}"#).unwrap(); + assert_eq!(audio.kind, MediaInputKind::AudioInput); + assert_eq!(audio.extra.get("duration"), Some(&Value::from(1.0))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/get_media_status.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/get_media_status.rs new file mode 100644 index 00000000..1a7a7f02 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/get_media_status.rs @@ -0,0 +1,140 @@ +//! GET `/fnf/media/{id}` (images) / `GET /fnf/video/{id}` (clips) — an +//! uploaded file's processing state: whether the IP (intellectual +//! property) check has finished and, for images, whether a face was +//! detected. Poll this before handing media to models that insist on the +//! IP check (Seedance 2.x). Audio has no such record (`/fnf/audio/{id}` +//! is not a status endpoint) and no IP check. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::endpoints::media::confirm_media_upload::MediaUploadStatus; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::MediaId; +use serde::Deserialize; +use serde_json::Value; + +pub struct GetMediaStatusArgs<'a> { + pub request: GetMediaStatusRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// Uploads are filed by family, each with its own status path. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum MediaStatusFamily { + /// `/fnf/media/{id}` + Image, + /// `/fnf/video/{id}` + Video, +} + +#[derive(Clone, Debug)] +pub struct GetMediaStatusRequest { + pub family: MediaStatusFamily, + pub media_id: MediaId, +} + +impl GetMediaStatusRequest { + pub fn new(family: MediaStatusFamily, media_id: MediaId) -> Self { + Self { family, media_id } + } + + pub fn image(media_id: MediaId) -> Self { + Self::new(MediaStatusFamily::Image, media_id) + } + + pub fn video(media_id: MediaId) -> Self { + Self::new(MediaStatusFamily::Video, media_id) + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if self.media_id.as_str().trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("media_id is empty".to_string())); + } + Ok(()) + } + + fn path(&self) -> String { + match self.family { + MediaStatusFamily::Image => format!("/fnf/media/{}", self.media_id), + MediaStatusFamily::Video => format!("/fnf/video/{}", self.media_id), + } + } +} + +#[derive(Clone, Debug, Deserialize)] +pub struct GetMediaStatusResponse { + pub id: MediaId, + + pub status: MediaUploadStatus, + + /// `true` once the IP check has run; `null`/`false` while pending (or + /// never requested). + #[serde(default)] + pub ip_check_finished: Option, + + #[serde(default)] + pub ip_detected: Option, + + #[serde(default)] + pub is_face_detected: Option, + + #[serde(flatten)] + pub extra: serde_json::Map, +} + +impl GetMediaStatusResponse { + pub fn is_ip_check_finished(&self) -> bool { + self.ip_check_finished == Some(true) + } + + /// Flagged as protected content (see `MediaUploadStatus::IpDetected`). + pub fn is_ip_detected(&self) -> bool { + self.status == MediaUploadStatus::IpDetected + } +} + +pub async fn get_media_status(args: GetMediaStatusArgs<'_>) -> Result { + args.request.validate()?; + send_json_request(HttpMethod::Get, &args.request.path(), args.auth, args.host, None::<&()>).await +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn path_and_validation() { + let id = MediaId::new("00000000-0000-4000-8000-0000000000aa"); + assert_eq!(GetMediaStatusRequest::image(id.clone()).path(), "/fnf/media/00000000-0000-4000-8000-0000000000aa"); + assert_eq!(GetMediaStatusRequest::video(id).path(), "/fnf/video/00000000-0000-4000-8000-0000000000aa"); + assert!(matches!(GetMediaStatusRequest::image(MediaId::new("")).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn video_status_parses() { + // Live 2026-08-31 (id scrubbed): `/fnf/video/{id}` right after confirm. + let pending: GetMediaStatusResponse = serde_json::from_str(r#"{"id":"00000000-0000-4000-8000-0000000000cc","ip_check_finished":false,"status":"uploaded"}"#).unwrap(); + assert!(!pending.is_ip_check_finished()); + assert!(pending.is_face_detected.is_none()); + } + + #[test] + fn response_parses() { + // Live 2026-08-31 (id scrubbed), after confirming with force_ip_check. + let response: GetMediaStatusResponse = serde_json::from_str(r#"{"id":"00000000-0000-4000-8000-0000000000aa","ip_check_finished":true,"is_face_detected":false,"status":"uploaded"}"#).unwrap(); + assert!(response.is_ip_check_finished()); + assert_eq!(response.is_face_detected, Some(false)); + assert_eq!(response.status, MediaUploadStatus::Uploaded); + + let pending: GetMediaStatusResponse = serde_json::from_str(r#"{"id":"x","ip_check_finished":null,"status":"uploaded"}"#).unwrap(); + assert!(!pending.is_ip_check_finished()); + + // Live 2026-08-31: a public figure's photo. + let flagged: GetMediaStatusResponse = serde_json::from_str(r#"{"id":"x","ip_check_finished":true,"is_face_detected":true,"status":"ip_detected"}"#).unwrap(); + assert!(flagged.is_ip_detected()); + assert_eq!(flagged.is_face_detected, Some(true)); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/mod.rs new file mode 100644 index 00000000..7d071744 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/mod.rs @@ -0,0 +1,52 @@ +//! Uploading reference files (images, video, audio) for generation requests. +//! +//! An upload is three calls, mirroring the web app, with a presign + +//! confirm pair per file family: +//! +//! | Family | Presign | Confirm | Descriptor `type` | +//! |--------|-------------------------------------------|------------------------------|-------------------| +//! | image | [`create_reference_media`] (one) or [`create_media_batch`] (many) | [`confirm_media_upload`] | `media_input` | +//! | video | [`create_video_upload`] | [`confirm_video_upload`] | `video_input` | +//! | audio | [`create_audio_upload`] | [`confirm_audio_upload`] | `audio_input` | +//! +//! 1. Presign: the gateway allocates a [`MediaId`] and returns a CDN URL +//! plus a presigned storage URL. +//! 2. [`upload_media_bytes`] — `PUT` the raw bytes to the storage URL. +//! 3. Confirm — tell the gateway the bytes are there (and kick off its +//! NSFW / IP checks). +//! +//! Generation requests then reference the file by its +//! [`MediaInput`](crate::types::media_input::MediaInput) descriptor +//! (`{id, type, url}`) — never the bytes. +//! `HiggsfieldSession::upload_reference_media` does all three in one call +//! for any family. +//! +//! Some models (Seedance 2.x) refuse media whose intellectual-property +//! check hasn't run (`400 "IP check not finished for input media"`): +//! confirm with `force_ip_check: true` and poll [`get_media_status`] until +//! `ip_check_finished` — or set `ReferenceMediaFile::with_ip_check` and let +//! the session do it. [`get_input_media`] looks a descriptor up by id. +//! +//! [`get_media_status`]: get_media_status::get_media_status +//! [`get_input_media`]: get_input_media::get_input_media +//! +//! [`MediaId`]: crate::types::ids::MediaId +//! [`create_reference_media`]: create_reference_media::create_reference_media +//! [`create_media_batch`]: create_media_batch::create_media_batch +//! [`create_video_upload`]: create_video_upload::create_video_upload +//! [`create_audio_upload`]: create_audio_upload::create_audio_upload +//! [`upload_media_bytes`]: upload_media_bytes::upload_media_bytes +//! [`confirm_media_upload`]: confirm_media_upload::confirm_media_upload +//! [`confirm_video_upload`]: confirm_video_upload::confirm_video_upload +//! [`confirm_audio_upload`]: confirm_audio_upload::confirm_audio_upload + +pub mod confirm_audio_upload; +pub mod confirm_media_upload; +pub mod confirm_video_upload; +pub mod create_audio_upload; +pub mod create_media_batch; +pub mod create_reference_media; +pub mod create_video_upload; +pub mod get_input_media; +pub mod get_media_status; +pub mod upload_media_bytes; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/media/upload_media_bytes.rs b/crates/api_clients/higgsfield_client/src/endpoints/media/upload_media_bytes.rs new file mode 100644 index 00000000..554370fb --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/media/upload_media_bytes.rs @@ -0,0 +1,95 @@ +//! `PUT ` — send the file's bytes to the presigned storage URL +//! from a presign response. Not a gateway endpoint: no auth or host, the +//! signature in the URL is the credential. + +use crate::client::send_request::send_presigned_upload; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::presigned_media_upload::PresignedMediaUpload; + +pub struct UploadMediaBytesArgs<'a> { + pub request: UploadMediaBytesRequest, + + /// The capturing browser's UA, for the same reason as on the gateway + /// (the presign was issued to it). + pub maybe_user_agent: Option<&'a str>, +} + +#[derive(Clone, Debug)] +pub struct UploadMediaBytesRequest { + /// `PresignedMediaUpload::upload_url`. + pub upload_url: String, + + /// Must match the type the slot was presigned for. + pub content_type: MediaMimeType, + + pub bytes: Vec, +} + +impl UploadMediaBytesRequest { + pub fn for_slot(slot: &PresignedMediaUpload, bytes: Vec) -> Self { + Self { upload_url: slot.upload_url.clone(), content_type: slot.content_type.clone(), bytes } + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if !self.upload_url.starts_with("https://") { + return Err(HiggsfieldClientError::InvalidRequest("upload_url is not an https URL".to_string())); + } + if self.bytes.is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("no bytes to upload".to_string())); + } + Ok(()) + } +} + +/// Upload the bytes. Storage answers an empty `200`; the gateway doesn't +/// know about the file until `confirm_media_upload`. +pub async fn upload_media_bytes(args: UploadMediaBytesArgs<'_>) -> Result<(), HiggsfieldError> { + args.request.validate()?; + let UploadMediaBytesRequest { upload_url, content_type, bytes } = args.request; + send_presigned_upload(&upload_url, content_type.as_str(), bytes, args.maybe_user_agent).await +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::ids::MediaId; + + fn slot() -> PresignedMediaUpload { + PresignedMediaUpload { + id: MediaId::new("m1"), + url: "https://cdn.example.com/user_x/m1.png".to_string(), + upload_url: "https://bucket.s3.amazonaws.com/user_x/m1.png?X-Amz-Signature=abc".to_string(), + content_type: MediaMimeType::ImagePng, + thumbnail_url: None, + } + } + + #[test] + fn request_takes_type_and_url_from_the_slot() { + let request = UploadMediaBytesRequest::for_slot(&slot(), vec![1, 2, 3]); + assert_eq!(request.content_type, MediaMimeType::ImagePng); + assert!(request.upload_url.contains("X-Amz-Signature")); + assert!(request.validate().is_ok()); + } + + #[test] + fn validation() { + let empty = UploadMediaBytesRequest::for_slot(&slot(), vec![]); + assert!(matches!(empty.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + + let mut plain_http = UploadMediaBytesRequest::for_slot(&slot(), vec![1]); + plain_http.upload_url = "http://bucket.s3.amazonaws.com/x".to_string(); + assert!(matches!(plain_http.validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[tokio::test] + async fn rejects_before_network() { + let err = upload_media_bytes(UploadMediaBytesArgs { + request: UploadMediaBytesRequest::for_slot(&slot(), vec![]), + maybe_user_agent: None, + }).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/mod.rs new file mode 100644 index 00000000..2efb878b --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/mod.rs @@ -0,0 +1,5 @@ +pub mod auth; +pub mod generate; +pub mod jobs; +pub mod media; +pub mod user; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/user/mod.rs b/crates/api_clients/higgsfield_client/src/endpoints/user/mod.rs new file mode 100644 index 00000000..32ddc814 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/user/mod.rs @@ -0,0 +1,2 @@ +pub mod user_data; +pub mod user_profile; diff --git a/crates/api_clients/higgsfield_client/src/endpoints/user/user_data.rs b/crates/api_clients/higgsfield_client/src/endpoints/user/user_data.rs new file mode 100644 index 00000000..8b0f6875 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/user/user_data.rs @@ -0,0 +1,223 @@ +//! GET `/fnf/user` — the logged-in user's account: plan, credits, workspace, +//! and account status. Also the cheapest way to confirm a session is valid. + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::types::ids::{UserId, WorkspaceId}; +use serde::Deserialize; +use serde_json::Value; +use crate::types::string_enum::string_enum; + +const PATH: &str = "/fnf/user"; + +string_enum! { + /// The subscription plan. + PlanType { + Free => "free", + Basic => "basic", + Pro => "pro", + Plus => "plus", + Ultimate => "ultimate", + Creator => "creator", + Enterprise => "enterprise", + } +} + +string_enum! { + BillingPeriod { + Monthly => "monthly", + Yearly => "yearly", + } +} + +pub struct UserDataArgs<'a> { + pub request: UserDataRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// No parameters; kept for uniformity with the other endpoints. +#[derive(Clone, Debug, Default)] +pub struct UserDataRequest; + +/// The fields we rely on. The real payload has dozens more (per-feature +/// credit buckets, consent flags, promo state, ...); they're kept in `extra` +/// rather than typed, since they change often. +#[derive(Clone, Debug, Deserialize)] +pub struct UserDataResponse { + pub id: UserId, + + #[serde(default)] + pub email: Option, + + #[serde(default)] + pub plan_type: Option, + + #[serde(default)] + pub plan_version: Option, + + #[serde(default)] + pub billing_period: Option, + + /// RFC 3339 timestamp. + #[serde(default)] + pub plan_ends_at: Option, + + #[serde(default)] + pub subscription_credits: Option, + + #[serde(default)] + pub package_credits: Option, + + #[serde(default)] + pub daily_credits: Option, + + #[serde(default)] + pub total_plan_credits: Option, + + /// The plan includes an "unlimited" generation pool. + #[serde(default)] + pub has_unlim: bool, + + #[serde(default)] + pub has_flex_unlim: bool, + + #[serde(default)] + pub workspace_id: Option, + + /// e.g. `private`. + #[serde(default)] + pub workspace_type: Option, + + /// e.g. `owner`. + #[serde(default)] + pub workspace_role: Option, + + #[serde(default)] + pub lang: Option, + + #[serde(default)] + pub is_paused: bool, + + #[serde(default)] + pub is_test_user: bool, + + /// RFC 3339 timestamp; set when the account is blocked. + #[serde(default)] + pub blocked_at: Option, + + /// RFC 3339 timestamp; set when the account is suspended. + #[serde(default)] + pub suspended_at: Option, + + /// Everything not typed above, keyed by field name. + #[serde(flatten)] + pub extra: serde_json::Map, +} + +impl UserDataResponse { + /// Whether the account can generate (not blocked, suspended, or paused). + pub fn is_account_active(&self) -> bool { + self.blocked_at.is_none() && self.suspended_at.is_none() && !self.is_paused + } +} + +pub async fn user_data(args: UserDataArgs<'_>) -> Result { + send_json_request(HttpMethod::Get, PATH, args.auth, args.host, None::<&()>).await +} + +#[cfg(test)] +mod tests { + use super::*; + + /// Captured, with the id / email / timestamps scrubbed. + const USER_RESPONSE: &str = r#"{"id":"user_TESTUSER0000000000000000000","enterprise_new_main":false,"plan_type":"plus","subscription_credits":1200.0,"package_credits":6.0,"soul_credits":0.0,"wan2_5_video_credits":0.0,"text2keyframes_credits":0.0,"face_swap_credits":2.0,"qwen_camera_control_credits":0.0,"character_swap_credits":0.0,"daily_credits":6.0,"total_plan_credits":1200,"billing_period":"monthly","is_cancel_inited":false,"plan_ends_at":"2026-09-30T03:30:59+00:00","next_credit_allocation_at":null,"is_pro_plan_veo3_available":false,"cohort":"tier_1","promo_state":"inactive","has_unlim":true,"veo3_fast_generations_count":0,"auto_publish":false,"lang":"en","is_creator_partner_program":false,"pause_starts_at":null,"pause_resumes_at":null,"is_pause_scheduled":false,"is_paused":false,"is_gift_subscription":false,"workspace_id":"00000000-0000-0000-0000-00000000aaaa","workspace_type":"private","workspace_role":"owner","workspace_membership_exists":false,"blog_ip_check":false,"blog_collab":false,"subscription_downgrades_at":null,"last_daily_credits_awarded_at":"2026-08-31T03:26:11.951412+00:00","has_flex_unlim":true,"hide_reduced_nano_banana_2_concurrent":true,"unlim_battery":null,"blocked_at":null,"suspended_at":null,"email":"user@example.com","business_email":null,"block_reason":"other","appeal_applied_at":null,"plan_version":40,"show_generation_activity_notice":false,"verified_business_email":null,"is_test_user":false,"mcp_trial_ends_at":null,"trial_status":null,"consents":{"enabled":false,"terms_of_use":{"required_version":2,"accepted_version":2,"is_accepted":true},"biometric":{"required_version":1,"accepted_version":0,"is_accepted":false}},"cobalt":true}"#; + + #[test] + fn user_response_parses() { + let response: UserDataResponse = serde_json::from_str(USER_RESPONSE).unwrap(); + assert_eq!(response.id.as_str(), "user_TESTUSER0000000000000000000"); + assert_eq!(response.email.as_deref(), Some("user@example.com")); + assert_eq!(response.plan_type, Some(PlanType::Plus)); + assert_eq!(response.billing_period, Some(BillingPeriod::Monthly)); + assert_eq!(response.subscription_credits, Some(1200.0)); + assert_eq!(response.total_plan_credits, Some(1200.0)); + assert!(response.has_unlim); + assert_eq!(response.workspace_id.as_ref().unwrap().as_str(), "00000000-0000-0000-0000-00000000aaaa"); + assert_eq!(response.workspace_role.as_deref(), Some("owner")); + assert!(response.is_account_active()); + + // Untyped fields are still reachable. + assert_eq!(response.extra.get("cohort").and_then(|v| v.as_str()), Some("tier_1")); + assert!(response.extra.contains_key("consents")); + } + + #[test] + fn blocked_account_is_inactive() { + let json = USER_RESPONSE.replace("\"blocked_at\":null", "\"blocked_at\":\"2026-08-31T00:00:00+00:00\""); + let response: UserDataResponse = serde_json::from_str(&json).unwrap(); + assert!(!response.is_account_active()); + } + + #[test] + fn unknown_plan_parses_as_other() { + let json = USER_RESPONSE.replace("\"plan_type\":\"plus\"", "\"plan_type\":\"galactic\""); + let response: UserDataResponse = serde_json::from_str(&json).unwrap(); + assert_eq!(response.plan_type, Some(PlanType::Other("galactic".to_string()))); + } + + // ── Live (ignored: needs a real session) ── + + /// Drives the binding off the desktop app's saved Higgsfield login + /// (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`): mints a + /// Clerk token from the stored cookies, calls `/fnf/user`, and prints + /// everything that came back. + #[tokio::test] + #[ignore] + async fn live_user_data_from_app_credential() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("minting a session token failed: {err}"))?; + println!("Minted bearer token ({} chars); session {:?}", auth.bearer_token.len(), session.current_token().await.map(|t| t.session_id().to_string())); + + let response = user_data(UserDataArgs { + request: UserDataRequest, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("\n===== /fnf/user (typed) =====\n{:#?}", response); + println!("\n===== /fnf/user (extra, untyped) ====="); + for (key, value) in &response.extra { + println!("{key} = {value}"); + } + + assert!(response.email.is_some(), "expected an email on the account"); + assert!(response.workspace_id.is_some(), "expected a workspace id"); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn live_user_data() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let response = user_data(UserDataArgs { + request: UserDataRequest, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("User {} plan={:?} credits={:?}", response.id, response.plan_type, response.subscription_credits); + assert!(response.email.is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/endpoints/user/user_profile.rs b/crates/api_clients/higgsfield_client/src/endpoints/user/user_profile.rs new file mode 100644 index 00000000..1b41caaa --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/endpoints/user/user_profile.rs @@ -0,0 +1,157 @@ +//! GET `/fnf/user/profile` — the user's public profile (username, bio, +//! social handles). + +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::client::send_request::{send_json_request, HttpMethod}; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::error::higgsfield_error::HiggsfieldError; +use serde::Deserialize; +use serde_json::Value; + +const PATH: &str = "/fnf/user/profile"; + +pub struct UserProfileArgs<'a> { + pub request: UserProfileRequest, + pub auth: &'a HiggsfieldAuth, + pub host: &'a HiggsfieldHost, +} + +/// No parameters; kept for uniformity with the other endpoints. +#[derive(Clone, Debug, Default)] +pub struct UserProfileRequest; + +#[derive(Clone, Debug, Deserialize)] +pub struct UserProfileResponse { + pub username: String, + + #[serde(default)] + pub avatar_url: Option, + + #[serde(default)] + pub background_image_url: Option, + + #[serde(default)] + pub bio: Option, + + #[serde(default)] + pub headline: Option, + + #[serde(default)] + pub instagram_handle: Option, + + #[serde(default)] + pub twitter_handle: Option, + + #[serde(default)] + pub youtube_handle: Option, + + #[serde(default)] + pub tiktok_handle: Option, + + #[serde(default)] + pub location: Option, + + #[serde(default)] + pub badge: Option, + + #[serde(default)] + pub badges: Vec, + + #[serde(default)] + pub total_projects_views: i64, + + #[serde(default)] + pub total_projects_likes: i64, + + /// RFC 3339 timestamp. + #[serde(default)] + pub created_at: Option, + + /// RFC 3339 timestamp. + #[serde(default)] + pub updated_at: Option, +} + +pub async fn user_profile(args: UserProfileArgs<'_>) -> Result { + send_json_request(HttpMethod::Get, PATH, args.auth, args.host, None::<&()>).await +} + +#[cfg(test)] +mod tests { + use super::*; + + /// Captured, with the username / timestamps scrubbed. + const PROFILE_RESPONSE: &str = r#"{"username":"testuser","avatar_url":null,"background_image_url":null,"bio":null,"headline":null,"instagram_handle":null,"twitter_handle":null,"youtube_handle":null,"tiktok_handle":null,"location":null,"badge":null,"badges":[],"total_projects_views":0,"total_projects_likes":0,"created_at":"2026-08-31T03:26:11.944804Z","updated_at":"2026-08-31T03:28:31.443066Z"}"#; + + #[test] + fn profile_response_parses() { + let response: UserProfileResponse = serde_json::from_str(PROFILE_RESPONSE).unwrap(); + assert_eq!(response.username, "testuser"); + assert!(response.avatar_url.is_none()); + assert!(response.badges.is_empty()); + assert_eq!(response.total_projects_views, 0); + assert_eq!(response.created_at.as_deref(), Some("2026-08-31T03:26:11.944804Z")); + } + + #[test] + fn sparse_profile_parses() { + let response: UserProfileResponse = serde_json::from_str(r#"{"username":"x"}"#).unwrap(); + assert_eq!(response.username, "x"); + assert_eq!(response.total_projects_likes, 0); + } + + // ── Live (ignored: needs a real session) ── + + /// Drives the binding off the desktop app's saved Higgsfield login + /// (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`): mints a + /// Clerk token from the stored cookies, calls `/fnf/user/profile`, and + /// prints everything that came back. + #[tokio::test] + #[ignore] + async fn live_user_profile_from_app_credential() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_session_from_app_credential()?; + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("minting a session token failed: {err}"))?; + println!( + "Minted bearer token ({} chars); session {:?}; user-agent {:?}; datadome id present: {}", + auth.bearer_token.len(), + session.current_token().await.map(|t| t.session_id().to_string()), + session.maybe_user_agent(), + session.maybe_datadome_client_id().is_some(), + ); + + let response = user_profile(UserProfileArgs { + request: UserProfileRequest, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("\n===== /fnf/user/profile =====\n{:#?}", response); + + assert!(!response.username.is_empty(), "expected a username on the profile"); + assert!(response.created_at.is_some(), "expected a created_at timestamp"); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn live_user_profile() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_auth; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let auth = load_higgsfield_test_auth().await?; + let response = user_profile(UserProfileArgs { + request: UserProfileRequest, + auth: &auth, + host: &HiggsfieldHost::Higgsfield, + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("Profile: {:?}", response); + assert!(!response.username.is_empty()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/error/classify_higgsfield_http_error.rs b/crates/api_clients/higgsfield_client/src/error/classify_higgsfield_http_error.rs new file mode 100644 index 00000000..097c4a02 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/error/classify_higgsfield_http_error.rs @@ -0,0 +1,346 @@ +use crate::error::higgsfield_api_error::HiggsfieldApiError; +use crate::error::higgsfield_error::HiggsfieldError; +use cloudflare_errors::classify_cloudflare_response::classify_cloudflare_response; +use cloudflare_errors::cloudflare_response_signals::CloudflareResponseSignals; +use datadome_errors::classify_datadome_response::classify_datadome_response; +use datadome_errors::datadome_response_signals::DataDomeResponseSignals; + +/// Everything the transport knows about a response. Header fields are +/// optional so the status + body shortcut still works. +#[derive(Debug, Clone, Default)] +pub struct HttpResponseSignals<'a> { + pub status_code: u16, + pub body: &'a str, + pub maybe_server_header: Option<&'a str>, + pub maybe_cf_ray: Option<&'a str>, + pub maybe_cf_mitigated: Option<&'a str>, + pub maybe_x_datadome: Option<&'a str>, + pub maybe_x_dd_b: Option<&'a str>, + /// What was being requested, for log lines (e.g. the URL). + pub context: &'a str, +} + +/// Convert a non-2xx HTTP response into the most specific +/// [`HiggsfieldError`] we can classify. Returns `Ok(())` for 2xx. +/// +/// Bot protection is checked first: a DataDome or Cloudflare answer is not +/// an API error and must never be mistaken for one (a challenge page is a +/// 403 too). Those are logged here, at the level the protection crate +/// recommends, so every caller gets consistent logging for free. +pub fn classify_higgsfield_http_response(signals: &HttpResponseSignals<'_>) -> Result<(), HiggsfieldError> { + let status_code = signals.status_code; + let body = signals.body; + + if (200..300).contains(&status_code) { + return Ok(()); + } + + let datadome_signals = DataDomeResponseSignals::new(status_code, body) + .with_x_datadome(signals.maybe_x_datadome) + .with_x_dd_b(signals.maybe_x_dd_b); + if let Some(err) = classify_datadome_response(&datadome_signals) { + err.log(signals.context); + return Err(HiggsfieldApiError::DataDome(err).into()); + } + + let cloudflare_signals = CloudflareResponseSignals::new(status_code, body) + .with_server_header(signals.maybe_server_header) + .with_cf_ray(signals.maybe_cf_ray) + .with_cf_mitigated(signals.maybe_cf_mitigated); + if let Some(err) = classify_cloudflare_response(&cloudflare_signals) { + err.log(signals.context); + return Err(HiggsfieldApiError::Cloudflare(err).into()); + } + + let raw = || body.to_string(); + let reason = || extract_error_message(body).unwrap_or_else(|| body.to_string()); + + // Content moderation and credit exhaustion can arrive under several 4xx + // codes; classify by body first for those. + if (400..500).contains(&status_code) { + if body_indicates_moderation(body) { + return Err(HiggsfieldApiError::ContentModerated { reason: reason(), raw_http_body: raw() }.into()); + } + if status_code == 402 || body_indicates_insufficient_credits(body) { + return Err(HiggsfieldApiError::InsufficientCredits { reason: reason(), raw_http_body: raw() }.into()); + } + } + + let error = match status_code { + 400 => HiggsfieldApiError::BadRequest { reason: reason(), raw_http_body: raw() }, + 401 => HiggsfieldApiError::Unauthorized { raw_http_body: raw() }, + 403 => HiggsfieldApiError::Forbidden { reason: reason(), raw_http_body: raw() }, + 404 => HiggsfieldApiError::NotFound { raw_http_body: raw() }, + 422 => HiggsfieldApiError::UnprocessableEntity { reason: reason(), raw_http_body: raw() }, + 429 => HiggsfieldApiError::RateLimited { raw_http_body: raw() }, + 500..=599 => HiggsfieldApiError::ServerError { status_code, raw_http_body: raw() }, + _ => HiggsfieldApiError::UnknownHttpFailure { status_code, raw_http_body: raw() }, + }; + + Err(error.into()) +} + +/// Status + body shortcut over [`classify_higgsfield_http_response`]. +pub fn classify_higgsfield_http_error(status_code: u16, maybe_body: Option<&str>) -> Result<(), HiggsfieldError> { + classify_higgsfield_http_response(&HttpResponseSignals { + status_code, + body: maybe_body.unwrap_or(""), + context: "higgsfield", + ..Default::default() + }) +} + +/// The gateway is FastAPI-flavored: errors usually look like +/// `{"detail": "..."}`, `{"detail": [{"msg": "..."}]}`, `{"message": "..."}` +/// or `{"error": "..."}` / `{"error": {"message": "..."}}`. Clerk's frontend +/// API uses `{"errors": [{"message", "long_message", "code"}]}`. +fn extract_error_message(body: &str) -> Option { + let parsed: serde_json::Value = serde_json::from_str(body).ok()?; + + if let Some(errors) = parsed.get("errors").and_then(|v| v.as_array()) { + let messages = errors.iter() + .filter_map(|item| { + item.get("long_message").or_else(|| item.get("message")).and_then(|v| v.as_str()) + }) + .collect::>(); + if !messages.is_empty() { + return Some(messages.join("; ")); + } + } + + for key in ["detail", "message", "error"] { + let Some(value) = parsed.get(key) else { continue }; + match value { + serde_json::Value::String(s) => return Some(s.clone()), + serde_json::Value::Object(obj) => { + if let Some(msg) = obj.get("message").or_else(|| obj.get("msg")).and_then(|v| v.as_str()) { + return Some(msg.to_string()); + } + } + serde_json::Value::Array(items) => { + let messages = items.iter() + .filter_map(|item| item.get("msg").and_then(|v| v.as_str())) + .collect::>(); + if !messages.is_empty() { + return Some(messages.join("; ")); + } + } + _ => {} + } + } + + None +} + +fn body_indicates_moderation(body: &str) -> bool { + let lower = body.to_lowercase(); + lower.contains("moderat") + || lower.contains("nsfw") + || lower.contains("content policy") + || lower.contains("content_policy") + || lower.contains("safety") + || lower.contains("prohibited") +} + +fn body_indicates_insufficient_credits(body: &str) -> bool { + let lower = body.to_lowercase(); + (lower.contains("credit") || lower.contains("balance")) + && (lower.contains("insufficient") || lower.contains("not enough") || lower.contains("enough")) +} + +#[cfg(test)] +mod tests { + use super::*; + use cloudflare_errors::cloudflare_error::CloudflareError; + use datadome_errors::datadome_error::DataDomeError; + + // ── Success ── + + #[test] + fn ok_200_returns_ok() { + assert!(classify_higgsfield_http_error(200, None).is_ok()); + assert!(classify_higgsfield_http_error(201, Some("{}")).is_ok()); + } + + // ── Bot protection ── + + #[test] + fn datadome_captcha_is_first_class() { + let body = r#"{"url":"https://geo.captcha-delivery.com/captcha/?initialCid=abc&hash=def&cid=x&t=fe","cid":"x"}"#; + let err = classify_higgsfield_http_error(403, Some(body)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::DataDome(DataDomeError::CaptchaChallenge { .. })))); + assert!(err.needs_browser_reauth()); + assert!(err.is_auth_failure()); + assert!(!err.is_token_rejected()); + assert!(!err.is_retryable()); + } + + #[test] + fn datadome_hard_block_is_not_reauthable() { + let body = r#"{"url":"https://geo.captcha-delivery.com/captcha/?cid=x&t=bv","cid":"x"}"#; + let err = classify_higgsfield_http_error(403, Some(body)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::DataDome(DataDomeError::Blocked { .. })))); + assert!(!err.needs_browser_reauth()); + } + + #[test] + fn cloudflare_challenge_is_first_class() { + let body = "Just a moment...

"; + let err = classify_higgsfield_http_error(403, Some(body)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::Cloudflare(CloudflareError::ChallengeInterstitial403)))); + assert!(err.needs_browser_reauth()); + assert!(!err.is_retryable()); + } + + #[test] + fn cloudflare_challenge_by_header_beats_an_opaque_body() { + let err = classify_higgsfield_http_response(&HttpResponseSignals { + status_code: 403, + body: "", + maybe_cf_mitigated: Some("challenge"), + context: "test", + ..Default::default() + }).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::Cloudflare(CloudflareError::ChallengeInterstitial403)))); + } + + #[test] + fn cloudflare_origin_failure_is_retryable() { + let err = classify_higgsfield_http_response(&HttpResponseSignals { + status_code: 502, + body: "", + maybe_server_header: Some("cloudflare"), + maybe_cf_ray: Some("8abc-SJC"), + context: "test", + ..Default::default() + }).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::Cloudflare(CloudflareError::BadGateway502)))); + assert!(err.is_retryable()); + assert!(!err.needs_browser_reauth()); + } + + #[test] + fn an_origin_502_without_cloudflare_markers_is_a_server_error() { + let err = classify_higgsfield_http_error(502, Some(r#"{"detail":"upstream"}"#)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::ServerError { status_code: 502, .. }))); + } + + // ── Direct status mappings ── + + #[test] + fn unauthorized_401() { + let err = classify_higgsfield_http_error(401, Some(r#"{"detail":"Not authenticated"}"#)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::Unauthorized { .. }))); + assert!(err.is_token_rejected()); + assert!(err.is_auth_failure()); + assert!(!err.needs_browser_reauth()); + assert!(!err.is_retryable()); + } + + #[test] + fn payment_required_402() { + let err = classify_higgsfield_http_error(402, Some("{}")).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::InsufficientCredits { .. }))); + } + + #[test] + fn plain_403_is_forbidden() { + let err = classify_higgsfield_http_error(403, Some(r#"{"detail":"Account suspended"}"#)).unwrap_err(); + match err { + HiggsfieldError::Api(HiggsfieldApiError::Forbidden { reason, .. }) => assert_eq!(reason, "Account suspended"), + other => panic!("expected Forbidden, got {:?}", other), + } + } + + #[test] + fn not_found_404() { + let err = classify_higgsfield_http_error(404, Some(r#"{"detail":"Job not found"}"#)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::NotFound { .. }))); + } + + #[test] + fn unprocessable_422_joins_fastapi_messages() { + let body = r#"{"detail":[{"loc":["body","params","prompt"],"msg":"field required","type":"value_error.missing"},{"loc":["body","params","batch_size"],"msg":"ensure this value is less than or equal to 4","type":"value_error"}]}"#; + let err = classify_higgsfield_http_error(422, Some(body)).unwrap_err(); + match err { + HiggsfieldError::Api(HiggsfieldApiError::UnprocessableEntity { reason, .. }) => { + assert_eq!(reason, "field required; ensure this value is less than or equal to 4"); + } + other => panic!("expected UnprocessableEntity, got {:?}", other), + } + } + + #[test] + fn rate_limited_429_is_retryable() { + let err = classify_higgsfield_http_error(429, None).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::RateLimited { .. }))); + assert!(err.is_retryable()); + } + + #[test] + fn server_errors_are_retryable() { + for status in [500, 502, 503, 504] { + let err = classify_higgsfield_http_error(status, Some("upstream unavailable")).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::ServerError { .. })), "status {status}"); + assert!(err.is_retryable()); + } + } + + #[test] + fn other_statuses_are_unknown() { + let err = classify_higgsfield_http_error(418, None).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::UnknownHttpFailure { status_code: 418, .. }))); + } + + // ── Body-driven classification ── + + #[test] + fn bad_request_400_extracts_detail() { + let err = classify_higgsfield_http_error(400, Some(r#"{"detail":"Unknown aspect ratio"}"#)).unwrap_err(); + match err { + HiggsfieldError::Api(HiggsfieldApiError::BadRequest { reason, raw_http_body }) => { + assert_eq!(reason, "Unknown aspect ratio"); + assert!(raw_http_body.contains("Unknown aspect ratio")); + } + other => panic!("expected BadRequest, got {:?}", other), + } + } + + #[test] + fn bad_request_400_unparseable_body_falls_back_to_raw() { + let err = classify_higgsfield_http_error(400, Some("definitely not json")).unwrap_err(); + match err { + HiggsfieldError::Api(HiggsfieldApiError::BadRequest { reason, .. }) => assert_eq!(reason, "definitely not json"), + other => panic!("expected BadRequest, got {:?}", other), + } + } + + #[test] + fn moderation_body_is_content_moderated_regardless_of_4xx_code() { + for status in [400, 403, 422] { + let body = r#"{"detail":"Prompt was flagged by content moderation"}"#; + let err = classify_higgsfield_http_error(status, Some(body)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::ContentModerated { .. })), "status {status}"); + } + } + + #[test] + fn insufficient_credits_body_on_400() { + let body = r#"{"detail":"Not enough credits to run this generation"}"#; + let err = classify_higgsfield_http_error(400, Some(body)).unwrap_err(); + assert!(matches!(err, HiggsfieldError::Api(HiggsfieldApiError::InsufficientCredits { .. }))); + } + + #[test] + fn clerk_error_envelope_is_extracted() { + let body = r#"{"errors":[{"message":"Signed out","long_message":"The session is signed out","code":"session_signed_out"}],"clerk_trace_id":"abc"}"#; + assert_eq!(extract_error_message(body).as_deref(), Some("The session is signed out")); + } + + #[test] + fn nested_error_message_is_extracted() { + assert_eq!(extract_error_message(r#"{"error":{"message":"boom"}}"#).as_deref(), Some("boom")); + assert_eq!(extract_error_message(r#"{"message":"plain"}"#).as_deref(), Some("plain")); + assert_eq!(extract_error_message("[]"), None); + } +} diff --git a/crates/api_clients/higgsfield_client/src/error/higgsfield_api_error.rs b/crates/api_clients/higgsfield_client/src/error/higgsfield_api_error.rs new file mode 100644 index 00000000..17313da9 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/error/higgsfield_api_error.rs @@ -0,0 +1,199 @@ +use cloudflare_errors::cloudflare_error::CloudflareError; +use datadome_errors::datadome_error::DataDomeError; +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// Errors that came back from Higgsfield's gateway, or from the network +/// while talking to it. +/// +/// Every server-response variant carries the raw HTTP body so logs and +/// alerts keep the upstream context, not just our classification. +#[derive(Debug)] +pub enum HiggsfieldApiError { + /// 400 — the request body was rejected (unknown field, bad value, ...). + BadRequest { + /// The message parsed from the body, or the raw body if unparseable. + reason: String, + raw_http_body: String, + }, + + /// 401 — the bearer token is missing, expired, or revoked. Clerk tokens + /// only live about a minute; mint a new one and retry. + Unauthorized { + raw_http_body: String, + }, + + /// 402, or a 4xx whose body says the wallet can't cover the job. + InsufficientCredits { + reason: String, + raw_http_body: String, + }, + + /// 403 — the session is valid but this action isn't allowed (blocked or + /// suspended account, feature not on the plan, ...). + Forbidden { + reason: String, + raw_http_body: String, + }, + + /// Cloudflare's edge answered instead of the API: a bot challenge, a WAF + /// block, a rate limit, or an origin failure. See + /// [`CloudflareError`] for which, and `cloudflare_mitigation` for what to + /// do about it. + Cloudflare(CloudflareError), + + /// DataDome's bot protection answered instead of the API: a CAPTCHA, + /// an interstitial, or a hard block. The session (cookies, + /// `x-datadome-clientid`, User-Agent) needs refreshing from a real + /// browser. See `datadome_mitigation`. + DataDome(DataDomeError), + + /// 404 — e.g. an unknown job id. + NotFound { + raw_http_body: String, + }, + + /// Clerk reports no active session for these cookies: the user signed + /// out, or the session expired. Log in again to capture new cookies. + NoActiveSession { + raw_http_body: String, + }, + + /// 422 — the body was well-formed JSON but failed validation. + UnprocessableEntity { + reason: String, + raw_http_body: String, + }, + + /// 429 — slow down. + RateLimited { + raw_http_body: String, + }, + + /// The prompt or input was rejected by content moderation. + ContentModerated { + reason: String, + raw_http_body: String, + }, + + /// 5xx. + ServerError { + status_code: u16, + raw_http_body: String, + }, + + /// Any other non-2xx status. + UnknownHttpFailure { + status_code: u16, + raw_http_body: String, + }, + + /// The response body didn't match the expected schema. Carries the raw + /// body so the drift is visible in logs. + Deserialization { + source: serde_json::Error, + raw_http_body: String, + }, + + /// The request timed out. + Timeout(String), + + /// A network-level failure (DNS, connect, reset, TLS, ...). + Network(String), +} + +impl Error for HiggsfieldApiError {} + +impl Display for HiggsfieldApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::BadRequest { reason, raw_http_body } => + write!(f, "Bad request: {}{}", reason, fmt_raw_body(raw_http_body)), + Self::Unauthorized { raw_http_body } => + write!(f, "Unauthorized (bearer token missing, expired, or revoked){}", fmt_raw_body(raw_http_body)), + Self::InsufficientCredits { reason, raw_http_body } => + write!(f, "Insufficient credits: {}{}", reason, fmt_raw_body(raw_http_body)), + Self::Forbidden { reason, raw_http_body } => + write!(f, "Forbidden: {}{}", reason, fmt_raw_body(raw_http_body)), + Self::Cloudflare(err) => write!(f, "{}", err), + Self::DataDome(err) => write!(f, "{}", err), + Self::NotFound { raw_http_body } => + write!(f, "Not found{}", fmt_raw_body(raw_http_body)), + Self::NoActiveSession { raw_http_body } => + write!(f, "No active Clerk session (signed out or expired; log in again){}", fmt_raw_body(raw_http_body)), + Self::UnprocessableEntity { reason, raw_http_body } => + write!(f, "Unprocessable entity: {}{}", reason, fmt_raw_body(raw_http_body)), + Self::RateLimited { raw_http_body } => + write!(f, "Rate limited{}", fmt_raw_body(raw_http_body)), + Self::ContentModerated { reason, raw_http_body } => + write!(f, "Content moderated: {}{}", reason, fmt_raw_body(raw_http_body)), + Self::ServerError { status_code, raw_http_body } => + write!(f, "Server error (status {}){}", status_code, fmt_raw_body(raw_http_body)), + Self::UnknownHttpFailure { status_code, raw_http_body } => + write!(f, "Unknown HTTP failure (status {}){}", status_code, fmt_raw_body(raw_http_body)), + Self::Deserialization { source, raw_http_body } => + write!(f, "Deserialization error: {} | raw response body ({} bytes): {}", source, raw_http_body.len(), raw_http_body), + Self::Timeout(msg) => write!(f, "Timeout: {}", msg), + Self::Network(msg) => write!(f, "Network error: {}", msg), + } + } +} + +impl HiggsfieldApiError { + /// Whether retrying the same request later is reasonable. + pub fn is_retryable(&self) -> bool { + match self { + Self::RateLimited { .. } | Self::ServerError { .. } | Self::Timeout(_) | Self::Network(_) => true, + Self::Cloudflare(err) => err.is_retryable(), + _ => false, + } + } + + /// Bot protection (Cloudflare challenge / DataDome) refused this client: + /// the only fix is a fresh browser login that re-earns the protection + /// cookies. Distinct from an expired bearer token, which the session + /// re-mints on its own. + pub fn needs_browser_reauth(&self) -> bool { + match self { + Self::Cloudflare(err) => err.is_challenge(), + Self::DataDome(err) => err.is_challenge() || matches!(err, DataDomeError::Unclassified { .. }), + Self::NoActiveSession { .. } => true, + _ => false, + } + } + + /// Build a [`HiggsfieldApiError::Deserialization`] that captures the raw + /// body, and log the whole payload immediately so it's never lost even if + /// the error is later swallowed. + pub fn deserialization(source: serde_json::Error, raw_http_body: &str) -> Self { + log::warn!( + "Higgsfield response failed to deserialize: {} | raw body ({} bytes): {}", + source, + raw_http_body.len(), + raw_http_body, + ); + Self::Deserialization { + source, + raw_http_body: raw_http_body.to_string(), + } + } + + /// Map a transport-level `wreq` failure (sending, or reading the body) to + /// the timeout / network split. + pub(crate) fn from_transport_error(error: wreq::Error) -> Self { + if error.is_timeout() { + Self::Timeout(error.to_string()) + } else { + Self::Network(error.to_string()) + } + } +} + +/// Append the raw HTTP body to a `Display` message when one is present. +fn fmt_raw_body(raw_http_body: &str) -> String { + if raw_http_body.is_empty() { + String::new() + } else { + format!(" [raw http body: {}]", raw_http_body) + } +} diff --git a/crates/api_clients/higgsfield_client/src/error/higgsfield_client_error.rs b/crates/api_clients/higgsfield_client/src/error/higgsfield_client_error.rs new file mode 100644 index 00000000..d81ccff4 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/error/higgsfield_client_error.rs @@ -0,0 +1,121 @@ +use crate::types::ids::{JobId, MediaId}; +use crate::types::job_status::JobStatus; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::time::Duration; + +/// Errors raised entirely on the client side — before or independent of the +/// request reaching Higgsfield. +#[derive(Debug)] +pub enum HiggsfieldClientError { + /// The auth has an empty bearer token. + MissingBearerToken, + + /// The bearer token contains characters that can't go in a header. + InvalidBearerToken, + + /// A JWT didn't parse or lacks the claims we need (`exp`, `sid`, `sub`). + InvalidSessionToken(String), + + /// The cookies are empty. + MissingCookies, + + /// The cookies contain characters that can't go in a header. + InvalidCookies, + + /// The cookies lack Clerk's `__client` cookie, so no session token can be + /// minted. Re-capture from a logged-in browser. + MissingClerkClientCookie, + + /// The request failed our own validation before being sent — e.g. an empty + /// prompt or a batch size the endpoint doesn't accept. + InvalidRequest(String), + + /// Building the HTTP client failed. + WreqClientBuild(wreq::Error), + + /// Building the HTTP request failed (bad URL, bad header value, ...). + WreqRequestBuild(wreq::Error), + + /// The request body could not be serialized to JSON. + RequestSerialization(serde_json::Error), + + /// Waiting for a job: the server doesn't know the id. + JobNotFound(JobId), + + /// Waiting for a job: it ended in a non-success state. + JobFailed { + job_id: JobId, + status: JobStatus, + /// The server's `meta.fail_reason`, when it gave one. + maybe_reason: Option, + }, + + /// Waiting for a job: it didn't finish within the timeout. + JobTimedOut { + job_id: JobId, + last_status: JobStatus, + waited: Duration, + }, + + /// Waiting for an upload's IP check: it didn't finish within the timeout + /// (or was never requested — confirm with `force_ip_check`). + MediaIpCheckTimedOut { + media_id: MediaId, + waited: Duration, + }, + + /// The upload was flagged as protected content (a recognised public + /// figure or copyrighted image); the server will refuse it in every + /// generation request (`404 "Media input not found"`). Nothing to retry + /// — pick different media. + MediaProtectedContent { + media_id: MediaId, + }, + + /// The upload's source URL is on a first-party domain (ArtCraft / + /// FakeYou); our own CDN assets must not be re-uploaded to Higgsfield. + /// See `session::upload_source_guard`. + UploadSourceDomainBlocked { + source_url: String, + domain: &'static str, + }, +} + +impl Error for HiggsfieldClientError {} + +impl Display for HiggsfieldClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::MissingBearerToken => write!(f, "No bearer token present."), + Self::InvalidBearerToken => write!(f, "The bearer token contains invalid characters."), + Self::InvalidSessionToken(msg) => write!(f, "The session token is not a usable Clerk JWT: {}", msg), + Self::MissingCookies => write!(f, "No cookies present."), + Self::InvalidCookies => write!(f, "The cookies contain invalid characters."), + Self::MissingClerkClientCookie => write!(f, "The cookies lack Clerk's `__client` cookie; log in again to capture it."), + Self::InvalidRequest(msg) => write!(f, "Invalid request (rejected client-side before sending): {}", msg), + Self::WreqClientBuild(err) => write!(f, "Failed to build the HTTP client: {}", err), + Self::WreqRequestBuild(err) => write!(f, "Failed to build the HTTP request: {}", err), + Self::RequestSerialization(err) => write!(f, "Failed to serialize the request body to JSON: {}", err), + Self::JobNotFound(job_id) => write!(f, "Job {} is unknown to the server.", job_id), + Self::JobFailed { job_id, status, maybe_reason } => match maybe_reason { + Some(reason) => write!(f, "Job {} ended in state {}: {}", job_id, status, reason), + None => write!(f, "Job {} ended in state {}.", job_id, status), + }, + Self::JobTimedOut { job_id, last_status, waited } => + write!(f, "Job {} did not finish within {}s (last status: {}).", job_id, waited.as_secs(), last_status), + Self::MediaIpCheckTimedOut { media_id, waited } => + write!(f, "Media {} IP check did not finish within {}s (was it requested with force_ip_check?).", media_id, waited.as_secs()), + Self::MediaProtectedContent { media_id } => + write!(f, "Media {} was flagged as protected content (recognised likeness or copyrighted image); Higgsfield will not use it as a reference.", media_id), + Self::UploadSourceDomainBlocked { source_url, domain } => + write!(f, "Refusing to upload media sourced from {} — {} is a first-party domain whose assets must not be sent to Higgsfield.", source_url, domain), + } + } +} + +impl From for HiggsfieldClientError { + fn from(error: serde_json::Error) -> Self { + Self::RequestSerialization(error) + } +} diff --git a/crates/api_clients/higgsfield_client/src/error/higgsfield_error.rs b/crates/api_clients/higgsfield_client/src/error/higgsfield_error.rs new file mode 100644 index 00000000..345d1f64 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/error/higgsfield_error.rs @@ -0,0 +1,156 @@ +use crate::error::higgsfield_api_error::HiggsfieldApiError; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// Top-level error for the Higgsfield client: every failure any endpoint can +/// produce, split by where it happened. +#[derive(Debug)] +pub enum HiggsfieldError { + /// Failed on our side, before or independent of a server response. + Client(HiggsfieldClientError), + + /// The server (or the network in between) produced the failure. + Api(HiggsfieldApiError), +} + +impl Error for HiggsfieldError {} + +impl Display for HiggsfieldError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::Client(err) => write!(f, "Higgsfield client error: {}", err), + Self::Api(err) => write!(f, "Higgsfield API error: {}", err), + } + } +} + +impl HiggsfieldError { + /// Whether retrying the same request later is reasonable (transient + /// network trouble, rate limiting, or a server-side failure). + pub fn is_retryable(&self) -> bool { + match self { + Self::Client(_) => false, + Self::Api(err) => err.is_retryable(), + } + } + + /// The bearer token was rejected (expired or revoked). The session can fix + /// this itself by minting a new one — see `HiggsfieldSession::with_auth`. + pub fn is_token_rejected(&self) -> bool { + matches!(self, Self::Api(HiggsfieldApiError::Unauthorized { .. })) + } + + /// Bot protection or a dead Clerk session: only a human in a browser can + /// fix this (a fresh login re-earns the cookies). + pub fn needs_browser_reauth(&self) -> bool { + match self { + Self::Client(_) => false, + Self::Api(err) => err.needs_browser_reauth(), + } + } + + /// A plain-language explanation when Higgsfield refused the request for a + /// reason the user can act on (rather than a fault to retry or report): + /// reference media failing the intellectual-property / likeness check, or + /// that check not finishing. `None` for everything else. + pub fn user_facing_rejection(&self) -> Option { + match self { + Self::Client(HiggsfieldClientError::MediaProtectedContent { .. }) => Some( + "Higgsfield's intellectual property check rejected one of your reference images or videos: \ + it appears to contain a recognizable person or copyrighted content, so Higgsfield won't use it. \ + Please choose different reference media.".to_string(), + ), + Self::Client(HiggsfieldClientError::MediaIpCheckTimedOut { .. }) => Some( + "Higgsfield's intellectual property check on your reference media didn't finish in time. \ + Please try again in a moment.".to_string(), + ), + _ => None, + } + } + + /// The server refused a job because a referenced media input is unknown + /// or unusable (`404 "Media input not found"` and its 400/422 cousins). + /// Happens when a previously uploaded reference has since been deleted or + /// flagged: forget the cached upload and upload afresh. + pub fn is_media_input_rejected(&self) -> bool { + let text = match self { + Self::Api(HiggsfieldApiError::NotFound { raw_http_body }) => raw_http_body, + Self::Api(HiggsfieldApiError::BadRequest { reason, .. }) => reason, + Self::Api(HiggsfieldApiError::UnprocessableEntity { reason, .. }) => reason, + _ => return false, + }; + let text = text.to_ascii_lowercase(); + text.contains("media") && (text.contains("not found") || text.contains("input")) + } + + /// Whether the session itself is the problem (expired token, dead session, + /// bot protection, unusable cookies) — some form of re-authentication is + /// needed before retrying. Union of [`Self::is_token_rejected`], + /// [`Self::needs_browser_reauth`], and client-side credential problems. + pub fn is_auth_failure(&self) -> bool { + if self.is_token_rejected() || self.needs_browser_reauth() { + return true; + } + match self { + Self::Client(err) => matches!( + err, + HiggsfieldClientError::MissingBearerToken + | HiggsfieldClientError::InvalidBearerToken + | HiggsfieldClientError::InvalidSessionToken(_) + | HiggsfieldClientError::MissingCookies + | HiggsfieldClientError::InvalidCookies + | HiggsfieldClientError::MissingClerkClientCookie, + ), + Self::Api(_) => false, + } + } +} + +impl From for HiggsfieldError { + fn from(error: HiggsfieldClientError) -> Self { + Self::Client(error) + } +} + +impl From for HiggsfieldError { + fn from(error: HiggsfieldApiError) -> Self { + Self::Api(error) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::ids::MediaId; + use std::time::Duration; + + #[test] + fn ip_check_outcomes_have_user_facing_messages() { + let protected = HiggsfieldError::Client(HiggsfieldClientError::MediaProtectedContent { media_id: MediaId::new("m1") }); + let message = protected.user_facing_rejection().expect("protected content is user-facing"); + assert!(message.contains("intellectual property")); + assert!(message.contains("different reference media")); + + let timed_out = HiggsfieldError::Client(HiggsfieldClientError::MediaIpCheckTimedOut { media_id: MediaId::new("m1"), waited: Duration::from_secs(30) }); + assert!(timed_out.user_facing_rejection().unwrap().contains("didn't finish in time")); + } + + #[test] + fn media_input_rejections_are_recognised_by_status_and_body() { + let not_found = HiggsfieldError::Api(HiggsfieldApiError::NotFound { raw_http_body: r#"{"detail":"Media input not found"}"#.to_string() }); + assert!(not_found.is_media_input_rejected()); + let unprocessable = HiggsfieldError::Api(HiggsfieldApiError::UnprocessableEntity { reason: "Invalid media input".to_string(), raw_http_body: String::new() }); + assert!(unprocessable.is_media_input_rejected()); + let job_missing = HiggsfieldError::Api(HiggsfieldApiError::NotFound { raw_http_body: r#"{"detail":"Job not found"}"#.to_string() }); + assert!(!job_missing.is_media_input_rejected(), "a missing job is not a media problem"); + let dead = HiggsfieldError::Api(HiggsfieldApiError::NoActiveSession { raw_http_body: String::new() }); + assert!(!dead.is_media_input_rejected()); + } + + #[test] + fn other_errors_are_not_user_facing_rejections() { + let dead = HiggsfieldError::Api(HiggsfieldApiError::NoActiveSession { raw_http_body: String::new() }); + assert!(dead.user_facing_rejection().is_none()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/error/mod.rs b/crates/api_clients/higgsfield_client/src/error/mod.rs new file mode 100644 index 00000000..06cc51bd --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/error/mod.rs @@ -0,0 +1,4 @@ +pub mod classify_higgsfield_http_error; +pub mod higgsfield_api_error; +pub mod higgsfield_client_error; +pub mod higgsfield_error; diff --git a/crates/api_clients/higgsfield_client/src/lib.rs b/crates/api_clients/higgsfield_client/src/lib.rs new file mode 100644 index 00000000..791e9f01 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/lib.rs @@ -0,0 +1,20 @@ +//! A client for Higgsfield's consumer web API (`fnf-api-gw.higgsfield.ai`) — +//! the same endpoints the higgsfield.ai web app calls. +//! +//! Requests authenticate with a short-lived Clerk JWT (see +//! [`credentials::higgsfield_auth::HiggsfieldAuth`]). Each endpoint binding +//! under [`endpoints`] takes an `{Endpoint}Args { request, auth, host }`. +//! +//! The easy path is [`session::higgsfield_session::HiggsfieldSession`]: build +//! it from the browser's cookies once, and it mints / refreshes the JWT for +//! you and exposes every endpoint as a method. + +#[cfg(test)] +pub(crate) mod test_utils; + +pub mod client; +pub mod credentials; +pub mod endpoints; +pub mod error; +pub mod session; +pub mod types; diff --git a/crates/api_clients/higgsfield_client/src/session/endpoint_wrappers.rs b/crates/api_clients/higgsfield_client/src/session/endpoint_wrappers.rs new file mode 100644 index 00000000..7143f597 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/session/endpoint_wrappers.rs @@ -0,0 +1,281 @@ +//! Every endpoint as a [`HiggsfieldSession`] method: the session supplies a +//! fresh bearer token and retries once on `401`. + +use crate::endpoints::generate::image::gpt_image_2::{gpt_image_2, GptImage2Args, GptImage2Request}; +use crate::endpoints::generate::image::nano_banana_2::{nano_banana_2, NanoBanana2Args, NanoBanana2Request}; +use crate::endpoints::generate::image::nano_banana_2_lite::{nano_banana_2_lite, NanoBanana2LiteArgs, NanoBanana2LiteRequest}; +use crate::endpoints::generate::image::nano_banana_pro::{nano_banana_pro, NanoBananaProArgs, NanoBananaProRequest}; +use crate::endpoints::generate::image::seedream_4p5::{seedream_4p5, Seedream4p5Args, Seedream4p5Request}; +use crate::endpoints::generate::image::seedream_5p0_lite::{seedream_5p0_lite, Seedream5p0LiteArgs, Seedream5p0LiteRequest}; +use crate::endpoints::generate::image::seedream_5p0_pro::{seedream_5p0_pro, Seedream5p0ProArgs, Seedream5p0ProRequest}; +use crate::endpoints::generate::video::grok_imagine_1p5::{grok_imagine_1p5, GrokImagine1p5Args, GrokImagine1p5Request}; +use crate::endpoints::generate::video::kling_3p0::{kling_3p0, Kling3p0Args, Kling3p0Request}; +use crate::endpoints::generate::video::minimax_h3::{minimax_h3, MinimaxH3Args, MinimaxH3Request}; +use crate::endpoints::generate::video::seedance_2p0::{seedance_2p0, Seedance2p0Args, Seedance2p0Request}; +use crate::endpoints::generate::video::seedance_2p0_mini::{seedance_2p0_mini, Seedance2p0MiniArgs, Seedance2p0MiniRequest}; +use crate::endpoints::generate::video::seedance_2p5::{seedance_2p5, Seedance2p5Args, Seedance2p5Request}; +use crate::endpoints::generate::video::seedance_2p5_edit::{seedance_2p5_edit, Seedance2p5EditArgs, Seedance2p5EditRequest}; +use crate::endpoints::jobs::job_status::{job_status, JobStatusArgs, JobStatusRequest, JobStatusResponse}; +use crate::endpoints::jobs::job_status_batch::{job_status_batch, JobStatusBatchArgs, JobStatusBatchRequest, JobStatusBatchResponse}; +use crate::endpoints::user::user_data::{user_data, UserDataArgs, UserDataRequest, UserDataResponse}; +use crate::endpoints::user::user_profile::{user_profile, UserProfileArgs, UserProfileRequest, UserProfileResponse}; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::types::enqueue_jobs_response::EnqueueJobsResponse; +use crate::types::ids::JobId; + +impl HiggsfieldSession { + /// Enqueue a Nano Banana Pro image job. + pub async fn nano_banana_pro(&self, request: NanoBananaProRequest) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { nano_banana_pro(NanoBananaProArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Nano Banana 2 image job. + pub async fn nano_banana_2(&self, request: NanoBanana2Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { nano_banana_2(NanoBanana2Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Nano Banana 2 Lite image job. + pub async fn nano_banana_2_lite(&self, request: NanoBanana2LiteRequest) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { nano_banana_2_lite(NanoBanana2LiteArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Seedream 5.0 Pro image job. + pub async fn seedream_5p0_pro(&self, request: Seedream5p0ProRequest) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedream_5p0_pro(Seedream5p0ProArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Seedream 5.0 lite image job. + pub async fn seedream_5p0_lite(&self, request: Seedream5p0LiteRequest) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedream_5p0_lite(Seedream5p0LiteArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Seedream 4.5 image job. + pub async fn seedream_4p5(&self, request: Seedream4p5Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedream_4p5(Seedream4p5Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a GPT Image job. + pub async fn gpt_image_2(&self, request: GptImage2Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { gpt_image_2(GptImage2Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + // ── Video ── + + /// Enqueue a Seedance 2.5 video job. + pub async fn seedance_2p5(&self, request: Seedance2p5Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedance_2p5(Seedance2p5Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Seedance 2.5 Edit (video-to-video) job. + pub async fn seedance_2p5_edit(&self, request: Seedance2p5EditRequest) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedance_2p5_edit(Seedance2p5EditArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Seedance 2.0 video job. + pub async fn seedance_2p0(&self, request: Seedance2p0Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedance_2p0(Seedance2p0Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Seedance 2.0 Mini video job. + pub async fn seedance_2p0_mini(&self, request: Seedance2p0MiniRequest) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { seedance_2p0_mini(Seedance2p0MiniArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a MiniMax H3 video job. + pub async fn minimax_h3(&self, request: MinimaxH3Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { minimax_h3(MinimaxH3Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Kling 3.0 video job. + pub async fn kling_3p0(&self, request: Kling3p0Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { kling_3p0(Kling3p0Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Enqueue a Grok Imagine 1.5 video job. + pub async fn grok_imagine_1p5(&self, request: GrokImagine1p5Request) -> Result { + self.with_auth(|auth| { + let request = request.clone(); + async move { grok_imagine_1p5(GrokImagine1p5Args { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Full state of one job, including result URLs once complete. + pub async fn job_status(&self, job_id: &JobId) -> Result { + self.with_auth(|auth| { + let request = JobStatusRequest { job_id: job_id.clone() }; + async move { job_status(JobStatusArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Lightweight status for many jobs. + pub async fn job_status_batch(&self, job_ids: &[JobId]) -> Result { + self.with_auth(|auth| { + let request = JobStatusBatchRequest { ids: job_ids.to_vec() }; + async move { job_status_batch(JobStatusBatchArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// The account: plan, credits, workspace. Also the cheapest session check. + pub async fn user_data(&self) -> Result { + self.with_auth(|auth| async move { + user_data(UserDataArgs { request: UserDataRequest, auth: &auth, host: self.api_host() }).await + }).await + } + + /// The public profile. + pub async fn user_profile(&self) -> Result { + self.with_auth(|auth| async move { + user_profile(UserProfileArgs { request: UserProfileRequest, auth: &auth, host: self.api_host() }).await + }).await + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::client::clerk_host::ClerkHost; + use crate::client::higgsfield_host::HiggsfieldHost; + use crate::error::higgsfield_client_error::HiggsfieldClientError; + use crate::endpoints::generate::image::gpt_image_2::{GptImage2AspectRatio, GptImage2Quality, GptImage2Resolution}; + use crate::endpoints::generate::image::nano_banana_pro::{NanoBananaProAspectRatio, NanoBananaProResolution}; + + /// A session that can't reach anything, but has a fresh seed token so the + /// wrappers get past auth and into request validation. + fn offline_session() -> HiggsfieldSession { + use crate::credentials::clerk_session_token::tests::fake_clerk_token; + let token = fake_clerk_token((chrono::Utc::now() + chrono::Duration::hours(1)).timestamp()); + HiggsfieldSession::from_cookie_header("__client=x") + .with_hosts(HiggsfieldHost::Custom("http://127.0.0.1:9".into()), ClerkHost::Custom("http://127.0.0.1:9".into())) + .with_initial_token(token) + } + + #[tokio::test] + async fn wrappers_apply_request_validation() { + let session = offline_session(); + + let request = NanoBananaProRequest::text_to_image("", NanoBananaProAspectRatio::Square1x1, NanoBananaProResolution::OneK); + let err = session.nano_banana_pro(request).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + + let request = GptImage2Request::text_to_image("", GptImage2AspectRatio::Square1x1, GptImage2Quality::Low, GptImage2Resolution::OneK); + let err = session.gpt_image_2(request).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + + use crate::endpoints::generate::image::nano_banana_2::NanoBanana2Resolution; + use crate::endpoints::generate::image::nano_banana_2_lite::NanoBanana2LiteQuality; + use crate::endpoints::generate::image::seedream_4p5::Seedream4p5Resolution; + use crate::endpoints::generate::image::seedream_5p0_lite::Seedream5p0LiteResolution; + use crate::endpoints::generate::image::seedream_5p0_pro::Seedream5p0ProResolution; + use crate::types::seedream_aspect_ratio::SeedreamAspectRatio; + let err = session.nano_banana_2(NanoBanana2Request::text_to_image("", NanoBananaProAspectRatio::Square1x1, NanoBanana2Resolution::OneK)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.nano_banana_2_lite(NanoBanana2LiteRequest::text_to_image("", NanoBananaProAspectRatio::Square1x1, NanoBanana2LiteQuality::High)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.seedream_5p0_pro(Seedream5p0ProRequest::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream5p0ProResolution::OneK)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.seedream_5p0_lite(Seedream5p0LiteRequest::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream5p0LiteResolution::TwoK)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.seedream_4p5(Seedream4p5Request::text_to_image("", SeedreamAspectRatio::Square1x1, Seedream4p5Resolution::TwoK)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + + use crate::endpoints::generate::video::grok_imagine_1p5::GrokImagine1p5Resolution; + use crate::endpoints::generate::video::kling_3p0::Kling3p0Resolution; + use crate::endpoints::generate::video::seedance_2p0::Seedance2p0Resolution; + use crate::endpoints::generate::video::seedance_2p0_mini::Seedance2p0MiniResolution; + use crate::endpoints::generate::video::seedance_2p5::Seedance2p5Resolution; + use crate::types::video_aspect_ratio::{KlingAspectRatio, SeedanceVideoAspectRatio}; + use crate::types::video_duration::VideoDurationSeconds; + let bad_duration = VideoDurationSeconds::new(0); + let err = session.seedance_2p5(Seedance2p5Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p5Resolution::P480, bad_duration)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.seedance_2p0(Seedance2p0Request::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0Resolution::P480, bad_duration)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.seedance_2p0_mini(Seedance2p0MiniRequest::text_to_video("p", SeedanceVideoAspectRatio::Landscape16x9, Seedance2p0MiniResolution::P480, bad_duration)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.minimax_h3(MinimaxH3Request::text_to_video("p", bad_duration)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.kling_3p0(Kling3p0Request::text_to_video("p", KlingAspectRatio::Landscape16x9, Kling3p0Resolution::P720, bad_duration)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + let err = session.grok_imagine_1p5(GrokImagine1p5Request::text_to_video("p", GrokImagine1p5Resolution::P480, bad_duration)).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + + let err = session.job_status_batch(&[]).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } + + // ── Live (ignored: needs captured cookies; the enqueue spends credits) ── + + #[tokio::test] + #[ignore] + async fn live_session_user_data() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_session; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_test_session()?; + let user = session.user_data().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let profile = session.user_profile().await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("User {} ({}) plan={:?} credits={:?}", user.id, profile.username, user.plan_type, user.subscription_credits); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn live_session_generate_and_wait() -> anyhow::Result<()> { + use crate::session::wait_for_job::WaitForJobOptions; + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_session; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_test_session()?; + let enqueued = session.nano_banana_pro( + NanoBananaProRequest::text_to_image("a dinosaur on a skateboard", NanoBananaProAspectRatio::Portrait3x4, NanoBananaProResolution::OneK), + ).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let job_id = enqueued.job_ids().into_iter().next().unwrap(); + let job = session.wait_for_job(&job_id, WaitForJobOptions::default()).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("Job {} finished: {:?}", job.id, job.result_url()); + assert!(job.result_url().is_some()); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/session/higgsfield_session.rs b/crates/api_clients/higgsfield_client/src/session/higgsfield_session.rs new file mode 100644 index 00000000..caa57015 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/session/higgsfield_session.rs @@ -0,0 +1,394 @@ +use crate::client::clerk_host::ClerkHost; +use crate::client::higgsfield_host::HiggsfieldHost; +use crate::credentials::clerk_session_token::ClerkSessionToken; +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::credentials::higgsfield_cookies::HiggsfieldCookies; +use crate::endpoints::auth::clerk_client::{clerk_client, ClerkClientArgs, ClerkClientRequest}; +use crate::endpoints::auth::clerk_session_tokens::{clerk_session_tokens, ClerkSessionTokensArgs, ClerkSessionTokensRequest}; +use crate::error::higgsfield_error::HiggsfieldError; +use chrono::{DateTime, Duration, Utc}; +use datadome_mitigation::client_id::datadome_client_id::client_id_from_cookie_header; +use log::{info, warn}; +use std::sync::Arc; +use tokio::sync::Mutex; + +/// Mint a new token when the current one has less than this left. Clerk +/// tokens live ~60s, so this keeps a comfortable runway for the request. +const DEFAULT_REFRESH_MARGIN_SECONDS: i64 = 15; + +/// A logged-in Higgsfield session that manages its own bearer token. +/// +/// Build one from the browser's cookies (the long-lived credential), then +/// call endpoints through it — every call gets a fresh Clerk JWT, minted or +/// refreshed on demand, and a `401` triggers one re-mint and retry. +/// +/// Bot protection is handled too: requests present the User-Agent that +/// captured the cookies (see [`Self::with_user_agent`]) and DataDome's +/// `x-datadome-clientid` derived from the `datadome` cookie, so replayed +/// sessions look like the browser that earned them. A Cloudflare or DataDome +/// challenge surfaces as an error whose `needs_browser_reauth()` is true — +/// the cue to send the user back through the login window. +/// +/// ```ignore +/// let session = HiggsfieldSession::from_cookies(HiggsfieldCookies::from_cookie_header(cookie_header)); +/// let enqueued = session.nano_banana_pro(NanoBananaProRequest::text_to_image("a cat", NanoBananaProAspectRatio::Square1x1, NanoBananaProResolution::OneK)).await?; +/// let job = session.wait_for_job(&enqueued.job_ids()[0], WaitForJobOptions::default()).await?; +/// println!("{:?}", job.result_url()); +/// ``` +/// +/// Cheap to clone; clones share the cached token. Refreshes are +/// single-flight: concurrent callers wait for one mint rather than each +/// minting their own. +#[derive(Clone)] +pub struct HiggsfieldSession { + cookies: HiggsfieldCookies, + maybe_datadome_client_id: Option, + maybe_user_agent: Option, + api_host: HiggsfieldHost, + clerk_host: ClerkHost, + refresh_margin: Duration, + state: Arc>, +} + +#[derive(Default)] +struct SessionState { + /// The most recent token, fresh or not. + maybe_token: Option, + + /// Known Clerk session id, so refreshes can skip the client lookup. + maybe_session_id: Option, +} + +impl HiggsfieldSession { + /// From captured browser cookies. If they include a `__session` JWT it + /// seeds the token (even expired, it tells us the session id). + pub fn from_cookies(cookies: HiggsfieldCookies) -> Self { + let seed = cookies.maybe_session_jwt() + .and_then(|jwt| ClerkSessionToken::parse(jwt).ok()); + let maybe_session_id = seed.as_ref().map(|token| token.session_id().to_string()); + + // DataDome expects the header to echo its cookie; a browser's JS does + // this automatically, so a replayed session must too. + let maybe_datadome_client_id = client_id_from_cookie_header(cookies.as_header_value()); + + Self { + cookies, + maybe_datadome_client_id, + maybe_user_agent: None, + api_host: HiggsfieldHost::Higgsfield, + clerk_host: ClerkHost::Higgsfield, + refresh_margin: Duration::seconds(DEFAULT_REFRESH_MARGIN_SECONDS), + state: Arc::new(Mutex::new(SessionState { maybe_token: seed, maybe_session_id })), + } + } + + /// From a `cookie` header value; see [`Self::from_cookies`]. + pub fn from_cookie_header(cookie_header: impl Into) -> Self { + Self::from_cookies(HiggsfieldCookies::from_cookie_header(cookie_header)) + } + + /// Override the `x-datadome-clientid` sent with gateway requests. By + /// default it's derived from the `datadome` cookie, which is what the + /// browser sends; only override if you captured a different value. + pub fn with_datadome_client_id(mut self, datadome_client_id: impl Into) -> Self { + self.maybe_datadome_client_id = Some(datadome_client_id.into().trim().to_string()); + self + } + + /// The User-Agent of the browser that captured the cookies. Cloudflare's + /// `cf_clearance` and DataDome's `datadome` cookies are bound to it, so + /// replaying under a different UA invites a challenge. Without one, the + /// client's pinned default (`HIGGSFIELD_USER_AGENT`) is used — make sure + /// the login window uses the same. + pub fn with_user_agent(mut self, user_agent: impl Into) -> Self { + let user_agent = user_agent.into().trim().to_string(); + self.maybe_user_agent = (!user_agent.is_empty()).then_some(user_agent); + self + } + + /// Seed with an already-captured bearer JWT (e.g. from an + /// `authorization` header). Used until it's near expiry, then refreshed. + /// + /// NB: like the other builders, call this before cloning the session — + /// it replaces the shared state. + pub fn with_initial_token(mut self, token: ClerkSessionToken) -> Self { + self.state = Arc::new(Mutex::new(SessionState { + maybe_session_id: Some(token.session_id().to_string()), + maybe_token: Some(token), + })); + self + } + + /// Point at other hosts (mocks, proxies, staging). + pub fn with_hosts(mut self, api_host: HiggsfieldHost, clerk_host: ClerkHost) -> Self { + self.api_host = api_host; + self.clerk_host = clerk_host; + self + } + + /// How much lifetime a token must have left to be reused. + pub fn with_refresh_margin(mut self, margin: Duration) -> Self { + self.refresh_margin = margin; + self + } + + pub fn cookies(&self) -> &HiggsfieldCookies { + &self.cookies + } + + pub fn api_host(&self) -> &HiggsfieldHost { + &self.api_host + } + + pub fn clerk_host(&self) -> &ClerkHost { + &self.clerk_host + } + + /// The `x-datadome-clientid` requests carry (derived from the cookies + /// unless overridden). + pub fn maybe_datadome_client_id(&self) -> Option<&str> { + self.maybe_datadome_client_id.as_deref() + } + + pub fn maybe_user_agent(&self) -> Option<&str> { + self.maybe_user_agent.as_deref() + } + + /// A bearer auth that is good for at least the refresh margin, minting + /// a new token if needed. This is the primitive the endpoint wrappers + /// use; call it directly to use the raw `endpoints` bindings. + pub async fn auth(&self) -> Result { + let token = self.fresh_token(Utc::now()).await?; + Ok(self.auth_for(token)) + } + + /// Force a new token, regardless of the current one's freshness. + pub async fn refresh(&self) -> Result { + let mut state = self.state.lock().await; + self.mint_locked(&mut state).await + } + + /// The cached token, if any (fresh or not). + pub async fn current_token(&self) -> Option { + self.state.lock().await.maybe_token.clone() + } + + /// Run an endpoint call with a fresh auth; on a `401`, mint once more and + /// retry, since the token may have been revoked or rotated server-side. + /// Bot-protection refusals are NOT retried — a new token can't pass a + /// challenge; check `needs_browser_reauth()` on the error instead. + pub async fn with_auth( + &self, + call: impl Fn(HiggsfieldAuth) -> Fut, + ) -> Result + where + Fut: std::future::Future>, + { + let auth = self.auth().await?; + match call(auth).await { + Ok(value) => Ok(value), + Err(err) if err.is_token_rejected() => { + warn!("Higgsfield request was unauthorized; minting a new session token and retrying once"); + let token = self.refresh().await?; + call(self.auth_for(token)).await + } + Err(err) => Err(err), + } + } + + // ── Private ── + + fn auth_for(&self, token: ClerkSessionToken) -> HiggsfieldAuth { + HiggsfieldAuth { + bearer_token: token.into_jwt(), + maybe_cookie_header: Some(self.cookies.as_header_value().to_string()), + maybe_datadome_client_id: self.maybe_datadome_client_id.clone(), + maybe_user_agent: self.maybe_user_agent.clone(), + } + } + + async fn fresh_token(&self, now: DateTime) -> Result { + let mut state = self.state.lock().await; + if let Some(token) = state.maybe_token.as_ref() { + if token.is_fresh(now, self.refresh_margin) { + return Ok(token.clone()); + } + } + self.mint_locked(&mut state).await + } + + /// Mint with the state lock held, so concurrent callers share one mint. + async fn mint_locked(&self, state: &mut SessionState) -> Result { + let token = match state.maybe_session_id.clone() { + Some(session_id) => match self.mint_for_session(&session_id).await { + Ok(token) => token, + Err(err) if err.is_token_rejected() || matches!(err, HiggsfieldError::Api(crate::error::higgsfield_api_error::HiggsfieldApiError::NoActiveSession { .. })) => { + // The remembered session may be gone; look the client up again. + warn!("Minting for Clerk session {} failed ({}); re-discovering the session", session_id, err); + self.discover_session_token().await? + } + Err(err) => return Err(err), + }, + None => self.discover_session_token().await?, + }; + + info!( + "Higgsfield session token minted for {} (expires {}, {}s from now)", + token.session_id(), token.expires_at(), token.remaining(Utc::now()).num_seconds(), + ); + + state.maybe_session_id = Some(token.session_id().to_string()); + state.maybe_token = Some(token.clone()); + Ok(token) + } + + async fn mint_for_session(&self, session_id: &str) -> Result { + clerk_session_tokens(ClerkSessionTokensArgs { + request: ClerkSessionTokensRequest { session_id: session_id.to_string(), maybe_organization_id: None }, + cookies: &self.cookies, + maybe_user_agent: self.maybe_user_agent.as_deref(), + host: &self.clerk_host, + }).await + } + + /// Ask Clerk which session is active. Its reply already includes a fresh + /// token; use that, minting explicitly only if it didn't. + async fn discover_session_token(&self) -> Result { + let client = clerk_client(ClerkClientArgs { + request: ClerkClientRequest, + cookies: &self.cookies, + maybe_user_agent: self.maybe_user_agent.as_deref(), + host: &self.clerk_host, + }).await?; + + // `clerk_client` guarantees an active session on success. + let session = client.active_session().expect("clerk_client returns Err without an active session"); + + let is_usable = |token: &ClerkSessionToken| token.is_fresh(Utc::now(), self.refresh_margin); + match session.maybe_last_active_token.as_ref().filter(|token| is_usable(token)) { + Some(token) => Ok(token.clone()), + None => self.mint_for_session(&session.id).await, + } + } +} + +impl std::fmt::Debug for HiggsfieldSession { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("HiggsfieldSession") + .field("cookies", &self.cookies) + .field("maybe_user_agent", &self.maybe_user_agent) + .field("has_datadome_client_id", &self.maybe_datadome_client_id.is_some()) + .field("api_host", &self.api_host) + .field("clerk_host", &self.clerk_host) + .field("refresh_margin", &self.refresh_margin) + .finish() + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::clerk_session_token::tests::{fake_clerk_jwt, fake_clerk_token}; + + fn cookies_with_session(jwt: &str) -> HiggsfieldCookies { + HiggsfieldCookies::from_cookie_header(format!("__client=client.cookie.value; __session={jwt}")) + } + + #[tokio::test] + async fn seeds_session_id_and_token_from_session_cookie() { + let jwt = fake_clerk_jwt(&serde_json::json!({"exp": 10, "iat": 5, "sid": "sess_SEED", "sub": "user_x"})); + let session = HiggsfieldSession::from_cookies(cookies_with_session(&jwt)); + let state = session.state.lock().await; + assert_eq!(state.maybe_session_id.as_deref(), Some("sess_SEED")); + assert_eq!(state.maybe_token.as_ref().unwrap().session_id(), "sess_SEED"); + } + + #[tokio::test] + async fn fresh_seed_token_is_reused_without_network() { + let far_future = (Utc::now() + Duration::hours(1)).timestamp(); + let token = fake_clerk_token(far_future); + // Unroutable hosts: any network attempt would fail loudly. + let session = HiggsfieldSession::from_cookie_header("__client=x") + .with_hosts(HiggsfieldHost::Custom("http://127.0.0.1:9".into()), ClerkHost::Custom("http://127.0.0.1:9".into())) + .with_initial_token(token.clone()); + + let auth = session.auth().await.unwrap(); + assert_eq!(auth.bearer_token, token.jwt()); + assert_eq!(auth.maybe_cookie_header.as_deref(), Some("__client=x")); + } + + #[tokio::test] + async fn expired_seed_token_triggers_mint() { + let expired = fake_clerk_token((Utc::now() - Duration::minutes(5)).timestamp()); + let session = HiggsfieldSession::from_cookie_header("__client=x") + .with_hosts(HiggsfieldHost::Custom("http://127.0.0.1:9".into()), ClerkHost::Custom("http://127.0.0.1:9".into())) + .with_initial_token(expired); + + // The mint goes to the unroutable Clerk host and fails as a network + // error — proving a refresh was attempted rather than the stale token + // being handed out. + let err = session.auth().await.unwrap_err(); + assert!(!err.is_auth_failure(), "unexpected: {err}"); + assert!(matches!(err, HiggsfieldError::Api(_)), "expected a transport failure, got {err}"); + } + + #[tokio::test] + async fn missing_client_cookie_fails_before_network() { + let session = HiggsfieldSession::from_cookie_header("__session=abc") + .with_hosts(HiggsfieldHost::Custom("http://127.0.0.1:9".into()), ClerkHost::Custom("http://127.0.0.1:9".into())); + let err = session.auth().await.unwrap_err(); + assert!(err.is_auth_failure()); + assert!(matches!(err, HiggsfieldError::Client(_))); + } + + #[test] + fn datadome_client_id_is_derived_from_the_cookie() { + let session = HiggsfieldSession::from_cookie_header("__client=x; datadome=Yw0QRSl16BFXimBAv1I7~SfJW6aNcwFV"); + assert_eq!(session.maybe_datadome_client_id(), Some("Yw0QRSl16BFXimBAv1I7~SfJW6aNcwFV")); + + let overridden = session.clone().with_datadome_client_id("other"); + assert_eq!(overridden.maybe_datadome_client_id(), Some("other")); + + let without = HiggsfieldSession::from_cookie_header("__client=x"); + assert_eq!(without.maybe_datadome_client_id(), None); + } + + #[tokio::test] + async fn user_agent_and_datadome_id_flow_into_auth() { + let far_future = (Utc::now() + Duration::hours(1)).timestamp(); + let session = HiggsfieldSession::from_cookie_header("__client=x; datadome=dd-id") + .with_user_agent(" Mozilla/5.0 Test ") + .with_initial_token(fake_clerk_token(far_future)); + let auth = session.auth().await.unwrap(); + assert_eq!(auth.maybe_user_agent.as_deref(), Some("Mozilla/5.0 Test")); + assert_eq!(auth.maybe_datadome_client_id.as_deref(), Some("dd-id")); + } + + #[test] + fn debug_is_redacted() { + let session = HiggsfieldSession::from_cookie_header("__client=super-secret").with_datadome_client_id("dd-secret"); + let debug = format!("{:?}", session); + assert!(!debug.contains("super-secret")); + assert!(!debug.contains("dd-secret")); + } + + // ── Live (ignored: needs captured cookies) ── + + #[tokio::test] + #[ignore] + async fn live_session_mints_and_reuses_token() -> anyhow::Result<()> { + use crate::test_utils::higgsfield_test_secrets::load_higgsfield_test_session; + use crate::test_utils::setup_test_logging::setup_test_logging; + setup_test_logging(); + + let session = load_higgsfield_test_session()?; + let first = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + let second = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + assert_eq!(first.bearer_token, second.bearer_token, "a fresh token should be reused"); + + let refreshed = session.refresh().await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!("Refreshed token expires {}", refreshed.expires_at()); + assert_ne!(refreshed.jwt(), first.bearer_token); + Ok(()) + } +} diff --git a/crates/api_clients/higgsfield_client/src/session/mod.rs b/crates/api_clients/higgsfield_client/src/session/mod.rs new file mode 100644 index 00000000..0c847ce4 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/session/mod.rs @@ -0,0 +1,7 @@ +//! The easy way in: [`HiggsfieldSession`](higgsfield_session::HiggsfieldSession). + +pub mod endpoint_wrappers; +pub mod higgsfield_session; +pub mod wait_for_job; +pub mod upload_media; +pub mod upload_source_guard; diff --git a/crates/api_clients/higgsfield_client/src/session/upload_media.rs b/crates/api_clients/higgsfield_client/src/session/upload_media.rs new file mode 100644 index 00000000..46f5f88c --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/session/upload_media.rs @@ -0,0 +1,317 @@ +//! Upload reference files through a [`HiggsfieldSession`]: presign, `PUT` +//! the bytes, confirm — and hand back the [`MediaInput`] descriptor a +//! generation request wants. + +use crate::endpoints::media::confirm_audio_upload::{confirm_audio_upload, ConfirmAudioUploadArgs, ConfirmAudioUploadRequest}; +use crate::endpoints::media::confirm_media_upload::{confirm_media_upload, ConfirmMediaUploadArgs, ConfirmMediaUploadRequest, ConfirmMediaUploadResponse}; +use crate::endpoints::media::confirm_video_upload::{confirm_video_upload, ConfirmVideoUploadArgs, ConfirmVideoUploadRequest}; +use crate::endpoints::media::create_audio_upload::{create_audio_upload, AudioUploadExtension, CreateAudioUploadArgs, CreateAudioUploadRequest}; +use crate::endpoints::media::create_media_batch::{create_media_batch, CreateMediaBatchArgs, CreateMediaBatchRequest}; +use crate::endpoints::media::create_reference_media::{create_reference_media, CreateReferenceMediaArgs, CreateReferenceMediaRequest}; +use crate::endpoints::media::create_video_upload::{create_video_upload, CreateVideoUploadArgs, CreateVideoUploadRequest}; +use crate::endpoints::media::get_media_status::{get_media_status, GetMediaStatusArgs, GetMediaStatusRequest, GetMediaStatusResponse, MediaStatusFamily}; +use crate::endpoints::media::upload_media_bytes::{upload_media_bytes, UploadMediaBytesArgs, UploadMediaBytesRequest}; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::session::upload_source_guard::check_upload_source_url; +use crate::types::ids::MediaId; +use crate::types::media_input::MediaInput; +use crate::types::media_mime_type::MediaMimeType; +use crate::types::presigned_media_upload::PresignedMediaUpload; +use log::info; +use std::time::{Duration, Instant}; + +/// How long [`HiggsfieldSession::wait_for_media_ip_check`] polls by default. +const DEFAULT_IP_CHECK_TIMEOUT: Duration = Duration::from_secs(90); + +const IP_CHECK_POLL_INTERVAL: Duration = Duration::from_secs(2); + +/// A file to upload as reference media. +#[derive(Clone, Debug)] +pub struct ReferenceMediaFile { + /// Shown in the web app's media library; its extension is also the + /// fallback for guessing `mime_type`. + pub file_name: String, + + pub mime_type: MediaMimeType, + + pub bytes: Vec, + + /// Ask the server to run its intellectual-property check on confirm, + /// and wait for it to finish before returning. Off by default (like the + /// web app's frame pickers). Required for models that refuse unchecked + /// media — Seedance 2.x answers `400 "IP check not finished for input + /// media"` otherwise. Images and video only; audio has no IP check. + pub force_ip_check: bool, + + /// Where the bytes were downloaded from, when they came from a URL. Set + /// it so uploads sourced from first-party domains are refused — see + /// `upload_source_guard`. + pub maybe_source_url: Option, +} + +impl ReferenceMediaFile { + pub fn new(file_name: impl Into, mime_type: MediaMimeType, bytes: Vec) -> Self { + Self { file_name: file_name.into(), mime_type, bytes, force_ip_check: false, maybe_source_url: None } + } + + /// Run and wait for the IP check (see [`Self::force_ip_check`]). + pub fn with_ip_check(mut self) -> Self { + self.force_ip_check = true; + self + } + + /// Record where the bytes were downloaded from (see + /// [`Self::maybe_source_url`]). + pub fn with_source_url(mut self, source_url: impl Into) -> Self { + self.maybe_source_url = Some(source_url.into()); + self + } + + /// Guess the type from the file name's extension. + pub fn from_file_name(file_name: impl Into, bytes: Vec) -> Result { + let file_name = file_name.into(); + let mime_type = MediaMimeType::from_file_name(&file_name) + .ok_or_else(|| HiggsfieldClientError::InvalidRequest(format!("can't tell the media type of {file_name:?}; pass it explicitly")))?; + Ok(Self { file_name, mime_type, bytes, force_ip_check: false, maybe_source_url: None }) + } + + fn validate(&self) -> Result<(), HiggsfieldClientError> { + if let Some(source_url) = &self.maybe_source_url { + check_upload_source_url(source_url)?; + } + if self.file_name.trim().is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("file_name is empty".to_string())); + } + if self.bytes.is_empty() { + return Err(HiggsfieldClientError::InvalidRequest(format!("{:?} has no bytes", self.file_name))); + } + if self.mime_type.is_audio() && AudioUploadExtension::for_mime_type(&self.mime_type).is_none() { + return Err(HiggsfieldClientError::InvalidRequest(format!( + "{:?}: audio uploads support only wav, mp3 or webm, not {}", self.file_name, self.mime_type, + ))); + } + Ok(()) + } + + fn family(&self) -> MediaFamily { + if self.mime_type.is_video() { + MediaFamily::Video + } else if self.mime_type.is_audio() { + MediaFamily::Audio + } else { + MediaFamily::Image + } + } +} + +/// Which presign / confirm pair a file goes through. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum MediaFamily { + Image, + Video, + Audio, +} + +impl HiggsfieldSession { + /// Upload one file — image, video or audio — and get back the descriptor + /// to reference it with. Picks the presign / confirm pair for the file's + /// type (`/fnf/reference-media`, `/fnf/video`, `/fnf/audio`). + /// + /// ```ignore + /// let reference = session.upload_reference_media(ReferenceMediaFile::from_file_name("cat.png", bytes)?).await?; + /// let request = NanoBanana2Request::text_to_image("the same cat, but on the moon", NanoBananaAspectRatio::Auto, NanoBanana2Resolution::OneK) + /// .with_reference_images(vec![reference]); + /// ``` + pub async fn upload_reference_media(&self, file: ReferenceMediaFile) -> Result { + file.validate()?; + + let slot = match file.family() { + MediaFamily::Image => self.with_auth(|auth| { + let request = CreateReferenceMediaRequest::new(file.mime_type.clone()); + async move { create_reference_media(CreateReferenceMediaArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?, + MediaFamily::Video => self.with_auth(|auth| { + let request = CreateVideoUploadRequest::new(file.mime_type.clone()); + async move { create_video_upload(CreateVideoUploadArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?, + MediaFamily::Audio => self.with_auth(|auth| { + let extension = AudioUploadExtension::for_mime_type(&file.mime_type).expect("validated above"); + let request = CreateAudioUploadRequest::new(extension, file.file_name.clone()); + async move { create_audio_upload(CreateAudioUploadArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?, + }; + + self.upload_and_confirm(&slot, file).await + } + + /// Upload several image files in one presign round trip, in order. Uses + /// the video generator's presign (`/fnf/media/batch`), which only takes + /// image types; upload video / audio one at a time with + /// [`Self::upload_reference_media`]. + pub async fn upload_reference_media_batch(&self, files: Vec) -> Result, HiggsfieldError> { + if files.is_empty() { + return Err(HiggsfieldClientError::InvalidRequest("no files to upload".to_string()).into()); + } + for file in &files { + file.validate()?; + } + + let mime_types: Vec = files.iter().map(|file| file.mime_type.clone()).collect(); + + let slots = self.with_auth(|auth| { + let request = CreateMediaBatchRequest::new(mime_types.clone()); + async move { create_media_batch(CreateMediaBatchArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?; + + if slots.len() != files.len() { + return Err(HiggsfieldClientError::InvalidRequest(format!( + "the server allocated {} upload slots for {} files", slots.len(), files.len(), + )).into()); + } + + let mut uploaded = Vec::with_capacity(files.len()); + for (slot, file) in slots.iter().zip(files) { + uploaded.push(self.upload_and_confirm(slot, file).await?); + } + Ok(uploaded) + } + + // ── Private ── + + async fn upload_and_confirm(&self, slot: &PresignedMediaUpload, file: ReferenceMediaFile) -> Result { + let family = file.family(); + let ReferenceMediaFile { file_name, mime_type, bytes, force_ip_check, .. } = file; + let byte_count = bytes.len(); + + upload_media_bytes(UploadMediaBytesArgs { + request: UploadMediaBytesRequest::for_slot(slot, bytes), + maybe_user_agent: self.maybe_user_agent(), + }).await?; + + let confirmation: ConfirmMediaUploadResponse = match family { + MediaFamily::Image => self.with_auth(|auth| { + let mut request = ConfirmMediaUploadRequest::new(slot.id.clone(), file_name.clone()); + request.force_ip_check = force_ip_check; + async move { confirm_media_upload(ConfirmMediaUploadArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?, + MediaFamily::Video => self.with_auth(|auth| { + let mut request = ConfirmVideoUploadRequest::new(slot.id.clone()); + request.maybe_force_ip_check = force_ip_check.then_some(true); + async move { confirm_video_upload(ConfirmVideoUploadArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?, + MediaFamily::Audio => self.with_auth(|auth| { + let request = ConfirmAudioUploadRequest::new(slot.id.clone()); + async move { confirm_audio_upload(ConfirmAudioUploadArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?, + }; + + info!( + "Higgsfield reference media {} uploaded ({} bytes, {}, status {})", + slot.id, byte_count, mime_type, confirmation.status, + ); + + if confirmation.is_ip_detected() { + return Err(HiggsfieldClientError::MediaProtectedContent { media_id: slot.id.clone() }.into()); + } + + if force_ip_check && !confirmation.ip_check_finished.unwrap_or(false) { + let status_family = match family { + MediaFamily::Image => Some(MediaStatusFamily::Image), + MediaFamily::Video => Some(MediaStatusFamily::Video), + MediaFamily::Audio => None, + }; + if let Some(status_family) = status_family { + self.wait_for_media_ip_check(status_family, &slot.id, DEFAULT_IP_CHECK_TIMEOUT).await?; + } + } + + Ok(slot.to_media_input()) + } +} + +impl HiggsfieldSession { + /// One status read of an uploaded image or clip (`GET /fnf/media/{id}` / + /// `/fnf/video/{id}`). Used to confirm a previously uploaded reference + /// still exists (and whether its IP check ran) before reusing its id. + pub async fn get_media_status(&self, family: MediaStatusFamily, media_id: &MediaId) -> Result { + self.with_auth(|auth| { + let request = GetMediaStatusRequest::new(family, media_id.clone()); + async move { get_media_status(GetMediaStatusArgs { request, auth: &auth, host: self.api_host() }).await } + }).await + } + + /// Poll the upload's status (`GET /fnf/media/{id}` for images, + /// `/fnf/video/{id}` for clips) until its IP check has finished. Only + /// completes if the check was requested (`force_ip_check` on confirm); + /// otherwise it times out with + /// [`HiggsfieldClientError::MediaIpCheckTimedOut`]. + pub async fn wait_for_media_ip_check(&self, family: MediaStatusFamily, media_id: &MediaId, timeout: Duration) -> Result { + let started = Instant::now(); + loop { + let status = self.with_auth(|auth| { + let request = GetMediaStatusRequest::new(family, media_id.clone()); + async move { get_media_status(GetMediaStatusArgs { request, auth: &auth, host: self.api_host() }).await } + }).await?; + + if status.is_ip_detected() { + return Err(HiggsfieldClientError::MediaProtectedContent { media_id: media_id.clone() }.into()); + } + if status.is_ip_check_finished() { + info!("Higgsfield media {} IP check finished after {}s (ip_detected={:?})", media_id, started.elapsed().as_secs(), status.ip_detected); + return Ok(status); + } + if started.elapsed() >= timeout { + return Err(HiggsfieldClientError::MediaIpCheckTimedOut { media_id: media_id.clone(), waited: started.elapsed() }.into()); + } + tokio::time::sleep(IP_CHECK_POLL_INTERVAL).await; + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn file_from_name_guesses_the_type() { + let file = ReferenceMediaFile::from_file_name("frame.JPG", vec![1]).unwrap(); + assert_eq!(file.mime_type, MediaMimeType::ImageJpeg); + assert!(matches!(ReferenceMediaFile::from_file_name("notes.txt", vec![1]), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn validation() { + assert!(matches!(ReferenceMediaFile::new("a.aac", MediaMimeType::AudioAac, vec![1]).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert_eq!(ReferenceMediaFile::new("a.mov", MediaMimeType::VideoQuicktime, vec![1]).family(), MediaFamily::Video); + assert_eq!(ReferenceMediaFile::new("a.mp3", MediaMimeType::AudioMpeg, vec![1]).family(), MediaFamily::Audio); + assert!(matches!(ReferenceMediaFile::new("a.png", MediaMimeType::ImagePng, vec![]).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert!(matches!(ReferenceMediaFile::new(" ", MediaMimeType::ImagePng, vec![1]).validate(), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert!(ReferenceMediaFile::new("a.png", MediaMimeType::ImagePng, vec![1]).validate().is_ok()); + } + + #[test] + fn first_party_source_urls_are_refused() { + let file = ReferenceMediaFile::new("a.png", MediaMimeType::ImagePng, vec![1]) + .with_source_url("https://cdn-2.fakeyou.com/media/a/image_a.png"); + assert!(matches!(file.validate(), Err(HiggsfieldClientError::UploadSourceDomainBlocked { .. }))); + let file = ReferenceMediaFile::new("a.png", MediaMimeType::ImagePng, vec![1]) + .with_source_url("https://cdn.example.com/a.png"); + assert!(file.validate().is_ok()); + } + + #[tokio::test] + async fn empty_inputs_fail_before_network() { + use crate::client::clerk_host::ClerkHost; + use crate::client::higgsfield_host::HiggsfieldHost; + let session = HiggsfieldSession::from_cookie_header("__client=x") + .with_hosts(HiggsfieldHost::Custom("http://127.0.0.1:9".into()), ClerkHost::Custom("http://127.0.0.1:9".into())); + + let err = session.upload_reference_media(ReferenceMediaFile::new("a.png", MediaMimeType::ImagePng, vec![])).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + + let err = session.upload_reference_media_batch(vec![]).await.unwrap_err(); + assert!(matches!(err, HiggsfieldError::Client(HiggsfieldClientError::InvalidRequest(_)))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/session/upload_source_guard.rs b/crates/api_clients/higgsfield_client/src/session/upload_source_guard.rs new file mode 100644 index 00000000..5f20bdd3 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/session/upload_source_guard.rs @@ -0,0 +1,105 @@ +//! Refuse to upload first-party assets to Higgsfield. Reference media is +//! downloaded from a source URL and re-uploaded as bytes; media sourced from +//! our own CDNs must never be handed to a third-party provider, so uploads +//! whose source URL is on a first-party domain are rejected client-side. + +use crate::error::higgsfield_client_error::HiggsfieldClientError; + +/// Domains (including their subdomains) that may not be used as upload +/// sources. These are first-party ArtCraft / FakeYou properties. +pub const BLOCKED_UPLOAD_SOURCE_DOMAINS: &[&str] = &[ + "fakeyou.com", + "getartcraft.com", + "artcraft.ai", + "cdn-2.fakeyou.com", // Subsumed by fakeyou.com; listed for clarity. +]; + +/// Err( [`HiggsfieldClientError::UploadSourceDomainBlocked`] ) if +/// `source_url`'s host is (or is a subdomain of) a blocked domain. +pub fn check_upload_source_url(source_url: &str) -> Result<(), HiggsfieldClientError> { + let Some(host) = url_host(source_url) else { + return Ok(()); + }; + match blocked_domain_for_host(&host) { + Some(domain) => Err(HiggsfieldClientError::UploadSourceDomainBlocked { + source_url: source_url.to_string(), + domain, + }), + None => Ok(()), + } +} + +fn blocked_domain_for_host(host: &str) -> Option<&'static str> { + let host = host.to_ascii_lowercase(); + BLOCKED_UPLOAD_SOURCE_DOMAINS.iter().copied().find(|domain| { + host == *domain || host.ends_with(&format!(".{domain}")) + }) +} + +/// The host of a URL, without scheme, userinfo, port, path or query. `None` +/// when there's no host to speak of (e.g. a relative path or empty string). +fn url_host(url: &str) -> Option { + let after_scheme = url.split_once("://").map(|(_, rest)| rest).unwrap_or(url); + let authority = after_scheme.split(['/', '?', '#']).next()?; + let host = authority.rsplit_once('@').map(|(_, host)| host).unwrap_or(authority); + let host = if host.starts_with('[') { + // Bracketed IPv6: keep everything through the closing bracket. + host.split_once(']').map(|(inside, _)| &host[..inside.len() + 1]).unwrap_or(host) + } else { + host.rsplit_once(':').map(|(host, _)| host).unwrap_or(host) + }; + if host.is_empty() { + return None; + } + Some(host.to_string()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn first_party_domains_are_blocked() { + for url in [ + "https://fakeyou.com/media/a.png", + "https://cdn-2.fakeyou.com/media/a/5/a/image_x.png", + "https://storage.getartcraft.com/media/a.png?query=1", + "https://artcraft.ai/a.png", + "https://ARTCRAFT.AI/a.png", + "http://user:pass@cdn.fakeyou.com:8080/a.png", + ] { + assert!( + matches!( + check_upload_source_url(url), + Err(HiggsfieldClientError::UploadSourceDomainBlocked { .. }), + ), + "{url} should be blocked", + ); + } + } + + #[test] + fn third_party_urls_pass() { + for url in [ + "https://cdn.example.com/a.png", + "https://notfakeyou.com/a.png", + "https://fakeyou.com.evil.example/a.png", + "https://higgsfield.ai/a.png", + "http://[::1]:8080/a.png", + "not a url", + "", + ] { + assert!(check_upload_source_url(url).is_ok(), "{url:?} should pass"); + } + } + + #[test] + fn hosts_extract() { + assert_eq!(url_host("https://cdn-2.fakeyou.com/a/b.png"), Some("cdn-2.fakeyou.com".to_string())); + assert_eq!(url_host("https://a.example.com:443?x=1"), Some("a.example.com".to_string())); + assert_eq!(url_host("http://user@host.example/a"), Some("host.example".to_string())); + assert_eq!(url_host("http://[::1]:8080/a"), Some("[::1]".to_string())); + assert_eq!(url_host(""), None); + assert_eq!(url_host("https://"), None); + } +} diff --git a/crates/api_clients/higgsfield_client/src/session/wait_for_job.rs b/crates/api_clients/higgsfield_client/src/session/wait_for_job.rs new file mode 100644 index 00000000..b71678b8 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/session/wait_for_job.rs @@ -0,0 +1,82 @@ +use crate::endpoints::jobs::job_status::JobStatusResponse; +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::error::higgsfield_error::HiggsfieldError; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::types::ids::JobId; +use crate::types::job_status::JobStatus; +use log::info; +use std::time::{Duration, Instant}; + +/// How to poll for a job to finish. +#[derive(Clone, Debug)] +pub struct WaitForJobOptions { + /// Time between status checks. + pub poll_interval: Duration, + + /// Give up after this long. + pub timeout: Duration, +} + +impl Default for WaitForJobOptions { + fn default() -> Self { + Self { + poll_interval: Duration::from_secs(3), + timeout: Duration::from_secs(10 * 60), + } + } +} + +impl HiggsfieldSession { + /// Poll until the job reaches a terminal state, then return its full + /// status (with result URLs when it completed). + /// + /// Polls the cheap batch endpoint and only fetches the full record at the + /// end. Errors with [`HiggsfieldClientError::JobTimedOut`] if the job + /// isn't done within `options.timeout`, and + /// [`HiggsfieldClientError::JobFailed`] if it ends in a non-success state. + pub async fn wait_for_job(&self, job_id: &JobId, options: WaitForJobOptions) -> Result { + let started = Instant::now(); + let ids = [job_id.clone()]; + + loop { + let batch = self.job_status_batch(&ids).await?; + + if batch.missing.contains(job_id) { + return Err(HiggsfieldClientError::JobNotFound(job_id.clone()).into()); + } + + let status = batch.find(job_id) + .map(|item| item.status.clone()) + .unwrap_or_else(|| JobStatus::Other("".to_string())); + + info!("Higgsfield job {} status: {} ({}s elapsed)", job_id, status, started.elapsed().as_secs()); + + if status.is_terminal() { + let job = self.job_status(job_id).await?; + if !job.status.is_success() { + let maybe_reason = job.fail_reason().map(str::to_string); + return Err(HiggsfieldClientError::JobFailed { job_id: job_id.clone(), status: job.status, maybe_reason }.into()); + } + return Ok(job); + } + + if started.elapsed() >= options.timeout { + return Err(HiggsfieldClientError::JobTimedOut { job_id: job_id.clone(), last_status: status, waited: started.elapsed() }.into()); + } + + tokio::time::sleep(options.poll_interval).await; + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn defaults_are_sane() { + let options = WaitForJobOptions::default(); + assert!(options.poll_interval >= Duration::from_secs(1)); + assert!(options.timeout > options.poll_interval); + } +} diff --git a/crates/api_clients/higgsfield_client/src/test_utils/higgsfield_credential_toml.rs b/crates/api_clients/higgsfield_client/src/test_utils/higgsfield_credential_toml.rs new file mode 100644 index 00000000..b4c7b1c9 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/test_utils/higgsfield_credential_toml.rs @@ -0,0 +1,90 @@ +//! Test-only loader for the desktop app's saved Higgsfield credential file +//! (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`), written by +//! the login window. Lets live tests run straight off a real app login +//! without copying cookies around. +//! +//! Override the path with `HIGGSFIELD_CREDENTIAL_TOML=/path/to/file.toml`. + +use crate::credentials::higgsfield_cookies::HiggsfieldCookies; +use crate::session::higgsfield_session::HiggsfieldSession; +use errors::AnyhowResult; +use serde::Deserialize; +use std::fs::read_to_string; +use std::path::PathBuf; + +const PATH_ENV_VAR: &str = "HIGGSFIELD_CREDENTIAL_TOML"; +const DEFAULT_RELATIVE_PATH: &str = "Artcraft/artcraftx/credentials/higgsfield_cookies.toml"; + +/// The subset of the app's credential TOML we need. (Mirrors +/// `crates/artcraftx/src/credentials/credential_toml.rs`, which this crate +/// can't depend on.) +#[derive(Deserialize)] +struct CredentialToml { + service: String, + + #[serde(default)] + user_info: Option, + + cookie: CookieSectionToml, +} + +#[derive(Deserialize)] +struct UserInfoToml { + #[serde(default)] + email: Option, +} + +#[derive(Deserialize)] +struct CookieSectionToml { + #[serde(default)] + cookies: Vec, +} + +#[derive(Deserialize)] +struct CookieToml { + name: String, + value: String, +} + +/// Where the credential file lives. +pub fn higgsfield_credential_toml_path() -> AnyhowResult { + if let Ok(path) = std::env::var(PATH_ENV_VAR) { + return Ok(PathBuf::from(path)); + } + let home = std::env::var("HOME").map_err(|_| anyhow::anyhow!("HOME is not set"))?; + Ok(PathBuf::from(home).join(DEFAULT_RELATIVE_PATH)) +} + +/// The cookies from the app's credential file, as one cookie header (every +/// cookie regardless of host — the gateway and Clerk both live under +/// higgsfield.ai, and the session needs Clerk's `__client`). +pub fn load_higgsfield_cookies_from_app_credential() -> AnyhowResult { + let path = higgsfield_credential_toml_path()?; + let raw = read_to_string(&path) + .map_err(|err| anyhow::anyhow!("Could not read Higgsfield credential {:?}: {} (log in via the app first)", path, err))?; + let parsed: CredentialToml = toml::from_str(&raw) + .map_err(|err| anyhow::anyhow!("Could not parse Higgsfield credential {:?}: {}", path, err))?; + + if parsed.service != "higgsfield_cookies" { + anyhow::bail!("{:?} is a {:?} credential, not higgsfield_cookies", path, parsed.service); + } + + let header = parsed.cookie.cookies.iter() + .map(|cookie| format!("{}={}", cookie.name, cookie.value)) + .collect::>() + .join("; "); + + println!( + "Loaded Higgsfield credential {:?}: {} cookies, email={:?}", + path, + parsed.cookie.cookies.len(), + parsed.user_info.and_then(|info| info.email), + ); + + Ok(HiggsfieldCookies::from_cookie_header(header)) +} + +/// A session backed by the app's credential file. +pub fn load_higgsfield_session_from_app_credential() -> AnyhowResult { + Ok(HiggsfieldSession::from_cookies(load_higgsfield_cookies_from_app_credential()?)) +} diff --git a/crates/api_clients/higgsfield_client/src/test_utils/higgsfield_test_secrets.rs b/crates/api_clients/higgsfield_client/src/test_utils/higgsfield_test_secrets.rs new file mode 100644 index 00000000..de962086 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/test_utils/higgsfield_test_secrets.rs @@ -0,0 +1,119 @@ +//! Test-only loader for a browser-captured Higgsfield session kept off to +//! the side in the (gitignored) `external/credentials/higgsfield` directory. +//! +//! Files (all plain text, whitespace trimmed): +//! +//! - `cookies.txt` — optional. The `cookie` header for higgsfield.ai, +//! INCLUDING the `__client` cookie from `clerk.higgsfield.ai` (in DevTools: +//! Application → Cookies → both hosts). When absent, the desktop app's +//! saved login (`~/Artcraft/artcraftx/credentials/higgsfield_cookies.toml`) +//! is used instead — so logging in through the app is enough. +//! - `bearer.txt` — optional. A captured `authorization: Bearer …` JWT; when +//! present it's used as-is (it expires after ~60s, so re-capture right +//! before running). Otherwise a token is minted from the cookies. +//! - `datadome_client_id.txt` — optional. The `x-datadome-clientid` header. +//! - `job_id.txt` — optional. A single job id for the status live tests. +//! - `job_ids.txt` — optional. Job ids for the status live tests, one per +//! line (`#` comments allowed). Real ids stay out of the repo. + +use crate::credentials::higgsfield_auth::HiggsfieldAuth; +use crate::credentials::higgsfield_cookies::HiggsfieldCookies; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::test_utils::higgsfield_credential_toml::load_higgsfield_session_from_app_credential; +use crate::types::ids::JobId; +use errors::AnyhowResult; +use std::fs::read_to_string; +use std::path::Path; + +/// Repo-root-relative directory holding the captured secrets. Resolved from +/// this crate's manifest dir so tests work regardless of the shell's working +/// directory. +const SECRETS_DIR: &str = concat!( + env!("CARGO_MANIFEST_DIR"), + "/../../../external/credentials/higgsfield", +); + +/// The captured cookies. +pub fn load_higgsfield_test_cookies() -> AnyhowResult { + Ok(HiggsfieldCookies::from_cookie_header(read_required("cookies.txt")?)) +} + +/// A session that mints its own tokens: from `cookies.txt` when present, +/// else from the desktop app's saved Higgsfield login (see +/// `higgsfield_credential_toml`), so a plain app login is enough to run +/// every live test. +pub fn load_higgsfield_test_session() -> AnyhowResult { + if read_optional("cookies.txt")?.is_none() { + return load_higgsfield_session_from_app_credential(); + } + let mut session = HiggsfieldSession::from_cookies(load_higgsfield_test_cookies()?); + if let Some(datadome_client_id) = read_optional("datadome_client_id.txt")? { + session = session.with_datadome_client_id(datadome_client_id); + } + Ok(session) +} + +/// A bearer auth for the raw endpoint bindings: a captured `bearer.txt` if +/// present, else minted by [`load_higgsfield_test_session`]. +pub async fn load_higgsfield_test_auth() -> AnyhowResult { + if read_optional("bearer.txt")?.is_none() { + let session = load_higgsfield_test_session()?; + return session.auth().await.map_err(|err| anyhow::anyhow!("Could not mint a Higgsfield session token: {err}")); + } + + let bearer = read_required("bearer.txt")?; + let mut auth = HiggsfieldAuth::new(bearer); + if let Some(datadome_client_id) = read_optional("datadome_client_id.txt")? { + auth = auth.with_datadome_client_id(datadome_client_id); + } + Ok(auth) +} + +/// A job id to poll in the status live tests: the first of `job_ids.txt`, +/// else `job_id.txt`. +pub fn load_higgsfield_test_job_id() -> AnyhowResult { + if let Some(first) = load_higgsfield_test_job_ids()?.into_iter().next() { + return Ok(first); + } + Ok(JobId::new(read_required("job_id.txt")?)) +} + +/// Every job id listed in `job_ids.txt` (falling back to `job_id.txt`). +/// Errors if neither file has any. +pub fn load_higgsfield_test_job_ids() -> AnyhowResult> { + let mut ids: Vec = read_optional("job_ids.txt")? + .unwrap_or_default() + .lines() + .map(|line| line.split('#').next().unwrap_or("").trim()) + .filter(|line| !line.is_empty()) + .map(JobId::new) + .collect(); + + if ids.is_empty() { + if let Some(single) = read_optional("job_id.txt")? { + ids.push(JobId::new(single)); + } + } + + if ids.is_empty() { + anyhow::bail!("No Higgsfield test job ids: add {}/job_ids.txt (one id per line) from a job this account ran", SECRETS_DIR); + } + Ok(ids) +} + +fn read_required(file_name: &str) -> AnyhowResult { + read_optional(file_name)?.ok_or_else(|| { + anyhow::anyhow!("Missing Higgsfield test secret {}/{} (capture it from a logged-in browser session)", SECRETS_DIR, file_name) + }) +} + +fn read_optional(file_name: &str) -> AnyhowResult> { + let path = Path::new(SECRETS_DIR).join(file_name); + if !path.exists() { + return Ok(None); + } + let raw = read_to_string(&path) + .map_err(|err| anyhow::anyhow!("Could not read Higgsfield test secret {:?}: {}", path, err))?; + let trimmed = raw.trim().to_string(); + Ok((!trimmed.is_empty()).then_some(trimmed)) +} diff --git a/crates/api_clients/higgsfield_client/src/test_utils/mod.rs b/crates/api_clients/higgsfield_client/src/test_utils/mod.rs new file mode 100644 index 00000000..b6bf6b0f --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/test_utils/mod.rs @@ -0,0 +1,4 @@ +pub mod higgsfield_credential_toml; +pub mod higgsfield_test_secrets; +pub mod poll_job_to_completion; +pub mod setup_test_logging; diff --git a/crates/api_clients/higgsfield_client/src/test_utils/poll_job_to_completion.rs b/crates/api_clients/higgsfield_client/src/test_utils/poll_job_to_completion.rs new file mode 100644 index 00000000..708b0ccb --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/test_utils/poll_job_to_completion.rs @@ -0,0 +1,97 @@ +//! Follow a freshly enqueued job through the status endpoints, printing every +//! step: the cheap batch status while it runs, then the full record once it's +//! done. Shared by the enqueue live tests. + +use crate::endpoints::jobs::job_status::{job_status, JobStatusArgs, JobStatusRequest, JobStatusResponse}; +use crate::endpoints::jobs::job_status_batch::{job_status_batch, JobStatusBatchArgs, JobStatusBatchRequest}; +use crate::session::higgsfield_session::HiggsfieldSession; +use crate::types::ids::JobId; +use std::time::{Duration, Instant}; + +const POLL_INTERVAL: Duration = Duration::from_secs(3); +const TIMEOUT: Duration = Duration::from_secs(10 * 60); + +pub async fn poll_job_to_completion(session: &HiggsfieldSession, job_id: &JobId) -> anyhow::Result { + let started = Instant::now(); + let ids = vec![job_id.clone()]; + + loop { + // Tokens live ~60s; ask the session each time so long jobs don't 401. + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let batch = job_status_batch(JobStatusBatchArgs { + request: JobStatusBatchRequest { ids: ids.clone() }, + auth: &auth, + host: session.api_host(), + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let item = batch.find(job_id) + .ok_or_else(|| anyhow::anyhow!("job {job_id} absent from batch response: {:?}", batch))?; + println!( + "[{:>4}s] POST /fnf/jobs/status-batch => {} status={} job_set_type={:?}", + started.elapsed().as_secs(), item.id, item.status, item.job_set_type, + ); + + if item.status.is_terminal() { + let job = job_status(JobStatusArgs { + request: JobStatusRequest { job_id: job_id.clone() }, + auth: &auth, + host: session.api_host(), + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + println!("\n===== GET /fnf/jobs/{job_id} (final) =====\n{:#?}", job); + println!("result_url = {:?}", job.result_url()); + anyhow::ensure!(job.status.is_success(), "job {job_id} ended in state {} (reason: {:?})", job.status, job.fail_reason()); + return Ok(job); + } + + anyhow::ensure!(started.elapsed() < TIMEOUT, "job {job_id} did not finish within {:?}", TIMEOUT); + tokio::time::sleep(POLL_INTERVAL).await; + } +} + +/// Like [`poll_job_to_completion`] for a whole batch: polls `status-batch` +/// until every job is terminal, then fetches and prints each full record. +/// Fails if any job ended unsuccessfully. +pub async fn poll_jobs_to_completion(session: &HiggsfieldSession, job_ids: &[JobId]) -> anyhow::Result> { + let started = Instant::now(); + + loop { + let auth = session.auth().await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let batch = job_status_batch(JobStatusBatchArgs { + request: JobStatusBatchRequest { ids: job_ids.to_vec() }, + auth: &auth, + host: session.api_host(), + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + + let mut all_terminal = true; + for job_id in job_ids { + let item = batch.find(job_id) + .ok_or_else(|| anyhow::anyhow!("job {job_id} absent from batch response: {:?}", batch))?; + println!("[{:>4}s] status-batch => {} status={}", started.elapsed().as_secs(), item.id, item.status); + all_terminal &= item.status.is_terminal(); + } + + if all_terminal { + let mut jobs = Vec::with_capacity(job_ids.len()); + for job_id in job_ids { + let job = job_status(JobStatusArgs { + request: JobStatusRequest { job_id: job_id.clone() }, + auth: &auth, + host: session.api_host(), + }).await.map_err(|err| anyhow::anyhow!("{err}"))?; + println!( + "\n===== GET /fnf/jobs/{job_id} (final) =====\nstatus={} type={} size={:?}x{:?} quality={:?} thinking={:?} seed={:?}\nresult_url = {:?}", + job.status, job.job_set_type, job.params.width, job.params.height, job.params.quality, job.params.thinking, job.params.seed, job.result_url(), + ); + anyhow::ensure!(job.status.is_success(), "job {job_id} ended in state {} (reason: {:?})", job.status, job.fail_reason()); + jobs.push(job); + } + return Ok(jobs); + } + + anyhow::ensure!(started.elapsed() < TIMEOUT, "jobs did not finish within {:?}", TIMEOUT); + tokio::time::sleep(POLL_INTERVAL).await; + } +} diff --git a/crates/api_clients/higgsfield_client/src/test_utils/setup_test_logging.rs b/crates/api_clients/higgsfield_client/src/test_utils/setup_test_logging.rs new file mode 100644 index 00000000..988ef648 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/test_utils/setup_test_logging.rs @@ -0,0 +1,14 @@ +use std::sync::Once; + +static INIT: Once = Once::new(); + +/// Initialize env_logger so live-API tests print request/response details. +/// Idempotent — safe to call from every test. +pub fn setup_test_logging() { + INIT.call_once(|| { + let _ = env_logger::builder() + .filter_level(log::LevelFilter::Debug) + .is_test(true) + .try_init(); + }); +} diff --git a/crates/api_clients/higgsfield_client/src/types/enqueue_jobs_response.rs b/crates/api_clients/higgsfield_client/src/types/enqueue_jobs_response.rs new file mode 100644 index 00000000..7316ea6f --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/enqueue_jobs_response.rs @@ -0,0 +1,154 @@ +use crate::types::ids::{JobId, JobSetId, UserId, WorkspaceId}; +use crate::types::job_params::JobParams; +use crate::types::job_set_type::JobSetType; +use crate::types::job_status::JobStatus; +use crate::types::wallet::Wallet; +use serde::Deserialize; +use serde_json::Value; + +/// What every `/fnf/jobs/...` enqueue returns: the job set(s) that were +/// created, plus the wallet after the cost was deducted. +#[derive(Clone, Debug, Deserialize)] +pub struct EnqueueJobsResponse { + /// The workspace the jobs were created in. + pub id: WorkspaceId, + + /// One job set per enqueue in practice. + pub job_sets: Vec, + + #[serde(default)] + pub has_more: bool, + + #[serde(default)] + pub wallet: Option, + + #[serde(default)] + pub workspace_details: Option, +} + +impl EnqueueJobsResponse { + /// The ids of every job created, across all job sets, in order. These are + /// what to poll. + pub fn job_ids(&self) -> Vec { + self.job_sets.iter() + .flat_map(|job_set| job_set.jobs.iter().map(|job| job.id.clone())) + .collect() + } + + /// The first job set (there's normally exactly one). + pub fn first_job_set(&self) -> Option<&JobSet> { + self.job_sets.first() + } +} + +/// One enqueue request: `batch_size` jobs sharing the same params. +#[derive(Clone, Debug, Deserialize)] +pub struct JobSet { + pub id: JobSetId, + + #[serde(rename = "type")] + pub job_set_type: JobSetType, + + #[serde(default)] + pub project_id: Option, + + /// Unix epoch seconds (fractional). + pub created_at: f64, + + #[serde(default)] + pub parent_id: Option, + + /// Credits charged for the whole set. + #[serde(default)] + pub cost: Option, + + #[serde(default)] + pub params: JobParams, + + pub jobs: Vec, + + #[serde(default)] + pub client_meta: Option, + + #[serde(default)] + pub chain_id: Option, +} + +/// A job as it appears right after enqueue (no results yet). +#[derive(Clone, Debug, Deserialize)] +pub struct EnqueuedJob { + pub id: JobId, + + pub status: JobStatus, + + /// Unix epoch seconds (fractional). + pub created_at: f64, + + #[serde(default)] + pub user_id: Option, + + #[serde(default)] + pub trace_id: Option, + + #[serde(default)] + pub cluster_hash: Option, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct WorkspaceDetails { + pub id: WorkspaceId, + + #[serde(default)] + pub name: Option, + + /// e.g. `private`. + #[serde(default, rename = "type")] + pub workspace_type: Option, + + /// e.g. `owner`. + #[serde(default)] + pub user_role: Option, + + #[serde(default)] + pub is_enterprise_sub_workspace: bool, +} + +#[cfg(test)] +pub(crate) mod tests { + use super::*; + + /// The enqueue response for a Nano Banana Pro job (ids / user scrubbed). + pub(crate) const NANO_BANANA_ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-00000000bbbb","type":"nano_banana_2","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788147223.616406,"parent_id":null,"cost":200,"params":{"width":864,"height":1184,"aspect_ratio":"3:4","resolution":"1k","batch_size":1,"input_images":[],"input_image":null,"application":null,"surface":null,"prompt":"a dinosaur on a skateboard"},"jobs":[{"id":"00000000-0000-0000-0000-00000000cccc","status":"waiting","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788147223.626676,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000cccc","folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":600,"subscription_balance":120000,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + /// The enqueue response for a GPT Image 2 job (ids / user scrubbed). + pub(crate) const GPT_IMAGE_ENQUEUE_RESPONSE: &str = r#"{"id":"00000000-0000-0000-0000-00000000aaaa","job_sets":[{"id":"00000000-0000-0000-0000-00000000dddd","type":"gpt_image_2","project_id":"00000000-0000-0000-0000-00000000aaaa","created_at":1788148993.964493,"parent_id":null,"cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","cost":850.0,"params":{"width":1152,"height":2048,"prompt":"a corgi on a bike","medias":[],"aspect_ratio":"9:16","quality":"high","resolution":"2k","model":"videotape-alpha","remove_bg":false,"reference_elements":[]},"jobs":[{"id":"00000000-0000-0000-0000-00000000eeee","status":"queued","ip_check_finished":null,"ip_detected":null,"result":null,"results":null,"board_ids":[],"published_at":null,"meta":{},"created_at":1788148993.971706,"user_id":"user_TESTUSER0000000000000000000","trace_id":"00000000-0000-0000-0000-00000000eeee","cluster_hash":"d8cd56aedaaaeedac3a5ed262f5eed0e","representation":null,"folder_ids":[],"is_favourite":false}],"client_meta":null,"chain_id":null}],"has_more":false,"wallet":{"workspace_id":"00000000-0000-0000-0000-00000000aaaa","credits_balance":0,"subscription_balance":119350,"wallet_created_at":"2026-08-31T03:26:11.027426Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90},"workspace_details":{"id":"00000000-0000-0000-0000-00000000aaaa","name":null,"type":"private","user_role":"owner","clerk_organization_id":null,"avatar_url":null,"bio":null,"grace_period_type":null,"sso_status":"idle","is_enterprise_sub_workspace":false,"sub_workspace_block":null},"free_gens_v2":{"items":[]},"generation_seconds":{"items":[]},"folder_credits":null}"#; + + #[test] + fn nano_banana_enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(NANO_BANANA_ENQUEUE_RESPONSE).unwrap(); + assert_eq!(response.id.as_str(), "00000000-0000-0000-0000-00000000aaaa"); + assert_eq!(response.job_sets.len(), 1); + + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::NanoBanana2); + assert_eq!(job_set.cost, Some(200.0)); + assert_eq!(job_set.params.prompt.as_deref(), Some("a dinosaur on a skateboard")); + assert_eq!(job_set.jobs.len(), 1); + assert_eq!(job_set.jobs[0].status, JobStatus::Waiting); + + assert_eq!(response.job_ids(), vec![JobId::new("00000000-0000-0000-0000-00000000cccc")]); + assert_eq!(response.wallet.as_ref().unwrap().credits_balance, 600.0); + assert_eq!(response.workspace_details.as_ref().unwrap().user_role.as_deref(), Some("owner")); + } + + #[test] + fn gpt_image_enqueue_response_parses() { + let response: EnqueueJobsResponse = serde_json::from_str(GPT_IMAGE_ENQUEUE_RESPONSE).unwrap(); + let job_set = response.first_job_set().unwrap(); + assert_eq!(job_set.job_set_type, JobSetType::GptImage2); + assert_eq!(job_set.cost, Some(850.0)); + assert_eq!(job_set.jobs[0].status, JobStatus::Queued); + assert_eq!(job_set.jobs[0].cluster_hash.as_deref(), Some("d8cd56aedaaaeedac3a5ed262f5eed0e")); + assert_eq!(job_set.params.model.as_deref(), Some("videotape-alpha")); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/ids.rs b/crates/api_clients/higgsfield_client/src/types/ids.rs new file mode 100644 index 00000000..3e79d984 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/ids.rs @@ -0,0 +1,89 @@ +//! Opaque identifiers. Newtypes so a job id can't be handed to something +//! expecting a job set id; all are transparent strings on the wire. + +use serde::{Deserialize, Serialize}; +use std::fmt::{Display, Formatter}; + +macro_rules! string_id { + ($(#[$meta:meta])* $name:ident) => { + $(#[$meta])* + #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] + #[serde(transparent)] + pub struct $name(String); + + impl $name { + pub fn new(raw: impl Into) -> Self { + Self(raw.into()) + } + + pub fn as_str(&self) -> &str { + &self.0 + } + + pub fn into_string(self) -> String { + self.0 + } + } + + impl Display for $name { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.write_str(&self.0) + } + } + + impl From for $name { + fn from(raw: String) -> Self { + Self(raw) + } + } + + impl From<&str> for $name { + fn from(raw: &str) -> Self { + Self(raw.to_string()) + } + } + }; +} + +string_id! { + /// A single generation job (one output). Poll it with the job status + /// endpoints. UUID-shaped. + JobId +} + +string_id! { + /// A job set: one enqueue request, which fans out into `batch_size` jobs. + /// UUID-shaped. + JobSetId +} + +string_id! { + /// The workspace (also used as the "project" id on job sets). UUID-shaped. + WorkspaceId +} + +string_id! { + /// A Clerk user id, e.g. `user_2abc...`. + UserId +} + +string_id! { + /// An uploaded reference file (image, video or audio), as returned by the + /// media upload endpoints and referenced from generation requests. + /// UUID-shaped. + MediaId +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn ids_are_transparent_strings() { + let id = JobId::new("11111111-2222-4333-8444-555555555555"); + assert_eq!(serde_json::to_string(&id).unwrap(), "\"11111111-2222-4333-8444-555555555555\""); + let parsed: JobId = serde_json::from_str("\"abc\"").unwrap(); + assert_eq!(parsed.as_str(), "abc"); + assert_eq!(parsed.to_string(), "abc"); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/image_aspect_ratio.rs b/crates/api_clients/higgsfield_client/src/types/image_aspect_ratio.rs new file mode 100644 index 00000000..8d79cafe --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/image_aspect_ratio.rs @@ -0,0 +1,71 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// Output aspect ratio for image generation — the union of every ratio the + /// web app offers across models (each model's request type narrows this to + /// its own list). Also what job params parse back into. + ImageAspectRatio { + /// Let the model pick (the web app offers this for reference-image + /// workflows). NB: wire value inferred from the UI label; not yet seen + /// in a captured request. + Auto => "auto", + Square1x1 => "1:1", + Portrait2x3 => "2:3", + Landscape3x2 => "3:2", + Portrait3x4 => "3:4", + Landscape4x3 => "4:3", + Portrait4x5 => "4:5", + Landscape5x4 => "5:4", + Portrait9x16 => "9:16", + Landscape16x9 => "16:9", + Landscape21x9 => "21:9", + } +} + +impl ImageAspectRatio { + /// Width / height as a ratio, e.g. `16:9` → `1.777…`. `Auto` has none; + /// `Other` values are parsed as `W:H` when possible. + pub fn ratio(&self) -> Option { + let (width, height) = self.as_str().split_once(':')?; + let width: f64 = width.parse().ok()?; + let height: f64 = height.parse().ok()?; + if height <= 0.0 || width <= 0.0 { + return None; + } + Some(width / height) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in ImageAspectRatio::known_variants() { + assert_eq!(&ImageAspectRatio::from_str_lossy(variant.as_str()), variant); + } + } + + #[test] + fn serde_uses_wire_string() { + assert_eq!(serde_json::to_string(&ImageAspectRatio::Portrait3x4).unwrap(), "\"3:4\""); + let parsed: ImageAspectRatio = serde_json::from_str("\"16:9\"").unwrap(); + assert_eq!(parsed, ImageAspectRatio::Landscape16x9); + } + + #[test] + fn unknown_parses_as_other() { + let parsed: ImageAspectRatio = serde_json::from_str("\"7:5\"").unwrap(); + assert_eq!(parsed, ImageAspectRatio::Other("7:5".to_string())); + assert_eq!(parsed.ratio(), Some(1.4)); + } + + #[test] + fn ratio() { + assert_eq!(ImageAspectRatio::Square1x1.ratio(), Some(1.0)); + assert!((ImageAspectRatio::Landscape16x9.ratio().unwrap() - 16.0 / 9.0).abs() < 1e-9); + assert_eq!(ImageAspectRatio::Other("nope".to_string()).ratio(), None); + assert_eq!(ImageAspectRatio::Auto.ratio(), None); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/image_batch_size.rs b/crates/api_clients/higgsfield_client/src/types/image_batch_size.rs new file mode 100644 index 00000000..c719b96e --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/image_batch_size.rs @@ -0,0 +1,89 @@ +use serde::{Deserialize, Serialize}; +use std::fmt::{Display, Formatter}; + +/// How many images one enqueue produces. The web app's counter runs 1–4 +/// for every image model, so this is a closed set rather than a bare +/// integer. Serializes as the number. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum ImageBatchSize { + #[default] + One, + Two, + Three, + Four, +} + +impl ImageBatchSize { + pub const MIN: u32 = 1; + pub const MAX: u32 = 4; + + pub fn as_u32(self) -> u32 { + match self { + Self::One => 1, + Self::Two => 2, + Self::Three => 3, + Self::Four => 4, + } + } + + /// `None` outside 1–4. + pub fn from_u32(count: u32) -> Option { + match count { + 1 => Some(Self::One), + 2 => Some(Self::Two), + 3 => Some(Self::Three), + 4 => Some(Self::Four), + _ => None, + } + } + + pub fn all() -> [Self; 4] { + [Self::One, Self::Two, Self::Three, Self::Four] + } +} + +impl Display for ImageBatchSize { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_u32()) + } +} + +impl Serialize for ImageBatchSize { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_u32(self.as_u32()) + } +} + +impl<'de> Deserialize<'de> for ImageBatchSize { + fn deserialize>(deserializer: D) -> Result { + let count = u32::deserialize(deserializer)?; + Self::from_u32(count).ok_or_else(|| serde::de::Error::custom(format!("batch size must be 1-4, got {count}"))) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trips_through_numbers() { + for size in ImageBatchSize::all() { + assert_eq!(ImageBatchSize::from_u32(size.as_u32()), Some(size)); + let json = serde_json::to_string(&size).unwrap(); + assert_eq!(json, size.as_u32().to_string()); + assert_eq!(serde_json::from_str::(&json).unwrap(), size); + } + } + + #[test] + fn rejects_out_of_range() { + assert_eq!(ImageBatchSize::from_u32(0), None); + assert_eq!(ImageBatchSize::from_u32(5), None); + assert!(serde_json::from_str::("7").is_err()); + } + + #[test] + fn default_is_one() { + assert_eq!(ImageBatchSize::default(), ImageBatchSize::One); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/image_dimensions.rs b/crates/api_clients/higgsfield_client/src/types/image_dimensions.rs new file mode 100644 index 00000000..2083cb46 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/image_dimensions.rs @@ -0,0 +1,107 @@ +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::image_resolution::ImageResolution; +use serde::{Deserialize, Serialize}; + +/// Pixel dimensions the web app sends alongside aspect ratio + resolution. +/// +/// The server treats these as advisory: it re-derives its own `width` / +/// `height` for the job (the enqueue response echoes the normalized values, +/// and they can change again once the job completes). We send what the web +/// app would so requests look the same. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct ImageDimensions { + pub width: u32, + pub height: u32, +} + +/// Dimensions snap to this grid on the short side, matching the web app. +const DIMENSION_STEP: u32 = 64; + +impl ImageDimensions { + pub fn new(width: u32, height: u32) -> Self { + Self { width, height } + } + + /// What the web app sends for an aspect ratio at a resolution tier: the + /// long side is fixed per tier and the short side is derived from the + /// ratio, rounded down to a multiple of 64. + /// + /// Long sides observed in captured requests: 1k → 1200, 2k → 2048, + /// 4k → 5504. `Auto` is sent as a square. Returns `None` for an + /// unparseable `Other` aspect ratio or an unknown resolution. + pub fn for_aspect_ratio(aspect_ratio: &ImageAspectRatio, resolution: &ImageResolution) -> Option { + let long_side = match resolution { + ImageResolution::OneK => 1200, + ImageResolution::TwoK => 2048, + ImageResolution::FourK => 5504, + ImageResolution::Other(_) => return None, + }; + + // "Auto" has no ratio of its own; the web app still has to send a size, + // so use a square at the tier's long side and let the server pick. + let ratio = match aspect_ratio { + ImageAspectRatio::Auto => 1.0, + other => other.ratio()?, + }; + + // ratio = width / height. The long side goes to whichever is bigger. + let short_side_exact = if ratio >= 1.0 { + long_side as f64 / ratio + } else { + long_side as f64 * ratio + }; + let short_side = (short_side_exact as u32 / DIMENSION_STEP) * DIMENSION_STEP; + + if ratio >= 1.0 { + Some(Self::new(long_side, short_side)) + } else { + Some(Self::new(short_side, long_side)) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + // Values captured from the web app's own requests. + + #[test] + fn matches_captured_nano_banana_3x4_1k() { + let dims = ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Portrait3x4, &ImageResolution::OneK).unwrap(); + assert_eq!(dims, ImageDimensions::new(896, 1200)); + } + + #[test] + fn matches_captured_nano_banana_16x9_4k() { + let dims = ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Landscape16x9, &ImageResolution::FourK).unwrap(); + assert_eq!(dims, ImageDimensions::new(5504, 3072)); + } + + #[test] + fn matches_captured_gpt_image_9x16_2k() { + let dims = ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Portrait9x16, &ImageResolution::TwoK).unwrap(); + assert_eq!(dims, ImageDimensions::new(1152, 2048)); + } + + #[test] + fn square_uses_long_side_for_both() { + let dims = ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Square1x1, &ImageResolution::TwoK).unwrap(); + assert_eq!(dims, ImageDimensions::new(2048, 2048)); + } + + #[test] + fn auto_is_sent_like_square() { + for resolution in [ImageResolution::OneK, ImageResolution::TwoK, ImageResolution::FourK] { + let auto = ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Auto, &resolution).unwrap(); + let square = ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Square1x1, &resolution).unwrap(); + assert_eq!(auto, square, "{}", resolution); + } + } + + #[test] + fn unknown_resolution_or_ratio_is_none() { + assert!(ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Square1x1, &ImageResolution::Other("8k".into())).is_none()); + assert!(ImageDimensions::for_aspect_ratio(&ImageAspectRatio::Other("wide".into()), &ImageResolution::OneK).is_none()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/image_quality.rs b/crates/api_clients/higgsfield_client/src/types/image_quality.rs new file mode 100644 index 00000000..1fd26a4b --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/image_quality.rs @@ -0,0 +1,28 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// The `quality` vocabulary across image models, as echoed in job params. + /// GPT Image 2 uses low / medium / high; the Seedream models map their + /// resolution menu onto basic / high / ultra. Each model's request type + /// narrows this to its own list. + ImageQuality { + Low => "low", + Medium => "medium", + High => "high", + Basic => "basic", + Ultra => "ultra", + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in ImageQuality::known_variants() { + assert_eq!(&ImageQuality::from_str_lossy(variant.as_str()), variant); + } + assert_eq!(serde_json::to_string(&ImageQuality::Ultra).unwrap(), "\"ultra\""); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/image_resolution.rs b/crates/api_clients/higgsfield_client/src/types/image_resolution.rs new file mode 100644 index 00000000..622521e2 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/image_resolution.rs @@ -0,0 +1,23 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// Output resolution tier for image generation. + ImageResolution { + OneK => "1k", + TwoK => "2k", + FourK => "4k", + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in ImageResolution::known_variants() { + assert_eq!(&ImageResolution::from_str_lossy(variant.as_str()), variant); + } + assert_eq!(serde_json::to_string(&ImageResolution::FourK).unwrap(), "\"4k\""); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/image_seed.rs b/crates/api_clients/higgsfield_client/src/types/image_seed.rs new file mode 100644 index 00000000..54954bde --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/image_seed.rs @@ -0,0 +1,45 @@ +use rand::Rng; +use serde::{Deserialize, Serialize}; + +/// The web app picks seeds in this range (six digits). +const MAX_RANDOM_SEED: u32 = 1_000_000; + +/// A generation seed. The Seedream endpoints expect one on every request; +/// the web app sends a fresh random one unless the user pins it. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(transparent)] +pub struct ImageSeed(u32); + +impl ImageSeed { + pub fn new(seed: u32) -> Self { + Self(seed) + } + + /// A random seed in the web app's range. + pub fn random() -> Self { + Self(rand::rng().random_range(0..MAX_RANDOM_SEED)) + } + + pub fn value(self) -> u32 { + self.0 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn serializes_as_number() { + assert_eq!(serde_json::to_string(&ImageSeed::new(158368)).unwrap(), "158368"); + let parsed: ImageSeed = serde_json::from_str("12745").unwrap(); + assert_eq!(parsed.value(), 12745); + } + + #[test] + fn random_is_in_range() { + for _ in 0..50 { + assert!(ImageSeed::random().value() < MAX_RANDOM_SEED); + } + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/job_media.rs b/crates/api_clients/higgsfield_client/src/types/job_media.rs new file mode 100644 index 00000000..3045566e --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/job_media.rs @@ -0,0 +1,65 @@ +use serde::{Deserialize, Serialize}; +use crate::types::string_enum::string_enum; + +string_enum! { + /// What kind of file a job result is. + JobMediaType { + Image => "image", + Video => "video", + } +} + +/// One rendition of a job's output. +#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)] +pub struct JobMedia { + #[serde(rename = "type")] + pub media_type: JobMediaType, + + /// A CDN URL. Observed hosts are CloudFront; treat as time-limited. + pub url: String, + + /// Videos come with a poster frame (`.webp`); images don't. + #[serde(default)] + pub thumbnail_url: Option, +} + +/// A completed job's outputs: the full-resolution file plus a preview. +#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)] +pub struct JobResults { + /// The full-resolution output (`.png` for images). + pub raw: JobMedia, + + /// A smaller preview. For images this is usually a `.webp`, but it can be + /// the same file as `raw` (observed for GPT Image 2). + pub min: JobMedia, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn video_results_carry_a_thumbnail() { + let json = r#"{ + "raw": {"type": "video", "url": "https://cdn.example.com/user_x/hf_20260831_061007_job.mp4", "thumbnail_url": "https://cdn.example.com/user_x/hf_20260831_061007_job_thumbnail.webp"}, + "min": {"type": "video", "url": "https://cdn.example.com/user_x/hf_20260831_061007_job.mp4", "thumbnail_url": "https://cdn.example.com/user_x/hf_20260831_061007_job_thumbnail.webp"} + }"#; + let results: JobResults = serde_json::from_str(json).unwrap(); + assert_eq!(results.raw.media_type, JobMediaType::Video); + assert!(results.raw.url.ends_with(".mp4")); + assert!(results.raw.thumbnail_url.as_deref().unwrap().ends_with("_thumbnail.webp")); + } + + #[test] + fn results_parse() { + let json = r#"{ + "raw": {"type": "image", "url": "https://cdn.example.com/user_x/hf_20260101_000000_job.png"}, + "min": {"type": "image", "url": "https://cdn.example.com/user_x/hf_20260101_000000_job_min.webp"} + }"#; + let results: JobResults = serde_json::from_str(json).unwrap(); + assert_eq!(results.raw.media_type, JobMediaType::Image); + assert!(results.raw.url.ends_with(".png")); + assert!(results.min.url.ends_with("_min.webp")); + assert!(results.raw.thumbnail_url.is_none()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/job_params.rs b/crates/api_clients/higgsfield_client/src/types/job_params.rs new file mode 100644 index 00000000..ed38f272 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/job_params.rs @@ -0,0 +1,170 @@ +use crate::types::image_quality::ImageQuality; +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::image_resolution::ImageResolution; +use crate::types::image_seed::ImageSeed; +use crate::types::media_input::MediaInput; +use crate::types::media_reference::MediaReference; +use crate::types::thinking_level::ThinkingLevel; +use crate::types::video_bitrate_mode::VideoBitrateMode; +use crate::types::video_mode::VideoMode; +use serde::Deserialize; +use serde_json::Value; + +/// The server's normalized view of a job's parameters, as echoed on job sets +/// and job status responses. +/// +/// Every pipeline has its own shape (nano banana has `input_images`, GPT +/// image has `medias` / `quality` / `model`, ...), so only the fields common +/// to image jobs are typed; everything else stays available in `extra`. +#[derive(Clone, Debug, Default, Deserialize)] +pub struct JobParams { + #[serde(default)] + pub prompt: Option, + + #[serde(default)] + pub aspect_ratio: Option, + + #[serde(default)] + pub resolution: Option, + + /// The server-derived pixel size (can differ from what was requested). + #[serde(default)] + pub width: Option, + + #[serde(default)] + pub height: Option, + + #[serde(default)] + pub batch_size: Option, + + /// GPT Image (low/medium/high) and Seedream lite / 4.5 (basic/high/ultra). + #[serde(default)] + pub quality: Option, + + /// Seedream models only. + #[serde(default)] + pub seed: Option, + + /// Nano Banana 2 Lite only. + #[serde(default)] + pub thinking: Option, + + // ── Video ── + + /// Clip length in whole seconds. + #[serde(default)] + pub duration: Option, + + /// Seedance: whether a soundtrack was generated. + #[serde(default)] + pub generate_audio: Option, + + /// Seedance 2.x: output bitrate tier. + #[serde(default)] + pub bitrate_mode: Option, + + /// Seedance 2.0 / Kling: the quality mode (`std` / `pro` / `4k`). + #[serde(default)] + pub mode: Option, + + /// GPT Image only: the sub-model actually used (e.g. `videotape-alpha`). + #[serde(default)] + pub model: Option, + + // ── References ── + + /// Reference media with roles (most models). Empty for text-only jobs. + #[serde(default)] + pub medias: Vec, + + /// Reference images on the two models that use this older field instead + /// of `medias` (Nano Banana Pro, Seedream 4.5). + #[serde(default)] + pub input_images: Vec, + + /// Everything not typed above, keyed by field name. + #[serde(flatten)] + pub extra: serde_json::Map, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_role::MediaRole; + + #[test] + fn nano_banana_params_parse() { + let json = r#"{"width":864,"height":1184,"aspect_ratio":"3:4","resolution":"1k","batch_size":1,"input_images":[],"input_image":null,"application":null,"surface":null,"prompt":"a dinosaur on a skateboard"}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.prompt.as_deref(), Some("a dinosaur on a skateboard")); + assert_eq!(params.aspect_ratio, Some(ImageAspectRatio::Portrait3x4)); + assert_eq!(params.resolution, Some(ImageResolution::OneK)); + assert_eq!((params.width, params.height), (Some(864), Some(1184))); + assert_eq!(params.batch_size, Some(1)); + assert!(params.quality.is_none()); + assert!(params.input_images.is_empty()); + assert!(!params.extra.contains_key("input_images")); + } + + #[test] + fn reference_media_parse_with_roles() { + let json = r#"{"width":854,"height":480,"prompt":"p","medias":[{"role":"start_image","data":{"id":"00000000-0000-4000-8000-000000000001","type":"media_input","url":"https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000001.png"}}],"duration":1,"resolution":"480p","aspect_ratio":"auto"}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.medias.len(), 1); + assert_eq!(params.medias[0].role, MediaRole::StartImage); + assert_eq!(params.medias[0].data.id.as_str(), "00000000-0000-4000-8000-000000000001"); + assert!(!params.extra.contains_key("medias")); + } + + #[test] + fn input_images_parse() { + let json = r#"{"width":1344,"height":768,"aspect_ratio":"16:9","resolution":"1k","batch_size":1,"input_images":[{"id":"00000000-0000-4000-8000-000000000002","type":"media_input","url":"https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000002.png"}],"input_image":null,"application":null,"surface":null,"prompt":"a corgi on a bike"}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.input_images, vec![MediaInput::uploaded("00000000-0000-4000-8000-000000000002", "https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000002.png")]); + } + + #[test] + fn seedream_lite_params_parse() { + let json = r#"{"prompt":"a corgi on a bike","medias":[],"batch_size":1,"aspect_ratio":"3:4","width":1728,"height":2304,"quality":"basic","seed":12745,"reference_elements":[]}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.quality, Some(ImageQuality::Basic)); + assert_eq!(params.seed, Some(ImageSeed::new(12745))); + assert!(params.resolution.is_none()); + } + + #[test] + fn nano_banana_2_lite_params_parse() { + let json = r#"{"width":864,"height":1184,"aspect_ratio":"3:4","batch_size":1,"thinking":"MINIMAL","is_inpaint":false,"prompt":"a corgi on a bike","medias":[],"reference_elements":[]}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.thinking, Some(ThinkingLevel::Minimal)); + assert_eq!(params.extra.get("is_inpaint"), Some(&Value::Bool(false))); + } + + #[test] + fn seedance_video_params_parse() { + let json = r#"{"width":854,"height":480,"prompt":"a shiba inu skateboarding down a hill","genre":"auto","medias":[],"duration":4,"resolution":"480p","aspect_ratio":"16:9","generate_audio":true,"multi_shots":false,"multi_shot_mode":"custom","multi_prompt":[],"speedramp":"auto","reference_elements":[],"prompt_language":"en","model":"default","extension_mode":null,"bitrate_mode":"high"}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.duration, Some(4)); + assert_eq!(params.generate_audio, Some(true)); + assert_eq!(params.bitrate_mode, Some(VideoBitrateMode::High)); + assert_eq!(params.resolution, Some(ImageResolution::Other("480p".to_string()))); + assert_eq!(params.extra.get("speedramp"), Some(&Value::String("auto".to_string()))); + } + + #[test] + fn kling_video_params_parse() { + let json = r#"{"width":1280,"height":720,"prompt":"p","medias":[],"duration":3,"aspect_ratio":"16:9","multi_shots":false,"multi_prompt":[],"sound":"on","cfg_scale":0.5,"mode":"std","kling_elements":[],"kling_element_ids":[],"multi_shot_mode":"auto","reference_elements":[],"enhance_prompt":true}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.mode, Some(VideoMode::Std)); + assert_eq!(params.duration, Some(3)); + } + + #[test] + fn gpt_image_params_parse() { + let json = r#"{"width":1152,"height":2048,"prompt":"a corgi on a bike","medias":[],"aspect_ratio":"9:16","quality":"high","resolution":"2k","model":"videotape-alpha","remove_bg":false,"reference_elements":[]}"#; + let params: JobParams = serde_json::from_str(json).unwrap(); + assert_eq!(params.quality, Some(ImageQuality::High)); + assert_eq!(params.model.as_deref(), Some("videotape-alpha")); + assert_eq!(params.extra.get("remove_bg"), Some(&Value::Bool(false))); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/job_set_type.rs b/crates/api_clients/higgsfield_client/src/types/job_set_type.rs new file mode 100644 index 00000000..42677fb7 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/job_set_type.rs @@ -0,0 +1,42 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// Which model/pipeline a job set ran. This is the `type` on a job set and + /// `job_set_type` on job status responses. + JobSetType { + /// Nano Banana Pro (the web app's name); `nano-banana-2` on the wire. + NanoBanana2 => "nano_banana_2", + /// Nano Banana 2 (the web app's name); `nano_banana_flash` on the wire. + NanoBananaFlash => "nano_banana_flash", + NanoBanana2Lite => "nano_banana_2_lite", + GptImage2 => "gpt_image_2", + SeedreamV5Pro => "seedream_v5_pro", + SeedreamV5Lite => "seedream_v5_lite", + SeedreamV4p5 => "seedream_v4_5", + // ── Video ── + Seedance2p5 => "seedance_2_5", + Seedance2p0 => "seedance_2_0", + Seedance2p0Mini => "seedance_2_0_mini", + MinimaxH3 => "minimax_h3", + Kling3p0 => "kling3_0", + GrokVideoV15 => "grok_video_v15", + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in JobSetType::known_variants() { + assert_eq!(&JobSetType::from_str_lossy(variant.as_str()), variant); + } + let parsed: JobSetType = serde_json::from_str("\"seedance_2\"").unwrap(); + assert_eq!(parsed, JobSetType::Other("seedance_2".to_string())); + assert_eq!(JobSetType::from_str_lossy("seedream_v4_5"), JobSetType::SeedreamV4p5); + assert_eq!(JobSetType::from_str_lossy("nano_banana_flash"), JobSetType::NanoBananaFlash); + assert_eq!(JobSetType::from_str_lossy("kling3_0"), JobSetType::Kling3p0); + assert_eq!(JobSetType::from_str_lossy("grok_video_v15"), JobSetType::GrokVideoV15); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/job_status.rs b/crates/api_clients/higgsfield_client/src/types/job_status.rs new file mode 100644 index 00000000..315e9b3f --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/job_status.rs @@ -0,0 +1,60 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// Lifecycle state of a job. + /// + /// Observed: `waiting` (nano banana, right after enqueue), `queued` (GPT + /// image, right after enqueue), `in_progress`, `completed`. The failure + /// states haven't been captured yet, so they're best guesses; anything + /// unexpected lands in `Other` rather than breaking status polling. + JobStatus { + Waiting => "waiting", + Queued => "queued", + InProgress => "in_progress", + Completed => "completed", + Failed => "failed", + Cancelled => "cancelled", + Nsfw => "nsfw", + } +} + +impl JobStatus { + /// The job has reached an end state (successfully or not). + pub fn is_terminal(&self) -> bool { + match self { + Self::Waiting | Self::Queued | Self::InProgress => false, + Self::Completed | Self::Failed | Self::Cancelled | Self::Nsfw => true, + // Unknown states: don't claim to know. Callers polling should keep + // going and rely on their own timeout. + Self::Other(_) => false, + } + } + + pub fn is_success(&self) -> bool { + matches!(self, Self::Completed) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in JobStatus::known_variants() { + assert_eq!(&JobStatus::from_str_lossy(variant.as_str()), variant); + } + } + + #[test] + fn terminal_states() { + assert!(!JobStatus::Waiting.is_terminal()); + assert!(!JobStatus::Queued.is_terminal()); + assert!(!JobStatus::InProgress.is_terminal()); + assert!(JobStatus::Completed.is_terminal()); + assert!(JobStatus::Completed.is_success()); + assert!(JobStatus::Failed.is_terminal()); + assert!(!JobStatus::Failed.is_success()); + assert!(!JobStatus::Other("mystery".into()).is_terminal()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/media_input.rs b/crates/api_clients/higgsfield_client/src/types/media_input.rs new file mode 100644 index 00000000..73b17075 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/media_input.rs @@ -0,0 +1,98 @@ +//! The descriptor generation requests use to point at a reference file. + +use crate::types::ids::MediaId; +use crate::types::string_enum::string_enum; +use serde::{Deserialize, Serialize}; + +string_enum! { + /// Where a reference comes from. The web app builds `media_input` for + /// images it uploaded, `video_input` / `audio_input` for uploaded clips + /// and tracks, and `image_job` / `video_job` when a previous generation + /// is reused as a reference (then `id` is the job id). + MediaInputKind { + MediaInput => "media_input", + VideoInput => "video_input", + AudioInput => "audio_input", + ImageJob => "image_job", + VideoJob => "video_job", + } +} + +/// A reference file as the API knows it: the id the upload endpoints +/// handed out and the CDN URL they published it at. Bytes are never sent +/// with a generation request — only this descriptor. +/// +/// On the wire: `{"id": "", "type": "media_input", "url": "https://…"}`. +/// (The web app also tacks on `ipCheckFinished` / `ipStatus`; the server +/// drops them, so this client doesn't send them.) +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct MediaInput { + pub id: MediaId, + + #[serde(rename = "type")] + pub kind: MediaInputKind, + + pub url: String, +} + +impl MediaInput { + /// An image uploaded through the media endpoints (see + /// `endpoints::media` / `HiggsfieldSession::upload_reference_media`). + pub fn uploaded(id: impl Into, url: impl Into) -> Self { + Self { id: id.into(), kind: MediaInputKind::MediaInput, url: url.into() } + } + + /// An uploaded video clip. + pub fn uploaded_video(id: impl Into, url: impl Into) -> Self { + Self { id: id.into(), kind: MediaInputKind::VideoInput, url: url.into() } + } + + /// An uploaded audio track. + pub fn uploaded_audio(id: impl Into, url: impl Into) -> Self { + Self { id: id.into(), kind: MediaInputKind::AudioInput, url: url.into() } + } + + /// A previous image generation, by job id and result URL. + pub fn from_image_job(job_id: impl Into, url: impl Into) -> Self { + Self { id: job_id.into(), kind: MediaInputKind::ImageJob, url: url.into() } + } + + /// A previous video generation, by job id and result URL. + pub fn from_video_job(job_id: impl Into, url: impl Into) -> Self { + Self { id: job_id.into(), kind: MediaInputKind::VideoJob, url: url.into() } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + #[test] + fn serializes_like_the_web_app() { + let input = MediaInput::uploaded("00000000-0000-4000-8000-000000000001", "https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000001.png"); + let actual: Value = serde_json::to_value(&input).unwrap(); + assert_eq!(actual, json!({ + "id": "00000000-0000-4000-8000-000000000001", + "type": "media_input", + "url": "https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000001.png", + })); + } + + #[test] + fn parses_the_server_echo_and_the_web_apps_extra_fields() { + // As echoed in job set / job status params. + let echoed: MediaInput = serde_json::from_str(r#"{"id":"abc","type":"media_input","url":"https://cdn.example.com/x.png"}"#).unwrap(); + assert_eq!(echoed, MediaInput::uploaded("abc", "https://cdn.example.com/x.png")); + + // As the web app sends it (extra fields ignored). + let sent: MediaInput = serde_json::from_str(r#"{"id":"abc","url":"https://cdn.example.com/x.png","type":"media_input","ipCheckFinished":null,"ipStatus":"uploaded"}"#).unwrap(); + assert_eq!(sent, echoed); + + let job: MediaInput = serde_json::from_str(r#"{"id":"job-1","type":"video_job","url":"https://cdn.example.com/x.mp4"}"#).unwrap(); + assert_eq!(job.kind, MediaInputKind::VideoJob); + + let unknown: MediaInput = serde_json::from_str(r#"{"id":"x","type":"element","url":"u"}"#).unwrap(); + assert_eq!(unknown.kind, MediaInputKind::Other("element".to_string())); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/media_mime_type.rs b/crates/api_clients/higgsfield_client/src/types/media_mime_type.rs new file mode 100644 index 00000000..1e5eacfa --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/media_mime_type.rs @@ -0,0 +1,130 @@ +//! The file types the web app's upload pickers accept. + +use crate::types::string_enum::string_enum; + +string_enum! { + /// A reference file's MIME type, as sent to the presign endpoints and as + /// the `Content-Type` of the storage upload. + /// + /// `/fnf/media/batch` accepts exactly the image types (its 422 lists + /// jpeg, jpg, png, webp, gif, heic, heif, avif); the web app's media + /// library picker also offers the video and audio types below. + MediaMimeType { + ImageJpeg => "image/jpeg", + ImagePng => "image/png", + ImageWebp => "image/webp", + ImageHeic => "image/heic", + ImageHeif => "image/heif", + ImageGif => "image/gif", + ImageAvif => "image/avif", + VideoMp4 => "video/mp4", + VideoWebm => "video/webm", + VideoOgg => "video/ogg", + VideoQuicktime => "video/quicktime", + AudioWav => "audio/wav", + /// What the audio presign hands back for a `wav`. + AudioXWav => "audio/x-wav", + AudioMpeg => "audio/mpeg", + AudioMp4 => "audio/mp4", + AudioAac => "audio/aac", + AudioOgg => "audio/ogg", + AudioWebm => "audio/webm", + } +} + +impl MediaMimeType { + /// Guess from a file name / extension (case-insensitive). `None` for + /// anything the web app wouldn't accept. + pub fn from_file_name(file_name: &str) -> Option { + let extension = file_name.rsplit('.').next()?.to_ascii_lowercase(); + let mime = match extension.as_str() { + "jpg" | "jpeg" => Self::ImageJpeg, + "png" => Self::ImagePng, + "webp" => Self::ImageWebp, + "heic" => Self::ImageHeic, + "heif" => Self::ImageHeif, + "gif" => Self::ImageGif, + "avif" => Self::ImageAvif, + "mp4" => Self::VideoMp4, + "webm" => Self::VideoWebm, + "ogv" => Self::VideoOgg, + "mov" => Self::VideoQuicktime, + "wav" => Self::AudioWav, + "mp3" => Self::AudioMpeg, + "m4a" => Self::AudioMp4, + "aac" => Self::AudioAac, + "ogg" | "oga" => Self::AudioOgg, + _ => return None, + }; + Some(mime) + } + + /// The extension the CDN URL will carry for this type. + pub fn file_extension(&self) -> &str { + match self { + Self::ImageJpeg => "jpg", + Self::ImagePng => "png", + Self::ImageWebp => "webp", + Self::ImageHeic => "heic", + Self::ImageHeif => "heif", + Self::ImageGif => "gif", + Self::ImageAvif => "avif", + Self::VideoMp4 => "mp4", + Self::VideoWebm => "webm", + Self::VideoOgg => "ogv", + Self::VideoQuicktime => "mov", + Self::AudioWav | Self::AudioXWav => "wav", + Self::AudioMpeg => "mp3", + Self::AudioMp4 => "m4a", + Self::AudioAac => "aac", + Self::AudioOgg => "ogg", + Self::AudioWebm => "webm", + Self::Other(raw) => raw.rsplit('/').next().unwrap_or(raw), + } + } + + pub fn is_image(&self) -> bool { + self.as_str().starts_with("image/") + } + + pub fn is_video(&self) -> bool { + self.as_str().starts_with("video/") + } + + pub fn is_audio(&self) -> bool { + self.as_str().starts_with("audio/") + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn guesses_from_file_names() { + assert_eq!(MediaMimeType::from_file_name("shiba.PNG"), Some(MediaMimeType::ImagePng)); + assert_eq!(MediaMimeType::from_file_name("/tmp/a.b/clip.mov"), Some(MediaMimeType::VideoQuicktime)); + assert_eq!(MediaMimeType::from_file_name("tone.wav"), Some(MediaMimeType::AudioWav)); + assert_eq!(MediaMimeType::from_file_name("readme.txt"), None); + assert_eq!(MediaMimeType::from_file_name("noextension"), None); + } + + #[test] + fn classifies_by_family() { + assert!(MediaMimeType::ImageWebp.is_image()); + assert!(MediaMimeType::VideoMp4.is_video()); + assert!(MediaMimeType::AudioMpeg.is_audio()); + assert!(!MediaMimeType::AudioMpeg.is_image()); + assert!(MediaMimeType::Other("image/gif".to_string()).is_image()); + } + + #[test] + fn wire_strings_round_trip() { + for mime in MediaMimeType::known_variants() { + assert_eq!(&MediaMimeType::from_str_lossy(mime.as_str()), mime); + assert_eq!(serde_json::to_string(mime).unwrap(), format!("\"{}\"", mime.as_str())); + } + assert_eq!(MediaMimeType::VideoMp4.file_extension(), "mp4"); + assert_eq!(MediaMimeType::Other("image/gif".to_string()).file_extension(), "gif"); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/media_reference.rs b/crates/api_clients/higgsfield_client/src/types/media_reference.rs new file mode 100644 index 00000000..b97f9776 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/media_reference.rs @@ -0,0 +1,102 @@ +//! A reference file with its role, as listed in a request's `medias`. + +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use crate::types::media_input::MediaInput; +use crate::types::media_role::MediaRole; +use serde::{Deserialize, Serialize}; + +/// One entry of a `medias` list: `{"role": "...", "data": {}}`. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct MediaReference { + pub role: MediaRole, + pub data: MediaInput, +} + +impl MediaReference { + pub fn new(role: MediaRole, data: MediaInput) -> Self { + Self { role, data } + } + + /// A style / subject reference image. + pub fn image(data: MediaInput) -> Self { + Self::new(MediaRole::Image, data) + } + + /// The video's first frame. + pub fn start_frame(data: MediaInput) -> Self { + Self::new(MediaRole::StartImage, data) + } + + /// The video's last frame. + pub fn end_frame(data: MediaInput) -> Self { + Self::new(MediaRole::EndImage, data) + } + + /// A reference video clip. + pub fn video(data: MediaInput) -> Self { + Self::new(MediaRole::Video, data) + } + + /// A reference audio track. + pub fn audio(data: MediaInput) -> Self { + Self::new(MediaRole::Audio, data) + } +} + +/// Reject roles a model doesn't take, and duplicate frames (a video has one +/// start and one end). `model` names the model in the error message. +pub fn validate_media_roles(medias: &[MediaReference], allowed: &[MediaRole], model: &str) -> Result<(), HiggsfieldClientError> { + for reference in medias { + if !allowed.contains(&reference.role) { + let allowed_list: Vec<&str> = allowed.iter().map(|role| role.as_str()).collect(); + return Err(HiggsfieldClientError::InvalidRequest(format!( + "{model} does not take `{}` media; it accepts: {}", + reference.role, allowed_list.join(", "), + ))); + } + } + + for role in [MediaRole::StartImage, MediaRole::EndImage] { + let count = medias.iter().filter(|reference| reference.role == role).count(); + if count > 1 { + return Err(HiggsfieldClientError::InvalidRequest(format!("{model} takes at most one `{role}`; got {count}"))); + } + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::{json, Value}; + + fn input(id: &str) -> MediaInput { + MediaInput::uploaded(id, format!("https://cdn.example.com/user_x/{id}.png")) + } + + #[test] + fn serializes_like_the_web_app() { + let actual: Value = serde_json::to_value(MediaReference::start_frame(input("m1"))).unwrap(); + assert_eq!(actual, json!({"role": "start_image", "data": {"id": "m1", "type": "media_input", "url": "https://cdn.example.com/user_x/m1.png"}})); + } + + #[test] + fn parses_the_server_echo() { + let echoed: Vec = serde_json::from_str(r#"[{"role":"image","data":{"id":"m1","type":"media_input","url":"https://cdn.example.com/user_x/m1.png"}}]"#).unwrap(); + assert_eq!(echoed, vec![MediaReference::image(input("m1"))]); + } + + #[test] + fn role_validation() { + let allowed = [MediaRole::StartImage, MediaRole::Image]; + assert!(validate_media_roles(&[], &allowed, "m").is_ok()); + assert!(validate_media_roles(&[MediaReference::start_frame(input("a")), MediaReference::image(input("b")), MediaReference::image(input("c"))], &allowed, "m").is_ok()); + + let err = validate_media_roles(&[MediaReference::end_frame(input("a"))], &allowed, "Grok").unwrap_err(); + assert!(err.to_string().contains("Grok does not take `end_image`"), "{err}"); + + let err = validate_media_roles(&[MediaReference::start_frame(input("a")), MediaReference::start_frame(input("b"))], &allowed, "m").unwrap_err(); + assert!(err.to_string().contains("at most one `start_image`"), "{err}"); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/media_role.rs b/crates/api_clients/higgsfield_client/src/types/media_role.rs new file mode 100644 index 00000000..4cfffaba --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/media_role.rs @@ -0,0 +1,47 @@ +//! What a reference file is *for* in a generation request. + +use crate::types::string_enum::string_enum; + +string_enum! { + /// The `role` of an entry in a request's `medias` list. The set comes + /// from the web app's own filter (`role === "image" || "start_image" || + /// "end_image" || "video" || "audio"`); which roles a given model accepts + /// is per model — see each request type's `MEDIA_ROLES`. + MediaRole { + /// A style / subject reference image (image-to-image, or a video + /// model's "references"). + Image => "image", + + /// The first frame of a video. + StartImage => "start_image", + + /// The last frame of a video. + EndImage => "end_image", + + /// A reference video clip (Seedance 2.x, MiniMax H3 references). + Video => "video", + + /// A reference audio track (Seedance 2.x, MiniMax H3 references). + Audio => "audio", + } +} + +impl MediaRole { + /// Frames are singular: at most one start and one end image per request. + pub fn is_frame(&self) -> bool { + matches!(self, Self::StartImage | Self::EndImage) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_strings_match_the_web_app() { + let wire: Vec<&str> = MediaRole::known_variants().iter().map(|r| r.as_str()).collect(); + assert_eq!(wire, ["image", "start_image", "end_image", "video", "audio"]); + assert!(MediaRole::StartImage.is_frame()); + assert!(!MediaRole::Image.is_frame()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/mod.rs b/crates/api_clients/higgsfield_client/src/types/mod.rs new file mode 100644 index 00000000..5cc831f0 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/mod.rs @@ -0,0 +1,33 @@ +//! Typed vocabulary shared across endpoints: closed-set enums for request +//! parameters (with an `Other` escape hatch when parsing responses) and the +//! response structures several endpoints return. + +pub(crate) mod string_enum; + +pub mod enqueue_jobs_response; +pub mod ids; +pub mod image_aspect_ratio; +pub mod image_batch_size; +pub mod image_dimensions; +pub mod image_quality; +pub mod image_resolution; +pub mod image_seed; +pub mod job_media; +pub mod job_params; +pub mod job_set_type; +pub mod job_status; +pub mod media_input; +pub mod media_mime_type; +pub mod media_reference; +pub mod media_role; +pub mod nano_banana_aspect_ratio; +pub mod presigned_media_upload; +pub mod seedream_aspect_ratio; +pub mod thinking_level; +pub mod video_aspect_ratio; +pub mod video_bitrate_mode; +pub mod video_dimensions; +pub mod video_duration; +pub mod video_mode; +pub mod video_resolution; +pub mod wallet; diff --git a/crates/api_clients/higgsfield_client/src/types/nano_banana_aspect_ratio.rs b/crates/api_clients/higgsfield_client/src/types/nano_banana_aspect_ratio.rs new file mode 100644 index 00000000..5a6abc54 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/nano_banana_aspect_ratio.rs @@ -0,0 +1,82 @@ +use crate::types::image_aspect_ratio::ImageAspectRatio; +use serde::Serialize; + +/// The aspect ratios the web app offers for the Nano Banana models (Pro, 2, +/// 2 Lite), in its menu order. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub enum NanoBananaAspectRatio { + /// Let the model pick (meant for reference-image workflows). + Auto, + Square1x1, + Portrait3x4, + Landscape4x3, + Portrait2x3, + Landscape3x2, + Portrait9x16, + Landscape16x9, + Landscape5x4, + Portrait4x5, + Landscape21x9, +} + +impl NanoBananaAspectRatio { + pub fn all() -> [Self; 11] { + [ + Self::Auto, Self::Square1x1, Self::Portrait3x4, Self::Landscape4x3, Self::Portrait2x3, Self::Landscape3x2, + Self::Portrait9x16, Self::Landscape16x9, Self::Landscape5x4, Self::Portrait4x5, Self::Landscape21x9, + ] + } + + /// The wire vocabulary value. + pub fn to_image_aspect_ratio(self) -> ImageAspectRatio { + match self { + Self::Auto => ImageAspectRatio::Auto, + Self::Square1x1 => ImageAspectRatio::Square1x1, + Self::Portrait3x4 => ImageAspectRatio::Portrait3x4, + Self::Landscape4x3 => ImageAspectRatio::Landscape4x3, + Self::Portrait2x3 => ImageAspectRatio::Portrait2x3, + Self::Landscape3x2 => ImageAspectRatio::Landscape3x2, + Self::Portrait9x16 => ImageAspectRatio::Portrait9x16, + Self::Landscape16x9 => ImageAspectRatio::Landscape16x9, + Self::Landscape5x4 => ImageAspectRatio::Landscape5x4, + Self::Portrait4x5 => ImageAspectRatio::Portrait4x5, + Self::Landscape21x9 => ImageAspectRatio::Landscape21x9, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Auto => "auto", + Self::Square1x1 => "1:1", + Self::Portrait3x4 => "3:4", + Self::Landscape4x3 => "4:3", + Self::Portrait2x3 => "2:3", + Self::Landscape3x2 => "3:2", + Self::Portrait9x16 => "9:16", + Self::Landscape16x9 => "16:9", + Self::Landscape5x4 => "5:4", + Self::Portrait4x5 => "4:5", + Self::Landscape21x9 => "21:9", + } + } +} + +impl Serialize for NanoBananaAspectRatio { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_the_web_app_menu() { + let wire: Vec<&str> = NanoBananaAspectRatio::all().iter().map(|a| a.as_str()).collect(); + assert_eq!(wire, ["auto", "1:1", "3:4", "4:3", "2:3", "3:2", "9:16", "16:9", "5:4", "4:5", "21:9"]); + for ratio in NanoBananaAspectRatio::all() { + assert_eq!(ratio.to_image_aspect_ratio().as_str(), ratio.as_str()); + } + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/presigned_media_upload.rs b/crates/api_clients/higgsfield_client/src/types/presigned_media_upload.rs new file mode 100644 index 00000000..eae17e9b --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/presigned_media_upload.rs @@ -0,0 +1,78 @@ +//! What the presign endpoints hand back: where to PUT the bytes and where +//! they'll be served from afterwards. + +use crate::types::ids::MediaId; +use crate::types::media_input::MediaInput; +use crate::types::media_mime_type::MediaMimeType; +use serde::Deserialize; + +/// One presigned upload slot. Returned singly by `/fnf/reference-media` +/// and as a list by `/fnf/media/batch`. +#[derive(Clone, Debug, PartialEq, Eq, Deserialize)] +pub struct PresignedMediaUpload { + pub id: MediaId, + + /// The public CDN URL the file will have once uploaded. This is what + /// generation requests reference. + pub url: String, + + /// A presigned storage URL (S3); `PUT` the raw bytes here with + /// `Content-Type: `. Short-lived and secret-bearing — don't + /// log it. + pub upload_url: String, + + /// As the server will store it; can differ from what was asked for (a + /// `wav` audio presign comes back as `audio/x-wav`). Use this as the + /// `Content-Type` of the `PUT`. + pub content_type: MediaMimeType, + + /// Video presigns come with the poster frame the server will extract. + #[serde(default)] + pub thumbnail_url: Option, +} + +impl PresignedMediaUpload { + /// The descriptor to put in a generation request once the bytes are + /// uploaded and confirmed. The descriptor's `type` follows the file + /// family (`media_input` / `video_input` / `audio_input`). + pub fn to_media_input(&self) -> MediaInput { + if self.content_type.is_video() { + MediaInput::uploaded_video(self.id.clone(), self.url.clone()) + } else if self.content_type.is_audio() { + MediaInput::uploaded_audio(self.id.clone(), self.url.clone()) + } else { + MediaInput::uploaded(self.id.clone(), self.url.clone()) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::types::media_input::MediaInputKind; + + #[test] + fn parses_and_converts() { + let json = r#"{"id":"00000000-0000-4000-8000-000000000001","url":"https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000001.png","upload_url":"https://bucket.s3.amazonaws.com/user_x/00000000-0000-4000-8000-000000000001.png?X-Amz-Signature=abc","content_type":"image/png"}"#; + let slot: PresignedMediaUpload = serde_json::from_str(json).unwrap(); + assert_eq!(slot.content_type, MediaMimeType::ImagePng); + assert!(slot.upload_url.contains("X-Amz-Signature")); + let input = slot.to_media_input(); + assert_eq!(input.id.as_str(), "00000000-0000-4000-8000-000000000001"); + assert_eq!(input.url, slot.url); + assert_eq!(input.kind, MediaInputKind::MediaInput); + assert!(slot.thumbnail_url.is_none()); + } + + #[test] + fn video_and_audio_slots_parse_and_convert() { + // Live 2026-08-31 (ids / signatures scrubbed). + let video: PresignedMediaUpload = serde_json::from_str(r#"{"content_type":"video/mp4","id":"00000000-0000-4000-8000-000000000002","thumbnail_url":"https://cdn.example.com/00000000-0000-4000-8000-000000000002_thumb.webp","upload_url":"https://bucket.s3.amazonaws.com/user_x/00000000-0000-4000-8000-000000000002.mp4?X-Amz-Signature=abc","url":"https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000002.mp4"}"#).unwrap(); + assert_eq!(video.to_media_input().kind, MediaInputKind::VideoInput); + assert!(video.thumbnail_url.as_deref().unwrap().ends_with("_thumb.webp")); + + let audio: PresignedMediaUpload = serde_json::from_str(r#"{"content_type":"audio/x-wav","id":"00000000-0000-4000-8000-000000000003","upload_url":"https://bucket.s3.amazonaws.com/user_x/00000000-0000-4000-8000-000000000003.wav?X-Amz-Signature=abc","url":"https://cdn.example.com/user_x/00000000-0000-4000-8000-000000000003.wav"}"#).unwrap(); + assert_eq!(audio.content_type, MediaMimeType::AudioXWav); + assert_eq!(audio.to_media_input().kind, MediaInputKind::AudioInput); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/seedream_aspect_ratio.rs b/crates/api_clients/higgsfield_client/src/types/seedream_aspect_ratio.rs new file mode 100644 index 00000000..48ddf44d --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/seedream_aspect_ratio.rs @@ -0,0 +1,72 @@ +use crate::types::image_aspect_ratio::ImageAspectRatio; +use serde::Serialize; + +/// The aspect ratios the web app offers for every Seedream model +/// (5.0 Pro, 5.0 lite, 4.5), in its menu order. No Auto. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub enum SeedreamAspectRatio { + Square1x1, + Landscape4x3, + Portrait3x4, + Landscape16x9, + Landscape21x9, + Portrait9x16, + Portrait2x3, + Landscape3x2, +} + +impl SeedreamAspectRatio { + pub fn all() -> [Self; 8] { + [ + Self::Square1x1, Self::Landscape4x3, Self::Portrait3x4, Self::Landscape16x9, + Self::Landscape21x9, Self::Portrait9x16, Self::Portrait2x3, Self::Landscape3x2, + ] + } + + /// The wire vocabulary value. + pub fn to_image_aspect_ratio(self) -> ImageAspectRatio { + match self { + Self::Square1x1 => ImageAspectRatio::Square1x1, + Self::Landscape4x3 => ImageAspectRatio::Landscape4x3, + Self::Portrait3x4 => ImageAspectRatio::Portrait3x4, + Self::Landscape16x9 => ImageAspectRatio::Landscape16x9, + Self::Landscape21x9 => ImageAspectRatio::Landscape21x9, + Self::Portrait9x16 => ImageAspectRatio::Portrait9x16, + Self::Portrait2x3 => ImageAspectRatio::Portrait2x3, + Self::Landscape3x2 => ImageAspectRatio::Landscape3x2, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Square1x1 => "1:1", + Self::Landscape4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Landscape16x9 => "16:9", + Self::Landscape21x9 => "21:9", + Self::Portrait9x16 => "9:16", + Self::Portrait2x3 => "2:3", + Self::Landscape3x2 => "3:2", + } + } +} + +impl Serialize for SeedreamAspectRatio { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_the_web_app_menu() { + let wire: Vec<&str> = SeedreamAspectRatio::all().iter().map(|a| a.as_str()).collect(); + assert_eq!(wire, ["1:1", "4:3", "3:4", "16:9", "21:9", "9:16", "2:3", "3:2"]); + for ratio in SeedreamAspectRatio::all() { + assert_eq!(ratio.to_image_aspect_ratio().as_str(), ratio.as_str()); + } + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/string_enum.rs b/crates/api_clients/higgsfield_client/src/types/string_enum.rs new file mode 100644 index 00000000..f9cce877 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/string_enum.rs @@ -0,0 +1,73 @@ +/// Define an enum that is a closed set of known string values on the wire, +/// plus an `Other(String)` variant so unknown values coming *back* from the +/// API still parse instead of failing the whole response. +/// +/// Generates `as_str`, `from_str_lossy`, `Display`, and serde impls that use +/// the wire string. +macro_rules! string_enum { + ( + $(#[$meta:meta])* + $name:ident { + $( + $(#[$variant_meta:meta])* + $variant:ident => $wire:literal + ),+ $(,)? + } + ) => { + $(#[$meta])* + #[derive(Clone, Debug, PartialEq, Eq, Hash)] + pub enum $name { + $( + $(#[$variant_meta])* + $variant, + )+ + /// A value this client doesn't know about yet (only produced when + /// parsing responses; carries the raw wire string). + Other(String), + } + + impl $name { + /// The exact string sent to / received from the API. + pub fn as_str(&self) -> &str { + match self { + $( Self::$variant => $wire, )+ + Self::Other(raw) => raw.as_str(), + } + } + + /// Parse a wire string; unknown values become [`Self::Other`]. + pub fn from_str_lossy(raw: &str) -> Self { + match raw { + $( $wire => Self::$variant, )+ + other => Self::Other(other.to_string()), + } + } + + /// Every known (non-`Other`) variant, in declaration order. + pub fn known_variants() -> &'static [Self] { + &[ $( Self::$variant, )+ ] + } + } + + impl std::fmt::Display for $name { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(self.as_str()) + } + } + + impl serde::Serialize for $name { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } + } + + impl<'de> serde::Deserialize<'de> for $name { + fn deserialize>(deserializer: D) -> Result { + let raw = String::deserialize(deserializer)?; + Ok(Self::from_str_lossy(&raw)) + } + } + }; +} + +pub(crate) use string_enum; diff --git a/crates/api_clients/higgsfield_client/src/types/thinking_level.rs b/crates/api_clients/higgsfield_client/src/types/thinking_level.rs new file mode 100644 index 00000000..99097b45 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/thinking_level.rs @@ -0,0 +1,21 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// How much "thinking" a model spends on a prompt (Nano Banana 2 Lite's + /// quality menu: High / Minimal). Upper-case on the wire. + ThinkingLevel { + High => "HIGH", + Minimal => "MINIMAL", + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + assert_eq!(serde_json::to_string(&ThinkingLevel::Minimal).unwrap(), "\"MINIMAL\""); + assert_eq!(ThinkingLevel::from_str_lossy("HIGH"), ThinkingLevel::High); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/video_aspect_ratio.rs b/crates/api_clients/higgsfield_client/src/types/video_aspect_ratio.rs new file mode 100644 index 00000000..e5fa6852 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/video_aspect_ratio.rs @@ -0,0 +1,109 @@ +use crate::types::image_aspect_ratio::ImageAspectRatio; +use serde::Serialize; + +/// The aspect ratios the Seedance video models offer (2.5, 2.0, 2.0 Mini), +/// in menu order. `Auto` is on 2.0 / 2.0 Mini only (see each request type's +/// validation) and, for text-to-video, the web app sends `16:9` for it. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub enum SeedanceVideoAspectRatio { + Auto, + Landscape21x9, + Landscape16x9, + Landscape4x3, + Square1x1, + Portrait3x4, + Portrait9x16, +} + +impl SeedanceVideoAspectRatio { + pub fn all() -> [Self; 7] { + [Self::Auto, Self::Landscape21x9, Self::Landscape16x9, Self::Landscape4x3, Self::Square1x1, Self::Portrait3x4, Self::Portrait9x16] + } + + pub fn to_image_aspect_ratio(self) -> ImageAspectRatio { + match self { + Self::Auto => ImageAspectRatio::Auto, + Self::Landscape21x9 => ImageAspectRatio::Landscape21x9, + Self::Landscape16x9 => ImageAspectRatio::Landscape16x9, + Self::Landscape4x3 => ImageAspectRatio::Landscape4x3, + Self::Square1x1 => ImageAspectRatio::Square1x1, + Self::Portrait3x4 => ImageAspectRatio::Portrait3x4, + Self::Portrait9x16 => ImageAspectRatio::Portrait9x16, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Auto => "auto", + Self::Landscape21x9 => "21:9", + Self::Landscape16x9 => "16:9", + Self::Landscape4x3 => "4:3", + Self::Square1x1 => "1:1", + Self::Portrait3x4 => "3:4", + Self::Portrait9x16 => "9:16", + } + } +} + +impl Serialize for SeedanceVideoAspectRatio { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +/// The aspect ratios Kling 3.0 offers, in menu order. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)] +pub enum KlingAspectRatio { + #[default] + Landscape16x9, + Portrait9x16, + Square1x1, +} + +impl KlingAspectRatio { + pub fn all() -> [Self; 3] { + [Self::Landscape16x9, Self::Portrait9x16, Self::Square1x1] + } + + pub fn to_image_aspect_ratio(self) -> ImageAspectRatio { + match self { + Self::Landscape16x9 => ImageAspectRatio::Landscape16x9, + Self::Portrait9x16 => ImageAspectRatio::Portrait9x16, + Self::Square1x1 => ImageAspectRatio::Square1x1, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::Square1x1 => "1:1", + } + } +} + +impl Serialize for KlingAspectRatio { + fn serialize(&self, serializer: S) -> Result { + serializer.serialize_str(self.as_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn seedance_matches_the_web_app_menu() { + let wire: Vec<&str> = SeedanceVideoAspectRatio::all().iter().map(|a| a.as_str()).collect(); + assert_eq!(wire, ["auto", "21:9", "16:9", "4:3", "1:1", "3:4", "9:16"]); + for ratio in SeedanceVideoAspectRatio::all() { + assert_eq!(ratio.to_image_aspect_ratio().as_str(), ratio.as_str()); + } + } + + #[test] + fn kling_matches_the_web_app_menu() { + let wire: Vec<&str> = KlingAspectRatio::all().iter().map(|a| a.as_str()).collect(); + assert_eq!(wire, ["16:9", "9:16", "1:1"]); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/video_bitrate_mode.rs b/crates/api_clients/higgsfield_client/src/types/video_bitrate_mode.rs new file mode 100644 index 00000000..d289fa28 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/video_bitrate_mode.rs @@ -0,0 +1,31 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// Seedance's output bitrate tier ("High — less compression, larger size" + /// / "Standard — more compression, smaller size"). + /// + /// NB: only `high` has been seen on the wire; `standard` is inferred from + /// the menu label. + VideoBitrateMode { + High => "high", + Standard => "standard", + } +} + +impl Default for VideoBitrateMode { + fn default() -> Self { + Self::High + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + assert_eq!(serde_json::to_string(&VideoBitrateMode::High).unwrap(), "\"high\""); + assert_eq!(VideoBitrateMode::from_str_lossy("standard"), VideoBitrateMode::Standard); + assert_eq!(VideoBitrateMode::default(), VideoBitrateMode::High); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/video_dimensions.rs b/crates/api_clients/higgsfield_client/src/types/video_dimensions.rs new file mode 100644 index 00000000..d29431fb --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/video_dimensions.rs @@ -0,0 +1,64 @@ +use crate::types::image_aspect_ratio::ImageAspectRatio; +use crate::types::video_resolution::VideoResolution; +use serde::{Deserialize, Serialize}; + +/// Pixel dimensions the web app sends alongside a video's aspect ratio and +/// resolution. The server treats them as advisory. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct VideoDimensions { + pub width: u32, + pub height: u32, +} + +impl VideoDimensions { + pub fn new(width: u32, height: u32) -> Self { + Self { width, height } + } + + /// What the web app sends: the resolution tier fixes the short side and + /// the long side follows the aspect ratio, rounded to an even number. + /// `Auto` (text-to-video, no reference frame) is sent as 16:9. + /// + /// Observed: 16:9 @ 480p → 854×480, 16:9 @ 720p → 1280×720, + /// auto @ 2K → 2560×1440. + pub fn for_aspect_ratio(aspect_ratio: &ImageAspectRatio, resolution: &VideoResolution) -> Option { + let short_side = resolution.short_side_px()?; + let ratio = match aspect_ratio { + ImageAspectRatio::Auto => 16.0 / 9.0, + other => other.ratio()?, + }; + let round_even = |value: f64| -> u32 { + let rounded = value.round() as u32; + if rounded % 2 == 0 { rounded } else { rounded + 1 } + }; + if ratio >= 1.0 { + Some(Self::new(round_even(short_side as f64 * ratio), short_side)) + } else { + Some(Self::new(short_side, round_even(short_side as f64 / ratio))) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_captured_requests() { + assert_eq!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Landscape16x9, &VideoResolution::P480), Some(VideoDimensions::new(854, 480))); + assert_eq!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Landscape16x9, &VideoResolution::P720), Some(VideoDimensions::new(1280, 720))); + assert_eq!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Auto, &VideoResolution::TwoK), Some(VideoDimensions::new(2560, 1440))); + } + + #[test] + fn portrait_and_square() { + assert_eq!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Portrait9x16, &VideoResolution::P480), Some(VideoDimensions::new(480, 854))); + assert_eq!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Square1x1, &VideoResolution::P1080), Some(VideoDimensions::new(1080, 1080))); + } + + #[test] + fn unknown_inputs_are_none() { + assert!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Other("x".into()), &VideoResolution::P480).is_none()); + assert!(VideoDimensions::for_aspect_ratio(&ImageAspectRatio::Square1x1, &VideoResolution::Other("8k".into())).is_none()); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/video_duration.rs b/crates/api_clients/higgsfield_client/src/types/video_duration.rs new file mode 100644 index 00000000..9095e423 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/video_duration.rs @@ -0,0 +1,79 @@ +use crate::error::higgsfield_client_error::HiggsfieldClientError; +use serde::{Deserialize, Serialize}; +use std::fmt::{Display, Formatter}; + +/// A clip length in whole seconds. Every video model exposes duration as a +/// one-second-step slider; each model's request type validates against its +/// own [`VideoDurationRange`]. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(transparent)] +pub struct VideoDurationSeconds(u32); + +impl VideoDurationSeconds { + pub const fn new(seconds: u32) -> Self { + Self(seconds) + } + + pub fn seconds(self) -> u32 { + self.0 + } +} + +impl Display for VideoDurationSeconds { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "{}s", self.0) + } +} + +/// The inclusive slider range a model offers. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct VideoDurationRange { + pub min_seconds: u32, + pub max_seconds: u32, +} + +impl VideoDurationRange { + pub const fn new(min_seconds: u32, max_seconds: u32) -> Self { + Self { min_seconds, max_seconds } + } + + /// The cheapest clip the model offers. + pub fn shortest(&self) -> VideoDurationSeconds { + VideoDurationSeconds(self.min_seconds) + } + + pub fn contains(&self, duration: VideoDurationSeconds) -> bool { + (self.min_seconds..=self.max_seconds).contains(&duration.0) + } + + pub fn validate(&self, duration: VideoDurationSeconds) -> Result<(), HiggsfieldClientError> { + if self.contains(duration) { + Ok(()) + } else { + Err(HiggsfieldClientError::InvalidRequest(format!( + "duration must be between {}s and {}s, got {}", self.min_seconds, self.max_seconds, duration, + ))) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn range_validation() { + let range = VideoDurationRange::new(4, 15); + assert_eq!(range.shortest(), VideoDurationSeconds::new(4)); + assert!(range.validate(VideoDurationSeconds::new(4)).is_ok()); + assert!(range.validate(VideoDurationSeconds::new(15)).is_ok()); + assert!(matches!(range.validate(VideoDurationSeconds::new(3)), Err(HiggsfieldClientError::InvalidRequest(_)))); + assert!(matches!(range.validate(VideoDurationSeconds::new(16)), Err(HiggsfieldClientError::InvalidRequest(_)))); + } + + #[test] + fn serializes_as_number() { + assert_eq!(serde_json::to_string(&VideoDurationSeconds::new(4)).unwrap(), "4"); + assert_eq!(VideoDurationSeconds::new(5).to_string(), "5s"); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/video_mode.rs b/crates/api_clients/higgsfield_client/src/types/video_mode.rs new file mode 100644 index 00000000..d8a12a17 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/video_mode.rs @@ -0,0 +1,24 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// The `mode` quality tier some video pipelines take. Kling 3.0 maps its + /// resolution menu onto it (720p → `std`, 1080p → `pro`, 4K → `4k`); + /// Seedance 2.0 sends `std`. + VideoMode { + Std => "std", + Pro => "pro", + FourK => "4k", + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in VideoMode::known_variants() { + assert_eq!(&VideoMode::from_str_lossy(variant.as_str()), variant); + } + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/video_resolution.rs b/crates/api_clients/higgsfield_client/src/types/video_resolution.rs new file mode 100644 index 00000000..32d49ef3 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/video_resolution.rs @@ -0,0 +1,43 @@ +use crate::types::string_enum::string_enum; + +string_enum! { + /// The `resolution` vocabulary across video models. Note the casing is + /// the API's: `4k` lower-case (Seedance 2.0) but `2K` upper-case + /// (MiniMax). Each model's request type narrows this to its own list. + VideoResolution { + P480 => "480p", + P720 => "720p", + P1080 => "1080p", + TwoK => "2K", + FourK => "4k", + } +} + +impl VideoResolution { + /// The short side in pixels for a 16:9 frame at this tier (what the web + /// app derives `width`/`height` from). + pub fn short_side_px(&self) -> Option { + match self { + Self::P480 => Some(480), + Self::P720 => Some(720), + Self::P1080 => Some(1080), + Self::TwoK => Some(1440), + Self::FourK => Some(2160), + Self::Other(_) => None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_round_trip() { + for variant in VideoResolution::known_variants() { + assert_eq!(&VideoResolution::from_str_lossy(variant.as_str()), variant); + } + assert_eq!(serde_json::to_string(&VideoResolution::FourK).unwrap(), "\"4k\""); + assert_eq!(serde_json::to_string(&VideoResolution::TwoK).unwrap(), "\"2K\""); + } +} diff --git a/crates/api_clients/higgsfield_client/src/types/wallet.rs b/crates/api_clients/higgsfield_client/src/types/wallet.rs new file mode 100644 index 00000000..d63fd5c4 --- /dev/null +++ b/crates/api_clients/higgsfield_client/src/types/wallet.rs @@ -0,0 +1,46 @@ +use crate::types::ids::WorkspaceId; +use serde::Deserialize; + +/// The workspace's credit balances, returned with every enqueue. +#[derive(Clone, Debug, Deserialize)] +pub struct Wallet { + pub workspace_id: WorkspaceId, + + /// Credits available right now (the enqueue's cost has been deducted). + pub credits_balance: f64, + + #[serde(default)] + pub subscription_balance: Option, + + #[serde(default)] + pub total_credits: Option, + + #[serde(default)] + pub on_demand_credits: Option, + + #[serde(default)] + pub expire_days: Option, + + /// RFC 3339 timestamp. + #[serde(default)] + pub wallet_created_at: Option, + + /// RFC 3339 timestamp. + #[serde(default)] + pub next_credit_allocation_date: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wallet_parses() { + let json = r#"{"workspace_id":"00000000-0000-0000-0000-000000000001","credits_balance":600,"subscription_balance":120000,"wallet_created_at":"2026-01-01T00:00:00.000000Z","next_credit_allocation_date":null,"total_credits":120000,"on_demand_credits":0,"expire_days":90}"#; + let wallet: Wallet = serde_json::from_str(json).unwrap(); + assert_eq!(wallet.workspace_id.as_str(), "00000000-0000-0000-0000-000000000001"); + assert_eq!(wallet.credits_balance, 600.0); + assert_eq!(wallet.expire_days, Some(90)); + assert!(wallet.next_credit_allocation_date.is_none()); + } +} diff --git a/crates/api_clients/higgsfield_client/test_assets/clip_4s.mp4 b/crates/api_clients/higgsfield_client/test_assets/clip_4s.mp4 new file mode 100644 index 00000000..29297d6a Binary files /dev/null and b/crates/api_clients/higgsfield_client/test_assets/clip_4s.mp4 differ diff --git a/crates/api_clients/higgsfield_client/test_assets/reference_640.png b/crates/api_clients/higgsfield_client/test_assets/reference_640.png new file mode 100644 index 00000000..dc90f51f Binary files /dev/null and b/crates/api_clients/higgsfield_client/test_assets/reference_640.png differ diff --git a/crates/api_clients/higgsfield_client/test_assets/tone_4s.wav b/crates/api_clients/higgsfield_client/test_assets/tone_4s.wav new file mode 100644 index 00000000..f3150d74 Binary files /dev/null and b/crates/api_clients/higgsfield_client/test_assets/tone_4s.wav differ diff --git a/crates/api_clients/midjourney_client/Cargo.toml b/crates/api_clients/midjourney_client/Cargo.toml new file mode 100644 index 00000000..dd20a8b8 --- /dev/null +++ b/crates/api_clients/midjourney_client/Cargo.toml @@ -0,0 +1,44 @@ +[package] +name = "midjourney_client" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "midjourney_client" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +browser_emulation.workspace = true +cloudflare_errors.workspace = true +cookie_store_wrapper = { workspace = true, features = ["wreq"] } +errors.workspace = true + +# External +anyhow.workspace = true +futures.workspace = true +log.workspace = true +serde.workspace = true +serde_json.workspace = true +tokio = { version = "1", features = ["full"] } +url.workspace = true +wreq-util.workspace = true +wreq.workspace = true + +# NB: We need to parse HTML to get out the websocket token +dom_query = "0.20.2" + +# NB: Midjourney's websocket sends server->client frames as CBOR. +ciborium = "0.2" + +[dev-dependencies] +filesys.workspace = true +test_data.workspace = true +test_utils.workspace = true diff --git a/crates/api_clients/midjourney_client/src/client/midjourney_hostname.rs b/crates/api_clients/midjourney_client/src/client/midjourney_hostname.rs new file mode 100644 index 00000000..3110ff0c --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/midjourney_hostname.rs @@ -0,0 +1,17 @@ + +/// Multiple third party Midjourney clients make this configurable. +/// Not sure why, I'm just cargo culting it. +#[derive(Clone)] +pub enum MidjourneyHostname { + Standard, + Custom(String), +} + +impl MidjourneyHostname { + pub fn as_str(&self) -> &str { + match self { + Self::Standard => "www.midjourney.com", + Self::Custom(domain) => domain, + } + } +} diff --git a/crates/api_clients/midjourney_client/src/client/mod.rs b/crates/api_clients/midjourney_client/src/client/mod.rs new file mode 100644 index 00000000..5faec3d6 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/mod.rs @@ -0,0 +1,2 @@ +pub mod midjourney_hostname; +pub mod websocket; diff --git a/crates/api_clients/midjourney_client/src/client/websocket/job_progress.rs b/crates/api_clients/midjourney_client/src/client/websocket/job_progress.rs new file mode 100644 index 00000000..c875b954 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/websocket/job_progress.rs @@ -0,0 +1,127 @@ +/// A single in-progress preview image carried on the websocket during a job. +/// +/// Midjourney streams four images (indices 0-3) that refine over successive +/// diffusion steps. Each websocket progress frame may carry one preview per +/// image for the current step; the previews grow sharper as the step count +/// climbs. The final, full-resolution image is NOT delivered here — it is +/// fetched over HTTP once the job reaches `completed` (see the `imagine` +/// endpoint). +#[derive(Clone)] +pub struct JobStepImage { + /// Which of the four grid images this is, in `[0, 4)`. + pub image_index: u8, + + /// The diffusion step this preview was rendered at (larger = more refined). + pub step: u32, + + /// The image encoding. Observed to be JPEG in practice. + pub format: MidjourneyImageFormat, + + /// The raw encoded image bytes. + pub bytes: Vec, +} + +/// The encoding of a websocket preview image, taken from the file extension in +/// the frame and cross-checked against the leading magic bytes. +#[derive(Clone, Debug, Eq, PartialEq)] +pub enum MidjourneyImageFormat { + Jpeg, + Webp, + Png, + Other(String), +} + +impl JobStepImage { + /// Parse one `files` entry, whose key looks like `"0_step_5.jpeg"`. + /// Returns `None` if the key does not match the expected shape. + pub fn from_file_entry(key: &str, bytes: Vec) -> Option { + // "0_step_5.jpeg" -> index "0", rest "step_5.jpeg" + let (index_str, rest) = key.split_once('_')?; + let image_index = index_str.parse::().ok()?; + + // "step_5.jpeg" -> "5.jpeg" + let rest = rest.strip_prefix("step_")?; + + // "5.jpeg" -> step "5", extension "jpeg" + let (step_str, extension) = rest.split_once('.')?; + let step = step_str.parse::().ok()?; + + let format = MidjourneyImageFormat::infer(extension, &bytes); + + Some(Self { + image_index, + step, + format, + bytes, + }) + } +} + +impl MidjourneyImageFormat { + /// Prefer the magic bytes (authoritative), falling back to the extension. + fn infer(extension: &str, bytes: &[u8]) -> Self { + if bytes.len() >= 4 && bytes[0..3] == [0xFF, 0xD8, 0xFF] { + return Self::Jpeg; + } + if bytes.len() >= 12 && &bytes[0..4] == b"RIFF" && &bytes[8..12] == b"WEBP" { + return Self::Webp; + } + if bytes.len() >= 8 && bytes[0..8] == [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A] { + return Self::Png; + } + match extension.to_ascii_lowercase().as_str() { + "jpeg" | "jpg" => Self::Jpeg, + "webp" => Self::Webp, + "png" => Self::Png, + other => Self::Other(other.to_string()), + } + } + + pub fn extension(&self) -> &str { + match self { + Self::Jpeg => "jpeg", + Self::Webp => "webp", + Self::Png => "png", + Self::Other(ext) => ext, + } + } +} + +impl std::fmt::Debug for JobStepImage { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("JobStepImage") + .field("image_index", &self.image_index) + .field("step", &self.step) + .field("format", &self.format) + .field("bytes", &format!("<{} bytes>", self.bytes.len())) + .finish() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const JPEG_MAGIC: &[u8] = &[0xFF, 0xD8, 0xFF, 0xE0, 0x00, 0x10]; + + #[test] + fn parses_step_file_key() { + let image = JobStepImage::from_file_entry("2_step_14.jpeg", JPEG_MAGIC.to_vec()).unwrap(); + assert_eq!(image.image_index, 2); + assert_eq!(image.step, 14); + assert_eq!(image.format, MidjourneyImageFormat::Jpeg); + } + + #[test] + fn magic_bytes_override_extension() { + let image = JobStepImage::from_file_entry("0_step_0.png", JPEG_MAGIC.to_vec()).unwrap(); + assert_eq!(image.format, MidjourneyImageFormat::Jpeg); + } + + #[test] + fn rejects_malformed_keys() { + assert!(JobStepImage::from_file_entry("garbage", vec![]).is_none()); + assert!(JobStepImage::from_file_entry("x_step_1.jpeg", vec![]).is_none()); + assert!(JobStepImage::from_file_entry("0_notstep_1.jpeg", vec![]).is_none()); + } +} diff --git a/crates/api_clients/midjourney_client/src/client/websocket/midjourney_websocket.rs b/crates/api_clients/midjourney_client/src/client/websocket/midjourney_websocket.rs new file mode 100644 index 00000000..ee1c8008 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/websocket/midjourney_websocket.rs @@ -0,0 +1,214 @@ +use crate::client::websocket::midjourney_ws_event::MidjourneyWsEvent; +use crate::credentials::midjourney_user_id::MidjourneyUserId; +use crate::error::midjourney_client_error::MidjourneyClientError; +use log::{debug, warn}; +use std::sync::Arc; +use std::sync::atomic::{AtomicBool, Ordering}; +use tokio::sync::{broadcast, mpsc}; +use wreq::ws::WebSocket; +use wreq::ws::message::Message; + +/// How many events the broadcast channel buffers. A single job emits ~30 +/// frames; this holds many concurrent jobs before a slow consumer lags. +const EVENT_CHANNEL_CAPACITY: usize = 2048; + +/// A live, thread-safe handle to an open Midjourney websocket. +/// +/// The connection is driven by a background task that owns the raw socket; +/// this handle only talks to it over channels, so it is cheap to `clone` and +/// share across threads. Cloned handles observe the same connection. +/// +/// Reading images: +/// +/// ```ignore +/// let ws = open_midjourney_websocket(/* ... */).await?; +/// // Submit the job over HTTP, then stream its previews: +/// ws.stream_job(&job_id, |event| { +/// if let MidjourneyWsEvent::Progress(progress) = event { +/// for image in &progress.images { +/// // image.bytes is a JPEG preview for image.image_index at image.step +/// } +/// } +/// }).await?; +/// ``` +/// +/// For finer control, call [`Self::events`] to get a raw receiver and +/// [`Self::subscribe_to_job`] / [`Self::send_json`] to drive the protocol +/// yourself. +/// +/// Dropping the last handle ends the background task and closes the socket. +#[derive(Clone)] +pub struct MidjourneyWebSocket { + inner: Arc, +} + +struct WebSocketInner { + user_id: MidjourneyUserId, + outbound: mpsc::UnboundedSender, + events: broadcast::Sender>, + connected: Arc, +} + +impl MidjourneyWebSocket { + /// Take ownership of a freshly upgraded socket, spawn its driver task, and + /// return a handle. The caller is responsible for the `subscribe_to_user` + /// handshake (see `open_midjourney_websocket`). + pub (crate) fn spawn(user_id: MidjourneyUserId, websocket: WebSocket) -> Self { + let (outbound_tx, outbound_rx) = mpsc::unbounded_channel::(); + let (events_tx, _events_rx) = broadcast::channel::>(EVENT_CHANNEL_CAPACITY); + let connected = Arc::new(AtomicBool::new(true)); + + tokio::spawn(run_websocket_loop( + websocket, + outbound_rx, + events_tx.clone(), + connected.clone(), + )); + + Self { + inner: Arc::new(WebSocketInner { + user_id, + outbound: outbound_tx, + events: events_tx, + connected, + }), + } + } + + /// The user this connection is bound to. + pub fn user_id(&self) -> &MidjourneyUserId { + &self.inner.user_id + } + + /// Whether the background task is still running. + pub fn is_connected(&self) -> bool { + self.inner.connected.load(Ordering::SeqCst) + } + + /// A new receiver over the decoded event stream. Each call yields an + /// independent receiver that sees events sent *after* it was created, so + /// subscribe before sending the request whose events you want. + pub fn events(&self) -> broadcast::Receiver> { + self.inner.events.subscribe() + } + + /// Bind this connection to the user (the opening handshake). Normally done + /// for you by `open_midjourney_websocket`. + pub fn subscribe_to_user(&self) -> Result<(), MidjourneyClientError> { + self.send_json(&serde_json::json!({ "type": "subscribe_to_user" })) + } + + /// Ask the server to stream progress for a job (after it was submitted over + /// HTTP). Progress frames, including preview images, follow. + pub fn subscribe_to_job(&self, job_id: &str) -> Result<(), MidjourneyClientError> { + self.send_json(&serde_json::json!({ "type": "subscribe_to_job", "job_id": job_id })) + } + + /// Send an arbitrary JSON command frame. The escape hatch for protocol + /// messages this handle does not model directly (e.g. `room_new_job`). + pub fn send_json(&self, value: &serde_json::Value) -> Result<(), MidjourneyClientError> { + let text = serde_json::to_string(value)?; + self.send_message(Message::text(text)) + } + + /// Subscribe to a job and invoke `on_event` for every event belonging to it, + /// returning once the job completes (or erroring if the socket closes first). + /// + /// This is the ergonomic path for reading images: each `Progress` event + /// carries the preview `images` for the current step, and the call returns + /// when the `Completed` event arrives. + pub async fn stream_job( + &self, + job_id: &str, + mut on_event: F, + ) -> Result<(), MidjourneyClientError> + where + F: FnMut(&MidjourneyWsEvent), + { + let mut receiver = self.events(); + self.subscribe_to_job(job_id)?; + + loop { + match receiver.recv().await { + Ok(event) => { + if event.job_id() != Some(job_id) { + continue; + } + on_event(&event); + if event.is_terminal() { + return Ok(()); + } + } + Err(broadcast::error::RecvError::Lagged(skipped)) => { + warn!("Midjourney websocket consumer lagged, skipped {} events", skipped); + } + Err(broadcast::error::RecvError::Closed) => { + return Err(MidjourneyClientError::WebSocketClosed); + } + } + } + } + + /// Politely close the connection. The background task forwards the close + /// frame and then stops. Dropping the last handle does the same implicitly. + pub fn close(&self) { + let _ = self.send_message(Message::Close(None)); + } + + fn send_message(&self, message: Message) -> Result<(), MidjourneyClientError> { + self.inner + .outbound + .send(message) + .map_err(|_| MidjourneyClientError::WebSocketClosed) + } +} + +/// Owns the raw socket: forwards outbound command frames and decodes inbound +/// CBOR frames into events. Ends when the socket closes or all handles drop. +async fn run_websocket_loop( + mut websocket: WebSocket, + mut outbound_rx: mpsc::UnboundedReceiver, + events_tx: broadcast::Sender>, + connected: Arc, +) { + loop { + tokio::select! { + maybe_outbound = outbound_rx.recv() => { + match maybe_outbound { + Some(message) => { + if let Err(err) = websocket.send(message).await { + warn!("Midjourney websocket send failed: {}", err); + break; + } + } + // All handles dropped; nothing more will be sent. + None => break, + } + } + maybe_incoming = websocket.recv() => { + match maybe_incoming { + Some(Ok(Message::Binary(bytes))) => { + match MidjourneyWsEvent::from_cbor_frame(&bytes) { + // A send error just means there are no live receivers; that's fine. + Ok(event) => { let _ = events_tx.send(Arc::new(event)); } + Err(err) => warn!("Midjourney websocket frame decode failed: {}", err), + } + } + Some(Ok(Message::Text(text))) => { + debug!("Unexpected text frame from Midjourney websocket: {}", text.as_str()); + } + // Ping/Pong are handled by wreq; ignore anything else non-terminal. + Some(Ok(Message::Close(_))) | None => break, + Some(Ok(_)) => {} + Some(Err(err)) => { + warn!("Midjourney websocket receive error: {}", err); + break; + } + } + } + } + } + + connected.store(false, Ordering::SeqCst); + debug!("Midjourney websocket loop ended."); +} diff --git a/crates/api_clients/midjourney_client/src/client/websocket/midjourney_ws_event.rs b/crates/api_clients/midjourney_client/src/client/websocket/midjourney_ws_event.rs new file mode 100644 index 00000000..c97966e9 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/websocket/midjourney_ws_event.rs @@ -0,0 +1,284 @@ +use crate::client::websocket::job_progress::JobStepImage; +use ciborium::value::Value as CborValue; + +/// A decoded server-to-client websocket event. +/// +/// Midjourney sends these as CBOR binary frames. The variants cover the +/// handshake reply, job lifecycle notifications, and the streaming progress +/// frames that carry preview images. +#[derive(Clone, Debug)] +pub enum MidjourneyWsEvent { + /// Reply to `subscribe_to_user`; the connection is now bound to this user. + UserSuccess { + user_id: String, + }, + + /// A job was announced in the user's room (echo of `room_new_job`). + RoomNewJob { + job_id: Option, + }, + + /// Reply to `subscribe_to_job`; progress frames for it will now arrive. + JobSuccess { + job_id: String, + }, + + /// A progress update. Carries preview images when the frame includes them. + Progress(JobProgress), + + /// The job finished. The full-resolution result is fetched over HTTP. + Completed { + job_id: String, + percentage_complete: f64, + }, + + /// A frame we recognized as CBOR but do not model. `maybe_kind` is its + /// `type` field when present. + Unknown { + maybe_kind: Option, + }, +} + +/// A single progress frame for a running job. +#[derive(Clone, Debug)] +pub struct JobProgress { + pub job_id: String, + pub maybe_user_id: Option, + + /// e.g. `unqueue`, `start_stage`, `running`. + pub current_status: String, + + pub percentage_complete: f64, + + /// Preview images included in this frame (may be empty). + pub images: Vec, +} + +impl MidjourneyWsEvent { + /// The job this event concerns, if any. `UserSuccess` and unmodeled frames + /// return `None`. + pub fn job_id(&self) -> Option<&str> { + match self { + Self::UserSuccess { .. } | Self::Unknown { .. } => None, + Self::RoomNewJob { job_id } => job_id.as_deref(), + Self::JobSuccess { job_id } => Some(job_id), + Self::Progress(progress) => Some(&progress.job_id), + Self::Completed { job_id, .. } => Some(job_id), + } + } + + /// Whether this event marks the end of a job's progress stream. + pub fn is_terminal(&self) -> bool { + matches!(self, Self::Completed { .. }) + } + + /// Decode one binary websocket frame (CBOR) into an event. + pub fn from_cbor_frame(bytes: &[u8]) -> Result { + let value: CborValue = ciborium::from_reader(bytes) + .map_err(|err| MidjourneyWsDecodeError(err.to_string()))?; + + let entries = match &value { + CborValue::Map(entries) => entries, + _ => return Err(MidjourneyWsDecodeError("frame was not a CBOR map".to_string())), + }; + + let maybe_kind = get_str(entries, "type"); + + if let Some(kind) = maybe_kind.as_deref() { + match kind { + "user_success" => { + return Ok(Self::UserSuccess { + user_id: get_str(entries, "user_id").unwrap_or_default(), + }); + } + "room_new_job" => { + return Ok(Self::RoomNewJob { + job_id: get_str(entries, "job_id"), + }); + } + "job_success" => { + return Ok(Self::JobSuccess { + job_id: get_str(entries, "job_id").unwrap_or_default(), + }); + } + _ => {} + } + } + + // Progress frames have no `type`, but do carry `current_status`. + if let Some(current_status) = get_str(entries, "current_status") { + let job_id = get_str(entries, "job_id").unwrap_or_default(); + let percentage_complete = get_f64(entries, "percentage_complete").unwrap_or(0.0); + + if current_status == "completed" { + return Ok(Self::Completed { job_id, percentage_complete }); + } + + return Ok(Self::Progress(JobProgress { + job_id, + maybe_user_id: get_str(entries, "user_id"), + current_status, + percentage_complete, + images: extract_images(entries), + })); + } + + Ok(Self::Unknown { maybe_kind }) + } +} + +/// The error returned when a websocket frame cannot be decoded as CBOR. +#[derive(Debug)] +pub struct MidjourneyWsDecodeError(pub String); + +impl std::fmt::Display for MidjourneyWsDecodeError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "Failed to decode Midjourney websocket frame: {}", self.0) + } +} + +impl std::error::Error for MidjourneyWsDecodeError {} + +fn extract_images(entries: &[(CborValue, CborValue)]) -> Vec { + let files = match map_get(entries, "files") { + Some(CborValue::Map(files)) => files, + _ => return Vec::new(), + }; + + let mut images = Vec::new(); + for (key, value) in files { + let (CborValue::Text(name), CborValue::Bytes(bytes)) = (key, value) else { + continue; + }; + if let Some(image) = JobStepImage::from_file_entry(name, bytes.clone()) { + images.push(image); + } + } + images.sort_by_key(|image| (image.step, image.image_index)); + images +} + +fn map_get<'a>(entries: &'a [(CborValue, CborValue)], key: &str) -> Option<&'a CborValue> { + entries + .iter() + .find(|(k, _)| matches!(k, CborValue::Text(text) if text == key)) + .map(|(_, value)| value) +} + +/// Read a string field, accepting both a plain text value and a CBOR +/// tag-37 (RFC 8949 UUID) 16-byte value, which Midjourney uses for some +/// `job_id` / `user_id` fields. +fn get_str(entries: &[(CborValue, CborValue)], key: &str) -> Option { + match map_get(entries, key)? { + CborValue::Text(text) => Some(text.clone()), + CborValue::Tag(37, inner) => match inner.as_ref() { + CborValue::Bytes(bytes) if bytes.len() == 16 => Some(format_uuid(bytes)), + CborValue::Text(text) => Some(text.clone()), + _ => None, + }, + _ => None, + } +} + +fn get_f64(entries: &[(CborValue, CborValue)], key: &str) -> Option { + match map_get(entries, key)? { + CborValue::Float(float) => Some(*float), + CborValue::Integer(integer) => { + let as_i128: i128 = (*integer).into(); + Some(as_i128 as f64) + } + _ => None, + } +} + +fn format_uuid(bytes: &[u8]) -> String { + let hex: String = bytes.iter().map(|byte| format!("{:02x}", byte)).collect(); + format!( + "{}-{}-{}-{}-{}", + &hex[0..8], + &hex[8..12], + &hex[12..16], + &hex[16..20], + &hex[20..32], + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn encode(value: &CborValue) -> Vec { + let mut buffer = Vec::new(); + ciborium::into_writer(value, &mut buffer).unwrap(); + buffer + } + + fn text(value: &str) -> CborValue { + CborValue::Text(value.to_string()) + } + + #[test] + fn decodes_user_success() { + let frame = encode(&CborValue::Map(vec![ + (text("type"), text("user_success")), + (text("user_id"), text("26c9d38d-1f71-49c7-a356-b29dac58b54c")), + ])); + + let event = MidjourneyWsEvent::from_cbor_frame(&frame).unwrap(); + let MidjourneyWsEvent::UserSuccess { user_id } = event else { + panic!("expected UserSuccess, got {event:?}"); + }; + assert_eq!(user_id, "26c9d38d-1f71-49c7-a356-b29dac58b54c"); + } + + #[test] + fn decodes_tag37_uuid_job_id() { + let uuid_bytes = vec![ + 0x7d, 0xa8, 0xda, 0x16, 0x69, 0x64, 0x46, 0x5b, + 0x92, 0x98, 0xa8, 0x45, 0xa7, 0xfe, 0xc1, 0xbb, + ]; + let frame = encode(&CborValue::Map(vec![ + (text("job_id"), CborValue::Tag(37, Box::new(CborValue::Bytes(uuid_bytes)))), + (text("current_status"), text("completed")), + (text("percentage_complete"), CborValue::Integer(100.into())), + ])); + + let event = MidjourneyWsEvent::from_cbor_frame(&frame).unwrap(); + let MidjourneyWsEvent::Completed { job_id, percentage_complete } = event else { + panic!("expected Completed, got {event:?}"); + }; + assert_eq!(job_id, "7da8da16-6964-465b-9298-a845a7fec1bb"); + assert_eq!(percentage_complete, 100.0); + } + + #[test] + fn decodes_progress_with_images() { + let jpeg = vec![0xFF, 0xD8, 0xFF, 0xE0, 0x00, 0x10]; + let frame = encode(&CborValue::Map(vec![ + (text("current_status"), text("running")), + (text("percentage_complete"), CborValue::Float(5.0)), + (text("job_id"), text("job-1")), + (text("user_id"), text("user-1")), + (text("files"), CborValue::Map(vec![ + (text("0_step_1.jpeg"), CborValue::Bytes(jpeg.clone())), + (text("1_step_1.jpeg"), CborValue::Bytes(jpeg.clone())), + ])), + ])); + + let event = MidjourneyWsEvent::from_cbor_frame(&frame).unwrap(); + let MidjourneyWsEvent::Progress(progress) = event else { + panic!("expected Progress, got {event:?}"); + }; + assert_eq!(progress.current_status, "running"); + assert_eq!(progress.percentage_complete, 5.0); + assert_eq!(progress.images.len(), 2); + assert_eq!(progress.images[0].image_index, 0); + assert_eq!(progress.images[1].image_index, 1); + } + + #[test] + fn non_map_frame_errors() { + let frame = encode(&text("nope")); + assert!(MidjourneyWsEvent::from_cbor_frame(&frame).is_err()); + } +} diff --git a/crates/api_clients/midjourney_client/src/client/websocket/mod.rs b/crates/api_clients/midjourney_client/src/client/websocket/mod.rs new file mode 100644 index 00000000..6383f36b --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/websocket/mod.rs @@ -0,0 +1,15 @@ +//! Midjourney websocket client. +//! +//! Midjourney streams job progress (and in-progress preview images) over a +//! websocket at `wss://ws.midjourney.com/ws`. Client-to-server frames are JSON +//! text; server-to-client frames are CBOR binary. +//! +//! Usage: open the socket with [`open_midjourney_websocket`], submit a job over +//! HTTP (see the `submit_job` endpoint), then read previews with +//! [`MidjourneyWebSocket::stream_job`] or the raw [`MidjourneyWebSocket::events`] +//! receiver. + +pub mod job_progress; +pub mod midjourney_websocket; +pub mod midjourney_ws_event; +pub mod open_midjourney_websocket; diff --git a/crates/api_clients/midjourney_client/src/client/websocket/open_midjourney_websocket.rs b/crates/api_clients/midjourney_client/src/client/websocket/open_midjourney_websocket.rs new file mode 100644 index 00000000..2c1c7cf5 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/client/websocket/open_midjourney_websocket.rs @@ -0,0 +1,169 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::client::websocket::midjourney_websocket::MidjourneyWebSocket; +use crate::client::websocket::midjourney_ws_event::MidjourneyWsEvent; +use crate::credentials::midjourney_user_id::MidjourneyUserId; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use std::time::Duration; +use tokio::sync::broadcast; +use tokio::time::timeout; + +/// Midjourney's websocket gateway. The host is fixed regardless of which +/// `www`/custom hostname the HTTP API is reached through. +const WEBSOCKET_URL_BASE: &str = "wss://ws.midjourney.com/ws"; + +/// Protocol version pinned by the web client's `?v=` query parameter. +const WEBSOCKET_PROTOCOL_VERSION: &str = "5"; + +/// How long to wait for the `user_success` reply before giving up. +const HANDSHAKE_TIMEOUT: Duration = Duration::from_secs(15); + +pub struct OpenMidjourneyWebSocketRequest<'a> { + /// The short-lived websocket token from the index page's `initialProps` + /// (see `get_user_info`, which reads `websocketToken`). + pub websocket_token: &'a str, + + /// The Midjourney user id this connection is for. + pub user_id: MidjourneyUserId, + + /// Used only for the `Origin` header; the socket host is always + /// `ws.midjourney.com`. Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + + /// Defaults to [`BrowserProfile::default`] if absent. Should match the + /// browser whose cookies obtained the `websocket_token`. + pub browser: Option, +} + +/// Open a Midjourney websocket, complete the `subscribe_to_user` handshake, +/// and return a live [`MidjourneyWebSocket`] handle. +/// +/// The returned handle is already bound to the user and ready for +/// [`MidjourneyWebSocket::subscribe_to_job`] / [`MidjourneyWebSocket::stream_job`]. +/// No cookies are needed — the websocket authenticates via `websocket_token`. +pub async fn open_midjourney_websocket( + req: OpenMidjourneyWebSocketRequest<'_>, +) -> Result { + let client = req.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let default_hostname = MidjourneyHostname::Standard; + let hostname = req.hostname.unwrap_or(&default_hostname); + let origin = format!("https://{}", hostname.as_str()); + let url = format!( + "{}?token={}&v={}", + WEBSOCKET_URL_BASE, + req.websocket_token, + WEBSOCKET_PROTOCOL_VERSION, + ); + + let response = client + .websocket(url) + .header("Origin", origin) + .send() + .await + .map_err(|err| MidjourneyClientError::WebSocketUpgrade(err.to_string()))?; + + let websocket = response + .into_websocket() + .await + .map_err(|err| MidjourneyClientError::WebSocketUpgrade(err.to_string()))?; + + let handle = MidjourneyWebSocket::spawn(req.user_id, websocket); + + // Subscribe to the event stream BEFORE sending, so we cannot miss the reply. + let mut events = handle.events(); + handle.subscribe_to_user()?; + + match timeout(HANDSHAKE_TIMEOUT, await_user_success(&mut events)).await { + Ok(Ok(())) => Ok(handle), + Ok(Err(err)) => Err(err.into()), + Err(_) => Err(MidjourneyClientError::WebSocketHandshakeTimeout.into()), + } +} + +async fn await_user_success( + events: &mut broadcast::Receiver>, +) -> Result<(), MidjourneyClientError> { + loop { + match events.recv().await { + Ok(event) => { + if matches!(event.as_ref(), MidjourneyWsEvent::UserSuccess { .. }) { + return Ok(()); + } + } + Err(broadcast::error::RecvError::Lagged(_)) => continue, + Err(broadcast::error::RecvError::Closed) => { + return Err(MidjourneyClientError::WebSocketClosed); + } + } + } +} + +#[cfg(test)] +mod tests { + use crate::client::websocket::midjourney_ws_event::MidjourneyWsEvent; + use crate::client::websocket::open_midjourney_websocket::{ + open_midjourney_websocket, OpenMidjourneyWebSocketRequest, + }; + use crate::endpoints::submit_job::{submit_job, SubmitJobArgs, SubmitJobRequest}; + use crate::recipes::channel_id::ChannelId; + use crate::recipes::get_user_info::{get_user_info, GetUserInfoArgs}; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + // Live end-to-end test. Requires a valid cookie header on disk. Run with: + // cargo test -p midjourney_client -- --ignored --exact \ + // client::websocket::open_midjourney_websocket::tests::live_stream_job + #[ignore] + #[tokio::test] + async fn live_stream_job() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + + // 1. Read user id + websocket token from the index page. + let user_info = get_user_info(GetUserInfoArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + let user_id = user_info.user_id.expect("user id"); + let websocket_token = user_info.websocket_token.expect("websocket token"); + + // 2. Open the websocket (does the subscribe_to_user handshake). + let ws = open_midjourney_websocket(OpenMidjourneyWebSocketRequest { + websocket_token: &websocket_token, + user_id: user_id.clone(), + hostname: None, + browser: None, + }).await?; + + // 3. Submit a job over HTTP. + let channel_id = ChannelId::UserId(user_id.clone()).to_string(); + let submit = submit_job(SubmitJobArgs { + request: SubmitJobRequest { + prompt: "pirate ship in the city --v 8.2", + channel_id: &channel_id, + }, + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + let job_id = submit.maybe_job_id.expect("job id"); + + // 4. Stream previews until completion. + let mut preview_frames = 0; + ws.stream_job(&job_id, |event| { + if let MidjourneyWsEvent::Progress(progress) = event { + if !progress.images.is_empty() { + preview_frames += 1; + } + } + }).await?; + + assert!(preview_frames > 0, "expected at least one preview frame"); + Ok(()) + } +} diff --git a/crates/api_clients/midjourney_client/src/credentials/cookie_names.rs b/crates/api_clients/midjourney_client/src/credentials/cookie_names.rs new file mode 100644 index 00000000..6eba239b --- /dev/null +++ b/crates/api_clients/midjourney_client/src/credentials/cookie_names.rs @@ -0,0 +1,6 @@ + +/// One of the apparent authentication cookies used by Midjourney. +pub (crate) const AUTH_COOKIE_NAME_R : &str = "__Host-Midjourney.AuthUserTokenV3_r"; + +/// One of the apparent authentication cookies used by Midjourney. +pub (crate) const AUTH_COOKIE_NAME_I : &str = "__Host-Midjourney.AuthUserTokenV3_i"; diff --git a/crates/api_clients/midjourney_client/src/credentials/cookie_store_has_auth_cookies.rs b/crates/api_clients/midjourney_client/src/credentials/cookie_store_has_auth_cookies.rs new file mode 100644 index 00000000..007cd94a --- /dev/null +++ b/crates/api_clients/midjourney_client/src/credentials/cookie_store_has_auth_cookies.rs @@ -0,0 +1,8 @@ +use crate::credentials::cookie_names::{AUTH_COOKIE_NAME_I, AUTH_COOKIE_NAME_R}; +use cookie_store_wrapper::cookie_store::CookieStore; + +/// Returns true if the given cookie store has the necessary authentication cookies. +pub fn cookie_store_has_auth_cookies(cookie_store: &CookieStore) -> bool { + cookie_store.has_cookie(AUTH_COOKIE_NAME_I) + && cookie_store.has_cookie(AUTH_COOKIE_NAME_R) +} diff --git a/crates/api_clients/midjourney_client/src/credentials/jwt_decode.rs b/crates/api_clients/midjourney_client/src/credentials/jwt_decode.rs new file mode 100644 index 00000000..2efdd4e4 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/credentials/jwt_decode.rs @@ -0,0 +1,31 @@ + +/* +{ + "name": "u3869671173", + "picture": "https://lh3.googleusercontent.com/a/ACg8ocKw0aaXKYSqy-Xkkn69ydIJFGnJA37S13XvjNY4d9xCzUzKUw=s96-c", + "midjourney_id": "f8a57ac3-e416-4dd4-9be8-2c4223691b01", + "iss": "https://securetoken.google.com/authjourney", + "aud": "authjourney", + "auth_time": 1754970849, + "user_id": "bS9idl73DlSbE61KnCyKpDfazCX2", + "sub": "bS9idl73DlSbE61KnCyKpDfazCX2", + "iat": 1754970849, + "exp": 1754974449, + "email": "victorvoice89@gmail.com", + "email_verified": true, + "firebase": { + "identities": { + "google.com": [ + "116459300198619888836" + ], + "email": [ + "victorvoice89@gmail.com" + ] + }, + "sign_in_provider": "google.com" + } +} +*/ + +/* + */ \ No newline at end of file diff --git a/crates/api_clients/midjourney_client/src/credentials/midjourney_user_id.rs b/crates/api_clients/midjourney_client/src/credentials/midjourney_user_id.rs new file mode 100644 index 00000000..1df40c2d --- /dev/null +++ b/crates/api_clients/midjourney_client/src/credentials/midjourney_user_id.rs @@ -0,0 +1,22 @@ + +/// The user ID used for several midjourney requests. +#[derive(Clone, Debug, Eq, PartialEq, Hash)] +pub struct MidjourneyUserId(pub String); + +impl MidjourneyUserId { + pub fn from_str(user_id: &str) -> Self { + Self(user_id.to_string()) + } + + pub fn from_string(user_id: String) -> Self { + Self(user_id) + } + + pub fn as_str(&self) -> &str { + &self.0 + } + + pub fn to_string(&self) -> String { + self.0.to_string() + } +} diff --git a/crates/api_clients/midjourney_client/src/credentials/mod.rs b/crates/api_clients/midjourney_client/src/credentials/mod.rs new file mode 100644 index 00000000..3f9cb6ef --- /dev/null +++ b/crates/api_clients/midjourney_client/src/credentials/mod.rs @@ -0,0 +1,4 @@ +pub mod cookie_names; +pub mod cookie_store_has_auth_cookies; +pub mod jwt_decode; +pub mod midjourney_user_id; diff --git a/crates/api_clients/midjourney_client/src/endpoints/get_index_page_html.rs b/crates/api_clients/midjourney_client/src/endpoints/get_index_page_html.rs new file mode 100644 index 00000000..af8b78c0 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/get_index_page_html.rs @@ -0,0 +1,95 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use log::error; + +/// Fetches the pre-rendered index HTML (which contains the websocket token and +/// other details). Has no semantic parameters — only transport concerns. +pub struct GetIndexPageArgs<'a> { + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +pub async fn get_index_page_html(args: GetIndexPageArgs<'_>) -> Result { + let default_hostname = MidjourneyHostname::Standard; + let hostname = args.hostname.unwrap_or(&default_hostname); + + let url = format!("https://{}/", hostname.as_str()); + + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let cookie_header = args.cookie_header.trim(); + + if cookie_header.len() < 20 { + error!("Cookie header is too short (len: {}): {}", cookie_header.len(), cookie_header); + return Err(MidjourneyClientError::CookieTooShort.into()); + } + + // NB: Browser-identity headers (user-agent, sec-ch-ua*, accept-encoding) come + // from the emulation on the client; only request-context headers are set here. + let http_request = client.get(url) + .header("cookie", cookie_header) + .header("Referrer-Policy", "origin-when-cross-origin") + .header("accept", "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7") + .header("accept-language", "en-US,en;q=0.8") + .header("priority", "u=0, i") + .header("sec-fetch-dest", "document") + .header("sec-fetch-mode", "navigate") + .header("sec-fetch-site", "none") + .header("sec-fetch-user", "?1") + .header("upgrade-insecure-requests", "1"); + + let http_request = http_request + .build() + .map_err(MidjourneyClientError::WreqError)?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + + let response_body = response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + } + + Ok(response_body) +} + +#[cfg(test)] +mod tests { + use crate::endpoints::get_index_page_html::{get_index_page_html, GetIndexPageArgs}; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + + let result = get_index_page_html(GetIndexPageArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}\n\n", result); + + assert_eq!(1, 2); + + Ok(()) + } +} diff --git a/crates/api_clients/midjourney_client/src/endpoints/imagine.rs b/crates/api_clients/midjourney_client/src/endpoints/imagine.rs new file mode 100644 index 00000000..0b9fc52f --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/imagine.rs @@ -0,0 +1,258 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::credentials::midjourney_user_id::MidjourneyUserId; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use log::error; +use serde::Deserialize; + +const DEFAULT_PAGE_SIZE : u64 = 1000; + +/// The semantic parameters for listing Midjourney's job/media feed. +pub struct ImagineRequest<'a> { + pub user_id: &'a MidjourneyUserId, + pub page_size: Option, +} + +/// An imagine (job/media list) request plus its transport concerns. +pub struct ImagineArgs<'a> { + pub request: ImagineRequest<'a>, + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug, Clone)] +pub struct ImagineResponse { + pub items: Vec, + pub cursor: Option, +} + +#[derive(Debug, Clone)] +pub struct ImagineItem { + pub id: Option, + + /// This is the prompt, e.g. + /// `cute puppy wearing a polar bear suit --ar 4:3 --raw --v 7.0` + pub full_command: Option, + + pub job_type: Option, +} + +#[derive(Debug, Clone)] +pub enum MidjourneyJobType { + V6Diffusion, + V6p1Diffusion, + V6p1RawDiffusion, + V7Diffusion, + V7DraftDiffusion, + V7DraftRawDiffusion, + V7RawDiffusion, + Vid11I2vRenderAJointVideo, + Vid11I2vRenderBJointVideo, + Vid11I2vStartEndAVideo, + Vid11I2vStartEndBVideo, + Other(String), +} + +impl MidjourneyJobType { + pub fn from_str(s: &str) -> MidjourneyJobType { + match s { + "v6_diffusion" => MidjourneyJobType::V6Diffusion, + "v6-1_diffusion" => MidjourneyJobType::V6p1Diffusion, + "v6-1_raw_diffusion" => MidjourneyJobType::V6p1RawDiffusion, + "v7_diffusion" => MidjourneyJobType::V7Diffusion, + "v7_draft_diffusion" => MidjourneyJobType::V7DraftDiffusion, + "v7_draft_raw_diffusion" => MidjourneyJobType::V7DraftRawDiffusion, + "v7_raw_diffusion" => MidjourneyJobType::V7RawDiffusion, + "vid_1.1_i2v_render_a_joint_video" => MidjourneyJobType::Vid11I2vRenderAJointVideo, + "vid_1.1_i2v_render_b_joint_video" => MidjourneyJobType::Vid11I2vRenderBJointVideo, + "vid_1.1_i2v_start_end_a_video" => MidjourneyJobType::Vid11I2vStartEndAVideo, + "vid_1.1_i2v_start_end_b_video" => MidjourneyJobType::Vid11I2vStartEndBVideo, + other => MidjourneyJobType::Other(other.to_string()), + } + } +} + +pub async fn imagine(args: ImagineArgs<'_>) -> Result { + let cookie_header = args.cookie_header.trim(); + + if cookie_header.len() < 20 { + error!("Cookie header is too short (len: {}): {}", cookie_header.len(), cookie_header); + return Err(MidjourneyClientError::CookieTooShort.into()); + } + + let default_hostname = MidjourneyHostname::Standard; + let hostname = args.hostname.unwrap_or(&default_hostname); + + let page_size = args.request.page_size.unwrap_or(DEFAULT_PAGE_SIZE); + + let referer = format!("https://{}/imagine", hostname.as_str()); + + let url = format!("https://{}/api/imagine?user_id={}&page_size={}", + hostname.as_str(), + args.request.user_id.as_str(), + page_size, + ); + + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + // NB: Browser-identity headers (user-agent, sec-ch-ua*, accept-encoding) come + // from the emulation on the client; only request-context headers are set here. + let http_request = client.get(url) + .header("cookie", cookie_header) + .header("Referer", &referer) + .header("Referrer-Policy", "origin-when-cross-origin") + .header("accept", "*/*") + .header("accept-language", "en-US,en;q=0.8") + .header("content-type", "application/json") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header("x-csrf-protection", "1"); + + let http_request = http_request + .build() + .map_err(|err| MidjourneyClientError::WreqError(err))?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + + let response_body = response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + } + + /* + { + "data": [ + { + "id": "a2339f14-ff71-43e4-a69f-8da15e7ba871", + "enqueue_time": "2025-08-14T17:21:28.403560+00:00", + "parent_id": null, + "video_segments": null, + "rating": null, + "job_type": "v7_diffusion", + "event_type": "diffusion", + "parent_grid": null, + "full_command": "a modern n64 console", + "batch_size": 4, + "width": 1024, + "height": 1024, + "published": true, + "shown": true, + "user_hidden": false, + "template": null, + "vid_framecount": null + }, + ], + "cursor": "encrypted cursor", + "checkpoint": "encrypted something ???" + } + */ + + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawImagineResponse { + data: Vec, + cursor: Option, + //pub checkpoint: Option, + } + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawImagineItem { + // The job id + id: Option, + + // The prompt plus `--` args. + full_command: Option, + + // Number of images, typically 4 + batch_size: Option, + + // Some possible values: + // "v6_diffusion" + // "v7_diffusion" + // "v7_draft_raw_diffusion" + // "v7_raw_diffusion" + // "vid_1.1_i2v_render_b_joint_video", + // "vid_1.1_i2v_start_end_a_video" + // "vid_1.1_i2v_start_end_b_video" + job_type: Option, + + // Some possible values: + // "diffusion" + // "draft" + // "variation" + // "video_diffusion" + // "video_start_end" + event_type: Option, + } + + let response : RawImagineResponse = serde_json::from_str(&response_body) + .map_err(|err| MidjourneyApiError::deserialization(err, response_body.as_str()))?; + + Ok(ImagineResponse { + cursor: response.cursor.clone(), + items: response.data + .into_iter() + .map(|item| { + ImagineItem { + id: item.id, + full_command: item.full_command, + job_type: item.job_type.as_ref() + .map(|jt| MidjourneyJobType::from_str(jt)) + } + }).collect(), + }) +} + +#[cfg(test)] +mod tests { + use crate::credentials::midjourney_user_id::MidjourneyUserId; + use crate::endpoints::imagine::{imagine, ImagineArgs, ImagineRequest}; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + let user_id = read_to_trimmed_string("/Users/bt/secrets/midjourney/user_id.txt")?; + let user_id = MidjourneyUserId::from_string(user_id); + + let result = imagine(ImagineArgs { + request: ImagineRequest { + user_id: &user_id, + page_size: None, + }, + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}\n\n", result); + + assert_eq!(1, 2); + + Ok(()) + } +} + + diff --git a/crates/api_clients/midjourney_client/src/endpoints/mod.rs b/crates/api_clients/midjourney_client/src/endpoints/mod.rs new file mode 100644 index 00000000..704adc84 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/mod.rs @@ -0,0 +1,7 @@ +pub mod get_index_page_html; +pub mod imagine; +pub mod prompt_session_log; +pub mod refresh_token; +pub mod storage_list; +pub mod submit_job; +pub mod user_connections; diff --git a/crates/api_clients/midjourney_client/src/endpoints/prompt_session_log.rs b/crates/api_clients/midjourney_client/src/endpoints/prompt_session_log.rs new file mode 100644 index 00000000..707e81b3 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/prompt_session_log.rs @@ -0,0 +1,152 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use log::error; +use serde::{Deserialize, Serialize}; + +/// The semantic parameters of a prompt-session-log entry. +/// +/// This endpoint is telemetry the web client fires alongside each imagine +/// submission (see the `08`/`11` captures); it is NOT the job-enqueue call +/// (that is `submit_job`). We mirror it so our traffic matches the browser's. +pub struct PromptSessionLogRequest<'a> { + /// A client-generated session id (UUID) grouping prompts in one sitting. + pub session_id: &'a str, + + /// Monotonic index of this prompt within the session, starting at 0. + pub sequence_index: u32, + + /// Epoch milliseconds when the prompt was captured. + pub captured_at_ms: u64, + + /// The prompt text WITHOUT the trailing `--` parameters. + pub raw_text: &'a str, + + /// The model version string, e.g. `"8.2"`. + pub version: &'a str, +} + +/// A prompt-session-log request plus its transport concerns. +pub struct PromptSessionLogArgs<'a> { + pub request: PromptSessionLogRequest<'a>, + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug, Clone)] +pub struct PromptSessionLogResponse { + /// The `status` field from the response body (e.g. `"success"`). + pub status: Option, +} + +pub async fn prompt_session_log( + args: PromptSessionLogArgs<'_>, +) -> Result { + let cookie_header = args.cookie_header.trim(); + if cookie_header.len() < 20 { + error!("Cookie header is too short (len: {}): {}", cookie_header.len(), cookie_header); + return Err(MidjourneyClientError::CookieTooShort.into()); + } + + let default_hostname = MidjourneyHostname::Standard; + let hostname = args.hostname.unwrap_or(&default_hostname); + + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let referer = format!("https://{}/imagine", hostname.as_str()); + let url = format!("https://{}/api/prompt-session-log", hostname.as_str()); + + #[derive(Serialize)] + struct RawRequest<'a> { + session_id: &'a str, + sequence_index: u32, + captured_at_ms: u64, + source: &'a str, + raw_text: &'a str, + route: &'a str, + in_conversation_mode: bool, + version: &'a str, + video_mode: bool, + image_prompt_count: u32, + style_ref_count: u32, + character_ref_count: u32, + depth_ref_count: u32, + starting_frame_count: u32, + ending_frame_count: u32, + openai_item_id: Option, + } + + let body = RawRequest { + session_id: args.request.session_id, + sequence_index: args.request.sequence_index, + captured_at_ms: args.request.captured_at_ms, + source: "imagine_text", + raw_text: args.request.raw_text, + route: "/imagine", + in_conversation_mode: false, + version: args.request.version, + video_mode: false, + image_prompt_count: 0, + style_ref_count: 0, + character_ref_count: 0, + depth_ref_count: 0, + starting_frame_count: 0, + ending_frame_count: 0, + openai_item_id: None, + }; + + let http_request = client.post(url) + .header("cookie", cookie_header) + .header("Referer", &referer) + .header("Referrer-Policy", "origin-when-cross-origin") + .header("accept", "*/*") + .header("accept-language", "en-US,en;q=0.8") + .header("content-type", "application/json") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header("x-csrf-protection", "1") + .json(&body) + .build() + .map_err(MidjourneyClientError::WreqError)?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + let response_body = response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + return Err(MidjourneyApiError::UnknownHttpFailure { + status_code: status.as_u16(), + body: response_body, + }.into()); + } + + // {"status":"success"} + #[derive(Deserialize)] + struct RawResponse { + status: Option, + } + + let response = serde_json::from_str::(&response_body) + .map_err(|err| MidjourneyApiError::deserialization(err, response_body.as_str()))?; + + Ok(PromptSessionLogResponse { + status: response.status, + }) +} diff --git a/crates/api_clients/midjourney_client/src/endpoints/refresh_token.rs b/crates/api_clients/midjourney_client/src/endpoints/refresh_token.rs new file mode 100644 index 00000000..dfc8953a --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/refresh_token.rs @@ -0,0 +1,120 @@ +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use serde::Deserialize; + +/// Google Identity Toolkit endpoint that Midjourney's Firebase auth uses to +/// exchange a refresh token for a fresh ID token. +const SECURE_TOKEN_URL: &str = "https://securetoken.googleapis.com/v1/token"; + +/// The public Firebase Web API key embedded in the Midjourney web app. This is +/// not a secret (it ships in the client bundle); it identifies the Firebase +/// project, and access is still gated by the refresh token. +pub const DEFAULT_FIREBASE_API_KEY: &str = "AIzaSyAjizp68NsH3JGUS0EyLXsChW4fN0A92tM"; + +/// Exchanges a refresh token for a new ID/access token. +/// +/// The refresh token is the value of the `__Host-Midjourney.AuthUserTokenV3_r` +/// cookie. The returned `id_token` is the new value for the +/// `__Host-Midjourney.AuthUserTokenV3_i` cookie. +pub struct RefreshTokenRequest<'a> { + pub refresh_token: &'a str, + + /// Firebase Web API key. Pass `DEFAULT_FIREBASE_API_KEY` unless overriding. + pub api_key: &'a str, +} + +/// A refresh-token request plus its transport concerns. This endpoint hits +/// Google's securetoken service (not Midjourney), so it has no cookie or +/// hostname — only an optional browser profile. +pub struct RefreshTokenArgs<'a> { + pub request: RefreshTokenRequest<'a>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug, Clone)] +pub struct RefreshTokenResponse { + /// The new access token (same value as `id_token`). + pub access_token: String, + + /// The new Firebase ID token — the fresh `AuthUserTokenV3_i` cookie value. + pub id_token: String, + + /// The refresh token to use next time (may be rotated). + pub refresh_token: String, + + /// Seconds until `access_token` expires (as returned, a stringified number). + pub expires_in: Option, + + pub token_type: Option, + pub user_id: Option, + pub project_id: Option, +} + +pub async fn refresh_token( + args: RefreshTokenArgs<'_>, +) -> Result { + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let url = format!("{}?key={}", SECURE_TOKEN_URL, args.request.api_key); + + let form = [ + ("grant_type", "refresh_token"), + ("refresh_token", args.request.refresh_token), + ]; + + let http_request = client.post(url) + .header("Origin", "https://www.midjourney.com") + .header("Referer", "https://www.midjourney.com/") + .header("accept", "*/*") + .header("accept-language", "en-US,en;q=0.8") + .header("content-type", "application/x-www-form-urlencoded") + .form(&form) + .build() + .map_err(MidjourneyClientError::WreqError)?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + let response_body = response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + return Err(match status.as_u16() { + 400 => MidjourneyApiError::InvalidRequest(response_body), + 401 => MidjourneyApiError::Unauthorized(response_body), + 403 => MidjourneyApiError::Forbidden(response_body), + code => MidjourneyApiError::UnknownHttpFailure { status_code: code, body: response_body }, + }.into()); + } + + #[derive(Deserialize)] + struct RawResponse { + access_token: String, + id_token: String, + refresh_token: String, + expires_in: Option, + token_type: Option, + user_id: Option, + project_id: Option, + } + + let response = serde_json::from_str::(&response_body) + .map_err(|err| MidjourneyApiError::deserialization(err, response_body.as_str()))?; + + Ok(RefreshTokenResponse { + access_token: response.access_token, + id_token: response.id_token, + refresh_token: response.refresh_token, + expires_in: response.expires_in, + token_type: response.token_type, + user_id: response.user_id, + project_id: response.project_id, + }) +} diff --git a/crates/api_clients/midjourney_client/src/endpoints/storage_list.rs b/crates/api_clients/midjourney_client/src/endpoints/storage_list.rs new file mode 100644 index 00000000..d9f6ad03 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/storage_list.rs @@ -0,0 +1,148 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use log::error; +use serde::Deserialize; + +/// Lists the user's storage (the paths contain the user id). Has no semantic +/// parameters — only transport concerns. +pub struct StorageListArgs<'a> { + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug)] +pub struct StorageItem { + // NB: The path contains the user ID. + pub bucket_pathname: Option, + + // NB: Other fields aren't necessary for us right now. +} + +pub async fn storage_list(args: StorageListArgs<'_>) -> Result, MidjourneyError> { + let default_hostname = MidjourneyHostname::Standard; + let hostname = args.hostname.unwrap_or(&default_hostname); + + let referer = format!("https://{}", hostname.as_str()); + + let url = format!("https://{}/api/storage-list", hostname.as_str()); + + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let cookie_header = args.cookie_header.trim(); + + if cookie_header.len() < 20 { + error!("Cookie header is too short (len: {}): {}", cookie_header.len(), cookie_header); + return Err(MidjourneyClientError::CookieTooShort.into()); + } + + // NB: Browser-identity headers come from the emulation on the client; only + // request-context headers are set here. + let http_request = client.get(url) + .header("cookie", cookie_header) + .header("Referer", &referer) + .header("Referrer-Policy", "origin-when-cross-origin") + .header("accept", "*/*") + .header("accept-language", "en-US,en;q=0.8") + .header("content-type", "application/json") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header("x-csrf-protection", "1"); + + let http_request = http_request + .build() + .map_err(|err| MidjourneyClientError::WreqError(err))?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + + // if status == 301 { + // for (name, value) in response.headers().iter() { + // println!("- {}: {}", name.as_str(), value.to_str().unwrap()); + // } + // } + + let response_body = &response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + } + + /* + [ + { + "bucketPathname": "UUID/OTHER_HEX_ENTROPY.png", + "shortUrl": null, + "type": "image-prompt", + "origin": "web", + "timeCreated": TIMESTAMP, + "hidden": false, + "contentType": "image/png", + "state": "loaded" + } + ] + */ + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawStorageItem { + bucketPathname: Option, + } + + let response : Vec = serde_json::from_str(response_body) + .map_err(|err| MidjourneyApiError::deserialization(err, response_body.as_str()))?; + + let items = response + .into_iter() + .map(|r| StorageItem { + bucket_pathname: r.bucketPathname, + }) + .collect::>(); + + Ok(items) +} + +#[cfg(test)] +mod tests { + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + use crate::endpoints::storage_list::{storage_list, StorageListArgs}; + + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + + let result = storage_list(StorageListArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}\n\n", result); + + for provider in result { + println!("Provider: {:?}", provider); + } + + assert_eq!(1, 2); + + Ok(()) + } +} diff --git a/crates/api_clients/midjourney_client/src/endpoints/submit_job.rs b/crates/api_clients/midjourney_client/src/endpoints/submit_job.rs new file mode 100644 index 00000000..a098e1c1 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/submit_job.rs @@ -0,0 +1,321 @@ +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use log::{error, warn}; +use serde::{Deserialize, Serialize}; + +use crate::client::midjourney_hostname::MidjourneyHostname; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; + +/// The semantic parameters of a submit-jobs request. +pub struct SubmitJobRequest<'a> { + pub prompt: &'a str, + pub channel_id: &'a str, +} + +/// A submit-jobs request plus its transport concerns. +pub struct SubmitJobArgs<'a> { + pub request: SubmitJobRequest<'a>, + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug, Clone)] +pub struct SubmitJobResponse { + /// On success, the job ID is returned. + pub maybe_job_id: Option, + + /// On error, we have a list of error messages. + pub maybe_errors: Option>, +} + +impl SubmitJobResponse { + /// The classified errors returned by the submit, if any. + pub fn errors(&self) -> &[SubmitJobError] { + self.maybe_errors.as_deref().unwrap_or(&[]) + } + + /// Whether the submit was rejected because the account has no active paid + /// Midjourney subscription (free trials disabled). First-class so callers + /// can branch on it (e.g. prompt the user to subscribe). + pub fn is_subscription_required(&self) -> bool { + self.errors() + .iter() + .any(|error| error.error_type == MidjourneySubmitErrorType::SubscriptionRequired) + } +} + +#[derive(Debug, Clone)] +pub struct SubmitJobError { + pub error_type: MidjourneySubmitErrorType, + pub message: Option, +} + +/// A classified Midjourney submit-jobs failure `type`. Unknown values are +/// preserved via [`MidjourneySubmitErrorType::Other`] so matching stays +/// exhaustive-safe. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum MidjourneySubmitErrorType { + /// `subscription_required`: the account needs an active paid Midjourney plan. + SubscriptionRequired, + + /// Any other failure type Midjourney returned (carries the raw string). + Other(String), +} + +impl MidjourneySubmitErrorType { + pub fn from_api_str(value: &str) -> Self { + match value { + "subscription_required" => Self::SubscriptionRequired, + other => Self::Other(other.to_string()), + } + } +} + +pub async fn submit_job(args: SubmitJobArgs<'_>) -> Result { + let default_hostname = MidjourneyHostname::Standard; + let hostname = args.hostname.unwrap_or(&default_hostname); + + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let referer = format!("https://{}", hostname.as_str()); + + // NB: Other recent clients use /api/app/submit-jobs, but this appears invalid. + let url = format!("https://{}/api/submit-jobs", hostname.as_str()); + + let cookie_header = args.cookie_header.trim(); + + if cookie_header.len() < 20 { + error!("Cookie header is too short (len: {}): {}", cookie_header.len(), cookie_header); + return Err(MidjourneyClientError::CookieTooShort.into()); + } + + // NB: Browser-identity headers (user-agent, sec-ch-ua*, accept-encoding) are + // set coherently by the emulation on the client; here we set only the + // request-context headers. + let http_request = client.post(url) + .header("cookie", cookie_header) + .header("Referer", &referer) + .header("Referrer-Policy", "origin-when-cross-origin") + .header("accept", "*/*") + .header("accept-language", "en-US,en;q=0.8") + .header("content-type", "application/json") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header("x-csrf-protection", "1"); + + #[derive(Serialize)] + struct F { + mode: String, + private: bool, + } + + #[derive(Serialize)] + #[allow(non_snake_case)] + struct Metadata { + // NB: Field order and null-vs-empty match the browser request exactly. + isMobile: Option, + imagePrompts: u8, + imageReferences: u8, + characterReferences: u8, + depthReferences: u8, + lightboxOpen: Option, + } + + #[derive(Serialize)] + #[allow(non_snake_case)] + struct RawRequest { + f: F, + channelId: String, + metadata: Metadata, + t: String, + prompt: String, + } + + let body = RawRequest { + f: F { + mode: "fast".to_string(), + private: false, + }, + channelId: args.request.channel_id.to_string(), + metadata: Metadata { + isMobile: None, + imagePrompts: 0, + imageReferences: 0, + characterReferences: 0, + depthReferences: 0, + lightboxOpen: None, + }, + t: "imagine".to_string(), + prompt: args.request.prompt.to_string(), + }; + + let http_request = http_request + .json(&body) + .build() + .map_err(|err| MidjourneyClientError::WreqError(err))?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + + // if status == 301 { + // for (name, value) in response.headers().iter() { + // println!("- {}: {}", name.as_str(), value.to_str().unwrap()); + // } + // } + + let response_body = &response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + log::info!( + "Midjourney submit-jobs response: status={}, body_len={}, looks_like_challenge={}", + status.as_u16(), + response_body.len(), + response_body.contains("challenge-platform") || response_body.contains("Just a moment"), + ); + + if !status.is_success() { + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + } + + /* + {"success":[ + { + "job_id":"UUID-like-string", + "prompt":"prompt", + "is_queued":false, + "event_type":"diffusion", + "flags":{ + "mode":"fast","visibility":"public" + }, + "meta":{ + "height":1024,"width":1024,"batch_size":4,"parent_id":null,"parent_grid":null + }, + "optimisticJobIndex":0, + "personalization_codes":null + }], + "failure":[]} + */ + + #[derive(Deserialize)] + struct SuccessPayload { + job_id: String, + } + + #[derive(Deserialize)] + struct FailurePayload { + r#type: String, + message: String, + } + + #[derive(Deserialize)] + #[allow(non_snake_case)] + struct RawResponse { + success: Vec, + failure: Option>, + } + + let response = serde_json::from_str::(response_body) + .map_err(|err| MidjourneyApiError::deserialization(err, response_body.as_str()))?; + + let maybe_job_id = response.success + .get(0) + .map(|s| s.job_id.clone()); + + if maybe_job_id.is_none() { + warn!("No job id found in body: {:?}", response_body); + } + + let mut maybe_errors = None; + + if let Some(failures) = response.failure.as_ref() { + if !failures.is_empty() { + maybe_errors = Some(failures.iter() + .map(|f| SubmitJobError { + error_type: MidjourneySubmitErrorType::from_api_str(&f.r#type), + message: Some(f.message.clone()), + }).collect()); + } + } + + Ok(SubmitJobResponse { + maybe_job_id, + maybe_errors, + }) +} + +#[cfg(test)] +mod tests { + use crate::endpoints::submit_job::{ + submit_job, MidjourneySubmitErrorType, SubmitJobArgs, SubmitJobError, SubmitJobRequest, + SubmitJobResponse, + }; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + #[test] + fn classifies_subscription_required() { + assert_eq!( + MidjourneySubmitErrorType::from_api_str("subscription_required"), + MidjourneySubmitErrorType::SubscriptionRequired, + ); + assert_eq!( + MidjourneySubmitErrorType::from_api_str("softban"), + MidjourneySubmitErrorType::Other("softban".to_string()), + ); + } + + #[test] + fn response_flags_subscription_required() { + let response = SubmitJobResponse { + maybe_job_id: None, + maybe_errors: Some(vec![SubmitJobError { + error_type: MidjourneySubmitErrorType::SubscriptionRequired, + message: Some("Please subscribe".to_string()), + }]), + }; + assert!(response.is_subscription_required()); + + let ok = SubmitJobResponse { maybe_job_id: Some("job".to_string()), maybe_errors: None }; + assert!(!ok.is_subscription_required()); + } + + // Get channel id via: + // https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[TOKEN] + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + let channel_id = read_to_trimmed_string("/Users/bt/secrets/midjourney/channel_id.txt")?; + + let result = submit_job(SubmitJobArgs { + request: SubmitJobRequest { + prompt: "a modern n64 console", + channel_id: &channel_id, + }, + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}", result); + + assert_eq!(1, 2); + + + Ok(()) + } +} diff --git a/crates/api_clients/midjourney_client/src/endpoints/user_connections.rs b/crates/api_clients/midjourney_client/src/endpoints/user_connections.rs new file mode 100644 index 00000000..e1a23901 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/endpoints/user_connections.rs @@ -0,0 +1,178 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use log::error; +use serde::Deserialize; + +/// Lists the user's linked auth providers. Has no semantic parameters — only +/// transport concerns. +pub struct UserConnectionsArgs<'a> { + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug)] +pub struct UserData { + pub provider_id: String, + pub display_name: Option, + pub email: Option, + pub user_id: Option, +} + +#[derive(Debug)] +pub struct Provider { + pub provider_id: String, + pub user_data: Option, + pub is_linked: bool, +} + +pub async fn user_connections(args: UserConnectionsArgs<'_>) -> Result, MidjourneyError> { + let default_hostname = MidjourneyHostname::Standard; + let hostname = args.hostname.unwrap_or(&default_hostname); + + let referer = format!("https://{}", hostname.as_str()); + + let url = format!("https://{}/api/user-connections", hostname.as_str()); + + let client = args.browser.clone().unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?; + + let cookie_header = args.cookie_header.trim(); + + if cookie_header.len() < 20 { + error!("Cookie header is too short (len: {}): {}", cookie_header.len(), cookie_header); + return Err(MidjourneyClientError::CookieTooShort.into()); + } + + // NB: Browser-identity headers come from the emulation on the client; only + // request-context headers are set here. + let http_request = client.get(url) + .header("cookie", cookie_header) + .header("Referer", &referer) + .header("Referrer-Policy", "origin-when-cross-origin") + .header("accept", "*/*") + .header("accept-language", "en-US,en;q=0.8") + .header("content-type", "application/json") + .header("priority", "u=1, i") + .header("sec-fetch-dest", "empty") + .header("sec-fetch-mode", "cors") + .header("sec-fetch-site", "same-origin") + .header("x-csrf-protection", "1"); + + let http_request = http_request + .build() + .map_err(|err| MidjourneyClientError::WreqError(err))?; + + let response = client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + + // if status == 301 { + // for (name, value) in response.headers().iter() { + // println!("- {}: {}", name.as_str(), value.to_str().unwrap()); + // } + // } + + let response_body = &response.text().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + } + + /* + [ + { + "providerId": "google.com", + "userData": { + "providerId": "google.com", + "displayName": "John Doe", + "email": "john.doe@gmail.com", + "userId": "123456789000000001", + }, + "isLinked": true + }, + { + "providerId": "discord.com", + "isLinked": false + } + ] + */ + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawProviderUserData { + providerId: String, + displayName: Option, + email: Option, + userId: Option, + } + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawProvider { + providerId: String, + userData: Option, + isLinked: bool, + } + + let response : Vec = serde_json::from_str(response_body) + .map_err(|err| MidjourneyApiError::deserialization(err, response_body.as_str()))?; + + let providers = response + .into_iter() + .map(|r| Provider { + provider_id: r.providerId, + user_data: r.userData.map(|u| UserData { + provider_id: u.providerId, + display_name: u.displayName, + email: u.email, + user_id: u.userId, + }), + is_linked: r.isLinked, + }) + .collect::>(); + + Ok(providers) +} + +#[cfg(test)] +mod tests { + use crate::endpoints::user_connections::{user_connections, UserConnectionsArgs}; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + + let result = user_connections(UserConnectionsArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}\n\n", result); + + for provider in result { + println!("Provider: {:?}", provider); + } + + assert_eq!(1, 2); + + Ok(()) + } +} + diff --git a/crates/api_clients/midjourney_client/src/error/midjourney_api_error.rs b/crates/api_clients/midjourney_client/src/error/midjourney_api_error.rs new file mode 100644 index 00000000..48dd122c --- /dev/null +++ b/crates/api_clients/midjourney_client/src/error/midjourney_api_error.rs @@ -0,0 +1,139 @@ +use cloudflare_errors::cloudflare_error::CloudflareError; +use errors::AnyhowError; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::io; + +#[derive(Debug)] +pub enum MidjourneyApiError { + /// There was no user ID in an otherwise valid-looking response. + NoUserId, + + /// No user props in index HTML payload. + /// We need this for the user ID and the websocket token. + NoUserProps, + + /// No initialAuthUser in the index HTML payload. + /// We need this for the user ID and the websocket token. + NoInitialAuthUser, + + /// 400. The request was invalid. + InvalidRequest(String), + + /// 401. The request was not authorized. + Unauthorized(String), + + /// 403. The request was forbidden. + Forbidden(String), + + /// 404. The requested resource was not found. + NotFound(String), + + /// 429. Too many requests. + TooManyRequests(String), + + /// 500. An internal server error occurred. + InternalServerError { + body: String, + backend_hostname: Option, + }, + + /// Eg. when downloading images + UnknownHttpFailure { + status_code: u16, + body: String, + }, + + /// Cloudflare errors. + CloudflareError(CloudflareError), + + /// A deserialization error with the response. Carries the raw response body + /// that failed to parse, so the exact shape is visible in logs. + DeserializationError { + source: serde_json::Error, + body: String, + }, + + /// The request timed out. + Timeout(String), + + /// A network error occurred. + NetworkError(String), + + /// An error doing file I/O (on our side) + IoError(io::Error), + + /// Another type of error. + Other(AnyhowError), +} + +impl Error for MidjourneyApiError {} + +impl Display for MidjourneyApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + // Response body errors + Self::NoUserId => write!(f, "No user ID found in the response body."), + Self::NoUserProps => write!(f, "No user properties found in the index HTML payload."), + Self::NoInitialAuthUser => write!(f, "No initialAuthUser in the index HTML payload."), + // Server response code errors + Self::InvalidRequest(msg) => write!(f, "Invalid request: {}", msg), + Self::Unauthorized(msg) => write!(f, "Unauthorized: {}", msg), + Self::Forbidden(msg) => write!(f, "Forbidden: {}", msg), + Self::NotFound(msg) => write!(f, "Not found: {}", msg), + Self::TooManyRequests(msg) => write!(f, "Too many requests: {}", msg), + Self::InternalServerError {body, backend_hostname} => + write!(f, "Internal Server Error; backend hostname: {:?} ; body: {}; ", backend_hostname, body), + Self::UnknownHttpFailure {status_code, body} => + write!(f, "Unknown HTTP failure; status code: {}; body: {}", status_code, body), + // Deserialization errors + // Server response handling errors + Self::DeserializationError { source, body } => write!( + f, + "Deserialization error: {} | raw response body ({} bytes): {}", + source, + body.len(), + body, + ), + // Network errors + Self::Timeout(msg) => write!(f, "Timeout: {}", msg), + Self::NetworkError(msg) => write!(f, "Network error: {}", msg), + // Cloudflare errors + Self::CloudflareError(error) => write!(f, "Cloudflare Error: {}", error), + // I/O errors + Self::IoError(error) => write!(f, "IO error: {}", error), + // Other + Self::Other(error) => write!(f, "Other error: {}", error), + } + } +} + +impl MidjourneyApiError { + /// Build a [`MidjourneyApiError::DeserializationError`] that captures the raw + /// body that failed to parse, and log the whole payload immediately so it is + /// never lost even if the error is later swallowed. + pub fn deserialization(source: serde_json::Error, body: &str) -> Self { + log::warn!( + "Midjourney response failed to deserialize: {} | raw body ({} bytes): {}", + source, + body.len(), + body, + ); + Self::DeserializationError { + source, + body: body.to_string(), + } + } +} + +impl From for MidjourneyApiError { + fn from(error: io::Error) -> Self { + Self::IoError(error) + } +} + +impl From for MidjourneyApiError { + fn from(error: CloudflareError) -> Self { + Self::CloudflareError(error) + } +} diff --git a/crates/api_clients/midjourney_client/src/error/midjourney_client_error.rs b/crates/api_clients/midjourney_client/src/error/midjourney_client_error.rs new file mode 100644 index 00000000..26829267 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/error/midjourney_client_error.rs @@ -0,0 +1,84 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::io; +use std::path::PathBuf; + +/// An error arising from the client, either before or after the request is sent. +#[derive(Debug)] +pub enum MidjourneyClientError { + /// The cookie was too short to be valid. + CookieTooShort, + + /// Tried to look up an image out of range [0,4) + InvalidImageIndex, + + /// Could not determine the filetype for the file. + FileTypeNotKnown(PathBuf), + + /// Could not handle the file type. + FileTypeNotHandled(PathBuf), + + /// An error doing file I/O (on our side) + IoError(io::Error), + + // /// An error setting up the client + // ReqwestError(reqwest::Error), + WreqError(wreq::Error), + + /// A serialization error with the request. + SerializationError(serde_json::Error), + + /// The websocket upgrade handshake failed. + WebSocketUpgrade(String), + + /// Tried to send on a websocket whose background task has stopped. + WebSocketClosed, + + /// The websocket opened but the `subscribe_to_user` handshake did not + /// complete within the allotted time. + WebSocketHandshakeTimeout, +} + +impl Error for MidjourneyClientError {} + +impl Display for MidjourneyClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::CookieTooShort => write!(f, "The cookie header is too short to be valid."), + Self::InvalidImageIndex => write!(f, "The image index is out of range. Valid range is [0, 4)."), + Self::FileTypeNotKnown(path) => write!(f, "Could not determine the filetype for the file: {:?}", path), + Self::FileTypeNotHandled(path) => write!(f, "Could not handle the file type for the file: {:?}", path), + Self::IoError(err) => write!(f, "IO error: {}", err), + //Self::ReqwestError(err) => write!(f, "Reqwest client error: {}", err), + Self::WreqError(err) => write!(f, "Wreq client error: {}", err), + Self::SerializationError(err) => write!(f, "Request serialization error: {}", err), + Self::WebSocketUpgrade(msg) => write!(f, "WebSocket upgrade failed: {}", msg), + Self::WebSocketClosed => write!(f, "The websocket connection is closed."), + Self::WebSocketHandshakeTimeout => write!(f, "Timed out waiting for the websocket user handshake."), + } + } +} + +impl From for MidjourneyClientError { + fn from(error: io::Error) -> Self { + Self::IoError(error) + } +} + +impl From for MidjourneyClientError { + fn from(error: serde_json::Error) -> Self { + Self::SerializationError(error) + } +} + +/*impl From for MidjourneyClientError { + fn from(error: reqwest::Error) -> Self { + Self::ReqwestError(error) + } +}*/ + +impl From for MidjourneyClientError { + fn from(error: wreq::Error) -> Self { + Self::WreqError(error) + } +} diff --git a/crates/api_clients/midjourney_client/src/error/midjourney_error.rs b/crates/api_clients/midjourney_client/src/error/midjourney_error.rs new file mode 100644 index 00000000..61b6490f --- /dev/null +++ b/crates/api_clients/midjourney_client/src/error/midjourney_error.rs @@ -0,0 +1,32 @@ +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use std::error::Error; + +#[derive(Debug)] +pub enum MidjourneyError { + Api(MidjourneyApiError), + Client(MidjourneyClientError), +} + +impl Error for MidjourneyError {} + +impl std::fmt::Display for MidjourneyError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Api(e) => write!(f, "Midjourney API error: {:?}", e), + Self::Client(e) => write!(f, "Midjourney Client error: {:?}", e), + } + } +} + +impl From for MidjourneyError { + fn from(error: MidjourneyApiError) -> Self { + Self::Api(error) + } +} + +impl From for MidjourneyError { + fn from(error: MidjourneyClientError) -> Self { + Self::Client(error) + } +} diff --git a/crates/api_clients/midjourney_client/src/error/mod.rs b/crates/api_clients/midjourney_client/src/error/mod.rs new file mode 100644 index 00000000..ceefb7b1 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/error/mod.rs @@ -0,0 +1,3 @@ +pub mod midjourney_error; +pub mod midjourney_api_error; +pub mod midjourney_client_error; \ No newline at end of file diff --git a/crates/api_clients/midjourney_client/src/lib.rs b/crates/api_clients/midjourney_client/src/lib.rs new file mode 100644 index 00000000..1adf9304 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/lib.rs @@ -0,0 +1,8 @@ +//! A midjourney API client. + +pub mod client; +pub mod credentials; +pub mod endpoints; +pub mod error; +pub mod recipes; +pub mod utils; diff --git a/crates/api_clients/midjourney_client/src/recipes/channel_id.rs b/crates/api_clients/midjourney_client/src/recipes/channel_id.rs new file mode 100644 index 00000000..b9f876cf --- /dev/null +++ b/crates/api_clients/midjourney_client/src/recipes/channel_id.rs @@ -0,0 +1,20 @@ +use crate::credentials::midjourney_user_id::MidjourneyUserId; + +#[derive(Debug, Clone)] +pub enum ChannelId { + /// Channel based on the user ID. + /// This is what Midjourney uses by default. + UserId(MidjourneyUserId), + + // Bare string ID + Raw(String), +} + +impl ChannelId { + pub fn to_string(&self) -> String { + match self { + Self::UserId(user_id) => format!("singleplayer_{}", user_id.0), + Self::Raw(id) => id.clone(), + } + } +} diff --git a/crates/api_clients/midjourney_client/src/recipes/get_midjourney_user_id_from_storage.rs b/crates/api_clients/midjourney_client/src/recipes/get_midjourney_user_id_from_storage.rs new file mode 100644 index 00000000..25182173 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/recipes/get_midjourney_user_id_from_storage.rs @@ -0,0 +1,60 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::credentials::midjourney_user_id::MidjourneyUserId; +use crate::endpoints::storage_list::{storage_list, StorageListArgs}; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; + +/// Recovers the user id from the storage list. Has no semantic parameters — +/// only transport concerns. +pub struct GetMidjourneyUserIdArgs<'a> { + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +pub async fn get_midjourney_user_id_from_storage( + args: GetMidjourneyUserIdArgs<'_>, +) -> Result { + let items = storage_list(StorageListArgs { + cookie_header: args.cookie_header, + hostname: args.hostname, + browser: args.browser, + }).await?; + + let user_id = items + .into_iter() + .find_map(|item| item.bucket_pathname) + .and_then(|path| path.split('/').next().map(|id| id.to_owned())) + .map(|id| MidjourneyUserId(id.to_string())) + .ok_or(MidjourneyApiError::NoUserId)?; + + Ok(user_id) +} + +#[cfg(test)] +mod tests { + use crate::recipes::get_midjourney_user_id_from_storage::{get_midjourney_user_id_from_storage, GetMidjourneyUserIdArgs}; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + + let result = get_midjourney_user_id_from_storage(GetMidjourneyUserIdArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}\n\n", result); + + assert_eq!(1, 2); + + Ok(()) + } +} diff --git a/crates/api_clients/midjourney_client/src/recipes/get_user_info.rs b/crates/api_clients/midjourney_client/src/recipes/get_user_info.rs new file mode 100644 index 00000000..43c25298 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/recipes/get_user_info.rs @@ -0,0 +1,172 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::credentials::midjourney_user_id::MidjourneyUserId; +use crate::endpoints::get_index_page_html::{get_index_page_html, GetIndexPageArgs}; +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_error::MidjourneyError; +use browser_emulation::browser_profile::BrowserProfile; +use dom_query::Document; +use serde::Deserialize; + +/// Fetches the user's id, email, and websocket token from the index page. Has +/// no semantic parameters — only transport concerns. +pub struct GetUserInfoArgs<'a> { + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug, Clone)] +pub struct GetUserInfoResponse { + pub user_id: Option, + pub email: Option, + pub websocket_token: Option, +} + +pub async fn get_user_info(args: GetUserInfoArgs<'_>) -> Result { + let index_html = get_index_page_html(GetIndexPageArgs { + cookie_header: args.cookie_header, + hostname: args.hostname, + browser: args.browser, + }).await?; + + // Diagnostics: distinguish a Cloudflare challenge from a genuinely + // logged-out page when the parse below fails. + log::info!( + "Midjourney index page: {} bytes; initialProps={}, initialAuthUser={}, websocketToken={}, turnstile={}, challenge-platform={}", + index_html.len(), + index_html.contains("initialProps"), + index_html.contains("initialAuthUser"), + index_html.contains("websocketToken"), + index_html.contains("turnstile"), + index_html.contains("challenge-platform"), + ); + + /* + + */ + + let document = Document::from(index_html); + let maybe_nodes = document.select("script[id=initialProps]"); + + let node = match maybe_nodes.get(0) { + Some(node) => node, + None => { + return Err(MidjourneyApiError::NoUserProps.into()); + } + }; + + let inner_json = node.inner_html().to_string(); + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawAuthUser { + // NB: The Midjourney user id. + id: Option, + email: Option, + websocketToken: Option, + } + + #[derive(Deserialize, Debug)] + #[allow(non_snake_case)] + struct RawBody { + initialAuthUser: Option, + } + + let response : RawBody = serde_json::from_str(&inner_json) + .map_err(|err| MidjourneyApiError::deserialization(err, inner_json.as_str()))?; + + let props = match response.initialAuthUser { + Some(props) => props, + None => { + return Err(MidjourneyApiError::NoInitialAuthUser.into()); + } + }; + + Ok(GetUserInfoResponse { + user_id: props.id + .map(|id| MidjourneyUserId::from_string(id)), + email: props.email + .map(|email| email.to_string()), + websocket_token: props.websocketToken + .map(|email| email.to_string()), + }) +} + +#[cfg(test)] +mod tests { + use crate::recipes::get_user_info::{get_user_info, GetUserInfoArgs}; + use errors::AnyhowResult; + use filesys::read_to_trimmed_string::read_to_trimmed_string; + + #[ignore] + #[tokio::test] + async fn test() -> AnyhowResult<()> { + let cookie_header = read_to_trimmed_string("/Users/bt/secrets/midjourney/cookie.txt")?; + + let result = get_user_info(GetUserInfoArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await?; + + println!("Response: {:?}\n\n", result); + + assert_eq!(1, 2); + + Ok(()) + } +} + diff --git a/crates/api_clients/midjourney_client/src/recipes/mod.rs b/crates/api_clients/midjourney_client/src/recipes/mod.rs new file mode 100644 index 00000000..7ec937df --- /dev/null +++ b/crates/api_clients/midjourney_client/src/recipes/mod.rs @@ -0,0 +1,4 @@ +mod get_midjourney_user_id_from_storage; +pub mod channel_id; +pub mod get_user_info; +pub mod text_to_image; \ No newline at end of file diff --git a/crates/api_clients/midjourney_client/src/recipes/text_to_image.rs b/crates/api_clients/midjourney_client/src/recipes/text_to_image.rs new file mode 100644 index 00000000..afbc99ce --- /dev/null +++ b/crates/api_clients/midjourney_client/src/recipes/text_to_image.rs @@ -0,0 +1,76 @@ +use crate::client::midjourney_hostname::MidjourneyHostname; +use crate::endpoints::submit_job::{submit_job, MidjourneySubmitErrorType, SubmitJobArgs, SubmitJobRequest}; +use crate::error::midjourney_error::MidjourneyError; +use crate::recipes::channel_id::ChannelId; +use browser_emulation::browser_profile::BrowserProfile; + +/// The semantic parameters of a text-to-image request. +pub struct TextToImageRequest<'a> { + pub prompt: &'a str, + pub channel_id: &'a ChannelId, +} + +/// A text-to-image request plus its transport concerns. +pub struct TextToImageArgs<'a> { + pub request: TextToImageRequest<'a>, + pub cookie_header: &'a str, + /// Defaults to the standard hostname if absent. + pub hostname: Option<&'a MidjourneyHostname>, + /// Defaults to [`BrowserProfile::default`] if absent. + pub browser: Option, +} + +#[derive(Debug, Clone)] +pub struct TextToImageResponse { + /// On success, the job ID is returned. + pub maybe_job_id: Option, + + /// On error, we have a list of error messages. + pub maybe_errors: Option>, +} + +impl TextToImageResponse { + pub fn errors(&self) -> &[TextToImageError] { + self.maybe_errors.as_deref().unwrap_or(&[]) + } + + /// Whether the request was rejected for lack of an active paid Midjourney + /// subscription. See [`MidjourneySubmitErrorType::SubscriptionRequired`]. + pub fn is_subscription_required(&self) -> bool { + self.errors() + .iter() + .any(|error| error.error_type == MidjourneySubmitErrorType::SubscriptionRequired) + } +} + +#[derive(Debug, Clone)] +pub struct TextToImageError { + pub error_type: MidjourneySubmitErrorType, + pub message: Option, +} + +/// Slightly more ergonomic text-to-image API. +/// As we add more `submit_job()` cases, we'll keep this simple. +pub async fn text_to_image(args: TextToImageArgs<'_>) -> Result { + let channel_id = args.request.channel_id.to_string(); + + let response = submit_job(SubmitJobArgs { + request: SubmitJobRequest { + prompt: args.request.prompt, + channel_id: &channel_id, + }, + cookie_header: args.cookie_header, + hostname: args.hostname, + browser: args.browser, + }).await?; + + Ok(TextToImageResponse { + maybe_job_id: response.maybe_job_id, + maybe_errors: response.maybe_errors.map(|errs| { + errs.into_iter().map(|e| TextToImageError { + error_type: e.error_type, + message: e.message, + }).collect() + }), + }) +} diff --git a/crates/api_clients/midjourney_client/src/utils/get_image_url.rs b/crates/api_clients/midjourney_client/src/utils/get_image_url.rs new file mode 100644 index 00000000..81116e8c --- /dev/null +++ b/crates/api_clients/midjourney_client/src/utils/get_image_url.rs @@ -0,0 +1,9 @@ +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; + +pub fn get_image_url(job_id: &str, image_index: u8) -> Result { + if image_index > 3 { + return Err(MidjourneyClientError::InvalidImageIndex.into()) + } + Ok(format!("https://cdn.midjourney.com/{}/0_{}.png", job_id, image_index)) +} diff --git a/crates/api_clients/midjourney_client/src/utils/image_downloader_client.rs b/crates/api_clients/midjourney_client/src/utils/image_downloader_client.rs new file mode 100644 index 00000000..a313b2a1 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/utils/image_downloader_client.rs @@ -0,0 +1,67 @@ +use crate::error::midjourney_api_error::MidjourneyApiError; +use crate::error::midjourney_client_error::MidjourneyClientError; +use crate::error::midjourney_error::MidjourneyError; +use crate::utils::get_image_url::get_image_url; +use browser_emulation::browser_profile::BrowserProfile; +use cloudflare_errors::filter_cloudflare_errors::filter_cloudflare_errors; +use wreq::Client; + +#[derive(Clone)] +pub struct ImageDownloaderClient { + client: Client, +} + +impl ImageDownloaderClient { + /// Build a downloader. `maybe_browser` defaults to [`BrowserProfile::default`]. + pub fn create(maybe_browser: Option) -> Result { + Ok(Self { + client: maybe_browser.unwrap_or_default() + .build_client() + .map_err(MidjourneyClientError::WreqError)?, + }) + } + + pub async fn download_image(&self, job_id: &str, image_index: u8) -> anyhow::Result, MidjourneyError> { + let url = get_image_url(job_id, image_index)?; + + // TODO: Cookies + // TODO: Cache control headers? + // NB: Browser-identity headers come from the emulation on the client; only + // request-context headers are set here. + let http_request = self.client.get(url) + .header("Referrer", "https://www.midjourney.com/") + .header("accept", "image/avif,image/webp,image/apng,image/svg+xml,image/*,*/*;q=0.8") + .header("accept-language", "en-US,en;q=0.8") + .header("priority", "i") + .header("sec-fetch-dest", "image") + .header("sec-fetch-mode", "no-cors") + .header("sec-fetch-site", "same-site"); + + let http_request = http_request + .build() + .map_err(|err| MidjourneyClientError::WreqError(err))?; + + let response = self.client.execute(http_request) + .await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + let status = response.status(); + + let response_bytes = response.bytes().await + .map_err(|e| MidjourneyApiError::NetworkError(e.to_string()))?; + + if !status.is_success() { + let response_body = String::from_utf8_lossy(&response_bytes).to_string(); + if let Err(err) = filter_cloudflare_errors(status.as_u16(), &response_body) { + return Err(MidjourneyApiError::CloudflareError(err).into()); + } + + return Err(MidjourneyApiError::UnknownHttpFailure { + status_code: status.as_u16(), + body: response_body, + }.into()); + } + + Ok(response_bytes.to_vec()) + } +} diff --git a/crates/api_clients/midjourney_client/src/utils/mod.rs b/crates/api_clients/midjourney_client/src/utils/mod.rs new file mode 100644 index 00000000..9f61b7f9 --- /dev/null +++ b/crates/api_clients/midjourney_client/src/utils/mod.rs @@ -0,0 +1,2 @@ +pub mod get_image_url; +pub mod image_downloader_client; \ No newline at end of file diff --git a/crates/api_clients/seedance2pro_client/Cargo.toml b/crates/api_clients/seedance2pro_client/Cargo.toml new file mode 100644 index 00000000..e2b2d11a --- /dev/null +++ b/crates/api_clients/seedance2pro_client/Cargo.toml @@ -0,0 +1,38 @@ +[package] +name = "seedance2pro_client" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "seedance2pro_client" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true + +# External +chrono.workspace = true +cloudflare_errors.workspace = true +log.workspace = true +rand.workspace = true +serde.workspace = true +serde_derive.workspace = true +serde_json.workspace = true +wreq-util.workspace = true +wreq.workspace = true +url.workspace = true + +[dev-dependencies] +env.workspace = true +env_logger.workspace = true +test_data = { path = "../../testing/test_data" } +test_utils = { path = "../../testing/test_utils" } +tokio = { version = "1", features = ["full"] } diff --git a/crates/api_clients/seedance2pro_client/costs_seedance2.md b/crates/api_clients/seedance2pro_client/costs_seedance2.md new file mode 100644 index 00000000..2f603df9 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/costs_seedance2.md @@ -0,0 +1,68 @@ +Cost table built on 2026-06-11 + +Seedance 2.0 (~$0.19/sec) +Seedance 2.0 Fast (~$0.13/sec) + +Without Video Uploads +===================== + +### Seedance 2.0 + +4 sec 480p = 60 credits +5 sec 480p = 75 credits +10 sec 480p = 150 credits +15 sec 480p = 225 credits + +4 sec 720p = 160 credits +5 sec 720p = 200 credits +10 sec 720p = 400 credits +15 sec 720p = 600 credits + +4 sec 1080p = 360 credits +5 sec 1080p = 450 credits +10 sec 1080p = 900 credits +15 sec 1080p = 1350 credits + +### Seedance 2.0 Fast + +fast 4 sec 480p = 56 credits +fast 5 sec 480p = 70 credits +fast 10 sec 480p = 140 credits +fast 15 sec 480p = 210 credits + +fast 4 sec 720p = 112 credits +fast 5 sec 720p = 140 credits +fast 10 sec 720p = 280 credits +fast 15 sec 720p = 420 credits + +With Video Uploads +================== + +### Seedance 2.0 With Video Refs + +4 sec 480p + 10 sec video ref = 60 credits + 16 credits +5 sec 480p + 10 sec video ref = 75 credits + 20 credits +10 sec 480p + 10 sec video ref = 150 credits + 40 credits +15 sec 480p + 10 sec video ref = 225 credits + 60 credits + +4 sec 720p + 10 sec video ref = 160 credits + 32 credits +5 sec 720p + 10 sec video ref = 200 credits + 40 credits +10 sec 720p + 10 sec video ref = 400 credits + 80 credits +15 sec 720p + 10 sec video ref = 600 credits + 120 credits + +4 sec 1080p + 10 sec video ref = 360 credits + 72 credits +5 sec 1080p + 10 sec video ref = 450 credits + 90 credits +10 sec 1080p + 10 sec video ref = 900 credits + 180 credits +15 sec 1080p + 10 sec video ref = 1350 credits + 270 credits + +### Seedance 2.0 Fast With Video Refs + +fast 4 sec 480p + 10 sec video ref = 56 credits + 16 credits +fast 5 sec 480p + 10 sec video ref = 70 credits + 20 credits +fast 10 sec 480p + 10 sec video ref = 140 credits + 40 credits +fast 15 sec 480p + 10 sec video ref = 210 credits + 60 credits + +fast 4 sec 720p + 10 sec video ref = 112 credits + 24 credits +fast 5 sec 720p + 10 sec video ref = 140 credits + 30 credits +fast 10 sec 720p + 10 sec video ref = 280 credits + 60 credits +fast 15 sec 720p + 10 sec video ref = 420 credits + 90 credits diff --git a/crates/api_clients/seedance2pro_client/src/billing/get_billing_payments_history.rs b/crates/api_clients/seedance2pro_client/src/billing/get_billing_payments_history.rs new file mode 100644 index 00000000..4a642b67 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/billing/get_billing_payments_history.rs @@ -0,0 +1,421 @@ +use chrono::{DateTime, Utc}; +use log::info; +use serde::Deserialize; +use wreq::Client; +use wreq_util::Emulation; + +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use crate::utils::number_coercion::de_u64_int_or_float; + +/// Page size the kinovi.ai billing dashboard uses. +pub const DEFAULT_BILLING_PAGE_LIMIT: u32 = 20; + +// --- Args & response --- + +pub struct GetBillingPaymentsHistoryArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// Page size. The web dashboard uses [`DEFAULT_BILLING_PAGE_LIMIT`]. + pub limit: u32, + + /// Zero-based row offset. Pagination is offset-based: advance by the + /// number of payments actually returned until a page comes back empty. + pub offset: u64, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +pub struct BillingPaymentsHistoryPage { + /// Payments on this page, newest first. + pub payments: Vec, + + /// Cursor of the row after this page (`None` on the last page). The + /// dashboard paginates by limit/offset; this is informational. + pub maybe_next_cursor: Option, + + /// Total payment rows on the account, per the server. + pub total: u64, +} + +// --- Public types --- + +/// One payment on the Kinovi billing dashboard (a credit-package purchase). +#[derive(Debug, Clone)] +pub struct BillingPayment { + pub id: String, + + /// Payment amount in US dollars (the API returns dollars: `2159`, `99.99`). + pub amount_usd: f64, + + pub status: BillingPaymentStatus, + + pub payment_type: BillingPaymentType, + + /// Kinovi credits granted by this payment (e.g. 525,000). + pub credits_earned: u64, + + /// e.g. "Credits Package" + pub product_name: String, + + pub transaction_id: String, + pub payment_id: String, + pub product_id: String, + + /// ISO 8601 creation timestamp (e.g. `"2026-07-13T20:40:49.405Z"`). + pub created_at: String, + + /// Parsed `created_at`. `None` if the raw string could not be parsed. + pub created_at_utc: Option>, + + pub updated_at: String, +} + +/// Payment status. Only `PAID` has been observed; unrecognised values are +/// preserved in `Unknown` so future statuses (refunds, chargebacks, pending) +/// don't break deserialization. +#[derive(Debug, Clone, PartialEq)] +pub enum BillingPaymentStatus { + Paid, + Unknown(String), +} + +impl BillingPaymentStatus { + fn from_str(s: &str) -> Self { + match s { + "PAID" => Self::Paid, + other => Self::Unknown(other.to_string()), + } + } +} + +/// Payment type. Only `ONE_TIME` has been observed. +#[derive(Debug, Clone, PartialEq)] +pub enum BillingPaymentType { + OneTime, + Unknown(String), +} + +impl BillingPaymentType { + fn from_str(s: &str) -> Self { + match s { + "ONE_TIME" => Self::OneTime, + other => Self::Unknown(other.to_string()), + } + } +} + +// --- Implementation --- + +pub async fn get_billing_payments_history( + args: GetBillingPaymentsHistoryArgs<'_>, +) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let url = format!("{}/api/trpc/billing.getPayments", base_url); + + info!("Fetching billing payments (limit: {}, offset: {})...", args.limit, args.offset); + + let input_json = build_input_json(args.limit, args.offset); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/app/dashboard/billing", base_url); + + let request = client.get(&url) + .query(&[("batch", "1"), ("input", input_json.as_str())]) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("content-type", "application/json") + .header("x-trpc-source", "client") + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.execute(request) + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Billing payments response status: {}", status); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + parse_response_body(&response_body) +} + +fn parse_response_body(response_body: &str) -> Result { + let batch_response: Vec = serde_json::from_str(response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.to_string()))?; + + let json = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.to_string(), + })? + .result + .data + .json; + + let payments = json.payments + .into_iter() + .map(|p| { + let created_at_utc = DateTime::parse_from_rfc3339(&p.created_at) + .map(|dt| dt.with_timezone(&Utc)) + .ok(); + BillingPayment { + id: p.id, + amount_usd: p.amount, + status: BillingPaymentStatus::from_str(&p.payment_status), + payment_type: BillingPaymentType::from_str(&p.payment_type), + credits_earned: p.credits_earned, + product_name: p.product_name, + transaction_id: p.transaction_id, + payment_id: p.payment_id, + product_id: p.product_id, + created_at: p.created_at, + created_at_utc, + updated_at: p.updated_at, + } + }) + .collect(); + + Ok(BillingPaymentsHistoryPage { + payments, + maybe_next_cursor: json.next_cursor, + total: json.total, + }) +} + +/// Builds the tRPC `input` JSON for the billing.getPayments endpoint. +fn build_input_json(limit: u32, offset: u64) -> String { + format!(r#"{{"0":{{"json":{{"limit":{limit},"offset":{offset}}}}}}}"#) +} + +// --- Raw response types --- + +#[derive(Deserialize, Debug)] +struct BatchResponseItem { + result: RawResult, +} + +#[derive(Deserialize, Debug)] +struct RawResult { + data: RawData, +} + +#[derive(Deserialize, Debug)] +struct RawData { + json: RawJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +struct RawJson { + payments: Vec, + #[serde(default)] + next_cursor: Option, + #[serde(deserialize_with = "de_u64_int_or_float")] + total: u64, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +struct RawPayment { + id: String, + amount: f64, + payment_status: String, + #[serde(default)] + transaction_id: String, + #[serde(default)] + payment_id: String, + #[serde(default)] + product_id: String, + #[serde(rename = "type")] + payment_type: String, + #[serde(deserialize_with = "de_u64_int_or_float")] + credits_earned: u64, + #[serde(default)] + product_name: String, + created_at: String, + #[serde(default)] + updated_at: String, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + mod offline_parsing { + use super::*; + + /// Trimmed verbatim from a captured billing.getPayments response + /// (external/requests/sites/kinovi.ai/2026-07-13-billing/). + const CAPTURED_PAGE: &str = r#"[{"result":{"data":{"json":{"payments":[ + {"id":"31722","amount":2159,"paymentStatus":"PAID","transactionId":"","paymentId":"","createdAt":"2026-07-13T20:40:49.405Z","updatedAt":"2026-07-13T20:40:49.405Z","productId":"","type":"ONE_TIME","creditsEarned":525000,"productName":"Credits Package"}, + {"id":"11491","amount":99.99,"paymentStatus":"PAID","transactionId":"202603141400154949180","paymentId":"202603141400154949180","createdAt":"2026-03-14T14:00:15.782Z","updatedAt":"2026-03-14T14:01:02.630Z","productId":"","type":"ONE_TIME","creditsEarned":22000,"productName":"Credits Package"} + ],"nextCursor":"29564","total":997}}}}]"#; + + #[test] + fn parses_captured_page() { + let page = parse_response_body(CAPTURED_PAGE).expect("parse"); + assert_eq!(page.payments.len(), 2); + assert_eq!(page.maybe_next_cursor.as_deref(), Some("29564")); + assert_eq!(page.total, 997); + + let first = &page.payments[0]; + assert_eq!(first.id, "31722"); + assert_eq!(first.amount_usd, 2159.0); + assert_eq!(first.status, BillingPaymentStatus::Paid); + assert_eq!(first.payment_type, BillingPaymentType::OneTime); + assert_eq!(first.credits_earned, 525_000); + assert!(first.created_at_utc.is_some()); + + let second = &page.payments[1]; + assert_eq!(second.amount_usd, 99.99); + assert_eq!(second.transaction_id, "202603141400154949180"); + } + + #[test] + fn last_page_has_no_next_cursor() { + let body = r#"[{"result":{"data":{"json":{"payments":[],"nextCursor":null,"total":997}}}}]"#; + let page = parse_response_body(body).expect("parse"); + assert!(page.payments.is_empty()); + assert_eq!(page.maybe_next_cursor, None); + } + + #[test] + fn unknown_status_and_type_are_preserved() { + let body = r#"[{"result":{"data":{"json":{"payments":[ + {"id":"1","amount":5,"paymentStatus":"REFUNDED","type":"SUBSCRIPTION","creditsEarned":0,"createdAt":"2026-07-13T20:40:49.405Z"} + ],"nextCursor":null,"total":1}}}}]"#; + let page = parse_response_body(body).expect("parse"); + assert_eq!(page.payments[0].status, BillingPaymentStatus::Unknown("REFUNDED".to_string())); + assert_eq!(page.payments[0].payment_type, BillingPaymentType::Unknown("SUBSCRIPTION".to_string())); + } + } + + mod live { + use super::*; + + #[tokio::test] + #[ignore] // manual test — requires real cookies + async fn live_fetch_first_payments_page() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let session = test_session()?; + + let page = get_billing_payments_history(GetBillingPaymentsHistoryArgs { + session: &session, + limit: DEFAULT_BILLING_PAGE_LIMIT, + offset: 0, + host_override: None, + }).await?; + + println!("payments: {}, total: {}, next_cursor: {:?}", + page.payments.len(), page.total, page.maybe_next_cursor); + for payment in &page.payments { + println!(" {} | {} | ${:.2} | {} credits | {:?} | {:?}", + payment.id, payment.created_at, payment.amount_usd, + payment.credits_earned, payment.status, payment.payment_type); + } + assert!(!page.payments.is_empty()); + Ok(()) + } + + /// Pages through the ENTIRE payments history with throttling and prints + /// lifetime totals. ~1,000 rows / 50 pages as of 2026-07. + /// cargo test -p seedance2pro_client live_paginate_entire_payments_history -- --ignored --nocapture + #[tokio::test] + #[ignore] // manual test — requires real cookies; fetches every page + async fn live_paginate_entire_payments_history() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let session = test_session()?; + + const PAGE_DELAY_MS: u64 = 250; + const MAX_PAGES: usize = 2_000; // runaway guard + + let mut offset: u64 = 0; + let mut pages = 0usize; + let mut total_rows = 0u64; + let mut total_amount_usd = 0f64; + let mut total_credits = 0u64; + let mut last_reported_total = 0u64; + + for _ in 0..MAX_PAGES { + let page = get_billing_payments_history(GetBillingPaymentsHistoryArgs { + session: &session, + limit: DEFAULT_BILLING_PAGE_LIMIT, + offset, + host_override: None, + }).await?; + + pages += 1; + last_reported_total = page.total; + if page.payments.is_empty() { + break; + } + + for payment in &page.payments { + total_rows += 1; + total_amount_usd += payment.amount_usd; + total_credits += payment.credits_earned; + } + + println!("page {} (offset {}): {} payments, running total ${:.2}", + pages, offset, page.payments.len(), total_amount_usd); + + // Advance by what was actually returned so a server-side limit cap + // can never skip rows. + offset += page.payments.len() as u64; + tokio::time::sleep(std::time::Duration::from_millis(PAGE_DELAY_MS)).await; + } + + println!("── payments history totals ──"); + println!("pages: {}", pages); + println!("payments: {} (server reports total {})", total_rows, last_reported_total); + println!("lifetime spend: ${:.2}", total_amount_usd); + println!("lifetime credits: {}", total_credits); + assert!(total_rows > 0); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/billing/get_credits_history.rs b/crates/api_clients/seedance2pro_client/src/billing/get_credits_history.rs new file mode 100644 index 00000000..1f3d22c3 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/billing/get_credits_history.rs @@ -0,0 +1,415 @@ +use chrono::{DateTime, Utc}; +use log::info; +use serde::Deserialize; +use wreq::Client; +use wreq_util::Emulation; + +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use crate::utils::number_coercion::{de_i64_int_or_float, de_u64_int_or_float}; + +/// Page size the kinovi.ai billing dashboard uses. +pub const DEFAULT_CREDITS_PAGE_LIMIT: u32 = 20; + +// --- Args & response --- + +pub struct GetCreditsHistoryArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// Page size. The web dashboard uses [`DEFAULT_CREDITS_PAGE_LIMIT`]. + pub limit: u32, + + /// Zero-based row offset. Pagination is offset-based: advance by the + /// number of entries actually returned until a page comes back empty. + /// NB: the ledger grows while you page (offsets shift under live traffic), + /// so dedupe by entry `id` when sweeping the full history. + pub offset: u64, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +pub struct CreditsHistoryPage { + /// Ledger entries on this page, newest first. + pub entries: Vec, + + /// Total ledger rows on the account, per the server. + pub total: u64, +} + +// --- Public types --- + +/// One row of the Kinovi credits ledger: a signed credit delta attributed to +/// a generation order (consumption) or a grant (purchase, registration bonus). +#[derive(Debug, Clone)] +pub struct CreditHistoryEntry { + pub id: u64, + + pub entry_type: CreditHistoryEntryType, + + /// Signed credit delta: negative for consumption, positive for grants. + pub credit_delta: i64, + + /// The generation order this entry bills, when applicable (`ord_...`). + /// `None` for grants (purchases, registration bonuses). + pub maybe_order_id: Option, + + /// e.g. "Seedance 2.0 Video", "Credit Package - xl (25000 credits)" + pub product_name: String, + + /// ISO 8601 creation timestamp (e.g. `"2026-07-14T00:31:12.820Z"`). + pub created_at: String, + + /// Parsed `created_at`. `None` if the raw string could not be parsed. + pub created_at_utc: Option>, +} + +/// Ledger entry type. Observed values are mapped; anything new (refunds, +/// failure credits, expirations, ...) lands in `Unknown` so deserialization +/// never breaks. +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum CreditHistoryEntryType { + /// Credits consumed by a successful generation (negative delta). + ConsumptionSuccess, + /// Credits granted by a package purchase (positive delta). + PurchasedCredits, + /// Sign-up bonus credits (positive delta). + NewUserRegistration, + Unknown(String), +} + +impl CreditHistoryEntryType { + pub fn as_str(&self) -> &str { + match self { + Self::ConsumptionSuccess => "CONSUMPTION_SUCCESS", + Self::PurchasedCredits => "PURCHASED_CREDITS", + Self::NewUserRegistration => "NEW_USER_REGISTRATION", + Self::Unknown(other) => other.as_str(), + } + } + + fn from_str(s: &str) -> Self { + match s { + "CONSUMPTION_SUCCESS" => Self::ConsumptionSuccess, + "PURCHASED_CREDITS" => Self::PurchasedCredits, + "NEW_USER_REGISTRATION" => Self::NewUserRegistration, + other => Self::Unknown(other.to_string()), + } + } +} + +// --- Implementation --- + +pub async fn get_credits_history( + args: GetCreditsHistoryArgs<'_>, +) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let url = format!("{}/api/trpc/credits.getCreditHistory", base_url); + + info!("Fetching credits history (limit: {}, offset: {})...", args.limit, args.offset); + + let input_json = build_input_json(args.limit, args.offset); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/app/dashboard/billing", base_url); + + let request = client.get(&url) + .query(&[("batch", "1"), ("input", input_json.as_str())]) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("content-type", "application/json") + .header("x-trpc-source", "client") + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.execute(request) + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Credits history response status: {}", status); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + parse_response_body(&response_body) +} + +fn parse_response_body(response_body: &str) -> Result { + let batch_response: Vec = serde_json::from_str(response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.to_string()))?; + + let json = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.to_string(), + })? + .result + .data + .json; + + let entries = json.credits + .into_iter() + .map(|entry| { + let created_at_utc = DateTime::parse_from_rfc3339(&entry.created_at) + .map(|dt| dt.with_timezone(&Utc)) + .ok(); + CreditHistoryEntry { + id: entry.id, + entry_type: CreditHistoryEntryType::from_str(&entry.entry_type), + credit_delta: entry.credit, + maybe_order_id: entry.order_id, + product_name: entry.product_name, + created_at: entry.created_at, + created_at_utc, + } + }) + .collect(); + + Ok(CreditsHistoryPage { + entries, + total: json.total, + }) +} + +/// Builds the tRPC `input` JSON for the credits.getCreditHistory endpoint. +fn build_input_json(limit: u32, offset: u64) -> String { + format!(r#"{{"0":{{"json":{{"limit":{limit},"offset":{offset}}}}}}}"#) +} + +// --- Raw response types --- + +#[derive(Deserialize, Debug)] +struct BatchResponseItem { + result: RawResult, +} + +#[derive(Deserialize, Debug)] +struct RawResult { + data: RawData, +} + +#[derive(Deserialize, Debug)] +struct RawData { + json: RawJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +struct RawJson { + credits: Vec, + #[serde(deserialize_with = "de_u64_int_or_float")] + total: u64, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +struct RawCreditEntry { + #[serde(deserialize_with = "de_u64_int_or_float")] + id: u64, + #[serde(rename = "type")] + entry_type: String, + #[serde(deserialize_with = "de_i64_int_or_float")] + credit: i64, + #[serde(default)] + order_id: Option, + created_at: String, + #[serde(default)] + product_name: String, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + mod offline_parsing { + use super::*; + + /// Trimmed verbatim from a captured credits.getCreditHistory response + /// (external/requests/sites/kinovi.ai/2026-07-13-billing/). + const CAPTURED_PAGE: &str = r#"[{"result":{"data":{"json":{"credits":[ + {"id":2750659,"type":"CONSUMPTION_SUCCESS","credit":-454,"orderId":"ord_mff2cjk2feczmzqweizcdal2","createdAt":"2026-07-14T00:31:12.820Z","productName":"Seedance 2.0 Video"}, + {"id":591799,"type":"PURCHASED_CREDITS","credit":25000,"orderId":null,"createdAt":"2026-02-19T08:16:58.524Z","productName":"Credit Package - xl (25000 credits)"}, + {"id":563856,"type":"NEW_USER_REGISTRATION","credit":200,"orderId":null,"createdAt":"2026-02-18T01:02:52.747Z","productName":"unknown"} + ],"total":304617}}}}]"#; + + #[test] + fn parses_captured_page() { + let page = parse_response_body(CAPTURED_PAGE).expect("parse"); + assert_eq!(page.entries.len(), 3); + assert_eq!(page.total, 304_617); + + let consumption = &page.entries[0]; + assert_eq!(consumption.id, 2_750_659); + assert_eq!(consumption.entry_type, CreditHistoryEntryType::ConsumptionSuccess); + assert_eq!(consumption.credit_delta, -454); + assert_eq!(consumption.maybe_order_id.as_deref(), Some("ord_mff2cjk2feczmzqweizcdal2")); + assert!(consumption.created_at_utc.is_some()); + + let purchase = &page.entries[1]; + assert_eq!(purchase.entry_type, CreditHistoryEntryType::PurchasedCredits); + assert_eq!(purchase.credit_delta, 25_000); + assert_eq!(purchase.maybe_order_id, None); + + let registration = &page.entries[2]; + assert_eq!(registration.entry_type, CreditHistoryEntryType::NewUserRegistration); + assert_eq!(registration.credit_delta, 200); + } + + #[test] + fn unknown_entry_type_is_preserved() { + let body = r#"[{"result":{"data":{"json":{"credits":[ + {"id":1,"type":"CONSUMPTION_REFUND","credit":454,"orderId":"ord_x","createdAt":"2026-07-14T00:31:12.820Z","productName":"Seedance 2.0 Video"} + ],"total":1}}}}]"#; + let page = parse_response_body(body).expect("parse"); + assert_eq!( + page.entries[0].entry_type, + CreditHistoryEntryType::Unknown("CONSUMPTION_REFUND".to_string()), + ); + assert_eq!(page.entries[0].credit_delta, 454); + } + + #[test] + fn entry_type_round_trips_as_str() { + for raw in ["CONSUMPTION_SUCCESS", "PURCHASED_CREDITS", "NEW_USER_REGISTRATION", "SOMETHING_NEW"] { + assert_eq!(CreditHistoryEntryType::from_str(raw).as_str(), raw); + } + } + } + + mod live { + use super::*; + use std::collections::HashMap; + use std::collections::HashSet; + + #[tokio::test] + #[ignore] // manual test — requires real cookies + async fn live_fetch_first_credits_page() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let session = test_session()?; + + let page = get_credits_history(GetCreditsHistoryArgs { + session: &session, + limit: DEFAULT_CREDITS_PAGE_LIMIT, + offset: 0, + host_override: None, + }).await?; + + println!("entries: {}, total: {}", page.entries.len(), page.total); + for entry in &page.entries { + println!(" {} | {} | {:?} | {} | {:?}", + entry.id, entry.created_at, entry.entry_type, entry.credit_delta, + entry.maybe_order_id); + } + assert!(!page.entries.is_empty()); + Ok(()) + } + + /// Pages through the ENTIRE credits ledger with throttling and prints + /// per-type tallies (this is where any refund-like entry types will + /// surface). ~300k rows as of 2026-07 — expect a long run; the ledger + /// also grows while paging, so entries are deduped by id. + /// cargo test -p seedance2pro_client live_paginate_entire_credits_history -- --ignored --nocapture + #[tokio::test] + #[ignore] // manual test — requires real cookies; fetches every page + async fn live_paginate_entire_credits_history() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + let session = test_session()?; + + const PAGE_LIMIT: u32 = 100; + const PAGE_DELAY_MS: u64 = 250; + const MAX_PAGES: usize = 50_000; // runaway guard + + let mut offset: u64 = 0; + let mut pages = 0usize; + let mut seen_ids: HashSet = HashSet::new(); + let mut type_counts: HashMap = HashMap::new(); + let mut last_reported_total = 0u64; + + for _ in 0..MAX_PAGES { + let page = get_credits_history(GetCreditsHistoryArgs { + session: &session, + limit: PAGE_LIMIT, + offset, + host_override: None, + }).await?; + + pages += 1; + last_reported_total = page.total; + if page.entries.is_empty() { + break; + } + + for entry in &page.entries { + if !seen_ids.insert(entry.id) { + continue; // offset shifted under live traffic; already counted + } + let tally = type_counts.entry(entry.entry_type.clone()).or_insert((0, 0)); + tally.0 += 1; + tally.1 += entry.credit_delta; + } + + if pages % 25 == 0 { + println!("page {} (offset {}): {} unique entries so far (server total {})", + pages, offset, seen_ids.len(), page.total); + } + + // Advance by what was actually returned so a server-side limit cap + // can never skip rows. + offset += page.entries.len() as u64; + tokio::time::sleep(std::time::Duration::from_millis(PAGE_DELAY_MS)).await; + } + + println!("── credits ledger totals ──"); + println!("pages: {}", pages); + println!("unique entries: {} (server reports total {})", seen_ids.len(), last_reported_total); + let mut types: Vec<_> = type_counts.iter().collect(); + types.sort_by_key(|(_, (count, _))| std::cmp::Reverse(*count)); + for (entry_type, (count, delta_sum)) in types { + println!(" {:<28} n={:<8} credit_sum={}", entry_type.as_str(), count, delta_sum); + } + assert!(!seen_ids.is_empty()); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/billing/mod.rs b/crates/api_clients/seedance2pro_client/src/billing/mod.rs new file mode 100644 index 00000000..fb75bf5b --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/billing/mod.rs @@ -0,0 +1,2 @@ +pub mod get_billing_payments_history; +pub mod get_credits_history; diff --git a/crates/api_clients/seedance2pro_client/src/cost/constants.rs b/crates/api_clients/seedance2pro_client/src/cost/constants.rs new file mode 100644 index 00000000..da460867 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/cost/constants.rs @@ -0,0 +1,9 @@ +/// Kinovi credits per US dollar. +/// +/// Current package: 525,000 credits for $2,159.0909 (~243.16 credits/$1, +/// rounded down to 243). +/// +/// Historical packages, for reference: +/// - 500,000 credits for $2,159.09 (~231.58 credits/$1, rounded down to 231) +/// - 22,000 credits for $114 (~192.98 credits/$1, rounded to 193) +pub const CREDITS_PER_DOLLAR: u64 = 243; diff --git a/crates/api_clients/seedance2pro_client/src/cost/kinovi_fractional_generation_cost.rs b/crates/api_clients/seedance2pro_client/src/cost/kinovi_fractional_generation_cost.rs new file mode 100644 index 00000000..964b44eb --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/cost/kinovi_fractional_generation_cost.rs @@ -0,0 +1,85 @@ +use crate::cost::constants::CREDITS_PER_DOLLAR; + +/// The cost of a Kinovi generation that bills FRACTIONAL credits, in both +/// native credits and USD cents. +/// +/// This is the fractional-credit counterpart of +/// [`crate::cost::kinovi_generation_cost::KinoviGenerationCost`] (which uses +/// `u64`). Some Kinovi models bill non-integer credits — e.g. Seedance 2.0 +/// Mini at 480p bills 7.5 credits/sec, landing on half-credits like 37.5 at +/// odd durations. Any model with a fractional credit rate uses this type; +/// whole-credit models use the cheaper `u64` `KinoviGenerationCost`. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct KinoviFractionalGenerationCost { + /// The cost of the generation in Kinovi credits. May be fractional (e.g. + /// 37.5 for Seedance 2.0 Mini 480p at 5 seconds). + pub kinovi_credits: f64, + + /// Estimated cost in cents, rounded up to the nearest whole cent. + /// This does not account for discounts, prorations, etc. + pub usd_cents_rounded_up: u64, + + /// Estimated cost in cents, rounded down to the nearest whole cent. + pub usd_cents_rounded_down: u64, + + /// Estimated cost in cents without rounding (the exact fractional value). + pub usd_cents_fractional: f64, +} + +impl KinoviFractionalGenerationCost { + /// Build a cost from a (possibly fractional) Kinovi credit amount, deriving + /// the USD cents via the credit-package rate. + /// + /// The conversion is done on integer hundredths-of-a-credit, so the integer + /// cent results are exact (no floating-point drift). Credit amounts are + /// rounded to the nearest hundredth of a credit, which covers every Kinovi + /// rate seen so far (e.g. Mini's half-credits). + pub fn from_kinovi_credits(kinovi_credits: f64) -> Self { + // usd_cents == credits × 100 / CREDITS_PER_DOLLAR == hundredths / CREDITS_PER_DOLLAR. + let hundredths_of_credit = (kinovi_credits * 100.0).round() as u64; + Self { + kinovi_credits, + usd_cents_rounded_up: hundredths_of_credit.div_ceil(CREDITS_PER_DOLLAR), + usd_cents_rounded_down: hundredths_of_credit / CREDITS_PER_DOLLAR, + usd_cents_fractional: hundredths_of_credit as f64 / CREDITS_PER_DOLLAR as f64, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const FLOAT_TOLERANCE: f64 = 1e-9; + + #[test] + fn fractional_credits_convert_to_usd() { + // 37.5 credits; 3750/243 = 15.4320 cents. + let cost = KinoviFractionalGenerationCost::from_kinovi_credits(37.5); + assert_eq!(cost.kinovi_credits, 37.5); + assert_eq!(cost.usd_cents_rounded_up, 16); + assert_eq!(cost.usd_cents_rounded_down, 15); + assert!((cost.usd_cents_fractional - (3750.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn whole_credits_convert_to_usd() { + // 100 credits; 10000/243 = 41.1522 cents. + let cost = KinoviFractionalGenerationCost::from_kinovi_credits(100.0); + assert_eq!(cost.kinovi_credits, 100.0); + assert_eq!(cost.usd_cents_rounded_up, 42); + assert_eq!(cost.usd_cents_rounded_down, 41); + assert!((cost.usd_cents_fractional - (10000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn rounded_bounds_bracket_the_fractional_value() { + for half_credits in [0u64, 1, 15, 75, 95, 200, 225, 600, 720] { + let credits = half_credits as f64 / 2.0; + let cost = KinoviFractionalGenerationCost::from_kinovi_credits(credits); + assert!(cost.usd_cents_rounded_down as f64 <= cost.usd_cents_fractional); + assert!(cost.usd_cents_fractional <= cost.usd_cents_rounded_up as f64); + assert!(cost.usd_cents_rounded_up - cost.usd_cents_rounded_down <= 1); + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/cost/kinovi_generation_cost.rs b/crates/api_clients/seedance2pro_client/src/cost/kinovi_generation_cost.rs new file mode 100644 index 00000000..a8c3b07d --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/cost/kinovi_generation_cost.rs @@ -0,0 +1,90 @@ +use crate::cost::constants::CREDITS_PER_DOLLAR; + +/// The cost of a Kinovi generation, in both native credits and USD cents. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct KinoviGenerationCost { + /// The cost of the generation in Kinovi credits. + pub kinovi_credits: u64, + + /// Estimated cost in cents, rounded up to the nearest whole cent. + /// This does not account for discounts, prorations, etc. + /// This is always rounded up when fractional. + pub usd_cents_rounded_up: u64, + + /// Estimated cost in cents, rounded down to the nearest whole cent. + pub usd_cents_rounded_down: u64, + + /// Estimated cost in cents without rounding (the exact fractional value). + pub usd_cents_fractional: f64, +} + +impl KinoviGenerationCost { + /// Build a cost from a Kinovi credit amount, deriving the USD cents via + /// the credit-package rate. + pub fn from_kinovi_credits(kinovi_credits: u64) -> Self { + let total_hundredths = kinovi_credits * 100; + Self { + kinovi_credits, + // Integer ceiling / floor of (credits * 100 / CREDITS_PER_DOLLAR). + usd_cents_rounded_up: total_hundredths.div_ceil(CREDITS_PER_DOLLAR), + usd_cents_rounded_down: total_hundredths / CREDITS_PER_DOLLAR, + usd_cents_fractional: total_hundredths as f64 / CREDITS_PER_DOLLAR as f64, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const FLOAT_TOLERANCE: f64 = 1e-9; + + #[test] + fn zero_credits_is_zero_cents() { + let cost = KinoviGenerationCost::from_kinovi_credits(0); + assert_eq!(cost.kinovi_credits, 0); + assert_eq!(cost.usd_cents_rounded_up, 0); + assert_eq!(cost.usd_cents_rounded_down, 0); + assert!((cost.usd_cents_fractional - 0.0).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn exact_dollar_boundaries_do_not_round() { + // 243 credits = exactly $1.00 — all three representations agree. + let cost = KinoviGenerationCost::from_kinovi_credits(243); + assert_eq!(cost.kinovi_credits, 243); + assert_eq!(cost.usd_cents_rounded_up, 100); + assert_eq!(cost.usd_cents_rounded_down, 100); + assert!((cost.usd_cents_fractional - 100.0).abs() < FLOAT_TOLERANCE); + + let cost = KinoviGenerationCost::from_kinovi_credits(486); + assert_eq!(cost.usd_cents_rounded_up, 200); + assert_eq!(cost.usd_cents_rounded_down, 200); + assert!((cost.usd_cents_fractional - 200.0).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn fractional_cents_round_in_both_directions() { + // 244 credits = 100.411... cents. + let cost = KinoviGenerationCost::from_kinovi_credits(244); + assert_eq!(cost.usd_cents_rounded_up, 101); + assert_eq!(cost.usd_cents_rounded_down, 100); + assert!((cost.usd_cents_fractional - (24400.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // 1 credit = 0.432... cents. + let cost = KinoviGenerationCost::from_kinovi_credits(1); + assert_eq!(cost.usd_cents_rounded_up, 1); + assert_eq!(cost.usd_cents_rounded_down, 0); + assert!((cost.usd_cents_fractional - (100.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn rounded_bounds_bracket_the_fractional_value() { + for credits in [0, 1, 12, 75, 200, 243, 244, 450, 1350] { + let cost = KinoviGenerationCost::from_kinovi_credits(credits); + assert!(cost.usd_cents_rounded_down as f64 <= cost.usd_cents_fractional); + assert!(cost.usd_cents_fractional <= cost.usd_cents_rounded_up as f64); + assert!(cost.usd_cents_rounded_up - cost.usd_cents_rounded_down <= 1); + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/cost/kinovi_seedance_generation_cost.rs b/crates/api_clients/seedance2pro_client/src/cost/kinovi_seedance_generation_cost.rs new file mode 100644 index 00000000..d6cd31a0 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/cost/kinovi_seedance_generation_cost.rs @@ -0,0 +1,116 @@ +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; + +/// The cost of a Kinovi Seedance generation, with the video-reference +/// surcharge broken out from the base price. +/// +/// Used by the WHOLE-credit Seedance video models (regular + Fast). Seedance +/// 2.0 Mini bills fractional credits and has its own `f64` twin, +/// [`crate::cost::kinovi_seedance_mini_generation_cost::KinoviSeedanceMiniGenerationCost`] +/// — see that file for why they aren't merged. +/// +/// `total_cost` covers base + surcharge. NB: the total's USD conversions are +/// computed from the SUMMED credits (rounded once), so they may differ by a +/// cent from adding the parts' rounded USD values together. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct KinoviSeedanceGenerationCost { + /// The full cost (base + any surcharge), in credits and USD cents. + pub total_cost: KinoviGenerationCost, + + /// The base generation cost (resolution rate × output duration × batch + /// count), excluding any surcharges. + pub base_cost: KinoviGenerationCost, + + /// The video-reference surcharge, when one or more reference videos are + /// attached. `None` when no reference videos are attached. + pub video_reference_surcharge_cost: Option, +} + +impl KinoviSeedanceGenerationCost { + /// Build a cost from base credits plus an optional video-reference + /// surcharge (both in Kinovi credits). The per-part and total USD + /// conversions are derived. + pub fn from_base_and_surcharge( + base_credits: u64, + maybe_video_reference_surcharge_credits: Option, + ) -> Self { + let total_credits = base_credits + maybe_video_reference_surcharge_credits.unwrap_or(0); + Self { + total_cost: KinoviGenerationCost::from_kinovi_credits(total_credits), + base_cost: KinoviGenerationCost::from_kinovi_credits(base_credits), + video_reference_surcharge_cost: maybe_video_reference_surcharge_credits + .map(KinoviGenerationCost::from_kinovi_credits), + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const FLOAT_TOLERANCE: f64 = 1e-9; + + #[test] + fn without_surcharge() { + let cost = KinoviSeedanceGenerationCost::from_base_and_surcharge(200, None); + + assert!(cost.video_reference_surcharge_cost.is_none()); + + // Base: 200 credits; 20000/243 = 82.30. + assert_eq!(cost.base_cost.kinovi_credits, 200); + assert_eq!(cost.base_cost.usd_cents_rounded_up, 83); + assert_eq!(cost.base_cost.usd_cents_rounded_down, 82); + assert!((cost.base_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total equals base when there's no surcharge. + assert_eq!(cost.total_cost, cost.base_cost); + } + + #[test] + fn with_surcharge() { + let cost = KinoviSeedanceGenerationCost::from_base_and_surcharge(200, Some(40)); + + // Base: 200 credits; 20000/243 = 82.30. + assert_eq!(cost.base_cost.kinovi_credits, 200); + assert_eq!(cost.base_cost.usd_cents_rounded_up, 83); + assert_eq!(cost.base_cost.usd_cents_rounded_down, 82); + assert!((cost.base_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Surcharge: 40 credits; 4000/243 = 16.46. + let surcharge = cost.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 40); + assert_eq!(surcharge.usd_cents_rounded_up, 17); + assert_eq!(surcharge.usd_cents_rounded_down, 16); + assert!((surcharge.usd_cents_fractional - (4000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total: 240 credits; 24000/243 = 98.77. + assert_eq!(cost.total_cost.kinovi_credits, 240); + assert_eq!(cost.total_cost.usd_cents_rounded_up, 99); + assert_eq!(cost.total_cost.usd_cents_rounded_down, 98); + assert!((cost.total_cost.usd_cents_fractional - (24000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn total_credits_are_base_plus_surcharge() { + let cost = KinoviSeedanceGenerationCost::from_base_and_surcharge(450, Some(90)); + assert_eq!( + cost.total_cost.kinovi_credits, + cost.base_cost.kinovi_credits + cost.video_reference_surcharge_cost.unwrap().kinovi_credits); + } + + /// The total's USD is rounded ONCE on the summed credits, so it can be a + /// cent under the sum of the parts' rounded-up values. + #[test] + fn total_usd_is_rounded_once_not_per_part() { + let cost = KinoviSeedanceGenerationCost::from_base_and_surcharge(200, Some(40)); + let surcharge = cost.video_reference_surcharge_cost.unwrap(); + + // Parts round up to 83 + 17 = 100, but the total (240 credits) rounds + // once to 99 — one cent less than summing the rounded parts. + assert_eq!(cost.base_cost.usd_cents_rounded_up + surcharge.usd_cents_rounded_up, 100); + assert_eq!(cost.total_cost.usd_cents_rounded_up, 99); + + // …but the fractional parts always sum exactly to the fractional total. + let parts = cost.base_cost.usd_cents_fractional + surcharge.usd_cents_fractional; + assert!((parts - cost.total_cost.usd_cents_fractional).abs() < FLOAT_TOLERANCE); + } +} diff --git a/crates/api_clients/seedance2pro_client/src/cost/kinovi_seedance_mini_generation_cost.rs b/crates/api_clients/seedance2pro_client/src/cost/kinovi_seedance_mini_generation_cost.rs new file mode 100644 index 00000000..268467b7 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/cost/kinovi_seedance_mini_generation_cost.rs @@ -0,0 +1,91 @@ +use crate::cost::kinovi_fractional_generation_cost::KinoviFractionalGenerationCost; + +// ───────────────────────────────────────────────────────────────────────────── +// WHY THIS TYPE EXISTS (don't merge it into KinoviSeedanceGenerationCost): +// +// This is the Mini twin of `KinoviSeedanceGenerationCost`. It is structurally +// identical (base + optional video-reference surcharge = total) and prices the +// SAME way conceptually — but its credits are fractional +// (`KinoviFractionalGenerationCost`, `f64`) rather than whole +// (`KinoviGenerationCost`, `u64`). +// +// Seedance 2.0 Mini at 480p bills 7.5 credits/sec, so odd durations land on +// FRACTIONAL credits (5s = 37.5, 15s = 112.5). Every OTHER whole-credit +// Seedance video model uses `KinoviSeedanceGenerationCost` (u64 credits). +// +// Making the shared `u64` credit type fractional would ripple `f64` through all +// of those whole-credit models AND `artcraft_router` (which stores credits as +// `u64`), forcing hundreds of integer-literal edits for one model's benefit. +// Keeping Mini's fractional credits in their own small type is the cheaper, +// better-isolated choice. The inner `KinoviFractionalGenerationCost` is generic +// (not Mini-specific) — other fractional-credit models can reuse it. +// ───────────────────────────────────────────────────────────────────────────── + +/// The cost of a Kinovi Seedance 2.0 Mini generation, with the video-reference +/// surcharge broken out from the base price. +/// +/// Mirrors [`crate::cost::kinovi_seedance_generation_cost::KinoviSeedanceGenerationCost`], +/// but with FRACTIONAL credits (see the module note above). +/// +/// `total_cost` covers base + surcharge. NB: the total's USD conversions are +/// computed from the SUMMED credits (rounded once), so they may differ by a +/// cent from adding the parts' rounded USD values together. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct KinoviSeedanceMiniGenerationCost { + /// The full cost (base + any surcharge), in credits and USD cents. + pub total_cost: KinoviFractionalGenerationCost, + + /// The base generation cost (resolution rate × output duration × batch + /// count), excluding any surcharges. + pub base_cost: KinoviFractionalGenerationCost, + + /// The video-reference surcharge, when one or more reference videos are + /// attached. `None` when no reference videos are attached. + pub video_reference_surcharge_cost: Option, +} + +impl KinoviSeedanceMiniGenerationCost { + /// Build a cost from base credits plus an optional video-reference + /// surcharge (both in Kinovi credits, possibly fractional). The per-part + /// and total USD conversions are derived. + pub fn from_base_and_surcharge( + base_credits: f64, + maybe_video_reference_surcharge_credits: Option, + ) -> Self { + let total_credits = base_credits + maybe_video_reference_surcharge_credits.unwrap_or(0.0); + Self { + total_cost: KinoviFractionalGenerationCost::from_kinovi_credits(total_credits), + base_cost: KinoviFractionalGenerationCost::from_kinovi_credits(base_credits), + video_reference_surcharge_cost: maybe_video_reference_surcharge_credits + .map(KinoviFractionalGenerationCost::from_kinovi_credits), + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn without_surcharge_total_equals_base() { + let cost = KinoviSeedanceMiniGenerationCost::from_base_and_surcharge(37.5, None); + assert!(cost.video_reference_surcharge_cost.is_none()); + assert_eq!(cost.base_cost.kinovi_credits, 37.5); + assert_eq!(cost.total_cost, cost.base_cost); + } + + #[test] + fn with_surcharge_sums_into_total() { + // 480p 5s with video ref: 37.5 base + 10 surcharge = 47.5 total. + let cost = KinoviSeedanceMiniGenerationCost::from_base_and_surcharge(37.5, Some(10.0)); + assert_eq!(cost.base_cost.kinovi_credits, 37.5); + assert_eq!( + cost.video_reference_surcharge_cost.map(|c| c.kinovi_credits), + Some(10.0), + ); + assert_eq!(cost.total_cost.kinovi_credits, 47.5); + // 47.5 credits; 4750/243 = 19.5473 → 20¢. + assert_eq!(cost.total_cost.usd_cents_rounded_up, 20); + assert_eq!(cost.total_cost.usd_cents_rounded_down, 19); + } +} diff --git a/crates/api_clients/seedance2pro_client/src/cost/mod.rs b/crates/api_clients/seedance2pro_client/src/cost/mod.rs new file mode 100644 index 00000000..541ebcd1 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/cost/mod.rs @@ -0,0 +1,5 @@ +pub mod constants; +pub mod kinovi_fractional_generation_cost; +pub mod kinovi_generation_cost; +pub mod kinovi_seedance_generation_cost; +pub mod kinovi_seedance_mini_generation_cost; diff --git a/crates/api_clients/seedance2pro_client/src/creds/mod.rs b/crates/api_clients/seedance2pro_client/src/creds/mod.rs new file mode 100644 index 00000000..bd0abf85 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/creds/mod.rs @@ -0,0 +1,2 @@ +pub mod seedance2pro_cookies; +pub mod seedance2pro_session; diff --git a/crates/api_clients/seedance2pro_client/src/creds/seedance2pro_cookies.rs b/crates/api_clients/seedance2pro_client/src/creds/seedance2pro_cookies.rs new file mode 100644 index 00000000..005456ae --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/creds/seedance2pro_cookies.rs @@ -0,0 +1,24 @@ +/// Cookies are the credential required to interact with the Seedance2 Pro API. + +#[derive(Clone)] +pub struct Seedance2ProCookies { + cookies: String, +} + +impl Seedance2ProCookies { + pub fn new(cookies: String) -> Self { + Seedance2ProCookies { cookies } + } + + pub fn as_str(&self) -> &str { + &self.cookies + } + + pub fn as_bytes(&self) -> &[u8] { + self.cookies.as_bytes() + } + + pub fn to_string(&self) -> String { + self.cookies.clone() + } +} diff --git a/crates/api_clients/seedance2pro_client/src/creds/seedance2pro_session.rs b/crates/api_clients/seedance2pro_client/src/creds/seedance2pro_session.rs new file mode 100644 index 00000000..f418414d --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/creds/seedance2pro_session.rs @@ -0,0 +1,19 @@ +use crate::creds::seedance2pro_cookies::Seedance2ProCookies; + +/// Holds the full session data needed to make authenticated requests to Seedance2 Pro. +#[derive(Clone)] +pub struct Seedance2ProSession { + pub cookies: Seedance2ProCookies, +} + +impl Seedance2ProSession { + pub fn new(cookies: Seedance2ProCookies) -> Self { + Seedance2ProSession { cookies } + } + + pub fn from_cookies_string(cookies: String) -> Self { + Seedance2ProSession { + cookies: Seedance2ProCookies::new(cookies), + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/error/mod.rs b/crates/api_clients/seedance2pro_client/src/error/mod.rs new file mode 100644 index 00000000..9ae37a80 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/error/mod.rs @@ -0,0 +1,5 @@ +pub mod seedance2pro_bad_request_api_error; +pub mod seedance2pro_client_error; +pub mod seedance2pro_error; +pub mod seedance2pro_generic_api_error; +pub mod seedance2pro_specific_api_error; diff --git a/crates/api_clients/seedance2pro_client/src/error/seedance2pro_bad_request_api_error.rs b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_bad_request_api_error.rs new file mode 100644 index 00000000..eb816ef9 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_bad_request_api_error.rs @@ -0,0 +1,29 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// These represent known "400s" that are the fault of the client sending a bad request. +#[derive(Debug)] +pub enum Seedance2ProBadRequestApiError { + /// The video generation request was flagged as a content violation. + VideoGenerationViolation { raw_body: String }, + + /// The prompt exceeded Kinovi's maximum length (10,000 characters at the + /// time of writing). + PromptIsTooLong { raw_body: String }, + + /// Too many media URLs were attached to the request (`uploadedUrls` is + /// capped at 9 elements at the time of writing). + TooManyUrls { raw_body: String }, +} + +impl Error for Seedance2ProBadRequestApiError {} + +impl Display for Seedance2ProBadRequestApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::VideoGenerationViolation { raw_body } => write!(f, "Video generation violation: {}", raw_body), + Self::PromptIsTooLong { raw_body } => write!(f, "Prompt is too long: {}", raw_body), + Self::TooManyUrls { raw_body } => write!(f, "Too many urls: {}", raw_body), + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/error/seedance2pro_client_error.rs b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_client_error.rs new file mode 100644 index 00000000..fab71452 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_client_error.rs @@ -0,0 +1,33 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum Seedance2ProClientError { + /// No cookies are present in the session. + NoCookiesPresent, + + /// Error parsing a URL. + UrlParseError(url::ParseError), + + /// An error was encountered in building the Wreq client. + WreqClientError(wreq::Error), + + /// A request field couldn't be parsed into the value expected on the wire. + /// Carries the field name and the raw input the caller supplied. + InvalidRequestField { field: &'static str, raw_value: String, reason: String }, +} + +impl Error for Seedance2ProClientError {} + +impl Display for Seedance2ProClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::NoCookiesPresent => write!(f, "No cookies present in the session."), + Self::UrlParseError(err) => write!(f, "URL parse error: {}", err), + Self::WreqClientError(err) => write!(f, "Wreq client error (during client creation): {}", err), + Self::InvalidRequestField { field, raw_value, reason } => { + write!(f, "Invalid value for request field `{}`: {:?} ({})", field, raw_value, reason) + } + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/error/seedance2pro_error.rs b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_error.rs new file mode 100644 index 00000000..77565579 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_error.rs @@ -0,0 +1,70 @@ +use crate::error::seedance2pro_bad_request_api_error::Seedance2ProBadRequestApiError; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::error::seedance2pro_specific_api_error::Seedance2ProSpecificApiError; +use cloudflare_errors::cloudflare_error::CloudflareError; +use std::error::Error; + +#[derive(Debug)] +pub enum Seedance2ProError { + Client(Seedance2ProClientError), + ApiSpecific(Seedance2ProSpecificApiError), + ApiGeneric(Seedance2ProGenericApiError), + ApiBadRequest(Seedance2ProBadRequestApiError), +} + +impl Seedance2ProError { + pub fn is_having_downtime_issues(&self) -> bool { + match self { + Self::ApiGeneric(Seedance2ProGenericApiError::CloudflareError(CloudflareError::BadGateway502)) => true, + Self::ApiGeneric(Seedance2ProGenericApiError::CloudflareError(CloudflareError::GatewayTimeout504)) => true, + Self::ApiGeneric(Seedance2ProGenericApiError::CloudflareError(CloudflareError::TimeoutOccurred524)) => true, + Self::ApiGeneric(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { status_code, body: _ }) => { + match status_code.as_u16() { + 502 => true, + 504 => true, + 524 => true, + _ => false, + } + }, + _ => false, + } + } +} + +impl Error for Seedance2ProError {} + +impl std::fmt::Display for Seedance2ProError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Client(e) => write!(f, "Seedance2ProClientError: {:?}", e), + Self::ApiSpecific(e) => write!(f, "Seedance2ProSpecificApiError: {:?}", e), + Self::ApiGeneric(e) => write!(f, "Seedance2ProGenericApiError: {:?}", e), + Self::ApiBadRequest(e) => write!(f, "Seedance2ProBadRequestApiError: {:?}", e), + } + } +} + +impl From for Seedance2ProError { + fn from(error: Seedance2ProClientError) -> Self { + Self::Client(error) + } +} + +impl From for Seedance2ProError { + fn from(error: Seedance2ProSpecificApiError) -> Self { + Self::ApiSpecific(error) + } +} + +impl From for Seedance2ProError { + fn from(error: Seedance2ProGenericApiError) -> Self { + Self::ApiGeneric(error) + } +} + +impl From for Seedance2ProError { + fn from(error: Seedance2ProBadRequestApiError) -> Self { + Self::ApiBadRequest(error) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/error/seedance2pro_generic_api_error.rs b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_generic_api_error.rs new file mode 100644 index 00000000..d0a7d1f6 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_generic_api_error.rs @@ -0,0 +1,49 @@ +use cloudflare_errors::cloudflare_error::CloudflareError; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use wreq::StatusCode; + +#[derive(Debug)] +pub enum Seedance2ProGenericApiError { + /// Specific Cloudflare errors. + CloudflareError(CloudflareError), + + /// serde_json::Error, likely from JSON deserialization schema mismatch. + /// Includes the original body. + SerdeResponseParseErrorWithBody(serde_json::Error, String), + + /// serde_json::Error on a non-200 (error) response. + /// Includes the original body. + SerdeParseErrorWithBodyOnNon200(serde_json::Error, String), + + /// A response that parsed, but didn't have the shape we expected + /// (eg. an empty batch response array). + UnexpectedResponseShape { + explanation: String, + raw_body: String, + }, + + /// An uncategorized bad HTTP response with status code and body. + UncategorizedBadResponseWithStatusAndBody { + status_code: StatusCode, + body: String, + }, + + /// An uncaught error from the HTTP client. + WreqError(wreq::Error), +} + +impl Error for Seedance2ProGenericApiError {} + +impl Display for Seedance2ProGenericApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::CloudflareError(err) => write!(f, "Cloudflare error: {}", err), + Self::SerdeResponseParseErrorWithBody(err, body) => write!(f, "Failed to parse response body: {:?}. Body: {}", err, body), + Self::SerdeParseErrorWithBodyOnNon200(err, body) => write!(f, "Failed to parse non-200 response body: {:?}. Body: {}", err, body), + Self::UnexpectedResponseShape { explanation, raw_body } => write!(f, "Unexpected response shape: {}. Body: {}", explanation, raw_body), + Self::UncategorizedBadResponseWithStatusAndBody { status_code, body } => write!(f, "Uncategorized bad response: status code {}, body: {}", status_code, body), + Self::WreqError(err) => write!(f, "Wreq client error: {}", err), + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/error/seedance2pro_specific_api_error.rs b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_specific_api_error.rs new file mode 100644 index 00000000..c3c38ce7 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/error/seedance2pro_specific_api_error.rs @@ -0,0 +1,27 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +use wreq::StatusCode; + +#[derive(Debug)] +pub enum Seedance2ProSpecificApiError { + /// The session cookies are expired or invalid. + UnauthorizedSessionExpired, + + /// The account does not have enough credits to perform the operation. + BillingError { + status_code: StatusCode, + body: String, + }, +} + +impl Error for Seedance2ProSpecificApiError {} + +impl Display for Seedance2ProSpecificApiError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::UnauthorizedSessionExpired => write!(f, "Unauthorized: session cookies expired or invalid."), + Self::BillingError { status_code, body } => write!(f, "Billing error (status {}): {}", status_code, body), + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_music.rs b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_music.rs new file mode 100644 index 00000000..e966f244 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_music.rs @@ -0,0 +1,263 @@ +use serde_derive::Serialize; + +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task_custom, WorkflowRunTaskCustomArgs, WorkflowRunTaskResponse, +}; + +const BUSINESS_TYPE: &str = "suno-music-generation"; +const MODEL: &str = "suno-music"; +const MODEL_VERSION: &str = "chirp-v5-5"; + +/// Flat credit price per generation. +const CREDITS_PER_GENERATION: u64 = 16; + +// ── Args ── + +pub struct GenerateSunoMusicArgs<'a> { + pub request: GenerateSunoMusicRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +/// Suno Music: text-to-music generation. +/// +/// NB: the Kinovi UI offers a voice choice (any / male / female), but it is +/// never transmitted on the wire — steer the vocalist through the prompt or +/// style tags instead. +#[derive(Clone, Debug)] +pub struct GenerateSunoMusicRequest { + /// What the song should be about. + pub prompt: String, + + /// Optional style/genre direction (the UI's "style prompt"), e.g. + /// "EDM style meets dance". + pub style_tags: Option, + + /// Generate an instrumental-only track (no vocals). + pub instrumental: bool, +} + +// ── Pricing ── +// +// Suno Music: flat 16 Kinovi credits per generation, regardless of options. + +impl GenerateSunoMusicRequest { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents. + pub fn calculate_costs(&self) -> KinoviGenerationCost { + KinoviGenerationCost::from_kinovi_credits(CREDITS_PER_GENERATION) + } +} + +// ── Response ── + +pub struct GenerateSunoMusicResponse { + pub task_id: String, + pub order_id: String, +} + +// ── Entry point ── + +pub async fn generate_suno_music( + args: GenerateSunoMusicArgs<'_>, +) -> Result { + let raw_response: WorkflowRunTaskResponse = workflow_run_task_custom(WorkflowRunTaskCustomArgs { + business_type: BUSINESS_TYPE, + api_params: build_api_params(&args.request), + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSunoMusicResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + }) +} + +// ── Wire payload ── + +/// The `apiParams` shape for `suno-music-generation`. Field order matches the +/// captured browser traffic. +#[derive(Serialize, Debug)] +struct SunoMusicApiParams { + model: &'static str, + prompt: String, + custom: bool, + instrumental: bool, + mv: &'static str, + #[serde(skip_serializing_if = "Option::is_none")] + tags: Option, + #[serde(rename = "generateVideo")] + generate_video: bool, + #[serde(rename = "isStorage")] + is_storage: bool, +} + +fn build_api_params(request: &GenerateSunoMusicRequest) -> SunoMusicApiParams { + SunoMusicApiParams { + model: MODEL, + prompt: request.prompt.clone(), + custom: false, + instrumental: request.instrumental, + mv: MODEL_VERSION, + tags: request.style_tags.clone(), + generate_video: false, + is_storage: true, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + + mod pricing_tests { + use super::*; + + fn base_request() -> GenerateSunoMusicRequest { + GenerateSunoMusicRequest { + prompt: "A song".to_string(), + style_tags: None, + instrumental: false, + } + } + + #[test] + fn flat_sixteen_credits() { + let costs = base_request().calculate_costs(); + assert_eq!(costs.kinovi_credits, 16); + } + + #[test] + fn usd_cents() { + // 16 credits; 1600/243 = 6.5843… → up 7¢, down 6¢. + let costs = base_request().calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 7); + assert_eq!(costs.usd_cents_rounded_down, 6); + assert!((costs.usd_cents_fractional - (1600.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn options_do_not_affect_cost() { + let base = base_request().calculate_costs(); + let styled = GenerateSunoMusicRequest { + prompt: "Another song".to_string(), + style_tags: Some("EDM".to_string()), + instrumental: true, + }.calculate_costs(); + assert_eq!(base, styled); + } + } + + mod request_shape_tests { + use super::*; + + /// Mirrors capture 1_suno_music.txt (no style tags, with vocals). + #[test] + fn basic_prompt() { + let params = build_api_params(&GenerateSunoMusicRequest { + prompt: "A song about corgi super heroes fighting shiba super villains.".to_string(), + style_tags: None, + instrumental: false, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-music","prompt":"A song about corgi super heroes fighting shiba super villains.","custom":false,"instrumental":false,"mv":"chirp-v5-5","generateVideo":false,"isStorage":true}"#, + ); + } + + /// Mirrors capture 2_suno_music_style_female.txt (style tags present). + #[test] + fn with_style_tags() { + let params = build_api_params(&GenerateSunoMusicRequest { + prompt: "A song about Mario and Luigi fighting Bowser".to_string(), + style_tags: Some("EDM style meets dance".to_string()), + instrumental: false, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-music","prompt":"A song about Mario and Luigi fighting Bowser","custom":false,"instrumental":false,"mv":"chirp-v5-5","tags":"EDM style meets dance","generateVideo":false,"isStorage":true}"#, + ); + } + + /// Mirrors capture 3_suno_music_instrumental.txt. + #[test] + fn instrumental() { + let params = build_api_params(&GenerateSunoMusicRequest { + prompt: "An epic journey for a JRPG".to_string(), + style_tags: Some("Japanese JRPG adventure music".to_string()), + instrumental: true, + }); + let json = serde_json::to_string(¶ms).unwrap(); + assert!(json.contains(r#""instrumental":true"#), "{json}"); + assert!(json.contains(r#""custom":false"#), "{json}"); + assert!(json.contains(r#""mv":"chirp-v5-5""#), "{json}"); + } + + #[test] + fn business_type() { + assert_eq!(BUSINESS_TYPE, "suno-music-generation"); + } + } + + mod live_tests { + use super::*; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn test_music_with_vocals() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_suno_music(GenerateSunoMusicArgs { + session: &session, + host_override: None, + request: GenerateSunoMusicRequest { + prompt: "A song about a corgi who learns to sail the open sea".to_string(), + style_tags: Some("Sea shanty, folk".to_string()), + instrumental: false, + }, + }).await?; + println!("suno music — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn test_music_instrumental() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_suno_music(GenerateSunoMusicArgs { + session: &session, + host_override: None, + request: GenerateSunoMusicRequest { + prompt: "An epic journey across a frozen mountain range".to_string(), + style_tags: Some("Cinematic orchestral score".to_string()), + instrumental: true, + }, + }).await?; + println!("suno music instrumental — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_remix.rs b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_remix.rs new file mode 100644 index 00000000..ec5a3c5f --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_remix.rs @@ -0,0 +1,283 @@ +use serde_derive::Serialize; + +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task_custom, WorkflowRunTaskCustomArgs, WorkflowRunTaskResponse, +}; + +const BUSINESS_TYPE: &str = "suno-remix-generation"; +const MODEL: &str = "suno-remix"; +const MODEL_VERSION: &str = "chirp-v5-5"; + +/// Flat credit price per generation. +const CREDITS_PER_GENERATION: u64 = 16; + +// ── Args ── + +pub struct GenerateSunoRemixArgs<'a> { + pub request: GenerateSunoRemixRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +/// Suno Remix: transform an existing piece of audio. +#[derive(Clone, Debug)] +pub struct GenerateSunoRemixRequest { + /// How to transform the audio, e.g. "Make this electronic". + pub prompt: String, + + /// The audio to remix. + pub source: KinoviSunoRemixSource, + + /// Optional style/genre direction (the UI's "style prompt"). + pub style_tags: Option, + + /// Keep the original lyrics in the remix. + pub keep_lyrics: bool, +} + +// ── Enums ── + +/// The audio input for a remix: either an uploaded file (by CDN URL) or a +/// previously generated Suno track (by its music id). +#[derive(Clone, Debug)] +pub enum KinoviSunoRemixSource { + /// A Kinovi CDN URL to an uploaded audio file. + AudioUrl(String), + /// The id of a previously generated Suno track + /// (e.g. "fea7e70c-5373-452d-9c5e-f079ff837fcd"). + MusicId(String), +} + +// ── Pricing ── +// +// Suno Remix: flat 16 Kinovi credits per generation, regardless of options. + +impl GenerateSunoRemixRequest { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents. + pub fn calculate_costs(&self) -> KinoviGenerationCost { + KinoviGenerationCost::from_kinovi_credits(CREDITS_PER_GENERATION) + } +} + +// ── Response ── + +pub struct GenerateSunoRemixResponse { + pub task_id: String, + pub order_id: String, +} + +// ── Entry point ── + +pub async fn generate_suno_remix( + args: GenerateSunoRemixArgs<'_>, +) -> Result { + let raw_response: WorkflowRunTaskResponse = workflow_run_task_custom(WorkflowRunTaskCustomArgs { + business_type: BUSINESS_TYPE, + api_params: build_api_params(&args.request), + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSunoRemixResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + }) +} + +// ── Wire payload ── + +/// The `apiParams` shape for `suno-remix-generation`. Field order matches the +/// captured browser traffic. Exactly one of `audio_url` / `music_id` is set. +#[derive(Serialize, Debug)] +struct SunoRemixApiParams { + model: &'static str, + prompt: String, + #[serde(rename = "audioUrl", skip_serializing_if = "Option::is_none")] + audio_url: Option, + #[serde(rename = "musicId", skip_serializing_if = "Option::is_none")] + music_id: Option, + custom: bool, + #[serde(rename = "keepLyrics")] + keep_lyrics: bool, + mv: &'static str, + #[serde(skip_serializing_if = "Option::is_none")] + tags: Option, + #[serde(rename = "isStorage")] + is_storage: bool, +} + +fn build_api_params(request: &GenerateSunoRemixRequest) -> SunoRemixApiParams { + let (audio_url, music_id) = match &request.source { + KinoviSunoRemixSource::AudioUrl(url) => (Some(url.clone()), None), + KinoviSunoRemixSource::MusicId(id) => (None, Some(id.clone())), + }; + + SunoRemixApiParams { + model: MODEL, + prompt: request.prompt.clone(), + audio_url, + music_id, + custom: false, + keep_lyrics: request.keep_lyrics, + mv: MODEL_VERSION, + tags: request.style_tags.clone(), + is_storage: true, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + + mod pricing_tests { + use super::*; + + fn base_request() -> GenerateSunoRemixRequest { + GenerateSunoRemixRequest { + prompt: "Make this electronic".to_string(), + source: KinoviSunoRemixSource::AudioUrl("https://example.com/a.mp3".to_string()), + style_tags: None, + keep_lyrics: false, + } + } + + #[test] + fn flat_sixteen_credits() { + let costs = base_request().calculate_costs(); + assert_eq!(costs.kinovi_credits, 16); + } + + #[test] + fn usd_cents() { + // 16 credits; 1600/243 = 6.5843… → up 7¢, down 6¢. + let costs = base_request().calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 7); + assert_eq!(costs.usd_cents_rounded_down, 6); + assert!((costs.usd_cents_fractional - (1600.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn options_do_not_affect_cost() { + let base = base_request().calculate_costs(); + let other = GenerateSunoRemixRequest { + prompt: "Make this a symphony".to_string(), + source: KinoviSunoRemixSource::MusicId("abc".to_string()), + style_tags: Some("Classical music".to_string()), + keep_lyrics: true, + }.calculate_costs(); + assert_eq!(base, other); + } + } + + mod request_shape_tests { + use super::*; + + /// Mirrors capture 5_suno_remix.txt (uploaded audio URL, no lyric keep). + #[test] + fn audio_url_source() { + let params = build_api_params(&GenerateSunoRemixRequest { + prompt: "Make this electronic".to_string(), + source: KinoviSunoRemixSource::AudioUrl( + "https://static.seedance2-pro.com/materials/20260707/1783399892833-7d9668fb.mp3".to_string(), + ), + style_tags: Some("EDM style".to_string()), + keep_lyrics: false, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-remix","prompt":"Make this electronic","audioUrl":"https://static.seedance2-pro.com/materials/20260707/1783399892833-7d9668fb.mp3","custom":false,"keepLyrics":false,"mv":"chirp-v5-5","tags":"EDM style","isStorage":true}"#, + ); + } + + /// Mirrors capture 6_suno_remix_lyrics.txt (existing track by music id, + /// keeping the lyrics). + #[test] + fn music_id_source_with_kept_lyrics() { + let params = build_api_params(&GenerateSunoRemixRequest { + prompt: "Make this a symphony".to_string(), + source: KinoviSunoRemixSource::MusicId("fea7e70c-5373-452d-9c5e-f079ff837fcd".to_string()), + style_tags: Some("Classical music".to_string()), + keep_lyrics: true, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-remix","prompt":"Make this a symphony","musicId":"fea7e70c-5373-452d-9c5e-f079ff837fcd","custom":false,"keepLyrics":true,"mv":"chirp-v5-5","tags":"Classical music","isStorage":true}"#, + ); + } + + #[test] + fn business_type() { + assert_eq!(BUSINESS_TYPE, "suno-remix-generation"); + } + } + + mod live_tests { + use super::*; + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. Requires a local audio file. + async fn test_remix_uploaded_audio() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let audio_url = upload_test_audio(&session).await?; + println!("Uploaded audio: {}", audio_url); + + let result = generate_suno_remix(GenerateSunoRemixArgs { + session: &session, + host_override: None, + request: GenerateSunoRemixRequest { + prompt: "Make this electronic".to_string(), + source: KinoviSunoRemixSource::AudioUrl(audio_url), + style_tags: Some("EDM style".to_string()), + keep_lyrics: false, + }, + }).await?; + println!("suno remix — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + async fn upload_test_audio(session: &Seedance2ProSession) -> AnyhowResult { + let audio_path = test_utils::test_file_path::test_file_path( + "test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3", + )?; + let audio_bytes = std::fs::read(&audio_path)?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "mp3".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: audio_bytes, + host_override: None, + }).await?; + + Ok(upload_result.public_url) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_sample.rs b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_sample.rs new file mode 100644 index 00000000..bf0761fb --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_sample.rs @@ -0,0 +1,289 @@ +use serde_derive::Serialize; + +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task_custom, WorkflowRunTaskCustomArgs, WorkflowRunTaskResponse, +}; + +const BUSINESS_TYPE: &str = "suno-sample-generation"; +const MODEL: &str = "suno-sample"; +const MODEL_VERSION: &str = "chirp-v5-5"; + +/// Flat credit price per generation. +const CREDITS_PER_GENERATION: u64 = 16; + +// ── Args ── + +pub struct GenerateSunoSampleArgs<'a> { + pub request: GenerateSunoSampleRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +/// Suno Sample: build a track from a chopped sample of an uploaded audio file. +/// +/// NB: the Kinovi UI offers a voice choice (male / female / no voice), but it +/// is never transmitted on the wire — `instrumental` controls whether vocals +/// are added at all; steer the vocalist through the prompt or style tags. +#[derive(Clone, Debug)] +pub struct GenerateSunoSampleRequest { + /// What to build from the sample, e.g. "Mystical RPG adventure, make it + /// have a grand climax". + pub prompt: String, + + /// A Kinovi CDN URL to the uploaded audio file to sample. + pub audio_url: String, + + /// Start of the sample window within the audio, in seconds. + pub chop_sample_start_seconds: u32, + + /// End of the sample window within the audio, in seconds. + pub chop_sample_end_seconds: u32, + + /// Optional style/genre direction (the UI's "style prompt"). + pub style_tags: Option, + + /// Generate an instrumental-only track (no vocals). + pub instrumental: bool, +} + +// ── Pricing ── +// +// Suno Sample: flat 16 Kinovi credits per generation, regardless of options. + +impl GenerateSunoSampleRequest { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents. + pub fn calculate_costs(&self) -> KinoviGenerationCost { + KinoviGenerationCost::from_kinovi_credits(CREDITS_PER_GENERATION) + } +} + +// ── Response ── + +pub struct GenerateSunoSampleResponse { + pub task_id: String, + pub order_id: String, +} + +// ── Entry point ── + +pub async fn generate_suno_sample( + args: GenerateSunoSampleArgs<'_>, +) -> Result { + let raw_response: WorkflowRunTaskResponse = workflow_run_task_custom(WorkflowRunTaskCustomArgs { + business_type: BUSINESS_TYPE, + api_params: build_api_params(&args.request), + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSunoSampleResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + }) +} + +// ── Wire payload ── + +/// The `apiParams` shape for `suno-sample-generation`. Field order matches the +/// captured browser traffic. +#[derive(Serialize, Debug)] +struct SunoSampleApiParams { + model: &'static str, + prompt: String, + #[serde(rename = "audioUrl")] + audio_url: String, + #[serde(rename = "chopSampleStartS")] + chop_sample_start_s: u32, + #[serde(rename = "chopSampleEndS")] + chop_sample_end_s: u32, + custom: bool, + instrumental: bool, + #[serde(rename = "autoLyrics")] + auto_lyrics: bool, + mv: &'static str, + #[serde(skip_serializing_if = "Option::is_none")] + tags: Option, + #[serde(rename = "isStorage")] + is_storage: bool, +} + +fn build_api_params(request: &GenerateSunoSampleRequest) -> SunoSampleApiParams { + SunoSampleApiParams { + model: MODEL, + prompt: request.prompt.clone(), + audio_url: request.audio_url.clone(), + chop_sample_start_s: request.chop_sample_start_seconds, + chop_sample_end_s: request.chop_sample_end_seconds, + custom: false, + instrumental: request.instrumental, + auto_lyrics: true, + mv: MODEL_VERSION, + tags: request.style_tags.clone(), + is_storage: true, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + + mod pricing_tests { + use super::*; + + fn base_request() -> GenerateSunoSampleRequest { + GenerateSunoSampleRequest { + prompt: "Mystical RPG adventure".to_string(), + audio_url: "https://example.com/a.aac".to_string(), + chop_sample_start_seconds: 0, + chop_sample_end_seconds: 41, + style_tags: None, + instrumental: true, + } + } + + #[test] + fn flat_sixteen_credits() { + let costs = base_request().calculate_costs(); + assert_eq!(costs.kinovi_credits, 16); + } + + #[test] + fn usd_cents() { + // 16 credits; 1600/243 = 6.5843… → up 7¢, down 6¢. + let costs = base_request().calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 7); + assert_eq!(costs.usd_cents_rounded_down, 6); + assert!((costs.usd_cents_fractional - (1600.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn options_do_not_affect_cost() { + let base = base_request().calculate_costs(); + let other = GenerateSunoSampleRequest { + prompt: "A vocal fantasy track".to_string(), + audio_url: "https://example.com/b.aac".to_string(), + chop_sample_start_seconds: 10, + chop_sample_end_seconds: 30, + style_tags: Some("Fantasy video game".to_string()), + instrumental: false, + }.calculate_costs(); + assert_eq!(base, other); + } + } + + mod request_shape_tests { + use super::*; + + /// Mirrors capture 11_suno_sample_1.txt (instrumental). + #[test] + fn instrumental_sample() { + let params = build_api_params(&GenerateSunoSampleRequest { + prompt: "Mystical RPG adventure, make it have a grand climax".to_string(), + audio_url: "https://static.seedance2-pro.com/materials/20260707/1783401649804-e654f994.aac".to_string(), + chop_sample_start_seconds: 0, + chop_sample_end_seconds: 41, + style_tags: Some("Fantasy video game, Motoi Sakuraba, Golden Sun".to_string()), + instrumental: true, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-sample","prompt":"Mystical RPG adventure, make it have a grand climax","audioUrl":"https://static.seedance2-pro.com/materials/20260707/1783401649804-e654f994.aac","chopSampleStartS":0,"chopSampleEndS":41,"custom":false,"instrumental":true,"autoLyrics":true,"mv":"chirp-v5-5","tags":"Fantasy video game, Motoi Sakuraba, Golden Sun","isStorage":true}"#, + ); + } + + /// Mirrors capture 12_suno_sample_2.txt (with vocals). + #[test] + fn vocal_sample() { + let params = build_api_params(&GenerateSunoSampleRequest { + prompt: "Give this a lyrics track, a woman singing in a fantasy language".to_string(), + audio_url: "https://static.seedance2-pro.com/materials/20260707/1783401649804-e654f994.aac".to_string(), + chop_sample_start_seconds: 0, + chop_sample_end_seconds: 41, + style_tags: Some("Fantasy video game, Motoi Sakuraba, Golden Sun".to_string()), + instrumental: false, + }); + let json = serde_json::to_string(¶ms).unwrap(); + assert!(json.contains(r#""instrumental":false"#), "{json}"); + assert!(json.contains(r#""autoLyrics":true"#), "{json}"); + assert!(json.contains(r#""chopSampleStartS":0"#), "{json}"); + assert!(json.contains(r#""chopSampleEndS":41"#), "{json}"); + } + + #[test] + fn business_type() { + assert_eq!(BUSINESS_TYPE, "suno-sample-generation"); + } + } + + mod live_tests { + use super::*; + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. Requires a local audio file. + async fn test_sample_instrumental() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let audio_url = upload_test_audio(&session).await?; + println!("Uploaded audio: {}", audio_url); + + let result = generate_suno_sample(GenerateSunoSampleArgs { + session: &session, + host_override: None, + request: GenerateSunoSampleRequest { + prompt: "Mystical RPG adventure, make it have a grand climax".to_string(), + audio_url, + chop_sample_start_seconds: 0, + chop_sample_end_seconds: 30, + style_tags: Some("Fantasy video game score".to_string()), + instrumental: true, + }, + }).await?; + println!("suno sample — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + async fn upload_test_audio(session: &Seedance2ProSession) -> AnyhowResult { + let audio_path = test_utils::test_file_path::test_file_path( + "test_data/audio/aac/golden_sun_elemental_stars_cyanne.aac", + )?; + let audio_bytes = std::fs::read(&audio_path)?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "aac".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: audio_bytes, + host_override: None, + }).await?; + + Ok(upload_result.public_url) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_sound.rs b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_sound.rs new file mode 100644 index 00000000..6c109107 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/audio/generate_suno_sound.rs @@ -0,0 +1,360 @@ +use serde_derive::Serialize; + +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task_custom, WorkflowRunTaskCustomArgs, WorkflowRunTaskResponse, +}; + +const BUSINESS_TYPE: &str = "suno-sounds-generation"; +const MODEL: &str = "suno-sounds"; +const MODEL_VERSION: &str = "chirp-v5-5"; + +/// Flat credit price per generation. +const CREDITS_PER_GENERATION: u64 = 4; + +// ── Args ── + +pub struct GenerateSunoSoundArgs<'a> { + pub request: GenerateSunoSoundRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +/// Suno Sounds: short sound-effect / sample generation. +#[derive(Clone, Debug)] +pub struct GenerateSunoSoundRequest { + /// What the sound should be, e.g. "Rain sound effects". + pub prompt: String, + + /// Single hit vs seamless loop. + pub sound_type: KinoviSunoSoundType, + + /// Optional tempo in BPM. + pub bpm: Option, + + /// Musical key. `Auto` lets Kinovi pick. + pub key: KinoviSunoSoundKey, +} + +// ── Enums ── + +/// Single hit ("one-shot") vs seamless loop ("loop"). +#[derive(Debug, Clone, Copy)] +pub enum KinoviSunoSoundType { + SingleHit, + Loopable, +} + +/// Musical key for the generated sound. +/// +/// NB: the Kinovi UI's "Auto" selection still transmits "C" on the wire +/// (observed in captured traffic), so `Auto` and `CMajor` are wire-identical. +#[derive(Debug, Clone, Copy)] +pub enum KinoviSunoSoundKey { + Auto, + CMajor, + CMinor, + DMajor, + DMinor, + FMajor, + FMinor, + GMajor, + GMinor, + AMajor, + AMinor, + BMajor, + BMinor, +} + +// ── Pricing ── +// +// Suno Sounds: flat 4 Kinovi credits per generation, regardless of options. + +impl GenerateSunoSoundRequest { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents. + pub fn calculate_costs(&self) -> KinoviGenerationCost { + KinoviGenerationCost::from_kinovi_credits(CREDITS_PER_GENERATION) + } +} + +// ── Response ── + +pub struct GenerateSunoSoundResponse { + pub task_id: String, + pub order_id: String, +} + +// ── Entry point ── + +pub async fn generate_suno_sound( + args: GenerateSunoSoundArgs<'_>, +) -> Result { + let raw_response: WorkflowRunTaskResponse = workflow_run_task_custom(WorkflowRunTaskCustomArgs { + business_type: BUSINESS_TYPE, + api_params: build_api_params(&args.request), + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSunoSoundResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + }) +} + +// ── Wire payload ── + +/// The `apiParams` shape for `suno-sounds-generation`. Field order matches the +/// captured browser traffic. +#[derive(Serialize, Debug)] +struct SunoSoundApiParams { + model: &'static str, + prompt: String, + mv: &'static str, + #[serde(rename = "type")] + sound_type: &'static str, + #[serde(skip_serializing_if = "Option::is_none")] + bpm: Option, + key: &'static str, + #[serde(rename = "isStorage")] + is_storage: bool, +} + +fn build_api_params(request: &GenerateSunoSoundRequest) -> SunoSoundApiParams { + SunoSoundApiParams { + model: MODEL, + prompt: request.prompt.clone(), + mv: MODEL_VERSION, + sound_type: sound_type_as_api_str(request.sound_type), + bpm: request.bpm, + key: key_as_api_str(request.key), + is_storage: true, + } +} + +fn sound_type_as_api_str(sound_type: KinoviSunoSoundType) -> &'static str { + match sound_type { + KinoviSunoSoundType::SingleHit => "one-shot", + KinoviSunoSoundType::Loopable => "loop", + } +} + +fn key_as_api_str(key: KinoviSunoSoundKey) -> &'static str { + match key { + // The UI's Auto choice sends "C" on the wire. + KinoviSunoSoundKey::Auto => "C", + KinoviSunoSoundKey::CMajor => "C", + KinoviSunoSoundKey::CMinor => "Cm", + KinoviSunoSoundKey::DMajor => "D", + KinoviSunoSoundKey::DMinor => "Dm", + KinoviSunoSoundKey::FMajor => "F", + KinoviSunoSoundKey::FMinor => "Fm", + KinoviSunoSoundKey::GMajor => "G", + KinoviSunoSoundKey::GMinor => "Gm", + KinoviSunoSoundKey::AMajor => "A", + KinoviSunoSoundKey::AMinor => "Am", + KinoviSunoSoundKey::BMajor => "B", + KinoviSunoSoundKey::BMinor => "Bm", + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + + mod pricing_tests { + use super::*; + + fn base_request() -> GenerateSunoSoundRequest { + GenerateSunoSoundRequest { + prompt: "Rain sound effects".to_string(), + sound_type: KinoviSunoSoundType::SingleHit, + bpm: None, + key: KinoviSunoSoundKey::Auto, + } + } + + #[test] + fn flat_four_credits() { + let costs = base_request().calculate_costs(); + assert_eq!(costs.kinovi_credits, 4); + } + + #[test] + fn usd_cents() { + // 4 credits; 400/243 = 1.6461… → up 2¢, down 1¢. + let costs = base_request().calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 2); + assert_eq!(costs.usd_cents_rounded_down, 1); + assert!((costs.usd_cents_fractional - (400.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn options_do_not_affect_cost() { + let base = base_request().calculate_costs(); + let other = GenerateSunoSoundRequest { + prompt: "Thunder".to_string(), + sound_type: KinoviSunoSoundType::Loopable, + bpm: Some(180), + key: KinoviSunoSoundKey::DMinor, + }.calculate_costs(); + assert_eq!(base, other); + } + } + + mod request_shape_tests { + use super::*; + + /// Mirrors capture 7_suno_sounds_1.txt (single hit, no BPM, auto key — + /// which transmits "C"). + #[test] + fn single_hit_no_bpm_auto_key() { + let params = build_api_params(&GenerateSunoSoundRequest { + prompt: "Rain sound effects".to_string(), + sound_type: KinoviSunoSoundType::SingleHit, + bpm: None, + key: KinoviSunoSoundKey::Auto, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-sounds","prompt":"Rain sound effects","mv":"chirp-v5-5","type":"one-shot","key":"C","isStorage":true}"#, + ); + } + + /// Mirrors capture 8_suno_sounds_2.txt (loop, 60 BPM, D minor). + #[test] + fn loop_with_bpm_and_minor_key() { + let params = build_api_params(&GenerateSunoSoundRequest { + prompt: "Thunder".to_string(), + sound_type: KinoviSunoSoundType::Loopable, + bpm: Some(60), + key: KinoviSunoSoundKey::DMinor, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-sounds","prompt":"Thunder","mv":"chirp-v5-5","type":"loop","bpm":60,"key":"Dm","isStorage":true}"#, + ); + } + + /// Mirrors capture 9_suno_sounds_3.txt (loop, 180 BPM, F major). + #[test] + fn loop_with_major_key() { + let params = build_api_params(&GenerateSunoSoundRequest { + prompt: "Plates crashing in the kitchen".to_string(), + sound_type: KinoviSunoSoundType::Loopable, + bpm: Some(180), + key: KinoviSunoSoundKey::FMajor, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-sounds","prompt":"Plates crashing in the kitchen","mv":"chirp-v5-5","type":"loop","bpm":180,"key":"F","isStorage":true}"#, + ); + } + + /// Mirrors capture 10_suno_sounds_4.txt (single hit, 100 BPM, C minor). + #[test] + fn single_hit_with_bpm_and_minor_key() { + let params = build_api_params(&GenerateSunoSoundRequest { + prompt: "Car crash".to_string(), + sound_type: KinoviSunoSoundType::SingleHit, + bpm: Some(100), + key: KinoviSunoSoundKey::CMinor, + }); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"model":"suno-sounds","prompt":"Car crash","mv":"chirp-v5-5","type":"one-shot","bpm":100,"key":"Cm","isStorage":true}"#, + ); + } + + #[test] + fn every_key_wire_value() { + let cases = [ + (KinoviSunoSoundKey::Auto, "C"), + (KinoviSunoSoundKey::CMajor, "C"), + (KinoviSunoSoundKey::CMinor, "Cm"), + (KinoviSunoSoundKey::DMajor, "D"), + (KinoviSunoSoundKey::DMinor, "Dm"), + (KinoviSunoSoundKey::FMajor, "F"), + (KinoviSunoSoundKey::FMinor, "Fm"), + (KinoviSunoSoundKey::GMajor, "G"), + (KinoviSunoSoundKey::GMinor, "Gm"), + (KinoviSunoSoundKey::AMajor, "A"), + (KinoviSunoSoundKey::AMinor, "Am"), + (KinoviSunoSoundKey::BMajor, "B"), + (KinoviSunoSoundKey::BMinor, "Bm"), + ]; + for (key, expected) in cases { + assert_eq!(key_as_api_str(key), expected, "wire value for {key:?}"); + } + } + + #[test] + fn business_type() { + assert_eq!(BUSINESS_TYPE, "suno-sounds-generation"); + } + } + + mod live_tests { + use super::*; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn test_single_hit() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_suno_sound(GenerateSunoSoundArgs { + session: &session, + host_override: None, + request: GenerateSunoSoundRequest { + prompt: "A heavy castle door creaking open".to_string(), + sound_type: KinoviSunoSoundType::SingleHit, + bpm: None, + key: KinoviSunoSoundKey::Auto, + }, + }).await?; + println!("suno sound single hit — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn test_loop_with_bpm_and_key() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_suno_sound(GenerateSunoSoundArgs { + session: &session, + host_override: None, + request: GenerateSunoSoundRequest { + prompt: "Lo-fi vinyl crackle groove".to_string(), + sound_type: KinoviSunoSoundType::Loopable, + bpm: Some(85), + key: KinoviSunoSoundKey::AMinor, + }, + }).await?; + println!("suno sound loop — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/audio/mod.rs b/crates/api_clients/seedance2pro_client/src/generate/audio/mod.rs new file mode 100644 index 00000000..afba02de --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/audio/mod.rs @@ -0,0 +1,4 @@ +pub mod generate_suno_music; +pub mod generate_suno_remix; +pub mod generate_suno_sample; +pub mod generate_suno_sound; diff --git a/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v7.rs b/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v7.rs new file mode 100644 index 00000000..e1ffa9a8 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v7.rs @@ -0,0 +1,385 @@ +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::generate_image::generate_image::{ + generate_image, GenerateImageArgs, KinoviGenerateImageRequest, KinoviMidjourneyModel, +}; +use crate::requests::kinovi_host::KinoviHost; + +// `KinoviMidjourneyBatchCount` is shared across all Midjourney models, so we +// re-export it from the base. Aspect ratio and quality, however, are pinned +// to model-specific enums on this wrapper to keep their valid values typed +// at the call site. +pub use crate::requests::generate_image::generate_image::KinoviMidjourneyBatchCount; + +// ── Args ── + +pub struct GenerateMidjourneyV7Args<'a> { + pub request: GenerateMidjourneyV7Request, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateMidjourneyV7Request { + pub prompt: String, + pub aspect_ratio: GenerateMidjourneyV7AspectRatio, + pub negative_prompt: Option, + pub stylize: Option, + pub weird: Option, + pub chaos: Option, + pub quality: Option, + pub raw_mode: bool, + pub batch_count: KinoviMidjourneyBatchCount, + pub reference_image_urls: Option>, +} + +impl GenerateMidjourneyV7Request { + /// Calculate the cost of this request, in Kinovi credits and USD cents + /// (rounded up). + pub fn calculate_costs(&self) -> KinoviGenerationCost { + self.to_inner_request().calculate_costs() + } + + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().kinovi_credits as u32 + } + + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().usd_cents_rounded_up + } + + pub(crate) fn to_inner_request(&self) -> KinoviGenerateImageRequest { + KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7, + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.as_api_str().to_string(), + negative_prompt: self.negative_prompt.clone(), + stylize: self.stylize, + weird: self.weird, + chaos: self.chaos, + quality: self.quality.map(|q| q.as_api_str().to_string()), + raw_mode: self.raw_mode, + batch_count: self.batch_count, + reference_image_urls: self.reference_image_urls.clone(), + } + } +} + +// ── Model-specific enums ── + +/// Aspect ratios supported by Midjourney v7. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum GenerateMidjourneyV7AspectRatio { + Square1x1, + Landscape16x9, + Portrait9x16, + UltraWide21x9, + UltraTall9x21, + Standard4x3, + Portrait3x4, + Wide5x4, + Tall4x5, + Wide3x2, + Tall2x3, +} + +impl GenerateMidjourneyV7AspectRatio { + fn as_api_str(&self) -> &'static str { + match self { + Self::Square1x1 => "1:1", + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::UltraWide21x9 => "21:9", + Self::UltraTall9x21 => "9:21", + Self::Standard4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Wide5x4 => "5:4", + Self::Tall4x5 => "4:5", + Self::Wide3x2 => "3:2", + Self::Tall2x3 => "2:3", + } + } +} + +/// Quality presets supported by Midjourney v7. Higher = more compute and +/// slower; Kinovi credit pricing is flat regardless. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum GenerateMidjourneyV7Quality { + /// 0.25 + Quarter, + /// 0.5 + Half, + /// 1 (default) + Full, +} + +impl GenerateMidjourneyV7Quality { + fn as_api_str(&self) -> &'static str { + match self { + Self::Quarter => "0.25", + Self::Half => "0.5", + Self::Full => "1", + } + } +} + +// ── Response ── + +pub struct GenerateMidjourneyV7Response { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_midjourney_v7( + args: GenerateMidjourneyV7Args<'_>, +) -> Result { + let inner_request = args.request.to_inner_request(); + let result = generate_image(GenerateImageArgs { + request: inner_request, + session: args.session, + host_override: args.host_override, + }).await?; + Ok(GenerateMidjourneyV7Response { + task_id: result.task_id, + order_id: result.order_id, + task_ids: result.task_ids, + order_ids: result.order_ids, + }) +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + fn make_request(batch_count: KinoviMidjourneyBatchCount) -> GenerateMidjourneyV7Request { + GenerateMidjourneyV7Request { + prompt: "test".to_string(), + aspect_ratio: GenerateMidjourneyV7AspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count, + reference_image_urls: None, + } + } + + // ── Inner-request mapping ── + + mod inner_request_tests { + use super::*; + + #[test] + fn inner_request_pins_model_to_v7() { + let inner = make_request(KinoviMidjourneyBatchCount::One).to_inner_request(); + assert_eq!(inner.model, KinoviMidjourneyModel::V7); + } + + #[test] + fn inner_request_preserves_all_fields() { + let req = GenerateMidjourneyV7Request { + prompt: "a corgi in space".to_string(), + aspect_ratio: GenerateMidjourneyV7AspectRatio::Landscape16x9, + negative_prompt: Some("dark".to_string()), + stylize: Some(500), + weird: Some(1500), + chaos: Some(50), + quality: Some(GenerateMidjourneyV7Quality::Half), + raw_mode: true, + batch_count: KinoviMidjourneyBatchCount::Four, + reference_image_urls: Some(vec!["https://example.com/x.png".to_string()]), + }; + let inner = req.to_inner_request(); + assert_eq!(inner.model, KinoviMidjourneyModel::V7); + assert_eq!(inner.prompt, "a corgi in space"); + assert_eq!(inner.aspect_ratio, "16:9"); + assert_eq!(inner.negative_prompt.as_deref(), Some("dark")); + assert_eq!(inner.stylize, Some(500)); + assert_eq!(inner.weird, Some(1500)); + assert_eq!(inner.chaos, Some(50)); + assert_eq!(inner.quality.as_deref(), Some("0.5")); + assert!(inner.raw_mode); + assert_eq!(inner.batch_count, KinoviMidjourneyBatchCount::Four); + assert_eq!( + inner.reference_image_urls.as_deref(), + Some(&["https://example.com/x.png".to_string()][..]), + ); + } + + /// Every wrapper-side aspect ratio must serialize to the exact wire + /// string Midjourney expects. Catches silent drift between the enum + /// surface and the API. + #[test] + fn every_aspect_ratio_maps_to_canonical_wire_string() { + let cases = [ + (GenerateMidjourneyV7AspectRatio::Square1x1, "1:1"), + (GenerateMidjourneyV7AspectRatio::Landscape16x9, "16:9"), + (GenerateMidjourneyV7AspectRatio::Portrait9x16, "9:16"), + (GenerateMidjourneyV7AspectRatio::UltraWide21x9, "21:9"), + (GenerateMidjourneyV7AspectRatio::UltraTall9x21, "9:21"), + (GenerateMidjourneyV7AspectRatio::Standard4x3, "4:3"), + (GenerateMidjourneyV7AspectRatio::Portrait3x4, "3:4"), + (GenerateMidjourneyV7AspectRatio::Wide5x4, "5:4"), + (GenerateMidjourneyV7AspectRatio::Tall4x5, "4:5"), + (GenerateMidjourneyV7AspectRatio::Wide3x2, "3:2"), + (GenerateMidjourneyV7AspectRatio::Tall2x3, "2:3"), + ]; + for (variant, expected) in cases { + let req = GenerateMidjourneyV7Request { aspect_ratio: variant, ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.to_inner_request().aspect_ratio, expected, "variant={:?}", variant); + } + } + + #[test] + fn every_quality_maps_to_canonical_wire_string() { + let cases = [ + (GenerateMidjourneyV7Quality::Quarter, "0.25"), + (GenerateMidjourneyV7Quality::Half, "0.5"), + (GenerateMidjourneyV7Quality::Full, "1"), + ]; + for (variant, expected) in cases { + let req = GenerateMidjourneyV7Request { quality: Some(variant), ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.to_inner_request().quality.as_deref(), Some(expected), "variant={:?}", variant); + } + } + } + + // ── Pricing (delegates to the inner module, but pinned via explicit values) ── + + mod pricing_tests { + use super::*; + + #[test] + fn batch_one_is_twelve_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits, 12); + } + + #[test] + fn batch_two_is_twentyfour_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().kinovi_credits, 24); + } + + #[test] + fn batch_three_is_thirtysix_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Three).calculate_costs().kinovi_credits, 36); + } + + #[test] + fn batch_four_is_fortyeight_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().kinovi_credits, 48); + } + + #[test] + fn usd_cents_batch_one_is_five() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_up, 5); // 1200/243 = 4.94 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_down, 4); + assert!((make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_fractional - (1200.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_batch_four_is_twenty() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_up, 20); // 4800/243 = 19.75 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_down, 19); + assert!((make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_fractional - (4800.0 / 243.0)).abs() < 1e-9); + } + + /// Pricing must match the inner module byte-for-byte (sanity that no + /// wrapper drift introduces an extra rounding step). + #[test] + fn matches_inner_pricing_exactly() { + for batch in [ + KinoviMidjourneyBatchCount::One, + KinoviMidjourneyBatchCount::Two, + KinoviMidjourneyBatchCount::Three, + KinoviMidjourneyBatchCount::Four, + ] { + let outer = make_request(batch); + let inner = outer.to_inner_request(); + assert_eq!(outer.calculate_costs().kinovi_credits, inner.calculate_costs().kinovi_credits, "batch={:?}", batch); + assert_eq!(outer.calculate_costs().usd_cents_rounded_up, inner.calculate_costs().usd_cents_rounded_up, "batch={:?}", batch); + } + } + } + + // ── Real requests ── + + mod real_requests { + use super::*; + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v7_minimal() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_midjourney_v7(GenerateMidjourneyV7Args { + session: &session, + host_override: None, + request: GenerateMidjourneyV7Request { + prompt: "A corgi astronaut floating among stars".to_string(), + aspect_ratio: GenerateMidjourneyV7AspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }).await?; + println!("v7 minimal — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v7_all_knobs() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_midjourney_v7(GenerateMidjourneyV7Args { + session: &session, + host_override: None, + request: GenerateMidjourneyV7Request { + prompt: "abandoned skyscrapers".to_string(), + aspect_ratio: GenerateMidjourneyV7AspectRatio::Square1x1, + negative_prompt: Some("dark, gloomy, night".to_string()), + stylize: Some(1000), + weird: Some(3000), + chaos: Some(100), + quality: Some(GenerateMidjourneyV7Quality::Half), + raw_mode: true, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }).await?; + println!("v7 all knobs — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + Ok(()) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v7_niji.rs b/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v7_niji.rs new file mode 100644 index 00000000..41fb895b --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v7_niji.rs @@ -0,0 +1,355 @@ +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::generate_image::generate_image::{ + generate_image, GenerateImageArgs, KinoviGenerateImageRequest, KinoviMidjourneyModel, +}; +use crate::requests::kinovi_host::KinoviHost; + +// `KinoviMidjourneyBatchCount` is shared across all Midjourney models, so we +// re-export it from the base. Aspect ratio and quality, however, are pinned +// to model-specific enums on this wrapper to keep their valid values typed +// at the call site. +pub use crate::requests::generate_image::generate_image::KinoviMidjourneyBatchCount; + +// ── Args ── + +pub struct GenerateMidjourneyV7NijiArgs<'a> { + pub request: GenerateMidjourneyV7NijiRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateMidjourneyV7NijiRequest { + pub prompt: String, + pub aspect_ratio: GenerateMidjourneyV7NijiAspectRatio, + pub negative_prompt: Option, + pub stylize: Option, + pub weird: Option, + pub chaos: Option, + pub quality: Option, + pub raw_mode: bool, + pub batch_count: KinoviMidjourneyBatchCount, + pub reference_image_urls: Option>, +} + +impl GenerateMidjourneyV7NijiRequest { + /// Calculate the cost of this request, in Kinovi credits and USD cents + /// (rounded up). + pub fn calculate_costs(&self) -> KinoviGenerationCost { + self.to_inner_request().calculate_costs() + } + + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().kinovi_credits as u32 + } + + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().usd_cents_rounded_up + } + + pub(crate) fn to_inner_request(&self) -> KinoviGenerateImageRequest { + KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7Niji, + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.as_api_str().to_string(), + negative_prompt: self.negative_prompt.clone(), + stylize: self.stylize, + weird: self.weird, + chaos: self.chaos, + quality: self.quality.map(|q| q.as_api_str().to_string()), + raw_mode: self.raw_mode, + batch_count: self.batch_count, + reference_image_urls: self.reference_image_urls.clone(), + } + } +} + +// ── Model-specific enums ── + +/// Aspect ratios supported by Midjourney v7 Niji. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum GenerateMidjourneyV7NijiAspectRatio { + Square1x1, + Landscape16x9, + Portrait9x16, + UltraWide21x9, + UltraTall9x21, + Standard4x3, + Portrait3x4, + Wide5x4, + Tall4x5, + Wide3x2, + Tall2x3, +} + +impl GenerateMidjourneyV7NijiAspectRatio { + fn as_api_str(&self) -> &'static str { + match self { + Self::Square1x1 => "1:1", + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::UltraWide21x9 => "21:9", + Self::UltraTall9x21 => "9:21", + Self::Standard4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Wide5x4 => "5:4", + Self::Tall4x5 => "4:5", + Self::Wide3x2 => "3:2", + Self::Tall2x3 => "2:3", + } + } +} + +/// Quality presets supported by Midjourney v7 Niji. Higher = more compute +/// and slower; Kinovi credit pricing is flat regardless. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum GenerateMidjourneyV7NijiQuality { + /// 0.25 + Quarter, + /// 0.5 + Half, + /// 1 (default) + Full, +} + +impl GenerateMidjourneyV7NijiQuality { + fn as_api_str(&self) -> &'static str { + match self { + Self::Quarter => "0.25", + Self::Half => "0.5", + Self::Full => "1", + } + } +} + +// ── Response ── + +pub struct GenerateMidjourneyV7NijiResponse { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_midjourney_v7_niji( + args: GenerateMidjourneyV7NijiArgs<'_>, +) -> Result { + let inner_request = args.request.to_inner_request(); + let result = generate_image(GenerateImageArgs { + request: inner_request, + session: args.session, + host_override: args.host_override, + }).await?; + Ok(GenerateMidjourneyV7NijiResponse { + task_id: result.task_id, + order_id: result.order_id, + task_ids: result.task_ids, + order_ids: result.order_ids, + }) +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + fn make_request(batch_count: KinoviMidjourneyBatchCount) -> GenerateMidjourneyV7NijiRequest { + GenerateMidjourneyV7NijiRequest { + prompt: "test".to_string(), + aspect_ratio: GenerateMidjourneyV7NijiAspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count, + reference_image_urls: None, + } + } + + // ── Inner-request mapping ── + + mod inner_request_tests { + use super::*; + + #[test] + fn inner_request_pins_model_to_v7_niji() { + let inner = make_request(KinoviMidjourneyBatchCount::One).to_inner_request(); + assert_eq!(inner.model, KinoviMidjourneyModel::V7Niji); + } + + #[test] + fn inner_request_preserves_all_fields() { + let req = GenerateMidjourneyV7NijiRequest { + prompt: "anime mecha duel".to_string(), + aspect_ratio: GenerateMidjourneyV7NijiAspectRatio::UltraWide21x9, + negative_prompt: Some("blurry".to_string()), + stylize: Some(750), + weird: Some(0), + chaos: Some(25), + quality: Some(GenerateMidjourneyV7NijiQuality::Full), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::Two, + reference_image_urls: Some(vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + ]), + }; + let inner = req.to_inner_request(); + assert_eq!(inner.model, KinoviMidjourneyModel::V7Niji); + assert_eq!(inner.prompt, "anime mecha duel"); + assert_eq!(inner.aspect_ratio, "21:9"); + assert_eq!(inner.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(inner.stylize, Some(750)); + assert_eq!(inner.weird, Some(0)); + assert_eq!(inner.chaos, Some(25)); + assert_eq!(inner.quality.as_deref(), Some("1")); + assert!(!inner.raw_mode); + assert_eq!(inner.batch_count, KinoviMidjourneyBatchCount::Two); + assert_eq!(inner.reference_image_urls.as_ref().map(|v| v.len()), Some(2)); + } + + /// Every wrapper-side aspect ratio must serialize to the canonical wire string. + #[test] + fn every_aspect_ratio_maps_to_canonical_wire_string() { + let cases = [ + (GenerateMidjourneyV7NijiAspectRatio::Square1x1, "1:1"), + (GenerateMidjourneyV7NijiAspectRatio::Landscape16x9, "16:9"), + (GenerateMidjourneyV7NijiAspectRatio::Portrait9x16, "9:16"), + (GenerateMidjourneyV7NijiAspectRatio::UltraWide21x9, "21:9"), + (GenerateMidjourneyV7NijiAspectRatio::UltraTall9x21, "9:21"), + (GenerateMidjourneyV7NijiAspectRatio::Standard4x3, "4:3"), + (GenerateMidjourneyV7NijiAspectRatio::Portrait3x4, "3:4"), + (GenerateMidjourneyV7NijiAspectRatio::Wide5x4, "5:4"), + (GenerateMidjourneyV7NijiAspectRatio::Tall4x5, "4:5"), + (GenerateMidjourneyV7NijiAspectRatio::Wide3x2, "3:2"), + (GenerateMidjourneyV7NijiAspectRatio::Tall2x3, "2:3"), + ]; + for (variant, expected) in cases { + let req = GenerateMidjourneyV7NijiRequest { aspect_ratio: variant, ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.to_inner_request().aspect_ratio, expected, "variant={:?}", variant); + } + } + + #[test] + fn every_quality_maps_to_canonical_wire_string() { + let cases = [ + (GenerateMidjourneyV7NijiQuality::Quarter, "0.25"), + (GenerateMidjourneyV7NijiQuality::Half, "0.5"), + (GenerateMidjourneyV7NijiQuality::Full, "1"), + ]; + for (variant, expected) in cases { + let req = GenerateMidjourneyV7NijiRequest { quality: Some(variant), ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.to_inner_request().quality.as_deref(), Some(expected), "variant={:?}", variant); + } + } + } + + // ── Pricing ── + + mod pricing_tests { + use super::*; + + #[test] + fn batch_one_is_twelve_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits, 12); + } + + #[test] + fn batch_two_is_twentyfour_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().kinovi_credits, 24); + } + + #[test] + fn batch_three_is_thirtysix_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Three).calculate_costs().kinovi_credits, 36); + } + + #[test] + fn batch_four_is_fortyeight_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().kinovi_credits, 48); + } + + #[test] + fn usd_cents_batch_one_is_five() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_up, 5); // 1200/243 = 4.94 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_down, 4); + assert!((make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_fractional - (1200.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_batch_four_is_twenty() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_up, 20); // 4800/243 = 19.75 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_down, 19); + assert!((make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_fractional - (4800.0 / 243.0)).abs() < 1e-9); + } + + /// Pricing must match the inner module exactly. + #[test] + fn matches_inner_pricing_exactly() { + for batch in [ + KinoviMidjourneyBatchCount::One, + KinoviMidjourneyBatchCount::Two, + KinoviMidjourneyBatchCount::Three, + KinoviMidjourneyBatchCount::Four, + ] { + let outer = make_request(batch); + let inner = outer.to_inner_request(); + assert_eq!(outer.calculate_costs().kinovi_credits, inner.calculate_costs().kinovi_credits, "batch={:?}", batch); + assert_eq!(outer.calculate_costs().usd_cents_rounded_up, inner.calculate_costs().usd_cents_rounded_up, "batch={:?}", batch); + } + } + } + + // ── Real requests ── + + mod real_requests { + use super::*; + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v7_niji_anime() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_midjourney_v7_niji(GenerateMidjourneyV7NijiArgs { + session: &session, + host_override: None, + request: GenerateMidjourneyV7NijiRequest { + prompt: "A magical shiba inu sorcerer casting spells in a crystal cave".to_string(), + aspect_ratio: GenerateMidjourneyV7NijiAspectRatio::UltraWide21x9, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }).await?; + println!("v7-niji — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + Ok(()) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v8.rs b/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v8.rs new file mode 100644 index 00000000..4ab6a911 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/image/generate_midjourney_v8.rs @@ -0,0 +1,406 @@ +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::generate_image::generate_image::{ + generate_image, GenerateImageArgs, KinoviGenerateImageRequest, KinoviMidjourneyModel, +}; +use crate::requests::kinovi_host::KinoviHost; + +// `KinoviMidjourneyBatchCount` is shared across all Midjourney models, so we +// re-export it from the base. Aspect ratio and quality, however, are pinned +// to model-specific enums on this wrapper to keep their valid values typed +// at the call site. +pub use crate::requests::generate_image::generate_image::KinoviMidjourneyBatchCount; + +// ── Args ── + +pub struct GenerateMidjourneyV8Args<'a> { + pub request: GenerateMidjourneyV8Request, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateMidjourneyV8Request { + pub prompt: String, + pub aspect_ratio: GenerateMidjourneyV8AspectRatio, + pub negative_prompt: Option, + pub stylize: Option, + pub weird: Option, + pub chaos: Option, + pub quality: Option, + pub raw_mode: bool, + pub batch_count: KinoviMidjourneyBatchCount, + pub reference_image_urls: Option>, +} + +impl GenerateMidjourneyV8Request { + /// Calculate the cost of this request, in Kinovi credits and USD cents + /// (rounded up). + pub fn calculate_costs(&self) -> KinoviGenerationCost { + self.to_inner_request().calculate_costs() + } + + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().kinovi_credits as u32 + } + + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().usd_cents_rounded_up + } + + pub(crate) fn to_inner_request(&self) -> KinoviGenerateImageRequest { + KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V8, + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio.as_api_str().to_string(), + negative_prompt: self.negative_prompt.clone(), + stylize: self.stylize, + weird: self.weird, + chaos: self.chaos, + quality: self.quality.map(|q| q.as_api_str().to_string()), + raw_mode: self.raw_mode, + batch_count: self.batch_count, + reference_image_urls: self.reference_image_urls.clone(), + } + } +} + +// ── Model-specific enums ── + +/// Aspect ratios supported by Midjourney v8. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum GenerateMidjourneyV8AspectRatio { + Square1x1, + Landscape16x9, + Portrait9x16, + UltraWide21x9, + UltraTall9x21, + Standard4x3, + Portrait3x4, + Wide5x4, + Tall4x5, + Wide3x2, + Tall2x3, +} + +impl GenerateMidjourneyV8AspectRatio { + fn as_api_str(&self) -> &'static str { + match self { + Self::Square1x1 => "1:1", + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::UltraWide21x9 => "21:9", + Self::UltraTall9x21 => "9:21", + Self::Standard4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Wide5x4 => "5:4", + Self::Tall4x5 => "4:5", + Self::Wide3x2 => "3:2", + Self::Tall2x3 => "2:3", + } + } +} + +/// Quality presets supported by Midjourney v8. Higher = more compute and +/// slower; Kinovi credit pricing is flat regardless. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum GenerateMidjourneyV8Quality { + /// 0.25 + Quarter, + /// 0.5 + Half, + /// 1 (default) + Full, +} + +impl GenerateMidjourneyV8Quality { + fn as_api_str(&self) -> &'static str { + match self { + Self::Quarter => "0.25", + Self::Half => "0.5", + Self::Full => "1", + } + } +} + +// ── Response ── + +pub struct GenerateMidjourneyV8Response { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_midjourney_v8( + args: GenerateMidjourneyV8Args<'_>, +) -> Result { + let inner_request = args.request.to_inner_request(); + let result = generate_image(GenerateImageArgs { + request: inner_request, + session: args.session, + host_override: args.host_override, + }).await?; + Ok(GenerateMidjourneyV8Response { + task_id: result.task_id, + order_id: result.order_id, + task_ids: result.task_ids, + order_ids: result.order_ids, + }) +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + fn make_request(batch_count: KinoviMidjourneyBatchCount) -> GenerateMidjourneyV8Request { + GenerateMidjourneyV8Request { + prompt: "test".to_string(), + aspect_ratio: GenerateMidjourneyV8AspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count, + reference_image_urls: None, + } + } + + // ── Inner-request mapping ── + + mod inner_request_tests { + use super::*; + + #[test] + fn inner_request_pins_model_to_v8() { + let inner = make_request(KinoviMidjourneyBatchCount::One).to_inner_request(); + assert_eq!(inner.model, KinoviMidjourneyModel::V8); + } + + #[test] + fn inner_request_preserves_all_fields() { + let req = GenerateMidjourneyV8Request { + prompt: "abandoned k-mart, overgrown vines".to_string(), + aspect_ratio: GenerateMidjourneyV8AspectRatio::Portrait9x16, + negative_prompt: Some("dark, gloomy".to_string()), + stylize: Some(730), + weird: Some(2050), + chaos: Some(70), + quality: Some(GenerateMidjourneyV8Quality::Half), + raw_mode: true, + batch_count: KinoviMidjourneyBatchCount::Four, + reference_image_urls: Some(vec!["https://example.com/ref.jpg".to_string()]), + }; + let inner = req.to_inner_request(); + assert_eq!(inner.model, KinoviMidjourneyModel::V8); + assert_eq!(inner.prompt, "abandoned k-mart, overgrown vines"); + assert_eq!(inner.aspect_ratio, "9:16"); + assert_eq!(inner.negative_prompt.as_deref(), Some("dark, gloomy")); + assert_eq!(inner.stylize, Some(730)); + assert_eq!(inner.weird, Some(2050)); + assert_eq!(inner.chaos, Some(70)); + assert_eq!(inner.quality.as_deref(), Some("0.5")); + assert!(inner.raw_mode); + assert_eq!(inner.batch_count, KinoviMidjourneyBatchCount::Four); + assert_eq!(inner.reference_image_urls.as_ref().map(|v| v.len()), Some(1)); + } + + /// Every wrapper-side aspect ratio must serialize to the canonical wire string. + #[test] + fn every_aspect_ratio_maps_to_canonical_wire_string() { + let cases = [ + (GenerateMidjourneyV8AspectRatio::Square1x1, "1:1"), + (GenerateMidjourneyV8AspectRatio::Landscape16x9, "16:9"), + (GenerateMidjourneyV8AspectRatio::Portrait9x16, "9:16"), + (GenerateMidjourneyV8AspectRatio::UltraWide21x9, "21:9"), + (GenerateMidjourneyV8AspectRatio::UltraTall9x21, "9:21"), + (GenerateMidjourneyV8AspectRatio::Standard4x3, "4:3"), + (GenerateMidjourneyV8AspectRatio::Portrait3x4, "3:4"), + (GenerateMidjourneyV8AspectRatio::Wide5x4, "5:4"), + (GenerateMidjourneyV8AspectRatio::Tall4x5, "4:5"), + (GenerateMidjourneyV8AspectRatio::Wide3x2, "3:2"), + (GenerateMidjourneyV8AspectRatio::Tall2x3, "2:3"), + ]; + for (variant, expected) in cases { + let req = GenerateMidjourneyV8Request { aspect_ratio: variant, ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.to_inner_request().aspect_ratio, expected, "variant={:?}", variant); + } + } + + #[test] + fn every_quality_maps_to_canonical_wire_string() { + let cases = [ + (GenerateMidjourneyV8Quality::Quarter, "0.25"), + (GenerateMidjourneyV8Quality::Half, "0.5"), + (GenerateMidjourneyV8Quality::Full, "1"), + ]; + for (variant, expected) in cases { + let req = GenerateMidjourneyV8Request { quality: Some(variant), ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.to_inner_request().quality.as_deref(), Some(expected), "variant={:?}", variant); + } + } + } + + // ── Pricing ── + + mod pricing_tests { + use super::*; + + #[test] + fn batch_one_is_twelve_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits, 12); + } + + #[test] + fn batch_two_is_twentyfour_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().kinovi_credits, 24); + } + + #[test] + fn batch_three_is_thirtysix_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Three).calculate_costs().kinovi_credits, 36); + } + + #[test] + fn batch_four_is_fortyeight_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().kinovi_credits, 48); + } + + #[test] + fn usd_cents_batch_one_is_five() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_up, 5); // 1200/243 = 4.94 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_down, 4); + assert!((make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_fractional - (1200.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_batch_four_is_twenty() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_up, 20); // 4800/243 = 19.75 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_down, 19); + assert!((make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_fractional - (4800.0 / 243.0)).abs() < 1e-9); + } + + /// Pricing must match the inner module exactly. + #[test] + fn matches_inner_pricing_exactly() { + for batch in [ + KinoviMidjourneyBatchCount::One, + KinoviMidjourneyBatchCount::Two, + KinoviMidjourneyBatchCount::Three, + KinoviMidjourneyBatchCount::Four, + ] { + let outer = make_request(batch); + let inner = outer.to_inner_request(); + assert_eq!(outer.calculate_costs().kinovi_credits, inner.calculate_costs().kinovi_credits, "batch={:?}", batch); + assert_eq!(outer.calculate_costs().usd_cents_rounded_up, inner.calculate_costs().usd_cents_rounded_up, "batch={:?}", batch); + } + } + } + + // ── Real requests ── + + mod real_requests { + use super::*; + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v8_minimal() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_midjourney_v8(GenerateMidjourneyV8Args { + session: &session, + host_override: None, + request: GenerateMidjourneyV8Request { + prompt: "spooky horror scene, ghosts".to_string(), + aspect_ratio: GenerateMidjourneyV8AspectRatio::Portrait9x16, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: Some(GenerateMidjourneyV8Quality::Full), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }).await?; + println!("v8 minimal — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs 48 credits + async fn test_generate_v8_batch_4() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_midjourney_v8(GenerateMidjourneyV8Args { + session: &session, + host_override: None, + request: GenerateMidjourneyV8Request { + prompt: "desolate cliff overlooking the ocean".to_string(), + aspect_ratio: GenerateMidjourneyV8AspectRatio::Portrait9x16, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: Some(GenerateMidjourneyV8Quality::Full), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::Four, + reference_image_urls: None, + }, + }).await?; + println!("v8 batch-4 — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(result.task_ids.as_ref().map(|v| v.len()), Some(4)); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v8_with_reference_image() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_midjourney_v8(GenerateMidjourneyV8Args { + session: &session, + host_override: None, + request: GenerateMidjourneyV8Request { + prompt: "spooky horror scene, ghosts".to_string(), + aspect_ratio: GenerateMidjourneyV8AspectRatio::Portrait9x16, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: Some(GenerateMidjourneyV8Quality::Full), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260602/1780380104765-10cec276.jpg".to_string(), + ]), + }, + }).await?; + println!("v8 with ref image — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + Ok(()) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/image/generate_seedream_5p0_pro.rs b/crates/api_clients/seedance2pro_client/src/generate/image/generate_seedream_5p0_pro.rs new file mode 100644 index 00000000..77ec2c67 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/image/generate_seedream_5p0_pro.rs @@ -0,0 +1,620 @@ +use serde_derive::Serialize; + +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task_custom, WorkflowRunTaskCustomArgs, WorkflowRunTaskResponse, +}; + +const BUSINESS_TYPE: &str = "seedream-5-pro-image-generation"; +const MODEL: &str = "seedream-5.0-pro"; + +/// Kinovi allows at most this many reference images per request. +pub const MAX_REFERENCE_IMAGES: usize = 14; + +/// Credits per generated image at 1k resolution. +const CREDITS_PER_IMAGE_1K: u64 = 14; + +/// Credits per generated image at 2k resolution. +const CREDITS_PER_IMAGE_2K: u64 = 24; + +// ── Args ── + +pub struct GenerateSeedream5p0ProArgs<'a> { + pub request: GenerateSeedream5p0ProRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +/// Seedream 5.0 Pro: text-to-image (optionally with reference images). +#[derive(Clone, Debug)] +pub struct GenerateSeedream5p0ProRequest { + /// Reference images are cited in the prompt as @Image1, @Image2, etc. + pub prompt: String, + + pub aspect_ratio: KinoviSeedream5p0ProAspectRatio, + + pub resolution: KinoviSeedream5p0ProResolution, + + /// Number of images to generate in a single request. + pub batch_count: KinoviSeedream5p0ProBatchCount, + + /// Optional reference image URLs, up to [`MAX_REFERENCE_IMAGES`]. + /// Referenced in prompts as @Image1, @Image2, etc. + pub reference_image_urls: Option>, +} + +// ── Enums ── + +/// Aspect ratios supported by Seedream 5.0 Pro. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum KinoviSeedream5p0ProAspectRatio { + /// Let the model pick (useful with reference images). + Auto, + Square1x1, + Standard4x3, + Portrait3x4, + Landscape16x9, + Portrait9x16, + Wide3x2, + Tall2x3, + UltraWide21x9, +} + +/// Output resolution. Determines the per-image credit price. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum KinoviSeedream5p0ProResolution { + /// 1k (14 credits per image) + OneK, + /// 2k (24 credits per image) + TwoK, +} + +/// Number of images to generate in a single request. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum KinoviSeedream5p0ProBatchCount { + One, + Two, + Three, + Four, + Five, + Six, + Seven, + Eight, +} + +// ── Pricing ── +// +// Seedream 5.0 Pro credit pricing (per image; batch count multiplies): +// +// | Resolution | Credits/image | +// |------------|---------------| +// | 1k | 14 | +// | 2k | 24 | +// +// Reference images do not affect cost. +// Credit package: 525,000 credits for $2,159.0909 (~243.16 credits/$1, rounded down to 243). + +impl GenerateSeedream5p0ProRequest { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents. + pub fn calculate_costs(&self) -> KinoviGenerationCost { + let credits_per_image = match self.resolution { + KinoviSeedream5p0ProResolution::OneK => CREDITS_PER_IMAGE_1K, + KinoviSeedream5p0ProResolution::TwoK => CREDITS_PER_IMAGE_2K, + }; + let total_credits = credits_per_image * u64::from(self.batch_count.as_u8()); + KinoviGenerationCost::from_kinovi_credits(total_credits) + } +} + +impl KinoviSeedream5p0ProBatchCount { + fn as_u8(&self) -> u8 { + match self { + Self::One => 1, + Self::Two => 2, + Self::Three => 3, + Self::Four => 4, + Self::Five => 5, + Self::Six => 6, + Self::Seven => 7, + Self::Eight => 8, + } + } +} + +impl KinoviSeedream5p0ProAspectRatio { + fn as_api_str(&self) -> &'static str { + match self { + Self::Auto => "auto", + Self::Square1x1 => "1:1", + Self::Standard4x3 => "4:3", + Self::Portrait3x4 => "3:4", + Self::Landscape16x9 => "16:9", + Self::Portrait9x16 => "9:16", + Self::Wide3x2 => "3:2", + Self::Tall2x3 => "2:3", + Self::UltraWide21x9 => "21:9", + } + } +} + +impl KinoviSeedream5p0ProResolution { + fn as_api_str(&self) -> &'static str { + match self { + Self::OneK => "1k", + Self::TwoK => "2k", + } + } +} + +// ── Response ── + +pub struct GenerateSeedream5p0ProResponse { + pub task_id: String, + pub order_id: String, + + /// Present when batch_count > 1. + pub task_ids: Option>, + + /// Present when batch_count > 1. + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_seedream_5p0_pro( + args: GenerateSeedream5p0ProArgs<'_>, +) -> Result { + let api_params = build_api_params(&args.request)?; + + let raw_response: WorkflowRunTaskResponse = workflow_run_task_custom(WorkflowRunTaskCustomArgs { + business_type: BUSINESS_TYPE, + api_params, + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSeedream5p0ProResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + task_ids: raw_response.task_ids, + order_ids: raw_response.order_ids, + }) +} + +// ── Wire payload ── + +/// The `apiParams` shape for `seedream-5-pro-image-generation`. Field order +/// matches the captured browser traffic. +#[derive(Serialize, Debug)] +struct Seedream5p0ProApiParams { + prompt: String, + #[serde(rename = "aspectRatio")] + aspect_ratio: &'static str, + resolution: &'static str, + model: &'static str, + /// Omitted when generating a single image. + #[serde(rename = "batchCount", skip_serializing_if = "Option::is_none")] + batch_count: Option, + /// Omitted when no reference images are attached. + #[serde(rename = "uploadedUrls", skip_serializing_if = "Option::is_none")] + uploaded_urls: Option>, +} + +fn build_api_params( + request: &GenerateSeedream5p0ProRequest, +) -> Result { + let uploaded_urls = match &request.reference_image_urls { + Some(urls) if urls.len() > MAX_REFERENCE_IMAGES => { + return Err(Seedance2ProClientError::InvalidRequestField { + field: "reference_image_urls", + raw_value: format!("{} urls", urls.len()), + reason: format!("At most {} reference images are allowed", MAX_REFERENCE_IMAGES), + }); + } + Some(urls) if !urls.is_empty() => Some(urls.clone()), + _ => None, + }; + + let batch_count_value = request.batch_count.as_u8(); + let batch_count = if batch_count_value > 1 { Some(batch_count_value) } else { None }; + + Ok(Seedream5p0ProApiParams { + prompt: request.prompt.clone(), + aspect_ratio: request.aspect_ratio.as_api_str(), + resolution: request.resolution.as_api_str(), + model: MODEL, + batch_count, + uploaded_urls, + }) +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + + fn base_request() -> GenerateSeedream5p0ProRequest { + GenerateSeedream5p0ProRequest { + prompt: "An anime girl riding a dinosaur".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Auto, + resolution: KinoviSeedream5p0ProResolution::TwoK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + reference_image_urls: None, + } + } + + mod request_shape_tests { + use super::*; + + /// Mirrors capture 1_seedream_5.txt (auto aspect ratio, 2k, single image, + /// no references). + #[test] + fn auto_2k_single_image() { + let params = build_api_params(&base_request()).unwrap(); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"prompt":"An anime girl riding a dinosaur","aspectRatio":"auto","resolution":"2k","model":"seedream-5.0-pro"}"#, + ); + } + + /// Mirrors capture 2_seedream_5_21x9.txt (21:9, 2k, single image). + #[test] + fn ultra_wide_21x9_2k() { + let params = build_api_params(&GenerateSeedream5p0ProRequest { + prompt: "a pirate sailing a pirate ship".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::UltraWide21x9, + resolution: KinoviSeedream5p0ProResolution::TwoK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + reference_image_urls: None, + }).unwrap(); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"prompt":"a pirate sailing a pirate ship","aspectRatio":"21:9","resolution":"2k","model":"seedream-5.0-pro"}"#, + ); + } + + /// Mirrors capture 3_seedream_5_9x16_image_refs.txt (9:16, 1k, single + /// image, two reference images). + #[test] + fn portrait_9x16_1k_with_image_references() { + let params = build_api_params(&GenerateSeedream5p0ProRequest { + prompt: "The man in @Image1 is staring out the door in @Image2 ".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Portrait9x16, + resolution: KinoviSeedream5p0ProResolution::OneK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260713/1783904468032-0a803390.jpg".to_string(), + "https://static.seedance2-pro.com/materials/20260713/1783904481112-4a3fa0d2.png".to_string(), + ]), + }).unwrap(); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"prompt":"The man in @Image1 is staring out the door in @Image2 ","aspectRatio":"9:16","resolution":"1k","model":"seedream-5.0-pro","uploadedUrls":["https://static.seedance2-pro.com/materials/20260713/1783904468032-0a803390.jpg","https://static.seedance2-pro.com/materials/20260713/1783904481112-4a3fa0d2.png"]}"#, + ); + } + + /// Mirrors capture 4_seedream_5_misc.txt (2:3, 2k, batch of 4, two + /// reference images). + #[test] + fn tall_2x3_2k_batch_four_with_image_references() { + let params = build_api_params(&GenerateSeedream5p0ProRequest { + prompt: "An anime girl is standing in the door @Image1 Outside the door, there's the galaxy and windmill @Image2 ".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Tall2x3, + resolution: KinoviSeedream5p0ProResolution::TwoK, + batch_count: KinoviSeedream5p0ProBatchCount::Four, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260713/1783904481112-4a3fa0d2.png".to_string(), + "https://static.seedance2-pro.com/materials/20260713/1783904588294-5c713908.jpg".to_string(), + ]), + }).unwrap(); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"prompt":"An anime girl is standing in the door @Image1 Outside the door, there's the galaxy and windmill @Image2 ","aspectRatio":"2:3","resolution":"2k","model":"seedream-5.0-pro","batchCount":4,"uploadedUrls":["https://static.seedance2-pro.com/materials/20260713/1783904481112-4a3fa0d2.png","https://static.seedance2-pro.com/materials/20260713/1783904588294-5c713908.jpg"]}"#, + ); + } + + /// Mirrors capture 5_seedream_5_misc2.txt (1:1, 1k, batch of 8, two + /// reference images). + #[test] + fn square_1x1_1k_batch_eight_with_image_references() { + let params = build_api_params(&GenerateSeedream5p0ProRequest { + prompt: "The mirror from @Image2 is in front of the windmill in @Image1 . The sky and galaxy are lit up at night. ".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Square1x1, + resolution: KinoviSeedream5p0ProResolution::OneK, + batch_count: KinoviSeedream5p0ProBatchCount::Eight, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260713/1783904715554-1a7ce415.jpg".to_string(), + "https://static.seedance2-pro.com/materials/20260713/1783904719453-1d10e81f.png".to_string(), + ]), + }).unwrap(); + assert_eq!( + serde_json::to_string(¶ms).unwrap(), + r#"{"prompt":"The mirror from @Image2 is in front of the windmill in @Image1 . The sky and galaxy are lit up at night. ","aspectRatio":"1:1","resolution":"1k","model":"seedream-5.0-pro","batchCount":8,"uploadedUrls":["https://static.seedance2-pro.com/materials/20260713/1783904715554-1a7ce415.jpg","https://static.seedance2-pro.com/materials/20260713/1783904719453-1d10e81f.png"]}"#, + ); + } + + #[test] + fn every_aspect_ratio_wire_value() { + let cases = [ + (KinoviSeedream5p0ProAspectRatio::Auto, "auto"), + (KinoviSeedream5p0ProAspectRatio::Square1x1, "1:1"), + (KinoviSeedream5p0ProAspectRatio::Standard4x3, "4:3"), + (KinoviSeedream5p0ProAspectRatio::Portrait3x4, "3:4"), + (KinoviSeedream5p0ProAspectRatio::Landscape16x9, "16:9"), + (KinoviSeedream5p0ProAspectRatio::Portrait9x16, "9:16"), + (KinoviSeedream5p0ProAspectRatio::Wide3x2, "3:2"), + (KinoviSeedream5p0ProAspectRatio::Tall2x3, "2:3"), + (KinoviSeedream5p0ProAspectRatio::UltraWide21x9, "21:9"), + ]; + for (variant, expected) in cases { + assert_eq!(variant.as_api_str(), expected, "wire value for {variant:?}"); + } + } + + #[test] + fn every_resolution_wire_value() { + assert_eq!(KinoviSeedream5p0ProResolution::OneK.as_api_str(), "1k"); + assert_eq!(KinoviSeedream5p0ProResolution::TwoK.as_api_str(), "2k"); + } + + #[test] + fn every_batch_count_value() { + let cases = [ + (KinoviSeedream5p0ProBatchCount::One, 1), + (KinoviSeedream5p0ProBatchCount::Two, 2), + (KinoviSeedream5p0ProBatchCount::Three, 3), + (KinoviSeedream5p0ProBatchCount::Four, 4), + (KinoviSeedream5p0ProBatchCount::Five, 5), + (KinoviSeedream5p0ProBatchCount::Six, 6), + (KinoviSeedream5p0ProBatchCount::Seven, 7), + (KinoviSeedream5p0ProBatchCount::Eight, 8), + ]; + for (variant, expected) in cases { + assert_eq!(variant.as_u8(), expected, "value for {variant:?}"); + } + } + + #[test] + fn batch_count_one_omits_field() { + let params = build_api_params(&base_request()).unwrap(); + assert_eq!(params.batch_count, None); + } + + #[test] + fn empty_reference_list_omits_uploaded_urls() { + let params = build_api_params(&GenerateSeedream5p0ProRequest { + reference_image_urls: Some(vec![]), + ..base_request() + }).unwrap(); + let json = serde_json::to_string(¶ms).unwrap(); + assert!(!json.contains("uploadedUrls"), "expected no uploadedUrls in {json}"); + } + + #[test] + fn business_type() { + assert_eq!(BUSINESS_TYPE, "seedream-5-pro-image-generation"); + } + } + + mod reference_image_limit_tests { + use super::*; + + #[test] + fn fourteen_references_is_allowed() { + let params = build_api_params(&request_with_n_references(MAX_REFERENCE_IMAGES)).unwrap(); + assert_eq!(params.uploaded_urls.map(|urls| urls.len()), Some(MAX_REFERENCE_IMAGES)); + } + + #[test] + fn fifteen_references_is_rejected() { + let result = build_api_params(&request_with_n_references(MAX_REFERENCE_IMAGES + 1)); + match result { + Err(Seedance2ProClientError::InvalidRequestField { field, .. }) => { + assert_eq!(field, "reference_image_urls"); + } + other => panic!("expected InvalidRequestField, got {other:?}"), + } + } + + fn request_with_n_references(count: usize) -> GenerateSeedream5p0ProRequest { + GenerateSeedream5p0ProRequest { + reference_image_urls: Some( + (0..count).map(|i| format!("https://example.com/ref{i}.jpg")).collect(), + ), + ..base_request() + } + } + } + + // ── Pricing ── + // + // 1k = 14 credits/image, 2k = 24 credits/image; batch count multiplies. + // Verified against captured traffic: 2k x 4 images = 96 credits + // (4_seedream_5_misc.txt), 1k x 8 images = 112 credits + // (5_seedream_5_misc2.txt). + + mod pricing_tests { + use super::*; + + #[test] + fn one_1k_image_is_fourteen_credits() { + let costs = request(KinoviSeedream5p0ProResolution::OneK, KinoviSeedream5p0ProBatchCount::One).calculate_costs(); + assert_eq!(costs.kinovi_credits, 14); + } + + #[test] + fn one_2k_image_is_twentyfour_credits() { + let costs = request(KinoviSeedream5p0ProResolution::TwoK, KinoviSeedream5p0ProBatchCount::One).calculate_costs(); + assert_eq!(costs.kinovi_credits, 24); + } + + /// Mirrors capture 4_seedream_5_misc.txt: 2k, batch of 4 → 96 credits. + #[test] + fn four_2k_images_is_ninetysix_credits() { + let costs = request(KinoviSeedream5p0ProResolution::TwoK, KinoviSeedream5p0ProBatchCount::Four).calculate_costs(); + assert_eq!(costs.kinovi_credits, 96); + } + + /// Mirrors capture 5_seedream_5_misc2.txt: 1k, batch of 8 → 112 credits. + #[test] + fn eight_1k_images_is_one_hundred_twelve_credits() { + let costs = request(KinoviSeedream5p0ProResolution::OneK, KinoviSeedream5p0ProBatchCount::Eight).calculate_costs(); + assert_eq!(costs.kinovi_credits, 112); + } + + #[test] + fn usd_cents_one_1k_image() { + // 14 credits; 1400/243 = 5.7613… → up 6¢, down 5¢. + let costs = request(KinoviSeedream5p0ProResolution::OneK, KinoviSeedream5p0ProBatchCount::One).calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 6); + assert_eq!(costs.usd_cents_rounded_down, 5); + assert!((costs.usd_cents_fractional - (1400.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_one_2k_image() { + // 24 credits; 2400/243 = 9.8765… → up 10¢, down 9¢. + let costs = request(KinoviSeedream5p0ProResolution::TwoK, KinoviSeedream5p0ProBatchCount::One).calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 10); + assert_eq!(costs.usd_cents_rounded_down, 9); + assert!((costs.usd_cents_fractional - (2400.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_eight_1k_images() { + // 112 credits; 11200/243 = 46.0905… → up 47¢, down 46¢. + let costs = request(KinoviSeedream5p0ProResolution::OneK, KinoviSeedream5p0ProBatchCount::Eight).calculate_costs(); + assert_eq!(costs.usd_cents_rounded_up, 47); + assert_eq!(costs.usd_cents_rounded_down, 46); + assert!((costs.usd_cents_fractional - (11200.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn reference_images_do_not_affect_cost() { + let without_refs = request(KinoviSeedream5p0ProResolution::TwoK, KinoviSeedream5p0ProBatchCount::Four).calculate_costs(); + let with_refs = GenerateSeedream5p0ProRequest { + reference_image_urls: Some(vec![ + "https://example.com/ref1.jpg".to_string(), + "https://example.com/ref2.jpg".to_string(), + ]), + ..request(KinoviSeedream5p0ProResolution::TwoK, KinoviSeedream5p0ProBatchCount::Four) + }.calculate_costs(); + assert_eq!(without_refs, with_refs); + } + + #[test] + fn aspect_ratio_does_not_affect_cost() { + let auto = request(KinoviSeedream5p0ProResolution::OneK, KinoviSeedream5p0ProBatchCount::One).calculate_costs(); + let ultra_wide = GenerateSeedream5p0ProRequest { + aspect_ratio: KinoviSeedream5p0ProAspectRatio::UltraWide21x9, + ..request(KinoviSeedream5p0ProResolution::OneK, KinoviSeedream5p0ProBatchCount::One) + }.calculate_costs(); + assert_eq!(auto, ultra_wide); + } + + fn request( + resolution: KinoviSeedream5p0ProResolution, + batch_count: KinoviSeedream5p0ProBatchCount, + ) -> GenerateSeedream5p0ProRequest { + GenerateSeedream5p0ProRequest { + resolution, + batch_count, + ..base_request() + } + } + } + + // ── Live usage tests ── + + mod live_tests { + use super::*; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs 24 credits. + async fn test_text_to_image_2k() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedream_5p0_pro(GenerateSeedream5p0ProArgs { + session: &session, + host_override: None, + request: GenerateSeedream5p0ProRequest { + prompt: "A corgi wearing a wizard hat, studio lighting".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Auto, + resolution: KinoviSeedream5p0ProResolution::TwoK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + reference_image_urls: None, + }, + }).await?; + println!("seedream 5.0 pro 2k — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs 14 credits. + async fn test_text_to_image_1k_with_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedream_5p0_pro(GenerateSeedream5p0ProArgs { + session: &session, + host_override: None, + request: GenerateSeedream5p0ProRequest { + prompt: "The man in @Image1 is staring out the door in @Image2".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Portrait9x16, + resolution: KinoviSeedream5p0ProResolution::OneK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260713/1783904468032-0a803390.jpg".to_string(), + "https://static.seedance2-pro.com/materials/20260713/1783904481112-4a3fa0d2.png".to_string(), + ]), + }, + }).await?; + println!("seedream 5.0 pro 1k refs — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs 56 credits. + async fn test_batch_four_1k() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedream_5p0_pro(GenerateSeedream5p0ProArgs { + session: &session, + host_override: None, + request: GenerateSeedream5p0ProRequest { + prompt: "A lighthouse on a cliff at golden hour".to_string(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Landscape16x9, + resolution: KinoviSeedream5p0ProResolution::OneK, + batch_count: KinoviSeedream5p0ProBatchCount::Four, + reference_image_urls: None, + }, + }).await?; + println!("seedream 5.0 pro batch-4 — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(result.task_ids.as_ref().map(|ids| ids.len()), Some(4)); + assert_eq!(result.order_ids.as_ref().map(|ids| ids.len()), Some(4)); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/image/mod.rs b/crates/api_clients/seedance2pro_client/src/generate/image/mod.rs new file mode 100644 index 00000000..0360d403 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/image/mod.rs @@ -0,0 +1,4 @@ +pub mod generate_midjourney_v7; +pub mod generate_midjourney_v7_niji; +pub mod generate_midjourney_v8; +pub mod generate_seedream_5p0_pro; diff --git a/crates/api_clients/seedance2pro_client/src/generate/mod.rs b/crates/api_clients/seedance2pro_client/src/generate/mod.rs new file mode 100644 index 00000000..53475895 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/mod.rs @@ -0,0 +1,3 @@ +pub mod audio; +pub mod image; +pub mod video; diff --git a/crates/api_clients/seedance2pro_client/src/generate/video/generate_happy_horse_1p0.rs b/crates/api_clients/seedance2pro_client/src/generate/video/generate_happy_horse_1p0.rs new file mode 100644 index 00000000..9e019ac2 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/video/generate_happy_horse_1p0.rs @@ -0,0 +1,666 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task, KinoviAspectRatioRaw, KinoviBatchCountRaw, + KinoviModelTypeRaw, KinoviOutputResolutionRaw, WorkflowRunTaskArgs + , WorkflowRunTaskRequest, +}; + +// ── Args ── + +pub struct GenerateHappyHorse1p0Args<'a> { + pub request: GenerateHappyHorse1p0Request, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateHappyHorse1p0Request { + pub prompt: String, + pub aspect_ratio: Option, + pub output_resolution: Option, + pub batch_count: Option, + pub duration_seconds: u8, + pub start_frame_url: Option, +} + +// ── Enums ── + +#[derive(Debug, Clone, Copy)] +pub enum KinoviHappyHorse1p0AspectRatio { + Portrait9x16, + Portrait3x4, + Square1x1, + Landscape4x3, + Landscape16x9, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviHappyHorse1p0OutputResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviHappyHorse1p0BatchCount { + One, + Two, + Four, +} + +// ── Pricing ── +// +// Happy Horse 1.0 credit pricing: +// +// | Resolution | Credits/sec | +// |------------|-------------| +// | 720p | 33 | +// | 1080p | 66 | +// +// Default resolution (None) is 720p. +// Batch count multiplies the total cost. +// Credit package: 525,000 credits for $2,159.0909 (~243.16 credits/$1, rounded down to 243). + +impl GenerateHappyHorse1p0Request { + /// Estimate the credit cost for this generation request. + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents (rounded up). + pub fn calculate_costs(&self) -> KinoviGenerationCost { + let credits_per_second: u64 = match self.output_resolution { + Some(KinoviHappyHorse1p0OutputResolution::TenEightyP) => 66, + Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP) | None => 33, + }; + + let per_video = u64::from(self.duration_seconds) * credits_per_second; + let batch_multiplier: u64 = match self.batch_count { + None | Some(KinoviHappyHorse1p0BatchCount::One) => 1, + Some(KinoviHappyHorse1p0BatchCount::Two) => 2, + Some(KinoviHappyHorse1p0BatchCount::Four) => 4, + }; + + KinoviGenerationCost::from_kinovi_credits(per_video * batch_multiplier) + } + + /// Estimate the credit cost for this generation request. + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().kinovi_credits as u32 + } + + /// Estimate the USD cost in cents for this generation request. + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().usd_cents_rounded_up + } +} + +// ── Response ── + +pub struct GenerateHappyHorse1p0Response { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_happy_horse_1p0( + args: GenerateHappyHorse1p0Args<'_>, +) -> Result { + let req = args.request; + + let raw_request = WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::HappyHorse1p0, + prompt: req.prompt, + aspect_ratio: map_aspect_ratio(req.aspect_ratio), + output_resolution: req.output_resolution.map(map_output_resolution), + batch_count: map_batch_count(req.batch_count), + duration_seconds: req.duration_seconds, + start_frame_url: req.start_frame_url, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: Some(false), + bitrate: None, + }; + + let raw_response = workflow_run_task(WorkflowRunTaskArgs { + request: raw_request, + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateHappyHorse1p0Response { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + task_ids: raw_response.task_ids, + order_ids: raw_response.order_ids, + }) +} + +// ── Mapping helpers ── + +fn map_aspect_ratio(ar: Option) -> KinoviAspectRatioRaw { + match ar { + Some(KinoviHappyHorse1p0AspectRatio::Landscape16x9) => KinoviAspectRatioRaw::Landscape16x9, + Some(KinoviHappyHorse1p0AspectRatio::Portrait9x16) => KinoviAspectRatioRaw::Portrait9x16, + Some(KinoviHappyHorse1p0AspectRatio::Square1x1) => KinoviAspectRatioRaw::Square1x1, + Some(KinoviHappyHorse1p0AspectRatio::Landscape4x3) => KinoviAspectRatioRaw::Landscape4x3, + Some(KinoviHappyHorse1p0AspectRatio::Portrait3x4) => KinoviAspectRatioRaw::Portrait3x4, + None => KinoviAspectRatioRaw::Landscape16x9, + } +} + +fn map_output_resolution(res: KinoviHappyHorse1p0OutputResolution) -> KinoviOutputResolutionRaw { + match res { + KinoviHappyHorse1p0OutputResolution::SevenTwentyP => KinoviOutputResolutionRaw::SevenTwentyP, + KinoviHappyHorse1p0OutputResolution::TenEightyP => KinoviOutputResolutionRaw::TenEightyP, + } +} + +fn map_batch_count(bc: Option) -> KinoviBatchCountRaw { + match bc { + Some(KinoviHappyHorse1p0BatchCount::One) | None => KinoviBatchCountRaw::One, + Some(KinoviHappyHorse1p0BatchCount::Two) => KinoviBatchCountRaw::Two, + Some(KinoviHappyHorse1p0BatchCount::Four) => KinoviBatchCountRaw::Four, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + mod pricing_tests { + use super::*; + + fn make_request( + duration_seconds: u8, + output_resolution: Option, + batch_count: Option, + ) -> GenerateHappyHorse1p0Request { + GenerateHappyHorse1p0Request { + prompt: String::new(), + aspect_ratio: None, + output_resolution, + batch_count, + duration_seconds, + start_frame_url: None, + } + } + + fn r720(dur: u8) -> GenerateHappyHorse1p0Request { + make_request(dur, None, None) + } + + fn r1080(dur: u8) -> GenerateHappyHorse1p0Request { + make_request(dur, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), None) + } + + // ── 720p credits (33 credits/sec) ── + + mod credits_720p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r720(3).calculate_costs().kinovi_credits, 99); + assert_eq!(r720(4).calculate_costs().kinovi_credits, 132); + assert_eq!(r720(5).calculate_costs().kinovi_credits, 165); + assert_eq!(r720(6).calculate_costs().kinovi_credits, 198); + assert_eq!(r720(7).calculate_costs().kinovi_credits, 231); + assert_eq!(r720(8).calculate_costs().kinovi_credits, 264); + assert_eq!(r720(9).calculate_costs().kinovi_credits, 297); + assert_eq!(r720(10).calculate_costs().kinovi_credits, 330); + assert_eq!(r720(11).calculate_costs().kinovi_credits, 363); + assert_eq!(r720(12).calculate_costs().kinovi_credits, 396); + assert_eq!(r720(13).calculate_costs().kinovi_credits, 429); + assert_eq!(r720(14).calculate_costs().kinovi_credits, 462); + assert_eq!(r720(15).calculate_costs().kinovi_credits, 495); + } + + #[test] + fn explicit_720p_same_as_default() { + let default = r720(5).calculate_costs().kinovi_credits; + let explicit = make_request(5, Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP), None).calculate_costs().kinovi_credits; + assert_eq!(default, explicit); + } + } + + // ── 1080p credits (66 credits/sec) ── + + mod credits_1080p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r1080(3).calculate_costs().kinovi_credits, 198); + assert_eq!(r1080(4).calculate_costs().kinovi_credits, 264); + assert_eq!(r1080(5).calculate_costs().kinovi_credits, 330); + assert_eq!(r1080(6).calculate_costs().kinovi_credits, 396); + assert_eq!(r1080(7).calculate_costs().kinovi_credits, 462); + assert_eq!(r1080(8).calculate_costs().kinovi_credits, 528); + assert_eq!(r1080(9).calculate_costs().kinovi_credits, 594); + assert_eq!(r1080(10).calculate_costs().kinovi_credits, 660); + assert_eq!(r1080(11).calculate_costs().kinovi_credits, 726); + assert_eq!(r1080(12).calculate_costs().kinovi_credits, 792); + assert_eq!(r1080(13).calculate_costs().kinovi_credits, 858); + assert_eq!(r1080(14).calculate_costs().kinovi_credits, 924); + assert_eq!(r1080(15).calculate_costs().kinovi_credits, 990); + } + } + + // ── Batch multiplier ── + + mod batch_tests { + use super::*; + + #[test] + fn batch_1_is_base() { + let base = r720(5).calculate_costs().kinovi_credits; + let explicit = make_request(5, None, Some(KinoviHappyHorse1p0BatchCount::One)).calculate_costs().kinovi_credits; + assert_eq!(base, explicit); + } + + #[test] + fn batch_2_doubles() { + let base = r720(5).calculate_costs().kinovi_credits; + let batch2 = make_request(5, None, Some(KinoviHappyHorse1p0BatchCount::Two)).calculate_costs().kinovi_credits; + assert_eq!(batch2, base * 2); + } + + #[test] + fn batch_4_quadruples() { + let base = r720(5).calculate_costs().kinovi_credits; + let batch4 = make_request(5, None, Some(KinoviHappyHorse1p0BatchCount::Four)).calculate_costs().kinovi_credits; + assert_eq!(batch4, base * 4); + } + + #[test] + fn batch_multiplier_applies_to_1080p() { + let base = r1080(5).calculate_costs().kinovi_credits; + let batch2 = make_request(5, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), Some(KinoviHappyHorse1p0BatchCount::Two)).calculate_costs().kinovi_credits; + let batch4 = make_request(5, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), Some(KinoviHappyHorse1p0BatchCount::Four)).calculate_costs().kinovi_credits; + assert_eq!(batch2, base * 2); + assert_eq!(batch4, base * 4); + } + } + + // ── Relative pricing ── + + mod relative_tests { + use super::*; + + #[test] + fn r1080p_is_exactly_double_720p() { + for dur in 3..=15u8 { + let c720 = make_request(dur, None, None).calculate_costs().kinovi_credits; + let c1080 = make_request(dur, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), None).calculate_costs().kinovi_credits; + assert_eq!(c1080, c720 * 2, "1080p should be 2× 720p at {}s", dur); + } + } + + #[test] + fn cost_scales_with_duration() { + let c3 = r720(3).calculate_costs().kinovi_credits; + let c10 = r720(10).calculate_costs().kinovi_credits; + let c15 = r720(15).calculate_costs().kinovi_credits; + assert!(c3 < c10); + assert!(c10 < c15); + } + } + + // ── USD cents ── + + mod calculate_costs_tests { + use super::*; + + /// Both fields together: credits and ceil-rounded USD cents. + /// (USD cents are always rounded UP when fractional.) + #[test] + fn costs_720p_5s() { + // 33 credits/s × 5s = 165 credits; 16500/243 = 67.90 → rounds UP to 68¢ + let costs = r720(5).calculate_costs(); + assert_eq!(costs.kinovi_credits, 165); + assert_eq!(costs.usd_cents_rounded_up, 68); + assert_eq!(costs.usd_cents_rounded_down, 67); + assert!((costs.usd_cents_fractional - (16500.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn costs_1080p_5s() { + // 66 credits/s × 5s = 330 credits; 33000/243 = 135.80 → 136¢ + let costs = r1080(5).calculate_costs(); + assert_eq!(costs.kinovi_credits, 330); + assert_eq!(costs.usd_cents_rounded_up, 136); + assert_eq!(costs.usd_cents_rounded_down, 135); + assert!((costs.usd_cents_fractional - (33000.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn costs_720p_15s() { + // 33 credits/s × 15s = 495 credits; 49500/243 = 203.70 → rounds UP to 204¢ + let costs = r720(15).calculate_costs(); + assert_eq!(costs.kinovi_credits, 495); + assert_eq!(costs.usd_cents_rounded_up, 204); + assert_eq!(costs.usd_cents_rounded_down, 203); + assert!((costs.usd_cents_fractional - (49500.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn costs_1080p_15s() { + // 66 credits/s × 15s = 990 credits; 99000/243 = 407.41 → 408¢ + let costs = r1080(15).calculate_costs(); + assert_eq!(costs.kinovi_credits, 990); + assert_eq!(costs.usd_cents_rounded_up, 408); + assert_eq!(costs.usd_cents_rounded_down, 407); + assert!((costs.usd_cents_fractional - (99000.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn costs_batch_2_720p_5s() { + // 165 credits × 2 = 330 credits; 33000/243 = 135.80 → 136¢ + let costs = make_request(5, None, Some(KinoviHappyHorse1p0BatchCount::Two)).calculate_costs(); + assert_eq!(costs.kinovi_credits, 330); + assert_eq!(costs.usd_cents_rounded_up, 136); + assert_eq!(costs.usd_cents_rounded_down, 135); + assert!((costs.usd_cents_fractional - (33000.0 / 243.0)).abs() < 1e-9); + } + + /// The deprecated shims return the corresponding struct fields. + #[test] + #[allow(deprecated)] + fn deprecated_methods_delegate() { + let request = r720(5); + let costs = request.calculate_costs(); + assert_eq!(u64::from(request.estimate_credits()), costs.kinovi_credits); + assert_eq!(request.estimate_cost_in_usd_cents(), costs.usd_cents_rounded_up); + } + } + + // ── Aspect ratio doesn't affect cost ── + + #[test] + fn aspect_ratio_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().kinovi_credits; + + let ratios = [ + KinoviHappyHorse1p0AspectRatio::Landscape16x9, + KinoviHappyHorse1p0AspectRatio::Portrait9x16, + KinoviHappyHorse1p0AspectRatio::Square1x1, + KinoviHappyHorse1p0AspectRatio::Landscape4x3, + KinoviHappyHorse1p0AspectRatio::Portrait3x4, + ]; + + for ar in &ratios { + let req = GenerateHappyHorse1p0Request { + prompt: String::new(), + aspect_ratio: Some(*ar), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + }; + assert_eq!( + req.calculate_costs().kinovi_credits, baseline, + "Aspect ratio {:?} should not change credits from baseline {}", ar, baseline, + ); + } + } + } + + mod text_to_video { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_text_to_video_default() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: "A corgi and a shiba are playing chess against one another".to_string(), + aspect_ratio: None, + output_resolution: None, + batch_count: None, + duration_seconds: 4, + start_frame_url: None, + }, + }).await?; + println!("t2v default — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_text_to_video_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: "A golden retriever running through a field of sunflowers".to_string(), + aspect_ratio: Some(KinoviHappyHorse1p0AspectRatio::Landscape16x9), + output_resolution: Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP), + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + }, + }).await?; + println!("t2v 720p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_text_to_video_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: "A dragon soaring over a medieval castle at sunset".to_string(), + aspect_ratio: Some(KinoviHappyHorse1p0AspectRatio::Landscape16x9), + output_resolution: Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), + batch_count: None, + duration_seconds: 4, + start_frame_url: None, + }, + }).await?; + println!("t2v 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod aspect_ratios { + use super::*; + + async fn test_aspect_ratio(ar: KinoviHappyHorse1p0AspectRatio, label: &str) -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: format!("A cat sitting in a sunbeam ({})", label), + aspect_ratio: Some(ar), + output_resolution: None, + batch_count: None, + duration_seconds: 4, + start_frame_url: None, + }, + }).await?; + println!("{} — task_id={}, order_id={}", label, result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_landscape_16x9() -> AnyhowResult<()> { + test_aspect_ratio(KinoviHappyHorse1p0AspectRatio::Landscape16x9, "16:9").await + } + + #[tokio::test] + #[ignore] + async fn test_portrait_9x16() -> AnyhowResult<()> { + test_aspect_ratio(KinoviHappyHorse1p0AspectRatio::Portrait9x16, "9:16").await + } + + #[tokio::test] + #[ignore] + async fn test_square_1x1() -> AnyhowResult<()> { + test_aspect_ratio(KinoviHappyHorse1p0AspectRatio::Square1x1, "1:1").await + } + + #[tokio::test] + #[ignore] + async fn test_standard_4x3() -> AnyhowResult<()> { + test_aspect_ratio(KinoviHappyHorse1p0AspectRatio::Landscape4x3, "4:3").await + } + + #[tokio::test] + #[ignore] + async fn test_portrait_3x4() -> AnyhowResult<()> { + test_aspect_ratio(KinoviHappyHorse1p0AspectRatio::Portrait3x4, "3:4").await + } + } + + mod keyframe { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_keyframe_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session).await?; + println!("Uploaded start frame: {}", start_frame_url); + + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: "The corgi dog watches the lake as the sun sets.".to_string(), + aspect_ratio: Some(KinoviHappyHorse1p0AspectRatio::Portrait9x16), + output_resolution: Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP), + batch_count: None, + duration_seconds: 8, + start_frame_url: Some(start_frame_url), + }, + }).await?; + println!("keyframe 720p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_keyframe_1080p_square() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session).await?; + println!("Uploaded start frame: {}", start_frame_url); + + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: "A dragon and a raptor fighting on the beach.".to_string(), + aspect_ratio: Some(KinoviHappyHorse1p0AspectRatio::Square1x1), + output_resolution: Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), + batch_count: None, + duration_seconds: 15, + start_frame_url: Some(start_frame_url), + }, + }).await?; + println!("keyframe 1080p square — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_keyframe_landscape_default_resolution() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session).await?; + println!("Uploaded start frame: {}", start_frame_url); + + let result = generate_happy_horse_1p0(GenerateHappyHorse1p0Args { + session: &session, + host_override: None, + request: GenerateHappyHorse1p0Request { + prompt: "The dog runs along the shore, kicking up sand.".to_string(), + aspect_ratio: Some(KinoviHappyHorse1p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: Some(start_frame_url), + }, + }).await?; + println!("keyframe landscape default res — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + async fn upload_test_image(session: &Seedance2ProSession) -> AnyhowResult { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + Ok(upload_result.public_url) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0.rs b/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0.rs new file mode 100644 index 00000000..934f48f5 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0.rs @@ -0,0 +1,1402 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::cost::kinovi_seedance_generation_cost::KinoviSeedanceGenerationCost; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task, KinoviAspectRatioRaw, KinoviBatchCountRaw, KinoviBitrateRaw, + KinoviModelTypeRaw, KinoviOutputResolutionRaw, WorkflowRunTaskArgs, + WorkflowRunTaskRequest, +}; + +// ── Args ── + +pub struct GenerateSeedance2p0Args<'a> { + pub request: GenerateSeedance2p0Request, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateSeedance2p0Request { + pub prompt: String, + pub aspect_ratio: Option, + pub output_resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + pub start_frame_url: Option, + pub end_frame_url: Option, + pub reference_image_urls: Option>, + pub reference_video_urls: Option>, + pub reference_audio_urls: Option>, + pub character_ids: Option>, + pub use_face_blur_hack: Option, + /// Output video bitrate. None defaults to "standard"; `High` requests a + /// higher bitrate. Does not affect cost. + pub bitrate: Option, +} + +// ── Enums ── + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0AspectRatio { + Landscape16x9, + UltraWide21x9, + Portrait9x16, + Square1x1, + Standard4x3, + Portrait3x4, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0OutputResolution { + FourEightyP, + SevenTwentyP, + TenEightyP, + FourK, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0BatchCount { + One, + Two, + Four, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0Bitrate { + High, +} + +// ── Pricing ── +// +// Seedance 2.0 Pro credit pricing: +// +// | Resolution | Credits/sec | +// |------------|-------------| +// | 480p | 15 | +// | 720p | 40 | +// | 1080p | 90 | +// | 4K | 200 | +// +// Default resolution (None) is 720p. +// Batch count multiplies the total cost. +// Credit package: 525,000 credits for $2,159.0909 (~243.16 credits/$1, rounded down to 243). + +impl GenerateSeedance2p0Request { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents (rounded up). + /// + /// Attaching reference VIDEOS adds a per-output-second surcharge (see the + /// pricing table below). Reference images and audio are free. + pub fn calculate_costs(&self) -> KinoviSeedanceGenerationCost { + let credits_per_second: u64 = match self.output_resolution { + Some(KinoviSeedance2p0OutputResolution::FourEightyP) => 15, + Some(KinoviSeedance2p0OutputResolution::SevenTwentyP) | None => 40, + Some(KinoviSeedance2p0OutputResolution::TenEightyP) => 90, + Some(KinoviSeedance2p0OutputResolution::FourK) => 200, + }; + + // Video-reference surcharge, billed per second of OUTPUT duration + // (not the reference video's duration): + // + // | Resolution | Surcharge credits/sec | + // |------------|-----------------------| + // | 480p | 4 | + // | 720p | 8 | + // | 1080p | 18 | + // | 4K | 40 | + // + // NB: Assumed flat per generation regardless of how many reference + // videos are attached (Kinovi's pricing page only shows one). + let video_reference_surcharge_per_second: u64 = if self.has_video_reference() { + match self.output_resolution { + Some(KinoviSeedance2p0OutputResolution::FourEightyP) => 4, + Some(KinoviSeedance2p0OutputResolution::SevenTwentyP) | None => 8, + Some(KinoviSeedance2p0OutputResolution::TenEightyP) => 18, + Some(KinoviSeedance2p0OutputResolution::FourK) => 40, + } + } else { + 0 + }; + + let batch_multiplier: u64 = match self.batch_count { + None | Some(KinoviSeedance2p0BatchCount::One) => 1, + Some(KinoviSeedance2p0BatchCount::Two) => 2, + Some(KinoviSeedance2p0BatchCount::Four) => 4, + }; + + let duration = u64::from(self.duration_seconds); + let base_credits = duration * credits_per_second * batch_multiplier; + let maybe_video_reference_surcharge_credits = if self.has_video_reference() { + Some(duration * video_reference_surcharge_per_second * batch_multiplier) + } else { + None + }; + + KinoviSeedanceGenerationCost::from_base_and_surcharge( + base_credits, + maybe_video_reference_surcharge_credits, + ) + } + + fn has_video_reference(&self) -> bool { + self.reference_video_urls + .as_ref() + .is_some_and(|urls| !urls.is_empty()) + } + + /// Estimate the credit cost for this generation request. + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().total_cost.kinovi_credits as u32 + } + + /// Estimate the USD cost in cents for this generation request. + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().total_cost.usd_cents_rounded_up + } +} + +// ── Response ── + +pub struct GenerateSeedance2p0Response { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_seedance_2p0( + args: GenerateSeedance2p0Args<'_>, +) -> Result { + let req = args.request; + + let raw_request = WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: req.prompt, + aspect_ratio: map_aspect_ratio(req.aspect_ratio), + output_resolution: req.output_resolution.map(map_output_resolution), + batch_count: map_batch_count(req.batch_count), + duration_seconds: req.duration_seconds, + start_frame_url: req.start_frame_url, + end_frame_url: req.end_frame_url, + reference_image_urls: req.reference_image_urls, + reference_video_urls: req.reference_video_urls, + reference_audio_urls: req.reference_audio_urls, + character_ids: req.character_ids, + use_face_blur_hack: req.use_face_blur_hack, + bitrate: map_bitrate(req.bitrate), + }; + + let raw_response = workflow_run_task(WorkflowRunTaskArgs { + request: raw_request, + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSeedance2p0Response { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + task_ids: raw_response.task_ids, + order_ids: raw_response.order_ids, + }) +} + +// ── Mapping helpers ── + +fn map_aspect_ratio(ar: Option) -> KinoviAspectRatioRaw { + match ar { + Some(KinoviSeedance2p0AspectRatio::Landscape16x9) => KinoviAspectRatioRaw::Landscape16x9, + Some(KinoviSeedance2p0AspectRatio::UltraWide21x9) => KinoviAspectRatioRaw::UltraWide21x9, + Some(KinoviSeedance2p0AspectRatio::Portrait9x16) => KinoviAspectRatioRaw::Portrait9x16, + Some(KinoviSeedance2p0AspectRatio::Square1x1) => KinoviAspectRatioRaw::Square1x1, + Some(KinoviSeedance2p0AspectRatio::Standard4x3) => KinoviAspectRatioRaw::Landscape4x3, + Some(KinoviSeedance2p0AspectRatio::Portrait3x4) => KinoviAspectRatioRaw::Portrait3x4, + None => KinoviAspectRatioRaw::Landscape16x9, + } +} + +fn map_output_resolution(res: KinoviSeedance2p0OutputResolution) -> KinoviOutputResolutionRaw { + match res { + KinoviSeedance2p0OutputResolution::FourEightyP => KinoviOutputResolutionRaw::FourEightyP, + KinoviSeedance2p0OutputResolution::SevenTwentyP => KinoviOutputResolutionRaw::SevenTwentyP, + KinoviSeedance2p0OutputResolution::TenEightyP => KinoviOutputResolutionRaw::TenEightyP, + KinoviSeedance2p0OutputResolution::FourK => KinoviOutputResolutionRaw::FourK, + } +} + +fn map_batch_count(bc: Option) -> KinoviBatchCountRaw { + match bc { + Some(KinoviSeedance2p0BatchCount::One) | None => KinoviBatchCountRaw::One, + Some(KinoviSeedance2p0BatchCount::Two) => KinoviBatchCountRaw::Two, + Some(KinoviSeedance2p0BatchCount::Four) => KinoviBatchCountRaw::Four, + } +} + +fn map_bitrate(bitrate: Option) -> Option { + match bitrate { + Some(KinoviSeedance2p0Bitrate::High) => Some(KinoviBitrateRaw::High), + None => None, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + mod pricing_tests { + use super::*; + + fn build_request( + duration_seconds: u8, + output_resolution: Option, + batch_count: Option, + ) -> GenerateSeedance2p0Request { + GenerateSeedance2p0Request { + prompt: String::new(), + aspect_ratio: None, + output_resolution, + batch_count, + duration_seconds, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + } + + fn r480(dur: u8) -> GenerateSeedance2p0Request { + build_request(dur, Some(KinoviSeedance2p0OutputResolution::FourEightyP), None) + } + + fn r720(dur: u8) -> GenerateSeedance2p0Request { + build_request(dur, None, None) + } + + fn r1080(dur: u8) -> GenerateSeedance2p0Request { + build_request(dur, Some(KinoviSeedance2p0OutputResolution::TenEightyP), None) + } + + /// A 4K request with NO video reference. + fn r4k(dur: u8) -> GenerateSeedance2p0Request { + build_request(dur, Some(KinoviSeedance2p0OutputResolution::FourK), None) + } + + /// A 4K request WITH a video reference (adds the per-second surcharge). + fn r4k_with_video_ref(dur: u8) -> GenerateSeedance2p0Request { + let mut request = r4k(dur); + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + request + } + + fn total_credits(request: &GenerateSeedance2p0Request) -> u64 { + request.calculate_costs().total_cost.kinovi_credits + } + + fn total_usd_cents(request: &GenerateSeedance2p0Request) -> u64 { + request.calculate_costs().total_cost.usd_cents_rounded_up + } + + // ── 4K pricing (Seedance 2.0 only) ── + // + // Base: 200 credits/sec. With a video reference: 240 credits/sec + // (200 base + 40/sec surcharge). Every duration × video-ref combination + // is asserted below against Kinovi's published 4K numbers. + + mod four_k_pricing { + use super::*; + + // ── No video reference: 200 credits/sec ── + + #[test] + fn four_k_no_video_ref_4_seconds_is_800_credits() { + assert_eq!(total_credits(&r4k(4)), 800); + } + + #[test] + fn four_k_no_video_ref_5_seconds_is_1000_credits() { + assert_eq!(total_credits(&r4k(5)), 1000); + } + + #[test] + fn four_k_no_video_ref_10_seconds_is_2000_credits() { + assert_eq!(total_credits(&r4k(10)), 2000); + } + + #[test] + fn four_k_no_video_ref_15_seconds_is_3000_credits() { + assert_eq!(total_credits(&r4k(15)), 3000); + } + + // ── With video reference: 240 credits/sec (200 base + 40 surcharge) ── + + #[test] + fn four_k_with_video_ref_4_seconds_is_960_credits() { + assert_eq!(total_credits(&r4k_with_video_ref(4)), 960); + } + + #[test] + fn four_k_with_video_ref_5_seconds_is_1200_credits() { + assert_eq!(total_credits(&r4k_with_video_ref(5)), 1200); + } + + #[test] + fn four_k_with_video_ref_10_seconds_is_2400_credits() { + assert_eq!(total_credits(&r4k_with_video_ref(10)), 2400); + } + + #[test] + fn four_k_with_video_ref_15_seconds_is_3600_credits() { + assert_eq!(total_credits(&r4k_with_video_ref(15)), 3600); + } + + // ── Total cost in USD cents — no video reference ── + // + // 200 credits/sec; usd_cents = ceil(total_credits / 243 * 100). + + #[test] + fn four_k_no_video_ref_4_seconds_is_330_cents() { + assert_eq!(total_usd_cents(&r4k(4)), 330); + } + + #[test] + fn four_k_no_video_ref_5_seconds_is_412_cents() { + assert_eq!(total_usd_cents(&r4k(5)), 412); + } + + #[test] + fn four_k_no_video_ref_10_seconds_is_824_cents() { + assert_eq!(total_usd_cents(&r4k(10)), 824); + } + + #[test] + fn four_k_no_video_ref_15_seconds_is_1235_cents() { + assert_eq!(total_usd_cents(&r4k(15)), 1235); + } + + // ── Total cost in USD cents — with video reference ── + // + // 240 credits/sec (200 base + 40 surcharge); usd_cents = ceil(total_credits / 243 * 100). + + #[test] + fn four_k_with_video_ref_4_seconds_is_396_cents() { + assert_eq!(total_usd_cents(&r4k_with_video_ref(4)), 396); + } + + #[test] + fn four_k_with_video_ref_5_seconds_is_494_cents() { + assert_eq!(total_usd_cents(&r4k_with_video_ref(5)), 494); + } + + #[test] + fn four_k_with_video_ref_10_seconds_is_988_cents() { + assert_eq!(total_usd_cents(&r4k_with_video_ref(10)), 988); + } + + #[test] + fn four_k_with_video_ref_15_seconds_is_1482_cents() { + assert_eq!(total_usd_cents(&r4k_with_video_ref(15)), 1482); + } + + // ── Base / surcharge breakdown (5 seconds) ── + + #[test] + fn four_k_with_video_ref_breaks_base_and_surcharge_apart() { + let costs = r4k_with_video_ref(5).calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, 1000); // 5s × 200 + assert_eq!( + costs.video_reference_surcharge_cost.as_ref().map(|c| c.kinovi_credits), + Some(200), // 5s × 40 + ); + assert_eq!(costs.total_cost.kinovi_credits, 1200); + } + } + + // ── Comprehensive per-resolution coverage ── + // + // Seedance 2.0: 480p 15/s (+4/s video ref), 720p 40/s (+8/s), 1080p 90/s (+18/s). + // Every field and subfield is asserted: total_cost, base_cost, + // video_reference_surcharge_cost × (kinovi_credits, usd_cents_rounded_up, + // usd_cents_rounded_down, usd_cents_fractional). All cases use a 5 second + // duration with no batching. + + mod comprehensive { + use super::*; + + const FLOAT_TOLERANCE: f64 = 1e-9; + + + mod resolution_480p { + use super::*; + + #[test] + fn test_without_reference_video() { + let costs = r480(5).calculate_costs(); + + // Base: 15 credits/s × 5s = 75 credits; 7500/243 = 30.8642. + assert_eq!(costs.base_cost.kinovi_credits, 75); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 31); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 30); + assert!((costs.base_cost.usd_cents_fractional - (7500.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // No reference video: no surcharge, and the total equals the base. + assert!(costs.video_reference_surcharge_cost.is_none()); + + assert_eq!(costs.total_cost.kinovi_credits, 75); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 31); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 30); + assert!((costs.total_cost.usd_cents_fractional - (7500.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn test_with_reference_video() { + let mut request = r480(5); + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + let costs = request.calculate_costs(); + + // Base: 15 credits/s × 5s = 75 credits; 7500/243 = 30.8642. + assert_eq!(costs.base_cost.kinovi_credits, 75); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 31); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 30); + assert!((costs.base_cost.usd_cents_fractional - (7500.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Surcharge: 4 credits/s × 5s = 20 credits; 2000/243 = 8.2305. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 20); + assert_eq!(surcharge.usd_cents_rounded_up, 9); + assert_eq!(surcharge.usd_cents_rounded_down, 8); + assert!((surcharge.usd_cents_fractional - (2000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total: 75 + 20 = 95 credits; 9500/243 = 39.0947. + assert_eq!(costs.total_cost.kinovi_credits, 95); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 40); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 39); + assert!((costs.total_cost.usd_cents_fractional - (9500.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + } + + + mod resolution_720p { + use super::*; + + #[test] + fn test_without_reference_video() { + let costs = r720(5).calculate_costs(); + + // Base: 40 credits/s × 5s = 200 credits; 20000/243 = 82.3045. + assert_eq!(costs.base_cost.kinovi_credits, 200); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 83); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 82); + assert!((costs.base_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // No reference video: no surcharge, and the total equals the base. + assert!(costs.video_reference_surcharge_cost.is_none()); + + assert_eq!(costs.total_cost.kinovi_credits, 200); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 83); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 82); + assert!((costs.total_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn test_with_reference_video() { + let mut request = r720(5); + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + let costs = request.calculate_costs(); + + // Base: 40 credits/s × 5s = 200 credits; 20000/243 = 82.3045. + assert_eq!(costs.base_cost.kinovi_credits, 200); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 83); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 82); + assert!((costs.base_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Surcharge: 8 credits/s × 5s = 40 credits; 4000/243 = 16.4609. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 40); + assert_eq!(surcharge.usd_cents_rounded_up, 17); + assert_eq!(surcharge.usd_cents_rounded_down, 16); + assert!((surcharge.usd_cents_fractional - (4000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total: 200 + 40 = 240 credits; 24000/243 = 98.7654. + assert_eq!(costs.total_cost.kinovi_credits, 240); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 99); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 98); + assert!((costs.total_cost.usd_cents_fractional - (24000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + } + + + mod resolution_1080p { + use super::*; + + #[test] + fn test_without_reference_video() { + let costs = r1080(5).calculate_costs(); + + // Base: 90 credits/s × 5s = 450 credits; 45000/243 = 185.1852. + assert_eq!(costs.base_cost.kinovi_credits, 450); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 186); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 185); + assert!((costs.base_cost.usd_cents_fractional - (45000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // No reference video: no surcharge, and the total equals the base. + assert!(costs.video_reference_surcharge_cost.is_none()); + + assert_eq!(costs.total_cost.kinovi_credits, 450); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 186); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 185); + assert!((costs.total_cost.usd_cents_fractional - (45000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn test_with_reference_video() { + let mut request = r1080(5); + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + let costs = request.calculate_costs(); + + // Base: 90 credits/s × 5s = 450 credits; 45000/243 = 185.1852. + assert_eq!(costs.base_cost.kinovi_credits, 450); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 186); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 185); + assert!((costs.base_cost.usd_cents_fractional - (45000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Surcharge: 18 credits/s × 5s = 90 credits; 9000/243 = 37.0370. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 90); + assert_eq!(surcharge.usd_cents_rounded_up, 38); + assert_eq!(surcharge.usd_cents_rounded_down, 37); + assert!((surcharge.usd_cents_fractional - (9000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total: 450 + 90 = 540 credits; 54000/243 = 222.2222. + assert_eq!(costs.total_cost.kinovi_credits, 540); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 223); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 222); + assert!((costs.total_cost.usd_cents_fractional - (54000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + } + + } + + // ── 480p credits (15 credits/sec) ── + + mod credits_480p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r480(3).calculate_costs().total_cost.kinovi_credits, 45); + assert_eq!(r480(4).calculate_costs().total_cost.kinovi_credits, 60); + assert_eq!(r480(5).calculate_costs().total_cost.kinovi_credits, 75); + assert_eq!(r480(6).calculate_costs().total_cost.kinovi_credits, 90); + assert_eq!(r480(7).calculate_costs().total_cost.kinovi_credits, 105); + assert_eq!(r480(8).calculate_costs().total_cost.kinovi_credits, 120); + assert_eq!(r480(9).calculate_costs().total_cost.kinovi_credits, 135); + assert_eq!(r480(10).calculate_costs().total_cost.kinovi_credits, 150); + assert_eq!(r480(11).calculate_costs().total_cost.kinovi_credits, 165); + assert_eq!(r480(12).calculate_costs().total_cost.kinovi_credits, 180); + assert_eq!(r480(13).calculate_costs().total_cost.kinovi_credits, 195); + assert_eq!(r480(14).calculate_costs().total_cost.kinovi_credits, 210); + assert_eq!(r480(15).calculate_costs().total_cost.kinovi_credits, 225); + } + } + + // ── 720p credits (40 credits/sec) ── + + mod credits_720p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r720(3).calculate_costs().total_cost.kinovi_credits, 120); + assert_eq!(r720(4).calculate_costs().total_cost.kinovi_credits, 160); + assert_eq!(r720(5).calculate_costs().total_cost.kinovi_credits, 200); + assert_eq!(r720(6).calculate_costs().total_cost.kinovi_credits, 240); + assert_eq!(r720(7).calculate_costs().total_cost.kinovi_credits, 280); + assert_eq!(r720(8).calculate_costs().total_cost.kinovi_credits, 320); + assert_eq!(r720(9).calculate_costs().total_cost.kinovi_credits, 360); + assert_eq!(r720(10).calculate_costs().total_cost.kinovi_credits, 400); + assert_eq!(r720(11).calculate_costs().total_cost.kinovi_credits, 440); + assert_eq!(r720(12).calculate_costs().total_cost.kinovi_credits, 480); + assert_eq!(r720(13).calculate_costs().total_cost.kinovi_credits, 520); + assert_eq!(r720(14).calculate_costs().total_cost.kinovi_credits, 560); + assert_eq!(r720(15).calculate_costs().total_cost.kinovi_credits, 600); + } + + #[test] + fn explicit_720p_same_as_default() { + let default = r720(5).calculate_costs().total_cost.kinovi_credits; + let explicit = build_request(5, Some(KinoviSeedance2p0OutputResolution::SevenTwentyP), None).calculate_costs().total_cost.kinovi_credits; + assert_eq!(default, explicit); + } + } + + // ── 1080p credits (90 credits/sec) ── + + mod credits_1080p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r1080(3).calculate_costs().total_cost.kinovi_credits, 270); + assert_eq!(r1080(4).calculate_costs().total_cost.kinovi_credits, 360); + assert_eq!(r1080(5).calculate_costs().total_cost.kinovi_credits, 450); + assert_eq!(r1080(6).calculate_costs().total_cost.kinovi_credits, 540); + assert_eq!(r1080(7).calculate_costs().total_cost.kinovi_credits, 630); + assert_eq!(r1080(8).calculate_costs().total_cost.kinovi_credits, 720); + assert_eq!(r1080(9).calculate_costs().total_cost.kinovi_credits, 810); + assert_eq!(r1080(10).calculate_costs().total_cost.kinovi_credits, 900); + assert_eq!(r1080(11).calculate_costs().total_cost.kinovi_credits, 990); + assert_eq!(r1080(12).calculate_costs().total_cost.kinovi_credits, 1080); + assert_eq!(r1080(13).calculate_costs().total_cost.kinovi_credits, 1170); + assert_eq!(r1080(14).calculate_costs().total_cost.kinovi_credits, 1260); + assert_eq!(r1080(15).calculate_costs().total_cost.kinovi_credits, 1350); + } + } + + // ── Batch multiplier ── + + mod batch_tests { + use super::*; + + #[test] + fn batch_1_is_base() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let explicit = build_request(5, None, Some(KinoviSeedance2p0BatchCount::One)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(base, explicit); + } + + #[test] + fn batch_2_doubles() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let batch2 = build_request(5, None, Some(KinoviSeedance2p0BatchCount::Two)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch2, base * 2); + } + + #[test] + fn batch_4_quadruples() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let batch4 = build_request(5, None, Some(KinoviSeedance2p0BatchCount::Four)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch4, base * 4); + } + + #[test] + fn batch_multiplier_applies_to_1080p() { + let base = r1080(5).calculate_costs().total_cost.kinovi_credits; + let batch2 = build_request(5, Some(KinoviSeedance2p0OutputResolution::TenEightyP), Some(KinoviSeedance2p0BatchCount::Two)).calculate_costs().total_cost.kinovi_credits; + let batch4 = build_request(5, Some(KinoviSeedance2p0OutputResolution::TenEightyP), Some(KinoviSeedance2p0BatchCount::Four)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch2, base * 2); + assert_eq!(batch4, base * 4); + } + + #[test] + fn batch_multiplier_applies_to_480p() { + let base = r480(5).calculate_costs().total_cost.kinovi_credits; + let batch2 = build_request(5, Some(KinoviSeedance2p0OutputResolution::FourEightyP), Some(KinoviSeedance2p0BatchCount::Two)).calculate_costs().total_cost.kinovi_credits; + let batch4 = build_request(5, Some(KinoviSeedance2p0OutputResolution::FourEightyP), Some(KinoviSeedance2p0BatchCount::Four)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch2, base * 2); + assert_eq!(batch4, base * 4); + } + } + + // ── Relative pricing ── + + mod relative_tests { + use super::*; + + #[test] + fn cost_scales_with_duration() { + let c3 = r720(3).calculate_costs().total_cost.kinovi_credits; + let c10 = r720(10).calculate_costs().total_cost.kinovi_credits; + let c15 = r720(15).calculate_costs().total_cost.kinovi_credits; + assert!(c3 < c10); + assert!(c10 < c15); + } + + #[test] + fn resolution_ordering() { + for dur in 3..=15u8 { + let c480 = build_request(dur, Some(KinoviSeedance2p0OutputResolution::FourEightyP), None).calculate_costs().total_cost.kinovi_credits; + let c720 = build_request(dur, None, None).calculate_costs().total_cost.kinovi_credits; + let c1080 = build_request(dur, Some(KinoviSeedance2p0OutputResolution::TenEightyP), None).calculate_costs().total_cost.kinovi_credits; + assert!(c480 < c720, "480p should be cheaper than 720p at {}s", dur); + assert!(c720 < c1080, "720p should be cheaper than 1080p at {}s", dur); + } + } + } + + // ── USD cents ── + + mod calculate_costs_tests { + use super::*; + + /// Both fields together: credits and ceil-rounded USD cents. + /// (USD cents are always rounded UP when fractional.) + #[test] + fn costs_480p_5s() { + // 15 credits/s × 5s = 75 credits; 7500/243 = 30.86 → 31¢ + let costs = r480(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 75); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 31); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 30); + assert!((costs.total_cost.usd_cents_fractional - (7500.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 75); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_720p_5s() { + // 40 credits/s × 5s = 200 credits; 20000/243 = 82.30 → 83¢ + let costs = r720(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 200); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 83); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 82); + assert!((costs.total_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 200); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_1080p_5s() { + // 90 credits/s × 5s = 450 credits; 45000/243 = 185.19 → rounds UP to 186¢ + let costs = r1080(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 450); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 186); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 185); + assert!((costs.total_cost.usd_cents_fractional - (45000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 450); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_720p_15s() { + // 40 credits/s × 15s = 600 credits; 60000/243 = 246.91 → 247¢ + let costs = r720(15).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 600); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 247); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 246); + assert!((costs.total_cost.usd_cents_fractional - (60000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 600); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_1080p_15s() { + // 90 credits/s × 15s = 1350 credits; 135000/243 = 555.56 → rounds UP to 556¢ + let costs = r1080(15).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 1350); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 556); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 555); + assert!((costs.total_cost.usd_cents_fractional - (135000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 1350); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_batch_4_720p_5s() { + // 200 credits × 4 = 800 credits; 80000/243 = 329.22 → 330¢ + let costs = build_request(5, None, Some(KinoviSeedance2p0BatchCount::Four)).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 800); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 330); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 329); + assert!((costs.total_cost.usd_cents_fractional - (80000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 800); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + /// The deprecated shims return the corresponding struct fields. + #[test] + #[allow(deprecated)] + fn deprecated_methods_delegate() { + let request = r720(5); + let costs = request.calculate_costs(); + assert_eq!(u64::from(request.estimate_credits()), costs.total_cost.kinovi_credits); + assert_eq!(request.estimate_cost_in_usd_cents(), costs.total_cost.usd_cents_rounded_up); + } + } + + // ── Video-reference surcharge ── + // + // Per Kinovi's pricing page, attaching a reference video adds a + // per-output-second surcharge (480p: +4/s, 720p: +8/s, 1080p: +18/s). + + mod video_reference_surcharge_tests { + use super::*; + + fn with_video_ref(mut request: GenerateSeedance2p0Request) -> GenerateSeedance2p0Request { + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + request + } + + /// The full base + surcharge table from Kinovi's pricing page + /// ("With Video Uploads", 10 sec video ref). Asserts every field: + /// base, surcharge, and the derived total. + #[test] + fn kinovi_pricing_table_with_video_reference() { + // (request, duration, base credits, surcharge credits) + let cases: &[(fn(u8) -> GenerateSeedance2p0Request, u8, u64, u64)] = &[ + // 480p: base + 4/s + (r480, 4, 60, 16), + (r480, 5, 75, 20), + (r480, 10, 150, 40), + (r480, 15, 225, 60), + // 720p: base + 8/s + (r720, 4, 160, 32), + (r720, 5, 200, 40), + (r720, 10, 400, 80), + (r720, 15, 600, 120), + // 1080p: base + 18/s + (r1080, 4, 360, 72), + (r1080, 5, 450, 90), + (r1080, 10, 900, 180), + (r1080, 15, 1350, 270), + ]; + + for (make, duration, base, surcharge) in cases { + let costs = with_video_ref(make(*duration)).calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, *base, "base for {duration}s"); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(*surcharge), "surcharge for {duration}s"); + assert_eq!(costs.total_cost.kinovi_credits, base + surcharge, "total for {duration}s"); + } + } + + #[test] + fn surcharge_includes_usd_cents() { + // 720p 5s + video ref = 200 + 40 = 240 credits; 24000/243 = 98.77 → 99¢ + let costs = with_video_ref(r720(5)).calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, 200); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(40)); + assert_eq!(costs.total_cost.kinovi_credits, 240); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 99); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 98); + assert!((costs.total_cost.usd_cents_fractional - (24000.0 / 243.0)).abs() < 1e-9); + } + + /// The base and surcharge parts each carry their own USD conversions. + #[test] + fn parts_have_their_own_usd_conversions() { + let costs = with_video_ref(r720(5)).calculate_costs(); + + // Base: 200 credits; 20000/243 = 82.30. + assert_eq!(costs.base_cost.usd_cents_rounded_up, 83); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 82); + assert!((costs.base_cost.usd_cents_fractional - (20000.0 / 243.0)).abs() < 1e-9); + + // Surcharge: 40 credits; 4000/243 = 16.46. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 40); + assert_eq!(surcharge.usd_cents_rounded_up, 17); + assert_eq!(surcharge.usd_cents_rounded_down, 16); + assert!((surcharge.usd_cents_fractional - (4000.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn empty_video_reference_list_has_no_surcharge() { + let mut request = r720(5); + request.reference_video_urls = Some(vec![]); + let costs = request.calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 200); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + /// Surcharge is flat per generation regardless of how many reference + /// videos are attached (assumption — Kinovi's page only shows one). + #[test] + fn multiple_video_references_charge_once() { + let mut request = r720(5); + request.reference_video_urls = Some(vec![ + "https://example.com/a.mp4".to_string(), + "https://example.com/b.mp4".to_string(), + ]); + assert_eq!(request.calculate_costs().total_cost.kinovi_credits, 240); + } + + /// The surcharge applies per generated video, so batches multiply it. + #[test] + fn batch_multiplies_surcharge() { + let request = with_video_ref(build_request(5, None, Some(KinoviSeedance2p0BatchCount::Two))); + // (200 base + 40 surcharge) × 2 = 480 credits + let costs = request.calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, 400); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(80)); + assert_eq!(costs.total_cost.kinovi_credits, 480); + } + } + + // ── Aspect ratio doesn't affect cost ── + + #[test] + fn aspect_ratio_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().total_cost.kinovi_credits; + + let ratios = [ + KinoviSeedance2p0AspectRatio::Landscape16x9, + KinoviSeedance2p0AspectRatio::UltraWide21x9, + KinoviSeedance2p0AspectRatio::Portrait9x16, + KinoviSeedance2p0AspectRatio::Square1x1, + KinoviSeedance2p0AspectRatio::Standard4x3, + KinoviSeedance2p0AspectRatio::Portrait3x4, + ]; + + for ar in &ratios { + let req = GenerateSeedance2p0Request { + prompt: String::new(), + aspect_ratio: Some(*ar), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }; + assert_eq!( + req.calculate_costs().total_cost.kinovi_credits, baseline, + "Aspect ratio {:?} should not change credits from baseline {}", ar, baseline, + ); + } + } + + // ── Bitrate doesn't affect cost ── + + #[test] + fn high_bitrate_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().total_cost.kinovi_credits; + + let mut high = r720(5); + high.bitrate = Some(KinoviSeedance2p0Bitrate::High); + + assert_eq!( + high.calculate_costs().total_cost.kinovi_credits, baseline, + "High bitrate should not change credits from baseline {}", baseline, + ); + } + } + + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + + const STEAMPUNK_CLOWN_ID: &str = "char_1775176566518_sik0te"; + const MOCHI_ID: &str = "char_1775177718294_g2pitx"; + + mod text_to_video { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_text_to_video_default() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "A corgi and a shiba are playing chess against one another".to_string(), + aspect_ratio: None, + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("t2v default — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_text_to_video_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "A dragon soaring over a medieval castle at sunset".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: Some(KinoviSeedance2p0OutputResolution::TenEightyP), + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("t2v 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod ultra_wide { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_text_to_video_21x9() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "A corgi is riding on the back of a sauropod dinosaur".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::UltraWide21x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("t2v 21:9 — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_keyframe_21x9() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session, test_data::web::image_urls::WIDE_CORGI_SHIBA_TREASURE_OCEAN_URL).await?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "The dogs sail across the ocean on a treasure ship.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::UltraWide21x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: Some(start_frame_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("keyframe 21:9 — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod keyframe { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_keyframe_start_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session, test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL).await?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "The corgi dog watches the lake as the sun sets.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: Some(start_frame_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("keyframe — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_keyframe_start_and_end_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session, test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL).await?; + let end_frame_url = upload_test_image(&session, test_data::web::image_urls::FOREST_BACKDROP_IMAGE_URL).await?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "The dog walks from the lake toward the camera.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: Some(start_frame_url), + end_frame_url: Some(end_frame_url), + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("keyframe start+end — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod image_reference { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_image_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let img1 = upload_test_image(&session, test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL).await?; + let img2 = upload_test_image(&session, test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL).await?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "The dog in @1 runs through the scenery in @2.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![img1, img2]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("image ref — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + /// 4K with image references (Seedance 2.0 only), 5-second clip. + #[tokio::test] + #[ignore] + async fn test_4k_image_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let img1 = upload_test_image(&session, test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL).await?; + let img2 = upload_test_image(&session, test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL).await?; + let img3 = upload_test_image(&session, test_data::web::image_urls::FOREST_BACKDROP_IMAGE_URL).await?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "The dog in @1 explores the scenery in @3 and meets the friendly man in @2. Cinematic 4K detail.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: Some(KinoviSeedance2p0OutputResolution::FourK), + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![img1, img2, img3]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("4K image ref — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + } + + mod video_reference { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_video_reference() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "Change @video1 to a nighttime scene with moonlight.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("video ref — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod character_reference { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_single_character() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "@Steampunk Clown is juggling flaming torches in a circus tent.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("character ref — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_two_characters() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = generate_seedance_2p0(GenerateSeedance2p0Args { + session: &session, + host_override: None, + request: GenerateSeedance2p0Request { + prompt: "@Steampunk Clown and @Mochi are playing fetch in a sunny park.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0AspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string(), MOCHI_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("two characters — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + async fn upload_test_image(session: &Seedance2ProSession, image_url: &str) -> AnyhowResult { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + image_url, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + Ok(upload_result.public_url) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0_fast.rs b/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0_fast.rs new file mode 100644 index 00000000..8d3881f3 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0_fast.rs @@ -0,0 +1,1082 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::cost::kinovi_seedance_generation_cost::KinoviSeedanceGenerationCost; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task, KinoviAspectRatioRaw, KinoviBatchCountRaw, KinoviBitrateRaw, + KinoviModelTypeRaw, KinoviOutputResolutionRaw, WorkflowRunTaskArgs, + WorkflowRunTaskRequest, +}; + +// ── Args ── + +pub struct GenerateSeedance2p0FastArgs<'a> { + pub request: GenerateSeedance2p0FastRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateSeedance2p0FastRequest { + pub prompt: String, + pub aspect_ratio: Option, + pub output_resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + pub start_frame_url: Option, + pub end_frame_url: Option, + pub reference_image_urls: Option>, + pub reference_video_urls: Option>, + pub reference_audio_urls: Option>, + pub character_ids: Option>, + pub use_face_blur_hack: Option, + /// Output video bitrate. None defaults to "standard"; `High` requests a + /// higher bitrate. Does not affect cost. + pub bitrate: Option, +} + +// ── Enums ── + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0FastAspectRatio { + Landscape16x9, + UltraWide21x9, + Portrait9x16, + Square1x1, + Standard4x3, + Portrait3x4, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0FastOutputResolution { + FourEightyP, + SevenTwentyP, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0FastBatchCount { + One, + Two, + Four, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0FastBitrate { + High, +} + +// ── Pricing ── +// +// Seedance 2.0 Fast credit pricing: +// +// | Resolution | Credits/sec | +// |------------|-------------| +// | 480p | 14 | +// | 720p | 28 | +// +// Default resolution (None) is 720p. +// Batch count multiplies the total cost. +// Credit package: 525,000 credits for $2,159.0909 (~243.16 credits/$1, rounded down to 243). + +impl GenerateSeedance2p0FastRequest { + /// Calculate the cost of this generation request, in Kinovi credits and + /// USD cents (rounded up). + /// + /// Attaching reference VIDEOS adds a per-output-second surcharge (see the + /// pricing table below). Reference images and audio are free. + pub fn calculate_costs(&self) -> KinoviSeedanceGenerationCost { + let credits_per_second: u64 = match self.output_resolution { + Some(KinoviSeedance2p0FastOutputResolution::FourEightyP) => 14, + Some(KinoviSeedance2p0FastOutputResolution::SevenTwentyP) | None => 28, + }; + + // Video-reference surcharge, billed per second of OUTPUT duration + // (not the reference video's duration): + // + // | Resolution | Surcharge credits/sec | + // |------------|-----------------------| + // | 480p | 4 | + // | 720p | 6 | + // + // NB: Assumed flat per generation regardless of how many reference + // videos are attached (Kinovi's pricing page only shows one). + let video_reference_surcharge_per_second: u64 = if self.has_video_reference() { + match self.output_resolution { + Some(KinoviSeedance2p0FastOutputResolution::FourEightyP) => 4, + Some(KinoviSeedance2p0FastOutputResolution::SevenTwentyP) | None => 6, + } + } else { + 0 + }; + + let batch_multiplier: u64 = match self.batch_count { + None | Some(KinoviSeedance2p0FastBatchCount::One) => 1, + Some(KinoviSeedance2p0FastBatchCount::Two) => 2, + Some(KinoviSeedance2p0FastBatchCount::Four) => 4, + }; + + let duration = u64::from(self.duration_seconds); + let base_credits = duration * credits_per_second * batch_multiplier; + let maybe_video_reference_surcharge_credits = if self.has_video_reference() { + Some(duration * video_reference_surcharge_per_second * batch_multiplier) + } else { + None + }; + + KinoviSeedanceGenerationCost::from_base_and_surcharge( + base_credits, + maybe_video_reference_surcharge_credits, + ) + } + + fn has_video_reference(&self) -> bool { + self.reference_video_urls + .as_ref() + .is_some_and(|urls| !urls.is_empty()) + } + + /// Estimate the credit cost for this generation request. + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().total_cost.kinovi_credits as u32 + } + + /// Estimate the USD cost in cents for this generation request. + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().total_cost.usd_cents_rounded_up + } +} + +// ── Response ── + +pub struct GenerateSeedance2p0FastResponse { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_seedance_2p0_fast( + args: GenerateSeedance2p0FastArgs<'_>, +) -> Result { + let req = args.request; + + let raw_request = WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Fast, + prompt: req.prompt, + aspect_ratio: map_aspect_ratio(req.aspect_ratio), + output_resolution: req.output_resolution.map(map_output_resolution), + batch_count: map_batch_count(req.batch_count), + duration_seconds: req.duration_seconds, + start_frame_url: req.start_frame_url, + end_frame_url: req.end_frame_url, + reference_image_urls: req.reference_image_urls, + reference_video_urls: req.reference_video_urls, + reference_audio_urls: req.reference_audio_urls, + character_ids: req.character_ids, + use_face_blur_hack: req.use_face_blur_hack, + bitrate: map_bitrate(req.bitrate), + }; + + let raw_response = workflow_run_task(WorkflowRunTaskArgs { + request: raw_request, + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSeedance2p0FastResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + task_ids: raw_response.task_ids, + order_ids: raw_response.order_ids, + }) +} + +// ── Mapping helpers ── + +fn map_aspect_ratio(ar: Option) -> KinoviAspectRatioRaw { + match ar { + Some(KinoviSeedance2p0FastAspectRatio::Landscape16x9) => KinoviAspectRatioRaw::Landscape16x9, + Some(KinoviSeedance2p0FastAspectRatio::UltraWide21x9) => KinoviAspectRatioRaw::UltraWide21x9, + Some(KinoviSeedance2p0FastAspectRatio::Portrait9x16) => KinoviAspectRatioRaw::Portrait9x16, + Some(KinoviSeedance2p0FastAspectRatio::Square1x1) => KinoviAspectRatioRaw::Square1x1, + Some(KinoviSeedance2p0FastAspectRatio::Standard4x3) => KinoviAspectRatioRaw::Landscape4x3, + Some(KinoviSeedance2p0FastAspectRatio::Portrait3x4) => KinoviAspectRatioRaw::Portrait3x4, + None => KinoviAspectRatioRaw::Landscape16x9, + } +} + +fn map_output_resolution(res: KinoviSeedance2p0FastOutputResolution) -> KinoviOutputResolutionRaw { + match res { + KinoviSeedance2p0FastOutputResolution::FourEightyP => KinoviOutputResolutionRaw::FourEightyP, + KinoviSeedance2p0FastOutputResolution::SevenTwentyP => KinoviOutputResolutionRaw::SevenTwentyP, + } +} + +fn map_batch_count(bc: Option) -> KinoviBatchCountRaw { + match bc { + Some(KinoviSeedance2p0FastBatchCount::One) | None => KinoviBatchCountRaw::One, + Some(KinoviSeedance2p0FastBatchCount::Two) => KinoviBatchCountRaw::Two, + Some(KinoviSeedance2p0FastBatchCount::Four) => KinoviBatchCountRaw::Four, + } +} + +fn map_bitrate(bitrate: Option) -> Option { + match bitrate { + Some(KinoviSeedance2p0FastBitrate::High) => Some(KinoviBitrateRaw::High), + None => None, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + mod pricing_tests { + use super::*; + + fn build_request( + duration_seconds: u8, + output_resolution: Option, + batch_count: Option, + ) -> GenerateSeedance2p0FastRequest { + GenerateSeedance2p0FastRequest { + prompt: String::new(), + aspect_ratio: None, + output_resolution, + batch_count, + duration_seconds, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + } + + fn r480(dur: u8) -> GenerateSeedance2p0FastRequest { + build_request(dur, Some(KinoviSeedance2p0FastOutputResolution::FourEightyP), None) + } + + fn r720(dur: u8) -> GenerateSeedance2p0FastRequest { + build_request(dur, None, None) + } + + // ── Comprehensive per-resolution coverage ── + // + // Seedance 2.0 Fast: 480p 14/s (+4/s video ref), 720p 28/s (+6/s). No 1080p. + // Every field and subfield is asserted: total_cost, base_cost, + // video_reference_surcharge_cost × (kinovi_credits, usd_cents_rounded_up, + // usd_cents_rounded_down, usd_cents_fractional). All cases use a 5 second + // duration with no batching. + + mod comprehensive { + use super::*; + + const FLOAT_TOLERANCE: f64 = 1e-9; + + + mod resolution_480p { + use super::*; + + #[test] + fn test_without_reference_video() { + let costs = r480(5).calculate_costs(); + + // Base: 14 credits/s × 5s = 70 credits; 7000/243 = 28.8066. + assert_eq!(costs.base_cost.kinovi_credits, 70); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 29); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 28); + assert!((costs.base_cost.usd_cents_fractional - (7000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // No reference video: no surcharge, and the total equals the base. + assert!(costs.video_reference_surcharge_cost.is_none()); + + assert_eq!(costs.total_cost.kinovi_credits, 70); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 29); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 28); + assert!((costs.total_cost.usd_cents_fractional - (7000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn test_with_reference_video() { + let mut request = r480(5); + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + let costs = request.calculate_costs(); + + // Base: 14 credits/s × 5s = 70 credits; 7000/243 = 28.8066. + assert_eq!(costs.base_cost.kinovi_credits, 70); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 29); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 28); + assert!((costs.base_cost.usd_cents_fractional - (7000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Surcharge: 4 credits/s × 5s = 20 credits; 2000/243 = 8.2305. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 20); + assert_eq!(surcharge.usd_cents_rounded_up, 9); + assert_eq!(surcharge.usd_cents_rounded_down, 8); + assert!((surcharge.usd_cents_fractional - (2000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total: 70 + 20 = 90 credits; 9000/243 = 37.0370. + assert_eq!(costs.total_cost.kinovi_credits, 90); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 38); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 37); + assert!((costs.total_cost.usd_cents_fractional - (9000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + } + + + mod resolution_720p { + use super::*; + + #[test] + fn test_without_reference_video() { + let costs = r720(5).calculate_costs(); + + // Base: 28 credits/s × 5s = 140 credits; 14000/243 = 57.6132. + assert_eq!(costs.base_cost.kinovi_credits, 140); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 58); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 57); + assert!((costs.base_cost.usd_cents_fractional - (14000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // No reference video: no surcharge, and the total equals the base. + assert!(costs.video_reference_surcharge_cost.is_none()); + + assert_eq!(costs.total_cost.kinovi_credits, 140); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 58); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 57); + assert!((costs.total_cost.usd_cents_fractional - (14000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn test_with_reference_video() { + let mut request = r720(5); + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + let costs = request.calculate_costs(); + + // Base: 28 credits/s × 5s = 140 credits; 14000/243 = 57.6132. + assert_eq!(costs.base_cost.kinovi_credits, 140); + assert_eq!(costs.base_cost.usd_cents_rounded_up, 58); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 57); + assert!((costs.base_cost.usd_cents_fractional - (14000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Surcharge: 6 credits/s × 5s = 30 credits; 3000/243 = 12.3457. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 30); + assert_eq!(surcharge.usd_cents_rounded_up, 13); + assert_eq!(surcharge.usd_cents_rounded_down, 12); + assert!((surcharge.usd_cents_fractional - (3000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + + // Total: 140 + 30 = 170 credits; 17000/243 = 69.9588. + assert_eq!(costs.total_cost.kinovi_credits, 170); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 70); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 69); + assert!((costs.total_cost.usd_cents_fractional - (17000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + } + + } + + // ── 480p credits (14 credits/sec) ── + + mod credits_480p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r480(3).calculate_costs().total_cost.kinovi_credits, 42); + assert_eq!(r480(4).calculate_costs().total_cost.kinovi_credits, 56); + assert_eq!(r480(5).calculate_costs().total_cost.kinovi_credits, 70); + assert_eq!(r480(6).calculate_costs().total_cost.kinovi_credits, 84); + assert_eq!(r480(7).calculate_costs().total_cost.kinovi_credits, 98); + assert_eq!(r480(8).calculate_costs().total_cost.kinovi_credits, 112); + assert_eq!(r480(9).calculate_costs().total_cost.kinovi_credits, 126); + assert_eq!(r480(10).calculate_costs().total_cost.kinovi_credits, 140); + assert_eq!(r480(11).calculate_costs().total_cost.kinovi_credits, 154); + assert_eq!(r480(12).calculate_costs().total_cost.kinovi_credits, 168); + assert_eq!(r480(13).calculate_costs().total_cost.kinovi_credits, 182); + assert_eq!(r480(14).calculate_costs().total_cost.kinovi_credits, 196); + assert_eq!(r480(15).calculate_costs().total_cost.kinovi_credits, 210); + } + } + + // ── 720p credits (28 credits/sec) ── + + mod credits_720p { + use super::*; + + #[test] + fn every_duration() { + assert_eq!(r720(3).calculate_costs().total_cost.kinovi_credits, 84); + assert_eq!(r720(4).calculate_costs().total_cost.kinovi_credits, 112); + assert_eq!(r720(5).calculate_costs().total_cost.kinovi_credits, 140); + assert_eq!(r720(6).calculate_costs().total_cost.kinovi_credits, 168); + assert_eq!(r720(7).calculate_costs().total_cost.kinovi_credits, 196); + assert_eq!(r720(8).calculate_costs().total_cost.kinovi_credits, 224); + assert_eq!(r720(9).calculate_costs().total_cost.kinovi_credits, 252); + assert_eq!(r720(10).calculate_costs().total_cost.kinovi_credits, 280); + assert_eq!(r720(11).calculate_costs().total_cost.kinovi_credits, 308); + assert_eq!(r720(12).calculate_costs().total_cost.kinovi_credits, 336); + assert_eq!(r720(13).calculate_costs().total_cost.kinovi_credits, 364); + assert_eq!(r720(14).calculate_costs().total_cost.kinovi_credits, 392); + assert_eq!(r720(15).calculate_costs().total_cost.kinovi_credits, 420); + } + + #[test] + fn explicit_720p_same_as_default() { + let default = r720(5).calculate_costs().total_cost.kinovi_credits; + let explicit = build_request(5, Some(KinoviSeedance2p0FastOutputResolution::SevenTwentyP), None).calculate_costs().total_cost.kinovi_credits; + assert_eq!(default, explicit); + } + } + + // ── Batch multiplier ── + + mod batch_tests { + use super::*; + + #[test] + fn batch_1_is_base() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let explicit = build_request(5, None, Some(KinoviSeedance2p0FastBatchCount::One)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(base, explicit); + } + + #[test] + fn batch_2_doubles() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let batch2 = build_request(5, None, Some(KinoviSeedance2p0FastBatchCount::Two)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch2, base * 2); + } + + #[test] + fn batch_4_quadruples() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let batch4 = build_request(5, None, Some(KinoviSeedance2p0FastBatchCount::Four)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch4, base * 4); + } + + #[test] + fn batch_multiplier_applies_to_480p() { + let base = r480(5).calculate_costs().total_cost.kinovi_credits; + let batch2 = build_request(5, Some(KinoviSeedance2p0FastOutputResolution::FourEightyP), Some(KinoviSeedance2p0FastBatchCount::Two)).calculate_costs().total_cost.kinovi_credits; + let batch4 = build_request(5, Some(KinoviSeedance2p0FastOutputResolution::FourEightyP), Some(KinoviSeedance2p0FastBatchCount::Four)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(batch2, base * 2); + assert_eq!(batch4, base * 4); + } + } + + // ── Relative pricing ── + + mod relative_tests { + use super::*; + + #[test] + fn cost_scales_with_duration() { + let c3 = r720(3).calculate_costs().total_cost.kinovi_credits; + let c10 = r720(10).calculate_costs().total_cost.kinovi_credits; + let c15 = r720(15).calculate_costs().total_cost.kinovi_credits; + assert!(c3 < c10); + assert!(c10 < c15); + } + + #[test] + fn resolution_ordering() { + for dur in 3..=15u8 { + let c480 = build_request(dur, Some(KinoviSeedance2p0FastOutputResolution::FourEightyP), None).calculate_costs().total_cost.kinovi_credits; + let c720 = build_request(dur, None, None).calculate_costs().total_cost.kinovi_credits; + assert!(c480 < c720, "480p should be cheaper than 720p at {}s", dur); + } + } + } + + // ── USD cents ── + + mod calculate_costs_tests { + use super::*; + + /// Both fields together: credits and ceil-rounded USD cents. + /// (USD cents are always rounded UP when fractional.) + #[test] + fn costs_480p_5s() { + // 14 credits/s × 5s = 70 credits; 7000/243 = 28.81 → rounds UP to 29¢ + let costs = r480(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 70); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 29); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 28); + assert!((costs.total_cost.usd_cents_fractional - (7000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 70); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_720p_5s() { + // 28 credits/s × 5s = 140 credits; 14000/243 = 57.61 → 58¢ + let costs = r720(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 140); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 58); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 57); + assert!((costs.total_cost.usd_cents_fractional - (14000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 140); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_720p_15s() { + // 28 credits/s × 15s = 420 credits; 42000/243 = 172.84 → 173¢ + let costs = r720(15).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 420); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 173); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 172); + assert!((costs.total_cost.usd_cents_fractional - (42000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 420); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_480p_15s() { + // 14 credits/s × 15s = 210 credits; 21000/243 = 86.42 → 87¢ + let costs = r480(15).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 210); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 87); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 86); + assert!((costs.total_cost.usd_cents_fractional - (21000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 210); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + #[test] + fn costs_batch_2_720p_5s() { + // 140 credits × 2 = 280 credits; 28000/243 = 115.23 → 116¢ + let costs = build_request(5, None, Some(KinoviSeedance2p0FastBatchCount::Two)).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 280); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 116); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 115); + assert!((costs.total_cost.usd_cents_fractional - (28000.0 / 243.0)).abs() < 1e-9); + assert_eq!(costs.base_cost.kinovi_credits, 280); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + /// The deprecated shims return the corresponding struct fields. + #[test] + #[allow(deprecated)] + fn deprecated_methods_delegate() { + let request = r720(5); + let costs = request.calculate_costs(); + assert_eq!(u64::from(request.estimate_credits()), costs.total_cost.kinovi_credits); + assert_eq!(request.estimate_cost_in_usd_cents(), costs.total_cost.usd_cents_rounded_up); + } + } + + // ── Video-reference surcharge ── + // + // Per Kinovi's pricing page ("Seedance 2.0 Fast With Video Ref"), + // attaching a reference video adds a per-output-second surcharge + // (480p: +4/s, 720p: +6/s). + + mod video_reference_surcharge_tests { + use super::*; + + fn with_video_ref(mut request: GenerateSeedance2p0FastRequest) -> GenerateSeedance2p0FastRequest { + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + request + } + + /// The full base + surcharge table from Kinovi's pricing page + /// ("Seedance 2.0 Fast With Video Ref", 10 sec video ref). Asserts + /// every field: base, surcharge, and the derived total. + #[test] + fn kinovi_pricing_table_with_video_reference() { + // (request, duration, base credits, surcharge credits) + let cases: &[(fn(u8) -> GenerateSeedance2p0FastRequest, u8, u64, u64)] = &[ + // 480p: base + 4/s + (r480, 4, 56, 16), + (r480, 5, 70, 20), + (r480, 10, 140, 40), + (r480, 15, 210, 60), + // 720p: base + 6/s + (r720, 4, 112, 24), + (r720, 5, 140, 30), + (r720, 10, 280, 60), + (r720, 15, 420, 90), + ]; + + for (make, duration, base, surcharge) in cases { + let costs = with_video_ref(make(*duration)).calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, *base, "base for {duration}s"); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(*surcharge), "surcharge for {duration}s"); + assert_eq!(costs.total_cost.kinovi_credits, base + surcharge, "total for {duration}s"); + } + } + + #[test] + fn surcharge_includes_usd_cents() { + // 720p 5s + video ref = 140 + 30 = 170 credits; 17000/243 = 69.96 → 70¢ + let costs = with_video_ref(r720(5)).calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, 140); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(30)); + assert_eq!(costs.total_cost.kinovi_credits, 170); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 70); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 69); + assert!((costs.total_cost.usd_cents_fractional - (17000.0 / 243.0)).abs() < 1e-9); + } + + /// The base and surcharge parts each carry their own USD conversions. + #[test] + fn parts_have_their_own_usd_conversions() { + let costs = with_video_ref(r720(5)).calculate_costs(); + + // Base: 140 credits; 14000/243 = 57.61. + assert_eq!(costs.base_cost.usd_cents_rounded_up, 58); + assert_eq!(costs.base_cost.usd_cents_rounded_down, 57); + assert!((costs.base_cost.usd_cents_fractional - (14000.0 / 243.0)).abs() < 1e-9); + + // Surcharge: 30 credits; 3000/243 = 12.35. + let surcharge = costs.video_reference_surcharge_cost.expect("should have surcharge"); + assert_eq!(surcharge.kinovi_credits, 30); + assert_eq!(surcharge.usd_cents_rounded_up, 13); + assert_eq!(surcharge.usd_cents_rounded_down, 12); + assert!((surcharge.usd_cents_fractional - (3000.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn empty_video_reference_list_has_no_surcharge() { + let mut request = r720(5); + request.reference_video_urls = Some(vec![]); + let costs = request.calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 140); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + /// Surcharge is flat per generation regardless of how many reference + /// videos are attached (assumption — Kinovi's page only shows one). + #[test] + fn multiple_video_references_charge_once() { + let mut request = r720(5); + request.reference_video_urls = Some(vec![ + "https://example.com/a.mp4".to_string(), + "https://example.com/b.mp4".to_string(), + ]); + assert_eq!(request.calculate_costs().total_cost.kinovi_credits, 170); + } + + /// The surcharge applies per generated video, so batches multiply it. + #[test] + fn batch_multiplies_surcharge() { + let request = with_video_ref(build_request(5, None, Some(KinoviSeedance2p0FastBatchCount::Two))); + // (140 base + 30 surcharge) × 2 = 340 credits + let costs = request.calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, 280); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(60)); + assert_eq!(costs.total_cost.kinovi_credits, 340); + } + } + + // ── Aspect ratio doesn't affect cost ── + + #[test] + fn aspect_ratio_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().total_cost.kinovi_credits; + + let ratios = [ + KinoviSeedance2p0FastAspectRatio::Landscape16x9, + KinoviSeedance2p0FastAspectRatio::UltraWide21x9, + KinoviSeedance2p0FastAspectRatio::Portrait9x16, + KinoviSeedance2p0FastAspectRatio::Square1x1, + KinoviSeedance2p0FastAspectRatio::Standard4x3, + KinoviSeedance2p0FastAspectRatio::Portrait3x4, + ]; + + for ar in &ratios { + let req = GenerateSeedance2p0FastRequest { + prompt: String::new(), + aspect_ratio: Some(*ar), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }; + assert_eq!( + req.calculate_costs().total_cost.kinovi_credits, baseline, + "Aspect ratio {:?} should not change credits from baseline {}", ar, baseline, + ); + } + } + + // ── Bitrate doesn't affect cost ── + + #[test] + fn high_bitrate_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().total_cost.kinovi_credits; + + let mut high = r720(5); + high.bitrate = Some(KinoviSeedance2p0FastBitrate::High); + + assert_eq!( + high.calculate_costs().total_cost.kinovi_credits, baseline, + "High bitrate should not change credits from baseline {}", baseline, + ); + } + } + + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + + const STEAMPUNK_CLOWN_ID: &str = "char_1775176566518_sik0te"; + const MOCHI_ID: &str = "char_1775177718294_g2pitx"; + + mod text_to_video { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_text_to_video_default() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "A corgi and a shiba are playing chess against one another".to_string(), + aspect_ratio: None, + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("t2v fast default — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_text_to_video_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "A golden retriever running through a field of sunflowers".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::Landscape16x9), + output_resolution: Some(KinoviSeedance2p0FastOutputResolution::FourEightyP), + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("t2v fast 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod ultra_wide { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_text_to_video_21x9() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "A shiba is riding on the back of a sauropod dinosaur".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::UltraWide21x9), + output_resolution: Some(KinoviSeedance2p0FastOutputResolution::FourEightyP), + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast t2v 21:9 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_keyframe_21x9() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session, test_data::web::image_urls::WIDE_CORGI_SHIBA_TREASURE_OCEAN_URL).await?; + + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "The dogs in @1 set sail across the ocean on a treasure ship.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::UltraWide21x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![start_frame_url]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast keyframe 21:9 — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod keyframe { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_keyframe_start_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let start_frame_url = upload_test_image(&session, test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL).await?; + + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "A corgi dog runs along the lake shore, splashing water.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: Some(start_frame_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast keyframe — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod image_reference { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_image_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let img1 = upload_test_image(&session, test_data::web::image_urls::FOREST_BACKDROP_IMAGE_URL).await?; + let img2 = upload_test_image(&session, test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL).await?; + + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "The dog in @1 runs through the scenery in @2. Golden hour.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![img1, img2]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast image ref — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod video_reference { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_video_reference() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "Change @video1 to night time.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast video ref — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod character_reference { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_single_character() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "@Mochi the shiba inu is eating a cheese pizza on the table.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::Portrait9x16), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![MOCHI_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast character — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_two_characters() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = generate_seedance_2p0_fast(GenerateSeedance2p0FastArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0FastRequest { + prompt: "@Steampunk Clown and @Mochi are playing fetch in a sunny park.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0FastAspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string(), MOCHI_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("fast two characters — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + async fn upload_test_image(session: &Seedance2ProSession, image_url: &str) -> AnyhowResult { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + image_url, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + Ok(upload_result.public_url) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0_mini.rs b/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0_mini.rs new file mode 100644 index 00000000..9d916c06 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/video/generate_seedance_2p0_mini.rs @@ -0,0 +1,755 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::cost::kinovi_seedance_mini_generation_cost::KinoviSeedanceMiniGenerationCost; +use crate::requests::kinovi_host::KinoviHost; +use crate::requests::workflow_run_task::workflow_run_task::{ + workflow_run_task, KinoviAspectRatioRaw, KinoviBatchCountRaw, KinoviBitrateRaw, + KinoviModelTypeRaw, KinoviOutputResolutionRaw, WorkflowRunTaskArgs, + WorkflowRunTaskRequest, +}; + +// ── Args ── + +pub struct GenerateSeedance2p0MiniArgs<'a> { + pub request: GenerateSeedance2p0MiniRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +// ── Request ── + +#[derive(Clone, Debug)] +pub struct GenerateSeedance2p0MiniRequest { + pub prompt: String, + pub aspect_ratio: Option, + pub output_resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + pub start_frame_url: Option, + pub end_frame_url: Option, + pub reference_image_urls: Option>, + pub reference_video_urls: Option>, + pub reference_audio_urls: Option>, + pub character_ids: Option>, + pub use_face_blur_hack: Option, + /// Output video bitrate. None defaults to "normal"; `High` requests a + /// higher bitrate. Does not affect cost. + pub bitrate: Option, +} + +// ── Enums ── + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0MiniAspectRatio { + Landscape16x9, + UltraWide21x9, + Portrait9x16, + Square1x1, + Standard4x3, + Portrait3x4, +} + +/// Output resolution. Mini supports only 480p and 720p (no 1080p / 4K). +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0MiniOutputResolution { + FourEightyP, + SevenTwentyP, +} + +/// Number of videos to generate in one request. Mini allows 1–8. +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0MiniBatchCount { + One, + Two, + Three, + Four, + Five, + Six, + Seven, + Eight, +} + +#[derive(Debug, Clone, Copy)] +pub enum KinoviSeedance2p0MiniBitrate { + High, +} + +// ── Pricing ── +// +// Seedance 2.0 Mini credit pricing (per second of OUTPUT duration): +// +// | Resolution | Credits/sec | Video-ref surcharge/sec | +// |------------|-------------|-------------------------| +// | 480p | 7.5 | 2 | +// | 720p | 20 | 4 | +// +// 480p credits can be FRACTIONAL (7.5/sec lands on half-credits at odd +// durations, e.g. 5s = 37.5). Default resolution (None) is 720p. Batch count +// multiplies the total. Attaching reference VIDEOS adds the surcharge; +// reference images and audio are free. +// +// Credit package: 525,000 credits for $2,159.0909 (~243 credits/$1). + +impl GenerateSeedance2p0MiniRequest { + /// Calculate the cost of this generation request, in Kinovi credits + /// (possibly fractional) and USD cents. + pub fn calculate_costs(&self) -> KinoviSeedanceMiniGenerationCost { + let credits_per_second: f64 = match self.output_resolution { + Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP) => 7.5, + Some(KinoviSeedance2p0MiniOutputResolution::SevenTwentyP) | None => 20.0, + }; + + let video_reference_surcharge_per_second: f64 = if self.has_video_reference() { + match self.output_resolution { + Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP) => 2.0, + Some(KinoviSeedance2p0MiniOutputResolution::SevenTwentyP) | None => 4.0, + } + } else { + 0.0 + }; + + let batch_multiplier = f64::from(self.batch_multiplier()); + let duration = f64::from(self.duration_seconds); + + let base_credits = duration * credits_per_second * batch_multiplier; + let maybe_video_reference_surcharge_credits = if self.has_video_reference() { + Some(duration * video_reference_surcharge_per_second * batch_multiplier) + } else { + None + }; + + KinoviSeedanceMiniGenerationCost::from_base_and_surcharge( + base_credits, + maybe_video_reference_surcharge_credits, + ) + } + + fn has_video_reference(&self) -> bool { + self.reference_video_urls + .as_ref() + .is_some_and(|urls| !urls.is_empty()) + } + + fn batch_multiplier(&self) -> u8 { + match self.batch_count { + None | Some(KinoviSeedance2p0MiniBatchCount::One) => 1, + Some(KinoviSeedance2p0MiniBatchCount::Two) => 2, + Some(KinoviSeedance2p0MiniBatchCount::Three) => 3, + Some(KinoviSeedance2p0MiniBatchCount::Four) => 4, + Some(KinoviSeedance2p0MiniBatchCount::Five) => 5, + Some(KinoviSeedance2p0MiniBatchCount::Six) => 6, + Some(KinoviSeedance2p0MiniBatchCount::Seven) => 7, + Some(KinoviSeedance2p0MiniBatchCount::Eight) => 8, + } + } +} + +// ── Response ── + +pub struct GenerateSeedance2p0MiniResponse { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, +} + +// ── Entry point ── + +pub async fn generate_seedance_2p0_mini( + args: GenerateSeedance2p0MiniArgs<'_>, +) -> Result { + let raw_response = workflow_run_task(WorkflowRunTaskArgs { + request: to_raw_request(args.request), + session: args.session, + host_override: args.host_override, + }).await?; + + Ok(GenerateSeedance2p0MiniResponse { + task_id: raw_response.task_id, + order_id: raw_response.order_id, + task_ids: raw_response.task_ids, + order_ids: raw_response.order_ids, + }) +} + +// ── Mapping helpers ── + +fn to_raw_request(req: GenerateSeedance2p0MiniRequest) -> WorkflowRunTaskRequest { + WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Mini, + prompt: req.prompt, + aspect_ratio: map_aspect_ratio(req.aspect_ratio), + output_resolution: req.output_resolution.map(map_output_resolution), + batch_count: map_batch_count(req.batch_count), + duration_seconds: req.duration_seconds, + start_frame_url: req.start_frame_url, + end_frame_url: req.end_frame_url, + reference_image_urls: req.reference_image_urls, + reference_video_urls: req.reference_video_urls, + reference_audio_urls: req.reference_audio_urls, + character_ids: req.character_ids, + use_face_blur_hack: req.use_face_blur_hack, + bitrate: map_bitrate(req.bitrate), + } +} + +fn map_aspect_ratio(ar: Option) -> KinoviAspectRatioRaw { + match ar { + Some(KinoviSeedance2p0MiniAspectRatio::Landscape16x9) => KinoviAspectRatioRaw::Landscape16x9, + Some(KinoviSeedance2p0MiniAspectRatio::UltraWide21x9) => KinoviAspectRatioRaw::UltraWide21x9, + Some(KinoviSeedance2p0MiniAspectRatio::Portrait9x16) => KinoviAspectRatioRaw::Portrait9x16, + Some(KinoviSeedance2p0MiniAspectRatio::Square1x1) => KinoviAspectRatioRaw::Square1x1, + Some(KinoviSeedance2p0MiniAspectRatio::Standard4x3) => KinoviAspectRatioRaw::Landscape4x3, + Some(KinoviSeedance2p0MiniAspectRatio::Portrait3x4) => KinoviAspectRatioRaw::Portrait3x4, + None => KinoviAspectRatioRaw::Landscape16x9, + } +} + +fn map_output_resolution(res: KinoviSeedance2p0MiniOutputResolution) -> KinoviOutputResolutionRaw { + match res { + KinoviSeedance2p0MiniOutputResolution::FourEightyP => KinoviOutputResolutionRaw::FourEightyP, + KinoviSeedance2p0MiniOutputResolution::SevenTwentyP => KinoviOutputResolutionRaw::SevenTwentyP, + } +} + +fn map_batch_count(bc: Option) -> KinoviBatchCountRaw { + match bc { + Some(KinoviSeedance2p0MiniBatchCount::One) | None => KinoviBatchCountRaw::One, + Some(KinoviSeedance2p0MiniBatchCount::Two) => KinoviBatchCountRaw::Two, + Some(KinoviSeedance2p0MiniBatchCount::Three) => KinoviBatchCountRaw::Three, + Some(KinoviSeedance2p0MiniBatchCount::Four) => KinoviBatchCountRaw::Four, + Some(KinoviSeedance2p0MiniBatchCount::Five) => KinoviBatchCountRaw::Five, + Some(KinoviSeedance2p0MiniBatchCount::Six) => KinoviBatchCountRaw::Six, + Some(KinoviSeedance2p0MiniBatchCount::Seven) => KinoviBatchCountRaw::Seven, + Some(KinoviSeedance2p0MiniBatchCount::Eight) => KinoviBatchCountRaw::Eight, + } +} + +fn map_bitrate(bitrate: Option) -> Option { + match bitrate { + Some(KinoviSeedance2p0MiniBitrate::High) => Some(KinoviBitrateRaw::High), + None => None, + } +} + +// ── Tests ── + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + mod pricing_tests { + use super::*; + + const FLOAT_TOLERANCE: f64 = 1e-9; + + fn build_request( + duration_seconds: u8, + output_resolution: Option, + batch_count: Option, + ) -> GenerateSeedance2p0MiniRequest { + GenerateSeedance2p0MiniRequest { + prompt: String::new(), + aspect_ratio: None, + output_resolution, + batch_count, + duration_seconds, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + } + + fn r480(dur: u8) -> GenerateSeedance2p0MiniRequest { + build_request(dur, Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP), None) + } + + fn r720(dur: u8) -> GenerateSeedance2p0MiniRequest { + build_request(dur, None, None) + } + + fn with_video_ref(mut request: GenerateSeedance2p0MiniRequest) -> GenerateSeedance2p0MiniRequest { + request.reference_video_urls = Some(vec!["https://example.com/ref.mp4".to_string()]); + request + } + + // ── Full pricing table (credits) ── + // + // The exact table provided by Kinovi for Seedance 2.0 Mini. 480p produces + // fractional credits at odd durations (37.5, 112.5, …). + + mod kinovi_pricing_table { + use super::*; + + #[test] + fn table_480p_without_video_reference() { + assert_eq!(r480(4).calculate_costs().total_cost.kinovi_credits, 30.0); + assert_eq!(r480(5).calculate_costs().total_cost.kinovi_credits, 37.5); + assert_eq!(r480(10).calculate_costs().total_cost.kinovi_credits, 75.0); + assert_eq!(r480(15).calculate_costs().total_cost.kinovi_credits, 112.5); + } + + #[test] + fn table_720p_without_video_reference() { + assert_eq!(r720(4).calculate_costs().total_cost.kinovi_credits, 80.0); + assert_eq!(r720(5).calculate_costs().total_cost.kinovi_credits, 100.0); + assert_eq!(r720(10).calculate_costs().total_cost.kinovi_credits, 200.0); + assert_eq!(r720(15).calculate_costs().total_cost.kinovi_credits, 300.0); + } + + #[test] + fn table_480p_with_video_reference() { + assert_eq!(with_video_ref(r480(4)).calculate_costs().total_cost.kinovi_credits, 38.0); + assert_eq!(with_video_ref(r480(5)).calculate_costs().total_cost.kinovi_credits, 47.5); + assert_eq!(with_video_ref(r480(10)).calculate_costs().total_cost.kinovi_credits, 95.0); + assert_eq!(with_video_ref(r480(15)).calculate_costs().total_cost.kinovi_credits, 142.5); + } + + #[test] + fn table_720p_with_video_reference() { + assert_eq!(with_video_ref(r720(4)).calculate_costs().total_cost.kinovi_credits, 96.0); + assert_eq!(with_video_ref(r720(5)).calculate_costs().total_cost.kinovi_credits, 120.0); + assert_eq!(with_video_ref(r720(10)).calculate_costs().total_cost.kinovi_credits, 240.0); + assert_eq!(with_video_ref(r720(15)).calculate_costs().total_cost.kinovi_credits, 360.0); + } + } + + // ── Base / surcharge breakdown ── + + mod video_reference_surcharge { + use super::*; + + /// The surcharge is the difference between the with-ref total and the + /// base: 480p +2/s, 720p +4/s. + #[test] + fn surcharge_table() { + // (request builder, duration, base credits, surcharge credits) + let cases: &[(fn(u8) -> GenerateSeedance2p0MiniRequest, u8, f64, f64)] = &[ + // 480p: 7.5/s base, +2/s surcharge + (r480, 4, 30.0, 8.0), + (r480, 5, 37.5, 10.0), + (r480, 10, 75.0, 20.0), + (r480, 15, 112.5, 30.0), + // 720p: 20/s base, +4/s surcharge + (r720, 4, 80.0, 16.0), + (r720, 5, 100.0, 20.0), + (r720, 10, 200.0, 40.0), + (r720, 15, 300.0, 60.0), + ]; + + for (make, duration, base, surcharge) in cases { + let costs = with_video_ref(make(*duration)).calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, *base, "base at {duration}s"); + assert_eq!( + costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), + Some(*surcharge), + "surcharge at {duration}s", + ); + assert_eq!(costs.total_cost.kinovi_credits, base + surcharge, "total at {duration}s"); + } + } + + #[test] + fn no_video_reference_has_no_surcharge() { + let costs = r480(5).calculate_costs(); + assert!(costs.video_reference_surcharge_cost.is_none()); + assert_eq!(costs.total_cost, costs.base_cost); + } + + #[test] + fn empty_video_reference_list_has_no_surcharge() { + let mut request = r720(5); + request.reference_video_urls = Some(vec![]); + let costs = request.calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 100.0); + assert!(costs.video_reference_surcharge_cost.is_none()); + } + + /// The surcharge applies per generated video, so batches multiply it. + #[test] + fn batch_multiplies_surcharge() { + let request = with_video_ref(build_request( + 5, + Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP), + Some(KinoviSeedance2p0MiniBatchCount::Two), + )); + // (37.5 base + 10 surcharge) × 2 + let costs = request.calculate_costs(); + assert_eq!(costs.base_cost.kinovi_credits, 75.0); + assert_eq!(costs.video_reference_surcharge_cost.map(|c| c.kinovi_credits), Some(20.0)); + assert_eq!(costs.total_cost.kinovi_credits, 95.0); + } + } + + // ── USD cents conversion ── + + mod usd_cents { + use super::*; + + #[test] + fn fractional_480p_5s() { + // 37.5 credits; 3750/243 = 15.43 → 16¢ up, 15¢ down. + let costs = r480(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 37.5); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 16); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 15); + assert!((costs.total_cost.usd_cents_fractional - (3750.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn whole_720p_5s() { + // 100 credits; 10000/243 = 41.15 → 42¢ up, 41¢ down. + let costs = r720(5).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 100.0); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 42); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 41); + assert!((costs.total_cost.usd_cents_fractional - (10000.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + + #[test] + fn fractional_480p_15s_with_video_reference() { + // 142.5 credits; 14250/243 = 58.64 → 59¢ up, 58¢ down. + let costs = with_video_ref(r480(15)).calculate_costs(); + assert_eq!(costs.total_cost.kinovi_credits, 142.5); + assert_eq!(costs.total_cost.usd_cents_rounded_up, 59); + assert_eq!(costs.total_cost.usd_cents_rounded_down, 58); + assert!((costs.total_cost.usd_cents_fractional - (14250.0 / 243.0)).abs() < FLOAT_TOLERANCE); + } + } + + // ── Batch multiplier ── + + mod batch_tests { + use super::*; + + #[test] + fn batch_scales_total_linearly() { + let base = r720(5).calculate_costs().total_cost.kinovi_credits; + let by_count = [ + (KinoviSeedance2p0MiniBatchCount::One, 1.0), + (KinoviSeedance2p0MiniBatchCount::Two, 2.0), + (KinoviSeedance2p0MiniBatchCount::Three, 3.0), + (KinoviSeedance2p0MiniBatchCount::Four, 4.0), + (KinoviSeedance2p0MiniBatchCount::Five, 5.0), + (KinoviSeedance2p0MiniBatchCount::Six, 6.0), + (KinoviSeedance2p0MiniBatchCount::Seven, 7.0), + (KinoviSeedance2p0MiniBatchCount::Eight, 8.0), + ]; + for (count, multiplier) in by_count { + let credits = build_request(5, None, Some(count)).calculate_costs().total_cost.kinovi_credits; + assert_eq!(credits, base * multiplier, "batch {count:?}"); + } + } + + #[test] + fn batch_eight_480p_with_video_reference() { + let costs = with_video_ref(build_request( + 5, + Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP), + Some(KinoviSeedance2p0MiniBatchCount::Eight), + )).calculate_costs(); + // (37.5 + 10) × 8 = 380 + assert_eq!(costs.total_cost.kinovi_credits, 380.0); + } + } + + // ── Defaults & invariants ── + + #[test] + fn default_resolution_is_720p() { + let default = r720(5).calculate_costs().total_cost.kinovi_credits; + let explicit = build_request(5, Some(KinoviSeedance2p0MiniOutputResolution::SevenTwentyP), None) + .calculate_costs().total_cost.kinovi_credits; + assert_eq!(default, explicit); + assert_eq!(default, 100.0); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = r720(4).calculate_costs().total_cost.kinovi_credits; + let c10 = r720(10).calculate_costs().total_cost.kinovi_credits; + let c15 = r720(15).calculate_costs().total_cost.kinovi_credits; + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn resolution_480p_cheaper_than_720p() { + for dur in 4..=15u8 { + let c480 = r480(dur).calculate_costs().total_cost.kinovi_credits; + let c720 = r720(dur).calculate_costs().total_cost.kinovi_credits; + assert!(c480 < c720, "480p should be cheaper than 720p at {dur}s"); + } + } + + #[test] + fn aspect_ratio_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().total_cost.kinovi_credits; + let ratios = [ + KinoviSeedance2p0MiniAspectRatio::Landscape16x9, + KinoviSeedance2p0MiniAspectRatio::UltraWide21x9, + KinoviSeedance2p0MiniAspectRatio::Portrait9x16, + KinoviSeedance2p0MiniAspectRatio::Square1x1, + KinoviSeedance2p0MiniAspectRatio::Standard4x3, + KinoviSeedance2p0MiniAspectRatio::Portrait3x4, + ]; + for ar in ratios { + let mut req = r720(5); + req.aspect_ratio = Some(ar); + assert_eq!(req.calculate_costs().total_cost.kinovi_credits, baseline, "{ar:?}"); + } + } + + #[test] + fn high_bitrate_does_not_affect_credits() { + let baseline = r720(5).calculate_costs().total_cost.kinovi_credits; + let mut high = r720(5); + high.bitrate = Some(KinoviSeedance2p0MiniBitrate::High); + assert_eq!(high.calculate_costs().total_cost.kinovi_credits, baseline); + } + } + + // ── Request shape (mapping to the raw Kinovi request) ── + + mod request_shape_tests { + use super::*; + + fn sample() -> GenerateSeedance2p0MiniRequest { + GenerateSeedance2p0MiniRequest { + prompt: "a corgi".to_string(), + aspect_ratio: Some(KinoviSeedance2p0MiniAspectRatio::Standard4x3), + output_resolution: Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP), + duration_seconds: 10, + batch_count: Some(KinoviSeedance2p0MiniBatchCount::Eight), + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec!["https://example.com/a.png".to_string()]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: Some(KinoviSeedance2p0MiniBitrate::High), + } + } + + #[test] + fn maps_to_mini_model_type() { + let raw = to_raw_request(sample()); + assert!(matches!(raw.model_type, KinoviModelTypeRaw::Seedance2Mini)); + } + + #[test] + fn maps_resolution_aspect_and_batch() { + let raw = to_raw_request(sample()); + assert!(matches!(raw.aspect_ratio, KinoviAspectRatioRaw::Landscape4x3)); + assert!(matches!(raw.output_resolution, Some(KinoviOutputResolutionRaw::FourEightyP))); + assert!(matches!(raw.batch_count, KinoviBatchCountRaw::Eight)); + assert!(matches!(raw.bitrate, Some(KinoviBitrateRaw::High))); + } + + #[test] + fn passes_through_prompt_duration_and_references() { + let raw = to_raw_request(sample()); + assert_eq!(raw.prompt, "a corgi"); + assert_eq!(raw.duration_seconds, 10); + assert_eq!(raw.reference_image_urls, Some(vec!["https://example.com/a.png".to_string()])); + } + + #[test] + fn default_resolution_maps_to_none() { + let mut req = sample(); + req.output_resolution = None; + let raw = to_raw_request(req); + assert!(raw.output_resolution.is_none()); + } + + #[test] + fn all_batch_counts_map() { + let expected: &[(KinoviSeedance2p0MiniBatchCount, u8)] = &[ + (KinoviSeedance2p0MiniBatchCount::One, 1), + (KinoviSeedance2p0MiniBatchCount::Two, 2), + (KinoviSeedance2p0MiniBatchCount::Three, 3), + (KinoviSeedance2p0MiniBatchCount::Four, 4), + (KinoviSeedance2p0MiniBatchCount::Five, 5), + (KinoviSeedance2p0MiniBatchCount::Six, 6), + (KinoviSeedance2p0MiniBatchCount::Seven, 7), + (KinoviSeedance2p0MiniBatchCount::Eight, 8), + ]; + for (count, n) in expected { + let mut req = sample(); + req.batch_count = Some(*count); + let raw = to_raw_request(req); + // The mapped raw batch matches the requested count's multiplier. + let mut probe = build_probe(); + probe.batch_count = Some(*count); + assert_eq!(probe.batch_multiplier(), *n, "{count:?}"); + // And the raw enum is the corresponding variant. + assert!(!matches!(raw.model_type, KinoviModelTypeRaw::Seedance2Pro)); + } + } + + fn build_probe() -> GenerateSeedance2p0MiniRequest { + GenerateSeedance2p0MiniRequest { + prompt: String::new(), + aspect_ratio: None, + output_resolution: None, + duration_seconds: 5, + batch_count: None, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + } + } + + // ── Live API tests (manual; require Kinovi cookies) ── + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + mod live { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_text_to_video_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_mini(GenerateSeedance2p0MiniArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0MiniRequest { + prompt: "A giant evil teddy bear steps on people in the city.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0MiniAspectRatio::Landscape16x9), + output_resolution: None, + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("mini t2v 720p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_text_to_video_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_mini(GenerateSeedance2p0MiniArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0MiniRequest { + prompt: "A snowman fights a bear".to_string(), + aspect_ratio: Some(KinoviSeedance2p0MiniAspectRatio::Standard4x3), + output_resolution: Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP), + batch_count: None, + duration_seconds: 10, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("mini t2v 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_reference_to_video_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_mini(GenerateSeedance2p0MiniArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0MiniRequest { + prompt: "Girl walks around in the city, giving a historical tour".to_string(), + aspect_ratio: Some(KinoviSeedance2p0MiniAspectRatio::UltraWide21x9), + output_resolution: None, + batch_count: None, + duration_seconds: 15, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260624/1782342102687-53fe5496.png".to_string(), + ]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("mini reference-to-video 720p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_video_reference_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = generate_seedance_2p0_mini(GenerateSeedance2p0MiniArgs { + session: &session, + host_override: None, + request: GenerateSeedance2p0MiniRequest { + prompt: "Change @video1 to night time.".to_string(), + aspect_ratio: Some(KinoviSeedance2p0MiniAspectRatio::Landscape16x9), + output_resolution: Some(KinoviSeedance2p0MiniOutputResolution::FourEightyP), + batch_count: None, + duration_seconds: 5, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + }).await?; + println!("mini video ref 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/generate/video/mod.rs b/crates/api_clients/seedance2pro_client/src/generate/video/mod.rs new file mode 100644 index 00000000..e4995a4f --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/generate/video/mod.rs @@ -0,0 +1,4 @@ +pub mod generate_happy_horse_1p0; +pub mod generate_seedance_2p0; +pub mod generate_seedance_2p0_fast; +pub mod generate_seedance_2p0_mini; diff --git a/crates/api_clients/seedance2pro_client/src/lib.rs b/crates/api_clients/seedance2pro_client/src/lib.rs new file mode 100644 index 00000000..9571caee --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/lib.rs @@ -0,0 +1,11 @@ +#[cfg(test)] +pub (crate) mod test_utils; + +// User API +pub mod billing; +pub mod cost; +pub mod creds; +pub mod error; +pub mod generate; +pub mod requests; +pub mod utils; diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_character/generate_character.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_character/generate_character.rs new file mode 100644 index 00000000..755aa578 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_character/generate_character.rs @@ -0,0 +1,235 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::generate_character::request_types::*; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// --- Public args --- + +pub struct GenerateCharacterArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// The name for this character. + pub name: String, + + /// A description of the character. + pub description: String, + + /// URL of the uploaded reference image (from `upload_file`). + /// NB: The Kinovi API accepts multiple images, but the UI only supports one for now. + /// We may expand this to Vec in the future. + pub reference_image_url: String, + + /// Whether the character should be publicly visible. + pub is_public: bool, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +// --- Public response --- + +#[derive(Debug)] +pub struct GenerateCharacterResponse { + /// Internal numeric ID. + pub id: u64, + + /// The character identifier (e.g. "char_1774752056469_2wlxoq"). + pub character_id: String, + + /// The name that was assigned. + pub name: String, + + /// ISO 8601 timestamp of creation. + pub created_at: String, +} + +// --- Implementation --- + +pub async fn generate_character(args: GenerateCharacterArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let url = format!("{}/api/trpc/character.createCharacter?batch=1", base_url); + + info!("Creating character '{}'", args.name); + + let request_body = BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + name: args.name, + description: args.description, + reference_image_urls: vec![args.reference_image_url], + mode: "upload", + is_public: args.is_public, + }, + }, + }; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/app/characters", base_url); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.post(&url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .json(&request_body) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Create character response: status={}, body={}", status, response_body); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let data = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + Ok(GenerateCharacterResponse { + id: data.id, + character_id: data.character_id, + name: data.name, + created_at: data.created_at, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + async fn upload_image_from_url(session: &Seedance2ProSession, image_url: &str, extension: &str) -> AnyhowResult { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes(image_url).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: extension.to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + Ok(upload_result.public_url) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_create_character_juno() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let public_url = upload_image_from_url( + &session, + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + "jpg", + ).await?; + + println!("Uploaded image: {}", public_url); + + let result = generate_character(GenerateCharacterArgs { + session: &session, + name: "Juno".to_string(), + description: "Juno the shiba inu at the lake".to_string(), + reference_image_url: public_url, + is_public: false, + host_override: None, + }).await?; + + println!("Character ID: {}", result.character_id); + println!("Name: {}", result.name); + println!("Created at: {}", result.created_at); + assert!(!result.character_id.is_empty()); + assert_eq!(result.name, "Juno"); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_create_character_ernest() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let public_url = upload_image_from_url( + &session, + test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL, + "jpg", + ).await?; + + println!("Uploaded image: {}", public_url); + + let result = generate_character(GenerateCharacterArgs { + session: &session, + name: "Ernest".to_string(), + description: "Ernest".to_string(), + reference_image_url: public_url, + is_public: false, + host_override: None, + }).await?; + + println!("Character ID: {}", result.character_id); + println!("Name: {}", result.name); + println!("Created at: {}", result.created_at); + assert!(!result.character_id.is_empty()); + assert_eq!(result.name, "Ernest"); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_character/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_character/mod.rs new file mode 100644 index 00000000..e4a02cf1 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_character/mod.rs @@ -0,0 +1,2 @@ +pub mod generate_character; +pub(crate) mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_character/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_character/request_types.rs new file mode 100644 index 00000000..a0685d65 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_character/request_types.rs @@ -0,0 +1,51 @@ +use serde_derive::{Deserialize, Serialize}; + +// ======================== Request ======================== + +#[derive(Serialize, Debug)] +pub(super) struct BatchRequest { + #[serde(rename = "0")] + pub zero: BatchRequestInner, +} + +#[derive(Serialize, Debug)] +pub(super) struct BatchRequestInner { + pub json: BatchRequestJson, +} + +#[derive(Serialize, Debug)] +pub(super) struct BatchRequestJson { + pub name: String, + pub description: String, + #[serde(rename = "referenceImageUrls")] + pub reference_image_urls: Vec, + pub mode: &'static str, + #[serde(rename = "isPublic")] + pub is_public: bool, +} + +// ======================== Response ======================== + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseData { + pub json: CharacterResponseJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct CharacterResponseJson { + pub id: u64, + pub character_id: String, + pub name: String, + pub created_at: String, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_image/generate_image.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_image/generate_image.rs new file mode 100644 index 00000000..c40c4ddc --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_image/generate_image.rs @@ -0,0 +1,951 @@ +use crate::cost::kinovi_generation_cost::KinoviGenerationCost; +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_bad_request_api_error::Seedance2ProBadRequestApiError; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::generate_image::request_types::*; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::categorize_seedance2pro_error::categorize_seedance2pro_error; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// ── Constants ── + +/// All Midjourney generations on Kinovi cost 12 credits per image-task, +/// regardless of model (v7, v7-niji, v8) or aspect ratio. Batches are billed +/// at this rate × `batch_count`. +const CREDITS_PER_MIDJOURNEY_TASK: u32 = 12; + +/// Newer Kinovi credit-package rate. Used to convert credits to USD for the +/// Midjourney image generation flow. +/// +/// 500,000 credits / $2,159.09 = 231.58 ≈ 243 credits per dollar (rounded down). + +/// Kinovi only currently exposes a single Midjourney resolution preset. +/// Kinovi moved these Midjourney models to `2k`; `1k` is no longer accepted. +const MIDJOURNEY_RESOLUTION: &str = "2k"; + +const BUSINESS_TYPE: &str = "midjourney-image-generation"; + +// ── Request args ── + +/// Wrapper that bundles a [`KinoviGenerateImageRequest`] with session and host info. +pub struct GenerateImageArgs<'a> { + pub request: KinoviGenerateImageRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +/// Image generation parameters (no session/host info). +/// +/// `aspect_ratio` and `quality` are loosely-typed strings here so this +/// function can serve image-generation flows that aren't Midjourney without +/// being constrained to Midjourney's particular set of values. The thin +/// per-model wrappers (`generate_midjourney_v7`, etc.) own strongly-typed +/// enums and convert them to strings before calling in. +#[derive(Clone)] +pub struct KinoviGenerateImageRequest { + /// Which Midjourney variant to run. + pub model: KinoviMidjourneyModel, + + /// User prompt. + pub prompt: String, + + /// Output aspect ratio, e.g. `"16:9"`, `"1:1"`, `"9:16"`. Forwarded + /// verbatim into the request's `aspectRatio` field. + pub aspect_ratio: String, + + /// Optional negative prompt. Sent as the `"no"` field on the wire. + pub negative_prompt: Option, + + /// "0 = literal, 1000 = artistic" + /// Midjourney "stylize" parameter. Valid range 0–1000. `None` omits the + /// field and lets Kinovi pick its default. + pub stylize: Option, + + /// "Unconventional aesthetics" + /// Midjourney "weird" parameter. Valid range 0–3000. + pub weird: Option, + + /// "Variation between images" + /// Midjourney "chaos" parameter. Valid range 0–100. + pub chaos: Option, + + /// Quality preset, e.g. `"0.25"`, `"0.5"`, `"1"`. Parsed as an `f32` and + /// emitted as a JSON number on the wire. `None` omits the field. + /// + /// If the string isn't a valid `f32`, `generate_image()` returns a + /// `Seedance2ProClientError::InvalidRequestField` error rather than + /// panicking. The typed wrappers always supply well-formed values, so + /// errors here only occur for callers that bypass them. + pub quality: Option, + + /// Enables Midjourney "raw" style mode when true. Sent as `"style":"raw"`. + pub raw_mode: bool, + + /// Number of distinct generations to enqueue in a single request. + pub batch_count: KinoviMidjourneyBatchCount, + + /// Optional reference image URLs. Sent on the wire as `uploadedUrls`. + /// Midjourney uses these as visual inspiration alongside the prompt. + pub reference_image_urls: Option>, +} + +impl std::fmt::Debug for KinoviGenerateImageRequest { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("GenerateImageRequest") + .field("model", &self.model) + .field("prompt", &self.prompt) + .field("aspect_ratio", &self.aspect_ratio) + .field("negative_prompt", &self.negative_prompt) + .field("stylize", &self.stylize) + .field("weird", &self.weird) + .field("chaos", &self.chaos) + .field("quality", &self.quality) + .field("raw_mode", &self.raw_mode) + .field("batch_count", &self.batch_count) + .field("reference_image_urls", &self.reference_image_urls) + .finish() + } +} + +impl std::fmt::Debug for GenerateImageArgs<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("GenerateImageArgs") + .field("request", &self.request) + .field("host_override", &self.host_override) + .finish() + } +} + +impl KinoviGenerateImageRequest { + /// Calculate the cost of this request, in Kinovi credits and USD cents + /// (rounded up). + /// + /// Pricing for Midjourney is flat: 12 credits per task, regardless of + /// model or aspect ratio. Batches multiply the cost by `batch_count`. + pub fn calculate_costs(&self) -> KinoviGenerationCost { + let credits = u64::from(CREDITS_PER_MIDJOURNEY_TASK) * u64::from(self.batch_count.as_u8()); + KinoviGenerationCost::from_kinovi_credits(credits) + } + + /// Estimates the Kinovi credit cost for this request. + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_credits(&self) -> u32 { + self.calculate_costs().kinovi_credits as u32 + } + + /// Estimates the dollar cost in USD cents. + /// NB: Rounds UP fractional cents (the historical behavior rounded to nearest). + #[deprecated(note = "Use calculate_costs() instead")] + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + self.calculate_costs().usd_cents_rounded_up + } +} + +// ── Public enums ── + +/// Midjourney model variant. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum KinoviMidjourneyModel { + /// Midjourney v7 — the current general-purpose model. + V7, + /// Midjourney v7 Niji — v7 trained for anime/illustration. + V7Niji, + /// Midjourney v8 — the newest model. + V8, +} + +impl KinoviMidjourneyModel { + fn as_api_str(&self) -> &'static str { + match self { + Self::V7 => "midjourney-v7", + Self::V7Niji => "midjourney-v7-niji", + Self::V8 => "midjourney-v8", + } + } +} + +/// Number of distinct Midjourney generations to enqueue. +/// Each task itself returns a 4-image grid; this knob just enqueues N tasks. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +pub enum KinoviMidjourneyBatchCount { + One, + Two, + Three, + Four, +} + +impl KinoviMidjourneyBatchCount { + fn as_u8(&self) -> u8 { + match self { + Self::One => 1, + Self::Two => 2, + Self::Three => 3, + Self::Four => 4, + } + } +} + +// ── Response ── + +pub struct GenerateImageResponse { + pub task_id: String, + pub order_id: String, + + /// Present when batch_count > 1. + pub task_ids: Option>, + + /// Present when batch_count > 1. + pub order_ids: Option>, +} + +// ── Implementation ── + +pub async fn generate_image(args: GenerateImageArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let run_task_url = format!("{}/api/trpc/workflow.runTask?batch=1", base_url); + + let req = args.request; + + info!("Requesting Midjourney image from Kinovi: {:?}", req); + + let batch_count_value = req.batch_count.as_u8(); + let batch_count = if batch_count_value > 1 { Some(batch_count_value) } else { None }; + + let style = if req.raw_mode { Some("raw") } else { None }; + + // Empty Vec is treated as "no references" so the field is omitted from the + // wire — Midjourney rejects empty arrays. + let uploaded_urls = req.reference_image_urls.filter(|urls| !urls.is_empty()); + + let quality = req.quality.as_deref().map(parse_quality).transpose()?; + + let request_body = BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + business_type: BUSINESS_TYPE, + api_params: ApiParams { + prompt: req.prompt, + aspect_ratio: req.aspect_ratio, + resolution: MIDJOURNEY_RESOLUTION, + model: req.model.as_api_str(), + stylize: req.stylize, + chaos: req.chaos, + weird: req.weird, + quality, + style, + negative_prompt: req.negative_prompt, + batch_count, + uploaded_urls, + }, + }, + }, + }; + + info!("Kinovi Midjourney request: {:?}", request_body); + + let cookie = args.session.cookies.as_str(); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let referer = format!("{}/", base_url); + + let response = client.post(&run_task_url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .json(&request_body) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Response status: {}, body: {}", status, response_body); + + if !status.is_success() { + return Err(categorize_seedance2pro_error(status, response_body)); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let task_data = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + if task_data.violation_warning { + return Err(Seedance2ProBadRequestApiError::VideoGenerationViolation { raw_body: response_body }.into()); + } + + Ok(GenerateImageResponse { + task_id: task_data.task_id, + order_id: task_data.order_id, + task_ids: task_data.task_ids, + order_ids: task_data.order_ids, + }) +} + +/// The wire format for `quality` is a JSON number, but the public API +/// accepts a string so future models with different quality semantics can +/// hand in whatever they like. Callers funnel through strongly-typed +/// wrapper enums whose string output is always parseable; arbitrary +/// callers might not, so we surface a structured client error instead of +/// panicking. +fn parse_quality(raw: &str) -> Result { + raw.parse::().map_err(|err| Seedance2ProClientError::InvalidRequestField { + field: "quality", + raw_value: raw.to_string(), + reason: format!("not a valid f32: {}", err), + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // ── Pricing ── + + mod pricing_tests { + use super::*; + + fn make_request(batch_count: KinoviMidjourneyBatchCount) -> KinoviGenerateImageRequest { + KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7, + prompt: String::new(), + aspect_ratio: "1:1".to_string(), + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count, + reference_image_urls: None, + } + } + + // ── Headline cost rule: 12 credits × batch_count ── + + #[test] + fn batch_one_is_twelve_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits, 12); + } + + #[test] + fn batch_two_is_twentyfour_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().kinovi_credits, 24); + } + + #[test] + fn batch_three_is_thirtysix_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Three).calculate_costs().kinovi_credits, 36); + } + + #[test] + fn batch_four_is_fortyeight_credits() { + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().kinovi_credits, 48); + } + + /// Pricing is identical across all three Midjourney models. + #[test] + fn pricing_is_model_agnostic() { + let baseline = make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits; + for model in [ + KinoviMidjourneyModel::V7, + KinoviMidjourneyModel::V7Niji, + KinoviMidjourneyModel::V8, + ] { + let req = KinoviGenerateImageRequest { model, ..make_request(KinoviMidjourneyBatchCount::One) }; + assert_eq!(req.calculate_costs().kinovi_credits, baseline, "model={:?}", model); + } + } + + /// Pricing does not vary by aspect ratio. + #[test] + fn pricing_is_aspect_ratio_agnostic() { + let baseline = make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits; + for ar in ["1:1", "16:9", "9:16", "21:9", "9:21", "4:3", "3:4", "5:4", "4:5", "3:2", "2:3"] { + let req = KinoviGenerateImageRequest { + aspect_ratio: ar.to_string(), + ..make_request(KinoviMidjourneyBatchCount::One) + }; + assert_eq!(req.calculate_costs().kinovi_credits, baseline, "aspect_ratio={:?}", ar); + } + } + + /// Pricing does not vary with the Midjourney style knobs. + #[test] + fn pricing_is_independent_of_style_knobs() { + let baseline = make_request(KinoviMidjourneyBatchCount::One).calculate_costs().kinovi_credits; + let req = KinoviGenerateImageRequest { + stylize: Some(1000), + weird: Some(3000), + chaos: Some(100), + quality: Some("1".to_string()), + raw_mode: true, + negative_prompt: Some("ugly, blurry".to_string()), + ..make_request(KinoviMidjourneyBatchCount::One) + }; + assert_eq!(req.calculate_costs().kinovi_credits, baseline); + } + + // ── USD cents conversion ── + + #[test] + fn usd_cents_batch_one() { + // 12/243 × 100 = 4.94¢ → 5¢ + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_up, 5); // 1200/243 = 4.94 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_rounded_down, 4); + assert!((make_request(KinoviMidjourneyBatchCount::One).calculate_costs().usd_cents_fractional - (1200.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_batch_two() { + // 24/243 × 100 = 9.88¢ → 10¢ + assert_eq!(make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().usd_cents_rounded_up, 10); // 2400/243 = 9.88 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().usd_cents_rounded_down, 9); + assert!((make_request(KinoviMidjourneyBatchCount::Two).calculate_costs().usd_cents_fractional - (2400.0 / 243.0)).abs() < 1e-9); + } + + #[test] + fn usd_cents_batch_four() { + // 48/243 × 100 = 19.75¢ → 20¢ + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_up, 20); // 4800/243 = 19.75 -> rounds UP + assert_eq!(make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_rounded_down, 19); + assert!((make_request(KinoviMidjourneyBatchCount::Four).calculate_costs().usd_cents_fractional - (4800.0 / 243.0)).abs() < 1e-9); + } + + /// Batch 4 should be exactly 4× the credit cost of batch 1, and the USD + /// cents conversion should track within rounding (1¢ slack). + #[test] + fn batch_4_costs_4x_credits_and_approximately_4x_dollars() { + let one = make_request(KinoviMidjourneyBatchCount::One); + let four = make_request(KinoviMidjourneyBatchCount::Four); + + assert_eq!(four.calculate_costs().kinovi_credits, one.calculate_costs().kinovi_credits * 4); + + // With round-up pricing, a batch rounds up ONCE while four singles + // round up four times — so the batch price is at most 4× the single + // price, and within 4¢ of it. + let one_cents = one.calculate_costs().usd_cents_rounded_up; + let four_cents = four.calculate_costs().usd_cents_rounded_up; + let four_singles = one_cents * 4; + assert!(four_cents <= four_singles && four_cents + 4 > four_singles, + "expected within 4¢ under {}¢, got {}¢", four_singles, four_cents); + } + } + + // ── Wire-shape ── + + mod wire_shape_tests { + use super::*; + use serde_json::Value; + + fn build_wire_json(req: KinoviGenerateImageRequest) -> Value { + try_build_wire_json(req).expect("test helper: malformed quality string") + } + + fn try_build_wire_json(req: KinoviGenerateImageRequest) -> Result { + // Mirrors the body assembly in `generate_image()` minus the actual + // network call, so we can introspect the JSON the server would see. + let batch_count_value = req.batch_count.as_u8(); + let batch_count = if batch_count_value > 1 { Some(batch_count_value) } else { None }; + let style = if req.raw_mode { Some("raw") } else { None }; + let uploaded_urls = req.reference_image_urls.filter(|urls| !urls.is_empty()); + let quality = req.quality.as_deref().map(parse_quality).transpose()?; + + let request_body = BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + business_type: BUSINESS_TYPE, + api_params: ApiParams { + prompt: req.prompt, + aspect_ratio: req.aspect_ratio, + resolution: MIDJOURNEY_RESOLUTION, + model: req.model.as_api_str(), + stylize: req.stylize, + chaos: req.chaos, + weird: req.weird, + quality, + style, + negative_prompt: req.negative_prompt, + batch_count, + uploaded_urls, + }, + }, + }, + }; + Ok(serde_json::to_value(&request_body).unwrap()) + } + + fn api_params(req: KinoviGenerateImageRequest) -> Value { + build_wire_json(req)["0"]["json"]["apiParams"].clone() + } + + fn minimal_request(model: KinoviMidjourneyModel, prompt: &str) -> KinoviGenerateImageRequest { + KinoviGenerateImageRequest { + model, + prompt: prompt.to_string(), + aspect_ratio: "1:1".to_string(), + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + } + } + + // ── Minimal: matches captured sample #1 ── + + #[test] + fn minimal_v7_matches_captured_sample() { + // Sample #1: `{"prompt":"A corgi walking in the park","aspectRatio":"1:1","resolution":"2k","model":"midjourney-v7"}` + let params = api_params(minimal_request(KinoviMidjourneyModel::V7, "A corgi walking in the park")); + assert_eq!(params["prompt"], "A corgi walking in the park"); + assert_eq!(params["aspectRatio"], "1:1"); + assert_eq!(params["resolution"], "2k"); + assert_eq!(params["model"], "midjourney-v7"); + + let obj = params.as_object().unwrap(); + let unexpected: Vec<&str> = obj.keys() + .filter(|k| !["prompt", "aspectRatio", "resolution", "model"].contains(&k.as_str())) + .map(|s| s.as_str()) + .collect(); + assert!(unexpected.is_empty(), "minimal request should omit optional fields, found: {:?}", unexpected); + } + + // ── Model strings ── + + #[test] + fn model_v7_maps_to_midjourney_v7() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V7, "p")); + assert_eq!(p["model"], "midjourney-v7"); + } + + #[test] + fn model_v7_niji_maps_to_midjourney_v7_niji() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V7Niji, "p")); + assert_eq!(p["model"], "midjourney-v7-niji"); + } + + #[test] + fn model_v8_maps_to_midjourney_v8() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V8, "p")); + assert_eq!(p["model"], "midjourney-v8"); + } + + // ── Aspect ratio strings ── + + #[test] + fn aspect_ratio_passes_through_verbatim() { + // The base API is stringly-typed for aspect_ratio — whatever the caller + // (typically a per-model wrapper) hands in must appear on the wire as-is. + for input in ["1:1", "16:9", "9:16", "21:9", "9:21", "4:3", "3:4", "5:4", "4:5", "3:2", "2:3"] { + let req = KinoviGenerateImageRequest { + aspect_ratio: input.to_string(), + ..minimal_request(KinoviMidjourneyModel::V7, "p") + }; + let p = api_params(req); + assert_eq!(p["aspectRatio"], input, "aspect_ratio={:?}", input); + } + } + + // ── Optional fields omit when None ── + + #[test] + fn optionals_omitted_when_none() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V7, "p")); + let obj = p.as_object().unwrap(); + for key in ["stylize", "chaos", "weird", "quality", "style", "no", "batchCount", "uploadedUrls"] { + assert!(!obj.contains_key(key), "expected `{}` to be omitted in minimal request", key); + } + } + + // ── Style knobs ── + + #[test] + fn stylize_serializes_when_set() { + let req = KinoviGenerateImageRequest { stylize: Some(730), ..minimal_request(KinoviMidjourneyModel::V8, "p") }; + assert_eq!(api_params(req)["stylize"], 730); + } + + #[test] + fn chaos_serializes_when_set() { + let req = KinoviGenerateImageRequest { chaos: Some(70), ..minimal_request(KinoviMidjourneyModel::V8, "p") }; + assert_eq!(api_params(req)["chaos"], 70); + } + + #[test] + fn weird_serializes_when_set() { + let req = KinoviGenerateImageRequest { weird: Some(2050), ..minimal_request(KinoviMidjourneyModel::V8, "p") }; + assert_eq!(api_params(req)["weird"], 2050); + } + + #[test] + fn stylize_zero_is_explicitly_sent_not_omitted() { + // Captured sample #9 sends explicit zeros — `None` ≠ `Some(0)` on the wire. + let req = KinoviGenerateImageRequest { + stylize: Some(0), + chaos: Some(0), + weird: Some(0), + ..minimal_request(KinoviMidjourneyModel::V7, "p") + }; + let p = api_params(req); + assert_eq!(p["stylize"], 0); + assert_eq!(p["chaos"], 0); + assert_eq!(p["weird"], 0); + } + + #[test] + fn quality_quarter_serializes_as_0_25() { + let req = KinoviGenerateImageRequest { quality: Some("0.25".to_string()), ..minimal_request(KinoviMidjourneyModel::V7, "p") }; + let q = api_params(req)["quality"].as_f64().unwrap(); + assert!((q - 0.25).abs() < 1e-6, "got {}", q); + } + + #[test] + fn quality_half_serializes_as_0_5() { + let req = KinoviGenerateImageRequest { quality: Some("0.5".to_string()), ..minimal_request(KinoviMidjourneyModel::V7, "p") }; + let q = api_params(req)["quality"].as_f64().unwrap(); + assert!((q - 0.5).abs() < 1e-6, "got {}", q); + } + + #[test] + fn quality_full_serializes_as_1_0() { + let req = KinoviGenerateImageRequest { quality: Some("1".to_string()), ..minimal_request(KinoviMidjourneyModel::V7, "p") }; + let q = api_params(req)["quality"].as_f64().unwrap(); + assert!((q - 1.0).abs() < 1e-6, "got {}", q); + } + + #[test] + fn quality_with_non_numeric_string_returns_client_error() { + // The base function accepts strings; malformed input surfaces as a + // structured `Seedance2ProClientError::InvalidRequestField` rather + // than panicking. + let req = KinoviGenerateImageRequest { + quality: Some("not-a-number".to_string()), + ..minimal_request(KinoviMidjourneyModel::V7, "p") + }; + let err = try_build_wire_json(req).expect_err("expected an error"); + match err { + Seedance2ProClientError::InvalidRequestField { field, raw_value, .. } => { + assert_eq!(field, "quality"); + assert_eq!(raw_value, "not-a-number"); + } + other => panic!("expected InvalidRequestField, got {:?}", other), + } + } + + // ── Raw mode ── + + #[test] + fn raw_mode_true_sends_style_raw() { + let req = KinoviGenerateImageRequest { raw_mode: true, ..minimal_request(KinoviMidjourneyModel::V7, "p") }; + assert_eq!(api_params(req)["style"], "raw"); + } + + #[test] + fn raw_mode_false_omits_style() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V7, "p")); + assert!(p.as_object().unwrap().get("style").is_none()); + } + + // ── Negative prompt → `"no"` field ── + + #[test] + fn negative_prompt_serializes_as_no_field() { + let req = KinoviGenerateImageRequest { + negative_prompt: Some("dark, gloomy, night".to_string()), + ..minimal_request(KinoviMidjourneyModel::V7, "p") + }; + let p = api_params(req); + assert_eq!(p["no"], "dark, gloomy, night"); + assert!(p.as_object().unwrap().get("negative_prompt").is_none(), "must not leak field name"); + assert!(p.as_object().unwrap().get("negativePrompt").is_none(), "must not leak camelCase variant"); + } + + // ── Batch count ── + + #[test] + fn batch_one_omits_batch_count() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V7, "p")); + assert!(p.as_object().unwrap().get("batchCount").is_none()); + } + + #[test] + fn batch_two_sends_batch_count_2() { + let req = KinoviGenerateImageRequest { batch_count: KinoviMidjourneyBatchCount::Two, ..minimal_request(KinoviMidjourneyModel::V7, "p") }; + assert_eq!(api_params(req)["batchCount"], 2); + } + + #[test] + fn batch_three_sends_batch_count_3() { + let req = KinoviGenerateImageRequest { batch_count: KinoviMidjourneyBatchCount::Three, ..minimal_request(KinoviMidjourneyModel::V7Niji, "p") }; + assert_eq!(api_params(req)["batchCount"], 3); + } + + #[test] + fn batch_four_sends_batch_count_4() { + let req = KinoviGenerateImageRequest { batch_count: KinoviMidjourneyBatchCount::Four, ..minimal_request(KinoviMidjourneyModel::V7, "p") }; + assert_eq!(api_params(req)["batchCount"], 4); + } + + // ── businessType and trpc envelope ── + + #[test] + fn business_type_is_midjourney_image_generation() { + let body = build_wire_json(minimal_request(KinoviMidjourneyModel::V7, "p")); + assert_eq!(body["0"]["json"]["businessType"], "midjourney-image-generation"); + } + + #[test] + fn resolution_is_2k() { + let p = api_params(minimal_request(KinoviMidjourneyModel::V7, "p")); + assert_eq!(p["resolution"], "2k"); + } + + // ── Captured-sample replay (#9: kitchen sink) ── + + /// Reconstructs the captured sample #9 (V7 + raw + all knobs + negative + /// prompt) and asserts the wire matches byte-for-byte. + #[test] + fn captured_sample_9_matches_byte_for_byte() { + let req = KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7, + prompt: "abandoned skyscrapers".to_string(), + aspect_ratio: "1:1".to_string(), + negative_prompt: Some("dark, gloomy, night".to_string()), + stylize: Some(1000), + weird: Some(3000), + chaos: Some(100), + quality: Some("0.5".to_string()), + raw_mode: true, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }; + let got = api_params(req); + let expected: Value = serde_json::from_str( + r#"{"prompt":"abandoned skyscrapers","aspectRatio":"1:1","resolution":"2k","model":"midjourney-v7","stylize":1000,"chaos":100,"weird":3000,"quality":0.5,"style":"raw","no":"dark, gloomy, night"}"#, + ).unwrap(); + assert_eq!(got, expected); + } + + /// Captured sample #12 (V8 + batch 4). + #[test] + fn captured_sample_12_batch_4() { + let req = KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V8, + prompt: "desolate cliff overlooking the ocean".to_string(), + aspect_ratio: "9:16".to_string(), + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: Some("1".to_string()), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::Four, + reference_image_urls: None, + }; + let got = api_params(req); + let expected: Value = serde_json::from_str( + r#"{"prompt":"desolate cliff overlooking the ocean","aspectRatio":"9:16","resolution":"2k","model":"midjourney-v8","batchCount":4,"quality":1.0}"#, + ).unwrap(); + assert_eq!(got, expected); + } + + /// Real capture (2026-07-01): V7-niji + batch 3 + all knobs. `seed` is + /// present in the real request but not yet supported by the client, so + /// it is excluded from the expected shape here. + #[test] + fn captured_v7_niji_batch_3_matches_except_seed() { + let req = KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7Niji, + prompt: "A shiba walking in the park".to_string(), + aspect_ratio: "16:9".to_string(), + negative_prompt: Some("bad quality, green".to_string()), + stylize: Some(80), + weird: Some(700), + chaos: Some(15), + quality: Some("0.25".to_string()), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::Three, + reference_image_urls: None, + }; + let got = api_params(req); + let expected: Value = serde_json::from_str( + r#"{"prompt":"A shiba walking in the park","aspectRatio":"16:9","resolution":"2k","model":"midjourney-v7-niji","batchCount":3,"stylize":80,"chaos":15,"weird":700,"quality":0.25,"no":"bad quality, green"}"#, + ).unwrap(); + assert_eq!(got, expected); + } + } + + // ── Real requests (manually run; require live cookies and cost credits) ── + + mod real_requests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v7_minimal() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateImageArgs { + session: &session, + host_override: None, + request: KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7, + prompt: "A corgi astronaut floating among stars".to_string(), + aspect_ratio: "1:1".to_string(), + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }; + let result = generate_image(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v7_niji_anime() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateImageArgs { + session: &session, + host_override: None, + request: KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V7Niji, + prompt: "A magical shiba inu sorcerer casting spells in a crystal cave".to_string(), + aspect_ratio: "21:9".to_string(), + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }; + let result = generate_image(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs credits + async fn test_generate_v8_all_knobs() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateImageArgs { + session: &session, + host_override: None, + request: KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V8, + prompt: "A magical shiba inu sorcerer casting spells in a crystal cave".to_string(), + aspect_ratio: "1:1".to_string(), + negative_prompt: Some("dark, gloomy".to_string()), + stylize: Some(730), + weird: Some(2050), + chaos: Some(70), + quality: Some("0.5".to_string()), + raw_mode: true, + batch_count: KinoviMidjourneyBatchCount::One, + reference_image_urls: None, + }, + }; + let result = generate_image(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs 48 credits + async fn test_generate_v8_batch_4() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateImageArgs { + session: &session, + host_override: None, + request: KinoviGenerateImageRequest { + model: KinoviMidjourneyModel::V8, + prompt: "desolate cliff overlooking the ocean".to_string(), + aspect_ratio: "9:16".to_string(), + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: Some("1".to_string()), + raw_mode: false, + batch_count: KinoviMidjourneyBatchCount::Four, + reference_image_urls: None, + }, + }; + let result = generate_image(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + println!("All task IDs: {:?}", result.task_ids); + println!("All order IDs: {:?}", result.order_ids); + assert!(!result.task_id.is_empty()); + assert_eq!(result.task_ids.as_ref().map(|v| v.len()), Some(4), "batch 4 should return 4 task IDs"); + Ok(()) + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_image/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_image/mod.rs new file mode 100644 index 00000000..a4af23de --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_image/mod.rs @@ -0,0 +1,2 @@ +pub mod generate_image; +mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_image/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_image/request_types.rs new file mode 100644 index 00000000..5c426c82 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_image/request_types.rs @@ -0,0 +1,83 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequest { + #[serde(rename = "0")] + pub zero: BatchRequestInner, +} + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequestInner { + pub json: BatchRequestJson, +} + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequestJson { + #[serde(rename = "businessType")] + pub business_type: &'static str, + #[serde(rename = "apiParams")] + pub api_params: ApiParams, +} + +#[derive(Serialize, Debug)] +pub (super) struct ApiParams { + pub prompt: String, + #[serde(rename = "aspectRatio")] + pub aspect_ratio: String, + pub resolution: &'static str, + pub model: &'static str, + + #[serde(skip_serializing_if = "Option::is_none")] + pub stylize: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub chaos: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub weird: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub quality: Option, + + /// Sent as `"raw"` for raw mode; omitted otherwise. Currently `"raw"` is + /// the only documented value. + #[serde(skip_serializing_if = "Option::is_none")] + pub style: Option<&'static str>, + + /// Negative prompt. Sent as the field `"no"` to match Midjourney's + /// CLI-style convention. + #[serde(rename = "no", skip_serializing_if = "Option::is_none")] + pub negative_prompt: Option, + + /// Number of distinct image generations to enqueue. Omitted when 1 + /// (Midjourney returns four images per task regardless). + #[serde(rename = "batchCount", skip_serializing_if = "Option::is_none")] + pub batch_count: Option, + + /// Reference image URLs. When present, Midjourney uses them as visual + /// inspiration alongside the prompt. + #[serde(rename = "uploadedUrls", skip_serializing_if = "Option::is_none")] + pub uploaded_urls: Option>, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseData { + pub json: TaskResponseJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub (super) struct TaskResponseJson { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, + pub violation_warning: bool, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_video/generate_video.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_video/generate_video.rs new file mode 100644 index 00000000..5661e2be --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_video/generate_video.rs @@ -0,0 +1,1470 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_bad_request_api_error::Seedance2ProBadRequestApiError; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::generate_video::request_types::*; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::categorize_seedance2pro_error::categorize_seedance2pro_error; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// --- Request args --- + +/// Wrapper that bundles a [`KinoviGenerateVideoRequest`] with session and host info. +pub struct GenerateVideoArgs<'a> { + pub request: KinoviGenerateVideoRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +/// Video generation parameters (no session/host info). +#[derive(Clone)] +pub struct KinoviGenerateVideoRequest { + /// Seedance 2.0 Pro vs Fast + pub model_type: KinoviModelType, + + pub prompt: String, + + /// The aspect ratio + /// (Kinovi terms this "resolution" in the API, confusingly.) + pub aspect_ratio: KinoviAspectRatio, + + /// The resolution + /// Output resolution quality (480p, 720p, 1080p). None defaults to 720p. + /// (Kinovi terms this "outputResolution" in the API, which is confusingly named) + pub output_resolution: Option, + + /// Duration in seconds (4–15). + pub duration_seconds: u8, + + pub batch_count: KinoviBatchCount, + + /// Optional start frame image URL (keyframe mode). + pub start_frame_url: Option, + + /// Optional end frame image URL (keyframe mode). + pub end_frame_url: Option, + + /// Optional reference image URLs (reference mode). + /// When present, takes priority over start/end frames. + pub reference_image_urls: Option>, + + /// Optional reference video URLs (reference mode). + /// Can be combined with reference_image_urls. + /// Videos are referenced in prompts as @video1, @video2, etc. + /// When present, takes priority over start/end frames. + pub reference_video_urls: Option>, + + /// Optional reference audio URLs (reference mode). + /// Audio is referenced in prompts as @audio1, @audio2, etc. + /// Sent in a separate `audioUrls` field (not in `uploadedUrls`). + pub reference_audio_urls: Option>, + + /// Optional Kinovi character IDs to reference in the prompt. + /// Characters are referenced in prompts as @CharacterName. + pub character_ids: Option>, + + /// Controls the `faceBlurMode` field: true sends "on", false sends "off", None omits it. + pub use_face_blur_hack: Option, +} + +impl std::fmt::Debug for KinoviGenerateVideoRequest { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("GenerateVideoRequest") + .field("model_type", &self.model_type) + .field("prompt", &self.prompt) + .field("aspect_ratio", &self.aspect_ratio) + .field("duration_seconds", &self.duration_seconds) + .field("batch_count", &self.batch_count) + .field("start_frame_url", &self.start_frame_url) + .field("end_frame_url", &self.end_frame_url) + .field("reference_image_urls", &self.reference_image_urls) + .field("reference_video_urls", &self.reference_video_urls) + .field("reference_audio_urls", &self.reference_audio_urls) + .field("character_ids", &self.character_ids) + .field("output_resolution", &self.output_resolution) + .field("use_face_blur_hack", &self.use_face_blur_hack) + .finish() + } +} + +impl std::fmt::Debug for GenerateVideoArgs<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("GenerateVideoArgs") + .field("request", &self.request) + .field("host_override", &self.host_override) + .finish() + } +} + +impl KinoviGenerateVideoRequest { + /// Estimates the credit cost for this generation request. + /// + /// Pricing is per-second × batch count, with the per-second rate + /// depending on model type and output resolution: + /// + /// | Model | 480p | 720p | 1080p | + /// |-----------|------|------|-------| + /// | Pro | 15 | 40 | 90 | + /// | Fast | 10 | 28 | n/a | + /// + /// Input mode (text, keyframe, reference) has no effect on cost. + /// Aspect ratio (`resolution` field) has no effect on cost. + pub fn estimate_credits(&self) -> u32 { + let credits_per_second: u32 = match (self.model_type, self.output_resolution) { + // Seedance 2.0 Pro + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::FourEightyP)) => 15, + (KinoviModelType::Seedance2Pro, None) + | (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::SevenTwentyP)) => 40, + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::TenEightyP)) => 90, + + // Seedance 2.0 Fast + (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::FourEightyP)) => 10, + (KinoviModelType::Seedance2Fast, None) + | (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::SevenTwentyP)) => 28, + // NB: 1080p not officially supported for Fast, but price as 720p if requested + (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::TenEightyP)) => 28, + }; + + let per_video = u32::from(self.duration_seconds) * credits_per_second; + let batch_multiplier: u32 = match self.batch_count { + KinoviBatchCount::One => 1, + KinoviBatchCount::Two => 2, + KinoviBatchCount::Four => 4, + }; + per_video * batch_multiplier + } + + /// Credits per dollar for billing conversion. + /// + /// Legacy 720p pricing uses the original Kinovi credit package rates. + /// All other model/resolution combos use the newer rate: 525,000 credits / $2,159.0909. + fn credits_per_dollar(&self) -> f64 { + match (self.model_type, self.output_resolution) { + // Legacy: Seedance 2.0 Pro @ 720p — 25,000 credits for $99.99 + (KinoviModelType::Seedance2Pro, None) + | (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::SevenTwentyP)) => 250.0, + + // Legacy: Seedance 2.0 Fast @ 720p — 22,000 credits for $99.99 + (KinoviModelType::Seedance2Fast, None) + | (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::SevenTwentyP)) => 220.0, + + // New pricing: 525,000 credits for $2,159.0909 (~243.16 credits/$1) + _ => 243.0, + } + } + + pub fn estimate_cost_in_usd_cents(&self) -> u64 { + let credits = self.estimate_credits() as f64; + let credits_per_dollar = self.credits_per_dollar(); + let cost = credits / credits_per_dollar * 100.0; + cost.round() as u64 + } +} + +// --- Public enums --- + +/// Video resolution / aspect ratio. +#[derive(Debug, Clone, Copy)] +pub enum KinoviAspectRatio { + /// 16:9 landscape (1280x720) + Landscape16x9, + /// 21:9 ultra-wide (1280x540) + UltraWide21x9, + /// 9:16 portrait (720x1280) + Portrait9x16, + /// 1:1 square (720x720) + Square1x1, + /// 4:3 standard (960x720) + Standard4x3, + /// 3:4 portrait (720x960) + Portrait3x4, +} + +impl KinoviAspectRatio { + fn as_str(&self) -> &'static str { + match self { + Self::Landscape16x9 => "1280x720", + Self::UltraWide21x9 => "1280x540", + Self::Portrait9x16 => "720x1280", + Self::Square1x1 => "720x720", + Self::Standard4x3 => "960x720", + Self::Portrait3x4 => "720x960", + } + } +} + +/// Output resolution quality. When omitted, defaults to 720p. +#[derive(Debug, Clone, Copy)] +pub enum KinoviOutputResolution { + /// 480p + FourEightyP, + /// 720p (default — omitting the field gives this) + SevenTwentyP, + /// 1080p + TenEightyP, +} + +impl KinoviOutputResolution { + /// Returns the API string to send, or None for 720p (the default, which is + /// expressed by omitting the field entirely). + pub fn as_api_str(&self) -> Option<&'static str> { + match self { + Self::FourEightyP => Some("480p"), + Self::SevenTwentyP => None, // Default — omit from request + Self::TenEightyP => Some("1080p"), + } + } +} + +/// Number of videos to generate in a single request. +#[derive(Debug, Clone, Copy)] +pub enum KinoviBatchCount { + One, + Two, + Four, +} + +impl KinoviBatchCount { + fn as_u8(&self) -> u8 { + match self { + Self::One => 1, + Self::Two => 2, + Self::Four => 4, + } + } +} + +/// The Seedance model variant to use. +#[derive(Debug, Clone, Copy)] +pub enum KinoviModelType { + /// Seedance 2.0 Pro (higher quality, slower). + Seedance2Pro, + /// Seedance 2.0 Fast (lower quality, faster). + Seedance2Fast, +} + +impl KinoviModelType { + fn as_api_str(&self) -> &'static str { + match self { + Self::Seedance2Pro => "seedance-20", + Self::Seedance2Fast => "seedance2-fast", + } + } +} + +// --- Response --- + +pub struct GenerateVideoResponse { + pub task_id: String, + + pub order_id: String, + + /// Present when batch_count > 1. + pub task_ids: Option>, + + /// Present when batch_count > 1. + pub order_ids: Option>, +} + +// --- Implementation --- + +pub async fn generate_video(args: GenerateVideoArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let run_task_url = format!("{}/api/trpc/workflow.runTask?batch=1", base_url); + + let req = args.request; + + info!("Requesting video from Seedance2Pro: {:?}", req); + + let has_reference_images = req.reference_image_urls.as_ref().is_some_and(|urls| !urls.is_empty()); + let has_reference_videos = req.reference_video_urls.as_ref().is_some_and(|urls| !urls.is_empty()); + let has_reference_audio = req.reference_audio_urls.as_ref().is_some_and(|urls| !urls.is_empty()); + let has_characters = req.character_ids.as_ref().is_some_and(|ids| !ids.is_empty()); + + let is_reference_mode = has_reference_images || has_reference_videos || has_reference_audio || has_characters; + + let video_input_mode = if is_reference_mode { "reference" } else { "keyframe" }; + + let uploaded_urls: Option> = if is_reference_mode { + let mut urls = Vec::new(); + if let Some(video_urls) = req.reference_video_urls { + urls.extend(video_urls); + } + if let Some(image_urls) = req.reference_image_urls { + urls.extend(image_urls); + } + if urls.is_empty() { None } else { Some(urls) } + } else { + let mut urls = Vec::new(); + if let Some(url) = req.start_frame_url { + urls.push(url); + } + if let Some(url) = req.end_frame_url { + urls.push(url); + } + if urls.is_empty() { None } else { Some(urls) } + }; + + let audio_urls: Option> = if has_reference_audio { + req.reference_audio_urls + } else { + None + }; + + let face_blur_mode = match req.use_face_blur_hack { + Some(true) => Some("on"), + Some(false) => Some("off"), + None => None, + }; + + let batch_count_value = req.batch_count.as_u8(); + let batch_count = if batch_count_value > 1 { Some(batch_count_value) } else { None }; + + let duration = format!("{}s", req.duration_seconds); + + info!( + "Generating video: mode={}, resolution={}, duration={}, batch={}", + video_input_mode, req.aspect_ratio.as_str(), duration, batch_count_value + ); + + let request_body = BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + business_type: "wan22-video-generation", + api_params: ApiParams { + prompt: req.prompt, + resolution: req.aspect_ratio.as_str().to_string(), + content_mode: "normal", + model: req.model_type.as_api_str(), + duration, + mode: video_input_mode, + output_resolution: req.output_resolution.and_then(|r| r.as_api_str()), + face_blur_mode, + character_ids: req.character_ids, + uploaded_urls, + audio_urls, + batch_count, + }, + }, + }, + }; + + info!("Seedance2pro request : {:?}", request_body); + + let cookie = args.session.cookies.as_str(); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let referer = format!("{}/", base_url); + + let response = client.post(&run_task_url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .json(&request_body) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Response status: {}, body: {}", status, response_body); + + if !status.is_success() { + return Err(categorize_seedance2pro_error(status, response_body)); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let task_data = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + if task_data.violation_warning { + return Err(Seedance2ProBadRequestApiError::VideoGenerationViolation { raw_body: response_body }.into()); + } + + Ok(GenerateVideoResponse { + task_id: task_data.task_id, + order_id: task_data.order_id, + task_ids: task_data.task_ids, + order_ids: task_data.order_ids, + }) +} + +#[cfg(test)] +mod tests { + use std::fs; + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + + mod pricing_tests { + use super::*; + + fn make_args( + model_type: KinoviModelType, + duration_seconds: u8, + batch_count: KinoviBatchCount, + output_resolution: Option, + ) -> KinoviGenerateVideoRequest { + KinoviGenerateVideoRequest { + model_type, + prompt: String::new(), + aspect_ratio: KinoviAspectRatio::Square1x1, + duration_seconds, + batch_count, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + output_resolution, + use_face_blur_hack: None, + } + } + + fn pro(dur: u8, batch: KinoviBatchCount) -> KinoviGenerateVideoRequest { + make_args(KinoviModelType::Seedance2Pro, dur, batch, None) + } + + fn pro_res(dur: u8, batch: KinoviBatchCount, res: KinoviOutputResolution) -> KinoviGenerateVideoRequest { + make_args(KinoviModelType::Seedance2Pro, dur, batch, Some(res)) + } + + fn fast(dur: u8, batch: KinoviBatchCount) -> KinoviGenerateVideoRequest { + make_args(KinoviModelType::Seedance2Fast, dur, batch, None) + } + + fn fast_res(dur: u8, batch: KinoviBatchCount, res: KinoviOutputResolution) -> KinoviGenerateVideoRequest { + make_args(KinoviModelType::Seedance2Fast, dur, batch, Some(res)) + } + + // ── Spot checks: exact values from the pricing table ── + + #[test] + fn spot_check_pro_720p() { + // Pro 720p = 40 credits/sec (default when output_resolution is None) + assert_eq!(pro(5, KinoviBatchCount::One).estimate_credits(), 200); + assert_eq!(pro(10, KinoviBatchCount::One).estimate_credits(), 400); + assert_eq!(pro(15, KinoviBatchCount::One).estimate_credits(), 600); + } + + #[test] + fn spot_check_pro_480p() { + // Pro 480p = 15 credits/sec + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(), 75); + assert_eq!(pro_res(10, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(), 150); + assert_eq!(pro_res(15, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(), 225); + } + + #[test] + fn spot_check_pro_1080p() { + // Pro 1080p = 90 credits/sec + assert_eq!(pro_res(4, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 360); + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 450); + assert_eq!(pro_res(6, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 540); + assert_eq!(pro_res(7, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 630); + assert_eq!(pro_res(8, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 720); + assert_eq!(pro_res(9, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 810); + assert_eq!(pro_res(10, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 900); + assert_eq!(pro_res(11, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 990); + assert_eq!(pro_res(12, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 1080); + assert_eq!(pro_res(13, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 1170); + assert_eq!(pro_res(14, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 1260); + assert_eq!(pro_res(15, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(), 1350); + } + + #[test] + fn spot_check_fast_720p() { + // Fast 720p = 28 credits/sec + assert_eq!(fast(5, KinoviBatchCount::One).estimate_credits(), 140); + assert_eq!(fast(10, KinoviBatchCount::One).estimate_credits(), 280); + } + + #[test] + fn spot_check_fast_480p() { + // Fast 480p = 10 credits/sec + assert_eq!(fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(), 50); + assert_eq!(fast_res(10, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(), 100); + } + + // ── Pro is more expensive than Fast at the same resolution ── + + #[test] + fn pro_more_expensive_than_fast_720p() { + let p = pro(5, KinoviBatchCount::One).estimate_credits(); + let f = fast(5, KinoviBatchCount::One).estimate_credits(); + assert!(p > f, "Pro 720p ({}) should be more than Fast 720p ({})", p, f); + } + + #[test] + fn pro_more_expensive_than_fast_480p() { + let p = pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(); + let f = fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(); + assert!(p > f, "Pro 480p ({}) should be more than Fast 480p ({})", p, f); + } + + // ── Higher resolution is more expensive ── + + #[test] + fn pro_1080p_more_than_720p_more_than_480p() { + let c480 = pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(); + let c720 = pro(5, KinoviBatchCount::One).estimate_credits(); + let c1080 = pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_credits(); + assert!(c480 < c720, "480p ({}) should be less than 720p ({})", c480, c720); + assert!(c720 < c1080, "720p ({}) should be less than 1080p ({})", c720, c1080); + } + + #[test] + fn fast_720p_more_than_480p() { + let c480 = fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_credits(); + let c720 = fast(5, KinoviBatchCount::One).estimate_credits(); + assert!(c480 < c720, "Fast 480p ({}) should be less than Fast 720p ({})", c480, c720); + } + + // ── None output_resolution same as explicit 720p ── + + #[test] + fn pro_none_same_as_720p() { + let none = pro(5, KinoviBatchCount::One).estimate_credits(); + let explicit = pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::SevenTwentyP).estimate_credits(); + assert_eq!(none, explicit); + } + + #[test] + fn fast_none_same_as_720p() { + let none = fast(5, KinoviBatchCount::One).estimate_credits(); + let explicit = fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::SevenTwentyP).estimate_credits(); + assert_eq!(none, explicit); + } + + // ── Table-driven: batch × duration × model × resolution spot checks ── + + #[test] + fn table_driven_credits() { + // (model, output_res, duration, batch, expected_credits) + let cases: Vec<(KinoviModelType, Option, u8, KinoviBatchCount, u32)> = vec![ + // Pro 720p (40/sec) + (KinoviModelType::Seedance2Pro, None, 4, KinoviBatchCount::One, 160), + (KinoviModelType::Seedance2Pro, None, 5, KinoviBatchCount::Two, 400), + (KinoviModelType::Seedance2Pro, None, 10, KinoviBatchCount::Four, 1600), + // Pro 480p (15/sec) + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::FourEightyP), 5, KinoviBatchCount::One, 75), + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::FourEightyP), 10, KinoviBatchCount::Two, 300), + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::FourEightyP), 15, KinoviBatchCount::Four, 900), + // Pro 1080p (90/sec) + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::TenEightyP), 5, KinoviBatchCount::One, 450), + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::TenEightyP), 10, KinoviBatchCount::Two, 1800), + (KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::TenEightyP), 15, KinoviBatchCount::Four, 5400), + // Fast 720p (28/sec) + (KinoviModelType::Seedance2Fast, None, 4, KinoviBatchCount::One, 112), + (KinoviModelType::Seedance2Fast, None, 5, KinoviBatchCount::Two, 280), + (KinoviModelType::Seedance2Fast, None, 15, KinoviBatchCount::Four, 1680), + // Fast 480p (10/sec) + (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::FourEightyP), 5, KinoviBatchCount::One, 50), + (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::FourEightyP), 10, KinoviBatchCount::Two, 200), + (KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::FourEightyP), 15, KinoviBatchCount::Four, 600), + ]; + + for (i, (model, res, dur, batch, expected)) in cases.iter().enumerate() { + let args = make_args(*model, *dur, *batch, *res); + let actual = args.estimate_credits(); + assert_eq!( + actual, *expected, + "Case {}: {:?} {:?} {}s batch {:?} — expected {} credits, got {}", + i, model, res, dur, batch, expected, actual, + ); + } + } + + // ── Aspect ratio doesn't affect cost ── + + #[test] + fn aspect_ratio_does_not_affect_credits() { + let resolutions = [ + KinoviAspectRatio::Landscape16x9, + KinoviAspectRatio::Portrait9x16, + KinoviAspectRatio::Square1x1, + KinoviAspectRatio::Standard4x3, + KinoviAspectRatio::Portrait3x4, + ]; + + let baseline = pro(5, KinoviBatchCount::One).estimate_credits(); + + for res in &resolutions { + let req = KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: String::new(), + aspect_ratio: *res, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + output_resolution: None, + use_face_blur_hack: None, + }; + assert_eq!( + req.estimate_credits(), baseline, + "Aspect ratio {:?} should not change credits from baseline {}", + res, baseline, + ); + } + } + + // ── USD cents: legacy 720p pricing ── + + #[test] + fn usd_cents_legacy_pro_720p() { + // 250 credits/$1: 200 credits = 80¢ + assert_eq!(pro(5, KinoviBatchCount::One).estimate_cost_in_usd_cents(), 80); + assert_eq!(pro(10, KinoviBatchCount::One).estimate_cost_in_usd_cents(), 160); + assert_eq!(pro(15, KinoviBatchCount::One).estimate_cost_in_usd_cents(), 240); + // Batch 2 + assert_eq!(pro(5, KinoviBatchCount::Two).estimate_cost_in_usd_cents(), 160); + // Batch 4 + assert_eq!(pro(5, KinoviBatchCount::Four).estimate_cost_in_usd_cents(), 320); + } + + #[test] + fn usd_cents_legacy_fast_720p() { + // 220 credits/$1: 140 credits = 57.61 → 58¢ + assert_eq!(fast(5, KinoviBatchCount::One).estimate_cost_in_usd_cents(), 64); + assert_eq!(fast(10, KinoviBatchCount::One).estimate_cost_in_usd_cents(), 127); + } + + // ── USD cents: new pricing (22000 credits / $114) ── + + #[test] + fn usd_cents_new_pro_480p() { + // 243 credits/$1: 75 credits = 30.86 → 31¢ + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_cost_in_usd_cents(), 31); + assert_eq!(pro_res(10, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_cost_in_usd_cents(), 62); + } + + #[test] + fn usd_cents_new_pro_1080p() { + // 243 credits/$1: 450 credits = 185.19 → 185¢ + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_cost_in_usd_cents(), 185); + // 900 credits = 370.37 → 370¢ + assert_eq!(pro_res(10, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).estimate_cost_in_usd_cents(), 370); + } + + #[test] + fn usd_cents_new_fast_480p() { + // 243 credits/$1: 50 credits = 20.58 → 21¢ + assert_eq!(fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_cost_in_usd_cents(), 21); + assert_eq!(fast_res(10, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).estimate_cost_in_usd_cents(), 41); + } + + // ── credits_per_dollar: verify the rates directly ── + + #[test] + fn credits_per_dollar_legacy_rates() { + assert_eq!(pro(5, KinoviBatchCount::One).credits_per_dollar(), 250.0); + assert_eq!(fast(5, KinoviBatchCount::One).credits_per_dollar(), 220.0); + // Explicit 720p = same as None + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::SevenTwentyP).credits_per_dollar(), 250.0); + assert_eq!(fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::SevenTwentyP).credits_per_dollar(), 220.0); + } + + #[test] + fn credits_per_dollar_new_rate() { + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).credits_per_dollar(), 243.0); + assert_eq!(pro_res(5, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).credits_per_dollar(), 243.0); + assert_eq!(fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::FourEightyP).credits_per_dollar(), 243.0); + // Fast 1080p (not officially supported) also uses new rate + assert_eq!(fast_res(5, KinoviBatchCount::One, KinoviOutputResolution::TenEightyP).credits_per_dollar(), 243.0); + } + } + + mod real_requests { + use super::*; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_generate_text_to_video() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "A corgi eating a cake in a fancy kitchen.".to_string(), + aspect_ratio: KinoviAspectRatio::Square1x1, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_generate_keyframe_video() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "A dog shakes the glasses off its head. The camera pans out as the shiba shakes. The shiba barks.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: Some("https://static.seedance2-pro.com/materials/20260219/1771496300184-fb32e08c.jpg".to_string()), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_generate_reference_image_video() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "The dog in @2 is in the office at @1 without the man. The office is dark and moonlight streams in through the windows. Particles of dust gleam in the moon beams. Suddenly, the dog jumps walks in front of the desk and barks.".to_string(), + aspect_ratio: KinoviAspectRatio::Standard4x3, + duration_seconds: 10, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260219/1771463564512-b14bfe90.png".to_string(), + "https://static.seedance2-pro.com/materials/20260219/1771496300184-fb32e08c.jpg".to_string(), + ]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_generate_reference_video_only() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "Change the Video @video1 to night time.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_generate_reference_video_and_image() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "Put the robot in @video1 next to the house in @image1".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773595053724-07a1d500.png".to_string(), + ]), + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and a test image + async fn test_video_ref_file_that_is_too_long() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + + // Step 1: Get a signed upload URL + let cookies = get_test_cookies()?; + let session = Seedance2ProSession::from_cookies_string(cookies); + let prepare_args = PrepareFileUploadArgs { + session: &session, + extension: "mp4".to_string(), + host_override: None, + }; + let prepare_result = prepare_file_upload(prepare_args).await?; + println!("Upload URL: {}", prepare_result.upload_url); + + // Step 2: Read a test image + let file_bytes = fs::read("/Users/bt/Videos/Artcraft/Artcraft Best/ArtCraft Seedance Knight.mp4")?; + println!("File size: {} bytes", file_bytes.len()); + + // Step 3: Upload + let upload_args = UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes, + host_override: None, + }; + let result = upload_file(upload_args).await?; + println!("Public URL: {}", result.public_url); + + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "Change @video1 to night time".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![ + result.public_url, + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_pro_keyframe_with_start_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + // Upload a start frame image from our CDN + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded start frame: {}", upload_result.public_url); + + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "The corgi dog watches the lake.".to_string(), + aspect_ratio: KinoviAspectRatio::Portrait9x16, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: Some(upload_result.public_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + // --- Seedance 2 Fast tests --- + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_fast_keyframe_with_start_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + // Upload a start frame image from our CDN + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded start frame: {}", upload_result.public_url); + + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Fast, + prompt: "A corgi dog runs along the lake shore, splashing water. Camera follows.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: Some(upload_result.public_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_fast_three_image_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + // Upload three reference images from our CDN + let image_urls_to_upload = [ + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL, + test_data::web::image_urls::FOREST_BACKDROP_IMAGE_URL, + ]; + + let mut uploaded_urls = Vec::new(); + for (i, source_url) in image_urls_to_upload.iter().enumerate() { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes(source_url).await?; + let ext = if source_url.ends_with(".png") { "png" } else { "jpg" }; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: ext.to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded ref image {}: {}", i + 1, upload_result.public_url); + uploaded_urls.push(upload_result.public_url); + } + + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Fast, + prompt: "The dog in @1 is running through the scenery in @3 towards the building in @2. Golden hour lighting.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(uploaded_urls), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_fast_audio_reference_with_text() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + // Upload a test audio file + let audio_path = test_utils::test_file_path::test_file_path( + "test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3", + )?; + let audio_bytes = fs::read(&audio_path)?; + println!("Audio file size: {} bytes", audio_bytes.len()); + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "mp3".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: audio_bytes, + host_override: None, + }).await?; + + println!("Uploaded audio: {}", upload_result.public_url); + + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Fast, + prompt: "A fantasy forest with mushrooms glowing in the dark. Fireflies dance between the trees. A small character walks along a winding path.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: Some(vec![upload_result.public_url]), + character_ids: None, + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + mod character_tests { + use super::*; + + const STEAMPUNK_CLOWN_ID: &str = "char_1775176566518_sik0te"; + const MOCHI_ID: &str = "char_1775177718294_g2pitx"; + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs money + async fn test_text_prompt_with_character_pro() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "@Steampunk Clown is juggling flaming torches in a circus tent.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string()]), + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs money + async fn test_text_prompt_with_character_fast() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Fast, + prompt: "@Mochi the female shiba inu is eating a cheese pizza while standing on the table".to_string(), + aspect_ratio: KinoviAspectRatio::Portrait9x16, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![MOCHI_ID.to_string()]), + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs money + async fn test_character_with_image_ref_pro() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Pro, + prompt: "@Steampunk Clown is walking up to pet a dog on the couch.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260329/1774752385699-1ff44886.jpeg".to_string(), + ]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string()]), + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, costs money + async fn test_two_characters_fast() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = GenerateVideoArgs { + session: &session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type: KinoviModelType::Seedance2Fast, + prompt: "@Steampunk Clown and @Mochi are playing fetch in a sunny park.".to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![ + STEAMPUNK_CLOWN_ID.to_string(), + MOCHI_ID.to_string(), + ]), + use_face_blur_hack: None, + output_resolution: None, + }, + }; + let result = generate_video(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + } + } + + mod output_resolution_tests { + use super::*; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + fn make_args_with_prompt<'a>( + prompt: &'a str, + session: &'a Seedance2ProSession, + model_type: KinoviModelType, + output_resolution: Option, + ) -> GenerateVideoArgs<'a> { + GenerateVideoArgs { + session, + host_override: None, + request: KinoviGenerateVideoRequest { + model_type, + prompt: prompt.to_string(), + aspect_ratio: KinoviAspectRatio::Landscape16x9, + duration_seconds: 4, + batch_count: KinoviBatchCount::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + output_resolution, + use_face_blur_hack: None, + }, + } + } + + fn make_args<'a>( + session: &'a Seedance2ProSession, + model_type: KinoviModelType, + output_resolution: Option, + ) -> GenerateVideoArgs<'a> { + make_args_with_prompt("A corgi running through a field of flowers", session, model_type, output_resolution) + } + + mod seedance_2 { + use super::*; + + #[tokio::test] + #[ignore] // manually test — requires real cookies and costs money + async fn test_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = make_args(&session, KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::FourEightyP)); + let result = generate_video(args).await?; + println!("Seedance 2.0 @ 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + // Output resolution was: "864 × 496" + // Cost: 60 credits (4 x 15) + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and costs money + async fn test_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + // 720p = None (default, outputResolution field omitted) + let prompt = "A corgi running through a field of stars"; + let args = make_args_with_prompt(prompt, &session, KinoviModelType::Seedance2Pro, None); + let result = generate_video(args).await?; + println!("Seedance 2.0 @ 720p (default) — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + // Output resolution was: "1280 × 720 + // Cost: 160 credits (4 x 40) + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and costs money + async fn test_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A shiba running through a field of stars"; + let args = make_args_with_prompt(prompt, &session, KinoviModelType::Seedance2Pro, Some(KinoviOutputResolution::TenEightyP)); + let result = generate_video(args).await?; + println!("Seedance 2.0 @ 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + // Output resolution was: "1920 × 1080" + // Cost: 360 credits (4 x 90) + Ok(()) + } + } + + mod seedance_2_fast { + use super::*; + + #[tokio::test] + #[ignore] // manually test — requires real cookies and costs money + async fn test_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A corgi running through a foggy meadow at dawn"; + let args = make_args_with_prompt(prompt, &session, KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::FourEightyP)); + let result = generate_video(args).await?; + println!("Seedance 2.0 Fast @ 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + // Output resolution was: "???" + // Cost: 40 credits (4 x 10) + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and costs money + async fn test_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A shiba running through a foggy meadow at dawn"; + let args = make_args_with_prompt(prompt, &session, KinoviModelType::Seedance2Fast, None); + let result = generate_video(args).await?; + println!("Seedance 2.0 Fast @ 720p (default) — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + // Output resolution was: "???" + // Cost: 112 credits (4 x 28) + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and costs money + async fn test_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A small klee kai dog running through a foggy meadow at dawn"; + let args = make_args_with_prompt(prompt, &session, KinoviModelType::Seedance2Fast, Some(KinoviOutputResolution::TenEightyP)); + let result = generate_video(args).await?; + println!("Seedance 2.0 Fast @ 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + // Output resolution was: "???" + // Cost: 112 credits (4 x 28) ??? - it enqueued as 720p I think + Ok(()) + } + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_video/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_video/mod.rs new file mode 100644 index 00000000..278eed12 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_video/mod.rs @@ -0,0 +1,2 @@ +pub mod generate_video; +mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/generate_video/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/generate_video/request_types.rs new file mode 100644 index 00000000..3ae8a16c --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/generate_video/request_types.rs @@ -0,0 +1,68 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequest { + #[serde(rename = "0")] + pub zero: BatchRequestInner, +} + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequestInner { + pub json: BatchRequestJson, +} + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequestJson { + #[serde(rename = "businessType")] + pub business_type: &'static str, + #[serde(rename = "apiParams")] + pub api_params: ApiParams, +} + +#[derive(Serialize, Debug)] +pub (super) struct ApiParams { + pub prompt: String, + pub resolution: String, + #[serde(rename = "contentMode")] + pub content_mode: &'static str, + pub model: &'static str, + pub duration: String, + pub mode: &'static str, + #[serde(rename = "outputResolution", skip_serializing_if = "Option::is_none")] + pub output_resolution: Option<&'static str>, + #[serde(rename = "faceBlurMode", skip_serializing_if = "Option::is_none")] + pub face_blur_mode: Option<&'static str>, + #[serde(rename = "characterIds", skip_serializing_if = "Option::is_none")] + pub character_ids: Option>, + #[serde(rename = "uploadedUrls", skip_serializing_if = "Option::is_none")] + pub uploaded_urls: Option>, + #[serde(rename = "audioUrls", skip_serializing_if = "Option::is_none")] + pub audio_urls: Option>, + #[serde(rename = "batchCount", skip_serializing_if = "Option::is_none")] + pub batch_count: Option, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseData { + pub json: TaskResponseJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub (super) struct TaskResponseJson { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, + pub violation_warning: bool, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/get_user_auth_details.rs b/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/get_user_auth_details.rs new file mode 100644 index 00000000..8756e7bb --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/get_user_auth_details.rs @@ -0,0 +1,160 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::get_user_auth_details::request_types::*; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// --- Args & response --- + +pub struct GetUserAuthDetailsArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +#[derive(Debug)] +pub struct GetUserAuthDetailsResponse { + pub email: String, + pub credits: u64, + pub available_credits: u64, +} + +// --- Implementation --- + +/// The tRPC `input` query param for `auth.user` — a static null payload. +const AUTH_USER_INPUT: &str = + r#"{"0":{"json":null,"meta":{"values":["undefined"],"v":1}}}"#; + +pub async fn get_user_auth_details( + args: GetUserAuthDetailsArgs<'_>, +) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let url = format!("{}/api/trpc/auth.user", base_url); + + info!("Fetching user auth details..."); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/pricing", base_url); + + let request = client.get(&url) + .query(&[("batch", "1"), ("input", AUTH_USER_INPUT)]) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("content-type", "application/json") + .header("x-trpc-source", "client") + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.execute(request) + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Get user auth details response status: {}", status); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody( + err, + response_body.clone(), + ))?; + + let json = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + info!("User: {}, credits: {}, available: {}", json.email, json.credits, json.available_credits); + + Ok(GetUserAuthDetailsResponse { + email: json.email, + credits: json.credits, + available_credits: json.available_credits, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + /// Regression: the Kinovi API started returning `credits` as a float + /// (e.g. `372215.18`) while `availableCredits` stays an int. Both must parse + /// and coerce to `u64` instead of failing with + /// "invalid type: floating point ..., expected u64". + #[test] + fn float_credits_are_coerced() { + let body = r#"[{"result":{"data":{"json":{ + "email":"hello@storyteller.ai", + "credits":372215.18, + "availableCredits":372215 + }}}}]"#; + let batch: Vec = serde_json::from_str(body).expect("parse user auth"); + let json = batch.into_iter().next().expect("non-empty batch").result.data.json; + assert_eq!(json.credits, 372215); + assert_eq!(json.available_credits, 372215); + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_get_user_auth_details() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = get_user_auth_details(GetUserAuthDetailsArgs { + session: &session, + host_override: None, + }).await?; + println!("Email: {}", result.email); + println!("Credits: {}", result.credits); + println!("Available credits: {}", result.available_credits); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/mod.rs new file mode 100644 index 00000000..6277520a --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/mod.rs @@ -0,0 +1,2 @@ +pub mod get_user_auth_details; +mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/request_types.rs new file mode 100644 index 00000000..c5caccd5 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/get_user_auth_details/request_types.rs @@ -0,0 +1,28 @@ +use serde_derive::Deserialize; + +use crate::utils::number_coercion::de_u64_int_or_float; + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseData { + pub json: RawUserAuthDetails, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct RawUserAuthDetails { + pub email: String, + #[serde(deserialize_with = "de_u64_int_or_float")] + pub credits: u64, + #[serde(deserialize_with = "de_u64_int_or_float")] + pub available_credits: u64, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/kinovi_host.rs b/crates/api_clients/seedance2pro_client/src/requests/kinovi_host.rs new file mode 100644 index 00000000..f1f39172 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/kinovi_host.rs @@ -0,0 +1,54 @@ +/// The host to target for API requests. +/// +/// The service was originally at `seedance2-pro.com` but migrated to `kinovi.ai`. +/// This enum allows configuring which host to use. +#[derive(Debug, Clone)] +pub enum KinoviHost { + /// https://kinovi.ai (current default) + Kinovi, + + /// https://seedance2-pro.com (legacy) + Seedance2Pro, + + /// Custom hosts for API and CDN. + /// Must include the URL scheme but no trailing slash. + /// e.g. api_host: "https://example.com", cdn_host: "http://static.example.com:1234" + CustomHost { api_host: String, cdn_host: String }, +} + +impl Default for KinoviHost { + fn default() -> Self { + Self::Kinovi + } +} + +impl KinoviHost { + /// Returns the API base URL (scheme + domain, no trailing slash). + pub fn api_base_url(&self) -> &str { + match self { + Self::Kinovi => "https://kinovi.ai", + Self::Seedance2Pro => "https://seedance2-pro.com", + Self::CustomHost { api_host, .. } => api_host.as_str(), + } + } + + /// Returns the CDN base URL for uploaded/static files (no trailing slash). + pub fn cdn_base_url(&self) -> &str { + match self { + // NB: The API endpoint moved to kinovi.ai but the CDN for uploaded materials + // still uses the legacy seedance2-pro.com domain. The generate_video API + // expects URLs on this domain. + Self::Kinovi => "https://static.seedance2-pro.com", + // Self::Kinovi => "https://static.kinovi.ai", + Self::Seedance2Pro => "https://static.seedance2-pro.com", + Self::CustomHost { cdn_host, .. } => cdn_host.as_str(), + } + } +} + +/// Resolves an optional host override to the effective host. +pub fn resolve_host(host_override: Option<&KinoviHost>) -> &KinoviHost { + // Use a static default to avoid needing to return owned data + static DEFAULT: KinoviHost = KinoviHost::Kinovi; + host_override.unwrap_or(&DEFAULT) +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/mod.rs new file mode 100644 index 00000000..006c66d6 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/mod.rs @@ -0,0 +1,11 @@ +pub mod generate_character; +pub mod generate_image; +pub mod generate_video; +pub mod workflow_run_task; +pub mod get_user_auth_details; +pub mod kinovi_host; +pub mod poll_characters; +pub mod poll_orders; +pub mod prepare_file_upload; +pub mod update_character; +pub mod upload_file; diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_characters/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_characters/mod.rs new file mode 100644 index 00000000..119ad6ad --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_characters/mod.rs @@ -0,0 +1,2 @@ +pub mod poll_characters; +pub(crate) mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_characters/poll_characters.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_characters/poll_characters.rs new file mode 100644 index 00000000..da35e2f8 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_characters/poll_characters.rs @@ -0,0 +1,373 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::requests::poll_characters::request_types::*; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// --- Public args --- + +pub struct PollCharactersArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// Cursor from a previous `PollCharactersResponse::next_cursor`. + /// When `None`, the most recent characters are returned. + pub cursor: Option, + + /// Maximum number of characters to return per page. Defaults to 50. + pub limit: Option, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +// --- Public response --- + +pub struct PollCharactersResponse { + pub characters: Vec, + + /// Present when there are more characters to fetch. + /// Pass this value as `PollCharactersArgs::cursor` in the next call. + pub next_cursor: Option, +} + +// --- Public types --- + +/// Our resolved status for a character creation job. +/// +/// This is NOT 1:1 with Kinovi's API. A character can have `taskStatus: "COMPLETED"` +/// but `assetStatus: "Failed"`, which we treat as `Failed` on our end. +#[derive(Debug, Clone, PartialEq)] +pub enum CharacterCreationStatus { + /// The character was successfully created and the asset is active. + Success, + /// The character creation failed (either the task failed or the asset failed). + Failed, + /// The character is still being created (pending or processing). + Pending, +} + +impl CharacterCreationStatus { + pub fn is_terminal(&self) -> bool { + matches!(self, Self::Success | Self::Failed) + } +} + +/// A single result image attached to a character. +#[derive(Debug, Clone)] +pub struct CharacterResultImage { + pub url: String, + pub image_type: Option, +} + +/// The status of one character. +#[derive(Debug, Clone)] +pub struct CharacterStatus { + /// Internal numeric ID. + pub id: u64, + + /// The character identifier (e.g. "char_1774752056469_2wlxoq"). + pub character_id: String, + + /// The name of the character. + pub name: String, + + /// The description of the character. + pub description: Option, + + /// The avatar URL (typically the uploaded reference image). + pub avatar_url: Option, + + /// Result images generated during character creation. + pub result_images: Vec, + + /// Our resolved status (Success, Failed, or Pending). + pub status: CharacterCreationStatus, + + /// If the task failed, the reason from the API. + pub fail_reason: Option, + + /// The asset ID, present when the character completed successfully. + pub asset_id: Option, + + /// Raw task status from the Kinovi API (for debugging). + pub raw_task_status: String, + + /// Raw asset status from the Kinovi API (for debugging). + pub raw_asset_status: Option, + + /// ISO 8601 timestamp of creation. + pub created_at: String, +} + +// --- Implementation --- + +pub async fn poll_characters(args: PollCharactersArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + + let limit = args.limit.unwrap_or(50); + + // The query param is URL-encoded JSON: {"0":{"json":{"limit":N}}} or {"0":{"json":{"limit":N,"cursor":C}}} + let input = match args.cursor { + Some(cursor) => format!( + r#"{{"0":{{"json":{{"limit":{},"cursor":{}}}}}}}"#, + limit, cursor + ), + None => format!( + r#"{{"0":{{"json":{{"limit":{}}}}}}}"#, + limit + ), + }; + + let encoded_input: String = url::form_urlencoded::byte_serialize(input.as_bytes()).collect(); + + let url = format!( + "{}/api/trpc/character.getCharacters?batch=1&input={}", + base_url, + encoded_input, + ); + + info!("Polling characters (limit={}, cursor={:?})...", limit, args.cursor); + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/app/characters", base_url); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.get(&url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Poll characters response: status={}", status); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let data = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + let characters: Vec = data.items.into_iter().map(|item| { + let result_images = item.result_images + .unwrap_or_default() + .into_iter() + .map(|img| CharacterResultImage { + url: img.url, + image_type: img.image_type, + }) + .collect(); + + // Derive our status from the raw Kinovi API fields. + // Kinovi reports "COMPLETED" even when the character actually failed: + // - assetStatus "Failed" => the asset generation failed + // - assetStatus null (no assetId) => the task completed but produced no asset + // Only taskStatus "COMPLETED" + assetStatus "Active" is a true success. + let status = match item.task_status.as_str() { + "FAILED" => CharacterCreationStatus::Failed, + "COMPLETED" => match item.asset_status.as_deref() { + Some("Active") => CharacterCreationStatus::Success, + _ => CharacterCreationStatus::Failed, // "Failed", null, or any other value + }, + _ => CharacterCreationStatus::Pending, + }; + + CharacterStatus { + id: item.id, + character_id: item.character_id, + name: item.name, + description: item.description, + avatar_url: item.avatar_url, + result_images, + status, + fail_reason: item.fail_reason, + asset_id: item.asset_id, + raw_task_status: item.task_status, + raw_asset_status: item.asset_status, + created_at: item.created_at, + } + }).collect(); + + // Parse next_cursor: it's either a JSON number or null. + let next_cursor = data.next_cursor + .and_then(|v| v.as_u64()); + + info!("Polled {} character(s), next_cursor={:?}", characters.len(), next_cursor); + + Ok(PollCharactersResponse { characters, next_cursor }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_poll_characters() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = poll_characters(PollCharactersArgs { + session: &session, + limit: None, + cursor: None, + host_override: None, + }).await?; + + println!("Characters returned: {}", result.characters.len()); + println!("Next cursor: {:?}", result.next_cursor); + for ch in &result.characters { + println!( + " {} | {} | {:?} | asset_id={:?} | avatar={:?}", + ch.character_id, ch.name, ch.status, ch.asset_id, ch.avatar_url, + ); + } + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_poll_characters_small_limit() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = poll_characters(PollCharactersArgs { + session: &session, + limit: Some(2), + cursor: None, + host_override: None, + }).await?; + + println!("Characters returned (limit=2): {}", result.characters.len()); + println!("Next cursor: {:?}", result.next_cursor); + for ch in &result.characters { + println!( + " {} | {} | {:?} | asset_id={:?}", + ch.character_id, ch.name, ch.status, ch.asset_id, + ); + } + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; exhausts all pages + async fn test_poll_all_pages() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let mut cursor: Option = None; + let mut page = 0usize; + let mut total_characters = 0usize; + + loop { + page += 1; + let result = poll_characters(PollCharactersArgs { + session: &session, + limit: Some(2), + cursor, + host_override: None, + }).await?; + + let page_count = result.characters.len(); + total_characters += page_count; + + println!("Page {}: {} characters, next_cursor: {:?}", page, page_count, result.next_cursor); + for ch in &result.characters { + println!(" {} | {} | {:?} | asset_id={:?}", ch.character_id, ch.name, ch.status, ch.asset_id); + } + + cursor = result.next_cursor; + if cursor.is_none() { + break; + } + } + + println!("Total characters across {} pages: {}", page, total_characters); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; logs all character details + async fn test_poll_all_characters_verbose() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = poll_characters(PollCharactersArgs { + session: &session, + limit: None, + cursor: None, + host_override: None, + }).await?; + + println!("=== All Characters ({} total) ===", result.characters.len()); + for ch in &result.characters { + println!("Character: {} ({})", ch.name, ch.character_id); + println!(" Description: {:?}", ch.description); + println!(" Status: {:?}", ch.status); + println!(" Avatar URL: {:?}", ch.avatar_url); + println!(" Asset ID: {:?}", ch.asset_id); + println!(" Raw Task Status: {}", ch.raw_task_status); + println!(" Raw Asset Status: {:?}", ch.raw_asset_status); + println!(" Fail Reason: {:?}", ch.fail_reason); + println!(" Created At: {}", ch.created_at); + println!(" Result Images:"); + for img in &ch.result_images { + println!(" {} (type={:?})", img.url, img.image_type); + } + println!(); + } + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_characters/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_characters/request_types.rs new file mode 100644 index 00000000..85c23f2f --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_characters/request_types.rs @@ -0,0 +1,50 @@ +use serde_derive::Deserialize; + +// ======================== Response ======================== + +// The request is a GET with query params, no request body. + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseData { + pub json: CharacterListJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct CharacterListJson { + pub items: Vec, + pub next_cursor: Option, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct CharacterItemJson { + pub id: u64, + pub character_id: String, + pub name: String, + pub description: Option, + pub avatar_url: Option, + pub result_images: Option>, + pub task_status: String, + pub fail_reason: Option, + pub asset_id: Option, + pub asset_status: Option, + pub created_at: String, +} + +#[derive(Deserialize, Debug)] +pub(super) struct ResultImageJson { + pub url: String, + #[serde(rename = "type")] + pub image_type: Option, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_orders/failure_reason.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/failure_reason.rs new file mode 100644 index 00000000..fce92498 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/failure_reason.rs @@ -0,0 +1,26 @@ +use super::failure_type::FailureType; + +/// A structured failure reason parsed from the raw Seedance2 Pro API response. +#[derive(Debug, Clone)] +pub struct FailureReason { + /// The original reason string from the API. + pub reason: String, + + /// The categorized failure type. + pub failure_type: FailureType, +} + +impl FailureReason { + /// Parse a raw failure reason string into a structured `FailureReason`. + /// + /// First checks for exact string matches against known reasons, + /// then falls back to case-insensitive substring matching. + pub fn from_reason(reason: &str) -> Self { + let failure_type = FailureType::classify_text(reason); + FailureReason { + reason: reason.to_string(), + failure_type, + } + } +} + diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_orders/failure_type.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/failure_type.rs new file mode 100644 index 00000000..8817ef7e --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/failure_type.rs @@ -0,0 +1,84 @@ + +/// Categorized failure type for a Seedance2 Pro order. +#[derive(Debug, Clone, PartialEq)] +pub enum FailureType { + /// User's uploaded image was rejected by platform content rules. + RuleBansUserImage, + /// User's uploaded image was rejected because it contains faces. + RuleBansUserImageWithFaces, + /// User's text prompt was rejected by platform content rules. + RuleBansUserTextPrompt, + /// User's content (image or text) was rejected by platform content rules (generic). + RuleBansUserContent, + /// The generated video was rejected by platform content review. + RuleBansGeneratedVideo, + /// The generated audio was rejected by platform content rules. + RuleBansGeneratedAudio, + /// The generated content (video/audio/other) was rejected by platform content rules (generic). + RuleBansGeneratedContent, + /// Video generation failed (timeout, server error, processing error, etc.) + GenerationFailed, + /// An unrecognized or absent failure reason. + OtherUnknownReason, +} + +impl FailureType { + pub fn classify_text(reason: &str) -> Self { + // --- Exact matches first --- + match reason { + "Your uploaded image violates platform rules. Please modify and try again." => + return Self::RuleBansUserImage, + "Face detected in uploaded media. Please adjust your media and try again." => + return Self::RuleBansUserImageWithFaces, + "Your input text violates platform rules. Please modify and try again." => + return Self::RuleBansUserTextPrompt, + "Content violates platform rules. Please modify and try again." => + return Self::RuleBansUserContent, + "The generated video did not pass review. Credits will not be deducted." => + return Self::RuleBansGeneratedVideo, + "The generated audio violates platform rules. Please adjust your prompt or images and try again." => + return Self::RuleBansGeneratedAudio, + "The generated content violates platform rules. Please adjust your prompt or images and try again." => + return Self::RuleBansGeneratedContent, + "Video generation failed. Please try again." => + return Self::GenerationFailed, + "Generation timed out. Please try again." => + return Self::GenerationFailed, + "Server error. Please try again later." => + return Self::GenerationFailed, + "Your content could not be processed. Please try different images or adjust your prompt." => + return Self::GenerationFailed, + _ => {} + } + + // --- Substring matches (case-insensitive) --- + let lower = reason.to_lowercase(); + + if lower.contains("face detected") || lower.contains("ensure no faces") { + return Self::RuleBansUserImageWithFaces; + } + if lower.contains("uploaded image violates") { + return Self::RuleBansUserImage; + } + if lower.contains("input text violates") { + return Self::RuleBansUserTextPrompt; + } + if lower.contains("generated video") && lower.contains("not pass review") { + return Self::RuleBansGeneratedVideo; + } + if lower.contains("generated audio") && lower.contains("violates") { + return Self::RuleBansGeneratedAudio; + } + if lower.contains("generated content") && lower.contains("violates") { + return Self::RuleBansGeneratedContent; + } + if lower.contains("content violates") || lower.contains("platform rules") { + return Self::RuleBansUserContent; + } + if lower.contains("video generation failed") || lower.contains("timed out") || lower.contains("server error") { + return Self::GenerationFailed; + } + + Self::OtherUnknownReason + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_orders/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/mod.rs new file mode 100644 index 00000000..c3458c1f --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/mod.rs @@ -0,0 +1,4 @@ +pub mod failure_reason; +pub mod failure_type; +pub mod poll_orders; +mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_orders/poll_orders.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/poll_orders.rs new file mode 100644 index 00000000..5a719880 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/poll_orders.rs @@ -0,0 +1,757 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::requests::poll_orders::failure_reason::FailureReason; +use crate::requests::poll_orders::request_types::*; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use chrono::{DateTime, Utc}; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + + +// --- Args & response --- + +pub struct PollOrdersArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// Optional cursor from a previous `PollOrdersResponse::next_cursor`. + /// When `None`, the most recent orders are returned. + pub cursor: Option, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +pub struct PollOrdersResponse { + pub orders: Vec, + + /// Present when there are more orders to fetch. + /// Pass this value as `PollOrdersArgs::cursor` in the next call. + pub next_cursor: Option, +} + +// --- Public types --- + +/// The status of one order (one generation task — video or image). +#[derive(Debug, Clone)] +pub struct OrderStatus { + pub order_id: String, + + pub task_status: TaskStatus, + + /// Top-level result URL (video file for video orders, the first image of + /// the 4-image grid for Midjourney image orders). Populated when + /// `task_status` is `Completed`. + pub result_url: Option, + + /// Detailed result entries. One entry per video frame (video orders), or + /// four entries per Midjourney task (image orders). + pub results: Vec, + + /// Structured failure reason. Populated when `task_status` is `Failed` or `fail_reason` is present. + pub fail_reason: Option, + + /// ISO 8601 creation timestamp (e.g. `"2026-02-19T01:20:50.398Z"`). + pub created_at: String, + + /// Parsed `created_at` as a `DateTime`. `None` if the raw string could not be parsed. + pub created_at_utc: Option>, + + /// Whether this order produced an image or a video. `None` for older + /// polling responses that didn't include the field — those came from the + /// video-only era and can be treated as video by callers that need to. + pub media_type: Option, + + /// The Kinovi credits charged for the order (the API's `totalCredits`). + /// `None` for older polling responses that didn't include the field. + pub total_credits: Option, +} + +/// The lifecycle status of a video generation task. +#[derive(Debug, Clone, PartialEq)] +pub enum TaskStatus { + /// The task is queued and has not started yet. + Pending, + /// The task is actively being processed. + Processing, + /// The task finished successfully. `result_url` and `results` will be populated. + Completed, + /// The task failed. `fail_reason` will contain the reason. + Failed, + /// An unrecognised status string was returned by the server. + Unknown(String), +} + +impl TaskStatus { + fn from_str(s: &str) -> Self { + match s { + "PENDING" => Self::Pending, + "PROCESSING" => Self::Processing, + "COMPLETED" => Self::Completed, + "FAILED" => Self::Failed, + other => Self::Unknown(other.to_string()), + } + } + + pub fn is_terminal(&self) -> bool { + matches!(self, Self::Completed | Self::Failed) + } +} + +/// A single generated result attached to an order — a video frame for video +/// orders, or one of Midjourney's 4 generated images for image orders. +/// (Originally named for the video-only days; the underlying shape is shared.) +#[derive(Debug, Clone)] +pub struct MediaResult { + pub url: String, + /// Frame width in pixels. `None` when the API returns `null`/omits it + /// (it does so intermittently); callers should persist NULL, not a sentinel. + pub maybe_width: Option, + /// Frame height in pixels. `None` when the API returns `null`/omits it. + pub maybe_height: Option, + // NB: We don't need these. + // /// Width / height ratio (e.g. 1.777… for 16:9). `None` when the server returns null. + // pub ratio: Option, +} + +/// Media type of an order. Midjourney orders are `Image`; the various +/// Seedance/keyframe/reference flows are `Video`. +/// +/// `Unknown` covers response payloads that omit the field (older video +/// polling) or return an unrecognised value. +#[derive(Debug, Clone, PartialEq)] +pub enum OrderMediaType { + Image, + Video, + Unknown(String), +} + +impl OrderMediaType { + fn from_str(s: &str) -> Self { + match s { + "image" => Self::Image, + "video" => Self::Video, + other => Self::Unknown(other.to_string()), + } + } + + pub fn is_image(&self) -> bool { matches!(self, Self::Image) } + pub fn is_video(&self) -> bool { matches!(self, Self::Video) } +} + +// --- Implementation --- + +pub async fn poll_orders(args: PollOrdersArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let get_orders_url = format!("{}/api/trpc/userOrder.getOrders", base_url); + + info!("Polling orders (cursor: {:?})...", args.cursor); + + let input_json = build_input_json(args.cursor); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/app/gallery", base_url); + + let request = client.get(&get_orders_url) + .query(&[("batch", "1"), ("input", input_json.as_str())]) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("content-type", "application/json") + .header("x-trpc-source", "client") + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.execute(request) + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Poll orders response status: {}", status); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let json = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + let next_cursor = json.next_cursor; + + let orders: Vec = json.orders + .into_iter() + .map(|o| { + let task_status = TaskStatus::from_str(&o.task_status); + let fail_reason = match (&o.fail_reason, &task_status) { + (Some(reason), _) => Some(FailureReason::from_reason(reason)), + (None, TaskStatus::Failed) => Some(FailureReason::from_reason("(no reason)")), + _ => None, + }; + let created_at_utc = DateTime::parse_from_rfc3339(&o.created_at) + .map(|dt| dt.with_timezone(&Utc)) + .ok(); + + let media_type = o.media_type.as_deref().map(OrderMediaType::from_str); + + OrderStatus { + order_id: o.order_id, + task_status, + result_url: o.result_url, + results: o.results.into_iter().map(|r| MediaResult { + url: r.url, + maybe_width: r.maybe_width, + maybe_height: r.maybe_height, + }).collect(), + fail_reason, + created_at: o.created_at, + created_at_utc, + media_type, + total_credits: o.total_credits, + } + }) + .collect(); + + info!("Polled {} orders, next_cursor: {:?}", orders.len(), next_cursor); + + Ok(PollOrdersResponse { orders, next_cursor }) +} + +/// Builds the tRPC `input` JSON for the getOrders endpoint. +/// When `cursor` is `Some`, it is included in the JSON payload. +fn build_input_json(cursor: Option) -> String { + match cursor { + None => r#"{"0":{"json":{"limit":30,"format":null,"toolId":null,"direction":"forward"},"meta":{"values":{"format":["undefined"],"toolId":["undefined"]},"v":1}}}"#.to_string(), + Some(c) => format!( + r#"{{"0":{{"json":{{"limit":30,"format":null,"toolId":null,"cursor":{cursor},"direction":"forward"}},"meta":{{"values":{{"format":["undefined"],"toolId":["undefined"]}},"v":1}}}}}}"#, + cursor = c + ), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + /// Diagnostic: fetch the raw getOrders JSON (no typed parsing) and print + /// the complete field set per order, so schema additions can be checked + /// against reality. Requires real cookies. + /// cargo test -p seedance2pro_client live_dump_raw_orders_json -- --ignored --nocapture + #[tokio::test] + #[ignore] + async fn live_dump_raw_orders_json() -> AnyhowResult<()> { + let session = test_session()?; + let host = resolve_host(None); + let base_url = host.api_base_url(); + let get_orders_url = format!("{}/api/trpc/userOrder.getOrders", base_url); + let input_json = build_input_json(None); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build()?; + + let response = client.get(&get_orders_url) + .query(&[("batch", "1"), ("input", input_json.as_str())]) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Referer", format!("{}/app/gallery", base_url)) + .header("content-type", "application/json") + .header("x-trpc-source", "client") + .header("Cookie", session.cookies.as_str()) + .send() + .await?; + + let body = response.text().await?; + let parsed: serde_json::Value = serde_json::from_str(&body)?; + let orders = &parsed[0]["result"]["data"]["json"]["orders"]; + + if let Some(first) = orders.get(0) { + let keys: Vec<&str> = first.as_object().map(|o| o.keys().map(|k| k.as_str()).collect()).unwrap_or_default(); + println!("FIELDS ON AN ORDER: {:?}", keys); + println!("FIRST ORDER RAW: {}", serde_json::to_string_pretty(first)?); + } else { + println!("no orders; raw body head: {}", &body[..body.len().min(500)]); + } + Ok(()) + } + + // ── Offline parsing tests against captured responses ── + // + // These verify the deserializer + mapping handle the Midjourney image + // polling shape, including the new `mediaType` field, without breaking + // the older video-only callers. + + mod offline_parsing { + use super::*; + + /// Helper: take a captured response file with a `Response:` header and + /// extract the first complete JSON array body. Tolerant of whitespace + /// between `[` and `{` (the pretty-printed captures look like + /// `[\n {`). + fn extract_json_body(raw: &str) -> &str { + // The body always sits after the `Response:` header in the capture. + // Anchor the search there so we don't accidentally grab a `[` from + // a header value above. + let after_header = match raw.find("Response") { + Some(i) => &raw[i..], + None => raw, + }; + let local_start = after_header.find('[').expect("no `[` found in response body"); + let start = (raw.len() - after_header.len()) + local_start; + + let mut depth = 0i32; + let mut in_str = false; + let mut esc = false; + let bytes = raw.as_bytes(); + for i in start..bytes.len() { + let c = bytes[i] as char; + if in_str { + if esc { esc = false; } + else if c == '\\' { esc = true; } + else if c == '"' { in_str = false; } + } else { + if c == '"' { in_str = true; } + else if c == '[' || c == '{' { depth += 1; } + else if c == ']' || c == '}' { + depth -= 1; + if depth == 0 { + return &raw[start..=i]; + } + } + } + } + panic!("never found closing bracket") + } + + /// The pretty-printed captures occasionally contain trailing commas + /// before `]` or `}` because the curator excised neighbouring orders + /// by hand. serde_json is strict about JSON, so scrub those out + /// before parsing. + fn strip_trailing_commas(body: &str) -> String { + let mut out = String::with_capacity(body.len()); + let mut in_str = false; + let mut esc = false; + let bytes = body.as_bytes(); + let mut i = 0; + while i < bytes.len() { + let c = bytes[i] as char; + if in_str { + out.push(c); + if esc { esc = false; } + else if c == '\\' { esc = true; } + else if c == '"' { in_str = false; } + i += 1; + continue; + } + if c == '"' { in_str = true; out.push(c); i += 1; continue; } + if c == ',' { + // Peek ahead past whitespace; if the next non-whitespace char is + // `]` or `}`, drop the comma. + let mut j = i + 1; + while j < bytes.len() && (bytes[j] as char).is_whitespace() { j += 1; } + if j < bytes.len() && (bytes[j] == b']' || bytes[j] == b'}') { + i += 1; + continue; + } + } + out.push(c); + i += 1; + } + out + } + + fn parse_orders(raw: &str) -> Vec { + let body = extract_json_body(raw); + let body = strip_trailing_commas(body); + let batch: Vec = serde_json::from_str(&body).expect("parse batch"); + let json = batch.into_iter().next().expect("non-empty batch").result.data.json; + json.orders.into_iter().map(|o| { + let task_status = TaskStatus::from_str(&o.task_status); + let fail_reason = match (&o.fail_reason, &task_status) { + (Some(r), _) => Some(FailureReason::from_reason(r)), + (None, TaskStatus::Failed) => Some(FailureReason::from_reason("(no reason)")), + _ => None, + }; + let created_at_utc = DateTime::parse_from_rfc3339(&o.created_at) + .map(|dt| dt.with_timezone(&Utc)).ok(); + let media_type = o.media_type.as_deref().map(OrderMediaType::from_str); + OrderStatus { + order_id: o.order_id, + task_status, + result_url: o.result_url, + results: o.results.into_iter().map(|r| MediaResult { + url: r.url, maybe_width: r.maybe_width, maybe_height: r.maybe_height, + }).collect(), + fail_reason, + created_at: o.created_at, + created_at_utc, + media_type, + total_credits: o.total_credits, + } + }).collect() + } + + /// Back-compat: when the raw payload omits `mediaType` (older video-only + /// polling), `media_type` parses as `None` and the rest of the order + /// continues to deserialise unchanged. + #[test] + fn omitted_media_type_field_yields_none() { + // Hand-built minimal video-shaped order, no `mediaType` field. + let body = r#"[{"result":{"data":{"json":{"orders":[{ + "orderId":"ord_legacy_video", + "resultUrl":null, + "taskStatus":"PROCESSING", + "results":[], + "failReason":null, + "createdAt":"2026-02-19T01:20:50.398Z" + }],"nextCursor":null}}}}]"#; + let orders = parse_orders(body); + assert_eq!(orders.len(), 1); + assert!(orders[0].media_type.is_none(), "legacy responses without mediaType should map to None"); + assert_eq!(orders[0].task_status, TaskStatus::Processing); + } + + /// Regression: the Kinovi API started returning result `width`/`height` + /// (and `totalCredits`) as floats (e.g. `568.5`). They must parse and + /// coerce to unsigned ints instead of failing with + /// "invalid type: floating point ..., expected u32". + #[test] + fn float_dimensions_and_credits_are_coerced() { + let body = r#"[{"result":{"data":{"json":{"orders":[{ + "orderId":"ord_float", + "resultUrl":"https://example.com/v.mp4", + "taskStatus":"COMPLETED", + "results":[{"url":"https://example.com/v.mp4","width":568.5,"height":1023.4}], + "failReason":null, + "createdAt":"2026-02-19T01:20:50.398Z", + "mediaType":"video", + "totalCredits":12.9 + }],"nextCursor":394062.0}}}}]"#; + let orders = parse_orders(body); + assert_eq!(orders.len(), 1); + assert_eq!(orders[0].results.len(), 1); + assert_eq!(orders[0].results[0].maybe_width, Some(569)); + assert_eq!(orders[0].results[0].maybe_height, Some(1023)); + assert_eq!(orders[0].total_credits, Some(13)); + } + + /// Regression (paging outage): the Kinovi API started returning result + /// `width`/`height` as `null`, which blew up the whole poll with + /// "invalid type: null, expected a JSON number" and stalled the queue. + /// They must parse as `None` and let the rest of the response parse. + #[test] + fn null_dimensions_parse_as_none() { + let body = r#"[{"result":{"data":{"json":{"orders":[{ + "orderId":"ord_foo", + "resultUrl":"https://static.seedance2-pro.com/videos/seedance_video.mp4", + "taskStatus":"COMPLETED", + "results":[{"url":"https://static.seedance2-pro.com/videos/seedance_video.mp4","width":null,"height":null}], + "failReason":null, + "createdAt":"2026-02-19T01:20:50.398Z", + "mediaType":"video" + }],"nextCursor":null}}}}]"#; + let orders = parse_orders(body); + assert_eq!(orders.len(), 1); + assert_eq!(orders[0].results.len(), 1); + assert_eq!(orders[0].results[0].maybe_width, None); + assert_eq!(orders[0].results[0].maybe_height, None); + assert_eq!(orders[0].task_status, TaskStatus::Completed); + } + + /// Omitted `width`/`height` keys (not just `null`) also parse as `None`. + #[test] + fn missing_dimensions_parse_as_none() { + let body = r#"[{"result":{"data":{"json":{"orders":[{ + "orderId":"ord_no_dims", + "resultUrl":"https://example.com/v.mp4", + "taskStatus":"COMPLETED", + "results":[{"url":"https://example.com/v.mp4"}], + "failReason":null, + "createdAt":"2026-02-19T01:20:50.398Z", + "mediaType":"video" + }],"nextCursor":null}}}}]"#; + let orders = parse_orders(body); + assert_eq!(orders.len(), 1); + assert_eq!(orders[0].results[0].maybe_width, None); + assert_eq!(orders[0].results[0].maybe_height, None); + } + + /// Unrecognised mediaType values shouldn't crash deserialisation; + /// they end up as `Unknown(_)`. + #[test] + fn unknown_media_type_value_is_preserved() { + let body = r#"[{"result":{"data":{"json":{"orders":[{ + "orderId":"ord_x", + "resultUrl":null, + "taskStatus":"PROCESSING", + "results":[], + "failReason":null, + "createdAt":"2026-02-19T01:20:50.398Z", + "mediaType":"hologram" + }],"nextCursor":null}}}}]"#; + let orders = parse_orders(body); + assert_eq!(orders.len(), 1); + match &orders[0].media_type { + Some(OrderMediaType::Unknown(s)) => assert_eq!(s, "hologram"), + other => panic!("expected Unknown(\"hologram\"), got {:?}", other), + } + } + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_poll_all_orders() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let result = poll_orders(PollOrdersArgs { session: &session, cursor: None, host_override: None }).await?; + println!("Orders returned: {}", result.orders.len()); + println!("Next cursor: {:?}", result.next_cursor); + let mut images = 0; + let mut videos = 0; + let mut unknown = 0; + let mut missing = 0; + for order in &result.orders { + match &order.media_type { + Some(OrderMediaType::Image) => images += 1, + Some(OrderMediaType::Video) => videos += 1, + Some(OrderMediaType::Unknown(_)) => unknown += 1, + None => missing += 1, + } + println!(" {} | {:?} | media={:?} | results={} | result_url={:?} | fail={:?}", + order.order_id, order.task_status, order.media_type, + order.results.len(), order.result_url, order.fail_reason); + } + println!( + "media_type tally: image={}, video={}, unknown={}, missing={}", + images, videos, unknown, missing, + ); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and a known cursor value + async fn test_poll_with_cursor() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + // Use the cursor value returned from a prior call (e.g. 394062 from the example responses). + let cursor: u64 = 394062; + let result = poll_orders(PollOrdersArgs { session: &session, cursor: Some(cursor), host_override: None }).await?; + println!("Orders returned (with cursor {}): {}", cursor, result.orders.len()); + println!("Next cursor: {:?}", result.next_cursor); + for order in &result.orders { + println!(" {} | {:?} | media={:?} | results={} | result_url={:?} | fail={:?}", + order.order_id, order.task_status, order.media_type, + order.results.len(), order.result_url, order.fail_reason); + } + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + /// Page back from the most recent orders until we hit a Midjourney image + /// order, then assert the new parsing path detects it. Bounded to a few + /// pages so this doesn't accidentally exhaust the whole account. + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_poll_back_to_first_image_order() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + const MAX_PAGES: usize = 10; + let mut cursor: Option = None; + let mut found_image_orders: Vec = Vec::new(); + let mut pages_scanned = 0usize; + + for _ in 0..MAX_PAGES { + let result = poll_orders(PollOrdersArgs { + session: &session, cursor, host_override: None, + }).await?; + pages_scanned += 1; + println!("Page {}: {} orders, next_cursor={:?}", pages_scanned, result.orders.len(), result.next_cursor); + + for order in &result.orders { + if order.media_type == Some(OrderMediaType::Image) { + found_image_orders.push(order.clone()); + } + } + if !found_image_orders.is_empty() { break; } + cursor = result.next_cursor; + if cursor.is_none() { break; } + } + + println!("Scanned {} pages; found {} image order(s)", pages_scanned, found_image_orders.len()); + for o in &found_image_orders { + println!(" IMG {} | {:?} | results={} | result_url={:?}", + o.order_id, o.task_status, o.results.len(), o.result_url); + } + + assert!(!found_image_orders.is_empty(), + "expected to find at least one image order within {} pages — \ + create a Midjourney generation if needed and rerun", MAX_PAGES); + + // Each Midjourney task returns exactly 4 images when completed. + if let Some(completed) = found_image_orders.iter().find(|o| o.task_status == TaskStatus::Completed) { + assert_eq!(completed.results.len(), 4, + "completed Midjourney image order should have 4 results, got {}", + completed.results.len()); + } + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; exhausts all pages + async fn test_poll_all_pages() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let mut cursor: Option = None; + let mut page = 0usize; + let mut total_orders = 0usize; + + loop { + page += 1; + let result = poll_orders(PollOrdersArgs { session: &session, cursor, host_override: None }).await?; + let page_count = result.orders.len(); + total_orders += page_count; + + println!("Page {}: {} orders, next_cursor: {:?}", page, page_count, result.next_cursor); + for order in &result.orders { + println!(" {} | {:?}", order.order_id, order.task_status); + } + + cursor = result.next_cursor; + if cursor.is_none() { + break; + } + } + + println!("Total orders across {} pages: {}", page, total_orders); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + /// Live diagnostic for the paging outage: try EACH Kinovi account's cookies + /// from the job's secrets env file and cursor across several pages, reporting + /// which account(s) parse cleanly and which blow up. Never prints cookies. + /// + /// cargo test -p seedance2pro_client live_cursor_all_accounts -- --ignored --nocapture + #[tokio::test] + #[ignore] + async fn live_cursor_all_accounts() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Info); + + const SECRETS_ENV: &str = concat!( + env!("CARGO_MANIFEST_DIR"), + "/../../../crates/service/job/seedance2_pro_job/config/seedance2-pro-job.development-secrets.env", + ); + const ACCOUNTS: &[&str] = &[ + "SEEDANCE2PRO_VOLCENGINE_COOKIES", + "SEEDANCE2PRO_BYTEPLUS_COOKIES", + "SEEDANCE2PRO_BYTEPLUS_ULTRA_COOKIES", + ]; + const MAX_PAGES: usize = 5; + + let env_contents = std::fs::read_to_string(SECRETS_ENV) + .unwrap_or_else(|e| panic!("could not read secrets env at {}: {}", SECRETS_ENV, e)); + + for account in ACCOUNTS { + let Some(cookies) = read_env_value(&env_contents, account) else { + println!("[{}] not present in secrets env — skipping", account); + continue; + }; + if cookies.is_empty() { + println!("[{}] empty — skipping", account); + continue; + } + + let session = Seedance2ProSession::from_cookies_string(cookies); + let mut cursor: Option = None; + let mut pages = 0usize; + let mut total = 0usize; + let mut ok = true; + + for _ in 0..MAX_PAGES { + match poll_orders(PollOrdersArgs { session: &session, cursor, host_override: None }).await { + Ok(result) => { + pages += 1; + total += result.orders.len(); + cursor = result.next_cursor; + if cursor.is_none() { break; } + } + Err(err) => { + ok = false; + println!("[{}] FAILED on page {}: {:?}", account, pages + 1, err); + break; + } + } + } + + println!( + "[{}] {} — {} page(s), {} order(s) parsed cleanly", + account, if ok { "OK" } else { "ERROR" }, pages, total, + ); + } + + Ok(()) + } + + /// Minimal dotenv value reader: returns the value for `KEY=...` from raw env + /// file contents, trimming surrounding quotes. Used so the diagnostic can try + /// each account without depending on process-wide env being loaded. + fn read_env_value(contents: &str, key: &str) -> Option { + for line in contents.lines() { + let line = line.trim(); + if line.starts_with('#') { continue; } + let Some((k, v)) = line.split_once('=') else { continue; }; + if k.trim() != key { continue; } + let v = v.trim().trim_matches('"').trim_matches('\'').to_string(); + return Some(v); + } + None + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/poll_orders/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/request_types.rs new file mode 100644 index 00000000..0e09b396 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/poll_orders/request_types.rs @@ -0,0 +1,61 @@ +use serde_derive::Deserialize; + +use crate::utils::number_coercion::{ + de_opt_u32_int_or_float, de_opt_u64_int_or_float, +}; + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseData { + pub json: OrdersResponseJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct OrdersResponseJson { + pub orders: Vec, + #[serde(default, deserialize_with = "de_opt_u64_int_or_float")] + pub next_cursor: Option, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct RawOrder { + pub order_id: String, + pub result_url: Option, + pub task_status: String, + pub results: Vec, + pub fail_reason: Option, + pub created_at: String, + + /// `"image"` for Midjourney image-generation orders, `"video"` for video + /// orders. `None` for older response shapes that didn't include the field. + #[serde(default)] + pub media_type: Option, + + /// The Kinovi credits charged for the order. `None` for older response + /// shapes that didn't include the field. + #[serde(default, deserialize_with = "de_opt_u32_int_or_float")] + pub total_credits: Option, +} + +#[derive(Deserialize, Debug)] +pub(super) struct RawVideoResult { + pub url: String, + /// The API intermittently returns `null` (or omits) these dimensions, so + /// they're optional rather than coerced to a sentinel. + #[serde(rename = "width", default, deserialize_with = "de_opt_u32_int_or_float")] + pub maybe_width: Option, + #[serde(rename = "height", default, deserialize_with = "de_opt_u32_int_or_float")] + pub maybe_height: Option, + // pub ratio: Option, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/mod.rs new file mode 100644 index 00000000..6de086d7 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/mod.rs @@ -0,0 +1,2 @@ +pub mod prepare_file_upload; +mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/prepare_file_upload.rs b/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/prepare_file_upload.rs new file mode 100644 index 00000000..13fd98fe --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/prepare_file_upload.rs @@ -0,0 +1,175 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::requests::prepare_file_upload::request_types::*; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use chrono::Utc; +use log::info; +use rand::Rng; +use wreq::Client; +use wreq_util::Emulation; + +/// Generates a material path based on the current time. +/// Format: `materials/YYYYMMDD/-.` +fn generate_material_path(extension: &str) -> String { + let now = Utc::now(); + let date_part = now.format("%Y%m%d").to_string(); + let timestamp_millis = now.timestamp_millis(); + let random_hex: u32 = rand::rng().random(); + let hex_part = format!("{:08x}", random_hex); + format!("materials/{}/{}-{}.{}", date_part, timestamp_millis, hex_part, extension) +} + +pub struct PrepareFileUploadArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// File extension without the dot, e.g. "png", "mp4", "mp3". + pub extension: String, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +pub struct PrepareFileUploadResponse { + /// The signed URL to upload the file to (Cloudflare R2 / S3-compatible). + pub upload_url: String, + + /// The material path that was generated for this upload. + pub material_path: String, +} + +pub async fn prepare_file_upload(args: PrepareFileUploadArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let signed_upload_url = format!("{}/api/trpc/uploads.signedUploadUrl?batch=1", base_url); + + let material_path = generate_material_path(&args.extension); + + info!("Preparing file upload with path: {}", material_path); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let request_body = BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + path: material_path.clone(), + }, + }, + }; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/", base_url); + + let response = client.post(&signed_upload_url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .json(&request_body) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Response status: {}, body: {}", status, response_body); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let upload_url = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + Ok(PrepareFileUploadResponse { + upload_url, + material_path, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_prepare_file_upload_png() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let cookies = get_test_cookies()?; + let session = Seedance2ProSession::from_cookies_string(cookies); + let args = PrepareFileUploadArgs { + session: &session, + extension: "png".to_string(), + host_override: None, + }; + let result = prepare_file_upload(args).await?; + println!("Upload URL: {}", result.upload_url); + println!("Material path: {}", result.material_path); + assert!(!result.upload_url.is_empty()); + assert!(result.upload_url.contains("cloudflarestorage.com") || result.upload_url.contains("kinovi")); + assert!(result.material_path.starts_with("materials/")); + assert!(result.material_path.ends_with(".png")); + + assert_eq!(1, 2); // NB: Intentional failure to check the response. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies + async fn test_prepare_file_upload_mp4() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let cookies = get_test_cookies()?; + let session = Seedance2ProSession::from_cookies_string(cookies); + let args = PrepareFileUploadArgs { + session: &session, + extension: "mp4".to_string(), + host_override: None, + }; + let result = prepare_file_upload(args).await?; + println!("Upload URL: {}", result.upload_url); + println!("Material path: {}", result.material_path); + assert!(!result.upload_url.is_empty()); + assert!(result.material_path.ends_with(".mp4")); + + assert_eq!(1, 2); // NB: Intentional failure to check the response. + Ok(()) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/request_types.rs new file mode 100644 index 00000000..6736d588 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/prepare_file_upload/request_types.rs @@ -0,0 +1,32 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize)] +pub(super) struct BatchRequest { + #[serde(rename = "0")] + pub zero: BatchRequestInner, +} + +#[derive(Serialize)] +pub(super) struct BatchRequestInner { + pub json: BatchRequestJson, +} + +#[derive(Serialize)] +pub(super) struct BatchRequestJson { + pub path: String, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseData { + pub json: String, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/update_character/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/update_character/mod.rs new file mode 100644 index 00000000..e7abf057 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/update_character/mod.rs @@ -0,0 +1,2 @@ +pub mod update_character; +pub(crate) mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/update_character/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/update_character/request_types.rs new file mode 100644 index 00000000..963523f3 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/update_character/request_types.rs @@ -0,0 +1,44 @@ +use serde_derive::{Deserialize, Serialize}; + +// ======================== Request ======================== + +#[derive(Serialize, Debug)] +pub(super) struct BatchRequest { + #[serde(rename = "0")] + pub zero: BatchRequestInner, +} + +#[derive(Serialize, Debug)] +pub(super) struct BatchRequestInner { + pub json: BatchRequestJson, +} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub(super) struct BatchRequestJson { + pub character_id: String, + pub name: String, + pub description: String, +} + +// ======================== Response ======================== + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub(super) struct BatchResponseData { + pub json: UpdateCharacterResponseJson, +} + +#[derive(Deserialize, Debug)] +pub(super) struct UpdateCharacterResponseJson { + pub success: bool, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/update_character/update_character.rs b/crates/api_clients/seedance2pro_client/src/requests/update_character/update_character.rs new file mode 100644 index 00000000..204f5fa9 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/update_character/update_character.rs @@ -0,0 +1,204 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::update_character::request_types::*; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// --- Public args --- + +pub struct UpdateCharacterArgs<'a> { + pub session: &'a Seedance2ProSession, + + /// The Kinovi character ID (e.g. "char_1775184656440_vsy3eu"). + pub character_id: String, + + /// The new name for the character. + pub name: String, + + /// The new description (empty string clears it). + pub description: String, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +// --- Public response --- + +#[derive(Debug)] +pub struct UpdateCharacterResponse { + pub success: bool, +} + +// --- Implementation --- + +pub async fn update_character(args: UpdateCharacterArgs<'_>) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + let url = format!("{}/api/trpc/character.updateCharacter?batch=1", base_url); + + info!("Updating character '{}' (name='{}', description='{}')", args.character_id, args.name, args.description); + + let request_body = BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + character_id: args.character_id.clone(), + name: args.name, + description: args.description, + }, + }, + }; + + let cookie = args.session.cookies.as_str(); + let referer = format!("{}/app/characters", base_url); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let response = client.post(&url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .json(&request_body) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Update character response: status={}, body={}", status, response_body); + + if !status.is_success() { + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body: response_body, + }.into()); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let data = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + Ok(UpdateCharacterResponse { + success: data.success, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + // Steampunk Clown character + const TEST_CHARACTER_ID: &str = "char_1775176566518_sik0te"; + + #[tokio::test] + #[ignore] // manually test — requires real cookies, modifies real data + async fn test_rename_character() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = update_character(UpdateCharacterArgs { + session: &session, + character_id: TEST_CHARACTER_ID.to_string(), + name: "Steampunk Clown (renamed)".to_string(), + description: "A steampunk clown character for testing".to_string(), + host_override: None, + }).await?; + + println!("Success: {}", result.success); + assert!(result.success); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, modifies real data + async fn test_rename_character_clear_description() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let result = update_character(UpdateCharacterArgs { + session: &session, + character_id: TEST_CHARACTER_ID.to_string(), + name: "Steampunk Clown".to_string(), + description: "".to_string(), + host_override: None, + }).await?; + + println!("Success: {}", result.success); + assert!(result.success); + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies, modifies real data + async fn test_rename_and_restore() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + // Rename + let result = update_character(UpdateCharacterArgs { + session: &session, + character_id: TEST_CHARACTER_ID.to_string(), + name: "Temporary Name".to_string(), + description: "Temporary description".to_string(), + host_override: None, + }).await?; + assert!(result.success); + + // Restore + let result = update_character(UpdateCharacterArgs { + session: &session, + character_id: TEST_CHARACTER_ID.to_string(), + name: "Steampunk Clown".to_string(), + description: "A steampunk clown".to_string(), + host_override: None, + }).await?; + assert!(result.success); + + assert_eq!(1, 2); // NB: Intentional failure to inspect output. + Ok(()) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/upload_file/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/upload_file/mod.rs new file mode 100644 index 00000000..e24b75ef --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/upload_file/mod.rs @@ -0,0 +1 @@ +pub mod upload_file; diff --git a/crates/api_clients/seedance2pro_client/src/requests/upload_file/upload_file.rs b/crates/api_clients/seedance2pro_client/src/requests/upload_file/upload_file.rs new file mode 100644 index 00000000..141ff29b --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/upload_file/upload_file.rs @@ -0,0 +1,172 @@ +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use url::Url; +use wreq::Client; +use wreq_util::Emulation; + +pub struct UploadFileArgs { + /// The signed upload URL returned by `prepare_file_upload`. + pub upload_url: String, + + /// The raw file bytes to upload. + pub file_bytes: Vec, + + /// Override the default host (kinovi.ai). + pub host_override: Option, +} + +pub struct UploadFileResponse { + /// The public-facing URL for the uploaded file. + /// e.g. `https://static.seedance2-pro.com/materials/20260219/1771463564512-b14bfe90.png` + pub public_url: String, +} + +/// Extracts the path from the R2 upload URL and builds the static public URL. +/// e.g. `https://comm.….r2.cloudflarestorage.com/materials/20260219/…?X-Amz-…` +/// -> `https://static.kinovi.ai/materials/20260219/…` +fn build_public_url(upload_url: &str, host: &KinoviHost) -> Result { + let parsed = Url::parse(upload_url) + .map_err(|err| Seedance2ProClientError::UrlParseError(err))?; + let path = parsed.path(); // e.g. "/materials/20260219/1771463564512-b14bfe90.png" + Ok(format!("{}{}", host.cdn_base_url(), path)) +} + +pub async fn upload_file(args: UploadFileArgs) -> Result { + let host = resolve_host(args.host_override.as_ref()); + let base_url = host.api_base_url(); + + info!("Uploading file to: {}", args.upload_url); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let referer = format!("{}/", base_url); + + let response = client.put(&args.upload_url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "cross-site") + .header("Priority", "u=4") + .body(args.file_bytes) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + + info!("Upload response status: {}", status); + + if !status.is_success() { + let body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + return Err(Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code: status, + body, + }.into()); + } + + let public_url = build_public_url(&args.upload_url, host)?; + + info!("Public URL: {}", public_url); + + Ok(UploadFileResponse { public_url }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use crate::requests::prepare_file_upload::prepare_file_upload::{ + prepare_file_upload, PrepareFileUploadArgs, + }; + use errors::AnyhowResult; + use log::LevelFilter; + use std::fs; + + #[tokio::test] + #[ignore] // manually test — requires real cookies and a test image + async fn test_upload_image_file() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + + // Step 1: Get a signed upload URL + let cookies = get_test_cookies()?; + let session = Seedance2ProSession::from_cookies_string(cookies); + let prepare_args = PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }; + let prepare_result = prepare_file_upload(prepare_args).await?; + println!("Upload URL: {}", prepare_result.upload_url); + + // Step 2: Read a test image + let file_bytes = fs::read("/Users/bt/dev/storyteller/artcraft/test_data/image/juno.jpg")?; + println!("File size: {} bytes", file_bytes.len()); + + // Step 3: Upload + let upload_args = UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes, + host_override: None, + }; + let result = upload_file(upload_args).await?; + println!("Public URL: {}", result.public_url); + + assert!(result.public_url.starts_with("https://static.kinovi.ai/materials/")); + assert_eq!(1, 2); // NB: Intentional failure to check the response. + + Ok(()) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies and a test image + async fn test_upload_video_file_that_is_too_long() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + + // Step 1: Get a signed upload URL + let cookies = get_test_cookies()?; + let session = Seedance2ProSession::from_cookies_string(cookies); + let prepare_args = PrepareFileUploadArgs { + session: &session, + extension: "mp4".to_string(), + host_override: None, + }; + let prepare_result = prepare_file_upload(prepare_args).await?; + println!("Upload URL: {}", prepare_result.upload_url); + + // Step 2: Read a test image + let file_bytes = fs::read("/Users/bt/Videos/Artcraft/Artcraft Best/ArtCraft Seedance Knight.mp4")?; + println!("File size: {} bytes", file_bytes.len()); + + // Step 3: Upload + let upload_args = UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes, + host_override: None, + }; + let result = upload_file(upload_args).await?; + println!("Public URL: {}", result.public_url); + + assert!(result.public_url.starts_with("https://static.kinovi.ai/materials/")); + assert_eq!(1, 2); // NB: Intentional failure to check the response. + + Ok(()) + } +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/mod.rs b/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/mod.rs new file mode 100644 index 00000000..01eb807c --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/mod.rs @@ -0,0 +1,2 @@ +pub mod workflow_run_task; +mod request_types; diff --git a/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/request_types.rs b/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/request_types.rs new file mode 100644 index 00000000..81c57770 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/request_types.rs @@ -0,0 +1,85 @@ +use serde_derive::{Deserialize, Serialize}; + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequest { + #[serde(rename = "0")] + pub zero: BatchRequestInner, +} + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequestInner { + pub json: BatchRequestJson, +} + +#[derive(Serialize, Debug)] +pub (super) struct BatchRequestJson { + #[serde(rename = "businessType")] + pub business_type: &'static str, + #[serde(rename = "apiParams")] + pub api_params: ApiParams, +} + +#[derive(Serialize, Debug)] +pub (super) struct ApiParams { + pub prompt: String, + /// Aspect ratio as pixel dimensions (e.g. "1280x720"). Most Kinovi + /// models carry the aspect ratio here. None for models that use the + /// `aspectRatio` field instead (Seedance 2.0 Mini). + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution: Option, + /// Aspect ratio as a ratio string (e.g. "16:9"). Used by Seedance 2.0 + /// Mini instead of `resolution`. None for models that use `resolution`. + #[serde(rename = "aspectRatio", skip_serializing_if = "Option::is_none")] + pub aspect_ratio: Option<&'static str>, + #[serde(rename = "contentMode")] + pub content_mode: &'static str, + pub model: &'static str, + pub duration: String, + /// Generation mode ("keyframe" / "reference"). Omitted for models that use + /// `happyhorseMode` instead (Happy Horse). + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option<&'static str>, + /// Happy Horse generation mode ("t2v" / "i2v"). Used instead of `mode` by + /// Happy Horse; None for every other model. + #[serde(rename = "happyhorseMode", skip_serializing_if = "Option::is_none")] + pub happyhorse_mode: Option<&'static str>, + #[serde(rename = "outputResolution", skip_serializing_if = "Option::is_none")] + pub output_resolution: Option<&'static str>, + #[serde(rename = "faceBlurMode", skip_serializing_if = "Option::is_none")] + pub face_blur_mode: Option<&'static str>, + #[serde(rename = "characterIds", skip_serializing_if = "Option::is_none")] + pub character_ids: Option>, + #[serde(rename = "uploadedUrls", skip_serializing_if = "Option::is_none")] + pub uploaded_urls: Option>, + #[serde(rename = "audioUrls", skip_serializing_if = "Option::is_none")] + pub audio_urls: Option>, + #[serde(rename = "batchCount", skip_serializing_if = "Option::is_none")] + pub batch_count: Option, + #[serde(rename = "bitrate_mode", skip_serializing_if = "Option::is_none")] + pub bitrate_mode: Option<&'static str>, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseItem { + pub result: BatchResponseResult, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseResult { + pub data: BatchResponseData, +} + +#[derive(Deserialize, Debug)] +pub (super) struct BatchResponseData { + pub json: TaskResponseJson, +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub (super) struct TaskResponseJson { + pub task_id: String, + pub order_id: String, + pub task_ids: Option>, + pub order_ids: Option>, + pub violation_warning: bool, +} diff --git a/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/workflow_run_task.rs b/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/workflow_run_task.rs new file mode 100644 index 00000000..aa767168 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/requests/workflow_run_task/workflow_run_task.rs @@ -0,0 +1,1739 @@ +use crate::creds::seedance2pro_session::Seedance2ProSession; +use crate::error::seedance2pro_bad_request_api_error::Seedance2ProBadRequestApiError; +use crate::error::seedance2pro_client_error::Seedance2ProClientError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::requests::workflow_run_task::request_types::*; +use crate::requests::kinovi_host::{KinoviHost, resolve_host}; +use crate::utils::categorize_seedance2pro_error::categorize_seedance2pro_error; +use crate::utils::common_headers::FIREFOX_USER_AGENT; +use log::info; +use wreq::Client; +use wreq_util::Emulation; + +// --- Request args --- + +/// Wrapper that bundles a [`WorkflowRunTaskRequest`] with session and host info. +pub struct WorkflowRunTaskArgs<'a> { + pub request: WorkflowRunTaskRequest, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +/// Video generation parameters (no session/host info). +#[derive(Clone)] +pub struct WorkflowRunTaskRequest { + /// Seedance 2.0 Pro vs Fast + pub model_type: KinoviModelTypeRaw, + + pub prompt: String, + + /// The aspect ratio + /// (Kinovi terms this "resolution" in the API, confusingly.) + pub aspect_ratio: KinoviAspectRatioRaw, + + /// The resolution + /// Output resolution quality (480p, 720p, 1080p). None defaults to 720p. + /// (Kinovi terms this "outputResolution" in the API, which is confusingly named) + pub output_resolution: Option, + + /// Duration in seconds (4–15). + pub duration_seconds: u8, + + pub batch_count: KinoviBatchCountRaw, + + /// Optional start frame image URL (keyframe mode). + pub start_frame_url: Option, + + /// Optional end frame image URL (keyframe mode). + pub end_frame_url: Option, + + /// Optional reference image URLs (reference mode). + /// When present, takes priority over start/end frames. + pub reference_image_urls: Option>, + + /// Optional reference video URLs (reference mode). + /// Can be combined with reference_image_urls. + /// Videos are referenced in prompts as @video1, @video2, etc. + /// When present, takes priority over start/end frames. + pub reference_video_urls: Option>, + + /// Optional reference audio URLs (reference mode). + /// Audio is referenced in prompts as @audio1, @audio2, etc. + /// Sent in a separate `audioUrls` field (not in `uploadedUrls`). + pub reference_audio_urls: Option>, + + /// Optional Kinovi character IDs to reference in the prompt. + /// Characters are referenced in prompts as @CharacterName. + pub character_ids: Option>, + + /// Controls the `faceBlurMode` field: true sends "on", false sends "off", None omits it. + pub use_face_blur_hack: Option, + + /// Output video bitrate. None defaults to "standard" (the field is omitted); + /// `High` sends `bitrate_mode: "high"`. Does not affect cost. + pub bitrate: Option, +} + +impl std::fmt::Debug for WorkflowRunTaskRequest { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("WorkflowRunTaskRequest") + .field("model_type", &self.model_type) + .field("prompt", &self.prompt) + .field("aspect_ratio", &self.aspect_ratio) + .field("duration_seconds", &self.duration_seconds) + .field("batch_count", &self.batch_count) + .field("start_frame_url", &self.start_frame_url) + .field("end_frame_url", &self.end_frame_url) + .field("reference_image_urls", &self.reference_image_urls) + .field("reference_video_urls", &self.reference_video_urls) + .field("reference_audio_urls", &self.reference_audio_urls) + .field("character_ids", &self.character_ids) + .field("output_resolution", &self.output_resolution) + .field("use_face_blur_hack", &self.use_face_blur_hack) + .field("bitrate", &self.bitrate) + .finish() + } +} + +impl std::fmt::Debug for WorkflowRunTaskArgs<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("WorkflowRunTaskArgs") + .field("request", &self.request) + .field("host_override", &self.host_override) + .finish() + } +} + +// --- Public enums --- + +/// Video resolution / aspect ratio. +#[derive(Debug, Clone, Copy)] +pub enum KinoviAspectRatioRaw { + /// 16:9 landscape (1280x720) + Landscape16x9, + /// 21:9 ultra-wide (1280x540) + UltraWide21x9, + /// 9:16 portrait (720x1280) + Portrait9x16, + /// 1:1 square (720x720) + Square1x1, + /// 4:3 standard (960x720) + Landscape4x3, + /// 3:4 portrait (720x960) + Portrait3x4, +} + +impl KinoviAspectRatioRaw { + /// The aspect ratio as a ratio string (e.g. "16:9"), used by models that + /// send an `aspectRatio` field (Seedance 2.0 Mini) instead of `resolution`. + fn as_aspect_ratio_str(&self) -> &'static str { + match self { + Self::Landscape16x9 => "16:9", + Self::UltraWide21x9 => "21:9", + Self::Portrait9x16 => "9:16", + Self::Square1x1 => "1:1", + Self::Landscape4x3 => "4:3", + Self::Portrait3x4 => "3:4", + } + } +} + +/// Output resolution quality. When omitted, defaults to 720p. +#[derive(Debug, Clone, Copy)] +pub enum KinoviOutputResolutionRaw { + /// 480p + FourEightyP, + /// 720p (default — omitting the field gives this) + SevenTwentyP, + /// 1080p + TenEightyP, + /// 4K. Only supported by Seedance 2.0 (Pro). Seedance 2.0 Fast does NOT + /// offer 4K — requesting it for Fast is not valid upstream. + FourK, +} + +impl KinoviOutputResolutionRaw { + /// Returns the API string to send, or None for 720p (the default, which is + /// expressed by omitting the field entirely). + pub fn as_api_str(&self) -> Option<&'static str> { + match self { + Self::FourEightyP => Some("480p"), + Self::SevenTwentyP => None, // Default — omit from request + Self::TenEightyP => Some("1080p"), + Self::FourK => Some("4k"), + } + } +} + +/// Number of videos to generate in a single request. +#[derive(Debug, Clone, Copy)] +pub enum KinoviBatchCountRaw { + One, + Two, + Three, + Four, + Five, + Six, + Seven, + Eight, +} + +impl KinoviBatchCountRaw { + fn as_u8(&self) -> u8 { + match self { + Self::One => 1, + Self::Two => 2, + Self::Three => 3, + Self::Four => 4, + Self::Five => 5, + Self::Six => 6, + Self::Seven => 7, + Self::Eight => 8, + } + } +} + +/// The model variant to use. +#[derive(Debug, Clone, Copy)] +pub enum KinoviModelTypeRaw { + /// Seedance 2.0 Pro (higher quality, slower). + Seedance2Pro, + /// Seedance 2.0 Fast (lower quality, faster). + Seedance2Fast, + /// Seedance 2.0 Mini (cheapest; 480p/720p only). + Seedance2Mini, + /// Happy Horse 1.0. + HappyHorse1p0, +} + +impl KinoviModelTypeRaw { + fn as_api_str(&self) -> &'static str { + match self { + Self::Seedance2Pro => "seedance-20", + Self::Seedance2Fast => "seedance2-fast", + Self::Seedance2Mini => "seedance2.0-mini", + Self::HappyHorse1p0 => "happyhorse1.0", + } + } + + /// The tRPC `businessType` for this model. Seedance 2.0 Mini uses its + /// own business type; every other model uses the shared one. + fn business_type(&self) -> &'static str { + match self { + Self::Seedance2Mini => "seedance20-mini-video-generation", + Self::HappyHorse1p0 => "happyhorse-video-generation", + Self::Seedance2Pro | Self::Seedance2Fast => "wan22-video-generation", + } + } + + /// Whether the aspect ratio is sent in an `aspectRatio` field (true) + /// rather than the `resolution` field. Mini and Happy Horse use `aspectRatio`. + fn uses_aspect_ratio_field(&self) -> bool { + matches!(self, Self::Seedance2Mini | Self::HappyHorse1p0) + } + + /// Whether this model uses Happy Horse's `happyhorseMode` (t2v/i2v) + /// instead of the standard `mode` (keyframe/reference). + fn uses_happyhorse_mode(&self) -> bool { + matches!(self, Self::HappyHorse1p0) + } +} + +/// Output video bitrate. When omitted, defaults to "standard". +#[derive(Debug, Clone, Copy)] +pub enum KinoviBitrateRaw { + /// High bitrate (`bitrate_mode: "high"`). + High, +} + +impl KinoviBitrateRaw { + /// Returns the API string to send, or None for "standard" (the default, + /// which is expressed by omitting the field entirely). + pub fn as_api_str(&self) -> Option<&'static str> { + match self { + Self::High => Some("high"), + } + } +} + +// --- Response --- + +pub struct WorkflowRunTaskResponse { + pub task_id: String, + + pub order_id: String, + + /// Present when batch_count > 1. + pub task_ids: Option>, + + /// Present when batch_count > 1. + pub order_ids: Option>, +} + +// --- Implementation --- + +pub async fn workflow_run_task(args: WorkflowRunTaskArgs<'_>) -> Result { + let req = args.request; + + info!("Requesting video from Seedance2Pro (v2): {:?}", req); + + let request_body = build_batch_request(req); + + info!("Seedance2pro request (v2): {:?}", request_body); + + send_run_task_request(args.session, args.host_override, &request_body).await +} + +/// Run a `workflow.runTask` call whose `apiParams` shape differs from the +/// standard video request — e.g. the Suno audio models, which carry their own +/// parameter sets. The caller provides the tRPC `businessType` and a +/// serializable `apiParams` payload; the HTTP plumbing and response handling +/// are shared with [`workflow_run_task`]. +pub async fn workflow_run_task_custom( + args: WorkflowRunTaskCustomArgs<'_, T>, +) -> Result { + info!( + "Requesting {} from Seedance2Pro (custom): {:?}", + args.business_type, args.api_params, + ); + + let request_body = serde_json::json!({ + "0": { + "json": { + "businessType": args.business_type, + "apiParams": args.api_params, + } + } + }); + + send_run_task_request(args.session, args.host_override, &request_body).await +} + +/// Bundle for [`workflow_run_task_custom`]. +pub struct WorkflowRunTaskCustomArgs<'a, T: serde::Serialize + std::fmt::Debug> { + /// The tRPC `businessType` discriminator (e.g. "suno-music-generation"). + pub business_type: &'static str, + pub api_params: T, + pub session: &'a Seedance2ProSession, + pub host_override: Option, +} + +async fn send_run_task_request( + session: &Seedance2ProSession, + host_override: Option, + request_body: &B, +) -> Result { + let host = resolve_host(host_override.as_ref()); + let base_url = host.api_base_url(); + let run_task_url = format!("{}/api/trpc/workflow.runTask?batch=1", base_url); + + let cookie = session.cookies.as_str(); + + let client = Client::builder() + .emulation(Emulation::Firefox143) + .build() + .map_err(|err| Seedance2ProClientError::WreqClientError(err))?; + + let referer = format!("{}/", base_url); + + let response = client.post(&run_task_url) + .header("User-Agent", FIREFOX_USER_AGENT) + .header("Accept", "*/*") + .header("Accept-Language", "en-US,en;q=0.9") + .header("Accept-Encoding", "gzip, deflate, br, zstd") + .header("Referer", &referer) + .header("Content-Type", "application/json") + .header("x-trpc-source", "client") + .header("Origin", base_url) + .header("Connection", "keep-alive") + .header("Cookie", cookie) + .header("Sec-Fetch-Dest", "empty") + .header("Sec-Fetch-Mode", "cors") + .header("Sec-Fetch-Site", "same-origin") + .header("Priority", "u=4") + .header("TE", "trailers") + .json(request_body) + .send() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + let status = response.status(); + let response_body = response.text() + .await + .map_err(|err| Seedance2ProGenericApiError::WreqError(err))?; + + info!("Response status: {}, body: {}", status, response_body); + + if !status.is_success() { + return Err(categorize_seedance2pro_error(status, response_body)); + } + + let batch_response: Vec = serde_json::from_str(&response_body) + .map_err(|err| Seedance2ProGenericApiError::SerdeResponseParseErrorWithBody(err, response_body.clone()))?; + + let task_data = batch_response + .into_iter() + .next() + .ok_or_else(|| Seedance2ProGenericApiError::UnexpectedResponseShape { + explanation: "Empty batch response array".to_string(), + raw_body: response_body.clone(), + })? + .result + .data + .json; + + if task_data.violation_warning { + return Err(Seedance2ProBadRequestApiError::VideoGenerationViolation { raw_body: response_body }.into()); + } + + Ok(WorkflowRunTaskResponse { + task_id: task_data.task_id, + order_id: task_data.order_id, + task_ids: task_data.task_ids, + order_ids: task_data.order_ids, + }) +} + +/// Build the tRPC request body for a workflow run-task call. +/// +/// Most models carry the aspect ratio as pixel dimensions in `resolution`. +/// Seedance 2.0 Mini instead sends a ratio string in an `aspectRatio` field +/// and a different `businessType`. +fn build_batch_request(req: WorkflowRunTaskRequest) -> BatchRequest { + let has_reference_images = req.reference_image_urls.as_ref().is_some_and(|urls| !urls.is_empty()); + let has_reference_videos = req.reference_video_urls.as_ref().is_some_and(|urls| !urls.is_empty()); + let has_reference_audio = req.reference_audio_urls.as_ref().is_some_and(|urls| !urls.is_empty()); + let has_characters = req.character_ids.as_ref().is_some_and(|ids| !ids.is_empty()); + + let is_reference_mode = has_reference_images || has_reference_videos || has_reference_audio || has_characters; + + let video_input_mode = if is_reference_mode { "reference" } else { "keyframe" }; + + let uploaded_urls: Option> = if is_reference_mode { + let mut urls = Vec::new(); + if let Some(video_urls) = req.reference_video_urls { + urls.extend(video_urls); + } + if let Some(image_urls) = req.reference_image_urls { + urls.extend(image_urls); + } + if urls.is_empty() { None } else { Some(urls) } + } else { + let mut urls = Vec::new(); + if let Some(url) = req.start_frame_url { + urls.push(url); + } + if let Some(url) = req.end_frame_url { + urls.push(url); + } + if urls.is_empty() { None } else { Some(urls) } + }; + + let audio_urls: Option> = if has_reference_audio { + req.reference_audio_urls + } else { + None + }; + + let face_blur_mode = match req.use_face_blur_hack { + Some(true) => Some("on"), + Some(false) => Some("off"), + None => None, + }; + + let batch_count_value = req.batch_count.as_u8(); + let batch_count = if batch_count_value > 1 { Some(batch_count_value) } else { None }; + + let duration = format!("{}s", req.duration_seconds); + + // The aspect ratio is sent as a ratio string (e.g. "16:9"). Seedance Pro/Fast + // carry it in the `resolution` field; Mini and Happy Horse use `aspectRatio`. + let aspect_ratio_value = req.aspect_ratio.as_aspect_ratio_str(); + let (resolution, aspect_ratio) = if req.model_type.uses_aspect_ratio_field() { + (None, Some(aspect_ratio_value)) + } else { + (Some(aspect_ratio_value.to_string()), None) + }; + + // Happy Horse uses `happyhorseMode` (t2v/i2v) instead of the standard `mode` + // (keyframe/reference). i2v applies whenever an input image/video is attached. + let (mode, happyhorse_mode) = if req.model_type.uses_happyhorse_mode() { + let hh = if uploaded_urls.is_some() { "i2v" } else { "t2v" }; + (None, Some(hh)) + } else { + (Some(video_input_mode), None) + }; + + info!( + "Generating video (v2): mode={}, model={}, duration={}, batch={}", + video_input_mode, req.model_type.as_api_str(), duration, batch_count_value + ); + + BatchRequest { + zero: BatchRequestInner { + json: BatchRequestJson { + business_type: req.model_type.business_type(), + api_params: ApiParams { + prompt: req.prompt, + resolution, + aspect_ratio, + content_mode: "normal", + model: req.model_type.as_api_str(), + duration, + mode, + happyhorse_mode, + output_resolution: req.output_resolution.and_then(|r| r.as_api_str()), + face_blur_mode, + character_ids: req.character_ids, + uploaded_urls, + audio_urls, + batch_count, + bitrate_mode: req.bitrate.and_then(|bitrate| bitrate.as_api_str()), + }, + }, + }, + } +} + +#[cfg(test)] +mod tests { + use std::fs; + use super::*; + use crate::creds::seedance2pro_session::Seedance2ProSession; + use crate::test_utils::get_test_cookies::get_test_cookies; + use crate::test_utils::setup_test_logging::setup_test_logging; + use errors::AnyhowResult; + use log::LevelFilter; + use crate::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use crate::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + + // ── Bitrate serialization ── + // + // The optional `bitrate_mode` field is sent only when `High` is requested; + // the standard (default) bitrate omits the field entirely. + + mod bitrate_tests { + use super::*; + + #[test] + fn high_bitrate_serializes_to_high() { + assert_eq!(KinoviBitrateRaw::High.as_api_str(), Some("high")); + + let api_params = base_api_params(Some("high")); + let json = serde_json::to_string(&api_params).unwrap(); + assert!(json.contains(r#""bitrate_mode":"high""#), "expected bitrate_mode in {json}"); + } + + #[test] + fn standard_bitrate_omits_field() { + let api_params = base_api_params(None); + let json = serde_json::to_string(&api_params).unwrap(); + assert!(!json.contains("bitrate_mode"), "expected no bitrate_mode in {json}"); + } + + fn base_api_params(bitrate_mode: Option<&'static str>) -> ApiParams { + ApiParams { + prompt: "a corgi".to_string(), + resolution: Some("16:9".to_string()), + aspect_ratio: None, + content_mode: "normal", + model: "seedance-20", + duration: "5s".to_string(), + mode: Some("keyframe"), + happyhorse_mode: None, + output_resolution: None, + face_blur_mode: None, + character_ids: None, + uploaded_urls: None, + audio_urls: None, + batch_count: None, + bitrate_mode, + } + } + } + + // ── Output-resolution serialization ── + // + // `outputResolution` is sent only when non-default; 720p (the default) omits + // the field. 4K serializes to the literal "4k". + + mod output_resolution_serialization_tests { + use super::*; + + #[test] + fn four_k_maps_to_4k() { + assert_eq!(KinoviOutputResolutionRaw::FourK.as_api_str(), Some("4k")); + } + + #[test] + fn four_k_serializes_on_the_wire() { + let api_params = base_api_params(KinoviOutputResolutionRaw::FourK.as_api_str()); + let json = serde_json::to_string(&api_params).unwrap(); + assert!(json.contains(r#""outputResolution":"4k""#), "expected outputResolution in {json}"); + } + + #[test] + fn default_720p_omits_output_resolution() { + assert_eq!(KinoviOutputResolutionRaw::SevenTwentyP.as_api_str(), None); + let api_params = base_api_params(KinoviOutputResolutionRaw::SevenTwentyP.as_api_str()); + let json = serde_json::to_string(&api_params).unwrap(); + assert!(!json.contains("outputResolution"), "expected no outputResolution in {json}"); + } + + fn base_api_params(output_resolution: Option<&'static str>) -> ApiParams { + ApiParams { + prompt: "a corgi".to_string(), + resolution: Some("16:9".to_string()), + aspect_ratio: None, + content_mode: "normal", + model: "seedance-20", + duration: "5s".to_string(), + mode: Some("reference"), + happyhorse_mode: None, + output_resolution, + face_blur_mode: None, + character_ids: None, + uploaded_urls: None, + audio_urls: None, + batch_count: None, + bitrate_mode: None, + } + } + } + + // ── Seedance 2.0 Mini request shape ── + // + // Mini differs from the other models on the wire: a + // `seedance20-mini-video-generation` businessType, a `seedance2.0-mini` + // model, and an `aspectRatio` ratio string (e.g. "16:9") in place of the + // pixel-dimension `resolution` field. + + mod mini_request_shape_tests { + use super::*; + + fn mini_request( + aspect_ratio: KinoviAspectRatioRaw, + output_resolution: Option, + batch_count: KinoviBatchCountRaw, + ) -> WorkflowRunTaskRequest { + WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Mini, + prompt: "a corgi".to_string(), + aspect_ratio, + output_resolution, + duration_seconds: 5, + batch_count, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + } + + #[test] + fn mini_uses_aspect_ratio_field_and_business_type() { + let body = build_batch_request(mini_request( + KinoviAspectRatioRaw::Landscape4x3, + Some(KinoviOutputResolutionRaw::FourEightyP), + KinoviBatchCountRaw::One, + )); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""businessType":"seedance20-mini-video-generation""#), "{json}"); + assert!(json.contains(r#""model":"seedance2.0-mini""#), "{json}"); + assert!(json.contains(r#""aspectRatio":"4:3""#), "{json}"); + assert!(json.contains(r#""outputResolution":"480p""#), "{json}"); + // Mini does NOT send the pixel-dimension `resolution` field. + assert!(!json.contains(r#""resolution":"#), "{json}"); + } + + #[test] + fn mini_720p_omits_output_resolution() { + let body = build_batch_request(mini_request( + KinoviAspectRatioRaw::Landscape16x9, + None, + KinoviBatchCountRaw::One, + )); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""aspectRatio":"16:9""#), "{json}"); + assert!(!json.contains("outputResolution"), "{json}"); + } + + #[test] + fn mini_batch_count_eight_serializes() { + let body = build_batch_request(mini_request( + KinoviAspectRatioRaw::Landscape16x9, + None, + KinoviBatchCountRaw::Eight, + )); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""batchCount":8"#), "{json}"); + } + + #[test] + fn non_mini_still_uses_resolution_field() { + let mut req = mini_request(KinoviAspectRatioRaw::Landscape16x9, None, KinoviBatchCountRaw::One); + req.model_type = KinoviModelTypeRaw::Seedance2Pro; + let body = build_batch_request(req); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""businessType":"wan22-video-generation""#), "{json}"); + assert!(json.contains(r#""resolution":"16:9""#), "{json}"); + assert!(!json.contains("aspectRatio"), "{json}"); + } + + #[test] + fn model_strings_and_business_types() { + assert_eq!(KinoviModelTypeRaw::Seedance2Mini.as_api_str(), "seedance2.0-mini"); + assert_eq!(KinoviModelTypeRaw::Seedance2Mini.business_type(), "seedance20-mini-video-generation"); + assert_eq!(KinoviModelTypeRaw::Seedance2Pro.business_type(), "wan22-video-generation"); + assert_eq!(KinoviModelTypeRaw::Seedance2Fast.business_type(), "wan22-video-generation"); + assert_eq!(KinoviModelTypeRaw::HappyHorse1p0.business_type(), "happyhorse-video-generation"); + } + + #[test] + fn aspect_ratio_strings() { + assert_eq!(KinoviAspectRatioRaw::Landscape16x9.as_aspect_ratio_str(), "16:9"); + assert_eq!(KinoviAspectRatioRaw::UltraWide21x9.as_aspect_ratio_str(), "21:9"); + assert_eq!(KinoviAspectRatioRaw::Portrait9x16.as_aspect_ratio_str(), "9:16"); + assert_eq!(KinoviAspectRatioRaw::Square1x1.as_aspect_ratio_str(), "1:1"); + assert_eq!(KinoviAspectRatioRaw::Landscape4x3.as_aspect_ratio_str(), "4:3"); + assert_eq!(KinoviAspectRatioRaw::Portrait3x4.as_aspect_ratio_str(), "3:4"); + } + } + + // ── 2026-06-24 request-shape change ── + // + // The aspect ratio is now a ratio string ("16:9"). Seedance Pro/Fast keep it + // in `resolution`; Happy Horse moved to its own `businessType`, an + // `aspectRatio` field, and a `happyhorseMode` (t2v/i2v) in place of `mode`. + + mod wire_shape_change_tests { + use super::*; + + fn request( + model_type: KinoviModelTypeRaw, + aspect_ratio: KinoviAspectRatioRaw, + start_frame_url: Option, + ) -> WorkflowRunTaskRequest { + WorkflowRunTaskRequest { + model_type, + prompt: "a corgi".to_string(), + aspect_ratio, + output_resolution: None, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + } + + #[test] + fn seedance_pro_resolution_is_a_ratio_string() { + let body = build_batch_request(request( + KinoviModelTypeRaw::Seedance2Pro, KinoviAspectRatioRaw::Landscape16x9, None)); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""businessType":"wan22-video-generation""#), "{json}"); + assert!(json.contains(r#""resolution":"16:9""#), "{json}"); + assert!(json.contains(r#""mode":"keyframe""#), "{json}"); + assert!(!json.contains("aspectRatio"), "{json}"); + assert!(!json.contains("1280x720"), "{json}"); + assert!(!json.contains("happyhorseMode"), "{json}"); + } + + #[test] + fn seedance_fast_resolution_is_a_ratio_string() { + let body = build_batch_request(request( + KinoviModelTypeRaw::Seedance2Fast, KinoviAspectRatioRaw::Portrait3x4, None)); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""model":"seedance2-fast""#), "{json}"); + assert!(json.contains(r#""resolution":"3:4""#), "{json}"); + } + + #[test] + fn happy_horse_text_to_video_shape() { + let body = build_batch_request(request( + KinoviModelTypeRaw::HappyHorse1p0, KinoviAspectRatioRaw::Portrait9x16, None)); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""businessType":"happyhorse-video-generation""#), "{json}"); + assert!(json.contains(r#""model":"happyhorse1.0""#), "{json}"); + assert!(json.contains(r#""happyhorseMode":"t2v""#), "{json}"); + assert!(json.contains(r#""aspectRatio":"9:16""#), "{json}"); + // Happy Horse omits the standard `mode` and the `resolution` field. + assert!(!json.contains(r#""mode":"#), "{json}"); + assert!(!json.contains(r#""resolution":"#), "{json}"); + } + + #[test] + fn happy_horse_image_to_video_uses_i2v() { + let body = build_batch_request(request( + KinoviModelTypeRaw::HappyHorse1p0, KinoviAspectRatioRaw::Landscape16x9, + Some("https://example.com/start.png".to_string()))); + let json = serde_json::to_string(&body).unwrap(); + assert!(json.contains(r#""happyhorseMode":"i2v""#), "{json}"); + assert!(json.contains(r#""uploadedUrls":["https://example.com/start.png"]"#), "{json}"); + assert!(!json.contains(r#""mode":"#), "{json}"); + } + + #[test] + fn business_types() { + assert_eq!(KinoviModelTypeRaw::Seedance2Pro.business_type(), "wan22-video-generation"); + assert_eq!(KinoviModelTypeRaw::Seedance2Fast.business_type(), "wan22-video-generation"); + assert_eq!(KinoviModelTypeRaw::Seedance2Mini.business_type(), "seedance20-mini-video-generation"); + assert_eq!(KinoviModelTypeRaw::HappyHorse1p0.business_type(), "happyhorse-video-generation"); + } + } + + mod real_requests { + use super::*; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + #[tokio::test] + #[ignore] + async fn test_generate_text_to_video() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "A corgi eating a cake in a fancy kitchen.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Square1x1, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_generate_keyframe_video() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "A dog shakes the glasses off its head. The camera pans out as the shiba shakes. The shiba barks.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: Some("https://static.seedance2-pro.com/materials/20260219/1771496300184-fb32e08c.jpg".to_string()), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_generate_reference_image_video() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "The dog in @2 is in the office at @1 without the man. The office is dark and moonlight streams in through the windows. Particles of dust gleam in the moon beams. Suddenly, the dog jumps walks in front of the desk and barks.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape4x3, + duration_seconds: 10, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260219/1771463564512-b14bfe90.png".to_string(), + "https://static.seedance2-pro.com/materials/20260219/1771496300184-fb32e08c.jpg".to_string(), + ]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_generate_reference_video_only() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "Change the Video @video1 to night time.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_generate_reference_video_and_image() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "Put the robot in @video1 next to the house in @image1".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773595053724-07a1d500.png".to_string(), + ]), + reference_video_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260315/1773594284659-3a46d231.mp4".to_string(), + ]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_video_ref_file_that_is_too_long() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + + let cookies = get_test_cookies()?; + let session = Seedance2ProSession::from_cookies_string(cookies); + let prepare_args = PrepareFileUploadArgs { + session: &session, + extension: "mp4".to_string(), + host_override: None, + }; + let prepare_result = prepare_file_upload(prepare_args).await?; + println!("Upload URL: {}", prepare_result.upload_url); + + let file_bytes = fs::read("/Users/bt/Videos/Artcraft/Artcraft Best/ArtCraft Seedance Knight.mp4")?; + println!("File size: {} bytes", file_bytes.len()); + + let upload_args = UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes, + host_override: None, + }; + let result = upload_file(upload_args).await?; + println!("Public URL: {}", result.public_url); + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "Change @video1 to night time".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: Some(vec![result.public_url]), + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert_eq!(1, 2); + + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_pro_keyframe_with_start_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded start frame: {}", upload_result.public_url); + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "The corgi dog watches the lake.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Portrait9x16, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: Some(upload_result.public_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_fast_keyframe_with_start_frame() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded start frame: {}", upload_result.public_url); + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Fast, + prompt: "A corgi dog runs along the lake shore, splashing water. Camera follows.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: Some(upload_result.public_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_fast_three_image_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let image_urls_to_upload = [ + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL, + test_data::web::image_urls::FOREST_BACKDROP_IMAGE_URL, + ]; + + let mut uploaded_urls = Vec::new(); + for (i, source_url) in image_urls_to_upload.iter().enumerate() { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes(source_url).await?; + let ext = if source_url.ends_with(".png") { "png" } else { "jpg" }; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: ext.to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded ref image {}: {}", i + 1, upload_result.public_url); + uploaded_urls.push(upload_result.public_url); + } + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Fast, + prompt: "The dog in @1 is running through the scenery in @3 towards the building in @2. Golden hour lighting.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(uploaded_urls), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_fast_audio_reference_with_text() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let audio_path = test_utils::test_file_path::test_file_path( + "test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3", + )?; + let audio_bytes = fs::read(&audio_path)?; + println!("Audio file size: {} bytes", audio_bytes.len()); + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "mp3".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: audio_bytes, + host_override: None, + }).await?; + + println!("Uploaded audio: {}", upload_result.public_url); + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Fast, + prompt: "A fantasy forest with mushrooms glowing in the dark. Fireflies dance between the trees. A small character walks along a winding path.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: Some(vec![upload_result.public_url]), + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + mod character_tests { + use super::*; + + const STEAMPUNK_CLOWN_ID: &str = "char_1775176566518_sik0te"; + const MOCHI_ID: &str = "char_1775177718294_g2pitx"; + + #[tokio::test] + #[ignore] + async fn test_text_prompt_with_character_pro() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "@Steampunk Clown is juggling flaming torches in a circus tent.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_text_prompt_with_character_fast() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Fast, + prompt: "@Mochi the female shiba inu is eating a cheese pizza while standing on the table".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Portrait9x16, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![MOCHI_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_character_with_image_ref_pro() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "@Steampunk Clown is walking up to pet a dog on the couch.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(vec![ + "https://static.seedance2-pro.com/materials/20260329/1774752385699-1ff44886.jpeg".to_string(), + ]), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![STEAMPUNK_CLOWN_ID.to_string()]), + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_two_characters_fast() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Fast, + prompt: "@Steampunk Clown and @Mochi are playing fetch in a sunny park.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: Some(vec![ + STEAMPUNK_CLOWN_ID.to_string(), + MOCHI_ID.to_string(), + ]), + use_face_blur_hack: None, + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Task ID: {}", result.task_id); + println!("Order ID: {}", result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + + mod happy_horse_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_happy_horse_text_to_video_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::HappyHorse1p0, + prompt: "A corgi and shiba are in a bamboo forest. They are samurai battling one anotherplaying chess against one another".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 4, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: Some(false), + bitrate: None, + output_resolution: Some(KinoviOutputResolutionRaw::TenEightyP), + }, + }; + let result = workflow_run_task(args).await?; + println!("Happy Horse t2v 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_happy_horse_keyframe_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded start frame: {}", upload_result.public_url); + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::HappyHorse1p0, + prompt: "The corgi dog watches the lake as the sun sets.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Portrait9x16, + duration_seconds: 8, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: Some(upload_result.public_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: Some(false), + bitrate: None, + output_resolution: None, + }, + }; + let result = workflow_run_task(args).await?; + println!("Happy Horse keyframe 720p — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_happy_horse_keyframe_1080p_square() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + let image_bytes = crate::test_utils::http_download::http_download_to_bytes( + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + ).await?; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: "jpg".to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded start frame: {}", upload_result.public_url); + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::HappyHorse1p0, + prompt: "A dragon and a raptor fighting on the beach.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Square1x1, + duration_seconds: 15, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: Some(upload_result.public_url), + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: Some(false), + bitrate: None, + output_resolution: Some(KinoviOutputResolutionRaw::TenEightyP), + }, + }; + let result = workflow_run_task(args).await?; + println!("Happy Horse keyframe 1080p square — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2); + Ok(()) + } + } + } + + mod output_resolution_tests { + use super::*; + + fn test_session() -> AnyhowResult { + let cookies = get_test_cookies()?; + Ok(Seedance2ProSession::from_cookies_string(cookies)) + } + + fn make_args_with_prompt<'a>( + prompt: &'a str, + session: &'a Seedance2ProSession, + model_type: KinoviModelTypeRaw, + output_resolution: Option, + ) -> WorkflowRunTaskArgs<'a> { + WorkflowRunTaskArgs { + session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type, + prompt: prompt.to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 4, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + output_resolution, + use_face_blur_hack: None, + bitrate: None, + }, + } + } + + fn make_args<'a>( + session: &'a Seedance2ProSession, + model_type: KinoviModelTypeRaw, + output_resolution: Option, + ) -> WorkflowRunTaskArgs<'a> { + make_args_with_prompt("A corgi running through a field of flowers", session, model_type, output_resolution) + } + + mod seedance_2 { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let args = make_args(&session, KinoviModelTypeRaw::Seedance2Pro, Some(KinoviOutputResolutionRaw::FourEightyP)); + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 @ 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A corgi running through a field of stars"; + let args = make_args_with_prompt(prompt, &session, KinoviModelTypeRaw::Seedance2Pro, None); + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 @ 720p (default) — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A shiba running through a field of stars"; + let args = make_args_with_prompt(prompt, &session, KinoviModelTypeRaw::Seedance2Pro, Some(KinoviOutputResolutionRaw::TenEightyP)); + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 @ 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + /// 4K with image references (Seedance 2.0 Pro only), 5-second sample. + #[tokio::test] + #[ignore] + async fn test_4k_image_references() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + + // Upload a few reference images first, then drive a 5-second 4K job. + let image_urls_to_upload = [ + test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL, + test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL, + test_data::web::image_urls::FOREST_BACKDROP_IMAGE_URL, + ]; + + let mut uploaded_urls = Vec::new(); + for (i, source_url) in image_urls_to_upload.iter().enumerate() { + let image_bytes = crate::test_utils::http_download::http_download_to_bytes(source_url).await?; + let ext = if source_url.ends_with(".png") { "png" } else { "jpg" }; + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session: &session, + extension: ext.to_string(), + host_override: None, + }).await?; + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: image_bytes, + host_override: None, + }).await?; + + println!("Uploaded ref image {}: {}", i + 1, upload_result.public_url); + uploaded_urls.push(upload_result.public_url); + } + + let args = WorkflowRunTaskArgs { + session: &session, + host_override: None, + request: WorkflowRunTaskRequest { + model_type: KinoviModelTypeRaw::Seedance2Pro, + prompt: "The dog in @1 explores the scenery in @3 near the building in @2. Cinematic 4K detail.".to_string(), + aspect_ratio: KinoviAspectRatioRaw::Landscape16x9, + duration_seconds: 5, + batch_count: KinoviBatchCountRaw::One, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: Some(uploaded_urls), + reference_video_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + output_resolution: Some(KinoviOutputResolutionRaw::FourK), + }, + }; + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 @ 4K (image refs) — task_id={}, order_id={}", result.task_id, result.order_id); + assert!(!result.task_id.is_empty()); + assert!(!result.order_id.is_empty()); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + } + + mod seedance_2_fast { + use super::*; + + #[tokio::test] + #[ignore] + async fn test_480p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A corgi running through a foggy meadow at dawn"; + let args = make_args_with_prompt(prompt, &session, KinoviModelTypeRaw::Seedance2Fast, Some(KinoviOutputResolutionRaw::FourEightyP)); + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 Fast @ 480p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_720p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A shiba running through a foggy meadow at dawn"; + let args = make_args_with_prompt(prompt, &session, KinoviModelTypeRaw::Seedance2Fast, None); + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 Fast @ 720p (default) — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + + #[tokio::test] + #[ignore] + async fn test_1080p() -> AnyhowResult<()> { + setup_test_logging(LevelFilter::Trace); + let session = test_session()?; + let prompt = "A small klee kai dog running through a foggy meadow at dawn"; + let args = make_args_with_prompt(prompt, &session, KinoviModelTypeRaw::Seedance2Fast, Some(KinoviOutputResolutionRaw::TenEightyP)); + let result = workflow_run_task(args).await?; + println!("Seedance 2.0 Fast @ 1080p — task_id={}, order_id={}", result.task_id, result.order_id); + assert_eq!(1, 2, "Inspect output above"); + Ok(()) + } + } + } +} diff --git a/crates/api_clients/seedance2pro_client/src/test_utils/get_test_cookies.rs b/crates/api_clients/seedance2pro_client/src/test_utils/get_test_cookies.rs new file mode 100644 index 00000000..bbe163ab --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/test_utils/get_test_cookies.rs @@ -0,0 +1,9 @@ +use errors::AnyhowResult; +use std::fs::read_to_string; + +#[cfg(test)] +pub fn get_test_cookies() -> AnyhowResult { + let cookies = read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt")?; + let cookies = cookies.trim().to_string(); + Ok(cookies) +} diff --git a/crates/api_clients/seedance2pro_client/src/test_utils/http_download.rs b/crates/api_clients/seedance2pro_client/src/test_utils/http_download.rs new file mode 100644 index 00000000..cd5fae52 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/test_utils/http_download.rs @@ -0,0 +1,9 @@ +use errors::AnyhowResult; + +/// Download a URL to bytes. For use in tests only. +#[cfg(test)] +pub async fn http_download_to_bytes(url: &str) -> AnyhowResult> { + let response = wreq::get(url).send().await?; + let bytes = response.bytes().await?; + Ok(bytes.to_vec()) +} diff --git a/crates/api_clients/seedance2pro_client/src/test_utils/mod.rs b/crates/api_clients/seedance2pro_client/src/test_utils/mod.rs new file mode 100644 index 00000000..84b8dd4f --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/test_utils/mod.rs @@ -0,0 +1,8 @@ +#[cfg(test)] +pub (crate) mod get_test_cookies; + +#[cfg(test)] +pub (crate) mod http_download; + +#[cfg(test)] +pub (crate) mod setup_test_logging; diff --git a/crates/api_clients/seedance2pro_client/src/test_utils/setup_test_logging.rs b/crates/api_clients/seedance2pro_client/src/test_utils/setup_test_logging.rs new file mode 100644 index 00000000..cdb6c4e5 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/test_utils/setup_test_logging.rs @@ -0,0 +1,54 @@ +use chrono::Local; +use env_logger::Builder; +use log::{debug, error, info, trace, warn, LevelFilter}; +use std::io::Write; + +const RUST_LOG: &str = "RUST_LOG"; + +pub fn setup_test_logging(level: LevelFilter) { + let level_str = get_level_str(level); + + println!("Previous log level: {:?}", env::var(RUST_LOG)); + + let is_unsafe = env::set_var(RUST_LOG, level_str); + + if is_unsafe.is_none() { + println!("Unsafely setting Rust Log Level..."); + unsafe { std::env::set_var(RUST_LOG, level_str) } + } + + println!("Log level: {:?}", env::var(RUST_LOG)); + + // try_init: several #[ignore] live tests may run in one process, and only + // the first can install the logger. + let _ = Builder::new() + .is_test(true) + .format(|buf, record| { + writeln!(buf, + "{} [{}] - {}", + Local::now().format("%H:%M:%S%.6f"), + record.level(), + record.args() + ) + }) + .filter(None, level) + .filter_level(level) + .try_init(); + + trace!("Test trace log"); + debug!("Test debug log"); + info!("Test info log"); + warn!("Test warn log"); + error!("Test error log"); +} + +fn get_level_str(level: LevelFilter) -> &'static str { + match level { + LevelFilter::Error => "error", + LevelFilter::Warn => "warn", + LevelFilter::Info => "info", + LevelFilter::Debug => "debug", + LevelFilter::Trace => "trace", + LevelFilter::Off => "off", + } +} diff --git a/crates/api_clients/seedance2pro_client/src/utils/categorize_seedance2pro_error.rs b/crates/api_clients/seedance2pro_client/src/utils/categorize_seedance2pro_error.rs new file mode 100644 index 00000000..5277fe7d --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/utils/categorize_seedance2pro_error.rs @@ -0,0 +1,224 @@ +use wreq::StatusCode; + +use crate::error::seedance2pro_bad_request_api_error::Seedance2ProBadRequestApiError; +use crate::error::seedance2pro_error::Seedance2ProError; +use crate::error::seedance2pro_generic_api_error::Seedance2ProGenericApiError; +use crate::error::seedance2pro_specific_api_error::Seedance2ProSpecificApiError; + +/// Known error message substrings that indicate a billing/credits error. +const BILLING_ERROR_MARKERS: &[&str] = &[ + "credits not enough", +]; + +/// Zod validation message for a string field exceeding its maximum length, +/// eg. "参数验证失败 - String must contain at most 10000 character(s)". +const STRING_TOO_LONG_MARKER: &str = "String must contain at most"; + +/// Zod validation message for an array field exceeding its maximum size, +/// eg. "参数验证失败 - Array must contain at most 9 element(s)". +const ARRAY_TOO_LARGE_MARKER: &str = "Array must contain at most"; + +/// Zod `fieldErrors` path entry for the prompt field. +const PROMPT_FIELD_MARKER: &str = "\"prompt\""; + +/// Zod `fieldErrors` path entry for the uploaded media urls field. +const UPLOADED_URLS_FIELD_MARKER: &str = "\"uploadedUrls\""; + +/// Categorize a non-success HTTP response into a specific or generic error. +/// +/// Checks the response body for known patterns (e.g. billing errors, request +/// validation failures) and returns a specific error variant when possible, +/// falling back to `UncategorizedBadResponseWithStatusAndBody` otherwise. +pub fn categorize_seedance2pro_error( + status_code: StatusCode, + body: String, +) -> Seedance2ProError { + if is_billing_error(&body) { + return Seedance2ProSpecificApiError::BillingError { + status_code, + body, + }.into(); + } + + if status_code == StatusCode::BAD_REQUEST { + if is_prompt_too_long_error(&body) { + return Seedance2ProBadRequestApiError::PromptIsTooLong { raw_body: body }.into(); + } + if is_too_many_urls_error(&body) { + return Seedance2ProBadRequestApiError::TooManyUrls { raw_body: body }.into(); + } + } + + Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { + status_code, + body, + }.into() +} + +/// Check if the response body contains a known billing error marker. +fn is_billing_error(body: &str) -> bool { + let body_lower = body.to_lowercase(); + BILLING_ERROR_MARKERS.iter().any(|marker| body_lower.contains(marker)) +} + +/// Check if the response body is a zod validation failure for an over-long prompt. +fn is_prompt_too_long_error(body: &str) -> bool { + body.contains(STRING_TOO_LONG_MARKER) && body.contains(PROMPT_FIELD_MARKER) +} + +/// Check if the response body is a zod validation failure for too many uploaded urls. +fn is_too_many_urls_error(body: &str) -> bool { + body.contains(ARRAY_TOO_LARGE_MARKER) && body.contains(UPLOADED_URLS_FIELD_MARKER) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::error::seedance2pro_error::Seedance2ProError; + + mod billing_tests { + use super::*; + + #[test] + fn real_not_enough_credits_response() { + let body = read_response_body("not_enough_credits.json"); + + let error = categorize_seedance2pro_error(StatusCode::BAD_REQUEST, body); + + match error { + Seedance2ProError::ApiSpecific( + Seedance2ProSpecificApiError::BillingError { status_code, body } + ) => { + assert_eq!(status_code, StatusCode::BAD_REQUEST); + assert!(body.contains("credits not enough")); + } + other => panic!("Expected BillingError, got: {:?}", other), + } + } + + #[test] + fn billing_error_case_insensitive() { + let body = r#"{"error":"Credits Not Enough"}"#.to_string(); + + let error = categorize_seedance2pro_error(StatusCode::BAD_REQUEST, body); + + match error { + Seedance2ProError::ApiSpecific( + Seedance2ProSpecificApiError::BillingError { .. } + ) => {} + other => panic!("Expected BillingError, got: {:?}", other), + } + } + } + + mod bad_request_tests { + use super::*; + + #[test] + fn real_prompt_too_long_response() { + let body = read_response_body("prompt_too_long.json"); + + let error = categorize_seedance2pro_error(StatusCode::BAD_REQUEST, body); + + match error { + Seedance2ProError::ApiBadRequest( + Seedance2ProBadRequestApiError::PromptIsTooLong { raw_body } + ) => { + assert!(raw_body.contains("String must contain at most 10000 character(s)")); + assert!(raw_body.contains("\"prompt\"")); + } + other => panic!("Expected PromptIsTooLong, got: {:?}", other), + } + } + + #[test] + fn real_too_many_urls_response() { + let body = read_response_body("too_many_urls.json"); + + let error = categorize_seedance2pro_error(StatusCode::BAD_REQUEST, body); + + match error { + Seedance2ProError::ApiBadRequest( + Seedance2ProBadRequestApiError::TooManyUrls { raw_body } + ) => { + assert!(raw_body.contains("Array must contain at most 9 element(s)")); + assert!(raw_body.contains("\"uploadedUrls\"")); + } + other => panic!("Expected TooManyUrls, got: {:?}", other), + } + } + + #[test] + fn bad_request_markers_require_400_status() { + let body = read_response_body("prompt_too_long.json"); + + let error = categorize_seedance2pro_error(StatusCode::INTERNAL_SERVER_ERROR, body); + + match error { + Seedance2ProError::ApiGeneric( + Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. } + ) => {} + other => panic!("Expected UncategorizedBadResponseWithStatusAndBody, got: {:?}", other), + } + } + + #[test] + fn validation_failure_for_other_field_is_not_categorized() { + // Same zod shape, but for a field we don't have a variant for. + let body = r#"[{"error":{"json":{"message":"validation failed - String must contain at most 100 character(s)","code":-32600,"data":{"code":"BAD_REQUEST","httpStatus":400,"zodError":{"formErrors":[],"fieldErrors":{"apiParams":[{"code":"custom","message":"String must contain at most 100 character(s)","path":["apiParams","negativePrompt"],"fatal":true}]}}}}}]"#.to_string(); + + let error = categorize_seedance2pro_error(StatusCode::BAD_REQUEST, body); + + match error { + Seedance2ProError::ApiGeneric( + Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. } + ) => {} + other => panic!("Expected UncategorizedBadResponseWithStatusAndBody, got: {:?}", other), + } + } + } + + mod fallback_tests { + use super::*; + + #[test] + fn unknown_error_falls_back_to_uncategorized() { + let body = r#"{"error":"something else went wrong"}"#.to_string(); + + let error = categorize_seedance2pro_error( + StatusCode::INTERNAL_SERVER_ERROR, + body.clone(), + ); + + match error { + Seedance2ProError::ApiGeneric( + Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { status_code, body: b } + ) => { + assert_eq!(status_code, StatusCode::INTERNAL_SERVER_ERROR); + assert_eq!(b, body); + } + other => panic!("Expected UncategorizedBadResponseWithStatusAndBody, got: {:?}", other), + } + } + + #[test] + fn empty_body_falls_back_to_uncategorized() { + let error = categorize_seedance2pro_error( + StatusCode::BAD_REQUEST, + String::new(), + ); + + match error { + Seedance2ProError::ApiGeneric( + Seedance2ProGenericApiError::UncategorizedBadResponseWithStatusAndBody { .. } + ) => {} + other => panic!("Expected UncategorizedBadResponseWithStatusAndBody, got: {:?}", other), + } + } + } + + fn read_response_body(filename: &str) -> String { + std::fs::read_to_string(format!("test_data/responses/{}", filename)) + .expect("Failed to read test data file") + } +} diff --git a/crates/api_clients/seedance2pro_client/src/utils/common_headers.rs b/crates/api_clients/seedance2pro_client/src/utils/common_headers.rs new file mode 100644 index 00000000..d10f62ab --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/utils/common_headers.rs @@ -0,0 +1,2 @@ +pub const FIREFOX_USER_AGENT: &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:147.0) Gecko/20100101 Firefox/147.0"; diff --git a/crates/api_clients/seedance2pro_client/src/utils/mod.rs b/crates/api_clients/seedance2pro_client/src/utils/mod.rs new file mode 100644 index 00000000..98128651 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/utils/mod.rs @@ -0,0 +1,3 @@ +pub mod categorize_seedance2pro_error; +pub mod common_headers; +pub mod number_coercion; diff --git a/crates/api_clients/seedance2pro_client/src/utils/number_coercion.rs b/crates/api_clients/seedance2pro_client/src/utils/number_coercion.rs new file mode 100644 index 00000000..cf2ab132 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/src/utils/number_coercion.rs @@ -0,0 +1,177 @@ +//! Deserialization helpers for numeric fields that the Kinovi API has started +//! returning as floating-point values where it previously returned integers +//! (e.g. `width: 568.5`, `credits: 372215.18`). +//! +//! Each helper accepts EITHER a JSON integer or a JSON float and coerces it to +//! an unsigned integer: exact integers pass through unchanged (no precision +//! loss for large `u64` credit balances), and floats are rounded to the nearest +//! integer. Negative / non-finite values clamp to `0`. + +use serde::{Deserialize, Deserializer}; +use serde_json::Number; + +/// Coerce a parsed JSON number to `u64`. Exact non-negative integers pass +/// through; floats are rounded; anything negative / non-finite becomes `0`. +fn coerce_to_u64(number: &Number) -> u64 { + if let Some(unsigned) = number.as_u64() { + return unsigned; + } + if let Some(float) = number.as_f64() { + if float.is_finite() && float >= 0.0 { + return float.round() as u64; + } + } + 0 +} + +fn coerce_to_u32(number: &Number) -> u32 { + coerce_to_u64(number).min(u32::MAX as u64) as u32 +} + +/// Coerce a parsed JSON number to `i64`. Exact integers pass through; floats +/// are rounded; non-finite values become `0`. +fn coerce_to_i64(number: &Number) -> i64 { + if let Some(signed) = number.as_i64() { + return signed; + } + if let Some(float) = number.as_f64() { + if float.is_finite() { + return float.round() as i64; + } + } + 0 +} + +/// `#[serde(deserialize_with = "...")]` for a required `u64` field that may +/// arrive as an integer or a float. +pub fn de_u64_int_or_float<'de, D>(deserializer: D) -> Result +where + D: Deserializer<'de>, +{ + let number = Number::deserialize(deserializer)?; + Ok(coerce_to_u64(&number)) +} + +/// `#[serde(deserialize_with = "...")]` for a required `i64` field that may +/// arrive as an integer or a float (e.g. signed credit deltas). +pub fn de_i64_int_or_float<'de, D>(deserializer: D) -> Result +where + D: Deserializer<'de>, +{ + let number = Number::deserialize(deserializer)?; + Ok(coerce_to_i64(&number)) +} + +/// `#[serde(deserialize_with = "...")]` for an optional `u64` field (handles +/// `null` / missing as `None`). +pub fn de_opt_u64_int_or_float<'de, D>(deserializer: D) -> Result, D::Error> +where + D: Deserializer<'de>, +{ + let maybe_number = Option::::deserialize(deserializer)?; + Ok(maybe_number.as_ref().map(coerce_to_u64)) +} + +/// `#[serde(deserialize_with = "...")]` for an optional `u32` field (handles +/// `null` / missing as `None`). +pub fn de_opt_u32_int_or_float<'de, D>(deserializer: D) -> Result, D::Error> +where + D: Deserializer<'de>, +{ + let maybe_number = Option::::deserialize(deserializer)?; + Ok(maybe_number.as_ref().map(coerce_to_u32)) +} + +/// `#[serde(deserialize_with = "...")]` for a required `u32` field that may +/// arrive as an integer or a float. +pub fn de_u32_int_or_float<'de, D>(deserializer: D) -> Result +where + D: Deserializer<'de>, +{ + let number = Number::deserialize(deserializer)?; + Ok(coerce_to_u32(&number)) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[derive(Deserialize)] + struct U32Holder { + #[serde(deserialize_with = "de_u32_int_or_float")] + value: u32, + } + + #[derive(Deserialize)] + struct U64Holder { + #[serde(deserialize_with = "de_u64_int_or_float")] + value: u64, + } + + #[derive(Deserialize)] + struct OptU32Holder { + #[serde(default, deserialize_with = "de_opt_u32_int_or_float")] + value: Option, + } + + #[derive(Deserialize)] + struct I64Holder { + #[serde(deserialize_with = "de_i64_int_or_float")] + value: i64, + } + + fn parse_u32(json: &str) -> u32 { + serde_json::from_str::(json).unwrap().value + } + + fn parse_u64(json: &str) -> u64 { + serde_json::from_str::(json).unwrap().value + } + + fn parse_i64(json: &str) -> i64 { + serde_json::from_str::(json).unwrap().value + } + + #[test] + fn u32_accepts_integer() { + assert_eq!(parse_u32(r#"{"value": 568}"#), 568); + } + + #[test] + fn u32_accepts_float_and_rounds() { + assert_eq!(parse_u32(r#"{"value": 568.5}"#), 569); + assert_eq!(parse_u32(r#"{"value": 568.4}"#), 568); + } + + #[test] + fn u64_accepts_integer_exactly() { + // Large value that would lose precision via f64 — must pass through exact. + assert_eq!(parse_u64(r#"{"value": 372215}"#), 372215); + } + + #[test] + fn u64_accepts_float_and_rounds() { + assert_eq!(parse_u64(r#"{"value": 372215.18}"#), 372215); + } + + #[test] + fn negative_and_nonfinite_clamp_to_zero() { + assert_eq!(parse_u64(r#"{"value": -5}"#), 0); + assert_eq!(parse_u64(r#"{"value": -5.5}"#), 0); + } + + #[test] + fn i64_accepts_negative_integers_and_floats() { + assert_eq!(parse_i64(r#"{"value": -454}"#), -454); + assert_eq!(parse_i64(r#"{"value": -454.6}"#), -455); + assert_eq!(parse_i64(r#"{"value": 25000}"#), 25000); + } + + #[test] + fn optional_handles_null_missing_and_values() { + assert_eq!(serde_json::from_str::(r#"{"value": null}"#).unwrap().value, None); + assert_eq!(serde_json::from_str::(r#"{}"#).unwrap().value, None); + assert_eq!(serde_json::from_str::(r#"{"value": 12.9}"#).unwrap().value, Some(13)); + assert_eq!(serde_json::from_str::(r#"{"value": 12}"#).unwrap().value, Some(12)); + } +} diff --git a/crates/api_clients/seedance2pro_client/test_data/responses/not_enough_credits.json b/crates/api_clients/seedance2pro_client/test_data/responses/not_enough_credits.json new file mode 100644 index 00000000..d1949a18 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/test_data/responses/not_enough_credits.json @@ -0,0 +1,25 @@ +[ + { + "error": { + "json": { + "message": "credits not enough", + "code": -32600, + "data": { + "code": "BAD_REQUEST", + "httpStatus": 400, + "path": "workflow.runTask", + "zodError": null + }, + "stack": null + }, + "meta": { + "values": { + "stack": [ + "undefined" + ] + }, + "v": 1 + } + } + } +] diff --git a/crates/api_clients/seedance2pro_client/test_data/responses/prompt_too_long.json b/crates/api_clients/seedance2pro_client/test_data/responses/prompt_too_long.json new file mode 100644 index 00000000..30086ad3 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/test_data/responses/prompt_too_long.json @@ -0,0 +1,40 @@ +[ + { + "error": { + "json": { + "message": "[{\"code\": \"custom\",\"message\": \"参数验证失败 - String must contain at most 10000 character(s)\",\"path\": [\"apiParams\",\"prompt\"],\"fatal\": true}]", + "code": -32600, + "data": { + "code": "BAD_REQUEST", + "httpStatus": 400, + "path": "workflow.runTask", + "zodError": { + "formErrors": [], + "fieldErrors": { + "apiParams": [ + { + "code": "custom", + "message": "参数验证失败 - String must contain at most 10000 character(s)", + "path": [ + "apiParams", + "prompt" + ], + "fatal": true + } + ] + } + } + }, + "stack": null + }, + "meta": { + "values": { + "stack": [ + "undefined" + ] + }, + "v": 1 + } + } + } +] \ No newline at end of file diff --git a/crates/api_clients/seedance2pro_client/test_data/responses/too_many_urls.json b/crates/api_clients/seedance2pro_client/test_data/responses/too_many_urls.json new file mode 100644 index 00000000..65a351a3 --- /dev/null +++ b/crates/api_clients/seedance2pro_client/test_data/responses/too_many_urls.json @@ -0,0 +1,40 @@ +[ + { + "error": { + "json": { + "message": "[{\"code\": \"custom\",\"message\": \"参数验证失败 - Array must contain at most 9 element(s)\",\"path\": [\"apiParams\",\"uploadedUrls\"],\"fatal\": true}]", + "code": -32600, + "data": { + "code": "BAD_REQUEST", + "httpStatus": 400, + "path": "workflow.runTask", + "zodError": { + "formErrors": [], + "fieldErrors": { + "apiParams": [ + { + "code": "custom", + "message": "参数验证失败 - Array must contain at most 9 element(s)", + "path": [ + "apiParams", + "uploadedUrls" + ], + "fatal": true + } + ] + } + } + }, + "stack": null + }, + "meta": { + "values": { + "stack": [ + "undefined" + ] + }, + "v": 1 + } + } + } +] \ No newline at end of file diff --git a/crates/artcraftx/.gitignore b/crates/artcraftx/.gitignore new file mode 100644 index 00000000..502406b4 --- /dev/null +++ b/crates/artcraftx/.gitignore @@ -0,0 +1,4 @@ +# Generated by Cargo +# will have compiled files and executables +/target/ +/gen/schemas diff --git a/crates/artcraftx/.taurignore b/crates/artcraftx/.taurignore new file mode 100644 index 00000000..ad17b2ca --- /dev/null +++ b/crates/artcraftx/.taurignore @@ -0,0 +1,4 @@ +# Don't restart the dev server on Rust changes +crates/ +Cargo.toml +Cargo.lock \ No newline at end of file diff --git a/crates/artcraftx/Cargo.toml b/crates/artcraftx/Cargo.toml new file mode 100644 index 00000000..27f0d350 --- /dev/null +++ b/crates/artcraftx/Cargo.toml @@ -0,0 +1,98 @@ +[package] +name = "artcraftx" +version = "0.0.1" +description = "ArtCraftX" +authors = ["you"] +license = "" +repository = "" +edition = "2021" +rust-version = "1.77.2" +publish = false + +# [lints.rust] +# unused_imports = "forbid" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[lib] +name = "artcraftx_app_lib" +crate-type = ["staticlib", "cdylib", "rlib"] + +[build-dependencies] +tauri-build = { version = "2.6.2", features = [] } + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +artcraft_client.workspace = true +router.workspace = true +build_metadata.workspace = true +cookie_store_wrapper.workspace = true +errors.workspace = true +fal_client.workspace = true +file_hashing.workspace = true +filesys.workspace = true +grok_consumer_client.workspace = true +higgsfield_client.workspace = true +grok_consumer_statsig.workspace = true +uuid_utils.workspace = true +browser_emulation.workspace = true +images.workspace = true +local_files_database.workspace = true +memory_store.workspace = true +midjourney_client.workspace = true +mimetypes.workspace = true +primitives.workspace = true +sqlite_database.workspace = true +thumbnails.workspace = true +core_types.workspace = true +models.workspace = true +sqlite_identifiers.workspace = true +url_utils.workspace = true +web_base64.workspace = true + +# External +anyhow.workspace = true +async-trait.workspace = true +base64.workspace = true +bytes = "1.10.1" +chrono.workspace = true +directories = "6.0.0" +dirs = "6.0.0" +discord-rich-presence = "1.1.0" +futures = "0.3" +image = "0.25.5" +indexmap.workspace = true +log.workspace = true +once_cell.workspace = true +os_info = { version = "3.12.0", default-features = false } +rand.workspace = true +reqwest = { workspace = true, features = ["multipart", "stream"], default-features = false } # NB(bt,2025-03-10): default-features = false on Windows while I debug openssl / rustls +serde.workspace = true +serde_derive.workspace = true +serde_json.workspace = true +tauri-plugin-dialog.workspace = true +tauri-plugin-log.workspace = true +tauri-plugin-upload.workspace = true +tauri.workspace = true +tempdir.workspace = true +tempfile.workspace = true +tokio = { version = "1.42", features = ["rt", "rt-multi-thread", "fs", "sync", "time", "macros"] } +tokio-util.workspace = true +toml.workspace = true +url.workspace = true + +# NB: We need to vendor this in so that we can access the cookies inside via the private API +tauri-plugin-http = { path = "../vendor/tauri-plugin-http" } +tauri-plugin-opener = "2" + +# # Transparent title bar on MacOS +# # NB: See the notes here: +# # https://v2.tauri.app/learn/window-customization/ +# [target."cfg(target_os = \"macos\")".dependencies] +# cocoa = "0.26" + +[dev-dependencies] +serial_test = "3.2.0" diff --git a/crates/artcraftx/build.rs b/crates/artcraftx/build.rs new file mode 100644 index 00000000..795b9b7c --- /dev/null +++ b/crates/artcraftx/build.rs @@ -0,0 +1,3 @@ +fn main() { + tauri_build::build() +} diff --git a/crates/artcraftx/capabilities/default.json b/crates/artcraftx/capabilities/default.json new file mode 100644 index 00000000..9e286eff --- /dev/null +++ b/crates/artcraftx/capabilities/default.json @@ -0,0 +1,34 @@ +{ + "$schema": "../gen/schemas/desktop-schema.json", + "identifier": "default", + "description": "enables the default permissions", + "windows": [ + "main" + ], + "permissions": [ + "core:default", + "core:window:allow-close", + "core:window:allow-minimize", + "core:window:allow-start-dragging", + "core:window:allow-set-focus", + "core:window:allow-toggle-maximize", + "core:window:default", + "dialog:default", + "http:allow-fetch", + "log:default", + "upload:allow-download", + "upload:default", + { + "identifier": "http:default", + "allow": [ + { + "url": "https://*" + }, + { + "url": "http://localhost:12345" + } + ] + }, + "opener:default" + ] +} \ No newline at end of file diff --git a/crates/artcraftx/icons/128x128.png b/crates/artcraftx/icons/128x128.png new file mode 100644 index 00000000..baeb9c06 Binary files /dev/null and b/crates/artcraftx/icons/128x128.png differ diff --git a/crates/artcraftx/icons/128x128@2x.png b/crates/artcraftx/icons/128x128@2x.png new file mode 100644 index 00000000..97cfd0b2 Binary files /dev/null and b/crates/artcraftx/icons/128x128@2x.png differ diff --git a/crates/artcraftx/icons/32x32.png b/crates/artcraftx/icons/32x32.png new file mode 100644 index 00000000..e7db6b6d Binary files /dev/null and b/crates/artcraftx/icons/32x32.png differ diff --git a/crates/artcraftx/icons/64x64.png b/crates/artcraftx/icons/64x64.png new file mode 100644 index 00000000..2bfadfe0 Binary files /dev/null and b/crates/artcraftx/icons/64x64.png differ diff --git a/crates/artcraftx/icons/Square107x107Logo.png b/crates/artcraftx/icons/Square107x107Logo.png new file mode 100644 index 00000000..35a253d4 Binary files /dev/null and b/crates/artcraftx/icons/Square107x107Logo.png differ diff --git a/crates/artcraftx/icons/Square142x142Logo.png b/crates/artcraftx/icons/Square142x142Logo.png new file mode 100644 index 00000000..caaadd7b Binary files /dev/null and b/crates/artcraftx/icons/Square142x142Logo.png differ diff --git a/crates/artcraftx/icons/Square150x150Logo.png b/crates/artcraftx/icons/Square150x150Logo.png new file mode 100644 index 00000000..be7aa118 Binary files /dev/null and b/crates/artcraftx/icons/Square150x150Logo.png differ diff --git a/crates/artcraftx/icons/Square284x284Logo.png b/crates/artcraftx/icons/Square284x284Logo.png new file mode 100644 index 00000000..b6ba3c25 Binary files /dev/null and b/crates/artcraftx/icons/Square284x284Logo.png differ diff --git a/crates/artcraftx/icons/Square30x30Logo.png b/crates/artcraftx/icons/Square30x30Logo.png new file mode 100644 index 00000000..bf789473 Binary files /dev/null and b/crates/artcraftx/icons/Square30x30Logo.png differ diff --git a/crates/artcraftx/icons/Square310x310Logo.png b/crates/artcraftx/icons/Square310x310Logo.png new file mode 100644 index 00000000..c9378aeb Binary files /dev/null and b/crates/artcraftx/icons/Square310x310Logo.png differ diff --git a/crates/artcraftx/icons/Square44x44Logo.png b/crates/artcraftx/icons/Square44x44Logo.png new file mode 100644 index 00000000..b43d72fc Binary files /dev/null and b/crates/artcraftx/icons/Square44x44Logo.png differ diff --git a/crates/artcraftx/icons/Square71x71Logo.png b/crates/artcraftx/icons/Square71x71Logo.png new file mode 100644 index 00000000..694d402a Binary files /dev/null and b/crates/artcraftx/icons/Square71x71Logo.png differ diff --git a/crates/artcraftx/icons/Square89x89Logo.png b/crates/artcraftx/icons/Square89x89Logo.png new file mode 100644 index 00000000..cb819018 Binary files /dev/null and b/crates/artcraftx/icons/Square89x89Logo.png differ diff --git a/crates/artcraftx/icons/StoreLogo.png b/crates/artcraftx/icons/StoreLogo.png new file mode 100644 index 00000000..971214c0 Binary files /dev/null and b/crates/artcraftx/icons/StoreLogo.png differ diff --git a/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher.png b/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher.png new file mode 100644 index 00000000..a8f46064 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher.png differ diff --git a/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher_foreground.png b/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher_foreground.png new file mode 100644 index 00000000..856fc5bd Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher_foreground.png differ diff --git a/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher_round.png b/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 00000000..a8f46064 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-hdpi/ic_launcher_round.png differ diff --git a/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher.png b/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher.png new file mode 100644 index 00000000..2194742e Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher.png differ diff --git a/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher_foreground.png b/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher_foreground.png new file mode 100644 index 00000000..701f818e Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher_foreground.png differ diff --git a/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher_round.png b/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 00000000..2194742e Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-mdpi/ic_launcher_round.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher.png b/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 00000000..b180db63 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher_foreground.png b/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher_foreground.png new file mode 100644 index 00000000..3cd93c43 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher_foreground.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher_round.png b/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 00000000..b180db63 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher.png b/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 00000000..f09690f5 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher_foreground.png b/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher_foreground.png new file mode 100644 index 00000000..25d51ed4 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher_foreground.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher_round.png b/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 00000000..f09690f5 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher.png b/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 00000000..eb4454e6 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher_foreground.png b/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher_foreground.png new file mode 100644 index 00000000..963b1e48 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher_foreground.png differ diff --git a/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher_round.png b/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 00000000..eb4454e6 Binary files /dev/null and b/crates/artcraftx/icons/android/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/crates/artcraftx/icons/icon.icns b/crates/artcraftx/icons/icon.icns new file mode 100644 index 00000000..1e11c08e Binary files /dev/null and b/crates/artcraftx/icons/icon.icns differ diff --git a/crates/artcraftx/icons/icon.ico b/crates/artcraftx/icons/icon.ico new file mode 100644 index 00000000..b2e7a265 Binary files /dev/null and b/crates/artcraftx/icons/icon.ico differ diff --git a/crates/artcraftx/icons/icon.png b/crates/artcraftx/icons/icon.png new file mode 100644 index 00000000..ae13d4ce Binary files /dev/null and b/crates/artcraftx/icons/icon.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-20x20@1x.png b/crates/artcraftx/icons/ios/AppIcon-20x20@1x.png new file mode 100644 index 00000000..08d04d79 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-20x20@1x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-20x20@2x-1.png b/crates/artcraftx/icons/ios/AppIcon-20x20@2x-1.png new file mode 100644 index 00000000..6d4b74f0 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-20x20@2x-1.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-20x20@2x.png b/crates/artcraftx/icons/ios/AppIcon-20x20@2x.png new file mode 100644 index 00000000..6d4b74f0 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-20x20@2x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-20x20@3x.png b/crates/artcraftx/icons/ios/AppIcon-20x20@3x.png new file mode 100644 index 00000000..ef88a392 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-20x20@3x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-29x29@1x.png b/crates/artcraftx/icons/ios/AppIcon-29x29@1x.png new file mode 100644 index 00000000..880b1300 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-29x29@1x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-29x29@2x-1.png b/crates/artcraftx/icons/ios/AppIcon-29x29@2x-1.png new file mode 100644 index 00000000..54d51c2e Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-29x29@2x-1.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-29x29@2x.png b/crates/artcraftx/icons/ios/AppIcon-29x29@2x.png new file mode 100644 index 00000000..54d51c2e Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-29x29@2x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-29x29@3x.png b/crates/artcraftx/icons/ios/AppIcon-29x29@3x.png new file mode 100644 index 00000000..20c73d70 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-29x29@3x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-40x40@1x.png b/crates/artcraftx/icons/ios/AppIcon-40x40@1x.png new file mode 100644 index 00000000..6d4b74f0 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-40x40@1x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-40x40@2x-1.png b/crates/artcraftx/icons/ios/AppIcon-40x40@2x-1.png new file mode 100644 index 00000000..5bd6a225 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-40x40@2x-1.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-40x40@2x.png b/crates/artcraftx/icons/ios/AppIcon-40x40@2x.png new file mode 100644 index 00000000..5bd6a225 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-40x40@2x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-40x40@3x.png b/crates/artcraftx/icons/ios/AppIcon-40x40@3x.png new file mode 100644 index 00000000..b90a6e91 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-40x40@3x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-512@2x.png b/crates/artcraftx/icons/ios/AppIcon-512@2x.png new file mode 100644 index 00000000..12aed85b Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-512@2x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-60x60@2x.png b/crates/artcraftx/icons/ios/AppIcon-60x60@2x.png new file mode 100644 index 00000000..b90a6e91 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-60x60@2x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-60x60@3x.png b/crates/artcraftx/icons/ios/AppIcon-60x60@3x.png new file mode 100644 index 00000000..3a34b504 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-60x60@3x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-76x76@1x.png b/crates/artcraftx/icons/ios/AppIcon-76x76@1x.png new file mode 100644 index 00000000..8bf184ca Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-76x76@1x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-76x76@2x.png b/crates/artcraftx/icons/ios/AppIcon-76x76@2x.png new file mode 100644 index 00000000..6fd0a546 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-76x76@2x.png differ diff --git a/crates/artcraftx/icons/ios/AppIcon-83.5x83.5@2x.png b/crates/artcraftx/icons/ios/AppIcon-83.5x83.5@2x.png new file mode 100644 index 00000000..e4d293c6 Binary files /dev/null and b/crates/artcraftx/icons/ios/AppIcon-83.5x83.5@2x.png differ diff --git a/crates/artcraftx/src/commands/cost_estimate/estimate_audio_cost_command.rs b/crates/artcraftx/src/commands/cost_estimate/estimate_audio_cost_command.rs new file mode 100644 index 00000000..0e6850b6 --- /dev/null +++ b/crates/artcraftx/src/commands/cost_estimate/estimate_audio_cost_command.rs @@ -0,0 +1,45 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrError; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; +use artcraft_client::api_defs::omni_gen::cost_response::omni_gen_audio_cost_response::OmniGenAudioCostResponse; +use artcraft_client::endpoints::omni_gen::cost::audio::omni_gen_audio_cost::{omni_gen_audio_cost, OmniGenAudioCostArgs}; +use log::debug; +use serde_derive::Serialize; + +impl SerializeMarker for OmniGenAudioCostResponse {} + +#[derive(Serialize)] +pub struct EstimateAudioCostError { + pub success: bool, + pub error_message: String, +} + +/// Estimate the cost of a audio generation via the omni cost endpoint. +/// Anonymous: no credentials are needed for a baseline estimate. +#[tauri::command] +pub async fn estimate_audio_cost_command( + request: OmniGenAudioCostAndGenerateRequest, +) -> ResponseOrError { + debug!("estimate_audio_cost_command called"); + + let result = omni_gen_audio_cost(OmniGenAudioCostArgs { + api_host: &ApiHost::Storyteller, + api_or_web_creds: None, + request: &request, + }).await; + + match result { + Ok(response) => Ok(response.into()), + Err(err) => Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, + error_message: None, + error_type: None, + error_details: Some(EstimateAudioCostError { + success: false, + error_message: err.to_string(), + }), + }), + } +} diff --git a/crates/artcraftx/src/commands/cost_estimate/estimate_image_cost_command.rs b/crates/artcraftx/src/commands/cost_estimate/estimate_image_cost_command.rs new file mode 100644 index 00000000..118b2a32 --- /dev/null +++ b/crates/artcraftx/src/commands/cost_estimate/estimate_image_cost_command.rs @@ -0,0 +1,40 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrError; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use artcraft_client::api_defs::generate::cost_estimate::estimate_image_cost::{ + EstimateImageCostError, EstimateImageCostErrorType, EstimateImageCostRequest, + EstimateImageCostResponse, +}; +use artcraft_client::endpoints::generate::cost_estimate::image::estimate_image_cost::estimate_image_cost; +use log::debug; + +impl SerializeMarker for EstimateImageCostResponse {} + +#[tauri::command] +pub async fn estimate_image_cost_command( + request: EstimateImageCostRequest, +) -> ResponseOrError { + debug!("estimate_image_cost_command called: {:?}", request); + + let result = estimate_image_cost( + &ApiHost::Storyteller, + None, // Credentials are not required for this endpoint. + request, + ) + .await; + + match result { + Ok(response) => Ok(response.into()), + Err(err) => Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, + error_message: None, + error_type: None, + error_details: Some(EstimateImageCostError { + success: false, + error_type: EstimateImageCostErrorType::InvalidInput, + error_message: err.to_string(), + }), + }), + } +} diff --git a/crates/artcraftx/src/commands/cost_estimate/estimate_mesh_cost_command.rs b/crates/artcraftx/src/commands/cost_estimate/estimate_mesh_cost_command.rs new file mode 100644 index 00000000..1e6fe9ea --- /dev/null +++ b/crates/artcraftx/src/commands/cost_estimate/estimate_mesh_cost_command.rs @@ -0,0 +1,45 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrError; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; +use artcraft_client::api_defs::omni_gen::cost_response::omni_gen_mesh_cost_response::OmniGenMeshCostResponse; +use artcraft_client::endpoints::omni_gen::cost::mesh::omni_gen_mesh_cost::{omni_gen_mesh_cost, OmniGenMeshCostArgs}; +use log::debug; +use serde_derive::Serialize; + +impl SerializeMarker for OmniGenMeshCostResponse {} + +#[derive(Serialize)] +pub struct EstimateMeshCostError { + pub success: bool, + pub error_message: String, +} + +/// Estimate the cost of a mesh generation via the omni cost endpoint. +/// Anonymous: no credentials are needed for a baseline estimate. +#[tauri::command] +pub async fn estimate_mesh_cost_command( + request: OmniGenMeshCostAndGenerateRequest, +) -> ResponseOrError { + debug!("estimate_mesh_cost_command called"); + + let result = omni_gen_mesh_cost(OmniGenMeshCostArgs { + api_host: &ApiHost::Storyteller, + api_or_web_creds: None, + request: &request, + }).await; + + match result { + Ok(response) => Ok(response.into()), + Err(err) => Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, + error_message: None, + error_type: None, + error_details: Some(EstimateMeshCostError { + success: false, + error_message: err.to_string(), + }), + }), + } +} diff --git a/crates/artcraftx/src/commands/cost_estimate/estimate_splat_cost_command.rs b/crates/artcraftx/src/commands/cost_estimate/estimate_splat_cost_command.rs new file mode 100644 index 00000000..ab26ff8a --- /dev/null +++ b/crates/artcraftx/src/commands/cost_estimate/estimate_splat_cost_command.rs @@ -0,0 +1,47 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrError; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; +use artcraft_client::api_defs::omni_gen::cost_response::omni_gen_splat_cost_response::OmniGenSplatCostResponse; +use artcraft_client::endpoints::omni_gen::cost::splat::omni_gen_splat_cost::{omni_gen_splat_cost, OmniGenSplatCostArgs}; +use log::debug; +use serde_derive::Serialize; + +impl SerializeMarker for OmniGenSplatCostResponse {} + +#[derive(Serialize)] +pub struct EstimateSplatCostError { + pub success: bool, + pub error_message: String, +} + +/// Estimate the cost of a splat generation via the omni cost endpoint. +/// (Migrated from the legacy `/v1/generate/cost_estimate/splat`, which does +/// not know the Marble 1.x models.) +/// Anonymous: no credentials are needed for a baseline estimate. +#[tauri::command] +pub async fn estimate_splat_cost_command( + request: OmniGenSplatCostAndGenerateRequest, +) -> ResponseOrError { + debug!("estimate_splat_cost_command called"); + + let result = omni_gen_splat_cost(OmniGenSplatCostArgs { + api_host: &ApiHost::Storyteller, + api_or_web_creds: None, + request: &request, + }).await; + + match result { + Ok(response) => Ok(response.into()), + Err(err) => Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, + error_message: None, + error_type: None, + error_details: Some(EstimateSplatCostError { + success: false, + error_message: err.to_string(), + }), + }), + } +} diff --git a/crates/artcraftx/src/commands/cost_estimate/estimate_video_cost_command.rs b/crates/artcraftx/src/commands/cost_estimate/estimate_video_cost_command.rs new file mode 100644 index 00000000..59a35767 --- /dev/null +++ b/crates/artcraftx/src/commands/cost_estimate/estimate_video_cost_command.rs @@ -0,0 +1,40 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrError; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use artcraft_client::api_defs::generate::cost_estimate::estimate_video_cost::{ + EstimateVideoCostError, EstimateVideoCostErrorType, EstimateVideoCostRequest, + EstimateVideoCostResponse, +}; +use artcraft_client::endpoints::generate::cost_estimate::video::estimate_video_cost::estimate_video_cost; +use log::debug; + +impl SerializeMarker for EstimateVideoCostResponse {} + +#[tauri::command] +pub async fn estimate_video_cost_command( + request: EstimateVideoCostRequest, +) -> ResponseOrError { + debug!("estimate_video_cost_command called: {:?}", request); + + let result = estimate_video_cost( + &ApiHost::Storyteller, + None, // Credentials are not required for this endpoint. + request, + ) + .await; + + match result { + Ok(response) => Ok(response.into()), + Err(err) => Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, + error_message: None, + error_type: None, + error_details: Some(EstimateVideoCostError { + success: false, + error_type: EstimateVideoCostErrorType::InvalidInput, + error_message: err.to_string(), + }), + }), + } +} diff --git a/crates/artcraftx/src/commands/cost_estimate/mod.rs b/crates/artcraftx/src/commands/cost_estimate/mod.rs new file mode 100644 index 00000000..a093ad41 --- /dev/null +++ b/crates/artcraftx/src/commands/cost_estimate/mod.rs @@ -0,0 +1,5 @@ +pub mod estimate_audio_cost_command; +pub mod estimate_image_cost_command; +pub mod estimate_mesh_cost_command; +pub mod estimate_splat_cost_command; +pub mod estimate_video_cost_command; diff --git a/crates/artcraftx/src/commands/credentials/add_api_credential_command.rs b/crates/artcraftx/src/commands/credentials/add_api_credential_command.rs new file mode 100644 index 00000000..3f9a7e56 --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/add_api_credential_command.rs @@ -0,0 +1,66 @@ +use crate::commands::credentials::credential_payload::CredentialPayload; +use crate::credentials::api_key_credential::ApiKeyCredential; +use crate::credentials::auth_credential::{AuthCredential, CredentialSecret}; +use core_types::enums::generation_source::{CredentialKind, GenerationSource}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +#[derive(Serialize)] +pub struct AddApiCredentialResponse { + pub credential: CredentialPayload, +} + +/// Create a new API-key credential file for a service. +/// +/// Files follow the naming scheme `{service}.toml`, `{service}_2.toml`, ... +/// Multiple credentials per service are allowed. +#[tauri::command] +pub async fn add_api_credential_command( + app_data_root: State<'_, AppDataRoot>, + service: GenerationSource, + api_key: String, + name: Option, +) -> Result { + info!("add_api_credential_command called for service: {}", service); + + if service.kind() != CredentialKind::ApiKey { + let message = format!("Service {} is not an API key service", service); + error!("{}", message); + return Err(message); + } + + let api_key = api_key.trim().to_string(); + if api_key.is_empty() { + return Err("API key must not be empty".to_string()); + } + + let creds_dir = app_data_root.credentials_dir(); + let source_path = creds_dir.next_available_credential_path(service); + + let credential = AuthCredential { + id: creds_dir.generate_unique_credential_id(), + service, + name: normalize_name(name), + secret: CredentialSecret::ApiKey(ApiKeyCredential::new(api_key)), + user_info: None, + source_path, + }; + + creds_dir + .save_credential(&credential) + .map_err(|err| { + error!("Error saving credential: {}", err); + format!("Error saving credential: {}", err) + })?; + + Ok(AddApiCredentialResponse { + credential: CredentialPayload::from_auth_credential(&credential), + }) +} + +fn normalize_name(name: Option) -> Option { + name.map(|value| value.trim().to_string()) + .filter(|value| !value.is_empty()) +} diff --git a/crates/artcraftx/src/commands/credentials/add_web_credential_command.rs b/crates/artcraftx/src/commands/credentials/add_web_credential_command.rs new file mode 100644 index 00000000..8fb9181f --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/add_web_credential_command.rs @@ -0,0 +1,270 @@ +use crate::commands::credentials::credential_payload::CredentialPayload; +use crate::credentials::cookie_credential::CookieCredential; +use crate::credentials::auth_credential::{AuthCredential, CredentialSecret}; +use core_types::enums::generation_source::{CredentialKind, GenerationSource}; +use crate::credentials::credential_user_info::CredentialUserInfo; +use crate::credentials::service_cookie_origin::cookie_origin_for_service; +use crate::error::artcraftx_error::ArtcraftXError; +use cookie_store_wrapper::cookie_store::CookieStore; +use crate::credentials::cookie_credential_grok_extra_pieces::{CookieCredentialGrokExtraPieces, GrokStatsigCapture}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::app_credentials_dir::AppCredentialsDir; +use chrono::Utc; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +/// The captured result of a web login, ready to persist. +pub struct WebCredentialSave { + pub service: GenerationSource, + pub cookies: CookieStore, + pub maybe_user_info: Option, + /// Preemptively captured statsig (Grok only; `None` for other sites). + pub maybe_statsig: Option, + /// The User-Agent the capturing webview presented, when the site pins one. + /// Bot-protection cookies are bound to it; see `CookieCredential::user_agent`. + pub maybe_user_agent: Option, + /// An existing credential to refresh in place (a re-login). When it still + /// exists, exactly that file is rewritten; when it's gone, a new one is + /// created. `None` upserts the service's managed credential instead. + pub maybe_target_credential_id: Option, +} + +/// Save a web-login (cookie) credential to the credentials directory. +/// +/// With a target credential id (a re-login), that exact credential is +/// rewritten if it still exists, keeping its id, label, and file. Otherwise +/// this upserts by service: if a managed cookie credential for `service` +/// already exists, its file (and label) are reused and the cookies refreshed; +/// else a new `{service}.toml` file is created. This keeps the login flow +/// from piling up a new file on every re-login while still letting users +/// hand-maintain multiple accounts. +/// +/// Fresh cookies are a fresh session, so any "needs re-login" mark is cleared. +pub fn save_web_credential( + creds_dir: &AppCredentialsDir, + save: WebCredentialSave, +) -> Result { + let all_credentials = creds_dir.load_credentials()?; + + let targeted = save.maybe_target_credential_id.as_deref().and_then(|target_id| { + let found = all_credentials.iter().find(|credential| { + credential.id.as_str() == target_id + && credential.service == save.service + && credential.kind() == CredentialKind::Cookies + }); + if found.is_none() { + info!("Re-login target credential {} no longer exists; saving a new credential instead", target_id); + } + found.cloned() + }); + + let existing = targeted.or_else(|| { + all_credentials.into_iter().find(|credential| { + credential.service == save.service && credential.kind() == CredentialKind::Cookies + }) + }); + + let now = Utc::now(); + + // A fresh capture stamps fetched/expiry times; without one, preserve whatever + // the existing credential already had. + let grok_data = match save.maybe_statsig { + Some(capture) => Some(CookieCredentialGrokExtraPieces::fresh(capture, now)), + None => existing + .as_ref() + .and_then(|credential| credential.cookies()) + .and_then(|cookie| cookie.grok_data.clone()), + }; + + let cookie = CookieCredential { + updated_at: Some(now), + failed_at: None, + succeeded_at: None, + relogin_required_since: None, + user_agent: save.maybe_user_agent, + grok_data, + cookies: save.cookies, + }; + + let credential = match existing { + Some(existing) => AuthCredential { + id: existing.id, + service: existing.service, + name: existing.name, + secret: CredentialSecret::Cookies(cookie), + user_info: merge_user_info(existing.user_info, save.maybe_user_info), + source_path: existing.source_path, + }, + None => AuthCredential { + id: creds_dir.generate_unique_credential_id(), + service: save.service, + name: None, + secret: CredentialSecret::Cookies(cookie), + user_info: save.maybe_user_info, + source_path: creds_dir.next_available_credential_path(save.service), + }, + }; + + creds_dir.save_credential(&credential)?; + Ok(credential) +} + +/// Prefer freshly detected identity fields, falling back to whatever the +/// existing file already recorded, so a login that can't read (say) an email +/// doesn't wipe one the user previously had. +fn merge_user_info( + existing: Option, + fresh: Option, +) -> Option { + match (existing, fresh) { + (None, fresh) => fresh, + (existing, None) => existing, + (Some(existing), Some(fresh)) => Some(CredentialUserInfo { + username: fresh.username.or(existing.username), + email: fresh.email.or(existing.email), + }), + } +} + +#[derive(Serialize)] +pub struct AddWebCredentialResponse { + pub credential: CredentialPayload, +} + +/// Manually add a web-login (cookie) credential file for a service, given a +/// full `Cookie:` header. The automated login flow saves via +/// [`save_web_credential`]; this command is the hand-entry path. +#[tauri::command] +pub async fn add_web_credential_command( + app_data_root: State<'_, AppDataRoot>, + service: GenerationSource, + cookie_header: String, + name: Option, +) -> Result { + info!("add_web_credential_command called for service: {}", service); + + if service.kind() != CredentialKind::Cookies { + let message = format!("Service {} is not a cookie service", service); + error!("{}", message); + return Err(message); + } + + let cookie_header = cookie_header.trim().to_string(); + if cookie_header.is_empty() { + return Err("Cookie header must not be empty".to_string()); + } + + let Some(cookie_origin) = cookie_origin_for_service(service) else { + let message = format!("Service {} has no cookie origin", service); + error!("{}", message); + return Err(message); + }; + let cookies = CookieStore::from_cookie_header(&cookie_header, &cookie_origin); + if cookies.is_empty() { + return Err("Cookie header contained no name=value cookies".to_string()); + } + + let credential = save_web_credential( + app_data_root.credentials_dir(), + WebCredentialSave { + service, + cookies, + maybe_user_info: None, + maybe_statsig: None, + // Hand-entered cookies came from an unknown browser; record no UA. + maybe_user_agent: None, + maybe_target_credential_id: None, + }, + ).map_err(|err| { + error!("Error saving web credential: {}", err); + format!("Error saving web credential: {}", err) + })?; + + let credential = apply_optional_name(app_data_root.credentials_dir(), credential, name)?; + + Ok(AddWebCredentialResponse { + credential: CredentialPayload::from_auth_credential(&credential), + }) +} + +/// Apply an optional user-supplied label to a just-saved credential. +fn apply_optional_name( + creds_dir: &AppCredentialsDir, + mut credential: AuthCredential, + name: Option, +) -> Result { + let Some(name) = name else { + return Ok(credential); + }; + let name = name.trim().to_string(); + credential.name = if name.is_empty() { None } else { Some(name) }; + creds_dir.save_credential(&credential).map_err(|err| { + error!("Error saving credential label: {}", err); + format!("Error saving credential label: {}", err) + })?; + Ok(credential) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::auth_credential::AuthCredential; + use reqwest::Url; + + const SERVICE: GenerationSource = GenerationSource::HiggsfieldCookies; + + #[test] + fn targeted_relogin_rewrites_that_credential_and_clears_the_mark() { + let (_dir, root) = temp_root(); + let creds_dir = root.credentials_dir(); + let first = save(creds_dir, "__client=first", None); + let second = save(creds_dir, "__client=second", None); + // NB: without a target, a second login upserts the first managed file. + assert_eq!(second.id, first.id); + + let mut expired = creds_dir.find_credential_by_id(first.id.as_str()).unwrap().unwrap(); + expired.name = Some("work".to_string()); + creds_dir.save_credential(&expired).unwrap(); + assert!(expired.mark_relogin_required().unwrap()); + assert!(creds_dir.find_credential_by_id(first.id.as_str()).unwrap().unwrap().needs_relogin()); + + let refreshed = save(creds_dir, "__client=fresh", Some(first.id.as_str())); + assert_eq!(refreshed.id, first.id, "same identity"); + assert_eq!(refreshed.source_path, first.source_path, "same file"); + assert_eq!(refreshed.name.as_deref(), Some("work"), "label kept"); + assert!(!refreshed.needs_relogin(), "fresh session clears the mark"); + assert!(refreshed.cookies().unwrap().cookies.has_cookie("__client")); + assert_eq!(creds_dir.load_credentials().unwrap().len(), 1, "no second file"); + } + + #[test] + fn targeted_relogin_creates_a_new_credential_when_the_target_is_gone() { + let (_dir, root) = temp_root(); + let creds_dir = root.credentials_dir(); + let saved = save(creds_dir, "__client=fresh", Some("credential_deleted_meanwhile")); + assert_ne!(saved.id.as_str(), "credential_deleted_meanwhile"); + assert_eq!(creds_dir.load_credentials().unwrap().len(), 1); + assert!(!saved.needs_relogin()); + } + + // ── Helpers ── + + fn temp_root() -> (tempfile::TempDir, AppDataRoot) { + let dir = tempfile::tempdir().unwrap(); + let root = AppDataRoot::create_existing(dir.path()).unwrap(); + (dir, root) + } + + fn save(creds_dir: &AppCredentialsDir, cookie_header: &str, target: Option<&str>) -> AuthCredential { + let origin = Url::parse("https://higgsfield.ai/").unwrap(); + save_web_credential(creds_dir, WebCredentialSave { + service: SERVICE, + cookies: CookieStore::from_cookie_header(cookie_header, &origin), + maybe_user_info: None, + maybe_statsig: None, + maybe_user_agent: None, + maybe_target_credential_id: target.map(str::to_string), + }).unwrap() + } +} diff --git a/crates/artcraftx/src/commands/credentials/artcraft_login_command.rs b/crates/artcraftx/src/commands/credentials/artcraft_login_command.rs new file mode 100644 index 00000000..cc9d0f3d --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/artcraft_login_command.rs @@ -0,0 +1,202 @@ +use artcraft_client::api_defs::users::login::{LoginErrorType, LoginRequest}; +use artcraft_client::endpoints::users::login::{login, LoginArgs, LoginError}; +use chrono::Utc; +use core_types::enums::generation_source::GenerationSource; +use log::{error, info, warn}; +use serde_derive::Serialize; +use tauri::{AppHandle, State}; + +use crate::commands::credentials::credential_payload::CredentialPayload; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; +use crate::credentials::cookie_credential::CookieCredential; +use crate::credentials::auth_credential::{AuthCredential, CredentialSecret}; +use crate::credentials::service_cookie_origin::cookie_origin_for_service; +use cookie_store_wrapper::cookie_store::CookieStore; +use crate::credentials::credential_user_info::CredentialUserInfo; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::refresh_account_state_event::RefreshAccountStateEvent; +use crate::state::data_dir::app_data_root::AppDataRoot; + +#[derive(Serialize)] +pub struct ArtcraftLoginResponse { + pub credential: CredentialPayload, +} + +/// Error payload surfaced to the frontend when a login fails. +#[derive(Clone, Debug, Serialize)] +pub struct ArtcraftLoginCommandError { + pub error_type: ArtcraftLoginErrorType, + pub message: String, +} + +#[derive(Clone, Copy, Debug, Serialize)] +pub enum ArtcraftLoginErrorType { + /// Invalid username/email or password. + #[serde(rename = "invalid_credentials")] + InvalidCredentials, + /// The account was created without a password (needs a password reset). + #[serde(rename = "account_needs_password")] + AccountNeedsPassword, + /// The API returned a server error. + #[serde(rename = "server_error")] + ServerError, + /// We couldn't reach the API (network problem, local dev server not + /// running, unexpected response). + #[serde(rename = "connection_error")] + ConnectionError, + /// The request was malformed (wrong service, empty fields). + #[serde(rename = "bad_request")] + BadRequest, +} + +/// Log into an ArtCraft account with a username (or email) and password, then +/// store the resulting session as a new credential file. +/// +/// `service` selects the environment: `Artcraft` hits production +/// (`api.storyteller.ai`); `ArtcraftLocal` hits a local dev server. Every +/// successful login creates a NEW credential file, so users can keep an +/// unlimited number of accounts for either environment. +#[tauri::command] +pub async fn artcraft_login_command( + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + service: GenerationSource, + username_or_email: String, + password: String, +) -> Result { + info!("artcraft_login_command called for service: {}", service); + + let is_password_login_service = matches!( + service, + GenerationSource::Artcraft | GenerationSource::ArtcraftLocal, + ); + + let maybe_api_host = maybe_artcraft_api_host_for_service(service) + .filter(|_| is_password_login_service); + + let Some(api_host) = maybe_api_host else { + let message = format!("Service {} does not support password login", service); + error!("{}", message); + return Err(ArtcraftLoginCommandError { + error_type: ArtcraftLoginErrorType::BadRequest, + message, + }); + }; + + let username_or_email = username_or_email.trim().to_string(); + if username_or_email.is_empty() || password.is_empty() { + return Err(ArtcraftLoginCommandError { + error_type: ArtcraftLoginErrorType::BadRequest, + message: "Enter a username (or email) and password".to_string(), + }); + } + + let request = LoginRequest { + username_or_email: username_or_email.clone(), + password, + }; + + let response = login(LoginArgs { + api_host: &api_host, + request: &request, + }).await.map_err(|err| { + warn!("ArtCraft login failed for service {}: {}", service, err); + login_error_to_command_error(err) + })?; + + let credential = save_session_credential( + &app_data_root, + service, + &response.signed_session, + username_or_email, + )?; + + RefreshAccountStateEvent { + provider: Some(GenerationSource::Artcraft), + }.send_infallible(&app); + + Ok(ArtcraftLoginResponse { + credential: CredentialPayload::from_auth_credential(&credential), + }) +} + +/// Persist the signed session as a NEW cookie credential file (never upserts, +/// so each login adds another account). +fn save_session_credential( + app_data_root: &AppDataRoot, + service: GenerationSource, + signed_session: &str, + username_or_email: String, +) -> Result { + let now = Utc::now(); + + let Some(cookie_origin) = cookie_origin_for_service(service) else { + return Err(ArtcraftLoginCommandError { + error_type: ArtcraftLoginErrorType::BadRequest, + message: format!("Service {} has no cookie origin", service), + }); + }; + let cookie = CookieCredential { + updated_at: Some(now), + failed_at: None, + succeeded_at: Some(now), + relogin_required_since: None, + user_agent: None, + grok_data: None, + cookies: CookieStore::from_cookie_header( + &format!("session={}", signed_session), &cookie_origin), + }; + + let user_info = if username_or_email.contains('@') { + CredentialUserInfo { + username: None, + email: Some(username_or_email), + } + } else { + CredentialUserInfo { + username: Some(username_or_email), + email: None, + } + }; + + let creds_dir = app_data_root.credentials_dir(); + + let credential = AuthCredential { + id: creds_dir.generate_unique_credential_id(), + service, + name: None, + secret: CredentialSecret::Cookies(cookie), + user_info: Some(user_info), + source_path: creds_dir.next_available_credential_path(service), + }; + + creds_dir.save_credential(&credential).map_err(|err| { + error!("Error saving login credential: {}", err); + ArtcraftLoginCommandError { + error_type: ArtcraftLoginErrorType::ServerError, + message: format!("Login succeeded but saving the credential failed: {}", err), + } + })?; + + Ok(credential) +} + +fn login_error_to_command_error(error: LoginError) -> ArtcraftLoginCommandError { + match error { + LoginError::Login(response) => { + let error_type = match response.error_type { + LoginErrorType::InvalidCredentials => ArtcraftLoginErrorType::InvalidCredentials, + LoginErrorType::AccountNeedsPassword => ArtcraftLoginErrorType::AccountNeedsPassword, + LoginErrorType::ServerError => ArtcraftLoginErrorType::ServerError, + }; + ArtcraftLoginCommandError { + error_type, + message: response.error_message, + } + } + LoginError::Storyteller(err) => ArtcraftLoginCommandError { + error_type: ArtcraftLoginErrorType::ConnectionError, + message: format!("Could not reach the server: {}", err), + }, + } +} diff --git a/crates/artcraftx/src/commands/credentials/credential_payload.rs b/crates/artcraftx/src/commands/credentials/credential_payload.rs new file mode 100644 index 00000000..444bfd71 --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/credential_payload.rs @@ -0,0 +1,56 @@ +use crate::credentials::auth_credential::AuthCredential; +use core_types::enums::generation_source::{CredentialKind, GenerationSource}; +use chrono::{DateTime, Utc}; +use serde_derive::Serialize; +use core_types::identifiers::credential_id::CredentialId; + +/// Frontend-facing view of a stored credential. +#[derive(Serialize)] +pub struct CredentialPayload { + /// The credential's stable identity (`credential_{entropy}`). Hidden from + /// users, but the effective primary identifier — pass this back to + /// edit/delete and use it to reference the credential anywhere. + pub id: CredentialId, + /// The credential's file name within the credentials directory + /// (e.g. `fal_api_2.toml`). Informational; may change if the user renames + /// the file. + pub file_name: String, + pub service: GenerationSource, + pub kind: CredentialKind, + /// Optional user-facing label. Empty by default. + pub name: Option, + /// Full API key (local app; the user owns this file). + pub api_key: Option, + /// First few characters of the API key, for display. + pub api_key_preview: Option, + pub username: Option, + pub email: Option, + pub updated_at: Option>, + pub failed_at: Option>, + pub succeeded_at: Option>, + /// Set while the provider has rejected this session and the user must log + /// in again (see `CookieCredential::relogin_required_since`). + pub relogin_required_since: Option>, +} + +impl CredentialPayload { + pub fn from_auth_credential(credential: &AuthCredential) -> Self { + let api_key = credential.api_key(); + let cookie = credential.cookies(); + Self { + id: credential.id.clone(), + file_name: credential.file_name(), + service: credential.service, + kind: credential.kind(), + name: credential.name.clone(), + api_key: api_key.map(|key| key.api_key.clone()), + api_key_preview: api_key.map(|key| key.printable_partial_prefix.clone()), + username: credential.user_info.as_ref().and_then(|info| info.username.clone()), + email: credential.user_info.as_ref().and_then(|info| info.email.clone()), + updated_at: cookie.and_then(|c| c.updated_at), + failed_at: api_key.and_then(|key| key.failed_at).or(cookie.and_then(|c| c.failed_at)), + succeeded_at: api_key.and_then(|key| key.succeeded_at).or(cookie.and_then(|c| c.succeeded_at)), + relogin_required_since: cookie.and_then(|c| c.relogin_required_since), + } + } +} diff --git a/crates/artcraftx/src/commands/credentials/delete_credentials_command.rs b/crates/artcraftx/src/commands/credentials/delete_credentials_command.rs new file mode 100644 index 00000000..b9585c17 --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/delete_credentials_command.rs @@ -0,0 +1,34 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::{error, info}; +use tauri::State; + +/// Delete a credential, identified by its stable id. The frontend asks +/// the user for confirmation before calling this. +#[tauri::command] +pub async fn delete_credentials_command( + app_data_root: State<'_, AppDataRoot>, + credential_id: String, +) -> Result<(), String> { + info!("delete_credentials_command called for: {}", credential_id); + + let creds_dir = app_data_root.credentials_dir(); + + let credential = creds_dir + .find_credential_by_id(&credential_id) + .map_err(|err| { + error!("Error looking up credential {}: {}", credential_id, err); + format!("Error looking up credential {}: {}", credential_id, err) + })? + .ok_or_else(|| { + let message = format!("No credential found for id {}", credential_id); + error!("{}", message); + message + })?; + + creds_dir + .delete_credential_file(&credential.file_name()) + .map_err(|err| { + error!("Error deleting credential {}: {}", credential_id, err); + format!("Error deleting credential {}: {}", credential_id, err) + }) +} diff --git a/crates/artcraftx/src/commands/credentials/edit_api_credential_command.rs b/crates/artcraftx/src/commands/credentials/edit_api_credential_command.rs new file mode 100644 index 00000000..d743b38e --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/edit_api_credential_command.rs @@ -0,0 +1,69 @@ +use crate::commands::credentials::credential_payload::CredentialPayload; +use crate::credentials::api_key_credential::ApiKeyCredential; +use crate::credentials::auth_credential::CredentialSecret; +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +#[derive(Serialize)] +pub struct EditApiCredentialResponse { + pub credential: CredentialPayload, +} + +/// Edit an existing API-key credential, identified by its stable id. +/// +/// `api_key` replaces the key when provided (non-empty). `name` replaces the +/// label; an empty string clears it. Omitted fields are left unchanged. +#[tauri::command] +pub async fn edit_api_credential_command( + app_data_root: State<'_, AppDataRoot>, + credential_id: String, + api_key: Option, + name: Option, +) -> Result { + info!("edit_api_credential_command called for: {}", credential_id); + + let creds_dir = app_data_root.credentials_dir(); + + let mut credential = creds_dir + .find_credential_by_id(&credential_id) + .map_err(|err| { + error!("Error looking up credential {}: {}", credential_id, err); + format!("Error looking up credential {}: {}", credential_id, err) + })? + .ok_or_else(|| { + let message = format!("No credential found for id {}", credential_id); + error!("{}", message); + message + })?; + + let CredentialSecret::ApiKey(existing_key) = &credential.secret else { + let message = format!("AuthCredential {} is not an API key credential", credential_id); + error!("{}", message); + return Err(message); + }; + + if let Some(new_api_key) = api_key { + let new_api_key = new_api_key.trim().to_string(); + if !new_api_key.is_empty() && new_api_key != existing_key.api_key { + credential.secret = CredentialSecret::ApiKey(ApiKeyCredential::new(new_api_key)); + } + } + + if let Some(new_name) = name { + let new_name = new_name.trim().to_string(); + credential.name = if new_name.is_empty() { None } else { Some(new_name) }; + } + + creds_dir + .save_credential(&credential) + .map_err(|err| { + error!("Error saving credential {}: {}", credential_id, err); + format!("Error saving credential {}: {}", credential_id, err) + })?; + + Ok(EditApiCredentialResponse { + credential: CredentialPayload::from_auth_credential(&credential), + }) +} diff --git a/crates/artcraftx/src/commands/credentials/edit_web_credential_command.rs b/crates/artcraftx/src/commands/credentials/edit_web_credential_command.rs new file mode 100644 index 00000000..e6139b4a --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/edit_web_credential_command.rs @@ -0,0 +1,97 @@ +use crate::commands::credentials::credential_payload::CredentialPayload; +use crate::credentials::cookie_credential::CookieCredential; +use crate::credentials::auth_credential::CredentialSecret; +use crate::credentials::service_cookie_origin::cookie_origin_for_service; +use crate::state::data_dir::app_data_root::AppDataRoot; +use cookie_store_wrapper::cookie_store::CookieStore; +use chrono::Utc; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +#[derive(Serialize)] +pub struct EditWebCredentialResponse { + pub credential: CredentialPayload, +} + +/// Edit an existing web-login (cookie) credential, identified by its stable +/// id. +/// +/// `name` replaces the label; an empty string clears it. `cookie_header` +/// replaces the cookies when provided (non-empty). Omitted fields are left +/// unchanged. The common case is simply renaming the credential. +#[tauri::command] +pub async fn edit_web_credential_command( + app_data_root: State<'_, AppDataRoot>, + credential_id: String, + name: Option, + cookie_header: Option, +) -> Result { + info!("edit_web_credential_command called for: {}", credential_id); + + let creds_dir = app_data_root.credentials_dir(); + + let mut credential = creds_dir + .find_credential_by_id(&credential_id) + .map_err(|err| { + error!("Error looking up credential {}: {}", credential_id, err); + format!("Error looking up credential {}: {}", credential_id, err) + })? + .ok_or_else(|| { + let message = format!("No credential found for id {}", credential_id); + error!("{}", message); + message + })?; + + let CredentialSecret::Cookies(existing_cookie) = &credential.secret else { + let message = format!("AuthCredential {} is not a cookie credential", credential_id); + error!("{}", message); + return Err(message); + }; + let existing_cookies = existing_cookie.cookies.clone(); + let existing_failed_at = existing_cookie.failed_at; + let existing_succeeded_at = existing_cookie.succeeded_at; + let existing_grok_data = existing_cookie.grok_data.clone(); + + if let Some(new_cookie_header) = cookie_header { + let new_cookie_header = new_cookie_header.trim().to_string(); + if !new_cookie_header.is_empty() { + let Some(cookie_origin) = cookie_origin_for_service(credential.service) else { + let message = format!("Service {} has no cookie origin", credential.service); + error!("{}", message); + return Err(message); + }; + let new_cookies = CookieStore::from_cookie_header(&new_cookie_header, &cookie_origin); + if new_cookies != existing_cookies { + credential.secret = CredentialSecret::Cookies(CookieCredential { + updated_at: Some(Utc::now()), + failed_at: existing_failed_at, + succeeded_at: existing_succeeded_at, + // New cookies are a new session; the old one's death no longer applies. + relogin_required_since: None, + // Hand-pasted cookies came from an unknown browser; drop the + // recorded UA rather than claim one that may no longer match. + user_agent: None, + grok_data: existing_grok_data, + cookies: new_cookies, + }); + } + } + } + + if let Some(new_name) = name { + let new_name = new_name.trim().to_string(); + credential.name = if new_name.is_empty() { None } else { Some(new_name) }; + } + + creds_dir + .save_credential(&credential) + .map_err(|err| { + error!("Error saving credential {}: {}", credential_id, err); + format!("Error saving credential {}: {}", credential_id, err) + })?; + + Ok(EditWebCredentialResponse { + credential: CredentialPayload::from_auth_credential(&credential), + }) +} diff --git a/crates/artcraftx/src/commands/credentials/list_credentials_command.rs b/crates/artcraftx/src/commands/credentials/list_credentials_command.rs new file mode 100644 index 00000000..e75855e9 --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/list_credentials_command.rs @@ -0,0 +1,32 @@ +use crate::commands::credentials::credential_payload::CredentialPayload; +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +#[derive(Serialize)] +pub struct ListCredentialsResponse { + pub credentials: Vec, +} + +#[tauri::command] +pub async fn list_credentials_command( + app_data_root: State<'_, AppDataRoot>, +) -> Result { + info!("list_credentials_command called"); + + let credentials = app_data_root + .credentials_dir() + .load_credentials() + .map_err(|err| { + error!("Error listing credentials: {}", err); + format!("Error listing credentials: {}", err) + })?; + + Ok(ListCredentialsResponse { + credentials: credentials + .iter() + .map(CredentialPayload::from_auth_credential) + .collect(), + }) +} diff --git a/crates/artcraftx/src/commands/credentials/mod.rs b/crates/artcraftx/src/commands/credentials/mod.rs new file mode 100644 index 00000000..e0524d82 --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/mod.rs @@ -0,0 +1,10 @@ +pub mod add_api_credential_command; +pub mod add_web_credential_command; +pub mod artcraft_login_command; +pub mod credential_payload; +pub mod delete_credentials_command; +pub mod edit_api_credential_command; +pub mod edit_web_credential_command; +pub mod list_credentials_command; +pub mod open_web_login_command; +pub mod refresh_grok_statsig_command; diff --git a/crates/artcraftx/src/commands/credentials/open_web_login_command.rs b/crates/artcraftx/src/commands/credentials/open_web_login_command.rs new file mode 100644 index 00000000..37b6faaa --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/open_web_login_command.rs @@ -0,0 +1,32 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::open_login_window::open_login_window; +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::{error, info}; +use tauri::{AppHandle, State}; + +/// Open a web-login window for a site (e.g. the user clicked "Artcraft"). +/// +/// Opens a fresh, cookie-cleared webview and drives the login flow; a +/// background thread captures the resulting cookies into the credentials +/// directory once the user signs in. +/// +/// `credential_id` targets an existing credential to refresh in place (a +/// re-login after the session expired); it is created anew only if that +/// file is gone by the time login completes. Without it, the login upserts +/// the service's managed credential as before. +#[tauri::command] +pub async fn open_web_login_command( + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + website: LoginWebsite, + credential_id: Option, +) -> Result<(), String> { + info!("open_web_login_command called for website: {} (target credential: {:?})", website, credential_id); + + open_login_window(&app, &app_data_root, website, credential_id) + .await + .map_err(|err| { + error!("Error opening {} login window: {:?}", website, err); + format!("Error opening {} login window: {}", website, err) + }) +} diff --git a/crates/artcraftx/src/commands/credentials/refresh_grok_statsig_command.rs b/crates/artcraftx/src/commands/credentials/refresh_grok_statsig_command.rs new file mode 100644 index 00000000..2efd873c --- /dev/null +++ b/crates/artcraftx/src/commands/credentials/refresh_grok_statsig_command.rs @@ -0,0 +1,23 @@ +use crate::services::grok::util::refresh_grok_statsig::refresh_grok_statsig_if_stale; +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::info; +use tauri::{AppHandle, State}; + +/// Refresh the Grok statsig material if it's missing or stale. +/// +/// Best-effort and non-blocking: it spawns the refresh (which opens a hidden +/// grok.com webview to re-capture) and returns immediately, so callers — the +/// credentials page on mount, say — never wait on it. A no-op when there's no +/// Grok credential or the material is still fresh. +#[tauri::command] +pub async fn refresh_grok_statsig_command( + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, +) -> Result<(), String> { + info!("refresh_grok_statsig_command called"); + // Returns as soon as the (hidden) window is built and the poll loop spawned; + // the actual capture happens in the background. A single-flight guard inside + // makes repeat/concurrent calls (e.g. a double-mounting page) safe. + refresh_grok_statsig_if_stale(&app, app_data_root.inner()).await; + Ok(()) +} diff --git a/crates/artcraftx/src/commands/download/download_directory_reveal_command.rs b/crates/artcraftx/src/commands/download/download_directory_reveal_command.rs new file mode 100644 index 00000000..3c5a8bbd --- /dev/null +++ b/crates/artcraftx/src/commands/download/download_directory_reveal_command.rs @@ -0,0 +1,68 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use anyhow::anyhow; +use log::info; +use serde_derive::Serialize; +use tauri::{AppHandle, State}; +use tauri_plugin_opener::OpenerExt; + +#[derive(Serialize)] +pub struct DownloadDirectoryRevealSuccessResponse { +} + +impl SerializeMarker for DownloadDirectoryRevealSuccessResponse {} + +#[tauri::command] +pub async fn download_directory_reveal_command( + app: AppHandle, + app_prefs: State<'_, AppPreferencesManager>, + app_data_root: State<'_, AppDataRoot>, +) -> ResponseOrErrorMessage { + + info!("download_directory_reveal_command called"); + + let result = handle_request( + &app, + &app_prefs, + &app_data_root, + ).await; + + if let Err(err) = result { + format!("Error revealing download dir: {:?}", err); + return Err("error revealing download dir".into()) + } + + Ok(DownloadDirectoryRevealSuccessResponse {}.into()) +} + + +pub async fn handle_request( + app: &AppHandle, + app_prefs: &AppPreferencesManager, + app_data_root: &AppDataRoot, +) -> Result<(), ArtcraftXError> { + + let app_prefs = app_prefs.get()?; + + let download_directory = app_prefs + .downloads + .preferred_download_directory + .download_directory(app_data_root); + + info!("Opening download directory: {:?}", download_directory); + + // NB: `open_path` opens the directory ITSELF in the system file manager; + // `reveal_item_in_dir` would open the PARENT with the directory selected. + let download_directory = download_directory + .to_str() + .ok_or_else(|| anyhow!("Download directory path isn't valid UTF-8: {:?}", download_directory))? + .to_string(); + + app.opener().open_path(download_directory, None::<&str>) + .map_err(|err| anyhow!("Failed to open directory: {:?}", err))?; + + Ok(()) +} diff --git a/crates/artcraftx/src/commands/download/download_media_file_command.rs b/crates/artcraftx/src/commands/download/download_media_file_command.rs new file mode 100644 index 00000000..c849bdba --- /dev/null +++ b/crates/artcraftx/src/commands/download/download_media_file_command.rs @@ -0,0 +1,95 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::error::artcraftx_error::ArtcraftXError; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrErrorType; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::download::download_url_to_user_download_dir::download_url_to_user_download_dir; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use tauri::{AppHandle, State}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; + +#[derive(Deserialize, Debug)] +pub struct DownloadMediaFileRequest { + pub media_token: MediaFileToken, +} + +#[derive(Serialize)] +pub struct DownloadMediaFileSuccessResponse { +} + +impl SerializeMarker for DownloadMediaFileSuccessResponse {} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum DownloadMediaFileErrorType { + FilesystemError, + NetworkError, + UnknownError, +} + + +#[tauri::command] +pub async fn download_media_file_command( + request: DownloadMediaFileRequest, + app: AppHandle, + app_prefs: State<'_, AppPreferencesManager>, + app_data_root: State<'_, AppDataRoot>, +) -> ResponseOrErrorType { + + info!("download_media_file_command called"); + + info!("request: {:?}", request); + + let result = handle_request( + request, + &app, + &app_prefs, + &app_data_root, + ).await; + + if let Err(err) = result { + error!("Error downloading media: {:?}", err); + // TODO: This error is semantically incorrect - just trying to get the code done + return Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::ServerError, + error_message: Some("error downloading file".to_string()), + error_type: Some(DownloadMediaFileErrorType::UnknownError), + error_details: None, + }); + } + + Ok(DownloadMediaFileSuccessResponse {}.into()) +} + + +pub async fn handle_request( + request: DownloadMediaFileRequest, + _app: &AppHandle, + app_prefs: &AppPreferencesManager, + app_data_root: &AppDataRoot +) -> Result<(), ArtcraftXError> { + + let app_prefs = app_prefs.get()?; + + // TODO: Api should return the extension and suggested filename so we can better construct something. + let media_file = get_media_file( + &ApiHost::Storyteller, + &request.media_token, + ).await?; + + let asset_url = media_file.media_file.media_links.cdn_url; + + let download_path = download_url_to_user_download_dir( + &asset_url, + app_data_root, + &app_prefs + ).await?; + + info!("downloaded to: {:?}", download_path); + + Ok(()) +} diff --git a/crates/artcraftx/src/commands/download/download_url_command.rs b/crates/artcraftx/src/commands/download/download_url_command.rs new file mode 100644 index 00000000..239e80ea --- /dev/null +++ b/crates/artcraftx/src/commands/download/download_url_command.rs @@ -0,0 +1,111 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::ResponseOrErrorType; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::warning_events::flash_file_download_error_event::{FlashFileDownloadErrorType, FlashFileDownloadErrorEvent}; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::download::download_url_to_user_download_dir::download_url_to_user_download_dir; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use tauri::{AppHandle, State}; +use url::Url; + +#[derive(Deserialize, Debug)] +pub struct DownloadUrlRequest { + pub url: Url, +} + +#[derive(Serialize)] +pub struct DownloadUrlSuccessResponse { +} + +impl SerializeMarker for DownloadUrlSuccessResponse {} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum DownloadUrlErrorType { + FilesystemError, + NetworkError, + UnknownError, +} + + +#[tauri::command] +pub async fn download_url_command( + request: DownloadUrlRequest, + app: AppHandle, + app_prefs: State<'_, AppPreferencesManager>, + app_data_root: State<'_, AppDataRoot>, +) -> ResponseOrErrorType { + + info!("download_url_command called"); + + info!("request: {:?}", request); + + let result = handle_request( + request, + &app, + &app_prefs, + &app_data_root, + ).await; + + if let Err(err) = result { + // Already on disk = success. Download filenames derive from the content + // hash, so the existing file IS the requested file. This also happens + // routinely now that completed ArtCraft jobs are auto-downloaded by the + // backend polling thread while the frontend auto-save races it. + if let ArtcraftXError::CannotDownloadFilePathAlreadyExists { path } = &err { + info!("File already downloaded (treating as success): {:?}", path); + return Ok(DownloadUrlSuccessResponse {}.into()); + } + + error!("Error downloading media: {:?}", err); + + let endpoint_message = "unknown error when downloading file"; + let error_type = DownloadUrlErrorType::UnknownError; + + let flash_error_type = FlashFileDownloadErrorType::UnknownError; + let flash_filename = None; + let flash_message = Some("Failed to download file".to_string()); + + let event = FlashFileDownloadErrorEvent { + filename: flash_filename, + message: flash_message, + error_type: flash_error_type, + }; + + event.send_infallible(&app); + + return Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::ServerError, + error_message: Some(endpoint_message.to_string()), + error_type: Some(error_type), + error_details: None, + }); + } + + Ok(DownloadUrlSuccessResponse {}.into()) +} + + +pub async fn handle_request( + request: DownloadUrlRequest, + _app: &AppHandle, + app_prefs: &AppPreferencesManager, + app_data_root: &AppDataRoot +) -> Result<(), ArtcraftXError> { + + let app_prefs = app_prefs.get()?; + + let download_path = download_url_to_user_download_dir( + &request.url, + app_data_root, + &app_prefs + ).await?; + + info!("downloaded to: {:?}", download_path); + + Ok(()) +} diff --git a/crates/artcraftx/src/commands/download/mod.rs b/crates/artcraftx/src/commands/download/mod.rs new file mode 100644 index 00000000..20ef1334 --- /dev/null +++ b/crates/artcraftx/src/commands/download/mod.rs @@ -0,0 +1,4 @@ +pub mod download_directory_reveal_command; +pub mod download_media_file_command; +pub mod download_url_command; +pub mod open_local_file_command; diff --git a/crates/artcraftx/src/commands/download/open_local_file_command.rs b/crates/artcraftx/src/commands/download/open_local_file_command.rs new file mode 100644 index 00000000..1e89ad48 --- /dev/null +++ b/crates/artcraftx/src/commands/download/open_local_file_command.rs @@ -0,0 +1,54 @@ +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use std::path::Path; +use tauri::AppHandle; +use tauri_plugin_opener::OpenerExt; + +/// How to open a local file. +#[derive(Copy, Clone, Debug, Eq, PartialEq, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum OpenLocalFileMode { + /// Open the file with the OS default application (image viewer, video player, ...). + Open, + /// Open the containing directory in the OS file manager (Finder, Explorer, ...) + /// with the file selected. + Reveal, +} + +#[derive(Serialize)] +pub struct OpenLocalFileSuccessResponse {} + +impl SerializeMarker for OpenLocalFileSuccessResponse {} + +/// Open a file that a completed task downloaded (see the task's +/// `on_complete_first_file_location`) natively, either in its default viewer +/// or revealed in the file manager. The file must exist. +#[tauri::command] +pub async fn open_local_file_command( + app: AppHandle, + path: String, + mode: OpenLocalFileMode, +) -> ResponseOrErrorMessage { + info!("open_local_file_command called: mode={:?} path={:?}", mode, path); + + let file = Path::new(&path); + + if !file.is_file() { + error!("open_local_file_command: not an existing file: {:?}", path); + return Err("file not found".into()); + } + + let result = match mode { + OpenLocalFileMode::Open => app.opener().open_path(&path, None::<&str>), + OpenLocalFileMode::Reveal => app.opener().reveal_item_in_dir(file), + }; + + if let Err(err) = result { + error!("open_local_file_command failed ({:?}) for {:?}: {:?}", mode, path, err); + return Err("could not open file".into()); + } + + Ok(OpenLocalFileSuccessResponse {}.into()) +} diff --git a/crates/artcraftx/src/commands/generate/common/generation_credential.rs b/crates/artcraftx/src/commands/generate/common/generation_credential.rs new file mode 100644 index 00000000..1d2c789b --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/generation_credential.rs @@ -0,0 +1,58 @@ +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + +use crate::commands::generate::generate_error::{CredentialProblemReason, GenerateError}; +use crate::credentials::auth_credential::AuthCredential; +use crate::state::data_dir::app_data_root::AppDataRoot; + +/// Resolve the stored credential a generation request names via +/// `credential_id`. Every failure is a [`GenerateError::CredentialProblem`], +/// which flashes the frontend's dismissable credential-error modal. +pub fn resolve_generation_credential( + maybe_credential_id: Option<&str>, + app_data_root: &AppDataRoot, +) -> Result { + let credential_id = maybe_credential_id + .filter(|id| !id.trim().is_empty()) + .ok_or(GenerateError::CredentialProblem( + CredentialProblemReason::NoCredentialSupplied, + ))?; + + let maybe_credential = app_data_root + .credentials_dir() + .find_credential_by_id(credential_id) + .map_err(GenerateError::from)?; + + maybe_credential.ok_or_else(|| { + GenerateError::CredentialProblem(CredentialProblemReason::CredentialNotFound { + credential_id: credential_id.to_string(), + }) + }) +} + +/// Rebuild the web-session credential set from a stored cookie credential. +pub fn storyteller_creds_from_credential( + credential: &AuthCredential, +) -> Result { + let cookie = credential.cookies().ok_or_else(|| { + credential_not_usable(credential, "the account has no session cookies") + })?; + + StorytellerCredentialSet::parse_multi_cookie_header(&cookie.cookie_header()) + .map_err(|err| { + credential_not_usable( + credential, + &format!("the stored session cookies could not be parsed ({})", err), + ) + })? + .filter(|creds| !creds.is_empty()) + .ok_or_else(|| { + credential_not_usable(credential, "the stored session cookies are empty") + }) +} + +pub fn credential_not_usable(credential: &AuthCredential, reason: &str) -> GenerateError { + GenerateError::CredentialProblem(CredentialProblemReason::CredentialNotUsable { + credential_id: credential.id.to_string(), + reason: reason.to_string(), + }) +} diff --git a/crates/artcraftx/src/commands/generate/common/higgsfield_generation.rs b/crates/artcraftx/src/commands/generate/common/higgsfield_generation.rs new file mode 100644 index 00000000..c317a600 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/higgsfield_generation.rs @@ -0,0 +1,308 @@ +//! Shared pieces of the first-party (cookie-session) Higgsfield enqueue path +//! for images and videos: the router client for a stored credential, the +//! media-token → CDN URL map for cloud-library references (local files and +//! bytes go straight to Higgsfield without touching ArtCraft), and running a +//! built request through the draft phase. + +use std::collections::HashMap; + +use artcraft_client::utils::api_host::ApiHost; +use log::{error, info, warn}; +use router::client::router_client::RouterClient; +use router::client::router_higgsfield_client::RouterHiggsfieldClient; +use router::errors::artcraft_router_error::ArtcraftRouterError; +use router::errors::provider_error::ProviderError; +use router::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use router::generate::generate_image::generate_image_response::GenerateImageResponse; +use router::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use router::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use router::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use router::generate::generate_image::image_generation_request::ImageGenerationRequest; +use router::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use router::generate::generate_video::generate_video_response::GenerateVideoResponse; +use router::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; +use router::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use router::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use router::generate::generate_video::video_generation_request::VideoGenerationRequest; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use tauri::AppHandle; + +use crate::commands::generate::generate_error::{CredentialProblemReason, GenerateError}; +use crate::commands::generate::generate_image::utils::map_media_files_to_urls::map_media_file_tokens_to_cdn_urls; +use crate::credentials::auth_credential::AuthCredential; +use crate::services::asset_uploads::asset_upload_ledger::AccountUploadCache; +use crate::services::higgsfield::higgsfield_upload_notices::HiggsfieldUploadNotices; +use crate::services::higgsfield::higgsfield_session_from_credential::higgsfield_session_from_credential; + +/// Batch job ids are stored on the task as one comma-separated +/// `provider_job_id`, so the poller can follow every job of the set. +pub const HIGGSFIELD_JOB_ID_SEPARATOR: char = ','; + +/// The router client for a stored Higgsfield credential. A credential whose +/// session Higgsfield already rejected fails here, before any request, until +/// the user logs in again. +pub fn higgsfield_router_client(credential: &AuthCredential) -> Result { + if credential.needs_relogin() { + info!("Higgsfield credential {} is marked as needing a re-login; not calling the API", credential.id); + return Err(session_expired(credential)); + } + let session = higgsfield_session_from_credential(credential)?; + Ok(RouterClient::Higgsfield(RouterHiggsfieldClient::new(session))) +} + +/// The error for a credential whose session is dead. +pub fn session_expired(credential: &AuthCredential) -> GenerateError { + GenerateError::CredentialProblem(CredentialProblemReason::SessionExpired { + credential_id: credential.id.to_string(), + service: credential.service, + }) +} + +/// Convert a router error from a Higgsfield call. +/// +/// - A refusal the user can act on (reference media failing the IP / +/// likeness check) becomes a [`GenerateError::ProviderRejected`] carrying +/// the explanation, which the commands show verbatim. +/// - A dead session (`needs_browser_reauth()`) marks the credential file so +/// nothing else retries it, and becomes a session-expired credential +/// problem (which the frontend turns into a "log in again" prompt). +/// - Anything else is a plain provider failure. +fn higgsfield_error_to_generate_error(credential: &AuthCredential, err: ArtcraftRouterError) -> GenerateError { + let ArtcraftRouterError::Provider(ProviderError::Higgsfield(higgsfield_err)) = &err else { + return GenerateError::from(err); + }; + if let Some(message) = higgsfield_err.user_facing_rejection() { + info!("Higgsfield rejected the request for a user-actionable reason: {}", higgsfield_err); + return GenerateError::ProviderRejected(message); + } + if !higgsfield_err.needs_browser_reauth() { + return GenerateError::from(err); + } + warn!("Higgsfield rejected the session of credential {}; marking it as needing a re-login: {:?}", credential.id, err); + let mut marked = credential.clone(); + if let Err(save_err) = marked.mark_relogin_required() { + error!("Could not mark credential {} as needing a re-login: {}", credential.id, save_err); + } + session_expired(credential) +} + +/// Resolve reference media tokens (cloud-library picks only) to their +/// ArtCraft CDN URLs. Higgsfield can't fetch ArtCraft media itself, so the +/// router downloads each URL and re-uploads the bytes as Higgsfield +/// reference media. Empty when every reference is a local file or bytes — +/// then ArtCraft is never contacted at all. +pub async fn higgsfield_media_url_map(tokens: &[MediaFileToken]) -> Result, GenerateError> { + if tokens.is_empty() { + return Ok(HashMap::new()); + } + let urls = map_media_file_tokens_to_cdn_urls(tokens, &ApiHost::Storyteller).await?; + Ok(tokens.iter().cloned().zip(urls).collect()) +} + +/// Build, finalize (uploading references) and send an image request. +/// +/// References the account already uploaded are reused from the ledger. If +/// Higgsfield then rejects the job because a reused media id is no good +/// (deleted or flagged since), those ledger entries are dropped and the +/// request is finalized and sent once more with fresh uploads. +pub async fn send_higgsfield_image_request( + maybe_app: Option<&AppHandle>, + credential: &AuthCredential, + builder: GenerateImageRequestBuilder, + client: &RouterClient, + media_url_map: &HashMap, + upload_cache: &AccountUploadCache, +) -> Result { + let draft = match builder.build2().map_err(|err| { + warn!("Could not build Higgsfield image request: {:?}", err); + GenerateError::from(err) + })? { + ImageGenerationDraftOrRequest::Request(request) => { + return request.send_request(client).await + .map_err(|err| higgsfield_error_to_generate_error(credential, err)); + } + ImageGenerationDraftOrRequest::Draft(draft) => draft, + }; + + info!("Higgsfield image request has references; uploading them first"); + // Reuse flashes a notice; a real upload keeps a progress toast up until + // `notices` drops at the end of this function (retry included). + let notices = HiggsfieldUploadNotices::new(maybe_app); + let request = finalize_image_draft(credential, draft.clone(), client, media_url_map, upload_cache, ¬ices).await?; + match request.send_request(client).await { + Ok(response) => Ok(response), + Err(err) if should_retry_with_fresh_uploads(&err, upload_cache) => { + let forgotten = upload_cache.forget_reused().await; + warn!("Higgsfield rejected reused reference media ({:?}); forgot {} ledger entries and uploading afresh", err, forgotten); + let request = finalize_image_draft(credential, draft, client, media_url_map, upload_cache, ¬ices).await?; + request.send_request(client).await + .map_err(|err| higgsfield_error_to_generate_error(credential, err)) + } + Err(err) => Err(higgsfield_error_to_generate_error(credential, err)), + } +} + +async fn finalize_image_draft( + credential: &AuthCredential, + draft: ImageGenerationDraftRequest, + client: &RouterClient, + media_url_map: &HashMap, + upload_cache: &AccountUploadCache, + notices: &HiggsfieldUploadNotices, +) -> Result { + let context = ImageGenerationDraftContext { + client: Some(client), + media_file_to_artcraft_url_map: Some(media_url_map), + asset_upload_cache: Some(upload_cache), + asset_upload_observer: Some(notices), + }; + draft.finalize(context).await.map_err(|err| { + warn!("Could not upload references to Higgsfield: {:?}", err); + higgsfield_error_to_generate_error(credential, err) + }) +} + +/// Build, finalize (uploading keyframes and references) and send a video +/// request. Reused uploads that Higgsfield rejects at enqueue time are +/// forgotten and uploaded afresh, once — see [`send_higgsfield_image_request`]. +pub async fn send_higgsfield_video_request( + maybe_app: Option<&AppHandle>, + credential: &AuthCredential, + builder: GenerateVideoRequestBuilder, + client: &RouterClient, + media_url_map: &HashMap, + upload_cache: &AccountUploadCache, +) -> Result { + let draft = match builder.build2().map_err(|err| { + warn!("Could not build Higgsfield video request: {:?}", err); + GenerateError::from(err) + })? { + VideoGenerationDraftOrRequest::Request(request) => { + return request.send_request(client).await + .map_err(|err| higgsfield_error_to_generate_error(credential, err)); + } + VideoGenerationDraftOrRequest::Draft(draft) => draft, + }; + + info!("Higgsfield video request has media; uploading it first"); + // Reuse flashes a notice; a real upload keeps a progress toast up until + // `notices` drops at the end of this function (retry included). + let notices = HiggsfieldUploadNotices::new(maybe_app); + let request = finalize_video_draft(credential, draft.clone(), client, media_url_map, upload_cache, ¬ices).await?; + match request.send_request(client).await { + Ok(response) => Ok(response), + Err(err) if should_retry_with_fresh_uploads(&err, upload_cache) => { + let forgotten = upload_cache.forget_reused().await; + warn!("Higgsfield rejected reused reference media ({:?}); forgot {} ledger entries and uploading afresh", err, forgotten); + let request = finalize_video_draft(credential, draft, client, media_url_map, upload_cache, ¬ices).await?; + request.send_request(client).await + .map_err(|err| higgsfield_error_to_generate_error(credential, err)) + } + Err(err) => Err(higgsfield_error_to_generate_error(credential, err)), + } +} + +async fn finalize_video_draft( + credential: &AuthCredential, + draft: VideoGenerationDraftRequest, + client: &RouterClient, + media_url_map: &HashMap, + upload_cache: &AccountUploadCache, + notices: &HiggsfieldUploadNotices, +) -> Result { + let context = VideoGenerationDraftContext { + client: Some(client), + media_file_to_artcraft_url_map: Some(media_url_map), + character_token_to_kinovi_id_map: None, + asset_upload_cache: Some(upload_cache), + asset_upload_observer: Some(notices), + }; + draft.finalize(context).await.map_err(|err| { + warn!("Could not upload media to Higgsfield: {:?}", err); + higgsfield_error_to_generate_error(credential, err) + }) +} + +/// Retry with fresh uploads only when Higgsfield rejected a media input and +/// this request actually reused something from the ledger; otherwise the +/// media was uploaded just now and re-uploading would change nothing. +fn should_retry_with_fresh_uploads(err: &ArtcraftRouterError, upload_cache: &AccountUploadCache) -> bool { + let media_rejected = matches!( + err, + ArtcraftRouterError::Provider(ProviderError::Higgsfield(higgsfield_err)) if higgsfield_err.is_media_input_rejected() + ); + media_rejected && upload_cache.reused_count() > 0 +} + +/// One `provider_job_id` for a Higgsfield job set. +pub fn join_higgsfield_job_ids(job_ids: &[String]) -> String { + job_ids.join(&HIGGSFIELD_JOB_ID_SEPARATOR.to_string()) +} + +/// The job ids stored on a task by [`join_higgsfield_job_ids`]. +pub fn split_higgsfield_job_ids(provider_job_id: &str) -> Vec { + provider_job_id + .split(HIGGSFIELD_JOB_ID_SEPARATOR) + .map(str::trim) + .filter(|id| !id.is_empty()) + .map(str::to_string) + .collect() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::auth_credential::CredentialSecret; + use crate::credentials::cookie_credential::CookieCredential; + use cookie_store_wrapper::cookie_store::CookieStore; + use core_types::enums::generation_source::GenerationSource; + use core_types::identifiers::credential_id::CredentialId; + use higgsfield_client::error::higgsfield_client_error::HiggsfieldClientError; + use higgsfield_client::error::higgsfield_error::HiggsfieldError; + use higgsfield_client::types::ids::MediaId; + use reqwest::Url; + + #[test] + fn protected_content_becomes_a_provider_rejection_with_the_explanation() { + let err = ArtcraftRouterError::Provider(ProviderError::Higgsfield( + HiggsfieldError::Client(HiggsfieldClientError::MediaProtectedContent { media_id: MediaId::new("m1") }), + )); + match higgsfield_error_to_generate_error(&unsaved_credential(), err) { + GenerateError::ProviderRejected(message) => assert!(message.contains("intellectual property"), "{message}"), + other => panic!("expected ProviderRejected, got {other:?}"), + } + } + + #[test] + fn other_higgsfield_errors_stay_provider_failures() { + let err = ArtcraftRouterError::Provider(ProviderError::Higgsfield( + HiggsfieldError::Client(HiggsfieldClientError::UploadSourceDomainBlocked { + source_url: "https://cdn.example.com/a.png".to_string(), + domain: "cdn.example.com", + }), + )); + assert!(matches!(higgsfield_error_to_generate_error(&unsaved_credential(), err), GenerateError::ProviderFailure(_))); + } + + fn unsaved_credential() -> AuthCredential { + let origin = Url::parse("https://higgsfield.ai/").unwrap(); + AuthCredential { + id: CredentialId::generate(), + service: GenerationSource::HiggsfieldCookies, + name: None, + secret: CredentialSecret::Cookies(CookieCredential::new(CookieStore::from_cookie_header("__client=abc", &origin))), + user_info: None, + source_path: std::env::temp_dir().join("never_written_higgsfield_cookies.toml"), + } + } + + #[test] + fn job_ids_round_trip() { + let ids = vec!["job_a".to_string(), "job_b".to_string()]; + let joined = join_higgsfield_job_ids(&ids); + assert_eq!(joined, "job_a,job_b"); + assert_eq!(split_higgsfield_job_ids(&joined), ids); + assert_eq!(split_higgsfield_job_ids("solo"), vec!["solo".to_string()]); + assert!(split_higgsfield_job_ids(" , ").is_empty()); + } +} diff --git a/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_billing_errors.rs b/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_billing_errors.rs new file mode 100644 index 00000000..7387aca4 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_billing_errors.rs @@ -0,0 +1,58 @@ +use crate::commands::generate::generate_error::{BillingIssueReason, BillingProvider, GenerateError, ProviderFailureReason}; +use crate::events::functional_events::show_provider_billing_modal_event::ShowProviderBillingModalEvent; +use core_types::enums::generation_source::GenerationSource; +use log::warn; +use artcraft_client::error::api_error::ApiError; +use artcraft_client::error::storyteller_error::StorytellerError; +use tauri::AppHandle; + +pub async fn maybe_notify_frontend_of_billing_errors( + app: &AppHandle, + error: &GenerateError, +) { + match error { + GenerateError::BillingIssue(reason) => { + billing_error(app, reason); + } + GenerateError::ProviderFailure(reason) => { + provider_billing_error(app, reason); + } + _ => { + // Do nothing for other types of errors + } + } +} + +fn billing_error( + app: &AppHandle, + reason: &BillingIssueReason, +) { + let provider = match reason.provider { + BillingProvider::Artcraft => GenerationSource::Artcraft, + BillingProvider::Fal => GenerationSource::Fal, + BillingProvider::Higgsfield => GenerationSource::Higgsfield, + BillingProvider::Kinovi => GenerationSource::Artcraft, // NB: We don't support Kinovi yet. + BillingProvider::Midjourney => GenerationSource::Midjourney, + }; + warn!("Billing issue with: {:?}", provider); + ShowProviderBillingModalEvent::send_for_provider(provider, app); +} + +fn provider_billing_error( + app: &AppHandle, + error: &ProviderFailureReason, +) { + let provider; + + match error { + ProviderFailureReason::StorytellerError(StorytellerError::Api(ApiError::PaymentRequired(reason))) => { + warn!("Billing issue with Artcraft/Storyteller: {}", reason); + provider = GenerationSource::Artcraft; + } + _ => { + return; + } + } + + ShowProviderBillingModalEvent::send_for_provider(provider, app); +} diff --git a/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_credential_errors.rs b/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_credential_errors.rs new file mode 100644 index 00000000..1d1f2e00 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_credential_errors.rs @@ -0,0 +1,33 @@ +use tauri::AppHandle; + +use crate::commands::generate::generate_error::{CredentialProblemReason, GenerateError}; +use crate::credentials::login_website::LoginWebsite; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::show_credential_error_modal_event::ShowCredentialErrorModalEvent; + +/// If the error is a credential problem, tell the frontend to show the +/// dismissable credential-error modal. An expired session also names the +/// website and credential to log into again, so the modal can offer a +/// "log in" button that refreshes that exact credential. +pub async fn maybe_notify_frontend_of_credential_errors( + app: &AppHandle, + error: &GenerateError, +) { + let GenerateError::CredentialProblem(reason) = error else { + return; + }; + + let (maybe_relogin_website, maybe_credential_id) = match reason { + CredentialProblemReason::SessionExpired { credential_id, service } => ( + LoginWebsite::for_credential_service(*service), + Some(credential_id.clone()), + ), + _ => (None, None), + }; + + ShowCredentialErrorModalEvent { + message: reason.user_message(), + maybe_relogin_website, + maybe_credential_id, + }.send_infallible(app); +} diff --git a/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_grok_errors.rs b/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_grok_errors.rs new file mode 100644 index 00000000..b24e2c0d --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/maybe_notify_frontend_of_grok_errors.rs @@ -0,0 +1,49 @@ +use crate::commands::generate::generate_error::{GenerateError, MissingCredentialsReason, ProviderFailureReason}; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::common::{GenerationAction, GenerationServiceProvider}; +use crate::events::generation_events::generation_enqueue_failure_event::GenerationEnqueueFailureEvent; +use grok_consumer_client::error::grok_error::GrokError; +use grok_consumer_client::error::grok_specific_api_error::GrokSpecificApiError; +use tauri::AppHandle; + +pub async fn maybe_notify_frontend_of_grok_errors( + app: &AppHandle, + error: &GenerateError, +) { + match error { + GenerateError::ProviderFailure(ProviderFailureReason::GrokError(error)) => { + grok_error(app, error); + } + GenerateError::MissingCredentials(MissingCredentialsReason::NeedsGrokCredentials) => { + GenerationEnqueueFailureEvent { + action: GenerationAction::GenerateImage, + service: GenerationServiceProvider::Grok, + model: None, + reason: Some("Please log into Grok (Settings → Accounts) to use Grok Imagine.".to_string()), + }.send_infallible(app); + } + _ => { + // Do nothing for other types of errors + } + } +} + +fn grok_error( + app: &AppHandle, + error: &GrokError, +) { + match error { + GrokError::ApiSpecific(GrokSpecificApiError::TooManyVideos) => { + let event = GenerationEnqueueFailureEvent { + action: GenerationAction::GenerateVideo, + service: GenerationServiceProvider::Grok, + model: None, + reason: Some("You've generated too many Grok videos. Please wait for more quota from Grok.".to_string()), + }; + event.send_infallible(&app); + } + GrokError::ApiSpecific(_) => {} + GrokError::Client(_) => {} + GrokError::ApiGeneric(_) => {} + } +} diff --git a/crates/artcraftx/src/commands/generate/common/media_source_conversion.rs b/crates/artcraftx/src/commands/generate/common/media_source_conversion.rs new file mode 100644 index 00000000..cc0a3919 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/media_source_conversion.rs @@ -0,0 +1,280 @@ +//! Per-provider conversion of [`TauriMediaSource`]s. +//! +//! - Higgsfield / Kinovi consume sources natively (`sources_to_*_list`); the +//! router reads local files / bytes and uploads them straight to the +//! provider. Only tokens (cloud-library picks) resolve through ArtCraft. +//! - The ArtCraft provider is token-native: local files / bytes upload to +//! ArtCraft at generate time (`sources_to_artcraft_tokens`) — the media +//! must reach ArtCraft anyway. +//! - FAL needs public URLs and has no storage of its own: local files / +//! bytes upload to ArtCraft and resolve to CDN URLs +//! (`image_sources_to_fal_urls`). FAL is the ONLY non-ArtCraft provider +//! allowed to route local media through the ArtCraft cloud. + +use std::path::{Path, PathBuf}; + +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use artcraft_client::endpoints::media_files::upload_audio_media_file_from_file::{upload_audio_media_file_from_file, UploadAudioFromFileArgs}; +use artcraft_client::endpoints::media_files::upload_image_media_file_from_file::{upload_image_media_file_from_file, UploadImageFromFileArgs}; +use artcraft_client::endpoints::media_files::upload_video_media_file_from_file::{upload_video_media_file_from_file, UploadVideoFromFileArgs}; +use artcraft_client::error::storyteller_error::StorytellerError; +use artcraft_client::utils::api_host::ApiHost; +use log::info; +use router::api::audio_list_ref::AudioListRef; +use router::api::image_list_ref::ImageListRef; +use router::api::image_ref::ImageRef; +use router::api::video_list_ref::VideoListRef; +use router::utils::higgsfield_media::sniff_mime_type; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use uuid_utils::uuid::generate_random_uuid; + +use crate::commands::generate::common::tauri_media_source::TauriMediaSource; +use crate::commands::generate::generate_error::GenerateError; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; + +/// Which ArtCraft upload endpoint a source goes through. +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum ArtcraftMediaKind { + Image, + Video, + Audio, +} + +// ── Router-native providers (Higgsfield, Kinovi) ── + +pub fn source_to_image_ref(maybe_source: Option) -> Option { + maybe_source.map(TauriMediaSource::into_image_ref) +} + +pub fn sources_to_image_list(maybe_sources: Option>) -> Option { + maybe_sources.map(|sources| { + ImageListRef::Sources(sources.into_iter().map(TauriMediaSource::into_image_ref).collect()) + }) +} + +pub fn sources_to_video_list(maybe_sources: Option>) -> Option { + maybe_sources.map(|sources| { + VideoListRef::Sources(sources.into_iter().map(TauriMediaSource::into_video_ref).collect()) + }) +} + +pub fn sources_to_audio_list(maybe_sources: Option>) -> Option { + maybe_sources.map(|sources| { + AudioListRef::Sources(sources.into_iter().map(TauriMediaSource::into_audio_ref).collect()) + }) +} + +/// The ArtCraft media tokens among `sources`, deduplicated, in order — the +/// only sources that need the token→CDN-URL map. +pub fn collect_source_tokens<'a>(sources: impl IntoIterator) -> Vec { + let mut tokens: Vec = sources.into_iter() + .filter_map(TauriMediaSource::maybe_media_file_token) + .cloned() + .collect(); + tokens.dedup(); + tokens +} + +// ── ArtCraft provider (token-native) ── + +/// Resolve one source to an ArtCraft media token: tokens pass through; +/// local files and bytes upload to ArtCraft at generate time — unless the +/// ledger says this account already uploaded the same content and ArtCraft +/// confirms it still has it. +pub async fn source_to_artcraft_token( + source: TauriMediaSource, + kind: ArtcraftMediaKind, + maybe_creds: Option<&StorytellerCredentialSet>, + api_host: &ApiHost, + ledger: &AssetUploadLedger, +) -> Result { + let maybe_cache = ledger.for_artcraft_session(maybe_creds); + match source { + TauriMediaSource::MediaFileToken { token } => Ok(token), + TauriMediaSource::LocalPath { path } => match &maybe_cache { + Some(cache) => cache.artcraft_token_for_file(api_host, &path, || upload_path_to_artcraft(&path, kind, maybe_creds, api_host)).await, + None => upload_path_to_artcraft(&path, kind, maybe_creds, api_host).await, + }, + TauriMediaSource::Bytes { bytes, file_name } => { + let upload = || upload_bytes_to_artcraft(&bytes, file_name.as_deref(), kind, maybe_creds, api_host); + match &maybe_cache { + Some(cache) => cache.artcraft_token_for_bytes(api_host, &bytes, upload).await, + None => upload().await, + } + } + } +} + +/// List twin of [`source_to_artcraft_token`]; order is preserved. +pub async fn sources_to_artcraft_tokens( + maybe_sources: Option>, + kind: ArtcraftMediaKind, + maybe_creds: Option<&StorytellerCredentialSet>, + api_host: &ApiHost, + ledger: &AssetUploadLedger, +) -> Result>, GenerateError> { + let sources = match maybe_sources { + None => return Ok(None), + Some(sources) if sources.is_empty() => return Ok(None), + Some(sources) => sources, + }; + let mut tokens = Vec::with_capacity(sources.len()); + for source in sources { + tokens.push(source_to_artcraft_token(source, kind, maybe_creds, api_host, ledger).await?); + } + Ok(Some(tokens)) +} + +/// Single-optional twin of [`source_to_artcraft_token`]. +pub async fn maybe_source_to_artcraft_token( + maybe_source: Option, + kind: ArtcraftMediaKind, + maybe_creds: Option<&StorytellerCredentialSet>, + api_host: &ApiHost, + ledger: &AssetUploadLedger, +) -> Result, GenerateError> { + match maybe_source { + None => Ok(None), + Some(source) => Ok(Some(source_to_artcraft_token(source, kind, maybe_creds, api_host, ledger).await?)), + } +} + +// ── FAL (URL-native; the ONLY provider allowed to route through ArtCraft) ── + +/// Resolve image sources to publicly-reachable CDN URLs for FAL: tokens +/// resolve to their CDN URL; local files / bytes upload to ArtCraft first. +pub async fn image_sources_to_fal_urls( + maybe_sources: Option>, + maybe_creds: Option<&StorytellerCredentialSet>, + api_host: &ApiHost, + ledger: &AssetUploadLedger, +) -> Result>, GenerateError> { + let sources = match maybe_sources { + None => return Ok(None), + Some(sources) if sources.is_empty() => return Ok(None), + Some(sources) => sources, + }; + let mut urls = Vec::with_capacity(sources.len()); + for source in sources { + let token = source_to_artcraft_token(source, ArtcraftMediaKind::Image, maybe_creds, api_host, ledger).await?; + let response = get_media_file(api_host, &token).await?; + urls.push(response.media_file.media_links.cdn_url.to_string()); + } + Ok(Some(urls)) +} + +// ── Private ── + +/// The upload endpoints are multipart-from-file; stage the bytes, upload, +/// clean up. +async fn upload_bytes_to_artcraft( + bytes: &[u8], + maybe_file_name: Option<&str>, + kind: ArtcraftMediaKind, + maybe_creds: Option<&StorytellerCredentialSet>, + api_host: &ApiHost, +) -> Result { + let staged = stage_bytes_to_temp_file(bytes, maybe_file_name)?; + let result = upload_path_to_artcraft(&staged, kind, maybe_creds, api_host).await; + std::fs::remove_file(&staged).ok(); + result +} + +async fn upload_path_to_artcraft( + path: &Path, + kind: ArtcraftMediaKind, + maybe_creds: Option<&StorytellerCredentialSet>, + api_host: &ApiHost, +) -> Result { + info!("Uploading local {:?} file to ArtCraft at generate time: {}", kind, path.display()); + let token = match kind { + ArtcraftMediaKind::Image => { + upload_image_media_file_from_file(UploadImageFromFileArgs { + api_host, + maybe_creds, + path, + is_intermediate_system_file: false, + maybe_prompt_token: None, + maybe_generation_provider: None, + maybe_batch_token: None, + }).await?.media_file_token + } + ArtcraftMediaKind::Video => { + upload_video_media_file_from_file(UploadVideoFromFileArgs { + api_host, + maybe_creds, + path, + maybe_prompt_token: None, + maybe_generation_provider: None, + }).await.map_err(StorytellerError::from)?.media_file_token + } + ArtcraftMediaKind::Audio => { + upload_audio_media_file_from_file(UploadAudioFromFileArgs { + api_host, + maybe_creds, + path, + maybe_prompt_token: None, + maybe_generation_provider: None, + }).await.map_err(StorytellerError::from)?.media_file_token + } + }; + info!("Uploaded local {:?} file as {}", kind, token.as_str()); + Ok(token) +} + +/// Stage in-memory bytes as a temp file for the multipart-from-file upload +/// endpoints. The file name's extension survives so the server can tell the +/// type; unknown types get one sniffed from the bytes. +fn stage_bytes_to_temp_file(bytes: &[u8], maybe_file_name: Option<&str>) -> Result { + let extension = maybe_file_name + .and_then(|name| Path::new(name).extension()?.to_str().map(str::to_string)) + .or_else(|| sniff_mime_type(bytes).map(|mime| mime.file_extension().to_string())) + .unwrap_or_else(|| "bin".to_string()); + let path = std::env::temp_dir().join(format!("artcraftx_media_{}.{}", generate_random_uuid(), extension)); + std::fs::write(&path, bytes).map_err(GenerateError::IoError)?; + Ok(path) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn sources_map_to_router_lists() { + let list = sources_to_image_list(Some(vec![ + TauriMediaSource::MediaFileToken { token: MediaFileToken::new_from_str("m_a") }, + TauriMediaSource::LocalPath { path: PathBuf::from("/tmp/a.png") }, + ])).unwrap(); + assert_eq!(list.len(), 2); + assert!(matches!(&list, ImageListRef::Sources(refs) if matches!(refs[1], ImageRef::LocalPath(_)))); + assert!(sources_to_image_list(None).is_none()); + } + + #[test] + fn only_tokens_are_collected_for_the_url_map() { + let sources = vec![ + TauriMediaSource::MediaFileToken { token: MediaFileToken::new_from_str("m_a") }, + TauriMediaSource::LocalPath { path: PathBuf::from("/tmp/a.png") }, + TauriMediaSource::Bytes { bytes: vec![1], file_name: None }, + TauriMediaSource::MediaFileToken { token: MediaFileToken::new_from_str("m_b") }, + ]; + let tokens = collect_source_tokens(&sources); + assert_eq!(tokens.len(), 2); + assert_eq!(tokens[0].as_str(), "m_a"); + assert_eq!(tokens[1].as_str(), "m_b"); + } + + #[test] + fn byte_staging_names_by_extension() { + const PNG: &[u8] = b"\x89PNG\r\n\x1a\n\0\0\0\rIHDR"; + let staged = stage_bytes_to_temp_file(PNG, None).unwrap(); + assert_eq!(staged.extension().and_then(|e| e.to_str()), Some("png")); + assert_eq!(std::fs::read(&staged).unwrap(), PNG); + std::fs::remove_file(&staged).ok(); + + let staged = stage_bytes_to_temp_file(b"????", Some("track.mp3")).unwrap(); + assert_eq!(staged.extension().and_then(|e| e.to_str()), Some("mp3")); + std::fs::remove_file(&staged).ok(); + } +} diff --git a/crates/artcraftx/src/commands/generate/common/mod.rs b/crates/artcraftx/src/commands/generate/common/mod.rs new file mode 100644 index 00000000..0f3ad8b7 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/mod.rs @@ -0,0 +1,10 @@ +pub mod maybe_notify_frontend_of_billing_errors; +pub mod maybe_notify_frontend_of_credential_errors; +pub mod maybe_notify_frontend_of_grok_errors; +pub mod media_source_conversion; +pub mod notify_frontend_of_errors; +pub mod generation_credential; +pub mod higgsfield_generation; +pub mod router_image_request_to_artcraft_prompt; +pub mod router_video_request_to_artcraft_prompt; +pub mod tauri_media_source; diff --git a/crates/artcraftx/src/commands/generate/common/notify_frontend_of_errors.rs b/crates/artcraftx/src/commands/generate/common/notify_frontend_of_errors.rs new file mode 100644 index 00000000..78575c40 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/notify_frontend_of_errors.rs @@ -0,0 +1,14 @@ +use crate::commands::generate::common::maybe_notify_frontend_of_billing_errors::maybe_notify_frontend_of_billing_errors; +use crate::commands::generate::common::maybe_notify_frontend_of_credential_errors::maybe_notify_frontend_of_credential_errors; +use crate::commands::generate::common::maybe_notify_frontend_of_grok_errors::maybe_notify_frontend_of_grok_errors; +use crate::commands::generate::generate_error::GenerateError; +use tauri::AppHandle; + +pub async fn notify_frontend_of_errors( + app: &AppHandle, + error: &GenerateError, +) { + maybe_notify_frontend_of_billing_errors(app, error).await; + maybe_notify_frontend_of_credential_errors(app, error).await; + maybe_notify_frontend_of_grok_errors(app, error).await; +} diff --git a/crates/artcraftx/src/commands/generate/common/router_image_request_to_artcraft_prompt.rs b/crates/artcraftx/src/commands/generate/common/router_image_request_to_artcraft_prompt.rs new file mode 100644 index 00000000..a4b28d5b --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/router_image_request_to_artcraft_prompt.rs @@ -0,0 +1,224 @@ +use artcraft_client::api_defs::prompts::create_prompt::CreatePromptRequest; +use router::api::router_aspect_ratio::RouterAspectRatio; +use router::api::router_image_model::RouterImageModel; +use router::api::router_resolution::RouterResolution; +use router::api::router_provider::RouterProvider; +use router::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as EnumsAspectRatio; +use artcraft_client::enums::common::generation::common_generation_mode::CommonGenerationMode; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as EnumsResolution; +use core_types::enums::generation_source::GenerationSource; +use uuid_utils::uuid::generate_random_uuid; + +pub fn router_image_request_to_artcraft_prompt( + request: &GenerateImageRequestBuilder, +) -> CreatePromptRequest { + CreatePromptRequest { + uuid_idempotency_token: generate_random_uuid(), + positive_prompt: request.prompt.clone(), + negative_prompt: None, + model_type: image_model_to_common_model_type(request.model), + generation_provider: Some(provider_to_generation_provider(request.provider)), + maybe_generation_mode: Some(determine_image_generation_mode(request)), + maybe_aspect_ratio: request.aspect_ratio.map(router_aspect_ratio_to_enums), + maybe_resolution: request.resolution.map(router_resolution_to_enums), + maybe_batch_count: request.image_batch_count.map(|n| n.min(255) as u8), + maybe_generate_audio: None, + maybe_duration_seconds: None, + } +} + +// ── Converters ── + +fn determine_image_generation_mode(request: &GenerateImageRequestBuilder) -> CommonGenerationMode { + if request.image_inputs.is_some() { + CommonGenerationMode::Edit + } else { + CommonGenerationMode::Text + } +} + +fn image_model_to_common_model_type(model: RouterImageModel) -> Option { + match model { + RouterImageModel::Flux1Dev => Some(CommonModelType::Flux1Dev), + RouterImageModel::Flux1Schnell => Some(CommonModelType::Flux1Schnell), + RouterImageModel::FluxPro11 => Some(CommonModelType::FluxPro11), + RouterImageModel::FluxPro11Ultra => Some(CommonModelType::FluxPro11Ultra), + RouterImageModel::GptImage1 => Some(CommonModelType::GptImage1), + RouterImageModel::GptImage1p5 => Some(CommonModelType::GptImage1p5), + RouterImageModel::GptImage2 => Some(CommonModelType::GptImage2), + RouterImageModel::NanoBanana => Some(CommonModelType::NanoBanana), + RouterImageModel::NanoBanana2 => Some(CommonModelType::NanoBanana2), + // Higgsfield-only; storyteller-web has no prompt type for it. + RouterImageModel::NanoBanana2Lite => None, + RouterImageModel::NanoBananaPro => Some(CommonModelType::NanoBananaPro), + RouterImageModel::Seedream4 => Some(CommonModelType::Seedream4), + RouterImageModel::Seedream4p5 => Some(CommonModelType::Seedream4p5), + RouterImageModel::Seedream5Lite => Some(CommonModelType::Seedream5Lite), + RouterImageModel::Seedream5p0Pro => Some(CommonModelType::Seedream5p0Pro), + RouterImageModel::Seedream5p0ProUltra => Some(CommonModelType::Seedream5p0ProUltra), + RouterImageModel::QwenEdit2511Angles => Some(CommonModelType::QwenEdit2511Angles), + RouterImageModel::Flux2LoraAngles => Some(CommonModelType::Flux2LoraAngles), + RouterImageModel::GrokImagineImage => Some(CommonModelType::GrokImagineImage), + RouterImageModel::GrokImagineImageQuality => Some(CommonModelType::GrokImagineImageQuality), + RouterImageModel::Midjourney7 => Some(CommonModelType::Midjourney7), + RouterImageModel::Midjourney7Niji => Some(CommonModelType::Midjourney7Niji), + RouterImageModel::Midjourney8 => Some(CommonModelType::Midjourney8), + } +} + +fn provider_to_generation_provider(provider: RouterProvider) -> GenerationSource { + match provider { + RouterProvider::Artcraft => GenerationSource::Artcraft, + RouterProvider::Fal => GenerationSource::Fal, + RouterProvider::Grok => GenerationSource::Grok, + RouterProvider::Higgsfield => GenerationSource::Higgsfield, + RouterProvider::Midjourney => GenerationSource::Midjourney, + // Unused providers -> ArtCraft + RouterProvider::Seedance2Pro => GenerationSource::Artcraft , + RouterProvider::GmiCloud => GenerationSource::Artcraft, + RouterProvider::GrokApi => GenerationSource::Artcraft, + } +} + +fn router_aspect_ratio_to_enums(ar: RouterAspectRatio) -> EnumsAspectRatio { + match ar { + RouterAspectRatio::Auto => EnumsAspectRatio::Auto, + RouterAspectRatio::Square => EnumsAspectRatio::Square, + RouterAspectRatio::WideThreeByTwo => EnumsAspectRatio::WideThreeByTwo, + RouterAspectRatio::WideFourByThree => EnumsAspectRatio::WideFourByThree, + RouterAspectRatio::WideFiveByFour => EnumsAspectRatio::WideFiveByFour, + RouterAspectRatio::WideSixteenByNine => EnumsAspectRatio::WideSixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => EnumsAspectRatio::WideTwentyOneByNine, + RouterAspectRatio::TallTwoByThree => EnumsAspectRatio::TallTwoByThree, + RouterAspectRatio::TallThreeByFour => EnumsAspectRatio::TallThreeByFour, + RouterAspectRatio::TallFourByFive => EnumsAspectRatio::TallFourByFive, + RouterAspectRatio::TallNineBySixteen => EnumsAspectRatio::TallNineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => EnumsAspectRatio::TallNineByTwentyOne, + RouterAspectRatio::Wide => EnumsAspectRatio::Wide, + RouterAspectRatio::Tall => EnumsAspectRatio::Tall, + RouterAspectRatio::Auto2k => EnumsAspectRatio::Auto2k, + RouterAspectRatio::Auto3k => EnumsAspectRatio::Auto3k, + RouterAspectRatio::Auto4k => EnumsAspectRatio::Auto4k, + RouterAspectRatio::SquareHd => EnumsAspectRatio::SquareHd, + } +} + +fn router_resolution_to_enums(res: RouterResolution) -> EnumsResolution { + match res { + RouterResolution::OneK => EnumsResolution::OneK, + RouterResolution::TwoK => EnumsResolution::TwoK, + RouterResolution::ThreeK => EnumsResolution::ThreeK, + RouterResolution::FourK => EnumsResolution::FourK, + RouterResolution::HalfK => EnumsResolution::HalfK, + RouterResolution::FourEightyP => EnumsResolution::FourEightyP, + RouterResolution::SevenTwentyP => EnumsResolution::SevenTwentyP, + RouterResolution::TenEightyP => EnumsResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBananaPro, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + #[test] + fn basic_conversion() { + let builder = base_builder(); + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.positive_prompt.as_deref(), Some("a cat in space")); + assert_eq!(prompt.model_type, Some(CommonModelType::NanoBananaPro)); + assert_eq!(prompt.generation_provider, Some(GenerationSource::Fal)); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Text)); + assert!(prompt.negative_prompt.is_none()); + assert!(prompt.maybe_aspect_ratio.is_none()); + assert!(prompt.maybe_resolution.is_none()); + assert!(prompt.maybe_batch_count.is_none()); + assert!(!prompt.uuid_idempotency_token.is_empty()); + } + + #[test] + fn text_mode_when_no_images() { + let builder = base_builder(); + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Text)); + } + + #[test] + fn edit_mode_when_images_present() { + use router::api::image_list_ref::ImageListRef; + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Edit)); + } + + #[test] + fn with_aspect_ratio_and_resolution() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::TwoK), + image_batch_count: Some(3), + ..base_builder() + }; + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_aspect_ratio, Some(EnumsAspectRatio::WideSixteenByNine)); + assert_eq!(prompt.maybe_resolution, Some(EnumsResolution::TwoK)); + assert_eq!(prompt.maybe_batch_count, Some(3)); + } + + #[test] + fn no_prompt() { + let builder = GenerateImageRequestBuilder { + prompt: None, + ..base_builder() + }; + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert!(prompt.positive_prompt.is_none()); + } + + #[test] + fn all_image_models_map() { + let models = [ + (RouterImageModel::Flux1Dev, CommonModelType::Flux1Dev), + (RouterImageModel::Flux1Schnell, CommonModelType::Flux1Schnell), + (RouterImageModel::NanoBananaPro, CommonModelType::NanoBananaPro), + (RouterImageModel::GptImage1, CommonModelType::GptImage1), + (RouterImageModel::Seedream4, CommonModelType::Seedream4), + ]; + for (router_model, expected) in models { + let builder = GenerateImageRequestBuilder { model: router_model, ..base_builder() }; + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.model_type, Some(expected)); + } + } + + #[test] + fn provider_mapping() { + let builder = GenerateImageRequestBuilder { provider: RouterProvider::Artcraft, ..base_builder() }; + let prompt = router_image_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.generation_provider, Some(GenerationSource::Artcraft)); + } +} diff --git a/crates/artcraftx/src/commands/generate/common/router_video_request_to_artcraft_prompt.rs b/crates/artcraftx/src/commands/generate/common/router_video_request_to_artcraft_prompt.rs new file mode 100644 index 00000000..4e6a68c8 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/router_video_request_to_artcraft_prompt.rs @@ -0,0 +1,275 @@ +use artcraft_client::api_defs::prompts::create_prompt::CreatePromptRequest; +use router::api::router_aspect_ratio::RouterAspectRatio; +use router::api::router_resolution::RouterResolution; +use router::api::router_video_model::RouterVideoModel; +use router::api::router_provider::RouterProvider; +use router::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as EnumsAspectRatio; +use artcraft_client::enums::common::generation::common_generation_mode::CommonGenerationMode; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as EnumsResolution; +use core_types::enums::generation_source::GenerationSource; +use uuid_utils::uuid::generate_random_uuid; + +pub fn router_video_request_to_artcraft_prompt( + request: &GenerateVideoRequestBuilder, +) -> CreatePromptRequest { + CreatePromptRequest { + uuid_idempotency_token: generate_random_uuid(), + positive_prompt: request.prompt.clone(), + negative_prompt: request.negative_prompt.clone(), + model_type: video_model_to_common_model_type(request.model), + generation_provider: Some(provider_to_generation_provider(request.provider)), + maybe_generation_mode: Some(determine_video_generation_mode(request)), + maybe_aspect_ratio: request.aspect_ratio.map(router_aspect_ratio_to_enums), + maybe_resolution: request.resolution.map(router_resolution_to_enums), + maybe_batch_count: request.video_batch_count.map(|n| n.min(255) as u8), + maybe_generate_audio: request.generate_audio, + maybe_duration_seconds: request.duration_seconds.map(|d| d as u32), + } +} + +// ── Converters ── + +fn determine_video_generation_mode(request: &GenerateVideoRequestBuilder) -> CommonGenerationMode { + let has_keyframes = request.start_frame.is_some() || request.end_frame.is_some(); + let has_references = request.reference_images.is_some() + || request.reference_videos.is_some() + || request.reference_audio.is_some(); + + if has_keyframes { + CommonGenerationMode::Keyframe + } else if has_references { + CommonGenerationMode::Reference + } else { + CommonGenerationMode::Text + } +} + +fn video_model_to_common_model_type(model: RouterVideoModel) -> Option { + match model { + RouterVideoModel::GrokVideo => Some(CommonModelType::GrokVideo), + RouterVideoModel::Kling16Pro => Some(CommonModelType::Kling16Pro), + RouterVideoModel::Kling21Pro => Some(CommonModelType::Kling21Pro), + RouterVideoModel::Kling21Master => Some(CommonModelType::Kling21Master), + RouterVideoModel::Kling2p5TurboPro => Some(CommonModelType::Kling2p5TurboPro), + RouterVideoModel::Kling2p6Pro => Some(CommonModelType::Kling2p6Pro), + RouterVideoModel::Kling3p0Standard => Some(CommonModelType::Kling3p0Standard), + RouterVideoModel::Kling3p0Pro => Some(CommonModelType::Kling3p0Pro), + RouterVideoModel::Seedance10Lite => Some(CommonModelType::Seedance10Lite), + RouterVideoModel::Seedance1p5Pro => Some(CommonModelType::Seedance1p5Pro), + RouterVideoModel::Seedance2p0 => Some(CommonModelType::Seedance2p0), + RouterVideoModel::Seedance2p0Fast => Some(CommonModelType::Seedance2p0Fast), + RouterVideoModel::HappyHorse1p0 => Some(CommonModelType::HappyHorse1p0), + RouterVideoModel::Sora2 => Some(CommonModelType::Sora2), + RouterVideoModel::Sora2Pro => Some(CommonModelType::Sora2Pro), + RouterVideoModel::Veo2 => Some(CommonModelType::Veo2), + RouterVideoModel::Veo3 => Some(CommonModelType::Veo3), + RouterVideoModel::Veo3Fast => Some(CommonModelType::Veo3Fast), + RouterVideoModel::Veo3p1 => Some(CommonModelType::Veo3p1), + RouterVideoModel::Veo3p1Fast => Some(CommonModelType::Veo3p1Fast), + RouterVideoModel::Veo3p1Lite => Some(CommonModelType::Veo3p1Lite), + RouterVideoModel::ViduQ3 => Some(CommonModelType::ViduQ3), + RouterVideoModel::ViduQ3Turbo => Some(CommonModelType::ViduQ3Turbo), + RouterVideoModel::Seedance2p0BytePlus => Some(CommonModelType::Seedance2p0BytePlus), + RouterVideoModel::Seedance2p0BytePlusFast => Some(CommonModelType::Seedance2p0BytePlusFast), + RouterVideoModel::Seedance2p0Ultra => Some(CommonModelType::Seedance2p0Ultra), + RouterVideoModel::Seedance2p0UltraFast => Some(CommonModelType::Seedance2p0UltraFast), + RouterVideoModel::Seedance2p0BytePlusUltra => Some(CommonModelType::Seedance2p0BytePlusUltra), + RouterVideoModel::Seedance2p0BytePlusUltraFast => Some(CommonModelType::Seedance2p0BytePlusUltraFast), + RouterVideoModel::Seedance2p0Mini => Some(CommonModelType::Seedance2p0Mini), + RouterVideoModel::Seedance2p0BytePlusMini => Some(CommonModelType::Seedance2p0BytePlusMini), + RouterVideoModel::Seedance2p0BytePlusUltraMini => Some(CommonModelType::Seedance2p0BytePlusUltraMini), + RouterVideoModel::PreviewModel => Some(CommonModelType::PreviewModel), + RouterVideoModel::PreviewModelFast => Some(CommonModelType::PreviewModelFast), + RouterVideoModel::GrokImagineVideo => Some(CommonModelType::GrokImagineVideo), + RouterVideoModel::GrokImagineVideo1p5 => Some(CommonModelType::GrokImagineVideo1p5), + // Higgsfield-only; storyteller-web has no prompt types for them. + RouterVideoModel::Seedance2p5 + | RouterVideoModel::Seedance2p5Edit + | RouterVideoModel::MinimaxH3 => None, + } +} + +fn provider_to_generation_provider(provider: RouterProvider) -> GenerationSource { + match provider { + RouterProvider::Artcraft => GenerationSource::Artcraft, + RouterProvider::Fal => GenerationSource::Fal, + RouterProvider::Grok => GenerationSource::Grok, + RouterProvider::Higgsfield => GenerationSource::Higgsfield, + RouterProvider::Midjourney => GenerationSource::Midjourney, + // Unused providers -> ArtCraft + RouterProvider::Seedance2Pro => GenerationSource::Artcraft , + RouterProvider::GmiCloud => GenerationSource::Artcraft, + RouterProvider::GrokApi => GenerationSource::Artcraft, + } +} + +fn router_aspect_ratio_to_enums(ar: RouterAspectRatio) -> EnumsAspectRatio { + match ar { + RouterAspectRatio::Auto => EnumsAspectRatio::Auto, + RouterAspectRatio::Square => EnumsAspectRatio::Square, + RouterAspectRatio::WideThreeByTwo => EnumsAspectRatio::WideThreeByTwo, + RouterAspectRatio::WideFourByThree => EnumsAspectRatio::WideFourByThree, + RouterAspectRatio::WideFiveByFour => EnumsAspectRatio::WideFiveByFour, + RouterAspectRatio::WideSixteenByNine => EnumsAspectRatio::WideSixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => EnumsAspectRatio::WideTwentyOneByNine, + RouterAspectRatio::TallTwoByThree => EnumsAspectRatio::TallTwoByThree, + RouterAspectRatio::TallThreeByFour => EnumsAspectRatio::TallThreeByFour, + RouterAspectRatio::TallFourByFive => EnumsAspectRatio::TallFourByFive, + RouterAspectRatio::TallNineBySixteen => EnumsAspectRatio::TallNineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => EnumsAspectRatio::TallNineByTwentyOne, + RouterAspectRatio::Wide => EnumsAspectRatio::Wide, + RouterAspectRatio::Tall => EnumsAspectRatio::Tall, + RouterAspectRatio::Auto2k => EnumsAspectRatio::Auto2k, + RouterAspectRatio::Auto3k => EnumsAspectRatio::Auto3k, + RouterAspectRatio::Auto4k => EnumsAspectRatio::Auto4k, + RouterAspectRatio::SquareHd => EnumsAspectRatio::SquareHd, + } +} + +fn router_resolution_to_enums(res: RouterResolution) -> EnumsResolution { + match res { + RouterResolution::OneK => EnumsResolution::OneK, + RouterResolution::TwoK => EnumsResolution::TwoK, + RouterResolution::ThreeK => EnumsResolution::ThreeK, + RouterResolution::FourK => EnumsResolution::FourK, + RouterResolution::HalfK => EnumsResolution::HalfK, + RouterResolution::FourEightyP => EnumsResolution::FourEightyP, + RouterResolution::SevenTwentyP => EnumsResolution::SevenTwentyP, + RouterResolution::TenEightyP => EnumsResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Standard, + provider: RouterProvider::Fal, + prompt: Some("a dog running on the beach".to_string()), + negative_prompt: None, + start_frame: None, + end_frame: None, + reference_images: None, + reference_videos: None, + reference_audio: None, + reference_character_tokens: None, + resolution: None, + aspect_ratio: None, + bitrate: None, + duration_seconds: None, + video_batch_count: None, + generate_audio: None, + request_mismatch_mitigation_strategy: + router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy::ErrorOut, + idempotency_token: None, + } + } + + #[test] + fn basic_conversion() { + let builder = base_builder(); + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.positive_prompt.as_deref(), Some("a dog running on the beach")); + assert_eq!(prompt.model_type, Some(CommonModelType::Kling3p0Standard)); + assert_eq!(prompt.generation_provider, Some(GenerationSource::Fal)); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Text)); + assert!(prompt.negative_prompt.is_none()); + assert!(prompt.maybe_aspect_ratio.is_none()); + assert!(prompt.maybe_resolution.is_none()); + assert!(prompt.maybe_batch_count.is_none()); + assert!(prompt.maybe_generate_audio.is_none()); + assert!(prompt.maybe_duration_seconds.is_none()); + } + + #[test] + fn with_video_fields() { + let builder = GenerateVideoRequestBuilder { + negative_prompt: Some("blurry".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::TenEightyP), + duration_seconds: Some(10), + video_batch_count: Some(2), + generate_audio: Some(true), + ..base_builder() + }; + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.negative_prompt.as_deref(), Some("blurry")); + assert_eq!(prompt.maybe_aspect_ratio, Some(EnumsAspectRatio::WideSixteenByNine)); + assert_eq!(prompt.maybe_resolution, Some(EnumsResolution::TenEightyP)); + assert_eq!(prompt.maybe_duration_seconds, Some(10)); + assert_eq!(prompt.maybe_batch_count, Some(2)); + assert_eq!(prompt.maybe_generate_audio, Some(true)); + } + + #[test] + fn text_mode_when_no_references() { + let builder = base_builder(); + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Text)); + } + + #[test] + fn keyframe_mode_with_start_frame() { + use router::api::image_ref::ImageRef; + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/frame.jpg".to_string())), + ..base_builder() + }; + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Keyframe)); + } + + #[test] + fn keyframe_mode_with_end_frame() { + use router::api::image_ref::ImageRef; + let builder = GenerateVideoRequestBuilder { + end_frame: Some(ImageRef::Url("https://example.com/frame.jpg".to_string())), + ..base_builder() + }; + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Keyframe)); + } + + #[test] + fn reference_mode_with_reference_images() { + use router::api::image_list_ref::ImageListRef; + let builder = GenerateVideoRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/ref.jpg".to_string()])), + ..base_builder() + }; + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Reference)); + } + + #[test] + fn keyframe_takes_priority_over_reference() { + use router::api::image_ref::ImageRef; + use router::api::image_list_ref::ImageListRef; + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/frame.jpg".to_string())), + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/ref.jpg".to_string()])), + ..base_builder() + }; + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.maybe_generation_mode, Some(CommonGenerationMode::Keyframe)); + } + + #[test] + fn video_model_mapping() { + let models = [ + (RouterVideoModel::Kling3p0Standard, CommonModelType::Kling3p0Standard), + (RouterVideoModel::Veo3, CommonModelType::Veo3), + (RouterVideoModel::Seedance2p0, CommonModelType::Seedance2p0), + (RouterVideoModel::Sora2, CommonModelType::Sora2), + ]; + for (router_model, expected) in models { + let builder = GenerateVideoRequestBuilder { model: router_model, ..base_builder() }; + let prompt = router_video_request_to_artcraft_prompt(&builder); + assert_eq!(prompt.model_type, Some(expected)); + } + } +} diff --git a/crates/artcraftx/src/commands/generate/common/tauri_media_source.rs b/crates/artcraftx/src/commands/generate/common/tauri_media_source.rs new file mode 100644 index 00000000..36b41928 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/common/tauri_media_source.rs @@ -0,0 +1,205 @@ +//! The Tauri bridge's three-way media source: reference media arrives from +//! the frontend as raw bytes, a local filesystem path, or an ArtCraft media +//! file token (a cloud-library pick). Local files and bytes never touch the +//! ArtCraft cloud unless the target provider itself requires it (ArtCraft +//! generations, and FAL — the one provider allowed to route through ArtCraft +//! uploads). + +use std::fmt::{Debug, Formatter}; +use std::path::PathBuf; + +use router::api::audio_ref::AudioRef; +use router::api::image_ref::ImageRef; +use router::api::media_bytes::MediaBytes; +use router::api::video_ref::VideoRef; +use serde_derive::Deserialize; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::generate_error::{BadInputReason, GenerateError}; + +/// One media reference from the frontend. +/// +/// Wire format (don't change without coordinating with the frontend): +/// `{"kind": "media_file_token", "token": "m_..."}`, +/// `{"kind": "local_path", "path": "/Users/..."}`, or +/// `{"kind": "bytes", "bytes": [...], "file_name": "photo.png"}`. +#[derive(Deserialize, Clone)] +#[serde(tag = "kind", rename_all = "snake_case")] +pub enum TauriMediaSource { + MediaFileToken { token: MediaFileToken }, + LocalPath { path: PathBuf }, + Bytes { + bytes: Vec, + #[serde(default)] + file_name: Option, + }, +} + +impl TauriMediaSource { + /// Reject unusable sources up front, before any provider work: a local + /// path must point at an existing regular file, and bytes must be + /// non-empty. + pub fn validate(&self) -> Result<(), GenerateError> { + match self { + Self::MediaFileToken { .. } => Ok(()), + Self::LocalPath { path } => { + if path.is_file() { + Ok(()) + } else { + Err(GenerateError::BadInput(BadInputReason::LocalMediaFileNotFound { path: path.clone() })) + } + } + Self::Bytes { bytes, .. } => { + if bytes.is_empty() { + Err(GenerateError::BadInput(BadInputReason::EmptyMediaBytes)) + } else { + Ok(()) + } + } + } + } + + pub fn maybe_media_file_token(&self) -> Option<&MediaFileToken> { + match self { + Self::MediaFileToken { token } => Some(token), + Self::LocalPath { .. } | Self::Bytes { .. } => None, + } + } + + pub fn into_image_ref(self) -> ImageRef { + match self { + Self::MediaFileToken { token } => ImageRef::MediaFileToken(token), + Self::LocalPath { path } => ImageRef::LocalPath(path), + Self::Bytes { bytes, file_name } => ImageRef::Bytes(media_bytes(bytes, file_name)), + } + } + + pub fn into_video_ref(self) -> VideoRef { + match self { + Self::MediaFileToken { token } => VideoRef::MediaFileToken(token), + Self::LocalPath { path } => VideoRef::LocalPath(path), + Self::Bytes { bytes, file_name } => VideoRef::Bytes(media_bytes(bytes, file_name)), + } + } + + pub fn into_audio_ref(self) -> AudioRef { + match self { + Self::MediaFileToken { token } => AudioRef::MediaFileToken(token), + Self::LocalPath { path } => AudioRef::LocalPath(path), + Self::Bytes { bytes, file_name } => AudioRef::Bytes(media_bytes(bytes, file_name)), + } + } +} + +// Manual impl: generate requests are logged at INFO; never dump the bytes. +impl Debug for TauriMediaSource { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::MediaFileToken { token } => f.debug_struct("MediaFileToken").field("token", token).finish(), + Self::LocalPath { path } => f.debug_struct("LocalPath").field("path", path).finish(), + Self::Bytes { bytes, file_name } => f.debug_struct("Bytes") + .field("bytes", &format_args!("<{} bytes>", bytes.len())) + .field("file_name", file_name) + .finish(), + } + } +} + +/// A source field wins over its legacy token twin; legacy tokens are folded +/// into sources so handlers only ever see [`TauriMediaSource`]. +pub fn merge_source_with_legacy_token( + maybe_source: Option, + maybe_legacy_token: Option, +) -> Option { + maybe_source.or_else(|| maybe_legacy_token.map(|token| TauriMediaSource::MediaFileToken { token })) +} + +/// List twin of [`merge_source_with_legacy_token`]. An empty legacy list is +/// treated like an absent one. +pub fn merge_sources_with_legacy_tokens( + maybe_sources: Option>, + maybe_legacy_tokens: Option>, +) -> Option> { + maybe_sources.or_else(|| { + let tokens = maybe_legacy_tokens?; + if tokens.is_empty() { + return None; + } + Some(tokens.into_iter().map(|token| TauriMediaSource::MediaFileToken { token }).collect()) + }) +} + +/// Validate every source a request carries; call once at command entry. +pub fn validate_sources<'a>(sources: impl IntoIterator) -> Result<(), GenerateError> { + for source in sources { + source.validate()?; + } + Ok(()) +} + +fn media_bytes(bytes: Vec, maybe_file_name: Option) -> MediaBytes { + match maybe_file_name { + Some(file_name) => MediaBytes::new(bytes).with_file_name(file_name), + None => MediaBytes::new(bytes), + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn wire_format_round_trip() { + let source: TauriMediaSource = serde_json::from_str(r#"{"kind":"media_file_token","token":"m_abc"}"#).unwrap(); + assert!(matches!(&source, TauriMediaSource::MediaFileToken { token } if token.as_str() == "m_abc")); + + let source: TauriMediaSource = serde_json::from_str(r#"{"kind":"local_path","path":"/tmp/a.png"}"#).unwrap(); + assert!(matches!(&source, TauriMediaSource::LocalPath { path } if path == &PathBuf::from("/tmp/a.png"))); + + let source: TauriMediaSource = serde_json::from_str(r#"{"kind":"bytes","bytes":[1,2,3]}"#).unwrap(); + assert!(matches!(&source, TauriMediaSource::Bytes { bytes, file_name: None } if bytes == &vec![1, 2, 3])); + + let source: TauriMediaSource = serde_json::from_str(r#"{"kind":"bytes","bytes":[1],"file_name":"a.png"}"#).unwrap(); + assert!(matches!(&source, TauriMediaSource::Bytes { file_name: Some(name), .. } if name == "a.png")); + } + + #[test] + fn debug_never_dumps_bytes() { + let source = TauriMediaSource::Bytes { bytes: vec![0; 100_000], file_name: Some("a.png".into()) }; + let debug = format!("{source:?}"); + assert!(debug.contains("<100000 bytes>")); + assert!(debug.len() < 200); + } + + #[test] + fn validation() { + assert!(TauriMediaSource::MediaFileToken { token: MediaFileToken::new_from_str("m_a") }.validate().is_ok()); + assert!(TauriMediaSource::Bytes { bytes: vec![1], file_name: None }.validate().is_ok()); + assert!(matches!( + TauriMediaSource::Bytes { bytes: vec![], file_name: None }.validate(), + Err(GenerateError::BadInput(BadInputReason::EmptyMediaBytes)), + )); + assert!(matches!( + TauriMediaSource::LocalPath { path: PathBuf::from("/definitely/not/real.png") }.validate(), + Err(GenerateError::BadInput(BadInputReason::LocalMediaFileNotFound { .. })), + )); + } + + #[test] + fn legacy_tokens_fold_into_sources() { + let token = MediaFileToken::new_from_str("m_x"); + let merged = merge_source_with_legacy_token(None, Some(token.clone())); + assert!(matches!(merged, Some(TauriMediaSource::MediaFileToken { .. }))); + + // A source field wins over its legacy twin. + let merged = merge_source_with_legacy_token( + Some(TauriMediaSource::LocalPath { path: PathBuf::from("/tmp/a.png") }), + Some(token.clone()), + ); + assert!(matches!(merged, Some(TauriMediaSource::LocalPath { .. }))); + + assert!(merge_sources_with_legacy_tokens(None, Some(vec![])).is_none()); + let merged = merge_sources_with_legacy_tokens(None, Some(vec![token])).unwrap(); + assert_eq!(merged.len(), 1); + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_audio/generate_audio_command.rs b/crates/artcraftx/src/commands/generate/generate_audio/generate_audio_command.rs new file mode 100644 index 00000000..eddb6d0f --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_audio/generate_audio_command.rs @@ -0,0 +1,126 @@ +use crate::commands::generate::common::notify_frontend_of_errors::notify_frontend_of_errors; +use crate::commands::generate::generate_error::GenerateError; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::generate_audio::handle_credential_router::handle_credential_router; +use crate::commands::generate::generate_audio::request::{ + TauriGenerateAudioErrorType, TauriGenerateAudioRequest, TauriGenerateAudioResponse, +}; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::Response; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::credits_balance_changed_event::CreditsBalanceChangedEvent; +use crate::events::generation_events::generation_enqueue_success_event::GenerationEnqueueSuccessEvent; + + +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::database::task_database::TaskDatabase; +use log::{error, info}; +use tauri::{AppHandle, State}; + +#[tauri::command] +pub async fn generate_audio_command( + request: TauriGenerateAudioRequest, + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + task_database: State<'_, TaskDatabase>, + local_files_database: State<'_, LocalFilesDatabase>, +) -> Response { + + info!("generate_audio_command called, request: {:?}", request); + + let ledger = AssetUploadLedger::new(local_files_database.inner().clone()); + let result = handle_request( + request, + &app_data_root, + &task_database, + &ledger, + ).await; + + match result { + Err(err) => { + error!("generate_audio_command error: {:?}", err); + + notify_frontend_of_errors(&app, &err).await; + + let mut status = CommandErrorStatus::ServerError; + let mut error_type = TauriGenerateAudioErrorType::ServerError; + let mut error_message = "A server error occurred. Please try again. If it continues, please tell our staff about the problem.".to_string(); + + match err { + GenerateError::BadInput(_) => { + status = CommandErrorStatus::BadRequest; + error_type = TauriGenerateAudioErrorType::ModelNotSpecified; + error_message = "No model specified for audio generation".to_string(); + } + GenerateError::CredentialProblem(reason) => { + status = CommandErrorStatus::Unauthorized; + error_type = TauriGenerateAudioErrorType::CredentialProblem; + error_message = reason.user_message(); + } + GenerateError::NotYetImplemented(message) => { + error_message = message; + } + GenerateError::ProviderRejected(message) => { + // The provider refused for a reason the user can act on; the + // message already explains it. + status = CommandErrorStatus::BadRequest; + error_message = message; + } + _ => {}, // Fall-through + } + + Err(CommandErrorResponseWrapper { + status, + error_message: Some(error_message), + error_type: Some(error_type), + error_details: None, + }) + } + Ok(event) => { + let event = GenerationEnqueueSuccessEvent { + action: event.to_frontend_event_action(), + service: event.to_frontend_event_service(), + model: event.model, + }; + + if let Err(err) = event.send(&app) { + error!("Failed to emit event: {:?}", err); + } + + CreditsBalanceChangedEvent{}.send_infallible(&app); + + Ok(TauriGenerateAudioResponse {}.into()) + } + } +} + +async fn handle_request( + request: TauriGenerateAudioRequest, + app_data_root: &AppDataRoot, + task_database: &TaskDatabase, + ledger: &AssetUploadLedger, +) -> Result { + + // Generation is credential-driven: the request names a stored credential, + // and the router dispatches to that credential's service. + let success_event = handle_credential_router(&request, app_data_root, ledger).await?; + + let result = success_event + .insert_into_task_database_with_frontend_payload( + task_database, + request.frontend_caller, + request.frontend_subscriber_id.as_deref(), + request.frontend_subscriber_payload.as_deref(), + ) + .await; + + if let Err(err) = result { + error!("Failed to create task in database: {:?}", err); + } + + // NB: The usage tracker has no audio method yet. + + Ok(success_event) +} diff --git a/crates/artcraftx/src/commands/generate/generate_audio/handle_credential_router.rs b/crates/artcraftx/src/commands/generate/generate_audio/handle_credential_router.rs new file mode 100644 index 00000000..2fd86816 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_audio/handle_credential_router.rs @@ -0,0 +1,155 @@ +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{info, warn}; +use router::api::router_provider::RouterProvider; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::client::router_artcraft_client::RouterArtcraftClient; +use router::client::router_client::RouterClient; +use router::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use router::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use router::api::audio_list_ref::AudioListRef; +use router::api::image_list_ref::ImageListRef; + +use crate::commands::utils::api_adapters::models::audio::tauri_audio_model_to_generation_model::tauri_audio_model_to_generation_model; +use crate::commands::utils::api_adapters::models::audio::tauri_audio_model_to_router_model::tauri_audio_model_to_router_model; +use crate::commands::generate::generate_error::GenerateError; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::common::generation_credential::{credential_not_usable, resolve_generation_credential, storyteller_creds_from_credential}; +use crate::commands::generate::common::media_source_conversion::{sources_to_artcraft_tokens, ArtcraftMediaKind}; +use crate::commands::generate::common::tauri_media_source::validate_sources; +use crate::commands::generate::generate_audio::request::TauriGenerateAudioRequest; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; +use crate::credentials::auth_credential::AuthCredential; +use crate::state::data_dir::app_data_root::AppDataRoot; + +/// Credential-driven audio generation: resolve the stored credential named +/// by the request's `credential_id`, then route to that credential's service +/// via the router. The router owns upload + dispatch mechanics per provider. +pub async fn handle_credential_router( + request: &TauriGenerateAudioRequest, + app_data_root: &AppDataRoot, + ledger: &AssetUploadLedger, +) -> Result { + // Reject unusable media sources (missing local files, empty bytes) before + // any provider work. + validate_sources(request.audio_media_sources().iter().flatten())?; + validate_sources(request.image_media_sources().iter().flatten())?; + + let credential = resolve_generation_credential( + request.credential_id.as_deref(), + app_data_root, + )?; + + info!( + "handle_credential_router (audio): credential={} service={}", + credential.id.as_str(), + credential.service, + ); + + match credential.service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies => { + handle_artcraft_credential(request, &credential, ledger).await + } + other => Err(credential_not_usable( + &credential, + &format!("accounts for service {} can't generate audio yet", other), + )), + } +} + +/// Generate via the router's Artcraft provider, authenticating with the +/// stored session cookies. Artcraft's API is token-native; local files and +/// bytes upload to ArtCraft here, at generate time. +async fn handle_artcraft_credential( + request: &TauriGenerateAudioRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_audio_model_to_router_model(tauri_model); + let generation_model = tauri_audio_model_to_generation_model(tauri_model); + + let api_host = maybe_artcraft_api_host_for_service(credential.service) + .expect("caller only routes ArtCraft services here"); + + let creds = storyteller_creds_from_credential(credential)?; + + let audio_references = sources_to_artcraft_tokens( + request.audio_media_sources(), ArtcraftMediaKind::Audio, Some(&creds), &api_host, ledger, + ).await?.map(AudioListRef::MediaFileTokens); + let image_references = sources_to_artcraft_tokens( + request.image_media_sources(), ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger, + ).await?.map(ImageListRef::MediaFileTokens); + + let client = RouterClient::Artcraft(RouterArtcraftClient::new( + api_host, + creds, + )); + + let router_request = GenerateAudioRequestBuilder { + model: router_model, + provider: RouterProvider::Artcraft, + prompt: request.prompt.clone(), + style_prompt: request.style_prompt.clone(), + audio_references, + image_references, + keep_lyrics: request.keep_lyrics, + is_instrumental: request.is_instrumental, + is_loopable: request.is_loopable, + bpm: request.bpm, + musical_key: request.musical_key, + sample_rate_hz: request.sample_rate_hz, + speed: request.speed, + volume: request.volume, + pitch: request.pitch, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + idempotency_token: None, + }; + + info!("Building Artcraft audio generation plan: model={:?}", router_model); + + let generation_request = match router_request.build2() { + Ok(AudioGenerationDraftOrRequest::Request(generation_request)) => generation_request, + Ok(AudioGenerationDraftOrRequest::Draft(draft)) => { + warn!("Artcraft build unexpectedly produced a draft: {:?}", draft); + return Err(GenerateError::NotYetImplemented( + "Artcraft requests should not require a draft phase".to_string(), + )); + } + Err(err) => { + warn!("Could not build Artcraft router request: {:?}", err); + return Err(err.into()); + } + }; + + let response = generation_request.send_request(&client).await + .map_err(|err| { + warn!("Artcraft router audio generation failed: {:?}", err); + GenerateError::from(err) + })?; + + let payload = response.get_artcraft_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!( + "Router audio generation enqueued: inference_job_token={}, all_tokens={:?}, response={:?}", + payload.inference_job_token.as_str(), + payload.all_inference_job_tokens, + response, + ); + + Ok(TaskEnqueueSuccess { + task_type: TaskType::AudioGeneration, + model: Some(generation_model), + provider: GenerationSource::Artcraft, + provider_job_id: Some(payload.inference_job_token.to_string()), + is_batch_generation: false, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} diff --git a/crates/artcraftx/src/commands/generate/generate_audio/mod.rs b/crates/artcraftx/src/commands/generate/generate_audio/mod.rs new file mode 100644 index 00000000..b9ace028 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_audio/mod.rs @@ -0,0 +1,3 @@ +pub mod generate_audio_command; +mod handle_credential_router; +pub mod request; diff --git a/crates/artcraftx/src/commands/generate/generate_audio/request.rs b/crates/artcraftx/src/commands/generate/generate_audio/request.rs new file mode 100644 index 00000000..a90735bd --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_audio/request.rs @@ -0,0 +1,128 @@ +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use serde_derive::{Deserialize, Serialize}; +use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::tauri_media_source::{merge_sources_with_legacy_tokens, TauriMediaSource}; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +// ── Request ── + +#[derive(Deserialize, Debug)] +pub struct TauriGenerateAudioRequest { + /// Stable id (`credential_{entropy}`) of the stored credential (account) + /// to generate with. Loaded from disk; generation routes to the + /// credential's service. + pub credential_id: Option, + + /// The model to use. + pub model: Option, + + /// Text prompt. + pub prompt: Option, + + /// Style/genre prompt (Suno's "tags"). + pub style_prompt: Option, + + /// Reference audio (already uploaded). + pub audio_media_tokens: Option>, + + /// Reference images (already uploaded). + pub image_media_tokens: Option>, + + /// Three-way reference audio (bytes | local path | media token). Wins + /// over `audio_media_tokens` when both are set. + pub audio_sources: Option>, + + /// Three-way reference images (bytes | local path | media token). Wins + /// over `image_media_tokens` when both are set. + pub image_sources: Option>, + + /// Keep the original lyrics (Suno Remix). + pub keep_lyrics: Option, + + /// Instrumental-only toggle (Suno Music / Sample). + pub is_instrumental: Option, + + /// Loopable vs single-hit toggle (Suno Sounds). + pub is_loopable: Option, + + /// Target BPM (Suno Sounds). + pub bpm: Option, + + /// Musical key (Suno Sounds). + pub musical_key: Option, + + /// Sample rate in Hz (Seed Audio). + pub sample_rate_hz: Option, + + /// Playback speed (Seed Audio, 0.5–2.0). + pub speed: Option, + + /// Volume (Seed Audio, 0.5–2.0). + pub volume: Option, + + /// Pitch shift in semitones (Seed Audio, -12..=12). + pub pitch: Option, + + // ── Frontend metadata ── + + /// Name of the frontend caller. + pub frontend_caller: Option, + + /// A frontend-defined identifier sent back as a Tauri event on task completion. + pub frontend_subscriber_id: Option, + + /// A frontend-defined payload sent back as a Tauri event on task completion. + pub frontend_subscriber_payload: Option, +} + +impl TauriGenerateAudioRequest { + /// Reference audio, normalized: `audio_sources` wins, legacy tokens fold in. + pub fn audio_media_sources(&self) -> Option> { + merge_sources_with_legacy_tokens(self.audio_sources.clone(), self.audio_media_tokens.clone()) + } + + /// Reference images, normalized: `image_sources` wins, legacy tokens fold in. + pub fn image_media_sources(&self) -> Option> { + merge_sources_with_legacy_tokens(self.image_sources.clone(), self.image_media_tokens.clone()) + } +} + +/// The audio models the frontend can request, identified by their omni +/// model ids (`CommonAudioModel` serde strings). +#[derive(Clone, Copy, Debug, Deserialize)] +pub enum TauriAudioModel { + #[serde(rename = "suno_music")] + SunoMusic, + #[serde(rename = "suno_remix")] + SunoRemix, + #[serde(rename = "suno_sounds")] + SunoSounds, + #[serde(rename = "suno_sample")] + SunoSample, + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, +} + +// ── Response ── + +#[derive(Serialize)] +pub struct TauriGenerateAudioResponse { +} + +impl SerializeMarker for TauriGenerateAudioResponse {} + +// ── Error ── + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum TauriGenerateAudioErrorType { + /// Caller didn't specify a model + ModelNotSpecified, + /// Generic server error + ServerError, + /// Problem with the selected account credential (absent, unknown, or + /// unusable). The backend also flashes a dismissable modal. + CredentialProblem, +} diff --git a/crates/artcraftx/src/commands/generate/generate_error.rs b/crates/artcraftx/src/commands/generate/generate_error.rs new file mode 100644 index 00000000..0381e355 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_error.rs @@ -0,0 +1,322 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use anyhow::anyhow; +use router::errors::artcraft_router_error::ArtcraftRouterError; +use router::errors::provider_error::ProviderError; +use base64::DecodeError; +use core_types::enums::generation_source::GenerationSource; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use errors::AnyhowError; +use grok_consumer_client::error::grok_error::GrokError; +use higgsfield_client::error::higgsfield_error::HiggsfieldError; +use midjourney_client::error::midjourney_error::MidjourneyError; +use artcraft_client::error::storyteller_error::StorytellerError; +use router::errors::download_error::DownloadError; +//use fal_client::error::fal_error_plus::FalErrorPlus; + +#[derive(Debug)] +pub enum GenerateError { + BadInput(BadInputReason), + MissingCredentials(MissingCredentialsReason), + /// Problem with the stored credential named by the request + /// (`credential_id`): absent, unknown, or unusable. + CredentialProblem(CredentialProblemReason), + ProviderFailure(ProviderFailureReason), + + /// We couldn't find a provider to dispatch the request to. + NoProviderAvailable, + + /// We pulled out Fal (for now) - it's impacting build speeds. We'll add it in the future. + FalNoLongerSupported, + + /// Wrong provider for the model + BadProviderForModel { + provider: GenerationSource, + model: CommonModelType, + }, + + /// If the response didn't contain job tokens to track. + ResponseHadNoJobTokens, + + /// Issue with Artcraft router downloads + ArtcraftRouterDownloadError(DownloadError), + + /// A provider we don't support yet in ArtCraft "the Tauri app" part. + ArtcraftRouterNotYetSupportedProvider(&'static str), + + /// There was a billing, credits, or payments issue. + BillingIssue(BillingIssueReason), + + /// The feature is not yet implemented. + NotYetImplemented(String), + + /// The provider accepted the request but rejected it with a user-facing + /// message (e.g. Midjourney "subscription_required", a banned prompt). + ProviderRejected(String), + + // Misc error buckets + AnyhowError(AnyhowError), + DecodeError(DecodeError), + IoError(std::io::Error), +} + +#[derive(Debug)] +pub enum BadInputReason { + Base64DecodeError, + BothImageMaskMediaTokenAndBytesSupplied, + CannotDetermineImageMimeType, + /// A `local_path` media source doesn't point at an existing regular file. + LocalMediaFileNotFound { path: std::path::PathBuf }, + /// A `bytes` media source arrived empty. + EmptyMediaBytes, + InvalidNumberOfInputImages { + provided: u32, + min: u32, + max: u32, + }, + InvalidNumberOfRequestedImages { + requested: u32, + min: u32, + max: u32, + }, + NoModelSpecified, + RequiredSourceImageMaskNotProvided, + RequiredSourceImageNotProvided, + WrongImageArguments(String), +} + +#[derive(Debug)] +pub enum CredentialProblemReason { + /// The request didn't name a credential (no account selected). + NoCredentialSupplied, + /// The named credential doesn't exist on disk. + CredentialNotFound { credential_id: String }, + /// The credential exists but can't serve this request. + CredentialNotUsable { credential_id: String, reason: String }, + /// The provider rejected the credential's session; only a fresh browser + /// login fixes it. The credential file is marked (see + /// `CookieCredential::relogin_required_since`) so nothing retries the API + /// until the user logs in again. + SessionExpired { credential_id: String, service: GenerationSource }, +} + +impl CredentialProblemReason { + /// What to tell the user. Shared by the generate commands' error responses + /// and the credential-error modal so both say the same thing. + pub fn user_message(&self) -> String { + match self { + Self::NoCredentialSupplied => { + "No account selected. Pick an account in the account selector, \ + or add one in Settings → Accounts.".to_string() + } + Self::CredentialNotFound { credential_id } => format!( + "The selected account no longer exists (credential {}). \ + Pick another account and try again.", + credential_id, + ), + Self::CredentialNotUsable { reason, .. } => { + format!("The selected account can't be used for this request: {}", reason) + } + Self::SessionExpired { service, .. } => format!( + "Your session has expired and {} needs you to login again.", + service_display_name(*service), + ), + } + } +} + +/// The provider name as users know it, for messages. +fn service_display_name(service: GenerationSource) -> &'static str { + match service { + GenerationSource::Higgsfield | GenerationSource::HiggsfieldCookies => "Higgsfield", + GenerationSource::Grok | GenerationSource::GrokCookies | GenerationSource::XAiApi => "Grok", + GenerationSource::Midjourney | GenerationSource::MidjourneyCookies => "Midjourney", + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies + | GenerationSource::ArtcraftApi => "ArtCraft", + GenerationSource::Fal | GenerationSource::FalApi => "Fal", + GenerationSource::MagnificCookies => "Magnific", + GenerationSource::OpenArtCookies => "OpenArt", + GenerationSource::RunwayCookies => "Runway", + GenerationSource::OpenAiApi => "OpenAI", + GenerationSource::ReplicateApi => "Replicate", + GenerationSource::WorldLabs | GenerationSource::WorldLabsCookies => "World Labs", + } +} + +#[derive(Debug)] +pub enum MissingCredentialsReason { + NeedsGrokCredentials, + NeedsFalApiKey, + NeedsMidjourneyCredentials, + NeedsMidjourneyUserId, + NeedsMidjourneyUserInfo, + NeedsStorytellerCredentials, +} + +#[derive(Debug)] +pub struct BillingIssueReason { + pub provider: BillingProvider, +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] +pub enum BillingProvider { + Artcraft, + Fal, + Higgsfield, + Kinovi, + Midjourney, +} + +#[derive(Debug)] +pub enum ProviderFailureReason { + GrokError(GrokError), + /// NB: The Grok client doesn't say why certain errors (eg. missing fields) happen, so we synthesize this. + GrokJobEnqueueFailed, + //Fal(FalErrorPlus), + /// First-party Higgsfield failed. `needs_browser_reauth()` on the inner + /// error means the user has to log into Higgsfield again. + HiggsfieldError(HiggsfieldError), + MidjourneyError(MidjourneyError), + /// NB: The midjourney client doesn't categorize all errors, so we have to do so on our end. + MidjourneyJobEnqueueFailed, + StorytellerError(StorytellerError), +} + +impl GenerateError { + + // + // Bad input + // + + pub fn both_image_mask_media_token_and_bytes_supplied() -> Self { + Self::BadInput(BadInputReason::BothImageMaskMediaTokenAndBytesSupplied) + } + + pub fn no_model_specified() -> Self { + Self::BadInput(BadInputReason::NoModelSpecified) + } + + pub fn required_source_image_mask_not_provided() -> Self { + Self::BadInput(BadInputReason::RequiredSourceImageMaskNotProvided) + } + + pub fn required_source_image_not_provided() -> Self { + Self::BadInput(BadInputReason::RequiredSourceImageNotProvided) + } + + // + // Missing credentials + // + + pub fn needs_fal_api_key() -> Self { + Self::MissingCredentials(MissingCredentialsReason::NeedsFalApiKey) + } + + pub fn needs_grok_credentials() -> Self { + Self::MissingCredentials(MissingCredentialsReason::NeedsGrokCredentials) + } + + pub fn needs_midjourney_credentials() -> Self { + Self::MissingCredentials(MissingCredentialsReason::NeedsMidjourneyCredentials) + } + + pub fn needs_storyteller_credentials() -> Self { + Self::MissingCredentials(MissingCredentialsReason::NeedsStorytellerCredentials) + } +} + +impl From for GenerateError { + fn from(value: AnyhowError) -> Self { + Self::AnyhowError(value) + } +} + +impl From for GenerateError { + fn from(value: ArtcraftXError) -> Self { + match value { + ArtcraftXError::AnyhowError(e) => Self::AnyhowError(e), + ArtcraftXError::CredentialError(e) => Self::AnyhowError(anyhow!("AuthCredential error: {}", e)), + ArtcraftXError::DecodeError(e) => Self::DecodeError(e), + ArtcraftXError::IoError(e) => Self::IoError(e), + ArtcraftXError::GrokError(e) => Self::ProviderFailure(ProviderFailureReason::GrokError(e)), + ArtcraftXError::StorytellerError(e) => Self::ProviderFailure(ProviderFailureReason::StorytellerError(e)), + ArtcraftXError::RwLockReadError => Self::AnyhowError(anyhow!("Lock read error")), + ArtcraftXError::RwLockWriteError => Self::AnyhowError(anyhow!("Lock write error")), + ArtcraftXError::MutexLockError => Self::AnyhowError(anyhow!("Mutex lock error")), + ArtcraftXError::ReqwestError(err) => Self::AnyhowError(anyhow!("Reqwest error: {:?}", err)), + ArtcraftXError::BadDownloadFilename { path } => Self::AnyhowError(anyhow!("Bad download file name: {:?}", path)), + ArtcraftXError::CannotDownloadFilePathAlreadyExists { path } => Self::AnyhowError(anyhow!("Cannot download already existing file: {:?}", path)), + } + } +} + +//impl From for GenerateError { +// fn from(value: FalErrorPlus) -> Self { +// Self::ProviderFailure(ProviderFailureReason::Fal(value)) +// } +//} + +impl From for GenerateError { + fn from(value: GrokError) -> Self { + Self::ProviderFailure(ProviderFailureReason::GrokError(value)) + } +} + +impl From for GenerateError { + fn from(value: HiggsfieldError) -> Self { + Self::ProviderFailure(ProviderFailureReason::HiggsfieldError(value)) + } +} + +impl From for GenerateError { + fn from(value: MidjourneyError) -> Self { + Self::ProviderFailure(ProviderFailureReason::MidjourneyError(value)) + } +} + +impl From for GenerateError { + fn from(value: StorytellerError) -> Self { + Self::ProviderFailure(ProviderFailureReason::StorytellerError(value)) + } +} + +impl From for GenerateError { + fn from(value: ArtcraftRouterError) -> Self { + match value { + ArtcraftRouterError::Client(e) => Self::BadInput(BadInputReason::WrongImageArguments(e.to_string())), + ArtcraftRouterError::Download(e) => Self::ArtcraftRouterDownloadError(e), + ArtcraftRouterError::InvalidInput(msg) => Self::BadInput(BadInputReason::WrongImageArguments(msg)), + ArtcraftRouterError::ProviderBillingError(err) => { + let provider = match err { + ProviderError::Fal(_) => BillingProvider::Fal, + ProviderError::Seedance2Pro(_) => BillingProvider::Kinovi, + ProviderError::Midjourney(_) + | ProviderError::MidjourneySubscriptionRequired(_) + | ProviderError::MidjourneySubmitRejected(_) => BillingProvider::Midjourney, + ProviderError::Storyteller(_) => BillingProvider::Artcraft, + ProviderError::GmiCloud(_) => BillingProvider::Artcraft, + ProviderError::GrokApi(_) => BillingProvider::Artcraft, + ProviderError::Grok(_) => BillingProvider::Artcraft, + ProviderError::Higgsfield(_) => BillingProvider::Higgsfield, + }; + Self::BillingIssue(BillingIssueReason { provider }) + }, + ArtcraftRouterError::Provider(ProviderError::Storyteller(e)) => Self::ProviderFailure(ProviderFailureReason::StorytellerError(e)), + ArtcraftRouterError::Provider(ProviderError::Fal(_)) => Self::FalNoLongerSupported, + ArtcraftRouterError::Provider(ProviderError::GmiCloud(_)) => Self::ArtcraftRouterNotYetSupportedProvider("gmicloud"), + ArtcraftRouterError::Provider(ProviderError::GrokApi(_)) => Self::ArtcraftRouterNotYetSupportedProvider("grok_api"), + // First-party (cookie-session) Grok Imagine websocket/POST failure. The string carries the raw detail. + ArtcraftRouterError::Provider(ProviderError::Grok(message)) => Self::ProviderRejected(message), + // First-party (cookie-session) Higgsfield. + ArtcraftRouterError::Provider(ProviderError::Higgsfield(e)) => Self::ProviderFailure(ProviderFailureReason::HiggsfieldError(e)), + ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(_)) => Self::ArtcraftRouterNotYetSupportedProvider("seedance2pro"), + ArtcraftRouterError::Provider(ProviderError::Midjourney(e)) => Self::ProviderFailure(ProviderFailureReason::MidjourneyError(e)), + ArtcraftRouterError::Provider(ProviderError::MidjourneySubscriptionRequired(message)) => Self::ProviderRejected(message), + ArtcraftRouterError::Provider(ProviderError::MidjourneySubmitRejected(message)) => Self::ProviderRejected(message), + ArtcraftRouterError::UnsupportedModel(model) => Self::NotYetImplemented(format!("Unsupported model: {}", model)), + ArtcraftRouterError::UnsupportedProviderAndModelForNewApi(_message) => Self::ArtcraftRouterNotYetSupportedProvider("unsupported model for new router API"), + ArtcraftRouterError::ProviderResponseInvalid(message) => Self::ProviderRejected(message), + } + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/enqueue_image_generation.rs b/crates/artcraftx/src/commands/generate/generate_image/enqueue_image_generation.rs new file mode 100644 index 00000000..4edd361e --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/enqueue_image_generation.rs @@ -0,0 +1,701 @@ +use artcraft_client::utils::api_host::ApiHost; +use chrono::Utc; +use core_types::enums::generation_source::GenerationSource; +use log::{error, info, warn}; +use midjourney_client::recipes::get_user_info::{get_user_info, GetUserInfoArgs}; +use router::api::image_list_ref::ImageListRef; +use router::api::router_image_model::RouterImageModel; +use router::api::router_provider::RouterProvider; +use router::client::generation_mode_mismatch_strategy::GenerationModeMismatchStrategy; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::client::router_artcraft_client::RouterArtcraftClient; +use router::client::router_client::RouterClient; +use router::client::router_fal_client::RouterFalClient; +use router::client::router_grok_client::RouterGrokClient; +use router::client::router_midjourney_client::RouterMidjourneyClient; +use router::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use router::generate::generate_image::generate_image_response::GenerateImageResponse; +use router::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use router::errors::artcraft_router_error::ArtcraftRouterError; +use router::generate::generate_image::image_generation_request::ImageGenerationRequest; +use grok_consumer_client::endpoint_bindings::generate_image_websocket::grok_generate_image_websocket::GrokImageWebsocket; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::generation_credential::{ + credential_not_usable, resolve_generation_credential, storyteller_creds_from_credential, +}; +use crate::commands::generate::common::media_source_conversion::{ + image_sources_to_fal_urls, sources_to_artcraft_tokens, ArtcraftMediaKind, +}; +use crate::commands::generate::common::tauri_media_source::validate_sources; +use crate::commands::generate::generate_error::{BadInputReason, GenerateError}; +use crate::commands::generate::generate_image::higgsfield::enqueue_via_higgsfield::enqueue_via_higgsfield; +use crate::commands::generate::generate_image::tauri_generate_image_request::TauriGenerateImageRequest; +use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; +use crate::commands::generate::generate_image::utils::convert_enums_to_router::{ + convert_aspect_ratio, convert_quality, convert_resolution, +}; +use crate::commands::generate::generate_image::utils::map_media_files_to_urls::map_media_file_tokens_to_cdn_urls; +use crate::commands::generate::generate_image::utils::parse_semantic_media_files::{ + parse_semantic_media_files, SemanticMediaFiles, +}; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::utils::api_adapters::models::image::tauri_image_model_to_generation_model::tauri_image_model_to_generation_model; +use crate::commands::utils::api_adapters::models::image::tauri_image_model_to_router_model::tauri_image_model_to_router_model; +use crate::credentials::auth_credential::AuthCredential; +use crate::credentials::find_service_credentials::find_first_credential_for_service; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::services::grok::state::grok_websockets::GrokWebsockets; +use crate::services::grok::util::refresh_grok_statsig::{refresh_grok_statsig_blocking, GrokStatsigRefreshOutcome}; +use crate::services::midjourney::state::midjourney_live_session::MidjourneyLiveSession; +use crate::services::midjourney::utils::extract_midjourney_user_id_from_cookies::extract_midjourney_user_id_from_cookie_header; +use crate::services::midjourney::utils::midjourney_browser_profile::midjourney_browser_profile; +use crate::state::data_dir::app_data_root::AppDataRoot; +use tauri::AppHandle; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; + +/// Credential-driven image generation: resolve the stored credential named by +/// the request's `credential_id`, then invoke the router for that credential's +/// service. This is the single enqueue entry point — there is no separate +/// per-provider "handler" layer. +pub async fn enqueue_image_generation( + request: &TauriGenerateImageRequest, + app: &AppHandle, + app_data_root: &AppDataRoot, + mj_session: &MidjourneyLiveSession, + grok_websockets: &GrokWebsockets, + ledger: &AssetUploadLedger, +) -> Result { + // Reject unusable media sources (missing local files, empty bytes) before + // any provider work. + validate_sources(request.reference_media_sources().iter().flatten())?; + + let credential = resolve_generation_credential(request.credential_id.as_deref(), app_data_root)?; + let credential = maybe_reroute_grok_model_to_grok_credential(request, credential, app_data_root)?; + + info!( + "enqueue_image_generation: credential={} service={}", + credential.id.as_str(), + credential.service, + ); + + match credential.service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies => enqueue_via_artcraft(request, &credential, ledger).await, + + GenerationSource::FalApi => { + let api_key = credential.api_key().ok_or_else(|| { + credential_not_usable(&credential, "the FAL credential has no API key") + })?; + enqueue_via_fal(request, &api_key.api_key, app_data_root, ledger).await + } + + GenerationSource::MidjourneyCookies | GenerationSource::Midjourney => { + enqueue_via_midjourney(request, &credential, mj_session).await + } + + GenerationSource::GrokCookies | GenerationSource::Grok => { + enqueue_via_grok(request, app, app_data_root, &credential, grok_websockets).await + } + + GenerationSource::HiggsfieldCookies | GenerationSource::Higgsfield => { + enqueue_via_higgsfield(Some(app), request, &credential, ledger).await + } + + other => Err(credential_not_usable( + &credential, + &format!("accounts for service {} can't generate images yet", other), + )), + } +} + +// ── Artcraft ── + +/// Generate via the router's Artcraft provider, authenticating with the stored +/// session cookies. Raw canvas/scene/mask bytes are uploaded to ArtCraft first +/// (with the same credential) so the router request only carries media tokens. +async fn enqueue_via_artcraft( + request: &TauriGenerateImageRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_image_model_to_router_model(tauri_model).ok_or( + GenerateError::NotYetImplemented(format!( + "Model {:?} can't be generated with this account yet", + tauri_model + )), + )?; + + let api_host = maybe_artcraft_api_host_for_service(credential.service) + .expect("caller only routes ArtCraft services here"); + + let creds = storyteller_creds_from_credential(credential)?; + + // Upload any raw image bytes before the generate request. Local-file / + // bytes references also upload here: ArtCraft's API is token-native and + // the media must reach ArtCraft anyway. + let semantic_media_files = parse_semantic_media_files(request, &creds, &api_host).await?; + let reference_tokens = sources_to_artcraft_tokens( + request.reference_media_sources(), ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger, + ).await?; + let image_inputs = collect_artcraft_image_inputs(&semantic_media_files, reference_tokens); + + let router_request = GenerateImageRequestBuilder { + model: router_model, + provider: RouterProvider::Artcraft, + prompt: request.prompt.clone(), + image_inputs, + resolution: request.resolution.map(convert_resolution), + aspect_ratio: request.aspect_ratio.map(convert_aspect_ratio), + quality: request.quality.map(convert_quality), + image_batch_count: request.batch_size.map(|n| n as u16), + horizontal_angle: request.adjust_horizontal_angle, + vertical_angle: request.adjust_vertical_angle, + zoom: request.adjust_zoom, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + }; + + let client = RouterClient::Artcraft(RouterArtcraftClient::new(api_host, creds)); + let generation_request = build_direct_request(router_request, "Artcraft")?; + + let response = generation_request.send_request(&client).await.map_err(|err| { + warn!("Artcraft router image generation failed: {:?}", err); + GenerateError::from(err) + })?; + + let payload = response + .get_artcraft_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + Ok(TaskEnqueueSuccess { + task_type: TaskType::ImageGeneration, + model: Some(tauri_image_model_to_generation_model(tauri_model)), + provider: GenerationSource::Artcraft, + provider_job_id: Some(payload.inference_job_token.to_string()), + is_batch_generation: request.batch_size.unwrap_or(1) > 1, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} + +/// Reference images for the Artcraft router request: canvas first, then scene, +/// then the un-semantic reference images (already resolved to tokens). +fn collect_artcraft_image_inputs( + semantic_media_files: &SemanticMediaFiles, + reference_tokens: Option>, +) -> Option { + let mut tokens: Vec = Vec::new(); + + if let Some(canvas_token) = &semantic_media_files.canvas_image_media_token { + tokens.push(canvas_token.clone()); + } + if let Some(scene_token) = &semantic_media_files.scene_image_media_token { + tokens.push(scene_token.clone()); + } + tokens.extend(reference_tokens.unwrap_or_default()); + + if tokens.is_empty() { + None + } else { + Some(ImageListRef::MediaFileTokens(tokens)) + } +} + +// ── Fal ── + +/// Generate via the router's FAL provider using a stored FAL API key. FAL only +/// accepts URLs, so media tokens resolve to CDN URLs — and local files / raw +/// bytes upload to ArtCraft first to get one (FAL is the ONLY non-ArtCraft +/// provider allowed to route local media through the ArtCraft cloud). +async fn enqueue_via_fal( + request: &TauriGenerateImageRequest, + api_key: &str, + app_data_root: &AppDataRoot, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_image_model_to_router_model(tauri_model).ok_or( + GenerateError::NotYetImplemented(format!( + "Model {:?} is not supported via the FAL router path", + tauri_model + )), + )?; + + let image_inputs = resolve_fal_image_inputs(request, &ApiHost::Storyteller, app_data_root, ledger).await?; + + let router_request = GenerateImageRequestBuilder { + model: router_model, + provider: RouterProvider::Fal, + prompt: request.prompt.clone(), + image_inputs, + resolution: request.resolution.map(convert_resolution), + aspect_ratio: request.aspect_ratio.map(convert_aspect_ratio), + quality: request.quality.map(convert_quality), + image_batch_count: request.batch_size.map(|n| n as u16), + horizontal_angle: request.adjust_horizontal_angle, + vertical_angle: request.adjust_vertical_angle, + zoom: request.adjust_zoom, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + }; + + let client = RouterClient::Fal(RouterFalClient::new_polling_only_from_raw_key(api_key)); + let generation_request = build_direct_request(router_request, "FAL")?; + + let response = generation_request.send_request(&client).await.map_err(|err| { + warn!("FAL image generation failed: {:?}", err); + GenerateError::from(err) + })?; + + build_fal_task_enqueue_success(tauri_model, response, request.batch_size.unwrap_or(1) > 1) +} + +async fn resolve_fal_image_inputs( + request: &TauriGenerateImageRequest, + api_host: &ApiHost, + app_data_root: &AppDataRoot, + ledger: &AssetUploadLedger, +) -> Result, GenerateError> { + let mut canvas_and_scene_tokens: Vec = Vec::new(); + + if let Some(canvas_token) = &request.canvas_image_media_token { + canvas_and_scene_tokens.push(canvas_token.clone()); + } + if let Some(scene_token) = &request.scene_image_media_token { + canvas_and_scene_tokens.push(scene_token.clone()); + } + + let mut urls = map_media_file_tokens_to_cdn_urls(&canvas_and_scene_tokens, api_host).await?; + + // Local files / raw bytes upload to ArtCraft, authenticated with any + // stored ArtCraft account (anonymous otherwise). + let maybe_artcraft_credential = find_first_credential_for_service(app_data_root, GenerationSource::ArtcraftCookies) + .or_else(|| find_first_credential_for_service(app_data_root, GenerationSource::Artcraft)); + let maybe_creds = maybe_artcraft_credential.as_ref() + .and_then(|credential| storyteller_creds_from_credential(credential).ok()); + let reference_urls = image_sources_to_fal_urls( + request.reference_media_sources(), maybe_creds.as_ref(), api_host, ledger, + ).await?; + urls.extend(reference_urls.unwrap_or_default()); + + if urls.is_empty() { + return Ok(None); + } + Ok(Some(ImageListRef::Urls(urls))) +} + +fn build_fal_task_enqueue_success( + tauri_model: TauriImageModel, + response: GenerateImageResponse, + is_batch_generation: bool, +) -> Result { + let fal_payload = response + .get_fal_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + let provider_job_id = fal_payload + .request_id + .or(fal_payload.gateway_request_id) + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + Ok(TaskEnqueueSuccess { + task_type: TaskType::ImageGeneration, + model: Some(tauri_image_model_to_generation_model(tauri_model)), + provider: GenerationSource::Fal, + provider_job_id: Some(provider_job_id), + is_batch_generation, + maybe_queue_status_url: fal_payload.maybe_status_url, + maybe_queue_response_url: fal_payload.maybe_response_url, + maybe_prompt_token: None, + }) +} + +// ── Midjourney (first-party, cookie-session) ── + +/// Generate via the router's first-party Midjourney provider, authenticating +/// with the stored session cookies. The `user_id` (needed to form the +/// submit channel) is taken from the in-memory session, resolving it once via +/// the index page when absent. +async fn enqueue_via_midjourney( + request: &TauriGenerateImageRequest, + credential: &AuthCredential, + mj_session: &MidjourneyLiveSession, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_image_model_to_router_model(tauri_model).ok_or( + GenerateError::NotYetImplemented(format!( + "Model {:?} is not supported for a Midjourney account", + tauri_model + )), + )?; + + let cookie = credential.cookies().ok_or_else(|| { + credential_not_usable(credential, "the Midjourney credential has no cookies") + })?; + let cookie_header = cookie.cookie_header(); + + let browser = midjourney_browser_profile(); + + info!( + "Midjourney enqueue: cookie_header_len={}, has_auth_i={}, has_auth_r={}, has_cf_clearance={}, browser={}", + cookie_header.len(), + cookie_header.contains("__Host-Midjourney.AuthUserTokenV3_i"), + cookie_header.contains("__Host-Midjourney.AuthUserTokenV3_r"), + cookie_header.contains("cf_clearance"), + browser.label(), + ); + + // Resolve the Midjourney user id (needed for `singleplayer_{user_id}`). + // Prefer the live session, then the auth cookie's JWT (no network), and only + // fall back to the Cloudflare-gated index page as a last resort. + let user_id = match mj_session.user_id() { + Some(user_id) => user_id, + None => match extract_midjourney_user_id_from_cookie_header(&cookie_header) { + Some(user_id) => { + info!("Resolved Midjourney user id from auth cookie JWT: {}", user_id.as_str()); + mj_session.set_identity(user_id.clone(), None); + user_id + } + None => { + warn!("Could not read Midjourney user id from the auth cookie; falling back to the index page."); + let info = get_user_info(GetUserInfoArgs { + cookie_header: &cookie_header, + hostname: None, + browser: Some(browser.clone()), + }) + .await + .map_err(|err| { + warn!("Could not read Midjourney user info from index page: {:?}", err); + credential_not_usable( + credential, + "could not read your Midjourney account info; the session may have expired", + ) + })?; + + let user_id = info.user_id.ok_or_else(|| { + credential_not_usable(credential, "Midjourney did not return a user id") + })?; + mj_session.set_identity(user_id.clone(), info.websocket_token); + user_id + } + }, + }; + + let router_request = GenerateImageRequestBuilder { + model: router_model, + provider: RouterProvider::Midjourney, + prompt: request.prompt.clone(), + image_inputs: None, + resolution: request.resolution.map(convert_resolution), + aspect_ratio: request.aspect_ratio.map(convert_aspect_ratio), + quality: request.quality.map(convert_quality), + image_batch_count: request.batch_size.map(|n| n as u16), + horizontal_angle: request.adjust_horizontal_angle, + vertical_angle: request.adjust_vertical_angle, + zoom: request.adjust_zoom, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + }; + + let client = RouterClient::Midjourney(RouterMidjourneyClient::new( + cookie_header, + user_id, + browser, + )); + let generation_request = build_direct_request(router_request, "Midjourney")?; + + let response = generation_request.send_request(&client).await.map_err(|err| { + warn!("Midjourney image generation failed: {:?}", err); + GenerateError::from(err) + })?; + + let payload = response + .get_midjourney_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!("Midjourney image generation enqueued: job_id={}", payload.job_id); + + // Stash the prompt so the (metadata-less) websocket completion path can + // still attribute the created Storyteller prompt. + if let Some(prompt) = &request.prompt { + mj_session.record_pending_prompt(payload.job_id.clone(), prompt.clone()); + } + + Ok(TaskEnqueueSuccess { + task_type: TaskType::ImageGeneration, + model: Some(tauri_image_model_to_generation_model(tauri_model)), + // NB: the task uses the bare `Midjourney` provider (what the completion + // pollers query), not the `MidjourneyCookies` credential service. + provider: GenerationSource::Midjourney, + provider_job_id: Some(payload.job_id), + // NB: Midjourney always produces a 2x2 grid. + is_batch_generation: true, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} + +// ── Grok Imagine (first-party, cookie-session) ── + +/// Grok Imagine models only run on the user's own Grok session. If the picker +/// still has another account selected, quietly use the first stored Grok +/// account instead; without one, ask the user to log into Grok. +fn maybe_reroute_grok_model_to_grok_credential( + request: &TauriGenerateImageRequest, + credential: AuthCredential, + app_data_root: &AppDataRoot, +) -> Result { + if !is_grok_imagine_model(request.model) || is_grok_service(credential.service) { + return Ok(credential); + } + + match find_first_credential_for_service(app_data_root, GenerationSource::GrokCookies) { + Some(grok_credential) => { + info!( + "Grok Imagine selected with a {} account; using Grok credential {} instead", + credential.service, + grok_credential.id.as_str(), + ); + Ok(grok_credential) + } + None => { + warn!("Grok Imagine selected but no Grok credential is stored"); + Err(GenerateError::needs_grok_credentials()) + } + } +} + +fn is_grok_imagine_model(model: Option) -> bool { + matches!(model, Some(TauriImageModel::GrokImage | TauriImageModel::GrokImagineImageQuality)) +} + +fn is_grok_service(service: GenerationSource) -> bool { + matches!(service, GenerationSource::GrokCookies | GenerationSource::Grok) +} + +/// Enqueue via the router's first-party Grok Imagine provider. +/// +/// Sends the prompt on the account's live imagine websocket (shared via +/// [`GrokWebsockets`]) and returns Grok's request id as the task's +/// `provider_job_id`; the third-party task polling thread collects the images +/// off the same socket later. +/// +/// Statsig policy: use the credential file's latest statsig as long as it +/// isn't expired (refresh first if it is). If the enqueue fails, warn, force a +/// refresh (and reconnect the socket), and retry once; if that also fails the +/// error goes back to the frontend as a flashed message. +async fn enqueue_via_grok( + request: &TauriGenerateImageRequest, + app: &AppHandle, + app_data_root: &AppDataRoot, + credential: &AuthCredential, + grok_websockets: &GrokWebsockets, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = match tauri_model { + TauriImageModel::GrokImage => RouterImageModel::GrokImagineImage, + TauriImageModel::GrokImagineImageQuality => RouterImageModel::GrokImagineImageQuality, + other => { + return Err(GenerateError::NotYetImplemented(format!( + "Model {:?} is not supported for a Grok account", + other + ))); + } + }; + + let cookie_header = credential + .cookies() + .map(|cookie| cookie.cookie_header()) + .ok_or_else(|| credential_not_usable(credential, "the Grok credential has no cookies"))?; + + let prompt = request.prompt.clone().unwrap_or_default().trim().to_string(); + if prompt.is_empty() { + return Err(GenerateError::BadInput(BadInputReason::WrongImageArguments( + "Grok Imagine needs a text prompt".to_string(), + ))); + } + + let router_request = GenerateImageRequestBuilder { + model: router_model, + provider: RouterProvider::Grok, + prompt: Some(prompt), + image_inputs: None, + resolution: request.resolution.map(convert_resolution), + aspect_ratio: request.aspect_ratio.map(convert_aspect_ratio), + quality: request.quality.map(convert_quality), + image_batch_count: request.batch_size.map(|n| n as u16), + horizontal_angle: request.adjust_horizontal_angle, + vertical_angle: request.adjust_vertical_angle, + zoom: request.adjust_zoom, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + }; + + let generation_request = build_direct_request(router_request, "Grok")?; + + let websocket = grok_websockets + .get_or_connect(&credential.id, &cookie_header) + .await + .map_err(|err| { + error!("Could not open the Grok image websocket for credential {}: {:?}", credential.id.as_str(), err); + GenerateError::ProviderRejected(format!("Couldn't connect to Grok: {}", err)) + })?; + + // Attempt 1: stored statsig if fresh, else refresh first. + ensure_grok_statsig_fresh(app, app_data_root, credential).await; + + let first_error = match dispatch_grok_once(app_data_root, credential, &cookie_header, &websocket, &generation_request, 1).await { + Ok(request_id) => return Ok(grok_enqueue_success(tauri_model, request_id)), + Err(err) => err, + }; + + // Attempt 2: the failure may be a stale statsig/session — force a refresh, + // reconnect the socket, and retry once. + warn!( + "Grok enqueue attempt 1 failed ({}); checking whether a new statsig/secret is needed and refreshing.", + first_error, + ); + match refresh_grok_statsig_blocking(app, app_data_root, true).await { + Ok(outcome) => info!("Grok statsig refresh outcome: {:?}", outcome), + Err(err) => warn!("Grok statsig refresh failed: {:?}", err), + } + if let Err(err) = websocket.reconnect().await { + warn!("Grok image websocket reconnect failed before retry: {}", err); + } + + match dispatch_grok_once(app_data_root, credential, &cookie_header, &websocket, &generation_request, 2).await { + Ok(request_id) => Ok(grok_enqueue_success(tauri_model, request_id)), + Err(second_error) => { + error!( + "Grok enqueue failed after statsig refresh + retry (attempt 1: {}; attempt 2: {})", + first_error, second_error, + ); + Err(GenerateError::ProviderRejected(format!( + "Grok image generation couldn't be started, even after refreshing your Grok session: {}", + second_error, + ))) + } + } +} + +/// Use the credential file's latest statsig as long as it isn't expired; if it +/// is, fire off a refresh first and wait for it. +async fn ensure_grok_statsig_fresh(app: &AppHandle, app_data_root: &AppDataRoot, credential: &AuthCredential) { + if fresh_grok_statsig(credential).is_some() { + info!("Grok enqueue: using the stored statsig (not expired)."); + return; + } + + warn!("Grok enqueue: stored statsig is missing or expired; refreshing before dispatch."); + match refresh_grok_statsig_blocking(app, app_data_root, false).await { + Ok(GrokStatsigRefreshOutcome::Refreshed) => info!("Grok enqueue: statsig refreshed."), + Ok(outcome) => warn!("Grok enqueue: statsig refresh outcome {:?}; dispatching anyway.", outcome), + Err(err) => warn!("Grok enqueue: statsig refresh failed ({:?}); dispatching anyway.", err), + } +} + +/// One send through the router, with the statsig re-read from disk so a +/// refresh between attempts is picked up. Returns Grok's request id. +async fn dispatch_grok_once( + app_data_root: &AppDataRoot, + credential: &AuthCredential, + cookie_header: &str, + websocket: &GrokImageWebsocket, + generation_request: &ImageGenerationRequest, + attempt: u32, +) -> Result { + // Re-read the credential file: a refresh may have just updated the statsig. + let maybe_statsig = app_data_root + .credentials_dir() + .find_credential_by_id(credential.id.as_str()) + .ok() + .flatten() + .as_ref() + .and_then(fresh_grok_statsig); + + info!( + "Grok enqueue: dispatch attempt {} (credential={}, cookie_header_len={}, has_statsig={})", + attempt, credential.id.as_str(), cookie_header.len(), maybe_statsig.is_some(), + ); + + let client = RouterClient::Grok(RouterGrokClient::new(cookie_header.to_string(), maybe_statsig, websocket.clone())); + + let response = generation_request.send_request(&client).await.map_err(|err| { + warn!("Grok enqueue: router dispatch attempt {} failed: {:?}", attempt, err); + match &err { + ArtcraftRouterError::Provider(provider_error) => provider_error.to_string(), + other => format!("{other:?}"), + } + })?; + + let payload = response + .get_grok_payload() + .ok_or_else(|| "the router returned a non-Grok response".to_string())?; + + info!("Grok enqueue: prompt sent, request_id={}", payload.request_id); + Ok(payload.request_id) +} + +/// The credential file's latest statsig, if it hasn't expired. +fn fresh_grok_statsig(credential: &AuthCredential) -> Option { + credential + .cookies()? + .grok_data + .as_ref()? + .latest_statsig_if_fresh(Utc::now()) + .map(|statsig| statsig.to_string()) +} + +fn grok_enqueue_success(tauri_model: TauriImageModel, request_id: String) -> TaskEnqueueSuccess { + TaskEnqueueSuccess { + task_type: TaskType::ImageGeneration, + model: Some(tauri_image_model_to_generation_model(tauri_model)), + // NB: the task uses the bare `Grok` provider (what the polling thread + // queries), not the `GrokCookies` credential service. + provider: GenerationSource::Grok, + provider_job_id: Some(request_id), + // NB: Grok's imagine websocket returns two images per prompt. + is_batch_generation: true, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + } +} + +// ── Shared ── + +/// Build a directly-sendable request, rejecting the draft phase (none of these +/// providers use it on the text/token path). +fn build_direct_request( + router_request: GenerateImageRequestBuilder, + provider_label: &str, +) -> Result { + match router_request.build2() { + Ok(ImageGenerationDraftOrRequest::Request(generation_request)) => Ok(generation_request), + Ok(ImageGenerationDraftOrRequest::Draft(draft)) => { + warn!("{} build unexpectedly produced a draft: {:?}", provider_label, draft); + Err(GenerateError::NotYetImplemented(format!( + "{} requests should not require a draft phase", + provider_label + ))) + } + Err(err) => { + warn!("Could not build {} router request: {:?}", provider_label, err); + Err(err.into()) + } + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/generate_image_command.rs b/crates/artcraftx/src/commands/generate/generate_image/generate_image_command.rs new file mode 100644 index 00000000..6c35a153 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/generate_image_command.rs @@ -0,0 +1,172 @@ +use crate::commands::generate::common::notify_frontend_of_errors::notify_frontend_of_errors; +use crate::commands::generate::generate_error::{GenerateError, MissingCredentialsReason}; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::generate_image::enqueue_image_generation::enqueue_image_generation; +use crate::commands::generate::generate_image::tauri_generate_image_request::{ + TauriGenerateImageErrorType, TauriGenerateImageRequest, TauriGenerateImageResponse, +}; +use crate::services::grok::state::grok_websockets::GrokWebsockets; +use crate::services::midjourney::state::midjourney_live_session::MidjourneyLiveSession; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::Response; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::credits_balance_changed_event::CreditsBalanceChangedEvent; +use crate::events::generation_events::generation_enqueue_success_event::GenerationEnqueueSuccessEvent; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::database::task_database::TaskDatabase; +use log::{error, info}; +use tauri::{AppHandle, State}; + +#[tauri::command] +pub async fn generate_image_command( + request: TauriGenerateImageRequest, + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + task_database: State<'_, TaskDatabase>, + midjourney_live_session: State<'_, MidjourneyLiveSession>, + grok_websockets: State<'_, GrokWebsockets>, + local_files_database: State<'_, LocalFilesDatabase>, +) -> Response { + + info!("generate_image_command called, request: {:?}", request); + + // Generation is credential-driven: the request names a stored credential, + // and we invoke the router for that credential's service. + let ledger = AssetUploadLedger::new(local_files_database.inner().clone()); + let result = enqueue_image_generation( + &request, + &app, + &app_data_root, + &midjourney_live_session, + &grok_websockets, + &ledger, + ).await; + + match result { + Ok(success) => handle_success_behavior(&app, &task_database, &request, success).await, + Err(err) => handle_error_behavior(&app, err).await, + } +} + +// ── Result mapping ── + +async fn handle_success_behavior( + app: &AppHandle, + task_database: &TaskDatabase, + request: &TauriGenerateImageRequest, + success: TaskEnqueueSuccess, +) -> Response { + + + // Insert into task database + let db_result = success + .insert_into_task_database_with_frontend_payload( + &task_database, + request.frontend_caller, + request.frontend_subscriber_id.as_deref(), + request.frontend_subscriber_payload.as_deref(), + ) + .await; + + if let Err(err) = db_result { + error!("Failed to create task in database: {:?}", err); + } + + /* + let usage_type = if is_image_to_image { + ArtcraftUsageType::ImageToResult + } else { + ArtcraftUsageType::TextToResult + }; + + if let Err(err) = artcraft_usage_tracker.record_image_generation(num_images, usage_type, ArtcraftUsagePage::ImagePage) { + // NB: Fail open. + warn!("Failed to report usage: {:?}", err); + } + */ + + let event = GenerationEnqueueSuccessEvent { + action: success.to_frontend_event_action(), + service: success.to_frontend_event_service(), + model: success.model, + }; + + if let Err(err) = event.send(&app) { + error!("Failed to emit event: {:?}", err); + } + + CreditsBalanceChangedEvent{}.send_infallible(&app); + + Ok(TauriGenerateImageResponse {}.into()) +} + +async fn handle_error_behavior( + app: &AppHandle, + err: GenerateError, +) -> Response { + error!("generate_image_command error: {:?}", err); + + notify_frontend_of_errors(&app, &err).await; + + let error_type = match &err { + GenerateError::BadInput(_) => TauriGenerateImageErrorType::BadInput, + GenerateError::MissingCredentials(MissingCredentialsReason::NeedsFalApiKey) => TauriGenerateImageErrorType::NeedsFalApiKey, + GenerateError::MissingCredentials(MissingCredentialsReason::NeedsGrokCredentials) => TauriGenerateImageErrorType::NeedsGrokCredentials, + GenerateError::MissingCredentials(_) => TauriGenerateImageErrorType::NeedsStorytellerCredentials, + GenerateError::CredentialProblem(_) => TauriGenerateImageErrorType::CredentialProblem, + GenerateError::NoProviderAvailable => TauriGenerateImageErrorType::NoProviderAvailable, + GenerateError::BillingIssue(_) => TauriGenerateImageErrorType::BillingIssue, + _ => TauriGenerateImageErrorType::ServerError, + }; + + // TODO: + /* + let mut status = CommandErrorStatus::ServerError; + let mut error_type = EnqueueTextToImageErrorType::ServerError; + let mut error_message = "A server error occurred. Please try again. If it continues, please tell our staff about the problem."; + + match err { + GenerateError::BadInput(BadInputReason::NoModelSpecified) => { + status = CommandErrorStatus::BadRequest; + error_type = EnqueueTextToImageErrorType::ModelNotSpecified; + error_message = "No model specified for image generation"; + } + GenerateError::NoProviderAvailable => { + status = CommandErrorStatus::ServerError; + error_type = EnqueueTextToImageErrorType::NoProviderAvailable; + error_message = "No configured provider available for image generation"; + } + GenerateError::MissingCredentials(MissingCredentialsReason::NeedsFalApiKey) => { + status = CommandErrorStatus::Unauthorized; + error_type = EnqueueTextToImageErrorType::NeedsFalApiKey; + error_message = "You need to set a FAL api key"; + }, + _ => {}, // Fall-through + } + + Err(CommandErrorResponseWrapper { + status, + error_message: Some(error_message.to_string()), + error_type: Some(error_type), + error_details: None, + }) + */ + + // Prefer a human-readable message for the frontend toast; fall back to the + // debug rendering for error kinds without one. + let error_message = match &err { + GenerateError::NotYetImplemented(message) => message.clone(), + GenerateError::ProviderRejected(message) => message.clone(), + GenerateError::CredentialProblem(reason) => reason.user_message(), + other => format!("{:?}", other), + }; + + Err(CommandErrorResponseWrapper { + status: CommandErrorStatus::ServerError, + error_message: Some(error_message), + error_type: Some(error_type), + error_details: None, + }) +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/higgsfield/enqueue_via_higgsfield.rs b/crates/artcraftx/src/commands/generate/generate_image/higgsfield/enqueue_via_higgsfield.rs new file mode 100644 index 00000000..81249450 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/higgsfield/enqueue_via_higgsfield.rs @@ -0,0 +1,190 @@ +//! Image generation on the user's own Higgsfield account, via the router's +//! first-party Higgsfield provider. + +use core_types::enums::generation_source::GenerationSource; +use log::info; +use router::api::image_list_ref::ImageListRef; +use router::api::router_provider::RouterProvider; +use router::client::generation_mode_mismatch_strategy::GenerationModeMismatchStrategy; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::higgsfield_generation::{ + higgsfield_media_url_map, higgsfield_router_client, join_higgsfield_job_ids, send_higgsfield_image_request, +}; +use crate::commands::generate::common::media_source_conversion::collect_source_tokens; +use crate::commands::generate::common::tauri_media_source::TauriMediaSource; +use crate::commands::generate::generate_error::GenerateError; +use crate::commands::generate::generate_image::tauri_generate_image_request::TauriGenerateImageRequest; +use crate::commands::generate::generate_image::utils::convert_enums_to_router::{convert_aspect_ratio, convert_quality, convert_resolution}; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::utils::api_adapters::models::image::tauri_image_model_to_generation_model::tauri_image_model_to_generation_model; +use crate::commands::utils::api_adapters::models::image::tauri_image_model_to_router_model::tauri_image_model_to_router_model; +use crate::credentials::auth_credential::AuthCredential; +use tauri::AppHandle; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; + +/// Enqueue via the router's first-party Higgsfield provider. +/// +/// Reference images (canvas, scene, and the prompt box's three-way image +/// sources) go to the router; local files and raw bytes upload straight to +/// Higgsfield, while ArtCraft media tokens (cloud-library picks) resolve to +/// CDN URLs through the map built here before the router downloads and +/// re-uploads them. The returned task carries every job id of the +/// Higgsfield job set so the poller can follow a batch. +pub async fn enqueue_via_higgsfield( + maybe_app: Option<&AppHandle>, + request: &TauriGenerateImageRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_image_model_to_router_model(tauri_model).ok_or( + GenerateError::NotYetImplemented(format!( + "Model {:?} is not supported for a Higgsfield account", + tauri_model + )), + )?; + + let sources = collect_reference_sources(request); + let media_url_map = higgsfield_media_url_map(&collect_source_tokens(&sources)).await?; + let image_inputs = (!sources.is_empty()).then(|| { + ImageListRef::Sources(sources.into_iter().map(TauriMediaSource::into_image_ref).collect()) + }); + + let router_request = GenerateImageRequestBuilder { + model: router_model, + provider: RouterProvider::Higgsfield, + prompt: request.prompt.clone(), + image_inputs, + resolution: request.resolution.map(convert_resolution), + aspect_ratio: request.aspect_ratio.map(convert_aspect_ratio), + quality: request.quality.map(convert_quality), + image_batch_count: request.batch_size.map(|n| n as u16), + horizontal_angle: request.adjust_horizontal_angle, + vertical_angle: request.adjust_vertical_angle, + zoom: request.adjust_zoom, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + }; + + let client = higgsfield_router_client(credential)?; + // References this account already uploaded are reused by media id. + let upload_cache = ledger.for_higgsfield_credential(&credential.id); + let response = send_higgsfield_image_request(maybe_app, credential, router_request, &client, &media_url_map, &upload_cache).await?; + + let payload = response + .get_higgsfield_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!( + "Higgsfield image generation enqueued: job_set={} jobs={:?}", + payload.job_set_id, payload.job_ids, + ); + + Ok(TaskEnqueueSuccess { + task_type: TaskType::ImageGeneration, + model: Some(tauri_image_model_to_generation_model(tauri_model)), + // NB: the task uses the bare `Higgsfield` provider (what the polling + // thread queries), not the `HiggsfieldCookies` credential service. + provider: GenerationSource::Higgsfield, + provider_job_id: Some(join_higgsfield_job_ids(&payload.job_ids)), + is_batch_generation: payload.job_ids.len() > 1, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} + +/// Reference images in priority order: canvas first, then scene, then the +/// un-semantic references (three-way sources). (Raw canvas / scene bytes +/// aren't accepted on this path — they'd need an ArtCraft session to become +/// tokens.) +fn collect_reference_sources(request: &TauriGenerateImageRequest) -> Vec { + let mut sources: Vec = Vec::new(); + if let Some(canvas_token) = &request.canvas_image_media_token { + sources.push(TauriMediaSource::MediaFileToken { token: canvas_token.clone() }); + } + if let Some(scene_token) = &request.scene_image_media_token { + sources.push(TauriMediaSource::MediaFileToken { token: scene_token.clone() }); + } + sources.extend(request.reference_media_sources().unwrap_or_default()); + sources +} + +/// Live smoke tests that hit the REAL Higgsfield API with the REAL stored +/// credential and SPEND HIGGSFIELD CREDITS. `#[ignore]`; run explicitly: +/// SQLX_OFFLINE=true cargo test -p artcraftx live_higgsfield_image -- --ignored --nocapture +#[cfg(test)] +mod live_higgsfield_image_tests { + use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as EnumsAspectRatio; + use artcraft_client::enums::common::generation::common_quality::CommonQuality as EnumsQuality; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; + use crate::state::data_dir::app_data_root::AppDataRoot; + use crate::state::database::local_files_database::LocalFilesDatabase; + + use super::*; + + async fn ledger() -> AssetUploadLedger { + let app_data_root = AppDataRoot::create_default().expect("app data root"); + AssetUploadLedger::new(LocalFilesDatabase::connect(&app_data_root).await.expect("local files db")) + } + + /// A production ArtCraft media file (see `test_data::web::image_media_tokens`). + const JUNO_AT_LAKE_MEDIA_TOKEN: &str = "m_m1bz02z1kkzanxy6rb4vk1kvq9de9g"; + + fn higgsfield_credential() -> AuthCredential { + let app_data_root = AppDataRoot::create_default().expect("app data root"); + app_data_root + .credentials_dir() + .load_credentials() + .expect("load credentials") + .into_iter() + .find(|c| c.service == GenerationSource::HiggsfieldCookies) + .expect("no `higgsfield_cookies` credential on disk; log into Higgsfield via the app first") + } + + #[tokio::test] + #[ignore] // live: spends Higgsfield credits + async fn live_higgsfield_image_text_to_image() { + let credential = higgsfield_credential(); + let request = TauriGenerateImageRequest { + credential_id: Some(credential.id.as_str().to_string()), + model: Some(TauriImageModel::NanoBanana2Lite), + prompt: Some("a shiba inu doing a kickflip on a skateboard, golden hour".to_string()), + aspect_ratio: Some(EnumsAspectRatio::WideSixteenByNine), + quality: Some(EnumsQuality::Low), + batch_size: Some(1), + ..Default::default() + }; + + let success = enqueue_via_higgsfield(None, &request, &credential, &ledger().await).await.expect("enqueue should succeed"); + println!("[live] Higgsfield image enqueued: provider_job_id={:?}", success.provider_job_id); + assert_eq!(success.provider, GenerationSource::Higgsfield); + assert!(success.provider_job_id.is_some()); + } + + #[tokio::test] + #[ignore] // live: spends Higgsfield credits and uploads a reference image + async fn live_higgsfield_image_edit_with_reference() { + let credential = higgsfield_credential(); + let request = TauriGenerateImageRequest { + credential_id: Some(credential.id.as_str().to_string()), + model: Some(TauriImageModel::NanoBanana2), + prompt: Some("the same scene at night under the northern lights".to_string()), + image_media_tokens: Some(vec![MediaFileToken::new_from_str(JUNO_AT_LAKE_MEDIA_TOKEN)]), + batch_size: Some(1), + ..Default::default() + }; + + let success = enqueue_via_higgsfield(None, &request, &credential, &ledger().await).await.expect("enqueue should succeed"); + println!("[live] Higgsfield image edit enqueued: provider_job_id={:?}", success.provider_job_id); + assert!(success.provider_job_id.is_some()); + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/higgsfield/mod.rs b/crates/artcraftx/src/commands/generate/generate_image/higgsfield/mod.rs new file mode 100644 index 00000000..5ee3c5d0 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/higgsfield/mod.rs @@ -0,0 +1 @@ +pub mod enqueue_via_higgsfield; diff --git a/crates/artcraftx/src/commands/generate/generate_image/mod.rs b/crates/artcraftx/src/commands/generate/generate_image/mod.rs new file mode 100644 index 00000000..dae71fe3 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/mod.rs @@ -0,0 +1,6 @@ +pub mod enqueue_image_generation; +pub mod generate_image_command; +pub mod higgsfield; +pub mod tauri_generate_image_request; +pub mod tauri_image_model; +pub mod utils; diff --git a/crates/artcraftx/src/commands/generate/generate_image/tauri_generate_image_request.rs b/crates/artcraftx/src/commands/generate/generate_image/tauri_generate_image_request.rs new file mode 100644 index 00000000..27171a76 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/tauri_generate_image_request.rs @@ -0,0 +1,147 @@ +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; +use artcraft_client::enums::common::generation::common_quality::CommonQuality; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::tauri_media_source::{merge_sources_with_legacy_tokens, TauriMediaSource}; +use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +// ── Request ── + +#[derive(Deserialize, Debug, Default)] +pub struct TauriGenerateImageRequest { + /// Stable id (`credential_{entropy}`) of the stored credential (account) + /// to generate with. Loaded from disk; generation routes to the + /// credential's service. + pub credential_id: Option, + + /// The provider to use (defaults to Artcraft/Storyteller). + /// Not all (provider, model) combinations are valid. + pub provider: Option, + + /// The model to use. + pub model: Option, + + /// Text prompt for the image generation. + pub prompt: Option, + + /// Aspect ratio. + pub aspect_ratio: Option, + + /// Resolution. + pub resolution: Option, + + /// Quality (used by OpenAI models). + pub quality: Option, + + /// The number of images to generate. + pub batch_size: Option, + + /// Reference images (without semantics). + /// The purpose varies on a model-by-model basis. + pub image_media_tokens: Option>, + + /// Three-way reference images (bytes | local path | media token). Wins + /// over `image_media_tokens` when both are set; local files and bytes + /// never touch the ArtCraft cloud unless the target provider requires it. + pub image_sources: Option>, + + // ── Canvas / scene images ── + + /// Supply this *XOR* `canvas_image_raw_bytes`. + /// Becomes the first image reference (pushing back `image_media_tokens` by one). + pub canvas_image_media_token: Option, + + /// Supply this *XOR* `canvas_image_media_token`. + /// Raw bytes of a canvas image. + pub canvas_image_raw_bytes: Option>, + + /// Supply this *XOR* `scene_image_raw_bytes`. + /// Becomes a scene reference image. + pub scene_image_media_token: Option, + + /// Supply this *XOR* `scene_image_media_token`. + /// Raw bytes of a scene image. + pub scene_image_raw_bytes: Option>, + + // ── Inpainting ── + + /// Supply this *XOR* `inpainting_mask_image_raw_bytes`. + /// The mask to focus the edit (already uploaded). + pub inpainting_mask_image_media_token: Option, + + /// Supply this *XOR* `inpainting_mask_image_media_token`. + /// The mask to focus the edit (raw bytes). + pub inpainting_mask_image_raw_bytes: Option>, + + // ── Angle adjustment (for edit models like QwenEdit, Flux2LoraAngles) ── + + /// Horizontal angle adjustment. + pub adjust_horizontal_angle: Option, + + /// Vertical angle adjustment. + pub adjust_vertical_angle: Option, + + /// Zoom adjustment. + pub adjust_zoom: Option, + + /// Turn on the system prompt. + pub enable_system_prompt: Option, + + // ── Frontend metadata ── + + /// Name of the frontend caller. + pub frontend_caller: Option, + + /// A frontend-defined identifier sent back as a Tauri event on task completion. + pub frontend_subscriber_id: Option, + + /// A frontend-defined payload sent back as a Tauri event on task completion. + pub frontend_subscriber_payload: Option, +} + +impl TauriGenerateImageRequest { + /// The un-semantic reference images, normalized: `image_sources` wins, + /// legacy `image_media_tokens` fold into [`TauriMediaSource`]s. + pub fn reference_media_sources(&self) -> Option> { + merge_sources_with_legacy_tokens(self.image_sources.clone(), self.image_media_tokens.clone()) + } +} + +// ── Response ── + +#[derive(Serialize)] +pub struct TauriGenerateImageResponse { +} + +impl SerializeMarker for TauriGenerateImageResponse {} + +// ── Error ── + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum TauriGenerateImageErrorType { + /// Caller didn't specify a model + ModelNotSpecified, + /// Bad input + BadInput, + /// No provider available + NoProviderAvailable, + /// Generic server error + ServerError, + /// Needs to be logged into Artcraft + NeedsStorytellerCredentials, + /// Needs a FAL API key + NeedsFalApiKey, + /// Needs Grok credentials + NeedsGrokCredentials, + /// Billing issue + BillingIssue, + /// Problem with the selected account credential (absent, unknown, or + /// unusable). The backend also flashes a dismissable modal. + CredentialProblem, +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/tauri_image_model.rs b/crates/artcraftx/src/commands/generate/generate_image/tauri_image_model.rs new file mode 100644 index 00000000..a89ec844 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/tauri_image_model.rs @@ -0,0 +1,82 @@ +use serde_derive::Deserialize; + +/// Unified image model enum covering text-to-image, image edit, and inpainting. +/// +/// This is used in the Tauri command bridge. +/// Don't change the serializations without coordinating with the frontend. +/// +/// MIGRATION (2026-07): we're moving the frontend to send storyteller-web omni +/// identifiers (`CommonImageModel` serde strings). Variants whose legacy Tauri +/// id differs carry the omni id as a `#[serde(alias)]` so BOTH deserialize. +/// Once the frontend is 100% omni ids, the legacy renames can be dropped. +#[derive(Deserialize, Debug, Copy, Clone)] +#[serde(rename_all = "snake_case")] +pub enum TauriImageModel { + // Text-to-image models + + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_pro_11", alias = "flux_pro_1p1")] + FluxPro11, + #[serde(rename = "flux_pro_11_ultra", alias = "flux_pro_1p1_ultra")] + FluxPro11Ultra, + // First-party (cookie-session) Grok Imagine, fast ("speed") tier. + #[serde(rename = "grok_image", alias = "grok_imagine_image")] + GrokImage, + // First-party (cookie-session) Grok Imagine, quality ("pro") tier. + #[serde(rename = "grok_imagine_image_q")] + GrokImagineImageQuality, + #[serde(rename = "recraft_3")] + Recraft3, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + // Higgsfield's Nano Banana 2 Lite (fixed 1K, High / Minimal quality). + #[serde(rename = "nano_banana_2_lite")] + NanoBanana2Lite, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + // Midjourney models, served by storyteller-web via the Artcraft provider + // (dispatched through the router). + #[serde(rename = "midjourney_7")] + Midjourney7, + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + #[serde(rename = "midjourney_8")] + Midjourney8, + + // Image edit models + + #[serde(rename = "flux_pro_kontext_max")] + FluxProKontextMax, + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, + + // Inpainting models + + #[serde(rename = "flux_dev_juggernaut")] + FluxDevJuggernaut, + #[serde(rename = "flux_pro_1")] + FluxPro1, +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/utils/convert_enums_to_router.rs b/crates/artcraftx/src/commands/generate/generate_image/utils/convert_enums_to_router.rs new file mode 100644 index 00000000..45c9e5be --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/utils/convert_enums_to_router.rs @@ -0,0 +1,50 @@ +use router::api::router_aspect_ratio::RouterAspectRatio; +use router::api::router_quality::RouterQuality; +use router::api::router_resolution::RouterResolution; +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as EnumsAspectRatio; +use artcraft_client::enums::common::generation::common_quality::CommonQuality as EnumsQuality; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as EnumsResolution; + +pub fn convert_aspect_ratio(value: EnumsAspectRatio) -> RouterAspectRatio { + match value { + EnumsAspectRatio::Auto => RouterAspectRatio::Auto, + EnumsAspectRatio::Square => RouterAspectRatio::Square, + EnumsAspectRatio::WideThreeByTwo => RouterAspectRatio::WideThreeByTwo, + EnumsAspectRatio::WideFourByThree => RouterAspectRatio::WideFourByThree, + EnumsAspectRatio::WideFiveByFour => RouterAspectRatio::WideFiveByFour, + EnumsAspectRatio::WideSixteenByNine => RouterAspectRatio::WideSixteenByNine, + EnumsAspectRatio::WideTwentyOneByNine => RouterAspectRatio::WideTwentyOneByNine, + EnumsAspectRatio::TallTwoByThree => RouterAspectRatio::TallTwoByThree, + EnumsAspectRatio::TallThreeByFour => RouterAspectRatio::TallThreeByFour, + EnumsAspectRatio::TallFourByFive => RouterAspectRatio::TallFourByFive, + EnumsAspectRatio::TallNineBySixteen => RouterAspectRatio::TallNineBySixteen, + EnumsAspectRatio::TallNineByTwentyOne => RouterAspectRatio::TallNineByTwentyOne, + EnumsAspectRatio::Wide => RouterAspectRatio::Wide, + EnumsAspectRatio::Tall => RouterAspectRatio::Tall, + EnumsAspectRatio::Auto2k => RouterAspectRatio::Auto2k, + EnumsAspectRatio::Auto3k => RouterAspectRatio::Auto3k, + EnumsAspectRatio::Auto4k => RouterAspectRatio::Auto4k, + EnumsAspectRatio::SquareHd => RouterAspectRatio::SquareHd, + } +} + +pub fn convert_quality(value: EnumsQuality) -> RouterQuality { + match value { + EnumsQuality::High => RouterQuality::High, + EnumsQuality::Medium => RouterQuality::Medium, + EnumsQuality::Low => RouterQuality::Low, + } +} + +pub fn convert_resolution(value: EnumsResolution) -> RouterResolution { + match value { + EnumsResolution::OneK => RouterResolution::OneK, + EnumsResolution::TwoK => RouterResolution::TwoK, + EnumsResolution::ThreeK => RouterResolution::ThreeK, + EnumsResolution::FourK => RouterResolution::FourK, + EnumsResolution::HalfK => RouterResolution::HalfK, + EnumsResolution::FourEightyP => RouterResolution::FourEightyP, + EnumsResolution::SevenTwentyP => RouterResolution::SevenTwentyP, + EnumsResolution::TenEightyP => RouterResolution::TenEightyP, + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/utils/map_media_files_to_urls.rs b/crates/artcraftx/src/commands/generate/generate_image/utils/map_media_files_to_urls.rs new file mode 100644 index 00000000..38cab2ec --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/utils/map_media_files_to_urls.rs @@ -0,0 +1,27 @@ +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use artcraft_client::utils::api_host::ApiHost; +use log::info; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::generate_error::GenerateError; + +/// Resolve a list of media file tokens to their CDN URLs. +/// +/// FAL (and other third-party providers) can fetch images by URL directly, +/// so we just need the CDN link — no need to download the bytes locally. +pub async fn map_media_file_tokens_to_cdn_urls( + tokens: &[MediaFileToken], + api_host: &ApiHost, +) -> Result, GenerateError> { + let mut urls = Vec::with_capacity(tokens.len()); + + for token in tokens { + info!("Resolving media file token {} to CDN URL...", token.as_str()); + let response = get_media_file(api_host, token).await?; + let cdn_url = response.media_file.media_links.cdn_url.to_string(); + info!("Resolved {} -> {}", token.as_str(), &cdn_url); + urls.push(cdn_url); + } + + Ok(urls) +} diff --git a/crates/artcraftx/src/commands/generate/generate_image/utils/mod.rs b/crates/artcraftx/src/commands/generate/generate_image/utils/mod.rs new file mode 100644 index 00000000..8b9c70f3 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/utils/mod.rs @@ -0,0 +1,3 @@ +pub mod convert_enums_to_router; +pub mod map_media_files_to_urls; +pub mod parse_semantic_media_files; diff --git a/crates/artcraftx/src/commands/generate/generate_image/utils/parse_semantic_media_files.rs b/crates/artcraftx/src/commands/generate/generate_image/utils/parse_semantic_media_files.rs new file mode 100644 index 00000000..a4091196 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_image/utils/parse_semantic_media_files.rs @@ -0,0 +1,123 @@ +use log::info; + +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::utils::api_host::ApiHost; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::generate_error::{BadInputReason, GenerateError}; +use crate::commands::generate::generate_image::tauri_generate_image_request::TauriGenerateImageRequest; +use crate::services::storyteller::utils::upload_bytes_to_media_file::upload_image_bytes_as_media_file::upload_image_bytes_as_media_file; +use crate::services::storyteller::utils::upload_bytes_to_media_file::upload_mask_image_bytes_as_media_file::upload_mask_image_bytes_as_media_file; + +/// Resolved semantic media file tokens for canvas, scene, and inpainting mask. +/// +/// Each field is populated either from an already-uploaded token on the request +/// or by uploading raw bytes on the fly. +pub struct SemanticMediaFiles { + pub canvas_image_media_token: Option, + pub scene_image_media_token: Option, + pub inpainting_mask_image_media_token: Option, +} + +/// Resolve semantic media files from the request. +/// +/// For each of (canvas, scene, mask): the request may supply a pre-uploaded +/// token XOR raw bytes. If both are supplied, returns an error. If raw bytes +/// are supplied, uploads them and returns the resulting token. +pub async fn parse_semantic_media_files( + request: &TauriGenerateImageRequest, + creds: &StorytellerCredentialSet, + api_host: &ApiHost, +) -> Result { + // Canvas image + let canvas_image_media_token = resolve_image_field( + "canvas_image", + request.canvas_image_media_token.as_ref(), + request.canvas_image_raw_bytes.as_deref(), + creds, + api_host, + ).await?; + + // Scene image + let scene_image_media_token = resolve_image_field( + "scene_image", + request.scene_image_media_token.as_ref(), + request.scene_image_raw_bytes.as_deref(), + creds, + api_host, + ).await?; + + // Inpainting mask + let inpainting_mask_image_media_token = resolve_mask_field( + request.inpainting_mask_image_media_token.as_ref(), + request.inpainting_mask_image_raw_bytes.as_deref(), + creds, + api_host, + ).await?; + + Ok(SemanticMediaFiles { + canvas_image_media_token, + scene_image_media_token, + inpainting_mask_image_media_token, + }) +} + +// ── Helpers ── + +async fn resolve_image_field( + field_name: &str, + maybe_token: Option<&MediaFileToken>, + maybe_raw_bytes: Option<&[u8]>, + creds: &StorytellerCredentialSet, + api_host: &ApiHost, +) -> Result, GenerateError> { + if maybe_token.is_some() && maybe_raw_bytes.is_some() { + return Err(GenerateError::BadInput(BadInputReason::WrongImageArguments(format!( + "Cannot supply both {}_media_token and {}_raw_bytes", + field_name, field_name + )))); + } + + if let Some(token) = maybe_token { + return Ok(Some(token.clone())); + } + + if let Some(raw_bytes) = maybe_raw_bytes { + info!("Uploading {} raw bytes ({} bytes)...", field_name, raw_bytes.len()); + let token = upload_image_bytes_as_media_file( + creds, + api_host, + raw_bytes.to_vec(), + ).await?; + return Ok(Some(token)); + } + + Ok(None) +} + +async fn resolve_mask_field( + maybe_token: Option<&MediaFileToken>, + maybe_raw_bytes: Option<&[u8]>, + creds: &StorytellerCredentialSet, + api_host: &ApiHost, +) -> Result, GenerateError> { + if maybe_token.is_some() && maybe_raw_bytes.is_some() { + return Err(GenerateError::BadInput(BadInputReason::BothImageMaskMediaTokenAndBytesSupplied)); + } + + if let Some(token) = maybe_token { + return Ok(Some(token.clone())); + } + + if let Some(raw_bytes) = maybe_raw_bytes { + info!("Uploading inpainting mask raw bytes ({} bytes)...", raw_bytes.len()); + let token = upload_mask_image_bytes_as_media_file( + creds, + api_host, + raw_bytes, + ).await?; + return Ok(Some(token)); + } + + Ok(None) +} diff --git a/crates/artcraftx/src/commands/generate/generate_mesh/generate_mesh_command.rs b/crates/artcraftx/src/commands/generate/generate_mesh/generate_mesh_command.rs new file mode 100644 index 00000000..dcd06fe3 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_mesh/generate_mesh_command.rs @@ -0,0 +1,131 @@ +use crate::commands::generate::common::notify_frontend_of_errors::notify_frontend_of_errors; +use crate::commands::generate::generate_error::GenerateError; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::generate_mesh::handle_credential_router::handle_credential_router; +use crate::commands::generate::generate_mesh::request::{ + TauriGenerateMeshErrorType, TauriGenerateMeshRequest, TauriGenerateMeshResponse, +}; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::Response; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::credits_balance_changed_event::CreditsBalanceChangedEvent; +use crate::events::generation_events::generation_enqueue_success_event::GenerationEnqueueSuccessEvent; +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use crate::state::usage_tracker::artcraft_usage_type::{ArtcraftUsagePage, ArtcraftUsageType}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::database::task_database::TaskDatabase; +use log::{error, info, warn}; +use tauri::{AppHandle, State}; + +#[tauri::command] +pub async fn generate_mesh_command( + request: TauriGenerateMeshRequest, + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + artcraft_usage_tracker: State<'_, ArtcraftUsageTracker>, + task_database: State<'_, TaskDatabase>, + local_files_database: State<'_, LocalFilesDatabase>, +) -> Response { + + info!("generate_mesh_command called, request: {:?}", request); + + let ledger = AssetUploadLedger::new(local_files_database.inner().clone()); + let result = handle_request( + request, + &app_data_root, + &artcraft_usage_tracker, + &task_database, + &ledger, + ).await; + + match result { + Err(err) => { + error!("generate_mesh_command error: {:?}", err); + + notify_frontend_of_errors(&app, &err).await; + + let mut status = CommandErrorStatus::ServerError; + let mut error_type = TauriGenerateMeshErrorType::ServerError; + let mut error_message = "A server error occurred. Please try again. If it continues, please tell our staff about the problem.".to_string(); + + match err { + GenerateError::BadInput(_) => { + status = CommandErrorStatus::BadRequest; + error_type = TauriGenerateMeshErrorType::ModelNotSpecified; + error_message = "No model specified for mesh generation".to_string(); + } + GenerateError::CredentialProblem(reason) => { + status = CommandErrorStatus::Unauthorized; + error_type = TauriGenerateMeshErrorType::CredentialProblem; + error_message = reason.user_message(); + } + GenerateError::NotYetImplemented(message) => { + error_message = message; + } + GenerateError::ProviderRejected(message) => { + // The provider refused for a reason the user can act on; the + // message already explains it. + status = CommandErrorStatus::BadRequest; + error_message = message; + } + _ => {}, // Fall-through + } + + Err(CommandErrorResponseWrapper { + status, + error_message: Some(error_message), + error_type: Some(error_type), + error_details: None, + }) + } + Ok(event) => { + let event = GenerationEnqueueSuccessEvent { + action: event.to_frontend_event_action(), + service: event.to_frontend_event_service(), + model: event.model, + }; + + if let Err(err) = event.send(&app) { + error!("Failed to emit event: {:?}", err); + } + + CreditsBalanceChangedEvent{}.send_infallible(&app); + + Ok(TauriGenerateMeshResponse {}.into()) + } + } +} + +async fn handle_request( + request: TauriGenerateMeshRequest, + app_data_root: &AppDataRoot, + artcraft_usage_tracker: &ArtcraftUsageTracker, + task_database: &TaskDatabase, + ledger: &AssetUploadLedger, +) -> Result { + + // Generation is credential-driven: the request names a stored credential, + // and the router dispatches to that credential's service. + let success_event = handle_credential_router(&request, app_data_root, ledger).await?; + + let result = success_event + .insert_into_task_database_with_frontend_payload( + task_database, + request.frontend_caller, + request.frontend_subscriber_id.as_deref(), + request.frontend_subscriber_payload.as_deref(), + ) + .await; + + if let Err(err) = result { + error!("Failed to create task in database: {:?}", err); + } + + if let Err(err) = artcraft_usage_tracker.record_object_generation(1, ArtcraftUsageType::ImageToResult, ArtcraftUsagePage::ObjectPage) { + warn!("Failed to report usage: {:?}", err); + } + + Ok(success_event) +} diff --git a/crates/artcraftx/src/commands/generate/generate_mesh/handle_credential_router.rs b/crates/artcraftx/src/commands/generate/generate_mesh/handle_credential_router.rs new file mode 100644 index 00000000..c95b084c --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_mesh/handle_credential_router.rs @@ -0,0 +1,173 @@ +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{info, warn}; +use router::api::router_provider::RouterProvider; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::client::router_artcraft_client::RouterArtcraftClient; +use router::client::router_client::RouterClient; +use router::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use router::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use router::api::image_list_ref::ImageListRef; +use router::api::image_ref::ImageRef; +use router::api::mesh_ref::MeshRef; + +use crate::commands::utils::api_adapters::models::mesh::tauri_mesh_model_to_generation_model::tauri_mesh_model_to_generation_model; +use crate::commands::utils::api_adapters::models::mesh::tauri_mesh_model_to_router_model::tauri_mesh_model_to_router_model; +use crate::commands::generate::generate_error::GenerateError; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::common::generation_credential::{credential_not_usable, resolve_generation_credential, storyteller_creds_from_credential}; +use crate::commands::generate::common::media_source_conversion::{ + maybe_source_to_artcraft_token, sources_to_artcraft_tokens, ArtcraftMediaKind, +}; +use crate::commands::generate::common::tauri_media_source::{validate_sources, TauriMediaSource}; +use crate::commands::generate::generate_mesh::request::TauriGenerateMeshRequest; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; +use crate::credentials::auth_credential::AuthCredential; +use crate::state::data_dir::app_data_root::AppDataRoot; + +/// Credential-driven mesh generation: resolve the stored credential named +/// by the request's `credential_id`, then route to that credential's service +/// via the router. The router owns upload + dispatch mechanics per provider. +pub async fn handle_credential_router( + request: &TauriGenerateMeshRequest, + app_data_root: &AppDataRoot, + ledger: &AssetUploadLedger, +) -> Result { + // Reject unusable media sources (missing local files, empty bytes) before + // any provider work. + validate_sources(request.media_sources().iter())?; + + let credential = resolve_generation_credential( + request.credential_id.as_deref(), + app_data_root, + )?; + + info!( + "handle_credential_router (mesh): credential={} service={}", + credential.id.as_str(), + credential.service, + ); + + match credential.service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies => { + handle_artcraft_credential(request, &credential, ledger).await + } + other => Err(credential_not_usable( + &credential, + &format!("accounts for service {} can't generate mesh yet", other), + )), + } +} + +/// Generate via the router's Artcraft provider, authenticating with the +/// stored session cookies. Artcraft's API is token-native; local image +/// files and bytes upload to ArtCraft here, at generate time. +async fn handle_artcraft_credential( + request: &TauriGenerateMeshRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_mesh_model_to_router_model(tauri_model); + let generation_model = tauri_mesh_model_to_generation_model(tauri_model); + + let api_host = maybe_artcraft_api_host_for_service(credential.service) + .expect("caller only routes ArtCraft services here"); + + let creds = storyteller_creds_from_credential(credential)?; + + let media = request.media_sources(); + let reference_images = sources_to_artcraft_tokens(media.reference_images, ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger) + .await?.map(ImageListRef::MediaFileTokens); + let front_image = maybe_source_to_artcraft_token(media.front_image, ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger) + .await?.map(ImageRef::MediaFileToken); + let back_image = maybe_source_to_artcraft_token(media.back_image, ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger) + .await?.map(ImageRef::MediaFileToken); + let left_image = maybe_source_to_artcraft_token(media.left_image, ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger) + .await?.map(ImageRef::MediaFileToken); + let right_image = maybe_source_to_artcraft_token(media.right_image, ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger) + .await?.map(ImageRef::MediaFileToken); + // There's no ArtCraft mesh-file upload endpoint yet; meshes stay token-only. + let input_mesh = match media.input_mesh { + None => None, + Some(TauriMediaSource::MediaFileToken { token }) => Some(MeshRef::MediaFileToken(token)), + Some(_) => { + return Err(GenerateError::NotYetImplemented( + "Local mesh files can't be used as generation inputs yet; pick one from the library".to_string(), + )); + } + }; + + let client = RouterClient::Artcraft(RouterArtcraftClient::new( + api_host, + creds, + )); + + let router_request = GenerateMeshRequestBuilder { + model: router_model, + provider: RouterProvider::Artcraft, + prompt: request.prompt.clone(), + reference_images, + front_image, + back_image, + left_image, + right_image, + input_mesh, + mesh_output_type: request.mesh_output_type, + polygon_type: request.polygon_type, + face_count: request.face_count, + enable_pbr: request.enable_pbr, + enable_texture: request.enable_texture, + texture_quality: request.texture_quality, + geometry_quality: request.geometry_quality, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + idempotency_token: None, + }; + + info!("Building Artcraft mesh generation plan: model={:?}", router_model); + + let generation_request = match router_request.build2() { + Ok(MeshGenerationDraftOrRequest::Request(generation_request)) => generation_request, + Ok(MeshGenerationDraftOrRequest::Draft(draft)) => { + warn!("Artcraft build unexpectedly produced a draft: {:?}", draft); + return Err(GenerateError::NotYetImplemented( + "Artcraft requests should not require a draft phase".to_string(), + )); + } + Err(err) => { + warn!("Could not build Artcraft router request: {:?}", err); + return Err(err.into()); + } + }; + + let response = generation_request.send_request(&client).await + .map_err(|err| { + warn!("Artcraft router mesh generation failed: {:?}", err); + GenerateError::from(err) + })?; + + let payload = response.get_artcraft_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!( + "Router mesh generation enqueued: inference_job_token={}, all_tokens={:?}, response={:?}", + payload.inference_job_token.as_str(), + payload.all_inference_job_tokens, + response, + ); + + Ok(TaskEnqueueSuccess { + task_type: TaskType::MeshGeneration, + model: Some(generation_model), + provider: GenerationSource::Artcraft, + provider_job_id: Some(payload.inference_job_token.to_string()), + is_batch_generation: false, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} diff --git a/crates/artcraftx/src/commands/generate/generate_mesh/mod.rs b/crates/artcraftx/src/commands/generate/generate_mesh/mod.rs new file mode 100644 index 00000000..92d68a4f --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_mesh/mod.rs @@ -0,0 +1,3 @@ +pub mod generate_mesh_command; +mod handle_credential_router; +pub mod request; diff --git a/crates/artcraftx/src/commands/generate/generate_mesh/request.rs b/crates/artcraftx/src/commands/generate/generate_mesh/request.rs new file mode 100644 index 00000000..98f2478f --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_mesh/request.rs @@ -0,0 +1,169 @@ +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use serde_derive::{Deserialize, Serialize}; +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::tauri_media_source::{ + merge_source_with_legacy_token, merge_sources_with_legacy_tokens, TauriMediaSource, +}; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +// ── Request ── + +#[derive(Deserialize, Debug)] +pub struct TauriGenerateMeshRequest { + /// Stable id (`credential_{entropy}`) of the stored credential (account) + /// to generate with. Loaded from disk; generation routes to the + /// credential's service. + pub credential_id: Option, + + /// The model to use. + pub model: Option, + + /// Text prompt. + pub prompt: Option, + + /// Reference images (already uploaded). + pub reference_image_media_tokens: Option>, + + /// Multi-view images (already uploaded). + pub front_image_media_token: Option, + pub back_image_media_token: Option, + pub left_image_media_token: Option, + pub right_image_media_token: Option, + + /// Input mesh for mesh-to-mesh models (part splitting, retopology). + pub input_mesh_media_token: Option, + + // Three-way media sources (bytes | local path | media token). Each wins + // over its legacy `*_media_token(s)` twin above when both are set. + pub reference_image_sources: Option>, + pub front_image_source: Option, + pub back_image_source: Option, + pub left_image_source: Option, + pub right_image_source: Option, + pub input_mesh_source: Option, + + /// Requested mesh output type. + pub mesh_output_type: Option, + + /// Requested polygon type. + pub polygon_type: Option, + + /// Target face count. + pub face_count: Option, + + /// Generate PBR materials. + pub enable_pbr: Option, + + /// Generate textures (off = untextured output). + pub enable_texture: Option, + + /// Texture quality level. + pub texture_quality: Option, + + /// Geometry quality level. + pub geometry_quality: Option, + + // ── Frontend metadata ── + + /// Name of the frontend caller. + pub frontend_caller: Option, + + /// A frontend-defined identifier sent back as a Tauri event on task completion. + pub frontend_subscriber_id: Option, + + /// A frontend-defined payload sent back as a Tauri event on task completion. + pub frontend_subscriber_payload: Option, +} + +/// The mesh request's media inputs, normalized: legacy token fields fold +/// into [`TauriMediaSource`]s so handlers see one shape. +#[derive(Debug, Clone)] +pub struct MeshRequestMediaSources { + pub reference_images: Option>, + pub front_image: Option, + pub back_image: Option, + pub left_image: Option, + pub right_image: Option, + pub input_mesh: Option, +} + +impl TauriGenerateMeshRequest { + pub fn media_sources(&self) -> MeshRequestMediaSources { + MeshRequestMediaSources { + reference_images: merge_sources_with_legacy_tokens( + self.reference_image_sources.clone(), self.reference_image_media_tokens.clone(), + ), + front_image: merge_source_with_legacy_token(self.front_image_source.clone(), self.front_image_media_token.clone()), + back_image: merge_source_with_legacy_token(self.back_image_source.clone(), self.back_image_media_token.clone()), + left_image: merge_source_with_legacy_token(self.left_image_source.clone(), self.left_image_media_token.clone()), + right_image: merge_source_with_legacy_token(self.right_image_source.clone(), self.right_image_media_token.clone()), + input_mesh: merge_source_with_legacy_token(self.input_mesh_source.clone(), self.input_mesh_media_token.clone()), + } + } +} + +impl MeshRequestMediaSources { + /// Every source the request carries, for up-front validation. + pub fn iter(&self) -> impl Iterator { + self.reference_images.iter().flatten() + .chain(self.front_image.iter()) + .chain(self.back_image.iter()) + .chain(self.left_image.iter()) + .chain(self.right_image.iter()) + .chain(self.input_mesh.iter()) + } +} + +/// The mesh models the frontend can request, identified by their omni +/// model ids (`CommonMeshModel` serde strings). +#[derive(Clone, Copy, Debug, Deserialize)] +pub enum TauriMeshModel { + #[serde(rename = "hunyuan_3d_2p0", alias = "hunyuan_3d_2_0", alias = "hunyuan_3d_2")] + Hunyuan3d2p0, + #[serde(rename = "hunyuan_3d_2p1", alias = "hunyuan_3d_2_1")] + Hunyuan3d2p1, + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + #[serde(rename = "hunyuan_3d_3_sketch")] + Hunyuan3d3Sketch, + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3p1Pro, + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3p1Rapid, + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3p1Part, + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3p1SmartTopology, + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3p1, + #[serde(rename = "meshy_v6")] + MeshyV6, + #[serde(rename = "rodin_2p5_fast")] + Rodin2p5Fast, +} + +// ── Response ── + +#[derive(Serialize)] +pub struct TauriGenerateMeshResponse { +} + +impl SerializeMarker for TauriGenerateMeshResponse {} + +// ── Error ── + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum TauriGenerateMeshErrorType { + /// Caller didn't specify a model + ModelNotSpecified, + /// Generic server error + ServerError, + /// Problem with the selected account credential (absent, unknown, or + /// unusable). The backend also flashes a dismissable modal. + CredentialProblem, +} diff --git a/crates/artcraftx/src/commands/generate/generate_splat/generate_splat_command.rs b/crates/artcraftx/src/commands/generate/generate_splat/generate_splat_command.rs new file mode 100644 index 00000000..a3a420c7 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_splat/generate_splat_command.rs @@ -0,0 +1,131 @@ +use crate::commands::generate::common::notify_frontend_of_errors::notify_frontend_of_errors; +use crate::commands::generate::generate_error::GenerateError; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::generate_splat::handle_credential_router::handle_credential_router; +use crate::commands::generate::generate_splat::request::{ + TauriGenerateSplatErrorType, TauriGenerateSplatRequest, TauriGenerateSplatResponse, +}; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::Response; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::credits_balance_changed_event::CreditsBalanceChangedEvent; +use crate::events::generation_events::generation_enqueue_success_event::GenerationEnqueueSuccessEvent; +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use crate::state::usage_tracker::artcraft_usage_type::{ArtcraftUsagePage, ArtcraftUsageType}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::database::task_database::TaskDatabase; +use log::{error, info, warn}; +use tauri::{AppHandle, State}; + +#[tauri::command] +pub async fn generate_splat_command( + request: TauriGenerateSplatRequest, + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + artcraft_usage_tracker: State<'_, ArtcraftUsageTracker>, + task_database: State<'_, TaskDatabase>, + local_files_database: State<'_, LocalFilesDatabase>, +) -> Response { + + info!("generate_splat_command called, request: {:?}", request); + + let ledger = AssetUploadLedger::new(local_files_database.inner().clone()); + let result = handle_request( + request, + &app_data_root, + &artcraft_usage_tracker, + &task_database, + &ledger, + ).await; + + match result { + Err(err) => { + error!("generate_splat_command error: {:?}", err); + + notify_frontend_of_errors(&app, &err).await; + + let mut status = CommandErrorStatus::ServerError; + let mut error_type = TauriGenerateSplatErrorType::ServerError; + let mut error_message = "A server error occurred. Please try again. If it continues, please tell our staff about the problem.".to_string(); + + match err { + GenerateError::BadInput(_) => { + status = CommandErrorStatus::BadRequest; + error_type = TauriGenerateSplatErrorType::ModelNotSpecified; + error_message = "No model specified for splat generation".to_string(); + } + GenerateError::CredentialProblem(reason) => { + status = CommandErrorStatus::Unauthorized; + error_type = TauriGenerateSplatErrorType::CredentialProblem; + error_message = reason.user_message(); + } + GenerateError::NotYetImplemented(message) => { + error_message = message; + } + GenerateError::ProviderRejected(message) => { + // The provider refused for a reason the user can act on; the + // message already explains it. + status = CommandErrorStatus::BadRequest; + error_message = message; + } + _ => {}, // Fall-through + } + + Err(CommandErrorResponseWrapper { + status, + error_message: Some(error_message), + error_type: Some(error_type), + error_details: None, + }) + } + Ok(event) => { + let event = GenerationEnqueueSuccessEvent { + action: event.to_frontend_event_action(), + service: event.to_frontend_event_service(), + model: event.model, + }; + + if let Err(err) = event.send(&app) { + error!("Failed to emit event: {:?}", err); + } + + CreditsBalanceChangedEvent{}.send_infallible(&app); + + Ok(TauriGenerateSplatResponse {}.into()) + } + } +} + +async fn handle_request( + request: TauriGenerateSplatRequest, + app_data_root: &AppDataRoot, + artcraft_usage_tracker: &ArtcraftUsageTracker, + task_database: &TaskDatabase, + ledger: &AssetUploadLedger, +) -> Result { + + // Generation is credential-driven: the request names a stored credential, + // and the router dispatches to that credential's service. + let success_event = handle_credential_router(&request, app_data_root, ledger).await?; + + let result = success_event + .insert_into_task_database_with_frontend_payload( + task_database, + request.frontend_caller, + request.frontend_subscriber_id.as_deref(), + request.frontend_subscriber_payload.as_deref(), + ) + .await; + + if let Err(err) = result { + error!("Failed to create task in database: {:?}", err); + } + + if let Err(err) = artcraft_usage_tracker.record_object_generation(1, ArtcraftUsageType::ImageToResult, ArtcraftUsagePage::OtherPage) { + warn!("Failed to report usage: {:?}", err); + } + + Ok(success_event) +} diff --git a/crates/artcraftx/src/commands/generate/generate_splat/handle_credential_router.rs b/crates/artcraftx/src/commands/generate/generate_splat/handle_credential_router.rs new file mode 100644 index 00000000..ab1325e5 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_splat/handle_credential_router.rs @@ -0,0 +1,138 @@ +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{info, warn}; +use router::api::router_provider::RouterProvider; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::client::router_artcraft_client::RouterArtcraftClient; +use router::client::router_client::RouterClient; +use router::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use router::api::image_list_ref::ImageListRef; +use router::api::video_ref::VideoRef; + +use crate::commands::utils::api_adapters::models::splat::tauri_splat_model_to_generation_model::tauri_splat_model_to_generation_model; +use crate::commands::utils::api_adapters::models::splat::tauri_splat_model_to_router_model::tauri_splat_model_to_router_model; +use crate::commands::generate::generate_error::GenerateError; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::common::generation_credential::{credential_not_usable, resolve_generation_credential, storyteller_creds_from_credential}; +use crate::commands::generate::common::media_source_conversion::{ + maybe_source_to_artcraft_token, sources_to_artcraft_tokens, ArtcraftMediaKind, +}; +use crate::commands::generate::common::tauri_media_source::validate_sources; +use crate::commands::generate::generate_splat::request::TauriGenerateSplatRequest; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; +use crate::credentials::auth_credential::AuthCredential; +use crate::state::data_dir::app_data_root::AppDataRoot; + +/// Credential-driven splat generation: resolve the stored credential named +/// by the request's `credential_id`, then route to that credential's service +/// via the router. The router owns upload + dispatch mechanics per provider. +pub async fn handle_credential_router( + request: &TauriGenerateSplatRequest, + app_data_root: &AppDataRoot, + ledger: &AssetUploadLedger, +) -> Result { + // Reject unusable media sources (missing local files, empty bytes) before + // any provider work. + validate_sources(request.media_sources().iter())?; + + let credential = resolve_generation_credential( + request.credential_id.as_deref(), + app_data_root, + )?; + + info!( + "handle_credential_router (splat): credential={} service={}", + credential.id.as_str(), + credential.service, + ); + + match credential.service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies => { + handle_artcraft_credential(request, &credential, ledger).await + } + other => Err(credential_not_usable( + &credential, + &format!("accounts for service {} can't generate splat yet", other), + )), + } +} + +/// Generate via the router's Artcraft provider, authenticating with the +/// stored session cookies. Artcraft's API is token-native; local files and +/// bytes upload to ArtCraft here, at generate time. +async fn handle_artcraft_credential( + request: &TauriGenerateSplatRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_splat_model_to_router_model(tauri_model); + let generation_model = tauri_splat_model_to_generation_model(tauri_model); + + let api_host = maybe_artcraft_api_host_for_service(credential.service) + .expect("caller only routes ArtCraft services here"); + + let creds = storyteller_creds_from_credential(credential)?; + + let media = request.media_sources(); + let reference_images = sources_to_artcraft_tokens(media.reference_images, ArtcraftMediaKind::Image, Some(&creds), &api_host, ledger) + .await?.map(ImageListRef::MediaFileTokens); + let reference_video = maybe_source_to_artcraft_token(media.reference_video, ArtcraftMediaKind::Video, Some(&creds), &api_host, ledger) + .await?.map(VideoRef::MediaFileToken); + + let client = RouterClient::Artcraft(RouterArtcraftClient::new( + api_host, + creds, + )); + + let router_request = GenerateSplatRequestBuilder { + model: router_model, + provider: RouterProvider::Artcraft, + prompt: request.prompt.clone(), + reference_images, + reference_video, + is_panoramic: request.is_panoramic, + disable_recaption: request.disable_recaption, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + idempotency_token: None, + }; + + info!("Building Artcraft splat generation plan: model={:?}", router_model); + + let generation_request = router_request.build2() + .map_err(|err| { + warn!("Could not build Artcraft router request: {:?}", err); + GenerateError::from(err) + })?; + + let response = generation_request.send_request(&client).await + .map_err(|err| { + warn!("Artcraft router splat generation failed: {:?}", err); + GenerateError::from(err) + })?; + + let payload = response.get_artcraft_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!( + "Router splat generation enqueued: inference_job_token={}, all_tokens={:?}, response={:?}", + payload.inference_job_token.as_str(), + payload.all_inference_job_tokens, + response, + ); + + Ok(TaskEnqueueSuccess { + task_type: TaskType::SplatGeneration, + model: Some(generation_model), + provider: GenerationSource::Artcraft, + provider_job_id: Some(payload.inference_job_token.to_string()), + is_batch_generation: false, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} diff --git a/crates/artcraftx/src/commands/generate/generate_splat/mod.rs b/crates/artcraftx/src/commands/generate/generate_splat/mod.rs new file mode 100644 index 00000000..c3349b2c --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_splat/mod.rs @@ -0,0 +1,3 @@ +pub mod generate_splat_command; +mod handle_credential_router; +pub mod request; diff --git a/crates/artcraftx/src/commands/generate/generate_splat/request.rs b/crates/artcraftx/src/commands/generate/generate_splat/request.rs new file mode 100644 index 00000000..6f252f91 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_splat/request.rs @@ -0,0 +1,122 @@ +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use serde_derive::{Deserialize, Serialize}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::tauri_media_source::{ + merge_source_with_legacy_token, merge_sources_with_legacy_tokens, TauriMediaSource, +}; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +// ── Request ── + +#[derive(Deserialize, Debug)] +pub struct TauriGenerateSplatRequest { + /// Stable id (`credential_{entropy}`) of the stored credential (account) + /// to generate with. Loaded from disk; generation routes to the + /// credential's service. + pub credential_id: Option, + + /// The model to use. + pub model: Option, + + /// Text prompt. + pub prompt: Option, + + /// Reference images (already uploaded). + pub reference_image_media_tokens: Option>, + + /// Reference video (already uploaded). + pub reference_video_media_token: Option, + + // Three-way media sources (bytes | local path | media token). Each wins + // over its legacy `*_media_token(s)` twin above when both are set. + pub reference_image_sources: Option>, + pub reference_video_source: Option, + + /// The reference image is a 360-degree panorama. + pub is_panoramic: Option, + + /// Disable server-side recaptioning of the prompt. + pub disable_recaption: Option, + + // ── Frontend metadata ── + + /// Name of the frontend caller. + pub frontend_caller: Option, + + /// A frontend-defined identifier sent back as a Tauri event on task completion. + pub frontend_subscriber_id: Option, + + /// A frontend-defined payload sent back as a Tauri event on task completion. + pub frontend_subscriber_payload: Option, +} + +/// The splat request's media inputs, normalized: legacy token fields fold +/// into [`TauriMediaSource`]s so handlers see one shape. +#[derive(Debug, Clone)] +pub struct SplatRequestMediaSources { + pub reference_images: Option>, + pub reference_video: Option, +} + +impl TauriGenerateSplatRequest { + pub fn media_sources(&self) -> SplatRequestMediaSources { + SplatRequestMediaSources { + reference_images: merge_sources_with_legacy_tokens( + self.reference_image_sources.clone(), self.reference_image_media_tokens.clone(), + ), + reference_video: merge_source_with_legacy_token( + self.reference_video_source.clone(), self.reference_video_media_token.clone(), + ), + } + } +} + +impl SplatRequestMediaSources { + /// Every source the request carries, for up-front validation. + pub fn iter(&self) -> impl Iterator { + self.reference_images.iter().flatten().chain(self.reference_video.iter()) + } +} + +/// The splat models the frontend can request, identified by their omni +/// model ids (`CommonSplatModel` serde strings). +#[derive(Clone, Copy, Debug, Deserialize)] +pub enum TauriSplatModel { + #[serde(rename = "marble_0p1_mini")] + Marble0p1Mini, + #[serde(rename = "marble_0p1_plus")] + Marble0p1Plus, + #[serde(rename = "marble_1p0")] + Marble1p0, + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + #[serde(rename = "marble_1p1")] + Marble1p1, + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + #[serde(rename = "triposplat")] + TripoSplat, +} + +// ── Response ── + +#[derive(Serialize)] +pub struct TauriGenerateSplatResponse { +} + +impl SerializeMarker for TauriGenerateSplatResponse {} + +// ── Error ── + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum TauriGenerateSplatErrorType { + /// Caller didn't specify a model + ModelNotSpecified, + /// Generic server error + ServerError, + /// Problem with the selected account credential (absent, unknown, or + /// unusable). The backend also flashes a dismissable modal. + CredentialProblem, +} diff --git a/crates/artcraftx/src/commands/generate/generate_video/artcraft/handle_artcraft_video_via_router.rs b/crates/artcraftx/src/commands/generate/generate_video/artcraft/handle_artcraft_video_via_router.rs new file mode 100644 index 00000000..37b0c8d9 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/artcraft/handle_artcraft_video_via_router.rs @@ -0,0 +1,126 @@ +use crate::commands::generate::common::media_source_conversion::{ + maybe_source_to_artcraft_token, sources_to_artcraft_tokens, ArtcraftMediaKind, +}; +use crate::commands::generate::generate_error::GenerateError; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::commands::generate::generate_video::request::TauriGenerateVideoRequest; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::events::generation_events::common::GenerationModel; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::utils::api_host::ApiHost; +use router::api::audio_list_ref::AudioListRef; +use router::api::character_list_ref::CharacterListRef; +use router::api::router_video_model::RouterVideoModel; +use router::api::image_list_ref::ImageListRef; +use router::api::image_ref::ImageRef; +use router::api::router_provider::RouterProvider; +use router::api::video_list_ref::VideoListRef; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::client::router_artcraft_client::RouterArtcraftClient; +use router::client::router_client::RouterClient; +use router::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use router::generate::generate_video::generate_video_response::GenerateVideoResponse; +use router::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{error, info}; + +pub async fn handle_artcraft_video_via_router( + request: &TauriGenerateVideoRequest, + api_host: &ApiHost, + creds: &StorytellerCredentialSet, + model: RouterVideoModel, + generation_model: GenerationModel, + ledger: &AssetUploadLedger, +) -> Result { + let client = RouterClient::Artcraft(RouterArtcraftClient::new( + api_host.clone(), + creds.clone(), + )); + + // ArtCraft's API is token-native: local files and bytes upload to + // ArtCraft here, at generate time (the media must reach ArtCraft anyway). + let media = request.media_sources(); + let start_frame = maybe_source_to_artcraft_token(media.start_frame, ArtcraftMediaKind::Image, Some(creds), api_host, ledger) + .await?.map(ImageRef::MediaFileToken); + let end_frame = maybe_source_to_artcraft_token(media.end_frame, ArtcraftMediaKind::Image, Some(creds), api_host, ledger) + .await?.map(ImageRef::MediaFileToken); + + let reference_images = sources_to_artcraft_tokens(media.reference_images, ArtcraftMediaKind::Image, Some(creds), api_host, ledger) + .await?.map(ImageListRef::MediaFileTokens); + let reference_videos = sources_to_artcraft_tokens(media.reference_videos, ArtcraftMediaKind::Video, Some(creds), api_host, ledger) + .await?.map(VideoListRef::MediaFileTokens); + let reference_audio = sources_to_artcraft_tokens(media.reference_audios, ArtcraftMediaKind::Audio, Some(creds), api_host, ledger) + .await?.map(AudioListRef::MediaFileTokens); + + let reference_character_tokens = request.reference_character_tokens.clone().map(CharacterListRef::CharacterTokens); + + let router_request = GenerateVideoRequestBuilder { + model, + provider: RouterProvider::Artcraft, + prompt: request.prompt.clone(), + start_frame, + end_frame, + reference_images, + reference_videos, + reference_audio, + reference_character_tokens, + resolution: request.resolution, + aspect_ratio: request.aspect_ratio, + bitrate: None, + duration_seconds: request.duration_seconds, + video_batch_count: request.video_batch_count, + generate_audio: request.generate_audio, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + idempotency_token: None, + negative_prompt: None, + }; + + info!("Building request for artcraft_router (v2 pipeline)..."); + let response = generate_via_v2(router_request, &client).await?; + + let job_id = response.get_artcraft_payload() + .map(|p| p.inference_job_token.to_string()) + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!( + "Router video generation enqueued: inference_job_token={}, response={:?}", + job_id, + response, + ); + + Ok(TaskEnqueueSuccess { + task_type: TaskType::VideoGeneration, + model: Some(generation_model), + provider: GenerationSource::Artcraft, + provider_job_id: Some(job_id), + is_batch_generation: request.video_batch_count.unwrap_or(1) > 1, + maybe_queue_status_url: None, + maybe_prompt_token: None, + maybe_queue_response_url: None, + }) +} + +/// V2 pipeline: build2 → send_request (Artcraft skips draft phase). +async fn generate_via_v2( + router_request: GenerateVideoRequestBuilder, + client: &RouterClient, +) -> Result { + let draft_or_request = router_request.build2()?; + + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + VideoGenerationDraftOrRequest::Draft(_) => { + error!("Unexpected Draft variant for Artcraft provider"); + return Err(GenerateError::NotYetImplemented("Artcraft provider should not produce a draft request".to_string())); + } + }; + + let response = request.send_request(client).await.map_err(|err| { + error!("V2 failed to enqueue: {:?}", err); + GenerateError::from(err) + })?; + + info!("V2 successfully enqueued."); + Ok(response) +} diff --git a/crates/artcraftx/src/commands/generate/generate_video/artcraft/mod.rs b/crates/artcraftx/src/commands/generate/generate_video/artcraft/mod.rs new file mode 100644 index 00000000..b9004285 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/artcraft/mod.rs @@ -0,0 +1 @@ +pub mod handle_artcraft_video_via_router; diff --git a/crates/artcraftx/src/commands/generate/generate_video/generate_video_command.rs b/crates/artcraftx/src/commands/generate/generate_video/generate_video_command.rs new file mode 100644 index 00000000..e744a185 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/generate_video_command.rs @@ -0,0 +1,174 @@ +use crate::commands::generate::common::notify_frontend_of_errors::notify_frontend_of_errors; +use crate::commands::generate::common::tauri_media_source::validate_sources; +use crate::commands::generate::generate_error::{BadInputReason, GenerateError, MissingCredentialsReason}; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::generate_video::handle_credential_router::handle_credential_router; +use crate::commands::generate::generate_video::request::{ + TauriGenerateVideoErrorType, TauriGenerateVideoRequest, TauriGenerateVideoResponse, +}; +use crate::commands::utils::response::failure_response_wrapper::{CommandErrorResponseWrapper, CommandErrorStatus}; +use crate::commands::utils::response::shorthand::Response; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::credits_balance_changed_event::CreditsBalanceChangedEvent; +use crate::events::generation_events::generation_enqueue_success_event::GenerationEnqueueSuccessEvent; +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use crate::state::usage_tracker::artcraft_usage_type::{ArtcraftUsagePage, ArtcraftUsageType}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::database::task_database::TaskDatabase; +use log::{error, info, warn}; +use tauri::{AppHandle, State}; + +#[tauri::command] +pub async fn generate_video_command( + mut request: TauriGenerateVideoRequest, + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + artcraft_usage_tracker: State<'_, ArtcraftUsageTracker>, + task_database: State<'_, TaskDatabase>, + local_files_database: State<'_, LocalFilesDatabase>, +) -> Response { + + info!("generate_video_command called, request: {:?}", request); + + if request.image_media_token.is_none() + && request.start_frame_image_media_token.is_some() { + // NB: This is to fix the legacy handlers + request.image_media_token = request.start_frame_image_media_token.clone(); + } + + if request.image_media_token.is_some() + && request.start_frame_image_media_token.is_none() { + // NB: This is to fix the modern handlers + request.start_frame_image_media_token = request.image_media_token.clone(); + } + + let ledger = AssetUploadLedger::new(local_files_database.inner().clone()); + let result = handle_request( + request, + &app, + &app_data_root, + &artcraft_usage_tracker, + &task_database, + &ledger, + ).await; + + match result { + Err(err) => { + error!("error: {:?}", err); + + notify_frontend_of_errors(&app, &err).await; + + let mut status = CommandErrorStatus::ServerError; + let mut error_type = TauriGenerateVideoErrorType::ServerError; + let mut error_message = "A server error occurred. Please try again. If it continues, please tell our staff about the problem.".to_string(); + + match err { + GenerateError::BadInput(BadInputReason::NoModelSpecified) => { + status = CommandErrorStatus::BadRequest; + error_type = TauriGenerateVideoErrorType::ModelNotSpecified; + error_message = "No model specified for video generation".to_string(); + } + GenerateError::BadInput(BadInputReason::LocalMediaFileNotFound { path }) => { + status = CommandErrorStatus::BadRequest; + error_message = format!("A reference file no longer exists on disk: {}", path.display()); + } + GenerateError::NoProviderAvailable => { + status = CommandErrorStatus::ServerError; + error_type = TauriGenerateVideoErrorType::NoProviderAvailable; + error_message = "No configured provider available for video generation".to_string(); + } + GenerateError::CredentialProblem(reason) => { + status = CommandErrorStatus::Unauthorized; + error_type = TauriGenerateVideoErrorType::CredentialProblem; + error_message = reason.user_message(); + } + GenerateError::NotYetImplemented(message) => { + error_message = message; + } + GenerateError::MissingCredentials(MissingCredentialsReason::NeedsFalApiKey) => { + status = CommandErrorStatus::Unauthorized; + error_type = TauriGenerateVideoErrorType::NeedsFalApiKey; + error_message = "You need to set a FAL api key".to_string(); + }, + GenerateError::MissingCredentials(MissingCredentialsReason::NeedsStorytellerCredentials) => { + status = CommandErrorStatus::Unauthorized; + error_type = TauriGenerateVideoErrorType::NeedsStorytellerCredentials; + error_message = "You need to be logged into Artcraft.".to_string(); + } + GenerateError::ProviderRejected(message) => { + // The provider refused for a reason the user can act on; the + // message already explains it. + status = CommandErrorStatus::BadRequest; + error_message = message; + } + _ => {}, // Fall-through + } + + Err(CommandErrorResponseWrapper { + status, + error_message: Some(error_message), + error_type: Some(error_type), + error_details: None, + }) + } + Ok(event) => { + let event = GenerationEnqueueSuccessEvent { + action: event.to_frontend_event_action(), + service: event.to_frontend_event_service(), + model: event.model, + }; + + if let Err(err) = event.send(&app) { + error!("Failed to emit event: {:?}", err); + } + + CreditsBalanceChangedEvent{}.send_infallible(&app); + + Ok(TauriGenerateVideoResponse {}.into()) + } + } +} + +async fn handle_request( + request: TauriGenerateVideoRequest, + app: &AppHandle, + app_data_root: &AppDataRoot, + artcraft_usage_tracker: &ArtcraftUsageTracker, + task_database: &TaskDatabase, + ledger: &AssetUploadLedger, +) -> Result { + + // Reject unusable media sources (missing local files, empty bytes) before + // any provider work. + validate_sources(request.media_sources().iter())?; + + // Generation is credential-driven: the request names a stored credential, + // and the router dispatches to that credential's service. + let result = handle_credential_router(&request, Some(app), app_data_root, ledger).await; + + let success_event = match result { + Err(err) => return Err(err), + Ok(event) => event, + }; + + let result = success_event + .insert_into_task_database_with_frontend_payload( + task_database, + request.frontend_caller, + request.frontend_subscriber_id.as_deref(), + request.frontend_subscriber_payload.as_deref() + ) + .await; + + if let Err(err) = result { + error!("Failed to create task in database: {:?}", err); + } + + if let Err(err) = artcraft_usage_tracker.record_video_generation(1, ArtcraftUsageType::ImageToResult, ArtcraftUsagePage::VideoPage) { + warn!("Failed to report usage: {:?}", err); + } + + Ok(success_event) +} diff --git a/crates/artcraftx/src/commands/generate/generate_video/handle_credential_router.rs b/crates/artcraftx/src/commands/generate/generate_video/handle_credential_router.rs new file mode 100644 index 00000000..8883ab28 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/handle_credential_router.rs @@ -0,0 +1,160 @@ +use log::info; + +use crate::commands::utils::api_adapters::models::video::tauri_video_model_to_generation_model::tauri_video_model_to_generation_model; +use crate::commands::utils::api_adapters::models::video::tauri_video_model_to_router_model::tauri_video_model_to_router_model; +use crate::commands::generate::generate_error::GenerateError; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::generate::common::generation_credential::{credential_not_usable, resolve_generation_credential, storyteller_creds_from_credential}; +use crate::commands::generate::generate_video::artcraft::handle_artcraft_video_via_router::handle_artcraft_video_via_router; +use crate::commands::generate::generate_video::higgsfield::handle_higgsfield_video_via_router::handle_higgsfield_video_via_router; +use crate::commands::generate::generate_video::request::TauriGenerateVideoRequest; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; +use crate::credentials::auth_credential::AuthCredential; +use core_types::enums::generation_source::GenerationSource; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::data_dir::app_data_root::AppDataRoot; +use tauri::AppHandle; + +/// Credential-driven video generation: resolve the stored credential named +/// by the request's `credential_id`, then route to that credential's service +/// via the router. The router owns upload + dispatch mechanics per provider. +pub async fn handle_credential_router( + request: &TauriGenerateVideoRequest, + // Optional so headless callers (live tests) can skip UI notices. + maybe_app: Option<&AppHandle>, + app_data_root: &AppDataRoot, + ledger: &AssetUploadLedger, +) -> Result { + let credential = resolve_generation_credential( + request.credential_id.as_deref(), + app_data_root, + )?; + + info!( + "handle_credential_router (video): credential={} service={}", + credential.id.as_str(), + credential.service, + ); + + match credential.service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies => { + handle_artcraft_credential(request, &credential, ledger).await + } + GenerationSource::HiggsfieldCookies + | GenerationSource::Higgsfield => { + // Reference media is uploaded (with Higgsfield's 15-30s IP/likeness + // scan) or reused from the ledger; the notices for either come from + // the router's upload observer, so nothing is announced up front. + handle_higgsfield_video_via_router(maybe_app, request, &credential, ledger).await + } + other => Err(credential_not_usable( + &credential, + &format!("accounts for service {} can't generate videos yet", other), + )), + } +} + +/// Generate via the router's Artcraft provider, authenticating with the +/// stored session cookies. Video requests carry media tokens only, which +/// Artcraft accepts directly — no pre-upload step is needed. +async fn handle_artcraft_credential( + request: &TauriGenerateVideoRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + + let router_model = tauri_video_model_to_router_model(tauri_model); + let generation_model = tauri_video_model_to_generation_model(tauri_model); + + let api_host = maybe_artcraft_api_host_for_service(credential.service) + .expect("caller only routes ArtCraft services here"); + + let creds = storyteller_creds_from_credential(credential)?; + + handle_artcraft_video_via_router( + request, + &api_host, + &creds, + router_model, + generation_model, + ledger, + ).await +} + +/// Live smoke test that hits the REAL production API with the REAL stored +/// credential and SPENDS CREDITS. `#[ignore]`; run explicitly: +/// SQLX_OFFLINE=true cargo test -p artcraftx live_generation -- --ignored --nocapture +#[cfg(test)] +mod live_generation_tests { + use artcraft_client::endpoints::media_files::upload_image_media_file_from_bytes::{upload_image_media_file_from_bytes, ImageType, UploadImageBytesArgs}; + use artcraft_client::utils::api_host::ApiHost; + use router::api::router_resolution::RouterResolution; + + use crate::commands::generate::generate_video::request::TauriVideoModel; + + use super::*; + + #[tokio::test] + #[ignore] // live: spends credits on api.storyteller.ai + async fn live_generation_video_seedance_lite_480p() { + let app_data_root = AppDataRoot::create_default().expect("app data root"); + let credential_id = app_data_root + .credentials_dir() + .load_credentials() + .expect("load credentials") + .into_iter() + .find(|c| c.service == GenerationSource::Artcraft) + .expect("no `artcraft` (production) credential on disk") + .id + .as_str() + .to_string(); + + // Seedance is image-to-video: upload a small start frame first, using + // the same stored credential the generation will use. + let credential = app_data_root + .credentials_dir() + .find_credential_by_id(&credential_id) + .expect("lookup") + .expect("credential exists"); + let creds = storyteller_creds_from_credential(&credential).expect("cookie creds"); + + let mut png_bytes: Vec = Vec::new(); + let start_frame = image::RgbaImage::from_fn(512, 512, |x, y| { + image::Rgba([(x / 2) as u8, (y / 2) as u8, 200, 255]) + }); + image::DynamicImage::ImageRgba8(start_frame) + .write_to(&mut std::io::Cursor::new(&mut png_bytes), image::ImageFormat::Png) + .expect("encode png"); + + let upload = upload_image_media_file_from_bytes(UploadImageBytesArgs { + api_host: &ApiHost::Storyteller, + maybe_creds: Some(&creds), + image_bytes: png_bytes, + image_type: ImageType::Png, + is_intermediate_system_file: true, + maybe_generation_provider: None, + }).await.expect("start frame upload"); + println!("[live] start frame uploaded: {}", upload.media_file_token.as_str()); + + let request = TauriGenerateVideoRequest { + credential_id: Some(credential_id), + model: Some(TauriVideoModel::Seedance10Lite), + prompt: Some("gentle camera pan across a colorful gradient".to_string()), + start_frame_image_media_token: Some(upload.media_file_token.clone()), + image_media_token: Some(upload.media_file_token), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + + let ledger = AssetUploadLedger::new(crate::state::database::local_files_database::LocalFilesDatabase::connect(&app_data_root).await.expect("local files db")); + let result = handle_credential_router(&request, None, &app_data_root, &ledger).await; + let success = result.expect("seedance lite enqueue should succeed"); + println!("[live] seedance 1.0 lite enqueued: job_id={:?}", success.provider_job_id); + assert!(success.provider_job_id.is_some()); + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_video/higgsfield/handle_higgsfield_video_via_router.rs b/crates/artcraftx/src/commands/generate/generate_video/higgsfield/handle_higgsfield_video_via_router.rs new file mode 100644 index 00000000..ccf84e96 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/higgsfield/handle_higgsfield_video_via_router.rs @@ -0,0 +1,171 @@ +//! Video generation on the user's own Higgsfield account, via the router's +//! first-party Higgsfield provider. + +use core_types::enums::generation_source::GenerationSource; +use log::info; +use router::api::router_provider::RouterProvider; +use router::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use router::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use sqlite_identifiers::enums::task_type::TaskType; +use tauri::AppHandle; + +use crate::commands::generate::common::higgsfield_generation::{ + higgsfield_media_url_map, higgsfield_router_client, join_higgsfield_job_ids, send_higgsfield_video_request, +}; +use crate::commands::generate::common::media_source_conversion::{ + collect_source_tokens, source_to_image_ref, sources_to_audio_list, sources_to_image_list, sources_to_video_list, +}; +use crate::commands::generate::generate_error::GenerateError; +use crate::commands::generate::generate_video::request::TauriGenerateVideoRequest; +use crate::commands::generate::task_enqueue_success::TaskEnqueueSuccess; +use crate::commands::utils::api_adapters::models::video::tauri_video_model_to_generation_model::tauri_video_model_to_generation_model; +use crate::commands::utils::api_adapters::models::video::tauri_video_model_to_router_model::tauri_video_model_to_router_model; +use crate::credentials::auth_credential::AuthCredential; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; + +/// Enqueue via the router's first-party Higgsfield provider. +/// +/// Keyframes and image / video / audio references arrive as three-way media +/// sources. Local files and raw bytes go straight to Higgsfield; only +/// ArtCraft media tokens (cloud-library picks) resolve to CDN URLs through +/// the map built here before the router downloads and re-uploads them +/// (running Higgsfield's IP check where the model demands it). The returned +/// task carries every job id of the Higgsfield job set so the poller can +/// follow a batch. +pub async fn handle_higgsfield_video_via_router( + maybe_app: Option<&AppHandle>, + request: &TauriGenerateVideoRequest, + credential: &AuthCredential, + ledger: &AssetUploadLedger, +) -> Result { + let tauri_model = request.model.ok_or(GenerateError::no_model_specified())?; + let router_model = tauri_video_model_to_router_model(tauri_model); + let generation_model = tauri_video_model_to_generation_model(tauri_model); + + let media = request.media_sources(); + let media_url_map = higgsfield_media_url_map(&collect_source_tokens(media.iter())).await?; + + // Character references have no Higgsfield equivalent; the router drops + // them with a warning, so they aren't forwarded at all. + let router_request = GenerateVideoRequestBuilder { + model: router_model, + provider: RouterProvider::Higgsfield, + prompt: request.prompt.clone(), + negative_prompt: request.negative_prompt.clone(), + start_frame: source_to_image_ref(media.start_frame), + end_frame: source_to_image_ref(media.end_frame), + reference_images: sources_to_image_list(media.reference_images), + reference_videos: sources_to_video_list(media.reference_videos), + reference_audio: sources_to_audio_list(media.reference_audios), + reference_character_tokens: None, + resolution: request.resolution, + aspect_ratio: request.aspect_ratio, + bitrate: None, + duration_seconds: request.duration_seconds, + video_batch_count: request.video_batch_count, + generate_audio: request.generate_audio, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + idempotency_token: None, + }; + + let client = higgsfield_router_client(credential)?; + // References this account already uploaded are reused by media id. + let upload_cache = ledger.for_higgsfield_credential(&credential.id); + let response = send_higgsfield_video_request(maybe_app, credential, router_request, &client, &media_url_map, &upload_cache).await?; + + let payload = response + .get_higgsfield_payload() + .ok_or(GenerateError::ResponseHadNoJobTokens)?; + + info!( + "Higgsfield video generation enqueued: job_set={} jobs={:?}", + payload.job_set_id, payload.job_ids, + ); + + Ok(TaskEnqueueSuccess { + task_type: TaskType::VideoGeneration, + model: Some(generation_model), + // NB: the task uses the bare `Higgsfield` provider (what the polling + // thread queries), not the `HiggsfieldCookies` credential service. + provider: GenerationSource::Higgsfield, + provider_job_id: Some(join_higgsfield_job_ids(&payload.job_ids)), + is_batch_generation: payload.job_ids.len() > 1, + maybe_queue_status_url: None, + maybe_queue_response_url: None, + maybe_prompt_token: None, + }) +} + +/// Live smoke tests that hit the REAL Higgsfield API with the REAL stored +/// credential and SPEND HIGGSFIELD CREDITS. `#[ignore]`; run explicitly: +/// SQLX_OFFLINE=true cargo test -p artcraftx live_higgsfield_video -- --ignored --nocapture +#[cfg(test)] +mod live_higgsfield_video_tests { + use router::api::router_aspect_ratio::RouterAspectRatio; + use router::api::router_resolution::RouterResolution; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::commands::generate::generate_video::request::TauriVideoModel; + use crate::state::data_dir::app_data_root::AppDataRoot; + + use super::*; + + async fn test_ledger() -> AssetUploadLedger { + let app_data_root = AppDataRoot::create_default().expect("app data root"); + AssetUploadLedger::new(crate::state::database::local_files_database::LocalFilesDatabase::connect(&app_data_root).await.expect("local files db")) + } + + /// A production ArtCraft media file (see `test_data::web::image_media_tokens`). + const JUNO_AT_LAKE_MEDIA_TOKEN: &str = "m_m1bz02z1kkzanxy6rb4vk1kvq9de9g"; + + fn higgsfield_credential() -> AuthCredential { + let app_data_root = AppDataRoot::create_default().expect("app data root"); + app_data_root + .credentials_dir() + .load_credentials() + .expect("load credentials") + .into_iter() + .find(|c| c.service == GenerationSource::HiggsfieldCookies) + .expect("no `higgsfield_cookies` credential on disk; log into Higgsfield via the app first") + } + + #[tokio::test] + #[ignore] // live: spends Higgsfield credits + async fn live_higgsfield_video_text_to_video() { + let credential = higgsfield_credential(); + let request = TauriGenerateVideoRequest { + credential_id: Some(credential.id.as_str().to_string()), + model: Some(TauriVideoModel::Seedance2p0Mini), + prompt: Some("a shiba inu surfing a big wave, action photo".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + }; + + let success = handle_higgsfield_video_via_router(None, &request, &credential, &test_ledger().await).await.expect("enqueue should succeed"); + println!("[live] Higgsfield video enqueued: provider_job_id={:?}", success.provider_job_id); + assert_eq!(success.provider, GenerationSource::Higgsfield); + assert!(success.provider_job_id.is_some()); + } + + #[tokio::test] + #[ignore] // live: spends Higgsfield credits and uploads a start frame (with IP check) + async fn live_higgsfield_video_from_start_frame() { + let credential = higgsfield_credential(); + let request = TauriGenerateVideoRequest { + credential_id: Some(credential.id.as_str().to_string()), + model: Some(TauriVideoModel::Seedance2p0Mini), + prompt: Some("gentle camera push-in, ripples on the water".to_string()), + start_frame_image_media_token: Some(MediaFileToken::new_from_str(JUNO_AT_LAKE_MEDIA_TOKEN)), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(4), + ..Default::default() + }; + + let success = handle_higgsfield_video_via_router(None, &request, &credential, &test_ledger().await).await.expect("enqueue should succeed"); + println!("[live] Higgsfield image-to-video enqueued: provider_job_id={:?}", success.provider_job_id); + assert!(success.provider_job_id.is_some()); + } +} diff --git a/crates/artcraftx/src/commands/generate/generate_video/higgsfield/mod.rs b/crates/artcraftx/src/commands/generate/generate_video/higgsfield/mod.rs new file mode 100644 index 00000000..efb14dd3 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/higgsfield/mod.rs @@ -0,0 +1 @@ +pub mod handle_higgsfield_video_via_router; diff --git a/crates/artcraftx/src/commands/generate/generate_video/mod.rs b/crates/artcraftx/src/commands/generate/generate_video/mod.rs new file mode 100644 index 00000000..3895a111 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/mod.rs @@ -0,0 +1,5 @@ +pub mod generate_video_command; +mod handle_credential_router; +pub mod request; +pub mod artcraft; +pub mod higgsfield; diff --git a/crates/artcraftx/src/commands/generate/generate_video/request.rs b/crates/artcraftx/src/commands/generate/generate_video/request.rs new file mode 100644 index 00000000..72114dee --- /dev/null +++ b/crates/artcraftx/src/commands/generate/generate_video/request.rs @@ -0,0 +1,244 @@ +use router::api::router_aspect_ratio::RouterAspectRatio; +use router::api::router_resolution::RouterResolution; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use serde_derive::{Deserialize, Serialize}; +use artcraft_client::tokens::characters::CharacterToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::common::tauri_media_source::{ + merge_source_with_legacy_token, merge_sources_with_legacy_tokens, TauriMediaSource, +}; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +/// This is used in the Tauri command bridge. +/// Don't change the serializations without coordinating with the frontend. +/// +/// MIGRATION (2026-07): we're moving the frontend to send storyteller-web omni +/// identifiers (`CommonVideoModel` serde strings). Variants whose legacy Tauri +/// id differs carry the omni id as a `#[serde(alias)]` so BOTH deserialize. +/// Once the frontend is 100% omni ids, the legacy renames can be dropped. +#[derive(Deserialize, Debug, Copy, Clone)] +#[serde(rename_all = "snake_case")] +pub enum TauriVideoModel { + #[serde(rename = "grok_video", alias = "grok_imagine_video")] + GrokVideo, + + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + + #[serde(rename = "kling_1.6_pro", alias = "kling_1p6_pro")] + Kling16Pro, + + #[serde(rename = "kling_2.1_pro", alias = "kling_2p1_pro")] + Kling21Pro, + + #[serde(rename = "kling_2.1_master", alias = "kling_2p1_master")] + Kling21Master, + + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + + #[serde(rename = "seedance_1.0_lite", alias = "seedance_1p0_lite")] + Seedance10Lite, + + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + + #[serde(rename = "seedance_2p0")] + Seedance2p0, + + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + + #[serde(rename = "seedance_2p5")] + Seedance2p5, + + #[serde(rename = "seedance_2p5_edit")] + Seedance2p5Edit, + + #[serde(rename = "minimax_h3")] + MinimaxH3, + + #[serde(rename = "sora_2")] + Sora2, + + #[serde(rename = "sora_2_pro")] + Sora2Pro, + + #[serde(rename = "veo_2")] + Veo2, + + #[serde(rename = "veo_3")] + Veo3, + + #[serde(rename = "veo_3_fast")] + Veo3Fast, + + #[serde(rename = "veo_3p1")] + Veo3p1, + + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + + #[serde(rename = "vidu_q3")] + ViduQ3, + + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, +} + +#[derive(Deserialize, Debug, Clone, Default)] +pub struct TauriGenerateVideoRequest { + /// Stable id (`credential_{entropy}`) of the stored credential (account) + /// to generate with. Loaded from disk; generation routes to the + /// credential's service. + pub credential_id: Option, + + pub provider: Option, + pub model: Option, + + pub prompt: Option, + pub negative_prompt: Option, + + #[deprecated(note = "Use start_frame_image_media_token instead")] + pub image_media_token: Option, + + pub start_frame_image_media_token: Option, + pub end_frame_image_media_token: Option, + + pub reference_image_media_tokens: Option>, + pub reference_video_media_tokens: Option>, + pub reference_audio_media_tokens: Option>, + pub reference_character_tokens: Option>, + + // Three-way media sources (bytes | local path | media token). Each wins + // over its legacy `*_media_token(s)` twin above when both are set; local + // files and bytes never touch the ArtCraft cloud unless the target + // provider requires it. + pub start_frame_image_source: Option, + pub end_frame_image_source: Option, + pub reference_image_sources: Option>, + pub reference_video_sources: Option>, + pub reference_audio_sources: Option>, + + pub aspect_ratio: Option, + pub resolution: Option, + + pub duration_seconds: Option, + pub generate_audio: Option, + pub video_batch_count: Option, + + #[deprecated(note = "Use start_frame_image_media_token instead")] + pub sora_orientation: Option, + + #[deprecated(note = "Use start_frame_image_media_token instead")] + pub grok_aspect_ratio: Option, + + pub frontend_caller: Option, + pub frontend_subscriber_id: Option, + pub frontend_subscriber_payload: Option, +} + +/// The request's media inputs, normalized: legacy token fields are folded +/// into [`TauriMediaSource`]s so handlers see one shape. +#[derive(Debug, Clone)] +pub struct VideoRequestMediaSources { + pub start_frame: Option, + pub end_frame: Option, + pub reference_images: Option>, + pub reference_videos: Option>, + pub reference_audios: Option>, +} + +impl TauriGenerateVideoRequest { + pub fn media_sources(&self) -> VideoRequestMediaSources { + VideoRequestMediaSources { + start_frame: merge_source_with_legacy_token( + self.start_frame_image_source.clone(), + self.start_frame_image_media_token.clone(), + ), + end_frame: merge_source_with_legacy_token( + self.end_frame_image_source.clone(), + self.end_frame_image_media_token.clone(), + ), + reference_images: merge_sources_with_legacy_tokens( + self.reference_image_sources.clone(), + self.reference_image_media_tokens.clone(), + ), + reference_videos: merge_sources_with_legacy_tokens( + self.reference_video_sources.clone(), + self.reference_video_media_tokens.clone(), + ), + reference_audios: merge_sources_with_legacy_tokens( + self.reference_audio_sources.clone(), + self.reference_audio_media_tokens.clone(), + ), + } + } +} + +impl VideoRequestMediaSources { + /// Every source the request carries, for up-front validation and for + /// collecting the tokens that need CDN resolution. + pub fn iter(&self) -> impl Iterator { + self.start_frame.iter() + .chain(self.end_frame.iter()) + .chain(self.reference_images.iter().flatten()) + .chain(self.reference_videos.iter().flatten()) + .chain(self.reference_audios.iter().flatten()) + } +} + +#[derive(Deserialize, Debug, Clone, Copy)] +#[serde(rename_all = "snake_case")] +pub enum SoraOrientation { + Portrait, + Landscape, +} + +#[derive(Deserialize, Debug, Clone, Copy)] +#[serde(rename_all = "snake_case")] +pub enum GrokAspectRatio { + Portrait, + Landscape, + Square, +} + +#[derive(Serialize)] +pub struct TauriGenerateVideoResponse { +} + +impl SerializeMarker for TauriGenerateVideoResponse {} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "snake_case")] +pub enum TauriGenerateVideoErrorType { + ModelNotSpecified, + NoProviderAvailable, + ServerError, + NeedsFalApiKey, + FalError, + NeedsStorytellerCredentials, + /// Problem with the selected account credential (absent, unknown, or + /// unusable). The backend also flashes a dismissable modal. + CredentialProblem, +} diff --git a/crates/artcraftx/src/commands/generate/mod.rs b/crates/artcraftx/src/commands/generate/mod.rs new file mode 100644 index 00000000..a505e0d2 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/mod.rs @@ -0,0 +1,9 @@ +pub mod generate_audio; +pub mod generate_image; +pub mod generate_mesh; +pub mod generate_splat; +pub mod generate_video; +pub mod common; +pub mod generate_error; +pub mod task_enqueue_success; +pub mod models; diff --git a/crates/artcraftx/src/commands/generate/models/audio/list_audio_models_command.rs b/crates/artcraftx/src/commands/generate/models/audio/list_audio_models_command.rs new file mode 100644 index 00000000..3689c61e --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/audio/list_audio_models_command.rs @@ -0,0 +1,33 @@ +//! Tauri command: list every audio model, with capabilities, presentation, and +//! which providers offer it. Served from the built-in `models` crate tables. + +use log::info; +use models::configs::audio_model_config::AudioModelConfig; +use models::configs::audio_models::AUDIO_MODELS; +use models::providers::audio_providers::{AudioProviderOffering, AUDIO_PROVIDERS}; +use serde_derive::Serialize; + +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +#[derive(Clone, Debug, Serialize)] +pub struct ListAudioModelsResponse { + /// Every model, in picker order. Includes disabled models (`is_disabled`), + /// which the frontend hides but keeps addressable. + pub models: Vec, + /// Which providers offer which of those models (a model absent from every + /// provider can't be generated). The first provider listing a model is its + /// default. + pub providers: Vec, +} + +impl SerializeMarker for ListAudioModelsResponse {} + +#[tauri::command] +pub async fn list_audio_models_command() -> ResponseOrErrorMessage { + info!("list_audio_models_command called"); + Ok(ListAudioModelsResponse { + models: AUDIO_MODELS.clone(), + providers: AUDIO_PROVIDERS.clone(), + }.into()) +} diff --git a/crates/artcraftx/src/commands/generate/models/audio/mod.rs b/crates/artcraftx/src/commands/generate/models/audio/mod.rs new file mode 100644 index 00000000..7372acfa --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/audio/mod.rs @@ -0,0 +1 @@ +pub mod list_audio_models_command; diff --git a/crates/artcraftx/src/commands/generate/models/image/list_image_models_command.rs b/crates/artcraftx/src/commands/generate/models/image/list_image_models_command.rs new file mode 100644 index 00000000..86a89e56 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/image/list_image_models_command.rs @@ -0,0 +1,33 @@ +//! Tauri command: list every image model, with capabilities, presentation, and +//! which providers offer it. Served from the built-in `models` crate tables. + +use log::info; +use models::configs::image_model_config::ImageModelConfig; +use models::configs::image_models::IMAGE_MODELS; +use models::providers::image_providers::{ImageProviderOffering, IMAGE_PROVIDERS}; +use serde_derive::Serialize; + +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +#[derive(Clone, Debug, Serialize)] +pub struct ListImageModelsResponse { + /// Every model, in picker order. Includes disabled models (`is_disabled`), + /// which the frontend hides but keeps addressable. + pub models: Vec, + /// Which providers offer which of those models (a model absent from every + /// provider can't be generated). The first provider listing a model is its + /// default. + pub providers: Vec, +} + +impl SerializeMarker for ListImageModelsResponse {} + +#[tauri::command] +pub async fn list_image_models_command() -> ResponseOrErrorMessage { + info!("list_image_models_command called"); + Ok(ListImageModelsResponse { + models: IMAGE_MODELS.clone(), + providers: IMAGE_PROVIDERS.clone(), + }.into()) +} diff --git a/crates/artcraftx/src/commands/generate/models/image/mod.rs b/crates/artcraftx/src/commands/generate/models/image/mod.rs new file mode 100644 index 00000000..6d4df049 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/image/mod.rs @@ -0,0 +1 @@ +pub mod list_image_models_command; diff --git a/crates/artcraftx/src/commands/generate/models/mesh/list_mesh_models_command.rs b/crates/artcraftx/src/commands/generate/models/mesh/list_mesh_models_command.rs new file mode 100644 index 00000000..0d88cabb --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/mesh/list_mesh_models_command.rs @@ -0,0 +1,33 @@ +//! Tauri command: list every mesh model, with capabilities, presentation, and +//! which providers offer it. Served from the built-in `models` crate tables. + +use log::info; +use models::configs::mesh_model_config::MeshModelConfig; +use models::configs::mesh_models::MESH_MODELS; +use models::providers::mesh_providers::{MeshProviderOffering, MESH_PROVIDERS}; +use serde_derive::Serialize; + +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +#[derive(Clone, Debug, Serialize)] +pub struct ListMeshModelsResponse { + /// Every model, in picker order. Includes disabled models (`is_disabled`), + /// which the frontend hides but keeps addressable. + pub models: Vec, + /// Which providers offer which of those models (a model absent from every + /// provider can't be generated). The first provider listing a model is its + /// default. + pub providers: Vec, +} + +impl SerializeMarker for ListMeshModelsResponse {} + +#[tauri::command] +pub async fn list_mesh_models_command() -> ResponseOrErrorMessage { + info!("list_mesh_models_command called"); + Ok(ListMeshModelsResponse { + models: MESH_MODELS.clone(), + providers: MESH_PROVIDERS.clone(), + }.into()) +} diff --git a/crates/artcraftx/src/commands/generate/models/mesh/mod.rs b/crates/artcraftx/src/commands/generate/models/mesh/mod.rs new file mode 100644 index 00000000..be73b99b --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/mesh/mod.rs @@ -0,0 +1 @@ +pub mod list_mesh_models_command; diff --git a/crates/artcraftx/src/commands/generate/models/mod.rs b/crates/artcraftx/src/commands/generate/models/mod.rs new file mode 100644 index 00000000..ac2d83d5 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/mod.rs @@ -0,0 +1,9 @@ +//! Tauri commands that list the models the app knows about, per modality. +//! +//! All of them serve the built-in tables from the first-party `models` crate +//! verbatim; the frontend's pickers are built from these responses alone. +pub mod audio; +pub mod image; +pub mod mesh; +pub mod splat; +pub mod video; diff --git a/crates/artcraftx/src/commands/generate/models/splat/list_splat_models_command.rs b/crates/artcraftx/src/commands/generate/models/splat/list_splat_models_command.rs new file mode 100644 index 00000000..db9f45a6 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/splat/list_splat_models_command.rs @@ -0,0 +1,33 @@ +//! Tauri command: list every splat model, with capabilities, presentation, and +//! which providers offer it. Served from the built-in `models` crate tables. + +use log::info; +use models::configs::splat_model_config::SplatModelConfig; +use models::configs::splat_models::SPLAT_MODELS; +use models::providers::splat_providers::{SplatProviderOffering, SPLAT_PROVIDERS}; +use serde_derive::Serialize; + +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +#[derive(Clone, Debug, Serialize)] +pub struct ListSplatModelsResponse { + /// Every model, in picker order. Includes disabled models (`is_disabled`), + /// which the frontend hides but keeps addressable. + pub models: Vec, + /// Which providers offer which of those models (a model absent from every + /// provider can't be generated). The first provider listing a model is its + /// default. + pub providers: Vec, +} + +impl SerializeMarker for ListSplatModelsResponse {} + +#[tauri::command] +pub async fn list_splat_models_command() -> ResponseOrErrorMessage { + info!("list_splat_models_command called"); + Ok(ListSplatModelsResponse { + models: SPLAT_MODELS.clone(), + providers: SPLAT_PROVIDERS.clone(), + }.into()) +} diff --git a/crates/artcraftx/src/commands/generate/models/splat/mod.rs b/crates/artcraftx/src/commands/generate/models/splat/mod.rs new file mode 100644 index 00000000..b121d68e --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/splat/mod.rs @@ -0,0 +1 @@ +pub mod list_splat_models_command; diff --git a/crates/artcraftx/src/commands/generate/models/video/list_video_models_command.rs b/crates/artcraftx/src/commands/generate/models/video/list_video_models_command.rs new file mode 100644 index 00000000..8d36c54d --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/video/list_video_models_command.rs @@ -0,0 +1,33 @@ +//! Tauri command: list every video model, with capabilities, presentation, and +//! which providers offer it. Served from the built-in `models` crate tables. + +use log::info; +use models::configs::video_model_config::VideoModelConfig; +use models::configs::video_models::VIDEO_MODELS; +use models::providers::video_providers::{VideoProviderOffering, VIDEO_PROVIDERS}; +use serde_derive::Serialize; + +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; + +#[derive(Clone, Debug, Serialize)] +pub struct ListVideoModelsResponse { + /// Every model, in picker order. Includes disabled models (`is_disabled`), + /// which the frontend hides but keeps addressable. + pub models: Vec, + /// Which providers offer which of those models (a model absent from every + /// provider can't be generated). The first provider listing a model is its + /// default. + pub providers: Vec, +} + +impl SerializeMarker for ListVideoModelsResponse {} + +#[tauri::command] +pub async fn list_video_models_command() -> ResponseOrErrorMessage { + info!("list_video_models_command called"); + Ok(ListVideoModelsResponse { + models: VIDEO_MODELS.clone(), + providers: VIDEO_PROVIDERS.clone(), + }.into()) +} diff --git a/crates/artcraftx/src/commands/generate/models/video/mod.rs b/crates/artcraftx/src/commands/generate/models/video/mod.rs new file mode 100644 index 00000000..de435821 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/models/video/mod.rs @@ -0,0 +1 @@ +pub mod list_video_models_command; diff --git a/crates/artcraftx/src/commands/generate/task_enqueue_success.rs b/crates/artcraftx/src/commands/generate/task_enqueue_success.rs new file mode 100644 index 00000000..4bfbe174 --- /dev/null +++ b/crates/artcraftx/src/commands/generate/task_enqueue_success.rs @@ -0,0 +1,162 @@ +use crate::events::generation_events::common::{GenerationAction, GenerationModel, GenerationServiceProvider}; +use crate::utils::enum_conversion::generation_source::to_generation_service_provider; +use crate::state::database::task_database::TaskDatabase; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlite_database::error::SqliteTasksError; +use sqlite_database::queries::create::create_task::{create_task, CreateTaskArgs}; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct TaskEnqueueSuccess { + pub task_type: TaskType, + pub model: Option, + pub provider: GenerationSource, + pub provider_job_id: Option, + /// Whether the job produces more than one file. + pub is_batch_generation: bool, + pub maybe_queue_status_url: Option, + pub maybe_queue_response_url: Option, + pub maybe_prompt_token: Option, +} + +impl TaskEnqueueSuccess{ + pub fn to_frontend_event_action(&self) -> GenerationAction { + match self.task_type { + TaskType::ImageGeneration => GenerationAction::GenerateImage, + TaskType::SplatGeneration => GenerationAction::GenerateGaussian, + TaskType::VideoGeneration => GenerationAction::GenerateVideo, + TaskType::AudioGeneration => GenerationAction::GenerateAudio, + TaskType::MeshGeneration => GenerationAction::ImageTo3d, + } + } + + pub fn to_frontend_event_service(&self) -> GenerationServiceProvider { + to_generation_service_provider(self.provider) + } + + pub async fn insert_into_task_database(&self, task_database: &TaskDatabase) -> Result { + self.insert_into_task_database_with_frontend_payload( + task_database, + None, + None, + None, + ).await + } + + // TODO: This belongs somewhere else, not as a method of an event struct. + pub async fn insert_into_task_database_with_frontend_payload( + &self, + task_database: &TaskDatabase, + frontend_caller: Option, + frontend_subscriber_id: Option<&str>, + frontend_subscriber_payload: Option<&str>, + ) -> Result { + // TODO: Move this mapping elsewhere, or remove the other models. + let model_type = match self.model { + None => None, + Some(GenerationModel::Flux1Dev) => Some(TaskModelType::Flux1Dev), + Some(GenerationModel::FluxDevJuggernaut) => Some(TaskModelType::FluxDevJuggernaut), + Some(GenerationModel::Flux1Schnell) => Some(TaskModelType::Flux1Schnell), + Some(GenerationModel::FluxPro1) => Some(TaskModelType::FluxPro1), // NB: This is for inpainting. + Some(GenerationModel::FluxPro11) => Some(TaskModelType::FluxPro11), + Some(GenerationModel::FluxPro11Ultra) => Some(TaskModelType::FluxPro11Ultra), + Some(GenerationModel::FluxProKontextMax) => Some(TaskModelType::FluxProKontextMax), + Some(GenerationModel::Gemini25Flash) => Some(TaskModelType::Gemini25Flash), + Some(GenerationModel::NanoBanana) => Some(TaskModelType::NanoBanana), + Some(GenerationModel::NanoBanana2) => Some(TaskModelType::NanoBanana2), + Some(GenerationModel::NanoBanana2Lite) => Some(TaskModelType::NanoBanana2Lite), + Some(GenerationModel::NanoBananaPro) => Some(TaskModelType::NanoBananaPro), + Some(GenerationModel::GptImage1) => Some(TaskModelType::GptImage1), + Some(GenerationModel::GptImage1p5) => Some(TaskModelType::GptImage1p5), + Some(GenerationModel::GptImage2) => Some(TaskModelType::GptImage2), + Some(GenerationModel::Seedream4) => Some(TaskModelType::Seedream4), + Some(GenerationModel::Seedream4p5) => Some(TaskModelType::Seedream4p5), + Some(GenerationModel::Seedream5Lite) => Some(TaskModelType::Seedream5Lite), + Some(GenerationModel::Seedream5p0Pro) => Some(TaskModelType::Seedream5p0Pro), + Some(GenerationModel::Seedream5p0ProUltra) => Some(TaskModelType::Seedream5p0ProUltra), + Some(GenerationModel::QwenEdit2511Angles) => Some(TaskModelType::QwenEdit2511Angles), + Some(GenerationModel::Flux2LoraAngles) => Some(TaskModelType::Flux2LoraAngles), + Some(GenerationModel::GrokImage) => Some(TaskModelType::GrokImage), + Some(GenerationModel::Recraft3) => Some(TaskModelType::Recraft3), + Some(GenerationModel::GrokVideo) => Some(TaskModelType::GrokVideo), + Some(GenerationModel::GrokImagineVideo1p5) => Some(TaskModelType::GrokImagineVideo1p5), + Some(GenerationModel::Kling21Pro) => Some(TaskModelType::Kling21Pro), + Some(GenerationModel::Kling21Master) => Some(TaskModelType::Kling21Master), + Some(GenerationModel::Kling2p5TurboPro) => Some(TaskModelType::Kling2p5TurboPro), + Some(GenerationModel::Kling2p6Pro) => Some(TaskModelType::Kling2p6Pro), + Some(GenerationModel::Kling3p0Standard) => Some(TaskModelType::Kling3p0Standard), + Some(GenerationModel::Kling3p0Pro) => Some(TaskModelType::Kling3p0Pro), + Some(GenerationModel::HappyHorse1p0) => Some(TaskModelType::HappyHorse1p0), + Some(GenerationModel::Seedance10Lite) => Some(TaskModelType::Seedance10Lite), + Some(GenerationModel::Seedance1p5Pro) => Some(TaskModelType::Seedance1p5Pro), + Some(GenerationModel::Seedance2p0) => Some(TaskModelType::Seedance2p0), + Some(GenerationModel::Seedance2p0Fast) => Some(TaskModelType::Seedance2p0Fast), + Some(GenerationModel::Seedance2p0Mini) => Some(TaskModelType::Seedance2p0Mini), + Some(GenerationModel::Seedance2p5) => Some(TaskModelType::Seedance2p5), + Some(GenerationModel::Seedance2p5Edit) => Some(TaskModelType::Seedance2p5Edit), + Some(GenerationModel::MinimaxH3) => Some(TaskModelType::MinimaxH3), + Some(GenerationModel::Sora2) => Some(TaskModelType::Sora2), + Some(GenerationModel::Sora2Pro) => Some(TaskModelType::Sora2Pro), + Some(GenerationModel::Veo2) => Some(TaskModelType::Veo2), + Some(GenerationModel::Veo3) => Some(TaskModelType::Veo3), + Some(GenerationModel::Veo3p1) => Some(TaskModelType::Veo3p1), + Some(GenerationModel::Veo3p1Fast) => Some(TaskModelType::Veo3p1Fast), + Some(GenerationModel::Veo3Fast) => Some(TaskModelType::Veo3Fast), + Some(GenerationModel::Veo3p1Lite) => Some(TaskModelType::Veo3p1Lite), + Some(GenerationModel::ViduQ3) => Some(TaskModelType::ViduQ3), + Some(GenerationModel::ViduQ3Turbo) => Some(TaskModelType::ViduQ3Turbo), + Some(GenerationModel::Hunyuan3d2_0) => Some(TaskModelType::Hunyuan3d2_0), + Some(GenerationModel::Hunyuan3d2_1) => Some(TaskModelType::Hunyuan3d2_1), + Some(GenerationModel::Hunyuan3d3) => Some(TaskModelType::Hunyuan3d3), + Some(GenerationModel::Hunyuan3d3Sketch) => Some(TaskModelType::Hunyuan3d3Sketch), + Some(GenerationModel::Hunyuan3d3p1Pro) => Some(TaskModelType::Hunyuan3d3p1Pro), + Some(GenerationModel::Hunyuan3d3p1Rapid) => Some(TaskModelType::Hunyuan3d3p1Rapid), + Some(GenerationModel::Hunyuan3d3p1Part) => Some(TaskModelType::Hunyuan3d3p1Part), + Some(GenerationModel::Hunyuan3d3p1SmartTopology) => Some(TaskModelType::Hunyuan3d3p1SmartTopology), + Some(GenerationModel::Tripo3dH3p1) => Some(TaskModelType::Tripo3dH3p1), + Some(GenerationModel::MeshyV6) => Some(TaskModelType::MeshyV6), + Some(GenerationModel::Rodin2p5Fast) => Some(TaskModelType::Rodin2p5Fast), + Some(GenerationModel::Marble1p0) => Some(TaskModelType::Marble1p0), + Some(GenerationModel::Marble1p0Draft) => Some(TaskModelType::Marble1p0Draft), + Some(GenerationModel::Marble1p1) => Some(TaskModelType::Marble1p1), + Some(GenerationModel::Marble1p1Plus) => Some(TaskModelType::Marble1p1Plus), + Some(GenerationModel::TripoSplat) => Some(TaskModelType::TripoSplat), + Some(GenerationModel::SunoMusic) => Some(TaskModelType::SunoMusic), + Some(GenerationModel::SunoRemix) => Some(TaskModelType::SunoRemix), + Some(GenerationModel::SunoSounds) => Some(TaskModelType::SunoSounds), + Some(GenerationModel::SunoSample) => Some(TaskModelType::SunoSample), + Some(GenerationModel::SeedAudio1p0) => Some(TaskModelType::SeedAudio1p0), + Some(GenerationModel::WorldlabsMarble) => Some(TaskModelType::WorldlabsMarble), + Some(GenerationModel::WorldlabsMarble0p1Mini) => Some(TaskModelType::WorldlabsMarble0p1Mini), + Some(GenerationModel::WorldlabsMarble0p1Plus) => Some(TaskModelType::WorldlabsMarble0p1Plus), + Some(GenerationModel::Midjourney) => Some(TaskModelType::Midjourney), // NB: This is a generic Midjourney model, version unknown. + Some(GenerationModel::Midjourney7) => Some(TaskModelType::Midjourney7), + Some(GenerationModel::Midjourney7Niji) => Some(TaskModelType::Midjourney7Niji), + Some(GenerationModel::Midjourney8) => Some(TaskModelType::Midjourney8), + + // TODO: These seem wrong - + Some(GenerationModel::Kling1_6) => Some(TaskModelType::Kling16Pro), // NB: `VideoModel::Kling16Pro`. + Some(GenerationModel::Kling2_0) => None, // TODO: unused elsewhere? + }; + + create_task(CreateTaskArgs { + db: task_database.get_connection(), + status: TaskStatus::Pending, + task_type: self.task_type, + model_type, + provider: self.provider, + provider_job_id: self.provider_job_id.as_deref(), + is_batch_generation: self.is_batch_generation, + queue_status_url: self.maybe_queue_status_url.as_deref(), + queue_response_url: self.maybe_queue_response_url.as_deref(), + prompt_token: self.maybe_prompt_token.as_ref(), + frontend_caller, + frontend_subscriber_id, + frontend_subscriber_payload, + }).await + } +} \ No newline at end of file diff --git a/crates/artcraftx/src/commands/local_files/get_local_thumbnails_command.rs b/crates/artcraftx/src/commands/local_files/get_local_thumbnails_command.rs new file mode 100644 index 00000000..8aa6fdbf --- /dev/null +++ b/crates/artcraftx/src/commands/local_files/get_local_thumbnails_command.rs @@ -0,0 +1,59 @@ +//! Bulk thumbnail lookup for local files. +//! +//! Takes one or more absolute file paths and returns, per path, the cached +//! thumbnail (and video animated preview) if the worker has produced it. +//! Anything still `pending` is handed to the worker thread; the frontend +//! learns of it through `local_thumbnail_ready_event`. Per-item statuses +//! mean one bad path never fails the batch, so the command is infallible. + +use std::path::PathBuf; + +use serde_derive::Deserialize; + +use crate::commands::utils::response::shorthand::InfallibleResponse; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::services::local_files::thumbnail_service::{lookup_thumbnail, LocalThumbnail, LocalThumbnailStatus}; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::state::thumbnails::thumbnail_work_queue::ThumbnailWorkQueue; +use log::info; +use serde_derive::Serialize; +use tauri::{AppHandle, State}; + +// ── Request ── + +#[derive(Debug, Deserialize)] +pub struct GetLocalThumbnailsRequest { + /// Absolute local file paths (typically completed results on disk). + pub file_paths: Vec, +} + +// ── Response ── + +#[derive(Debug, Serialize)] +pub struct GetLocalThumbnailsResponse { + /// One entry per requested path, in request order. + pub thumbnails: Vec, +} + +impl SerializeMarker for GetLocalThumbnailsResponse {} + +#[tauri::command] +pub async fn get_local_thumbnails_command( + app: AppHandle, + request: GetLocalThumbnailsRequest, + local_files_database: State<'_, LocalFilesDatabase>, +) -> Result, ()> { + info!("get_local_thumbnails_command called for {} path(s)", request.file_paths.len()); + + let file_paths: Vec = request.file_paths.iter().map(PathBuf::from).collect(); + let lookups = file_paths.iter().map(|file_path| lookup_thumbnail(&local_files_database, file_path)); + let thumbnails = futures::future::join_all(lookups).await; + + let pending: Vec<&str> = thumbnails.iter() + .filter(|thumbnail| thumbnail.status == LocalThumbnailStatus::Pending) + .map(|thumbnail| thumbnail.file_path.as_str()) + .collect(); + ThumbnailWorkQueue::enqueue_for_app(&app, &pending); + + Ok(GetLocalThumbnailsResponse { thumbnails }.into()) +} diff --git a/crates/artcraftx/src/commands/local_files/mod.rs b/crates/artcraftx/src/commands/local_files/mod.rs new file mode 100644 index 00000000..f3a0eea2 --- /dev/null +++ b/crates/artcraftx/src/commands/local_files/mod.rs @@ -0,0 +1 @@ +pub mod get_local_thumbnails_command; diff --git a/crates/artcraftx/src/commands/mod.rs b/crates/artcraftx/src/commands/mod.rs new file mode 100644 index 00000000..af3e21d9 --- /dev/null +++ b/crates/artcraftx/src/commands/mod.rs @@ -0,0 +1,8 @@ +pub mod cost_estimate; +pub mod credentials; +pub mod download; +pub mod generate; +pub mod local_files; +pub mod service; +pub mod task_queue; +pub mod utils; diff --git a/crates/artcraftx/src/commands/service/app_preferences/get_app_preferences_command.rs b/crates/artcraftx/src/commands/service/app_preferences/get_app_preferences_command.rs new file mode 100644 index 00000000..b92bf979 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/get_app_preferences_command.rs @@ -0,0 +1,26 @@ +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +/// The preferences as the frontend sees them: the same nested shape as the +/// on-disk file (`sounds`, `downloads`), minus the file version. +#[derive(Serialize)] +pub struct GetAppPreferencesResponse { + pub preferences: AppPreferences, +} + +#[tauri::command] +pub async fn get_app_preferences_command( + app_prefs: State<'_, AppPreferencesManager>, +) -> Result { + info!("get_app_preferences_command called"); + + let preferences = app_prefs.get().map_err(|err| { + error!("Error getting app preferences: {:?}", err); + format!("Error getting app preferences: {:?}", err) + })?; + + Ok(GetAppPreferencesResponse { preferences }) +} diff --git a/crates/artcraftx/src/commands/service/app_preferences/load_custom_sound_command.rs b/crates/artcraftx/src/commands/service/app_preferences/load_custom_sound_command.rs new file mode 100644 index 00000000..a57b7a97 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/load_custom_sound_command.rs @@ -0,0 +1,38 @@ +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::app_preferences::settings::app_sound_preferences::AppSoundEvent; +use log::{error, info, warn}; +use tauri::ipc::Response; +use tauri::State; + +/// The bytes of the custom `.wav` configured for an event, for the frontend +/// to play. The path comes from the saved preference — the frontend never +/// names a file — so this can only read files the user picked in Settings. +/// +/// Errors (returned as a plain message, logged at `warn`) when the event has +/// no custom sound or the file has since gone missing; the frontend treats +/// that as "play nothing". +#[tauri::command] +pub async fn load_custom_sound_command( + event: AppSoundEvent, + app_prefs: State<'_, AppPreferencesManager>, +) -> Result { + info!("load_custom_sound_command called for {:?}", event); + + let prefs = app_prefs.get().map_err(|err| { + error!("Error reading app preferences: {:?}", err); + format!("Error reading app preferences: {:?}", err) + })?; + + let path = prefs + .sounds + .get(event) + .and_then(|sound| sound.custom_wav_path()) + .ok_or_else(|| format!("No custom sound is configured for {:?}", event))?; + + let bytes = std::fs::read(path).map_err(|err| { + warn!("Custom sound for {:?} could not be read from {}: {}", event, path.display(), err); + format!("Custom sound file could not be read: {}", path.display()) + })?; + + Ok(Response::new(bytes)) +} diff --git a/crates/artcraftx/src/commands/service/app_preferences/mod.rs b/crates/artcraftx/src/commands/service/app_preferences/mod.rs new file mode 100644 index 00000000..42359ca6 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/mod.rs @@ -0,0 +1,9 @@ +pub mod get_app_preferences_command; +pub mod load_custom_sound_command; +pub mod update_app_preference_command; +pub mod update_backup_preference_command; +pub mod update_prompt_preference_command; +pub mod update_sound_preference_command; + +// Private +mod notify_app_preferences_changed; diff --git a/crates/artcraftx/src/commands/service/app_preferences/notify_app_preferences_changed.rs b/crates/artcraftx/src/commands/service/app_preferences/notify_app_preferences_changed.rs new file mode 100644 index 00000000..4bf5da21 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/notify_app_preferences_changed.rs @@ -0,0 +1,9 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::app_preferences_changed_event::AppPreferencesChangedEvent; +use tauri::AppHandle; + +/// Tell the frontend the preferences changed so it drops its cached copy. +/// Every command that writes preferences calls this after a successful save. +pub fn notify_app_preferences_changed(app: &AppHandle) { + AppPreferencesChangedEvent {}.send_infallible(app); +} diff --git a/crates/artcraftx/src/commands/service/app_preferences/update_app_preference_command.rs b/crates/artcraftx/src/commands/service/app_preferences/update_app_preference_command.rs new file mode 100644 index 00000000..333b002e --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/update_app_preference_command.rs @@ -0,0 +1,129 @@ +use crate::commands::service::app_preferences::notify_app_preferences_changed::notify_app_preferences_changed; +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::app_preferences::settings::preferred_download_directory::PreferredDownloadDirectory; +use crate::state::app_preferences::settings::preferred_download_filename::PreferredDownloadFilename; +use anyhow::anyhow; +use errors::AnyhowResult; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use tauri::{AppHandle, State}; + +/// One preference change, typed per preference. The frontend sends +/// `{ "preference": "", "value": }`. +/// +/// Per-event sounds have their own command (`update_sound_preference_command`), +/// since custom files need validating. +#[derive(Deserialize, Debug)] +#[serde(tag = "preference", content = "value", rename_all = "snake_case")] +pub enum UpdateAppPreferencesRequest { + PreferredDownloadDirectory(PreferredDownloadDirectory), + PreferredDownloadFilename(PreferredDownloadFilename), + PlaySounds(bool), +} + +#[derive(Serialize)] +pub struct UpdateAppPreferencesResponse { + pub success: bool, +} + +#[tauri::command] +pub async fn update_app_preferences_command( + request: UpdateAppPreferencesRequest, + app: AppHandle, + app_prefs: State<'_, AppPreferencesManager>, +) -> Result { + info!("update_app_preferences_command called: {:?}", request); + + update_prefs(request, &app_prefs).map_err(|err| { + error!("Error updating app preferences: {:?}", err); + format!("Error updating app preferences: {:?}", err) + })?; + + notify_app_preferences_changed(&app); + + Ok(UpdateAppPreferencesResponse { success: true }) +} + +fn update_prefs(request: UpdateAppPreferencesRequest, app_prefs: &AppPreferencesManager) -> AnyhowResult<()> { + validate(&request)?; + app_prefs.update(|prefs| apply(request, prefs))?; + Ok(()) +} + +fn validate(request: &UpdateAppPreferencesRequest) -> AnyhowResult<()> { + match request { + UpdateAppPreferencesRequest::PreferredDownloadFilename(PreferredDownloadFilename::Custom(format)) => { + PreferredDownloadFilename::validate_custom_format(format) + .map_err(|reason| anyhow!("Invalid filename format: {}", reason)) + } + _ => Ok(()), + } +} + +fn apply(request: UpdateAppPreferencesRequest, prefs: &mut AppPreferences) { + use UpdateAppPreferencesRequest::*; + match request { + PreferredDownloadDirectory(directory) => prefs.downloads.preferred_download_directory = directory, + PreferredDownloadFilename(filename) => prefs.downloads.preferred_download_filename = filename, + PlaySounds(enabled) => prefs.sounds.play_sounds = enabled, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn decode(json: &str) -> UpdateAppPreferencesRequest { + serde_json::from_str(json).unwrap() + } + + /// Pin the wire format the frontend sends (`UpdateAppPreference.ts`). + #[test] + fn decodes_each_preference() { + assert!(matches!( + decode(r#"{"preference":"play_sounds","value":true}"#), + UpdateAppPreferencesRequest::PlaySounds(true), + )); + assert!(matches!( + decode(r#"{"preference":"preferred_download_filename","value":"artcraft_convention"}"#), + UpdateAppPreferencesRequest::PreferredDownloadFilename(PreferredDownloadFilename::ArtcraftConvention), + )); + assert!(matches!( + decode(r#"{"preference":"preferred_download_filename","value":{"custom_format":"{model}_{date}"}}"#), + UpdateAppPreferencesRequest::PreferredDownloadFilename(PreferredDownloadFilename::Custom(_)), + )); + assert!(matches!( + decode(r#"{"preference":"preferred_download_directory","value":{"custom":"/tmp"}}"#), + UpdateAppPreferencesRequest::PreferredDownloadDirectory(PreferredDownloadDirectory::Custom(_)), + )); + assert!(matches!( + decode(r#"{"preference":"preferred_download_directory","value":{"system":"downloads"}}"#), + UpdateAppPreferencesRequest::PreferredDownloadDirectory(PreferredDownloadDirectory::System(_)), + )); + } + + #[test] + fn wrong_value_type_is_rejected() { + assert!(serde_json::from_str::(r#"{"preference":"play_sounds","value":"yes"}"#).is_err()); + // Per-event sounds moved to `update_sound_preference_command`. + assert!(serde_json::from_str::(r#"{"preference":"enqueue_success_sound","value":"done"}"#).is_err()); + } + + #[test] + fn custom_filename_format_is_validated() { + let bad = decode(r#"{"preference":"preferred_download_filename","value":{"custom_format":"a/b"}}"#); + assert!(validate(&bad).is_err()); + let good = decode(r#"{"preference":"preferred_download_filename","value":{"custom_format":"{model}_{date}"}}"#); + assert!(validate(&good).is_ok()); + } + + #[test] + fn apply_writes_into_the_right_group() { + let mut prefs = AppPreferences::default(); + apply(decode(r#"{"preference":"play_sounds","value":false}"#), &mut prefs); + apply(decode(r#"{"preference":"preferred_download_directory","value":{"custom":"/tmp/out"}}"#), &mut prefs); + assert!(!prefs.sounds.play_sounds); + assert_eq!(prefs.downloads.preferred_download_directory, PreferredDownloadDirectory::Custom("/tmp/out".into())); + } +} diff --git a/crates/artcraftx/src/commands/service/app_preferences/update_backup_preference_command.rs b/crates/artcraftx/src/commands/service/app_preferences/update_backup_preference_command.rs new file mode 100644 index 00000000..9f088d17 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/update_backup_preference_command.rs @@ -0,0 +1,94 @@ +use crate::commands::service::app_preferences::notify_app_preferences_changed::notify_app_preferences_changed; +use crate::services::backup::backup_target::is_backup_eligible; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::app_preferences::settings::app_backup_preferences::AppBackupPreferences; +use crate::state::data_dir::app_data_root::AppDataRoot; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use tauri::{AppHandle, State}; + +/// One backup preference change. The frontend sends +/// `{ "preference": "", "value": }`. +#[derive(Deserialize, Debug)] +#[serde(tag = "preference", content = "value", rename_all = "snake_case")] +pub enum UpdateBackupPreferenceRequest { + /// Switch backups on or off. The selected account is kept either way. + Enabled(bool), + /// Pick the ArtCraft account to back up to (`null` clears it). Must name + /// an existing ArtCraft web-session credential. + ArtcraftCredentialId(Option), +} + +/// The full backup preferences after the change. +#[derive(Serialize)] +pub struct UpdateBackupPreferenceResponse { + pub backup: AppBackupPreferences, +} + +#[tauri::command] +pub async fn update_backup_preference_command( + request: UpdateBackupPreferenceRequest, + app: AppHandle, + app_data_root: State<'_, AppDataRoot>, + app_prefs: State<'_, AppPreferencesManager>, +) -> Result { + info!("update_backup_preference_command called: {:?}", request); + + if let UpdateBackupPreferenceRequest::ArtcraftCredentialId(Some(credential_id)) = &request { + validate_backup_credential(&app_data_root, credential_id)?; + } + + let prefs = app_prefs + .update(|prefs| match request { + UpdateBackupPreferenceRequest::Enabled(enabled) => prefs.backup.enabled = enabled, + UpdateBackupPreferenceRequest::ArtcraftCredentialId(maybe_id) => { + prefs.backup.maybe_artcraft_credential_id = maybe_id.filter(|id| !id.trim().is_empty()); + } + }) + .map_err(|err| { + error!("Error updating backup preference: {:?}", err); + format!("Error updating backup preference: {:?}", err) + })?; + + notify_app_preferences_changed(&app); + + Ok(UpdateBackupPreferenceResponse { backup: prefs.backup }) +} + +fn validate_backup_credential(app_data_root: &AppDataRoot, credential_id: &str) -> Result<(), String> { + let credential = app_data_root + .credentials_dir() + .find_credential_by_id(credential_id) + .map_err(|err| format!("Error looking up credential {}: {}", credential_id, err))? + .ok_or_else(|| format!("No credential found for id {}", credential_id))?; + if !is_backup_eligible(&credential) { + return Err(format!( + "Credential {} ({}) can't receive backups; pick an ArtCraft account", + credential_id, credential.service, + )); + } + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + + /// Pin the wire format the frontend sends (`UpdateBackupPreference.ts`). + #[test] + fn decodes_requests() { + assert!(matches!( + serde_json::from_str::(r#"{"preference":"enabled","value":true}"#).unwrap(), + UpdateBackupPreferenceRequest::Enabled(true), + )); + assert!(matches!( + serde_json::from_str::(r#"{"preference":"artcraft_credential_id","value":"credential_abc"}"#).unwrap(), + UpdateBackupPreferenceRequest::ArtcraftCredentialId(Some(id)) if id == "credential_abc", + )); + assert!(matches!( + serde_json::from_str::(r#"{"preference":"artcraft_credential_id","value":null}"#).unwrap(), + UpdateBackupPreferenceRequest::ArtcraftCredentialId(None), + )); + assert!(serde_json::from_str::(r#"{"preference":"enabled","value":"yes"}"#).is_err()); + } +} diff --git a/crates/artcraftx/src/commands/service/app_preferences/update_prompt_preference_command.rs b/crates/artcraftx/src/commands/service/app_preferences/update_prompt_preference_command.rs new file mode 100644 index 00000000..a91bacf1 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/update_prompt_preference_command.rs @@ -0,0 +1,58 @@ +use crate::commands::service::app_preferences::notify_app_preferences_changed::notify_app_preferences_changed; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::app_preferences::settings::app_prompt_preferences::AppPromptPreferences; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use tauri::{AppHandle, State}; + +/// One prompt-box preference change. The frontend sends +/// `{ "preference": "", "value": }`. +#[derive(Deserialize, Debug)] +#[serde(tag = "preference", content = "value", rename_all = "snake_case")] +pub enum UpdatePromptPreferenceRequest { + EnterToGenerate(bool), +} + +/// The full prompt preferences after the change. +#[derive(Serialize)] +pub struct UpdatePromptPreferenceResponse { + pub prompt: AppPromptPreferences, +} + +#[tauri::command] +pub async fn update_prompt_preference_command( + request: UpdatePromptPreferenceRequest, + app: AppHandle, + app_prefs: State<'_, AppPreferencesManager>, +) -> Result { + info!("update_prompt_preference_command called: {:?}", request); + + let prefs = app_prefs + .update(|prefs| match request { + UpdatePromptPreferenceRequest::EnterToGenerate(enabled) => prefs.prompt.enter_to_generate = enabled, + }) + .map_err(|err| { + error!("Error updating prompt preference: {:?}", err); + format!("Error updating prompt preference: {:?}", err) + })?; + + notify_app_preferences_changed(&app); + + Ok(UpdatePromptPreferenceResponse { prompt: prefs.prompt }) +} + +#[cfg(test)] +mod tests { + use super::*; + + /// Pin the wire format the frontend sends (`UpdatePromptPreference.ts`). + #[test] + fn decodes_enter_to_generate() { + assert!(matches!( + serde_json::from_str::(r#"{"preference":"enter_to_generate","value":false}"#).unwrap(), + UpdatePromptPreferenceRequest::EnterToGenerate(false), + )); + assert!(serde_json::from_str::(r#"{"preference":"enter_to_generate","value":"yes"}"#).is_err()); + assert!(serde_json::from_str::(r#"{"preference":"tab_to_generate","value":true}"#).is_err()); + } +} diff --git a/crates/artcraftx/src/commands/service/app_preferences/update_sound_preference_command.rs b/crates/artcraftx/src/commands/service/app_preferences/update_sound_preference_command.rs new file mode 100644 index 00000000..799816ea --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_preferences/update_sound_preference_command.rs @@ -0,0 +1,128 @@ +use crate::commands::service::app_preferences::notify_app_preferences_changed::notify_app_preferences_changed; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::app_preferences::settings::app_sound_file::{optional_sound, AppSoundFile}; +use crate::state::app_preferences::settings::app_sound_preferences::{AppSoundEvent, AppSoundPreferences}; +use log::{error, info, warn}; +use serde_derive::{Deserialize, Serialize}; +use tauri::{AppHandle, State}; + +/// Change the sound for one event. +/// +/// - `set`: `sound` is a catalog key (e.g. `"done"`), `{ "custom_wav": +/// "/abs/path.wav" }`, or `"none"` / `null` / absent for silent. A custom +/// file is checked to exist (and be a `.wav`) before it's accepted. +/// - `reset_to_default`: back to the out-of-the-box sound for the event +/// (whatever `AppSoundPreferences::default()` says). +#[derive(Deserialize, Debug)] +#[serde(tag = "action", rename_all = "snake_case")] +pub enum UpdateSoundPreferenceRequest { + Set { + event: AppSoundEvent, + #[serde(default, with = "optional_sound")] + sound: Option, + }, + ResetToDefault { + event: AppSoundEvent, + }, +} + +/// The full sound preferences after the change, so the UI can re-render +/// without a second round trip. +#[derive(Serialize)] +pub struct UpdateSoundPreferenceResponse { + pub sounds: AppSoundPreferences, +} + +#[tauri::command] +pub async fn update_sound_preference_command( + request: UpdateSoundPreferenceRequest, + app: AppHandle, + app_prefs: State<'_, AppPreferencesManager>, +) -> Result { + info!("update_sound_preference_command called: {:?}", request); + + if let UpdateSoundPreferenceRequest::Set { event, sound: Some(sound) } = &request { + sound.validate().map_err(|reason| { + warn!("Rejected sound for {:?}: {}", event, reason); + reason + })?; + } + + let prefs = app_prefs + .update(|prefs| match request { + UpdateSoundPreferenceRequest::Set { event, sound } => prefs.sounds.set(event, sound), + UpdateSoundPreferenceRequest::ResetToDefault { event } => prefs.sounds.reset_to_default(event), + }) + .map_err(|err| { + error!("Error updating sound preference: {:?}", err); + format!("Error updating sound preference: {:?}", err) + })?; + + notify_app_preferences_changed(&app); + + Ok(UpdateSoundPreferenceResponse { sounds: prefs.sounds }) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn decode(json: &str) -> UpdateSoundPreferenceRequest { + serde_json::from_str(json).unwrap() + } + + fn set_sound(request: UpdateSoundPreferenceRequest) -> (AppSoundEvent, Option) { + match request { + UpdateSoundPreferenceRequest::Set { event, sound } => (event, sound), + other => panic!("expected a set action, got {other:?}"), + } + } + + /// Pin the wire format the frontend sends (`UpdateSoundPreference.ts`). + #[test] + fn decodes_catalog_custom_and_silent() { + let (event, sound) = set_sound(decode(r#"{"action":"set","event":"enqueue_success","sound":"done"}"#)); + assert_eq!(event, AppSoundEvent::EnqueueSuccess); + assert_eq!(sound, Some(AppSoundFile::Done)); + + let (event, sound) = set_sound(decode(r#"{"action":"set","event":"generation_failure","sound":{"custom_wav":"/tmp/x.wav"}}"#)); + assert_eq!(event, AppSoundEvent::GenerationFailure); + assert_eq!(sound, Some(AppSoundFile::CustomWav("/tmp/x.wav".into()))); + + assert_eq!(set_sound(decode(r#"{"action":"set","event":"delete_file","sound":"none"}"#)).1, None); + assert_eq!(set_sound(decode(r#"{"action":"set","event":"delete_file","sound":null}"#)).1, None); + assert_eq!(set_sound(decode(r#"{"action":"set","event":"delete_file"}"#)).1, None); + } + + #[test] + fn decodes_reset() { + assert!(matches!( + decode(r#"{"action":"reset_to_default","event":"generation_success"}"#), + UpdateSoundPreferenceRequest::ResetToDefault { event: AppSoundEvent::GenerationSuccess }, + )); + } + + #[test] + fn rejects_unknown_action_event_or_sound() { + assert!(serde_json::from_str::(r#"{"event":"delete_file","sound":"done"}"#).is_err()); + assert!(serde_json::from_str::(r#"{"action":"set","event":"launch","sound":"done"}"#).is_err()); + assert!(serde_json::from_str::(r#"{"action":"set","event":"delete_file","sound":"bogus"}"#).is_err()); + } + + /// Resetting reads the default from the `Default` impl, so changing a + /// default there is the only place it needs changing. + #[test] + fn reset_restores_the_default_impl_value() { + let mut sounds = AppSoundPreferences::default(); + sounds.set(AppSoundEvent::EnqueueFailure, Some(AppSoundFile::CustomWav("/tmp/x.wav".into()))); + sounds.set(AppSoundEvent::DeleteFile, None); + + sounds.reset_to_default(AppSoundEvent::EnqueueFailure); + sounds.reset_to_default(AppSoundEvent::DeleteFile); + + let defaults = AppSoundPreferences::default(); + assert_eq!(sounds.enqueue_failure, defaults.enqueue_failure); + assert_eq!(sounds.delete_file, defaults.delete_file); + assert_eq!(sounds, defaults); + } +} diff --git a/crates/artcraftx/src/commands/service/app_state/mod.rs b/crates/artcraftx/src/commands/service/app_state/mod.rs new file mode 100644 index 00000000..33df1ad7 --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_state/mod.rs @@ -0,0 +1 @@ +mod reset_artcraft_command; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/service/app_state/reset_artcraft_command.rs b/crates/artcraftx/src/commands/service/app_state/reset_artcraft_command.rs new file mode 100644 index 00000000..d19f64bd --- /dev/null +++ b/crates/artcraftx/src/commands/service/app_state/reset_artcraft_command.rs @@ -0,0 +1,26 @@ +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use log::info; +use serde_derive::Serialize; +use tauri::AppHandle; + +#[derive(Serialize)] +pub struct ResetArtcraftCommandResponse { + pub success: bool, +} + +impl SerializeMarker for ResetArtcraftCommandResponse {} + +#[tauri::command] +pub async fn reset_artcraft_command( + _app: AppHandle, +) -> ResponseOrErrorMessage { + info!("reset_artcraft_command called"); + + // TODO: Reset local vs. production + + Ok(ResetArtcraftCommandResponse { + success: true, + }.into()) +} + diff --git a/crates/artcraftx/src/commands/service/get_app_info_command.rs b/crates/artcraftx/src/commands/service/get_app_info_command.rs new file mode 100644 index 00000000..1761a099 --- /dev/null +++ b/crates/artcraftx/src/commands/service/get_app_info_command.rs @@ -0,0 +1,88 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::commands::utils::response::shorthand::InfallibleResponse; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::runtime::artcraft_platform_info::{ArtcraftOs, ArtcraftPlatformInfo}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use chrono::{DateTime, Utc}; +use log::{info, warn}; +use serde_derive::Serialize; +use std::path::PathBuf; +use tauri::State; + +#[derive(Debug, Serialize)] +pub struct AppInfoResponse { + pub artcraft_version: String, + + pub build_timestamp: DateTime, + + pub git_commit_id: Option, + pub git_commit_short_id: Option, + pub git_commit_timestamp: Option>, + + pub os_platform: DetectedOs, + pub os_version: String, + + pub storyteller_host: String, + + pub artcraft_root_directory: PathBuf, + pub download_directory: PathBuf, +} + +impl SerializeMarker for AppInfoResponse {} + +#[derive(Copy, Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum DetectedOs { + Windows, + #[serde(rename = "macos")] + MacOS, + Linux, + Unknown, +} + +#[tauri::command] +pub fn get_app_info_command( + app_data_root: State<'_, AppDataRoot>, + artcraft_platform_info: State<'_, ArtcraftPlatformInfo>, + app_prefs: State<'_, AppPreferencesManager>, +) -> InfallibleResponse { + info!("get_app_info_command called..."); + + let storyteller_host = ApiHost::Storyteller.to_api_hostname_and_scheme(); + + let os_platform = match artcraft_platform_info.os_platform { + ArtcraftOs::Linux => DetectedOs::Linux, + ArtcraftOs::MacOS => DetectedOs::MacOS, + ArtcraftOs::Windows => DetectedOs::Windows, + ArtcraftOs::Unknown => DetectedOs::Unknown, + }; + + let root_directory = app_data_root.path().to_path_buf(); + + let download_directory = match app_prefs.get() { + Ok(app_prefs) => { + app_prefs.downloads.preferred_download_directory + .download_directory(&app_data_root) + } + Err(err) => { + warn!("Can't get user download directory: {:?}", err); + app_data_root.downloads_dir().path().to_path_buf() + } + }; + + AppInfoResponse { + artcraft_version: artcraft_platform_info.artcraft_version.clone(), + build_timestamp: artcraft_platform_info.build_timestamp, + git_commit_id: artcraft_platform_info.git_commit_id.clone(), + git_commit_short_id: artcraft_platform_info.git_commit_short_id.clone(), + git_commit_timestamp: artcraft_platform_info.git_commit_timestamp, + os_platform, + os_version: artcraft_platform_info.os_version.clone(), + storyteller_host, + artcraft_root_directory: root_directory, + download_directory, + }.into() +} + diff --git a/crates/artcraftx/src/commands/service/load_without_cors_command.rs b/crates/artcraftx/src/commands/service/load_without_cors_command.rs new file mode 100644 index 00000000..482dce15 --- /dev/null +++ b/crates/artcraftx/src/commands/service/load_without_cors_command.rs @@ -0,0 +1,43 @@ +use futures::TryFutureExt; +use log::{error, info}; +use reqwest::Client; +use tauri::ipc::Response; + +/// Request a URL and load it without worrying about CORS. +#[tauri::command] +pub async fn load_without_cors_command(url: String) -> Result { + + info!("load_without_cors_command for URL: {}", url); + + // TODO(bt,2025-07-22): Make sure the URL is valid and safe to fetch. Check an allowlist. + + // TODO(bt,2025-07-22): Should we cache clients so we don't need to SSL handshake every time? + let client = Client::builder() + .gzip(true) + .build() + .map_err(|e| { + error!("Failed to create HTTP client: {:?}", e); + format!("Failed to create HTTP client: {:?}", e) + })?; + + let response = client.get(url.clone()) + .send() + .await + .map_err(|e| { + error!("Failed to send HTTP request: {:?}", e); + format!("Failed to send HTTP request: {:?}", e) + })?; + + if response.status() != 200 { + return Err(format!("Failed to fetch URL: {}. Status: {}", url, response.status())); + } + + let bytes = response.bytes() + .await + .map_err(|e| { + error!("Failed to read response bytes: {:?}", e); + format!("Failed to read response bytes: {:?}", e) + })?; + + Ok(Response::new(bytes.to_vec())) +} diff --git a/crates/artcraftx/src/commands/service/mod.rs b/crates/artcraftx/src/commands/service/mod.rs new file mode 100644 index 00000000..18192391 --- /dev/null +++ b/crates/artcraftx/src/commands/service/mod.rs @@ -0,0 +1,6 @@ +pub mod app_preferences; +pub mod promptbox; +pub mod app_state; +pub mod get_app_info_command; +pub mod load_without_cors_command; +pub mod platform_info_command; diff --git a/crates/artcraftx/src/commands/service/platform_info_command.rs b/crates/artcraftx/src/commands/service/platform_info_command.rs new file mode 100644 index 00000000..69657088 --- /dev/null +++ b/crates/artcraftx/src/commands/service/platform_info_command.rs @@ -0,0 +1,61 @@ +use crate::commands::utils::response::shorthand::InfallibleResponse; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::state::runtime::os_platform::OsPlatform; +use log::info; +use serde_derive::Serialize; + +#[derive(Debug, Serialize)] +pub struct PlatformInfoResponse { + pub os_platform: DetectedOs, + pub webview_runtime: WebviewRuntime, +} + +impl SerializeMarker for PlatformInfoResponse {} + +#[derive(Copy, Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum DetectedOs { + Windows, + #[serde(rename = "macos")] + MacOS, + Linux, + Unknown, +} + +#[derive(Copy, Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum WebviewRuntime { + #[serde(rename = "webkit_safari")] + WebkitSafari, + #[serde(rename = "webkit_gtk")] + WebkitGtk, + #[serde(rename = "edge_webview_2")] + EdgeWebview2, + Unknown, +} + +#[tauri::command] +pub fn platform_info_command() -> InfallibleResponse { + info!("platform_info_command called..."); + + let os_platform = match OsPlatform::maybe_get() { + Some(OsPlatform::Linux) => DetectedOs::Linux, + Some(OsPlatform::MacOs) => DetectedOs::MacOS, + Some(OsPlatform::Windows) => DetectedOs::Windows, + None => DetectedOs::Unknown, + }; + + // These are the webviews that Tauri uses on each OS: + // https://tauri.app/reference/webview-versions/ + let webview_runtime = match os_platform { + DetectedOs::Windows => WebviewRuntime::EdgeWebview2, + DetectedOs::MacOS => WebviewRuntime::WebkitSafari, + DetectedOs::Linux => WebviewRuntime::WebkitGtk, + DetectedOs::Unknown => WebviewRuntime::Unknown, + }; + + PlatformInfoResponse { + os_platform, + webview_runtime, + }.into() +} diff --git a/crates/artcraftx/src/commands/service/promptbox/get_promptbox_state_command.rs b/crates/artcraftx/src/commands/service/promptbox/get_promptbox_state_command.rs new file mode 100644 index 00000000..b6b252b6 --- /dev/null +++ b/crates/artcraftx/src/commands/service/promptbox/get_promptbox_state_command.rs @@ -0,0 +1,26 @@ +use crate::state::promptbox::promptbox_state::PromptboxState; +use crate::state::promptbox::promptbox_state_manager::PromptboxStateManager; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +/// What every prompt box last had selected. The frontend hydrates its stores +/// from this on boot, dropping anything that no longer exists. +#[derive(Serialize)] +pub struct GetPromptboxStateResponse { + pub state: PromptboxState, +} + +#[tauri::command] +pub async fn get_promptbox_state_command( + promptbox_state: State<'_, PromptboxStateManager>, +) -> Result { + info!("get_promptbox_state_command called"); + + let state = promptbox_state.get().map_err(|err| { + error!("Error reading prompt box state: {:?}", err); + format!("Error reading prompt box state: {:?}", err) + })?; + + Ok(GetPromptboxStateResponse { state }) +} diff --git a/crates/artcraftx/src/commands/service/promptbox/mod.rs b/crates/artcraftx/src/commands/service/promptbox/mod.rs new file mode 100644 index 00000000..83663fd2 --- /dev/null +++ b/crates/artcraftx/src/commands/service/promptbox/mod.rs @@ -0,0 +1,2 @@ +pub mod get_promptbox_state_command; +pub mod update_promptbox_state_command; diff --git a/crates/artcraftx/src/commands/service/promptbox/update_promptbox_state_command.rs b/crates/artcraftx/src/commands/service/promptbox/update_promptbox_state_command.rs new file mode 100644 index 00000000..0e8fc520 --- /dev/null +++ b/crates/artcraftx/src/commands/service/promptbox/update_promptbox_state_command.rs @@ -0,0 +1,58 @@ +use crate::state::promptbox::promptbox_state::PromptboxState; +use crate::state::promptbox::promptbox_state_manager::PromptboxStateManager; +use log::{error, info}; +use serde_derive::Serialize; +use tauri::State; + +#[derive(Serialize)] +pub struct UpdatePromptboxStateResponse { + pub state: PromptboxState, +} + +/// Replaces the whole prompt box state. The frontend is the only writer and +/// always knows the full state, so it sends a complete snapshot (debounced) +/// rather than patches. Missing fields default; `version` is owned by the +/// backend and ignored. +#[tauri::command] +pub async fn update_promptbox_state_command( + state: PromptboxState, + promptbox_state: State<'_, PromptboxStateManager>, +) -> Result { + info!("update_promptbox_state_command called: {:?}", state); + + let state = promptbox_state + .update(|current| *current = replace_keeping_version(current, state)) + .map_err(|err| { + error!("Error updating prompt box state: {:?}", err); + format!("Error updating prompt box state: {:?}", err) + })?; + + Ok(UpdatePromptboxStateResponse { state }) +} + +fn replace_keeping_version(current: &PromptboxState, incoming: PromptboxState) -> PromptboxState { + PromptboxState { version: current.version, ..incoming } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn incoming_state_replaces_everything_but_version() { + let mut current = PromptboxState::default(); + current.image.selected_model = Some("old_model".to_string()); + current.last_account_by_model.insert("old_model".to_string(), "credential_a".to_string()); + + let incoming: PromptboxState = serde_json::from_str( + r#"{ "version": 999, "video": { "selected_model": "seedance_2p0", "options": { "duration": 5 } } }"#, + ).unwrap(); + + let replaced = replace_keeping_version(¤t, incoming); + assert_eq!(replaced.version, current.version, "backend owns the version"); + assert_eq!(replaced.video.selected_model.as_deref(), Some("seedance_2p0")); + assert_eq!(replaced.video.options["duration"], 5); + assert_eq!(replaced.image, Default::default(), "omitted modalities reset, not merged"); + assert!(replaced.last_account_by_model.is_empty(), "omitted map resets, not merged"); + } +} diff --git a/crates/artcraftx/src/commands/task_queue/get_task_queue_command.rs b/crates/artcraftx/src/commands/task_queue/get_task_queue_command.rs new file mode 100644 index 00000000..9a67a6b3 --- /dev/null +++ b/crates/artcraftx/src/commands/task_queue/get_task_queue_command.rs @@ -0,0 +1,230 @@ +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::services::local_files::thumbnail_service::generated_thumbnail_paths; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::state::database::task_database::TaskDatabase; +use local_files_database::queries::get_local_files_by_paths::get_local_files_by_paths; +use chrono::{DateTime, Utc}; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use errors::AnyhowResult; +use log::{debug, error, warn}; +use serde_derive::Serialize; +use sqlite_database::queries::read::list_tasks_for_frontend::list_tasks_for_frontend; +use tauri::{AppHandle, State}; +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::task_id::TaskId; + +#[derive(Serialize)] +pub struct GetTaskQueueCommandResponse { + tasks: Vec, +} + +#[derive(Serialize)] +pub struct TaskQueueItem { + pub id: TaskId, + + pub task_status: TaskStatus, + pub task_type: TaskType, + pub model_type: Option, + + pub provider: Option, + pub provider_job_id: Option, + + /// Whether the job produces more than one file. + pub is_batch_generation: bool, + + /// If the item is done, these will be filled out. + pub completed_item: Option, + + /// If the item failed, this will be filled out. + pub failure_reason: Option, + + pub created_at: DateTime, + pub updated_at: DateTime, + pub completed_at: Option>, +} + +#[derive(Serialize)] +pub struct CompletedItemData { + /// Present only when the result was uploaded to ArtCraft (requires a + /// logged-in session). Local-only completions have download locations but + /// no cloud media file. + pub primary_media_file: Option, + + /// The type of file(s) generated. + pub media_file_class: Option, + + /// If generated in a batch, we probably have a batch token we can query. + pub maybe_batch_token: Option, + + /// If the results were downloaded: the directory they were saved into and + /// the first (or only) file. Absolute paths recorded at completion time. + pub maybe_download_directory: Option, + pub maybe_first_downloaded_file: Option, + + /// Thumbnails of the first downloaded file, once the thumbnail worker has + /// produced them (absolute cache paths; render via the asset protocol). + /// Until then the frontend hears about them via + /// `local_thumbnail_ready_event`. + pub maybe_local_thumbnail_path: Option, + pub maybe_local_animated_preview_path: Option, +} + +#[derive(Serialize)] +pub struct MediaFileData { + pub token: MediaFileToken, + pub cdn_url: String, + pub maybe_thumbnail_url_template: Option, + + // NB: The frontend wants this. + pub created_at: DateTime, +} + +#[derive(Serialize)] +pub struct FailedItemData { + pub failure_type: TaskFailureType, + pub failure_message: Option, +} + +impl SerializeMarker for GetTaskQueueCommandResponse {} + +#[tauri::command] +pub async fn get_task_queue_command( + _app: AppHandle, + task_database: State<'_, TaskDatabase>, + local_files_database: State<'_, LocalFilesDatabase>, +) -> ResponseOrErrorMessage { + + // NB: This is debug because it spams the logs. + debug!("get_task_queue_command called"); + + let result = handle_request( + &task_database, + &local_files_database, + ).await; + + let tasks = match result { + Ok(items) => items, + Err(err) => { + error!("get_task_queue_command failed: {:?}", err); + return Err("get_task_queue_command failed".into()) + } + }; + + Ok(GetTaskQueueCommandResponse{ + tasks, + }.into()) +} + +pub async fn handle_request( + task_database: &TaskDatabase, + local_files_database: &LocalFilesDatabase, +) -> AnyhowResult> { + + let tasks = list_tasks_for_frontend(task_database.get_connection()) + .await?; + + let mut transformed_tasks = Vec::with_capacity(tasks.tasks.len()); + + for task in tasks.tasks.into_iter() { + let mut completed_item = None; + let mut failure_reason = None; + + if task.status == TaskStatus::CompleteSuccess { + // The cloud media file only exists when the result was uploaded to + // ArtCraft; a local-only completion still gets a completed item so + // the frontend can render (and thumbnail) the downloaded files. + let primary_media_file = task.on_complete_primary_media_file_token + .zip(task.on_complete_primary_media_file_cdn_url) + .map(|(primary_media_file_token, media_file_url)| MediaFileData { + token: primary_media_file_token, + cdn_url: media_file_url, + maybe_thumbnail_url_template: task.on_complete_primary_media_file_thumbnail_url_template.clone(), + // NB: This isn't the exact completion date. Also, fallback to now if missing. + created_at: task.completed_at.unwrap_or_else(Utc::now), + }); + + if primary_media_file.is_none() && task.on_complete_first_file_location.is_none() { + warn!("Task {} is marked complete but has neither a cloud media file nor a local download.", task.id); + } + + completed_item = Some(CompletedItemData { + primary_media_file, + media_file_class: task.on_complete_primary_media_file_class, + maybe_batch_token: task.on_complete_batch_token, + maybe_download_directory: task.on_complete_directory_location.clone(), + maybe_first_downloaded_file: task.on_complete_first_file_location.clone(), + maybe_local_thumbnail_path: None, + maybe_local_animated_preview_path: None, + }); + } else { + // If either failure field is present, fill out the failure report. + if let Some(failure_message) = task.on_failure_message.as_deref() { + failure_reason = Some(FailedItemData { + failure_type: task.on_failure_type.unwrap_or(TaskFailureType::Unknown), + failure_message: Some(failure_message.to_string()), + }); + } else if let Some(failure_type) = task.on_failure_type { + failure_reason = Some(FailedItemData { + failure_type, + failure_message: None, + }); + } + } + + transformed_tasks.push(TaskQueueItem { + id: task.id, + task_status: task.status, + task_type: task.task_type, + model_type: task.model_type, + provider: task.provider, + provider_job_id: task.provider_job_id, + is_batch_generation: task.is_batch_generation, + created_at: task.created_at, + updated_at: task.updated_at, + completed_at: task.completed_at, + completed_item, + failure_reason, + }) + } + + attach_local_thumbnails(local_files_database, &mut transformed_tasks).await; + + Ok(transformed_tasks) +} + +/// Fill in the worker-generated thumbnails for every downloaded result, in +/// one batch lookup. Fails open: a lookup error just leaves them unset. +async fn attach_local_thumbnails(local_files_database: &LocalFilesDatabase, tasks: &mut [TaskQueueItem]) { + let file_paths: Vec = tasks.iter() + .filter_map(|task| task.completed_item.as_ref()) + .filter_map(|item| item.maybe_first_downloaded_file.clone()) + .collect(); + if file_paths.is_empty() { + return; + } + + let records = match get_local_files_by_paths(local_files_database.get_connection(), &file_paths).await { + Ok(records) => records, + Err(err) => { + warn!("Could not look up local thumbnails for the task queue: {}", err); + return; + } + }; + + for item in tasks.iter_mut().filter_map(|task| task.completed_item.as_mut()) { + let Some(record) = item.maybe_first_downloaded_file.as_ref().and_then(|path| records.get(path)) else { + continue; + }; + if let Some((thumbnail_path, maybe_animated_preview_path)) = generated_thumbnail_paths(record) { + item.maybe_local_thumbnail_path = Some(thumbnail_path); + item.maybe_local_animated_preview_path = maybe_animated_preview_path; + } + } +} diff --git a/crates/artcraftx/src/commands/task_queue/mark_task_as_dismissed_command.rs b/crates/artcraftx/src/commands/task_queue/mark_task_as_dismissed_command.rs new file mode 100644 index 00000000..a4eaebbf --- /dev/null +++ b/crates/artcraftx/src/commands/task_queue/mark_task_as_dismissed_command.rs @@ -0,0 +1,53 @@ +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::state::database::task_database::TaskDatabase; +use errors::AnyhowResult; +use log::{error, info}; +use serde_derive::{Deserialize, Serialize}; +use sqlite_database::queries::update::mark_task_as_dismissed::mark_task_as_dismissed; +use tauri::{AppHandle, State}; +use sqlite_identifiers::ids::task_id::TaskId; + +#[derive(Deserialize)] +pub struct MarkTaskAsDismissedRequest { + task: TaskId, +} + +#[derive(Serialize)] +pub struct MarkTaskAsDismissedResponse { + success: bool, +} + +impl SerializeMarker for MarkTaskAsDismissedResponse {} + +#[tauri::command] +pub async fn mark_task_as_dismissed_command( + request: MarkTaskAsDismissedRequest, + _app: AppHandle, + task_database: State<'_, TaskDatabase>, +) -> ResponseOrErrorMessage { + + info!("mark_task_as_dismissed_command called"); + + let result = handle_request( + &request.task, + &task_database, + ).await; + + if let Err(err) = &result { + error!("mark_task_as_dismissed_command failed: {:?}", err); + return Err("mark_task_as_dismissed_command failed".into()) + } + + Ok(MarkTaskAsDismissedResponse{ + success: true, + }.into()) +} + +pub async fn handle_request( + task_id: &TaskId, + task_database: &TaskDatabase, +) -> AnyhowResult<()> { + let _result = mark_task_as_dismissed(task_database.get_connection(), task_id).await?; + Ok(()) +} diff --git a/crates/artcraftx/src/commands/task_queue/mod.rs b/crates/artcraftx/src/commands/task_queue/mod.rs new file mode 100644 index 00000000..2bcdeb65 --- /dev/null +++ b/crates/artcraftx/src/commands/task_queue/mod.rs @@ -0,0 +1,3 @@ +pub mod get_task_queue_command; +pub mod mark_task_as_dismissed_command; +pub mod tasks_nuke_all_command; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/task_queue/tasks_nuke_all_command.rs b/crates/artcraftx/src/commands/task_queue/tasks_nuke_all_command.rs new file mode 100644 index 00000000..44bd18af --- /dev/null +++ b/crates/artcraftx/src/commands/task_queue/tasks_nuke_all_command.rs @@ -0,0 +1,45 @@ +use crate::commands::utils::response::shorthand::ResponseOrErrorMessage; +use crate::commands::utils::response::success_response_wrapper::SerializeMarker; +use crate::state::database::task_database::TaskDatabase; +use errors::AnyhowResult; +use log::{error, info}; +use serde_derive::Serialize; +use sqlite_database::queries::update::dismiss_all_tasks::dismiss_all_tasks; +use sqlite_database::queries::update::nuke_all_tasks::nuke_all_tasks; +use tauri::State; + +#[derive(Serialize)] +pub struct TasksNukeAllResponse { + success: bool, +} + +impl SerializeMarker for TasksNukeAllResponse {} + +#[tauri::command] +pub async fn tasks_nuke_all_command( + task_database: State<'_, TaskDatabase>, +) -> ResponseOrErrorMessage { + + info!("tasks_nuke_all_command called"); + + let result = handle_request( + &task_database, + ).await; + + if let Err(err) = &result { + error!("tasks_nuke_all_command failed: {:?}", err); + return Err("tasks_nuke_all_command failed".into()) + } + + Ok(TasksNukeAllResponse{ + success: true, + }.into()) +} + +pub async fn handle_request( + task_database: &TaskDatabase, +) -> AnyhowResult<()> { + let _result = nuke_all_tasks(task_database.get_connection()).await?; + let _result = dismiss_all_tasks(task_database.get_connection()).await?; + Ok(()) +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/common_aspect_ratio.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/common_aspect_ratio.rs new file mode 100644 index 00000000..c16d63e1 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/common_aspect_ratio.rs @@ -0,0 +1,42 @@ +use serde_derive::{Deserialize, Serialize}; + +/// This is a comprehensive list of common aspect ratios you can specify when enqueuing a generation. +/// Not every model will support every aspect ratio. +/// In the case a model doesn't support the aspect ratio, gracefully pick the nearest option. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonAspectRatio { + // Auto (eg. for image editing to use the source; used by Nano Banana Pro edit image, but not text-to-image) + Auto, + + // Square + Square, + + // Wide + WideThreeByTwo, + WideFourByThree, + WideFiveByFour, + WideSixteenByNine, + WideTwentyOneByNine, + + // Tall + TallTwoByThree, + TallThreeByFour, + TallFourByFive, + TallNineBySixteen, + TallNineByTwentyOne, + + // Imprecise semantic values that we probably remap to other meanings + // on a model-by-model basis. + Wide, + Tall, + + // Auto values that bake in resolution + // These are from the Seedream models + Auto2k, + Auto4k, + + // Defined aspect ratios that bake in resolution + // These are from the Seedream models + SquareHd, +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_1_dev.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_1_dev.rs new file mode 100644 index 00000000..34734a90 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_1_dev.rs @@ -0,0 +1,31 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::text::generate_flux_1_dev_text_to_image::GenerateFlux1DevTextToImageAspectRatio; + +pub fn aspect_ratio_to_artcraft_flux_1_dev(aspect_ratio: CommonAspectRatio) -> GenerateFlux1DevTextToImageAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => GenerateFlux1DevTextToImageAspectRatio::Square, + CommonAspectRatio::SquareHd => GenerateFlux1DevTextToImageAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree => GenerateFlux1DevTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideSixteenByNine => GenerateFlux1DevTextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::TallThreeByFour => GenerateFlux1DevTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::TallNineBySixteen => GenerateFlux1DevTextToImageAspectRatio::PortraitNineBySixteen, + + // Non-matching aspect ratios, use closest neighbor + CommonAspectRatio::TallFourByFive => GenerateFlux1DevTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::TallNineByTwentyOne => GenerateFlux1DevTextToImageAspectRatio::PortraitNineBySixteen, + CommonAspectRatio::TallTwoByThree => GenerateFlux1DevTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::WideFiveByFour => GenerateFlux1DevTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::WideThreeByTwo => GenerateFlux1DevTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideTwentyOneByNine => GenerateFlux1DevTextToImageAspectRatio::LandscapeSixteenByNine, + + // Special + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => GenerateFlux1DevTextToImageAspectRatio::Square, + + // Semantic values + CommonAspectRatio::Wide => GenerateFlux1DevTextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::Tall => GenerateFlux1DevTextToImageAspectRatio::PortraitNineBySixteen, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_1_schnell.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_1_schnell.rs new file mode 100644 index 00000000..62158d57 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_1_schnell.rs @@ -0,0 +1,31 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::text::generate_flux_1_schnell_text_to_image::GenerateFlux1SchnellTextToImageAspectRatio; + +pub fn aspect_ratio_to_artcraft_flux_1_schnell(aspect_ratio: CommonAspectRatio) -> GenerateFlux1SchnellTextToImageAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => GenerateFlux1SchnellTextToImageAspectRatio::Square, + CommonAspectRatio::SquareHd => GenerateFlux1SchnellTextToImageAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree => GenerateFlux1SchnellTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideSixteenByNine => GenerateFlux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::TallThreeByFour => GenerateFlux1SchnellTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::TallNineBySixteen => GenerateFlux1SchnellTextToImageAspectRatio::PortraitNineBySixteen, + + // Non-matching aspect ratios, use closest neighbor + CommonAspectRatio::TallFourByFive => GenerateFlux1SchnellTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::TallNineByTwentyOne => GenerateFlux1SchnellTextToImageAspectRatio::PortraitNineBySixteen, + CommonAspectRatio::TallTwoByThree => GenerateFlux1SchnellTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::WideFiveByFour => GenerateFlux1SchnellTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::WideThreeByTwo => GenerateFlux1SchnellTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideTwentyOneByNine => GenerateFlux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine, + + // Special + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => GenerateFlux1SchnellTextToImageAspectRatio::Square, + + // Semantic values + CommonAspectRatio::Wide => GenerateFlux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::Tall => GenerateFlux1SchnellTextToImageAspectRatio::PortraitNineBySixteen, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_pro_1p1.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_pro_1p1.rs new file mode 100644 index 00000000..e639360d --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_pro_1p1.rs @@ -0,0 +1,33 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::text::generate_flux_pro_11_text_to_image::GenerateFluxPro11TextToImageAspectRatio; + +pub fn aspect_ratio_to_artcraft_flux_pro_1p1(aspect_ratio: CommonAspectRatio) -> GenerateFluxPro11TextToImageAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => GenerateFluxPro11TextToImageAspectRatio::Square, + CommonAspectRatio::WideFourByThree => GenerateFluxPro11TextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideSixteenByNine => GenerateFluxPro11TextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::TallThreeByFour => GenerateFluxPro11TextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::TallNineBySixteen => GenerateFluxPro11TextToImageAspectRatio::PortraitNineBySixteen, + + // Non-matching aspect ratios, use closest neighbor + CommonAspectRatio::TallFourByFive => GenerateFluxPro11TextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::TallNineByTwentyOne => GenerateFluxPro11TextToImageAspectRatio::PortraitNineBySixteen, + CommonAspectRatio::TallTwoByThree => GenerateFluxPro11TextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::WideFiveByFour => GenerateFluxPro11TextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::WideThreeByTwo => GenerateFluxPro11TextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideTwentyOneByNine => GenerateFluxPro11TextToImageAspectRatio::LandscapeSixteenByNine, + + // Best match + CommonAspectRatio::SquareHd => GenerateFluxPro11TextToImageAspectRatio::Square, + + // Special + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => GenerateFluxPro11TextToImageAspectRatio::Square, + + // Semantic values + CommonAspectRatio::Wide => GenerateFluxPro11TextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::Tall => GenerateFluxPro11TextToImageAspectRatio::PortraitNineBySixteen, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_pro_1p1_ultra.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_pro_1p1_ultra.rs new file mode 100644 index 00000000..f9b75999 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_flux_pro_1p1_ultra.rs @@ -0,0 +1,33 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::text::generate_flux_pro_11_ultra_text_to_image::GenerateFluxPro11UltraTextToImageAspectRatio; + +pub fn aspect_ratio_to_artcraft_flux_pro_1p1_ultra(aspect_ratio: CommonAspectRatio) -> GenerateFluxPro11UltraTextToImageAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => GenerateFluxPro11UltraTextToImageAspectRatio::Square, + CommonAspectRatio::WideFourByThree => GenerateFluxPro11UltraTextToImageAspectRatio::LandscapeFourByThree, + CommonAspectRatio::WideThreeByTwo => GenerateFluxPro11UltraTextToImageAspectRatio::LandscapeThreeByTwo, + CommonAspectRatio::WideSixteenByNine => GenerateFluxPro11UltraTextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::WideTwentyOneByNine => GenerateFluxPro11UltraTextToImageAspectRatio::LandscapeTwentyOneByNine, + CommonAspectRatio::TallThreeByFour => GenerateFluxPro11UltraTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::TallTwoByThree => GenerateFluxPro11UltraTextToImageAspectRatio::PortraitTwoByThree, + CommonAspectRatio::TallNineBySixteen => GenerateFluxPro11UltraTextToImageAspectRatio::PortraitNineBySixteen, + CommonAspectRatio::TallNineByTwentyOne => GenerateFluxPro11UltraTextToImageAspectRatio::PortraitNineByTwentyOne, + + // Non-matching aspect ratios, use closest neighbor + CommonAspectRatio::WideFiveByFour => GenerateFluxPro11UltraTextToImageAspectRatio::PortraitThreeByFour, + CommonAspectRatio::TallFourByFive => GenerateFluxPro11UltraTextToImageAspectRatio::LandscapeFourByThree, + + // Best match + CommonAspectRatio::SquareHd => GenerateFluxPro11UltraTextToImageAspectRatio::Square, + + // Special + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => GenerateFluxPro11UltraTextToImageAspectRatio::Square, + + // Semantic values + CommonAspectRatio::Wide => GenerateFluxPro11UltraTextToImageAspectRatio::LandscapeSixteenByNine, + CommonAspectRatio::Tall => GenerateFluxPro11UltraTextToImageAspectRatio::PortraitNineBySixteen, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_gpt_image_1.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_gpt_image_1.rs new file mode 100644 index 00000000..86a5e16e --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_gpt_image_1.rs @@ -0,0 +1,7 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; + +pub fn aspect_ratio_to_artcraft_gpt_image_1(_aspect_ratio: CommonAspectRatio) -> Option { + // TODO: We still make calls to two distinct endpoints for image-to-image and text-to-image. + // These need to be consolidated to benefit from this approach. + None +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_gpt_image_1p5.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_gpt_image_1p5.rs new file mode 100644 index 00000000..c6b1e219 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_gpt_image_1p5.rs @@ -0,0 +1,33 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::multi_function::gpt_image_1p5_multi_function_image_gen::GptImage1p5MultiFunctionImageGenSize; + +pub fn aspect_ratio_to_artcraft_gpt_image_1p5(aspect_ratio: CommonAspectRatio) -> GptImage1p5MultiFunctionImageGenSize { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => GptImage1p5MultiFunctionImageGenSize::Square, + CommonAspectRatio::Wide => GptImage1p5MultiFunctionImageGenSize::Wide, + CommonAspectRatio::Tall => GptImage1p5MultiFunctionImageGenSize::Tall, + + // Non-matching + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => GptImage1p5MultiFunctionImageGenSize::Square, + + // Mismatch - square + CommonAspectRatio::SquareHd => GptImage1p5MultiFunctionImageGenSize::Square, + + // Mismatch - wide + CommonAspectRatio::WideThreeByTwo + | CommonAspectRatio::WideFiveByFour + | CommonAspectRatio::WideFourByThree + | CommonAspectRatio::WideSixteenByNine + | CommonAspectRatio::WideTwentyOneByNine => GptImage1p5MultiFunctionImageGenSize::Wide, + + // Mismatch - tall + CommonAspectRatio::TallTwoByThree + | CommonAspectRatio::TallFourByFive + | CommonAspectRatio::TallThreeByFour + | CommonAspectRatio::TallNineBySixteen + | CommonAspectRatio::TallNineByTwentyOne => GptImage1p5MultiFunctionImageGenSize::Tall, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_nano_banana.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_nano_banana.rs new file mode 100644 index 00000000..74c5f12b --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_nano_banana.rs @@ -0,0 +1,29 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::multi_function::nano_banana_multi_function_image_gen::NanoBananaMultiFunctionImageGenAspectRatio; + +pub fn aspect_ratio_to_artcraft_nano_banana(aspect_ratio: CommonAspectRatio) -> NanoBananaMultiFunctionImageGenAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => NanoBananaMultiFunctionImageGenAspectRatio::OneByOne, + CommonAspectRatio::WideFiveByFour => NanoBananaMultiFunctionImageGenAspectRatio::FiveByFour, + CommonAspectRatio::WideFourByThree => NanoBananaMultiFunctionImageGenAspectRatio::FourByThree, + CommonAspectRatio::WideThreeByTwo => NanoBananaMultiFunctionImageGenAspectRatio::ThreeByTwo, + CommonAspectRatio::WideSixteenByNine => NanoBananaMultiFunctionImageGenAspectRatio::SixteenByNine, + CommonAspectRatio::WideTwentyOneByNine => NanoBananaMultiFunctionImageGenAspectRatio::TwentyOneByNine, + CommonAspectRatio::TallFourByFive => NanoBananaMultiFunctionImageGenAspectRatio::FourByFive, + CommonAspectRatio::TallThreeByFour => NanoBananaMultiFunctionImageGenAspectRatio::ThreeByFour, + CommonAspectRatio::TallTwoByThree => NanoBananaMultiFunctionImageGenAspectRatio::TwoByThree, + CommonAspectRatio::TallNineBySixteen => NanoBananaMultiFunctionImageGenAspectRatio::NineBySixteen, + // Special + // NB: this is only for image-to-image editing, not text-to-image. + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => NanoBananaMultiFunctionImageGenAspectRatio::Auto, + // NB: "9:21" value does not exist. Interpolated. + CommonAspectRatio::TallNineByTwentyOne => NanoBananaMultiFunctionImageGenAspectRatio::NineBySixteen, + // Semantic values + CommonAspectRatio::Wide => NanoBananaMultiFunctionImageGenAspectRatio::SixteenByNine, + CommonAspectRatio::Tall => NanoBananaMultiFunctionImageGenAspectRatio::NineBySixteen, + CommonAspectRatio::SquareHd => NanoBananaMultiFunctionImageGenAspectRatio::OneByOne, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_nano_banana_pro.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_nano_banana_pro.rs new file mode 100644 index 00000000..66cdd0ea --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_nano_banana_pro.rs @@ -0,0 +1,29 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::multi_function::nano_banana_pro_multi_function_image_gen::NanoBananaProMultiFunctionImageGenAspectRatio; + +pub fn aspect_ratio_to_artcraft_nano_banana_pro(aspect_ratio: CommonAspectRatio) -> NanoBananaProMultiFunctionImageGenAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => NanoBananaProMultiFunctionImageGenAspectRatio::OneByOne, + CommonAspectRatio::WideFiveByFour => NanoBananaProMultiFunctionImageGenAspectRatio::FiveByFour, + CommonAspectRatio::WideFourByThree => NanoBananaProMultiFunctionImageGenAspectRatio::FourByThree, + CommonAspectRatio::WideThreeByTwo => NanoBananaProMultiFunctionImageGenAspectRatio::ThreeByTwo, + CommonAspectRatio::WideSixteenByNine => NanoBananaProMultiFunctionImageGenAspectRatio::SixteenByNine, + CommonAspectRatio::WideTwentyOneByNine => NanoBananaProMultiFunctionImageGenAspectRatio::TwentyOneByNine, + CommonAspectRatio::TallFourByFive => NanoBananaProMultiFunctionImageGenAspectRatio::FourByFive, + CommonAspectRatio::TallThreeByFour => NanoBananaProMultiFunctionImageGenAspectRatio::ThreeByFour, + CommonAspectRatio::TallTwoByThree => NanoBananaProMultiFunctionImageGenAspectRatio::TwoByThree, + CommonAspectRatio::TallNineBySixteen => NanoBananaProMultiFunctionImageGenAspectRatio::NineBySixteen, + // Special + // NB: this is only for image-to-image editing, not text-to-image. + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => NanoBananaProMultiFunctionImageGenAspectRatio::Auto, + // NB: "9:21" value does not exist. Interpolated. + CommonAspectRatio::TallNineByTwentyOne => NanoBananaProMultiFunctionImageGenAspectRatio::NineBySixteen, + // Semantic values + CommonAspectRatio::Wide => NanoBananaProMultiFunctionImageGenAspectRatio::SixteenByNine, + CommonAspectRatio::Tall => NanoBananaProMultiFunctionImageGenAspectRatio::NineBySixteen, + CommonAspectRatio::SquareHd => NanoBananaProMultiFunctionImageGenAspectRatio::OneByOne, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_seedream_4.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_seedream_4.rs new file mode 100644 index 00000000..5582fb9a --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_seedream_4.rs @@ -0,0 +1,29 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::multi_function::bytedance_seedream_v4_multi_function_image_gen::BytedanceSeedreamV4MultiFunctionImageGenImageSize; + +pub fn aspect_ratio_to_artcraft_seedream_4(aspect_ratio: CommonAspectRatio) -> BytedanceSeedreamV4MultiFunctionImageGenImageSize { + match aspect_ratio { + // Exact + CommonAspectRatio::Auto => BytedanceSeedreamV4MultiFunctionImageGenImageSize::Auto, + CommonAspectRatio::Auto2k => BytedanceSeedreamV4MultiFunctionImageGenImageSize::Auto2k, + CommonAspectRatio::Auto4k => BytedanceSeedreamV4MultiFunctionImageGenImageSize::Auto4k, + CommonAspectRatio::Square => BytedanceSeedreamV4MultiFunctionImageGenImageSize::Square, + CommonAspectRatio::SquareHd => BytedanceSeedreamV4MultiFunctionImageGenImageSize::SquareHd, + CommonAspectRatio::WideFourByThree => BytedanceSeedreamV4MultiFunctionImageGenImageSize::LandscapeFourThree, + CommonAspectRatio::WideSixteenByNine => BytedanceSeedreamV4MultiFunctionImageGenImageSize::LandscapeSixteenNine, + CommonAspectRatio::TallThreeByFour => BytedanceSeedreamV4MultiFunctionImageGenImageSize::PortraitFourThree, + CommonAspectRatio::TallNineBySixteen => BytedanceSeedreamV4MultiFunctionImageGenImageSize::PortraitSixteenNine, + + // Non-matching aspect ratios, use closest neighbor + CommonAspectRatio::WideFiveByFour => BytedanceSeedreamV4MultiFunctionImageGenImageSize::LandscapeFourThree, + CommonAspectRatio::WideThreeByTwo => BytedanceSeedreamV4MultiFunctionImageGenImageSize::LandscapeFourThree, + CommonAspectRatio::WideTwentyOneByNine => BytedanceSeedreamV4MultiFunctionImageGenImageSize::LandscapeSixteenNine, + CommonAspectRatio::TallFourByFive => BytedanceSeedreamV4MultiFunctionImageGenImageSize::PortraitFourThree, + CommonAspectRatio::TallTwoByThree => BytedanceSeedreamV4MultiFunctionImageGenImageSize::PortraitFourThree, + CommonAspectRatio::TallNineByTwentyOne => BytedanceSeedreamV4MultiFunctionImageGenImageSize::PortraitSixteenNine, + + // Semantic values + CommonAspectRatio::Wide => BytedanceSeedreamV4MultiFunctionImageGenImageSize::LandscapeSixteenNine, + CommonAspectRatio::Tall => BytedanceSeedreamV4MultiFunctionImageGenImageSize::PortraitSixteenNine, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_seedream_4p5.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_seedream_4p5.rs new file mode 100644 index 00000000..11c5a132 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_artcraft_seedream_4p5.rs @@ -0,0 +1,29 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use artcraft_client::api_defs::generate::image::multi_function::bytedance_seedream_v4p5_multi_function_image_gen::BytedanceSeedreamV4p5MultiFunctionImageGenImageSize; + +pub fn aspect_ratio_to_artcraft_seedream_4p5(aspect_ratio: CommonAspectRatio) -> BytedanceSeedreamV4p5MultiFunctionImageGenImageSize { + match aspect_ratio { + // Exact + CommonAspectRatio::Auto2k => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::Auto2k, + CommonAspectRatio::Auto4k => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::Auto4k, + CommonAspectRatio::Square => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::Square, + CommonAspectRatio::SquareHd => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::SquareHd, + CommonAspectRatio::WideFourByThree => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::LandscapeFourThree, + CommonAspectRatio::WideSixteenByNine => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::LandscapeSixteenNine, + CommonAspectRatio::TallThreeByFour => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::PortraitFourThree, + CommonAspectRatio::TallNineBySixteen => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::PortraitSixteenNine, + + // Non-matching aspect ratios, use closest neighbor + CommonAspectRatio::Auto => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::Auto4k, + CommonAspectRatio::WideFiveByFour => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::LandscapeFourThree, + CommonAspectRatio::WideThreeByTwo => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::LandscapeFourThree, + CommonAspectRatio::WideTwentyOneByNine => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::LandscapeSixteenNine, + CommonAspectRatio::TallFourByFive => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::PortraitFourThree, + CommonAspectRatio::TallTwoByThree => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::PortraitFourThree, + CommonAspectRatio::TallNineByTwentyOne => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::PortraitSixteenNine, + + // Semantic values + CommonAspectRatio::Wide => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::LandscapeSixteenNine, + CommonAspectRatio::Tall => BytedanceSeedreamV4p5MultiFunctionImageGenImageSize::PortraitSixteenNine, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_grok_image.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_grok_image.rs new file mode 100644 index 00000000..a664b4e4 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/aspect_ratio_to_grok_image.rs @@ -0,0 +1,33 @@ +use crate::commands::utils::api_adapters::aspect_ratio::common_aspect_ratio::CommonAspectRatio; +use grok_consumer_client::endpoint_bindings::generate_image_websocket::messages::websocket_client_message::FastAspectRatio; + +pub fn aspect_ratio_to_grok_image(aspect_ratio: CommonAspectRatio) -> FastAspectRatio { + match aspect_ratio { + // Exact + CommonAspectRatio::Square => FastAspectRatio::Square, + CommonAspectRatio::WideThreeByTwo => FastAspectRatio::WideThreeByTwo, + CommonAspectRatio::TallTwoByThree => FastAspectRatio::TallTwoByThree, + + // Close enough + CommonAspectRatio::SquareHd => FastAspectRatio::Square, + + // Non-matching + CommonAspectRatio::Auto + | CommonAspectRatio::Auto2k + | CommonAspectRatio::Auto4k => FastAspectRatio::Square, + + // Mismatch - wide + CommonAspectRatio::Wide + | CommonAspectRatio::WideFiveByFour + | CommonAspectRatio::WideFourByThree + | CommonAspectRatio::WideSixteenByNine + | CommonAspectRatio::WideTwentyOneByNine => FastAspectRatio::WideThreeByTwo, + + // Mismatch - tall + CommonAspectRatio::Tall + | CommonAspectRatio::TallFourByFive + | CommonAspectRatio::TallThreeByFour + | CommonAspectRatio::TallNineBySixteen + | CommonAspectRatio::TallNineByTwentyOne => FastAspectRatio::TallTwoByThree, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/mod.rs new file mode 100644 index 00000000..4280fceb --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/mod.rs @@ -0,0 +1,12 @@ +pub mod aspect_ratio_to_artcraft_flux_1_dev; +pub mod router_aspect_ratio_to_enums_aspect_ratio; +pub mod aspect_ratio_to_artcraft_flux_1_schnell; +pub mod aspect_ratio_to_artcraft_flux_pro_1p1; +pub mod aspect_ratio_to_artcraft_flux_pro_1p1_ultra; +pub mod aspect_ratio_to_artcraft_gpt_image_1; +pub mod aspect_ratio_to_artcraft_gpt_image_1p5; +pub mod aspect_ratio_to_artcraft_nano_banana; +pub mod aspect_ratio_to_artcraft_nano_banana_pro; +pub mod aspect_ratio_to_artcraft_seedream_4; +pub mod aspect_ratio_to_artcraft_seedream_4p5; +pub mod aspect_ratio_to_grok_image; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/router_aspect_ratio_to_enums_aspect_ratio.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/router_aspect_ratio_to_enums_aspect_ratio.rs new file mode 100644 index 00000000..5e3ae77c --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/convert/router_aspect_ratio_to_enums_aspect_ratio.rs @@ -0,0 +1,26 @@ +use router::api::router_aspect_ratio::RouterAspectRatio; +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as EnumsCommonAspectRatio; + +/// Map from the router's CommonAspectRatio to the enums crate's CommonAspectRatio. +pub fn router_aspect_ratio_to_enums_aspect_ratio(ratio: RouterAspectRatio) -> EnumsCommonAspectRatio { + match ratio { + RouterAspectRatio::Auto => EnumsCommonAspectRatio::Auto, + RouterAspectRatio::Square => EnumsCommonAspectRatio::Square, + RouterAspectRatio::WideThreeByTwo => EnumsCommonAspectRatio::WideThreeByTwo, + RouterAspectRatio::WideFourByThree => EnumsCommonAspectRatio::WideFourByThree, + RouterAspectRatio::WideFiveByFour => EnumsCommonAspectRatio::WideFiveByFour, + RouterAspectRatio::WideSixteenByNine => EnumsCommonAspectRatio::WideSixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => EnumsCommonAspectRatio::WideTwentyOneByNine, + RouterAspectRatio::TallTwoByThree => EnumsCommonAspectRatio::TallTwoByThree, + RouterAspectRatio::TallThreeByFour => EnumsCommonAspectRatio::TallThreeByFour, + RouterAspectRatio::TallFourByFive => EnumsCommonAspectRatio::TallFourByFive, + RouterAspectRatio::TallNineBySixteen => EnumsCommonAspectRatio::TallNineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => EnumsCommonAspectRatio::TallNineByTwentyOne, + RouterAspectRatio::Wide => EnumsCommonAspectRatio::Wide, + RouterAspectRatio::Tall => EnumsCommonAspectRatio::Tall, + RouterAspectRatio::Auto2k => EnumsCommonAspectRatio::Auto2k, + RouterAspectRatio::Auto3k => EnumsCommonAspectRatio::Auto3k, + RouterAspectRatio::Auto4k => EnumsCommonAspectRatio::Auto4k, + RouterAspectRatio::SquareHd => EnumsCommonAspectRatio::SquareHd, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/mod.rs new file mode 100644 index 00000000..9dbd41f3 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/aspect_ratio/mod.rs @@ -0,0 +1,2 @@ +pub mod common_aspect_ratio; +pub mod convert; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/mod.rs new file mode 100644 index 00000000..f25f1f21 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/mod.rs @@ -0,0 +1,4 @@ +pub mod aspect_ratio; +pub mod models; +pub mod quality; +pub mod resolution; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/audio/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/audio/mod.rs new file mode 100644 index 00000000..ce52b580 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/audio/mod.rs @@ -0,0 +1,2 @@ +pub mod tauri_audio_model_to_generation_model; +pub mod tauri_audio_model_to_router_model; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/audio/tauri_audio_model_to_generation_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/audio/tauri_audio_model_to_generation_model.rs new file mode 100644 index 00000000..d37918a2 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/audio/tauri_audio_model_to_generation_model.rs @@ -0,0 +1,13 @@ +use crate::events::generation_events::common::GenerationModel; +use crate::commands::generate::generate_audio::request::TauriAudioModel; + +/// Map TauriAudioModel to the frontend-event GenerationModel. +pub fn tauri_audio_model_to_generation_model(model: TauriAudioModel) -> GenerationModel { + match model { + TauriAudioModel::SunoMusic => GenerationModel::SunoMusic, + TauriAudioModel::SunoRemix => GenerationModel::SunoRemix, + TauriAudioModel::SunoSounds => GenerationModel::SunoSounds, + TauriAudioModel::SunoSample => GenerationModel::SunoSample, + TauriAudioModel::SeedAudio1p0 => GenerationModel::SeedAudio1p0, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/audio/tauri_audio_model_to_router_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/audio/tauri_audio_model_to_router_model.rs new file mode 100644 index 00000000..eb68f59b --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/audio/tauri_audio_model_to_router_model.rs @@ -0,0 +1,14 @@ +use router::api::router_audio_model::RouterAudioModel; + +use crate::commands::generate::generate_audio::request::TauriAudioModel; + +/// Map TauriAudioModel to the router's RouterAudioModel. +pub fn tauri_audio_model_to_router_model(model: TauriAudioModel) -> RouterAudioModel { + match model { + TauriAudioModel::SunoMusic => RouterAudioModel::SunoMusic, + TauriAudioModel::SunoRemix => RouterAudioModel::SunoRemix, + TauriAudioModel::SunoSounds => RouterAudioModel::SunoSounds, + TauriAudioModel::SunoSample => RouterAudioModel::SunoSample, + TauriAudioModel::SeedAudio1p0 => RouterAudioModel::SeedAudio1p0, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/image/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/image/mod.rs new file mode 100644 index 00000000..3d782c1e --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/image/mod.rs @@ -0,0 +1,4 @@ +pub mod tauri_image_model_to_common_model_type; +pub mod tauri_image_model_to_enums_model; +pub mod tauri_image_model_to_generation_model; +pub mod tauri_image_model_to_router_model; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_common_model_type.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_common_model_type.rs new file mode 100644 index 00000000..172a5423 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_common_model_type.rs @@ -0,0 +1,36 @@ +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; + +use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; + +/// Map TauriImageModel to the legacy CommonModelType (enums crate). +pub fn tauri_image_model_to_common_model_type(model: TauriImageModel) -> CommonModelType { + match model { + TauriImageModel::Flux1Dev => CommonModelType::Flux1Dev, + TauriImageModel::Flux1Schnell => CommonModelType::Flux1Schnell, + TauriImageModel::FluxPro11 => CommonModelType::FluxPro11, + TauriImageModel::FluxPro11Ultra => CommonModelType::FluxPro11Ultra, + TauriImageModel::GrokImage => CommonModelType::GrokImagineImage, + TauriImageModel::GrokImagineImageQuality => CommonModelType::GrokImagineImageQuality, + TauriImageModel::Recraft3 => CommonModelType::Recraft3, + TauriImageModel::GptImage1 => CommonModelType::GptImage1, + TauriImageModel::GptImage1p5 => CommonModelType::GptImage1p5, + TauriImageModel::GptImage2 => CommonModelType::GptImage2, + TauriImageModel::NanoBanana => CommonModelType::NanoBanana, + TauriImageModel::NanoBanana2 => CommonModelType::NanoBanana2, + TauriImageModel::NanoBanana2Lite => CommonModelType::NanoBanana2, // NB: no dedicated legacy type; nearest. + TauriImageModel::NanoBananaPro => CommonModelType::NanoBananaPro, + TauriImageModel::Seedream4 => CommonModelType::Seedream4, + TauriImageModel::Seedream4p5 => CommonModelType::Seedream4p5, + TauriImageModel::Seedream5Lite => CommonModelType::Seedream5Lite, + TauriImageModel::Seedream5p0Pro => CommonModelType::Seedream5p0Pro, + TauriImageModel::Seedream5p0ProUltra => CommonModelType::Seedream5p0ProUltra, + TauriImageModel::Midjourney7 => CommonModelType::Midjourney7, + TauriImageModel::Midjourney7Niji => CommonModelType::Midjourney7Niji, + TauriImageModel::Midjourney8 => CommonModelType::Midjourney8, + TauriImageModel::FluxProKontextMax => CommonModelType::FluxProKontextMax, + TauriImageModel::QwenEdit2511Angles => CommonModelType::QwenEdit2511Angles, + TauriImageModel::Flux2LoraAngles => CommonModelType::Flux2LoraAngles, + TauriImageModel::FluxDevJuggernaut => CommonModelType::FluxDevJuggernaut, + TauriImageModel::FluxPro1 => CommonModelType::FluxPro1, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_enums_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_enums_model.rs new file mode 100644 index 00000000..43790360 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_enums_model.rs @@ -0,0 +1,38 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel; + +use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; + +/// Map TauriImageModel to the omni endpoint's CommonImageModel (enums crate). +/// Returns None for models not yet supported by the omni endpoint. +pub fn tauri_image_model_to_enums_model(model: TauriImageModel) -> Option { + match model { + TauriImageModel::Flux1Dev => Some(CommonImageModel::Flux1Dev), + TauriImageModel::Flux1Schnell => Some(CommonImageModel::Flux1Schnell), + TauriImageModel::FluxPro1 => Some(CommonImageModel::FluxPro11), // TODO: Might be a slight mismatch + TauriImageModel::FluxPro11 => Some(CommonImageModel::FluxPro11), + TauriImageModel::FluxPro11Ultra => Some(CommonImageModel::FluxPro11Ultra), + TauriImageModel::GptImage1 => Some(CommonImageModel::GptImage1), + TauriImageModel::GptImage1p5 => Some(CommonImageModel::GptImage1p5), + TauriImageModel::GptImage2 => Some(CommonImageModel::GptImage2), + TauriImageModel::NanoBanana => Some(CommonImageModel::NanoBanana), + TauriImageModel::NanoBanana2 => Some(CommonImageModel::NanoBanana2), + TauriImageModel::NanoBanana2Lite => None, // Higgsfield only; not on the omni endpoint. + TauriImageModel::NanoBananaPro => Some(CommonImageModel::NanoBananaPro), + TauriImageModel::Seedream4 => Some(CommonImageModel::Seedream4), + TauriImageModel::Seedream4p5 => Some(CommonImageModel::Seedream4p5), + TauriImageModel::Seedream5Lite => Some(CommonImageModel::Seedream5Lite), + TauriImageModel::Seedream5p0Pro => Some(CommonImageModel::Seedream5p0Pro), + TauriImageModel::Seedream5p0ProUltra => Some(CommonImageModel::Seedream5p0ProUltra), + TauriImageModel::QwenEdit2511Angles => Some(CommonImageModel::QwenEdit2511Angles), + TauriImageModel::Flux2LoraAngles => Some(CommonImageModel::Flux2LoraAngles), + TauriImageModel::Midjourney7 => Some(CommonImageModel::Midjourney7), + TauriImageModel::Midjourney7Niji => Some(CommonImageModel::Midjourney7Niji), + TauriImageModel::Midjourney8 => Some(CommonImageModel::Midjourney8), + // Not accounted for yet + TauriImageModel::GrokImage => Some(CommonImageModel::GrokImagineImage), + TauriImageModel::GrokImagineImageQuality => Some(CommonImageModel::GrokImagineImageQuality), + TauriImageModel::Recraft3 => None, + TauriImageModel::FluxProKontextMax => None, + TauriImageModel::FluxDevJuggernaut => None, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_generation_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_generation_model.rs new file mode 100644 index 00000000..f661a30a --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_generation_model.rs @@ -0,0 +1,35 @@ +use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; +use crate::events::generation_events::common::GenerationModel; + +/// Map TauriImageModel to GenerationModel for frontend events. +pub fn tauri_image_model_to_generation_model(model: TauriImageModel) -> GenerationModel { + match model { + TauriImageModel::Flux1Dev => GenerationModel::Flux1Dev, + TauriImageModel::Flux1Schnell => GenerationModel::Flux1Schnell, + TauriImageModel::FluxPro11 => GenerationModel::FluxPro11, + TauriImageModel::FluxPro11Ultra => GenerationModel::FluxPro11Ultra, + TauriImageModel::GrokImage => GenerationModel::GrokImage, + TauriImageModel::GrokImagineImageQuality => GenerationModel::GrokImage, // NB: no tier-specific task model yet + TauriImageModel::Recraft3 => GenerationModel::Flux1Dev, // Fallback + TauriImageModel::GptImage1 => GenerationModel::GptImage1, + TauriImageModel::GptImage1p5 => GenerationModel::GptImage1p5, + TauriImageModel::GptImage2 => GenerationModel::GptImage2, + TauriImageModel::NanoBanana => GenerationModel::NanoBanana, + TauriImageModel::NanoBanana2 => GenerationModel::NanoBanana2, + TauriImageModel::NanoBanana2Lite => GenerationModel::NanoBanana2Lite, + TauriImageModel::NanoBananaPro => GenerationModel::NanoBananaPro, + TauriImageModel::Seedream4 => GenerationModel::Seedream4, + TauriImageModel::Seedream4p5 => GenerationModel::Seedream4p5, + TauriImageModel::Seedream5Lite => GenerationModel::Seedream5Lite, + TauriImageModel::Seedream5p0Pro => GenerationModel::Seedream5p0Pro, + TauriImageModel::Seedream5p0ProUltra => GenerationModel::Seedream5p0ProUltra, + TauriImageModel::Midjourney7 => GenerationModel::Midjourney7, + TauriImageModel::Midjourney7Niji => GenerationModel::Midjourney7Niji, + TauriImageModel::Midjourney8 => GenerationModel::Midjourney8, + TauriImageModel::FluxProKontextMax => GenerationModel::FluxProKontextMax, + TauriImageModel::QwenEdit2511Angles => GenerationModel::QwenEdit2511Angles, + TauriImageModel::Flux2LoraAngles => GenerationModel::Flux2LoraAngles, + TauriImageModel::FluxDevJuggernaut => GenerationModel::FluxDevJuggernaut, + TauriImageModel::FluxPro1 => GenerationModel::FluxPro1, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_router_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_router_model.rs new file mode 100644 index 00000000..8a4d27c7 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/image/tauri_image_model_to_router_model.rs @@ -0,0 +1,39 @@ +use router::api::router_image_model::RouterImageModel; + +use crate::commands::generate::generate_image::tauri_image_model::TauriImageModel; + +/// Map TauriImageModel to the artcraft_router's RouterImageModel. +/// Returns None for models not supported by the router (Recraft, etc.). +pub fn tauri_image_model_to_router_model(model: TauriImageModel) -> Option { + match model { + TauriImageModel::Flux1Dev => Some(RouterImageModel::Flux1Dev), // Text-to-Image + TauriImageModel::Flux1Schnell => Some(RouterImageModel::Flux1Schnell), // Text-to-Image + TauriImageModel::FluxPro1 => Some(RouterImageModel::FluxPro11), // TODO: Might be a slight mismatch + TauriImageModel::FluxPro11 => Some(RouterImageModel::FluxPro11), // Text-to-Image + TauriImageModel::FluxPro11Ultra => Some(RouterImageModel::FluxPro11Ultra), // Text-to-Image + TauriImageModel::GptImage1 => Some(RouterImageModel::GptImage1), // Text-to-Image + TauriImageModel::GptImage1p5 => Some(RouterImageModel::GptImage1p5), // Text-to-Image + TauriImageModel::GptImage2 => Some(RouterImageModel::GptImage2), // Text-to-Image + TauriImageModel::NanoBanana => Some(RouterImageModel::NanoBanana), // Text-to-Image + TauriImageModel::NanoBanana2 => Some(RouterImageModel::NanoBanana2), // Text-to-Image + TauriImageModel::NanoBanana2Lite => Some(RouterImageModel::NanoBanana2Lite), // Higgsfield only + TauriImageModel::NanoBananaPro => Some(RouterImageModel::NanoBananaPro), // Text-to-Image + TauriImageModel::Seedream4 => Some(RouterImageModel::Seedream4), // Text-to-Image + TauriImageModel::Seedream4p5 => Some(RouterImageModel::Seedream4p5), // Text-to-Image + TauriImageModel::Seedream5Lite => Some(RouterImageModel::Seedream5Lite), // Text-to-Image + TauriImageModel::Seedream5p0Pro => Some(RouterImageModel::Seedream5p0Pro), // Text-to-Image + TauriImageModel::Seedream5p0ProUltra => Some(RouterImageModel::Seedream5p0ProUltra), // Text-to-Image + TauriImageModel::QwenEdit2511Angles => Some(RouterImageModel::QwenEdit2511Angles), + TauriImageModel::Flux2LoraAngles => Some(RouterImageModel::Flux2LoraAngles), + TauriImageModel::Midjourney7 => Some(RouterImageModel::Midjourney7), + TauriImageModel::Midjourney7Niji => Some(RouterImageModel::Midjourney7Niji), + TauriImageModel::Midjourney8 => Some(RouterImageModel::Midjourney8), + // First-party (cookie-session) Grok Imagine + TauriImageModel::GrokImage => Some(RouterImageModel::GrokImagineImage), + TauriImageModel::GrokImagineImageQuality => Some(RouterImageModel::GrokImagineImageQuality), + // Not accounted for yet + TauriImageModel::Recraft3 => None, + TauriImageModel::FluxProKontextMax => None, + TauriImageModel::FluxDevJuggernaut => None, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/mod.rs new file mode 100644 index 00000000..c188ecba --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/mod.rs @@ -0,0 +1,2 @@ +pub mod tauri_mesh_model_to_generation_model; +pub mod tauri_mesh_model_to_router_model; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/tauri_mesh_model_to_generation_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/tauri_mesh_model_to_generation_model.rs new file mode 100644 index 00000000..5ce6200b --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/tauri_mesh_model_to_generation_model.rs @@ -0,0 +1,19 @@ +use crate::events::generation_events::common::GenerationModel; +use crate::commands::generate::generate_mesh::request::TauriMeshModel; + +/// Map TauriMeshModel to the frontend-event GenerationModel. +pub fn tauri_mesh_model_to_generation_model(model: TauriMeshModel) -> GenerationModel { + match model { + TauriMeshModel::Hunyuan3d2p0 => GenerationModel::Hunyuan3d2_0, + TauriMeshModel::Hunyuan3d2p1 => GenerationModel::Hunyuan3d2_1, + TauriMeshModel::Hunyuan3d3 => GenerationModel::Hunyuan3d3, + TauriMeshModel::Hunyuan3d3Sketch => GenerationModel::Hunyuan3d3Sketch, + TauriMeshModel::Hunyuan3d3p1Pro => GenerationModel::Hunyuan3d3p1Pro, + TauriMeshModel::Hunyuan3d3p1Rapid => GenerationModel::Hunyuan3d3p1Rapid, + TauriMeshModel::Hunyuan3d3p1Part => GenerationModel::Hunyuan3d3p1Part, + TauriMeshModel::Hunyuan3d3p1SmartTopology => GenerationModel::Hunyuan3d3p1SmartTopology, + TauriMeshModel::Tripo3dH3p1 => GenerationModel::Tripo3dH3p1, + TauriMeshModel::MeshyV6 => GenerationModel::MeshyV6, + TauriMeshModel::Rodin2p5Fast => GenerationModel::Rodin2p5Fast, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/tauri_mesh_model_to_router_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/tauri_mesh_model_to_router_model.rs new file mode 100644 index 00000000..25d639f1 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/mesh/tauri_mesh_model_to_router_model.rs @@ -0,0 +1,20 @@ +use router::api::router_mesh_model::RouterMeshModel; + +use crate::commands::generate::generate_mesh::request::TauriMeshModel; + +/// Map TauriMeshModel to the router's RouterMeshModel. +pub fn tauri_mesh_model_to_router_model(model: TauriMeshModel) -> RouterMeshModel { + match model { + TauriMeshModel::Hunyuan3d2p0 => RouterMeshModel::Hunyuan3d2p0, + TauriMeshModel::Hunyuan3d2p1 => RouterMeshModel::Hunyuan3d2p1, + TauriMeshModel::Hunyuan3d3 => RouterMeshModel::Hunyuan3d3, + TauriMeshModel::Hunyuan3d3Sketch => RouterMeshModel::Hunyuan3d3Sketch, + TauriMeshModel::Hunyuan3d3p1Pro => RouterMeshModel::Hunyuan3d3p1Pro, + TauriMeshModel::Hunyuan3d3p1Rapid => RouterMeshModel::Hunyuan3d3p1Rapid, + TauriMeshModel::Hunyuan3d3p1Part => RouterMeshModel::Hunyuan3d3p1Part, + TauriMeshModel::Hunyuan3d3p1SmartTopology => RouterMeshModel::Hunyuan3d3p1SmartTopology, + TauriMeshModel::Tripo3dH3p1 => RouterMeshModel::Tripo3dH3p1, + TauriMeshModel::MeshyV6 => RouterMeshModel::MeshyV6, + TauriMeshModel::Rodin2p5Fast => RouterMeshModel::Rodin2p5Fast, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/mod.rs new file mode 100644 index 00000000..53eac2cd --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/mod.rs @@ -0,0 +1,5 @@ +pub mod audio; +pub mod image; +pub mod video; +pub mod mesh; +pub mod splat; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/splat/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/splat/mod.rs new file mode 100644 index 00000000..b259373a --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/splat/mod.rs @@ -0,0 +1,2 @@ +pub mod tauri_splat_model_to_generation_model; +pub mod tauri_splat_model_to_router_model; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/splat/tauri_splat_model_to_generation_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/splat/tauri_splat_model_to_generation_model.rs new file mode 100644 index 00000000..c1f4fc32 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/splat/tauri_splat_model_to_generation_model.rs @@ -0,0 +1,15 @@ +use crate::events::generation_events::common::GenerationModel; +use crate::commands::generate::generate_splat::request::TauriSplatModel; + +/// Map TauriSplatModel to the frontend-event GenerationModel. +pub fn tauri_splat_model_to_generation_model(model: TauriSplatModel) -> GenerationModel { + match model { + TauriSplatModel::Marble0p1Mini => GenerationModel::WorldlabsMarble0p1Mini, + TauriSplatModel::Marble0p1Plus => GenerationModel::WorldlabsMarble0p1Plus, + TauriSplatModel::Marble1p0 => GenerationModel::Marble1p0, + TauriSplatModel::Marble1p0Draft => GenerationModel::Marble1p0Draft, + TauriSplatModel::Marble1p1 => GenerationModel::Marble1p1, + TauriSplatModel::Marble1p1Plus => GenerationModel::Marble1p1Plus, + TauriSplatModel::TripoSplat => GenerationModel::TripoSplat, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/splat/tauri_splat_model_to_router_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/splat/tauri_splat_model_to_router_model.rs new file mode 100644 index 00000000..9906b8c5 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/splat/tauri_splat_model_to_router_model.rs @@ -0,0 +1,16 @@ +use router::api::router_splat_model::RouterSplatModel; + +use crate::commands::generate::generate_splat::request::TauriSplatModel; + +/// Map TauriSplatModel to the router's RouterSplatModel. +pub fn tauri_splat_model_to_router_model(model: TauriSplatModel) -> RouterSplatModel { + match model { + TauriSplatModel::Marble0p1Mini => RouterSplatModel::Marble0p1Mini, + TauriSplatModel::Marble0p1Plus => RouterSplatModel::Marble0p1Plus, + TauriSplatModel::Marble1p0 => RouterSplatModel::Marble1p0, + TauriSplatModel::Marble1p0Draft => RouterSplatModel::Marble1p0Draft, + TauriSplatModel::Marble1p1 => RouterSplatModel::Marble1p1, + TauriSplatModel::Marble1p1Plus => RouterSplatModel::Marble1p1Plus, + TauriSplatModel::TripoSplat => RouterSplatModel::TripoSplat, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/video/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/video/mod.rs new file mode 100644 index 00000000..b2235723 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/video/mod.rs @@ -0,0 +1,2 @@ +pub mod tauri_video_model_to_generation_model; +pub mod tauri_video_model_to_router_model; diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/video/tauri_video_model_to_generation_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/video/tauri_video_model_to_generation_model.rs new file mode 100644 index 00000000..8f1f9ada --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/video/tauri_video_model_to_generation_model.rs @@ -0,0 +1,38 @@ +use crate::commands::generate::generate_video::request::TauriVideoModel; +use crate::events::generation_events::common::GenerationModel; + +/// Map TauriVideoModel to the GenerationModel used in events and the task database. +/// NB: GenerationModel serializations are stored in the tasks database — they keep +/// their legacy spellings for compatibility. +pub fn tauri_video_model_to_generation_model(model: TauriVideoModel) -> GenerationModel { + match model { + TauriVideoModel::GrokVideo => GenerationModel::GrokVideo, + TauriVideoModel::GrokImagineVideo1p5 => GenerationModel::GrokImagineVideo1p5, + TauriVideoModel::HappyHorse1p0 => GenerationModel::HappyHorse1p0, + TauriVideoModel::Kling16Pro => GenerationModel::Kling1_6, + TauriVideoModel::Kling21Master => GenerationModel::Kling21Master, + TauriVideoModel::Kling21Pro => GenerationModel::Kling21Pro, + TauriVideoModel::Kling2p5TurboPro => GenerationModel::Kling2p5TurboPro, + TauriVideoModel::Kling2p6Pro => GenerationModel::Kling2p6Pro, + TauriVideoModel::Kling3p0Pro => GenerationModel::Kling3p0Pro, + TauriVideoModel::Kling3p0Standard => GenerationModel::Kling3p0Standard, + TauriVideoModel::Seedance10Lite => GenerationModel::Seedance10Lite, + TauriVideoModel::Seedance1p5Pro => GenerationModel::Seedance1p5Pro, + TauriVideoModel::Seedance2p0 => GenerationModel::Seedance2p0, + TauriVideoModel::Seedance2p0Fast => GenerationModel::Seedance2p0Fast, + TauriVideoModel::Seedance2p0Mini => GenerationModel::Seedance2p0Mini, + TauriVideoModel::Seedance2p5 => GenerationModel::Seedance2p5, + TauriVideoModel::Seedance2p5Edit => GenerationModel::Seedance2p5Edit, + TauriVideoModel::MinimaxH3 => GenerationModel::MinimaxH3, + TauriVideoModel::Sora2 => GenerationModel::Sora2, + TauriVideoModel::Sora2Pro => GenerationModel::Sora2Pro, + TauriVideoModel::Veo2 => GenerationModel::Veo2, + TauriVideoModel::Veo3 => GenerationModel::Veo3, + TauriVideoModel::Veo3Fast => GenerationModel::Veo3Fast, + TauriVideoModel::Veo3p1 => GenerationModel::Veo3p1, + TauriVideoModel::Veo3p1Fast => GenerationModel::Veo3p1Fast, + TauriVideoModel::Veo3p1Lite => GenerationModel::Veo3p1Lite, + TauriVideoModel::ViduQ3 => GenerationModel::ViduQ3, + TauriVideoModel::ViduQ3Turbo => GenerationModel::ViduQ3Turbo, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/models/video/tauri_video_model_to_router_model.rs b/crates/artcraftx/src/commands/utils/api_adapters/models/video/tauri_video_model_to_router_model.rs new file mode 100644 index 00000000..16b2da5b --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/models/video/tauri_video_model_to_router_model.rs @@ -0,0 +1,37 @@ +use router::api::router_video_model::RouterVideoModel; + +use crate::commands::generate::generate_video::request::TauriVideoModel; + +/// Map TauriVideoModel to the artcraft_router's RouterVideoModel. +pub fn tauri_video_model_to_router_model(model: TauriVideoModel) -> RouterVideoModel { + match model { + TauriVideoModel::GrokVideo => RouterVideoModel::GrokImagineVideo, + TauriVideoModel::GrokImagineVideo1p5 => RouterVideoModel::GrokImagineVideo1p5, + TauriVideoModel::HappyHorse1p0 => RouterVideoModel::HappyHorse1p0, + TauriVideoModel::Kling16Pro => RouterVideoModel::Kling16Pro, + TauriVideoModel::Kling21Master => RouterVideoModel::Kling21Master, + TauriVideoModel::Kling21Pro => RouterVideoModel::Kling21Pro, + TauriVideoModel::Kling2p5TurboPro => RouterVideoModel::Kling2p5TurboPro, + TauriVideoModel::Kling2p6Pro => RouterVideoModel::Kling2p6Pro, + TauriVideoModel::Kling3p0Pro => RouterVideoModel::Kling3p0Pro, + TauriVideoModel::Kling3p0Standard => RouterVideoModel::Kling3p0Standard, + TauriVideoModel::Seedance10Lite => RouterVideoModel::Seedance10Lite, + TauriVideoModel::Seedance1p5Pro => RouterVideoModel::Seedance1p5Pro, + TauriVideoModel::Seedance2p0 => RouterVideoModel::Seedance2p0, + TauriVideoModel::Seedance2p0Fast => RouterVideoModel::Seedance2p0Fast, + TauriVideoModel::Seedance2p0Mini => RouterVideoModel::Seedance2p0Mini, + TauriVideoModel::Seedance2p5 => RouterVideoModel::Seedance2p5, + TauriVideoModel::Seedance2p5Edit => RouterVideoModel::Seedance2p5Edit, + TauriVideoModel::MinimaxH3 => RouterVideoModel::MinimaxH3, + TauriVideoModel::Sora2 => RouterVideoModel::Sora2, + TauriVideoModel::Sora2Pro => RouterVideoModel::Sora2Pro, + TauriVideoModel::Veo2 => RouterVideoModel::Veo2, + TauriVideoModel::Veo3 => RouterVideoModel::Veo3, + TauriVideoModel::Veo3Fast => RouterVideoModel::Veo3Fast, + TauriVideoModel::Veo3p1 => RouterVideoModel::Veo3p1, + TauriVideoModel::Veo3p1Fast => RouterVideoModel::Veo3p1Fast, + TauriVideoModel::Veo3p1Lite => RouterVideoModel::Veo3p1Lite, + TauriVideoModel::ViduQ3 => RouterVideoModel::ViduQ3, + TauriVideoModel::ViduQ3Turbo => RouterVideoModel::ViduQ3Turbo, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/quality/common_quality.rs b/crates/artcraftx/src/commands/utils/api_adapters/quality/common_quality.rs new file mode 100644 index 00000000..cd234e58 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/quality/common_quality.rs @@ -0,0 +1,21 @@ +use serde_derive::{Deserialize, Serialize}; +use router::api::router_quality::RouterQuality; + +/// Just cargo culting this. might not be necessary for standalone types anymore +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonQuality { + High, + Medium, + Low, +} + +impl CommonQuality { + pub fn to_artcraft_router_type(&self) -> RouterQuality { + match self { + CommonQuality::High => RouterQuality::High, + CommonQuality::Medium => RouterQuality::Medium, + CommonQuality::Low => RouterQuality::Low, + } + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/quality/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/quality/mod.rs new file mode 100644 index 00000000..1f4f0aaa --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/quality/mod.rs @@ -0,0 +1 @@ +pub mod common_quality; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/utils/api_adapters/resolution/common_resolution.rs b/crates/artcraftx/src/commands/utils/api_adapters/resolution/common_resolution.rs new file mode 100644 index 00000000..3b401c02 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/resolution/common_resolution.rs @@ -0,0 +1,29 @@ +use serde_derive::{Deserialize, Serialize}; + +/// This is a comprehensive list of common resolutions you can specify when enqueuing a generation. +/// Not every model will support every resolution +/// In the case a model doesn't support the resolution, gracefully pick the nearest option. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonResolution { + /// Models: Nano Banana Pro + OneK, + /// Models: Nano Banana Pro + TwoK, + /// Models: (None) + ThreeK, + /// Models: Nano Banana Pro + FourK, + + /// Used by Nano Banana 2 (and others) + HalfK, + + /// Used by the Seedance family (and others) + FourEightyP, + + /// Used by the Seedance family (and others) + SevenTwentyP, + + /// Used by the Seedance family (and others) + TenEightyP, +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/mod.rs new file mode 100644 index 00000000..332209b3 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/mod.rs @@ -0,0 +1,2 @@ +pub mod resolution_to_artcraft_nano_banana_pro; +pub mod router_resolution_to_enums_resolution; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/resolution_to_artcraft_nano_banana_pro.rs b/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/resolution_to_artcraft_nano_banana_pro.rs new file mode 100644 index 00000000..e01e46b1 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/resolution_to_artcraft_nano_banana_pro.rs @@ -0,0 +1,17 @@ +use crate::commands::utils::api_adapters::resolution::common_resolution::CommonResolution; +use artcraft_client::api_defs::generate::image::multi_function::nano_banana_pro_multi_function_image_gen::NanoBananaProMultiFunctionImageGenImageResolution; + +pub fn resolution_to_artcraft_nano_banana_pro(resolution: CommonResolution) -> NanoBananaProMultiFunctionImageGenImageResolution { + match resolution { + CommonResolution::OneK => NanoBananaProMultiFunctionImageGenImageResolution::OneK, + CommonResolution::TwoK => NanoBananaProMultiFunctionImageGenImageResolution::TwoK, + // NB: ThreeK doesn't exist in Nano Banana Pro, use FourK as nearest higher resolution + CommonResolution::ThreeK => NanoBananaProMultiFunctionImageGenImageResolution::FourK, + CommonResolution::FourK => NanoBananaProMultiFunctionImageGenImageResolution::FourK, + // Fall back to nearest supported resolution + CommonResolution::HalfK => NanoBananaProMultiFunctionImageGenImageResolution::OneK, + CommonResolution::FourEightyP => NanoBananaProMultiFunctionImageGenImageResolution::OneK, + CommonResolution::SevenTwentyP => NanoBananaProMultiFunctionImageGenImageResolution::OneK, + CommonResolution::TenEightyP => NanoBananaProMultiFunctionImageGenImageResolution::OneK, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/router_resolution_to_enums_resolution.rs b/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/router_resolution_to_enums_resolution.rs new file mode 100644 index 00000000..390bf891 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/resolution/convert/router_resolution_to_enums_resolution.rs @@ -0,0 +1,16 @@ +use router::api::router_resolution::RouterResolution; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as EnumsCommonResolution; + +/// Map from the router's CommonResolution to the enums crate's CommonResolution. +pub fn router_resolution_to_enums_resolution(res: RouterResolution) -> EnumsCommonResolution { + match res { + RouterResolution::OneK => EnumsCommonResolution::OneK, + RouterResolution::TwoK => EnumsCommonResolution::TwoK, + RouterResolution::ThreeK => EnumsCommonResolution::ThreeK, + RouterResolution::FourK => EnumsCommonResolution::FourK, + RouterResolution::HalfK => EnumsCommonResolution::HalfK, + RouterResolution::FourEightyP => EnumsCommonResolution::FourEightyP, + RouterResolution::SevenTwentyP => EnumsCommonResolution::SevenTwentyP, + RouterResolution::TenEightyP => EnumsCommonResolution::TenEightyP, + } +} diff --git a/crates/artcraftx/src/commands/utils/api_adapters/resolution/mod.rs b/crates/artcraftx/src/commands/utils/api_adapters/resolution/mod.rs new file mode 100644 index 00000000..f1197a3d --- /dev/null +++ b/crates/artcraftx/src/commands/utils/api_adapters/resolution/mod.rs @@ -0,0 +1,2 @@ +pub mod common_resolution; +pub mod convert; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/utils/mod.rs b/crates/artcraftx/src/commands/utils/mod.rs new file mode 100644 index 00000000..e908f364 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/mod.rs @@ -0,0 +1,2 @@ +pub mod api_adapters; +pub mod response; diff --git a/crates/artcraftx/src/commands/utils/response/failure_response_wrapper.rs b/crates/artcraftx/src/commands/utils/response/failure_response_wrapper.rs new file mode 100644 index 00000000..b193791d --- /dev/null +++ b/crates/artcraftx/src/commands/utils/response/failure_response_wrapper.rs @@ -0,0 +1,53 @@ +use serde::Serialize; + +/// Statuses for errorful commands. +#[derive(Serialize, Clone, Debug)] +#[serde(rename_all = "snake_case")] +pub enum CommandErrorStatus { + BadRequest, // 400 + Unauthorized, // 401 + TooManyRequests, // 429 + ServerError, // 500 +} + +#[derive(Serialize, Debug)] +pub struct CommandErrorResponseWrapper { + /// Both "success" and "error" types have a `status` field for the frontend. + /// We constrain the value types for successes and failures. + pub status: CommandErrorStatus, + + #[serde(skip_serializing_if = "Option::is_none")] + pub error_message: Option, + + /// Represents a "type" of error, preferably an enum without payloads. + /// Preferably this serializes to a string. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_type: Option, + + /// Represents a full error details object or payload. + /// This could be a structure, message, or whatever. + #[serde(skip_serializing_if = "Option::is_none")] + pub error_details: Option, +} + +impl From<&str> for CommandErrorResponseWrapper<(), ()> { + fn from(value: &str) -> Self { + CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, // NB: Default to 500 error. + error_message: Some(value.to_string()), + error_type: None, + error_details: None, + } + } +} + +impl From for CommandErrorResponseWrapper<(), ()> { + fn from(value: String) -> Self { + CommandErrorResponseWrapper { + status: CommandErrorStatus::BadRequest, // NB: Default to 500 error. + error_message: Some(value), + error_type: None, + error_details: None, + } + } +} diff --git a/crates/artcraftx/src/commands/utils/response/mod.rs b/crates/artcraftx/src/commands/utils/response/mod.rs new file mode 100644 index 00000000..d9d4f372 --- /dev/null +++ b/crates/artcraftx/src/commands/utils/response/mod.rs @@ -0,0 +1,3 @@ +pub mod failure_response_wrapper; +pub mod shorthand; +pub mod success_response_wrapper; \ No newline at end of file diff --git a/crates/artcraftx/src/commands/utils/response/shorthand.rs b/crates/artcraftx/src/commands/utils/response/shorthand.rs new file mode 100644 index 00000000..d0abc40c --- /dev/null +++ b/crates/artcraftx/src/commands/utils/response/shorthand.rs @@ -0,0 +1,53 @@ +use crate::commands::utils::response::failure_response_wrapper::CommandErrorResponseWrapper; +use crate::commands::utils::response::success_response_wrapper::CommandSuccessResponseWrapper; + +// TODO(needs command response refactor): +// - get_app_preferences_command +// - update_app_preferences_command +// - flip_image + +// TODO(already updated, need to update frontend): +// - platform_info_command + +// TODO(simplify error types): +// - enqueue_text_to_image_command +// - fal_background_removal_command +// - fal_hunyuan_image_to_3d_command +// - fal_kling_image_to_video_command +// - get_fal_api_key_command +// - set_fal_api_key_command + +/// Easy to use infallible response. +/// This always contains a success payload and never results in an error. +pub type InfallibleResponse = CommandSuccessResponseWrapper; + +/// Easy to use Result type. +/// +/// There are easier ways to use Response : +/// - `SimpleResponse` just returns strings on success or error (but provides clues to the frontend) +/// - `SuccessOrErrorMessage` returns an empty success payload or an error message +/// - `ResponseOrErrorMessage` returns a success payload or an error message +/// - `ResponseOrErrorType` returns a success payload or an error type +/// - `ResponseOrError` returns a success payload or an error payload +/// +pub type Response = + Result, CommandErrorResponseWrapper>; + +/// No inner payloads for this type. Just strings as messages. +pub type SimpleResponse = Response<(), (), ()>; + +/// Either an empty success payload or error message. +pub type SuccessOrErrorMessage = + Result, CommandErrorResponseWrapper<(), ()>>; + +/// Either a success or error message. +pub type ResponseOrErrorMessage = + Result, CommandErrorResponseWrapper<(), ()>>; + +/// Either a success or error type. +pub type ResponseOrErrorType = + Result, CommandErrorResponseWrapper>; + +/// Either a success or error payload. +pub type ResponseOrError = + Result, CommandErrorResponseWrapper<(), ErrPayload>>; diff --git a/crates/artcraftx/src/commands/utils/response/success_response_wrapper.rs b/crates/artcraftx/src/commands/utils/response/success_response_wrapper.rs new file mode 100644 index 00000000..2666ce5f --- /dev/null +++ b/crates/artcraftx/src/commands/utils/response/success_response_wrapper.rs @@ -0,0 +1,86 @@ +use serde::Serialize; + +/// Statuses for successful commands. +#[derive(Serialize, Clone, Debug)] +#[serde(rename_all = "snake_case")] +pub enum CommandSuccessStatus { + Success, // 200 +} + +#[derive(Serialize, Debug)] +pub struct CommandSuccessResponseWrapper { + /// Both "success" and "error" types have a `status` field for the frontend. + /// We constrain the value types for successes and failures. + pub status: CommandSuccessStatus, + + #[serde(skip_serializing_if = "Option::is_none")] + pub success_message: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub payload: Option, +} + +/// NB: This is a hack because of `()` (a.k.a. the "unit" type) and `Serialize` trait coherence and overlap. +/// We cannot currently implement a trait for `()` and generic `Serialize` because `()` itself implements +/// `Serialize`. Rust's `"specialization"`, which would let us account for this, is an unstable, nightly-only +/// feature. So instead we manually mark all types other than `()` with `SerializeMarker` as a hack to +/// distinguish the two. +pub trait SerializeMarker : Serialize {} + +impl CommandSuccessResponseWrapper<()> { + pub fn empty_success() -> Self { + Self::empty() + } + pub fn empty() -> Self { + CommandSuccessResponseWrapper { + status: CommandSuccessStatus::Success, + success_message: None, + payload: None, + } + } +} + +// NB: () is Serialize! So we can't broadly implement just `T: Serialize`. +impl From<()> for CommandSuccessResponseWrapper<()> { + fn from(_: ()) -> Self { + CommandSuccessResponseWrapper { + status: CommandSuccessStatus::Success, + success_message: None, + payload: None, + } + } +} + +/// NB: Note the `"+ SerializeMarker"` bound here. This is a hack to distinguish between `()` and other types +/// for which we will manually mark as `SerializeMarker`. +impl From for CommandSuccessResponseWrapper where T: Serialize + SerializeMarker { + fn from(val: T) -> Self { + CommandSuccessResponseWrapper { + status: CommandSuccessStatus::Success, + success_message: None, + payload: Some(val), + } + } +} + +impl From<&str> for CommandSuccessResponseWrapper { + fn from(msg: &str) -> Self { + CommandSuccessResponseWrapper { + status: CommandSuccessStatus::Success, + success_message: Some(msg.to_string()), + payload: None, + } + } +} + +#[cfg(test)] +mod tests { + + #[test] + fn test_empty_tuple_serialize() { + let response = super::CommandSuccessResponseWrapper::<()>::from(()); + let serialized = serde_json::to_string(&response).unwrap(); + // NB: This tests that the blanket "Serialize" impl doesn't produce a "null payload" field. + assert_eq!(serialized, r#"{"status":"success"}"#); + } +} diff --git a/crates/artcraftx/src/credentials/api_key_credential.rs b/crates/artcraftx/src/credentials/api_key_credential.rs new file mode 100644 index 00000000..cde2c77d --- /dev/null +++ b/crates/artcraftx/src/credentials/api_key_credential.rs @@ -0,0 +1,73 @@ +use chrono::{DateTime, Utc}; +use serde_derive::{Deserialize, Serialize}; + +/// How many leading characters of an API key are safe to show in the UI. +pub const PRINTABLE_PREFIX_LEN: usize = 5; + +/// An API key secret for a service. +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct ApiKeyCredential { + /// Full API key. + pub api_key: String, + + /// First few characters of the API key that we can show in the UI. + /// Recomputed from `api_key` on load, so hand-edited files can omit it + /// (and a stale value never survives a key change). + #[serde(default)] + pub printable_partial_prefix: String, + + /// Last time a request with this key failed (e.g. rejected as invalid). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub failed_at: Option>, + + /// Last time a request with this key succeeded. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub succeeded_at: Option>, +} + +impl ApiKeyCredential { + pub fn new(api_key: impl Into) -> Self { + let api_key = api_key.into(); + let printable_partial_prefix = printable_prefix(&api_key); + Self { + api_key, + printable_partial_prefix, + failed_at: None, + succeeded_at: None, + } + } + + /// Recompute the printable prefix from the full key. + pub fn normalize(&mut self) { + self.printable_partial_prefix = printable_prefix(&self.api_key); + } +} + +fn printable_prefix(api_key: &str) -> String { + api_key.chars().take(PRINTABLE_PREFIX_LEN).collect() +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn new_computes_printable_prefix() { + let credential = ApiKeyCredential::new("sk-abcdef123456"); + assert_eq!(credential.printable_partial_prefix, "sk-ab"); + } + + #[test] + fn short_keys_do_not_panic() { + let credential = ApiKeyCredential::new("abc"); + assert_eq!(credential.printable_partial_prefix, "abc"); + } + + #[test] + fn normalize_repairs_stale_prefix() { + let mut credential = ApiKeyCredential::new("sk-abcdef123456"); + credential.api_key = "sk-zzzzzz".to_string(); + credential.normalize(); + assert_eq!(credential.printable_partial_prefix, "sk-zz"); + } +} diff --git a/crates/artcraftx/src/credentials/auth_credential.rs b/crates/artcraftx/src/credentials/auth_credential.rs new file mode 100644 index 00000000..f6db6763 --- /dev/null +++ b/crates/artcraftx/src/credentials/auth_credential.rs @@ -0,0 +1,202 @@ +use crate::credentials::api_key_credential::ApiKeyCredential; +use crate::credentials::cookie_credential::CookieCredential; +use crate::credentials::credential_toml::CredentialToml; +use core_types::enums::generation_source::{CredentialKind, GenerationSource}; +use crate::credentials::credential_user_info::CredentialUserInfo; +use crate::error::artcraftx_credential_error::ArtcraftXCredentialError; +use chrono::Utc; +use std::path::{Path, PathBuf}; +use core_types::identifiers::credential_id::CredentialId; + +/// A validated, in-app credential. +/// +/// Unlike the on-disk [`CredentialToml`], an `AuthCredential` always carries +/// exactly one secret and remembers which file it was loaded from, so the +/// app can rewrite that file in place (refreshed cookies, success/failure +/// timestamps, etc.) +#[derive(Clone, Debug)] +pub struct AuthCredential { + /// The credential's stable identity (`credential_{entropy}`), stored in the + /// TOML file. Hidden from users, but the effective primary identifier — + /// file names can be freely renamed. + pub id: CredentialId, + pub service: GenerationSource, + /// Optional user-facing label to tell multiple credentials for the same + /// service apart. Empty by default. + pub name: Option, + pub secret: CredentialSecret, + pub user_info: Option, + /// The TOML file this credential was loaded from (and saves back to). + pub source_path: PathBuf, +} + +/// The secret payload of a credential. Mutually exclusive by construction. +#[derive(Clone, Debug)] +pub enum CredentialSecret { + Cookies(CookieCredential), + ApiKey(ApiKeyCredential), +} + +impl CredentialSecret { + pub fn kind(&self) -> CredentialKind { + match self { + Self::Cookies(_) => CredentialKind::Cookies, + Self::ApiKey(_) => CredentialKind::ApiKey, + } + } +} + +impl AuthCredential { + /// Load a credential, minting (and persisting) an id if the file lacks + /// one so the identity stays stable across loads. + pub fn load_from_file>(path: P) -> Result { + let path = path.as_ref(); + let file = CredentialToml::load(path)?; + let needs_id_backfill = file.id.is_none(); + let credential = file.into_auth_credential(path.to_path_buf())?; + if needs_id_backfill { + if let Err(err) = credential.save() { + log::warn!("Could not persist backfilled credential id for {:?}: {}", path, err); + } + } + Ok(credential) + } + + /// Rewrite this credential's TOML file in place. + pub fn save(&self) -> Result<(), ArtcraftXCredentialError> { + CredentialToml::from_auth_credential(self).save(&self.source_path) + } + + pub fn kind(&self) -> CredentialKind { + self.secret.kind() + } + + /// Whether the stored session is known-dead (see + /// [`CookieCredential::relogin_required_since`]). API-key credentials + /// never need a browser re-login. + pub fn needs_relogin(&self) -> bool { + self.cookies().is_some_and(CookieCredential::needs_relogin) + } + + /// Record that the provider rejected this credential's session and + /// persist it, so every later caller skips the API until the user logs in + /// again. Returns `Ok(true)` when the credential was newly marked (the + /// moment to tell the user), `Ok(false)` if it was already marked or isn't + /// a cookie credential. + pub fn mark_relogin_required(&mut self) -> Result { + let CredentialSecret::Cookies(cookie) = &mut self.secret else { + return Ok(false); + }; + let newly_marked = cookie.mark_relogin_required(Utc::now()); + self.save()?; + Ok(newly_marked) + } + + /// The credential's file name within the credentials directory + /// (e.g. `fal_api_2.toml`). Informational — the stable identifier is + /// [`AuthCredential::id`]; users can rename files freely. + pub fn file_name(&self) -> String { + self.source_path + .file_name() + .map(|name| name.to_string_lossy().to_string()) + .unwrap_or_default() + } + + pub fn cookies(&self) -> Option<&CookieCredential> { + match &self.secret { + CredentialSecret::Cookies(cookie) => Some(cookie), + CredentialSecret::ApiKey(_) => None, + } + } + + pub fn api_key(&self) -> Option<&ApiKeyCredential> { + match &self.secret { + CredentialSecret::ApiKey(api_key) => Some(api_key), + CredentialSecret::Cookies(_) => None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + // A cookie credential carrying Grok statsig data must round-trip: the + // `grok_data` table has to serialize before the `cookies` array-of-tables, or + // the TOML is invalid. + #[test] + fn cookie_credential_with_grok_data_round_trips() { + use crate::credentials::cookie_credential::CookieCredential; + use crate::credentials::cookie_credential_grok_extra_pieces::{CookieCredentialGrokExtraPieces, GrokStatsigCapture}; + use chrono::Utc; + use cookie_store_wrapper::cookie_store::CookieStore; + use grok_consumer_statsig::StatsigMaterial; + use reqwest::Url; + + let material = StatsigMaterial::from_seed_b64("7LKU1SbbPgGmlkhdNLb4ltpqrlenNVC2KnvBRD5ly/VV9ueQboie/eZABqiclvh1"); + let capture = GrokStatsigCapture { + material: material.clone(), + statsig_id: "XbHvyYh7hmNc+8sVAGnrpcuHN/MK+mgN63cmnBljOJaoCKu6zTPVw6C7HVv1wculKCNmYVum+L1h0IjFmtyZD/C53M+ZXg".to_string(), + method: "POST".to_string(), + path: "/rest/app-chat/conversations/new".to_string(), + captured_at: Utc::now(), + }; + + let mut cookies = CookieStore::empty(); + cookies.insert_named("sso", "token-value", &Url::parse("https://grok.com/").unwrap()); + + let now = Utc::now(); + let mut cookie = CookieCredential::new(cookies); + cookie.updated_at = Some(now); + cookie.grok_data = Some(CookieCredentialGrokExtraPieces::fresh(capture.clone(), now)); + + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("grok_cookies.toml"); + let credential = AuthCredential { + id: CredentialId::generate(), + service: GenerationSource::GrokCookies, + name: None, + secret: CredentialSecret::Cookies(cookie), + user_info: None, + source_path: path.clone(), + }; + credential.save().unwrap(); + + let loaded = AuthCredential::load_from_file(&path).unwrap(); + let loaded_grok = loaded.cookies().unwrap().grok_data.as_ref().unwrap(); + assert_eq!(loaded_grok.statsig_material.as_ref(), Some(&material)); + assert!(loaded_grok.statsig_fetched_at.is_some()); + assert!(loaded_grok.statsig_refresh_at.is_some()); + let latest = loaded_grok.latest_statsig.as_ref().expect("latest statsig persisted"); + assert_eq!(latest.statsig_id, capture.statsig_id); + assert_eq!(latest.method, "POST"); + assert_eq!(latest.path, "/rest/app-chat/conversations/new"); + assert_eq!(loaded_grok.latest_statsig_if_fresh(now), Some(capture.statsig_id.as_str())); + assert!(loaded.cookies().unwrap().cookies.has_cookie("sso")); + } + + #[test] + fn save_and_load_round_trip() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("fal_api_key.toml"); + + let credential = AuthCredential { + id: CredentialId::generate(), + service: GenerationSource::FalApi, + name: Some("work account".to_string()), + secret: CredentialSecret::ApiKey(ApiKeyCredential::new("fal-secret-key-12345")), + user_info: None, + source_path: path.clone(), + }; + credential.save().unwrap(); + + let loaded = AuthCredential::load_from_file(&path).unwrap(); + assert_eq!(loaded.id, credential.id); + assert_eq!(loaded.service, GenerationSource::FalApi); + assert_eq!(loaded.name.as_deref(), Some("work account")); + assert_eq!(loaded.api_key().unwrap().api_key, "fal-secret-key-12345"); + assert_eq!(loaded.api_key().unwrap().printable_partial_prefix, "fal-s"); + assert_eq!(loaded.source_path, path); + assert_eq!(loaded.file_name(), "fal_api_key.toml"); + } +} diff --git a/crates/artcraftx/src/credentials/cookie_credential.rs b/crates/artcraftx/src/credentials/cookie_credential.rs new file mode 100644 index 00000000..e21940de --- /dev/null +++ b/crates/artcraftx/src/credentials/cookie_credential.rs @@ -0,0 +1,123 @@ +use crate::credentials::cookie_credential_grok_extra_pieces::CookieCredentialGrokExtraPieces; +use chrono::{DateTime, Utc}; +use cookie_store_wrapper::cookie_store::CookieStore; +use serde_derive::{Deserialize, Serialize}; + +/// A browser-cookie secret for a website integration. +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct CookieCredential { + /// Last time the cookies were rewritten (e.g. refreshed by the app). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub updated_at: Option>, + + /// Last time a request with these cookies failed (e.g. session expired). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub failed_at: Option>, + + /// Last time a request with these cookies succeeded. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub succeeded_at: Option>, + + /// Set when the provider told us this session is dead (signed out, + /// expired, or revoked) and only a fresh browser login can fix it. While + /// set, the app makes no API calls with these cookies at all: generation + /// fails fast with a "log in again" message and background polling skips + /// the account. Cleared by a successful re-login (or pasting new cookies). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub relogin_required_since: Option>, + + /// The User-Agent of the browser that captured these cookies. Bot-protection + /// cookies (Cloudflare `cf_clearance`, DataDome `datadome`) are bound to + /// it, so HTTP clients replaying the cookies must present the same string. + /// Absent for hand-written files and captures from before this was + /// recorded; clients then fall back to their pinned per-site UA. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub user_agent: Option, + + /// Grok-only extras: the reusable statsig material and its refresh schedule. + /// NB: a table, so it must stay after all scalar fields (before `cookies`). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub grok_data: Option, + + /// The stored cookies with their RFC 6265 attributes. + /// NB: Serialized as an array of tables, so this field must stay LAST for + /// the TOML credential files to remain valid. + pub cookies: CookieStore, +} + +impl CookieCredential { + pub fn new(cookies: CookieStore) -> Self { + Self { + updated_at: None, + failed_at: None, + succeeded_at: None, + relogin_required_since: None, + user_agent: None, + grok_data: None, + cookies, + } + } + + /// Whether the session is known-dead and the user has to log in again + /// before these cookies are worth using. + pub fn needs_relogin(&self) -> bool { + self.relogin_required_since.is_some() + } + + /// Record that the provider rejected the session. Keeps the earliest + /// timestamp if already marked. Returns whether this call changed anything. + pub fn mark_relogin_required(&mut self, now: DateTime) -> bool { + self.failed_at = Some(now); + if self.relogin_required_since.is_some() { + return false; + } + self.relogin_required_since = Some(now); + true + } + + /// The stored cookies rendered as a `Cookie:` request-header string. + pub fn cookie_header(&self) -> String { + self.cookies.to_cookie_string() + } +} + +#[cfg(test)] +mod tests { + use super::*; + use reqwest::Url; + + fn credential() -> CookieCredential { + let origin = Url::parse("https://higgsfield.ai/").unwrap(); + CookieCredential::new(CookieStore::from_cookie_header("__client=abc", &origin)) + } + + #[test] + fn marking_sets_the_timestamp_once_and_reports_the_transition() { + let mut cookie = credential(); + assert!(!cookie.needs_relogin()); + + let first = Utc::now(); + assert!(cookie.mark_relogin_required(first), "first mark is a transition"); + assert!(cookie.needs_relogin()); + assert_eq!(cookie.relogin_required_since, Some(first)); + assert_eq!(cookie.failed_at, Some(first)); + + let later = first + chrono::Duration::minutes(5); + assert!(!cookie.mark_relogin_required(later), "already marked"); + assert_eq!(cookie.relogin_required_since, Some(first), "keeps the earliest mark"); + assert_eq!(cookie.failed_at, Some(later), "but records the latest failure"); + } + + #[test] + fn mark_round_trips_through_toml_and_is_absent_when_unset() { + let mut cookie = credential(); + let unmarked = toml::to_string(&cookie).unwrap(); + assert!(!unmarked.contains("relogin_required_since")); + + cookie.mark_relogin_required(Utc::now()); + let marked = toml::to_string(&cookie).unwrap(); + assert!(marked.contains("relogin_required_since")); + let back: CookieCredential = toml::from_str(&marked).unwrap(); + assert_eq!(back.relogin_required_since, cookie.relogin_required_since); + } +} diff --git a/crates/artcraftx/src/credentials/cookie_credential_grok_extra_pieces.rs b/crates/artcraftx/src/credentials/cookie_credential_grok_extra_pieces.rs new file mode 100644 index 00000000..b8bcf284 --- /dev/null +++ b/crates/artcraftx/src/credentials/cookie_credential_grok_extra_pieces.rs @@ -0,0 +1,188 @@ +use chrono::{DateTime, Utc}; +use grok_consumer_statsig::StatsigMaterial; +use serde_derive::{Deserialize, Serialize}; + +/// How long a captured statsig (and its material) is considered current before +/// the app should re-capture. Single source of truth for the login flow, the +/// preemptive refresher, and the generation workers. +pub const STATSIG_REFRESH_MINUTES: i64 = 30; + +/// Grok-specific extras stored alongside the cookies in a +/// [`CookieCredential`](crate::credentials::cookie_credential::CookieCredential). +/// +/// Holds two things captured from the user's own grok.com session: +/// +/// 1. The optional statsig *prerequisite* material (the seed a fresh +/// `x-statsig-id` could be minted from — see [`StatsigMaterial`]). +/// 2. The *latest* browser-minted `x-statsig-id` itself, with the request it +/// signed and when it was captured / expires. This is what generation +/// requests actually send (see [`Self::latest_statsig_if_fresh`]). +/// +/// NB: TOML field order matters — scalars first, then the nested tables. +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct CookieCredentialGrokExtraPieces { + /// When the statsig material was captured. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub statsig_fetched_at: Option>, + + /// When the statsig material should be re-captured + /// ([`STATSIG_REFRESH_MINUTES`] after fetch). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub statsig_refresh_at: Option>, + + /// The reusable statsig material (currently just the captured seed). + /// NB: a table, so it must stay after the scalar timestamp fields. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub statsig_material: Option, + + /// The latest browser-minted `x-statsig-id`, plus timing. + /// NB: a table, so it must stay after the scalar fields. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub latest_statsig: Option, +} + +/// A browser-minted `x-statsig-id` as captured from the page, with the request +/// it signed and its validity window. +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct LatestGrokStatsig { + /// The raw `x-statsig-id` header value. + pub statsig_id: String, + + /// HTTP method of the request the page signed (e.g. `POST`). + pub method: String, + + /// Path of the request the page signed (e.g. `/rest/app-chat/conversations/new`). + pub path: String, + + /// When the page minted it. + pub captured_at: DateTime, + + /// When it should no longer be sent ([`STATSIG_REFRESH_MINUTES`] after capture). + pub expires_at: DateTime, +} + +/// Everything one passive capture yields: the seed material and the signed +/// header it came from. Produced by the login / refresh webviews. +#[derive(Clone, Debug, Eq, PartialEq)] +pub struct GrokStatsigCapture { + pub material: StatsigMaterial, + pub statsig_id: String, + pub method: String, + pub path: String, + pub captured_at: DateTime, +} + +impl CookieCredentialGrokExtraPieces { + /// Stamp a fresh capture with fetch/expiry times [`STATSIG_REFRESH_MINUTES`] + /// into the future. + pub fn fresh(capture: GrokStatsigCapture, now: DateTime) -> Self { + let expires_at = now + chrono::Duration::minutes(STATSIG_REFRESH_MINUTES); + Self { + statsig_fetched_at: Some(now), + statsig_refresh_at: Some(expires_at), + statsig_material: Some(capture.material), + latest_statsig: Some(LatestGrokStatsig { + statsig_id: capture.statsig_id, + method: capture.method, + path: capture.path, + captured_at: capture.captured_at, + expires_at, + }), + } + } + + /// The latest captured `x-statsig-id`, if there is one and it hasn't expired. + pub fn latest_statsig_if_fresh(&self, now: DateTime) -> Option<&str> { + self.latest_statsig + .as_ref() + .filter(|latest| now < latest.expires_at) + .map(|latest| latest.statsig_id.as_str()) + } + + /// Whether the stored statsig is missing or past its refresh time, so it + /// should be re-captured. Both the material and the latest signed header must + /// be present and current. + pub fn is_stale(&self, now: DateTime) -> bool { + let material_stale = match (&self.statsig_material, self.statsig_refresh_at) { + (Some(_), Some(refresh_at)) => now >= refresh_at, + _ => true, // no material, or no refresh time recorded + }; + material_stale || self.latest_statsig_if_fresh(now).is_none() + } +} + +/// Whether a cookie credential's Grok statsig data is absent or stale and +/// should be re-captured. `None` (no `grok_data` at all) counts as stale. +pub fn grok_statsig_needs_refresh( + grok_data: Option<&CookieCredentialGrokExtraPieces>, + now: DateTime, +) -> bool { + grok_data.map_or(true, |data| data.is_stale(now)) +} + +#[cfg(test)] +mod tests { + use super::*; + + const STATSIG_ID: &str = "XbHvyYh7hmNc+8sVAGnrpcuHN/MK+mgN63cmnBljOJaoCKu6zTPVw6C7HVv1wculKCNmYVum+L1h0IjFmtyZD/C53M+ZXg"; + + fn capture(now: DateTime) -> GrokStatsigCapture { + GrokStatsigCapture { + material: StatsigMaterial::from_seed_b64("7LKU1SbbPgGmlkhdNLb4ltpqrlenNVC2KnvBRD5ly/VV9ueQboie/eZABqiclvh1"), + statsig_id: STATSIG_ID.to_string(), + method: "POST".to_string(), + path: "/rest/app-chat/conversations/new".to_string(), + captured_at: now, + } + } + + #[test] + fn missing_grok_data_is_stale() { + assert!(grok_statsig_needs_refresh(None, Utc::now())); + } + + #[test] + fn fresh_capture_is_not_stale_until_refresh_time() { + let now = Utc::now(); + let data = CookieCredentialGrokExtraPieces::fresh(capture(now), now); + assert!(!data.is_stale(now)); + assert!(!data.is_stale(now + chrono::Duration::minutes(STATSIG_REFRESH_MINUTES - 1))); + assert!(data.is_stale(now + chrono::Duration::minutes(STATSIG_REFRESH_MINUTES))); + } + + #[test] + fn latest_statsig_is_served_only_while_fresh() { + let now = Utc::now(); + let data = CookieCredentialGrokExtraPieces::fresh(capture(now), now); + assert_eq!(data.latest_statsig_if_fresh(now), Some(STATSIG_ID)); + assert_eq!( + data.latest_statsig_if_fresh(now + chrono::Duration::minutes(STATSIG_REFRESH_MINUTES)), + None, + ); + } + + #[test] + fn material_without_latest_statsig_is_stale() { + let now = Utc::now(); + let data = CookieCredentialGrokExtraPieces { + statsig_fetched_at: Some(now), + statsig_refresh_at: Some(now + chrono::Duration::minutes(STATSIG_REFRESH_MINUTES)), + statsig_material: Some(capture(now).material), + latest_statsig: None, + }; + assert!(data.is_stale(now)); + assert_eq!(data.latest_statsig_if_fresh(now), None); + } + + #[test] + fn material_without_refresh_time_is_stale() { + let now = Utc::now(); + let data = CookieCredentialGrokExtraPieces { + statsig_fetched_at: None, + statsig_refresh_at: None, + statsig_material: Some(capture(now).material), + latest_statsig: None, + }; + assert!(data.is_stale(now)); + } +} diff --git a/crates/artcraftx/src/credentials/credential_toml.rs b/crates/artcraftx/src/credentials/credential_toml.rs new file mode 100644 index 00000000..93f855bf --- /dev/null +++ b/crates/artcraftx/src/credentials/credential_toml.rs @@ -0,0 +1,287 @@ +use crate::credentials::api_key_credential::ApiKeyCredential; +use crate::credentials::cookie_credential::CookieCredential; +use crate::credentials::auth_credential::{AuthCredential, CredentialSecret}; +use core_types::enums::generation_source::GenerationSource; +use crate::credentials::credential_user_info::CredentialUserInfo; +use crate::error::artcraftx_credential_error::ArtcraftXCredentialError; +use serde_derive::{Deserialize, Serialize}; +use std::path::{Path, PathBuf}; +use core_types::identifiers::credential_id::CredentialId; + +/// The on-disk (TOML) shape of a credential file. +/// +/// This is the tolerant serialization layer: both secrets are optional so +/// that hand-written files always parse, and validation happens when +/// converting into the in-app [`AuthCredential`] type. +/// +/// Example file (`~/Artcraft/artcraftx/credentials/higgsfield.toml`): +/// +/// ```toml +/// id = "credential_01j9dq3v5x8k2m7n4p6r9t0wxy" +/// service = "higgsfield_cookies" +/// +/// [user_info] +/// username = "creator123" +/// +/// [[cookie.cookies]] +/// name = "session" +/// value = "abc123" +/// domain = "higgsfield.ai" +/// +/// [[cookie.cookies]] +/// name = "other" +/// value = "value" +/// domain = "higgsfield.ai" +/// ``` +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct CredentialToml { + /// The credential's stable identity. Absent in older or hand-written + /// files; loading backfills a freshly generated id. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub id: Option, + + pub service: GenerationSource, + + /// Optional user-facing label. Empty by default. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub name: Option, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub cookie: Option, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub api_key: Option, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub user_info: Option, +} + +impl CredentialToml { + pub fn load>(path: P) -> Result { + let path = path.as_ref(); + let contents = std::fs::read_to_string(path) + .map_err(|source| ArtcraftXCredentialError::FileReadError { + path: path.to_path_buf(), + source, + })?; + toml::from_str(&contents) + .map_err(|source| ArtcraftXCredentialError::TomlParseError { + path: path.to_path_buf(), + source, + }) + } + + pub fn save>(&self, path: P) -> Result<(), ArtcraftXCredentialError> { + let path = path.as_ref(); + let contents = toml::to_string_pretty(self) + .map_err(|source| ArtcraftXCredentialError::TomlSerializeError { source })?; + std::fs::write(path, contents) + .map_err(|source| ArtcraftXCredentialError::FileWriteError { + path: path.to_path_buf(), + source, + }) + } + + /// Validate and convert into the in-app credential type. + /// + /// Exactly one of `cookie` / `api_key` must be present, and it must match + /// the auth mechanism of `service`. + pub fn into_auth_credential(self, source_path: PathBuf) -> Result { + let secret = match (self.cookie, self.api_key) { + (Some(cookie), None) => CredentialSecret::Cookies(cookie), + (None, Some(mut api_key)) => { + api_key.normalize(); + CredentialSecret::ApiKey(api_key) + }, + (None, None) => { + return Err(ArtcraftXCredentialError::MissingSecret { path: source_path }); + }, + (Some(_), Some(_)) => { + return Err(ArtcraftXCredentialError::AmbiguousSecret { path: source_path }); + }, + }; + + if secret.kind() != self.service.kind() { + return Err(ArtcraftXCredentialError::SecretKindMismatch { + path: source_path, + service: self.service, + found: secret.kind(), + }); + } + + Ok(AuthCredential { + id: self.id.unwrap_or_else(CredentialId::generate), + service: self.service, + name: self.name, + secret, + user_info: self.user_info, + source_path, + }) + } + + pub fn from_auth_credential(credential: &AuthCredential) -> Self { + let (cookie, api_key) = match &credential.secret { + CredentialSecret::Cookies(cookie) => (Some(cookie.clone()), None), + CredentialSecret::ApiKey(api_key) => (None, Some(api_key.clone())), + }; + Self { + id: Some(credential.id.clone()), + service: credential.service, + name: credential.name.clone(), + cookie, + api_key, + user_info: credential.user_info.clone(), + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use core_types::enums::generation_source::CredentialKind; + + const HAND_WRITTEN_COOKIE_FILE: &str = r#" + service = "artcraft_cookies" + + [user_info] + username = "creator123" + email = "creator@example.com" + + [[cookie.cookies]] + name = "session" + value = "abc123" + domain = "storyteller.ai" + "#; + + const HAND_WRITTEN_API_KEY_FILE: &str = r#" + service = "fal_api" + + [api_key] + api_key = "fal-secret-key-12345" + "#; + + mod parsing_tests { + use super::*; + + #[test] + fn parses_hand_written_cookie_file() { + let file: CredentialToml = toml::from_str(HAND_WRITTEN_COOKIE_FILE).unwrap(); + assert_eq!(file.service, GenerationSource::ArtcraftCookies); + assert_eq!(file.cookie.unwrap().cookie_header(), "session=abc123"); + let user_info = file.user_info.unwrap(); + assert_eq!(user_info.username.as_deref(), Some("creator123")); + assert_eq!(user_info.email.as_deref(), Some("creator@example.com")); + } + + #[test] + fn parses_hand_written_api_key_file_without_prefix() { + let file: CredentialToml = toml::from_str(HAND_WRITTEN_API_KEY_FILE).unwrap(); + assert_eq!(file.service, GenerationSource::FalApi); + assert_eq!(file.api_key.unwrap().api_key, "fal-secret-key-12345"); + } + + #[test] + fn rejects_unknown_service() { + let result: Result = + toml::from_str("service = \"unknown_service\"\n[api_key]\napi_key = \"x\"\n"); + assert!(result.is_err()); + } + } + + mod validation_tests { + use super::*; + + #[test] + fn cookie_file_becomes_cookie_credential() { + let file: CredentialToml = toml::from_str(HAND_WRITTEN_COOKIE_FILE).unwrap(); + let credential = file.into_auth_credential(PathBuf::from("test.toml")).unwrap(); + assert_eq!(credential.kind(), CredentialKind::Cookies); + assert_eq!(credential.source_path, PathBuf::from("test.toml")); + } + + #[test] + fn api_key_prefix_is_computed_on_load() { + let file: CredentialToml = toml::from_str(HAND_WRITTEN_API_KEY_FILE).unwrap(); + let credential = file.into_auth_credential(PathBuf::from("test.toml")).unwrap(); + let CredentialSecret::ApiKey(api_key) = &credential.secret else { + panic!("expected api key secret"); + }; + assert_eq!(api_key.printable_partial_prefix, "fal-s"); + } + + #[test] + fn missing_secret_is_an_error() { + let file: CredentialToml = toml::from_str("service = \"fal_api\"").unwrap(); + let result = file.into_auth_credential(PathBuf::from("test.toml")); + assert!(matches!(result, Err(ArtcraftXCredentialError::MissingSecret { .. }))); + } + + #[test] + fn both_secrets_is_an_error() { + let toml_text = r#" + service = "fal_api" + [api_key] + api_key = "x" + [[cookie.cookies]] + name = "a" + value = "b" + domain = "example.com" + "#; + let file: CredentialToml = toml::from_str(toml_text).unwrap(); + let result = file.into_auth_credential(PathBuf::from("test.toml")); + assert!(matches!(result, Err(ArtcraftXCredentialError::AmbiguousSecret { .. }))); + } + + #[test] + fn secret_kind_must_match_service_kind() { + let toml_text = r#" + service = "fal_api" + [[cookie.cookies]] + name = "a" + value = "b" + domain = "example.com" + "#; + let file: CredentialToml = toml::from_str(toml_text).unwrap(); + let result = file.into_auth_credential(PathBuf::from("test.toml")); + assert!(matches!(result, Err(ArtcraftXCredentialError::SecretKindMismatch { .. }))); + } + } + + mod id_tests { + use super::*; + + #[test] + fn id_in_file_is_preserved() { + let toml_text = r#" + id = "credential_test123" + service = "fal_api" + [api_key] + api_key = "x" + "#; + let file: CredentialToml = toml::from_str(toml_text).unwrap(); + let credential = file.into_auth_credential(PathBuf::from("test.toml")).unwrap(); + assert_eq!(credential.id.as_str(), "credential_test123"); + } + + #[test] + fn missing_id_generates_one() { + let file: CredentialToml = toml::from_str(HAND_WRITTEN_API_KEY_FILE).unwrap(); + let credential = file.into_auth_credential(PathBuf::from("test.toml")).unwrap(); + assert!(credential.id.as_str().starts_with("credential_")); + } + } + + mod round_trip_tests { + use super::*; + + #[test] + fn credential_round_trips_through_toml() { + let file: CredentialToml = toml::from_str(HAND_WRITTEN_COOKIE_FILE).unwrap(); + let credential = file.into_auth_credential(PathBuf::from("test.toml")).unwrap(); + let rewritten = CredentialToml::from_auth_credential(&credential); + let toml_text = toml::to_string_pretty(&rewritten).unwrap(); + let reparsed: CredentialToml = toml::from_str(&toml_text).unwrap(); + assert_eq!(reparsed, rewritten); + } + } +} diff --git a/crates/artcraftx/src/credentials/credential_user_info.rs b/crates/artcraftx/src/credentials/credential_user_info.rs new file mode 100644 index 00000000..ecd7832d --- /dev/null +++ b/crates/artcraftx/src/credentials/credential_user_info.rs @@ -0,0 +1,12 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Optional identity metadata attached to a credential, so users can tell +/// multiple accounts for the same service apart. +#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize)] +pub struct CredentialUserInfo { + #[serde(default, skip_serializing_if = "Option::is_none")] + pub username: Option, + + #[serde(default, skip_serializing_if = "Option::is_none")] + pub email: Option, +} diff --git a/crates/artcraftx/src/credentials/find_service_credentials.rs b/crates/artcraftx/src/credentials/find_service_credentials.rs new file mode 100644 index 00000000..c7a775ec --- /dev/null +++ b/crates/artcraftx/src/credentials/find_service_credentials.rs @@ -0,0 +1,31 @@ +use log::warn; + +use crate::credentials::auth_credential::AuthCredential; +use core_types::enums::generation_source::GenerationSource; +use crate::state::data_dir::app_data_root::AppDataRoot; + +/// Find the first stored credential for a service, if any. +/// +/// Background threads use this to authenticate without a request-scoped +/// credential id (e.g. the FAL polling thread picking up the user's FAL +/// API key). +pub fn find_first_credential_for_service( + app_data_root: &AppDataRoot, + service: GenerationSource, +) -> Option { + let credentials = match app_data_root.credentials_dir().load_credentials() { + Ok(credentials) => credentials, + Err(err) => { + warn!("Could not load credentials for service {}: {}", service, err); + return None; + } + }; + + credentials.into_iter().find(|c| c.service == service) +} + +/// The first stored FAL API key, if any. +pub fn find_fal_api_key(app_data_root: &AppDataRoot) -> Option { + find_first_credential_for_service(app_data_root, GenerationSource::FalApi) + .and_then(|credential| credential.api_key().map(|key| key.api_key.clone())) +} diff --git a/crates/artcraftx/src/credentials/login_website.rs b/crates/artcraftx/src/credentials/login_website.rs new file mode 100644 index 00000000..62cd025d --- /dev/null +++ b/crates/artcraftx/src/credentials/login_website.rs @@ -0,0 +1,134 @@ +use core_types::enums::generation_source::GenerationSource; +use serde_derive::{Deserialize, Serialize}; +use std::fmt::{Display, Formatter}; + +/// A website we can drive a cookie-based web login for. +/// +/// The frontend passes one of these to the `open_web_login_command`; the +/// login window module then knows which URLs to visit and which +/// [`GenerationSource`] to save the resulting cookies under. +/// +/// The string values are serialized to/from the frontend. NEVER change an +/// existing value; only add new ones. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)] +pub enum LoginWebsite { + #[serde(rename = "artcraft")] + ArtCraft, + #[serde(rename = "openart")] + OpenArt, + #[serde(rename = "higgsfield")] + Higgsfield, + #[serde(rename = "runway")] + Runway, + #[serde(rename = "magnific")] + Magnific, + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "xai")] + XAi, +} + +impl LoginWebsite { + /// The credential service (and cookie file `service = "..."`) that a + /// successful login for this website is stored under. + pub fn credential_service(&self) -> GenerationSource { + match self { + Self::ArtCraft => GenerationSource::ArtcraftCookies, + Self::OpenArt => GenerationSource::OpenArtCookies, + Self::Higgsfield => GenerationSource::HiggsfieldCookies, + Self::Runway => GenerationSource::RunwayCookies, + Self::Magnific => GenerationSource::MagnificCookies, + Self::Midjourney => GenerationSource::MidjourneyCookies, + Self::XAi => GenerationSource::GrokCookies, + } + } + + /// The website to log into again to refresh a credential of this service, + /// if the app can drive that login. The inverse of + /// [`Self::credential_service`]. + pub fn for_credential_service(service: GenerationSource) -> Option { + match service { + GenerationSource::ArtcraftCookies => Some(Self::ArtCraft), + GenerationSource::OpenArtCookies => Some(Self::OpenArt), + GenerationSource::HiggsfieldCookies => Some(Self::Higgsfield), + GenerationSource::RunwayCookies => Some(Self::Runway), + GenerationSource::MagnificCookies => Some(Self::Magnific), + GenerationSource::MidjourneyCookies => Some(Self::Midjourney), + GenerationSource::GrokCookies => Some(Self::XAi), + _ => None, + } + } + + /// The generation provider impacted by this login, if any. Used to tell the + /// frontend which account state to refresh. `None` means "not tied to a + /// known generation provider" (refresh broadly). + pub fn generation_provider(&self) -> Option { + match self { + Self::ArtCraft => Some(GenerationSource::Artcraft), + Self::Midjourney => Some(GenerationSource::Midjourney), + Self::XAi => Some(GenerationSource::Grok), + Self::Higgsfield => Some(GenerationSource::Higgsfield), + Self::OpenArt | Self::Runway | Self::Magnific => None, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::ArtCraft => "artcraft", + Self::OpenArt => "openart", + Self::Higgsfield => "higgsfield", + Self::Runway => "runway", + Self::Magnific => "magnific", + Self::Midjourney => "midjourney", + Self::XAi => "xai", + } + } +} + +impl Display for LoginWebsite { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.to_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn serializes_to_stable_string() { + let json = serde_json::to_string(&LoginWebsite::ArtCraft).unwrap(); + assert_eq!(json, "\"artcraft\""); + let back: LoginWebsite = serde_json::from_str("\"higgsfield\"").unwrap(); + assert_eq!(back, LoginWebsite::Higgsfield); + } + + #[test] + fn credential_service_round_trips() { + for website in [LoginWebsite::ArtCraft, LoginWebsite::OpenArt, LoginWebsite::Higgsfield, LoginWebsite::Runway, LoginWebsite::Magnific, LoginWebsite::Midjourney, LoginWebsite::XAi] { + assert_eq!(LoginWebsite::for_credential_service(website.credential_service()), Some(website)); + } + assert_eq!(LoginWebsite::for_credential_service(GenerationSource::FalApi), None); + assert_eq!(LoginWebsite::for_credential_service(GenerationSource::Higgsfield), None, "bare provider, not a cookie service"); + } + + #[test] + fn maps_to_cookie_service_type() { + assert_eq!( + LoginWebsite::ArtCraft.credential_service(), + GenerationSource::ArtcraftCookies, + ); + assert_eq!( + LoginWebsite::OpenArt.credential_service(), + GenerationSource::OpenArtCookies, + ); + assert_eq!( + LoginWebsite::Higgsfield.credential_service(), + GenerationSource::HiggsfieldCookies, + ); + assert_eq!( + LoginWebsite::Midjourney.credential_service(), + GenerationSource::MidjourneyCookies, + ); + } +} diff --git a/crates/artcraftx/src/credentials/mod.rs b/crates/artcraftx/src/credentials/mod.rs new file mode 100644 index 00000000..9bda6b1e --- /dev/null +++ b/crates/artcraftx/src/credentials/mod.rs @@ -0,0 +1,26 @@ +//! Credential storage for third party services. +//! +//! Credentials live as individual TOML files in the app's credentials +//! directory (by default `~/Artcraft/artcraftx/credentials`). Users may +//! hand-write files there under any file name; the app periodically lists +//! and loads them all, and can rewrite managed files in place (e.g. to +//! refresh cookies or record success/failure timestamps). +//! +//! There are two layers: +//! +//! 1. [`credential_toml::CredentialToml`] — the tolerant serialization +//! layer (the on-disk TOML schema). Everything optional so hand-written +//! files parse. +//! 2. [`auth_credential::AuthCredential`] — the validated in-app layer the +//! app shuttles around to authenticate. Exactly one secret (cookie XOR +//! api key), tied back to its source file path. + +pub mod api_key_credential; +pub mod auth_credential; +pub mod cookie_credential; +pub mod cookie_credential_grok_extra_pieces; +pub mod credential_toml; +pub mod credential_user_info; +pub mod find_service_credentials; +pub mod login_website; +pub mod service_cookie_origin; diff --git a/crates/artcraftx/src/credentials/service_cookie_origin.rs b/crates/artcraftx/src/credentials/service_cookie_origin.rs new file mode 100644 index 00000000..591c3a41 --- /dev/null +++ b/crates/artcraftx/src/credentials/service_cookie_origin.rs @@ -0,0 +1,55 @@ +use core_types::enums::generation_source::GenerationSource; +use reqwest::Url; + +/// The canonical site origin that a cookie-kind service's cookies belong to. +/// +/// Used to attribute a domain when cookies arrive as a bare `Cookie:` header +/// string (hand-entered credentials, session strings from our own backend) +/// rather than from a browser capture that knows each cookie's real domain. +/// Returns `None` for API-key services, which have no cookies. +pub fn cookie_origin_for_service(service: GenerationSource) -> Option { + let origin = match service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies => "https://storyteller.ai/", + GenerationSource::Grok + | GenerationSource::GrokCookies => "https://grok.com/", + GenerationSource::Midjourney + | GenerationSource::MidjourneyCookies => "https://www.midjourney.com/", + GenerationSource::WorldLabs + | GenerationSource::WorldLabsCookies => "https://worldlabs.ai/", + GenerationSource::Higgsfield + | GenerationSource::HiggsfieldCookies => "https://higgsfield.ai/", + GenerationSource::MagnificCookies => "https://www.magnific.com/", + GenerationSource::OpenArtCookies => "https://openart.ai/", + GenerationSource::RunwayCookies => "https://app.runwayml.com/", + GenerationSource::ArtcraftApi + | GenerationSource::Fal + | GenerationSource::FalApi + | GenerationSource::OpenAiApi + | GenerationSource::ReplicateApi + | GenerationSource::XAiApi => return None, + }; + Some(Url::parse(origin).expect("static origin URL should parse")) +} + +#[cfg(test)] +mod tests { + use super::*; + use core_types::enums::generation_source::CredentialKind; + + #[test] + fn every_cookie_service_has_an_origin() { + for service in GenerationSource::all_variants() { + let origin = cookie_origin_for_service(service); + match service.kind() { + CredentialKind::Cookies => { + assert!(origin.is_some(), "cookie service {service} has no cookie origin"); + } + CredentialKind::ApiKey => { + assert!(origin.is_none(), "api-key service {service} should have no cookie origin"); + } + } + } + } +} diff --git a/crates/artcraftx/src/database/mod.rs b/crates/artcraftx/src/database/mod.rs new file mode 100644 index 00000000..ecf20795 --- /dev/null +++ b/crates/artcraftx/src/database/mod.rs @@ -0,0 +1 @@ +pub mod task_database_pending_statuses; diff --git a/crates/artcraftx/src/database/task_database_pending_statuses.rs b/crates/artcraftx/src/database/task_database_pending_statuses.rs new file mode 100644 index 00000000..4c8a0f0e --- /dev/null +++ b/crates/artcraftx/src/database/task_database_pending_statuses.rs @@ -0,0 +1,12 @@ +use sqlite_identifiers::enums::task_status::TaskStatus; +use once_cell::sync::Lazy; +use std::collections::HashSet; + +/// Reused predicate for querying pending SQLite tasks +pub static TASK_DATABASE_PENDING_STATUSES: Lazy> = Lazy::new(|| { + let mut statuses = HashSet::new(); + statuses.insert(TaskStatus::Pending); + statuses.insert(TaskStatus::Started); + statuses.insert(TaskStatus::AttemptFailed); + statuses +}); diff --git a/crates/artcraftx/src/error/artcraftx_credential_error.rs b/crates/artcraftx/src/error/artcraftx_credential_error.rs new file mode 100644 index 00000000..407dfeac --- /dev/null +++ b/crates/artcraftx/src/error/artcraftx_credential_error.rs @@ -0,0 +1,69 @@ +use core_types::enums::generation_source::{CredentialKind, GenerationSource}; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::path::PathBuf; + +/// Errors from loading and saving credential TOML files. +#[derive(Debug)] +pub enum ArtcraftXCredentialError { + // Filesystem errors + DirectoryReadError { path: PathBuf, source: std::io::Error }, + FileReadError { path: PathBuf, source: std::io::Error }, + FileWriteError { path: PathBuf, source: std::io::Error }, + FileDeleteError { path: PathBuf, source: std::io::Error }, + // File name errors (ids are file names within the credentials directory) + InvalidFileName { file_name: String }, + // Serialization errors + TomlParseError { path: PathBuf, source: toml::de::Error }, + TomlSerializeError { source: toml::ser::Error }, + // Validation errors + MissingSecret { path: PathBuf }, + AmbiguousSecret { path: PathBuf }, + SecretKindMismatch { path: PathBuf, service: GenerationSource, found: CredentialKind }, +} + +impl Error for ArtcraftXCredentialError {} + +impl Display for ArtcraftXCredentialError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::DirectoryReadError { path, source } => { + write!(f, "DirectoryReadError: {:?}: {:?}", path, source) + }, + Self::FileReadError { path, source } => { + write!(f, "FileReadError: {:?}: {:?}", path, source) + }, + Self::FileWriteError { path, source } => { + write!(f, "FileWriteError: {:?}: {:?}", path, source) + }, + Self::FileDeleteError { path, source } => { + write!(f, "FileDeleteError: {:?}: {:?}", path, source) + }, + Self::InvalidFileName { file_name } => { + write!(f, "InvalidFileName: {:?}", file_name) + }, + Self::TomlParseError { path, source } => { + write!(f, "TomlParseError: {:?}: {:?}", path, source) + }, + Self::TomlSerializeError { source } => { + write!(f, "TomlSerializeError: {:?}", source) + }, + Self::MissingSecret { path } => { + write!(f, "MissingSecret (neither cookie nor api_key present): {:?}", path) + }, + Self::AmbiguousSecret { path } => { + write!(f, "AmbiguousSecret (both cookie and api_key present): {:?}", path) + }, + Self::SecretKindMismatch { path, service, found } => { + write!( + f, + "SecretKindMismatch (service {:?} expects {:?}, found {:?}): {:?}", + service, + service.kind(), + found, + path, + ) + }, + } + } +} diff --git a/crates/artcraftx/src/error/artcraftx_error.rs b/crates/artcraftx/src/error/artcraftx_error.rs new file mode 100644 index 00000000..2df701df --- /dev/null +++ b/crates/artcraftx/src/error/artcraftx_error.rs @@ -0,0 +1,89 @@ +use crate::error::artcraftx_credential_error::ArtcraftXCredentialError; +use grok_consumer_client::error::grok_error::GrokError; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::path::PathBuf; +use artcraft_client::error::storyteller_error::StorytellerError; + +#[derive(Debug)] +pub enum ArtcraftXError { + AnyhowError(anyhow::Error), + CredentialError(ArtcraftXCredentialError), + DecodeError(base64::DecodeError), + IoError(std::io::Error), + ReqwestError(reqwest::Error), + // Service errors + GrokError(GrokError), + StorytellerError(StorytellerError), + // Lock errors + RwLockReadError, + RwLockWriteError, + MutexLockError, + // Download errors + BadDownloadFilename { path: PathBuf }, + CannotDownloadFilePathAlreadyExists { path: PathBuf }, +} + +impl Error for ArtcraftXError {} + +impl Display for ArtcraftXError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::AnyhowError(e) => write!(f, "AnyhowError: {:?}", e), + Self::CredentialError(e) => write!(f, "CredentialError: {}", e), + Self::DecodeError(e) => write!(f, "DecodeError: {:?}", e), + Self::IoError(e) => write!(f, "IoError: {:?}", e), + Self::ReqwestError(e) => write!(f, "ReqwestError: {:?}", e), + Self::GrokError(e) => write!(f, "GrokError: {:?}", e), + Self::StorytellerError(e) => write!(f, "StorytellerError: {:?}", e), + Self::RwLockReadError => write!(f, "RwLockReadError"), + Self::RwLockWriteError => write!(f, "RwLockWriteError"), + Self::MutexLockError => write!(f, "MutexLockError"), + Self::BadDownloadFilename { path } => write!(f, "BadDownloadFilename: {:?}", path), + Self::CannotDownloadFilePathAlreadyExists { path } => write!(f, "CannotDownloadFilePathAlreadyExists {:?}", path), + } + } +} + +impl From for ArtcraftXError { + fn from(value: anyhow::Error) -> Self { + Self::AnyhowError(value) + } +} + +impl From for ArtcraftXError { + fn from(value: ArtcraftXCredentialError) -> Self { + Self::CredentialError(value) + } +} + +impl From for ArtcraftXError { + fn from(value: base64::DecodeError) -> Self { + Self::DecodeError(value) + } +} + +impl From for ArtcraftXError { + fn from(value: std::io::Error) -> Self { + Self::IoError(value) + } +} + +impl From for ArtcraftXError { + fn from(value: reqwest::Error) -> Self { + Self::ReqwestError(value) + } +} + +impl From for ArtcraftXError { + fn from(value: GrokError) -> Self { + Self::GrokError(value) + } +} + +impl From for ArtcraftXError { + fn from(value: StorytellerError) -> Self { + Self::StorytellerError(value) + } +} + diff --git a/crates/artcraftx/src/error/mod.rs b/crates/artcraftx/src/error/mod.rs new file mode 100644 index 00000000..67f28895 --- /dev/null +++ b/crates/artcraftx/src/error/mod.rs @@ -0,0 +1,2 @@ +pub mod artcraftx_credential_error; +pub mod artcraftx_error; diff --git a/crates/artcraftx/src/events/basic_sendable_event_trait.rs b/crates/artcraftx/src/events/basic_sendable_event_trait.rs new file mode 100644 index 00000000..8568cb30 --- /dev/null +++ b/crates/artcraftx/src/events/basic_sendable_event_trait.rs @@ -0,0 +1,59 @@ +use crate::events::sendable_event_error::SendableEventError; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use log::{error, info}; +use serde::Serialize; +use std::fmt::Debug; +use tauri::{AppHandle, Emitter}; + +// Tagged enums here are waaay too "Rustic" +// #[derive(Clone, Serialize)] +// #[serde(rename_all = "camelCase", rename_all_fields = "camelCase", tag = "event", content = "data")] +// pub enum BasicEvent { +// Success(T), +// Failure(T), +// } + +#[derive(Copy, Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum BasicEventStatus { + Success, + Failure, +} + +/// Wrap the event with "status" and "data" fields. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +struct BasicEventWrapper { + status: BasicEventStatus, + data: T, +} + +pub trait BasicSendableEvent : Clone + Debug + Serialize { + /// This is the name of the event that the frontend subscribes to. + const FRONTEND_EVENT_NAME: TauriEventName; + + /// This is the status of the event: Success, Failure, etc. + const EVENT_STATUS: BasicEventStatus; + + /// Default implementation of send(). + /// This serializes and sends the event to the frontend. + fn send(&self, app: &AppHandle) -> Result<(), SendableEventError> { + let wrapped = BasicEventWrapper { + status: Self::EVENT_STATUS, + data: self.clone(), + }; + info!("Sending event to frontend: {} ; payload = {:?}", Self::FRONTEND_EVENT_NAME.to_str(), wrapped); + let result = app.emit(Self::FRONTEND_EVENT_NAME.to_str(), wrapped); + if let Err(err) = result { + return Err(SendableEventError::from(err)); + } + Ok(()) + } + + fn send_infallible(&self, app: &AppHandle) { + if let Err(err) = self.send(app) { + // Fail open + error!("Failed to send event `{}`: {:?}", Self::FRONTEND_EVENT_NAME.to_str(), err); + } + } +} diff --git a/crates/artcraftx/src/events/functional_events/app_preferences_changed_event.rs b/crates/artcraftx/src/events/functional_events/app_preferences_changed_event.rs new file mode 100644 index 00000000..026796c3 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/app_preferences_changed_event.rs @@ -0,0 +1,14 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +/// The app preferences were saved (by any command). Carries no payload; the +/// frontend should re-read them via `get_app_preferences_command`. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct AppPreferencesChangedEvent {} + +impl BasicSendableEvent for AppPreferencesChangedEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::AppPreferencesChangedEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/credits_balance_changed_event.rs b/crates/artcraftx/src/events/functional_events/credits_balance_changed_event.rs new file mode 100644 index 00000000..d05c5169 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/credits_balance_changed_event.rs @@ -0,0 +1,15 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct CreditsBalanceChangedEvent { + // NB: We don't know how much was added or removed, just that it changed. + // The frontend should re-query the balance +} + +impl BasicSendableEvent for CreditsBalanceChangedEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::CreditsBalanceChangedEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/gaussian_generation_complete_event.rs b/crates/artcraftx/src/events/functional_events/gaussian_generation_complete_event.rs new file mode 100644 index 00000000..5cb767bd --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/gaussian_generation_complete_event.rs @@ -0,0 +1,26 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use url::Url; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GaussianGenerationCompleteEvent { + pub generated_gaussians: Vec, + pub maybe_frontend_subscriber_id: Option, + pub maybe_frontend_subscriber_payload: Option, +} + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GeneratedGaussian { + pub media_token: MediaFileToken, + pub cdn_url: Url, + pub maybe_thumbnail_template: Option, +} + +impl BasicSendableEvent for GaussianGenerationCompleteEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::GaussianGenerationCompleteEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/local_thumbnail_ready_event.rs b/crates/artcraftx/src/events/functional_events/local_thumbnail_ready_event.rs new file mode 100644 index 00000000..6a83d8e8 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/local_thumbnail_ready_event.rs @@ -0,0 +1,21 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +/// The thumbnail worker finished a local file. Paths are absolute; render +/// them through Tauri's asset protocol (`convertFileSrc`). +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct LocalThumbnailReadyEvent { + /// The source file the thumbnail is for (keys the frontend's cache). + pub file_path: String, + /// Static jpg in the thumbnail cache. + pub thumbnail_path: String, + /// ~1s animated webp, videos only. + pub maybe_animated_preview_path: Option, +} + +impl BasicSendableEvent for LocalThumbnailReadyEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::LocalThumbnailReadyEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/mod.rs b/crates/artcraftx/src/events/functional_events/mod.rs new file mode 100644 index 00000000..d9a92946 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/mod.rs @@ -0,0 +1,11 @@ +pub mod app_preferences_changed_event; +pub mod credits_balance_changed_event; +pub mod gaussian_generation_complete_event; +pub mod local_thumbnail_ready_event; +pub mod object_generation_complete_event; +pub mod refresh_account_state_event; +pub mod show_credential_error_modal_event; +pub mod show_provider_billing_modal_event; +pub mod subscription_plan_changed_event; +pub mod text_to_image_generation_complete_event; +pub mod video_generation_complete_event; \ No newline at end of file diff --git a/crates/artcraftx/src/events/functional_events/object_generation_complete_event.rs b/crates/artcraftx/src/events/functional_events/object_generation_complete_event.rs new file mode 100644 index 00000000..75c7e9b8 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/object_generation_complete_event.rs @@ -0,0 +1,26 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use url::Url; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct ObjectGenerationCompleteEvent { + pub generated_objects: Vec, + pub maybe_frontend_subscriber_id: Option, + pub maybe_frontend_subscriber_payload: Option, +} + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GeneratedObject { + pub media_token: MediaFileToken, + pub cdn_url: Url, + pub maybe_thumbnail_template: Option, +} + +impl BasicSendableEvent for ObjectGenerationCompleteEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::ObjectGenerationCompleteEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/refresh_account_state_event.rs b/crates/artcraftx/src/events/functional_events/refresh_account_state_event.rs new file mode 100644 index 00000000..53f551ce --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/refresh_account_state_event.rs @@ -0,0 +1,19 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use core_types::enums::generation_source::GenerationSource; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +/// Send a signal to the frontend that an account state has changed: login, +/// logout, invalidated, etc. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct RefreshAccountStateEvent { + /// The frontend can optionally decide whether it wants to refresh based + /// on the impacted provider account. + pub provider: Option, +} + +impl BasicSendableEvent for RefreshAccountStateEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::RefreshAccountStateEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/show_credential_error_modal_event.rs b/crates/artcraftx/src/events/functional_events/show_credential_error_modal_event.rs new file mode 100644 index 00000000..94490550 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/show_credential_error_modal_event.rs @@ -0,0 +1,26 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use crate::credentials::login_website::LoginWebsite; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +/// Tell the frontend to show a dismissable modal explaining a credential +/// problem: the request named no credential, the credential id didn't match +/// anything on disk, or the credential can't be used for the request. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct ShowCredentialErrorModalEvent { + pub message: String, + /// When the fix is to log into a website again, which one — the frontend + /// shows a button that opens that login window. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_relogin_website: Option, + /// The credential the re-login should refresh in place (rather than + /// adding a second account for the same service). + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_credential_id: Option, +} + +impl BasicSendableEvent for ShowCredentialErrorModalEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::ShowCredentialErrorModalEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Failure; +} diff --git a/crates/artcraftx/src/events/functional_events/show_provider_billing_modal_event.rs b/crates/artcraftx/src/events/functional_events/show_provider_billing_modal_event.rs new file mode 100644 index 00000000..f085db82 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/show_provider_billing_modal_event.rs @@ -0,0 +1,25 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use core_types::enums::generation_source::GenerationSource; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use tauri::AppHandle; + +/// Send a signal to the frontend to show a modal that suggests fixing or setting up +/// service billing requirements. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct ShowProviderBillingModalEvent { + pub provider: GenerationSource, +} + +impl ShowProviderBillingModalEvent { + pub fn send_for_provider(provider: GenerationSource, app: &AppHandle) { + let event = Self { provider }; + event.send_infallible(&app); + } +} + +impl BasicSendableEvent for ShowProviderBillingModalEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::ShowProviderBillingModalEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Failure; +} diff --git a/crates/artcraftx/src/events/functional_events/subscription_plan_changed_event.rs b/crates/artcraftx/src/events/functional_events/subscription_plan_changed_event.rs new file mode 100644 index 00000000..bf07d113 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/subscription_plan_changed_event.rs @@ -0,0 +1,16 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct SubscriptionPlanChangedEvent { + // NB: We don't know what plan was changed (subscribed, upgraded, canceled, etc.), + // just that it changed. The actual fulfillment is async anyway. + // The frontend should re-query the subscription plan after a short delay. +} + +impl BasicSendableEvent for SubscriptionPlanChangedEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::SubscriptionPlanChangedEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/text_to_image_generation_complete_event.rs b/crates/artcraftx/src/events/functional_events/text_to_image_generation_complete_event.rs new file mode 100644 index 00000000..920ce9ce --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/text_to_image_generation_complete_event.rs @@ -0,0 +1,26 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use url::Url; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct TextToImageGenerationCompleteEvent { + pub generated_images: Vec, + pub maybe_frontend_subscriber_id: Option, + pub maybe_frontend_subscriber_payload: Option, +} + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GeneratedImage { + pub media_token: MediaFileToken, + pub cdn_url: Url, + pub maybe_thumbnail_template: Option, +} + +impl BasicSendableEvent for TextToImageGenerationCompleteEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::TextToImageGenerationCompleteEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/functional_events/video_generation_complete_event.rs b/crates/artcraftx/src/events/functional_events/video_generation_complete_event.rs new file mode 100644 index 00000000..933eaba7 --- /dev/null +++ b/crates/artcraftx/src/events/functional_events/video_generation_complete_event.rs @@ -0,0 +1,26 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use url::Url; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct VideoGenerationCompleteEvent { + pub generated_videos: Vec, + pub maybe_frontend_subscriber_id: Option, + pub maybe_frontend_subscriber_payload: Option, +} + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GeneratedVideo { + pub media_token: MediaFileToken, + pub cdn_url: Url, + pub maybe_thumbnail_template: Option, +} + +impl BasicSendableEvent for VideoGenerationCompleteEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::VideoGenerationCompleteEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/generation_events/common.rs b/crates/artcraftx/src/events/generation_events/common.rs new file mode 100644 index 00000000..b8c19455 --- /dev/null +++ b/crates/artcraftx/src/events/generation_events/common.rs @@ -0,0 +1,201 @@ +use serde::Serialize; + +#[derive(Debug, Copy, Clone, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerationServiceProvider { + Artcraft, + Fal, + Grok, + Higgsfield, + Midjourney, + WorldLabs, +} + +#[derive(Debug, Copy, Clone, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerationModel { + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_dev_juggernaut")] + FluxDevJuggernaut, + #[serde(rename = "flux_pro_1")] + FluxPro1, + #[serde(rename = "flux_pro_1.1")] + FluxPro11, + #[serde(rename = "flux_pro_1.1_ultra")] + FluxPro11Ultra, + + #[serde(rename = "flux_pro_kontext_max")] + FluxProKontextMax, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + #[serde(rename = "grok_image")] + GrokImage, + #[serde(rename = "gemini_25_flash")] + Gemini25Flash, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + #[serde(rename = "nano_banana_2_lite")] + NanoBanana2Lite, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, + + #[serde(rename = "hunyuan_3d_2_0")] + Hunyuan3d2_0, + #[serde(rename = "hunyuan_3d_2_1")] + Hunyuan3d2_1, + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + #[serde(rename = "hunyuan_3d_3_sketch")] + Hunyuan3d3Sketch, + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3p1Pro, + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3p1Rapid, + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3p1Part, + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3p1SmartTopology, + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3p1, + #[serde(rename = "meshy_v6")] + MeshyV6, + #[serde(rename = "rodin_2p5_fast")] + Rodin2p5Fast, + + #[serde(rename = "worldlabs_marble")] + WorldlabsMarble, + #[serde(rename = "worldlabs_marble_0p1_mini")] + WorldlabsMarble0p1Mini, + #[serde(rename = "worldlabs_marble_0p1_plus")] + WorldlabsMarble0p1Plus, + #[serde(rename = "marble_1p0")] + Marble1p0, + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + #[serde(rename = "marble_1p1")] + Marble1p1, + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + #[serde(rename = "triposplat")] + TripoSplat, + + // Audio generation models + #[serde(rename = "suno_music")] + SunoMusic, + #[serde(rename = "suno_remix")] + SunoRemix, + #[serde(rename = "suno_sounds")] + SunoSounds, + #[serde(rename = "suno_sample")] + SunoSample, + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, + + // Generic Midjourney model, version unknown. + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "midjourney_7")] + Midjourney7, + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + #[serde(rename = "midjourney_8")] + Midjourney8, + + // Generic Grok video model, version unknown. + #[serde(rename = "grok_video")] + GrokVideo, + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + // TODO: Should be Kling16Pro + #[serde(rename = "kling_1.6")] + Kling1_6, + #[serde(rename = "kling_2.0")] + Kling2_0, + #[serde(rename = "kling_2.1_master")] + Kling21Master, + #[serde(rename = "kling_2.1_pro")] + Kling21Pro, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + #[serde(rename = "recraft_3")] + Recraft3, + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + #[serde(rename = "seedance_1.0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + #[serde(rename = "seedance_2p0")] + Seedance2p0, + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + #[serde(rename = "seedance_2p5")] + Seedance2p5, + #[serde(rename = "seedance_2p5_edit")] + Seedance2p5Edit, + #[serde(rename = "minimax_h3")] + MinimaxH3, + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + #[serde(rename = "vidu_q3")] + ViduQ3, + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, +} + +#[derive(Debug, Copy, Clone, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerationAction { + GenerateImage, + GenerateVideo, + GenerateAudio, + #[serde(rename = "image_to_3d")] + ImageTo3d, + GenerateGaussian, +} diff --git a/crates/artcraftx/src/events/generation_events/generation_complete_event.rs b/crates/artcraftx/src/events/generation_events/generation_complete_event.rs new file mode 100644 index 00000000..f3cb36b0 --- /dev/null +++ b/crates/artcraftx/src/events/generation_events/generation_complete_event.rs @@ -0,0 +1,17 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use crate::events::generation_events::common::{GenerationAction, GenerationModel, GenerationServiceProvider}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GenerationCompleteEvent { + pub action: Option, + pub service: GenerationServiceProvider, + pub model: Option, +} + +impl BasicSendableEvent for GenerationCompleteEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::GenerationCompleteEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/generation_events/generation_enqueue_failure_event.rs b/crates/artcraftx/src/events/generation_events/generation_enqueue_failure_event.rs new file mode 100644 index 00000000..20b646e1 --- /dev/null +++ b/crates/artcraftx/src/events/generation_events/generation_enqueue_failure_event.rs @@ -0,0 +1,40 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use crate::events::generation_events::common::{GenerationAction, GenerationModel, GenerationServiceProvider}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GenerationEnqueueFailureEvent { + pub action: GenerationAction, + pub service: GenerationServiceProvider, + pub model: Option, + + /// User-facing reason for the failure, if available. + pub reason: Option, +} + +impl BasicSendableEvent for GenerationEnqueueFailureEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::GenerationEnqueueFailureEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Failure; +} + +impl GenerationEnqueueFailureEvent { + pub fn no_artcraft_credentials(action: GenerationAction) -> Self { + Self { + action, + service: GenerationServiceProvider::Artcraft, + model: None, + reason: Some("Please log into Artcraft.".to_string()), + } + } + + pub fn no_fal_api_key(action: GenerationAction) -> Self { + Self { + action, + service: GenerationServiceProvider::Fal, + model: None, + reason: Some("No FAL API key is set. Configure this in your settings.".to_string()), + } + } +} diff --git a/crates/artcraftx/src/events/generation_events/generation_enqueue_success_event.rs b/crates/artcraftx/src/events/generation_events/generation_enqueue_success_event.rs new file mode 100644 index 00000000..2c022628 --- /dev/null +++ b/crates/artcraftx/src/events/generation_events/generation_enqueue_success_event.rs @@ -0,0 +1,17 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use crate::events::generation_events::common::{GenerationAction, GenerationModel, GenerationServiceProvider}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GenerationEnqueueSuccessEvent { + pub action: GenerationAction, + pub service: GenerationServiceProvider, + pub model: Option, +} + +impl BasicSendableEvent for GenerationEnqueueSuccessEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::GenerationEnqueueSuccessEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/generation_events/generation_failed_event.rs b/crates/artcraftx/src/events/generation_events/generation_failed_event.rs new file mode 100644 index 00000000..266bc476 --- /dev/null +++ b/crates/artcraftx/src/events/generation_events/generation_failed_event.rs @@ -0,0 +1,20 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use crate::events::generation_events::common::{GenerationAction, GenerationModel, GenerationServiceProvider}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct GenerationFailedEvent { + pub action: GenerationAction, + pub service: GenerationServiceProvider, + pub model: Option, + + /// User-facing reason for the failure, if available. + pub reason: Option, +} + +impl BasicSendableEvent for GenerationFailedEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::GenerationFailedEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Failure; +} diff --git a/crates/artcraftx/src/events/generation_events/mod.rs b/crates/artcraftx/src/events/generation_events/mod.rs new file mode 100644 index 00000000..67ff3ba2 --- /dev/null +++ b/crates/artcraftx/src/events/generation_events/mod.rs @@ -0,0 +1,5 @@ +pub mod common; +pub mod generation_enqueue_failure_event; +pub mod generation_enqueue_success_event; +pub mod generation_complete_event; +pub mod generation_failed_event; \ No newline at end of file diff --git a/crates/artcraftx/src/events/mod.rs b/crates/artcraftx/src/events/mod.rs new file mode 100644 index 00000000..fb3ca014 --- /dev/null +++ b/crates/artcraftx/src/events/mod.rs @@ -0,0 +1,7 @@ +pub mod basic_sendable_event_trait; +pub mod functional_events; +pub mod generation_events; +pub mod notice_events; +pub mod sendable_event_error; +pub mod sendable_event_trait; +pub mod warning_events; \ No newline at end of file diff --git a/crates/artcraftx/src/events/notice_events/flash_notice_event.rs b/crates/artcraftx/src/events/notice_events/flash_notice_event.rs new file mode 100644 index 00000000..a89fcc22 --- /dev/null +++ b/crates/artcraftx/src/events/notice_events/flash_notice_event.rs @@ -0,0 +1,24 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +/// Flash an informational (non-error) message in the frontend — a "notice" +/// toast, e.g. "Your library was refreshed". Purely informational: nothing +/// failed and nothing is required of the user. For a step the user has to +/// wait on, use `ProgressNotice` instead. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct FlashNoticeEvent { + pub message: String, +} + +impl FlashNoticeEvent { + pub fn new(message: impl Into) -> Self { + Self { message: message.into() } + } +} + +impl BasicSendableEvent for FlashNoticeEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::FlashNoticeEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} diff --git a/crates/artcraftx/src/events/notice_events/mod.rs b/crates/artcraftx/src/events/notice_events/mod.rs new file mode 100644 index 00000000..9f815076 --- /dev/null +++ b/crates/artcraftx/src/events/notice_events/mod.rs @@ -0,0 +1,2 @@ +pub mod flash_notice_event; +pub mod progress_notice_event; diff --git a/crates/artcraftx/src/events/notice_events/progress_notice_event.rs b/crates/artcraftx/src/events/notice_events/progress_notice_event.rs new file mode 100644 index 00000000..bd3cb5e4 --- /dev/null +++ b/crates/artcraftx/src/events/notice_events/progress_notice_event.rs @@ -0,0 +1,69 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use tauri::AppHandle; +use uuid_utils::uuid::generate_random_uuid; + +/// A long-running backend step the user has to wait on, e.g. Higgsfield's +/// IP/likeness check on uploaded media (routinely 15-30s). Send `started` +/// before the step and `finished` after it; the frontend keeps a progress +/// toast up in between. Prefer the [`ProgressNotice`] guard over sending +/// these by hand so the `finished` half can't be forgotten on error paths. +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct ProgressNoticeEvent { + /// Ties `finished` to its `started`; unique per step so concurrent steps + /// get their own toasts. + pub notice_id: String, + pub state: ProgressNoticeState, + /// What the user is waiting on. Only set on `started`. + pub maybe_message: Option, +} + +#[derive(Copy, Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum ProgressNoticeState { + Started, + Finished, +} + +impl BasicSendableEvent for ProgressNoticeEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::ProgressNoticeEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Success; +} + +/// RAII handle for a [`ProgressNoticeEvent`] pair: sends `started` on +/// creation and `finished` when dropped, so holding it across an `.await` +/// scopes the toast to that work — including early returns and `?` errors. +/// +/// ```ignore +/// let _notice = ProgressNotice::start(app, "Higgsfield is checking your media"); +/// upload_and_enqueue().await?; // toast comes down however this ends +/// ``` +#[must_use = "dropping the notice immediately ends it; bind it to a variable"] +pub struct ProgressNotice { + app: AppHandle, + notice_id: String, +} + +impl ProgressNotice { + pub fn start(app: &AppHandle, message: impl Into) -> Self { + let notice_id = generate_random_uuid(); + ProgressNoticeEvent { + notice_id: notice_id.clone(), + state: ProgressNoticeState::Started, + maybe_message: Some(message.into()), + }.send_infallible(app); + Self { app: app.clone(), notice_id } + } +} + +impl Drop for ProgressNotice { + fn drop(&mut self) { + ProgressNoticeEvent { + notice_id: self.notice_id.clone(), + state: ProgressNoticeState::Finished, + maybe_message: None, + }.send_infallible(&self.app); + } +} diff --git a/crates/artcraftx/src/events/sendable_event_error.rs b/crates/artcraftx/src/events/sendable_event_error.rs new file mode 100644 index 00000000..25d4a574 --- /dev/null +++ b/crates/artcraftx/src/events/sendable_event_error.rs @@ -0,0 +1,31 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum SendableEventError { + TauriError(tauri::Error), + AnyhowError(anyhow::Error), +} + +impl Error for SendableEventError {} + +impl Display for SendableEventError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::TauriError(err) => write!(f, "SendableEventError::TauriError: {}", err), + Self::AnyhowError(err) => write!(f, "SendableEventError::AnyhowError: {}", err), + } + } +} + +impl From for SendableEventError { + fn from(err: anyhow::Error) -> Self { + SendableEventError::AnyhowError(err) + } +} + +impl From for SendableEventError { + fn from(err: tauri::Error) -> Self { + SendableEventError::TauriError(err) + } +} diff --git a/crates/artcraftx/src/events/sendable_event_trait.rs b/crates/artcraftx/src/events/sendable_event_trait.rs new file mode 100644 index 00000000..f2a25307 --- /dev/null +++ b/crates/artcraftx/src/events/sendable_event_trait.rs @@ -0,0 +1,23 @@ +use crate::events::sendable_event_error::SendableEventError; +use log::info; +use serde::Serialize; +use tauri::{AppHandle, Emitter}; + +/// Implement this on a Serializable object to be able to send it as an event to the frontend. +#[deprecated(note = "Use BasicSendableEvent instead as it wraps the event with status and data fields.")] +pub trait SendableEvent : Serialize { + /// This is the name of the event that the frontend subscribes to. + const FRONTEND_EVENT_NAME: &'static str; + + /// Default implementation of send(). + /// This serializes and sends the event to the frontend. + #[deprecated(note = "Use BasicSendableEvent instead as it wraps the event with status and data fields.")] + fn send(&self, app: &AppHandle) -> Result<(), SendableEventError> { + info!("Sending event to frontend: {}", Self::FRONTEND_EVENT_NAME); + let result = app.emit(Self::FRONTEND_EVENT_NAME, self); + if let Err(err) = result { + return Err(SendableEventError::from(err)); + } + Ok(()) + } +} diff --git a/crates/artcraftx/src/events/warning_events/flash_file_download_error_event.rs b/crates/artcraftx/src/events/warning_events/flash_file_download_error_event.rs new file mode 100644 index 00000000..c5a2280b --- /dev/null +++ b/crates/artcraftx/src/events/warning_events/flash_file_download_error_event.rs @@ -0,0 +1,26 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; +use std::path::PathBuf; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct FlashFileDownloadErrorEvent { + pub error_type: FlashFileDownloadErrorType, + pub filename: Option, + pub message: Option, +} + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum FlashFileDownloadErrorType { + FileAlreadyDownloaded, + FilesystemError, + NetworkError, + UnknownError, +} + +impl BasicSendableEvent for FlashFileDownloadErrorEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::FlashFileDownloadErrorEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Failure; +} diff --git a/crates/artcraftx/src/events/warning_events/flash_user_input_error_event.rs b/crates/artcraftx/src/events/warning_events/flash_user_input_error_event.rs new file mode 100644 index 00000000..fd140692 --- /dev/null +++ b/crates/artcraftx/src/events/warning_events/flash_user_input_error_event.rs @@ -0,0 +1,14 @@ +use crate::events::basic_sendable_event_trait::{BasicEventStatus, BasicSendableEvent}; +use artcraft_client::enums::tauri::ux::tauri_event_name::TauriEventName; +use serde_derive::Serialize; + +#[derive(Clone, Debug, Serialize)] +#[serde(rename_all = "snake_case")] +pub struct FlashUserInputErrorEvent { + pub message: String, +} + +impl BasicSendableEvent for FlashUserInputErrorEvent { + const FRONTEND_EVENT_NAME: TauriEventName = TauriEventName::FlashUserInputErrorEvent; + const EVENT_STATUS: BasicEventStatus = BasicEventStatus::Failure; +} diff --git a/crates/artcraftx/src/events/warning_events/mod.rs b/crates/artcraftx/src/events/warning_events/mod.rs new file mode 100644 index 00000000..cf70efec --- /dev/null +++ b/crates/artcraftx/src/events/warning_events/mod.rs @@ -0,0 +1,2 @@ +pub mod flash_file_download_error_event; +pub mod flash_user_input_error_event; diff --git a/crates/artcraftx/src/lib.rs b/crates/artcraftx/src/lib.rs new file mode 100644 index 00000000..5cfcb77e --- /dev/null +++ b/crates/artcraftx/src/lib.rs @@ -0,0 +1,229 @@ +pub mod commands; +pub mod credentials; +pub mod database; +pub mod error; +pub mod events; +pub mod lifecycle; +pub mod services; +pub mod state; +pub mod threads; +pub mod utils; +pub mod version; +pub mod windows; + +use tauri::Manager; + +use crate::commands::credentials::add_api_credential_command::add_api_credential_command; +use crate::commands::credentials::add_web_credential_command::add_web_credential_command; +use crate::commands::credentials::artcraft_login_command::artcraft_login_command; +use crate::commands::credentials::delete_credentials_command::delete_credentials_command; +use crate::commands::credentials::edit_api_credential_command::edit_api_credential_command; +use crate::commands::credentials::edit_web_credential_command::edit_web_credential_command; +use crate::commands::credentials::list_credentials_command::list_credentials_command; +use crate::commands::credentials::open_web_login_command::open_web_login_command; +use crate::commands::credentials::refresh_grok_statsig_command::refresh_grok_statsig_command; +use crate::commands::service::app_preferences::get_app_preferences_command::get_app_preferences_command; +use crate::commands::service::promptbox::get_promptbox_state_command::get_promptbox_state_command; +use crate::commands::service::promptbox::update_promptbox_state_command::update_promptbox_state_command; +use crate::commands::service::app_preferences::load_custom_sound_command::load_custom_sound_command; +use crate::commands::service::app_preferences::update_app_preference_command::update_app_preferences_command; +use crate::commands::service::app_preferences::update_backup_preference_command::update_backup_preference_command; +use crate::commands::service::app_preferences::update_prompt_preference_command::update_prompt_preference_command; +use crate::commands::service::app_preferences::update_sound_preference_command::update_sound_preference_command; +use crate::commands::cost_estimate::estimate_audio_cost_command::estimate_audio_cost_command; +use crate::commands::cost_estimate::estimate_image_cost_command::estimate_image_cost_command; +use crate::commands::cost_estimate::estimate_mesh_cost_command::estimate_mesh_cost_command; +use crate::commands::cost_estimate::estimate_splat_cost_command::estimate_splat_cost_command; +use crate::commands::cost_estimate::estimate_video_cost_command::estimate_video_cost_command; +use crate::commands::generate::models::audio::list_audio_models_command::list_audio_models_command; +use crate::commands::generate::models::image::list_image_models_command::list_image_models_command; +use crate::commands::generate::models::mesh::list_mesh_models_command::list_mesh_models_command; +use crate::commands::generate::models::splat::list_splat_models_command::list_splat_models_command; +use crate::commands::generate::models::video::list_video_models_command::list_video_models_command; +use crate::commands::download::download_directory_reveal_command::download_directory_reveal_command; +use crate::commands::download::download_media_file_command::download_media_file_command; +use crate::commands::download::download_url_command::download_url_command; +use crate::commands::download::open_local_file_command::open_local_file_command; +use crate::commands::generate::generate_audio::generate_audio_command::generate_audio_command; +use crate::commands::generate::generate_image::generate_image_command::generate_image_command; +use crate::commands::generate::generate_mesh::generate_mesh_command::generate_mesh_command; +use crate::commands::generate::generate_splat::generate_splat_command::generate_splat_command; +use crate::commands::generate::generate_video::generate_video_command::generate_video_command; +use crate::commands::service::get_app_info_command::get_app_info_command; +use crate::commands::service::load_without_cors_command::load_without_cors_command; +use crate::commands::service::platform_info_command::platform_info_command; +use crate::commands::local_files::get_local_thumbnails_command::get_local_thumbnails_command; +use crate::commands::task_queue::get_task_queue_command::get_task_queue_command; +use crate::commands::task_queue::mark_task_as_dismissed_command::mark_task_as_dismissed_command; +use crate::commands::task_queue::tasks_nuke_all_command::tasks_nuke_all_command; +use crate::lifecycle::startup::handle_tauri_startup::handle_tauri_startup; +use crate::lifecycle::startup::setup_main_window::setup_main_window; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::promptbox::promptbox_state_manager::PromptboxStateManager; +use crate::state::runtime::artcraft_platform_info::ArtcraftPlatformInfo; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use crate::services::grok::state::grok_websockets::GrokWebsockets; +use crate::services::midjourney::state::midjourney_credential_manager::MidjourneyCredentialManager; +use crate::services::midjourney::state::midjourney_live_session::MidjourneyLiveSession; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use log::error; + +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use tauri_plugin_dialog; +use tauri_plugin_http; + +#[cfg_attr(mobile, tauri::mobile_entry_point)] +pub fn run() { + // NB: Tauri wants to install the logger itself, so we can't rely on the logger crate + // until the tauri runtime begins. + println!("Loading config..."); + let app_data_root = AppDataRoot::create_default().expect("data directory should be created"); + let app_data_root_2 = app_data_root.clone(); + + println!("Getting platform info..."); + let artcraft_platform_info = ArtcraftPlatformInfo::get(); + let artcraft_platform_info_2 = artcraft_platform_info.clone(); + + println!("Platform info: {:?}", artcraft_platform_info); + + println!("Loading app preferences..."); + let app_preferences = AppPreferencesManager::load_or_default(&app_data_root); + let promptbox_state = PromptboxStateManager::load_or_default(&app_data_root); + let app_preferences_2 = app_preferences.clone(); + + + // NB: tauri-plugin-http stores the credentials on disk, so we can defer to that for now. + // println!("Attempting to read existing artcraft credentials..."); + // let storyteller_creds_manager = StorytellerCredentialManager::initialize_from_disk_infallible(&app_data_root); + let storyteller_creds_manager = StorytellerCredentialManager::initialize_empty(&app_data_root); + let storyteller_creds_manager_2 = storyteller_creds_manager.clone(); + let storyteller_creds_manager_3 = storyteller_creds_manager.clone(); + + let midjourney_creds_manager = MidjourneyCredentialManager::initialize_from_disk_infallible(&app_data_root); + + // In-memory, process-lifetime Midjourney session (user_id, websocket token, + // live websocket handle). Shared between the enqueue command and the + // completion threads. + let midjourney_live_session = MidjourneyLiveSession::new(); + let midjourney_live_session_2 = midjourney_live_session.clone(); + + let grok_creds_manager = GrokCredentialManager::initialize_from_disk_infallible(&app_data_root); + let grok_creds_manager_2 = grok_creds_manager.clone(); + + // One live Grok imagine websocket per account, shared by the enqueue command + // and the third-party task polling thread. + let grok_websockets = GrokWebsockets::new(); + let grok_websockets_2 = grok_websockets.clone(); + + let artcraft_usage_tracker = ArtcraftUsageTracker::new(); + let artcraft_usage_tracker_2 = artcraft_usage_tracker.clone(); + + println!("Initializing backend runtime..."); + + let builder = tauri::Builder::default() + .plugin(tauri_plugin_dialog::init()) + .plugin(tauri_plugin_http::init()) + .plugin(tauri_plugin_opener::init()) + .plugin(tauri_plugin_upload::init()) + .setup(move |app| { + // TODO(bt): This is broken on windows + // log_environment_details(); + + //if cfg!(debug_assertions) { + // app.handle().plugin( + // tauri_plugin_log::Builder::default() + // .level(log::LevelFilter::Info) + // .build(), + // )?; + //} + let app = app.handle().clone(); + let handle = app.clone(); + let root = app_data_root_2.clone(); + let storyteller_creds = storyteller_creds_manager_2.clone(); + + tauri::async_runtime::block_on(async move { + let _result = setup_main_window(&app).await; + + let result = handle_tauri_startup( + handle, + root, + app_preferences_2, + artcraft_platform_info_2, + artcraft_usage_tracker_2, + storyteller_creds, + midjourney_live_session_2, + grok_creds_manager_2, + grok_websockets_2, + ).await; + + if let Err(err) = result { + error!("Failed to handle Tauri startup: {:?}", err); + panic!("Failed to handle Tauri startup: {:?}", err); + } + }); + + Ok(()) + }) + .manage(app_data_root) + .manage(app_preferences) + .manage(promptbox_state) + .manage(artcraft_platform_info) + .manage(artcraft_usage_tracker) + .manage(grok_creds_manager) + .manage(grok_websockets) + .manage(midjourney_creds_manager) + .manage(midjourney_live_session) + .manage(storyteller_creds_manager_3); + + // TODO: Break this out into another module, because RustRover/IntelliJ lags with these macros. + // My first attempt at naively doing this didn't work because the macros can't find their codegen'd targets. + let builder = builder.invoke_handler(tauri::generate_handler![ + add_api_credential_command, + add_web_credential_command, + artcraft_login_command, + delete_credentials_command, + edit_api_credential_command, + edit_web_credential_command, + list_credentials_command, + open_local_file_command, + open_web_login_command, + refresh_grok_statsig_command, + download_directory_reveal_command, + download_media_file_command, + download_url_command, + estimate_audio_cost_command, + estimate_image_cost_command, + estimate_mesh_cost_command, + estimate_splat_cost_command, + estimate_video_cost_command, + list_audio_models_command, + list_image_models_command, + list_mesh_models_command, + list_splat_models_command, + list_video_models_command, + generate_audio_command, + generate_image_command, + generate_mesh_command, + generate_splat_command, + generate_video_command, + get_app_info_command, + get_app_preferences_command, + get_promptbox_state_command, + get_local_thumbnails_command, + get_task_queue_command, + load_custom_sound_command, + load_without_cors_command, + mark_task_as_dismissed_command, + platform_info_command, + tasks_nuke_all_command, + update_app_preferences_command, + update_backup_preference_command, + update_prompt_preference_command, + update_promptbox_state_command, + update_sound_preference_command, + ]); + + builder.run(tauri::generate_context!("tauri.conf.json")) + .expect("error while running tauri application"); +} diff --git a/crates/artcraftx/src/lifecycle/mod.rs b/crates/artcraftx/src/lifecycle/mod.rs new file mode 100644 index 00000000..f58fb458 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/mod.rs @@ -0,0 +1 @@ +pub mod startup; \ No newline at end of file diff --git a/crates/artcraftx/src/lifecycle/startup/handle_tauri_startup.rs b/crates/artcraftx/src/lifecycle/startup/handle_tauri_startup.rs new file mode 100644 index 00000000..a819268f --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/handle_tauri_startup.rs @@ -0,0 +1,110 @@ +use crate::lifecycle::startup::tasks::bootstrap_local_files_database::bootstrap_local_files_database; +use crate::lifecycle::startup::tasks::bootstrap_task_database::bootstrap_task_database; +use crate::lifecycle::startup::tasks::initially_size_and_position_windows::initially_size_and_position_windows; +use crate::lifecycle::startup::tasks::set_app_log_level::set_app_log_level; +use crate::lifecycle::startup::tasks::spawn_discord_presence_thread::spawn_discord_presence_thread; +use crate::lifecycle::startup::tasks::spawn_main_window_thread::spawn_main_window_thread; +use crate::lifecycle::startup::tasks::spawn_storyteller_threads::spawn_storyteller_threads; +use crate::lifecycle::startup::tasks::spawn_thumbnail_worker_thread::spawn_thumbnail_worker_thread; +use crate::state::runtime::artcraft_platform_info::ArtcraftPlatformInfo; +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use crate::services::grok::state::grok_websockets::GrokWebsockets; +use crate::services::grok::threads::grok_video_task_polling::grok_video_task_polling_thread::grok_video_task_polling_thread; +use crate::services::midjourney::state::midjourney_live_session::MidjourneyLiveSession; +use crate::services::midjourney::threads::midjourney_long_polling_thread::midjourney_long_polling_thread; +use crate::services::midjourney::threads::midjourney_websocket_thread::midjourney_websocket_thread; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::threads::third_party_task_polling_thread::third_party_task_polling_thread::third_party_task_polling_thread; +use errors::AnyhowResult; +use tauri::AppHandle; + +pub async fn handle_tauri_startup( + app: AppHandle, + root: AppDataRoot, + app_preferences: AppPreferencesManager, + artcraft_platform_info: ArtcraftPlatformInfo, + artcraft_usage_tracker: ArtcraftUsageTracker, + storyteller_creds_manager: StorytellerCredentialManager, + midjourney_live_session: MidjourneyLiveSession, + grok_creds_manager: GrokCredentialManager, + grok_websockets: GrokWebsockets, +) -> AnyhowResult<()> { + + set_app_log_level( + &app, + &root, + )?; + + let task_database = + bootstrap_task_database(&app, &root).await?; + + let local_files_database = + bootstrap_local_files_database(&app, &root).await?; + + spawn_thumbnail_worker_thread( + &app, + &root, + &task_database, + &local_files_database, + )?; + + spawn_main_window_thread( + &app, + &root, + )?; + + spawn_storyteller_threads( + &app, + &root, + &app_preferences, + &artcraft_usage_tracker, + &artcraft_platform_info, + &task_database, + &storyteller_creds_manager, + )?; + + tauri::async_runtime::spawn(grok_video_task_polling_thread( + app.clone(), + root.clone(), + app_preferences.clone(), + task_database.clone(), + grok_creds_manager.clone(), + storyteller_creds_manager.clone(), + )); + + tauri::async_runtime::spawn(midjourney_websocket_thread( + app.clone(), + root.clone(), + app_preferences.clone(), + task_database.clone(), + midjourney_live_session.clone(), + storyteller_creds_manager.clone(), + )); + + tauri::async_runtime::spawn(midjourney_long_polling_thread( + app.clone(), + root.clone(), + app_preferences.clone(), + task_database.clone(), + midjourney_live_session.clone(), + storyteller_creds_manager.clone(), + )); + + tauri::async_runtime::spawn(third_party_task_polling_thread( + app.clone(), + root.clone(), + app_preferences.clone(), + task_database.clone(), + storyteller_creds_manager.clone(), + grok_websockets.clone(), + )); + + spawn_discord_presence_thread()?; + + initially_size_and_position_windows(&app, &root); + + Ok(()) +} diff --git a/crates/artcraftx/src/lifecycle/startup/mod.rs b/crates/artcraftx/src/lifecycle/startup/mod.rs new file mode 100644 index 00000000..07db4020 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/mod.rs @@ -0,0 +1,3 @@ +mod tasks; +pub mod handle_tauri_startup; +pub mod setup_main_window; \ No newline at end of file diff --git a/crates/artcraftx/src/lifecycle/startup/setup_main_window.rs b/crates/artcraftx/src/lifecycle/startup/setup_main_window.rs new file mode 100644 index 00000000..648f03c2 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/setup_main_window.rs @@ -0,0 +1,99 @@ +use crate::windows::main_window::constants::MAIN_WINDOW_NAME; +use errors::AnyhowResult; +use tauri::window::Color; +use tauri::{AppHandle, TitleBarStyle, WebviewUrl, WebviewWindowBuilder}; + +pub async fn setup_main_window( + app: &AppHandle, +) -> AnyhowResult<()> { + + let win_builder = + WebviewWindowBuilder::new(app, MAIN_WINDOW_NAME, WebviewUrl::default()) + .title("ArtCraft") + .resizable(true) + .fullscreen(false) + .background_color(Color(0, 0, 0, 0)) + .enable_clipboard_access() + .inner_size(1080.0, 480.0); + + #[cfg(target_os = "macos")] + let win_builder = win_builder + .decorations(true) // NB: Mac requires decorations. Tons of capabilities disappear otherwise. + .title_bar_style(TitleBarStyle::Overlay) + .hidden_title(true) + .accept_first_mouse(true) // https://github.com/tauri-apps/tauri/issues/11605#issuecomment-2460112096 + .focusable(true) + .focused(true); + + // NB: Setting decorations(false) "breaks" Mac, though I never documented how/why. + // NB: On Linux, setting decorations(false) will cause the window to be unable to be + // resized, despite the arrow cursor indicating resize is possible. This might be + // fixable another way, but for now it seems fine to disable this. There also seem to + // be some performance loss with decorations(false), but I might be imagining it. + #[cfg(target_os = "windows")] + let win_builder = win_builder + .decorations(false); // NB: This breaks Mac! (And breaks resize on Linux) + + // On macOS, Cmd+A/C/V/X/Z and friends are dispatched by AppKit through the application + // menu. Without an Edit submenu containing the standard predefined items, these + // shortcuts never reach the WKWebView and text inputs behave as if Cmd is unmapped. + #[cfg(target_os = "macos")] + install_macos_app_menu(app)?; + + let _window = win_builder.build()?; + + Ok(()) +} + +#[cfg(target_os = "macos")] +fn install_macos_app_menu(app: &AppHandle) -> AnyhowResult<()> { + use tauri::menu::{Menu, PredefinedMenuItem, Submenu}; + + let app_submenu = Submenu::with_items( + app, + "ArtCraft", + true, + &[ + &PredefinedMenuItem::about(app, None, None)?, + &PredefinedMenuItem::separator(app)?, + &PredefinedMenuItem::services(app, None)?, + &PredefinedMenuItem::separator(app)?, + &PredefinedMenuItem::hide(app, None)?, + &PredefinedMenuItem::hide_others(app, None)?, + &PredefinedMenuItem::show_all(app, None)?, + &PredefinedMenuItem::separator(app)?, + &PredefinedMenuItem::quit(app, None)?, + ], + )?; + + let edit_submenu = Submenu::with_items( + app, + "Edit", + true, + &[ + &PredefinedMenuItem::undo(app, None)?, + &PredefinedMenuItem::redo(app, None)?, + &PredefinedMenuItem::separator(app)?, + &PredefinedMenuItem::cut(app, None)?, + &PredefinedMenuItem::copy(app, None)?, + &PredefinedMenuItem::paste(app, None)?, + &PredefinedMenuItem::select_all(app, None)?, + ], + )?; + + let window_submenu = Submenu::with_items( + app, + "Window", + true, + &[ + &PredefinedMenuItem::minimize(app, None)?, + &PredefinedMenuItem::maximize(app, None)?, + &PredefinedMenuItem::separator(app)?, + &PredefinedMenuItem::close_window(app, None)?, + ], + )?; + + let menu = Menu::with_items(app, &[&app_submenu, &edit_submenu, &window_submenu])?; + app.set_menu(menu)?; + Ok(()) +} diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/bootstrap_local_files_database.rs b/crates/artcraftx/src/lifecycle/startup/tasks/bootstrap_local_files_database.rs new file mode 100644 index 00000000..c88d8bfa --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/bootstrap_local_files_database.rs @@ -0,0 +1,10 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use errors::AnyhowResult; +use tauri::{AppHandle, Manager}; + +pub async fn bootstrap_local_files_database(app: &AppHandle, root: &AppDataRoot) -> AnyhowResult { + let local_files_database = LocalFilesDatabase::connect(root).await?; + app.manage(local_files_database.clone()); + Ok(local_files_database) +} diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/bootstrap_task_database.rs b/crates/artcraftx/src/lifecycle/startup/tasks/bootstrap_task_database.rs new file mode 100644 index 00000000..e30f070c --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/bootstrap_task_database.rs @@ -0,0 +1,10 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use errors::AnyhowResult; +use tauri::{AppHandle, Manager}; + +pub async fn bootstrap_task_database(app: &AppHandle, root: &AppDataRoot) -> AnyhowResult { + let task_database = TaskDatabase::connect(root).await?; + app.manage(task_database.clone()); + Ok(task_database) +} diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/initially_size_and_position_windows.rs b/crates/artcraftx/src/lifecycle/startup/tasks/initially_size_and_position_windows.rs new file mode 100644 index 00000000..a914763c --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/initially_size_and_position_windows.rs @@ -0,0 +1,42 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::window::main_window_position::MainWindowPosition; +use crate::state::window::main_window_size::MainWindowSize; +use crate::utils::window::position_main_window::position_main_window; +use crate::utils::window::resize_main_window::resize_main_window; +use tauri::AppHandle; + +pub fn initially_size_and_position_windows( + app: &AppHandle, + root: &AppDataRoot, +) { + + println!("Sizing and positioning window..."); + + match MainWindowSize::from_filesystem_configs(&root) { + Ok(None) => {} + Ok(Some(size)) => { + println!("Resizing window to: {:?}", size); + let result = resize_main_window(app, &size); + if let Err(err) = result { + eprintln!("Could not set window size: {:?}", err); + } + } + Err(err) => { + eprintln!("Failed to read window size from disk: {:?}", err); + } + } + + match MainWindowPosition::from_filesystem_configs(&root) { + Ok(None) => {} + Ok(Some(pos)) => { + println!("Moving window to: {:?}", pos); + let result = position_main_window(app, &pos); + if let Err(err) = result { + eprintln!("Could not set window position: {:?}", err); + } + } + Err(err) => { + eprintln!("Failed to read window position from disk: {:?}", err); + } + } +} \ No newline at end of file diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/mod.rs b/crates/artcraftx/src/lifecycle/startup/tasks/mod.rs new file mode 100644 index 00000000..797ed6cf --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/mod.rs @@ -0,0 +1,8 @@ +pub (super) mod bootstrap_local_files_database; +pub (super) mod bootstrap_task_database; +pub (super) mod set_app_log_level; +pub (super) mod initially_size_and_position_windows; +pub (super) mod spawn_discord_presence_thread; +pub (super) mod spawn_main_window_thread; +pub (super) mod spawn_storyteller_threads; +pub (super) mod spawn_thumbnail_worker_thread; diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/set_app_log_level.rs b/crates/artcraftx/src/lifecycle/startup/tasks/set_app_log_level.rs new file mode 100644 index 00000000..69a50761 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/set_app_log_level.rs @@ -0,0 +1,73 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use log::LevelFilter; +use std::env; +use std::env::VarError; +use tauri::AppHandle; +use tauri_plugin_log::{Target, TargetKind}; + +const RUST_LOG: &str = "RUST_LOG"; + +pub fn set_app_log_level( + app: &AppHandle, + root: &AppDataRoot, +) -> AnyhowResult<()> { + + //print_env_var(RUST_LOG); + + // NB: The semantics of this do not match `RUST_LOG` exactly as it's not set per-package. + let maybe_level = env::var(RUST_LOG) + .map(|value| value.trim().to_ascii_lowercase()); + + let mut log_level = LevelFilter::Info; + + match maybe_level { + Ok(level) => { + println!("The `RUST_LOG` environment variable was set to: `{}`.", level); + + if level.contains("debug") { + log_level = LevelFilter::Debug; + } else if level.contains("info") { + log_level = LevelFilter::Info; + } else if level.contains("warn") { + log_level = LevelFilter::Warn; + } else if level.contains("error") { + log_level = LevelFilter::Error; + } else if level.contains("off") { + log_level = LevelFilter::Off; + } + } + Err(VarError::NotPresent) => { + // NB: This demonstrably tests stderr output in the default case. + eprintln!("No `RUST_LOG` environment variable found."); + } + Err(VarError::NotUnicode(_)) => { + // NB: This demonstrably tests stderr output in the default case. + eprintln!("Could not parse `RUST_LOG` environment variable; not unicode."); + } + } + + println!("Setting app log level to: {:?}", log_level); + + app.plugin( + tauri_plugin_log::Builder::default() + .level(log_level) + .targets(vec![ + Target::new(TargetKind::Stdout), + Target::new(TargetKind::LogDir { + file_name: Some(root.log_file_name_str().to_string()) + }), + ]) + .build(), + )?; + + Ok(()) +} + +// pub fn print_env_var(var_name: &str) { +// match env::var(var_name) { +// Ok(value) => println!("Environment variable `{}` = {}", var_name, value), +// Err(VarError::NotPresent) => println!("Environment variable `{}` is not set.", var_name), +// Err(VarError::NotUnicode(_)) => println!("Environment variable `{}` is not a valid Unicode string", var_name), +// } +// } diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/spawn_discord_presence_thread.rs b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_discord_presence_thread.rs new file mode 100644 index 00000000..0b93b8be --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_discord_presence_thread.rs @@ -0,0 +1,10 @@ +use crate::threads::discord_presence_thread::discord_presence_thread; +use errors::AnyhowResult; + +pub fn spawn_discord_presence_thread( +) -> AnyhowResult<()> { + + tauri::async_runtime::spawn(discord_presence_thread()); + + Ok(()) +} diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/spawn_main_window_thread.rs b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_main_window_thread.rs new file mode 100644 index 00000000..152d36f5 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_main_window_thread.rs @@ -0,0 +1,17 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::threads::main_window_thread::main_window_thread::main_window_thread; +use errors::AnyhowResult; +use tauri::AppHandle; + +pub fn spawn_main_window_thread( + app: &AppHandle, + root: &AppDataRoot, +) -> AnyhowResult<()> { + + tauri::async_runtime::spawn(main_window_thread( + app.clone(), + root.clone(), + )); + + Ok(()) +} diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/spawn_storyteller_threads.rs b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_storyteller_threads.rs new file mode 100644 index 00000000..e3a15fb2 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_storyteller_threads.rs @@ -0,0 +1,37 @@ +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::runtime::artcraft_platform_info::ArtcraftPlatformInfo; +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use crate::state::database::task_database::TaskDatabase; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::services::storyteller::threads::storyteller_activity_thread::storyteller_activity_thread; +use crate::services::storyteller::threads::storyteller_task_polling_thread::storyteller_task_polling_thread::storyteller_task_polling_thread; +use errors::AnyhowResult; +use tauri::AppHandle; + +pub fn spawn_storyteller_threads( + app: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + artcraft_usage_tracker: &ArtcraftUsageTracker, + artcraft_platform_info: &ArtcraftPlatformInfo, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, +) -> AnyhowResult<()> { + + tauri::async_runtime::spawn(storyteller_task_polling_thread( + app.clone(), + app_data_root.clone(), + app_preferences.clone(), + task_database.clone(), + storyteller_creds_manager.clone(), + )); + + tauri::async_runtime::spawn(storyteller_activity_thread( + artcraft_platform_info.clone(), + artcraft_usage_tracker.clone(), + storyteller_creds_manager.clone(), + )); + + Ok(()) +} diff --git a/crates/artcraftx/src/lifecycle/startup/tasks/spawn_thumbnail_worker_thread.rs b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_thumbnail_worker_thread.rs new file mode 100644 index 00000000..bcb162e3 --- /dev/null +++ b/crates/artcraftx/src/lifecycle/startup/tasks/spawn_thumbnail_worker_thread.rs @@ -0,0 +1,29 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::state::database::task_database::TaskDatabase; +use crate::state::thumbnails::thumbnail_work_queue::ThumbnailWorkQueue; +use crate::threads::thumbnail_worker_thread::thumbnail_worker_thread::thumbnail_worker_thread; +use errors::AnyhowResult; +use tauri::{AppHandle, Manager}; + +/// Start the background thumbnail worker and expose its wake-up queue as +/// managed state, so downloaders (and commands) can hand it files. +pub fn spawn_thumbnail_worker_thread( + app: &AppHandle, + app_data_root: &AppDataRoot, + task_database: &TaskDatabase, + local_files_database: &LocalFilesDatabase, +) -> AnyhowResult<()> { + let queue = ThumbnailWorkQueue::new(); + app.manage(queue.clone()); + + tauri::async_runtime::spawn(thumbnail_worker_thread( + app.clone(), + app_data_root.clone(), + task_database.clone(), + local_files_database.clone(), + queue, + )); + + Ok(()) +} diff --git a/crates/artcraftx/src/main.rs b/crates/artcraftx/src/main.rs new file mode 100644 index 00000000..719c54d3 --- /dev/null +++ b/crates/artcraftx/src/main.rs @@ -0,0 +1,6 @@ +// Prevents additional console window on Windows in release, DO NOT REMOVE!! +#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] + +fn main() { + artcraftx_app_lib::run(); +} diff --git a/crates/artcraftx/src/services/asset_uploads/asset_upload_ledger.rs b/crates/artcraftx/src/services/asset_uploads/asset_upload_ledger.rs new file mode 100644 index 00000000..d398fbda --- /dev/null +++ b/crates/artcraftx/src/services/asset_uploads/asset_upload_ledger.rs @@ -0,0 +1,378 @@ +//! The upload-dedup ledger: which remote service already holds which local +//! content, per account. +//! +//! Before an upload, callers hash the bytes (memoized through the +//! local_files index for files on disk) and ask the ledger. A hit is +//! verified with the service before it is trusted; a miss, or a hit the +//! service no longer honours, means a fresh upload that is then recorded +//! over the old row. The ledger never makes an upload fail: every lookup +//! error reads as a miss and every write error is logged. +//! +//! Account identity: +//! - Higgsfield: the stored credential's id (sessions only come from stored +//! credentials). +//! - ArtCraft: a fingerprint of the web session cookie +//! ([`artcraft_account_id`]) — the app has no user id for a session, and a +//! re-login simply starts a fresh (empty) history. +//! +//! The router gets a per-account view through [`AccountUploadCache`], which +//! implements its [`AssetUploadCache`] trait. + +use std::future::Future; +use std::path::Path; +use std::sync::{Arc, Mutex}; + +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use artcraft_client::utils::api_host::ApiHost; +use async_trait::async_trait; +use core_types::enums::generation_source::GenerationSource; +use core_types::identifiers::credential_id::CredentialId; +use file_hashing::hash_bytes_blake3; +use local_files_database::queries::asset_upload_record::AssetUploadRecord; +use local_files_database::queries::delete_asset_upload::delete_asset_upload; +use local_files_database::queries::get_asset_upload::{get_asset_upload, GetAssetUploadArgs}; +use local_files_database::queries::touch_asset_upload_reused::touch_asset_upload_reused; +use local_files_database::queries::upsert_asset_upload::{upsert_asset_upload, UpsertAssetUploadArgs}; +use log::{info, warn}; +use router::api::asset_upload_cache::{AssetUploadCache, AssetUploadOrigin, CachedAssetUpload}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::services::local_files::file_hash_service::hash_local_file_memoized; +use crate::state::database::local_files_database::LocalFilesDatabase; + +/// The ArtCraft account key is derived from the session cookie; this many +/// hex characters of its BLAKE3 is plenty to tell sessions apart. +const ARTCRAFT_SESSION_FINGERPRINT_CHARS: usize = 32; + +#[derive(Clone)] +pub struct AssetUploadLedger { + database: LocalFilesDatabase, +} + +/// The ledger narrowed to one service + account: what the router (and the +/// ArtCraft upload helpers) work with. +#[derive(Clone)] +pub struct AccountUploadCache { + ledger: AssetUploadLedger, + service: GenerationSource, + account_id: String, + /// Hashes whose upload this request skipped thanks to a ledger hit. If the + /// provider then rejects the request over its media, these are the entries + /// to drop before uploading afresh (see `forget_reused`). + reused_this_request: Arc>>, +} + +impl AssetUploadLedger { + pub fn new(database: LocalFilesDatabase) -> Self { + Self { database } + } + + /// This account's uploads on `service`. + pub fn for_account(&self, service: GenerationSource, account_id: impl Into) -> AccountUploadCache { + AccountUploadCache { + ledger: self.clone(), + service, + account_id: account_id.into(), + reused_this_request: Arc::new(Mutex::new(Vec::new())), + } + } + + /// A stored Higgsfield credential's uploads. + pub fn for_higgsfield_credential(&self, credential_id: &CredentialId) -> AccountUploadCache { + self.for_account(GenerationSource::Higgsfield, credential_id.as_str()) + } + + /// The uploads of the ArtCraft account behind a web session, if the + /// session identifies one (anonymous uploads aren't tracked). + pub fn for_artcraft_session(&self, maybe_creds: Option<&StorytellerCredentialSet>) -> Option { + let account_id = artcraft_account_id(maybe_creds?)?; + Some(self.for_account(GenerationSource::Artcraft, account_id)) + } + + /// BLAKE3 of a file on disk, memoized in the local_files index. + pub async fn hash_file(&self, path: &Path) -> Result { + hash_local_file_memoized(&self.database, path).await + } + + // ── Raw row access ── + + pub async fn find(&self, service: GenerationSource, account_id: &str, file_hash: &str) -> Option { + let result = get_asset_upload(GetAssetUploadArgs { + db: self.database.get_connection(), + service: service.to_str(), + account_id, + file_hash_blake3: file_hash, + }).await; + match result { + Ok(record) => record, + Err(err) => { + warn!("asset_uploads lookup failed ({service}, {account_id}, {file_hash}): {err}"); + None + } + } + } + + pub async fn record(&self, service: GenerationSource, account_id: &str, file_hash: &str, file_size_bytes: Option, upload: &CachedAssetUpload) { + let result = upsert_asset_upload(UpsertAssetUploadArgs { + db: self.database.get_connection(), + service: service.to_str(), + account_id, + file_hash_blake3: file_hash, + service_id: &upload.service_id, + origin: upload.origin.as_str(), + maybe_service_url: upload.maybe_service_url.as_deref(), + maybe_file_size_bytes: file_size_bytes.map(|size| size as i64), + }).await; + match result { + Ok(()) => info!("Recorded {service} upload {} for {account_id} (hash {file_hash})", upload.service_id), + Err(err) => warn!("Could not record {service} upload {}: {err}", upload.service_id), + } + } + + pub async fn note_reused(&self, service: GenerationSource, account_id: &str, file_hash: &str) { + if let Err(err) = touch_asset_upload_reused(self.database.get_connection(), service.to_str(), account_id, file_hash).await { + warn!("Could not mark {service} upload reused (hash {file_hash}): {err}"); + } + } + + pub async fn forget(&self, service: GenerationSource, account_id: &str, file_hash: &str) { + if let Err(err) = delete_asset_upload(self.database.get_connection(), service.to_str(), account_id, file_hash).await { + warn!("Could not forget {service} upload (hash {file_hash}): {err}"); + } + } +} + +impl AccountUploadCache { + pub fn service(&self) -> GenerationSource { + self.service + } + + /// How many uploads this request has skipped so far via ledger hits. + pub fn reused_count(&self) -> usize { + self.reused_this_request.lock().map(|reused| reused.len()).unwrap_or(0) + } + + /// Drop every ledger entry this request reused, so the next finalize + /// uploads those files afresh. Returns how many were forgotten. + pub async fn forget_reused(&self) -> usize { + let hashes: Vec = match self.reused_this_request.lock() { + Ok(mut reused) => reused.drain(..).collect(), + Err(_) => Vec::new(), + }; + for hash in &hashes { + self.ledger.forget(self.service, &self.account_id, hash).await; + } + hashes.len() + } + + pub fn account_id(&self) -> &str { + &self.account_id + } + + /// Hash a local file (memoized through the local_files index). + pub async fn hash_file(&self, path: &Path) -> Result { + self.ledger.hash_file(path).await + } + + /// The ArtCraft media file for a local file, reusing this account's + /// earlier upload when ArtCraft still has it, else running `upload` and + /// recording its token. `upload` is only awaited on a miss. + /// + /// Hashing failures (unreadable file) skip the ledger and just upload. + pub async fn artcraft_token_for_file(&self, api_host: &ApiHost, path: &Path, upload: F) -> Result + where + F: FnOnce() -> Fut, + Fut: Future>, + { + let maybe_hash = match self.hash_file(path).await { + Ok(hash) => Some(hash), + Err(message) => { + warn!("Could not hash {} for the upload ledger ({message}); uploading without it", path.display()); + None + } + }; + + if let Some(hash) = maybe_hash.as_deref() { + if let Some(token) = self.verified_artcraft_token(api_host, hash).await { + info!("Reusing ArtCraft media file {} for {} (already uploaded by this account)", token.as_str(), path.display()); + self.note_reused(hash).await; + return Ok(token); + } + } + + let token = upload().await?; + + if let Some(hash) = maybe_hash.as_deref() { + let file_size_bytes = std::fs::metadata(path).ok().map(|metadata| metadata.len()); + self.record_upload(hash, file_size_bytes.unwrap_or(0), &CachedAssetUpload::uploaded(token.as_str().to_string(), None)).await; + } + Ok(token) + } + + /// Same as [`Self::artcraft_token_for_file`] for bytes already in memory. + pub async fn artcraft_token_for_bytes(&self, api_host: &ApiHost, bytes: &[u8], upload: F) -> Result + where + F: FnOnce() -> Fut, + Fut: Future>, + { + let hash = hash_bytes_blake3(bytes); + if let Some(token) = self.verified_artcraft_token(api_host, &hash).await { + info!("Reusing ArtCraft media file {} for {} in-memory bytes (already uploaded by this account)", token.as_str(), bytes.len()); + self.note_reused(&hash).await; + return Ok(token); + } + let token = upload().await?; + self.record_upload(&hash, bytes.len() as u64, &CachedAssetUpload::uploaded(token.as_str().to_string(), None)).await; + Ok(token) + } + + /// The cached ArtCraft token for a hash, if ArtCraft still serves the + /// media file. Anything else forgets the row and answers `None`. + async fn verified_artcraft_token(&self, api_host: &ApiHost, file_hash: &str) -> Option { + let cached = self.find_upload(file_hash).await?; + let token = MediaFileToken::new_from_str(&cached.service_id); + match get_media_file(api_host, &token).await { + Ok(_) => Some(token), + Err(err) => { + warn!("Cached ArtCraft media file {} could not be confirmed ({:?}); uploading again", token.as_str(), err); + self.forget_upload(file_hash).await; + None + } + } + } +} + +#[async_trait] +impl AssetUploadCache for AccountUploadCache { + async fn find_upload(&self, file_hash_blake3: &str) -> Option { + self.ledger.find(self.service, &self.account_id, file_hash_blake3).await + .map(|record| CachedAssetUpload { + service_id: record.service_id, + maybe_service_url: record.service_url, + origin: AssetUploadOrigin::parse(&record.origin), + }) + } + + async fn record_upload(&self, file_hash_blake3: &str, file_size_bytes: u64, upload: &CachedAssetUpload) { + self.ledger.record(self.service, &self.account_id, file_hash_blake3, Some(file_size_bytes), upload).await + } + + async fn note_reused(&self, file_hash_blake3: &str) { + if let Ok(mut reused) = self.reused_this_request.lock() { + reused.push(file_hash_blake3.to_string()); + } + self.ledger.note_reused(self.service, &self.account_id, file_hash_blake3).await + } + + async fn forget_upload(&self, file_hash_blake3: &str) { + self.ledger.forget(self.service, &self.account_id, file_hash_blake3).await + } +} + +/// The ledger's account key for an ArtCraft web session: a fingerprint of +/// the session cookie. `None` without a session (anonymous). +pub fn artcraft_account_id(creds: &StorytellerCredentialSet) -> Option { + let session = creds.session.as_ref()?; + let fingerprint = hash_bytes_blake3(session.as_bytes()); + Some(format!("artcraft_session_{}", &fingerprint[..ARTCRAFT_SESSION_FINGERPRINT_CHARS])) +} + +#[cfg(test)] +mod tests { + use super::*; + use artcraft_client::credentials::storyteller_session_cookie::StorytellerSessionCookie; + use crate::state::data_dir::app_data_root::AppDataRoot; + + #[test] + fn artcraft_account_id_is_a_stable_session_fingerprint() { + let mut creds = StorytellerCredentialSet::empty(); + assert!(artcraft_account_id(&creds).is_none()); + + creds.session = Some(StorytellerSessionCookie::new("session-abc".to_string())); + let id = artcraft_account_id(&creds).unwrap(); + assert!(id.starts_with("artcraft_session_")); + assert_eq!(id.len(), "artcraft_session_".len() + ARTCRAFT_SESSION_FINGERPRINT_CHARS); + assert_eq!(artcraft_account_id(&creds).unwrap(), id); + assert!(!id.contains("session-abc"), "the raw cookie must not leak into the key"); + + creds.session = Some(StorytellerSessionCookie::new("session-xyz".to_string())); + assert_ne!(artcraft_account_id(&creds).unwrap(), id); + } + + #[tokio::test] + async fn account_cache_round_trips_through_the_router_trait() { + let dir = tempfile::tempdir().unwrap(); + let root = AppDataRoot::create_existing(dir.path().join("root")).unwrap(); + let ledger = AssetUploadLedger::new(LocalFilesDatabase::connect(&root).await.unwrap()); + let cache = ledger.for_higgsfield_credential(&CredentialId::from_trusted("credential_test")); + let other = ledger.for_higgsfield_credential(&CredentialId::from_trusted("credential_other")); + + assert!(cache.find_upload("hash1").await.is_none()); + let upload = CachedAssetUpload::uploaded("media-1", Some("https://cdn/x".into())); + cache.record_upload("hash1", 10, &upload).await; + assert_eq!(cache.find_upload("hash1").await, Some(upload)); + assert!(other.find_upload("hash1").await.is_none(), "accounts don't share uploads"); + + cache.note_reused("hash1").await; + assert!(ledger.find(GenerationSource::Higgsfield, "credential_test", "hash1").await.unwrap().last_reused_at.is_some()); + + cache.forget_upload("hash1").await; + assert!(cache.find_upload("hash1").await.is_none()); + } + + #[tokio::test] + async fn generation_results_keep_their_origin() { + let dir = tempfile::tempdir().unwrap(); + let root = AppDataRoot::create_existing(dir.path().join("root")).unwrap(); + let ledger = AssetUploadLedger::new(LocalFilesDatabase::connect(&root).await.unwrap()); + let cache = ledger.for_higgsfield_credential(&CredentialId::from_trusted("credential_test")); + let result = CachedAssetUpload::generation_result("job-1", "https://cdn/result.png"); + cache.record_upload("hash-result", 10, &result).await; + assert_eq!(cache.find_upload("hash-result").await, Some(result)); + let plain = CachedAssetUpload::uploaded("media-1", Some("https://cdn/x".into())); + cache.record_upload("hash-upload", 10, &plain).await; + assert_eq!(cache.find_upload("hash-upload").await.unwrap().origin, AssetUploadOrigin::Upload); + } + + #[tokio::test] + async fn forget_reused_drops_only_what_this_request_reused() { + let dir = tempfile::tempdir().unwrap(); + let root = AppDataRoot::create_existing(dir.path().join("root")).unwrap(); + let ledger = AssetUploadLedger::new(LocalFilesDatabase::connect(&root).await.unwrap()); + let cache = ledger.for_higgsfield_credential(&CredentialId::from_trusted("credential_test")); + let upload = |id: &str| CachedAssetUpload::uploaded(id, Some("https://cdn/x".into())); + cache.record_upload("reused", 10, &upload("media-reused")).await; + cache.record_upload("fresh", 10, &upload("media-fresh")).await; + assert_eq!(cache.reused_count(), 0); + + cache.note_reused("reused").await; + assert_eq!(cache.reused_count(), 1); + + assert_eq!(cache.forget_reused().await, 1); + assert_eq!(cache.reused_count(), 0, "cleared for the retry"); + assert!(cache.find_upload("reused").await.is_none(), "the reused entry is gone"); + assert!(cache.find_upload("fresh").await.is_some(), "an entry that wasn't reused survives"); + assert_eq!(cache.forget_reused().await, 0, "nothing left to forget"); + } + + #[tokio::test] + async fn artcraft_file_helper_uploads_on_miss_and_records() { + let dir = tempfile::tempdir().unwrap(); + let root = AppDataRoot::create_existing(dir.path().join("root")).unwrap(); + let ledger = AssetUploadLedger::new(LocalFilesDatabase::connect(&root).await.unwrap()); + let cache = ledger.for_account(GenerationSource::Artcraft, "artcraft_session_test"); + let file = dir.path().join("ref.png"); + std::fs::write(&file, b"\x89PNG\r\n\x1a\nfake").unwrap(); + + let token = cache.artcraft_token_for_file::<_, _, ()>(&ApiHost::Storyteller, &file, || async { + Ok(MediaFileToken::new_from_str("m_fresh")) + }).await.unwrap(); + assert_eq!(token.as_str(), "m_fresh"); + + let hash = cache.hash_file(&file).await.unwrap(); + let recorded = cache.find_upload(&hash).await.unwrap(); + assert_eq!(recorded.service_id, "m_fresh"); + assert_eq!(ledger.find(GenerationSource::Artcraft, "artcraft_session_test", &hash).await.unwrap().file_size_bytes, Some(12)); + } +} diff --git a/crates/artcraftx/src/services/asset_uploads/mod.rs b/crates/artcraftx/src/services/asset_uploads/mod.rs new file mode 100644 index 00000000..719a52be --- /dev/null +++ b/crates/artcraftx/src/services/asset_uploads/mod.rs @@ -0,0 +1 @@ +pub mod asset_upload_ledger; diff --git a/crates/artcraftx/src/services/backup/backup_target.rs b/crates/artcraftx/src/services/backup/backup_target.rs new file mode 100644 index 00000000..253e50a9 --- /dev/null +++ b/crates/artcraftx/src/services/backup/backup_target.rs @@ -0,0 +1,138 @@ +//! Where generations made on other services get backed up. +//! +//! The user opts in under Settings → Account Backup and picks one of their +//! ArtCraft accounts. Every third-party completion path (Higgsfield, +//! Midjourney, Grok, Fal, and whatever comes next) asks [`resolve_backup_target`] +//! at delivery time and, when it answers, uploads the results (and a prompt +//! record) to that account. Nothing is cached: the preferences and the +//! credential file are re-read per task so changes apply immediately. + +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::utils::api_host::ApiHost; +use core_types::enums::generation_source::GenerationSource; +use core_types::identifiers::credential_id::CredentialId; +use log::{info, warn}; + +use crate::credentials::auth_credential::AuthCredential; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::services::artcraft_api_host::maybe_artcraft_api_host_for_service; + +/// The ArtCraft account third-party generations are backed up to. +#[derive(Clone)] +pub struct BackupTarget { + pub credential_id: CredentialId, + pub api_host: ApiHost, + pub creds: StorytellerCredentialSet, +} + +/// Whether a stored credential can receive backups: an ArtCraft account with +/// a web session (uploads and prompt records need the session cookies). +pub fn is_backup_eligible(credential: &AuthCredential) -> bool { + matches!( + credential.service, + GenerationSource::Artcraft | GenerationSource::ArtcraftLocal | GenerationSource::ArtcraftCookies + ) && credential.cookies().is_some() +} + +/// The configured backup account, if backups are on and the chosen +/// credential still exists and is usable. Logs why when it doesn't. +pub fn resolve_backup_target( + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, +) -> Option { + let backup = match app_preferences.get() { + Ok(prefs) => prefs.backup, + Err(err) => { + warn!("[Backup] Could not read app preferences; not backing up: {}", err); + return None; + } + }; + if !backup.enabled { + return None; + } + let Some(credential_id) = backup.maybe_artcraft_credential_id.filter(|id| !id.trim().is_empty()) else { + info!("[Backup] Backups are on but no ArtCraft account is selected; not backing up"); + return None; + }; + + let credential = match app_data_root.credentials_dir().find_credential_by_id(&credential_id) { + Ok(Some(credential)) => credential, + Ok(None) => { + warn!("[Backup] Backup account {} no longer exists; not backing up", credential_id); + return None; + } + Err(err) => { + warn!("[Backup] Could not load backup account {}: {}", credential_id, err); + return None; + } + }; + + backup_target_for_credential(&credential) +} + +/// The backup target a specific credential represents, if it is eligible. +pub fn backup_target_for_credential(credential: &AuthCredential) -> Option { + if !is_backup_eligible(credential) { + warn!("[Backup] Credential {} ({}) is not an ArtCraft web-session account; not backing up", credential.id, credential.service); + return None; + } + let api_host = maybe_artcraft_api_host_for_service(credential.service)?; + let cookie = credential.cookies()?; + let creds = match StorytellerCredentialSet::parse_multi_cookie_header(&cookie.cookie_header()) { + Ok(Some(creds)) if !creds.is_empty() => creds, + Ok(_) => { + warn!("[Backup] Backup account {} has no usable session cookies; not backing up", credential.id); + return None; + } + Err(err) => { + warn!("[Backup] Backup account {} has unparsable session cookies ({}); not backing up", credential.id, err); + return None; + } + }; + Some(BackupTarget { credential_id: credential.id.clone(), api_host, creds }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::auth_credential::CredentialSecret; + use crate::credentials::api_key_credential::ApiKeyCredential; + use crate::credentials::cookie_credential::CookieCredential; + use cookie_store_wrapper::cookie_store::CookieStore; + use reqwest::Url; + use std::path::PathBuf; + + fn cookie_credential(service: GenerationSource, header: &str) -> AuthCredential { + let origin = Url::parse("https://artcraft.ai/").unwrap(); + AuthCredential { + id: CredentialId::generate(), + service, + name: None, + secret: CredentialSecret::Cookies(CookieCredential::new(CookieStore::from_cookie_header(header, &origin))), + user_info: None, + source_path: PathBuf::from("/tmp/never_written.toml"), + } + } + + #[test] + fn only_artcraft_web_sessions_are_eligible() { + assert!(is_backup_eligible(&cookie_credential(GenerationSource::Artcraft, "session=abc"))); + assert!(is_backup_eligible(&cookie_credential(GenerationSource::ArtcraftCookies, "session=abc"))); + assert!(!is_backup_eligible(&cookie_credential(GenerationSource::HiggsfieldCookies, "__client=abc"))); + let api_key = AuthCredential { + secret: CredentialSecret::ApiKey(ApiKeyCredential::new("sk-123")), + service: GenerationSource::ArtcraftApi, + ..cookie_credential(GenerationSource::Artcraft, "session=abc") + }; + assert!(!is_backup_eligible(&api_key), "API keys can't drive web-session uploads"); + } + + #[test] + fn target_carries_the_session_and_host() { + let target = backup_target_for_credential(&cookie_credential(GenerationSource::Artcraft, "session=abc")).expect("eligible"); + assert!(!target.creds.is_empty()); + assert!(matches!(target.api_host, ApiHost::Storyteller)); + assert!(backup_target_for_credential(&cookie_credential(GenerationSource::HiggsfieldCookies, "__client=abc")).is_none()); + } +} diff --git a/crates/artcraftx/src/services/backup/mod.rs b/crates/artcraftx/src/services/backup/mod.rs new file mode 100644 index 00000000..fb27d9a1 --- /dev/null +++ b/crates/artcraftx/src/services/backup/mod.rs @@ -0,0 +1 @@ +pub mod backup_target; diff --git a/crates/artcraftx/src/services/grok/mod.rs b/crates/artcraftx/src/services/grok/mod.rs new file mode 100644 index 00000000..c2675d9e --- /dev/null +++ b/crates/artcraftx/src/services/grok/mod.rs @@ -0,0 +1,4 @@ +pub mod state; +pub mod threads; +pub mod util; +pub mod windows; \ No newline at end of file diff --git a/crates/artcraftx/src/services/grok/state/grok_credential_holder.rs b/crates/artcraftx/src/services/grok/state/grok_credential_holder.rs new file mode 100644 index 00000000..378ca5a9 --- /dev/null +++ b/crates/artcraftx/src/services/grok/state/grok_credential_holder.rs @@ -0,0 +1,23 @@ +use cookie_store_wrapper::cookie_store::CookieStore; +use grok_consumer_client::credentials::grok_full_credentials::GrokFullCredentials; + +#[derive(Clone)] +pub struct GrokCredentialHolder { + /// Directly off the Tauri browser session. + /// Read once, write to disk + /// The Grok client consumes a string-only form (rather than this cookie jar) + pub browser_cookies: Option, + + /// Full credentials. + /// NOT PERSISTED TO DISK. + pub grok_full_credentials: Option, +} + +impl GrokCredentialHolder { + pub fn empty() -> Self { + Self { + browser_cookies: None, + grok_full_credentials: None, + } + } +} diff --git a/crates/artcraftx/src/services/grok/state/grok_credential_manager.rs b/crates/artcraftx/src/services/grok/state/grok_credential_manager.rs new file mode 100644 index 00000000..12012273 --- /dev/null +++ b/crates/artcraftx/src/services/grok/state/grok_credential_manager.rs @@ -0,0 +1,212 @@ +use crate::services::grok::state::legacy_credential_paths::GrokLegacyCredentialPaths; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::grok::state::grok_credential_holder::GrokCredentialHolder; +use crate::services::grok::state::grok_serializable_state::{GrokSerializableState, SERIALIZABLE_GROK_STATE_VERSION}; +use cookie_store_wrapper::cookie_store::CookieStore; +use grok_consumer_client::credentials::grok_client_secrets::GrokClientSecrets; +use grok_consumer_client::credentials::grok_cookies::GrokCookies; +use grok_consumer_client::credentials::grok_full_credentials::GrokFullCredentials; +use grok_consumer_client::credentials::grok_user_data::GrokUserData; +use log::warn; +use std::sync::{Arc, RwLock}; + +#[derive(Clone)] +pub struct GrokCredentialManager { + // TODO: Put last write/last read timestamps on these. + credential_data: Arc>, + + //user_info: Arc>>, + app_data_root: AppDataRoot, +} + +impl GrokCredentialManager { + pub fn initialize_empty(app_data_root: &AppDataRoot) -> Self { + Self { + credential_data: Arc::new(RwLock::new(GrokCredentialHolder::empty())), + app_data_root: app_data_root.clone(), + } + } + + pub fn initialize_from_disk_infallible(app_data_root: &AppDataRoot) -> Self { + let credential_data; + + let result = GrokSerializableState::read_from_disk(app_data_root); + match result { + Err(err) => { + warn!("Failed to read grok state from disk: {:?}", err); + credential_data = Arc::new(RwLock::new(GrokCredentialHolder::empty())); + }, + Ok(None) => { + credential_data = Arc::new(RwLock::new(GrokCredentialHolder::empty())); + } + Ok(Some(state)) => { + let maybe_cookies = state.user_cookies; + + let mut user_data = None; + if let Some(user_id) = state.user_id { + user_data = Some(GrokUserData::from_id_and_email(user_id, state.user_email)); + } + + credential_data = Arc::new(RwLock::new(GrokCredentialHolder { + browser_cookies: maybe_cookies, + grok_full_credentials: None, // NB: We don't want to keep this on disk. It goes stale. + })); + } + }; + + Self { + credential_data, + app_data_root: app_data_root.clone(), + } + } + + pub fn maybe_copy_cookie_store(&self) -> anyhow::Result> { + match self.credential_data.read() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(holder) => Ok(holder.browser_cookies.clone()), + } + } + + pub fn maybe_copy_cookie_header_string(&self) -> anyhow::Result> { + let maybe_cookies = self.maybe_copy_cookie_store()?; + let maybe_cookies = maybe_cookies.map(|cookies| { + cookies.to_cookie_string() + }); + Ok(maybe_cookies) + } + + pub fn maybe_copy_typed_cookies(&self) -> anyhow::Result> { + let maybe_cookies = self.maybe_copy_cookie_header_string()?; + let maybe_cookies = maybe_cookies.map(|cookies| { + GrokCookies::new(cookies) + }); + Ok(maybe_cookies) + } + + pub fn maybe_copy_full_credentials(&self) -> anyhow::Result> { + match self.credential_data.read() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(holder) => Ok(holder.grok_full_credentials.clone()), + } + } + + pub fn replace_cookie_store(&self, store: CookieStore) -> anyhow::Result<()> { + match self.credential_data.write() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut holder) => { + holder.browser_cookies = Some(store); + Ok(()) + } + } + } + + pub fn replace_full_credentials(&self, creds: GrokFullCredentials) -> anyhow::Result<()> { + match self.credential_data.write() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut holder) => { + holder.grok_full_credentials = Some(creds); + Ok(()) + } + } + } + + pub fn replace_client_secrets_only(&self, secrets: GrokClientSecrets) -> anyhow::Result<()> { + match self.credential_data.write() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut holder) => { + let mut maybe_full_creds = holder.grok_full_credentials.clone(); + if let Some(creds) = maybe_full_creds.as_mut() { + creds.client_secrets = secrets; + } else { + warn!("No existing credentials to replace secrets into."); + } + holder.grok_full_credentials = maybe_full_creds; + Ok(()) + } + } + } + + // NB: This is just a heuristic. We'll add better checks later. + pub fn do_task_polling(&self) -> anyhow::Result { + self.session_appears_active() + } + + // NB: This is just a heuristic. We'll add better checks later. + pub fn session_appears_active(&self) -> anyhow::Result { + let holder = match self.credential_data.read() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => store.clone(), + }; + + if holder.grok_full_credentials.is_some() { + return Ok(true); + } + + if holder.browser_cookies.is_none() { + return Ok(false); + } + + // TODO: Heuristic + Ok(true) + + //let cookies = match holder.browser_cookies.as_ref() { + // None => return Ok(false), + // Some(cookies) => cookies, + //}; + //// NB: We consider the session active if we have auth cookies and a user id. + ////let has_user_id = user_info.user_id.is_some(); + ////let maybe_has_auth_cookies = cookie_store_has_auth_cookies(&cookies); + //let maybe_has_auth_cookies = true; // TODO TODO TODO - fix this + //// Misc cookies without login cookies are ~1055 length + //// AUTH_I is ~1500 length + //// AUTH_R is ~500 length + //let maybe_has_big_enough_cookie = cookies.calculate_approx_cookie_character_length() > 2100; + //// TODO: Heuristic should count. + //// TODO: Consolidate with "login window thread" logic. + //// TODO: Check timestamp of last valid request. + //Ok((maybe_has_auth_cookies && maybe_has_big_enough_cookie && maybe_has_big_enough_cookie)) + } + + pub fn clear_credentials(&self) -> anyhow::Result<()> { + match self.credential_data.write() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => *store = GrokCredentialHolder::empty(), + } + Ok(()) + } + + pub fn persist_to_disk(&self) -> anyhow::Result<()> { + let creds = match self.credential_data.read() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => store.clone(), + }; + + let state = GrokSerializableState { + version: SERIALIZABLE_GROK_STATE_VERSION, + user_cookies: creds.browser_cookies.clone(), + user_id: creds.grok_full_credentials + .as_ref() + .map(|creds| creds.client_secrets.user_id.to_string()), + user_email: creds.grok_full_credentials + .as_ref() + .map(|data| data.client_secrets.user_email.as_ref()) + .flatten() + .map(|email| email.to_string()), + }; + + let path = self.app_data_root.credentials_dir().get_grok_state_path(); + let serialized = serde_json::to_string(&state)?; + + std::fs::write(path, serialized)?; + + // TODO: This is just for building the client and testing. + if let Some(cookies) = creds.browser_cookies.as_ref() { + let cookies_header = cookies.to_cookie_string(); + let path = self.app_data_root.credentials_dir().get_grok_cookies_path(); + std::fs::write(path, cookies_header)?; + } + + Ok(()) + } +} + diff --git a/crates/artcraftx/src/services/grok/state/grok_serializable_state.rs b/crates/artcraftx/src/services/grok/state/grok_serializable_state.rs new file mode 100644 index 00000000..1e0ae24f --- /dev/null +++ b/crates/artcraftx/src/services/grok/state/grok_serializable_state.rs @@ -0,0 +1,44 @@ +use crate::services::grok::state::legacy_credential_paths::GrokLegacyCredentialPaths; +use crate::state::data_dir::app_data_root::AppDataRoot; +use cookie_store_wrapper::cookie_store::CookieStore; +use serde_derive::{Deserialize, Serialize}; +use std::fs::read_to_string; + +/// History +/// v1 - initial +pub (super) const SERIALIZABLE_GROK_STATE_VERSION: u32 = 1; + +/// We only need to serialize Grok cookies. +/// Most of the other state (verification_token, etc.) can be pulled at runtime. +/// We will cache the `user_id` and `user_email`. +#[derive(Serialize, Deserialize)] +pub (super) struct GrokSerializableState { + pub (super) version: u32, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) user_cookies: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) user_id: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) user_email: Option, +} + +impl GrokSerializableState { + pub fn read_from_disk(root: &AppDataRoot) -> anyhow::Result> { + let state_path = root.credentials_dir().get_grok_state_path(); + + if !state_path.exists() { + return Ok(None); + } + + let contents = read_to_string(&state_path)? + .trim() + .to_string(); + + let state: GrokSerializableState = serde_json::from_str(&contents)?; + + Ok(Some(state)) + } +} diff --git a/crates/artcraftx/src/services/grok/state/grok_websockets.rs b/crates/artcraftx/src/services/grok/state/grok_websockets.rs new file mode 100644 index 00000000..370631ec --- /dev/null +++ b/crates/artcraftx/src/services/grok/state/grok_websockets.rs @@ -0,0 +1,87 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use core_types::identifiers::credential_id::CredentialId; +use grok_consumer_client::endpoint_bindings::generate_image_websocket::grok_generate_image_websocket::GrokImageWebsocket; +use grok_consumer_client::error::grok_error::GrokError; +use log::{error, info}; +use std::collections::HashMap; +use std::sync::{Arc, RwLock}; + +/// App-wide store of live Grok "imagine" image websockets, one per Grok +/// account (credential). +/// +/// The enqueue command opens (or reuses) the socket for the credential it +/// generates with and hands the router a handle to send the prompt on; the +/// third-party task polling thread reads every socket for finished images. +/// [`GrokImageWebsocket`] is itself a cheap, thread-safe handle, so this only +/// guards the "which socket belongs to which account" map. +#[derive(Clone, Default)] +pub struct GrokWebsockets { + websockets: Arc>>, +} + +impl GrokWebsockets { + pub fn new() -> Self { + Self::default() + } + + /// The account's live socket, connecting (and storing) one if absent. + pub async fn get_or_connect( + &self, + credential_id: &CredentialId, + cookie_header: &str, + ) -> Result { + if let Some(websocket) = self.get(credential_id)? { + return Ok(websocket); + } + + info!("Opening Grok image websocket for credential {}", credential_id.as_str()); + let websocket = GrokImageWebsocket::connect(cookie_header) + .await + .map_err(|err: GrokError| ArtcraftXError::from(err))?; + + // NB: two concurrent first enqueues for one account can race here; the + // later insert wins and the earlier socket is dropped (its handle stays + // valid for the caller that opened it). + self.insert(credential_id.clone(), websocket.clone())?; + Ok(websocket) + } + + pub fn get(&self, credential_id: &CredentialId) -> Result, ArtcraftXError> { + let websockets = self.websockets.read().map_err(|err| { + error!("Error reading Grok websockets: {}", err); + ArtcraftXError::RwLockReadError + })?; + Ok(websockets.get(credential_id).cloned()) + } + + pub fn insert(&self, credential_id: CredentialId, websocket: GrokImageWebsocket) -> Result<(), ArtcraftXError> { + let mut websockets = self.write()?; + websockets.insert(credential_id, websocket); + Ok(()) + } + + pub fn remove(&self, credential_id: &CredentialId) -> Result, ArtcraftXError> { + let mut websockets = self.write()?; + Ok(websockets.remove(credential_id)) + } + + /// Snapshot of every live socket (handles are cheap clones). + pub fn all(&self) -> Result, ArtcraftXError> { + let websockets = self.websockets.read().map_err(|err| { + error!("Error reading Grok websockets: {}", err); + ArtcraftXError::RwLockReadError + })?; + Ok(websockets.iter().map(|(id, ws)| (id.clone(), ws.clone())).collect()) + } + + pub fn is_empty(&self) -> Result { + Ok(self.all()?.is_empty()) + } + + fn write(&self) -> Result>, ArtcraftXError> { + self.websockets.write().map_err(|err| { + error!("Error writing Grok websockets: {}", err); + ArtcraftXError::RwLockWriteError + }) + } +} diff --git a/crates/artcraftx/src/services/grok/state/legacy_credential_paths.rs b/crates/artcraftx/src/services/grok/state/legacy_credential_paths.rs new file mode 100644 index 00000000..a971775f --- /dev/null +++ b/crates/artcraftx/src/services/grok/state/legacy_credential_paths.rs @@ -0,0 +1,23 @@ +//! Legacy on-disk credential paths for Grok. +//! +//! TODO(artcraftx): retire once Grok moves to the unified TOML credential +//! store in `crate::credentials`. + +use crate::state::data_dir::subdirectory::app_credentials_dir::AppCredentialsDir; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::path::PathBuf; + +pub trait GrokLegacyCredentialPaths { + fn get_grok_state_path(&self) -> PathBuf; + fn get_grok_cookies_path(&self) -> PathBuf; +} + +impl GrokLegacyCredentialPaths for AppCredentialsDir { + fn get_grok_state_path(&self) -> PathBuf { + self.path().join("grok_state.json") + } + + fn get_grok_cookies_path(&self) -> PathBuf { + self.path().join("grok_cookies.txt") + } +} diff --git a/crates/artcraftx/src/services/grok/state/mod.rs b/crates/artcraftx/src/services/grok/state/mod.rs new file mode 100644 index 00000000..c7aa8b96 --- /dev/null +++ b/crates/artcraftx/src/services/grok/state/mod.rs @@ -0,0 +1,7 @@ +pub mod legacy_credential_paths; +pub mod grok_credential_manager; +pub mod grok_serializable_state; +pub mod grok_websockets; + +// Private +mod grok_credential_holder; diff --git a/crates/artcraftx/src/services/grok/threads/grok_video_task_polling/grok_video_task_polling_thread.rs b/crates/artcraftx/src/services/grok/threads/grok_video_task_polling/grok_video_task_polling_thread.rs new file mode 100644 index 00000000..3abce77d --- /dev/null +++ b/crates/artcraftx/src/services/grok/threads/grok_video_task_polling/grok_video_task_polling_thread.rs @@ -0,0 +1,214 @@ +use crate::database::task_database_pending_statuses::TASK_DATABASE_PENDING_STATUSES; +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use crate::services::grok::util::get_or_upgrade_grok_full_credentials::get_or_update_grok_full_credentials; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::task_completion::complete_task_with_local_files::{complete_task_with_local_files, CompleteTaskArgs}; +use crate::threads::task_completion::upload_results_to_artcraft::CompletionPrompt; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use grok_consumer_client::credentials::grok_full_credentials::GrokFullCredentials; +use grok_consumer_client::endpoint_bindings::old_bindings::download_video_file::grok_download_video::GrokDownloadVideo; +use grok_consumer_client::endpoint_bindings::old_bindings::media_posts::list_media_posts::grok_list_media_posts::{GrokMediaPostListRequest, VideoData}; +use log::{error, info}; +use sqlite_database::queries::read::list_tasks_by_provider_and_status::{list_tasks_by_provider_and_status, ListTasksByProviderAndStatusArgs, TaskList}; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use std::collections::HashMap; +use std::time::Duration; +use tauri::AppHandle; + +/// Download filename slug when the task has no model type recorded. +const GROK_VIDEO_FALLBACK_MODEL_SLUG: &str = "grok_video"; + +pub async fn grok_video_task_polling_thread( + app_handle: AppHandle, + app_data_root: AppDataRoot, + app_preferences: AppPreferencesManager, + task_database: TaskDatabase, + creds: GrokCredentialManager, + storyteller_creds_manager: StorytellerCredentialManager, +) -> ! { + loop { + let res = polling_loop( + &app_handle, + &app_data_root, + &app_preferences, + &task_database, + &creds, + &storyteller_creds_manager, + ).await; + if let Err(err) = res { + error!("An error occurred: {:?}", err); + } + // NB: Only sleep if an error occurs. + tokio::time::sleep(std::time::Duration::from_millis(30_000)).await; + } +} + +async fn polling_loop( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + grok_creds: &GrokCredentialManager, + // Uploads now go to the backup account (see `services::backup`), not the session. + _storyteller_creds_manager: &StorytellerCredentialManager, +) -> AnyhowResult<()> { + loop { + if !grok_creds.do_task_polling()? { + tokio::time::sleep(std::time::Duration::from_millis(10_000)).await; + continue; + } + + + let grok_full_creds = match get_or_update_grok_full_credentials(&grok_creds).await { + Ok(creds) => creds, + Err(err) => { + info!("No full grok credentials: {:?}", err); + tokio::time::sleep(std::time::Duration::from_millis(30_000)).await; + continue; + } + }; + + let local_tasks = list_tasks_by_provider_and_status(ListTasksByProviderAndStatusArgs { + db: task_database.get_connection(), + provider: GenerationSource::Grok, + task_statuses: &TASK_DATABASE_PENDING_STATUSES, + }).await?; + + poll_grok_tasks( + app_handle, + app_data_root, + app_preferences, + task_database, + &grok_full_creds, + local_tasks, + ).await?; + + tokio::time::sleep(std::time::Duration::from_millis(2_000)).await; + } +} + +async fn poll_grok_tasks( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + grok_full_creds: &GrokFullCredentials, + local_tasks: TaskList, +) -> AnyhowResult<()> { + let local_tasks = local_tasks.tasks; + + if local_tasks.is_empty() { + return Ok(()) + } + + info!("Grok tasks waiting: {:?}", local_tasks.len()); + + // Map of Grok Post ID to Local Task. + let local_tasks_by_grok_post_id = local_tasks.iter() + .filter_map(|task| { + if let Some(provider_job_id) = &task.provider_job_id { + Some((provider_job_id.clone(), task.clone())) + } else { + None + } + }) + .collect::>(); + + let list_media_request = GrokMediaPostListRequest { + cookie: grok_full_creds.cookies.as_str(), + cursor: None, + request_timeout: Some(Duration::from_millis(20_000)), + }; + + let list_result = list_media_request.send().await?; + + let grok_posts = list_result.posts; + + let grok_video_posts_by_id = { + let mut hash = HashMap::new(); + for post in grok_posts.iter() { + if let Some(video_data) = &post.video_data { + hash.insert(post.post_id.to_string(), video_data.clone()); + } + } + hash + }; + + for (grok_post_id, local_task) in local_tasks_by_grok_post_id.iter() { + // TODO: Copy prompt from this. + let grok_video_data = match grok_video_posts_by_id.get(grok_post_id) { + Some(video_data) => video_data, + None => continue, + }; + + let result = complete_grok_video( + app_handle, + app_data_root, + app_preferences, + task_database, + grok_full_creds, + grok_post_id, + local_task, + grok_video_data, + ).await; + + if let Err(err) = result { + error!("Failed to complete Grok video task {}: {:?}", local_task.id.as_str(), err); + } + + tokio::time::sleep(std::time::Duration::from_millis(2_000)).await; + } + + tokio::time::sleep(std::time::Duration::from_millis(60_000)).await; + + Ok(()) +} + +/// Download the finished video to the temp dir, then hand it to the shared +/// completion routine. +async fn complete_grok_video( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + grok_full_creds: &GrokFullCredentials, + grok_post_id: &str, + local_task: &Task, + grok_video_post: &VideoData, +) -> AnyhowResult { + info!("Downloading generated Grok video ..."); + + let download_path = app_data_root.temp_dir().path().join(format!("{}.mp4", grok_post_id)); + + let download = GrokDownloadVideo { + cookies: grok_full_creds.cookies.as_str(), + user_id: grok_full_creds.get_user_id_ref(), + file_id: &grok_video_post.file_id, + request_timeout: None, + }; + + download.download_to_path(&download_path).await?; + + complete_task_with_local_files(CompleteTaskArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + task: local_task, + generation_provider: GenerationSource::Grok, + media_class: TaskMediaFileClass::Video, + prompt: CompletionPrompt::Create { + model_type: CommonModelType::GrokVideo, + maybe_prompt: grok_video_post.prompt.clone(), + }, + fallback_model_slug: GROK_VIDEO_FALLBACK_MODEL_SLUG, + local_files: &[download_path], + }).await +} diff --git a/crates/artcraftx/src/services/grok/threads/grok_video_task_polling/mod.rs b/crates/artcraftx/src/services/grok/threads/grok_video_task_polling/mod.rs new file mode 100644 index 00000000..8a7f6404 --- /dev/null +++ b/crates/artcraftx/src/services/grok/threads/grok_video_task_polling/mod.rs @@ -0,0 +1 @@ +pub mod grok_video_task_polling_thread; \ No newline at end of file diff --git a/crates/artcraftx/src/services/grok/threads/mod.rs b/crates/artcraftx/src/services/grok/threads/mod.rs new file mode 100644 index 00000000..4ea02728 --- /dev/null +++ b/crates/artcraftx/src/services/grok/threads/mod.rs @@ -0,0 +1 @@ +pub mod grok_video_task_polling; diff --git a/crates/artcraftx/src/services/grok/util/get_or_upgrade_grok_full_credentials.rs b/crates/artcraftx/src/services/grok/util/get_or_upgrade_grok_full_credentials.rs new file mode 100644 index 00000000..49bf3988 --- /dev/null +++ b/crates/artcraftx/src/services/grok/util/get_or_upgrade_grok_full_credentials.rs @@ -0,0 +1,46 @@ +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use grok_consumer_client::credentials::grok_cookies::GrokCookies; +use grok_consumer_client::credentials::grok_full_credentials::GrokFullCredentials; +use grok_consumer_client::error::grok_client_error::GrokClientError; +use grok_consumer_client::error::grok_error::GrokError; +use grok_consumer_client::recipes::request_client_secrets::{request_client_secrets, RequestClientSecretsArgs}; +use log::{error, info, warn}; +use crate::error::artcraftx_error::ArtcraftXError; + +pub async fn get_or_update_grok_full_credentials(grok_credential_manager: &GrokCredentialManager) -> Result { + if let Some(creds) = grok_credential_manager.maybe_copy_full_credentials()? { + return Ok(creds); + } + + let cookies = match grok_credential_manager.maybe_copy_cookie_store()? { + Some(cookies) => cookies.to_cookie_string(), + None => { + return Err(GrokError::Client(GrokClientError::NoCookiesPresent).into()) + } + }; + + let cookies = GrokCookies::new(cookies); + + info!("Requesting Grok client secrets..."); + + let upgraded = request_client_secrets(RequestClientSecretsArgs { + cookies: &cookies, + }).await; + + match upgraded { + Err(err) => { + error!("Failed to fetch Grok client secrets: {}", err); // NB: Fall-through + return Err(ArtcraftXError::from(err)); + } + Ok(secrets) => { + info!("Grok client secrets successfully upgraded..."); + let full_creds = GrokFullCredentials::from_cookies_and_client_secrets(cookies, secrets); + grok_credential_manager.replace_full_credentials(full_creds.clone())?; + info!("Persisting grok credentials to disk..."); + grok_credential_manager.persist_to_disk()?; + return Ok(full_creds) + } + } + + warn!("Grok upgrade failed. Try logging in again..."); +} diff --git a/crates/artcraftx/src/services/grok/util/mod.rs b/crates/artcraftx/src/services/grok/util/mod.rs new file mode 100644 index 00000000..14704d96 --- /dev/null +++ b/crates/artcraftx/src/services/grok/util/mod.rs @@ -0,0 +1,3 @@ +pub mod get_or_upgrade_grok_full_credentials; +pub mod refresh_grok_statsig; +pub mod upload_image_media_file_to_grok; \ No newline at end of file diff --git a/crates/artcraftx/src/services/grok/util/refresh_grok_statsig.rs b/crates/artcraftx/src/services/grok/util/refresh_grok_statsig.rs new file mode 100644 index 00000000..26566b68 --- /dev/null +++ b/crates/artcraftx/src/services/grok/util/refresh_grok_statsig.rs @@ -0,0 +1,263 @@ +//! Grok statsig refresh. +//! +//! When a Grok credential exists but its statsig (the browser-minted +//! `x-statsig-id` plus its seed material) is missing or stale, open a *hidden* +//! grok.com webview so the passive capture harness records a fresh signature +//! the page makes on load, then persist it onto the credential file. +//! +//! Two entry points: +//! +//! - [`refresh_grok_statsig_if_stale`] — fire-and-forget. Used by the login +//! flow and the credentials page; returns as soon as the hidden window is +//! built and the poll loop is spawned. +//! - [`refresh_grok_statsig_blocking`] — awaits the whole capture. Used by the +//! generation workers right before (or after a failed) enqueue, so the retry +//! can pick up the fresh statsig. +//! +//! Relies on the shared WebKit session (the cookies the login window captured), +//! so the hidden window loads logged-in without re-authenticating. +//! +//! Concurrency: a process-wide single-flight guard ensures only one refresh +//! runs at a time — the credentials page mounts can fire the command twice (and +//! two concurrent same-label window builds deadlock the UI). The blocking +//! variant waits for an in-flight refresh instead of starting a second one. + +use crate::credentials::auth_credential::CredentialSecret; +use crate::credentials::cookie_credential_grok_extra_pieces::{ + grok_statsig_needs_refresh, CookieCredentialGrokExtraPieces, GrokStatsigCapture, +}; +use crate::credentials::find_service_credentials::find_first_credential_for_service; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::windows::login_window::utils::grok_statsig_capture::{grok_statsig_init_script, read_captured_statsig}; +use chrono::Utc; +use core_types::enums::generation_source::GenerationSource; +use errors::{anyhow, AnyhowResult}; +use log::{info, warn}; +use std::sync::atomic::{AtomicBool, Ordering}; +use std::time::Duration; +use tauri::{AppHandle, Manager, WebviewUrl, WebviewWindowBuilder}; + +const REFRESH_WINDOW_NAME: &str = "grok_statsig_refresh"; +const GROK_URL: &str = "https://grok.com/"; + +/// Let the page load before reading cookies, then poll gently up to a timeout. +const INITIAL_LOAD_DELAY: Duration = Duration::from_secs(3); +const CAPTURE_TIMEOUT: Duration = Duration::from_secs(20); +const CAPTURE_POLL_INTERVAL: Duration = Duration::from_secs(1); + +/// How long a blocking caller waits for another in-flight refresh to finish +/// before giving up. Comfortably above a full capture cycle. +const WAIT_FOR_IN_FLIGHT_TIMEOUT: Duration = Duration::from_secs(45); +const WAIT_FOR_IN_FLIGHT_POLL_INTERVAL: Duration = Duration::from_millis(500); + +/// Single-flight guard: only one refresh (and thus one refresh window) at a time. +static REFRESH_IN_PROGRESS: AtomicBool = AtomicBool::new(false); + +/// Resets the single-flight flag on drop, so a panic or early return can never +/// wedge future refreshes. +struct RefreshGuard; + +impl RefreshGuard { + /// Acquire the guard, or `None` if a refresh is already running. + fn acquire() -> Option { + REFRESH_IN_PROGRESS + .compare_exchange(false, true, Ordering::SeqCst, Ordering::SeqCst) + .ok() + .map(|_| RefreshGuard) + } + + fn is_held() -> bool { + REFRESH_IN_PROGRESS.load(Ordering::SeqCst) + } +} + +impl Drop for RefreshGuard { + fn drop(&mut self) { + REFRESH_IN_PROGRESS.store(false, Ordering::SeqCst); + } +} + +/// Outcome of a blocking refresh. +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum GrokStatsigRefreshOutcome { + /// A fresh statsig was captured and saved to the credential file. + Refreshed, + /// Nothing to do: no Grok credential, or the stored statsig is still fresh + /// (possibly because a concurrent refresh just finished). + StillFresh, + /// The hidden window loaded but no signed request was observed in time. + NothingCaptured, +} + +/// Refresh the Grok statsig if missing/stale. Returns immediately after +/// kicking off a background poll; safe to call on login, credentials-page +/// mount, etc. Non-blocking and best-effort. +pub async fn refresh_grok_statsig_if_stale(app: &AppHandle, app_data_root: &AppDataRoot) { + if !stored_statsig_is_stale(app_data_root) { + return; // Not logged in, or still fresh. + } + + let Some(guard) = RefreshGuard::acquire() else { + return; // A refresh is already running. + }; + + if let Err(err) = start_background_refresh(app, app_data_root, guard) { + warn!("Grok statsig refresh could not start: {err:?}"); + // `guard` was moved into start_background_refresh only on success; on + // error it has already been dropped, releasing the flag. + } +} + +/// Refresh the Grok statsig and wait for the result. +/// +/// `force` re-captures even when the stored statsig still looks fresh — used +/// after Grok rejects a request, since the freshness window is a heuristic. +/// If another refresh is in flight, waits for it and reports its result via +/// the credential file's freshness rather than starting a second window. +pub async fn refresh_grok_statsig_blocking( + app: &AppHandle, + app_data_root: &AppDataRoot, + force: bool, +) -> AnyhowResult { + if find_first_credential_for_service(app_data_root, GenerationSource::GrokCookies).is_none() { + return Ok(GrokStatsigRefreshOutcome::StillFresh); // Not logged in — nothing to refresh. + } + + if !force && !stored_statsig_is_stale(app_data_root) { + return Ok(GrokStatsigRefreshOutcome::StillFresh); + } + + let guard = match RefreshGuard::acquire() { + Some(guard) => guard, + None => { + info!("Grok statsig refresh already in flight; waiting for it to finish."); + wait_for_in_flight_refresh().await?; + if !stored_statsig_is_stale(app_data_root) { + return Ok(GrokStatsigRefreshOutcome::StillFresh); + } + // The other refresh finished without producing fresh material; run our own. + RefreshGuard::acquire() + .ok_or_else(|| anyhow!("another Grok statsig refresh started before we could"))? + } + }; + let _guard = guard; // held until this function returns (or panics) + + info!("Refreshing Grok statsig (blocking, force={force}) ..."); + build_refresh_window(app)?; + let captured = poll_and_persist(app, app_data_root).await; + close_refresh_window(app); + + Ok(if captured { + GrokStatsigRefreshOutcome::Refreshed + } else { + GrokStatsigRefreshOutcome::NothingCaptured + }) +} + +/// Whether the stored Grok credential's statsig needs re-capturing. `false` +/// when there is no Grok credential at all. +fn stored_statsig_is_stale(app_data_root: &AppDataRoot) -> bool { + let Some(credential) = find_first_credential_for_service(app_data_root, GenerationSource::GrokCookies) else { + return false; + }; + let grok_data = credential.cookies().and_then(|cookie| cookie.grok_data.as_ref()); + grok_statsig_needs_refresh(grok_data, Utc::now()) +} + +/// Build the hidden window (in the caller's context) and spawn the poll loop. +/// Ownership of `guard` transfers to the spawned task so the flag stays held +/// until the whole refresh finishes. +fn start_background_refresh(app: &AppHandle, app_data_root: &AppDataRoot, guard: RefreshGuard) -> AnyhowResult<()> { + build_refresh_window(app)?; + + info!("Grok statsig missing/stale — refreshing in a hidden window."); + + let app = app.clone(); + let app_data_root = app_data_root.clone(); + tauri::async_runtime::spawn(async move { + let _guard = guard; // released on task completion (or panic) + poll_and_persist(&app, &app_data_root).await; + close_refresh_window(&app); + }); + + Ok(()) +} + +async fn wait_for_in_flight_refresh() -> AnyhowResult<()> { + let deadline = tokio::time::Instant::now() + WAIT_FOR_IN_FLIGHT_TIMEOUT; + while RefreshGuard::is_held() { + if tokio::time::Instant::now() >= deadline { + return Err(anyhow!("timed out waiting for the in-flight Grok statsig refresh")); + } + tokio::time::sleep(WAIT_FOR_IN_FLIGHT_POLL_INTERVAL).await; + } + Ok(()) +} + +fn build_refresh_window(app: &AppHandle) -> AnyhowResult<()> { + if app.get_window(REFRESH_WINDOW_NAME).is_some() { + return Err(anyhow!("refresh window already exists")); + } + + WebviewWindowBuilder::new(app, REFRESH_WINDOW_NAME, WebviewUrl::External(GROK_URL.parse()?)) + .title("Refreshing Grok…") + .visible(false) + .initialization_script(&grok_statsig_init_script()) + .build()?; + + Ok(()) +} + +fn close_refresh_window(app: &AppHandle) { + if let Some(window) = app.get_webview_window(REFRESH_WINDOW_NAME) { + let _ = window.close(); + } +} + +/// Poll the capture cookie the harness stashes until it appears or we time out, +/// then persist the capture. Returns whether something was captured and saved. +async fn poll_and_persist(app: &AppHandle, app_data_root: &AppDataRoot) -> bool { + tokio::time::sleep(INITIAL_LOAD_DELAY).await; + + let deadline = tokio::time::Instant::now() + CAPTURE_TIMEOUT; + loop { + let Some(window) = app.get_webview_window(REFRESH_WINDOW_NAME) else { + warn!("Grok statsig refresh: window closed before a capture was observed."); + return false; + }; + + if let Some(capture) = read_captured_statsig(&window) { + return match save_refreshed_capture(app_data_root, capture) { + Ok(()) => { + info!("Refreshed Grok statsig and saved it to the credential file."); + true + } + Err(err) => { + warn!("Grok statsig refresh: could not save capture: {err:?}"); + false + } + }; + } + + if tokio::time::Instant::now() >= deadline { + warn!("Grok statsig refresh: no signed request observed within {CAPTURE_TIMEOUT:?}."); + return false; + } + tokio::time::sleep(CAPTURE_POLL_INTERVAL).await; + } +} + +/// Persist a fresh capture onto the existing Grok credential, updating only +/// `grok_data` (cookies untouched). +fn save_refreshed_capture(app_data_root: &AppDataRoot, capture: GrokStatsigCapture) -> AnyhowResult<()> { + let mut credential = find_first_credential_for_service(app_data_root, GenerationSource::GrokCookies) + .ok_or_else(|| anyhow!("Grok credential vanished mid-refresh"))?; + + let CredentialSecret::Cookies(cookie) = &mut credential.secret else { + return Err(anyhow!("Grok credential is not a cookie credential")); + }; + cookie.grok_data = Some(CookieCredentialGrokExtraPieces::fresh(capture, Utc::now())); + + credential.save()?; + Ok(()) +} diff --git a/crates/artcraftx/src/services/grok/util/upload_image_media_file_to_grok.rs b/crates/artcraftx/src/services/grok/util/upload_image_media_file_to_grok.rs new file mode 100644 index 00000000..d0b717c4 --- /dev/null +++ b/crates/artcraftx/src/services/grok/util/upload_image_media_file_to_grok.rs @@ -0,0 +1,73 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use crate::utils::get_url_file_extension::get_url_file_extension; +use crate::utils::download::simple_http_download::simple_http_download; +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use anyhow::anyhow; +use errors::AnyhowResult; +use grok_consumer_client::datatypes::api::file_id::FileId; +use grok_consumer_client::endpoint_bindings::upload_file::grok_upload_file::{grok_upload_file, GrokUploadFileArgs, GrokUploadFileRequest, PathOrFile}; +use log::info; +use std::time::Duration; +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use artcraft_client::utils::api_host::ApiHost; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +const GROK_IMAGE_UPLOAD_TIMEOUT: Duration = Duration::from_millis(1000 * 30); // 30 seconds + +pub struct UploadImageMediaFileToGrok<'a> { + pub storyteller_host: &'a ApiHost, + pub image_media_token: &'a MediaFileToken, + + pub app_data_root: &'a AppDataRoot, + pub grok_creds_manager: &'a GrokCredentialManager, +} + +pub struct UploadImageMediaFileToGrokResult { + pub grok_file_id: FileId, +} + +pub async fn upload_image_media_file_to_grok( + args: UploadImageMediaFileToGrok<'_>, +) -> AnyhowResult { + + info!("Calling get media file API: {:?}", args.storyteller_host); + + info!("Using media token: {:?}", args.image_media_token); + + let response = get_media_file( + args.storyteller_host, + args.image_media_token + ).await?; + + let media_file_url = &response.media_file.media_links.cdn_url; + let extension_with_dot = get_url_file_extension(media_file_url) + .map(|ext| format!(".{}", ext)) + .unwrap_or_else(|| ".png".to_string()); + + let filename = format!("{}{}", response.media_file.token.as_str(), extension_with_dot); + let filename = args.app_data_root.downloads_dir().path().join(&filename); + + simple_http_download(&media_file_url, &filename).await?; + + let cookies = args.grok_creds_manager.maybe_copy_cookie_header_string()? + .ok_or_else(|| anyhow!("Missing Grok cookies"))?; + + info!("Uploading image to Grok..."); + + let response = grok_upload_file(GrokUploadFileArgs { + request: GrokUploadFileRequest { + file: PathOrFile::Path(filename.as_path()), + }, + cookie: &cookies, + domain_override: None, + request_timeout: Some(GROK_IMAGE_UPLOAD_TIMEOUT), + }).await?; + + let file_id = response.file_id + .ok_or_else(|| anyhow!("Media upload did not produce a file_id!"))?; + + Ok(UploadImageMediaFileToGrokResult { + grok_file_id: file_id, + }) +} diff --git a/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_webview_extract_cookies.rs b/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_webview_extract_cookies.rs new file mode 100644 index 00000000..2e5443cf --- /dev/null +++ b/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_webview_extract_cookies.rs @@ -0,0 +1,48 @@ +use cookie_store_wrapper::cookie_store::{CapturedCookie, CookieStore}; +use errors::AnyhowResult; +use once_cell::sync::Lazy; +use reqwest::Url; +use tauri::webview::Cookie; +use tauri::WebviewWindow; + +//static WWW_COOKIE_URL: Lazy = Lazy::new(|| { +// Url::parse("https://www.grok.com").expect("URL should parse") +//}); + +static ROOT_COOKIE_URL: Lazy = Lazy::new(|| { + Url::parse("https://grok.com").expect("URL should parse") +}); + +pub fn grok_login_webview_extract_cookies(webview: &WebviewWindow) -> AnyhowResult { + let mut cookie_store = CookieStore::empty(); + let cookies = get_all_grok_cookies(webview)?; + for cookie in cookies.iter() { + cookie_store.insert_captured( + CapturedCookie { + name: cookie.name().to_string(), + value: cookie.value().to_string(), + maybe_domain: cookie.domain().map(str::to_string), + maybe_path: cookie.path().map(str::to_string), + }, + &ROOT_COOKIE_URL, + ); + } + Ok(cookie_store) +} + +fn get_all_grok_cookies(webview: &WebviewWindow) -> AnyhowResult>> { + //let www_cookies = webview.cookies_for_url(WWW_COOKIE_URL.clone())?; + let root_cookies = webview.cookies_for_url(ROOT_COOKIE_URL.clone())?; + + let all_cookies = root_cookies; + //let mut cookie_names = HashSet::new(); + + //for cookie in root_cookies.iter() { + // if !cookie_names.contains(cookie.name()) { + // cookie_names.insert(cookie.name().to_string()); + // all_cookies.push(cookie.clone()); + // } + //} + + Ok(all_cookies) +} diff --git a/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_window_open.rs b/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_window_open.rs new file mode 100644 index 00000000..c2cddd33 --- /dev/null +++ b/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_window_open.rs @@ -0,0 +1,71 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::window::clear_all_webview_cookies::clear_all_webview_cookies; +use anyhow::anyhow; +use errors::AnyhowResult; +use once_cell::sync::Lazy; +use reqwest::Url; +use std::time::Duration; +use tauri::{AppHandle, Manager, WebviewUrl, WebviewWindowBuilder}; +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use crate::services::grok::windows::grok_login_window::grok_login_window_thread::grok_login_window_thread; + +/// Name of the window +pub (super) const GROK_LOGIN_WINDOW_NAME: &str = "grok_login_window"; + +pub (super) static START_URL: Lazy = Lazy::new(|| { + Url::parse("https://google.com").expect("URL should parse") +}); + +pub (super) static GROK_HOMEPAGE_URL: Lazy = Lazy::new(|| { + Url::parse("https://grok.com/").expect("URL should parse") +}); + +pub (super) static GROK_LOGIN_URL: Lazy = Lazy::new(|| { + Url::parse("https://accounts.x.ai/sign-in?redirect=grok-com").expect("URL should parse") +}); + +pub async fn grok_login_window_open( + app: &AppHandle, + app_data_root: &AppDataRoot, + grok_creds_manager: &GrokCredentialManager, +) -> AnyhowResult<()> { + if app.get_window(GROK_LOGIN_WINDOW_NAME).is_some() { + return Err(anyhow!("Login window already open")); + } + + let url = WebviewUrl::External(START_URL.clone()); + + let window = WebviewWindowBuilder::new(app, GROK_LOGIN_WINDOW_NAME, url) + .always_on_top(false) + .title("Login to Grok") + .center() + .resizable(true) + .visible(true) + .closable(true) + .min_inner_size(200.0, 800.0) + .focused(true) + .devtools(true) + .build()?; + + let webview = window.get_webview(GROK_LOGIN_WINDOW_NAME) + .ok_or_else(|| anyhow!("no webview found"))?; + + clear_all_webview_cookies(&webview)?; + + webview.navigate(GROK_HOMEPAGE_URL.clone())?; + + // NB: We're starting to get Cloudflare protection screens. Let's try to avoid. + tokio::time::sleep(Duration::from_millis(100)).await; + + webview.navigate(GROK_LOGIN_URL.clone())?; + + let app_handle = app.clone(); + let app_data_root = app_data_root.clone(); + let grok_creds_manager= grok_creds_manager.clone(); + + let _ = tauri::async_runtime::spawn(async move { + grok_login_window_thread(app_handle, app_data_root, grok_creds_manager).await; + }); + + Ok(()) +} diff --git a/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_window_thread.rs b/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_window_thread.rs new file mode 100644 index 00000000..9e544b49 --- /dev/null +++ b/crates/artcraftx/src/services/grok/windows/grok_login_window/grok_login_window_thread.rs @@ -0,0 +1,172 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::refresh_account_state_event::RefreshAccountStateEvent; +use crate::events::sendable_event_trait::SendableEvent; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::window::get_webview_window_hostname::get_webview_window_hostname; +use crate::services::grok::state::grok_credential_manager::GrokCredentialManager; +use crate::services::grok::windows::grok_login_window::grok_login_webview_extract_cookies::grok_login_webview_extract_cookies; +use crate::services::grok::windows::grok_login_window::grok_login_window_open::GROK_LOGIN_WINDOW_NAME; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::{error, info}; +use tauri::{AppHandle, Manager, WebviewWindow}; + +pub async fn grok_login_window_thread( + app: AppHandle, + app_data_root: AppDataRoot, + grok_creds_manager: GrokCredentialManager, +) { + let mut visited_login = false; + + loop { + let login_webview_window = match app.get_webview_window(GROK_LOGIN_WINDOW_NAME) { + Some(webview) => webview, + None => { + info!("Exit Grok login thread."); + return; // NB: Only exit if we don't have the webview. + } + }; + + let result = check_login_window( + &app, + &login_webview_window, + &app_data_root, + &grok_creds_manager, + &mut visited_login, + ).await; + + match result { + Err(err) => { + error!("Error checking Grok login window: {:?}", err); + } + Ok(false) => {} // Continue iteration and try again... + Ok(true) => { + info!("Successfully saved cookies from login window. Closing."); + if let Err(err) = login_webview_window.close() { + error!("Error closing login window: {:?}", err); + } + return; + } + } + + tokio::time::sleep(std::time::Duration::from_millis(2_000)).await; + } +} + +/// Returns true if we can exit. +async fn check_login_window( + app_handle: &AppHandle, + webview_window: &WebviewWindow, + _app_data_root: &AppDataRoot, + grok_creds_manager: &GrokCredentialManager, + visited_login: &mut bool, +) -> AnyhowResult { + + /* Login flow looks like this: + + 1. Start: https://accounts.x.ai/sign-in?redirect=grok-com + 2. SSO / Google Login (etc): https://accounts.google.com/v3/signin/challenge/pwd?[query] + 3. Done / Landing: https://grok.com/... + */ + + let hostname = get_webview_window_hostname(webview_window)?; + + let mut maybe_at_destination = false; + + match hostname.as_str() { + "www.grok.com" | + "grok.com" + => { + maybe_at_destination = true; + } + // chatgpt.com/auth is also an auth domain + "accounts.x.ai" | + "auth.openai.com" | + "accounts.google.com" | + "accounts.youtube.com" | + "login.live.com" | + "appleid.apple.com" + => { + // NB: We're in auth flow. + info!("Grok webview is in auth flow; hostname `{}`.", hostname); + *visited_login = true; + return Ok(false) + } + _ => {}, // We just don't know... + } + + let cookie_store = grok_login_webview_extract_cookies(webview_window)?; + + let maybe_has_auth_cookies = true; //cookie_store_has_auth_cookies(&cookie_store); // TODO TODO FIXME + let maybe_has_enough_cookies = cookie_store.len() > 6; + let maybe_completed_login_cycle = *visited_login && maybe_at_destination; + + // Misc cookies without login cookies are ~1055 length + // AUTH_I is ~1500 length + // AUTH_R is ~500 length + let maybe_has_big_enough_cookie = cookie_store.calculate_approx_cookie_character_length() > 2100; + + let mut heuristic_count = 0; + + if maybe_has_auth_cookies { + heuristic_count += 1; + } + if maybe_has_enough_cookies { + heuristic_count += 1; + } + if maybe_completed_login_cycle { + heuristic_count += 1; + } + if maybe_has_big_enough_cookie { + heuristic_count += 1; + } + + if heuristic_count < 3 { + return Ok(false); + } + + info!("Heuristic count is ({}); we're likely done.", heuristic_count); + + info!("Current cookies (len {}): {:?}", cookie_store.len(), cookie_store.to_cookie_string()); + + //let response = get_user_info(GetUserInfoRequest { + // hostname: MidjourneyHostname::Standard, + // cookie_header: cookie_store.to_cookie_string(), + //}).await; + + //match response { + // Err(err) => { + // error!("Error getting midjourney user info: {:?}", err); + // // NB: Fall through. Allow us to update the cookies. + // } + // Ok(user_info) => { + // info!("Got midjourney user info: {:?}", user_info); + // let user_info = MidjourneyUserInfo::from_api_response(user_info); + // + // //if let Err(err) = grok_creds_manager.replace_user_info(user_info) { + // // error!("Error saving midjourney user info: {:?}", err); + // // // NB: Fall through. Allow us to update the cookies. + // //} + // } + //} + + grok_creds_manager.replace_cookie_store(cookie_store)?; + + let result = grok_creds_manager.persist_to_disk(); + + if let Err(err) = result { + error!("Error persisting grok cookies to disk: {:?}", err); + return Ok(false); + } + + let event = RefreshAccountStateEvent { + provider: Some(GenerationSource::Grok), + }; + + if let Err(err) = event.send(&app_handle) { + error!("Failed to send RefreshAccountStateEvent: {:?}", err); // Fail open + } + + Ok(true) +} + diff --git a/crates/artcraftx/src/services/grok/windows/grok_login_window/mod.rs b/crates/artcraftx/src/services/grok/windows/grok_login_window/mod.rs new file mode 100644 index 00000000..5f818a63 --- /dev/null +++ b/crates/artcraftx/src/services/grok/windows/grok_login_window/mod.rs @@ -0,0 +1,3 @@ +pub mod grok_login_window_open; +pub (super) mod grok_login_window_thread; +pub (super) mod grok_login_webview_extract_cookies; diff --git a/crates/artcraftx/src/services/grok/windows/mod.rs b/crates/artcraftx/src/services/grok/windows/mod.rs new file mode 100644 index 00000000..66ef2bb3 --- /dev/null +++ b/crates/artcraftx/src/services/grok/windows/mod.rs @@ -0,0 +1 @@ +pub mod grok_login_window; \ No newline at end of file diff --git a/crates/artcraftx/src/services/higgsfield/higgsfield_session_from_credential.rs b/crates/artcraftx/src/services/higgsfield/higgsfield_session_from_credential.rs new file mode 100644 index 00000000..8b0e979b --- /dev/null +++ b/crates/artcraftx/src/services/higgsfield/higgsfield_session_from_credential.rs @@ -0,0 +1,71 @@ +use crate::credentials::auth_credential::AuthCredential; +use crate::error::artcraftx_error::ArtcraftXError; +use anyhow::anyhow; +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; + +/// The one way the app should talk to Higgsfield: a [`HiggsfieldSession`] +/// built from a stored `higgsfield_cookies` credential. +/// +/// The session mints and refreshes the Clerk bearer token itself, derives +/// DataDome's `x-datadome-clientid` from the `datadome` cookie, and replays +/// the cookies under the User-Agent the login window recorded — so the +/// requests look like the browser that earned the session. When a call +/// fails with `needs_browser_reauth()`, send the user back through the +/// Higgsfield login window. +pub fn higgsfield_session_from_credential(credential: &AuthCredential) -> Result { + let cookie = credential.cookies().ok_or_else(|| { + ArtcraftXError::AnyhowError(anyhow!( + "Credential {} ({}) is not a cookie credential; Higgsfield needs a website login", + credential.id, credential.service, + )) + })?; + + let mut session = HiggsfieldSession::from_cookie_header(cookie.cookie_header()); + + if let Some(user_agent) = cookie.user_agent.as_deref() { + session = session.with_user_agent(user_agent); + } + + Ok(session) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::auth_credential::CredentialSecret; + use crate::credentials::cookie_credential::CookieCredential; + use cookie_store_wrapper::cookie_store::CookieStore; + use core_types::enums::generation_source::GenerationSource; + use core_types::identifiers::credential_id::CredentialId; + use reqwest::Url; + use std::path::PathBuf; + + fn cookie_credential(user_agent: Option<&str>) -> AuthCredential { + let origin = Url::parse("https://higgsfield.ai/").unwrap(); + let cookies = CookieStore::from_cookie_header("__client=abc; datadome=dd-client-id; __session=x.y.z", &origin); + let mut cookie = CookieCredential::new(cookies); + cookie.user_agent = user_agent.map(str::to_string); + AuthCredential { + id: CredentialId::generate(), + service: GenerationSource::HiggsfieldCookies, + name: None, + secret: CredentialSecret::Cookies(cookie), + user_info: None, + source_path: PathBuf::from("/tmp/higgsfield_cookies.toml"), + } + } + + #[test] + fn session_carries_recorded_ua_and_datadome_id() { + let session = higgsfield_session_from_credential(&cookie_credential(Some("Mozilla/5.0 Recorded"))).unwrap(); + assert_eq!(session.maybe_user_agent(), Some("Mozilla/5.0 Recorded")); + assert_eq!(session.maybe_datadome_client_id(), Some("dd-client-id")); + assert!(session.cookies().has_clerk_client_cookie()); + } + + #[test] + fn missing_ua_falls_back_to_client_default() { + let session = higgsfield_session_from_credential(&cookie_credential(None)).unwrap(); + assert_eq!(session.maybe_user_agent(), None); + } +} diff --git a/crates/artcraftx/src/services/higgsfield/higgsfield_upload_notices.rs b/crates/artcraftx/src/services/higgsfield/higgsfield_upload_notices.rs new file mode 100644 index 00000000..cfa1252c --- /dev/null +++ b/crates/artcraftx/src/services/higgsfield/higgsfield_upload_notices.rs @@ -0,0 +1,59 @@ +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::Mutex; + +use router::api::asset_upload_observer::AssetUploadObserver; +use tauri::AppHandle; + +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::notice_events::flash_notice_event::FlashNoticeEvent; +use crate::events::notice_events::progress_notice_event::ProgressNotice; + +const IP_CHECK_MESSAGE: &str = "Higgsfield is checking your media for Intellectual Property and Likeness"; +const UPLOADING_MESSAGE: &str = "Uploading your media to Higgsfield"; +const REUSED_MESSAGE: &str = "Reusing media Higgsfield already has (no upload or new IP check needed)"; + +/// Turns the router's per-file upload decisions into frontend notices for +/// one Higgsfield request: +/// +/// - the first real upload puts up a progress toast (the IP/likeness check +/// routinely takes 15-30s), which stays up until this value is dropped — +/// so hold it across the enqueue, including retries; +/// - a reuse flashes a plain, progress-free notice once, since nothing is +/// being waited on. +/// +/// Without an app handle (tests, headless callers) it observes silently. +pub struct HiggsfieldUploadNotices { + maybe_app: Option, + progress: Mutex>, + reuse_announced: AtomicBool, +} + +impl HiggsfieldUploadNotices { + pub fn new(maybe_app: Option<&AppHandle>) -> Self { + Self { + maybe_app: maybe_app.cloned(), + progress: Mutex::new(None), + reuse_announced: AtomicBool::new(false), + } + } +} + +impl AssetUploadObserver for HiggsfieldUploadNotices { + fn on_reused(&self, _kind: &str, _description: &str) { + let Some(app) = &self.maybe_app else { return }; + if self.reuse_announced.swap(true, Ordering::SeqCst) { + return; + } + FlashNoticeEvent::new(REUSED_MESSAGE).send_infallible(app); + } + + fn on_uploading(&self, _kind: &str, _byte_count: u64, ip_check: bool) { + let Some(app) = &self.maybe_app else { return }; + let Ok(mut progress) = self.progress.lock() else { return }; + if progress.is_some() { + return; // One toast covers every upload of the request. + } + let message = if ip_check { IP_CHECK_MESSAGE } else { UPLOADING_MESSAGE }; + *progress = Some(ProgressNotice::start(app, message)); + } +} diff --git a/crates/artcraftx/src/services/higgsfield/mark_higgsfield_relogin_required.rs b/crates/artcraftx/src/services/higgsfield/mark_higgsfield_relogin_required.rs new file mode 100644 index 00000000..ad247687 --- /dev/null +++ b/crates/artcraftx/src/services/higgsfield/mark_higgsfield_relogin_required.rs @@ -0,0 +1,52 @@ +use log::{error, info, warn}; +use tauri::AppHandle; + +use crate::commands::generate::generate_error::CredentialProblemReason; +use crate::credentials::login_website::LoginWebsite; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::refresh_account_state_event::RefreshAccountStateEvent; +use crate::events::functional_events::show_credential_error_modal_event::ShowCredentialErrorModalEvent; +use crate::state::data_dir::app_data_root::AppDataRoot; +use core_types::enums::generation_source::GenerationSource; + +/// Background paths (task polling) found that Higgsfield rejected a stored +/// session. Mark the credential file so every caller skips it until the +/// user logs in again, and — the first time only — show the "log in again" +/// modal and refresh the account state. Silent if already marked. +pub fn mark_higgsfield_relogin_required( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + credential_id: &str, +) { + let maybe_credential = match app_data_root.credentials_dir().find_credential_by_id(credential_id) { + Ok(maybe_credential) => maybe_credential, + Err(err) => { + error!("Could not load credential {} to mark it as needing a re-login: {}", credential_id, err); + return; + } + }; + let Some(mut credential) = maybe_credential else { + warn!("Credential {} is gone; nothing to mark as needing a re-login", credential_id); + return; + }; + + match credential.mark_relogin_required() { + Ok(true) => info!("Marked Higgsfield credential {} as needing a re-login", credential_id), + Ok(false) => return, + Err(err) => { + error!("Could not mark credential {} as needing a re-login: {}", credential_id, err); + return; + } + } + + let reason = CredentialProblemReason::SessionExpired { + credential_id: credential.id.to_string(), + service: credential.service, + }; + ShowCredentialErrorModalEvent { + message: reason.user_message(), + maybe_relogin_website: LoginWebsite::for_credential_service(credential.service), + maybe_credential_id: Some(credential.id.to_string()), + }.send_infallible(app_handle); + RefreshAccountStateEvent { provider: Some(GenerationSource::Higgsfield) }.send_infallible(app_handle); +} diff --git a/crates/artcraftx/src/services/higgsfield/mod.rs b/crates/artcraftx/src/services/higgsfield/mod.rs new file mode 100644 index 00000000..66c45461 --- /dev/null +++ b/crates/artcraftx/src/services/higgsfield/mod.rs @@ -0,0 +1,4 @@ +pub mod higgsfield_session_from_credential; + +pub mod mark_higgsfield_relogin_required; +pub mod higgsfield_upload_notices; diff --git a/crates/artcraftx/src/services/local_files/file_hash_service.rs b/crates/artcraftx/src/services/local_files/file_hash_service.rs new file mode 100644 index 00000000..e1f2f061 --- /dev/null +++ b/crates/artcraftx/src/services/local_files/file_hash_service.rs @@ -0,0 +1,80 @@ +//! BLAKE3 for local files, memoized in the local_files index: when a path's +//! size and mtime match the indexed row the stored hash is returned without +//! reading the file; otherwise the file is hashed and the row refreshed. + +use std::path::Path; +use std::time::UNIX_EPOCH; + +use file_hashing::hash_file_blake3; +use local_files_database::queries::get_local_file_by_path::get_local_file_by_path; +use local_files_database::queries::upsert_local_file::{upsert_local_file, UpsertLocalFileArgs}; +use log::warn; + +use crate::state::database::local_files_database::LocalFilesDatabase; + +/// `(size, mtime_ms)` for a regular file, `None` if it's missing. +pub fn stat_file(file_path: &Path) -> Option<(i64, i64)> { + let stat = match std::fs::metadata(file_path) { + Ok(metadata) if metadata.is_file() => metadata, + _ => return None, + }; + let file_mtime_ms = stat.modified().ok() + .and_then(|mtime| mtime.duration_since(UNIX_EPOCH).ok()) + .map(|duration| duration.as_millis() as i64) + .unwrap_or(0); + Some((stat.len() as i64, file_mtime_ms)) +} + +/// The file's BLAKE3 hash, from the index when the stat matches, else by +/// reading the file (and indexing the result). +pub async fn hash_local_file_memoized(database: &LocalFilesDatabase, file_path: &Path) -> Result { + let (file_size_bytes, file_mtime_ms) = stat_file(file_path) + .ok_or_else(|| format!("{} is not a readable file", file_path.display()))?; + hash_local_file_with_stat(database, file_path, file_size_bytes, file_mtime_ms).await +} + +/// [`hash_local_file_memoized`] for a caller that already stat-ed the file. +pub async fn hash_local_file_with_stat( + database: &LocalFilesDatabase, + file_path: &Path, + file_size_bytes: i64, + file_mtime_ms: i64, +) -> Result { + let path_string = file_path.to_string_lossy().into_owned(); + + match get_local_file_by_path(database.get_connection(), &path_string).await { + Ok(Some(record)) if record.matches_stat(file_size_bytes, file_mtime_ms) => { + return Ok(record.file_hash_blake3); + } + Ok(_) => {} + Err(err) => warn!("local_files lookup failed for {}: {}", path_string, err), + } + + let hash_path = file_path.to_path_buf(); + let file_hash = tokio::task::spawn_blocking(move || hash_file_blake3(&hash_path)) + .await + .map_err(|join_error| join_error.to_string())? + .map_err(|io_error| io_error.to_string())?; + + let extension = file_extension(file_path); + let upsert = upsert_local_file(UpsertLocalFileArgs { + db: database.get_connection(), + file_path: &path_string, + maybe_file_type: (!extension.is_empty()).then_some(extension.as_str()), + file_size_bytes, + file_mtime_ms, + file_hash_blake3: &file_hash, + }).await; + if let Err(err) = upsert { + warn!("local_files upsert failed for {}: {}", path_string, err); + } + + Ok(file_hash) +} + +pub fn file_extension(file_path: &Path) -> String { + file_path.extension() + .and_then(|extension| extension.to_str()) + .map(str::to_ascii_lowercase) + .unwrap_or_default() +} diff --git a/crates/artcraftx/src/services/local_files/mod.rs b/crates/artcraftx/src/services/local_files/mod.rs new file mode 100644 index 00000000..328e355c --- /dev/null +++ b/crates/artcraftx/src/services/local_files/mod.rs @@ -0,0 +1,2 @@ +pub mod file_hash_service; +pub mod thumbnail_service; diff --git a/crates/artcraftx/src/services/local_files/thumbnail_service.rs b/crates/artcraftx/src/services/local_files/thumbnail_service.rs new file mode 100644 index 00000000..090558e6 --- /dev/null +++ b/crates/artcraftx/src/services/local_files/thumbnail_service.rs @@ -0,0 +1,401 @@ +//! Thumbnails for local files, content-addressed and cached. +//! +//! Two entry points with one cache between them: +//! +//! - [`lookup_thumbnail`] is the cheap read path (a stat and a row lookup, +//! never a file read) for request handlers. It reports what exists and +//! says `Pending` for anything the worker hasn't produced yet. +//! - [`generate_thumbnail`] is the write path, run by the thumbnail worker +//! thread: stat → BLAKE3 (from the local_files index when size+mtime +//! match, else rehash) → `cache/thumbnails/{hash}.jpg` (static) and +//! `{hash}.webp` (~1s animated preview, videos only) → record the outcome +//! (state, cache paths, error, attempt count) on the file's row. +//! +//! Everything on disk is regenerable; the database rows make lookups cheap +//! and let the worker find work without walking the cache directory. + +use std::collections::HashMap; +use std::path::{Path, PathBuf}; +use std::sync::{Arc, Mutex as StdMutex}; + +use local_files_database::queries::get_local_file_by_path::get_local_file_by_path; +use local_files_database::queries::local_file_record::LocalFileRecord; +use local_files_database::queries::set_thumbnail_result::{set_thumbnail_result, SetThumbnailResultArgs}; +use local_files_database::thumbnail_state::ThumbnailState; +use log::{info, warn}; +use once_cell::sync::Lazy; +use serde_derive::Serialize; +use thumbnails::{generate_image_thumbnail, generate_video_thumbnails, ThumbnailError, STATIC_THUMBNAIL_MAX_DIMENSION, THUMBNAIL_GENERATOR_VERSION}; +use tokio::sync::{Mutex as TokioMutex, Semaphore}; + +use crate::services::local_files::file_hash_service::{file_extension, hash_local_file_with_stat, stat_file}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; + +/// Failed generations are retried until this many attempts; after that the +/// file is left alone (a placeholder is shown). +pub const MAX_THUMBNAIL_ATTEMPTS: i64 = 3; + +/// Cap on concurrent thumbnail generations (decode + encode are CPU-heavy). +const MAX_CONCURRENT_GENERATIONS: usize = 2; + +static GENERATION_SEMAPHORE: Lazy = Lazy::new(|| Semaphore::new(MAX_CONCURRENT_GENERATIONS)); + +/// Per-path locks so the worker and a stray direct call never hash or +/// generate the same file twice at once. +static PER_PATH_LOCKS: Lazy>>>> = + Lazy::new(|| StdMutex::new(HashMap::new())); + +const IMAGE_EXTENSIONS: &[&str] = &["jpg", "jpeg", "png", "webp", "gif", "bmp", "tiff", "avif"]; +const VIDEO_EXTENSIONS: &[&str] = &["mp4", "m4v", "mov"]; + +#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum LocalThumbnailStatus { + /// A static thumbnail exists (animated preview too, when the path is set). + Ready, + /// Not generated yet; the worker thread will get to it and the frontend + /// hears about it via `local_thumbnail_ready_event`. + Pending, + /// The file type (or codec) can't be thumbnailed; show a placeholder. + Unsupported, + /// The source file no longer exists on disk. + MissingFile, + /// Generation errored and won't be retried; show a placeholder. + Failed, +} + +#[derive(Clone, Debug, Serialize)] +pub struct LocalThumbnail { + pub file_path: String, + pub status: LocalThumbnailStatus, + pub maybe_file_hash: Option, + pub maybe_thumbnail_path: Option, + pub maybe_animated_preview_path: Option, +} + +impl LocalThumbnail { + fn without_thumbnail(file_path: &Path, status: LocalThumbnailStatus, maybe_file_hash: Option) -> Self { + Self { + file_path: file_path.to_string_lossy().into_owned(), + status, + maybe_file_hash, + maybe_thumbnail_path: None, + maybe_animated_preview_path: None, + } + } + + fn ready(file_path: &Path, file_hash: String, thumbnail_jpg: &Path, animated_webp: Option<&Path>) -> Self { + Self { + file_path: file_path.to_string_lossy().into_owned(), + status: LocalThumbnailStatus::Ready, + maybe_file_hash: Some(file_hash), + maybe_thumbnail_path: Some(thumbnail_jpg.to_string_lossy().into_owned()), + maybe_animated_preview_path: animated_webp.map(|path| path.to_string_lossy().into_owned()), + } + } +} + +/// The cache paths a `local_files` row points at, if its thumbnail has been +/// generated. No disk access — the row is trusted (the worker's scan +/// re-checks disk and regenerates anything that went missing). +pub fn generated_thumbnail_paths(record: &LocalFileRecord) -> Option<(String, Option)> { + if record.thumbnail_state() != ThumbnailState::Generated { + return None; + } + let jpg = record.thumbnail_jpg_path.clone()?; + Some((jpg, record.animated_preview_webp_path.clone())) +} + +/// Whether the worker should (re)generate this row's thumbnail: never done, +/// still retryable, made by an older generator, or done but the cache file +/// is gone. +pub fn needs_generation(record: &LocalFileRecord) -> bool { + match record.thumbnail_state() { + ThumbnailState::Pending => true, + ThumbnailState::Failed => record.thumbnail_attempts < MAX_THUMBNAIL_ATTEMPTS, + ThumbnailState::Unsupported => false, + ThumbnailState::Generated => { + if record.thumbnail_generator_version < THUMBNAIL_GENERATOR_VERSION { + return true; + } + match record.thumbnail_jpg_path.as_deref() { + Some(jpg) => !Path::new(jpg).is_file(), + None => true, + } + } + } +} + +/// Cheap read: what the cache holds for one file right now. Never hashes or +/// generates; anything not yet produced is `Pending`. +pub async fn lookup_thumbnail(database: &LocalFilesDatabase, file_path: &Path) -> LocalThumbnail { + let Some((file_size_bytes, file_mtime_ms)) = stat_file(file_path) else { + return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::MissingFile, None); + }; + + let path_string = file_path.to_string_lossy().into_owned(); + let record = match get_local_file_by_path(database.get_connection(), &path_string).await { + Ok(Some(record)) if record.matches_stat(file_size_bytes, file_mtime_ms) => record, + Ok(_) => return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Pending, None), + Err(err) => { + warn!("local_files lookup failed for {}: {}", path_string, err); + return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Pending, None); + } + }; + + let file_hash = Some(record.file_hash_blake3.clone()); + match record.thumbnail_state() { + ThumbnailState::Generated => match generated_thumbnail_paths(&record) { + Some((jpg, maybe_webp)) if Path::new(&jpg).is_file() => LocalThumbnail { + file_path: path_string, + status: LocalThumbnailStatus::Ready, + maybe_file_hash: file_hash, + maybe_thumbnail_path: Some(jpg), + maybe_animated_preview_path: maybe_webp, + }, + // Cache file gone; the worker regenerates on its next scan. + _ => LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Pending, file_hash), + }, + ThumbnailState::Unsupported => LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Unsupported, file_hash), + ThumbnailState::Failed if record.thumbnail_attempts >= MAX_THUMBNAIL_ATTEMPTS => { + LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Failed, file_hash) + } + ThumbnailState::Failed | ThumbnailState::Pending => { + LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Pending, file_hash) + } + } +} + +/// Produce (or confirm) the cached thumbnails for one file and record the +/// outcome on its row. The worker thread's unit of work. +pub async fn generate_thumbnail( + database: &LocalFilesDatabase, + app_data_root: &AppDataRoot, + file_path: &Path, +) -> LocalThumbnail { + // Serialize work per path; overlapping calls wait, then hit the cache. + let path_lock = per_path_lock(file_path); + let _path_guard = path_lock.lock().await; + + let Some((file_size_bytes, file_mtime_ms)) = stat_file(file_path) else { + return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::MissingFile, None); + }; + + let file_hash = match hash_local_file_with_stat(database, file_path, file_size_bytes, file_mtime_ms).await { + Ok(hash) => hash, + Err(message) => { + warn!("Could not hash {}: {}", file_path.display(), message); + return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Failed, None); + } + }; + + let thumbnails_dir = match app_data_root.cache_dir().get_or_create_thumbnails_dir() { + Ok(dir) => dir, + Err(err) => { + warn!("Could not create thumbnails cache dir: {}", err); + return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Failed, Some(file_hash)); + } + }; + let thumbnail_jpg = thumbnails_dir.join(format!("{file_hash}.jpg")); + let animated_webp = thumbnails_dir.join(format!("{file_hash}.webp")); + + let extension = file_extension(file_path); + let kind = if IMAGE_EXTENSIONS.contains(&extension.as_str()) { + MediaKind::Image + } else if VIDEO_EXTENSIONS.contains(&extension.as_str()) { + MediaKind::Video + } else { + record_outcome(database, file_path, ThumbnailState::Unsupported, None, None, Some(&format!("unsupported extension {extension:?}"))).await; + return LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Unsupported, Some(file_hash)); + }; + + // Already in the cache (same content seen at another path, or a previous + // run of this generator): just point the row at it. Videos count as + // cached only with their animated preview, so an earlier partial result + // gets completed; older generators' output is always redone. + let made_by_current_generator = get_local_file_by_path(database.get_connection(), &file_path.to_string_lossy()).await + .ok() + .flatten() + .is_some_and(|record| record.thumbnail_generator_version >= THUMBNAIL_GENERATOR_VERSION); + let cache_complete = made_by_current_generator && thumbnail_jpg.is_file() && match kind { + MediaKind::Image => true, + MediaKind::Video => animated_webp.is_file(), + }; + if cache_complete { + let has_webp = animated_webp.is_file(); + record_outcome(database, file_path, ThumbnailState::Generated, Some(&thumbnail_jpg), has_webp.then_some(&animated_webp), None).await; + return LocalThumbnail::ready(file_path, file_hash, &thumbnail_jpg, has_webp.then_some(animated_webp.as_path())); + } + + let generation = { + let _permit = GENERATION_SEMAPHORE.acquire().await.expect("semaphore never closes"); + let source = file_path.to_path_buf(); + let jpg = thumbnail_jpg.clone(); + let webp = animated_webp.clone(); + tokio::task::spawn_blocking(move || generate(kind, &source, &jpg, &webp)).await + }; + + match generation { + Ok(Ok(wrote_animated_preview)) => { + info!("Generated thumbnail for {} -> {}", file_path.display(), thumbnail_jpg.display()); + record_outcome(database, file_path, ThumbnailState::Generated, Some(&thumbnail_jpg), wrote_animated_preview.then_some(&animated_webp), None).await; + LocalThumbnail::ready(file_path, file_hash, &thumbnail_jpg, wrote_animated_preview.then_some(animated_webp.as_path())) + } + Ok(Err(err)) if err.is_unsupported() => { + info!("Media not thumbnailable ({}): {}", file_path.display(), err); + record_outcome(database, file_path, ThumbnailState::Unsupported, None, None, Some(&err.to_string())).await; + LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Unsupported, Some(file_hash)) + } + Ok(Err(err)) => { + warn!("Thumbnail generation failed for {}: {}", file_path.display(), err); + record_outcome(database, file_path, ThumbnailState::Failed, None, None, Some(&err.to_string())).await; + LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Failed, Some(file_hash)) + } + Err(join_error) => { + warn!("Thumbnail generation task panicked for {}: {}", file_path.display(), join_error); + record_outcome(database, file_path, ThumbnailState::Failed, None, None, Some(&join_error.to_string())).await; + LocalThumbnail::without_thumbnail(file_path, LocalThumbnailStatus::Failed, Some(file_hash)) + } + } +} + +// ── Private ── + +#[derive(Copy, Clone, Debug)] +enum MediaKind { + Image, + Video, +} + +/// Returns whether an animated preview was written alongside the static jpg. +fn generate(kind: MediaKind, source: &Path, jpg: &Path, webp: &Path) -> Result { + match kind { + MediaKind::Image => { + generate_image_thumbnail(source, jpg, STATIC_THUMBNAIL_MAX_DIMENSION)?; + Ok(false) + } + MediaKind::Video => { + let outcome = generate_video_thumbnails(source, jpg, webp)?; + Ok(outcome.wrote_animated_preview) + } + } +} + +async fn record_outcome( + database: &LocalFilesDatabase, + file_path: &Path, + state: ThumbnailState, + maybe_jpg: Option<&Path>, + maybe_webp: Option<&Path>, + maybe_error: Option<&str>, +) { + let path_string = file_path.to_string_lossy(); + let jpg = maybe_jpg.map(|path| path.to_string_lossy().into_owned()); + let webp = maybe_webp.map(|path| path.to_string_lossy().into_owned()); + let result = set_thumbnail_result(SetThumbnailResultArgs { + db: database.get_connection(), + file_path: &path_string, + state, + generator_version: THUMBNAIL_GENERATOR_VERSION, + maybe_thumbnail_jpg_path: jpg.as_deref(), + maybe_animated_preview_webp_path: webp.as_deref(), + maybe_error, + }).await; + match result { + Ok(true) => {} + Ok(false) => warn!("No local_files row to record thumbnail state for {}", path_string), + Err(err) => warn!("Could not record thumbnail state for {}: {}", path_string, err), + } +} + +fn per_path_lock(file_path: &Path) -> Arc> { + let mut locks = PER_PATH_LOCKS.lock().expect("lock poisoned"); + locks.entry(file_path.to_path_buf()).or_default().clone() +} + +#[cfg(test)] +mod tests { + use super::*; + + // The 4-second H.264 clip the higgsfield_client live tests upload. + const H264_FIXTURE: &str = concat!( + env!("CARGO_MANIFEST_DIR"), + "/../api_clients/higgsfield_client/test_assets/clip_4s.mp4", + ); + + /// The worker's write path against a throwaway data root and index. + #[tokio::test] + async fn generates_records_and_then_serves_a_video_thumbnail() { + let dir = tempfile::tempdir().unwrap(); + let app_data_root = AppDataRoot::create_existing(dir.path().join("root")).unwrap(); + let database = LocalFilesDatabase::connect(&app_data_root).await.unwrap(); + let video = dir.path().join("downloaded.mp4"); + std::fs::copy(H264_FIXTURE, &video).unwrap(); + + // Nothing yet: the read path says pending without touching the file. + let before = lookup_thumbnail(&database, &video).await; + assert_eq!(before.status, LocalThumbnailStatus::Pending); + assert!(before.maybe_file_hash.is_none()); + + let generated = generate_thumbnail(&database, &app_data_root, &video).await; + assert_eq!(generated.status, LocalThumbnailStatus::Ready); + let jpg = PathBuf::from(generated.maybe_thumbnail_path.clone().unwrap()); + let webp = PathBuf::from(generated.maybe_animated_preview_path.clone().unwrap()); + assert!(jpg.is_file(), "static thumbnail written"); + assert!(webp.is_file(), "animated preview written"); + // Content-addressed under the cache dir. + let hash = generated.maybe_file_hash.clone().unwrap(); + assert_eq!(jpg.file_name().unwrap().to_str().unwrap(), format!("{hash}.jpg")); + assert!(jpg.starts_with(app_data_root.cache_dir().get_or_create_thumbnails_dir().unwrap())); + + // The row records the outcome, so readers never stat the cache. + let record = get_local_file_by_path(database.get_connection(), &video.to_string_lossy()).await.unwrap().unwrap(); + assert_eq!(record.thumbnail_state(), ThumbnailState::Generated); + assert_eq!(record.thumbnail_attempts, 1); + assert_eq!(record.thumbnail_generator_version, THUMBNAIL_GENERATOR_VERSION); + assert!(record.has_thumbnail && record.has_animated_preview); + assert_eq!(record.thumbnail_jpg_path.as_deref(), Some(jpg.to_str().unwrap())); + assert!(!needs_generation(&record)); + assert_eq!(generated_thumbnail_paths(&record), Some((jpg.to_string_lossy().into_owned(), Some(webp.to_string_lossy().into_owned())))); + + let served = lookup_thumbnail(&database, &video).await; + assert_eq!(served.status, LocalThumbnailStatus::Ready); + assert_eq!(served.maybe_thumbnail_path.as_deref(), Some(jpg.to_str().unwrap())); + assert_eq!(served.maybe_animated_preview_path.as_deref(), Some(webp.to_str().unwrap())); + + // A second pass is a cache hit (no re-decode) that just re-confirms. + let again = generate_thumbnail(&database, &app_data_root, &video).await; + assert_eq!(again.status, LocalThumbnailStatus::Ready); + + // Cache file deleted: the read path degrades to pending and the scan + // wants it regenerated. + std::fs::remove_file(&jpg).unwrap(); + let record = get_local_file_by_path(database.get_connection(), &video.to_string_lossy()).await.unwrap().unwrap(); + assert!(needs_generation(&record)); + assert_eq!(lookup_thumbnail(&database, &video).await.status, LocalThumbnailStatus::Pending); + let regenerated = generate_thumbnail(&database, &app_data_root, &video).await; + assert_eq!(regenerated.status, LocalThumbnailStatus::Ready); + assert!(jpg.is_file()); + } + + #[tokio::test] + async fn unsupported_and_missing_files_are_reported_not_retried() { + let dir = tempfile::tempdir().unwrap(); + let app_data_root = AppDataRoot::create_existing(dir.path().join("root")).unwrap(); + let database = LocalFilesDatabase::connect(&app_data_root).await.unwrap(); + + let text = dir.path().join("notes.txt"); + std::fs::write(&text, b"not media").unwrap(); + let result = generate_thumbnail(&database, &app_data_root, &text).await; + assert_eq!(result.status, LocalThumbnailStatus::Unsupported); + let record = get_local_file_by_path(database.get_connection(), &text.to_string_lossy()).await.unwrap().unwrap(); + assert_eq!(record.thumbnail_state(), ThumbnailState::Unsupported); + assert!(!needs_generation(&record)); + assert_eq!(lookup_thumbnail(&database, &text).await.status, LocalThumbnailStatus::Unsupported); + + let missing = dir.path().join("gone.mp4"); + assert_eq!(generate_thumbnail(&database, &app_data_root, &missing).await.status, LocalThumbnailStatus::MissingFile); + assert_eq!(lookup_thumbnail(&database, &missing).await.status, LocalThumbnailStatus::MissingFile); + } +} diff --git a/crates/artcraftx/src/services/midjourney/completion/finalize_midjourney_job.rs b/crates/artcraftx/src/services/midjourney/completion/finalize_midjourney_job.rs new file mode 100644 index 00000000..381ca1f2 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/completion/finalize_midjourney_job.rs @@ -0,0 +1,77 @@ +use crate::services::midjourney::utils::download_midjourney_image::download_midjourney_image; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::task_completion::complete_task_with_local_files::{complete_task_with_local_files, CompleteTaskArgs}; +use crate::threads::task_completion::upload_results_to_artcraft::CompletionPrompt; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use midjourney_client::utils::image_downloader_client::ImageDownloaderClient; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use tauri::AppHandle; + +/// How many images a Midjourney job produces (the 2x2 grid). +const MIDJOURNEY_GRID_SIZE: u8 = 4; + +/// Download filename slug when the task has no model type recorded. +const MIDJOURNEY_FALLBACK_MODEL_SLUG: &str = "midjourney"; + +pub struct FinalizeMidjourneyJobArgs<'a> { + pub app_handle: &'a AppHandle, + pub app_data_root: &'a AppDataRoot, + pub app_preferences: &'a AppPreferencesManager, + pub task_database: &'a TaskDatabase, + pub image_downloader: &'a ImageDownloaderClient, + pub midjourney_job_id: &'a str, + pub local_task: &'a Task, + pub model_type: CommonModelType, + pub maybe_full_command: Option, +} + +/// The completion routine for a Midjourney job: download the four +/// full-resolution images (from the deterministic CDN URL), then hand them to +/// the shared completion routine. +/// +/// Both the websocket fast path and the long-polling fallback call this. It is +/// safe to call from both concurrently: the shared routine finalizes via +/// `update_successful_task_status_with_metadata`, which no-ops (returns false) +/// once a task is already complete — so whichever path gets there first wins. +/// +/// Returns `Ok(true)` if this call finalized the task, `Ok(false)` if it was +/// already finalized by someone else. +pub async fn finalize_midjourney_job(args: FinalizeMidjourneyJobArgs<'_>) -> AnyhowResult { + let FinalizeMidjourneyJobArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + image_downloader, + midjourney_job_id, + local_task, + model_type, + maybe_full_command, + } = args; + + let mut local_files = Vec::with_capacity(MIDJOURNEY_GRID_SIZE as usize); + for index in 0..MIDJOURNEY_GRID_SIZE { + local_files.push(download_midjourney_image(image_downloader, midjourney_job_id, index, app_data_root).await?); + } + + complete_task_with_local_files(CompleteTaskArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + task: local_task, + generation_provider: GenerationSource::Midjourney, + media_class: TaskMediaFileClass::Image, + prompt: CompletionPrompt::Create { + model_type, + maybe_prompt: maybe_full_command, + }, + fallback_model_slug: MIDJOURNEY_FALLBACK_MODEL_SLUG, + local_files: &local_files, + }).await +} diff --git a/crates/artcraftx/src/services/midjourney/completion/mod.rs b/crates/artcraftx/src/services/midjourney/completion/mod.rs new file mode 100644 index 00000000..0e6c7b8a --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/completion/mod.rs @@ -0,0 +1 @@ +pub mod finalize_midjourney_job; diff --git a/crates/artcraftx/src/services/midjourney/mod.rs b/crates/artcraftx/src/services/midjourney/mod.rs new file mode 100644 index 00000000..20aca60d --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/mod.rs @@ -0,0 +1,5 @@ +pub mod completion; +pub mod state; +pub mod threads; +pub mod utils; +pub mod windows; \ No newline at end of file diff --git a/crates/artcraftx/src/services/midjourney/state/legacy_credential_paths.rs b/crates/artcraftx/src/services/midjourney/state/legacy_credential_paths.rs new file mode 100644 index 00000000..149746d4 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/state/legacy_credential_paths.rs @@ -0,0 +1,18 @@ +//! Legacy on-disk credential paths for Midjourney. +//! +//! TODO(artcraftx): retire once Midjourney moves to the unified TOML +//! credential store in `crate::credentials`. + +use crate::state::data_dir::subdirectory::app_credentials_dir::AppCredentialsDir; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::path::PathBuf; + +pub trait MidjourneyLegacyCredentialPaths { + fn get_midjourney_state_path(&self) -> PathBuf; +} + +impl MidjourneyLegacyCredentialPaths for AppCredentialsDir { + fn get_midjourney_state_path(&self) -> PathBuf { + self.path().join("midjourney_state.json") + } +} diff --git a/crates/artcraftx/src/services/midjourney/state/midjourney_credential_manager.rs b/crates/artcraftx/src/services/midjourney/state/midjourney_credential_manager.rs new file mode 100644 index 00000000..2b05459f --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/state/midjourney_credential_manager.rs @@ -0,0 +1,188 @@ +use crate::services::midjourney::state::legacy_credential_paths::MidjourneyLegacyCredentialPaths; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::midjourney::state::midjourney_user_info::MidjourneyUserInfo; +use crate::services::midjourney::state::serializable_midjourney_state::{SerializableMidjourneyState, SERIALIZABLE_MIDJOURNEY_STATE_VERSION}; +use cookie_store_wrapper::cookie_store::CookieStore; +use errors::AnyhowResult; +use log::{info, warn}; +use std::fs::read_to_string; +use std::sync::{Arc, RwLock}; +use midjourney_client::credentials::cookie_store_has_auth_cookies::cookie_store_has_auth_cookies; + +#[derive(Clone)] +pub struct MidjourneyCredentialManager { + // TODO: Put last write/last read timestamps on these. + cookies: Arc>>, + user_info: Arc>>, + app_data_root: AppDataRoot, +} + +impl MidjourneyCredentialManager { + pub fn initialize_empty(app_data_root: &AppDataRoot) -> Self { + Self { + cookies: Arc::new(RwLock::new(None)), + user_info: Arc::new(RwLock::new(None)), + app_data_root: app_data_root.clone(), + } + } + + pub fn initialize_from_disk_infallible(app_data_root: &AppDataRoot) -> Self { + let cookies; + let user_info; + + match read_midjourney_state_from_disk(app_data_root) { + Err(err) => { + warn!("Failed to read midjourney state from disk: {:?}", err); + cookies = Arc::new(RwLock::new(None)); + user_info = Arc::new(RwLock::new(None)); + }, + Ok(None) => { + cookies = Arc::new(RwLock::new(None)); + user_info = Arc::new(RwLock::new(None)); + } + Ok(Some(state)) => { + let maybe_cookies = state.user_cookies; + let maybe_user_info = state.user_info + .map(|info| info.to_user_info()); + cookies = Arc::new(RwLock::new(maybe_cookies)); + user_info = Arc::new(RwLock::new(maybe_user_info)); + } + }; + + Self { + cookies, + user_info, + app_data_root: app_data_root.clone(), + } + } + + pub fn maybe_copy_cookie_store(&self) -> anyhow::Result> { + match self.cookies.read() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(store) => Ok(store.clone()), + } + } + + pub fn maybe_copy_user_info(&self) -> anyhow::Result> { + match self.user_info.read() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(info) => Ok(info.clone()), + } + } + + pub fn replace_cookie_store(&self, store: CookieStore) -> anyhow::Result<()> { + match self.cookies.write() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut current_store) => { + *current_store = Some(store); + Ok(()) + } + } + } + + pub fn replace_user_info(&self, user_info: MidjourneyUserInfo) -> anyhow::Result<()> { + match self.user_info.write() { + Err(err) => Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut current_info) => { + *current_info = Some(user_info); + Ok(()) + } + } + } + + // NB: This is just a heuristic. We'll add better checks later. + pub fn session_appears_active(&self) -> anyhow::Result { + let maybe_cookies = match self.cookies.read() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => store.clone(), + }; + + let maybe_user_info = match self.user_info.read() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(info) => info.clone(), + }; + + if maybe_cookies.is_none() || maybe_user_info.is_none() { + return Ok(false); + } + + let cookies = maybe_cookies.unwrap(); + let user_info = maybe_user_info.unwrap(); + + // NB: We consider the session active if we have auth cookies and a user id. + let has_user_id = user_info.user_id.is_some(); + let maybe_has_auth_cookies = cookie_store_has_auth_cookies(&cookies); + + // Misc cookies without login cookies are ~1055 length + // AUTH_I is ~1500 length + // AUTH_R is ~500 length + let maybe_has_big_enough_cookie = cookies.calculate_approx_cookie_character_length() > 2100; + + // TODO: Heuristic should count. + // TODO: Consolidate with "login window thread" logic. + // TODO: Check timestamp of last valid request. + Ok(has_user_id && maybe_has_auth_cookies && maybe_has_big_enough_cookie && maybe_has_big_enough_cookie) + } + + pub fn clear_credentials(&self) -> anyhow::Result<()> { + match self.cookies.write() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => *store = None, + } + match self.user_info.write() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut info) => *info = None, + } + Ok(()) + } + + pub fn persist_to_disk(&self) -> anyhow::Result<()> { + let maybe_cookies = match self.cookies.read() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => store.clone(), + }; + + let maybe_user_info = match self.user_info.read() { + Err(err) => return Err(anyhow::anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(info) => info.clone(), + }; + + let maybe_user_info= maybe_user_info + .map(|info| info.to_serializable()); + + if maybe_cookies.is_none() && maybe_user_info.is_none() { + info!("Nothing to write to disk, skipping."); + return Ok(()); + + } + + let state = SerializableMidjourneyState { + version: SERIALIZABLE_MIDJOURNEY_STATE_VERSION, + user_cookies: maybe_cookies, + user_info: maybe_user_info, + }; + + let path = self.app_data_root.credentials_dir().get_midjourney_state_path(); + let serialized = serde_json::to_string(&state)?; + + std::fs::write(path, serialized)?; + + Ok(()) + } +} + +fn read_midjourney_state_from_disk(root: &AppDataRoot) -> AnyhowResult> { + let midjourney_state_path= root.credentials_dir().get_midjourney_state_path(); + + if !midjourney_state_path.exists() { + return Ok(None); + } + + let contents = read_to_string(&midjourney_state_path)? + .trim() + .to_string(); + + let state: SerializableMidjourneyState = serde_json::from_str(&contents)?; + + Ok(Some(state)) +} diff --git a/crates/artcraftx/src/services/midjourney/state/midjourney_live_session.rs b/crates/artcraftx/src/services/midjourney/state/midjourney_live_session.rs new file mode 100644 index 00000000..cc7bd0ed --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/state/midjourney_live_session.rs @@ -0,0 +1,119 @@ +use midjourney_client::client::websocket::midjourney_websocket::MidjourneyWebSocket; +use midjourney_client::credentials::midjourney_user_id::MidjourneyUserId; +use std::collections::HashMap; +use std::sync::{Arc, PoisonError, RwLock}; + +/// In-memory, process-lifetime Midjourney session state. +/// +/// Distinct from the on-disk cookie credential (which lives in the TOML +/// credential store): this holds the *live* session bits that are cheap to +/// re-derive and should not be persisted — the resolved `user_id`, the +/// short-lived `websocket_token`, and the currently-open websocket handle. +/// +/// All fields start `None`. On the first enqueue we resolve the identity and +/// open a websocket; if the websocket dies we drop the handle so the next +/// enqueue re-opens one. The completion path prefers a live websocket and only +/// falls back to the HTTP status/download endpoints when it has terminated. +/// +/// Cheaply clonable (`Arc`-backed); every clone shares the same state. +#[derive(Clone, Default)] +pub struct MidjourneyLiveSession { + inner: Arc>, +} + +#[derive(Default)] +struct MidjourneyLiveSessionInner { + user_id: Option, + websocket_token: Option, + websocket: Option, + + /// Prompt text captured at enqueue, keyed by Midjourney job id. The + /// websocket completion path uses it to attribute the created Storyteller + /// prompt (the `Completed` frame does not carry the prompt). Consumed on + /// finalize. + pending_prompts: HashMap, +} + +impl MidjourneyLiveSession { + pub fn new() -> Self { + Self::default() + } + + pub fn user_id(&self) -> Option { + self.read(|inner| inner.user_id.clone()) + } + + pub fn websocket_token(&self) -> Option { + self.read(|inner| inner.websocket_token.clone()) + } + + /// Record the identity resolved from `get_user_info` (index-page scrape). + pub fn set_identity(&self, user_id: MidjourneyUserId, websocket_token: Option) { + self.write(|inner| { + inner.user_id = Some(user_id); + if websocket_token.is_some() { + inner.websocket_token = websocket_token; + } + }); + } + + /// The live websocket handle if one is currently open AND still connected. + /// A terminated socket is dropped as a side effect so the next enqueue + /// re-opens one. + pub fn connected_websocket(&self) -> Option { + // Fast path: read lock to check. + let maybe_connected = self.read(|inner| { + inner.websocket.as_ref().map(|ws| (ws.clone(), ws.is_connected())) + }); + + match maybe_connected { + Some((ws, true)) => Some(ws), + Some((_, false)) => { + self.clear_websocket(); + None + } + None => None, + } + } + + pub fn set_websocket(&self, websocket: MidjourneyWebSocket) { + self.write(|inner| inner.websocket = Some(websocket)); + } + + /// Remember the prompt for a just-enqueued job so the completion path can + /// attribute it even when the source (websocket `Completed`) omits it. + pub fn record_pending_prompt(&self, job_id: String, prompt: String) { + self.write(|inner| { + inner.pending_prompts.insert(job_id, prompt); + }); + } + + /// Consume the stashed prompt for a job (returns `None` if unknown). + pub fn take_pending_prompt(&self, job_id: &str) -> Option { + self.write(|inner| inner.pending_prompts.remove(job_id)) + } + + pub fn clear_websocket(&self) { + self.write(|inner| inner.websocket = None); + } + + /// Clears everything (e.g. on logout / credential change). + pub fn clear(&self) { + self.write(|inner| { + inner.user_id = None; + inner.websocket_token = None; + inner.websocket = None; + inner.pending_prompts.clear(); + }); + } + + fn read(&self, reader: impl FnOnce(&MidjourneyLiveSessionInner) -> R) -> R { + let guard = self.inner.read().unwrap_or_else(PoisonError::into_inner); + reader(&guard) + } + + fn write(&self, writer: impl FnOnce(&mut MidjourneyLiveSessionInner) -> R) -> R { + let mut guard = self.inner.write().unwrap_or_else(PoisonError::into_inner); + writer(&mut guard) + } +} diff --git a/crates/artcraftx/src/services/midjourney/state/midjourney_user_info.rs b/crates/artcraftx/src/services/midjourney/state/midjourney_user_info.rs new file mode 100644 index 00000000..258804ff --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/state/midjourney_user_info.rs @@ -0,0 +1,30 @@ +use midjourney_client::credentials::midjourney_user_id::MidjourneyUserId; +use midjourney_client::recipes::get_user_info::GetUserInfoResponse; +use crate::services::midjourney::state::serializable_midjourney_state::SerializableMidjourneyUserInfo; + +#[derive(Clone)] +pub struct MidjourneyUserInfo { + pub user_id: Option, + pub email: Option, + pub websocket_token: Option, +} + +impl MidjourneyUserInfo { + pub fn to_serializable(&self) -> SerializableMidjourneyUserInfo { + SerializableMidjourneyUserInfo { + user_id: self.user_id + .as_ref() + .map(|id| id.to_string()), + email: self.email.clone(), + websocket_token: self.websocket_token.clone(), + } + } + + pub fn from_api_response(response: GetUserInfoResponse) -> Self { + Self { + user_id: response.user_id, + email: response.email, + websocket_token: response.websocket_token, + } + } +} diff --git a/crates/artcraftx/src/services/midjourney/state/mod.rs b/crates/artcraftx/src/services/midjourney/state/mod.rs new file mode 100644 index 00000000..ae56d7a8 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/state/mod.rs @@ -0,0 +1,5 @@ +pub mod legacy_credential_paths; +pub (super) mod serializable_midjourney_state; +pub mod midjourney_credential_manager; +pub mod midjourney_live_session; +pub mod midjourney_user_info; \ No newline at end of file diff --git a/crates/artcraftx/src/services/midjourney/state/serializable_midjourney_state.rs b/crates/artcraftx/src/services/midjourney/state/serializable_midjourney_state.rs new file mode 100644 index 00000000..7696f53b --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/state/serializable_midjourney_state.rs @@ -0,0 +1,41 @@ +use crate::services::midjourney::state::midjourney_user_info::MidjourneyUserInfo; +use cookie_store_wrapper::cookie_store::CookieStore; +use midjourney_client::credentials::midjourney_user_id::MidjourneyUserId; +use serde_derive::{Deserialize, Serialize}; + +pub (super) const SERIALIZABLE_MIDJOURNEY_STATE_VERSION: u32 = 1; + +#[derive(Serialize, Deserialize)] +pub (super) struct SerializableMidjourneyState { + pub (super) version: u32, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) user_cookies: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) user_info: Option, +} + +#[derive(Serialize, Deserialize)] +pub (super) struct SerializableMidjourneyUserInfo { + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) user_id: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) email: Option, + + #[serde(skip_serializing_if = "Option::is_none")] + pub (super) websocket_token: Option, +} + +impl SerializableMidjourneyUserInfo { + pub fn to_user_info(&self) -> MidjourneyUserInfo { + MidjourneyUserInfo { + user_id: self.user_id + .as_deref() + .map(|id| MidjourneyUserId::from_str(id)), + email: self.email.clone(), + websocket_token: self.websocket_token.clone(), + } + } +} diff --git a/crates/artcraftx/src/services/midjourney/threads/midjourney_long_polling_thread.rs b/crates/artcraftx/src/services/midjourney/threads/midjourney_long_polling_thread.rs new file mode 100644 index 00000000..c5158c42 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/threads/midjourney_long_polling_thread.rs @@ -0,0 +1,241 @@ +use crate::credentials::find_service_credentials::find_first_credential_for_service; +use crate::services::midjourney::completion::finalize_midjourney_job::{ + finalize_midjourney_job, FinalizeMidjourneyJobArgs, +}; +use crate::services::midjourney::state::midjourney_live_session::MidjourneyLiveSession; +use crate::services::midjourney::utils::extract_midjourney_user_id_from_cookies::extract_midjourney_user_id_from_cookie_header; +use crate::services::midjourney::utils::midjourney_browser_profile::midjourney_browser_profile; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::database::task_database_pending_statuses::TASK_DATABASE_PENDING_STATUSES; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::{error, warn}; +use midjourney_client::credentials::midjourney_user_id::MidjourneyUserId; +use midjourney_client::endpoints::imagine::{imagine, ImagineArgs, ImagineItem, ImagineRequest, MidjourneyJobType}; +use midjourney_client::recipes::get_user_info::{get_user_info, GetUserInfoArgs}; +use midjourney_client::utils::image_downloader_client::ImageDownloaderClient; +use sqlite_database::queries::read::list_tasks_by_provider_and_status::{ + list_tasks_by_provider_and_status, ListTasksByProviderAndStatusArgs, TaskList, +}; +use sqlite_database::queries::task::Task; +use std::collections::HashMap; +use tauri::AppHandle; + +const SLEEP_NO_SESSION_MS: u64 = 30_000; +const SLEEP_BETWEEN_TASKS_MS: u64 = 2_000; +const SLEEP_AFTER_BATCH_MS: u64 = 60_000; +const SLEEP_ON_ERROR_MS: u64 = 30_000; + +/// Fallback completion thread for first-party Midjourney jobs: it reconciles +/// pending `Midjourney` tasks against the account's `imagine` feed and finalizes +/// any that are ready. The websocket thread is the fast path; this catches +/// anything it missed (socket down, job not streamed). Both call the shared +/// `finalize_midjourney_job`, which dedups via the task-status update. +pub async fn midjourney_long_polling_thread( + app_handle: AppHandle, + app_data_root: AppDataRoot, + app_preferences: AppPreferencesManager, + task_database: TaskDatabase, + mj_session: MidjourneyLiveSession, + storyteller_creds_manager: StorytellerCredentialManager, +) -> ! { + loop { + let res = polling_loop( + &app_handle, + &app_data_root, + &app_preferences, + &task_database, + &mj_session, + &storyteller_creds_manager, + ).await; + if let Err(err) = res { + error!("Midjourney polling error: {:?}", err); + } + // NB: Only reached if the loop errors out. + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_ON_ERROR_MS)).await; + } +} + +async fn polling_loop( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + mj_session: &MidjourneyLiveSession, + // Uploads now go to the backup account (see `services::backup`), not the session. + _storyteller_creds_manager: &StorytellerCredentialManager, +) -> AnyhowResult<()> { + loop { + // Cookie credential comes from the unified TOML store. + let cookie_header = match midjourney_cookie_header(app_data_root) { + Some(header) => header, + None => { + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_NO_SESSION_MS)).await; + continue; + } + }; + + + let user_id = match resolve_user_id(mj_session, &cookie_header).await { + Some(user_id) => user_id, + None => { + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_NO_SESSION_MS)).await; + continue; + } + }; + + let local_tasks = list_tasks_by_provider_and_status(ListTasksByProviderAndStatusArgs { + db: task_database.get_connection(), + provider: GenerationSource::Midjourney, + task_statuses: &TASK_DATABASE_PENDING_STATUSES, + }).await?; + + poll_midjourney_tasks( + app_handle, + app_data_root, + app_preferences, + task_database, + mj_session, + &cookie_header, + &user_id, + local_tasks, + ).await?; + + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_BETWEEN_TASKS_MS)).await; + } +} + +async fn poll_midjourney_tasks( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + mj_session: &MidjourneyLiveSession, + cookie_header: &str, + mj_user_id: &MidjourneyUserId, + local_tasks: TaskList, +) -> AnyhowResult<()> { + let local_tasks = local_tasks.tasks; + if local_tasks.is_empty() { + return Ok(()); + } + + let local_tasks_by_job_id = local_tasks + .iter() + .filter_map(|task| task.provider_job_id.clone().map(|job_id| (job_id, task.clone()))) + .collect::>(); + + let midjourney_result = imagine(ImagineArgs { + request: ImagineRequest { user_id: mj_user_id, page_size: None }, + cookie_header, + hostname: None, + browser: Some(midjourney_browser_profile()), + }).await?; + + let midjourney_items_by_id = midjourney_result + .items + .iter() + .filter_map(|item| item.id.clone().map(|id| (id, item.clone()))) + .collect::>(); + + let image_downloader = ImageDownloaderClient::create(Some(midjourney_browser_profile()))?; + + for (job_id, local_task) in local_tasks_by_job_id.iter() { + let Some(item) = midjourney_items_by_id.get(job_id) else { + continue; // Not ready (or not present) in the feed yet. + }; + + // Prefer the feed's command; fall back to the prompt we stashed at enqueue. + let maybe_full_command = item + .full_command + .clone() + .or_else(|| mj_session.take_pending_prompt(job_id)); + + let result = finalize_midjourney_job(FinalizeMidjourneyJobArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + image_downloader: &image_downloader, + midjourney_job_id: job_id, + local_task, + model_type: job_type_to_model_type(job_id, item), + maybe_full_command, + }).await; + + if let Err(err) = result { + error!("Failed to finalize Midjourney job {}: {:?}", job_id, err); + } + + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_BETWEEN_TASKS_MS)).await; + } + + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_AFTER_BATCH_MS)).await; + Ok(()) +} + +// ── Helpers ── + +/// The cookie header for the stored `MidjourneyCookies` credential (TOML store). +pub(crate) fn midjourney_cookie_header(app_data_root: &AppDataRoot) -> Option { + let credential = find_first_credential_for_service(app_data_root, GenerationSource::MidjourneyCookies)?; + let cookie = credential.cookies()?; + Some(cookie.cookie_header()) +} + +/// The Midjourney user id, from the live session or resolved once via the +/// index page (and cached). +pub(crate) async fn resolve_user_id( + mj_session: &MidjourneyLiveSession, + cookie_header: &str, +) -> Option { + if let Some(user_id) = mj_session.user_id() { + return Some(user_id); + } + + // Prefer the auth-cookie JWT (no network, not Cloudflare-gated). + if let Some(user_id) = extract_midjourney_user_id_from_cookie_header(cookie_header) { + mj_session.set_identity(user_id.clone(), None); + return Some(user_id); + } + + // Fall back to the index page (needed for the websocket token anyway). + let info = get_user_info(GetUserInfoArgs { + cookie_header, + hostname: None, + browser: Some(midjourney_browser_profile()), + }).await; + + match info { + Ok(info) => { + let user_id = info.user_id?; + mj_session.set_identity(user_id.clone(), info.websocket_token); + Some(user_id) + } + Err(err) => { + warn!("Could not resolve Midjourney user info: {:?}", err); + None + } + } +} + +fn job_type_to_model_type(job_id: &str, item: &ImagineItem) -> CommonModelType { + match item.job_type { + Some(MidjourneyJobType::V6Diffusion) => CommonModelType::MidjourneyV6, + Some(MidjourneyJobType::V6p1Diffusion) => CommonModelType::MidjourneyV6p1, + Some(MidjourneyJobType::V6p1RawDiffusion) => CommonModelType::MidjourneyV6p1Raw, + Some(MidjourneyJobType::V7Diffusion) => CommonModelType::MidjourneyV7, + Some(MidjourneyJobType::V7RawDiffusion) => CommonModelType::MidjourneyV7Raw, + Some(MidjourneyJobType::V7DraftDiffusion) => CommonModelType::MidjourneyV7Draft, + Some(MidjourneyJobType::V7DraftRawDiffusion) => CommonModelType::MidjourneyV7DraftRaw, + Some(MidjourneyJobType::Other(ref other)) => { + warn!("Unknown Midjourney job type (job {}): {}", job_id, other); + CommonModelType::Midjourney + } + _ => CommonModelType::Midjourney, + } +} diff --git a/crates/artcraftx/src/services/midjourney/threads/midjourney_websocket_thread.rs b/crates/artcraftx/src/services/midjourney/threads/midjourney_websocket_thread.rs new file mode 100644 index 00000000..bdd10c13 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/threads/midjourney_websocket_thread.rs @@ -0,0 +1,238 @@ +use crate::services::midjourney::completion::finalize_midjourney_job::{ + finalize_midjourney_job, FinalizeMidjourneyJobArgs, +}; +use crate::services::midjourney::state::midjourney_live_session::MidjourneyLiveSession; +use crate::services::midjourney::threads::midjourney_long_polling_thread::{ + midjourney_cookie_header, resolve_user_id, +}; +use crate::services::midjourney::utils::midjourney_browser_profile::midjourney_browser_profile; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::database::task_database_pending_statuses::TASK_DATABASE_PENDING_STATUSES; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::{error, info, warn}; +use midjourney_client::client::websocket::midjourney_websocket::MidjourneyWebSocket; +use midjourney_client::client::websocket::midjourney_ws_event::MidjourneyWsEvent; +use midjourney_client::client::websocket::open_midjourney_websocket::{ + open_midjourney_websocket, OpenMidjourneyWebSocketRequest, +}; +use midjourney_client::utils::image_downloader_client::ImageDownloaderClient; +use sqlite_database::queries::read::list_tasks_by_provider_and_status::{ + list_tasks_by_provider_and_status, ListTasksByProviderAndStatusArgs, +}; +use sqlite_database::queries::task::Task; +use std::collections::{HashMap, HashSet}; +use tauri::AppHandle; +use tokio::sync::broadcast::error::RecvError; + +const SLEEP_NOT_READY_MS: u64 = 15_000; +const SLEEP_AFTER_SOCKET_DEATH_MS: u64 = 5_000; + +/// How often (while the socket is up) to rescan the tasks DB for newly +/// enqueued Midjourney jobs and subscribe to them. +const RESCAN_INTERVAL_MS: u64 = 3_000; + +/// The fast completion path: keep a Midjourney websocket open, subscribe to +/// every pending job, and finalize as soon as its `completed` frame arrives. +/// The long-polling thread is the fallback for anything this misses. +pub async fn midjourney_websocket_thread( + app_handle: AppHandle, + app_data_root: AppDataRoot, + app_preferences: AppPreferencesManager, + task_database: TaskDatabase, + mj_session: MidjourneyLiveSession, + storyteller_creds_manager: StorytellerCredentialManager, +) -> ! { + loop { + let res = run_once( + &app_handle, + &app_data_root, + &app_preferences, + &task_database, + &mj_session, + &storyteller_creds_manager, + ).await; + + // The socket closed (or never opened). Drop the handle so we re-open next + // pass, and let the long-poller cover the gap. + mj_session.clear_websocket(); + + if let Err(err) = res { + warn!("Midjourney websocket session ended: {:?}", err); + } + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_AFTER_SOCKET_DEATH_MS)).await; + } +} + +async fn run_once( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + mj_session: &MidjourneyLiveSession, + // Uploads now go to the backup account (see `services::backup`), not the session. + _storyteller_creds_manager: &StorytellerCredentialManager, +) -> AnyhowResult<()> { + let cookie_header = match midjourney_cookie_header(app_data_root) { + Some(header) => header, + None => return sleep_not_ready().await, + }; + + + // Resolves and caches user_id + websocket_token in the session. + let user_id = match resolve_user_id(mj_session, &cookie_header).await { + Some(user_id) => user_id, + None => return sleep_not_ready().await, + }; + + let websocket_token = match mj_session.websocket_token() { + Some(token) => token, + None => { + // No token available (index page didn't expose one); leave it to the poller. + return sleep_not_ready().await; + } + }; + + let websocket = match mj_session.connected_websocket() { + Some(ws) => ws, + None => { + let ws = open_midjourney_websocket(OpenMidjourneyWebSocketRequest { + websocket_token: &websocket_token, + user_id, + hostname: None, + browser: Some(midjourney_browser_profile()), + }).await?; + mj_session.set_websocket(ws.clone()); + info!("Midjourney websocket opened for fast completion."); + ws + } + }; + + drive_websocket( + app_handle, + app_data_root, + app_preferences, + task_database, + mj_session, + websocket, + ).await +} + +/// Subscribe to pending jobs and finalize them as `completed` frames arrive, +/// returning when the socket closes. +async fn drive_websocket( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + mj_session: &MidjourneyLiveSession, + websocket: MidjourneyWebSocket, +) -> AnyhowResult<()> { + let image_downloader = ImageDownloaderClient::create(Some(midjourney_browser_profile()))?; + let mut events = websocket.events(); + let mut subscribed: HashSet = HashSet::new(); + let mut pending_tasks_by_job_id: HashMap = HashMap::new(); + + // Subscribe to whatever is already pending before we start waiting. + refresh_subscriptions(task_database, &websocket, &mut subscribed, &mut pending_tasks_by_job_id).await?; + + let mut rescan = tokio::time::interval(std::time::Duration::from_millis(RESCAN_INTERVAL_MS)); + + loop { + tokio::select! { + _ = rescan.tick() => { + if !websocket.is_connected() { + return Ok(()); + } + if let Err(err) = refresh_subscriptions( + task_database, &websocket, &mut subscribed, &mut pending_tasks_by_job_id, + ).await { + warn!("Failed to refresh Midjourney subscriptions: {:?}", err); + } + } + + received = events.recv() => { + match received { + Ok(event) => { + if let MidjourneyWsEvent::Completed { job_id, .. } = event.as_ref() { + let Some(local_task) = pending_tasks_by_job_id.get(job_id).cloned() else { + continue; // Not one of ours (or already handled). + }; + + let maybe_full_command = mj_session.take_pending_prompt(job_id); + + let result = finalize_midjourney_job(FinalizeMidjourneyJobArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + image_downloader: &image_downloader, + midjourney_job_id: job_id, + local_task: &local_task, + // NB: the `completed` frame carries no model detail; the + // poller sets a precise model when it finalizes instead. + model_type: CommonModelType::Midjourney, + maybe_full_command, + }).await; + + match result { + Ok(true) => info!("Finalized Midjourney job {} via websocket.", job_id), + Ok(false) => {} // Already finalized elsewhere. + Err(err) => error!("Websocket finalize failed for job {}: {:?}", job_id, err), + } + + pending_tasks_by_job_id.remove(job_id); + } + } + Err(RecvError::Lagged(skipped)) => { + warn!("Midjourney websocket consumer lagged, skipped {} events", skipped); + } + Err(RecvError::Closed) => { + return Ok(()); // Socket closed; outer loop re-opens. + } + } + } + } + } +} + +/// List currently-pending Midjourney tasks, subscribe to any we haven't yet, +/// and refresh the job-id → task lookup used to finalize completions. +async fn refresh_subscriptions( + task_database: &TaskDatabase, + websocket: &MidjourneyWebSocket, + subscribed: &mut HashSet, + pending_tasks_by_job_id: &mut HashMap, +) -> AnyhowResult<()> { + let pending = list_tasks_by_provider_and_status(ListTasksByProviderAndStatusArgs { + db: task_database.get_connection(), + provider: GenerationSource::Midjourney, + task_statuses: &TASK_DATABASE_PENDING_STATUSES, + }).await?; + + pending_tasks_by_job_id.clear(); + for task in pending.tasks { + let Some(job_id) = task.provider_job_id.clone() else { + continue; + }; + pending_tasks_by_job_id.insert(job_id.clone(), task); + + if subscribed.insert(job_id.clone()) { + if let Err(err) = websocket.subscribe_to_job(&job_id) { + warn!("Failed to subscribe to Midjourney job {}: {:?}", job_id, err); + subscribed.remove(&job_id); + } + } + } + + Ok(()) +} + +async fn sleep_not_ready() -> AnyhowResult<()> { + tokio::time::sleep(std::time::Duration::from_millis(SLEEP_NOT_READY_MS)).await; + Ok(()) +} diff --git a/crates/artcraftx/src/services/midjourney/threads/mod.rs b/crates/artcraftx/src/services/midjourney/threads/mod.rs new file mode 100644 index 00000000..84519353 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/threads/mod.rs @@ -0,0 +1,2 @@ +pub mod midjourney_long_polling_thread; +pub mod midjourney_websocket_thread; diff --git a/crates/artcraftx/src/services/midjourney/utils/download_midjourney_image.rs b/crates/artcraftx/src/services/midjourney/utils/download_midjourney_image.rs new file mode 100644 index 00000000..15bde7fd --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/utils/download_midjourney_image.rs @@ -0,0 +1,35 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use errors::AnyhowResult; +use midjourney_client::utils::get_image_url::get_image_url; +use std::fs::File; +use std::io::Write; +use std::path::PathBuf; +use url::Url; +use midjourney_client::utils::image_downloader_client::ImageDownloaderClient; + +pub async fn download_midjourney_image( + image_downloader: &ImageDownloaderClient, + job_id: &str, + index: u8, + app_data_root: &AppDataRoot +) -> AnyhowResult { + let url = get_image_url(job_id, index)?; + let parsed_url = Url::parse(&url)?; + + //let response = reqwest::get(&url).await?; + //let image_bytes = response.bytes().await?; + + let image_bytes = image_downloader.download_image(job_id, index).await?; + + let ext = parsed_url.path().split(".").last().unwrap_or("png"); + + let tempdir = app_data_root.temp_dir().path(); + let download_filename = format!("{}_{}.{}", job_id, index, ext); + let download_path = tempdir.join(download_filename); + + let mut file = File::create(&download_path)?; + file.write_all(&image_bytes)?; + + Ok(download_path) +} diff --git a/crates/artcraftx/src/services/midjourney/utils/extract_midjourney_user_id_from_cookies.rs b/crates/artcraftx/src/services/midjourney/utils/extract_midjourney_user_id_from_cookies.rs new file mode 100644 index 00000000..9ee84e13 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/utils/extract_midjourney_user_id_from_cookies.rs @@ -0,0 +1,68 @@ +use base64::prelude::BASE64_URL_SAFE_NO_PAD; +use base64::Engine; +use midjourney_client::credentials::midjourney_user_id::MidjourneyUserId; +use serde_json::Value; + +/// The Midjourney auth id-token cookie. Its (unverified) JWT payload carries +/// the Midjourney user id under `midjourney_id`. +const AUTH_ID_TOKEN_COOKIE: &str = "__Host-Midjourney.AuthUserTokenV3_i"; + +/// The JWT claim holding the Midjourney user id (the `singleplayer_{...}` +/// channel id is built from it). +const MIDJOURNEY_ID_CLAIM: &str = "midjourney_id"; + +/// Recover the Midjourney user id from the auth cookie's JWT, WITHOUT hitting +/// the Cloudflare-gated index page. `cookie_header` is a raw `Cookie:` header +/// string (`"a=1; b=2"`). +pub fn extract_midjourney_user_id_from_cookie_header( + cookie_header: &str, +) -> Option { + let token = cookie_value(cookie_header, AUTH_ID_TOKEN_COOKIE)?; + let claims = decode_jwt_payload(token)?; + let id = claims.get(MIDJOURNEY_ID_CLAIM).and_then(Value::as_str)?; + if id.is_empty() { + return None; + } + Some(MidjourneyUserId::from_str(id)) +} + +fn cookie_value<'a>(cookie_header: &'a str, name: &str) -> Option<&'a str> { + cookie_header + .split(';') + .filter_map(|pair| pair.trim().split_once('=')) + .find(|(cookie_name, _)| *cookie_name == name) + .map(|(_, value)| value) +} + +/// Decode the (unverified) payload of a `header.payload.signature` JWT. +fn decode_jwt_payload(token: &str) -> Option { + let mut parts = token.split('.'); + let _header = parts.next()?; + let payload = parts.next()?; + let _signature = parts.next()?; + if parts.next().is_some() { + return None; + } + let bytes = BASE64_URL_SAFE_NO_PAD.decode(payload).ok()?; + serde_json::from_slice(&bytes).ok() +} + +#[cfg(test)] +mod tests { + use super::*; + + // Payload: {"midjourney_id":"26c9d38d-1f71-49c7-a356-b29dac58b54c","name":"u1"} + const JWT: &str = "eyJhbGciOiJIUzI1NiJ9.eyJtaWRqb3VybmV5X2lkIjoiMjZjOWQzOGQtMWY3MS00OWM3LWEzNTYtYjI5ZGFjNThiNTRjIiwibmFtZSI6InUxIn0.sig"; + + #[test] + fn extracts_user_id_from_auth_cookie() { + let header = format!("_fbp=abc; {}={}; other=x", AUTH_ID_TOKEN_COOKIE, JWT); + let user_id = extract_midjourney_user_id_from_cookie_header(&header).unwrap(); + assert_eq!(user_id.as_str(), "26c9d38d-1f71-49c7-a356-b29dac58b54c"); + } + + #[test] + fn returns_none_without_auth_cookie() { + assert!(extract_midjourney_user_id_from_cookie_header("_fbp=abc; other=x").is_none()); + } +} diff --git a/crates/artcraftx/src/services/midjourney/utils/midjourney_browser_profile.rs b/crates/artcraftx/src/services/midjourney/utils/midjourney_browser_profile.rs new file mode 100644 index 00000000..812d5d9b --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/utils/midjourney_browser_profile.rs @@ -0,0 +1,22 @@ +use browser_emulation::browser_profile::BrowserProfile; + +/// The User-Agent used for BOTH the Midjourney login webview and every +/// first-party Midjourney HTTP/websocket call. +/// +/// It must be identical in both places: Cloudflare's `cf_clearance` cookie +/// (captured by the webview) is bound to the exact User-Agent, so the wreq +/// calls that replay those cookies have to present the same string. A +/// mainstream desktop Safari UA (rather than the default WKWebView UA) also +/// makes Google's embedded-webview risk detection less likely to force a +/// passkey step-up during sign-in. +pub const MIDJOURNEY_USER_AGENT: &str = + "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15"; + +/// The browser profile used for ALL first-party Midjourney HTTP/websocket +/// traffic (submit, imagine, index page, image downloads, websocket upgrade). +/// +/// Safari fingerprint + the exact [`MIDJOURNEY_USER_AGENT`], to stay consistent +/// with the macOS WKWebView login window that captured the cookies. +pub fn midjourney_browser_profile() -> BrowserProfile { + BrowserProfile::safari_macos_with_user_agent(MIDJOURNEY_USER_AGENT) +} diff --git a/crates/artcraftx/src/services/midjourney/utils/mod.rs b/crates/artcraftx/src/services/midjourney/utils/mod.rs new file mode 100644 index 00000000..905e7ee0 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/utils/mod.rs @@ -0,0 +1,3 @@ +pub mod download_midjourney_image; +pub mod extract_midjourney_user_id_from_cookies; +pub mod midjourney_browser_profile; \ No newline at end of file diff --git a/crates/artcraftx/src/services/midjourney/windows/extract_midjourney_webview_cookies.rs b/crates/artcraftx/src/services/midjourney/windows/extract_midjourney_webview_cookies.rs new file mode 100644 index 00000000..58416ad6 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/windows/extract_midjourney_webview_cookies.rs @@ -0,0 +1,51 @@ +use cookie_store_wrapper::cookie_store::{CapturedCookie, CookieStore}; +use errors::AnyhowResult; +use once_cell::sync::Lazy; +use reqwest::Url; +use std::collections::HashSet; +use tauri::webview::Cookie; +use tauri::WebviewWindow; + +static WWW_COOKIE_URL: Lazy = Lazy::new(|| { + Url::parse("https://www.midjourney.com").expect("URL should parse") +}); + +static ROOT_COOKIE_URL: Lazy = Lazy::new(|| { + Url::parse("https://midjourney.com").expect("URL should parse") +}); + +pub fn extract_midjourney_webview_cookies(webview: &WebviewWindow) -> AnyhowResult { + let mut cookie_store = CookieStore::empty(); + let cookies = get_all_midjourney_cookies(webview)?; + for cookie in cookies.iter() { + cookie_store.insert_captured( + CapturedCookie { + name: cookie.name().to_string(), + value: cookie.value().to_string(), + maybe_domain: cookie.domain().map(str::to_string), + maybe_path: cookie.path().map(str::to_string), + }, + &WWW_COOKIE_URL, + ); + } + Ok(cookie_store) +} + +fn get_all_midjourney_cookies(webview: &WebviewWindow) -> AnyhowResult>> { + // NB: WWW domain contains the auth/session cookies. + // Root domain contains some other cookies, such as Cloudflare. + let www_cookies = webview.cookies_for_url(WWW_COOKIE_URL.clone())?; + let root_cookies = webview.cookies_for_url(ROOT_COOKIE_URL.clone())?; + + let mut all_cookies = www_cookies; + let mut cookie_names = HashSet::new(); + + for cookie in root_cookies.iter() { + if !cookie_names.contains(cookie.name()) { + cookie_names.insert(cookie.name().to_string()); + all_cookies.push(cookie.clone()); + } + } + + Ok(all_cookies) +} diff --git a/crates/artcraftx/src/services/midjourney/windows/midjourney_login_window_thread.rs b/crates/artcraftx/src/services/midjourney/windows/midjourney_login_window_thread.rs new file mode 100644 index 00000000..313af76e --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/windows/midjourney_login_window_thread.rs @@ -0,0 +1,176 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::refresh_account_state_event::RefreshAccountStateEvent; +use crate::events::sendable_event_trait::SendableEvent; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::window::get_webview_window_hostname::get_webview_window_hostname; +use crate::services::midjourney::state::midjourney_credential_manager::MidjourneyCredentialManager; +use crate::services::midjourney::state::midjourney_user_info::MidjourneyUserInfo; +use crate::services::midjourney::windows::extract_midjourney_webview_cookies::extract_midjourney_webview_cookies; +use crate::services::midjourney::windows::open_midjourney_login_window::MIDJOURNEY_LOGIN_WINDOW_NAME; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::{error, info}; +use midjourney_client::credentials::cookie_store_has_auth_cookies::cookie_store_has_auth_cookies; +use midjourney_client::recipes::get_user_info::{get_user_info, GetUserInfoArgs}; +use tauri::{AppHandle, Manager, WebviewWindow}; + +pub async fn midjourney_login_window_thread( + app: AppHandle, + app_data_root: AppDataRoot, + mj_creds_manager: MidjourneyCredentialManager, +) { + let mut visited_login = false; + + loop { + let login_webview_window = match app.get_webview_window(MIDJOURNEY_LOGIN_WINDOW_NAME) { + Some(webview) => webview, + None => { + info!("Exit midjourney login thread."); + return; // NB: Only exit if we don't have the webview. + } + }; + + let result = check_login_window( + &app, + &login_webview_window, + &app_data_root, + &mj_creds_manager, + &mut visited_login, + ).await; + + match result { + Err(err) => { + error!("Error checking login window: {:?}", err); + } + Ok(false) => {} // Continue iteration and try again... + Ok(true) => { + info!("Successfully saved cookies from login window. Closing."); + if let Err(err) = login_webview_window.close() { + error!("Error closing login window: {:?}", err); + } + return; + } + } + + tokio::time::sleep(std::time::Duration::from_millis(2_000)).await; + } +} + +/// Returns true if we can exit. +async fn check_login_window( + app_handle: &AppHandle, + webview_window: &WebviewWindow, + _app_data_root: &AppDataRoot, + mj_creds_manager: &MidjourneyCredentialManager, + visited_login: &mut bool, +) -> AnyhowResult { + + /* Login flow looks like this: + + 1. Start: https://www.midjourney.com/auth/signin + 2. SSO / Google Login (etc): https://accounts.google.com/v3/signin/challenge/pwd?[query] + 3. Done / Landing: https://www.midjourney.com/... + */ + + let hostname = get_webview_window_hostname(webview_window)?; + + let mut maybe_at_destination = false; + + match hostname.as_str() { + "www.midjourney.com" | + "midjourney.com" + => { + maybe_at_destination = true; + } + // chatgpt.com/auth is also an auth domain + "auth.openai.com" | + "accounts.google.com" | + "accounts.youtube.com" | + "login.live.com" | + "appleid.apple.com" + => { + // NB: We're in auth flow. + info!("Midjourney webview is in auth flow; hostname `{}`.", hostname); + *visited_login = true; + return Ok(false) + } + _ => {}, // We just don't know... + } + + let cookie_store = extract_midjourney_webview_cookies(webview_window)?; + + let maybe_has_auth_cookies = cookie_store_has_auth_cookies(&cookie_store); + let maybe_has_enough_cookies = cookie_store.len() > 6; + let maybe_completed_login_cycle = *visited_login && maybe_at_destination; + + // Misc cookies without login cookies are ~1055 length + // AUTH_I is ~1500 length + // AUTH_R is ~500 length + let maybe_has_big_enough_cookie = cookie_store.calculate_approx_cookie_character_length() > 2100; + + let mut heuristic_count = 0; + + if maybe_has_auth_cookies { + heuristic_count += 1; + } + if maybe_has_enough_cookies { + heuristic_count += 1; + } + if maybe_completed_login_cycle { + heuristic_count += 1; + } + if maybe_has_big_enough_cookie { + heuristic_count += 1; + } + + if heuristic_count < 3 { + return Ok(false); + } + + info!("Heuristic count is ({}); we're likely done.", heuristic_count); + + info!("Current cookies (len {}): {:?}", cookie_store.len(), cookie_store.to_cookie_string()); + + let cookie_header = cookie_store.to_cookie_string(); + let response = get_user_info(GetUserInfoArgs { + cookie_header: &cookie_header, + hostname: None, + browser: None, + }).await; + + match response { + Err(err) => { + error!("Error getting midjourney user info: {:?}", err); + // NB: Fall through. Allow us to update the cookies. + } + Ok(user_info) => { + info!("Got midjourney user info: {:?}", user_info); + let user_info = MidjourneyUserInfo::from_api_response(user_info); + + if let Err(err) = mj_creds_manager.replace_user_info(user_info) { + error!("Error saving midjourney user info: {:?}", err); + // NB: Fall through. Allow us to update the cookies. + } + } + } + + mj_creds_manager.replace_cookie_store(cookie_store)?; + + let result = mj_creds_manager.persist_to_disk(); + + if let Err(err) = result { + error!("Error persisting midjourney cookies to disk: {:?}", err); + return Ok(false); + } + + let event = RefreshAccountStateEvent { + provider: Some(GenerationSource::Midjourney), + }; + + if let Err(err) = event.send(&app_handle) { + error!("Failed to send RefreshAccountStateEvent: {:?}", err); // Fail open + } + + Ok(true) +} + diff --git a/crates/artcraftx/src/services/midjourney/windows/mod.rs b/crates/artcraftx/src/services/midjourney/windows/mod.rs new file mode 100644 index 00000000..b5417787 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/windows/mod.rs @@ -0,0 +1,3 @@ +pub mod extract_midjourney_webview_cookies; +pub mod midjourney_login_window_thread; +pub mod open_midjourney_login_window; \ No newline at end of file diff --git a/crates/artcraftx/src/services/midjourney/windows/open_midjourney_login_window.rs b/crates/artcraftx/src/services/midjourney/windows/open_midjourney_login_window.rs new file mode 100644 index 00000000..d162c8e6 --- /dev/null +++ b/crates/artcraftx/src/services/midjourney/windows/open_midjourney_login_window.rs @@ -0,0 +1,77 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::window::clear_all_webview_cookies::clear_all_webview_cookies; +use crate::services::midjourney::state::midjourney_credential_manager::MidjourneyCredentialManager; +use crate::services::midjourney::windows::midjourney_login_window_thread::midjourney_login_window_thread; +use anyhow::anyhow; +use errors::AnyhowResult; +use once_cell::sync::Lazy; +use reqwest::Url; +use std::time::Duration; +use tauri::{AppHandle, Manager, WebviewUrl, WebviewWindowBuilder}; + +/// Name of the window +pub (super) const MIDJOURNEY_LOGIN_WINDOW_NAME: &str = "midjourney_login_window"; + +pub (super) const MIDJOURNEY_START_URL_STR: &str = "https://google.com"; + +pub (super) static START_URL: Lazy = Lazy::new(|| { + Url::parse(MIDJOURNEY_START_URL_STR).expect("URL should parse") +}); + +pub (super) const MIDJOURNEY_HOMEPAGE_URL_STR: &str = "https://www.midjourney.com/"; + +pub (super) static MIDJOURNEY_HOMEPAGE_URL: Lazy = Lazy::new(|| { + Url::parse(MIDJOURNEY_HOMEPAGE_URL_STR).expect("URL should parse") +}); + +pub (super) const MIDJOURNEY_LOGIN_URL_STR: &str = "https://www.midjourney.com/auth/signin"; + +pub (super) static MIDJOURNEY_LOGIN_URL: Lazy = Lazy::new(|| { + Url::parse(MIDJOURNEY_LOGIN_URL_STR).expect("URL should parse") +}); + +pub async fn open_midjourney_login_window( + app: &AppHandle, + app_data_root: &AppDataRoot, + mj_creds_manager: &MidjourneyCredentialManager, +) -> AnyhowResult<()> { + if app.get_window(MIDJOURNEY_LOGIN_WINDOW_NAME).is_some() { + return Err(anyhow!("Login window already open")); + } + + let url = WebviewUrl::External(START_URL.clone()); + + let window = WebviewWindowBuilder::new(app, MIDJOURNEY_LOGIN_WINDOW_NAME, url) + .always_on_top(false) + .title("Login to Midjourney") + .center() + .resizable(true) + .visible(true) + .closable(true) + .min_inner_size(200.0, 800.0) + .focused(true) + .devtools(true) + .build()?; + + let webview = window.get_webview(MIDJOURNEY_LOGIN_WINDOW_NAME) + .ok_or_else(|| anyhow!("no webview found"))?; + + clear_all_webview_cookies(&webview)?; + + webview.navigate(MIDJOURNEY_HOMEPAGE_URL.clone())?; + + // NB: We're starting to get Cloudflare protection screens. Let's try to avoid. + tokio::time::sleep(Duration::from_millis(100)).await; + + webview.navigate(MIDJOURNEY_LOGIN_URL.clone())?; + + let app_handle = app.clone(); + let app_data_root = app_data_root.clone(); + let mj_creds_manager= mj_creds_manager.clone(); + + let _ = tauri::async_runtime::spawn(async move { + midjourney_login_window_thread(app_handle, app_data_root, mj_creds_manager).await; + }); + + Ok(()) +} diff --git a/crates/artcraftx/src/services/mod.rs b/crates/artcraftx/src/services/mod.rs new file mode 100644 index 00000000..2a62094d --- /dev/null +++ b/crates/artcraftx/src/services/mod.rs @@ -0,0 +1,7 @@ +pub mod asset_uploads; +pub mod backup; +pub mod grok; +pub mod local_files; +pub mod higgsfield; +pub mod midjourney; +pub mod storyteller; diff --git a/crates/artcraftx/src/services/storyteller/mod.rs b/crates/artcraftx/src/services/storyteller/mod.rs new file mode 100644 index 00000000..b8e47c76 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/mod.rs @@ -0,0 +1,4 @@ +pub mod state; +pub mod utils; +pub mod threads; +pub mod windows; diff --git a/crates/artcraftx/src/services/storyteller/state/legacy_credential_paths.rs b/crates/artcraftx/src/services/storyteller/state/legacy_credential_paths.rs new file mode 100644 index 00000000..11931601 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/state/legacy_credential_paths.rs @@ -0,0 +1,23 @@ +//! Legacy on-disk credential paths for Storyteller / Artcraft. +//! +//! TODO(artcraftx): retire once Storyteller moves to the unified TOML +//! credential store in `crate::credentials`. + +use crate::state::data_dir::subdirectory::app_credentials_dir::AppCredentialsDir; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::path::PathBuf; + +pub trait StorytellerLegacyCredentialPaths { + fn get_storyteller_avt_cookie_file_path(&self) -> PathBuf; + fn get_storyteller_session_cookie_file_path(&self) -> PathBuf; +} + +impl StorytellerLegacyCredentialPaths for AppCredentialsDir { + fn get_storyteller_avt_cookie_file_path(&self) -> PathBuf { + self.path().join("artcraft_avt.txt") + } + + fn get_storyteller_session_cookie_file_path(&self) -> PathBuf { + self.path().join("artcraft_session.txt") + } +} diff --git a/crates/artcraftx/src/services/storyteller/state/mod.rs b/crates/artcraftx/src/services/storyteller/state/mod.rs new file mode 100644 index 00000000..6baef973 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/state/mod.rs @@ -0,0 +1,4 @@ +pub mod legacy_credential_paths; +pub mod read_storyteller_credentials_from_disk; +pub mod storyteller_credential_holder; +pub mod storyteller_credential_manager; \ No newline at end of file diff --git a/crates/artcraftx/src/services/storyteller/state/read_storyteller_credentials_from_disk.rs b/crates/artcraftx/src/services/storyteller/state/read_storyteller_credentials_from_disk.rs new file mode 100644 index 00000000..b621edf6 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/state/read_storyteller_credentials_from_disk.rs @@ -0,0 +1,40 @@ +use crate::services::storyteller::state::legacy_credential_paths::StorytellerLegacyCredentialPaths; +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use std::fs::read_to_string; +use artcraft_client::credentials::storyteller_avt_cookie::StorytellerAvtCookie; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::credentials::storyteller_session_cookie::StorytellerSessionCookie; + +pub fn read_storyteller_credentials_from_disk(app_data_root: &AppDataRoot) -> AnyhowResult { + let creds_dir= app_data_root.credentials_dir(); + + let mut avt = None; + + { + let avt_file = creds_dir.get_storyteller_avt_cookie_file_path(); + if avt_file.exists() { + let contents = read_to_string(&avt_file)? + .trim() + .to_string(); + avt = Some(StorytellerAvtCookie::new(contents)); + } + } + + let mut session = None; + + { + let session_file = creds_dir.get_storyteller_session_cookie_file_path(); + if session_file.exists() { + let contents = read_to_string(&session_file)? + .trim() + .to_string(); + session = Some(StorytellerSessionCookie::new(contents)); + } + } + + Ok(StorytellerCredentialSet::initialize( + avt, + session, + )) +} diff --git a/crates/artcraftx/src/services/storyteller/state/storyteller_credential_holder.rs b/crates/artcraftx/src/services/storyteller/state/storyteller_credential_holder.rs new file mode 100644 index 00000000..5759f413 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/state/storyteller_credential_holder.rs @@ -0,0 +1,57 @@ +use anyhow::anyhow; +use errors::AnyhowResult; +use std::sync::{Arc, RwLock}; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + +/// Hold credentials for the application. +#[derive(Clone)] +pub struct StorytellerCredentialHolder { + credentials: Arc>>, +} + +impl StorytellerCredentialHolder { + pub fn new() -> Self { + Self { + credentials: Arc::new(RwLock::new(None)), + } + } + + pub fn set_credentials(&self, credentials: &StorytellerCredentialSet) -> AnyhowResult<()> { + match self.credentials.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut creds) => { + *creds = Some(credentials.clone()); + Ok(()) + } + } + } + + pub fn clear_credentials(&self) -> AnyhowResult<()> { + match self.credentials.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut creds) => { + *creds = None; + Ok(()) + } + } + } + + pub fn get_credentials(&self) -> AnyhowResult> { + match self.credentials.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(creds) => { + Ok(creds.clone()) + } + } + } + + pub fn get_credentials_required(&self) -> AnyhowResult { + match self.credentials.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(creds) => match &*creds { + None => Err(anyhow!("Storyteller credentials not set")), + Some(creds) => Ok(creds.clone()), + } + } + } +} diff --git a/crates/artcraftx/src/services/storyteller/state/storyteller_credential_manager.rs b/crates/artcraftx/src/services/storyteller/state/storyteller_credential_manager.rs new file mode 100644 index 00000000..e7418d2c --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/state/storyteller_credential_manager.rs @@ -0,0 +1,165 @@ +use crate::services::storyteller::state::legacy_credential_paths::StorytellerLegacyCredentialPaths; +use core_types::enums::generation_source::GenerationSource; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::storyteller::state::read_storyteller_credentials_from_disk::read_storyteller_credentials_from_disk; +use crate::services::storyteller::state::storyteller_credential_holder::StorytellerCredentialHolder; +use errors::AnyhowResult; +use log::{info, warn}; +use std::fs::OpenOptions; +use std::io::Write; +use artcraft_client::credentials::storyteller_avt_cookie::StorytellerAvtCookie; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::credentials::storyteller_session_cookie::StorytellerSessionCookie; + +#[derive(Clone)] +pub struct StorytellerCredentialManager { + holder: StorytellerCredentialHolder, + app_data_root: AppDataRoot, +} + +impl StorytellerCredentialManager { + + pub fn initialize_empty(app_data_root: &AppDataRoot) -> Self { + Self { + holder: StorytellerCredentialHolder::new(), + app_data_root: app_data_root.clone(), + } + } + + pub fn initialize_from_disk_infallible(app_data_root: &AppDataRoot) -> Self { + let holder = StorytellerCredentialHolder::new(); + + match read_storyteller_credentials_from_disk(app_data_root) { + Err(err) => warn!("Failed to read credentials from disk: {:?}", err), + Ok(creds) => { + holder.set_credentials(&creds).expect("Failed to set credentials"); + } + } + + Self { + holder, + app_data_root: app_data_root.clone(), + } + } + + pub fn set_credentials(&self, creds: &StorytellerCredentialSet) -> AnyhowResult<()> { + self.holder.set_credentials(creds) + } + + pub fn clear_credentials(&self) -> AnyhowResult<()> { + self.holder.clear_credentials()?; + Ok(()) + } + + pub fn get_credentials(&self) -> AnyhowResult> { + if let Some(creds) = self.holder.get_credentials()? { + return Ok(Some(creds)); + } + + // Fall back to the stored `artcraft` account credential (the new + // credential system) so background polling works without a webview + // login. Cached in the holder after the first successful load. + match self.try_load_from_credentials_dir() { + Some(creds) => { + if let Err(err) = self.holder.set_credentials(&creds) { + warn!("Could not cache credentials from credentials dir: {:?}", err); + } + Ok(Some(creds)) + } + None => Ok(None), + } + } + + /// Load session cookies from the first `artcraft` (production) credential + /// in the app's credentials directory, if any. + fn try_load_from_credentials_dir(&self) -> Option { + let credentials = self.app_data_root + .credentials_dir() + .load_credentials() + .ok()?; + + let credential = credentials.into_iter() + .find(|c| c.service == GenerationSource::Artcraft)?; + + let cookie = credential.cookies()?; + + StorytellerCredentialSet::parse_multi_cookie_header(&cookie.cookie_header()) + .ok() + .flatten() + .filter(|creds| !creds.is_empty()) + } + + pub fn get_credentials_required(&self) -> AnyhowResult { + self.holder.get_credentials_required() + } + + pub fn reset_from_disk(&self) -> AnyhowResult { + let creds = read_storyteller_credentials_from_disk(&self.app_data_root)?; + self.holder.set_credentials(&creds)?; + Ok(creds) + } + + pub fn persist_all_to_disk(&self) -> AnyhowResult<()> { + let credentials = self.holder.get_credentials_required()?; + + info!("Persisting avt cookie to disk..."); + if let Some(avt) = credentials.avt.as_ref() { + persist_avt_to_disk(&avt, &self.app_data_root)?; + } + + info!("Persisting session cookie to disk..."); + if let Some(session) = credentials.session.as_ref() { + persist_session_to_disk(&session, &self.app_data_root)?; + } + + Ok(()) + } + + pub fn delete_persisted_copies_on_disk(&self) -> AnyhowResult<()> { + let creds_dir = self.app_data_root.credentials_dir(); + + let session_file = creds_dir.get_storyteller_session_cookie_file_path(); + if session_file.exists() { + std::fs::remove_file(session_file)?; + } + + let avt_file = creds_dir.get_storyteller_avt_cookie_file_path(); + if avt_file.exists() { + std::fs::remove_file(avt_file)?; + } + + Ok(()) + } +} + +fn persist_session_to_disk(session: &StorytellerSessionCookie, app_data_root: &AppDataRoot) -> AnyhowResult<()> { + let creds_dir = app_data_root.credentials_dir(); + let filename = creds_dir.get_storyteller_session_cookie_file_path(); + + let mut file = OpenOptions::new() + .create(true) + .write(true) + .truncate(true) + .open(filename)?; + + file.write_all(session.as_bytes())?; + file.flush()?; + + Ok(()) +} + +fn persist_avt_to_disk(avt: &StorytellerAvtCookie, app_data_root: &AppDataRoot) -> AnyhowResult<()> { + let creds_dir = app_data_root.credentials_dir(); + let filename = creds_dir.get_storyteller_avt_cookie_file_path(); + + let mut file = OpenOptions::new() + .create(true) + .write(true) + .truncate(true) + .open(filename)?; + + file.write_all(avt.as_bytes())?; + file.flush()?; + + Ok(()) +} diff --git a/crates/artcraftx/src/services/storyteller/threads/mod.rs b/crates/artcraftx/src/services/storyteller/threads/mod.rs new file mode 100644 index 00000000..663bd6cd --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/mod.rs @@ -0,0 +1,2 @@ +pub mod storyteller_activity_thread; +pub mod storyteller_task_polling_thread; \ No newline at end of file diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_activity_thread.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_activity_thread.rs new file mode 100644 index 00000000..172b64e3 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_activity_thread.rs @@ -0,0 +1,143 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::state::runtime::artcraft_platform_info::ArtcraftPlatformInfo; +use crate::state::usage_tracker::artcraft_usage_tracker::ArtcraftUsageTracker; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use anyhow::anyhow; +use artcraft_client::api_defs::analytics::log_active_user::LogAppActiveUserRequest; +use artcraft_client::endpoints::analytics::log_active_user_v2::log_active_user_v2; +use artcraft_client::error::api_error::ApiError; +use artcraft_client::error::storyteller_error::StorytellerError; +use errors::AnyhowResult; +use log::{debug, error, info}; +use std::time::Instant; +use artcraft_client::tokens::app_session::AppSessionToken; + +const CLIENT_NAME : &str = "artcraft"; + +const ERROR_SLEEP_MILLIS : u64 = 1_000 * 60 * 3; // 3 minutes; + +/// App session tokens are the one token minted client-side: an opaque +/// per-app-run analytics id in the server's historical format +/// (`app_session_` + 20 chars of mixed-case Crockford base32). +const APP_SESSION_ENTROPY_CHARSET: &[u8] = b"0123456789ABCDEFGHJKMNPQRSTVWXYZabcdefghjkmnpqrstvwxyz"; +const APP_SESSION_ENTROPY_LENGTH: usize = 20; + +fn generate_app_session_token() -> AppSessionToken { + use rand::Rng; + let mut rng = rand::thread_rng(); + let entropy: String = (0..APP_SESSION_ENTROPY_LENGTH) + .map(|_| { + let idx = rng.gen_range(0..APP_SESSION_ENTROPY_CHARSET.len()); + APP_SESSION_ENTROPY_CHARSET[idx] as char + }) + .collect(); + AppSessionToken::new(format!("app_session_{entropy}")) +} + +pub async fn storyteller_activity_thread( + artcraft_platform_info: ArtcraftPlatformInfo, + artcraft_usage_tracker: ArtcraftUsageTracker, + storyteller_creds_manager: StorytellerCredentialManager, +) -> ! { + let startup = Instant::now(); + let app_session_token = generate_app_session_token(); + + info!("Session started at {:?} with token: {:?}", startup, app_session_token); + + loop { + let res = polling_loop( + &artcraft_usage_tracker, + &storyteller_creds_manager, + startup, + &artcraft_platform_info, + &app_session_token, + ).await; + if let Err(err) = res { + error!("An error occurred: {:?}", err); + } + // NB: Sleep if an error occurs. + tokio::time::sleep(std::time::Duration::from_millis(ERROR_SLEEP_MILLIS)).await; + } +} + +async fn polling_loop( + artcraft_usage_tracker: &ArtcraftUsageTracker, + storyteller_creds_manager: &StorytellerCredentialManager, + startup: Instant, + artcraft_platform_info: &ArtcraftPlatformInfo, + app_session_token: &AppSessionToken, +) -> AnyhowResult<()> { + loop { + let creds = storyteller_creds_manager.get_credentials()?; + + let creds = match creds { + None => { + tokio::time::sleep(std::time::Duration::from_millis(5_000)).await; + continue; + } + Some(creds) => { + if creds.is_empty() { + tokio::time::sleep(std::time::Duration::from_millis(5_000)).await; + continue; + } + creds + }, + }; + + let usage_data = artcraft_usage_tracker.get()?; + + let time_since_startup = Instant::now().duration_since(startup); + + let request = LogAppActiveUserRequest { + maybe_app_session_token: Some(app_session_token.clone()), + maybe_app_name: Some(CLIENT_NAME.to_string()), + maybe_app_version: Some(artcraft_platform_info.artcraft_version.clone()), + maybe_os_platform: Some(artcraft_platform_info.os_platform.as_str().to_owned()), + maybe_os_version: Some(artcraft_platform_info.os_version.clone()), + maybe_session_duration_seconds: Some(time_since_startup.as_secs()), + total_generation_count: Some(usage_data.total_generation_count), + image_generation_count: Some(usage_data.image_generation_count), + video_generation_count: Some(usage_data.video_generation_count), + object_generation_count: Some(usage_data.object_generation_count), + text_to_image_count: Some(usage_data.text_to_image_count), + image_to_image_count: Some(usage_data.image_to_image_count), + text_to_video_count: Some(usage_data.text_to_video_count), + image_to_video_count: Some(usage_data.image_to_video_count), + text_to_object_count: Some(usage_data.text_to_object_count), + image_to_object_count: Some(usage_data.image_to_object_count), + image_page_prompt_count: Some(usage_data.image_page_prompt_count), + video_page_prompt_count: Some(usage_data.video_page_prompt_count), + edit_page_prompt_count: Some(usage_data.edit_page_prompt_count), + stage_page_prompt_count: Some(usage_data.stage_page_prompt_count), + object_page_prompt_count: Some(usage_data.object_page_prompt_count), + other_page_prompt_count: Some(usage_data.other_page_prompt_count), + }; + + debug!("Logging active user with storyteller."); + + let result = log_active_user_v2( + &ApiHost::Storyteller, + Some(&creds), + request, + ).await; + + let wait_millis = match result { + Ok(result) => result.wait_for_retry_millis, + Err(err) => { + match &err { + StorytellerError::Api(ApiError::TooManyRequests(message)) => { + error!("Too many requests (sleeping): {:?}", message); + tokio::time::sleep(std::time::Duration::from_millis(ERROR_SLEEP_MILLIS)).await; + continue; + } + _ => {} + } + return Err(anyhow!(err)); + } + }; + + // Wait at least a minute, no matter what the server tells us. + let wait_millis = std::cmp::min(wait_millis, 60_000); + tokio::time::sleep(std::time::Duration::from_millis(wait_millis)).await; + } +} diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/events/maybe_handle_frontend_caller_notification.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/events/maybe_handle_frontend_caller_notification.rs new file mode 100644 index 00000000..b9432b36 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/events/maybe_handle_frontend_caller_notification.rs @@ -0,0 +1,130 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::gaussian_generation_complete_event::{GaussianGenerationCompleteEvent, GeneratedGaussian}; +use crate::events::functional_events::object_generation_complete_event::{GeneratedObject, ObjectGenerationCompleteEvent}; +use crate::events::functional_events::text_to_image_generation_complete_event::{GeneratedImage, TextToImageGenerationCompleteEvent}; +use crate::events::functional_events::video_generation_complete_event::{GeneratedVideo, VideoGenerationCompleteEvent}; +use artcraft_client::api_defs::jobs::get_job_status::JobStatusPayload; +use artcraft_client::api_defs::media_file::list_media_files_by_job::JobMediaFileInfo; +use artcraft_client::api_defs::utils::media_links_to_thumbnail_template::media_links_to_thumbnail_template; +use errors::AnyhowResult; +use log::warn; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use tauri::AppHandle; +use url::Url; + +/// One generated output file, in the shape the typed frontend events share. +struct GeneratedFile { + media_token: MediaFileToken, + cdn_url: Url, + maybe_thumbnail_template: Option, +} + +pub async fn maybe_handle_frontend_caller_notification( + app: &AppHandle, + task: &Task, + job: &JobStatusPayload, + media_files: &[JobMediaFileInfo], +) -> AnyhowResult<()> { + // Every file the job produced. When the media-file -> source-job linkage + // isn't populated, fall back to the job's single result entity. + let generated_files = collect_generated_files(job, media_files); + + if generated_files.is_empty() { + warn!("Job has no result files for task: {:?}", task); + return Ok(()); // No results, nothing to announce. + } + + match task.task_type { + TaskType::ImageGeneration => { + let event = TextToImageGenerationCompleteEvent { + generated_images: generated_files.into_iter() + .map(|file| GeneratedImage { + media_token: file.media_token, + cdn_url: file.cdn_url, + maybe_thumbnail_template: file.maybe_thumbnail_template, + }) + .collect(), + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + event.send_infallible(app); + } + TaskType::VideoGeneration => { + let event = VideoGenerationCompleteEvent { + generated_videos: generated_files.into_iter() + .map(|file| GeneratedVideo { + media_token: file.media_token, + cdn_url: file.cdn_url, + maybe_thumbnail_template: file.maybe_thumbnail_template, + }) + .collect(), + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + event.send_infallible(app); + } + TaskType::MeshGeneration => { + let event = ObjectGenerationCompleteEvent { + generated_objects: generated_files.into_iter() + .map(|file| GeneratedObject { + media_token: file.media_token, + cdn_url: file.cdn_url, + maybe_thumbnail_template: file.maybe_thumbnail_template, + }) + .collect(), + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + event.send_infallible(app); + } + TaskType::SplatGeneration => { + let event = GaussianGenerationCompleteEvent { + generated_gaussians: generated_files.into_iter() + .map(|file| GeneratedGaussian { + media_token: file.media_token, + cdn_url: file.cdn_url, + maybe_thumbnail_template: file.maybe_thumbnail_template, + }) + .collect(), + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + event.send_infallible(app); + } + TaskType::AudioGeneration => { + // No typed audio notification yet; generic completion events still fire. + } + } + + Ok(()) +} + +fn collect_generated_files( + job: &JobStatusPayload, + media_files: &[JobMediaFileInfo], +) -> Vec { + if !media_files.is_empty() { + return media_files.iter() + .map(|file| GeneratedFile { + media_token: file.token.clone(), + cdn_url: file.media_links.cdn_url.clone(), + maybe_thumbnail_template: media_links_to_thumbnail_template(&file.media_links) + .map(|template| template.to_owned()), + }) + .collect(); + } + + // Fall back to the single result entity on the job itself. + job.maybe_result + .as_ref() + .map(|result| GeneratedFile { + media_token: MediaFileToken::new_from_str(&result.entity_token), + cdn_url: result.media_links.cdn_url.clone(), + maybe_thumbnail_template: media_links_to_thumbnail_template(&result.media_links) + .map(|template| template.to_owned()), + }) + .into_iter() + .collect() +} diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/events/mod.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/events/mod.rs new file mode 100644 index 00000000..3f571eba --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/events/mod.rs @@ -0,0 +1 @@ +pub (super) mod maybe_handle_frontend_caller_notification; diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/handle_storyteller_failed_job.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/handle_storyteller_failed_job.rs new file mode 100644 index 00000000..348343da --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/handle_storyteller_failed_job.rs @@ -0,0 +1,50 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::generation_failed_event::GenerationFailedEvent; +use crate::state::database::task_database::TaskDatabase; +use crate::utils::enum_conversion::generation_source::to_generation_service_provider; +use crate::utils::enum_conversion::task_failure_type::task_failure_type_from_frontend_failure_category_for_api; +use crate::utils::enum_conversion::task_type::to_generation_action; +use artcraft_client::api_defs::jobs::get_job_status::JobStatusPayload; +use errors::AnyhowResult; +use log::info; +use sqlite_database::queries::task::Task; +use sqlite_database::queries::update::update_task_status_with_rich_failure::{update_task_status_with_rich_failure, UpdateTaskWithRichFailureArgs}; +use sqlite_identifiers::enums::task_status::TaskStatus; +use tauri::AppHandle; + +pub async fn handle_failed_job( + app_handle: &AppHandle, + job: &JobStatusPayload, + task: &Task, + task_database: &TaskDatabase, +) -> AnyhowResult<()> { + info!("Marking storyteller job as failed: {:?}", task.id); + + let maybe_failure_type = job.status + .maybe_failure_category + .as_ref() + .map(task_failure_type_from_frontend_failure_category_for_api); + + update_task_status_with_rich_failure(UpdateTaskWithRichFailureArgs { + db: task_database.get_connection(), + task_id: &task.id, + status: TaskStatus::CompleteFailure, + maybe_failure_type, + // NB: The job status endpoints don't carry a user-facing failure message. + maybe_failure_message: None, + }).await?; + + let service = to_generation_service_provider(task.provider); + let action = to_generation_action(task.task_type); + + let event = GenerationFailedEvent { + action, + service, + model: None, + reason: None, + }; + + event.send_infallible(app_handle); + + Ok(()) +} diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/handle_storyteller_successful_job.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/handle_storyteller_successful_job.rs new file mode 100644 index 00000000..a0c8be1b --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/handle_storyteller_successful_job.rs @@ -0,0 +1,293 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::generation_complete_event::GenerationCompleteEvent; +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::state::thumbnails::thumbnail_work_queue::ThumbnailWorkQueue; +use crate::state::app_preferences::settings::preferred_download_filename::{model_slug_from_model_type_str, DownloadFilenameParts}; +use chrono::Local; +use crate::utils::download::download_url_to_download_dir_via_temp::download_url_to_download_dir_via_temp; +use crate::utils::download::record_task_download_locations::record_task_download_locations; +use std::path::PathBuf; +use crate::utils::enum_conversion::generation_source::to_generation_service_provider; +use crate::utils::enum_conversion::task_type::to_generation_action; +use super::events::maybe_handle_frontend_caller_notification::maybe_handle_frontend_caller_notification; +use artcraft_client::api_defs::jobs::get_job_status::JobStatusPayload; +use artcraft_client::api_defs::media_file::list_media_files_by_job::JobMediaFileInfo; +use artcraft_client::api_defs::utils::media_links_to_thumbnail_template::media_links_to_thumbnail_template; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::media_files::list_media_files_by_job::list_media_files_by_job; +use artcraft_client::enums::by_table::generic_inference_jobs::inference_category::InferenceCategory; +use artcraft_client::enums::by_table::media_files::media_file_class::MediaFileClass; +use artcraft_client::utils::api_host::ApiHost; +use errors::AnyhowResult; +use log::error; +use log::info; +use log::warn; +use sqlite_database::queries::task::Task; +use sqlite_database::queries::update::update_successful_task_status_with_metadata::{update_successful_task_status_with_metadata, UpdateSuccessfulTaskArgs}; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use tauri::AppHandle; + +pub async fn handle_successful_job( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + creds: Option<&StorytellerCredentialSet>, + job: &JobStatusPayload, + task: &Task, + task_database: &TaskDatabase, +) -> AnyhowResult<()> { + // A job can produce MULTIPLE files (e.g. a 4-image batch). List them all so + // every file is delivered, not just the job's primary result entity. + let media_files = list_all_job_media_files(creds, job).await; + + // Primary media file: the first listed file, falling back to the job's + // single result entity (some generation paths don't populate the + // media-file -> source-job linkage yet). + let maybe_primary_media_file_token = media_files.first() + .map(|file| file.token.clone()) + .or_else(|| { + job.maybe_result + .as_ref() + .map(|result| MediaFileToken::new_from_str(&result.entity_token)) + }); + + let updated = update_successful_task_status_with_metadata(UpdateSuccessfulTaskArgs { + db: task_database.get_connection(), + task_id: &task.id, + maybe_batch_token: media_files.first() + .and_then(|file| file.maybe_batch_token.as_ref()), + maybe_primary_media_file_token: maybe_primary_media_file_token.as_ref(), + maybe_primary_media_file_class: get_media_file_class(job, media_files.first()), + maybe_primary_media_file_thumbnail_url_template: get_thumbnail_template(job, media_files.first()), + maybe_primary_media_file_cdn_url: media_files.first() + .map(|file| file.media_links.cdn_url.as_str()) + .or_else(|| { + job.maybe_result + .as_ref() + .map(|result| result.media_links.cdn_url.as_str()) + }), + }).await?; + + if !updated { + return Ok(()); // If anything breaks with queries, don't spam events. + } + + let downloaded = download_all_files(app_data_root, app_preferences, job, task, &media_files).await; + record_task_download_locations(task_database, &task.id, &downloaded).await; + ThumbnailWorkQueue::enqueue_for_app(app_handle, &downloaded); + + send_additional_success_events(app_handle, job, task, &media_files).await; + + let service = to_generation_service_provider(task.provider); + let action = to_generation_action(task.task_type); + + let event = GenerationCompleteEvent { + action: Some(action), + service, + model: None, // TODO + }; + + if let Err(err) = event.send(app_handle) { + error!("Failed to send GenerationCompleteEvent: {:?}", err); // Fail open + } + + Ok(()) +} + +/// Download every file the job produced into the user's configured download +/// directory (temp dir first, then moved into place), named per the user's +/// preferred filename convention. Fails open per file so one bad download +/// doesn't lose the rest. Returns the files' paths (in job order), including +/// ones that were already there from an earlier run. +async fn download_all_files( + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + job: &JobStatusPayload, + task: &Task, + media_files: &[JobMediaFileInfo], +) -> Vec { + let mut downloaded = Vec::new(); + let app_prefs = match app_preferences.get() { + Ok(prefs) => prefs, + Err(err) => { + error!("Can't read app preferences; skipping downloads for job {}: {:?}", job.job_token.as_str(), err); + return downloaded; + } + }; + + // Every listed file; fall back to the job's single result entity when the + // media-file listing is empty. + let cdn_urls = if media_files.is_empty() { + job.maybe_result + .as_ref() + .map(|result| result.media_links.cdn_url.clone()) + .into_iter() + .collect::>() + } else { + media_files.iter() + .map(|file| file.media_links.cdn_url.clone()) + .collect::>() + }; + + let model_slug = task.model_type + .as_ref() + .map(|model_type| model_slug_from_model_type_str(model_type.to_str())) + .unwrap_or_else(|| "artcraft".to_string()); + + let download_time = Local::now(); + + for (index, cdn_url) in cdn_urls.iter().enumerate() { + let extension = cdn_url.path() + .rsplit('.') + .next() + .unwrap_or("bin") + .to_string(); + + let filename = app_prefs.downloads.preferred_download_filename.build_filename(&DownloadFilenameParts { + model_slug: &model_slug, + download_time, + maybe_batch_index: (cdn_urls.len() > 1).then(|| index + 1), + extension: &extension, + }); + + match download_url_to_download_dir_via_temp(cdn_url, Some(&filename), app_data_root, &app_prefs).await { + Ok(path) => { + info!("Downloaded job {} file to {:?}", job.job_token.as_str(), path); + downloaded.push(path); + } + Err(ArtcraftXError::CannotDownloadFilePathAlreadyExists { path }) => { + info!("Job {} file already downloaded: {:?}", job.job_token.as_str(), path); + downloaded.push(path); + } + Err(err) => { + error!("Failed to download job {} file {}: {:?}", job.job_token.as_str(), cdn_url, err); + } + } + } + downloaded +} + +/// Fetch every media file the job produced. Fails open with an empty list +/// (callers fall back to the job's single result entity). +async fn list_all_job_media_files( + creds: Option<&StorytellerCredentialSet>, + job: &JobStatusPayload, +) -> Vec { + let creds = match creds { + Some(creds) => creds, + None => { + warn!("No credentials; can't list media files for job {}", job.job_token.as_str()); + return Vec::new(); + } + }; + + match list_media_files_by_job(&ApiHost::Storyteller, creds, &job.job_token).await { + Ok(response) => response.media_files, + Err(err) => { + warn!("Failed to list media files for job {}: {:?}", job.job_token.as_str(), err); + Vec::new() + } + } +} + +async fn send_additional_success_events( + app_handle: &AppHandle, + job: &JobStatusPayload, + task: &Task, + media_files: &[JobMediaFileInfo], +) { + info!("Attempting to dispatch events for completed Storyteller job: {:?}", task); + + let result = maybe_handle_frontend_caller_notification( + app_handle, + task, + job, + media_files, + ).await; + + if let Err(err) = result { + error!("Failed to send generation complete event: {:?}", err); + } +} + +fn get_thumbnail_template<'a>( + job: &'a JobStatusPayload, + maybe_primary_file: Option<&'a JobMediaFileInfo>, +) -> Option<&'a str> { + if let Some(file) = maybe_primary_file { + if let Some(template) = media_links_to_thumbnail_template(&file.media_links) { + return Some(template); + } + } + + let links = match job.maybe_result.as_ref() { + None => return None, + Some(result) => &result.media_links, + }; + + media_links_to_thumbnail_template(links) +} + +fn get_media_file_class( + job: &JobStatusPayload, + maybe_primary_file: Option<&JobMediaFileInfo>, +) -> Option { + // The listed media file's class is authoritative when we have it. + if let Some(file) = maybe_primary_file { + match file.media_class { + MediaFileClass::Audio => return Some(TaskMediaFileClass::Audio), + MediaFileClass::Image => return Some(TaskMediaFileClass::Image), + MediaFileClass::Video => return Some(TaskMediaFileClass::Video), + MediaFileClass::Mesh => return Some(TaskMediaFileClass::Mesh), + MediaFileClass::Splat => return Some(TaskMediaFileClass::Splat), + _ => {} // Fall-through (Unknown / legacy Dimensional / Project): infer below. + } + } + + match job.request.inference_category { + InferenceCategory::BackgroundRemoval => return Some(TaskMediaFileClass::Image), + InferenceCategory::ImageGeneration => return Some(TaskMediaFileClass::Image), + InferenceCategory::VideoGeneration => return Some(TaskMediaFileClass::Video), + InferenceCategory::ObjectGeneration => return Some(TaskMediaFileClass::Mesh), + _ => {}, // Fall-through + } + + let url = match (maybe_primary_file, job.maybe_result.as_ref()) { + (Some(file), _) => file.media_links.cdn_url.as_str(), + (None, Some(result)) => result.media_links.cdn_url.as_str(), + (None, None) => return None, + }; + + if url.ends_with("jpg") + || url.ends_with("jpeg") + || url.ends_with("png") + { + return Some(TaskMediaFileClass::Image); + } + + if url.ends_with("mp4") + || url.ends_with("webm") + { + return Some(TaskMediaFileClass::Video); + } + + if url.ends_with("glb") { + return Some(TaskMediaFileClass::Mesh); + } + + if url.ends_with("ply") || url.ends_with("spz") { + return Some(TaskMediaFileClass::Splat); + } + + if url.ends_with("wav") + || url.ends_with("mp3") + { + return Some(TaskMediaFileClass::Audio); + } + + None +} diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/mod.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/mod.rs new file mode 100644 index 00000000..d0222b17 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/mod.rs @@ -0,0 +1,4 @@ +mod events; +mod handle_storyteller_failed_job; +mod handle_storyteller_successful_job; +pub mod storyteller_task_polling_thread; diff --git a/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/storyteller_task_polling_thread.rs b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/storyteller_task_polling_thread.rs new file mode 100644 index 00000000..d95c4398 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/threads/storyteller_task_polling_thread/storyteller_task_polling_thread.rs @@ -0,0 +1,122 @@ +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::storyteller::threads::storyteller_task_polling_thread::handle_storyteller_failed_job::handle_failed_job; +use crate::services::storyteller::threads::storyteller_task_polling_thread::handle_storyteller_successful_job::handle_successful_job; +use crate::state::database::task_database::TaskDatabase; +use anyhow::anyhow; +use artcraft_client::endpoints::jobs::batch_get_job_status::batch_get_job_status; +use artcraft_client::enums::common::job_status_plus::JobStatusPlus; +use artcraft_client::error::api_error::ApiError; +use artcraft_client::error::storyteller_error::StorytellerError; +use artcraft_client::tokens::generic_inference_jobs::InferenceJobToken; +use artcraft_client::utils::api_host::ApiHost; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::error; +use sqlite_database::queries::read::list_tasks_by_provider_and_status::{list_tasks_by_provider_and_status, ListTasksByProviderAndStatusArgs}; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_status::TaskStatus; +use std::collections::{HashMap, HashSet}; +use tauri::AppHandle; + +pub async fn storyteller_task_polling_thread( + app_handle: AppHandle, + app_data_root: AppDataRoot, + app_preferences: AppPreferencesManager, + task_database: TaskDatabase, + storyteller_creds_manager: StorytellerCredentialManager, +) -> ! { + loop { + let res = polling_loop( + &app_handle, + &app_data_root, + &app_preferences, + &task_database, + &storyteller_creds_manager, + ).await; + if let Err(err) = res { + error!("An error occurred: {:?}", err); + } + // NB: Only sleep if an error occurs. + tokio::time::sleep(std::time::Duration::from_millis(30_000)).await; + } +} + +async fn polling_loop( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, +) -> AnyhowResult<()> { + loop { + // Wait before next request for jobs. + tokio::time::sleep(std::time::Duration::from_millis(5_000)).await; + + // Only poll for tasks that are still in flight. + let unfinished_statuses = HashSet::from([TaskStatus::Pending, TaskStatus::Started]); + + let tasks = list_tasks_by_provider_and_status(ListTasksByProviderAndStatusArgs { + db: task_database.get_connection(), + provider: GenerationSource::Artcraft, + task_statuses: &unfinished_statuses, + }).await?; + + let tasks_by_provider_job_id = tasks.tasks.iter() + .filter_map(|task| { + task.provider_job_id + .as_ref() + .map(|provider_job_id| (provider_job_id.clone(), task.clone())) + }) + .collect::>(); + + if tasks_by_provider_job_id.is_empty() { + continue; // Nothing in flight. + } + + let job_tokens = tasks_by_provider_job_id.keys() + .map(|job_id| InferenceJobToken::new_from_str(job_id)) + .collect::>(); + + let creds = storyteller_creds_manager.get_credentials()?; + + let result = batch_get_job_status( + &ApiHost::Storyteller, + creds.as_ref(), + &job_tokens, + ).await; + + let job_states = match result { + Ok(result) => result.job_states, + Err(err) => { + match &err { + StorytellerError::Api(ApiError::TooManyRequests(message)) => { + error!("Too many requests (sleeping): {:?}", message); + tokio::time::sleep(std::time::Duration::from_millis(60_000)).await; + } + _ => {} + } + return Err(anyhow!(err)); + } + }; + + for job in job_states.iter() { + let task = match tasks_by_provider_job_id.get(job.job_token.as_str()) { + Some(task) => task, + None => continue, + }; + + match job.status.status { + JobStatusPlus::CompleteSuccess => { + handle_successful_job(app_handle, app_data_root, app_preferences, creds.as_ref(), job, task, task_database).await?; + } + JobStatusPlus::CompleteFailure | JobStatusPlus::Dead => { + handle_failed_job(app_handle, job, task, task_database).await?; + } + _ => continue, + } + } + + } +} diff --git a/crates/artcraftx/src/services/storyteller/utils/download_media_file_to_temp_dir.rs b/crates/artcraftx/src/services/storyteller/utils/download_media_file_to_temp_dir.rs new file mode 100644 index 00000000..83ff586f --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/utils/download_media_file_to_temp_dir.rs @@ -0,0 +1,31 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::get_url_file_extension::get_url_file_extension; +use crate::utils::download::simple_http_download_to_tempfile::simple_http_download_to_tempfile; +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use tempfile::NamedTempFile; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +// TODO: Better more concrete error handling + +pub async fn download_media_file_to_temp_dir(app_data_root: &AppDataRoot, token: &MediaFileToken) -> Result { + let response = get_media_file( + &ApiHost::Storyteller, + token + ).await?; + + let media_file_url = &response.media_file.media_links.cdn_url; + + let extension_with_dot = get_url_file_extension(media_file_url) + .map(|ext| format!(".{}", ext)) + .unwrap_or_else(|| ".png".to_string()); // TODO: Better default extension passed by caller as heuristic. + + //let filename = format!("{}{}", response.media_file.token.as_str(), extension_with_dot); + //let filename = app_data_root.downloads_dir().path().join(&filename); + + let mut file = app_data_root.temp_dir().new_named_temp_file_with_extension(&extension_with_dot)?; + + simple_http_download_to_tempfile(&media_file_url, &mut file).await?; + + Ok(file) // NB: Must return TempFile to not drop / delete it +} diff --git a/crates/artcraftx/src/services/storyteller/utils/mod.rs b/crates/artcraftx/src/services/storyteller/utils/mod.rs new file mode 100644 index 00000000..aa9867a9 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/utils/mod.rs @@ -0,0 +1,2 @@ +pub mod download_media_file_to_temp_dir; +pub mod upload_bytes_to_media_file; diff --git a/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/mod.rs b/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/mod.rs new file mode 100644 index 00000000..9f4a49e1 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/mod.rs @@ -0,0 +1,2 @@ +pub mod upload_image_bytes_as_media_file; +pub mod upload_mask_image_bytes_as_media_file; diff --git a/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/upload_image_bytes_as_media_file.rs b/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/upload_image_bytes_as_media_file.rs new file mode 100644 index 00000000..215bfb0d --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/upload_image_bytes_as_media_file.rs @@ -0,0 +1,38 @@ +use log::info; + +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::media_files::upload_image_media_file_from_bytes::{ + upload_image_media_file_from_bytes, ImageType, UploadImageBytesArgs, +}; +use artcraft_client::utils::api_host::ApiHost; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::generate_error::GenerateError; + +/// Upload raw image bytes to ArtCraft, returning the resulting MediaFileToken. +/// +/// This is NOT marked as an intermediate system file — the image will appear +/// in the user's gallery. +pub async fn upload_image_bytes_as_media_file( + creds: &StorytellerCredentialSet, + api_host: &ApiHost, + image_bytes: Vec, +) -> Result { + info!("Uploading image bytes ({} bytes) as media file...", image_bytes.len()); + + let result = upload_image_media_file_from_bytes(UploadImageBytesArgs { + api_host, + maybe_creds: Some(creds), + image_bytes, + image_type: ImageType::Png, + is_intermediate_system_file: false, + maybe_generation_provider: None, + }).await.map_err(|err| { + log::error!("Failed to upload image bytes as media file: {:?}", err); + GenerateError::from(err) + })?; + + info!("Uploaded image bytes as media file: {}", result.media_file_token.as_str()); + + Ok(result.media_file_token) +} diff --git a/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/upload_mask_image_bytes_as_media_file.rs b/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/upload_mask_image_bytes_as_media_file.rs new file mode 100644 index 00000000..f9ec48ed --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/utils/upload_bytes_to_media_file/upload_mask_image_bytes_as_media_file.rs @@ -0,0 +1,48 @@ +use log::{error, info}; + +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::media_files::upload_image_media_file_from_bytes::{ + upload_image_media_file_from_bytes, ImageType, UploadImageBytesArgs, +}; +use artcraft_client::utils::api_host::ApiHost; +use images::mask_images::normalize_image_bytes_to_flux_mask::normalize_image_bytes_to_flux_mask; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::commands::generate::generate_error::GenerateError; + +/// Upload raw mask image bytes to ArtCraft, returning the resulting MediaFileToken. +/// +/// The mask bytes are first normalized via `normalize_image_bytes_to_flux_mask` +/// (transparent pixels → black/ignore, opaque pixels → white/interest region), +/// then uploaded as an intermediate system file (hidden from the user's gallery). +pub async fn upload_mask_image_bytes_as_media_file( + creds: &StorytellerCredentialSet, + api_host: &ApiHost, + mask_image_bytes: &[u8], +) -> Result { + info!("Normalizing mask image bytes ({} bytes)...", mask_image_bytes.len()); + + let normalized = normalize_image_bytes_to_flux_mask(mask_image_bytes) + .map_err(|err| { + error!("Failed to normalize mask image bytes: {:?}", err); + GenerateError::AnyhowError(anyhow::anyhow!("Failed to normalize mask image bytes")) + })?; + + info!("Uploading normalized mask ({} bytes) as intermediate system file...", normalized.0.len()); + + let result = upload_image_media_file_from_bytes(UploadImageBytesArgs { + api_host, + maybe_creds: Some(creds), + image_bytes: normalized.0, + image_type: ImageType::Png, + is_intermediate_system_file: true, + maybe_generation_provider: None, + }).await.map_err(|err| { + error!("Failed to upload mask image bytes: {:?}", err); + GenerateError::from(err) + })?; + + info!("Uploaded mask as media file: {}", result.media_file_token.as_str()); + + Ok(result.media_file_token) +} diff --git a/crates/artcraftx/src/services/storyteller/windows/clear_main_webview_window_storyteller_cookies.rs b/crates/artcraftx/src/services/storyteller/windows/clear_main_webview_window_storyteller_cookies.rs new file mode 100644 index 00000000..e76c532a --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/windows/clear_main_webview_window_storyteller_cookies.rs @@ -0,0 +1,59 @@ +use crate::windows::main_window::constants::MAIN_WINDOW_NAME; +use errors::AnyhowResult; +use log::warn; +use tauri::webview::Cookie; +use tauri::{AppHandle, Manager}; + +pub fn clear_main_webview_window_storyteller_cookies(app: &AppHandle) -> AnyhowResult<()> { + let main_webview_window = app.get_webview_window(MAIN_WINDOW_NAME) + .ok_or_else(|| anyhow::anyhow!("Main window not found"))?; + + let cookies = main_webview_window.cookies()?; + + let cookies_to_delete = get_cookies_to_delete(cookies); + + let mut maybe_error = None; + + for cookie in cookies_to_delete { + if let Err(err) = main_webview_window.delete_cookie(cookie) { + warn!("Failed to delete cookie: {:?}", err); + maybe_error = Some(err); + } + } + + if let Some(err) = maybe_error { + return Err(anyhow::anyhow!("Failed to delete some cookies. Here's one failure: {:?}", err)); + } + + Ok(()) +} + +// TODO: This will need to handle local development, too. +fn get_cookies_to_delete(cookies: Vec) -> Vec { + cookies.into_iter() + .filter(|cookie| { + // Define your filtering logic here + // For example, delete cookies with a specific name or domain + match cookie.domain() { + // storyteller.ai + Some("api.storyteller.ai") => true, + Some("storyteller.ai") => true, + Some(domain) if domain.ends_with(".storyteller.ai") => true, + // getartcraft.com + Some("api.getartcraft.com") => true, + Some("getartcraft.com") => true, + Some(domain) if domain.ends_with(".getartcraft.com") => true, + // artcraft.ai + Some("api.artcraft.ai") => true, + Some("artcraft.ai") => true, + Some(domain) if domain.ends_with(".artcraft.ai") => true, + // ignore all others + None => false, + Some(domain) => { + warn!("Ignoring cookie with unrecognized domain: {}", domain); + false + } + } + }) + .collect() +} \ No newline at end of file diff --git a/crates/artcraftx/src/services/storyteller/windows/mod.rs b/crates/artcraftx/src/services/storyteller/windows/mod.rs new file mode 100644 index 00000000..ef56e025 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/windows/mod.rs @@ -0,0 +1,3 @@ +pub mod clear_main_webview_window_storyteller_cookies; +pub mod open_storyteller_billing_window; +pub mod storyteller_billing_window_thread; \ No newline at end of file diff --git a/crates/artcraftx/src/services/storyteller/windows/open_storyteller_billing_window.rs b/crates/artcraftx/src/services/storyteller/windows/open_storyteller_billing_window.rs new file mode 100644 index 00000000..c6026c74 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/windows/open_storyteller_billing_window.rs @@ -0,0 +1,284 @@ +use artcraft_client::utils::api_host::ApiHost; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::services::storyteller::windows::storyteller_billing_window_thread::storyteller_billing_window_thread; +use anyhow::anyhow; +use artcraft_client::api_defs::stripe_artcraft::create_credits_pack_checkout::StripeArtcraftCreateCreditsPackCheckoutRequest; +use artcraft_client::api_defs::stripe_artcraft::create_subscription_checkout::{PlanBillingCadence, StripeArtcraftCreateSubscriptionCheckoutRequest}; +use artcraft_client::api_defs::stripe_artcraft::customer_portal_cancel_plan::StripeArtcraftCustomerPortalCancelPlanRequest; +use artcraft_client::api_defs::stripe_artcraft::customer_portal_manage_plan::StripeArtcraftCustomerPortalManagePlanRequest; +use artcraft_client::api_defs::stripe_artcraft::customer_portal_switch_plan::{PlanBillingCadenceConfirmation, StripeArtcraftCustomerPortalSwitchPlanRequest}; +use artcraft_client::api_defs::stripe_artcraft::customer_portal_update_payment_method::StripeArtcraftCustomerPortalUpdatePaymentMethodRequest; +use artcraft_client::enums::common::artcraft_credits_pack_slug::ArtcraftCreditsPackSlug; +use artcraft_client::enums::common::artcraft_subscription_slug::ArtcraftSubscriptionSlug; +use errors::AnyhowResult; +use log::info; +use reqwest::Url; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::stripe_artcraft::create_credits_pack_checkout::create_credits_pack_checkout; +use artcraft_client::endpoints::stripe_artcraft::create_subscription_checkout::create_subscription_checkout; +use artcraft_client::endpoints::stripe_artcraft::customer_portal_cancel_plan::customer_portal_cancel_plan; +use artcraft_client::endpoints::stripe_artcraft::customer_portal_manage_plan::customer_portal_manage_plan; +use artcraft_client::endpoints::stripe_artcraft::customer_portal_switch_plan::customer_portal_switch_plan; +use artcraft_client::endpoints::stripe_artcraft::customer_portal_update_payment_method::customer_portal_update_payment_method; +use tauri::{AppHandle, Manager, WebviewUrl, WebviewWindowBuilder}; + +pub const BILLING_WINDOW_NAME: &str = "artcraft_billing_window"; + +pub struct OpenStorytellerBillingWindowArgs<'a> { + pub app: &'a AppHandle, + pub app_data_root: &'a AppDataRoot, + pub storyteller_creds_manager: &'a StorytellerCredentialManager, + pub billing_window_case: BillingWindowCase, +} + +pub enum BillingWindowCase { + /// Purchase a subscription plan with the billing cadence supplied. + Subscription { + plan: ArtcraftSubscriptionSlug, + cadence: PlanBillingCadence, + }, + + /// Purchase a credits pack. + CreditsPack { + credits_pack: ArtcraftCreditsPackSlug, + }, + + /// Cancel the user's subscription. + /// Stripe shows a confirmation and then cancels the subscription. + CustomerPortalCancelPlan, + + /// Manage the user's subscription. + /// Stripe shows complete controls for updating the plan, payment method, etc. + CustomerPortalManagePlan, + + /// Switch the user's subscription plan. + /// Stripe pre-fills to the selected plan and cadence. + CustomerPortalSwitchPlan { + plan: ArtcraftSubscriptionSlug, + cadence: PlanBillingCadenceConfirmation, + }, + + /// Change the payment method attached to the customer / subscription. + CustomerPortalUpdatePaymentMethod, +} + +pub async fn open_storyteller_billing_window( + args: OpenStorytellerBillingWindowArgs<'_>, +) -> AnyhowResult<()> { + + if args.app.get_window(BILLING_WINDOW_NAME).is_some() { + return Err(anyhow!("Billing window already open")); + } + + info!("Building Stripe Checkout session..."); + + let creds = args.storyteller_creds_manager.get_credentials_required()?; + + let checkout_url = match args.billing_window_case { + BillingWindowCase::Subscription { plan, cadence } => { + get_subscription_url( + &creds, + plan, + cadence, + ).await? + }, + BillingWindowCase::CreditsPack { credits_pack } => { + get_credits_pack_url( + &creds, + credits_pack, + ).await? + }, + BillingWindowCase::CustomerPortalCancelPlan => { + get_customer_portal_cancel_plan_url( + &creds, + ).await? + }, + BillingWindowCase::CustomerPortalManagePlan => { + get_customer_portal_manage_plan_url( + &creds, + ).await? + }, + BillingWindowCase::CustomerPortalSwitchPlan { plan, cadence } => { + get_customer_portal_switch_plan_url( + &creds, + plan, + cadence, + ).await? + }, + BillingWindowCase::CustomerPortalUpdatePaymentMethod => { + get_customer_portal_update_payment_method_url( + &creds, + ).await? + } + }; + + do_open_window(args.app, args.app_data_root, checkout_url).await?; + + Ok(()) +} + +async fn get_subscription_url( + storyteller_creds: &StorytellerCredentialSet, + plan: ArtcraftSubscriptionSlug, + cadence: PlanBillingCadence, +) -> AnyhowResult { + + info!("Getting URL for subscription checkout..."); + + let request = StripeArtcraftCreateSubscriptionCheckoutRequest { + plan: Some(plan), + cadence: Some(cadence), + }; + + let result = create_subscription_checkout( + &ApiHost::Storyteller, + Some(&storyteller_creds), + request, + ).await?; + + info!("Checkout session created..."); + + let url = Url::parse(&result.stripe_checkout_redirect_url)?; + Ok(url) +} + +async fn get_credits_pack_url( + storyteller_creds: &StorytellerCredentialSet, + credits_pack: ArtcraftCreditsPackSlug, +) -> AnyhowResult { + + info!("Getting URL for credits pack checkout..."); + + let request = StripeArtcraftCreateCreditsPackCheckoutRequest { + credits_pack: Some(credits_pack), + }; + + let result = create_credits_pack_checkout( + &ApiHost::Storyteller, + Some(&storyteller_creds), + request, + ).await?; + + info!("Credits pack checkout session created..."); + Ok(Url::parse(&result.stripe_checkout_redirect_url)?) +} + +async fn get_customer_portal_cancel_plan_url( + storyteller_creds: &StorytellerCredentialSet, +) -> AnyhowResult { + + info!("Getting customer portal cancel plan session..."); + + let request = StripeArtcraftCustomerPortalCancelPlanRequest { + portal_config_id: None, + }; + + let result = customer_portal_cancel_plan( + &ApiHost::Storyteller, + Some(&storyteller_creds), + request, + ).await?; + + info!("Customer portal cancel plan session created..."); + Ok(Url::parse(&result.stripe_portal_url)?) +} + +async fn get_customer_portal_manage_plan_url( + storyteller_creds: &StorytellerCredentialSet, +) -> AnyhowResult { + + info!("Getting customer portal manage plan session..."); + + let request = StripeArtcraftCustomerPortalManagePlanRequest { + portal_config_id: None, + }; + + let result = customer_portal_manage_plan( + &ApiHost::Storyteller, + Some(&storyteller_creds), + request, + ).await?; + + info!("Customer portal manage plan session created..."); + Ok(Url::parse(&result.stripe_portal_url)?) +} + +async fn get_customer_portal_switch_plan_url( + storyteller_creds: &StorytellerCredentialSet, + plan: ArtcraftSubscriptionSlug, + cadence: PlanBillingCadenceConfirmation, +) -> AnyhowResult { + + info!("Getting customer portal switch plan session..."); + + let request = StripeArtcraftCustomerPortalSwitchPlanRequest { + portal_config_id: None, + plan: Some(plan), + cadence: Some(cadence), + }; + + let result = customer_portal_switch_plan( + &ApiHost::Storyteller, + Some(&storyteller_creds), + request, + ).await?; + + info!("Customer portal switch plan session created..."); + Ok(Url::parse(&result.stripe_portal_url)?) +} + +async fn get_customer_portal_update_payment_method_url( + storyteller_creds: &StorytellerCredentialSet, +) -> AnyhowResult { + + info!("Getting customer portal update payment method session..."); + + let request = StripeArtcraftCustomerPortalUpdatePaymentMethodRequest { + portal_config_id: None, + }; + + let result = customer_portal_update_payment_method( + &ApiHost::Storyteller, + Some(&storyteller_creds), + request, + ).await?; + + info!("Customer portal update payment method created..."); + Ok(Url::parse(&result.stripe_portal_url)?) +} + +async fn do_open_window( + app: &AppHandle, + app_data_root: &AppDataRoot, + url: Url, +) -> AnyhowResult<()> { + let url = WebviewUrl::External(url); + + info!("Opening checkout window..."); + + // TODO(bt,2025-09-01): We probably need to open this in a real browser to get autocomplete. + let _window = WebviewWindowBuilder::new(app, BILLING_WINDOW_NAME, url) + .always_on_top(false) + .title("ArtCraft Billing") + .center() + .resizable(true) + .visible(true) + .closable(true) + .min_inner_size(1000.0, 800.0) + .focused(true) + .devtools(true) + .build()?; + + //let _webview = window.get_webview(BILLING_WINDOW_NAME) + // .ok_or_else(|| anyhow!("no webview found"))?; + + let app_handle = app.clone(); + let app_data_root = app_data_root.clone(); + + let _ = tauri::async_runtime::spawn(async move { + storyteller_billing_window_thread(app_handle, app_data_root).await; + }); + + Ok(()) +} diff --git a/crates/artcraftx/src/services/storyteller/windows/storyteller_billing_window_thread.rs b/crates/artcraftx/src/services/storyteller/windows/storyteller_billing_window_thread.rs new file mode 100644 index 00000000..8c406cd4 --- /dev/null +++ b/crates/artcraftx/src/services/storyteller/windows/storyteller_billing_window_thread.rs @@ -0,0 +1,107 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::credits_balance_changed_event::CreditsBalanceChangedEvent; +use crate::events::functional_events::subscription_plan_changed_event::SubscriptionPlanChangedEvent; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::storyteller::windows::open_storyteller_billing_window::BILLING_WINDOW_NAME; +use anyhow::anyhow; +use errors::AnyhowResult; +use log::{error, info}; +use tauri::{AppHandle, Manager, WebviewWindow}; + +pub async fn storyteller_billing_window_thread( + app: AppHandle, + _app_data_root: AppDataRoot, +) { + loop { + let billing_webview_window = match app.get_webview_window(BILLING_WINDOW_NAME) { + Some(webview) => webview, + None => { + info!("Exit billing window thread."); + return; // NB: Only exit if we don't have the webview. + } + }; + + let result = check_billing_window( + &app, + &billing_webview_window, + ).await; + + match result { + Err(err) => { + error!("Error checking billing window: {:?}", err); + } + Ok(false) => {} // Continue iteration and try again... + Ok(true) => { + info!("Checkout complete; exiting"); + if let Err(err) = billing_webview_window.close() { + error!("Error closing billing window: {:?}", err); + } + + // TODO: We can distinguish between subscription and credits impacts if we send a parameter + // from the webview. For now, just refresh everything. + + // Refresh the credits view + CreditsBalanceChangedEvent{}.send_infallible(&app); + SubscriptionPlanChangedEvent{}.send_infallible(&app); + + // And in case there's a race condition (likely), do it again after a delay. + tokio::time::sleep(std::time::Duration::from_millis(5_000)).await; + CreditsBalanceChangedEvent{}.send_infallible(&app); + SubscriptionPlanChangedEvent{}.send_infallible(&app); + + return; + } + } + + tokio::time::sleep(std::time::Duration::from_millis(1_000)).await; + } +} + +/// Returns true if we can exit. +async fn check_billing_window( + _app_handle: &AppHandle, + webview_window: &WebviewWindow, +) -> AnyhowResult { + + let url = webview_window.url()?; + + let hostname= url + .host() + .ok_or(anyhow!("no host in url"))? + .to_string(); + + match hostname.as_str() { + "getartcraft.com" | + "storyteller.ai" => { + // Checkout done. Fall-through. + }, + "stripe.com" | "checkout.stripe.com" => { + return Ok(false) // Still in checkout flow. + } + _ => { + return Ok(false) // Unknown hostname... + } + } + + let path = url + .path() + .to_string(); + + // TODO: This is brittle. + + let success = path.contains("checkout_success"); + + info!("Checkout success: {}", success); + + // TODO: Send success events: + + // let event = RefreshAccountStateEvent { + // provider: Some(GenerationSource::Midjourney), + // }; + // + // if let Err(err) = event.send(&app_handle) { + // error!("Failed to send RefreshAccountStateEvent: {:?}", err); // Fail open + // } + + Ok(true) +} diff --git a/crates/artcraftx/src/state/app_preferences/app_preferences.rs b/crates/artcraftx/src/state/app_preferences/app_preferences.rs new file mode 100644 index 00000000..14de5c99 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/app_preferences.rs @@ -0,0 +1,189 @@ +use crate::state::app_preferences::legacy_json_preferences::LegacyJsonPreferences; +use crate::state::app_preferences::settings::app_backup_preferences::AppBackupPreferences; +use crate::state::app_preferences::settings::app_download_preferences::AppDownloadPreferences; +use crate::state::app_preferences::settings::app_prompt_preferences::AppPromptPreferences; +use crate::state::app_preferences::settings::app_sound_preferences::AppSoundPreferences; +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use log::{info, warn}; +use serde_derive::{Deserialize, Serialize}; +use std::path::Path; + +/// File format version (not semver). +/// - 1..=3: the legacy JSON layout (see `legacy_json_preferences`). +/// - 4: TOML, grouped into `[sounds]` / `[downloads]` tables. +/// - 5: added the `[prompt]` table. +/// - 6: added the `[backup]` table. +const CURRENT_VERSION: u32 = 6; + +/// User-adjustable app preferences, persisted as `settings/app_preferences.toml`. +/// +/// Grouped by concern so the file reads as nested tables: +/// +/// ```toml +/// version = 4 +/// +/// [sounds] +/// play_sounds = true +/// enqueue_success = "done" +/// +/// [downloads] +/// preferred_download_filename = "artcraft_convention" +/// +/// [prompt] +/// enter_to_generate = true +/// +/// [backup] +/// enabled = true +/// maybe_artcraft_credential_id = "credential_01j9dq3v5x8k2m7n4p6r9t0wxy" +/// +/// [downloads.preferred_download_directory] +/// system = "downloads" +/// ``` +/// +/// Every group defaults independently, so a file missing a group (or a field) +/// still loads. +#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct AppPreferences { + pub version: u32, + pub sounds: AppSoundPreferences, + pub downloads: AppDownloadPreferences, + pub prompt: AppPromptPreferences, + pub backup: AppBackupPreferences, +} + +impl Default for AppPreferences { + fn default() -> Self { + Self { + version: CURRENT_VERSION, + sounds: AppSoundPreferences::default(), + downloads: AppDownloadPreferences::default(), + prompt: AppPromptPreferences::default(), + backup: AppBackupPreferences::default(), + } + } +} + +impl AppPreferences { + /// Load from the settings directory. Falls back to the defaults when there + /// is no file or it can't be read (logged), and migrates a legacy JSON file + /// (rewriting it as TOML) the first time. + pub fn load_or_default(data_root: &AppDataRoot) -> Self { + let settings_dir = data_root.settings_dir(); + let toml_path = settings_dir.get_app_preferences_path(); + + if toml_path.exists() { + return match Self::load_from_file(&toml_path) { + Ok(prefs) => prefs, + Err(err) => { + warn!("Could not read app preferences from {:?}; using defaults: {}", toml_path, err); + Self::default() + } + }; + } + + let legacy_path = settings_dir.get_legacy_app_preferences_json_path(); + if legacy_path.exists() { + match LegacyJsonPreferences::load(&legacy_path) { + Ok(legacy) => { + let prefs = legacy.into_preferences(); + info!("Migrating legacy app preferences {:?} -> {:?}", legacy_path, toml_path); + if let Err(err) = prefs.save_to_file(&toml_path) { + warn!("Could not write migrated app preferences: {}", err); + } + return prefs; + } + Err(err) => { + warn!("Could not read legacy app preferences from {:?}; using defaults: {}", legacy_path, err); + } + } + } + + Self::default() + } + + pub fn load_from_file(path: &Path) -> AnyhowResult { + let contents = std::fs::read_to_string(path)?; + let mut prefs: Self = toml::from_str(&contents)?; + prefs.version = CURRENT_VERSION; + Ok(prefs) + } + + /// Write atomically (temp file + rename) so a crash mid-write can't leave a + /// truncated preferences file. + pub fn save_to_file(&self, path: &Path) -> AnyhowResult<()> { + if let Some(parent) = path.parent() { + std::fs::create_dir_all(parent)?; + } + let contents = toml::to_string_pretty(self)?; + let temp_path = path.with_extension("toml.tmp"); + std::fs::write(&temp_path, contents)?; + std::fs::rename(&temp_path, path)?; + Ok(()) + } + + pub fn save(&self, data_root: &AppDataRoot) -> AnyhowResult<()> { + self.save_to_file(&data_root.settings_dir().get_app_preferences_path()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::state::app_preferences::settings::app_sound_file::AppSoundFile; + use crate::state::app_preferences::settings::preferred_download_directory::PreferredDownloadDirectory; + use crate::state::app_preferences::settings::preferred_download_filename::PreferredDownloadFilename; + + #[test] + fn defaults_serialize_to_nested_toml() { + let toml = toml::to_string_pretty(&AppPreferences::default()).unwrap(); + assert!(toml.starts_with("version = 6\n"), "{toml}"); + assert!(toml.contains("[sounds]\nplay_sounds = true\n"), "{toml}"); + assert!(toml.contains("enqueue_success = \"done\""), "{toml}"); + assert!(toml.contains("[downloads]\n"), "{toml}"); + assert!(toml.contains("[downloads.preferred_download_directory]\nsystem = \"downloads\""), "{toml}"); + assert!(toml.contains("[prompt]\nenter_to_generate = true"), "{toml}"); + assert!(toml.contains("[backup]\nenabled = false\n"), "{toml}"); + } + + #[test] + fn round_trips_through_file() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("app_preferences.toml"); + + let mut prefs = AppPreferences::default(); + prefs.sounds.play_sounds = false; + prefs.sounds.enqueue_failure = None; + prefs.sounds.generation_success = Some(AppSoundFile::CustomWav("/tmp/ding.wav".into())); + prefs.downloads.preferred_download_directory = PreferredDownloadDirectory::Custom("/tmp/out".into()); + prefs.downloads.preferred_download_filename = PreferredDownloadFilename::Custom("{model}_{date}".into()); + prefs.prompt.enter_to_generate = false; + prefs.backup.enabled = true; + prefs.backup.maybe_artcraft_credential_id = Some("credential_backup".to_string()); + + prefs.save_to_file(&path).unwrap(); + let loaded = AppPreferences::load_from_file(&path).unwrap(); + assert_eq!(loaded, prefs); + } + + #[test] + fn partial_file_falls_back_to_defaults_per_field() { + let prefs: AppPreferences = toml::from_str("[sounds]\nplay_sounds = false\n").unwrap(); + assert!(!prefs.sounds.play_sounds); + assert_eq!(prefs.sounds.enqueue_success, Some(AppSoundFile::Done)); + assert_eq!(prefs.downloads, AppPreferences::default().downloads); + assert!(prefs.prompt.enter_to_generate, "prompt table absent -> default"); + assert!(!prefs.backup.enabled, "backup table absent -> off"); + } + + #[test] + fn silent_event_persists_as_none_string() { + let mut prefs = AppPreferences::default(); + prefs.sounds.delete_file = None; + let toml = toml::to_string_pretty(&prefs).unwrap(); + assert!(toml.contains("delete_file = \"none\""), "{toml}"); + let loaded: AppPreferences = toml::from_str(&toml).unwrap(); + assert_eq!(loaded.sounds.delete_file, None); + } +} diff --git a/crates/artcraftx/src/state/app_preferences/app_preferences_manager.rs b/crates/artcraftx/src/state/app_preferences/app_preferences_manager.rs new file mode 100644 index 00000000..dc51f5c5 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/app_preferences_manager.rs @@ -0,0 +1,38 @@ +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use memory_store::clone_cell::CloneCell; + +/// Shared, process-wide app preferences: an in-memory copy that every reader +/// clones, and a single write path that persists to disk. +#[derive(Clone)] +pub struct AppPreferencesManager { + preferences: CloneCell, + data_root: AppDataRoot, +} + +impl AppPreferencesManager { + /// Load from disk (migrating the legacy JSON file if present), or start + /// from the defaults. + pub fn load_or_default(data_root: &AppDataRoot) -> Self { + Self { + preferences: CloneCell::with_owned(AppPreferences::load_or_default(data_root)), + data_root: data_root.clone(), + } + } + + /// A snapshot of the current preferences. + pub fn get(&self) -> AnyhowResult { + self.preferences.get_clone() + } + + /// Apply a change to the current preferences, persist it, and return the + /// updated snapshot. Nothing changes in memory if the write fails. + pub fn update(&self, change: impl FnOnce(&mut AppPreferences)) -> AnyhowResult { + let mut prefs = self.get()?; + change(&mut prefs); + prefs.save(&self.data_root)?; + self.preferences.set_clone(&prefs)?; + Ok(prefs) + } +} diff --git a/crates/artcraftx/src/state/app_preferences/legacy_json_preferences.rs b/crates/artcraftx/src/state/app_preferences/legacy_json_preferences.rs new file mode 100644 index 00000000..1f858091 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/legacy_json_preferences.rs @@ -0,0 +1,93 @@ +//! The pre-TOML `app_preferences.json` layout, read once to migrate existing +//! installs. Never written. + +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::app_preferences::settings::app_sound_file::AppSoundFile; +use crate::state::app_preferences::settings::preferred_download_directory::PreferredDownloadDirectory; +use crate::state::app_preferences::settings::preferred_download_filename::PreferredDownloadFilename; +use errors::AnyhowResult; +use log::warn; +use serde_derive::Deserialize; +use std::path::Path; + +#[derive(Deserialize)] +pub(super) struct LegacyJsonPreferences { + preferred_download_directory: Option, + #[serde(default)] + preferred_download_filename: Option, + play_sounds: Option, + delete_file_sound: Option, + generation_success_sound: Option, + generation_failure_sound: Option, + /// Was the enqueue-success sound before the enqueue sounds were split. + generation_enqueue_sound: Option, +} + +impl LegacyJsonPreferences { + pub(super) fn load(path: &Path) -> AnyhowResult { + let contents = std::fs::read_to_string(path)?; + Ok(serde_json::from_str(&contents)?) + } + + /// Overlay the legacy values onto the defaults. Sound keys the catalog no + /// longer knows are dropped (logged) rather than failing the migration. + pub(super) fn into_preferences(self) -> AppPreferences { + let mut prefs = AppPreferences::default(); + + if let Some(directory) = self.preferred_download_directory { + prefs.downloads.preferred_download_directory = directory; + } + if let Some(filename) = self.preferred_download_filename { + prefs.downloads.preferred_download_filename = filename; + } + if let Some(play_sounds) = self.play_sounds { + prefs.sounds.play_sounds = play_sounds; + } + prefs.sounds.delete_file = legacy_sound(self.delete_file_sound, prefs.sounds.delete_file); + prefs.sounds.enqueue_success = legacy_sound(self.generation_enqueue_sound, prefs.sounds.enqueue_success); + prefs.sounds.generation_success = legacy_sound(self.generation_success_sound, prefs.sounds.generation_success); + prefs.sounds.generation_failure = legacy_sound(self.generation_failure_sound, prefs.sounds.generation_failure); + + prefs + } +} + +/// A legacy sound key is the catalog key string; unknown keys keep the default. +fn legacy_sound(maybe_key: Option, default: Option) -> Option { + let Some(key) = maybe_key else { + return default; + }; + match serde_json::from_value::(serde_json::Value::String(key.clone())) { + Ok(sound) => Some(sound), + Err(_) => { + warn!("Dropping unknown legacy sound key `{}`; using the default.", key); + default + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn migrates_known_fields_and_drops_unknown_sounds() { + let legacy: LegacyJsonPreferences = serde_json::from_str(r#"{ + "version": "3", + "preferred_download_directory": {"custom": "/tmp/out"}, + "play_sounds": false, + "delete_file_sound": "ghost", + "generation_enqueue_sound": "not_a_real_sound", + "generation_failure_sound": "wrong" + }"#).unwrap(); + + let prefs = legacy.into_preferences(); + assert_eq!(prefs.downloads.preferred_download_directory, PreferredDownloadDirectory::Custom("/tmp/out".into())); + assert_eq!(prefs.downloads.preferred_download_filename, PreferredDownloadFilename::ArtcraftConvention); + assert!(!prefs.sounds.play_sounds); + assert_eq!(prefs.sounds.delete_file, Some(AppSoundFile::Ghost)); + assert_eq!(prefs.sounds.enqueue_success, Some(AppSoundFile::Done)); // unknown key -> default + assert_eq!(prefs.sounds.generation_failure, Some(AppSoundFile::Wrong)); + assert_eq!(prefs.sounds.generation_success, Some(AppSoundFile::SpecialFlower)); // absent -> default + } +} diff --git a/crates/artcraftx/src/state/app_preferences/mod.rs b/crates/artcraftx/src/state/app_preferences/mod.rs new file mode 100644 index 00000000..5acf1199 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/mod.rs @@ -0,0 +1,6 @@ +pub mod app_preferences; +pub mod app_preferences_manager; +pub mod settings; + +// Private +mod legacy_json_preferences; diff --git a/crates/artcraftx/src/state/app_preferences/settings/app_backup_preferences.rs b/crates/artcraftx/src/state/app_preferences/settings/app_backup_preferences.rs new file mode 100644 index 00000000..69d90830 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/app_backup_preferences.rs @@ -0,0 +1,28 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Backing up generations made on other services (Higgsfield, Midjourney, +/// Runway, ...) to an ArtCraft account, so the user always keeps a copy. +/// +/// Missing fields in an older preferences file fall back to the defaults. +#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct AppBackupPreferences { + /// Master switch. Off by default; nothing is uploaded until the user opts + /// in and picks an account. + pub enabled: bool, + + /// The ArtCraft credential (`credential_...`) results are uploaded to. + /// Kept when backups are switched off so re-enabling restores the choice. + /// Only ArtCraft (cookie-session) credentials are valid here. + #[serde(skip_serializing_if = "Option::is_none")] + pub maybe_artcraft_credential_id: Option, +} + +impl Default for AppBackupPreferences { + fn default() -> Self { + Self { + enabled: false, + maybe_artcraft_credential_id: None, + } + } +} diff --git a/crates/artcraftx/src/state/app_preferences/settings/app_download_preferences.rs b/crates/artcraftx/src/state/app_preferences/settings/app_download_preferences.rs new file mode 100644 index 00000000..9d648275 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/app_download_preferences.rs @@ -0,0 +1,25 @@ +use crate::state::app_preferences::settings::preferred_download_directory::{PreferredDownloadDirectory, SystemDownloadDirectory}; +use crate::state::app_preferences::settings::preferred_download_filename::PreferredDownloadFilename; +use serde_derive::{Deserialize, Serialize}; + +/// Where downloaded files go and what they're called. +/// +/// Missing fields in an older preferences file fall back to the defaults. +#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct AppDownloadPreferences { + /// The downloads directory to use when a user downloads a file. + pub preferred_download_directory: PreferredDownloadDirectory, + + /// How downloaded generation files are named on disk. + pub preferred_download_filename: PreferredDownloadFilename, +} + +impl Default for AppDownloadPreferences { + fn default() -> Self { + Self { + preferred_download_directory: PreferredDownloadDirectory::System(SystemDownloadDirectory::Downloads), + preferred_download_filename: PreferredDownloadFilename::ArtcraftConvention, + } + } +} diff --git a/crates/artcraftx/src/state/app_preferences/settings/app_prompt_preferences.rs b/crates/artcraftx/src/state/app_preferences/settings/app_prompt_preferences.rs new file mode 100644 index 00000000..aeb1050e --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/app_prompt_preferences.rs @@ -0,0 +1,20 @@ +use serde_derive::{Deserialize, Serialize}; + +/// How the prompt boxes behave (image, video, mesh, splat, ...). +/// +/// Missing fields in an older preferences file fall back to the defaults. +#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct AppPromptPreferences { + /// When on, Enter submits the prompt and Shift+Enter inserts a newline. + /// When off, both insert a newline and only the button submits. + pub enter_to_generate: bool, +} + +impl Default for AppPromptPreferences { + fn default() -> Self { + Self { + enter_to_generate: true, + } + } +} diff --git a/crates/artcraftx/src/state/app_preferences/settings/app_sound_file.rs b/crates/artcraftx/src/state/app_preferences/settings/app_sound_file.rs new file mode 100644 index 00000000..c478a889 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/app_sound_file.rs @@ -0,0 +1,187 @@ +use serde_derive::{Deserialize, Serialize}; +use std::path::PathBuf; + +/// A sound the app can play for an event. +/// +/// The unit variants are the frontend's sound catalog (`SoundManager.ts`) and +/// serialize to its keys (`"done"`, `"spike_throw"`, ...), so the preferences +/// API hands the frontend the same strings it plays by. NEVER change existing +/// serialized values; only add new ones. +#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum AppSoundFile { + // Menu choices + Click, + #[serde(rename = "scifi_menu_beep_1")] + ScifiMenuBeep1, + #[serde(rename = "scifi_menu_beep_2")] + ScifiMenuBeep2, + ScifiMenuSelect, + // Immediate enqueue success + Done, + // Immediate failure + ErrorChirp, + SpikeThrow, + GiantShellKick, + Wrong, + // Async success + SpecialFlower, + ExtraPower, + // Async errors + Crumble, + Ghost, + SpecialAlert, + ScifiAlert, + ScifiShrillAlert, + // Menus + Next, + Select, + ScifiMenuOpen, + ScifiMenuClose, + // Reward / celebration + Correct, + Flower, + // Trash / delete + Trash, + // Misc + AcceptChirp, + #[serde(rename = "accept_normal_level_1")] + AcceptNormalLevel1, + #[serde(rename = "accept_normal_level_2")] + AcceptNormalLevel2, + #[serde(rename = "accept_normal_level_3")] + AcceptNormalLevel3, + DeclineChirp, + DeclineNormal, + + /// A user-supplied `.wav` file. + /// NB: Serializes as `{"custom_wav": "/path/to/file.wav"}` in JSON and an + /// inline table in TOML. + CustomWav(PathBuf), +} + +impl AppSoundFile { + /// Whether this sound can be saved: catalog sounds always can; a custom file + /// must be an absolute path to an existing `.wav` file. Returns a + /// user-facing reason when it can't. + pub fn validate(&self) -> Result<(), String> { + let Self::CustomWav(path) = self else { + return Ok(()); + }; + if !path.is_absolute() { + return Err(format!("Sound file path must be absolute: {}", path.display())); + } + let is_wav = path.extension() + .map(|ext| ext.eq_ignore_ascii_case("wav")) + .unwrap_or(false); + if !is_wav { + return Err(format!("Sound file must be a .wav file: {}", path.display())); + } + if !path.is_file() { + return Err(format!("Sound file does not exist: {}", path.display())); + } + Ok(()) + } + + pub fn custom_wav_path(&self) -> Option<&std::path::Path> { + match self { + Self::CustomWav(path) => Some(path), + _ => None, + } + } +} + +/// Serde helper for `Option` fields: `None` (silent) is written +/// as the string `"none"` — TOML has no null, and the frontend already uses +/// `"none"` for "None (Silent)". Reading accepts `"none"`, `null`, or a sound. +pub mod optional_sound { + use super::AppSoundFile; + use serde::{Deserialize, Deserializer, Serialize, Serializer}; + + pub const SILENT: &str = "none"; + + #[derive(Serialize, Deserialize)] + #[serde(untagged)] + enum SoundOrSilent { + Sound(AppSoundFile), + Silent(String), + } + + pub fn serialize(value: &Option, serializer: S) -> Result { + match value { + Some(sound) => sound.serialize(serializer), + None => SILENT.serialize(serializer), + } + } + + pub fn deserialize<'de, D: Deserializer<'de>>(deserializer: D) -> Result, D::Error> { + match Option::::deserialize(deserializer)? { + None => Ok(None), + Some(SoundOrSilent::Sound(sound)) => Ok(Some(sound)), + Some(SoundOrSilent::Silent(text)) if text == SILENT => Ok(None), + Some(SoundOrSilent::Silent(text)) => Err(serde::de::Error::custom(format!("unknown sound `{text}`"))), + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn catalog_variants_serialize_to_frontend_keys() { + assert_eq!(serde_json::to_string(&AppSoundFile::Done).unwrap(), "\"done\""); + assert_eq!(serde_json::to_string(&AppSoundFile::SpikeThrow).unwrap(), "\"spike_throw\""); + assert_eq!(serde_json::to_string(&AppSoundFile::ScifiMenuBeep1).unwrap(), "\"scifi_menu_beep_1\""); + assert_eq!(serde_json::from_str::("\"crumble\"").unwrap(), AppSoundFile::Crumble); + } + + #[test] + fn optional_sound_writes_silent_as_none_string() { + #[derive(Serialize, Deserialize, PartialEq, Debug)] + struct Holder { + #[serde(with = "optional_sound")] + sound: Option, + } + + let silent = Holder { sound: None }; + assert_eq!(serde_json::to_string(&silent).unwrap(), "{\"sound\":\"none\"}"); + assert_eq!(serde_json::from_str::("{\"sound\":\"none\"}").unwrap(), silent); + assert_eq!(serde_json::from_str::("{\"sound\":null}").unwrap(), silent); + assert_eq!(toml::from_str::("sound = \"none\"").unwrap(), silent); + + let done = Holder { sound: Some(AppSoundFile::Done) }; + assert_eq!(toml::to_string(&done).unwrap(), "sound = \"done\"\n"); + assert_eq!(toml::from_str::("sound = \"done\"").unwrap(), done); + assert!(serde_json::from_str::("{\"sound\":\"bogus\"}").is_err()); + } + + #[test] + fn validate_requires_an_existing_absolute_wav() { + assert!(AppSoundFile::Done.validate().is_ok()); + + let dir = tempfile::tempdir().unwrap(); + let wav = dir.path().join("ding.wav"); + std::fs::write(&wav, b"RIFF").unwrap(); + let upper = dir.path().join("DING.WAV"); + std::fs::write(&upper, b"RIFF").unwrap(); + let mp3 = dir.path().join("ding.mp3"); + std::fs::write(&mp3, b"ID3").unwrap(); + + assert!(AppSoundFile::CustomWav(wav).validate().is_ok()); + assert!(AppSoundFile::CustomWav(upper).validate().is_ok()); + assert!(AppSoundFile::CustomWav(mp3).validate().unwrap_err().contains(".wav")); + assert!(AppSoundFile::CustomWav(dir.path().join("missing.wav")).validate().unwrap_err().contains("does not exist")); + let dir_named_wav = dir.path().join("folder.wav"); + std::fs::create_dir(&dir_named_wav).unwrap(); + assert!(AppSoundFile::CustomWav(dir_named_wav).validate().unwrap_err().contains("does not exist")); + assert!(AppSoundFile::CustomWav("relative/ding.wav".into()).validate().unwrap_err().contains("absolute")); + } + + #[test] + fn custom_wav_serializes_as_tagged_path() { + let sound = AppSoundFile::CustomWav("/tmp/ding.wav".into()); + assert_eq!(serde_json::to_string(&sound).unwrap(), "{\"custom_wav\":\"/tmp/ding.wav\"}"); + assert_eq!(serde_json::from_str::("{\"custom_wav\":\"/tmp/ding.wav\"}").unwrap(), sound); + } +} diff --git a/crates/artcraftx/src/state/app_preferences/settings/app_sound_preferences.rs b/crates/artcraftx/src/state/app_preferences/settings/app_sound_preferences.rs new file mode 100644 index 00000000..5b14fbcc --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/app_sound_preferences.rs @@ -0,0 +1,93 @@ +use crate::state::app_preferences::settings::app_sound_file::{optional_sound, AppSoundFile}; +use serde_derive::{Deserialize, Serialize}; + +/// Which sound (if any) plays for each app event. +/// +/// `None` means silent for that event and is stored as `"none"` (see +/// [`optional_sound`]). Missing fields in an older preferences file fall back +/// to the defaults. +#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct AppSoundPreferences { + /// Master switch: play sounds on events at all. + pub play_sounds: bool, + + /// A file was deleted. + #[serde(with = "optional_sound")] + pub delete_file: Option, + + /// A generation was accepted by the provider (image enqueue can be async). + #[serde(with = "optional_sound")] + pub enqueue_success: Option, + + /// A generation was rejected on enqueue. + #[serde(with = "optional_sound")] + pub enqueue_failure: Option, + + /// A generation finished. + #[serde(with = "optional_sound")] + pub generation_success: Option, + + /// A generation failed. + #[serde(with = "optional_sound")] + pub generation_failure: Option, +} + +/// The app events that can play a sound; one per field of +/// [`AppSoundPreferences`]. Serialized as the field names. +#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum AppSoundEvent { + DeleteFile, + EnqueueSuccess, + EnqueueFailure, + GenerationSuccess, + GenerationFailure, +} + +impl AppSoundPreferences { + pub fn get(&self, event: AppSoundEvent) -> Option<&AppSoundFile> { + match event { + AppSoundEvent::DeleteFile => self.delete_file.as_ref(), + AppSoundEvent::EnqueueSuccess => self.enqueue_success.as_ref(), + AppSoundEvent::EnqueueFailure => self.enqueue_failure.as_ref(), + AppSoundEvent::GenerationSuccess => self.generation_success.as_ref(), + AppSoundEvent::GenerationFailure => self.generation_failure.as_ref(), + } + } + + /// The out-of-the-box sound for an event (from the `Default` impl). + pub fn default_for(event: AppSoundEvent) -> Option { + Self::default().get(event).cloned() + } + + /// Put the event back to its out-of-the-box sound. + pub fn reset_to_default(&mut self, event: AppSoundEvent) { + self.set(event, Self::default_for(event)); + } + + /// `None` silences the event. + pub fn set(&mut self, event: AppSoundEvent, sound: Option) { + let slot = match event { + AppSoundEvent::DeleteFile => &mut self.delete_file, + AppSoundEvent::EnqueueSuccess => &mut self.enqueue_success, + AppSoundEvent::EnqueueFailure => &mut self.enqueue_failure, + AppSoundEvent::GenerationSuccess => &mut self.generation_success, + AppSoundEvent::GenerationFailure => &mut self.generation_failure, + }; + *slot = sound; + } +} + +impl Default for AppSoundPreferences { + fn default() -> Self { + Self { + play_sounds: true, + delete_file: Some(AppSoundFile::Trash), + enqueue_success: Some(AppSoundFile::Done), + enqueue_failure: Some(AppSoundFile::SpikeThrow), + generation_success: Some(AppSoundFile::SpecialFlower), + generation_failure: Some(AppSoundFile::Crumble), + } + } +} diff --git a/crates/artcraftx/src/state/app_preferences/settings/mod.rs b/crates/artcraftx/src/state/app_preferences/settings/mod.rs new file mode 100644 index 00000000..c375c657 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/mod.rs @@ -0,0 +1,7 @@ +pub mod app_backup_preferences; +pub mod app_download_preferences; +pub mod app_prompt_preferences; +pub mod app_sound_file; +pub mod app_sound_preferences; +pub mod preferred_download_directory; +pub mod preferred_download_filename; diff --git a/crates/artcraftx/src/state/app_preferences/settings/preferred_download_directory.rs b/crates/artcraftx/src/state/app_preferences/settings/preferred_download_directory.rs new file mode 100644 index 00000000..b9161ccf --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/preferred_download_directory.rs @@ -0,0 +1,105 @@ +use errors::AnyhowError; +use serde_derive::{Deserialize, Serialize}; +use std::fmt::{Display, Formatter}; +use std::path::PathBuf; +use std::str::FromStr; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; + +const SYSTEM_DEFAULT_SENTINEL_VALUE: &str = "system_default"; + +/// NB: The reason these are not flat is so that they serialize/deserialize nicely to/from JSON. +#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum PreferredDownloadDirectory { + /// The system-default downloads directory, which varies by OS. + /// NB: Serializes as `"system_default"` in JSON. + System(SystemDownloadDirectory), + + /// A user-defined path + /// NB: Serializes as `{"custom": "/path/to/dir"}` in JSON. + Custom(PathBuf), +} + +#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum SystemDownloadDirectory { + Downloads, + Documents, +} + +impl PreferredDownloadDirectory { + /// This doesn't have a fallback. + pub fn maybe_to_download_directory(&self) -> Option { + match self { + PreferredDownloadDirectory::Custom(path) => Some(path.clone()), + PreferredDownloadDirectory::System(SystemDownloadDirectory::Documents) => { + dirs::document_dir() + } + PreferredDownloadDirectory::System(SystemDownloadDirectory::Downloads) => { + dirs::download_dir() + } + } + } + + /// Fallback to the Artcraft directory. + pub fn download_directory(&self, root: &AppDataRoot) -> PathBuf { + let maybe_path = self.maybe_to_download_directory(); + maybe_path.unwrap_or_else(|| root.downloads_dir().path().to_path_buf()) + } +} + +impl FromStr for SystemDownloadDirectory { + type Err = AnyhowError; + + fn from_str(s: &str) -> Result { + match s { + "downloads" => Ok(SystemDownloadDirectory::Downloads), + "documents" => Ok(SystemDownloadDirectory::Documents), + _ => Err(AnyhowError::msg(format!("Invalid system download directory: {}", s))), + } + } +} + +impl Display for PreferredDownloadDirectory { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + PreferredDownloadDirectory::System(system) => system.fmt(f), + PreferredDownloadDirectory::Custom(path) => write!(f, "{}", path.to_string_lossy()), + } + } +} + +impl Display for SystemDownloadDirectory { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + SystemDownloadDirectory::Downloads => write!(f, "downloads"), + SystemDownloadDirectory::Documents => write!(f, "documents"), + } + } +} + +#[cfg(test)] +mod tests { + use crate::state::app_preferences::settings::preferred_download_directory::PreferredDownloadDirectory; + use crate::state::app_preferences::settings::preferred_download_directory::SystemDownloadDirectory; + + + mod json { + use super::*; + + #[test] + fn to_json_system_default() { + let val = PreferredDownloadDirectory::System(SystemDownloadDirectory::Documents); + let val = serde_json::to_string(&val).unwrap(); + assert_eq!(&val, "{\"system\":\"documents\"}"); + } + + #[test] + fn to_json_custom() { + let val = PreferredDownloadDirectory::Custom("/tmp".into()); + let val = serde_json::to_string(&val).unwrap(); + assert_eq!(&val, "{\"custom\":\"/tmp\"}"); + } + } +} diff --git a/crates/artcraftx/src/state/app_preferences/settings/preferred_download_filename.rs b/crates/artcraftx/src/state/app_preferences/settings/preferred_download_filename.rs new file mode 100644 index 00000000..71cdf345 --- /dev/null +++ b/crates/artcraftx/src/state/app_preferences/settings/preferred_download_filename.rs @@ -0,0 +1,318 @@ +use chrono::{DateTime, Datelike, Local, Timelike}; +use serde_derive::{Deserialize, Serialize}; + +/// Characters that may never appear in a download filename (or a custom +/// filename format): path separators, traversal, quoting, and shell-unsafe +/// characters. +const UNSAFE_CHARACTERS: &[char] = &[ + '/', '\\', '\'', '"', '`', '%', '<', '>', '|', ':', '*', '?', '\0', +]; + +/// How downloaded generation files are named on disk. +/// +/// Stored in the app preferences file. NEVER change existing serialized +/// values; only add new ones. +#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum PreferredDownloadFilename { + /// `{model}_{date}(_{batch_index}).{ext}` + /// - model slug, eg. "seedance_2.0", "flux_pro_1.1" + /// - date is "YYYY-MM-DD-HH-MM-SS" (download time) + /// - batch index is 1-n when the job produced more than one file + /// - ext matches the cloud file (jpg, png, mp4, ...) + /// + /// NB: Serializes as `"artcraft_convention"` in JSON. + ArtcraftConvention, + + /// A user-defined format string. Supported tokens: + /// - `{model}` — the model slug + /// - `{date}` — "YYYY-MM-DD-HH-MM-SS" (download time) + /// - `{YYYY}`, `{YY}`, `{MM}`, `{DD}`, `{HH}`, `{mm}`, `{SS}` — date parts + /// - `{batch_index}` — 1-n (appended automatically when the job produced + /// more than one file and the format doesn't include it) + /// + /// Slash, quote, and other unsafe characters are rejected. + /// + /// NB: Serializes as `{"custom_format": "..."}` in JSON. (The key is NOT + /// "custom" so it can't be confused with `PreferredDownloadDirectory`'s + /// custom variant in loosely-typed payloads.) + #[serde(rename = "custom_format")] + Custom(String), +} + +impl Default for PreferredDownloadFilename { + fn default() -> Self { + Self::ArtcraftConvention + } +} + +/// Everything needed to render a download filename. +pub struct DownloadFilenameParts<'a> { + /// Model slug, eg. "seedance_2.0". Use [`model_slug_from_model_type_str`]. + pub model_slug: &'a str, + + /// The download time. + pub download_time: DateTime, + + /// 1-based index when the job produced more than one file. + pub maybe_batch_index: Option, + + /// File extension without the leading dot, matching the cloud file. + pub extension: &'a str, +} + +impl PreferredDownloadFilename { + /// Render the filename (including extension) for one downloaded file. + /// The output is sanitized: unsafe characters can never appear. + pub fn build_filename(&self, parts: &DownloadFilenameParts<'_>) -> String { + let stem = match self { + Self::ArtcraftConvention => { + let mut stem = format!( + "{}_{}", + parts.model_slug, + full_date_string(&parts.download_time), + ); + if let Some(index) = parts.maybe_batch_index { + stem.push_str(&format!("_{index}")); + } + stem + } + Self::Custom(format) => { + let mut stem = expand_format_tokens(format, parts); + let has_batch_token = format.contains("{batch_index}"); + if !has_batch_token { + if let Some(index) = parts.maybe_batch_index { + stem.push_str(&format!("_{index}")); + } + } + stem + } + }; + + let stem = sanitize(&stem); + let extension = sanitize(parts.extension); + + format!("{stem}.{extension}") + } + + /// Vet a user-supplied custom format string. + pub fn validate_custom_format(format: &str) -> Result<(), String> { + if format.trim().is_empty() { + return Err("Filename format cannot be empty".to_string()); + } + if format.contains("..") { + return Err("Filename format cannot contain '..'".to_string()); + } + if let Some(bad) = format.chars().find(|c| UNSAFE_CHARACTERS.contains(c) || c.is_control()) { + return Err(format!("Filename format cannot contain {bad:?}")); + } + Ok(()) + } +} + +/// Derive a friendly model slug from a `TaskModelType` string value: +/// version markers like "2p0" become "2.0" (eg. "seedance_2p0" -> +/// "seedance_2.0", "flux_pro_1p1" -> "flux_pro_1.1"). +pub fn model_slug_from_model_type_str(model_type: &str) -> String { + let mut slug = String::with_capacity(model_type.len()); + let chars = model_type.chars().collect::>(); + for (i, c) in chars.iter().enumerate() { + let is_version_dot = *c == 'p' + && i > 0 + && i + 1 < chars.len() + && chars[i - 1].is_ascii_digit() + && chars[i + 1].is_ascii_digit(); + slug.push(if is_version_dot { '.' } else { *c }); + } + slug +} + +fn full_date_string(time: &DateTime) -> String { + format!( + "{:04}-{:02}-{:02}-{:02}-{:02}-{:02}", + time.year(), time.month(), time.day(), + time.hour(), time.minute(), time.second(), + ) +} + +fn expand_format_tokens(format: &str, parts: &DownloadFilenameParts<'_>) -> String { + let time = &parts.download_time; + format + .replace("{model}", parts.model_slug) + .replace("{date}", &full_date_string(time)) + .replace("{YYYY}", &format!("{:04}", time.year())) + .replace("{YY}", &format!("{:02}", time.year() % 100)) + .replace("{MM}", &format!("{:02}", time.month())) + .replace("{DD}", &format!("{:02}", time.day())) + .replace("{HH}", &format!("{:02}", time.hour())) + .replace("{mm}", &format!("{:02}", time.minute())) + .replace("{SS}", &format!("{:02}", time.second())) + .replace( + "{batch_index}", + &parts.maybe_batch_index.map(|i| i.to_string()).unwrap_or_default(), + ) +} + +/// Strip anything unsafe out of a rendered filename component. +fn sanitize(value: &str) -> String { + value.chars() + .filter(|c| !UNSAFE_CHARACTERS.contains(c) && !c.is_control()) + .collect::() + .replace("..", "_") + .trim() + .to_string() +} + +#[cfg(test)] +mod tests { + use super::*; + use chrono::TimeZone; + + fn test_time() -> DateTime { + Local.with_ymd_and_hms(2026, 8, 5, 14, 30, 9).unwrap() + } + + mod artcraft_convention { + use super::*; + + #[test] + fn single_file() { + let name = PreferredDownloadFilename::ArtcraftConvention.build_filename(&DownloadFilenameParts { + model_slug: "seedance_2.0", + download_time: test_time(), + maybe_batch_index: None, + extension: "mp4", + }); + assert_eq!(name, "seedance_2.0_2026-08-05-14-30-09.mp4"); + } + + #[test] + fn batch_file() { + let name = PreferredDownloadFilename::ArtcraftConvention.build_filename(&DownloadFilenameParts { + model_slug: "flux_pro_1.1", + download_time: test_time(), + maybe_batch_index: Some(3), + extension: "png", + }); + assert_eq!(name, "flux_pro_1.1_2026-08-05-14-30-09_3.png"); + } + } + + mod custom_format { + use super::*; + + #[test] + fn tokens_expand() { + let format = PreferredDownloadFilename::Custom("{model}-{YYYY}{MM}{DD}-{HH}{mm}{SS}".to_string()); + let name = format.build_filename(&DownloadFilenameParts { + model_slug: "nano_banana", + download_time: test_time(), + maybe_batch_index: None, + extension: "jpg", + }); + assert_eq!(name, "nano_banana-20260805-143009.jpg"); + } + + #[test] + fn batch_index_token() { + let format = PreferredDownloadFilename::Custom("gen_{batch_index}".to_string()); + let name = format.build_filename(&DownloadFilenameParts { + model_slug: "unused", + download_time: test_time(), + maybe_batch_index: Some(2), + extension: "png", + }); + assert_eq!(name, "gen_2.png"); + } + + #[test] + fn batch_index_appended_when_absent_from_format() { + let format = PreferredDownloadFilename::Custom("gen".to_string()); + let name = format.build_filename(&DownloadFilenameParts { + model_slug: "unused", + download_time: test_time(), + maybe_batch_index: Some(2), + extension: "png", + }); + assert_eq!(name, "gen_2.png"); + } + + #[test] + fn unsafe_characters_stripped_from_output() { + let format = PreferredDownloadFilename::Custom("weird{model}".to_string()); + let name = format.build_filename(&DownloadFilenameParts { + model_slug: "a/b\\c\"d", + download_time: test_time(), + maybe_batch_index: None, + extension: "png", + }); + assert_eq!(name, "weirdabcd.png"); + } + } + + mod validation { + use super::*; + + #[test] + fn accepts_reasonable_formats() { + assert!(PreferredDownloadFilename::validate_custom_format("{model}_{date}").is_ok()); + assert!(PreferredDownloadFilename::validate_custom_format("my file {YYYY}").is_ok()); + } + + #[test] + fn rejects_unsafe_formats() { + assert!(PreferredDownloadFilename::validate_custom_format("").is_err()); + assert!(PreferredDownloadFilename::validate_custom_format("a/b").is_err()); + assert!(PreferredDownloadFilename::validate_custom_format("a\\b").is_err()); + assert!(PreferredDownloadFilename::validate_custom_format("a\"b").is_err()); + assert!(PreferredDownloadFilename::validate_custom_format("a'b").is_err()); + assert!(PreferredDownloadFilename::validate_custom_format("../etc").is_err()); + } + } + + mod model_slug { + use super::*; + + #[test] + fn version_markers_become_dots() { + assert_eq!(model_slug_from_model_type_str("seedance_2p0"), "seedance_2.0"); + assert_eq!(model_slug_from_model_type_str("flux_pro_1p1"), "flux_pro_1.1"); + assert_eq!(model_slug_from_model_type_str("seedream_5p0_pro_u"), "seedream_5.0_pro_u"); + } + + #[test] + fn non_version_names_unchanged() { + assert_eq!(model_slug_from_model_type_str("nano_banana"), "nano_banana"); + assert_eq!(model_slug_from_model_type_str("midjourney_8"), "midjourney_8"); + assert_eq!(model_slug_from_model_type_str("marble_1p1_plus"), "marble_1.1_plus"); + } + } + + mod serialization { + use super::*; + + #[test] + fn artcraft_convention_serializes_as_string() { + let val = PreferredDownloadFilename::ArtcraftConvention; + assert_eq!(serde_json::to_string(&val).unwrap(), "\"artcraft_convention\""); + } + + #[test] + fn custom_serializes_with_custom_format_key() { + let val = PreferredDownloadFilename::Custom("{model}_{date}".to_string()); + assert_eq!(serde_json::to_string(&val).unwrap(), "{\"custom_format\":\"{model}_{date}\"}"); + } + + #[test] + fn round_trips() { + for val in [ + PreferredDownloadFilename::ArtcraftConvention, + PreferredDownloadFilename::Custom("{model}".to_string()), + ] { + let json = serde_json::to_string(&val).unwrap(); + let back: PreferredDownloadFilename = serde_json::from_str(&json).unwrap(); + assert_eq!(back, val); + } + } + } +} diff --git a/crates/artcraftx/src/state/data_dir/app_data_root.rs b/crates/artcraftx/src/state/data_dir/app_data_root.rs new file mode 100644 index 00000000..3e36cfc1 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/app_data_root.rs @@ -0,0 +1,147 @@ +use crate::state::data_dir::subdirectory::app_cache_dir::AppCacheDir; +use crate::state::data_dir::subdirectory::app_credentials_dir::AppCredentialsDir; +use crate::state::data_dir::subdirectory::app_downloads_dir::AppDownloadsDir; +use crate::state::data_dir::subdirectory::app_settings_dir::AppSettingsDir; +use crate::state::data_dir::subdirectory::app_state_dir::AppStateDir; +use crate::state::data_dir::subdirectory::temporary_dir::TemporaryDir; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use crate::state::runtime::expanduser::expanduser; +use crate::state::runtime::os_platform::OsPlatform; +use anyhow::anyhow; +use directories::UserDirs; +use std::path::{Path, PathBuf}; + +/// Company directory +const DEFAULT_ARTCRAFT_DATA_DIR : &str = "Artcraft"; + +/// ArtCraft-X subdirectory +const DEFAULT_ARTCRAFTX_DATA_SUBDIR : &str = "artcraftx"; + +/// Note: Tauri appends ".log" to the end of the filename. +const LOG_FILE_NAME : &str = "artcraftx_debug"; + +/// The path to the application data directory. +#[derive(Clone)] +pub struct AppDataRoot { + path: PathBuf, + + log_file_name: PathBuf, + log_file_name_string: String, + + cache_dir: AppCacheDir, + credentials_dir: AppCredentialsDir, + downloads_dir: AppDownloadsDir, + settings_dir: AppSettingsDir, + state_dir: AppStateDir, + temp_dir: TemporaryDir, +} + +impl AppDataRoot { + pub fn create_default() -> anyhow::Result { + let directory = get_default_data_dir()?; + println!("App data directory: {:?}", directory); + Self::create_existing(directory) + } + + pub fn create_existing>(dir: P) -> anyhow::Result { + let mut dir = dir.as_ref().to_path_buf(); + + match OsPlatform::get() { + OsPlatform::Linux | OsPlatform::MacOs => { + if let Some(d) = dir.as_os_str().to_str() { + dir = expanduser(d)?; + } + }, + OsPlatform::Windows => {} + } + + if !dir.is_dir() { + println!("Creating directory {:?}", dir); + std::fs::create_dir_all(&dir)?; + } + + match dir.canonicalize() { + Ok(d) => dir = d, + Err(err) => { + println!("Error canonicalizing {:?}: {}", dir, err); + } + } + + let cache_dir = AppCacheDir::get_or_create_in_root_dir(&dir)?; + let credentials_dir = AppCredentialsDir::get_or_create_in_root_dir(&dir)?; + let downloads_dir = AppDownloadsDir::get_or_create_in_root_dir(&dir)?; + let settings_dir = AppSettingsDir::get_or_create_in_root_dir(&dir)?; + let state_dir = AppStateDir::get_or_create_in_root_dir(&dir)?; + let temp_dir = TemporaryDir::get_or_create_in_root_dir(&dir)?; + let log_file_name = dir.join(LOG_FILE_NAME); + let log_file_name_string = log_file_name + .to_str() + .ok_or(anyhow!("couldn't convert log path to str"))? + .to_string(); + + Ok(Self { + path: dir, + log_file_name, + log_file_name_string, + cache_dir, + credentials_dir, + downloads_dir, + settings_dir, + state_dir, + temp_dir, + }) + } + + pub fn cache_dir(&self) -> &AppCacheDir { + &self.cache_dir + } + + pub fn credentials_dir(&self) -> &AppCredentialsDir { + &self.credentials_dir + } + + pub fn downloads_dir(&self) -> &AppDownloadsDir { + &self.downloads_dir + } + + pub fn settings_dir(&self) -> &AppSettingsDir { + &self.settings_dir + } + + pub fn state_dir(&self) -> &AppStateDir { + &self.state_dir + } + + pub fn temp_dir(&self) -> &TemporaryDir { + &self.temp_dir + } + + pub fn path(&self) -> &Path { + &self.path + } + + pub fn log_file_name(&self) -> &Path { + &self.log_file_name + } + + pub fn log_file_name_str(&self) -> &str { + &self.log_file_name_string + } + + pub fn get_window_size_config_file(&self) -> PathBuf { + self.state_dir.get_window_size_config_file() + } + + pub fn get_window_position_config_file(&self) -> PathBuf { + self.state_dir.get_window_position_config_file() + } +} + +// eg. /home/bob/artcraft, /Users/alice/artcraft, or C:\Users\Taylor\artcraft +fn get_default_data_dir() -> anyhow::Result { + Ok(UserDirs::new() + .ok_or_else(|| anyhow!("could not determine user home directory"))? + .home_dir() + .join(DEFAULT_ARTCRAFT_DATA_DIR) + .join(DEFAULT_ARTCRAFTX_DATA_SUBDIR)) +} diff --git a/crates/artcraftx/src/state/data_dir/mod.rs b/crates/artcraftx/src/state/data_dir/mod.rs new file mode 100644 index 00000000..1919e75d --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/mod.rs @@ -0,0 +1,2 @@ +pub mod app_data_root; +pub mod subdirectory; diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/app_cache_dir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/app_cache_dir.rs new file mode 100644 index 00000000..cbc43a66 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/app_cache_dir.rs @@ -0,0 +1,37 @@ +use std::path::{Path, PathBuf}; + +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; + +/// `/cache` — regenerable derived data (thumbnails, previews). Safe to +/// delete wholesale; everything here rebuilds on demand. +#[derive(Clone)] +pub struct AppCacheDir { + path: PathBuf, +} + +impl DataSubdir for AppCacheDir { + const DIRECTORY_NAME: &'static str = "cache"; + + fn new_from>(dir: P) -> Self { + Self { + path: dir.as_ref().to_path_buf(), + } + } + + fn path(&self) -> &Path { + &self.path + } +} + +impl AppCacheDir { + /// `cache/thumbnails/` — content-addressed thumbnails + /// (`{blake3_hex}.jpg` static, `{blake3_hex}.webp` animated preview). + /// Created on demand. + pub fn get_or_create_thumbnails_dir(&self) -> anyhow::Result { + let dir = self.path.join("thumbnails"); + if !dir.exists() { + std::fs::create_dir_all(&dir)?; + } + Ok(dir) + } +} diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/app_credentials_dir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/app_credentials_dir.rs new file mode 100644 index 00000000..5eb607a7 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/app_credentials_dir.rs @@ -0,0 +1,345 @@ +use crate::credentials::auth_credential::AuthCredential; +use core_types::enums::generation_source::GenerationSource; +use crate::error::artcraftx_credential_error::ArtcraftXCredentialError; +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::collections::HashSet; +use std::path::{Path, PathBuf}; +use core_types::identifiers::credential_id::CredentialId; + +/// The directory holding per-service credential TOML files +/// (by default `~/Artcraft/artcraftx/credentials`). +/// +/// Files can be named anything (`artcraft_user1.toml`, `fal_api_key.toml`, +/// `higgsfield.toml`, ...) — users may hand-write their own. See +/// [`crate::credentials`] for the file format. +#[derive(Clone)] +pub struct AppCredentialsDir { + path: PathBuf, +} + +impl DataSubdir for AppCredentialsDir { + const DIRECTORY_NAME: &'static str = "credentials"; + + fn new_from> (dir: P) -> Self { + Self { + path: dir.as_ref().to_path_buf(), + } + } + + fn path(&self) -> &Path { + &self.path + } +} + +impl AppCredentialsDir { + /// List and load every `*.toml` credential file in the directory. + /// + /// Files that fail to parse or validate are skipped with a warning so a + /// single malformed (possibly hand-written) file can't take down every + /// other credential. Only a directory listing failure is an error. + pub fn load_credentials(&self) -> Result, ArtcraftXError> { + let entries = std::fs::read_dir(&self.path) + .map_err(|source| ArtcraftXCredentialError::DirectoryReadError { + path: self.path.clone(), + source, + })?; + + let mut paths: Vec = entries + .filter_map(|entry| entry.ok()) + .map(|entry| entry.path()) + .filter(|path| path.is_file() && has_toml_extension(path)) + .collect(); + paths.sort(); + + let mut credentials = Vec::new(); + let mut seen_ids: HashSet = HashSet::new(); + for path in paths { + match AuthCredential::load_from_file(&path) { + Ok(mut credential) => { + // Ids must be unique; a duplicate (eg. a copied file) gets a + // fresh id, persisted so it stays stable. + if seen_ids.contains(&credential.id) { + credential.id = generate_id_not_in(&seen_ids); + if let Err(err) = self.save_credential(&credential) { + log::warn!( + "Could not persist deduplicated credential id for {:?}: {}", + credential.source_path, err, + ); + } + } + seen_ids.insert(credential.id.clone()); + credentials.push(credential); + }, + Err(err) => { + log::warn!("Skipping bad credential file: {}", err); + }, + } + } + + Ok(credentials) + } + + /// Rewrite a credential's TOML file in place (refreshed cookies, + /// success/failure timestamps, etc.) + pub fn save_credential(&self, credential: &AuthCredential) -> Result<(), ArtcraftXError> { + credential.save().map_err(ArtcraftXError::from) + } + + /// Path for a new managed credential file with the given file stem, + /// e.g. `file_path_for("fal_api_key")` -> `.../credentials/fal_api_key.toml`. + pub fn file_path_for(&self, file_stem: &str) -> PathBuf { + self.path.join(format!("{}.toml", file_stem)) + } + + /// Next unused managed path for a service, following the naming scheme + /// `{service}.toml`, then `{service}_2.toml`, `{service}_3.toml`, ... + /// (Users are free to rename the files afterwards.) + pub fn next_available_credential_path(&self, service: GenerationSource) -> PathBuf { + let stem = service.to_str(); + let first = self.file_path_for(stem); + if !first.exists() { + return first; + } + let mut number: u32 = 2; + loop { + let candidate = self.file_path_for(&format!("{}_{}", stem, number)); + if !candidate.exists() { + return candidate; + } + number += 1; + } + } + + /// Resolve a credential id (a bare file name like `fal_api_2.toml`) to a + /// path inside this directory, rejecting anything that could escape it. + pub fn resolve_credential_file(&self, file_name: &str) -> Result { + let is_bare_file_name = !file_name.is_empty() + && !file_name.contains('/') + && !file_name.contains('\\') + && !file_name.contains(".."); + let is_toml = Path::new(file_name) + .extension() + .map(|ext| ext.eq_ignore_ascii_case("toml")) + .unwrap_or(false); + if !is_bare_file_name || !is_toml { + return Err(ArtcraftXCredentialError::InvalidFileName { + file_name: file_name.to_string(), + }.into()); + } + Ok(self.path.join(file_name)) + } + + /// Load a single credential by id (file name). + pub fn load_credential(&self, file_name: &str) -> Result { + let path = self.resolve_credential_file(file_name)?; + AuthCredential::load_from_file(path).map_err(ArtcraftXError::from) + } + + /// Find a credential by its id, the stable primary identifier. + pub fn find_credential_by_id( + &self, + id: &str, + ) -> Result, ArtcraftXError> { + Ok(self.load_credentials()? + .into_iter() + .find(|credential| credential.id.as_str() == id)) + } + + /// Generate an id no existing credential uses. Collisions are + /// astronomically unlikely; the check guards against them anyway. + pub fn generate_unique_credential_id(&self) -> CredentialId { + let existing: HashSet = self.load_credentials() + .map(|credentials| credentials.into_iter().map(|c| c.id).collect()) + .unwrap_or_default(); + generate_id_not_in(&existing) + } + + /// Delete a credential file by id (file name). + pub fn delete_credential_file(&self, file_name: &str) -> Result<(), ArtcraftXError> { + let path = self.resolve_credential_file(file_name)?; + std::fs::remove_file(&path) + .map_err(|source| ArtcraftXCredentialError::FileDeleteError { path, source }.into()) + } +} + +fn generate_id_not_in(taken: &HashSet) -> CredentialId { + loop { + let id = CredentialId::generate(); + if !taken.contains(&id) { + return id; + } + } +} + +fn has_toml_extension(path: &Path) -> bool { + path.extension() + .map(|ext| ext.eq_ignore_ascii_case("toml")) + .unwrap_or(false) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::credentials::api_key_credential::ApiKeyCredential; + use crate::credentials::auth_credential::CredentialSecret; + + fn write_file(dir: &Path, name: &str, contents: &str) { + std::fs::write(dir.join(name), contents).unwrap(); + } + + #[test] + fn loads_all_valid_toml_files() { + let dir = tempfile::tempdir().unwrap(); + write_file( + dir.path(), + "artcraft_user1.toml", + "service = \"artcraft_cookies\"\n[[cookie.cookies]]\nname = \"a\"\nvalue = \"b\"\ndomain = \"storyteller.ai\"\n", + ); + write_file( + dir.path(), + "fal_api_key.toml", + "service = \"fal_api\"\n[api_key]\napi_key = \"fal-key-123\"\n", + ); + // Non-toml and malformed files must not break the load. + write_file(dir.path(), "notes.txt", "not a credential"); + write_file(dir.path(), "broken.toml", "service = \"fal_api\""); + + let creds_dir = AppCredentialsDir::new_from(dir.path()); + let credentials = creds_dir.load_credentials().unwrap(); + + assert_eq!(credentials.len(), 2); + assert_eq!(credentials[0].service, GenerationSource::ArtcraftCookies); + assert_eq!(credentials[1].service, GenerationSource::FalApi); + } + + #[test] + fn save_credential_writes_to_source_path() { + let dir = tempfile::tempdir().unwrap(); + let creds_dir = AppCredentialsDir::new_from(dir.path()); + + let credential = AuthCredential { + id: CredentialId::generate(), + service: GenerationSource::FalApi, + name: None, + secret: CredentialSecret::ApiKey(ApiKeyCredential::new("fal-key-123")), + user_info: None, + source_path: creds_dir.file_path_for("fal_api_key"), + }; + creds_dir.save_credential(&credential).unwrap(); + + let credentials = creds_dir.load_credentials().unwrap(); + assert_eq!(credentials.len(), 1); + assert_eq!(credentials[0].api_key().unwrap().api_key, "fal-key-123"); + } + + #[test] + fn next_available_path_numbers_duplicates() { + let dir = tempfile::tempdir().unwrap(); + let creds_dir = AppCredentialsDir::new_from(dir.path()); + let service = GenerationSource::FalApi; + + let first = creds_dir.next_available_credential_path(service); + assert_eq!(first.file_name().unwrap(), "fal_api.toml"); + std::fs::write(&first, "").unwrap(); + + let second = creds_dir.next_available_credential_path(service); + assert_eq!(second.file_name().unwrap(), "fal_api_2.toml"); + std::fs::write(&second, "").unwrap(); + + let third = creds_dir.next_available_credential_path(service); + assert_eq!(third.file_name().unwrap(), "fal_api_3.toml"); + } + + #[test] + fn missing_id_is_backfilled_and_stable_across_loads() { + let dir = tempfile::tempdir().unwrap(); + write_file( + dir.path(), + "fal_api.toml", + "service = \"fal_api\"\n[api_key]\napi_key = \"fal-key-123\"\n", + ); + + let creds_dir = AppCredentialsDir::new_from(dir.path()); + let first_load = creds_dir.load_credentials().unwrap(); + assert_eq!(first_load.len(), 1); + let id = first_load[0].id.clone(); + assert!(id.as_str().starts_with("credential_")); + + // The generated id was persisted, so a reload sees the same one. + let second_load = creds_dir.load_credentials().unwrap(); + assert_eq!(second_load[0].id, id); + } + + #[test] + fn duplicate_ids_are_deduplicated_on_load() { + let dir = tempfile::tempdir().unwrap(); + let duplicated = "id = \"credential_copied\"\nservice = \"fal_api\"\n[api_key]\napi_key = \"x\"\n"; + write_file(dir.path(), "fal_api.toml", duplicated); + write_file(dir.path(), "fal_api_2.toml", duplicated); + + let creds_dir = AppCredentialsDir::new_from(dir.path()); + let credentials = creds_dir.load_credentials().unwrap(); + + assert_eq!(credentials.len(), 2); + assert_ne!(credentials[0].id, credentials[1].id); + + // The reassigned id was persisted, so a reload is stable. + let reloaded = creds_dir.load_credentials().unwrap(); + let mut ids: Vec<_> = credentials.iter().map(|c| c.id.clone()).collect(); + let mut reloaded_ids: Vec<_> = reloaded.iter().map(|c| c.id.clone()).collect(); + ids.sort(); + reloaded_ids.sort(); + assert_eq!(ids, reloaded_ids); + } + + #[test] + fn find_credential_by_id_matches() { + let dir = tempfile::tempdir().unwrap(); + write_file( + dir.path(), + "fal_api.toml", + "id = \"credential_findme\"\nservice = \"fal_api\"\n[api_key]\napi_key = \"x\"\n", + ); + + let creds_dir = AppCredentialsDir::new_from(dir.path()); + let found = creds_dir.find_credential_by_id("credential_findme").unwrap(); + assert_eq!(found.unwrap().file_name(), "fal_api.toml"); + + let missing = creds_dir.find_credential_by_id("credential_nope").unwrap(); + assert!(missing.is_none()); + } + + #[test] + fn resolve_rejects_path_traversal() { + let dir = tempfile::tempdir().unwrap(); + let creds_dir = AppCredentialsDir::new_from(dir.path()); + assert!(creds_dir.resolve_credential_file("../evil.toml").is_err()); + assert!(creds_dir.resolve_credential_file("a/b.toml").is_err()); + assert!(creds_dir.resolve_credential_file("not_toml.txt").is_err()); + assert!(creds_dir.resolve_credential_file("").is_err()); + assert!(creds_dir.resolve_credential_file("fal_api.toml").is_ok()); + } + + #[test] + fn delete_removes_the_right_file() { + let dir = tempfile::tempdir().unwrap(); + write_file( + dir.path(), + "fal_api.toml", + "service = \"fal_api\"\n[api_key]\napi_key = \"key-one\"\n", + ); + write_file( + dir.path(), + "fal_api_2.toml", + "service = \"fal_api\"\n[api_key]\napi_key = \"key-two\"\n", + ); + + let creds_dir = AppCredentialsDir::new_from(dir.path()); + creds_dir.delete_credential_file("fal_api.toml").unwrap(); + + let remaining = creds_dir.load_credentials().unwrap(); + assert_eq!(remaining.len(), 1); + assert_eq!(remaining[0].api_key().unwrap().api_key, "key-two"); + } +} diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/app_downloads_dir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/app_downloads_dir.rs new file mode 100644 index 00000000..8c112dea --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/app_downloads_dir.rs @@ -0,0 +1,21 @@ +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::path::{Path, PathBuf}; + +#[derive(Clone)] +pub struct AppDownloadsDir { + path: PathBuf, +} + +impl DataSubdir for AppDownloadsDir { + const DIRECTORY_NAME: &'static str = "downloads"; + + fn new_from>(dir: P) -> Self { + Self { + path: dir.as_ref().to_path_buf(), + } + } + + fn path(&self) -> &Path { + &self.path + } +} diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/app_settings_dir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/app_settings_dir.rs new file mode 100644 index 00000000..89fed3b2 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/app_settings_dir.rs @@ -0,0 +1,38 @@ +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::path::{Path, PathBuf}; + +/// Loose per-concern settings files. App preferences live in +/// `app_preferences.toml` (see `AppPreferences`). +#[derive(Clone)] +pub struct AppSettingsDir { + path: PathBuf, +} + +impl DataSubdir for AppSettingsDir { + const DIRECTORY_NAME: &'static str = "settings"; + + fn new_from> (dir: P) -> Self { + Self { + path: dir.as_ref().to_path_buf(), + } + } + + fn path(&self) -> &Path { + &self.path + } +} + +impl AppSettingsDir { + pub fn get_app_preferences_path(&self) -> PathBuf { + self.path.join("app_preferences.toml") + } + + /// The pre-TOML preferences file, read once to migrate existing installs. + pub fn get_legacy_app_preferences_json_path(&self) -> PathBuf { + self.path.join("app_preferences.json") + } + + pub fn get_provider_preferences_path(&self) -> PathBuf { + self.path.join("provider_preferences.json") + } +} diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/app_state_dir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/app_state_dir.rs new file mode 100644 index 00000000..8ae25fd0 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/app_state_dir.rs @@ -0,0 +1,50 @@ +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use crate::state::database::task_database_version::TASK_DATABASE_VERSION; +use std::path::{Path, PathBuf}; + +#[derive(Clone)] +pub struct AppStateDir { + path: PathBuf, +} + +impl DataSubdir for AppStateDir{ + const DIRECTORY_NAME: &'static str = "state"; + + fn new_from>(dir: P) -> Self { + Self { + path: dir.as_ref().to_path_buf(), + } + } + + fn path(&self) -> &Path { + &self.path + } +} + +impl AppStateDir { + pub fn get_tasks_sqlite_database_path(&self) -> PathBuf { + // NB: This must be incremented on any change to the database schema (including comments). + // The database houses ephemeral content and will be migrated automatically. + self.path.join(format!("tasks_v{TASK_DATABASE_VERSION}.sqlite")) + } + + /// The local_files content-hash index. Unlike the tasks database this + /// keeps a STABLE filename: it migrates additively, and on migration + /// failure it's deleted and rebuilt (every row is derivable). + pub fn get_local_files_sqlite_database_path(&self) -> PathBuf { + self.path.join("local_files.sqlite") + } + + pub fn get_window_size_config_file(&self) -> PathBuf { + self.path.join("window_size.json") + } + + pub fn get_window_position_config_file(&self) -> PathBuf { + self.path.join("window_position.json") + } + + /// What each prompt box last had selected (see `state::promptbox`). + pub fn get_promptbox_state_path(&self) -> PathBuf { + self.path.join("promptbox_state.json") + } +} diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/mod.rs b/crates/artcraftx/src/state/data_dir/subdirectory/mod.rs new file mode 100644 index 00000000..d7ad15f7 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/mod.rs @@ -0,0 +1,7 @@ +pub mod app_cache_dir; +pub mod app_credentials_dir; +pub mod app_downloads_dir; +pub mod app_settings_dir; +pub mod app_state_dir; +pub mod temporary_dir; +pub mod trait_data_subdir; diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/temporary_dir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/temporary_dir.rs new file mode 100644 index 00000000..a26593c6 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/temporary_dir.rs @@ -0,0 +1,51 @@ +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use std::path::{Path, PathBuf}; +use tempdir::TempDir; +use tempfile::{Builder, NamedTempFile}; + +#[derive(Clone)] +pub struct TemporaryDir { + path: PathBuf, +} + +impl DataSubdir for TemporaryDir { + const DIRECTORY_NAME: &'static str = "temp"; + + fn new_from>(dir: P) -> Self { + Self { + path: dir.as_ref().to_path_buf(), + } + } + + fn path(&self) -> &Path { + &self.path + } +} + +impl TemporaryDir { + pub fn with_prefix(&self, prefix: &str) -> anyhow::Result { + let tempdir = TempDir::new_in(&self.path, prefix)?; + Ok(tempdir) + } + + pub fn new_named_temp_file(&self) -> anyhow::Result { + let tempfile = Builder::new() + .prefix("temp_") + .suffix(".bin") + .tempfile_in(&self.path)?; + Ok(tempfile) + } + + pub fn new_named_temp_file_with_extension(&self, extension: &str) -> Result { + let extension = if extension.starts_with(".") { + extension.to_string() + } else { + format!(".{}", extension) + }; + let tempfile = Builder::new() + .prefix("temp_") + .suffix(&extension) + .tempfile_in(&self.path)?; + Ok(tempfile) + } +} diff --git a/crates/artcraftx/src/state/data_dir/subdirectory/trait_data_subdir.rs b/crates/artcraftx/src/state/data_dir/subdirectory/trait_data_subdir.rs new file mode 100644 index 00000000..eb44a402 --- /dev/null +++ b/crates/artcraftx/src/state/data_dir/subdirectory/trait_data_subdir.rs @@ -0,0 +1,31 @@ +use std::path::Path; + +pub trait DataSubdir : Sized { + const DIRECTORY_NAME: &'static str; + + fn new_from>(dir: P) -> Self; + + fn path(&self) -> &Path; + + fn get_or_create_in_root_dir>(root_dir: P) -> anyhow::Result { + Self::get_or_create_dir(root_dir.as_ref().join(Self::DIRECTORY_NAME)) + } + + fn get_or_create_dir>(dir: P) -> anyhow::Result { + let mut dir = dir.as_ref().to_path_buf(); + + match dir.canonicalize() { + Ok(d) => dir = d, + Err(err) => { + println!("Error canonicalizing {:?}: {}", dir, err); + } + } + + if !dir.exists() { + println!("Creating directory {:?}", dir); + std::fs::create_dir(&dir)?; + } + + Ok(Self::new_from(dir)) + } +} diff --git a/crates/artcraftx/src/state/database/local_files_database.rs b/crates/artcraftx/src/state/database/local_files_database.rs new file mode 100644 index 00000000..84907781 --- /dev/null +++ b/crates/artcraftx/src/state/database/local_files_database.rs @@ -0,0 +1,24 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use local_files_database::connection::LocalFilesDbConnection; + +/// The content-hash index of local files (thumbnail accounting today; the +/// upload-dedup ledger later). Deliberately a separate SQLite file from the +/// tasks database: it's a rebuildable index with its own write bursts and +/// lock domain. +#[derive(Clone)] +pub struct LocalFilesDatabase { + connection: LocalFilesDbConnection, +} + +impl LocalFilesDatabase { + pub async fn connect(root: &AppDataRoot) -> AnyhowResult { + let path = root.state_dir().get_local_files_sqlite_database_path(); + let connection = LocalFilesDbConnection::connect_and_migrate(path).await?; + Ok(Self { connection }) + } + + pub fn get_connection(&self) -> &LocalFilesDbConnection { + &self.connection + } +} diff --git a/crates/artcraftx/src/state/database/mod.rs b/crates/artcraftx/src/state/database/mod.rs new file mode 100644 index 00000000..dc7bc7ee --- /dev/null +++ b/crates/artcraftx/src/state/database/mod.rs @@ -0,0 +1,3 @@ +pub mod local_files_database; +pub mod task_database; +pub mod task_database_version; diff --git a/crates/artcraftx/src/state/database/task_database.rs b/crates/artcraftx/src/state/database/task_database.rs new file mode 100644 index 00000000..a822523a --- /dev/null +++ b/crates/artcraftx/src/state/database/task_database.rs @@ -0,0 +1,20 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use sqlite_database::connection::TaskDbConnection; + +#[derive(Clone)] +pub struct TaskDatabase { + connection: TaskDbConnection, +} + +impl TaskDatabase { + pub async fn connect(root: &AppDataRoot) -> AnyhowResult { + let path = root.state_dir().get_tasks_sqlite_database_path(); + let connection = TaskDbConnection::connect_and_migrate(path).await?; + Ok(Self { connection}) + } + + pub fn get_connection(&self) -> &TaskDbConnection { + &self.connection + } +} \ No newline at end of file diff --git a/crates/artcraftx/src/state/database/task_database_version.rs b/crates/artcraftx/src/state/database/task_database_version.rs new file mode 100644 index 00000000..d67024ad --- /dev/null +++ b/crates/artcraftx/src/state/database/task_database_version.rs @@ -0,0 +1,10 @@ + + +/// Used to bump the task database schema version. +/// Migrations on customers' machines tend to fail on existing databases, +/// even if we instruct that the database file be deleted first. +/// It's easiest to just write to a new file and migrate from scratch. +/// We increment this whenever we make a change to the database schema. +/// This prevents deadlock on startup if the schema has changed from the +/// previous version. +pub const TASK_DATABASE_VERSION: u32 = 8; diff --git a/crates/artcraftx/src/state/mod.rs b/crates/artcraftx/src/state/mod.rs new file mode 100644 index 00000000..e4761e37 --- /dev/null +++ b/crates/artcraftx/src/state/mod.rs @@ -0,0 +1,8 @@ +pub mod app_preferences; +pub mod promptbox; +pub mod usage_tracker; +pub mod data_dir; +pub mod database; +pub mod runtime; +pub mod thumbnails; +pub mod window; diff --git a/crates/artcraftx/src/state/promptbox/mod.rs b/crates/artcraftx/src/state/promptbox/mod.rs new file mode 100644 index 00000000..ab94f73e --- /dev/null +++ b/crates/artcraftx/src/state/promptbox/mod.rs @@ -0,0 +1,7 @@ +//! Per-modality prompt box state (selected account, model, and options), +//! persisted so it survives restarts. See [`promptbox_state::PromptboxState`]. + +pub mod modality_promptbox_state; +pub mod promptbox_modality; +pub mod promptbox_state; +pub mod promptbox_state_manager; diff --git a/crates/artcraftx/src/state/promptbox/modality_promptbox_state.rs b/crates/artcraftx/src/state/promptbox/modality_promptbox_state.rs new file mode 100644 index 00000000..625f17af --- /dev/null +++ b/crates/artcraftx/src/state/promptbox/modality_promptbox_state.rs @@ -0,0 +1,25 @@ +use serde_derive::{Deserialize, Serialize}; +use serde_json::{Map, Value}; + +/// What one modality's prompt box last had selected. +/// +/// The backend stores these verbatim and never interprets them: the frontend +/// validates on hydration (a model or account that no longer exists is simply +/// dropped), so stale or hand-edited state can't break the app. +#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct ModalityPromptboxState { + /// The stored credential (`credential_{entropy}`) the prompt box generates + /// with. An account, not a provider: the user may have several accounts on + /// one service. + #[serde(skip_serializing_if = "Option::is_none")] + pub selected_account_id: Option, + + /// The model id (as served by the `models` crate). + #[serde(skip_serializing_if = "Option::is_none")] + pub selected_model: Option, + + /// Model/mode-specific options (aspect ratio, resolution, batch count, + /// duration, ...), as an opaque JSON object owned by the frontend. + pub options: Map, +} diff --git a/crates/artcraftx/src/state/promptbox/promptbox_modality.rs b/crates/artcraftx/src/state/promptbox/promptbox_modality.rs new file mode 100644 index 00000000..321d5b62 --- /dev/null +++ b/crates/artcraftx/src/state/promptbox/promptbox_modality.rs @@ -0,0 +1,12 @@ +use serde_derive::{Deserialize, Serialize}; + +/// The generation modalities that each have a prompt box. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum PromptboxModality { + Image, + Video, + Mesh, + Splat, + Audio, +} diff --git a/crates/artcraftx/src/state/promptbox/promptbox_state.rs b/crates/artcraftx/src/state/promptbox/promptbox_state.rs new file mode 100644 index 00000000..8c497fd1 --- /dev/null +++ b/crates/artcraftx/src/state/promptbox/promptbox_state.rs @@ -0,0 +1,154 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::promptbox::modality_promptbox_state::ModalityPromptboxState; +use crate::state::promptbox::promptbox_modality::PromptboxModality; +use errors::AnyhowResult; +use log::warn; +use serde_derive::{Deserialize, Serialize}; +use std::collections::BTreeMap; +use std::path::Path; + +/// File format version (not semver). +/// - 1: initial. +const CURRENT_VERSION: u32 = 1; + +/// Everything the prompt boxes remember across restarts, persisted as +/// `state/promptbox_state.json`. +/// +/// Every field defaults independently, so a file from an older build (or one +/// missing pieces) still loads; an unreadable file is replaced by the +/// defaults (logged), never a crash. +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(default)] +pub struct PromptboxState { + pub version: u32, + pub image: ModalityPromptboxState, + pub video: ModalityPromptboxState, + pub mesh: ModalityPromptboxState, + pub splat: ModalityPromptboxState, + pub audio: ModalityPromptboxState, + + /// The account last used with each model (model id -> credential id), so + /// re-selecting a model brings back the account it was last run on, even + /// when the current account could also run it. + pub last_account_by_model: BTreeMap, +} + +impl Default for PromptboxState { + fn default() -> Self { + Self { + version: CURRENT_VERSION, + image: ModalityPromptboxState::default(), + video: ModalityPromptboxState::default(), + mesh: ModalityPromptboxState::default(), + splat: ModalityPromptboxState::default(), + audio: ModalityPromptboxState::default(), + last_account_by_model: BTreeMap::new(), + } + } +} + +impl PromptboxState { + /// Load from the state directory, or the defaults when there is no file or + /// it can't be read (logged). + pub fn load_or_default(data_root: &AppDataRoot) -> Self { + let path = data_root.state_dir().get_promptbox_state_path(); + if !path.exists() { + return Self::default(); + } + match Self::load_from_file(&path) { + Ok(state) => state, + Err(err) => { + warn!("Could not read prompt box state from {:?}; starting fresh: {}", path, err); + Self::default() + } + } + } + + pub fn load_from_file(path: &Path) -> AnyhowResult { + let contents = std::fs::read_to_string(path)?; + let mut state: Self = serde_json::from_str(&contents)?; + state.version = CURRENT_VERSION; + Ok(state) + } + + /// Write atomically (temp file + rename) so a crash mid-write can't leave a + /// truncated file. + pub fn save_to_file(&self, path: &Path) -> AnyhowResult<()> { + if let Some(parent) = path.parent() { + std::fs::create_dir_all(parent)?; + } + let contents = serde_json::to_string_pretty(self)?; + let temp_path = path.with_extension("json.tmp"); + std::fs::write(&temp_path, contents)?; + std::fs::rename(&temp_path, path)?; + Ok(()) + } + + pub fn save(&self, data_root: &AppDataRoot) -> AnyhowResult<()> { + self.save_to_file(&data_root.state_dir().get_promptbox_state_path()) + } + + pub fn modality(&self, modality: PromptboxModality) -> &ModalityPromptboxState { + match modality { + PromptboxModality::Image => &self.image, + PromptboxModality::Video => &self.video, + PromptboxModality::Mesh => &self.mesh, + PromptboxModality::Splat => &self.splat, + PromptboxModality::Audio => &self.audio, + } + } + + pub fn modality_mut(&mut self, modality: PromptboxModality) -> &mut ModalityPromptboxState { + match modality { + PromptboxModality::Image => &mut self.image, + PromptboxModality::Video => &mut self.video, + PromptboxModality::Mesh => &mut self.mesh, + PromptboxModality::Splat => &mut self.splat, + PromptboxModality::Audio => &mut self.audio, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::json; + + #[test] + fn round_trips_through_file() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("promptbox_state.json"); + + let mut state = PromptboxState::default(); + state.image.selected_account_id = Some("credential_abc".to_string()); + state.image.selected_model = Some("midjourney_7".to_string()); + state.image.options = json!({ "aspect_ratio": "square", "batch_count": 4 }).as_object().unwrap().clone(); + state.video.selected_model = Some("seedance_2p0".to_string()); + state.last_account_by_model.insert("midjourney_7".to_string(), "credential_abc".to_string()); + + state.save_to_file(&path).unwrap(); + assert_eq!(PromptboxState::load_from_file(&path).unwrap(), state); + } + + #[test] + fn partial_or_unknown_fields_still_load() { + let state: PromptboxState = serde_json::from_str(r#"{ + "version": 1, + "image": { "selected_model": "nano_banana_pro", "future_field": true }, + "something_new": [1, 2, 3] + }"#).unwrap(); + assert_eq!(state.image.selected_model.as_deref(), Some("nano_banana_pro")); + assert_eq!(state.image.selected_account_id, None); + assert_eq!(state.video, ModalityPromptboxState::default()); + assert!(state.last_account_by_model.is_empty()); + } + + #[test] + fn unreadable_file_falls_back_to_defaults() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("promptbox_state.json"); + std::fs::write(&path, "{ this is not json").unwrap(); + assert!(PromptboxState::load_from_file(&path).is_err()); + // (load_or_default logs and returns Default; exercised via the manager.) + } +} diff --git a/crates/artcraftx/src/state/promptbox/promptbox_state_manager.rs b/crates/artcraftx/src/state/promptbox/promptbox_state_manager.rs new file mode 100644 index 00000000..a89953b6 --- /dev/null +++ b/crates/artcraftx/src/state/promptbox/promptbox_state_manager.rs @@ -0,0 +1,95 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::promptbox::promptbox_state::PromptboxState; +use errors::AnyhowResult; +use log::warn; +use memory_store::clone_cell::CloneCell; +use std::sync::{Arc, Mutex, MutexGuard}; + +/// Shared, process-wide prompt box state: an in-memory copy that readers +/// clone, and a single write path that persists to disk. +#[derive(Clone)] +pub struct PromptboxStateManager { + state: CloneCell, + data_root: AppDataRoot, + /// Serializes `update` so concurrent commands don't race each other's + /// read-modify-write or collide on the same temp file when saving. + /// The guarded section is synchronous and tiny (clone, serialize a few KB, + /// write, rename), so callers queue for microseconds, never the UI. + write_lock: Arc>, +} + +impl PromptboxStateManager { + pub fn load_or_default(data_root: &AppDataRoot) -> Self { + Self { + state: CloneCell::with_owned(PromptboxState::load_or_default(data_root)), + data_root: data_root.clone(), + write_lock: Arc::new(Mutex::new(())), + } + } + + pub fn get(&self) -> AnyhowResult { + self.state.get_clone() + } + + /// Apply a change, persist it, and return the updated snapshot. Nothing + /// changes in memory if the write fails. + pub fn update(&self, change: impl FnOnce(&mut PromptboxState)) -> AnyhowResult { + let _guard = self.acquire_write_lock(); + let mut state = self.get()?; + change(&mut state); + state.save(&self.data_root)?; + self.state.set_clone(&state)?; + Ok(state) + } + + /// The lock guards nothing but ordering (the real state lives in the cell + /// and on disk, and saves are atomic), so a poisoned lock is safe to reuse. + /// Failing here forever would just break a low-stakes preference feature. + fn acquire_write_lock(&self) -> MutexGuard<'_, ()> { + self.write_lock.lock().unwrap_or_else(|poisoned| { + warn!("Prompt box write lock was poisoned by an earlier panic; continuing"); + poisoned.into_inner() + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::thread; + + const THREADS: usize = 8; + const UPDATES_PER_THREAD: usize = 25; + + /// Regression: concurrent updates used to race on the shared temp file + /// (`rename` -> ENOENT) and clobber each other's changes. + #[test] + fn concurrent_updates_all_succeed_and_none_are_lost() { + let dir = tempfile::tempdir().unwrap(); + let data_root = AppDataRoot::create_existing(dir.path()).unwrap(); + let manager = PromptboxStateManager::load_or_default(&data_root); + + let handles: Vec<_> = (0..THREADS) + .map(|thread_index| { + let manager = manager.clone(); + thread::spawn(move || { + for i in 0..UPDATES_PER_THREAD { + manager + .update(|state| { + state.last_account_by_model.insert(format!("model_{thread_index}_{i}"), "credential".to_string()); + }) + .expect("update should never fail under contention"); + } + }) + }) + .collect(); + for handle in handles { + handle.join().unwrap(); + } + + let expected = THREADS * UPDATES_PER_THREAD; + assert_eq!(manager.get().unwrap().last_account_by_model.len(), expected, "in memory"); + let on_disk = PromptboxState::load_or_default(&data_root); + assert_eq!(on_disk.last_account_by_model.len(), expected, "on disk"); + } +} diff --git a/crates/artcraftx/src/state/runtime/app_startup_time.rs b/crates/artcraftx/src/state/runtime/app_startup_time.rs new file mode 100644 index 00000000..900797eb --- /dev/null +++ b/crates/artcraftx/src/state/runtime/app_startup_time.rs @@ -0,0 +1,22 @@ +use chrono::{DateTime, TimeDelta, Utc}; + +pub struct AppStartupTime { + startup_time: DateTime, +} + +impl AppStartupTime { + pub fn new() -> Self { + Self { + startup_time: Utc::now(), + } + } + + pub fn get_startup_time(&self) -> DateTime { + self.startup_time + } + + pub fn time_delta_since(&self) -> TimeDelta { + let now = Utc::now(); + now.signed_duration_since(self.startup_time) + } +} diff --git a/crates/artcraftx/src/state/runtime/artcraft_platform_info.rs b/crates/artcraftx/src/state/runtime/artcraft_platform_info.rs new file mode 100644 index 00000000..3abc99d1 --- /dev/null +++ b/crates/artcraftx/src/state/runtime/artcraft_platform_info.rs @@ -0,0 +1,68 @@ +use crate::state::runtime::os_platform::OsPlatform; +use crate::version::ARTCRAFT_VERSION; +use chrono::{DateTime, Utc}; + +#[derive(Clone, Debug)] +pub struct ArtcraftPlatformInfo { + pub artcraft_version: String, + + pub os_platform: ArtcraftOs, + pub os_version: String, + + pub build_timestamp: DateTime, + + pub git_commit_id: Option, + pub git_commit_short_id: Option, + pub git_commit_timestamp: Option>, +} + +#[derive(Copy, Clone, Debug)] +pub enum ArtcraftOs { + Windows, + MacOS, + Linux, + Unknown, +} + +impl ArtcraftPlatformInfo { + + pub fn get() -> Self { + let build_timestamp = build_metadata::build_timestamp(); + let git_commit_id = build_metadata::git_commit_id().map(|s| s.to_string()); + let git_commit_short_id = build_metadata::git_commit_short_id().map(|s| s.to_string()); + let git_commit_timestamp = build_metadata::git_commit_timestamp(); + + let os_info = os_info::get(); + + let maybe_os_version = Some(os_info.version().to_string()) + .map(|s| s.trim().to_string()) + .filter(|s| !s.is_empty()) + .unwrap_or_else(|| "unknown".to_string()); + + Self { + artcraft_version: ARTCRAFT_VERSION.to_string(), + os_platform: match OsPlatform::maybe_get() { + Some(OsPlatform::Linux) => ArtcraftOs::Linux, + Some(OsPlatform::MacOs) => ArtcraftOs::MacOS, + Some(OsPlatform::Windows) => ArtcraftOs::Windows, + None => ArtcraftOs::Unknown, + }, + os_version: maybe_os_version, + build_timestamp, + git_commit_id, + git_commit_short_id, + git_commit_timestamp, + } + } +} + +impl ArtcraftOs { + pub fn as_str(&self) -> &'static str { + match self { + ArtcraftOs::Windows => "windows", + ArtcraftOs::MacOS => "macos", + ArtcraftOs::Linux => "linux", + ArtcraftOs::Unknown => "unknown", + } + } +} diff --git a/crates/artcraftx/src/state/runtime/expanduser.rs b/crates/artcraftx/src/state/runtime/expanduser.rs new file mode 100644 index 00000000..5be63cd1 --- /dev/null +++ b/crates/artcraftx/src/state/runtime/expanduser.rs @@ -0,0 +1,73 @@ +use once_cell::sync::Lazy; +use std::io; +use std::path::{PathBuf, MAIN_SEPARATOR}; + +static PREFIX: Lazy = Lazy::new(|| format!("~{}", MAIN_SEPARATOR)); + +/// The "expanduser" crate doesn't compile on Windows, so we replace its functionality slightly +pub fn expanduser>(path: P) -> io::Result { + + Ok(match path.as_ref() { + // matches an exact "~" + s if s == "~" => { + home_dir()? + }, + // matches paths that start with `~/` + s if s.starts_with(&*PREFIX) => { + let home = home_dir()?; + home.join(&s[2..]) + }, + // // matches paths that start with `~` but not `~/`, might be a `~username/` path + // s if s.starts_with("~") => { + // let mut parts = s[1..].splitn(2, MAIN_SEPARATOR); + // let user = parts.next() + // .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "malformed path"))?; + // let user = Passwd::from_name(&user) + // .map_err(|_| io::Error::new(io::ErrorKind::Other, "error searching for user"))? + // .ok_or_else(|| io::Error::new(io::ErrorKind::Other, format!("user '{}', does not exist", &user)))?; + // if let Some(ref path) = parts.next() { + // PathBuf::from(user.dir).join(&path) + // } else { + // PathBuf::from(user.dir) + // } + // }, + // nothing to expand, just make a PathBuf + s => PathBuf::from(s) + }) +} + +pub fn home_dir() -> io::Result { + dirs::home_dir() + .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "no home directory is set")) +} + +#[cfg(test)] +mod tests { + use crate::state::runtime::expanduser::expanduser; + use std::env; + use std::path::PathBuf; + + #[test] + #[serial_test::serial] + fn test_success() { + let old_home = env::var("HOME").expect("no home dir set"); + let new_home = "/home/foo"; + env::set_var("HOME", new_home); + let path = expanduser("~/path/to/directory"); + env::set_var("HOME", old_home); + assert_eq!(path.expect("io error"), PathBuf::from("/home/foo/path/to/directory")); + } + + #[test] + #[serial_test::serial] + fn test_only_tilde() { + let old_home = env::var("HOME").expect("no home dir set"); + let new_home = "/home/foo"; + env::set_var("HOME", new_home); + let pathstr = "~"; + let path = expanduser(pathstr); + env::set_var("HOME", old_home); + assert_eq!(path.expect("io error"), PathBuf::from("/home/foo")); + } + +} \ No newline at end of file diff --git a/crates/artcraftx/src/state/runtime/mod.rs b/crates/artcraftx/src/state/runtime/mod.rs new file mode 100644 index 00000000..7a9a68a8 --- /dev/null +++ b/crates/artcraftx/src/state/runtime/mod.rs @@ -0,0 +1,4 @@ +pub mod app_startup_time; +pub mod artcraft_platform_info; +pub mod expanduser; +pub mod os_platform; diff --git a/crates/artcraftx/src/state/runtime/os_platform.rs b/crates/artcraftx/src/state/runtime/os_platform.rs new file mode 100644 index 00000000..37a94e82 --- /dev/null +++ b/crates/artcraftx/src/state/runtime/os_platform.rs @@ -0,0 +1,33 @@ + +#[derive(Copy, Clone, Eq, PartialEq, Debug)] +pub enum OsPlatform { + Linux, + MacOs, + Windows, +} + +impl OsPlatform { + pub fn maybe_get() -> Option { + // Totally scientific. + // https://doc.rust-lang.org/std/env/consts/constant.OS.html + match std::env::consts::OS { + "linux" => Some(Self::Linux), + "windows" => Some(Self::Windows), + "macos" | "apple" => Some(Self::MacOs), + _ => None, + } + } + + pub fn maybe_get_str() -> Option<&'static str> { + match Self::maybe_get() { + Some(Self::Linux) => Some("linux"), + Some(Self::Windows) => Some("windows"), + Some(Self::MacOs) => Some("macos"), // NB: "apple" can become "macos". + None => None, + } + } + + pub fn get() -> Self { + Self::maybe_get().unwrap_or(Self::Linux) + } +} diff --git a/crates/artcraftx/src/state/thumbnails/mod.rs b/crates/artcraftx/src/state/thumbnails/mod.rs new file mode 100644 index 00000000..89ee1501 --- /dev/null +++ b/crates/artcraftx/src/state/thumbnails/mod.rs @@ -0,0 +1 @@ +pub mod thumbnail_work_queue; diff --git a/crates/artcraftx/src/state/thumbnails/thumbnail_work_queue.rs b/crates/artcraftx/src/state/thumbnails/thumbnail_work_queue.rs new file mode 100644 index 00000000..e6dfa0ed --- /dev/null +++ b/crates/artcraftx/src/state/thumbnails/thumbnail_work_queue.rs @@ -0,0 +1,122 @@ +//! The wake-up channel between downloaders and the thumbnail worker thread. +//! +//! Downloaders push the paths they just wrote and the worker wakes at once; +//! without a push the worker still scans the databases on its own timer, +//! so a lost signal only delays a thumbnail, never loses it. + +use std::collections::{HashSet, VecDeque}; +use std::path::{Path, PathBuf}; +use std::sync::{Arc, Mutex}; + +use log::{debug, warn}; +use tauri::{AppHandle, Manager}; +use tokio::sync::Notify; + +/// Tauri-managed state. Cheap to clone; all clones share one queue. +#[derive(Clone)] +pub struct ThumbnailWorkQueue { + inner: Arc, +} + +struct Inner { + /// FIFO of paths to thumbnail, deduplicated by `queued`. + pending: Mutex, + /// Wakes the worker; `notify_one` stores a permit if it isn't waiting. + notify: Notify, +} + +#[derive(Default)] +struct PendingPaths { + order: VecDeque, + queued: HashSet, +} + +impl ThumbnailWorkQueue { + pub fn new() -> Self { + Self { + inner: Arc::new(Inner { + pending: Mutex::new(PendingPaths::default()), + notify: Notify::new(), + }), + } + } + + /// Queue freshly downloaded files and wake the worker. Fails open when the + /// queue isn't managed (headless callers, early startup): the worker's + /// periodic database scan picks the files up later. + pub fn enqueue_for_app(app: &AppHandle, file_paths: &[impl AsRef]) { + match app.try_state::() { + Some(queue) => queue.enqueue(file_paths), + None => warn!("[ThumbnailQueue] Not managed yet; {} file(s) will be found by the periodic scan", file_paths.len()), + } + } + + /// Queue paths (skipping ones already queued) and wake the worker. + pub fn enqueue(&self, file_paths: &[impl AsRef]) { + if file_paths.is_empty() { + return; + } + let mut added = 0; + { + let mut pending = self.inner.pending.lock().expect("thumbnail queue lock poisoned"); + for file_path in file_paths { + let file_path = file_path.as_ref().to_path_buf(); + if pending.queued.insert(file_path.clone()) { + pending.order.push_back(file_path); + added += 1; + } + } + } + debug!("[ThumbnailQueue] Queued {} new path(s)", added); + self.inner.notify.notify_one(); + } + + /// Wake the worker without queueing anything (e.g. to force a scan). + pub fn wake(&self) { + self.inner.notify.notify_one(); + } + + /// Take everything queued so far, in FIFO order. + pub fn drain(&self) -> Vec { + let mut pending = self.inner.pending.lock().expect("thumbnail queue lock poisoned"); + pending.queued.clear(); + pending.order.drain(..).collect() + } + + /// Resolves on the next wake-up (or immediately if one is already stored). + pub async fn notified(&self) { + self.inner.notify.notified().await + } +} + +impl Default for ThumbnailWorkQueue { + fn default() -> Self { + Self::new() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn drain_returns_fifo_without_duplicates() { + let queue = ThumbnailWorkQueue::new(); + queue.enqueue(&["/a.mp4", "/b.mp4"]); + queue.enqueue(&["/a.mp4", "/c.mp4"]); + let drained = queue.drain(); + assert_eq!(drained, vec![PathBuf::from("/a.mp4"), PathBuf::from("/b.mp4"), PathBuf::from("/c.mp4")]); + assert!(queue.drain().is_empty()); + // Once drained a path can be queued again (its content may have changed). + queue.enqueue(&["/a.mp4"]); + assert_eq!(queue.drain().len(), 1); + } + + #[tokio::test] + async fn enqueue_wakes_a_waiter_even_before_it_waits() { + let queue = ThumbnailWorkQueue::new(); + queue.enqueue(&["/a.mp4"]); + // The permit was stored, so this completes immediately. + tokio::time::timeout(std::time::Duration::from_millis(100), queue.notified()).await.unwrap(); + } +} diff --git a/crates/artcraftx/src/state/usage_tracker/artcraft_usage_tracker.rs b/crates/artcraftx/src/state/usage_tracker/artcraft_usage_tracker.rs new file mode 100644 index 00000000..753ccb13 --- /dev/null +++ b/crates/artcraftx/src/state/usage_tracker/artcraft_usage_tracker.rs @@ -0,0 +1,135 @@ +use crate::state::usage_tracker::artcraft_usage_tracker_data::ArtcraftUsageTrackerData; +use std::sync::{Arc, RwLock}; +use log::error; +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::usage_tracker::artcraft_usage_type::{ArtcraftUsagePage, ArtcraftUsageType}; + +/// Track generation volume so we know which areas to focus efforts on. +/// But also note: https://en.wikipedia.org/wiki/Survivorship_bias +#[derive(Clone)] +pub struct ArtcraftUsageTracker { + data: Arc>, +} + + +impl ArtcraftUsageTracker { + pub fn new() -> Self { + Self { + data: Arc::new(RwLock::new(ArtcraftUsageTrackerData::new())), + } + } + + pub fn record_image_generation(&self, num_images: u16, usage_type: ArtcraftUsageType, page: ArtcraftUsagePage) -> Result<(), ArtcraftXError> { + let mut data = self.get()?; + data.total_generation_count += num_images; + data.image_generation_count += num_images; + match usage_type { + ArtcraftUsageType::TextToResult => { + data.text_to_image_count += num_images; + } + ArtcraftUsageType::ImageToResult => { + data.image_to_image_count += num_images; + } + ArtcraftUsageType::Other => {} + } + match page { + ArtcraftUsagePage::ImagePage => { + data.image_page_prompt_count += num_images; + } + ArtcraftUsagePage::EditPage => { + data.edit_page_prompt_count += num_images; + } + ArtcraftUsagePage::StagePage => { + data.stage_page_prompt_count += num_images; + } + ArtcraftUsagePage::OtherPage => { + data.other_page_prompt_count += num_images; + } + ArtcraftUsagePage::VideoPage => {} // NB: Does not generate images. + ArtcraftUsagePage::ObjectPage => {} // NB: Does not generate images. + } + self.set(data)?; + Ok(()) + } + + pub fn record_video_generation(&self, num_videos: u16, usage_type: ArtcraftUsageType, page: ArtcraftUsagePage) -> Result<(), ArtcraftXError> { + let mut data = self.get()?; + data.total_generation_count += num_videos; + data.video_generation_count += num_videos; + match usage_type { + ArtcraftUsageType::TextToResult => { + data.text_to_video_count += num_videos; + } + ArtcraftUsageType::ImageToResult => { + data.image_to_video_count += num_videos; + } + ArtcraftUsageType::Other => {} + } + match page { + ArtcraftUsagePage::VideoPage => { + data.video_page_prompt_count += num_videos; + } + ArtcraftUsagePage::OtherPage => { + data.other_page_prompt_count += num_videos; + } + ArtcraftUsagePage::ImagePage => {} // NB: Does not generate videos. + ArtcraftUsagePage::EditPage => {} // NB: Does not generate videos. + ArtcraftUsagePage::StagePage => {} // NB: Does not generate videos. + ArtcraftUsagePage::ObjectPage => {} // NB: Does not generate videos. + } + self.set(data)?; + Ok(()) + } + + pub fn record_object_generation(&self, num_objects: u16, usage_type: ArtcraftUsageType, page: ArtcraftUsagePage) -> Result<(), ArtcraftXError> { + let mut data = self.get()?; + data.total_generation_count += num_objects; + data.object_generation_count += num_objects; + match usage_type { + ArtcraftUsageType::TextToResult => { + data.text_to_object_count += num_objects; + } + ArtcraftUsageType::ImageToResult => { + data.image_to_object_count += num_objects; + } + ArtcraftUsageType::Other => {} + } + match page { + ArtcraftUsagePage::ObjectPage => { + data.object_page_prompt_count += num_objects; + } + ArtcraftUsagePage::OtherPage => { + data.other_page_prompt_count += num_objects; + } + ArtcraftUsagePage::ImagePage => {} // NB: Does not generate objects. + ArtcraftUsagePage::VideoPage => {} // NB: Does not generate objects. + ArtcraftUsagePage::EditPage => {} // NB: Does not generate objects. + ArtcraftUsagePage::StagePage => {} // NB: Does not generate objects. + } + self.set(data)?; + Ok(()) + } + + pub fn get(&self) -> Result { + match self.data.read() { + Ok(data) => Ok(data.clone()), + Err(err) => { + error!("Lock read error: {:?}", err); + Err(ArtcraftXError::RwLockReadError) + } + } + } + + fn set(&self, data: ArtcraftUsageTrackerData) -> Result<(), ArtcraftXError> { + match self.data.write() { + Ok(mut lock) => { + *lock = data; + Ok(()) + }, + Err(err) => { + error!("Lock write error: {:?}", err); + Err(ArtcraftXError::RwLockWriteError) + } + } + } +} diff --git a/crates/artcraftx/src/state/usage_tracker/artcraft_usage_tracker_data.rs b/crates/artcraftx/src/state/usage_tracker/artcraft_usage_tracker_data.rs new file mode 100644 index 00000000..725c7609 --- /dev/null +++ b/crates/artcraftx/src/state/usage_tracker/artcraft_usage_tracker_data.rs @@ -0,0 +1,46 @@ + +/// Track generation volume so we know which areas to focus efforts on. +/// But also note: https://en.wikipedia.org/wiki/Survivorship_bias +#[derive(Clone)] +pub struct ArtcraftUsageTrackerData { + pub total_generation_count: u16, + pub image_generation_count: u16, + pub video_generation_count: u16, + pub object_generation_count: u16, + pub text_to_image_count: u16, + pub image_to_image_count: u16, + pub text_to_video_count: u16, + pub image_to_video_count: u16, + pub text_to_object_count: u16, + pub image_to_object_count: u16, + pub image_page_prompt_count: u16, + pub video_page_prompt_count: u16, + pub edit_page_prompt_count: u16, + pub stage_page_prompt_count: u16, + pub object_page_prompt_count: u16, + pub other_page_prompt_count: u16, +} + +impl ArtcraftUsageTrackerData { + pub fn new() -> Self { + Self { + total_generation_count: 0, + image_generation_count: 0, + video_generation_count: 0, + object_generation_count: 0, + text_to_image_count: 0, + image_to_image_count: 0, + text_to_video_count: 0, + image_to_video_count: 0, + text_to_object_count: 0, + image_to_object_count: 0, + image_page_prompt_count: 0, + video_page_prompt_count: 0, + edit_page_prompt_count: 0, + stage_page_prompt_count: 0, + object_page_prompt_count: 0, + other_page_prompt_count: 0, + } + } +} + diff --git a/crates/artcraftx/src/state/usage_tracker/artcraft_usage_type.rs b/crates/artcraftx/src/state/usage_tracker/artcraft_usage_type.rs new file mode 100644 index 00000000..6fe8684b --- /dev/null +++ b/crates/artcraftx/src/state/usage_tracker/artcraft_usage_type.rs @@ -0,0 +1,18 @@ + + +#[derive(Clone, Copy, Debug, PartialEq)] +pub enum ArtcraftUsageType { + TextToResult, + ImageToResult, + Other, +} + +#[derive(Clone, Copy, Debug, PartialEq)] +pub enum ArtcraftUsagePage { + ImagePage, + VideoPage, + EditPage, + StagePage, + ObjectPage, + OtherPage, +} diff --git a/crates/artcraftx/src/state/usage_tracker/mod.rs b/crates/artcraftx/src/state/usage_tracker/mod.rs new file mode 100644 index 00000000..8a61045b --- /dev/null +++ b/crates/artcraftx/src/state/usage_tracker/mod.rs @@ -0,0 +1,3 @@ +pub mod artcraft_usage_tracker; +pub mod artcraft_usage_type; +mod artcraft_usage_tracker_data; \ No newline at end of file diff --git a/crates/artcraftx/src/state/window/main_window_position.rs b/crates/artcraftx/src/state/window/main_window_position.rs new file mode 100644 index 00000000..e6cacf07 --- /dev/null +++ b/crates/artcraftx/src/state/window/main_window_position.rs @@ -0,0 +1,65 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::windows::main_window::constants::MAIN_WINDOW_NAME; +use errors::AnyhowResult; +use serde_derive::{Deserialize, Serialize}; +use std::fs::OpenOptions; +use std::io::Write; +use tauri::{AppHandle, Manager, PhysicalPosition, Window}; + +#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)] +pub struct MainWindowPosition { + pub x: i32, + pub y: i32, +} + +impl MainWindowPosition { + pub fn new(x: i32, y: i32) -> Self { + Self { x, y } + } + + pub fn from_main_window(app: &AppHandle) -> AnyhowResult { + let windows = app.windows(); + windows.get(MAIN_WINDOW_NAME) + .map(|window| Self::from_window(window)) + .unwrap_or_else(|| Err(anyhow::anyhow!("Main window not found"))) + } + + pub fn from_window(window: &Window) -> AnyhowResult { + let position = window.outer_position()?; + Ok(Self { + x: position.x, + y: position.y, + }) + } + + pub fn from_filesystem_configs(app_data_root: &AppDataRoot) -> AnyhowResult> { + let filename = app_data_root.get_window_position_config_file(); + if !filename.exists() { + return Ok(None); + } + let contents = std::fs::read_to_string(filename)?; + let pos : MainWindowPosition = serde_json::from_str(&contents)?; + Ok(Some(pos)) + } + + pub fn persist_to_filesystem(&self, app_data_root: &AppDataRoot) -> AnyhowResult<()> { + let filename = app_data_root.get_window_position_config_file(); + let json = serde_json::to_string(self)?; + let mut file = OpenOptions::new() + .create(true) + .write(true) + .truncate(true) + .open(filename)?; + file.write_all(json.as_bytes())?; + file.flush()?; + Ok(()) + } + + pub fn to_physical_position(&self) -> PhysicalPosition { + PhysicalPosition::new(self.x, self.y) + } + + pub fn matches_physical_position(&self, pos: &PhysicalPosition) -> bool { + self.x == pos.x && self.y == pos.y + } +} diff --git a/crates/artcraftx/src/state/window/main_window_size.rs b/crates/artcraftx/src/state/window/main_window_size.rs new file mode 100644 index 00000000..23123ed0 --- /dev/null +++ b/crates/artcraftx/src/state/window/main_window_size.rs @@ -0,0 +1,82 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::window::get_window_size_heuristic::get_window_size_heuristic; +use crate::windows::main_window::constants::{MAIN_WINDOW_MIN_HEIGHT, MAIN_WINDOW_MIN_WIDTH, MAIN_WINDOW_NAME}; +use errors::AnyhowResult; +use serde_derive::{Deserialize, Serialize}; +use std::fs::OpenOptions; +use std::io::Write; +use tauri::{AppHandle, Manager, PhysicalSize, Window}; + + +#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)] +pub struct MainWindowSize { + pub width: u32, + pub height: u32, +} + +impl MainWindowSize { + pub fn new(width: u32, height: u32) -> Self { + Self { width, height } + } + + pub fn from_main_window(app: &AppHandle) -> AnyhowResult { + let windows = app.windows(); + windows.get(MAIN_WINDOW_NAME) + .map(|window| Self::from_window(window)) + .unwrap_or_else(|| Err(anyhow::anyhow!("Main window not found"))) + } + + pub fn from_window(window: &Window) -> AnyhowResult { + let size = get_window_size_heuristic(window)?; + Ok(Self { + width: size.width, + height: size.height, + }) + } + + pub fn from_filesystem_configs(app_data_root: &AppDataRoot) -> AnyhowResult> { + let filename = app_data_root.get_window_size_config_file(); + if !filename.exists() { + return Ok(None); + } + let contents = std::fs::read_to_string(filename)?; + let size: MainWindowSize = serde_json::from_str(&contents)?; + Ok(Some(size)) + } + + pub fn persist_to_filesystem(&self, app_data_root: &AppDataRoot) -> AnyhowResult<()> { + let filename = app_data_root.get_window_size_config_file(); + let json = serde_json::to_string(self)?; + let mut file = OpenOptions::new() + .create(true) + .write(true) + .truncate(true) + .open(filename)?; + file.write_all(json.as_bytes())?; + file.flush()?; + Ok(()) + } + + /// Window size is not wide enough to persist or apply. + pub fn is_not_wide_enough(&self) -> bool { + self.width < MAIN_WINDOW_MIN_WIDTH + } + + /// Window size is not tall enough to persist or apply. + pub fn is_not_tall_enough(&self) -> bool { + self.height < MAIN_WINDOW_MIN_HEIGHT + } + + /// Window size is not big enough (tall or wide) to persist or apply. + pub fn is_not_big_enough(&self) -> bool { + self.is_not_wide_enough() || self.is_not_tall_enough() + } + + pub fn to_physical_size(&self) -> PhysicalSize { + PhysicalSize::new(self.width, self.height) + } + + pub fn matches_physical_size(&self, size: &PhysicalSize) -> bool { + self.width == size.width && self.height == size.height + } +} diff --git a/crates/artcraftx/src/state/window/mod.rs b/crates/artcraftx/src/state/window/mod.rs new file mode 100644 index 00000000..697e172a --- /dev/null +++ b/crates/artcraftx/src/state/window/mod.rs @@ -0,0 +1,2 @@ +pub mod main_window_position; +pub mod main_window_size; \ No newline at end of file diff --git a/crates/artcraftx/src/threads/discord_presence_thread.rs b/crates/artcraftx/src/threads/discord_presence_thread.rs new file mode 100644 index 00000000..06acbd07 --- /dev/null +++ b/crates/artcraftx/src/threads/discord_presence_thread.rs @@ -0,0 +1,64 @@ +use anyhow::anyhow; +use discord_rich_presence::{DiscordIpc, DiscordIpcClient}; +use errors::AnyhowResult; +use log::{debug, info}; +use rand::random_range; + +/// Our Discord App ID. Not sure if this is a secret. +// const DISCORD_APP_ID : &str = "1366596912593113138"; +const DISCORD_APP_ID : &str = "1534088661052817480"; + +const DISCORD_ARTCRAFT_LOGO_SPIN : &str = "https://getartcraft.com/discord-status-icons/artcraft-a-spin-512x512.webp"; +const DISCORD_ARTCRAFT_LOGO_STATIC : &str = "https://getartcraft.com/discord-status-icons/artcraft-a-512x512.png"; +const DISCORD_KITSUNE_MASK_LOGO : &str = "https://getartcraft.com/discord-status-icons/kitsune-mask-512x512.png"; +const DISCORD_LINK_SPIN: &str = "https://getartcraft.com/discord-status-icons/link-spin-200x216.webp"; + +pub async fn discord_presence_thread() -> ! { + loop { + let client = DiscordIpcClient::new(DISCORD_APP_ID); + let _err = discord_main_loop(client).await; + tokio::time::sleep(std::time::Duration::from_millis(10_000)).await; + } +} + +async fn discord_main_loop(mut client: DiscordIpcClient) -> AnyhowResult<()> { + info!("(Re)-connecting Discord IPC client..."); + + client.connect() + .map_err(|err| anyhow!("Error connecting to Discord IPC: {:?}", err))?; + + loop { + debug!("Notifying discord presence API..."); + + let discord_logo_image = get_random_discord_icon(); + + let assets = discord_rich_presence::activity::Assets::new() + .large_image(discord_logo_image) + .large_text("ArtCraftX.ai"); + //.small_image("https://storyteller.ai/android-chrome-192x192.png") + //.small_text("small text"); + + client.set_activity(discord_rich_presence::activity::Activity::new() + //.state("Anyone can make arts!") + .state("ArtCraftX.ai") + .details("Making Art | ArtCraftX") + .activity_type(discord_rich_presence::activity::ActivityType::Playing) + .assets(assets)) + .map_err(|err| anyhow!("Error setting Discord activity: {:?}", err))?; + + tokio::time::sleep(std::time::Duration::from_millis(60_000)).await; + } +} + +fn get_random_discord_icon() -> &'static str { + let value = random_range(0..10u8); + if value < 6 { + DISCORD_ARTCRAFT_LOGO_SPIN + } else if value < 7 { + DISCORD_ARTCRAFT_LOGO_STATIC + } else if value < 8 { + DISCORD_KITSUNE_MASK_LOGO + } else { + DISCORD_LINK_SPIN + } +} diff --git a/crates/artcraftx/src/threads/main_window_thread/main_window_thread.rs b/crates/artcraftx/src/threads/main_window_thread/main_window_thread.rs new file mode 100644 index 00000000..afc24a19 --- /dev/null +++ b/crates/artcraftx/src/threads/main_window_thread/main_window_thread.rs @@ -0,0 +1,80 @@ +use crate::state::runtime::app_startup_time::AppStartupTime; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::window::main_window_position::MainWindowPosition; +use crate::state::window::main_window_size::MainWindowSize; +use crate::threads::main_window_thread::persist_window_position_task::persist_window_position_task; +use crate::threads::main_window_thread::persist_window_resize_task::persist_window_resize_task; +use crate::windows::main_window::constants::MAIN_WINDOW_NAME; +use errors::AnyhowResult; +use log::{error, info, warn}; +use memory_store::clone_slot::CloneSlot; +use tauri::{AppHandle, Manager, Window}; + +pub async fn main_window_thread( + app: AppHandle, + app_data_root: AppDataRoot, +) -> ! { + // TODO: Move these into some kind of dependency injection framework + let window_size_slot: CloneSlot = CloneSlot::empty(); + let window_pos_slot: CloneSlot = CloneSlot::empty(); + let _app_startup_time = AppStartupTime::new(); + + // Emit debugging information to the logs (do not remove this!) + info!("git commit id: {:?}", build_metadata::git_commit_id() + .unwrap_or_else(|| "unknown")); + info!("git commit timestamp: {:?}", build_metadata::git_commit_timestamp() + .map(|t| t.to_string()) + .unwrap_or_else(|| "unknown".to_string())); + info!("build timestamp: {:?}", build_metadata::build_timestamp() + .to_string()); + + // debug_try_clear_all_webview_data(&app); + + loop { + for (window_name, window) in app.windows() { + if window_name == MAIN_WINDOW_NAME { + let result = handle_main_window( + &window, + &app_data_root, + &window_size_slot, + &window_pos_slot, + ).await; + if let Err(err) = result { + error!("Error handling main window: {:?}", err); + } + } + } + tokio::time::sleep(std::time::Duration::from_millis(1_000)).await; + } +} + +pub async fn handle_main_window( + window: &Window, + app_data_root: &AppDataRoot, + window_size_slot: &CloneSlot, + window_pos_slot: &CloneSlot, +) -> AnyhowResult<()> { + loop { + log_errors(persist_window_resize_task(window, app_data_root, window_size_slot).await); + log_errors(persist_window_position_task(window, app_data_root, window_pos_slot).await); + tokio::time::sleep(std::time::Duration::from_millis(1_000)).await; + } +} + +pub fn log_errors(result: AnyhowResult) { + if let Err(err) = result { + error!("Error persisting window size: {:?}", err); + } +} + +fn debug_try_clear_all_webview_data(app: &AppHandle) { + warn!("[!!!] THIS IS ONLY FOR DEBUGGING PURPOSES: Attempting to clear webview data..."); + + for (name, webview) in app.webviews() { + if let Err(err) = webview.clear_all_browsing_data() { + error!("Failed to clear cookies for '{}' window webview: {:?}", name, err); + } else { + warn!("Successfully cleared cookies for '{}' window webview", name); + } + } +} diff --git a/crates/artcraftx/src/threads/main_window_thread/mod.rs b/crates/artcraftx/src/threads/main_window_thread/mod.rs new file mode 100644 index 00000000..894f1579 --- /dev/null +++ b/crates/artcraftx/src/threads/main_window_thread/mod.rs @@ -0,0 +1,3 @@ +pub mod main_window_thread; +pub mod persist_window_position_task; +pub mod persist_window_resize_task; \ No newline at end of file diff --git a/crates/artcraftx/src/threads/main_window_thread/persist_window_position_task.rs b/crates/artcraftx/src/threads/main_window_thread/persist_window_position_task.rs new file mode 100644 index 00000000..24c5340a --- /dev/null +++ b/crates/artcraftx/src/threads/main_window_thread/persist_window_position_task.rs @@ -0,0 +1,32 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::window::main_window_position::MainWindowPosition; +use errors::AnyhowResult; +use log::info; +use memory_store::clone_slot::CloneSlot; +use tauri::Window; + +pub async fn persist_window_position_task( + window: &Window, + app_data_root: &AppDataRoot, + window_pos_slot: &CloneSlot, +) -> AnyhowResult<()> { + + let current_window_position = MainWindowPosition::from_window(window)?; + let current_physical_pos = window.outer_position()?; + + let mut save_size_to_disk = true; + + if let Ok(Some(old_size)) = window_pos_slot.get_clone() { + if old_size.matches_physical_position(¤t_physical_pos) { + save_size_to_disk = false; + } + } + + if save_size_to_disk { + info!("Saving window position configs to disk..."); + current_window_position.persist_to_filesystem(app_data_root)?; + window_pos_slot.set_clone(¤t_window_position)?; + } + + Ok(()) +} diff --git a/crates/artcraftx/src/threads/main_window_thread/persist_window_resize_task.rs b/crates/artcraftx/src/threads/main_window_thread/persist_window_resize_task.rs new file mode 100644 index 00000000..74547a89 --- /dev/null +++ b/crates/artcraftx/src/threads/main_window_thread/persist_window_resize_task.rs @@ -0,0 +1,37 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::window::main_window_size::MainWindowSize; +use crate::utils::window::get_window_size_heuristic::get_window_size_heuristic; +use errors::AnyhowResult; +use log::info; +use memory_store::clone_slot::CloneSlot; +use tauri::Window; + +pub async fn persist_window_resize_task( + window: &Window, + app_data_root: &AppDataRoot, + window_size_slot: &CloneSlot, +) -> AnyhowResult<()> { + + let current_window_size = MainWindowSize::from_window(window)?; + let current_physical_size = get_window_size_heuristic(window)?; + + let mut save_size_to_disk = true; + + if let Ok(Some(old_size)) = window_size_slot.get_clone() { + if old_size.matches_physical_size(¤t_physical_size) { + save_size_to_disk = false; + } + } + + if current_window_size.is_not_big_enough() { + save_size_to_disk = false; + } + + if save_size_to_disk { + info!("Saving window size configs to disk..."); + current_window_size.persist_to_filesystem(app_data_root)?; + window_size_slot.set_clone(¤t_window_size)?; + } + + Ok(()) +} diff --git a/crates/artcraftx/src/threads/mod.rs b/crates/artcraftx/src/threads/mod.rs new file mode 100644 index 00000000..b22fb82a --- /dev/null +++ b/crates/artcraftx/src/threads/mod.rs @@ -0,0 +1,5 @@ +pub mod discord_presence_thread; +pub mod main_window_thread; +pub mod task_completion; +pub mod third_party_task_polling_thread; +pub mod thumbnail_worker_thread; diff --git a/crates/artcraftx/src/threads/task_completion/complete_task_with_local_files.rs b/crates/artcraftx/src/threads/task_completion/complete_task_with_local_files.rs new file mode 100644 index 00000000..fa0fb874 --- /dev/null +++ b/crates/artcraftx/src/threads/task_completion/complete_task_with_local_files.rs @@ -0,0 +1,164 @@ +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::state::database::task_database::TaskDatabase; +use crate::state::thumbnails::thumbnail_work_queue::ThumbnailWorkQueue; +use crate::threads::task_completion::save_results_to_download_dir::save_results_to_download_dir; +use crate::threads::task_completion::upload_results_to_artcraft::{upload_results_to_artcraft, CompletionPrompt}; +use crate::threads::third_party_task_polling_thread::events::notify_frontend_of_completion::{ + notify_frontend_of_completion, notify_generation_complete, CompletionData, +}; +use crate::utils::download::record_task_download_locations::record_task_download_locations; +use anyhow::bail; +use crate::services::backup::backup_target::resolve_backup_target; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::info; +use sqlite_database::queries::task::Task; +use sqlite_database::queries::update::update_successful_task_status_with_metadata::{ + update_successful_task_status_with_metadata, UpdateSuccessfulTaskArgs, +}; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use std::path::PathBuf; +use tauri::{AppHandle, Manager}; + +pub struct CompleteTaskArgs<'a> { + pub app_handle: &'a AppHandle, + pub app_data_root: &'a AppDataRoot, + pub app_preferences: &'a AppPreferencesManager, + pub task_database: &'a TaskDatabase, + + pub task: &'a Task, + + /// Provider recorded on the uploaded media files. + pub generation_provider: GenerationSource, + + /// What kind of files these are (picks the upload endpoint and is stored on + /// the task). + pub media_class: TaskMediaFileClass, + + /// How to associate the uploads with a Storyteller prompt record. + pub prompt: CompletionPrompt, + + /// Used in download filenames when the task has no model type recorded. + pub fallback_model_slug: &'a str, + + /// The result files, already fetched to local disk (normally the temp + /// directory), in generation order. The first is the primary file. + pub local_files: &'a [PathBuf], +} + +/// Deliver a finished generation: +/// +/// 1. save every file to the user's download directory (fail open per file), +/// 2. back up to the user's chosen ArtCraft account, when backups are on +/// (Settings → Account Backup; see `services::backup`), +/// 3. mark the task complete (a no-op if another path already did — the +/// Midjourney websocket and long-poller can race), +/// 4. record where the files landed on the task and hand them to the +/// thumbnail worker, +/// 5. notify the frontend. +/// +/// Returns `Ok(true)` if this call completed the task, `Ok(false)` if it was +/// already complete. Errors leave the task pending so the poller retries. +pub async fn complete_task_with_local_files(args: CompleteTaskArgs<'_>) -> AnyhowResult { + let CompleteTaskArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + task, + generation_provider, + media_class, + prompt, + fallback_model_slug, + local_files, + } = args; + + let task_id = task.id.as_str(); + + if local_files.is_empty() { + bail!("Task {} completed with no result files", task_id); + } + + info!("[TaskCompletion] Delivering {} file(s) for task {} ({:?})", local_files.len(), task_id, generation_provider); + + let downloaded = save_results_to_download_dir( + app_data_root, + app_preferences, + task, + fallback_model_slug, + local_files, + ); + + // The upload ledger lets a re-delivered file reuse its earlier upload. + let maybe_ledger = app_handle.try_state::() + .map(|database| AssetUploadLedger::new(database.inner().clone())); + + // The same rail for every third-party service: results go to the backup + // account the user picked, or stay local when backups are off. + let maybe_backup = resolve_backup_target(app_data_root, app_preferences); + + let maybe_uploaded = match &maybe_backup { + Some(backup) => { + info!("[TaskCompletion] Backing up task {} to ArtCraft account {}", task_id, backup.credential_id); + let uploaded = upload_results_to_artcraft( + &backup.api_host, + &backup.creds, + task, + generation_provider, + media_class, + prompt, + local_files, + maybe_ledger.as_ref(), + ).await?; + Some(uploaded) + } + None => { + info!("[TaskCompletion] Backups are off or unconfigured; completing task {} locally only", task_id); + None + } + }; + + let maybe_cdn_url_str = maybe_uploaded.as_ref() + .and_then(|uploaded| uploaded.maybe_cdn_url.as_ref()) + .map(|url| url.to_string()); + + let updated = update_successful_task_status_with_metadata(UpdateSuccessfulTaskArgs { + db: task_database.get_connection(), + task_id: &task.id, + maybe_batch_token: maybe_uploaded.as_ref().and_then(|uploaded| uploaded.maybe_batch_token.as_ref()), + maybe_primary_media_file_token: maybe_uploaded.as_ref().map(|uploaded| &uploaded.primary_media_file_token), + maybe_primary_media_file_class: Some(media_class), + maybe_primary_media_file_cdn_url: maybe_cdn_url_str.as_deref(), + maybe_primary_media_file_thumbnail_url_template: maybe_uploaded.as_ref() + .and_then(|uploaded| uploaded.maybe_thumbnail_url_template.as_deref()), + }).await?; + + if !updated { + info!("[TaskCompletion] Task {} was already completed elsewhere; not notifying again", task_id); + return Ok(false); + } + + record_task_download_locations(task_database, &task.id, &downloaded).await; + ThumbnailWorkQueue::enqueue_for_app(app_handle, &downloaded); + + match maybe_uploaded { + Some(uploaded) => { + let completion = CompletionData { + primary_media_file_token: uploaded.primary_media_file_token, + maybe_cdn_url: uploaded.maybe_cdn_url, + maybe_thumbnail_url_template: uploaded.maybe_thumbnail_url_template, + maybe_batch_token: uploaded.maybe_batch_token, + media_class, + }; + let backup = maybe_backup.as_ref().expect("uploaded only with a backup target"); + notify_frontend_of_completion(app_handle, &backup.api_host, Some(&backup.creds), task, &completion).await; + } + None => notify_generation_complete(app_handle, task), + } + + info!("[TaskCompletion] Task {} fully handled", task_id); + Ok(true) +} diff --git a/crates/artcraftx/src/threads/task_completion/mod.rs b/crates/artcraftx/src/threads/task_completion/mod.rs new file mode 100644 index 00000000..3c014cef --- /dev/null +++ b/crates/artcraftx/src/threads/task_completion/mod.rs @@ -0,0 +1,14 @@ +//! The single place a finished generation is delivered, no matter which +//! provider produced it. +//! +//! Every poller (Storyteller aside — its files already live on the server) +//! only has to fetch the provider's result files into the temp directory and +//! call [`complete_task_with_local_files`]; saving to the user's download +//! directory, uploading to ArtCraft, marking the task complete, recording +//! where the files landed, and notifying the frontend all happen here. +//! +//! [`complete_task_with_local_files`]: complete_task_with_local_files::complete_task_with_local_files + +pub mod complete_task_with_local_files; +pub mod save_results_to_download_dir; +pub mod upload_results_to_artcraft; diff --git a/crates/artcraftx/src/threads/task_completion/save_results_to_download_dir.rs b/crates/artcraftx/src/threads/task_completion/save_results_to_download_dir.rs new file mode 100644 index 00000000..197e6712 --- /dev/null +++ b/crates/artcraftx/src/threads/task_completion/save_results_to_download_dir.rs @@ -0,0 +1,69 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::app_preferences::settings::preferred_download_filename::{model_slug_from_model_type_str, DownloadFilenameParts}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::download::save_local_file_to_download_dir::save_local_file_to_download_dir; +use chrono::Local; +use log::{error, info}; +use sqlite_database::queries::task::Task; +use std::path::PathBuf; + +/// Extension used when a result file has none. +const DEFAULT_EXTENSION: &str = "bin"; + +/// Copy every result file into the user's download directory, named per their +/// filename convention. Fails open per file — a copy failure must never block +/// completing the task. Returns the saved paths, in input order. +pub fn save_results_to_download_dir( + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task: &Task, + fallback_model_slug: &str, + local_files: &[PathBuf], +) -> Vec { + let task_id = task.id.as_str(); + let mut saved = Vec::with_capacity(local_files.len()); + + let app_prefs = match app_preferences.get() { + Ok(prefs) => prefs, + Err(err) => { + error!("[TaskCompletion] Can't read app preferences; not saving downloads for task {}: {:?}", task_id, err); + return saved; + } + }; + + let model_slug = task.model_type + .as_ref() + .map(|model_type| model_slug_from_model_type_str(model_type.to_str())) + .unwrap_or_else(|| fallback_model_slug.to_string()); + + let download_time = Local::now(); + let is_batch = local_files.len() > 1; + + for (index, local_file) in local_files.iter().enumerate() { + let extension = local_file.extension() + .and_then(|ext| ext.to_str()) + .unwrap_or(DEFAULT_EXTENSION); + + let filename = app_prefs.downloads.preferred_download_filename.build_filename(&DownloadFilenameParts { + model_slug: &model_slug, + download_time, + maybe_batch_index: is_batch.then(|| index + 1), + extension, + }); + + match save_local_file_to_download_dir(local_file, &filename, app_data_root, &app_prefs) { + Ok(path) => { + info!("[TaskCompletion] Saved task {} result to {:?}", task_id, path); + saved.push(path); + } + Err(ArtcraftXError::CannotDownloadFilePathAlreadyExists { path }) => { + info!("[TaskCompletion] Task {} result already saved: {:?}", task_id, path); + saved.push(path); + } + Err(err) => error!("[TaskCompletion] Failed to save task {} result {:?}: {:?}", task_id, local_file, err), + } + } + + saved +} diff --git a/crates/artcraftx/src/threads/task_completion/upload_results_to_artcraft.rs b/crates/artcraftx/src/threads/task_completion/upload_results_to_artcraft.rs new file mode 100644 index 00000000..7bd975d2 --- /dev/null +++ b/crates/artcraftx/src/threads/task_completion/upload_results_to_artcraft.rs @@ -0,0 +1,270 @@ +use artcraft_client::api_defs::prompts::create_prompt::CreatePromptRequest; +use artcraft_client::api_defs::utils::media_links_to_thumbnail_template::media_links_to_thumbnail_template; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::endpoints::media_files::get_media_file::get_media_file; +use artcraft_client::endpoints::media_files::legacy_upload_media_file_from_file::{ + legacy_upload_media_file_from_file, LegacyUploadMediaFileFromFileArgs, +}; +use artcraft_client::endpoints::media_files::upload_image_media_file_from_file::{ + upload_image_media_file_from_file, UploadImageFromFileArgs, +}; +use artcraft_client::endpoints::media_files::upload_video_media_file_from_file::{ + upload_video_media_file_from_file, UploadVideoFromFileArgs, +}; +use artcraft_client::endpoints::prompts::create_prompt::create_prompt; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use artcraft_client::error::api_error::ApiError; +use artcraft_client::error::storyteller_error::StorytellerError; +use artcraft_client::utils::api_host::ApiHost; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use log::{error, info, warn}; +use reqwest::Url; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use std::path::{Path, PathBuf}; +use std::time::Duration; +use uuid_utils::uuid::generate_random_uuid; +use crate::services::asset_uploads::asset_upload_ledger::AssetUploadLedger; +use crate::utils::enum_conversion::artcraft_api_generation_provider::artcraft_api_generation_provider; + +const MAX_UPLOAD_RETRIES: u32 = 5; +const INITIAL_RETRY_DELAY_SECS: u64 = 10; +const MAX_RETRY_DELAY_SECS: u64 = 60; + +/// How the uploads get associated with a Storyteller prompt record. +pub enum CompletionPrompt { + /// Reuse a prompt created at enqueue time (eg. the task's `prompt_token`). + Existing(PromptToken), + + /// Create the prompt now from what the provider reported. + Create { + model_type: CommonModelType, + maybe_prompt: Option, + }, + + /// Don't associate a prompt. + None, +} + +/// What came back from uploading a task's results. +pub struct UploadedResults { + /// The first uploaded file. + pub primary_media_file_token: MediaFileToken, + + /// Set when more than one file was uploaded. + pub maybe_batch_token: Option, + + pub maybe_cdn_url: Option, + pub maybe_thumbnail_url_template: Option, +} + +/// Upload every result file to ArtCraft (in order; the first becomes the +/// primary), retrying on rate limits, then look up the primary file's CDN and +/// thumbnail URLs (failing open). With a ledger, a file this account already +/// uploaded (and ArtCraft still has) is reused by token instead. +pub async fn upload_results_to_artcraft( + api_host: &ApiHost, + creds: &StorytellerCredentialSet, + task: &Task, + generation_provider: GenerationSource, + media_class: TaskMediaFileClass, + prompt: CompletionPrompt, + local_files: &[PathBuf], + maybe_ledger: Option<&AssetUploadLedger>, +) -> AnyhowResult { + let task_id = task.id.as_str(); + let maybe_upload_cache = maybe_ledger.and_then(|ledger| ledger.for_artcraft_session(Some(creds))); + + let maybe_prompt_token = resolve_prompt_token(api_host, creds, task, generation_provider, prompt).await; + + // TODO: Move this from clientside to the backend. + // The first upload should produce a batch token that we can reuse. + let maybe_batch_token = (local_files.len() > 1).then(BatchGenerationToken::generate); + + let mut maybe_primary_media_file_token: Option = None; + + for (index, local_file) in local_files.iter().enumerate() { + info!("[TaskCompletion] Uploading result {} of {} for task {} ...", index + 1, local_files.len(), task_id); + + let upload = || upload_with_retry( + api_host, + creds, + local_file, + generation_provider, + media_class, + maybe_prompt_token.as_ref(), + maybe_batch_token.as_ref(), + ); + let media_token = match &maybe_upload_cache { + Some(cache) => cache.artcraft_token_for_file(api_host, local_file, upload).await?, + None => upload().await?, + }; + + info!("[TaskCompletion] Uploaded task {} result as {:?}", task_id, media_token); + + if maybe_primary_media_file_token.is_none() { + maybe_primary_media_file_token = Some(media_token); + } + } + + let Some(primary_media_file_token) = maybe_primary_media_file_token else { + anyhow::bail!("No files were uploaded for task {}", task_id); + }; + + let mut maybe_cdn_url = None; + let mut maybe_thumbnail_url_template = None; + + match get_media_file(api_host, &primary_media_file_token).await { + Ok(response) => { + maybe_cdn_url = Some(response.media_file.media_links.cdn_url.clone()); + maybe_thumbnail_url_template = media_links_to_thumbnail_template(&response.media_file.media_links) + .map(|s| s.to_string()); + } + Err(err) => { + error!("[TaskCompletion] Failed to look up media file after upload: {:?} (failing open)", err); + } + } + + Ok(UploadedResults { + primary_media_file_token, + maybe_batch_token, + maybe_cdn_url, + maybe_thumbnail_url_template, + }) +} + +// ── Helpers ── + +/// Turn the caller's prompt instruction into a token. Creating a prompt fails +/// open: the uploads are still worth keeping without one. +async fn resolve_prompt_token( + api_host: &ApiHost, + creds: &StorytellerCredentialSet, + task: &Task, + generation_provider: GenerationSource, + prompt: CompletionPrompt, +) -> Option { + let task_id = task.id.as_str(); + + match prompt { + CompletionPrompt::Existing(token) => { + info!("[TaskCompletion] Using prompt {:?} from task {}", token, task_id); + Some(token) + } + CompletionPrompt::None => { + warn!("[TaskCompletion] Task {} has no prompt; uploading without prompt association", task_id); + None + } + CompletionPrompt::Create { model_type, maybe_prompt } => { + // Only providers the API's enum knows; others (Higgsfield) go unspecified + // rather than failing the request with `unknown variant`. + let request = CreatePromptRequest { + uuid_idempotency_token: generate_random_uuid(), + positive_prompt: maybe_prompt, + negative_prompt: None, + model_type: Some(model_type), + generation_provider: artcraft_api_generation_provider(generation_provider), + maybe_generation_mode: None, + maybe_aspect_ratio: None, + maybe_resolution: None, + maybe_batch_count: None, + maybe_generate_audio: None, + maybe_duration_seconds: None, + }; + + match create_prompt(api_host, Some(creds), request).await { + Ok(response) => { + info!("[TaskCompletion] Created prompt {:?} for task {}", response.prompt_token, task_id); + Some(response.prompt_token) + } + Err(err) => { + error!("[TaskCompletion] Failed to create prompt for task {}: {:?} (uploading without one)", task_id, err); + None + } + } + } + } +} + +async fn upload_with_retry( + api_host: &ApiHost, + creds: &StorytellerCredentialSet, + path: &Path, + generation_provider: GenerationSource, + media_class: TaskMediaFileClass, + maybe_prompt_token: Option<&PromptToken>, + maybe_batch_token: Option<&BatchGenerationToken>, +) -> AnyhowResult { + let mut retry_delay_secs = INITIAL_RETRY_DELAY_SECS; + + for attempt in 1..=MAX_UPLOAD_RETRIES { + let result = try_upload(api_host, creds, path, generation_provider, media_class, maybe_prompt_token, maybe_batch_token).await; + + match result { + Ok(token) => return Ok(token), + Err(StorytellerError::Api(ApiError::TooManyRequests(_))) if attempt < MAX_UPLOAD_RETRIES => { + warn!( + "[TaskCompletion] Upload rate-limited (429), retrying in {}s (attempt {}/{})", + retry_delay_secs, attempt, MAX_UPLOAD_RETRIES, + ); + tokio::time::sleep(Duration::from_secs(retry_delay_secs)).await; + retry_delay_secs = (retry_delay_secs * 2).min(MAX_RETRY_DELAY_SECS); + } + Err(err) => return Err(err.into()), + } + } + + unreachable!("loop returns on the final attempt") +} + +async fn try_upload( + api_host: &ApiHost, + creds: &StorytellerCredentialSet, + path: &Path, + generation_provider: GenerationSource, + media_class: TaskMediaFileClass, + maybe_prompt_token: Option<&PromptToken>, + maybe_batch_token: Option<&BatchGenerationToken>, +) -> Result { + // See `resolve_prompt_token`: providers the API doesn't know go unspecified. + let maybe_generation_provider = artcraft_api_generation_provider(generation_provider); + let media_token = match media_class { + TaskMediaFileClass::Video => { + let result = upload_video_media_file_from_file(UploadVideoFromFileArgs { + api_host, + maybe_creds: Some(creds), + path, + maybe_prompt_token, + maybe_generation_provider, + }).await?; + result.media_file_token + } + TaskMediaFileClass::Splat | TaskMediaFileClass::Mesh => { + let result = legacy_upload_media_file_from_file(LegacyUploadMediaFileFromFileArgs { + api_host, + maybe_creds: Some(creds), + path, + maybe_generation_provider, + }).await?; + result.media_file_token + } + _ => { + let result = upload_image_media_file_from_file(UploadImageFromFileArgs { + api_host, + maybe_creds: Some(creds), + path, + is_intermediate_system_file: false, + maybe_prompt_token, + maybe_batch_token, + maybe_generation_provider, + }).await?; + result.media_file_token + } + }; + + Ok(media_token) +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/events/mod.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/events/mod.rs new file mode 100644 index 00000000..911c8e71 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/events/mod.rs @@ -0,0 +1 @@ +pub mod notify_frontend_of_completion; diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/events/notify_frontend_of_completion.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/events/notify_frontend_of_completion.rs new file mode 100644 index 00000000..909beae5 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/events/notify_frontend_of_completion.rs @@ -0,0 +1,310 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::common::{GenerationAction, GenerationModel}; +use crate::events::generation_events::generation_complete_event::GenerationCompleteEvent; +use crate::events::functional_events::gaussian_generation_complete_event::{GaussianGenerationCompleteEvent, GeneratedGaussian}; +use crate::events::functional_events::object_generation_complete_event::{GeneratedObject, ObjectGenerationCompleteEvent}; +use crate::events::functional_events::text_to_image_generation_complete_event::{GeneratedImage, TextToImageGenerationCompleteEvent}; +use crate::events::functional_events::video_generation_complete_event::{GeneratedVideo, VideoGenerationCompleteEvent}; +use artcraft_client::endpoints::media_files::list_batch_generated_redux_media_files::list_batch_generated_redux_media_files; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::utils::api_host::ApiHost; + +use crate::utils::enum_conversion::generation_source::to_generation_service_provider; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{error, warn}; +use sqlite_database::queries::task::Task; +use tauri::AppHandle; +use reqwest::Url; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +/// Data about a successfully completed third-party generation. +pub struct CompletionData { + /// The primary media file token (first uploaded file). + pub primary_media_file_token: MediaFileToken, + + /// The CDN URL for the primary media file, if looked up. + pub maybe_cdn_url: Option, + + /// A thumbnail URL template for the primary media file, if available. + pub maybe_thumbnail_url_template: Option, + + /// The batch token, if multiple files were generated. + pub maybe_batch_token: Option, + + /// The media class of the generated output. + pub media_class: TaskMediaFileClass, +} + +/// Notify the frontend that a third-party job has completed, sending the +/// appropriate typed event based on the task type. +/// +/// This is the cross-cutting equivalent of the Storyteller-specific +/// `maybe_handle_frontend_caller_notification` — it works for any provider. +pub async fn notify_frontend_of_completion( + app: &AppHandle, + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + task: &Task, + completion: &CompletionData, +) { + notify_generation_complete(app, task); + + // Fire the typed frontend notification (for the specific page/component that initiated the job). + let result = match task.task_type { + TaskType::ImageGeneration => { + notify_image_generation(app, api_host, maybe_creds, task, completion).await + } + TaskType::VideoGeneration => { + notify_video_generation(app, task, completion) + } + TaskType::AudioGeneration => { + // No typed audio notification yet; the generic GenerationCompleteEvent + // above already fired. + Ok(()) + } + TaskType::MeshGeneration => { + notify_object_generation(app, task, completion) + } + TaskType::SplatGeneration => { + notify_gaussian_generation(app, task, completion) + } + }; + + if let Err(err) = result { + error!("[ThirdPartyEvents] Failed to send frontend notification for task {}: {:?}", task.id.as_str(), err); + } +} + +/// Fire the generic generation-complete event (for the task queue UI). Use +/// this alone when a task completed without anything uploaded to ArtCraft. +pub fn notify_generation_complete(app: &AppHandle, task: &Task) { + let generation_action = task_type_to_generation_action(task.task_type); + let generation_model = task.model_type.and_then(task_model_type_to_generation_model); + let generation_service = to_generation_service_provider(task.provider); + + let complete_event = GenerationCompleteEvent { + action: Some(generation_action), + service: generation_service, + model: generation_model, + }; + complete_event.send_infallible(app); +} + +// ── Per-type handlers ── + +async fn notify_image_generation( + app: &AppHandle, + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + task: &Task, + completion: &CompletionData, +) -> Result<(), Box> { + let generated_images = collect_generated_images( + api_host, + maybe_creds, + completion, + ).await; + + let event = TextToImageGenerationCompleteEvent { + generated_images, + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + + event.send_infallible(app); + Ok(()) +} + +fn notify_video_generation( + app: &AppHandle, + task: &Task, + completion: &CompletionData, +) -> Result<(), Box> { + let event = VideoGenerationCompleteEvent { + generated_videos: vec![GeneratedVideo { + media_token: completion.primary_media_file_token.clone(), + cdn_url: completion.maybe_cdn_url.clone().unwrap_or_else(|| Url::parse("https://cdn.artcraft.ai/placeholder").unwrap()), + maybe_thumbnail_template: completion.maybe_thumbnail_url_template.clone(), + }], + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + + event.send_infallible(app); + Ok(()) +} + +fn notify_object_generation( + app: &AppHandle, + task: &Task, + completion: &CompletionData, +) -> Result<(), Box> { + let event = ObjectGenerationCompleteEvent { + generated_objects: vec![GeneratedObject { + media_token: completion.primary_media_file_token.clone(), + cdn_url: completion.maybe_cdn_url.clone().unwrap_or_else(|| Url::parse("https://cdn.artcraft.ai/placeholder").unwrap()), + maybe_thumbnail_template: completion.maybe_thumbnail_url_template.clone(), + }], + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + + event.send_infallible(app); + Ok(()) +} + +fn notify_gaussian_generation( + app: &AppHandle, + task: &Task, + completion: &CompletionData, +) -> Result<(), Box> { + let event = GaussianGenerationCompleteEvent { + generated_gaussians: vec![GeneratedGaussian { + media_token: completion.primary_media_file_token.clone(), + cdn_url: completion.maybe_cdn_url.clone().unwrap_or_else(|| Url::parse("https://cdn.artcraft.ai/placeholder").unwrap()), + maybe_thumbnail_template: completion.maybe_thumbnail_url_template.clone(), + }], + maybe_frontend_subscriber_id: task.frontend_subscriber_id.clone(), + maybe_frontend_subscriber_payload: task.frontend_subscriber_payload.clone(), + }; + + event.send_infallible(app); + Ok(()) +} + + +// ── Helpers ── + +/// Collect generated images. If there's a batch token, fetch all files in the batch. +/// Otherwise, return a single-element list with the primary file. +async fn collect_generated_images( + api_host: &ApiHost, + maybe_creds: Option<&StorytellerCredentialSet>, + completion: &CompletionData, +) -> Vec { + // If we have a batch token, try to fetch all files in the batch. + if let Some(batch_token) = &completion.maybe_batch_token { + match list_batch_generated_redux_media_files(api_host, maybe_creds, batch_token).await { + Ok(result) if !result.media_files.is_empty() => { + return result.media_files.into_iter() + .map(|file| GeneratedImage { + media_token: file.token, + cdn_url: file.media_links.cdn_url, + maybe_thumbnail_template: file.media_links.maybe_thumbnail_template, + }) + .collect(); + } + Ok(_) => { + warn!("[ThirdPartyEvents] Batch token {} returned no media files, falling back to primary", batch_token); + } + Err(err) => { + error!("[ThirdPartyEvents] Failed to list batch media files: {:?}, falling back to primary", err); + } + } + } + + // Fallback: single image from primary token. + vec![GeneratedImage { + media_token: completion.primary_media_file_token.clone(), + cdn_url: completion.maybe_cdn_url.clone().unwrap_or_else(|| Url::parse("https://cdn.artcraft.ai/placeholder").unwrap()), + maybe_thumbnail_template: completion.maybe_thumbnail_url_template.clone(), + }] +} + +fn task_type_to_generation_action(task_type: TaskType) -> GenerationAction { + match task_type { + TaskType::ImageGeneration => GenerationAction::GenerateImage, + TaskType::VideoGeneration => GenerationAction::GenerateVideo, + TaskType::AudioGeneration => GenerationAction::GenerateAudio, + TaskType::MeshGeneration => GenerationAction::ImageTo3d, + TaskType::SplatGeneration => GenerationAction::GenerateGaussian, + } +} + +fn task_model_type_to_generation_model(model: TaskModelType) -> Option { + match model { + TaskModelType::Flux1Dev => Some(GenerationModel::Flux1Dev), + TaskModelType::Flux1Schnell => Some(GenerationModel::Flux1Schnell), + TaskModelType::FluxPro1 => Some(GenerationModel::FluxPro1), + TaskModelType::FluxPro11 => Some(GenerationModel::FluxPro11), + TaskModelType::FluxPro11Ultra => Some(GenerationModel::FluxPro11Ultra), + TaskModelType::FluxProKontextMax => Some(GenerationModel::FluxProKontextMax), + TaskModelType::FluxDevJuggernaut => Some(GenerationModel::FluxDevJuggernaut), + TaskModelType::Flux2LoraAngles => Some(GenerationModel::Flux2LoraAngles), + TaskModelType::GptImage1 => Some(GenerationModel::GptImage1), + TaskModelType::GptImage1p5 => Some(GenerationModel::GptImage1p5), + TaskModelType::GptImage2 => Some(GenerationModel::GptImage2), + TaskModelType::NanoBanana => Some(GenerationModel::NanoBanana), + TaskModelType::NanoBanana2 => Some(GenerationModel::NanoBanana2), + TaskModelType::NanoBanana2Lite => Some(GenerationModel::NanoBanana2Lite), + TaskModelType::NanoBananaPro => Some(GenerationModel::NanoBananaPro), + TaskModelType::Seedream4 => Some(GenerationModel::Seedream4), + TaskModelType::Seedream4p5 => Some(GenerationModel::Seedream4p5), + TaskModelType::Seedream5Lite => Some(GenerationModel::Seedream5Lite), + TaskModelType::Seedream5p0Pro => Some(GenerationModel::Seedream5p0Pro), + TaskModelType::Seedream5p0ProUltra => Some(GenerationModel::Seedream5p0ProUltra), + TaskModelType::QwenEdit2511Angles => Some(GenerationModel::QwenEdit2511Angles), + TaskModelType::GrokImage => Some(GenerationModel::GrokImage), + TaskModelType::Recraft3 => Some(GenerationModel::Recraft3), + TaskModelType::Midjourney7 => Some(GenerationModel::Midjourney7), + TaskModelType::Midjourney7Niji => Some(GenerationModel::Midjourney7Niji), + TaskModelType::Midjourney8 => Some(GenerationModel::Midjourney8), + TaskModelType::GrokVideo => Some(GenerationModel::GrokVideo), + TaskModelType::GrokImagineVideo1p5 => Some(GenerationModel::GrokImagineVideo1p5), + TaskModelType::Kling16Pro => Some(GenerationModel::Kling1_6), + TaskModelType::Kling21Pro => Some(GenerationModel::Kling21Pro), + TaskModelType::Kling21Master => Some(GenerationModel::Kling21Master), + TaskModelType::Kling2p5TurboPro => Some(GenerationModel::Kling2p5TurboPro), + TaskModelType::Kling2p6Pro => Some(GenerationModel::Kling2p6Pro), + TaskModelType::Kling3p0Standard => Some(GenerationModel::Kling3p0Standard), + TaskModelType::Kling3p0Pro => Some(GenerationModel::Kling3p0Pro), + TaskModelType::HappyHorse1p0 => Some(GenerationModel::HappyHorse1p0), + TaskModelType::Seedance10Lite => Some(GenerationModel::Seedance10Lite), + TaskModelType::Seedance1p5Pro => Some(GenerationModel::Seedance1p5Pro), + TaskModelType::Seedance2p0 => Some(GenerationModel::Seedance2p0), + TaskModelType::Seedance2p0Fast => Some(GenerationModel::Seedance2p0Fast), + TaskModelType::Seedance2p0Mini => Some(GenerationModel::Seedance2p0Mini), + TaskModelType::Seedance2p5 => Some(GenerationModel::Seedance2p5), + TaskModelType::Seedance2p5Edit => Some(GenerationModel::Seedance2p5Edit), + TaskModelType::MinimaxH3 => Some(GenerationModel::MinimaxH3), + TaskModelType::Sora2 => Some(GenerationModel::Sora2), + TaskModelType::Sora2Pro => Some(GenerationModel::Sora2Pro), + TaskModelType::Veo2 => Some(GenerationModel::Veo2), + TaskModelType::Veo3 => Some(GenerationModel::Veo3), + TaskModelType::Veo3Fast => Some(GenerationModel::Veo3Fast), + TaskModelType::Veo3p1 => Some(GenerationModel::Veo3p1), + TaskModelType::Veo3p1Fast => Some(GenerationModel::Veo3p1Fast), + TaskModelType::Veo3p1Lite => Some(GenerationModel::Veo3p1Lite), + TaskModelType::ViduQ3 => Some(GenerationModel::ViduQ3), + TaskModelType::ViduQ3Turbo => Some(GenerationModel::ViduQ3Turbo), + TaskModelType::Hunyuan3d2_0 => Some(GenerationModel::Hunyuan3d2_0), + TaskModelType::Hunyuan3d2_1 => Some(GenerationModel::Hunyuan3d2_1), + TaskModelType::Hunyuan3d3 => Some(GenerationModel::Hunyuan3d3), + TaskModelType::Hunyuan3d3Sketch => Some(GenerationModel::Hunyuan3d3Sketch), + TaskModelType::Hunyuan3d3p1Pro => Some(GenerationModel::Hunyuan3d3p1Pro), + TaskModelType::Hunyuan3d3p1Rapid => Some(GenerationModel::Hunyuan3d3p1Rapid), + TaskModelType::Hunyuan3d3p1Part => Some(GenerationModel::Hunyuan3d3p1Part), + TaskModelType::Hunyuan3d3p1SmartTopology => Some(GenerationModel::Hunyuan3d3p1SmartTopology), + TaskModelType::Tripo3dH3p1 => Some(GenerationModel::Tripo3dH3p1), + TaskModelType::MeshyV6 => Some(GenerationModel::MeshyV6), + TaskModelType::Rodin2p5Fast => Some(GenerationModel::Rodin2p5Fast), + TaskModelType::Marble1p0 => Some(GenerationModel::Marble1p0), + TaskModelType::Marble1p0Draft => Some(GenerationModel::Marble1p0Draft), + TaskModelType::Marble1p1 => Some(GenerationModel::Marble1p1), + TaskModelType::Marble1p1Plus => Some(GenerationModel::Marble1p1Plus), + TaskModelType::TripoSplat => Some(GenerationModel::TripoSplat), + TaskModelType::SunoMusic => Some(GenerationModel::SunoMusic), + TaskModelType::SunoRemix => Some(GenerationModel::SunoRemix), + TaskModelType::SunoSounds => Some(GenerationModel::SunoSounds), + TaskModelType::SunoSample => Some(GenerationModel::SunoSample), + TaskModelType::SeedAudio1p0 => Some(GenerationModel::SeedAudio1p0), + TaskModelType::Midjourney => Some(GenerationModel::Midjourney), + TaskModelType::Gemini25Flash => Some(GenerationModel::Gemini25Flash), + TaskModelType::WorldlabsMarble => Some(GenerationModel::WorldlabsMarble), + TaskModelType::WorldlabsMarble0p1Mini => Some(GenerationModel::WorldlabsMarble0p1Mini), + TaskModelType::WorldlabsMarble0p1Plus => Some(GenerationModel::WorldlabsMarble0p1Plus), + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/handle_fal_complete.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/handle_fal_complete.rs new file mode 100644 index 00000000..2483371b --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/handle_fal_complete.rs @@ -0,0 +1,152 @@ +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::data_dir::subdirectory::trait_data_subdir::DataSubdir; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::task_completion::complete_task_with_local_files::{complete_task_with_local_files, CompleteTaskArgs}; +use crate::threads::task_completion::upload_results_to_artcraft::CompletionPrompt; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use fal_client::polling::poll_job_response::poll_job_response::PollJobResponse; +use fal_client::polling::poll_job_response::success_case_extractors::PollResponseExtractedContents; +use log::{error, info, warn}; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use std::fs::File; +use std::io::Write; +use std::path::PathBuf; +use tauri::AppHandle; +use url_utils::download_extension::extract_download_extension_from_url::extract_download_extension_from_url_str; +use uuid_utils::uuid::generate_random_uuid; + +/// Download filename slug when the task has no model type recorded. +const FAL_FALLBACK_MODEL_SLUG: &str = "fal"; + +/// A FAL job finished: fetch its files, then hand them to the shared +/// completion routine. +pub async fn handle_fal_complete( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + task: &Task, + job_response: PollJobResponse, +) { + info!("[FalComplete] Handling completed task {}", task.id.as_str()); + + let result = handle_fal_complete_inner( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + task, + job_response, + ).await; + + if let Err(err) = result { + error!("[FalComplete] Failed to handle task {}: {:?}", task.id.as_str(), err); + } +} + +async fn handle_fal_complete_inner( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + // Uploads now go to the backup account (see `services::backup`), not the session. + _storyteller_creds_manager: &StorytellerCredentialManager, + task: &Task, + job_response: PollJobResponse, +) -> AnyhowResult<()> { + let (urls, media_class) = collect_media_urls(&job_response.extracted_contents); + + if urls.is_empty() { + warn!("[FalComplete] Task {} completed but no downloadable media found in response", task.id.as_str()); + return Ok(()); + } + + let mut local_files = Vec::with_capacity(urls.len()); + for (index, url) in urls.iter().enumerate() { + info!("[FalComplete] Downloading result {} from: {}", index, url); + local_files.push(download_file(url, app_data_root, index).await?); + } + + // The prompt was created at enqueue time. + let prompt = match task.prompt_token.as_deref() { + Some(token) => CompletionPrompt::Existing(PromptToken::new_from_str(token)), + None => CompletionPrompt::None, + }; + + + complete_task_with_local_files(CompleteTaskArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + task, + generation_provider: GenerationSource::Fal, + media_class, + prompt, + fallback_model_slug: FAL_FALLBACK_MODEL_SLUG, + local_files: &local_files, + }).await?; + + Ok(()) +} + +// ── Helpers ── + +/// Collect downloadable media URLs from the extracted response contents. +fn collect_media_urls(extracted: &Option) -> (Vec, TaskMediaFileClass) { + let Some(extracted) = extracted else { + return (vec![], TaskMediaFileClass::Image); + }; + + // Images (batch) + if let Some(images) = &extracted.images { + let urls: Vec = images.iter() + .filter_map(|img| img.url.clone()) + .collect(); + if !urls.is_empty() { + return (urls, TaskMediaFileClass::Image); + } + } + + // Single image (e.g. background removal) + if let Some(url) = extracted.image.as_ref().and_then(|image| image.url.clone()) { + return (vec![url], TaskMediaFileClass::Image); + } + + // Video + if let Some(url) = extracted.video.as_ref().and_then(|video| video.url.clone()) { + return (vec![url], TaskMediaFileClass::Video); + } + + // 3D model (GLB) + if let Some(url) = extracted.model_glb.as_ref().and_then(|glb| glb.url.clone()) { + return (vec![url], TaskMediaFileClass::Mesh); + } + + (vec![], TaskMediaFileClass::Image) +} + +async fn download_file(url: &str, app_data_root: &AppDataRoot, index: usize) -> AnyhowResult { + let response = reqwest::get(url).await?; + let bytes = response.bytes().await?; + + let extension = extract_download_extension_from_url_str(url) + .map(|ext| ext.as_extension_without_period()) + .unwrap_or("bin"); + + let tempdir = app_data_root.temp_dir().path(); + let filename = format!("fal_{}_{}.{}", generate_random_uuid(), index, extension); + let download_path = tempdir.join(filename); + + let mut file = File::create(&download_path)?; + file.write_all(&bytes)?; + + Ok(download_path) +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/handle_fal_failure.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/handle_fal_failure.rs new file mode 100644 index 00000000..0877dfc2 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/handle_fal_failure.rs @@ -0,0 +1,50 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::common::{GenerationAction, GenerationServiceProvider}; +use crate::events::generation_events::generation_failed_event::GenerationFailedEvent; +use crate::state::database::task_database::TaskDatabase; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{error, info}; +use sqlite_database::queries::task::Task; +use sqlite_database::queries::update::update_task_status::{update_task_status, UpdateTaskArgs}; +use tauri::AppHandle; + +pub async fn handle_fal_failure( + app_handle: &AppHandle, + task_database: &TaskDatabase, + task: &Task, + reason: &str, +) { + info!("[FalPolling] Marking task {} as failed: {}", task.id.as_str(), reason); + + let update_result = update_task_status(UpdateTaskArgs { + db: task_database.get_connection(), + task_id: &task.id, + status: TaskStatus::CompleteFailure, + }).await; + + if let Err(err) = update_result { + error!("[FalPolling] Failed to update task status for {}: {:?}", task.id.as_str(), err); + } + + let action = task_type_to_generation_action(task.task_type); + + let event = GenerationFailedEvent { + action, + service: GenerationServiceProvider::Fal, + model: None, + reason: Some(reason.to_string()), + }; + + event.send_infallible(app_handle); +} + +fn task_type_to_generation_action(task_type: TaskType) -> GenerationAction { + match task_type { + TaskType::ImageGeneration => GenerationAction::GenerateImage, + TaskType::VideoGeneration => GenerationAction::GenerateVideo, + TaskType::AudioGeneration => GenerationAction::GenerateAudio, + TaskType::MeshGeneration => GenerationAction::ImageTo3d, + TaskType::SplatGeneration => GenerationAction::GenerateGaussian, + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/mod.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/mod.rs new file mode 100644 index 00000000..95e45891 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/mod.rs @@ -0,0 +1,3 @@ +pub mod handle_fal_complete; +pub mod handle_fal_failure; +pub mod poll_fal_tasks; diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/poll_fal_tasks.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/poll_fal_tasks.rs new file mode 100644 index 00000000..f0e74412 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/fal/poll_fal_tasks.rs @@ -0,0 +1,173 @@ +use crate::credentials::find_service_credentials::find_fal_api_key; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::third_party_task_polling_thread::handlers::fal::handle_fal_complete::handle_fal_complete; +use crate::threads::third_party_task_polling_thread::handlers::fal::handle_fal_failure::handle_fal_failure; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use fal_client::creds::fal_api_key::FalApiKey; +use fal_client::polling::poll_job_response::poll_job_response::{poll_job_response, PollJobResponseArgs}; +use fal_client::polling::poll_job_status::poll_job_status::{poll_job_status, FalJobStatus, PollJobStatusArgs}; +use log::{error, info, warn}; +use sqlite_database::queries::task::Task; +use tauri::AppHandle; + +pub async fn poll_fal_tasks( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + fal_tasks: &[&Task], +) { + let api_key = match load_fal_api_key(app_data_root) { + Some(key) => key, + None => { + warn!("[FalPolling] No FAL API key configured, skipping poll"); + return; + } + }; + + for task in fal_tasks { + let result = poll_single_fal_task( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + &api_key, + task, + ).await; + + if let Err(err) = result { + error!( + "[FalPolling] Error processing task {}: {:?}", + task.id.as_str(), + err, + ); + } + } +} + +async fn poll_single_fal_task( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + api_key: &FalApiKey, + task: &Task, +) -> Result<(), Box> { + let status_url = match &task.queue_status_url { + Some(url) => url.as_str(), + None => { + warn!("[FalPolling] Task {} has no queue_status_url, marking as failed", task.id.as_str()); + handle_fal_failure( + app_handle, + task_database, + task, + "No queue status URL to check", + ).await; + return Ok(()); + } + }; + + // Step 1: Check job status + info!("[FalPolling] Checking status for task {}: {}", task.id.as_str(), status_url); + + let status_response = poll_job_status(PollJobStatusArgs { + status_url, + api_key, + }).await?; + + match status_response.status { + FalJobStatus::InQueue | FalJobStatus::InProgress => { + info!( + "[FalPolling] Task {} still {:?} (queue_position={:?})", + task.id.as_str(), + status_response.status, + status_response.maybe_queue_position, + ); + return Ok(()); + } + FalJobStatus::Unknown(ref status) => { + warn!("[FalPolling] Task {} has unknown status: {}", task.id.as_str(), status); + return Ok(()); + } + FalJobStatus::Completed => { + info!("[FalPolling] Task {} completed, fetching results...", task.id.as_str()); + } + } + + // Step 2: Fetch the response + let response_url = pick_response_url(task, &status_response.response_url); + + let response_url = match response_url { + Some(url) => url, + None => { + warn!("[FalPolling] Task {} completed but has no response URL, marking as failed", task.id.as_str()); + handle_fal_failure( + app_handle, + task_database, + task, + "Job completed but no response URL available", + ).await; + return Ok(()); + } + }; + + let job_response = match poll_job_response(PollJobResponseArgs { + response_url: &response_url, + api_key, + }).await { + Ok(response) => response, + Err(err) => { + error!( + "[FalPolling] Failed to fetch response for task {}: {}. Skipping for now.", + task.id.as_str(), + err, + ); + return Ok(()); + } + }; + + // Step 3: Handle completed job + handle_fal_complete( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + task, + job_response, + ).await; + + Ok(()) +} + +// ── Helpers ── + +fn load_fal_api_key(app_data_root: &AppDataRoot) -> Option { + find_fal_api_key(app_data_root).map(|key| FalApiKey::from_str(&key)) +} + +/// Use the task's stored response URL first; fall back to the one from the status poll. +/// Log if they differ. +fn pick_response_url(task: &Task, polled_response_url: &Option) -> Option { + match (&task.queue_response_url, polled_response_url) { + (Some(db_url), Some(polled_url)) => { + if db_url != polled_url { + warn!( + "[FalPolling] Task {} response URLs differ: db={}, polled={}. Using db URL.", + task.id.as_str(), + db_url, + polled_url, + ); + } + Some(db_url.clone()) + } + (Some(db_url), None) => Some(db_url.clone()), + (None, Some(polled_url)) => Some(polled_url.clone()), + (None, None) => None, + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/grok_image_collector.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/grok_image_collector.rs new file mode 100644 index 00000000..a96d9c6b --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/grok_image_collector.rs @@ -0,0 +1,82 @@ +use grok_consumer_client::endpoint_bindings::generate_image_websocket::grok_generate_image_websocket::CompletedImage; +use std::collections::HashMap; +use std::time::{Duration, Instant}; + +/// Images a Grok prompt has produced so far, keyed by request id. +/// +/// Grok's imagine websocket streams a prompt's images one at a time, so the +/// polling thread accumulates them here between iterations and decides when a +/// prompt is done (all expected images, or nothing more for a while). +#[derive(Default)] +pub struct GrokImageCollector { + pending: HashMap, +} + +pub struct PendingGrokImages { + pub images: Vec, + /// When the polling thread first saw the task pending. + pub first_seen: Instant, + /// When the most recent image arrived. + pub maybe_last_image_at: Option, +} + +impl GrokImageCollector { + pub fn new() -> Self { + Self::default() + } + + /// Start tracking a request id (no-op if already tracked). + pub fn track(&mut self, request_id: &str) { + self.pending.entry(request_id.to_string()).or_insert_with(|| PendingGrokImages { + images: Vec::new(), + first_seen: Instant::now(), + maybe_last_image_at: None, + }); + } + + /// Record a finished image for its request id (deduped by URL). Returns + /// whether the id was being tracked. + pub fn push_image(&mut self, image: CompletedImage) -> bool { + let Some(pending) = self.pending.get_mut(&image.request_id.0) else { + return false; + }; + if !pending.images.iter().any(|existing| existing.url == image.url) { + pending.images.push(image); + pending.maybe_last_image_at = Some(Instant::now()); + } + true + } + + pub fn get(&self, request_id: &str) -> Option<&PendingGrokImages> { + self.pending.get(request_id) + } + + pub fn remove(&mut self, request_id: &str) -> Option { + self.pending.remove(request_id) + } + + /// Drop everything not in `live_request_ids` (tasks that are no longer + /// pending, e.g. dismissed by the user). + pub fn retain_only(&mut self, live_request_ids: &[&str]) { + self.pending.retain(|id, _| live_request_ids.contains(&id.as_str())); + } +} + +impl PendingGrokImages { + /// Whether the prompt looks finished: every expected image arrived, or at + /// least one did and nothing more has come for `idle_timeout`. + pub fn is_complete(&self, expected_images: usize, idle_timeout: Duration) -> bool { + if self.images.len() >= expected_images { + return true; + } + match self.maybe_last_image_at { + Some(last) if !self.images.is_empty() => last.elapsed() >= idle_timeout, + _ => false, + } + } + + /// Whether nothing at all arrived within `timeout` of first seeing the task. + pub fn is_timed_out(&self, timeout: Duration) -> bool { + self.images.is_empty() && self.first_seen.elapsed() >= timeout + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/handle_grok_image_complete.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/handle_grok_image_complete.rs new file mode 100644 index 00000000..1eaf5cc5 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/handle_grok_image_complete.rs @@ -0,0 +1,92 @@ +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::task_completion::complete_task_with_local_files::{complete_task_with_local_files, CompleteTaskArgs}; +use crate::threads::task_completion::upload_results_to_artcraft::CompletionPrompt; +use crate::utils::download::download_url_to_temp_dir::download_url_to_temp_dir; +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use grok_consumer_client::endpoint_bindings::generate_image_websocket::grok_generate_image_websocket::CompletedImage; +use log::{error, info}; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use tauri::AppHandle; + +/// Download filename slug when the task has no model type recorded. +const GROK_IMAGE_FALLBACK_MODEL_SLUG: &str = "grok_imagine"; + +/// A Grok image task finished: fetch the images, then hand them to the shared +/// completion routine. +pub async fn handle_grok_image_complete( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + task: &Task, + images: &[CompletedImage], +) { + info!("[GrokComplete] Handling completed task {} ({} image(s))", task.id.as_str(), images.len()); + + let result = handle_grok_image_complete_inner( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + task, + images, + ).await; + + if let Err(err) = result { + error!("[GrokComplete] Failed to handle task {}: {:?}", task.id.as_str(), err); + } +} + +async fn handle_grok_image_complete_inner( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + // Uploads now go to the backup account (see `services::backup`), not the session. + _storyteller_creds_manager: &StorytellerCredentialManager, + task: &Task, + images: &[CompletedImage], +) -> AnyhowResult<()> { + // NB: `NamedTempFile`s delete themselves on drop, so keep them alive until + // the completion routine has copied and uploaded them. + let mut temp_files = Vec::with_capacity(images.len()); + for (index, image) in images.iter().enumerate() { + info!("[GrokComplete] Downloading image {} of {} for task {} ...", index + 1, images.len(), task.id.as_str()); + temp_files.push(download_url_to_temp_dir(&image.url, app_data_root).await?); + } + let local_files = temp_files.iter() + .map(|file| file.path().to_path_buf()) + .collect::>(); + + let maybe_prompt = images.iter() + .map(|image| image.user_prompt.trim()) + .find(|prompt| !prompt.is_empty()) + .map(|prompt| prompt.to_string()); + + + complete_task_with_local_files(CompleteTaskArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + task, + generation_provider: GenerationSource::Grok, + media_class: TaskMediaFileClass::Image, + prompt: CompletionPrompt::Create { + model_type: CommonModelType::GrokImagineImage, + maybe_prompt, + }, + fallback_model_slug: GROK_IMAGE_FALLBACK_MODEL_SLUG, + local_files: &local_files, + }).await?; + + Ok(()) +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/handle_grok_image_failure.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/handle_grok_image_failure.rs new file mode 100644 index 00000000..b4e7d71a --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/handle_grok_image_failure.rs @@ -0,0 +1,41 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::common::{GenerationAction, GenerationServiceProvider}; +use crate::events::generation_events::generation_failed_event::GenerationFailedEvent; +use crate::state::database::task_database::TaskDatabase; +use log::{error, info}; +use sqlite_database::queries::task::Task; +use sqlite_database::queries::update::update_task_status_with_rich_failure::{ + update_task_status_with_rich_failure, UpdateTaskWithRichFailureArgs, +}; +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use tauri::AppHandle; + +/// Mark a Grok image task failed and tell the frontend why. +pub async fn handle_grok_image_failure( + app_handle: &AppHandle, + task_database: &TaskDatabase, + task: &Task, + reason: &str, +) { + info!("[GrokPolling] Marking task {} as failed: {}", task.id.as_str(), reason); + + let update_result = update_task_status_with_rich_failure(UpdateTaskWithRichFailureArgs { + db: task_database.get_connection(), + task_id: &task.id, + status: TaskStatus::CompleteFailure, + maybe_failure_type: Some(TaskFailureType::GenerationFailed), + maybe_failure_message: Some(reason), + }).await; + + if let Err(err) = update_result { + error!("[GrokPolling] Failed to update task status for {}: {:?}", task.id.as_str(), err); + } + + GenerationFailedEvent { + action: GenerationAction::GenerateImage, + service: GenerationServiceProvider::Grok, + model: None, + reason: Some(reason.to_string()), + }.send_infallible(app_handle); +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/mod.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/mod.rs new file mode 100644 index 00000000..13280d15 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/mod.rs @@ -0,0 +1,4 @@ +pub mod grok_image_collector; +pub mod handle_grok_image_complete; +pub mod handle_grok_image_failure; +pub mod poll_grok_image_tasks; diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/poll_grok_image_tasks.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/poll_grok_image_tasks.rs new file mode 100644 index 00000000..4b84663e --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/grok/poll_grok_image_tasks.rs @@ -0,0 +1,136 @@ +use crate::services::grok::state::grok_websockets::GrokWebsockets; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::third_party_task_polling_thread::handlers::grok::grok_image_collector::GrokImageCollector; +use crate::threads::third_party_task_polling_thread::handlers::grok::handle_grok_image_complete::handle_grok_image_complete; +use crate::threads::third_party_task_polling_thread::handlers::grok::handle_grok_image_failure::handle_grok_image_failure; +use grok_consumer_client::endpoint_bindings::generate_image_websocket::grok_generate_image_websocket::{ + ImageWebsocketEvent, DEFAULT_IMAGE_COUNT, +}; +use log::{debug, error, info, warn}; +use sqlite_database::queries::task::Task; +use std::collections::HashMap; +use std::time::Duration; +use tauri::AppHandle; + +/// How long each iteration listens on each socket for new frames. +const SOCKET_POLL_BUDGET: Duration = Duration::from_secs(2); + +/// A prompt with at least one image but fewer than expected is treated as +/// done once nothing more arrives for this long. +const PARTIAL_RESULT_IDLE_TIMEOUT: Duration = Duration::from_secs(20); + +/// A prompt that produced nothing at all within this window is failed. +const NO_RESULT_TIMEOUT: Duration = Duration::from_secs(5 * 60); + +/// One polling pass over the pending Grok image tasks: read every account's +/// imagine websocket, route finished images / error frames to their tasks by +/// request id, and complete or fail tasks that are done. +pub async fn poll_grok_image_tasks( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + grok_websockets: &GrokWebsockets, + collector: &mut GrokImageCollector, + grok_tasks: &[&Task], +) { + // provider_job_id is the websocket request id the enqueue returned. + let tasks_by_request_id: HashMap<&str, &Task> = grok_tasks.iter() + .filter_map(|task| task.provider_job_id.as_deref().map(|id| (id, *task))) + .collect(); + + let live_request_ids: Vec<&str> = tasks_by_request_id.keys().copied().collect(); + collector.retain_only(&live_request_ids); + for request_id in &live_request_ids { + collector.track(request_id); + } + + let websockets = match grok_websockets.all() { + Ok(websockets) => websockets, + Err(err) => { + error!("[GrokPolling] Could not read Grok websockets: {:?}", err); + return; + } + }; + + if websockets.is_empty() { + // Pending tasks but no socket (e.g. app restarted): they can only time out. + debug!("[GrokPolling] {} pending Grok task(s) but no live websocket", grok_tasks.len()); + } + + // 1) Drain every socket and route events to tasks. + for (credential_id, websocket) in &websockets { + let events = match websocket.poll_events(SOCKET_POLL_BUDGET).await { + Ok(events) => events, + Err(err) => { + warn!("[GrokPolling] Websocket for credential {} failed ({}); reconnecting", credential_id.as_str(), err); + if let Err(err) = websocket.reconnect().await { + error!("[GrokPolling] Could not reconnect Grok websocket for credential {}: {}", credential_id.as_str(), err); + } + continue; + } + }; + + for event in events { + match event { + ImageWebsocketEvent::Completed(image) => { + let request_id = image.request_id.to_string(); + if collector.push_image(image) { + info!("[GrokPolling] Image arrived for request {}", request_id); + } else { + debug!("[GrokPolling] Ignoring image for untracked request {}", request_id); + } + } + ImageWebsocketEvent::Failed { request_id, message, err_code, raw_frame } => { + let reason = match (&message, &err_code) { + (Some(message), _) => format!("Grok rejected the prompt: {message}"), + (None, Some(code)) => format!("Grok rejected the prompt (code {code})"), + (None, None) => "Grok rejected the prompt".to_string(), + }; + warn!("[GrokPolling] Error frame (request {:?}): {}", request_id.as_ref().map(|id| id.to_string()), raw_frame); + + let Some(request_id) = request_id.map(|id| id.to_string()) else { + warn!("[GrokPolling] Error frame names no request id; can't attribute it to a task"); + continue; + }; + if let Some(task) = tasks_by_request_id.get(request_id.as_str()) { + collector.remove(&request_id); + handle_grok_image_failure(app_handle, task_database, task, &reason).await; + } + } + } + } + } + + // 2) Complete / fail tasks that are done. + for (request_id, task) in &tasks_by_request_id { + let Some(pending) = collector.get(request_id) else { + continue; // Just failed above. + }; + + if pending.is_complete(DEFAULT_IMAGE_COUNT, PARTIAL_RESULT_IDLE_TIMEOUT) { + let pending = collector.remove(request_id).expect("checked above"); + handle_grok_image_complete( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + task, + &pending.images, + ).await; + } else if pending.is_timed_out(NO_RESULT_TIMEOUT) { + collector.remove(request_id); + handle_grok_image_failure( + app_handle, + task_database, + task, + "Grok did not return any images in time", + ).await; + } + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/handle_higgsfield_complete.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/handle_higgsfield_complete.rs new file mode 100644 index 00000000..1c9488e6 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/handle_higgsfield_complete.rs @@ -0,0 +1,185 @@ +use artcraft_client::enums::common::generation::common_model_type::CommonModelType; +use core_types::enums::generation_source::GenerationSource; +use errors::AnyhowResult; +use higgsfield_client::endpoints::jobs::job_status::JobStatusResponse; +use log::{error, info, warn}; +use sqlite_database::queries::task::Task; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_type::TaskType; +use tauri::AppHandle; + +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::task_completion::complete_task_with_local_files::{complete_task_with_local_files, CompleteTaskArgs}; +use crate::threads::task_completion::upload_results_to_artcraft::CompletionPrompt; +use crate::services::asset_uploads::asset_upload_ledger::{AccountUploadCache, AssetUploadLedger}; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::utils::download::download_url_to_temp_dir::download_url_to_temp_dir; +use core_types::identifiers::credential_id::CredentialId; +use file_hashing::hash_file_blake3; +use router::api::asset_upload_cache::{AssetUploadCache, CachedAssetUpload}; +use std::path::Path; +use tauri::Manager; + +/// Download filename slug when the task has no model type recorded. +const HIGGSFIELD_FALLBACK_MODEL_SLUG: &str = "higgsfield"; + +/// A Higgsfield job set finished: fetch every finished job's file, then hand +/// them to the shared completion routine. +pub async fn handle_higgsfield_complete( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + credential_id: &str, + task: &Task, + jobs: &[JobStatusResponse], +) { + info!("[HiggsfieldComplete] Handling completed task {} ({} job(s))", task.id.as_str(), jobs.len()); + + let result = handle_higgsfield_complete_inner( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + credential_id, + task, + jobs, + ).await; + + if let Err(err) = result { + error!("[HiggsfieldComplete] Failed to handle task {}: {:?}", task.id.as_str(), err); + } +} + +async fn handle_higgsfield_complete_inner( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + // Uploads now go to the backup account (see `services::backup`), not the session. + _storyteller_creds_manager: &StorytellerCredentialManager, + credential_id: &str, + task: &Task, + jobs: &[JobStatusResponse], +) -> AnyhowResult<()> { + // Higgsfield already holds these files: remember each one under the + // account that generated it, so using the download as a reference later + // passes the job id instead of uploading (and IP-checking) it again. + let maybe_ledger = app_handle.try_state::() + .map(|database| AssetUploadLedger::new(database.inner().clone())) + .map(|ledger| ledger.for_higgsfield_credential(&CredentialId::from_trusted(credential_id))); + + // NB: `NamedTempFile`s delete themselves on drop, so keep them alive until + // the completion routine has copied and uploaded them. + let mut temp_files = Vec::with_capacity(jobs.len()); + for (index, job) in jobs.iter().enumerate() { + let url = job.result_url().expect("caller passes only jobs with a result URL"); + info!("[HiggsfieldComplete] Downloading result {} of {} for task {} ...", index + 1, jobs.len(), task.id.as_str()); + let temp_file = download_url_to_temp_dir(url, app_data_root).await?; + if let Some(ledger) = &maybe_ledger { + record_generation_result(ledger, job, temp_file.path()).await; + } + temp_files.push(temp_file); + } + let local_files = temp_files.iter() + .map(|file| file.path().to_path_buf()) + .collect::>(); + + let media_class = media_class_for(task.task_type); + let maybe_prompt = jobs.iter() + .filter_map(|job| job.params.prompt.as_deref()) + .map(str::trim) + .find(|prompt| !prompt.is_empty()) + .map(str::to_string); + + // Attribute a prompt when storyteller-web knows the model; the + // Higgsfield-only models have no prompt type there. + let prompt = match task.model_type.and_then(common_model_type_for) { + Some(model_type) => CompletionPrompt::Create { model_type, maybe_prompt }, + None => CompletionPrompt::None, + }; + + + complete_task_with_local_files(CompleteTaskArgs { + app_handle, + app_data_root, + app_preferences, + task_database, + task, + generation_provider: GenerationSource::Higgsfield, + media_class, + prompt, + fallback_model_slug: HIGGSFIELD_FALLBACK_MODEL_SLUG, + local_files: &local_files, + }).await?; + + Ok(()) +} + +/// Ledger a downloaded result as content Higgsfield generated (job id + +/// result URL). Best-effort: a hashing or database problem only costs a +/// future re-upload. +async fn record_generation_result(ledger: &AccountUploadCache, job: &JobStatusResponse, path: &Path) { + let Some(url) = job.result_url() else { return }; + let (hash, size) = match (hash_file_blake3(path), std::fs::metadata(path)) { + (Ok(hash), Ok(metadata)) => (hash, metadata.len()), + (Err(err), _) | (_, Err(err)) => { + warn!("[HiggsfieldComplete] Could not hash downloaded result of job {}: {}", job.id, err); + return; + } + }; + ledger.record_upload(&hash, size, &CachedAssetUpload::generation_result(job.id.as_str(), url)).await; +} + +fn media_class_for(task_type: TaskType) -> TaskMediaFileClass { + match task_type { + TaskType::VideoGeneration => TaskMediaFileClass::Video, + TaskType::ImageGeneration => TaskMediaFileClass::Image, + // Higgsfield only produces images and videos; anything else is a + // mis-recorded task, delivered as an image so it isn't lost. + TaskType::AudioGeneration | TaskType::MeshGeneration | TaskType::SplatGeneration => TaskMediaFileClass::Image, + } +} + +/// The storyteller-web prompt type for the models Higgsfield shares with it. +fn common_model_type_for(model_type: TaskModelType) -> Option { + match model_type { + TaskModelType::NanoBananaPro => Some(CommonModelType::NanoBananaPro), + TaskModelType::NanoBanana2 => Some(CommonModelType::NanoBanana2), + TaskModelType::GptImage2 => Some(CommonModelType::GptImage2), + TaskModelType::Seedream5p0Pro => Some(CommonModelType::Seedream5p0Pro), + TaskModelType::Seedream5Lite => Some(CommonModelType::Seedream5Lite), + TaskModelType::Seedream4p5 => Some(CommonModelType::Seedream4p5), + TaskModelType::Seedance2p0 => Some(CommonModelType::Seedance2p0), + TaskModelType::Seedance2p0Mini => Some(CommonModelType::Seedance2p0Mini), + TaskModelType::Kling3p0Standard => Some(CommonModelType::Kling3p0Standard), + TaskModelType::Kling3p0Pro => Some(CommonModelType::Kling3p0Pro), + TaskModelType::GrokImagineVideo1p5 => Some(CommonModelType::GrokImagineVideo1p5), + _ => None, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn media_class_follows_task_type() { + assert_eq!(media_class_for(TaskType::ImageGeneration), TaskMediaFileClass::Image); + assert_eq!(media_class_for(TaskType::VideoGeneration), TaskMediaFileClass::Video); + } + + #[test] + fn higgsfield_only_models_have_no_prompt_type() { + assert!(common_model_type_for(TaskModelType::Seedance2p5).is_none()); + assert!(common_model_type_for(TaskModelType::MinimaxH3).is_none()); + assert!(common_model_type_for(TaskModelType::NanoBanana2Lite).is_none()); + assert_eq!(common_model_type_for(TaskModelType::NanoBananaPro), Some(CommonModelType::NanoBananaPro)); + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/handle_higgsfield_failure.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/handle_higgsfield_failure.rs new file mode 100644 index 00000000..1f463c5a --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/handle_higgsfield_failure.rs @@ -0,0 +1,59 @@ +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::generation_events::common::{GenerationAction, GenerationServiceProvider}; +use crate::events::generation_events::generation_failed_event::GenerationFailedEvent; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::higgsfield_failure_reason::HiggsfieldFailureReport; +use log::{error, info}; +use sqlite_database::queries::task::Task; +use sqlite_database::queries::update::update_task_status_with_rich_failure::{ + update_task_status_with_rich_failure, UpdateTaskWithRichFailureArgs, +}; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use tauri::AppHandle; + +/// Mark the task failed, persisting the failure type + friendly message to +/// the tasks database (so the task queue can render it later) and notifying +/// the frontend. The technical record goes to the logs. +pub async fn handle_higgsfield_failure( + app_handle: &AppHandle, + task_database: &TaskDatabase, + task: &Task, + report: &HiggsfieldFailureReport, +) { + info!( + "[HiggsfieldPolling] Marking task {} as failed ({}): {} | details: {}", + task.id.as_str(), report.failure_type, report.user_message, report.log_details, + ); + + let update_result = update_task_status_with_rich_failure(UpdateTaskWithRichFailureArgs { + db: task_database.get_connection(), + task_id: &task.id, + status: TaskStatus::CompleteFailure, + maybe_failure_type: Some(report.failure_type), + maybe_failure_message: Some(&report.user_message), + }).await; + + if let Err(err) = update_result { + error!("[HiggsfieldPolling] Failed to update task status for {}: {:?}", task.id.as_str(), err); + } + + let event = GenerationFailedEvent { + action: task_type_to_generation_action(task.task_type), + service: GenerationServiceProvider::Higgsfield, + model: None, + reason: Some(report.user_message.clone()), + }; + + event.send_infallible(app_handle); +} + +fn task_type_to_generation_action(task_type: TaskType) -> GenerationAction { + match task_type { + TaskType::ImageGeneration => GenerationAction::GenerateImage, + TaskType::VideoGeneration => GenerationAction::GenerateVideo, + TaskType::AudioGeneration => GenerationAction::GenerateAudio, + TaskType::MeshGeneration => GenerationAction::ImageTo3d, + TaskType::SplatGeneration => GenerationAction::GenerateGaussian, + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/higgsfield_failure_reason.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/higgsfield_failure_reason.rs new file mode 100644 index 00000000..c433e679 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/higgsfield_failure_reason.rs @@ -0,0 +1,223 @@ +//! Turn Higgsfield job failures into something a person can act on. +//! +//! Two audiences, two strings: `user_message` is what the frontend shows +//! (no job ids, no jargon, a next step where one exists) and `log_details` +//! is the full technical record (every job id, raw status, and the server's +//! `fail_reason`) for the logs and the tasks database. + +use higgsfield_client::types::ids::JobId; +use higgsfield_client::types::job_status::JobStatus; +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; + +/// One job's failure, as observed while polling. +pub struct HiggsfieldJobFailure { + pub job_id: JobId, + pub kind: HiggsfieldJobFailureKind, + /// The server's `meta.fail_reason`, when the full job record gave one. + pub maybe_server_reason: Option, +} + +pub enum HiggsfieldJobFailureKind { + /// The job ended in a non-success terminal status. + TerminalStatus(JobStatus), + /// The job claims success but returned no result URL to download. + CompletedWithoutResult, +} + +/// A whole task's failure, ready to persist and display. +pub struct HiggsfieldFailureReport { + pub failure_type: TaskFailureType, + /// Frontend-facing: friendly, actionable, no identifiers. + pub user_message: String, + /// Log/database-facing: every job id, raw status, and server reason. + pub log_details: String, +} + +impl HiggsfieldJobFailure { + /// Higher wins when picking the message for a mixed batch: a stated + /// server reason is the most specific thing we have, then the content + /// filter (actionable), then the generic states. + fn priority(&self) -> u8 { + if self.maybe_server_reason.is_some() { + return 6; + } + match &self.kind { + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Nsfw) => 5, + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Failed) => 4, + HiggsfieldJobFailureKind::CompletedWithoutResult => 3, + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Cancelled) => 2, + HiggsfieldJobFailureKind::TerminalStatus(_) => 1, + } + } + + fn user_message(&self) -> String { + match &self.kind { + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Nsfw) => { + "Higgsfield's content filter flagged this generation as NSFW. If your prompt and \ + references are innocuous this can be a false positive — try rewording the prompt \ + or swapping the reference media.".to_string() + } + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Failed) => { + match &self.maybe_server_reason { + Some(reason) => format!("Higgsfield reported an error: {}", reason), + None => "The generation failed on Higgsfield's side without a stated reason. \ + This is often transient — try again.".to_string(), + } + } + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Cancelled) => { + "The generation was cancelled on Higgsfield before it finished.".to_string() + } + HiggsfieldJobFailureKind::TerminalStatus(status) => { + format!("The generation ended in an unexpected state on Higgsfield (\"{}\").", status) + } + HiggsfieldJobFailureKind::CompletedWithoutResult => { + "Higgsfield reported the generation as complete but returned no output file. \ + Trying again usually works.".to_string() + } + } + } + + fn failure_type(&self) -> TaskFailureType { + match &self.kind { + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Nsfw) => TaskFailureType::RuleBansGeneratedContent, + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Failed) => TaskFailureType::GenerationFailed, + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Cancelled) => TaskFailureType::GenerationFailed, + HiggsfieldJobFailureKind::TerminalStatus(_) => TaskFailureType::Unknown, + HiggsfieldJobFailureKind::CompletedWithoutResult => TaskFailureType::GenerationFailed, + } + } + + fn log_detail(&self) -> String { + let raw_state = match &self.kind { + HiggsfieldJobFailureKind::TerminalStatus(status) => format!("status={}", status), + HiggsfieldJobFailureKind::CompletedWithoutResult => "status=completed, no result URL".to_string(), + }; + match &self.maybe_server_reason { + Some(reason) => format!("job {}: {}, fail_reason={:?}", self.job_id, raw_state, reason), + None => format!("job {}: {}", self.job_id, raw_state), + } + } +} + +/// Summarize why a task (one or more Higgsfield jobs) failed. +/// `total_jobs` is the batch size, so partial context survives in the copy. +pub fn build_failure_report(failures: &[HiggsfieldJobFailure], total_jobs: usize) -> HiggsfieldFailureReport { + let Some(primary) = failures.iter().max_by_key(|failure| failure.priority()) else { + // Shouldn't happen (callers only report with >= 1 failure), but never + // leave the user message empty. + return HiggsfieldFailureReport { + failure_type: TaskFailureType::Unknown, + user_message: "The generation failed on Higgsfield for an unknown reason.".to_string(), + log_details: "no job outcomes recorded".to_string(), + }; + }; + + let mut user_message = primary.user_message(); + if total_jobs > 1 { + user_message = format!( + "{} of {} generations in this batch failed. {}", + failures.len(), total_jobs, user_message, + ); + } + + let log_details = failures.iter() + .map(HiggsfieldJobFailure::log_detail) + .collect::>() + .join("; "); + + HiggsfieldFailureReport { + failure_type: primary.failure_type(), + user_message, + log_details, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn failure(kind: HiggsfieldJobFailureKind, maybe_server_reason: Option<&str>) -> HiggsfieldJobFailure { + HiggsfieldJobFailure { + job_id: JobId::new("e82ac3d7-5282-4b71-be90-c7cfad846299"), + kind, + maybe_server_reason: maybe_server_reason.map(str::to_string), + } + } + + #[test] + fn nsfw_maps_to_content_rule_with_actionable_copy() { + let report = build_failure_report( + &[failure(HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Nsfw), None)], + 1, + ); + assert_eq!(report.failure_type, TaskFailureType::RuleBansGeneratedContent); + assert!(report.user_message.contains("content filter")); + assert!(report.user_message.contains("false positive")); + // Job ids stay out of user copy, but land in the log details. + assert!(!report.user_message.contains("e82ac3d7")); + assert!(report.log_details.contains("e82ac3d7")); + assert!(report.log_details.contains("status=nsfw")); + } + + #[test] + fn server_fail_reason_is_surfaced_verbatim() { + let report = build_failure_report( + &[failure( + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Failed), + Some("Input audio duration is not supported. Please try a shorter audio."), + )], + 1, + ); + assert_eq!(report.failure_type, TaskFailureType::GenerationFailed); + assert!(report.user_message.contains("Input audio duration is not supported")); + assert!(report.log_details.contains("fail_reason=\"Input audio duration")); + } + + #[test] + fn failed_without_reason_reads_as_transient() { + let report = build_failure_report( + &[failure(HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Failed), None)], + 1, + ); + assert!(report.user_message.contains("try again")); + } + + #[test] + fn unexpected_status_names_the_state() { + let report = build_failure_report( + &[failure(HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Other("mystery".into())), None)], + 1, + ); + assert_eq!(report.failure_type, TaskFailureType::Unknown); + assert!(report.user_message.contains("mystery")); + } + + #[test] + fn batch_failures_carry_counts_and_pick_the_most_specific_message() { + let report = build_failure_report( + &[ + failure(HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Cancelled), None), + failure( + HiggsfieldJobFailureKind::TerminalStatus(JobStatus::Failed), + Some("Resolution not supported."), + ), + ], + 4, + ); + assert!(report.user_message.starts_with("2 of 4 generations in this batch failed.")); + assert!(report.user_message.contains("Resolution not supported.")); + // Both jobs appear in the technical record. + assert_eq!(report.log_details.matches("job ").count(), 2); + } + + #[test] + fn completed_without_result_is_its_own_story() { + let report = build_failure_report( + &[failure(HiggsfieldJobFailureKind::CompletedWithoutResult, None)], + 1, + ); + assert_eq!(report.failure_type, TaskFailureType::GenerationFailed); + assert!(report.user_message.contains("no output file")); + assert!(report.log_details.contains("no result URL")); + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/higgsfield_poll_sessions.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/higgsfield_poll_sessions.rs new file mode 100644 index 00000000..4e2cbb41 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/higgsfield_poll_sessions.rs @@ -0,0 +1,81 @@ +use std::collections::HashMap; + +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; +use log::{info, warn}; + +use crate::credentials::auth_credential::AuthCredential; +use crate::services::higgsfield::higgsfield_session_from_credential::higgsfield_session_from_credential; +use crate::state::data_dir::app_data_root::AppDataRoot; +use core_types::enums::generation_source::GenerationSource; + +/// One live [`HiggsfieldSession`] per stored Higgsfield credential, kept +/// across polling iterations so the short-lived Clerk bearer token is reused +/// rather than re-minted every couple of seconds. Sessions follow the +/// credential files: a re-login (new cookies) replaces the session, a deleted +/// credential drops it. +#[derive(Default)] +pub struct HiggsfieldPollSessions { + sessions: HashMap, +} + +struct SessionEntry { + cookie_header: String, + session: HiggsfieldSession, +} + +impl HiggsfieldPollSessions { + pub fn new() -> Self { + Self::default() + } + + /// The sessions for every Higgsfield credential currently on disk, in + /// credential order. Empty when the user has no Higgsfield account. + pub fn refresh(&mut self, app_data_root: &AppDataRoot) -> Vec<(String, HiggsfieldSession)> { + let credentials = match app_data_root.credentials_dir().load_credentials() { + Ok(credentials) => credentials, + Err(err) => { + warn!("[HiggsfieldPolling] Could not load credentials: {}", err); + return self.sessions.iter().map(|(id, entry)| (id.clone(), entry.session.clone())).collect(); + } + }; + + let higgsfield_credentials: Vec = credentials.into_iter() + .filter(|credential| credential.service == GenerationSource::HiggsfieldCookies) + .collect(); + + let live_ids: Vec = higgsfield_credentials.iter().map(|c| c.id.as_str().to_string()).collect(); + self.sessions.retain(|id, _| live_ids.contains(id)); + + let mut result = Vec::with_capacity(higgsfield_credentials.len()); + for credential in &higgsfield_credentials { + let id = credential.id.as_str().to_string(); + // A session Higgsfield already rejected stays untouched until the user + // logs in again (which rewrites the cookies and clears the mark). + if credential.needs_relogin() { + if self.sessions.remove(&id).is_some() { + warn!("[HiggsfieldPolling] Credential {} needs a re-login; not polling with it", id); + } + continue; + } + let cookie_header = credential.cookies().map(|cookie| cookie.cookie_header()).unwrap_or_default(); + let is_current = self.sessions.get(&id).is_some_and(|entry| entry.cookie_header == cookie_header); + if !is_current { + match higgsfield_session_from_credential(credential) { + Ok(session) => { + info!("[HiggsfieldPolling] Opened a session for credential {}", id); + self.sessions.insert(id.clone(), SessionEntry { cookie_header, session }); + } + Err(err) => { + warn!("[HiggsfieldPolling] Credential {} can't open a Higgsfield session: {}", id, err); + self.sessions.remove(&id); + continue; + } + } + } + if let Some(entry) = self.sessions.get(&id) { + result.push((id, entry.session.clone())); + } + } + result + } +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/mod.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/mod.rs new file mode 100644 index 00000000..07f3c6d5 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/mod.rs @@ -0,0 +1,11 @@ +//! First-party (cookie-session) Higgsfield jobs. A task's `provider_job_id` +//! holds every job id of the Higgsfield job set (comma-separated for a +//! batch); the poller checks them in one batch-status call per account and, +//! once every job is terminal, downloads the finished files and hands them +//! to the shared completion routine. + +pub mod handle_higgsfield_complete; +pub mod handle_higgsfield_failure; +pub mod higgsfield_failure_reason; +pub mod higgsfield_poll_sessions; +pub mod poll_higgsfield_tasks; diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/poll_higgsfield_tasks.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/poll_higgsfield_tasks.rs new file mode 100644 index 00000000..0afd8d25 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/higgsfield/poll_higgsfield_tasks.rs @@ -0,0 +1,227 @@ +use std::collections::HashMap; + +use higgsfield_client::endpoints::jobs::job_status::JobStatusResponse; +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; +use higgsfield_client::types::ids::JobId; +use higgsfield_client::types::job_status::JobStatus; +use log::{error, info, warn}; +use sqlite_database::queries::task::Task; +use tauri::AppHandle; + +use crate::commands::generate::common::higgsfield_generation::split_higgsfield_job_ids; +use crate::services::higgsfield::mark_higgsfield_relogin_required::mark_higgsfield_relogin_required; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::handle_higgsfield_complete::handle_higgsfield_complete; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::handle_higgsfield_failure::handle_higgsfield_failure; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::higgsfield_failure_reason::{ + build_failure_report, HiggsfieldFailureReport, HiggsfieldJobFailure, HiggsfieldJobFailureKind, +}; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::higgsfield_poll_sessions::HiggsfieldPollSessions; +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; + +/// Check every pending Higgsfield task. Jobs are looked up through each +/// stored Higgsfield account in turn (a job only answers on the account that +/// created it); the first account that knows the job set is used. +pub async fn poll_higgsfield_tasks( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + sessions: &mut HiggsfieldPollSessions, + tasks: &[&Task], +) { + let sessions = sessions.refresh(app_data_root); + if sessions.is_empty() { + warn!("[HiggsfieldPolling] {} task(s) pending but no Higgsfield account is stored; skipping", tasks.len()); + return; + } + + for task in tasks { + let result = poll_single_task( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + &sessions, + task, + ).await; + if let Err(err) = result { + error!("[HiggsfieldPolling] Error processing task {}: {:?}", task.id.as_str(), err); + } + } +} + +/// What the batch status call said about one task's jobs. +enum JobSetProgress { + /// At least one job is still running. + Pending, + /// Every job reached a terminal state. + Done(Vec), +} + +struct JobOutcome { + job_id: JobId, + status: JobStatus, +} + +async fn poll_single_task( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + sessions: &[(String, HiggsfieldSession)], + task: &Task, +) -> anyhow::Result<()> { + let job_ids: Vec = task.provider_job_id.as_deref() + .map(split_higgsfield_job_ids) + .unwrap_or_default() + .into_iter() + .map(JobId::new) + .collect(); + + if job_ids.is_empty() { + warn!("[HiggsfieldPolling] Task {} has no job ids; marking as failed", task.id.as_str()); + let report = HiggsfieldFailureReport { + failure_type: TaskFailureType::Unknown, + user_message: "This generation lost track of its Higgsfield job and can't be resumed. Please generate again.".to_string(), + log_details: "task record has no provider job ids".to_string(), + }; + handle_higgsfield_failure(app_handle, task_database, task, &report).await; + return Ok(()); + } + + let Some((credential_id, session, progress)) = find_job_set(app_handle, app_data_root, sessions, &job_ids, task).await else { + // No account knows the jobs. Leave the task pending: the account may be + // temporarily unreachable (expired session, network) and come back. + return Ok(()); + }; + + let outcomes = match progress { + JobSetProgress::Pending => return Ok(()), + JobSetProgress::Done(outcomes) => outcomes, + }; + + // Fetch the full record (result URLs, prompt) of every finished job. + let mut finished: Vec = Vec::new(); + let mut failures: Vec = Vec::new(); + for outcome in &outcomes { + if !outcome.status.is_success() { + // Best-effort: the full job record carries the server's fail_reason + // (e.g. "Input audio duration is not supported"), which is the most + // useful thing we can show. A fetch error just means no reason. + let maybe_server_reason = match session.job_status(&outcome.job_id).await { + Ok(job) => job.fail_reason().map(str::to_string), + Err(err) => { + warn!( + "[HiggsfieldPolling] Could not fetch fail_reason for job {} (task {}): {}", + outcome.job_id, task.id.as_str(), err, + ); + None + } + }; + failures.push(HiggsfieldJobFailure { + job_id: outcome.job_id.clone(), + kind: HiggsfieldJobFailureKind::TerminalStatus(outcome.status.clone()), + maybe_server_reason, + }); + continue; + } + match session.job_status(&outcome.job_id).await { + Ok(job) if job.result_url().is_some() => finished.push(job), + Ok(job) => { + let maybe_server_reason = job.fail_reason().map(str::to_string); + failures.push(HiggsfieldJobFailure { + job_id: job.id.clone(), + kind: HiggsfieldJobFailureKind::CompletedWithoutResult, + maybe_server_reason, + }); + } + Err(err) => { + // Transient: try again next iteration rather than failing the task. + warn!("[HiggsfieldPolling] Could not fetch job {} for task {}: {}", outcome.job_id, task.id.as_str(), err); + return Ok(()); + } + } + } + + if finished.is_empty() { + let report = build_failure_report(&failures, outcomes.len()); + handle_higgsfield_failure(app_handle, task_database, task, &report).await; + return Ok(()); + } + + if !failures.is_empty() { + let report = build_failure_report(&failures, outcomes.len()); + warn!( + "[HiggsfieldPolling] Task {}: {} of {} job(s) failed; delivering the rest. Details: {}", + task.id.as_str(), failures.len(), outcomes.len(), report.log_details, + ); + } + + handle_higgsfield_complete( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + credential_id, + task, + &finished, + ).await; + + Ok(()) +} + +/// Ask each account for the jobs' status until one knows them. +async fn find_job_set<'a>( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + sessions: &'a [(String, HiggsfieldSession)], + job_ids: &[JobId], + task: &Task, +) -> Option<(&'a str, &'a HiggsfieldSession, JobSetProgress)> { + for (credential_id, session) in sessions { + let batch = match session.job_status_batch(job_ids).await { + Ok(batch) => batch, + Err(err) => { + warn!( + "[HiggsfieldPolling] Status check failed for task {} on credential {}: {}{}", + task.id.as_str(), credential_id, err, + if err.needs_browser_reauth() { " (log into Higgsfield again)" } else { "" }, + ); + if err.needs_browser_reauth() { + mark_higgsfield_relogin_required(app_handle, app_data_root, credential_id); + } + continue; + } + }; + + // An account that created none of these jobs reports them all missing. + if batch.items.is_empty() { + continue; + } + + let statuses: HashMap<&JobId, &JobStatus> = batch.items.iter().map(|item| (&item.id, &item.status)).collect(); + let mut outcomes = Vec::with_capacity(job_ids.len()); + for job_id in job_ids { + let status = match statuses.get(job_id) { + Some(status) => (*status).clone(), + None if batch.missing.contains(job_id) => JobStatus::Other("missing".to_string()), + None => return Some((credential_id, session, JobSetProgress::Pending)), + }; + if !status.is_terminal() && !batch.missing.contains(job_id) { + info!("[HiggsfieldPolling] Task {} job {} is {}", task.id.as_str(), job_id, status); + return Some((credential_id, session, JobSetProgress::Pending)); + } + outcomes.push(JobOutcome { job_id: job_id.clone(), status }); + } + return Some((credential_id, session, JobSetProgress::Done(outcomes))); + } + None +} diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/mod.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/mod.rs new file mode 100644 index 00000000..f6454340 --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/handlers/mod.rs @@ -0,0 +1,3 @@ +pub mod fal; +pub mod grok; +pub mod higgsfield; diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/mod.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/mod.rs new file mode 100644 index 00000000..3c01673a --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/mod.rs @@ -0,0 +1,3 @@ +pub mod events; +pub mod handlers; +pub mod third_party_task_polling_thread; diff --git a/crates/artcraftx/src/threads/third_party_task_polling_thread/third_party_task_polling_thread.rs b/crates/artcraftx/src/threads/third_party_task_polling_thread/third_party_task_polling_thread.rs new file mode 100644 index 00000000..8fe17ded --- /dev/null +++ b/crates/artcraftx/src/threads/third_party_task_polling_thread/third_party_task_polling_thread.rs @@ -0,0 +1,190 @@ +use crate::services::grok::state::grok_websockets::GrokWebsockets; +use crate::state::app_preferences::app_preferences_manager::AppPreferencesManager; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::task_database::TaskDatabase; +use crate::threads::third_party_task_polling_thread::handlers::fal::poll_fal_tasks::poll_fal_tasks; +use crate::threads::third_party_task_polling_thread::handlers::grok::grok_image_collector::GrokImageCollector; +use crate::threads::third_party_task_polling_thread::handlers::grok::poll_grok_image_tasks::poll_grok_image_tasks; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::higgsfield_poll_sessions::HiggsfieldPollSessions; +use crate::threads::third_party_task_polling_thread::handlers::higgsfield::poll_higgsfield_tasks::poll_higgsfield_tasks; +use crate::database::task_database_pending_statuses::TASK_DATABASE_PENDING_STATUSES; +use crate::services::storyteller::state::storyteller_credential_manager::StorytellerCredentialManager; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_type::TaskType; +use log::{error, info, warn}; +use sqlite_database::queries::read::list_non_artcraft_pending_tasks::{ + list_non_artcraft_pending_tasks, ListNonArtcraftPendingTasksArgs, +}; +use sqlite_database::queries::task::Task; +use std::time::Duration; +use tauri::AppHandle; + +const SLEEP_NO_THIRD_PARTY_JOBS_SEEN: Duration = Duration::from_secs(10); +const SLEEP_THIRD_PARTY_JOBS_SEEN: Duration = Duration::from_secs(2); +const SLEEP_BETWEEN_FAL_POLLS: Duration = Duration::from_secs(1); +const SLEEP_ON_ERROR: Duration = Duration::from_secs(30); + +pub async fn third_party_task_polling_thread( + app_handle: AppHandle, + app_data_root: AppDataRoot, + app_preferences: AppPreferencesManager, + task_database: TaskDatabase, + storyteller_creds_manager: StorytellerCredentialManager, + grok_websockets: GrokWebsockets, +) -> ! { + let mut has_ever_seen_third_party_jobs = false; + // Grok streams a prompt's images one frame at a time; accumulate across iterations. + let mut grok_image_collector = GrokImageCollector::new(); + // One Higgsfield session per account, reused so bearer tokens aren't re-minted every poll. + let mut higgsfield_sessions = HiggsfieldPollSessions::new(); + + loop { + let result = poll_iteration( + &app_handle, + &app_data_root, + &app_preferences, + &task_database, + &storyteller_creds_manager, + &grok_websockets, + &mut grok_image_collector, + &mut higgsfield_sessions, + &mut has_ever_seen_third_party_jobs, + ).await; + + if let Err(err) = result { + error!("[ThirdPartyPolling] Error in polling loop: {:?}", err); + tokio::time::sleep(SLEEP_ON_ERROR).await; + } + } +} + +async fn poll_iteration( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + app_preferences: &AppPreferencesManager, + task_database: &TaskDatabase, + storyteller_creds_manager: &StorytellerCredentialManager, + grok_websockets: &GrokWebsockets, + grok_image_collector: &mut GrokImageCollector, + higgsfield_sessions: &mut HiggsfieldPollSessions, + has_ever_seen_third_party_jobs: &mut bool, +) -> Result<(), PollError> { + let task_list = list_non_artcraft_pending_tasks(ListNonArtcraftPendingTasksArgs { + db: task_database.get_connection(), + task_statuses: &TASK_DATABASE_PENDING_STATUSES, + }).await?; + + let tasks = task_list.tasks; + + if tasks.is_empty() { + let sleep_duration = if *has_ever_seen_third_party_jobs { + SLEEP_THIRD_PARTY_JOBS_SEEN + } else { + SLEEP_NO_THIRD_PARTY_JOBS_SEEN + }; + tokio::time::sleep(sleep_duration).await; + return Ok(()); + } + + *has_ever_seen_third_party_jobs = true; + + let fal_tasks: Vec<&Task> = tasks.iter() + .filter(|t| t.provider == GenerationSource::Fal) + .collect(); + + // First-party Grok Imagine images (websocket results; see handlers/grok). + let grok_image_tasks: Vec<&Task> = tasks.iter() + .filter(|t| t.provider == GenerationSource::Grok && t.task_type == TaskType::ImageGeneration) + .collect(); + + // First-party Higgsfield images and videos (see handlers/higgsfield). + let higgsfield_tasks: Vec<&Task> = tasks.iter() + .filter(|t| t.provider == GenerationSource::Higgsfield) + .collect(); + + let unhandled_tasks: Vec<&Task> = tasks.iter() + .filter(|t| t.provider != GenerationSource::Fal) + .filter(|t| t.provider != GenerationSource::Higgsfield) + .filter(|t| !(t.provider == GenerationSource::Grok && t.task_type == TaskType::ImageGeneration)) + .collect(); + + for task in &unhandled_tasks { + warn!( + "[ThirdPartyPolling] Skipping unhandled task: id={}, provider={:?}, type={:?}", + task.id.as_str(), + task.provider, + task.task_type, + ); + } + + if !grok_image_tasks.is_empty() { + info!("[ThirdPartyPolling] {} Grok image job(s) pending", grok_image_tasks.len()); + poll_grok_image_tasks( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + grok_websockets, + grok_image_collector, + &grok_image_tasks, + ).await; + } + + if !higgsfield_tasks.is_empty() { + info!("[ThirdPartyPolling] {} Higgsfield job(s) pending", higgsfield_tasks.len()); + poll_higgsfield_tasks( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + higgsfield_sessions, + &higgsfield_tasks, + ).await; + } + + if fal_tasks.is_empty() { + // NB: the Grok poll already listened on its sockets for a couple of seconds. + if grok_image_tasks.is_empty() { + tokio::time::sleep(SLEEP_THIRD_PARTY_JOBS_SEEN).await; + } + return Ok(()); + } + + info!("[ThirdPartyPolling] {} FAL job(s) ready to check", fal_tasks.len()); + + poll_fal_tasks( + app_handle, + app_data_root, + app_preferences, + task_database, + storyteller_creds_manager, + &fal_tasks, + ).await; + + tokio::time::sleep(SLEEP_BETWEEN_FAL_POLLS).await; + + Ok(()) +} + +// ── Error ── + +#[derive(Debug)] +enum PollError { + SqliteTasksError(sqlite_database::error::SqliteTasksError), +} + +impl From for PollError { + fn from(err: sqlite_database::error::SqliteTasksError) -> Self { + Self::SqliteTasksError(err) + } +} + +impl std::fmt::Display for PollError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::SqliteTasksError(err) => write!(f, "SQLite error: {:?}", err), + } + } +} diff --git a/crates/artcraftx/src/threads/thumbnail_worker_thread/mod.rs b/crates/artcraftx/src/threads/thumbnail_worker_thread/mod.rs new file mode 100644 index 00000000..9cdda131 --- /dev/null +++ b/crates/artcraftx/src/threads/thumbnail_worker_thread/mod.rs @@ -0,0 +1 @@ +pub mod thumbnail_worker_thread; diff --git a/crates/artcraftx/src/threads/thumbnail_worker_thread/thumbnail_worker_thread.rs b/crates/artcraftx/src/threads/thumbnail_worker_thread/thumbnail_worker_thread.rs new file mode 100644 index 00000000..3eb4b175 --- /dev/null +++ b/crates/artcraftx/src/threads/thumbnail_worker_thread/thumbnail_worker_thread.rs @@ -0,0 +1,142 @@ +//! Background thumbnail generation for downloaded results. +//! +//! Work arrives two ways: +//! +//! 1. Downloaders push the files they just wrote onto the +//! [`ThumbnailWorkQueue`], which wakes this thread immediately. +//! 2. Every [`SCAN_INTERVAL`] the thread asks both databases what's owed: +//! `local_files` rows still pending (retryable, or made by an older +//! generator), and the most recently completed tasks' downloads that have +//! no current thumbnail yet — so history from before this thread existed, +//! and anything a missed wake-up skipped, still gets done. +//! +//! Each finished thumbnail is announced with `local_thumbnail_ready_event` +//! so the task queue can show it without re-polling. + +use std::collections::HashSet; +use std::path::PathBuf; +use std::time::{Duration, Instant}; + +use log::{debug, error, info, warn}; +use local_files_database::queries::get_local_files_by_paths::get_local_files_by_paths; +use local_files_database::queries::list_local_files_needing_thumbnails::list_local_files_needing_thumbnails; +use sqlite_database::queries::read::list_completed_task_download_files::list_completed_task_download_files; +use tauri::AppHandle; +use thumbnails::THUMBNAIL_GENERATOR_VERSION; + +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::local_thumbnail_ready_event::LocalThumbnailReadyEvent; +use crate::services::local_files::thumbnail_service::{generate_thumbnail, needs_generation, LocalThumbnailStatus, MAX_THUMBNAIL_ATTEMPTS}; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::state::database::local_files_database::LocalFilesDatabase; +use crate::state::database::task_database::TaskDatabase; +use crate::state::thumbnails::thumbnail_work_queue::ThumbnailWorkQueue; + +/// How often the databases are scanned for owed thumbnails when nobody +/// wakes the thread. +const SCAN_INTERVAL: Duration = Duration::from_secs(60); + +/// Per scan, how many `local_files` rows to pick up. +const MAX_LOCAL_FILE_ROWS_PER_SCAN: i64 = 50; + +/// Per scan, how far back through completed tasks to look. +const RECENT_COMPLETED_TASKS_TO_SCAN: i64 = 200; + +pub async fn thumbnail_worker_thread( + app_handle: AppHandle, + app_data_root: AppDataRoot, + task_database: TaskDatabase, + local_files_database: LocalFilesDatabase, + queue: ThumbnailWorkQueue, +) -> ! { + info!("[ThumbnailWorker] Started"); + // Scan right away so history is covered as soon as the app is up. + let mut next_scan = Instant::now(); + + loop { + let queued = queue.drain(); + if !queued.is_empty() { + info!("[ThumbnailWorker] Woken with {} queued file(s)", queued.len()); + process_all(&app_handle, &app_data_root, &local_files_database, queued).await; + } + + if Instant::now() >= next_scan { + match scan_for_work(&task_database, &local_files_database).await { + Ok(paths) => { + if !paths.is_empty() { + info!("[ThumbnailWorker] Scan found {} file(s) owed a thumbnail", paths.len()); + } + process_all(&app_handle, &app_data_root, &local_files_database, paths).await; + } + Err(err) => error!("[ThumbnailWorker] Scan failed: {}", err), + } + next_scan = Instant::now() + SCAN_INTERVAL; + } + + let until_next_scan = next_scan.saturating_duration_since(Instant::now()); + tokio::select! { + _ = queue.notified() => {}, + _ = tokio::time::sleep(until_next_scan) => {}, + } + } +} + +async fn process_all( + app_handle: &AppHandle, + app_data_root: &AppDataRoot, + local_files_database: &LocalFilesDatabase, + paths: Vec, +) { + for path in paths { + let thumbnail = generate_thumbnail(local_files_database, app_data_root, &path).await; + match thumbnail.status { + LocalThumbnailStatus::Ready => { + let Some(thumbnail_path) = thumbnail.maybe_thumbnail_path else { + warn!("[ThumbnailWorker] Ready without a thumbnail path for {}", path.display()); + continue; + }; + LocalThumbnailReadyEvent { + file_path: thumbnail.file_path, + thumbnail_path, + maybe_animated_preview_path: thumbnail.maybe_animated_preview_path, + }.send_infallible(app_handle); + } + LocalThumbnailStatus::MissingFile => debug!("[ThumbnailWorker] File is gone, skipping: {}", path.display()), + // Already logged (and recorded on the row) by the service. + LocalThumbnailStatus::Pending | LocalThumbnailStatus::Unsupported | LocalThumbnailStatus::Failed => {} + } + } +} + +/// Everything the databases say is owed a thumbnail, deduplicated, with the +/// newest downloads first. +async fn scan_for_work( + task_database: &TaskDatabase, + local_files_database: &LocalFilesDatabase, +) -> anyhow::Result> { + let mut seen: HashSet = HashSet::new(); + let mut work: Vec = Vec::new(); + + // Recently completed tasks whose download has no (surviving) thumbnail. + let recent_downloads = list_completed_task_download_files(task_database.get_connection(), RECENT_COMPLETED_TASKS_TO_SCAN).await?; + let known = get_local_files_by_paths(local_files_database.get_connection(), &recent_downloads).await?; + for path in recent_downloads { + let owed = match known.get(&path) { + Some(record) => needs_generation(record), + None => true, + }; + if owed && seen.insert(path.clone()) { + work.push(PathBuf::from(path)); + } + } + + // Rows the index already knows are unfinished (files seen by other means). + let pending_rows = list_local_files_needing_thumbnails(local_files_database.get_connection(), MAX_THUMBNAIL_ATTEMPTS, THUMBNAIL_GENERATOR_VERSION, MAX_LOCAL_FILE_ROWS_PER_SCAN).await?; + for record in pending_rows { + if seen.insert(record.file_path.clone()) { + work.push(PathBuf::from(record.file_path)); + } + } + + Ok(work) +} diff --git a/crates/artcraftx/src/utils/download/download_url_to_download_dir_via_temp.rs b/crates/artcraftx/src/utils/download/download_url_to_download_dir_via_temp.rs new file mode 100644 index 00000000..08449798 --- /dev/null +++ b/crates/artcraftx/src/utils/download/download_url_to_download_dir_via_temp.rs @@ -0,0 +1,120 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::download::download_url_to_user_download_dir::{check_download_file_name, download_file_name_from_url}; +use anyhow::anyhow; +use log::info; +use std::io::Write; +use std::path::PathBuf; +use url::Url; + +/// Download a file to the app's temp directory, then move it into the user's +/// configured download directory. Downloading to temp first means partially +/// downloaded files never land in the download directory. +/// +/// `maybe_filename` overrides the URL-derived filename (eg. to apply the +/// user's preferred download filename convention). It is vetted with the +/// same rules as URL-derived names. +/// +/// Returns the final path. If a file with the same name already exists in the +/// download directory, nothing is downloaded and +/// [`ArtcraftXError::CannotDownloadFilePathAlreadyExists`] is returned. +pub async fn download_url_to_download_dir_via_temp( + url: &Url, + maybe_filename: Option<&str>, + app_data_root: &AppDataRoot, + app_prefs: &AppPreferences, +) -> Result { + let url_file_name = match maybe_filename { + Some(filename) => { + check_download_file_name(filename)?; + filename.to_string() + } + None => download_file_name_from_url(url)?, + }; + + let download_directory = app_prefs + .downloads + .preferred_download_directory + .download_directory(app_data_root); + + let destination = { + let mut destination = download_directory.clone(); + destination.push(&url_file_name); + destination + }; + + if destination == download_directory { + return Err(ArtcraftXError::AnyhowError(anyhow!("Download filename resolved to directory: {:?}", destination))); + } + + if destination.exists() { + if destination.is_dir() { + return Err(ArtcraftXError::AnyhowError(anyhow!("Download path exists and resolved to directory: {:?}", destination))); + } + return Err(ArtcraftXError::CannotDownloadFilePathAlreadyExists { path: destination }); + } + + // Download to the temp directory first. + let extension = url_file_name.rsplit('.').next().unwrap_or("bin"); + + let response = reqwest::get(url.clone()).await?; + let response_bytes = response.bytes().await?; + + let mut temp_file = app_data_root + .temp_dir() + .new_named_temp_file_with_extension(extension)?; + temp_file.write_all(&response_bytes)?; + temp_file.flush()?; + + info!("Downloaded {:?} to temp; moving to {:?}", url.as_str(), destination); + + // Move into place. `persist_noclobber` is a rename, which can fail two + // ways: another downloader won the race (destination now exists — that's + // fine, filenames derive from the content hash so it's the same file), or + // the download directory is on another volume (cross-device rename) — fall + // back to a copy. + match temp_file.persist_noclobber(&destination) { + Ok(_file) => {} + Err(persist_error) => { + let temp_file = persist_error.file; + if !destination.exists() { + std::fs::copy(temp_file.path(), &destination)?; + } + // NB: The temp file cleans itself up on drop. + } + } + + Ok(destination) +} + +#[cfg(test)] +mod tests { + use super::*; + + /// Live: downloads a real CDN file through the temp-then-move path. + #[tokio::test] + #[ignore] // Live: hits the CDN (read-only) and writes to the default download dir. + async fn live_download_to_download_dir() { + let app_data_root = AppDataRoot::create_default().expect("app data root"); + let app_prefs = AppPreferences::default(); + + // A known completed generation output. + let url = Url::parse("https://cdn-2.fakeyou.com/media/j/q/z/s/x/jqzsxxd8r20bnx42jw2dhdj6tq81q9xf/artcraft_jqzsxxd8r20bnx42jw2dhdj6tq81q9xf.png").unwrap(); + + let path = download_url_to_download_dir_via_temp(&url, None, &app_data_root, &app_prefs) + .await + .expect("download should succeed"); + + println!("[live] downloaded to {:?}", path); + assert!(path.exists()); + assert!(std::fs::metadata(&path).unwrap().len() > 0); + assert!(path.starts_with(app_prefs.downloads.preferred_download_directory.download_directory(&app_data_root))); + + // Second attempt must refuse to clobber. + let second = download_url_to_download_dir_via_temp(&url, None, &app_data_root, &app_prefs).await; + assert!(matches!(second, Err(ArtcraftXError::CannotDownloadFilePathAlreadyExists { .. }))); + + std::fs::remove_file(&path).expect("cleanup"); + } +} diff --git a/crates/artcraftx/src/utils/download/download_url_to_temp_dir.rs b/crates/artcraftx/src/utils/download/download_url_to_temp_dir.rs new file mode 100644 index 00000000..5f2fea8a --- /dev/null +++ b/crates/artcraftx/src/utils/download/download_url_to_temp_dir.rs @@ -0,0 +1,20 @@ +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use std::io::Write; +use tempfile::NamedTempFile; +use url::Url; + +pub async fn download_url_to_temp_dir(url: &str, app_data_root: &AppDataRoot) -> AnyhowResult { + let url = Url::parse(&url)?; + + let response = reqwest::get(url.clone()).await?; + let response_bytes = response.bytes().await?; + + let ext = url.path().split(".").last().unwrap_or("png"); + + let mut temp_file = app_data_root.temp_dir().new_named_temp_file_with_extension(ext)?; + + temp_file.write_all(&response_bytes)?; + + Ok(temp_file) +} diff --git a/crates/artcraftx/src/utils/download/download_url_to_user_download_dir.rs b/crates/artcraftx/src/utils/download/download_url_to_user_download_dir.rs new file mode 100644 index 00000000..ebfa6ae4 --- /dev/null +++ b/crates/artcraftx/src/utils/download/download_url_to_user_download_dir.rs @@ -0,0 +1,132 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::data_dir::app_data_root::AppDataRoot; +use anyhow::anyhow; +use log::{error, info}; +use std::fs::OpenOptions; +use std::io::Write; +use std::path::PathBuf; +use url::Url; + +pub async fn download_url_to_user_download_dir( + url: &Url, + app_data_root: &AppDataRoot, + app_prefs: &AppPreferences, +) -> Result { + + let url_file_name = download_file_name_from_url(url)?; + + let download_directory = app_prefs + .downloads + .preferred_download_directory + .download_directory(app_data_root); + + info!("Pushing path `{}` onto downloaded directory `{:?}`", url_file_name, download_directory); + + let download_filename = { + let mut download_filename = download_directory.clone(); + download_filename.push(&url_file_name); + download_filename + }; + + info!("Download filename: `{:?}`", download_filename); + + if download_filename == download_directory { + return Err(ArtcraftXError::AnyhowError(anyhow!("Download filename resolved to directory: {:?}", download_filename)))?; + } + + if download_filename.exists() { + if download_filename.is_dir() { + return Err(ArtcraftXError::AnyhowError(anyhow!("Download path exists and resolved to directory: {:?}", download_filename))); + } else { + return Err(ArtcraftXError::CannotDownloadFilePathAlreadyExists { path: download_filename }.into()); + } + } + + info!("Downloading bytes from url: {:?}", url); + + let response = reqwest::get(url.clone()).await?; + let response_bytes = response.bytes().await?; + + info!("Writing file: {:?}", download_filename); + + let mut file = OpenOptions::new() + .create(true) + .write(true) + .truncate(true) + .open(&download_filename)?; + + file.write_all(&response_bytes)?; + + Ok(download_filename) +} + +/// Derive (and vet) the local filename to save a download under from its URL. +pub fn download_file_name_from_url(url: &Url) -> Result { + let path_segments = url.path_segments() + .ok_or_else(|| ArtcraftXError::AnyhowError(anyhow!("URL does not have path segments (1): {:?}", url)))?; + + let mut url_file_name = path_segments.last() + .ok_or_else(|| ArtcraftXError::AnyhowError(anyhow!("URL does not have path segments (2): {:?}", url)))? + .trim() + .to_string(); + + if !url_file_name.to_lowercase().starts_with("artcraft") { + url_file_name = format!("artcraft_{}", url_file_name); + } + + check_download_file_name(&url_file_name)?; + + Ok(url_file_name) +} + +/// Vet a filename (from any source) before writing it into the download +/// directory. +// TODO: This likely needs more protections. +pub fn check_download_file_name(filename: &str) -> Result<(), ArtcraftXError> { + if filename.trim().is_empty() { + error!("Download filename is empty!"); + return Err(ArtcraftXError::BadDownloadFilename { path: "".into() }.into()); + } + + if !filename.is_ascii() { + error!("Download filename is not completely ASCII: {:?}", filename); + return Err(ArtcraftXError::BadDownloadFilename { path: filename.into() }.into()); + } + + if filename.contains("/") + || filename.contains("..") + || filename.contains("\\") + { + error!("Cannot download filename that has relative path components: {:?}", filename); + return Err(ArtcraftXError::BadDownloadFilename { path: filename.into() }.into()); + } + + if filename.contains("'") + || filename.contains("\"") + || filename.contains("%") + || filename.contains("<") + || filename.contains(">") + || filename.contains("|") + { + error!("Download filename has dangerous path components: {:?}", filename); + return Err(ArtcraftXError::BadDownloadFilename { path: filename.into() }.into()); + } + + if filename.ends_with(".apk") + || filename.ends_with(".app") + || filename.ends_with(".bat") + || filename.ends_with(".cmd") + || filename.ends_with(".com") + || filename.ends_with(".ps1") + || filename.ends_with(".sh") + || filename.ends_with(".so") + || filename.ends_with("dll") // Don't even risk the '.' + || filename.ends_with("exe") // Don't even risk the '.' + { + error!("Cannot download filename that resembles executable: {:?}", filename); + return Err(ArtcraftXError::BadDownloadFilename { path: filename.into() }.into()); + } + + Ok(()) +} diff --git a/crates/artcraftx/src/utils/download/mod.rs b/crates/artcraftx/src/utils/download/mod.rs new file mode 100644 index 00000000..4eaff34e --- /dev/null +++ b/crates/artcraftx/src/utils/download/mod.rs @@ -0,0 +1,8 @@ +pub mod download_url_to_download_dir_via_temp; +pub mod record_task_download_locations; +pub mod download_url_to_temp_dir; +pub mod download_url_to_user_download_dir; +pub mod save_base64_image_to_temp_dir; +pub mod simple_http_download; +pub mod simple_http_download_to_tempfile; +pub mod save_local_file_to_download_dir; diff --git a/crates/artcraftx/src/utils/download/record_task_download_locations.rs b/crates/artcraftx/src/utils/download/record_task_download_locations.rs new file mode 100644 index 00000000..6f5c553f --- /dev/null +++ b/crates/artcraftx/src/utils/download/record_task_download_locations.rs @@ -0,0 +1,33 @@ +use crate::state::database::task_database::TaskDatabase; +use log::{error, info}; +use sqlite_database::queries::update::update_task_download_locations::{ + update_task_download_locations, UpdateTaskDownloadLocationsArgs, +}; +use sqlite_identifiers::ids::task_id::TaskId; +use std::path::Path; + +/// Record where a completed task's files landed: the containing directory and +/// the first (or only) file. No-op when nothing was downloaded. Fails open — +/// a bookkeeping failure must never undo a completed generation. +pub async fn record_task_download_locations(task_database: &TaskDatabase, task_id: &TaskId, downloaded: &[impl AsRef]) { + let Some(first_file) = downloaded.first().map(|p| p.as_ref()) else { + return; + }; + let Some(directory) = first_file.parent() else { + error!("Downloaded file {:?} for task {} has no parent directory", first_file, task_id.as_str()); + return; + }; + + let result = update_task_download_locations(UpdateTaskDownloadLocationsArgs { + db: task_database.get_connection(), + task_id, + directory_location: directory, + first_file_location: first_file, + }).await; + + match result { + Ok(true) => info!("Recorded download location for task {}: {:?}", task_id.as_str(), first_file), + Ok(false) => error!("Task {} not found while recording its download location", task_id.as_str()), + Err(err) => error!("Could not record download location for task {}: {:?}", task_id.as_str(), err), + } +} diff --git a/crates/artcraftx/src/utils/download/save_base64_image_to_temp_dir.rs b/crates/artcraftx/src/utils/download/save_base64_image_to_temp_dir.rs new file mode 100644 index 00000000..e8ede2ff --- /dev/null +++ b/crates/artcraftx/src/utils/download/save_base64_image_to_temp_dir.rs @@ -0,0 +1,22 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::data_dir::app_data_root::AppDataRoot; +use mimetypes::mimetype_info::mimetype_info::MimetypeInfo; +use std::io::Write; +use tempfile::NamedTempFile; +use web_base64::web_base64_decode::web_base64_decode; + +pub async fn save_base64_image_to_temp_dir(app_data_root: &AppDataRoot, base64_image: &str) -> Result { + let bytes = web_base64_decode(base64_image)?; + + let extension = MimetypeInfo::get_for_bytes(&bytes) + .map(|info| info.file_extension()) + .flatten() + .map(|ext| ext.extension_with_period().to_string()) + .unwrap_or_else(|| ".png".to_string()); + + let mut file = app_data_root.temp_dir().new_named_temp_file_with_extension(&extension)?; + + file.write_all(bytes.as_ref())?; + + Ok(file) // NB: Must return TempFile to not drop / delete it +} diff --git a/crates/artcraftx/src/utils/download/save_local_file_to_download_dir.rs b/crates/artcraftx/src/utils/download/save_local_file_to_download_dir.rs new file mode 100644 index 00000000..a5af7735 --- /dev/null +++ b/crates/artcraftx/src/utils/download/save_local_file_to_download_dir.rs @@ -0,0 +1,47 @@ +use crate::error::artcraftx_error::ArtcraftXError; +use crate::state::app_preferences::app_preferences::AppPreferences; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::download::download_url_to_user_download_dir::check_download_file_name; +use anyhow::anyhow; +use log::info; +use std::path::{Path, PathBuf}; + +/// Copy an already-fetched local file (eg. a result sitting in the app's temp +/// directory) into the user's configured download directory under `filename`. +/// +/// Returns the final path. If a file with that name already exists, nothing is +/// copied and [`ArtcraftXError::CannotDownloadFilePathAlreadyExists`] is +/// returned — callers treat that as "already saved". +pub fn save_local_file_to_download_dir( + source: &Path, + filename: &str, + app_data_root: &AppDataRoot, + app_prefs: &AppPreferences, +) -> Result { + check_download_file_name(filename)?; + + let download_directory = app_prefs + .downloads + .preferred_download_directory + .download_directory(app_data_root); + + let destination = download_directory.join(filename); + + if destination == download_directory { + return Err(ArtcraftXError::AnyhowError(anyhow!("Download filename resolved to directory: {:?}", destination))); + } + + if destination.exists() { + if destination.is_dir() { + return Err(ArtcraftXError::AnyhowError(anyhow!("Download path exists and resolved to directory: {:?}", destination))); + } + return Err(ArtcraftXError::CannotDownloadFilePathAlreadyExists { path: destination }); + } + + std::fs::create_dir_all(&download_directory)?; + std::fs::copy(source, &destination)?; + + info!("Saved {:?} to {:?}", source, destination); + + Ok(destination) +} diff --git a/crates/artcraftx/src/utils/download/simple_http_download.rs b/crates/artcraftx/src/utils/download/simple_http_download.rs new file mode 100644 index 00000000..966b7195 --- /dev/null +++ b/crates/artcraftx/src/utils/download/simple_http_download.rs @@ -0,0 +1,34 @@ +use errors::AnyhowResult; +use reqwest::Client; +use reqwest::Url; +use std::fs::OpenOptions; +use std::io::Write; +use std::path::Path; + +const USER_AGENT: &str = "storyteller-client/1.0"; + +/// Downloads a (binary) file to a filesystem path. Good for images, etc. Not great for large files. +pub async fn simple_http_download>(url: &Url, download_path: P) -> AnyhowResult<()> { + let client = Client::builder() + .gzip(true) + .build()?; + + let response = client.get(url.clone()) // NB: No IntoUrl for &Url. + .header("User-Agent", USER_AGENT) + .header("Accept", "*/*") + .send() + .await?; + + //let response : Response = reqwest::get(url).await?; + let bytes = response.bytes().await?; + + let mut file = OpenOptions::new() + .create(true) // To create a new file + .write(true) + .truncate(true) + .open(download_path)?; + + file.write_all(&bytes)?; + + Ok(()) +} diff --git a/crates/artcraftx/src/utils/download/simple_http_download_to_tempfile.rs b/crates/artcraftx/src/utils/download/simple_http_download_to_tempfile.rs new file mode 100644 index 00000000..b1ae596f --- /dev/null +++ b/crates/artcraftx/src/utils/download/simple_http_download_to_tempfile.rs @@ -0,0 +1,26 @@ +use errors::AnyhowResult; +use reqwest::Client; +use reqwest::Url; +use std::io::Write; +use tempfile::NamedTempFile; + +const USER_AGENT: &str = "storyteller-client/1.0"; + +/// Downloads a (binary) file to a filesystem path. Good for images, etc. Not great for large files. +pub async fn simple_http_download_to_tempfile(url: &Url, temp_file: &mut NamedTempFile) -> AnyhowResult<()> { + let client = Client::builder() + .gzip(true) + .build()?; + + let response = client.get(url.clone()) // NB: No IntoUrl for &Url. + .header("User-Agent", USER_AGENT) + .header("Accept", "*/*") + .send() + .await?; + + let bytes = response.bytes().await?; + + temp_file.write_all(&bytes)?; + + Ok(()) +} diff --git a/crates/artcraftx/src/utils/enum_conversion/artcraft_api_generation_provider.rs b/crates/artcraftx/src/utils/enum_conversion/artcraft_api_generation_provider.rs new file mode 100644 index 00000000..dfd5966a --- /dev/null +++ b/crates/artcraftx/src/utils/enum_conversion/artcraft_api_generation_provider.rs @@ -0,0 +1,86 @@ +//! The `generation_provider` value the ArtCraft (storyteller-web) API accepts +//! when we upload results or create prompts. +//! +//! The API's `GenerationProvider` enum (storyteller-web, +//! `crates/schema/public/enums/src/common/generation_provider.rs`) accepts: +//! `artcraft`, `fal`, `grok`, `midjourney`, `sora`, `world_labs`, +//! `higgsfield`, `krea`, `leonardo`, `magnific`, `openart`, `picsart`, +//! `pixverse`, `runway`. Sending anything else fails the request with +//! `unknown variant`, so only these are ever sent; credential services +//! collapse onto their provider, and sources with no API value go +//! "unspecified" rather than losing the upload / prompt. +//! +//! NB: the app only records tasks for providers it generates with, so the +//! cookie-only services (Magnific, OpenArt, Runway) and the API-key-only +//! ones (OpenAI, Replicate) have no bare [`GenerationSource`] variant to +//! send yet; add one alongside their generation path. + +use core_types::enums::generation_source::GenerationSource; + +pub fn artcraft_api_generation_provider(source: GenerationSource) -> Option { + match source { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies + | GenerationSource::ArtcraftApi => Some(GenerationSource::Artcraft), + GenerationSource::Fal + | GenerationSource::FalApi => Some(GenerationSource::Fal), + GenerationSource::Grok + | GenerationSource::GrokCookies + | GenerationSource::XAiApi => Some(GenerationSource::Grok), + GenerationSource::Midjourney + | GenerationSource::MidjourneyCookies => Some(GenerationSource::Midjourney), + GenerationSource::WorldLabs + | GenerationSource::WorldLabsCookies => Some(GenerationSource::WorldLabs), + GenerationSource::Higgsfield + | GenerationSource::HiggsfieldCookies => Some(GenerationSource::Higgsfield), + // The API knows `magnific` / `openart` / `runway`, but the app has no bare + // provider variant for them yet (see the module docs). + GenerationSource::MagnificCookies + | GenerationSource::OpenArtCookies + | GenerationSource::RunwayCookies + | GenerationSource::OpenAiApi + | GenerationSource::ReplicateApi => None, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + /// What storyteller-web's `GenerationProvider` deserializes today. + const API_KNOWN_VALUES: &[&str] = &[ + "artcraft", "fal", "grok", "midjourney", "sora", "world_labs", + "higgsfield", "krea", "leonardo", "magnific", "openart", "picsart", "pixverse", "runway", + ]; + + #[test] + fn only_values_the_api_knows_are_ever_sent() { + for source in GenerationSource::all_variants() { + if let Some(sent) = artcraft_api_generation_provider(source) { + assert!(API_KNOWN_VALUES.contains(&sent.to_str()), "{source} would be sent as {sent}, which the API rejects"); + } + } + } + + #[test] + fn credential_services_collapse_onto_their_provider() { + assert_eq!(artcraft_api_generation_provider(GenerationSource::GrokCookies), Some(GenerationSource::Grok)); + assert_eq!(artcraft_api_generation_provider(GenerationSource::ArtcraftLocal), Some(GenerationSource::Artcraft)); + assert_eq!(artcraft_api_generation_provider(GenerationSource::WorldLabs), Some(GenerationSource::WorldLabs)); + } + + #[test] + fn higgsfield_is_sent_as_itself() { + assert_eq!(artcraft_api_generation_provider(GenerationSource::Higgsfield), Some(GenerationSource::Higgsfield)); + assert_eq!(artcraft_api_generation_provider(GenerationSource::HiggsfieldCookies), Some(GenerationSource::Higgsfield)); + assert_eq!(GenerationSource::Higgsfield.to_str(), "higgsfield"); + } + + #[test] + fn services_without_a_bare_provider_stay_unspecified() { + for source in [GenerationSource::MagnificCookies, GenerationSource::OpenArtCookies, GenerationSource::RunwayCookies, GenerationSource::OpenAiApi, GenerationSource::ReplicateApi] { + assert_eq!(artcraft_api_generation_provider(source), None, "{source}"); + } + } +} diff --git a/crates/artcraftx/src/utils/enum_conversion/generation_source.rs b/crates/artcraftx/src/utils/enum_conversion/generation_source.rs new file mode 100644 index 00000000..a8665b42 --- /dev/null +++ b/crates/artcraftx/src/utils/enum_conversion/generation_source.rs @@ -0,0 +1,29 @@ +use crate::events::generation_events::common::GenerationServiceProvider; +use core_types::enums::generation_source::GenerationSource; + +// TODO(bt,2025-07-15): Get rid of GenerationServiceProvider +pub fn to_generation_service_provider(source: GenerationSource) -> GenerationServiceProvider { + match source { + GenerationSource::Artcraft + | GenerationSource::ArtcraftLocal + | GenerationSource::ArtcraftCookies + | GenerationSource::ArtcraftApi => GenerationServiceProvider::Artcraft, + GenerationSource::Fal + | GenerationSource::FalApi => GenerationServiceProvider::Fal, + GenerationSource::Grok + | GenerationSource::GrokCookies + | GenerationSource::XAiApi => GenerationServiceProvider::Grok, + GenerationSource::Midjourney + | GenerationSource::MidjourneyCookies => GenerationServiceProvider::Midjourney, + GenerationSource::WorldLabs + | GenerationSource::WorldLabsCookies => GenerationServiceProvider::WorldLabs, + GenerationSource::Higgsfield + | GenerationSource::HiggsfieldCookies => GenerationServiceProvider::Higgsfield, + // No tasks are generated from these sources (yet); fall back to Artcraft. + GenerationSource::MagnificCookies + | GenerationSource::OpenArtCookies + | GenerationSource::RunwayCookies + | GenerationSource::OpenAiApi + | GenerationSource::ReplicateApi => GenerationServiceProvider::Artcraft, + } +} diff --git a/crates/artcraftx/src/utils/enum_conversion/mod.rs b/crates/artcraftx/src/utils/enum_conversion/mod.rs new file mode 100644 index 00000000..c1cc20c7 --- /dev/null +++ b/crates/artcraftx/src/utils/enum_conversion/mod.rs @@ -0,0 +1,4 @@ +pub mod artcraft_api_generation_provider; +pub mod task_failure_type; +pub mod generation_source; +pub mod task_type; \ No newline at end of file diff --git a/crates/artcraftx/src/utils/enum_conversion/task_failure_type.rs b/crates/artcraftx/src/utils/enum_conversion/task_failure_type.rs new file mode 100644 index 00000000..871af3a9 --- /dev/null +++ b/crates/artcraftx/src/utils/enum_conversion/task_failure_type.rs @@ -0,0 +1,60 @@ +use artcraft_client::enums::api_safe::by_table::generic_inference_jobs::frontend_failure_category_for_api_clients::FrontendFailureCategoryForApiClients; +use artcraft_client::enums::by_table::generic_inference_jobs::frontend_failure_category::FrontendFailureCategory; +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; + +/// Convert the web API's `FrontendFailureCategory` to a Tauri-facing type, if there is a matching variant. +/// If there isn't a matching variant, return `Unknown`. +pub fn task_failure_type_from_frontend_failure_category(category: FrontendFailureCategory) -> TaskFailureType { + match category { + FrontendFailureCategory::ModelRulesViolation => TaskFailureType::ModelRulesViolation, + FrontendFailureCategory::RuleBansUserImage => TaskFailureType::RuleBansUserImage, + FrontendFailureCategory::RuleBansUserImageWithFaces => TaskFailureType::RuleBansUserImageWithFaces, + FrontendFailureCategory::RuleBansUserTextPrompt => TaskFailureType::RuleBansUserTextPrompt, + FrontendFailureCategory::RuleBansUserContent => TaskFailureType::RuleBansUserContent, + FrontendFailureCategory::RuleBansGeneratedVideo => TaskFailureType::RuleBansGeneratedVideo, + FrontendFailureCategory::RuleBansGeneratedAudio => TaskFailureType::RuleBansGeneratedAudio, + FrontendFailureCategory::RuleBansGeneratedContent => TaskFailureType::RuleBansGeneratedContent, + FrontendFailureCategory::NoForegroundSubjectDetected => TaskFailureType::NoForegroundSubjectDetected, + FrontendFailureCategory::FormatNotSupported => TaskFailureType::FormatNotSupported, + FrontendFailureCategory::GenerationFailed => TaskFailureType::GenerationFailed, + FrontendFailureCategory::FaceNotDetected => TaskFailureType::FaceNotDetected, + FrontendFailureCategory::KeepAliveElapsed => TaskFailureType::KeepAliveElapsed, + FrontendFailureCategory::NotYetImplemented => TaskFailureType::NotYetImplemented, + FrontendFailureCategory::RetryableWorkerError => TaskFailureType::RetryableWorkerError, + FrontendFailureCategory::FilesizeTooLarge => TaskFailureType::FilesizeTooLarge, + FrontendFailureCategory::ImageDimensionsTooSmall => TaskFailureType::ImageDimensionsTooSmall, + FrontendFailureCategory::ImageDimensionsTooLarge => TaskFailureType::ImageDimensionsTooLarge, + } +} + +/// Convert the API-client-facing `FrontendFailureCategoryForApiClients` to a Tauri-facing type. +/// `Unknown(String)` maps to `Unknown` with a debug log. +pub fn task_failure_type_from_frontend_failure_category_for_api(category: &FrontendFailureCategoryForApiClients) -> TaskFailureType { + match category { + FrontendFailureCategoryForApiClients::ModelRulesViolation => TaskFailureType::ModelRulesViolation, + FrontendFailureCategoryForApiClients::RuleBansUserImage => TaskFailureType::RuleBansUserImage, + FrontendFailureCategoryForApiClients::RuleBansUserImageWithFaces => TaskFailureType::RuleBansUserImageWithFaces, + FrontendFailureCategoryForApiClients::RuleBansUserTextPrompt => TaskFailureType::RuleBansUserTextPrompt, + FrontendFailureCategoryForApiClients::RuleBansUserContent => TaskFailureType::RuleBansUserContent, + FrontendFailureCategoryForApiClients::RuleBansGeneratedVideo => TaskFailureType::RuleBansGeneratedVideo, + FrontendFailureCategoryForApiClients::RuleBansGeneratedAudio => TaskFailureType::RuleBansGeneratedAudio, + FrontendFailureCategoryForApiClients::RuleBansGeneratedContent => TaskFailureType::RuleBansGeneratedContent, + FrontendFailureCategoryForApiClients::NoForegroundSubjectDetected => TaskFailureType::NoForegroundSubjectDetected, + FrontendFailureCategoryForApiClients::FormatNotSupported => TaskFailureType::FormatNotSupported, + FrontendFailureCategoryForApiClients::GenerationFailed => TaskFailureType::GenerationFailed, + + FrontendFailureCategoryForApiClients::FaceNotDetected => TaskFailureType::FaceNotDetected, + FrontendFailureCategoryForApiClients::KeepAliveElapsed => TaskFailureType::KeepAliveElapsed, + FrontendFailureCategoryForApiClients::NotYetImplemented => TaskFailureType::NotYetImplemented, + FrontendFailureCategoryForApiClients::RetryableWorkerError => TaskFailureType::RetryableWorkerError, + FrontendFailureCategoryForApiClients::FilesizeTooLarge => TaskFailureType::FilesizeTooLarge, + FrontendFailureCategoryForApiClients::ImageDimensionsTooSmall => TaskFailureType::ImageDimensionsTooSmall, + FrontendFailureCategoryForApiClients::ImageDimensionsTooLarge => TaskFailureType::ImageDimensionsTooLarge, + + // Unknown (future-proof) variant + FrontendFailureCategoryForApiClients::Unknown(ref value) => { + log::debug!("Unknown FrontendFailureCategoryForApiClients variant: {}", value); + TaskFailureType::Unknown + } + } +} diff --git a/crates/artcraftx/src/utils/enum_conversion/task_type.rs b/crates/artcraftx/src/utils/enum_conversion/task_type.rs new file mode 100644 index 00000000..743cccd1 --- /dev/null +++ b/crates/artcraftx/src/utils/enum_conversion/task_type.rs @@ -0,0 +1,12 @@ +use crate::events::generation_events::common::GenerationAction; +use sqlite_identifiers::enums::task_type::TaskType; + +pub fn to_generation_action(task_type: TaskType) -> GenerationAction { + match task_type { + TaskType::ImageGeneration => GenerationAction::GenerateImage, + TaskType::VideoGeneration => GenerationAction::GenerateVideo, + TaskType::AudioGeneration => GenerationAction::GenerateAudio, + TaskType::MeshGeneration => GenerationAction::ImageTo3d, + TaskType::SplatGeneration => GenerationAction::GenerateGaussian, + } +} diff --git a/crates/artcraftx/src/utils/get_url_file_extension.rs b/crates/artcraftx/src/utils/get_url_file_extension.rs new file mode 100644 index 00000000..9acf0cfa --- /dev/null +++ b/crates/artcraftx/src/utils/get_url_file_extension.rs @@ -0,0 +1,35 @@ +use reqwest::Url; +use std::path::Path; + +pub fn get_url_file_extension(url: &Url) -> Option<&str> { + Path::new(url.path()) + .extension() + .filter(|ext| !ext.is_empty()) + .and_then(|ext| ext.to_str()) +} + +#[cfg(test)] +mod tests { + use reqwest::Url; + + #[test] + fn extension_exists() { + let url = Url::parse("https://example.com/image.png").unwrap(); + let extension = super::get_url_file_extension(&url); + assert_eq!(extension, Some("png")); + } + + #[test] + fn extension_does_not_exist() { + let url = Url::parse("https://example.com/foo").unwrap(); + let extension = super::get_url_file_extension(&url); + assert_eq!(extension, None); + } + + #[test] + fn period_not_in_path() { + let url = Url::parse("https://example.com/invalid.period/foo").unwrap(); + let extension = super::get_url_file_extension(&url); + assert_eq!(extension, None); + } +} \ No newline at end of file diff --git a/crates/artcraftx/src/utils/image/decode_base64_image.rs b/crates/artcraftx/src/utils/image/decode_base64_image.rs new file mode 100644 index 00000000..d8ebb2b1 --- /dev/null +++ b/crates/artcraftx/src/utils/image/decode_base64_image.rs @@ -0,0 +1,14 @@ +use base64::prelude::BASE64_STANDARD; +use base64::Engine; +use image::{DynamicImage, ImageReader}; +use std::io::Cursor; + +pub fn decode_base64_image(base64_image: &str) -> anyhow::Result { + let bytes = BASE64_STANDARD.decode(base64_image)?; + + let image = ImageReader::new(Cursor::new(bytes)) + .with_guessed_format()? + .decode()?; + + Ok(image) +} diff --git a/crates/artcraftx/src/utils/image/encode_dynamic_image_base64_png.rs b/crates/artcraftx/src/utils/image/encode_dynamic_image_base64_png.rs new file mode 100644 index 00000000..cb68e228 --- /dev/null +++ b/crates/artcraftx/src/utils/image/encode_dynamic_image_base64_png.rs @@ -0,0 +1,14 @@ +use base64::prelude::BASE64_STANDARD; +use base64::Engine; +use image::{DynamicImage, ImageFormat}; +use std::io::Cursor; + +pub fn encode_dynamic_image_base64_png(image: DynamicImage) -> anyhow::Result { + let mut bytes = Vec::with_capacity(1024*1024); + + image.write_to(&mut Cursor::new(&mut bytes), ImageFormat::Png)?; + + let bytes = BASE64_STANDARD.encode(bytes); + + Ok(bytes) +} diff --git a/crates/artcraftx/src/utils/image/encode_rgb_image_base64_png.rs b/crates/artcraftx/src/utils/image/encode_rgb_image_base64_png.rs new file mode 100644 index 00000000..76eb333d --- /dev/null +++ b/crates/artcraftx/src/utils/image/encode_rgb_image_base64_png.rs @@ -0,0 +1,16 @@ +use base64::prelude::BASE64_STANDARD; +use base64::Engine; +use image::{ImageFormat, RgbImage}; +use std::io::Cursor; + +pub fn encode_rgb_image_base64_png( + image: RgbImage +) -> anyhow::Result { + let mut bytes = Vec::with_capacity(1024*1024); + + image.write_to(&mut Cursor::new(&mut bytes), ImageFormat::Png)?; + + let bytes = (&BASE64_STANDARD).encode(bytes); + + Ok(bytes) +} diff --git a/crates/artcraftx/src/utils/image/mod.rs b/crates/artcraftx/src/utils/image/mod.rs new file mode 100644 index 00000000..3b7d7a6b --- /dev/null +++ b/crates/artcraftx/src/utils/image/mod.rs @@ -0,0 +1,3 @@ +pub mod decode_base64_image; +pub mod encode_dynamic_image_base64_png; +pub mod encode_rgb_image_base64_png; \ No newline at end of file diff --git a/crates/artcraftx/src/utils/mod.rs b/crates/artcraftx/src/utils/mod.rs new file mode 100644 index 00000000..7b867ec4 --- /dev/null +++ b/crates/artcraftx/src/utils/mod.rs @@ -0,0 +1,6 @@ +pub mod download; +pub mod enum_conversion; +pub mod get_url_file_extension; +pub mod image; +pub mod services; +pub mod window; diff --git a/crates/artcraftx/src/utils/services/artcraft_api_host.rs b/crates/artcraftx/src/utils/services/artcraft_api_host.rs new file mode 100644 index 00000000..f7976d6c --- /dev/null +++ b/crates/artcraftx/src/utils/services/artcraft_api_host.rs @@ -0,0 +1,21 @@ +use artcraft_client::utils::api_host::ApiHost; + +use core_types::enums::generation_source::GenerationSource; + +/// Port the local ArtCraft development server listens on. +pub const ARTCRAFT_LOCAL_DEV_PORT: u32 = 12345; + +/// The API host an ArtCraft-family credential authenticates against. +/// `None` for services that aren't ArtCraft accounts. +pub fn maybe_artcraft_api_host_for_service( + service: GenerationSource, +) -> Option { + match service { + GenerationSource::Artcraft + | GenerationSource::ArtcraftCookies => Some(ApiHost::Storyteller), + GenerationSource::ArtcraftLocal => { + Some(ApiHost::Localhost { port: ARTCRAFT_LOCAL_DEV_PORT }) + } + _ => None, + } +} diff --git a/crates/artcraftx/src/utils/services/mod.rs b/crates/artcraftx/src/utils/services/mod.rs new file mode 100644 index 00000000..f513bec8 --- /dev/null +++ b/crates/artcraftx/src/utils/services/mod.rs @@ -0,0 +1 @@ +pub mod artcraft_api_host; diff --git a/crates/artcraftx/src/utils/window/clear_all_webview_cookies.rs b/crates/artcraftx/src/utils/window/clear_all_webview_cookies.rs new file mode 100644 index 00000000..fb39071d --- /dev/null +++ b/crates/artcraftx/src/utils/window/clear_all_webview_cookies.rs @@ -0,0 +1,7 @@ +use errors::AnyhowResult; +use tauri::Webview; + +pub fn clear_all_webview_cookies(webview: &Webview) -> AnyhowResult<()> { + webview.clear_all_browsing_data()?; + Ok(()) +} diff --git a/crates/artcraftx/src/utils/window/get_webview_window_hostname.rs b/crates/artcraftx/src/utils/window/get_webview_window_hostname.rs new file mode 100644 index 00000000..4fd10cd5 --- /dev/null +++ b/crates/artcraftx/src/utils/window/get_webview_window_hostname.rs @@ -0,0 +1,11 @@ +use anyhow::anyhow; +use tauri::WebviewWindow; +use errors::AnyhowResult; + +pub fn get_webview_window_hostname(webview: &WebviewWindow) -> AnyhowResult { + let url = webview.url()?; + let url_hostname= url.host() + .ok_or(anyhow!("no host in url"))? + .to_string(); + Ok(url_hostname) +} diff --git a/crates/artcraftx/src/utils/window/get_webview_window_url_path.rs b/crates/artcraftx/src/utils/window/get_webview_window_url_path.rs new file mode 100644 index 00000000..0cdec494 --- /dev/null +++ b/crates/artcraftx/src/utils/window/get_webview_window_url_path.rs @@ -0,0 +1,7 @@ +use errors::AnyhowResult; +use tauri::WebviewWindow; + +pub fn get_webview_window_url_path(webview: &WebviewWindow) -> AnyhowResult { + let url = webview.url()?; + Ok(url.path().to_string()) +} diff --git a/crates/artcraftx/src/utils/window/get_window_size_heuristic.rs b/crates/artcraftx/src/utils/window/get_window_size_heuristic.rs new file mode 100644 index 00000000..6631f783 --- /dev/null +++ b/crates/artcraftx/src/utils/window/get_window_size_heuristic.rs @@ -0,0 +1,25 @@ +use errors::AnyhowResult; +use tauri::{PhysicalSize, Window}; + +// A typical height difference when dev tools are open: +// Window inner size = PhysicalSize { width: 3704, height: 732 } +// Window outer size = PhysicalSize { width: 3704, height: 1476 } +const DEV_TOOLS_HEIGHT_DIFFERENCE_THRESHOLD: u32 = 300; + +/// Get the best window size +pub fn get_window_size_heuristic(window: &Window) -> AnyhowResult> { + // NB: Ordinarily we'd use inner size, as the outer size includes the window decorations. + // However, dev tools contract the inner size, and in the event they're open, we should + // prefer the outer size. + let inner = window.inner_size()?; + let outer = window.outer_size()?; + + let height_delta = outer.height.saturating_sub(inner.height); + if height_delta > DEV_TOOLS_HEIGHT_DIFFERENCE_THRESHOLD { + // Dev tools are open, use the outer size + Ok(outer) + } else { + // Dev tools are not open, use the inner size + Ok(inner) + } +} diff --git a/crates/artcraftx/src/utils/window/mod.rs b/crates/artcraftx/src/utils/window/mod.rs new file mode 100644 index 00000000..00b12530 --- /dev/null +++ b/crates/artcraftx/src/utils/window/mod.rs @@ -0,0 +1,6 @@ +pub mod clear_all_webview_cookies; +pub mod get_webview_window_hostname; +pub mod get_window_size_heuristic; +pub mod position_main_window; +pub mod resize_main_window; +pub mod get_webview_window_url_path; diff --git a/crates/artcraftx/src/utils/window/position_main_window.rs b/crates/artcraftx/src/utils/window/position_main_window.rs new file mode 100644 index 00000000..13d5869b --- /dev/null +++ b/crates/artcraftx/src/utils/window/position_main_window.rs @@ -0,0 +1,65 @@ +use crate::state::window::main_window_position::MainWindowPosition; +use crate::windows::main_window::constants::MAIN_WINDOW_NAME; +use errors::AnyhowResult; +use tauri::{AppHandle, Manager, PhysicalPosition}; + +/// Try to position the main window at startup. +/// If it doesn't meet certain placement heuristics, abandon manual placement and let the OS +/// decide where to place the app. +pub fn position_main_window( + app: &AppHandle, + position: &MainWindowPosition, +) -> AnyhowResult<()> { + + // NB: This non-negative position heuristic is good for MacBook (single screen). + // Not sure how this fares on Windows, Linux, or multiscreen setups. + // On Mac, this prevents the windows from being positioned off to the top-left, + // as (0,0) is the top left directly under the top menu bar. + if position.x < 0 { + // TODO(bt,2025-07-16): just in the case of x/width, allow slight placement off + // screen as long as the app is wide enough. + return Err(anyhow::anyhow!("X position must be non-negative")); + } else if position.y < 0 { + return Err(anyhow::anyhow!("Y position must be non-negative")); + } + + let windows = app.windows(); + + let window = windows.get(MAIN_WINDOW_NAME) + .ok_or_else(|| anyhow::anyhow!("Main window not found"))?; + + if let Ok(Some(monitor)) = window.current_monitor() { + // Reports the size of the monitor, e.g. PhysicalSize { width: 4112, height: 2658 } + // This is not impacted by `scale_factor`, even if that's a multiple like "2". + // i.e., positioning the app at `monitor.size().width/2` and `monitor.size().height/2` + // will place the **top left corner of the app** in roughly the center of the monitor. + let monitor_size = monitor.size(); + + println!("Current monitor - size: {:?}", monitor_size); + println!("Current monitor - scale factor: {:?}", monitor.scale_factor()); + println!("Current monitor - position: {:?}", monitor.position()); + + let width_padding = monitor_size.width.div_ceil(6); + let height_padding = monitor_size.height.div_ceil(6); + + let max_width = monitor_size.width.saturating_sub(width_padding); + let max_height = monitor_size.height.saturating_sub(height_padding); + + let max_width = i32::try_from(max_width)?; + let max_height = i32::try_from(max_height)?; + + // Prevent the window from being positioned off the screen to the bottom, right, and bottom right. + // This works on MacBook (single screen), but should be tested on Windows, Linux, and multiscreen setups. + if position.x > max_width { + return Err(anyhow::anyhow!("X position must be less than or equal to {} (monitor width {})", + max_width, monitor_size.width)); + } else if position.y > max_height { + return Err(anyhow::anyhow!("Y position must be less than or equal to {} (monitor height {})", + max_height, monitor_size.height)); + } + } + + window.set_position(PhysicalPosition::new(position.x, position.y))?; + + Ok(()) +} \ No newline at end of file diff --git a/crates/artcraftx/src/utils/window/resize_main_window.rs b/crates/artcraftx/src/utils/window/resize_main_window.rs new file mode 100644 index 00000000..0fd6da3b --- /dev/null +++ b/crates/artcraftx/src/utils/window/resize_main_window.rs @@ -0,0 +1,63 @@ +use crate::state::window::main_window_size::MainWindowSize; +use crate::windows::main_window::constants::{MAIN_WINDOW_MIN_HEIGHT, MAIN_WINDOW_MIN_WIDTH, MAIN_WINDOW_NAME}; +use tauri::{AppHandle, Manager, PhysicalSize}; + +/// Try to resize the main window at startup. +/// If it doesn't meet certain sizing heuristics, abandon manual resize and let the OS +/// decide how to size the app. +pub fn resize_main_window( + app: &AppHandle, + size: &MainWindowSize, +) -> errors::AnyhowResult<()> { + + let mut resize_width = size.width; + let mut resize_height = size.height; + let mut resize_was_corrected = false; + + if resize_width < MAIN_WINDOW_MIN_WIDTH { + resize_width = MAIN_WINDOW_MIN_WIDTH; + resize_was_corrected = true; + } + if resize_height < MAIN_WINDOW_MIN_HEIGHT { + resize_height = MAIN_WINDOW_MIN_HEIGHT; + resize_was_corrected = true; + } + + let windows = app.windows(); + let window = windows.get(MAIN_WINDOW_NAME) + .ok_or_else(|| anyhow::anyhow!("Main window not found"))?; + + if let Ok(Some(monitor)) = window.current_monitor() { + let scale_factor = monitor.scale_factor(); + + if scale_factor > 1.0 { + + let min_width = MAIN_WINDOW_MIN_WIDTH as f64 * scale_factor; + let min_height = MAIN_WINDOW_MIN_HEIGHT as f64 * scale_factor; + + // Is this safe? https://users.rust-lang.org/t/convert-an-f64-to-an-i32/50991/4 + let min_width = min_width as u32; + let min_height = min_height as u32; + + if resize_width < min_width { + resize_width = min_width; + resize_was_corrected = true; + } + if resize_height < min_height { + resize_height = min_height; + resize_was_corrected = true; + } + } + } + + if resize_was_corrected { + println!("Resizing window to: {}x{} (corrected from {}x{})", + resize_width, resize_height, size.width, size.height); + } else { + println!("Resizing window to: {}x{} (no correction needed)", resize_width, resize_height); + } + + window.set_size(PhysicalSize::new(resize_width, resize_height))?; + + Ok(()) +} diff --git a/crates/artcraftx/src/version.rs b/crates/artcraftx/src/version.rs new file mode 100644 index 00000000..87a6b8e5 --- /dev/null +++ b/crates/artcraftx/src/version.rs @@ -0,0 +1,4 @@ + +/// The version of the ArtCraft desktop app reported in the UI and via Analytics. +/// This should match the CI builds. +pub const ARTCRAFT_VERSION: &str = "0.0.1"; diff --git a/crates/artcraftx/src/windows/login_window/login_journey.rs b/crates/artcraftx/src/windows/login_window/login_journey.rs new file mode 100644 index 00000000..7b55d302 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/login_journey.rs @@ -0,0 +1,286 @@ +use once_cell::sync::Lazy; +use reqwest::Url; + +/// Default pre-navigation referrer. Visiting Google first gives the login +/// page a plausible referrer (some providers gate on this). +static DEFAULT_PRE_NAVIGATION_URL: Lazy = Lazy::new(|| { + Url::parse("https://google.com").expect("URL should parse") +}); + +/// How long the injected link-discovery script keeps polling the page for the +/// login link before giving up (milliseconds, page-side). +const FOLLOW_LINK_TIMEOUT_MS: u32 = 30_000; + +/// How often the injected link-discovery script re-checks the page for the +/// login link (milliseconds, page-side). +const FOLLOW_LINK_POLL_INTERVAL_MS: u32 = 250; + +/// The scripted navigation journey that takes a fresh login window from a +/// cold start to the site's login screen. +/// +/// The journey is modeled as named stages that run in order, each optional: +/// +/// 1. `pre_navigation` — a referrer page visited before touching the site +/// (e.g. Google). +/// 2. `website_entry` — the site's public entry page (e.g. its homepage). +/// 3. `login_page` — how to reach the login page itself: a fixed URL, or +/// discovered on the entry page when the URL is subject to change +/// (see [`LoginPageTarget`]). +/// +/// After the last stage the user signs in by hand and the monitor thread +/// ([`crate::windows::login_window::login_window_thread`]) takes over to +/// capture cookies. +/// +/// Future stages slot in as new fields; [`LoginJourney::plan`] flattens +/// whatever is present into the ordered [`NavigationAction`]s the window +/// driver executes, so the driver never changes when stages are added. +#[derive(Clone, Debug)] +pub struct LoginJourney { + /// Stage 1: referrer page visited before touching the site. + pub pre_navigation: Option, + /// Stage 2: the site's public entry page. + pub website_entry: Option, + /// Stage 3: how to reach the login page. + pub login_page: Option, +} + +/// How a journey reaches the login page. +#[derive(Clone, Debug)] +pub enum LoginPageTarget { + /// A fixed, known login URL. + Url(Url), + /// The login URL is dynamic (subject to change on the provider's side), so + /// instead of navigating blindly, wait for the previous stage's page to + /// load and follow the login link found on the page itself. + FollowLink { + /// CSS selector for the anchor that leads to the login page, + /// e.g. `a[href*="app.example.com/login"]`. + css_selector: String, + }, +} + +/// One concrete step for the login window driver, produced by +/// [`LoginJourney::plan`]. +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum NavigationAction { + /// Point the webview at a URL. + Navigate(Url), + /// Run a self-contained, idempotent script in the current page. The script + /// performs any further navigation itself (e.g. following a login link). + RunScript(String), +} + +impl LoginJourney { + /// An empty journey. Most sites should start from + /// [`LoginJourney::with_default_pre_navigation`] instead. + pub fn new() -> Self { + Self { + pre_navigation: None, + website_entry: None, + login_page: None, + } + } + + /// A journey that starts at the default referrer (Google). + pub fn with_default_pre_navigation() -> Self { + Self { + pre_navigation: Some(DEFAULT_PRE_NAVIGATION_URL.clone()), + ..Self::new() + } + } + + /// Set stage 2: the site's public entry page. + pub fn website_entry(mut self, url: Url) -> Self { + self.website_entry = Some(url); + self + } + + /// Set stage 3 to a fixed login URL. + pub fn login_page(mut self, url: Url) -> Self { + self.login_page = Some(LoginPageTarget::Url(url)); + self + } + + /// Set stage 3 to follow the login link discovered on the previous stage's + /// page (for sites whose login URL is subject to change). + pub fn login_page_via_link(mut self, css_selector: &str) -> Self { + self.login_page = Some(LoginPageTarget::FollowLink { + css_selector: css_selector.to_string(), + }); + self + } + + /// Flatten the present stages, in order, into driver actions. + pub fn plan(&self) -> Vec { + let mut actions = Vec::new(); + if let Some(url) = &self.pre_navigation { + actions.push(NavigationAction::Navigate(url.clone())); + } + if let Some(url) = &self.website_entry { + actions.push(NavigationAction::Navigate(url.clone())); + } + match &self.login_page { + Some(LoginPageTarget::Url(url)) => { + actions.push(NavigationAction::Navigate(url.clone())); + } + Some(LoginPageTarget::FollowLink { css_selector }) => { + actions.push(NavigationAction::RunScript(follow_link_script(css_selector))); + } + None => {} + } + actions + } + + /// The site-owned fixed URLs in the journey: the entry page and the login + /// page when it's a fixed URL. Excludes the pre-navigation referrer (a + /// third party) and discovered login pages (unknown until runtime). Used + /// to derive default cookie-capture origins. + pub fn site_urls(&self) -> Vec { + let mut urls = Vec::new(); + if let Some(url) = &self.website_entry { + urls.push(url.clone()); + } + if let Some(LoginPageTarget::Url(url)) = &self.login_page { + urls.push(url.clone()); + } + urls + } +} + +impl Default for LoginJourney { + fn default() -> Self { + Self::new() + } +} + +/// Build the in-page script that waits for the document to be ready, finds +/// the login link by CSS selector, and follows it. Self-contained and +/// idempotent: safe to inject more than once (a document swap between +/// injection and load wipes scripts, so the driver re-injects). +fn follow_link_script(css_selector: &str) -> String { + let selector_literal = + serde_json::to_string(css_selector).expect("string serializes to JSON"); + format!( + r#"(() => {{ + const SELECTOR = {selector_literal}; + const DEADLINE = Date.now() + {FOLLOW_LINK_TIMEOUT_MS}; + const follow = () => {{ + const link = document.querySelector(SELECTOR); + if (link) {{ + if (link.href) {{ + window.location.assign(link.href); + return; + }} + if (typeof link.click === 'function') {{ + link.click(); + return; + }} + }} + if (Date.now() < DEADLINE) {{ + setTimeout(follow, {FOLLOW_LINK_POLL_INTERVAL_MS}); + }} + }}; + if (document.readyState === 'loading') {{ + document.addEventListener('DOMContentLoaded', follow); + }} else {{ + follow(); + }} +}})();"# + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + const ENTRY_URL: &str = "https://example.com/"; + const LOGIN_URL: &str = "https://app.example.com/login"; + + fn url(value: &str) -> Url { + Url::parse(value).unwrap() + } + + mod plan_tests { + use super::*; + + #[test] + fn full_journey_flattens_in_stage_order() { + let journey = LoginJourney::with_default_pre_navigation() + .website_entry(url(ENTRY_URL)) + .login_page(url(LOGIN_URL)); + + assert_eq!(journey.plan(), vec![ + NavigationAction::Navigate(url("https://google.com")), + NavigationAction::Navigate(url(ENTRY_URL)), + NavigationAction::Navigate(url(LOGIN_URL)), + ]); + } + + #[test] + fn stages_are_optional() { + let journey = LoginJourney::new().website_entry(url(ENTRY_URL)); + + assert_eq!(journey.plan(), vec![ + NavigationAction::Navigate(url(ENTRY_URL)), + ]); + } + + #[test] + fn empty_journey_has_empty_plan() { + assert!(LoginJourney::new().plan().is_empty()); + } + + #[test] + fn follow_link_login_page_becomes_a_script_action() { + let journey = LoginJourney::new() + .website_entry(url(ENTRY_URL)) + .login_page_via_link("a[href*=\"app.example.com/login\"]"); + + let plan = journey.plan(); + assert_eq!(plan.len(), 2); + assert_eq!(plan[0], NavigationAction::Navigate(url(ENTRY_URL))); + match &plan[1] { + NavigationAction::RunScript(script) => { + assert!(script.contains(r#""a[href*=\"app.example.com/login\"]""#)); + assert!(script.contains("document.querySelector")); + } + other => panic!("expected RunScript, got {:?}", other), + } + } + } + + mod site_urls_tests { + use super::*; + + #[test] + fn excludes_referrer_and_discovered_login_pages() { + let fixed = LoginJourney::with_default_pre_navigation() + .website_entry(url(ENTRY_URL)) + .login_page(url(LOGIN_URL)); + assert_eq!(fixed.site_urls(), vec![url(ENTRY_URL), url(LOGIN_URL)]); + + let discovered = LoginJourney::with_default_pre_navigation() + .website_entry(url(ENTRY_URL)) + .login_page_via_link("a.login"); + assert_eq!(discovered.site_urls(), vec![url(ENTRY_URL)]); + } + } + + mod follow_link_script_tests { + use super::*; + + #[test] + fn escapes_selector_quotes() { + let script = follow_link_script(r#"a[href*="login"]"#); + assert!(script.contains(r#"const SELECTOR = "a[href*=\"login\"]";"#)); + } + + #[test] + fn waits_for_dom_and_polls() { + let script = follow_link_script("a.login"); + assert!(script.contains("DOMContentLoaded")); + assert!(script.contains("setTimeout(follow, 250)")); + assert!(script.contains("Date.now() + 30000")); + } + } +} diff --git a/crates/artcraftx/src/windows/login_window/login_window_thread.rs b/crates/artcraftx/src/windows/login_window/login_window_thread.rs new file mode 100644 index 00000000..6dcdbf74 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/login_window_thread.rs @@ -0,0 +1,174 @@ +use crate::commands::credentials::add_web_credential_command::{save_web_credential, WebCredentialSave}; +use crate::credentials::login_website::LoginWebsite; +use crate::events::basic_sendable_event_trait::BasicSendableEvent; +use crate::events::functional_events::refresh_account_state_event::RefreshAccountStateEvent; +use crate::windows::login_window::utils::extract_login_window_cookies::extract_login_window_cookies; +use crate::windows::login_window::utils::extract_user_info_from_cookies::extract_user_info_from_cookies; +use crate::windows::login_window::utils::grok_statsig_capture::read_captured_statsig; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use crate::windows::login_window::logins::login_site_for; +use crate::windows::login_window::open_login_window::login_window_name; +use crate::state::data_dir::app_data_root::AppDataRoot; +use errors::AnyhowResult; +use log::{error, info}; +use std::time::Duration; +use tauri::{AppHandle, Manager, WebviewWindow}; + +/// How often we poll the webview to see whether login has completed. +const POLL_INTERVAL: Duration = Duration::from_millis(2_000); + +/// Path fragments that mean "this is still a login / auth page", so we don't +/// treat it as the logged-in destination. Matched as substrings, so +/// `/login`, `/login/`, `/auth/sign-in`, etc. all count. +const LOGIN_PATH_FRAGMENTS: &[&str] = &["login", "signin", "sign-in"]; + +/// Watch a login webview until the user finishes signing in, then persist the +/// captured cookies (and any detected identity) and close the window. +/// +/// Exits when the window is gone (user closed it) or once cookies are saved. +pub async fn login_window_thread( + app: AppHandle, + app_data_root: AppDataRoot, + website: LoginWebsite, + maybe_target_credential_id: Option, +) { + let site = login_site_for(website); + let window_name = login_window_name(website); + + loop { + let login_webview_window = match app.get_webview_window(&window_name) { + Some(webview) => webview, + None => { + info!("Exit {} login thread (window gone).", website); + return; // NB: Only exit if we don't have the webview. + } + }; + + let result = check_login_window( + &app, + &login_webview_window, + &app_data_root, + website, + site.as_ref(), + maybe_target_credential_id.as_deref(), + ); + + match result { + Err(err) => { + error!("Error checking {} login window: {:?}", website, err); + } + Ok(false) => {} // Continue iteration and try again... + Ok(true) => { + info!("Saved {} cookies from login window. Closing.", website); + if let Err(err) = login_webview_window.close() { + error!("Error closing {} login window: {:?}", website, err); + } + return; + } + } + + tokio::time::sleep(POLL_INTERVAL).await; + } +} + +/// Returns `true` once cookies have been captured and saved (time to exit). +/// +/// Stateless by design: login is "done" when the webview is on a recognized +/// destination host, not on a login/auth page, and the session signal is +/// present. No cross-poll flags to get wrong. +fn check_login_window( + app_handle: &AppHandle, + webview_window: &WebviewWindow, + app_data_root: &AppDataRoot, + website: LoginWebsite, + site: &dyn LoginWindowSite, + maybe_target_credential_id: Option<&str>, +) -> AnyhowResult { + let url = webview_window.url()?; + let hostname = url.host_str().unwrap_or_default().to_string(); + let path = url.path().to_ascii_lowercase(); + + // Still on an SSO / identity host mid auth-flow: keep waiting. + if site.auth_flow_hostnames().contains(&hostname.as_str()) { + return Ok(false); + } + + // Capture only once we're on a logged-in destination page — a recognized + // host and not the login page itself. Substring path matching keeps this + // robust to www / trailing-slash / query-string redirects on the login URL. + let at_destination = site.destination_hostnames().contains(&hostname.as_str()); + let on_login_page = LOGIN_PATH_FRAGMENTS + .iter() + .any(|fragment| path.contains(fragment)); + + if !at_destination || on_login_page { + return Ok(false); + } + + let cookie_store = extract_login_window_cookies(webview_window, &site.cookie_urls())?; + + let session_cookie_names = site.session_cookie_names(); + let cookie_length = cookie_store.calculate_approx_cookie_character_length(); + + // When a site declares its session cookie name(s), their presence is the + // definitive "logged in" signal — cookies are cleared when the window opens, + // so a known session cookie can only appear after the user authenticates + // here. (Login pages set few, small cookies, so the size/count thresholds + // miss real logins; those are only a fallback for sites whose session cookie + // names we don't know.) + let has_captured_session = if session_cookie_names.is_empty() { + cookie_store.len() >= site.min_cookie_count() + && cookie_length >= site.min_cookie_char_length() + } else { + session_cookie_names.iter().any(|name| cookie_store.has_cookie(name)) + }; + + let cookie_names = cookie_store.cookie_names().join(", "); + info!( + "{} login check: host `{}`, path `{}`, cookies={} [{}], length={}, has_session={}", + website, hostname, path, cookie_store.len(), cookie_names, cookie_length, has_captured_session, + ); + + if !has_captured_session { + return Ok(false); + } + + // The cookies are the credential — everything below is best-effort and must + // never prevent the save. Both are plain `Option`s (no blocking, no `?`), so + // a missing identity or statsig just means those fields stay empty. + + // 1) Try to grab the account's extra information. + let maybe_user_info = extract_user_info_from_cookies(&cookie_store); + if let Some(user_info) = &maybe_user_info { + info!("Detected {} login identity: {:?}", website, user_info); + } + + // 2) Try to grab the statsig prerequisites the capture harness stashed (Grok + // only; other sites don't install it, so this is `None`). + let maybe_statsig = read_captured_statsig(webview_window); + if maybe_statsig.is_some() { + info!("Captured {} statsig material (seed)", website); + } + + // 3) Save the credential file to the credentials directory. + let credential = save_web_credential( + app_data_root.credentials_dir(), + WebCredentialSave { + service: site.credential_service(), + cookies: cookie_store, + maybe_user_info, + maybe_statsig, + maybe_user_agent: site.user_agent().map(str::to_string), + maybe_target_credential_id: maybe_target_credential_id.map(str::to_string), + }, + )?; + + info!("Saved {} credential to {:?}.", website, credential.source_path); + + let event = RefreshAccountStateEvent { + provider: website.generation_provider(), + }; + event.send_infallible(app_handle); + + Ok(true) +} diff --git a/crates/artcraftx/src/windows/login_window/login_window_trait.rs b/crates/artcraftx/src/windows/login_window/login_window_trait.rs new file mode 100644 index 00000000..e019b848 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/login_window_trait.rs @@ -0,0 +1,125 @@ +use core_types::enums::generation_source::GenerationSource; +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use reqwest::Url; + +/// Third-party SSO / identity provider hosts. When the webview is on one of +/// these we know the user is mid auth-flow (and has therefore left the login +/// page), so we never mistake it for the logged-in destination. +const DEFAULT_AUTH_FLOW_HOSTNAMES: &[&str] = &[ + "accounts.google.com", + "accounts.youtube.com", + "accounts.x.ai", + "auth.openai.com", + "appleid.apple.com", + "login.live.com", + "www.facebook.com", + "facebook.com", + "github.com", + "discord.com", + "x.com", + "twitter.com", +]; + +/// A website whose login flow the app can drive in an embedded webview. +/// +/// Implementors describe the navigation [`LoginJourney`] to the site's login +/// screen and how to recognize a completed login. Sensible defaults are +/// provided for the SSO host list, cookie origins, and the completion +/// heuristics; a site only overrides what differs. +/// +/// The driver executes [`journey`]'s plan, then the monitor thread watches +/// for [`destination_hostnames`] plus cookie signals to decide when the user +/// has finished. +pub trait LoginWindowSite: Send + Sync { + /// Which website this drives (also selects the credential service). + fn login_website(&self) -> LoginWebsite; + + /// Human-facing window title (e.g. "Login to Artcraft"). + fn window_title(&self) -> String; + + /// The navigation journey from a cold window to the site's login screen. + fn journey(&self) -> LoginJourney; + + /// Hosts that indicate the user has reached the logged-in destination. + /// e.g. `["app.getartcraft.com"]`. Note the login page is often on one of + /// these too, so this is combined with cookie heuristics — see + /// [`crate::windows::login_window::login_window_thread`]. + fn destination_hostnames(&self) -> &[&str]; + + /// The credential service that a successful login is saved under. + fn credential_service(&self) -> GenerationSource { + self.login_website().credential_service() + } + + /// An optional User-Agent override for the login webview. Return `Some` when + /// the site's sign-in misbehaves under the default WKWebView UA (e.g. Google + /// forcing a passkey step-up), or when the captured cookies must later be + /// replayed by an HTTP client under a specific UA (Cloudflare `cf_clearance` + /// is UA-bound, so the two must match). Defaults to the platform default. + fn user_agent(&self) -> Option<&'static str> { + None + } + + /// SSO / identity-provider hosts that mean "still logging in". + fn auth_flow_hostnames(&self) -> &[&str] { + DEFAULT_AUTH_FLOW_HOSTNAMES + } + + /// An optional JS initialization script injected before page scripts on every + /// load of the login webview. Used by Grok to install the passive statsig + /// capture harness. Defaults to none. + fn initialization_script(&self) -> Option { + None + } + + /// URLs whose cookies we read once the user appears logged in. Defaults to + /// the origins of the journey's site URLs plus the destination hostnames + /// (which covers sites whose login page is discovered at runtime). + fn cookie_urls(&self) -> Vec { + let mut urls: Vec = Vec::new(); + for url in self.journey().site_urls() { + let origin = origin_url(&url); + if !urls.contains(&origin) { + urls.push(origin); + } + } + for hostname in self.destination_hostnames() { + if let Ok(origin) = Url::parse(&format!("https://{hostname}/")) { + if !urls.contains(&origin) { + urls.push(origin); + } + } + } + urls + } + + /// Cookie names that, if present, strongly indicate a live session. When + /// non-empty, at least one must be present before we consider login done. + /// Empty by default (we fall back to size/count heuristics). + fn session_cookie_names(&self) -> &[&str] { + &[] + } + + /// Minimum number of cookies expected once logged in. + fn min_cookie_count(&self) -> usize { + 3 + } + + /// Minimum approximate cookie-header length (chars) expected once logged in. + /// Session/auth tokens are large, so a real login pushes well past a page's + /// baseline analytics cookies. + fn min_cookie_char_length(&self) -> usize { + 800 + } +} + +/// The scheme+host+port origin of a URL, with the path/query stripped — the +/// form Tauri's `cookies_for_url` expects. +pub fn origin_url(url: &Url) -> Url { + let mut origin = url.clone(); + origin.set_path("/"); + origin.set_query(None); + origin.set_fragment(None); + origin +} diff --git a/crates/artcraftx/src/windows/login_window/logins/artcraft_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/artcraft_login_window.rs new file mode 100644 index 00000000..c9f99cf3 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/artcraft_login_window.rs @@ -0,0 +1,59 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use once_cell::sync::Lazy; +use reqwest::Url; + +// NB(2026-07-31): Artcraft login is temporarily pointed at Storyteller's login +// instead of app.getartcraft.com. Artcraft is a Storyteller frontend backed by +// the same api.storyteller.ai, and its session cookies are scoped to +// `.storyteller.ai`, so a Storyteller login yields cookies valid for Artcraft +// too. The getartcraft.com page can't complete login inside the webview because +// it detects Tauri and routes auth through the Rust HTTP proxy (unavailable in +// this window); the Storyteller login form works directly. Revisit when the +// Artcraft web login is reachable natively. +// +// We use the classic storyteller.ai/login page rather than the studio SPA: the +// studio app runs a GPU-detection step (detect-gpu) on load that can stall +// inside the webview and never redirect off /login, starving the completion +// heuristic. The classic login does a plain post-login redirect. +const DESTINATION_HOSTNAMES: &[&str] = + &["storyteller.ai", "www.storyteller.ai", "studio.storyteller.ai"]; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://storyteller.ai/").expect("URL should parse") +}); + +static LOGIN_PAGE_URL: Lazy = Lazy::new(|| { + Url::parse("https://storyteller.ai/login").expect("URL should parse") +}); + +pub struct ArtCraftLoginWindow; + +impl LoginWindowSite for ArtCraftLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::ArtCraft + } + + fn window_title(&self) -> String { + "Login to Artcraft".to_string() + } + + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + .login_page(LOGIN_PAGE_URL.clone()) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } + + // The Storyteller/Artcraft backend session is the cookie named `session` + // (see artcraft_client's StorytellerSessionCookie). Its presence on the + // destination host, after leaving the login page, is the definitive + // "logged in" signal. + fn session_cookie_names(&self) -> &[&str] { + &["session"] + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/higgsfield_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/higgsfield_login_window.rs new file mode 100644 index 00000000..8b3fd52d --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/higgsfield_login_window.rs @@ -0,0 +1,56 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use higgsfield_client::client::higgsfield_browser_profile::HIGGSFIELD_USER_AGENT; +use once_cell::sync::Lazy; +use reqwest::Url; + +const DESTINATION_HOSTNAMES: &[&str] = &["higgsfield.ai", "www.higgsfield.ai"]; + +/// Clerk's session JWT cookie, set on higgsfield.ai only while signed in. +const CLERK_SESSION_COOKIE: &str = "__session"; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://higgsfield.ai/").expect("URL should parse") +}); + +pub struct HiggsfieldLoginWindow; + +impl LoginWindowSite for HiggsfieldLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::Higgsfield + } + + fn window_title(&self) -> String { + "Login to Higgsfield".to_string() + } + + /// Higgsfield has no distinct login page — the entry page hosts the login. + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } + + // The SAME User-Agent `higgsfield_client` replays the cookies under. + // Cloudflare's `cf_clearance` and DataDome's `datadome` cookies are bound + // to the UA (and checked against the browser fingerprint), so the webview + // that earns them and the client that spends them must match. The UA is + // also recorded on the credential so the client can follow it exactly. + fn user_agent(&self) -> Option<&'static str> { + Some(HIGGSFIELD_USER_AGENT) + } + + // Higgsfield's auth is Clerk. The logged-OUT homepage already sets several + // large cookies (DataDome, analytics), so the size/count fallback fires + // before the user can sign in. Clerk only writes the `__session` JWT cookie + // on higgsfield.ai once a session is active, so that's the login signal. + // (`__client` on clerk.higgsfield.ai exists even signed out, and + // `__client_uat` is present as "0" when signed out — neither is usable.) + fn session_cookie_names(&self) -> &[&str] { + &[CLERK_SESSION_COOKIE] + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/magnific_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/magnific_login_window.rs new file mode 100644 index 00000000..f32efbea --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/magnific_login_window.rs @@ -0,0 +1,38 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use once_cell::sync::Lazy; +use reqwest::Url; + +const DESTINATION_HOSTNAMES: &[&str] = &["magnific.com", "www.magnific.com"]; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://www.magnific.com/").expect("URL should parse") +}); + +static LOGIN_PAGE_URL: Lazy = Lazy::new(|| { + Url::parse("https://www.magnific.com/log-in?client_id=magnific&lang=eno") + .expect("URL should parse") +}); + +pub struct MagnificLoginWindow; + +impl LoginWindowSite for MagnificLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::Magnific + } + + fn window_title(&self) -> String { + "Login to Magnific".to_string() + } + + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + .login_page(LOGIN_PAGE_URL.clone()) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/midjourney_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/midjourney_login_window.rs new file mode 100644 index 00000000..c82a302e --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/midjourney_login_window.rs @@ -0,0 +1,52 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::services::midjourney::utils::midjourney_browser_profile::MIDJOURNEY_USER_AGENT; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use once_cell::sync::Lazy; +use reqwest::Url; + +const DESTINATION_HOSTNAMES: &[&str] = &["www.midjourney.com", "midjourney.com"]; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://www.midjourney.com/").expect("URL should parse") +}); + +pub struct MidjourneyLoginWindow; + +impl LoginWindowSite for MidjourneyLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::Midjourney + } + + fn window_title(&self) -> String { + "Login to Midjourney".to_string() + } + + /// Midjourney has no discrete login page — the entry page hosts the login. + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } + + // Google's sign-in forces a passkey step-up under the default WKWebView UA + // (which the embedded browser can't satisfy). Present a mainstream desktop + // Safari UA — the SAME one the Midjourney HTTP/websocket calls use — so the + // captured cf_clearance cookie validates when those calls replay it. + fn user_agent(&self) -> Option<&'static str> { + Some(MIDJOURNEY_USER_AGENT) + } + + // Midjourney's session rides in the AuthUserTokenV3 cookie pair (the same + // names midjourney_client's cookie_store_has_auth_cookies checks); either + // appearing in a cookie-cleared window is the definitive login signal. + fn session_cookie_names(&self) -> &[&str] { + &[ + "__Host-Midjourney.AuthUserTokenV3_i", + "__Host-Midjourney.AuthUserTokenV3_r", + ] + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/mod.rs b/crates/artcraftx/src/windows/login_window/logins/mod.rs new file mode 100644 index 00000000..f04c2e01 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/mod.rs @@ -0,0 +1,173 @@ +pub mod artcraft_login_window; +pub mod higgsfield_login_window; +pub mod magnific_login_window; +pub mod midjourney_login_window; +pub mod openart_login_window; +pub mod runway_login_window; +pub mod xai_login_window; + +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use crate::windows::login_window::logins::artcraft_login_window::ArtCraftLoginWindow; +use crate::windows::login_window::logins::higgsfield_login_window::HiggsfieldLoginWindow; +use crate::windows::login_window::logins::magnific_login_window::MagnificLoginWindow; +use crate::windows::login_window::logins::midjourney_login_window::MidjourneyLoginWindow; +use crate::windows::login_window::logins::openart_login_window::OpenArtLoginWindow; +use crate::windows::login_window::logins::runway_login_window::RunwayLoginWindow; +use crate::windows::login_window::logins::xai_login_window::GrokLoginWindow; + +/// Resolve the [`LoginWindowSite`] driver for a website. +pub fn login_site_for(website: LoginWebsite) -> Box { + match website { + LoginWebsite::ArtCraft => Box::new(ArtCraftLoginWindow), + LoginWebsite::OpenArt => Box::new(OpenArtLoginWindow), + LoginWebsite::Higgsfield => Box::new(HiggsfieldLoginWindow), + LoginWebsite::Runway => Box::new(RunwayLoginWindow), + LoginWebsite::Magnific => Box::new(MagnificLoginWindow), + LoginWebsite::Midjourney => Box::new(MidjourneyLoginWindow), + LoginWebsite::XAi => Box::new(GrokLoginWindow), + } +} + +// Journeys and plans are plain values, so every site's navigation flow is +// validated here without touching the network. +#[cfg(test)] +mod tests { + use super::*; + use crate::windows::login_window::login_journey::NavigationAction; + + const ALL_WEBSITES: &[LoginWebsite] = &[ + LoginWebsite::ArtCraft, + LoginWebsite::OpenArt, + LoginWebsite::Higgsfield, + LoginWebsite::Runway, + LoginWebsite::Magnific, + LoginWebsite::Midjourney, + LoginWebsite::XAi, + ]; + + #[test] + fn every_site_journey_starts_with_a_navigation() { + for website in ALL_WEBSITES { + let plan = login_site_for(*website).journey().plan(); + assert!(!plan.is_empty(), "{website} journey is empty"); + assert!( + matches!(plan.first(), Some(NavigationAction::Navigate(_))), + "{website} journey must start with a navigation", + ); + } + } + + #[test] + fn every_site_has_cookie_urls_covering_its_destinations() { + for website in ALL_WEBSITES { + let site = login_site_for(*website); + let cookie_hosts: Vec = site.cookie_urls() + .iter() + .map(|url| url.host_str().unwrap_or_default().to_string()) + .collect(); + for hostname in site.destination_hostnames() { + assert!( + cookie_hosts.iter().any(|host| host == hostname), + "{website} cookie urls {cookie_hosts:?} miss destination {hostname}", + ); + } + } + } + + #[test] + fn openart_journey() { + let plan = login_site_for(LoginWebsite::OpenArt).journey().plan(); + assert_eq!(plan.len(), 3); + assert_navigates_to(&plan[1], "openart.ai", "/"); + assert_navigates_to(&plan[2], "openart.ai", "/home"); + } + + #[test] + fn higgsfield_journey_has_no_login_page() { + let plan = login_site_for(LoginWebsite::Higgsfield).journey().plan(); + assert_eq!(plan.len(), 2); + assert_navigates_to(&plan[1], "higgsfield.ai", "/"); + } + + #[test] + fn higgsfield_waits_for_the_clerk_session_cookie() { + // Without a named session cookie the size/count fallback would fire on + // the logged-out homepage and close the window before login. + let site = login_site_for(LoginWebsite::Higgsfield); + assert_eq!(site.session_cookie_names(), &["__session"]); + } + + #[test] + fn cookie_replaying_sites_pin_the_user_agent_their_clients_use() { + use grok_consumer_client::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; + use higgsfield_client::client::higgsfield_browser_profile::HIGGSFIELD_USER_AGENT; + use crate::services::midjourney::utils::midjourney_browser_profile::MIDJOURNEY_USER_AGENT; + + assert_eq!(login_site_for(LoginWebsite::Higgsfield).user_agent(), Some(HIGGSFIELD_USER_AGENT)); + assert_eq!(login_site_for(LoginWebsite::XAi).user_agent(), Some(FIREFOX_143_MAC_USER_AGENT)); + assert_eq!(login_site_for(LoginWebsite::Midjourney).user_agent(), Some(MIDJOURNEY_USER_AGENT)); + } + + #[test] + fn midjourney_journey_has_no_login_page() { + let plan = login_site_for(LoginWebsite::Midjourney).journey().plan(); + assert_eq!(plan.len(), 2); + assert_navigates_to(&plan[1], "www.midjourney.com", "/"); + } + + #[test] + fn midjourney_waits_for_the_auth_token_cookies() { + let site = login_site_for(LoginWebsite::Midjourney); + assert_eq!(site.session_cookie_names(), &[ + "__Host-Midjourney.AuthUserTokenV3_i", + "__Host-Midjourney.AuthUserTokenV3_r", + ]); + } + + #[test] + fn runway_journey_discovers_the_login_link() { + let plan = login_site_for(LoginWebsite::Runway).journey().plan(); + assert_eq!(plan.len(), 3); + assert_navigates_to(&plan[1], "runwayml.com", "/"); + match &plan[2] { + NavigationAction::RunScript(script) => { + assert!(script.contains("app.runwayml.com/login")); + } + other => panic!("expected RunScript, got {other:?}"), + } + } + + #[test] + fn magnific_journey() { + let plan = login_site_for(LoginWebsite::Magnific).journey().plan(); + assert_eq!(plan.len(), 3); + assert_navigates_to(&plan[1], "www.magnific.com", "/"); + match &plan[2] { + NavigationAction::Navigate(url) => { + assert_eq!(url.host_str(), Some("www.magnific.com")); + assert_eq!(url.path(), "/log-in"); + assert_eq!(url.query(), Some("client_id=magnific&lang=eno")); + } + other => panic!("expected Navigate, got {other:?}"), + } + } + + #[test] + fn grok_journey() { + let plan = login_site_for(LoginWebsite::XAi).journey().plan(); + assert_eq!(plan.len(), 3); + assert_navigates_to(&plan[1], "grok.com", "/"); + assert_navigates_to(&plan[2], "accounts.x.ai", "/sign-in"); + } + + fn assert_navigates_to(action: &NavigationAction, host: &str, path: &str) { + match action { + NavigationAction::Navigate(url) => { + assert_eq!(url.host_str(), Some(host)); + assert_eq!(url.path(), path); + } + other => panic!("expected Navigate to {host}{path}, got {other:?}"), + } + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/openart_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/openart_login_window.rs new file mode 100644 index 00000000..0f7bb21b --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/openart_login_window.rs @@ -0,0 +1,37 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use once_cell::sync::Lazy; +use reqwest::Url; + +const DESTINATION_HOSTNAMES: &[&str] = &["openart.ai", "www.openart.ai"]; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://openart.ai/").expect("URL should parse") +}); + +static LOGIN_PAGE_URL: Lazy = Lazy::new(|| { + Url::parse("https://openart.ai/home").expect("URL should parse") +}); + +pub struct OpenArtLoginWindow; + +impl LoginWindowSite for OpenArtLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::OpenArt + } + + fn window_title(&self) -> String { + "Login to OpenArt".to_string() + } + + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + .login_page(LOGIN_PAGE_URL.clone()) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/runway_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/runway_login_window.rs new file mode 100644 index 00000000..e0f60c13 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/runway_login_window.rs @@ -0,0 +1,38 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use once_cell::sync::Lazy; +use reqwest::Url; + +const DESTINATION_HOSTNAMES: &[&str] = &["app.runwayml.com"]; + +/// The homepage's login button. Runway's login URL carries volatile +/// tracking/consent query parameters, so we discover it from the page rather +/// than hardcode it. +const LOGIN_LINK_SELECTOR: &str = r#"a[href*="app.runwayml.com/login"]"#; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://runwayml.com/").expect("URL should parse") +}); + +pub struct RunwayLoginWindow; + +impl LoginWindowSite for RunwayLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::Runway + } + + fn window_title(&self) -> String { + "Login to Runway".to_string() + } + + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + .login_page_via_link(LOGIN_LINK_SELECTOR) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } +} diff --git a/crates/artcraftx/src/windows/login_window/logins/xai_login_window.rs b/crates/artcraftx/src/windows/login_window/logins/xai_login_window.rs new file mode 100644 index 00000000..b136f56f --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/logins/xai_login_window.rs @@ -0,0 +1,63 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::LoginJourney; +use crate::windows::login_window::login_window_trait::LoginWindowSite; +use crate::windows::login_window::utils::grok_statsig_capture::grok_statsig_init_script; +use grok_consumer_client::client::browser_user_agents::FIREFOX_143_MAC_USER_AGENT; +use once_cell::sync::Lazy; +use reqwest::Url; + +const DESTINATION_HOSTNAMES: &[&str] = &["grok.com", "www.grok.com"]; + +static WEBSITE_ENTRY_URL: Lazy = Lazy::new(|| { + Url::parse("https://grok.com/").expect("URL should parse") +}); + +// The xAI SSO sign-in page that redirects back to grok.com once authenticated. +// accounts.x.ai is in the default auth-flow hostnames, so time spent here counts +// as "still logging in" until the webview returns to grok.com. +static LOGIN_PAGE_URL: Lazy = Lazy::new(|| { + Url::parse("https://accounts.x.ai/sign-in?redirect=grok-com&return_to=%2F%3Fq%3D%26reasoningMode%3Dnone%26voice%3Dfalse") + .expect("URL should parse") +}); + +/// The Grok website login (stored under the `xai` credential service). +pub struct GrokLoginWindow; + +impl LoginWindowSite for GrokLoginWindow { + fn login_website(&self) -> LoginWebsite { + LoginWebsite::XAi + } + + fn window_title(&self) -> String { + "Login to Grok".to_string() + } + + fn journey(&self) -> LoginJourney { + LoginJourney::with_default_pre_navigation() + .website_entry(WEBSITE_ENTRY_URL.clone()) + .login_page(LOGIN_PAGE_URL.clone()) + } + + fn destination_hostnames(&self) -> &[&str] { + DESTINATION_HOSTNAMES + } + + // grok.com sits behind Cloudflare, whose `cf_clearance` cookie is bound to + // the User-Agent. `grok_consumer_client` sends every request (and the image + // websocket upgrade) as Firefox 143 on macOS, so the webview that earns the + // clearance must present the same UA. + fn user_agent(&self) -> Option<&'static str> { + Some(FIREFOX_143_MAC_USER_AGENT) + } + + // NB: Grok's session rides in the xAI SSO cookies (`sso`/`sso-rw`), but rather + // than gate the save on exact names we don't fully control, we use the + // default size/count heuristic — a logged-in grok.com page carries far more + // cookie data than the login redirect, so a real login is unmistakable, and + // we never fail to save just because a cookie name changed. + + // Install the passive statsig-capture harness from first page load. + fn initialization_script(&self) -> Option { + Some(grok_statsig_init_script()) + } +} diff --git a/crates/artcraftx/src/windows/login_window/mod.rs b/crates/artcraftx/src/windows/login_window/mod.rs new file mode 100644 index 00000000..5da0408f --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/mod.rs @@ -0,0 +1,21 @@ +//! Cookie-based web login windows for third-party sites. +//! +//! The frontend triggers a login for a [`crate::credentials::login_website::LoginWebsite`] +//! (via `open_web_login_command`). This module opens a fresh, cookie-cleared +//! Tauri webview and drives it through the site's [`login_journey::LoginJourney`] +//! — optional pre-navigation referrer, website entry page, then the login +//! page (fixed or discovered on-page) — see [`open_login_window`]. A +//! background thread ([`login_window_thread`]) then watches until the user +//! finishes signing in. Captured cookies (plus any username/email decoded +//! from a cookie JWT) are saved to the credentials directory as a cookie +//! [`crate::credentials::auth_credential::AuthCredential`]. +//! +//! Each supported site implements [`login_window_trait::LoginWindowSite`] +//! under [`logins`], describing its journey and completion heuristics. + +pub mod login_journey; +pub mod login_window_thread; +pub mod login_window_trait; +pub mod logins; +pub mod open_login_window; +pub mod utils; diff --git a/crates/artcraftx/src/windows/login_window/open_login_window.rs b/crates/artcraftx/src/windows/login_window/open_login_window.rs new file mode 100644 index 00000000..c44ea45b --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/open_login_window.rs @@ -0,0 +1,182 @@ +use crate::credentials::login_website::LoginWebsite; +use crate::windows::login_window::login_journey::NavigationAction; +use crate::windows::login_window::login_window_thread::login_window_thread; +use crate::windows::login_window::logins::login_site_for; +use crate::state::data_dir::app_data_root::AppDataRoot; +use crate::utils::window::clear_all_webview_cookies::clear_all_webview_cookies; +use anyhow::anyhow; +use errors::AnyhowResult; +use reqwest::Url; +use std::time::Duration; +use tauri::{AppHandle, Manager, Runtime, Webview, WebviewUrl, WebviewWindowBuilder}; + +/// Brief pause between navigations so each page settles (and to dodge +/// Cloudflare interstitials that trip on instant redirects). +const NAVIGATION_DELAY: Duration = Duration::from_millis(100); + +/// How long we wait for a page to arrive before injecting a discovery script. +const PAGE_ARRIVAL_TIMEOUT: Duration = Duration::from_secs(15); + +/// How often we poll the webview URL while waiting for a page to arrive. +const PAGE_ARRIVAL_POLL_INTERVAL: Duration = Duration::from_millis(250); + +/// How many times a discovery script is re-injected. A document swap between +/// injection and page load wipes the script, so we inject repeatedly (the +/// script is idempotent) until the page navigates or attempts run out. +const SCRIPT_INJECTION_ATTEMPTS: u32 = 5; + +/// Pause between discovery-script injections. +const SCRIPT_INJECTION_INTERVAL: Duration = Duration::from_secs(1); + +/// Open a fresh, cookie-cleared login window for a website and start watching +/// it. The site's [`crate::windows::login_window::login_journey::LoginJourney`] +/// drives the webview to the login screen, then a background thread captures +/// cookies once the user finishes. See [`login_window_thread`]. +pub async fn open_login_window( + app: &AppHandle, + app_data_root: &AppDataRoot, + website: LoginWebsite, + maybe_target_credential_id: Option, +) -> AnyhowResult<()> { + let window_name = login_window_name(website); + if app.get_window(&window_name).is_some() { + return Err(anyhow!("{} login window already open", website)); + } + + let site = login_site_for(website); + let plan = site.journey().plan(); + + // The window itself opens on the journey's first URL, so the first action + // must be a navigation (a script has no page to run against yet). + let first_url = match plan.first() { + Some(NavigationAction::Navigate(url)) => url.clone(), + Some(NavigationAction::RunScript(_)) => { + return Err(anyhow!("{} login journey must start with a navigation", website)); + } + None => return Err(anyhow!("{} login journey is empty", website)), + }; + + let start_url = WebviewUrl::External(first_url); + let mut builder = WebviewWindowBuilder::new(app, &window_name, start_url) + .title(site.window_title()) + .center() + .resizable(true) + .visible(true) + .closable(true) + .min_inner_size(200.0, 800.0) + .focused(true) + .devtools(true); + + // Some sites (e.g. Midjourney, whose Google sign-in otherwise forces a + // passkey step-up that the default WKWebView can't satisfy) need a + // mainstream desktop User-Agent. It must match the UA the site's HTTP client + // later uses, since Cloudflare's cf_clearance is UA-bound. + if let Some(user_agent) = site.user_agent() { + builder = builder.user_agent(user_agent); + } + + // An optional init script that runs before page scripts on every load (Grok + // uses it to install the passive statsig-capture harness). + if let Some(script) = site.initialization_script() { + builder = builder.initialization_script(&script); + } + + let window = builder.build()?; + + let webview = window.get_webview(&window_name) + .ok_or_else(|| anyhow!("no webview found"))?; + + // Start every login from a clean slate — no stale cookies/state. + clear_all_webview_cookies(&webview)?; + + run_navigation_actions(&webview, &plan[1..]).await?; + + let app_handle = app.clone(); + let app_data_root = app_data_root.clone(); + + let _ = tauri::async_runtime::spawn(async move { + login_window_thread(app_handle, app_data_root, website, maybe_target_credential_id).await; + }); + + Ok(()) +} + +/// The unique Tauri window label for a website's login window. +pub fn login_window_name(website: LoginWebsite) -> String { + format!("{}_login_window", website.to_str()) +} + +/// Execute the remainder of a journey plan against an open webview. +async fn run_navigation_actions( + webview: &Webview, + actions: &[NavigationAction], +) -> AnyhowResult<()> { + // The most recent page we deliberately navigated to; discovery scripts run + // against this page, so we wait for it to arrive before injecting. + let mut current_page: Option = None; + + for action in actions { + match action { + NavigationAction::Navigate(url) => { + tokio::time::sleep(NAVIGATION_DELAY).await; + webview.navigate(url.clone())?; + current_page = Some(url.clone()); + } + NavigationAction::RunScript(script) => { + let page = current_page.as_ref() + .ok_or_else(|| anyhow!("script action requires a preceding navigation"))?; + wait_for_page_arrival(webview, page).await; + inject_script_until_navigation(webview, script).await?; + } + } + } + Ok(()) +} + +/// Wait (bounded) until the webview lands on the host we navigated to, so a +/// discovery script runs against the intended page rather than its +/// predecessor. Falls through on timeout — the script also self-waits. +async fn wait_for_page_arrival(webview: &Webview, page: &Url) { + let deadline = tokio::time::Instant::now() + PAGE_ARRIVAL_TIMEOUT; + let expected_host = normalized_host(page); + + while tokio::time::Instant::now() < deadline { + if let Ok(url) = webview.url() { + if normalized_host(&url) == expected_host { + return; + } + } + tokio::time::sleep(PAGE_ARRIVAL_POLL_INTERVAL).await; + } +} + +/// Inject an idempotent discovery script, re-injecting a few times in case a +/// document swap wiped it, and stopping early once the page navigates away +/// (i.e. the script did its job or the user moved on). +async fn inject_script_until_navigation( + webview: &Webview, + script: &str, +) -> AnyhowResult<()> { + let starting_url = webview.url()?; + + for _ in 0..SCRIPT_INJECTION_ATTEMPTS { + webview.eval(script)?; + tokio::time::sleep(SCRIPT_INJECTION_INTERVAL).await; + if webview.url()? != starting_url { + return Ok(()); + } + } + + // Not navigated yet — the last injected script keeps polling in-page, and + // the monitor thread takes over from here. + Ok(()) +} + +/// Hostname with any `www.` prefix stripped, so redirects between the bare +/// and `www.` forms of a site still count as arrival. +fn normalized_host(url: &Url) -> String { + url.host_str() + .unwrap_or_default() + .trim_start_matches("www.") + .to_string() +} diff --git a/crates/artcraftx/src/windows/login_window/utils/extract_login_window_cookies.rs b/crates/artcraftx/src/windows/login_window/utils/extract_login_window_cookies.rs new file mode 100644 index 00000000..485f6779 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/utils/extract_login_window_cookies.rs @@ -0,0 +1,92 @@ +use crate::windows::login_window::utils::grok_statsig_capture::STATSIG_CAPTURE_COOKIE; +use cookie_store_wrapper::cookie_store::{CapturedCookie, CookieStore}; +use errors::AnyhowResult; +use reqwest::Url; +use tauri::WebviewWindow; + +/// Collect the webview's cookies for the given URLs' domains into a +/// [`CookieStore`]. +/// +/// We read the *entire* cookie store (`webview.cookies()`) and match domains +/// ourselves rather than using `webview.cookies_for_url()`. wry's +/// `cookies_for_url` filters with an exact `cookie.domain() == url.domain()` +/// comparison, but session cookies are usually set on the parent domain with a +/// leading dot (e.g. `.storyteller.ai`, so they reach `api.storyteller.ai`). +/// That never equals the bare host (`storyteller.ai`), so `cookies_for_url` +/// silently drops exactly the auth cookie we need. `cookies()` returns +/// everything (including HttpOnly cookies), so we filter it correctly here. +pub fn extract_login_window_cookies( + webview: &WebviewWindow, + cookie_urls: &[Url], +) -> AnyhowResult { + let Some(fallback_url) = cookie_urls.first() else { + return Ok(CookieStore::empty()); + }; + + let hosts: Vec = cookie_urls + .iter() + .filter_map(|url| url.host_str().map(|host| host.to_ascii_lowercase())) + .collect(); + + let mut cookie_store = CookieStore::empty(); + for cookie in webview.cookies()?.iter() { + // The Grok statsig-capture harness stashes its output in a client-only + // cookie; never persist it into the saved session. + if cookie.name() == STATSIG_CAPTURE_COOKIE { + continue; + } + if cookie_domain_matches(cookie.domain(), &hosts) { + cookie_store.insert_captured( + CapturedCookie { + name: cookie.name().to_string(), + value: cookie.value().to_string(), + maybe_domain: cookie.domain().map(str::to_string), + maybe_path: cookie.path().map(str::to_string), + }, + fallback_url, + ); + } + } + Ok(cookie_store) +} + +/// Whether a cookie's domain applies to any target host, ignoring a leading +/// dot. A parent-domain cookie (`storyteller.ai`) applies to its subdomains +/// (`studio.storyteller.ai`), and — for our capture purposes — we also keep a +/// subdomain cookie when matching against the parent host. The leading `.` +/// guards against partial-label matches (`evilstoryteller.ai`). +fn cookie_domain_matches(cookie_domain: Option<&str>, hosts: &[String]) -> bool { + let Some(domain) = cookie_domain else { + return false; + }; + let domain = domain.trim_start_matches('.').to_ascii_lowercase(); + if domain.is_empty() { + return false; + } + hosts.iter().any(|host| { + *host == domain + || host.ends_with(&format!(".{domain}")) + || domain.ends_with(&format!(".{host}")) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn matches_parent_domain_cookie_with_leading_dot() { + let hosts = vec!["storyteller.ai".to_string()]; + assert!(cookie_domain_matches(Some(".storyteller.ai"), &hosts)); + assert!(cookie_domain_matches(Some("storyteller.ai"), &hosts)); + assert!(cookie_domain_matches(Some("studio.storyteller.ai"), &hosts)); + } + + #[test] + fn rejects_unrelated_and_lookalike_domains() { + let hosts = vec!["storyteller.ai".to_string()]; + assert!(!cookie_domain_matches(Some("google.com"), &hosts)); + assert!(!cookie_domain_matches(Some("evilstoryteller.ai"), &hosts)); + assert!(!cookie_domain_matches(None, &hosts)); + } +} diff --git a/crates/artcraftx/src/windows/login_window/utils/extract_user_info_from_cookies.rs b/crates/artcraftx/src/windows/login_window/utils/extract_user_info_from_cookies.rs new file mode 100644 index 00000000..a0fef08c --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/utils/extract_user_info_from_cookies.rs @@ -0,0 +1,93 @@ +use crate::credentials::credential_user_info::CredentialUserInfo; +use base64::prelude::BASE64_URL_SAFE_NO_PAD; +use base64::Engine; +use cookie_store_wrapper::cookie_store::CookieStore; +use serde_json::Value; + +/// JSON claim keys that may carry an email address, most specific first. +const EMAIL_CLAIM_KEYS: &[&str] = &["email", "email_address", "user_email"]; + +/// JSON claim keys that may carry a human username / handle. +const USERNAME_CLAIM_KEYS: &[&str] = &["username", "preferred_username", "name", "nickname"]; + +/// Best-effort identity extraction from a freshly captured cookie set. +/// +/// Providers frequently drop a JWT (session token, id token, etc.) as one of +/// the cookies. We do not verify it — we only decode the payload to read a +/// username/email so the saved credential can be told apart from other +/// accounts. Returns `None` when nothing identifiable is found. +pub fn extract_user_info_from_cookies(cookie_store: &CookieStore) -> Option { + for (_name, value) in cookie_store.iter_name_values() { + let Some(claims) = decode_jwt_payload(value) else { + continue; + }; + + let email = first_string_claim(&claims, EMAIL_CLAIM_KEYS) + .filter(|value| value.contains('@')); + let username = first_string_claim(&claims, USERNAME_CLAIM_KEYS); + + if email.is_some() || username.is_some() { + return Some(CredentialUserInfo { username, email }); + } + } + None +} + +/// Decode the (unverified) claims of a value that looks like a JWT. +fn decode_jwt_payload(value: &str) -> Option { + let mut parts = value.split('.'); + let _header = parts.next()?; + let payload = parts.next()?; + let _signature = parts.next()?; + if parts.next().is_some() { + return None; // Not a 3-part token. + } + + let bytes = BASE64_URL_SAFE_NO_PAD.decode(payload).ok()?; + serde_json::from_slice(&bytes).ok() +} + +/// The first non-empty string value among the given claim keys. +fn first_string_claim(claims: &Value, keys: &[&str]) -> Option { + for key in keys { + if let Some(value) = claims.get(key).and_then(Value::as_str) { + let value = value.trim(); + if !value.is_empty() { + return Some(value.to_string()); + } + } + } + None +} + +#[cfg(test)] +mod tests { + use super::*; + use reqwest::Url; + + // Payload: {"email":"echelon@gmail.com","username":"echelon","exp":1,"iat":1} + const JWT_WITH_EMAIL: &str = "eyJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImVjaGVsb25AZ21haWwuY29tIiwidXNlcm5hbWUiOiJlY2hlbG9uIiwiZXhwIjoxLCJpYXQiOjF9.abc"; + + #[test] + fn extracts_email_and_username_from_jwt_cookie() { + let url = site_url(); + let mut store = CookieStore::empty(); + store.insert_named("session", JWT_WITH_EMAIL, &url); + store.insert_named("analytics", "not-a-jwt", &url); + + let info = extract_user_info_from_cookies(&store).unwrap(); + assert_eq!(info.email.as_deref(), Some("echelon@gmail.com")); + assert_eq!(info.username.as_deref(), Some("echelon")); + } + + #[test] + fn returns_none_without_identifiable_claims() { + let mut store = CookieStore::empty(); + store.insert_named("plain", "opaque-token", &site_url()); + assert!(extract_user_info_from_cookies(&store).is_none()); + } + + fn site_url() -> Url { + Url::parse("https://provider.example/").unwrap() + } +} diff --git a/crates/artcraftx/src/windows/login_window/utils/grok_statsig_capture.rs b/crates/artcraftx/src/windows/login_window/utils/grok_statsig_capture.rs new file mode 100644 index 00000000..889405b7 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/utils/grok_statsig_capture.rs @@ -0,0 +1,128 @@ +//! Passive `x-statsig-id` capture during the Grok login. +//! +//! An initialization script installs `grok_consumer_statsig`'s observing +//! harness on the login page from first load, stashing each captured +//! `x-statsig-id` into a cookie — the only Rust-visible channel out of an +//! external webview in the login flow. After login the freshest capture is +//! decoded into storable pieces (seed, key, timestamp, …) via the library. +//! +//! This is deliberately passive: it records whatever signed request the page +//! makes on its own (no generation is triggered), so the stored statsig is a +//! session sample, not necessarily the video endpoint's. + +use crate::credentials::cookie_credential_grok_extra_pieces::GrokStatsigCapture; +use chrono::{DateTime, Utc}; +use grok_consumer_statsig::statsig_cache_file::decode_statsig; +use grok_consumer_statsig::{StatsigMaterial, MINT_HARNESS_SCRIPT}; +use tauri::WebviewWindow; + +/// Cookie the capture harness stashes the latest statsig report into. Skipped +/// when persisting login cookies (see `extract_login_window_cookies`). +pub const STATSIG_CAPTURE_COOKIE: &str = "__artcraft_statsig_capture"; + +/// The Grok login webview's initialization script: define a cookie sink, then +/// install the observing harness. Runs before page scripts on every load, so it +/// catches the page's signed requests from the first one. +/// +/// The harness reports `{method, path, statsigId, capturedAt}` JSON to +/// `window.__grokStatsigReport`; the sink flattens it into a cookie-safe +/// `method|path|statsigId|capturedAt` string (base64 statsig ids never contain +/// `|`), which [`read_captured_statsig`] reads back. +pub fn grok_statsig_init_script() -> String { + // Guard to grok.com only: the harness must never run on the accounts.x.ai + // sign-in page, where wrapping fetch/XHR could interfere with the login flow. + format!( + r#"if (location.hostname.indexOf("grok.com") !== -1) {{ + (function () {{ + window.__grokStatsigReport = function (json) {{ + try {{ + var o = JSON.parse(json); + var packed = [o.method, o.path, o.statsigId, o.capturedAt].join("|"); + document.cookie = "{cookie}=" + packed + "; path=/; max-age=3600"; + }} catch (e) {{ /* never break the page */ }} + }}; + }})(); + {harness} +}}"#, + cookie = STATSIG_CAPTURE_COOKIE, + harness = MINT_HARNESS_SCRIPT, + ) +} + +/// Read the freshest statsig the harness captured: the signed `x-statsig-id` +/// itself (what requests send) plus the reusable [`StatsigMaterial`] (the seed) +/// decoded from it, if any. +/// +/// The captured signature yields the seed (decodable) but not the genuine-hex +/// fingerprint (SHA-locked), so the material is the seed alone — see +/// [`StatsigMaterial::generate_statsig`]. +pub fn read_captured_statsig(webview: &WebviewWindow) -> Option { + let packed = webview + .cookies() + .ok()? + .into_iter() + .find(|cookie| cookie.name() == STATSIG_CAPTURE_COOKIE) + .map(|cookie| cookie.value().to_string())?; + + parse_packed_statsig(&packed) +} + +/// Parse the `method|path|statsigId|capturedAtMs` cookie payload into the +/// signed header and its reusable seed material. +fn parse_packed_statsig(packed: &str) -> Option { + let mut parts = packed.splitn(4, '|'); + let method = parts.next()?; + let path = parts.next()?; + let statsig_id = parts.next()?; + let captured_at_ms: i64 = parts.next()?.parse().ok()?; + + let captured = decode_statsig(statsig_id, method, path, captured_at_ms / 1000).ok()?; + let captured_at: DateTime = DateTime::from_timestamp_millis(captured_at_ms)?; + + Some(GrokStatsigCapture { + material: StatsigMaterial::from_seed_b64(captured.seed_b64), + statsig_id: statsig_id.to_string(), + method: method.trim().to_ascii_uppercase(), + path: path.trim().to_string(), + captured_at, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + // A real browser-captured statsig for POST /conversations/new. + const CAPTURE: &str = + "XbHvyYh7hmNc+8sVAGnrpcuHN/MK+mgN63cmnBljOJaoCKu6zTPVw6C7HVv1wculKCNmYVum+L1h0IjFmtyZD/C53M+ZXg"; + + #[test] + fn init_script_installs_sink_and_harness() { + let script = grok_statsig_init_script(); + // Guarded to grok.com so it never touches the accounts.x.ai sign-in page. + assert!(script.contains("grok.com")); + assert!(script.contains("__grokStatsigReport")); + assert!(script.contains(STATSIG_CAPTURE_COOKIE)); + // The library harness is embedded. + assert!(script.contains("x-statsig-id")); + } + + #[test] + fn parses_a_packed_capture_into_seed_material() { + let packed = format!("POST|/rest/app-chat/conversations/new|{CAPTURE}|1787535100000"); + let capture = parse_packed_statsig(&packed).expect("should decode"); + // The reusable piece is the decoded seed (48 bytes -> 64 base64 chars). + assert_eq!(capture.material.seed_b64.len(), 64); + // The signed header itself is kept verbatim, with the request it signed. + assert_eq!(capture.statsig_id, CAPTURE); + assert_eq!(capture.method, "POST"); + assert_eq!(capture.path, "/rest/app-chat/conversations/new"); + assert_eq!(capture.captured_at.timestamp_millis(), 1787535100000); + } + + #[test] + fn rejects_malformed_payloads() { + assert!(parse_packed_statsig("garbage").is_none()); + assert!(parse_packed_statsig("POST|/p|not-base64!!|123").is_none()); + } +} diff --git a/crates/artcraftx/src/windows/login_window/utils/mod.rs b/crates/artcraftx/src/windows/login_window/utils/mod.rs new file mode 100644 index 00000000..5dce39c0 --- /dev/null +++ b/crates/artcraftx/src/windows/login_window/utils/mod.rs @@ -0,0 +1,6 @@ +//! Support utilities for the login window: cookie capture and decoding +//! user info out of captured cookies. + +pub mod extract_login_window_cookies; +pub mod extract_user_info_from_cookies; +pub mod grok_statsig_capture; diff --git a/crates/artcraftx/src/windows/main_window/constants.rs b/crates/artcraftx/src/windows/main_window/constants.rs new file mode 100644 index 00000000..1b4755c1 --- /dev/null +++ b/crates/artcraftx/src/windows/main_window/constants.rs @@ -0,0 +1,15 @@ + +/// The name of the main application window. +/// This is the Artcraft application UX itself. +pub const MAIN_WINDOW_NAME : &str = "main"; + +/// This is the name of the main window's main webview. +pub const MAIN_WEBVIEW_NAME: &str = "main"; + +// TODO: handle pixel density, eg. retina displays +/// This is the minimum width to resize the main window in an automated fashion +pub const MAIN_WINDOW_MIN_WIDTH : u32 = 800; + +// TODO: handle pixel density, eg. retina displays +/// This is the minimum height to resize the main window in an automated fashion +pub const MAIN_WINDOW_MIN_HEIGHT : u32 = 400; diff --git a/crates/artcraftx/src/windows/main_window/mod.rs b/crates/artcraftx/src/windows/main_window/mod.rs new file mode 100644 index 00000000..987b09fc --- /dev/null +++ b/crates/artcraftx/src/windows/main_window/mod.rs @@ -0,0 +1 @@ +pub mod constants; \ No newline at end of file diff --git a/crates/artcraftx/src/windows/mod.rs b/crates/artcraftx/src/windows/mod.rs new file mode 100644 index 00000000..5ad26a54 --- /dev/null +++ b/crates/artcraftx/src/windows/mod.rs @@ -0,0 +1,2 @@ +pub mod login_window; +pub mod main_window; diff --git a/crates/artcraftx/tauri-dev-hot-reload.conf.json b/crates/artcraftx/tauri-dev-hot-reload.conf.json new file mode 100644 index 00000000..d31d445a --- /dev/null +++ b/crates/artcraftx/tauri-dev-hot-reload.conf.json @@ -0,0 +1,105 @@ +{ + "build": { + "frontendDist": "../../frontend/apps/artcraft/dist", + "beforeDevCommand": "echo 'no dev'", + "devUrl": "http://localhost:5173", + "beforeBuildCommand": "npx nx run artcraft:build" + }, + "app": { + "withGlobalTauri": true, + "windows": [], + "security": { + "assetProtocol": { + "enable": true, + "scope": [ + "**" + ] + }, + "csp": { + "default-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://www.google-analytics.com", + "https://www.googletagmanager.com", + "ipc://localhost", + "tauri://localhost" + ], + "connect-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "asset:", + "blob:", + "data:", + "http://ipc.localhost", + "https://*.clarity.ms", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://asset.localhost", + "https://unpkg.com/detect-gpu@5.0.70/", + "https://www.google-analytics.com", + "https://www.googletagmanager.com", + "ipc://localhost", + "tauri://localhost" + ], + "font-src": "*", + "img-src": [ + "", + "'self'", + "'unsafe-inline'", + "*", + "asset:", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "ipc://localhost", + "tauri://localhost" + ], + "media-src": [ + "'self'", + "*", + "asset:", + "blob:", + "data:", + "https://asset.localhost" + ], + "script-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "'wasm-unsafe-eval'", + "asset:", + "blob:", + "data:", + "https://*.clarity.ms", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://*.unpkg.com", + "https://clarity.ms", + "https://unpkg.com", + "ipc://localhost", + "tauri:", + "tauri://localhost" + ], + "style-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://fonts.googleapis.com", + "ipc://localhost", + "tauri://localhost" + ] + } + } + } +} diff --git a/crates/artcraftx/tauri-dev-static.conf.json b/crates/artcraftx/tauri-dev-static.conf.json new file mode 100644 index 00000000..898eb61a --- /dev/null +++ b/crates/artcraftx/tauri-dev-static.conf.json @@ -0,0 +1,13 @@ +{ + "build": { + "frontendDist": "../../frontend/apps/artcraft/dist", + "beforeDevCommand": "echo 'this is static development; no live reload'", + "beforeBuildCommand": "echo 'this is static development; no live reload'", + "devUrl": null + }, + "app": { + "withGlobalTauri": true, + "windows": [ + ] + } +} diff --git a/crates/artcraftx/tauri-mac.conf.json b/crates/artcraftx/tauri-mac.conf.json new file mode 100644 index 00000000..f24cce42 --- /dev/null +++ b/crates/artcraftx/tauri-mac.conf.json @@ -0,0 +1,120 @@ +{ + "$schema": "https://schema.tauri.app/config/2.0.0-rc", + "productName": "ArtCraftX", + "version": "0.0.1", + "identifier": "ai.artcraftx.app", + "build": { + "frontendDist": "../../frontend/apps/artcraft/dist", + "devUrl": "http://localhost:5173", + "beforeDevCommand": "nx run artcraft:dev", + "beforeBuildCommand": "nx run artcraft:build" + }, + "app": { + "withGlobalTauri": true, + "windows": [], + "security": { + "assetProtocol": { + "enable": true, + "scope": [ + "**" + ] + }, + "csp": { + "default-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://www.google-analytics.com", + "https://www.googletagmanager.com", + "ipc://localhost", + "tauri://localhost" + ], + "connect-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "asset:", + "blob:", + "data:", + "http://ipc.localhost", + "https://*.clarity.ms", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://asset.localhost", + "https://unpkg.com/detect-gpu@5.0.70/", + "https://www.google-analytics.com", + "https://www.googletagmanager.com", + "ipc://localhost", + "tauri://localhost" + ], + "font-src": "*", + "img-src": [ + "", + "'self'", + "'unsafe-inline'", + "*", + "asset:", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "ipc://localhost", + "tauri://localhost" + ], + "media-src": [ + "'self'", + "*", + "asset:", + "blob:", + "data:", + "https://asset.localhost" + ], + "script-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "'wasm-unsafe-eval'", + "asset:", + "blob:", + "data:", + "https://*.clarity.ms", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://*.unpkg.com", + "https://clarity.ms", + "https://unpkg.com", + "ipc://localhost", + "tauri:", + "tauri://localhost" + ], + "style-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://fonts.googleapis.com", + "ipc://localhost", + "tauri://localhost" + ] + } + } + }, + "bundle": { + "active": true, + "targets": "all", + "icon": [ + "icons/32x32.png", + "icons/128x128.png", + "icons/128x128@2x.png", + "icons/icon.icns", + "icons/icon.ico" + ] + } +} diff --git a/crates/artcraftx/tauri.conf.json b/crates/artcraftx/tauri.conf.json new file mode 100644 index 00000000..8369b361 --- /dev/null +++ b/crates/artcraftx/tauri.conf.json @@ -0,0 +1,120 @@ +{ + "$schema": "https://schema.tauri.app/config/2.0.0-rc", + "productName": "ArtCraftX", + "version": "0.0.1", + "identifier": "ai.artcraftx.app", + "build": { + "frontendDist": "../../frontend/apps/artcraft/dist", + "devUrl": "http://localhost:5173", + "beforeDevCommand": "nx run artcraft:dev", + "beforeBuildCommand": "npx run artcraft:build" + }, + "app": { + "withGlobalTauri": true, + "windows": [], + "security": { + "assetProtocol": { + "enable": true, + "scope": [ + "**" + ] + }, + "csp": { + "default-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://www.google-analytics.com", + "https://www.googletagmanager.com", + "ipc://localhost", + "tauri://localhost" + ], + "connect-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "asset:", + "blob:", + "data:", + "http://ipc.localhost", + "https://*.clarity.ms", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://asset.localhost", + "https://unpkg.com/detect-gpu@5.0.70/", + "https://www.google-analytics.com", + "https://www.googletagmanager.com", + "ipc://localhost", + "tauri://localhost" + ], + "font-src": "*", + "img-src": [ + "", + "'self'", + "'unsafe-inline'", + "*", + "asset:", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "ipc://localhost", + "tauri://localhost" + ], + "media-src": [ + "'self'", + "*", + "asset:", + "blob:", + "data:", + "https://asset.localhost" + ], + "script-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "'wasm-unsafe-eval'", + "asset:", + "blob:", + "data:", + "https://*.clarity.ms", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://*.unpkg.com", + "https://clarity.ms", + "https://unpkg.com", + "ipc://localhost", + "tauri:", + "tauri://localhost" + ], + "style-src": [ + "'self'", + "'unsafe-eval'", + "'unsafe-inline'", + "blob:", + "data:", + "https://*.fakeyou.com", + "https://*.storyteller.ai", + "https://fonts.googleapis.com", + "ipc://localhost", + "tauri://localhost" + ] + } + } + }, + "bundle": { + "active": true, + "targets": "all", + "icon": [ + "icons/32x32.png", + "icons/128x128.png", + "icons/128x128@2x.png", + "icons/icon.icns", + "icons/icon.ico" + ] + } +} diff --git a/crates/core_types/CLAUDE.md b/crates/core_types/CLAUDE.md new file mode 100644 index 00000000..16a3d22c --- /dev/null +++ b/crates/core_types/CLAUDE.md @@ -0,0 +1,58 @@ +# core_types — the highest-level shared types + +The whole workspace depends on this crate; it must stay dependency-light. + +- `enums/generation_source.rs` — `GenerationSource`: where a generation comes from (the service + + auth mechanism behind a credential, and the provider recorded for tasks). Stored in credential + TOML files and the sqlite tasks database — NEVER change existing string values. +- `identifiers/` — the concrete strongly-typed id types. Every non-database entity id gets a + distinct type here (`CredentialId`, …). The *machinery* (minting, validation, the `define_id!` + macro) lives in `identifiers/utils/id_core.rs`. + +Database identifiers live elsewhere: `sqlite_identifiers` for the local tasks database, `artcraft_client::tokens` +for the server API. + +## The rule: NEVER stringly-typed ids + +A bare `String`/`&str` id is a bug. Function signatures, struct fields, file formats, and request +types all use the typed id. This makes "passed a `CredentialId` where another id was expected" a +**compile error**, not a production incident. + +```rust +CredentialId::generate() // mint a new one +"credential_01j9…".parse::()? // validating parse of untrusted input +CredentialId::from_trusted(s) // wrap a known-good string (a value we minted) — no validation +credential_id.as_str() // borrow the underlying string +``` + +## Adding a new id type + +One line, alphabetized within its domain group: + +```rust +define_id!(pub struct WidgetId => "wgt"); +``` + +- Pick a short, collision-free prefix. +- Group types under a plain `//` section comment. +- Add a test only when the type carries unusual rules; the generic tests already in `lib.rs` + cover the macro itself. + +## Trusted vs. validated — pick deliberately + +- Crossing a trust boundary (Tauri request payload, hand-written file)? → `parse()` / `from_str`. +- Value we produced and are round-tripping (a credential file we wrote)? → `from_trusted` (cheaper). + NB: existing credential files minted before the ULID switch carry shorter entropy — they load via + serde/`from_trusted` and stay valid; only strict `parse()` would reject them. + +When unsure, validate. + +## The machinery (`src/id_core.rs`) + +- `mint(prefix) -> String` — `{prefix}_{26-char lowercase Crockford ULID}`. Time-ordered + globally + unique. This is the ONLY place these ids are minted. +- `validate(s, prefix) -> Result<(), ParseIdError>` — checks the `{prefix}_` and a 26-char ULID body. +- `ParseIdError` — `WrongPrefix` / `BadUlid`, returned by every `FromStr`. +- `define_id!` — stamps out a `#[serde(transparent)]` newtype over `String` with `generate()`, + validating `FromStr`, `from_trusted()`, `as_str()`/`into_string()`/`AsRef`/`Display`/`Debug`. + No sqlx integration (these ids live in files, not database columns); add it if that ever changes. diff --git a/crates/core_types/Cargo.toml b/crates/core_types/Cargo.toml new file mode 100644 index 00000000..d6aca8a4 --- /dev/null +++ b/crates/core_types/Cargo.toml @@ -0,0 +1,34 @@ +[package] +name = "core_types" +edition = "2021" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "core_types" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Serialization (define_id! expansion references ::serde) +serde.workspace = true +serde_derive.workspace = true + +# Id entropy (time-ordered ULIDs) +ulid = "1" + +[dev-dependencies] +# Test serialization +serde_json.workspace = true + +# Enum iteration in tests +strum = { workspace = true, features = ["derive"] } diff --git a/crates/core_types/src/enums/enum_error.rs b/crates/core_types/src/enums/enum_error.rs new file mode 100644 index 00000000..0efb8fd6 --- /dev/null +++ b/crates/core_types/src/enums/enum_error.rs @@ -0,0 +1,19 @@ +use std::fmt; + +/// Error converting a string into an enum variant. +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum EnumError { + CouldNotConvertFromString(String), +} + +impl fmt::Display for EnumError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Self::CouldNotConvertFromString(value) => { + write!(f, "could not convert string to enum: {value:?}") + } + } + } +} + +impl std::error::Error for EnumError {} diff --git a/crates/core_types/src/enums/generation_source.rs b/crates/core_types/src/enums/generation_source.rs new file mode 100644 index 00000000..c67cd32f --- /dev/null +++ b/crates/core_types/src/enums/generation_source.rs @@ -0,0 +1,287 @@ +//! This is an important enum. +//! +//! It identifies where a generation comes from: the service (and auth +//! mechanism) behind a stored credential, and the provider recorded for +//! tasks in the local tasks database. +//! +//! The string values are stored in user-editable credential TOML files AND +//! in the sqlite tasks database. NEVER change existing values; only add +//! new ones. Keep the max length to 32 characters. + +use std::collections::BTreeSet; +use std::fmt; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Whether a source authenticates with browser cookies or an API key. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)] +pub enum CredentialKind { + #[serde(rename = "cookies")] + Cookies, + #[serde(rename = "api_key")] + ApiKey, +} + +/// Where a generation comes from: a service plus its auth mechanism. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +pub enum GenerationSource { + // ── ArtCraft ── + /// Production ArtCraft API (username + password login; stores the + /// resulting session cookie). + #[serde(rename = "artcraft")] + Artcraft, + /// Local dev ArtCraft API. + #[serde(rename = "artcraft_local")] + ArtcraftLocal, + /// ArtCraft website cookies captured from a webview. + #[serde(rename = "artcraft_cookies")] + ArtcraftCookies, + /// ArtCraft API key. + #[serde(rename = "artcraft_api")] + ArtcraftApi, + + // ── Fal ── + #[serde(rename = "fal")] + Fal, + #[serde(rename = "fal_api")] + FalApi, + + // ── Grok / xAI ── + #[serde(rename = "grok")] + Grok, + // `xai_cookies` is the legacy name for this service; kept as a serde alias so + // existing credential files still load. + #[serde(rename = "grok_cookies", alias = "xai_cookies")] + GrokCookies, + #[serde(rename = "xai_api")] + XAiApi, + + // ── Midjourney ── + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "midjourney_cookies")] + MidjourneyCookies, + + // ── OpenAI ── + #[serde(rename = "openai_api")] + OpenAiApi, + + // ── World Labs ── + #[serde(rename = "world_labs")] + WorldLabs, + #[serde(rename = "worldlabs_cookies")] + WorldLabsCookies, + + // ── Higgsfield ── + /// The generation provider recorded on tasks run with a Higgsfield account. + #[serde(rename = "higgsfield")] + Higgsfield, + /// Higgsfield website cookies captured from the login webview. + #[serde(rename = "higgsfield_cookies")] + HiggsfieldCookies, + // ── Other website (cookie) integrations ── + #[serde(rename = "magnific_cookies")] + MagnificCookies, + #[serde(rename = "openart_cookies")] + OpenArtCookies, + #[serde(rename = "runway_cookies")] + RunwayCookies, + + // ── Other API key integrations ── + #[serde(rename = "replicate_api")] + ReplicateApi, +} + +impl GenerationSource { + /// The auth mechanism this source uses. + pub fn kind(&self) -> CredentialKind { + match self { + Self::Artcraft + | Self::ArtcraftLocal + | Self::ArtcraftCookies + | Self::Grok + | Self::GrokCookies + | Self::Midjourney + | Self::MidjourneyCookies + | Self::WorldLabs + | Self::WorldLabsCookies + | Self::Higgsfield + | Self::HiggsfieldCookies + | Self::MagnificCookies + | Self::OpenArtCookies + | Self::RunwayCookies => CredentialKind::Cookies, + Self::ArtcraftApi + | Self::Fal + | Self::FalApi + | Self::OpenAiApi + | Self::ReplicateApi + | Self::XAiApi => CredentialKind::ApiKey, + } + } + + pub fn to_str(&self) -> &'static str { + match self { + Self::Artcraft => "artcraft", + Self::ArtcraftLocal => "artcraft_local", + Self::ArtcraftCookies => "artcraft_cookies", + Self::ArtcraftApi => "artcraft_api", + Self::Fal => "fal", + Self::FalApi => "fal_api", + Self::Grok => "grok", + Self::GrokCookies => "grok_cookies", + Self::XAiApi => "xai_api", + Self::Midjourney => "midjourney", + Self::MidjourneyCookies => "midjourney_cookies", + Self::OpenAiApi => "openai_api", + Self::WorldLabs => "world_labs", + Self::WorldLabsCookies => "worldlabs_cookies", + Self::Higgsfield => "higgsfield", + Self::HiggsfieldCookies => "higgsfield_cookies", + Self::MagnificCookies => "magnific_cookies", + Self::OpenArtCookies => "openart_cookies", + Self::RunwayCookies => "runway_cookies", + Self::ReplicateApi => "replicate_api", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "artcraft" => Ok(Self::Artcraft), + "artcraft_local" => Ok(Self::ArtcraftLocal), + "artcraft_cookies" => Ok(Self::ArtcraftCookies), + "artcraft_api" => Ok(Self::ArtcraftApi), + "fal" => Ok(Self::Fal), + "fal_api" => Ok(Self::FalApi), + "grok" => Ok(Self::Grok), + "grok_cookies" | "xai_cookies" => Ok(Self::GrokCookies), + "xai_api" => Ok(Self::XAiApi), + "midjourney" => Ok(Self::Midjourney), + "midjourney_cookies" => Ok(Self::MidjourneyCookies), + "openai_api" => Ok(Self::OpenAiApi), + "world_labs" => Ok(Self::WorldLabs), + "worldlabs_cookies" => Ok(Self::WorldLabsCookies), + "higgsfield" => Ok(Self::Higgsfield), + "higgsfield_cookies" => Ok(Self::HiggsfieldCookies), + "magnific_cookies" => Ok(Self::MagnificCookies), + "openart_cookies" => Ok(Self::OpenArtCookies), + "runway_cookies" => Ok(Self::RunwayCookies), + "replicate_api" => Ok(Self::ReplicateApi), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + BTreeSet::from([ + Self::Artcraft, + Self::ArtcraftLocal, + Self::ArtcraftCookies, + Self::ArtcraftApi, + Self::Fal, + Self::FalApi, + Self::Grok, + Self::GrokCookies, + Self::XAiApi, + Self::Midjourney, + Self::MidjourneyCookies, + Self::OpenAiApi, + Self::WorldLabs, + Self::WorldLabsCookies, + Self::Higgsfield, + Self::HiggsfieldCookies, + Self::MagnificCookies, + Self::OpenArtCookies, + Self::RunwayCookies, + Self::ReplicateApi, + ]) + } +} + +impl fmt::Display for GenerationSource { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.to_str()) + } +} + +impl fmt::Debug for GenerationSource { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.to_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod explicit_checks { + use super::*; + + #[test] + fn serde_round_trip_matches_to_str() { + for source in GenerationSource::all_variants() { + let json = serde_json::to_string(&source).unwrap(); + assert_eq!(json, format!("\"{}\"", source.to_str())); + let back: GenerationSource = serde_json::from_str(&json).unwrap(); + assert_eq!(back, source); + } + } + + #[test] + fn from_str_err() { + let result = GenerationSource::from_str("asdf"); + assert_eq!( + result, + Err(EnumError::CouldNotConvertFromString("asdf".to_string())) + ); + } + + #[test] + fn all_variants_count() { + assert_eq!(GenerationSource::all_variants().len(), 20); + } + + #[test] + fn kind_matches_variant_family() { + assert_eq!(GenerationSource::Artcraft.kind(), CredentialKind::Cookies); + assert_eq!(GenerationSource::ArtcraftLocal.kind(), CredentialKind::Cookies); + assert_eq!(GenerationSource::RunwayCookies.kind(), CredentialKind::Cookies); + assert_eq!(GenerationSource::Fal.kind(), CredentialKind::ApiKey); + assert_eq!(GenerationSource::FalApi.kind(), CredentialKind::ApiKey); + } + } + + mod mechanical_checks { + use super::*; + use strum::IntoEnumIterator; + + #[test] + fn variant_length() { + assert_eq!(GenerationSource::all_variants().len(), GenerationSource::iter().len()); + } + + #[test] + fn round_trip() { + for variant in GenerationSource::all_variants() { + assert_eq!(variant, GenerationSource::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, GenerationSource::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, GenerationSource::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + /// Stored in VARCHAR-ish columns and TOML files. Every value must fit. + #[test] + fn max_serialization_length() { + const MAX_LENGTH: usize = 32; + for variant in GenerationSource::all_variants() { + let serialized = variant.to_str(); + assert!(!serialized.is_empty()); + assert!(serialized.len() <= MAX_LENGTH); + } + } + } +} diff --git a/crates/core_types/src/enums/mod.rs b/crates/core_types/src/enums/mod.rs new file mode 100644 index 00000000..49bf5160 --- /dev/null +++ b/crates/core_types/src/enums/mod.rs @@ -0,0 +1,2 @@ +pub mod enum_error; +pub mod generation_source; diff --git a/crates/core_types/src/identifiers/credential_id.rs b/crates/core_types/src/identifiers/credential_id.rs new file mode 100644 index 00000000..ad2138c4 --- /dev/null +++ b/crates/core_types/src/identifiers/credential_id.rs @@ -0,0 +1,52 @@ +// Stored credentials (one TOML file per credential in the desktop app's +// credentials directory). Hidden from users; the effective primary identifier. +define_id!(pub struct CredentialId => "credential"); + +#[cfg(test)] +mod tests { + use super::*; + use std::str::FromStr; + + #[test] + fn generate_has_prefix() { + assert!(CredentialId::generate().as_str().starts_with("credential_")); + assert_eq!(CredentialId::PREFIX, "credential"); + } + + #[test] + fn from_str_roundtrip() { + let id = CredentialId::generate(); + let parsed = CredentialId::from_str(id.as_str()).unwrap(); + assert_eq!(parsed, id); + } + + #[test] + fn from_str_rejects_wrong_prefix() { + assert!(CredentialId::from_str("user_01j9abcdefghjkmnpqrstvwxyz").is_err()); + } + + #[test] + fn from_str_rejects_short_entropy() { + assert!(CredentialId::from_str("credential_tooshort").is_err()); + } + + #[test] + fn from_trusted_skips_validation() { + let id = CredentialId::from_trusted("credential_legacy21charentropy00"); + assert_eq!(id.as_str(), "credential_legacy21charentropy00"); + } + + #[test] + fn serializes_as_bare_string() { + let id = CredentialId::generate(); + let json = serde_json::to_string(&id).unwrap(); + assert_eq!(json, format!("\"{id}\"")); + let back: CredentialId = serde_json::from_str(&json).unwrap(); + assert_eq!(back, id); + } + + #[test] + fn ids_are_unique() { + assert_ne!(CredentialId::generate(), CredentialId::generate()); + } +} diff --git a/crates/core_types/src/identifiers/mod.rs b/crates/core_types/src/identifiers/mod.rs new file mode 100644 index 00000000..437d7d19 --- /dev/null +++ b/crates/core_types/src/identifiers/mod.rs @@ -0,0 +1,19 @@ +//! The strongly-typed id types for entities that are NOT database rows +//! (credential files, and whatever comes next). +//! +//! Each is a transparent newtype over `String` generated by +//! [`define_id!`] (see `utils::id_core`), so it carries its prefix, +//! `generate()`s time-ordered ULIDs, and validates on `FromStr`. Passing a +//! `CredentialId` where another id is expected is a compile error — that is +//! the entire point. NEVER use bare `String` ids. +//! +//! Database identifiers live elsewhere: `sqlite_identifiers` for the local +//! tasks database, `artcraft_client::tokens` for the server API. + +#[macro_use] +pub mod utils; + +pub mod credential_id; + +pub use credential_id::CredentialId; +pub use utils::id_core::ParseIdError; diff --git a/crates/core_types/src/identifiers/utils/id_core.rs b/crates/core_types/src/identifiers/utils/id_core.rs new file mode 100644 index 00000000..ba40ba96 --- /dev/null +++ b/crates/core_types/src/identifiers/utils/id_core.rs @@ -0,0 +1,145 @@ +//! The id *machinery*: minting, validation, and the [`define_id!`] macro. +//! Concrete `{Entity}Id` newtypes are declared in `lib.rs`, one +//! `define_id!` line each. + +use std::fmt; + +/// Mint a fresh id string: `{prefix}_{26-char lowercase Crockford ULID}`. +pub fn mint(prefix: &str) -> String { + format!("{prefix}_{}", ulid::Ulid::new().to_string().to_lowercase()) +} + +/// Error parsing a prefixed id from an untrusted string. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum ParseIdError { + /// The string didn't start with `{prefix}_`. + WrongPrefix { expected: &'static str, got: String }, + /// The part after the prefix wasn't a 26-char Crockford ULID. + BadUlid { got: String }, +} + +impl fmt::Display for ParseIdError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Self::WrongPrefix { expected, got } => { + write!(f, "expected id with prefix '{expected}_', got '{got}'") + } + Self::BadUlid { got } => write!(f, "id '{got}' does not end in a 26-char ULID"), + } + } +} + +impl std::error::Error for ParseIdError {} + +/// Validate that `s` is a well-formed `{prefix}_{ulid}` id. +pub fn validate(s: &str, prefix: &'static str) -> Result<(), ParseIdError> { + let rest = s + .strip_prefix(prefix) + .and_then(|r| r.strip_prefix('_')) + .ok_or_else(|| ParseIdError::WrongPrefix { expected: prefix, got: s.to_string() })?; + + // A Crockford ULID is 26 chars of lowercase base32 (0-9 a-z after lowercasing). + if rest.len() != 26 || !rest.bytes().all(|b| b.is_ascii_alphanumeric()) { + return Err(ParseIdError::BadUlid { got: s.to_string() }); + } + Ok(()) +} + +/// Define a strongly-typed id newtype: `define_id!(pub struct CredentialId => "credential");`. +/// +/// The generated type is a transparent newtype over `String` that: +/// - `generate()`s a fresh `{prefix}_{ulid}`, +/// - parses/validates via `FromStr`, +/// - `Display`s / `Serialize`s as the bare string. +#[macro_export] +macro_rules! define_id { + ($(#[$doc:meta])* $vis:vis struct $name:ident => $prefix:literal) => { + $(#[$doc])* + #[derive( + Clone, PartialEq, Eq, PartialOrd, Ord, Hash, + ::serde::Serialize, ::serde::Deserialize, + )] + #[serde(transparent)] + $vis struct $name(String); + + impl $name { + /// The id prefix (e.g. `credential`). + pub const PREFIX: &'static str = $prefix; + + /// Generate a fresh, time-ordered id. + pub fn generate() -> Self { + Self($crate::identifiers::utils::id_core::mint($prefix)) + } + + /// Borrow the underlying string. + pub fn as_str(&self) -> &str { + &self.0 + } + + /// Consume into the underlying string. + pub fn into_string(self) -> String { + self.0 + } + + /// Wrap a string already known to be valid (e.g. one we minted and are + /// round-tripping). Skips validation — use [`std::str::FromStr`] for + /// untrusted input. + pub fn from_trusted(s: impl Into) -> Self { + Self(s.into()) + } + } + + impl ::std::str::FromStr for $name { + type Err = $crate::identifiers::utils::id_core::ParseIdError; + fn from_str(s: &str) -> ::std::result::Result { + $crate::identifiers::utils::id_core::validate(s, $prefix)?; + Ok(Self(s.to_string())) + } + } + + impl ::std::fmt::Display for $name { + fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result { + f.write_str(&self.0) + } + } + + impl ::std::fmt::Debug for $name { + fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result { + write!(f, concat!(stringify!($name), "({})"), &self.0) + } + } + + impl ::std::convert::AsRef for $name { + fn as_ref(&self) -> &str { + &self.0 + } + } + }; +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn mint_has_prefix_and_26_char_ulid() { + let id = mint("credential"); + assert!(id.starts_with("credential_")); + let (_, ulid) = id.split_once('_').unwrap(); + assert_eq!(ulid.len(), 26); + assert_eq!(ulid, ulid.to_lowercase()); + assert!(validate(&id, "credential").is_ok()); + } + + #[test] + fn validate_rejects_wrong_prefix() { + let id = mint("acct"); + assert!(matches!(validate(&id, "credential"), Err(ParseIdError::WrongPrefix { .. }))); + } + + #[test] + fn validate_rejects_bad_ulid() { + assert!(matches!(validate("credential_short", "credential"), Err(ParseIdError::BadUlid { .. }))); + assert!(matches!(validate("credential_", "credential"), Err(ParseIdError::BadUlid { .. }))); + } +} diff --git a/crates/core_types/src/identifiers/utils/mod.rs b/crates/core_types/src/identifiers/utils/mod.rs new file mode 100644 index 00000000..9d4a4b41 --- /dev/null +++ b/crates/core_types/src/identifiers/utils/mod.rs @@ -0,0 +1,2 @@ +#[macro_use] +pub mod id_core; diff --git a/crates/core_types/src/lib.rs b/crates/core_types/src/lib.rs new file mode 100644 index 00000000..2f1341cf --- /dev/null +++ b/crates/core_types/src/lib.rs @@ -0,0 +1,11 @@ +//! The highest-level shared types: enums and identifiers used across the +//! whole workspace (commands, credentials, the tasks database, API clients). +//! +//! This crate must stay dependency-light — everything else depends on it. + +#[macro_use] +extern crate serde_derive; + +pub mod enums; +#[macro_use] +pub mod identifiers; diff --git a/crates/lib/browser_emulation/Cargo.toml b/crates/lib/browser_emulation/Cargo.toml new file mode 100644 index 00000000..c2a61fa7 --- /dev/null +++ b/crates/lib/browser_emulation/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "browser_emulation" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "browser_emulation" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# External +wreq.workspace = true +wreq-util.workspace = true + +[dev-dependencies] +# None yet diff --git a/crates/lib/browser_emulation/src/browser_profile.rs b/crates/lib/browser_emulation/src/browser_profile.rs new file mode 100644 index 00000000..c78bab2a --- /dev/null +++ b/crates/lib/browser_emulation/src/browser_profile.rs @@ -0,0 +1,248 @@ +use wreq::{Client, ClientBuilder}; +use wreq_util::{Emulation, EmulationOS, EmulationOption}; + +/// A browser identity to emulate. +/// +/// The named variants cover the browsers we routinely emulate, defaulting to a +/// macOS platform (which is what our desktop app and captured cookies use). +/// [`BrowserProfile::Custom`] is the escape hatch for any other `wreq_util` +/// emulation, a different OS, or a User-Agent override (useful when a site +/// advertises a browser version newer than `wreq_util` ships a fingerprint for). +#[derive(Clone, Debug, PartialEq, Eq, Hash, Default)] +pub enum BrowserProfile { + #[default] + Firefox139, + Firefox147, + Chrome131, + Chrome145, + Safari18, + Custom(CustomBrowserProfile), +} + +/// A fully-specified browser identity for [`BrowserProfile::Custom`]. +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +pub struct CustomBrowserProfile { + /// The `wreq_util` fingerprint to emulate. + pub emulation: Emulation, + + /// The operating system to present (drives `sec-ch-ua-platform`, the UA, …). + pub os: EmulationOS, + + /// Overrides the User-Agent the emulation would otherwise send. Leave `None` + /// to use the emulation's built-in UA. + pub maybe_user_agent: Option, +} + +impl BrowserProfile { + /// A macOS Safari profile with an explicit User-Agent override. + /// + /// Use this when the UA must EXACTLY match another client's — e.g. an + /// embedded webview that captured the cookies, since Cloudflare's + /// `cf_clearance` is bound to the exact User-Agent string. + pub fn safari_macos_with_user_agent(user_agent: impl Into) -> Self { + Self::Custom(CustomBrowserProfile { + emulation: Emulation::Safari18, + os: EmulationOS::MacOS, + maybe_user_agent: Some(user_agent.into()), + }) + } + + /// The profile that best matches a User-Agent captured from another client + /// (typically the login webview that earned the site's cookies), keeping + /// that exact UA string. + /// + /// Use this whenever cookies are replayed: bot-protection clearances + /// (Cloudflare `cf_clearance`, DataDome) are bound to the UA and checked + /// against the TLS/HTTP fingerprint, so the replaying client should present + /// the same UA on the fingerprint of the same browser family. WebKit-based + /// UAs (Safari, WKWebView) map to Safari; Chrome/Chromium/Edge to Chrome; + /// Firefox to Firefox. Anything else falls back to Safari, since our + /// webviews are WebKit. + pub fn matching_user_agent(user_agent: impl Into) -> Self { + let user_agent = user_agent.into(); + let emulation = emulation_for_user_agent(&user_agent); + Self::Custom(CustomBrowserProfile { + emulation, + os: os_for_user_agent(&user_agent), + maybe_user_agent: Some(user_agent), + }) + } + + /// Build a ready-to-use client carrying this profile's full fingerprint and + /// identity headers. This is the usual entry point. + pub fn build_client(&self) -> Result { + self.configure_client_builder(Client::builder()).build() + } + + /// Apply this profile to an existing [`ClientBuilder`], so callers can layer + /// on their own settings (timeouts, proxies, …) before building. + pub fn configure_client_builder(&self, builder: ClientBuilder) -> ClientBuilder { + let builder = builder.emulation(self.emulation_option()); + match self.maybe_user_agent_override() { + Some(user_agent) => builder.user_agent(user_agent), + None => builder, + } + } + + /// The `wreq` emulation factory (fingerprint + coherent identity headers) + /// for this profile. Pass it to any `wreq` `emulation(...)` method — e.g. to + /// emulate at the request level (`RequestBuilder`) or on a websocket upgrade + /// (`WebSocketRequestBuilder`) instead of at the client level. + /// + /// Note: this does NOT include the User-Agent override — that is applied by + /// [`Self::configure_client_builder`]. When emulating at the request level, + /// apply any override yourself with a `user-agent` header. + pub fn emulation_option(&self) -> EmulationOption { + EmulationOption::builder() + .emulation(self.emulation()) + .emulation_os(self.os()) + .build() + } + + /// The underlying `wreq_util` emulation for this profile. + pub fn emulation(&self) -> Emulation { + match self { + Self::Firefox139 => Emulation::Firefox139, + Self::Firefox147 => Emulation::Firefox147, + Self::Chrome131 => Emulation::Chrome131, + Self::Chrome145 => Emulation::Chrome145, + Self::Safari18 => Emulation::Safari18, + Self::Custom(custom) => custom.emulation, + } + } + + /// The operating system this profile presents. Named variants default to + /// macOS. + pub fn os(&self) -> EmulationOS { + match self { + Self::Custom(custom) => custom.os, + _ => EmulationOS::MacOS, + } + } + + /// The User-Agent override, if this profile sets one. Named variants use the + /// emulation's built-in UA and return `None`. + pub fn maybe_user_agent_override(&self) -> Option<&str> { + match self { + Self::Custom(custom) => custom.maybe_user_agent.as_deref(), + _ => None, + } + } + + /// A short human label for logs and debugging. + pub fn label(&self) -> String { + match self { + Self::Firefox139 => "firefox139".to_string(), + Self::Firefox147 => "firefox147".to_string(), + Self::Chrome131 => "chrome131".to_string(), + Self::Chrome145 => "chrome145".to_string(), + Self::Safari18 => "safari18".to_string(), + Self::Custom(custom) => { + format!("custom({:?} on {:?})", custom.emulation, custom.os) + } + } + } +} + +/// The newest fingerprint we ship for the UA's browser family. +fn emulation_for_user_agent(user_agent: &str) -> Emulation { + let lower = user_agent.to_ascii_lowercase(); + if lower.contains("firefox/") { + Emulation::Firefox147 + } else if lower.contains("chrome/") || lower.contains("chromium/") || lower.contains("edg/") { + Emulation::Chrome145 + } else { + // Safari proper, WKWebView UAs ("AppleWebKit/... Safari/..." without + // "Chrome/"), and anything unrecognized: our webviews are WebKit. + Emulation::Safari18 + } +} + +fn os_for_user_agent(user_agent: &str) -> EmulationOS { + let lower = user_agent.to_ascii_lowercase(); + if lower.contains("windows") { + EmulationOS::Windows + } else if lower.contains("android") { + EmulationOS::Android + } else if lower.contains("iphone") || lower.contains("ipad") { + EmulationOS::IOS + } else if lower.contains("linux") || lower.contains("x11") { + EmulationOS::Linux + } else { + EmulationOS::MacOS + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const WKWEBVIEW_MAC_UA: &str = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko)"; + const SAFARI_MAC_UA: &str = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15"; + const CHROME_MAC_UA: &str = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"; + const FIREFOX_WIN_UA: &str = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:143.0) Gecko/20100101 Firefox/143.0"; + + #[test] + fn matching_user_agent_picks_family_and_keeps_exact_ua() { + let safari = BrowserProfile::matching_user_agent(SAFARI_MAC_UA); + assert_eq!(safari.emulation(), Emulation::Safari18); + assert_eq!(safari.os(), EmulationOS::MacOS); + assert_eq!(safari.maybe_user_agent_override(), Some(SAFARI_MAC_UA)); + + // WKWebView says "Safari/..."-less AppleWebKit; still WebKit. + assert_eq!(BrowserProfile::matching_user_agent(WKWEBVIEW_MAC_UA).emulation(), Emulation::Safari18); + + // Chrome also says "Safari/537.36" — "Chrome/" must win. + let chrome = BrowserProfile::matching_user_agent(CHROME_MAC_UA); + assert_eq!(chrome.emulation(), Emulation::Chrome145); + assert_eq!(chrome.os(), EmulationOS::MacOS); + + let firefox = BrowserProfile::matching_user_agent(FIREFOX_WIN_UA); + assert_eq!(firefox.emulation(), Emulation::Firefox147); + assert_eq!(firefox.os(), EmulationOS::Windows); + } + + #[test] + fn matching_user_agent_builds_a_client() { + BrowserProfile::matching_user_agent(CHROME_MAC_UA).build_client().unwrap(); + } + + #[test] + fn default_is_firefox139() { + assert_eq!(BrowserProfile::default(), BrowserProfile::Firefox139); + assert_eq!(BrowserProfile::default().emulation(), Emulation::Firefox139); + } + + #[test] + fn named_variants_default_to_macos_and_no_ua_override() { + assert_eq!(BrowserProfile::Chrome145.os(), EmulationOS::MacOS); + assert_eq!(BrowserProfile::Chrome145.maybe_user_agent_override(), None); + } + + #[test] + fn custom_carries_os_and_ua_override() { + let profile = BrowserProfile::Custom(CustomBrowserProfile { + emulation: Emulation::Chrome145, + os: EmulationOS::Windows, + maybe_user_agent: Some("custom-agent/1.0".to_string()), + }); + assert_eq!(profile.emulation(), Emulation::Chrome145); + assert_eq!(profile.os(), EmulationOS::Windows); + assert_eq!(profile.maybe_user_agent_override(), Some("custom-agent/1.0")); + } + + #[test] + fn every_profile_builds_a_client() { + for profile in [ + BrowserProfile::Firefox139, + BrowserProfile::Firefox147, + BrowserProfile::Chrome131, + BrowserProfile::Chrome145, + BrowserProfile::Safari18, + ] { + profile.build_client().unwrap_or_else(|err| { + panic!("profile {} failed to build a client: {err}", profile.label()) + }); + } + } +} diff --git a/crates/lib/browser_emulation/src/lib.rs b/crates/lib/browser_emulation/src/lib.rs new file mode 100644 index 00000000..1e821c16 --- /dev/null +++ b/crates/lib/browser_emulation/src/lib.rs @@ -0,0 +1,37 @@ +//! browser_emulation +//! +//! A small, shared vocabulary of browser identities for anti-bot-sensitive +//! HTTP clients (Cloudflare-guarded scraping endpoints, websockets, etc.). +//! +//! Pick a [`BrowserProfile`] and it configures `wreq` end to end: the TLS/JA3 +//! and HTTP/2 fingerprint, the User-Agent, and the coherent identity headers +//! (`sec-ch-ua`, `accept`, `accept-encoding`, …) that a real browser sends. +//! These MUST live on the client/connection, not on individual requests, so +//! the primary entry point builds a configured client: +//! +//! ```ignore +//! let client = BrowserProfile::Firefox139.build_client()?; +//! // Every request from `client` now carries Firefox 139's fingerprint. +//! ``` +//! +//! When the cookies you send were captured from a specific browser (e.g. a +//! Cloudflare `cf_clearance` cookie, which is bound to the capturing browser's +//! User-Agent), pick the profile that matches that browser so the cookie +//! validates. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod browser_profile; diff --git a/crates/lib/build_metadata/Cargo.toml b/crates/lib/build_metadata/Cargo.toml new file mode 100644 index 00000000..bd768bfb --- /dev/null +++ b/crates/lib/build_metadata/Cargo.toml @@ -0,0 +1,34 @@ +[package] +name = "build_metadata" +resolver = "2" # NB: Required by `build-info` +edition = "2024" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +name = "build_metadata" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration = { workspace = true } + +# Internal +# (None yet) + +# External +build-info = "0.0.40" + +[dev-dependencies] +# None yet + +[build-dependencies] +build-info-build = "0.0.40" + diff --git a/crates/lib/build_metadata/build.rs b/crates/lib/build_metadata/build.rs new file mode 100644 index 00000000..3ed1729c --- /dev/null +++ b/crates/lib/build_metadata/build.rs @@ -0,0 +1,9 @@ + +fn main() { + // Tell Cargo that if the given file changes, to rerun this build script. + // TODO: Use this to test the GIT_SHA, etc. files that CI dumps into the working directory + // println!("cargo::rerun-if-changed=Cargo.toml"); + + // Make build info available in the main crate sources. + build_info_build::build_script(); +} diff --git a/crates/lib/build_metadata/src/lib.rs b/crates/lib/build_metadata/src/lib.rs new file mode 100644 index 00000000..91d84b5a --- /dev/null +++ b/crates/lib/build_metadata/src/lib.rs @@ -0,0 +1,43 @@ +use std::ops::Deref; +use build_info::chrono::{DateTime, Utc}; + +build_info::build_info!(fn version); + +pub fn build_timestamp() -> DateTime { + version().timestamp +} + +pub fn git_commit_id() -> Option<&'static str> { + version().version_control + .as_ref() + .map(|vc| vc.git()) + .flatten() + .map(|git| git.commit_id.deref()) +} + +pub fn git_commit_short_id() -> Option<&'static str> { + version().version_control + .as_ref() + .map(|vc| vc.git()) + .flatten() + .map(|git| git.commit_short_id.deref()) +} + +pub fn git_commit_timestamp() -> Option> { + version().version_control + .as_ref() + .map(|vc| vc.git()) + .flatten() + .map(|git| git.commit_timestamp) +} + +#[cfg(test)] +mod tests { + use crate::git_commit_id; + + #[test] + #[ignore] // Run manually for testing, not in CI + fn test_git_commit_id() { + assert_eq!(git_commit_id(), None); + } +} diff --git a/crates/lib/caching/memory_store/Cargo.toml b/crates/lib/caching/memory_store/Cargo.toml new file mode 100644 index 00000000..0c30db2a --- /dev/null +++ b/crates/lib/caching/memory_store/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "memory_store" +edition = "2018" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +name = "memory_store" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration = { workspace = true } + +# Internal +errors = { workspace = true } + +# External +anyhow = { workspace = true } diff --git a/crates/lib/caching/memory_store/src/clone_cell.rs b/crates/lib/caching/memory_store/src/clone_cell.rs new file mode 100644 index 00000000..aba8cdb9 --- /dev/null +++ b/crates/lib/caching/memory_store/src/clone_cell.rs @@ -0,0 +1,54 @@ +use anyhow::anyhow; +use errors::AnyhowResult; +use std::sync::{Arc, RwLock}; + +/// Store a threadsafe value that can be passed around and cloned. +/// The object is interior mutable so it can be changed without mut/&mut references. +/// This is useful for storing a value that may or may not be set between threads. +/// +/// Unlike `CloneSlot`, this always holds an object. +#[derive(Clone)] +pub struct CloneCell { + pub store: Arc>, +} + +impl CloneCell { + pub fn with_clone(object: &T) -> Self { + Self { + store: Arc::new(RwLock::new(object.clone())), + } + } + + pub fn with_owned(object: T) -> Self { + Self { + store: Arc::new(RwLock::new(object)), + } + } + + pub fn get_clone(&self) -> AnyhowResult { + match self.store.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => Ok(store.clone()), + } + } + + pub fn set_clone(&self, value: &T) -> AnyhowResult<()> { + match self.store.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => { + *store = value.clone(); + Ok(()) + } + } + } + + pub fn set_owned(&self, value: T) -> AnyhowResult<()> { + match self.store.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => { + *store = value; + Ok(()) + } + } + } +} diff --git a/crates/lib/caching/memory_store/src/clone_slot.rs b/crates/lib/caching/memory_store/src/clone_slot.rs new file mode 100644 index 00000000..ef2a3d10 --- /dev/null +++ b/crates/lib/caching/memory_store/src/clone_slot.rs @@ -0,0 +1,87 @@ +use anyhow::anyhow; +use errors::AnyhowResult; +use std::sync::{Arc, RwLock}; + +/// Store a threadsafe value that can be passed around and cloned. +/// The object is interior mutable so it can be changed without mut/&mut references. +/// This is useful for storing a value that may or may not be set between threads. +/// +/// Unlike `CloneCell`, this holds an optional object. +#[derive(Clone)] +pub struct CloneSlot { + pub store: Arc>>, +} + +impl CloneSlot { + pub fn empty() -> Self { + Self { + store: Arc::new(RwLock::new(None)), + } + } + + pub fn with_clone(object: &T) -> Self { + Self { + store: Arc::new(RwLock::new(Some(object.clone()))), + } + } + + pub fn get_clone(&self) -> AnyhowResult> { + match self.store.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => Ok(store.clone()), + } + } + + pub fn get_clone_required(&self) -> AnyhowResult { + match self.store.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => match &*store { + None => Err(anyhow!("Required stored item is not set")), + Some(inner) => Ok(inner.clone()), + } + } + } + + pub fn set_clone(&self, value: &T) -> AnyhowResult<()> { + match self.store.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => { + *store = Some(value.clone()); + Ok(()) + } + } + } + + pub fn clear(&self) -> AnyhowResult<()> { + match self.store.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => { + *store = None; + Ok(()) + } + } + } + + pub fn take(&self) -> AnyhowResult> { + match self.store.write() { + Err(err) => Err(anyhow!("Failed to acquire write lock: {:?}", err)), + Ok(mut store) => { + Ok(store.take()) + } + } + } + + pub fn is_some(&self) -> AnyhowResult { + match self.store.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => Ok(store.is_some()), + } + } + + pub fn is_none(&self) -> AnyhowResult { + match self.store.read() { + Err(err) => Err(anyhow!("Failed to acquire read lock: {:?}", err)), + Ok(store) => Ok(store.is_none()), + } + } +} diff --git a/crates/lib/caching/memory_store/src/lib.rs b/crates/lib/caching/memory_store/src/lib.rs new file mode 100644 index 00000000..19f70cae --- /dev/null +++ b/crates/lib/caching/memory_store/src/lib.rs @@ -0,0 +1,2 @@ +pub mod clone_cell; +pub mod clone_slot; \ No newline at end of file diff --git a/crates/lib/cloudflare_errors/Cargo.toml b/crates/lib/cloudflare_errors/Cargo.toml new file mode 100644 index 00000000..79ce79d8 --- /dev/null +++ b/crates/lib/cloudflare_errors/Cargo.toml @@ -0,0 +1,25 @@ +[package] +name = "cloudflare_errors" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "cloudflare_errors" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +# (None) + +# External +log.workspace = true + +[dev-dependencies] +# (None) diff --git a/crates/lib/cloudflare_errors/src/_metadata/cloudflare_301_response_body.txt b/crates/lib/cloudflare_errors/src/_metadata/cloudflare_301_response_body.txt new file mode 100644 index 00000000..0bb46277 --- /dev/null +++ b/crates/lib/cloudflare_errors/src/_metadata/cloudflare_301_response_body.txt @@ -0,0 +1,7 @@ + +301 Moved Permanently + +

301 Moved Permanently

+
cloudflare
+ + diff --git a/crates/lib/cloudflare_errors/src/classify_cloudflare_response.rs b/crates/lib/cloudflare_errors/src/classify_cloudflare_response.rs new file mode 100644 index 00000000..2ebdb2b3 --- /dev/null +++ b/crates/lib/cloudflare_errors/src/classify_cloudflare_response.rs @@ -0,0 +1,189 @@ +use crate::cloudflare_error::CloudflareError; +use crate::cloudflare_response_signals::CloudflareResponseSignals; + +/// Body markers of Cloudflare's challenge pages (managed challenge, JS +/// challenge, Turnstile interstitial). Any one is conclusive. +const CHALLENGE_BODY_MARKERS: &[&str] = &[ + "challenge-platform", + "challenge-error-text", + "cType: 'managed'", + "Just a moment...", + "_cf_chl_opt", + "cf-chl-", + "cf_chl_", + "Enable JavaScript and cookies to continue", + "Checking if the site connection is secure", + "Verify you are human", +]; + +/// Body markers of a hard WAF block page. +const ACCESS_DENIED_BODY_MARKERS: &[&str] = &[ + "error code: 1020", + "Error 1020", + "Access denied", + "Sorry, you have been blocked", + "Attention Required! | Cloudflare", +]; + +/// Body markers of Cloudflare's rate-limit page. +const RATE_LIMIT_BODY_MARKERS: &[&str] = &[ + "error code: 1015", + "Error 1015", + "You are being rate limited", +]; + +/// Body markers that a page came from Cloudflare at all (used only to avoid +/// mislabeling an origin's own 5xx as an edge error). +const CLOUDFLARE_BODY_MARKERS: &[&str] = &[ + "cloudflare", + "Cloudflare", + "cf-error-details", + "Ray ID", +]; + +/// Decide whether a response is a Cloudflare edge response and which kind. +/// +/// Returns `None` for 2xx, for responses that clearly came from the origin, +/// and for anything we can't attribute to Cloudflare. Header signals +/// ([`CloudflareResponseSignals::maybe_cf_mitigated`] especially) take +/// precedence over body heuristics. +pub fn classify_cloudflare_response(signals: &CloudflareResponseSignals<'_>) -> Option { + let status = signals.status_code; + let body = signals.body; + + if (200..300).contains(&status) { + return None; + } + + // `cf-mitigated: challenge` is Cloudflare telling us outright. + if signals.maybe_cf_mitigated.is_some_and(|value| value.eq_ignore_ascii_case("challenge")) { + return Some(CloudflareError::ChallengeInterstitial403); + } + + if contains_any(body, CHALLENGE_BODY_MARKERS) { + return Some(CloudflareError::ChallengeInterstitial403); + } + + if status == 403 && contains_any(body, ACCESS_DENIED_BODY_MARKERS) && looks_like_cloudflare(signals) { + return Some(CloudflareError::AccessDenied1020); + } + + if status == 429 && (contains_any(body, RATE_LIMIT_BODY_MARKERS) || signals.headers_say_cloudflare() == Some(true)) { + return Some(CloudflareError::RateLimited429); + } + + // Everything below is only attributable to Cloudflare when the response + // says so — an origin's own 502 is not a Cloudflare error. + if !looks_like_cloudflare(signals) { + return None; + } + + match status { + 301 => Some(CloudflareError::MovedPermanently301), // TODO: Include location header. + 502 => Some(CloudflareError::BadGateway502), + 503 => Some(CloudflareError::ServiceUnavailable503), + 504 => Some(CloudflareError::GatewayTimeout504), + 524 => Some(CloudflareError::TimeoutOccurred524), + 520..=523 | 525 | 526 | 527 | 530 => Some(CloudflareError::OriginError5xx(status)), + _ => { + if contains_any(body, &["errorcode_504", "Gateway time-out", "Error code 504"]) { + Some(CloudflareError::GatewayTimeout504) + } else { + None + } + } + } +} + +fn looks_like_cloudflare(signals: &CloudflareResponseSignals<'_>) -> bool { + match signals.headers_say_cloudflare() { + Some(answer) => answer, + None => contains_any(signals.body, CLOUDFLARE_BODY_MARKERS), + } +} + +fn contains_any(haystack: &str, needles: &[&str]) -> bool { + needles.iter().any(|needle| haystack.contains(needle)) +} + +#[cfg(test)] +mod tests { + use super::*; + + const CHALLENGE_PAGE: &str = r#"Just a moment...
Enable JavaScript and cookies to continue
"#; + const BLOCK_PAGE: &str = r#"Attention Required! | Cloudflare

Sorry, you have been blocked

error code: 1020

Cloudflare Ray ID: 8abc"#; + const RATE_LIMIT_PAGE: &str = r#"

Error 1015

You are being rate limited

Cloudflare Ray ID: 8abc

"#; + const ORIGIN_502_PAGE: &str = r#"502: Bad gateway

Bad gateway

Error code 502

Cloudflare Ray ID: 8abc

"#; + + fn classify(status: u16, body: &str) -> Option { + classify_cloudflare_response(&CloudflareResponseSignals::new(status, body)) + } + + #[test] + fn success_is_never_cloudflare() { + assert_eq!(classify(200, CHALLENGE_PAGE), None); + } + + #[test] + fn challenge_page_by_body() { + assert_eq!(classify(403, CHALLENGE_PAGE), Some(CloudflareError::ChallengeInterstitial403)); + // Under-attack mode serves the challenge as a 503. + assert_eq!(classify(503, CHALLENGE_PAGE), Some(CloudflareError::ChallengeInterstitial403)); + } + + #[test] + fn challenge_by_cf_mitigated_header_even_with_opaque_body() { + let signals = CloudflareResponseSignals::new(403, "").with_cf_mitigated(Some("challenge")); + assert_eq!(classify_cloudflare_response(&signals), Some(CloudflareError::ChallengeInterstitial403)); + } + + #[test] + fn access_denied_1020() { + assert_eq!(classify(403, BLOCK_PAGE), Some(CloudflareError::AccessDenied1020)); + } + + #[test] + fn rate_limited_1015() { + assert_eq!(classify(429, RATE_LIMIT_PAGE), Some(CloudflareError::RateLimited429)); + // A 429 with a plain body counts when headers prove the edge answered. + let signals = CloudflareResponseSignals::new(429, "slow down").with_server_header(Some("cloudflare")); + assert_eq!(classify_cloudflare_response(&signals), Some(CloudflareError::RateLimited429)); + } + + #[test] + fn origin_failures_need_cloudflare_attribution() { + assert_eq!(classify(502, ORIGIN_502_PAGE), Some(CloudflareError::BadGateway502)); + // An origin's own 502 (no Cloudflare markers) is not ours to label. + assert_eq!(classify(502, r#"{"error":"upstream failed"}"#), None); + // ...unless the headers say the edge produced it. + let signals = CloudflareResponseSignals::new(504, "").with_cf_ray(Some("8abc-SJC")).with_server_header(Some("cloudflare")); + assert_eq!(classify_cloudflare_response(&signals), Some(CloudflareError::GatewayTimeout504)); + } + + #[test] + fn fifty_two_x_family() { + assert_eq!(classify(524, "cloudflare"), Some(CloudflareError::TimeoutOccurred524)); + assert_eq!(classify(522, "cloudflare"), Some(CloudflareError::OriginError5xx(522))); + assert_eq!(classify(503, "cloudflare"), Some(CloudflareError::ServiceUnavailable503)); + } + + #[test] + fn an_api_403_from_the_origin_is_not_cloudflare() { + // A JSON 403 from the app itself, even with a cf-ray (it passed through). + let signals = CloudflareResponseSignals::new(403, r#"{"detail":"Forbidden"}"#).with_cf_ray(Some("8abc-SJC")); + assert_eq!(classify_cloudflare_response(&signals), None); + } + + #[test] + fn semantics() { + assert!(CloudflareError::ChallengeInterstitial403.is_access_denied()); + assert!(CloudflareError::ChallengeInterstitial403.is_challenge()); + assert!(!CloudflareError::ChallengeInterstitial403.is_retryable()); + assert!(CloudflareError::RateLimited429.is_access_denied()); + assert!(CloudflareError::RateLimited429.is_retryable()); + assert!(CloudflareError::BadGateway502.is_origin_failure()); + assert!(CloudflareError::BadGateway502.is_retryable()); + assert_eq!(CloudflareError::ChallengeInterstitial403.log_level(), log::Level::Warn); + assert_eq!(CloudflareError::BadGateway502.log_level(), log::Level::Info); + } +} diff --git a/crates/lib/cloudflare_errors/src/cloudflare_error.rs b/crates/lib/cloudflare_errors/src/cloudflare_error.rs new file mode 100644 index 00000000..2eeedf95 --- /dev/null +++ b/crates/lib/cloudflare_errors/src/cloudflare_error.rs @@ -0,0 +1,136 @@ +use log::Level; +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// A response that came from Cloudflare's edge instead of the origin. +/// +/// Two families, which need opposite reactions: +/// - **Access decisions** (challenge, block, rate limit): the *request* is +/// the problem — retrying the same thing just repeats the answer. See +/// [`Self::is_access_denied`]. +/// - **Origin failures** (502/504/52x): the *site* is the problem — wait +/// and retry. See [`Self::is_origin_failure`]. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum CloudflareError { + /// 301 from Cloudflare (e.g. an always-HTTPS or www redirect the client + /// didn't follow). + /// TODO: This needs to include "location" and "set-cookie" headers. + MovedPermanently301, + + /// A bot-management challenge (managed challenge / JS challenge / Turnstile + /// interstitial — "Just a moment..."). Only a real browser can pass it; the + /// fix is a fresh `cf_clearance` from a browser presenting the SAME + /// User-Agent and IP the replaying client uses. + ChallengeInterstitial403, + + /// A hard WAF / firewall block (error 1020 "Access denied" and friends). + /// The site's rules rejected this client outright; a challenge won't be + /// offered. + AccessDenied1020, + + /// Cloudflare's rate limiting (429 from the edge, error 1015). + RateLimited429, + + /// Cloudflare returned a 502 Bad Gateway response. + BadGateway502, + + /// 503 from the edge: origin overloaded, or "I'm Under Attack" mode. + ServiceUnavailable503, + + /// Cloudflare could not form a connection to the backend server. + GatewayTimeout504, + + /// 52x origin errors other than the ones above (520 unknown, 521 down, + /// 522 connection timed out, 523 unreachable, 525/526 TLS). + OriginError5xx(u16), + + /// Cloudflare formed a TCP connection to the backend server, but no payload was delivered before timeout + TimeoutOccurred524, +} + +impl Error for CloudflareError {} + +impl Display for CloudflareError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::MovedPermanently301 => { + write!(f, "Cloudflare Moved Permanently (301)") + } + Self::ChallengeInterstitial403 => { + write!(f, "Cloudflare Challenge Interstitial (403); Cloudflare wants to verify the request with a CAPTCHA challenge.") + } + Self::AccessDenied1020 => { + write!(f, "Cloudflare Access Denied (error 1020); the site's firewall rules blocked this client.") + } + Self::RateLimited429 => { + write!(f, "Cloudflare Rate Limited (429 / error 1015); slow down before retrying.") + } + Self::BadGateway502 => { + write!(f, "Cloudflare Bad Gateway (502); This is likely a backend server issue.") + } + Self::ServiceUnavailable503 => { + write!(f, "Cloudflare Service Unavailable (503); the origin is overloaded or in Under Attack mode.") + } + Self::GatewayTimeout504 => { + write!(f, "Cloudflare Gateway Timeout (504); This is likely a backend server issue.") + } + Self::OriginError5xx(status) => { + write!(f, "Cloudflare origin error ({}); Cloudflare could not get a usable response from the backend server.", status) + } + Self::TimeoutOccurred524 => { + write!(f, "Cloudflare Timeout (524); This is likely a backend server issue. Cloudflare connected, but did not receive a response from the server in time.") + } + } + } +} + +impl CloudflareError { + /// Cloudflare refused this client (challenge, block, rate limit). Retrying + /// unchanged won't help; see `cloudflare_mitigation` for what will. + pub fn is_access_denied(&self) -> bool { + matches!( + self, + Self::ChallengeInterstitial403 | Self::AccessDenied1020 | Self::RateLimited429, + ) + } + + /// A bot-management challenge specifically — passable only by a browser. + pub fn is_challenge(&self) -> bool { + matches!(self, Self::ChallengeInterstitial403) + } + + /// The origin behind Cloudflare is failing; the request itself was fine. + pub fn is_origin_failure(&self) -> bool { + matches!( + self, + Self::BadGateway502 + | Self::ServiceUnavailable503 + | Self::GatewayTimeout504 + | Self::OriginError5xx(_) + | Self::TimeoutOccurred524, + ) + } + + /// Whether waiting and retrying the same request is reasonable. + pub fn is_retryable(&self) -> bool { + self.is_origin_failure() || matches!(self, Self::RateLimited429) + } + + /// The level a client should log this at. Origin failures are the site's + /// problem (info — expected noise); challenges and blocks mean our + /// fingerprint or session is off and need a human eventually (warn); + /// redirects we didn't expect are a client bug (error). + pub fn log_level(&self) -> Level { + match self { + Self::ChallengeInterstitial403 | Self::AccessDenied1020 | Self::RateLimited429 => Level::Warn, + Self::MovedPermanently301 => Level::Error, + _ => Level::Info, + } + } + + /// Log at [`Self::log_level`] with a caller-supplied context (which host, + /// which endpoint). One place to keep the wording consistent. + pub fn log(&self, context: &str) { + log::log!(self.log_level(), "[cloudflare] {}: {}", context, self); + } +} diff --git a/crates/lib/cloudflare_errors/src/cloudflare_response_signals.rs b/crates/lib/cloudflare_errors/src/cloudflare_response_signals.rs new file mode 100644 index 00000000..6eb0684c --- /dev/null +++ b/crates/lib/cloudflare_errors/src/cloudflare_response_signals.rs @@ -0,0 +1,56 @@ +/// Everything about a response that helps decide whether Cloudflare's edge +/// produced it. Build with [`Self::new`] and add whichever headers the HTTP +/// client exposes; the body-only path works without any. +#[derive(Debug, Clone, Default)] +pub struct CloudflareResponseSignals<'a> { + pub status_code: u16, + + pub body: &'a str, + + /// The `server` response header. Cloudflare's edge sets `cloudflare`. + pub maybe_server_header: Option<&'a str>, + + /// The `cf-ray` header: present on every response that passed through + /// Cloudflare (origin responses included). + pub maybe_cf_ray: Option<&'a str>, + + /// The `cf-mitigated` header: `challenge` when the response IS a + /// bot-management challenge. The definitive signal when available. + pub maybe_cf_mitigated: Option<&'a str>, +} + +impl<'a> CloudflareResponseSignals<'a> { + pub fn new(status_code: u16, body: &'a str) -> Self { + Self { + status_code, + body, + maybe_server_header: None, + maybe_cf_ray: None, + maybe_cf_mitigated: None, + } + } + + pub fn with_server_header(mut self, server: Option<&'a str>) -> Self { + self.maybe_server_header = server; + self + } + + pub fn with_cf_ray(mut self, cf_ray: Option<&'a str>) -> Self { + self.maybe_cf_ray = cf_ray; + self + } + + pub fn with_cf_mitigated(mut self, cf_mitigated: Option<&'a str>) -> Self { + self.maybe_cf_mitigated = cf_mitigated; + self + } + + /// Whether the headers prove the response passed through Cloudflare. + /// `None` means we weren't given headers, not that it didn't. + pub fn headers_say_cloudflare(&self) -> Option { + if self.maybe_cf_ray.is_some() || self.maybe_cf_mitigated.is_some() { + return Some(true); + } + self.maybe_server_header.map(|server| server.eq_ignore_ascii_case("cloudflare")) + } +} diff --git a/crates/lib/cloudflare_errors/src/filter_cloudflare_errors.rs b/crates/lib/cloudflare_errors/src/filter_cloudflare_errors.rs new file mode 100644 index 00000000..866268f5 --- /dev/null +++ b/crates/lib/cloudflare_errors/src/filter_cloudflare_errors.rs @@ -0,0 +1,36 @@ +use crate::classify_cloudflare_response::classify_cloudflare_response; +use crate::cloudflare_error::CloudflareError; +use crate::cloudflare_response_signals::CloudflareResponseSignals; + +/// Status + body shortcut over +/// [`classify_cloudflare_response`]: `Err` when the response is a Cloudflare +/// edge response, `Ok(())` for everything else (including non-Cloudflare +/// errors, which the caller classifies itself). +/// +/// Prefer the full classifier when the HTTP client exposes response headers +/// — `cf-mitigated` and `server` make the decision exact. +pub fn filter_cloudflare_errors(status_code: u16, body: &str) -> Result<(), CloudflareError> { + match classify_cloudflare_response(&CloudflareResponseSignals::new(status_code, body)) { + Some(error) => Err(error), + None => Ok(()), + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn passes_non_cloudflare_errors_through() { + assert!(filter_cloudflare_errors(200, "ok").is_ok()); + assert!(filter_cloudflare_errors(500, r#"{"detail":"boom"}"#).is_ok()); + } + + #[test] + fn catches_challenge_pages() { + assert_eq!( + filter_cloudflare_errors(403, "Just a moment..."), + Err(CloudflareError::ChallengeInterstitial403), + ); + } +} diff --git a/crates/lib/cloudflare_errors/src/lib.rs b/crates/lib/cloudflare_errors/src/lib.rs new file mode 100644 index 00000000..4289e5ba --- /dev/null +++ b/crates/lib/cloudflare_errors/src/lib.rs @@ -0,0 +1,32 @@ +//! cloudflare_errors +//! +//! Recognize responses that came from Cloudflare's edge rather than the +//! origin — bot-management challenges, WAF blocks, and origin failures — so +//! every API client can react the same way. Pair with `cloudflare_mitigation` +//! for what to do about each. +//! +//! Entry points: +//! - [`classify_cloudflare_response`](classify_cloudflare_response::classify_cloudflare_response) +//! — the full classifier: status + body + the Cloudflare response headers. +//! - [`filter_cloudflare_errors`](filter_cloudflare_errors::filter_cloudflare_errors) +//! — the status + body shortcut most clients use. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod classify_cloudflare_response; +pub mod cloudflare_error; +pub mod cloudflare_response_signals; +pub mod filter_cloudflare_errors; diff --git a/crates/lib/cloudflare_mitigation/Cargo.toml b/crates/lib/cloudflare_mitigation/Cargo.toml new file mode 100644 index 00000000..4e6b41ce --- /dev/null +++ b/crates/lib/cloudflare_mitigation/Cargo.toml @@ -0,0 +1,27 @@ +[package] +name = "cloudflare_mitigation" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "cloudflare_mitigation" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +browser_emulation.workspace = true +cloudflare_errors.workspace = true + +# External +once_cell.workspace = true +wreq.workspace = true + +[dev-dependencies] +# (None) diff --git a/crates/lib/cloudflare_mitigation/src/clearance/clearance_binding.rs b/crates/lib/cloudflare_mitigation/src/clearance/clearance_binding.rs new file mode 100644 index 00000000..17ca0a79 --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/clearance/clearance_binding.rs @@ -0,0 +1,57 @@ +use browser_emulation::browser_profile::BrowserProfile; + +/// The cookie Cloudflare issues once a client passes a challenge. It is +/// bound to the client's User-Agent and IP, and validated against the TLS / +/// HTTP fingerprint, for a site-configured lifetime (30 minutes by default, +/// often extended to hours or days). +pub const CF_CLEARANCE_COOKIE: &str = "cf_clearance"; + +/// Whether a cookie header carries a clearance at all. Without one, a +/// challenge is a normal first contact rather than a broken replay. +pub fn cookie_header_has_clearance(cookie_header: &str) -> bool { + cookie_header + .split(';') + .filter_map(|pair| pair.trim().split_once('=')) + .any(|(name, value)| name.trim() == CF_CLEARANCE_COOKIE && !value.trim().is_empty()) +} + +/// The browser profile an HTTP client must use to replay cookies captured +/// by another client (typically a login webview): the exact User-Agent that +/// earned the `cf_clearance`, on the fingerprint of the same browser family. +/// +/// When the capturing UA wasn't recorded, fall back to the profile the +/// integration pins on both sides (e.g. `MIDJOURNEY_USER_AGENT`). +pub fn profile_for_captured_user_agent( + maybe_captured_user_agent: Option<&str>, + fallback: BrowserProfile, +) -> BrowserProfile { + match maybe_captured_user_agent.map(str::trim).filter(|ua| !ua.is_empty()) { + Some(user_agent) => BrowserProfile::matching_user_agent(user_agent), + None => fallback, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn detects_clearance_cookie() { + assert!(cookie_header_has_clearance("a=1; cf_clearance=abc.def-ghi; b=2")); + assert!(!cookie_header_has_clearance("a=1; b=2")); + assert!(!cookie_header_has_clearance("cf_clearance=")); + } + + #[test] + fn captured_ua_wins_over_fallback() { + let ua = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15"; + let profile = profile_for_captured_user_agent(Some(ua), BrowserProfile::Chrome145); + assert_eq!(profile.maybe_user_agent_override(), Some(ua)); + + let profile = profile_for_captured_user_agent(None, BrowserProfile::Chrome145); + assert_eq!(profile, BrowserProfile::Chrome145); + + let profile = profile_for_captured_user_agent(Some(" "), BrowserProfile::Chrome145); + assert_eq!(profile, BrowserProfile::Chrome145); + } +} diff --git a/crates/lib/cloudflare_mitigation/src/clearance/mod.rs b/crates/lib/cloudflare_mitigation/src/clearance/mod.rs new file mode 100644 index 00000000..3f616e2a --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/clearance/mod.rs @@ -0,0 +1 @@ +pub mod clearance_binding; diff --git a/crates/lib/cloudflare_mitigation/src/headers/firefox_websocket_http_1_1_headers.rs b/crates/lib/cloudflare_mitigation/src/headers/firefox_websocket_http_1_1_headers.rs new file mode 100644 index 00000000..3502b9fe --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/headers/firefox_websocket_http_1_1_headers.rs @@ -0,0 +1,33 @@ +use once_cell::sync::Lazy; +use wreq::header::OrigHeaderMap; + +/// Header casing and order needed to bypass Cloudflare WebSocket HTTP/1.1 checks. +/// This is the set of headers sent by Firefox 143 on macOS. +static FIREFOX_WEBSOCKET_HTTP_1_1_HEADERS : Lazy = Lazy::new(|| { + let mut original_headers = OrigHeaderMap::new(); + + original_headers.insert("Host"); + original_headers.insert("User-Agent"); + original_headers.insert("Accept"); + original_headers.insert("Accept-Language"); + original_headers.insert("Accept-Encoding"); + original_headers.insert("Sec-WebSocket-Version"); + original_headers.insert("Origin"); + original_headers.insert("Sec-WebSocket-Extensions"); + original_headers.insert("Sec-WebSocket-Key"); + original_headers.insert("Connection"); + original_headers.insert("Cookie"); + original_headers.insert("Sec-Fetch-Dest"); + original_headers.insert("Sec-Fetch-Mode"); + original_headers.insert("Sec-Fetch-Site"); + original_headers.insert("Pragma"); + original_headers.insert("Cache-Control"); + original_headers.insert("Upgrade"); + + original_headers +}); + +/// Wreq expects an owned copy, so we are required to clone. +pub fn get_firefox_websocket_http_1_1_headers() -> OrigHeaderMap { + FIREFOX_WEBSOCKET_HTTP_1_1_HEADERS.clone() +} \ No newline at end of file diff --git a/crates/lib/cloudflare_mitigation/src/headers/mod.rs b/crates/lib/cloudflare_mitigation/src/headers/mod.rs new file mode 100644 index 00000000..6352f64f --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/headers/mod.rs @@ -0,0 +1 @@ +pub mod firefox_websocket_http_1_1_headers; \ No newline at end of file diff --git a/crates/lib/cloudflare_mitigation/src/lib.rs b/crates/lib/cloudflare_mitigation/src/lib.rs new file mode 100644 index 00000000..6c0b617e --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/lib.rs @@ -0,0 +1,18 @@ +//! cloudflare_mitigation +//! +//! What to do when Cloudflare's edge answers instead of the origin. The +//! errors themselves live in `cloudflare_errors`; this crate holds the +//! counter-measures every API client and the desktop app share: +//! +//! - [`strategy`] — map a [`CloudflareError`](cloudflare_errors::cloudflare_error::CloudflareError) +//! to a [`CloudflareMitigation`](strategy::cloudflare_mitigation::CloudflareMitigation): +//! retry with backoff, or send the user back to a browser. +//! - [`clearance`] — keep replayed `cf_clearance` cookies valid by presenting +//! the same User-Agent (on the same browser family's fingerprint) as the +//! browser that earned them. +//! - [`headers`] — exact header casing/order for protocol paths Cloudflare +//! fingerprints (websocket upgrades). + +pub mod clearance; +pub mod headers; +pub mod strategy; diff --git a/crates/lib/cloudflare_mitigation/src/strategy/cloudflare_mitigation.rs b/crates/lib/cloudflare_mitigation/src/strategy/cloudflare_mitigation.rs new file mode 100644 index 00000000..07fc9fbf --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/strategy/cloudflare_mitigation.rs @@ -0,0 +1,109 @@ +use cloudflare_errors::cloudflare_error::CloudflareError; +use std::time::Duration; + +/// Base delay for origin-failure retries; doubles per attempt. +const ORIGIN_FAILURE_BASE_DELAY: Duration = Duration::from_secs(5); +const ORIGIN_FAILURE_MAX_DELAY: Duration = Duration::from_secs(120); + +/// Rate limits back off harder: Cloudflare's window is typically a minute. +const RATE_LIMIT_BASE_DELAY: Duration = Duration::from_secs(30); +const RATE_LIMIT_MAX_DELAY: Duration = Duration::from_secs(300); + +/// The counter-measure for a Cloudflare edge response. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum CloudflareMitigation { + /// The origin is failing or we're rate limited: wait this long, then retry + /// the same request unchanged. + RetryAfter(Duration), + + /// A challenge only a browser can pass. Send the user through the site's + /// login window again to earn a fresh `cf_clearance` — and make sure the + /// replaying client presents the same User-Agent that window used + /// (see `clearance::profile_for_captured_user_agent`). + ReauthenticateInBrowser, + + /// The firewall rejected this client outright. Retrying or re-logging in + /// won't help; surface it and stop. + GiveUp, +} + +impl CloudflareMitigation { + /// Whether the caller should try the request again (after + /// [`Self::retry_delay`]). + pub fn should_retry(&self) -> bool { + matches!(self, Self::RetryAfter(_)) + } + + pub fn retry_delay(&self) -> Option { + match self { + Self::RetryAfter(delay) => Some(*delay), + _ => None, + } + } + + /// Whether the session needs a human in a browser before continuing. + pub fn needs_browser(&self) -> bool { + matches!(self, Self::ReauthenticateInBrowser) + } +} + +/// The mitigation for an error on the given retry `attempt` (0 = first +/// retry). Delays grow exponentially and cap. +pub fn mitigation_for(error: &CloudflareError, attempt: u32) -> CloudflareMitigation { + match error { + CloudflareError::ChallengeInterstitial403 => CloudflareMitigation::ReauthenticateInBrowser, + CloudflareError::AccessDenied1020 => CloudflareMitigation::GiveUp, + // An unexpected redirect is a client bug (wrong host/scheme), not + // something waiting fixes. + CloudflareError::MovedPermanently301 => CloudflareMitigation::GiveUp, + CloudflareError::RateLimited429 => { + CloudflareMitigation::RetryAfter(backoff(RATE_LIMIT_BASE_DELAY, RATE_LIMIT_MAX_DELAY, attempt)) + } + CloudflareError::BadGateway502 + | CloudflareError::ServiceUnavailable503 + | CloudflareError::GatewayTimeout504 + | CloudflareError::OriginError5xx(_) + | CloudflareError::TimeoutOccurred524 => { + CloudflareMitigation::RetryAfter(backoff(ORIGIN_FAILURE_BASE_DELAY, ORIGIN_FAILURE_MAX_DELAY, attempt)) + } + } +} + +fn backoff(base: Duration, max: Duration, attempt: u32) -> Duration { + let multiplier = 2u32.saturating_pow(attempt.min(16)); + base.saturating_mul(multiplier).min(max) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn challenge_means_browser() { + let mitigation = mitigation_for(&CloudflareError::ChallengeInterstitial403, 0); + assert_eq!(mitigation, CloudflareMitigation::ReauthenticateInBrowser); + assert!(mitigation.needs_browser()); + assert!(!mitigation.should_retry()); + } + + #[test] + fn hard_block_gives_up() { + assert_eq!(mitigation_for(&CloudflareError::AccessDenied1020, 0), CloudflareMitigation::GiveUp); + assert_eq!(mitigation_for(&CloudflareError::MovedPermanently301, 3), CloudflareMitigation::GiveUp); + } + + #[test] + fn origin_failures_back_off_and_cap() { + assert_eq!(mitigation_for(&CloudflareError::BadGateway502, 0), CloudflareMitigation::RetryAfter(Duration::from_secs(5))); + assert_eq!(mitigation_for(&CloudflareError::GatewayTimeout504, 1), CloudflareMitigation::RetryAfter(Duration::from_secs(10))); + assert_eq!(mitigation_for(&CloudflareError::TimeoutOccurred524, 2), CloudflareMitigation::RetryAfter(Duration::from_secs(20))); + assert_eq!(mitigation_for(&CloudflareError::OriginError5xx(522), 10), CloudflareMitigation::RetryAfter(Duration::from_secs(120))); + assert_eq!(mitigation_for(&CloudflareError::OriginError5xx(522), 40).retry_delay(), Some(Duration::from_secs(120))); + } + + #[test] + fn rate_limits_back_off_harder() { + assert_eq!(mitigation_for(&CloudflareError::RateLimited429, 0), CloudflareMitigation::RetryAfter(Duration::from_secs(30))); + assert_eq!(mitigation_for(&CloudflareError::RateLimited429, 5), CloudflareMitigation::RetryAfter(Duration::from_secs(300))); + } +} diff --git a/crates/lib/cloudflare_mitigation/src/strategy/mod.rs b/crates/lib/cloudflare_mitigation/src/strategy/mod.rs new file mode 100644 index 00000000..eebd5f6d --- /dev/null +++ b/crates/lib/cloudflare_mitigation/src/strategy/mod.rs @@ -0,0 +1 @@ +pub mod cloudflare_mitigation; diff --git a/crates/lib/cookie_store_wrapper/Cargo.toml b/crates/lib/cookie_store_wrapper/Cargo.toml new file mode 100644 index 00000000..72fcf11b --- /dev/null +++ b/crates/lib/cookie_store_wrapper/Cargo.toml @@ -0,0 +1,43 @@ +[package] +name = "cookie_store_wrapper" +edition = "2024" +version = "0.0.2" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "cookie_store_wrapper" +path = "src/lib.rs" + +[features] +default = [] +# Implements the wreq `CookieStore` trait on `SharedCookieStore` so a wreq +# client can read from and write Set-Cookie responses into a shared store. +wreq = ["dep:wreq"] + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# External +chrono.workspace = true +log.workspace = true +serde.workspace = true +serde_json.workspace = true +url.workspace = true + +# NB: For converting cookie expiry timestamps; the `cookie` crate (via +# `cookie_store`) already depends on `time`, so this adds no new weight. +time = "0.3" +wreq = { workspace = true, optional = true } + +# NB: The RFC 6265 cookie store implementation this crate wraps. `serde_json` +# enables cookie serialization; we skip `public_suffix` to keep dependencies +# minimal. +cookie_store = { version = "0.21.1", default-features = false, features = ["serde_json"] } + +[dev-dependencies] +serde_derive.workspace = true +toml.workspace = true diff --git a/crates/lib/cookie_store_wrapper/src/change_log.rs b/crates/lib/cookie_store_wrapper/src/change_log.rs new file mode 100644 index 00000000..b760225c --- /dev/null +++ b/crates/lib/cookie_store_wrapper/src/change_log.rs @@ -0,0 +1,91 @@ +use std::collections::VecDeque; +use std::time::SystemTime; + +/// Oldest records are dropped once the log exceeds this many entries. +pub const MAX_CHANGE_LOG_RECORDS: usize = 256; + +/// A bounded, in-memory history of cookie store mutations, for debugging +/// auth flows ("did the provider rotate the session cookie?", "when did we +/// lose it?"). Values are intentionally not recorded — only names, domains, +/// and what happened. +#[derive(Clone, Debug, Default)] +pub struct CookieChangeLog { + records: VecDeque, + next_sequence_number: u64, +} + +#[derive(Clone, Debug)] +pub struct CookieChangeRecord { + pub sequence_number: u64, + pub timestamp: SystemTime, + pub action: CookieChangeAction, + pub cookie_name: String, + pub maybe_domain: Option, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum CookieChangeAction { + /// A new cookie was stored. + Inserted, + /// An existing cookie's value was replaced. + Updated, + /// A server sent an expired Set-Cookie, deleting the stored cookie. + ExpiredByServer, + /// A cookie was refused (domain mismatch, malformed, etc.). + Rejected, + /// The whole store was cleared. + Cleared, +} + +impl CookieChangeLog { + pub fn record( + &mut self, + action: CookieChangeAction, + cookie_name: &str, + maybe_domain: Option, + ) { + self.records.push_back(CookieChangeRecord { + sequence_number: self.next_sequence_number, + timestamp: SystemTime::now(), + action, + cookie_name: cookie_name.to_owned(), + maybe_domain, + }); + self.next_sequence_number += 1; + while self.records.len() > MAX_CHANGE_LOG_RECORDS { + self.records.pop_front(); + } + } + + /// Records in chronological order, oldest first. + pub fn iter(&self) -> impl Iterator { + self.records.iter() + } + + pub fn len(&self) -> usize { + self.records.len() + } + + pub fn is_empty(&self) -> bool { + self.records.is_empty() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn log_is_bounded_and_keeps_newest_records() { + let mut log = CookieChangeLog::default(); + for index in 0..(MAX_CHANGE_LOG_RECORDS + 10) { + log.record(CookieChangeAction::Inserted, &format!("cookie_{index}"), None); + } + + assert_eq!(log.len(), MAX_CHANGE_LOG_RECORDS); + let first = log.iter().next().unwrap(); + assert_eq!(first.sequence_number, 10); + let last = log.iter().last().unwrap(); + assert_eq!(last.cookie_name, format!("cookie_{}", MAX_CHANGE_LOG_RECORDS + 9)); + } +} diff --git a/crates/lib/cookie_store_wrapper/src/cookie_store.rs b/crates/lib/cookie_store_wrapper/src/cookie_store.rs new file mode 100644 index 00000000..fca28dfb --- /dev/null +++ b/crates/lib/cookie_store_wrapper/src/cookie_store.rs @@ -0,0 +1,396 @@ +use crate::change_log::{CookieChangeAction, CookieChangeLog}; +use log::warn; +use ::cookie_store::{CookieError, CookieStore as CookieStoreRfc, RawCookie, StoreAction}; +use url::Url; + +/// A cookie jar with RFC 6265 storage semantics. +/// +/// Cookies are keyed by `(domain, path, name)` — not just name — and a repeat +/// `Set-Cookie` for the same key replaces the old value, while an expired +/// `Set-Cookie` deletes it (the standard server-side removal mechanism). +/// Every mutation is recorded in a bounded [`CookieChangeLog`] for debugging. +/// +/// This is a plain value type; wrap it in +/// [`crate::shared_cookie_store::SharedCookieStore`] to share it between +/// threads. +#[derive(Clone, Debug, Default)] +pub struct CookieStore { + store: CookieStoreRfc, + change_log: CookieChangeLog, +} + +/// A cookie captured from a browser or webview, with as much metadata as the +/// browser reported. +#[derive(Clone, Debug)] +pub struct CapturedCookie { + pub name: String, + pub value: String, + + /// Domain as reported by the browser. May carry a leading dot + /// (e.g. `.storyteller.ai`), which marks a parent-domain cookie. + pub maybe_domain: Option, + + pub maybe_path: Option, +} + +impl CookieStore { + pub fn empty() -> Self { + Self::default() + } + + /// Parse a raw `Cookie:` request-header string (`"a=1; b=2"`) into a new + /// store of host-only cookies for `source_url`'s host. This is the entry + /// point for hand-entered cookie headers, where per-cookie attributes are + /// not known. + pub fn from_cookie_header(cookie_header: &str, source_url: &Url) -> Self { + let mut store = Self::empty(); + store.insert_cookie_header(cookie_header, source_url); + store + } + + pub (crate) fn from_rfc_store(store: CookieStoreRfc) -> Self { + Self { + store, + change_log: CookieChangeLog::default(), + } + } + + /// Insert a bare name/value cookie as a host-only cookie for `source_url`'s + /// host. Returns whether the cookie was stored (or expired an existing one). + pub fn insert_named(&mut self, name: &str, value: &str, source_url: &Url) -> bool { + let raw = RawCookie::new(name.to_owned(), value.to_owned()); + self.insert_raw(&raw, source_url) + } + + /// Insert a cookie captured from a browser or webview. + /// + /// When the capture carries a domain, the cookie is stored as a + /// domain-suffix cookie for it (so it matches subdomains, mirroring how the + /// browser scoped it). Without a domain it falls back to a host-only cookie + /// for `fallback_source_url`. + pub fn insert_captured(&mut self, captured: CapturedCookie, fallback_source_url: &Url) -> bool { + let maybe_domain = captured.maybe_domain + .as_deref() + .map(|domain| domain.trim_start_matches('.').to_ascii_lowercase()) + .filter(|domain| !domain.is_empty()); + + let Some(domain) = maybe_domain else { + return self.insert_named(&captured.name, &captured.value, fallback_source_url); + }; + + let source_url = match Url::parse(&format!("https://{domain}/")) { + Ok(url) => url, + Err(err) => { + warn!("Cannot build source URL for captured cookie {:?} (domain {:?}): {:?}", + captured.name, domain, err); + return false; + } + }; + + let mut raw = RawCookie::new(captured.name, captured.value); + raw.set_domain(domain); + raw.set_path(captured.maybe_path.unwrap_or_else(|| "/".to_owned())); + self.insert_raw(&raw, &source_url) + } + + /// Insert every `name=value` pair of a raw `Cookie:` request-header string + /// as a host-only cookie for `source_url`'s host. Returns how many cookies + /// were stored. + pub fn insert_cookie_header(&mut self, cookie_header: &str, source_url: &Url) -> usize { + cookie_header + .split(';') + .filter_map(|pair| pair.trim().split_once('=')) + .filter(|(name, _)| !name.trim().is_empty()) + .map(|(name, value)| (name.trim().to_owned(), value.trim().to_owned())) + .collect::>() + .into_iter() + .filter(|(name, value)| self.insert_named(name, value, source_url)) + .count() + } + + /// Apply one `Set-Cookie` header value received from `request_url`, + /// following the RFC 6265 storage model (replace / expire / reject). + pub fn apply_set_cookie_header(&mut self, set_cookie_value: &str, request_url: &Url) -> bool { + let cookie_name = set_cookie_value + .split('=') + .next() + .unwrap_or(set_cookie_value) + .trim() + .to_owned(); + let result = self.store.parse(set_cookie_value, request_url); + self.record_insert_result(result, &cookie_name, request_url) + } + + /// Apply several `Set-Cookie` header values received from `request_url`. + /// Returns how many were accepted. + pub fn apply_set_cookie_headers<'a>( + &mut self, + set_cookie_values: impl Iterator, + request_url: &Url, + ) -> usize { + set_cookie_values + .filter(|value| self.apply_set_cookie_header(value, request_url)) + .count() + } + + pub fn clear_all(&mut self) { + self.store.clear(); + self.change_log.record(CookieChangeAction::Cleared, "*", None); + } + + /// Whether an unexpired cookie with this name exists on any domain. + pub fn has_cookie(&self, name: &str) -> bool { + self.store.iter_unexpired().any(|cookie| cookie.name() == name) + } + + /// The value of the first unexpired cookie with this name, on any domain. + pub fn get_cookie_value(&self, name: &str) -> Option<&str> { + self.store + .iter_unexpired() + .find(|cookie| cookie.name() == name) + .map(|cookie| cookie.value()) + } + + /// `(name, value)` pairs of every unexpired cookie, across all domains. + pub fn iter_name_values(&self) -> impl Iterator { + self.store + .iter_unexpired() + .map(|cookie| (cookie.name(), cookie.value())) + } + + /// Names of every unexpired cookie, across all domains. + pub fn cookie_names(&self) -> Vec { + self.iter_name_values() + .map(|(name, _)| name.to_owned()) + .collect() + } + + pub fn len(&self) -> usize { + self.store.iter_unexpired().count() + } + + pub fn is_empty(&self) -> bool { + self.store.iter_unexpired().next().is_none() + } + + /// NB: Just use this as a heuristic, and do not call it in a loop. + pub fn calculate_approx_cookie_character_length(&self) -> usize { + const COOKIE_SEP_LENGTH: usize = 2; // '=' and ';' + self.iter_name_values() + .map(|(name, value)| name.len() + value.len() + COOKIE_SEP_LENGTH) + .sum() + } + + /// Every unexpired cookie joined into one `Cookie:` header string, + /// regardless of domain or path. + /// + /// This is a blunt tool for scraping clients that captured cookies for one + /// known site and want to send them all back. It performs no request + /// matching; two same-named cookies on different domains both appear. + /// Prefer [`Self::cookie_header_for_url`] when the request URL is known. + pub fn to_cookie_string(&self) -> String { + self.iter_name_values() + .map(|(name, value)| format!("{}={}", name, value)) + .collect::>() + .join("; ") + } + + /// A `Cookie:` header value containing only the cookies that RFC 6265 + /// domain/path/secure matching would send to `request_url`, or `None` when + /// no cookies match. + pub fn cookie_header_for_url(&self, request_url: &Url) -> Option { + let header = self.store + .get_request_values(request_url) + .map(|(name, value)| format!("{}={}", name, value)) + .collect::>() + .join("; "); + if header.is_empty() { + None + } else { + Some(header) + } + } + + /// The recent mutation history, for debugging. + pub fn change_log(&self) -> &CookieChangeLog { + &self.change_log + } + + pub (crate) fn rfc_store(&self) -> &CookieStoreRfc { + &self.store + } + + pub (crate) fn insert_raw(&mut self, raw: &RawCookie<'static>, source_url: &Url) -> bool { + let cookie_name = raw.name().to_owned(); + let result = self.store.insert_raw(raw, source_url); + self.record_insert_result(result, &cookie_name, source_url) + } + + fn record_insert_result( + &mut self, + result: Result, + cookie_name: &str, + request_url: &Url, + ) -> bool { + let maybe_domain = request_url.host_str().map(str::to_owned); + match result { + Ok(StoreAction::Inserted) => { + self.change_log.record(CookieChangeAction::Inserted, cookie_name, maybe_domain); + true + } + Ok(StoreAction::UpdatedExisting) => { + self.change_log.record(CookieChangeAction::Updated, cookie_name, maybe_domain); + true + } + Ok(StoreAction::ExpiredExisting) => { + self.change_log.record(CookieChangeAction::ExpiredByServer, cookie_name, maybe_domain); + true + } + Err(err) => { + warn!("Rejected cookie {:?} from {}: {:?}", cookie_name, request_url, err); + self.change_log.record(CookieChangeAction::Rejected, cookie_name, maybe_domain); + false + } + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::change_log::CookieChangeAction; + + const SITE_URL: &str = "https://www.example.com/"; + + mod insert_tests { + use super::*; + + #[test] + fn insert_named_stores_host_only_cookie() { + let mut store = CookieStore::empty(); + assert!(store.insert_named("session", "abc123", &site_url())); + + assert!(store.has_cookie("session")); + assert_eq!(store.get_cookie_value("session"), Some("abc123")); + assert_eq!(store.len(), 1); + } + + #[test] + fn insert_named_replaces_existing_value() { + let mut store = CookieStore::empty(); + store.insert_named("session", "old", &site_url()); + store.insert_named("session", "new", &site_url()); + + assert_eq!(store.len(), 1); + assert_eq!(store.get_cookie_value("session"), Some("new")); + } + + #[test] + fn insert_captured_with_parent_domain_matches_subdomains() { + let mut store = CookieStore::empty(); + let captured = CapturedCookie { + name: "auth".to_string(), + value: "token".to_string(), + maybe_domain: Some(".example.com".to_string()), + maybe_path: None, + }; + assert!(store.insert_captured(captured, &site_url())); + + let subdomain_url = Url::parse("https://api.example.com/v1/things").unwrap(); + assert_eq!(store.cookie_header_for_url(&subdomain_url), Some("auth=token".to_string())); + } + + #[test] + fn insert_captured_without_domain_falls_back_to_source_url() { + let mut store = CookieStore::empty(); + let captured = CapturedCookie { + name: "sid".to_string(), + value: "xyz".to_string(), + maybe_domain: None, + maybe_path: None, + }; + assert!(store.insert_captured(captured, &site_url())); + + assert_eq!(store.cookie_header_for_url(&site_url()), Some("sid=xyz".to_string())); + } + } + + mod set_cookie_header_tests { + use super::*; + + #[test] + fn apply_set_cookie_header_stores_cookie() { + let mut store = CookieStore::empty(); + assert!(store.apply_set_cookie_header("session=abc; Path=/; HttpOnly", &site_url())); + assert_eq!(store.get_cookie_value("session"), Some("abc")); + } + + #[test] + fn expired_set_cookie_deletes_existing_cookie() { + let mut store = CookieStore::empty(); + store.apply_set_cookie_header("session=abc; Path=/", &site_url()); + assert!(store.has_cookie("session")); + + let accepted = store.apply_set_cookie_header( + "session=gone; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT", + &site_url(), + ); + assert!(accepted); + assert!(!store.has_cookie("session")); + } + + #[test] + fn set_cookie_for_mismatched_domain_is_rejected() { + let mut store = CookieStore::empty(); + let accepted = store.apply_set_cookie_header("evil=1; Domain=other.com", &site_url()); + assert!(!accepted); + assert!(!store.has_cookie("evil")); + } + } + + mod header_rendering_tests { + use super::*; + + #[test] + fn to_cookie_string_joins_all_cookies() { + let mut store = CookieStore::empty(); + store.insert_named("a", "1", &site_url()); + store.insert_named("b", "2", &site_url()); + + let header = store.to_cookie_string(); + let mut parts = header.split("; ").collect::>(); + parts.sort(); + assert_eq!(parts, vec!["a=1", "b=2"]); + } + + #[test] + fn cookie_header_for_url_excludes_other_hosts() { + let mut store = CookieStore::empty(); + store.insert_named("mine", "1", &site_url()); + store.insert_named("theirs", "2", &Url::parse("https://other.example.org/").unwrap()); + + assert_eq!(store.cookie_header_for_url(&site_url()), Some("mine=1".to_string())); + } + } + + mod change_log_tests { + use super::*; + + #[test] + fn mutations_are_recorded() { + let mut store = CookieStore::empty(); + store.insert_named("session", "a", &site_url()); + store.insert_named("session", "b", &site_url()); + + let actions = store.change_log() + .iter() + .map(|record| record.action) + .collect::>(); + assert_eq!(actions, vec![CookieChangeAction::Inserted, CookieChangeAction::Updated]); + } + } + + fn site_url() -> Url { + Url::parse(SITE_URL).unwrap() + } +} diff --git a/crates/lib/cookie_store_wrapper/src/lib.rs b/crates/lib/cookie_store_wrapper/src/lib.rs new file mode 100644 index 00000000..a501d02a --- /dev/null +++ b/crates/lib/cookie_store_wrapper/src/lib.rs @@ -0,0 +1,37 @@ +//! cookie_store_wrapper +//! +//! Cookie jar for scraping-style API clients. +//! +//! Wraps the RFC 6265 `cookie_store` crate so stored cookies follow real HTTP +//! semantics: domain and path matching, replacement on repeat Set-Cookie, and +//! server-driven expiry. On top of that this crate adds Serde support (embed a +//! [`cookie_store::CookieStore`] directly in your own serializable structs), a +//! bounded change log for debugging auth flows, and a cheaply clonable +//! thread-safe handle ([`shared_cookie_store::SharedCookieStore`]). +//! +//! With the `wreq` feature enabled, `SharedCookieStore` implements wreq's +//! `CookieStore` trait, so a wreq client built with it as the cookie provider +//! transparently applies every `Set-Cookie` response to the shared store. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod change_log; +pub mod cookie_store; +pub mod serde_support; +pub mod shared_cookie_store; + +#[cfg(feature = "wreq")] +pub mod wreq_cookie_provider; diff --git a/crates/lib/cookie_store_wrapper/src/serde_support.rs b/crates/lib/cookie_store_wrapper/src/serde_support.rs new file mode 100644 index 00000000..43de1bee --- /dev/null +++ b/crates/lib/cookie_store_wrapper/src/serde_support.rs @@ -0,0 +1,340 @@ +//! Serde support for [`CookieStore`] and [`SharedCookieStore`]. +//! +//! Both types implement `Serialize` and `Deserialize` directly, so callers +//! can embed a cookie store in their own serializable structs (JSON state +//! files, TOML credential files, etc.) without a conversion type: +//! +//! ```ignore +//! #[derive(Serialize, Deserialize)] +//! struct CookieCredential { +//! updated_at: Option>, +//! cookies: CookieStore, // NB: keep array-of-table fields LAST for TOML +//! } +//! ``` +//! +//! The wire shape is a flat list of cookies, chosen to stay human-editable +//! when it lands in a TOML file someone opens in vim: +//! +//! ```toml +//! [[cookie.cookies]] +//! name = "session" +//! value = "abc123" +//! domain = "example.com" +//! secure = true +//! http_only = true +//! expires = "2027-01-01T00:00:00+00:00" +//! ``` +//! +//! Defaulted attributes (`path = "/"`, false flags, session-cookie expiry) +//! are omitted on write but accepted on read. Expired cookies are dropped on +//! both save and load. The change log is debug state and is not serialized. + +use crate::cookie_store::CookieStore; +use crate::shared_cookie_store::SharedCookieStore; +use ::cookie_store::Cookie as CookieRfc; +use ::cookie_store::{CookieDomain, CookieExpiration, RawCookie}; +use chrono::{DateTime, SecondsFormat, Utc}; +use log::warn; +use serde::{Deserialize, Deserializer, Serialize, Serializer}; +use std::time::SystemTime; +use url::Url; + +const DEFAULT_PATH: &str = "/"; + +/// The wire shape of one cookie. Public so callers can build tooling around +/// the stored format, but normal use is via `CookieStore`'s serde impls. +#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +pub struct SerializedCookie { + pub name: String, + pub value: String, + + /// The domain the cookie belongs to, without a leading dot. Subdomains + /// also match unless `host_only` is set. + pub domain: String, + + /// Restrict the cookie to exactly `domain` (no subdomains). + #[serde(default, skip_serializing_if = "is_false")] + pub host_only: bool, + + #[serde(default = "default_path", skip_serializing_if = "is_default_path")] + pub path: String, + + #[serde(default, skip_serializing_if = "is_false")] + pub secure: bool, + + #[serde(default, skip_serializing_if = "is_false")] + pub http_only: bool, + + /// RFC 3339 expiry time. Omitted for session cookies (which never expire + /// on disk). + #[serde(default, skip_serializing_if = "Option::is_none")] + pub expires: Option, +} + +impl Serialize for CookieStore { + fn serialize(&self, serializer: S) -> Result { + serializer.collect_seq( + self.rfc_store() + .iter_unexpired() + .filter_map(serialized_cookie_from_rfc) + ) + } +} + +impl<'de> Deserialize<'de> for CookieStore { + fn deserialize>(deserializer: D) -> Result { + let cookies = Vec::::deserialize(deserializer)?; + let mut store = CookieStore::empty(); + for cookie in cookies { + insert_serialized_cookie(&mut store, cookie); + } + Ok(store) + } +} + +/// Serializes as a point-in-time snapshot of the shared store. +impl Serialize for SharedCookieStore { + fn serialize(&self, serializer: S) -> Result { + self.with_read(|store| store.serialize(serializer)) + } +} + +/// Deserializes into a fresh handle, unrelated to any existing clones. +impl<'de> Deserialize<'de> for SharedCookieStore { + fn deserialize>(deserializer: D) -> Result { + Ok(SharedCookieStore::new(CookieStore::deserialize(deserializer)?)) + } +} + +/// Compares the cookies (name, value, and attributes), ignoring the change +/// log and insertion order. +impl PartialEq for CookieStore { + fn eq(&self, other: &Self) -> bool { + sorted_serialized_cookies(self) == sorted_serialized_cookies(other) + } +} + +impl Eq for CookieStore {} + +fn serialized_cookie_from_rfc(cookie: &CookieRfc<'static>) -> Option { + let (domain, host_only) = match &cookie.domain { + CookieDomain::HostOnly(host) => (host.clone(), true), + CookieDomain::Suffix(suffix) => (suffix.clone(), false), + other => { + warn!("Cannot serialize cookie {:?} with domain {:?}; skipping.", cookie.name(), other); + return None; + } + }; + + let expires = match &cookie.expires { + CookieExpiration::AtUtc(at_utc) => { + let system_time = SystemTime::from(*at_utc); + Some(DateTime::::from(system_time).to_rfc3339_opts(SecondsFormat::Secs, false)) + } + CookieExpiration::SessionEnd => None, + }; + + Some(SerializedCookie { + name: cookie.name().to_owned(), + value: cookie.value().to_owned(), + domain, + host_only, + path: (*cookie.path).to_owned(), + secure: cookie.secure().unwrap_or(false), + http_only: cookie.http_only().unwrap_or(false), + expires, + }) +} + +fn insert_serialized_cookie(store: &mut CookieStore, cookie: SerializedCookie) { + let source_url = match Url::parse(&format!("https://{}/", cookie.domain)) { + Ok(url) => url, + Err(err) => { + warn!("Cannot restore cookie {:?} with domain {:?}: {:?}", cookie.name, cookie.domain, err); + return; + } + }; + + let mut raw = RawCookie::new(cookie.name, cookie.value); + raw.set_path(cookie.path); + raw.set_secure(cookie.secure); + raw.set_http_only(cookie.http_only); + if !cookie.host_only { + raw.set_domain(cookie.domain); + } + if let Some(expires) = &cookie.expires { + match DateTime::parse_from_rfc3339(expires) { + Ok(at) => { + let system_time = SystemTime::from(at.with_timezone(&Utc)); + raw.set_expires(time::OffsetDateTime::from(system_time)); + } + Err(err) => { + warn!("Cookie {:?} has unparseable expires {:?} ({:?}); treating as session cookie.", + raw.name(), expires, err); + } + } + } + + // NB: An expired cookie is rejected here (with a warning), which is the + // intended load behavior. + store.insert_raw(&raw, &source_url); +} + +fn sorted_serialized_cookies(store: &CookieStore) -> Vec { + let mut cookies = store.rfc_store() + .iter_unexpired() + .filter_map(serialized_cookie_from_rfc) + .collect::>(); + cookies.sort_by(|a, b| { + (&a.domain, &a.path, &a.name).cmp(&(&b.domain, &b.path, &b.name)) + }); + cookies +} + +fn default_path() -> String { + DEFAULT_PATH.to_owned() +} + +fn is_default_path(path: &str) -> bool { + path == DEFAULT_PATH +} + +fn is_false(value: &bool) -> bool { + !value +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_derive::{Deserialize, Serialize}; + + #[test] + fn cookie_store_round_trips_through_json() { + let store = example_store(); + + let serialized = serde_json::to_string(&store).unwrap(); + let restored: CookieStore = serde_json::from_str(&serialized).unwrap(); + + assert_eq!(restored.len(), 3); + assert_eq!(restored.get_cookie_value("session"), Some("abc123")); + assert_eq!(restored.get_cookie_value("pref"), Some("dark")); + assert_eq!(restored.get_cookie_value("keeper"), Some("forever")); + assert_eq!(restored, store); + } + + #[test] + fn cookie_store_nests_inside_caller_toml_structs() { + #[derive(Serialize, Deserialize)] + struct CredentialFile { + service: String, + // NB: Array-of-table fields go last so TOML stays valid. + cookies: CookieStore, + } + + let file = CredentialFile { + service: "midjourney_cookies".to_string(), + cookies: example_store(), + }; + + let serialized = toml::to_string(&file).unwrap(); + let restored: CredentialFile = toml::from_str(&serialized).unwrap(); + + assert_eq!(restored.service, "midjourney_cookies"); + assert_eq!(restored.cookies, file.cookies); + } + + #[test] + fn toml_output_is_human_editable() { + #[derive(Serialize)] + struct CredentialFile { + cookies: CookieStore, + } + + let site_url = Url::parse("https://www.example.com/").unwrap(); + let mut store = CookieStore::empty(); + store.apply_set_cookie_header("session=abc123; Secure; HttpOnly; Path=/", &site_url); + + let serialized = toml::to_string(&CredentialFile { cookies: store }).unwrap(); + + // The whole cookie reads as a flat, obvious table. + let expected = "\ +[[cookies]] +name = \"session\" +value = \"abc123\" +domain = \"www.example.com\" +host_only = true +secure = true +http_only = true +"; + assert_eq!(serialized, expected); + } + + #[test] + fn hand_written_toml_with_defaults_parses() { + #[derive(Deserialize)] + struct CredentialFile { + cookies: CookieStore, + } + + let hand_written = r#" + [[cookies]] + name = "session" + value = "abc123" + domain = "example.com" + "#; + + let file: CredentialFile = toml::from_str(hand_written).unwrap(); + assert_eq!(file.cookies.get_cookie_value("session"), Some("abc123")); + + // Domain cookies (the default) match subdomains. + let subdomain_url = Url::parse("https://api.example.com/").unwrap(); + assert_eq!( + file.cookies.cookie_header_for_url(&subdomain_url), + Some("session=abc123".to_string()), + ); + } + + #[test] + fn expires_round_trips_and_expired_cookies_are_dropped() { + let json = r#"[ + {"name": "fresh", "value": "1", "domain": "example.com", "expires": "2100-01-01T00:00:00+00:00"}, + {"name": "stale", "value": "2", "domain": "example.com", "expires": "2001-01-01T00:00:00+00:00"} + ]"#; + + let restored: CookieStore = serde_json::from_str(json).unwrap(); + assert!(restored.has_cookie("fresh")); + assert!(!restored.has_cookie("stale")); + + let reserialized = serde_json::to_string(&restored).unwrap(); + assert!(reserialized.contains("\"expires\":\"2100-01-01T00:00:00+00:00\"")); + } + + #[test] + fn shared_cookie_store_round_trips_through_json() { + let shared = SharedCookieStore::new(example_store()); + + let serialized = serde_json::to_string(&shared).unwrap(); + let restored: SharedCookieStore = serde_json::from_str(&serialized).unwrap(); + + assert!(restored.has_cookie("session")); + } + + #[test] + fn legacy_version_1_data_fails_to_parse() { + let legacy_json = r#"{"cookies":[{"name":"session","value":"abc"}]}"#; + let result = serde_json::from_str::(legacy_json); + assert!(result.is_err()); + } + + fn example_store() -> CookieStore { + let site_url = Url::parse("https://www.example.com/").unwrap(); + let mut store = CookieStore::empty(); + store.insert_named("session", "abc123", &site_url); + store.apply_set_cookie_header("pref=dark; Domain=example.com; Path=/", &site_url); + store.apply_set_cookie_header( + "keeper=forever; Path=/; Expires=Tue, 03 Aug 2100 00:38:37 GMT", + &site_url, + ); + store + } +} diff --git a/crates/lib/cookie_store_wrapper/src/shared_cookie_store.rs b/crates/lib/cookie_store_wrapper/src/shared_cookie_store.rs new file mode 100644 index 00000000..4adbfd46 --- /dev/null +++ b/crates/lib/cookie_store_wrapper/src/shared_cookie_store.rs @@ -0,0 +1,80 @@ +use crate::cookie_store::CookieStore; +use std::sync::{Arc, PoisonError, RwLock}; +use url::Url; + +/// A cheaply clonable, thread-safe handle to a [`CookieStore`]. +/// +/// Clones share the same underlying store, so a mutation made by one thread +/// (e.g. a Set-Cookie applied by an HTTP client) is visible to all holders. +/// With the `wreq` feature enabled this type implements wreq's `CookieStore` +/// trait and can be passed to `ClientBuilder::cookie_provider`. +#[derive(Clone, Debug, Default)] +pub struct SharedCookieStore { + inner: Arc>, +} + +impl SharedCookieStore { + pub fn empty() -> Self { + Self::default() + } + + pub fn new(store: CookieStore) -> Self { + Self { + inner: Arc::new(RwLock::new(store)), + } + } + + /// A point-in-time copy of the underlying store. + pub fn snapshot(&self) -> CookieStore { + self.with_read(|store| store.clone()) + } + + /// Swap the underlying store for all holders of this handle. + pub fn replace(&self, store: CookieStore) { + self.with_write(|current| *current = store); + } + + pub fn with_read(&self, reader: impl FnOnce(&CookieStore) -> R) -> R { + // NB: A panic mid-read cannot corrupt the store, so recover from poison. + let guard = self.inner.read().unwrap_or_else(PoisonError::into_inner); + reader(&guard) + } + + pub fn with_write(&self, writer: impl FnOnce(&mut CookieStore) -> R) -> R { + let mut guard = self.inner.write().unwrap_or_else(PoisonError::into_inner); + writer(&mut guard) + } + + pub fn has_cookie(&self, name: &str) -> bool { + self.with_read(|store| store.has_cookie(name)) + } + + pub fn to_cookie_string(&self) -> String { + self.with_read(|store| store.to_cookie_string()) + } + + pub fn cookie_header_for_url(&self, request_url: &Url) -> Option { + self.with_read(|store| store.cookie_header_for_url(request_url)) + } + + pub fn apply_set_cookie_header(&self, set_cookie_value: &str, request_url: &Url) -> bool { + self.with_write(|store| store.apply_set_cookie_header(set_cookie_value, request_url)) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn clones_share_mutations() { + let site_url = Url::parse("https://www.example.com/").unwrap(); + let shared = SharedCookieStore::empty(); + let clone = shared.clone(); + + clone.apply_set_cookie_header("session=abc; Path=/", &site_url); + + assert!(shared.has_cookie("session")); + assert_eq!(shared.cookie_header_for_url(&site_url), Some("session=abc".to_string())); + } +} diff --git a/crates/lib/cookie_store_wrapper/src/wreq_cookie_provider.rs b/crates/lib/cookie_store_wrapper/src/wreq_cookie_provider.rs new file mode 100644 index 00000000..0f6c8ac4 --- /dev/null +++ b/crates/lib/cookie_store_wrapper/src/wreq_cookie_provider.rs @@ -0,0 +1,60 @@ +//! Implements wreq's `CookieStore` trait on [`SharedCookieStore`], so a wreq +//! client can use our store as its cookie provider: +//! +//! ```ignore +//! let cookies = SharedCookieStore::empty(); +//! let client = wreq::Client::builder() +//! .cookie_provider(cookies.clone()) +//! .build()?; +//! // Every Set-Cookie the client receives now lands in `cookies`, +//! // and every request sends the matching stored cookies. +//! ``` + +use crate::shared_cookie_store::SharedCookieStore; +use log::warn; +use url::Url; +use wreq::Uri; +use wreq::cookie::{CookieStore as WreqCookieStore, Cookies}; +use wreq::header::HeaderValue; + +impl WreqCookieStore for SharedCookieStore { + fn set_cookies(&self, cookie_headers: &mut dyn Iterator, uri: &Uri) { + let Some(request_url) = uri_to_url(uri) else { + warn!("Cannot convert URI to URL for Set-Cookie storage: {}", uri); + return; + }; + self.with_write(|store| { + for header in cookie_headers { + match header.to_str() { + Ok(value) => { + store.apply_set_cookie_header(value, &request_url); + } + Err(err) => { + warn!("Set-Cookie header from {} is not valid UTF-8: {:?}", request_url, err); + } + } + } + }); + } + + fn cookies(&self, uri: &Uri) -> Cookies { + let Some(request_url) = uri_to_url(uri) else { + return Cookies::Empty; + }; + let maybe_header = self.cookie_header_for_url(&request_url); + match maybe_header { + Some(header) => match HeaderValue::from_str(&header) { + Ok(value) => Cookies::Compressed(value), + Err(err) => { + warn!("Stored cookies for {} do not form a valid header: {:?}", request_url, err); + Cookies::Empty + } + }, + None => Cookies::Empty, + } + } +} + +fn uri_to_url(uri: &Uri) -> Option { + Url::parse(&uri.to_string()).ok() +} diff --git a/crates/lib/data/primitives/Cargo.toml b/crates/lib/data/primitives/Cargo.toml new file mode 100644 index 00000000..0977d554 --- /dev/null +++ b/crates/lib/data/primitives/Cargo.toml @@ -0,0 +1,40 @@ +[package] +name = "primitives" +edition = "2018" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +# NB: Public "primitives" crate does not exist, so we're fine to use this internally. +name = "primitives" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# NB: This is designed to be a central crate with few dependencies. +# Consider the dependencies here wisely. +# This is used in MySQL, etc., so dependencies are ill-advised. + +# Internal +# **DO NOT ADD ANY!** +# (None) + +# External +# **DO NOT ADD ANY!** +# (None) + +[dev-dependencies] +# Internal +test_utils.workspace = true + +# External +assertor.workspace = true diff --git a/crates/lib/data/primitives/src/bool_to_str.rs b/crates/lib/data/primitives/src/bool_to_str.rs new file mode 100644 index 00000000..2bf36c6d --- /dev/null +++ b/crates/lib/data/primitives/src/bool_to_str.rs @@ -0,0 +1,24 @@ + +/// Convert a boolean to a lower case string, with values of either "true" or "false". +pub fn bool_to_str(value: bool) -> &'static str { + if value { + "true" + } else { + "false" + } +} + +#[cfg(test)] +mod tests { + use crate::bool_to_str::bool_to_str; + + #[test] + fn test_true() { + assert_eq!(bool_to_str(true), "true"); + } + + #[test] + fn test_false() { + assert_eq!(bool_to_str(false), "false"); + } +} diff --git a/crates/lib/data/primitives/src/iterators/iterate_trimmed_lines_without_comments.rs b/crates/lib/data/primitives/src/iterators/iterate_trimmed_lines_without_comments.rs new file mode 100644 index 00000000..bd384d68 --- /dev/null +++ b/crates/lib/data/primitives/src/iterators/iterate_trimmed_lines_without_comments.rs @@ -0,0 +1,42 @@ + + +/// Read lines from a file in an iterator. +/// Remove comment lines prefixed with `#`. +pub fn iterate_trimmed_lines_without_comments<'a>(iterator: impl IntoIterator) + -> impl Iterator +{ + iterator.into_iter() + .map(|line| line.trim()) + .filter(|line| !(line.starts_with("#") || line.is_empty())) +} + +#[cfg(test)] +mod tests { + use crate::iterators::iterate_trimmed_lines_without_comments::iterate_trimmed_lines_without_comments; + use std::fs::File; + use std::io::Read; + use test_utils::test_file_path::test_file_path; + + #[test] + fn load_file() { + let filename = test_file_path("test_data/text_files/cidr_ban_example/local_cidrs_example.txt") + .expect("should be a valid path"); + + let mut file = File::open(filename) + .expect("file should open"); + + let mut contents = String::new(); + file.read_to_string(&mut contents) + .expect("should be able to read file"); + + let lines = contents.lines(); + let lines = iterate_trimmed_lines_without_comments(lines); + + assert_eq!( + lines.collect::>(), + vec![ + "127.0.0.0/24", + "192.168.0.0/24", + ]); + } +} diff --git a/crates/lib/data/primitives/src/iterators/mod.rs b/crates/lib/data/primitives/src/iterators/mod.rs new file mode 100644 index 00000000..3261fee9 --- /dev/null +++ b/crates/lib/data/primitives/src/iterators/mod.rs @@ -0,0 +1 @@ +pub mod iterate_trimmed_lines_without_comments; \ No newline at end of file diff --git a/crates/lib/data/primitives/src/lazy_any_option_true.rs b/crates/lib/data/primitives/src/lazy_any_option_true.rs new file mode 100644 index 00000000..05f97849 --- /dev/null +++ b/crates/lib/data/primitives/src/lazy_any_option_true.rs @@ -0,0 +1,94 @@ + +//pub type LazyOptional = Box Option + Send>; +pub type LazyOptional<'a> = Box Option + 'a>; + +/// Lazily evaluate a list of boxed closures that return Option. +/// +/// - If any result in true, return Some(true). +/// The first true will end the evaluation. +/// +/// - If none are true, but any result in false, return Some(false). +/// +/// - Else, return None +pub fn lazy_any_option_true(functions: &[LazyOptional]) -> Option +{ + let mut opt_false_found = false; + for func in functions.iter() { + match func() { + Some(true) => return Some(true), + Some(false) => if !opt_false_found { opt_false_found = true }, + None => continue, + } + } + if opt_false_found { + Some(false) + } else { + None + } +} + +#[cfg(test)] +mod tests { + + #[test] + fn empty() { + let result = super::lazy_any_option_true(&[]); + assert_eq!(result, None); + } + + #[test] + fn all_empty() { + let result = super::lazy_any_option_true(&[ + Box::new(|| None), + Box::new(|| None), + ]); + assert_eq!(result, None); + } + + #[test] + fn all_false() { + let result = super::lazy_any_option_true(&[ + Box::new(|| Some(false)), + Box::new(|| Some(false)), + ]); + assert_eq!(result, Some(false)); + } + + #[test] + fn mix_false_none() { + let result = super::lazy_any_option_true(&[ + Box::new(|| None), + Box::new(|| Some(false)), + Box::new(|| Some(false)), + Box::new(|| None), + ]); + assert_eq!(result, Some(false)); + } + + #[test] + fn mix() { + let result = super::lazy_any_option_true(&[ + Box::new(|| None), + Box::new(|| Some(false)), + Box::new(|| Some(true)), + Box::new(|| Some(false)), + Box::new(|| None), + ]); + assert_eq!(result, Some(true)); + } + + #[test] + fn mix_closure_capture() { + let truthy = Some(true); + let falsy = Some(true); + + let result = super::lazy_any_option_true(&[ + Box::new(|| None), + Box::new(|| (&falsy).map(|inner| inner.clone())), + Box::new(|| (&truthy).map(|inner| inner.clone())), + Box::new(|| (&falsy).map(|inner| inner.clone())), + Box::new(|| None), + ]); + assert_eq!(result, Some(true)); + } +} diff --git a/crates/lib/data/primitives/src/lib.rs b/crates/lib/data/primitives/src/lib.rs new file mode 100644 index 00000000..38f11650 --- /dev/null +++ b/crates/lib/data/primitives/src/lib.rs @@ -0,0 +1,31 @@ +//! primitives +//! +//! The purpose of this library is to package converters and utilities around Rust's primitive types. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod bool_to_str; +pub mod iterators; +pub mod lazy_any_option_true; +pub mod numerics; +pub mod optional_false_to_none; +pub mod str; +pub mod str_to_bool; +pub mod traits; +pub mod trim_or_empty; +pub mod truncate_str; +pub mod try_str_to_num; diff --git a/crates/lib/data/primitives/src/numerics/i32_to_u32_zero_clamped.rs b/crates/lib/data/primitives/src/numerics/i32_to_u32_zero_clamped.rs new file mode 100644 index 00000000..31a5876f --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/i32_to_u32_zero_clamped.rs @@ -0,0 +1,43 @@ +/// Convert an i32 to a u32. If the i32 is negative, return 0. +pub fn i32_to_u32_zero_clamped(num: i32) -> u32 { + if num < 0 { + return 0 + } else { + num as u32 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn zero() { + assert_eq!(i32_to_u32_zero_clamped(0), 0); + } + + #[test] + fn one() { + assert_eq!(i32_to_u32_zero_clamped(1), 1); + } + + #[test] + fn negative_one() { + assert_eq!(i32_to_u32_zero_clamped(-1), 0); + } + + #[test] + fn i32_min() { + assert_eq!(i32_to_u32_zero_clamped(i32::MIN), 0); + } + + #[test] + fn i32_max() { + assert_eq!(i32_to_u32_zero_clamped(i32::MAX), u32::MAX / 2); + } + + #[test] + fn i32_max_minus_one() { + assert_eq!(i32_to_u32_zero_clamped(i32::MAX - 1), u32::MAX / 2 - 1); + } +} diff --git a/crates/lib/data/primitives/src/numerics/i64_to_u64_zero_clamped.rs b/crates/lib/data/primitives/src/numerics/i64_to_u64_zero_clamped.rs new file mode 100644 index 00000000..6b4c3b36 --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/i64_to_u64_zero_clamped.rs @@ -0,0 +1,43 @@ +/// Convert an i64 to a u64. If the i64 is negative, return 0. +pub fn i64_to_u64_zero_clamped(num: i64) -> u64 { + if num < 0 { + return 0 + } else { + num as u64 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn zero() { + assert_eq!(i64_to_u64_zero_clamped(0), 0); + } + + #[test] + fn one() { + assert_eq!(i64_to_u64_zero_clamped(1), 1); + } + + #[test] + fn negative_one() { + assert_eq!(i64_to_u64_zero_clamped(-1), 0); + } + + #[test] + fn i32_min() { + assert_eq!(i64_to_u64_zero_clamped(i64::MIN), 0); + } + + #[test] + fn i32_max() { + assert_eq!(i64_to_u64_zero_clamped(i64::MAX), u64::MAX / 2); + } + + #[test] + fn i32_max_minus_one() { + assert_eq!(i64_to_u64_zero_clamped(i64::MAX - 1), u64::MAX / 2 - 1); + } +} diff --git a/crates/lib/data/primitives/src/numerics/mod.rs b/crates/lib/data/primitives/src/numerics/mod.rs new file mode 100644 index 00000000..d4b2921c --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/mod.rs @@ -0,0 +1,6 @@ +pub mod i32_to_u32_zero_clamped; +pub mod i64_to_u64_zero_clamped; +pub mod remap_range_f64; +pub mod u64_to_i32_saturating; +pub mod u64_to_i64_saturating; +pub mod u64_to_u32_saturating; \ No newline at end of file diff --git a/crates/lib/data/primitives/src/numerics/remap_range_f64.rs b/crates/lib/data/primitives/src/numerics/remap_range_f64.rs new file mode 100644 index 00000000..19a48adf --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/remap_range_f64.rs @@ -0,0 +1,131 @@ + +pub struct Args { + pub old_min: f64, + pub old_max: f64, + pub new_min: f64, + pub new_max: f64, + + /// The value to remap to the new range. + pub value: f64, +} + +pub fn remap_range_f64(args: Args) -> f64 { + let old_range = args.old_max - args.old_min; + let new_range = args.new_max - args.new_min; + + let new_value = (args.value - args.old_min) * new_range / old_range + args.new_min; + + if new_value > args.new_max { + args.new_max + } else if new_value < args.new_min { + args.new_min + } else { + new_value + } +} + +#[cfg(test)] +mod tests { + use crate::numerics::remap_range_f64::{remap_range_f64, Args}; + use assertor::{assert_that, FloatAssertion}; + + #[test] + fn test_base_cases() { + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: 0.0, + new_max: 1.0, + value: 0.0, + })).with_abs_tol(0.01).is_approx_equal_to(0.0); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: 0.0, + new_max: 1.0, + value: 1.0, + })).with_abs_tol(0.01).is_approx_equal_to(1.0); + } + + #[test] + fn test_maxima() { + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 100.0, + new_min: 0.0, + new_max: 1.0, + value: 100.0, + })).with_abs_tol(0.01).is_approx_equal_to(1.0); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: 0.0, + new_max: 50.0, + value: 1.0, + })).with_abs_tol(0.01).is_approx_equal_to(50.0); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: -100.0, + new_max: 100.0, + value: 1.0, + })).with_abs_tol(0.01).is_approx_equal_to(100.0); + } + + #[test] + fn test_minima() { + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 100.0, + new_min: 0.0, + new_max: 1.0, + value: 0.0, + })).with_abs_tol(0.01).is_approx_equal_to(0.0); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: 0.0, + new_max: 50.0, + value: 0.0, + })).with_abs_tol(0.01).is_approx_equal_to(0.0); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: -100.0, + new_max: 100.0, + value: 0.0, + })).with_abs_tol(0.01).is_approx_equal_to(-100.0); + } + + #[test] + fn test_other_values() { + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 100.0, + new_min: 0.0, + new_max: 1.0, + value: 50.0, + })).with_abs_tol(0.01).is_approx_equal_to(0.50); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: 0.0, + new_max: 50.0, + value: 0.10, + })).with_abs_tol(0.01).is_approx_equal_to(5.0); + + assert_that!(remap_range_f64(Args { + old_min: 0.0, + old_max: 1.0, + new_min: -100.0, + new_max: 100.0, + value: 0.25, + })).with_abs_tol(0.01).is_approx_equal_to(-50.0); + } +} diff --git a/crates/lib/data/primitives/src/numerics/u64_to_i32_saturating.rs b/crates/lib/data/primitives/src/numerics/u64_to_i32_saturating.rs new file mode 100644 index 00000000..f3498af0 --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/u64_to_i32_saturating.rs @@ -0,0 +1,40 @@ +const MAX_I32 : u64 = i32::MAX as u64; + +/// Convert a u64 to a positive i32, saturating to i32::MAX if the u64 overflows the container. +pub fn u64_to_i32_saturating(num: u64) -> i32 { + if num > MAX_I32 { + return i32::MAX; + } else { + num as i32 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn zero() { + assert_eq!(u64_to_i32_saturating(0), 0); + } + + #[test] + fn u64_max() { + assert_eq!(u64_to_i32_saturating(u64::MAX), i32::MAX); + } + + #[test] + fn i32_max() { + assert_eq!(u64_to_i32_saturating(i32::MAX as u64), i32::MAX); + } + + #[test] + fn i32_max_plus_one() { + assert_eq!(u64_to_i32_saturating(i32::MAX as u64 + 1), i32::MAX); + } + + #[test] + fn i32_max_minus_one() { + assert_eq!(u64_to_i32_saturating(i32::MAX as u64 - 1), i32::MAX - 1); + } +} diff --git a/crates/lib/data/primitives/src/numerics/u64_to_i64_saturating.rs b/crates/lib/data/primitives/src/numerics/u64_to_i64_saturating.rs new file mode 100644 index 00000000..23c3540c --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/u64_to_i64_saturating.rs @@ -0,0 +1,45 @@ +const MAX_I64 : u64 = i64::MAX as u64; + +/// Convert a u64 to a positive i64, saturating to i64::MAX if the u64 overflows the container. +pub fn u64_to_i64_saturating(num: u64) -> i64 { + if num > MAX_I64 { + return i64::MAX; + } else { + num as i64 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn zero() { + assert_eq!(u64_to_i64_saturating(0), 0); + } + + #[test] + fn one() { + assert_eq!(u64_to_i64_saturating(1), 1); + } + + #[test] + fn u64_max() { + assert_eq!(u64_to_i64_saturating(u64::MAX), i64::MAX); + } + + #[test] + fn i32_max() { + assert_eq!(u64_to_i64_saturating(i64::MAX as u64), i64::MAX); + } + + #[test] + fn i32_max_plus_one() { + assert_eq!(u64_to_i64_saturating(i64::MAX as u64 + 1), i64::MAX); + } + + #[test] + fn i32_max_minus_one() { + assert_eq!(u64_to_i64_saturating(i64::MAX as u64 - 1), i64::MAX - 1); + } +} diff --git a/crates/lib/data/primitives/src/numerics/u64_to_u32_saturating.rs b/crates/lib/data/primitives/src/numerics/u64_to_u32_saturating.rs new file mode 100644 index 00000000..6bb5bab4 --- /dev/null +++ b/crates/lib/data/primitives/src/numerics/u64_to_u32_saturating.rs @@ -0,0 +1,50 @@ +const MAX_U32 : u64 = u32::MAX as u64; + +/// Convert a u64 to a u32, saturating to u32::MAX if the u64 overflows the container. +pub fn u64_to_u32_saturating(num: u64) -> u32 { + if num > MAX_U32 { + return u32::MAX; + } else { + num as u32 + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn zero() { + assert_eq!(u64_to_u32_saturating(0), 0); + } + + #[test] + fn one() { + assert_eq!(u64_to_u32_saturating(1), 1); + } + + #[test] + fn u32_max() { + assert_eq!(u64_to_u32_saturating(u32::MAX as u64), u32::MAX); + } + + #[test] + fn u32_max_plus_one() { + assert_eq!(u64_to_u32_saturating(u32::MAX as u64 + 1), u32::MAX); + } + + #[test] + fn u32_max_minus_one() { + assert_eq!(u64_to_u32_saturating(u32::MAX as u64 - 1), u32::MAX - 1); + } + + #[test] + fn u64_max() { + assert_eq!(u64_to_u32_saturating(u64::MAX), u32::MAX); + } + + #[test] + fn u64_max_minus_one() { + assert_eq!(u64_to_u32_saturating(u64::MAX - 1), u32::MAX); + } +} diff --git a/crates/lib/data/primitives/src/optional_false_to_none.rs b/crates/lib/data/primitives/src/optional_false_to_none.rs new file mode 100644 index 00000000..45e52a07 --- /dev/null +++ b/crates/lib/data/primitives/src/optional_false_to_none.rs @@ -0,0 +1,14 @@ + +pub fn optional_false_to_none(optional: Option) -> Option { + optional.filter(|&value| value) +} + +#[cfg(test)] +mod test { + #[test] + fn test_optional_false_to_none() { + assert_eq!(super::optional_false_to_none(None), None); + assert_eq!(super::optional_false_to_none(Some(false)), None); + assert_eq!(super::optional_false_to_none(Some(true)), Some(true)); + } +} diff --git a/crates/lib/data/primitives/src/str/first_letter_uppercase.rs b/crates/lib/data/primitives/src/str/first_letter_uppercase.rs new file mode 100644 index 00000000..5f566966 --- /dev/null +++ b/crates/lib/data/primitives/src/str/first_letter_uppercase.rs @@ -0,0 +1,37 @@ + +/// Converts the first letter of a string to uppercase. +/// eg, "foobar" is converted to "Foobar". +/// From https://stackoverflow.com/a/53570840 +pub fn first_letter_uppercase(s: &str) -> String { + let mut c = s.chars(); + match c.next() { + None => String::new(), + Some(f) => f.to_uppercase().collect::() + c.as_str(), + } +} + +#[cfg(test)] +mod tests { + use crate::str::first_letter_uppercase::first_letter_uppercase; + + #[test] + fn empty() { + assert_eq!(first_letter_uppercase(""), ""); + } + + #[test] + fn lowercase() { + assert_eq!(first_letter_uppercase("f"), "F"); + assert_eq!(first_letter_uppercase("foo"), "Foo"); + assert_eq!(first_letter_uppercase("fOO"), "FOO"); + assert_eq!(first_letter_uppercase("asdf"), "Asdf"); + } + + #[test] + fn uppercase() { + assert_eq!(first_letter_uppercase("F"), "F"); + assert_eq!(first_letter_uppercase("Foo"), "Foo"); + assert_eq!(first_letter_uppercase("FOO"), "FOO"); + assert_eq!(first_letter_uppercase("ASDF"), "ASDF"); + } +} diff --git a/crates/lib/data/primitives/src/str/mod.rs b/crates/lib/data/primitives/src/str/mod.rs new file mode 100644 index 00000000..f1267184 --- /dev/null +++ b/crates/lib/data/primitives/src/str/mod.rs @@ -0,0 +1 @@ +pub mod first_letter_uppercase; \ No newline at end of file diff --git a/crates/lib/data/primitives/src/str_to_bool.rs b/crates/lib/data/primitives/src/str_to_bool.rs new file mode 100644 index 00000000..2095e365 --- /dev/null +++ b/crates/lib/data/primitives/src/str_to_bool.rs @@ -0,0 +1,31 @@ + +/// Convert string values to bool. +/// Empty, "0", "false", "False", and "FALSE" are considered false +pub fn str_to_bool(input: &str) -> bool { + match input { + "" | "0" | "false" | "False" | "FALSE" => false, + _ => true, + } +} + +#[cfg(test)] +mod tests { + use crate::str_to_bool::str_to_bool; + + #[test] + fn false_values() { + assert!(!str_to_bool("")); + assert!(!str_to_bool("0")); + assert!(!str_to_bool("false")); + assert!(!str_to_bool("False")); + assert!(!str_to_bool("FALSE")); + } + + #[test] + fn true_values() { + assert!(str_to_bool(" ")); + assert!(str_to_bool("true")); + assert!(str_to_bool("TRUE")); + assert!(str_to_bool("whatever")); + } +} diff --git a/crates/lib/data/primitives/src/traits/mod.rs b/crates/lib/data/primitives/src/traits/mod.rs new file mode 100644 index 00000000..a3713933 --- /dev/null +++ b/crates/lib/data/primitives/src/traits/mod.rs @@ -0,0 +1 @@ +pub mod trim_or_emptyable; \ No newline at end of file diff --git a/crates/lib/data/primitives/src/traits/trim_or_emptyable.rs b/crates/lib/data/primitives/src/traits/trim_or_emptyable.rs new file mode 100644 index 00000000..66147ad6 --- /dev/null +++ b/crates/lib/data/primitives/src/traits/trim_or_emptyable.rs @@ -0,0 +1,131 @@ +/// Something that can be trimmed +pub trait TrimOrEmptyable { + /// Trim the string. If it trims to empty, return None. + fn trim_or_empty(&self) -> Option<&str>; + + /// Trim the string. If it trims to empty, return None. + fn new_string_trim_or_empty(&self) -> Option { + self.trim_or_empty().map(|s| s.to_string()) + } +} + +// TODO: Can't create this due to conflicting implementations +// impl TrimOrEmptyable for T +// where T: AsRef +// { +// fn trim_or_empty(&self) -> Option<&str> { +// self.as_ref().trim_or_empty() +// } +// } + +impl TrimOrEmptyable for Option<&str> { + fn trim_or_empty(&self) -> Option<&str> { + self.map(|s| s.trim()) + .filter(|s| !s.is_empty()) + } +} + +impl TrimOrEmptyable for Option { + fn trim_or_empty(&self) -> Option<&str> { + self.as_deref() + .map(|s| s.trim()) + .filter(|s| !s.is_empty()) + } +} + +impl TrimOrEmptyable for &str { + fn trim_or_empty(&self) -> Option<&str> { + match self.trim() { + "" => None, + s => Some(s), + } + } +} + +impl TrimOrEmptyable for String { + fn trim_or_empty(&self) -> Option<&str> { + match self.trim() { + "" => None, + s => Some(s), + } + } +} + +#[cfg(test)] +mod tests { + use crate::traits::trim_or_emptyable::TrimOrEmptyable; + + mod str_primitive { + use super::*; + + #[test] + fn empty() { + assert_eq!("".trim_or_empty(), None); + assert_eq!(" ".trim_or_empty(), None); + assert_eq!(" \n\t \t ".trim_or_empty(), None); + } + + #[test] + fn trimmed() { + assert_eq!("hello".trim_or_empty(), Some("hello")); + assert_eq!(" world ".trim_or_empty(), Some("world")); + assert_eq!(" \n\tsuper\nmario\tbros\n\t \n ".trim_or_empty(), Some("super\nmario\tbros")); + } + } + + mod string_primitive { + use super::*; + + #[test] + fn empty() { + assert_eq!("".to_string().trim_or_empty(), None); + assert_eq!(" ".to_string().trim_or_empty(), None); + assert_eq!(" \n\t \t ".to_string().trim_or_empty(), None); + } + + #[test] + fn trimmed() { + assert_eq!("hello".to_string().trim_or_empty(), Some("hello")); + assert_eq!(" world ".to_string().trim_or_empty(), Some("world")); + assert_eq!(" \n\tsuper\nmario\tbros\n\t \n ".to_string().trim_or_empty(), Some("super\nmario\tbros")); + } + } + + mod option_str_primitive { + use super::*; + + #[test] + fn empty() { + assert_eq!(Some("").trim_or_empty(), None); + assert_eq!(Some(" ").trim_or_empty(), None); + assert_eq!(Some(" \n\t \t ").trim_or_empty(), None); + assert_eq!(None::<&str>.trim_or_empty(), None); + + } + + #[test] + fn trimmed() { + assert_eq!(Some("hello").trim_or_empty(), Some("hello")); + assert_eq!(Some(" world ").trim_or_empty(), Some("world")); + assert_eq!(Some(" \n\tsuper\nmario\tbros\n\t \n ").trim_or_empty(), Some("super\nmario\tbros")); + } + } + + mod option_string_primitive { + use super::*; + #[test] + fn empty() { + assert_eq!(Some("".to_string()).trim_or_empty(), None); + assert_eq!(Some(" ".to_string()).trim_or_empty(), None); + assert_eq!(Some(" \n\t \t ".to_string()).trim_or_empty(), None); + assert_eq!(None::.trim_or_empty(), None); + } + + #[test] + fn trimmed() { + assert_eq!(Some("hello".to_string()).trim_or_empty(), Some("hello")); + assert_eq!(Some(" world ".to_string()).trim_or_empty(), Some("world")); + assert_eq!(Some(" \n\tsuper\nmario\tbros\n\t \n ".to_string()).trim_or_empty(), Some("super\nmario\tbros")); + } + } +} diff --git a/crates/lib/data/primitives/src/trim_or_empty.rs b/crates/lib/data/primitives/src/trim_or_empty.rs new file mode 100644 index 00000000..5b91e00c --- /dev/null +++ b/crates/lib/data/primitives/src/trim_or_empty.rs @@ -0,0 +1,28 @@ + +/// Trim the string. If it trims to empty, return None. +pub fn trim_or_empty(input: &str) -> Option<&str> { + let trimmed = input.trim(); + if trimmed.is_empty() { + None + } else { + Some(trimmed) + } +} + +#[cfg(test)] +mod tests { + use crate::trim_or_empty::trim_or_empty; + + #[test] + fn empty() { + assert_eq!(trim_or_empty(""), None); + assert_eq!(trim_or_empty(" "), None); + assert_eq!(trim_or_empty(" \n\t \t "), None); + } + + fn trimmed() { + assert_eq!(trim_or_empty("hello"), Some("hello")); + assert_eq!(trim_or_empty(" world "), Some("world")); + assert_eq!(trim_or_empty(" \n\tsuper\nmario\tbros\n\t \n "), Some("super\nmario\tbros")); + } +} \ No newline at end of file diff --git a/crates/lib/data/primitives/src/truncate_str.rs b/crates/lib/data/primitives/src/truncate_str.rs new file mode 100644 index 00000000..bbdfb4f8 --- /dev/null +++ b/crates/lib/data/primitives/src/truncate_str.rs @@ -0,0 +1,24 @@ + +/// Truncate a string based on character length, not byte length. +/// Taken from https://stackoverflow.com/a/38461750 +pub fn truncate_str(s: &str, max_chars: usize) -> &str { + match s.char_indices().nth(max_chars) { + None => s, + Some((idx, _)) => &s[..idx], + } +} + +#[cfg(test)] +mod tests { + use crate::truncate_str::truncate_str; + + #[test] + fn truncate() { + assert_eq!(truncate_str("hello", 0), ""); + assert_eq!(truncate_str("hello", 1), "h"); + assert_eq!(truncate_str("hello", 3), "hel"); + assert_eq!(truncate_str("hello", 5), "hello"); + assert_eq!(truncate_str("hello", 10), "hello"); + assert_eq!(truncate_str("hello", 10000), "hello"); + } +} diff --git a/crates/lib/data/primitives/src/try_str_to_num.rs b/crates/lib/data/primitives/src/try_str_to_num.rs new file mode 100644 index 00000000..2fa77dfa --- /dev/null +++ b/crates/lib/data/primitives/src/try_str_to_num.rs @@ -0,0 +1,80 @@ +use std::ops::{AddAssign, MulAssign}; +use std::str::FromStr; + +/// Convert string values to numerics +/// The trait bounds aren't perfect, but are close enough. +/// This is probably inferior to just using `u32::from_str` directly, but it +/// serves as good documentation on generics. +pub fn try_str_to_num(input: &str) -> Result::Err> + where T: FromStr + Copy + AddAssign + MulAssign +{ + let value = T::from_str(input)?; + Ok(value) +} + +#[cfg(test)] +mod tests { + use crate::try_str_to_num::try_str_to_num; + + mod u8 { + use super::*; + + #[test] + fn parse() { + assert_eq!(try_str_to_num::("0"), Ok(0u8)); + assert_eq!(try_str_to_num::("1"), Ok(1u8)); + assert_eq!(try_str_to_num::("5"), Ok(5u8)); + assert_eq!(try_str_to_num::("123"), Ok(123u8)); + assert_eq!(try_str_to_num::("255"), Ok(255u8)); + } + + #[test] + fn true_values() { + assert!(try_str_to_num::("").is_err()); + assert!(try_str_to_num::("-1").is_err()); + assert!(try_str_to_num::("256").is_err()); + assert!(try_str_to_num::("foo").is_err()); + } + } + + mod i8 { + use super::*; + + #[test] + fn parse() { + assert_eq!(try_str_to_num::("0"), Ok(0i8)); + assert_eq!(try_str_to_num::("1"), Ok(1i8)); + assert_eq!(try_str_to_num::("5"), Ok(5i8)); + assert_eq!(try_str_to_num::("123"), Ok(123i8)); + assert_eq!(try_str_to_num::("-1"), Ok(-1i8)); + } + + #[test] + fn true_values() { + assert!(try_str_to_num::("").is_err()); + assert!(try_str_to_num::("128").is_err()); + assert!(try_str_to_num::("256").is_err()); + assert!(try_str_to_num::("foo").is_err()); + } + } + + mod u32 { + use super::*; + + #[test] + fn parse() { + assert_eq!(try_str_to_num::("0"), Ok(0u32)); + assert_eq!(try_str_to_num::("1"), Ok(1u32)); + assert_eq!(try_str_to_num::("5"), Ok(5u32)); + assert_eq!(try_str_to_num::("123"), Ok(123u32)); + assert_eq!(try_str_to_num::("255"), Ok(255u32)); + } + + #[test] + fn true_values() { + assert!(try_str_to_num::("").is_err()); + assert!(try_str_to_num::("-1").is_err()); + assert!(try_str_to_num::("foo").is_err()); + } + } +} diff --git a/crates/lib/data/web_base64/Cargo.toml b/crates/lib/data/web_base64/Cargo.toml new file mode 100644 index 00000000..ff381857 --- /dev/null +++ b/crates/lib/data/web_base64/Cargo.toml @@ -0,0 +1,25 @@ +[package] +name = "web_base64" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "web_base64" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration = { workspace = true } + +# Internal +# (None) + +# External +base64 = { workspace = true } + +[dev-dependencies] +# (None) diff --git a/crates/lib/data/web_base64/src/lib.rs b/crates/lib/data/web_base64/src/lib.rs new file mode 100644 index 00000000..c5c08aeb --- /dev/null +++ b/crates/lib/data/web_base64/src/lib.rs @@ -0,0 +1,5 @@ +//! Base64 encoding and decoding library that handles data from the web. +//! Most of the base64 we receive from the web is of a particular encoding +//! type, and we also have to juggle URL prefixes. + +pub mod web_base64_decode; diff --git a/crates/lib/data/web_base64/src/web_base64_decode.rs b/crates/lib/data/web_base64/src/web_base64_decode.rs new file mode 100644 index 00000000..f8016111 --- /dev/null +++ b/crates/lib/data/web_base64/src/web_base64_decode.rs @@ -0,0 +1,14 @@ +use base64::prelude::BASE64_STANDARD; +use base64::Engine; + +pub fn web_base64_decode(base64_string: &str) -> Result, base64::DecodeError> { + // Remove the data URL prefix if it exists + // eg: "data:image/png;base64,..." + let base64_data = if base64_string.starts_with("data:") { + base64_string.split(',').nth(1).unwrap_or(base64_string) + } else { + base64_string + }; + + BASE64_STANDARD.decode(base64_data) +} diff --git a/crates/lib/datadome_errors/Cargo.toml b/crates/lib/datadome_errors/Cargo.toml new file mode 100644 index 00000000..c7a1dd97 --- /dev/null +++ b/crates/lib/datadome_errors/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "datadome_errors" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "datadome_errors" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +# (None) + +# External +log.workspace = true +serde_json.workspace = true + +[dev-dependencies] +# (None) diff --git a/crates/lib/datadome_errors/src/classify_datadome_response.rs b/crates/lib/datadome_errors/src/classify_datadome_response.rs new file mode 100644 index 00000000..791fdafb --- /dev/null +++ b/crates/lib/datadome_errors/src/classify_datadome_response.rs @@ -0,0 +1,111 @@ +use crate::datadome_error::DataDomeError; +use crate::datadome_response_signals::DataDomeResponseSignals; + +/// Hosts DataDome serves its challenge / block pages from. +const DATADOME_PAGE_HOSTS: &[&str] = &[ + "captcha-delivery.com", + "geo.captcha-delivery.com", + "ct.captcha-delivery.com", +]; + +/// Decide whether a response is a DataDome response and which kind. +/// +/// Returns `None` for 2xx and for anything not attributable to DataDome. +/// DataDome only ever answers with 403 (blocks and challenges alike); the +/// body's `url` decides between challenge and block. +pub fn classify_datadome_response(signals: &DataDomeResponseSignals<'_>) -> Option { + let status = signals.status_code; + let body = signals.body; + + if (200..300).contains(&status) { + return None; + } + + if let Some(url) = extract_challenge_url(body) { + return Some(classify_by_url(&url)); + } + + let blocked_by_header = signals.maybe_x_dd_b.is_some(); + let body_names_datadome = body.to_ascii_lowercase().contains("datadome"); + + if status == 403 && (blocked_by_header || body_names_datadome) { + return Some(DataDomeError::Unclassified { status_code: status, raw_http_body: body.to_string() }); + } + + None +} + +/// The `url` field of DataDome's JSON body, when the body is one. +fn extract_challenge_url(body: &str) -> Option { + let parsed: serde_json::Value = serde_json::from_str(body).ok()?; + let url = parsed.get("url")?.as_str()?; + let is_datadome_page = DATADOME_PAGE_HOSTS.iter().any(|host| url.contains(host)); + is_datadome_page.then(|| url.to_string()) +} + +fn classify_by_url(url: &str) -> DataDomeError { + // `t=bv` ("blocked, verified bot") means no challenge is offered. + let is_hard_block = url.contains("t=bv"); + if is_hard_block { + return DataDomeError::Blocked { maybe_block_url: Some(url.to_string()) }; + } + if url.contains("/interstitial/") { + return DataDomeError::Interstitial { challenge_url: url.to_string() }; + } + DataDomeError::CaptchaChallenge { challenge_url: url.to_string() } +} + +#[cfg(test)] +mod tests { + use super::*; + + const CAPTCHA_BODY: &str = r#"{"url":"https://geo.captcha-delivery.com/captcha/?initialCid=AHrlqAAAAAMA&hash=A55FBF4311ED37&cid=Yw0QRSl16BFX&t=fe&referer=https%3A%2F%2Fhiggsfield.ai%2F&s=17605&e=8d0e","cid":"Yw0QRSl16BFX"}"#; + const INTERSTITIAL_BODY: &str = r#"{"url":"https://geo.captcha-delivery.com/interstitial/?initialCid=AHrlqAAAAAMA&hash=A55FBF4311ED37&cid=Yw0QRSl16BFX&referer=https%3A%2F%2Fhiggsfield.ai%2F","cid":"Yw0QRSl16BFX"}"#; + const BLOCK_BODY: &str = r#"{"url":"https://geo.captcha-delivery.com/captcha/?initialCid=AHrlqAAAAAMA&hash=A55FBF4311ED37&cid=Yw0QRSl16BFX&t=bv&referer=https%3A%2F%2Fhiggsfield.ai%2F","cid":"Yw0QRSl16BFX"}"#; + + fn classify(status: u16, body: &str) -> Option { + classify_datadome_response(&DataDomeResponseSignals::new(status, body)) + } + + #[test] + fn success_is_never_datadome() { + assert_eq!(classify(200, CAPTCHA_BODY), None); + } + + #[test] + fn captcha_challenge() { + match classify(403, CAPTCHA_BODY) { + Some(DataDomeError::CaptchaChallenge { challenge_url }) => assert!(challenge_url.contains("/captcha/")), + other => panic!("expected CaptchaChallenge, got {:?}", other), + } + assert!(classify(403, CAPTCHA_BODY).unwrap().is_challenge()); + } + + #[test] + fn interstitial() { + assert!(matches!(classify(403, INTERSTITIAL_BODY), Some(DataDomeError::Interstitial { .. }))); + } + + #[test] + fn hard_block() { + let error = classify(403, BLOCK_BODY).unwrap(); + assert!(matches!(error, DataDomeError::Blocked { .. })); + assert!(error.is_hard_block()); + assert!(!error.is_challenge()); + assert_eq!(error.log_level(), log::Level::Error); + } + + #[test] + fn block_header_without_body_detail_is_unclassified() { + let signals = DataDomeResponseSignals::new(403, "").with_x_dd_b(Some("1")); + assert!(matches!(classify_datadome_response(&signals), Some(DataDomeError::Unclassified { status_code: 403, .. }))); + } + + #[test] + fn ordinary_api_errors_are_not_datadome() { + assert_eq!(classify(403, r#"{"detail":"Forbidden"}"#), None); + assert_eq!(classify(401, r#"{"detail":"Not authenticated"}"#), None); + // A JSON body with an unrelated `url` field isn't a challenge. + assert_eq!(classify(403, r#"{"url":"https://example.com/login"}"#), None); + } +} diff --git a/crates/lib/datadome_errors/src/datadome_error.rs b/crates/lib/datadome_errors/src/datadome_error.rs new file mode 100644 index 00000000..dfbd28cb --- /dev/null +++ b/crates/lib/datadome_errors/src/datadome_error.rs @@ -0,0 +1,97 @@ +use log::Level; +use std::error::Error; +use std::fmt::{Display, Formatter}; + +/// A response produced by DataDome's bot protection instead of the site. +/// +/// All variants mean "this client was not trusted"; they differ in whether +/// a browser could get it trusted again. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum DataDomeError { + /// A CAPTCHA challenge (`/captcha/`). A real browser can solve it and earn + /// a fresh `datadome` cookie; the replaying client must then present the + /// same cookie AND fingerprint (User-Agent, `x-datadome-clientid`). + CaptchaChallenge { + /// The challenge page URL DataDome returned. + challenge_url: String, + }, + + /// A device-check interstitial (`/interstitial/`): a JavaScript proof + /// rather than a visible puzzle. Same remedy as a CAPTCHA. + Interstitial { + challenge_url: String, + }, + + /// A hard block (`t=bv`): DataDome has decided this client is a bot and + /// won't offer a challenge. Only a new identity (IP / browser session) + /// clears it. + Blocked { + /// The block page URL, if one was given. + maybe_block_url: Option, + }, + + /// A response that carried DataDome's block signature (the `x-dd-b` + /// header, or a 403 JSON body naming DataDome) but no usable detail. + Unclassified { + status_code: u16, + raw_http_body: String, + }, +} + +impl Error for DataDomeError {} + +impl Display for DataDomeError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::CaptchaChallenge { challenge_url } => { + write!(f, "DataDome CAPTCHA challenge; a browser must solve it to earn a new datadome cookie (challenge url: {})", challenge_url) + } + Self::Interstitial { challenge_url } => { + write!(f, "DataDome device-check interstitial; a browser must pass it to earn a new datadome cookie (challenge url: {})", challenge_url) + } + Self::Blocked { maybe_block_url } => { + write!(f, "DataDome blocked this client outright (no challenge offered){}", + maybe_block_url.as_deref().map(|url| format!(" (block url: {url})")).unwrap_or_default()) + } + Self::Unclassified { status_code, raw_http_body } => { + write!(f, "DataDome rejected the request (status {}) with an unrecognized body: {}", status_code, raw_http_body) + } + } + } +} + +impl DataDomeError { + /// A browser session can clear this (captcha / interstitial). + pub fn is_challenge(&self) -> bool { + matches!(self, Self::CaptchaChallenge { .. } | Self::Interstitial { .. }) + } + + /// Nothing short of a new identity will clear this. + pub fn is_hard_block(&self) -> bool { + matches!(self, Self::Blocked { .. }) + } + + /// The URL DataDome would send a browser to, when known. + pub fn challenge_url(&self) -> Option<&str> { + match self { + Self::CaptchaChallenge { challenge_url } | Self::Interstitial { challenge_url } => Some(challenge_url), + Self::Blocked { maybe_block_url } => maybe_block_url.as_deref(), + Self::Unclassified { .. } => None, + } + } + + /// Challenges are a fingerprint/session problem we can act on (warn); + /// hard blocks and mysteries need eyes (error). + pub fn log_level(&self) -> Level { + match self { + Self::CaptchaChallenge { .. } | Self::Interstitial { .. } => Level::Warn, + Self::Blocked { .. } | Self::Unclassified { .. } => Level::Error, + } + } + + /// Log at [`Self::log_level`] with a caller-supplied context (which host, + /// which endpoint). One place to keep the wording consistent. + pub fn log(&self, context: &str) { + log::log!(self.log_level(), "[datadome] {}: {}", context, self); + } +} diff --git a/crates/lib/datadome_errors/src/datadome_response_signals.rs b/crates/lib/datadome_errors/src/datadome_response_signals.rs new file mode 100644 index 00000000..e8146d7f --- /dev/null +++ b/crates/lib/datadome_errors/src/datadome_response_signals.rs @@ -0,0 +1,36 @@ +/// Everything about a response that helps decide whether DataDome produced +/// it. Build with [`Self::new`] and add whichever headers the HTTP client +/// exposes; the body-only path works without any. +#[derive(Debug, Clone, Default)] +pub struct DataDomeResponseSignals<'a> { + pub status_code: u16, + + pub body: &'a str, + + /// The `x-datadome` header (`protected` on responses DataDome inspected). + pub maybe_x_datadome: Option<&'a str>, + + /// The `x-dd-b` header: present on responses DataDome blocked. + pub maybe_x_dd_b: Option<&'a str>, +} + +impl<'a> DataDomeResponseSignals<'a> { + pub fn new(status_code: u16, body: &'a str) -> Self { + Self { + status_code, + body, + maybe_x_datadome: None, + maybe_x_dd_b: None, + } + } + + pub fn with_x_datadome(mut self, value: Option<&'a str>) -> Self { + self.maybe_x_datadome = value; + self + } + + pub fn with_x_dd_b(mut self, value: Option<&'a str>) -> Self { + self.maybe_x_dd_b = value; + self + } +} diff --git a/crates/lib/datadome_errors/src/filter_datadome_errors.rs b/crates/lib/datadome_errors/src/filter_datadome_errors.rs new file mode 100644 index 00000000..b1c455e0 --- /dev/null +++ b/crates/lib/datadome_errors/src/filter_datadome_errors.rs @@ -0,0 +1,30 @@ +use crate::classify_datadome_response::classify_datadome_response; +use crate::datadome_error::DataDomeError; +use crate::datadome_response_signals::DataDomeResponseSignals; + +/// Status + body shortcut over +/// [`classify_datadome_response`]: `Err` when DataDome produced the +/// response, `Ok(())` for everything else. +pub fn filter_datadome_errors(status_code: u16, body: &str) -> Result<(), DataDomeError> { + match classify_datadome_response(&DataDomeResponseSignals::new(status_code, body)) { + Some(error) => Err(error), + None => Ok(()), + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn passes_non_datadome_errors_through() { + assert!(filter_datadome_errors(200, "ok").is_ok()); + assert!(filter_datadome_errors(403, r#"{"detail":"Forbidden"}"#).is_ok()); + } + + #[test] + fn catches_challenges() { + let body = r#"{"url":"https://geo.captcha-delivery.com/captcha/?cid=x&t=fe","cid":"x"}"#; + assert!(matches!(filter_datadome_errors(403, body), Err(DataDomeError::CaptchaChallenge { .. }))); + } +} diff --git a/crates/lib/datadome_errors/src/lib.rs b/crates/lib/datadome_errors/src/lib.rs new file mode 100644 index 00000000..2ded8564 --- /dev/null +++ b/crates/lib/datadome_errors/src/lib.rs @@ -0,0 +1,36 @@ +//! datadome_errors +//! +//! Recognize responses produced by DataDome's bot protection (used by +//! higgsfield.ai among others) rather than by the site's API, and say which +//! kind: a CAPTCHA challenge, a device-check interstitial, or a hard block. +//! Pair with `datadome_mitigation` for what to do about each. +//! +//! DataDome answers a blocked request with `403` and a small JSON body: +//! +//! ```json +//! {"url":"https://geo.captcha-delivery.com/captcha/?initialCid=...&hash=...&cid=...&t=fe&referer=...&s=...","cid":"..."} +//! ``` +//! +//! The `url` path says which page it would show a browser (`/captcha/`, +//! `/interstitial/`), and `t=bv` in its query means the client is banned +//! outright rather than challenged. Responses also carry an `x-datadome` +//! header (`protected`) and, on blocks, `x-dd-b`. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] + +pub mod classify_datadome_response; +pub mod datadome_error; +pub mod datadome_response_signals; +pub mod filter_datadome_errors; diff --git a/crates/lib/datadome_mitigation/Cargo.toml b/crates/lib/datadome_mitigation/Cargo.toml new file mode 100644 index 00000000..c9781ad4 --- /dev/null +++ b/crates/lib/datadome_mitigation/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "datadome_mitigation" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "datadome_mitigation" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +browser_emulation.workspace = true +datadome_errors.workspace = true + +# External +# (None) + +[dev-dependencies] +# (None) diff --git a/crates/lib/datadome_mitigation/src/client_id/datadome_client_id.rs b/crates/lib/datadome_mitigation/src/client_id/datadome_client_id.rs new file mode 100644 index 00000000..a25711b4 --- /dev/null +++ b/crates/lib/datadome_mitigation/src/client_id/datadome_client_id.rs @@ -0,0 +1,48 @@ +/// The cookie DataDome sets once it has profiled a client. Its value is the +/// client id. +pub const DATADOME_COOKIE: &str = "datadome"; + +/// The header DataDome's JS adds to API requests. Its value is the +/// `datadome` cookie's value — a request sending the cookie without the +/// header (or with a mismatched one) looks like a script, not the browser +/// that earned the cookie. +pub const DATADOME_CLIENT_ID_HEADER: &str = "x-datadome-clientid"; + +/// The DataDome client id carried by a cookie header, if any. +pub fn client_id_from_cookie_header(cookie_header: &str) -> Option { + cookie_header + .split(';') + .filter_map(|pair| pair.trim().split_once('=')) + .find(|(name, _)| name.trim() == DATADOME_COOKIE) + .map(|(_, value)| value.trim().to_string()) + .filter(|value| !value.is_empty()) +} + +/// The `(name, value)` header a replaying client should add, derived from +/// the cookie header. `None` when there's no `datadome` cookie — then the +/// site hasn't profiled this session and the header would be a lie. +pub fn client_id_header_for_cookie_header(cookie_header: &str) -> Option<(&'static str, String)> { + client_id_from_cookie_header(cookie_header).map(|value| (DATADOME_CLIENT_ID_HEADER, value)) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn extracts_client_id() { + let header = "__client=abc; datadome=Yw0QRSl16BFXimBAv1I7~SfJW6aNcwFV; _ga=1"; + assert_eq!(client_id_from_cookie_header(header).as_deref(), Some("Yw0QRSl16BFXimBAv1I7~SfJW6aNcwFV")); + assert_eq!( + client_id_header_for_cookie_header(header), + Some(("x-datadome-clientid", "Yw0QRSl16BFXimBAv1I7~SfJW6aNcwFV".to_string())), + ); + } + + #[test] + fn absent_or_empty_cookie_yields_none() { + assert_eq!(client_id_from_cookie_header("a=1; b=2"), None); + assert_eq!(client_id_from_cookie_header("datadome="), None); + assert_eq!(client_id_header_for_cookie_header(""), None); + } +} diff --git a/crates/lib/datadome_mitigation/src/client_id/mod.rs b/crates/lib/datadome_mitigation/src/client_id/mod.rs new file mode 100644 index 00000000..b412690b --- /dev/null +++ b/crates/lib/datadome_mitigation/src/client_id/mod.rs @@ -0,0 +1 @@ +pub mod datadome_client_id; diff --git a/crates/lib/datadome_mitigation/src/fingerprint/fingerprint_binding.rs b/crates/lib/datadome_mitigation/src/fingerprint/fingerprint_binding.rs new file mode 100644 index 00000000..4b6566b7 --- /dev/null +++ b/crates/lib/datadome_mitigation/src/fingerprint/fingerprint_binding.rs @@ -0,0 +1,31 @@ +use browser_emulation::browser_profile::BrowserProfile; + +/// The browser profile an HTTP client must use to replay a DataDome-profiled +/// session: the exact User-Agent that earned the `datadome` cookie, on the +/// fingerprint of the same browser family. DataDome scores the UA, TLS, and +/// HTTP/2 fingerprints together, so a cookie earned by WebKit and replayed +/// by a Chrome fingerprint is exactly the mismatch that gets challenged. +/// +/// When the capturing UA wasn't recorded, fall back to the profile the +/// integration pins on both sides. +pub fn profile_for_captured_user_agent( + maybe_captured_user_agent: Option<&str>, + fallback: BrowserProfile, +) -> BrowserProfile { + match maybe_captured_user_agent.map(str::trim).filter(|ua| !ua.is_empty()) { + Some(user_agent) => BrowserProfile::matching_user_agent(user_agent), + None => fallback, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn captured_ua_wins_over_fallback() { + let ua = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.15"; + assert_eq!(profile_for_captured_user_agent(Some(ua), BrowserProfile::Chrome145).maybe_user_agent_override(), Some(ua)); + assert_eq!(profile_for_captured_user_agent(None, BrowserProfile::Chrome145), BrowserProfile::Chrome145); + } +} diff --git a/crates/lib/datadome_mitigation/src/fingerprint/mod.rs b/crates/lib/datadome_mitigation/src/fingerprint/mod.rs new file mode 100644 index 00000000..b0e35f62 --- /dev/null +++ b/crates/lib/datadome_mitigation/src/fingerprint/mod.rs @@ -0,0 +1 @@ +pub mod fingerprint_binding; diff --git a/crates/lib/datadome_mitigation/src/lib.rs b/crates/lib/datadome_mitigation/src/lib.rs new file mode 100644 index 00000000..7ddb52c5 --- /dev/null +++ b/crates/lib/datadome_mitigation/src/lib.rs @@ -0,0 +1,17 @@ +//! datadome_mitigation +//! +//! What to do about DataDome's bot protection. The errors live in +//! `datadome_errors`; this crate holds the counter-measures shared by API +//! clients and the desktop app: +//! +//! - [`client_id`] — DataDome trusts a request when its `datadome` cookie +//! and `x-datadome-clientid` header agree with the browser fingerprint. +//! Derive the header from the cookie so replayed sessions send both. +//! - [`fingerprint`] — replay captured cookies under the User-Agent (and +//! browser-family fingerprint) that earned them. +//! - [`strategy`] — map a [`DataDomeError`](datadome_errors::datadome_error::DataDomeError) +//! to a [`DataDomeMitigation`](strategy::datadome_mitigation::DataDomeMitigation). + +pub mod client_id; +pub mod fingerprint; +pub mod strategy; diff --git a/crates/lib/datadome_mitigation/src/strategy/datadome_mitigation.rs b/crates/lib/datadome_mitigation/src/strategy/datadome_mitigation.rs new file mode 100644 index 00000000..1c15d547 --- /dev/null +++ b/crates/lib/datadome_mitigation/src/strategy/datadome_mitigation.rs @@ -0,0 +1,52 @@ +use datadome_errors::datadome_error::DataDomeError; + +/// The counter-measure for a DataDome rejection. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum DataDomeMitigation { + /// A challenge a browser can pass. Send the user through the site's login + /// window to earn a fresh `datadome` cookie, then replay it with the + /// matching `x-datadome-clientid` header and User-Agent + /// (see `client_id` and `fingerprint`). + ReauthenticateInBrowser, + + /// DataDome has banned this client identity. A re-login from the same + /// IP / browser profile will be banned too; surface it and stop. + GiveUp, +} + +impl DataDomeMitigation { + /// Whether the session needs a human in a browser before continuing. + pub fn needs_browser(&self) -> bool { + matches!(self, Self::ReauthenticateInBrowser) + } +} + +/// The mitigation for an error. DataDome never asks us to simply retry: +/// every rejection is about the client identity. +pub fn mitigation_for(error: &DataDomeError) -> DataDomeMitigation { + match error { + DataDomeError::CaptchaChallenge { .. } | DataDomeError::Interstitial { .. } => DataDomeMitigation::ReauthenticateInBrowser, + DataDomeError::Blocked { .. } => DataDomeMitigation::GiveUp, + // We know DataDome rejected us but not how; a fresh browser session is + // the only move that can help. + DataDomeError::Unclassified { .. } => DataDomeMitigation::ReauthenticateInBrowser, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn challenges_need_a_browser() { + let error = DataDomeError::CaptchaChallenge { challenge_url: "https://geo.captcha-delivery.com/captcha/".into() }; + assert_eq!(mitigation_for(&error), DataDomeMitigation::ReauthenticateInBrowser); + assert!(mitigation_for(&error).needs_browser()); + } + + #[test] + fn hard_blocks_give_up() { + let error = DataDomeError::Blocked { maybe_block_url: None }; + assert_eq!(mitigation_for(&error), DataDomeMitigation::GiveUp); + } +} diff --git a/crates/lib/datadome_mitigation/src/strategy/mod.rs b/crates/lib/datadome_mitigation/src/strategy/mod.rs new file mode 100644 index 00000000..d54f2f64 --- /dev/null +++ b/crates/lib/datadome_mitigation/src/strategy/mod.rs @@ -0,0 +1 @@ +pub mod datadome_mitigation; diff --git a/crates/lib/errors/Cargo.toml b/crates/lib/errors/Cargo.toml new file mode 100644 index 00000000..a70f5533 --- /dev/null +++ b/crates/lib/errors/Cargo.toml @@ -0,0 +1,29 @@ +[package] +name = "errors" +edition = "2018" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +# NB: Public "errors" crate is name-squatted, so we're fine to use this internally. +name = "errors" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# NB: This is one of the most central crates in the monorepo and everything depends on it. +# Consider the dependencies here wisely. +# Ideally we have almost nothing as a dependency of this crate. +anyhow.workspace = true + +[dev-dependencies] +# None yet diff --git a/crates/lib/errors/src/lib.rs b/crates/lib/errors/src/lib.rs new file mode 100644 index 00000000..70a8cea8 --- /dev/null +++ b/crates/lib/errors/src/lib.rs @@ -0,0 +1,31 @@ +//! errors +//! +//! The purpose of this library is to pin to a single 'anyhow' and also develop +//! common error utilities. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +/// Useful re-export. +pub use anyhow::anyhow; +pub use anyhow::bail; + +/// Easier to import than anyhow::Result. +/// (Naming things "Result" pollutes the import scope or requires nasty renames. Gross.) +pub type AnyhowResult = anyhow::Result; + +pub type AnyhowError = anyhow::Error; + diff --git a/crates/lib/files/file_hashing/Cargo.toml b/crates/lib/files/file_hashing/Cargo.toml new file mode 100644 index 00000000..b1272c2c --- /dev/null +++ b/crates/lib/files/file_hashing/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "file_hashing" +edition = "2024" +version = "0.0.1" +publish = false + +[lib] +name = "file_hashing" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# External +# KEEP THIS TO A MINIMUM OR NIL. +blake3.workspace = true + +[dev-dependencies] +tempfile.workspace = true diff --git a/crates/lib/files/file_hashing/src/hash_file.rs b/crates/lib/files/file_hashing/src/hash_file.rs new file mode 100644 index 00000000..53502480 --- /dev/null +++ b/crates/lib/files/file_hashing/src/hash_file.rs @@ -0,0 +1,66 @@ +use std::fs::File; +use std::io::{BufReader, Read}; +use std::path::Path; + +/// Streaming read size. 1 MiB keeps syscall counts low without holding a +/// large buffer per concurrent hash. +const READ_BUFFER_BYTES: usize = 1024 * 1024; + +/// BLAKE3 of a file's contents, as 64 lowercase hex characters. +/// +/// Streams the file; memory use is one buffer regardless of file size. This +/// is blocking I/O — call it from `spawn_blocking` in async contexts. +pub fn hash_file_blake3>(path: P) -> std::io::Result { + let file = File::open(path)?; + let mut reader = BufReader::with_capacity(READ_BUFFER_BYTES, file); + let mut hasher = blake3::Hasher::new(); + let mut buffer = vec![0u8; READ_BUFFER_BYTES]; + loop { + let read = reader.read(&mut buffer)?; + if read == 0 { + break; + } + hasher.update(&buffer[..read]); + } + Ok(hasher.finalize().to_hex().to_string()) +} + +/// BLAKE3 of in-memory bytes, as 64 lowercase hex characters. +pub fn hash_bytes_blake3(bytes: &[u8]) -> String { + blake3::hash(bytes).to_hex().to_string() +} + +#[cfg(test)] +mod tests { + use super::*; + + // Known-answer test vector: blake3 of the empty input. + const EMPTY_BLAKE3: &str = "af1349b9f5f9a1a6a0404dea36dcc9499bcb25c9adc112b7cc9a93cae41f3262"; + + #[test] + fn known_answers() { + assert_eq!(hash_bytes_blake3(b""), EMPTY_BLAKE3); + assert_eq!( + hash_bytes_blake3(b"hello world"), + "d74981efa70a0c880b8d8c1985d075dbcbf679b99a5f9914e5aaf96b831a9e24", + ); + } + + #[test] + fn file_and_bytes_agree() { + let dir = tempfile::tempdir().unwrap(); + let path = dir.path().join("data.bin"); + let contents = vec![7u8; 3 * 1024 * 1024 + 17]; // spans several read buffers + std::fs::write(&path, &contents).unwrap(); + assert_eq!(hash_file_blake3(&path).unwrap(), hash_bytes_blake3(&contents)); + + let empty = dir.path().join("empty.bin"); + std::fs::write(&empty, b"").unwrap(); + assert_eq!(hash_file_blake3(&empty).unwrap(), EMPTY_BLAKE3); + } + + #[test] + fn missing_file_errors() { + assert!(hash_file_blake3("/definitely/not/a/real/file").is_err()); + } +} diff --git a/crates/lib/files/file_hashing/src/lib.rs b/crates/lib/files/file_hashing/src/lib.rs new file mode 100644 index 00000000..97ff6704 --- /dev/null +++ b/crates/lib/files/file_hashing/src/lib.rs @@ -0,0 +1,11 @@ +//! Content hashing for local files. +//! +//! BLAKE3 is the house hash for file identity: faster than the disk it +//! reads from, 256-bit, and cryptographically collision-resistant — safe to +//! use as a content address (thumbnail cache keys, upload-dedup ledgers). +//! Column/field naming should carry the family (`file_hash_blake3`) so a +//! second family can coexist later. + +pub mod hash_file; + +pub use hash_file::{hash_bytes_blake3, hash_file_blake3}; diff --git a/crates/lib/files/file_to_base64_url/Cargo.toml b/crates/lib/files/file_to_base64_url/Cargo.toml new file mode 100644 index 00000000..a7c957d2 --- /dev/null +++ b/crates/lib/files/file_to_base64_url/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "file_to_base64_url" +edition = "2021" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "fal_client" +path = "src/lib.rs" + +[dependencies] + +# Workspace hack (faster compile times) +workspace-build-acceleration = { workspace = true } + +# Internal +errors.workspace = true + +# External +anyhow.workspace = true +base64.workspace = true +mimetypes.workspace = true + +[dev-dependencies] +test_utils = { path = "../../../testing/test_utils" } diff --git a/crates/lib/files/file_to_base64_url/src/file_to_base64_url.rs b/crates/lib/files/file_to_base64_url/src/file_to_base64_url.rs new file mode 100644 index 00000000..a5a4ce1d --- /dev/null +++ b/crates/lib/files/file_to_base64_url/src/file_to_base64_url.rs @@ -0,0 +1,45 @@ +use anyhow::anyhow; +use base64::prelude::BASE64_STANDARD; +use base64::Engine; +use errors::AnyhowResult; +use mimetypes::mimetype_info::mimetype_info::MimetypeInfo; +use std::path::Path; + +/// Read a file into a base64 URL-safe string. +pub fn file_to_base64_url>(path: P) -> AnyhowResult { + let bytes = std::fs::read(path.as_ref())?; + + let mime = match MimetypeInfo::get_for_bytes(&bytes) { + Some(mime) => mime, + None => { + return Err(anyhow!("could not determine mimetype")); + }, + }; + + let base64_bytes = BASE64_STANDARD.encode(&bytes); + + match mime.mime_type() { + "image/png" => Ok(format!("data:image/png;base64,{}", base64_bytes)), + "image/jpeg" => Ok(format!("data:image/jpeg;base64,{}", base64_bytes)), + _ => Err(anyhow!("unknown or unsupported mime type: {}", mime.mime_type())), + } +} + +#[cfg(test)] +mod tests { + use errors::AnyhowResult; + use test_utils::test_file_path::test_file_path; + use crate::file_to_base64_url::file_to_base64_url; + + #[test] + fn test_file_to_base64_url() -> AnyhowResult<()> { + let path = test_file_path("test_data/image/juno.jpg")?; + let base64_url = file_to_base64_url(path)?; + + assert!(base64_url.starts_with("data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEBLAEsAAD")); + assert!(base64_url.ends_with("z8c2LAteJ5zOIDcX5m04K3P/2Q==")); + assert_eq!(base64_url.len(), 223991); + + Ok(()) + } +} \ No newline at end of file diff --git a/crates/lib/files/file_to_base64_url/src/lib.rs b/crates/lib/files/file_to_base64_url/src/lib.rs new file mode 100644 index 00000000..ad027980 --- /dev/null +++ b/crates/lib/files/file_to_base64_url/src/lib.rs @@ -0,0 +1 @@ +pub mod file_to_base64_url; \ No newline at end of file diff --git a/crates/lib/files/filesys/Cargo.toml b/crates/lib/files/filesys/Cargo.toml new file mode 100644 index 00000000..6525f8f4 --- /dev/null +++ b/crates/lib/files/filesys/Cargo.toml @@ -0,0 +1,32 @@ +[package] +name = "filesys" +edition = "2018" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +# NB: Public "filesys" crate does not exist, so it's safe to use for now. +name = "filesys" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration = { version = "0.1", path = "../../../workspace-build-acceleration" } + +# Internal (keep this to a minimum!) +errors.workspace = true + +# External +# KEEP THIS TO A MINIMUM OR NIL. +log.workspace = true +walkdir.workspace = true + +[dev-dependencies] +test_utils = { path = "../../../testing/test_utils" } diff --git a/crates/lib/files/filesys/src/check_directory_exists.rs b/crates/lib/files/filesys/src/check_directory_exists.rs new file mode 100644 index 00000000..adef0550 --- /dev/null +++ b/crates/lib/files/filesys/src/check_directory_exists.rs @@ -0,0 +1,15 @@ +use std::path::Path; + +use errors::{AnyhowResult, bail}; + +pub fn check_directory_exists>(path: P) -> AnyhowResult<()> { + let check_path = path.as_ref(); + + if !check_path.exists() { + bail!("Path doesn't exist: {:?}", check_path); + } + if !check_path.is_dir() { + bail!("Path isn't a directory: {:?}", check_path); + } + Ok(()) +} diff --git a/crates/lib/files/filesys/src/check_file_exists.rs b/crates/lib/files/filesys/src/check_file_exists.rs new file mode 100644 index 00000000..62805c4c --- /dev/null +++ b/crates/lib/files/filesys/src/check_file_exists.rs @@ -0,0 +1,14 @@ +use std::path::PathBuf; + +use errors::AnyhowResult; +use errors::bail; + +pub fn check_file_exists(path: &PathBuf) -> AnyhowResult<()> { + if !path.exists() { + bail!("Path doesn't exist: {:?}", path); + } + if !path.is_file() { + bail!("Path isn't a file: {:?}", path); + } + Ok(()) +} diff --git a/crates/lib/files/filesys/src/create_dir_all_if_missing.rs b/crates/lib/files/filesys/src/create_dir_all_if_missing.rs new file mode 100644 index 00000000..f320e679 --- /dev/null +++ b/crates/lib/files/filesys/src/create_dir_all_if_missing.rs @@ -0,0 +1,17 @@ +use std::path::Path; + +use crate::directory_exists::directory_exists; + +/// create_dir_all, but only if it doesn't already exist. +/// (maybe this will miss permission errors.) +pub fn create_dir_all_if_missing>(path: P) -> std::io::Result<()> { + if directory_exists(&path) { + return Ok(()) + } + std::fs::create_dir_all(&path) +} + +#[cfg(test)] +mod tests { + // TODO +} diff --git a/crates/lib/files/filesys/src/directory_exists.rs b/crates/lib/files/filesys/src/directory_exists.rs new file mode 100644 index 00000000..66cbb008 --- /dev/null +++ b/crates/lib/files/filesys/src/directory_exists.rs @@ -0,0 +1,53 @@ +use std::path::Path; + +/// Check if the path exists and if it's a directory. +#[inline] +pub fn directory_exists>(path: P) -> bool { + let path_ref = path.as_ref(); + if !path_ref.exists() { + return false; + } + if !path_ref.is_dir() { + return false; + } + true +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::directory_exists::directory_exists; + + #[test] + fn test_directory_exists() { + // Common directories + assert_eq!(true, directory_exists("../../../../..")); + assert_eq!(true, directory_exists("./")); + assert_eq!(true, directory_exists("../")); + assert_eq!(true, directory_exists("/")); + + // As PathBuf + assert_eq!(true, directory_exists(PathBuf::from("../../../../.."))); + assert_eq!(true, directory_exists(PathBuf::from("./"))); + assert_eq!(true, directory_exists(PathBuf::from("../"))); + assert_eq!(true, directory_exists(PathBuf::from("/"))); + + // Other directories + assert_eq!(true, directory_exists("../../../../test_data/audio/flac")); + assert_eq!(true, directory_exists(PathBuf::from("../../../../test_data/audio/flac"))); + } + + #[test] + fn test_file_does_not_exist() { + assert_eq!(false, directory_exists("")); + assert_eq!(false, directory_exists(" ")); + assert_eq!(false, directory_exists("foo")); + assert_eq!(false, directory_exists("foo/bar/baz")); + assert_eq!(false, directory_exists("/foo/bar/baz")); + + assert_eq!(false, directory_exists(PathBuf::from(""))); + assert_eq!(false, directory_exists(PathBuf::from(" "))); + assert_eq!(false, directory_exists(PathBuf::from("foo/bar/baz"))); + } +} diff --git a/crates/lib/files/filesys/src/file_deletion/mod.rs b/crates/lib/files/filesys/src/file_deletion/mod.rs new file mode 100644 index 00000000..845eb593 --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/mod.rs @@ -0,0 +1,6 @@ +pub mod safe_delete_directory; +pub mod safe_delete_file; +pub mod safe_delete_files_and_directories; +pub mod safe_delete_possible_file; +pub mod safe_delete_possible_files_and_directories; +pub mod safe_recursively_delete_files; \ No newline at end of file diff --git a/crates/lib/files/filesys/src/file_deletion/safe_delete_directory.rs b/crates/lib/files/filesys/src/file_deletion/safe_delete_directory.rs new file mode 100644 index 00000000..6f977d46 --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/safe_delete_directory.rs @@ -0,0 +1,16 @@ +use std::fs; +use std::path::Path; + +use log::info; +use log::warn; + +/// Safely deletes a directory without panicking. Errors are logged. +/// This is an infallible, idempotent function. +pub fn safe_delete_directory>(directory_path: P) { + let printable_name = directory_path.as_ref().to_str().unwrap_or("bad directory"); + match fs::remove_dir_all(&directory_path) { + Ok(_) => info!("Temp directory deleted: {}", printable_name), + Err(e) => warn!("Could not delete temp directory{:?} (not a fatal error): {:?}", + printable_name, e), + } +} diff --git a/crates/lib/files/filesys/src/file_deletion/safe_delete_file.rs b/crates/lib/files/filesys/src/file_deletion/safe_delete_file.rs new file mode 100644 index 00000000..bc0c92d0 --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/safe_delete_file.rs @@ -0,0 +1,15 @@ +use std::path::Path; + +use log::info; +use log::warn; + +/// Safely deletes a file without panicking. Errors are logged. +/// This is an infallible, idempotent function. +pub fn safe_delete_file>(file_path: P) { + let printable_name = file_path.as_ref().to_str().unwrap_or("bad filename"); + match std::fs::remove_file(&file_path) { + Ok(_) => info!("Temp file deleted: {}", printable_name), + Err(e) => warn!("Could not delete temp file {:?} (not a fatal error): {:?}", + printable_name, e), + } +} diff --git a/crates/lib/files/filesys/src/file_deletion/safe_delete_files_and_directories.rs b/crates/lib/files/filesys/src/file_deletion/safe_delete_files_and_directories.rs new file mode 100644 index 00000000..75503bdb --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/safe_delete_files_and_directories.rs @@ -0,0 +1,39 @@ +use std::path::Path; + +use log::warn; + +use crate::file_deletion::safe_delete_directory::safe_delete_directory; +use crate::file_deletion::safe_delete_file::safe_delete_file; +use crate::file_deletion::safe_recursively_delete_files::safe_recursively_delete_files; + +/// Safely deletes all files and directories passed to the function without panicking. Errors are logged. +/// Directories are recursively deleted before being removed. +/// This is an infallible, idempotent function. +/// +/// Note on usage: since this is a generic function with only one generic type, `P`, you can only pass +/// a list of paths that are all the same type. If you have a mix of `PathBuf` and `&Path`, it's best to +/// convert the PathBuf to &Path references. Mixing other `AsRef` types will be more complicated, +/// so it may be worth calling `as_ref()` on them, e.g.: +/// +/// ```rust +/// use std::path::{Path, PathBuf}; +/// use filesys::file_deletion::safe_delete_files_and_directories::safe_delete_files_and_directories; +/// +/// safe_delete_files_and_directories(&[ +/// Path::new("1234_foo_bar_baz.bash"), +/// &PathBuf::from("1234_foo_bar_baz.bin"), +/// ]); +/// ``` +pub fn safe_delete_files_and_directories>(paths: &[P]) { + for path in paths { + let p = path.as_ref(); + if p.is_file() { + safe_delete_file(p); + } else if p.is_dir() { + safe_recursively_delete_files(p); + safe_delete_directory(p); + } else { + warn!("Path {:?} is neither a file nor a directory", p); + } + } +} diff --git a/crates/lib/files/filesys/src/file_deletion/safe_delete_possible_file.rs b/crates/lib/files/filesys/src/file_deletion/safe_delete_possible_file.rs new file mode 100644 index 00000000..d5b8a2a2 --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/safe_delete_possible_file.rs @@ -0,0 +1,11 @@ +use std::path::Path; + +use crate::file_deletion::safe_delete_file::safe_delete_file; + +/// Safely deletes a "possible" file (calling on None is a no-op) without panicking. Errors are logged. +/// This is an infallible, idempotent function. +pub fn safe_delete_possible_file>(maybe_file_path: Option

) { + if let Some(file_path) = maybe_file_path { + safe_delete_file(file_path) + } +} diff --git a/crates/lib/files/filesys/src/file_deletion/safe_delete_possible_files_and_directories.rs b/crates/lib/files/filesys/src/file_deletion/safe_delete_possible_files_and_directories.rs new file mode 100644 index 00000000..d8c6371a --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/safe_delete_possible_files_and_directories.rs @@ -0,0 +1,45 @@ +use std::path::Path; + +use log::warn; + +use crate::file_deletion::safe_delete_directory::safe_delete_directory; +use crate::file_deletion::safe_delete_file::safe_delete_file; +use crate::file_deletion::safe_recursively_delete_files::safe_recursively_delete_files; + +/// Safely deletes all files and directories passed to the function without panicking. Errors are logged. +/// Directories are recursively deleted before being removed. +/// This is an infallible, idempotent function. +/// +/// Note on usage: since this is a generic function with only one generic type, `P`, you can only pass +/// a list of paths that are all the same type. If you have a mix of `PathBuf` and `&Path`, it's best to +/// convert the PathBuf to &Path references. Mixing other `AsRef` types will be more complicated, +/// so it may be worth calling `as_ref()` on them, e.g.: +/// +/// ```rust +/// use std::path::{Path, PathBuf}; +/// use filesys::file_deletion::safe_delete_possible_files_and_directories::safe_delete_possible_files_and_directories; +/// +/// safe_delete_possible_files_and_directories(&[ +/// Some(Path::new("1234_foo_bar_baz.bash")), +/// None, +/// Some(&PathBuf::from("1234_foo_bar_baz.bin")), +/// None, +/// ]); +/// ``` +pub fn safe_delete_possible_files_and_directories>(possible_paths: &[Option

]) { + for possible_path in possible_paths { + let path = match possible_path { + None => continue, + Some(path) => path, + }; + let p = path.as_ref(); + if p.is_file() { + safe_delete_file(p); + } else if p.is_dir() { + safe_recursively_delete_files(p); + safe_delete_directory(p); + } else { + warn!("Path {:?} is neither a file nor a directory", p); + } + } +} diff --git a/crates/lib/files/filesys/src/file_deletion/safe_recursively_delete_files.rs b/crates/lib/files/filesys/src/file_deletion/safe_recursively_delete_files.rs new file mode 100644 index 00000000..be4477fc --- /dev/null +++ b/crates/lib/files/filesys/src/file_deletion/safe_recursively_delete_files.rs @@ -0,0 +1,29 @@ +use std::path::Path; + +use log::warn; +use walkdir::WalkDir; + +use crate::file_deletion::safe_delete_file::safe_delete_file; + +/// Deletes all files in the directory tree at the given path *without deleting the directory itself*, +/// and *without deleting any subdirectories*. This is an infallible, idempotent function. +pub fn safe_recursively_delete_files(path: &Path) { + if !path.exists() { + warn!("Path does not exist: {:?}", path); + return; + } + if !path.is_dir() { + warn!("Path is not a directory: {:?}", path); + return; + } + + let walk = WalkDir::new(path); + + for entry in walk { + if let Ok(entry) = entry { + if entry.path().is_file() { + safe_delete_file(entry.path()); + } + } + } +} diff --git a/crates/lib/files/filesys/src/file_exists.rs b/crates/lib/files/filesys/src/file_exists.rs new file mode 100644 index 00000000..9eb5dd2e --- /dev/null +++ b/crates/lib/files/filesys/src/file_exists.rs @@ -0,0 +1,40 @@ +use std::path::Path; + +pub fn file_exists>(path: P) -> bool { + let path_ref = path.as_ref(); + if !path_ref.exists() { + return false; + } + if !path_ref.is_file() { + return false; + } + true +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::file_exists::file_exists; + + #[test] + fn test_file_exists() { + assert_eq!(true, file_exists("../../../../test_data/audio/flac/zelda_ocarina_small_item.flac")); + assert_eq!(true, file_exists(PathBuf::from("../../../../test_data/audio/flac/zelda_ocarina_small_item.flac"))); + } + + #[test] + fn test_file_does_not_exist() { + assert_eq!(false, file_exists("")); + assert_eq!(false, file_exists(" ")); + assert_eq!(false, file_exists("./")); // Current directory is not a file + assert_eq!(false, file_exists("foo")); + assert_eq!(false, file_exists("foo/bar/baz")); + assert_eq!(false, file_exists("/foo/bar/baz")); + + assert_eq!(false, file_exists(PathBuf::from(""))); + assert_eq!(false, file_exists(PathBuf::from(" "))); + assert_eq!(false, file_exists(PathBuf::from("./"))); + assert_eq!(false, file_exists(PathBuf::from("foo/bar/baz"))); + } +} \ No newline at end of file diff --git a/crates/lib/files/filesys/src/file_lines/iterate_file_lines.rs b/crates/lib/files/filesys/src/file_lines/iterate_file_lines.rs new file mode 100644 index 00000000..0f3eef67 --- /dev/null +++ b/crates/lib/files/filesys/src/file_lines/iterate_file_lines.rs @@ -0,0 +1,38 @@ +use std::fs::File; +use std::io::{self, BufRead}; +use std::path::Path; + +/// Read lines from a file in an iterator. +/// From Rust manual: https://doc.rust-lang.org/rust-by-example/std_misc/file/read_lines.html +pub fn iterate_file_lines

(filename: P) -> io::Result>> +where P: AsRef, { + let file = File::open(filename)?; + Ok(io::BufReader::new(file).lines()) +} + +#[cfg(test)] +mod tests { + use test_utils::test_file_path::test_file_path; + use crate::file_lines::iterate_file_lines::iterate_file_lines; + + #[test] + fn load_file() { + let filename = test_file_path("test_data/text_files/cidr_ban_example/local_cidrs_example.txt") + .expect("should be a valid path"); + + let lines = iterate_file_lines(filename) + .expect("should be readable file"); + + let lines: Vec = lines.map(|line| line.unwrap()).collect(); + + assert_eq!( + lines, + vec![ + "# this is test data".to_string(), + "".to_string(), + "# local cidrs".to_string(), + "127.0.0.0/24".to_string(), + "192.168.0.0/24".to_string(), + ]); + } +} diff --git a/crates/lib/files/filesys/src/file_lines/iterate_trimmed_file_lines_without_comments.rs b/crates/lib/files/filesys/src/file_lines/iterate_trimmed_file_lines_without_comments.rs new file mode 100644 index 00000000..f86ddbbb --- /dev/null +++ b/crates/lib/files/filesys/src/file_lines/iterate_trimmed_file_lines_without_comments.rs @@ -0,0 +1,55 @@ +use crate::file_lines::iterate_file_lines::iterate_file_lines; +use std::io; +use std::path::Path; + +/// Read lines from a file in an iterator. +/// Remove comment lines prefixed with `#`. +pub fn iterate_trimmed_file_lines_without_comments

(filename: P) + -> io::Result>> +where + P: AsRef, +{ + // NB: This is a little bit nasty because we don't want to call ::collect() on + // the iterator to coalesce any errors in the stream. + let it = iterate_file_lines(filename)? + .map(|maybe_line| match maybe_line { + Ok(line) => Ok(line.trim().to_string()), + Err(e) => Err(e), + }) + .filter_map(|maybe_line| match maybe_line { + Err(e) => Some(Err(e)), + Ok(line) => { + if line.starts_with("#") || line.is_empty() { + None + } else { + Some(Ok(line)) + } + }, + }); + + Ok(it) +} + +#[cfg(test)] +mod tests { + use crate::file_lines::iterate_trimmed_file_lines_without_comments::iterate_trimmed_file_lines_without_comments; + use test_utils::test_file_path::test_file_path; + + #[test] + fn load_file() { + let filename = test_file_path("test_data/text_files/cidr_ban_example/local_cidrs_example.txt") + .expect("should be a valid path"); + + let lines = iterate_trimmed_file_lines_without_comments(filename) + .expect("should be readable file"); + + let lines: Vec = lines.filter_map(|line| line.ok()).collect(); + + assert_eq!( + lines, + vec![ + "127.0.0.0/24".to_string(), + "192.168.0.0/24".to_string(), + ]); + } +} diff --git a/crates/lib/files/filesys/src/file_lines/mod.rs b/crates/lib/files/filesys/src/file_lines/mod.rs new file mode 100644 index 00000000..e89c1f68 --- /dev/null +++ b/crates/lib/files/filesys/src/file_lines/mod.rs @@ -0,0 +1,2 @@ +pub mod iterate_file_lines; +pub mod iterate_trimmed_file_lines_without_comments; diff --git a/crates/lib/files/filesys/src/file_read_bytes.rs b/crates/lib/files/filesys/src/file_read_bytes.rs new file mode 100644 index 00000000..00fd8d73 --- /dev/null +++ b/crates/lib/files/filesys/src/file_read_bytes.rs @@ -0,0 +1,16 @@ +use std::fs::File; +use std::io; +use std::io::{BufReader, Read}; +use std::path::Path; + +/// Read a file into a byte buffer +pub fn file_read_bytes>(file_path: P) -> io::Result> { + let f = File::open(file_path)?; + let mut reader = BufReader::new(f); + let mut buffer = Vec::new(); + + // Read file into vector. + reader.read_to_end(&mut buffer)?; + + Ok(buffer) +} diff --git a/crates/lib/files/filesys/src/file_size.rs b/crates/lib/files/filesys/src/file_size.rs new file mode 100644 index 00000000..c64723f2 --- /dev/null +++ b/crates/lib/files/filesys/src/file_size.rs @@ -0,0 +1,42 @@ +use std::path::Path; + +use errors::{anyhow, AnyhowResult}; + +/// Return the file size of the file. +/// Only works for *files*, not directories or symlinks +pub fn file_size>(filename: P) -> AnyhowResult { + let metadata = std::fs::metadata(filename.as_ref())?; + + // TODO(bt,2023-11-29): Return io::Result and errors here. + if !metadata.is_file() { + Err(anyhow!("path {:?} is not a file", filename.as_ref())) + } else if metadata.is_symlink() { + Err(anyhow!("path {:?} is a symlink", filename.as_ref())) + } else { + Ok(metadata.len()) + } +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::file_size::file_size; + + fn test_file(path_from_repo_root: &str) -> PathBuf { + // https://doc.rust-lang.org/cargo/reference/environment-variables.html + let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR")); + path.push(format!("../../../../{}", path_from_repo_root)); + path + } + + #[test] + pub fn test_file_size() { + // Success case + let path = test_file("test_data/audio/flac/zelda_ocarina_small_item.flac"); + assert_eq!(file_size(path).unwrap(), 271925); + + // Error case + assert!(file_size("non/existing/path").is_err()); + } +} diff --git a/crates/lib/files/filesys/src/filename_concat.rs b/crates/lib/files/filesys/src/filename_concat.rs new file mode 100644 index 00000000..40d7ca89 --- /dev/null +++ b/crates/lib/files/filesys/src/filename_concat.rs @@ -0,0 +1,84 @@ +use std::path::{Path, PathBuf}; + +use crate::path_to_string::path_to_string; + +/// Concatenate filenames while preserving path information. Do not join paths as directories. +/// This contains no file normalizing logic, it's purely a concatenation. +/// +/// eg. "foo" + "bar" results in "foobar" instead of the "foo/bar" that Path::join() returns. +/// eg. "/usr/bin" + "baz" results in "/usr/binbaz" instead of "/usr/bin/baz" +/// +/// This is not efficient. +pub fn filename_concat, Q: AsRef>(part_1: P, part_2: Q) -> String { + let mut base = path_to_string(part_1); + let suffix= path_to_string(part_2); + base.push_str(&suffix); + base +} + +pub fn filename_concat_pathbuf, Q: AsRef>(part_1: P, part_2: Q) -> PathBuf { + PathBuf::from(filename_concat(part_1, part_2)) +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::filename_concat::filename_concat; + + // Layout: Base, Suffix, Expected Result + const TEST_CASES : [(&'static str, &'static str, &'static str); 11] = [ + // Absolute + ("/", "foo", "/foo"), + ("/usr/bin", "baz", "/usr/binbaz"), + ("/usr/local", "/bin", "/usr/local/bin"), + // Relative + ("picture", ".jpg", "picture.jpg"), + ("/", "..", "/.."), + ("../", "..", "../.."), + ("./", "bin", "./bin"), + (".", "bar", ".bar"), + // Misc + ("", "", ""), + ("/", "", "/"), + ("", "/", "/"), + ]; + + #[test] + fn pathbuf() { + for (part_1, part_2, expected) in TEST_CASES.iter() { + let test_part_1 = PathBuf::from(part_1); + let test_part_2 = PathBuf::from(part_2); + assert_eq!(filename_concat(test_part_1, test_part_2), expected.to_string()); + } + } + + #[test] + fn path() { + for (part_1, part_2, expected) in TEST_CASES.iter() { + let test_part_1 = PathBuf::from(part_1); + let test_part_2 = PathBuf::from(part_2); + + assert_eq!(filename_concat(test_part_1.as_path(), test_part_2.as_path()), + expected.to_string()); + } + } + + #[test] + fn str() { + for (part_1, part_2, expected) in TEST_CASES.iter() { + let test_part_1 = *part_1; + let test_part_2 = *part_2; + assert_eq!(filename_concat(test_part_1, test_part_2), expected.to_string()); + } + } + + #[test] + fn mixed_type() { + for (part_1, part_2, expected) in TEST_CASES.iter() { + let test_part_1 = PathBuf::from(part_1); + let test_part_2 = *part_2; + assert_eq!(filename_concat(test_part_1, test_part_2), expected.to_string()); + } + } +} diff --git a/crates/lib/files/filesys/src/is_filesystem_full_error.rs b/crates/lib/files/filesys/src/is_filesystem_full_error.rs new file mode 100644 index 00000000..fdbc459e --- /dev/null +++ b/crates/lib/files/filesys/src/is_filesystem_full_error.rs @@ -0,0 +1,16 @@ + +// Nearly a third of `ErrorKind` is nightly rust, so we're going to have to match on +// unix error codes until the rest of the ErrorKind enum variants are stable. +// The error codes are maintained in sys/unix/voice_conversion_to_weights - decode_error_kind(i32) + +const E_FILESYSTEM_QUOTA_EXCEEDED : i32 = 122; // pub const EDQUOT: ::c_int = 122; +const E_STORAGE_FULL : i32 = 28; // pub const ENOSPC: ::c_int = 28; + +/// Reports if an io::Error was caused by the filesystem being full. +pub fn is_filesystem_full_error(err: &std::io::Error) -> bool { + match err.raw_os_error() { + Some(E_FILESYSTEM_QUOTA_EXCEEDED) => true, + Some(E_STORAGE_FULL) => true, + _ => false, + } +} diff --git a/crates/lib/files/filesys/src/lib.rs b/crates/lib/files/filesys/src/lib.rs new file mode 100644 index 00000000..0d5c3fc5 --- /dev/null +++ b/crates/lib/files/filesys/src/lib.rs @@ -0,0 +1,36 @@ +//! filesys +//! +//! The purpose of this library is to make basic filesystem operations easier. +//! We won't be including content type or magic type features that incur a higher cost. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod check_directory_exists; +pub mod check_file_exists; +pub mod create_dir_all_if_missing; +pub mod directory_exists; +pub mod file_deletion; +pub mod file_exists; +pub mod file_lines; +pub mod file_read_bytes; +pub mod file_size; +pub mod filename_concat; +pub mod is_filesystem_full_error; +pub mod path_to_string; +pub mod read_to_trimmed_string; +pub mod recursively_find_file_by_name; +pub mod rename_across_devices; diff --git a/crates/lib/files/filesys/src/path_to_string.rs b/crates/lib/files/filesys/src/path_to_string.rs new file mode 100644 index 00000000..d5635a28 --- /dev/null +++ b/crates/lib/files/filesys/src/path_to_string.rs @@ -0,0 +1,53 @@ +use std::path::Path; + +/// Convert a path to a string without adding quotes or garbage. +pub fn path_to_string>(path: P) -> String { + path.as_ref().display().to_string() +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::path_to_string::path_to_string; + + const TEST_CASES : [&'static str; 9] = [ + // Absolute + "/", + "/usr/bin", + // Relative + "picture.jpg", + "foo/bar/baz", + "../", + "./", + ".", + // Misc + "", + ".././../foo/.././bar", + ]; + + #[test] + fn pathbuf() { + for example in TEST_CASES.iter() { + let test = PathBuf::from(example); + assert_eq!(path_to_string(test), example.to_string()); + } + } + + #[test] + fn path() { + for example in TEST_CASES.iter() { + let path = PathBuf::from(example); + let test = path.as_path(); + assert_eq!(path_to_string(test), example.to_string()); + } + } + + #[test] + fn str() { + for example in TEST_CASES.iter() { + let test = *example; + assert_eq!(path_to_string(test), example.to_string()); + } + } +} diff --git a/crates/lib/files/filesys/src/read_to_trimmed_string.rs b/crates/lib/files/filesys/src/read_to_trimmed_string.rs new file mode 100644 index 00000000..737755fe --- /dev/null +++ b/crates/lib/files/filesys/src/read_to_trimmed_string.rs @@ -0,0 +1,8 @@ +use std::fs::read_to_string; +use std::io; +use std::path::Path; + +pub fn read_to_trimmed_string>(path: P) -> io::Result { + let content = read_to_string(path)?; + Ok(content.trim().to_string()) +} diff --git a/crates/lib/files/filesys/src/recursively_find_file_by_name.rs b/crates/lib/files/filesys/src/recursively_find_file_by_name.rs new file mode 100644 index 00000000..5b93eee0 --- /dev/null +++ b/crates/lib/files/filesys/src/recursively_find_file_by_name.rs @@ -0,0 +1,56 @@ +use std::path::{Path, PathBuf}; +use walkdir::WalkDir; +use errors::AnyhowResult; + +pub fn recursively_find_file_by_name, Q: AsRef>( + search_filename: P, + search_root: Q, + max_depth: usize, +) -> AnyhowResult> { + + let walker = WalkDir::new(search_root) + .max_depth(max_depth); + + for entry in walker { + let entry = entry?; + if entry.path().is_dir() { + let check_path = entry.path().join(search_filename.as_ref()); + if check_path.exists() && check_path.is_file() { + return Ok(Some(check_path)); + } + } + } + + Ok(None) +} + +#[cfg(test)] +mod tests { + use test_utils::test_file_path::test_file_path; + use crate::recursively_find_file_by_name::recursively_find_file_by_name; + + #[test] + fn test_path_exists() { + let test_data_path = test_file_path("test_data/").expect("should work"); + let result = recursively_find_file_by_name( + "super_mario_rpg_beware_the_forests_mushrooms.mp3", + test_data_path, + 5 + ); + let result = result.expect("should be ok"); + let result = result.expect("should exist"); + assert!(result.ends_with("test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3")); + } + + #[test] + fn test_path_does_not_exist() { + let test_data_path = test_file_path("test_data/").expect("should work"); + let result = recursively_find_file_by_name( + "fake_name.foo", + test_data_path, + 5 + ); + let result = result.expect("should be ok"); + assert!(result.is_none()); + } +} \ No newline at end of file diff --git a/crates/lib/files/filesys/src/rename_across_devices.rs b/crates/lib/files/filesys/src/rename_across_devices.rs new file mode 100644 index 00000000..13c53b84 --- /dev/null +++ b/crates/lib/files/filesys/src/rename_across_devices.rs @@ -0,0 +1,81 @@ +use std::error::Error; +use std::fmt; +use std::path::Path; + +use log::error; + +use crate::is_filesystem_full_error::is_filesystem_full_error; + +#[derive(Debug)] +pub enum RenameError { + StorageFull, + IoError(std::io::Error), +} + +impl Error for RenameError {} + +impl fmt::Display for RenameError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + RenameError::StorageFull => write!(f, "RenameError: storage is full"), + RenameError::IoError(err) => write!(f, "{:?}", err), + } + } +} + +impl From for RenameError { + fn from(error: std::io::Error) -> Self { + RenameError::IoError(error) + } +} + +/// Rename a file. +/// Ordinary rename will fail in Linux if it is across physical devices. +/// This function will perform a copy followed by delete in that case. +/// In both cases, this function will overwrite the destination if it already exists. +pub fn rename_across_devices, Q: AsRef>(from: P, to: Q) -> Result<(), RenameError> { + let result = std::fs::rename(&from, &to); + + let err = match result { + Ok(_) => return Ok(()), // Rename succeeded. + Err(err) => err, + }; + + // Nearly a third of `ErrorKind` is nightly rust, so we're going to have to match on + // unix error codes until the rest of the ErrorKind enum variants are stable. + // The error codes are maintained in sys/unix/voice_conversion_to_weights - decode_error_kind(i32) + const E_CROSSES_DEVICES : i32 = 18; // pub const EXDEV: ::c_int = 18; + + if is_filesystem_full_error(&err) { + error!("Filesystem is full during rename."); + return Err(RenameError::StorageFull); + } + + match err.raw_os_error() { + Some(E_CROSSES_DEVICES) => { + // NB: Fall through. + } + _ => { + // Something else happened. Return original error. + return Err(RenameError::IoError(err)); + } + } + + // NB: In production we've seen std::fs::copy silently succeed, yet copy zero bytes. The reason + // is more than likely that the filesystem is full. We'll check the number of copied bytes to + // confirm. Moreover, the Rust docs say wrt std::fs::copy, "On success, the total number of bytes + // copied is returned and it is equal to the length of the to file as reported by metadata." + let original_file_size = std::fs::metadata(from.as_ref())?.len(); + + let num_bytes_copied = std::fs::copy(&from, &to)?; + + if num_bytes_copied != original_file_size { + error!("Filesystem is full during copy. Not all bytes copied."); + return Err(RenameError::StorageFull); + } + + // An emulated "rename" would delete the source file. + std::fs::remove_file(&from)?; + + Ok(()) +} diff --git a/crates/lib/files/images/Cargo.toml b/crates/lib/files/images/Cargo.toml new file mode 100644 index 00000000..0c30f430 --- /dev/null +++ b/crates/lib/files/images/Cargo.toml @@ -0,0 +1,33 @@ +[package] +name = "images" +edition = "2024" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +# NB: Public "images" crate doesn't exist; "image" crate is the heavily used public library, +# so perhaps this naming scheme causes confusion (?) +name = "images" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration = { workspace = true } + +# Internal +errors = { workspace = true} +mimetypes = { workspace = true } + +# External +image = { version = "0.25.6" , features = ["jpeg", "png", "tiff", "webp"] } + +[dev-dependencies] +anyhow = { workspace = true } +test_utils = { path = "../../../testing/test_utils" } diff --git a/crates/lib/files/images/src/encoding/image_bytes_to_png_bytes.rs b/crates/lib/files/images/src/encoding/image_bytes_to_png_bytes.rs new file mode 100644 index 00000000..5c497c44 --- /dev/null +++ b/crates/lib/files/images/src/encoding/image_bytes_to_png_bytes.rs @@ -0,0 +1,18 @@ +use crate::error::ImagesError; +use image::{ImageFormat, ImageReader}; +use std::io::Cursor; + +pub fn image_bytes_to_png_bytes( + arbitrary_image_bytes: &[u8], +) -> Result, ImagesError> { + let reader = ImageReader::new(Cursor::new(arbitrary_image_bytes)); + + let image = reader + .with_guessed_format()? // NB: Can raise IoError. + .decode()?; + + let mut output_bytes: Vec = Vec::new(); + image.write_to(&mut Cursor::new(&mut output_bytes), ImageFormat::Png)?; + + Ok(output_bytes) +} diff --git a/crates/lib/files/images/src/encoding/image_bytes_to_png_bytes_with_dimensions.rs b/crates/lib/files/images/src/encoding/image_bytes_to_png_bytes_with_dimensions.rs new file mode 100644 index 00000000..06bcfbd3 --- /dev/null +++ b/crates/lib/files/images/src/encoding/image_bytes_to_png_bytes_with_dimensions.rs @@ -0,0 +1,29 @@ +use std::io::Cursor; +use image::{ImageFormat, ImageReader}; +use crate::error::ImagesError; + +pub struct PngBytesWithDimensions { + pub png_bytes: Vec, + pub width: u32, + pub height: u32, +} + +pub fn image_bytes_to_png_bytes_with_dimensions( + arbitrary_image_bytes: &[u8], +) -> Result { + + let reader = ImageReader::new(Cursor::new(arbitrary_image_bytes)); + + let image = reader + .with_guessed_format()? // NB: Can raise IoError. + .decode()?; + + let mut output_bytes: Vec = Vec::new(); + image.write_to(&mut Cursor::new(&mut output_bytes), ImageFormat::Png)?; + + Ok(PngBytesWithDimensions { + png_bytes: output_bytes, + width: image.width(), + height: image.height(), + }) +} diff --git a/crates/lib/files/images/src/encoding/mod.rs b/crates/lib/files/images/src/encoding/mod.rs new file mode 100644 index 00000000..1e6618af --- /dev/null +++ b/crates/lib/files/images/src/encoding/mod.rs @@ -0,0 +1,3 @@ +pub mod image_bytes_to_png_bytes; +pub mod image_bytes_to_png_bytes_with_dimensions; +pub mod webp_bytes_to_png_bytes; \ No newline at end of file diff --git a/crates/lib/files/images/src/encoding/webp_bytes_to_png_bytes.rs b/crates/lib/files/images/src/encoding/webp_bytes_to_png_bytes.rs new file mode 100644 index 00000000..66e96d06 --- /dev/null +++ b/crates/lib/files/images/src/encoding/webp_bytes_to_png_bytes.rs @@ -0,0 +1,21 @@ +use crate::error::ImagesError; +use image::{ImageFormat, ImageReader}; +use std::io::Cursor; + +pub fn webp_bytes_to_png_bytes( + webp_bytes: &[u8], +) -> Result, ImagesError> { + + let mut reader = ImageReader::new(Cursor::new(webp_bytes)); + + reader.set_format(ImageFormat::WebP); // Default to WebP format (as fallback). + + let image = reader + .with_guessed_format()? // NB: Can raise IoError. + .decode()?; + + let mut output_bytes: Vec = Vec::new(); + image.write_to(&mut Cursor::new(&mut output_bytes), ImageFormat::Png)?; + + Ok(output_bytes) +} \ No newline at end of file diff --git a/crates/lib/files/images/src/error.rs b/crates/lib/files/images/src/error.rs new file mode 100644 index 00000000..e52a09c0 --- /dev/null +++ b/crates/lib/files/images/src/error.rs @@ -0,0 +1,31 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum ImagesError { + IoError(std::io::Error), + ImageError(image::ImageError), +} + +impl Error for ImagesError {} + +impl Display for ImagesError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + ImagesError::IoError(err) => write!(f, "IO Error: {}", err), + ImagesError::ImageError(err) => write!(f, "Image Error: {}", err), + } + } +} + +impl From for ImagesError { + fn from(err: std::io::Error) -> Self { + ImagesError::IoError(err) + } +} + +impl From for ImagesError { + fn from(err: image::ImageError) -> Self { + ImagesError::ImageError(err) + } +} diff --git a/crates/lib/files/images/src/image_info/image_info.rs b/crates/lib/files/images/src/image_info/image_info.rs new file mode 100644 index 00000000..7893f126 --- /dev/null +++ b/crates/lib/files/images/src/image_info/image_info.rs @@ -0,0 +1,100 @@ +use crate::image_info::image_info_error::ImageInfoError; +use image::{GenericImageView, ImageReader}; +use mimetypes::mimetype_info::file_extension::FileExtension; +use mimetypes::mimetype_info::mimetype_info::MimetypeInfo; +use std::io::Cursor; +use std::path::Path; + +#[derive(Clone, Debug)] +pub struct ImageInfo { + /// The mimetype we determined + mimetype_info: MimetypeInfo, + + /// The width of the image in pixels + width: u32, + + /// The height of the image in pixels + height: u32, +} + +impl ImageInfo { + /// Note: This has to do a full file read, and we throw the parsed image on the floor. + pub fn decode_image_from_bytes(bytes: &[u8]) -> Result { + let image = ImageReader::new(Cursor::new(bytes)).with_guessed_format()?.decode()?; + let (width, height) = image.dimensions(); + Ok(ImageInfo { + mimetype_info: MimetypeInfo::get_for_bytes(bytes) + .ok_or_else(|| ImageInfoError::CouldNotDetermineMimetype)?, + width, + height, + }) + } + + /// Note: This has to do a full file read, and we throw the parsed image on the floor. + pub fn decode_image_from_path>(path: P) -> Result { + let image = ImageReader::open(&path)?.decode()?; + let (width, height) = image.dimensions(); + Ok(ImageInfo { + mimetype_info: MimetypeInfo::get_for_path(path)? + .ok_or_else(|| ImageInfoError::CouldNotDetermineMimetype)?, + width, + height, + }) + } + + pub fn width(&self) -> u32 { + self.width + } + + pub fn height(&self) -> u32 { + self.height + } + + pub fn dimensions(&self) -> (u32, u32) { + (self.width, self.height) + } + + pub fn mime_type(&self) -> &str { + self.mimetype_info.mime_type() + } + + pub fn file_extension(&self) -> Option { + self.mimetype_info.file_extension() + } +} + +#[cfg(test)] +mod tests { + use crate::image_info::image_info::ImageInfo; + use mimetypes::mimetype_info::file_extension::FileExtension; + use test_utils::test_file_path::test_file_path; + + #[test] + fn jpg_file() -> anyhow::Result<()> { + let path = test_file_path("test_data/image/mochi.jpg")?; + let info = ImageInfo::decode_image_from_path(path)?; + assert_eq!(info.width(), 753); + assert_eq!(info.height(), 1000); + assert_eq!(info.mime_type(), "image/jpeg"); + let ext = info.file_extension().expect("should have extension"); + assert_eq!(ext, FileExtension::Jpg); + assert_eq!(ext.extension_with_period(), ".jpg"); + assert_eq!(ext.extension_without_period(), "jpg"); + Ok(()) + } + + #[test] + fn jpg_bytes() -> anyhow::Result<()> { + let path = test_file_path("test_data/image/juno.jpg")?; + let bytes = std::fs::read(path)?; + let info = ImageInfo::decode_image_from_bytes(&bytes)?; + assert_eq!(info.width(), 1000); + assert_eq!(info.height(), 750); + assert_eq!(info.mime_type(), "image/jpeg"); + let ext = info.file_extension().expect("should have extension"); + assert_eq!(ext, FileExtension::Jpg); + assert_eq!(ext.extension_with_period(), ".jpg"); + assert_eq!(ext.extension_without_period(), "jpg"); + Ok(()) + } +} diff --git a/crates/lib/files/images/src/image_info/image_info_error.rs b/crates/lib/files/images/src/image_info/image_info_error.rs new file mode 100644 index 00000000..e1d84cd3 --- /dev/null +++ b/crates/lib/files/images/src/image_info/image_info_error.rs @@ -0,0 +1,39 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::io; + +#[derive(Debug)] +pub enum ImageInfoError { + CouldNotDetermineMimetype, + ImageError(image::ImageError), + IoError(io::Error), +} + +impl Error for ImageInfoError {} + +impl Display for ImageInfoError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + ImageInfoError::CouldNotDetermineMimetype => { + write!(f, "ImageInfoError::CouldNotDetermineMimetype") + } + ImageInfoError::ImageError(err) => { + write!(f, "ImageInfoError::ImageError: {}", err) + } + ImageInfoError::IoError(err) => { + write!(f, "ImageInfoError::IoError: {}", err) + } + } + } +} + +impl From for ImageInfoError { + fn from(err: image::ImageError) -> Self { + ImageInfoError::ImageError(err) + } +} +impl From for ImageInfoError { + fn from(err: io::Error) -> Self { + ImageInfoError::IoError(err) + } +} diff --git a/crates/lib/files/images/src/image_info/mod.rs b/crates/lib/files/images/src/image_info/mod.rs new file mode 100644 index 00000000..1d5cdbac --- /dev/null +++ b/crates/lib/files/images/src/image_info/mod.rs @@ -0,0 +1,2 @@ +pub mod image_info; +pub mod image_info_error; \ No newline at end of file diff --git a/crates/lib/files/images/src/lib.rs b/crates/lib/files/images/src/lib.rs new file mode 100644 index 00000000..c65665cf --- /dev/null +++ b/crates/lib/files/images/src/lib.rs @@ -0,0 +1,32 @@ +//! images +//! +//! Even though the "image" library is the most widely used crate, if we declare a dependency here +//! we can update every downstream caller in unison. This will also let us collect common algorithms +//! and functions. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +// Re-export image to everyone importing this library +pub use image; + +pub mod encoding; +pub mod error; +pub mod image_info; +pub mod mask_images; +pub mod resize_image_file_preserving_aspect; +pub mod resize_preserving_aspect; + diff --git a/crates/lib/files/images/src/mask_images/mod.rs b/crates/lib/files/images/src/mask_images/mod.rs new file mode 100644 index 00000000..b2b6d6f1 --- /dev/null +++ b/crates/lib/files/images/src/mask_images/mod.rs @@ -0,0 +1 @@ +pub mod normalize_image_bytes_to_flux_mask; \ No newline at end of file diff --git a/crates/lib/files/images/src/mask_images/normalize_image_bytes_to_flux_mask.rs b/crates/lib/files/images/src/mask_images/normalize_image_bytes_to_flux_mask.rs new file mode 100644 index 00000000..fa631099 --- /dev/null +++ b/crates/lib/files/images/src/mask_images/normalize_image_bytes_to_flux_mask.rs @@ -0,0 +1,40 @@ +use crate::error::ImagesError; +use image::{GenericImage, GenericImageView, ImageFormat, ImageReader, Rgba}; +use std::io::Cursor; + +pub struct PngBytes(pub Vec); + +/// Normalize arbitrary image bytes to a PNG format image. +/// Make sure the bitmap is in the correct mask format. +pub fn normalize_image_bytes_to_flux_mask( + arbitrary_image_bytes: &[u8], +) -> Result { + + let reader = ImageReader::new(Cursor::new(arbitrary_image_bytes)); + + let mut image = reader + .with_guessed_format()? // NB: Can raise IoError. + .decode()?; + + let (width, height) = image.dimensions(); + + for y in 0..height { + for x in 0..width { + let rgba_pixel = image.get_pixel(x, y); + + if rgba_pixel[3] == 0 { + // Alpha pixel is transparent + // Set to black. Mask ignore region. + image.put_pixel(x, y, Rgba([0, 0, 0, 255])); + } else { + // Set to white. Mask interest region. + image.put_pixel(x, y, Rgba([255, 255, 255, 255])); + } + } + } + + let mut output_bytes: Vec = Vec::new(); + image.write_to(&mut Cursor::new(&mut output_bytes), ImageFormat::Png)?; + + Ok(PngBytes(output_bytes)) +} diff --git a/crates/lib/files/images/src/resize_image_file_preserving_aspect.rs b/crates/lib/files/images/src/resize_image_file_preserving_aspect.rs new file mode 100644 index 00000000..27035472 --- /dev/null +++ b/crates/lib/files/images/src/resize_image_file_preserving_aspect.rs @@ -0,0 +1,43 @@ +use std::fs::File; +use std::io::BufReader; +use std::path::Path; + +use image::DynamicImage; +use image::io::Reader; + +use errors::AnyhowResult; + +use crate::resize_preserving_aspect::resize_preserving_aspect; + +pub fn resize_image_file_preserving_aspect>( + source_image_file: P, + new_width: u32, + new_height: u32, + exact_fit: bool, +) -> AnyhowResult { + let file = File::open(source_image_file)?; + let reader = BufReader::new(file); + + let reader = Reader::new(reader) + .with_guessed_format()?; + + let img = reader.decode()?; + + Ok(resize_preserving_aspect(&img, new_width, new_height, exact_fit)) +} + +#[cfg(test)] +mod tests { + use test_utils::test_file_path::test_file_path; + + use crate::resize_image_file_preserving_aspect::resize_image_file_preserving_aspect; + + #[test] + fn test_happy_path() { + // NB: The other function does most of the testing + let path = test_file_path("test_data/image/mochi.jpg").unwrap(); + let image = resize_image_file_preserving_aspect(path, 100, 100, true).unwrap(); + assert_eq!(image.width(), 100); + assert_eq!(image.height(), 100); + } +} \ No newline at end of file diff --git a/crates/lib/files/images/src/resize_preserving_aspect.rs b/crates/lib/files/images/src/resize_preserving_aspect.rs new file mode 100644 index 00000000..2470e550 --- /dev/null +++ b/crates/lib/files/images/src/resize_preserving_aspect.rs @@ -0,0 +1,134 @@ +use image::DynamicImage; +use image::imageops::FilterType; + +/// Resize an image preserving the exact aspect ratio of the source image. +/// +/// If `exact_fit` is true, the image will be resized to fit the largest dimension, +/// then cropped to fit the precise dimensions specified. +pub fn resize_preserving_aspect( + source_image: &DynamicImage, + new_width: u32, + new_height: u32, + exact_fit: bool, +) -> DynamicImage { + if exact_fit { + source_image.resize_to_fill(new_width, new_height, FilterType::Lanczos3) + } else { + source_image.resize(new_width, new_height, FilterType::Lanczos3) + } +} + +#[cfg(test)] +mod tests { + use image::DynamicImage; + + use errors::AnyhowResult; + use test_utils::test_file_path::test_file_path; + + use crate::resize_preserving_aspect::resize_preserving_aspect; + + fn open_test_image(filename: &str) -> AnyhowResult { + let path = test_file_path(filename)?; + Ok(image::open(path)?) + } + + fn open_tall_image() -> AnyhowResult { + let image = open_test_image("test_data/image/mochi.jpg").unwrap(); + assert!(image.width() < image.height()); + assert_eq!(image.width(), 753); + assert_eq!(image.height(), 1000); + Ok(image) + } + + fn open_wide_image() -> AnyhowResult { + let image = open_test_image("test_data/image/juno.jpg").unwrap(); + assert!(image.width() > image.height()); + assert_eq!(image.width(), 1000); + assert_eq!(image.height(), 750); + Ok(image) + } + + #[test] + fn downsize_wide_image_preserving_aspect() { + let image = open_wide_image().unwrap(); + let resized = resize_preserving_aspect(&image, 500, 500, false); + assert!(resized.width() > resized.height()); + assert_eq!(resized.width(), 500); + assert_eq!(resized.height(), 375); + } + + #[test] + fn downsize_tall_image_preserving_aspect() { + let image = open_tall_image().unwrap(); + let resized = resize_preserving_aspect(&image, 500, 500, false); + assert!(resized.width() < resized.height()); + assert_eq!(resized.width(), 377); + assert_eq!(resized.height(), 500); + } + + #[test] + fn enlarge_wide_image_preserving_aspect() { + let image = open_wide_image().unwrap(); + let resized = resize_preserving_aspect(&image, 1200, 1200, false); + assert!(resized.width() > resized.height()); + assert_eq!(resized.width(), 1200); + assert_eq!(resized.height(), 900); + } + + #[test] + fn enlarge_tall_image_preserving_aspect() { + let image = open_tall_image().unwrap(); + let resized = resize_preserving_aspect(&image, 1200, 1200, false); + assert!(resized.width() < resized.height()); + assert_eq!(resized.width(), 904); + assert_eq!(resized.height(), 1200); + } + + #[test] + fn resize_wide_image_preserving_aspect_exact() { + // Downscale + let image = open_wide_image().unwrap(); + let resized = resize_preserving_aspect(&image, 500, 500, true); + assert_eq!(resized.width(), 500); + assert_eq!(resized.height(), 500); + + // Upscale + let resized = resize_preserving_aspect(&image, 1200, 1200, true); + assert_eq!(resized.width(), 1200); + assert_eq!(resized.height(), 1200); + + // Really wide + let resized = resize_preserving_aspect(&image, 1200, 100, true); + assert_eq!(resized.width(), 1200); + assert_eq!(resized.height(), 100); + + // Really tall + let resized = resize_preserving_aspect(&image, 100, 1200, true); + assert_eq!(resized.width(), 100); + assert_eq!(resized.height(), 1200); + } + + #[test] + fn resize_tall_image_preserving_aspect_exact() { + // Downscale + let image = open_tall_image().unwrap(); + let resized = resize_preserving_aspect(&image, 500, 500, true); + assert_eq!(resized.width(), 500); + assert_eq!(resized.height(), 500); + + // Upscale + let resized = resize_preserving_aspect(&image, 1200, 1200, true); + assert_eq!(resized.width(), 1200); + assert_eq!(resized.height(), 1200); + + // Really wide + let resized = resize_preserving_aspect(&image, 1200, 100, true); + assert_eq!(resized.width(), 1200); + assert_eq!(resized.height(), 100); + + // Really tall + let resized = resize_preserving_aspect(&image, 100, 1200, true); + assert_eq!(resized.width(), 100); + assert_eq!(resized.height(), 1200); + } +} diff --git a/crates/lib/files/mimetypes/Cargo.toml b/crates/lib/files/mimetypes/Cargo.toml new file mode 100644 index 00000000..da5d9082 --- /dev/null +++ b/crates/lib/files/mimetypes/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "mimetypes" +edition = "2024" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +# NB: Public "mimetypes" crate does not exist, so it's safe to use for now. +name = "mimetypes" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration = { workspace = true } + +# External +infer = "0.19.0" # Mimetype detection + +[dev-dependencies] +test_utils = { path = "../../../testing/test_utils" } +anyhow = { workspace = true } diff --git a/crates/lib/files/mimetypes/src/custom/custom_infer.rs b/crates/lib/files/mimetypes/src/custom/custom_infer.rs new file mode 100644 index 00000000..97d805ec --- /dev/null +++ b/crates/lib/files/mimetypes/src/custom/custom_infer.rs @@ -0,0 +1,78 @@ +use infer::Infer; +use std::sync::LazyLock; + +pub (crate) static CUSTOM_INFER: LazyLock = LazyLock::new(|| { + let mut infer = Infer::new(); + add_custom_types(&mut infer); + infer +}); + +fn add_custom_types(infer: &mut Infer) { + infer.add("model/gltf-binary", "glb", gltf_matcher); + infer.add("model/fbx", "fbx", fbx_matcher); + infer.add("model/ply", "ply", ply_matcher); +} + +fn gltf_matcher(buf: &[u8]) -> bool { + // Magic is 'glTF' (103 108 84 70) + // https://github.com/KhronosGroup/glTF/blob/main/extensions/1.0/Khronos/KHR_binary_glTF/README.md + buf.len() >= 4 && buf[0] == 103 && buf[1] == 108 && buf[2] == 84 && buf[3] == 70 +} + +fn ply_matcher(buf: &[u8]) -> bool { + // PLY files (ASCII and binary alike) start with the line "ply". + // https://paulbourke.net/dataformats/ply/ + buf.len() >= 4 + && &buf[..3] == b"ply" + && (buf[3] == b'\n' || buf[3] == b'\r') +} + +fn fbx_matcher(buf: &[u8]) -> bool { + // Binary FBX magic: "Kaydara FBX Binary " (two trailing spaces). + // https://code.blender.org/2013/08/fbx-binary-file-format-specification/ + // NB: ASCII FBX files have no magic and are not detected here. + const FBX_MAGIC: &[u8] = b"Kaydara FBX Binary "; + buf.len() >= FBX_MAGIC.len() && &buf[..FBX_MAGIC.len()] == FBX_MAGIC +} + +#[cfg(test)] +mod tests { + use crate::custom::custom_infer::CUSTOM_INFER; + use test_utils::test_file_path::test_file_path; + + #[test] + fn test_gltf() -> anyhow::Result<()> { + let path = test_file_path("test_data/3d/hanashi.glb")?; + let maybe_type = CUSTOM_INFER.get_from_path(path)?.unwrap(); + assert_eq!(maybe_type.mime_type(), "model/gltf-binary"); + Ok(()) + } + + #[test] + fn test_binary_fbx_magic() { + let mut bytes = b"Kaydara FBX Binary ".to_vec(); + bytes.extend_from_slice(&[0x00, 0x1a, 0x00]); + let maybe_type = CUSTOM_INFER.get(&bytes).unwrap(); + assert_eq!(maybe_type.mime_type(), "model/fbx"); + } + + #[test] + fn test_ply_magic() { + let bytes = b"ply\nformat binary_little_endian 1.0\n".to_vec(); + let maybe_type = CUSTOM_INFER.get(&bytes).unwrap(); + assert_eq!(maybe_type.mime_type(), "model/ply"); + } + + #[test] + fn test_ply_prefix_without_newline_is_not_detected() { + let bytes = b"plywood texture".to_vec(); + assert!(CUSTOM_INFER.get(&bytes).is_none()); + } + + #[test] + fn test_ascii_fbx_is_not_detected() { + // ASCII FBX files have no magic bytes. + let bytes = b"; FBX 7.3.0 project file".to_vec(); + assert!(CUSTOM_INFER.get(&bytes).is_none()); + } +} diff --git a/crates/lib/files/mimetypes/src/custom/mod.rs b/crates/lib/files/mimetypes/src/custom/mod.rs new file mode 100644 index 00000000..69519270 --- /dev/null +++ b/crates/lib/files/mimetypes/src/custom/mod.rs @@ -0,0 +1 @@ +pub (crate) mod custom_infer; \ No newline at end of file diff --git a/crates/lib/files/mimetypes/src/lib.rs b/crates/lib/files/mimetypes/src/lib.rs new file mode 100644 index 00000000..286b1abf --- /dev/null +++ b/crates/lib/files/mimetypes/src/lib.rs @@ -0,0 +1,26 @@ +//! mimetypes +//! +//! The purpose of this library is to perform mimetype detection routines on files, raw bytes, +//! streams, etc. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub (crate) mod custom; +pub mod mimetype_for_bytes; +pub mod mimetype_for_file; +pub mod mimetype_info; +pub mod mimetype_to_extension; diff --git a/crates/lib/files/mimetypes/src/mimetype_for_bytes.rs b/crates/lib/files/mimetypes/src/mimetype_for_bytes.rs new file mode 100644 index 00000000..66cf9bc4 --- /dev/null +++ b/crates/lib/files/mimetypes/src/mimetype_for_bytes.rs @@ -0,0 +1,41 @@ + +const DEFAULT_BINARY_MIMETYPE : &str = "application/octet-stream"; + +pub fn get_mimetype_for_bytes(bytes: &[u8]) -> Option<&'static str> { + infer::get(bytes) + .map(|typ| typ.mime_type()) +} + +pub fn get_mimetype_for_bytes_or_default(bytes: &[u8]) -> &'static str { + infer::get(bytes) + .map(|typ| typ.mime_type()) + .unwrap_or(DEFAULT_BINARY_MIMETYPE) +} + +#[cfg(test)] +mod tests { + use crate::mimetype_for_bytes::{get_mimetype_for_bytes, get_mimetype_for_bytes_or_default}; + + #[test] + fn test_mimetype_png() { + // NB: From "Hanashi Mask.png" + let bytes : Vec = vec![ + 137, 80, 78, 71, 13, 10, 26, 10, + 0, 0, 0, 13, 73, 72, 68, 82, + 0, 0, 20, 193, 0, 0, 15, 239, + 8, 6, 0, 0, 0, 163, 131, 119, + 122, 0, 0, 0, + ]; + + assert_eq!(get_mimetype_for_bytes(&bytes), Some("image/png")); + assert_eq!(get_mimetype_for_bytes_or_default(&bytes), "image/png"); + } + + #[test] + fn test_mimetype_unknown() { + let bytes : Vec = vec![]; + + assert_eq!(get_mimetype_for_bytes(&bytes), None); + assert_eq!(get_mimetype_for_bytes_or_default(&bytes), "application/octet-stream"); + } +} diff --git a/crates/lib/files/mimetypes/src/mimetype_for_file.rs b/crates/lib/files/mimetypes/src/mimetype_for_file.rs new file mode 100644 index 00000000..83af7721 --- /dev/null +++ b/crates/lib/files/mimetypes/src/mimetype_for_file.rs @@ -0,0 +1,44 @@ +use std::path::Path; + +const DEFAULT_BINARY_MIMETYPE : &str = "application/octet-stream"; + +pub fn get_mimetype_for_file>(file: P) -> std::io::Result> { + infer::get_from_path(file) + .map(|maybe_type| maybe_type.map(|typ| typ.mime_type())) +} + +pub fn get_mimetype_for_file_or_default>(file: P) -> std::io::Result<&'static str> { + get_mimetype_for_file(file) + .map(|maybe_type| match maybe_type { + Some(mimetype) => mimetype, + None => DEFAULT_BINARY_MIMETYPE, + }) +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::mimetype_for_file::get_mimetype_for_file; + + fn test_file(path_from_repo_root: &str) -> PathBuf { + // https://doc.rust-lang.org/cargo/reference/environment-variables.html + let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR")); + path.push(format!("../../../../{}", path_from_repo_root)); + path + } + + #[test] + fn test_mimetype_mp3() { + let path = test_file("test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3"); + + assert_eq!(get_mimetype_for_file(&path).unwrap(), Some("audio/mpeg")); + } + + #[test] + fn test_mimetype_unknown() { + let path = test_file("test_data/video/mp4/golden_sun_garoh.mp4"); + + assert_eq!(get_mimetype_for_file(&path).unwrap(), Some("video/mp4")); + } +} diff --git a/crates/lib/files/mimetypes/src/mimetype_info/file_extension.rs b/crates/lib/files/mimetypes/src/mimetype_info/file_extension.rs new file mode 100644 index 00000000..2aa1825d --- /dev/null +++ b/crates/lib/files/mimetypes/src/mimetype_info/file_extension.rs @@ -0,0 +1,81 @@ + +/// This is a constrained set of file extensions that: +/// 1. we care about +/// 2. we can detect with magic bytes +/// 3. are not text formats / are binary formats +#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)] +pub enum FileExtension { + Aac, + Fbx, + Flac, + Gif, + Glb, + Jpg, + Mov, + Mp3, + Mp4, + Obj, + Ogg, + Opus, + Ply, + Png, + Wav, + Webm, + Webp, +} + +impl FileExtension { + pub fn from_mimetype(mimetype: &str) -> Option { + match mimetype { + "audio/aac" => Some(FileExtension::Aac), + "model/fbx" => Some(FileExtension::Fbx), + "application/fbx" => Some(FileExtension::Fbx), + "audio/flac" => Some(FileExtension::Flac), + "image/gif" => Some(FileExtension::Gif), + "model/gltf-binary" => Some(FileExtension::Glb), + "image/jpeg" => Some(FileExtension::Jpg), + "video/quicktime" => Some(FileExtension::Mov), + "audio/mpeg" => Some(FileExtension::Mp3), + "video/mp4" => Some(FileExtension::Mp4), + "model/obj" => Some(FileExtension::Obj), + "model/ply" => Some(FileExtension::Ply), + "audio/ogg" => Some(FileExtension::Ogg), + "audio/opus" => Some(FileExtension::Opus), + "image/png" => Some(FileExtension::Png), + "audio/wav" => Some(FileExtension::Wav), + "video/webm" => Some(FileExtension::Webm), + "image/webp" => Some(FileExtension::Webp), + _ => None, + } + } + + pub fn extension_with_period(&self) -> &'static str { + self.with_and_without_period().0 + } + + pub fn extension_without_period(&self) -> &'static str { + self.with_and_without_period().1 + } + + fn with_and_without_period(&self) -> (&'static str, &'static str) { + match self { + FileExtension::Aac => (".aac", "aac"), + FileExtension::Fbx => (".fbx", "fbx"), + FileExtension::Flac => (".flac", "flac"), + FileExtension::Gif => (".gif", "gif"), + FileExtension::Glb => (".glb", "glb"), + FileExtension::Jpg => (".jpg", "jpg"), + FileExtension::Mov => (".mov", "mov"), + FileExtension::Mp3 => (".mp3", "mp3"), + FileExtension::Mp4 => (".mp4", "mp4"), + FileExtension::Obj => (".obj", "obj"), + FileExtension::Ogg => (".ogg", "ogg"), + FileExtension::Opus => (".opus", "opus"), + FileExtension::Ply => (".ply", "ply"), + FileExtension::Png => (".png", "png"), + FileExtension::Wav => (".wav", "wav"), + FileExtension::Webm => (".webm", "webm"), + FileExtension::Webp => (".webp", "webp"), + } + } +} diff --git a/crates/lib/files/mimetypes/src/mimetype_info/mimetype_info.rs b/crates/lib/files/mimetypes/src/mimetype_info/mimetype_info.rs new file mode 100644 index 00000000..6369dc7f --- /dev/null +++ b/crates/lib/files/mimetypes/src/mimetype_info/mimetype_info.rs @@ -0,0 +1,93 @@ +use crate::custom::custom_infer::CUSTOM_INFER; +use crate::mimetype_info::file_extension::FileExtension; +use infer::Type; +use std::io; +use std::path::Path; + +#[derive(Clone, Debug)] +pub struct MimetypeInfo { + /// The mimetype we determined + mime_type: String, + + /// The extension for the mimetype, if we could determine it. + file_extension: Option, +} + +impl MimetypeInfo { + pub fn get_for_bytes(bytes: &[u8]) -> Option { + CUSTOM_INFER.get(bytes) + .map(|t| Self::for_type(t)) + } + + pub fn get_for_path>(path: P) -> io::Result> { + CUSTOM_INFER.get_from_path(path) + .map(|maybe_type| maybe_type.map(|t| Self::for_type(t))) + } + + fn for_type(r#type: Type) -> Self { + let mime_type = r#type.mime_type().to_string(); + MimetypeInfo { + file_extension: FileExtension::from_mimetype(&mime_type), + mime_type, + } + } + + pub fn mime_type(&self) -> &str { + &self.mime_type + } + + pub fn file_extension(&self) -> Option { + self.file_extension + } +} + +#[cfg(test)] +mod tests { + use crate::mimetype_info::file_extension::FileExtension; + use crate::mimetype_info::mimetype_info::MimetypeInfo; + + mod for_bytes { + use super::*; + + #[test] + fn png() { + // NB: From "Hanashi Mask.png" + let bytes: Vec = vec![137, 80, 78, 71, 13, 10, 26, 10]; + let t = MimetypeInfo::get_for_bytes(&bytes).expect("should detect bytes"); + assert_eq!(t.mime_type(), "image/png"); + let ext = t.file_extension.expect("should have extension"); + assert_eq!(ext, FileExtension::Png); + assert_eq!(ext.extension_with_period(), ".png"); + assert_eq!(ext.extension_without_period(), "png"); + } + } + + mod for_files { + use super::*; + use test_utils::test_file_path::test_file_path; + + #[test] + fn mp3() -> anyhow::Result<()> { + let path = test_file_path("test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3")?; + let t = MimetypeInfo::get_for_path(path)?.expect("should detect type"); + assert_eq!(t.mime_type(), "audio/mpeg"); + let ext = t.file_extension.expect("should have extension"); + assert_eq!(ext, FileExtension::Mp3); + assert_eq!(ext.extension_with_period(), ".mp3"); + assert_eq!(ext.extension_without_period(), "mp3"); + Ok(()) + } + + #[test] + fn glb() -> anyhow::Result<()> { + let path = test_file_path("test_data/3d/hanashi.glb")?; + let t = MimetypeInfo::get_for_path(path)?.expect("should detect type"); + assert_eq!(t.mime_type(), "model/gltf-binary"); + let ext = t.file_extension.expect("should have extension"); + assert_eq!(ext, FileExtension::Glb); + assert_eq!(ext.extension_with_period(), ".glb"); + assert_eq!(ext.extension_without_period(), "glb"); + Ok(()) + } + } +} diff --git a/crates/lib/files/mimetypes/src/mimetype_info/mod.rs b/crates/lib/files/mimetypes/src/mimetype_info/mod.rs new file mode 100644 index 00000000..910eaea5 --- /dev/null +++ b/crates/lib/files/mimetypes/src/mimetype_info/mod.rs @@ -0,0 +1,2 @@ +pub mod file_extension; +pub mod mimetype_info; \ No newline at end of file diff --git a/crates/lib/files/mimetypes/src/mimetype_to_extension.rs b/crates/lib/files/mimetypes/src/mimetype_to_extension.rs new file mode 100644 index 00000000..7e53f35e --- /dev/null +++ b/crates/lib/files/mimetypes/src/mimetype_to_extension.rs @@ -0,0 +1,49 @@ + +/// Provide a best guess extension for the given mime type. +/// Extensions do not include a "." (period) prefix. +pub fn mimetype_to_extension(mimetype: &str) -> Option<&'static str> { + // TODO(bt,2023-11-17): maybe make a bidirectional map + match mimetype { + // Image + "image/gif" => Some("gif"), + "image/jpeg" => Some("jpg"), + "image/png" => Some("png"), + "image/webp" => Some("webp"), + // Audio + "audio/aac" => Some("aac"), + "audio/m4a" => Some("m4a"), + "audio/mpeg" => Some("mp3"), + "audio/ogg" => Some("ogg"), + "audio/opus" => Some("opus"), + "audio/wav" => Some("wav"), + "audio/x-flac" => Some("flac"), + "audio/x-wav" => Some("wav"), + // Video + "video/mp4" /* .mp4 */ => Some("mp4"), + "video/quicktime" /* .mov */ => Some("mov"), + "video/webm" => Some("webm"), // TODO: Browsers send this for audio? + _ => None + } +} + +#[cfg(test)] +mod test { + use crate::mimetype_to_extension::mimetype_to_extension; + + #[test] + fn no_value() { + assert_eq!(mimetype_to_extension(""), None); + assert_eq!(mimetype_to_extension("blah"), None); + assert_eq!(mimetype_to_extension("nothing"), None); + } + + #[test] + fn mime_type_spot_check() { + assert_eq!(mimetype_to_extension("audio/mpeg"), Some("mp3")); + assert_eq!(mimetype_to_extension("audio/wav"), Some("wav")); + assert_eq!(mimetype_to_extension("audio/x-wav"), Some("wav")); + assert_eq!(mimetype_to_extension("image/png"), Some("png")); + assert_eq!(mimetype_to_extension("image/jpeg"), Some("jpg")); + assert_eq!(mimetype_to_extension("video/mp4"), Some("mp4")); + } +} \ No newline at end of file diff --git a/crates/lib/files/thumbnails/Cargo.toml b/crates/lib/files/thumbnails/Cargo.toml new file mode 100644 index 00000000..c4c599ea --- /dev/null +++ b/crates/lib/files/thumbnails/Cargo.toml @@ -0,0 +1,32 @@ +[package] +name = "thumbnails" +edition = "2024" +version = "0.0.1" +publish = false + +[lib] +name = "thumbnails" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +images.workspace = true + +# External +log.workspace = true +# MP4 demuxing (pure Rust). +mp4.workspace = true +# H.264 decoding — Cisco's openh264, built from vendored source at compile +# time; no runtime dependency on the customer machine. +openh264.workspace = true +# Animated WebP encoding — vendored libwebp, same no-runtime-deps property. +webp-animation.workspace = true + +[dev-dependencies] +tempfile.workspace = true diff --git a/crates/lib/files/thumbnails/src/error.rs b/crates/lib/files/thumbnails/src/error.rs new file mode 100644 index 00000000..4ddfa3e6 --- /dev/null +++ b/crates/lib/files/thumbnails/src/error.rs @@ -0,0 +1,41 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum ThumbnailError { + Io(std::io::Error), + + /// The file isn't a container/codec we can read (e.g. webm, HEVC). The + /// caller should show a placeholder, not retry. + Unsupported(String), + + /// The container parsed but no decodable frame came out. + Decode(String), + + Encode(String), +} + +impl ThumbnailError { + pub fn is_unsupported(&self) -> bool { + matches!(self, Self::Unsupported(_)) + } +} + +impl Error for ThumbnailError {} + +impl Display for ThumbnailError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::Io(err) => write!(f, "Thumbnail I/O error: {}", err), + Self::Unsupported(message) => write!(f, "Unsupported media for thumbnailing: {}", message), + Self::Decode(message) => write!(f, "Could not decode media: {}", message), + Self::Encode(message) => write!(f, "Could not encode thumbnail: {}", message), + } + } +} + +impl From for ThumbnailError { + fn from(err: std::io::Error) -> Self { + Self::Io(err) + } +} diff --git a/crates/lib/files/thumbnails/src/image_thumbnail.rs b/crates/lib/files/thumbnails/src/image_thumbnail.rs new file mode 100644 index 00000000..bc824ba6 --- /dev/null +++ b/crates/lib/files/thumbnails/src/image_thumbnail.rs @@ -0,0 +1,108 @@ +use std::fs::File; +use std::io::BufWriter; +use std::path::Path; + +use images::image::codecs::jpeg::JpegEncoder; +use images::image::DynamicImage; +use images::resize_preserving_aspect::resize_preserving_aspect; + +use crate::error::ThumbnailError; + +const JPEG_QUALITY: u8 = 80; + +/// Decode an image file, downscale it (aspect-preserving, longest edge = +/// `max_dimension`, never upscaled), and write it as a JPEG. +/// +/// Blocking CPU + I/O — call from `spawn_blocking` in async contexts. +pub fn generate_image_thumbnail, Q: AsRef>( + source: P, + destination_jpg: Q, + max_dimension: u32, +) -> Result<(), ThumbnailError> { + let decoded = images::image::open(source.as_ref()) + .map_err(|err| ThumbnailError::Unsupported(format!("{}: {}", source.as_ref().display(), err)))?; + let thumbnail = downscale(&decoded, max_dimension); + write_jpeg(&thumbnail, destination_jpg.as_ref()) +} + +/// Downscale only; small sources pass through at native size. +pub(crate) fn downscale(decoded: &DynamicImage, max_dimension: u32) -> DynamicImage { + if decoded.width() <= max_dimension && decoded.height() <= max_dimension { + decoded.clone() + } else { + resize_preserving_aspect(decoded, max_dimension, max_dimension, false) + } +} + +/// Write via a temp file + rename so a crash never leaves a half-written +/// cache entry behind. +pub(crate) fn write_jpeg(thumbnail: &DynamicImage, destination: &Path) -> Result<(), ThumbnailError> { + let temp_path = temp_sibling(destination); + { + let file = File::create(&temp_path)?; + let mut encoder = JpegEncoder::new_with_quality(BufWriter::new(file), JPEG_QUALITY); + encoder.encode_image(&thumbnail.to_rgb8()) + .map_err(|err| ThumbnailError::Encode(err.to_string()))?; + } + std::fs::rename(&temp_path, destination)?; + Ok(()) +} + +pub(crate) fn write_bytes_atomically(bytes: &[u8], destination: &Path) -> Result<(), ThumbnailError> { + let temp_path = temp_sibling(destination); + std::fs::write(&temp_path, bytes)?; + std::fs::rename(&temp_path, destination)?; + Ok(()) +} + +fn temp_sibling(destination: &Path) -> std::path::PathBuf { + let mut name = destination.file_name().unwrap_or_default().to_os_string(); + name.push(".tmp"); + destination.with_file_name(name) +} + +#[cfg(test)] +mod tests { + use images::image::RgbImage; + + use super::*; + + #[test] + fn thumbnails_are_downscaled_and_written_atomically() { + let dir = tempfile::tempdir().unwrap(); + let source = dir.path().join("source.png"); + let wide = DynamicImage::ImageRgb8(RgbImage::from_fn(1024, 512, |x, _| { + images::image::Rgb([(x % 256) as u8, 0, 0]) + })); + wide.save(&source).unwrap(); + + let destination = dir.path().join("thumb.jpg"); + generate_image_thumbnail(&source, &destination, 512).unwrap(); + + let thumbnail = images::image::open(&destination).unwrap(); + assert_eq!(thumbnail.width(), 512); + assert_eq!(thumbnail.height(), 256); + assert!(!dir.path().join("thumb.jpg.tmp").exists()); + } + + #[test] + fn small_images_are_not_upscaled() { + let dir = tempfile::tempdir().unwrap(); + let source = dir.path().join("small.png"); + DynamicImage::ImageRgb8(RgbImage::new(100, 60)).save(&source).unwrap(); + + let destination = dir.path().join("thumb.jpg"); + generate_image_thumbnail(&source, &destination, 512).unwrap(); + let thumbnail = images::image::open(&destination).unwrap(); + assert_eq!((thumbnail.width(), thumbnail.height()), (100, 60)); + } + + #[test] + fn non_images_are_unsupported() { + let dir = tempfile::tempdir().unwrap(); + let source = dir.path().join("not_an_image.bin"); + std::fs::write(&source, b"definitely not pixels").unwrap(); + let err = generate_image_thumbnail(&source, dir.path().join("t.jpg"), 512).unwrap_err(); + assert!(err.is_unsupported()); + } +} diff --git a/crates/lib/files/thumbnails/src/lib.rs b/crates/lib/files/thumbnails/src/lib.rs new file mode 100644 index 00000000..e173ecc7 --- /dev/null +++ b/crates/lib/files/thumbnails/src/lib.rs @@ -0,0 +1,62 @@ +//! thumbnails +//! +//! Pure-Rust thumbnail generation for local media files: static JPEG +//! thumbnails for images and videos, plus a ~1-second animated WebP preview +//! for videos. Video support covers H.264 in MP4 — what every current +//! provider emits — via vendored decoders (no ffmpeg, no runtime deps on +//! the customer machine). Anything else returns a typed "unsupported" +//! error for the caller to placeholder. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] + +pub mod error; +pub mod image_thumbnail; +pub mod mp4_frames; +pub mod video_thumbnail; + +pub use error::ThumbnailError; +pub use image_thumbnail::generate_image_thumbnail; +pub use video_thumbnail::generate_video_thumbnails; + +/// Longest edge of static thumbnails (matches the frontend's +/// `THUMBNAIL_SIZES.LARGE`). +pub const STATIC_THUMBNAIL_MAX_DIMENSION: u32 = 512; + +/// Longest edge of animated previews (kept small; these hold ~24 frames). +pub const ANIMATED_PREVIEW_MAX_DIMENSION: u32 = 320; + +/// How much leading video the animated preview covers. +pub const ANIMATED_PREVIEW_MAX_DURATION_MS: u32 = 3_100; + +/// Cap on frames decoded for the animated preview (~3s at 30fps). Decoding +/// stops at whichever of this and the duration comes first. +pub const ANIMATED_PREVIEW_MAX_DECODED_FRAMES: usize = 96; + +/// Frame rate the animated preview is subsampled to. Half of the usual +/// 24fps keeps motion smooth at a third of the frames. +pub const ANIMATED_PREVIEW_TARGET_FPS: u32 = 12; + +/// Lossy WebP quality (0-100) for the animated preview. At 320px, 70 is +/// visually clean and ~10x smaller than lossless. +pub const ANIMATED_PREVIEW_QUALITY: f32 = 70.0; + +/// Bump when the thumbnail output changes (size, duration, quality, ...) so +/// the thumbnail worker regenerates cache entries made by older versions. +/// +/// History: +/// 1 - 512px jpg + ~1s lossless 320px webp (decoder truncated B-frame +/// streams to a few frames) +/// 2 - ~3s 12fps lossy-q70 webp; B-frame streams decode fully +pub const THUMBNAIL_GENERATOR_VERSION: i64 = 2; diff --git a/crates/lib/files/thumbnails/src/mp4_frames.rs b/crates/lib/files/thumbnails/src/mp4_frames.rs new file mode 100644 index 00000000..297c6d0f --- /dev/null +++ b/crates/lib/files/thumbnails/src/mp4_frames.rs @@ -0,0 +1,185 @@ +//! Decode the leading frames of an H.264 MP4 into RGB images. +//! +//! `mp4` demuxes the container; `openh264` (vendored Cisco decoder) decodes +//! the access units. Sample payloads are length-prefixed NAL units, so each +//! is rewritten to Annex-B (start codes) with the track's SPS/PPS fed first. + +use std::fs::File; +use std::io::BufReader; +use std::path::Path; + +use images::image::RgbImage; +use mp4::{MediaType, Mp4Reader, TrackType}; +use openh264::decoder::{Decoder, DecoderConfig, Flush}; +use openh264::OpenH264API; + +use crate::error::ThumbnailError; + +const ANNEX_B_START_CODE: [u8; 4] = [0, 0, 0, 1]; + +/// One decoded frame with its presentation time. +pub struct DecodedFrame { + pub pts_ms: u32, + pub image: RgbImage, +} + +/// Decode frames from the start of the file until `max_duration_ms` of +/// presentation time or `max_frames` frames, whichever comes first. Frames +/// are returned sorted by presentation time. +/// +/// Blocking CPU work — call from `spawn_blocking` in async contexts. +pub fn decode_mp4_leading_frames>( + path: P, + max_duration_ms: u32, + max_frames: usize, +) -> Result, ThumbnailError> { + let file = File::open(path.as_ref())?; + let size = file.metadata()?.len(); + let mut mp4 = Mp4Reader::read_header(BufReader::new(file), size) + .map_err(|err| ThumbnailError::Unsupported(format!("not a readable MP4: {}", err)))?; + + let (track_id, timescale, nal_length_size, sps, pps) = { + let track = mp4.tracks().values() + .find(|track| { + track.track_type().is_ok_and(|kind| kind == TrackType::Video) + && track.media_type().is_ok_and(|media| media == MediaType::H264) + }) + .ok_or_else(|| ThumbnailError::Unsupported("no H.264 video track".to_string()))?; + + let sps = track.sequence_parameter_set() + .map_err(|err| ThumbnailError::Unsupported(format!("missing SPS: {}", err)))? + .to_vec(); + let pps = track.picture_parameter_set() + .map_err(|err| ThumbnailError::Unsupported(format!("missing PPS: {}", err)))? + .to_vec(); + (track.track_id(), track.timescale(), nal_length_size_for(track), sps, pps) + }; + + // NB: openh264-rs flushes the decoder after every call by default, which + // wrecks B-frame reordering: streams with B-frames (every provider's + // High-profile output) start erroring a handful of samples in and never + // recover. Let the decoder keep its reorder buffer and drain it at the end. + let config = DecoderConfig::new().flush_after_decode(Flush::NoFlush); + let mut decoder = Decoder::with_api_config(OpenH264API::from_source(), config) + .map_err(|err| ThumbnailError::Decode(format!("could not create H.264 decoder: {}", err)))?; + + // Prime the decoder with the parameter sets. + let mut parameter_sets = Vec::with_capacity(sps.len() + pps.len() + 8); + append_annex_b(&mut parameter_sets, &sps); + append_annex_b(&mut parameter_sets, &pps); + let _ = decoder.decode(¶meter_sets); + + let mut frames: Vec = Vec::new(); + // Presentation times of every sample fed so far. The decoder emits frames + // in presentation order (that's what its reorder buffer is for), so the + // k-th output frame gets the k-th smallest pts fed — exact regardless of + // B-frame depth. + let mut fed_pts_ms: Vec = Vec::new(); + let sample_count = mp4.sample_count(track_id) + .map_err(|err| ThumbnailError::Decode(format!("could not count samples: {}", err)))?; + + for sample_id in 1..=sample_count { + if frames.len() >= max_frames { + break; + } + + let sample = match mp4.read_sample(track_id, sample_id) { + Ok(Some(sample)) => sample, + Ok(None) => break, + Err(err) => return Err(ThumbnailError::Decode(format!("could not read sample {}: {}", sample_id, err))), + }; + + // Presentation time: decode time + composition offset. + let pts_units = sample.start_time as i64 + sample.rendering_offset as i64; + let pts_ms = ((pts_units.max(0) as u128 * 1000) / timescale.max(1) as u128) as u32; + + let annex_b = length_prefixed_to_annex_b(&sample.bytes, nal_length_size)?; + let insert_at = fed_pts_ms.partition_point(|&fed| fed <= pts_ms); + fed_pts_ms.insert(insert_at, pts_ms); + + match decoder.decode(&annex_b) { + Ok(Some(yuv)) => { + let output_pts_ms = fed_pts_ms[frames.len()]; + frames.push(DecodedFrame { pts_ms: output_pts_ms, image: yuv_to_rgb(&yuv)? }); + } + Ok(None) => {} // Decoder delay; frame not ready yet. + Err(err) => { + // A corrupt tail sample shouldn't discard the frames we have. + log::warn!("H.264 decode error at sample {}: {}", sample_id, err); + break; + } + } + + // Samples arrive in decode order, so a B-frame with an earlier pts can + // follow the sample that crossed the limit; stop once the frames we + // actually have reach it. + if frames.last().is_some_and(|frame| frame.pts_ms >= max_duration_ms) { + break; + } + } + + // Frames still parked in the reorder buffer. + if frames.len() < max_frames { + match decoder.flush_remaining() { + Ok(remaining) => { + for yuv in remaining { + if frames.len() >= max_frames || frames.len() >= fed_pts_ms.len() { + break; + } + let output_pts_ms = fed_pts_ms[frames.len()]; + if output_pts_ms > max_duration_ms { + break; + } + frames.push(DecodedFrame { pts_ms: output_pts_ms, image: yuv_to_rgb(&yuv)? }); + } + } + Err(err) => log::warn!("H.264 flush error: {}", err), + } + } + + if frames.is_empty() { + return Err(ThumbnailError::Decode("no frames decoded".to_string())); + } + + frames.sort_by_key(|frame| frame.pts_ms); + Ok(frames) +} + +/// The avcC NAL length-prefix size (1, 2, or 4 bytes; 4 is ubiquitous). +fn nal_length_size_for(track: &mp4::Mp4Track) -> usize { + track.trak.mdia.minf.stbl.stsd.avc1.as_ref() + .map(|avc1| (avc1.avcc.length_size_minus_one as usize & 0b11) + 1) + .unwrap_or(4) +} + +fn length_prefixed_to_annex_b(sample_bytes: &[u8], length_size: usize) -> Result, ThumbnailError> { + let mut annex_b = Vec::with_capacity(sample_bytes.len() + 16); + let mut offset = 0usize; + while offset + length_size <= sample_bytes.len() { + let mut nal_length = 0usize; + for byte in &sample_bytes[offset..offset + length_size] { + nal_length = (nal_length << 8) | *byte as usize; + } + offset += length_size; + let end = offset.checked_add(nal_length) + .filter(|end| *end <= sample_bytes.len()) + .ok_or_else(|| ThumbnailError::Decode("NAL length overruns sample".to_string()))?; + append_annex_b(&mut annex_b, &sample_bytes[offset..end]); + offset = end; + } + Ok(annex_b) +} + +fn append_annex_b(buffer: &mut Vec, nal: &[u8]) { + buffer.extend_from_slice(&ANNEX_B_START_CODE); + buffer.extend_from_slice(nal); +} + +fn yuv_to_rgb(yuv: &openh264::decoder::DecodedYUV<'_>) -> Result { + use openh264::formats::YUVSource; + let (width, height) = yuv.dimensions(); + let mut rgb = vec![0u8; width * height * 3]; + yuv.write_rgb8(&mut rgb); + RgbImage::from_raw(width as u32, height as u32, rgb) + .ok_or_else(|| ThumbnailError::Decode("YUV → RGB buffer size mismatch".to_string())) +} diff --git a/crates/lib/files/thumbnails/src/video_thumbnail.rs b/crates/lib/files/thumbnails/src/video_thumbnail.rs new file mode 100644 index 00000000..2b0083cd --- /dev/null +++ b/crates/lib/files/thumbnails/src/video_thumbnail.rs @@ -0,0 +1,195 @@ +//! Video thumbnails: one decode pass over the leading ~3s produces both the +//! static first-frame JPEG and the animated WebP preview. + +use std::path::Path; + +use images::image::DynamicImage; +use webp_animation::{Encoder, EncoderOptions, EncodingConfig, EncodingType, LossyEncodingConfig}; + +use crate::error::ThumbnailError; +use crate::image_thumbnail::{downscale, write_bytes_atomically, write_jpeg}; +use crate::mp4_frames::{decode_mp4_leading_frames, DecodedFrame}; +use crate::{ + ANIMATED_PREVIEW_MAX_DECODED_FRAMES, ANIMATED_PREVIEW_MAX_DIMENSION, ANIMATED_PREVIEW_MAX_DURATION_MS, + ANIMATED_PREVIEW_QUALITY, ANIMATED_PREVIEW_TARGET_FPS, STATIC_THUMBNAIL_MAX_DIMENSION, +}; + +#[derive(Debug)] +pub struct VideoThumbnailOutcome { + pub wrote_static_thumbnail: bool, + pub wrote_animated_preview: bool, +} + +/// Decode the leading frames of `source` once; write the first frame as a +/// 512px JPEG and the whole ~3s run, subsampled to ~12fps, as a lossy 320px +/// animated WebP. +/// +/// The animated preview is best-effort: if its encode fails, the static +/// thumbnail still lands and the outcome reports the difference. +/// +/// Blocking CPU work — call from `spawn_blocking` in async contexts. +pub fn generate_video_thumbnails, Q: AsRef, R: AsRef>( + source: P, + destination_jpg: Q, + destination_webp: R, +) -> Result { + let frames = decode_mp4_leading_frames( + source.as_ref(), + ANIMATED_PREVIEW_MAX_DURATION_MS, + ANIMATED_PREVIEW_MAX_DECODED_FRAMES, + )?; + + let first_frame = DynamicImage::ImageRgb8(frames[0].image.clone()); + write_jpeg(&downscale(&first_frame, STATIC_THUMBNAIL_MAX_DIMENSION), destination_jpg.as_ref())?; + + let preview_frames = subsample_to_fps(&frames, ANIMATED_PREVIEW_TARGET_FPS); + let wrote_animated_preview = match encode_animated_webp(&preview_frames) { + Ok(webp_bytes) => { + write_bytes_atomically(&webp_bytes, destination_webp.as_ref())?; + true + } + Err(err) => { + log::warn!("Animated preview encode failed for {}: {}", source.as_ref().display(), err); + false + } + }; + + Ok(VideoThumbnailOutcome { wrote_static_thumbnail: true, wrote_animated_preview }) +} + +/// Keep roughly one frame per `1000 / target_fps` ms: the first frame at or +/// after each slot boundary. Frames must be sorted by pts. A source already +/// at or below the target rate passes through untouched. +fn subsample_to_fps(frames: &[DecodedFrame], target_fps: u32) -> Vec<&DecodedFrame> { + let slot_ms = 1000 / target_fps.max(1); + let mut picked = Vec::with_capacity(frames.len()); + let mut next_slot_ms = 0u32; + for frame in frames { + if frame.pts_ms >= next_slot_ms { + picked.push(frame); + // Advance to the slot after this frame, so a frame landing late in its + // slot doesn't also eat the next one. + next_slot_ms = (frame.pts_ms / slot_ms + 1) * slot_ms; + } + } + picked +} + +fn encode_animated_webp(frames: &[&DecodedFrame]) -> Result, ThumbnailError> { + let scaled: Vec<(u32, DynamicImage)> = frames.iter() + .map(|frame| { + let image = DynamicImage::ImageRgb8(frame.image.clone()); + (frame.pts_ms, downscale(&image, ANIMATED_PREVIEW_MAX_DIMENSION)) + }) + .collect(); + + let (width, height) = (scaled[0].1.width(), scaled[0].1.height()); + let options = EncoderOptions { + encoding_config: Some(EncodingConfig { + encoding_type: EncodingType::Lossy(LossyEncodingConfig::default()), + quality: ANIMATED_PREVIEW_QUALITY, + method: 4, + }), + ..Default::default() + }; + let mut encoder = Encoder::new_with_options((width, height), options) + .map_err(|err| ThumbnailError::Encode(format!("webp encoder: {}", err)))?; + + // Normalize timestamps so the preview starts at 0 even if the stream's + // first pts doesn't. + let first_pts = scaled[0].0; + let mut last_timestamp_ms: i32 = 0; + for (pts_ms, image) in &scaled { + last_timestamp_ms = pts_ms.saturating_sub(first_pts) as i32; + let rgba = image.to_rgba8(); + encoder.add_frame(rgba.as_raw(), last_timestamp_ms) + .map_err(|err| ThumbnailError::Encode(format!("webp frame: {}", err)))?; + } + + // Close the last frame with a plausible display duration. + let average_frame_ms = if scaled.len() > 1 { + (last_timestamp_ms / (scaled.len() as i32 - 1)).max(1) + } else { + 500 + }; + let webp_data = encoder.finalize(last_timestamp_ms + average_frame_ms) + .map_err(|err| ThumbnailError::Encode(format!("webp finalize: {}", err)))?; + Ok(webp_data.to_vec()) +} + +#[cfg(test)] +mod tests { + use super::*; + use images::image::RgbImage; + + // The 4-second, 12fps, B-frame (High profile) H.264 clip the + // higgsfield_client live tests upload. + const H264_FIXTURE: &str = concat!( + env!("CARGO_MANIFEST_DIR"), + "/../../../api_clients/higgsfield_client/test_assets/clip_4s.mp4", + ); + + #[test] + fn h264_mp4_produces_static_and_animated_thumbnails() { + let dir = tempfile::tempdir().unwrap(); + let jpg = dir.path().join("thumb.jpg"); + let webp = dir.path().join("preview.webp"); + + let outcome = generate_video_thumbnails(H264_FIXTURE, &jpg, &webp).unwrap(); + assert!(outcome.wrote_static_thumbnail); + assert!(outcome.wrote_animated_preview); + + let thumbnail = images::image::open(&jpg).unwrap(); + assert!(thumbnail.width() > 0 && thumbnail.height() > 0); + assert!(thumbnail.width() <= 512 && thumbnail.height() <= 512); + + let webp_bytes = std::fs::read(&webp).unwrap(); + assert!(webp_bytes.len() > 12); + assert_eq!(&webp_bytes[0..4], b"RIFF"); + assert_eq!(&webp_bytes[8..12], b"WEBP"); + // Lossy at 320px: a 3s preview stays well under half a megabyte. + assert!(webp_bytes.len() < 400 * 1024, "preview is {} bytes", webp_bytes.len()); + } + + #[test] + fn b_frame_stream_decodes_the_whole_preview_window() { + let frames = decode_mp4_leading_frames(H264_FIXTURE, ANIMATED_PREVIEW_MAX_DURATION_MS, ANIMATED_PREVIEW_MAX_DECODED_FRAMES).unwrap(); + // 12fps over ~3s; the old flush-per-decode setup stopped after a few + // frames on any B-frame stream. + assert!(frames.len() >= 35, "only {} frames decoded", frames.len()); + // Raw composition times (no edit-list shift), so the first pts is a + // couple of frames in, not exactly 0. + assert!(frames[0].pts_ms < 300, "first pts {}", frames[0].pts_ms); + assert!(frames.last().unwrap().pts_ms >= 2_900); + assert!(frames.windows(2).all(|pair| pair[0].pts_ms < pair[1].pts_ms), "pts must be strictly increasing"); + + // Already at the target rate: nothing dropped. + let preview = subsample_to_fps(&frames, ANIMATED_PREVIEW_TARGET_FPS); + assert_eq!(preview.len(), frames.len()); + } + + #[test] + fn subsampling_keeps_one_frame_per_slot() { + let frames: Vec = (0..24).map(|i| DecodedFrame { + pts_ms: i * 1000 / 24, + image: RgbImage::new(1, 1), + }).collect(); + let picked: Vec = subsample_to_fps(&frames, 12).iter().map(|f| f.pts_ms).collect(); + assert_eq!(picked, vec![0, 83, 166, 250, 333, 416, 500, 583, 666, 750, 833, 916]); + + // Already sparse input passes through. + let sparse: Vec = [0u32, 500, 1000].iter().map(|&pts_ms| DecodedFrame { pts_ms, image: RgbImage::new(1, 1) }).collect(); + assert_eq!(subsample_to_fps(&sparse, 12).len(), 3); + } + + #[test] + fn non_mp4_is_unsupported() { + let dir = tempfile::tempdir().unwrap(); + let source = dir.path().join("not_a_video.mp4"); + std::fs::write(&source, b"this is not an mp4 file at all").unwrap(); + let err = generate_video_thumbnails(&source, dir.path().join("t.jpg"), dir.path().join("p.webp")) + .unwrap_err(); + assert!(err.is_unsupported()); + } +} + diff --git a/crates/lib/http_headers/Cargo.toml b/crates/lib/http_headers/Cargo.toml new file mode 100644 index 00000000..669b0701 --- /dev/null +++ b/crates/lib/http_headers/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "http_headers" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +# NB: public `http_headers` crate appears to be abandoned, so this name seems fine. Wish we had namespacing, though. +name = "http_headers" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true + +# External +# (None yet) + +[dev-dependencies] +# (None yet) diff --git a/crates/lib/http_headers/src/lib.rs b/crates/lib/http_headers/src/lib.rs new file mode 100644 index 00000000..3a85c60c --- /dev/null +++ b/crates/lib/http_headers/src/lib.rs @@ -0,0 +1,23 @@ +//! http_headers +//! +//! The purpose of this library is to centralize the definition of common header names +//! and header values that are not already represented by common libraries. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod names; +pub mod values; \ No newline at end of file diff --git a/crates/lib/http_headers/src/names/mod.rs b/crates/lib/http_headers/src/names/mod.rs new file mode 100644 index 00000000..6f5b8ca8 --- /dev/null +++ b/crates/lib/http_headers/src/names/mod.rs @@ -0,0 +1,20 @@ + +/// `Priority` header name +/// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Priority +pub const PRIORITY: &str = "Priority"; + +/// `Sec-Fetch-Dest` header name +/// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Sec-Fetch-Dest +pub const SEC_FETCH_DEST : &str = "Sec-Fetch-Dest"; + +/// `Sec-Fetch-Mode` header name +/// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Sec-Fetch-Mode +pub const SEC_FETCH_MODE: &str = "Sec-Fetch-Mode"; + +/// `Sec-Fetch-Site` header name +/// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Sec-Fetch-Site +pub const SEC_FETCH_SITE : &str = "Sec-Fetch-Site"; + +/// `Sec-GPC` header name +/// https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Sec-GPC +pub const SEC_GPC : &str = "Sec-GPC"; diff --git a/crates/lib/http_headers/src/values/accept.rs b/crates/lib/http_headers/src/values/accept.rs new file mode 100644 index 00000000..c8ebae38 --- /dev/null +++ b/crates/lib/http_headers/src/values/accept.rs @@ -0,0 +1,2 @@ + +pub const ACCEPT_ALL : &str = "*/*"; diff --git a/crates/lib/http_headers/src/values/accept_encoding.rs b/crates/lib/http_headers/src/values/accept_encoding.rs new file mode 100644 index 00000000..a7783a0f --- /dev/null +++ b/crates/lib/http_headers/src/values/accept_encoding.rs @@ -0,0 +1,5 @@ + + +/// Accept-Encoding +/// Sent by Firefox for en-US on Mac +pub const ACCEPT_ENCODING_GZIP_ETC : &str = "gzip, deflate, br, zstd"; diff --git a/crates/lib/http_headers/src/values/accept_language.rs b/crates/lib/http_headers/src/values/accept_language.rs new file mode 100644 index 00000000..da1629ce --- /dev/null +++ b/crates/lib/http_headers/src/values/accept_language.rs @@ -0,0 +1,4 @@ + +/// Accept-Language +/// Sent by Firefox for en-US on Mac +pub const ACCEPT_LANGUAGE_EN_US: &str = "en-US,en;q=0.5"; diff --git a/crates/lib/http_headers/src/values/cache_control.rs b/crates/lib/http_headers/src/values/cache_control.rs new file mode 100644 index 00000000..dfd8e509 --- /dev/null +++ b/crates/lib/http_headers/src/values/cache_control.rs @@ -0,0 +1,3 @@ + +/// eg. -H 'Cache-Control: no-cache' +pub const CACHE_CONTROL_NO_CACHE: &str = "no-cache"; diff --git a/crates/lib/http_headers/src/values/connection.rs b/crates/lib/http_headers/src/values/connection.rs new file mode 100644 index 00000000..0ab994ab --- /dev/null +++ b/crates/lib/http_headers/src/values/connection.rs @@ -0,0 +1,2 @@ + +pub const CONNECTION_KEEP_ALIVE : &str = "keep-alive"; diff --git a/crates/lib/http_headers/src/values/content_type.rs b/crates/lib/http_headers/src/values/content_type.rs new file mode 100644 index 00000000..1753912c --- /dev/null +++ b/crates/lib/http_headers/src/values/content_type.rs @@ -0,0 +1,2 @@ + +pub const CONTENT_TYPE_APPLICATION_JSON: &str = "application/json"; diff --git a/crates/lib/http_headers/src/values/mod.rs b/crates/lib/http_headers/src/values/mod.rs new file mode 100644 index 00000000..1e789736 --- /dev/null +++ b/crates/lib/http_headers/src/values/mod.rs @@ -0,0 +1,10 @@ +pub mod accept; +pub mod accept_encoding; +pub mod accept_language; +pub mod cache_control; +pub mod connection; +pub mod content_type; +pub mod pragma; +pub mod priority; +pub mod sec; +pub mod te; diff --git a/crates/lib/http_headers/src/values/pragma.rs b/crates/lib/http_headers/src/values/pragma.rs new file mode 100644 index 00000000..28408e62 --- /dev/null +++ b/crates/lib/http_headers/src/values/pragma.rs @@ -0,0 +1,3 @@ + +/// eg. -H 'Pragma: no-cache' +pub const PRAGMA_NO_CACHE: &str = "no-cache"; \ No newline at end of file diff --git a/crates/lib/http_headers/src/values/priority.rs b/crates/lib/http_headers/src/values/priority.rs new file mode 100644 index 00000000..197c90cc --- /dev/null +++ b/crates/lib/http_headers/src/values/priority.rs @@ -0,0 +1,10 @@ +/// eg. -H 'Priority: u=0' +pub const PRIORITY_HIGHEST : &str = "u=0"; + +/// eg. -H 'Priority: u=4' +/// "The default priority value for requests is 3." +pub const PRIORITY_4: &str = "u=4"; + +/// eg. -H 'Priority: u=6' +/// "The default priority value for requests is 3." +pub const PRIORITY_6: &str = "u=6"; diff --git a/crates/lib/http_headers/src/values/sec.rs b/crates/lib/http_headers/src/values/sec.rs new file mode 100644 index 00000000..72bc5637 --- /dev/null +++ b/crates/lib/http_headers/src/values/sec.rs @@ -0,0 +1,9 @@ + +/// eg. -H 'Sec-Fetch-Dest: empty' +pub const SEC_FETCH_DEST_EMPTY : &str = "empty"; + +/// eg. -H 'Sec-Fetch-Mode: cors' +pub const SEC_FETCH_MODE_CORS : &str = "cors"; + +/// eg. -H 'Sec-Fetch-Site: cross-site' +pub const SEC_FETCH_SITE_CROSS_SITE : &str = "cross-site"; diff --git a/crates/lib/http_headers/src/values/te.rs b/crates/lib/http_headers/src/values/te.rs new file mode 100644 index 00000000..007c53f0 --- /dev/null +++ b/crates/lib/http_headers/src/values/te.rs @@ -0,0 +1,3 @@ + +/// eg. -H 'TE: trailers' +pub const TE_TRAILERS : &str = "trailers"; diff --git a/crates/lib/jwt_light/Cargo.toml b/crates/lib/jwt_light/Cargo.toml new file mode 100644 index 00000000..ae523f83 --- /dev/null +++ b/crates/lib/jwt_light/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "jwt_light" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "jwt_light" +path = "src/lib.rs" + +[dependencies] + +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +# (None) + +# External +base64.workspace = true +chrono.workspace = true +serde_json.workspace = true + +[dev-dependencies] +# (None) \ No newline at end of file diff --git a/crates/lib/jwt_light/src/common_claims.rs b/crates/lib/jwt_light/src/common_claims.rs new file mode 100644 index 00000000..a2caf3fd --- /dev/null +++ b/crates/lib/jwt_light/src/common_claims.rs @@ -0,0 +1,109 @@ +use crate::error::JwtError; +use crate::utils::json_number_to_datetime::json_number_to_datetime; +use chrono::{DateTime, Utc}; +use serde_json::Value; + +pub struct CommonClaims { + /// From the "iat" field + pub created: DateTime, + + /// From the "exp" field + pub expiration: DateTime, +} + +impl CommonClaims { + pub fn from_json(raw_json_claims: &str) -> Result { + let claims : serde_json::Map = serde_json::from_str(&raw_json_claims) + .map_err(|err| JwtError::CommonFieldError( + format!("failure to parse claims json: {:?}", err)))?; + + // NB: Some JWTs have "iat" and "exp" as integer numbers, some have them as floats + let iat = { + let iat = claims.get("iat") + .map(|val| val.as_number()) + .flatten() + .ok_or_else(|| JwtError::CommonFieldError("no iat claim".to_string()))?; + + json_number_to_datetime(iat, "iat")? + }; + + let exp = { + let exp = claims.get("exp") + .map(|val| val.as_number()) + .flatten() + .ok_or_else(|| JwtError::CommonFieldError("no exp claim".to_string()))?; + + json_number_to_datetime(exp, "exp")? + }; + + Ok(Self { + created: iat, + expiration: exp, + }) + } +} + +#[cfg(test)] +mod tests { + use crate::common_claims::CommonClaims; + use crate::utils::raw_jwt_to_raw_json::raw_jwt_to_raw_json; + use chrono::DateTime; + + #[test] + fn test_runwayml() { + let jwt = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjMxMjk0MDUsImVtYWlsIjoiZWNoZWxvbkBnbWFpbC5jb20iLCJleHAiOjE3NTAyMDEyNTYuNDksImlhdCI6MTc0NzYwOTI1Ni40OSwic3NvIjpmYWxzZX0.UxbJozIiHSApqI8_Vl7o2d7q7CzqpXIzsZoazCtY75s"; + + let json = raw_jwt_to_raw_json(jwt).unwrap(); + + let claims = CommonClaims::from_json(&json).unwrap(); + + // jwt payload: + // { + // "id": 23129405, + // "email": "echelon@gmail.com", + // "exp": 1750201256.49, + // "iat": 1747609256.49, + // "sso": false + // } + + assert_eq!(claims.created, DateTime::from_timestamp(1747609256, 0).unwrap()); + assert_eq!(claims.expiration, DateTime::from_timestamp(1750201256, 0).unwrap()); + } + + #[test] + fn test_sora() { + let token = + "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE5MzQ0ZTY1LWJiYzktNDRkMS1hOWQwLWY5NTdiMDc5YmQwZSIsInR5cCI6Ik\ + pXVCJ9.eyJhdWQiOlsiaHR0cHM6Ly9hcGkub3BlbmFpLmNvbS92MSJdLCJjbGllbnRfaWQiOiJhcHBfTTFuUTN0UjV2\ + VzdYOWpMMnBFNmdIOGRLNCIsImV4cCI6MTc0NTgwMDQ3MiwiaHR0cHM6Ly9hcGkub3BlbmFpLmNvbS9hdXRoIjp7InV\ + zZXJfaWQiOiJ1c2VyLTZOeEpmbEFIb0VCREp6Wmw5aVhocWJERyJ9LCJodHRwczovL2FwaS5vcGVuYWkuY29tL3Byb2\ + ZpbGUiOnsiZW1haWwiOiJ2b2NvZGVzMjAyMEBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZX0sImlhdCI6M\ + Tc0NDkzNjQ3MSwiaXNzIjoiaHR0cHM6Ly9hdXRoLm9wZW5haS5jb20iLCJqdGkiOiI0NTZmZjY5Yi0xZTZhLTQzOWYt\ + YTYzMC1jNmFjYzI3NzU1YjAiLCJuYmYiOjE3NDQ5MzY0NzEsInB3ZF9hdXRoX3RpbWUiOjE3NDQwNTkzMTc3NTAsInN\ + jcCI6WyJvcGVuaWQiLCJlbWFpbCIsInByb2ZpbGUiLCJvZmZsaW5lX2FjY2VzcyJdLCJzZXNzaW9uX2lkIjoiYXV0aH\ + Nlc3NfcEE4UGl3V0trNmJsSE1qQnVCQnVSRmh2Iiwic3ViIjoiZ29vZ2xlLW9hdXRoMnwxMTMxMDE5Njc2MTIzOTY3O\ + TM3NzcifQ.JOxYfrQSIsHdf-VN1zcOqDOS3tF1HpUYnRVfPKgi65am3sNiniOM1kWTNrKE5-sh4DaZ33G_XniGkhg-9\ + QKF8tspXpZ6BnTNkf-QdGqR_v89AIO8pZgQ7oECLXhnmg-31G-LAHlGfwWedJ6qPVy4dL5zoR0wVyoQ8gYv5QzQC-zd\ + IF7uY-umKKloAAYP_tkKLlQHackjTynN-bpu2mKv55-h7a3hSEPfxvgX0SsvL69xtNsZkwb43bqyP1x_c2ErfYoPyzg\ + rqgMIRZjCw9TI33vISKM_BfQXBiZT_BHkX4s0Jng3ph4vrwvnBsa0HpNxBhQYKb1u9gZXs7XjLZhjZJZsDTQI1V4Wov\ + iAL7ihvZkLxJRtDCOmX7-5BTEsMInFgXUAhCDhQUMwSfLLJuinBS96NGSX5_TfIVMkbCl-HWzdQx7KZAsahNe_CmuYT\ + lZH32NuRn78ohY4eViRyfC8OXVLwoLxxpen2CWlV2dxV5wwXeij_kHt5wOXSGYpSfxz37cK0CaK8K2pwudasxQ0lv2V\ + _Xx_z4UaEOr5wqT_BK1A1HO4HRjvFX2soF-qm4GCSWAbmFZs7DVEClrotxRx2romifRVb8XRia2M6YTmDyIT0YphFgG\ + nnrDIZNKO23uDYT60LVMVYpCCY2RiwxCR9bn7AeGbmi7cpL9aYZ5uJRM"; + + let json = raw_jwt_to_raw_json(token).unwrap(); + + // jwt payload : + // - "https://api.openai.com/auth".user_id = "user-6NxJflAHoEBDJzZl9iXhqbDG" + // - "https://api.openai.com/profile".email = "vocodes2020@gmail.com" + // - "https://api.openai.com/profile".email_verified = true + // - "iat": 1744936471, - issued at claim (5 days ago) + // - "nbf": 1744936471, - not before, don't use before date + // - "exp": 1745800472, - in 5 days, expiry + + let claims = CommonClaims::from_json(&json).unwrap(); + + assert_eq!(claims.created, DateTime::from_timestamp(1744936471, 0).unwrap()); + assert_eq!(claims.expiration, DateTime::from_timestamp(1745800472, 0).unwrap()); + } +} diff --git a/crates/lib/jwt_light/src/error.rs b/crates/lib/jwt_light/src/error.rs new file mode 100644 index 00000000..6c89ffea --- /dev/null +++ b/crates/lib/jwt_light/src/error.rs @@ -0,0 +1,51 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum JwtError { + /// Generic error parsing the JWT + ParseError(String), + /// Error parsing the JWT JSON payload specifically + JsonParseError(serde_json::Error), + /// Error decoding the base64 payload + Base64DecodeError(base64::DecodeError), + /// Error decoding from UTF-8 (should be exceedingly rare) + Utf8Error(std::string::FromUtf8Error), + /// Error parsing a common field (iat, exp, etc.) + CommonFieldError(String), + /// Error parsing a custom claims field. + CustomClaimsFieldError(String), +} + +impl Error for JwtError {} + +impl Display for JwtError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::ParseError(reason) => { write!(f, "JwtError::ParseError : {}", reason) } + Self::JsonParseError(err) => { write!(f, "JwtError::JsonParseError : {:?}", err) } + Self::Base64DecodeError(err) => { write!(f, "JwtError::Base64DecodeError : {:?}", err) } + Self::Utf8Error(err) => { write!(f, "JwtError::Utf8Error : {:?}", err) } + Self::CommonFieldError(reason) => { write!(f, "JwtError::CommonFieldError : {}", reason) } + Self::CustomClaimsFieldError(reason) => { write!(f, "JwtError::CustomClaimsFieldError : {}", reason) } + } + } +} + +impl From for JwtError { + fn from(err: serde_json::Error) -> Self { + JwtError::JsonParseError(err) + } +} + +impl From for JwtError { + fn from(err: base64::DecodeError) -> Self { + JwtError::Base64DecodeError(err) + } +} + +impl From for JwtError { + fn from(err: std::string::FromUtf8Error) -> Self { + JwtError::Utf8Error(err) + } +} diff --git a/crates/lib/jwt_light/src/lib.rs b/crates/lib/jwt_light/src/lib.rs new file mode 100644 index 00000000..65cc31ec --- /dev/null +++ b/crates/lib/jwt_light/src/lib.rs @@ -0,0 +1,12 @@ +//! Lightweight JWT library for Rust. +//! No cryptographic verification, no OpenSSL, etc. +//! +//! DO NOT USE THIS FOR OUR OWN JWT VERIFICATION !!! +//! It's okay to parse external vendors since we're not validating, but +//! do not ever use this to secure our own server. + +pub (crate) mod utils; + +pub mod common_claims; +pub mod error; +pub mod parse_jwt_claims_trait; diff --git a/crates/lib/jwt_light/src/parse_jwt_claims_trait.rs b/crates/lib/jwt_light/src/parse_jwt_claims_trait.rs new file mode 100644 index 00000000..ee71dbba --- /dev/null +++ b/crates/lib/jwt_light/src/parse_jwt_claims_trait.rs @@ -0,0 +1,27 @@ +use crate::common_claims::CommonClaims; +use crate::error::JwtError; +use crate::utils::decode_base64::decode_base64; +use crate::utils::split_components::split_components; +use serde_json::Value; + +/// Trait for simple JWT claims parsing +pub trait ParseJwtClaims : Sized { + /// Parse any special fields relevant to the struct + /// Implement this method to complete the parsing. + fn extract_claims( + common_claims: CommonClaims, + extra_claims: serde_json::Map, + ) -> Result; + + fn parse_claims(raw_jwt: &str) -> Result { + let [_header_str, claims_str, _signature_str] = split_components(raw_jwt)?; + + let raw_json = decode_base64(claims_str)?; + + let common_claims = CommonClaims::from_json(&raw_json)?; + + let extra_claims : serde_json::Map = serde_json::from_str(&raw_json)?; + + Self::extract_claims(common_claims, extra_claims) + } +} diff --git a/crates/lib/jwt_light/src/utils/decode_base64.rs b/crates/lib/jwt_light/src/utils/decode_base64.rs new file mode 100644 index 00000000..50e5958b --- /dev/null +++ b/crates/lib/jwt_light/src/utils/decode_base64.rs @@ -0,0 +1,9 @@ +use crate::error::JwtError; +use base64::prelude::BASE64_URL_SAFE_NO_PAD; +use base64::Engine; + +pub fn decode_base64(raw: &str) -> Result { + let json_bytes = BASE64_URL_SAFE_NO_PAD.decode(raw)?; + let json_str = String::from_utf8(json_bytes.clone())?; + Ok(json_str) +} diff --git a/crates/lib/jwt_light/src/utils/json_number_to_datetime.rs b/crates/lib/jwt_light/src/utils/json_number_to_datetime.rs new file mode 100644 index 00000000..47be8ca5 --- /dev/null +++ b/crates/lib/jwt_light/src/utils/json_number_to_datetime.rs @@ -0,0 +1,30 @@ +use crate::error::JwtError; +use chrono::{DateTime, Utc}; +use serde_json::Number; + +// NB: Some JWTs have "iat" and "exp" as integer numbers, some have them as floats +pub (crate) fn json_number_to_datetime(timestamp: &Number, field_name: &str) -> Result, JwtError> { + let result; + + if timestamp.is_i64() { + // Integer case + let timestamp = timestamp.as_i64() + .ok_or_else(|| JwtError::CommonFieldError(format!("{} is not an integer", field_name)))?; + + result = DateTime::from_timestamp(timestamp, 0) + .ok_or_else(|| JwtError::CommonFieldError(format!("{} is not a valid timestamp", field_name)))?; + } else if timestamp.is_f64() { + // Float case + let timestamp = timestamp.as_f64() + .ok_or_else(|| JwtError::CommonFieldError(format!("{} is not an integer", field_name)))?; + + let timestamp = timestamp.round() as i64; + + result = DateTime::from_timestamp(timestamp, 0) + .ok_or_else(|| JwtError::CommonFieldError(format!("{} is not a valid timestamp", field_name)))?; + } else { + return Err(JwtError::CommonFieldError(format!("{} is not a number", field_name))); + } + + Ok(result) +} diff --git a/crates/lib/jwt_light/src/utils/mod.rs b/crates/lib/jwt_light/src/utils/mod.rs new file mode 100644 index 00000000..17fa7884 --- /dev/null +++ b/crates/lib/jwt_light/src/utils/mod.rs @@ -0,0 +1,4 @@ +pub (crate) mod decode_base64; +pub (crate) mod json_number_to_datetime; +pub (crate) mod raw_jwt_to_raw_json; +pub (crate) mod split_components; \ No newline at end of file diff --git a/crates/lib/jwt_light/src/utils/raw_jwt_to_raw_json.rs b/crates/lib/jwt_light/src/utils/raw_jwt_to_raw_json.rs new file mode 100644 index 00000000..7189cf7b --- /dev/null +++ b/crates/lib/jwt_light/src/utils/raw_jwt_to_raw_json.rs @@ -0,0 +1,9 @@ +use crate::error::JwtError; +use crate::utils::decode_base64::decode_base64; +use crate::utils::split_components::split_components; + +pub (crate) fn raw_jwt_to_raw_json(raw_jwt: &str) -> Result { + let [_header_str, claims_str, _signature_str] = split_components(raw_jwt)?; + let raw_json = decode_base64(claims_str)?; + Ok(raw_json) +} diff --git a/crates/lib/jwt_light/src/utils/split_components.rs b/crates/lib/jwt_light/src/utils/split_components.rs new file mode 100644 index 00000000..321fb4a4 --- /dev/null +++ b/crates/lib/jwt_light/src/utils/split_components.rs @@ -0,0 +1,25 @@ +use crate::error::JwtError; + +const SEPARATOR: &str = "."; + +pub fn split_components(token: &str) -> Result<[&str; 3], JwtError> { + let mut components = token.split(SEPARATOR); + let header = components.next() + .ok_or_else(|| jwt_error("no header component"))?; + + let claims = components.next() + .ok_or_else(|| jwt_error("no claims component"))?; + + let signature = components.next() + .ok_or_else(|| jwt_error("no signature component"))?; + + if components.next().is_some() { + return Err(jwt_error("too many components")); + } + + Ok([header, claims, signature]) +} + +fn jwt_error(reason: &str) -> JwtError { + JwtError::ParseError(reason.to_string()) +} diff --git a/crates/lib/url_utils/Cargo.toml b/crates/lib/url_utils/Cargo.toml new file mode 100644 index 00000000..5ba520e7 --- /dev/null +++ b/crates/lib/url_utils/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "url_utils" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "url_utils" +path = "src/lib.rs" + +[dependencies] + +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +# NB: DO NOT ALLOW ANY OTHER DEPS - THIS IS URL LOGIC ONLY +# (None) + +# External +# NB: DO NOT ALLOW ANY OTHER DEPS - THIS IS URL LOGIC ONLY +url.workspace = true + +[dev-dependencies] +# (None) diff --git a/crates/lib/url_utils/src/download_extension/download_extension.rs b/crates/lib/url_utils/src/download_extension/download_extension.rs new file mode 100644 index 00000000..4193b074 --- /dev/null +++ b/crates/lib/url_utils/src/download_extension/download_extension.rs @@ -0,0 +1,72 @@ + +/// When downloading a remote file, it makes sense to try to match the same file extension (with reasonable safeguards). +#[deprecated(note = "Use `Extension` in `url_utils::extension::extension` instead")] +#[derive(Debug, Copy, Clone, Eq, PartialEq)] +pub enum DownloadExtension { + // Image + Jpg, + Png, + // Video + Mp4, + Webm, + // Audio + Mp3, + Wav, + // Text + Json, + Txt, +} + +impl DownloadExtension { + pub fn as_extension_without_period(&self) -> &'static str { + match self { + // Image + Self::Jpg => "jpg", + Self::Png => "png", + // Video + Self::Mp4 => "mp4", + Self::Webm => "webm", + // Audio + Self::Mp3 => "mp3", + Self::Wav => "wav", + // Text + Self::Json => "json", + Self::Txt => "txt", + } + } + + pub fn as_extension_with_period(&self) -> &'static str { + match self { + // Image + Self::Jpg => ".jpg", + Self::Png => ".png", + // Video + Self::Mp4 => ".mp4", + Self::Webm => ".webm", + // Audio + Self::Mp3 => ".mp3", + Self::Wav => ".wav", + // Text + Self::Json => ".json", + Self::Txt => ".txt", + } + } + + pub fn try_from_str(extension: &str) -> Option { + match extension.to_lowercase().as_str() { + // Image + "jpg" | "jpeg" => Some(Self::Jpg), + "png" => Some(Self::Png), + // Video + "mp4" => Some(Self::Mp4), + "webm" => Some(Self::Webm), + // Audio + "mp3" => Some(Self::Mp3), + "wav" => Some(Self::Wav), + // Text + "json" => Some(Self::Json), + "txt" => Some(Self::Txt), + _ => None, + } + } +} diff --git a/crates/lib/url_utils/src/download_extension/extract_download_extension_from_url.rs b/crates/lib/url_utils/src/download_extension/extract_download_extension_from_url.rs new file mode 100644 index 00000000..1d0c1b64 --- /dev/null +++ b/crates/lib/url_utils/src/download_extension/extract_download_extension_from_url.rs @@ -0,0 +1,39 @@ +use crate::download_extension::DownloadExtension; +use url::Url; + +/// This should be used for naming files on the local file system based on their URL. +#[deprecated(note = "Use `extract_extension_from_url_str` in `url_utils::extension::extract_extension_from_url` instead")] +pub fn extract_download_extension_from_url_str(url: &str) -> Option { + let parsed_url = Url::parse(url).ok()?; + extract_download_extension_from_url(&parsed_url) +} + +/// This should be used for naming files on the local file system based on their URL. +#[deprecated(note = "Use `extract_extension_from_url` in `url_utils::extension::extract_extension_from_url` instead")] +pub fn extract_download_extension_from_url(url: &Url) -> Option { + let path = url.path(); + let extension = std::path::Path::new(path) + .extension() + .and_then(|ext| ext.to_str())?; + DownloadExtension::try_from_str(extension) +} + +#[cfg(test)] +mod tests { + use crate::download_extension::DownloadExtension; + use crate::download_extension::extract_download_extension_from_url::extract_download_extension_from_url_str; + + #[test] + fn success_case() { + let url = "https://storyteller.ai/example.jpg"; + let maybe_extension= extract_download_extension_from_url_str(url); + assert_eq!(maybe_extension, Some(DownloadExtension::Jpg)); + } + + #[test] + fn difficult_url() { + let url = "https://videos.youtube.com/foo/bar/files/00000000-f19a-1275-a092-caa60b38f8d2%2Fraw?se=2025-11-21T22%3A26%3A53Z&sp=r&sv=2024-08-09&sr=b&skoid=8cfff87a-01fc-27c1-9091-32999dcd1389&sktid=aa8ccaf6-e6da-484e-ab11-9c7496c21c53&skt=2025-11-17T21%3A09%3A08Z&ske=2025-10-23T21%3A14%3A08Z&sks=b&skv=2024-08-04&sig=T2U6%2Brw9WJdJagBkCL4/GlFr72KhZGP3QPlobIO7JlU%3D&ac=oaisdsorprnorthcentralus"; + let maybe_extension= extract_download_extension_from_url_str(url); + assert!(maybe_extension.is_none()); + } +} diff --git a/crates/lib/url_utils/src/download_extension/mod.rs b/crates/lib/url_utils/src/download_extension/mod.rs new file mode 100644 index 00000000..3706f2dd --- /dev/null +++ b/crates/lib/url_utils/src/download_extension/mod.rs @@ -0,0 +1,4 @@ +mod download_extension; +pub mod extract_download_extension_from_url; + +pub use download_extension::DownloadExtension; diff --git a/crates/lib/url_utils/src/extension/extension.rs b/crates/lib/url_utils/src/extension/extension.rs new file mode 100644 index 00000000..a92df6d4 --- /dev/null +++ b/crates/lib/url_utils/src/extension/extension.rs @@ -0,0 +1,146 @@ +use std::borrow::Cow; +use std::fmt; + +/// A file extension that can be either a compile-time constant or a runtime-parsed value. +/// +/// ``` +/// use url_utils::extension::extension::Extension; +/// +/// // Static constants (no allocation) +/// const PNG: Extension = Extension::from_static("png", ".png"); +/// assert_eq!(PNG.without_period(), "png"); +/// assert_eq!(PNG.with_period(), ".png"); +/// +/// // Runtime parsing (allocates only if needed) +/// let ext = Extension::new("mp4"); +/// assert_eq!(ext.without_period(), "mp4"); +/// assert_eq!(ext.with_period(), ".mp4"); +/// ``` +#[derive(Clone, Eq, Hash)] +pub struct Extension { + /// The extension without the leading period, e.g. "png", "mp4". + value: Cow<'static, str>, + + /// The extension with the leading period, e.g. ".png", ".mp4". + dotted: Cow<'static, str>, +} + +impl Extension { + /// Creates an `Extension` from static strings at compile time. + /// Pass both the bare extension and the dotted form. + /// + /// ``` + /// use url_utils::extension::extension::Extension; + /// const MP4: Extension = Extension::from_static("mp4", ".mp4"); + /// ``` + pub const fn from_static(ext: &'static str, dotted: &'static str) -> Self { + Self { + value: Cow::Borrowed(ext), + dotted: Cow::Borrowed(dotted), + } + } + + /// Creates an `Extension` from a `&str` at runtime. + /// The input must NOT include a leading period. + pub fn new(ext: &str) -> Self { + let dotted = format!(".{}", ext); + Self { + value: Cow::Owned(ext.to_string()), + dotted: Cow::Owned(dotted), + } + } + + /// Returns the extension without the leading period, e.g. `"png"`. + pub fn without_period(&self) -> &str { + &self.value + } + + /// Returns the extension with the leading period, e.g. `".png"`. + pub fn with_period(&self) -> &str { + &self.dotted + } +} + +impl PartialEq for Extension { + fn eq(&self, other: &Self) -> bool { + self.value == other.value + } +} + +impl fmt::Debug for Extension { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "Extension(\"{}\")", self.value) + } +} + +impl fmt::Display for Extension { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", self.value) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const PNG: Extension = Extension::from_static("png", ".png"); + const MP4: Extension = Extension::from_static("mp4", ".mp4"); + const MP3: Extension = Extension::from_static("mp3", ".mp3"); + + #[test] + fn static_without_period() { + assert_eq!(PNG.without_period(), "png"); + assert_eq!(MP4.without_period(), "mp4"); + assert_eq!(MP3.without_period(), "mp3"); + } + + #[test] + fn static_with_period() { + assert_eq!(PNG.with_period(), ".png"); + assert_eq!(MP4.with_period(), ".mp4"); + assert_eq!(MP3.with_period(), ".mp3"); + } + + #[test] + fn runtime_without_period() { + let ext = Extension::new("webm"); + assert_eq!(ext.without_period(), "webm"); + } + + #[test] + fn runtime_with_period() { + let ext = Extension::new("webm"); + assert_eq!(ext.with_period(), ".webm"); + } + + #[test] + fn unknown_extension() { + let ext = Extension::new("foobar"); + assert_eq!(ext.without_period(), "foobar"); + assert_eq!(ext.with_period(), ".foobar"); + } + + #[test] + fn equality() { + let a = Extension::new("png"); + assert_eq!(a, PNG); + } + + #[test] + fn clone() { + let a = Extension::new("wav"); + let b = a.clone(); + assert_eq!(a, b); + } + + #[test] + fn display() { + assert_eq!(format!("{}", PNG), "png"); + assert_eq!(format!("{}", Extension::new("xyz")), "xyz"); + } + + #[test] + fn debug() { + assert_eq!(format!("{:?}", PNG), "Extension(\"png\")"); + } +} diff --git a/crates/lib/url_utils/src/extension/extract_extension_from_url.rs b/crates/lib/url_utils/src/extension/extract_extension_from_url.rs new file mode 100644 index 00000000..928aa583 --- /dev/null +++ b/crates/lib/url_utils/src/extension/extract_extension_from_url.rs @@ -0,0 +1,244 @@ +use std::collections::HashSet; + +use crate::extension::extension::Extension; +use url::Url; + +// TODO: Lookups against these as lists will be slow + +/// Known image extensions. +const KNOWN_IMAGE_EXTENSIONS: &[Extension] = &[ + Extension::from_static("png", ".png"), + Extension::from_static("jpg", ".jpg"), + Extension::from_static("jpeg", ".jpeg"), + Extension::from_static("webp", ".webp"), +]; + +/// Known audio extensions. +const KNOWN_AUDIO_EXTENSIONS: &[Extension] = &[ + Extension::from_static("wav", ".wav"), + Extension::from_static("mp3", ".mp3"), +]; + +/// Known video extensions. +const KNOWN_VIDEO_EXTENSIONS: &[Extension] = &[ + Extension::from_static("mp4", ".mp4"), + Extension::from_static("webm", ".webm"), +]; + +/// Controls which extensions are accepted when extracting from a URL. +pub enum ExtractExtensions { + /// Accept any extension-like string found in the URL path. + All, + + /// Accept only extensions that appear in the given set. + Set(HashSet), + + /// Accept only known image extensions (png, jpg, jpeg, webp). + KnownImage, + + /// Accept only known audio extensions (wav, mp3). + KnownAudio, + + /// Accept only known video extensions (mp4, webm). + KnownVideo, + + /// Accept any known media extension (image, audio, or video). + KnownMedia, +} + +impl ExtractExtensions { + /// Creates a `Set` variant from a `Vec`. + pub fn from_vec(extensions: Vec) -> Self { + Self::Set(extensions.into_iter().collect()) + } +} + +/// Extracts a file extension from a URL string, filtered by `accept`. +pub fn extract_extension_from_url_str(url: &str, accept: &ExtractExtensions) -> Option { + let parsed_url = Url::parse(url).ok()?; + extract_extension_from_url(&parsed_url, accept) +} + +/// Extracts a file extension from a parsed `Url`, filtered by `accept`. +pub fn extract_extension_from_url(url: &Url, accept: &ExtractExtensions) -> Option { + let path = url.path(); + let raw_ext = std::path::Path::new(path) + .extension() + .and_then(|ext| ext.to_str())?; + + let lower = raw_ext.to_lowercase(); + let candidate = Extension::new(&lower); + + match accept { + ExtractExtensions::All => Some(candidate), + ExtractExtensions::Set(set) => { + if set.contains(&candidate) { Some(candidate) } else { None } + } + ExtractExtensions::KnownImage => { + if slice_contains(KNOWN_IMAGE_EXTENSIONS, &candidate) { Some(candidate) } else { None } + } + ExtractExtensions::KnownAudio => { + if slice_contains(KNOWN_AUDIO_EXTENSIONS, &candidate) { Some(candidate) } else { None } + } + ExtractExtensions::KnownVideo => { + if slice_contains(KNOWN_VIDEO_EXTENSIONS, &candidate) { Some(candidate) } else { None } + } + ExtractExtensions::KnownMedia => { + if slice_contains(KNOWN_IMAGE_EXTENSIONS, &candidate) + || slice_contains(KNOWN_AUDIO_EXTENSIONS, &candidate) + || slice_contains(KNOWN_VIDEO_EXTENSIONS, &candidate) + { + Some(candidate) + } else { + None + } + } + } +} + +fn slice_contains(extensions: &[Extension], candidate: &Extension) -> bool { + extensions.iter().any(|e| e == candidate) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn all_extracts_any_extension() { + let ext = extract_extension_from_url_str("https://example.com/file.png", &ExtractExtensions::All); + assert_eq!(ext.unwrap().without_period(), "png"); + } + + #[test] + fn all_extracts_unknown_extension() { + let ext = extract_extension_from_url_str("https://example.com/file.foobar", &ExtractExtensions::All); + assert_eq!(ext.unwrap().without_period(), "foobar"); + } + + #[test] + fn all_extracts_unknown_extension_all_caps() { + let ext = extract_extension_from_url_str("https://example.com/file.FOOBAR", &ExtractExtensions::All); + assert_eq!(ext.unwrap().without_period(), "foobar"); + } + + #[test] + fn all_lowercases() { + let ext = extract_extension_from_url_str("https://example.com/file.PNG", &ExtractExtensions::All); + assert_eq!(ext.unwrap().without_period(), "png"); + } + + #[test] + fn known_image_matches_png() { + let ext = extract_extension_from_url_str("https://example.com/photo.png", &ExtractExtensions::KnownImage); + assert_eq!(ext.unwrap().without_period(), "png"); + } + + #[test] + fn known_image_rejects_mp4() { + let ext = extract_extension_from_url_str("https://example.com/video.mp4", &ExtractExtensions::KnownImage); + assert!(ext.is_none()); + } + + #[test] + fn known_audio_matches_wav() { + let ext = extract_extension_from_url_str("https://example.com/sound.wav", &ExtractExtensions::KnownAudio); + assert_eq!(ext.unwrap().without_period(), "wav"); + } + + #[test] + fn known_audio_rejects_png() { + let ext = extract_extension_from_url_str("https://example.com/photo.png", &ExtractExtensions::KnownAudio); + assert!(ext.is_none()); + } + + #[test] + fn known_video_matches_mp4() { + let ext = extract_extension_from_url_str("https://example.com/clip.mp4", &ExtractExtensions::KnownVideo); + assert_eq!(ext.unwrap().without_period(), "mp4"); + } + + #[test] + fn known_video_rejects_mp3() { + let ext = extract_extension_from_url_str("https://example.com/song.mp3", &ExtractExtensions::KnownVideo); + assert!(ext.is_none()); + } + + #[test] + fn known_media_matches_image() { + let ext = extract_extension_from_url_str("https://example.com/photo.jpg", &ExtractExtensions::KnownMedia); + assert_eq!(ext.unwrap().without_period(), "jpg"); + } + + #[test] + fn known_media_matches_audio() { + let ext = extract_extension_from_url_str("https://example.com/song.mp3", &ExtractExtensions::KnownMedia); + assert_eq!(ext.unwrap().without_period(), "mp3"); + } + + #[test] + fn known_media_matches_video() { + let ext = extract_extension_from_url_str("https://example.com/clip.webm", &ExtractExtensions::KnownMedia); + assert_eq!(ext.unwrap().without_period(), "webm"); + } + + #[test] + fn known_media_rejects_unknown() { + let ext = extract_extension_from_url_str("https://example.com/data.xyz", &ExtractExtensions::KnownMedia); + assert!(ext.is_none()); + } + + #[test] + fn set_matches_custom_list() { + let accept = ExtractExtensions::from_vec(vec![ + Extension::from_static("csv", ".csv"), + Extension::from_static("tsv", ".tsv"), + ]); + let ext = extract_extension_from_url_str("https://example.com/data.csv", &accept); + assert_eq!(ext.unwrap().without_period(), "csv"); + } + + #[test] + fn set_rejects_non_member() { + let accept = ExtractExtensions::from_vec(vec![ + Extension::from_static("csv", ".csv"), + ]); + let ext = extract_extension_from_url_str("https://example.com/data.png", &accept); + assert!(ext.is_none()); + } + + #[test] + fn no_extension_returns_none() { + let ext = extract_extension_from_url_str("https://example.com/file", &ExtractExtensions::All); + assert!(ext.is_none()); + } + + #[test] + fn query_params_ignored() { + let ext = extract_extension_from_url_str( + "https://example.com/file.mp4?token=abc&format=hd", + &ExtractExtensions::KnownVideo, + ); + assert_eq!(ext.unwrap().without_period(), "mp4"); + } + + #[test] + fn difficult_url_returns_none() { + let url = "https://videos.youtube.com/foo/bar/files/00000000-f19a-1275-a092-caa60b38f8d2%2Fraw?se=2025-11-21T22%3A26%3A53Z&sp=r&sv=2024-08-09&sr=b"; + let ext = extract_extension_from_url_str(url, &ExtractExtensions::All); + assert!(ext.is_none()); + } + + fn extract_extension_all(url: &str) -> Option { + extract_extension_from_url_str(url, &ExtractExtensions::All) + .map(|ext| ext.without_period().to_string()) + } + + #[test] + fn test_extract_various_extensions() { + assert_eq!(extract_extension_all("https://example.com/image.png").as_deref(), Some("png")); + assert_eq!(extract_extension_all("https://example.com/video.mp4?token=abc").as_deref(), Some("mp4")); + assert_eq!(extract_extension_all("https://example.com/path/to/file.jpg").as_deref(), Some("jpg")); + assert_eq!(extract_extension_all("https://example.com/noext"), None); + } +} diff --git a/crates/lib/url_utils/src/extension/mod.rs b/crates/lib/url_utils/src/extension/mod.rs new file mode 100644 index 00000000..824c6d22 --- /dev/null +++ b/crates/lib/url_utils/src/extension/mod.rs @@ -0,0 +1,2 @@ +pub mod extension; +pub mod extract_extension_from_url; \ No newline at end of file diff --git a/crates/lib/url_utils/src/lib.rs b/crates/lib/url_utils/src/lib.rs new file mode 100644 index 00000000..2f3ba5d0 --- /dev/null +++ b/crates/lib/url_utils/src/lib.rs @@ -0,0 +1,2 @@ +pub mod extension; +pub mod download_extension; \ No newline at end of file diff --git a/crates/lib/uuid_utils/Cargo.toml b/crates/lib/uuid_utils/Cargo.toml new file mode 100644 index 00000000..5dcf6a78 --- /dev/null +++ b/crates/lib/uuid_utils/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "uuid_utils" +edition = "2018" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +name = "uuid_utils" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] +# Internal +# errors = { path = "../../lib/errors" } +# (None yet) + +# Workspace hack (faster compile times) +workspace-build-acceleration = { version = "0.1", path = "../../workspace-build-acceleration" } + +# External +uuid = { version = "1.8.0", features = ["v4"] } + +[dev-dependencies] +# None yet +# (None yet) diff --git a/crates/lib/uuid_utils/src/lib.rs b/crates/lib/uuid_utils/src/lib.rs new file mode 100644 index 00000000..b9ad7ad8 --- /dev/null +++ b/crates/lib/uuid_utils/src/lib.rs @@ -0,0 +1,22 @@ +//! idempotency +//! +//! The purpose of this library is to hold tools for generating idempotency tokens, +//! making requests retryable, etc. +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod uuid; diff --git a/crates/lib/uuid_utils/src/uuid.rs b/crates/lib/uuid_utils/src/uuid.rs new file mode 100644 index 00000000..8ece4abf --- /dev/null +++ b/crates/lib/uuid_utils/src/uuid.rs @@ -0,0 +1,44 @@ +use uuid::Uuid; + +/// Generate a 36 character hyphenated UUID (v4) that can be used as an idempotency token. +pub fn generate_random_uuid() -> String { + let uuid = Uuid::new_v4(); + let mut buffer = Uuid::encode_buffer(); + let hyphenated_uuid = uuid.hyphenated() + .encode_lower(&mut buffer); + hyphenated_uuid.to_string() +} + +#[cfg(test)] +mod tests { + use crate::uuid::generate_random_uuid; + + mod generate_random_uuid { + use std::collections::HashSet; + + use super::*; + + #[test] + fn length() { + for _ in 0..10 { + assert_eq!(generate_random_uuid().len(), 36); + } + } + + #[test] + fn hyphenated() { + for _ in 0..10 { + assert_eq!(generate_random_uuid().contains("-"), true); + } + } + + #[test] + fn no_collision() { + let mut set = HashSet::new(); + for _ in 0..1000 { + set.insert(generate_random_uuid()); + } + assert_eq!(set.len(), 1000); + } + } +} \ No newline at end of file diff --git a/crates/models/Cargo.toml b/crates/models/Cargo.toml new file mode 100644 index 00000000..85c38f1f --- /dev/null +++ b/crates/models/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "models" +edition = "2021" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "models" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Serialization (the configs are served to the frontend as-is) +serde.workspace = true +serde_derive.workspace = true + +# Lazily-built model tables +once_cell.workspace = true + +[dev-dependencies] +serde_json.workspace = true +strum = { workspace = true, features = ["derive"] } diff --git a/crates/models/src/configs/audio_model_config.rs b/crates/models/src/configs/audio_model_config.rs new file mode 100644 index 00000000..8812e01d --- /dev/null +++ b/crates/models/src/configs/audio_model_config.rs @@ -0,0 +1,81 @@ +use crate::enums::audio_model::AudioModel; +use crate::enums::model_creator::ModelCreator; +use crate::enums::model_tag::ModelTag; +use serde_derive::Serialize; + +/// Everything ArtCraftX knows about one audio model. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct AudioModelConfig { + // ── Identity ── + pub model: AudioModel, + pub model_creator: ModelCreator, + pub full_name: String, + + // ── Desktop presentation ── + pub selector_name: String, + pub selector_description: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + pub selector_badges: Vec, + pub tags: Vec, + pub progress_bar_ms: u32, + + // ── Capabilities ── + pub text_prompt_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + /// A separate "style" prompt (genre / mood direction). + pub style_prompt_supported: bool, + pub audio_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_max: Option, + pub image_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_max: Option, + pub keep_lyrics_supported: bool, + pub instrumental_toggle_supported: bool, + pub loopable_toggle_supported: bool, + pub bpm_supported: bool, + pub musical_key_supported: bool, + pub sample_rate_hz_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub sample_rate_hz_default: Option, + pub speed_supported: bool, + pub volume_supported: bool, + pub pitch_supported: bool, + pub is_disabled: bool, +} + +impl Default for AudioModelConfig { + fn default() -> Self { + Self { + model: AudioModel::SunoMusic, + model_creator: ModelCreator::ArtCraft, + full_name: String::new(), + selector_name: String::new(), + selector_description: String::new(), + extra_info: None, + selector_badges: Vec::new(), + tags: Vec::new(), + progress_bar_ms: 120_000, + text_prompt_supported: true, + text_prompt_max_length: Some(3000), + style_prompt_supported: false, + audio_references_supported: false, + audio_references_max: None, + image_references_supported: false, + image_references_max: None, + keep_lyrics_supported: false, + instrumental_toggle_supported: false, + loopable_toggle_supported: false, + bpm_supported: false, + musical_key_supported: false, + sample_rate_hz_options: Vec::new(), + sample_rate_hz_default: None, + speed_supported: false, + volume_supported: false, + pitch_supported: false, + is_disabled: false, + } + } +} diff --git a/crates/models/src/configs/audio_models.rs b/crates/models/src/configs/audio_models.rs new file mode 100644 index 00000000..49f492b1 --- /dev/null +++ b/crates/models/src/configs/audio_models.rs @@ -0,0 +1,120 @@ +//! The built-in audio model table. Picker order = table order. + +use crate::configs::audio_model_config::AudioModelConfig; +use crate::enums::audio_model::AudioModel; +use crate::enums::model_creator::ModelCreator; +use once_cell::sync::Lazy; + +pub static AUDIO_MODELS: Lazy> = Lazy::new(audio_models); + +/// Look up one model's config. +pub fn audio_model_config(model: AudioModel) -> &'static AudioModelConfig { + AUDIO_MODELS.iter() + .find(|config| config.model == model) + .expect("every AudioModel variant has a config (see tests)") +} + +fn strings(items: &[&str]) -> Vec { + items.iter().map(|s| s.to_string()).collect() +} + +fn audio_models() -> Vec { + vec![ + // Full songs from a text prompt with optional style direction. + AudioModelConfig { + model: AudioModel::SunoMusic, + model_creator: ModelCreator::Suno, + full_name: "Suno Music".to_string(), + selector_name: "Suno Music".to_string(), + selector_description: "Full songs from a text prompt".to_string(), + selector_badges: strings(&["~2 min."]), + style_prompt_supported: true, + instrumental_toggle_supported: true, + ..Default::default() + }, + // Remix an existing track (exactly one audio reference). + AudioModelConfig { + model: AudioModel::SunoRemix, + model_creator: ModelCreator::Suno, + full_name: "Suno Remix".to_string(), + selector_name: "Suno Remix".to_string(), + selector_description: "Remix an existing track".to_string(), + selector_badges: strings(&["~2 min."]), + style_prompt_supported: true, + keep_lyrics_supported: true, + audio_references_supported: true, + audio_references_max: Some(1), + ..Default::default() + }, + // Sound effects with loop, BPM, and musical key controls. + AudioModelConfig { + model: AudioModel::SunoSounds, + model_creator: ModelCreator::Suno, + full_name: "Suno Sounds".to_string(), + selector_name: "Suno Sounds".to_string(), + selector_description: "Sound effects with beat control".to_string(), + selector_badges: strings(&["~1 min."]), + progress_bar_ms: 60_000, + loopable_toggle_supported: true, + bpm_supported: true, + musical_key_supported: true, + ..Default::default() + }, + // Build a song from a sample (exactly one audio reference). + AudioModelConfig { + model: AudioModel::SunoSample, + model_creator: ModelCreator::Suno, + full_name: "Suno Sample".to_string(), + selector_name: "Suno Sample".to_string(), + selector_description: "Build a song from a sample".to_string(), + selector_badges: strings(&["~2 min."]), + style_prompt_supported: true, + instrumental_toggle_supported: true, + audio_references_supported: true, + audio_references_max: Some(1), + ..Default::default() + }, + // Sound generation with audio/image references and output shaping controls. + AudioModelConfig { + model: AudioModel::SeedAudio1p0, + model_creator: ModelCreator::Bytedance, + full_name: "Seed Audio 1.0".to_string(), + selector_name: "Seed Audio 1.0".to_string(), + selector_description: "Sound generation with fine tuning".to_string(), + selector_badges: strings(&["~1 min."]), + progress_bar_ms: 60_000, + audio_references_supported: true, + audio_references_max: Some(3), + image_references_supported: true, + image_references_max: Some(1), + sample_rate_hz_options: vec![8000, 16000, 24000, 32000, 44100, 48000], + sample_rate_hz_default: Some(24000), + speed_supported: true, + volume_supported: true, + pitch_supported: true, + ..Default::default() + }, + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashSet; + use strum::IntoEnumIterator; + + #[test] + fn every_model_has_exactly_one_config() { + let listed: Vec = AUDIO_MODELS.iter().map(|c| c.model).collect(); + let unique: HashSet = listed.iter().copied().collect(); + assert_eq!(listed.len(), unique.len(), "duplicate audio model configs"); + for model in AudioModel::iter() { + assert!(unique.contains(&model), "no config for {model:?}"); + } + for config in AUDIO_MODELS.iter() { + if let Some(default) = config.sample_rate_hz_default { + assert!(config.sample_rate_hz_options.contains(&default), "{:?} sample rate default not offered", config.model); + } + } + } +} diff --git a/crates/models/src/configs/image_model_config.rs b/crates/models/src/configs/image_model_config.rs new file mode 100644 index 00000000..e9c7bb5f --- /dev/null +++ b/crates/models/src/configs/image_model_config.rs @@ -0,0 +1,115 @@ +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_quality::CommonQuality; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::image_model::ImageModel; +use crate::enums::model_creator::ModelCreator; +use crate::enums::model_tag::ModelTag; +use serde_derive::Serialize; + +/// Everything ArtCraftX knows about one image model. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct ImageModelConfig { + // ── Identity ── + pub model: ImageModel, + pub model_creator: ModelCreator, + /// Long name (may need abbreviating in narrow UI). + pub full_name: String, + + // ── Desktop presentation ── + /// Name shown in the picker. + pub selector_name: String, + /// One-line tagline shown under the name. + pub selector_description: String, + /// Longer blurb for the (i) info icon, if any. + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + /// Small labels next to the name (e.g. "10 sec."). + pub selector_badges: Vec, + pub tags: Vec, + /// How long the fake progress bar takes to reach 100% (UI-only). + pub progress_bar_ms: u32, + + // ── Page placement (which editors show the model) ── + /// The text-to-image page. + pub can_text_to_image: bool, + /// Image editing models that focus on editing a single image. + pub can_edit_images: bool, + /// For inpainting models: does it take a mask? + pub uses_inpainting_mask: bool, + /// For editing models: is "editing" == "inpainting"? + pub editing_is_inpainting: bool, + /// The camera-angle editing page. + pub can_edit_angles: bool, + + // ── Capabilities ── + pub text_prompt_supported: bool, + /// `None` = no limit. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + pub negative_text_prompt_supported: bool, + /// Reference images (image prompts). + pub image_refs_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub image_refs_max: Option, + pub has_fixed_editing_aspect_ratio: bool, + /// Empty = the model has no aspect-ratio control. + pub aspect_ratio_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_default: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_default_when_editing: Option, + /// Empty = the model has no resolution control. + pub resolution_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution_default: Option, + pub quality_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub quality_default: Option, + pub batch_size_min: u16, + pub batch_size_max: u16, + /// When set, the picker offers exactly these counts instead of a range. + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_options: Option>, + pub batch_size_default: u16, + /// Hidden from the picker (kept in the table so ids stay known). + pub is_disabled: bool, +} + +impl Default for ImageModelConfig { + fn default() -> Self { + Self { + model: ImageModel::NanoBananaPro, + model_creator: ModelCreator::ArtCraft, + full_name: String::new(), + selector_name: String::new(), + selector_description: String::new(), + extra_info: None, + selector_badges: Vec::new(), + tags: Vec::new(), + progress_bar_ms: 20_000, + can_text_to_image: true, + can_edit_images: false, + uses_inpainting_mask: false, + editing_is_inpainting: false, + can_edit_angles: false, + text_prompt_supported: true, + text_prompt_max_length: Some(3000), + negative_text_prompt_supported: false, + image_refs_supported: false, + image_refs_max: None, + has_fixed_editing_aspect_ratio: false, + aspect_ratio_options: Vec::new(), + aspect_ratio_default: None, + aspect_ratio_default_when_editing: None, + resolution_options: Vec::new(), + resolution_default: None, + quality_options: Vec::new(), + quality_default: None, + batch_size_min: 1, + batch_size_max: 4, + batch_size_options: None, + batch_size_default: 1, + is_disabled: false, + } + } +} diff --git a/crates/models/src/configs/image_models.rs b/crates/models/src/configs/image_models.rs new file mode 100644 index 00000000..bcf0c59e --- /dev/null +++ b/crates/models/src/configs/image_models.rs @@ -0,0 +1,738 @@ +//! The built-in image model table. Picker order = table order. + +use crate::configs::image_model_config::ImageModelConfig; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_quality::CommonQuality; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::image_model::ImageModel; +use crate::enums::model_creator::ModelCreator; +use crate::enums::model_tag::ModelTag; +use once_cell::sync::Lazy; + +pub static IMAGE_MODELS: Lazy> = Lazy::new(image_models); + +/// Look up one model's config. +pub fn image_model_config(model: ImageModel) -> &'static ImageModelConfig { + IMAGE_MODELS.iter() + .find(|config| config.model == model) + .expect("every ImageModel variant has a config (see tests)") +} + +fn image_models() -> Vec { + let mut models = Vec::new(); + + models.extend(google_models()); + models.extend(openai_models()); + models.extend(bytedance_models()); + models.extend(black_forest_labs_models()); + models.extend(midjourney_models()); + models.extend(grok_models()); + models.extend(editing_only_models()); + + models +} + +// ── Aspect ratio sets shared by several models ── + +const NANO_BANANA_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Auto, + CommonAspectRatio::Square, + CommonAspectRatio::WideFiveByFour, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::TallFourByFive, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::TallNineBySixteen, +]; + +const FLUX_1_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Square, + CommonAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, +]; + +const MIDJOURNEY_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Auto, + CommonAspectRatio::Square, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallFourByFive, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideFiveByFour, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideTwentyOneByNine, +]; + +const SEEDREAM_5_PRO_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Auto, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::Square, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::TallNineBySixteen, +]; + +const ANGLES_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Square, + CommonAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, +]; + +const OPENAI_QUALITIES: &[CommonQuality] = &[CommonQuality::High, CommonQuality::Medium, CommonQuality::Low]; + +fn strings(items: &[&str]) -> Vec { + items.iter().map(|s| s.to_string()).collect() +} + +// ── Google ── + +fn google_models() -> Vec { + vec![ + ImageModelConfig { + model: ImageModel::NanoBananaPro, + model_creator: ModelCreator::Google, + full_name: "Nano Banana Pro".to_string(), + selector_name: "Nano Banana Pro".to_string(), + selector_description: "Powerful instructive editing".to_string(), + selector_badges: strings(&["30 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 25_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(4), + aspect_ratio_options: NANO_BANANA_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK, CommonResolution::FourK], + resolution_default: Some(CommonResolution::OneK), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::NanoBanana2, + model_creator: ModelCreator::Google, + full_name: "Nano Banana 2".to_string(), + selector_name: "Nano Banana 2".to_string(), + selector_description: "Fast instructive editing".to_string(), + selector_badges: strings(&["25 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 25_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: NANO_BANANA_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + resolution_options: vec![CommonResolution::HalfK, CommonResolution::OneK, CommonResolution::TwoK, CommonResolution::FourK], + resolution_default: Some(CommonResolution::OneK), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + // Higgsfield-only: Nano Banana 2 at a fixed 1K with a High / Minimal + // "thinking" menu (surfaced as quality High / Low). + ImageModelConfig { + model: ImageModel::NanoBanana2Lite, + model_creator: ModelCreator::Google, + full_name: "Nano Banana 2 Lite".to_string(), + selector_name: "Nano Banana 2 Lite".to_string(), + selector_description: "Fastest instructive editing".to_string(), + selector_badges: strings(&["20 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 20_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: NANO_BANANA_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + quality_options: vec![CommonQuality::High, CommonQuality::Low], + quality_default: Some(CommonQuality::High), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::NanoBanana, + model_creator: ModelCreator::Google, + full_name: "Nano Banana".to_string(), + selector_name: "Nano Banana".to_string(), + selector_description: "Fast instructive editing".to_string(), + selector_badges: strings(&["25 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 25_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: NANO_BANANA_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ] +} + +// ── OpenAI ── + +fn openai_models() -> Vec { + vec![ + ImageModelConfig { + model: ImageModel::GptImage2, + model_creator: ModelCreator::OpenAi, + full_name: "GPT Image 2".to_string(), + selector_name: "GPT Image 2".to_string(), + selector_description: "Smart with great text support".to_string(), + selector_badges: strings(&["2 min."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 120_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![ + CommonAspectRatio::Auto, + CommonAspectRatio::Square, + CommonAspectRatio::SquareHd, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + // NB: GPT Image 2 has no native resolution; the backend emulates it. + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK, CommonResolution::ThreeK, CommonResolution::FourK], + resolution_default: Some(CommonResolution::OneK), + quality_options: OPENAI_QUALITIES.to_vec(), + quality_default: Some(CommonQuality::High), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::GptImage1p5, + model_creator: ModelCreator::OpenAi, + full_name: "GPT Image 1.5".to_string(), + selector_name: "GPT Image 1.5".to_string(), + selector_description: "Faster, improved".to_string(), + selector_badges: strings(&["60 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 60_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![CommonAspectRatio::Square, CommonAspectRatio::Wide, CommonAspectRatio::Tall], + aspect_ratio_default: Some(CommonAspectRatio::Square), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + quality_options: OPENAI_QUALITIES.to_vec(), + quality_default: Some(CommonQuality::High), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::GptImage1, + model_creator: ModelCreator::OpenAi, + full_name: "GPT Image 1 (GPT-4o)".to_string(), + selector_name: "GPT Image 1 (GPT-4o)".to_string(), + selector_description: "Slow, but super smart".to_string(), + selector_badges: strings(&["60 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 60_000, + can_edit_images: true, + text_prompt_max_length: None, + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![CommonAspectRatio::Square, CommonAspectRatio::WideThreeByTwo, CommonAspectRatio::TallTwoByThree], + aspect_ratio_default: Some(CommonAspectRatio::Square), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + quality_options: OPENAI_QUALITIES.to_vec(), + quality_default: Some(CommonQuality::High), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ] +} + +// ── Bytedance ── + +fn bytedance_models() -> Vec { + vec![ + ImageModelConfig { + model: ImageModel::Seedream5p0Pro, + model_creator: ModelCreator::Bytedance, + full_name: "Seedream 5.0 Pro".to_string(), + selector_name: "Seedream 5.0 Pro".to_string(), + selector_description: "Highest quality Seedream".to_string(), + selector_badges: strings(&["60 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 60_000, + can_edit_images: true, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(14), + aspect_ratio_options: SEEDREAM_5_PRO_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::Square), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK], + resolution_default: Some(CommonResolution::TwoK), + batch_size_max: 8, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Seedream5p0ProUltra, + model_creator: ModelCreator::Bytedance, + full_name: "Seedream 5.0 Pro Ultra".to_string(), + selector_name: "Seedream 5.0 Pro Ultra".to_string(), + selector_description: "Highest quality Seedream".to_string(), + selector_badges: strings(&["90 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 90_000, + can_edit_images: true, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(14), + aspect_ratio_options: SEEDREAM_5_PRO_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::Square), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK], + resolution_default: Some(CommonResolution::TwoK), + batch_size_max: 8, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Seedream5Lite, + model_creator: ModelCreator::Bytedance, + full_name: "Seedream 5 Lite".to_string(), + selector_name: "Seedream 5 Lite".to_string(), + selector_description: "Fast".to_string(), + selector_badges: strings(&["60 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 60_000, + can_edit_images: true, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![ + CommonAspectRatio::Auto2k, + CommonAspectRatio::Auto3k, + CommonAspectRatio::Square, + CommonAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto3k), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Seedream4p5, + model_creator: ModelCreator::Bytedance, + full_name: "Seedream 4.5".to_string(), + selector_name: "Seedream 4.5".to_string(), + selector_description: "Fast".to_string(), + selector_badges: strings(&["60 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 60_000, + can_edit_images: true, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![ + CommonAspectRatio::Auto2k, + CommonAspectRatio::Auto4k, + CommonAspectRatio::Square, + CommonAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto2k), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Seedream4, + model_creator: ModelCreator::Bytedance, + full_name: "Seedream 4".to_string(), + selector_name: "Seedream 4".to_string(), + selector_description: "Fast".to_string(), + selector_badges: strings(&["60 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 60_000, + can_edit_images: true, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![ + CommonAspectRatio::Auto, + CommonAspectRatio::Auto2k, + CommonAspectRatio::Auto4k, + CommonAspectRatio::Square, + CommonAspectRatio::SquareHd, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Auto), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ] +} + +// ── Black Forest Labs ── + +fn black_forest_labs_models() -> Vec { + vec![ + ImageModelConfig { + model: ImageModel::FluxPro11Ultra, + model_creator: ModelCreator::BlackForestLabs, + full_name: "FLUX 1.1 [pro] ultra".to_string(), + selector_name: "Flux Pro 1.1 Ultra".to_string(), + selector_description: "Higher quality model".to_string(), + selector_badges: strings(&["35 sec."]), + progress_bar_ms: 35_000, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![ + CommonAspectRatio::Square, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::TallNineByTwentyOne, + ], + aspect_ratio_default: Some(CommonAspectRatio::Square), + batch_size_max: 4, + batch_size_default: 4, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::FluxPro11, + model_creator: ModelCreator::BlackForestLabs, + full_name: "FLUX 1.1 [pro]".to_string(), + selector_name: "Flux Pro 1.1".to_string(), + selector_description: "High quality model".to_string(), + selector_badges: strings(&["10 sec."]), + progress_bar_ms: 10_000, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: vec![ + CommonAspectRatio::Square, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::Square), + batch_size_max: 4, + batch_size_default: 4, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Flux1Dev, + model_creator: ModelCreator::BlackForestLabs, + full_name: "FLUX.1 [dev]".to_string(), + selector_name: "Flux 1 Dev".to_string(), + selector_description: "Fast, but lower quality".to_string(), + selector_badges: strings(&["10 sec."]), + progress_bar_ms: 10_000, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: FLUX_1_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::Square), + batch_size_max: 4, + batch_size_default: 4, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Flux1Schnell, + model_creator: ModelCreator::BlackForestLabs, + full_name: "FLUX.1 [schnell]".to_string(), + selector_name: "Flux 1 Schnell".to_string(), + selector_description: "Fastest image gen, but lowest quality".to_string(), + selector_badges: strings(&["10 sec."]), + progress_bar_ms: 10_000, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(6), + aspect_ratio_options: FLUX_1_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::Square), + batch_size_max: 4, + batch_size_default: 4, + ..Default::default() + }, + ] +} + +// ── Midjourney ── + +fn midjourney_models() -> Vec { + let midjourney = |model: ImageModel, full_name: &str, description: &str| ImageModelConfig { + model, + model_creator: ModelCreator::Midjourney, + full_name: full_name.to_string(), + selector_name: full_name.to_string(), + selector_description: description.to_string(), + selector_badges: strings(&["45 sec."]), + progress_bar_ms: 45_000, + text_prompt_max_length: Some(6000), + image_refs_supported: true, + image_refs_max: Some(1), + aspect_ratio_options: MIDJOURNEY_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::Square), + // NB: Midjourney produces a 2x2 grid per prompt. + batch_size_min: 4, + batch_size_max: 4, + batch_size_options: Some(vec![4]), + batch_size_default: 4, + ..Default::default() + }; + + vec![ + midjourney(ImageModel::Midjourney8, "Midjourney v8", "Stunning style and quality"), + midjourney(ImageModel::Midjourney7, "Midjourney v7", "Stunning style and quality"), + midjourney(ImageModel::Midjourney7Niji, "Midjourney v7 Niji", "Anime style"), + ] +} + +// ── Grok (first-party imagine websocket; see `enqueue_image_generation.rs`) ── + +fn grok_models() -> Vec { + vec![ + ImageModelConfig { + model: ImageModel::GrokImagineImage, + model_creator: ModelCreator::Grok, + full_name: "Grok Imagine".to_string(), + selector_name: "Grok Imagine".to_string(), + selector_description: "Fast image generation on your Grok account".to_string(), + selector_badges: strings(&["10 sec."]), + progress_bar_ms: 15_000, + text_prompt_max_length: Some(4096), + aspect_ratio_options: vec![ + CommonAspectRatio::Square, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::Square), + // NB: Grok's imagine websocket returns two images per prompt. + batch_size_min: 2, + batch_size_max: 2, + batch_size_options: Some(vec![2]), + batch_size_default: 2, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::GrokImagineImageQuality, + model_creator: ModelCreator::Grok, + full_name: "Grok Imagine (Quality)".to_string(), + selector_name: "Grok Imagine Quality".to_string(), + selector_description: "Higher quality on your Grok account".to_string(), + selector_badges: strings(&["30 sec."]), + progress_bar_ms: 40_000, + text_prompt_max_length: Some(4096), + aspect_ratio_options: vec![ + CommonAspectRatio::Square, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::Square), + batch_size_min: 2, + batch_size_max: 2, + batch_size_options: Some(vec![2]), + batch_size_default: 2, + ..Default::default() + }, + ] +} + +// ── Editing-only models (not on the text-to-image page) ── + +fn editing_only_models() -> Vec { + vec![ + ImageModelConfig { + model: ImageModel::QwenEdit2511Angles, + model_creator: ModelCreator::Alibaba, + full_name: "Qwen Edit 2511 Angles".to_string(), + selector_name: "Qwen Edit 2511 Angles".to_string(), + selector_description: "Angle manipulation with optional prompt".to_string(), + selector_badges: strings(&["30 sec."]), + progress_bar_ms: 30_000, + can_text_to_image: false, + can_edit_angles: true, + text_prompt_max_length: Some(800), + image_refs_supported: true, + image_refs_max: Some(1), + aspect_ratio_options: ANGLES_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::SquareHd), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::Flux2LoraAngles, + model_creator: ModelCreator::BlackForestLabs, + full_name: "Flux 2 LoRA Angles".to_string(), + selector_name: "Flux 2 LoRA Angles".to_string(), + selector_description: "Angle manipulation".to_string(), + selector_badges: strings(&["30 sec."]), + progress_bar_ms: 30_000, + can_text_to_image: false, + can_edit_angles: true, + text_prompt_max_length: Some(4000), + image_refs_supported: true, + image_refs_max: Some(1), + aspect_ratio_options: ANGLES_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::SquareHd), + batch_size_max: 4, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::FluxProKontextMax, + model_creator: ModelCreator::BlackForestLabs, + full_name: "Flux Pro Kontext Max".to_string(), + selector_name: "Flux Pro Kontext Max".to_string(), + selector_description: "Fast instructive editing".to_string(), + selector_badges: strings(&["20 sec."]), + tags: vec![ModelTag::InstructiveEdit], + progress_bar_ms: 20_000, + can_text_to_image: false, + can_edit_images: true, + text_prompt_max_length: Some(4000), + batch_size_max: 4, + batch_size_default: 4, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::FluxPro1, + model_creator: ModelCreator::BlackForestLabs, + full_name: "Flux Pro Inpaint".to_string(), + selector_name: "Flux Pro (Inpainting)".to_string(), + selector_description: "Fast inpainting".to_string(), + selector_badges: strings(&["30 sec."]), + tags: vec![ModelTag::MaskedInpainting], + progress_bar_ms: 30_000, + can_text_to_image: false, + can_edit_images: true, + uses_inpainting_mask: true, + editing_is_inpainting: true, + text_prompt_max_length: Some(4000), + // NB: FAL only allows one image for this model. + batch_size_max: 1, + batch_size_default: 1, + ..Default::default() + }, + ImageModelConfig { + model: ImageModel::FluxDevJuggernaut, + model_creator: ModelCreator::BlackForestLabs, + full_name: "Flux Dev Juggernaut Inpaint".to_string(), + selector_name: "Flux Dev Juggernaut".to_string(), + selector_description: "Fast inpainting, low quality".to_string(), + selector_badges: strings(&["10 sec."]), + tags: vec![ModelTag::MaskedInpainting], + progress_bar_ms: 10_000, + can_text_to_image: false, + can_edit_images: true, + uses_inpainting_mask: true, + editing_is_inpainting: true, + text_prompt_max_length: Some(4000), + batch_size_max: 4, + batch_size_default: 4, + ..Default::default() + }, + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashSet; + use strum::IntoEnumIterator; + + #[test] + fn every_model_has_exactly_one_config() { + let listed: Vec = IMAGE_MODELS.iter().map(|c| c.model).collect(); + let unique: HashSet = listed.iter().copied().collect(); + assert_eq!(listed.len(), unique.len(), "duplicate image model configs"); + for model in ImageModel::iter() { + assert!(unique.contains(&model), "no config for {model:?}"); + } + } + + #[test] + fn defaults_are_within_their_options() { + for config in IMAGE_MODELS.iter() { + assert!(!config.full_name.is_empty() && !config.selector_name.is_empty(), "{:?} needs names", config.model); + assert!(config.batch_size_min <= config.batch_size_default && config.batch_size_default <= config.batch_size_max, "{:?} batch sizes", config.model); + if let Some(default) = config.aspect_ratio_default { + assert!(config.aspect_ratio_options.contains(&default), "{:?} aspect default not offered", config.model); + } + if let Some(default) = config.resolution_default { + assert!(config.resolution_options.contains(&default), "{:?} resolution default not offered", config.model); + } + if let Some(default) = config.quality_default { + assert!(config.quality_options.contains(&default), "{:?} quality default not offered", config.model); + } + } + } + + #[test] + fn serializes_with_string_ids() { + let json = serde_json::to_value(image_model_config(ImageModel::FluxPro11)).unwrap(); + assert_eq!(json["model"], "flux_pro_1p1"); + assert_eq!(json["model_creator"], "black_forest_labs"); + assert_eq!(json["aspect_ratio_default"], "square"); + // Unlimited prompt length is simply absent. + let nb = serde_json::to_value(image_model_config(ImageModel::NanoBananaPro)).unwrap(); + assert!(nb.get("text_prompt_max_length").is_none()); + } +} diff --git a/crates/models/src/configs/mesh_model_config.rs b/crates/models/src/configs/mesh_model_config.rs new file mode 100644 index 00000000..ea3d42c5 --- /dev/null +++ b/crates/models/src/configs/mesh_model_config.rs @@ -0,0 +1,72 @@ +use crate::enums::common_mesh_output_type::CommonMeshOutputType; +use crate::enums::common_polygon_type::CommonPolygonType; +use crate::enums::mesh_model::MeshModel; +use crate::enums::model_creator::ModelCreator; +use crate::enums::model_tag::ModelTag; +use serde_derive::Serialize; + +/// Everything ArtCraftX knows about one 3D mesh model. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct MeshModelConfig { + // ── Identity ── + pub model: MeshModel, + pub model_creator: ModelCreator, + pub full_name: String, + + // ── Desktop presentation ── + pub selector_name: String, + pub selector_description: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + pub selector_badges: Vec, + pub tags: Vec, + pub progress_bar_ms: u32, + + // ── Capabilities ── + pub text_prompt_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + pub image_input_supported: bool, + pub sketch_input_supported: bool, + pub multi_view_supported: bool, + /// Takes an existing mesh as input (part splitting, retopology). + pub mesh_input_supported: bool, + pub mesh_output_types: Vec, + pub polygon_types: Vec, + pub face_count_supported: bool, + pub pbr_supported: bool, + pub texture_toggle_supported: bool, + pub texture_quality_supported: bool, + pub geometry_quality_supported: bool, + pub is_disabled: bool, +} + +impl Default for MeshModelConfig { + fn default() -> Self { + Self { + model: MeshModel::Hunyuan3d3, + model_creator: ModelCreator::ArtCraft, + full_name: String::new(), + selector_name: String::new(), + selector_description: String::new(), + extra_info: None, + selector_badges: Vec::new(), + tags: Vec::new(), + progress_bar_ms: 120_000, + text_prompt_supported: false, + text_prompt_max_length: Some(3000), + image_input_supported: false, + sketch_input_supported: false, + multi_view_supported: false, + mesh_input_supported: false, + mesh_output_types: Vec::new(), + polygon_types: Vec::new(), + face_count_supported: false, + pbr_supported: false, + texture_toggle_supported: false, + texture_quality_supported: false, + geometry_quality_supported: false, + is_disabled: false, + } + } +} diff --git a/crates/models/src/configs/mesh_models.rs b/crates/models/src/configs/mesh_models.rs new file mode 100644 index 00000000..76335836 --- /dev/null +++ b/crates/models/src/configs/mesh_models.rs @@ -0,0 +1,229 @@ +//! The built-in 3D mesh model table. Picker order = table order. + +use crate::configs::mesh_model_config::MeshModelConfig; +use crate::enums::common_mesh_output_type::CommonMeshOutputType; +use crate::enums::common_polygon_type::CommonPolygonType; +use crate::enums::mesh_model::MeshModel; +use crate::enums::model_creator::ModelCreator; +use once_cell::sync::Lazy; + +pub static MESH_MODELS: Lazy> = Lazy::new(mesh_models); + +/// Look up one model's config. +pub fn mesh_model_config(model: MeshModel) -> &'static MeshModelConfig { + MESH_MODELS.iter() + .find(|config| config.model == model) + .expect("every MeshModel variant has a config (see tests)") +} + +const NORMAL_AND_GEOMETRY: &[CommonMeshOutputType] = &[CommonMeshOutputType::Normal, CommonMeshOutputType::Geometry]; +const NORMAL_LOW_POLY_AND_GEOMETRY: &[CommonMeshOutputType] = &[ + CommonMeshOutputType::Normal, + CommonMeshOutputType::LowPoly, + CommonMeshOutputType::Geometry, +]; +const TRIANGLE_AND_QUAD: &[CommonPolygonType] = &[CommonPolygonType::Triangle, CommonPolygonType::Quad]; + +fn strings(items: &[&str]) -> Vec { + items.iter().map(|s| s.to_string()).collect() +} + +fn mesh_models() -> Vec { + vec![ + // Text and/or image input with multi-view support and full output shaping + // controls (output type, polygon type, face count, PBR). + MeshModelConfig { + model: MeshModel::Hunyuan3d3, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 3.0".to_string(), + selector_name: "Hunyuan 3.0".to_string(), + selector_description: "Highest quality 3D mesh generation".to_string(), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + text_prompt_supported: true, + image_input_supported: true, + multi_view_supported: true, + mesh_output_types: NORMAL_LOW_POLY_AND_GEOMETRY.to_vec(), + polygon_types: TRIANGLE_AND_QUAD.to_vec(), + face_count_supported: true, + pbr_supported: true, + ..Default::default() + }, + // Text or (multi-view) image input. No low-poly mode or polygon type + // selection (unlike v3). + MeshModelConfig { + model: MeshModel::Hunyuan3d3p1Pro, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 3.1 Pro".to_string(), + selector_name: "Hunyuan 3.1 Pro".to_string(), + selector_description: "Newest Hunyuan, highest quality".to_string(), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + text_prompt_supported: true, + image_input_supported: true, + multi_view_supported: true, + mesh_output_types: NORMAL_AND_GEOMETRY.to_vec(), + face_count_supported: true, + pbr_supported: true, + ..Default::default() + }, + // The fast, low-cost tier. Text or single-image input, minimal options. + MeshModelConfig { + model: MeshModel::Hunyuan3d3p1Rapid, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 3.1 Rapid".to_string(), + selector_name: "Hunyuan 3.1 Rapid".to_string(), + selector_description: "Newest Hunyuan, fast".to_string(), + selector_badges: strings(&["~1 min."]), + progress_bar_ms: 60_000, + text_prompt_supported: true, + image_input_supported: true, + mesh_output_types: NORMAL_AND_GEOMETRY.to_vec(), + pbr_supported: true, + ..Default::default() + }, + // Sketch-to-3D. Requires both a sketch image and a text prompt. + MeshModelConfig { + model: MeshModel::Hunyuan3d3Sketch, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 3 Sketch".to_string(), + selector_name: "Hunyuan 3 Sketch".to_string(), + selector_description: "3D mesh from a sketch".to_string(), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + text_prompt_supported: true, + sketch_input_supported: true, + face_count_supported: true, + pbr_supported: true, + ..Default::default() + }, + // Image-to-3D only (exactly one input image). + MeshModelConfig { + model: MeshModel::Hunyuan3d2p1, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 2.1".to_string(), + selector_name: "Hunyuan 2.1".to_string(), + selector_description: "Faster, lower fidelity 3D mesh".to_string(), + selector_badges: strings(&["~45 sec."]), + progress_bar_ms: 60_000, + image_input_supported: true, + mesh_output_types: NORMAL_AND_GEOMETRY.to_vec(), + ..Default::default() + }, + MeshModelConfig { + model: MeshModel::Hunyuan3d2p0, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 2.0".to_string(), + selector_name: "Hunyuan 2.0".to_string(), + selector_description: "Faster, lower fidelity 3D mesh".to_string(), + selector_badges: strings(&["~45 sec."]), + progress_bar_ms: 60_000, + image_input_supported: true, + mesh_output_types: NORMAL_AND_GEOMETRY.to_vec(), + ..Default::default() + }, + // Splits an existing mesh (FBX) into semantic parts. + MeshModelConfig { + model: MeshModel::Hunyuan3d3p1Part, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 3.1 Part".to_string(), + selector_name: "Hunyuan 3.1 Part".to_string(), + selector_description: "Mesh splitting".to_string(), + extra_info: Some("Splits an existing 3D mesh into semantically meaningful parts".to_string()), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + mesh_input_supported: true, + ..Default::default() + }, + // Retopologizes an existing mesh (GLB/OBJ). + MeshModelConfig { + model: MeshModel::Hunyuan3d3p1SmartTopology, + model_creator: ModelCreator::Tencent, + full_name: "Hunyuan 3D 3.1 Smart Topology".to_string(), + selector_name: "Hunyuan 3.1 Smart Topology".to_string(), + selector_description: "Retopology".to_string(), + extra_info: Some("Retopologizes an existing 3D mesh into a cleaner, more efficient topology".to_string()), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + mesh_input_supported: true, + polygon_types: TRIANGLE_AND_QUAD.to_vec(), + ..Default::default() + }, + // Text, single-image, or multi-view image input with texture/geometry + // quality tiers and quad output. + MeshModelConfig { + model: MeshModel::Tripo3dH3p1, + model_creator: ModelCreator::Tripo, + full_name: "Tripo3D H3.1".to_string(), + selector_name: "Tripo3D H3.1".to_string(), + selector_description: "High quality with texture controls".to_string(), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + text_prompt_supported: true, + image_input_supported: true, + multi_view_supported: true, + mesh_output_types: NORMAL_AND_GEOMETRY.to_vec(), + polygon_types: TRIANGLE_AND_QUAD.to_vec(), + face_count_supported: true, + pbr_supported: true, + texture_toggle_supported: true, + texture_quality_supported: true, + geometry_quality_supported: true, + ..Default::default() + }, + // Text or single-image input with low-poly mode and quad output. + MeshModelConfig { + model: MeshModel::MeshyV6, + model_creator: ModelCreator::Meshy, + full_name: "Meshy 6".to_string(), + selector_name: "Meshy 6".to_string(), + selector_description: "High quality with low-poly output".to_string(), + selector_badges: strings(&["~2 min."]), + progress_bar_ms: 120_000, + text_prompt_supported: true, + image_input_supported: true, + mesh_output_types: NORMAL_LOW_POLY_AND_GEOMETRY.to_vec(), + polygon_types: TRIANGLE_AND_QUAD.to_vec(), + face_count_supported: true, + pbr_supported: true, + texture_toggle_supported: true, + ..Default::default() + }, + // Text or image(s) input; fast, low-cost. + MeshModelConfig { + model: MeshModel::Rodin2p5Fast, + model_creator: ModelCreator::Deemos, + full_name: "Rodin 2.5 Fast".to_string(), + selector_name: "Rodin 2.5 Fast".to_string(), + selector_description: "Fast, inexpensive 3D mesh".to_string(), + selector_badges: strings(&["~1 min."]), + progress_bar_ms: 60_000, + text_prompt_supported: true, + image_input_supported: true, + mesh_output_types: NORMAL_AND_GEOMETRY.to_vec(), + pbr_supported: true, + texture_toggle_supported: true, + ..Default::default() + }, + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashSet; + use strum::IntoEnumIterator; + + #[test] + fn every_model_has_exactly_one_config() { + let listed: Vec = MESH_MODELS.iter().map(|c| c.model).collect(); + let unique: HashSet = listed.iter().copied().collect(); + assert_eq!(listed.len(), unique.len(), "duplicate mesh model configs"); + for model in MeshModel::iter() { + assert!(unique.contains(&model), "no config for {model:?}"); + } + for config in MESH_MODELS.iter() { + assert!(!config.full_name.is_empty() && !config.selector_name.is_empty(), "{:?} needs names", config.model); + } + } +} diff --git a/crates/models/src/configs/mod.rs b/crates/models/src/configs/mod.rs new file mode 100644 index 00000000..81cdc643 --- /dev/null +++ b/crates/models/src/configs/mod.rs @@ -0,0 +1,18 @@ +//! Per-modality model configs and the built-in tables of every model. +//! +//! Each `*ModelConfig` is what the Tauri list command serves the frontend: +//! identity, capabilities (which inputs and options a model accepts), and +//! desktop presentation (picker copy, badges, providers, page flags). The +//! `*_models()` tables are the data; they're declared with +//! `..Default::default()` so an entry only spells out what's true for it. + +pub mod audio_model_config; +pub mod audio_models; +pub mod image_model_config; +pub mod image_models; +pub mod mesh_model_config; +pub mod mesh_models; +pub mod splat_model_config; +pub mod splat_models; +pub mod video_model_config; +pub mod video_models; diff --git a/crates/models/src/configs/splat_model_config.rs b/crates/models/src/configs/splat_model_config.rs new file mode 100644 index 00000000..cbb2b7a7 --- /dev/null +++ b/crates/models/src/configs/splat_model_config.rs @@ -0,0 +1,59 @@ +use crate::enums::model_creator::ModelCreator; +use crate::enums::model_tag::ModelTag; +use crate::enums::splat_model::SplatModel; +use serde_derive::Serialize; + +/// Everything ArtCraftX knows about one Gaussian splat ("world") model. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct SplatModelConfig { + // ── Identity ── + pub model: SplatModel, + pub model_creator: ModelCreator, + pub full_name: String, + + // ── Desktop presentation ── + pub selector_name: String, + pub selector_description: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + pub selector_badges: Vec, + pub tags: Vec, + pub progress_bar_ms: u32, + + // ── Capabilities ── + pub text_prompt_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + pub image_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_max: Option, + pub video_reference_supported: bool, + /// 360-degree panorama input. + pub panorama_supported: bool, + pub disable_recaption_supported: bool, + pub is_disabled: bool, +} + +impl Default for SplatModelConfig { + fn default() -> Self { + Self { + model: SplatModel::Marble1p1, + model_creator: ModelCreator::ArtCraft, + full_name: String::new(), + selector_name: String::new(), + selector_description: String::new(), + extra_info: None, + selector_badges: Vec::new(), + tags: Vec::new(), + progress_bar_ms: 300_000, + text_prompt_supported: false, + text_prompt_max_length: Some(3000), + image_references_supported: false, + image_references_max: None, + video_reference_supported: false, + panorama_supported: false, + disable_recaption_supported: false, + is_disabled: false, + } + } +} diff --git a/crates/models/src/configs/splat_models.rs b/crates/models/src/configs/splat_models.rs new file mode 100644 index 00000000..7f2c6e39 --- /dev/null +++ b/crates/models/src/configs/splat_models.rs @@ -0,0 +1,84 @@ +//! The built-in Gaussian splat ("world") model table. Picker order = table order. + +use crate::configs::splat_model_config::SplatModelConfig; +use crate::enums::model_creator::ModelCreator; +use crate::enums::splat_model::SplatModel; +use once_cell::sync::Lazy; + +/// World Labs MultiImage input accepts up to this many reference images. +const MARBLE_MAX_IMAGE_REFERENCES: u16 = 4; + +pub static SPLAT_MODELS: Lazy> = Lazy::new(splat_models); + +/// Look up one model's config. +pub fn splat_model_config(model: SplatModel) -> &'static SplatModelConfig { + SPLAT_MODELS.iter() + .find(|config| config.model == model) + .expect("every SplatModel variant has a config (see tests)") +} + +fn splat_models() -> Vec { + vec![ + marble(SplatModel::Marble1p1, "Marble 1.1", "Latest generation, best quality", "~5 min.", 300_000, false), + marble(SplatModel::Marble1p1Plus, "Marble 1.1 Plus", "Highest quality, best for final renders", "~5 min.", 300_000, false), + marble(SplatModel::Marble1p0, "Marble 1.0", "Previous generation, high quality", "~5 min.", 300_000, false), + marble(SplatModel::Marble1p0Draft, "Marble 1.0 Draft", "Fast generation, good for quick drafts", "~30 sec.", 45_000, false), + marble(SplatModel::Marble0p1Plus, "Marble Plus", "Legacy Marble 0.1 Plus", "~5 min.", 300_000, true), + marble(SplatModel::Marble0p1Mini, "Marble Mini", "Legacy Marble 0.1 Mini", "~1 min.", 60_000, true), + // TripoSplat reconstructs an object-scale Gaussian splat from exactly one + // image. No prompt, video, panorama, or recaption toggle. + SplatModelConfig { + model: SplatModel::TripoSplat, + model_creator: ModelCreator::Tripo, + full_name: "TripoSplat".to_string(), + selector_name: "TripoSplat".to_string(), + selector_description: "Reconstructs a splat from a single image".to_string(), + extra_info: Some("Reconstructs a 3D Gaussian splat from a single image".to_string()), + selector_badges: vec!["~1 min.".to_string()], + progress_bar_ms: 60_000, + image_references_supported: true, + image_references_max: Some(1), + ..Default::default() + }, + ] +} + +/// All Marble models share the same capability surface: text prompt, image +/// references (up to 4, multi-view), a reference video, 360-degree panorama +/// input, and the "disable recaption" toggle. +fn marble(model: SplatModel, full_name: &str, description: &str, badge: &str, progress_bar_ms: u32, is_disabled: bool) -> SplatModelConfig { + SplatModelConfig { + model, + model_creator: ModelCreator::WorldLabs, + full_name: full_name.to_string(), + selector_name: full_name.to_string(), + selector_description: description.to_string(), + selector_badges: vec![badge.to_string()], + progress_bar_ms, + text_prompt_supported: true, + image_references_supported: true, + image_references_max: Some(MARBLE_MAX_IMAGE_REFERENCES), + video_reference_supported: true, + panorama_supported: true, + disable_recaption_supported: true, + is_disabled, + ..Default::default() + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashSet; + use strum::IntoEnumIterator; + + #[test] + fn every_model_has_exactly_one_config() { + let listed: Vec = SPLAT_MODELS.iter().map(|c| c.model).collect(); + let unique: HashSet = listed.iter().copied().collect(); + assert_eq!(listed.len(), unique.len(), "duplicate splat model configs"); + for model in SplatModel::iter() { + assert!(unique.contains(&model), "no config for {model:?}"); + } + } +} diff --git a/crates/models/src/configs/video_model_config.rs b/crates/models/src/configs/video_model_config.rs new file mode 100644 index 00000000..0b4402a3 --- /dev/null +++ b/crates/models/src/configs/video_model_config.rs @@ -0,0 +1,150 @@ +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_bitrate::CommonBitrate; +use crate::enums::common_quality::CommonQuality; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::legacy_video_size::LegacyVideoSize; +use crate::enums::model_creator::ModelCreator; +use crate::enums::model_tag::ModelTag; +use crate::enums::video_model::VideoModel; +use serde_derive::Serialize; + +/// Everything ArtCraftX knows about one video model. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct VideoModelConfig { + // ── Identity ── + pub model: VideoModel, + pub model_creator: ModelCreator, + pub full_name: String, + + // ── Desktop presentation ── + pub selector_name: String, + pub selector_description: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub extra_info: Option, + pub selector_badges: Vec, + pub tags: Vec, + pub progress_bar_ms: u32, + /// Whether the prompt box offers the system-prompt toggle. + pub supports_system_prompt: bool, + + // ── Capabilities ── + /// Can generate from a text prompt ALONE. When false, an image (starting + /// frame / reference) is also required. + pub text_to_video_supported: bool, + pub text_prompt_supported: bool, + /// `None` = no limit. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_prompt_max_length: Option, + pub negative_text_prompt_supported: bool, + pub starting_keyframe_supported: bool, + /// The model needs an image (it can't run text-only). + pub starting_keyframe_required: bool, + pub ending_keyframe_supported: bool, + /// Multi-image "reference mode". + pub image_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub image_references_max: Option, + pub video_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub video_references_max: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub video_references_max_total_duration_seconds: Option, + pub audio_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_max: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub audio_references_max_total_duration_seconds: Option, + pub character_references_supported: bool, + #[serde(skip_serializing_if = "Option::is_none")] + pub character_references_max: Option, + /// Show the "generate with sound" toggle. + pub show_generate_with_sound_toggle: bool, + /// Empty = no aspect-ratio control (or the model uses `legacy_size_options`). + pub aspect_ratio_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub aspect_ratio_default: Option, + /// The coarse landscape/portrait/square picker of the first-party Grok and + /// Sora paths (sent as `grok_aspect_ratio` / `sora_orientation`). Only set + /// when `aspect_ratio_options` is empty. + pub legacy_size_options: Vec, + pub resolution_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub resolution_default: Option, + pub bitrate_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub bitrate_default: Option, + pub quality_options: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub quality_default: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_min: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_max: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_max_with_image_references: Option, + /// When set, the picker offers exactly these durations instead of a range. + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_options: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub duration_seconds_default: Option, + pub batch_size_min: u16, + pub batch_size_max: u16, + #[serde(skip_serializing_if = "Option::is_none")] + pub batch_size_options: Option>, + pub batch_size_default: u16, + pub is_disabled: bool, +} + +impl Default for VideoModelConfig { + fn default() -> Self { + Self { + model: VideoModel::Seedance2p0, + model_creator: ModelCreator::ArtCraft, + full_name: String::new(), + selector_name: String::new(), + selector_description: String::new(), + extra_info: None, + selector_badges: Vec::new(), + tags: Vec::new(), + progress_bar_ms: 100_000, + supports_system_prompt: true, + text_to_video_supported: true, + text_prompt_supported: true, + text_prompt_max_length: Some(3000), + negative_text_prompt_supported: false, + starting_keyframe_supported: false, + starting_keyframe_required: false, + ending_keyframe_supported: false, + image_references_supported: false, + image_references_max: None, + video_references_supported: false, + video_references_max: None, + video_references_max_total_duration_seconds: None, + audio_references_supported: false, + audio_references_max: None, + audio_references_max_total_duration_seconds: None, + character_references_supported: false, + character_references_max: None, + show_generate_with_sound_toggle: false, + aspect_ratio_options: Vec::new(), + aspect_ratio_default: None, + legacy_size_options: Vec::new(), + resolution_options: Vec::new(), + resolution_default: None, + bitrate_options: Vec::new(), + bitrate_default: None, + quality_options: Vec::new(), + quality_default: None, + duration_seconds_min: None, + duration_seconds_max: None, + duration_seconds_max_with_image_references: None, + duration_seconds_options: None, + duration_seconds_default: None, + batch_size_min: 1, + batch_size_max: 1, + batch_size_options: None, + batch_size_default: 1, + is_disabled: false, + } + } +} diff --git a/crates/models/src/configs/video_models/by_type/beeble_video_models.rs b/crates/models/src/configs/video_models/by_type/beeble_video_models.rs new file mode 100644 index 00000000..8f9e2bd7 --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/beeble_video_models.rs @@ -0,0 +1,26 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +/// Beeble VFX models. SwitchX isn't a generator: it relights / swaps the +/// background of an existing video, so it's excluded from the video picker +/// by id on the frontend. +pub fn beeble_video_models() -> Vec { + vec![ + VideoModelConfig { + model: VideoModel::SwitchX, + model_creator: ModelCreator::Beeble, + full_name: "Beeble SwitchX".to_string(), + selector_name: "Beeble SwitchX".to_string(), + selector_description: "Relight, change location, swap objects.".to_string(), + selector_badges: strings(&["5 min."]), + progress_bar_ms: 5 * 60 * 1000, + text_prompt_max_length: Some(2000), + starting_keyframe_required: true, + starting_keyframe_supported: true, + text_to_video_supported: false, + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/grok_video_models.rs b/crates/models/src/configs/video_models/by_type/grok_video_models.rs new file mode 100644 index 00000000..498a4e45 --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/grok_video_models.rs @@ -0,0 +1,53 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::legacy_video_size::LegacyVideoSize; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +/// Grok Imagine video models. +pub fn grok_video_models() -> Vec { + vec![ + // First-party (cookie session). The prompt box sends its size as + // `grok_aspect_ratio` (landscape / portrait / square). + VideoModelConfig { + model: VideoModel::GrokImagineVideo, + model_creator: ModelCreator::Grok, + full_name: "Grok Video".to_string(), + selector_name: "Grok Video".to_string(), + selector_description: "Fastest video model".to_string(), + selector_badges: strings(&["20 sec."]), + progress_bar_ms: 50_000, + text_prompt_max_length: Some(4096), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + legacy_size_options: vec![LegacyVideoSize::Landscape, LegacyVideoSize::Portrait, LegacyVideoSize::Square], + ..Default::default() + }, + // Served via Artcraft (storyteller-web / router) for now, even though the + // model is made by xAI. See `generate_video_command.rs`. + VideoModelConfig { + model: VideoModel::GrokImagineVideo1p5, + model_creator: ModelCreator::Grok, + full_name: "Grok Imagine 1.5".to_string(), + selector_name: "Grok Imagine 1.5".to_string(), + selector_description: "Image-to-video by xAI".to_string(), + extra_info: Some("Fast and high quality. Requires a starting frame.".to_string()), + selector_badges: strings(&["Preview"]), + progress_bar_ms: 50_000, + text_prompt_max_length: Some(4096), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + legacy_size_options: vec![LegacyVideoSize::Landscape, LegacyVideoSize::Portrait, LegacyVideoSize::Square], + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(1), + duration_seconds_max: Some(15), + duration_seconds_max_with_image_references: Some(10), + duration_seconds_default: Some(8), + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/happy_horse_video_models.rs b/crates/models/src/configs/video_models/by_type/happy_horse_video_models.rs new file mode 100644 index 00000000..1ee54dfe --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/happy_horse_video_models.rs @@ -0,0 +1,42 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +/// Happy Horse (Alibaba) video models. +pub fn happy_horse_video_models() -> Vec { + vec![ + VideoModelConfig { + model: VideoModel::HappyHorse1p0, + model_creator: ModelCreator::Alibaba, + full_name: "Happy Horse 1.0".to_string(), + selector_name: "Happy Horse 1.0".to_string(), + selector_description: "High quality video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + show_generate_with_sound_toggle: true, + aspect_ratio_options: vec![ + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::Square, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(3), + duration_seconds_max: Some(15), + duration_seconds_options: Some((3..=15).collect()), + duration_seconds_default: Some(5), + batch_size_max: 4, + batch_size_options: Some(vec![1, 2, 4]), + batch_size_default: 1, + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/kling_video_models.rs b/crates/models/src/configs/video_models/by_type/kling_video_models.rs new file mode 100644 index 00000000..150458d9 --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/kling_video_models.rs @@ -0,0 +1,151 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +const KLING_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::Square, + CommonAspectRatio::TallNineBySixteen, +]; + +/// Kling video models. +pub fn kling_video_models() -> Vec { + vec![ + VideoModelConfig { + model: VideoModel::Kling3p0Pro, + model_creator: ModelCreator::Kling, + full_name: "Kling 3.0 Pro".to_string(), + selector_name: "Kling 3.0 Pro".to_string(), + selector_description: "High quality video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + show_generate_with_sound_toggle: true, + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_min: Some(3), + duration_seconds_max: Some(15), + duration_seconds_options: Some((3..=15).collect()), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Kling3p0Standard, + model_creator: ModelCreator::Kling, + full_name: "Kling 3.0 Standard".to_string(), + selector_name: "Kling 3.0 Standard".to_string(), + selector_description: "Standard quality video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + show_generate_with_sound_toggle: true, + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_min: Some(3), + duration_seconds_max: Some(15), + duration_seconds_options: Some((3..=15).collect()), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Kling2p6Pro, + model_creator: ModelCreator::Kling, + full_name: "Kling 2.6 Pro".to_string(), + selector_name: "Kling 2.6 Pro".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_options: Some(vec![5, 10]), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Kling2p5TurboPro, + model_creator: ModelCreator::Kling, + full_name: "Kling 2.5 Turbo Pro".to_string(), + selector_name: "Kling 2.5 Turbo Pro".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_options: Some(vec![5, 10]), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Kling21Master, + model_creator: ModelCreator::Kling, + full_name: "Kling 2.1 Master".to_string(), + selector_name: "Kling 2.1 Master".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_options: Some(vec![5, 10]), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Kling21Pro, + model_creator: ModelCreator::Kling, + full_name: "Kling 2.1 Pro".to_string(), + selector_name: "Kling 2.1 Pro".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + starting_keyframe_required: true, + ending_keyframe_supported: true, + text_to_video_supported: false, + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_options: Some(vec![5, 10]), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Kling16Pro, + model_creator: ModelCreator::Kling, + full_name: "Kling 1.6 Pro".to_string(), + selector_name: "Kling 1.6 Pro".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 300_000, + text_prompt_max_length: Some(2500), + starting_keyframe_supported: true, + starting_keyframe_required: true, + ending_keyframe_supported: true, + text_to_video_supported: false, + // NB: Kling 1.6 "Elements". + image_references_supported: true, + image_references_max: Some(4), + aspect_ratio_options: KLING_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_options: Some(vec![5, 10]), + duration_seconds_default: Some(5), + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/minimax_video_models.rs b/crates/models/src/configs/video_models/by_type/minimax_video_models.rs new file mode 100644 index 00000000..40f600ef --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/minimax_video_models.rs @@ -0,0 +1,39 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +/// MiniMax (Hailuo) video models. +pub fn minimax_video_models() -> Vec { + vec![ + // Higgsfield-only. Fixed 2K output that follows the references' framing: + // no aspect-ratio or resolution controls. + VideoModelConfig { + model: VideoModel::MinimaxH3, + model_creator: ModelCreator::Hailuo, + full_name: "MiniMax Hailuo 3".to_string(), + selector_name: "MiniMax H3".to_string(), + selector_description: "2K video with references".to_string(), + extra_info: Some("Always renders at 2K and follows the aspect of the start frame or references.".to_string()), + selector_badges: strings(&["~5 min."]), + progress_bar_ms: 300_000, + supports_system_prompt: false, + text_prompt_max_length: Some(5_000), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + image_references_supported: true, + image_references_max: Some(9), + video_references_supported: true, + video_references_max: Some(3), + video_references_max_total_duration_seconds: Some(15), + audio_references_supported: true, + audio_references_max: Some(3), + audio_references_max_total_duration_seconds: Some(15), + duration_seconds_min: Some(5), + duration_seconds_max: Some(15), + duration_seconds_options: Some((5..=15).collect()), + duration_seconds_default: Some(5), + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/mod.rs b/crates/models/src/configs/video_models/by_type/mod.rs new file mode 100644 index 00000000..02906113 --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/mod.rs @@ -0,0 +1,10 @@ +pub mod beeble_video_models; +pub mod grok_video_models; +pub mod happy_horse_video_models; +pub mod kling_video_models; +pub mod minimax_video_models; +pub mod preview_video_models; +pub mod seedance_video_models; +pub mod sora_video_models; +pub mod veo_video_models; +pub mod vidu_video_models; diff --git a/crates/models/src/configs/video_models/by_type/preview_video_models.rs b/crates/models/src/configs/video_models/by_type/preview_video_models.rs new file mode 100644 index 00000000..a7fbe4ad --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/preview_video_models.rs @@ -0,0 +1,24 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +/// Unreleased preview models the router knows about. Hidden from the picker. +pub fn preview_video_models() -> Vec { + let preview = |model: VideoModel, full_name: &str| VideoModelConfig { + model, + model_creator: ModelCreator::ArtCraft, + full_name: full_name.to_string(), + selector_name: full_name.to_string(), + selector_description: "Preview".to_string(), + selector_badges: strings(&["Preview"]), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + is_disabled: true, + ..Default::default() + }; + vec![ + preview(VideoModel::PreviewModel, "Preview Model"), + preview(VideoModel::PreviewModelFast, "Preview Model Fast"), + ] +} diff --git a/crates/models/src/configs/video_models/by_type/seedance_video_models.rs b/crates/models/src/configs/video_models/by_type/seedance_video_models.rs new file mode 100644 index 00000000..0cf72c83 --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/seedance_video_models.rs @@ -0,0 +1,319 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_bitrate::CommonBitrate; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +const SEEDANCE_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::Square, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, +]; + +/// Bytedance Seedance video models: 2.5 (Higgsfield), the 2.0 family (with +/// references), 1.5 Pro, and 1.0 Lite. +pub fn seedance_video_models() -> Vec { + let mut models = Vec::new(); + + // Higgsfield-only. Same reference surface as 2.0, longer clips (up to 30s), + // and no 4K tier. + models.push(VideoModelConfig { + model: VideoModel::Seedance2p5, + model_creator: ModelCreator::Bytedance, + full_name: "Seedance 2.5".to_string(), + selector_name: "Seedance 2.5".to_string(), + selector_description: "Newest Seedance; up to 30 seconds".to_string(), + selector_badges: strings(&["~10 min."]), + progress_bar_ms: 600_000, + supports_system_prompt: false, + text_prompt_max_length: Some(10_000), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + image_references_supported: true, + image_references_max: Some(9), + video_references_supported: true, + video_references_max: Some(3), + video_references_max_total_duration_seconds: Some(15), + audio_references_supported: true, + audio_references_max: Some(3), + audio_references_max_total_duration_seconds: Some(15), + show_generate_with_sound_toggle: true, + aspect_ratio_options: SEEDANCE_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + bitrate_options: vec![CommonBitrate::Normal, CommonBitrate::High], + bitrate_default: Some(CommonBitrate::High), + duration_seconds_min: Some(4), + duration_seconds_max: Some(30), + duration_seconds_options: Some((4..=30).collect()), + duration_seconds_default: Some(5), + batch_size_max: 4, + batch_size_options: Some(vec![1, 2, 3, 4]), + batch_size_default: 1, + ..Default::default() + }); + + // Higgsfield-only. Video-to-video: the first video reference is the clip to + // edit; images and audio are extra references. Output keeps the source's + // length and framing, so there is no duration or aspect control. + models.push(VideoModelConfig { + model: VideoModel::Seedance2p5Edit, + model_creator: ModelCreator::Bytedance, + full_name: "Seedance 2.5 Edit".to_string(), + selector_name: "Seedance 2.5 Edit".to_string(), + selector_description: "Edit an existing video with a prompt".to_string(), + extra_info: Some("Video-to-video. Attach the clip to edit as a video reference; add image and audio references to guide the edit.".to_string()), + selector_badges: strings(&["~10 min."]), + progress_bar_ms: 600_000, + supports_system_prompt: false, + text_to_video_supported: false, + text_prompt_max_length: Some(10_000), + image_references_supported: true, + image_references_max: Some(9), + video_references_supported: true, + video_references_max: Some(1), + video_references_max_total_duration_seconds: Some(15), + audio_references_supported: true, + audio_references_max: Some(3), + audio_references_max_total_duration_seconds: Some(15), + show_generate_with_sound_toggle: true, + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + bitrate_options: vec![CommonBitrate::Normal, CommonBitrate::High], + bitrate_default: Some(CommonBitrate::High), + batch_size_max: 4, + batch_size_options: Some(vec![1, 2, 3, 4]), + batch_size_default: 1, + ..Default::default() + }); + + models.push(seedance_2p0( + VideoModel::Seedance2p0, + "Seedance 2.0", + "High quality model", + "~15 min.", + 900_000, + Some("The Chinese Volcengine (ByteDance China API platform) version of Seedance 2.0. Checkpoint is from January 2026. This may be better at some characters than the other Seedance models."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP, CommonResolution::FourK], + true, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0Fast, + "Seedance 2.0 Fast", + "Fast and high quality", + "~5 min.", + 300_000, + Some("The Chinese Volcengine (ByteDance China API platform) version of Seedance 2.0 Fast. Checkpoint is from January 2026. This may be better at some characters than the other Seedance models."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + true, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0BytePlus, + "Seedance 2.0 Plus", + "Seedance 2.0 (BytePlus version)", + "~15 min.", + 900_000, + Some("The Chinese BytePlus (ByteDance's Western API platform) version of Seedance 2.0. This has fewer restrictions on faces and IP."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP, CommonResolution::FourK], + false, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0BytePlusFast, + "Seedance 2.0 Plus Fast", + "Seedance 2.0 Fast (BytePlus version)", + "~5 min.", + 300_000, + Some("The Chinese BytePlus (ByteDance's Western API platform) version of Seedance 2.0 Fast. This has fewer restrictions on faces and IP."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + false, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0Ultra, + "Seedance 2.0 Ultra", + "Seedance 2.0; less filtered", + "~15 min.", + 900_000, + None, + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP, CommonResolution::FourK], + true, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0UltraFast, + "Seedance 2.0 Ultra Fast", + "Seedance 2.0 Fast; less filtered", + "~5 min.", + 300_000, + None, + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + true, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0BytePlusUltra, + "Seedance 2.0 Plus Ultra", + "Seedance 2.0 (BytePlus version); less filtered", + "~15 min.", + 900_000, + Some("This is the same BytePlus version of Seedance 2.0, but with even fewer restrictions around content. Horror movies, action movie violence, and more is possible."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP, CommonResolution::FourK], + false, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0BytePlusUltraFast, + "Seedance 2.0 Plus Ultra Fast", + "Seedance 2.0 Fast (BytePlus version); less filtered", + "~5 min.", + 300_000, + Some("This is the same BytePlus version of Seedance 2.0 Fast, but with even fewer restrictions around content. Horror movies, action movie violence, and more is possible."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + false, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0Mini, + "Seedance 2.0 Mini", + "Chinese Volcengine version", + "~5 min.", + 300_000, + Some("The Chinese Volcengine (ByteDance China API platform) version of Seedance 2.0 Mini. This may be better at some characters than the other Seedance models."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + true, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0BytePlusMini, + "Seedance 2.0 Plus Mini", + "BytePlus version", + "~5 min.", + 300_000, + Some("The Chinese BytePlus (ByteDance's Western API platform) version of Seedance 2.0 Mini. This has fewer restrictions on faces and IP."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + false, + )); + models.push(seedance_2p0( + VideoModel::Seedance2p0BytePlusUltraMini, + "Seedance 2.0 Plus Ultra Mini", + "BytePlus version; less filtered", + "~5 min.", + 300_000, + Some("This is the same BytePlus version of Seedance 2.0 Mini, but with even fewer restrictions around content. Horror movies, action movie violence, and more is possible."), + &[CommonResolution::FourEightyP, CommonResolution::SevenTwentyP], + false, + )); + + models.push(VideoModelConfig { + model: VideoModel::Seedance1p5Pro, + model_creator: ModelCreator::Bytedance, + full_name: "Seedance 1.5 Pro".to_string(), + selector_name: "Seedance 1.5 Pro".to_string(), + selector_description: "High quality video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 180_000, + supports_system_prompt: false, + starting_keyframe_supported: true, + ending_keyframe_supported: true, + show_generate_with_sound_toggle: true, + aspect_ratio_options: vec![ + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::Square, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::Auto, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(4), + duration_seconds_max: Some(12), + duration_seconds_options: Some((4..=12).collect()), + duration_seconds_default: Some(5), + ..Default::default() + }); + + models.push(VideoModelConfig { + model: VideoModel::Seedance10Lite, + model_creator: ModelCreator::Bytedance, + full_name: "Seedance 1.0 Lite".to_string(), + selector_name: "Seedance 1.0 Lite".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + aspect_ratio_options: vec![ + CommonAspectRatio::Auto, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::Square, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::TallNineBySixteen, + ], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_options: Some(vec![5, 10]), + duration_seconds_default: Some(5), + ..Default::default() + }); + + models +} + +/// The Seedance 2.0 family shares one capability surface: keyframes, image / +/// video / audio (and sometimes character) references, bitrate, and batches. +fn seedance_2p0( + model: VideoModel, + full_name: &str, + description: &str, + badge: &str, + progress_bar_ms: u32, + extra_info: Option<&str>, + resolutions: &[CommonResolution], + character_references_supported: bool, +) -> VideoModelConfig { + VideoModelConfig { + model, + model_creator: ModelCreator::Bytedance, + full_name: full_name.to_string(), + selector_name: full_name.to_string(), + selector_description: description.to_string(), + extra_info: extra_info.map(|s| s.to_string()), + selector_badges: strings(&[badge]), + progress_bar_ms, + supports_system_prompt: false, + text_prompt_max_length: Some(10_000), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + image_references_supported: true, + image_references_max: Some(9), + video_references_supported: true, + video_references_max: Some(3), + video_references_max_total_duration_seconds: Some(15), + audio_references_supported: true, + audio_references_max: Some(3), + audio_references_max_total_duration_seconds: Some(15), + character_references_supported, + character_references_max: Some(9), + aspect_ratio_options: SEEDANCE_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: resolutions.to_vec(), + resolution_default: Some(CommonResolution::SevenTwentyP), + bitrate_options: vec![CommonBitrate::Normal, CommonBitrate::High], + bitrate_default: Some(CommonBitrate::Normal), + duration_seconds_min: Some(4), + duration_seconds_max: Some(15), + duration_seconds_options: Some((4..=15).collect()), + duration_seconds_default: Some(5), + batch_size_max: 4, + batch_size_options: Some(vec![1, 2, 3, 4]), + batch_size_default: 1, + ..Default::default() + } +} diff --git a/crates/models/src/configs/video_models/by_type/sora_video_models.rs b/crates/models/src/configs/video_models/by_type/sora_video_models.rs new file mode 100644 index 00000000..9291620a --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/sora_video_models.rs @@ -0,0 +1,45 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::legacy_video_size::LegacyVideoSize; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +/// Sora (OpenAI) video models. The prompt box sends their size as +/// `sora_orientation` (landscape / portrait). +pub fn sora_video_models() -> Vec { + vec![ + VideoModelConfig { + model: VideoModel::Sora2, + model_creator: ModelCreator::OpenAi, + full_name: "Sora 2".to_string(), + selector_name: "Sora 2".to_string(), + selector_description: "Smart video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(2000), + legacy_size_options: vec![LegacyVideoSize::Landscape, LegacyVideoSize::Portrait], + resolution_options: vec![CommonResolution::SevenTwentyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_options: Some(vec![4, 8, 12]), + duration_seconds_default: Some(4), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Sora2Pro, + model_creator: ModelCreator::OpenAi, + full_name: "Sora 2 Pro".to_string(), + selector_name: "Sora 2 Pro".to_string(), + selector_description: "Smart video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(2000), + legacy_size_options: vec![LegacyVideoSize::Landscape, LegacyVideoSize::Portrait], + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::TenEightyP), + duration_seconds_options: Some(vec![4, 8, 12]), + duration_seconds_default: Some(4), + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/veo_video_models.rs b/crates/models/src/configs/video_models/by_type/veo_video_models.rs new file mode 100644 index 00000000..fd52db3c --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/veo_video_models.rs @@ -0,0 +1,154 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +const VEO_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Auto, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallNineBySixteen, +]; + +/// Google Veo video models. +pub fn veo_video_models() -> Vec { + vec![ + VideoModelConfig { + model: VideoModel::Veo3p1, + model_creator: ModelCreator::Google, + full_name: "Google Veo 3.1".to_string(), + selector_name: "Google Veo 3.1".to_string(), + selector_description: "Slow, high-quality model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + ending_keyframe_supported: true, + image_references_supported: true, + image_references_max: Some(3), + video_references_supported: true, + video_references_max: Some(1), + show_generate_with_sound_toggle: true, + aspect_ratio_options: VEO_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP, CommonResolution::FourK], + resolution_default: Some(CommonResolution::TenEightyP), + duration_seconds_min: Some(4), + duration_seconds_max: Some(8), + duration_seconds_default: Some(8), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Veo3p1Fast, + model_creator: ModelCreator::Google, + full_name: "Google Veo 3.1 Fast".to_string(), + selector_name: "Google Veo 3.1 Fast".to_string(), + selector_description: "High-quality model (faster)".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + ending_keyframe_supported: true, + image_references_supported: true, + image_references_max: Some(3), + video_references_supported: true, + video_references_max: Some(1), + show_generate_with_sound_toggle: true, + aspect_ratio_options: VEO_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP, CommonResolution::FourK], + resolution_default: Some(CommonResolution::TenEightyP), + duration_seconds_min: Some(4), + duration_seconds_max: Some(8), + duration_seconds_default: Some(8), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Veo3p1Lite, + model_creator: ModelCreator::Google, + full_name: "Google Veo 3.1 Lite".to_string(), + selector_name: "Google Veo 3.1 Lite".to_string(), + selector_description: "Cheaper, lighter Veo".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + show_generate_with_sound_toggle: true, + aspect_ratio_options: VEO_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(4), + duration_seconds_max: Some(8), + duration_seconds_default: Some(8), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Veo3Fast, + model_creator: ModelCreator::Google, + full_name: "Google Veo 3 Fast".to_string(), + selector_name: "Google Veo 3 Fast".to_string(), + selector_description: "High-quality model (faster)".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + show_generate_with_sound_toggle: true, + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::TenEightyP), + duration_seconds_min: Some(4), + duration_seconds_max: Some(8), + duration_seconds_default: Some(8), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Veo3, + model_creator: ModelCreator::Google, + full_name: "Google Veo 3".to_string(), + selector_name: "Google Veo 3".to_string(), + selector_description: "Slow, high-quality model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + show_generate_with_sound_toggle: true, + aspect_ratio_options: vec![CommonAspectRatio::WideSixteenByNine, CommonAspectRatio::TallNineBySixteen, CommonAspectRatio::Auto], + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::TenEightyP), + duration_seconds_min: Some(4), + duration_seconds_max: Some(8), + duration_seconds_default: Some(8), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::Veo2, + model_creator: ModelCreator::Google, + full_name: "Google Veo 2".to_string(), + selector_name: "Google Veo 2".to_string(), + selector_description: "Fast video model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 100_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + starting_keyframe_required: true, + text_to_video_supported: false, + aspect_ratio_options: VEO_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + duration_seconds_min: Some(5), + duration_seconds_max: Some(8), + duration_seconds_default: Some(5), + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/by_type/vidu_video_models.rs b/crates/models/src/configs/video_models/by_type/vidu_video_models.rs new file mode 100644 index 00000000..5fdb9493 --- /dev/null +++ b/crates/models/src/configs/video_models/by_type/vidu_video_models.rs @@ -0,0 +1,64 @@ +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::strings; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::model_creator::ModelCreator; +use crate::enums::video_model::VideoModel; + +const VIDU_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::Square, +]; + +/// Vidu (Shengshu) video models. +pub fn vidu_video_models() -> Vec { + vec![ + VideoModelConfig { + model: VideoModel::ViduQ3, + model_creator: ModelCreator::Vidu, + full_name: "Vidu Q3".to_string(), + selector_name: "Vidu Q3".to_string(), + selector_description: "High-quality model".to_string(), + selector_badges: strings(&["2 min."]), + progress_bar_ms: 120_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + image_references_supported: true, + image_references_max: Some(4), + show_generate_with_sound_toggle: true, + aspect_ratio_options: VIDU_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(1), + duration_seconds_max: Some(16), + duration_seconds_default: Some(5), + ..Default::default() + }, + VideoModelConfig { + model: VideoModel::ViduQ3Turbo, + model_creator: ModelCreator::Vidu, + full_name: "Vidu Q3 Turbo".to_string(), + selector_name: "Vidu Q3 Turbo".to_string(), + selector_description: "High-quality model (faster)".to_string(), + selector_badges: strings(&["90 sec."]), + progress_bar_ms: 90_000, + text_prompt_max_length: Some(5000), + starting_keyframe_supported: true, + ending_keyframe_supported: true, + show_generate_with_sound_toggle: true, + aspect_ratio_options: VIDU_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(1), + duration_seconds_max: Some(16), + duration_seconds_default: Some(5), + ..Default::default() + }, + ] +} diff --git a/crates/models/src/configs/video_models/mod.rs b/crates/models/src/configs/video_models/mod.rs new file mode 100644 index 00000000..d5ea4915 --- /dev/null +++ b/crates/models/src/configs/video_models/mod.rs @@ -0,0 +1,87 @@ +//! The built-in video model table, grouped by family. Picker order = table order. + +use crate::configs::video_model_config::VideoModelConfig; +use crate::enums::video_model::VideoModel; +use once_cell::sync::Lazy; + +mod by_type; + +pub static VIDEO_MODELS: Lazy> = Lazy::new(video_models); + +/// Look up one model's config. +pub fn video_model_config(model: VideoModel) -> &'static VideoModelConfig { + VIDEO_MODELS.iter() + .find(|config| config.model == model) + .expect("every VideoModel variant has a config (see tests)") +} + +fn video_models() -> Vec { + let mut models = Vec::new(); + + models.extend(by_type::seedance_video_models::seedance_video_models()); + models.extend(by_type::kling_video_models::kling_video_models()); + models.extend(by_type::veo_video_models::veo_video_models()); + models.extend(by_type::vidu_video_models::vidu_video_models()); + models.extend(by_type::happy_horse_video_models::happy_horse_video_models()); + models.extend(by_type::minimax_video_models::minimax_video_models()); + models.extend(by_type::sora_video_models::sora_video_models()); + models.extend(by_type::grok_video_models::grok_video_models()); + models.extend(by_type::beeble_video_models::beeble_video_models()); + models.extend(by_type::preview_video_models::preview_video_models()); + + models +} + +pub(crate) fn strings(items: &[&str]) -> Vec { + items.iter().map(|s| s.to_string()).collect() +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashSet; + use strum::IntoEnumIterator; + + #[test] + fn every_model_has_exactly_one_config() { + let listed: Vec = VIDEO_MODELS.iter().map(|c| c.model).collect(); + let unique: HashSet = listed.iter().copied().collect(); + assert_eq!(listed.len(), unique.len(), "duplicate video model configs"); + for model in VideoModel::iter() { + assert!(unique.contains(&model), "no config for {model:?}"); + } + } + + #[test] + fn defaults_are_within_their_options() { + for config in VIDEO_MODELS.iter() { + assert!(!config.full_name.is_empty() && !config.selector_name.is_empty(), "{:?} needs names", config.model); + assert!( + config.aspect_ratio_options.is_empty() || config.legacy_size_options.is_empty(), + "{:?} must use either aspect ratios or legacy sizes, not both", config.model, + ); + if let Some(default) = config.aspect_ratio_default { + assert!(config.aspect_ratio_options.contains(&default), "{:?} aspect default not offered", config.model); + } + if let Some(default) = config.resolution_default { + assert!(config.resolution_options.contains(&default), "{:?} resolution default not offered", config.model); + } + if let (Some(default), Some(options)) = (config.duration_seconds_default, &config.duration_seconds_options) { + assert!(options.contains(&default), "{:?} duration default not offered", config.model); + } + if let (Some(default), Some(min), Some(max)) = (config.duration_seconds_default, config.duration_seconds_min, config.duration_seconds_max) { + assert!(min <= default && default <= max, "{:?} duration default out of range", config.model); + } + if config.starting_keyframe_required { + assert!(config.starting_keyframe_supported, "{:?} requires a keyframe it doesn't support", config.model); + } + } + } + + #[test] + fn serializes_with_string_ids() { + let json = serde_json::to_value(video_model_config(VideoModel::GrokImagineVideo)).unwrap(); + assert_eq!(json["model"], "grok_imagine_video"); + assert_eq!(json["legacy_size_options"], serde_json::json!(["landscape", "portrait", "square"])); + } +} diff --git a/crates/models/src/enums/audio_model.rs b/crates/models/src/enums/audio_model.rs new file mode 100644 index 00000000..c38371da --- /dev/null +++ b/crates/models/src/enums/audio_model.rs @@ -0,0 +1,18 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Every audio model ArtCraftX knows about. The serde form is the model id +/// the frontend sends on `generate_audio_command` (1:1 with the router's ids). +#[cfg_attr(test, derive(strum::EnumIter))] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum AudioModel { + #[serde(rename = "suno_music")] + SunoMusic, + #[serde(rename = "suno_remix")] + SunoRemix, + #[serde(rename = "suno_sounds")] + SunoSounds, + #[serde(rename = "suno_sample")] + SunoSample, + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, +} diff --git a/crates/models/src/enums/common_aspect_ratio.rs b/crates/models/src/enums/common_aspect_ratio.rs new file mode 100644 index 00000000..3cc2754d --- /dev/null +++ b/crates/models/src/enums/common_aspect_ratio.rs @@ -0,0 +1,33 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Aspect ratios a model can be asked for. Not every model supports every +/// value; a model's config lists its own. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonAspectRatio { + /// Let the model decide (e.g. follow the source image when editing). + Auto, + Square, + WideThreeByTwo, + WideFourByThree, + WideFiveByFour, + WideSixteenByNine, + WideTwentyOneByNine, + TallTwoByThree, + TallThreeByFour, + TallFourByFive, + TallNineBySixteen, + TallNineByTwentyOne, + /// Imprecise semantic values some models map to their own sizes. + Wide, + Tall, + /// Auto aspect at a baked-in resolution. + #[serde(rename = "auto_2k")] + Auto2k, + #[serde(rename = "auto_3k")] + Auto3k, + #[serde(rename = "auto_4k")] + Auto4k, + /// Square at a baked-in HD resolution. + SquareHd, +} diff --git a/crates/models/src/enums/common_bitrate.rs b/crates/models/src/enums/common_bitrate.rs new file mode 100644 index 00000000..fc07b506 --- /dev/null +++ b/crates/models/src/enums/common_bitrate.rs @@ -0,0 +1,9 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Video bitrate tiers (Seedance 2.0). +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonBitrate { + Normal, + High, +} diff --git a/crates/models/src/enums/common_mesh_output_type.rs b/crates/models/src/enums/common_mesh_output_type.rs new file mode 100644 index 00000000..4b322042 --- /dev/null +++ b/crates/models/src/enums/common_mesh_output_type.rs @@ -0,0 +1,10 @@ +use serde_derive::{Deserialize, Serialize}; + +/// What a mesh model can emit. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonMeshOutputType { + Normal, + LowPoly, + Geometry, +} diff --git a/crates/models/src/enums/common_polygon_type.rs b/crates/models/src/enums/common_polygon_type.rs new file mode 100644 index 00000000..a9741d29 --- /dev/null +++ b/crates/models/src/enums/common_polygon_type.rs @@ -0,0 +1,9 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Mesh polygon types a model can be asked for. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonPolygonType { + Triangle, + Quad, +} diff --git a/crates/models/src/enums/common_quality.rs b/crates/models/src/enums/common_quality.rs new file mode 100644 index 00000000..f5a149e5 --- /dev/null +++ b/crates/models/src/enums/common_quality.rs @@ -0,0 +1,10 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Quality tiers (used by the OpenAI image models). +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonQuality { + High, + Medium, + Low, +} diff --git a/crates/models/src/enums/common_resolution.rs b/crates/models/src/enums/common_resolution.rs new file mode 100644 index 00000000..c3e34961 --- /dev/null +++ b/crates/models/src/enums/common_resolution.rs @@ -0,0 +1,16 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Output resolutions. Image models use the `*K` tiers; video models use the +/// `*P` tiers (plus 2K/4K where offered). +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum CommonResolution { + HalfK, + OneK, + TwoK, + ThreeK, + FourK, + FourEightyP, + SevenTwentyP, + TenEightyP, +} diff --git a/crates/models/src/enums/generation_provider.rs b/crates/models/src/enums/generation_provider.rs new file mode 100644 index 00000000..6e4adc64 --- /dev/null +++ b/crates/models/src/enums/generation_provider.rs @@ -0,0 +1,31 @@ +use serde_derive::{Deserialize, Serialize}; + +/// A service that can run a generation. What the picker offers next to a +/// model (and what the frontend sends as `provider`). +/// +/// This is the user-facing provider set; the router's `RouterProvider` is +/// the dispatch-level set (it also has `GrokApi`, `GmiCloud`, `Seedance2Pro`). +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum GenerationProvider { + Artcraft, + Fal, + /// First-party (cookie-session) Grok. + Grok, + /// First-party (cookie-session) Higgsfield. + Higgsfield, + /// First-party (cookie-session) Midjourney. + Midjourney, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn serializes_to_frontend_values() { + assert_eq!(serde_json::to_string(&GenerationProvider::Artcraft).unwrap(), "\"artcraft\""); + assert_eq!(serde_json::to_string(&GenerationProvider::Higgsfield).unwrap(), "\"higgsfield\""); + assert_eq!(serde_json::from_str::("\"higgsfield\"").unwrap(), GenerationProvider::Higgsfield); + } +} diff --git a/crates/models/src/enums/image_model.rs b/crates/models/src/enums/image_model.rs new file mode 100644 index 00000000..c072fb51 --- /dev/null +++ b/crates/models/src/enums/image_model.rs @@ -0,0 +1,88 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Every image model ArtCraftX knows about. The serde form is the model id +/// the frontend sends on `generate_image_command` (and the router's ids). +/// +/// Roughly 1:1 with `router::api::RouterImageModel`, plus the desktop-only +/// editing / inpainting models the router doesn't dispatch. +#[cfg_attr(test, derive(strum::EnumIter))] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum ImageModel { + // ── Black Forest Labs ── + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_pro_1p1")] + FluxPro11, + #[serde(rename = "flux_pro_1p1_ultra")] + FluxPro11Ultra, + #[serde(rename = "flux_pro_kontext_max")] + FluxProKontextMax, + /// Inpainting. + #[serde(rename = "flux_pro_1")] + FluxPro1, + /// Inpainting. + #[serde(rename = "flux_dev_juggernaut")] + FluxDevJuggernaut, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, + // ── OpenAI ── + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + // ── Grok (first-party imagine) ── + #[serde(rename = "grok_imagine_image")] + GrokImagineImage, + #[serde(rename = "grok_imagine_image_q")] + GrokImagineImageQuality, + // ── Midjourney ── + #[serde(rename = "midjourney_7")] + Midjourney7, + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + #[serde(rename = "midjourney_8")] + Midjourney8, + // ── Google ── + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + /// Higgsfield's Nano Banana 2 Lite pipeline (quality tiers instead of a + /// resolution menu). + #[serde(rename = "nano_banana_2_lite")] + NanoBanana2Lite, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + // ── Bytedance ── + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + // ── Alibaba ── + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn ids_match_the_router_and_frontend() { + assert_eq!(serde_json::to_string(&ImageModel::FluxPro11).unwrap(), "\"flux_pro_1p1\""); + assert_eq!(serde_json::to_string(&ImageModel::GrokImagineImageQuality).unwrap(), "\"grok_imagine_image_q\""); + assert_eq!(serde_json::to_string(&ImageModel::Seedream5p0ProUltra).unwrap(), "\"seedream_5p0_pro_u\""); + assert_eq!(serde_json::from_str::("\"flux_pro_1\"").unwrap(), ImageModel::FluxPro1); + assert_eq!(serde_json::to_string(&ImageModel::NanoBanana2Lite).unwrap(), "\"nano_banana_2_lite\""); + } +} diff --git a/crates/models/src/enums/legacy_video_size.rs b/crates/models/src/enums/legacy_video_size.rs new file mode 100644 index 00000000..2ec5b4bd --- /dev/null +++ b/crates/models/src/enums/legacy_video_size.rs @@ -0,0 +1,12 @@ +use serde_derive::{Deserialize, Serialize}; + +/// The coarse size vocabulary of the first-party Grok and Sora video paths, +/// which predate [`CommonAspectRatio`](super::common_aspect_ratio::CommonAspectRatio). +/// The frontend sends these as `grok_aspect_ratio` / `sora_orientation`. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum LegacyVideoSize { + Landscape, + Portrait, + Square, +} diff --git a/crates/models/src/enums/mesh_model.rs b/crates/models/src/enums/mesh_model.rs new file mode 100644 index 00000000..563ea962 --- /dev/null +++ b/crates/models/src/enums/mesh_model.rs @@ -0,0 +1,30 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Every 3D mesh model ArtCraftX knows about. The serde form is the model id +/// the frontend sends on `generate_mesh_command` (1:1 with the router's ids). +#[cfg_attr(test, derive(strum::EnumIter))] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum MeshModel { + #[serde(rename = "hunyuan_3d_2p0")] + Hunyuan3d2p0, + #[serde(rename = "hunyuan_3d_2p1")] + Hunyuan3d2p1, + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + #[serde(rename = "hunyuan_3d_3_sketch")] + Hunyuan3d3Sketch, + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3p1Pro, + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3p1Rapid, + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3p1Part, + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3p1SmartTopology, + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3p1, + #[serde(rename = "meshy_v6")] + MeshyV6, + #[serde(rename = "rodin_2p5_fast")] + Rodin2p5Fast, +} diff --git a/crates/models/src/enums/mod.rs b/crates/models/src/enums/mod.rs new file mode 100644 index 00000000..c53edde7 --- /dev/null +++ b/crates/models/src/enums/mod.rs @@ -0,0 +1,15 @@ +pub mod audio_model; +pub mod common_aspect_ratio; +pub mod common_bitrate; +pub mod common_mesh_output_type; +pub mod common_polygon_type; +pub mod common_quality; +pub mod common_resolution; +pub mod generation_provider; +pub mod image_model; +pub mod legacy_video_size; +pub mod mesh_model; +pub mod model_creator; +pub mod model_tag; +pub mod splat_model; +pub mod video_model; diff --git a/crates/models/src/enums/model_creator.rs b/crates/models/src/enums/model_creator.rs new file mode 100644 index 00000000..6ef904b3 --- /dev/null +++ b/crates/models/src/enums/model_creator.rs @@ -0,0 +1,50 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Who made a model (for icons and grouping in the picker). +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum ModelCreator { + /// Qwen, Wan, Happy Horse + Alibaba, + #[serde(rename = "artcraft")] + ArtCraft, + Beeble, + BlackForestLabs, + Bytedance, + /// Rodin + Deemos, + Fal, + Google, + Grok, + Hailuo, + Higgsfield, + Kling, + Krea, + Meshy, + Midjourney, + OpenAi, + OpenArt, + Recraft, + Replicate, + Runway, + Stability, + Suno, + /// Hunyuan + Tencent, + TensorArt, + Tripo, + Vidu, + WorldLabs, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn serializes_to_snake_case() { + assert_eq!(serde_json::to_string(&ModelCreator::BlackForestLabs).unwrap(), "\"black_forest_labs\""); + assert_eq!(serde_json::to_string(&ModelCreator::ArtCraft).unwrap(), "\"artcraft\""); + assert_eq!(serde_json::to_string(&ModelCreator::OpenAi).unwrap(), "\"open_ai\""); + } +} diff --git a/crates/models/src/enums/model_tag.rs b/crates/models/src/enums/model_tag.rs new file mode 100644 index 00000000..489e21cc --- /dev/null +++ b/crates/models/src/enums/model_tag.rs @@ -0,0 +1,24 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Filterable capability tags the frontend uses to pick which models appear +/// in which editor. Serialized in camelCase to match the frontend's values. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub enum ModelTag { + /// Shows up in the 2D and 3D editors. + InstructiveEdit, + /// Shows up in the inpainting editor and uses a mask. + MaskedInpainting, + /// Shows up in the inpainting editor without a mask. + NonMaskedInpainting, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn serializes_to_camel_case() { + assert_eq!(serde_json::to_string(&ModelTag::InstructiveEdit).unwrap(), "\"instructiveEdit\""); + } +} diff --git a/crates/models/src/enums/splat_model.rs b/crates/models/src/enums/splat_model.rs new file mode 100644 index 00000000..ce80fbda --- /dev/null +++ b/crates/models/src/enums/splat_model.rs @@ -0,0 +1,23 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Every Gaussian splat ("world") model ArtCraftX knows about. The serde form +/// is the model id the frontend sends on `generate_splat_command` (1:1 with +/// the router's ids). +#[cfg_attr(test, derive(strum::EnumIter))] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum SplatModel { + #[serde(rename = "marble_0p1_mini")] + Marble0p1Mini, + #[serde(rename = "marble_0p1_plus")] + Marble0p1Plus, + #[serde(rename = "marble_1p0")] + Marble1p0, + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + #[serde(rename = "marble_1p1")] + Marble1p1, + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + #[serde(rename = "triposplat")] + TripoSplat, +} diff --git a/crates/models/src/enums/video_model.rs b/crates/models/src/enums/video_model.rs new file mode 100644 index 00000000..51403835 --- /dev/null +++ b/crates/models/src/enums/video_model.rs @@ -0,0 +1,118 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Every video model ArtCraftX knows about. The serde form is the model id +/// the frontend sends on `generate_video_command` (and the router's ids). +/// +/// Roughly 1:1 with `router::api::RouterVideoModel`, plus desktop-only +/// models (Beeble SwitchX). +#[cfg_attr(test, derive(strum::EnumIter))] +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum VideoModel { + // ── Grok ── + /// First-party Grok Imagine video (cookie session). + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + // ── Kling ── + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + #[serde(rename = "kling_2p1_master")] + Kling21Master, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + // ── Bytedance ── + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + #[serde(rename = "seedance_2p0")] + Seedance2p0, + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + #[serde(rename = "seedance_2p0_bp_mini")] + Seedance2p0BytePlusMini, + #[serde(rename = "seedance_2p0_bpu_mini")] + Seedance2p0BytePlusUltraMini, + #[serde(rename = "seedance_2p5")] + Seedance2p5, + /// Seedance 2.5 video-to-video editing: rewrites a source video clip. + #[serde(rename = "seedance_2p5_edit")] + Seedance2p5Edit, + // ── MiniMax (Hailuo) ── + #[serde(rename = "minimax_h3")] + MinimaxH3, + // ── Alibaba ── + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + // ── OpenAI ── + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + // ── Google ── + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + // ── Vidu ── + #[serde(rename = "vidu_q3")] + ViduQ3, + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, + // ── Beeble ── + /// Background change / relighting VFX. + #[serde(rename = "switch_x")] + SwitchX, + // ── Preview ── + #[serde(rename = "preview_model")] + PreviewModel, + #[serde(rename = "preview_model_fast")] + PreviewModelFast, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn ids_match_the_router_and_frontend() { + assert_eq!(serde_json::to_string(&VideoModel::Kling16Pro).unwrap(), "\"kling_1p6_pro\""); + assert_eq!(serde_json::to_string(&VideoModel::Seedance10Lite).unwrap(), "\"seedance_1p0_lite\""); + assert_eq!(serde_json::to_string(&VideoModel::Seedance2p0BytePlusUltraMini).unwrap(), "\"seedance_2p0_bpu_mini\""); + assert_eq!(serde_json::from_str::("\"switch_x\"").unwrap(), VideoModel::SwitchX); + assert_eq!(serde_json::to_string(&VideoModel::Seedance2p5).unwrap(), "\"seedance_2p5\""); + assert_eq!(serde_json::to_string(&VideoModel::Seedance2p5Edit).unwrap(), "\"seedance_2p5_edit\""); + assert_eq!(serde_json::to_string(&VideoModel::MinimaxH3).unwrap(), "\"minimax_h3\""); + } +} diff --git a/crates/models/src/lib.rs b/crates/models/src/lib.rs new file mode 100644 index 00000000..b7ba0a32 --- /dev/null +++ b/crates/models/src/lib.rs @@ -0,0 +1,24 @@ +//! # models +//! +//! The single source of truth for every generation model ArtCraftX knows +//! about — image, video, mesh, splat, and audio — and what each one can do. +//! +//! - [`enums`]: the model identifiers (one enum per modality), plus the +//! shared vocabulary they're described with (providers, creators, aspect +//! ratios, resolutions, ...). These are first-party types: nothing here +//! depends on a third-party API client or on the router. +//! - [`configs`]: one config struct per modality describing capabilities +//! (what inputs/options a model accepts) and desktop presentation (picker +//! copy, badges, which providers can run it, which pages show it), and the +//! built-in tables of every model. +//! - [`providers`]: which providers (services) offer which models, with room +//! for per-provider overrides. +//! +//! The Tauri list commands serve these tables to the frontend verbatim, so +//! the wire format is the serde form of the structs in [`configs`]. Enum +//! serializations are the identifiers the frontend sends back on generate +//! requests — NEVER change an existing one; only add. + +pub mod configs; +pub mod enums; +pub mod providers; diff --git a/crates/models/src/providers/audio_providers.rs b/crates/models/src/providers/audio_providers.rs new file mode 100644 index 00000000..2d11db41 --- /dev/null +++ b/crates/models/src/providers/audio_providers.rs @@ -0,0 +1,45 @@ +//! Which providers offer which audio models: ArtCraft only. + +use crate::configs::audio_model_config::AudioModelConfig; +use crate::enums::audio_model::AudioModel; +use crate::enums::generation_provider::GenerationProvider; +use crate::providers::provider_offering::{is_offered, providers_for_model, ProviderOffering}; +use once_cell::sync::Lazy; + +pub type AudioProviderOffering = ProviderOffering; + +pub static AUDIO_PROVIDERS: Lazy> = Lazy::new(audio_providers); + +pub fn providers_for_audio_model(model: AudioModel) -> Vec { + providers_for_model(&AUDIO_PROVIDERS, model) +} + +pub fn provider_offers_audio_model(provider: GenerationProvider, model: AudioModel) -> bool { + is_offered(&AUDIO_PROVIDERS, provider, model) +} + +fn audio_providers() -> Vec { + vec![ + AudioProviderOffering::of(GenerationProvider::Artcraft, &[ + AudioModel::SunoMusic, + AudioModel::SunoRemix, + AudioModel::SunoSounds, + AudioModel::SunoSample, + AudioModel::SeedAudio1p0, + ]), + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::configs::audio_models::AUDIO_MODELS; + use crate::providers::tests_common::check_offerings; + + #[test] + fn offerings_are_consistent_with_the_model_table() { + let known: Vec = AUDIO_MODELS.iter().filter(|c| !c.is_disabled).map(|c| c.model).collect(); + check_offerings(&AUDIO_PROVIDERS, &known, |config| config.model); + assert_eq!(AUDIO_PROVIDERS.len(), 1, "audio is ArtCraft-only"); + } +} diff --git a/crates/models/src/providers/higgsfield_image_offering.rs b/crates/models/src/providers/higgsfield_image_offering.rs new file mode 100644 index 00000000..a5d205ee --- /dev/null +++ b/crates/models/src/providers/higgsfield_image_offering.rs @@ -0,0 +1,234 @@ +//! The image models a first-party (cookie-session) Higgsfield account runs, +//! and how their option menus differ from the base table. +//! +//! Option sets mirror the higgsfield.ai image generator (read off the web app +//! on 2026-08-31, see `higgsfield_client::endpoints::generate::image`). Where +//! Higgsfield offers fewer choices than ArtCraft the override narrows the +//! menu so the picker only shows what the account can actually run, and the +//! router snaps anything else to the nearest tier. + +use crate::configs::image_model_config::ImageModelConfig; +use crate::configs::image_models::image_model_config; +use crate::enums::common_aspect_ratio::CommonAspectRatio; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::generation_provider::GenerationProvider; +use crate::enums::image_model::ImageModel; +use crate::providers::image_providers::ImageProviderOffering; +use crate::providers::provider_offering::OfferedModel; + +/// Higgsfield caps every image batch at 4. +pub const HIGGSFIELD_IMAGE_BATCH_MAX: u16 = 4; + +/// Higgsfield's Nano Banana Pro / 2 / 2 Lite and GPT Image 2 aspect menu +/// (Nano Banana adds 5:4 and 4:5). +const NANO_BANANA_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Auto, + CommonAspectRatio::Square, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideFiveByFour, + CommonAspectRatio::TallFourByFive, + CommonAspectRatio::WideTwentyOneByNine, +]; + +const GPT_IMAGE_2_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Auto, + CommonAspectRatio::Square, + CommonAspectRatio::WideThreeByTwo, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::WideTwentyOneByNine, +]; + +/// Higgsfield's Seedream menu: no Auto and no baked-in-resolution values. +const SEEDREAM_ASPECT_RATIOS: &[CommonAspectRatio] = &[ + CommonAspectRatio::Square, + CommonAspectRatio::WideFourByThree, + CommonAspectRatio::TallThreeByFour, + CommonAspectRatio::WideSixteenByNine, + CommonAspectRatio::WideTwentyOneByNine, + CommonAspectRatio::TallNineBySixteen, + CommonAspectRatio::TallTwoByThree, + CommonAspectRatio::WideThreeByTwo, +]; + +/// Every image model Higgsfield offers, in picker order. +pub const HIGGSFIELD_IMAGE_MODELS: &[ImageModel] = &[ + ImageModel::NanoBananaPro, + ImageModel::NanoBanana2, + ImageModel::NanoBanana2Lite, + ImageModel::GptImage2, + ImageModel::Seedream5p0Pro, + ImageModel::Seedream5Lite, + ImageModel::Seedream4p5, +]; + +pub fn higgsfield_image_offering() -> ImageProviderOffering { + ImageProviderOffering { + provider: GenerationProvider::Higgsfield, + models: HIGGSFIELD_IMAGE_MODELS.iter().copied().map(offered).collect(), + } +} + +/// The base config, or a Higgsfield-specific replacement when the menus +/// differ. Every override starts from the base so presentation stays in sync. +fn offered(model: ImageModel) -> OfferedModel { + let base = image_model_config(model).clone(); + let overrides = match model { + // Nano Banana Pro: the same 11 ratios, 1K / 2K / 4K, up to 4 images. + ImageModel::NanoBananaPro => None, + // Nano Banana 2: no 0.5K tier on Higgsfield. + ImageModel::NanoBanana2 => Some(ImageModelConfig { + aspect_ratio_options: NANO_BANANA_ASPECT_RATIOS.to_vec(), + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK, CommonResolution::FourK], + ..capped(base) + }), + // Higgsfield-only: the base config already describes it. + ImageModel::NanoBanana2Lite => None, + // GPT Image 2: no "1:1 HD", no 3K. + ImageModel::GptImage2 => Some(ImageModelConfig { + aspect_ratio_options: GPT_IMAGE_2_ASPECT_RATIOS.to_vec(), + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK, CommonResolution::FourK], + ..capped(base) + }), + // Seedream 5.0 Pro: no Auto ratio; 1K / 2K (Higgsfield's 1.5K has no + // common tier); batches of 4, not 8. + ImageModel::Seedream5p0Pro => Some(ImageModelConfig { + aspect_ratio_options: SEEDREAM_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::Square), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::Square), + resolution_options: vec![CommonResolution::OneK, CommonResolution::TwoK], + resolution_default: Some(CommonResolution::OneK), + ..capped(base) + }), + // Seedream 5 Lite: a real resolution menu (2K / 3K / 4K) instead of the + // baked-in "auto_2k" style ratios. + ImageModel::Seedream5Lite => Some(ImageModelConfig { + aspect_ratio_options: SEEDREAM_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::TwoK, CommonResolution::ThreeK, CommonResolution::FourK], + resolution_default: Some(CommonResolution::TwoK), + ..capped(base) + }), + // Seedream 4.5: likewise, 2K / 4K. + ImageModel::Seedream4p5 => Some(ImageModelConfig { + aspect_ratio_options: SEEDREAM_ASPECT_RATIOS.to_vec(), + aspect_ratio_default: Some(CommonAspectRatio::WideSixteenByNine), + aspect_ratio_default_when_editing: Some(CommonAspectRatio::WideSixteenByNine), + resolution_options: vec![CommonResolution::TwoK, CommonResolution::FourK], + resolution_default: Some(CommonResolution::TwoK), + ..capped(base) + }), + other => unreachable!("{other:?} is not a Higgsfield image model"), + }; + match overrides { + Some(overrides) => OfferedModel::with_overrides(model, overrides), + None => OfferedModel::same_as_base(model), + } +} + +/// Apply the batch cap every Higgsfield image model shares. +fn capped(base: ImageModelConfig) -> ImageModelConfig { + ImageModelConfig { + batch_size_max: HIGGSFIELD_IMAGE_BATCH_MAX, + batch_size_options: None, + batch_size_default: base.batch_size_default.min(HIGGSFIELD_IMAGE_BATCH_MAX), + ..base + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::providers::image_providers::{provider_offers_image_model, providers_for_image_model, IMAGE_PROVIDERS}; + use crate::providers::provider_offering::effective_config; + + fn effective(model: ImageModel) -> ImageModelConfig { + effective_config(&IMAGE_PROVIDERS, GenerationProvider::Higgsfield, model, image_model_config(model)).clone() + } + + #[test] + fn offers_exactly_the_supported_models() { + let offering = higgsfield_image_offering(); + let offered: Vec = offering.models.iter().map(|m| m.model).collect(); + assert_eq!(offered, HIGGSFIELD_IMAGE_MODELS.to_vec()); + assert!(!provider_offers_image_model(GenerationProvider::Higgsfield, ImageModel::Flux1Dev)); + assert!(!provider_offers_image_model(GenerationProvider::Higgsfield, ImageModel::Midjourney8)); + } + + #[test] + fn nano_banana_2_lite_is_higgsfield_only() { + assert_eq!(providers_for_image_model(ImageModel::NanoBanana2Lite), vec![GenerationProvider::Higgsfield]); + } + + #[test] + fn overrides_keep_identity_and_presentation() { + for offered in &higgsfield_image_offering().models { + let base = image_model_config(offered.model); + if let Some(overrides) = &offered.overrides { + assert_eq!(overrides.model, base.model); + assert_eq!(overrides.full_name, base.full_name); + assert_eq!(overrides.selector_name, base.selector_name); + assert_eq!(overrides.can_edit_images, base.can_edit_images); + assert_eq!(overrides.image_refs_supported, base.image_refs_supported); + } + } + } + + #[test] + fn every_default_is_within_its_override_menu() { + for model in HIGGSFIELD_IMAGE_MODELS { + let config = effective(*model); + assert!(config.batch_size_max <= HIGGSFIELD_IMAGE_BATCH_MAX, "{model:?}"); + assert!(config.batch_size_default <= config.batch_size_max, "{model:?}"); + if let Some(default) = config.aspect_ratio_default { + assert!(config.aspect_ratio_options.contains(&default), "{model:?} aspect default not offered"); + } + if let Some(default) = config.aspect_ratio_default_when_editing { + assert!(config.aspect_ratio_options.contains(&default), "{model:?} editing aspect default not offered"); + } + if let Some(default) = config.resolution_default { + assert!(config.resolution_options.contains(&default), "{model:?} resolution default not offered"); + } + if let Some(default) = config.quality_default { + assert!(config.quality_options.contains(&default), "{model:?} quality default not offered"); + } + } + } + + #[test] + fn menus_narrow_to_what_higgsfield_runs() { + // 0.5K is an ArtCraft-only tier for Nano Banana 2. + assert!(image_model_config(ImageModel::NanoBanana2).resolution_options.contains(&CommonResolution::HalfK)); + assert!(!effective(ImageModel::NanoBanana2).resolution_options.contains(&CommonResolution::HalfK)); + // GPT Image 2 has no 3K and no "1:1 HD" on Higgsfield. + let gpt = effective(ImageModel::GptImage2); + assert!(!gpt.resolution_options.contains(&CommonResolution::ThreeK)); + assert!(!gpt.aspect_ratio_options.contains(&CommonAspectRatio::SquareHd)); + assert!(gpt.aspect_ratio_options.contains(&CommonAspectRatio::WideTwentyOneByNine)); + // Seedream 5.0 Pro: batches of 4, no Auto. + let pro = effective(ImageModel::Seedream5p0Pro); + assert_eq!(pro.batch_size_max, 4); + assert!(!pro.aspect_ratio_options.contains(&CommonAspectRatio::Auto)); + // Seedream 5 Lite / 4.5 gain a real resolution menu. + assert_eq!(effective(ImageModel::Seedream5Lite).resolution_options, vec![CommonResolution::TwoK, CommonResolution::ThreeK, CommonResolution::FourK]); + assert_eq!(effective(ImageModel::Seedream4p5).resolution_options, vec![CommonResolution::TwoK, CommonResolution::FourK]); + // Nano Banana Pro is identical to the base config. + assert!(higgsfield_image_offering().overrides_for(ImageModel::NanoBananaPro).is_none()); + } + + #[test] + fn effective_config_falls_back_to_base_for_other_providers() { + let base = image_model_config(ImageModel::NanoBanana2); + let artcraft = effective_config(&IMAGE_PROVIDERS, GenerationProvider::Artcraft, ImageModel::NanoBanana2, base); + assert_eq!(artcraft, base); + } +} diff --git a/crates/models/src/providers/higgsfield_video_offering.rs b/crates/models/src/providers/higgsfield_video_offering.rs new file mode 100644 index 00000000..26f34aec --- /dev/null +++ b/crates/models/src/providers/higgsfield_video_offering.rs @@ -0,0 +1,217 @@ +//! The video models a first-party (cookie-session) Higgsfield account runs, +//! and how their option menus differ from the base table. +//! +//! Option sets mirror the higgsfield.ai video generator (see +//! `higgsfield_client::endpoints::generate::video`). Kling 3.0's "mode" menu +//! (std / pro / 4K) is split across the two Kling 3.0 model ids: Standard is +//! the 720p tier, Pro the 1080p / 4K tiers. + +use crate::configs::video_model_config::VideoModelConfig; +use crate::configs::video_models::video_model_config; +use crate::enums::common_bitrate::CommonBitrate; +use crate::enums::common_resolution::CommonResolution; +use crate::enums::generation_provider::GenerationProvider; +use crate::enums::video_model::VideoModel; +use crate::providers::provider_offering::OfferedModel; +use crate::providers::video_providers::VideoProviderOffering; + +/// Higgsfield caps every video batch at 4. +pub const HIGGSFIELD_VIDEO_BATCH_MAX: u16 = 4; + +/// Every video model Higgsfield offers, in picker order. +pub const HIGGSFIELD_VIDEO_MODELS: &[VideoModel] = &[ + VideoModel::Seedance2p5, + VideoModel::Seedance2p5Edit, + VideoModel::Seedance2p0, + VideoModel::Seedance2p0Mini, + VideoModel::MinimaxH3, + VideoModel::Kling3p0Pro, + VideoModel::Kling3p0Standard, + VideoModel::GrokImagineVideo1p5, +]; + +pub fn higgsfield_video_offering() -> VideoProviderOffering { + VideoProviderOffering { + provider: GenerationProvider::Higgsfield, + models: HIGGSFIELD_VIDEO_MODELS.iter().copied().map(offered).collect(), + } +} + +/// The base config, or a Higgsfield-specific replacement when the menus +/// differ. Every override starts from the base so presentation stays in sync. +fn offered(model: VideoModel) -> OfferedModel { + let base = video_model_config(model).clone(); + let overrides = match model { + // Higgsfield-only models: the base config already describes them. + VideoModel::Seedance2p5 | VideoModel::Seedance2p5Edit | VideoModel::MinimaxH3 => None, + // Seedance 2.0: no character references; the web app defaults to the + // high bitrate. + VideoModel::Seedance2p0 => Some(VideoModelConfig { + character_references_supported: false, + character_references_max: None, + bitrate_default: Some(CommonBitrate::High), + ..capped(base) + }), + // Seedance 2.0 Mini: no character references and no bitrate menu. + VideoModel::Seedance2p0Mini => Some(VideoModelConfig { + character_references_supported: false, + character_references_max: None, + bitrate_options: Vec::new(), + bitrate_default: None, + ..capped(base) + }), + // Kling 3.0 Standard = the "std" mode: 720p only. + VideoModel::Kling3p0Standard => Some(VideoModelConfig { + resolution_options: vec![CommonResolution::SevenTwentyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + ..capped(base) + }), + // Kling 3.0 Pro = the "pro" and "4K" modes. + VideoModel::Kling3p0Pro => Some(VideoModelConfig { + resolution_options: vec![CommonResolution::TenEightyP, CommonResolution::FourK], + resolution_default: Some(CommonResolution::TenEightyP), + ..capped(base) + }), + // Grok Imagine 1.5: text-to-video works, a 1080p tier exists, and image + // references are accepted alongside the start frame. + VideoModel::GrokImagineVideo1p5 => Some(VideoModelConfig { + text_to_video_supported: true, + starting_keyframe_required: false, + image_references_supported: true, + image_references_max: Some(4), + resolution_options: vec![CommonResolution::FourEightyP, CommonResolution::SevenTwentyP, CommonResolution::TenEightyP], + resolution_default: Some(CommonResolution::SevenTwentyP), + duration_seconds_min: Some(1), + duration_seconds_max: Some(15), + duration_seconds_max_with_image_references: None, + duration_seconds_options: Some((1..=15).collect()), + duration_seconds_default: Some(6), + ..capped(base) + }), + other => unreachable!("{other:?} is not a Higgsfield video model"), + }; + match overrides { + Some(overrides) => OfferedModel::with_overrides(model, overrides), + None => OfferedModel::same_as_base(model), + } +} + +/// Apply the batch cap every Higgsfield video model shares. +fn capped(base: VideoModelConfig) -> VideoModelConfig { + VideoModelConfig { + batch_size_max: base.batch_size_max.min(HIGGSFIELD_VIDEO_BATCH_MAX), + batch_size_options: base.batch_size_options.map(|options| { + options.into_iter().filter(|count| *count <= HIGGSFIELD_VIDEO_BATCH_MAX).collect() + }), + batch_size_default: base.batch_size_default.min(HIGGSFIELD_VIDEO_BATCH_MAX), + ..base + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::providers::provider_offering::effective_config; + use crate::providers::video_providers::{provider_offers_video_model, providers_for_video_model, VIDEO_PROVIDERS}; + + fn effective(model: VideoModel) -> VideoModelConfig { + effective_config(&VIDEO_PROVIDERS, GenerationProvider::Higgsfield, model, video_model_config(model)).clone() + } + + #[test] + fn offers_exactly_the_supported_models() { + let offering = higgsfield_video_offering(); + let offered: Vec = offering.models.iter().map(|m| m.model).collect(); + assert_eq!(offered, HIGGSFIELD_VIDEO_MODELS.to_vec()); + assert!(!provider_offers_video_model(GenerationProvider::Higgsfield, VideoModel::Veo3)); + assert!(!provider_offers_video_model(GenerationProvider::Higgsfield, VideoModel::Seedance2p0Fast)); + } + + #[test] + fn higgsfield_only_models_have_no_other_provider() { + for model in [VideoModel::Seedance2p5, VideoModel::Seedance2p5Edit, VideoModel::MinimaxH3] { + assert_eq!(providers_for_video_model(model), vec![GenerationProvider::Higgsfield], "{model:?}"); + } + } + + #[test] + fn overrides_keep_identity_and_presentation() { + for offered in &higgsfield_video_offering().models { + let base = video_model_config(offered.model); + if let Some(overrides) = &offered.overrides { + assert_eq!(overrides.model, base.model); + assert_eq!(overrides.full_name, base.full_name); + assert_eq!(overrides.selector_name, base.selector_name); + assert_eq!(overrides.starting_keyframe_supported, base.starting_keyframe_supported); + } + } + } + + #[test] + fn every_default_is_within_its_override_menu() { + for model in HIGGSFIELD_VIDEO_MODELS { + let config = effective(*model); + assert!(config.batch_size_max <= HIGGSFIELD_VIDEO_BATCH_MAX, "{model:?}"); + assert!(config.batch_size_default <= config.batch_size_max, "{model:?}"); + if let Some(default) = config.aspect_ratio_default { + assert!(config.aspect_ratio_options.contains(&default), "{model:?} aspect default not offered"); + } + if let Some(default) = config.resolution_default { + assert!(config.resolution_options.contains(&default), "{model:?} resolution default not offered"); + } + if let Some(default) = config.bitrate_default { + assert!(config.bitrate_options.contains(&default), "{model:?} bitrate default not offered"); + } + if let (Some(default), Some(options)) = (config.duration_seconds_default, &config.duration_seconds_options) { + assert!(options.contains(&default), "{model:?} duration default not offered"); + } + if let (Some(min), Some(max), Some(options)) = (config.duration_seconds_min, config.duration_seconds_max, &config.duration_seconds_options) { + assert_eq!(options.first().copied(), Some(min), "{model:?} duration options start below min"); + assert_eq!(options.last().copied(), Some(max), "{model:?} duration options end above max"); + } + if !config.starting_keyframe_supported { + assert!(!config.starting_keyframe_required, "{model:?}"); + } + } + } + + #[test] + fn kling_3p0_splits_the_mode_menu_by_model() { + assert_eq!(effective(VideoModel::Kling3p0Standard).resolution_options, vec![CommonResolution::SevenTwentyP]); + assert_eq!(effective(VideoModel::Kling3p0Pro).resolution_options, vec![CommonResolution::TenEightyP, CommonResolution::FourK]); + // The base (ArtCraft) Kling 3.0 has no resolution menu at all. + assert!(video_model_config(VideoModel::Kling3p0Pro).resolution_options.is_empty()); + } + + #[test] + fn seedance_2p0_drops_characters_and_mini_drops_bitrate() { + assert!(video_model_config(VideoModel::Seedance2p0).character_references_supported); + assert!(!effective(VideoModel::Seedance2p0).character_references_supported); + assert!(!effective(VideoModel::Seedance2p0Mini).character_references_supported); + assert!(effective(VideoModel::Seedance2p0Mini).bitrate_options.is_empty()); + assert_eq!(effective(VideoModel::Seedance2p0).resolution_options, video_model_config(VideoModel::Seedance2p0).resolution_options); + } + + #[test] + fn grok_imagine_1p5_gains_text_to_video_and_1080p() { + let base = video_model_config(VideoModel::GrokImagineVideo1p5); + let higgsfield = effective(VideoModel::GrokImagineVideo1p5); + assert!(!base.text_to_video_supported); + assert!(higgsfield.text_to_video_supported); + assert!(!higgsfield.starting_keyframe_required); + assert!(higgsfield.resolution_options.contains(&CommonResolution::TenEightyP)); + assert!(higgsfield.image_references_supported); + } + + #[test] + fn seedance_2p5_runs_longer_than_2p0_but_without_4k() { + let seedance_2p5 = effective(VideoModel::Seedance2p5); + assert_eq!(seedance_2p5.duration_seconds_max, Some(30)); + assert!(!seedance_2p5.resolution_options.contains(&CommonResolution::FourK)); + assert!(seedance_2p5.video_references_supported && seedance_2p5.audio_references_supported); + let edit = effective(VideoModel::Seedance2p5Edit); + assert!(!edit.text_to_video_supported); + assert_eq!(edit.video_references_max, Some(1)); + assert!(edit.duration_seconds_options.is_none()); + } +} diff --git a/crates/models/src/providers/image_providers.rs b/crates/models/src/providers/image_providers.rs new file mode 100644 index 00000000..9680ff80 --- /dev/null +++ b/crates/models/src/providers/image_providers.rs @@ -0,0 +1,99 @@ +//! Which providers offer which image models. + +use crate::configs::image_model_config::ImageModelConfig; +use crate::enums::generation_provider::GenerationProvider; +use crate::enums::image_model::ImageModel; +use crate::providers::higgsfield_image_offering::higgsfield_image_offering; +use crate::providers::provider_offering::{is_offered, providers_for_model, ProviderOffering}; +use once_cell::sync::Lazy; + +pub type ImageProviderOffering = ProviderOffering; + +pub static IMAGE_PROVIDERS: Lazy> = Lazy::new(image_providers); + +pub fn providers_for_image_model(model: ImageModel) -> Vec { + providers_for_model(&IMAGE_PROVIDERS, model) +} + +pub fn provider_offers_image_model(provider: GenerationProvider, model: ImageModel) -> bool { + is_offered(&IMAGE_PROVIDERS, provider, model) +} + +fn image_providers() -> Vec { + vec![ + // ArtCraft (storyteller-web) runs everything except the first-party Grok + // Imagine models. + ImageProviderOffering::of(GenerationProvider::Artcraft, &[ + ImageModel::NanoBananaPro, + ImageModel::NanoBanana2, + ImageModel::NanoBanana, + ImageModel::GptImage2, + ImageModel::GptImage1p5, + ImageModel::GptImage1, + ImageModel::Seedream5p0Pro, + ImageModel::Seedream5p0ProUltra, + ImageModel::Seedream5Lite, + ImageModel::Seedream4p5, + ImageModel::Seedream4, + ImageModel::FluxPro11Ultra, + ImageModel::FluxPro11, + ImageModel::Flux1Dev, + ImageModel::Flux1Schnell, + ImageModel::Midjourney8, + ImageModel::Midjourney7, + ImageModel::Midjourney7Niji, + ImageModel::QwenEdit2511Angles, + ImageModel::Flux2LoraAngles, + ImageModel::FluxProKontextMax, + ImageModel::FluxPro1, + ImageModel::FluxDevJuggernaut, + ]), + // FAL (API key). + ImageProviderOffering::of(GenerationProvider::Fal, &[ + ImageModel::NanoBananaPro, + ImageModel::NanoBanana2, + ImageModel::Flux1Dev, + ImageModel::Flux1Schnell, + ]), + // First-party (cookie-session) Grok: the imagine websocket only. + ImageProviderOffering::of(GenerationProvider::Grok, &[ + ImageModel::GrokImagineImage, + ImageModel::GrokImagineImageQuality, + ]), + // First-party (cookie-session) Midjourney: Midjourney models only. + ImageProviderOffering::of(GenerationProvider::Midjourney, &[ + ImageModel::Midjourney8, + ImageModel::Midjourney7, + ImageModel::Midjourney7Niji, + ]), + // First-party (cookie-session) Higgsfield, with per-model overrides where + // its menus differ from ArtCraft's. + higgsfield_image_offering(), + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::configs::image_models::IMAGE_MODELS; + use crate::providers::tests_common::check_offerings; + + #[test] + fn offerings_are_consistent_with_the_model_table() { + let known: Vec = IMAGE_MODELS.iter().filter(|c| !c.is_disabled).map(|c| c.model).collect(); + check_offerings(&IMAGE_PROVIDERS, &known, |config| config.model); + } + + #[test] + fn first_party_providers_are_exclusive() { + assert_eq!(providers_for_image_model(ImageModel::GrokImagineImage), vec![GenerationProvider::Grok]); + assert_eq!(providers_for_image_model(ImageModel::GrokImagineImageQuality), vec![GenerationProvider::Grok]); + assert!(!provider_offers_image_model(GenerationProvider::Artcraft, ImageModel::GrokImagineImage)); + assert!(!provider_offers_image_model(GenerationProvider::Midjourney, ImageModel::GrokImagineImage)); + assert_eq!(providers_for_image_model(ImageModel::Midjourney7), vec![GenerationProvider::Artcraft, GenerationProvider::Midjourney]); + assert!(!provider_offers_image_model(GenerationProvider::Grok, ImageModel::Midjourney7)); + // ArtCraft is the default provider for the shared models. + assert_eq!(providers_for_image_model(ImageModel::Flux1Dev)[0], GenerationProvider::Artcraft); + assert_eq!(providers_for_image_model(ImageModel::NanoBananaPro), vec![GenerationProvider::Artcraft, GenerationProvider::Fal, GenerationProvider::Higgsfield]); + } +} diff --git a/crates/models/src/providers/mesh_providers.rs b/crates/models/src/providers/mesh_providers.rs new file mode 100644 index 00000000..66f7f9ff --- /dev/null +++ b/crates/models/src/providers/mesh_providers.rs @@ -0,0 +1,51 @@ +//! Which providers offer which 3D mesh models: ArtCraft only. + +use crate::configs::mesh_model_config::MeshModelConfig; +use crate::enums::generation_provider::GenerationProvider; +use crate::enums::mesh_model::MeshModel; +use crate::providers::provider_offering::{is_offered, providers_for_model, ProviderOffering}; +use once_cell::sync::Lazy; + +pub type MeshProviderOffering = ProviderOffering; + +pub static MESH_PROVIDERS: Lazy> = Lazy::new(mesh_providers); + +pub fn providers_for_mesh_model(model: MeshModel) -> Vec { + providers_for_model(&MESH_PROVIDERS, model) +} + +pub fn provider_offers_mesh_model(provider: GenerationProvider, model: MeshModel) -> bool { + is_offered(&MESH_PROVIDERS, provider, model) +} + +fn mesh_providers() -> Vec { + vec![ + MeshProviderOffering::of(GenerationProvider::Artcraft, &[ + MeshModel::Hunyuan3d3, + MeshModel::Hunyuan3d3p1Pro, + MeshModel::Hunyuan3d3p1Rapid, + MeshModel::Hunyuan3d3Sketch, + MeshModel::Hunyuan3d2p1, + MeshModel::Hunyuan3d2p0, + MeshModel::Hunyuan3d3p1Part, + MeshModel::Hunyuan3d3p1SmartTopology, + MeshModel::Tripo3dH3p1, + MeshModel::MeshyV6, + MeshModel::Rodin2p5Fast, + ]), + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::configs::mesh_models::MESH_MODELS; + use crate::providers::tests_common::check_offerings; + + #[test] + fn offerings_are_consistent_with_the_model_table() { + let known: Vec = MESH_MODELS.iter().filter(|c| !c.is_disabled).map(|c| c.model).collect(); + check_offerings(&MESH_PROVIDERS, &known, |config| config.model); + assert_eq!(MESH_PROVIDERS.len(), 1, "mesh is ArtCraft-only"); + } +} diff --git a/crates/models/src/providers/mod.rs b/crates/models/src/providers/mod.rs new file mode 100644 index 00000000..93a5c010 --- /dev/null +++ b/crates/models/src/providers/mod.rs @@ -0,0 +1,61 @@ +//! Which providers (services) offer which models. +//! +//! A model's capabilities live in [`crate::configs`]; *where it can run* lives +//! here. Not every provider has every model: first-party Grok only runs the +//! Grok Imagine models, first-party Midjourney only the Midjourney models, +//! and video / mesh / splat / audio are ArtCraft (plus a couple of +//! credential-backed services) only. The frontend uses these tables to keep +//! provider + model + account choices valid; the enqueue commands and the +//! router still guard on their own. +//! +//! Each offering may carry `overrides`: a provider-specific replacement config +//! for a model whose behavior differs on that provider. Higgsfield uses these +//! (see [`higgsfield_image_offering`] / [`higgsfield_video_offering`]): it +//! runs several shared models with narrower resolution / duration / reference +//! menus than ArtCraft. Read a model's options for a provider through +//! [`provider_offering::effective_config`]. + +pub mod audio_providers; +pub mod higgsfield_image_offering; +pub mod higgsfield_video_offering; +pub mod image_providers; +pub mod mesh_providers; +pub mod provider_offering; +pub mod splat_providers; +pub mod video_providers; + +#[cfg(test)] +pub(crate) mod tests_common { + use crate::providers::provider_offering::ProviderOffering; + use std::collections::HashSet; + use std::fmt::Debug; + use std::hash::Hash; + + /// Every enabled model is offered by at least one provider, every offered + /// model is a known enabled model, no provider lists a model twice, and + /// every override describes the model it's attached to. + pub fn check_offerings( + offerings: &[ProviderOffering], + enabled_models: &[M], + model_of_config: impl Fn(&C) -> M, + ) { + let enabled: HashSet = enabled_models.iter().copied().collect(); + let mut offered_anywhere: HashSet = HashSet::new(); + let mut providers_seen = HashSet::new(); + for offering in offerings { + assert!(providers_seen.insert(offering.provider), "{:?} listed twice", offering.provider); + let mut seen = HashSet::new(); + for offered in &offering.models { + assert!(seen.insert(offered.model), "{:?} lists {:?} twice", offering.provider, offered.model); + assert!(enabled.contains(&offered.model), "{:?} offers unknown/disabled {:?}", offering.provider, offered.model); + if let Some(overrides) = &offered.overrides { + assert_eq!(model_of_config(overrides), offered.model, "{:?} override is for another model", offering.provider); + } + offered_anywhere.insert(offered.model); + } + } + for model in &enabled { + assert!(offered_anywhere.contains(model), "{model:?} is offered by no provider"); + } + } +} diff --git a/crates/models/src/providers/provider_offering.rs b/crates/models/src/providers/provider_offering.rs new file mode 100644 index 00000000..2ca3414d --- /dev/null +++ b/crates/models/src/providers/provider_offering.rs @@ -0,0 +1,89 @@ +use crate::enums::generation_provider::GenerationProvider; +use serde_derive::Serialize; + +/// The models one provider offers. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct ProviderOffering { + pub provider: GenerationProvider, + /// In the provider's display order. + pub models: Vec>, +} + +/// One model as offered by one provider. +#[derive(Clone, Debug, PartialEq, Serialize)] +pub struct OfferedModel { + pub model: Model, + /// When set, this provider's version of the model differs from the base + /// config and this replaces it. `None` = same as the base config. + #[serde(skip_serializing_if = "Option::is_none")] + pub overrides: Option, +} + +impl OfferedModel { + pub fn same_as_base(model: Model) -> Self { + Self { model, overrides: None } + } + + /// This provider runs the model with a different capability surface than + /// the base config (fewer resolutions, other durations, ...). + pub fn with_overrides(model: Model, overrides: Config) -> Self { + Self { model, overrides: Some(overrides) } + } +} + +impl ProviderOffering { + /// Every model this provider offers (base config, no overrides). + pub fn of(provider: GenerationProvider, models: &[Model]) -> Self { + Self { + provider, + models: models.iter().copied().map(OfferedModel::same_as_base).collect(), + } + } + + pub fn offers(&self, model: Model) -> bool { + self.models.iter().any(|offered| offered.model == model) + } + + /// This provider's replacement config for `model`, if it has one. + pub fn overrides_for(&self, model: Model) -> Option<&Config> { + self.models.iter() + .find(|offered| offered.model == model) + .and_then(|offered| offered.overrides.as_ref()) + } +} + +/// The config `provider` runs `model` with: its override when the offering +/// carries one, else `base`. Callers that plan a request against a specific +/// provider should read options from this, not from the base table. +pub fn effective_config<'a, Model: Copy + PartialEq, Config>( + offerings: &'a [ProviderOffering], + provider: GenerationProvider, + model: Model, + base: &'a Config, +) -> &'a Config { + offerings.iter() + .find(|offering| offering.provider == provider) + .and_then(|offering| offering.overrides_for(model)) + .unwrap_or(base) +} + +/// The providers that offer `model`, in table order (the first is the +/// default provider for the model). +pub fn providers_for_model( + offerings: &[ProviderOffering], + model: Model, +) -> Vec { + offerings.iter() + .filter(|offering| offering.offers(model)) + .map(|offering| offering.provider) + .collect() +} + +/// Whether `provider` offers `model`. +pub fn is_offered( + offerings: &[ProviderOffering], + provider: GenerationProvider, + model: Model, +) -> bool { + offerings.iter().any(|offering| offering.provider == provider && offering.offers(model)) +} diff --git a/crates/models/src/providers/splat_providers.rs b/crates/models/src/providers/splat_providers.rs new file mode 100644 index 00000000..b4161d0c --- /dev/null +++ b/crates/models/src/providers/splat_providers.rs @@ -0,0 +1,45 @@ +//! Which providers offer which Gaussian splat models. + +use crate::configs::splat_model_config::SplatModelConfig; +use crate::enums::generation_provider::GenerationProvider; +use crate::enums::splat_model::SplatModel; +use crate::providers::provider_offering::{is_offered, providers_for_model, ProviderOffering}; +use once_cell::sync::Lazy; + +pub type SplatProviderOffering = ProviderOffering; + +pub static SPLAT_PROVIDERS: Lazy> = Lazy::new(splat_providers); + +pub fn providers_for_splat_model(model: SplatModel) -> Vec { + providers_for_model(&SPLAT_PROVIDERS, model) +} + +pub fn provider_offers_splat_model(provider: GenerationProvider, model: SplatModel) -> bool { + is_offered(&SPLAT_PROVIDERS, provider, model) +} + +fn splat_providers() -> Vec { + vec![ + SplatProviderOffering::of(GenerationProvider::Artcraft, &[ + SplatModel::Marble1p1, + SplatModel::Marble1p1Plus, + SplatModel::Marble1p0, + SplatModel::Marble1p0Draft, + SplatModel::TripoSplat, + ]), + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::configs::splat_models::SPLAT_MODELS; + use crate::providers::tests_common::check_offerings; + + #[test] + fn offerings_are_consistent_with_the_model_table() { + let known: Vec = SPLAT_MODELS.iter().filter(|c| !c.is_disabled).map(|c| c.model).collect(); + check_offerings(&SPLAT_PROVIDERS, &known, |config| config.model); + assert_eq!(providers_for_splat_model(SplatModel::TripoSplat), vec![GenerationProvider::Artcraft]); + } +} diff --git a/crates/models/src/providers/video_providers.rs b/crates/models/src/providers/video_providers.rs new file mode 100644 index 00000000..47a0f2b0 --- /dev/null +++ b/crates/models/src/providers/video_providers.rs @@ -0,0 +1,89 @@ +//! Which providers offer which video models. + +use crate::configs::video_model_config::VideoModelConfig; +use crate::enums::generation_provider::GenerationProvider; +use crate::enums::video_model::VideoModel; +use crate::providers::higgsfield_video_offering::higgsfield_video_offering; +use crate::providers::provider_offering::{is_offered, providers_for_model, ProviderOffering}; +use once_cell::sync::Lazy; + +pub type VideoProviderOffering = ProviderOffering; + +pub static VIDEO_PROVIDERS: Lazy> = Lazy::new(video_providers); + +pub fn providers_for_video_model(model: VideoModel) -> Vec { + providers_for_model(&VIDEO_PROVIDERS, model) +} + +pub fn provider_offers_video_model(provider: GenerationProvider, model: VideoModel) -> bool { + is_offered(&VIDEO_PROVIDERS, provider, model) +} + +fn video_providers() -> Vec { + vec![ + // ArtCraft runs every video model except the Higgsfield-only ones (Grok + // Imagine video is served through storyteller-web too). Grok and + // Midjourney offer no video models. + VideoProviderOffering::of(GenerationProvider::Artcraft, &[ + VideoModel::Seedance2p0, + VideoModel::Seedance2p0Fast, + VideoModel::Seedance2p0BytePlus, + VideoModel::Seedance2p0BytePlusFast, + VideoModel::Seedance2p0Ultra, + VideoModel::Seedance2p0UltraFast, + VideoModel::Seedance2p0BytePlusUltra, + VideoModel::Seedance2p0BytePlusUltraFast, + VideoModel::Seedance2p0Mini, + VideoModel::Seedance2p0BytePlusMini, + VideoModel::Seedance2p0BytePlusUltraMini, + VideoModel::Seedance1p5Pro, + VideoModel::Seedance10Lite, + VideoModel::Kling3p0Pro, + VideoModel::Kling3p0Standard, + VideoModel::Kling2p6Pro, + VideoModel::Kling2p5TurboPro, + VideoModel::Kling21Master, + VideoModel::Kling21Pro, + VideoModel::Kling16Pro, + VideoModel::Veo3p1, + VideoModel::Veo3p1Fast, + VideoModel::Veo3p1Lite, + VideoModel::Veo3Fast, + VideoModel::Veo3, + VideoModel::Veo2, + VideoModel::ViduQ3, + VideoModel::ViduQ3Turbo, + VideoModel::HappyHorse1p0, + VideoModel::Sora2, + VideoModel::Sora2Pro, + VideoModel::GrokImagineVideo, + VideoModel::GrokImagineVideo1p5, + VideoModel::SwitchX, + ]), + // First-party (cookie-session) Higgsfield, with per-model overrides where + // its menus differ from ArtCraft's. + higgsfield_video_offering(), + ] +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::configs::video_models::VIDEO_MODELS; + use crate::providers::tests_common::check_offerings; + + #[test] + fn offerings_are_consistent_with_the_model_table() { + let known: Vec = VIDEO_MODELS.iter().filter(|c| !c.is_disabled).map(|c| c.model).collect(); + check_offerings(&VIDEO_PROVIDERS, &known, |config| config.model); + } + + #[test] + fn grok_and_midjourney_offer_no_video() { + assert!(!VIDEO_PROVIDERS.iter().any(|o| o.provider == GenerationProvider::Grok)); + assert!(!VIDEO_PROVIDERS.iter().any(|o| o.provider == GenerationProvider::Midjourney)); + assert_eq!(providers_for_video_model(VideoModel::Sora2), vec![GenerationProvider::Artcraft]); + assert!(provider_offers_video_model(GenerationProvider::Artcraft, VideoModel::GrokImagineVideo)); + assert_eq!(providers_for_video_model(VideoModel::Seedance2p0), vec![GenerationProvider::Artcraft, GenerationProvider::Higgsfield]); + } +} diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml new file mode 100644 index 00000000..aae4b035 --- /dev/null +++ b/crates/router/Cargo.toml @@ -0,0 +1,48 @@ +[package] +name = "router" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "router" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +artcraft_client.workspace = true +file_hashing.workspace = true +browser_emulation.workspace = true +fal_client.workspace = true +gmicloud_client.workspace = true +grok_api_client.workspace = true +grok_consumer_client.workspace = true +higgsfield_client.workspace = true +midjourney_client.workspace = true +seedance2pro_client.workspace = true +sqlite_identifiers.workspace = true +url_utils.workspace = true + +# External +anyhow.workspace = true +async-trait.workspace = true +log.workspace = true +reqwest.workspace = true +serde.workspace = true +wreq.workspace = true +serde_derive.workspace = true +tokio.workspace = true +uuid.workspace = true + +[dev-dependencies] +test_data.workspace = true +test_utils.workspace = true +strum.workspace = true +serde_json.workspace = true + diff --git a/crates/router/src/api/asset_upload_cache.rs b/crates/router/src/api/asset_upload_cache.rs new file mode 100644 index 00000000..aff8d844 --- /dev/null +++ b/crates/router/src/api/asset_upload_cache.rs @@ -0,0 +1,83 @@ +//! Skip re-uploading bytes a provider already holds. +//! +//! The router uploads reference media to providers on the caller's behalf +//! (Higgsfield today). The app keeps a ledger of what each account has +//! already uploaded, keyed by content hash; it hands the router a +//! per-account view of that ledger through this trait, and the router asks +//! before every upload. The router has no idea how the ledger is stored. +//! +//! Entries are advisory: the router verifies a hit with the provider before +//! trusting it, and any failure falls back to a fresh upload that is then +//! recorded over the stale entry. + +use async_trait::async_trait; + +/// How the provider came to hold some content. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum AssetUploadOrigin { + /// We uploaded the bytes; `service_id` is the provider's media id. + Upload, + /// The provider generated the file itself and we downloaded it; + /// `service_id` is the job id, and the content can be referenced as a + /// previous generation without uploading it (or re-running an IP check). + GenerationResult, +} + +impl AssetUploadOrigin { + /// The stored form. + pub fn as_str(self) -> &'static str { + match self { + Self::Upload => "upload", + Self::GenerationResult => "generation_result", + } + } + + /// Unknown values read as plain uploads (the conservative choice: they get + /// verified as media before reuse). + pub fn parse(value: &str) -> Self { + match value { + "generation_result" => Self::GenerationResult, + _ => Self::Upload, + } + } +} + +/// A copy of some bytes the provider already holds, as the provider knows it. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct CachedAssetUpload { + /// The provider's own id for the asset: a media id for an upload, a job + /// id for a generation result. + pub service_id: String, + /// Where the provider serves it, when it publishes a URL. + pub maybe_service_url: Option, + pub origin: AssetUploadOrigin, +} + +impl CachedAssetUpload { + /// Bytes we uploaded. + pub fn uploaded(service_id: impl Into, maybe_service_url: Option) -> Self { + Self { service_id: service_id.into(), maybe_service_url, origin: AssetUploadOrigin::Upload } + } + + /// A generation the provider produced, by job id and result URL. + pub fn generation_result(job_id: impl Into, result_url: impl Into) -> Self { + Self { service_id: job_id.into(), maybe_service_url: Some(result_url.into()), origin: AssetUploadOrigin::GenerationResult } + } +} + +/// One account's upload history on one provider. Implementations must not +/// fail loudly: a lookup error reads as a miss, a record error is logged. +#[async_trait] +pub trait AssetUploadCache: Send + Sync { + /// The upload previously made for these bytes, if any. + async fn find_upload(&self, file_hash_blake3: &str) -> Option; + + /// Remember a fresh upload (replacing any stale entry for the hash). + async fn record_upload(&self, file_hash_blake3: &str, file_size_bytes: u64, upload: &CachedAssetUpload); + + /// Note that an upload was skipped thanks to a (verified) entry. + async fn note_reused(&self, file_hash_blake3: &str); + + /// Drop an entry the provider no longer honours. + async fn forget_upload(&self, file_hash_blake3: &str); +} diff --git a/crates/router/src/api/asset_upload_observer.rs b/crates/router/src/api/asset_upload_observer.rs new file mode 100644 index 00000000..a59d6439 --- /dev/null +++ b/crates/router/src/api/asset_upload_observer.rs @@ -0,0 +1,19 @@ +//! Let the caller watch reference-media uploads as they happen. +//! +//! The router decides per file whether to reuse a provider's existing copy +//! (see [`crate::api::asset_upload_cache`]) or upload it — and the user +//! experience differs: a reuse is instant, an upload with an IP check is a +//! long wait. The caller learns which one happened through this trait, at +//! the moment it happens, so it can show the right notice. + +/// Observes upload decisions for one request. Implementations must be +/// cheap and must not fail; they only inform the UI. +pub trait AssetUploadObserver: Send + Sync { + /// A file was not uploaded because the provider already holds a verified + /// copy. `kind` is e.g. "image" / "video" / "audio". + fn on_reused(&self, kind: &str, description: &str); + + /// A fresh upload is starting. `ip_check` means the provider will also run + /// (and the router will wait for) its intellectual-property check. + fn on_uploading(&self, kind: &str, byte_count: u64, ip_check: bool); +} diff --git a/crates/router/src/api/audio_list_ref.rs b/crates/router/src/api/audio_list_ref.rs new file mode 100644 index 00000000..d81e3270 --- /dev/null +++ b/crates/router/src/api/audio_list_ref.rs @@ -0,0 +1,35 @@ +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::audio_ref::AudioRef; + +#[derive(Clone, Debug)] +pub enum AudioListRef { + MediaFileTokens(Vec), + Urls(Vec), + /// Mixed per-item sources (tokens, URLs, local paths, bytes) — the general + /// form; the homogeneous variants above remain as conveniences. + Sources(Vec), +} + +impl AudioListRef { + /// Normalize any variant into per-item refs, in order. + pub fn into_refs(self) -> Vec { + match self { + Self::MediaFileTokens(tokens) => tokens.into_iter().map(AudioRef::MediaFileToken).collect(), + Self::Urls(urls) => urls.into_iter().map(AudioRef::Url).collect(), + Self::Sources(refs) => refs, + } + } + + pub fn len(&self) -> usize { + match self { + Self::MediaFileTokens(tokens) => tokens.len(), + Self::Urls(urls) => urls.len(), + Self::Sources(refs) => refs.len(), + } + } + + pub fn is_empty(&self) -> bool { + self.len() == 0 + } +} diff --git a/crates/router/src/api/audio_ref.rs b/crates/router/src/api/audio_ref.rs new file mode 100644 index 00000000..1d6029da --- /dev/null +++ b/crates/router/src/api/audio_ref.rs @@ -0,0 +1,16 @@ +use std::path::PathBuf; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::media_bytes::MediaBytes; + +#[derive(Clone, Debug)] +pub enum AudioRef { + MediaFileToken(MediaFileToken), + Url(String), + /// A file on the local filesystem; read directly, never round-tripped + /// through the ArtCraft cloud. + LocalPath(PathBuf), + /// Bytes the caller already holds (e.g. pasted media). + Bytes(MediaBytes), +} diff --git a/crates/router/src/api/character_list_ref.rs b/crates/router/src/api/character_list_ref.rs new file mode 100644 index 00000000..b9471ba9 --- /dev/null +++ b/crates/router/src/api/character_list_ref.rs @@ -0,0 +1,9 @@ +use artcraft_client::tokens::characters::CharacterToken; + +/// Forward-compatible character reference list. +#[derive(Clone, Debug)] +pub enum CharacterListRef { + CharacterTokens(Vec), + + // In the future, we may have other identifiers for characters. +} diff --git a/crates/router/src/api/image_list_ref.rs b/crates/router/src/api/image_list_ref.rs new file mode 100644 index 00000000..4b5ccb9f --- /dev/null +++ b/crates/router/src/api/image_list_ref.rs @@ -0,0 +1,35 @@ +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::image_ref::ImageRef; + +#[derive(Clone, Debug)] +pub enum ImageListRef { + MediaFileTokens(Vec), + Urls(Vec), + /// Mixed per-item sources (tokens, URLs, local paths, bytes) — the general + /// form; the homogeneous variants above remain as conveniences. + Sources(Vec), +} + +impl ImageListRef { + /// Normalize any variant into per-item refs, in order. + pub fn into_refs(self) -> Vec { + match self { + Self::MediaFileTokens(tokens) => tokens.into_iter().map(ImageRef::MediaFileToken).collect(), + Self::Urls(urls) => urls.into_iter().map(ImageRef::Url).collect(), + Self::Sources(refs) => refs, + } + } + + pub fn len(&self) -> usize { + match self { + Self::MediaFileTokens(tokens) => tokens.len(), + Self::Urls(urls) => urls.len(), + Self::Sources(refs) => refs.len(), + } + } + + pub fn is_empty(&self) -> bool { + self.len() == 0 + } +} diff --git a/crates/router/src/api/image_ref.rs b/crates/router/src/api/image_ref.rs new file mode 100644 index 00000000..663342f6 --- /dev/null +++ b/crates/router/src/api/image_ref.rs @@ -0,0 +1,16 @@ +use std::path::PathBuf; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::media_bytes::MediaBytes; + +#[derive(Clone, Debug)] +pub enum ImageRef { + MediaFileToken(MediaFileToken), + Url(String), + /// A file on the local filesystem; read directly, never round-tripped + /// through the ArtCraft cloud. + LocalPath(PathBuf), + /// Bytes the caller already holds (e.g. pasted media). + Bytes(MediaBytes), +} diff --git a/crates/router/src/api/media_bytes.rs b/crates/router/src/api/media_bytes.rs new file mode 100644 index 00000000..f5c338ca --- /dev/null +++ b/crates/router/src/api/media_bytes.rs @@ -0,0 +1,31 @@ +use std::fmt::{Debug, Formatter}; + +/// In-memory media for a reference the caller already holds as bytes (e.g. a +/// pasted image that never touched disk). The file name, when known, helps +/// guess the MIME type; the bytes themselves are still sniffed first. +#[derive(Clone)] +pub struct MediaBytes { + pub bytes: Vec, + pub maybe_file_name: Option, +} + +impl MediaBytes { + pub fn new(bytes: Vec) -> Self { + Self { bytes, maybe_file_name: None } + } + + pub fn with_file_name(mut self, file_name: impl Into) -> Self { + self.maybe_file_name = Some(file_name.into()); + self + } +} + +// Manual impl: requests carrying these are logged; never dump the bytes. +impl Debug for MediaBytes { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.debug_struct("MediaBytes") + .field("bytes", &format_args!("<{} bytes>", self.bytes.len())) + .field("maybe_file_name", &self.maybe_file_name) + .finish() + } +} diff --git a/crates/router/src/api/mesh_ref.rs b/crates/router/src/api/mesh_ref.rs new file mode 100644 index 00000000..1aad83a3 --- /dev/null +++ b/crates/router/src/api/mesh_ref.rs @@ -0,0 +1,18 @@ +use std::path::PathBuf; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::media_bytes::MediaBytes; + +/// Reference to an input 3D mesh file (e.g. GLB/OBJ/FBX) for mesh-to-mesh +/// models like part splitting and retopology. +#[derive(Clone, Debug)] +pub enum MeshRef { + MediaFileToken(MediaFileToken), + Url(String), + /// A file on the local filesystem; read directly, never round-tripped + /// through the ArtCraft cloud. + LocalPath(PathBuf), + /// Bytes the caller already holds (e.g. pasted media). + Bytes(MediaBytes), +} diff --git a/crates/router/src/api/mod.rs b/crates/router/src/api/mod.rs new file mode 100644 index 00000000..b2ca4395 --- /dev/null +++ b/crates/router/src/api/mod.rs @@ -0,0 +1,21 @@ +pub mod asset_upload_cache; +pub mod asset_upload_observer; +pub mod audio_list_ref; +pub mod audio_ref; +pub mod character_list_ref; +pub mod image_list_ref; +pub mod image_ref; +pub mod media_bytes; +pub mod mesh_ref; +pub mod router_aspect_ratio; +pub mod router_audio_model; +pub mod router_bitrate; +pub mod router_image_model; +pub mod router_mesh_model; +pub mod router_provider; +pub mod router_quality; +pub mod router_resolution; +pub mod router_splat_model; +pub mod router_video_model; +pub mod video_list_ref; +pub mod video_ref; diff --git a/crates/router/src/api/router_aspect_ratio.rs b/crates/router/src/api/router_aspect_ratio.rs new file mode 100644 index 00000000..913d8389 --- /dev/null +++ b/crates/router/src/api/router_aspect_ratio.rs @@ -0,0 +1,49 @@ +use serde_derive::{Deserialize, Serialize}; +#[cfg(test)] +use strum::EnumIter; + +/// This is a comprehensive list of common aspect ratios you can specify when enqueuing a generation. +/// Not every model will support every aspect ratio. +/// In the case a model doesn't support the aspect ratio, gracefully pick the nearest option. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[cfg_attr(test, derive(EnumIter))] +#[serde(rename_all = "snake_case")] +pub enum RouterAspectRatio { + // Auto (eg. for image editing to use the source; used by Nano Banana Pro edit image, but not text-to-image) + Auto, + + // Square + Square, + + // Wide + WideThreeByTwo, + WideFourByThree, + WideFiveByFour, + WideSixteenByNine, + WideTwentyOneByNine, + + // Tall + TallTwoByThree, + TallThreeByFour, + TallFourByFive, + TallNineBySixteen, + TallNineByTwentyOne, + + // Imprecise semantic values that we probably remap to other meanings + // on a model-by-model basis. + Wide, + Tall, + + // Auto values that bake in resolution + // These are from the Seedream models + #[serde(rename = "auto_2k")] + Auto2k, + #[serde(rename = "auto_3k")] + Auto3k, + #[serde(rename = "auto_4k")] + Auto4k, + + // Defined aspect ratios that bake in resolution + // These are from the Seedream models + SquareHd, +} diff --git a/crates/router/src/api/router_audio_model.rs b/crates/router/src/api/router_audio_model.rs new file mode 100644 index 00000000..080b4b57 --- /dev/null +++ b/crates/router/src/api/router_audio_model.rs @@ -0,0 +1,65 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Common audio models supported by the router. +/// Not all models are available through all providers. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterAudioModel { + #[serde(rename = "suno_music")] + SunoMusic, + + #[serde(rename = "suno_remix")] + SunoRemix, + + #[serde(rename = "suno_sounds")] + SunoSounds, + + #[serde(rename = "suno_sample")] + SunoSample, + + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, +} + +#[cfg(test)] +mod tests { + use super::*; + + // NB: These strings must match `CommonAudioModel` — the two enums convert + // via serde string round-trip. + #[test] + fn all_variants_serialize_to_common_audio_model_strings() { + assert_serde_round_trip(RouterAudioModel::SunoMusic, "suno_music"); + assert_serde_round_trip(RouterAudioModel::SunoRemix, "suno_remix"); + assert_serde_round_trip(RouterAudioModel::SunoSounds, "suno_sounds"); + assert_serde_round_trip(RouterAudioModel::SunoSample, "suno_sample"); + assert_serde_round_trip(RouterAudioModel::SeedAudio1p0, "seed_audio_1p0"); + } + + #[test] + fn round_trips_through_common_audio_model() { + use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel; + + let cases = [ + (RouterAudioModel::SunoMusic, CommonAudioModel::SunoMusic), + (RouterAudioModel::SunoRemix, CommonAudioModel::SunoRemix), + (RouterAudioModel::SunoSounds, CommonAudioModel::SunoSounds), + (RouterAudioModel::SunoSample, CommonAudioModel::SunoSample), + (RouterAudioModel::SeedAudio1p0, CommonAudioModel::SeedAudio1p0), + ]; + for (router_model, expected_common) in cases { + let json = serde_json::to_string(&router_model).unwrap(); + let common: CommonAudioModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("CommonAudioModel failed to parse {json}: {e}")); + assert_eq!(common, expected_common, "for {router_model:?}"); + } + } + + fn assert_serde_round_trip(model: RouterAudioModel, expected: &str) { + let json = serde_json::to_string(&model).unwrap(); + assert_eq!(json, format!("\"{expected}\"")); + let parsed: RouterAudioModel = serde_json::from_str(&json).unwrap(); + // RouterAudioModel isn't PartialEq, so round-trip back to the wire form. + assert_eq!(serde_json::to_string(&parsed).unwrap(), json); + } +} diff --git a/crates/router/src/api/router_bitrate.rs b/crates/router/src/api/router_bitrate.rs new file mode 100644 index 00000000..ae9806a7 --- /dev/null +++ b/crates/router/src/api/router_bitrate.rs @@ -0,0 +1,10 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Output bitrate levels you can specify when enqueuing a generation. +/// Not every model will use this; models that don't simply ignore it. +#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum RouterBitrate { + Normal, + High, +} diff --git a/crates/router/src/api/router_image_model.rs b/crates/router/src/api/router_image_model.rs new file mode 100644 index 00000000..0dad2020 --- /dev/null +++ b/crates/router/src/api/router_image_model.rs @@ -0,0 +1,93 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Common image models supported by the router. +/// Not all models are available through all providers. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterImageModel { + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_pro_1p1")] + FluxPro11, + #[serde(rename = "flux_pro_1p1_ultra")] + FluxPro11Ultra, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + #[serde(rename = "grok_imagine_image")] + GrokImagineImage, + #[serde(rename = "grok_imagine_image_q")] + GrokImagineImageQuality, + #[serde(rename = "midjourney_7")] + Midjourney7, + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + #[serde(rename = "midjourney_8")] + Midjourney8, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + /// Higgsfield's Nano Banana 2 Lite (fixed 1K, High / Minimal quality). + #[serde(rename = "nano_banana_2_lite")] + NanoBanana2Lite, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, +} + +#[cfg(test)] +mod tests { + use super::*; + + fn assert_round_trip(model: RouterImageModel, expected_wire: &str) { + let json = serde_json::to_string(&model).unwrap(); + let unquoted = json.trim_matches('"'); + assert_eq!(unquoted, expected_wire, "serialize {:?}", model); + let back: RouterImageModel = serde_json::from_str(&json).unwrap(); + assert_eq!(back, model, "deserialize round-trip for {:?}", model); + } + + #[test] + fn midjourney_7_serializes_to_midjourney_7() { + assert_round_trip(RouterImageModel::Midjourney7, "midjourney_7"); + } + + #[test] + fn midjourney_7_niji_serializes_to_midjourney_7_niji() { + assert_round_trip(RouterImageModel::Midjourney7Niji, "midjourney_7_niji"); + } + + #[test] + fn midjourney_8_serializes_to_midjourney_8() { + assert_round_trip(RouterImageModel::Midjourney8, "midjourney_8"); + } + + #[test] + fn seedream_5p0_pro_serializes_to_seedream_5p0_pro() { + assert_round_trip(RouterImageModel::Seedream5p0Pro, "seedream_5p0_pro"); + } + + #[test] + fn seedream_5p0_pro_ultra_serializes_to_seedream_5p0_pro_u() { + assert_round_trip(RouterImageModel::Seedream5p0ProUltra, "seedream_5p0_pro_u"); + } +} diff --git a/crates/router/src/api/router_mesh_model.rs b/crates/router/src/api/router_mesh_model.rs new file mode 100644 index 00000000..2b84b8af --- /dev/null +++ b/crates/router/src/api/router_mesh_model.rs @@ -0,0 +1,107 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Common mesh (3D object) models supported by the router. +/// Not all models are available through all providers. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterMeshModel { + #[serde(rename = "hunyuan_3d_2p0")] + Hunyuan3d2p0, + + #[serde(rename = "hunyuan_3d_2p1")] + Hunyuan3d2p1, + + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + + /// Hunyuan 3D v3 in sketch-to-3D mode. Same underlying model as + /// [`Self::Hunyuan3d3`], but takes a sketch image plus a prompt as input. + #[serde(rename = "hunyuan_3d_3_sketch")] + Hunyuan3d3Sketch, + + /// Hunyuan 3D v3.1 Pro: text or (multi-view) image input. + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3p1Pro, + + /// Hunyuan 3D v3.1 Rapid: the fast, low-cost tier. Text or single-image + /// input. + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3p1Rapid, + + /// Hunyuan 3D v3.1 Part: splits an existing mesh into semantic parts. + /// Takes a mesh file as input, not text/images. + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3p1Part, + + /// Hunyuan 3D v3.1 Smart Topology: retopologizes an existing mesh. + /// Takes a mesh file as input, not text/images. + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3p1SmartTopology, + + /// Tripo3D H3.1: text, single-image, or multi-view image input. + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3p1, + + /// Meshy 6: text or single-image input. + #[serde(rename = "meshy_v6")] + MeshyV6, + + /// Hyper3D Rodin v2.5 Fast: text or image(s) input. + #[serde(rename = "rodin_2p5_fast")] + Rodin2p5Fast, +} + +#[cfg(test)] +mod tests { + use super::*; + + // NB: These strings must match `CommonMeshModel` — the two enums convert + // via serde string round-trip. + #[test] + fn all_variants_serialize_to_common_mesh_model_strings() { + assert_serde_round_trip(RouterMeshModel::Hunyuan3d2p0, "hunyuan_3d_2p0"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d2p1, "hunyuan_3d_2p1"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d3, "hunyuan_3d_3"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d3Sketch, "hunyuan_3d_3_sketch"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d3p1Pro, "hunyuan_3d_3p1_pro"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d3p1Rapid, "hunyuan_3d_3p1_rapid"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d3p1Part, "hunyuan_3d_3p1_part"); + assert_serde_round_trip(RouterMeshModel::Hunyuan3d3p1SmartTopology, "hunyuan_3d_3p1_topology"); + assert_serde_round_trip(RouterMeshModel::Tripo3dH3p1, "tripo3d_h3p1"); + assert_serde_round_trip(RouterMeshModel::MeshyV6, "meshy_v6"); + assert_serde_round_trip(RouterMeshModel::Rodin2p5Fast, "rodin_2p5_fast"); + } + + #[test] + fn round_trips_through_common_mesh_model() { + use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel; + + let cases = [ + (RouterMeshModel::Hunyuan3d2p0, CommonMeshModel::Hunyuan3d2p0), + (RouterMeshModel::Hunyuan3d2p1, CommonMeshModel::Hunyuan3d2p1), + (RouterMeshModel::Hunyuan3d3, CommonMeshModel::Hunyuan3d3), + (RouterMeshModel::Hunyuan3d3Sketch, CommonMeshModel::Hunyuan3d3Sketch), + (RouterMeshModel::Hunyuan3d3p1Pro, CommonMeshModel::Hunyuan3d3p1Pro), + (RouterMeshModel::Hunyuan3d3p1Rapid, CommonMeshModel::Hunyuan3d3p1Rapid), + (RouterMeshModel::Hunyuan3d3p1Part, CommonMeshModel::Hunyuan3d3p1Part), + (RouterMeshModel::Hunyuan3d3p1SmartTopology, CommonMeshModel::Hunyuan3d3p1SmartTopology), + (RouterMeshModel::Tripo3dH3p1, CommonMeshModel::Tripo3dH3p1), + (RouterMeshModel::MeshyV6, CommonMeshModel::MeshyV6), + (RouterMeshModel::Rodin2p5Fast, CommonMeshModel::Rodin2p5Fast), + ]; + for (router_model, expected_common) in cases { + let json = serde_json::to_string(&router_model).unwrap(); + let common: CommonMeshModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("CommonMeshModel failed to parse {json}: {e}")); + assert_eq!(common, expected_common, "for {router_model:?}"); + } + } + + fn assert_serde_round_trip(model: RouterMeshModel, expected: &str) { + let json = serde_json::to_string(&model).unwrap(); + assert_eq!(json, format!("\"{expected}\"")); + let parsed: RouterMeshModel = serde_json::from_str(&json).unwrap(); + // RouterMeshModel isn't PartialEq, so round-trip back to the wire form. + assert_eq!(serde_json::to_string(&parsed).unwrap(), json); + } +} diff --git a/crates/router/src/api/router_provider.rs b/crates/router/src/api/router_provider.rs new file mode 100644 index 00000000..55fb16de --- /dev/null +++ b/crates/router/src/api/router_provider.rs @@ -0,0 +1,18 @@ +use serde_derive::{Deserialize, Serialize}; + +/// The provider to route a generation request to. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterProvider { + Artcraft, + Fal, + GmiCloud, + GrokApi, + /// First-party (cookie-session) Grok Imagine. + Grok, + /// First-party (cookie-session) Higgsfield. + Higgsfield, + /// First-party (cookie-session) Midjourney. + Midjourney, + Seedance2Pro, +} diff --git a/crates/router/src/api/router_quality.rs b/crates/router/src/api/router_quality.rs new file mode 100644 index 00000000..b195a84b --- /dev/null +++ b/crates/router/src/api/router_quality.rs @@ -0,0 +1,11 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Common quality levels you can specify when enqueuing a generation. +/// Not every model will use this; models that don't simply ignore it. +#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum RouterQuality { + High, + Medium, + Low, +} diff --git a/crates/router/src/api/router_resolution.rs b/crates/router/src/api/router_resolution.rs new file mode 100644 index 00000000..22ae64cd --- /dev/null +++ b/crates/router/src/api/router_resolution.rs @@ -0,0 +1,29 @@ +use serde_derive::{Deserialize, Serialize}; + +/// This is a comprehensive list of common resolutions you can specify when enqueuing a generation. +/// Not every model will support every resolution. +/// In the case a model doesn't support the resolution, gracefully pick the nearest option. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterResolution { + /// Models: Nano Banana Pro + OneK, + /// Models: Nano Banana Pro + TwoK, + /// Models: (None) + ThreeK, + /// Models: Nano Banana Pro + FourK, + + /// Used by Nano Banana 2 (and others) + HalfK, + + /// Used by the Seedance family (and others) + FourEightyP, + + /// Used by the Seedance family (and others) + SevenTwentyP, + + /// Used by the Seedance family (and others) + TenEightyP, +} diff --git a/crates/router/src/api/router_splat_model.rs b/crates/router/src/api/router_splat_model.rs new file mode 100644 index 00000000..811482c7 --- /dev/null +++ b/crates/router/src/api/router_splat_model.rs @@ -0,0 +1,78 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Common splat models supported by the router. +/// Not all models are available through all providers. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterSplatModel { + /// Deprecated upstream; treated as [`Self::Marble1p0Draft`]. + #[serde(rename = "marble_0p1_mini")] + Marble0p1Mini, + + /// Deprecated upstream; treated as [`Self::Marble1p0`]. + #[serde(rename = "marble_0p1_plus")] + Marble0p1Plus, + + #[serde(rename = "marble_1p0")] + Marble1p0, + + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + + #[serde(rename = "marble_1p1")] + Marble1p1, + + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + + /// TripoSplat: single-image to 3D Gaussian splat (via Fal). + #[serde(rename = "triposplat")] + TripoSplat, +} + +#[cfg(test)] +mod tests { + use super::*; + + // NB: These strings must match `CommonSplatModel` — the two enums convert + // via serde string round-trip. + #[test] + fn all_variants_serialize_to_common_splat_model_strings() { + assert_serde_round_trip(RouterSplatModel::Marble0p1Mini, "marble_0p1_mini"); + assert_serde_round_trip(RouterSplatModel::Marble0p1Plus, "marble_0p1_plus"); + assert_serde_round_trip(RouterSplatModel::Marble1p0, "marble_1p0"); + assert_serde_round_trip(RouterSplatModel::Marble1p0Draft, "marble_1p0_draft"); + assert_serde_round_trip(RouterSplatModel::Marble1p1, "marble_1p1"); + assert_serde_round_trip(RouterSplatModel::Marble1p1Plus, "marble_1p1_plus"); + assert_serde_round_trip(RouterSplatModel::TripoSplat, "triposplat"); + } + + #[test] + fn round_trips_through_common_splat_model() { + use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel; + + let cases = [ + (RouterSplatModel::Marble0p1Mini, CommonSplatModel::Marble0p1Mini), + (RouterSplatModel::Marble0p1Plus, CommonSplatModel::Marble0p1Plus), + (RouterSplatModel::Marble1p0, CommonSplatModel::Marble1p0), + (RouterSplatModel::Marble1p0Draft, CommonSplatModel::Marble1p0Draft), + (RouterSplatModel::Marble1p1, CommonSplatModel::Marble1p1), + (RouterSplatModel::Marble1p1Plus, CommonSplatModel::Marble1p1Plus), + (RouterSplatModel::TripoSplat, CommonSplatModel::TripoSplat), + ]; + for (router_model, expected_common) in cases { + let json = serde_json::to_string(&router_model).unwrap(); + let common: CommonSplatModel = serde_json::from_str(&json) + .unwrap_or_else(|e| panic!("CommonSplatModel failed to parse {json}: {e}")); + assert_eq!(common, expected_common, "for {router_model:?}"); + } + } + + fn assert_serde_round_trip(model: RouterSplatModel, expected: &str) { + let json = serde_json::to_string(&model).unwrap(); + assert_eq!(json, format!("\"{expected}\"")); + let parsed: RouterSplatModel = serde_json::from_str(&json).unwrap(); + // RouterSplatModel isn't PartialEq, so round-trip back to the wire form. + assert_eq!(serde_json::to_string(&parsed).unwrap(), json); + } +} diff --git a/crates/router/src/api/router_video_model.rs b/crates/router/src/api/router_video_model.rs new file mode 100644 index 00000000..55d5a44f --- /dev/null +++ b/crates/router/src/api/router_video_model.rs @@ -0,0 +1,151 @@ +use serde_derive::{Deserialize, Serialize}; + +/// Common video models supported by the router. +/// Not all models are available through all providers. +#[derive(Copy, Clone, Debug, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum RouterVideoModel { + #[serde(rename = "grok_video")] + GrokVideo, + + #[serde(rename = "grok_imagine_video")] + GrokImagineVideo, + + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + + #[serde(rename = "kling_1p6_pro")] + Kling16Pro, + + #[serde(rename = "kling_2p1_pro")] + Kling21Pro, + + #[serde(rename = "kling_2p1_master")] + Kling21Master, + + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + + #[serde(rename = "seedance_1p0_lite")] + Seedance10Lite, + + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + + #[serde(rename = "seedance_2p0")] + Seedance2p0, + + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + + #[serde(rename = "seedance_2p0_bp")] + Seedance2p0BytePlus, + + #[serde(rename = "seedance_2p0_bp_fast")] + Seedance2p0BytePlusFast, + + #[serde(rename = "seedance_2p0_u")] + Seedance2p0Ultra, + + #[serde(rename = "seedance_2p0_u_fast")] + Seedance2p0UltraFast, + + #[serde(rename = "seedance_2p0_bpu")] + Seedance2p0BytePlusUltra, + + #[serde(rename = "seedance_2p0_bpu_fast")] + Seedance2p0BytePlusUltraFast, + + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + + #[serde(rename = "seedance_2p0_bp_mini")] + Seedance2p0BytePlusMini, + + #[serde(rename = "seedance_2p0_bpu_mini")] + Seedance2p0BytePlusUltraMini, + #[serde(rename = "seedance_2p5")] + Seedance2p5, + /// Seedance 2.5 video-to-video editing. + #[serde(rename = "seedance_2p5_edit")] + Seedance2p5Edit, + #[serde(rename = "minimax_h3")] + MinimaxH3, + + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + + #[serde(rename = "sora_2")] + Sora2, + + #[serde(rename = "sora_2_pro")] + Sora2Pro, + + #[serde(rename = "veo_2")] + Veo2, + + #[serde(rename = "veo_3")] + Veo3, + + #[serde(rename = "veo_3_fast")] + Veo3Fast, + + #[serde(rename = "veo_3p1")] + Veo3p1, + + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + + #[serde(rename = "vidu_q3")] + ViduQ3, + + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, + + #[serde(rename = "preview_model")] + PreviewModel, + + #[serde(rename = "preview_model_fast")] + PreviewModelFast, +} + +#[cfg(test)] +mod tests { + use super::*; + + fn assert_serde_round_trip(model: RouterVideoModel, expected: &str) { + let json = serde_json::to_string(&model).unwrap(); + assert_eq!(json, format!("\"{expected}\"")); + let parsed: RouterVideoModel = serde_json::from_str(&json).unwrap(); + // RouterVideoModel isn't PartialEq, so round-trip back to the wire form. + assert_eq!(serde_json::to_string(&parsed).unwrap(), json); + } + + #[test] + fn seedance_2p0_mini_variants_serialize() { + assert_serde_round_trip(RouterVideoModel::Seedance2p0Mini, "seedance_2p0_mini"); + assert_serde_round_trip(RouterVideoModel::Seedance2p0BytePlusMini, "seedance_2p0_bp_mini"); + assert_serde_round_trip(RouterVideoModel::Seedance2p0BytePlusUltraMini, "seedance_2p0_bpu_mini"); + } + + #[test] + fn veo_3p1_lite_and_vidu_variants_serialize() { + // NB: These strings must match `CommonVideoModel` — the two enums convert + // via serde string round-trip in the omni handlers. + assert_serde_round_trip(RouterVideoModel::Veo3p1Lite, "veo_3p1_lite"); + assert_serde_round_trip(RouterVideoModel::ViduQ3, "vidu_q3"); + assert_serde_round_trip(RouterVideoModel::ViduQ3Turbo, "vidu_q3_turbo"); + } +} diff --git a/crates/router/src/api/video_list_ref.rs b/crates/router/src/api/video_list_ref.rs new file mode 100644 index 00000000..60c09787 --- /dev/null +++ b/crates/router/src/api/video_list_ref.rs @@ -0,0 +1,35 @@ +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::video_ref::VideoRef; + +#[derive(Clone, Debug)] +pub enum VideoListRef { + MediaFileTokens(Vec), + Urls(Vec), + /// Mixed per-item sources (tokens, URLs, local paths, bytes) — the general + /// form; the homogeneous variants above remain as conveniences. + Sources(Vec), +} + +impl VideoListRef { + /// Normalize any variant into per-item refs, in order. + pub fn into_refs(self) -> Vec { + match self { + Self::MediaFileTokens(tokens) => tokens.into_iter().map(VideoRef::MediaFileToken).collect(), + Self::Urls(urls) => urls.into_iter().map(VideoRef::Url).collect(), + Self::Sources(refs) => refs, + } + } + + pub fn len(&self) -> usize { + match self { + Self::MediaFileTokens(tokens) => tokens.len(), + Self::Urls(urls) => urls.len(), + Self::Sources(refs) => refs.len(), + } + } + + pub fn is_empty(&self) -> bool { + self.len() == 0 + } +} diff --git a/crates/router/src/api/video_ref.rs b/crates/router/src/api/video_ref.rs new file mode 100644 index 00000000..a9891543 --- /dev/null +++ b/crates/router/src/api/video_ref.rs @@ -0,0 +1,16 @@ +use std::path::PathBuf; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::media_bytes::MediaBytes; + +#[derive(Clone, Debug)] +pub enum VideoRef { + MediaFileToken(MediaFileToken), + Url(String), + /// A file on the local filesystem; read directly, never round-tripped + /// through the ArtCraft cloud. + LocalPath(PathBuf), + /// Bytes the caller already holds (e.g. pasted media). + Bytes(MediaBytes), +} diff --git a/crates/router/src/client/generation_mode_mismatch_strategy.rs b/crates/router/src/client/generation_mode_mismatch_strategy.rs new file mode 100644 index 00000000..2a920a84 --- /dev/null +++ b/crates/router/src/client/generation_mode_mismatch_strategy.rs @@ -0,0 +1,12 @@ + +/// Strategy for handling requests where the model only supports text-to-image +/// but the request includes image inputs (image editing mode). +#[derive(Copy, Clone, Debug)] +pub enum GenerationModeMismatchStrategy { + /// Abort the generation: return an error if image inputs are provided + /// for a text-to-image-only model. + AbortGeneration, + + /// Proceed anyway, ignoring the image inputs for the generation. + GenerateAnyway, +} diff --git a/crates/router/src/client/mod.rs b/crates/router/src/client/mod.rs new file mode 100644 index 00000000..680be1a1 --- /dev/null +++ b/crates/router/src/client/mod.rs @@ -0,0 +1,13 @@ +pub mod generation_mode_mismatch_strategy; +pub mod multi_router_client; +pub mod multi_router_client_builder; +pub mod request_mismatch_mitigation_strategy; +pub mod router_artcraft_client; +pub mod router_client; +pub mod router_fal_client; +pub mod router_gmicloud_client; +pub mod router_grok_api_client; +pub mod router_grok_client; +pub mod router_higgsfield_client; +pub mod router_midjourney_client; +pub mod router_seedance2pro_client; diff --git a/crates/router/src/client/multi_router_client.rs b/crates/router/src/client/multi_router_client.rs new file mode 100644 index 00000000..6edf7b6b --- /dev/null +++ b/crates/router/src/client/multi_router_client.rs @@ -0,0 +1,63 @@ +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::client::router_fal_client::RouterFalClient; +use crate::client::router_gmicloud_client::RouterGmiCloudClient; +use crate::client::router_grok_api_client::RouterGrokApiClient; +use crate::client::router_grok_client::RouterGrokClient; +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::client::router_midjourney_client::RouterMidjourneyClient; +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::client_error::{ClientError, ClientType}; + +pub struct MultiRouterClient { + pub(crate) artcraft_client: Option, + pub(crate) fal_client: Option, + pub(crate) gmicloud_client: Option, + pub(crate) grok_api_client: Option, + pub(crate) grok_client: Option, + pub(crate) higgsfield_client: Option, + pub(crate) midjourney_client: Option, + pub(crate) seedance2pro_client: Option, +} + +impl MultiRouterClient { + pub fn get_artcraft_client_ref(&self) -> Result<&RouterArtcraftClient, ClientError> { + self.artcraft_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::Artcraft)) + } + + pub fn get_fal_client_ref(&self) -> Result<&RouterFalClient, ClientError> { + self.fal_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::Fal)) + } + + pub fn get_gmicloud_client_ref(&self) -> Result<&RouterGmiCloudClient, ClientError> { + self.gmicloud_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::GmiCloud)) + } + + pub fn get_grok_api_client_ref(&self) -> Result<&RouterGrokApiClient, ClientError> { + self.grok_api_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::GrokApi)) + } + + pub fn get_grok_client_ref(&self) -> Result<&RouterGrokClient, ClientError> { + self.grok_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::Grok)) + } + + pub fn get_higgsfield_client_ref(&self) -> Result<&RouterHiggsfieldClient, ClientError> { + self.higgsfield_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::Higgsfield)) + } + + pub fn get_midjourney_client_ref(&self) -> Result<&RouterMidjourneyClient, ClientError> { + self.midjourney_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::Midjourney)) + } + + pub fn get_seedance2pro_client_ref(&self) -> Result<&RouterSeedance2ProClient, ClientError> { + self.seedance2pro_client.as_ref() + .ok_or(ClientError::ClientNotConfigured(ClientType::Seedance2Pro)) + } + +} diff --git a/crates/router/src/client/multi_router_client_builder.rs b/crates/router/src/client/multi_router_client_builder.rs new file mode 100644 index 00000000..cd8b1a4c --- /dev/null +++ b/crates/router/src/client/multi_router_client_builder.rs @@ -0,0 +1,89 @@ +use crate::client::multi_router_client::MultiRouterClient; +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::client::router_fal_client::RouterFalClient; +use crate::client::router_gmicloud_client::RouterGmiCloudClient; +use crate::client::router_grok_api_client::RouterGrokApiClient; +use crate::client::router_grok_client::RouterGrokClient; +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::client::router_midjourney_client::RouterMidjourneyClient; +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + +pub struct MultiRouterClientBuilder { + artcraft_client: Option, + fal_client: Option, + gmicloud_client: Option, + grok_api_client: Option, + grok_client: Option, + higgsfield_client: Option, + midjourney_client: Option, + seedance2pro_client: Option, +} + +impl MultiRouterClientBuilder { + pub fn new() -> Self { + Self { + artcraft_client: None, + fal_client: None, + gmicloud_client: None, + grok_api_client: None, + grok_client: None, + higgsfield_client: None, + midjourney_client: None, + seedance2pro_client: None, + } + } + + pub fn set_artcraft_client(mut self, client: RouterArtcraftClient) -> Self { + self.artcraft_client = Some(client); + self + } + + pub fn set_fal_client(mut self, client: RouterFalClient) -> Self { + self.fal_client = Some(client); + self + } + + pub fn set_gmicloud_client(mut self, client: RouterGmiCloudClient) -> Self { + self.gmicloud_client = Some(client); + self + } + + pub fn set_grok_api_client(mut self, client: RouterGrokApiClient) -> Self { + self.grok_api_client = Some(client); + self + } + + pub fn set_grok_client(mut self, client: RouterGrokClient) -> Self { + self.grok_client = Some(client); + self + } + + pub fn set_higgsfield_client(mut self, client: RouterHiggsfieldClient) -> Self { + self.higgsfield_client = Some(client); + self + } + + pub fn set_midjourney_client(mut self, client: RouterMidjourneyClient) -> Self { + self.midjourney_client = Some(client); + self + } + + pub fn set_seedance2pro_client(mut self, client: RouterSeedance2ProClient) -> Self { + self.seedance2pro_client = Some(client); + self + } + + + pub fn build(self) -> MultiRouterClient { + MultiRouterClient { + artcraft_client: self.artcraft_client, + fal_client: self.fal_client, + gmicloud_client: self.gmicloud_client, + grok_api_client: self.grok_api_client, + grok_client: self.grok_client, + higgsfield_client: self.higgsfield_client, + midjourney_client: self.midjourney_client, + seedance2pro_client: self.seedance2pro_client, + } + } +} diff --git a/crates/router/src/client/request_mismatch_mitigation_strategy.rs b/crates/router/src/client/request_mismatch_mitigation_strategy.rs new file mode 100644 index 00000000..2c57e2e2 --- /dev/null +++ b/crates/router/src/client/request_mismatch_mitigation_strategy.rs @@ -0,0 +1,12 @@ + +#[derive(Copy, Clone, Debug)] +pub enum RequestMismatchMitigationStrategy { + /// Upgrade the request to pay more. + PayMoreUpgrade, + + /// Downgrade the request to pay less + PayLessDowngrade, + + /// Fail the request. + ErrorOut, +} diff --git a/crates/router/src/client/router_artcraft_client.rs b/crates/router/src/client/router_artcraft_client.rs new file mode 100644 index 00000000..a8038c34 --- /dev/null +++ b/crates/router/src/client/router_artcraft_client.rs @@ -0,0 +1,13 @@ +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::utils::api_host::ApiHost; + +pub struct RouterArtcraftClient { + pub(crate) api_host: ApiHost, + pub(crate) credentials: StorytellerCredentialSet, +} + +impl RouterArtcraftClient { + pub fn new(api_host: ApiHost, credentials: StorytellerCredentialSet) -> Self { + Self { api_host, credentials } + } +} diff --git a/crates/router/src/client/router_client.rs b/crates/router/src/client/router_client.rs new file mode 100644 index 00000000..b4011442 --- /dev/null +++ b/crates/router/src/client/router_client.rs @@ -0,0 +1,89 @@ +use crate::client::multi_router_client::MultiRouterClient; +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::client::router_fal_client::RouterFalClient; +use crate::client::router_gmicloud_client::RouterGmiCloudClient; +use crate::client::router_grok_api_client::RouterGrokApiClient; +use crate::client::router_grok_client::RouterGrokClient; +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::client::router_midjourney_client::RouterMidjourneyClient; +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::client_error::{ClientError, ClientType}; + +pub enum RouterClient { + Multi(MultiRouterClient), + Artcraft(RouterArtcraftClient), + Fal(RouterFalClient), + GmiCloud(RouterGmiCloudClient), + GrokApi(RouterGrokApiClient), + Grok(RouterGrokClient), + Higgsfield(RouterHiggsfieldClient), + Midjourney(RouterMidjourneyClient), + Seedance2Pro(RouterSeedance2ProClient), +} + +impl RouterClient { + pub fn get_artcraft_client_ref(&self) -> Result<&RouterArtcraftClient, ClientError> { + match self { + RouterClient::Artcraft(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_artcraft_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::Artcraft)), + } + } + + pub fn get_fal_client_ref(&self) -> Result<&RouterFalClient, ClientError> { + match self { + RouterClient::Fal(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_fal_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::Fal)), + } + } + + pub fn get_gmicloud_client_ref(&self) -> Result<&RouterGmiCloudClient, ClientError> { + match self { + RouterClient::GmiCloud(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_gmicloud_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::GmiCloud)), + } + } + + pub fn get_grok_api_client_ref(&self) -> Result<&RouterGrokApiClient, ClientError> { + match self { + RouterClient::GrokApi(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_grok_api_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::GrokApi)), + } + } + + pub fn get_grok_client_ref(&self) -> Result<&RouterGrokClient, ClientError> { + match self { + RouterClient::Grok(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_grok_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::Grok)), + } + } + + pub fn get_higgsfield_client_ref(&self) -> Result<&RouterHiggsfieldClient, ClientError> { + match self { + RouterClient::Higgsfield(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_higgsfield_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::Higgsfield)), + } + } + + pub fn get_midjourney_client_ref(&self) -> Result<&RouterMidjourneyClient, ClientError> { + match self { + RouterClient::Midjourney(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_midjourney_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::Midjourney)), + } + } + + pub fn get_seedance2pro_client_ref(&self) -> Result<&RouterSeedance2ProClient, ClientError> { + match self { + RouterClient::Seedance2Pro(client) => Ok(client), + RouterClient::Multi(multi) => multi.get_seedance2pro_client_ref(), + _ => Err(ClientError::ClientNotConfigured(ClientType::Seedance2Pro)), + } + } + +} diff --git a/crates/router/src/client/router_fal_client.rs b/crates/router/src/client/router_fal_client.rs new file mode 100644 index 00000000..7ffdf931 --- /dev/null +++ b/crates/router/src/client/router_fal_client.rs @@ -0,0 +1,30 @@ +use fal_client::creds::fal_api_key::FalApiKey; + +/// A unified Fal client. The caller picks the dispatch mode: +/// +/// - `Some(webhook_url)` → endpoints will use Fal's webhook flow. +/// - `None` → endpoints will use the queue/polling flow (where available). +/// +/// Some endpoints are webhook-only (their fal_client wrapper lives under the +/// `requests_old::webhook::*` namespace and has no `api::` queue variant). Those +/// will return `ClientError::WebhookUrlRequired` when constructed with `None`. +pub struct RouterFalClient { + pub(crate) api_key: FalApiKey, + pub(crate) webhook_url: Option, +} + +impl RouterFalClient { + /// Build a client for webhook dispatch. + pub fn new_with_webhook(api_key: FalApiKey, webhook_url: String) -> Self { + Self { api_key, webhook_url: Some(webhook_url) } + } + + /// Build a client for queue/polling dispatch (no webhook URL). + pub fn new_polling_only(api_key: FalApiKey) -> Self { + Self { api_key, webhook_url: None } + } + + pub fn new_polling_only_from_raw_key(api_key: &str) -> Self { + Self::new_polling_only(FalApiKey::from_str(api_key)) + } +} diff --git a/crates/router/src/client/router_gmicloud_client.rs b/crates/router/src/client/router_gmicloud_client.rs new file mode 100644 index 00000000..8660ffd2 --- /dev/null +++ b/crates/router/src/client/router_gmicloud_client.rs @@ -0,0 +1,11 @@ +use gmicloud_client::creds::gmicloud_api_key::GmiCloudApiKey; + +pub struct RouterGmiCloudClient { + pub(crate) api_key: GmiCloudApiKey, +} + +impl RouterGmiCloudClient { + pub fn new(api_key: GmiCloudApiKey) -> Self { + RouterGmiCloudClient { api_key } + } +} diff --git a/crates/router/src/client/router_grok_api_client.rs b/crates/router/src/client/router_grok_api_client.rs new file mode 100644 index 00000000..816f5730 --- /dev/null +++ b/crates/router/src/client/router_grok_api_client.rs @@ -0,0 +1,11 @@ +use grok_api_client::creds::grok_api_key::GrokApiKey; + +pub struct RouterGrokApiClient { + pub(crate) api_key: GrokApiKey, +} + +impl RouterGrokApiClient { + pub fn new(api_key: GrokApiKey) -> Self { + RouterGrokApiClient { api_key } + } +} diff --git a/crates/router/src/client/router_grok_client.rs b/crates/router/src/client/router_grok_client.rs new file mode 100644 index 00000000..4d91a9e2 --- /dev/null +++ b/crates/router/src/client/router_grok_client.rs @@ -0,0 +1,29 @@ +use grok_consumer_client::endpoint_bindings::generate_image_websocket::grok_generate_image_websocket::GrokImageWebsocket; + +/// The first-party (cookie-session) Grok client used by the router. +/// +/// Drives the user's own logged-in grok.com session directly via captured +/// cookies (distinct from the API-key `RouterGrokApiClient`). Image generation +/// runs over Grok's "imagine" websocket — the app owns one live socket per +/// account and hands the router a handle; the router only *sends* prompts on +/// it (the app's polling thread reads the results). Video generation +/// additionally needs an `x-statsig-id` signature. +// NB: `cookie_header` / `maybe_statsig` are carried for the (HTTP) video path; +// the image path only uses the websocket. +#[allow(dead_code)] +pub struct RouterGrokClient { + pub(crate) cookie_header: String, + + /// A browser-minted `x-statsig-id` for `POST /rest/app-chat/conversations/new` + /// (video only). `None` when unavailable — image generation ignores it. + pub(crate) maybe_statsig: Option, + + /// The account's live imagine websocket. A cheap, shareable handle. + pub(crate) image_websocket: GrokImageWebsocket, +} + +impl RouterGrokClient { + pub fn new(cookie_header: String, maybe_statsig: Option, image_websocket: GrokImageWebsocket) -> Self { + Self { cookie_header, maybe_statsig, image_websocket } + } +} diff --git a/crates/router/src/client/router_higgsfield_client.rs b/crates/router/src/client/router_higgsfield_client.rs new file mode 100644 index 00000000..9cf13127 --- /dev/null +++ b/crates/router/src/client/router_higgsfield_client.rs @@ -0,0 +1,22 @@ +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; + +/// The first-party (cookie-session) Higgsfield client used by the router. +/// +/// Drives the user's own logged-in higgsfield.ai account through a +/// [`HiggsfieldSession`], which mints and refreshes the short-lived Clerk +/// bearer token on its own and replays the captured cookies under the +/// User-Agent that earned them. The router enqueues jobs (and uploads +/// reference media first); the app polls job status itself. +pub struct RouterHiggsfieldClient { + pub(crate) session: HiggsfieldSession, +} + +impl RouterHiggsfieldClient { + pub fn new(session: HiggsfieldSession) -> Self { + Self { session } + } + + pub fn session(&self) -> &HiggsfieldSession { + &self.session + } +} diff --git a/crates/router/src/client/router_midjourney_client.rs b/crates/router/src/client/router_midjourney_client.rs new file mode 100644 index 00000000..79db2a81 --- /dev/null +++ b/crates/router/src/client/router_midjourney_client.rs @@ -0,0 +1,28 @@ +use browser_emulation::browser_profile::BrowserProfile; +use midjourney_client::credentials::midjourney_user_id::MidjourneyUserId; + +/// The first-party (cookie-session) Midjourney client used by the router. +/// +/// Unlike the Kinovi/Seedance2Pro Midjourney path (which is backend-billed), +/// this drives the user's own logged-in midjourney.com session directly via +/// captured cookies. The `browser` profile MUST match the browser that +/// captured the cookies — Cloudflare's `cf_clearance` cookie is bound to the +/// User-Agent. +pub struct RouterMidjourneyClient { + pub(crate) cookie_header: String, + + /// Needed to form the `singleplayer_{user_id}` channel id on submit. + pub(crate) user_id: MidjourneyUserId, + + pub(crate) browser: BrowserProfile, +} + +impl RouterMidjourneyClient { + pub fn new(cookie_header: String, user_id: MidjourneyUserId, browser: BrowserProfile) -> Self { + Self { + cookie_header, + user_id, + browser, + } + } +} diff --git a/crates/router/src/client/router_seedance2pro_client.rs b/crates/router/src/client/router_seedance2pro_client.rs new file mode 100644 index 00000000..10390a9c --- /dev/null +++ b/crates/router/src/client/router_seedance2pro_client.rs @@ -0,0 +1,11 @@ +use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + +pub struct RouterSeedance2ProClient { + pub(crate) session: Seedance2ProSession, +} + +impl RouterSeedance2ProClient { + pub fn new(session: Seedance2ProSession) -> Self { + RouterSeedance2ProClient { session } + } +} diff --git a/crates/router/src/errors/artcraft_router_error.rs b/crates/router/src/errors/artcraft_router_error.rs new file mode 100644 index 00000000..c3970105 --- /dev/null +++ b/crates/router/src/errors/artcraft_router_error.rs @@ -0,0 +1,94 @@ +use crate::errors::client_error::ClientError; +use crate::errors::download_error::DownloadError; +use crate::errors::provider_error::ProviderError; +use fal_client::error::fal_error_plus::FalErrorPlus; +use higgsfield_client::error::higgsfield_api_error::HiggsfieldApiError; +use higgsfield_client::error::higgsfield_error::HiggsfieldError; +use seedance2pro_client::error::seedance2pro_error::Seedance2ProError; +use seedance2pro_client::error::seedance2pro_specific_api_error::Seedance2ProSpecificApiError; +use std::error::Error; +use std::fmt::{Display, Formatter}; +use artcraft_client::error::api_error::ApiError; +use artcraft_client::error::storyteller_error::StorytellerError; + +#[derive(Debug)] +pub enum ArtcraftRouterError { + /// A client configuration error. + Client(ClientError), + + /// Failed to download a file from a URL (e.g. when re-uploading to a provider's CDN). + Download(DownloadError), + + /// The requested model is not yet supported by the router. + UnsupportedModel(String), + + /// [Temporary during migration] The requested model/provider is not yet supported by the router. + UnsupportedProviderAndModelForNewApi(String), + + /// Invalid or missing input arguments. + InvalidInput(String), + + /// An error from an underlying provider. + Provider(ProviderError), + + /// A billing error from an underlying provider. + ProviderBillingError(ProviderError), + /// The provider accepted the request but answered without the data the + /// router needs to track it (e.g. no job ids). + ProviderResponseInvalid(String), +} + +impl Error for ArtcraftRouterError {} + +impl Display for ArtcraftRouterError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::Client(e) => write!(f, "Client error: {}", e), + Self::Download(e) => write!(f, "Download error: {}", e), + Self::UnsupportedModel(model) => write!(f, "Unsupported model: {}", model), + Self::UnsupportedProviderAndModelForNewApi(msg) => write!(f, "Unsupported provider/model (for new API during migration): {}", msg), + Self::InvalidInput(msg) => write!(f, "Invalid input: {}", msg), + Self::Provider(e) => write!(f, "Provider error: {}", e), + Self::ProviderBillingError(e) => write!(f, "Provider billing error: {}", e), + Self::ProviderResponseInvalid(msg) => write!(f, "Provider response invalid: {}", msg), + } + } +} + +impl From for ArtcraftRouterError { + fn from(error: ClientError) -> Self { + Self::Client(error) + } +} + +impl From for ArtcraftRouterError { + fn from(error: DownloadError) -> Self { + Self::Download(error) + } +} + +impl From for ArtcraftRouterError { + fn from(error: ProviderError) -> Self { + let is_billing_error = match &error { + ProviderError::Fal(FalErrorPlus::FalBillingError(_)) => true, + ProviderError::Seedance2Pro(Seedance2ProError::ApiSpecific(Seedance2ProSpecificApiError::BillingError { .. })) => true, + ProviderError::Storyteller(StorytellerError::Api(ApiError::PaymentRequired(_))) => true, + ProviderError::Higgsfield(HiggsfieldError::Api(HiggsfieldApiError::InsufficientCredits { .. })) => true, + _ => false, + }; + if is_billing_error { + Self::ProviderBillingError(error) + } else { + Self::Provider(error) + } + } +} + +impl From for ArtcraftRouterError { + fn from(error: FalErrorPlus) -> Self { + match &error { + FalErrorPlus::FalBillingError(e) => ArtcraftRouterError::ProviderBillingError(ProviderError::Fal(error)), + _ => ArtcraftRouterError::Provider(ProviderError::Fal(error)), + } + } +} diff --git a/crates/router/src/errors/client_error.rs b/crates/router/src/errors/client_error.rs new file mode 100644 index 00000000..f6c1e26e --- /dev/null +++ b/crates/router/src/errors/client_error.rs @@ -0,0 +1,140 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; +use std::path::PathBuf; +use artcraft_client::tokens::characters::CharacterToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +#[derive(Debug, Clone, Copy)] +pub enum ClientType { + Artcraft, + Fal, + GmiCloud, + GrokApi, + Grok, + Higgsfield, + Midjourney, + Seedance2Pro, +} + +impl Display for ClientType { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::Artcraft => write!(f, "Artcraft"), + Self::Fal => write!(f, "Fal"), + Self::GmiCloud => write!(f, "GmiCloud"), + Self::GrokApi => write!(f, "GrokApi"), + Self::Grok => write!(f, "Grok"), + Self::Higgsfield => write!(f, "Higgsfield"), + Self::Midjourney => write!(f, "Midjourney"), + Self::Seedance2Pro => write!(f, "Seedance2Pro"), + } + } +} + +#[derive(Debug)] +pub enum ClientError { + /// A RouterClient was required but not provided on the draft context. + RouterClientNotProvided, + + /// The requested client is not configured on the RouterClient. + ClientNotConfigured(ClientType), + + /// The model does not support the given option value. + /// `field` is the request field name, `value` is what was requested. + ModelDoesNotSupportOption { field: &'static str, value: String }, + + /// The caller requested zero generations, which is never valid. + UserRequestedZeroGenerations, + + /// ArtCraft only accepts media tokens for image inputs, not raw URLs. + ArtcraftOnlySupportsMediaTokens, + + /// Fal only accepts image URLs for image inputs, not media tokens. + FalOnlySupportsUrls, + + /// Seedance2Pro only accepts URLs for media inputs, not media tokens. + Seedance2ProOnlySupportsUrls, + + /// The Fal endpoint requires a webhook URL but the caller built the client + /// in polling/queue mode (no webhook URL). Returned by webhook-only + /// endpoints (those whose fal_client wrapper has no `api::` queue variant). + WebhookUrlRequired, + + /// The pre-dispatch context of media file token to URL map was not supplied. + MediaFileToUrlMapNotProvided, + + /// A media file token was not found in the provided media-file-to-URL map. + MediaFileTokenNotFoundInMap { token: MediaFileToken }, + + /// The pre-dispatch context of character token to ID map was not supplied. + CharacterTokenToKinoviCharacterIdNotProvided, + + /// A character token was not found in the provided character-token-to-id map + CharacterTokenNotFoundInMap { token: CharacterToken }, + + /// A local-file reference points at a path that doesn't exist (or isn't a + /// regular file). + LocalFileNotFound { path: PathBuf }, + + /// A local-file reference exists but couldn't be read. + LocalFileRead { path: PathBuf, error: std::io::Error }, + + /// This provider can't take local files or raw bytes directly; the caller + /// must convert the reference first (e.g. upload it to obtain a token or + /// URL). + ProviderCannotUseLocalMedia { client_type: ClientType }, +} + +impl Error for ClientError {} + +impl Display for ClientError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::RouterClientNotProvided => { + write!(f, "A RouterClient is required but was not provided on the draft context") + } + Self::ClientNotConfigured(client_type) => { + write!(f, "{} client is not configured on the RouterClient", client_type) + } + Self::ModelDoesNotSupportOption { field, value } => { + write!(f, "Model does not support '{}' for field '{}'", value, field) + } + Self::UserRequestedZeroGenerations => { + write!(f, "Cannot request zero generations") + } + Self::ArtcraftOnlySupportsMediaTokens => { + write!(f, "ArtCraft only supports media tokens for image inputs; upload the image first to obtain a media token") + } + Self::FalOnlySupportsUrls => { + write!(f, "Fal only supports image URLs for image inputs, not media tokens") + } + Self::Seedance2ProOnlySupportsUrls => { + write!(f, "Seedance2Pro only supports URLs for media inputs; resolve media tokens to URLs before calling this provider") + } + Self::WebhookUrlRequired => { + write!(f, "This Fal endpoint only supports webhook dispatch; the caller built RouterFalClient in polling-only mode (no webhook URL)") + } + Self::MediaFileToUrlMapNotProvided => { + write!(f, "Media file to URL map was not provided") + } + Self::MediaFileTokenNotFoundInMap { token } => { + write!(f, "Media file token '{}' was not found in the provided URL map", token.as_str()) + } + Self::CharacterTokenToKinoviCharacterIdNotProvided => { + write!(f, "Character token to Kinovi character ID map was not provided") + } + Self::CharacterTokenNotFoundInMap { token } => { + write!(f, "Character token '{}' was not found in the provided character-token-to-id map", token.as_str()) + } + Self::LocalFileNotFound { path } => { + write!(f, "Local media file not found (or not a regular file): {}", path.display()) + } + Self::LocalFileRead { path, error } => { + write!(f, "Could not read local media file {}: {}", path.display(), error) + } + Self::ProviderCannotUseLocalMedia { client_type } => { + write!(f, "{} cannot take local files or raw bytes directly; convert the reference to a media token or URL first", client_type) + } + } + } +} diff --git a/crates/router/src/errors/download_error.rs b/crates/router/src/errors/download_error.rs new file mode 100644 index 00000000..302effc1 --- /dev/null +++ b/crates/router/src/errors/download_error.rs @@ -0,0 +1,40 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum DownloadError { + BadStatus { + url: String, + status_code: u16, + }, + + ReqwestDownload { + url: String, + error: reqwest::Error, + maybe_status: Option, + }, + + WreqDownload { + url: String, + error: wreq::Error, + maybe_status: Option, + }, +} + +impl Error for DownloadError {} + +impl Display for DownloadError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::BadStatus { url, status_code } => { + write!(f, "Download failed for {} with status {}", url, status_code) + } + Self::ReqwestDownload { url, error, maybe_status } => { + write!(f, "Reqwest download error for {}: {} (status: {:?})", url, error, maybe_status) + } + Self::WreqDownload { url, error, maybe_status } => { + write!(f, "Wreq download error for {}: {} (status: {:?})", url, error, maybe_status) + } + } + } +} diff --git a/crates/router/src/errors/mod.rs b/crates/router/src/errors/mod.rs new file mode 100644 index 00000000..29c2b051 --- /dev/null +++ b/crates/router/src/errors/mod.rs @@ -0,0 +1,4 @@ +pub mod artcraft_router_error; +pub mod client_error; +pub mod download_error; +pub mod provider_error; diff --git a/crates/router/src/errors/provider_error.rs b/crates/router/src/errors/provider_error.rs new file mode 100644 index 00000000..a53bc184 --- /dev/null +++ b/crates/router/src/errors/provider_error.rs @@ -0,0 +1,93 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; +use artcraft_client::error::storyteller_error::StorytellerError; +use fal_client::error::fal_error_plus::FalErrorPlus; +use gmicloud_client::error::gmicloud_error::GmiCloudError; +use grok_api_client::error::grok_error::GrokError; +use higgsfield_client::error::higgsfield_error::HiggsfieldError; +use midjourney_client::error::midjourney_error::MidjourneyError; +use seedance2pro_client::error::seedance2pro_error::Seedance2ProError; + +#[derive(Debug)] +pub enum ProviderError { + Storyteller(StorytellerError), + Fal(FalErrorPlus), + GmiCloud(GmiCloudError), + /// API-key (xAI) Grok client failed. + GrokApi(GrokError), + Midjourney(MidjourneyError), + /// First-party (cookie-session) Grok Imagine failed (websocket/POST). + Grok(String), + /// First-party (cookie-session) Higgsfield failed. Check + /// `needs_browser_reauth()` on the inner error to know whether the user has + /// to log in again. + Higgsfield(HiggsfieldError), + /// First-party Midjourney rejected the submit because the account has no + /// active paid subscription. First-class so callers can prompt to subscribe. + MidjourneySubscriptionRequired(String), + /// First-party Midjourney submit returned no job id for some other reason + /// (e.g. softban, filtered prompt). The string carries the raw detail. + MidjourneySubmitRejected(String), + Seedance2Pro(Seedance2ProError), +} + +impl Error for ProviderError {} + +impl Display for ProviderError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + Self::Storyteller(e) => write!(f, "Storyteller provider error: {}", e), + Self::Fal(e) => write!(f, "Fal provider error: {}", e), + Self::GmiCloud(e) => write!(f, "GmiCloud provider error: {}", e), + Self::GrokApi(e) => write!(f, "Grok API provider error: {}", e), + Self::Midjourney(e) => write!(f, "Midjourney provider error: {}", e), + Self::Grok(detail) => write!(f, "Grok provider error: {}", detail), + Self::Higgsfield(e) => write!(f, "Higgsfield provider error: {}", e), + Self::MidjourneySubscriptionRequired(detail) => write!(f, "Midjourney subscription required: {}", detail), + Self::MidjourneySubmitRejected(detail) => write!(f, "Midjourney submit rejected: {}", detail), + Self::Seedance2Pro(e) => write!(f, "Seedance2Pro provider error: {}", e), + } + } +} + +impl From for ProviderError { + fn from(error: StorytellerError) -> Self { + Self::Storyteller(error) + } +} + +impl From for ProviderError { + fn from(error: FalErrorPlus) -> Self { + Self::Fal(error) + } +} + +impl From for ProviderError { + fn from(error: GmiCloudError) -> Self { + Self::GmiCloud(error) + } +} + +impl From for ProviderError { + fn from(error: GrokError) -> Self { + Self::GrokApi(error) + } +} + +impl From for ProviderError { + fn from(error: HiggsfieldError) -> Self { + Self::Higgsfield(error) + } +} + +impl From for ProviderError { + fn from(error: MidjourneyError) -> Self { + Self::Midjourney(error) + } +} + +impl From for ProviderError { + fn from(error: Seedance2ProError) -> Self { + Self::Seedance2Pro(error) + } +} diff --git a/crates/router/src/generate/generate_audio/audio_generation_cost_estimate.rs b/crates/router/src/generate/generate_audio/audio_generation_cost_estimate.rs new file mode 100644 index 00000000..3838822a --- /dev/null +++ b/crates/router/src/generate/generate_audio/audio_generation_cost_estimate.rs @@ -0,0 +1,16 @@ +/// The result of estimating the cost of an audio generation plan. +#[derive(Clone, Debug)] +pub struct AudioGenerationCostEstimate { + pub cost_in_credits: Option, + pub cost_in_usd_cents: Option, + pub is_free: bool, + pub is_unlimited: bool, + pub is_rate_limited: bool, + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/router/src/generate/generate_audio/audio_generation_draft.rs b/crates/router/src/generate/generate_audio/audio_generation_draft.rs new file mode 100644 index 00000000..b7cb08f3 --- /dev/null +++ b/crates/router/src/generate/generate_audio/audio_generation_draft.rs @@ -0,0 +1,56 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::audio_generation_draft_context::AudioGenerationDraftContext; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::providers::kinovi::suno_remix::cost::KinoviSunoRemixCostState; +use crate::generate::generate_audio::providers::kinovi::suno_remix::draft::KinoviSunoRemixDraftState; +use crate::generate::generate_audio::providers::kinovi::suno_sample::cost::KinoviSunoSampleCostState; +use crate::generate::generate_audio::providers::kinovi::suno_sample::draft::KinoviSunoSampleDraftState; + +/** + * Wrapper for all audio generation draft requests. + * + * Only the Kinovi remix/sample models need a draft phase: they take a user + * audio reference that must be downloaded from our CDN and re-uploaded to the + * Kinovi CDN before the request can be sent. All other audio providers return + * a `Request` directly from `build2()`. + */ +#[derive(Clone, Debug)] +pub enum AudioGenerationDraftRequest { + KinoviSunoRemix(KinoviSunoRemixDraftState), + KinoviSunoSample(KinoviSunoSampleDraftState), +} + +impl AudioGenerationDraftRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::KinoviSunoRemix(_) => RouterProvider::Seedance2Pro, + Self::KinoviSunoSample(_) => RouterProvider::Seedance2Pro, + } + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match self { + AudioGenerationDraftRequest::KinoviSunoRemix(draft) => Ok(KinoviSunoRemixCostState::from_draft(draft).estimate_cost()), + AudioGenerationDraftRequest::KinoviSunoSample(draft) => Ok(KinoviSunoSampleCostState::from_draft(draft).estimate_cost()), + } + } + + /// Finalize the draft request before generation + /// This may involve uploading media to the provider. + pub async fn finalize(self, draft_context: AudioGenerationDraftContext<'_>) -> Result { + match self { + AudioGenerationDraftRequest::KinoviSunoRemix(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(AudioGenerationRequest::KinoviSunoRemix(result)) + }, + AudioGenerationDraftRequest::KinoviSunoSample(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(AudioGenerationRequest::KinoviSunoSample(result)) + }, + } + } +} diff --git a/crates/router/src/generate/generate_audio/audio_generation_draft_context.rs b/crates/router/src/generate/generate_audio/audio_generation_draft_context.rs new file mode 100644 index 00000000..8ef914c8 --- /dev/null +++ b/crates/router/src/generate/generate_audio/audio_generation_draft_context.rs @@ -0,0 +1,36 @@ +use std::collections::HashMap; +use std::fmt::Debug; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::client::router_client::RouterClient; +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +#[derive(Clone, Default)] +pub struct AudioGenerationDraftContext<'a> { + /// Optional: the router client, needed for providers that require authentication. + pub client: Option<&'a RouterClient>, + + /// Optional context: a map of Media File Tokens to their ArtCraft URLs + /// Only needed if we have to fetch these assets and upload them to another provider. + pub media_file_to_artcraft_url_map: Option<&'a HashMap>, +} + +impl <'a> AudioGenerationDraftContext<'a> { + pub fn get_seedance2pro_client_ref(&self) -> Result<&RouterSeedance2ProClient, ArtcraftRouterError> { + let client = self.client.ok_or(ArtcraftRouterError::Client(ClientError::RouterClientNotProvided))?; + client.get_seedance2pro_client_ref() + .map_err(|err| ArtcraftRouterError::Client(err)) + } +} + +impl Debug for AudioGenerationDraftContext<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("AudioGenerationDraftContext") + .field("client", &self.client.is_some()) + .field("media_file_to_artcraft_url_map", &self.media_file_to_artcraft_url_map) + .finish() + } +} diff --git a/crates/router/src/generate/generate_audio/audio_generation_draft_or_request.rs b/crates/router/src/generate/generate_audio/audio_generation_draft_or_request.rs new file mode 100644 index 00000000..d204723f --- /dev/null +++ b/crates/router/src/generate/generate_audio/audio_generation_draft_or_request.rs @@ -0,0 +1,28 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::audio_generation_draft::AudioGenerationDraftRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; + +#[derive(Debug, Clone)] +pub enum AudioGenerationDraftOrRequest { + Draft(AudioGenerationDraftRequest), + Request(AudioGenerationRequest), +} + +impl AudioGenerationDraftOrRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::Draft(draft) => draft.get_provider(), + Self::Request(request) => request.get_provider(), + } + } + + pub fn estimate_cost(&self) -> Result { + match self { + AudioGenerationDraftOrRequest::Draft(draft) => draft.estimate_cost(), + AudioGenerationDraftOrRequest::Request(request) => request.estimate_cost(), + } + } +} diff --git a/crates/router/src/generate/generate_audio/audio_generation_request.rs b/crates/router/src/generate/generate_audio/audio_generation_request.rs new file mode 100644 index 00000000..abe85afa --- /dev/null +++ b/crates/router/src/generate/generate_audio/audio_generation_request.rs @@ -0,0 +1,120 @@ +use crate::api::router_provider::RouterProvider; +use crate::client::router_client::RouterClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; +use crate::generate::generate_audio::providers::artcraft::seed_audio_1p0::cost::ArtcraftSeedAudio1p0CostState; +use crate::generate::generate_audio::providers::artcraft::seed_audio_1p0::request::ArtcraftSeedAudio1p0RequestState; +use crate::generate::generate_audio::providers::artcraft::suno_music::cost::ArtcraftSunoMusicCostState; +use crate::generate::generate_audio::providers::artcraft::suno_music::request::ArtcraftSunoMusicRequestState; +use crate::generate::generate_audio::providers::artcraft::suno_remix::cost::ArtcraftSunoRemixCostState; +use crate::generate::generate_audio::providers::artcraft::suno_remix::request::ArtcraftSunoRemixRequestState; +use crate::generate::generate_audio::providers::artcraft::suno_sample::cost::ArtcraftSunoSampleCostState; +use crate::generate::generate_audio::providers::artcraft::suno_sample::request::ArtcraftSunoSampleRequestState; +use crate::generate::generate_audio::providers::artcraft::suno_sounds::cost::ArtcraftSunoSoundsCostState; +use crate::generate::generate_audio::providers::artcraft::suno_sounds::request::ArtcraftSunoSoundsRequestState; +use crate::generate::generate_audio::providers::fal::seed_audio_1p0::cost::FalSeedAudio1p0CostState; +use crate::generate::generate_audio::providers::fal::seed_audio_1p0::request::FalSeedAudio1p0RequestState; +use crate::generate::generate_audio::providers::kinovi::suno_music::cost::KinoviSunoMusicCostState; +use crate::generate::generate_audio::providers::kinovi::suno_music::request::KinoviSunoMusicRequestState; +use crate::generate::generate_audio::providers::kinovi::suno_remix::cost::KinoviSunoRemixCostState; +use crate::generate::generate_audio::providers::kinovi::suno_remix::request::KinoviSunoRemixRequestState; +use crate::generate::generate_audio::providers::kinovi::suno_sample::cost::KinoviSunoSampleCostState; +use crate::generate::generate_audio::providers::kinovi::suno_sample::request::KinoviSunoSampleRequestState; +use crate::generate::generate_audio::providers::kinovi::suno_sounds::cost::KinoviSunoSoundsCostState; +use crate::generate::generate_audio::providers::kinovi::suno_sounds::request::KinoviSunoSoundsRequestState; + +#[derive(Clone, Debug)] +pub enum AudioGenerationRequest { + ArtcraftSunoMusic(ArtcraftSunoMusicRequestState), + ArtcraftSunoRemix(ArtcraftSunoRemixRequestState), + ArtcraftSunoSounds(ArtcraftSunoSoundsRequestState), + ArtcraftSunoSample(ArtcraftSunoSampleRequestState), + ArtcraftSeedAudio1p0(ArtcraftSeedAudio1p0RequestState), + FalSeedAudio1p0(FalSeedAudio1p0RequestState), + KinoviSunoMusic(KinoviSunoMusicRequestState), + KinoviSunoRemix(KinoviSunoRemixRequestState), + KinoviSunoSounds(KinoviSunoSoundsRequestState), + KinoviSunoSample(KinoviSunoSampleRequestState), +} + +impl AudioGenerationRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::ArtcraftSunoMusic(_) => RouterProvider::Artcraft, + Self::ArtcraftSunoRemix(_) => RouterProvider::Artcraft, + Self::ArtcraftSunoSounds(_) => RouterProvider::Artcraft, + Self::ArtcraftSunoSample(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedAudio1p0(_) => RouterProvider::Artcraft, + Self::FalSeedAudio1p0(_) => RouterProvider::Fal, + Self::KinoviSunoMusic(_) => RouterProvider::Seedance2Pro, + Self::KinoviSunoRemix(_) => RouterProvider::Seedance2Pro, + Self::KinoviSunoSounds(_) => RouterProvider::Seedance2Pro, + Self::KinoviSunoSample(_) => RouterProvider::Seedance2Pro, + } + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match self { + AudioGenerationRequest::ArtcraftSunoMusic(request) => Ok(ArtcraftSunoMusicCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::ArtcraftSunoRemix(request) => Ok(ArtcraftSunoRemixCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::ArtcraftSunoSounds(request) => Ok(ArtcraftSunoSoundsCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::ArtcraftSunoSample(request) => Ok(ArtcraftSunoSampleCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::ArtcraftSeedAudio1p0(request) => Ok(ArtcraftSeedAudio1p0CostState::from_request(request).estimate_cost()), + AudioGenerationRequest::FalSeedAudio1p0(request) => Ok(FalSeedAudio1p0CostState::from_request(request).estimate_cost()), + AudioGenerationRequest::KinoviSunoMusic(request) => Ok(KinoviSunoMusicCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::KinoviSunoRemix(request) => Ok(KinoviSunoRemixCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::KinoviSunoSounds(request) => Ok(KinoviSunoSoundsCostState::from_request(request).estimate_cost()), + AudioGenerationRequest::KinoviSunoSample(request) => Ok(KinoviSunoSampleCostState::from_request(request).estimate_cost()), + } + } + + /// Send the audio generation request + /// If successful, returns the job IDs. + pub async fn send_request(&self, client: &RouterClient) -> Result { + match self { + AudioGenerationRequest::ArtcraftSunoMusic(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::ArtcraftSunoRemix(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::ArtcraftSunoSounds(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::ArtcraftSunoSample(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::ArtcraftSeedAudio1p0(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::FalSeedAudio1p0(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::KinoviSunoMusic(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::KinoviSunoRemix(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::KinoviSunoSounds(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + AudioGenerationRequest::KinoviSunoSample(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + } + } +} diff --git a/crates/router/src/generate/generate_audio/generate_audio_request_builder.rs b/crates/router/src/generate/generate_audio/generate_audio_request_builder.rs new file mode 100644 index 00000000..9146470d --- /dev/null +++ b/crates/router/src/generate/generate_audio/generate_audio_request_builder.rs @@ -0,0 +1,302 @@ +use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_audio_model::RouterAudioModel; +use crate::api::router_provider::RouterProvider; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::providers::artcraft::seed_audio_1p0::build::build_artcraft_seed_audio_1p0; +use crate::generate::generate_audio::providers::artcraft::suno_music::build::build_artcraft_suno_music; +use crate::generate::generate_audio::providers::artcraft::suno_remix::build::build_artcraft_suno_remix; +use crate::generate::generate_audio::providers::artcraft::suno_sample::build::build_artcraft_suno_sample; +use crate::generate::generate_audio::providers::artcraft::suno_sounds::build::build_artcraft_suno_sounds; +use crate::generate::generate_audio::providers::fal::seed_audio_1p0::build::build_fal_seed_audio_1p0; +use crate::generate::generate_audio::providers::kinovi::suno_music::build::build_kinovi_suno_music; +use crate::generate::generate_audio::providers::kinovi::suno_remix::build::build_kinovi_suno_remix; +use crate::generate::generate_audio::providers::kinovi::suno_sample::build::build_kinovi_suno_sample; +use crate::generate::generate_audio::providers::kinovi::suno_sounds::build::build_kinovi_suno_sounds; + +/// RouterProvider-agnostic audio generation request. Distilled by `build2()` +/// into an `AudioGenerationDraftOrRequest` for the selected (provider, model) +/// pair. +#[derive(Clone, Debug)] +pub struct GenerateAudioRequestBuilder { + /// Which model to use. + pub model: RouterAudioModel, + + /// Which provider to use. + pub provider: RouterProvider, + + /// The prompt for the audio generation. + pub prompt: Option, + + /// Style/genre direction (Suno's "tags"), e.g. "EDM style meets dance". + pub style_prompt: Option, + + /// Reference audio (optional). + /// The remix/sample source, or Seed Audio @Audio references (up to 3). + pub audio_references: Option, + + /// Reference images (optional). + /// Seed Audio supports a single reference image; it cannot be combined + /// with audio references. + pub image_references: Option, + + /// Whether to keep the original lyrics (Suno Remix). + pub keep_lyrics: Option, + + /// Whether to generate instrumental-only audio (Suno Music / Sample). + pub is_instrumental: Option, + + /// Whether the sound should loop vs a single hit (Suno Sounds). + pub is_loopable: Option, + + /// Beats per minute (Suno Sounds). + pub bpm: Option, + + /// The musical key to use (Suno Sounds). + pub musical_key: Option, + + /// Output sample rate in Hz (Seed Audio). + pub sample_rate_hz: Option, + + /// Playback speed multiplier (Seed Audio: 0.5–2.0). + pub speed: Option, + + /// Volume multiplier (Seed Audio: 0.5–2.0). + pub volume: Option, + + /// Pitch shift in semitones (Seed Audio: -12..=12). + pub pitch: Option, + + /// If the request is a mismatch with the (model/provider), how to mitigate it. + pub request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy, + + /// Some providers support idempotency. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, +} + +impl Default for GenerateAudioRequestBuilder { + fn default() -> Self { + Self { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Artcraft, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + prompt: None, + style_prompt: None, + audio_references: None, + image_references: None, + keep_lyrics: None, + is_instrumental: None, + is_loopable: None, + bpm: None, + musical_key: None, + sample_rate_hz: None, + speed: None, + volume: None, + pitch: None, + idempotency_token: None, + } + } +} + +impl GenerateAudioRequestBuilder { + + pub fn build2(self) -> Result { + match (self.provider, self.model) { + // Artcraft + (RouterProvider::Artcraft, RouterAudioModel::SunoMusic) => build_artcraft_suno_music(self), + (RouterProvider::Artcraft, RouterAudioModel::SunoRemix) => build_artcraft_suno_remix(self), + (RouterProvider::Artcraft, RouterAudioModel::SunoSounds) => build_artcraft_suno_sounds(self), + (RouterProvider::Artcraft, RouterAudioModel::SunoSample) => build_artcraft_suno_sample(self), + (RouterProvider::Artcraft, RouterAudioModel::SeedAudio1p0) => build_artcraft_seed_audio_1p0(self), + // Fal + (RouterProvider::Fal, RouterAudioModel::SeedAudio1p0) => build_fal_seed_audio_1p0(self), + // Kinovi + (RouterProvider::Seedance2Pro, RouterAudioModel::SunoMusic) => build_kinovi_suno_music(self), + (RouterProvider::Seedance2Pro, RouterAudioModel::SunoRemix) => build_kinovi_suno_remix(self), + (RouterProvider::Seedance2Pro, RouterAudioModel::SunoSounds) => build_kinovi_suno_sounds(self), + (RouterProvider::Seedance2Pro, RouterAudioModel::SunoSample) => build_kinovi_suno_sample(self), + _ => self.unsupported_provider_and_model(), + } + } + + pub fn get_or_generate_idempotency_token(&self) -> String { + self.idempotency_token.clone() + .unwrap_or_else(|| uuid::Uuid::new_v4().to_string()) + } + + fn unsupported_provider_and_model(&self) -> Result { + Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + format!("Audio generation for model `{:?}` is not supported for provider {:?}", self.model, self.provider) + )) + } +} + +#[cfg(test)] +mod tests { + use crate::generate::generate_audio::audio_generation_draft::AudioGenerationDraftRequest; + use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; + + use super::*; + + mod dispatch_tests { + use super::*; + + #[test] + fn artcraft_suno_music_dispatches() { + let result = builder(RouterProvider::Artcraft, RouterAudioModel::SunoMusic).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoMusic(_)) + )); + } + + #[test] + fn artcraft_suno_remix_dispatches() { + let result = builder_with_audio_token_ref(RouterProvider::Artcraft, RouterAudioModel::SunoRemix).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoRemix(_)) + )); + } + + #[test] + fn artcraft_suno_sounds_dispatches() { + let result = builder(RouterProvider::Artcraft, RouterAudioModel::SunoSounds).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoSounds(_)) + )); + } + + #[test] + fn artcraft_suno_sample_dispatches() { + let result = builder_with_audio_token_ref(RouterProvider::Artcraft, RouterAudioModel::SunoSample).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoSample(_)) + )); + } + + #[test] + fn artcraft_seed_audio_1p0_dispatches() { + let result = builder(RouterProvider::Artcraft, RouterAudioModel::SeedAudio1p0).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSeedAudio1p0(_)) + )); + } + + #[test] + fn fal_seed_audio_1p0_dispatches() { + let result = builder(RouterProvider::Fal, RouterAudioModel::SeedAudio1p0).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::FalSeedAudio1p0(_)) + )); + } + + #[test] + fn kinovi_suno_music_dispatches_to_request() { + let result = builder(RouterProvider::Seedance2Pro, RouterAudioModel::SunoMusic).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::KinoviSunoMusic(_)) + )); + } + + #[test] + fn kinovi_suno_sounds_dispatches_to_request() { + let result = builder(RouterProvider::Seedance2Pro, RouterAudioModel::SunoSounds).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::KinoviSunoSounds(_)) + )); + } + + #[test] + fn kinovi_suno_remix_dispatches_to_draft() { + let result = builder_with_audio_ref(RouterProvider::Seedance2Pro, RouterAudioModel::SunoRemix).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Draft(AudioGenerationDraftRequest::KinoviSunoRemix(_)) + )); + } + + #[test] + fn kinovi_suno_sample_dispatches_to_draft() { + let result = builder_with_audio_ref(RouterProvider::Seedance2Pro, RouterAudioModel::SunoSample).build2().expect("build"); + assert!(matches!( + result, + AudioGenerationDraftOrRequest::Draft(AudioGenerationDraftRequest::KinoviSunoSample(_)) + )); + } + } + + mod unsupported_combo_tests { + use super::*; + + #[test] + fn kinovi_seed_audio_1p0_is_unsupported() { + let result = builder(RouterProvider::Seedance2Pro, RouterAudioModel::SeedAudio1p0).build2(); + assert!(matches!(result, Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi(_)))); + } + + #[test] + fn fal_suno_models_are_unsupported() { + for model in [ + RouterAudioModel::SunoMusic, + RouterAudioModel::SunoRemix, + RouterAudioModel::SunoSounds, + RouterAudioModel::SunoSample, + ] { + let result = builder(RouterProvider::Fal, model).build2(); + assert!( + matches!(result, Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi(_))), + "expected unsupported error for Fal + {model:?}", + ); + } + } + + #[test] + fn gmicloud_and_grok_are_unsupported() { + for provider in [RouterProvider::GmiCloud, RouterProvider::GrokApi] { + let result = builder(provider, RouterAudioModel::SunoMusic).build2(); + assert!( + matches!(result, Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi(_))), + "expected unsupported error for {provider:?}", + ); + } + } + } + + // ── Helpers ── + + fn builder(provider: RouterProvider, model: RouterAudioModel) -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + provider, + model, + prompt: Some("a song about corgis".to_string()), + ..Default::default() + } + } + + fn builder_with_audio_ref(provider: RouterProvider, model: RouterAudioModel) -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.mp3".to_string()])), + ..builder(provider, model) + } + } + + fn builder_with_audio_token_ref(provider: RouterProvider, model: RouterAudioModel) -> GenerateAudioRequestBuilder { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::MediaFileTokens(vec![MediaFileToken::new("mf_test123".to_string())])), + ..builder(provider, model) + } + } +} diff --git a/crates/router/src/generate/generate_audio/generate_audio_response.rs b/crates/router/src/generate/generate_audio/generate_audio_response.rs new file mode 100644 index 00000000..2ff2f11e --- /dev/null +++ b/crates/router/src/generate/generate_audio/generate_audio_response.rs @@ -0,0 +1,65 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use artcraft_client::tokens::generic_inference_jobs::InferenceJobToken; + +#[derive(Clone, Debug)] +pub struct ArtcraftAudioResponsePayload { + pub inference_job_token: InferenceJobToken, + pub all_inference_job_tokens: Vec, +} + +#[derive(Clone, Debug)] +pub struct Seedance2proAudioResponsePayload { + pub order_id: String, + pub task_id: String, +} + +#[derive(Clone, Debug)] +pub struct FalAudioResponsePayload { + pub request_id: Option, + pub gateway_request_id: Option, + + /// Queue-mode status URL (fal's queue/polling flow). `None` for webhook + /// dispatch — the webhook callback drives status updates instead. + pub maybe_status_url: Option, + + /// Queue-mode response URL (fal's queue/polling flow). `None` for webhook + /// dispatch. + pub maybe_response_url: Option, + + /// The outbound request that was sent to Fal. + /// Stored as a trait object so any Request type can be captured. + /// Use `format!("{:?}", ...)` or `format!("{:#?}", ...)` to print. + pub maybe_outbound_request: Option>, +} + +#[derive(Clone, Debug)] +pub enum GenerateAudioResponse { + Artcraft(ArtcraftAudioResponsePayload), + Seedance2Pro(Seedance2proAudioResponsePayload), + Fal(FalAudioResponsePayload), +} + +impl GenerateAudioResponse { + pub fn get_artcraft_payload(&self) -> Option { + match self { + Self::Artcraft(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_seedance2pro_payload(&self) -> Option { + match self { + Self::Seedance2Pro(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_fal_payload(&self) -> Option { + match self { + Self::Fal(p) => Some(p.clone()), + _ => None, + } + } +} diff --git a/crates/router/src/generate/generate_audio/mod.rs b/crates/router/src/generate/generate_audio/mod.rs new file mode 100644 index 00000000..2110437f --- /dev/null +++ b/crates/router/src/generate/generate_audio/mod.rs @@ -0,0 +1,8 @@ +pub mod audio_generation_cost_estimate; +pub mod audio_generation_draft; +pub mod audio_generation_draft_context; +pub mod audio_generation_draft_or_request; +pub mod audio_generation_request; +pub mod generate_audio_request_builder; +pub mod generate_audio_response; +pub mod providers; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/build_common.rs b/crates/router/src/generate/generate_audio/providers/artcraft/build_common.rs new file mode 100644 index 00000000..486210f5 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/build_common.rs @@ -0,0 +1,143 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; +use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel as CommonAudioModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::artcraft::resolve::{ + resolve_audio_list_ref, resolve_image_list_ref, +}; + +/// Build an `OmniGenAudioCostAndGenerateRequest` from the builder. The +/// Artcraft provider is a thin forwarding shim: the storyteller-web omni +/// audio endpoint owns per-model validation and option mapping, so the +/// builder's options are passed through as-is. +pub fn build_artcraft_omni_audio_request( + mut builder: GenerateAudioRequestBuilder, + model: CommonAudioModelEnum, +) -> Result { + let audio_media_tokens = resolve_audio_list_ref(builder.audio_references.take())?; + let image_media_tokens = resolve_image_list_ref(builder.image_references.take())?; + let idempotency_token = builder.get_or_generate_idempotency_token(); + + Ok(OmniGenAudioCostAndGenerateRequest { + idempotency_token: Some(idempotency_token), + model: Some(model), + prompt: builder.prompt.take(), + style_prompt: builder.style_prompt.take(), + audio_media_tokens, + image_media_tokens, + keep_lyrics: builder.keep_lyrics, + is_instrumental: builder.is_instrumental, + is_loopable: builder.is_loopable, + bpm: builder.bpm, + musical_key: builder.musical_key, + sample_rate_hz: builder.sample_rate_hz, + speed: builder.speed, + volume: builder.volume, + pitch: builder.pitch, + }) +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::errors::client_error::ClientError; + + use super::*; + + #[test] + fn all_fields_are_forwarded() { + use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; + + let builder = GenerateAudioRequestBuilder { + prompt: Some("a song".to_string()), + style_prompt: Some("EDM".to_string()), + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_audio".to_string()), + ])), + image_references: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image".to_string()), + ])), + keep_lyrics: Some(true), + is_instrumental: Some(false), + is_loopable: Some(true), + bpm: Some(120), + musical_key: Some(CommonMusicalKey::AMinor), + sample_rate_hz: Some(48_000), + speed: Some(1.5), + volume: Some(0.8), + pitch: Some(-2.0), + idempotency_token: Some("test-token".to_string()), + ..base_builder() + }; + + let request = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SunoMusic) + .expect("build"); + + assert_eq!(request.idempotency_token.as_deref(), Some("test-token")); + assert_eq!(request.model, Some(CommonAudioModelEnum::SunoMusic)); + assert_eq!(request.prompt.as_deref(), Some("a song")); + assert_eq!(request.style_prompt.as_deref(), Some("EDM")); + assert_eq!(request.audio_media_tokens.as_ref().map(|t| t.len()), Some(1)); + assert_eq!(request.image_media_tokens.as_ref().map(|t| t.len()), Some(1)); + assert_eq!(request.keep_lyrics, Some(true)); + assert_eq!(request.is_instrumental, Some(false)); + assert_eq!(request.is_loopable, Some(true)); + assert_eq!(request.bpm, Some(120)); + assert_eq!(request.musical_key, Some(CommonMusicalKey::AMinor)); + assert_eq!(request.sample_rate_hz, Some(48_000)); + assert_eq!(request.speed, Some(1.5)); + assert_eq!(request.volume, Some(0.8)); + assert_eq!(request.pitch, Some(-2.0)); + } + + #[test] + fn idempotency_token_is_generated_when_missing() { + let request = build_artcraft_omni_audio_request(base_builder(), CommonAudioModelEnum::SunoMusic) + .expect("build"); + assert!(request.idempotency_token.is_some()); + assert!(!request.idempotency_token.unwrap().is_empty()); + } + + #[test] + fn audio_url_references_are_rejected() { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.mp3".to_string()])), + ..base_builder() + }; + let result = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SunoRemix); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + )); + } + + #[test] + fn image_url_references_are_rejected() { + let builder = GenerateAudioRequestBuilder { + image_references: Some(ImageListRef::Urls(vec!["https://example.com/a.png".to_string()])), + ..base_builder() + }; + let result = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SeedAudio1p0); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + )); + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Artcraft, + prompt: Some("a song".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/mod.rs b/crates/router/src/generate/generate_audio/providers/artcraft/mod.rs new file mode 100644 index 00000000..6aa841b1 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/mod.rs @@ -0,0 +1,8 @@ +pub(crate) mod build_common; +pub(crate) mod request_common; +pub(crate) mod resolve; +pub mod seed_audio_1p0; +pub mod suno_music; +pub mod suno_remix; +pub mod suno_sample; +pub mod suno_sounds; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/request_common.rs b/crates/router/src/generate/generate_audio/providers/artcraft/request_common.rs new file mode 100644 index 00000000..150feaa3 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/request_common.rs @@ -0,0 +1,32 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; +use artcraft_client::credentials::api_or_web_creds::ApiOrWebCreds; +use artcraft_client::endpoints::omni_gen::generate::audio::omni_gen_audio::{omni_gen_audio_generate, OmniGenAudioGenerateArgs}; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_audio::generate_audio_response::{ + ArtcraftAudioResponsePayload, GenerateAudioResponse, +}; + +/// Send an audio generation request to the Artcraft omni-gen endpoint. +/// All Artcraft model request states delegate to this function. +pub async fn send_artcraft_omni_audio_request( + request: &OmniGenAudioCostAndGenerateRequest, + client: &RouterArtcraftClient, +) -> Result { + let api_or_web_creds = ApiOrWebCreds::from(&client.credentials); + + let response = omni_gen_audio_generate(OmniGenAudioGenerateArgs { + api_host: &client.api_host, + api_or_web_creds: Some(&api_or_web_creds), + request, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateAudioResponse::Artcraft(ArtcraftAudioResponsePayload { + inference_job_token: response.inference_job_token.clone(), + all_inference_job_tokens: vec![response.inference_job_token], + })) +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/resolve.rs b/crates/router/src/generate/generate_audio/providers/artcraft/resolve.rs new file mode 100644 index 00000000..e4603d2c --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/resolve.rs @@ -0,0 +1,56 @@ +//! Shared resolve helpers for the Artcraft audio provider. +//! +//! Artcraft only accepts media file tokens — raw URLs are rejected. + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::audio_ref::AudioRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +pub(super) fn resolve_audio_list_ref( + audio_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match audio_list_ref { + None => Ok(None), + Some(AudioListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(AudioListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(AudioListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for audio_ref in refs { + match audio_ref { + AudioRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +pub(super) fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/build.rs b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/build.rs new file mode 100644 index 00000000..cc734b20 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel as CommonAudioModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::artcraft::build_common::build_artcraft_omni_audio_request; +use crate::generate::generate_audio::providers::artcraft::seed_audio_1p0::request::ArtcraftSeedAudio1p0RequestState; + +pub fn build_artcraft_seed_audio_1p0(builder: GenerateAudioRequestBuilder) -> Result { + let request = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SeedAudio1p0)?; + let state = ArtcraftSeedAudio1p0RequestState { request }; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSeedAudio1p0(state))) +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/cost.rs b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/cost.rs new file mode 100644 index 00000000..bb9f3aa7 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/cost.rs @@ -0,0 +1,51 @@ +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::artcraft::seed_audio_1p0::request::ArtcraftSeedAudio1p0RequestState; + +const COST_IN_USD_CENTS: u64 = 21; + +/// Seed Audio 1.0 via Artcraft is flat priced, so the cost state carries no +/// request fields. +#[derive(Clone, Debug)] +pub struct ArtcraftSeedAudio1p0CostState; + +impl ArtcraftSeedAudio1p0CostState { + pub fn from_request(_request: &ArtcraftSeedAudio1p0RequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + AudioGenerationCostEstimate { + cost_in_credits: Some(COST_IN_USD_CENTS), + cost_in_usd_cents: Some(COST_IN_USD_CENTS), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + + use super::*; + + #[test] + fn flat_cost_is_twenty_one_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SeedAudio1p0, + provider: RouterProvider::Artcraft, + prompt: Some("a suspense radio drama".to_string()), + ..Default::default() + }; + let estimate = builder.build2().unwrap().estimate_cost().unwrap(); + assert_eq!(estimate.cost_in_usd_cents, Some(21)); + assert_eq!(estimate.cost_in_credits, Some(21)); + // Direct cost-state path matches the builder path. + assert_eq!(ArtcraftSeedAudio1p0CostState.estimate_cost().cost_in_usd_cents, Some(21)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/mod.rs b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/request.rs b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/request.rs new file mode 100644 index 00000000..82490276 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/seed_audio_1p0/request.rs @@ -0,0 +1,78 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; +use crate::generate::generate_audio::providers::artcraft::request_common::send_artcraft_omni_audio_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedAudio1p0RequestState { + pub request: OmniGenAudioCostAndGenerateRequest, +} + +impl ArtcraftSeedAudio1p0RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_audio_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_speech_drama() { + let response = run_pipeline(GenerateAudioRequestBuilder { + model: RouterAudioModel::SeedAudio1p0, + provider: RouterProvider::Artcraft, + prompt: Some("A calm narrator describes ocean waves rolling onto a moonlit beach.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateAudioResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/build.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/build.rs new file mode 100644 index 00000000..4fe30fc7 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel as CommonAudioModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::artcraft::build_common::build_artcraft_omni_audio_request; +use crate::generate::generate_audio::providers::artcraft::suno_music::request::ArtcraftSunoMusicRequestState; + +pub fn build_artcraft_suno_music(builder: GenerateAudioRequestBuilder) -> Result { + let request = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SunoMusic)?; + let state = ArtcraftSunoMusicRequestState { request }; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoMusic(state))) +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/cost.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/cost.rs new file mode 100644 index 00000000..780caf9e --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/cost.rs @@ -0,0 +1,51 @@ +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::artcraft::suno_music::request::ArtcraftSunoMusicRequestState; + +const COST_IN_USD_CENTS: u64 = 8; + +/// Suno Music via Artcraft is flat priced, so the cost state carries no +/// request fields. +#[derive(Clone, Debug)] +pub struct ArtcraftSunoMusicCostState; + +impl ArtcraftSunoMusicCostState { + pub fn from_request(_request: &ArtcraftSunoMusicRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + AudioGenerationCostEstimate { + cost_in_credits: Some(COST_IN_USD_CENTS), + cost_in_usd_cents: Some(COST_IN_USD_CENTS), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + + use super::*; + + #[test] + fn flat_cost_is_eight_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Artcraft, + prompt: Some("a song".to_string()), + ..Default::default() + }; + let estimate = builder.build2().unwrap().estimate_cost().unwrap(); + assert_eq!(estimate.cost_in_usd_cents, Some(8)); + assert_eq!(estimate.cost_in_credits, Some(8)); + // Direct cost-state path matches the builder path. + assert_eq!(ArtcraftSunoMusicCostState.estimate_cost().cost_in_usd_cents, Some(8)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/mod.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/request.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/request.rs new file mode 100644 index 00000000..1603b900 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_music/request.rs @@ -0,0 +1,79 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; +use crate::generate::generate_audio::providers::artcraft::request_common::send_artcraft_omni_audio_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSunoMusicRequestState { + pub request: OmniGenAudioCostAndGenerateRequest, +} + +impl ArtcraftSunoMusicRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_audio_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_music() { + let response = run_pipeline(GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Artcraft, + prompt: Some("A song about a corgi who learns to sail the open sea".to_string()), + style_prompt: Some("Sea shanty, folk".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateAudioResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/build.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/build.rs new file mode 100644 index 00000000..85421faa --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel as CommonAudioModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::artcraft::build_common::build_artcraft_omni_audio_request; +use crate::generate::generate_audio::providers::artcraft::suno_remix::request::ArtcraftSunoRemixRequestState; + +pub fn build_artcraft_suno_remix(builder: GenerateAudioRequestBuilder) -> Result { + let request = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SunoRemix)?; + let state = ArtcraftSunoRemixRequestState { request }; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoRemix(state))) +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/cost.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/cost.rs new file mode 100644 index 00000000..ba08851b --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/cost.rs @@ -0,0 +1,57 @@ +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::artcraft::suno_remix::request::ArtcraftSunoRemixRequestState; + +const COST_IN_USD_CENTS: u64 = 8; + +/// Suno Remix via Artcraft is flat priced, so the cost state carries no +/// request fields. +#[derive(Clone, Debug)] +pub struct ArtcraftSunoRemixCostState; + +impl ArtcraftSunoRemixCostState { + pub fn from_request(_request: &ArtcraftSunoRemixRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + AudioGenerationCostEstimate { + cost_in_credits: Some(COST_IN_USD_CENTS), + cost_in_usd_cents: Some(COST_IN_USD_CENTS), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + + use super::*; + + #[test] + fn flat_cost_is_eight_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoRemix, + provider: RouterProvider::Artcraft, + prompt: Some("make this electronic".to_string()), + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..Default::default() + }; + let estimate = builder.build2().unwrap().estimate_cost().unwrap(); + assert_eq!(estimate.cost_in_usd_cents, Some(8)); + assert_eq!(estimate.cost_in_credits, Some(8)); + // Direct cost-state path matches the builder path. + assert_eq!(ArtcraftSunoRemixCostState.estimate_cost().cost_in_usd_cents, Some(8)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/mod.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/request.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/request.rs new file mode 100644 index 00000000..27930d77 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_remix/request.rs @@ -0,0 +1,88 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; +use crate::generate::generate_audio::providers::artcraft::request_common::send_artcraft_omni_audio_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSunoRemixRequestState { + pub request: OmniGenAudioCostAndGenerateRequest, +} + +impl ArtcraftSunoRemixRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_audio_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + /// Replace with a real uploaded audio media token before running. + /// (test_data doesn't have a production audio media token yet.) + const AUDIO_MEDIA_TOKEN: &str = "m_replace_with_uploaded_audio_token"; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn remix_uploaded_audio() { + let response = run_pipeline(GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoRemix, + provider: RouterProvider::Artcraft, + prompt: Some("Make this electronic".to_string()), + style_prompt: Some("EDM style".to_string()), + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new(AUDIO_MEDIA_TOKEN.to_string()), + ])), + ..Default::default() + }).await; + assert!(matches!(response, GenerateAudioResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/build.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/build.rs new file mode 100644 index 00000000..59781d06 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel as CommonAudioModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::artcraft::build_common::build_artcraft_omni_audio_request; +use crate::generate::generate_audio::providers::artcraft::suno_sample::request::ArtcraftSunoSampleRequestState; + +pub fn build_artcraft_suno_sample(builder: GenerateAudioRequestBuilder) -> Result { + let request = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SunoSample)?; + let state = ArtcraftSunoSampleRequestState { request }; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoSample(state))) +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/cost.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/cost.rs new file mode 100644 index 00000000..c3e82eec --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/cost.rs @@ -0,0 +1,57 @@ +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::artcraft::suno_sample::request::ArtcraftSunoSampleRequestState; + +const COST_IN_USD_CENTS: u64 = 8; + +/// Suno Sample via Artcraft is flat priced, so the cost state carries no +/// request fields. +#[derive(Clone, Debug)] +pub struct ArtcraftSunoSampleCostState; + +impl ArtcraftSunoSampleCostState { + pub fn from_request(_request: &ArtcraftSunoSampleRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + AudioGenerationCostEstimate { + cost_in_credits: Some(COST_IN_USD_CENTS), + cost_in_usd_cents: Some(COST_IN_USD_CENTS), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + + use super::*; + + #[test] + fn flat_cost_is_eight_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSample, + provider: RouterProvider::Artcraft, + prompt: Some("mystical RPG adventure".to_string()), + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..Default::default() + }; + let estimate = builder.build2().unwrap().estimate_cost().unwrap(); + assert_eq!(estimate.cost_in_usd_cents, Some(8)); + assert_eq!(estimate.cost_in_credits, Some(8)); + // Direct cost-state path matches the builder path. + assert_eq!(ArtcraftSunoSampleCostState.estimate_cost().cost_in_usd_cents, Some(8)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/mod.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/request.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/request.rs new file mode 100644 index 00000000..bceb72ae --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sample/request.rs @@ -0,0 +1,89 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; +use crate::generate::generate_audio::providers::artcraft::request_common::send_artcraft_omni_audio_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSunoSampleRequestState { + pub request: OmniGenAudioCostAndGenerateRequest, +} + +impl ArtcraftSunoSampleRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_audio_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + /// Replace with a real uploaded audio media token before running. + /// (test_data doesn't have a production audio media token yet.) + const AUDIO_MEDIA_TOKEN: &str = "m_replace_with_uploaded_audio_token"; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn sample_uploaded_audio() { + let response = run_pipeline(GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSample, + provider: RouterProvider::Artcraft, + prompt: Some("Mystical RPG adventure, make it have a grand climax".to_string()), + style_prompt: Some("Fantasy video game score".to_string()), + is_instrumental: Some(true), + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new(AUDIO_MEDIA_TOKEN.to_string()), + ])), + ..Default::default() + }).await; + assert!(matches!(response, GenerateAudioResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/build.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/build.rs new file mode 100644 index 00000000..33755efb --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_audio_model::CommonAudioModel as CommonAudioModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::artcraft::build_common::build_artcraft_omni_audio_request; +use crate::generate::generate_audio::providers::artcraft::suno_sounds::request::ArtcraftSunoSoundsRequestState; + +pub fn build_artcraft_suno_sounds(builder: GenerateAudioRequestBuilder) -> Result { + let request = build_artcraft_omni_audio_request(builder, CommonAudioModelEnum::SunoSounds)?; + let state = ArtcraftSunoSoundsRequestState { request }; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::ArtcraftSunoSounds(state))) +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/cost.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/cost.rs new file mode 100644 index 00000000..17690fef --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/cost.rs @@ -0,0 +1,51 @@ +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::artcraft::suno_sounds::request::ArtcraftSunoSoundsRequestState; + +const COST_IN_USD_CENTS: u64 = 3; + +/// Suno Sounds via Artcraft is flat priced, so the cost state carries no +/// request fields. +#[derive(Clone, Debug)] +pub struct ArtcraftSunoSoundsCostState; + +impl ArtcraftSunoSoundsCostState { + pub fn from_request(_request: &ArtcraftSunoSoundsRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + AudioGenerationCostEstimate { + cost_in_credits: Some(COST_IN_USD_CENTS), + cost_in_usd_cents: Some(COST_IN_USD_CENTS), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + + use super::*; + + #[test] + fn flat_cost_is_three_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSounds, + provider: RouterProvider::Artcraft, + prompt: Some("rain sound effects".to_string()), + ..Default::default() + }; + let estimate = builder.build2().unwrap().estimate_cost().unwrap(); + assert_eq!(estimate.cost_in_usd_cents, Some(3)); + assert_eq!(estimate.cost_in_credits, Some(3)); + // Direct cost-state path matches the builder path. + assert_eq!(ArtcraftSunoSoundsCostState.estimate_cost().cost_in_usd_cents, Some(3)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/mod.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/request.rs b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/request.rs new file mode 100644 index 00000000..f7a6bc97 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/artcraft/suno_sounds/request.rs @@ -0,0 +1,82 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_audio_cost_and_generate_request::OmniGenAudioCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; +use crate::generate::generate_audio::providers::artcraft::request_common::send_artcraft_omni_audio_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSunoSoundsRequestState { + pub request: OmniGenAudioCostAndGenerateRequest, +} + +impl ArtcraftSunoSoundsRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_audio_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn loopable_sound_effect() { + let response = run_pipeline(GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSounds, + provider: RouterProvider::Artcraft, + prompt: Some("Lo-fi vinyl crackle groove".to_string()), + is_loopable: Some(true), + bpm: Some(85), + musical_key: Some(CommonMusicalKey::AMinor), + ..Default::default() + }).await; + assert!(matches!(response, GenerateAudioResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/fal/mod.rs b/crates/router/src/generate/generate_audio/providers/fal/mod.rs new file mode 100644 index 00000000..b93956a4 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/fal/mod.rs @@ -0,0 +1 @@ +pub mod seed_audio_1p0; diff --git a/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/build.rs b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/build.rs new file mode 100644 index 00000000..ce487be2 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/build.rs @@ -0,0 +1,610 @@ +use fal_client::requests::api::audio::omni::seed_audio_1p0::api::{ + SeedAudio1p0OutputFormat, SeedAudio1p0Request, SeedAudio1p0SampleRate, +}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::audio_ref::AudioRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::fal::seed_audio_1p0::request::FalSeedAudio1p0RequestState; +use crate::generate::generate_audio::providers::reject_unsupported::reject_unsupported_option; + +const MAX_AUDIO_REFERENCES: usize = 3; +const MIN_SPEED: f64 = 0.5; +const MAX_SPEED: f64 = 2.0; +const MIN_VOLUME: f64 = 0.5; +const MAX_VOLUME: f64 = 2.0; +const MIN_PITCH: i8 = -12; +const MAX_PITCH: i8 = 12; + +pub fn build_fal_seed_audio_1p0(builder: GenerateAudioRequestBuilder) -> Result { + let state = build_fal_seed_audio_1p0_state(builder)?; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::FalSeedAudio1p0(state))) +} + +pub(crate) fn build_fal_seed_audio_1p0_state( + mut builder: GenerateAudioRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options Seed Audio has no equivalent for. + reject_unsupported_option("style_prompt", builder.style_prompt.as_ref(), strategy)?; + reject_unsupported_option("keep_lyrics", builder.keep_lyrics.as_ref(), strategy)?; + reject_unsupported_option("is_instrumental", builder.is_instrumental.as_ref(), strategy)?; + reject_unsupported_option("is_loopable", builder.is_loopable.as_ref(), strategy)?; + reject_unsupported_option("bpm", builder.bpm.as_ref(), strategy)?; + reject_unsupported_option("musical_key", builder.musical_key.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput("A prompt is required for Seed Audio 1.0".to_string()) + })?; + + let audio_urls = plan_audio_urls(builder.audio_references.take(), strategy)?; + let image_url = plan_image_url(builder.image_references.take(), strategy)?; + + // fal rejects requests that combine an image reference with audio + // references, so the router always rejects the combination too. + if audio_urls.is_some() && image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_references", + value: "Seed Audio 1.0 cannot combine an image reference with audio references".to_string(), + })); + } + + let request = SeedAudio1p0Request { + prompt, + // The omni audio API doesn't expose voice selection yet, so the model + // always picks the voice. + voice: None, + audio_urls, + image_url, + output_format: Some(SeedAudio1p0OutputFormat::Mp3), + sample_rate: plan_sample_rate(builder.sample_rate_hz, strategy)?, + speed: plan_multiplier("speed", builder.speed, MIN_SPEED, MAX_SPEED, strategy)?, + volume: plan_multiplier("volume", builder.volume, MIN_VOLUME, MAX_VOLUME, strategy)?, + pitch: plan_pitch(builder.pitch, strategy)?, + }; + + Ok(FalSeedAudio1p0RequestState { request }) +} + +// ── Plan helpers ── + +/// Seed Audio takes up to 3 reference audio URLs. Fal only accepts URLs (not +/// media tokens). More than 3 references reject under `ErrorOut`; the other +/// strategies keep the first 3. +fn plan_audio_urls( + audio_references: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result>, ArtcraftRouterError> { + let mut urls = match audio_references { + None => return Ok(None), + Some(AudioListRef::Urls(urls)) => urls, + Some(AudioListRef::MediaFileTokens(tokens)) if tokens.is_empty() => return Ok(None), + Some(AudioListRef::MediaFileTokens(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + Some(AudioListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for audio_ref in refs { + match audio_ref { + AudioRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + urls + } + }; + if urls.is_empty() { + return Ok(None); + } + if urls.len() > MAX_AUDIO_REFERENCES { + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "audio_references", + value: format!( + "Seed Audio 1.0 supports at most {} audio references, got {}", + MAX_AUDIO_REFERENCES, + urls.len(), + ), + })); + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + urls.truncate(MAX_AUDIO_REFERENCES); + } + } + } + Ok(Some(urls)) +} + +/// Seed Audio takes a single reference image URL. Fal only accepts URLs (not +/// media tokens). More than 1 reference rejects under `ErrorOut`; the other +/// strategies keep the first. +fn plan_image_url( + image_references: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let urls = match image_references { + None => return Ok(None), + Some(ImageListRef::Urls(urls)) => urls, + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => return Ok(None), + Some(ImageListRef::MediaFileTokens(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + urls + } + }; + if urls.is_empty() { + return Ok(None); + } + if urls.len() > 1 { + if let RequestMismatchMitigationStrategy::ErrorOut = strategy { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_references", + value: format!("Seed Audio 1.0 supports at most 1 image reference, got {}", urls.len()), + })); + } + } + Ok(urls.into_iter().next()) +} + +/// Map a requested sample rate to Seed Audio's supported rates. An exact +/// match is required under `ErrorOut`; the other strategies pick the nearest +/// supported rate (ties resolve to the lower rate). +fn plan_sample_rate( + sample_rate_hz: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + const SUPPORTED: [(u32, SeedAudio1p0SampleRate); 6] = [ + (8_000, SeedAudio1p0SampleRate::Hz8000), + (16_000, SeedAudio1p0SampleRate::Hz16000), + (24_000, SeedAudio1p0SampleRate::Hz24000), + (32_000, SeedAudio1p0SampleRate::Hz32000), + (44_100, SeedAudio1p0SampleRate::Hz44100), + (48_000, SeedAudio1p0SampleRate::Hz48000), + ]; + + let Some(requested) = sample_rate_hz else { + return Ok(None); + }; + + if let Some((_, rate)) = SUPPORTED.iter().find(|(hz, _)| *hz == requested) { + return Ok(Some(*rate)); + } + + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "sample_rate_hz", + value: format!("{}", requested), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + let (_, nearest) = SUPPORTED.iter() + .min_by_key(|(hz, _)| requested.abs_diff(*hz)) + .expect("SUPPORTED is non-empty"); + Ok(Some(*nearest)) + } + } +} + +/// Clamp a 0.5–2.0 multiplier (speed / volume) per strategy: out-of-range +/// values reject under `ErrorOut` and clamp otherwise. +fn plan_multiplier( + field: &'static str, + value: Option, + min: f64, + max: f64, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let Some(value) = value else { + return Ok(None); + }; + if value >= min && value <= max { + return Ok(Some(value)); + } + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: format!("{}", value), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(value.clamp(min, max))), + } +} + +/// Pitch is a semitone shift: round to the nearest whole semitone, then +/// reject (under `ErrorOut`) or clamp values outside ±12. +fn plan_pitch( + pitch: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let Some(pitch) = pitch else { + return Ok(None); + }; + let rounded = pitch.round(); + if rounded >= MIN_PITCH as f64 && rounded <= MAX_PITCH as f64 { + return Ok(Some(rounded as i8)); + } + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "pitch", + value: format!("{}", pitch), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(rounded.clamp(MIN_PITCH as f64, MAX_PITCH as f64) as i8)) + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + const AUDIO_URL: &str = "https://example.com/a.mp3"; + const IMAGE_URL: &str = "https://example.com/scene.png"; + + mod basics { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let state = build_fal_seed_audio_1p0_state(base_builder()).expect("build"); + assert_eq!(state.request.prompt, "a suspense radio drama"); + } + + #[test] + fn missing_prompt_is_rejected() { + let builder = GenerateAudioRequestBuilder { prompt: None, ..base_builder() }; + assert!(build_fal_seed_audio_1p0_state(builder).is_err()); + } + + #[test] + fn voice_is_always_none() { + // The omni audio API doesn't expose voice selection. + let state = build_fal_seed_audio_1p0_state(base_builder()).expect("build"); + assert!(state.request.voice.is_none()); + } + + #[test] + fn output_format_is_mp3() { + let state = build_fal_seed_audio_1p0_state(base_builder()).expect("build"); + assert_eq!(state.request.output_format, Some(SeedAudio1p0OutputFormat::Mp3)); + } + } + + mod reference_tests { + use super::*; + + #[test] + fn audio_urls_pass_through() { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec![AUDIO_URL.to_string()])), + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.audio_urls, Some(vec![AUDIO_URL.to_string()])); + } + + #[test] + fn three_audio_urls_are_accepted() { + let builder = builder_with_audio_urls(3); + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.audio_urls.as_ref().map(|u| u.len()), Some(3)); + } + + #[test] + fn four_audio_urls_error_out() { + let mut builder = builder_with_audio_urls(4); + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_seed_audio_1p0_state(builder).is_err()); + } + + #[test] + fn four_audio_urls_truncate_under_lenient_strategies() { + let mut builder = builder_with_audio_urls(4); + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.audio_urls.as_ref().map(|u| u.len()), Some(3)); + } + + #[test] + fn audio_media_tokens_are_rejected() { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_seed_audio_1p0_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn image_url_passes_through() { + let builder = GenerateAudioRequestBuilder { + image_references: Some(ImageListRef::Urls(vec![IMAGE_URL.to_string()])), + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.image_url.as_deref(), Some(IMAGE_URL)); + } + + #[test] + fn two_image_urls_error_out() { + let builder = GenerateAudioRequestBuilder { + image_references: Some(ImageListRef::Urls(vec![ + IMAGE_URL.to_string(), + "https://example.com/other.png".to_string(), + ])), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_seed_audio_1p0_state(builder).is_err()); + } + + #[test] + fn combining_image_and_audio_references_is_always_rejected() { + // fal rejects the combination, so the router rejects it under every + // mitigation strategy. + for strategy in [ + RequestMismatchMitigationStrategy::ErrorOut, + RequestMismatchMitigationStrategy::PayMoreUpgrade, + RequestMismatchMitigationStrategy::PayLessDowngrade, + ] { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec![AUDIO_URL.to_string()])), + image_references: Some(ImageListRef::Urls(vec![IMAGE_URL.to_string()])), + request_mismatch_mitigation_strategy: strategy, + ..base_builder() + }; + assert!( + build_fal_seed_audio_1p0_state(builder).is_err(), + "expected rejection under {strategy:?}", + ); + } + } + } + + mod sample_rate_tests { + use super::*; + + #[test] + fn exact_rates_map_directly() { + let cases = [ + (8_000, SeedAudio1p0SampleRate::Hz8000), + (16_000, SeedAudio1p0SampleRate::Hz16000), + (24_000, SeedAudio1p0SampleRate::Hz24000), + (32_000, SeedAudio1p0SampleRate::Hz32000), + (44_100, SeedAudio1p0SampleRate::Hz44100), + (48_000, SeedAudio1p0SampleRate::Hz48000), + ]; + for (hz, expected) in cases { + let builder = GenerateAudioRequestBuilder { + sample_rate_hz: Some(hz), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.sample_rate, Some(expected), "for {hz} Hz"); + } + } + + #[test] + fn inexact_rate_errors_out_under_error_out() { + let builder = GenerateAudioRequestBuilder { + sample_rate_hz: Some(22_050), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_seed_audio_1p0_state(builder).is_err()); + } + + #[test] + fn inexact_rate_maps_to_nearest_under_lenient_strategies() { + let cases = [ + (7_000, SeedAudio1p0SampleRate::Hz8000), + (22_050, SeedAudio1p0SampleRate::Hz24000), + (40_000, SeedAudio1p0SampleRate::Hz44100), + (96_000, SeedAudio1p0SampleRate::Hz48000), + ]; + for (hz, expected) in cases { + let builder = GenerateAudioRequestBuilder { + sample_rate_hz: Some(hz), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.sample_rate, Some(expected), "for {hz} Hz"); + } + } + + #[test] + fn no_rate_stays_none() { + let state = build_fal_seed_audio_1p0_state(base_builder()).expect("build"); + assert!(state.request.sample_rate.is_none()); + } + } + + mod speed_and_volume_tests { + use super::*; + + #[test] + fn in_range_values_pass_through() { + let builder = GenerateAudioRequestBuilder { + speed: Some(1.5), + volume: Some(0.5), + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.speed, Some(1.5)); + assert_eq!(state.request.volume, Some(0.5)); + } + + #[test] + fn out_of_range_speed_errors_out() { + let builder = GenerateAudioRequestBuilder { + speed: Some(3.0), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_seed_audio_1p0_state(builder).is_err()); + } + + #[test] + fn out_of_range_speed_clamps_under_lenient_strategies() { + let builder = GenerateAudioRequestBuilder { + speed: Some(3.0), + volume: Some(0.1), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayLessDowngrade, + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.speed, Some(2.0)); + assert_eq!(state.request.volume, Some(0.5)); + } + } + + mod pitch_tests { + use super::*; + + #[test] + fn pitch_rounds_to_nearest_semitone() { + let cases = [ + (2.4, 2i8), + (2.5, 3i8), + (-2.4, -2i8), + (-2.5, -3i8), + (0.0, 0i8), + ]; + for (input, expected) in cases { + let builder = GenerateAudioRequestBuilder { + pitch: Some(input), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.pitch, Some(expected), "for pitch {input}"); + } + } + + #[test] + fn out_of_range_pitch_errors_out() { + for pitch in [13.0, -13.0] { + let builder = GenerateAudioRequestBuilder { + pitch: Some(pitch), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_seed_audio_1p0_state(builder).is_err(), "for pitch {pitch}"); + } + } + + #[test] + fn out_of_range_pitch_clamps_under_lenient_strategies() { + let cases = [(20.0, 12i8), (-20.0, -12i8)]; + for (input, expected) in cases { + let builder = GenerateAudioRequestBuilder { + pitch: Some(input), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.pitch, Some(expected), "for pitch {input}"); + } + } + + #[test] + fn boundary_pitch_is_accepted() { + for (input, expected) in [(12.0, 12i8), (-12.0, -12i8)] { + let builder = GenerateAudioRequestBuilder { + pitch: Some(input), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + let state = build_fal_seed_audio_1p0_state(builder).expect("build"); + assert_eq!(state.request.pitch, Some(expected)); + } + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn unsupported_options_error_out() { + use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; + let cases: Vec = vec![ + GenerateAudioRequestBuilder { style_prompt: Some("EDM".to_string()), ..base_builder() }, + GenerateAudioRequestBuilder { keep_lyrics: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { is_instrumental: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { is_loopable: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { bpm: Some(120), ..base_builder() }, + GenerateAudioRequestBuilder { musical_key: Some(CommonMusicalKey::CMajor), ..base_builder() }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_seed_audio_1p0_state(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateAudioRequestBuilder { + style_prompt: Some("EDM".to_string()), + keep_lyrics: Some(true), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + assert!(build_fal_seed_audio_1p0_state(builder).is_ok()); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SeedAudio1p0, + provider: RouterProvider::Fal, + prompt: Some("a suspense radio drama".to_string()), + ..Default::default() + } + } + + fn builder_with_audio_urls(count: usize) -> GenerateAudioRequestBuilder { + let urls = (0..count).map(|i| format!("https://example.com/a{i}.mp3")).collect(); + GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(urls)), + ..base_builder() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/cost.rs b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/cost.rs new file mode 100644 index 00000000..08e41c79 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/cost.rs @@ -0,0 +1,78 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::fal::seed_audio_1p0::request::FalSeedAudio1p0RequestState; + +#[derive(Clone, Debug)] +pub struct FalSeedAudio1p0CostState { + pub cost_in_usd_cents: u64, +} + +impl FalSeedAudio1p0CostState { + pub fn from_request(request: &FalSeedAudio1p0RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + AudioGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::providers::fal::seed_audio_1p0::build::build_fal_seed_audio_1p0_state; + + use super::*; + + #[test] + fn estimate_is_nineteen_cents() { + let state = build_fal_seed_audio_1p0_state(base_builder()).expect("build"); + let estimate = FalSeedAudio1p0CostState::from_request(&state).estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(19)); + assert_eq!(estimate.cost_in_credits, Some(19)); + } + + #[test] + fn options_do_not_change_the_estimate() { + let tuned = GenerateAudioRequestBuilder { + sample_rate_hz: Some(48_000), + speed: Some(2.0), + volume: Some(0.5), + pitch: Some(-12.0), + ..base_builder() + }; + let base_state = build_fal_seed_audio_1p0_state(base_builder()).expect("build"); + let tuned_state = build_fal_seed_audio_1p0_state(tuned).expect("build"); + assert_eq!( + FalSeedAudio1p0CostState::from_request(&base_state).cost_in_usd_cents, + FalSeedAudio1p0CostState::from_request(&tuned_state).cost_in_usd_cents, + ); + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SeedAudio1p0, + provider: RouterProvider::Fal, + prompt: Some("a calm narrator describes ocean waves".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/mod.rs b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/request.rs b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/request.rs new file mode 100644 index 00000000..4dac750e --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/fal/seed_audio_1p0/request.rs @@ -0,0 +1,118 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::audio::omni::seed_audio_1p0::api::SeedAudio1p0Request; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::generate_audio_response::{ + FalAudioResponsePayload, GenerateAudioResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalSeedAudio1p0RequestState { + /// Final materialized request; ready to fire. + pub request: SeedAudio1p0Request, +} + +impl FalSeedAudio1p0RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let outbound: Arc = Arc::new(self.request.clone()); + + let payload = if let Some(webhook_url) = &client.webhook_url { + let response = self.request.send_webhook_request(&client.api_key, webhook_url).await?; + FalAudioResponsePayload { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + } + } else { + let response = self.request.send_queue_request(&client.api_key).await?; + FalAudioResponsePayload { + request_id: Some(response.request_id), + gateway_request_id: None, + maybe_status_url: Some(response.status_url), + maybe_response_url: Some(response.response_url), + maybe_outbound_request: Some(outbound), + } + }; + + Ok(GenerateAudioResponse::Fal(payload)) + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_seed_audio_webhook() { + let response = run_pipeline(GenerateAudioRequestBuilder { + prompt: Some("A calm narrator describes ocean waves rolling onto a moonlit beach.".to_string()), + ..seed_audio_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_seed_audio_tuned() { + let response = run_pipeline(GenerateAudioRequestBuilder { + prompt: Some("Welcome aboard the midnight express. Please keep your arms inside the train.".to_string()), + sample_rate_hz: Some(44_100), + speed: Some(0.9), + volume: Some(1.2), + pitch: Some(-2.0), + ..seed_audio_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn seed_audio_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SeedAudio1p0, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Seed Audio skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/mod.rs b/crates/router/src/generate/generate_audio/providers/kinovi/mod.rs new file mode 100644 index 00000000..4e3a9278 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/mod.rs @@ -0,0 +1,5 @@ +pub mod suno_music; +pub mod suno_remix; +pub mod suno_sample; +pub mod suno_sounds; +pub(crate) mod resolve; diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/resolve.rs b/crates/router/src/generate/generate_audio/providers/kinovi/resolve.rs new file mode 100644 index 00000000..0ab1f18a --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/resolve.rs @@ -0,0 +1,128 @@ +//! Shared resolve helpers for the Kinovi audio provider. +//! +//! The remix/sample models take exactly one user audio reference, which is +//! resolved to bytes (CDN download, local read, or as-is) and re-uploaded to +//! the Kinovi CDN during the draft `finalize()` phase. The upload plumbing is +//! shared with the Kinovi video provider +//! (`generate_video::providers::kinovi::upload`). + +use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + +use crate::api::audio_list_ref::AudioListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_audio::audio_generation_draft_context::AudioGenerationDraftContext; +use crate::generate::generate_video::providers::kinovi::upload::upload_source_to_seedance2pro; +use crate::utils::media_source_ref::MediaSourceRef; + +/// A single unresolved audio reference: a media token (resolved via the +/// draft context's map), a URL, a local file, or raw bytes. +pub type SingleAudioRef = MediaSourceRef; + +/// Extract exactly one audio reference from the builder's audio list. +/// The Kinovi remix/sample models operate on a single source track, so zero +/// or multiple references are rejected regardless of mitigation strategy. +pub(crate) fn require_single_audio_ref( + audio_references: Option, +) -> Result { + let refs: Vec = match audio_references { + None => { + return Err(ArtcraftRouterError::InvalidInput( + "Exactly one audio reference is required, but none was provided".to_string(), + )); + } + Some(list) => MediaSourceRef::list_from_audios(list), + }; + + match refs.len() { + 0 => Err(ArtcraftRouterError::InvalidInput( + "Exactly one audio reference is required, but none was provided".to_string(), + )), + 1 => Ok(refs.into_iter().next().expect("length checked above")), + count => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "audio_references", + value: format!("Exactly one audio reference is required, got {}", count), + })), + } +} + +/// Resolve a single audio reference and re-upload it to the Kinovi CDN, +/// returning the Kinovi CDN URL. +pub(crate) async fn resolve_and_upload_audio_ref( + session: &Seedance2ProSession, + audio_ref: &SingleAudioRef, + draft_context: &AudioGenerationDraftContext<'_>, +) -> Result { + upload_source_to_seedance2pro(session, audio_ref.clone(), draft_context.media_file_to_artcraft_url_map).await +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use super::*; + + mod require_single_audio_ref_tests { + use std::path::PathBuf; + + use super::*; + + #[test] + fn none_is_rejected() { + assert!(require_single_audio_ref(None).is_err()); + } + + #[test] + fn empty_url_list_is_rejected() { + assert!(require_single_audio_ref(Some(AudioListRef::Urls(vec![]))).is_err()); + } + + #[test] + fn empty_token_list_is_rejected() { + assert!(require_single_audio_ref(Some(AudioListRef::MediaFileTokens(vec![]))).is_err()); + } + + #[test] + fn single_url_is_accepted() { + let result = require_single_audio_ref(Some(AudioListRef::Urls(vec![ + "https://example.com/a.mp3".to_string(), + ]))).expect("should accept a single URL"); + assert!(matches!(result, SingleAudioRef::Url(url) if url == "https://example.com/a.mp3")); + } + + #[test] + fn single_token_is_accepted() { + let result = require_single_audio_ref(Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ]))).expect("should accept a single token"); + assert!(matches!(result, SingleAudioRef::MediaFileToken(t) if t.as_str() == "mf_test123")); + } + + #[test] + fn single_local_path_is_accepted() { + use crate::api::audio_ref::AudioRef; + let result = require_single_audio_ref(Some(AudioListRef::Sources(vec![ + AudioRef::LocalPath(PathBuf::from("/tmp/track.mp3")), + ]))).expect("should accept a single local path"); + assert!(matches!(result, SingleAudioRef::LocalPath(path) if path == PathBuf::from("/tmp/track.mp3"))); + } + + #[test] + fn two_urls_are_rejected() { + let result = require_single_audio_ref(Some(AudioListRef::Urls(vec![ + "https://example.com/a.mp3".to_string(), + "https://example.com/b.mp3".to_string(), + ]))); + assert!(result.is_err()); + } + + #[test] + fn two_tokens_are_rejected() { + let result = require_single_audio_ref(Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ]))); + assert!(result.is_err()); + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/build.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/build.rs new file mode 100644 index 00000000..a0e689d6 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/build.rs @@ -0,0 +1,128 @@ +use seedance2pro_client::generate::audio::generate_suno_music::GenerateSunoMusicRequest; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::kinovi::suno_music::request::KinoviSunoMusicRequestState; +use crate::generate::generate_audio::providers::reject_unsupported::{ + reject_unsupported_audio_references, reject_unsupported_image_references, + reject_unsupported_option, +}; + +pub fn build_kinovi_suno_music(builder: GenerateAudioRequestBuilder) -> Result { + let state = build_kinovi_suno_music_state(builder)?; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::KinoviSunoMusic(state))) +} + +pub(crate) fn build_kinovi_suno_music_state( + mut builder: GenerateAudioRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options Suno Music has no equivalent for. + reject_unsupported_option("keep_lyrics", builder.keep_lyrics.as_ref(), strategy)?; + reject_unsupported_option("is_loopable", builder.is_loopable.as_ref(), strategy)?; + reject_unsupported_option("bpm", builder.bpm.as_ref(), strategy)?; + reject_unsupported_option("musical_key", builder.musical_key.as_ref(), strategy)?; + reject_unsupported_option("sample_rate_hz", builder.sample_rate_hz.as_ref(), strategy)?; + reject_unsupported_option("speed", builder.speed.as_ref(), strategy)?; + reject_unsupported_option("volume", builder.volume.as_ref(), strategy)?; + reject_unsupported_option("pitch", builder.pitch.as_ref(), strategy)?; + reject_unsupported_audio_references(builder.audio_references.as_ref(), strategy)?; + reject_unsupported_image_references(builder.image_references.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput("A prompt is required for Suno Music".to_string()) + })?; + + let request = GenerateSunoMusicRequest { + prompt, + style_tags: builder.style_prompt.take(), + instrumental: builder.is_instrumental.unwrap_or(false), + }; + + Ok(KinoviSunoMusicRequestState { request }) +} + +#[cfg(test)] +mod tests { + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + use super::*; + + #[test] + fn prompt_and_style_are_passed_through() { + let state = build_kinovi_suno_music_state(base_builder()).expect("build"); + assert_eq!(state.request.prompt, "a song about corgis"); + assert_eq!(state.request.style_tags.as_deref(), Some("sea shanty")); + } + + #[test] + fn missing_prompt_is_rejected() { + let builder = GenerateAudioRequestBuilder { prompt: None, ..base_builder() }; + assert!(build_kinovi_suno_music_state(builder).is_err()); + } + + #[test] + fn instrumental_defaults_to_false() { + let state = build_kinovi_suno_music_state(base_builder()).expect("build"); + assert!(!state.request.instrumental); + } + + #[test] + fn instrumental_passes_through() { + let builder = GenerateAudioRequestBuilder { is_instrumental: Some(true), ..base_builder() }; + let state = build_kinovi_suno_music_state(builder).expect("build"); + assert!(state.request.instrumental); + } + + #[test] + fn unsupported_options_error_out() { + let error_out = RequestMismatchMitigationStrategy::ErrorOut; + let cases: Vec = vec![ + GenerateAudioRequestBuilder { keep_lyrics: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { is_loopable: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { bpm: Some(120), ..base_builder() }, + GenerateAudioRequestBuilder { sample_rate_hz: Some(48_000), ..base_builder() }, + GenerateAudioRequestBuilder { speed: Some(1.5), ..base_builder() }, + GenerateAudioRequestBuilder { volume: Some(0.5), ..base_builder() }, + GenerateAudioRequestBuilder { pitch: Some(2.0), ..base_builder() }, + GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.mp3".to_string()])), + ..base_builder() + }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = error_out; + assert!(build_kinovi_suno_music_state(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateAudioRequestBuilder { + keep_lyrics: Some(true), + bpm: Some(120), + speed: Some(1.5), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + assert!(build_kinovi_suno_music_state(builder).is_ok()); + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a song about corgis".to_string()), + style_prompt: Some("sea shanty".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/cost.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/cost.rs new file mode 100644 index 00000000..a561fbad --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/cost.rs @@ -0,0 +1,65 @@ +use seedance2pro_client::generate::audio::generate_suno_music::GenerateSunoMusicRequest; + +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::kinovi::suno_music::request::KinoviSunoMusicRequestState; + +/// Suno Music is flat priced, so the cost state carries no request fields. +#[derive(Clone, Debug)] +pub struct KinoviSunoMusicCostState; + +impl KinoviSunoMusicCostState { + pub fn from_request(_request: &KinoviSunoMusicRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + // Cost math is owned by seedance2pro_client's binding — the router just + // forwards the result so router cost ≡ binding cost by construction. + let pricing_request = GenerateSunoMusicRequest { + prompt: String::new(), + style_tags: None, + instrumental: false, + }; + let costs = pricing_request.calculate_costs(); + + AudioGenerationCostEstimate { + cost_in_credits: Some(costs.kinovi_credits), + cost_in_usd_cents: Some(costs.usd_cents_rounded_up), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::providers::kinovi::suno_music::build::build_kinovi_suno_music_state; + + use super::*; + + #[test] + fn flat_cost_is_seven_cents() { + let estimate = KinoviSunoMusicCostState.estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(7)); + assert_eq!(estimate.cost_in_credits, Some(16)); + } + + #[test] + fn cost_from_built_request_is_seven_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a song".to_string()), + ..Default::default() + }; + let state = build_kinovi_suno_music_state(builder).expect("build"); + let estimate = KinoviSunoMusicCostState::from_request(&state).estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(7)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/mod.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/request.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/request.rs new file mode 100644 index 00000000..49f257c2 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_music/request.rs @@ -0,0 +1,113 @@ +use seedance2pro_client::generate::audio::generate_suno_music::{ + generate_suno_music, GenerateSunoMusicArgs, GenerateSunoMusicRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_audio::generate_audio_response::{ + GenerateAudioResponse, Seedance2proAudioResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviSunoMusicRequestState { + /// Final materialized request; ready to fire. + pub request: GenerateSunoMusicRequest, +} + +impl KinoviSunoMusicRequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSunoMusicArgs { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_suno_music(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateAudioResponse::Seedance2Pro(Seedance2proAudioResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + })) + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn music_with_vocals() { + let response = run_pipeline(GenerateAudioRequestBuilder { + prompt: Some("A song about a corgi who learns to sail the open sea".to_string()), + style_prompt: Some("Sea shanty, folk".to_string()), + ..suno_music_builder() + }).await; + assert!(matches!(response, GenerateAudioResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn music_instrumental() { + let response = run_pipeline(GenerateAudioRequestBuilder { + prompt: Some("An epic journey across a frozen mountain range".to_string()), + style_prompt: Some("Cinematic orchestral score".to_string()), + is_instrumental: Some(true), + ..suno_music_builder() + }).await; + assert!(matches!(response, GenerateAudioResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn suno_music_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoMusic, + provider: RouterProvider::Seedance2Pro, + ..Default::default() + } + } + + fn get_seedance2pro_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_seedance2pro_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Suno Music skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Seedance2Pro(p) => { + println!("task_id={}, order_id={}", p.task_id, p.order_id); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/build.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/build.rs new file mode 100644 index 00000000..57dfbb51 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/build.rs @@ -0,0 +1,178 @@ +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft::AudioGenerationDraftRequest; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::kinovi::resolve::require_single_audio_ref; +use crate::generate::generate_audio::providers::kinovi::suno_remix::draft::KinoviSunoRemixDraftState; +use crate::generate::generate_audio::providers::reject_unsupported::{ + reject_unsupported_image_references, reject_unsupported_option, +}; + +pub fn build_kinovi_suno_remix(builder: GenerateAudioRequestBuilder) -> Result { + let draft = build_kinovi_suno_remix_draft(builder)?; + Ok(AudioGenerationDraftOrRequest::Draft(AudioGenerationDraftRequest::KinoviSunoRemix(draft))) +} + +pub(crate) fn build_kinovi_suno_remix_draft( + mut builder: GenerateAudioRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options Suno Remix has no equivalent for. + reject_unsupported_option("is_instrumental", builder.is_instrumental.as_ref(), strategy)?; + reject_unsupported_option("is_loopable", builder.is_loopable.as_ref(), strategy)?; + reject_unsupported_option("bpm", builder.bpm.as_ref(), strategy)?; + reject_unsupported_option("musical_key", builder.musical_key.as_ref(), strategy)?; + reject_unsupported_option("sample_rate_hz", builder.sample_rate_hz.as_ref(), strategy)?; + reject_unsupported_option("speed", builder.speed.as_ref(), strategy)?; + reject_unsupported_option("volume", builder.volume.as_ref(), strategy)?; + reject_unsupported_option("pitch", builder.pitch.as_ref(), strategy)?; + reject_unsupported_image_references(builder.image_references.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput("A prompt is required for Suno Remix".to_string()) + })?; + + let audio_source = require_single_audio_ref(builder.audio_references.take())?; + + Ok(KinoviSunoRemixDraftState { + prompt, + style_tags: builder.style_prompt.take(), + keep_lyrics: builder.keep_lyrics.unwrap_or(false), + audio_source: Some(audio_source), + }) +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_audio::providers::kinovi::resolve::SingleAudioRef; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_and_style_are_passed_through() { + let draft = build_kinovi_suno_remix_draft(base_builder()).expect("build"); + assert_eq!(draft.prompt, "make this electronic"); + assert_eq!(draft.style_tags.as_deref(), Some("EDM style")); + } + + #[test] + fn missing_prompt_is_rejected() { + let builder = GenerateAudioRequestBuilder { prompt: None, ..base_builder() }; + assert!(build_kinovi_suno_remix_draft(builder).is_err()); + } + + #[test] + fn keep_lyrics_defaults_to_false() { + let draft = build_kinovi_suno_remix_draft(base_builder()).expect("build"); + assert!(!draft.keep_lyrics); + } + + #[test] + fn keep_lyrics_passes_through() { + let builder = GenerateAudioRequestBuilder { keep_lyrics: Some(true), ..base_builder() }; + let draft = build_kinovi_suno_remix_draft(builder).expect("build"); + assert!(draft.keep_lyrics); + } + } + + mod audio_reference_requirements { + use super::*; + + #[test] + fn exactly_one_url_reference_is_accepted() { + let draft = build_kinovi_suno_remix_draft(base_builder()).expect("build"); + assert!(matches!( + draft.audio_source, + Some(SingleAudioRef::Url(url)) if url == "https://example.com/a.mp3" + )); + } + + #[test] + fn a_media_token_reference_is_accepted() { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + let draft = build_kinovi_suno_remix_draft(builder).expect("build"); + assert!(matches!( + draft.audio_source, + Some(SingleAudioRef::MediaFileToken(t)) if t.as_str() == "mf_test123" + )); + } + + #[test] + fn zero_references_are_rejected() { + let builder = GenerateAudioRequestBuilder { audio_references: None, ..base_builder() }; + assert!(build_kinovi_suno_remix_draft(builder).is_err()); + } + + #[test] + fn two_references_are_rejected() { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec![ + "https://example.com/a.mp3".to_string(), + "https://example.com/b.mp3".to_string(), + ])), + ..base_builder() + }; + assert!(build_kinovi_suno_remix_draft(builder).is_err()); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn unsupported_options_error_out() { + let cases: Vec = vec![ + GenerateAudioRequestBuilder { is_instrumental: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { is_loopable: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { bpm: Some(120), ..base_builder() }, + GenerateAudioRequestBuilder { sample_rate_hz: Some(48_000), ..base_builder() }, + GenerateAudioRequestBuilder { speed: Some(1.5), ..base_builder() }, + GenerateAudioRequestBuilder { volume: Some(0.5), ..base_builder() }, + GenerateAudioRequestBuilder { pitch: Some(2.0), ..base_builder() }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_kinovi_suno_remix_draft(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateAudioRequestBuilder { + is_instrumental: Some(true), + bpm: Some(120), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + assert!(build_kinovi_suno_remix_draft(builder).is_ok()); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoRemix, + provider: RouterProvider::Seedance2Pro, + prompt: Some("make this electronic".to_string()), + style_prompt: Some("EDM style".to_string()), + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.mp3".to_string()])), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/cost.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/cost.rs new file mode 100644 index 00000000..3a7cc3e2 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/cost.rs @@ -0,0 +1,75 @@ +use seedance2pro_client::generate::audio::generate_suno_remix::{ + GenerateSunoRemixRequest, KinoviSunoRemixSource, +}; + +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::kinovi::suno_remix::draft::KinoviSunoRemixDraftState; +use crate::generate::generate_audio::providers::kinovi::suno_remix::request::KinoviSunoRemixRequestState; + +/// Suno Remix is flat priced, so the cost state carries no request fields. +#[derive(Clone, Debug)] +pub struct KinoviSunoRemixCostState; + +impl KinoviSunoRemixCostState { + pub fn from_request(_request: &KinoviSunoRemixRequestState) -> Self { + Self + } + + pub fn from_draft(_draft: &KinoviSunoRemixDraftState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + // Cost math is owned by seedance2pro_client's binding — the router just + // forwards the result so router cost ≡ binding cost by construction. + let pricing_request = GenerateSunoRemixRequest { + prompt: String::new(), + source: KinoviSunoRemixSource::AudioUrl("pricing-placeholder".to_string()), + style_tags: None, + keep_lyrics: false, + }; + let costs = pricing_request.calculate_costs(); + + AudioGenerationCostEstimate { + cost_in_credits: Some(costs.kinovi_credits), + cost_in_usd_cents: Some(costs.usd_cents_rounded_up), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::providers::kinovi::suno_remix::build::build_kinovi_suno_remix_draft; + + use super::*; + + #[test] + fn flat_cost_is_seven_cents() { + let estimate = KinoviSunoRemixCostState.estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(7)); + assert_eq!(estimate.cost_in_credits, Some(16)); + } + + #[test] + fn cost_from_draft_is_seven_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoRemix, + provider: RouterProvider::Seedance2Pro, + prompt: Some("make this electronic".to_string()), + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.mp3".to_string()])), + ..Default::default() + }; + let draft = build_kinovi_suno_remix_draft(builder).expect("build"); + let estimate = KinoviSunoRemixCostState::from_draft(&draft).estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(7)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/draft.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/draft.rs new file mode 100644 index 00000000..bb3306c5 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/draft.rs @@ -0,0 +1,49 @@ +use seedance2pro_client::generate::audio::generate_suno_remix::{ + GenerateSunoRemixRequest, KinoviSunoRemixSource, +}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_context::AudioGenerationDraftContext; +use crate::generate::generate_audio::providers::kinovi::resolve::{ + resolve_and_upload_audio_ref, SingleAudioRef, +}; +use crate::generate::generate_audio::providers::kinovi::suno_remix::request::KinoviSunoRemixRequestState; + +#[derive(Debug, Clone)] +pub struct KinoviSunoRemixDraftState { + // Materialized / finalized types + + pub prompt: String, + pub style_tags: Option, + pub keep_lyrics: bool, + + // Pending types that need to be resolved and uploaded to the Kinovi CDN. + pub audio_source: Option, +} + +impl KinoviSunoRemixDraftState { + pub async fn to_request( + &mut self, + draft_context: &AudioGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let audio_source = self.audio_source.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Suno Remix draft has no audio source (already finalized?)".to_string(), + ) + })?; + + let kinovi_audio_url = resolve_and_upload_audio_ref(session, &audio_source, draft_context).await?; + + let request = GenerateSunoRemixRequest { + prompt: self.prompt.clone(), + source: KinoviSunoRemixSource::AudioUrl(kinovi_audio_url), + style_tags: self.style_tags.clone(), + keep_lyrics: self.keep_lyrics, + }; + + Ok(KinoviSunoRemixRequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/mod.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/request.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/request.rs new file mode 100644 index 00000000..b1cd7661 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_remix/request.rs @@ -0,0 +1,134 @@ +use seedance2pro_client::generate::audio::generate_suno_remix::{ + generate_suno_remix, GenerateSunoRemixArgs, GenerateSunoRemixRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_audio::generate_audio_response::{ + GenerateAudioResponse, Seedance2proAudioResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviSunoRemixRequestState { + /// Final materialized request; ready to fire. The audio source has been + /// re-uploaded to the Kinovi CDN by the draft's `to_request()`. + pub request: GenerateSunoRemixRequest, +} + +impl KinoviSunoRemixRequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSunoRemixArgs { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_suno_remix(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateAudioResponse::Seedance2Pro(Seedance2proAudioResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + })) + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use seedance2pro_client::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use seedance2pro_client::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + use test_utils::test_file_path::test_file_path; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_audio::audio_generation_draft_context::AudioGenerationDraftContext; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + const TEST_AUDIO_PATH: &str = "test_data/audio/mp3/super_mario_rpg_beware_the_forests_mushrooms.mp3"; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. Requires a local audio file. + async fn remix_uploaded_audio() { + let client = get_seedance2pro_client(); + let audio_url = upload_test_audio(&client).await; + println!("Uploaded audio: {}", audio_url); + + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoRemix, + provider: RouterProvider::Seedance2Pro, + prompt: Some("Make this electronic".to_string()), + style_prompt: Some("EDM style".to_string()), + audio_references: Some(AudioListRef::Urls(vec![audio_url])), + ..Default::default() + }; + + let response = run_pipeline(&client, builder).await; + assert!(matches!(response, GenerateAudioResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_seedance2pro_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + async fn run_pipeline(client: &RouterClient, builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let draft_or_request = builder.build2().expect("build2 should succeed"); + let draft = match draft_or_request { + AudioGenerationDraftOrRequest::Draft(d) => d, + _ => panic!("expected Draft variant (Suno Remix uses the draft phase)"), + }; + + let draft_context = AudioGenerationDraftContext { + client: Some(client), + ..Default::default() + }; + + let request = draft.finalize(draft_context).await.expect("finalize should succeed"); + let response = request.send_request(client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Seedance2Pro(p) => { + println!("task_id={}, order_id={}", p.task_id, p.order_id); + } + other => println!("response: {:?}", other), + } + + response + } + + async fn upload_test_audio(client: &RouterClient) -> String { + let session = &client.get_seedance2pro_client_ref().expect("seedance2pro client").session; + + let audio_path = test_file_path(TEST_AUDIO_PATH).expect("test audio should exist"); + let audio_bytes = std::fs::read(&audio_path).expect("read test audio"); + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "mp3".to_string(), + host_override: None, + }).await.expect("prepare upload"); + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: audio_bytes, + host_override: None, + }).await.expect("upload"); + + upload_result.public_url + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/build.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/build.rs new file mode 100644 index 00000000..9151d9b7 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/build.rs @@ -0,0 +1,172 @@ +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft::AudioGenerationDraftRequest; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::kinovi::resolve::require_single_audio_ref; +use crate::generate::generate_audio::providers::kinovi::suno_sample::draft::KinoviSunoSampleDraftState; +use crate::generate::generate_audio::providers::reject_unsupported::{ + reject_unsupported_image_references, reject_unsupported_option, +}; + +/// The omni audio API doesn't carry a sample window yet, so every sample +/// generation chops the first 30 seconds of the source audio. +pub(crate) const DEFAULT_CHOP_SAMPLE_START_SECONDS: u32 = 0; +pub(crate) const DEFAULT_CHOP_SAMPLE_END_SECONDS: u32 = 30; + +pub fn build_kinovi_suno_sample(builder: GenerateAudioRequestBuilder) -> Result { + let draft = build_kinovi_suno_sample_draft(builder)?; + Ok(AudioGenerationDraftOrRequest::Draft(AudioGenerationDraftRequest::KinoviSunoSample(draft))) +} + +pub(crate) fn build_kinovi_suno_sample_draft( + mut builder: GenerateAudioRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options Suno Sample has no equivalent for. + reject_unsupported_option("keep_lyrics", builder.keep_lyrics.as_ref(), strategy)?; + reject_unsupported_option("is_loopable", builder.is_loopable.as_ref(), strategy)?; + reject_unsupported_option("bpm", builder.bpm.as_ref(), strategy)?; + reject_unsupported_option("musical_key", builder.musical_key.as_ref(), strategy)?; + reject_unsupported_option("sample_rate_hz", builder.sample_rate_hz.as_ref(), strategy)?; + reject_unsupported_option("speed", builder.speed.as_ref(), strategy)?; + reject_unsupported_option("volume", builder.volume.as_ref(), strategy)?; + reject_unsupported_option("pitch", builder.pitch.as_ref(), strategy)?; + reject_unsupported_image_references(builder.image_references.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput("A prompt is required for Suno Sample".to_string()) + })?; + + let audio_source = require_single_audio_ref(builder.audio_references.take())?; + + Ok(KinoviSunoSampleDraftState { + prompt, + style_tags: builder.style_prompt.take(), + instrumental: builder.is_instrumental.unwrap_or(false), + chop_sample_start_seconds: DEFAULT_CHOP_SAMPLE_START_SECONDS, + chop_sample_end_seconds: DEFAULT_CHOP_SAMPLE_END_SECONDS, + audio_source: Some(audio_source), + }) +} + +#[cfg(test)] +mod tests { + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_audio::providers::kinovi::resolve::SingleAudioRef; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_and_style_are_passed_through() { + let draft = build_kinovi_suno_sample_draft(base_builder()).expect("build"); + assert_eq!(draft.prompt, "mystical RPG adventure"); + assert_eq!(draft.style_tags.as_deref(), Some("fantasy video game")); + } + + #[test] + fn missing_prompt_is_rejected() { + let builder = GenerateAudioRequestBuilder { prompt: None, ..base_builder() }; + assert!(build_kinovi_suno_sample_draft(builder).is_err()); + } + + #[test] + fn instrumental_defaults_to_false() { + let draft = build_kinovi_suno_sample_draft(base_builder()).expect("build"); + assert!(!draft.instrumental); + } + + #[test] + fn instrumental_passes_through() { + let builder = GenerateAudioRequestBuilder { is_instrumental: Some(true), ..base_builder() }; + let draft = build_kinovi_suno_sample_draft(builder).expect("build"); + assert!(draft.instrumental); + } + + #[test] + fn chop_window_defaults_to_first_thirty_seconds() { + let draft = build_kinovi_suno_sample_draft(base_builder()).expect("build"); + assert_eq!(draft.chop_sample_start_seconds, 0); + assert_eq!(draft.chop_sample_end_seconds, 30); + } + } + + mod audio_reference_requirements { + use super::*; + + #[test] + fn exactly_one_reference_is_accepted() { + let draft = build_kinovi_suno_sample_draft(base_builder()).expect("build"); + assert!(matches!(draft.audio_source, Some(SingleAudioRef::Url(_)))); + } + + #[test] + fn zero_references_are_rejected() { + let builder = GenerateAudioRequestBuilder { audio_references: None, ..base_builder() }; + assert!(build_kinovi_suno_sample_draft(builder).is_err()); + } + + #[test] + fn two_references_are_rejected() { + let builder = GenerateAudioRequestBuilder { + audio_references: Some(AudioListRef::Urls(vec![ + "https://example.com/a.mp3".to_string(), + "https://example.com/b.mp3".to_string(), + ])), + ..base_builder() + }; + assert!(build_kinovi_suno_sample_draft(builder).is_err()); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn unsupported_options_error_out() { + let cases: Vec = vec![ + GenerateAudioRequestBuilder { keep_lyrics: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { is_loopable: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { bpm: Some(120), ..base_builder() }, + GenerateAudioRequestBuilder { sample_rate_hz: Some(48_000), ..base_builder() }, + GenerateAudioRequestBuilder { speed: Some(1.5), ..base_builder() }, + GenerateAudioRequestBuilder { volume: Some(0.5), ..base_builder() }, + GenerateAudioRequestBuilder { pitch: Some(2.0), ..base_builder() }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_kinovi_suno_sample_draft(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateAudioRequestBuilder { + keep_lyrics: Some(true), + speed: Some(1.5), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + assert!(build_kinovi_suno_sample_draft(builder).is_ok()); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSample, + provider: RouterProvider::Seedance2Pro, + prompt: Some("mystical RPG adventure".to_string()), + style_prompt: Some("fantasy video game".to_string()), + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.aac".to_string()])), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/cost.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/cost.rs new file mode 100644 index 00000000..859b9467 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/cost.rs @@ -0,0 +1,75 @@ +use seedance2pro_client::generate::audio::generate_suno_sample::GenerateSunoSampleRequest; + +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::kinovi::suno_sample::draft::KinoviSunoSampleDraftState; +use crate::generate::generate_audio::providers::kinovi::suno_sample::request::KinoviSunoSampleRequestState; + +/// Suno Sample is flat priced, so the cost state carries no request fields. +#[derive(Clone, Debug)] +pub struct KinoviSunoSampleCostState; + +impl KinoviSunoSampleCostState { + pub fn from_request(_request: &KinoviSunoSampleRequestState) -> Self { + Self + } + + pub fn from_draft(_draft: &KinoviSunoSampleDraftState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + // Cost math is owned by seedance2pro_client's binding — the router just + // forwards the result so router cost ≡ binding cost by construction. + let pricing_request = GenerateSunoSampleRequest { + prompt: String::new(), + audio_url: "pricing-placeholder".to_string(), + chop_sample_start_seconds: 0, + chop_sample_end_seconds: 30, + style_tags: None, + instrumental: false, + }; + let costs = pricing_request.calculate_costs(); + + AudioGenerationCostEstimate { + cost_in_credits: Some(costs.kinovi_credits), + cost_in_usd_cents: Some(costs.usd_cents_rounded_up), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::providers::kinovi::suno_sample::build::build_kinovi_suno_sample_draft; + + use super::*; + + #[test] + fn flat_cost_is_seven_cents() { + let estimate = KinoviSunoSampleCostState.estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(7)); + assert_eq!(estimate.cost_in_credits, Some(16)); + } + + #[test] + fn cost_from_draft_is_seven_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSample, + provider: RouterProvider::Seedance2Pro, + prompt: Some("mystical RPG adventure".to_string()), + audio_references: Some(AudioListRef::Urls(vec!["https://example.com/a.aac".to_string()])), + ..Default::default() + }; + let draft = build_kinovi_suno_sample_draft(builder).expect("build"); + let estimate = KinoviSunoSampleCostState::from_draft(&draft).estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(7)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/draft.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/draft.rs new file mode 100644 index 00000000..922c6794 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/draft.rs @@ -0,0 +1,59 @@ +use seedance2pro_client::generate::audio::generate_suno_sample::GenerateSunoSampleRequest; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_context::AudioGenerationDraftContext; +use crate::generate::generate_audio::providers::kinovi::resolve::{ + resolve_and_upload_audio_ref, SingleAudioRef, +}; +use crate::generate::generate_audio::providers::kinovi::suno_sample::request::KinoviSunoSampleRequestState; + +#[derive(Debug, Clone)] +pub struct KinoviSunoSampleDraftState { + // Materialized / finalized types + + pub prompt: String, + pub style_tags: Option, + pub instrumental: bool, + + /// Start of the sample window within the audio, in seconds. + /// NB: the omni audio API doesn't carry a sample window yet, so builds + /// default this to 0. + pub chop_sample_start_seconds: u32, + + /// End of the sample window within the audio, in seconds. + /// NB: the omni audio API doesn't carry a sample window yet, so builds + /// default this to 30. + pub chop_sample_end_seconds: u32, + + // Pending types that need to be resolved and uploaded to the Kinovi CDN. + pub audio_source: Option, +} + +impl KinoviSunoSampleDraftState { + pub async fn to_request( + &mut self, + draft_context: &AudioGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let audio_source = self.audio_source.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Suno Sample draft has no audio source (already finalized?)".to_string(), + ) + })?; + + let kinovi_audio_url = resolve_and_upload_audio_ref(session, &audio_source, draft_context).await?; + + let request = GenerateSunoSampleRequest { + prompt: self.prompt.clone(), + audio_url: kinovi_audio_url, + chop_sample_start_seconds: self.chop_sample_start_seconds, + chop_sample_end_seconds: self.chop_sample_end_seconds, + style_tags: self.style_tags.clone(), + instrumental: self.instrumental, + }; + + Ok(KinoviSunoSampleRequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/mod.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/request.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/request.rs new file mode 100644 index 00000000..d89b6489 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sample/request.rs @@ -0,0 +1,135 @@ +use seedance2pro_client::generate::audio::generate_suno_sample::{ + generate_suno_sample, GenerateSunoSampleArgs, GenerateSunoSampleRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_audio::generate_audio_response::{ + GenerateAudioResponse, Seedance2proAudioResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviSunoSampleRequestState { + /// Final materialized request; ready to fire. The audio source has been + /// re-uploaded to the Kinovi CDN by the draft's `to_request()`. + pub request: GenerateSunoSampleRequest, +} + +impl KinoviSunoSampleRequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSunoSampleArgs { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_suno_sample(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateAudioResponse::Seedance2Pro(Seedance2proAudioResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + })) + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use seedance2pro_client::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; + use seedance2pro_client::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; + use test_utils::test_file_path::test_file_path; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_audio::audio_generation_draft_context::AudioGenerationDraftContext; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + const TEST_AUDIO_PATH: &str = "test_data/audio/aac/golden_sun_elemental_stars_cyanne.aac"; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. Requires a local audio file. + async fn sample_instrumental() { + let client = get_seedance2pro_client(); + let audio_url = upload_test_audio(&client).await; + println!("Uploaded audio: {}", audio_url); + + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSample, + provider: RouterProvider::Seedance2Pro, + prompt: Some("Mystical RPG adventure, make it have a grand climax".to_string()), + style_prompt: Some("Fantasy video game score".to_string()), + is_instrumental: Some(true), + audio_references: Some(AudioListRef::Urls(vec![audio_url])), + ..Default::default() + }; + + let response = run_pipeline(&client, builder).await; + assert!(matches!(response, GenerateAudioResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_seedance2pro_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + async fn run_pipeline(client: &RouterClient, builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let draft_or_request = builder.build2().expect("build2 should succeed"); + let draft = match draft_or_request { + AudioGenerationDraftOrRequest::Draft(d) => d, + _ => panic!("expected Draft variant (Suno Sample uses the draft phase)"), + }; + + let draft_context = AudioGenerationDraftContext { + client: Some(client), + ..Default::default() + }; + + let request = draft.finalize(draft_context).await.expect("finalize should succeed"); + let response = request.send_request(client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Seedance2Pro(p) => { + println!("task_id={}, order_id={}", p.task_id, p.order_id); + } + other => println!("response: {:?}", other), + } + + response + } + + async fn upload_test_audio(client: &RouterClient) -> String { + let session = &client.get_seedance2pro_client_ref().expect("seedance2pro client").session; + + let audio_path = test_file_path(TEST_AUDIO_PATH).expect("test audio should exist"); + let audio_bytes = std::fs::read(&audio_path).expect("read test audio"); + + let prepare_result = prepare_file_upload(PrepareFileUploadArgs { + session, + extension: "aac".to_string(), + host_override: None, + }).await.expect("prepare upload"); + + let upload_result = upload_file(UploadFileArgs { + upload_url: prepare_result.upload_url, + file_bytes: audio_bytes, + host_override: None, + }).await.expect("upload"); + + upload_result.public_url + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/build.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/build.rs new file mode 100644 index 00000000..7bcaa051 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/build.rs @@ -0,0 +1,209 @@ +use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; +use seedance2pro_client::generate::audio::generate_suno_sound::{ + GenerateSunoSoundRequest, KinoviSunoSoundKey, KinoviSunoSoundType, +}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; +use crate::generate::generate_audio::audio_generation_request::AudioGenerationRequest; +use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; +use crate::generate::generate_audio::providers::kinovi::suno_sounds::request::KinoviSunoSoundsRequestState; +use crate::generate::generate_audio::providers::reject_unsupported::{ + reject_unsupported_audio_references, reject_unsupported_image_references, + reject_unsupported_option, +}; + +pub fn build_kinovi_suno_sounds(builder: GenerateAudioRequestBuilder) -> Result { + let state = build_kinovi_suno_sounds_state(builder)?; + Ok(AudioGenerationDraftOrRequest::Request(AudioGenerationRequest::KinoviSunoSounds(state))) +} + +pub(crate) fn build_kinovi_suno_sounds_state( + mut builder: GenerateAudioRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options Suno Sounds has no equivalent for. + reject_unsupported_option("style_prompt", builder.style_prompt.as_ref(), strategy)?; + reject_unsupported_option("keep_lyrics", builder.keep_lyrics.as_ref(), strategy)?; + reject_unsupported_option("is_instrumental", builder.is_instrumental.as_ref(), strategy)?; + reject_unsupported_option("sample_rate_hz", builder.sample_rate_hz.as_ref(), strategy)?; + reject_unsupported_option("speed", builder.speed.as_ref(), strategy)?; + reject_unsupported_option("volume", builder.volume.as_ref(), strategy)?; + reject_unsupported_option("pitch", builder.pitch.as_ref(), strategy)?; + reject_unsupported_audio_references(builder.audio_references.as_ref(), strategy)?; + reject_unsupported_image_references(builder.image_references.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput("A prompt is required for Suno Sounds".to_string()) + })?; + + let request = GenerateSunoSoundRequest { + prompt, + sound_type: plan_sound_type(builder.is_loopable), + bpm: builder.bpm, + key: plan_key(builder.musical_key), + }; + + Ok(KinoviSunoSoundsRequestState { request }) +} + +// ── Plan helpers ── + +fn plan_sound_type(is_loopable: Option) -> KinoviSunoSoundType { + match is_loopable { + Some(true) => KinoviSunoSoundType::Loopable, + Some(false) | None => KinoviSunoSoundType::SingleHit, + } +} + +fn plan_key(musical_key: Option) -> KinoviSunoSoundKey { + match musical_key { + None | Some(CommonMusicalKey::Auto) => KinoviSunoSoundKey::Auto, + Some(CommonMusicalKey::CMajor) => KinoviSunoSoundKey::CMajor, + Some(CommonMusicalKey::CMinor) => KinoviSunoSoundKey::CMinor, + Some(CommonMusicalKey::DMajor) => KinoviSunoSoundKey::DMajor, + Some(CommonMusicalKey::DMinor) => KinoviSunoSoundKey::DMinor, + Some(CommonMusicalKey::FMajor) => KinoviSunoSoundKey::FMajor, + Some(CommonMusicalKey::FMinor) => KinoviSunoSoundKey::FMinor, + Some(CommonMusicalKey::GMajor) => KinoviSunoSoundKey::GMajor, + Some(CommonMusicalKey::GMinor) => KinoviSunoSoundKey::GMinor, + Some(CommonMusicalKey::AMajor) => KinoviSunoSoundKey::AMajor, + Some(CommonMusicalKey::AMinor) => KinoviSunoSoundKey::AMinor, + Some(CommonMusicalKey::BMajor) => KinoviSunoSoundKey::BMajor, + Some(CommonMusicalKey::BMinor) => KinoviSunoSoundKey::BMinor, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let state = build_kinovi_suno_sounds_state(base_builder()).expect("build"); + assert_eq!(state.request.prompt, "rain sound effects"); + } + + #[test] + fn missing_prompt_is_rejected() { + let builder = GenerateAudioRequestBuilder { prompt: None, ..base_builder() }; + assert!(build_kinovi_suno_sounds_state(builder).is_err()); + } + + #[test] + fn bpm_passes_through() { + let builder = GenerateAudioRequestBuilder { bpm: Some(120), ..base_builder() }; + let state = build_kinovi_suno_sounds_state(builder).expect("build"); + assert_eq!(state.request.bpm, Some(120)); + } + + #[test] + fn loopable_true_maps_to_loop() { + let builder = GenerateAudioRequestBuilder { is_loopable: Some(true), ..base_builder() }; + let state = build_kinovi_suno_sounds_state(builder).expect("build"); + assert!(matches!(state.request.sound_type, KinoviSunoSoundType::Loopable)); + } + + #[test] + fn loopable_false_maps_to_single_hit() { + let builder = GenerateAudioRequestBuilder { is_loopable: Some(false), ..base_builder() }; + let state = build_kinovi_suno_sounds_state(builder).expect("build"); + assert!(matches!(state.request.sound_type, KinoviSunoSoundType::SingleHit)); + } + + #[test] + fn loopable_none_defaults_to_single_hit() { + let state = build_kinovi_suno_sounds_state(base_builder()).expect("build"); + assert!(matches!(state.request.sound_type, KinoviSunoSoundType::SingleHit)); + } + } + + mod key_mapping { + use super::*; + + #[test] + fn every_common_key_maps_to_the_kinovi_key() { + let cases = [ + (Some(CommonMusicalKey::Auto), KinoviSunoSoundKey::Auto), + (Some(CommonMusicalKey::CMajor), KinoviSunoSoundKey::CMajor), + (Some(CommonMusicalKey::CMinor), KinoviSunoSoundKey::CMinor), + (Some(CommonMusicalKey::DMajor), KinoviSunoSoundKey::DMajor), + (Some(CommonMusicalKey::DMinor), KinoviSunoSoundKey::DMinor), + (Some(CommonMusicalKey::FMajor), KinoviSunoSoundKey::FMajor), + (Some(CommonMusicalKey::FMinor), KinoviSunoSoundKey::FMinor), + (Some(CommonMusicalKey::GMajor), KinoviSunoSoundKey::GMajor), + (Some(CommonMusicalKey::GMinor), KinoviSunoSoundKey::GMinor), + (Some(CommonMusicalKey::AMajor), KinoviSunoSoundKey::AMajor), + (Some(CommonMusicalKey::AMinor), KinoviSunoSoundKey::AMinor), + (Some(CommonMusicalKey::BMajor), KinoviSunoSoundKey::BMajor), + (Some(CommonMusicalKey::BMinor), KinoviSunoSoundKey::BMinor), + ]; + assert_eq!(cases.len(), 13, "expected all 13 CommonMusicalKey variants covered"); + for (common_key, expected) in cases { + let builder = GenerateAudioRequestBuilder { musical_key: common_key, ..base_builder() }; + let state = build_kinovi_suno_sounds_state(builder).expect("build"); + assert!( + matches!(state.request.key, k if format!("{k:?}") == format!("{expected:?}")), + "expected {expected:?} for {common_key:?}, got {:?}", state.request.key, + ); + } + } + + #[test] + fn missing_key_defaults_to_auto() { + let state = build_kinovi_suno_sounds_state(base_builder()).expect("build"); + assert!(matches!(state.request.key, KinoviSunoSoundKey::Auto)); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn unsupported_options_error_out() { + let cases: Vec = vec![ + GenerateAudioRequestBuilder { style_prompt: Some("EDM".to_string()), ..base_builder() }, + GenerateAudioRequestBuilder { keep_lyrics: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { is_instrumental: Some(true), ..base_builder() }, + GenerateAudioRequestBuilder { sample_rate_hz: Some(48_000), ..base_builder() }, + GenerateAudioRequestBuilder { speed: Some(1.5), ..base_builder() }, + GenerateAudioRequestBuilder { volume: Some(0.5), ..base_builder() }, + GenerateAudioRequestBuilder { pitch: Some(2.0), ..base_builder() }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_kinovi_suno_sounds_state(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateAudioRequestBuilder { + style_prompt: Some("EDM".to_string()), + is_instrumental: Some(true), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayLessDowngrade, + ..base_builder() + }; + assert!(build_kinovi_suno_sounds_state(builder).is_ok()); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSounds, + provider: RouterProvider::Seedance2Pro, + prompt: Some("rain sound effects".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/cost.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/cost.rs new file mode 100644 index 00000000..2e75398c --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/cost.rs @@ -0,0 +1,70 @@ +use seedance2pro_client::generate::audio::generate_suno_sound::{ + GenerateSunoSoundRequest, KinoviSunoSoundKey, KinoviSunoSoundType, +}; + +use crate::generate::generate_audio::audio_generation_cost_estimate::AudioGenerationCostEstimate; +use crate::generate::generate_audio::providers::kinovi::suno_sounds::request::KinoviSunoSoundsRequestState; + +/// Suno Sounds is flat priced, so the cost state carries no request fields. +#[derive(Clone, Debug)] +pub struct KinoviSunoSoundsCostState; + +impl KinoviSunoSoundsCostState { + pub fn from_request(_request: &KinoviSunoSoundsRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> AudioGenerationCostEstimate { + // Cost math is owned by seedance2pro_client's binding — the router just + // forwards the result so router cost ≡ binding cost by construction. + let pricing_request = GenerateSunoSoundRequest { + prompt: String::new(), + sound_type: KinoviSunoSoundType::SingleHit, + bpm: None, + key: KinoviSunoSoundKey::Auto, + }; + let costs = pricing_request.calculate_costs(); + + AudioGenerationCostEstimate { + cost_in_credits: Some(costs.kinovi_credits), + cost_in_usd_cents: Some(costs.usd_cents_rounded_up), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::providers::kinovi::suno_sounds::build::build_kinovi_suno_sounds_state; + + use super::*; + + #[test] + fn flat_cost_is_two_cents() { + let estimate = KinoviSunoSoundsCostState.estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(2)); + assert_eq!(estimate.cost_in_credits, Some(4)); + } + + #[test] + fn cost_from_built_request_is_two_cents() { + let builder = GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSounds, + provider: RouterProvider::Seedance2Pro, + prompt: Some("thunder".to_string()), + is_loopable: Some(true), + bpm: Some(60), + ..Default::default() + }; + let state = build_kinovi_suno_sounds_state(builder).expect("build"); + let estimate = KinoviSunoSoundsCostState::from_request(&state).estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(2)); + } +} diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/mod.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/request.rs b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/request.rs new file mode 100644 index 00000000..25a396de --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/kinovi/suno_sounds/request.rs @@ -0,0 +1,114 @@ +use seedance2pro_client::generate::audio::generate_suno_sound::{ + generate_suno_sound, GenerateSunoSoundArgs, GenerateSunoSoundRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_audio::generate_audio_response::{ + GenerateAudioResponse, Seedance2proAudioResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviSunoSoundsRequestState { + /// Final materialized request; ready to fire. + pub request: GenerateSunoSoundRequest, +} + +impl KinoviSunoSoundsRequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSunoSoundArgs { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_suno_sound(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateAudioResponse::Seedance2Pro(Seedance2proAudioResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + })) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_musical_key::CommonMusicalKey; + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + + use crate::api::router_audio_model::RouterAudioModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_audio::audio_generation_draft_or_request::AudioGenerationDraftOrRequest; + use crate::generate::generate_audio::generate_audio_request_builder::GenerateAudioRequestBuilder; + use crate::generate::generate_audio::generate_audio_response::GenerateAudioResponse; + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn single_hit() { + let response = run_pipeline(GenerateAudioRequestBuilder { + prompt: Some("A heavy castle door creaking open".to_string()), + ..suno_sounds_builder() + }).await; + assert!(matches!(response, GenerateAudioResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // Sends a real generation to Kinovi; costs credits. + async fn loop_with_bpm_and_key() { + let response = run_pipeline(GenerateAudioRequestBuilder { + prompt: Some("Lo-fi vinyl crackle groove".to_string()), + is_loopable: Some(true), + bpm: Some(85), + musical_key: Some(CommonMusicalKey::AMinor), + ..suno_sounds_builder() + }).await; + assert!(matches!(response, GenerateAudioResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn suno_sounds_builder() -> GenerateAudioRequestBuilder { + GenerateAudioRequestBuilder { + model: RouterAudioModel::SunoSounds, + provider: RouterProvider::Seedance2Pro, + ..Default::default() + } + } + + fn get_seedance2pro_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + async fn run_pipeline(builder: GenerateAudioRequestBuilder) -> GenerateAudioResponse { + let client = get_seedance2pro_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + AudioGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Suno Sounds skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateAudioResponse::Seedance2Pro(p) => { + println!("task_id={}, order_id={}", p.task_id, p.order_id); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_audio/providers/mod.rs b/crates/router/src/generate/generate_audio/providers/mod.rs new file mode 100644 index 00000000..0ff9bf52 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/mod.rs @@ -0,0 +1,4 @@ +pub mod artcraft; +pub mod fal; +pub mod kinovi; +pub(crate) mod reject_unsupported; diff --git a/crates/router/src/generate/generate_audio/providers/reject_unsupported.rs b/crates/router/src/generate/generate_audio/providers/reject_unsupported.rs new file mode 100644 index 00000000..e7fe5311 --- /dev/null +++ b/crates/router/src/generate/generate_audio/providers/reject_unsupported.rs @@ -0,0 +1,61 @@ +//! Shared helpers for rejecting builder options that a model does not support. +//! +//! Per the request-mismatch mitigation strategy: `ErrorOut` rejects the +//! request when an unsupported option is set; the other strategies silently +//! drop the option. + +use std::fmt::Debug; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +/// Reject (under `ErrorOut`) or silently drop a set option the model doesn't +/// support. +pub(crate) fn reject_unsupported_option( + field: &'static str, + value: Option<&T>, + strategy: RequestMismatchMitigationStrategy, +) -> Result<(), ArtcraftRouterError> { + let Some(value) = value else { + return Ok(()); + }; + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: format!("{:?}", value), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(()), + } +} + +/// Reject (under `ErrorOut`) or silently drop audio references for models +/// that take none. Empty lists are treated as absent. +pub(crate) fn reject_unsupported_audio_references( + refs: Option<&AudioListRef>, + strategy: RequestMismatchMitigationStrategy, +) -> Result<(), ArtcraftRouterError> { + let has_refs = refs.is_some_and(|refs| !refs.is_empty()); + if has_refs { + return reject_unsupported_option("audio_references", refs, strategy); + } + Ok(()) +} + +/// Reject (under `ErrorOut`) or silently drop image references for models +/// that take none. Empty lists are treated as absent. +pub(crate) fn reject_unsupported_image_references( + refs: Option<&ImageListRef>, + strategy: RequestMismatchMitigationStrategy, +) -> Result<(), ArtcraftRouterError> { + let has_refs = refs.is_some_and(|refs| !refs.is_empty()); + if has_refs { + return reject_unsupported_option("image_references", refs, strategy); + } + Ok(()) +} diff --git a/crates/router/src/generate/generate_image/generate_image_request_builder.rs b/crates/router/src/generate/generate_image/generate_image_request_builder.rs new file mode 100644 index 00000000..ae382df6 --- /dev/null +++ b/crates/router/src/generate/generate_image/generate_image_request_builder.rs @@ -0,0 +1,194 @@ +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_image_model::RouterImageModel; +use crate::api::router_quality::RouterQuality; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_provider::RouterProvider; +use crate::client::generation_mode_mismatch_strategy::GenerationModeMismatchStrategy; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::artcraft::flux_1_dev::build::build_artcraft_flux_1_dev; +use crate::generate::generate_image::providers::artcraft::flux_1_schnell::build::build_artcraft_flux_1_schnell; +use crate::generate::generate_image::providers::artcraft::flux_2_lora_angles::build::build_artcraft_flux_2_lora_angles; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1::build::build_artcraft_flux_pro_1p1; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1_ultra::build::build_artcraft_flux_pro_1p1_ultra; +use crate::generate::generate_image::providers::artcraft::gpt_image_1::build::build_artcraft_gpt_image_1; +use crate::generate::generate_image::providers::artcraft::gpt_image_1p5::build::build_artcraft_gpt_image_1p5; +use crate::generate::generate_image::providers::artcraft::gpt_image_2::build::build_artcraft_gpt_image_2; +use crate::generate::generate_image::providers::artcraft::midjourney_7::build::build_artcraft_midjourney_7; +use crate::generate::generate_image::providers::artcraft::midjourney_7_niji::build::build_artcraft_midjourney_7_niji; +use crate::generate::generate_image::providers::artcraft::midjourney_8::build::build_artcraft_midjourney_8; +use crate::generate::generate_image::providers::artcraft::nano_banana::build::build_artcraft_nano_banana; +use crate::generate::generate_image::providers::artcraft::nano_banana_2::build::build_artcraft_nano_banana_2; +use crate::generate::generate_image::providers::artcraft::nano_banana_pro::build::build_artcraft_nano_banana_pro; +use crate::generate::generate_image::providers::artcraft::qwen_edit_2511_angles::build::build_artcraft_qwen_edit_2511_angles; +use crate::generate::generate_image::providers::artcraft::seedream_4::build::build_artcraft_seedream_4; +use crate::generate::generate_image::providers::artcraft::seedream_4p5::build::build_artcraft_seedream_4p5; +use crate::generate::generate_image::providers::artcraft::seedream_5_lite::build::build_artcraft_seedream_5_lite; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro::build::build_artcraft_seedream_5p0_pro; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro_ultra::build::build_artcraft_seedream_5p0_pro_ultra; +use crate::generate::generate_image::providers::fal::flux_1_dev::build::build_fal_flux_1_dev; +use crate::generate::generate_image::providers::fal::flux_1_schnell::build::build_fal_flux_1_schnell; +use crate::generate::generate_image::providers::fal::flux_2_lora_angles::build::build_fal_flux_2_lora_angles; +use crate::generate::generate_image::providers::fal::flux_pro_1p1::build::build_fal_flux_pro_1p1; +use crate::generate::generate_image::providers::fal::flux_pro_1p1_ultra::build::build_fal_flux_pro_1p1_ultra; +use crate::generate::generate_image::providers::fal::gpt_image_1::build::build_fal_gpt_image_1; +use crate::generate::generate_image::providers::fal::gpt_image_1p5::build::build_fal_gpt_image_1p5; +use crate::generate::generate_image::providers::fal::gpt_image_2::build::build_fal_gpt_image_2; +use crate::generate::generate_image::providers::fal::nano_banana::build::build_fal_nano_banana; +use crate::generate::generate_image::providers::fal::nano_banana_2::build::build_fal_nano_banana_2; +use crate::generate::generate_image::providers::fal::nano_banana_pro::build::build_fal_nano_banana_pro; +use crate::generate::generate_image::providers::fal::qwen_edit_2511_angles::build::build_fal_qwen_edit_2511_angles; +use crate::generate::generate_image::providers::fal::seedream_4::build::build_fal_seedream_4; +use crate::generate::generate_image::providers::fal::seedream_4p5::build::build_fal_seedream_4p5; +use crate::generate::generate_image::providers::fal::seedream_5_lite::build::build_fal_seedream_5_lite; +use crate::generate::generate_image::providers::kinovi::midjourney_7::build::build_kinovi_midjourney_7; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::build::build_kinovi_midjourney_7_niji; +use crate::generate::generate_image::providers::kinovi::midjourney_8::build::build_kinovi_midjourney_8; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::build::build_kinovi_seedream_5p0_pro; +use crate::generate::generate_image::providers::grok::grok_imagine_image::build::build_grok_imagine_image; +use crate::generate::generate_image::providers::higgsfield::gpt_image_2::build::build_higgsfield_gpt_image_2; +use crate::generate::generate_image::providers::higgsfield::nano_banana_2::build::build_higgsfield_nano_banana_2; +use crate::generate::generate_image::providers::higgsfield::nano_banana_2_lite::build::build_higgsfield_nano_banana_2_lite; +use crate::generate::generate_image::providers::higgsfield::nano_banana_pro::build::build_higgsfield_nano_banana_pro; +use crate::generate::generate_image::providers::higgsfield::seedream_4p5::build::build_higgsfield_seedream_4p5; +use crate::generate::generate_image::providers::higgsfield::seedream_5p0_lite::build::build_higgsfield_seedream_5p0_lite; +use crate::generate::generate_image::providers::higgsfield::seedream_5p0_pro::build::build_higgsfield_seedream_5p0_pro; +use crate::generate::generate_image::providers::midjourney::midjourney_8::build::build_midjourney_midjourney_8; + +#[derive(Clone, Debug)] +pub struct GenerateImageRequestBuilder { + /// Which model to use. + pub model: RouterImageModel, + + /// Which provider to use. + pub provider: RouterProvider, + + /// The prompt for the image generation. + pub prompt: Option, + + /// Input images for image editing. + /// If present, we're doing image editing (image-to-image). + /// If absent, we're doing text-to-image. + pub image_inputs: Option, + + /// The resolution to use. + pub resolution: Option, + + /// The aspect ratio to use. + pub aspect_ratio: Option, + + /// The quality level for generation. Not all models use this. + pub quality: Option, + + /// How many images to generate. + pub image_batch_count: Option, + + /// Only for angle manipulation models. + pub horizontal_angle: Option, + + /// Only for angle manipulation models. + pub vertical_angle: Option, + + /// Only for angle manipulation models. + pub zoom: Option, + + /// If the request is a mismatch with the (model/provider), how to mitigate it. + pub request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy, + + /// Controls behavior when `image_inputs` are supplied to a text-to-image-only model. + /// `None` is equivalent to `GenerateAnyway` — image inputs are silently ignored. + /// Set `AbortGeneration` to return an error instead. + pub generation_mode_mismatch_strategy: Option, + + /// Some providers support idempotency. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, +} + +impl GenerateImageRequestBuilder { + + /// Build an executable image generation request for the configured + /// (provider, model) pair. Returns either a directly-sendable `Request` + /// or a `Draft` that needs media-token resolution before sending. + /// + /// Named `build2` for historical reasons — this is the only build method + /// since v1 was removed. The name is preserved for consistency with + /// `GenerateVideoRequestBuilder::build2`. + pub fn build2(self) -> Result { + match (self.provider, self.model) { + (RouterProvider::Artcraft, RouterImageModel::Flux1Dev) => build_artcraft_flux_1_dev(self), + (RouterProvider::Artcraft, RouterImageModel::Flux1Schnell) => build_artcraft_flux_1_schnell(self), + (RouterProvider::Artcraft, RouterImageModel::FluxPro11) => build_artcraft_flux_pro_1p1(self), + (RouterProvider::Artcraft, RouterImageModel::FluxPro11Ultra) => build_artcraft_flux_pro_1p1_ultra(self), + (RouterProvider::Artcraft, RouterImageModel::GptImage1) => build_artcraft_gpt_image_1(self), + (RouterProvider::Artcraft, RouterImageModel::GptImage1p5) => build_artcraft_gpt_image_1p5(self), + (RouterProvider::Artcraft, RouterImageModel::GptImage2) => build_artcraft_gpt_image_2(self), + (RouterProvider::Artcraft, RouterImageModel::NanoBanana) => build_artcraft_nano_banana(self), + (RouterProvider::Artcraft, RouterImageModel::NanoBanana2) => build_artcraft_nano_banana_2(self), + (RouterProvider::Artcraft, RouterImageModel::NanoBananaPro) => build_artcraft_nano_banana_pro(self), + (RouterProvider::Artcraft, RouterImageModel::Seedream4) => build_artcraft_seedream_4(self), + (RouterProvider::Artcraft, RouterImageModel::Seedream4p5) => build_artcraft_seedream_4p5(self), + (RouterProvider::Artcraft, RouterImageModel::Seedream5Lite) => build_artcraft_seedream_5_lite(self), + (RouterProvider::Artcraft, RouterImageModel::Seedream5p0Pro) => build_artcraft_seedream_5p0_pro(self), + (RouterProvider::Artcraft, RouterImageModel::Seedream5p0ProUltra) => build_artcraft_seedream_5p0_pro_ultra(self), + (RouterProvider::Artcraft, RouterImageModel::QwenEdit2511Angles) => build_artcraft_qwen_edit_2511_angles(self), + (RouterProvider::Artcraft, RouterImageModel::Flux2LoraAngles) => build_artcraft_flux_2_lora_angles(self), + (RouterProvider::Artcraft, RouterImageModel::Midjourney7) => build_artcraft_midjourney_7(self), + (RouterProvider::Artcraft, RouterImageModel::Midjourney7Niji) => build_artcraft_midjourney_7_niji(self), + (RouterProvider::Artcraft, RouterImageModel::Midjourney8) => build_artcraft_midjourney_8(self), + + (RouterProvider::Fal, RouterImageModel::Flux1Dev) => build_fal_flux_1_dev(self), + (RouterProvider::Fal, RouterImageModel::Flux1Schnell) => build_fal_flux_1_schnell(self), + (RouterProvider::Fal, RouterImageModel::FluxPro11) => build_fal_flux_pro_1p1(self), + (RouterProvider::Fal, RouterImageModel::FluxPro11Ultra) => build_fal_flux_pro_1p1_ultra(self), + (RouterProvider::Fal, RouterImageModel::GptImage1) => build_fal_gpt_image_1(self), + (RouterProvider::Fal, RouterImageModel::GptImage1p5) => build_fal_gpt_image_1p5(self), + (RouterProvider::Fal, RouterImageModel::GptImage2) => build_fal_gpt_image_2(self), + (RouterProvider::Fal, RouterImageModel::NanoBanana) => build_fal_nano_banana(self), + (RouterProvider::Fal, RouterImageModel::NanoBanana2) => build_fal_nano_banana_2(self), + (RouterProvider::Fal, RouterImageModel::NanoBananaPro) => build_fal_nano_banana_pro(self), + (RouterProvider::Fal, RouterImageModel::Seedream4) => build_fal_seedream_4(self), + (RouterProvider::Fal, RouterImageModel::Seedream4p5) => build_fal_seedream_4p5(self), + (RouterProvider::Fal, RouterImageModel::Seedream5Lite) => build_fal_seedream_5_lite(self), + (RouterProvider::Fal, RouterImageModel::QwenEdit2511Angles) => build_fal_qwen_edit_2511_angles(self), + (RouterProvider::Fal, RouterImageModel::Flux2LoraAngles) => build_fal_flux_2_lora_angles(self), + + // Kinovi / Seedance2Pro (Midjourney + Seedream) + (RouterProvider::Seedance2Pro, RouterImageModel::Midjourney7) => build_kinovi_midjourney_7(self), + (RouterProvider::Seedance2Pro, RouterImageModel::Midjourney7Niji) => build_kinovi_midjourney_7_niji(self), + (RouterProvider::Seedance2Pro, RouterImageModel::Midjourney8) => build_kinovi_midjourney_8(self), + (RouterProvider::Seedance2Pro, RouterImageModel::Seedream5p0Pro) => build_kinovi_seedream_5p0_pro(self), + (RouterProvider::Seedance2Pro, RouterImageModel::Seedream5p0ProUltra) => build_kinovi_seedream_5p0_pro(self), + + // First-party (cookie-session) Midjourney. + (RouterProvider::Midjourney, RouterImageModel::Midjourney8) => build_midjourney_midjourney_8(self), + + // First-party (cookie-session) Grok Imagine. Fast vs quality ("pro") mode. + (RouterProvider::Grok, RouterImageModel::GrokImagineImage) => build_grok_imagine_image(self, false), + (RouterProvider::Grok, RouterImageModel::GrokImagineImageQuality) => build_grok_imagine_image(self, true), + // First-party (cookie-session) Higgsfield. + (RouterProvider::Higgsfield, RouterImageModel::NanoBananaPro) => build_higgsfield_nano_banana_pro(self), + (RouterProvider::Higgsfield, RouterImageModel::NanoBanana2) => build_higgsfield_nano_banana_2(self), + (RouterProvider::Higgsfield, RouterImageModel::NanoBanana2Lite) => build_higgsfield_nano_banana_2_lite(self), + (RouterProvider::Higgsfield, RouterImageModel::GptImage2) => build_higgsfield_gpt_image_2(self), + (RouterProvider::Higgsfield, RouterImageModel::Seedream5p0Pro) => build_higgsfield_seedream_5p0_pro(self), + (RouterProvider::Higgsfield, RouterImageModel::Seedream5Lite) => build_higgsfield_seedream_5p0_lite(self), + (RouterProvider::Higgsfield, RouterImageModel::Seedream4p5) => build_higgsfield_seedream_4p5(self), + + _ => self.unsupported_provider_and_model(), + } + } + + fn unsupported_provider_and_model(&self) -> Result { + Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + format!("Image generation for model `{:?}` is not supported for provider {:?}", self.model, self.provider) + )) + } + + pub fn get_or_generate_idempotency_token(&self) -> String { + self.idempotency_token.clone() + .unwrap_or_else(|| uuid::Uuid::new_v4().to_string()) + } +} diff --git a/crates/router/src/generate/generate_image/generate_image_response.rs b/crates/router/src/generate/generate_image/generate_image_response.rs new file mode 100644 index 00000000..a584de82 --- /dev/null +++ b/crates/router/src/generate/generate_image/generate_image_response.rs @@ -0,0 +1,126 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use artcraft_client::tokens::generic_inference_jobs::InferenceJobToken; + +#[derive(Clone, Debug)] +pub struct ArtcraftImageResponsePayload { + pub inference_job_token: InferenceJobToken, +} + +#[derive(Clone, Debug)] +pub struct FalImageResponsePayload { + pub request_id: Option, + pub gateway_request_id: Option, + + /// The queue status URL (for polling job progress). + pub maybe_status_url: Option, + + /// The queue response URL (for fetching completed results). + pub maybe_response_url: Option, + + /// The outbound request that was sent to Fal. + /// Stored as a trait object so any Request type can be captured. + /// Use `format!("{:?}", ...)` or `format!("{:#?}", ...)` to print. + pub maybe_outbound_request: Option>, +} + +/// Response from the Seedance2Pro/Kinovi provider (used for Midjourney +/// image generation). Mirrors `Seedance2proVideoResponsePayload` on the +/// video side. +#[derive(Clone, Debug)] +pub struct Seedance2proImageResponsePayload { + pub order_id: String, + pub task_id: String, + pub maybe_order_ids: Option>, + pub maybe_task_ids: Option>, +} + +/// Response from the first-party (cookie-session) Midjourney provider. The +/// `job_id` is Midjourney's own job id, used as the task `provider_job_id` and +/// as the websocket `subscribe_to_job` key. +#[derive(Clone, Debug)] +pub struct MidjourneyImageResponsePayload { + pub job_id: String, +} + +/// Response from the first-party (cookie-session) Grok Imagine provider. The +/// prompt was sent on the account's imagine websocket; every resulting frame +/// (progress, finished images, errors) carries this request id, which the +/// caller's polling thread keys results on. +#[derive(Clone, Debug)] +pub struct GrokImageResponsePayload { + pub request_id: String, +} + +/// Response from the first-party (cookie-session) Higgsfield provider. One +/// enqueue creates a job set with one job per requested image; the caller +/// polls the jobs (`HiggsfieldSession::job_status_batch`) by id. +#[derive(Clone, Debug)] +pub struct HiggsfieldImageResponsePayload { + pub job_set_id: String, + /// In generation order; never empty. + pub job_ids: Vec, +} + +impl HiggsfieldImageResponsePayload { + /// The first job, which stands in for the whole set as the task's + /// `provider_job_id`. + pub fn primary_job_id(&self) -> &str { + &self.job_ids[0] + } +} + +#[derive(Clone, Debug)] +pub enum GenerateImageResponse { + Artcraft(ArtcraftImageResponsePayload), + Fal(FalImageResponsePayload), + Grok(GrokImageResponsePayload), + Higgsfield(HiggsfieldImageResponsePayload), + Midjourney(MidjourneyImageResponsePayload), + Seedance2Pro(Seedance2proImageResponsePayload), +} + +impl GenerateImageResponse { + pub fn get_artcraft_payload(&self) -> Option { + match self { + Self::Artcraft(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_fal_payload(&self) -> Option { + match self { + Self::Fal(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_grok_payload(&self) -> Option { + match self { + Self::Grok(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_higgsfield_payload(&self) -> Option { + match self { + Self::Higgsfield(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_midjourney_payload(&self) -> Option { + match self { + Self::Midjourney(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_seedance2pro_payload(&self) -> Option { + match self { + Self::Seedance2Pro(p) => Some(p.clone()), + _ => None, + } + } +} diff --git a/crates/router/src/generate/generate_image/image_generation_cost_estimate.rs b/crates/router/src/generate/generate_image/image_generation_cost_estimate.rs new file mode 100644 index 00000000..0c6ea35e --- /dev/null +++ b/crates/router/src/generate/generate_image/image_generation_cost_estimate.rs @@ -0,0 +1,16 @@ +/// The result of estimating the cost of an image generation plan. +#[derive(Clone, Debug)] +pub struct ImageGenerationCostEstimate { + pub cost_in_credits: Option, + pub cost_in_usd_cents: Option, + pub is_free: bool, + pub is_unlimited: bool, + pub is_rate_limited: bool, + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/router/src/generate/generate_image/image_generation_draft.rs b/crates/router/src/generate/generate_image/image_generation_draft.rs new file mode 100644 index 00000000..7f22a078 --- /dev/null +++ b/crates/router/src/generate/generate_image/image_generation_draft.rs @@ -0,0 +1,79 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::higgsfield::cost::HiggsfieldImageCostState; +use crate::generate::generate_image::providers::higgsfield::draft::HiggsfieldImageDraftState; +use crate::generate::generate_image::providers::kinovi::midjourney_7::cost::KinoviMidjourney7CostState; +use crate::generate::generate_image::providers::kinovi::midjourney_7::draft::KinoviMidjourney7DraftState; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::cost::KinoviMidjourney7NijiCostState; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::draft::KinoviMidjourney7NijiDraftState; +use crate::generate::generate_image::providers::kinovi::midjourney_8::cost::KinoviMidjourney8CostState; +use crate::generate::generate_image::providers::kinovi::midjourney_8::draft::KinoviMidjourney8DraftState; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::cost::KinoviSeedream5p0ProCostState; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::draft::KinoviSeedream5p0ProDraftState; + +/// Wrapper for all image generation draft requests. +/// +/// Drafts hold validated/planned parameters but may still need media +/// resolution (e.g. uploading local files to a provider) before they can +/// be sent. The Kinovi models need this (reference images are uploaded to +/// the Seedance2Pro CDN first), and so does first-party Higgsfield +/// (reference images become Higgsfield media ids). +#[derive(Clone, Debug)] +pub enum ImageGenerationDraftRequest { + KinoviMidjourney7(KinoviMidjourney7DraftState), + KinoviMidjourney7Niji(KinoviMidjourney7NijiDraftState), + KinoviMidjourney8(KinoviMidjourney8DraftState), + KinoviSeedream5p0Pro(KinoviSeedream5p0ProDraftState), + /// Any Higgsfield image model (the state says which). + HiggsfieldImage(HiggsfieldImageDraftState), +} + +impl ImageGenerationDraftRequest { + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::KinoviMidjourney7(_) => RouterProvider::Seedance2Pro, + Self::KinoviMidjourney7Niji(_) => RouterProvider::Seedance2Pro, + Self::KinoviMidjourney8(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedream5p0Pro(_) => RouterProvider::Seedance2Pro, + Self::HiggsfieldImage(_) => RouterProvider::Higgsfield, + } + } + + pub fn estimate_cost(&self) -> Result { + match self { + Self::KinoviMidjourney7(draft) => Ok(KinoviMidjourney7CostState::from_draft(draft).estimate_cost()), + Self::KinoviMidjourney7Niji(draft) => Ok(KinoviMidjourney7NijiCostState::from_draft(draft).estimate_cost()), + Self::KinoviMidjourney8(draft) => Ok(KinoviMidjourney8CostState::from_draft(draft).estimate_cost()), + Self::KinoviSeedream5p0Pro(draft) => Ok(KinoviSeedream5p0ProCostState::from_draft(draft).estimate_cost()), + Self::HiggsfieldImage(draft) => Ok(HiggsfieldImageCostState::from_draft(draft).estimate_cost()), + } + } + + pub async fn finalize(self, draft_context: ImageGenerationDraftContext<'_>) -> Result { + match self { + Self::KinoviMidjourney7(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(ImageGenerationRequest::KinoviMidjourney7(result)) + } + Self::KinoviMidjourney7Niji(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(ImageGenerationRequest::KinoviMidjourney7Niji(result)) + } + Self::KinoviMidjourney8(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(ImageGenerationRequest::KinoviMidjourney8(result)) + } + Self::KinoviSeedream5p0Pro(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(ImageGenerationRequest::KinoviSeedream5p0Pro(result)) + } + Self::HiggsfieldImage(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(ImageGenerationRequest::HiggsfieldImage(result)) + } + } + } +} diff --git a/crates/router/src/generate/generate_image/image_generation_draft_context.rs b/crates/router/src/generate/generate_image/image_generation_draft_context.rs new file mode 100644 index 00000000..92704583 --- /dev/null +++ b/crates/router/src/generate/generate_image/image_generation_draft_context.rs @@ -0,0 +1,66 @@ +use std::collections::HashMap; +use std::fmt::Debug; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::asset_upload_cache::AssetUploadCache; +use crate::api::asset_upload_observer::AssetUploadObserver; +use crate::client::router_client::RouterClient; +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +/// Context passed when finalizing an image draft into a concrete request. +/// +/// Drafts only exist for providers that need to upload assets before +/// sending the request: the Seedance2Pro/Kinovi pipeline (used for +/// Midjourney image generation with reference images) and first-party +/// Higgsfield (reference images become Higgsfield media ids); other +/// providers — Artcraft, Fal — accept image URLs directly and skip the +/// draft phase entirely. +#[derive(Clone, Default)] +pub struct ImageGenerationDraftContext<'a> { + /// Optional: the router client, needed for providers that require + /// authenticated calls (e.g. Seedance2Pro/Kinovi uploads). + pub client: Option<&'a RouterClient>, + + /// Optional: a map of Media File Tokens to their ArtCraft URLs. + /// Required only when the draft has unresolved `MediaFileToken` image + /// inputs that must be downloaded from ArtCraft and re-uploaded to the + /// target provider's CDN. + pub media_file_to_artcraft_url_map: Option<&'a HashMap>, + + /// Optional: the account's upload history on the target provider, so + /// media it already holds isn't uploaded again. + pub asset_upload_cache: Option<&'a dyn AssetUploadCache>, + + /// Optional: told whether each reference was reused or uploaded, so the + /// caller can show the right notice. + pub asset_upload_observer: Option<&'a dyn AssetUploadObserver>, +} + +impl<'a> ImageGenerationDraftContext<'a> { + pub fn get_seedance2pro_client_ref(&self) -> Result<&RouterSeedance2ProClient, ArtcraftRouterError> { + let client = self.client.ok_or(ArtcraftRouterError::Client(ClientError::RouterClientNotProvided))?; + client.get_seedance2pro_client_ref() + .map_err(ArtcraftRouterError::Client) + } + + pub fn get_higgsfield_client_ref(&self) -> Result<&RouterHiggsfieldClient, ArtcraftRouterError> { + let client = self.client.ok_or(ArtcraftRouterError::Client(ClientError::RouterClientNotProvided))?; + client.get_higgsfield_client_ref() + .map_err(ArtcraftRouterError::Client) + } +} + +impl Debug for ImageGenerationDraftContext<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("ImageGenerationDraftContext") + .field("client", &self.client.is_some()) + .field("media_file_to_artcraft_url_map", &self.media_file_to_artcraft_url_map.map(|m| m.len())) + .field("asset_upload_cache", &self.asset_upload_cache.is_some()) + .field("asset_upload_observer", &self.asset_upload_observer.is_some()) + .finish() + } +} diff --git a/crates/router/src/generate/generate_image/image_generation_draft_or_request.rs b/crates/router/src/generate/generate_image/image_generation_draft_or_request.rs new file mode 100644 index 00000000..40c76967 --- /dev/null +++ b/crates/router/src/generate/generate_image/image_generation_draft_or_request.rs @@ -0,0 +1,27 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + +#[derive(Debug, Clone)] +pub enum ImageGenerationDraftOrRequest { + Draft(ImageGenerationDraftRequest), + Request(ImageGenerationRequest), +} + +impl ImageGenerationDraftOrRequest { + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::Draft(draft) => draft.get_provider(), + Self::Request(request) => request.get_provider(), + } + } + + pub fn estimate_cost(&self) -> Result { + match self { + Self::Draft(draft) => draft.estimate_cost(), + Self::Request(request) => request.estimate_cost(), + } + } +} diff --git a/crates/router/src/generate/generate_image/image_generation_request.rs b/crates/router/src/generate/generate_image/image_generation_request.rs new file mode 100644 index 00000000..d0b839e0 --- /dev/null +++ b/crates/router/src/generate/generate_image/image_generation_request.rs @@ -0,0 +1,486 @@ +use crate::api::router_provider::RouterProvider; +use crate::client::router_client::RouterClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::flux_1_dev::cost::ArtcraftFlux1DevCostState; +use crate::generate::generate_image::providers::artcraft::flux_1_dev::request::ArtcraftFlux1DevRequestState; +use crate::generate::generate_image::providers::artcraft::flux_1_schnell::cost::ArtcraftFlux1SchnellCostState; +use crate::generate::generate_image::providers::artcraft::flux_1_schnell::request::ArtcraftFlux1SchnellRequestState; +use crate::generate::generate_image::providers::artcraft::flux_2_lora_angles::cost::ArtcraftFlux2LoraAnglesCostState; +use crate::generate::generate_image::providers::artcraft::flux_2_lora_angles::request::ArtcraftFlux2LoraAnglesRequestState; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1::cost::ArtcraftFluxPro1p1CostState; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1::request::ArtcraftFluxPro1p1RequestState; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1_ultra::cost::ArtcraftFluxPro1p1UltraCostState; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1_ultra::request::ArtcraftFluxPro1p1UltraRequestState; +use crate::generate::generate_image::providers::artcraft::gpt_image_1::cost::ArtcraftGptImage1CostState; +use crate::generate::generate_image::providers::artcraft::gpt_image_1::request::ArtcraftGptImage1RequestState; +use crate::generate::generate_image::providers::artcraft::gpt_image_1p5::cost::ArtcraftGptImage1p5CostState; +use crate::generate::generate_image::providers::artcraft::gpt_image_1p5::request::ArtcraftGptImage1p5RequestState; +use crate::generate::generate_image::providers::artcraft::gpt_image_2::cost::ArtcraftGptImage2CostState; +use crate::generate::generate_image::providers::artcraft::gpt_image_2::request::ArtcraftGptImage2RequestState; +use crate::generate::generate_image::providers::artcraft::midjourney_7::cost::ArtcraftMidjourney7CostState; +use crate::generate::generate_image::providers::artcraft::midjourney_7::request::ArtcraftMidjourney7RequestState; +use crate::generate::generate_image::providers::artcraft::midjourney_7_niji::cost::ArtcraftMidjourney7NijiCostState; +use crate::generate::generate_image::providers::artcraft::midjourney_7_niji::request::ArtcraftMidjourney7NijiRequestState; +use crate::generate::generate_image::providers::artcraft::midjourney_8::cost::ArtcraftMidjourney8CostState; +use crate::generate::generate_image::providers::artcraft::midjourney_8::request::ArtcraftMidjourney8RequestState; +use crate::generate::generate_image::providers::artcraft::nano_banana::cost::ArtcraftNanoBananaCostState; +use crate::generate::generate_image::providers::artcraft::nano_banana::request::ArtcraftNanoBananaRequestState; +use crate::generate::generate_image::providers::artcraft::nano_banana_2::cost::ArtcraftNanoBanana2CostState; +use crate::generate::generate_image::providers::artcraft::nano_banana_2::request::ArtcraftNanoBanana2RequestState; +use crate::generate::generate_image::providers::artcraft::nano_banana_pro::cost::ArtcraftNanoBananaProCostState; +use crate::generate::generate_image::providers::artcraft::nano_banana_pro::request::ArtcraftNanoBananaProRequestState; +use crate::generate::generate_image::providers::artcraft::qwen_edit_2511_angles::cost::ArtcraftQwenEdit2511AnglesCostState; +use crate::generate::generate_image::providers::artcraft::qwen_edit_2511_angles::request::ArtcraftQwenEdit2511AnglesRequestState; +use crate::generate::generate_image::providers::artcraft::seedream_4::cost::ArtcraftSeedream4CostState; +use crate::generate::generate_image::providers::artcraft::seedream_4::request::ArtcraftSeedream4RequestState; +use crate::generate::generate_image::providers::artcraft::seedream_4p5::cost::ArtcraftSeedream4p5CostState; +use crate::generate::generate_image::providers::artcraft::seedream_4p5::request::ArtcraftSeedream4p5RequestState; +use crate::generate::generate_image::providers::artcraft::seedream_5_lite::cost::ArtcraftSeedream5LiteCostState; +use crate::generate::generate_image::providers::artcraft::seedream_5_lite::request::ArtcraftSeedream5LiteRequestState; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro::cost::ArtcraftSeedream5p0ProCostState; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro::request::ArtcraftSeedream5p0ProRequestState; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro_ultra::cost::ArtcraftSeedream5p0ProUltraCostState; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro_ultra::request::ArtcraftSeedream5p0ProUltraRequestState; +use crate::generate::generate_image::providers::fal::flux_1_dev::cost::FalFlux1DevCostState; +use crate::generate::generate_image::providers::fal::flux_1_dev::request::FalFlux1DevRequestState; +use crate::generate::generate_image::providers::fal::flux_1_schnell::cost::FalFlux1SchnellCostState; +use crate::generate::generate_image::providers::fal::flux_1_schnell::request::FalFlux1SchnellRequestState; +use crate::generate::generate_image::providers::fal::flux_2_lora_angles::cost::FalFlux2LoraAnglesCostState; +use crate::generate::generate_image::providers::fal::flux_2_lora_angles::request::FalFlux2LoraAnglesRequestState; +use crate::generate::generate_image::providers::fal::flux_pro_1p1::cost::FalFluxPro1p1CostState; +use crate::generate::generate_image::providers::fal::flux_pro_1p1::request::FalFluxPro1p1RequestState; +use crate::generate::generate_image::providers::fal::flux_pro_1p1_ultra::cost::FalFluxPro1p1UltraCostState; +use crate::generate::generate_image::providers::fal::flux_pro_1p1_ultra::request::FalFluxPro1p1UltraRequestState; +use crate::generate::generate_image::providers::fal::gpt_image_1::cost::FalGptImage1CostState; +use crate::generate::generate_image::providers::fal::gpt_image_1::request::FalGptImage1RequestState; +use crate::generate::generate_image::providers::fal::gpt_image_1p5::cost::FalGptImage1p5CostState; +use crate::generate::generate_image::providers::fal::gpt_image_1p5::request::FalGptImage1p5RequestState; +use crate::generate::generate_image::providers::fal::gpt_image_2::cost::FalGptImage2CostState; +use crate::generate::generate_image::providers::fal::gpt_image_2::request::FalGptImage2RequestState; +use crate::generate::generate_image::providers::fal::nano_banana::cost::FalNanoBananaCostState; +use crate::generate::generate_image::providers::fal::nano_banana::request::FalNanoBananaRequestState; +use crate::generate::generate_image::providers::fal::nano_banana_2::cost::FalNanoBanana2CostState; +use crate::generate::generate_image::providers::fal::nano_banana_2::request::FalNanoBanana2RequestState; +use crate::generate::generate_image::providers::fal::nano_banana_pro::cost::FalNanoBananaProCostState; +use crate::generate::generate_image::providers::fal::nano_banana_pro::request::FalNanoBananaProRequestState; +use crate::generate::generate_image::providers::fal::qwen_edit_2511_angles::cost::FalQwenEdit2511AnglesCostState; +use crate::generate::generate_image::providers::fal::qwen_edit_2511_angles::request::FalQwenEdit2511AnglesRequestState; +use crate::generate::generate_image::providers::fal::seedream_4::cost::FalSeedream4CostState; +use crate::generate::generate_image::providers::fal::seedream_4::request::FalSeedream4RequestState; +use crate::generate::generate_image::providers::fal::seedream_4p5::cost::FalSeedream4p5CostState; +use crate::generate::generate_image::providers::fal::seedream_4p5::request::FalSeedream4p5RequestState; +use crate::generate::generate_image::providers::fal::seedream_5_lite::cost::FalSeedream5LiteCostState; +use crate::generate::generate_image::providers::fal::seedream_5_lite::request::FalSeedream5LiteRequestState; +use crate::generate::generate_image::providers::grok::grok_imagine_image::cost::GrokImagineImageCostState; +use crate::generate::generate_image::providers::grok::grok_imagine_image::request::GrokImagineImageRequestState; +use crate::generate::generate_image::providers::higgsfield::cost::HiggsfieldImageCostState; +use crate::generate::generate_image::providers::higgsfield::request::HiggsfieldImageRequestState; +use crate::generate::generate_image::providers::kinovi::midjourney_7::cost::KinoviMidjourney7CostState; +use crate::generate::generate_image::providers::kinovi::midjourney_7::request::KinoviMidjourney7RequestState; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::cost::KinoviMidjourney7NijiCostState; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::request::KinoviMidjourney7NijiRequestState; +use crate::generate::generate_image::providers::kinovi::midjourney_8::cost::KinoviMidjourney8CostState; +use crate::generate::generate_image::providers::kinovi::midjourney_8::request::KinoviMidjourney8RequestState; +use crate::generate::generate_image::providers::midjourney::midjourney_8::cost::MidjourneyMidjourney8CostState; +use crate::generate::generate_image::providers::midjourney::midjourney_8::request::MidjourneyMidjourney8RequestState; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::cost::KinoviSeedream5p0ProCostState; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::request::KinoviSeedream5p0ProRequestState; + +#[derive(Clone, Debug)] +pub enum ImageGenerationRequest { + // ── Artcraft provider (omni-gen image endpoint) ── + ArtcraftFlux1Dev(ArtcraftFlux1DevRequestState), + ArtcraftFlux1Schnell(ArtcraftFlux1SchnellRequestState), + ArtcraftFluxPro1p1(ArtcraftFluxPro1p1RequestState), + ArtcraftFluxPro1p1Ultra(ArtcraftFluxPro1p1UltraRequestState), + ArtcraftGptImage1(ArtcraftGptImage1RequestState), + ArtcraftGptImage1p5(ArtcraftGptImage1p5RequestState), + ArtcraftGptImage2(ArtcraftGptImage2RequestState), + ArtcraftNanoBanana(ArtcraftNanoBananaRequestState), + ArtcraftNanoBanana2(ArtcraftNanoBanana2RequestState), + ArtcraftNanoBananaPro(ArtcraftNanoBananaProRequestState), + ArtcraftSeedream4(ArtcraftSeedream4RequestState), + ArtcraftSeedream4p5(ArtcraftSeedream4p5RequestState), + ArtcraftSeedream5Lite(ArtcraftSeedream5LiteRequestState), + ArtcraftSeedream5p0Pro(ArtcraftSeedream5p0ProRequestState), + ArtcraftSeedream5p0ProUltra(ArtcraftSeedream5p0ProUltraRequestState), + ArtcraftQwenEdit2511Angles(ArtcraftQwenEdit2511AnglesRequestState), + ArtcraftFlux2LoraAngles(ArtcraftFlux2LoraAnglesRequestState), + ArtcraftMidjourney7(ArtcraftMidjourney7RequestState), + ArtcraftMidjourney7Niji(ArtcraftMidjourney7NijiRequestState), + ArtcraftMidjourney8(ArtcraftMidjourney8RequestState), + + // ── Fal provider ── + FalFlux1Dev(FalFlux1DevRequestState), + FalFlux1Schnell(FalFlux1SchnellRequestState), + FalFluxPro1p1(FalFluxPro1p1RequestState), + FalFluxPro1p1Ultra(FalFluxPro1p1UltraRequestState), + FalGptImage1(FalGptImage1RequestState), + FalGptImage1p5(FalGptImage1p5RequestState), + FalGptImage2(FalGptImage2RequestState), + FalNanoBanana(FalNanoBananaRequestState), + FalNanoBanana2(FalNanoBanana2RequestState), + FalNanoBananaPro(FalNanoBananaProRequestState), + FalSeedream4(FalSeedream4RequestState), + FalSeedream4p5(FalSeedream4p5RequestState), + FalSeedream5Lite(FalSeedream5LiteRequestState), + FalQwenEdit2511Angles(FalQwenEdit2511AnglesRequestState), + FalFlux2LoraAngles(FalFlux2LoraAnglesRequestState), + + // ── Kinovi / Seedance2Pro provider (Midjourney + Seedream image generation) ── + KinoviMidjourney7(KinoviMidjourney7RequestState), + KinoviMidjourney7Niji(KinoviMidjourney7NijiRequestState), + KinoviMidjourney8(KinoviMidjourney8RequestState), + KinoviSeedream5p0Pro(KinoviSeedream5p0ProRequestState), + + // ── First-party (cookie-session) Midjourney provider ── + MidjourneyMidjourney8(MidjourneyMidjourney8RequestState), + + // ── First-party (cookie-session) Grok Imagine provider ── + GrokImagineImage(GrokImagineImageRequestState), + // ── First-party (cookie-session) Higgsfield provider (any of its models) ── + HiggsfieldImage(HiggsfieldImageRequestState), +} + +impl ImageGenerationRequest { + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::ArtcraftFlux1Dev(_) => RouterProvider::Artcraft, + Self::ArtcraftFlux1Schnell(_) => RouterProvider::Artcraft, + Self::ArtcraftFluxPro1p1(_) => RouterProvider::Artcraft, + Self::ArtcraftFluxPro1p1Ultra(_) => RouterProvider::Artcraft, + Self::ArtcraftGptImage1(_) => RouterProvider::Artcraft, + Self::ArtcraftGptImage1p5(_) => RouterProvider::Artcraft, + Self::ArtcraftGptImage2(_) => RouterProvider::Artcraft, + Self::ArtcraftNanoBanana(_) => RouterProvider::Artcraft, + Self::ArtcraftNanoBanana2(_) => RouterProvider::Artcraft, + Self::ArtcraftNanoBananaPro(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedream4(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedream4p5(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedream5Lite(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedream5p0Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedream5p0ProUltra(_) => RouterProvider::Artcraft, + Self::ArtcraftQwenEdit2511Angles(_) => RouterProvider::Artcraft, + Self::ArtcraftFlux2LoraAngles(_) => RouterProvider::Artcraft, + Self::ArtcraftMidjourney7(_) => RouterProvider::Artcraft, + Self::ArtcraftMidjourney7Niji(_) => RouterProvider::Artcraft, + Self::ArtcraftMidjourney8(_) => RouterProvider::Artcraft, + + Self::FalFlux1Dev(_) => RouterProvider::Fal, + Self::FalFlux1Schnell(_) => RouterProvider::Fal, + Self::FalFluxPro1p1(_) => RouterProvider::Fal, + Self::FalFluxPro1p1Ultra(_) => RouterProvider::Fal, + Self::FalGptImage1(_) => RouterProvider::Fal, + Self::FalGptImage1p5(_) => RouterProvider::Fal, + Self::FalGptImage2(_) => RouterProvider::Fal, + Self::FalNanoBanana(_) => RouterProvider::Fal, + Self::FalNanoBanana2(_) => RouterProvider::Fal, + Self::FalNanoBananaPro(_) => RouterProvider::Fal, + Self::FalSeedream4(_) => RouterProvider::Fal, + Self::FalSeedream4p5(_) => RouterProvider::Fal, + Self::FalSeedream5Lite(_) => RouterProvider::Fal, + Self::FalQwenEdit2511Angles(_) => RouterProvider::Fal, + Self::FalFlux2LoraAngles(_) => RouterProvider::Fal, + + Self::KinoviMidjourney7(_) => RouterProvider::Seedance2Pro, + Self::KinoviMidjourney7Niji(_) => RouterProvider::Seedance2Pro, + Self::KinoviMidjourney8(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedream5p0Pro(_) => RouterProvider::Seedance2Pro, + + Self::MidjourneyMidjourney8(_) => RouterProvider::Midjourney, + + Self::GrokImagineImage(_) => RouterProvider::Grok, + Self::HiggsfieldImage(_) => RouterProvider::Higgsfield, + } + } + + pub fn estimate_cost(&self) -> Result { + match self { + // ── Artcraft ── + Self::ArtcraftFlux1Dev(request) => { + Ok(ArtcraftFlux1DevCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftFlux1Schnell(request) => { + Ok(ArtcraftFlux1SchnellCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftFluxPro1p1(request) => { + Ok(ArtcraftFluxPro1p1CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftFluxPro1p1Ultra(request) => { + Ok(ArtcraftFluxPro1p1UltraCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftGptImage1(request) => { + Ok(ArtcraftGptImage1CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftGptImage1p5(request) => { + Ok(ArtcraftGptImage1p5CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftGptImage2(request) => { + Ok(ArtcraftGptImage2CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftNanoBanana(request) => { + Ok(ArtcraftNanoBananaCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftNanoBanana2(request) => { + Ok(ArtcraftNanoBanana2CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftNanoBananaPro(request) => { + Ok(ArtcraftNanoBananaProCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftSeedream4(request) => { + Ok(ArtcraftSeedream4CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftSeedream4p5(request) => { + Ok(ArtcraftSeedream4p5CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftSeedream5Lite(request) => { + Ok(ArtcraftSeedream5LiteCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftSeedream5p0Pro(request) => { + Ok(ArtcraftSeedream5p0ProCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftSeedream5p0ProUltra(request) => { + Ok(ArtcraftSeedream5p0ProUltraCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftQwenEdit2511Angles(request) => { + Ok(ArtcraftQwenEdit2511AnglesCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftFlux2LoraAngles(request) => { + Ok(ArtcraftFlux2LoraAnglesCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftMidjourney7(request) => { + Ok(ArtcraftMidjourney7CostState::from_request(request).estimate_cost()) + } + Self::ArtcraftMidjourney7Niji(request) => { + Ok(ArtcraftMidjourney7NijiCostState::from_request(request).estimate_cost()) + } + Self::ArtcraftMidjourney8(request) => { + Ok(ArtcraftMidjourney8CostState::from_request(request).estimate_cost()) + } + + // ── Fal ── + Self::FalFlux1Dev(request) => Ok(FalFlux1DevCostState::from_request(request).estimate_cost()), + Self::FalFlux1Schnell(request) => Ok(FalFlux1SchnellCostState::from_request(request).estimate_cost()), + Self::FalFluxPro1p1(request) => Ok(FalFluxPro1p1CostState::from_request(request).estimate_cost()), + Self::FalFluxPro1p1Ultra(request) => Ok(FalFluxPro1p1UltraCostState::from_request(request).estimate_cost()), + Self::FalGptImage1(request) => Ok(FalGptImage1CostState::from_request(request).estimate_cost()), + Self::FalGptImage1p5(request) => Ok(FalGptImage1p5CostState::from_request(request).estimate_cost()), + Self::FalGptImage2(request) => Ok(FalGptImage2CostState::from_request(request).estimate_cost()), + Self::FalNanoBanana(request) => Ok(FalNanoBananaCostState::from_request(request).estimate_cost()), + Self::FalNanoBanana2(request) => Ok(FalNanoBanana2CostState::from_request(request).estimate_cost()), + Self::FalNanoBananaPro(request) => Ok(FalNanoBananaProCostState::from_request(request).estimate_cost()), + Self::FalSeedream4(request) => Ok(FalSeedream4CostState::from_request(request).estimate_cost()), + Self::FalSeedream4p5(request) => Ok(FalSeedream4p5CostState::from_request(request).estimate_cost()), + Self::FalSeedream5Lite(request) => Ok(FalSeedream5LiteCostState::from_request(request).estimate_cost()), + Self::FalQwenEdit2511Angles(request) => Ok(FalQwenEdit2511AnglesCostState::from_request(request).estimate_cost()), + Self::FalFlux2LoraAngles(request) => Ok(FalFlux2LoraAnglesCostState::from_request(request).estimate_cost()), + + Self::KinoviMidjourney7(request) => Ok(KinoviMidjourney7CostState::from_request(request).estimate_cost()), + Self::KinoviMidjourney7Niji(request) => Ok(KinoviMidjourney7NijiCostState::from_request(request).estimate_cost()), + Self::KinoviMidjourney8(request) => Ok(KinoviMidjourney8CostState::from_request(request).estimate_cost()), + Self::KinoviSeedream5p0Pro(request) => Ok(KinoviSeedream5p0ProCostState::from_request(request).estimate_cost()), + + Self::MidjourneyMidjourney8(request) => Ok(MidjourneyMidjourney8CostState::from_request(request).estimate_cost()), + + Self::GrokImagineImage(request) => Ok(GrokImagineImageCostState::from_request(request).estimate_cost()), + Self::HiggsfieldImage(request) => Ok(HiggsfieldImageCostState::from_request(request).estimate_cost()), + } + } + + pub async fn send_request(&self, client: &RouterClient) -> Result { + match self { + // ── Artcraft (omni-gen image endpoint) ── + Self::ArtcraftFlux1Dev(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftFlux1Schnell(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftFluxPro1p1(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftFluxPro1p1Ultra(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftGptImage1(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftGptImage1p5(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftGptImage2(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftNanoBanana(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftNanoBanana2(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftNanoBananaPro(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftSeedream4(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftSeedream4p5(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftSeedream5Lite(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftSeedream5p0Pro(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftSeedream5p0ProUltra(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftQwenEdit2511Angles(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftFlux2LoraAngles(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftMidjourney7(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftMidjourney7Niji(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + Self::ArtcraftMidjourney8(request) => { + let artcraft_client = client.get_artcraft_client_ref()?; + request.send(artcraft_client).await + } + + // ── Fal ── + Self::FalFlux1Dev(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalFlux1Schnell(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalFluxPro1p1(request) => { + // Flux Pro 1.1 is webhook-required — uses the webhook-only RouterFalClient. + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalFluxPro1p1Ultra(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalGptImage1(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalGptImage1p5(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalGptImage2(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalNanoBanana(request) => { + // nano_banana (Gemini 2.5 Flash) is webhook-required. + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalNanoBanana2(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalNanoBananaPro(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalSeedream4(request) => { + // Seedream v4 is webhook-required. + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalSeedream4p5(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalSeedream5Lite(request) => { + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalQwenEdit2511Angles(request) => { + // Webhook-required endpoint. + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + Self::FalFlux2LoraAngles(request) => { + // Webhook-required endpoint. + let fal_client = client.get_fal_client_ref()?; + request.send(fal_client).await + } + + // ── Kinovi / Seedance2Pro (Midjourney + Seedream) ── + Self::KinoviMidjourney7(request) => { + let seedance_client = client.get_seedance2pro_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(seedance_client).await + } + Self::KinoviMidjourney7Niji(request) => { + let seedance_client = client.get_seedance2pro_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(seedance_client).await + } + Self::KinoviMidjourney8(request) => { + let seedance_client = client.get_seedance2pro_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(seedance_client).await + } + Self::KinoviSeedream5p0Pro(request) => { + let seedance_client = client.get_seedance2pro_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(seedance_client).await + } + + // ── First-party (cookie-session) Midjourney ── + Self::MidjourneyMidjourney8(request) => { + let midjourney_client = client.get_midjourney_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(midjourney_client).await + } + + // ── First-party (cookie-session) Grok Imagine ── + Self::GrokImagineImage(request) => { + let grok_client = client.get_grok_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(grok_client).await + } + // ── First-party (cookie-session) Higgsfield ── + Self::HiggsfieldImage(request) => { + let higgsfield_client = client.get_higgsfield_client_ref() + .map_err(ArtcraftRouterError::Client)?; + request.send(higgsfield_client).await + } + } + } +} diff --git a/crates/router/src/generate/generate_image/mod.rs b/crates/router/src/generate/generate_image/mod.rs new file mode 100644 index 00000000..f2c76005 --- /dev/null +++ b/crates/router/src/generate/generate_image/mod.rs @@ -0,0 +1,8 @@ +pub mod generate_image_request_builder; +pub mod generate_image_response; +pub mod image_generation_cost_estimate; +pub mod image_generation_draft; +pub mod image_generation_draft_context; +pub mod image_generation_draft_or_request; +pub mod image_generation_request; +pub mod providers; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/angle_validation.rs b/crates/router/src/generate/generate_image/providers/artcraft/angle_validation.rs new file mode 100644 index 00000000..e218a794 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/angle_validation.rs @@ -0,0 +1,41 @@ +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +/// Angle models (qwen_edit_2511_angles, flux_2_lora_angles) require at least +/// one input image — both v1 plans error out otherwise. Mirror that strict +/// requirement here so v1↔v2 parity holds for the "no inputs" case. +pub fn require_at_least_one_image_input( + image_inputs: &Option, +) -> Result<(), ArtcraftRouterError> { + match image_inputs { + None => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "Angle models require exactly one input image".to_string(), + })), + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("Angle models require exactly one input image, got {}", tokens.len()), + })) + } + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::MediaFileTokens(_)) => Ok(()), + Some(ImageListRef::Sources(refs)) if refs.is_empty() => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("Angle models require exactly one input image, got {}", refs.len()), + })) + } + Some(ImageListRef::Sources(refs)) => { + if refs.iter().all(|image_ref| matches!(image_ref, ImageRef::MediaFileToken(_))) { + Ok(()) + } else { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/build_common.rs b/crates/router/src/generate/generate_image/providers/artcraft/build_common.rs new file mode 100644 index 00000000..5ce9e833 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/build_common.rs @@ -0,0 +1,150 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; +use artcraft_client::enums::common::generation::common_quality::CommonQuality as CommonQualityEnum; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + +/// Build an `OmniGenImageCostAndGenerateRequest` from the builder. All Artcraft +/// image models delegate to this helper — the omni-gen endpoint handles all +/// model-specific transformations server-side, so the client request stays +/// extremely lightweight. +/// +/// Per-model build functions are expected to validate model-specific +/// constraints (e.g. unsupported aspect ratios) BEFORE calling this helper. +/// Validation that's identical across every Artcraft image model — batch count +/// (1..=4) and image_inputs shape — lives here. +pub fn build_artcraft_omni_image_request( + builder: GenerateImageRequestBuilder, + model: CommonImageModelEnum, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let image_batch_count = plan_batch_count(builder.image_batch_count, strategy)?; + let image_media_tokens = resolve_image_list_ref(builder.image_inputs.clone())?; + + let aspect_ratio = builder.aspect_ratio.map(to_aspect_ratio_enum); + let resolution = builder.resolution.map(to_resolution_enum); + let quality = builder.quality.map(to_quality_enum); + let idempotency_token = builder.get_or_generate_idempotency_token(); + + Ok(OmniGenImageCostAndGenerateRequest { + idempotency_token: Some(idempotency_token), + model: Some(model), + prompt: builder.prompt.clone(), + image_media_tokens, + resolution, + aspect_ratio, + quality, + image_batch_count: Some(image_batch_count), + adjust_horizontal_angle: builder.horizontal_angle, + adjust_vertical_angle: builder.vertical_angle, + adjust_zoom: builder.zoom, + }) +} + +/// Validate batch count (1..=4). Mirrors the v1 plan-level validation that +/// every Artcraft image model performs. +pub fn plan_batch_count( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1..=4 => Ok(count), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(4), + }, + } +} + +/// Resolve `image_inputs` to a `Vec` for the omni-gen request. +/// +/// Mirrors v1's behavior: URLs are accepted and dropped, because the omni-gen +/// distillation hydrates media tokens to URLs before the cost path runs. +/// Cost only depends on `num_images` + mode (derived from `image_inputs` +/// presence by callers), so URL-form inputs flow through cleanly. +pub fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(ImageListRef::Urls(_)) => Ok(None), + // Unlike the Urls form, mixed sources may carry local files or raw bytes + // that have never been uploaded — silently dropping them would lose the + // input entirely, so any non-token item errors out. + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +fn to_aspect_ratio_enum(ar: RouterAspectRatio) -> CommonAspectRatioEnum { + match ar { + RouterAspectRatio::Auto => CommonAspectRatioEnum::Auto, + RouterAspectRatio::Auto2k => CommonAspectRatioEnum::Auto2k, + RouterAspectRatio::Auto3k => CommonAspectRatioEnum::Auto3k, + RouterAspectRatio::Auto4k => CommonAspectRatioEnum::Auto4k, + RouterAspectRatio::Square => CommonAspectRatioEnum::Square, + RouterAspectRatio::SquareHd => CommonAspectRatioEnum::SquareHd, + RouterAspectRatio::WideFourByThree => CommonAspectRatioEnum::WideFourByThree, + RouterAspectRatio::WideFiveByFour => CommonAspectRatioEnum::WideFiveByFour, + RouterAspectRatio::WideThreeByTwo => CommonAspectRatioEnum::WideThreeByTwo, + RouterAspectRatio::WideSixteenByNine => CommonAspectRatioEnum::WideSixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => CommonAspectRatioEnum::WideTwentyOneByNine, + RouterAspectRatio::Wide => CommonAspectRatioEnum::Wide, + RouterAspectRatio::TallThreeByFour => CommonAspectRatioEnum::TallThreeByFour, + RouterAspectRatio::TallFourByFive => CommonAspectRatioEnum::TallFourByFive, + RouterAspectRatio::TallTwoByThree => CommonAspectRatioEnum::TallTwoByThree, + RouterAspectRatio::TallNineBySixteen => CommonAspectRatioEnum::TallNineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => CommonAspectRatioEnum::TallNineByTwentyOne, + RouterAspectRatio::Tall => CommonAspectRatioEnum::Tall, + } +} + +fn to_resolution_enum(r: RouterResolution) -> CommonResolutionEnum { + match r { + RouterResolution::HalfK => CommonResolutionEnum::HalfK, + RouterResolution::OneK => CommonResolutionEnum::OneK, + RouterResolution::TwoK => CommonResolutionEnum::TwoK, + RouterResolution::ThreeK => CommonResolutionEnum::ThreeK, + RouterResolution::FourK => CommonResolutionEnum::FourK, + RouterResolution::FourEightyP => CommonResolutionEnum::FourEightyP, + RouterResolution::SevenTwentyP => CommonResolutionEnum::SevenTwentyP, + RouterResolution::TenEightyP => CommonResolutionEnum::TenEightyP, + } +} + +fn to_quality_enum(q: RouterQuality) -> CommonQualityEnum { + match q { + RouterQuality::Low => CommonQualityEnum::Low, + RouterQuality::Medium => CommonQualityEnum::Medium, + RouterQuality::High => CommonQualityEnum::High, + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/build.rs new file mode 100644 index 00000000..62364f59 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::flux_1_dev::request::ArtcraftFlux1DevRequestState; + +pub fn build_artcraft_flux_1_dev( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Flux1Dev)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftFlux1Dev(ArtcraftFlux1DevRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/cost.rs new file mode 100644 index 00000000..6cb22e58 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/cost.rs @@ -0,0 +1,72 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::flux_1_dev::request::ArtcraftFlux1DevRequestState; + +/// Cost state for Artcraft Flux 1 Dev. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_flux_1_dev`): flat 2¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftFlux1DevCostState { + pub num_images: u16, +} + +impl ArtcraftFlux1DevCostState { + pub fn from_request(request: &ArtcraftFlux1DevRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Pricing: $0.02/image. 1 credit = 1 USD cent. + let cost_in_usd_cents = 2u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Flux1Dev, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_2_cents() { assert_eq!(cost_cents(1), 2); } + + #[test] + fn two_images_costs_4_cents() { assert_eq!(cost_cents(2), 4); } + + #[test] + fn three_images_costs_6_cents() { assert_eq!(cost_cents(3), 6); } + + #[test] + fn four_images_costs_8_cents() { assert_eq!(cost_cents(4), 8); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/request.rs new file mode 100644 index 00000000..ad2daf82 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_dev/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftFlux1DevRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftFlux1DevRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/build.rs new file mode 100644 index 00000000..8bde357a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::flux_1_schnell::request::ArtcraftFlux1SchnellRequestState; + +pub fn build_artcraft_flux_1_schnell( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Flux1Schnell)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftFlux1Schnell(ArtcraftFlux1SchnellRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/cost.rs new file mode 100644 index 00000000..15b6c2d2 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/cost.rs @@ -0,0 +1,71 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::flux_1_schnell::request::ArtcraftFlux1SchnellRequestState; + +/// Cost state for Artcraft Flux 1 Schnell. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_flux_1_schnell`): free, no per-image cost, +/// rate-limited by Artcraft. +#[derive(Clone, Debug)] +pub struct ArtcraftFlux1SchnellCostState; + +impl ArtcraftFlux1SchnellCostState { + pub fn from_request(_request: &ArtcraftFlux1SchnellRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + cost_in_credits: None, + cost_in_usd_cents: None, + is_free: true, + is_unlimited: true, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn build_estimate() -> crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Flux1Schnell, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(1), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap() + } + + #[test] + fn cost_is_none() { + let estimate = build_estimate(); + assert!(estimate.cost_in_usd_cents.is_none()); + assert!(estimate.cost_in_credits.is_none()); + } + + #[test] + fn is_free_is_true() { + assert!(build_estimate().is_free); + } + + #[test] + fn is_unlimited_is_true() { + assert!(build_estimate().is_unlimited); + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/request.rs new file mode 100644 index 00000000..f1336e2d --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_1_schnell/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftFlux1SchnellRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftFlux1SchnellRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/build.rs new file mode 100644 index 00000000..824d4084 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/build.rs @@ -0,0 +1,19 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::angle_validation::require_at_least_one_image_input; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::flux_2_lora_angles::request::ArtcraftFlux2LoraAnglesRequestState; + +pub fn build_artcraft_flux_2_lora_angles( + builder: GenerateImageRequestBuilder, +) -> Result { + require_at_least_one_image_input(&builder.image_inputs)?; + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Flux2LoraAngles)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftFlux2LoraAngles(ArtcraftFlux2LoraAnglesRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/cost.rs new file mode 100644 index 00000000..0286b5cd --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/cost.rs @@ -0,0 +1,73 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::flux_2_lora_angles::request::ArtcraftFlux2LoraAnglesRequestState; + +/// Cost state for Artcraft Flux 2 LoRA Angles. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_flux_2_lora_angles`): 4¢ per output image +/// (Artcraft markup over Fal's 2¢/image base rate). +#[derive(Clone, Debug)] +pub struct ArtcraftFlux2LoraAnglesCostState { + pub num_images: u16, +} + +impl ArtcraftFlux2LoraAnglesCostState { + pub fn from_request(request: &ArtcraftFlux2LoraAnglesRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 4u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Flux2LoraAngles, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: Some(ImageListRef::MediaFileTokens(vec![MediaFileToken::new_from_str("mf_test")])), + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: Some(45.0), + vertical_angle: Some(-15.0), + zoom: Some(2.0), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_4_cents() { assert_eq!(cost_cents(1), 4); } + + #[test] + fn two_images_costs_8_cents() { assert_eq!(cost_cents(2), 8); } + + #[test] + fn three_images_costs_12_cents() { assert_eq!(cost_cents(3), 12); } + + #[test] + fn four_images_costs_16_cents() { assert_eq!(cost_cents(4), 16); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/request.rs new file mode 100644 index 00000000..784657b0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_2_lora_angles/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftFlux2LoraAnglesRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftFlux2LoraAnglesRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/build.rs new file mode 100644 index 00000000..f8fd6031 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1::request::ArtcraftFluxPro1p1RequestState; + +pub fn build_artcraft_flux_pro_1p1( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::FluxPro11)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftFluxPro1p1(ArtcraftFluxPro1p1RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/cost.rs new file mode 100644 index 00000000..3e40ac28 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/cost.rs @@ -0,0 +1,71 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1::request::ArtcraftFluxPro1p1RequestState; + +/// Cost state for Artcraft Flux Pro 1.1. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_flux_pro_1p1`): 4¢ per output image (Fal's +/// $0.04/MP rate at the default ~1MP). +#[derive(Clone, Debug)] +pub struct ArtcraftFluxPro1p1CostState { + pub num_images: u16, +} + +impl ArtcraftFluxPro1p1CostState { + pub fn from_request(request: &ArtcraftFluxPro1p1RequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 4u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::FluxPro11, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_4_cents() { assert_eq!(cost_cents(1), 4); } + + #[test] + fn two_images_costs_8_cents() { assert_eq!(cost_cents(2), 8); } + + #[test] + fn three_images_costs_12_cents() { assert_eq!(cost_cents(3), 12); } + + #[test] + fn four_images_costs_16_cents() { assert_eq!(cost_cents(4), 16); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/request.rs new file mode 100644 index 00000000..54f538bb --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftFluxPro1p1RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftFluxPro1p1RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/build.rs new file mode 100644 index 00000000..493f16ca --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1_ultra::request::ArtcraftFluxPro1p1UltraRequestState; + +pub fn build_artcraft_flux_pro_1p1_ultra( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::FluxPro11Ultra)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftFluxPro1p1Ultra(ArtcraftFluxPro1p1UltraRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/cost.rs new file mode 100644 index 00000000..d1d922b3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/cost.rs @@ -0,0 +1,70 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::flux_pro_1p1_ultra::request::ArtcraftFluxPro1p1UltraRequestState; + +/// Cost state for Artcraft Flux Pro 1.1 Ultra. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_flux_pro_1p1_ultra`): 6¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftFluxPro1p1UltraCostState { + pub num_images: u16, +} + +impl ArtcraftFluxPro1p1UltraCostState { + pub fn from_request(request: &ArtcraftFluxPro1p1UltraRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 6u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::FluxPro11Ultra, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_6_cents() { assert_eq!(cost_cents(1), 6); } + + #[test] + fn two_images_costs_12_cents() { assert_eq!(cost_cents(2), 12); } + + #[test] + fn three_images_costs_18_cents() { assert_eq!(cost_cents(3), 18); } + + #[test] + fn four_images_costs_24_cents() { assert_eq!(cost_cents(4), 24); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/request.rs new file mode 100644 index 00000000..ca8e53a5 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/flux_pro_1p1_ultra/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftFluxPro1p1UltraRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftFluxPro1p1UltraRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/build.rs new file mode 100644 index 00000000..cb01c741 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::gpt_image_1::request::ArtcraftGptImage1RequestState; + +pub fn build_artcraft_gpt_image_1( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::GptImage1)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftGptImage1(ArtcraftGptImage1RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/cost.rs new file mode 100644 index 00000000..22fa5af5 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/cost.rs @@ -0,0 +1,194 @@ +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; +use artcraft_client::enums::common::generation::common_quality::CommonQuality as CommonQualityEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::gpt_image_1::request::ArtcraftGptImage1RequestState; + +/// Cost state for Artcraft GPT Image 1. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_gpt_image_1`): +/// +/// Output image cost (per output image): +/// Low: 2¢ all sizes +/// Medium: 5¢ square, 7¢ wide/tall +/// High: 17¢ square, 25¢ wide/tall +/// +/// Plus 2¢ per input image (high-fidelity estimate) in edit mode. +/// Quality defaults to High when unspecified. +#[derive(Clone, Debug)] +pub struct ArtcraftGptImage1CostState { + pub quality: Option, + pub aspect_ratio: Option, + pub num_images: u16, + pub num_input_images: u64, +} + +impl ArtcraftGptImage1CostState { + pub fn from_request(request: &ArtcraftGptImage1RequestState) -> Self { + Self { + quality: request.request.quality, + aspect_ratio: request.request.aspect_ratio, + num_images: request.request.image_batch_count.unwrap_or(1), + num_input_images: request.request.image_media_tokens + .as_ref() + .map(|t| t.len() as u64) + .unwrap_or(0), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let quality = self.quality.unwrap_or(CommonQualityEnum::High); + let is_square = is_square_or_none(self.aspect_ratio); + + let output_cost_per_image: u64 = match (quality, is_square) { + (CommonQualityEnum::Low, _) => 2, + (CommonQualityEnum::Medium, true) => 5, + (CommonQualityEnum::Medium, false) => 7, + (CommonQualityEnum::High, true) => 17, + (CommonQualityEnum::High, false) => 25, + }; + + let output_cost = output_cost_per_image * self.num_images as u64; + let input_image_cost = 2 * self.num_input_images; + let cost_in_usd_cents = output_cost + input_image_cost; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn is_square_or_none(aspect_ratio: Option) -> bool { + use CommonAspectRatioEnum as Ar; + matches!( + aspect_ratio, + None + | Some(Ar::Auto) + | Some(Ar::Auto2k) + | Some(Ar::Auto3k) + | Some(Ar::Auto4k) + | Some(Ar::Square) + | Some(Ar::SquareHd) + ) +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_quality::RouterQuality; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn base() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage1, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(1), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn cost_text(quality: Option, aspect_ratio: Option, batch: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + quality, + aspect_ratio, + image_batch_count: Some(batch), + ..base() + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + fn cost_edit(quality: Option, aspect_ratio: Option, batch: u16, num_inputs: usize) -> u64 { + let tokens: Vec = (0..num_inputs) + .map(|i| MediaFileToken::new_from_str(&format!("mf_test{:028}", i))) + .collect(); + let builder = GenerateImageRequestBuilder { + quality, + aspect_ratio, + image_batch_count: Some(batch), + image_inputs: Some(ImageListRef::MediaFileTokens(tokens)), + ..base() + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // ── Default (High square) → 17¢ ─────────────────────────────────────────── + + #[test] + fn default_one_image_is_17c() { assert_eq!(cost_text(None, None, 1), 17); } + + #[test] + fn default_four_images_is_68c() { assert_eq!(cost_text(None, None, 4), 68); } + + // ── Low → 2¢ all sizes ──────────────────────────────────────────────────── + + #[test] + fn low_square_one() { assert_eq!(cost_text(Some(RouterQuality::Low), Some(RouterAspectRatio::Square), 1), 2); } + + #[test] + fn low_wide_one() { assert_eq!(cost_text(Some(RouterQuality::Low), Some(RouterAspectRatio::WideSixteenByNine), 1), 2); } + + #[test] + fn low_tall_one() { assert_eq!(cost_text(Some(RouterQuality::Low), Some(RouterAspectRatio::TallNineBySixteen), 1), 2); } + + #[test] + fn low_four_images() { assert_eq!(cost_text(Some(RouterQuality::Low), None, 4), 8); } + + // ── Medium ──────────────────────────────────────────────────────────────── + + #[test] + fn medium_square_one() { assert_eq!(cost_text(Some(RouterQuality::Medium), Some(RouterAspectRatio::Square), 1), 5); } + + #[test] + fn medium_wide_one() { assert_eq!(cost_text(Some(RouterQuality::Medium), Some(RouterAspectRatio::WideSixteenByNine), 1), 7); } + + #[test] + fn medium_tall_one() { assert_eq!(cost_text(Some(RouterQuality::Medium), Some(RouterAspectRatio::TallNineBySixteen), 1), 7); } + + // ── High ────────────────────────────────────────────────────────────────── + + #[test] + fn high_square_one() { assert_eq!(cost_text(Some(RouterQuality::High), Some(RouterAspectRatio::Square), 1), 17); } + + #[test] + fn high_wide_one() { assert_eq!(cost_text(Some(RouterQuality::High), Some(RouterAspectRatio::WideSixteenByNine), 1), 25); } + + #[test] + fn high_wide_four() { assert_eq!(cost_text(Some(RouterQuality::High), Some(RouterAspectRatio::WideSixteenByNine), 4), 100); } + + // ── Edit mode adds 2¢ per input image ───────────────────────────────────── + + #[test] + fn edit_one_input_adds_2c() { + assert_eq!(cost_edit(Some(RouterQuality::High), Some(RouterAspectRatio::Square), 1, 1), 19); + } + + #[test] + fn edit_three_inputs_adds_6c() { + assert_eq!(cost_edit(Some(RouterQuality::High), Some(RouterAspectRatio::Square), 1, 3), 23); + } + + #[test] + fn edit_five_inputs_adds_10c() { + assert_eq!(cost_edit(Some(RouterQuality::Medium), Some(RouterAspectRatio::WideSixteenByNine), 2, 5), 24); + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/request.rs new file mode 100644 index 00000000..73e3ed5a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftGptImage1RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftGptImage1RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/build.rs new file mode 100644 index 00000000..cbf6c4aa --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::gpt_image_1p5::request::ArtcraftGptImage1p5RequestState; + +pub fn build_artcraft_gpt_image_1p5( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::GptImage1p5)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftGptImage1p5(ArtcraftGptImage1p5RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/cost.rs new file mode 100644 index 00000000..a40d5ae4 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/cost.rs @@ -0,0 +1,173 @@ +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; +use artcraft_client::enums::common::generation::common_quality::CommonQuality as CommonQualityEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::gpt_image_1p5::request::ArtcraftGptImage1p5RequestState; + +/// Cost state for Artcraft GPT Image 1.5. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_gpt_image_1p5`): +/// +/// Output image cost (per output image): +/// Low: 1¢ square, 2¢ wide/tall +/// Medium: 4¢ square, 5¢ wide, 6¢ tall +/// High: 14¢ square, 20¢ wide/tall +/// +/// Quality defaults to High when unspecified. +#[derive(Clone, Debug)] +pub struct ArtcraftGptImage1p5CostState { + pub quality: Option, + pub aspect_ratio: Option, + pub num_images: u16, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum SizeBucket { + Square, + Wide, + Tall, +} + +impl ArtcraftGptImage1p5CostState { + pub fn from_request(request: &ArtcraftGptImage1p5RequestState) -> Self { + Self { + quality: request.request.quality, + aspect_ratio: request.request.aspect_ratio, + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let quality = self.quality.unwrap_or(CommonQualityEnum::High); + let size = size_bucket(self.aspect_ratio); + + let cost_per_image: u64 = match (quality, size) { + (CommonQualityEnum::Low, SizeBucket::Square) => 1, + (CommonQualityEnum::Low, _) => 2, + + (CommonQualityEnum::Medium, SizeBucket::Square) => 4, + (CommonQualityEnum::Medium, SizeBucket::Wide) => 5, + (CommonQualityEnum::Medium, SizeBucket::Tall) => 6, + + (CommonQualityEnum::High, SizeBucket::Square) => 14, + (CommonQualityEnum::High, _) => 20, + }; + + let cost_in_usd_cents = cost_per_image * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn size_bucket(aspect_ratio: Option) -> SizeBucket { + use CommonAspectRatioEnum as Ar; + match aspect_ratio { + None + | Some(Ar::Auto) + | Some(Ar::Auto2k) + | Some(Ar::Auto3k) + | Some(Ar::Auto4k) + | Some(Ar::Square) + | Some(Ar::SquareHd) => SizeBucket::Square, + + Some(Ar::WideThreeByTwo) + | Some(Ar::WideFourByThree) + | Some(Ar::WideFiveByFour) + | Some(Ar::WideSixteenByNine) + | Some(Ar::WideTwentyOneByNine) + | Some(Ar::Wide) => SizeBucket::Wide, + + Some(Ar::TallTwoByThree) + | Some(Ar::TallThreeByFour) + | Some(Ar::TallFourByFive) + | Some(Ar::TallNineBySixteen) + | Some(Ar::TallNineByTwentyOne) + | Some(Ar::Tall) => SizeBucket::Tall, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_quality::RouterQuality; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(quality: Option, aspect_ratio: Option, batch: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::GptImage1p5, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio, + quality, + image_batch_count: Some(batch), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // ── Default (None → High) ───────────────────────────────────────────────── + + #[test] + fn default_square_one() { assert_eq!(cost_cents(None, Some(RouterAspectRatio::Square), 1), 14); } + + #[test] + fn default_unset_one() { assert_eq!(cost_cents(None, None, 1), 14); } + + #[test] + fn default_wide_one() { assert_eq!(cost_cents(None, Some(RouterAspectRatio::WideSixteenByNine), 1), 20); } + + #[test] + fn default_tall_one() { assert_eq!(cost_cents(None, Some(RouterAspectRatio::TallNineBySixteen), 1), 20); } + + #[test] + fn default_square_four() { assert_eq!(cost_cents(None, Some(RouterAspectRatio::Square), 4), 56); } + + // ── Low ─────────────────────────────────────────────────────────────────── + + #[test] + fn low_square_one() { assert_eq!(cost_cents(Some(RouterQuality::Low), Some(RouterAspectRatio::Square), 1), 1); } + + #[test] + fn low_wide_one() { assert_eq!(cost_cents(Some(RouterQuality::Low), Some(RouterAspectRatio::WideSixteenByNine), 1), 2); } + + #[test] + fn low_tall_one() { assert_eq!(cost_cents(Some(RouterQuality::Low), Some(RouterAspectRatio::TallNineBySixteen), 1), 2); } + + // ── Medium ──────────────────────────────────────────────────────────────── + + #[test] + fn medium_square_one() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::Square), 1), 4); } + + #[test] + fn medium_wide_one() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::WideSixteenByNine), 1), 5); } + + #[test] + fn medium_tall_one() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::TallNineBySixteen), 1), 6); } + + #[test] + fn medium_tall_four() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::TallNineBySixteen), 4), 24); } + + // ── High ────────────────────────────────────────────────────────────────── + + #[test] + fn high_square_one() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::Square), 1), 14); } + + #[test] + fn high_wide_four() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::WideSixteenByNine), 4), 80); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/request.rs new file mode 100644 index 00000000..991fa183 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_1p5/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftGptImage1p5RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftGptImage1p5RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/build.rs new file mode 100644 index 00000000..7f0c9537 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::gpt_image_2::request::ArtcraftGptImage2RequestState; + +pub fn build_artcraft_gpt_image_2( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::GptImage2)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftGptImage2(ArtcraftGptImage2RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/cost.rs new file mode 100644 index 00000000..3d96e1eb --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/cost.rs @@ -0,0 +1,201 @@ +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; +use artcraft_client::enums::common::generation::common_quality::CommonQuality as CommonQualityEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::gpt_image_2::request::ArtcraftGptImage2RequestState; + +/// Cost state for Artcraft GPT Image 2. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_gpt_image_2`): +/// +/// Output image cost (per output image), rounded up to whole cents: +/// Low: 1¢ all sizes +/// Medium: 4¢ landscape/portrait 4:3 or 16:9; 6¢ square or auto +/// High: 15¢ landscape/portrait 4:3; 16¢ landscape/portrait 16:9; +/// 22¢ square; 23¢ square_hd or auto +/// +/// Quality defaults to High when unspecified. +#[derive(Clone, Debug)] +pub struct ArtcraftGptImage2CostState { + pub quality: Option, + pub aspect_ratio: Option, + pub num_images: u16, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum SizeBucket { + Square, + SquareHd, + Landscape4x3, + Landscape16x9, + Portrait4x3, + Portrait16x9, + Auto, +} + +impl ArtcraftGptImage2CostState { + pub fn from_request(request: &ArtcraftGptImage2RequestState) -> Self { + Self { + quality: request.request.quality, + aspect_ratio: request.request.aspect_ratio, + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let quality = self.quality.unwrap_or(CommonQualityEnum::High); + let size = size_bucket(self.aspect_ratio); + + let cost_per_image: u64 = match (quality, size) { + (CommonQualityEnum::Low, _) => 1, + + (CommonQualityEnum::Medium, SizeBucket::Square) + | (CommonQualityEnum::Medium, SizeBucket::SquareHd) + | (CommonQualityEnum::Medium, SizeBucket::Auto) => 6, + (CommonQualityEnum::Medium, SizeBucket::Landscape4x3) + | (CommonQualityEnum::Medium, SizeBucket::Portrait4x3) + | (CommonQualityEnum::Medium, SizeBucket::Landscape16x9) + | (CommonQualityEnum::Medium, SizeBucket::Portrait16x9) => 4, + + (CommonQualityEnum::High, SizeBucket::Square) => 22, + (CommonQualityEnum::High, SizeBucket::SquareHd) | (CommonQualityEnum::High, SizeBucket::Auto) => 23, + (CommonQualityEnum::High, SizeBucket::Landscape4x3) + | (CommonQualityEnum::High, SizeBucket::Portrait4x3) => 15, + (CommonQualityEnum::High, SizeBucket::Landscape16x9) + | (CommonQualityEnum::High, SizeBucket::Portrait16x9) => 16, + }; + + let cost_in_usd_cents = cost_per_image * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Mirrors v1's `plan_image_size` for GPT Image 2 — see the v1 file +/// `plan_generate_image_artcraft_gpt_image_2.rs::plan_image_size`. +fn size_bucket(aspect_ratio: Option) -> SizeBucket { + use CommonAspectRatioEnum as Ar; + match aspect_ratio { + None + | Some(Ar::Auto) + | Some(Ar::Auto2k) + | Some(Ar::Auto3k) + | Some(Ar::Auto4k) => SizeBucket::Auto, + + Some(Ar::Square) => SizeBucket::Square, + Some(Ar::SquareHd) => SizeBucket::SquareHd, + + Some(Ar::WideFourByThree) | Some(Ar::WideFiveByFour) => SizeBucket::Landscape4x3, + + Some(Ar::WideThreeByTwo) + | Some(Ar::WideSixteenByNine) + | Some(Ar::WideTwentyOneByNine) + | Some(Ar::Wide) => SizeBucket::Landscape16x9, + + Some(Ar::TallThreeByFour) | Some(Ar::TallFourByFive) => SizeBucket::Portrait4x3, + + Some(Ar::TallTwoByThree) + | Some(Ar::TallNineBySixteen) + | Some(Ar::TallNineByTwentyOne) + | Some(Ar::Tall) => SizeBucket::Portrait16x9, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_quality::RouterQuality; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(quality: Option, aspect_ratio: Option, batch: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::GptImage2, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio, + quality, + image_batch_count: Some(batch), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // ── Low (1¢ all sizes) ──────────────────────────────────────────────────── + + #[test] + fn low_square() { assert_eq!(cost_cents(Some(RouterQuality::Low), Some(RouterAspectRatio::Square), 1), 1); } + + #[test] + fn low_square_hd() { assert_eq!(cost_cents(Some(RouterQuality::Low), Some(RouterAspectRatio::SquareHd), 1), 1); } + + #[test] + fn low_landscape_4x3() { assert_eq!(cost_cents(Some(RouterQuality::Low), Some(RouterAspectRatio::WideFourByThree), 1), 1); } + + #[test] + fn low_four() { assert_eq!(cost_cents(Some(RouterQuality::Low), None, 4), 4); } + + // ── Medium ──────────────────────────────────────────────────────────────── + + #[test] + fn medium_square_is_6c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::Square), 1), 6); } + + #[test] + fn medium_square_hd_is_6c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::SquareHd), 1), 6); } + + #[test] + fn medium_auto_is_6c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), None, 1), 6); } + + #[test] + fn medium_landscape_4x3_is_4c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::WideFourByThree), 1), 4); } + + #[test] + fn medium_portrait_4x3_is_4c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::TallThreeByFour), 1), 4); } + + #[test] + fn medium_landscape_16x9_is_4c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::WideSixteenByNine), 1), 4); } + + #[test] + fn medium_portrait_16x9_is_4c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::TallNineBySixteen), 1), 4); } + + #[test] + fn medium_square_four_is_24c() { assert_eq!(cost_cents(Some(RouterQuality::Medium), Some(RouterAspectRatio::Square), 4), 24); } + + // ── High ────────────────────────────────────────────────────────────────── + + #[test] + fn high_square_is_22c() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::Square), 1), 22); } + + #[test] + fn high_square_hd_is_23c() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::SquareHd), 1), 23); } + + #[test] + fn high_auto_is_23c() { assert_eq!(cost_cents(Some(RouterQuality::High), None, 1), 23); } + + #[test] + fn high_landscape_4x3_is_15c() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::WideFourByThree), 1), 15); } + + #[test] + fn high_landscape_16x9_is_16c() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::WideSixteenByNine), 1), 16); } + + #[test] + fn high_square_four_is_88c() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::Square), 4), 88); } + + #[test] + fn high_square_hd_four_is_92c() { assert_eq!(cost_cents(Some(RouterQuality::High), Some(RouterAspectRatio::SquareHd), 4), 92); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/request.rs new file mode 100644 index 00000000..21005a81 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/gpt_image_2/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftGptImage2RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftGptImage2RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/build.rs new file mode 100644 index 00000000..1f118bd8 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::midjourney_7::request::ArtcraftMidjourney7RequestState; + +pub fn build_artcraft_midjourney_7( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Midjourney7)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftMidjourney7(ArtcraftMidjourney7RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/cost.rs new file mode 100644 index 00000000..f43dd529 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/cost.rs @@ -0,0 +1,156 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::midjourney_7::request::ArtcraftMidjourney7RequestState; + +/// Cost state for Artcraft Midjourney 7. Pricing mirrors the Kinovi +/// midjourney_7 provider 1:1 in USD cents — ArtCraft credits map cent-for-cent. +/// +/// | batch | credits | USD cents | +/// |-------|---------|-----------| +/// | 1 | 6 | 6¢ | +/// | 2 | 12 | 12¢ | +/// | 3 | 19 | 19¢ | (interpolated; Kinovi doesn't expose 3) +/// | 4 | 25 | 25¢ | +/// +/// Kinovi-side math (historical, 22,000-credit package at 193 credits/$1): +/// 12 Kinovi credits per Midjourney task → batches 1/2/4 land on 6/12/25¢; +/// batch 3 is `ceil((12 × 3 / 193) × 100) = 19`. Under the current +/// 525,000-credit package (243 credits/$1) Kinovi costs only 5/10/20¢ — +/// user pricing is intentionally kept at the 193-derived values. +#[derive(Clone, Debug)] +pub struct ArtcraftMidjourney7CostState { + pub num_images: u16, +} + +impl ArtcraftMidjourney7CostState { + pub fn from_request(request: &ArtcraftMidjourney7RequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = midjourney_cost_for_batch(self.num_images); + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Returns the customer-facing midjourney cost in USD cents for a given +/// batch count. Shared between v7, v7-niji, and v8 (all three Midjourney +/// models have identical pricing on Kinovi). +pub(crate) fn midjourney_cost_for_batch(batch_count: u16) -> u64 { + match batch_count { + 0 => 0, // Defensive; the builder rejects zero before reaching cost. + 1 => 6, + 2 => 12, + 3 => 19, + 4 => 25, + // Should never happen — `plan_batch_count` clamps to 1..=4. + _ => 25, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7, + provider: RouterProvider::Artcraft, + prompt: Some("a corgi astronaut".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + fn cost_credits(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7, + provider: RouterProvider::Artcraft, + prompt: Some("a corgi astronaut".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_credits.unwrap() + } + + // ── Spot checks: each supported batch size ── + + #[test] + fn one_image_is_six_cents() { assert_eq!(cost_cents(1), 6); } + + #[test] + fn two_images_is_twelve_cents() { assert_eq!(cost_cents(2), 12); } + + #[test] + fn three_images_is_nineteen_cents() { assert_eq!(cost_cents(3), 19); } + + #[test] + fn four_images_is_twentyfive_cents() { assert_eq!(cost_cents(4), 25); } + + // ── Credits track USD cents exactly (1 credit = 1 cent) ── + + #[test] + fn credits_equal_usd_cents() { + for batch in 1..=4u16 { + assert_eq!(cost_credits(batch), cost_cents(batch), + "credits should equal usd cents at batch {}", batch); + } + } + + // ── Monotonicity ── + + #[test] + fn cost_is_monotonically_increasing() { + let c1 = cost_cents(1); + let c2 = cost_cents(2); + let c3 = cost_cents(3); + let c4 = cost_cents(4); + assert!(c1 < c2, "{} < {}", c1, c2); + assert!(c2 < c3, "{} < {}", c2, c3); + assert!(c3 < c4, "{} < {}", c3, c4); + } + + // ── Flags ── + + #[test] + fn cost_flags_are_correct() { + let cost = ArtcraftMidjourney7CostState { num_images: 1 }.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.failures_are_refunded, None); + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/request.rs new file mode 100644 index 00000000..70d2b6f6 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMidjourney7RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftMidjourney7RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/build.rs new file mode 100644 index 00000000..324d926a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::midjourney_7_niji::request::ArtcraftMidjourney7NijiRequestState; + +pub fn build_artcraft_midjourney_7_niji( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Midjourney7Niji)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftMidjourney7Niji(ArtcraftMidjourney7NijiRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/cost.rs new file mode 100644 index 00000000..19dfcffe --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/cost.rs @@ -0,0 +1,85 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::midjourney_7::cost::midjourney_cost_for_batch; +use crate::generate::generate_image::providers::artcraft::midjourney_7_niji::request::ArtcraftMidjourney7NijiRequestState; + +/// Cost state for Artcraft Midjourney 7 Niji. Pricing is identical to v7 +/// and v8 on Kinovi, so we share the per-batch table via +/// `midjourney_cost_for_batch`. +#[derive(Clone, Debug)] +pub struct ArtcraftMidjourney7NijiCostState { + pub num_images: u16, +} + +impl ArtcraftMidjourney7NijiCostState { + pub fn from_request(request: &ArtcraftMidjourney7NijiRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = midjourney_cost_for_batch(self.num_images); + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7Niji, + provider: RouterProvider::Artcraft, + prompt: Some("anime forest".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn batch_1_is_6() { assert_eq!(cost_cents(1), 6); } + + #[test] + fn batch_2_is_12() { assert_eq!(cost_cents(2), 12); } + + #[test] + fn batch_3_is_19() { assert_eq!(cost_cents(3), 19); } + + #[test] + fn batch_4_is_25() { assert_eq!(cost_cents(4), 25); } + + #[test] + fn niji_pricing_matches_v7() { + use crate::generate::generate_image::providers::artcraft::midjourney_7::cost::ArtcraftMidjourney7CostState; + for batch in 1..=4u16 { + let v7 = ArtcraftMidjourney7CostState { num_images: batch }.estimate_cost(); + let niji = ArtcraftMidjourney7NijiCostState { num_images: batch }.estimate_cost(); + assert_eq!(v7.cost_in_usd_cents, niji.cost_in_usd_cents, "batch {}", batch); + assert_eq!(v7.cost_in_credits, niji.cost_in_credits, "batch {}", batch); + } + } + +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/request.rs new file mode 100644 index 00000000..9ec610b8 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_7_niji/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMidjourney7NijiRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftMidjourney7NijiRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/build.rs new file mode 100644 index 00000000..ecf0ab39 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::midjourney_8::request::ArtcraftMidjourney8RequestState; + +pub fn build_artcraft_midjourney_8( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Midjourney8)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftMidjourney8(ArtcraftMidjourney8RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/cost.rs new file mode 100644 index 00000000..09cbaadb --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/cost.rs @@ -0,0 +1,85 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::midjourney_7::cost::midjourney_cost_for_batch; +use crate::generate::generate_image::providers::artcraft::midjourney_8::request::ArtcraftMidjourney8RequestState; + +/// Cost state for Artcraft Midjourney 8. Pricing is identical to v7 and +/// v7-niji on Kinovi; shares the per-batch table via +/// `midjourney_cost_for_batch`. +#[derive(Clone, Debug)] +pub struct ArtcraftMidjourney8CostState { + pub num_images: u16, +} + +impl ArtcraftMidjourney8CostState { + pub fn from_request(request: &ArtcraftMidjourney8RequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = midjourney_cost_for_batch(self.num_images); + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney8, + provider: RouterProvider::Artcraft, + prompt: Some("a haunted mansion".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn batch_1_is_6() { assert_eq!(cost_cents(1), 6); } + + #[test] + fn batch_2_is_12() { assert_eq!(cost_cents(2), 12); } + + #[test] + fn batch_3_is_19() { assert_eq!(cost_cents(3), 19); } + + #[test] + fn batch_4_is_25() { assert_eq!(cost_cents(4), 25); } + + #[test] + fn v8_pricing_matches_v7() { + use crate::generate::generate_image::providers::artcraft::midjourney_7::cost::ArtcraftMidjourney7CostState; + for batch in 1..=4u16 { + let v7 = ArtcraftMidjourney7CostState { num_images: batch }.estimate_cost(); + let v8 = ArtcraftMidjourney8CostState { num_images: batch }.estimate_cost(); + assert_eq!(v7.cost_in_usd_cents, v8.cost_in_usd_cents, "batch {}", batch); + assert_eq!(v7.cost_in_credits, v8.cost_in_credits, "batch {}", batch); + } + } + +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/request.rs new file mode 100644 index 00000000..303c2a3f --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/midjourney_8/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMidjourney8RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftMidjourney8RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/mod.rs new file mode 100644 index 00000000..cde52f8c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/mod.rs @@ -0,0 +1,23 @@ +pub(crate) mod angle_validation; +pub(crate) mod build_common; +pub mod flux_1_dev; +pub mod flux_1_schnell; +pub mod flux_2_lora_angles; +pub mod flux_pro_1p1; +pub mod flux_pro_1p1_ultra; +pub mod gpt_image_1; +pub mod gpt_image_1p5; +pub mod gpt_image_2; +pub mod midjourney_7; +pub mod midjourney_7_niji; +pub mod midjourney_8; +pub mod nano_banana; +pub mod nano_banana_2; +pub mod nano_banana_pro; +pub mod qwen_edit_2511_angles; +pub(crate) mod request_common; +pub mod seedream_4; +pub mod seedream_4p5; +pub mod seedream_5_lite; +pub mod seedream_5p0_pro; +pub mod seedream_5p0_pro_ultra; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/build.rs new file mode 100644 index 00000000..76e374b9 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::nano_banana::request::ArtcraftNanoBananaRequestState; + +pub fn build_artcraft_nano_banana( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::NanoBanana)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftNanoBanana(ArtcraftNanoBananaRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/cost.rs new file mode 100644 index 00000000..d2b2d12e --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/cost.rs @@ -0,0 +1,70 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::nano_banana::request::ArtcraftNanoBananaRequestState; + +/// Cost state for Artcraft Nano Banana (Gemini 2.5 Flash). Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_nano_banana`): 4¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftNanoBananaCostState { + pub num_images: u16, +} + +impl ArtcraftNanoBananaCostState { + pub fn from_request(request: &ArtcraftNanoBananaRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 4u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::NanoBanana, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_4_cents() { assert_eq!(cost_cents(1), 4); } + + #[test] + fn two_images_costs_8_cents() { assert_eq!(cost_cents(2), 8); } + + #[test] + fn three_images_costs_12_cents() { assert_eq!(cost_cents(3), 12); } + + #[test] + fn four_images_costs_16_cents() { assert_eq!(cost_cents(4), 16); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/request.rs new file mode 100644 index 00000000..15046c05 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftNanoBananaRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftNanoBananaRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/build.rs new file mode 100644 index 00000000..413f7cf6 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::nano_banana_2::request::ArtcraftNanoBanana2RequestState; + +pub fn build_artcraft_nano_banana_2( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::NanoBanana2)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftNanoBanana2(ArtcraftNanoBanana2RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/cost.rs new file mode 100644 index 00000000..e6c7b8f2 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/cost.rs @@ -0,0 +1,123 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::nano_banana_2::request::ArtcraftNanoBanana2RequestState; + +/// Cost state for Artcraft Nano Banana 2. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_nano_banana_2`): +/// +/// 0.5K → 6¢, 1K (default) → 8¢, 2K → 12¢, 4K → 16¢. 3K falls back to 2K +/// pricing; legacy video resolutions (480p/720p/1080p) fall back to 1K. +#[derive(Clone, Debug)] +pub struct ArtcraftNanoBanana2CostState { + pub resolution: Option, + pub num_images: u16, +} + +impl ArtcraftNanoBanana2CostState { + pub fn from_request(request: &ArtcraftNanoBanana2RequestState) -> Self { + Self { + resolution: request.request.resolution, + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_per_image: u64 = cost_per_image_in_cents(self.resolution); + let cost_in_usd_cents = cost_per_image * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn cost_per_image_in_cents(resolution: Option) -> u64 { + use CommonResolutionEnum as R; + match resolution { + Some(R::HalfK) => 6, + None + | Some(R::OneK) + | Some(R::FourEightyP) + | Some(R::SevenTwentyP) + | Some(R::TenEightyP) => 8, + Some(R::TwoK) | Some(R::ThreeK) => 12, + Some(R::FourK) => 16, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(resolution: Option, image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::NanoBanana2, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // ── Default / 1K (8¢) ────────────────────────────────────────────────────── + + #[test] + fn default_resolution_one_image_is_8c() { assert_eq!(cost_cents(None, 1), 8); } + + #[test] + fn default_resolution_four_images_is_32c() { assert_eq!(cost_cents(None, 4), 32); } + + #[test] + fn one_k_one_image_is_8c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 1), 8); } + + // ── 0.5K (6¢) ────────────────────────────────────────────────────────────── + + #[test] + fn half_k_one_image_is_6c() { assert_eq!(cost_cents(Some(RouterResolution::HalfK), 1), 6); } + + #[test] + fn half_k_four_images_is_24c() { assert_eq!(cost_cents(Some(RouterResolution::HalfK), 4), 24); } + + // ── 2K (12¢) ─────────────────────────────────────────────────────────────── + + #[test] + fn two_k_one_image_is_12c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 1), 12); } + + #[test] + fn two_k_four_images_is_48c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 4), 48); } + + // ── 3K falls back to 2K pricing ──────────────────────────────────────────── + + #[test] + fn three_k_one_image_falls_back_to_two_k_pricing() { + assert_eq!(cost_cents(Some(RouterResolution::ThreeK), 1), 12); + } + + // ── 4K (16¢) ─────────────────────────────────────────────────────────────── + + #[test] + fn four_k_one_image_is_16c() { assert_eq!(cost_cents(Some(RouterResolution::FourK), 1), 16); } + + #[test] + fn four_k_four_images_is_64c() { assert_eq!(cost_cents(Some(RouterResolution::FourK), 4), 64); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/request.rs new file mode 100644 index 00000000..0386b15c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_2/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftNanoBanana2RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftNanoBanana2RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/build.rs new file mode 100644 index 00000000..10b5a99a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::nano_banana_pro::request::ArtcraftNanoBananaProRequestState; + +pub fn build_artcraft_nano_banana_pro( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::NanoBananaPro)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftNanoBananaPro(ArtcraftNanoBananaProRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/cost.rs new file mode 100644 index 00000000..aecde3fd --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/cost.rs @@ -0,0 +1,109 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::nano_banana_pro::request::ArtcraftNanoBananaProRequestState; + +/// Cost state for Artcraft Nano Banana Pro. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_nano_banana_pro`): +/// +/// ≤2K (default 1K) → 15¢, 4K → 30¢. 3K falls back to 2K pricing; legacy +/// video resolutions and 0.5K fall back to 1K pricing. +#[derive(Clone, Debug)] +pub struct ArtcraftNanoBananaProCostState { + pub resolution: Option, + pub num_images: u16, +} + +impl ArtcraftNanoBananaProCostState { + pub fn from_request(request: &ArtcraftNanoBananaProRequestState) -> Self { + Self { + resolution: request.request.resolution, + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_per_image: u64 = match self.resolution { + Some(CommonResolutionEnum::FourK) => 30, + _ => 15, + }; + let cost_in_usd_cents = cost_per_image * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(resolution: Option, image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::NanoBananaPro, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // ── ≤2K → 15¢/image ──────────────────────────────────────────────────────── + + #[test] + fn default_resolution_one_image_is_15c() { assert_eq!(cost_cents(None, 1), 15); } + + #[test] + fn one_k_one_image_is_15c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 1), 15); } + + #[test] + fn two_k_one_image_is_15c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 1), 15); } + + #[test] + fn one_k_two_images_is_30c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 2), 30); } + + #[test] + fn one_k_four_images_is_60c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 4), 60); } + + // ── 4K → 30¢/image ──────────────────────────────────────────────────────── + + #[test] + fn four_k_one_image_is_30c() { assert_eq!(cost_cents(Some(RouterResolution::FourK), 1), 30); } + + #[test] + fn four_k_two_images_is_60c() { assert_eq!(cost_cents(Some(RouterResolution::FourK), 2), 60); } + + #[test] + fn four_k_four_images_is_120c() { assert_eq!(cost_cents(Some(RouterResolution::FourK), 4), 120); } + + // ── 3K and legacy resolutions fall back to 15¢ ───────────────────────────── + + #[test] + fn three_k_falls_back_to_15c() { assert_eq!(cost_cents(Some(RouterResolution::ThreeK), 1), 15); } + + #[test] + fn half_k_falls_back_to_15c() { assert_eq!(cost_cents(Some(RouterResolution::HalfK), 1), 15); } + + #[test] + fn ten_eighty_p_falls_back_to_15c() { assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 1), 15); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/request.rs new file mode 100644 index 00000000..9dfca956 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/nano_banana_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftNanoBananaProRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftNanoBananaProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/build.rs new file mode 100644 index 00000000..d32814d4 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/build.rs @@ -0,0 +1,19 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::angle_validation::require_at_least_one_image_input; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::qwen_edit_2511_angles::request::ArtcraftQwenEdit2511AnglesRequestState; + +pub fn build_artcraft_qwen_edit_2511_angles( + builder: GenerateImageRequestBuilder, +) -> Result { + require_at_least_one_image_input(&builder.image_inputs)?; + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::QwenEdit2511Angles)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftQwenEdit2511Angles(ArtcraftQwenEdit2511AnglesRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/cost.rs new file mode 100644 index 00000000..2994c7ac --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/cost.rs @@ -0,0 +1,72 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::qwen_edit_2511_angles::request::ArtcraftQwenEdit2511AnglesRequestState; + +/// Cost state for Artcraft Qwen Edit 2511 Angles. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_qwen_edit_2511_angles`): 4¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftQwenEdit2511AnglesCostState { + pub num_images: u16, +} + +impl ArtcraftQwenEdit2511AnglesCostState { + pub fn from_request(request: &ArtcraftQwenEdit2511AnglesRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 4u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::QwenEdit2511Angles, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: Some(ImageListRef::MediaFileTokens(vec![MediaFileToken::new_from_str("mf_test")])), + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: Some(45.0), + vertical_angle: Some(-15.0), + zoom: Some(2.0), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_4_cents() { assert_eq!(cost_cents(1), 4); } + + #[test] + fn two_images_costs_8_cents() { assert_eq!(cost_cents(2), 8); } + + #[test] + fn three_images_costs_12_cents() { assert_eq!(cost_cents(3), 12); } + + #[test] + fn four_images_costs_16_cents() { assert_eq!(cost_cents(4), 16); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/request.rs new file mode 100644 index 00000000..71653044 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/qwen_edit_2511_angles/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftQwenEdit2511AnglesRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftQwenEdit2511AnglesRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/request_common.rs b/crates/router/src/generate/generate_image/providers/artcraft/request_common.rs new file mode 100644 index 00000000..d9612503 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/request_common.rs @@ -0,0 +1,31 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; +use artcraft_client::credentials::api_or_web_creds::ApiOrWebCreds; +use artcraft_client::endpoints::omni_gen::generate::image::omni_gen_image::{omni_gen_image_generate, OmniGenImageGenerateArgs}; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + ArtcraftImageResponsePayload, GenerateImageResponse, +}; + +/// Send an image generation request to the Artcraft omni-gen image endpoint. +/// All Artcraft model request states delegate to this function. +pub async fn send_artcraft_omni_image_request( + request: &OmniGenImageCostAndGenerateRequest, + client: &RouterArtcraftClient, +) -> Result { + let api_or_web_creds = ApiOrWebCreds::from(&client.credentials); + + let response = omni_gen_image_generate(OmniGenImageGenerateArgs { + api_host: &client.api_host, + api_or_web_creds: Some(&api_or_web_creds), + request, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateImageResponse::Artcraft(ArtcraftImageResponsePayload { + inference_job_token: response.inference_job_token, + })) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/build.rs new file mode 100644 index 00000000..a7f11f3b --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::seedream_4::request::ArtcraftSeedream4RequestState; + +pub fn build_artcraft_seedream_4( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Seedream4)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftSeedream4(ArtcraftSeedream4RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/cost.rs new file mode 100644 index 00000000..7a05a74c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/cost.rs @@ -0,0 +1,70 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::seedream_4::request::ArtcraftSeedream4RequestState; + +/// Cost state for Artcraft Seedream V4. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_seedream_4`): 3¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream4CostState { + pub num_images: u16, +} + +impl ArtcraftSeedream4CostState { + pub fn from_request(request: &ArtcraftSeedream4RequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 3u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Seedream4, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_3_cents() { assert_eq!(cost_cents(1), 3); } + + #[test] + fn two_images_costs_6_cents() { assert_eq!(cost_cents(2), 6); } + + #[test] + fn three_images_costs_9_cents() { assert_eq!(cost_cents(3), 9); } + + #[test] + fn four_images_costs_12_cents() { assert_eq!(cost_cents(4), 12); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/request.rs new file mode 100644 index 00000000..02c8df3d --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream4RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftSeedream4RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/build.rs new file mode 100644 index 00000000..64f71aec --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::seedream_4p5::request::ArtcraftSeedream4p5RequestState; + +pub fn build_artcraft_seedream_4p5( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Seedream4p5)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftSeedream4p5(ArtcraftSeedream4p5RequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/cost.rs new file mode 100644 index 00000000..867ad1ad --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/cost.rs @@ -0,0 +1,64 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::seedream_4p5::request::ArtcraftSeedream4p5RequestState; + +/// Cost state for Artcraft Seedream V4.5. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_seedream_4p5`): 4¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream4p5CostState { + pub num_images: u16, +} + +impl ArtcraftSeedream4p5CostState { + pub fn from_request(request: &ArtcraftSeedream4p5RequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 4u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Seedream4p5, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_4_cents() { assert_eq!(cost_cents(1), 4); } + + #[test] + fn four_images_costs_16_cents() { assert_eq!(cost_cents(4), 16); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/request.rs new file mode 100644 index 00000000..4ce7dc49 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_4p5/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream4p5RequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftSeedream4p5RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/build.rs new file mode 100644 index 00000000..95254877 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::seedream_5_lite::request::ArtcraftSeedream5LiteRequestState; + +pub fn build_artcraft_seedream_5_lite( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Seedream5Lite)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftSeedream5Lite(ArtcraftSeedream5LiteRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/cost.rs new file mode 100644 index 00000000..92cafae7 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/cost.rs @@ -0,0 +1,64 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::seedream_5_lite::request::ArtcraftSeedream5LiteRequestState; + +/// Cost state for Artcraft Seedream 5 Lite. Pricing mirrors v1 +/// (`estimate_image_cost_artcraft_seedream_5_lite`): 4¢ per output image. +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream5LiteCostState { + pub num_images: u16, +} + +impl ArtcraftSeedream5LiteCostState { + pub fn from_request(request: &ArtcraftSeedream5LiteRequestState) -> Self { + Self { + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = 4u64 * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn cost_cents(image_batch_count: u16) -> u64 { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5Lite, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn one_image_costs_4_cents() { assert_eq!(cost_cents(1), 4); } + + #[test] + fn four_images_costs_16_cents() { assert_eq!(cost_cents(4), 16); } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/request.rs new file mode 100644 index 00000000..ef5bbd24 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5_lite/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream5LiteRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftSeedream5LiteRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/build.rs new file mode 100644 index 00000000..dc2727fc --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro::request::ArtcraftSeedream5p0ProRequestState; + +pub fn build_artcraft_seedream_5p0_pro( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Seedream5p0Pro)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftSeedream5p0Pro(ArtcraftSeedream5p0ProRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/cost.rs new file mode 100644 index 00000000..3cf00f96 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/cost.rs @@ -0,0 +1,187 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro::request::ArtcraftSeedream5p0ProRequestState; + +/// Customer-facing price per image at 1k resolution (the default), in USD cents. +const USD_CENTS_PER_IMAGE_1K: u64 = 7; + +/// Customer-facing price per image at 2k resolution, in USD cents. +const USD_CENTS_PER_IMAGE_2K: u64 = 12; + +/// Cost state for Artcraft Seedream 5.0 Pro. Pricing is per image and +/// resolution-dependent: +/// +/// 1K (default) → 7¢, 2K → 12¢. 3K/4K fall back to 2K pricing; 0.5K and +/// legacy video resolutions (480p/720p/1080p) fall back to 1K. +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream5p0ProCostState { + pub resolution: Option, + pub num_images: u16, +} + +impl ArtcraftSeedream5p0ProCostState { + pub fn from_request(request: &ArtcraftSeedream5p0ProRequestState) -> Self { + Self { + resolution: request.request.resolution, + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_per_image: u64 = cost_per_image_in_cents(self.resolution); + let cost_in_usd_cents = cost_per_image * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn cost_per_image_in_cents(resolution: Option) -> u64 { + use CommonResolutionEnum as R; + match resolution { + None + | Some(R::HalfK) + | Some(R::OneK) + | Some(R::FourEightyP) + | Some(R::SevenTwentyP) + | Some(R::TenEightyP) => USD_CENTS_PER_IMAGE_1K, + Some(R::TwoK) | Some(R::ThreeK) | Some(R::FourK) => USD_CENTS_PER_IMAGE_2K, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn estimate(resolution: Option, image_batch_count: u16) -> ImageGenerationCostEstimate { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5p0Pro, + provider: RouterProvider::Artcraft, + prompt: Some("an anime girl riding a dinosaur".to_string()), + image_inputs: None, + resolution, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap() + } + + fn cost_cents(resolution: Option, image_batch_count: u16) -> u64 { + estimate(resolution, image_batch_count).cost_in_usd_cents.unwrap() + } + + // ── Default / 1K (7¢) ── + + #[test] + fn default_resolution_one_image_is_7c() { assert_eq!(cost_cents(None, 1), 7); } + + #[test] + fn one_k_one_image_is_7c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 1), 7); } + + #[test] + fn one_k_four_images_is_28c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 4), 28); } + + // ── 2K (12¢) ── + + #[test] + fn two_k_one_image_is_12c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 1), 12); } + + #[test] + fn two_k_four_images_is_48c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 4), 48); } + + // ── Fallbacks ── + + #[test] + fn four_k_falls_back_to_two_k_pricing() { + assert_eq!( + ArtcraftSeedream5p0ProCostState { + resolution: Some(CommonResolutionEnum::FourK), + num_images: 1, + }.estimate_cost().cost_in_usd_cents, + Some(12), + ); + } + + #[test] + fn half_k_falls_back_to_one_k_pricing() { + assert_eq!( + ArtcraftSeedream5p0ProCostState { + resolution: Some(CommonResolutionEnum::HalfK), + num_images: 1, + }.estimate_cost().cost_in_usd_cents, + Some(7), + ); + } + + // ── Credits track USD cents exactly (1 credit = 1 cent) ── + + #[test] + fn credits_equal_usd_cents() { + for batch in 1..=4u16 { + let one_k = estimate(Some(RouterResolution::OneK), batch); + assert_eq!(one_k.cost_in_credits, one_k.cost_in_usd_cents, "1k batch {}", batch); + let two_k = estimate(Some(RouterResolution::TwoK), batch); + assert_eq!(two_k.cost_in_credits, two_k.cost_in_usd_cents, "2k batch {}", batch); + } + } + + // ── The Artcraft price must cover the Kinovi provider cost ── + + #[test] + fn price_covers_kinovi_cost() { + use seedance2pro_client::generate::image::generate_seedream_5p0_pro::{ + KinoviSeedream5p0ProBatchCount, KinoviSeedream5p0ProResolution, + }; + use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::cost::KinoviSeedream5p0ProCostState; + + let cases = [ + (RouterResolution::OneK, KinoviSeedream5p0ProResolution::OneK, 1u16, KinoviSeedream5p0ProBatchCount::One), + (RouterResolution::OneK, KinoviSeedream5p0ProResolution::OneK, 4u16, KinoviSeedream5p0ProBatchCount::Four), + (RouterResolution::TwoK, KinoviSeedream5p0ProResolution::TwoK, 1u16, KinoviSeedream5p0ProBatchCount::One), + (RouterResolution::TwoK, KinoviSeedream5p0ProResolution::TwoK, 4u16, KinoviSeedream5p0ProBatchCount::Four), + ]; + for (router_res, kinovi_res, batch, kinovi_batch) in cases { + let artcraft_cents = cost_cents(Some(router_res), batch); + let kinovi_cents = KinoviSeedream5p0ProCostState { + resolution: kinovi_res, + batch_count: kinovi_batch, + }.estimate_cost().cost_in_usd_cents.unwrap(); + assert!( + artcraft_cents > kinovi_cents, + "artcraft price {}¢ must exceed kinovi cost {}¢ ({:?} batch {})", + artcraft_cents, kinovi_cents, router_res, batch, + ); + } + } + + // ── Flags ── + + #[test] + fn cost_flags_are_correct() { + let cost = ArtcraftSeedream5p0ProCostState { resolution: None, num_images: 1 }.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.failures_are_refunded, None); + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/request.rs new file mode 100644 index 00000000..dc9f394f --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream5p0ProRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftSeedream5p0ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/build.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/build.rs new file mode 100644 index 00000000..a5d6c693 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/build.rs @@ -0,0 +1,17 @@ +use artcraft_client::enums::common::generation::common_image_model::CommonImageModel as CommonImageModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::artcraft::build_common::build_artcraft_omni_image_request; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro_ultra::request::ArtcraftSeedream5p0ProUltraRequestState; + +pub fn build_artcraft_seedream_5p0_pro_ultra( + builder: GenerateImageRequestBuilder, +) -> Result { + let request = build_artcraft_omni_image_request(builder, CommonImageModelEnum::Seedream5p0ProUltra)?; + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::ArtcraftSeedream5p0ProUltra(ArtcraftSeedream5p0ProUltraRequestState { request }), + )) +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/cost.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/cost.rs new file mode 100644 index 00000000..cfe3ef6a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/cost.rs @@ -0,0 +1,208 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro_ultra::request::ArtcraftSeedream5p0ProUltraRequestState; + +/// Customer-facing price per image at 1k resolution (the default), in USD cents. +const USD_CENTS_PER_IMAGE_1K: u64 = 18; + +/// Customer-facing price per image at 2k resolution, in USD cents. +const USD_CENTS_PER_IMAGE_2K: u64 = 30; + +/// Cost state for Artcraft Seedream 5.0 Pro Ultra. Pricing is per image and +/// resolution-dependent: +/// +/// 1K (default) → 18¢, 2K → 30¢. 3K/4K fall back to 2K pricing; 0.5K and +/// legacy video resolutions (480p/720p/1080p) fall back to 1K. +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream5p0ProUltraCostState { + pub resolution: Option, + pub num_images: u16, +} + +impl ArtcraftSeedream5p0ProUltraCostState { + pub fn from_request(request: &ArtcraftSeedream5p0ProUltraRequestState) -> Self { + Self { + resolution: request.request.resolution, + num_images: request.request.image_batch_count.unwrap_or(1), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_per_image: u64 = cost_per_image_in_cents(self.resolution); + let cost_in_usd_cents = cost_per_image * self.num_images as u64; + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn cost_per_image_in_cents(resolution: Option) -> u64 { + use CommonResolutionEnum as R; + match resolution { + None + | Some(R::HalfK) + | Some(R::OneK) + | Some(R::FourEightyP) + | Some(R::SevenTwentyP) + | Some(R::TenEightyP) => USD_CENTS_PER_IMAGE_1K, + Some(R::TwoK) | Some(R::ThreeK) | Some(R::FourK) => USD_CENTS_PER_IMAGE_2K, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + + fn estimate(resolution: Option, image_batch_count: u16) -> ImageGenerationCostEstimate { + let builder = GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5p0ProUltra, + provider: RouterProvider::Artcraft, + prompt: Some("an anime girl riding a dinosaur".to_string()), + image_inputs: None, + resolution, + aspect_ratio: None, + quality: None, + image_batch_count: Some(image_batch_count), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + }; + builder.build2().unwrap().estimate_cost().unwrap() + } + + fn cost_cents(resolution: Option, image_batch_count: u16) -> u64 { + estimate(resolution, image_batch_count).cost_in_usd_cents.unwrap() + } + + // ── Default / 1K (18¢) ── + + #[test] + fn default_resolution_one_image_is_18c() { assert_eq!(cost_cents(None, 1), 18); } + + #[test] + fn one_k_one_image_is_18c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 1), 18); } + + #[test] + fn one_k_four_images_is_72c() { assert_eq!(cost_cents(Some(RouterResolution::OneK), 4), 72); } + + // ── 2K (30¢) ── + + #[test] + fn two_k_one_image_is_30c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 1), 30); } + + #[test] + fn two_k_four_images_is_120c() { assert_eq!(cost_cents(Some(RouterResolution::TwoK), 4), 120); } + + // ── Fallbacks ── + + #[test] + fn four_k_falls_back_to_two_k_pricing() { + assert_eq!( + ArtcraftSeedream5p0ProUltraCostState { + resolution: Some(CommonResolutionEnum::FourK), + num_images: 1, + }.estimate_cost().cost_in_usd_cents, + Some(30), + ); + } + + #[test] + fn half_k_falls_back_to_one_k_pricing() { + assert_eq!( + ArtcraftSeedream5p0ProUltraCostState { + resolution: Some(CommonResolutionEnum::HalfK), + num_images: 1, + }.estimate_cost().cost_in_usd_cents, + Some(18), + ); + } + + // ── Credits track USD cents exactly (1 credit = 1 cent) ── + + #[test] + fn credits_equal_usd_cents() { + for batch in 1..=4u16 { + let one_k = estimate(Some(RouterResolution::OneK), batch); + assert_eq!(one_k.cost_in_credits, one_k.cost_in_usd_cents, "1k batch {}", batch); + let two_k = estimate(Some(RouterResolution::TwoK), batch); + assert_eq!(two_k.cost_in_credits, two_k.cost_in_usd_cents, "2k batch {}", batch); + } + } + + // ── The price must exceed the base Seedream 5.0 Pro price ── + + #[test] + fn price_exceeds_base_seedream_5p0_pro_price() { + use crate::generate::generate_image::providers::artcraft::seedream_5p0_pro::cost::ArtcraftSeedream5p0ProCostState; + + for resolution in [None, Some(CommonResolutionEnum::OneK), Some(CommonResolutionEnum::TwoK)] { + for num_images in [1u16, 4] { + let ultra_cents = ArtcraftSeedream5p0ProUltraCostState { resolution, num_images } + .estimate_cost().cost_in_usd_cents.unwrap(); + let base_cents = ArtcraftSeedream5p0ProCostState { resolution, num_images } + .estimate_cost().cost_in_usd_cents.unwrap(); + assert!( + ultra_cents > base_cents, + "ultra price {}¢ must exceed base price {}¢ ({:?} batch {})", + ultra_cents, base_cents, resolution, num_images, + ); + } + } + } + + // ── The Artcraft price must cover the Kinovi provider cost ── + + #[test] + fn price_covers_kinovi_cost() { + use seedance2pro_client::generate::image::generate_seedream_5p0_pro::{ + KinoviSeedream5p0ProBatchCount, KinoviSeedream5p0ProResolution, + }; + use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::cost::KinoviSeedream5p0ProCostState; + + let cases = [ + (RouterResolution::OneK, KinoviSeedream5p0ProResolution::OneK, 1u16, KinoviSeedream5p0ProBatchCount::One), + (RouterResolution::OneK, KinoviSeedream5p0ProResolution::OneK, 4u16, KinoviSeedream5p0ProBatchCount::Four), + (RouterResolution::TwoK, KinoviSeedream5p0ProResolution::TwoK, 1u16, KinoviSeedream5p0ProBatchCount::One), + (RouterResolution::TwoK, KinoviSeedream5p0ProResolution::TwoK, 4u16, KinoviSeedream5p0ProBatchCount::Four), + ]; + for (router_res, kinovi_res, batch, kinovi_batch) in cases { + let artcraft_cents = cost_cents(Some(router_res), batch); + let kinovi_cents = KinoviSeedream5p0ProCostState { + resolution: kinovi_res, + batch_count: kinovi_batch, + }.estimate_cost().cost_in_usd_cents.unwrap(); + assert!( + artcraft_cents > kinovi_cents, + "artcraft price {}¢ must exceed kinovi cost {}¢ ({:?} batch {})", + artcraft_cents, kinovi_cents, router_res, batch, + ); + } + } + + // ── Flags ── + + #[test] + fn cost_flags_are_correct() { + let cost = ArtcraftSeedream5p0ProUltraCostState { resolution: None, num_images: 1 }.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.failures_are_refunded, None); + } +} diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/mod.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/request.rs b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/request.rs new file mode 100644 index 00000000..fd5a9a12 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/artcraft/seedream_5p0_pro_ultra/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_image_cost_and_generate_request::OmniGenImageCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::GenerateImageResponse; +use crate::generate::generate_image::providers::artcraft::request_common::send_artcraft_omni_image_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedream5p0ProUltraRequestState { + pub request: OmniGenImageCostAndGenerateRequest, +} + +impl ArtcraftSeedream5p0ProUltraRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_image_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/build.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/build.rs new file mode 100644 index 00000000..94fcccdb --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/build.rs @@ -0,0 +1,453 @@ +use fal_client::requests::api::image::edit::flux_1_dev_edit_image::api::{ + Flux1DevEditImageNumImages, Flux1DevEditImageRequest, +}; +use fal_client::requests::api::image::text::flux_1_dev_text_to_image::api::{ + Flux1DevTextToImageAspectRatio, Flux1DevTextToImageNumImages, Flux1DevTextToImageRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::flux_1_dev::request::FalFlux1DevRequestState; + +pub fn build_fal_flux_1_dev( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let prompt = builder.prompt.clone().unwrap_or_default(); + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let image_url = resolve_single_image_url(builder.image_inputs.clone())?; + + let state = if let Some(url) = image_url { + // Edit image (single image URL, no aspect ratio / resolution controls) + FalFlux1DevRequestState::EditImage(Flux1DevEditImageRequest { + prompt, + image_url: url, + num_images: to_edit_num_images(num_images), + }) + } else { + // Text-to-image + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio); + + FalFlux1DevRequestState::TextToImage(Flux1DevTextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + aspect_ratio, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux1Dev(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> Flux1DevTextToImageNumImages { + match n { + PlannedNumImages::One => Flux1DevTextToImageNumImages::One, + PlannedNumImages::Two => Flux1DevTextToImageNumImages::Two, + PlannedNumImages::Three => Flux1DevTextToImageNumImages::Three, + PlannedNumImages::Four => Flux1DevTextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> Flux1DevEditImageNumImages { + match n { + PlannedNumImages::One => Flux1DevEditImageNumImages::One, + PlannedNumImages::Two => Flux1DevEditImageNumImages::Two, + PlannedNumImages::Three => Flux1DevEditImageNumImages::Three, + PlannedNumImages::Four => Flux1DevEditImageNumImages::Four, + } +} + +// ── Aspect ratio ── + +fn plan_aspect_ratio( + aspect_ratio: Option, +) -> Flux1DevTextToImageAspectRatio { + use Flux1DevTextToImageAspectRatio as T; + match aspect_ratio { + None | Some(RouterAspectRatio::Auto) | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) | Some(RouterAspectRatio::Auto4k) => T::SquareHd, + Some(RouterAspectRatio::Square) => T::Square, + Some(RouterAspectRatio::SquareHd) => T::SquareHd, + Some(RouterAspectRatio::WideFourByThree) | Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::WideThreeByTwo) | Some(RouterAspectRatio::Wide) => T::LandscapeFourByThree, + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::WideTwentyOneByNine) => T::LandscapeSixteenByNine, + Some(RouterAspectRatio::TallThreeByFour) | Some(RouterAspectRatio::TallFourByFive) + | Some(RouterAspectRatio::TallTwoByThree) | Some(RouterAspectRatio::Tall) => T::PortraitThreeByFour, + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::TallNineByTwentyOne) => T::PortraitNineBySixteen, + } +} + +// ── Image inputs ── + +/// Flux 1 Dev edit takes exactly one image URL. v1 rejects multi-URL inputs; +/// match that strictness so cost parity holds across the full sweep. +fn resolve_single_image_url( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(None), + Some(ImageListRef::Urls(urls)) if urls.is_empty() => Ok(None), + Some(ImageListRef::Urls(urls)) if urls.len() == 1 => Ok(Some(urls.into_iter().next().unwrap())), + Some(ImageListRef::Urls(urls)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("Flux 1 Dev image-to-image supports exactly 1 image, got {}", urls.len()), + })) + } + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + if urls.len() > 1 { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("Flux 1 Dev image-to-image supports exactly 1 image, got {}", urls.len()), + })); + } + Ok(urls.into_iter().next()) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Flux1Dev, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> Flux1DevTextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux1Dev( + FalFlux1DevRequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected TextToImage variant") + }; + req + } + + fn unwrap_edit(result: Result) -> Flux1DevEditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux1Dev( + FalFlux1DevRequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected EditImage variant") + }; + req + } + + // ── Mode detection ── + + mod mode_detection { + use super::*; + + #[test] + fn no_images_yields_text_to_image() { + let req = unwrap_t2i(build_fal_flux_1_dev(base_builder())); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn single_url_yields_edit_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_dev(builder)); + assert_eq!(req.image_url, "https://example.com/img.jpg"); + } + + #[test] + fn multiple_urls_rejected_for_parity_with_v1() { + // v1 hard-rejects >1 URL for Flux 1 Dev edit. v2 mirrors that. + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![ + "https://example.com/a.jpg".to_string(), + "https://example.com/b.jpg".to_string(), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_dev(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. })) + )); + } + + #[test] + fn empty_urls_yields_text_to_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![])), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_dev(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_t2i(build_fal_flux_1_dev(base_builder())); + assert!(matches!(req.num_images, Flux1DevTextToImageNumImages::One)); + } + + #[test] + fn explicit_three() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.num_images, Flux1DevTextToImageNumImages::Three)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_dev(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_dev(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.num_images, Flux1DevTextToImageNumImages::Four)); + } + + #[test] + fn edit_mode_num_images() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(2), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_dev(builder)); + assert!(matches!(req.num_images, Flux1DevEditImageNumImages::Two)); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn default_is_square_hd() { + let req = unwrap_t2i(build_fal_flux_1_dev(base_builder())); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::SquareHd)); + } + + #[test] + fn auto_yields_square_hd() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::SquareHd)); + } + + #[test] + fn square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::Square)); + } + + #[test] + fn square_hd() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::SquareHd), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::SquareHd)); + } + + #[test] + fn wide_four_by_three() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideFourByThree), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::LandscapeFourByThree)); + } + + #[test] + fn wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::LandscapeSixteenByNine)); + } + + #[test] + fn wide_twenty_one_by_nine_maps_to_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::LandscapeSixteenByNine)); + } + + #[test] + fn tall_three_by_four() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallThreeByFour), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::PortraitThreeByFour)); + } + + #[test] + fn tall_nine_by_sixteen() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert!(matches!(req.aspect_ratio, Flux1DevTextToImageAspectRatio::PortraitNineBySixteen)); + } + } + + // ── Prompt ── + + mod prompt_tests { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let builder = GenerateImageRequestBuilder { + prompt: Some("my custom prompt".to_string()), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert_eq!(req.prompt, "my custom prompt"); + } + + #[test] + fn missing_prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { + prompt: None, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_dev(builder)); + assert_eq!(req.prompt, ""); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/cost.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/cost.rs new file mode 100644 index 00000000..b28d3319 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/cost.rs @@ -0,0 +1,113 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::flux_1_dev::request::FalFlux1DevRequestState; + +pub struct FalFlux1DevCostState { + cost_in_usd_cents: u64, +} + +impl FalFlux1DevCostState { + pub fn from_request(request: &FalFlux1DevRequestState) -> Self { + let cost_in_usd_cents = match request { + FalFlux1DevRequestState::TextToImage(req) => req.calculate_cost_in_cents(), + FalFlux1DevRequestState::EditImage(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests::api::image::edit::flux_1_dev_edit_image::api::{ + Flux1DevEditImageNumImages, Flux1DevEditImageRequest, + }; + use fal_client::requests::api::image::text::flux_1_dev_text_to_image::api::{ + Flux1DevTextToImageAspectRatio, Flux1DevTextToImageNumImages, Flux1DevTextToImageRequest, + }; + + mod text_to_image_costs { + use super::*; + + fn make_t2i(num_images: Flux1DevTextToImageNumImages) -> FalFlux1DevRequestState { + FalFlux1DevRequestState::TextToImage(Flux1DevTextToImageRequest { + prompt: "test".to_string(), + num_images, + aspect_ratio: Flux1DevTextToImageAspectRatio::Square, + }) + } + + #[test] + fn one_image() { + let cost = FalFlux1DevCostState::from_request(&make_t2i(Flux1DevTextToImageNumImages::One)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(3)); + } + + #[test] + fn two_images() { + let cost = FalFlux1DevCostState::from_request(&make_t2i(Flux1DevTextToImageNumImages::Two)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(6)); + } + + #[test] + fn four_images() { + let cost = FalFlux1DevCostState::from_request(&make_t2i(Flux1DevTextToImageNumImages::Four)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(12)); + } + } + + mod edit_image_costs { + use super::*; + + fn make_edit(num_images: Flux1DevEditImageNumImages) -> FalFlux1DevRequestState { + FalFlux1DevRequestState::EditImage(Flux1DevEditImageRequest { + prompt: "test".to_string(), + image_url: "https://example.com/img.jpg".to_string(), + num_images, + }) + } + + #[test] + fn one_image() { + let cost = FalFlux1DevCostState::from_request(&make_edit(Flux1DevEditImageNumImages::One)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(3)); + } + + #[test] + fn three_images() { + let cost = FalFlux1DevCostState::from_request(&make_edit(Flux1DevEditImageNumImages::Three)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(9)); + } + } + + #[test] + fn cost_flags_are_correct() { + let state = FalFlux1DevCostState::from_request( + &FalFlux1DevRequestState::TextToImage(Flux1DevTextToImageRequest { + prompt: "test".to_string(), + num_images: Flux1DevTextToImageNumImages::One, + aspect_ratio: Flux1DevTextToImageAspectRatio::Square, + }), + ); + let cost = state.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/mod.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/request.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/request.rs new file mode 100644 index 00000000..e14a4f1a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_dev/request.rs @@ -0,0 +1,155 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::flux_1_dev_edit_image::api::Flux1DevEditImageRequest; +use fal_client::requests::api::image::text::flux_1_dev_text_to_image::api::Flux1DevTextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalFlux1DevRequestState { + TextToImage(Flux1DevTextToImageRequest), + EditImage(Flux1DevEditImageRequest), +} + +impl FalFlux1DevRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + } + } +} + +// ── Helpers ── + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::edit::flux_1_dev_edit_image::api::Flux1DevEditImageNumImages; + use fal_client::requests::api::image::text::flux_1_dev_text_to_image::api::{ + Flux1DevTextToImageAspectRatio, Flux1DevTextToImageNumImages, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + // ── Text-to-image ── + + mod text_to_image { + use super::*; + + fn t2i_request() -> FalFlux1DevRequestState { + FalFlux1DevRequestState::TextToImage(Flux1DevTextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: Flux1DevTextToImageNumImages::One, + aspect_ratio: Flux1DevTextToImageAspectRatio::LandscapeSixteenByNine, + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = t2i_request(); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook t2i — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + } + + // ── Edit image ── + + mod edit_image { + use super::*; + + fn edit_request() -> FalFlux1DevRequestState { + FalFlux1DevRequestState::EditImage(Flux1DevEditImageRequest { + prompt: "turn this into a watercolor painting".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + num_images: Flux1DevEditImageNumImages::One, + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = edit_request(); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook edit — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/build.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/build.rs new file mode 100644 index 00000000..85009e74 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/build.rs @@ -0,0 +1,468 @@ +use fal_client::requests::api::image::edit::flux_1_schnell_edit_image::api::{ + Flux1SchnellEditImageNumImages, Flux1SchnellEditImageRequest, Flux1SchnellEditImageSize, +}; +use fal_client::requests::api::image::text::flux_1_schnell_text_to_image::api::{ + Flux1SchnellTextToImageAspectRatio, Flux1SchnellTextToImageNumImages, + Flux1SchnellTextToImageRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::flux_1_schnell::request::FalFlux1SchnellRequestState; + +pub fn build_fal_flux_1_schnell( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let prompt = builder.prompt.clone().unwrap_or_default(); + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let image_url = resolve_single_image_url(builder.image_inputs.clone())?; + + let state = if let Some(url) = image_url { + // Edit image (redux): single image URL, optional image_size, no prompt + let image_size = plan_edit_image_size(builder.aspect_ratio); + + FalFlux1SchnellRequestState::EditImage(Flux1SchnellEditImageRequest { + image_url: url, + num_images: to_edit_num_images(num_images), + image_size, + }) + } else { + // Text-to-image + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio); + + FalFlux1SchnellRequestState::TextToImage(Flux1SchnellTextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + aspect_ratio, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux1Schnell(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> Flux1SchnellTextToImageNumImages { + match n { + PlannedNumImages::One => Flux1SchnellTextToImageNumImages::One, + PlannedNumImages::Two => Flux1SchnellTextToImageNumImages::Two, + PlannedNumImages::Three => Flux1SchnellTextToImageNumImages::Three, + PlannedNumImages::Four => Flux1SchnellTextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> Flux1SchnellEditImageNumImages { + match n { + PlannedNumImages::One => Flux1SchnellEditImageNumImages::One, + PlannedNumImages::Two => Flux1SchnellEditImageNumImages::Two, + PlannedNumImages::Three => Flux1SchnellEditImageNumImages::Three, + PlannedNumImages::Four => Flux1SchnellEditImageNumImages::Four, + } +} + +// ── Aspect ratio ── + +fn plan_aspect_ratio( + aspect_ratio: Option, +) -> Flux1SchnellTextToImageAspectRatio { + use Flux1SchnellTextToImageAspectRatio as T; + match aspect_ratio { + None | Some(RouterAspectRatio::Auto) | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) | Some(RouterAspectRatio::Auto4k) => T::SquareHd, + Some(RouterAspectRatio::Square) => T::Square, + Some(RouterAspectRatio::SquareHd) => T::SquareHd, + Some(RouterAspectRatio::WideFourByThree) | Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::WideThreeByTwo) | Some(RouterAspectRatio::Wide) => T::LandscapeFourByThree, + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::WideTwentyOneByNine) => T::LandscapeSixteenByNine, + Some(RouterAspectRatio::TallThreeByFour) | Some(RouterAspectRatio::TallFourByFive) + | Some(RouterAspectRatio::TallTwoByThree) | Some(RouterAspectRatio::Tall) => T::PortraitThreeByFour, + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::TallNineByTwentyOne) => T::PortraitNineBySixteen, + } +} + +fn plan_edit_image_size( + aspect_ratio: Option, +) -> Option { + use Flux1SchnellEditImageSize as S; + aspect_ratio.and_then(|ar| match ar { + RouterAspectRatio::Auto | RouterAspectRatio::Auto2k + | RouterAspectRatio::Auto3k | RouterAspectRatio::Auto4k => None, + RouterAspectRatio::Square => Some(S::Square), + RouterAspectRatio::SquareHd => Some(S::SquareHd), + RouterAspectRatio::WideFourByThree | RouterAspectRatio::WideFiveByFour + | RouterAspectRatio::WideThreeByTwo | RouterAspectRatio::Wide => Some(S::LandscapeFourByThree), + RouterAspectRatio::WideSixteenByNine | RouterAspectRatio::WideTwentyOneByNine => Some(S::LandscapeSixteenByNine), + RouterAspectRatio::TallThreeByFour | RouterAspectRatio::TallFourByFive + | RouterAspectRatio::TallTwoByThree | RouterAspectRatio::Tall => Some(S::PortraitThreeByFour), + RouterAspectRatio::TallNineBySixteen | RouterAspectRatio::TallNineByTwentyOne => Some(S::PortraitNineBySixteen), + }) +} + +// ── Image inputs ── + +/// Flux 1 Schnell redux takes exactly one image URL. v1 rejects multi-URL +/// inputs; match that strictness so cost parity holds across the full sweep. +fn resolve_single_image_url( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(None), + Some(ImageListRef::Urls(urls)) if urls.is_empty() => Ok(None), + Some(ImageListRef::Urls(urls)) if urls.len() == 1 => Ok(Some(urls.into_iter().next().unwrap())), + Some(ImageListRef::Urls(urls)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("Flux 1 Schnell redux supports exactly 1 image, got {}", urls.len()), + })) + } + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + if urls.len() > 1 { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("Flux 1 Schnell redux supports exactly 1 image, got {}", urls.len()), + })); + } + Ok(urls.into_iter().next()) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Flux1Schnell, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> Flux1SchnellTextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux1Schnell( + FalFlux1SchnellRequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected TextToImage variant") + }; + req + } + + fn unwrap_edit(result: Result) -> Flux1SchnellEditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux1Schnell( + FalFlux1SchnellRequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected EditImage variant") + }; + req + } + + // ── Mode detection ── + + mod mode_detection { + use super::*; + + #[test] + fn no_images_yields_text_to_image() { + let req = unwrap_t2i(build_fal_flux_1_schnell(base_builder())); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn single_url_yields_edit_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_schnell(builder)); + assert_eq!(req.image_url, "https://example.com/img.jpg"); + } + + #[test] + fn multiple_urls_rejected_for_parity_with_v1() { + // v1 hard-rejects >1 URL for Flux 1 Schnell redux. v2 mirrors that. + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![ + "https://example.com/a.jpg".to_string(), + "https://example.com/b.jpg".to_string(), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_schnell(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. })) + )); + } + + #[test] + fn empty_urls_yields_text_to_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![])), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_schnell(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_t2i(build_fal_flux_1_schnell(base_builder())); + assert!(matches!(req.num_images, Flux1SchnellTextToImageNumImages::One)); + } + + #[test] + fn explicit_three() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.num_images, Flux1SchnellTextToImageNumImages::Three)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_schnell(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_1_schnell(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.num_images, Flux1SchnellTextToImageNumImages::Four)); + } + + #[test] + fn edit_mode_num_images() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(2), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.num_images, Flux1SchnellEditImageNumImages::Two)); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn default_is_square_hd() { + let req = unwrap_t2i(build_fal_flux_1_schnell(base_builder())); + assert!(matches!(req.aspect_ratio, Flux1SchnellTextToImageAspectRatio::SquareHd)); + } + + #[test] + fn square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.aspect_ratio, Flux1SchnellTextToImageAspectRatio::Square)); + } + + #[test] + fn wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.aspect_ratio, Flux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine)); + } + + #[test] + fn tall_nine_by_sixteen() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.aspect_ratio, Flux1SchnellTextToImageAspectRatio::PortraitNineBySixteen)); + } + + #[test] + fn edit_auto_yields_none() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_schnell(builder)); + assert!(req.image_size.is_none()); + } + + #[test] + fn edit_square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.image_size, Some(Flux1SchnellEditImageSize::Square))); + } + + #[test] + fn edit_landscape() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_schnell(builder)); + assert!(matches!(req.image_size, Some(Flux1SchnellEditImageSize::LandscapeSixteenByNine))); + } + + #[test] + fn edit_no_aspect_ratio_yields_none() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: None, + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_flux_1_schnell(builder)); + assert!(req.image_size.is_none()); + } + } + + // ── Prompt ── + + mod prompt_tests { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let builder = GenerateImageRequestBuilder { + prompt: Some("my custom prompt".to_string()), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert_eq!(req.prompt, "my custom prompt"); + } + + #[test] + fn missing_prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { + prompt: None, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_flux_1_schnell(builder)); + assert_eq!(req.prompt, ""); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/cost.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/cost.rs new file mode 100644 index 00000000..be5f83c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/cost.rs @@ -0,0 +1,114 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::flux_1_schnell::request::FalFlux1SchnellRequestState; + +pub struct FalFlux1SchnellCostState { + cost_in_usd_cents: u64, +} + +impl FalFlux1SchnellCostState { + pub fn from_request(request: &FalFlux1SchnellRequestState) -> Self { + let cost_in_usd_cents = match request { + FalFlux1SchnellRequestState::TextToImage(req) => req.calculate_cost_in_cents(), + FalFlux1SchnellRequestState::EditImage(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests::api::image::edit::flux_1_schnell_edit_image::api::{ + Flux1SchnellEditImageNumImages, Flux1SchnellEditImageRequest, + }; + use fal_client::requests::api::image::text::flux_1_schnell_text_to_image::api::{ + Flux1SchnellTextToImageAspectRatio, Flux1SchnellTextToImageNumImages, + Flux1SchnellTextToImageRequest, + }; + + mod text_to_image_costs { + use super::*; + + fn make_t2i(num_images: Flux1SchnellTextToImageNumImages) -> FalFlux1SchnellRequestState { + FalFlux1SchnellRequestState::TextToImage(Flux1SchnellTextToImageRequest { + prompt: "test".to_string(), + num_images, + aspect_ratio: Flux1SchnellTextToImageAspectRatio::Square, + }) + } + + #[test] + fn one_image() { + let cost = FalFlux1SchnellCostState::from_request(&make_t2i(Flux1SchnellTextToImageNumImages::One)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(1)); + } + + #[test] + fn two_images() { + let cost = FalFlux1SchnellCostState::from_request(&make_t2i(Flux1SchnellTextToImageNumImages::Two)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(2)); + } + + #[test] + fn four_images() { + let cost = FalFlux1SchnellCostState::from_request(&make_t2i(Flux1SchnellTextToImageNumImages::Four)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(4)); + } + } + + mod edit_image_costs { + use super::*; + + fn make_edit(num_images: Flux1SchnellEditImageNumImages) -> FalFlux1SchnellRequestState { + FalFlux1SchnellRequestState::EditImage(Flux1SchnellEditImageRequest { + image_url: "https://example.com/img.jpg".to_string(), + num_images, + image_size: None, + }) + } + + #[test] + fn one_image() { + let cost = FalFlux1SchnellCostState::from_request(&make_edit(Flux1SchnellEditImageNumImages::One)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(1)); + } + + #[test] + fn three_images() { + let cost = FalFlux1SchnellCostState::from_request(&make_edit(Flux1SchnellEditImageNumImages::Three)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(3)); + } + } + + #[test] + fn cost_flags_are_correct() { + let state = FalFlux1SchnellCostState::from_request( + &FalFlux1SchnellRequestState::TextToImage(Flux1SchnellTextToImageRequest { + prompt: "test".to_string(), + num_images: Flux1SchnellTextToImageNumImages::One, + aspect_ratio: Flux1SchnellTextToImageAspectRatio::Square, + }), + ); + let cost = state.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/mod.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/request.rs b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/request.rs new file mode 100644 index 00000000..7f23db66 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_1_schnell/request.rs @@ -0,0 +1,151 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::flux_1_schnell_edit_image::api::Flux1SchnellEditImageRequest; +use fal_client::requests::api::image::text::flux_1_schnell_text_to_image::api::Flux1SchnellTextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalFlux1SchnellRequestState { + TextToImage(Flux1SchnellTextToImageRequest), + EditImage(Flux1SchnellEditImageRequest), +} + +impl FalFlux1SchnellRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + } + } +} + +// ── Helpers ── + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::edit::flux_1_schnell_edit_image::api::Flux1SchnellEditImageNumImages; + use fal_client::requests::api::image::text::flux_1_schnell_text_to_image::api::{ + Flux1SchnellTextToImageAspectRatio, Flux1SchnellTextToImageNumImages, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + // ── Text-to-image ── + + mod text_to_image { + use super::*; + + fn t2i_request() -> FalFlux1SchnellRequestState { + FalFlux1SchnellRequestState::TextToImage(Flux1SchnellTextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: Flux1SchnellTextToImageNumImages::One, + aspect_ratio: Flux1SchnellTextToImageAspectRatio::LandscapeSixteenByNine, + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let response = t2i_request().send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook t2i — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + } + + // ── Edit image ── + + mod edit_image { + use super::*; + + fn edit_request() -> FalFlux1SchnellRequestState { + FalFlux1SchnellRequestState::EditImage(Flux1SchnellEditImageRequest { + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + num_images: Flux1SchnellEditImageNumImages::One, + image_size: None, + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let response = edit_request().send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook edit — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/build.rs b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/build.rs new file mode 100644 index 00000000..45ae3dd2 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/build.rs @@ -0,0 +1,217 @@ +use fal_client::requests::api::image::angle::flux_2_lora_edit_image_angle::api::{ + Flux2LoraAngleImageSize, Flux2LoraAngleNumImages, Flux2LoraEditImageAngleRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::flux_2_lora_angles::request::FalFlux2LoraAnglesRequestState; + +pub fn build_fal_flux_2_lora_angles( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + if image_urls.is_empty() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "Angle models require at least one input image URL".to_string(), + })); + } + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let image_size = plan_image_size(builder.aspect_ratio, strategy)?; + + let request = Flux2LoraEditImageAngleRequest { + image_urls, + horizontal_angle: builder.horizontal_angle, + vertical_angle: builder.vertical_angle.map(|v| v.clamp(0.0, 60.0)), + zoom: builder.zoom, + num_images: Some(num_images), + image_size, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux2LoraAngles(FalFlux2LoraAnglesRequestState { request }), + )) +} + +fn resolve_image_urls(image_inputs: Option) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +fn plan_num_images( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use Flux2LoraAngleNumImages as N; + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(N::One), + 2 => Ok(N::Two), + 3 => Ok(N::Three), + 4 => Ok(N::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(N::Four), + }, + } +} + +fn plan_image_size( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Flux2LoraAngleImageSize as S; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Square) => Ok(Some(S::Square)), + Some(RouterAspectRatio::SquareHd) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Wide) | Some(RouterAspectRatio::WideSixteenByNine) => Ok(Some(S::LandscapeSixteenNine)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(S::LandscapeFourThree)), + + Some(RouterAspectRatio::Tall) | Some(RouterAspectRatio::TallNineBySixteen) => Ok(Some(S::PortraitSixteenNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(S::PortraitFourThree)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::SquareHd)), + }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + #[test] + fn passes_through_camera_params() { + let builder = GenerateImageRequestBuilder { + vertical_angle: Some(15.0), + ..base() + }; + let req = unwrap_request(build_fal_flux_2_lora_angles(builder)); + assert_eq!(req.horizontal_angle, Some(45.0)); + assert_eq!(req.vertical_angle, Some(15.0)); + assert_eq!(req.zoom, Some(2.0)); + } + + #[test] + fn negative_vertical_angle_clamps_to_zero() { + // Fal's flux-2-lora-gallery rejects vertical_angle < 0 (schema requires ge: 0.0). + let builder = GenerateImageRequestBuilder { + vertical_angle: Some(-30.0), + ..base() + }; + let req = unwrap_request(build_fal_flux_2_lora_angles(builder)); + assert_eq!(req.vertical_angle, Some(0.0)); + } + + #[test] + fn vertical_angle_above_sixty_clamps_to_sixty() { + // Fal's flux-2-lora-gallery rejects vertical_angle > 60 (schema requires le: 60.0). + let builder = GenerateImageRequestBuilder { + vertical_angle: Some(90.0), + ..base() + }; + let req = unwrap_request(build_fal_flux_2_lora_angles(builder)); + assert_eq!(req.vertical_angle, Some(60.0)); + } + + #[test] + fn missing_image_inputs_errors() { + let builder = GenerateImageRequestBuilder { image_inputs: None, ..base() }; + assert!(build_fal_flux_2_lora_angles(builder).is_err()); + } + + #[test] + fn media_file_tokens_rejected() { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![MediaFileToken::new_from_str("mf_test")])), + ..base() + }; + assert!(matches!( + build_fal_flux_2_lora_angles(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn batch_zero_errors() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(0), ..base() }; + assert!(matches!( + build_fal_flux_2_lora_angles(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + fn base() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Flux2LoraAngles, + provider: RouterProvider::Fal, + prompt: None, + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/x.jpg".to_string()])), + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: Some(45.0), + vertical_angle: Some(-15.0), + zoom: Some(2.0), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_request(result: Result) -> Flux2LoraEditImageAngleRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFlux2LoraAngles(state) + ) = result.expect("build should succeed") else { + panic!("expected FalFlux2LoraAngles variant") + }; + state.request + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/cost.rs b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/cost.rs new file mode 100644 index 00000000..ae2ddf14 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/cost.rs @@ -0,0 +1,75 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::flux_2_lora_angles::request::FalFlux2LoraAnglesRequestState; + +/// Cost state for Fal Flux 2 LoRA Angles. Delegates to the fal_client cost +/// calculator (2¢ per output image — $0.021/MP at the default ~1MP). +pub struct FalFlux2LoraAnglesCostState { + cost_in_usd_cents: u64, +} + +impl FalFlux2LoraAnglesCostState { + pub fn from_request(request: &FalFlux2LoraAnglesRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests::api::image::angle::flux_2_lora_edit_image_angle::api::{ + Flux2LoraAngleNumImages, Flux2LoraEditImageAngleRequest, + }; + + #[test] + fn one_image_is_2_cents() { + assert_eq!(cost_for(Flux2LoraAngleNumImages::One).cost_in_usd_cents, Some(2)); + } + + #[test] + fn two_images_is_4_cents() { + assert_eq!(cost_for(Flux2LoraAngleNumImages::Two).cost_in_usd_cents, Some(4)); + } + + #[test] + fn three_images_is_6_cents() { + assert_eq!(cost_for(Flux2LoraAngleNumImages::Three).cost_in_usd_cents, Some(6)); + } + + #[test] + fn four_images_is_8_cents() { + assert_eq!(cost_for(Flux2LoraAngleNumImages::Four).cost_in_usd_cents, Some(8)); + } + + fn cost_for(n: Flux2LoraAngleNumImages) -> ImageGenerationCostEstimate { + let state = FalFlux2LoraAnglesCostState::from_request(&FalFlux2LoraAnglesRequestState { + request: Flux2LoraEditImageAngleRequest { + image_urls: vec!["https://example.com/x.jpg".to_string()], + horizontal_angle: None, + vertical_angle: None, + zoom: None, + num_images: Some(n), + image_size: None, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + }); + state.estimate_cost() + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/mod.rs b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/request.rs b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/request.rs new file mode 100644 index 00000000..e6c18467 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_2_lora_angles/request.rs @@ -0,0 +1,111 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::angle::flux_2_lora_edit_image_angle::api::Flux2LoraEditImageAngleRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalFlux2LoraAnglesRequestState { + pub request: Flux2LoraEditImageAngleRequest, +} + +impl FalFlux2LoraAnglesRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let outbound: Arc = Arc::new(self.request.clone()); + let payload = send_fal_request(&self.request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } +} + +// ── Helpers ── + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request + .send_webhook_request(&client.api_key, webhook_url) + .await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request + .send_queue_request(&client.api_key) + .await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::angle::flux_2_lora_edit_image_angle::api::{ + Flux2LoraAngleImageSize, Flux2LoraAngleNumImages, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = FalFlux2LoraAnglesRequestState { + request: Flux2LoraEditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(15.0), + zoom: Some(2.0), + num_images: Some(Flux2LoraAngleNumImages::One), + image_size: Some(Flux2LoraAngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + }; + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/build.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/build.rs new file mode 100644 index 00000000..44a12242 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/build.rs @@ -0,0 +1,303 @@ +use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_text_to_image_webhook::{ + FluxPro11AspectRatio, FluxPro11NumImages, FluxPro11Request, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::flux_pro_1p1::request::FalFluxPro1p1RequestState; + +pub fn build_fal_flux_pro_1p1( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Flux Pro 1.1 is text-to-image only. v1 hard-errors on any image_inputs + // (regardless of generation_mode_mismatch_strategy) — match that. + if builder.image_inputs.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "Flux Pro 1.1 is text-to-image only".to_string(), + })); + } + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + + let request = FluxPro11Request { + prompt: builder.prompt.clone().unwrap_or_default(), + aspect_ratio, + num_images, + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFluxPro1p1(FalFluxPro1p1RequestState { request }), + )) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use FluxPro11AspectRatio as Ar; + match aspect_ratio { + None => Ok(Ar::Square), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::Square), + + Some(RouterAspectRatio::Square) => Ok(Ar::Square), + Some(RouterAspectRatio::SquareHd) => Ok(Ar::SquareHd), + Some(RouterAspectRatio::WideFourByThree) => Ok(Ar::LandscapeFourByThree), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::LandscapeSixteenByNine), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Ar::PortraitThreeByFour), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::PortraitNineBySixteen), + + Some(RouterAspectRatio::WideFiveByFour) => Ok(Ar::LandscapeFourByThree), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Ar::LandscapeFourByThree), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Ar::LandscapeSixteenByNine), + Some(RouterAspectRatio::TallFourByFive) => Ok(Ar::PortraitThreeByFour), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Ar::PortraitThreeByFour), + Some(RouterAspectRatio::TallNineByTwentyOne) => Ok(Ar::PortraitNineBySixteen), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Ar::Square), + }, + } +} + +fn plan_num_images( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(FluxPro11NumImages::One), + 2 => Ok(FluxPro11NumImages::Two), + 3 => Ok(FluxPro11NumImages::Three), + 4 => Ok(FluxPro11NumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(FluxPro11NumImages::Four), + }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::FluxPro11, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_request(result: Result) -> FluxPro11Request { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFluxPro1p1(state) + ) = result.expect("build should succeed") else { + panic!("expected FalFluxPro1p1 variant") + }; + state.request + } + + // ── Mode rejection ── + + #[test] + fn image_inputs_present_yields_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_pro_1p1(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. })) + )); + } + + // ── Prompt ── + + mod prompt_tests { + use super::*; + + #[test] + fn prompt_passed_through() { + let builder = GenerateImageRequestBuilder { + prompt: Some("my custom prompt".to_string()), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert_eq!(req.prompt, "my custom prompt"); + } + + #[test] + fn missing_prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { prompt: None, ..base_builder() }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert_eq!(req.prompt, ""); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn default_is_square() { + let req = unwrap_request(build_fal_flux_pro_1p1(base_builder())); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::Square)); + } + + #[test] + fn auto_maps_to_square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::Square)); + } + + #[test] + fn square_hd() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::SquareHd), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::SquareHd)); + } + + #[test] + fn wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::LandscapeSixteenByNine)); + } + + #[test] + fn tall_nine_by_sixteen() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::PortraitNineBySixteen)); + } + + #[test] + fn wide_twenty_one_by_nine_collapses_to_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::LandscapeSixteenByNine)); + } + + #[test] + fn tall_four_by_five_collapses_to_three_by_four() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallFourByFive), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11AspectRatio::PortraitThreeByFour)); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_request(build_fal_flux_pro_1p1(base_builder())); + assert!(matches!(req.num_images, FluxPro11NumImages::One)); + } + + #[test] + fn explicit_three() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.num_images, FluxPro11NumImages::Three)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_pro_1p1(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_pro_1p1(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_batch_count", .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1(builder)); + assert!(matches!(req.num_images, FluxPro11NumImages::Four)); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/cost.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/cost.rs new file mode 100644 index 00000000..9a49ff43 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/cost.rs @@ -0,0 +1,86 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::flux_pro_1p1::request::FalFluxPro1p1RequestState; + +pub struct FalFluxPro1p1CostState { + cost_in_usd_cents: u64, +} + +impl FalFluxPro1p1CostState { + pub fn from_request(request: &FalFluxPro1p1RequestState) -> Self { + // Delegate to the fal_client cost calculator: $0.04 per image (1MP base). + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Matches v1: credits == cents (1:1 with USD cents). + ImageGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_text_to_image_webhook::{ + FluxPro11AspectRatio, FluxPro11NumImages, FluxPro11Request, + }; + + fn cost_for(n: FluxPro11NumImages) -> ImageGenerationCostEstimate { + let state = FalFluxPro1p1CostState::from_request(&FalFluxPro1p1RequestState { + request: FluxPro11Request { + prompt: "test".to_string(), + aspect_ratio: FluxPro11AspectRatio::Square, + num_images: n, + }, + }); + state.estimate_cost() + } + + #[test] + fn one_image_is_4_cents() { + assert_eq!(cost_for(FluxPro11NumImages::One).cost_in_usd_cents, Some(4)); + } + + #[test] + fn two_images_is_8_cents() { + assert_eq!(cost_for(FluxPro11NumImages::Two).cost_in_usd_cents, Some(8)); + } + + #[test] + fn three_images_is_12_cents() { + assert_eq!(cost_for(FluxPro11NumImages::Three).cost_in_usd_cents, Some(12)); + } + + #[test] + fn four_images_is_16_cents() { + assert_eq!(cost_for(FluxPro11NumImages::Four).cost_in_usd_cents, Some(16)); + } + + #[test] + fn credits_equal_cents() { + // v1 set cost_in_credits to the same USD cents value; preserve that. + let cost = cost_for(FluxPro11NumImages::Two); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + + #[test] + fn cost_flags_match_v1() { + let cost = cost_for(FluxPro11NumImages::One); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert!(cost.failures_are_refunded.is_none()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/mod.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/request.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/request.rs new file mode 100644 index 00000000..9d5b53a2 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1/request.rs @@ -0,0 +1,85 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_text_to_image_webhook::{ + enqueue_flux_pro_11_text_to_image_webhook, FluxPro11Args, FluxPro11Request, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalFluxPro1p1RequestState { + pub request: FluxPro11Request, +} + +impl FalFluxPro1p1RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let outbound: Arc = Arc::new(self.request.clone()); + let args = FluxPro11Args { + request: self.request.clone(), + webhook_url, + api_key: &client.api_key, + }; + let webhook_response = enqueue_flux_pro_11_text_to_image_webhook(args) + .await + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_text_to_image_webhook::{ + FluxPro11AspectRatio, FluxPro11NumImages, + }; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + fn t2i_state() -> FalFluxPro1p1RequestState { + FalFluxPro1p1RequestState { + request: FluxPro11Request { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + aspect_ratio: FluxPro11AspectRatio::LandscapeSixteenByNine, + num_images: FluxPro11NumImages::One, + }, + } + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let response = t2i_state().send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook t2i — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/build.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/build.rs new file mode 100644 index 00000000..316ebb1b --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/build.rs @@ -0,0 +1,283 @@ +use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_ultra_text_to_image_webhook::{ + FluxPro11UltraAspectRatio, FluxPro11UltraNumImages, FluxPro11UltraRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::flux_pro_1p1_ultra::request::FalFluxPro1p1UltraRequestState; + +pub fn build_fal_flux_pro_1p1_ultra( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Flux Pro 1.1 Ultra is text-to-image only. v1 hard-errors on any + // image_inputs (regardless of generation_mode_mismatch_strategy) — + // match that. + if builder.image_inputs.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "Flux Pro 1.1 Ultra is text-to-image only".to_string(), + })); + } + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + + let request = FluxPro11UltraRequest { + prompt: builder.prompt.clone().unwrap_or_default(), + aspect_ratio, + num_images, + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFluxPro1p1Ultra(FalFluxPro1p1UltraRequestState { request }), + )) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use FluxPro11UltraAspectRatio as Ar; + match aspect_ratio { + None => Ok(Ar::Square), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::Square), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square), + Some(RouterAspectRatio::WideFourByThree) => Ok(Ar::LandscapeFourByThree), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Ar::LandscapeThreeByTwo), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::LandscapeSixteenByNine), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Ar::LandscapeTwentyOneByNine), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Ar::PortraitThreeByFour), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Ar::PortraitTwoByThree), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::PortraitNineBySixteen), + Some(RouterAspectRatio::TallNineByTwentyOne) => Ok(Ar::PortraitNineByTwentyOne), + + Some(RouterAspectRatio::WideFiveByFour) => Ok(Ar::LandscapeFourByThree), + Some(RouterAspectRatio::TallFourByFive) => Ok(Ar::PortraitThreeByFour), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Ar::Square), + }, + } +} + +fn plan_num_images( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(FluxPro11UltraNumImages::One), + 2 => Ok(FluxPro11UltraNumImages::Two), + 3 => Ok(FluxPro11UltraNumImages::Three), + 4 => Ok(FluxPro11UltraNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(FluxPro11UltraNumImages::Four), + }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::FluxPro11Ultra, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_request(result: Result) -> FluxPro11UltraRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalFluxPro1p1Ultra(state) + ) = result.expect("build should succeed") else { + panic!("expected FalFluxPro1p1Ultra variant") + }; + state.request + } + + // ── Mode rejection ── + + #[test] + fn image_inputs_present_yields_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_pro_1p1_ultra(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. })) + )); + } + + // ── Prompt ── + + mod prompt_tests { + use super::*; + + #[test] + fn prompt_passed_through() { + let builder = GenerateImageRequestBuilder { + prompt: Some("my custom prompt".to_string()), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert_eq!(req.prompt, "my custom prompt"); + } + + #[test] + fn missing_prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { prompt: None, ..base_builder() }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert_eq!(req.prompt, ""); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn default_is_square() { + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(base_builder())); + assert!(matches!(req.aspect_ratio, FluxPro11UltraAspectRatio::Square)); + } + + #[test] + fn wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11UltraAspectRatio::LandscapeSixteenByNine)); + } + + #[test] + fn wide_three_by_two_has_direct_mapping() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideThreeByTwo), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11UltraAspectRatio::LandscapeThreeByTwo)); + } + + #[test] + fn tall_two_by_three_has_direct_mapping() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallTwoByThree), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11UltraAspectRatio::PortraitTwoByThree)); + } + + #[test] + fn wide_twenty_one_by_nine_has_direct_mapping() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11UltraAspectRatio::LandscapeTwentyOneByNine)); + } + + #[test] + fn square_hd_collapses_to_square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::SquareHd), + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert!(matches!(req.aspect_ratio, FluxPro11UltraAspectRatio::Square)); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(base_builder())); + assert!(matches!(req.num_images, FluxPro11UltraNumImages::One)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_pro_1p1_ultra(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(5), + ..base_builder() + }; + assert!(matches!( + build_fal_flux_pro_1p1_ultra(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_batch_count", .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_request(build_fal_flux_pro_1p1_ultra(builder)); + assert!(matches!(req.num_images, FluxPro11UltraNumImages::Four)); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/cost.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/cost.rs new file mode 100644 index 00000000..271fc222 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/cost.rs @@ -0,0 +1,85 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::flux_pro_1p1_ultra::request::FalFluxPro1p1UltraRequestState; + +pub struct FalFluxPro1p1UltraCostState { + cost_in_usd_cents: u64, +} + +impl FalFluxPro1p1UltraCostState { + pub fn from_request(request: &FalFluxPro1p1UltraRequestState) -> Self { + // Delegate to the fal_client cost calculator: $0.06 per image. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Matches v1: credits == cents (1:1 with USD cents). + ImageGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_ultra_text_to_image_webhook::{ + FluxPro11UltraAspectRatio, FluxPro11UltraNumImages, FluxPro11UltraRequest, + }; + + fn cost_for(n: FluxPro11UltraNumImages) -> ImageGenerationCostEstimate { + let state = FalFluxPro1p1UltraCostState::from_request(&FalFluxPro1p1UltraRequestState { + request: FluxPro11UltraRequest { + prompt: "test".to_string(), + aspect_ratio: FluxPro11UltraAspectRatio::Square, + num_images: n, + }, + }); + state.estimate_cost() + } + + #[test] + fn one_image_is_6_cents() { + assert_eq!(cost_for(FluxPro11UltraNumImages::One).cost_in_usd_cents, Some(6)); + } + + #[test] + fn two_images_is_12_cents() { + assert_eq!(cost_for(FluxPro11UltraNumImages::Two).cost_in_usd_cents, Some(12)); + } + + #[test] + fn three_images_is_18_cents() { + assert_eq!(cost_for(FluxPro11UltraNumImages::Three).cost_in_usd_cents, Some(18)); + } + + #[test] + fn four_images_is_24_cents() { + assert_eq!(cost_for(FluxPro11UltraNumImages::Four).cost_in_usd_cents, Some(24)); + } + + #[test] + fn credits_equal_cents() { + let cost = cost_for(FluxPro11UltraNumImages::Two); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + + #[test] + fn cost_flags_match_v1() { + let cost = cost_for(FluxPro11UltraNumImages::One); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert!(cost.failures_are_refunded.is_none()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/mod.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/request.rs b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/request.rs new file mode 100644 index 00000000..98611f36 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/flux_pro_1p1_ultra/request.rs @@ -0,0 +1,85 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_ultra_text_to_image_webhook::{ + enqueue_flux_pro_11_ultra_text_to_image_webhook, FluxPro11UltraArgs, FluxPro11UltraRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalFluxPro1p1UltraRequestState { + pub request: FluxPro11UltraRequest, +} + +impl FalFluxPro1p1UltraRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let outbound: Arc = Arc::new(self.request.clone()); + let args = FluxPro11UltraArgs { + request: self.request.clone(), + webhook_url, + api_key: &client.api_key, + }; + let webhook_response = enqueue_flux_pro_11_ultra_text_to_image_webhook(args) + .await + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests_old::webhook::image::text::enqueue_flux_pro_11_ultra_text_to_image_webhook::{ + FluxPro11UltraAspectRatio, FluxPro11UltraNumImages, + }; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + fn t2i_state() -> FalFluxPro1p1UltraRequestState { + FalFluxPro1p1UltraRequestState { + request: FluxPro11UltraRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + aspect_ratio: FluxPro11UltraAspectRatio::LandscapeSixteenByNine, + num_images: FluxPro11UltraNumImages::One, + }, + } + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let response = t2i_state().send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook t2i — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/build.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/build.rs new file mode 100644 index 00000000..37111d1d --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/build.rs @@ -0,0 +1,409 @@ +use fal_client::requests::api::image::edit::gpt_image_1_edit_image::api::{ + GptImage1EditImageNumImages, GptImage1EditImageQuality, GptImage1EditImageRequest, + GptImage1EditImageSize, +}; +use fal_client::requests::api::image::text::gpt_image_1_text_to_image::api::{ + GptImage1TextToImageNumImages, GptImage1TextToImageQuality, + GptImage1TextToImageRequest, GptImage1TextToImageSize, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::gpt_image_1::request::FalGptImage1RequestState; + +pub fn build_fal_gpt_image_1( + builder: GenerateImageRequestBuilder, +) -> Result { + let prompt = builder.prompt.clone().unwrap_or_default(); + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + let num_images = plan_num_images(builder.image_batch_count, builder.request_mismatch_mitigation_strategy)?; + let image_size = plan_image_size(builder.aspect_ratio); + let quality = plan_quality(builder.quality); + + let state = if image_urls.is_empty() { + FalGptImage1RequestState::TextToImage(GptImage1TextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + image_size: image_size.map(to_t2i_image_size), + quality: Some(to_t2i_quality(quality)), + background: None, + output_format: None, + }) + } else { + FalGptImage1RequestState::EditImage(GptImage1EditImageRequest { + prompt, + image_urls, + num_images: to_edit_num_images(num_images), + mask_image_url: None, + image_size: image_size.map(to_edit_image_size), + quality: Some(to_edit_quality(quality)), + input_fidelity: None, + background: None, + output_format: None, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage1(state), + )) +} + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +enum PlannedQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +enum PlannedImageSize { + Square, + Horizontal, + Vertical, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn plan_quality(quality: Option) -> PlannedQuality { + match quality { + Some(RouterQuality::Low) => PlannedQuality::Low, + Some(RouterQuality::Medium) => PlannedQuality::Medium, + Some(RouterQuality::High) | None => PlannedQuality::High, + } +} + +fn plan_image_size(aspect_ratio: Option) -> Option { + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => None, + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Some(PlannedImageSize::Square) + } + Some(RouterAspectRatio::WideThreeByTwo) + | Some(RouterAspectRatio::WideFourByThree) + | Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::WideSixteenByNine) + | Some(RouterAspectRatio::WideTwentyOneByNine) + | Some(RouterAspectRatio::Wide) => Some(PlannedImageSize::Horizontal), + Some(RouterAspectRatio::TallTwoByThree) + | Some(RouterAspectRatio::TallThreeByFour) + | Some(RouterAspectRatio::TallFourByFive) + | Some(RouterAspectRatio::TallNineBySixteen) + | Some(RouterAspectRatio::TallNineByTwentyOne) + | Some(RouterAspectRatio::Tall) => Some(PlannedImageSize::Vertical), + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> GptImage1TextToImageNumImages { + match n { + PlannedNumImages::One => GptImage1TextToImageNumImages::One, + PlannedNumImages::Two => GptImage1TextToImageNumImages::Two, + PlannedNumImages::Three => GptImage1TextToImageNumImages::Three, + PlannedNumImages::Four => GptImage1TextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> GptImage1EditImageNumImages { + match n { + PlannedNumImages::One => GptImage1EditImageNumImages::One, + PlannedNumImages::Two => GptImage1EditImageNumImages::Two, + PlannedNumImages::Three => GptImage1EditImageNumImages::Three, + PlannedNumImages::Four => GptImage1EditImageNumImages::Four, + } +} + +fn to_t2i_quality(q: PlannedQuality) -> GptImage1TextToImageQuality { + match q { + PlannedQuality::Low => GptImage1TextToImageQuality::Low, + PlannedQuality::Medium => GptImage1TextToImageQuality::Medium, + PlannedQuality::High => GptImage1TextToImageQuality::High, + } +} + +fn to_edit_quality(q: PlannedQuality) -> GptImage1EditImageQuality { + match q { + PlannedQuality::Low => GptImage1EditImageQuality::Low, + PlannedQuality::Medium => GptImage1EditImageQuality::Medium, + PlannedQuality::High => GptImage1EditImageQuality::High, + } +} + +fn to_t2i_image_size(s: PlannedImageSize) -> GptImage1TextToImageSize { + match s { + PlannedImageSize::Square => GptImage1TextToImageSize::Square, + PlannedImageSize::Horizontal => GptImage1TextToImageSize::Horizontal, + PlannedImageSize::Vertical => GptImage1TextToImageSize::Vertical, + } +} + +fn to_edit_image_size(s: PlannedImageSize) -> GptImage1EditImageSize { + match s { + PlannedImageSize::Square => GptImage1EditImageSize::Square, + PlannedImageSize::Horizontal => GptImage1EditImageSize::Horizontal, + PlannedImageSize::Vertical => GptImage1EditImageSize::Vertical, + } +} + +fn resolve_image_urls( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::fmt::Debug; + + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage1, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> GptImage1TextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage1( + FalGptImage1RequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected GPT Image 1 text-to-image request") + }; + req + } + + fn unwrap_edit(result: Result) -> GptImage1EditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage1( + FalGptImage1RequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected GPT Image 1 edit-image request") + }; + req + } + + fn assert_debug(actual: T, expected: &str) { + assert_eq!(format!("{:?}", actual), expected); + } + + #[test] + fn build2_routes_to_gpt_image_1_request() { + let req = unwrap_t2i(base_builder().build2()); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn mode_detection_is_based_on_image_urls() { + let text_req = unwrap_t2i(build_fal_gpt_image_1(base_builder())); + assert_eq!(text_req.prompt, "a cat in space"); + + let edit_req = unwrap_edit(build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + })); + assert_eq!(edit_req.image_urls, vec!["https://example.com/img.jpg"]); + } + + #[test] + fn media_file_tokens_are_rejected() { + let result = build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn num_images_maps_exhaustively_for_text_and_edit() { + let text_cases = [ + (1, "One"), + (2, "Two"), + (3, "Three"), + (4, "Four"), + ]; + + for (count, expected) in text_cases { + let req = unwrap_t2i(build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_batch_count: Some(count), + ..base_builder() + })); + assert_debug(req.num_images, expected); + } + + for (count, expected) in text_cases { + let req = unwrap_edit(build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(count), + ..base_builder() + })); + assert_debug(req.num_images, expected); + } + } + + #[test] + fn num_images_rejects_zero_and_handles_overflow_by_strategy() { + assert!(matches!( + build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + assert!(matches!( + build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_batch_count: Some(5), + ..base_builder() + }), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + + let req = unwrap_t2i(build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_batch_count: Some(5), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + })); + assert_debug(req.num_images, "Four"); + } + + #[test] + fn quality_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "Some(High)"), + (Some(RouterQuality::Low), "Some(Low)"), + (Some(RouterQuality::Medium), "Some(Medium)"), + (Some(RouterQuality::High), "Some(High)"), + ]; + + for (quality, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_1(GenerateImageRequestBuilder { + quality, + ..base_builder() + })); + assert_debug(req.quality, expected); + } + + for (quality, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + quality, + ..base_builder() + })); + assert_debug(req.quality, expected); + } + } + + #[test] + fn aspect_ratio_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "None"), + (Some(RouterAspectRatio::Auto), "None"), + (Some(RouterAspectRatio::Auto2k), "None"), + (Some(RouterAspectRatio::Auto3k), "None"), + (Some(RouterAspectRatio::Auto4k), "None"), + (Some(RouterAspectRatio::Square), "Some(Square)"), + (Some(RouterAspectRatio::SquareHd), "Some(Square)"), + (Some(RouterAspectRatio::WideThreeByTwo), "Some(Horizontal)"), + (Some(RouterAspectRatio::WideFourByThree), "Some(Horizontal)"), + (Some(RouterAspectRatio::WideFiveByFour), "Some(Horizontal)"), + (Some(RouterAspectRatio::WideSixteenByNine), "Some(Horizontal)"), + (Some(RouterAspectRatio::WideTwentyOneByNine), "Some(Horizontal)"), + (Some(RouterAspectRatio::Wide), "Some(Horizontal)"), + (Some(RouterAspectRatio::TallTwoByThree), "Some(Vertical)"), + (Some(RouterAspectRatio::TallThreeByFour), "Some(Vertical)"), + (Some(RouterAspectRatio::TallFourByFive), "Some(Vertical)"), + (Some(RouterAspectRatio::TallNineBySixteen), "Some(Vertical)"), + (Some(RouterAspectRatio::TallNineByTwentyOne), "Some(Vertical)"), + (Some(RouterAspectRatio::Tall), "Some(Vertical)"), + ]; + + for (aspect_ratio, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_1(GenerateImageRequestBuilder { + aspect_ratio, + ..base_builder() + })); + assert_debug(req.image_size, expected); + } + + for (aspect_ratio, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_1(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + aspect_ratio, + ..base_builder() + })); + assert_debug(req.image_size, expected); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/cost.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/cost.rs new file mode 100644 index 00000000..c18351a5 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/cost.rs @@ -0,0 +1,210 @@ +use fal_client::requests::api::image::edit::gpt_image_1_edit_image::api::{ + GptImage1EditImageNumImages, GptImage1EditImageQuality, GptImage1EditImageSize, +}; +use fal_client::requests::api::image::text::gpt_image_1_text_to_image::api::{ + GptImage1TextToImageNumImages, GptImage1TextToImageQuality, GptImage1TextToImageSize, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::gpt_image_1::request::FalGptImage1RequestState; + +/// Cost state for Fal GPT Image 1. Mirrors v1 +/// (`estimate_image_cost_fal_gpt_image_1`): +/// +/// Output image cost (per output image): +/// Low: 2¢ all sizes +/// Medium: 5¢ square, 7¢ wide/tall +/// High: 17¢ square, 25¢ wide/tall +/// +/// Plus 2¢ per input image in edit mode (high-fidelity estimate). +/// Quality defaults to High when unspecified. +/// +/// The hand-rolled rates here intentionally override fal_client's trait +/// (which uses Medium as the default and omits the input-image fee). Keep +/// in sync with the v1 cost file. +#[derive(Clone, Debug)] +pub struct FalGptImage1CostState { + request: FalGptImage1RequestState, +} + +impl FalGptImage1CostState { + pub fn from_request(request: &FalGptImage1RequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = match &self.request { + FalGptImage1RequestState::TextToImage(req) => { + cost_t2i(req.quality, req.image_size, req.num_images) + } + FalGptImage1RequestState::EditImage(req) => { + let output_cost = cost_edit_output(req.quality, req.image_size, req.num_images); + let input_cost = 2 * req.image_urls.len() as u64; + output_cost + input_cost + } + }; + + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn cost_t2i( + quality: Option, + image_size: Option, + num_images: GptImage1TextToImageNumImages, +) -> u64 { + use GptImage1TextToImageQuality as Q; + use GptImage1TextToImageSize as S; + let q = quality.unwrap_or(Q::High); + let is_square = matches!(image_size, None | Some(S::Square)); + let per_image = output_cost(matches!(q, Q::Low), matches!(q, Q::Medium), is_square); + per_image * t2i_num_images(num_images) +} + +fn cost_edit_output( + quality: Option, + image_size: Option, + num_images: GptImage1EditImageNumImages, +) -> u64 { + use GptImage1EditImageQuality as Q; + use GptImage1EditImageSize as S; + let q = quality.unwrap_or(Q::High); + let is_square = matches!(image_size, None | Some(S::Square)); + let per_image = output_cost(matches!(q, Q::Low), matches!(q, Q::Medium), is_square); + per_image * edit_num_images(num_images) +} + +fn output_cost(is_low: bool, is_medium: bool, is_square: bool) -> u64 { + if is_low { + 2 + } else if is_medium { + if is_square { 5 } else { 7 } + } else { + // High (default) + if is_square { 17 } else { 25 } + } +} + +fn t2i_num_images(n: GptImage1TextToImageNumImages) -> u64 { + match n { + GptImage1TextToImageNumImages::One => 1, + GptImage1TextToImageNumImages::Two => 2, + GptImage1TextToImageNumImages::Three => 3, + GptImage1TextToImageNumImages::Four => 4, + } +} + +fn edit_num_images(n: GptImage1EditImageNumImages) -> u64 { + match n { + GptImage1EditImageNumImages::One => 1, + GptImage1EditImageNumImages::Two => 2, + GptImage1EditImageNumImages::Three => 3, + GptImage1EditImageNumImages::Four => 4, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; + use fal_client::requests::api::image::edit::gpt_image_1_edit_image::api::{GptImage1EditImageNumImages, GptImage1EditImageQuality, GptImage1EditImageRequest, GptImage1EditImageSize}; + use fal_client::requests::api::image::text::gpt_image_1_text_to_image::api::{GptImage1TextToImageNumImages, GptImage1TextToImageQuality, GptImage1TextToImageRequest, GptImage1TextToImageSize}; + + #[test] + fn text_to_image_cost_table_covers_quality_size_and_count() { + for (quality, image_size, expected_by_count) in text_to_image_price_cases() { + for (num_images, expected) in text_to_image_num_image_cases(expected_by_count) { + let request = FalGptImage1RequestState::TextToImage(GptImage1TextToImageRequest { prompt: "test".to_string(), num_images, image_size, quality, background: None, output_format: None }); + let cost = FalGptImage1CostState::from_request(&request).estimate_cost(); + assert_standard_cost_estimate(cost, expected); + } + } + } + + #[test] + fn edit_image_cost_table_covers_quality_size_and_count() { + for (quality, image_size, expected_by_count) in edit_image_price_cases() { + for (num_images, expected) in edit_image_num_image_cases(expected_by_count) { + let request = FalGptImage1RequestState::EditImage(GptImage1EditImageRequest { prompt: "test".to_string(), image_urls: vec!["https://example.com/image.png".to_string()], num_images, mask_image_url: None, image_size, quality, input_fidelity: None, background: None, output_format: None }); + let cost = FalGptImage1CostState::from_request(&request).estimate_cost(); + assert_standard_cost_estimate(cost, expected); + } + } + } + + // Tables encode v1's pricing semantics: + // - Quality defaults to High when unspecified. + // - is_square = matches!(image_size, None | Some(Square)). Auto, Horizontal, + // and Vertical are treated as non-square. + // - Low is 2¢ for every size; Medium and High differ by square vs non-square. + // Edit-mode rows additionally include a +2¢ input-image fee (one input URL + // in the make_edit helper below). + fn text_to_image_price_cases() -> [(Option, Option, [u64; 4]); 13] { + [ + // Default quality (None → High) + default size (None → square). + (None, None, [17, 34, 51, 68]), + // Low: flat 2¢ regardless of size. + (Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Auto), [2, 4, 6, 8]), + (Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Square), [2, 4, 6, 8]), + (Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Horizontal), [2, 4, 6, 8]), + (Some(GptImage1TextToImageQuality::Low), Some(GptImage1TextToImageSize::Vertical), [2, 4, 6, 8]), + // Medium: 5¢ square, 7¢ non-square. + (Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Auto), [7, 14, 21, 28]), + (Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Square), [5, 10, 15, 20]), + (Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Horizontal), [7, 14, 21, 28]), + (Some(GptImage1TextToImageQuality::Medium), Some(GptImage1TextToImageSize::Vertical), [7, 14, 21, 28]), + // High: 17¢ square, 25¢ non-square. + (Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Auto), [25, 50, 75, 100]), + (Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Square), [17, 34, 51, 68]), + (Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Horizontal), [25, 50, 75, 100]), + (Some(GptImage1TextToImageQuality::High), Some(GptImage1TextToImageSize::Vertical), [25, 50, 75, 100]), + ] + } + + // Each edit-mode row is t2i row + 2¢ (single input image — see make_edit + // below). Numbers are constant +2 because input fee scales with input count, + // not output count. + fn edit_image_price_cases() -> [(Option, Option, [u64; 4]); 13] { + [ + (None, None, [19, 36, 53, 70]), + (Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Auto), [4, 6, 8, 10]), + (Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Square), [4, 6, 8, 10]), + (Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Horizontal), [4, 6, 8, 10]), + (Some(GptImage1EditImageQuality::Low), Some(GptImage1EditImageSize::Vertical), [4, 6, 8, 10]), + (Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Auto), [9, 16, 23, 30]), + (Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Square), [7, 12, 17, 22]), + (Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Horizontal), [9, 16, 23, 30]), + (Some(GptImage1EditImageQuality::Medium), Some(GptImage1EditImageSize::Vertical), [9, 16, 23, 30]), + (Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Auto), [27, 52, 77, 102]), + (Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Square), [19, 36, 53, 70]), + (Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Horizontal), [27, 52, 77, 102]), + (Some(GptImage1EditImageQuality::High), Some(GptImage1EditImageSize::Vertical), [27, 52, 77, 102]), + ] + } + + fn text_to_image_num_image_cases(expected_by_count: [u64; 4]) -> [(GptImage1TextToImageNumImages, u64); 4] { + [(GptImage1TextToImageNumImages::One, expected_by_count[0]), (GptImage1TextToImageNumImages::Two, expected_by_count[1]), (GptImage1TextToImageNumImages::Three, expected_by_count[2]), (GptImage1TextToImageNumImages::Four, expected_by_count[3])] + } + + fn edit_image_num_image_cases(expected_by_count: [u64; 4]) -> [(GptImage1EditImageNumImages, u64); 4] { + [(GptImage1EditImageNumImages::One, expected_by_count[0]), (GptImage1EditImageNumImages::Two, expected_by_count[1]), (GptImage1EditImageNumImages::Three, expected_by_count[2]), (GptImage1EditImageNumImages::Four, expected_by_count[3])] + } + + fn assert_standard_cost_estimate(cost: ImageGenerationCostEstimate, expected_usd_cents: u64) { + assert_eq!(cost.cost_in_usd_cents, Some(expected_usd_cents)); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/mod.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/request.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/request.rs new file mode 100644 index 00000000..ec24a46c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1/request.rs @@ -0,0 +1,128 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::gpt_image_1_edit_image::api::GptImage1EditImageRequest; +use fal_client::requests::api::image::text::gpt_image_1_text_to_image::api::GptImage1TextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{FalImageResponsePayload, GenerateImageResponse}; + +#[derive(Clone, Debug)] +pub enum FalGptImage1RequestState { + TextToImage(GptImage1TextToImageRequest), + EditImage(GptImage1EditImageRequest), +} + +impl FalGptImage1RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => send_request(request, client).await, + Self::EditImage(request) => send_request(request, client).await, + } + } +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::edit::gpt_image_1_edit_image::api::{ + GptImage1EditImageNumImages, GptImage1EditImageQuality, GptImage1EditImageSize, + }; + use fal_client::requests::api::image::text::gpt_image_1_text_to_image::api::{ + GptImage1TextToImageNumImages, GptImage1TextToImageQuality, + GptImage1TextToImageSize, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn client_with_webhook() -> RouterFalClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + RouterFalClient::new_with_webhook( + FalApiKey::from_str(secret.trim()), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_image_webhook() { + let request = FalGptImage1RequestState::TextToImage(GptImage1TextToImageRequest { + prompt: "a small ceramic robot reading by a window".to_string(), + num_images: GptImage1TextToImageNumImages::One, + image_size: Some(GptImage1TextToImageSize::Square), + quality: Some(GptImage1TextToImageQuality::Low), + background: None, + output_format: None, + }); + let response = request.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_edit_image_webhook() { + let request = FalGptImage1RequestState::EditImage(GptImage1EditImageRequest { + prompt: "make the image feel like a quiet watercolor study".to_string(), + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + num_images: GptImage1EditImageNumImages::One, + mask_image_url: None, + image_size: Some(GptImage1EditImageSize::Square), + quality: Some(GptImage1EditImageQuality::Low), + input_fidelity: None, + background: None, + output_format: None, + }); + let response = request.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/build.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/build.rs new file mode 100644 index 00000000..449eb7c0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/build.rs @@ -0,0 +1,409 @@ +use fal_client::requests::api::image::edit::gpt_image_1p5_edit_image::api::{ + GptImage1p5EditImageNumImages, GptImage1p5EditImageQuality, + GptImage1p5EditImageRequest, GptImage1p5EditImageSize, +}; +use fal_client::requests::api::image::text::gpt_image_1p5_text_to_image::api::{ + GptImage1p5TextToImageNumImages, GptImage1p5TextToImageQuality, + GptImage1p5TextToImageRequest, GptImage1p5TextToImageSize, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::gpt_image_1p5::request::FalGptImage1p5RequestState; + +pub fn build_fal_gpt_image_1p5( + builder: GenerateImageRequestBuilder, +) -> Result { + let prompt = builder.prompt.clone().unwrap_or_default(); + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + let num_images = plan_num_images(builder.image_batch_count, builder.request_mismatch_mitigation_strategy)?; + let image_size = plan_image_size(builder.aspect_ratio); + let quality = plan_quality(builder.quality); + + let state = if image_urls.is_empty() { + FalGptImage1p5RequestState::TextToImage(GptImage1p5TextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + image_size: image_size.map(to_t2i_image_size), + background: None, + quality: Some(to_t2i_quality(quality)), + output_format: None, + }) + } else { + FalGptImage1p5RequestState::EditImage(GptImage1p5EditImageRequest { + prompt, + image_urls, + num_images: to_edit_num_images(num_images), + mask_image_url: None, + image_size: image_size.map(to_edit_image_size), + background: None, + quality: Some(to_edit_quality(quality)), + input_fidelity: None, + output_format: None, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage1p5(state), + )) +} + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +enum PlannedQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +enum PlannedImageSize { + Square, + Wide, + Tall, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn plan_quality(quality: Option) -> PlannedQuality { + match quality { + Some(RouterQuality::Low) => PlannedQuality::Low, + Some(RouterQuality::Medium) => PlannedQuality::Medium, + Some(RouterQuality::High) | None => PlannedQuality::High, + } +} + +fn plan_image_size(aspect_ratio: Option) -> Option { + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => None, + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Some(PlannedImageSize::Square) + } + Some(RouterAspectRatio::WideThreeByTwo) + | Some(RouterAspectRatio::WideFourByThree) + | Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::WideSixteenByNine) + | Some(RouterAspectRatio::WideTwentyOneByNine) + | Some(RouterAspectRatio::Wide) => Some(PlannedImageSize::Wide), + Some(RouterAspectRatio::TallTwoByThree) + | Some(RouterAspectRatio::TallThreeByFour) + | Some(RouterAspectRatio::TallFourByFive) + | Some(RouterAspectRatio::TallNineBySixteen) + | Some(RouterAspectRatio::TallNineByTwentyOne) + | Some(RouterAspectRatio::Tall) => Some(PlannedImageSize::Tall), + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> GptImage1p5TextToImageNumImages { + match n { + PlannedNumImages::One => GptImage1p5TextToImageNumImages::One, + PlannedNumImages::Two => GptImage1p5TextToImageNumImages::Two, + PlannedNumImages::Three => GptImage1p5TextToImageNumImages::Three, + PlannedNumImages::Four => GptImage1p5TextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> GptImage1p5EditImageNumImages { + match n { + PlannedNumImages::One => GptImage1p5EditImageNumImages::One, + PlannedNumImages::Two => GptImage1p5EditImageNumImages::Two, + PlannedNumImages::Three => GptImage1p5EditImageNumImages::Three, + PlannedNumImages::Four => GptImage1p5EditImageNumImages::Four, + } +} + +fn to_t2i_quality(q: PlannedQuality) -> GptImage1p5TextToImageQuality { + match q { + PlannedQuality::Low => GptImage1p5TextToImageQuality::Low, + PlannedQuality::Medium => GptImage1p5TextToImageQuality::Medium, + PlannedQuality::High => GptImage1p5TextToImageQuality::High, + } +} + +fn to_edit_quality(q: PlannedQuality) -> GptImage1p5EditImageQuality { + match q { + PlannedQuality::Low => GptImage1p5EditImageQuality::Low, + PlannedQuality::Medium => GptImage1p5EditImageQuality::Medium, + PlannedQuality::High => GptImage1p5EditImageQuality::High, + } +} + +fn to_t2i_image_size(s: PlannedImageSize) -> GptImage1p5TextToImageSize { + match s { + PlannedImageSize::Square => GptImage1p5TextToImageSize::Square, + PlannedImageSize::Wide => GptImage1p5TextToImageSize::Wide, + PlannedImageSize::Tall => GptImage1p5TextToImageSize::Tall, + } +} + +fn to_edit_image_size(s: PlannedImageSize) -> GptImage1p5EditImageSize { + match s { + PlannedImageSize::Square => GptImage1p5EditImageSize::Square, + PlannedImageSize::Wide => GptImage1p5EditImageSize::Wide, + PlannedImageSize::Tall => GptImage1p5EditImageSize::Tall, + } +} + +fn resolve_image_urls( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::fmt::Debug; + + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage1p5, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> GptImage1p5TextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage1p5( + FalGptImage1p5RequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected GPT Image 1.5 text-to-image request") + }; + req + } + + fn unwrap_edit(result: Result) -> GptImage1p5EditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage1p5( + FalGptImage1p5RequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected GPT Image 1.5 edit-image request") + }; + req + } + + fn assert_debug(actual: T, expected: &str) { + assert_eq!(format!("{:?}", actual), expected); + } + + #[test] + fn build2_routes_to_gpt_image_1p5_request() { + let req = unwrap_t2i(base_builder().build2()); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn mode_detection_is_based_on_image_urls() { + let text_req = unwrap_t2i(build_fal_gpt_image_1p5(base_builder())); + assert_eq!(text_req.prompt, "a cat in space"); + + let edit_req = unwrap_edit(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + })); + assert_eq!(edit_req.image_urls, vec!["https://example.com/img.jpg"]); + } + + #[test] + fn media_file_tokens_are_rejected() { + let result = build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn num_images_maps_exhaustively_for_text_and_edit() { + let cases = [ + (1, "One"), + (2, "Two"), + (3, "Three"), + (4, "Four"), + ]; + + for (count, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_batch_count: Some(count), + ..base_builder() + })); + assert_debug(req.num_images, expected); + } + + for (count, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(count), + ..base_builder() + })); + assert_debug(req.num_images, expected); + } + } + + #[test] + fn num_images_rejects_zero_and_handles_overflow_by_strategy() { + assert!(matches!( + build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + assert!(matches!( + build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_batch_count: Some(5), + ..base_builder() + }), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + + let req = unwrap_t2i(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_batch_count: Some(5), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + })); + assert_debug(req.num_images, "Four"); + } + + #[test] + fn quality_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "Some(High)"), + (Some(RouterQuality::Low), "Some(Low)"), + (Some(RouterQuality::Medium), "Some(Medium)"), + (Some(RouterQuality::High), "Some(High)"), + ]; + + for (quality, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + quality, + ..base_builder() + })); + assert_debug(req.quality, expected); + } + + for (quality, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + quality, + ..base_builder() + })); + assert_debug(req.quality, expected); + } + } + + #[test] + fn aspect_ratio_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "None"), + (Some(RouterAspectRatio::Auto), "None"), + (Some(RouterAspectRatio::Auto2k), "None"), + (Some(RouterAspectRatio::Auto3k), "None"), + (Some(RouterAspectRatio::Auto4k), "None"), + (Some(RouterAspectRatio::Square), "Some(Square)"), + (Some(RouterAspectRatio::SquareHd), "Some(Square)"), + (Some(RouterAspectRatio::WideThreeByTwo), "Some(Wide)"), + (Some(RouterAspectRatio::WideFourByThree), "Some(Wide)"), + (Some(RouterAspectRatio::WideFiveByFour), "Some(Wide)"), + (Some(RouterAspectRatio::WideSixteenByNine), "Some(Wide)"), + (Some(RouterAspectRatio::WideTwentyOneByNine), "Some(Wide)"), + (Some(RouterAspectRatio::Wide), "Some(Wide)"), + (Some(RouterAspectRatio::TallTwoByThree), "Some(Tall)"), + (Some(RouterAspectRatio::TallThreeByFour), "Some(Tall)"), + (Some(RouterAspectRatio::TallFourByFive), "Some(Tall)"), + (Some(RouterAspectRatio::TallNineBySixteen), "Some(Tall)"), + (Some(RouterAspectRatio::TallNineByTwentyOne), "Some(Tall)"), + (Some(RouterAspectRatio::Tall), "Some(Tall)"), + ]; + + for (aspect_ratio, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + aspect_ratio, + ..base_builder() + })); + assert_debug(req.image_size, expected); + } + + for (aspect_ratio, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_1p5(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + aspect_ratio, + ..base_builder() + })); + assert_debug(req.image_size, expected); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/cost.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/cost.rs new file mode 100644 index 00000000..c1542d0d --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/cost.rs @@ -0,0 +1,206 @@ +use fal_client::requests::api::image::edit::gpt_image_1p5_edit_image::api::{ + GptImage1p5EditImageNumImages, GptImage1p5EditImageQuality, GptImage1p5EditImageSize, +}; +use fal_client::requests::api::image::text::gpt_image_1p5_text_to_image::api::{ + GptImage1p5TextToImageNumImages, GptImage1p5TextToImageQuality, GptImage1p5TextToImageSize, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::gpt_image_1p5::request::FalGptImage1p5RequestState; + +/// Cost state for Fal GPT Image 1.5. Mirrors v1 +/// (`estimate_image_cost_fal_gpt_image_1p5`): +/// +/// Output image cost (per output image), rounded up to whole cents: +/// Low: 1¢ square, 2¢ wide/tall +/// Medium: 4¢ square, 5¢ wide, 6¢ tall +/// High: 14¢ square, 20¢ wide/tall +/// +/// Quality defaults to High when unspecified. +/// +/// The hand-rolled rates here intentionally override fal_client's trait, +/// which rounds $0.133→13¢ for High+Square (v1 rounds up to 14¢) and +/// flattens Medium wide/tall to a single value. Keep in sync with v1. +#[derive(Clone, Debug)] +pub struct FalGptImage1p5CostState { + request: FalGptImage1p5RequestState, +} + +impl FalGptImage1p5CostState { + pub fn from_request(request: &FalGptImage1p5RequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = match &self.request { + FalGptImage1p5RequestState::TextToImage(req) => { + cost_t2i(req.quality, req.image_size, req.num_images) + } + FalGptImage1p5RequestState::EditImage(req) => { + cost_edit(req.quality, req.image_size, req.num_images) + } + }; + + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[derive(Copy, Clone)] +enum SizeBucket { Square, Wide, Tall } + +fn cost_t2i( + quality: Option, + image_size: Option, + num_images: GptImage1p5TextToImageNumImages, +) -> u64 { + use GptImage1p5TextToImageQuality as Q; + use GptImage1p5TextToImageSize as S; + let q = quality.unwrap_or(Q::High); + let bucket = match image_size { + None | Some(S::Square) => SizeBucket::Square, + Some(S::Wide) => SizeBucket::Wide, + Some(S::Tall) => SizeBucket::Tall, + }; + let per_image = output_cost(matches!(q, Q::Low), matches!(q, Q::Medium), bucket); + per_image * t2i_num_images(num_images) +} + +fn cost_edit( + quality: Option, + image_size: Option, + num_images: GptImage1p5EditImageNumImages, +) -> u64 { + use GptImage1p5EditImageQuality as Q; + use GptImage1p5EditImageSize as S; + let q = quality.unwrap_or(Q::High); + let bucket = match image_size { + None | Some(S::Square) => SizeBucket::Square, + Some(S::Wide) => SizeBucket::Wide, + Some(S::Tall) => SizeBucket::Tall, + }; + let per_image = output_cost(matches!(q, Q::Low), matches!(q, Q::Medium), bucket); + per_image * edit_num_images(num_images) +} + +fn output_cost(is_low: bool, is_medium: bool, bucket: SizeBucket) -> u64 { + if is_low { + match bucket { SizeBucket::Square => 1, _ => 2 } + } else if is_medium { + match bucket { + SizeBucket::Square => 4, + SizeBucket::Wide => 5, + SizeBucket::Tall => 6, + } + } else { + // High (default) + match bucket { SizeBucket::Square => 14, _ => 20 } + } +} + +fn t2i_num_images(n: GptImage1p5TextToImageNumImages) -> u64 { + match n { + GptImage1p5TextToImageNumImages::One => 1, + GptImage1p5TextToImageNumImages::Two => 2, + GptImage1p5TextToImageNumImages::Three => 3, + GptImage1p5TextToImageNumImages::Four => 4, + } +} + +fn edit_num_images(n: GptImage1p5EditImageNumImages) -> u64 { + match n { + GptImage1p5EditImageNumImages::One => 1, + GptImage1p5EditImageNumImages::Two => 2, + GptImage1p5EditImageNumImages::Three => 3, + GptImage1p5EditImageNumImages::Four => 4, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; + use fal_client::requests::api::image::edit::gpt_image_1p5_edit_image::api::{GptImage1p5EditImageNumImages, GptImage1p5EditImageQuality, GptImage1p5EditImageRequest, GptImage1p5EditImageSize}; + use fal_client::requests::api::image::text::gpt_image_1p5_text_to_image::api::{GptImage1p5TextToImageNumImages, GptImage1p5TextToImageQuality, GptImage1p5TextToImageRequest, GptImage1p5TextToImageSize}; + + #[test] + fn text_to_image_cost_table_covers_quality_size_and_count() { + for (quality, image_size, expected_by_count) in text_to_image_price_cases() { + for (num_images, expected) in text_to_image_num_image_cases(expected_by_count) { + let request = FalGptImage1p5RequestState::TextToImage(GptImage1p5TextToImageRequest { prompt: "test".to_string(), num_images, image_size, background: None, quality, output_format: None }); + let cost = FalGptImage1p5CostState::from_request(&request).estimate_cost(); + assert_standard_cost_estimate(cost, expected); + } + } + } + + #[test] + fn edit_image_cost_table_covers_quality_size_and_count() { + for (quality, image_size, expected_by_count) in edit_image_price_cases() { + for (num_images, expected) in edit_image_num_image_cases(expected_by_count) { + let request = FalGptImage1p5RequestState::EditImage(GptImage1p5EditImageRequest { prompt: "test".to_string(), image_urls: vec!["https://example.com/image.png".to_string()], num_images, mask_image_url: None, image_size, background: None, quality, input_fidelity: None, output_format: None }); + let cost = FalGptImage1p5CostState::from_request(&request).estimate_cost(); + assert_standard_cost_estimate(cost, expected); + } + } + } + + // v1 rates: Low=1/2 (sq/wide-tall), Medium=4/5/6 (sq/wide/tall), + // High=14/20/20 (sq/wide/tall). Default quality is High. + fn text_to_image_price_cases() -> [(Option, Option, [u64; 4]); 10] { + [ + (None, None, [14, 28, 42, 56]), + (Some(GptImage1p5TextToImageQuality::Low), Some(GptImage1p5TextToImageSize::Square), [1, 2, 3, 4]), + (Some(GptImage1p5TextToImageQuality::Low), Some(GptImage1p5TextToImageSize::Wide), [2, 4, 6, 8]), + (Some(GptImage1p5TextToImageQuality::Low), Some(GptImage1p5TextToImageSize::Tall), [2, 4, 6, 8]), + (Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Square), [4, 8, 12, 16]), + (Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Wide), [5, 10, 15, 20]), + (Some(GptImage1p5TextToImageQuality::Medium), Some(GptImage1p5TextToImageSize::Tall), [6, 12, 18, 24]), + (Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Square), [14, 28, 42, 56]), + (Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Wide), [20, 40, 60, 80]), + (Some(GptImage1p5TextToImageQuality::High), Some(GptImage1p5TextToImageSize::Tall), [20, 40, 60, 80]), + ] + } + + // Edit-mode pricing is identical to t2i (v1 has no input-image fee for + // gpt_image_1p5 — that's only gpt_image_1). + fn edit_image_price_cases() -> [(Option, Option, [u64; 4]); 10] { + [ + (None, None, [14, 28, 42, 56]), + (Some(GptImage1p5EditImageQuality::Low), Some(GptImage1p5EditImageSize::Square), [1, 2, 3, 4]), + (Some(GptImage1p5EditImageQuality::Low), Some(GptImage1p5EditImageSize::Wide), [2, 4, 6, 8]), + (Some(GptImage1p5EditImageQuality::Low), Some(GptImage1p5EditImageSize::Tall), [2, 4, 6, 8]), + (Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Square), [4, 8, 12, 16]), + (Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Wide), [5, 10, 15, 20]), + (Some(GptImage1p5EditImageQuality::Medium), Some(GptImage1p5EditImageSize::Tall), [6, 12, 18, 24]), + (Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Square), [14, 28, 42, 56]), + (Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Wide), [20, 40, 60, 80]), + (Some(GptImage1p5EditImageQuality::High), Some(GptImage1p5EditImageSize::Tall), [20, 40, 60, 80]), + ] + } + + fn text_to_image_num_image_cases(expected_by_count: [u64; 4]) -> [(GptImage1p5TextToImageNumImages, u64); 4] { + [(GptImage1p5TextToImageNumImages::One, expected_by_count[0]), (GptImage1p5TextToImageNumImages::Two, expected_by_count[1]), (GptImage1p5TextToImageNumImages::Three, expected_by_count[2]), (GptImage1p5TextToImageNumImages::Four, expected_by_count[3])] + } + + fn edit_image_num_image_cases(expected_by_count: [u64; 4]) -> [(GptImage1p5EditImageNumImages, u64); 4] { + [(GptImage1p5EditImageNumImages::One, expected_by_count[0]), (GptImage1p5EditImageNumImages::Two, expected_by_count[1]), (GptImage1p5EditImageNumImages::Three, expected_by_count[2]), (GptImage1p5EditImageNumImages::Four, expected_by_count[3])] + } + + fn assert_standard_cost_estimate(cost: ImageGenerationCostEstimate, expected_usd_cents: u64) { + assert_eq!(cost.cost_in_usd_cents, Some(expected_usd_cents)); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/mod.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/request.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/request.rs new file mode 100644 index 00000000..4f69c13b --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_1p5/request.rs @@ -0,0 +1,129 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::gpt_image_1p5_edit_image::api::GptImage1p5EditImageRequest; +use fal_client::requests::api::image::text::gpt_image_1p5_text_to_image::api::GptImage1p5TextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{FalImageResponsePayload, GenerateImageResponse}; + +#[derive(Clone, Debug)] +pub enum FalGptImage1p5RequestState { + TextToImage(GptImage1p5TextToImageRequest), + EditImage(GptImage1p5EditImageRequest), +} + +impl FalGptImage1p5RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => send_request(request, client).await, + Self::EditImage(request) => send_request(request, client).await, + } + } +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::edit::gpt_image_1p5_edit_image::api::{ + GptImage1p5EditImageNumImages, GptImage1p5EditImageQuality, + GptImage1p5EditImageSize, + }; + use fal_client::requests::api::image::text::gpt_image_1p5_text_to_image::api::{ + GptImage1p5TextToImageNumImages, GptImage1p5TextToImageQuality, + GptImage1p5TextToImageSize, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn client_with_webhook() -> RouterFalClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + RouterFalClient::new_with_webhook( + FalApiKey::from_str(secret.trim()), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_image_webhook() { + let request = FalGptImage1p5RequestState::TextToImage(GptImage1p5TextToImageRequest { + prompt: "a tiny brass observatory in a snowy field".to_string(), + num_images: GptImage1p5TextToImageNumImages::One, + image_size: Some(GptImage1p5TextToImageSize::Square), + background: None, + quality: Some(GptImage1p5TextToImageQuality::Low), + output_format: None, + }); + let response = request.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_edit_image_webhook() { + let request = FalGptImage1p5RequestState::EditImage(GptImage1p5EditImageRequest { + prompt: "turn this into a softly lit editorial photograph".to_string(), + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + num_images: GptImage1p5EditImageNumImages::One, + mask_image_url: None, + image_size: Some(GptImage1p5EditImageSize::Square), + background: None, + quality: Some(GptImage1p5EditImageQuality::Low), + input_fidelity: None, + output_format: None, + }); + let response = request.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/build.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/build.rs new file mode 100644 index 00000000..be2f3cfd --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/build.rs @@ -0,0 +1,466 @@ +use fal_client::requests::api::image::common::gpt_image_2_resolution::GptImage2Resolution; +use fal_client::requests::api::image::edit::gpt_image_2_edit_image::api::{ + GptImage2EditImageNumImages, GptImage2EditImageQuality, GptImage2EditImageRequest, + GptImage2EditImageSize, +}; +use fal_client::requests::api::image::text::gpt_image_2_text_to_image::api::{ + GptImage2TextToImageNumImages, GptImage2TextToImageQuality, + GptImage2TextToImageRequest, GptImage2TextToImageSize, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::gpt_image_2::request::FalGptImage2RequestState; + +pub fn build_fal_gpt_image_2( + builder: GenerateImageRequestBuilder, +) -> Result { + let prompt = builder.prompt.clone().unwrap_or_default(); + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + let num_images = plan_num_images(builder.image_batch_count, builder.request_mismatch_mitigation_strategy)?; + let image_size = plan_image_size(builder.aspect_ratio); + let resolution = plan_resolution(builder.resolution); + let quality = plan_quality(builder.quality); + + let state = if image_urls.is_empty() { + FalGptImage2RequestState::TextToImage(GptImage2TextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + image_size: image_size.and_then(to_t2i_image_size), + resolution, + quality: Some(to_t2i_quality(quality)), + output_format: None, + }) + } else { + FalGptImage2RequestState::EditImage(GptImage2EditImageRequest { + prompt, + image_urls, + num_images: to_edit_num_images(num_images), + mask_url: None, + image_size: image_size.map(to_edit_image_size), + resolution, + quality: Some(to_edit_quality(quality)), + output_format: None, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage2(state), + )) +} + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +#[derive(Copy, Clone, Debug)] +enum PlannedQuality { + Low, + Medium, + High, +} + +#[derive(Copy, Clone, Debug)] +enum PlannedImageSize { + SquareHd, + Square, + Portrait4x3, + Portrait16x9, + Landscape4x3, + Landscape16x9, + Auto, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn plan_quality(quality: Option) -> PlannedQuality { + match quality { + Some(RouterQuality::Low) => PlannedQuality::Low, + Some(RouterQuality::Medium) => PlannedQuality::Medium, + Some(RouterQuality::High) | None => PlannedQuality::High, + } +} + +fn plan_resolution(resolution: Option) -> Option { + resolution.map(|r| match r { + RouterResolution::HalfK + | RouterResolution::FourEightyP + | RouterResolution::SevenTwentyP + | RouterResolution::OneK => GptImage2Resolution::OneK, + RouterResolution::TenEightyP | RouterResolution::TwoK => GptImage2Resolution::TwoK, + RouterResolution::ThreeK => GptImage2Resolution::ThreeK, + RouterResolution::FourK => GptImage2Resolution::FourK, + }) +} + +fn plan_image_size(aspect_ratio: Option) -> Option { + match aspect_ratio { + None => None, + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Some(PlannedImageSize::Auto), + Some(RouterAspectRatio::Square) => Some(PlannedImageSize::Square), + Some(RouterAspectRatio::SquareHd) => Some(PlannedImageSize::SquareHd), + Some(RouterAspectRatio::WideFourByThree) + | Some(RouterAspectRatio::WideFiveByFour) => Some(PlannedImageSize::Landscape4x3), + Some(RouterAspectRatio::WideThreeByTwo) + | Some(RouterAspectRatio::WideSixteenByNine) + | Some(RouterAspectRatio::WideTwentyOneByNine) + | Some(RouterAspectRatio::Wide) => Some(PlannedImageSize::Landscape16x9), + Some(RouterAspectRatio::TallThreeByFour) + | Some(RouterAspectRatio::TallFourByFive) => Some(PlannedImageSize::Portrait4x3), + Some(RouterAspectRatio::TallTwoByThree) + | Some(RouterAspectRatio::TallNineBySixteen) + | Some(RouterAspectRatio::TallNineByTwentyOne) + | Some(RouterAspectRatio::Tall) => Some(PlannedImageSize::Portrait16x9), + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> GptImage2TextToImageNumImages { + match n { + PlannedNumImages::One => GptImage2TextToImageNumImages::One, + PlannedNumImages::Two => GptImage2TextToImageNumImages::Two, + PlannedNumImages::Three => GptImage2TextToImageNumImages::Three, + PlannedNumImages::Four => GptImage2TextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> GptImage2EditImageNumImages { + match n { + PlannedNumImages::One => GptImage2EditImageNumImages::One, + PlannedNumImages::Two => GptImage2EditImageNumImages::Two, + PlannedNumImages::Three => GptImage2EditImageNumImages::Three, + PlannedNumImages::Four => GptImage2EditImageNumImages::Four, + } +} + +fn to_t2i_quality(q: PlannedQuality) -> GptImage2TextToImageQuality { + match q { + PlannedQuality::Low => GptImage2TextToImageQuality::Low, + PlannedQuality::Medium => GptImage2TextToImageQuality::Medium, + PlannedQuality::High => GptImage2TextToImageQuality::High, + } +} + +fn to_edit_quality(q: PlannedQuality) -> GptImage2EditImageQuality { + match q { + PlannedQuality::Low => GptImage2EditImageQuality::Low, + PlannedQuality::Medium => GptImage2EditImageQuality::Medium, + PlannedQuality::High => GptImage2EditImageQuality::High, + } +} + +fn to_t2i_image_size(s: PlannedImageSize) -> Option { + match s { + PlannedImageSize::SquareHd => Some(GptImage2TextToImageSize::SquareHd), + PlannedImageSize::Square => Some(GptImage2TextToImageSize::Square), + PlannedImageSize::Portrait4x3 => Some(GptImage2TextToImageSize::Portrait4x3), + PlannedImageSize::Portrait16x9 => Some(GptImage2TextToImageSize::Portrait16x9), + PlannedImageSize::Landscape4x3 => Some(GptImage2TextToImageSize::Landscape4x3), + PlannedImageSize::Landscape16x9 => Some(GptImage2TextToImageSize::Landscape16x9), + PlannedImageSize::Auto => None, + } +} + +fn to_edit_image_size(s: PlannedImageSize) -> GptImage2EditImageSize { + match s { + PlannedImageSize::SquareHd => GptImage2EditImageSize::SquareHd, + PlannedImageSize::Square => GptImage2EditImageSize::Square, + PlannedImageSize::Portrait4x3 => GptImage2EditImageSize::Portrait4x3, + PlannedImageSize::Portrait16x9 => GptImage2EditImageSize::Portrait16x9, + PlannedImageSize::Landscape4x3 => GptImage2EditImageSize::Landscape4x3, + PlannedImageSize::Landscape16x9 => GptImage2EditImageSize::Landscape16x9, + PlannedImageSize::Auto => GptImage2EditImageSize::Auto, + } +} + +fn resolve_image_urls( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::fmt::Debug; + + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage2, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> GptImage2TextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage2( + FalGptImage2RequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected GPT Image 2 text-to-image request") + }; + req + } + + fn unwrap_edit(result: Result) -> GptImage2EditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalGptImage2( + FalGptImage2RequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected GPT Image 2 edit-image request") + }; + req + } + + fn assert_debug(actual: T, expected: &str) { + assert_eq!(format!("{:?}", actual), expected); + } + + #[test] + fn build2_routes_to_gpt_image_2_request() { + let req = unwrap_t2i(base_builder().build2()); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn mode_detection_is_based_on_image_urls() { + let text_req = unwrap_t2i(build_fal_gpt_image_2(base_builder())); + assert_eq!(text_req.prompt, "a cat in space"); + + let edit_req = unwrap_edit(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + })); + assert_eq!(edit_req.image_urls, vec!["https://example.com/img.jpg"]); + } + + #[test] + fn media_file_tokens_are_rejected() { + let result = build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn num_images_maps_exhaustively_for_text_and_edit() { + let cases = [ + (1, "One"), + (2, "Two"), + (3, "Three"), + (4, "Four"), + ]; + + for (count, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_batch_count: Some(count), + ..base_builder() + })); + assert_debug(req.num_images, expected); + } + + for (count, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(count), + ..base_builder() + })); + assert_debug(req.num_images, expected); + } + } + + #[test] + fn num_images_rejects_zero_and_handles_overflow_by_strategy() { + assert!(matches!( + build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + assert!(matches!( + build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_batch_count: Some(5), + ..base_builder() + }), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + + let req = unwrap_t2i(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_batch_count: Some(5), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + })); + assert_debug(req.num_images, "Four"); + } + + #[test] + fn quality_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "Some(High)"), + (Some(RouterQuality::Low), "Some(Low)"), + (Some(RouterQuality::Medium), "Some(Medium)"), + (Some(RouterQuality::High), "Some(High)"), + ]; + + for (quality, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_2(GenerateImageRequestBuilder { + quality, + ..base_builder() + })); + assert_debug(req.quality, expected); + } + + for (quality, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + quality, + ..base_builder() + })); + assert_debug(req.quality, expected); + } + } + + #[test] + fn resolution_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "None"), + (Some(RouterResolution::HalfK), "Some(OneK)"), + (Some(RouterResolution::FourEightyP), "Some(OneK)"), + (Some(RouterResolution::SevenTwentyP), "Some(OneK)"), + (Some(RouterResolution::OneK), "Some(OneK)"), + (Some(RouterResolution::TenEightyP), "Some(TwoK)"), + (Some(RouterResolution::TwoK), "Some(TwoK)"), + (Some(RouterResolution::ThreeK), "Some(ThreeK)"), + (Some(RouterResolution::FourK), "Some(FourK)"), + ]; + + for (resolution, expected) in cases { + let req = unwrap_t2i(build_fal_gpt_image_2(GenerateImageRequestBuilder { + resolution, + ..base_builder() + })); + assert_debug(req.resolution, expected); + } + + for (resolution, expected) in cases { + let req = unwrap_edit(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + resolution, + ..base_builder() + })); + assert_debug(req.resolution, expected); + } + } + + #[test] + fn aspect_ratio_maps_exhaustively_for_text_and_edit() { + let cases = [ + (None, "None", "None"), + (Some(RouterAspectRatio::Auto), "None", "Some(Auto)"), + (Some(RouterAspectRatio::Auto2k), "None", "Some(Auto)"), + (Some(RouterAspectRatio::Auto3k), "None", "Some(Auto)"), + (Some(RouterAspectRatio::Auto4k), "None", "Some(Auto)"), + (Some(RouterAspectRatio::Square), "Some(Square)", "Some(Square)"), + (Some(RouterAspectRatio::SquareHd), "Some(SquareHd)", "Some(SquareHd)"), + (Some(RouterAspectRatio::WideThreeByTwo), "Some(Landscape16x9)", "Some(Landscape16x9)"), + (Some(RouterAspectRatio::WideFourByThree), "Some(Landscape4x3)", "Some(Landscape4x3)"), + (Some(RouterAspectRatio::WideFiveByFour), "Some(Landscape4x3)", "Some(Landscape4x3)"), + (Some(RouterAspectRatio::WideSixteenByNine), "Some(Landscape16x9)", "Some(Landscape16x9)"), + (Some(RouterAspectRatio::WideTwentyOneByNine), "Some(Landscape16x9)", "Some(Landscape16x9)"), + (Some(RouterAspectRatio::Wide), "Some(Landscape16x9)", "Some(Landscape16x9)"), + (Some(RouterAspectRatio::TallTwoByThree), "Some(Portrait16x9)", "Some(Portrait16x9)"), + (Some(RouterAspectRatio::TallThreeByFour), "Some(Portrait4x3)", "Some(Portrait4x3)"), + (Some(RouterAspectRatio::TallFourByFive), "Some(Portrait4x3)", "Some(Portrait4x3)"), + (Some(RouterAspectRatio::TallNineBySixteen), "Some(Portrait16x9)", "Some(Portrait16x9)"), + (Some(RouterAspectRatio::TallNineByTwentyOne), "Some(Portrait16x9)", "Some(Portrait16x9)"), + (Some(RouterAspectRatio::Tall), "Some(Portrait16x9)", "Some(Portrait16x9)"), + ]; + + for (aspect_ratio, expected_t2i, _) in cases { + let req = unwrap_t2i(build_fal_gpt_image_2(GenerateImageRequestBuilder { + aspect_ratio, + ..base_builder() + })); + assert_debug(req.image_size, expected_t2i); + } + + for (aspect_ratio, _, expected_edit) in cases { + let req = unwrap_edit(build_fal_gpt_image_2(GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + aspect_ratio, + ..base_builder() + })); + assert_debug(req.image_size, expected_edit); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/cost.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/cost.rs new file mode 100644 index 00000000..4ea79439 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/cost.rs @@ -0,0 +1,268 @@ +use fal_client::requests::api::image::edit::gpt_image_2_edit_image::api::{ + GptImage2EditImageNumImages, GptImage2EditImageQuality, GptImage2EditImageSize, +}; +use fal_client::requests::api::image::text::gpt_image_2_text_to_image::api::{ + GptImage2TextToImageNumImages, GptImage2TextToImageQuality, GptImage2TextToImageSize, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::gpt_image_2::request::FalGptImage2RequestState; + +/// Cost state for Fal GPT Image 2. Mirrors v1 +/// (`estimate_image_cost_fal_gpt_image_2`): +/// +/// Output image cost (per output image), rounded up to whole cents: +/// Low: 1¢ all sizes +/// Medium: 6¢ square/squareHD/auto; 4¢ landscape/portrait (4:3 or 16:9) +/// High: 22¢ square; 23¢ squareHD/auto; +/// 15¢ landscape/portrait 4:3; 16¢ landscape/portrait 16:9 +/// +/// Quality defaults to High when unspecified. Resolution is NOT priced +/// separately — v1's table only varies by quality + size. +/// +/// The hand-rolled rates here intentionally override fal_client's trait, +/// which uses a base+per-megapixel formula that scales with the resolution +/// field. Keep in sync with v1. +#[derive(Clone, Debug)] +pub struct FalGptImage2CostState { + request: FalGptImage2RequestState, +} + +impl FalGptImage2CostState { + pub fn from_request(request: &FalGptImage2RequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let cost_in_usd_cents = match &self.request { + FalGptImage2RequestState::TextToImage(req) => { + cost_t2i(req.quality, req.image_size, req.num_images) + } + FalGptImage2RequestState::EditImage(req) => { + cost_edit(req.quality, req.image_size, req.num_images) + } + }; + + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[derive(Copy, Clone)] +enum SizeBucket { + Square, + SquareHd, + Landscape4x3, + Landscape16x9, + Portrait4x3, + Portrait16x9, + Auto, +} + +fn cost_t2i( + quality: Option, + image_size: Option, + num_images: GptImage2TextToImageNumImages, +) -> u64 { + use GptImage2TextToImageQuality as Q; + use GptImage2TextToImageSize as S; + let q = quality.unwrap_or(Q::High); + // T2I size enum has no Auto variant — `None` is the only auto-equivalent. + let bucket = match image_size { + None => SizeBucket::Auto, + Some(S::Square) => SizeBucket::Square, + Some(S::SquareHd) => SizeBucket::SquareHd, + Some(S::Landscape4x3) => SizeBucket::Landscape4x3, + Some(S::Landscape16x9) => SizeBucket::Landscape16x9, + Some(S::Portrait4x3) => SizeBucket::Portrait4x3, + Some(S::Portrait16x9) => SizeBucket::Portrait16x9, + }; + output_cost(matches!(q, Q::Low), matches!(q, Q::Medium), bucket) * t2i_num_images(num_images) +} + +fn cost_edit( + quality: Option, + image_size: Option, + num_images: GptImage2EditImageNumImages, +) -> u64 { + use GptImage2EditImageQuality as Q; + use GptImage2EditImageSize as S; + let q = quality.unwrap_or(Q::High); + let bucket = match image_size { + None | Some(S::Auto) => SizeBucket::Auto, + Some(S::Square) => SizeBucket::Square, + Some(S::SquareHd) => SizeBucket::SquareHd, + Some(S::Landscape4x3) => SizeBucket::Landscape4x3, + Some(S::Landscape16x9) => SizeBucket::Landscape16x9, + Some(S::Portrait4x3) => SizeBucket::Portrait4x3, + Some(S::Portrait16x9) => SizeBucket::Portrait16x9, + }; + output_cost(matches!(q, Q::Low), matches!(q, Q::Medium), bucket) * edit_num_images(num_images) +} + +fn output_cost(is_low: bool, is_medium: bool, bucket: SizeBucket) -> u64 { + if is_low { + return 1; + } + if is_medium { + return match bucket { + SizeBucket::Square | SizeBucket::SquareHd | SizeBucket::Auto => 6, + SizeBucket::Landscape4x3 | SizeBucket::Portrait4x3 + | SizeBucket::Landscape16x9 | SizeBucket::Portrait16x9 => 4, + }; + } + // High (default) + match bucket { + SizeBucket::Square => 22, + SizeBucket::SquareHd | SizeBucket::Auto => 23, + SizeBucket::Landscape4x3 | SizeBucket::Portrait4x3 => 15, + SizeBucket::Landscape16x9 | SizeBucket::Portrait16x9 => 16, + } +} + +fn t2i_num_images(n: GptImage2TextToImageNumImages) -> u64 { + match n { + GptImage2TextToImageNumImages::One => 1, + GptImage2TextToImageNumImages::Two => 2, + GptImage2TextToImageNumImages::Three => 3, + GptImage2TextToImageNumImages::Four => 4, + } +} + +fn edit_num_images(n: GptImage2EditImageNumImages) -> u64 { + match n { + GptImage2EditImageNumImages::One => 1, + GptImage2EditImageNumImages::Two => 2, + GptImage2EditImageNumImages::Three => 3, + GptImage2EditImageNumImages::Four => 4, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; + use fal_client::requests::api::image::edit::gpt_image_2_edit_image::api::{GptImage2EditImageNumImages, GptImage2EditImageQuality, GptImage2EditImageRequest, GptImage2EditImageSize}; + use fal_client::requests::api::image::text::gpt_image_2_text_to_image::api::{GptImage2TextToImageNumImages, GptImage2TextToImageQuality, GptImage2TextToImageRequest, GptImage2TextToImageSize}; + + type TextPriceCase = (Option, Option, [u64; 4]); + type EditPriceCase = (Option, Option, [u64; 4]); + + // v1 doesn't price by resolution — only quality + size. The Fal request's + // resolution field is sent to Fal for actual generation but doesn't enter + // the cost calculation. + + #[test] + fn text_to_image_cost_table_covers_quality_and_size() { + for (quality, image_size, expected_by_count) in text_to_image_price_cases() { + for (num_images, expected) in text_to_image_num_image_cases(expected_by_count) { + let request = FalGptImage2RequestState::TextToImage(GptImage2TextToImageRequest { prompt: "test".to_string(), num_images, image_size, resolution: None, quality, output_format: None }); + let cost = FalGptImage2CostState::from_request(&request).estimate_cost(); + assert_standard_cost_estimate(cost, expected); + } + } + } + + #[test] + fn edit_image_cost_table_covers_quality_and_size() { + for (quality, image_size, expected_by_count) in edit_image_price_cases() { + for (num_images, expected) in edit_image_num_image_cases(expected_by_count) { + let request = FalGptImage2RequestState::EditImage(GptImage2EditImageRequest { prompt: "test".to_string(), image_urls: vec!["https://example.com/image.png".to_string()], num_images, mask_url: None, image_size, resolution: None, quality, output_format: None }); + let cost = FalGptImage2CostState::from_request(&request).estimate_cost(); + assert_standard_cost_estimate(cost, expected); + } + } + } + + // v1 rates (independent of resolution): + // Low: 1¢ all sizes + // Medium: 6¢ Square/SquareHd/Auto; 4¢ Landscape/Portrait (4:3 or 16:9) + // High: 22¢ Square; 23¢ SquareHd/Auto; 15¢ 4:3 (L/P); 16¢ 16:9 (L/P) + // Default quality is High. + fn text_to_image_price_cases() -> Vec { + vec![ + (None, None, [23, 46, 69, 92]), + // Low + // No Auto variant on t2i — None is the only auto-equivalent (tested above). + (Some(GptImage2TextToImageQuality::Low), Some(GptImage2TextToImageSize::Square), [1, 2, 3, 4]), + (Some(GptImage2TextToImageQuality::Low), Some(GptImage2TextToImageSize::SquareHd), [1, 2, 3, 4]), + (Some(GptImage2TextToImageQuality::Low), Some(GptImage2TextToImageSize::Landscape4x3), [1, 2, 3, 4]), + (Some(GptImage2TextToImageQuality::Low), Some(GptImage2TextToImageSize::Landscape16x9), [1, 2, 3, 4]), + (Some(GptImage2TextToImageQuality::Low), Some(GptImage2TextToImageSize::Portrait4x3), [1, 2, 3, 4]), + (Some(GptImage2TextToImageQuality::Low), Some(GptImage2TextToImageSize::Portrait16x9), [1, 2, 3, 4]), + // Medium + // No Auto variant on t2i. + (Some(GptImage2TextToImageQuality::Medium), Some(GptImage2TextToImageSize::Square), [6, 12, 18, 24]), + (Some(GptImage2TextToImageQuality::Medium), Some(GptImage2TextToImageSize::SquareHd), [6, 12, 18, 24]), + (Some(GptImage2TextToImageQuality::Medium), Some(GptImage2TextToImageSize::Landscape4x3), [4, 8, 12, 16]), + (Some(GptImage2TextToImageQuality::Medium), Some(GptImage2TextToImageSize::Landscape16x9), [4, 8, 12, 16]), + (Some(GptImage2TextToImageQuality::Medium), Some(GptImage2TextToImageSize::Portrait4x3), [4, 8, 12, 16]), + (Some(GptImage2TextToImageQuality::Medium), Some(GptImage2TextToImageSize::Portrait16x9), [4, 8, 12, 16]), + // High + // No Auto variant on t2i. + (Some(GptImage2TextToImageQuality::High), Some(GptImage2TextToImageSize::Square), [22, 44, 66, 88]), + (Some(GptImage2TextToImageQuality::High), Some(GptImage2TextToImageSize::SquareHd), [23, 46, 69, 92]), + (Some(GptImage2TextToImageQuality::High), Some(GptImage2TextToImageSize::Landscape4x3), [15, 30, 45, 60]), + (Some(GptImage2TextToImageQuality::High), Some(GptImage2TextToImageSize::Landscape16x9), [16, 32, 48, 64]), + (Some(GptImage2TextToImageQuality::High), Some(GptImage2TextToImageSize::Portrait4x3), [15, 30, 45, 60]), + (Some(GptImage2TextToImageQuality::High), Some(GptImage2TextToImageSize::Portrait16x9), [16, 32, 48, 64]), + ] + } + + // Edit-mode pricing is identical to t2i (v1 has no input-image fee for + // gpt_image_2 — only gpt_image_1 has that fee). + fn edit_image_price_cases() -> Vec { + vec![ + (None, None, [23, 46, 69, 92]), + // Low + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::Auto), [1, 2, 3, 4]), + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::Square), [1, 2, 3, 4]), + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::SquareHd), [1, 2, 3, 4]), + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::Landscape4x3), [1, 2, 3, 4]), + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::Landscape16x9), [1, 2, 3, 4]), + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::Portrait4x3), [1, 2, 3, 4]), + (Some(GptImage2EditImageQuality::Low), Some(GptImage2EditImageSize::Portrait16x9), [1, 2, 3, 4]), + // Medium + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::Auto), [6, 12, 18, 24]), + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::Square), [6, 12, 18, 24]), + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::SquareHd), [6, 12, 18, 24]), + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::Landscape4x3), [4, 8, 12, 16]), + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::Landscape16x9), [4, 8, 12, 16]), + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::Portrait4x3), [4, 8, 12, 16]), + (Some(GptImage2EditImageQuality::Medium), Some(GptImage2EditImageSize::Portrait16x9), [4, 8, 12, 16]), + // High + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::Auto), [23, 46, 69, 92]), + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::Square), [22, 44, 66, 88]), + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::SquareHd), [23, 46, 69, 92]), + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::Landscape4x3), [15, 30, 45, 60]), + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::Landscape16x9), [16, 32, 48, 64]), + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::Portrait4x3), [15, 30, 45, 60]), + (Some(GptImage2EditImageQuality::High), Some(GptImage2EditImageSize::Portrait16x9), [16, 32, 48, 64]), + ] + } + + fn text_to_image_num_image_cases(expected_by_count: [u64; 4]) -> [(GptImage2TextToImageNumImages, u64); 4] { + [(GptImage2TextToImageNumImages::One, expected_by_count[0]), (GptImage2TextToImageNumImages::Two, expected_by_count[1]), (GptImage2TextToImageNumImages::Three, expected_by_count[2]), (GptImage2TextToImageNumImages::Four, expected_by_count[3])] + } + + fn edit_image_num_image_cases(expected_by_count: [u64; 4]) -> [(GptImage2EditImageNumImages, u64); 4] { + [(GptImage2EditImageNumImages::One, expected_by_count[0]), (GptImage2EditImageNumImages::Two, expected_by_count[1]), (GptImage2EditImageNumImages::Three, expected_by_count[2]), (GptImage2EditImageNumImages::Four, expected_by_count[3])] + } + + fn assert_standard_cost_estimate(cost: ImageGenerationCostEstimate, expected_usd_cents: u64) { + assert_eq!(cost.cost_in_usd_cents, Some(expected_usd_cents)); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/mod.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/request.rs b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/request.rs new file mode 100644 index 00000000..c5846787 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/gpt_image_2/request.rs @@ -0,0 +1,128 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::gpt_image_2_edit_image::api::GptImage2EditImageRequest; +use fal_client::requests::api::image::text::gpt_image_2_text_to_image::api::GptImage2TextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{FalImageResponsePayload, GenerateImageResponse}; + +#[derive(Clone, Debug)] +pub enum FalGptImage2RequestState { + TextToImage(GptImage2TextToImageRequest), + EditImage(GptImage2EditImageRequest), +} + +impl FalGptImage2RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => send_request(request, client).await, + Self::EditImage(request) => send_request(request, client).await, + } + } +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::common::gpt_image_2_resolution::GptImage2Resolution; + use fal_client::requests::api::image::edit::gpt_image_2_edit_image::api::{ + GptImage2EditImageNumImages, GptImage2EditImageQuality, GptImage2EditImageSize, + }; + use fal_client::requests::api::image::text::gpt_image_2_text_to_image::api::{ + GptImage2TextToImageNumImages, GptImage2TextToImageQuality, + GptImage2TextToImageSize, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn client_with_webhook() -> RouterFalClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + RouterFalClient::new_with_webhook( + FalApiKey::from_str(secret.trim()), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_image_webhook() { + let request = FalGptImage2RequestState::TextToImage(GptImage2TextToImageRequest { + prompt: "a polished product photo of a glass compass".to_string(), + num_images: GptImage2TextToImageNumImages::One, + image_size: Some(GptImage2TextToImageSize::Square), + resolution: Some(GptImage2Resolution::OneK), + quality: Some(GptImage2TextToImageQuality::Low), + output_format: None, + }); + let response = request.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_edit_image_webhook() { + let request = FalGptImage2RequestState::EditImage(GptImage2EditImageRequest { + prompt: "make this look like an elegant magazine cover image".to_string(), + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + num_images: GptImage2EditImageNumImages::One, + mask_url: None, + image_size: Some(GptImage2EditImageSize::Square), + resolution: Some(GptImage2Resolution::OneK), + quality: Some(GptImage2EditImageQuality::Low), + output_format: None, + }); + let response = request.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/mod.rs b/crates/router/src/generate/generate_image/providers/fal/mod.rs new file mode 100644 index 00000000..3245f199 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/mod.rs @@ -0,0 +1,15 @@ +pub mod flux_1_dev; +pub mod flux_1_schnell; +pub mod flux_2_lora_angles; +pub mod flux_pro_1p1; +pub mod flux_pro_1p1_ultra; +pub mod gpt_image_1; +pub mod gpt_image_1p5; +pub mod gpt_image_2; +pub mod nano_banana; +pub mod nano_banana_2; +pub mod nano_banana_pro; +pub mod qwen_edit_2511_angles; +pub mod seedream_4; +pub mod seedream_4p5; +pub mod seedream_5_lite; diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana/build.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana/build.rs new file mode 100644 index 00000000..052c687b --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana/build.rs @@ -0,0 +1,397 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::{ + Gemini25FlashEditAspectRatio, Gemini25FlashEditNumImages, Gemini25FlashEditRequest, +}; +use fal_client::requests_old::webhook::image::text::enqueue_gemini_25_flash_text_to_image_webhook::{ + Gemini25FlashTextToImageAspectRatio, Gemini25FlashTextToImageNumImages, + Gemini25FlashTextToImageRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::nano_banana::request::FalNanoBananaRequestState; + +pub fn build_fal_nano_banana( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let image_urls = resolve_image_list_ref(builder.image_inputs.clone())?; + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + + let state = if image_urls.is_empty() { + let aspect_ratio = plan_t2i_aspect_ratio(builder.aspect_ratio, strategy)?; + FalNanoBananaRequestState::TextToImage(Gemini25FlashTextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + aspect_ratio, + }) + } else { + let aspect_ratio = plan_edit_aspect_ratio(builder.aspect_ratio, strategy)?; + FalNanoBananaRequestState::EditImage(Gemini25FlashEditRequest { + prompt, + image_urls, + num_images: to_edit_num_images(num_images), + aspect_ratio, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBanana(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> Gemini25FlashTextToImageNumImages { + match n { + PlannedNumImages::One => Gemini25FlashTextToImageNumImages::One, + PlannedNumImages::Two => Gemini25FlashTextToImageNumImages::Two, + PlannedNumImages::Three => Gemini25FlashTextToImageNumImages::Three, + PlannedNumImages::Four => Gemini25FlashTextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> Gemini25FlashEditNumImages { + match n { + PlannedNumImages::One => Gemini25FlashEditNumImages::One, + PlannedNumImages::Two => Gemini25FlashEditNumImages::Two, + PlannedNumImages::Three => Gemini25FlashEditNumImages::Three, + PlannedNumImages::Four => Gemini25FlashEditNumImages::Four, + } +} + +// ── Aspect ratio ── + +// Gemini 2.5 Flash text-to-image supported aspect ratios: +// 1:1, 5:4, 4:3, 3:2, 16:9, 21:9, 4:5, 3:4, 2:3, 9:16 +// (no Auto for text-to-image) +fn plan_t2i_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Gemini25FlashTextToImageAspectRatio as T; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(T::OneByOne)), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(T::OneByOne)), + Some(RouterAspectRatio::WideFiveByFour) => Ok(Some(T::FiveByFour)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(T::FourByThree)), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Some(T::ThreeByTwo)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(T::SixteenByNine)), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Some(T::TwentyOneByNine)), + Some(RouterAspectRatio::TallFourByFive) => Ok(Some(T::FourByFive)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(T::ThreeByFour)), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Some(T::TwoByThree)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(T::NineBySixteen)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(T::NineBySixteen)), + }, + } +} + +// Gemini 2.5 Flash image-edit supported aspect ratios: same as t2i plus Auto +fn plan_edit_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Gemini25FlashEditAspectRatio as E; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(E::Auto)), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(E::OneByOne)), + Some(RouterAspectRatio::WideFiveByFour) => Ok(Some(E::FiveByFour)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(E::FourByThree)), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Some(E::ThreeByTwo)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(E::SixteenByNine)), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Some(E::TwentyOneByNine)), + Some(RouterAspectRatio::TallFourByFive) => Ok(Some(E::FourByFive)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(E::ThreeByFour)), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Some(E::TwoByThree)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(E::NineBySixteen)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(E::NineBySixteen)), + }, + } +} + +// ── Image inputs ── + +fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_list_ref { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBanana, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> Gemini25FlashTextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBanana(FalNanoBananaRequestState::TextToImage(req)) + ) = result.expect("build should succeed") else { + panic!("expected TextToImage variant") + }; + req + } + + fn unwrap_edit(result: Result) -> Gemini25FlashEditRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBanana(FalNanoBananaRequestState::EditImage(req)) + ) = result.expect("build should succeed") else { + panic!("expected EditImage variant") + }; + req + } + + // ── Mode detection ── + + mod mode_detection { + use super::*; + + #[test] + fn no_image_inputs_yields_text_to_image() { + let req = unwrap_t2i(build_fal_nano_banana(base_builder())); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn image_inputs_yields_edit() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana(builder)); + assert_eq!(req.image_urls, vec!["https://example.com/img.jpg".to_string()]); + } + + #[test] + fn multiple_image_inputs_all_passed_through() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![ + "https://example.com/a.jpg".to_string(), + "https://example.com/b.jpg".to_string(), + ])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana(builder)); + assert_eq!(req.image_urls.len(), 2); + } + + #[test] + fn empty_image_urls_yields_text_to_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![])), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana(builder)); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn t2i_default_is_none() { + let req = unwrap_t2i(build_fal_nano_banana(base_builder())); + assert!(req.aspect_ratio.is_none()); + } + + #[test] + fn t2i_auto_falls_back_to_one_by_one() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana(builder)); + assert!(matches!(req.aspect_ratio, Some(Gemini25FlashTextToImageAspectRatio::OneByOne))); + } + + #[test] + fn t2i_wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana(builder)); + assert!(matches!(req.aspect_ratio, Some(Gemini25FlashTextToImageAspectRatio::SixteenByNine))); + } + + #[test] + fn edit_auto_is_preserved() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana(builder)); + assert!(matches!(req.aspect_ratio, Some(Gemini25FlashEditAspectRatio::Auto))); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_t2i(build_fal_nano_banana(base_builder())); + assert!(matches!(req.num_images, Gemini25FlashTextToImageNumImages::One)); + } + + #[test] + fn three_is_three() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana(builder)); + assert!(matches!(req.num_images, Gemini25FlashTextToImageNumImages::Three)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(9), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_batch_count", .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(9), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana(builder)); + assert!(matches!(req.num_images, Gemini25FlashTextToImageNumImages::Four)); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana/cost.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana/cost.rs new file mode 100644 index 00000000..a5274563 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana/cost.rs @@ -0,0 +1,118 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::Gemini25FlashEditNumImages; +use fal_client::requests_old::webhook::image::text::enqueue_gemini_25_flash_text_to_image_webhook::Gemini25FlashTextToImageNumImages; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::nano_banana::request::FalNanoBananaRequestState; + +pub struct FalNanoBananaCostState { + num_images: u64, +} + +impl FalNanoBananaCostState { + pub fn from_request(request: &FalNanoBananaRequestState) -> Self { + let num_images = match request { + FalNanoBananaRequestState::TextToImage(req) => match req.num_images { + Gemini25FlashTextToImageNumImages::One => 1, + Gemini25FlashTextToImageNumImages::Two => 2, + Gemini25FlashTextToImageNumImages::Three => 3, + Gemini25FlashTextToImageNumImages::Four => 4, + }, + FalNanoBananaRequestState::EditImage(req) => match req.num_images { + Gemini25FlashEditNumImages::One => 1, + Gemini25FlashEditNumImages::Two => 2, + Gemini25FlashEditNumImages::Three => 3, + Gemini25FlashEditNumImages::Four => 4, + }, + }; + Self { num_images } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Pricing: $0.039/image — rounded up to 4 cents (no resolution multiplier, + // Gemini 2.5 Flash has no resolution option). Matches v1. + const COST_PER_IMAGE: u64 = 4; + let cost_in_usd_cents = COST_PER_IMAGE * self.num_images; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::Gemini25FlashEditRequest; + use fal_client::requests_old::webhook::image::text::enqueue_gemini_25_flash_text_to_image_webhook::Gemini25FlashTextToImageRequest; + + fn t2i_cost(n: Gemini25FlashTextToImageNumImages) -> ImageGenerationCostEstimate { + FalNanoBananaCostState::from_request(&FalNanoBananaRequestState::TextToImage( + Gemini25FlashTextToImageRequest { + prompt: "test".to_string(), + num_images: n, + aspect_ratio: None, + }, + )).estimate_cost() + } + + fn edit_cost(n: Gemini25FlashEditNumImages) -> ImageGenerationCostEstimate { + FalNanoBananaCostState::from_request(&FalNanoBananaRequestState::EditImage( + Gemini25FlashEditRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/x.jpg".to_string()], + num_images: n, + aspect_ratio: None, + }, + )).estimate_cost() + } + + #[test] + fn t2i_one_image_is_4_cents() { + assert_eq!(t2i_cost(Gemini25FlashTextToImageNumImages::One).cost_in_usd_cents, Some(4)); + } + + #[test] + fn t2i_two_images_is_8_cents() { + assert_eq!(t2i_cost(Gemini25FlashTextToImageNumImages::Two).cost_in_usd_cents, Some(8)); + } + + #[test] + fn t2i_three_images_is_12_cents() { + assert_eq!(t2i_cost(Gemini25FlashTextToImageNumImages::Three).cost_in_usd_cents, Some(12)); + } + + #[test] + fn t2i_four_images_is_16_cents() { + assert_eq!(t2i_cost(Gemini25FlashTextToImageNumImages::Four).cost_in_usd_cents, Some(16)); + } + + #[test] + fn edit_two_images_matches_t2i_two_images() { + assert_eq!( + edit_cost(Gemini25FlashEditNumImages::Two).cost_in_usd_cents, + t2i_cost(Gemini25FlashTextToImageNumImages::Two).cost_in_usd_cents, + ); + } + + #[test] + fn credits_equal_cents() { + let c = t2i_cost(Gemini25FlashTextToImageNumImages::Two); + assert_eq!(c.cost_in_credits, c.cost_in_usd_cents); + } + + #[test] + fn cost_flags_match_v1() { + let c = t2i_cost(Gemini25FlashTextToImageNumImages::One); + assert!(!c.is_free); + assert!(!c.is_unlimited); + assert!(!c.is_rate_limited); + assert!(!c.has_watermark); + assert!(c.failures_are_refunded.is_none()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana/mod.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana/request.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana/request.rs new file mode 100644 index 00000000..9553fda3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana/request.rs @@ -0,0 +1,117 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::{ + enqueue_gemini_25_flash_edit_webhook, Gemini25FlashEditArgs, Gemini25FlashEditRequest, +}; +use fal_client::requests_old::webhook::image::text::enqueue_gemini_25_flash_text_to_image_webhook::{ + enqueue_gemini_25_flash_text_to_image_webhook, Gemini25FlashTextToImageArgs, + Gemini25FlashTextToImageRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalNanoBananaRequestState { + TextToImage(Gemini25FlashTextToImageRequest), + EditImage(Gemini25FlashEditRequest), +} + +impl FalNanoBananaRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound): (_, Arc) = match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = Gemini25FlashTextToImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_gemini_25_flash_text_to_image_webhook(args).await, outbound) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = Gemini25FlashEditArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_gemini_25_flash_edit_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests_old::webhook::image::edit::enqueue_gemini_25_flash_edit_webhook::Gemini25FlashEditNumImages; + use fal_client::requests_old::webhook::image::text::enqueue_gemini_25_flash_text_to_image_webhook::{ + Gemini25FlashTextToImageAspectRatio, Gemini25FlashTextToImageNumImages, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_t2i_via_webhook() { + let client = client_with_webhook(); + let state = FalNanoBananaRequestState::TextToImage(Gemini25FlashTextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: Gemini25FlashTextToImageNumImages::One, + aspect_ratio: Some(Gemini25FlashTextToImageAspectRatio::SixteenByNine), + }); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("nano_banana t2i — request_id: {:?}", payload.request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_edit_via_webhook() { + let client = client_with_webhook(); + let state = FalNanoBananaRequestState::EditImage(Gemini25FlashEditRequest { + prompt: "add a party hat to the dog".to_string(), + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + num_images: Gemini25FlashEditNumImages::One, + aspect_ratio: None, + }); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("nano_banana edit — request_id: {:?}", payload.request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/build.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/build.rs new file mode 100644 index 00000000..a29fc3dd --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/build.rs @@ -0,0 +1,551 @@ +use fal_client::requests::api::image::edit::nano_banana_2_edit_image::api::{ + NanoBanana2EditImageAspectRatio, NanoBanana2EditImageNumImages, + NanoBanana2EditImageRequest, NanoBanana2EditImageResolution, +}; +use fal_client::requests::api::image::text::nano_banana_2_text_to_image::api::{ + NanoBanana2TextToImageAspectRatio, NanoBanana2TextToImageNumImages, + NanoBanana2TextToImageRequest, NanoBanana2TextToImageResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::nano_banana_2::request::FalNanoBanana2RequestState; + +pub fn build_fal_nano_banana_2( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let prompt = builder.prompt.clone().unwrap_or_default(); + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let resolution = plan_resolution(builder.resolution); + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + + let state = if image_urls.is_empty() { + // Text-to-image + let aspect_ratio = plan_t2i_aspect_ratio(builder.aspect_ratio); + + FalNanoBanana2RequestState::TextToImage(NanoBanana2TextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + resolution: resolution.map(to_t2i_resolution), + aspect_ratio, + }) + } else { + // Edit image + let aspect_ratio = plan_edit_aspect_ratio(builder.aspect_ratio); + + FalNanoBanana2RequestState::EditImage(NanoBanana2EditImageRequest { + prompt, + image_urls, + num_images: to_edit_num_images(num_images), + resolution: resolution.map(to_edit_resolution), + aspect_ratio, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBanana2(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> NanoBanana2TextToImageNumImages { + match n { + PlannedNumImages::One => NanoBanana2TextToImageNumImages::One, + PlannedNumImages::Two => NanoBanana2TextToImageNumImages::Two, + PlannedNumImages::Three => NanoBanana2TextToImageNumImages::Three, + PlannedNumImages::Four => NanoBanana2TextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> NanoBanana2EditImageNumImages { + match n { + PlannedNumImages::One => NanoBanana2EditImageNumImages::One, + PlannedNumImages::Two => NanoBanana2EditImageNumImages::Two, + PlannedNumImages::Three => NanoBanana2EditImageNumImages::Three, + PlannedNumImages::Four => NanoBanana2EditImageNumImages::Four, + } +} + +// ── Resolution ── + +#[derive(Copy, Clone, Debug)] +enum PlannedResolution { + HalfK, + OneK, + TwoK, + FourK, +} + +fn plan_resolution(resolution: Option) -> Option { + resolution.map(|r| match r { + RouterResolution::HalfK | RouterResolution::FourEightyP => PlannedResolution::HalfK, + RouterResolution::OneK | RouterResolution::SevenTwentyP | RouterResolution::TenEightyP => PlannedResolution::OneK, + RouterResolution::TwoK => PlannedResolution::TwoK, + // 3K isn't natively supported on Fal nano_banana_2; v1 downgrades to 2K + // pricing (and TwoK resolution). Match v1 here so cost+behavior agree. + RouterResolution::ThreeK => PlannedResolution::TwoK, + RouterResolution::FourK => PlannedResolution::FourK, + }) +} + +fn to_t2i_resolution(r: PlannedResolution) -> NanoBanana2TextToImageResolution { + match r { + PlannedResolution::HalfK => NanoBanana2TextToImageResolution::HalfK, + PlannedResolution::OneK => NanoBanana2TextToImageResolution::OneK, + PlannedResolution::TwoK => NanoBanana2TextToImageResolution::TwoK, + PlannedResolution::FourK => NanoBanana2TextToImageResolution::FourK, + } +} + +fn to_edit_resolution(r: PlannedResolution) -> NanoBanana2EditImageResolution { + match r { + PlannedResolution::HalfK => NanoBanana2EditImageResolution::HalfK, + PlannedResolution::OneK => NanoBanana2EditImageResolution::OneK, + PlannedResolution::TwoK => NanoBanana2EditImageResolution::TwoK, + PlannedResolution::FourK => NanoBanana2EditImageResolution::FourK, + } +} + +// ── Aspect ratio ── + +fn plan_t2i_aspect_ratio( + aspect_ratio: Option, +) -> Option { + use NanoBanana2TextToImageAspectRatio as T; + aspect_ratio.map(|ar| match ar { + RouterAspectRatio::Auto | RouterAspectRatio::Auto2k + | RouterAspectRatio::Auto3k | RouterAspectRatio::Auto4k => T::Auto, + RouterAspectRatio::Square | RouterAspectRatio::SquareHd => T::OneByOne, + RouterAspectRatio::WideFiveByFour => T::FiveByFour, + RouterAspectRatio::WideFourByThree => T::FourByThree, + RouterAspectRatio::WideThreeByTwo | RouterAspectRatio::Wide => T::ThreeByTwo, + RouterAspectRatio::WideSixteenByNine => T::SixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => T::TwentyOneByNine, + RouterAspectRatio::TallFourByFive => T::FourByFive, + RouterAspectRatio::TallThreeByFour => T::ThreeByFour, + RouterAspectRatio::TallTwoByThree | RouterAspectRatio::Tall => T::TwoByThree, + RouterAspectRatio::TallNineBySixteen => T::NineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => T::NineBySixteen, // nearest match + }) +} + +fn plan_edit_aspect_ratio( + aspect_ratio: Option, +) -> Option { + use NanoBanana2EditImageAspectRatio as E; + aspect_ratio.map(|ar| match ar { + RouterAspectRatio::Auto | RouterAspectRatio::Auto2k + | RouterAspectRatio::Auto3k | RouterAspectRatio::Auto4k => E::Auto, + RouterAspectRatio::Square | RouterAspectRatio::SquareHd => E::OneByOne, + RouterAspectRatio::WideFiveByFour => E::FiveByFour, + RouterAspectRatio::WideFourByThree => E::FourByThree, + RouterAspectRatio::WideThreeByTwo | RouterAspectRatio::Wide => E::ThreeByTwo, + RouterAspectRatio::WideSixteenByNine => E::SixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => E::TwentyOneByNine, + RouterAspectRatio::TallFourByFive => E::FourByFive, + RouterAspectRatio::TallThreeByFour => E::ThreeByFour, + RouterAspectRatio::TallTwoByThree | RouterAspectRatio::Tall => E::TwoByThree, + RouterAspectRatio::TallNineBySixteen => E::NineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => E::NineBySixteen, // nearest match + }) +} + +// ── Image inputs ── + +fn resolve_image_urls( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBanana2, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> NanoBanana2TextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBanana2( + FalNanoBanana2RequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected TextToImage variant") + }; + req + } + + fn unwrap_edit(result: Result) -> NanoBanana2EditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBanana2( + FalNanoBanana2RequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected EditImage variant") + }; + req + } + + // ── Mode detection ── + + mod mode_detection { + use super::*; + + #[test] + fn no_images_yields_text_to_image() { + let result = build_fal_nano_banana_2(base_builder()); + let req = unwrap_t2i(result); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn urls_yield_edit_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let result = build_fal_nano_banana_2(builder); + let req = unwrap_edit(result); + assert_eq!(req.image_urls, vec!["https://example.com/img.jpg"]); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + let result = build_fal_nano_banana_2(builder); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_t2i(build_fal_nano_banana_2(base_builder())); + assert!(matches!(req.num_images, NanoBanana2TextToImageNumImages::One)); + } + + #[test] + fn explicit_three() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.num_images, NanoBanana2TextToImageNumImages::Three)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana_2(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana_2(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.num_images, NanoBanana2TextToImageNumImages::Four)); + } + + #[test] + fn edit_mode_num_images() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(2), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_2(builder)); + assert!(matches!(req.num_images, NanoBanana2EditImageNumImages::Two)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn none_is_none() { + let req = unwrap_t2i(build_fal_nano_banana_2(base_builder())); + assert!(req.resolution.is_none()); + } + + #[test] + fn half_k_maps_to_half_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::HalfK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2TextToImageResolution::HalfK))); + } + + #[test] + fn four_eighty_p_maps_to_half_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::FourEightyP), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2TextToImageResolution::HalfK))); + } + + #[test] + fn one_k_maps_to_one_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::OneK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2TextToImageResolution::OneK))); + } + + #[test] + fn two_k_maps_to_two_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::TwoK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2TextToImageResolution::TwoK))); + } + + #[test] + fn four_k_maps_to_four_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::FourK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2TextToImageResolution::FourK))); + } + + #[test] + fn three_k_rounds_down_to_two_k() { + // Match v1's downgrade behavior: 3K → 2K (cheaper, no 3K native support). + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::ThreeK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2TextToImageResolution::TwoK))); + } + + #[test] + fn edit_mode_resolution() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + resolution: Some(RouterResolution::HalfK), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_2(builder)); + assert!(matches!(req.resolution, Some(NanoBanana2EditImageResolution::HalfK))); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn none_is_none_t2i() { + let req = unwrap_t2i(build_fal_nano_banana_2(base_builder())); + assert!(req.aspect_ratio.is_none()); + } + + #[test] + fn auto_maps_to_auto_t2i() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBanana2TextToImageAspectRatio::Auto))); + } + + #[test] + fn square_maps_to_one_by_one() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBanana2TextToImageAspectRatio::OneByOne))); + } + + #[test] + fn wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBanana2TextToImageAspectRatio::SixteenByNine))); + } + + #[test] + fn tall_nine_by_sixteen() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBanana2TextToImageAspectRatio::NineBySixteen))); + } + + #[test] + fn edit_auto() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_2(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBanana2EditImageAspectRatio::Auto))); + } + + #[test] + fn edit_square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::SquareHd), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_2(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBanana2EditImageAspectRatio::OneByOne))); + } + } + + // ── Prompt ── + + mod prompt_tests { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let builder = GenerateImageRequestBuilder { + prompt: Some("my custom prompt".to_string()), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert_eq!(req.prompt, "my custom prompt"); + } + + #[test] + fn missing_prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { + prompt: None, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_2(builder)); + assert_eq!(req.prompt, ""); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/cost.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/cost.rs new file mode 100644 index 00000000..47f7e1f8 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/cost.rs @@ -0,0 +1,224 @@ +use fal_client::requests::api::image::edit::nano_banana_2_edit_image::api::{ + NanoBanana2EditImageNumImages, NanoBanana2EditImageResolution, +}; +use fal_client::requests::api::image::text::nano_banana_2_text_to_image::api::{ + NanoBanana2TextToImageNumImages, NanoBanana2TextToImageResolution, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::nano_banana_2::request::FalNanoBanana2RequestState; + +/// Cost state for Fal Nano Banana 2. Mirrors v1 +/// (`estimate_image_cost_fal_nano_banana_2`): +/// +/// $0.08/image base (1K). Multipliers: 0.5K = 0.75x, 2K = 1.5x, 4K = 2x. +/// 0.5K → 6¢, 1K → 8¢ (also default), 2K → 12¢, 4K → 16¢ +/// +/// The hand-rolled rates here intentionally override fal_client's trait, +/// whose rates are placeholder values from a `TODO(bt): Verify pricing` block +/// (8/15/15/30 instead of v1's 6/8/12/16). Keep this in sync with the v1 +/// cost file. +pub struct FalNanoBanana2CostState { + cost_in_usd_cents: u64, +} + +impl FalNanoBanana2CostState { + pub fn from_request(request: &FalNanoBanana2RequestState) -> Self { + let (cost_per_image, num_images) = match request { + FalNanoBanana2RequestState::TextToImage(req) => { + (cost_per_image_for_t2i_resolution(req.resolution), t2i_num_images(req.num_images)) + } + FalNanoBanana2RequestState::EditImage(req) => { + (cost_per_image_for_edit_resolution(req.resolution), edit_num_images(req.num_images)) + } + }; + Self { cost_in_usd_cents: cost_per_image * num_images } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn cost_per_image_for_t2i_resolution(r: Option) -> u64 { + match r { + Some(NanoBanana2TextToImageResolution::HalfK) => 6, + Some(NanoBanana2TextToImageResolution::OneK) | None => 8, + Some(NanoBanana2TextToImageResolution::TwoK) => 12, + Some(NanoBanana2TextToImageResolution::FourK) => 16, + } +} + +fn cost_per_image_for_edit_resolution(r: Option) -> u64 { + match r { + Some(NanoBanana2EditImageResolution::HalfK) => 6, + Some(NanoBanana2EditImageResolution::OneK) | None => 8, + Some(NanoBanana2EditImageResolution::TwoK) => 12, + Some(NanoBanana2EditImageResolution::FourK) => 16, + } +} + +fn t2i_num_images(n: NanoBanana2TextToImageNumImages) -> u64 { + match n { + NanoBanana2TextToImageNumImages::One => 1, + NanoBanana2TextToImageNumImages::Two => 2, + NanoBanana2TextToImageNumImages::Three => 3, + NanoBanana2TextToImageNumImages::Four => 4, + } +} + +fn edit_num_images(n: NanoBanana2EditImageNumImages) -> u64 { + match n { + NanoBanana2EditImageNumImages::One => 1, + NanoBanana2EditImageNumImages::Two => 2, + NanoBanana2EditImageNumImages::Three => 3, + NanoBanana2EditImageNumImages::Four => 4, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests::api::image::edit::nano_banana_2_edit_image::api::{ + NanoBanana2EditImageNumImages, NanoBanana2EditImageRequest, + NanoBanana2EditImageResolution, + }; + use fal_client::requests::api::image::text::nano_banana_2_text_to_image::api::{ + NanoBanana2TextToImageNumImages, NanoBanana2TextToImageRequest, + NanoBanana2TextToImageResolution, + }; + + mod text_to_image_costs { + use super::*; + + fn make_t2i( + num_images: NanoBanana2TextToImageNumImages, + resolution: Option, + ) -> FalNanoBanana2RequestState { + FalNanoBanana2RequestState::TextToImage(NanoBanana2TextToImageRequest { + prompt: "test".to_string(), + num_images, + resolution, + aspect_ratio: None, + }) + } + + #[test] + fn one_image_default_resolution() { + let state = FalNanoBanana2CostState::from_request( + &make_t2i(NanoBanana2TextToImageNumImages::One, None), + ); + // None defaults to 1K = 8¢ per v1's rate table. + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(8)); + } + + #[test] + fn one_image_half_k() { + let state = FalNanoBanana2CostState::from_request( + &make_t2i(NanoBanana2TextToImageNumImages::One, Some(NanoBanana2TextToImageResolution::HalfK)), + ); + // HalfK = 0.75x base = 6¢ per v1's rate table. + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(6)); + } + + #[test] + fn four_images_one_k() { + let state = FalNanoBanana2CostState::from_request( + &make_t2i(NanoBanana2TextToImageNumImages::Four, Some(NanoBanana2TextToImageResolution::OneK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(32)); + } + + #[test] + fn one_image_four_k() { + let state = FalNanoBanana2CostState::from_request( + &make_t2i(NanoBanana2TextToImageNumImages::One, Some(NanoBanana2TextToImageResolution::FourK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(16)); + } + + #[test] + fn two_images_four_k() { + let state = FalNanoBanana2CostState::from_request( + &make_t2i(NanoBanana2TextToImageNumImages::Two, Some(NanoBanana2TextToImageResolution::FourK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(32)); + } + } + + mod edit_image_costs { + use super::*; + + fn make_edit( + num_images: NanoBanana2EditImageNumImages, + resolution: Option, + ) -> FalNanoBanana2RequestState { + FalNanoBanana2RequestState::EditImage(NanoBanana2EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/image.jpg".to_string()], + num_images, + resolution, + aspect_ratio: None, + }) + } + + #[test] + fn one_image_default_resolution() { + let state = FalNanoBanana2CostState::from_request( + &make_edit(NanoBanana2EditImageNumImages::One, None), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(8)); + } + + #[test] + fn one_image_half_k() { + let state = FalNanoBanana2CostState::from_request( + &make_edit(NanoBanana2EditImageNumImages::One, Some(NanoBanana2EditImageResolution::HalfK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(6)); + } + + #[test] + fn three_images_two_k() { + let state = FalNanoBanana2CostState::from_request( + &make_edit(NanoBanana2EditImageNumImages::Three, Some(NanoBanana2EditImageResolution::TwoK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(36)); + } + + #[test] + fn one_image_four_k() { + let state = FalNanoBanana2CostState::from_request( + &make_edit(NanoBanana2EditImageNumImages::One, Some(NanoBanana2EditImageResolution::FourK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(16)); + } + } + + #[test] + fn cost_flags_are_correct() { + let state = FalNanoBanana2CostState::from_request( + &FalNanoBanana2RequestState::TextToImage(NanoBanana2TextToImageRequest { + prompt: "test".to_string(), + num_images: NanoBanana2TextToImageNumImages::One, + resolution: None, + aspect_ratio: None, + }), + ); + let cost = state.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/mod.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/request.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/request.rs new file mode 100644 index 00000000..18fa9054 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_2/request.rs @@ -0,0 +1,168 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::nano_banana_2_edit_image::api::NanoBanana2EditImageRequest; +use fal_client::requests::api::image::text::nano_banana_2_text_to_image::api::NanoBanana2TextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalNanoBanana2RequestState { + TextToImage(NanoBanana2TextToImageRequest), + EditImage(NanoBanana2EditImageRequest), +} + +impl FalNanoBanana2RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + } + } +} + +// ── Helpers ── + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request + .send_webhook_request(&client.api_key, webhook_url) + .await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request + .send_queue_request(&client.api_key) + .await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::edit::nano_banana_2_edit_image::api::{ + NanoBanana2EditImageAspectRatio, NanoBanana2EditImageNumImages, + NanoBanana2EditImageResolution, + }; + use fal_client::requests::api::image::text::nano_banana_2_text_to_image::api::{ + NanoBanana2TextToImageAspectRatio, NanoBanana2TextToImageNumImages, + NanoBanana2TextToImageResolution, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + // ── Text-to-image ── + + mod text_to_image { + use super::*; + + fn t2i_request() -> FalNanoBanana2RequestState { + FalNanoBanana2RequestState::TextToImage(NanoBanana2TextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: NanoBanana2TextToImageNumImages::One, + resolution: Some(NanoBanana2TextToImageResolution::OneK), + aspect_ratio: Some(NanoBanana2TextToImageAspectRatio::SixteenByNine), + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = t2i_request(); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook t2i — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + } + + // ── Edit image ── + + mod edit_image { + use super::*; + use test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL; + + fn edit_request() -> FalNanoBanana2RequestState { + FalNanoBanana2RequestState::EditImage(NanoBanana2EditImageRequest { + prompt: "add a party hat to the dog, and put the dog in front of the location".to_string(), + image_urls: vec![ + JUNO_AT_LAKE_IMAGE_URL.to_string(), + WHITE_HOUSE_SUNSET_IMAGE_URL.to_string(), + ], + num_images: NanoBanana2EditImageNumImages::One, + resolution: Some(NanoBanana2EditImageResolution::OneK), + aspect_ratio: Some(NanoBanana2EditImageAspectRatio::SixteenByNine), + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = edit_request(); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook edit — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/build.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/build.rs new file mode 100644 index 00000000..4e73d7cc --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/build.rs @@ -0,0 +1,538 @@ +use fal_client::requests::api::image::edit::nano_banana_pro_edit_image::api::{ + NanoBananaProEditImageAspectRatio, NanoBananaProEditImageNumImages, + NanoBananaProEditImageRequest, NanoBananaProEditImageResolution, +}; +use fal_client::requests::api::image::text::nano_banana_pro_text_to_image::api::{ + NanoBananaProTextToImageAspectRatio, NanoBananaProTextToImageNumImages, + NanoBananaProTextToImageRequest, NanoBananaProTextToImageResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::nano_banana_pro::request::FalNanoBananaProRequestState; + +pub fn build_fal_nano_banana_pro( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let prompt = builder.prompt.clone().unwrap_or_default(); + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let resolution = plan_resolution(builder.resolution); + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + + let state = if image_urls.is_empty() { + // Text-to-image + let aspect_ratio = plan_t2i_aspect_ratio(builder.aspect_ratio); + + FalNanoBananaProRequestState::TextToImage(NanoBananaProTextToImageRequest { + prompt, + num_images: to_t2i_num_images(num_images), + resolution: resolution.map(to_t2i_resolution), + aspect_ratio, + }) + } else { + // Edit image + let aspect_ratio = plan_edit_aspect_ratio(builder.aspect_ratio); + + FalNanoBananaProRequestState::EditImage(NanoBananaProEditImageRequest { + prompt, + image_urls, + num_images: to_edit_num_images(num_images), + resolution: resolution.map(to_edit_resolution), + aspect_ratio, + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBananaPro(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> NanoBananaProTextToImageNumImages { + match n { + PlannedNumImages::One => NanoBananaProTextToImageNumImages::One, + PlannedNumImages::Two => NanoBananaProTextToImageNumImages::Two, + PlannedNumImages::Three => NanoBananaProTextToImageNumImages::Three, + PlannedNumImages::Four => NanoBananaProTextToImageNumImages::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> NanoBananaProEditImageNumImages { + match n { + PlannedNumImages::One => NanoBananaProEditImageNumImages::One, + PlannedNumImages::Two => NanoBananaProEditImageNumImages::Two, + PlannedNumImages::Three => NanoBananaProEditImageNumImages::Three, + PlannedNumImages::Four => NanoBananaProEditImageNumImages::Four, + } +} + +// ── Resolution ── + +#[derive(Copy, Clone, Debug)] +enum PlannedResolution { + OneK, + TwoK, + FourK, +} + +fn plan_resolution(resolution: Option) -> Option { + resolution.map(|r| match r { + RouterResolution::HalfK | RouterResolution::FourEightyP | RouterResolution::SevenTwentyP + | RouterResolution::OneK | RouterResolution::TenEightyP => PlannedResolution::OneK, + RouterResolution::TwoK => PlannedResolution::TwoK, + // 3K isn't natively supported on Fal nano_banana_pro; v1 downgrades to 2K + // pricing (and TwoK resolution). Match v1 here so cost+behavior agree. + RouterResolution::ThreeK => PlannedResolution::TwoK, + RouterResolution::FourK => PlannedResolution::FourK, + }) +} + +fn to_t2i_resolution(r: PlannedResolution) -> NanoBananaProTextToImageResolution { + match r { + PlannedResolution::OneK => NanoBananaProTextToImageResolution::OneK, + PlannedResolution::TwoK => NanoBananaProTextToImageResolution::TwoK, + PlannedResolution::FourK => NanoBananaProTextToImageResolution::FourK, + } +} + +fn to_edit_resolution(r: PlannedResolution) -> NanoBananaProEditImageResolution { + match r { + PlannedResolution::OneK => NanoBananaProEditImageResolution::OneK, + PlannedResolution::TwoK => NanoBananaProEditImageResolution::TwoK, + PlannedResolution::FourK => NanoBananaProEditImageResolution::FourK, + } +} + +// ── Aspect ratio ── + +fn plan_t2i_aspect_ratio( + aspect_ratio: Option, +) -> Option { + use NanoBananaProTextToImageAspectRatio as T; + aspect_ratio.and_then(|ar| match ar { + RouterAspectRatio::Square | RouterAspectRatio::SquareHd => Some(T::OneByOne), + RouterAspectRatio::WideFiveByFour => Some(T::FiveByFour), + RouterAspectRatio::WideFourByThree => Some(T::FourByThree), + RouterAspectRatio::WideThreeByTwo | RouterAspectRatio::Wide => Some(T::ThreeByTwo), + RouterAspectRatio::WideSixteenByNine => Some(T::SixteenByNine), + RouterAspectRatio::WideTwentyOneByNine => Some(T::TwentyOneByNine), + RouterAspectRatio::TallFourByFive => Some(T::FourByFive), + RouterAspectRatio::TallThreeByFour => Some(T::ThreeByFour), + RouterAspectRatio::TallTwoByThree | RouterAspectRatio::Tall => Some(T::TwoByThree), + RouterAspectRatio::TallNineBySixteen => Some(T::NineBySixteen), + RouterAspectRatio::TallNineByTwentyOne => Some(T::NineBySixteen), // nearest match + RouterAspectRatio::Auto | RouterAspectRatio::Auto2k + | RouterAspectRatio::Auto3k | RouterAspectRatio::Auto4k => None, + }) +} + +fn plan_edit_aspect_ratio( + aspect_ratio: Option, +) -> Option { + use NanoBananaProEditImageAspectRatio as E; + aspect_ratio.map(|ar| match ar { + RouterAspectRatio::Auto | RouterAspectRatio::Auto2k + | RouterAspectRatio::Auto3k | RouterAspectRatio::Auto4k => E::Auto, + RouterAspectRatio::Square | RouterAspectRatio::SquareHd => E::OneByOne, + RouterAspectRatio::WideFiveByFour => E::FiveByFour, + RouterAspectRatio::WideFourByThree => E::FourByThree, + RouterAspectRatio::WideThreeByTwo | RouterAspectRatio::Wide => E::ThreeByTwo, + RouterAspectRatio::WideSixteenByNine => E::SixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => E::TwentyOneByNine, + RouterAspectRatio::TallFourByFive => E::FourByFive, + RouterAspectRatio::TallThreeByFour => E::ThreeByFour, + RouterAspectRatio::TallTwoByThree | RouterAspectRatio::Tall => E::TwoByThree, + RouterAspectRatio::TallNineBySixteen => E::NineBySixteen, + RouterAspectRatio::TallNineByTwentyOne => E::NineBySixteen, // nearest match + }) +} + +// ── Image inputs ── + +fn resolve_image_urls( + image_inputs: Option, +) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBananaPro, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> NanoBananaProTextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBananaPro( + FalNanoBananaProRequestState::TextToImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected TextToImage variant") + }; + req + } + + fn unwrap_edit(result: Result) -> NanoBananaProEditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalNanoBananaPro( + FalNanoBananaProRequestState::EditImage(req) + ) + ) = result.expect("build should succeed") else { + panic!("expected EditImage variant") + }; + req + } + + // ── Mode detection ── + + mod mode_detection { + use super::*; + + #[test] + fn no_images_yields_text_to_image() { + let result = build_fal_nano_banana_pro(base_builder()); + let req = unwrap_t2i(result); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn urls_yield_edit_image() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let result = build_fal_nano_banana_pro(builder); + let req = unwrap_edit(result); + assert_eq!(req.image_urls, vec!["https://example.com/img.jpg"]); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + let result = build_fal_nano_banana_pro(builder); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + // ── Num images ── + + mod num_images_tests { + use super::*; + + #[test] + fn default_is_one() { + let req = unwrap_t2i(build_fal_nano_banana_pro(base_builder())); + assert!(matches!(req.num_images, NanoBananaProTextToImageNumImages::One)); + } + + #[test] + fn explicit_three() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.num_images, NanoBananaProTextToImageNumImages::Three)); + } + + #[test] + fn zero_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana_pro(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_error_out() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + ..base_builder() + }; + assert!(matches!( + build_fal_nano_banana_pro(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(7), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.num_images, NanoBananaProTextToImageNumImages::Four)); + } + + #[test] + fn edit_mode_num_images() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + image_batch_count: Some(2), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.num_images, NanoBananaProEditImageNumImages::Two)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn none_is_none() { + let req = unwrap_t2i(build_fal_nano_banana_pro(base_builder())); + assert!(req.resolution.is_none()); + } + + #[test] + fn one_k_maps_to_one_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::OneK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.resolution, Some(NanoBananaProTextToImageResolution::OneK))); + } + + #[test] + fn two_k_maps_to_two_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::TwoK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.resolution, Some(NanoBananaProTextToImageResolution::TwoK))); + } + + #[test] + fn four_k_maps_to_four_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::FourK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.resolution, Some(NanoBananaProTextToImageResolution::FourK))); + } + + #[test] + fn three_k_rounds_down_to_two_k() { + // Match v1's downgrade behavior: 3K → 2K (cheaper, no 3K native support). + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::ThreeK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.resolution, Some(NanoBananaProTextToImageResolution::TwoK))); + } + + #[test] + fn half_k_rounds_to_one_k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::HalfK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.resolution, Some(NanoBananaProTextToImageResolution::OneK))); + } + + #[test] + fn edit_mode_resolution() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + resolution: Some(RouterResolution::FourK), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.resolution, Some(NanoBananaProEditImageResolution::FourK))); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn none_is_none_t2i() { + let req = unwrap_t2i(build_fal_nano_banana_pro(base_builder())); + assert!(req.aspect_ratio.is_none()); + } + + #[test] + fn square_maps_to_one_by_one() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBananaProTextToImageAspectRatio::OneByOne))); + } + + #[test] + fn wide_sixteen_by_nine() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBananaProTextToImageAspectRatio::SixteenByNine))); + } + + #[test] + fn tall_nine_by_sixteen() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBananaProTextToImageAspectRatio::NineBySixteen))); + } + + #[test] + fn auto_yields_none_for_t2i() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert!(req.aspect_ratio.is_none()); + } + + #[test] + fn auto_yields_auto_for_edit() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBananaProEditImageAspectRatio::Auto))); + } + + #[test] + fn edit_square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::SquareHd), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_nano_banana_pro(builder)); + assert!(matches!(req.aspect_ratio, Some(NanoBananaProEditImageAspectRatio::OneByOne))); + } + } + + // ── Prompt ── + + mod prompt_tests { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let builder = GenerateImageRequestBuilder { + prompt: Some("my custom prompt".to_string()), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert_eq!(req.prompt, "my custom prompt"); + } + + #[test] + fn missing_prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { + prompt: None, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_nano_banana_pro(builder)); + assert_eq!(req.prompt, ""); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/cost.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/cost.rs new file mode 100644 index 00000000..cf720e0e --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/cost.rs @@ -0,0 +1,151 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::nano_banana_pro::request::FalNanoBananaProRequestState; + +pub struct FalNanoBananaProCostState { + cost_in_usd_cents: u64, +} + +impl FalNanoBananaProCostState { + pub fn from_request(request: &FalNanoBananaProRequestState) -> Self { + let cost_in_usd_cents = match request { + FalNanoBananaProRequestState::TextToImage(req) => req.calculate_cost_in_cents(), + FalNanoBananaProRequestState::EditImage(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + // v1 sets cost_in_credits to the same value as USD cents (1:1). + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests::api::image::edit::nano_banana_pro_edit_image::api::{ + NanoBananaProEditImageNumImages, NanoBananaProEditImageRequest, + NanoBananaProEditImageResolution, + }; + use fal_client::requests::api::image::text::nano_banana_pro_text_to_image::api::{ + NanoBananaProTextToImageNumImages, NanoBananaProTextToImageRequest, + NanoBananaProTextToImageResolution, + }; + + mod text_to_image_costs { + use super::*; + + fn make_t2i( + num_images: NanoBananaProTextToImageNumImages, + resolution: Option, + ) -> FalNanoBananaProRequestState { + FalNanoBananaProRequestState::TextToImage(NanoBananaProTextToImageRequest { + prompt: "test".to_string(), + num_images, + resolution, + aspect_ratio: None, + }) + } + + #[test] + fn one_image_default_resolution() { + let state = FalNanoBananaProCostState::from_request( + &make_t2i(NanoBananaProTextToImageNumImages::One, None), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(15)); + } + + #[test] + fn four_images_one_k() { + let state = FalNanoBananaProCostState::from_request( + &make_t2i(NanoBananaProTextToImageNumImages::Four, Some(NanoBananaProTextToImageResolution::OneK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(60)); + } + + #[test] + fn one_image_four_k() { + let state = FalNanoBananaProCostState::from_request( + &make_t2i(NanoBananaProTextToImageNumImages::One, Some(NanoBananaProTextToImageResolution::FourK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(30)); + } + + #[test] + fn two_images_four_k() { + let state = FalNanoBananaProCostState::from_request( + &make_t2i(NanoBananaProTextToImageNumImages::Two, Some(NanoBananaProTextToImageResolution::FourK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(60)); + } + } + + mod edit_image_costs { + use super::*; + + fn make_edit( + num_images: NanoBananaProEditImageNumImages, + resolution: Option, + ) -> FalNanoBananaProRequestState { + FalNanoBananaProRequestState::EditImage(NanoBananaProEditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/img.jpg".to_string()], + num_images, + resolution, + aspect_ratio: None, + }) + } + + #[test] + fn one_image_default_resolution() { + let state = FalNanoBananaProCostState::from_request( + &make_edit(NanoBananaProEditImageNumImages::One, None), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(15)); + } + + #[test] + fn three_images_two_k() { + let state = FalNanoBananaProCostState::from_request( + &make_edit(NanoBananaProEditImageNumImages::Three, Some(NanoBananaProEditImageResolution::TwoK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(45)); + } + + #[test] + fn one_image_four_k() { + let state = FalNanoBananaProCostState::from_request( + &make_edit(NanoBananaProEditImageNumImages::One, Some(NanoBananaProEditImageResolution::FourK)), + ); + assert_eq!(state.estimate_cost().cost_in_usd_cents, Some(30)); + } + } + + #[test] + fn cost_flags_are_correct() { + let state = FalNanoBananaProCostState::from_request( + &FalNanoBananaProRequestState::TextToImage(NanoBananaProTextToImageRequest { + prompt: "test".to_string(), + num_images: NanoBananaProTextToImageNumImages::One, + resolution: None, + aspect_ratio: None, + }), + ); + let cost = state.estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/mod.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/request.rs b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/request.rs new file mode 100644 index 00000000..4f4318cb --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/nano_banana_pro/request.rs @@ -0,0 +1,168 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::edit::nano_banana_pro_edit_image::api::NanoBananaProEditImageRequest; +use fal_client::requests::api::image::text::nano_banana_pro_text_to_image::api::NanoBananaProTextToImageRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalNanoBananaProRequestState { + TextToImage(NanoBananaProTextToImageRequest), + EditImage(NanoBananaProEditImageRequest), +} + +impl FalNanoBananaProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } + } + } +} + +// ── Helpers ── + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request + .send_webhook_request(&client.api_key, webhook_url) + .await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request + .send_queue_request(&client.api_key) + .await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::edit::nano_banana_pro_edit_image::api::{ + NanoBananaProEditImageAspectRatio, NanoBananaProEditImageNumImages, + NanoBananaProEditImageResolution, + }; + use fal_client::requests::api::image::text::nano_banana_pro_text_to_image::api::{ + NanoBananaProTextToImageAspectRatio, NanoBananaProTextToImageNumImages, + NanoBananaProTextToImageResolution, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + // ── Text-to-image ── + + mod text_to_image { + use super::*; + + fn t2i_request() -> FalNanoBananaProRequestState { + FalNanoBananaProRequestState::TextToImage(NanoBananaProTextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: NanoBananaProTextToImageNumImages::One, + resolution: Some(NanoBananaProTextToImageResolution::OneK), + aspect_ratio: Some(NanoBananaProTextToImageAspectRatio::SixteenByNine), + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = t2i_request(); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook t2i — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + } + + // ── Edit image ── + + mod edit_image { + use super::*; + use test_data::web::image_urls::WHITE_HOUSE_SUNSET_IMAGE_URL; + + fn edit_request() -> FalNanoBananaProRequestState { + FalNanoBananaProRequestState::EditImage(NanoBananaProEditImageRequest { + prompt: "add a party hat to the dog, and put the dog in front of the location".to_string(), + image_urls: vec![ + JUNO_AT_LAKE_IMAGE_URL.to_string(), + WHITE_HOUSE_SUNSET_IMAGE_URL.to_string(), + ], + num_images: NanoBananaProEditImageNumImages::One, + resolution: Some(NanoBananaProEditImageResolution::OneK), + aspect_ratio: Some(NanoBananaProEditImageAspectRatio::SixteenByNine), + }) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = edit_request(); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("Webhook edit — request_id: {:?}, gateway_request_id: {:?}", payload.request_id, payload.gateway_request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/build.rs b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/build.rs new file mode 100644 index 00000000..c8aac184 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/build.rs @@ -0,0 +1,209 @@ +use fal_client::requests::api::image::angle::qwen_edit_2511_edit_image_angle::api::{ + QwenEdit2511AngleImageSize, QwenEdit2511AngleNumImages, QwenEdit2511EditImageAngleRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::qwen_edit_2511_angles::request::FalQwenEdit2511AnglesRequestState; + +pub fn build_fal_qwen_edit_2511_angles( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let image_urls = resolve_image_urls(builder.image_inputs.clone())?; + if image_urls.is_empty() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "Angle models require at least one input image URL".to_string(), + })); + } + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let image_size = plan_image_size(builder.aspect_ratio, strategy)?; + + let request = QwenEdit2511EditImageAngleRequest { + image_urls, + horizontal_angle: builder.horizontal_angle, + vertical_angle: builder.vertical_angle, + zoom: builder.zoom, + additional_prompt: builder.prompt.clone(), + num_images: Some(num_images), + image_size, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalQwenEdit2511Angles(FalQwenEdit2511AnglesRequestState { request }), + )) +} + +fn resolve_image_urls(image_inputs: Option) -> Result, ArtcraftRouterError> { + match image_inputs { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +fn plan_num_images( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use QwenEdit2511AngleNumImages as N; + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(N::One), + 2 => Ok(N::Two), + 3 => Ok(N::Three), + 4 => Ok(N::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(N::Four), + }, + } +} + +fn plan_image_size( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use QwenEdit2511AngleImageSize as S; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Square) => Ok(Some(S::Square)), + Some(RouterAspectRatio::SquareHd) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Wide) | Some(RouterAspectRatio::WideSixteenByNine) => Ok(Some(S::LandscapeSixteenNine)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(S::LandscapeFourThree)), + + Some(RouterAspectRatio::Tall) | Some(RouterAspectRatio::TallNineBySixteen) => Ok(Some(S::PortraitSixteenNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(S::PortraitFourThree)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::SquareHd)), + }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + #[test] + fn passes_through_camera_params() { + let req = unwrap_request(build_fal_qwen_edit_2511_angles(base())); + assert_eq!(req.horizontal_angle, Some(45.0)); + assert_eq!(req.vertical_angle, Some(-15.0)); + assert_eq!(req.zoom, Some(2.0)); + } + + #[test] + fn missing_image_inputs_errors() { + let builder = GenerateImageRequestBuilder { image_inputs: None, ..base() }; + assert!(build_fal_qwen_edit_2511_angles(builder).is_err()); + } + + #[test] + fn media_file_tokens_rejected() { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![MediaFileToken::new_from_str("mf_test")])), + ..base() + }; + assert!(matches!( + build_fal_qwen_edit_2511_angles(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn default_num_images_is_one() { + let req = unwrap_request(build_fal_qwen_edit_2511_angles(base())); + assert!(matches!(req.num_images, Some(QwenEdit2511AngleNumImages::One))); + } + + #[test] + fn batch_zero_errors() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(0), ..base() }; + assert!(matches!( + build_fal_qwen_edit_2511_angles(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn batch_over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(9), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base() + }; + let req = unwrap_request(build_fal_qwen_edit_2511_angles(builder)); + assert!(matches!(req.num_images, Some(QwenEdit2511AngleNumImages::Four))); + } + + fn base() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::QwenEdit2511Angles, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/x.jpg".to_string()])), + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: Some(45.0), + vertical_angle: Some(-15.0), + zoom: Some(2.0), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_request(result: Result) -> QwenEdit2511EditImageAngleRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalQwenEdit2511Angles(state) + ) = result.expect("build should succeed") else { + panic!("expected FalQwenEdit2511Angles variant") + }; + state.request + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/cost.rs b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/cost.rs new file mode 100644 index 00000000..99a93ffa --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/cost.rs @@ -0,0 +1,82 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::qwen_edit_2511_angles::request::FalQwenEdit2511AnglesRequestState; + +/// Cost state for Fal Qwen Edit 2511 Angles. Delegates to the fal_client +/// cost calculator (4¢ per output image — $0.035/MP at the default ~1MP). +pub struct FalQwenEdit2511AnglesCostState { + cost_in_usd_cents: u64, +} + +impl FalQwenEdit2511AnglesCostState { + pub fn from_request(request: &FalQwenEdit2511AnglesRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests::api::image::angle::qwen_edit_2511_edit_image_angle::api::{ + QwenEdit2511AngleNumImages, QwenEdit2511EditImageAngleRequest, + }; + + #[test] + fn one_image_is_4_cents() { + assert_eq!(cost_for(QwenEdit2511AngleNumImages::One).cost_in_usd_cents, Some(4)); + } + + #[test] + fn two_images_is_8_cents() { + assert_eq!(cost_for(QwenEdit2511AngleNumImages::Two).cost_in_usd_cents, Some(8)); + } + + #[test] + fn three_images_is_12_cents() { + assert_eq!(cost_for(QwenEdit2511AngleNumImages::Three).cost_in_usd_cents, Some(12)); + } + + #[test] + fn four_images_is_16_cents() { + assert_eq!(cost_for(QwenEdit2511AngleNumImages::Four).cost_in_usd_cents, Some(16)); + } + + #[test] + fn credits_equal_cents() { + let cost = cost_for(QwenEdit2511AngleNumImages::Two); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + + fn cost_for(n: QwenEdit2511AngleNumImages) -> ImageGenerationCostEstimate { + let state = FalQwenEdit2511AnglesCostState::from_request(&FalQwenEdit2511AnglesRequestState { + request: QwenEdit2511EditImageAngleRequest { + image_urls: vec!["https://example.com/x.jpg".to_string()], + horizontal_angle: None, + vertical_angle: None, + zoom: None, + additional_prompt: None, + num_images: Some(n), + image_size: None, + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + }); + state.estimate_cost() + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/mod.rs b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/request.rs b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/request.rs new file mode 100644 index 00000000..207e55cc --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/qwen_edit_2511_angles/request.rs @@ -0,0 +1,112 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::image::angle::qwen_edit_2511_edit_image_angle::api::QwenEdit2511EditImageAngleRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalQwenEdit2511AnglesRequestState { + pub request: QwenEdit2511EditImageAngleRequest, +} + +impl FalQwenEdit2511AnglesRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let outbound: Arc = Arc::new(self.request.clone()); + let payload = send_fal_request(&self.request, client).await?; + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) + } +} + +// ── Helpers ── + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request + .send_webhook_request(&client.api_key, webhook_url) + .await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request + .send_queue_request(&client.api_key) + .await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::image::angle::qwen_edit_2511_edit_image_angle::api::{ + QwenEdit2511AngleImageSize, QwenEdit2511AngleNumImages, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_via_webhook() { + let client = client_with_webhook(); + let state = FalQwenEdit2511AnglesRequestState { + request: QwenEdit2511EditImageAngleRequest { + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + horizontal_angle: Some(45.0), + vertical_angle: Some(-15.0), + zoom: Some(2.0), + additional_prompt: Some("cinematic".to_string()), + num_images: Some(QwenEdit2511AngleNumImages::One), + image_size: Some(QwenEdit2511AngleImageSize::SquareHd), + lora_scale: None, + guidance_scale: None, + num_inference_steps: None, + }, + }; + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4/build.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4/build.rs new file mode 100644 index 00000000..45ff3ae7 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4/build.rs @@ -0,0 +1,383 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4_edit_image_webhook::{ + EnqueueBytedanceSeedreamV4EditImageNumImages, EnqueueBytedanceSeedreamV4EditImageRequest, + EnqueueBytedanceSeedreamV4EditImageSize, +}; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4_text_to_image_webhook::{ + EnqueueBytedanceSeedreamV4TextToImageNumImages, EnqueueBytedanceSeedreamV4TextToImageRequest, + EnqueueBytedanceSeedreamV4TextToImageSize, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::seedream_4::request::FalSeedream4RequestState; + +pub fn build_fal_seedream_4( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let image_urls = resolve_image_list_ref(builder.image_inputs.clone())?; + let is_edit_mode = !image_urls.is_empty(); + let image_size = plan_image_size(builder.aspect_ratio, is_edit_mode, strategy)?; + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + + let state = if is_edit_mode { + FalSeedream4RequestState::EditImage(EnqueueBytedanceSeedreamV4EditImageRequest { + prompt, + image_urls, + num_images: Some(to_edit_num_images(num_images)), + max_images: None, + image_size: image_size.map(to_edit_image_size), + }) + } else { + FalSeedream4RequestState::TextToImage(EnqueueBytedanceSeedreamV4TextToImageRequest { + prompt, + num_images: Some(to_t2i_num_images(num_images)), + max_images: None, + image_size: image_size.map(to_t2i_image_size), + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream4(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> EnqueueBytedanceSeedreamV4TextToImageNumImages { + use EnqueueBytedanceSeedreamV4TextToImageNumImages as T; + match n { + PlannedNumImages::One => T::One, + PlannedNumImages::Two => T::Two, + PlannedNumImages::Three => T::Three, + PlannedNumImages::Four => T::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> EnqueueBytedanceSeedreamV4EditImageNumImages { + use EnqueueBytedanceSeedreamV4EditImageNumImages as E; + match n { + PlannedNumImages::One => E::One, + PlannedNumImages::Two => E::Two, + PlannedNumImages::Three => E::Three, + PlannedNumImages::Four => E::Four, + } +} + +// ── Image size ── + +#[derive(Copy, Clone, Debug)] +enum PlannedImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, + Auto, + Auto2k, + Auto4k, +} + +fn plan_image_size( + aspect_ratio: Option, + is_edit_mode: bool, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlannedImageSize as S; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) => { + if is_edit_mode { Ok(Some(S::Auto)) } else { Ok(Some(S::Square)) } + } + Some(RouterAspectRatio::Auto2k) | Some(RouterAspectRatio::Auto3k) => Ok(Some(S::Auto2k)), + Some(RouterAspectRatio::Auto4k) => Ok(Some(S::Auto4k)), + + Some(RouterAspectRatio::Square) => Ok(Some(S::Square)), + Some(RouterAspectRatio::SquareHd) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Wide) | Some(RouterAspectRatio::WideSixteenByNine) => Ok(Some(S::LandscapeSixteenNine)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(S::LandscapeFourThree)), + + Some(unsupported @ RouterAspectRatio::WideFiveByFour) + | Some(unsupported @ RouterAspectRatio::WideThreeByTwo) + | Some(unsupported @ RouterAspectRatio::WideTwentyOneByNine) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::LandscapeSixteenNine)), + }, + + Some(RouterAspectRatio::Tall) | Some(RouterAspectRatio::TallNineBySixteen) => Ok(Some(S::PortraitSixteenNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(S::PortraitFourThree)), + + Some(unsupported @ RouterAspectRatio::TallFourByFive) + | Some(unsupported @ RouterAspectRatio::TallTwoByThree) + | Some(unsupported @ RouterAspectRatio::TallNineByTwentyOne) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::PortraitSixteenNine)), + }, + } +} + +fn to_t2i_image_size(s: PlannedImageSize) -> EnqueueBytedanceSeedreamV4TextToImageSize { + use EnqueueBytedanceSeedreamV4TextToImageSize as T; + match s { + PlannedImageSize::Square => T::Square, + PlannedImageSize::SquareHd => T::SquareHd, + PlannedImageSize::PortraitFourThree => T::PortraitFourThree, + PlannedImageSize::PortraitSixteenNine => T::PortraitSixteenNine, + PlannedImageSize::LandscapeFourThree => T::LandscapeFourThree, + PlannedImageSize::LandscapeSixteenNine => T::LandscapeSixteenNine, + PlannedImageSize::Auto => T::Auto, + PlannedImageSize::Auto2k => T::Auto2k, + PlannedImageSize::Auto4k => T::Auto4k, + } +} + +fn to_edit_image_size(s: PlannedImageSize) -> EnqueueBytedanceSeedreamV4EditImageSize { + use EnqueueBytedanceSeedreamV4EditImageSize as E; + match s { + PlannedImageSize::Square => E::Square, + PlannedImageSize::SquareHd => E::SquareHd, + PlannedImageSize::PortraitFourThree => E::PortraitFourThree, + PlannedImageSize::PortraitSixteenNine => E::PortraitSixteenNine, + PlannedImageSize::LandscapeFourThree => E::LandscapeFourThree, + PlannedImageSize::LandscapeSixteenNine => E::LandscapeSixteenNine, + PlannedImageSize::Auto => E::Auto, + PlannedImageSize::Auto2k => E::Auto2k, + PlannedImageSize::Auto4k => E::Auto4k, + } +} + +// ── Image inputs ── + +fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_list_ref { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream4, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> EnqueueBytedanceSeedreamV4TextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream4(FalSeedream4RequestState::TextToImage(req)) + ) = result.expect("build should succeed") else { panic!("expected TextToImage variant") }; + req + } + + fn unwrap_edit(result: Result) -> EnqueueBytedanceSeedreamV4EditImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream4(FalSeedream4RequestState::EditImage(req)) + ) = result.expect("build should succeed") else { panic!("expected EditImage variant") }; + req + } + + // ── Mode detection ── + + #[test] + fn no_image_inputs_is_t2i() { + let req = unwrap_t2i(build_fal_seedream_4(base_builder())); + assert_eq!(req.prompt, "a cat in space"); + } + + #[test] + fn image_inputs_is_edit() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + ..base_builder() + }; + let req = unwrap_edit(build_fal_seedream_4(builder)); + assert_eq!(req.image_urls, vec!["https://example.com/img.jpg".to_string()]); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + assert!(matches!( + build_fal_seedream_4(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + // ── Image size ── + + #[test] + fn t2i_default_size_is_none() { + let req = unwrap_t2i(build_fal_seedream_4(base_builder())); + assert!(req.image_size.is_none()); + } + + #[test] + fn t2i_auto_maps_to_square() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_4(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV4TextToImageSize::Square))); + } + + #[test] + fn edit_auto_stays_auto() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/img.jpg".to_string()])), + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_edit(build_fal_seedream_4(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV4EditImageSize::Auto))); + } + + #[test] + fn auto4k_maps_to_auto4k() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto4k), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_4(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV4TextToImageSize::Auto4k))); + } + + #[test] + fn wide_21_9_errors_out() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), + ..base_builder() + }; + assert!(matches!( + build_fal_seedream_4(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "aspect_ratio", .. })) + )); + } + + #[test] + fn wide_21_9_falls_back_with_upgrade() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_4(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV4TextToImageSize::LandscapeSixteenNine))); + } + + // ── Num images ── + + #[test] + fn default_num_images_is_one() { + let req = unwrap_t2i(build_fal_seedream_4(base_builder())); + assert!(matches!(req.num_images, Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::One))); + } + + #[test] + fn zero_batch_count_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_seedream_4(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } + + #[test] + fn over_four_clamps_with_upgrade() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(9), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_4(builder)); + assert!(matches!(req.num_images, Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Four))); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4/cost.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4/cost.rs new file mode 100644 index 00000000..b408fdbe --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4/cost.rs @@ -0,0 +1,124 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4_edit_image_webhook::EnqueueBytedanceSeedreamV4EditImageNumImages; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4_text_to_image_webhook::EnqueueBytedanceSeedreamV4TextToImageNumImages; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::seedream_4::request::FalSeedream4RequestState; + +pub struct FalSeedream4CostState { + num_images: u64, +} + +impl FalSeedream4CostState { + pub fn from_request(request: &FalSeedream4RequestState) -> Self { + let num_images = match request { + FalSeedream4RequestState::TextToImage(req) => match req.num_images { + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::One) => 1, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Two) => 2, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Three) => 3, + Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::Four) => 4, + None => 1, // default + }, + FalSeedream4RequestState::EditImage(req) => match req.num_images { + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::One) => 1, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Two) => 2, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Three) => 3, + Some(EnqueueBytedanceSeedreamV4EditImageNumImages::Four) => 4, + None => 1, + }, + }; + Self { num_images } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Pricing: $0.03 per image. Matches v1. + const COST_PER_IMAGE: u64 = 3; + let cost_in_usd_cents = COST_PER_IMAGE * self.num_images; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4_edit_image_webhook::EnqueueBytedanceSeedreamV4EditImageRequest; + use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4_text_to_image_webhook::EnqueueBytedanceSeedreamV4TextToImageRequest; + + fn t2i_cost(n: EnqueueBytedanceSeedreamV4TextToImageNumImages) -> ImageGenerationCostEstimate { + FalSeedream4CostState::from_request(&FalSeedream4RequestState::TextToImage( + EnqueueBytedanceSeedreamV4TextToImageRequest { + prompt: "test".to_string(), + num_images: Some(n), + max_images: None, + image_size: None, + }, + )).estimate_cost() + } + + fn edit_cost(n: EnqueueBytedanceSeedreamV4EditImageNumImages) -> ImageGenerationCostEstimate { + FalSeedream4CostState::from_request(&FalSeedream4RequestState::EditImage( + EnqueueBytedanceSeedreamV4EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/x.jpg".to_string()], + num_images: Some(n), + max_images: None, + image_size: None, + }, + )).estimate_cost() + } + + #[test] + fn t2i_one_image_is_3_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4TextToImageNumImages::One).cost_in_usd_cents, Some(3)); + } + + #[test] + fn t2i_two_images_is_6_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4TextToImageNumImages::Two).cost_in_usd_cents, Some(6)); + } + + #[test] + fn t2i_three_images_is_9_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4TextToImageNumImages::Three).cost_in_usd_cents, Some(9)); + } + + #[test] + fn t2i_four_images_is_12_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4TextToImageNumImages::Four).cost_in_usd_cents, Some(12)); + } + + #[test] + fn t2i_none_num_images_defaults_to_one() { + let cost = FalSeedream4CostState::from_request(&FalSeedream4RequestState::TextToImage( + EnqueueBytedanceSeedreamV4TextToImageRequest { + prompt: "test".to_string(), + num_images: None, + max_images: None, + image_size: None, + }, + )).estimate_cost(); + assert_eq!(cost.cost_in_usd_cents, Some(3)); + } + + #[test] + fn edit_two_images_matches_t2i_two_images() { + assert_eq!( + edit_cost(EnqueueBytedanceSeedreamV4EditImageNumImages::Two).cost_in_usd_cents, + t2i_cost(EnqueueBytedanceSeedreamV4TextToImageNumImages::Two).cost_in_usd_cents, + ); + } + + #[test] + fn credits_equal_cents() { + let c = t2i_cost(EnqueueBytedanceSeedreamV4TextToImageNumImages::Two); + assert_eq!(c.cost_in_credits, c.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4/mod.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4/request.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4/request.rs new file mode 100644 index 00000000..b0f261d0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4/request.rs @@ -0,0 +1,118 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4_edit_image_webhook::{ + enqueue_bytedance_seedream_v4_edit_image_webhook, EnqueueBytedanceSeedreamV4EditImageArgs, + EnqueueBytedanceSeedreamV4EditImageRequest, +}; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4_text_to_image_webhook::{ + enqueue_bytedance_seedream_v4_text_to_image_webhook, EnqueueBytedanceSeedreamV4TextToImageArgs, + EnqueueBytedanceSeedreamV4TextToImageRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalSeedream4RequestState { + TextToImage(EnqueueBytedanceSeedreamV4TextToImageRequest), + EditImage(EnqueueBytedanceSeedreamV4EditImageRequest), +} + +impl FalSeedream4RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound): (_, Arc) = match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueBytedanceSeedreamV4TextToImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_bytedance_seedream_v4_text_to_image_webhook(args).await, outbound) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueBytedanceSeedreamV4EditImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_bytedance_seedream_v4_edit_image_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4_edit_image_webhook::EnqueueBytedanceSeedreamV4EditImageNumImages; + use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4_text_to_image_webhook::EnqueueBytedanceSeedreamV4TextToImageNumImages; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_t2i_via_webhook() { + let client = client_with_webhook(); + let state = FalSeedream4RequestState::TextToImage(EnqueueBytedanceSeedreamV4TextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: Some(EnqueueBytedanceSeedreamV4TextToImageNumImages::One), + max_images: None, + image_size: None, + }); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("seedream_4 t2i — request_id: {:?}", payload.request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_edit_via_webhook() { + let client = client_with_webhook(); + let state = FalSeedream4RequestState::EditImage(EnqueueBytedanceSeedreamV4EditImageRequest { + prompt: "make it sunset".to_string(), + image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + num_images: Some(EnqueueBytedanceSeedreamV4EditImageNumImages::One), + max_images: None, + image_size: None, + }); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("seedream_4 edit — request_id: {:?}", payload.request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/build.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/build.rs new file mode 100644 index 00000000..175c068b --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/build.rs @@ -0,0 +1,294 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4p5_edit_image_webhook::{ + EnqueueBytedanceSeedreamV4p5EditImageNumImages, EnqueueBytedanceSeedreamV4p5EditImageRequest, + EnqueueBytedanceSeedreamV4p5EditImageSize, +}; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4p5_text_to_image_webhook::{ + EnqueueBytedanceSeedreamV4p5TextToImageNumImages, EnqueueBytedanceSeedreamV4p5TextToImageRequest, + EnqueueBytedanceSeedreamV4p5TextToImageSize, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::seedream_4p5::request::FalSeedream4p5RequestState; + +pub fn build_fal_seedream_4p5( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let image_urls = resolve_image_list_ref(builder.image_inputs.clone())?; + let image_size = plan_image_size(builder.aspect_ratio, strategy)?; + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + + let state = if image_urls.is_empty() { + FalSeedream4p5RequestState::TextToImage(EnqueueBytedanceSeedreamV4p5TextToImageRequest { + prompt, + num_images: Some(to_t2i_num_images(num_images)), + max_images: None, + image_size: image_size.map(to_t2i_image_size), + }) + } else { + FalSeedream4p5RequestState::EditImage(EnqueueBytedanceSeedreamV4p5EditImageRequest { + prompt, + image_urls, + num_images: Some(to_edit_num_images(num_images)), + max_images: None, + image_size: image_size.map(to_edit_image_size), + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream4p5(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> EnqueueBytedanceSeedreamV4p5TextToImageNumImages { + use EnqueueBytedanceSeedreamV4p5TextToImageNumImages as T; + match n { + PlannedNumImages::One => T::One, + PlannedNumImages::Two => T::Two, + PlannedNumImages::Three => T::Three, + PlannedNumImages::Four => T::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> EnqueueBytedanceSeedreamV4p5EditImageNumImages { + use EnqueueBytedanceSeedreamV4p5EditImageNumImages as E; + match n { + PlannedNumImages::One => E::One, + PlannedNumImages::Two => E::Two, + PlannedNumImages::Three => E::Three, + PlannedNumImages::Four => E::Four, + } +} + +// ── Image size ── +// +// Note: Seedream V4.5 lacks the bare "Auto" image_size; only Auto2k/Auto4k are supported. +// Any Auto request falls back to Auto2k. + +#[derive(Copy, Clone, Debug)] +enum PlannedImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, + Auto2k, + Auto4k, +} + +fn plan_image_size( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlannedImageSize as S; + match aspect_ratio { + None => Ok(None), + + // No bare Auto for v4.5 — fall back to Auto2k. + Some(RouterAspectRatio::Auto) | Some(RouterAspectRatio::Auto2k) | Some(RouterAspectRatio::Auto3k) => Ok(Some(S::Auto2k)), + Some(RouterAspectRatio::Auto4k) => Ok(Some(S::Auto4k)), + + Some(RouterAspectRatio::Square) => Ok(Some(S::Square)), + Some(RouterAspectRatio::SquareHd) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Wide) | Some(RouterAspectRatio::WideSixteenByNine) => Ok(Some(S::LandscapeSixteenNine)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(S::LandscapeFourThree)), + + Some(unsupported @ RouterAspectRatio::WideFiveByFour) + | Some(unsupported @ RouterAspectRatio::WideThreeByTwo) + | Some(unsupported @ RouterAspectRatio::WideTwentyOneByNine) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::LandscapeSixteenNine)), + }, + + Some(RouterAspectRatio::Tall) | Some(RouterAspectRatio::TallNineBySixteen) => Ok(Some(S::PortraitSixteenNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(S::PortraitFourThree)), + + Some(unsupported @ RouterAspectRatio::TallFourByFive) + | Some(unsupported @ RouterAspectRatio::TallTwoByThree) + | Some(unsupported @ RouterAspectRatio::TallNineByTwentyOne) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::PortraitSixteenNine)), + }, + } +} + +fn to_t2i_image_size(s: PlannedImageSize) -> EnqueueBytedanceSeedreamV4p5TextToImageSize { + use EnqueueBytedanceSeedreamV4p5TextToImageSize as T; + match s { + PlannedImageSize::Square => T::Square, + PlannedImageSize::SquareHd => T::SquareHd, + PlannedImageSize::PortraitFourThree => T::PortraitFourThree, + PlannedImageSize::PortraitSixteenNine => T::PortraitSixteenNine, + PlannedImageSize::LandscapeFourThree => T::LandscapeFourThree, + PlannedImageSize::LandscapeSixteenNine => T::LandscapeSixteenNine, + PlannedImageSize::Auto2k => T::Auto2k, + PlannedImageSize::Auto4k => T::Auto4k, + } +} + +fn to_edit_image_size(s: PlannedImageSize) -> EnqueueBytedanceSeedreamV4p5EditImageSize { + use EnqueueBytedanceSeedreamV4p5EditImageSize as E; + match s { + PlannedImageSize::Square => E::Square, + PlannedImageSize::SquareHd => E::SquareHd, + PlannedImageSize::PortraitFourThree => E::PortraitFourThree, + PlannedImageSize::PortraitSixteenNine => E::PortraitSixteenNine, + PlannedImageSize::LandscapeFourThree => E::LandscapeFourThree, + PlannedImageSize::LandscapeSixteenNine => E::LandscapeSixteenNine, + PlannedImageSize::Auto2k => E::Auto2k, + PlannedImageSize::Auto4k => E::Auto4k, + } +} + +// ── Image inputs ── + +fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_list_ref { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream4p5, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> EnqueueBytedanceSeedreamV4p5TextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream4p5(FalSeedream4p5RequestState::TextToImage(req)) + ) = result.expect("build should succeed") else { panic!("expected TextToImage variant") }; + req + } + + #[test] + fn auto_falls_back_to_auto2k() { + // Seedream 4.5 has no bare Auto — request with Auto should map to Auto2k. + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_4p5(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV4p5TextToImageSize::Auto2k))); + } + + #[test] + fn auto4k_stays_auto4k() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto4k), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_4p5(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV4p5TextToImageSize::Auto4k))); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + assert!(matches!( + build_fal_seedream_4p5(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn zero_batch_is_error() { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(0), + ..base_builder() + }; + assert!(matches!( + build_fal_seedream_4p5(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)) + )); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/cost.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/cost.rs new file mode 100644 index 00000000..8af55e2e --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/cost.rs @@ -0,0 +1,106 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4p5_edit_image_webhook::EnqueueBytedanceSeedreamV4p5EditImageNumImages; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4p5_text_to_image_webhook::EnqueueBytedanceSeedreamV4p5TextToImageNumImages; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::seedream_4p5::request::FalSeedream4p5RequestState; + +pub struct FalSeedream4p5CostState { + num_images: u64, +} + +impl FalSeedream4p5CostState { + pub fn from_request(request: &FalSeedream4p5RequestState) -> Self { + let num_images = match request { + FalSeedream4p5RequestState::TextToImage(req) => match req.num_images { + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::One) => 1, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two) => 2, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Three) => 3, + Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Four) => 4, + None => 1, + }, + FalSeedream4p5RequestState::EditImage(req) => match req.num_images { + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::One) => 1, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Two) => 2, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Three) => 3, + Some(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Four) => 4, + None => 1, + }, + }; + Self { num_images } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Pricing: $0.04 per image. Matches v1. + const COST_PER_IMAGE: u64 = 4; + let cost_in_usd_cents = COST_PER_IMAGE * self.num_images; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4p5_edit_image_webhook::EnqueueBytedanceSeedreamV4p5EditImageRequest; + use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4p5_text_to_image_webhook::EnqueueBytedanceSeedreamV4p5TextToImageRequest; + + fn t2i_cost(n: EnqueueBytedanceSeedreamV4p5TextToImageNumImages) -> ImageGenerationCostEstimate { + FalSeedream4p5CostState::from_request(&FalSeedream4p5RequestState::TextToImage( + EnqueueBytedanceSeedreamV4p5TextToImageRequest { + prompt: "test".to_string(), + num_images: Some(n), + max_images: None, + image_size: None, + }, + )).estimate_cost() + } + + fn edit_cost(n: EnqueueBytedanceSeedreamV4p5EditImageNumImages) -> ImageGenerationCostEstimate { + FalSeedream4p5CostState::from_request(&FalSeedream4p5RequestState::EditImage( + EnqueueBytedanceSeedreamV4p5EditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/x.jpg".to_string()], + num_images: Some(n), + max_images: None, + image_size: None, + }, + )).estimate_cost() + } + + #[test] + fn t2i_one_image_is_4_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::One).cost_in_usd_cents, Some(4)); + } + + #[test] + fn t2i_two_images_is_8_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two).cost_in_usd_cents, Some(8)); + } + + #[test] + fn t2i_four_images_is_16_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Four).cost_in_usd_cents, Some(16)); + } + + #[test] + fn edit_two_images_matches_t2i_two_images() { + assert_eq!( + edit_cost(EnqueueBytedanceSeedreamV4p5EditImageNumImages::Two).cost_in_usd_cents, + t2i_cost(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two).cost_in_usd_cents, + ); + } + + #[test] + fn credits_equal_cents() { + let c = t2i_cost(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::Two); + assert_eq!(c.cost_in_credits, c.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/mod.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/request.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/request.rs new file mode 100644 index 00000000..24620cb4 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_4p5/request.rs @@ -0,0 +1,99 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v4p5_edit_image_webhook::{ + enqueue_bytedance_seedream_v4p5_edit_image_webhook, EnqueueBytedanceSeedreamV4p5EditImageArgs, + EnqueueBytedanceSeedreamV4p5EditImageRequest, +}; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4p5_text_to_image_webhook::{ + enqueue_bytedance_seedream_v4p5_text_to_image_webhook, EnqueueBytedanceSeedreamV4p5TextToImageArgs, + EnqueueBytedanceSeedreamV4p5TextToImageRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalSeedream4p5RequestState { + TextToImage(EnqueueBytedanceSeedreamV4p5TextToImageRequest), + EditImage(EnqueueBytedanceSeedreamV4p5EditImageRequest), +} + +impl FalSeedream4p5RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound): (_, Arc) = match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueBytedanceSeedreamV4p5TextToImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_bytedance_seedream_v4p5_text_to_image_webhook(args).await, outbound) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueBytedanceSeedreamV4p5EditImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_bytedance_seedream_v4p5_edit_image_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v4p5_text_to_image_webhook::EnqueueBytedanceSeedreamV4p5TextToImageNumImages; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_t2i_via_webhook() { + let client = client_with_webhook(); + let state = FalSeedream4p5RequestState::TextToImage(EnqueueBytedanceSeedreamV4p5TextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: Some(EnqueueBytedanceSeedreamV4p5TextToImageNumImages::One), + max_images: None, + image_size: None, + }); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("seedream_4p5 t2i — request_id: {:?}", payload.request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/build.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/build.rs new file mode 100644 index 00000000..20d59c4e --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/build.rs @@ -0,0 +1,317 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v5_lite_edit_image_webhook::{ + EnqueueBytedanceSeedreamV5LiteEditImageNumImages, EnqueueBytedanceSeedreamV5LiteEditImageRequest, + EnqueueBytedanceSeedreamV5LiteEditImageSize, +}; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v5_lite_text_to_image_webhook::{ + EnqueueBytedanceSeedreamV5LiteTextToImageNumImages, EnqueueBytedanceSeedreamV5LiteTextToImageRequest, + EnqueueBytedanceSeedreamV5LiteTextToImageSize, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::fal::seedream_5_lite::request::FalSeedream5LiteRequestState; + +pub fn build_fal_seedream_5_lite( + builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let image_urls = resolve_image_list_ref(builder.image_inputs.clone())?; + let image_size = plan_image_size(builder.aspect_ratio, builder.resolution, strategy)?; + let num_images = plan_num_images(builder.image_batch_count, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + + let state = if image_urls.is_empty() { + FalSeedream5LiteRequestState::TextToImage(EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + prompt, + num_images: Some(to_t2i_num_images(num_images)), + max_images: None, + image_size: image_size.map(to_t2i_image_size), + }) + } else { + FalSeedream5LiteRequestState::EditImage(EnqueueBytedanceSeedreamV5LiteEditImageRequest { + prompt, + image_urls, + num_images: Some(to_edit_num_images(num_images)), + max_images: None, + image_size: image_size.map(to_edit_image_size), + }) + }; + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream5Lite(state), + )) +} + +// ── Num images ── + +#[derive(Copy, Clone, Debug)] +enum PlannedNumImages { + One, + Two, + Three, + Four, +} + +fn plan_num_images( + count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(PlannedNumImages::One), + 2 => Ok(PlannedNumImages::Two), + 3 => Ok(PlannedNumImages::Three), + 4 => Ok(PlannedNumImages::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", count), + })) + } + _ => Ok(PlannedNumImages::Four), + }, + } +} + +fn to_t2i_num_images(n: PlannedNumImages) -> EnqueueBytedanceSeedreamV5LiteTextToImageNumImages { + use EnqueueBytedanceSeedreamV5LiteTextToImageNumImages as T; + match n { + PlannedNumImages::One => T::One, + PlannedNumImages::Two => T::Two, + PlannedNumImages::Three => T::Three, + PlannedNumImages::Four => T::Four, + } +} + +fn to_edit_num_images(n: PlannedNumImages) -> EnqueueBytedanceSeedreamV5LiteEditImageNumImages { + use EnqueueBytedanceSeedreamV5LiteEditImageNumImages as E; + match n { + PlannedNumImages::One => E::One, + PlannedNumImages::Two => E::Two, + PlannedNumImages::Three => E::Three, + PlannedNumImages::Four => E::Four, + } +} + +// ── Image size ── +// +// Note: Seedream V5 Lite supports Auto2k and Auto3k (no 4K, no bare Auto). +// Auto4k requests fall back to Auto3k. + +#[derive(Copy, Clone, Debug)] +enum PlannedImageSize { + Square, + SquareHd, + PortraitFourThree, + PortraitSixteenNine, + LandscapeFourThree, + LandscapeSixteenNine, + Auto2k, + Auto3k, +} + +fn plan_image_size( + aspect_ratio: Option, + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlannedImageSize as S; + match aspect_ratio { + // No aspect_ratio: use resolution as a hint for Auto sizes. + // Seedream v5 lite has no 4K — clamp to 3K. + None => match resolution { + Some(RouterResolution::TwoK) => Ok(Some(S::Auto2k)), + Some(RouterResolution::ThreeK) | Some(RouterResolution::FourK) => Ok(Some(S::Auto3k)), + _ => Ok(None), + }, + + Some(RouterAspectRatio::Auto) | Some(RouterAspectRatio::Auto2k) => Ok(Some(S::Auto2k)), + Some(RouterAspectRatio::Auto3k) => Ok(Some(S::Auto3k)), + // No 4K — fall back to 3K. + Some(RouterAspectRatio::Auto4k) => Ok(Some(S::Auto3k)), + + Some(RouterAspectRatio::Square) => Ok(Some(S::Square)), + Some(RouterAspectRatio::SquareHd) => Ok(Some(S::SquareHd)), + + Some(RouterAspectRatio::Wide) | Some(RouterAspectRatio::WideSixteenByNine) => Ok(Some(S::LandscapeSixteenNine)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(S::LandscapeFourThree)), + + Some(unsupported @ RouterAspectRatio::WideFiveByFour) + | Some(unsupported @ RouterAspectRatio::WideThreeByTwo) + | Some(unsupported @ RouterAspectRatio::WideTwentyOneByNine) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::LandscapeSixteenNine)), + }, + + Some(RouterAspectRatio::Tall) | Some(RouterAspectRatio::TallNineBySixteen) => Ok(Some(S::PortraitSixteenNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(S::PortraitFourThree)), + + Some(unsupported @ RouterAspectRatio::TallFourByFive) + | Some(unsupported @ RouterAspectRatio::TallTwoByThree) + | Some(unsupported @ RouterAspectRatio::TallNineByTwentyOne) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(S::PortraitSixteenNine)), + }, + } +} + +fn to_t2i_image_size(s: PlannedImageSize) -> EnqueueBytedanceSeedreamV5LiteTextToImageSize { + use EnqueueBytedanceSeedreamV5LiteTextToImageSize as T; + match s { + PlannedImageSize::Square => T::Square, + PlannedImageSize::SquareHd => T::SquareHd, + PlannedImageSize::PortraitFourThree => T::PortraitFourThree, + PlannedImageSize::PortraitSixteenNine => T::PortraitSixteenNine, + PlannedImageSize::LandscapeFourThree => T::LandscapeFourThree, + PlannedImageSize::LandscapeSixteenNine => T::LandscapeSixteenNine, + PlannedImageSize::Auto2k => T::Auto2k, + PlannedImageSize::Auto3k => T::Auto3k, + } +} + +fn to_edit_image_size(s: PlannedImageSize) -> EnqueueBytedanceSeedreamV5LiteEditImageSize { + use EnqueueBytedanceSeedreamV5LiteEditImageSize as E; + match s { + PlannedImageSize::Square => E::Square, + PlannedImageSize::SquareHd => E::SquareHd, + PlannedImageSize::PortraitFourThree => E::PortraitFourThree, + PlannedImageSize::PortraitSixteenNine => E::PortraitSixteenNine, + PlannedImageSize::LandscapeFourThree => E::LandscapeFourThree, + PlannedImageSize::LandscapeSixteenNine => E::LandscapeSixteenNine, + PlannedImageSize::Auto2k => E::Auto2k, + PlannedImageSize::Auto3k => E::Auto3k, + } +} + +// ── Image inputs ── + +fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_list_ref { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5Lite, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn unwrap_t2i(result: Result) -> EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + let ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::FalSeedream5Lite(FalSeedream5LiteRequestState::TextToImage(req)) + ) = result.expect("build should succeed") else { panic!("expected TextToImage variant") }; + req + } + + #[test] + fn auto_maps_to_auto2k() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_5_lite(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV5LiteTextToImageSize::Auto2k))); + } + + #[test] + fn auto4k_falls_back_to_auto3k() { + // Seedream 5 Lite has no 4K — clamp to 3K. + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto4k), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_5_lite(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV5LiteTextToImageSize::Auto3k))); + } + + #[test] + fn no_aspect_no_resolution_yields_none() { + let req = unwrap_t2i(build_fal_seedream_5_lite(base_builder())); + assert!(req.image_size.is_none()); + } + + #[test] + fn resolution_two_k_triggers_auto2k_when_no_aspect() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::TwoK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_5_lite(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV5LiteTextToImageSize::Auto2k))); + } + + #[test] + fn resolution_four_k_clamps_to_auto3k() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::FourK), + ..base_builder() + }; + let req = unwrap_t2i(build_fal_seedream_5_lite(builder)); + assert!(matches!(req.image_size, Some(EnqueueBytedanceSeedreamV5LiteTextToImageSize::Auto3k))); + } + + #[test] + fn media_tokens_return_error() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![])), + ..base_builder() + }; + assert!(matches!( + build_fal_seedream_5_lite(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/cost.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/cost.rs new file mode 100644 index 00000000..ed083a76 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/cost.rs @@ -0,0 +1,106 @@ +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v5_lite_edit_image_webhook::EnqueueBytedanceSeedreamV5LiteEditImageNumImages; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v5_lite_text_to_image_webhook::EnqueueBytedanceSeedreamV5LiteTextToImageNumImages; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::fal::seedream_5_lite::request::FalSeedream5LiteRequestState; + +pub struct FalSeedream5LiteCostState { + num_images: u64, +} + +impl FalSeedream5LiteCostState { + pub fn from_request(request: &FalSeedream5LiteRequestState) -> Self { + let num_images = match request { + FalSeedream5LiteRequestState::TextToImage(req) => match req.num_images { + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::One) => 1, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two) => 2, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Three) => 3, + Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Four) => 4, + None => 1, + }, + FalSeedream5LiteRequestState::EditImage(req) => match req.num_images { + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::One) => 1, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Two) => 2, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Three) => 3, + Some(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Four) => 4, + None => 1, + }, + }; + Self { num_images } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + // Pricing: $0.035 per image — rounded up to 4 cents. Matches v1. + const COST_PER_IMAGE: u64 = 4; + let cost_in_usd_cents = COST_PER_IMAGE * self.num_images; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v5_lite_edit_image_webhook::EnqueueBytedanceSeedreamV5LiteEditImageRequest; + use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v5_lite_text_to_image_webhook::EnqueueBytedanceSeedreamV5LiteTextToImageRequest; + + fn t2i_cost(n: EnqueueBytedanceSeedreamV5LiteTextToImageNumImages) -> ImageGenerationCostEstimate { + FalSeedream5LiteCostState::from_request(&FalSeedream5LiteRequestState::TextToImage( + EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + prompt: "test".to_string(), + num_images: Some(n), + max_images: None, + image_size: None, + }, + )).estimate_cost() + } + + fn edit_cost(n: EnqueueBytedanceSeedreamV5LiteEditImageNumImages) -> ImageGenerationCostEstimate { + FalSeedream5LiteCostState::from_request(&FalSeedream5LiteRequestState::EditImage( + EnqueueBytedanceSeedreamV5LiteEditImageRequest { + prompt: "test".to_string(), + image_urls: vec!["https://example.com/x.jpg".to_string()], + num_images: Some(n), + max_images: None, + image_size: None, + }, + )).estimate_cost() + } + + #[test] + fn t2i_one_image_is_4_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::One).cost_in_usd_cents, Some(4)); + } + + #[test] + fn t2i_two_images_is_8_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two).cost_in_usd_cents, Some(8)); + } + + #[test] + fn t2i_four_images_is_16_cents() { + assert_eq!(t2i_cost(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Four).cost_in_usd_cents, Some(16)); + } + + #[test] + fn edit_two_images_matches_t2i_two_images() { + assert_eq!( + edit_cost(EnqueueBytedanceSeedreamV5LiteEditImageNumImages::Two).cost_in_usd_cents, + t2i_cost(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two).cost_in_usd_cents, + ); + } + + #[test] + fn credits_equal_cents() { + let c = t2i_cost(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::Two); + assert_eq!(c.cost_in_credits, c.cost_in_usd_cents); + } +} diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/mod.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/request.rs b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/request.rs new file mode 100644 index 00000000..bc271279 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/fal/seedream_5_lite/request.rs @@ -0,0 +1,99 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::image::edit::enqueue_bytedance_seedream_v5_lite_edit_image_webhook::{ + enqueue_bytedance_seedream_v5_lite_edit_image_webhook, EnqueueBytedanceSeedreamV5LiteEditImageArgs, + EnqueueBytedanceSeedreamV5LiteEditImageRequest, +}; +use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v5_lite_text_to_image_webhook::{ + enqueue_bytedance_seedream_v5_lite_text_to_image_webhook, EnqueueBytedanceSeedreamV5LiteTextToImageArgs, + EnqueueBytedanceSeedreamV5LiteTextToImageRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + FalImageResponsePayload, GenerateImageResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalSeedream5LiteRequestState { + TextToImage(EnqueueBytedanceSeedreamV5LiteTextToImageRequest), + EditImage(EnqueueBytedanceSeedreamV5LiteEditImageRequest), +} + +impl FalSeedream5LiteRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound): (_, Arc) = match self { + Self::TextToImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueBytedanceSeedreamV5LiteTextToImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_bytedance_seedream_v5_lite_text_to_image_webhook(args).await, outbound) + } + Self::EditImage(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueBytedanceSeedreamV5LiteEditImageArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_bytedance_seedream_v5_lite_edit_image_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateImageResponse::Fal(FalImageResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests_old::webhook::image::text::enqueue_bytedance_seedream_v5_lite_text_to_image_webhook::EnqueueBytedanceSeedreamV5LiteTextToImageNumImages; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_t2i_via_webhook() { + let client = client_with_webhook(); + let state = FalSeedream5LiteRequestState::TextToImage(EnqueueBytedanceSeedreamV5LiteTextToImageRequest { + prompt: "a corgi wearing sunglasses on a surfboard".to_string(), + num_images: Some(EnqueueBytedanceSeedreamV5LiteTextToImageNumImages::One), + max_images: None, + image_size: None, + }); + let response = state.send(&client).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + println!("seedream_5_lite t2i — request_id: {:?}", payload.request_id); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/build.rs b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/build.rs new file mode 100644 index 00000000..7a5a74b5 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/build.rs @@ -0,0 +1,94 @@ +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::grok::grok_imagine_image::request::GrokImagineImageRequestState; + +/// Build a first-party Grok Imagine image request. `enable_pro` selects quality +/// ("pro") mode over fast ("speed"); the two `RouterImageModel`s map here. +pub fn build_grok_imagine_image( + builder: GenerateImageRequestBuilder, + enable_pro: bool, +) -> Result { + // The imagine websocket path is text-to-image only for now. + if has_image_inputs(builder.image_inputs.as_ref()) { + return Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + "Grok Imagine does not support image references yet".to_string(), + )); + } + + let prompt = builder.prompt.unwrap_or_default().trim().to_string(); + let aspect_ratio = builder.aspect_ratio.unwrap_or(RouterAspectRatio::Square); + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::GrokImagineImage(GrokImagineImageRequestState { + prompt, + aspect_ratio, + enable_pro, + }), + )) +} + +fn has_image_inputs(image_inputs: Option<&ImageListRef>) -> bool { + image_inputs.is_some_and(|refs| !refs.is_empty()) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::generation_mode_mismatch_strategy::GenerationModeMismatchStrategy; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GrokImagineImage, + provider: RouterProvider::Grok, + prompt: Some(" a red kite ".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + } + } + + fn built(builder: GenerateImageRequestBuilder, enable_pro: bool) -> GrokImagineImageRequestState { + match build_grok_imagine_image(builder, enable_pro).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::GrokImagineImage(r)) => r, + _ => panic!("expected a direct Grok Imagine request"), + } + } + + #[test] + fn trims_prompt_and_carries_aspect_and_mode() { + let state = built(base_builder(), true); + assert_eq!(state.prompt, "a red kite"); + assert_eq!(state.aspect_ratio, RouterAspectRatio::WideSixteenByNine); + assert!(state.enable_pro); + } + + #[test] + fn defaults_aspect_to_square() { + let builder = GenerateImageRequestBuilder { aspect_ratio: None, ..base_builder() }; + assert_eq!(built(builder, false).aspect_ratio, RouterAspectRatio::Square); + } + + #[test] + fn image_inputs_are_rejected() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/x.png".to_string()])), + ..base_builder() + }; + assert!(build_grok_imagine_image(builder, false).is_err()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/cost.rs b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/cost.rs new file mode 100644 index 00000000..3933478c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/cost.rs @@ -0,0 +1,28 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::grok::grok_imagine_image::request::GrokImagineImageRequestState; + +/// Cost state for first-party (cookie-session) Grok Imagine image generation. +/// +/// TODO(pricing): this runs on the USER'S OWN Grok account, so it does not +/// consume Artcraft credits. Placeholder reporting it as free/unlimited, like +/// the first-party Midjourney path; revisit the real pricing decision before +/// shipping. +pub struct GrokImagineImageCostState; + +impl GrokImagineImageCostState { + pub fn from_request(_request: &GrokImagineImageRequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + cost_in_credits: Some(0), + cost_in_usd_cents: None, + is_free: true, + is_unlimited: true, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/mod.rs b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/request.rs b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/request.rs new file mode 100644 index 00000000..d23207a7 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/grok/grok_imagine_image/request.rs @@ -0,0 +1,86 @@ +use grok_consumer_client::endpoint_bindings::generate_image_websocket::messages::websocket_client_message::{FastAspectRatio, QualityAspectRatio}; +use grok_consumer_client::prompt_flags::PromptFlags; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::router_grok_client::RouterGrokClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + GenerateImageResponse, GrokImageResponsePayload, +}; + +/// A ready-to-send first-party Grok Imagine image request. Fast vs quality +/// ("pro") is `enable_pro`; the two modes support slightly different aspect +/// ratios (see [`fast_aspect`] / [`quality_aspect`]). +#[derive(Debug, Clone)] +pub struct GrokImagineImageRequestState { + pub prompt: String, + pub aspect_ratio: RouterAspectRatio, + pub enable_pro: bool, +} + +impl GrokImagineImageRequestState { + /// Send the prompt on the client's imagine websocket and return the prompt's + /// request id right away. Finished images arrive later on the same socket, + /// tagged with that id — the caller's polling thread collects them. + pub async fn send( + &self, + client: &RouterGrokClient, + ) -> Result { + let websocket = &client.image_websocket; + let flags = PromptFlags::default(); + + let request_id = if self.enable_pro { + websocket + .send_quality_image_prompt_with_retry(&self.prompt, quality_aspect(self.aspect_ratio), &flags) + .await + } else { + websocket + .send_fast_image_prompt_with_retry(&self.prompt, fast_aspect(self.aspect_ratio), &flags) + .await + } + .map_err(|err| grok_err("send prompt", err))?; + + Ok(GenerateImageResponse::Grok(GrokImageResponsePayload { + request_id: request_id.to_string(), + })) + } +} + +fn grok_err(stage: &str, err: impl std::fmt::Display) -> ArtcraftRouterError { + ArtcraftRouterError::Provider(ProviderError::Grok(format!("{stage}: {err}"))) +} + +/// Map a router aspect ratio to fast mode's supported set (nearest fit). +fn fast_aspect(ratio: RouterAspectRatio) -> FastAspectRatio { + match ratio { + RouterAspectRatio::WideThreeByTwo | RouterAspectRatio::WideFourByThree => FastAspectRatio::WideThreeByTwo, + RouterAspectRatio::WideSixteenByNine + | RouterAspectRatio::Wide + | RouterAspectRatio::WideTwentyOneByNine => FastAspectRatio::WideSixteenByNine, + RouterAspectRatio::TallTwoByThree + | RouterAspectRatio::TallThreeByFour + | RouterAspectRatio::TallFourByFive => FastAspectRatio::TallTwoByThree, + RouterAspectRatio::TallNineBySixteen + | RouterAspectRatio::Tall + | RouterAspectRatio::TallNineByTwentyOne => FastAspectRatio::TallNineBySixteen, + _ => FastAspectRatio::Square, + } +} + +/// Map a router aspect ratio to quality mode's larger supported set. +fn quality_aspect(ratio: RouterAspectRatio) -> QualityAspectRatio { + match ratio { + RouterAspectRatio::WideThreeByTwo => QualityAspectRatio::WideThreeByTwo, + RouterAspectRatio::WideFourByThree => QualityAspectRatio::WideFourByThree, + RouterAspectRatio::WideSixteenByNine | RouterAspectRatio::Wide => QualityAspectRatio::WideSixteenByNine, + RouterAspectRatio::WideTwentyOneByNine => QualityAspectRatio::WideTwentyOneByNine, + RouterAspectRatio::TallTwoByThree + | RouterAspectRatio::TallThreeByFour + | RouterAspectRatio::TallFourByFive => QualityAspectRatio::TallTwoByThree, + RouterAspectRatio::TallNineBySixteen + | RouterAspectRatio::Tall + | RouterAspectRatio::TallNineByTwentyOne => QualityAspectRatio::TallNineBySixteen, + _ => QualityAspectRatio::Square, + } +} diff --git a/crates/router/src/generate/generate_image/providers/grok/mod.rs b/crates/router/src/generate/generate_image/providers/grok/mod.rs new file mode 100644 index 00000000..c9369dfc --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/grok/mod.rs @@ -0,0 +1,7 @@ +//! First-party (cookie-session) Grok Imagine image generation. +//! +//! Sends prompts on the user's own grok.com "imagine" websocket (the app owns +//! the socket; see `RouterGrokClient`). Sending returns the prompt's request +//! id immediately; finished images arrive later on the same socket, keyed by +//! that id. Fast vs quality ("pro") is a flag on the request. +pub mod grok_imagine_image; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/common.rs b/crates/router/src/generate/generate_image/providers/higgsfield/common.rs new file mode 100644 index 00000000..4cd97197 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/common.rs @@ -0,0 +1,420 @@ +//! Planning helpers shared by every Higgsfield image model: prompt and batch +//! validation, and "nearest supported option" snapping for resolutions and +//! aspect ratios. + +use higgsfield_client::endpoints::generate::image::gpt_image_2::GptImage2AspectRatio; +use higgsfield_client::types::image_batch_size::ImageBatchSize; +use higgsfield_client::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; +use higgsfield_client::types::seedream_aspect_ratio::SeedreamAspectRatio; +use log::warn; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::higgsfield::draft::{HiggsfieldImageDraftState, HiggsfieldImageRemainingItems}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; +use crate::generate::generate_image::providers::higgsfield::request::HiggsfieldImageRequestState; + +/// Higgsfield needs a text prompt for every image model. +pub(crate) fn require_prompt(prompt: Option) -> Result { + let prompt = prompt.unwrap_or_default().trim().to_string(); + if prompt.is_empty() { + return Err(ArtcraftRouterError::InvalidInput("Higgsfield needs a text prompt".to_string())); + } + Ok(prompt) +} + +pub(crate) fn image_input_count(image_inputs: Option<&ImageListRef>) -> usize { + image_inputs.map_or(0, ImageListRef::len) +} + +/// Reject over-limit reference lists before anything is uploaded. +pub(crate) fn check_reference_limit(count: usize, max: usize, model: &str) -> Result<(), ArtcraftRouterError> { + if count > max { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("{count} reference images ({model} on Higgsfield takes at most {max})"), + })); + } + Ok(()) +} + +/// Every Higgsfield image model renders 1–4 images per request. Larger +/// batches clamp to 4 (or error out under `ErrorOut`). +pub(crate) fn plan_batch_size( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + if count == 0 { + return Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)); + } + if let Some(batch_size) = ImageBatchSize::from_u32(count as u32) { + return Ok(batch_size); + } + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{count} (Higgsfield renders at most {} per request)", ImageBatchSize::MAX), + })), + _ => { + warn!("Higgsfield renders at most {} images per request; clamping {}", ImageBatchSize::MAX, count); + Ok(ImageBatchSize::Four) + } + } +} + +/// A total order over resolutions so tiers can be compared across the +/// image (`*K`) and video (`*p`) vocabularies. +pub(crate) fn resolution_rank(resolution: RouterResolution) -> u8 { + match resolution { + RouterResolution::HalfK => 0, + RouterResolution::FourEightyP => 1, + RouterResolution::SevenTwentyP => 2, + RouterResolution::OneK => 3, + RouterResolution::TenEightyP => 4, + RouterResolution::TwoK => 5, + RouterResolution::ThreeK => 6, + RouterResolution::FourK => 7, + } +} + +/// Pick the tier for a requested resolution from a model's supported +/// `tiers` (ascending). An exact match wins; otherwise `PayMoreUpgrade` +/// takes the next tier up (or the top one), `PayLessDowngrade` the next tier +/// down (or the bottom one), and `ErrorOut` refuses. `None` picks `default`. +pub(crate) fn snap_resolution( + requested: Option, + tiers: &[(RouterResolution, T)], + default: T, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + debug_assert!(tiers.windows(2).all(|pair| resolution_rank(pair[0].0) < resolution_rank(pair[1].0)), "tiers must ascend"); + let Some(requested) = requested else { + return Ok(default); + }; + let rank = resolution_rank(requested); + if let Some((_, tier)) = tiers.iter().find(|(supported, _)| resolution_rank(*supported) == rank) { + return Ok(*tier); + } + let snapped = match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{requested:?}"), + })); + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => tiers.iter() + .find(|(supported, _)| resolution_rank(*supported) > rank) + .or_else(|| tiers.last()), + RequestMismatchMitigationStrategy::PayLessDowngrade => tiers.iter() + .rev() + .find(|(supported, _)| resolution_rank(*supported) < rank) + .or_else(|| tiers.first()), + }; + let (snapped_resolution, tier) = snapped.expect("a model offers at least one resolution tier"); + warn!("Higgsfield does not offer {:?} for this model; using {:?} ({:?})", requested, snapped_resolution, strategy); + Ok(*tier) +} + +/// A ratio's numeric value (width / height). `None` for the auto values; +/// the loose `Wide` / `Tall` read as 16:9 / 9:16. +pub(crate) fn aspect_ratio_value(aspect_ratio: RouterAspectRatio) -> Option { + let value = match aspect_ratio { + RouterAspectRatio::Auto + | RouterAspectRatio::Auto2k + | RouterAspectRatio::Auto3k + | RouterAspectRatio::Auto4k => return None, + RouterAspectRatio::Square | RouterAspectRatio::SquareHd => 1.0, + RouterAspectRatio::WideThreeByTwo => 3.0 / 2.0, + RouterAspectRatio::WideFourByThree => 4.0 / 3.0, + RouterAspectRatio::WideFiveByFour => 5.0 / 4.0, + RouterAspectRatio::WideSixteenByNine | RouterAspectRatio::Wide => 16.0 / 9.0, + RouterAspectRatio::WideTwentyOneByNine => 21.0 / 9.0, + RouterAspectRatio::TallTwoByThree => 2.0 / 3.0, + RouterAspectRatio::TallThreeByFour => 3.0 / 4.0, + RouterAspectRatio::TallFourByFive => 4.0 / 5.0, + RouterAspectRatio::TallNineBySixteen | RouterAspectRatio::Tall => 9.0 / 16.0, + RouterAspectRatio::TallNineByTwentyOne => 9.0 / 21.0, + }; + Some(value) +} + +/// The candidate whose numeric ratio is closest to `value` (ties go to the +/// earlier candidate). +pub(crate) fn nearest_aspect_ratio(value: f64, candidates: &[(f64, T)]) -> T { + let mut best = candidates[0]; + for candidate in candidates { + if (candidate.0 - value).abs() < (best.0 - value).abs() - f64::EPSILON { + best = *candidate; + } + } + best.1 +} + +/// The Nano Banana aspect menu (Pro / 2 / 2 Lite): every named ratio plus +/// Auto. With reference images Auto follows the reference, so an unset ratio +/// means Auto when editing and 16:9 for text-to-image. +pub(crate) fn plan_nano_banana_aspect_ratio(requested: Option, editing: bool) -> NanoBananaAspectRatio { + use NanoBananaAspectRatio as Ar; + const CANDIDATES: &[(f64, Ar)] = &[ + (1.0, Ar::Square1x1), + (3.0 / 4.0, Ar::Portrait3x4), + (4.0 / 3.0, Ar::Landscape4x3), + (2.0 / 3.0, Ar::Portrait2x3), + (3.0 / 2.0, Ar::Landscape3x2), + (9.0 / 16.0, Ar::Portrait9x16), + (16.0 / 9.0, Ar::Landscape16x9), + (5.0 / 4.0, Ar::Landscape5x4), + (4.0 / 5.0, Ar::Portrait4x5), + (21.0 / 9.0, Ar::Landscape21x9), + ]; + match requested { + None if editing => Ar::Auto, + None => Ar::Landscape16x9, + Some(ratio) => match aspect_ratio_value(ratio) { + None => Ar::Auto, + Some(value) => nearest_aspect_ratio(value, CANDIDATES), + }, + } +} + +/// GPT Image 2's aspect menu: like Nano Banana's but without 5:4 / 4:5. +pub(crate) fn plan_gpt_image_2_aspect_ratio(requested: Option, editing: bool) -> GptImage2AspectRatio { + use GptImage2AspectRatio as Ar; + const CANDIDATES: &[(f64, Ar)] = &[ + (1.0, Ar::Square1x1), + (3.0 / 2.0, Ar::Landscape3x2), + (2.0 / 3.0, Ar::Portrait2x3), + (16.0 / 9.0, Ar::Landscape16x9), + (9.0 / 16.0, Ar::Portrait9x16), + (4.0 / 3.0, Ar::Landscape4x3), + (3.0 / 4.0, Ar::Portrait3x4), + (21.0 / 9.0, Ar::Landscape21x9), + ]; + match requested { + None if editing => Ar::Auto, + None => Ar::Landscape16x9, + Some(ratio) => match aspect_ratio_value(ratio) { + None => Ar::Auto, + Some(value) => nearest_aspect_ratio(value, CANDIDATES), + }, + } +} + +/// The Seedream menu has no Auto: unset and auto ratios fall back to +/// `default`, everything else snaps to the nearest of its eight ratios. +pub(crate) fn plan_seedream_aspect_ratio(requested: Option, default: SeedreamAspectRatio) -> SeedreamAspectRatio { + use SeedreamAspectRatio as Ar; + const CANDIDATES: &[(f64, Ar)] = &[ + (1.0, Ar::Square1x1), + (4.0 / 3.0, Ar::Landscape4x3), + (3.0 / 4.0, Ar::Portrait3x4), + (16.0 / 9.0, Ar::Landscape16x9), + (21.0 / 9.0, Ar::Landscape21x9), + (9.0 / 16.0, Ar::Portrait9x16), + (2.0 / 3.0, Ar::Portrait2x3), + (3.0 / 2.0, Ar::Landscape3x2), + ]; + match requested.and_then(aspect_ratio_value) { + None => default, + Some(value) => nearest_aspect_ratio(value, CANDIDATES), + } +} + +/// ArtCraft's Seedream models bake a resolution into their "auto" ratios +/// (`auto_2k`, ...). Higgsfield has a real resolution menu, so when no +/// resolution was given the baked-in one becomes the request. +pub(crate) fn seedream_auto_resolution_hint(requested: Option) -> Option { + match requested? { + RouterAspectRatio::Auto2k => Some(RouterResolution::TwoK), + RouterAspectRatio::Auto3k => Some(RouterResolution::ThreeK), + RouterAspectRatio::Auto4k => Some(RouterResolution::FourK), + _ => None, + } +} + +/// Wrap a planned request: with reference images it's a draft (they still +/// have to be uploaded), otherwise it's ready to send. +pub(crate) fn finish(request: HiggsfieldImageRequest, image_inputs: Option) -> ImageGenerationDraftOrRequest { + if image_input_count(image_inputs.as_ref()) == 0 { + return ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::HiggsfieldImage(HiggsfieldImageRequestState { request }), + ); + } + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::HiggsfieldImage(HiggsfieldImageDraftState { + request, + unhandled_request_state: Some(HiggsfieldImageRemainingItems { reference_images: image_inputs }), + })) +} + +#[cfg(test)] +mod tests { + use super::*; + use higgsfield_client::endpoints::generate::image::nano_banana_pro::NanoBananaProResolution; + + const NANO_BANANA_PRO_TIERS: &[(RouterResolution, NanoBananaProResolution)] = &[ + (RouterResolution::OneK, NanoBananaProResolution::OneK), + (RouterResolution::TwoK, NanoBananaProResolution::TwoK), + (RouterResolution::FourK, NanoBananaProResolution::FourK), + ]; + + mod prompts_and_batches { + use super::*; + + #[test] + fn prompt_is_trimmed_and_required() { + assert_eq!(require_prompt(Some(" a cat ".to_string())).unwrap(), "a cat"); + assert!(matches!(require_prompt(Some(" ".to_string())), Err(ArtcraftRouterError::InvalidInput(_)))); + assert!(matches!(require_prompt(None), Err(ArtcraftRouterError::InvalidInput(_)))); + } + + #[test] + fn batch_sizes_clamp_to_four() { + assert_eq!(plan_batch_size(None, RequestMismatchMitigationStrategy::ErrorOut).unwrap(), ImageBatchSize::One); + assert_eq!(plan_batch_size(Some(3), RequestMismatchMitigationStrategy::ErrorOut).unwrap(), ImageBatchSize::Three); + assert_eq!(plan_batch_size(Some(8), RequestMismatchMitigationStrategy::PayMoreUpgrade).unwrap(), ImageBatchSize::Four); + assert_eq!(plan_batch_size(Some(8), RequestMismatchMitigationStrategy::PayLessDowngrade).unwrap(), ImageBatchSize::Four); + assert!(matches!( + plan_batch_size(Some(8), RequestMismatchMitigationStrategy::ErrorOut), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_batch_count", .. })), + )); + assert!(matches!( + plan_batch_size(Some(0), RequestMismatchMitigationStrategy::PayMoreUpgrade), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + )); + } + + #[test] + fn reference_limits() { + assert!(check_reference_limit(4, 4, "x").is_ok()); + assert!(matches!( + check_reference_limit(5, 4, "x"), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. })), + )); + } + } + + mod resolution_snapping { + use super::*; + + #[test] + fn exact_tiers_pass_through_under_every_strategy() { + for strategy in [RequestMismatchMitigationStrategy::ErrorOut, RequestMismatchMitigationStrategy::PayMoreUpgrade, RequestMismatchMitigationStrategy::PayLessDowngrade] { + assert_eq!(snap_resolution(Some(RouterResolution::TwoK), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::TwoK); + } + } + + #[test] + fn none_uses_the_default() { + assert_eq!(snap_resolution(None, NANO_BANANA_PRO_TIERS, NanoBananaProResolution::TwoK, RequestMismatchMitigationStrategy::ErrorOut).unwrap(), NanoBananaProResolution::TwoK); + } + + #[test] + fn upgrade_takes_the_next_tier_up_or_the_top() { + let strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + // 3K sits between 2K and 4K → 4K. + assert_eq!(snap_resolution(Some(RouterResolution::ThreeK), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::FourK); + // Sub-1K tiers → 1K. + assert_eq!(snap_resolution(Some(RouterResolution::HalfK), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::OneK); + assert_eq!(snap_resolution(Some(RouterResolution::SevenTwentyP), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::OneK); + // 1080p sits between 1K and 2K → 2K. + assert_eq!(snap_resolution(Some(RouterResolution::TenEightyP), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::TwoK); + } + + #[test] + fn downgrade_takes_the_next_tier_down_or_the_bottom() { + let strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(snap_resolution(Some(RouterResolution::ThreeK), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::TwoK); + assert_eq!(snap_resolution(Some(RouterResolution::HalfK), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::OneK); + assert_eq!(snap_resolution(Some(RouterResolution::TenEightyP), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, strategy).unwrap(), NanoBananaProResolution::OneK); + } + + #[test] + fn error_out_refuses_unsupported_tiers() { + let err = snap_resolution(Some(RouterResolution::ThreeK), NANO_BANANA_PRO_TIERS, NanoBananaProResolution::OneK, RequestMismatchMitigationStrategy::ErrorOut).unwrap_err(); + assert!(matches!(err, ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "resolution", .. }))); + } + + #[test] + fn ranks_interleave_image_and_video_tiers() { + let ordered = [ + RouterResolution::HalfK, RouterResolution::FourEightyP, RouterResolution::SevenTwentyP, RouterResolution::OneK, + RouterResolution::TenEightyP, RouterResolution::TwoK, RouterResolution::ThreeK, RouterResolution::FourK, + ]; + assert!(ordered.windows(2).all(|pair| resolution_rank(pair[0]) < resolution_rank(pair[1]))); + } + } + + mod aspect_ratio_snapping { + use super::*; + + #[test] + fn nano_banana_maps_every_router_ratio() { + use NanoBananaAspectRatio as Ar; + let cases = [ + (RouterAspectRatio::Square, Ar::Square1x1), + (RouterAspectRatio::SquareHd, Ar::Square1x1), + (RouterAspectRatio::WideThreeByTwo, Ar::Landscape3x2), + (RouterAspectRatio::WideFourByThree, Ar::Landscape4x3), + (RouterAspectRatio::WideFiveByFour, Ar::Landscape5x4), + (RouterAspectRatio::WideSixteenByNine, Ar::Landscape16x9), + (RouterAspectRatio::Wide, Ar::Landscape16x9), + (RouterAspectRatio::WideTwentyOneByNine, Ar::Landscape21x9), + (RouterAspectRatio::TallTwoByThree, Ar::Portrait2x3), + (RouterAspectRatio::TallThreeByFour, Ar::Portrait3x4), + (RouterAspectRatio::TallFourByFive, Ar::Portrait4x5), + (RouterAspectRatio::TallNineBySixteen, Ar::Portrait9x16), + (RouterAspectRatio::Tall, Ar::Portrait9x16), + // 9:21 isn't offered; 9:16 is the closest. + (RouterAspectRatio::TallNineByTwentyOne, Ar::Portrait9x16), + (RouterAspectRatio::Auto, Ar::Auto), + (RouterAspectRatio::Auto2k, Ar::Auto), + ]; + for (requested, expected) in cases { + assert_eq!(plan_nano_banana_aspect_ratio(Some(requested), false), expected, "{requested:?}"); + } + assert_eq!(plan_nano_banana_aspect_ratio(None, false), Ar::Landscape16x9); + assert_eq!(plan_nano_banana_aspect_ratio(None, true), Ar::Auto); + } + + #[test] + fn gpt_image_2_snaps_the_missing_ratios() { + use GptImage2AspectRatio as Ar; + assert_eq!(plan_gpt_image_2_aspect_ratio(Some(RouterAspectRatio::WideFiveByFour), false), Ar::Landscape4x3); + assert_eq!(plan_gpt_image_2_aspect_ratio(Some(RouterAspectRatio::TallFourByFive), false), Ar::Portrait3x4); + assert_eq!(plan_gpt_image_2_aspect_ratio(Some(RouterAspectRatio::SquareHd), false), Ar::Square1x1); + assert_eq!(plan_gpt_image_2_aspect_ratio(Some(RouterAspectRatio::WideTwentyOneByNine), false), Ar::Landscape21x9); + assert_eq!(plan_gpt_image_2_aspect_ratio(Some(RouterAspectRatio::Auto), false), Ar::Auto); + assert_eq!(plan_gpt_image_2_aspect_ratio(None, true), Ar::Auto); + assert_eq!(plan_gpt_image_2_aspect_ratio(None, false), Ar::Landscape16x9); + } + + #[test] + fn seedream_has_no_auto_and_snaps_the_rest() { + use SeedreamAspectRatio as Ar; + assert_eq!(plan_seedream_aspect_ratio(None, Ar::Square1x1), Ar::Square1x1); + assert_eq!(plan_seedream_aspect_ratio(Some(RouterAspectRatio::Auto), Ar::Landscape16x9), Ar::Landscape16x9); + assert_eq!(plan_seedream_aspect_ratio(Some(RouterAspectRatio::Auto4k), Ar::Landscape16x9), Ar::Landscape16x9); + assert_eq!(plan_seedream_aspect_ratio(Some(RouterAspectRatio::WideFiveByFour), Ar::Square1x1), Ar::Landscape4x3); + assert_eq!(plan_seedream_aspect_ratio(Some(RouterAspectRatio::TallFourByFive), Ar::Square1x1), Ar::Portrait3x4); + assert_eq!(plan_seedream_aspect_ratio(Some(RouterAspectRatio::TallNineByTwentyOne), Ar::Square1x1), Ar::Portrait9x16); + assert_eq!(plan_seedream_aspect_ratio(Some(RouterAspectRatio::WideThreeByTwo), Ar::Square1x1), Ar::Landscape3x2); + } + + #[test] + fn seedream_auto_ratios_carry_a_resolution() { + assert!(matches!(seedream_auto_resolution_hint(Some(RouterAspectRatio::Auto2k)), Some(RouterResolution::TwoK))); + assert!(matches!(seedream_auto_resolution_hint(Some(RouterAspectRatio::Auto3k)), Some(RouterResolution::ThreeK))); + assert!(matches!(seedream_auto_resolution_hint(Some(RouterAspectRatio::Auto4k)), Some(RouterResolution::FourK))); + assert!(seedream_auto_resolution_hint(Some(RouterAspectRatio::Auto)).is_none()); + assert!(seedream_auto_resolution_hint(None).is_none()); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/common_test_helpers.rs b/crates/router/src/generate/generate_image/providers/higgsfield/common_test_helpers.rs new file mode 100644 index 00000000..93e45c47 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/common_test_helpers.rs @@ -0,0 +1,53 @@ +//! Test-only helpers shared by the per-model `build.rs` tests. + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_image_model::RouterImageModel; +use crate::api::router_provider::RouterProvider; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::higgsfield::draft::HiggsfieldImageDraftState; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub fn base_builder(model: RouterImageModel) -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model, + provider: RouterProvider::Higgsfield, + prompt: Some("a shiba inu doing a kickflip".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } +} + +pub fn with_references(mut builder: GenerateImageRequestBuilder, count: usize) -> GenerateImageRequestBuilder { + let urls = (0..count).map(|i| format!("https://cdn.example.com/ref_{i}.png")).collect(); + builder.image_inputs = Some(ImageListRef::Urls(urls)); + builder +} + +/// The planned request out of a direct (no references) build. +pub fn unwrap_request(result: ImageGenerationDraftOrRequest) -> HiggsfieldImageRequest { + match result { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::HiggsfieldImage(state)) => state.request, + other => panic!("expected a direct Higgsfield request, got {other:?}"), + } +} + +/// The draft out of a build with references. +pub fn unwrap_draft(result: ImageGenerationDraftOrRequest) -> HiggsfieldImageDraftState { + match result { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::HiggsfieldImage(draft)) => draft, + other => panic!("expected a Higgsfield draft, got {other:?}"), + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/cost.rs b/crates/router/src/generate/generate_image/providers/higgsfield/cost.rs new file mode 100644 index 00000000..43c350fd --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/cost.rs @@ -0,0 +1,33 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::higgsfield::draft::HiggsfieldImageDraftState; +use crate::generate::generate_image::providers::higgsfield::request::HiggsfieldImageRequestState; + +/// Cost state for first-party (cookie-session) Higgsfield image generation. +/// +/// This runs on the USER'S OWN Higgsfield account (its credits or unlimited +/// plan), so it consumes no ArtCraft credits. Reported as free / unlimited +/// like the other first-party providers; Higgsfield's own credit pricing +/// isn't modelled here. +pub struct HiggsfieldImageCostState; + +impl HiggsfieldImageCostState { + pub fn from_request(_request: &HiggsfieldImageRequestState) -> Self { + Self + } + + pub fn from_draft(_draft: &HiggsfieldImageDraftState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + cost_in_credits: Some(0), + cost_in_usd_cents: None, + is_free: true, + is_unlimited: true, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/draft.rs b/crates/router/src/generate/generate_image/providers/higgsfield/draft.rs new file mode 100644 index 00000000..475eef12 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/draft.rs @@ -0,0 +1,60 @@ +use log::info; + +use crate::api::image_list_ref::ImageListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; +use crate::generate::generate_image::providers::higgsfield::request::HiggsfieldImageRequestState; +use crate::utils::higgsfield_media::{upload_media_list, HiggsfieldMediaKind, HiggsfieldUploadContext}; + +/// A planned Higgsfield image request whose reference images still have to +/// be uploaded. `to_request` does the uploads and produces the sendable state. +#[derive(Clone, Debug)] +pub struct HiggsfieldImageDraftState { + /// Everything but the references, already snapped to Higgsfield's menus. + pub request: HiggsfieldImageRequest, + pub unhandled_request_state: Option, +} + +#[derive(Clone, Debug)] +pub struct HiggsfieldImageRemainingItems { + pub reference_images: Option, +} + +impl HiggsfieldImageDraftState { + pub fn reference_image_count(&self) -> usize { + self.unhandled_request_state.as_ref() + .and_then(|remaining| remaining.reference_images.as_ref()) + .map_or(0, ImageListRef::len) + } + + pub async fn to_request( + &mut self, + draft_context: &ImageGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_higgsfield_client_ref()?; + let uploads = HiggsfieldUploadContext { + session: &client.session, + maybe_map: draft_context.media_file_to_artcraft_url_map, + maybe_cache: draft_context.asset_upload_cache, + maybe_observer: draft_context.asset_upload_observer, + }; + + let mut reference_images = Vec::new(); + if let Some(remaining) = self.unhandled_request_state.take() { + // The image generator's references skip the IP check (as the web app + // does); only the Seedance video models insist on it. + reference_images = upload_media_list( + uploads, + remaining.reference_images.map(Into::into), + HiggsfieldMediaKind::Image, + false, + ).await?; + info!("Uploaded {} reference image(s) to Higgsfield for {}", reference_images.len(), self.request.model_label()); + } + + Ok(HiggsfieldImageRequestState { + request: self.request.clone().with_reference_images(reference_images), + }) + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/gpt_image_2/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/gpt_image_2/build.rs new file mode 100644 index 00000000..4e7d1d1c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/gpt_image_2/build.rs @@ -0,0 +1,86 @@ +//! GPT Image 2 on Higgsfield: 9 aspect ratios (incl. Auto; no 5:4 / 4:5, +//! no "1:1 HD"), Low / Medium / High quality, 1K / 2K / 4K (no 3K), 1–4 +//! images, up to 6 reference images. + +use higgsfield_client::endpoints::generate::image::gpt_image_2::{GptImage2Quality, GptImage2Request, GptImage2Resolution}; + +use crate::api::router_quality::RouterQuality; +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_gpt_image_2_aspect_ratio, require_prompt, snap_resolution, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 6; + +const RESOLUTION_TIERS: &[(RouterResolution, GptImage2Resolution)] = &[ + (RouterResolution::OneK, GptImage2Resolution::OneK), + (RouterResolution::TwoK, GptImage2Resolution::TwoK), + (RouterResolution::FourK, GptImage2Resolution::FourK), +]; + +pub fn build_higgsfield_gpt_image_2(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + let reference_count = image_input_count(image_inputs.as_ref()); + check_reference_limit(reference_count, MAX_REFERENCE_IMAGES, "GPT Image 2")?; + + let aspect_ratio = plan_gpt_image_2_aspect_ratio(builder.aspect_ratio.take(), reference_count > 0); + let quality = plan_quality(builder.quality.take()); + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, GptImage2Resolution::OneK, strategy)?; + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = GptImage2Request::text_to_image(prompt, aspect_ratio, quality, resolution); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::GptImage2(request), image_inputs)) +} + +/// The three tiers line up; unset means the web app's default (Medium). +fn plan_quality(quality: Option) -> GptImage2Quality { + match quality { + None | Some(RouterQuality::Medium) => GptImage2Quality::Medium, + Some(RouterQuality::High) => GptImage2Quality::High, + Some(RouterQuality::Low) => GptImage2Quality::Low, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + use higgsfield_client::endpoints::generate::image::gpt_image_2::GptImage2AspectRatio; + + fn built(builder: GenerateImageRequestBuilder) -> GptImage2Request { + match unwrap_request(build_higgsfield_gpt_image_2(builder).expect("build")) { + HiggsfieldImageRequest::GptImage2(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn three_k_snaps_up_or_down() { + let mut b = base_builder(RouterImageModel::GptImage2); + b.resolution = Some(RouterResolution::ThreeK); + assert_eq!(built(b.clone()).resolution, GptImage2Resolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(built(b).resolution, GptImage2Resolution::TwoK); + } + + #[test] + fn quality_and_missing_ratios() { + let mut b = base_builder(RouterImageModel::GptImage2); + b.quality = Some(RouterQuality::Low); + b.aspect_ratio = Some(RouterAspectRatio::SquareHd); + let request = built(b); + assert_eq!(request.quality, GptImage2Quality::Low); + assert_eq!(request.aspect_ratio, GptImage2AspectRatio::Square1x1); + assert_eq!(plan_quality(None), GptImage2Quality::Medium); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/gpt_image_2/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/gpt_image_2/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/gpt_image_2/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/image_request.rs b/crates/router/src/generate/generate_image/providers/higgsfield/image_request.rs new file mode 100644 index 00000000..65af12c5 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/image_request.rs @@ -0,0 +1,105 @@ +//! One planned Higgsfield image request, whichever model it's for. The +//! per-model `build.rs` files produce these; the shared draft / request / +//! cost states carry them. + +use higgsfield_client::endpoints::generate::image::gpt_image_2::GptImage2Request; +use higgsfield_client::endpoints::generate::image::nano_banana_2::NanoBanana2Request; +use higgsfield_client::endpoints::generate::image::nano_banana_2_lite::NanoBanana2LiteRequest; +use higgsfield_client::endpoints::generate::image::nano_banana_pro::NanoBananaProRequest; +use higgsfield_client::endpoints::generate::image::seedream_4p5::Seedream4p5Request; +use higgsfield_client::endpoints::generate::image::seedream_5p0_lite::Seedream5p0LiteRequest; +use higgsfield_client::endpoints::generate::image::seedream_5p0_pro::Seedream5p0ProRequest; +use higgsfield_client::error::higgsfield_error::HiggsfieldError; +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; +use higgsfield_client::types::enqueue_jobs_response::EnqueueJobsResponse; +use higgsfield_client::types::image_batch_size::ImageBatchSize; +use higgsfield_client::types::media_input::MediaInput; + +#[derive(Clone, Debug)] +pub enum HiggsfieldImageRequest { + NanoBananaPro(NanoBananaProRequest), + NanoBanana2(NanoBanana2Request), + NanoBanana2Lite(NanoBanana2LiteRequest), + GptImage2(GptImage2Request), + Seedream5p0Pro(Seedream5p0ProRequest), + Seedream5p0Lite(Seedream5p0LiteRequest), + Seedream4p5(Seedream4p5Request), +} + +impl HiggsfieldImageRequest { + /// Enqueue on the session (which mints the bearer token and retries once + /// on a rejected token). + pub async fn send(&self, session: &HiggsfieldSession) -> Result { + match self { + Self::NanoBananaPro(request) => session.nano_banana_pro(request.clone()).await, + Self::NanoBanana2(request) => session.nano_banana_2(request.clone()).await, + Self::NanoBanana2Lite(request) => session.nano_banana_2_lite(request.clone()).await, + Self::GptImage2(request) => session.gpt_image_2(request.clone()).await, + Self::Seedream5p0Pro(request) => session.seedream_5p0_pro(request.clone()).await, + Self::Seedream5p0Lite(request) => session.seedream_5p0_lite(request.clone()).await, + Self::Seedream4p5(request) => session.seedream_4p5(request.clone()).await, + } + } + + /// Attach uploaded reference images (image-to-image). + pub fn with_reference_images(self, reference_images: Vec) -> Self { + match self { + Self::NanoBananaPro(request) => Self::NanoBananaPro(request.with_reference_images(reference_images)), + Self::NanoBanana2(request) => Self::NanoBanana2(request.with_reference_images(reference_images)), + Self::NanoBanana2Lite(request) => Self::NanoBanana2Lite(request.with_reference_images(reference_images)), + Self::GptImage2(request) => Self::GptImage2(request.with_reference_images(reference_images)), + Self::Seedream5p0Pro(request) => Self::Seedream5p0Pro(request.with_reference_images(reference_images)), + Self::Seedream5p0Lite(request) => Self::Seedream5p0Lite(request.with_reference_images(reference_images)), + Self::Seedream4p5(request) => Self::Seedream4p5(request.with_reference_images(reference_images)), + } + } + + pub fn prompt(&self) -> &str { + match self { + Self::NanoBananaPro(request) => &request.prompt, + Self::NanoBanana2(request) => &request.prompt, + Self::NanoBanana2Lite(request) => &request.prompt, + Self::GptImage2(request) => &request.prompt, + Self::Seedream5p0Pro(request) => &request.prompt, + Self::Seedream5p0Lite(request) => &request.prompt, + Self::Seedream4p5(request) => &request.prompt, + } + } + + pub fn batch_size(&self) -> ImageBatchSize { + match self { + Self::NanoBananaPro(request) => request.batch_size, + Self::NanoBanana2(request) => request.batch_size, + Self::NanoBanana2Lite(request) => request.batch_size, + Self::GptImage2(request) => request.batch_size, + Self::Seedream5p0Pro(request) => request.batch_size, + Self::Seedream5p0Lite(request) => request.batch_size, + Self::Seedream4p5(request) => request.batch_size, + } + } + + pub fn reference_images(&self) -> &[MediaInput] { + match self { + Self::NanoBananaPro(request) => &request.reference_images, + Self::NanoBanana2(request) => &request.reference_images, + Self::NanoBanana2Lite(request) => &request.reference_images, + Self::GptImage2(request) => &request.reference_images, + Self::Seedream5p0Pro(request) => &request.reference_images, + Self::Seedream5p0Lite(request) => &request.reference_images, + Self::Seedream4p5(request) => &request.reference_images, + } + } + + /// A short label for logs. + pub fn model_label(&self) -> &'static str { + match self { + Self::NanoBananaPro(_) => "Nano Banana Pro", + Self::NanoBanana2(_) => "Nano Banana 2", + Self::NanoBanana2Lite(_) => "Nano Banana 2 Lite", + Self::GptImage2(_) => "GPT Image 2", + Self::Seedream5p0Pro(_) => "Seedream 5.0 Pro", + Self::Seedream5p0Lite(_) => "Seedream 5 Lite", + Self::Seedream4p5(_) => "Seedream 4.5", + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/mod.rs new file mode 100644 index 00000000..b2bb19c1 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/mod.rs @@ -0,0 +1,29 @@ +//! First-party (cookie-session) Higgsfield image generation. +//! +//! Runs on the user's own higgsfield.ai account through a +//! [`HiggsfieldSession`](higgsfield_client::session::higgsfield_session::HiggsfieldSession). +//! Reference images have to live on Higgsfield first, so a request with +//! image inputs goes through the draft phase: `finalize()` downloads each +//! reference (ArtCraft CDN URL or media token) and uploads it as Higgsfield +//! reference media, then the request goes out with the resulting media ids. +//! +//! Each model has its own `build.rs` that plans the request against the +//! option menus Higgsfield actually offers — unsupported resolutions, +//! ratios and batch sizes snap to the nearest tier per the mismatch strategy. +//! The plumbing after that (draft, upload, send, cost) is shared across all +//! models via [`image_request::HiggsfieldImageRequest`]. + +pub mod common; +#[cfg(test)] +pub(crate) mod common_test_helpers; +pub mod cost; +pub mod draft; +pub mod gpt_image_2; +pub mod image_request; +pub mod nano_banana_2; +pub mod nano_banana_2_lite; +pub mod nano_banana_pro; +pub mod request; +pub mod seedream_4p5; +pub mod seedream_5p0_lite; +pub mod seedream_5p0_pro; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2/build.rs new file mode 100644 index 00000000..ddd5d38f --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2/build.rs @@ -0,0 +1,76 @@ +//! Nano Banana 2 on Higgsfield: 11 aspect ratios (incl. Auto), 1K / 2K / 4K +//! (no 0.5K tier), 1–4 images, up to 6 reference images. + +use higgsfield_client::endpoints::generate::image::nano_banana_2::{NanoBanana2Request, NanoBanana2Resolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_nano_banana_aspect_ratio, require_prompt, snap_resolution, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 6; + +const RESOLUTION_TIERS: &[(RouterResolution, NanoBanana2Resolution)] = &[ + (RouterResolution::OneK, NanoBanana2Resolution::OneK), + (RouterResolution::TwoK, NanoBanana2Resolution::TwoK), + (RouterResolution::FourK, NanoBanana2Resolution::FourK), +]; + +pub fn build_higgsfield_nano_banana_2(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + let reference_count = image_input_count(image_inputs.as_ref()); + check_reference_limit(reference_count, MAX_REFERENCE_IMAGES, "Nano Banana 2")?; + + let aspect_ratio = plan_nano_banana_aspect_ratio(builder.aspect_ratio.take(), reference_count > 0); + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, NanoBanana2Resolution::OneK, strategy)?; + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = NanoBanana2Request::text_to_image(prompt, aspect_ratio, resolution); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::NanoBanana2(request), image_inputs)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request, with_references}; + + fn built(builder: GenerateImageRequestBuilder) -> NanoBanana2Request { + match unwrap_request(build_higgsfield_nano_banana_2(builder).expect("build")) { + HiggsfieldImageRequest::NanoBanana2(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn half_k_is_not_offered_and_rounds_to_one_k() { + let mut b = base_builder(RouterImageModel::NanoBanana2); + b.resolution = Some(RouterResolution::HalfK); + assert_eq!(built(b.clone()).resolution, NanoBanana2Resolution::OneK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(built(b.clone()).resolution, NanoBanana2Resolution::OneK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_nano_banana_2(b).is_err()); + } + + #[test] + fn supported_tiers_pass_through() { + let mut b = base_builder(RouterImageModel::NanoBanana2); + b.resolution = Some(RouterResolution::TwoK); + assert_eq!(built(b).resolution, NanoBanana2Resolution::TwoK); + } + + #[test] + fn reference_limit_is_six() { + assert!(build_higgsfield_nano_banana_2(with_references(base_builder(RouterImageModel::NanoBanana2), 6)).is_ok()); + assert!(build_higgsfield_nano_banana_2(with_references(base_builder(RouterImageModel::NanoBanana2), 7)).is_err()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2_lite/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2_lite/build.rs new file mode 100644 index 00000000..8bf78863 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2_lite/build.rs @@ -0,0 +1,78 @@ +//! Nano Banana 2 Lite on Higgsfield: 11 aspect ratios (incl. Auto), a fixed +//! 1K with a High / Minimal quality ("thinking") menu, 1–4 images, up to 6 +//! reference images. The router's Low / Medium / High quality maps onto the +//! two tiers; a requested resolution is ignored (there is no menu). + +use higgsfield_client::endpoints::generate::image::nano_banana_2_lite::{NanoBanana2LiteQuality, NanoBanana2LiteRequest}; +use log::warn; + +use crate::api::router_quality::RouterQuality; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_nano_banana_aspect_ratio, require_prompt, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 6; + +pub fn build_higgsfield_nano_banana_2_lite(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + let reference_count = image_input_count(image_inputs.as_ref()); + check_reference_limit(reference_count, MAX_REFERENCE_IMAGES, "Nano Banana 2 Lite")?; + + if let Some(resolution) = builder.resolution.take() { + warn!("Nano Banana 2 Lite always renders at 1K on Higgsfield; ignoring requested {resolution:?}"); + } + + let aspect_ratio = plan_nano_banana_aspect_ratio(builder.aspect_ratio.take(), reference_count > 0); + let quality = plan_quality(builder.quality.take()); + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = NanoBanana2LiteRequest::text_to_image(prompt, aspect_ratio, quality); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::NanoBanana2Lite(request), image_inputs)) +} + +/// High stays High; anything lower is the "Minimal" tier. +fn plan_quality(quality: Option) -> NanoBanana2LiteQuality { + match quality { + None | Some(RouterQuality::High) => NanoBanana2LiteQuality::High, + Some(RouterQuality::Medium) | Some(RouterQuality::Low) => NanoBanana2LiteQuality::Minimal, + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_resolution::RouterResolution; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + + fn built(builder: GenerateImageRequestBuilder) -> NanoBanana2LiteRequest { + match unwrap_request(build_higgsfield_nano_banana_2_lite(builder).expect("build")) { + HiggsfieldImageRequest::NanoBanana2Lite(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn quality_maps_onto_the_two_tiers() { + assert_eq!(plan_quality(None), NanoBanana2LiteQuality::High); + assert_eq!(plan_quality(Some(RouterQuality::High)), NanoBanana2LiteQuality::High); + assert_eq!(plan_quality(Some(RouterQuality::Medium)), NanoBanana2LiteQuality::Minimal); + assert_eq!(plan_quality(Some(RouterQuality::Low)), NanoBanana2LiteQuality::Minimal); + } + + #[test] + fn resolution_is_ignored_rather_than_rejected() { + let mut b = base_builder(RouterImageModel::NanoBanana2Lite); + b.resolution = Some(RouterResolution::FourK); + b.quality = Some(RouterQuality::Low); + let request = built(b); + assert_eq!(request.quality, NanoBanana2LiteQuality::Minimal); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2_lite/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2_lite/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_2_lite/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_pro/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_pro/build.rs new file mode 100644 index 00000000..c658cecf --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_pro/build.rs @@ -0,0 +1,119 @@ +//! Nano Banana Pro on Higgsfield: 11 aspect ratios (incl. Auto), 1K / 2K / +//! 4K, 1–4 images, up to 4 reference images. + +use higgsfield_client::endpoints::generate::image::nano_banana_pro::{NanoBananaProRequest, NanoBananaProResolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_nano_banana_aspect_ratio, require_prompt, snap_resolution, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 4; + +const RESOLUTION_TIERS: &[(RouterResolution, NanoBananaProResolution)] = &[ + (RouterResolution::OneK, NanoBananaProResolution::OneK), + (RouterResolution::TwoK, NanoBananaProResolution::TwoK), + (RouterResolution::FourK, NanoBananaProResolution::FourK), +]; + +pub fn build_higgsfield_nano_banana_pro(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + let reference_count = image_input_count(image_inputs.as_ref()); + check_reference_limit(reference_count, MAX_REFERENCE_IMAGES, "Nano Banana Pro")?; + + let aspect_ratio = plan_nano_banana_aspect_ratio(builder.aspect_ratio.take(), reference_count > 0); + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, NanoBananaProResolution::OneK, strategy)?; + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = NanoBananaProRequest::text_to_image(prompt, aspect_ratio, resolution); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::NanoBananaPro(request), image_inputs)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_draft, unwrap_request, with_references}; + use higgsfield_client::types::image_batch_size::ImageBatchSize; + use higgsfield_client::types::nano_banana_aspect_ratio::NanoBananaAspectRatio; + + fn builder() -> GenerateImageRequestBuilder { + base_builder(RouterImageModel::NanoBananaPro) + } + + fn built(builder: GenerateImageRequestBuilder) -> NanoBananaProRequest { + match unwrap_request(build_higgsfield_nano_banana_pro(builder).expect("build")) { + HiggsfieldImageRequest::NanoBananaPro(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn defaults_are_the_web_apps() { + let request = built(builder()); + assert_eq!(request.prompt, "a shiba inu doing a kickflip"); + assert_eq!(request.aspect_ratio, NanoBananaAspectRatio::Landscape16x9); + assert_eq!(request.resolution, NanoBananaProResolution::OneK); + assert_eq!(request.batch_size, ImageBatchSize::One); + assert!(request.reference_images.is_empty()); + } + + #[test] + fn options_flow_through() { + let mut b = builder(); + b.aspect_ratio = Some(RouterAspectRatio::TallThreeByFour); + b.resolution = Some(RouterResolution::FourK); + b.image_batch_count = Some(3); + let request = built(b); + assert_eq!(request.aspect_ratio, NanoBananaAspectRatio::Portrait3x4); + assert_eq!(request.resolution, NanoBananaProResolution::FourK); + assert_eq!(request.batch_size, ImageBatchSize::Three); + } + + #[test] + fn unsupported_resolutions_snap_per_strategy() { + let mut b = builder(); + b.resolution = Some(RouterResolution::ThreeK); + assert_eq!(built(b.clone()).resolution, NanoBananaProResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(built(b.clone()).resolution, NanoBananaProResolution::TwoK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_nano_banana_pro(b).is_err()); + // 0.5K (a Nano Banana 2 tier on ArtCraft) rounds up to 1K. + let mut b = builder(); + b.resolution = Some(RouterResolution::HalfK); + assert_eq!(built(b).resolution, NanoBananaProResolution::OneK); + } + + #[test] + fn references_make_a_draft_and_default_to_auto_aspect() { + let draft = unwrap_draft(build_higgsfield_nano_banana_pro(with_references(builder(), 2)).expect("build")); + assert_eq!(draft.reference_image_count(), 2); + match draft.request { + HiggsfieldImageRequest::NanoBananaPro(request) => assert_eq!(request.aspect_ratio, NanoBananaAspectRatio::Auto), + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn too_many_references_are_rejected_before_upload() { + assert!(build_higgsfield_nano_banana_pro(with_references(builder(), MAX_REFERENCE_IMAGES + 1)).is_err()); + assert!(build_higgsfield_nano_banana_pro(with_references(builder(), MAX_REFERENCE_IMAGES)).is_ok()); + } + + #[test] + fn empty_prompt_is_rejected() { + let mut b = builder(); + b.prompt = Some(" ".to_string()); + assert!(matches!(build_higgsfield_nano_banana_pro(b), Err(ArtcraftRouterError::InvalidInput(_)))); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_pro/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_pro/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/nano_banana_pro/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/request.rs b/crates/router/src/generate/generate_image/providers/higgsfield/request.rs new file mode 100644 index 00000000..473b013d --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/request.rs @@ -0,0 +1,38 @@ +use log::info; + +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{GenerateImageResponse, HiggsfieldImageResponsePayload}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +/// A ready-to-send Higgsfield image request: every reference image has been +/// uploaded and is referenced by its Higgsfield media id. +#[derive(Clone, Debug)] +pub struct HiggsfieldImageRequestState { + pub request: HiggsfieldImageRequest, +} + +impl HiggsfieldImageRequestState { + pub async fn send(&self, client: &RouterHiggsfieldClient) -> Result { + info!( + "Enqueuing Higgsfield {} image job: batch={}, references={}", + self.request.model_label(), self.request.batch_size(), self.request.reference_images().len(), + ); + + let response = self.request.send(&client.session).await + .map_err(|err| ArtcraftRouterError::from(ProviderError::Higgsfield(err)))?; + + let job_ids: Vec = response.job_ids().into_iter().map(|id| id.into_string()).collect(); + let job_set_id = response.first_job_set() + .map(|job_set| job_set.id.to_string()) + .filter(|_| !job_ids.is_empty()) + .ok_or_else(|| ArtcraftRouterError::ProviderResponseInvalid( + "Higgsfield accepted the request but returned no jobs".to_string(), + ))?; + + info!("Higgsfield enqueued job set {} with {} job(s)", job_set_id, job_ids.len()); + + Ok(GenerateImageResponse::Higgsfield(HiggsfieldImageResponsePayload { job_set_id, job_ids })) + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/seedream_4p5/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_4p5/build.rs new file mode 100644 index 00000000..3916627e --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_4p5/build.rs @@ -0,0 +1,74 @@ +//! Seedream 4.5 on Higgsfield: 8 aspect ratios (no Auto), a 2K / 4K menu, +//! 1–4 images. ArtCraft's baked-in `auto_2k` / `auto_4k` ratios become a +//! 16:9 request at that resolution. + +use higgsfield_client::endpoints::generate::image::seedream_4p5::{Seedream4p5Request, Seedream4p5Resolution}; +use higgsfield_client::types::seedream_aspect_ratio::SeedreamAspectRatio; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_seedream_aspect_ratio, require_prompt, + seedream_auto_resolution_hint, snap_resolution, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 6; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedream4p5Resolution)] = &[ + (RouterResolution::TwoK, Seedream4p5Resolution::TwoK), + (RouterResolution::FourK, Seedream4p5Resolution::FourK), +]; + +pub fn build_higgsfield_seedream_4p5(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + check_reference_limit(image_input_count(image_inputs.as_ref()), MAX_REFERENCE_IMAGES, "Seedream 4.5")?; + + let requested_aspect_ratio = builder.aspect_ratio.take(); + let aspect_ratio = plan_seedream_aspect_ratio(requested_aspect_ratio, SeedreamAspectRatio::Landscape16x9); + let requested_resolution = builder.resolution.take().or_else(|| seedream_auto_resolution_hint(requested_aspect_ratio)); + let resolution = snap_resolution(requested_resolution, RESOLUTION_TIERS, Seedream4p5Resolution::TwoK, strategy)?; + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = Seedream4p5Request::text_to_image(prompt, aspect_ratio, resolution); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::Seedream4p5(request), image_inputs)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + + fn built(builder: GenerateImageRequestBuilder) -> Seedream4p5Request { + match unwrap_request(build_higgsfield_seedream_4p5(builder).expect("build")) { + HiggsfieldImageRequest::Seedream4p5(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn three_k_sits_between_the_two_tiers() { + let mut b = base_builder(RouterImageModel::Seedream4p5); + b.resolution = Some(RouterResolution::ThreeK); + assert_eq!(built(b.clone()).resolution, Seedream4p5Resolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(built(b).resolution, Seedream4p5Resolution::TwoK); + } + + #[test] + fn auto_4k_becomes_16x9_at_4k() { + let mut b = base_builder(RouterImageModel::Seedream4p5); + b.aspect_ratio = Some(RouterAspectRatio::Auto4k); + let request = built(b); + assert_eq!(request.aspect_ratio, SeedreamAspectRatio::Landscape16x9); + assert_eq!(request.resolution, Seedream4p5Resolution::FourK); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/seedream_4p5/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_4p5/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_4p5/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_lite/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_lite/build.rs new file mode 100644 index 00000000..e8ff0d3a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_lite/build.rs @@ -0,0 +1,91 @@ +//! Seedream 5 Lite on Higgsfield: 8 aspect ratios (no Auto), a 2K / 3K / 4K +//! menu, 1–4 images. ArtCraft's baked-in `auto_2k` / `auto_3k` ratios become +//! a 16:9 request at that resolution. + +use higgsfield_client::endpoints::generate::image::seedream_5p0_lite::{Seedream5p0LiteRequest, Seedream5p0LiteResolution}; +use higgsfield_client::types::seedream_aspect_ratio::SeedreamAspectRatio; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_seedream_aspect_ratio, require_prompt, + seedream_auto_resolution_hint, snap_resolution, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 6; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedream5p0LiteResolution)] = &[ + (RouterResolution::TwoK, Seedream5p0LiteResolution::TwoK), + (RouterResolution::ThreeK, Seedream5p0LiteResolution::ThreeK), + (RouterResolution::FourK, Seedream5p0LiteResolution::FourK), +]; + +pub fn build_higgsfield_seedream_5p0_lite(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + check_reference_limit(image_input_count(image_inputs.as_ref()), MAX_REFERENCE_IMAGES, "Seedream 5 Lite")?; + + let requested_aspect_ratio = builder.aspect_ratio.take(); + let aspect_ratio = plan_seedream_aspect_ratio(requested_aspect_ratio, SeedreamAspectRatio::Landscape16x9); + let requested_resolution = builder.resolution.take().or_else(|| seedream_auto_resolution_hint(requested_aspect_ratio)); + let resolution = snap_resolution(requested_resolution, RESOLUTION_TIERS, Seedream5p0LiteResolution::TwoK, strategy)?; + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = Seedream5p0LiteRequest::text_to_image(prompt, aspect_ratio, resolution); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::Seedream5p0Lite(request), image_inputs)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + + fn built(builder: GenerateImageRequestBuilder) -> Seedream5p0LiteRequest { + match unwrap_request(build_higgsfield_seedream_5p0_lite(builder).expect("build")) { + HiggsfieldImageRequest::Seedream5p0Lite(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn auto_3k_becomes_16x9_at_3k() { + let mut b = base_builder(RouterImageModel::Seedream5Lite); + b.aspect_ratio = Some(RouterAspectRatio::Auto3k); + let request = built(b); + assert_eq!(request.aspect_ratio, SeedreamAspectRatio::Landscape16x9); + assert_eq!(request.resolution, Seedream5p0LiteResolution::ThreeK); + } + + #[test] + fn an_explicit_resolution_beats_the_auto_hint() { + let mut b = base_builder(RouterImageModel::Seedream5Lite); + b.aspect_ratio = Some(RouterAspectRatio::Auto2k); + b.resolution = Some(RouterResolution::FourK); + assert_eq!(built(b).resolution, Seedream5p0LiteResolution::FourK); + } + + #[test] + fn one_k_upgrades_to_two_k() { + let mut b = base_builder(RouterImageModel::Seedream5Lite); + b.resolution = Some(RouterResolution::OneK); + assert_eq!(built(b.clone()).resolution, Seedream5p0LiteResolution::TwoK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + // Nothing below 2K exists; the bottom tier is still 2K. + assert_eq!(built(b).resolution, Seedream5p0LiteResolution::TwoK); + } + + #[test] + fn square_hd_is_square() { + let mut b = base_builder(RouterImageModel::Seedream5Lite); + b.aspect_ratio = Some(RouterAspectRatio::SquareHd); + assert_eq!(built(b).aspect_ratio, SeedreamAspectRatio::Square1x1); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_lite/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_lite/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_lite/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_pro/build.rs b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_pro/build.rs new file mode 100644 index 00000000..5a8f0fe8 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_pro/build.rs @@ -0,0 +1,86 @@ +//! Seedream 5.0 Pro on Higgsfield: 8 aspect ratios (no Auto), 1K / 1.5K / +//! 2K, 1–4 images. The router has no 1.5K tier, so it offers 1K and 2K. + +use higgsfield_client::endpoints::generate::image::seedream_5p0_pro::{Seedream5p0ProRequest, Seedream5p0ProResolution}; +use higgsfield_client::types::seedream_aspect_ratio::SeedreamAspectRatio; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::providers::higgsfield::common::{ + check_reference_limit, finish, image_input_count, plan_batch_size, plan_seedream_aspect_ratio, require_prompt, + seedream_auto_resolution_hint, snap_resolution, +}; +use crate::generate::generate_image::providers::higgsfield::image_request::HiggsfieldImageRequest; + +pub const MAX_REFERENCE_IMAGES: usize = 14; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedream5p0ProResolution)] = &[ + (RouterResolution::OneK, Seedream5p0ProResolution::OneK), + (RouterResolution::TwoK, Seedream5p0ProResolution::TwoK), +]; + +pub fn build_higgsfield_seedream_5p0_pro(mut builder: GenerateImageRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + let image_inputs = builder.image_inputs.take(); + check_reference_limit(image_input_count(image_inputs.as_ref()), MAX_REFERENCE_IMAGES, "Seedream 5.0 Pro")?; + + let requested_aspect_ratio = builder.aspect_ratio.take(); + let aspect_ratio = plan_seedream_aspect_ratio(requested_aspect_ratio, SeedreamAspectRatio::Square1x1); + let requested_resolution = builder.resolution.take().or_else(|| seedream_auto_resolution_hint(requested_aspect_ratio)); + let resolution = snap_resolution(requested_resolution, RESOLUTION_TIERS, Seedream5p0ProResolution::OneK, strategy)?; + let batch_size = plan_batch_size(builder.image_batch_count.take(), strategy)?; + + let mut request = Seedream5p0ProRequest::text_to_image(prompt, aspect_ratio, resolution); + request.batch_size = batch_size; + Ok(finish(HiggsfieldImageRequest::Seedream5p0Pro(request), image_inputs)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + use higgsfield_client::types::image_batch_size::ImageBatchSize; + + fn built(builder: GenerateImageRequestBuilder) -> Seedream5p0ProRequest { + match unwrap_request(build_higgsfield_seedream_5p0_pro(builder).expect("build")) { + HiggsfieldImageRequest::Seedream5p0Pro(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn defaults_to_square_at_one_k() { + let request = built(base_builder(RouterImageModel::Seedream5p0Pro)); + assert_eq!(request.aspect_ratio, SeedreamAspectRatio::Square1x1); + assert_eq!(request.resolution, Seedream5p0ProResolution::OneK); + } + + #[test] + fn four_k_downgrades_to_two_k_even_when_upgrading() { + let mut b = base_builder(RouterImageModel::Seedream5p0Pro); + b.resolution = Some(RouterResolution::FourK); + assert_eq!(built(b.clone()).resolution, Seedream5p0ProResolution::TwoK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_seedream_5p0_pro(b).is_err()); + } + + #[test] + fn artcraft_batches_of_eight_clamp_to_four() { + let mut b = base_builder(RouterImageModel::Seedream5p0Pro); + b.image_batch_count = Some(8); + assert_eq!(built(b).batch_size, ImageBatchSize::Four); + } + + #[test] + fn auto_ratio_falls_back_to_square() { + let mut b = base_builder(RouterImageModel::Seedream5p0Pro); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + assert_eq!(built(b).aspect_ratio, SeedreamAspectRatio::Square1x1); + } +} diff --git a/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_pro/mod.rs b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_pro/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/higgsfield/seedream_5p0_pro/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/build.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/build.rs new file mode 100644 index 00000000..4cd1bdee --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/build.rs @@ -0,0 +1,470 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7::{ + GenerateMidjourneyV7AspectRatio, GenerateMidjourneyV7Quality, + GenerateMidjourneyV7Request, KinoviMidjourneyBatchCount, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::kinovi::midjourney_7::draft::{ + KinoviMidjourney7DraftState, KinoviMidjourney7RemainingItems, +}; +use crate::generate::generate_image::providers::kinovi::midjourney_7::request::KinoviMidjourney7RequestState; + +pub fn build_kinovi_midjourney_7( + mut builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let quality = plan_quality(builder.quality.take()); + let batch_count = plan_batch_count(builder.image_batch_count.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + let image_inputs = builder.image_inputs.take(); + + // No image inputs → we can build the final request immediately. No + // draft/upload phase needed. + if !has_image_inputs(image_inputs.as_ref()) { + let request = GenerateMidjourneyV7Request { + prompt, + aspect_ratio, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality, + raw_mode: false, + batch_count, + reference_image_urls: None, + }; + return Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::KinoviMidjourney7(KinoviMidjourney7RequestState { request }), + )); + } + + // Image inputs present → must go through the draft phase so we can + // upload each image to the Seedance2Pro CDN before sending. + let draft = KinoviMidjourney7DraftState { + prompt, + aspect_ratio, + quality, + batch_count, + unhandled_request_state: Some(KinoviMidjourney7RemainingItems { + reference_images: image_inputs, + }), + }; + Ok(ImageGenerationDraftOrRequest::Draft( + ImageGenerationDraftRequest::KinoviMidjourney7(draft), + )) +} + +fn has_image_inputs(image_inputs: Option<&ImageListRef>) -> bool { + image_inputs.is_some_and(|refs| !refs.is_empty()) +} + +// ── Plan helpers ── + +pub(crate) fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use GenerateMidjourneyV7AspectRatio as Ar; + match aspect_ratio { + // No preference or auto → square, matching Midjourney's own default for new + // jobs in their UI. + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::Square1x1), + + // Direct mappings — Midjourney supports every common ratio. + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square1x1), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::Landscape16x9), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Ar::UltraWide21x9), + Some(RouterAspectRatio::WideFourByThree) => Ok(Ar::Standard4x3), + Some(RouterAspectRatio::WideFiveByFour) => Ok(Ar::Wide5x4), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Ar::Wide3x2), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::Portrait9x16), + Some(RouterAspectRatio::TallNineByTwentyOne) => Ok(Ar::UltraTall9x21), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Ar::Portrait3x4), + Some(RouterAspectRatio::TallFourByFive) => Ok(Ar::Tall4x5), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Ar::Tall2x3), + + // Every aspect ratio listed in `RouterAspectRatio` has a direct mapping; + // the catch-all is reserved for future variants. + #[allow(unreachable_patterns)] + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Ar::Square1x1), + }, + } +} + +pub(crate) fn plan_quality(quality: Option) -> Option { + // Midjourney's quality knob is a compute-budget dial that doesn't change + // Kinovi pricing — pass through whatever the caller asked for, and let + // `None` ride Midjourney's server-side default. + match quality { + None => None, + Some(RouterQuality::Low) => Some(GenerateMidjourneyV7Quality::Quarter), + Some(RouterQuality::Medium) => Some(GenerateMidjourneyV7Quality::Half), + Some(RouterQuality::High) => Some(GenerateMidjourneyV7Quality::Full), + } +} + +pub(crate) fn plan_batch_count( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviMidjourneyBatchCount::One), + 2 => Ok(KinoviMidjourneyBatchCount::Two), + 3 => Ok(KinoviMidjourneyBatchCount::Three), + 4 => Ok(KinoviMidjourneyBatchCount::Four), + other => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", other), + })) + } + // Kinovi supports batches of 1–4; only counts of 5+ reach here, so both + // mitigation strategies clamp to the maximum supported batch. + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(KinoviMidjourneyBatchCount::Four) + } + }, + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::generate::image::generate_midjourney_v7::KinoviMidjourneyBatchCount; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::api::router_quality::RouterQuality; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + + use super::*; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a corgi astronaut".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + // ── Mode dispatch: no image inputs → Request; with → Draft ── + + mod mode_dispatch { + use super::*; + + #[test] + fn no_image_inputs_returns_request_directly() { + let result = build_kinovi_midjourney_7(base_builder()).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7(_)), + )); + } + + #[test] + fn empty_image_inputs_returns_request_directly() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![])), + ..base_builder() + }; + let result = build_kinovi_midjourney_7(builder).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7(_)), + )); + } + + #[test] + fn image_url_inputs_returns_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])), + ..base_builder() + }; + let result = build_kinovi_midjourney_7(builder).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7(_)), + )); + } + + #[test] + fn image_token_inputs_returns_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test".to_string()), + ])), + ..base_builder() + }; + let result = build_kinovi_midjourney_7(builder).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7(_)), + )); + } + + #[test] + fn draft_remembers_image_inputs() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + ])), + ..base_builder() + }; + let draft = unwrap_draft(build_kinovi_midjourney_7(builder)); + let remaining = draft.unhandled_request_state.as_ref().unwrap(); + let urls = match remaining.reference_images.as_ref().unwrap() { + ImageListRef::Urls(urls) => urls, + _ => panic!("expected Urls"), + }; + assert_eq!(urls.len(), 2); + } + } + + // ── Field passthrough ── + + mod field_passthrough { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let req = unwrap_direct_request(build_kinovi_midjourney_7(base_builder())); + assert_eq!(req.request.prompt, "a corgi astronaut"); + } + + #[test] + fn prompt_defaults_to_empty() { + let builder = GenerateImageRequestBuilder { prompt: None, ..base_builder() }; + let req = unwrap_direct_request(build_kinovi_midjourney_7(builder)); + assert_eq!(req.request.prompt, ""); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + use seedance2pro_client::generate::image::generate_midjourney_v7::GenerateMidjourneyV7AspectRatio as Ar; + + fn aspect_ratio_for(input: Option) -> Ar { + let builder = GenerateImageRequestBuilder { aspect_ratio: input, ..base_builder() }; + unwrap_direct_request(build_kinovi_midjourney_7(builder)).request.aspect_ratio + } + + #[test] + fn none_defaults_to_square() { + assert_eq!(aspect_ratio_for(None), Ar::Square1x1); + } + + #[test] + fn auto_defaults_to_square() { + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Auto)), Ar::Square1x1); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Auto2k)), Ar::Square1x1); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Auto3k)), Ar::Square1x1); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Auto4k)), Ar::Square1x1); + } + + #[test] + fn every_ratio_maps_directly() { + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Square)), Ar::Square1x1); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::SquareHd)), Ar::Square1x1); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::WideSixteenByNine)), Ar::Landscape16x9); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::WideTwentyOneByNine)), Ar::UltraWide21x9); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::WideFourByThree)), Ar::Standard4x3); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::WideFiveByFour)), Ar::Wide5x4); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::WideThreeByTwo)), Ar::Wide3x2); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Wide)), Ar::Landscape16x9); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::TallNineBySixteen)), Ar::Portrait9x16); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::TallNineByTwentyOne)), Ar::UltraTall9x21); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::TallThreeByFour)), Ar::Portrait3x4); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::TallFourByFive)), Ar::Tall4x5); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::TallTwoByThree)), Ar::Tall2x3); + assert_eq!(aspect_ratio_for(Some(RouterAspectRatio::Tall)), Ar::Portrait9x16); + } + } + + // ── Quality ── + + mod quality_tests { + use super::*; + use seedance2pro_client::generate::image::generate_midjourney_v7::GenerateMidjourneyV7Quality as Q; + + fn quality_for(input: Option) -> Option { + let builder = GenerateImageRequestBuilder { quality: input, ..base_builder() }; + unwrap_direct_request(build_kinovi_midjourney_7(builder)).request.quality + } + + #[test] + fn none_passes_through_as_none() { + assert_eq!(quality_for(None), None); + } + + #[test] + fn low_maps_to_quarter() { + assert_eq!(quality_for(Some(RouterQuality::Low)), Some(Q::Quarter)); + } + + #[test] + fn medium_maps_to_half() { + assert_eq!(quality_for(Some(RouterQuality::Medium)), Some(Q::Half)); + } + + #[test] + fn high_maps_to_full() { + assert_eq!(quality_for(Some(RouterQuality::High)), Some(Q::Full)); + } + } + + // ── Batch count ── + + mod batch_count_tests { + use super::*; + + fn batch_for(count: Option) -> KinoviMidjourneyBatchCount { + let builder = GenerateImageRequestBuilder { image_batch_count: count, ..base_builder() }; + unwrap_direct_request(build_kinovi_midjourney_7(builder)).request.batch_count + } + + #[test] + fn none_defaults_to_one() { + assert_eq!(batch_for(None), KinoviMidjourneyBatchCount::One); + } + + #[test] + fn one_two_three_four_map_directly() { + assert_eq!(batch_for(Some(1)), KinoviMidjourneyBatchCount::One); + assert_eq!(batch_for(Some(2)), KinoviMidjourneyBatchCount::Two); + assert_eq!(batch_for(Some(3)), KinoviMidjourneyBatchCount::Three); + assert_eq!(batch_for(Some(4)), KinoviMidjourneyBatchCount::Four); + } + + #[test] + fn zero_is_rejected() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(0), ..base_builder() }; + assert!(matches!( + build_kinovi_midjourney_7(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + )); + } + + /// Kinovi now supports batches of 3, so 3 is a first-class value and the + /// mitigation strategy no longer applies to it. + #[test] + fn three_maps_directly_regardless_of_strategy() { + for strategy in [ + RequestMismatchMitigationStrategy::ErrorOut, + RequestMismatchMitigationStrategy::PayMoreUpgrade, + RequestMismatchMitigationStrategy::PayLessDowngrade, + ] { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(3), + request_mismatch_mitigation_strategy: strategy, + ..base_builder() + }; + assert_eq!( + unwrap_direct_request(build_kinovi_midjourney_7(builder)).request.batch_count, + KinoviMidjourneyBatchCount::Three, + "strategy={:?}", strategy, + ); + } + } + + /// Counts above 4 are still unsupported: strict errors out, and both + /// pay-more/pay-less strategies clamp to the maximum supported batch (4). + #[test] + fn five_errors_under_strict_and_clamps_to_four_otherwise() { + let strict = GenerateImageRequestBuilder { + image_batch_count: Some(5), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(matches!( + build_kinovi_midjourney_7(strict), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })), + )); + + for strategy in [ + RequestMismatchMitigationStrategy::PayMoreUpgrade, + RequestMismatchMitigationStrategy::PayLessDowngrade, + ] { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(5), + request_mismatch_mitigation_strategy: strategy, + ..base_builder() + }; + assert_eq!( + unwrap_direct_request(build_kinovi_midjourney_7(builder)).request.batch_count, + KinoviMidjourneyBatchCount::Four, + "strategy={:?}", strategy, + ); + } + } + } + + // ── Helpers ── + + fn unwrap_direct_request( + result: Result, + ) -> KinoviMidjourney7RequestState { + match result.expect("build should succeed") { + ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::KinoviMidjourney7(req), + ) => req, + other => panic!("expected KinoviMidjourney7 Request, got {:?}", other), + } + } + + fn unwrap_draft( + result: Result, + ) -> KinoviMidjourney7DraftState { + match result.expect("build should succeed") { + ImageGenerationDraftOrRequest::Draft( + ImageGenerationDraftRequest::KinoviMidjourney7(draft), + ) => draft, + other => panic!("expected KinoviMidjourney7 Draft, got {:?}", other), + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/cost.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/cost.rs new file mode 100644 index 00000000..fbc84f7f --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/cost.rs @@ -0,0 +1,212 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7::{ + GenerateMidjourneyV7AspectRatio, GenerateMidjourneyV7Request, KinoviMidjourneyBatchCount, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::kinovi::midjourney_7::draft::KinoviMidjourney7DraftState; +use crate::generate::generate_image::providers::kinovi::midjourney_7::request::KinoviMidjourney7RequestState; + +/// Midjourney v7 (via Kinovi) cost state. Only `batch_count` matters for +/// pricing — Midjourney pricing is flat per task regardless of aspect +/// ratio, quality, or whether reference images were supplied. +pub struct KinoviMidjourney7CostState { + pub batch_count: KinoviMidjourneyBatchCount, +} + +impl KinoviMidjourney7CostState { + pub fn from_request(request: &KinoviMidjourney7RequestState) -> Self { + Self { batch_count: request.request.batch_count } + } + + pub fn from_draft(draft: &KinoviMidjourney7DraftState) -> Self { + Self { batch_count: draft.batch_count } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let pricing_request = GenerateMidjourneyV7Request { + batch_count: self.batch_count, + // Cost-irrelevant placeholders below — only `batch_count` matters. + prompt: String::new(), + aspect_ratio: GenerateMidjourneyV7AspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + reference_image_urls: None, + }; + + let costs = pricing_request.calculate_costs(); + let cost_in_credits = costs.kinovi_credits; + let cost_in_usd_cents = costs.usd_cents_rounded_up; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + + // ── Credit pricing (12 per task × batch) ── + + mod credits { + use super::*; + + #[test] + fn batch_one_is_twelve_credits() { + assert_eq!(credits_for(KinoviMidjourneyBatchCount::One), 12); + } + + #[test] + fn batch_two_is_twentyfour_credits() { + assert_eq!(credits_for(KinoviMidjourneyBatchCount::Two), 24); + } + + #[test] + fn batch_four_is_fortyeight_credits() { + assert_eq!(credits_for(KinoviMidjourneyBatchCount::Four), 48); + } + } + + // ── USD pricing (243 credits per dollar; rounded up) ── + + mod usd { + use super::*; + + #[test] + fn batch_one_is_five_cents() { + // 12/243 × 100 = 4.94 → 5¢ + assert_eq!(usd_cents_for(KinoviMidjourneyBatchCount::One), 5); // rounds UP + } + + #[test] + fn batch_two_is_ten_cents() { + // 24/243 × 100 = 9.88 → 10¢ + assert_eq!(usd_cents_for(KinoviMidjourneyBatchCount::Two), 10); // rounds UP + } + + #[test] + fn batch_four_is_twenty_cents() { + // 48/243 × 100 = 19.75 → 20¢ + assert_eq!(usd_cents_for(KinoviMidjourneyBatchCount::Four), 20); + } + } + + // ── Flags ── + + #[test] + fn flags_are_correct() { + let cost = KinoviMidjourney7CostState { batch_count: KinoviMidjourneyBatchCount::One } + .estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + assert_eq!(cost.failures_are_refunded, None); + } + + // ── from_request / from_draft ── + + mod source_state_round_trip { + use super::*; + + #[test] + fn from_request_picks_up_batch_count() { + let req = build_request_no_image_inputs(2); + let state = KinoviMidjourney7CostState::from_request(&req); + assert_eq!(state.batch_count, KinoviMidjourneyBatchCount::Two); + assert_eq!(state.estimate_cost().cost_in_credits, Some(24)); + } + + #[test] + fn from_draft_picks_up_batch_count() { + let draft = build_draft_with_image_inputs(4); + let state = KinoviMidjourney7CostState::from_draft(&draft); + assert_eq!(state.batch_count, KinoviMidjourneyBatchCount::Four); + assert_eq!(state.estimate_cost().cost_in_credits, Some(48)); + } + + #[test] + fn draft_and_request_produce_same_cost() { + // Same batch count → same cost, regardless of draft vs request path. + let req_cost = KinoviMidjourney7CostState::from_request(&build_request_no_image_inputs(2)) + .estimate_cost(); + let draft_cost = KinoviMidjourney7CostState::from_draft(&build_draft_with_image_inputs(2)) + .estimate_cost(); + assert_eq!(req_cost.cost_in_credits, draft_cost.cost_in_credits); + assert_eq!(req_cost.cost_in_usd_cents, draft_cost.cost_in_usd_cents); + } + } + + // ── Helpers ── + + fn credits_for(batch: KinoviMidjourneyBatchCount) -> u64 { + KinoviMidjourney7CostState { batch_count: batch } + .estimate_cost().cost_in_credits.unwrap() + } + + fn usd_cents_for(batch: KinoviMidjourneyBatchCount) -> u64 { + KinoviMidjourney7CostState { batch_count: batch } + .estimate_cost().cost_in_usd_cents.unwrap() + } + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7, + provider: RouterProvider::Seedance2Pro, + prompt: Some("test".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn build_request_no_image_inputs(batch_count: u16) -> KinoviMidjourney7RequestState { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(batch_count), + ..base_builder() + }; + match builder.build2().expect("build2") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7(r)) => r, + _ => panic!("expected Request"), + } + } + + fn build_draft_with_image_inputs(batch_count: u16) -> KinoviMidjourney7DraftState { + let builder = GenerateImageRequestBuilder { + image_batch_count: Some(batch_count), + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])), + ..base_builder() + }; + match builder.build2().expect("build2") { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7(d)) => d, + _ => panic!("expected Draft"), + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/draft.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/draft.rs new file mode 100644 index 00000000..68d7ec53 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/draft.rs @@ -0,0 +1,94 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7::{ + GenerateMidjourneyV7AspectRatio, GenerateMidjourneyV7Quality, + GenerateMidjourneyV7Request, KinoviMidjourneyBatchCount, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use crate::generate::generate_image::providers::kinovi::midjourney_7::request::KinoviMidjourney7RequestState; +use crate::generate::generate_image::providers::kinovi::resolve::resolve_and_upload_image_list; + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney7DraftState { + // Materialized fields — all enums already resolved. + pub prompt: String, + pub aspect_ratio: GenerateMidjourneyV7AspectRatio, + pub quality: Option, + pub batch_count: KinoviMidjourneyBatchCount, + + /// Image references that still need to be uploaded to Seedance2Pro CDN + /// before the request is sendable. `None` once `to_request()` has run. + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney7RemainingItems { + pub reference_images: Option, +} + +impl KinoviMidjourney7DraftState { + pub async fn to_request( + &mut self, + draft_context: &ImageGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut reference_image_urls = None; + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + reference_image_urls = resolve_and_upload_image_list( + session, remaining.reference_images, map, + ).await?; + } + + let request = GenerateMidjourneyV7Request { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: self.quality, + raw_mode: false, + batch_count: self.batch_count, + reference_image_urls, + }; + + Ok(KinoviMidjourney7RequestState { request }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use seedance2pro_client::generate::image::generate_midjourney_v7::GenerateMidjourneyV7AspectRatio; + + // Note: most behavioral tests live in `build.rs` and `cost.rs`. The + // `to_request()` method requires a live Seedance2Pro client to upload + // images, so its end-to-end behavior is exercised by the `request.rs` + // #[ignore]'d integration tests rather than unit-tested here. + + #[test] + fn draft_with_no_image_inputs_finalises_to_empty_reference_image_urls() { + // Even when the draft *has* an unhandled state, an empty `ImageListRef` + // shouldn't trigger an upload. This is technically not the path the + // builder takes (it short-circuits to Request), but we exercise it + // here for robustness. + let mut draft = KinoviMidjourney7DraftState { + prompt: "test".to_string(), + aspect_ratio: GenerateMidjourneyV7AspectRatio::Square1x1, + quality: None, + batch_count: KinoviMidjourneyBatchCount::One, + unhandled_request_state: Some(KinoviMidjourney7RemainingItems { + reference_images: Some(ImageListRef::Urls(vec![])), + }), + }; + // We can't actually call `to_request()` without a client, but the + // resolve path returns `None` for empty inputs. Smoke-test the resolve + // helper directly via the test_resolve helper. + let inputs = draft.unhandled_request_state.take().unwrap().reference_images; + assert!(matches!(inputs, Some(ImageListRef::Urls(ref v)) if v.is_empty())); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/mod.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/request.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/request.rs new file mode 100644 index 00000000..11ddfae1 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7/request.rs @@ -0,0 +1,144 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7::{ + generate_midjourney_v7, GenerateMidjourneyV7Args, GenerateMidjourneyV7Request, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + GenerateImageResponse, Seedance2proImageResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney7RequestState { + /// Final materialized request; ready to fire against Kinovi. + pub request: GenerateMidjourneyV7Request, +} + +impl KinoviMidjourney7RequestState { + pub async fn send( + &self, + client: &RouterSeedance2ProClient, + ) -> Result { + let args = GenerateMidjourneyV7Args { + session: &client.session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_midjourney_v7(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateImageResponse::Seedance2Pro(Seedance2proImageResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} + +#[cfg(test)] +mod tests { + use std::collections::HashMap; + + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::generate_image_response::GenerateImageResponse; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a serene mountain lake at sunrise, cinematic".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + quality: None, + image_batch_count: Some(1), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn get_kinovi_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn text_to_image_round_trip() { + let client = get_kinovi_client(); + let result = base_builder().build2().expect("build2"); + + let request = match result { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7(r)) => r, + _ => panic!("expected direct Request for text-to-image"), + }; + + let response = request.send(client.get_seedance2pro_client_ref().unwrap()) + .await.expect("send should succeed"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("v7 t2i — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn image_reference_round_trip_via_draft() { + let client = get_kinovi_client(); + let token = MediaFileToken::new("mf_test_juno".to_string()); + + let mut map = HashMap::new(); + map.insert(token.clone(), JUNO_AT_LAKE_IMAGE_URL.to_string()); + + let builder = GenerateImageRequestBuilder { + prompt: Some("a corgi in the style of @1".to_string()), + image_inputs: Some(ImageListRef::MediaFileTokens(vec![token])), + ..base_builder() + }; + + let draft_or_request = builder.build2().expect("build2"); + let draft = match draft_or_request { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7(d)) => d, + _ => panic!("expected Draft for image-input flow"), + }; + + let ctx = ImageGenerationDraftContext { + client: Some(&client), + media_file_to_artcraft_url_map: Some(&map), + asset_upload_cache: None, + asset_upload_observer: None, + }; + + let request = ImageGenerationDraftRequest::KinoviMidjourney7(draft) + .finalize(ctx).await.expect("finalize"); + + let response = request.send_request(&client).await.expect("send_request"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("v7 with ref — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/build.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/build.rs new file mode 100644 index 00000000..876e15d0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/build.rs @@ -0,0 +1,274 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7_niji::{ + GenerateMidjourneyV7NijiAspectRatio, GenerateMidjourneyV7NijiQuality, + GenerateMidjourneyV7NijiRequest, KinoviMidjourneyBatchCount, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::draft::{ + KinoviMidjourney7NijiDraftState, KinoviMidjourney7NijiRemainingItems, +}; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::request::KinoviMidjourney7NijiRequestState; + +pub fn build_kinovi_midjourney_7_niji( + mut builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let quality = plan_quality(builder.quality.take()); + let batch_count = plan_batch_count(builder.image_batch_count.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + let image_inputs = builder.image_inputs.take(); + + if !has_image_inputs(image_inputs.as_ref()) { + let request = GenerateMidjourneyV7NijiRequest { + prompt, + aspect_ratio, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality, + raw_mode: false, + batch_count, + reference_image_urls: None, + }; + return Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::KinoviMidjourney7Niji(KinoviMidjourney7NijiRequestState { request }), + )); + } + + let draft = KinoviMidjourney7NijiDraftState { + prompt, + aspect_ratio, + quality, + batch_count, + unhandled_request_state: Some(KinoviMidjourney7NijiRemainingItems { + reference_images: image_inputs, + }), + }; + Ok(ImageGenerationDraftOrRequest::Draft( + ImageGenerationDraftRequest::KinoviMidjourney7Niji(draft), + )) +} + +fn has_image_inputs(image_inputs: Option<&ImageListRef>) -> bool { + image_inputs.is_some_and(|refs| !refs.is_empty()) +} + +// ── Plan helpers ── + +pub(crate) fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use GenerateMidjourneyV7NijiAspectRatio as Ar; + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::Square1x1), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square1x1), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::Landscape16x9), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Ar::UltraWide21x9), + Some(RouterAspectRatio::WideFourByThree) => Ok(Ar::Standard4x3), + Some(RouterAspectRatio::WideFiveByFour) => Ok(Ar::Wide5x4), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Ar::Wide3x2), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::Portrait9x16), + Some(RouterAspectRatio::TallNineByTwentyOne) => Ok(Ar::UltraTall9x21), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Ar::Portrait3x4), + Some(RouterAspectRatio::TallFourByFive) => Ok(Ar::Tall4x5), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Ar::Tall2x3), + + #[allow(unreachable_patterns)] + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Ar::Square1x1), + }, + } +} + +pub(crate) fn plan_quality(quality: Option) -> Option { + match quality { + None => None, + Some(RouterQuality::Low) => Some(GenerateMidjourneyV7NijiQuality::Quarter), + Some(RouterQuality::Medium) => Some(GenerateMidjourneyV7NijiQuality::Half), + Some(RouterQuality::High) => Some(GenerateMidjourneyV7NijiQuality::Full), + } +} + +pub(crate) fn plan_batch_count( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviMidjourneyBatchCount::One), + 2 => Ok(KinoviMidjourneyBatchCount::Two), + 3 => Ok(KinoviMidjourneyBatchCount::Three), + 4 => Ok(KinoviMidjourneyBatchCount::Four), + other => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", other), + })) + } + // Kinovi supports batches of 1–4; only counts of 5+ reach here, so both + // mitigation strategies clamp to the maximum supported batch. + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(KinoviMidjourneyBatchCount::Four) + } + }, + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::generate::image::generate_midjourney_v7_niji::KinoviMidjourneyBatchCount; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::api::router_quality::RouterQuality; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + + use super::*; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7Niji, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a magical anime forest scene".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + #[test] + fn no_image_inputs_returns_request_directly() { + let result = build_kinovi_midjourney_7_niji(base_builder()).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7Niji(_)), + )); + } + + #[test] + fn image_inputs_returns_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])), + ..base_builder() + }; + let result = build_kinovi_midjourney_7_niji(builder).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7Niji(_)), + )); + } + + #[test] + fn batch_count_zero_errors() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(0), ..base_builder() }; + assert!(matches!( + build_kinovi_midjourney_7_niji(builder), + Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + )); + } + + #[test] + fn batch_count_three_is_accepted() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(3), ..base_builder() }; + let req = match build_kinovi_midjourney_7_niji(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7Niji(r)) => r, + _ => panic!("expected Request"), + }; + assert_eq!(req.request.batch_count, KinoviMidjourneyBatchCount::Three); + } + + #[test] + fn batch_count_four_is_accepted() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(4), ..base_builder() }; + let req = match build_kinovi_midjourney_7_niji(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7Niji(r)) => r, + _ => panic!("expected Request"), + }; + assert_eq!(req.request.batch_count, KinoviMidjourneyBatchCount::Four); + } + + #[test] + fn aspect_ratio_passes_through_to_niji_enum() { + use seedance2pro_client::generate::image::generate_midjourney_v7_niji::GenerateMidjourneyV7NijiAspectRatio as Ar; + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), + ..base_builder() + }; + let req = match build_kinovi_midjourney_7_niji(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7Niji(r)) => r, + _ => panic!("expected Request"), + }; + assert_eq!(req.request.aspect_ratio, Ar::UltraWide21x9); + } + + #[test] + fn quality_high_maps_to_full() { + use seedance2pro_client::generate::image::generate_midjourney_v7_niji::GenerateMidjourneyV7NijiQuality as Q; + let builder = GenerateImageRequestBuilder { + quality: Some(RouterQuality::High), + ..base_builder() + }; + let req = match build_kinovi_midjourney_7_niji(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7Niji(r)) => r, + _ => panic!("expected Request"), + }; + assert_eq!(req.request.quality, Some(Q::Full)); + } + + #[test] + fn media_file_tokens_route_through_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_x".to_string()), + ])), + ..base_builder() + }; + let draft = match build_kinovi_midjourney_7_niji(builder).expect("build") { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7Niji(d)) => d, + _ => panic!("expected Draft"), + }; + assert!(draft.unhandled_request_state.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/cost.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/cost.rs new file mode 100644 index 00000000..4aff6fe9 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/cost.rs @@ -0,0 +1,91 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7_niji::{ + GenerateMidjourneyV7NijiAspectRatio, GenerateMidjourneyV7NijiRequest, KinoviMidjourneyBatchCount, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::draft::KinoviMidjourney7NijiDraftState; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::request::KinoviMidjourney7NijiRequestState; + +/// Midjourney v7 Niji (via Kinovi) cost state. Pricing is flat per task +/// regardless of aspect ratio or quality, identical to v7 / v8. +pub struct KinoviMidjourney7NijiCostState { + pub batch_count: KinoviMidjourneyBatchCount, +} + +impl KinoviMidjourney7NijiCostState { + pub fn from_request(request: &KinoviMidjourney7NijiRequestState) -> Self { + Self { batch_count: request.request.batch_count } + } + + pub fn from_draft(draft: &KinoviMidjourney7NijiDraftState) -> Self { + Self { batch_count: draft.batch_count } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let pricing_request = GenerateMidjourneyV7NijiRequest { + batch_count: self.batch_count, + prompt: String::new(), + aspect_ratio: GenerateMidjourneyV7NijiAspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + reference_image_urls: None, + }; + + let costs = pricing_request.calculate_costs(); + let cost_in_credits = costs.kinovi_credits; + let cost_in_usd_cents = costs.usd_cents_rounded_up; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn batch_one_is_twelve_credits_and_five_cents() { + let cost = KinoviMidjourney7NijiCostState { batch_count: KinoviMidjourneyBatchCount::One } + .estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(12)); + assert_eq!(cost.cost_in_usd_cents, Some(5)); // 1200/243 = 4.94 -> rounds UP + } + + #[test] + fn batch_two_doubles() { + let cost = KinoviMidjourney7NijiCostState { batch_count: KinoviMidjourneyBatchCount::Two } + .estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(24)); + assert_eq!(cost.cost_in_usd_cents, Some(10)); // 2400/243 = 9.88 -> rounds UP + } + + #[test] + fn batch_four_quadruples() { + let cost = KinoviMidjourney7NijiCostState { batch_count: KinoviMidjourneyBatchCount::Four } + .estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(48)); + assert_eq!(cost.cost_in_usd_cents, Some(20)); + } + + #[test] + fn flags_are_correct() { + let cost = KinoviMidjourney7NijiCostState { batch_count: KinoviMidjourneyBatchCount::One } + .estimate_cost(); + assert!(!cost.is_free); + assert!(!cost.is_unlimited); + assert!(!cost.is_rate_limited); + assert!(!cost.has_watermark); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/draft.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/draft.rs new file mode 100644 index 00000000..d2cda52f --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/draft.rs @@ -0,0 +1,58 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7_niji::{ + GenerateMidjourneyV7NijiAspectRatio, GenerateMidjourneyV7NijiQuality, + GenerateMidjourneyV7NijiRequest, KinoviMidjourneyBatchCount, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use crate::generate::generate_image::providers::kinovi::midjourney_7_niji::request::KinoviMidjourney7NijiRequestState; +use crate::generate::generate_image::providers::kinovi::resolve::resolve_and_upload_image_list; + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney7NijiDraftState { + pub prompt: String, + pub aspect_ratio: GenerateMidjourneyV7NijiAspectRatio, + pub quality: Option, + pub batch_count: KinoviMidjourneyBatchCount, + + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney7NijiRemainingItems { + pub reference_images: Option, +} + +impl KinoviMidjourney7NijiDraftState { + pub async fn to_request( + &mut self, + draft_context: &ImageGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut reference_image_urls = None; + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + reference_image_urls = resolve_and_upload_image_list( + session, remaining.reference_images, map, + ).await?; + } + + let request = GenerateMidjourneyV7NijiRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: self.quality, + raw_mode: false, + batch_count: self.batch_count, + reference_image_urls, + }; + + Ok(KinoviMidjourney7NijiRequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/mod.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/request.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/request.rs new file mode 100644 index 00000000..cbbbcb42 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_7_niji/request.rs @@ -0,0 +1,142 @@ +use seedance2pro_client::generate::image::generate_midjourney_v7_niji::{ + generate_midjourney_v7_niji, GenerateMidjourneyV7NijiArgs, GenerateMidjourneyV7NijiRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + GenerateImageResponse, Seedance2proImageResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney7NijiRequestState { + pub request: GenerateMidjourneyV7NijiRequest, +} + +impl KinoviMidjourney7NijiRequestState { + pub async fn send( + &self, + client: &RouterSeedance2ProClient, + ) -> Result { + let args = GenerateMidjourneyV7NijiArgs { + session: &client.session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_midjourney_v7_niji(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateImageResponse::Seedance2Pro(Seedance2proImageResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} + +#[cfg(test)] +mod tests { + use std::collections::HashMap; + + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney7Niji, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a magical anime fox spirit in a moonlit bamboo forest".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + quality: None, + image_batch_count: Some(1), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn get_kinovi_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn text_to_image_round_trip() { + let client = get_kinovi_client(); + let result = base_builder().build2().expect("build2"); + + let request = match result { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney7Niji(r)) => r, + _ => panic!("expected direct Request for text-to-image"), + }; + + let response = request.send(client.get_seedance2pro_client_ref().unwrap()) + .await.expect("send should succeed"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("v7-niji t2i — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn image_reference_round_trip_via_draft() { + let client = get_kinovi_client(); + let token = MediaFileToken::new("mf_test_juno_niji".to_string()); + + let mut map = HashMap::new(); + map.insert(token.clone(), JUNO_AT_LAKE_IMAGE_URL.to_string()); + + let builder = GenerateImageRequestBuilder { + prompt: Some("an anime corgi sorcerer inspired by @1".to_string()), + image_inputs: Some(ImageListRef::MediaFileTokens(vec![token])), + ..base_builder() + }; + + let draft_or_request = builder.build2().expect("build2"); + let draft = match draft_or_request { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney7Niji(d)) => d, + _ => panic!("expected Draft for image-input flow"), + }; + + let ctx = ImageGenerationDraftContext { + client: Some(&client), + media_file_to_artcraft_url_map: Some(&map), + asset_upload_cache: None, + asset_upload_observer: None, + }; + + let request = ImageGenerationDraftRequest::KinoviMidjourney7Niji(draft) + .finalize(ctx).await.expect("finalize"); + + let response = request.send_request(&client).await.expect("send_request"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("v7-niji with ref — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/build.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/build.rs new file mode 100644 index 00000000..528993d1 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/build.rs @@ -0,0 +1,235 @@ +use seedance2pro_client::generate::image::generate_midjourney_v8::{ + GenerateMidjourneyV8AspectRatio, GenerateMidjourneyV8Quality, + GenerateMidjourneyV8Request, KinoviMidjourneyBatchCount, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_quality::RouterQuality; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::kinovi::midjourney_8::draft::{ + KinoviMidjourney8DraftState, KinoviMidjourney8RemainingItems, +}; +use crate::generate::generate_image::providers::kinovi::midjourney_8::request::KinoviMidjourney8RequestState; + +pub fn build_kinovi_midjourney_8( + mut builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let quality = plan_quality(builder.quality.take()); + let batch_count = plan_batch_count(builder.image_batch_count.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + let image_inputs = builder.image_inputs.take(); + + if !has_image_inputs(image_inputs.as_ref()) { + let request = GenerateMidjourneyV8Request { + prompt, + aspect_ratio, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality, + raw_mode: false, + batch_count, + reference_image_urls: None, + }; + return Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::KinoviMidjourney8(KinoviMidjourney8RequestState { request }), + )); + } + + let draft = KinoviMidjourney8DraftState { + prompt, + aspect_ratio, + quality, + batch_count, + unhandled_request_state: Some(KinoviMidjourney8RemainingItems { + reference_images: image_inputs, + }), + }; + Ok(ImageGenerationDraftOrRequest::Draft( + ImageGenerationDraftRequest::KinoviMidjourney8(draft), + )) +} + +fn has_image_inputs(image_inputs: Option<&ImageListRef>) -> bool { + image_inputs.is_some_and(|refs| !refs.is_empty()) +} + +// ── Plan helpers ── + +pub(crate) fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use GenerateMidjourneyV8AspectRatio as Ar; + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::Square1x1), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square1x1), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::Landscape16x9), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Ar::UltraWide21x9), + Some(RouterAspectRatio::WideFourByThree) => Ok(Ar::Standard4x3), + Some(RouterAspectRatio::WideFiveByFour) => Ok(Ar::Wide5x4), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Ar::Wide3x2), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::Portrait9x16), + Some(RouterAspectRatio::TallNineByTwentyOne) => Ok(Ar::UltraTall9x21), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Ar::Portrait3x4), + Some(RouterAspectRatio::TallFourByFive) => Ok(Ar::Tall4x5), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Ar::Tall2x3), + + #[allow(unreachable_patterns)] + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Ar::Square1x1), + }, + } +} + +pub(crate) fn plan_quality(quality: Option) -> Option { + match quality { + None => None, + Some(RouterQuality::Low) => Some(GenerateMidjourneyV8Quality::Quarter), + Some(RouterQuality::Medium) => Some(GenerateMidjourneyV8Quality::Half), + Some(RouterQuality::High) => Some(GenerateMidjourneyV8Quality::Full), + } +} + +pub(crate) fn plan_batch_count( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviMidjourneyBatchCount::One), + 2 => Ok(KinoviMidjourneyBatchCount::Two), + 3 => Ok(KinoviMidjourneyBatchCount::Three), + 4 => Ok(KinoviMidjourneyBatchCount::Four), + other => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", other), + })) + } + // Kinovi supports batches of 1–4; only counts of 5+ reach here, so both + // mitigation strategies clamp to the maximum supported batch. + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(KinoviMidjourneyBatchCount::Four) + } + }, + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::generate::image::generate_midjourney_v8::KinoviMidjourneyBatchCount; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + + use super::*; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney8, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a spooky horror scene".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + #[test] + fn no_image_inputs_returns_request_directly() { + let result = build_kinovi_midjourney_8(base_builder()).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney8(_)), + )); + } + + #[test] + fn image_inputs_returns_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])), + ..base_builder() + }; + let result = build_kinovi_midjourney_8(builder).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney8(_)), + )); + } + + #[test] + fn batch_count_three_is_accepted() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(3), ..base_builder() }; + let req = match build_kinovi_midjourney_8(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney8(r)) => r, + _ => panic!("expected Request"), + }; + assert_eq!(req.request.batch_count, KinoviMidjourneyBatchCount::Three); + } + + #[test] + fn batch_count_four_is_accepted() { + let builder = GenerateImageRequestBuilder { image_batch_count: Some(4), ..base_builder() }; + let req = match build_kinovi_midjourney_8(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney8(r)) => r, + _ => panic!("expected Request"), + }; + assert_eq!(req.request.batch_count, KinoviMidjourneyBatchCount::Four); + } + + #[test] + fn media_file_token_route_through_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_x".to_string()), + ])), + ..base_builder() + }; + let draft = match build_kinovi_midjourney_8(builder).expect("build") { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney8(d)) => d, + _ => panic!("expected Draft"), + }; + assert!(draft.unhandled_request_state.is_some()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/cost.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/cost.rs new file mode 100644 index 00000000..58dae7eb --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/cost.rs @@ -0,0 +1,81 @@ +use seedance2pro_client::generate::image::generate_midjourney_v8::{ + GenerateMidjourneyV8AspectRatio, GenerateMidjourneyV8Request, KinoviMidjourneyBatchCount, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::kinovi::midjourney_8::draft::KinoviMidjourney8DraftState; +use crate::generate::generate_image::providers::kinovi::midjourney_8::request::KinoviMidjourney8RequestState; + +/// Midjourney v8 (via Kinovi) cost state. Pricing is flat per task, +/// identical to v7 / v7 niji. +pub struct KinoviMidjourney8CostState { + pub batch_count: KinoviMidjourneyBatchCount, +} + +impl KinoviMidjourney8CostState { + pub fn from_request(request: &KinoviMidjourney8RequestState) -> Self { + Self { batch_count: request.request.batch_count } + } + + pub fn from_draft(draft: &KinoviMidjourney8DraftState) -> Self { + Self { batch_count: draft.batch_count } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let pricing_request = GenerateMidjourneyV8Request { + batch_count: self.batch_count, + prompt: String::new(), + aspect_ratio: GenerateMidjourneyV8AspectRatio::Square1x1, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: None, + raw_mode: false, + reference_image_urls: None, + }; + + let costs = pricing_request.calculate_costs(); + let cost_in_credits = costs.kinovi_credits; + let cost_in_usd_cents = costs.usd_cents_rounded_up; + + ImageGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn batch_one_is_twelve_credits_and_five_cents() { + let cost = KinoviMidjourney8CostState { batch_count: KinoviMidjourneyBatchCount::One } + .estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(12)); + assert_eq!(cost.cost_in_usd_cents, Some(5)); // 1200/243 = 4.94 -> rounds UP + } + + #[test] + fn batch_two_doubles() { + let cost = KinoviMidjourney8CostState { batch_count: KinoviMidjourneyBatchCount::Two } + .estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(24)); + assert_eq!(cost.cost_in_usd_cents, Some(10)); // 2400/243 = 9.88 -> rounds UP + } + + #[test] + fn batch_four_quadruples() { + let cost = KinoviMidjourney8CostState { batch_count: KinoviMidjourneyBatchCount::Four } + .estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(48)); + assert_eq!(cost.cost_in_usd_cents, Some(20)); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/draft.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/draft.rs new file mode 100644 index 00000000..4fa628ed --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/draft.rs @@ -0,0 +1,58 @@ +use seedance2pro_client::generate::image::generate_midjourney_v8::{ + GenerateMidjourneyV8AspectRatio, GenerateMidjourneyV8Quality, + GenerateMidjourneyV8Request, KinoviMidjourneyBatchCount, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use crate::generate::generate_image::providers::kinovi::midjourney_8::request::KinoviMidjourney8RequestState; +use crate::generate::generate_image::providers::kinovi::resolve::resolve_and_upload_image_list; + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney8DraftState { + pub prompt: String, + pub aspect_ratio: GenerateMidjourneyV8AspectRatio, + pub quality: Option, + pub batch_count: KinoviMidjourneyBatchCount, + + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney8RemainingItems { + pub reference_images: Option, +} + +impl KinoviMidjourney8DraftState { + pub async fn to_request( + &mut self, + draft_context: &ImageGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut reference_image_urls = None; + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + reference_image_urls = resolve_and_upload_image_list( + session, remaining.reference_images, map, + ).await?; + } + + let request = GenerateMidjourneyV8Request { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + negative_prompt: None, + stylize: None, + weird: None, + chaos: None, + quality: self.quality, + raw_mode: false, + batch_count: self.batch_count, + reference_image_urls, + }; + + Ok(KinoviMidjourney8RequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/mod.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/request.rs b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/request.rs new file mode 100644 index 00000000..e5ae9eaf --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/midjourney_8/request.rs @@ -0,0 +1,142 @@ +use seedance2pro_client::generate::image::generate_midjourney_v8::{ + generate_midjourney_v8, GenerateMidjourneyV8Args, GenerateMidjourneyV8Request, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + GenerateImageResponse, Seedance2proImageResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviMidjourney8RequestState { + pub request: GenerateMidjourneyV8Request, +} + +impl KinoviMidjourney8RequestState { + pub async fn send( + &self, + client: &RouterSeedance2ProClient, + ) -> Result { + let args = GenerateMidjourneyV8Args { + session: &client.session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_midjourney_v8(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateImageResponse::Seedance2Pro(Seedance2proImageResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} + +#[cfg(test)] +mod tests { + use std::collections::HashMap; + + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney8, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a spooky horror scene with ghosts in an abandoned mansion".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + quality: None, + image_batch_count: Some(1), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn get_kinovi_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn text_to_image_round_trip() { + let client = get_kinovi_client(); + let result = base_builder().build2().expect("build2"); + + let request = match result { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviMidjourney8(r)) => r, + _ => panic!("expected direct Request for text-to-image"), + }; + + let response = request.send(client.get_seedance2pro_client_ref().unwrap()) + .await.expect("send should succeed"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("v8 t2i — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn image_reference_round_trip_via_draft() { + let client = get_kinovi_client(); + let token = MediaFileToken::new("mf_test_juno_v8".to_string()); + + let mut map = HashMap::new(); + map.insert(token.clone(), JUNO_AT_LAKE_IMAGE_URL.to_string()); + + let builder = GenerateImageRequestBuilder { + prompt: Some("a dramatic painterly portrait inspired by @1".to_string()), + image_inputs: Some(ImageListRef::MediaFileTokens(vec![token])), + ..base_builder() + }; + + let draft_or_request = builder.build2().expect("build2"); + let draft = match draft_or_request { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviMidjourney8(d)) => d, + _ => panic!("expected Draft for image-input flow"), + }; + + let ctx = ImageGenerationDraftContext { + client: Some(&client), + media_file_to_artcraft_url_map: Some(&map), + asset_upload_cache: None, + asset_upload_observer: None, + }; + + let request = ImageGenerationDraftRequest::KinoviMidjourney8(draft) + .finalize(ctx).await.expect("finalize"); + + let response = request.send_request(&client).await.expect("send_request"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("v8 with ref — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/mod.rs b/crates/router/src/generate/generate_image/providers/kinovi/mod.rs new file mode 100644 index 00000000..47387c76 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/mod.rs @@ -0,0 +1,7 @@ +pub mod midjourney_7; +pub mod midjourney_7_niji; +pub mod midjourney_8; +pub mod seedream_5p0_pro; + +pub(crate) mod resolve; +pub(crate) mod upload; diff --git a/crates/router/src/generate/generate_image/providers/kinovi/resolve.rs b/crates/router/src/generate/generate_image/providers/kinovi/resolve.rs new file mode 100644 index 00000000..a52dfb61 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/resolve.rs @@ -0,0 +1,33 @@ +use std::collections::HashMap; + +use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::image_list_ref::ImageListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::providers::kinovi::upload::upload_source_to_seedance2pro; +use crate::utils::media_source_ref::MediaSourceRef; + +/// Resolve an [`ImageListRef`] to a list of public Seedance2Pro CDN URLs, +/// uploading each image one at a time. Preserves order. +/// +/// Returns `Ok(None)` when the input is `None` or an empty list — the +/// caller can then omit the field from the wire request entirely. (The +/// downstream Midjourney API rejects empty arrays.) +pub(crate) async fn resolve_and_upload_image_list( + session: &Seedance2ProSession, + list: Option, + maybe_map: Option<&HashMap>, +) -> Result>, ArtcraftRouterError> { + let sources = match list { + None => return Ok(None), + Some(list) if list.is_empty() => return Ok(None), + Some(list) => MediaSourceRef::list_from_images(list), + }; + + let mut uploaded = Vec::with_capacity(sources.len()); + for source in sources { + uploaded.push(upload_source_to_seedance2pro(session, source, maybe_map).await?); + } + Ok(Some(uploaded)) +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/build.rs b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/build.rs new file mode 100644 index 00000000..a23a0762 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/build.rs @@ -0,0 +1,400 @@ +use seedance2pro_client::generate::image::generate_seedream_5p0_pro::{ + GenerateSeedream5p0ProRequest, KinoviSeedream5p0ProAspectRatio, KinoviSeedream5p0ProBatchCount, + KinoviSeedream5p0ProResolution, MAX_REFERENCE_IMAGES, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::draft::{ + KinoviSeedream5p0ProDraftState, KinoviSeedream5p0ProRemainingItems, +}; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::request::KinoviSeedream5p0ProRequestState; + +pub fn build_kinovi_seedream_5p0_pro( + mut builder: GenerateImageRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_resolution(builder.resolution.take(), strategy)?; + let batch_count = plan_batch_count(builder.image_batch_count.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + let image_inputs = builder.image_inputs.take(); + + validate_reference_image_count(image_inputs.as_ref())?; + + if !has_image_inputs(image_inputs.as_ref()) { + let request = GenerateSeedream5p0ProRequest { + prompt, + aspect_ratio, + resolution, + batch_count, + reference_image_urls: None, + }; + return Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::KinoviSeedream5p0Pro(KinoviSeedream5p0ProRequestState { request }), + )); + } + + let draft = KinoviSeedream5p0ProDraftState { + prompt, + aspect_ratio, + resolution, + batch_count, + unhandled_request_state: Some(KinoviSeedream5p0ProRemainingItems { + reference_images: image_inputs, + }), + }; + Ok(ImageGenerationDraftOrRequest::Draft( + ImageGenerationDraftRequest::KinoviSeedream5p0Pro(draft), + )) +} + +fn has_image_inputs(image_inputs: Option<&ImageListRef>) -> bool { + image_inputs.is_some_and(|refs| !refs.is_empty()) +} + +/// Reject over-limit reference lists before any uploads happen — the +/// Seedance2Pro client would reject them anyway, but only after the draft +/// stage has already uploaded every image to the Kinovi CDN. +fn validate_reference_image_count( + image_inputs: Option<&ImageListRef>, +) -> Result<(), ArtcraftRouterError> { + let count = image_inputs.map_or(0, ImageListRef::len); + if count > MAX_REFERENCE_IMAGES { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: format!("{} reference images (max {})", count, MAX_REFERENCE_IMAGES), + })); + } + Ok(()) +} + +// ── Plan helpers ── + +pub(crate) fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use KinoviSeedream5p0ProAspectRatio as Ar; + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::Auto), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square1x1), + Some(RouterAspectRatio::WideFourByThree) => Ok(Ar::Standard4x3), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Ar::Portrait3x4), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::Landscape16x9), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::Portrait9x16), + Some(RouterAspectRatio::WideThreeByTwo) => Ok(Ar::Wide3x2), + Some(RouterAspectRatio::TallTwoByThree) => Ok(Ar::Tall2x3), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Ar::UltraWide21x9), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Ar::Auto), + }, + } +} + +pub(crate) fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use KinoviSeedream5p0ProResolution as Res; + match resolution { + None | Some(RouterResolution::OneK) => Ok(Res::OneK), + Some(RouterResolution::TwoK) => Ok(Res::TwoK), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", unsupported), + })) + } + // Snap to the nearest supported tier: sub-1k inputs (0.5K, legacy + // video resolutions) land on 1k; 3K/4K land on 2k. + _ => match unsupported { + RouterResolution::ThreeK | RouterResolution::FourK => Ok(Res::TwoK), + _ => Ok(Res::OneK), + }, + }, + } +} + +pub(crate) fn plan_batch_count( + image_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = image_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviSeedream5p0ProBatchCount::One), + 2 => Ok(KinoviSeedream5p0ProBatchCount::Two), + 3 => Ok(KinoviSeedream5p0ProBatchCount::Three), + 4 => Ok(KinoviSeedream5p0ProBatchCount::Four), + 5 => Ok(KinoviSeedream5p0ProBatchCount::Five), + 6 => Ok(KinoviSeedream5p0ProBatchCount::Six), + 7 => Ok(KinoviSeedream5p0ProBatchCount::Seven), + 8 => Ok(KinoviSeedream5p0ProBatchCount::Eight), + other => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_batch_count", + value: format!("{}", other), + })) + } + // Kinovi supports batches of 1–8; only counts of 9+ reach here, so both + // mitigation strategies clamp to the maximum supported batch. + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(KinoviSeedream5p0ProBatchCount::Eight) + } + }, + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5p0Pro, + provider: RouterProvider::Seedance2Pro, + prompt: Some("an anime girl riding a dinosaur".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn build_request(builder: GenerateImageRequestBuilder) -> KinoviSeedream5p0ProRequestState { + match build_kinovi_seedream_5p0_pro(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviSeedream5p0Pro(r)) => r, + _ => panic!("expected Request"), + } + } + + mod routing_tests { + use super::*; + + #[test] + fn no_image_inputs_returns_request_directly() { + let result = build_kinovi_seedream_5p0_pro(base_builder()).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviSeedream5p0Pro(_)), + )); + } + + #[test] + fn image_inputs_returns_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])), + ..base_builder() + }; + let result = build_kinovi_seedream_5p0_pro(builder).expect("build"); + assert!(matches!( + result, + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviSeedream5p0Pro(_)), + )); + } + + #[test] + fn media_file_tokens_route_through_draft() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_x".to_string()), + ])), + ..base_builder() + }; + let draft = match build_kinovi_seedream_5p0_pro(builder).expect("build") { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviSeedream5p0Pro(d)) => d, + _ => panic!("expected Draft"), + }; + assert!(draft.unhandled_request_state.is_some()); + } + + #[test] + fn fourteen_reference_images_is_accepted() { + let urls: Vec = (0..MAX_REFERENCE_IMAGES) + .map(|i| format!("https://example.com/ref{i}.png")) + .collect(); + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(urls)), + ..base_builder() + }; + assert!(build_kinovi_seedream_5p0_pro(builder).is_ok()); + } + + #[test] + fn fifteen_reference_images_is_rejected() { + let urls: Vec = (0..MAX_REFERENCE_IMAGES + 1) + .map(|i| format!("https://example.com/ref{i}.png")) + .collect(); + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(urls)), + ..base_builder() + }; + assert!(build_kinovi_seedream_5p0_pro(builder).is_err()); + } + } + + mod plan_tests { + use super::*; + + #[test] + fn default_aspect_ratio_is_auto() { + let req = build_request(base_builder()); + assert_eq!(req.request.aspect_ratio, KinoviSeedream5p0ProAspectRatio::Auto); + } + + #[test] + fn every_supported_aspect_ratio_maps() { + let cases = [ + (RouterAspectRatio::Auto, KinoviSeedream5p0ProAspectRatio::Auto), + (RouterAspectRatio::Square, KinoviSeedream5p0ProAspectRatio::Square1x1), + (RouterAspectRatio::WideFourByThree, KinoviSeedream5p0ProAspectRatio::Standard4x3), + (RouterAspectRatio::TallThreeByFour, KinoviSeedream5p0ProAspectRatio::Portrait3x4), + (RouterAspectRatio::WideSixteenByNine, KinoviSeedream5p0ProAspectRatio::Landscape16x9), + (RouterAspectRatio::TallNineBySixteen, KinoviSeedream5p0ProAspectRatio::Portrait9x16), + (RouterAspectRatio::WideThreeByTwo, KinoviSeedream5p0ProAspectRatio::Wide3x2), + (RouterAspectRatio::TallTwoByThree, KinoviSeedream5p0ProAspectRatio::Tall2x3), + (RouterAspectRatio::WideTwentyOneByNine, KinoviSeedream5p0ProAspectRatio::UltraWide21x9), + ]; + for (input, expected) in cases { + let planned = plan_aspect_ratio(Some(input), RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert_eq!(planned, expected, "input={:?}", input); + } + } + + #[test] + fn unsupported_aspect_ratio_errors_out() { + let result = plan_aspect_ratio( + Some(RouterAspectRatio::TallNineByTwentyOne), + RequestMismatchMitigationStrategy::ErrorOut, + ); + assert!(result.is_err()); + } + + #[test] + fn unsupported_aspect_ratio_falls_back_to_auto() { + let planned = plan_aspect_ratio( + Some(RouterAspectRatio::TallNineByTwentyOne), + RequestMismatchMitigationStrategy::PayLessDowngrade, + ).expect("plan"); + assert_eq!(planned, KinoviSeedream5p0ProAspectRatio::Auto); + } + + #[test] + fn default_resolution_is_1k() { + let req = build_request(base_builder()); + assert_eq!(req.request.resolution, KinoviSeedream5p0ProResolution::OneK); + } + + #[test] + fn two_k_resolution_maps() { + let builder = GenerateImageRequestBuilder { + resolution: Some(RouterResolution::TwoK), + ..base_builder() + }; + let req = build_request(builder); + assert_eq!(req.request.resolution, KinoviSeedream5p0ProResolution::TwoK); + } + + #[test] + fn four_k_resolution_errors_out() { + let result = plan_resolution( + Some(RouterResolution::FourK), + RequestMismatchMitigationStrategy::ErrorOut, + ); + assert!(result.is_err()); + } + + #[test] + fn four_k_resolution_downgrades_to_2k() { + let planned = plan_resolution( + Some(RouterResolution::FourK), + RequestMismatchMitigationStrategy::PayLessDowngrade, + ).expect("plan"); + assert_eq!(planned, KinoviSeedream5p0ProResolution::TwoK); + } + + #[test] + fn half_k_resolution_snaps_to_1k() { + let planned = plan_resolution( + Some(RouterResolution::HalfK), + RequestMismatchMitigationStrategy::PayMoreUpgrade, + ).expect("plan"); + assert_eq!(planned, KinoviSeedream5p0ProResolution::OneK); + } + + #[test] + fn batch_counts_one_through_eight_are_accepted() { + let cases = [ + (1, KinoviSeedream5p0ProBatchCount::One), + (2, KinoviSeedream5p0ProBatchCount::Two), + (3, KinoviSeedream5p0ProBatchCount::Three), + (4, KinoviSeedream5p0ProBatchCount::Four), + (5, KinoviSeedream5p0ProBatchCount::Five), + (6, KinoviSeedream5p0ProBatchCount::Six), + (7, KinoviSeedream5p0ProBatchCount::Seven), + (8, KinoviSeedream5p0ProBatchCount::Eight), + ]; + for (input, expected) in cases { + let planned = plan_batch_count(Some(input), RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert_eq!(planned, expected, "input={}", input); + } + } + + #[test] + fn batch_count_zero_is_rejected() { + assert!(plan_batch_count(Some(0), RequestMismatchMitigationStrategy::ErrorOut).is_err()); + } + + #[test] + fn batch_count_nine_errors_out() { + assert!(plan_batch_count(Some(9), RequestMismatchMitigationStrategy::ErrorOut).is_err()); + } + + #[test] + fn batch_count_nine_clamps_to_eight() { + let planned = plan_batch_count(Some(9), RequestMismatchMitigationStrategy::PayLessDowngrade) + .expect("plan"); + assert_eq!(planned, KinoviSeedream5p0ProBatchCount::Eight); + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/cost.rs b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/cost.rs new file mode 100644 index 00000000..9f281531 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/cost.rs @@ -0,0 +1,100 @@ +use seedance2pro_client::generate::image::generate_seedream_5p0_pro::{ + GenerateSeedream5p0ProRequest, KinoviSeedream5p0ProAspectRatio, KinoviSeedream5p0ProBatchCount, + KinoviSeedream5p0ProResolution, +}; + +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::draft::KinoviSeedream5p0ProDraftState; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::request::KinoviSeedream5p0ProRequestState; + +/// Seedream 5.0 Pro (via Kinovi) cost state. Pricing is per image and +/// resolution-dependent (1k vs 2k); batch count multiplies. +pub struct KinoviSeedream5p0ProCostState { + pub resolution: KinoviSeedream5p0ProResolution, + pub batch_count: KinoviSeedream5p0ProBatchCount, +} + +impl KinoviSeedream5p0ProCostState { + pub fn from_request(request: &KinoviSeedream5p0ProRequestState) -> Self { + Self { + resolution: request.request.resolution, + batch_count: request.request.batch_count, + } + } + + pub fn from_draft(draft: &KinoviSeedream5p0ProDraftState) -> Self { + Self { + resolution: draft.resolution, + batch_count: draft.batch_count, + } + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + let pricing_request = GenerateSeedream5p0ProRequest { + prompt: String::new(), + aspect_ratio: KinoviSeedream5p0ProAspectRatio::Auto, + resolution: self.resolution, + batch_count: self.batch_count, + reference_image_urls: None, + }; + + let costs = pricing_request.calculate_costs(); + + ImageGenerationCostEstimate { + cost_in_credits: Some(costs.kinovi_credits), + cost_in_usd_cents: Some(costs.usd_cents_rounded_up), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn one_1k_image_is_fourteen_credits_and_six_cents() { + let cost = KinoviSeedream5p0ProCostState { + resolution: KinoviSeedream5p0ProResolution::OneK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + }.estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(14)); + assert_eq!(cost.cost_in_usd_cents, Some(6)); // 1400/243 = 5.76 -> rounds UP + } + + #[test] + fn one_2k_image_is_twentyfour_credits_and_ten_cents() { + let cost = KinoviSeedream5p0ProCostState { + resolution: KinoviSeedream5p0ProResolution::TwoK, + batch_count: KinoviSeedream5p0ProBatchCount::One, + }.estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(24)); + assert_eq!(cost.cost_in_usd_cents, Some(10)); // 2400/243 = 9.88 -> rounds UP + } + + /// Mirrors capture 4_seedream_5_misc.txt: 2k, batch of 4 → 96 credits. + #[test] + fn four_2k_images_is_ninetysix_credits() { + let cost = KinoviSeedream5p0ProCostState { + resolution: KinoviSeedream5p0ProResolution::TwoK, + batch_count: KinoviSeedream5p0ProBatchCount::Four, + }.estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(96)); + assert_eq!(cost.cost_in_usd_cents, Some(40)); // 9600/243 = 39.51 -> rounds UP + } + + /// Mirrors capture 5_seedream_5_misc2.txt: 1k, batch of 8 → 112 credits. + #[test] + fn eight_1k_images_is_one_hundred_twelve_credits() { + let cost = KinoviSeedream5p0ProCostState { + resolution: KinoviSeedream5p0ProResolution::OneK, + batch_count: KinoviSeedream5p0ProBatchCount::Eight, + }.estimate_cost(); + assert_eq!(cost.cost_in_credits, Some(112)); + assert_eq!(cost.cost_in_usd_cents, Some(47)); // 11200/243 = 46.09 -> rounds UP + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/draft.rs b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/draft.rs new file mode 100644 index 00000000..33524204 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/draft.rs @@ -0,0 +1,53 @@ +use seedance2pro_client::generate::image::generate_seedream_5p0_pro::{ + GenerateSeedream5p0ProRequest, KinoviSeedream5p0ProAspectRatio, KinoviSeedream5p0ProBatchCount, + KinoviSeedream5p0ProResolution, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; +use crate::generate::generate_image::providers::kinovi::resolve::resolve_and_upload_image_list; +use crate::generate::generate_image::providers::kinovi::seedream_5p0_pro::request::KinoviSeedream5p0ProRequestState; + +#[derive(Debug, Clone)] +pub struct KinoviSeedream5p0ProDraftState { + pub prompt: String, + pub aspect_ratio: KinoviSeedream5p0ProAspectRatio, + pub resolution: KinoviSeedream5p0ProResolution, + pub batch_count: KinoviSeedream5p0ProBatchCount, + + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviSeedream5p0ProRemainingItems { + pub reference_images: Option, +} + +impl KinoviSeedream5p0ProDraftState { + pub async fn to_request( + &mut self, + draft_context: &ImageGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut reference_image_urls = None; + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + reference_image_urls = resolve_and_upload_image_list( + session, remaining.reference_images, map, + ).await?; + } + + let request = GenerateSeedream5p0ProRequest { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + resolution: self.resolution, + batch_count: self.batch_count, + reference_image_urls, + }; + + Ok(KinoviSeedream5p0ProRequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/mod.rs b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/request.rs b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/request.rs new file mode 100644 index 00000000..95b1d2d1 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/seedream_5p0_pro/request.rs @@ -0,0 +1,143 @@ +use seedance2pro_client::generate::image::generate_seedream_5p0_pro::{ + generate_seedream_5p0_pro, GenerateSeedream5p0ProArgs, GenerateSeedream5p0ProRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + GenerateImageResponse, Seedance2proImageResponsePayload, +}; + +#[derive(Debug, Clone)] +pub struct KinoviSeedream5p0ProRequestState { + pub request: GenerateSeedream5p0ProRequest, +} + +impl KinoviSeedream5p0ProRequestState { + pub async fn send( + &self, + client: &RouterSeedance2ProClient, + ) -> Result { + let args = GenerateSeedream5p0ProArgs { + session: &client.session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_seedream_5p0_pro(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateImageResponse::Seedance2Pro(Seedance2proImageResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} + +#[cfg(test)] +mod tests { + use std::collections::HashMap; + + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; + use crate::generate::generate_image::image_generation_draft::ImageGenerationDraftRequest; + use crate::generate::generate_image::image_generation_draft_context::ImageGenerationDraftContext; + use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; + use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5p0Pro, + provider: RouterProvider::Seedance2Pro, + prompt: Some("an anime girl riding a dinosaur through a neon city".to_string()), + image_inputs: None, + resolution: Some(RouterResolution::OneK), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + quality: None, + image_batch_count: Some(1), + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + } + } + + fn get_kinovi_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn text_to_image_round_trip() { + let client = get_kinovi_client(); + let result = base_builder().build2().expect("build2"); + + let request = match result { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::KinoviSeedream5p0Pro(r)) => r, + _ => panic!("expected direct Request for text-to-image"), + }; + + let response = request.send(client.get_seedance2pro_client_ref().unwrap()) + .await.expect("send should succeed"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("seedream 5.0 pro t2i — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } + + #[tokio::test] + #[ignore] // manually test — requires real cookies; costs credits + async fn image_reference_round_trip_via_draft() { + let client = get_kinovi_client(); + let token = MediaFileToken::new("mf_test_juno_seedream5".to_string()); + + let mut map = HashMap::new(); + map.insert(token.clone(), JUNO_AT_LAKE_IMAGE_URL.to_string()); + + let builder = GenerateImageRequestBuilder { + prompt: Some("The dog in @Image1 wearing a tiny crown in a royal palace".to_string()), + image_inputs: Some(ImageListRef::MediaFileTokens(vec![token])), + ..base_builder() + }; + + let draft_or_request = builder.build2().expect("build2"); + let draft = match draft_or_request { + ImageGenerationDraftOrRequest::Draft(ImageGenerationDraftRequest::KinoviSeedream5p0Pro(d)) => d, + _ => panic!("expected Draft for image-input flow"), + }; + + let ctx = ImageGenerationDraftContext { + client: Some(&client), + media_file_to_artcraft_url_map: Some(&map), + asset_upload_cache: None, + asset_upload_observer: None, + }; + + let request = ImageGenerationDraftRequest::KinoviSeedream5p0Pro(draft) + .finalize(ctx).await.expect("finalize"); + + let response = request.send_request(&client).await.expect("send_request"); + let payload = response.get_seedance2pro_payload().expect("expected seedance2pro payload"); + println!("seedream 5.0 pro with ref — task_id={}, order_id={}", payload.task_id, payload.order_id); + assert!(!payload.task_id.is_empty()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/kinovi/upload.rs b/crates/router/src/generate/generate_image/providers/kinovi/upload.rs new file mode 100644 index 00000000..cde45cf4 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/kinovi/upload.rs @@ -0,0 +1,54 @@ +use std::collections::HashMap; + +use log::info; +use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; +use seedance2pro_client::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; +use seedance2pro_client::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::utils::media_source_ref::{ + extension_from_name_hint, resolve_media_source_bytes, MediaSourceRef, ResolvedMediaBytes, +}; + +/// Resolves one image source to bytes (token → CDN download, URL → download, +/// local path → disk read, bytes → as-is) and re-uploads it to the +/// Seedance2Pro/Kinovi CDN. Returns the public URL. +/// +/// This is the image-side twin of `generate_video::providers::kinovi::upload`. +/// The actual upload path doesn't care whether the file is a video or an +/// image, but keeping the two helpers separate lets each side evolve +/// independently and makes intent clear at call sites. +pub(crate) async fn upload_source_to_seedance2pro( + session: &Seedance2ProSession, + source: MediaSourceRef, + maybe_map: Option<&HashMap>, +) -> Result { + let ResolvedMediaBytes { bytes, maybe_name_hint, description, .. } = + resolve_media_source_bytes(source, maybe_map).await?; + + let extension = maybe_name_hint.as_deref() + .and_then(extension_from_name_hint) + .unwrap_or_else(|| "jpg".to_string()); + + info!("Uploading image reference to Seedance2Pro from {} ({} bytes, .{})", description, bytes.len(), extension); + + let prepare_response = prepare_file_upload(PrepareFileUploadArgs { + session, + extension, + host_override: None, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + let upload_response = upload_file(UploadFileArgs { + upload_url: prepare_response.upload_url, + file_bytes: bytes, + host_override: None, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(upload_response.public_url) +} diff --git a/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/build.rs b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/build.rs new file mode 100644 index 00000000..b905cf8c --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/build.rs @@ -0,0 +1,130 @@ +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_image::image_generation_draft_or_request::ImageGenerationDraftOrRequest; +use crate::generate::generate_image::image_generation_request::ImageGenerationRequest; +use crate::generate::generate_image::providers::midjourney::midjourney_8::request::MidjourneyMidjourney8RequestState; + +/// The Midjourney model version flag appended to every prompt. +const MIDJOURNEY_VERSION_FLAG: &str = "--v 8.2"; + +pub fn build_midjourney_midjourney_8( + builder: GenerateImageRequestBuilder, +) -> Result { + // Image references are not yet supported on the first-party cookie path. + if has_image_inputs(builder.image_inputs.as_ref()) { + return Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + "First-party Midjourney does not yet support image references".to_string(), + )); + } + + let base_prompt = builder.prompt.unwrap_or_default(); + let prompt = compose_prompt(&base_prompt, builder.aspect_ratio); + + Ok(ImageGenerationDraftOrRequest::Request( + ImageGenerationRequest::MidjourneyMidjourney8(MidjourneyMidjourney8RequestState { prompt }), + )) +} + +/// Compose the final Midjourney prompt string, appending the aspect-ratio flag +/// (when the ratio maps to one Midjourney supports) and the version flag. +fn compose_prompt(base_prompt: &str, aspect_ratio: Option) -> String { + let mut prompt = base_prompt.trim().to_string(); + + if let Some(ratio) = aspect_ratio_flag(aspect_ratio) { + prompt.push_str(" --ar "); + prompt.push_str(ratio); + } + + prompt.push(' '); + prompt.push_str(MIDJOURNEY_VERSION_FLAG); + prompt +} + +/// Maps a router aspect ratio to Midjourney's `--ar W:H` value. Returns `None` +/// for `Auto`/unset (Midjourney defaults to 1:1). +fn aspect_ratio_flag(aspect_ratio: Option) -> Option<&'static str> { + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => None, + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Some("1:1"), + Some(RouterAspectRatio::WideThreeByTwo) => Some("3:2"), + Some(RouterAspectRatio::WideFourByThree) => Some("4:3"), + Some(RouterAspectRatio::WideFiveByFour) => Some("5:4"), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Some("16:9"), + Some(RouterAspectRatio::WideTwentyOneByNine) => Some("21:9"), + Some(RouterAspectRatio::TallTwoByThree) => Some("2:3"), + Some(RouterAspectRatio::TallThreeByFour) => Some("3:4"), + Some(RouterAspectRatio::TallFourByFive) => Some("4:5"), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Some("9:16"), + Some(RouterAspectRatio::TallNineByTwentyOne) => Some("9:21"), + } +} + +fn has_image_inputs(image_inputs: Option<&ImageListRef>) -> bool { + image_inputs.is_some_and(|refs| !refs.is_empty()) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_image_model::RouterImageModel; + use crate::api::router_provider::RouterProvider; + use crate::client::generation_mode_mismatch_strategy::GenerationModeMismatchStrategy; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + fn base_builder() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Midjourney8, + provider: RouterProvider::Midjourney, + prompt: Some("pirate ship in the city".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + generation_mode_mismatch_strategy: Some(GenerationModeMismatchStrategy::GenerateAnyway), + idempotency_token: None, + } + } + + fn built_prompt(builder: GenerateImageRequestBuilder) -> String { + match build_midjourney_midjourney_8(builder).expect("build") { + ImageGenerationDraftOrRequest::Request(ImageGenerationRequest::MidjourneyMidjourney8(r)) => r.prompt, + _ => panic!("expected a direct Midjourney request"), + } + } + + #[test] + fn appends_version_flag_and_no_ar_by_default() { + let prompt = built_prompt(base_builder()); + assert_eq!(prompt, "pirate ship in the city --v 8.2"); + } + + #[test] + fn appends_aspect_ratio_flag() { + let builder = GenerateImageRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..base_builder() + }; + assert_eq!(built_prompt(builder), "pirate ship in the city --ar 16:9 --v 8.2"); + } + + #[test] + fn image_inputs_are_rejected_for_now() { + let builder = GenerateImageRequestBuilder { + image_inputs: Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])), + ..base_builder() + }; + assert!(build_midjourney_midjourney_8(builder).is_err()); + } +} diff --git a/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/cost.rs b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/cost.rs new file mode 100644 index 00000000..96f8d5bf --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/cost.rs @@ -0,0 +1,30 @@ +use crate::generate::generate_image::image_generation_cost_estimate::ImageGenerationCostEstimate; +use crate::generate::generate_image::providers::midjourney::midjourney_8::request::MidjourneyMidjourney8RequestState; + +/// Cost state for first-party (cookie-session) Midjourney v8. +/// +/// TODO(pricing): first-party Midjourney runs on the USER'S OWN Midjourney +/// subscription, so it does not consume Artcraft credits. This is a placeholder +/// that reports the generation as free/unlimited. The real product/pricing +/// decision (charge an Artcraft markup? keep it free? rate-limit?) is still open +/// — revisit before shipping. Any supplier-cost/margin figures belong in the +/// external margins repo, not here. +pub struct MidjourneyMidjourney8CostState; + +impl MidjourneyMidjourney8CostState { + pub fn from_request(_request: &MidjourneyMidjourney8RequestState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> ImageGenerationCostEstimate { + ImageGenerationCostEstimate { + cost_in_credits: Some(0), + cost_in_usd_cents: None, + is_free: true, + is_unlimited: true, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} diff --git a/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/mod.rs b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/request.rs b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/request.rs new file mode 100644 index 00000000..6105908a --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/midjourney/midjourney_8/request.rs @@ -0,0 +1,67 @@ +use midjourney_client::recipes::channel_id::ChannelId; +use midjourney_client::recipes::text_to_image::{ + text_to_image, TextToImageArgs, TextToImageRequest, TextToImageResponse, +}; + +use crate::client::router_midjourney_client::RouterMidjourneyClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_image::generate_image_response::{ + GenerateImageResponse, MidjourneyImageResponsePayload, +}; + +/// A ready-to-send first-party Midjourney v8 request. The `prompt` is already +/// fully composed, including trailing `--` parameters (aspect ratio, `--v 8.2`). +#[derive(Debug, Clone)] +pub struct MidjourneyMidjourney8RequestState { + pub prompt: String, +} + +impl MidjourneyMidjourney8RequestState { + pub async fn send( + &self, + client: &RouterMidjourneyClient, + ) -> Result { + let channel_id = ChannelId::UserId(client.user_id.clone()); + + let response = text_to_image(TextToImageArgs { + request: TextToImageRequest { + prompt: &self.prompt, + channel_id: &channel_id, + }, + cookie_header: &client.cookie_header, + hostname: None, + browser: Some(client.browser.clone()), + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Midjourney(err)))?; + + if let Some(job_id) = response.maybe_job_id.clone() { + return Ok(GenerateImageResponse::Midjourney(MidjourneyImageResponsePayload { job_id })); + } + + // No job id — classify the rejection. Surface Midjourney's own + // human-readable message(s), not a debug dump. + let detail = midjourney_error_detail(&response); + if response.is_subscription_required() { + return Err(ArtcraftRouterError::Provider(ProviderError::MidjourneySubscriptionRequired(detail))); + } + Err(ArtcraftRouterError::Provider(ProviderError::MidjourneySubmitRejected(detail))) + } +} + +/// Join Midjourney's failure messages into a single human-readable string. +fn midjourney_error_detail(response: &TextToImageResponse) -> String { + let detail = response + .errors() + .iter() + .filter_map(|error| error.message.clone()) + .collect::>() + .join("; "); + + if detail.is_empty() { + "Midjourney rejected the request with no detail".to_string() + } else { + detail + } +} diff --git a/crates/router/src/generate/generate_image/providers/midjourney/mod.rs b/crates/router/src/generate/generate_image/providers/midjourney/mod.rs new file mode 100644 index 00000000..6b8922b0 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/midjourney/mod.rs @@ -0,0 +1,11 @@ +//! First-party (cookie-session) Midjourney image generation. +//! +//! This provider drives the user's own midjourney.com session via captured +//! cookies (see `RouterMidjourneyClient`). It is distinct from: +//! - `providers/kinovi/midjourney_*` — backend-billed via Kinovi/Seedance2Pro +//! - `providers/artcraft/midjourney_*` — routed through the Artcraft backend +//! +//! Submission is text-to-image only for now; image references are not yet +//! supported on this path. + +pub mod midjourney_8; diff --git a/crates/router/src/generate/generate_image/providers/mod.rs b/crates/router/src/generate/generate_image/providers/mod.rs new file mode 100644 index 00000000..83e66902 --- /dev/null +++ b/crates/router/src/generate/generate_image/providers/mod.rs @@ -0,0 +1,6 @@ +pub mod artcraft; +pub mod fal; +pub mod grok; +pub mod higgsfield; +pub mod kinovi; +pub mod midjourney; diff --git a/crates/router/src/generate/generate_mesh/generate_mesh_request_builder.rs b/crates/router/src/generate/generate_mesh/generate_mesh_request_builder.rs new file mode 100644 index 00000000..045a9752 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/generate_mesh_request_builder.rs @@ -0,0 +1,312 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::mesh_ref::MeshRef; +use crate::api::router_mesh_model::RouterMeshModel; +use crate::api::router_provider::RouterProvider; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3::build::build_artcraft_hunyuan3d_3; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3_sketch::build::build_artcraft_hunyuan3d_3_sketch; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p0::build::build_artcraft_hunyuan_3d_2p0; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p1::build::build_artcraft_hunyuan_3d_2p1; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_part::build::build_artcraft_hunyuan_3d_3p1_part; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_pro::build::build_artcraft_hunyuan_3d_3p1_pro; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_rapid::build::build_artcraft_hunyuan_3d_3p1_rapid; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_smart_topology::build::build_artcraft_hunyuan_3d_3p1_smart_topology; +use crate::generate::generate_mesh::providers::artcraft::meshy_v6::build::build_artcraft_meshy_v6; +use crate::generate::generate_mesh::providers::artcraft::rodin_2p5_fast::build::build_artcraft_rodin_2p5_fast; +use crate::generate::generate_mesh::providers::artcraft::tripo3d_h3p1::build::build_artcraft_tripo3d_h3p1; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::build::build_fal_hunyuan3d_3; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3_sketch::build::build_fal_hunyuan3d_3_sketch; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p0::build::build_fal_hunyuan_3d_2p0; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p1::build::build_fal_hunyuan_3d_2p1; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_part::build::build_fal_hunyuan_3d_3p1_part; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_pro::build::build_fal_hunyuan_3d_3p1_pro; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_rapid::build::build_fal_hunyuan_3d_3p1_rapid; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_smart_topology::build::build_fal_hunyuan_3d_3p1_smart_topology; +use crate::generate::generate_mesh::providers::fal::meshy_v6::build::build_fal_meshy_v6; +use crate::generate::generate_mesh::providers::fal::rodin_2p5_fast::build::build_fal_rodin_2p5_fast; +use crate::generate::generate_mesh::providers::fal::tripo3d_h3p1::build::build_fal_tripo3d_h3p1; + +/// RouterProvider-agnostic mesh (3D object) generation request. Distilled by +/// `build2()` into a `MeshGenerationDraftOrRequest` for the selected +/// (provider, model) pair. +#[derive(Clone, Debug)] +pub struct GenerateMeshRequestBuilder { + /// Which model to use. + pub model: RouterMeshModel, + + /// Which provider to use. + pub provider: RouterProvider, + + /// The text prompt (text-to-3D, or the sketch description for sketch-to-3D). + pub prompt: Option, + + /// Reference images (optional). + /// The primary/front input image, or the sketch image for sketch-to-3D. + pub reference_images: Option, + + /// Front view image (optional; multi-view input). + /// Can be used instead of `reference_images[0]` when the other side views + /// are supplied. + pub front_image: Option, + + /// Back view image (optional; multi-view input). + pub back_image: Option, + + /// Left view image (optional; multi-view input). + pub left_image: Option, + + /// Right view image (optional; multi-view input). + pub right_image: Option, + + /// Input mesh file for mesh-to-mesh models (part splitting, retopology). + pub input_mesh: Option, + + /// The mesh output type to generate (normal, low-poly, or geometry-only). + pub mesh_output_type: Option, + + /// The polygon type to use for the generated mesh (triangle or quad). + pub polygon_type: Option, + + /// Target face count for the generated mesh. + pub face_count: Option, + + /// Whether to generate PBR (physically based rendering) materials. + pub enable_pbr: Option, + + /// Whether to generate textures. Some models (Tripo3D) can skip texturing + /// for a cheaper, faster generation. + pub enable_texture: Option, + + /// Texture quality. `Detailed` may cost extra (e.g. Tripo3D's HD tier). + pub texture_quality: Option, + + /// Geometry quality. `Detailed` may cost extra (e.g. Tripo3D). + pub geometry_quality: Option, + + /// If the request is a mismatch with the (model/provider), how to mitigate it. + pub request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy, + + /// Some providers support idempotency. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, +} + +impl Default for GenerateMeshRequestBuilder { + fn default() -> Self { + Self { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Artcraft, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + prompt: None, + reference_images: None, + front_image: None, + back_image: None, + left_image: None, + right_image: None, + input_mesh: None, + mesh_output_type: None, + polygon_type: None, + face_count: None, + enable_pbr: None, + enable_texture: None, + texture_quality: None, + geometry_quality: None, + idempotency_token: None, + } + } +} + +impl GenerateMeshRequestBuilder { + + pub fn build2(self) -> Result { + match (self.provider, self.model) { + // Artcraft + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d2p0) => build_artcraft_hunyuan_3d_2p0(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d2p1) => build_artcraft_hunyuan_3d_2p1(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d3) => build_artcraft_hunyuan3d_3(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d3Sketch) => build_artcraft_hunyuan3d_3_sketch(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d3p1Pro) => build_artcraft_hunyuan_3d_3p1_pro(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d3p1Rapid) => build_artcraft_hunyuan_3d_3p1_rapid(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d3p1Part) => build_artcraft_hunyuan_3d_3p1_part(self), + (RouterProvider::Artcraft, RouterMeshModel::Hunyuan3d3p1SmartTopology) => build_artcraft_hunyuan_3d_3p1_smart_topology(self), + (RouterProvider::Artcraft, RouterMeshModel::Tripo3dH3p1) => build_artcraft_tripo3d_h3p1(self), + (RouterProvider::Artcraft, RouterMeshModel::MeshyV6) => build_artcraft_meshy_v6(self), + (RouterProvider::Artcraft, RouterMeshModel::Rodin2p5Fast) => build_artcraft_rodin_2p5_fast(self), + // Fal + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d2p0) => build_fal_hunyuan_3d_2p0(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d2p1) => build_fal_hunyuan_3d_2p1(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d3) => build_fal_hunyuan3d_3(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d3Sketch) => build_fal_hunyuan3d_3_sketch(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d3p1Pro) => build_fal_hunyuan_3d_3p1_pro(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d3p1Rapid) => build_fal_hunyuan_3d_3p1_rapid(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d3p1Part) => build_fal_hunyuan_3d_3p1_part(self), + (RouterProvider::Fal, RouterMeshModel::Hunyuan3d3p1SmartTopology) => build_fal_hunyuan_3d_3p1_smart_topology(self), + (RouterProvider::Fal, RouterMeshModel::Tripo3dH3p1) => build_fal_tripo3d_h3p1(self), + (RouterProvider::Fal, RouterMeshModel::MeshyV6) => build_fal_meshy_v6(self), + (RouterProvider::Fal, RouterMeshModel::Rodin2p5Fast) => build_fal_rodin_2p5_fast(self), + _ => self.unsupported_provider_and_model(), + } + } + + pub fn get_or_generate_idempotency_token(&self) -> String { + self.idempotency_token.clone() + .unwrap_or_else(|| uuid::Uuid::new_v4().to_string()) + } + + fn unsupported_provider_and_model(&self) -> Result { + Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + format!("Mesh generation for model `{:?}` is not supported for provider {:?}", self.model, self.provider) + )) + } +} + +#[cfg(test)] +mod tests { + use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; + + use super::*; + + const IMAGE_URL: &str = "https://example.com/front.png"; + + mod dispatch_tests { + use super::*; + + #[test] + fn artcraft_models_dispatch() { + let cases = [ + RouterMeshModel::Hunyuan3d2p0, + RouterMeshModel::Hunyuan3d2p1, + RouterMeshModel::Hunyuan3d3, + RouterMeshModel::Hunyuan3d3Sketch, + ]; + for model in cases { + let result = builder_with_token_image(RouterProvider::Artcraft, model).build2() + .unwrap_or_else(|e| panic!("build should succeed for {model:?}: {e}")); + let request = expect_request(result); + let matches = matches!( + (model, &request), + (RouterMeshModel::Hunyuan3d2p0, MeshGenerationRequest::ArtcraftHunyuan3d2p0(_)) + | (RouterMeshModel::Hunyuan3d2p1, MeshGenerationRequest::ArtcraftHunyuan3d2p1(_)) + | (RouterMeshModel::Hunyuan3d3, MeshGenerationRequest::ArtcraftHunyuan3d3(_)) + | (RouterMeshModel::Hunyuan3d3Sketch, MeshGenerationRequest::ArtcraftHunyuan3d3Sketch(_)) + ); + assert!(matches, "unexpected dispatch for {model:?}: {request:?}"); + } + } + + #[test] + fn fal_hunyuan3d_3_with_image_dispatches_to_image_endpoint() { + let result = builder_with_url_image(RouterProvider::Fal, RouterMeshModel::Hunyuan3d3) + .build2().expect("build"); + assert!(matches!( + expect_request(result), + MeshGenerationRequest::FalHunyuan3d3Image(_) + )); + } + + #[test] + fn fal_hunyuan3d_3_with_prompt_only_dispatches_to_text_endpoint() { + let builder = GenerateMeshRequestBuilder { + provider: RouterProvider::Fal, + model: RouterMeshModel::Hunyuan3d3, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + }; + let result = builder.build2().expect("build"); + assert!(matches!( + expect_request(result), + MeshGenerationRequest::FalHunyuan3d3Text(_) + )); + } + + #[test] + fn fal_hunyuan3d_3_sketch_dispatches() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..builder_with_url_image(RouterProvider::Fal, RouterMeshModel::Hunyuan3d3Sketch) + }; + let result = builder.build2().expect("build"); + assert!(matches!( + expect_request(result), + MeshGenerationRequest::FalHunyuan3d3Sketch(_) + )); + } + + #[test] + fn fal_hunyuan_3d_2p0_dispatches() { + let result = builder_with_url_image(RouterProvider::Fal, RouterMeshModel::Hunyuan3d2p0) + .build2().expect("build"); + assert!(matches!( + expect_request(result), + MeshGenerationRequest::FalHunyuan3d2p0(_) + )); + } + + #[test] + fn fal_hunyuan_3d_2p1_dispatches() { + let result = builder_with_url_image(RouterProvider::Fal, RouterMeshModel::Hunyuan3d2p1) + .build2().expect("build"); + assert!(matches!( + expect_request(result), + MeshGenerationRequest::FalHunyuan3d2p1(_) + )); + } + } + + mod unsupported_combo_tests { + use super::*; + + #[test] + fn non_mesh_providers_are_unsupported() { + for provider in [ + RouterProvider::GmiCloud, + RouterProvider::GrokApi, + RouterProvider::Seedance2Pro, + ] { + let result = builder_with_url_image(provider, RouterMeshModel::Hunyuan3d3).build2(); + assert!( + matches!(result, Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi(_))), + "expected unsupported error for {provider:?}", + ); + } + } + } + + // ── Helpers ── + + fn builder_with_url_image(provider: RouterProvider, model: RouterMeshModel) -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + provider, + model, + reference_images: Some(ImageListRef::Urls(vec![IMAGE_URL.to_string()])), + ..Default::default() + } + } + + fn builder_with_token_image(provider: RouterProvider, model: RouterMeshModel) -> GenerateMeshRequestBuilder { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + GenerateMeshRequestBuilder { + provider, + model, + prompt: Some("a red ceramic teapot".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..Default::default() + } + } + + fn expect_request(result: MeshGenerationDraftOrRequest) -> MeshGenerationRequest { + match result { + MeshGenerationDraftOrRequest::Request(request) => request, + MeshGenerationDraftOrRequest::Draft(draft) => panic!("expected Request, got Draft: {draft:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/generate_mesh_response.rs b/crates/router/src/generate/generate_mesh/generate_mesh_response.rs new file mode 100644 index 00000000..56447ea0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/generate_mesh_response.rs @@ -0,0 +1,51 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use artcraft_client::tokens::generic_inference_jobs::InferenceJobToken; + +#[derive(Clone, Debug)] +pub struct ArtcraftMeshResponsePayload { + pub inference_job_token: InferenceJobToken, + pub all_inference_job_tokens: Vec, +} + +#[derive(Clone, Debug)] +pub struct FalMeshResponsePayload { + pub request_id: Option, + pub gateway_request_id: Option, + + /// Queue-mode status URL (fal's queue/polling flow). `None` for webhook + /// dispatch — the webhook callback drives status updates instead. + pub maybe_status_url: Option, + + /// Queue-mode response URL (fal's queue/polling flow). `None` for webhook + /// dispatch. + pub maybe_response_url: Option, + + /// The outbound request that was sent to Fal. + /// Stored as a trait object so any Request type can be captured. + /// Use `format!("{:?}", ...)` or `format!("{:#?}", ...)` to print. + pub maybe_outbound_request: Option>, +} + +#[derive(Clone, Debug)] +pub enum GenerateMeshResponse { + Artcraft(ArtcraftMeshResponsePayload), + Fal(FalMeshResponsePayload), +} + +impl GenerateMeshResponse { + pub fn get_artcraft_payload(&self) -> Option { + match self { + Self::Artcraft(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_fal_payload(&self) -> Option { + match self { + Self::Fal(p) => Some(p.clone()), + _ => None, + } + } +} diff --git a/crates/router/src/generate/generate_mesh/mesh_generation_cost_estimate.rs b/crates/router/src/generate/generate_mesh/mesh_generation_cost_estimate.rs new file mode 100644 index 00000000..0187cf09 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/mesh_generation_cost_estimate.rs @@ -0,0 +1,16 @@ +/// The result of estimating the cost of a mesh generation plan. +#[derive(Clone, Debug)] +pub struct MeshGenerationCostEstimate { + pub cost_in_credits: Option, + pub cost_in_usd_cents: Option, + pub is_free: bool, + pub is_unlimited: bool, + pub is_rate_limited: bool, + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/router/src/generate/generate_mesh/mesh_generation_draft.rs b/crates/router/src/generate/generate_mesh/mesh_generation_draft.rs new file mode 100644 index 00000000..0eef23b7 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/mesh_generation_draft.rs @@ -0,0 +1,35 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::mesh_generation_draft_context::MeshGenerationDraftContext; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; + +/** + * Wrapper for all mesh generation draft requests. + * + * No mesh provider currently needs a draft phase: fal takes media URLs + * directly and Artcraft takes media tokens, so `build2()` always returns a + * `Request`. The enum exists so the mesh pipeline matches the audio/image + * draft-or-request shape and providers that need pre-upload can slot in + * later. + */ +#[derive(Clone, Debug)] +pub enum MeshGenerationDraftRequest {} + +impl MeshGenerationDraftRequest { + + pub fn get_provider(&self) -> RouterProvider { + match *self {} + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match *self {} + } + + /// Finalize the draft request before generation + /// This may involve uploading media to the provider. + pub async fn finalize(self, _draft_context: MeshGenerationDraftContext<'_>) -> Result { + match self {} + } +} diff --git a/crates/router/src/generate/generate_mesh/mesh_generation_draft_context.rs b/crates/router/src/generate/generate_mesh/mesh_generation_draft_context.rs new file mode 100644 index 00000000..4114a372 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/mesh_generation_draft_context.rs @@ -0,0 +1,25 @@ +use std::collections::HashMap; +use std::fmt::Debug; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::client::router_client::RouterClient; + +#[derive(Clone, Default)] +pub struct MeshGenerationDraftContext<'a> { + /// Optional: the router client, needed for providers that require authentication. + pub client: Option<&'a RouterClient>, + + /// Optional context: a map of Media File Tokens to their ArtCraft URLs + /// Only needed if we have to fetch these assets and upload them to another provider. + pub media_file_to_artcraft_url_map: Option<&'a HashMap>, +} + +impl Debug for MeshGenerationDraftContext<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("MeshGenerationDraftContext") + .field("client", &self.client.is_some()) + .field("media_file_to_artcraft_url_map", &self.media_file_to_artcraft_url_map) + .finish() + } +} diff --git a/crates/router/src/generate/generate_mesh/mesh_generation_draft_or_request.rs b/crates/router/src/generate/generate_mesh/mesh_generation_draft_or_request.rs new file mode 100644 index 00000000..e82d7e09 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/mesh_generation_draft_or_request.rs @@ -0,0 +1,28 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::mesh_generation_draft::MeshGenerationDraftRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; + +#[derive(Debug, Clone)] +pub enum MeshGenerationDraftOrRequest { + Draft(MeshGenerationDraftRequest), + Request(MeshGenerationRequest), +} + +impl MeshGenerationDraftOrRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::Draft(draft) => draft.get_provider(), + Self::Request(request) => request.get_provider(), + } + } + + pub fn estimate_cost(&self) -> Result { + match self { + MeshGenerationDraftOrRequest::Draft(draft) => draft.estimate_cost(), + MeshGenerationDraftOrRequest::Request(request) => request.estimate_cost(), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/mesh_generation_request.rs b/crates/router/src/generate/generate_mesh/mesh_generation_request.rs new file mode 100644 index 00000000..7841247e --- /dev/null +++ b/crates/router/src/generate/generate_mesh/mesh_generation_request.rs @@ -0,0 +1,214 @@ +use crate::api::router_provider::RouterProvider; +use crate::client::router_client::RouterClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3::cost::ArtcraftHunyuan3d3CostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3::request::ArtcraftHunyuan3d3RequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3_sketch::cost::ArtcraftHunyuan3d3SketchCostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3_sketch::request::ArtcraftHunyuan3d3SketchRequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p0::cost::ArtcraftHunyuan3d2p0CostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p0::request::ArtcraftHunyuan3d2p0RequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p1::cost::ArtcraftHunyuan3d2p1CostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p1::request::ArtcraftHunyuan3d2p1RequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_part::cost::ArtcraftHunyuan3d3p1PartCostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_part::request::ArtcraftHunyuan3d3p1PartRequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_pro::cost::ArtcraftHunyuan3d3p1ProCostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_pro::request::ArtcraftHunyuan3d3p1ProRequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_rapid::cost::ArtcraftHunyuan3d3p1RapidCostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_rapid::request::ArtcraftHunyuan3d3p1RapidRequestState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_smart_topology::cost::ArtcraftHunyuan3d3p1SmartTopologyCostState; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_smart_topology::request::ArtcraftHunyuan3d3p1SmartTopologyRequestState; +use crate::generate::generate_mesh::providers::artcraft::meshy_v6::cost::ArtcraftMeshyV6CostState; +use crate::generate::generate_mesh::providers::artcraft::meshy_v6::request::ArtcraftMeshyV6RequestState; +use crate::generate::generate_mesh::providers::artcraft::rodin_2p5_fast::cost::ArtcraftRodin2p5FastCostState; +use crate::generate::generate_mesh::providers::artcraft::rodin_2p5_fast::request::ArtcraftRodin2p5FastRequestState; +use crate::generate::generate_mesh::providers::artcraft::tripo3d_h3p1::cost::ArtcraftTripo3dH3p1CostState; +use crate::generate::generate_mesh::providers::artcraft::tripo3d_h3p1::request::ArtcraftTripo3dH3p1RequestState; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::{ + FalHunyuan3d3ImageCostState, FalHunyuan3d3TextCostState, +}; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::{ + FalHunyuan3d3ImageRequestState, FalHunyuan3d3TextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3_sketch::cost::FalHunyuan3d3SketchCostState; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3_sketch::request::FalHunyuan3d3SketchRequestState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p0::cost::FalHunyuan3d2p0CostState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p0::request::FalHunyuan3d2p0RequestState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p1::cost::FalHunyuan3d2p1CostState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p1::request::FalHunyuan3d2p1RequestState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_part::cost::FalHunyuan3d3p1PartCostState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_part::request::FalHunyuan3d3p1PartRequestState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_pro::cost::{ + FalHunyuan3d3p1ProImageCostState, FalHunyuan3d3p1ProTextCostState, +}; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_pro::request::{ + FalHunyuan3d3p1ProImageRequestState, FalHunyuan3d3p1ProTextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_rapid::cost::{ + FalHunyuan3d3p1RapidImageCostState, FalHunyuan3d3p1RapidTextCostState, +}; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_rapid::request::{ + FalHunyuan3d3p1RapidImageRequestState, FalHunyuan3d3p1RapidTextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_smart_topology::cost::FalHunyuan3d3p1SmartTopologyCostState; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_smart_topology::request::FalHunyuan3d3p1SmartTopologyRequestState; +use crate::generate::generate_mesh::providers::fal::meshy_v6::cost::{ + FalMeshyV6ImageCostState, FalMeshyV6TextCostState, +}; +use crate::generate::generate_mesh::providers::fal::meshy_v6::request::{ + FalMeshyV6ImageRequestState, FalMeshyV6TextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::rodin_2p5_fast::cost::{ + FalRodin2p5FastImageCostState, FalRodin2p5FastTextCostState, +}; +use crate::generate::generate_mesh::providers::fal::rodin_2p5_fast::request::{ + FalRodin2p5FastImageRequestState, FalRodin2p5FastTextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::tripo3d_h3p1::cost::{ + FalTripo3dH3p1ImageCostState, FalTripo3dH3p1MultiviewCostState, FalTripo3dH3p1TextCostState, +}; +use crate::generate::generate_mesh::providers::fal::tripo3d_h3p1::request::{ + FalTripo3dH3p1ImageRequestState, FalTripo3dH3p1MultiviewRequestState, FalTripo3dH3p1TextRequestState, +}; + +#[derive(Clone, Debug)] +pub enum MeshGenerationRequest { + ArtcraftHunyuan3d2p0(ArtcraftHunyuan3d2p0RequestState), + ArtcraftHunyuan3d2p1(ArtcraftHunyuan3d2p1RequestState), + ArtcraftHunyuan3d3(ArtcraftHunyuan3d3RequestState), + ArtcraftHunyuan3d3Sketch(ArtcraftHunyuan3d3SketchRequestState), + ArtcraftHunyuan3d3p1Pro(ArtcraftHunyuan3d3p1ProRequestState), + ArtcraftHunyuan3d3p1Rapid(ArtcraftHunyuan3d3p1RapidRequestState), + ArtcraftHunyuan3d3p1Part(ArtcraftHunyuan3d3p1PartRequestState), + ArtcraftHunyuan3d3p1SmartTopology(ArtcraftHunyuan3d3p1SmartTopologyRequestState), + ArtcraftTripo3dH3p1(ArtcraftTripo3dH3p1RequestState), + ArtcraftMeshyV6(ArtcraftMeshyV6RequestState), + ArtcraftRodin2p5Fast(ArtcraftRodin2p5FastRequestState), + FalHunyuan3d2p0(FalHunyuan3d2p0RequestState), + FalHunyuan3d2p1(FalHunyuan3d2p1RequestState), + FalHunyuan3d3Image(FalHunyuan3d3ImageRequestState), + FalHunyuan3d3Text(FalHunyuan3d3TextRequestState), + FalHunyuan3d3Sketch(FalHunyuan3d3SketchRequestState), + FalHunyuan3d3p1ProImage(FalHunyuan3d3p1ProImageRequestState), + FalHunyuan3d3p1ProText(FalHunyuan3d3p1ProTextRequestState), + FalHunyuan3d3p1RapidImage(FalHunyuan3d3p1RapidImageRequestState), + FalHunyuan3d3p1RapidText(FalHunyuan3d3p1RapidTextRequestState), + FalHunyuan3d3p1Part(FalHunyuan3d3p1PartRequestState), + FalHunyuan3d3p1SmartTopology(FalHunyuan3d3p1SmartTopologyRequestState), + FalTripo3dH3p1Text(FalTripo3dH3p1TextRequestState), + FalTripo3dH3p1Image(FalTripo3dH3p1ImageRequestState), + FalTripo3dH3p1Multiview(FalTripo3dH3p1MultiviewRequestState), + FalMeshyV6Text(FalMeshyV6TextRequestState), + FalMeshyV6Image(FalMeshyV6ImageRequestState), + FalRodin2p5FastText(FalRodin2p5FastTextRequestState), + FalRodin2p5FastImage(FalRodin2p5FastImageRequestState), +} + +impl MeshGenerationRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::ArtcraftHunyuan3d2p0(_) + | Self::ArtcraftHunyuan3d2p1(_) + | Self::ArtcraftHunyuan3d3(_) + | Self::ArtcraftHunyuan3d3Sketch(_) + | Self::ArtcraftHunyuan3d3p1Pro(_) + | Self::ArtcraftHunyuan3d3p1Rapid(_) + | Self::ArtcraftHunyuan3d3p1Part(_) + | Self::ArtcraftHunyuan3d3p1SmartTopology(_) + | Self::ArtcraftTripo3dH3p1(_) + | Self::ArtcraftMeshyV6(_) + | Self::ArtcraftRodin2p5Fast(_) => RouterProvider::Artcraft, + Self::FalHunyuan3d2p0(_) + | Self::FalHunyuan3d2p1(_) + | Self::FalHunyuan3d3Image(_) + | Self::FalHunyuan3d3Text(_) + | Self::FalHunyuan3d3Sketch(_) + | Self::FalHunyuan3d3p1ProImage(_) + | Self::FalHunyuan3d3p1ProText(_) + | Self::FalHunyuan3d3p1RapidImage(_) + | Self::FalHunyuan3d3p1RapidText(_) + | Self::FalHunyuan3d3p1Part(_) + | Self::FalHunyuan3d3p1SmartTopology(_) + | Self::FalTripo3dH3p1Text(_) + | Self::FalTripo3dH3p1Image(_) + | Self::FalTripo3dH3p1Multiview(_) + | Self::FalMeshyV6Text(_) + | Self::FalMeshyV6Image(_) + | Self::FalRodin2p5FastText(_) + | Self::FalRodin2p5FastImage(_) => RouterProvider::Fal, + } + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match self { + Self::ArtcraftHunyuan3d2p0(request) => Ok(ArtcraftHunyuan3d2p0CostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d2p1(request) => Ok(ArtcraftHunyuan3d2p1CostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d3(request) => Ok(ArtcraftHunyuan3d3CostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d3Sketch(request) => Ok(ArtcraftHunyuan3d3SketchCostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d3p1Pro(request) => Ok(ArtcraftHunyuan3d3p1ProCostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d3p1Rapid(request) => Ok(ArtcraftHunyuan3d3p1RapidCostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d3p1Part(request) => Ok(ArtcraftHunyuan3d3p1PartCostState::from_request(request).estimate_cost()), + Self::ArtcraftHunyuan3d3p1SmartTopology(request) => Ok(ArtcraftHunyuan3d3p1SmartTopologyCostState::from_request(request).estimate_cost()), + Self::ArtcraftTripo3dH3p1(request) => Ok(ArtcraftTripo3dH3p1CostState::from_request(request).estimate_cost()), + Self::ArtcraftMeshyV6(request) => Ok(ArtcraftMeshyV6CostState::from_request(request).estimate_cost()), + Self::ArtcraftRodin2p5Fast(request) => Ok(ArtcraftRodin2p5FastCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d2p0(request) => Ok(FalHunyuan3d2p0CostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d2p1(request) => Ok(FalHunyuan3d2p1CostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3Image(request) => Ok(FalHunyuan3d3ImageCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3Text(request) => Ok(FalHunyuan3d3TextCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3Sketch(request) => Ok(FalHunyuan3d3SketchCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3p1ProImage(request) => Ok(FalHunyuan3d3p1ProImageCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3p1ProText(request) => Ok(FalHunyuan3d3p1ProTextCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3p1RapidImage(request) => Ok(FalHunyuan3d3p1RapidImageCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3p1RapidText(request) => Ok(FalHunyuan3d3p1RapidTextCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3p1Part(request) => Ok(FalHunyuan3d3p1PartCostState::from_request(request).estimate_cost()), + Self::FalHunyuan3d3p1SmartTopology(request) => Ok(FalHunyuan3d3p1SmartTopologyCostState::from_request(request).estimate_cost()), + Self::FalTripo3dH3p1Text(request) => Ok(FalTripo3dH3p1TextCostState::from_request(request).estimate_cost()), + Self::FalTripo3dH3p1Image(request) => Ok(FalTripo3dH3p1ImageCostState::from_request(request).estimate_cost()), + Self::FalTripo3dH3p1Multiview(request) => Ok(FalTripo3dH3p1MultiviewCostState::from_request(request).estimate_cost()), + Self::FalMeshyV6Text(request) => Ok(FalMeshyV6TextCostState::from_request(request).estimate_cost()), + Self::FalMeshyV6Image(request) => Ok(FalMeshyV6ImageCostState::from_request(request).estimate_cost()), + Self::FalRodin2p5FastText(request) => Ok(FalRodin2p5FastTextCostState::from_request(request).estimate_cost()), + Self::FalRodin2p5FastImage(request) => Ok(FalRodin2p5FastImageCostState::from_request(request).estimate_cost()), + } + } + + /// Send the mesh generation request + /// If successful, returns the job IDs. + pub async fn send_request(&self, client: &RouterClient) -> Result { + match self { + Self::ArtcraftHunyuan3d2p0(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d2p1(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d3(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d3Sketch(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d3p1Pro(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d3p1Rapid(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d3p1Part(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftHunyuan3d3p1SmartTopology(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftTripo3dH3p1(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftMeshyV6(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::ArtcraftRodin2p5Fast(request) => request.send(client.get_artcraft_client_ref()?).await, + Self::FalHunyuan3d2p0(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d2p1(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3Image(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3Text(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3Sketch(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3p1ProImage(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3p1ProText(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3p1RapidImage(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3p1RapidText(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3p1Part(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalHunyuan3d3p1SmartTopology(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalTripo3dH3p1Text(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalTripo3dH3p1Image(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalTripo3dH3p1Multiview(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalMeshyV6Text(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalMeshyV6Image(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalRodin2p5FastText(request) => request.send(client.get_fal_client_ref()?).await, + Self::FalRodin2p5FastImage(request) => request.send(client.get_fal_client_ref()?).await, + } + } +} diff --git a/crates/router/src/generate/generate_mesh/mod.rs b/crates/router/src/generate/generate_mesh/mod.rs new file mode 100644 index 00000000..83ad68d4 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/mod.rs @@ -0,0 +1,8 @@ +pub mod generate_mesh_request_builder; +pub mod generate_mesh_response; +pub mod mesh_generation_cost_estimate; +pub mod mesh_generation_draft; +pub mod mesh_generation_draft_context; +pub mod mesh_generation_draft_or_request; +pub mod mesh_generation_request; +pub mod providers; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/build_common.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/build_common.rs new file mode 100644 index 00000000..afb7516a --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/build_common.rs @@ -0,0 +1,140 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::providers::artcraft::resolve::{ + resolve_image_list_ref, resolve_image_ref, resolve_mesh_ref, +}; + +/// Build an `OmniGenMeshCostAndGenerateRequest` from the builder. The +/// Artcraft provider is a thin forwarding shim: the storyteller-web omni +/// mesh endpoint owns per-model validation and option mapping, so the +/// builder's options are passed through as-is. +pub fn build_artcraft_omni_mesh_request( + mut builder: GenerateMeshRequestBuilder, + model: CommonMeshModelEnum, +) -> Result { + let reference_image_media_tokens = resolve_image_list_ref(builder.reference_images.take())?; + let front_image_media_token = resolve_image_ref(builder.front_image.take())?; + let back_image_media_token = resolve_image_ref(builder.back_image.take())?; + let left_image_media_token = resolve_image_ref(builder.left_image.take())?; + let right_image_media_token = resolve_image_ref(builder.right_image.take())?; + let input_mesh_media_token = resolve_mesh_ref(builder.input_mesh.take())?; + let idempotency_token = builder.get_or_generate_idempotency_token(); + + Ok(OmniGenMeshCostAndGenerateRequest { + idempotency_token: Some(idempotency_token), + model: Some(model), + prompt: builder.prompt.take(), + reference_image_media_tokens, + front_image_media_token, + back_image_media_token, + left_image_media_token, + right_image_media_token, + input_mesh_media_token, + mesh_output_type: builder.mesh_output_type, + polygon_type: builder.polygon_type, + face_count: builder.face_count, + enable_pbr: builder.enable_pbr, + enable_texture: builder.enable_texture, + texture_quality: builder.texture_quality, + geometry_quality: builder.geometry_quality, + }) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::errors::client_error::ClientError; + + use super::*; + + #[test] + fn all_fields_are_forwarded() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_ref".to_string()), + ])), + front_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_front".to_string()))), + back_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_back".to_string()))), + left_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_left".to_string()))), + right_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_right".to_string()))), + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + enable_pbr: Some(true), + idempotency_token: Some("test-token".to_string()), + ..base_builder() + }; + + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3) + .expect("build"); + + assert_eq!(request.idempotency_token.as_deref(), Some("test-token")); + assert_eq!(request.model, Some(CommonMeshModelEnum::Hunyuan3d3)); + assert_eq!(request.prompt.as_deref(), Some("a red ceramic teapot")); + assert_eq!(request.reference_image_media_tokens.as_ref().map(|t| t.len()), Some(1)); + assert_eq!(request.front_image_media_token.as_ref().map(|t| t.as_str()), Some("mf_front")); + assert_eq!(request.back_image_media_token.as_ref().map(|t| t.as_str()), Some("mf_back")); + assert_eq!(request.left_image_media_token.as_ref().map(|t| t.as_str()), Some("mf_left")); + assert_eq!(request.right_image_media_token.as_ref().map(|t| t.as_str()), Some("mf_right")); + assert_eq!(request.mesh_output_type, Some(CommonMeshOutputType::LowPoly)); + assert_eq!(request.polygon_type, Some(CommonPolygonType::Quad)); + assert_eq!(request.face_count, Some(100_000)); + assert_eq!(request.enable_pbr, Some(true)); + } + + #[test] + fn idempotency_token_is_generated_when_missing() { + let request = build_artcraft_omni_mesh_request(base_builder(), CommonMeshModelEnum::Hunyuan3d3) + .expect("build"); + assert!(request.idempotency_token.is_some()); + assert!(!request.idempotency_token.unwrap().is_empty()); + } + + #[test] + fn reference_image_url_references_are_rejected() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/a.png".to_string()])), + ..base_builder() + }; + let result = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + )); + } + + #[test] + fn side_image_url_references_are_rejected() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..base_builder() + }; + let result = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + )); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/build.rs new file mode 100644 index 00000000..b2967a11 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3::request::ArtcraftHunyuan3d3RequestState; + +pub fn build_artcraft_hunyuan3d_3(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3)?; + let state = ArtcraftHunyuan3d3RequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d3(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/cost.rs new file mode 100644 index 00000000..69ace3c3 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/cost.rs @@ -0,0 +1,225 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3::request::ArtcraftHunyuan3d3RequestState; + +const NORMAL_COST_IN_USD_CENTS: u64 = 49; +const LOW_POLY_COST_IN_USD_CENTS: u64 = 59; +const GEOMETRY_COST_IN_USD_CENTS: u64 = 30; +const ADD_ON_COST_IN_USD_CENTS: u64 = 20; + +/// Hunyuan 3D v3 via Artcraft: flat base price by output type, plus a flat +/// add-on for each extra option (PBR materials, custom face count, and +/// multi-view side images). +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3CostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d3CostState { + pub fn from_request(request: &ArtcraftHunyuan3d3RequestState) -> Self { + let request = &request.request; + + let mut cost = match request.mesh_output_type { + None | Some(CommonMeshOutputType::Normal) => NORMAL_COST_IN_USD_CENTS, + Some(CommonMeshOutputType::LowPoly) => LOW_POLY_COST_IN_USD_CENTS, + Some(CommonMeshOutputType::Geometry) => GEOMETRY_COST_IN_USD_CENTS, + }; + if request.enable_pbr.unwrap_or(false) { + cost += ADD_ON_COST_IN_USD_CENTS; + } + if request.face_count.is_some() { + cost += ADD_ON_COST_IN_USD_CENTS; + } + let uses_multi_view = request.back_image_media_token.is_some() + || request.left_image_media_token.is_some() + || request.right_image_media_token.is_some(); + if uses_multi_view { + cost += ADD_ON_COST_IN_USD_CENTS; + } + + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + mod base_costs { + use super::*; + + #[test] + fn default_output_type_is_forty_nine_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 49); + } + + #[test] + fn normal_is_forty_nine_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49); + } + + #[test] + fn low_poly_is_fifty_nine_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 59); + } + + #[test] + fn geometry_is_thirty_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30); + } + + #[test] + fn text_mode_prices_the_same_as_image_mode() { + // Text-only request (no image references). + let text_builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + }; + assert_eq!(estimate_usd_cents(text_builder), 49); + } + + #[test] + fn polygon_type_does_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49); + } + } + + mod add_ons { + use super::*; + + #[test] + fn pbr_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn pbr_false_adds_nothing() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(false), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49); + } + + #[test] + fn face_count_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn each_side_image_adds_twenty_cents_at_most_once() { + for side in ["back", "left", "right"] { + let mut builder = base_builder(); + let image = Some(ImageRef::MediaFileToken(MediaFileToken::new(format!("mf_{side}")))); + match side { + "back" => builder.back_image = image, + "left" => builder.left_image = image, + _ => builder.right_image = image, + } + assert_eq!(estimate_usd_cents(builder), 49 + 20, "for {side} image"); + } + + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_back".to_string()))), + left_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_left".to_string()))), + right_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_right".to_string()))), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn all_add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + enable_pbr: Some(true), + face_count: Some(100_000), + back_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_back".to_string()))), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 59 + 20 + 20 + 20); + } + + #[test] + fn geometry_with_all_add_ons() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + enable_pbr: Some(true), + face_count: Some(10_000), + left_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_left".to_string()))), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30 + 20 + 20 + 20); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/request.rs new file mode 100644 index 00000000..6f81e036 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3/request.rs @@ -0,0 +1,64 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3RequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d3RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_mesh_teapot() { + let response = run_pipeline(GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Artcraft, + prompt: Some("A red ceramic teapot with a curved spout.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateMeshResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateMeshResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/build.rs new file mode 100644 index 00000000..a71fe9af --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3_sketch::request::ArtcraftHunyuan3d3SketchRequestState; + +pub fn build_artcraft_hunyuan3d_3_sketch(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3Sketch)?; + let state = ArtcraftHunyuan3d3SketchRequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d3Sketch(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/cost.rs new file mode 100644 index 00000000..79a87b3f --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/cost.rs @@ -0,0 +1,115 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan3d_3_sketch::request::ArtcraftHunyuan3d3SketchRequestState; + +const BASE_COST_IN_USD_CENTS: u64 = 49; +const ADD_ON_COST_IN_USD_CENTS: u64 = 20; + +/// Hunyuan 3D v3 sketch-to-3D via Artcraft: flat base price plus a flat +/// add-on for each extra option (PBR materials, custom face count). +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3SketchCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d3SketchCostState { + pub fn from_request(request: &ArtcraftHunyuan3d3SketchRequestState) -> Self { + let request = &request.request; + + let mut cost = BASE_COST_IN_USD_CENTS; + if request.enable_pbr.unwrap_or(false) { + cost += ADD_ON_COST_IN_USD_CENTS; + } + if request.face_count.is_some() { + cost += ADD_ON_COST_IN_USD_CENTS; + } + + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + #[test] + fn base_cost_is_forty_nine_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 49); + } + + #[test] + fn pbr_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn pbr_false_adds_nothing() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(false), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49); + } + + #[test] + fn face_count_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn all_add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20 + 20); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3Sketch, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_sketch".to_string()), + ])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/request.rs new file mode 100644 index 00000000..3f1df13f --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan3d_3_sketch/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3SketchRequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d3SketchRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/build.rs new file mode 100644 index 00000000..a9d494cb --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p0::request::ArtcraftHunyuan3d2p0RequestState; + +pub fn build_artcraft_hunyuan_3d_2p0(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d2p0)?; + let state = ArtcraftHunyuan3d2p0RequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d2p0(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/cost.rs new file mode 100644 index 00000000..612f7324 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/cost.rs @@ -0,0 +1,93 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p0::request::ArtcraftHunyuan3d2p0RequestState; + +const TEXTURED_COST_IN_USD_CENTS: u64 = 63; +const GEOMETRY_COST_IN_USD_CENTS: u64 = 21; + +/// Hunyuan 3D 2.0 via Artcraft: flat price by output type. Geometry-only +/// (white mesh) is cheaper; every other output type prices as textured. +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d2p0CostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d2p0CostState { + pub fn from_request(request: &ArtcraftHunyuan3d2p0RequestState) -> Self { + let cost = match request.request.mesh_output_type { + Some(CommonMeshOutputType::Geometry) => GEOMETRY_COST_IN_USD_CENTS, + None | Some(_) => TEXTURED_COST_IN_USD_CENTS, + }; + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + #[test] + fn default_output_type_is_sixty_three_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 63); + } + + #[test] + fn normal_is_sixty_three_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 63); + } + + #[test] + fn geometry_is_twenty_one_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 21); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p0, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/request.rs new file mode 100644 index 00000000..d615c526 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p0/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d2p0RequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d2p0RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/build.rs new file mode 100644 index 00000000..c7fdcb8b --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p1::request::ArtcraftHunyuan3d2p1RequestState; + +pub fn build_artcraft_hunyuan_3d_2p1(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d2p1)?; + let state = ArtcraftHunyuan3d2p1RequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d2p1(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/cost.rs new file mode 100644 index 00000000..460c4a3f --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/cost.rs @@ -0,0 +1,93 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_2p1::request::ArtcraftHunyuan3d2p1RequestState; + +const TEXTURED_COST_IN_USD_CENTS: u64 = 117; +const GEOMETRY_COST_IN_USD_CENTS: u64 = 39; + +/// Hunyuan 3D 2.1 via Artcraft: flat price by output type. Geometry-only +/// (white mesh) is cheaper; every other output type prices as textured. +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d2p1CostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d2p1CostState { + pub fn from_request(request: &ArtcraftHunyuan3d2p1RequestState) -> Self { + let cost = match request.request.mesh_output_type { + Some(CommonMeshOutputType::Geometry) => GEOMETRY_COST_IN_USD_CENTS, + None | Some(_) => TEXTURED_COST_IN_USD_CENTS, + }; + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + #[test] + fn default_output_type_is_one_seventeen_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 117); + } + + #[test] + fn normal_is_one_seventeen_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 117); + } + + #[test] + fn geometry_is_thirty_nine_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p1, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/request.rs new file mode 100644 index 00000000..5cfa8338 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_2p1/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d2p1RequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d2p1RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/build.rs new file mode 100644 index 00000000..9aa03e86 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_part::request::ArtcraftHunyuan3d3p1PartRequestState; + +pub fn build_artcraft_hunyuan_3d_3p1_part(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3p1Part)?; + let state = ArtcraftHunyuan3d3p1PartRequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d3p1Part(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/cost.rs new file mode 100644 index 00000000..faa070c3 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/cost.rs @@ -0,0 +1,78 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_part::request::ArtcraftHunyuan3d3p1PartRequestState; + +const FLAT_COST_IN_USD_CENTS: u64 = 59; + +/// Hunyuan 3D v3.1 Part via Artcraft: flat 59¢ per generation, with no +/// add-ons. +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1PartCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d3p1PartCostState { + pub fn from_request(_request: &ArtcraftHunyuan3d3p1PartRequestState) -> Self { + Self { cost_in_usd_cents: FLAT_COST_IN_USD_CENTS } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + mod cost_table { + use super::*; + + #[test] + fn cost_is_a_flat_fifty_nine_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 59); + } + + #[test] + fn options_do_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 59); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Part, + provider: RouterProvider::Artcraft, + input_mesh: Some(MeshRef::MediaFileToken(MediaFileToken::new("mf_mesh".to_string()))), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/request.rs new file mode 100644 index 00000000..af76821c --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_part/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1PartRequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d3p1PartRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/build.rs new file mode 100644 index 00000000..77ca1c65 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_pro::request::ArtcraftHunyuan3d3p1ProRequestState; + +pub fn build_artcraft_hunyuan_3d_3p1_pro(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3p1Pro)?; + let state = ArtcraftHunyuan3d3p1ProRequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d3p1Pro(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/cost.rs new file mode 100644 index 00000000..c1afa6d7 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/cost.rs @@ -0,0 +1,183 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_pro::request::ArtcraftHunyuan3d3p1ProRequestState; + +const BASE_COST_IN_USD_CENTS: u64 = 49; +const ADD_ON_COST_IN_USD_CENTS: u64 = 20; + +/// Hunyuan 3D v3.1 Pro via Artcraft: flat 49¢ base price (any output type), +/// plus a flat 20¢ add-on for each extra option (PBR materials, custom face +/// count, and multi-view side images). +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1ProCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d3p1ProCostState { + pub fn from_request(request: &ArtcraftHunyuan3d3p1ProRequestState) -> Self { + let request = &request.request; + + let mut cost = BASE_COST_IN_USD_CENTS; + if request.enable_pbr.unwrap_or(false) { + cost += ADD_ON_COST_IN_USD_CENTS; + } + if request.face_count.is_some() { + cost += ADD_ON_COST_IN_USD_CENTS; + } + let uses_multi_view = request.back_image_media_token.is_some() + || request.left_image_media_token.is_some() + || request.right_image_media_token.is_some(); + if uses_multi_view { + cost += ADD_ON_COST_IN_USD_CENTS; + } + + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + mod base_costs { + use super::*; + + #[test] + fn default_output_type_is_forty_nine_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 49); + } + + #[test] + fn every_output_type_prices_the_same() { + let cases = [ + Some(CommonMeshOutputType::Normal), + Some(CommonMeshOutputType::Geometry), + ]; + for output_type in cases { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: output_type, + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49, "for {output_type:?}"); + } + } + + #[test] + fn text_mode_prices_the_same_as_image_mode() { + // Text-only request (no image references). + let text_builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + }; + assert_eq!(estimate_usd_cents(text_builder), 49); + } + } + + mod add_ons { + use super::*; + + #[test] + fn pbr_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn pbr_false_adds_nothing() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(false), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49); + } + + #[test] + fn face_count_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn each_side_image_adds_twenty_cents_at_most_once() { + for side in ["back", "left", "right"] { + let mut builder = base_builder(); + let image = Some(ImageRef::MediaFileToken(MediaFileToken::new(format!("mf_{side}")))); + match side { + "back" => builder.back_image = image, + "left" => builder.left_image = image, + _ => builder.right_image = image, + } + assert_eq!(estimate_usd_cents(builder), 49 + 20, "for {side} image"); + } + + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_back".to_string()))), + left_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_left".to_string()))), + right_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_right".to_string()))), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20); + } + + #[test] + fn all_add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + face_count: Some(100_000), + back_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_back".to_string()))), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 49 + 20 + 20 + 20); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/request.rs new file mode 100644 index 00000000..0a667cef --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_pro/request.rs @@ -0,0 +1,64 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1ProRequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d3p1ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_mesh_teapot() { + let response = run_pipeline(GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Artcraft, + prompt: Some("A red ceramic teapot with a curved spout.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateMeshResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateMeshResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/build.rs new file mode 100644 index 00000000..578c4bf6 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_rapid::request::ArtcraftHunyuan3d3p1RapidRequestState; + +pub fn build_artcraft_hunyuan_3d_3p1_rapid(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3p1Rapid)?; + let state = ArtcraftHunyuan3d3p1RapidRequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d3p1Rapid(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/cost.rs new file mode 100644 index 00000000..606ac04a --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/cost.rs @@ -0,0 +1,124 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_rapid::request::ArtcraftHunyuan3d3p1RapidRequestState; + +const BASE_COST_IN_USD_CENTS: u64 = 30; +const PBR_ADD_ON_COST_IN_USD_CENTS: u64 = 20; + +/// Hunyuan 3D v3.1 Rapid via Artcraft: flat 30¢ base price, plus a flat 20¢ +/// add-on for PBR materials. +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1RapidCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d3p1RapidCostState { + pub fn from_request(request: &ArtcraftHunyuan3d3p1RapidRequestState) -> Self { + let request = &request.request; + + let mut cost = BASE_COST_IN_USD_CENTS; + if request.enable_pbr.unwrap_or(false) { + cost += PBR_ADD_ON_COST_IN_USD_CENTS; + } + + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + mod base_costs { + use super::*; + + #[test] + fn base_cost_is_thirty_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 30); + } + + #[test] + fn text_mode_prices_the_same_as_image_mode() { + // Text-only request (no image references). + let text_builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + }; + assert_eq!(estimate_usd_cents(text_builder), 30); + } + + #[test] + fn output_type_does_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30); + } + } + + mod add_ons { + use super::*; + + #[test] + fn pbr_adds_twenty_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30 + 20); + } + + #[test] + fn pbr_false_adds_nothing() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(false), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/request.rs new file mode 100644 index 00000000..c7a62081 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_rapid/request.rs @@ -0,0 +1,64 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1RapidRequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d3p1RapidRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_mesh_teapot() { + let response = run_pipeline(GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Artcraft, + prompt: Some("A red ceramic teapot with a curved spout.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateMeshResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateMeshResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/build.rs new file mode 100644 index 00000000..b0434204 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_smart_topology::request::ArtcraftHunyuan3d3p1SmartTopologyRequestState; + +pub fn build_artcraft_hunyuan_3d_3p1_smart_topology(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Hunyuan3d3p1SmartTopology)?; + let state = ArtcraftHunyuan3d3p1SmartTopologyRequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftHunyuan3d3p1SmartTopology(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/cost.rs new file mode 100644 index 00000000..8ab0b866 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/cost.rs @@ -0,0 +1,78 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::hunyuan_3d_3p1_smart_topology::request::ArtcraftHunyuan3d3p1SmartTopologyRequestState; + +const FLAT_COST_IN_USD_CENTS: u64 = 98; + +/// Hunyuan 3D v3.1 Smart Topology via Artcraft: flat 98¢ per generation, +/// with no add-ons. +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1SmartTopologyCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftHunyuan3d3p1SmartTopologyCostState { + pub fn from_request(_request: &ArtcraftHunyuan3d3p1SmartTopologyRequestState) -> Self { + Self { cost_in_usd_cents: FLAT_COST_IN_USD_CENTS } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + mod cost_table { + use super::*; + + #[test] + fn cost_is_a_flat_ninety_eight_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 98); + } + + #[test] + fn polygon_type_does_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 98); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1SmartTopology, + provider: RouterProvider::Artcraft, + input_mesh: Some(MeshRef::MediaFileToken(MediaFileToken::new("mf_mesh".to_string()))), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/request.rs new file mode 100644 index 00000000..3cf6aabe --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/hunyuan_3d_3p1_smart_topology/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHunyuan3d3p1SmartTopologyRequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftHunyuan3d3p1SmartTopologyRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/build.rs new file mode 100644 index 00000000..7da67d49 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::meshy_v6::request::ArtcraftMeshyV6RequestState; + +pub fn build_artcraft_meshy_v6(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::MeshyV6)?; + let state = ArtcraftMeshyV6RequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftMeshyV6(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/cost.rs new file mode 100644 index 00000000..b563bc06 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/cost.rs @@ -0,0 +1,100 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::meshy_v6::request::ArtcraftMeshyV6RequestState; + +const FLAT_COST_IN_USD_CENTS: u64 = 104; + +/// Meshy 6 via Artcraft: flat price per generation, regardless of options +/// or input mode (text or image). +#[derive(Clone, Debug)] +pub struct ArtcraftMeshyV6CostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftMeshyV6CostState { + pub fn from_request(_request: &ArtcraftMeshyV6RequestState) -> Self { + Self { cost_in_usd_cents: FLAT_COST_IN_USD_CENTS } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + mod flat_pricing { + use super::*; + + #[test] + fn image_mode_is_one_hundred_four_cents() { + assert_eq!(estimate_usd_cents(image_builder()), 104); + } + + #[test] + fn text_mode_is_one_hundred_four_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 104); + } + + #[test] + fn options_do_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + enable_pbr: Some(true), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 104); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/request.rs new file mode 100644 index 00000000..aafdbadb --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/meshy_v6/request.rs @@ -0,0 +1,64 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMeshyV6RequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftMeshyV6RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_mesh_teapot() { + let response = run_pipeline(GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Artcraft, + prompt: Some("A red ceramic teapot with a curved spout.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateMeshResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateMeshResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/mod.rs new file mode 100644 index 00000000..19ec5280 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/mod.rs @@ -0,0 +1,14 @@ +pub(crate) mod build_common; +pub(crate) mod request_common; +pub(crate) mod resolve; +pub mod hunyuan3d_3; +pub mod hunyuan3d_3_sketch; +pub mod hunyuan_3d_2p0; +pub mod hunyuan_3d_2p1; +pub mod hunyuan_3d_3p1_part; +pub mod hunyuan_3d_3p1_pro; +pub mod hunyuan_3d_3p1_rapid; +pub mod hunyuan_3d_3p1_smart_topology; +pub mod meshy_v6; +pub mod rodin_2p5_fast; +pub mod tripo3d_h3p1; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/request_common.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/request_common.rs new file mode 100644 index 00000000..791b91a5 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/request_common.rs @@ -0,0 +1,32 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; +use artcraft_client::credentials::api_or_web_creds::ApiOrWebCreds; +use artcraft_client::endpoints::omni_gen::generate::mesh::omni_gen_mesh::{omni_gen_mesh_generate, OmniGenMeshGenerateArgs}; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_mesh::generate_mesh_response::{ + ArtcraftMeshResponsePayload, GenerateMeshResponse, +}; + +/// Send a mesh generation request to the Artcraft omni-gen endpoint. +/// All Artcraft model request states delegate to this function. +pub async fn send_artcraft_omni_mesh_request( + request: &OmniGenMeshCostAndGenerateRequest, + client: &RouterArtcraftClient, +) -> Result { + let api_or_web_creds = ApiOrWebCreds::from(&client.credentials); + + let response = omni_gen_mesh_generate(OmniGenMeshGenerateArgs { + api_host: &client.api_host, + api_or_web_creds: Some(&api_or_web_creds), + request, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateMeshResponse::Artcraft(ArtcraftMeshResponsePayload { + inference_job_token: response.inference_job_token, + all_inference_job_tokens: response.all_job_tokens, + })) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/resolve.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/resolve.rs new file mode 100644 index 00000000..09ccd903 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/resolve.rs @@ -0,0 +1,57 @@ +//! Shared resolve helpers for the Artcraft mesh provider. +//! +//! Artcraft only accepts media file tokens — raw URLs are rejected. + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::mesh_ref::MeshRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +pub(super) fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +pub(super) fn resolve_image_ref( + image_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::MediaFileToken(token)) => Ok(Some(token)), + Some(ImageRef::Url(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + } +} + +pub(super) fn resolve_mesh_ref( + mesh_ref: Option, +) -> Result, ArtcraftRouterError> { + match mesh_ref { + None => Ok(None), + Some(MeshRef::MediaFileToken(token)) => Ok(Some(token)), + Some(MeshRef::Url(_) | MeshRef::LocalPath(_) | MeshRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/build.rs new file mode 100644 index 00000000..ca47c7b2 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::rodin_2p5_fast::request::ArtcraftRodin2p5FastRequestState; + +pub fn build_artcraft_rodin_2p5_fast(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Rodin2p5Fast)?; + let state = ArtcraftRodin2p5FastRequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftRodin2p5Fast(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/cost.rs new file mode 100644 index 00000000..86b72eeb --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/cost.rs @@ -0,0 +1,97 @@ +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::rodin_2p5_fast::request::ArtcraftRodin2p5FastRequestState; + +const FLAT_COST_IN_USD_CENTS: u64 = 13; + +/// Hyper3D Rodin v2.5 Fast via Artcraft: flat price per generation, +/// regardless of options or input mode (text or image). +#[derive(Clone, Debug)] +pub struct ArtcraftRodin2p5FastCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftRodin2p5FastCostState { + pub fn from_request(_request: &ArtcraftRodin2p5FastRequestState) -> Self { + Self { cost_in_usd_cents: FLAT_COST_IN_USD_CENTS } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + mod flat_pricing { + use super::*; + + #[test] + fn image_mode_is_thirteen_cents() { + assert_eq!(estimate_usd_cents(image_builder()), 13); + } + + #[test] + fn text_mode_is_thirteen_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 13); + } + + #[test] + fn options_do_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + enable_pbr: Some(true), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 13); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Artcraft, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/request.rs new file mode 100644 index 00000000..ac613686 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/rodin_2p5_fast/request.rs @@ -0,0 +1,64 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftRodin2p5FastRequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftRodin2p5FastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_mesh_teapot() { + let response = run_pipeline(GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Artcraft, + prompt: Some("A red ceramic teapot with a curved spout.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateMeshResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateMeshResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/build.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/build.rs new file mode 100644 index 00000000..dc97d444 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/build.rs @@ -0,0 +1,14 @@ +use artcraft_client::enums::common::generation::common_mesh_model::CommonMeshModel as CommonMeshModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::artcraft::build_common::build_artcraft_omni_mesh_request; +use crate::generate::generate_mesh::providers::artcraft::tripo3d_h3p1::request::ArtcraftTripo3dH3p1RequestState; + +pub fn build_artcraft_tripo3d_h3p1(builder: GenerateMeshRequestBuilder) -> Result { + let request = build_artcraft_omni_mesh_request(builder, CommonMeshModelEnum::Tripo3dH3p1)?; + let state = ArtcraftTripo3dH3p1RequestState { request }; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::ArtcraftTripo3dH3p1(state))) +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/cost.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/cost.rs new file mode 100644 index 00000000..9827f65e --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/cost.rs @@ -0,0 +1,338 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::artcraft::tripo3d_h3p1::request::ArtcraftTripo3dH3p1RequestState; + +// Text and multi-view generations share a price tier; single-image +// generations price higher. +const TEXT_OR_MULTIVIEW_UNTEXTURED_COST_IN_USD_CENTS: u64 = 13; +const TEXT_OR_MULTIVIEW_STANDARD_TEXTURE_COST_IN_USD_CENTS: u64 = 26; +const TEXT_OR_MULTIVIEW_DETAILED_TEXTURE_COST_IN_USD_CENTS: u64 = 39; +const IMAGE_UNTEXTURED_COST_IN_USD_CENTS: u64 = 26; +const IMAGE_STANDARD_TEXTURE_COST_IN_USD_CENTS: u64 = 39; +const IMAGE_DETAILED_TEXTURE_COST_IN_USD_CENTS: u64 = 52; +const DETAILED_GEOMETRY_ADD_ON_COST_IN_USD_CENTS: u64 = 26; +const QUAD_ADD_ON_COST_IN_USD_CENTS: u64 = 7; + +/// Tripo3D H3.1 via Artcraft: base price by input mode (text and multi-view +/// share a tier; single-image is higher) and texture tier (untextured, +/// standard, or detailed), plus flat add-ons for detailed geometry and quad +/// topology. +#[derive(Clone, Debug)] +pub struct ArtcraftTripo3dH3p1CostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftTripo3dH3p1CostState { + pub fn from_request(request: &ArtcraftTripo3dH3p1RequestState) -> Self { + let request = &request.request; + + let uses_multi_view = request.back_image_media_token.is_some() + || request.left_image_media_token.is_some() + || request.right_image_media_token.is_some(); + let has_primary_image = request.front_image_media_token.is_some() + || request.reference_image_media_tokens.as_ref().is_some_and(|tokens| !tokens.is_empty()); + let uses_single_image = !uses_multi_view && has_primary_image; + + // The untextured tier requires that PBR isn't explicitly requested, + // since PBR implies texturing. + let texture_off = (matches!(request.mesh_output_type, Some(CommonMeshOutputType::Geometry)) + || request.enable_texture == Some(false)) + && request.enable_pbr != Some(true); + + let (untextured, standard, detailed) = if uses_single_image { + ( + IMAGE_UNTEXTURED_COST_IN_USD_CENTS, + IMAGE_STANDARD_TEXTURE_COST_IN_USD_CENTS, + IMAGE_DETAILED_TEXTURE_COST_IN_USD_CENTS, + ) + } else { + ( + TEXT_OR_MULTIVIEW_UNTEXTURED_COST_IN_USD_CENTS, + TEXT_OR_MULTIVIEW_STANDARD_TEXTURE_COST_IN_USD_CENTS, + TEXT_OR_MULTIVIEW_DETAILED_TEXTURE_COST_IN_USD_CENTS, + ) + }; + + let mut cost = if texture_off { + untextured + } else if matches!(request.texture_quality, Some(CommonMeshQuality::Detailed)) { + detailed + } else { + standard + }; + + if matches!(request.geometry_quality, Some(CommonMeshQuality::Detailed)) { + cost += DETAILED_GEOMETRY_ADD_ON_COST_IN_USD_CENTS; + } + if matches!(request.polygon_type, Some(CommonPolygonType::Quad)) { + cost += QUAD_ADD_ON_COST_IN_USD_CENTS; + } + + Self { cost_in_usd_cents: cost } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + use super::*; + + mod text_mode_costs { + use super::*; + + #[test] + fn default_is_standard_textures() { + assert_eq!(estimate_usd_cents(text_builder()), 26); + } + + #[test] + fn untextured_via_enable_texture_off() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 13); + } + + #[test] + fn untextured_via_geometry_output() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 13); + } + + #[test] + fn texture_off_with_pbr_keeps_textured_tier() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + enable_pbr: Some(true), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 26); + } + + #[test] + fn detailed_texture() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39); + } + } + + mod image_mode_costs { + use super::*; + + #[test] + fn default_is_standard_textures() { + assert_eq!(estimate_usd_cents(image_builder()), 39); + } + + #[test] + fn untextured_via_enable_texture_off() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 26); + } + + #[test] + fn untextured_via_geometry_output() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 26); + } + + #[test] + fn detailed_texture() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 52); + } + + #[test] + fn front_image_token_prices_as_image_mode() { + let builder = GenerateMeshRequestBuilder { + front_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_front".to_string()))), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39); + } + } + + mod multiview_mode_costs { + use super::*; + + #[test] + fn default_is_standard_textures() { + assert_eq!(estimate_usd_cents(multiview_builder()), 26); + } + + #[test] + fn each_side_view_prices_as_multiview() { + for side in ["back", "left", "right"] { + let mut builder = image_builder(); + let image = Some(ImageRef::MediaFileToken(MediaFileToken::new(format!("mf_{side}")))); + match side { + "back" => builder.back_image = image, + "left" => builder.left_image = image, + _ => builder.right_image = image, + } + assert_eq!(estimate_usd_cents(builder), 26, "for {side} image"); + } + } + + #[test] + fn untextured_via_enable_texture_off() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..multiview_builder() + }; + assert_eq!(estimate_usd_cents(builder), 13); + } + + #[test] + fn detailed_texture() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..multiview_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39); + } + } + + mod add_ons { + use super::*; + + #[test] + fn detailed_geometry_adds_twenty_six_cents() { + let builder = GenerateMeshRequestBuilder { + geometry_quality: Some(CommonMeshQuality::Detailed), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39 + 26); + } + + #[test] + fn quad_adds_seven_cents() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39 + 7); + } + + #[test] + fn triangle_polygon_adds_nothing() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Triangle), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39); + } + + #[test] + fn standard_qualities_add_nothing() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Standard), + geometry_quality: Some(CommonMeshQuality::Standard), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 39); + } + + #[test] + fn all_add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + polygon_type: Some(CommonPolygonType::Quad), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 52 + 26 + 7); + } + + #[test] + fn add_ons_stack_on_the_untextured_tier() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + geometry_quality: Some(CommonMeshQuality::Detailed), + polygon_type: Some(CommonPolygonType::Quad), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 13 + 26 + 7); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Tripo3dH3p1, + provider: RouterProvider::Artcraft, + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..base_builder() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_front".to_string()), + ])), + ..base_builder() + } + } + + fn multiview_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + back_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_back".to_string()))), + ..image_builder() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/mod.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/request.rs b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/request.rs new file mode 100644 index 00000000..17000ccf --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/artcraft/tripo3d_h3p1/request.rs @@ -0,0 +1,64 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_mesh_cost_and_generate_request::OmniGenMeshCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::artcraft::request_common::send_artcraft_omni_mesh_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftTripo3dH3p1RequestState { + pub request: OmniGenMeshCostAndGenerateRequest, +} + +impl ArtcraftTripo3dH3p1RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_mesh_teapot() { + let response = run_pipeline(GenerateMeshRequestBuilder { + model: RouterMeshModel::Tripo3dH3p1, + provider: RouterProvider::Artcraft, + prompt: Some("A red ceramic teapot with a curved spout.".to_string()), + ..Default::default() + }).await; + assert!(matches!(response, GenerateMeshResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateMeshResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/build.rs new file mode 100644 index 00000000..485ad6f5 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/build.rs @@ -0,0 +1,330 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; +use fal_client::requests::api::mesh::image::hunyuan3d_3_image_to_mesh::api::{ + Hunyuan3d3ImageToMeshGenerateType, Hunyuan3d3ImageToMeshPolygonType, Hunyuan3d3ImageToMeshRequest, +}; +use fal_client::requests::api::mesh::text::hunyuan3d_3_text_to_mesh::api::{ + Hunyuan3d3TextToMeshGenerateType, Hunyuan3d3TextToMeshPolygonType, Hunyuan3d3TextToMeshRequest, +}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::{ + FalHunyuan3d3ImageRequestState, FalHunyuan3d3TextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_face_count, plan_primary_image_url, plan_side_image_url, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// Hunyuan 3D v3 combines fal's image-to-3d and text-to-3d endpoints under a +/// single router model. The request shape picks the endpoint: any image input +/// (reference images or `front_image`) dispatches to image-to-3d; otherwise a +/// prompt dispatches to text-to-3d. +pub fn build_fal_hunyuan3d_3(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan3d_3_state(builder)?; + let request = match state { + FalHunyuan3d3State::Image(state) => MeshGenerationRequest::FalHunyuan3d3Image(state), + FalHunyuan3d3State::Text(state) => MeshGenerationRequest::FalHunyuan3d3Text(state), + }; + Ok(MeshGenerationDraftOrRequest::Request(request)) +} + +/// The endpoint selected by the request shape. +#[derive(Clone, Debug)] +pub(crate) enum FalHunyuan3d3State { + Image(FalHunyuan3d3ImageRequestState), + Text(FalHunyuan3d3TextRequestState), +} + +pub(crate) fn build_fal_hunyuan3d_3_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let maybe_front_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )?; + let face_count = plan_face_count(builder.face_count, strategy)?; + + match maybe_front_url { + Some(image_url) => { + // Image mode. The image endpoint has no prompt parameter. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + + let request = Hunyuan3d3ImageToMeshRequest { + image_url, + back_image_url: plan_side_image_url(builder.back_image.take())?, + left_image_url: plan_side_image_url(builder.left_image.take())?, + right_image_url: plan_side_image_url(builder.right_image.take())?, + face_count, + generate_type: builder.mesh_output_type.map(to_image_generate_type), + polygon_type: builder.polygon_type.map(to_image_polygon_type), + enable_pbr: builder.enable_pbr, + }; + Ok(FalHunyuan3d3State::Image(FalHunyuan3d3ImageRequestState { request })) + } + None => { + // Text mode. Multi-view side images only make sense alongside a front + // image, so they're unsupported here. + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Hunyuan 3D v3 requires an input image or a prompt".to_string(), + ) + })?; + + let request = Hunyuan3d3TextToMeshRequest { + prompt, + face_count, + generate_type: builder.mesh_output_type.map(to_text_generate_type), + polygon_type: builder.polygon_type.map(to_text_polygon_type), + enable_pbr: builder.enable_pbr, + }; + Ok(FalHunyuan3d3State::Text(FalHunyuan3d3TextRequestState { request })) + } + } +} + +// ── Enum mapping helpers ── + +fn to_image_generate_type(output_type: CommonMeshOutputType) -> Hunyuan3d3ImageToMeshGenerateType { + match output_type { + CommonMeshOutputType::Normal => Hunyuan3d3ImageToMeshGenerateType::Normal, + CommonMeshOutputType::LowPoly => Hunyuan3d3ImageToMeshGenerateType::LowPoly, + CommonMeshOutputType::Geometry => Hunyuan3d3ImageToMeshGenerateType::Geometry, + } +} + +fn to_image_polygon_type(polygon_type: CommonPolygonType) -> Hunyuan3d3ImageToMeshPolygonType { + match polygon_type { + CommonPolygonType::Triangle => Hunyuan3d3ImageToMeshPolygonType::Triangle, + CommonPolygonType::Quad => Hunyuan3d3ImageToMeshPolygonType::Quadrilateral, + } +} + +fn to_text_generate_type(output_type: CommonMeshOutputType) -> Hunyuan3d3TextToMeshGenerateType { + match output_type { + CommonMeshOutputType::Normal => Hunyuan3d3TextToMeshGenerateType::Normal, + CommonMeshOutputType::LowPoly => Hunyuan3d3TextToMeshGenerateType::LowPoly, + CommonMeshOutputType::Geometry => Hunyuan3d3TextToMeshGenerateType::Geometry, + } +} + +fn to_text_polygon_type(polygon_type: CommonPolygonType) -> Hunyuan3d3TextToMeshPolygonType { + match polygon_type { + CommonPolygonType::Triangle => Hunyuan3d3TextToMeshPolygonType::Triangle, + CommonPolygonType::Quad => Hunyuan3d3TextToMeshPolygonType::Quadrilateral, + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::errors::client_error::ClientError; + + use super::*; + + const FRONT_URL: &str = "https://example.com/front.png"; + const BACK_URL: &str = "https://example.com/back.png"; + + mod shape_dispatch { + use super::*; + + #[test] + fn reference_image_dispatches_to_image_mode() { + let state = build_fal_hunyuan3d_3_state(image_builder()).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn front_image_dispatches_to_image_mode() { + let builder = GenerateMeshRequestBuilder { + reference_images: None, + front_image: Some(ImageRef::Url(FRONT_URL.to_string())), + ..base_builder() + }; + let state = build_fal_hunyuan3d_3_state(builder).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn prompt_only_dispatches_to_text_mode() { + let state = build_fal_hunyuan3d_3_state(text_builder()).expect("build"); + let text = expect_text(state); + assert_eq!(text.request.prompt, "a red ceramic teapot"); + } + + #[test] + fn neither_image_nor_prompt_is_rejected() { + let result = build_fal_hunyuan3d_3_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + } + + mod image_mode { + use super::*; + + #[test] + fn side_images_map_to_multi_view_params() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + left_image: Some(ImageRef::Url("https://example.com/left.png".to_string())), + right_image: Some(ImageRef::Url("https://example.com/right.png".to_string())), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan3d_3_state(builder).expect("build")); + assert_eq!(image.request.back_image_url.as_deref(), Some(BACK_URL)); + assert_eq!(image.request.left_image_url.as_deref(), Some("https://example.com/left.png")); + assert_eq!(image.request.right_image_url.as_deref(), Some("https://example.com/right.png")); + } + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan3d_3_state(builder).expect("build")); + assert!(matches!(image.request.generate_type, Some(Hunyuan3d3ImageToMeshGenerateType::LowPoly))); + assert!(matches!(image.request.polygon_type, Some(Hunyuan3d3ImageToMeshPolygonType::Quadrilateral))); + assert_eq!(image.request.face_count, Some(100_000)); + assert_eq!(image.request.enable_pbr, Some(true)); + } + + #[test] + fn prompt_with_image_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_hunyuan3d_3_state(builder).is_err()); + } + + #[test] + fn prompt_with_image_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..image_builder() + }; + assert!(matches!( + build_fal_hunyuan3d_3_state(builder).expect("build"), + FalHunyuan3d3State::Image(_) + )); + } + + #[test] + fn media_tokens_are_rejected() { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_hunyuan3d_3_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + mod text_mode { + use super::*; + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + polygon_type: Some(CommonPolygonType::Triangle), + face_count: Some(40_000), + enable_pbr: Some(false), + ..text_builder() + }; + let text = expect_text(build_fal_hunyuan3d_3_state(builder).expect("build")); + assert!(matches!(text.request.generate_type, Some(Hunyuan3d3TextToMeshGenerateType::Geometry))); + assert!(matches!(text.request.polygon_type, Some(Hunyuan3d3TextToMeshPolygonType::Triangle))); + assert_eq!(text.request.face_count, Some(40_000)); + assert_eq!(text.request.enable_pbr, Some(false)); + } + + #[test] + fn side_images_without_front_error_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..text_builder() + }; + assert!(build_fal_hunyuan3d_3_state(builder).is_err()); + } + + #[test] + fn side_images_without_front_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + ..text_builder() + }; + assert!(matches!( + build_fal_hunyuan3d_3_state(builder).expect("build"), + FalHunyuan3d3State::Text(_) + )); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..base_builder() + } + } + + fn expect_image(state: FalHunyuan3d3State) -> FalHunyuan3d3ImageRequestState { + match state { + FalHunyuan3d3State::Image(image) => image, + FalHunyuan3d3State::Text(text) => panic!("expected image mode, got text: {text:?}"), + } + } + + fn expect_text(state: FalHunyuan3d3State) -> FalHunyuan3d3TextRequestState { + match state { + FalHunyuan3d3State::Text(text) => text, + FalHunyuan3d3State::Image(image) => panic!("expected text mode, got image: {image:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/cost.rs new file mode 100644 index 00000000..1b1f00e6 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/cost.rs @@ -0,0 +1,164 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::{ + FalHunyuan3d3ImageRequestState, FalHunyuan3d3TextRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3ImageCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3ImageCostState { + pub fn from_request(request: &FalHunyuan3d3ImageRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3TextCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3TextCostState { + pub fn from_request(request: &FalHunyuan3d3TextRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +pub(crate) fn fal_mesh_cost_estimate(cost_in_usd_cents: u64) -> MeshGenerationCostEstimate { + MeshGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const FRONT_URL: &str = "https://example.com/front.png"; + + mod image_mode_costs { + use super::*; + + #[test] + fn base_cost_table() { + let cases = [ + (None, 38), + (Some(CommonMeshOutputType::Normal), 38), + (Some(CommonMeshOutputType::LowPoly), 45), + (Some(CommonMeshOutputType::Geometry), 23), + ]; + for (output_type, expected) in cases { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: output_type, + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), expected, "for {output_type:?}"); + } + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + enable_pbr: Some(true), + face_count: Some(100_000), + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..image_builder() + }; + // LowPoly(45) + PBR(15) + face_count(15) + multi_view(15) + assert_eq!(estimate_usd_cents(builder), 90); + } + } + + mod text_mode_costs { + use super::*; + + #[test] + fn base_cost_table() { + let cases = [ + (None, 38), + (Some(CommonMeshOutputType::Normal), 38), + (Some(CommonMeshOutputType::LowPoly), 45), + (Some(CommonMeshOutputType::Geometry), 23), + ]; + for (output_type, expected) in cases { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: output_type, + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), expected, "for {output_type:?}"); + } + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + enable_pbr: Some(true), + face_count: Some(40_000), + ..text_builder() + }; + // Geometry(23) + PBR(15) + face_count(15) + assert_eq!(estimate_usd_cents(builder), 53); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/request.rs new file mode 100644 index 00000000..ed2fcc77 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3/request.rs @@ -0,0 +1,141 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::mesh::image::hunyuan3d_3_image_to_mesh::api::Hunyuan3d3ImageToMeshRequest; +use fal_client::requests::api::mesh::text::hunyuan3d_3_text_to_mesh::api::Hunyuan3d3TextToMeshRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::{ + FalMeshResponsePayload, GenerateMeshResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3ImageRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3ImageToMeshRequest, +} + +impl FalHunyuan3d3ImageRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3TextRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3TextToMeshRequest, +} + +impl FalHunyuan3d3TextRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +/// Send a mesh request to fal using the client's dispatch mode (webhook or +/// queue). Shared by all Fal mesh request states. +pub(crate) async fn send_fal_mesh_request( + request: &R, + client: &RouterFalClient, +) -> Result +where + R: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + + let payload = if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + FalMeshResponsePayload { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + } + } else { + let response = request.send_queue_request(&client.api_key).await?; + FalMeshResponsePayload { + request_id: Some(response.request_id), + gateway_request_id: None, + maybe_status_url: Some(response.status_url), + maybe_response_url: Some(response.response_url), + maybe_outbound_request: Some(outbound), + } + }; + + Ok(GenerateMeshResponse::Fal(payload)) +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_hunyuan3d_3_image_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..hunyuan3d_3_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_hunyuan3d_3_text_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + prompt: Some("A velociraptor with an open mouth full of sharp teeth.".to_string()), + ..hunyuan3d_3_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn hunyuan3d_3_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + pub(crate) fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } + + pub(crate) async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/build.rs new file mode 100644 index 00000000..cc8dc379 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/build.rs @@ -0,0 +1,154 @@ +use fal_client::requests::api::mesh::sketch::hunyuan3d_3_sketch_to_mesh::api::Hunyuan3d3SketchToMeshRequest; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3_sketch::request::FalHunyuan3d3SketchRequestState; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_face_count, plan_primary_image_url, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +pub fn build_fal_hunyuan3d_3_sketch(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan3d_3_sketch_state(builder)?; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::FalHunyuan3d3Sketch(state))) +} + +pub(crate) fn build_fal_hunyuan3d_3_sketch_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // fal's sketch-to-3d schema has no generate_type/polygon_type parameters, + // and no multi-view side images. + reject_unsupported_option("mesh_output_type", builder.mesh_output_type.as_ref(), strategy)?; + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let image_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )? + .ok_or_else(|| ArtcraftRouterError::InvalidInput( + "A sketch image is required for Hunyuan 3D v3 sketch-to-3D".to_string(), + ))?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "A prompt is required for Hunyuan 3D v3 sketch-to-3D".to_string(), + ) + })?; + + let request = Hunyuan3d3SketchToMeshRequest { + image_url, + prompt, + face_count: plan_face_count(builder.face_count, strategy)?, + enable_pbr: builder.enable_pbr, + }; + + Ok(FalHunyuan3d3SketchRequestState { request }) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + use super::*; + + const SKETCH_URL: &str = "https://example.com/sketch.png"; + + #[test] + fn sketch_and_prompt_pass_through() { + let state = build_fal_hunyuan3d_3_sketch_state(base_builder()).expect("build"); + assert_eq!(state.request.image_url, SKETCH_URL); + assert_eq!(state.request.prompt, "a red ceramic teapot"); + } + + #[test] + fn missing_sketch_is_rejected() { + let builder = GenerateMeshRequestBuilder { reference_images: None, ..base_builder() }; + assert!(matches!( + build_fal_hunyuan3d_3_sketch_state(builder), + Err(ArtcraftRouterError::InvalidInput(_)) + )); + } + + #[test] + fn missing_prompt_is_rejected() { + let builder = GenerateMeshRequestBuilder { prompt: None, ..base_builder() }; + assert!(matches!( + build_fal_hunyuan3d_3_sketch_state(builder), + Err(ArtcraftRouterError::InvalidInput(_)) + )); + } + + #[test] + fn face_count_and_pbr_pass_through() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(100_000), + enable_pbr: Some(true), + ..base_builder() + }; + let state = build_fal_hunyuan3d_3_sketch_state(builder).expect("build"); + assert_eq!(state.request.face_count, Some(100_000)); + assert_eq!(state.request.enable_pbr, Some(true)); + } + + #[test] + fn unsupported_options_error_out() { + let cases: Vec = vec![ + GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..base_builder() + }, + GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..base_builder() + }, + GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..base_builder() + }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_hunyuan3d_3_sketch_state(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + polygon_type: Some(CommonPolygonType::Quad), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..base_builder() + }; + assert!(build_fal_hunyuan3d_3_sketch_state(builder).is_ok()); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3Sketch, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + reference_images: Some(ImageListRef::Urls(vec![SKETCH_URL.to_string()])), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/cost.rs new file mode 100644 index 00000000..cb6ab405 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/cost.rs @@ -0,0 +1,87 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3_sketch::request::FalHunyuan3d3SketchRequestState; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3SketchCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3SketchCostState { + pub fn from_request(request: &FalHunyuan3d3SketchRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + #[test] + fn base_cost_is_thirty_eight_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 38); + } + + #[test] + fn pbr_adds_fifteen_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 38 + 15); + } + + #[test] + fn face_count_adds_fifteen_cents() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 38 + 15); + } + + #[test] + fn all_add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + face_count: Some(100_000), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 38 + 15 + 15); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3Sketch, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/sketch.png".to_string()])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/request.rs new file mode 100644 index 00000000..df83ba0c --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan3d_3_sketch/request.rs @@ -0,0 +1,68 @@ +use fal_client::requests::api::mesh::sketch::hunyuan3d_3_sketch_to_mesh::api::Hunyuan3d3SketchToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3SketchRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3SketchToMeshRequest, +} + +impl FalHunyuan3d3SketchRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_sketch_to_mesh() { + let builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3Sketch, + provider: RouterProvider::Fal, + prompt: Some("A cartoon character, colorful, plastic material".to_string()), + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..Default::default() + }; + + let client = get_fal_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/build.rs new file mode 100644 index 00000000..f5a50859 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/build.rs @@ -0,0 +1,219 @@ +use fal_client::requests::api::mesh::image::hunyuan_3d_2p0_image_to_mesh::api::Hunyuan3d2p0ImageToMeshRequest; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p0::request::FalHunyuan3d2p0RequestState; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_primary_image_url, plan_textured_mesh, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +pub fn build_fal_hunyuan_3d_2p0(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan_3d_2p0_state(builder)?; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::FalHunyuan3d2p0(state))) +} + +pub(crate) fn build_fal_hunyuan_3d_2p0_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Hunyuan 3D 2.0 is image-to-3D only, with a single input image and no + // extra mesh options. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_option("face_count", builder.face_count.as_ref(), strategy)?; + reject_unsupported_option("enable_pbr", builder.enable_pbr.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let image_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )? + .ok_or_else(|| ArtcraftRouterError::InvalidInput( + "An input image is required for Hunyuan 3D 2.0".to_string(), + ))?; + + let request = Hunyuan3d2p0ImageToMeshRequest { + image_url, + textured_mesh: plan_textured_mesh(builder.mesh_output_type, strategy)?, + // Tuning knobs stay at the endpoint's defaults. + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + Ok(FalHunyuan3d2p0RequestState { request }) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + use super::*; + + const IMAGE_URL: &str = "https://example.com/front.png"; + + mod image_requirements { + use super::*; + + #[test] + fn single_image_passes_through() { + let state = build_fal_hunyuan_3d_2p0_state(base_builder()).expect("build"); + assert_eq!(state.request.image_url, IMAGE_URL); + } + + #[test] + fn missing_image_is_rejected() { + let builder = GenerateMeshRequestBuilder { reference_images: None, ..base_builder() }; + assert!(matches!( + build_fal_hunyuan_3d_2p0_state(builder), + Err(ArtcraftRouterError::InvalidInput(_)) + )); + } + + #[test] + fn two_images_error_out() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + IMAGE_URL.to_string(), + "https://example.com/other.png".to_string(), + ])), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_hunyuan_3d_2p0_state(builder).is_err()); + } + + #[test] + fn two_images_keep_the_first_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + IMAGE_URL.to_string(), + "https://example.com/other.png".to_string(), + ])), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_2p0_state(builder).expect("build"); + assert_eq!(state.request.image_url, IMAGE_URL); + } + } + + mod output_type_mapping { + use super::*; + + #[test] + fn default_maps_to_textured() { + let state = build_fal_hunyuan_3d_2p0_state(base_builder()).expect("build"); + assert_eq!(state.request.textured_mesh, Some(true)); + } + + #[test] + fn normal_maps_to_textured() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_2p0_state(builder).expect("build"); + assert_eq!(state.request.textured_mesh, Some(true)); + } + + #[test] + fn geometry_maps_to_white_mesh() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_2p0_state(builder).expect("build"); + assert_eq!(state.request.textured_mesh, Some(false)); + } + + #[test] + fn low_poly_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_hunyuan_3d_2p0_state(builder).is_err()); + } + + #[test] + fn low_poly_upgrades_to_textured_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_2p0_state(builder).expect("build"); + assert_eq!(state.request.textured_mesh, Some(true)); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn unsupported_options_error_out() { + let cases: Vec = vec![ + GenerateMeshRequestBuilder { prompt: Some("a teapot".to_string()), ..base_builder() }, + GenerateMeshRequestBuilder { polygon_type: Some(CommonPolygonType::Quad), ..base_builder() }, + GenerateMeshRequestBuilder { face_count: Some(100_000), ..base_builder() }, + GenerateMeshRequestBuilder { enable_pbr: Some(true), ..base_builder() }, + GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..base_builder() + }, + ]; + for mut builder in cases { + builder.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_hunyuan_3d_2p0_state(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a teapot".to_string()), + face_count: Some(100_000), + enable_pbr: Some(true), + ..base_builder() + }; + assert!(build_fal_hunyuan_3d_2p0_state(builder).is_ok()); + } + + #[test] + fn tuning_knobs_stay_at_endpoint_defaults() { + let state = build_fal_hunyuan_3d_2p0_state(base_builder()).expect("build"); + assert!(state.request.guidance_scale.is_none()); + assert!(state.request.num_inference_steps.is_none()); + assert!(state.request.octree_resolution.is_none()); + assert!(state.request.seed.is_none()); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p0, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![IMAGE_URL.to_string()])), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/cost.rs new file mode 100644 index 00000000..32449f76 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/cost.rs @@ -0,0 +1,75 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p0::request::FalHunyuan3d2p0RequestState; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d2p0CostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d2p0CostState { + pub fn from_request(request: &FalHunyuan3d2p0RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + #[test] + fn textured_mesh_is_forty_eight_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 48); + + let normal = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(normal), 48); + } + + #[test] + fn white_mesh_is_sixteen_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 16); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p0, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/front.png".to_string()])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/request.rs new file mode 100644 index 00000000..276f7afe --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p0/request.rs @@ -0,0 +1,67 @@ +use fal_client::requests::api::mesh::image::hunyuan_3d_2p0_image_to_mesh::api::Hunyuan3d2p0ImageToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d2p0RequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d2p0ImageToMeshRequest, +} + +impl FalHunyuan3d2p0RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_hunyuan_3d_2p0_image_to_mesh() { + let builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p0, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..Default::default() + }; + + let client = get_fal_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/build.rs new file mode 100644 index 00000000..75b52e6f --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/build.rs @@ -0,0 +1,146 @@ +use fal_client::requests::api::mesh::image::hunyuan_3d_2p1_image_to_mesh::api::Hunyuan3d2p1ImageToMeshRequest; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p1::request::FalHunyuan3d2p1RequestState; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_primary_image_url, plan_textured_mesh, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +pub fn build_fal_hunyuan_3d_2p1(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan_3d_2p1_state(builder)?; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::FalHunyuan3d2p1(state))) +} + +pub(crate) fn build_fal_hunyuan_3d_2p1_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Hunyuan 3D 2.1 is image-to-3D only, with a single input image and no + // extra mesh options. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_option("face_count", builder.face_count.as_ref(), strategy)?; + reject_unsupported_option("enable_pbr", builder.enable_pbr.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let image_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )? + .ok_or_else(|| ArtcraftRouterError::InvalidInput( + "An input image is required for Hunyuan 3D 2.1".to_string(), + ))?; + + let request = Hunyuan3d2p1ImageToMeshRequest { + image_url, + textured_mesh: plan_textured_mesh(builder.mesh_output_type, strategy)?, + // Tuning knobs stay at the endpoint's defaults. + guidance_scale: None, + num_inference_steps: None, + octree_resolution: None, + seed: None, + }; + + Ok(FalHunyuan3d2p1RequestState { request }) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + use super::*; + + const IMAGE_URL: &str = "https://example.com/front.png"; + + #[test] + fn single_image_passes_through() { + let state = build_fal_hunyuan_3d_2p1_state(base_builder()).expect("build"); + assert_eq!(state.request.image_url, IMAGE_URL); + assert_eq!(state.request.textured_mesh, Some(true)); + } + + #[test] + fn missing_image_is_rejected() { + let builder = GenerateMeshRequestBuilder { reference_images: None, ..base_builder() }; + assert!(matches!( + build_fal_hunyuan_3d_2p1_state(builder), + Err(ArtcraftRouterError::InvalidInput(_)) + )); + } + + #[test] + fn geometry_maps_to_white_mesh() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_2p1_state(builder).expect("build"); + assert_eq!(state.request.textured_mesh, Some(false)); + } + + #[test] + fn low_poly_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_hunyuan_3d_2p1_state(builder).is_err()); + } + + #[test] + fn low_poly_upgrades_to_textured_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_2p1_state(builder).expect("build"); + assert_eq!(state.request.textured_mesh, Some(true)); + } + + #[test] + fn unsupported_options_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a teapot".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_hunyuan_3d_2p1_state(builder).is_err()); + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a teapot".to_string()), + face_count: Some(100_000), + ..base_builder() + }; + assert!(build_fal_hunyuan_3d_2p1_state(builder).is_ok()); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p1, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![IMAGE_URL.to_string()])), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/cost.rs new file mode 100644 index 00000000..1f60f682 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/cost.rs @@ -0,0 +1,75 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_2p1::request::FalHunyuan3d2p1RequestState; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d2p1CostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d2p1CostState { + pub fn from_request(request: &FalHunyuan3d2p1RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + #[test] + fn textured_mesh_is_ninety_cents() { + assert_eq!(estimate_usd_cents(base_builder()), 90); + + let normal = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(normal), 90); + } + + #[test] + fn white_mesh_is_thirty_cents() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..base_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30); + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p1, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/front.png".to_string()])), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/request.rs new file mode 100644 index 00000000..9e20a829 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_2p1/request.rs @@ -0,0 +1,67 @@ +use fal_client::requests::api::mesh::image::hunyuan_3d_2p1_image_to_mesh::api::Hunyuan3d2p1ImageToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d2p1RequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d2p1ImageToMeshRequest, +} + +impl FalHunyuan3d2p1RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_hunyuan_3d_2p1_image_to_mesh() { + let builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d2p1, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..Default::default() + }; + + let client = get_fal_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/build.rs new file mode 100644 index 00000000..d44c6003 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/build.rs @@ -0,0 +1,152 @@ +use fal_client::requests::api::mesh::part::hunyuan_3d_3p1_part::api::Hunyuan3d3p1PartRequest; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_part::request::FalHunyuan3d3p1PartRequestState; +use crate::generate::generate_mesh::providers::fal::resolve::plan_input_mesh_url; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// Hunyuan 3D v3.1 Part splits an existing mesh into semantic parts. It takes +/// only a mesh file (FBX) as input — text, images, and generation options are +/// all unsupported. +pub fn build_fal_hunyuan_3d_3p1_part(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan_3d_3p1_part_state(builder)?; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::FalHunyuan3d3p1Part(state))) +} + +pub(crate) fn build_fal_hunyuan_3d_3p1_part_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let input_file_url = plan_input_mesh_url(builder.input_mesh.take())?.ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Hunyuan 3D v3.1 Part requires an input mesh file (FBX)".to_string(), + ) + })?; + + // Part splitting takes only the mesh file; every other option is + // unsupported. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + reject_unsupported_option("reference_images", builder.reference_images.as_ref(), strategy)?; + reject_unsupported_image_ref("front_image", builder.front_image.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + reject_unsupported_option("mesh_output_type", builder.mesh_output_type.as_ref(), strategy)?; + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_option("face_count", builder.face_count.as_ref(), strategy)?; + reject_unsupported_option("enable_pbr", builder.enable_pbr.as_ref(), strategy)?; + reject_unsupported_option("enable_texture", builder.enable_texture.as_ref(), strategy)?; + reject_unsupported_option("texture_quality", builder.texture_quality.as_ref(), strategy)?; + reject_unsupported_option("geometry_quality", builder.geometry_quality.as_ref(), strategy)?; + + let request = Hunyuan3d3p1PartRequest { input_file_url }; + Ok(FalHunyuan3d3p1PartRequestState { request }) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_ref::ImageRef; + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::errors::client_error::ClientError; + + use super::*; + + const MESH_URL: &str = "https://example.com/model.fbx"; + + mod shape_dispatch { + use super::*; + + #[test] + fn input_mesh_url_builds_the_request() { + let state = build_fal_hunyuan_3d_3p1_part_state(mesh_builder()).expect("build"); + assert_eq!(state.request.input_file_url, MESH_URL); + } + + #[test] + fn missing_input_mesh_is_rejected() { + let result = build_fal_hunyuan_3d_3p1_part_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + + #[test] + fn media_token_input_mesh_is_rejected() { + let builder = GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::MediaFileToken(MediaFileToken::new("mf_mesh".to_string()))), + ..base_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_part_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn each_unsupported_option_errors_out_under_error_out() { + let cases: Vec = vec![ + |b| b.prompt = Some("a red ceramic teapot".to_string()), + |b| b.front_image = Some(ImageRef::Url("https://example.com/front.png".to_string())), + |b| b.back_image = Some(ImageRef::Url("https://example.com/back.png".to_string())), + |b| b.mesh_output_type = Some(CommonMeshOutputType::Normal), + |b| b.polygon_type = Some(CommonPolygonType::Quad), + |b| b.face_count = Some(100_000), + |b| b.enable_pbr = Some(true), + |b| b.enable_texture = Some(false), + ]; + for (index, set) in cases.into_iter().enumerate() { + let mut builder = GenerateMeshRequestBuilder { + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..mesh_builder() + }; + set(&mut builder); + assert!(build_fal_hunyuan_3d_3p1_part_state(builder).is_err(), "for case {index}"); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + mesh_output_type: Some(CommonMeshOutputType::Normal), + face_count: Some(100_000), + enable_pbr: Some(true), + ..mesh_builder() + }; + let state = build_fal_hunyuan_3d_3p1_part_state(builder).expect("build"); + assert_eq!(state.request.input_file_url, MESH_URL); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Part, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn mesh_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url(MESH_URL.to_string())), + ..base_builder() + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/cost.rs new file mode 100644 index 00000000..d00fd6e1 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/cost.rs @@ -0,0 +1,60 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_part::request::FalHunyuan3d3p1PartRequestState; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1PartCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3p1PartCostState { + pub fn from_request(request: &FalHunyuan3d3p1PartRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const MESH_URL: &str = "https://example.com/model.fbx"; + + #[test] + fn cost_is_a_flat_forty_five_cents() { + assert_eq!(estimate_usd_cents(mesh_builder()), 45); + } + + // ── Helpers ── + + fn mesh_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Part, + provider: RouterProvider::Fal, + input_mesh: Some(MeshRef::Url(MESH_URL.to_string())), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/request.rs new file mode 100644 index 00000000..9be55001 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_part/request.rs @@ -0,0 +1,52 @@ +use fal_client::requests::api::mesh::part::hunyuan_3d_3p1_part::api::Hunyuan3d3p1PartRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1PartRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3p1PartRequest, +} + +impl FalHunyuan3d3p1PartRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key and a real FBX URL, incurs cost + async fn send_part_split() { + let client = get_fal_client(); + let builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Part, + provider: RouterProvider::Fal, + input_mesh: Some(MeshRef::Url("https://example.com/model.fbx".to_string())), + ..Default::default() + }; + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/build.rs new file mode 100644 index 00000000..4e9342d2 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/build.rs @@ -0,0 +1,411 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use fal_client::requests::api::mesh::image::hunyuan_3d_3p1_pro_image_to_mesh::api::{ + Hunyuan3d3p1ProImageToMeshGenerateType, Hunyuan3d3p1ProImageToMeshRequest, +}; +use fal_client::requests::api::mesh::text::hunyuan_3d_3p1_pro_text_to_mesh::api::{ + Hunyuan3d3p1ProTextToMeshGenerateType, Hunyuan3d3p1ProTextToMeshRequest, +}; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_pro::request::{ + FalHunyuan3d3p1ProImageRequestState, FalHunyuan3d3p1ProTextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_face_count, plan_primary_image_url, plan_side_image_url, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// Hunyuan 3D v3.1 Pro combines fal's image-to-3d and text-to-3d endpoints +/// under a single router model. The request shape picks the endpoint: any +/// image input (reference images or `front_image`) dispatches to image-to-3d; +/// otherwise a prompt dispatches to text-to-3d. +pub fn build_fal_hunyuan_3d_3p1_pro(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan_3d_3p1_pro_state(builder)?; + let request = match state { + FalHunyuan3d3p1ProState::Image(state) => MeshGenerationRequest::FalHunyuan3d3p1ProImage(state), + FalHunyuan3d3p1ProState::Text(state) => MeshGenerationRequest::FalHunyuan3d3p1ProText(state), + }; + Ok(MeshGenerationDraftOrRequest::Request(request)) +} + +/// The endpoint selected by the request shape. +#[derive(Clone, Debug)] +pub(crate) enum FalHunyuan3d3p1ProState { + Image(FalHunyuan3d3p1ProImageRequestState), + Text(FalHunyuan3d3p1ProTextRequestState), +} + +pub(crate) fn build_fal_hunyuan_3d_3p1_pro_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // v3.1 Pro has no polygon-type, texture, or input-mesh parameters. + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_option("enable_texture", builder.enable_texture.as_ref(), strategy)?; + reject_unsupported_option("texture_quality", builder.texture_quality.as_ref(), strategy)?; + reject_unsupported_option("geometry_quality", builder.geometry_quality.as_ref(), strategy)?; + reject_unsupported_option("input_mesh", builder.input_mesh.as_ref(), strategy)?; + + let maybe_front_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )?; + let face_count = plan_face_count(builder.face_count, strategy)?; + + match maybe_front_url { + Some(image_url) => { + // Image mode. The image endpoint has no prompt parameter. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + + let request = Hunyuan3d3p1ProImageToMeshRequest { + image_url, + back_image_url: plan_side_image_url(builder.back_image.take())?, + left_image_url: plan_side_image_url(builder.left_image.take())?, + right_image_url: plan_side_image_url(builder.right_image.take())?, + // The builder has no fields for the v3.1-exclusive extra views. + top_image_url: None, + bottom_image_url: None, + left_front_image_url: None, + right_front_image_url: None, + generate_type: plan_image_generate_type(builder.mesh_output_type, strategy)?, + face_count, + enable_pbr: builder.enable_pbr, + }; + Ok(FalHunyuan3d3p1ProState::Image(FalHunyuan3d3p1ProImageRequestState { request })) + } + None => { + // Text mode. Multi-view side images only make sense alongside a front + // image, so they're unsupported here. + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Hunyuan 3D v3.1 Pro requires an input image or a prompt".to_string(), + ) + })?; + + let request = Hunyuan3d3p1ProTextToMeshRequest { + prompt, + generate_type: plan_text_generate_type(builder.mesh_output_type, strategy)?, + face_count, + enable_pbr: builder.enable_pbr, + }; + Ok(FalHunyuan3d3p1ProState::Text(FalHunyuan3d3p1ProTextRequestState { request })) + } + } +} + +// ── Enum mapping helpers ── + +/// v3.1 drops the v3 `LowPoly` generation type: `LowPoly` rejects under +/// `ErrorOut` and drops to the endpoint default otherwise. +fn plan_image_generate_type( + mesh_output_type: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match mesh_output_type { + None => Ok(None), + Some(CommonMeshOutputType::Normal) => Ok(Some(Hunyuan3d3p1ProImageToMeshGenerateType::Normal)), + Some(CommonMeshOutputType::Geometry) => Ok(Some(Hunyuan3d3p1ProImageToMeshGenerateType::Geometry)), + Some(CommonMeshOutputType::LowPoly) => { + reject_unsupported_option("mesh_output_type", Some(&CommonMeshOutputType::LowPoly), strategy)?; + Ok(None) + } + } +} + +fn plan_text_generate_type( + mesh_output_type: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match mesh_output_type { + None => Ok(None), + Some(CommonMeshOutputType::Normal) => Ok(Some(Hunyuan3d3p1ProTextToMeshGenerateType::Normal)), + Some(CommonMeshOutputType::Geometry) => Ok(Some(Hunyuan3d3p1ProTextToMeshGenerateType::Geometry)), + Some(CommonMeshOutputType::LowPoly) => { + reject_unsupported_option("mesh_output_type", Some(&CommonMeshOutputType::LowPoly), strategy)?; + Ok(None) + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + const FRONT_URL: &str = "https://example.com/front.png"; + const BACK_URL: &str = "https://example.com/back.png"; + + mod shape_dispatch { + use super::*; + + #[test] + fn reference_image_dispatches_to_image_mode() { + let state = build_fal_hunyuan_3d_3p1_pro_state(image_builder()).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn front_image_dispatches_to_image_mode() { + let builder = GenerateMeshRequestBuilder { + reference_images: None, + front_image: Some(ImageRef::Url(FRONT_URL.to_string())), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn prompt_only_dispatches_to_text_mode() { + let state = build_fal_hunyuan_3d_3p1_pro_state(text_builder()).expect("build"); + let text = expect_text(state); + assert_eq!(text.request.prompt, "a red ceramic teapot"); + } + + #[test] + fn neither_image_nor_prompt_is_rejected() { + let result = build_fal_hunyuan_3d_3p1_pro_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + } + + mod image_mode { + use super::*; + + #[test] + fn side_images_map_to_multi_view_params() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + left_image: Some(ImageRef::Url("https://example.com/left.png".to_string())), + right_image: Some(ImageRef::Url("https://example.com/right.png".to_string())), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build")); + assert_eq!(image.request.back_image_url.as_deref(), Some(BACK_URL)); + assert_eq!(image.request.left_image_url.as_deref(), Some("https://example.com/left.png")); + assert_eq!(image.request.right_image_url.as_deref(), Some("https://example.com/right.png")); + } + + #[test] + fn v3p1_exclusive_extra_views_are_left_unset() { + let image = expect_image(build_fal_hunyuan_3d_3p1_pro_state(image_builder()).expect("build")); + assert!(image.request.top_image_url.is_none()); + assert!(image.request.bottom_image_url.is_none()); + assert!(image.request.left_front_image_url.is_none()); + assert!(image.request.right_front_image_url.is_none()); + } + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + face_count: Some(100_000), + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build")); + assert!(matches!(image.request.generate_type, Some(Hunyuan3d3p1ProImageToMeshGenerateType::Geometry))); + assert_eq!(image.request.face_count, Some(100_000)); + assert_eq!(image.request.enable_pbr, Some(true)); + } + + #[test] + fn low_poly_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_pro_state(builder).is_err()); + } + + #[test] + fn low_poly_drops_to_default_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build")); + assert!(image.request.generate_type.is_none()); + } + + #[test] + fn prompt_with_image_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_pro_state(builder).is_err()); + } + + #[test] + fn prompt_with_image_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..image_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build"), + FalHunyuan3d3p1ProState::Image(_) + )); + } + } + + mod text_mode { + use super::*; + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + face_count: Some(40_000), + enable_pbr: Some(false), + ..text_builder() + }; + let text = expect_text(build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build")); + assert!(matches!(text.request.generate_type, Some(Hunyuan3d3p1ProTextToMeshGenerateType::Normal))); + assert_eq!(text.request.face_count, Some(40_000)); + assert_eq!(text.request.enable_pbr, Some(false)); + } + + #[test] + fn side_images_without_front_error_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..text_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_pro_state(builder).is_err()); + } + + #[test] + fn side_images_without_front_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + ..text_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build"), + FalHunyuan3d3p1ProState::Text(_) + )); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn polygon_type_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_pro_state(builder).is_err()); + } + + #[test] + fn texture_options_error_out_under_error_out() { + let cases: Vec = vec![ + |b| b.enable_texture = Some(false), + |b| b.texture_quality = Some(CommonMeshQuality::Detailed), + |b| b.geometry_quality = Some(CommonMeshQuality::Detailed), + ]; + for (index, set) in cases.into_iter().enumerate() { + let mut builder = GenerateMeshRequestBuilder { + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + set(&mut builder); + assert!(build_fal_hunyuan_3d_3p1_pro_state(builder).is_err(), "for case {index}"); + } + } + + #[test] + fn input_mesh_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url("https://example.com/model.glb".to_string())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..text_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_pro_state(builder).is_err()); + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + enable_texture: Some(false), + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + input_mesh: Some(MeshRef::Url("https://example.com/model.glb".to_string())), + ..image_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_pro_state(builder).expect("build"), + FalHunyuan3d3p1ProState::Image(_) + )); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..base_builder() + } + } + + fn expect_image(state: FalHunyuan3d3p1ProState) -> FalHunyuan3d3p1ProImageRequestState { + match state { + FalHunyuan3d3p1ProState::Image(image) => image, + FalHunyuan3d3p1ProState::Text(text) => panic!("expected image mode, got text: {text:?}"), + } + } + + fn expect_text(state: FalHunyuan3d3p1ProState) -> FalHunyuan3d3p1ProTextRequestState { + match state { + FalHunyuan3d3p1ProState::Text(text) => text, + FalHunyuan3d3p1ProState::Image(image) => panic!("expected text mode, got image: {image:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/cost.rs new file mode 100644 index 00000000..6b3a7d39 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/cost.rs @@ -0,0 +1,159 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_pro::request::{ + FalHunyuan3d3p1ProImageRequestState, FalHunyuan3d3p1ProTextRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1ProImageCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3p1ProImageCostState { + pub fn from_request(request: &FalHunyuan3d3p1ProImageRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1ProTextCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3p1ProTextCostState { + pub fn from_request(request: &FalHunyuan3d3p1ProTextRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const FRONT_URL: &str = "https://example.com/front.png"; + + mod image_mode_costs { + use super::*; + + #[test] + fn base_cost_table() { + let cases = [ + (None, 38), + (Some(CommonMeshOutputType::Normal), 38), + (Some(CommonMeshOutputType::Geometry), 38), + ]; + for (output_type, expected) in cases { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: output_type, + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), expected, "for {output_type:?}"); + } + } + + #[test] + fn multi_view_adds_fifteen_cents() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 38 + 15); + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + enable_pbr: Some(true), + face_count: Some(100_000), + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..image_builder() + }; + // base(38) + PBR(15) + face_count(15) + multi_view(15) + assert_eq!(estimate_usd_cents(builder), 83); + } + } + + mod text_mode_costs { + use super::*; + + #[test] + fn base_cost_table() { + let cases = [ + (None, 38), + (Some(CommonMeshOutputType::Normal), 38), + (Some(CommonMeshOutputType::Geometry), 38), + ]; + for (output_type, expected) in cases { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: output_type, + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), expected, "for {output_type:?}"); + } + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + face_count: Some(40_000), + ..text_builder() + }; + // base(38) + PBR(15) + face_count(15) + assert_eq!(estimate_usd_cents(builder), 68); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/request.rs new file mode 100644 index 00000000..0d9f4e37 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_pro/request.rs @@ -0,0 +1,92 @@ +use fal_client::requests::api::mesh::image::hunyuan_3d_3p1_pro_image_to_mesh::api::Hunyuan3d3p1ProImageToMeshRequest; +use fal_client::requests::api::mesh::text::hunyuan_3d_3p1_pro_text_to_mesh::api::Hunyuan3d3p1ProTextToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1ProImageRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3p1ProImageToMeshRequest, +} + +impl FalHunyuan3d3p1ProImageRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1ProTextRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3p1ProTextToMeshRequest, +} + +impl FalHunyuan3d3p1ProTextRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_pro_image_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..pro_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_pro_text_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + prompt: Some("A velociraptor with an open mouth full of sharp teeth.".to_string()), + ..pro_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn pro_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Pro, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/build.rs new file mode 100644 index 00000000..b667f8e7 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/build.rs @@ -0,0 +1,323 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use fal_client::requests::api::mesh::image::hunyuan_3d_3p1_rapid_image_to_mesh::api::Hunyuan3d3p1RapidImageToMeshRequest; +use fal_client::requests::api::mesh::text::hunyuan_3d_3p1_rapid_text_to_mesh::api::Hunyuan3d3p1RapidTextToMeshRequest; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_rapid::request::{ + FalHunyuan3d3p1RapidImageRequestState, FalHunyuan3d3p1RapidTextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::resolve::plan_primary_image_url; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// Hunyuan 3D v3.1 Rapid combines fal's rapid image-to-3d and text-to-3d +/// endpoints under a single router model. The request shape picks the +/// endpoint: any image input (reference images or `front_image`) dispatches +/// to image-to-3d; otherwise a prompt dispatches to text-to-3d. +pub fn build_fal_hunyuan_3d_3p1_rapid(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan_3d_3p1_rapid_state(builder)?; + let request = match state { + FalHunyuan3d3p1RapidState::Image(state) => MeshGenerationRequest::FalHunyuan3d3p1RapidImage(state), + FalHunyuan3d3p1RapidState::Text(state) => MeshGenerationRequest::FalHunyuan3d3p1RapidText(state), + }; + Ok(MeshGenerationDraftOrRequest::Request(request)) +} + +/// The endpoint selected by the request shape. +#[derive(Clone, Debug)] +pub(crate) enum FalHunyuan3d3p1RapidState { + Image(FalHunyuan3d3p1RapidImageRequestState), + Text(FalHunyuan3d3p1RapidTextRequestState), +} + +pub(crate) fn build_fal_hunyuan_3d_3p1_rapid_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // The rapid schema is minimal: no polygon-type, face-count, texture, or + // input-mesh parameters. + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_option("face_count", builder.face_count.as_ref(), strategy)?; + reject_unsupported_option("enable_texture", builder.enable_texture.as_ref(), strategy)?; + reject_unsupported_option("texture_quality", builder.texture_quality.as_ref(), strategy)?; + reject_unsupported_option("geometry_quality", builder.geometry_quality.as_ref(), strategy)?; + reject_unsupported_option("input_mesh", builder.input_mesh.as_ref(), strategy)?; + + // Rapid is single-image only — no multi-view side images in either mode. + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let maybe_front_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )?; + let enable_geometry = plan_enable_geometry(builder.mesh_output_type, strategy)?; + + match maybe_front_url { + Some(image_url) => { + // Image mode. The image endpoint has no prompt parameter. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + + let request = Hunyuan3d3p1RapidImageToMeshRequest { + image_url, + enable_pbr: builder.enable_pbr, + enable_geometry, + }; + Ok(FalHunyuan3d3p1RapidState::Image(FalHunyuan3d3p1RapidImageRequestState { request })) + } + None => { + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Hunyuan 3D v3.1 Rapid requires an input image or a prompt".to_string(), + ) + })?; + + let request = Hunyuan3d3p1RapidTextToMeshRequest { + prompt, + enable_pbr: builder.enable_pbr, + enable_geometry, + }; + Ok(FalHunyuan3d3p1RapidState::Text(FalHunyuan3d3p1RapidTextRequestState { request })) + } + } +} + +// ── Enum mapping helpers ── + +/// Rapid has no generation-type enum — geometry-only output is a boolean. +/// `Geometry` maps to `enable_geometry: true`; `Normal` (or unset) leaves it +/// unset (fal defaults to false); `LowPoly` rejects under `ErrorOut` and +/// drops otherwise. +fn plan_enable_geometry( + mesh_output_type: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match mesh_output_type { + None | Some(CommonMeshOutputType::Normal) => Ok(None), + Some(CommonMeshOutputType::Geometry) => Ok(Some(true)), + Some(CommonMeshOutputType::LowPoly) => { + reject_unsupported_option("mesh_output_type", Some(&CommonMeshOutputType::LowPoly), strategy)?; + Ok(None) + } + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + const FRONT_URL: &str = "https://example.com/front.png"; + const BACK_URL: &str = "https://example.com/back.png"; + + mod shape_dispatch { + use super::*; + + #[test] + fn reference_image_dispatches_to_image_mode() { + let state = build_fal_hunyuan_3d_3p1_rapid_state(image_builder()).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn front_image_dispatches_to_image_mode() { + let builder = GenerateMeshRequestBuilder { + reference_images: None, + front_image: Some(ImageRef::Url(FRONT_URL.to_string())), + ..base_builder() + }; + let state = build_fal_hunyuan_3d_3p1_rapid_state(builder).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn prompt_only_dispatches_to_text_mode() { + let state = build_fal_hunyuan_3d_3p1_rapid_state(text_builder()).expect("build"); + let text = expect_text(state); + assert_eq!(text.request.prompt, "a red ceramic teapot"); + } + + #[test] + fn neither_image_nor_prompt_is_rejected() { + let result = build_fal_hunyuan_3d_3p1_rapid_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + } + + mod option_mapping { + use super::*; + + #[test] + fn geometry_output_maps_to_enable_geometry() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_rapid_state(builder).expect("build")); + assert_eq!(image.request.enable_geometry, Some(true)); + } + + #[test] + fn normal_output_leaves_enable_geometry_unset() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Normal), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_rapid_state(builder).expect("build")); + assert!(image.request.enable_geometry.is_none()); + } + + #[test] + fn enable_pbr_passes_through_in_both_modes() { + let image_builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_rapid_state(image_builder).expect("build")); + assert_eq!(image.request.enable_pbr, Some(true)); + + let text_builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..text_builder() + }; + let text = expect_text(build_fal_hunyuan_3d_3p1_rapid_state(text_builder).expect("build")); + assert_eq!(text.request.enable_pbr, Some(true)); + } + + #[test] + fn low_poly_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_rapid_state(builder).is_err()); + } + + #[test] + fn low_poly_drops_to_default_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..image_builder() + }; + let image = expect_image(build_fal_hunyuan_3d_3p1_rapid_state(builder).expect("build")); + assert!(image.request.enable_geometry.is_none()); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn each_unsupported_option_errors_out_under_error_out() { + let cases: Vec = vec![ + |b| b.polygon_type = Some(CommonPolygonType::Quad), + |b| b.face_count = Some(100_000), + |b| b.enable_texture = Some(false), + |b| b.input_mesh = Some(MeshRef::Url("https://example.com/model.glb".to_string())), + |b| b.back_image = Some(ImageRef::Url(BACK_URL.to_string())), + |b| b.left_image = Some(ImageRef::Url(BACK_URL.to_string())), + |b| b.right_image = Some(ImageRef::Url(BACK_URL.to_string())), + ]; + for (index, set) in cases.into_iter().enumerate() { + let mut builder = GenerateMeshRequestBuilder { + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + set(&mut builder); + assert!(build_fal_hunyuan_3d_3p1_rapid_state(builder).is_err(), "for case {index}"); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + ..image_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_rapid_state(builder).expect("build"), + FalHunyuan3d3p1RapidState::Image(_) + )); + } + + #[test] + fn prompt_with_image_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_hunyuan_3d_3p1_rapid_state(builder).is_err()); + } + + #[test] + fn prompt_with_image_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..image_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_rapid_state(builder).expect("build"), + FalHunyuan3d3p1RapidState::Image(_) + )); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..base_builder() + } + } + + fn expect_image(state: FalHunyuan3d3p1RapidState) -> FalHunyuan3d3p1RapidImageRequestState { + match state { + FalHunyuan3d3p1RapidState::Image(image) => image, + FalHunyuan3d3p1RapidState::Text(text) => panic!("expected image mode, got text: {text:?}"), + } + } + + fn expect_text(state: FalHunyuan3d3p1RapidState) -> FalHunyuan3d3p1RapidTextRequestState { + match state { + FalHunyuan3d3p1RapidState::Text(text) => text, + FalHunyuan3d3p1RapidState::Image(image) => panic!("expected text mode, got image: {image:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/cost.rs new file mode 100644 index 00000000..66e8b021 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/cost.rs @@ -0,0 +1,130 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_rapid::request::{ + FalHunyuan3d3p1RapidImageRequestState, FalHunyuan3d3p1RapidTextRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1RapidImageCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3p1RapidImageCostState { + pub fn from_request(request: &FalHunyuan3d3p1RapidImageRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1RapidTextCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3p1RapidTextCostState { + pub fn from_request(request: &FalHunyuan3d3p1RapidTextRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const FRONT_URL: &str = "https://example.com/front.png"; + + mod image_mode_costs { + use super::*; + + #[test] + fn base_cost_is_twenty_three_cents() { + assert_eq!(estimate_usd_cents(image_builder()), 23); + } + + #[test] + fn pbr_adds_fifteen_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 23 + 15); + } + + #[test] + fn geometry_output_does_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 23); + } + } + + mod text_mode_costs { + use super::*; + + #[test] + fn base_cost_is_twenty_three_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 23); + } + + #[test] + fn pbr_adds_fifteen_cents() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 23 + 15); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/request.rs new file mode 100644 index 00000000..468eb59a --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_rapid/request.rs @@ -0,0 +1,92 @@ +use fal_client::requests::api::mesh::image::hunyuan_3d_3p1_rapid_image_to_mesh::api::Hunyuan3d3p1RapidImageToMeshRequest; +use fal_client::requests::api::mesh::text::hunyuan_3d_3p1_rapid_text_to_mesh::api::Hunyuan3d3p1RapidTextToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1RapidImageRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3p1RapidImageToMeshRequest, +} + +impl FalHunyuan3d3p1RapidImageRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1RapidTextRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3p1RapidTextToMeshRequest, +} + +impl FalHunyuan3d3p1RapidTextRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_rapid_image_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..rapid_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_rapid_text_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + prompt: Some("A velociraptor with an open mouth full of sharp teeth.".to_string()), + ..rapid_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn rapid_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1Rapid, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/build.rs new file mode 100644 index 00000000..511f250e --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/build.rs @@ -0,0 +1,247 @@ +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; +use fal_client::requests::api::mesh::topology::hunyuan_3d_3p1_smart_topology::api::{ + Hunyuan3d3p1SmartTopologyInputFileType, Hunyuan3d3p1SmartTopologyPolygonType, + Hunyuan3d3p1SmartTopologyRequest, +}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_smart_topology::request::FalHunyuan3d3p1SmartTopologyRequestState; +use crate::generate::generate_mesh::providers::fal::resolve::plan_input_mesh_url; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// Hunyuan 3D v3.1 Smart Topology retopologizes an existing mesh. It takes a +/// mesh file (GLB or OBJ) and an optional polygon type — text, images, and +/// the other generation options are all unsupported. +pub fn build_fal_hunyuan_3d_3p1_smart_topology(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_hunyuan_3d_3p1_smart_topology_state(builder)?; + Ok(MeshGenerationDraftOrRequest::Request(MeshGenerationRequest::FalHunyuan3d3p1SmartTopology(state))) +} + +pub(crate) fn build_fal_hunyuan_3d_3p1_smart_topology_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let input_file_url = plan_input_mesh_url(builder.input_mesh.take())?.ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Hunyuan 3D v3.1 Smart Topology requires an input mesh file (GLB or OBJ)".to_string(), + ) + })?; + + // Retopology takes only the mesh file and a polygon type; every other + // option is unsupported. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + reject_unsupported_option("reference_images", builder.reference_images.as_ref(), strategy)?; + reject_unsupported_image_ref("front_image", builder.front_image.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + reject_unsupported_option("mesh_output_type", builder.mesh_output_type.as_ref(), strategy)?; + reject_unsupported_option("face_count", builder.face_count.as_ref(), strategy)?; + reject_unsupported_option("enable_pbr", builder.enable_pbr.as_ref(), strategy)?; + reject_unsupported_option("enable_texture", builder.enable_texture.as_ref(), strategy)?; + reject_unsupported_option("texture_quality", builder.texture_quality.as_ref(), strategy)?; + reject_unsupported_option("geometry_quality", builder.geometry_quality.as_ref(), strategy)?; + + let input_file_type = infer_input_file_type(&input_file_url); + let request = Hunyuan3d3p1SmartTopologyRequest { + input_file_url, + input_file_type, + polygon_type: builder.polygon_type.map(to_polygon_type), + face_level: None, + }; + Ok(FalHunyuan3d3p1SmartTopologyRequestState { request }) +} + +// ── Mapping helpers ── + +/// Infer the input file format from the URL path: a path ending in `.obj` +/// (case-insensitive, ignoring any query string) maps to `Obj`; anything +/// else is left unset (fal defaults to GLB). +fn infer_input_file_type(url: &str) -> Option { + let path = url.split(['?', '#']).next().unwrap_or(url); + if path.to_ascii_lowercase().ends_with(".obj") { + Some(Hunyuan3d3p1SmartTopologyInputFileType::Obj) + } else { + None + } +} + +fn to_polygon_type(polygon_type: CommonPolygonType) -> Hunyuan3d3p1SmartTopologyPolygonType { + match polygon_type { + CommonPolygonType::Triangle => Hunyuan3d3p1SmartTopologyPolygonType::Triangle, + CommonPolygonType::Quad => Hunyuan3d3p1SmartTopologyPolygonType::Quadrilateral, + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_ref::ImageRef; + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::errors::client_error::ClientError; + + use super::*; + + const GLB_URL: &str = "https://example.com/model.glb"; + const OBJ_URL: &str = "https://example.com/model.obj"; + + mod shape_dispatch { + use super::*; + + #[test] + fn input_mesh_url_builds_the_request() { + let state = build_fal_hunyuan_3d_3p1_smart_topology_state(mesh_builder(GLB_URL)) + .expect("build"); + assert_eq!(state.request.input_file_url, GLB_URL); + assert!(state.request.face_level.is_none()); + } + + #[test] + fn missing_input_mesh_is_rejected() { + let result = build_fal_hunyuan_3d_3p1_smart_topology_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + + #[test] + fn media_token_input_mesh_is_rejected() { + let builder = GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::MediaFileToken(MediaFileToken::new("mf_mesh".to_string()))), + ..base_builder() + }; + assert!(matches!( + build_fal_hunyuan_3d_3p1_smart_topology_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + mod option_mapping { + use super::*; + + #[test] + fn obj_url_infers_obj_input_file_type() { + let state = build_fal_hunyuan_3d_3p1_smart_topology_state(mesh_builder(OBJ_URL)) + .expect("build"); + assert!(matches!( + state.request.input_file_type, + Some(Hunyuan3d3p1SmartTopologyInputFileType::Obj) + )); + } + + #[test] + fn obj_inference_is_case_insensitive_and_ignores_the_query_string() { + let cases = [ + "https://example.com/model.OBJ", + "https://example.com/model.obj?token=abc123", + "https://example.com/model.Obj#fragment", + ]; + for url in cases { + assert!( + matches!(infer_input_file_type(url), Some(Hunyuan3d3p1SmartTopologyInputFileType::Obj)), + "for {url}", + ); + } + } + + #[test] + fn non_obj_urls_leave_input_file_type_unset() { + let cases = [ + GLB_URL, + "https://example.com/model.fbx", + "https://example.com/model.glb?format=obj", + ]; + for url in cases { + assert!(infer_input_file_type(url).is_none(), "for {url}"); + } + } + + #[test] + fn polygon_type_maps_through() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..mesh_builder(GLB_URL) + }; + let state = build_fal_hunyuan_3d_3p1_smart_topology_state(builder).expect("build"); + assert!(matches!( + state.request.polygon_type, + Some(Hunyuan3d3p1SmartTopologyPolygonType::Quadrilateral) + )); + + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Triangle), + ..mesh_builder(GLB_URL) + }; + let state = build_fal_hunyuan_3d_3p1_smart_topology_state(builder).expect("build"); + assert!(matches!( + state.request.polygon_type, + Some(Hunyuan3d3p1SmartTopologyPolygonType::Triangle) + )); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn each_unsupported_option_errors_out_under_error_out() { + let cases: Vec = vec![ + |b| b.prompt = Some("a red ceramic teapot".to_string()), + |b| b.front_image = Some(ImageRef::Url("https://example.com/front.png".to_string())), + |b| b.back_image = Some(ImageRef::Url("https://example.com/back.png".to_string())), + |b| b.mesh_output_type = Some(CommonMeshOutputType::Normal), + |b| b.face_count = Some(100_000), + |b| b.enable_pbr = Some(true), + |b| b.enable_texture = Some(false), + ]; + for (index, set) in cases.into_iter().enumerate() { + let mut builder = GenerateMeshRequestBuilder { + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..mesh_builder(GLB_URL) + }; + set(&mut builder); + assert!(build_fal_hunyuan_3d_3p1_smart_topology_state(builder).is_err(), "for case {index}"); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + mesh_output_type: Some(CommonMeshOutputType::Normal), + face_count: Some(100_000), + enable_pbr: Some(true), + ..mesh_builder(GLB_URL) + }; + let state = build_fal_hunyuan_3d_3p1_smart_topology_state(builder).expect("build"); + assert_eq!(state.request.input_file_url, GLB_URL); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1SmartTopology, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn mesh_builder(url: &str) -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url(url.to_string())), + ..base_builder() + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/cost.rs new file mode 100644 index 00000000..19267e9d --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/cost.rs @@ -0,0 +1,75 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::hunyuan_3d_3p1_smart_topology::request::FalHunyuan3d3p1SmartTopologyRequestState; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1SmartTopologyCostState { + pub cost_in_usd_cents: u64, +} + +impl FalHunyuan3d3p1SmartTopologyCostState { + pub fn from_request(request: &FalHunyuan3d3p1SmartTopologyRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const MESH_URL: &str = "https://example.com/model.glb"; + + mod cost_table { + use super::*; + + #[test] + fn cost_is_a_flat_seventy_five_cents() { + assert_eq!(estimate_usd_cents(mesh_builder()), 75); + } + + #[test] + fn polygon_type_does_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..mesh_builder() + }; + assert_eq!(estimate_usd_cents(builder), 75); + } + } + + // ── Helpers ── + + fn mesh_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1SmartTopology, + provider: RouterProvider::Fal, + input_mesh: Some(MeshRef::Url(MESH_URL.to_string())), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/request.rs new file mode 100644 index 00000000..ee2ed24b --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/hunyuan_3d_3p1_smart_topology/request.rs @@ -0,0 +1,52 @@ +use fal_client::requests::api::mesh::topology::hunyuan_3d_3p1_smart_topology::api::Hunyuan3d3p1SmartTopologyRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalHunyuan3d3p1SmartTopologyRequestState { + /// Final materialized request; ready to fire. + pub request: Hunyuan3d3p1SmartTopologyRequest, +} + +impl FalHunyuan3d3p1SmartTopologyRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key and a real GLB URL, incurs cost + async fn send_smart_topology() { + let client = get_fal_client(); + let builder = GenerateMeshRequestBuilder { + model: RouterMeshModel::Hunyuan3d3p1SmartTopology, + provider: RouterProvider::Fal, + input_mesh: Some(MeshRef::Url("https://example.com/model.glb".to_string())), + ..Default::default() + }; + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/build.rs new file mode 100644 index 00000000..f5ac6a22 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/build.rs @@ -0,0 +1,490 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; +use fal_client::requests::api::mesh::image::meshy_v6_image_to_mesh::api::MeshyV6ImageToMeshRequest; +use fal_client::requests::api::mesh::text::meshy_v6_text_to_mesh::api::{ + MeshyV6ModelType, MeshyV6TextToMeshRequest, MeshyV6Topology, +}; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::meshy_v6::request::{ + FalMeshyV6ImageRequestState, FalMeshyV6TextRequestState, +}; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_face_count, plan_primary_image_url, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// Meshy 6 combines fal's image-to-3d and text-to-3d endpoints under a single +/// router model. The request shape picks the endpoint: any primary image +/// input dispatches to image-to-3d; otherwise a prompt dispatches to +/// text-to-3d. Neither endpoint takes side-view images or an input mesh. +pub fn build_fal_meshy_v6(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_meshy_v6_state(builder)?; + let request = match state { + FalMeshyV6State::Image(state) => MeshGenerationRequest::FalMeshyV6Image(state), + FalMeshyV6State::Text(state) => MeshGenerationRequest::FalMeshyV6Text(state), + }; + Ok(MeshGenerationDraftOrRequest::Request(request)) +} + +/// The endpoint selected by the request shape. +#[derive(Clone, Debug)] +pub(crate) enum FalMeshyV6State { + Image(FalMeshyV6ImageRequestState), + Text(FalMeshyV6TextRequestState), +} + +pub(crate) fn build_fal_meshy_v6_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options neither Meshy 6 endpoint supports. + reject_unsupported_option("texture_quality", builder.texture_quality.as_ref(), strategy)?; + reject_unsupported_option("geometry_quality", builder.geometry_quality.as_ref(), strategy)?; + reject_unsupported_option("input_mesh", builder.input_mesh.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let maybe_image_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )?; + let target_polycount = plan_face_count(builder.face_count, strategy)?; + let topology = builder.polygon_type.map(to_topology); + + match maybe_image_url { + Some(image_url) => { + // Image mode. The image endpoint has no prompt parameter. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + + let request = MeshyV6ImageToMeshRequest { + image_url, + model_type: plan_image_model_type(builder.mesh_output_type), + topology, + target_polycount, + symmetry_mode: None, + should_remesh: None, + should_texture: plan_should_texture(builder.mesh_output_type, builder.enable_texture), + enable_pbr: builder.enable_pbr, + pose_mode: None, + texture_prompt: None, + texture_image_url: None, + enable_rigging: None, + rigging_height_meters: None, + enable_animation: None, + animation_action_id: None, + enable_safety_checker: None, + }; + Ok(FalMeshyV6State::Image(FalMeshyV6ImageRequestState { request })) + } + None => { + // Text mode. The text endpoint always textures, so `enable_texture` + // has no equivalent parameter. + reject_unsupported_option("enable_texture", builder.enable_texture.as_ref(), strategy)?; + + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Meshy 6 requires an input image or a prompt".to_string(), + ) + })?; + + let request = MeshyV6TextToMeshRequest { + prompt, + mode: None, + seed: None, + model_type: plan_text_model_type(builder.mesh_output_type, strategy)?, + topology, + target_polycount, + should_remesh: None, + symmetry_mode: None, + enable_pbr: builder.enable_pbr, + pose_mode: None, + enable_prompt_expansion: None, + texture_prompt: None, + texture_image_url: None, + enable_rigging: None, + rigging_height_meters: None, + enable_animation: None, + animation_action_id: None, + enable_safety_checker: None, + }; + Ok(FalMeshyV6State::Text(FalMeshyV6TextRequestState { request })) + } + } +} + +// ── Option planning helpers ── + +/// Map the output type onto the image endpoint's `model_type`. `Geometry` +/// is expressed via `should_texture` instead, so only `LowPoly` maps here. +fn plan_image_model_type( + mesh_output_type: Option, +) -> Option { + match mesh_output_type { + Some(CommonMeshOutputType::LowPoly) => Some(MeshyV6ModelType::LowPoly), + None | Some(CommonMeshOutputType::Normal) | Some(CommonMeshOutputType::Geometry) => None, + } +} + +/// Map the output type onto the text endpoint's `model_type`. The text +/// endpoint cannot skip texturing, so `Geometry` rejects under `ErrorOut` +/// and is dropped otherwise. +fn plan_text_model_type( + mesh_output_type: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match mesh_output_type { + None | Some(CommonMeshOutputType::Normal) => Ok(None), + Some(CommonMeshOutputType::LowPoly) => Ok(Some(MeshyV6ModelType::LowPoly)), + Some(CommonMeshOutputType::Geometry) => { + reject_unsupported_option( + "mesh_output_type", + Some(&CommonMeshOutputType::Geometry), + strategy, + )?; + Ok(None) + } + } +} + +/// A geometry-only output type or an explicit `enable_texture: false` both +/// map to the image endpoint's `should_texture: false`. +fn plan_should_texture( + mesh_output_type: Option, + enable_texture: Option, +) -> Option { + let skip_texturing = matches!(mesh_output_type, Some(CommonMeshOutputType::Geometry)) + || enable_texture == Some(false); + if skip_texturing { + Some(false) + } else { + None + } +} + +fn to_topology(polygon_type: CommonPolygonType) -> MeshyV6Topology { + match polygon_type { + CommonPolygonType::Quad => MeshyV6Topology::Quad, + CommonPolygonType::Triangle => MeshyV6Topology::Triangle, + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::errors::client_error::ClientError; + + use super::*; + + const FRONT_URL: &str = "https://example.com/front.png"; + const PROMPT: &str = "a red ceramic teapot"; + + mod shape_dispatch { + use super::*; + + #[test] + fn reference_image_dispatches_to_image_mode() { + let state = build_fal_meshy_v6_state(image_builder()).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn front_image_dispatches_to_image_mode() { + let builder = GenerateMeshRequestBuilder { + reference_images: None, + front_image: Some(ImageRef::Url(FRONT_URL.to_string())), + ..base_builder() + }; + let state = build_fal_meshy_v6_state(builder).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn prompt_only_dispatches_to_text_mode() { + let state = build_fal_meshy_v6_state(text_builder()).expect("build"); + let text = expect_text(state); + assert_eq!(text.request.prompt, PROMPT); + } + + #[test] + fn neither_image_nor_prompt_is_rejected() { + let result = build_fal_meshy_v6_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + + #[test] + fn media_tokens_are_rejected() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_meshy_v6_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + mod image_mode { + use super::*; + + #[test] + fn geometry_output_sets_should_texture_false() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..image_builder() + }; + let image = expect_image(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(image.request.should_texture, Some(false)); + assert_eq!(image.request.model_type, None); + } + + #[test] + fn enable_texture_false_sets_should_texture_false() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..image_builder() + }; + let image = expect_image(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(image.request.should_texture, Some(false)); + } + + #[test] + fn should_texture_is_unset_by_default() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(image.request.should_texture, None); + } + + #[test] + fn low_poly_maps_to_model_type() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..image_builder() + }; + let image = expect_image(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(image.request.model_type, Some(MeshyV6ModelType::LowPoly)); + assert_eq!(image.request.should_texture, None); + } + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(image.request.topology, Some(MeshyV6Topology::Quad)); + assert_eq!(image.request.target_polycount, Some(100_000)); + assert_eq!(image.request.enable_pbr, Some(true)); + } + + #[test] + fn prompt_with_image_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some(PROMPT.to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn prompt_with_image_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some(PROMPT.to_string()), + ..image_builder() + }; + assert!(matches!( + build_fal_meshy_v6_state(builder).expect("build"), + FalMeshyV6State::Image(_) + )); + } + } + + mod text_mode { + use super::*; + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + polygon_type: Some(CommonPolygonType::Triangle), + face_count: Some(40_000), + enable_pbr: Some(false), + ..text_builder() + }; + let text = expect_text(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(text.request.model_type, Some(MeshyV6ModelType::LowPoly)); + assert_eq!(text.request.topology, Some(MeshyV6Topology::Triangle)); + assert_eq!(text.request.target_polycount, Some(40_000)); + assert_eq!(text.request.enable_pbr, Some(false)); + } + + #[test] + fn geometry_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..text_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn geometry_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..text_builder() + }; + let text = expect_text(build_fal_meshy_v6_state(builder).expect("build")); + assert_eq!(text.request.model_type, None); + } + + #[test] + fn enable_texture_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..text_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn enable_texture_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..text_builder() + }; + assert!(matches!( + build_fal_meshy_v6_state(builder).expect("build"), + FalMeshyV6State::Text(_) + )); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn texture_quality_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn geometry_quality_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + geometry_quality: Some(CommonMeshQuality::Detailed), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn input_mesh_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url("https://example.com/mesh.glb".to_string())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn side_images_error_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_meshy_v6_state(builder).is_err()); + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Standard), + input_mesh: Some(MeshRef::Url("https://example.com/mesh.glb".to_string())), + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + left_image: Some(ImageRef::Url("https://example.com/left.png".to_string())), + right_image: Some(ImageRef::Url("https://example.com/right.png".to_string())), + ..image_builder() + }; + assert!(matches!( + build_fal_meshy_v6_state(builder).expect("build"), + FalMeshyV6State::Image(_) + )); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some(PROMPT.to_string()), + ..base_builder() + } + } + + fn expect_image(state: FalMeshyV6State) -> FalMeshyV6ImageRequestState { + match state { + FalMeshyV6State::Image(image) => image, + FalMeshyV6State::Text(text) => panic!("expected image mode, got text: {text:?}"), + } + } + + fn expect_text(state: FalMeshyV6State) -> FalMeshyV6TextRequestState { + match state { + FalMeshyV6State::Text(text) => text, + FalMeshyV6State::Image(image) => panic!("expected text mode, got image: {image:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/cost.rs new file mode 100644 index 00000000..e8ba5fa8 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/cost.rs @@ -0,0 +1,112 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::meshy_v6::request::{ + FalMeshyV6ImageRequestState, FalMeshyV6TextRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalMeshyV6ImageCostState { + pub cost_in_usd_cents: u64, +} + +impl FalMeshyV6ImageCostState { + pub fn from_request(request: &FalMeshyV6ImageRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalMeshyV6TextCostState { + pub cost_in_usd_cents: u64, +} + +impl FalMeshyV6TextCostState { + pub fn from_request(request: &FalMeshyV6TextRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const FRONT_URL: &str = "https://example.com/front.png"; + + mod flat_pricing { + use super::*; + + #[test] + fn image_mode_is_eighty_cents() { + assert_eq!(estimate_usd_cents(image_builder()), 80); + } + + #[test] + fn text_mode_is_eighty_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 80); + } + + #[test] + fn options_do_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + enable_pbr: Some(true), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 80); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/request.rs new file mode 100644 index 00000000..cc1b63c7 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/meshy_v6/request.rs @@ -0,0 +1,102 @@ +use fal_client::requests::api::mesh::image::meshy_v6_image_to_mesh::api::MeshyV6ImageToMeshRequest; +use fal_client::requests::api::mesh::text::meshy_v6_text_to_mesh::api::MeshyV6TextToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalMeshyV6ImageRequestState { + /// Final materialized request; ready to fire. + pub request: MeshyV6ImageToMeshRequest, +} + +impl FalMeshyV6ImageRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalMeshyV6TextRequestState { + /// Final materialized request; ready to fire. + pub request: MeshyV6TextToMeshRequest, +} + +impl FalMeshyV6TextRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_meshy_v6_image_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..meshy_v6_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_meshy_v6_text_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + prompt: Some("A velociraptor with an open mouth full of sharp teeth.".to_string()), + ..meshy_v6_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn meshy_v6_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::MeshyV6, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/mod.rs new file mode 100644 index 00000000..b83304d4 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/mod.rs @@ -0,0 +1,12 @@ +pub(crate) mod resolve; +pub mod hunyuan3d_3; +pub mod hunyuan3d_3_sketch; +pub mod hunyuan_3d_2p0; +pub mod hunyuan_3d_2p1; +pub mod hunyuan_3d_3p1_part; +pub mod hunyuan_3d_3p1_pro; +pub mod hunyuan_3d_3p1_rapid; +pub mod hunyuan_3d_3p1_smart_topology; +pub mod meshy_v6; +pub mod rodin_2p5_fast; +pub mod tripo3d_h3p1; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/resolve.rs b/crates/router/src/generate/generate_mesh/providers/fal/resolve.rs new file mode 100644 index 00000000..f23a5d15 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/resolve.rs @@ -0,0 +1,231 @@ +//! Shared plan helpers for the Fal mesh provider. +//! +//! Fal only accepts media URLs — media file tokens are rejected. Callers +//! must resolve tokens to URLs before building for the Fal provider. + +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::mesh_ref::MeshRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +/// Resolve the primary (front) image from `reference_images` and/or +/// `front_image`. More than one candidate rejects under `ErrorOut`; the other +/// strategies keep the first (reference images take precedence over +/// `front_image`). +pub(crate) fn plan_primary_image_url( + reference_images: Option, + front_image: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let mut candidates: Vec = Vec::new(); + + match reference_images { + None => {} + Some(ImageListRef::Urls(urls)) => candidates.extend(urls), + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => {} + Some(ImageListRef::MediaFileTokens(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + Some(ImageListRef::Sources(refs)) => { + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => candidates.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + } + } + + if let Some(front) = front_image { + candidates.push(image_ref_to_url(front)?); + } + + if candidates.len() > 1 { + if let RequestMismatchMitigationStrategy::ErrorOut = strategy { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: format!("Expected at most 1 primary image, got {}", candidates.len()), + })); + } + } + Ok(candidates.into_iter().next()) +} + +/// Resolve an optional side-view image (back/left/right) to a URL. +pub(crate) fn plan_side_image_url( + image_ref: Option, +) -> Result, ArtcraftRouterError> { + image_ref.map(image_ref_to_url).transpose() +} + +/// Resolve an optional input mesh file to a URL. Fal only takes URLs; +/// media file tokens are rejected. +pub(crate) fn plan_input_mesh_url( + mesh_ref: Option, +) -> Result, ArtcraftRouterError> { + match mesh_ref { + None => Ok(None), + Some(MeshRef::Url(url)) => Ok(Some(url)), + Some(MeshRef::MediaFileToken(_) | MeshRef::LocalPath(_) | MeshRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + } +} + +/// Narrow a `u64` face count to the `u32` the fal bindings take. +/// Out-of-range values reject under `ErrorOut` and clamp otherwise. +pub(crate) fn plan_face_count( + face_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let Some(face_count) = face_count else { + return Ok(None); + }; + match u32::try_from(face_count) { + Ok(value) => Ok(Some(value)), + Err(_) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "face_count", + value: format!("{}", face_count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(u32::MAX)), + }, + } +} + +/// Map a mesh output type onto the Hunyuan 2.x endpoints' `textured_mesh` +/// flag. Those endpoints only produce textured or white (geometry-only) +/// meshes: `Normal` (or unset) maps to textured, `Geometry` to white, and +/// `LowPoly` rejects under `ErrorOut` or upgrades to textured otherwise. +pub(crate) fn plan_textured_mesh( + mesh_output_type: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match mesh_output_type { + None | Some(CommonMeshOutputType::Normal) => Ok(Some(true)), + Some(CommonMeshOutputType::Geometry) => Ok(Some(false)), + Some(CommonMeshOutputType::LowPoly) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "mesh_output_type", + value: format!("{:?}", CommonMeshOutputType::LowPoly), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(true)), + }, + } +} + +fn image_ref_to_url(image_ref: ImageRef) -> Result { + match image_ref { + ImageRef::Url(url) => Ok(url), + ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use super::*; + + mod primary_image_tests { + use super::*; + + #[test] + fn none_resolves_to_none() { + let result = plan_primary_image_url(None, None, RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert!(result.is_none()); + } + + #[test] + fn single_reference_url_is_used() { + let refs = Some(ImageListRef::Urls(vec!["https://example.com/a.png".to_string()])); + let result = plan_primary_image_url(refs, None, RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert_eq!(result.as_deref(), Some("https://example.com/a.png")); + } + + #[test] + fn front_image_is_used_when_no_references() { + let front = Some(ImageRef::Url("https://example.com/front.png".to_string())); + let result = plan_primary_image_url(None, front, RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert_eq!(result.as_deref(), Some("https://example.com/front.png")); + } + + #[test] + fn multiple_candidates_error_out() { + let refs = Some(ImageListRef::Urls(vec!["https://example.com/a.png".to_string()])); + let front = Some(ImageRef::Url("https://example.com/front.png".to_string())); + let result = plan_primary_image_url(refs, front, RequestMismatchMitigationStrategy::ErrorOut); + assert!(result.is_err()); + } + + #[test] + fn multiple_candidates_keep_the_first_under_lenient_strategies() { + let refs = Some(ImageListRef::Urls(vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + ])); + let result = plan_primary_image_url(refs, None, RequestMismatchMitigationStrategy::PayMoreUpgrade) + .expect("plan"); + assert_eq!(result.as_deref(), Some("https://example.com/a.png")); + } + + #[test] + fn media_tokens_are_rejected() { + let refs = Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])); + let result = plan_primary_image_url(refs, None, RequestMismatchMitigationStrategy::PayMoreUpgrade); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn empty_token_list_resolves_to_none() { + let refs = Some(ImageListRef::MediaFileTokens(vec![])); + let result = plan_primary_image_url(refs, None, RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert!(result.is_none()); + } + } + + mod face_count_tests { + use super::*; + + #[test] + fn in_range_passes_through() { + let result = plan_face_count(Some(500_000), RequestMismatchMitigationStrategy::ErrorOut) + .expect("plan"); + assert_eq!(result, Some(500_000)); + } + + #[test] + fn overflow_errors_out() { + let result = plan_face_count(Some(u64::MAX), RequestMismatchMitigationStrategy::ErrorOut); + assert!(result.is_err()); + } + + #[test] + fn overflow_clamps_under_lenient_strategies() { + let result = plan_face_count(Some(u64::MAX), RequestMismatchMitigationStrategy::PayLessDowngrade) + .expect("plan"); + assert_eq!(result, Some(u32::MAX)); + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/build.rs new file mode 100644 index 00000000..9c898331 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/build.rs @@ -0,0 +1,522 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use fal_client::requests::api::mesh::image::rodin_2p5_fast_image_to_mesh::api::Rodin2p5FastImageToMeshRequest; +use fal_client::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::api::{ + Rodin2p5FastMaterial, Rodin2p5FastTextToMeshRequest, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::rodin_2p5_fast::request::{ + FalRodin2p5FastImageRequestState, FalRodin2p5FastTextRequestState, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::{ + reject_unsupported_image_ref, reject_unsupported_option, +}; + +/// The image endpoint accepts at most this many input images. +const MAX_INPUT_IMAGES: usize = 5; + +/// Hyper3D Rodin v2.5 Fast combines fal's image-to-3d and text-to-3d +/// endpoints under a single router model. Any image input dispatches to +/// image-to-3d (which takes up to five views of the object, plus an optional +/// guidance prompt); otherwise a prompt dispatches to text-to-3d. +pub fn build_fal_rodin_2p5_fast(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_rodin_2p5_fast_state(builder)?; + let request = match state { + FalRodin2p5FastState::Image(state) => MeshGenerationRequest::FalRodin2p5FastImage(state), + FalRodin2p5FastState::Text(state) => MeshGenerationRequest::FalRodin2p5FastText(state), + }; + Ok(MeshGenerationDraftOrRequest::Request(request)) +} + +/// The endpoint selected by the request shape. +#[derive(Clone, Debug)] +pub(crate) enum FalRodin2p5FastState { + Image(FalRodin2p5FastImageRequestState), + Text(FalRodin2p5FastTextRequestState), +} + +pub(crate) fn build_fal_rodin_2p5_fast_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Options neither Rodin v2.5 Fast endpoint supports. + reject_unsupported_option("polygon_type", builder.polygon_type.as_ref(), strategy)?; + reject_unsupported_option("face_count", builder.face_count.as_ref(), strategy)?; + reject_unsupported_option("texture_quality", builder.texture_quality.as_ref(), strategy)?; + reject_unsupported_option("geometry_quality", builder.geometry_quality.as_ref(), strategy)?; + reject_unsupported_option("input_mesh", builder.input_mesh.as_ref(), strategy)?; + reject_unsupported_image_ref("back_image", builder.back_image.as_ref(), strategy)?; + reject_unsupported_image_ref("left_image", builder.left_image.as_ref(), strategy)?; + reject_unsupported_image_ref("right_image", builder.right_image.as_ref(), strategy)?; + + let material = plan_material( + builder.mesh_output_type, + builder.enable_pbr, + builder.enable_texture, + strategy, + )?; + let image_urls = plan_image_urls( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )?; + + if image_urls.is_empty() { + // Text mode. + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Rodin v2.5 Fast requires an input image or a prompt".to_string(), + ) + })?; + + let request = Rodin2p5FastTextToMeshRequest { + prompt, + tier: None, + seed: None, + geometry_file_format: None, + material, + quality_mesh_option: None, + texture_mode: None, + enable_creative_mode: None, + hd_texture: None, + texture_delight: None, + is_micro: None, + ta_pose: None, + bbox_condition: None, + }; + Ok(FalRodin2p5FastState::Text(FalRodin2p5FastTextRequestState { request })) + } else { + // Image mode. The prompt is optional guidance here. + let request = Rodin2p5FastImageToMeshRequest { + image_urls, + prompt: builder.prompt.take(), + use_original_alpha: None, + tier: None, + seed: None, + geometry_file_format: None, + material, + quality_mesh_option: None, + texture_mode: None, + enable_creative_mode: None, + hd_texture: None, + texture_delight: None, + is_micro: None, + ta_pose: None, + bbox_condition: None, + preview_render: None, + }; + Ok(FalRodin2p5FastState::Image(FalRodin2p5FastImageRequestState { request })) + } +} + +// ── Option planning helpers ── + +/// Collect every input image URL: all `reference_images` URLs plus the +/// `front_image` if set. More than [`MAX_INPUT_IMAGES`] rejects under +/// `ErrorOut`; the lenient strategies keep the first five. Fal only takes +/// URLs, so media file tokens are rejected. +fn plan_image_urls( + reference_images: Option, + front_image: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let mut urls: Vec = Vec::new(); + + match reference_images { + None => {} + Some(ImageListRef::Urls(reference_urls)) => urls.extend(reference_urls), + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => {} + Some(ImageListRef::MediaFileTokens(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + Some(ImageListRef::Sources(refs)) => { + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + } + } + + match front_image { + None => {} + Some(ImageRef::Url(url)) => urls.push(url), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + } + + if urls.len() > MAX_INPUT_IMAGES { + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: format!("Expected at most {MAX_INPUT_IMAGES} images, got {}", urls.len()), + })); + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + urls.truncate(MAX_INPUT_IMAGES); + } + } + } + Ok(urls) +} + +/// Map the builder's texturing options onto Rodin's `material` parameter. +/// PBR wins when requested; otherwise a geometry-only output type or an +/// explicit `enable_texture: false` map to no material. Rodin has no +/// low-poly mode, so `LowPoly` rejects under `ErrorOut` and is dropped +/// otherwise. +fn plan_material( + mesh_output_type: Option, + enable_pbr: Option, + enable_texture: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + if matches!(mesh_output_type, Some(CommonMeshOutputType::LowPoly)) { + reject_unsupported_option( + "mesh_output_type", + Some(&CommonMeshOutputType::LowPoly), + strategy, + )?; + } + if enable_pbr == Some(true) { + return Ok(Some(Rodin2p5FastMaterial::Pbr)); + } + let skip_texturing = matches!(mesh_output_type, Some(CommonMeshOutputType::Geometry)) + || enable_texture == Some(false); + if skip_texturing { + return Ok(Some(Rodin2p5FastMaterial::NoMaterial)); + } + Ok(None) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + const FRONT_URL: &str = "https://example.com/front.png"; + const SECOND_URL: &str = "https://example.com/second.png"; + const PROMPT: &str = "a red ceramic teapot"; + + mod shape_dispatch { + use super::*; + + #[test] + fn reference_image_dispatches_to_image_mode() { + let state = build_fal_rodin_2p5_fast_state(image_builder()).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_urls, vec![FRONT_URL.to_string()]); + } + + #[test] + fn front_image_dispatches_to_image_mode() { + let builder = GenerateMeshRequestBuilder { + reference_images: None, + front_image: Some(ImageRef::Url(FRONT_URL.to_string())), + ..base_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.image_urls, vec![FRONT_URL.to_string()]); + } + + #[test] + fn prompt_only_dispatches_to_text_mode() { + let state = build_fal_rodin_2p5_fast_state(text_builder()).expect("build"); + let text = expect_text(state); + assert_eq!(text.request.prompt, PROMPT); + } + + #[test] + fn neither_image_nor_prompt_is_rejected() { + let result = build_fal_rodin_2p5_fast_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + } + + mod image_mode { + use super::*; + + #[test] + fn multiple_reference_urls_collect_into_image_urls() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + FRONT_URL.to_string(), + SECOND_URL.to_string(), + ])), + front_image: Some(ImageRef::Url("https://example.com/third.png".to_string())), + ..base_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.image_urls, vec![ + FRONT_URL.to_string(), + SECOND_URL.to_string(), + "https://example.com/third.png".to_string(), + ]); + } + + #[test] + fn more_than_five_images_error_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(six_urls())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(matches!( + build_fal_rodin_2p5_fast_state(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn more_than_five_images_truncate_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(six_urls())), + ..base_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.image_urls.len(), 5); + assert_eq!(image.request.image_urls, &six_urls()[..5]); + } + + #[test] + fn prompt_is_forwarded_as_guidance() { + let builder = GenerateMeshRequestBuilder { + prompt: Some(PROMPT.to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.prompt.as_deref(), Some(PROMPT)); + } + + #[test] + fn reference_media_tokens_are_rejected() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_rodin_2p5_fast_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn front_image_media_token_is_rejected() { + let builder = GenerateMeshRequestBuilder { + front_image: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_front".to_string()))), + ..base_builder() + }; + assert!(matches!( + build_fal_rodin_2p5_fast_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + mod material_mapping { + use super::*; + + #[test] + fn pbr_maps_to_pbr_material() { + let builder = GenerateMeshRequestBuilder { + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.material, Some(Rodin2p5FastMaterial::Pbr)); + } + + #[test] + fn geometry_maps_to_no_material() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..image_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.material, Some(Rodin2p5FastMaterial::NoMaterial)); + } + + #[test] + fn enable_texture_false_maps_to_no_material() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..text_builder() + }; + let text = expect_text(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(text.request.material, Some(Rodin2p5FastMaterial::NoMaterial)); + } + + #[test] + fn pbr_takes_precedence_over_geometry() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.material, Some(Rodin2p5FastMaterial::Pbr)); + } + + #[test] + fn material_is_unset_by_default() { + let image = expect_image(build_fal_rodin_2p5_fast_state(image_builder()).expect("build")); + assert_eq!(image.request.material, None); + } + + #[test] + fn low_poly_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_rodin_2p5_fast_state(builder).is_err()); + } + + #[test] + fn low_poly_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..image_builder() + }; + let image = expect_image(build_fal_rodin_2p5_fast_state(builder).expect("build")); + assert_eq!(image.request.material, None); + } + } + + mod unsupported_options { + use super::*; + + #[test] + fn unsupported_options_error_out_under_error_out() { + let cases: Vec<(&str, GenerateMeshRequestBuilder)> = vec![ + ("polygon_type", GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + ..error_out_image_builder() + }), + ("face_count", GenerateMeshRequestBuilder { + face_count: Some(100_000), + ..error_out_image_builder() + }), + ("texture_quality", GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..error_out_image_builder() + }), + ("geometry_quality", GenerateMeshRequestBuilder { + geometry_quality: Some(CommonMeshQuality::Detailed), + ..error_out_image_builder() + }), + ("input_mesh", GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url("https://example.com/mesh.glb".to_string())), + ..error_out_image_builder() + }), + ("back_image", GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..error_out_image_builder() + }), + ("left_image", GenerateMeshRequestBuilder { + left_image: Some(ImageRef::Url("https://example.com/left.png".to_string())), + ..error_out_image_builder() + }), + ("right_image", GenerateMeshRequestBuilder { + right_image: Some(ImageRef::Url("https://example.com/right.png".to_string())), + ..error_out_image_builder() + }), + ]; + for (field, builder) in cases { + assert!( + build_fal_rodin_2p5_fast_state(builder).is_err(), + "expected error for {field}", + ); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Quad), + face_count: Some(100_000), + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Standard), + input_mesh: Some(MeshRef::Url("https://example.com/mesh.glb".to_string())), + back_image: Some(ImageRef::Url("https://example.com/back.png".to_string())), + ..image_builder() + }; + assert!(matches!( + build_fal_rodin_2p5_fast_state(builder).expect("build"), + FalRodin2p5FastState::Image(_) + )); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn error_out_image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some(PROMPT.to_string()), + ..base_builder() + } + } + + fn six_urls() -> Vec { + (1..=6).map(|i| format!("https://example.com/view-{i}.png")).collect() + } + + fn expect_image(state: FalRodin2p5FastState) -> FalRodin2p5FastImageRequestState { + match state { + FalRodin2p5FastState::Image(image) => image, + FalRodin2p5FastState::Text(text) => panic!("expected image mode, got text: {text:?}"), + } + } + + fn expect_text(state: FalRodin2p5FastState) -> FalRodin2p5FastTextRequestState { + match state { + FalRodin2p5FastState::Text(text) => text, + FalRodin2p5FastState::Image(image) => panic!("expected text mode, got image: {image:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/cost.rs new file mode 100644 index 00000000..870ade04 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/cost.rs @@ -0,0 +1,109 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::rodin_2p5_fast::request::{ + FalRodin2p5FastImageRequestState, FalRodin2p5FastTextRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalRodin2p5FastImageCostState { + pub cost_in_usd_cents: u64, +} + +impl FalRodin2p5FastImageCostState { + pub fn from_request(request: &FalRodin2p5FastImageRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalRodin2p5FastTextCostState { + pub cost_in_usd_cents: u64, +} + +impl FalRodin2p5FastTextCostState { + pub fn from_request(request: &FalRodin2p5FastTextRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const FRONT_URL: &str = "https://example.com/front.png"; + + mod flat_pricing { + use super::*; + + #[test] + fn image_mode_is_ten_cents() { + assert_eq!(estimate_usd_cents(image_builder()), 10); + } + + #[test] + fn text_mode_is_ten_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 10); + } + + #[test] + fn options_do_not_change_the_price() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + enable_pbr: Some(true), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 10); + } + } + + // ── Helpers ── + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Fal, + prompt: Some("a red ceramic teapot".to_string()), + ..Default::default() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/request.rs new file mode 100644 index 00000000..db40ce98 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/rodin_2p5_fast/request.rs @@ -0,0 +1,102 @@ +use fal_client::requests::api::mesh::image::rodin_2p5_fast_image_to_mesh::api::Rodin2p5FastImageToMeshRequest; +use fal_client::requests::api::mesh::text::rodin_2p5_fast_text_to_mesh::api::Rodin2p5FastTextToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalRodin2p5FastImageRequestState { + /// Final materialized request; ready to fire. + pub request: Rodin2p5FastImageToMeshRequest, +} + +impl FalRodin2p5FastImageRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalRodin2p5FastTextRequestState { + /// Final materialized request; ready to fire. + pub request: Rodin2p5FastTextToMeshRequest, +} + +impl FalRodin2p5FastTextRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_rodin_2p5_fast_image_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..rodin_2p5_fast_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_rodin_2p5_fast_text_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + prompt: Some("A velociraptor with an open mouth full of sharp teeth.".to_string()), + ..rodin_2p5_fast_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn rodin_2p5_fast_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Rodin2p5Fast, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/build.rs b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/build.rs new file mode 100644 index 00000000..19589629 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/build.rs @@ -0,0 +1,629 @@ +use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; +use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; +use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; +use fal_client::requests::api::mesh::image::tripo3d_h3p1_image_to_mesh::api::{ + Tripo3dH3p1ImageGeometryQuality, Tripo3dH3p1ImageTextureQuality, Tripo3dH3p1ImageToMeshRequest, +}; +use fal_client::requests::api::mesh::multiview::tripo3d_h3p1_multiview_to_mesh::api::Tripo3dH3p1MultiviewToMeshRequest; +use fal_client::requests::api::mesh::text::tripo3d_h3p1_text_to_mesh::api::{ + Tripo3dH3p1GeometryQuality, Tripo3dH3p1TextToMeshRequest, Tripo3dH3p1TextureQuality, +}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; +use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; +use crate::generate::generate_mesh::mesh_generation_request::MeshGenerationRequest; +use crate::generate::generate_mesh::providers::fal::resolve::{ + plan_face_count, plan_primary_image_url, plan_side_image_url, +}; +use crate::generate::generate_mesh::providers::fal::tripo3d_h3p1::request::{ + FalTripo3dH3p1ImageRequestState, FalTripo3dH3p1MultiviewRequestState, + FalTripo3dH3p1TextRequestState, +}; +use crate::generate::generate_mesh::providers::reject_unsupported::reject_unsupported_option; + +/// Tripo3D H3.1 combines fal's text-to-3d, image-to-3d, and multiview-to-3d +/// endpoints under a single router model. The request shape picks the +/// endpoint: any side-view image (back/left/right) dispatches to +/// multiview-to-3d (which also requires a front image); otherwise a primary +/// image dispatches to image-to-3d; otherwise a prompt dispatches to +/// text-to-3d. +pub fn build_fal_tripo3d_h3p1(builder: GenerateMeshRequestBuilder) -> Result { + let state = build_fal_tripo3d_h3p1_state(builder)?; + let request = match state { + FalTripo3dH3p1State::Multiview(state) => MeshGenerationRequest::FalTripo3dH3p1Multiview(state), + FalTripo3dH3p1State::Image(state) => MeshGenerationRequest::FalTripo3dH3p1Image(state), + FalTripo3dH3p1State::Text(state) => MeshGenerationRequest::FalTripo3dH3p1Text(state), + }; + Ok(MeshGenerationDraftOrRequest::Request(request)) +} + +/// The endpoint selected by the request shape. +#[derive(Clone, Debug)] +pub(crate) enum FalTripo3dH3p1State { + Multiview(FalTripo3dH3p1MultiviewRequestState), + Image(FalTripo3dH3p1ImageRequestState), + Text(FalTripo3dH3p1TextRequestState), +} + +pub(crate) fn build_fal_tripo3d_h3p1_state( + mut builder: GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // No Tripo3D endpoint takes a mesh input. + reject_unsupported_option("input_mesh", builder.input_mesh.as_ref(), strategy)?; + + let maybe_front_url = plan_primary_image_url( + builder.reference_images.take(), + builder.front_image.take(), + strategy, + )?; + let maybe_left_url = plan_side_image_url(builder.left_image.take())?; + let maybe_back_url = plan_side_image_url(builder.back_image.take())?; + let maybe_right_url = plan_side_image_url(builder.right_image.take())?; + + let options = plan_tripo3d_options(&mut builder)?; + + let has_side_view = maybe_left_url.is_some() + || maybe_back_url.is_some() + || maybe_right_url.is_some(); + + if has_side_view { + // Multiview mode. The endpoint reconstructs from 2-4 views, and the + // front view anchors the set, so it's required. + let front_url = maybe_front_url.ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Tripo3D multi-view input requires a front/reference image".to_string(), + ) + })?; + // The multiview endpoint has no prompt parameter. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + + // fal's canonical view order is [front, left, back, right]; absent views + // are simply omitted. + let mut image_urls = vec![front_url]; + image_urls.extend(maybe_left_url); + image_urls.extend(maybe_back_url); + image_urls.extend(maybe_right_url); + + let request = Tripo3dH3p1MultiviewToMeshRequest { + image_urls, + face_limit: options.face_limit, + texture: options.texture, + pbr: options.pbr, + model_seed: None, + texture_seed: None, + texture_quality: options.texture_quality.map(to_image_texture_quality), + geometry_quality: options.geometry_quality.map(to_image_geometry_quality), + texture_alignment: None, + auto_size: None, + orientation: None, + quad: options.quad, + }; + Ok(FalTripo3dH3p1State::Multiview(FalTripo3dH3p1MultiviewRequestState { request })) + } else if let Some(image_url) = maybe_front_url { + // Image mode. The image endpoint has no prompt parameter. + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + + let request = Tripo3dH3p1ImageToMeshRequest { + image_url, + face_limit: options.face_limit, + texture: options.texture, + pbr: options.pbr, + model_seed: None, + texture_seed: None, + texture_quality: options.texture_quality.map(to_image_texture_quality), + geometry_quality: options.geometry_quality.map(to_image_geometry_quality), + texture_alignment: None, + auto_size: None, + orientation: None, + quad: options.quad, + }; + Ok(FalTripo3dH3p1State::Image(FalTripo3dH3p1ImageRequestState { request })) + } else { + // Text mode. + let prompt = builder.prompt.take().ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "Tripo3D H3.1 requires an input image or a prompt".to_string(), + ) + })?; + + let request = Tripo3dH3p1TextToMeshRequest { + prompt, + negative_prompt: None, + face_limit: options.face_limit, + texture: options.texture, + pbr: options.pbr, + model_seed: None, + image_seed: None, + texture_seed: None, + texture_quality: options.texture_quality.map(to_text_texture_quality), + geometry_quality: options.geometry_quality.map(to_text_geometry_quality), + auto_size: None, + quad: options.quad, + }; + Ok(FalTripo3dH3p1State::Text(FalTripo3dH3p1TextRequestState { request })) + } +} + +/// Options shared by all three Tripo3D H3.1 endpoints, resolved from the +/// builder once and mapped onto each endpoint's field types per-mode. +struct Tripo3dH3p1Options { + face_limit: Option, + texture: Option, + pbr: Option, + texture_quality: Option, + geometry_quality: Option, + quad: Option, +} + +fn plan_tripo3d_options( + builder: &mut GenerateMeshRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Tripo3D has no low-poly output mode; `Normal` and `Geometry` map onto the + // texture flags below. + if matches!(builder.mesh_output_type, Some(CommonMeshOutputType::LowPoly)) { + reject_unsupported_option("mesh_output_type", builder.mesh_output_type.as_ref(), strategy)?; + } + + // A geometry-only output (or explicitly disabled texturing) maps to the + // untextured tier — unless PBR is explicitly requested, since PBR implies + // texturing. Both flags default to true on fal's side and either one alone + // re-enables texturing, so both must be explicitly disabled together to + // reach the untextured billing tier. + let wants_untextured = matches!(builder.mesh_output_type, Some(CommonMeshOutputType::Geometry)) + || builder.enable_texture == Some(false); + let texture_off = wants_untextured && builder.enable_pbr != Some(true); + let (texture, pbr) = if texture_off { + (Some(false), Some(false)) + } else { + (builder.enable_texture, builder.enable_pbr) + }; + + let quad = builder.polygon_type.take().map(|polygon_type| match polygon_type { + CommonPolygonType::Quad => true, + CommonPolygonType::Triangle => false, + }); + + Ok(Tripo3dH3p1Options { + face_limit: plan_face_count(builder.face_count, strategy)?, + texture, + pbr, + texture_quality: builder.texture_quality.take(), + geometry_quality: builder.geometry_quality.take(), + quad, + }) +} + +// ── Enum mapping helpers ── + +fn to_text_texture_quality(quality: CommonMeshQuality) -> Tripo3dH3p1TextureQuality { + match quality { + CommonMeshQuality::Standard => Tripo3dH3p1TextureQuality::Standard, + CommonMeshQuality::Detailed => Tripo3dH3p1TextureQuality::Detailed, + } +} + +fn to_text_geometry_quality(quality: CommonMeshQuality) -> Tripo3dH3p1GeometryQuality { + match quality { + CommonMeshQuality::Standard => Tripo3dH3p1GeometryQuality::Standard, + CommonMeshQuality::Detailed => Tripo3dH3p1GeometryQuality::Detailed, + } +} + +fn to_image_texture_quality(quality: CommonMeshQuality) -> Tripo3dH3p1ImageTextureQuality { + match quality { + CommonMeshQuality::Standard => Tripo3dH3p1ImageTextureQuality::Standard, + CommonMeshQuality::Detailed => Tripo3dH3p1ImageTextureQuality::Detailed, + } +} + +fn to_image_geometry_quality(quality: CommonMeshQuality) -> Tripo3dH3p1ImageGeometryQuality { + match quality { + CommonMeshQuality::Standard => Tripo3dH3p1ImageGeometryQuality::Standard, + CommonMeshQuality::Detailed => Tripo3dH3p1ImageGeometryQuality::Detailed, + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::mesh_ref::MeshRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::errors::client_error::ClientError; + + use super::*; + + const FRONT_URL: &str = "https://example.com/front.png"; + const LEFT_URL: &str = "https://example.com/left.png"; + const BACK_URL: &str = "https://example.com/back.png"; + const RIGHT_URL: &str = "https://example.com/right.png"; + + mod shape_dispatch { + use super::*; + + #[test] + fn reference_image_dispatches_to_image_mode() { + let state = build_fal_tripo3d_h3p1_state(image_builder()).expect("build"); + let image = expect_image(state); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn front_image_dispatches_to_image_mode() { + let builder = GenerateMeshRequestBuilder { + reference_images: None, + front_image: Some(ImageRef::Url(FRONT_URL.to_string())), + ..base_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(image.request.image_url, FRONT_URL); + } + + #[test] + fn prompt_only_dispatches_to_text_mode() { + let state = build_fal_tripo3d_h3p1_state(text_builder()).expect("build"); + let text = expect_text(state); + assert_eq!(text.request.prompt, "a red ceramic teapot"); + } + + #[test] + fn side_image_dispatches_to_multiview_mode() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + ..image_builder() + }; + let multiview = expect_multiview(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(multiview.request.image_urls, vec![FRONT_URL, BACK_URL]); + } + + #[test] + fn side_images_without_front_are_rejected() { + // A hard error even under the (default) lenient strategy: the endpoint + // cannot anchor the view set without a front image. + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + ..base_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder), + Err(ArtcraftRouterError::InvalidInput(_)) + )); + } + + #[test] + fn neither_image_nor_prompt_is_rejected() { + let result = build_fal_tripo3d_h3p1_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + } + + mod multiview_mode { + use super::*; + + #[test] + fn urls_follow_canonical_view_order() { + let builder = GenerateMeshRequestBuilder { + left_image: Some(ImageRef::Url(LEFT_URL.to_string())), + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + right_image: Some(ImageRef::Url(RIGHT_URL.to_string())), + ..image_builder() + }; + let multiview = expect_multiview(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!( + multiview.request.image_urls, + vec![FRONT_URL, LEFT_URL, BACK_URL, RIGHT_URL], + ); + } + + #[test] + fn missing_views_are_omitted() { + let builder = GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + right_image: Some(ImageRef::Url(RIGHT_URL.to_string())), + ..image_builder() + }; + let multiview = expect_multiview(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(multiview.request.image_urls, vec![FRONT_URL, BACK_URL, RIGHT_URL]); + } + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(100_000), + polygon_type: Some(CommonPolygonType::Quad), + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + ..multiview_builder() + }; + let multiview = expect_multiview(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(multiview.request.face_limit, Some(100_000)); + assert_eq!(multiview.request.quad, Some(true)); + assert_eq!(multiview.request.texture_quality, Some(Tripo3dH3p1ImageTextureQuality::Detailed)); + assert_eq!(multiview.request.geometry_quality, Some(Tripo3dH3p1ImageGeometryQuality::Detailed)); + } + + #[test] + fn prompt_with_multiview_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..multiview_builder() + }; + assert!(build_fal_tripo3d_h3p1_state(builder).is_err()); + } + + #[test] + fn prompt_with_multiview_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..multiview_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder).expect("build"), + FalTripo3dH3p1State::Multiview(_) + )); + } + } + + mod image_mode { + use super::*; + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(50_000), + polygon_type: Some(CommonPolygonType::Quad), + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Standard), + ..image_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(image.request.face_limit, Some(50_000)); + assert_eq!(image.request.quad, Some(true)); + assert_eq!(image.request.texture_quality, Some(Tripo3dH3p1ImageTextureQuality::Detailed)); + assert_eq!(image.request.geometry_quality, Some(Tripo3dH3p1ImageGeometryQuality::Standard)); + } + + #[test] + fn prompt_with_image_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_tripo3d_h3p1_state(builder).is_err()); + } + + #[test] + fn prompt_with_image_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..image_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder).expect("build"), + FalTripo3dH3p1State::Image(_) + )); + } + + #[test] + fn media_tokens_are_rejected() { + let builder = GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + } + + mod text_mode { + use super::*; + + #[test] + fn options_map_through() { + let builder = GenerateMeshRequestBuilder { + face_count: Some(40_000), + polygon_type: Some(CommonPolygonType::Triangle), + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + ..text_builder() + }; + let text = expect_text(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(text.request.face_limit, Some(40_000)); + assert_eq!(text.request.quad, Some(false)); + assert_eq!(text.request.texture_quality, Some(Tripo3dH3p1TextureQuality::Detailed)); + assert_eq!(text.request.geometry_quality, Some(Tripo3dH3p1GeometryQuality::Detailed)); + } + } + + mod option_mapping { + use super::*; + + #[test] + fn geometry_output_disables_texture_and_pbr() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..image_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(image.request.texture, Some(false)); + assert_eq!(image.request.pbr, Some(false)); + } + + #[test] + fn enable_texture_false_disables_texture_and_pbr() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..text_builder() + }; + let text = expect_text(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(text.request.texture, Some(false)); + assert_eq!(text.request.pbr, Some(false)); + } + + #[test] + fn enable_texture_false_with_pbr_true_keeps_textures() { + // PBR implies texturing, so an explicit PBR request wins. + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(image.request.texture, Some(false)); + assert_eq!(image.request.pbr, Some(true)); + } + + #[test] + fn texture_flags_pass_through_by_default() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(true), + enable_pbr: Some(true), + ..image_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(image.request.texture, Some(true)); + assert_eq!(image.request.pbr, Some(true)); + } + + #[test] + fn unset_texture_flags_stay_unset() { + let image = expect_image(build_fal_tripo3d_h3p1_state(image_builder()).expect("build")); + assert_eq!(image.request.texture, None); + assert_eq!(image.request.pbr, None); + } + + #[test] + fn polygon_type_maps_to_quad_flag() { + let cases = [ + (Some(CommonPolygonType::Quad), Some(true)), + (Some(CommonPolygonType::Triangle), Some(false)), + (None, None), + ]; + for (polygon_type, expected) in cases { + let builder = GenerateMeshRequestBuilder { + polygon_type, + ..image_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + assert_eq!(image.request.quad, expected, "for {polygon_type:?}"); + } + } + + #[test] + fn low_poly_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn low_poly_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::LowPoly), + ..image_builder() + }; + let image = expect_image(build_fal_tripo3d_h3p1_state(builder).expect("build")); + // Dropped: LowPoly doesn't force the untextured flags either. + assert_eq!(image.request.texture, None); + assert_eq!(image.request.pbr, None); + } + + #[test] + fn input_mesh_errors_out_under_error_out() { + let builder = GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url("https://example.com/mesh.glb".to_string())), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { .. })) + )); + } + + #[test] + fn input_mesh_is_dropped_under_lenient_strategies() { + let builder = GenerateMeshRequestBuilder { + input_mesh: Some(MeshRef::Url("https://example.com/mesh.glb".to_string())), + ..image_builder() + }; + assert!(matches!( + build_fal_tripo3d_h3p1_state(builder).expect("build"), + FalTripo3dH3p1State::Image(_) + )); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Tripo3dH3p1, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn multiview_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + left_image: Some(ImageRef::Url(LEFT_URL.to_string())), + ..image_builder() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..base_builder() + } + } + + fn expect_multiview(state: FalTripo3dH3p1State) -> FalTripo3dH3p1MultiviewRequestState { + match state { + FalTripo3dH3p1State::Multiview(multiview) => multiview, + other => panic!("expected multiview mode, got: {other:?}"), + } + } + + fn expect_image(state: FalTripo3dH3p1State) -> FalTripo3dH3p1ImageRequestState { + match state { + FalTripo3dH3p1State::Image(image) => image, + other => panic!("expected image mode, got: {other:?}"), + } + } + + fn expect_text(state: FalTripo3dH3p1State) -> FalTripo3dH3p1TextRequestState { + match state { + FalTripo3dH3p1State::Text(text) => text, + other => panic!("expected text mode, got: {other:?}"), + } + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/cost.rs b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/cost.rs new file mode 100644 index 00000000..856970d9 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/cost.rs @@ -0,0 +1,263 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_mesh::mesh_generation_cost_estimate::MeshGenerationCostEstimate; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::cost::fal_mesh_cost_estimate; +use crate::generate::generate_mesh::providers::fal::tripo3d_h3p1::request::{ + FalTripo3dH3p1ImageRequestState, FalTripo3dH3p1MultiviewRequestState, + FalTripo3dH3p1TextRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalTripo3dH3p1TextCostState { + pub cost_in_usd_cents: u64, +} + +impl FalTripo3dH3p1TextCostState { + pub fn from_request(request: &FalTripo3dH3p1TextRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalTripo3dH3p1ImageCostState { + pub cost_in_usd_cents: u64, +} + +impl FalTripo3dH3p1ImageCostState { + pub fn from_request(request: &FalTripo3dH3p1ImageRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[derive(Clone, Debug)] +pub struct FalTripo3dH3p1MultiviewCostState { + pub cost_in_usd_cents: u64, +} + +impl FalTripo3dH3p1MultiviewCostState { + pub fn from_request(request: &FalTripo3dH3p1MultiviewRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> MeshGenerationCostEstimate { + fal_mesh_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_mesh_output_type::CommonMeshOutputType; + use artcraft_client::enums::common::generation::common_mesh_quality::CommonMeshQuality; + use artcraft_client::enums::common::generation::common_polygon_type::CommonPolygonType; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + + const FRONT_URL: &str = "https://example.com/front.png"; + const BACK_URL: &str = "https://example.com/back.png"; + + mod text_mode_costs { + use super::*; + + #[test] + fn default_is_standard_textures() { + assert_eq!(estimate_usd_cents(text_builder()), 20); + } + + #[test] + fn untextured_via_enable_texture_off() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 10); + } + + #[test] + fn untextured_via_geometry_output() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 10); + } + + #[test] + fn texture_off_with_pbr_keeps_textured_tier() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + enable_pbr: Some(true), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 20); + } + + #[test] + fn detailed_texture() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..text_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30); + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + polygon_type: Some(CommonPolygonType::Quad), + ..text_builder() + }; + // Detailed texture(30) + detailed geometry(20) + quad(5) + assert_eq!(estimate_usd_cents(builder), 55); + } + } + + mod image_mode_costs { + use super::*; + + #[test] + fn default_is_standard_textures() { + assert_eq!(estimate_usd_cents(image_builder()), 30); + } + + #[test] + fn untextured_via_enable_texture_off() { + let builder = GenerateMeshRequestBuilder { + enable_texture: Some(false), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 20); + } + + #[test] + fn detailed_texture() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..image_builder() + }; + assert_eq!(estimate_usd_cents(builder), 40); + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + polygon_type: Some(CommonPolygonType::Quad), + ..image_builder() + }; + // Detailed texture(40) + detailed geometry(20) + quad(5) + assert_eq!(estimate_usd_cents(builder), 65); + } + } + + mod multiview_mode_costs { + use super::*; + + #[test] + fn default_is_standard_textures() { + assert_eq!(estimate_usd_cents(multiview_builder()), 20); + } + + #[test] + fn untextured_via_geometry_output() { + let builder = GenerateMeshRequestBuilder { + mesh_output_type: Some(CommonMeshOutputType::Geometry), + ..multiview_builder() + }; + assert_eq!(estimate_usd_cents(builder), 10); + } + + #[test] + fn detailed_texture() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + ..multiview_builder() + }; + assert_eq!(estimate_usd_cents(builder), 30); + } + + #[test] + fn triangle_polygon_adds_nothing() { + let builder = GenerateMeshRequestBuilder { + polygon_type: Some(CommonPolygonType::Triangle), + ..multiview_builder() + }; + assert_eq!(estimate_usd_cents(builder), 20); + } + + #[test] + fn add_ons_stack() { + let builder = GenerateMeshRequestBuilder { + texture_quality: Some(CommonMeshQuality::Detailed), + geometry_quality: Some(CommonMeshQuality::Detailed), + polygon_type: Some(CommonPolygonType::Quad), + ..multiview_builder() + }; + // Detailed texture(30) + detailed geometry(20) + quad(5) + assert_eq!(estimate_usd_cents(builder), 55); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Tripo3dH3p1, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn text_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + prompt: Some("a red ceramic teapot".to_string()), + ..base_builder() + } + } + + fn image_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![FRONT_URL.to_string()])), + ..base_builder() + } + } + + fn multiview_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + back_image: Some(ImageRef::Url(BACK_URL.to_string())), + ..image_builder() + } + } + + fn estimate_usd_cents(builder: GenerateMeshRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/mod.rs b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/request.rs b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/request.rs new file mode 100644 index 00000000..fa37943a --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/fal/tripo3d_h3p1/request.rs @@ -0,0 +1,129 @@ +use fal_client::requests::api::mesh::image::tripo3d_h3p1_image_to_mesh::api::Tripo3dH3p1ImageToMeshRequest; +use fal_client::requests::api::mesh::multiview::tripo3d_h3p1_multiview_to_mesh::api::Tripo3dH3p1MultiviewToMeshRequest; +use fal_client::requests::api::mesh::text::tripo3d_h3p1_text_to_mesh::api::Tripo3dH3p1TextToMeshRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; +use crate::generate::generate_mesh::providers::fal::hunyuan3d_3::request::send_fal_mesh_request; + +#[derive(Clone, Debug)] +pub struct FalTripo3dH3p1TextRequestState { + /// Final materialized request; ready to fire. + pub request: Tripo3dH3p1TextToMeshRequest, +} + +impl FalTripo3dH3p1TextRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalTripo3dH3p1ImageRequestState { + /// Final materialized request; ready to fire. + pub request: Tripo3dH3p1ImageToMeshRequest, +} + +impl FalTripo3dH3p1ImageRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[derive(Clone, Debug)] +pub struct FalTripo3dH3p1MultiviewRequestState { + /// Final materialized request; ready to fire. + pub request: Tripo3dH3p1MultiviewToMeshRequest, +} + +impl FalTripo3dH3p1MultiviewRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_mesh_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::{ERNEST_SCARED_STUPID_IMAGE_URL, JUNO_AT_LAKE_IMAGE_URL}; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_mesh_model::RouterMeshModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_fal_client::RouterFalClient; + use crate::generate::generate_mesh::generate_mesh_request_builder::GenerateMeshRequestBuilder; + use crate::generate::generate_mesh::generate_mesh_response::GenerateMeshResponse; + use crate::generate::generate_mesh::mesh_generation_draft_or_request::MeshGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_tripo3d_h3p1_text_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + prompt: Some("A velociraptor with an open mouth full of sharp teeth.".to_string()), + ..tripo3d_h3p1_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_tripo3d_h3p1_image_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + ..tripo3d_h3p1_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_tripo3d_h3p1_multiview_to_mesh() { + let response = run_pipeline(GenerateMeshRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ERNEST_SCARED_STUPID_IMAGE_URL.to_string()])), + back_image: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + ..tripo3d_h3p1_builder() + }).await; + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn tripo3d_h3p1_builder() -> GenerateMeshRequestBuilder { + GenerateMeshRequestBuilder { + model: RouterMeshModel::Tripo3dH3p1, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) + } + + async fn run_pipeline(builder: GenerateMeshRequestBuilder) -> GenerateMeshResponse { + let client = get_fal_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + MeshGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal mesh skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + response + } +} diff --git a/crates/router/src/generate/generate_mesh/providers/mod.rs b/crates/router/src/generate/generate_mesh/providers/mod.rs new file mode 100644 index 00000000..4418b658 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/mod.rs @@ -0,0 +1,3 @@ +pub mod artcraft; +pub mod fal; +pub(crate) mod reject_unsupported; diff --git a/crates/router/src/generate/generate_mesh/providers/reject_unsupported.rs b/crates/router/src/generate/generate_mesh/providers/reject_unsupported.rs new file mode 100644 index 00000000..77dd3e34 --- /dev/null +++ b/crates/router/src/generate/generate_mesh/providers/reject_unsupported.rs @@ -0,0 +1,44 @@ +//! Shared helpers for rejecting builder options that a model does not support. +//! +//! Per the request-mismatch mitigation strategy: `ErrorOut` rejects the +//! request when an unsupported option is set; the other strategies silently +//! drop the option. + +use std::fmt::Debug; + +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +/// Reject (under `ErrorOut`) or silently drop a set option the model doesn't +/// support. +pub(crate) fn reject_unsupported_option( + field: &'static str, + value: Option<&T>, + strategy: RequestMismatchMitigationStrategy, +) -> Result<(), ArtcraftRouterError> { + let Some(value) = value else { + return Ok(()); + }; + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: format!("{:?}", value), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(()), + } +} + +/// Reject (under `ErrorOut`) or silently drop a single side-view image for +/// models/endpoints that take none. +pub(crate) fn reject_unsupported_image_ref( + field: &'static str, + image_ref: Option<&ImageRef>, + strategy: RequestMismatchMitigationStrategy, +) -> Result<(), ArtcraftRouterError> { + reject_unsupported_option(field, image_ref, strategy) +} diff --git a/crates/router/src/generate/generate_splat/cost/artcraft/estimate_splat_cost_artcraft_marble_0p1_mini.rs b/crates/router/src/generate/generate_splat/cost/artcraft/estimate_splat_cost_artcraft_marble_0p1_mini.rs new file mode 100644 index 00000000..5202aef7 --- /dev/null +++ b/crates/router/src/generate/generate_splat/cost/artcraft/estimate_splat_cost_artcraft_marble_0p1_mini.rs @@ -0,0 +1,72 @@ +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_mini::PlanArtcraftMarble0p1Mini; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +/// Marble 0.1-mini costs 230 World Labs credits for text or a single image +/// ($1 per 1,250 credits), so it is flat priced. +const COST_IN_USD_CENTS: u64 = 18; + +pub(crate) fn estimate_splat_cost_artcraft_marble_0p1_mini( + _plan: &PlanArtcraftMarble0p1Mini, +) -> SplatGenerationCostEstimate { + let cost_in_usd_cents = COST_IN_USD_CENTS; + + SplatGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_splat::generate_splat_request::GenerateSplatRequest; + + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn estimate_usd_cents(prompt: Option<&str>, image_tokens: Option>) -> u64 { + let request = GenerateSplatRequest { + model: RouterSplatModel::Marble0p1Mini, + provider: RouterProvider::Artcraft, + prompt: prompt.map(|s| s.to_string()), + reference_images: image_tokens.map(crate::api::image_list_ref::ImageListRef::MediaFileTokens), + idempotency_token: None, + }; + request.build() + .expect("build should succeed") + .estimate_costs() + .cost_in_usd_cents + .expect("cost_in_usd_cents should be present") + } + + #[test] + fn test_estimate_cost_text_only() { + let cost = estimate_usd_cents(Some("a room"), None); + assert_eq!(cost, 18); // 230 credits → 18 cents + } + + #[test] + fn test_estimate_cost_no_image_no_prompt() { + let cost = estimate_usd_cents(None, None); + assert_eq!(cost, 18); + } + + #[test] + fn test_estimate_cost_image() { + let tokens = vec![MediaFileToken("test_token".to_string())]; + let cost = estimate_usd_cents(None, Some(tokens.clone())); + assert_eq!(cost, 18); // 230 credits → 18 cents (same as text for mini) + } + + #[test] + fn test_estimate_cost_image_with_prompt() { + let tokens = vec![MediaFileToken("test_token".to_string())]; + let cost = estimate_usd_cents(Some("a cozy room"), Some(tokens.clone())); + assert_eq!(cost, 18); // 230 credits → 18 cents + } +} diff --git a/crates/router/src/generate/generate_splat/cost/artcraft/estimate_splat_cost_artcraft_marble_0p1_plus.rs b/crates/router/src/generate/generate_splat/cost/artcraft/estimate_splat_cost_artcraft_marble_0p1_plus.rs new file mode 100644 index 00000000..068d8c59 --- /dev/null +++ b/crates/router/src/generate/generate_splat/cost/artcraft/estimate_splat_cost_artcraft_marble_0p1_plus.rs @@ -0,0 +1,72 @@ +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_plus::PlanArtcraftMarble0p1Plus; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +/// Marble 0.1-plus costs 1580 World Labs credits for text or a single image +/// ($1 per 1,250 credits), so it is flat priced. +const COST_IN_USD_CENTS: u64 = 126; + +pub(crate) fn estimate_splat_cost_artcraft_marble_0p1_plus( + _plan: &PlanArtcraftMarble0p1Plus, +) -> SplatGenerationCostEstimate { + let cost_in_usd_cents = COST_IN_USD_CENTS; + + SplatGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_splat::generate_splat_request::GenerateSplatRequest; + + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn estimate_usd_cents(prompt: Option<&str>, image_tokens: Option>) -> u64 { + let request = GenerateSplatRequest { + model: RouterSplatModel::Marble0p1Plus, + provider: RouterProvider::Artcraft, + prompt: prompt.map(|s| s.to_string()), + reference_images: image_tokens.map(crate::api::image_list_ref::ImageListRef::MediaFileTokens), + idempotency_token: None, + }; + request.build() + .expect("build should succeed") + .estimate_costs() + .cost_in_usd_cents + .expect("cost_in_usd_cents should be present") + } + + #[test] + fn test_estimate_cost_text_only() { + let cost = estimate_usd_cents(Some("a room"), None); + assert_eq!(cost, 126); // 1580 credits → 126 cents + } + + #[test] + fn test_estimate_cost_no_image_no_prompt() { + let cost = estimate_usd_cents(None, None); + assert_eq!(cost, 126); + } + + #[test] + fn test_estimate_cost_image() { + let tokens = vec![MediaFileToken("test_token".to_string())]; + let cost = estimate_usd_cents(None, Some(tokens.clone())); + assert_eq!(cost, 126); // 1580 credits → 126 cents (same as text for plus) + } + + #[test] + fn test_estimate_cost_image_with_prompt() { + let tokens = vec![MediaFileToken("test_token".to_string())]; + let cost = estimate_usd_cents(Some("a cozy room"), Some(tokens.clone())); + assert_eq!(cost, 126); // 1580 credits → 126 cents + } +} diff --git a/crates/router/src/generate/generate_splat/cost/artcraft/mod.rs b/crates/router/src/generate/generate_splat/cost/artcraft/mod.rs new file mode 100644 index 00000000..ecccb4fc --- /dev/null +++ b/crates/router/src/generate/generate_splat/cost/artcraft/mod.rs @@ -0,0 +1,2 @@ +pub mod estimate_splat_cost_artcraft_marble_0p1_mini; +pub mod estimate_splat_cost_artcraft_marble_0p1_plus; diff --git a/crates/router/src/generate/generate_splat/cost/mod.rs b/crates/router/src/generate/generate_splat/cost/mod.rs new file mode 100644 index 00000000..61bc3e70 --- /dev/null +++ b/crates/router/src/generate/generate_splat/cost/mod.rs @@ -0,0 +1 @@ +pub(crate) mod artcraft; diff --git a/crates/router/src/generate/generate_splat/execute/artcraft/generate_splat_artcraft_marble_0p1_mini.rs b/crates/router/src/generate/generate_splat/execute/artcraft/generate_splat_artcraft_marble_0p1_mini.rs new file mode 100644 index 00000000..c87fabef --- /dev/null +++ b/crates/router/src/generate/generate_splat/execute/artcraft/generate_splat_artcraft_marble_0p1_mini.rs @@ -0,0 +1,33 @@ +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_mini::PlanArtcraftMarble0p1Mini; +use crate::generate::generate_splat::generate_splat_response::{ + ArtcraftSplatResponsePayload, GenerateSplatResponse, +}; +use artcraft_client::api_defs::generate::splat::generate_worldlabs_marble_0p1_mini_splat::GenerateWorldlabsMarble0p1MiniSplatRequest; +use artcraft_client::endpoints::generate::splat::generate_worldlabs_marble_0p1_mini_splat::generate_worldlabs_marble_0p1_mini_splat; + +pub async fn execute_artcraft_marble_0p1_mini( + plan: &PlanArtcraftMarble0p1Mini, + artcraft_client: &RouterArtcraftClient, +) -> Result { + let request = GenerateWorldlabsMarble0p1MiniSplatRequest { + uuid_idempotency_token: plan.idempotency_token.clone(), + image_media_file_token: plan.reference_image.clone(), + prompt: plan.prompt.clone(), + }; + + let response = generate_worldlabs_marble_0p1_mini_splat( + &artcraft_client.api_host, + Some(&artcraft_client.credentials), + request, + ) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateSplatResponse::Artcraft(ArtcraftSplatResponsePayload { + inference_job_token: response.inference_job_token.clone(), + all_inference_job_tokens: vec![response.inference_job_token], + })) +} diff --git a/crates/router/src/generate/generate_splat/execute/artcraft/generate_splat_artcraft_marble_0p1_plus.rs b/crates/router/src/generate/generate_splat/execute/artcraft/generate_splat_artcraft_marble_0p1_plus.rs new file mode 100644 index 00000000..0bde4380 --- /dev/null +++ b/crates/router/src/generate/generate_splat/execute/artcraft/generate_splat_artcraft_marble_0p1_plus.rs @@ -0,0 +1,33 @@ +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_plus::PlanArtcraftMarble0p1Plus; +use crate::generate::generate_splat::generate_splat_response::{ + ArtcraftSplatResponsePayload, GenerateSplatResponse, +}; +use artcraft_client::api_defs::generate::splat::generate_worldlabs_marble_0p1_plus_splat::GenerateWorldlabsMarble0p1PlusSplatRequest; +use artcraft_client::endpoints::generate::splat::generate_worldlabs_marble_0p1_plus_splat::generate_worldlabs_marble_0p1_plus_splat; + +pub async fn execute_artcraft_marble_0p1_plus( + plan: &PlanArtcraftMarble0p1Plus, + artcraft_client: &RouterArtcraftClient, +) -> Result { + let request = GenerateWorldlabsMarble0p1PlusSplatRequest { + uuid_idempotency_token: plan.idempotency_token.clone(), + image_media_file_token: plan.reference_image.clone(), + prompt: plan.prompt.clone(), + }; + + let response = generate_worldlabs_marble_0p1_plus_splat( + &artcraft_client.api_host, + Some(&artcraft_client.credentials), + request, + ) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateSplatResponse::Artcraft(ArtcraftSplatResponsePayload { + inference_job_token: response.inference_job_token.clone(), + all_inference_job_tokens: vec![response.inference_job_token], + })) +} diff --git a/crates/router/src/generate/generate_splat/execute/artcraft/mod.rs b/crates/router/src/generate/generate_splat/execute/artcraft/mod.rs new file mode 100644 index 00000000..5f41e4d2 --- /dev/null +++ b/crates/router/src/generate/generate_splat/execute/artcraft/mod.rs @@ -0,0 +1,2 @@ +pub mod generate_splat_artcraft_marble_0p1_mini; +pub mod generate_splat_artcraft_marble_0p1_plus; diff --git a/crates/router/src/generate/generate_splat/execute/mod.rs b/crates/router/src/generate/generate_splat/execute/mod.rs new file mode 100644 index 00000000..e3a8f2a0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/execute/mod.rs @@ -0,0 +1 @@ +pub mod artcraft; diff --git a/crates/router/src/generate/generate_splat/generate_splat_request.rs b/crates/router/src/generate/generate_splat/generate_splat_request.rs new file mode 100644 index 00000000..58f96e98 --- /dev/null +++ b/crates/router/src/generate/generate_splat/generate_splat_request.rs @@ -0,0 +1,58 @@ +use crate::api::router_splat_model::RouterSplatModel; +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_mini::plan_generate_splat_artcraft_marble_0p1_mini; +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_plus::plan_generate_splat_artcraft_marble_0p1_plus; +use crate::generate::generate_splat::splat_generation_plan::SplatGenerationPlan; + +pub struct GenerateSplatRequest { + /// Which model to use. + pub model: RouterSplatModel, + + /// Which provider to use. + pub provider: RouterProvider, + + /// The prompt for splat generation (optional). + pub prompt: Option, + + /// Reference images (optional). + pub reference_images: Option, + + /// Some providers support idempotency. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, +} + +impl GenerateSplatRequest { + /// Read the splat generation request, construct a plan, then yield a means to execute it. + pub fn build(&self) -> Result { + match self.provider { + RouterProvider::Artcraft => self.build_artcraft(), + _ => self.unsupported_provider(), + } + } + + fn build_artcraft(&self) -> Result { + match self.model { + RouterSplatModel::Marble0p1Mini => plan_generate_splat_artcraft_marble_0p1_mini(self), + RouterSplatModel::Marble0p1Plus => plan_generate_splat_artcraft_marble_0p1_plus(self), + // The marble 1.x models are only supported by the new + // `GenerateSplatRequestBuilder::build2()` pipeline. + _ => Err(ArtcraftRouterError::UnsupportedModel( + format!("Splat generation for model `{:?}` is not supported by the legacy plan API; use GenerateSplatRequestBuilder::build2()", self.model) + )), + } + } + + fn unsupported_provider(&self) -> Result { + Err(ArtcraftRouterError::UnsupportedModel( + format!("Splat generation for model `{:?}` is not supported for provider {:?}", self.model, self.provider) + )) + } + + pub fn get_or_generate_idempotency_token(&self) -> String { + self.idempotency_token.clone() + .unwrap_or_else(|| uuid::Uuid::new_v4().to_string()) + } +} diff --git a/crates/router/src/generate/generate_splat/generate_splat_request_builder.rs b/crates/router/src/generate/generate_splat/generate_splat_request_builder.rs new file mode 100644 index 00000000..0a34406f --- /dev/null +++ b/crates/router/src/generate/generate_splat/generate_splat_request_builder.rs @@ -0,0 +1,183 @@ +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_provider::RouterProvider; +use crate::api::router_splat_model::RouterSplatModel; +use crate::api::video_ref::VideoRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::providers::artcraft::marble_1p0::build::build_artcraft_marble_1p0; +use crate::generate::generate_splat::providers::artcraft::marble_1p0_draft::build::build_artcraft_marble_1p0_draft; +use crate::generate::generate_splat::providers::artcraft::marble_1p1::build::build_artcraft_marble_1p1; +use crate::generate::generate_splat::providers::artcraft::marble_1p1_plus::build::build_artcraft_marble_1p1_plus; +use crate::generate::generate_splat::providers::artcraft::triposplat::build::build_artcraft_triposplat; +use crate::generate::generate_splat::providers::fal::triposplat::build::build_fal_triposplat; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +/// RouterProvider-agnostic splat (gaussian world) generation request. +/// Distilled by `build2()` into a `SplatGenerationRequest` for the +/// selected (provider, model) pair. +/// +/// NB: The deprecated marble 0.1 models are treated as their marble 1.x +/// successors (`Marble0p1Mini` → `Marble1p0Draft`, `Marble0p1Plus` → +/// `Marble1p0`). +#[derive(Clone, Debug)] +pub struct GenerateSplatRequestBuilder { + /// Which model to use. + pub model: RouterSplatModel, + + /// Which provider to use. + pub provider: RouterProvider, + + /// The text prompt for the splat generation. + pub prompt: Option, + + /// Reference images (optional). + /// One image generates from a single view; multiple images are treated as + /// multi-view input of the same world. + pub reference_images: Option, + + /// Reference video (optional). Cannot be combined with reference images. + pub reference_video: Option, + + /// Whether the single reference image is a 360-degree panorama. + pub is_panoramic: Option, + + /// Whether to disable prompt recaptioning. + pub disable_recaption: Option, + + /// If the request is a mismatch with the (model/provider), how to mitigate it. + pub request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy, + + /// Some providers support idempotency. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, +} + +impl Default for GenerateSplatRequestBuilder { + fn default() -> Self { + Self { + model: RouterSplatModel::Marble1p0Draft, + provider: RouterProvider::Artcraft, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + prompt: None, + reference_images: None, + reference_video: None, + is_panoramic: None, + disable_recaption: None, + idempotency_token: None, + } + } +} + +impl GenerateSplatRequestBuilder { + + pub fn build2(self) -> Result { + match (self.provider, self.model) { + // Artcraft + (RouterProvider::Artcraft, RouterSplatModel::Marble1p0 | RouterSplatModel::Marble0p1Plus) => build_artcraft_marble_1p0(self), + (RouterProvider::Artcraft, RouterSplatModel::Marble1p0Draft | RouterSplatModel::Marble0p1Mini) => build_artcraft_marble_1p0_draft(self), + (RouterProvider::Artcraft, RouterSplatModel::Marble1p1) => build_artcraft_marble_1p1(self), + (RouterProvider::Artcraft, RouterSplatModel::Marble1p1Plus) => build_artcraft_marble_1p1_plus(self), + (RouterProvider::Artcraft, RouterSplatModel::TripoSplat) => build_artcraft_triposplat(self), + // Fal + (RouterProvider::Fal, RouterSplatModel::TripoSplat) => build_fal_triposplat(self), + _ => self.unsupported_provider_and_model(), + } + } + + pub fn get_or_generate_idempotency_token(&self) -> String { + self.idempotency_token.clone() + .unwrap_or_else(|| uuid::Uuid::new_v4().to_string()) + } + + fn unsupported_provider_and_model(&self) -> Result { + Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + format!("Splat generation for model `{:?}` is not supported for provider {:?}", self.model, self.provider) + )) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod artcraft_dispatch_tests { + use super::*; + + #[test] + fn all_models_dispatch_to_requests() { + let cases = [ + RouterSplatModel::Marble1p0, + RouterSplatModel::Marble1p0Draft, + RouterSplatModel::Marble1p1, + RouterSplatModel::Marble1p1Plus, + ]; + for model in cases { + let result = artcraft_builder(model).build2() + .unwrap_or_else(|e| panic!("build should succeed for {model:?}: {e}")); + let request = result; + let matches = matches!( + (model, &request), + (RouterSplatModel::Marble1p0, SplatGenerationRequest::ArtcraftMarble1p0(_)) + | (RouterSplatModel::Marble1p0Draft, SplatGenerationRequest::ArtcraftMarble1p0Draft(_)) + | (RouterSplatModel::Marble1p1, SplatGenerationRequest::ArtcraftMarble1p1(_)) + | (RouterSplatModel::Marble1p1Plus, SplatGenerationRequest::ArtcraftMarble1p1Plus(_)) + ); + assert!(matches, "unexpected dispatch for {model:?}: {request:?}"); + } + } + + #[test] + fn legacy_marble_0p1_mini_is_treated_as_marble_1p0_draft() { + let result = artcraft_builder(RouterSplatModel::Marble0p1Mini).build2().expect("build"); + assert!(matches!( + result, + SplatGenerationRequest::ArtcraftMarble1p0Draft(_) + )); + } + + #[test] + fn legacy_marble_0p1_plus_is_treated_as_marble_1p0() { + let result = artcraft_builder(RouterSplatModel::Marble0p1Plus).build2().expect("build"); + assert!(matches!( + result, + SplatGenerationRequest::ArtcraftMarble1p0(_) + )); + } + } + + mod unsupported_combo_tests { + use super::*; + + #[test] + fn non_splat_providers_are_unsupported() { + for provider in [ + RouterProvider::Fal, + RouterProvider::GmiCloud, + RouterProvider::GrokApi, + RouterProvider::Seedance2Pro, + ] { + let result = GenerateSplatRequestBuilder { + provider, + model: RouterSplatModel::Marble1p0, + prompt: Some("a cozy cabin".to_string()), + ..Default::default() + }.build2(); + assert!( + matches!(result, Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi(_))), + "expected unsupported error for {provider:?}", + ); + } + } + } + + // ── Helpers ── + + fn artcraft_builder(model: RouterSplatModel) -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + provider: RouterProvider::Artcraft, + model, + prompt: Some("a cozy cabin in the snowy mountains".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_splat/generate_splat_response.rs b/crates/router/src/generate/generate_splat/generate_splat_response.rs new file mode 100644 index 00000000..3493861a --- /dev/null +++ b/crates/router/src/generate/generate_splat/generate_splat_response.rs @@ -0,0 +1,52 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use artcraft_client::tokens::generic_inference_jobs::InferenceJobToken; + +#[derive(Clone, Debug)] +pub struct ArtcraftSplatResponsePayload { + pub inference_job_token: InferenceJobToken, + pub all_inference_job_tokens: Vec, +} + +/// Fal's queue/webhook submission receipt for a splat generation. +#[derive(Clone, Debug)] +pub struct FalSplatResponsePayload { + /// Fal's ID for the queued request. Present on queue submissions and on + /// most webhook submissions. + pub request_id: Option, + + /// Gateway request ID (webhook submissions). + pub gateway_request_id: Option, + + /// Queue-mode status polling URL. + pub maybe_status_url: Option, + + /// Queue-mode response URL. + pub maybe_response_url: Option, + + /// The outbound request we sent, for debug logging. + pub maybe_outbound_request: Option>, +} + +#[derive(Clone, Debug)] +pub enum GenerateSplatResponse { + Artcraft(ArtcraftSplatResponsePayload), + Fal(FalSplatResponsePayload), +} + +impl GenerateSplatResponse { + pub fn get_artcraft_payload(&self) -> Option { + match self { + Self::Artcraft(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_fal_payload(&self) -> Option { + match self { + Self::Fal(p) => Some(p.clone()), + _ => None, + } + } +} diff --git a/crates/router/src/generate/generate_splat/mod.rs b/crates/router/src/generate/generate_splat/mod.rs new file mode 100644 index 00000000..5bca59a7 --- /dev/null +++ b/crates/router/src/generate/generate_splat/mod.rs @@ -0,0 +1,15 @@ +// New audio-style pipeline (marble 1.x; use `GenerateSplatRequestBuilder::build2()`). +pub mod generate_splat_request_builder; +pub mod providers; +pub mod splat_generation_request; + +// Shared between the new and legacy pipelines. +pub mod generate_splat_response; +pub mod splat_generation_cost_estimate; + +// Legacy plan-based pipeline (marble 0.1 only; still used by the desktop app). +pub mod cost; +pub mod execute; +pub mod generate_splat_request; +pub mod plan; +pub mod splat_generation_plan; diff --git a/crates/router/src/generate/generate_splat/plan/artcraft/mod.rs b/crates/router/src/generate/generate_splat/plan/artcraft/mod.rs new file mode 100644 index 00000000..2f11cdbc --- /dev/null +++ b/crates/router/src/generate/generate_splat/plan/artcraft/mod.rs @@ -0,0 +1,2 @@ +pub mod plan_generate_splat_artcraft_marble_0p1_mini; +pub mod plan_generate_splat_artcraft_marble_0p1_plus; diff --git a/crates/router/src/generate/generate_splat/plan/artcraft/plan_generate_splat_artcraft_marble_0p1_mini.rs b/crates/router/src/generate/generate_splat/plan/artcraft/plan_generate_splat_artcraft_marble_0p1_mini.rs new file mode 100644 index 00000000..368948ff --- /dev/null +++ b/crates/router/src/generate/generate_splat/plan/artcraft/plan_generate_splat_artcraft_marble_0p1_mini.rs @@ -0,0 +1,50 @@ +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_splat::generate_splat_request::GenerateSplatRequest; +use crate::generate::generate_splat::splat_generation_plan::SplatGenerationPlan; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +#[derive(Debug, Clone)] +pub struct PlanArtcraftMarble0p1Mini { + pub prompt: Option, + pub reference_image: Option, + pub idempotency_token: String, +} + +pub fn plan_generate_splat_artcraft_marble_0p1_mini( + request: &GenerateSplatRequest, +) -> Result { + let reference_image = resolve_single_image_ref(request.reference_images.clone())?; + + Ok(SplatGenerationPlan::ArtcraftMarble0p1Mini(PlanArtcraftMarble0p1Mini { + prompt: request.prompt.clone(), + reference_image, + idempotency_token: request.get_or_generate_idempotency_token(), + })) +} + +fn resolve_single_image_ref( + image_list_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => { + Ok(tokens.into_iter().next()) + } + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(tokens.into_iter().next()) + } + } +} diff --git a/crates/router/src/generate/generate_splat/plan/artcraft/plan_generate_splat_artcraft_marble_0p1_plus.rs b/crates/router/src/generate/generate_splat/plan/artcraft/plan_generate_splat_artcraft_marble_0p1_plus.rs new file mode 100644 index 00000000..9134dcce --- /dev/null +++ b/crates/router/src/generate/generate_splat/plan/artcraft/plan_generate_splat_artcraft_marble_0p1_plus.rs @@ -0,0 +1,50 @@ +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_splat::generate_splat_request::GenerateSplatRequest; +use crate::generate::generate_splat::splat_generation_plan::SplatGenerationPlan; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +#[derive(Debug, Clone)] +pub struct PlanArtcraftMarble0p1Plus { + pub prompt: Option, + pub reference_image: Option, + pub idempotency_token: String, +} + +pub fn plan_generate_splat_artcraft_marble_0p1_plus( + request: &GenerateSplatRequest, +) -> Result { + let reference_image = resolve_single_image_ref(request.reference_images.clone())?; + + Ok(SplatGenerationPlan::ArtcraftMarble0p1Plus(PlanArtcraftMarble0p1Plus { + prompt: request.prompt.clone(), + reference_image, + idempotency_token: request.get_or_generate_idempotency_token(), + })) +} + +fn resolve_single_image_ref( + image_list_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => { + Ok(tokens.into_iter().next()) + } + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(tokens.into_iter().next()) + } + } +} diff --git a/crates/router/src/generate/generate_splat/plan/mod.rs b/crates/router/src/generate/generate_splat/plan/mod.rs new file mode 100644 index 00000000..e3a8f2a0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/plan/mod.rs @@ -0,0 +1 @@ +pub mod artcraft; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/build_common.rs b/crates/router/src/generate/generate_splat/providers/artcraft/build_common.rs new file mode 100644 index 00000000..0c0c214a --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/build_common.rs @@ -0,0 +1,115 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; +use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel as CommonSplatModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::artcraft::resolve::{ + resolve_image_list_ref, resolve_video_ref, +}; + +/// Build an `OmniGenSplatCostAndGenerateRequest` from the builder. The +/// Artcraft provider is a thin forwarding shim: the storyteller-web omni +/// splat endpoint owns per-model validation and option mapping, so the +/// builder's options are passed through as-is. +pub fn build_artcraft_omni_splat_request( + mut builder: GenerateSplatRequestBuilder, + model: CommonSplatModelEnum, +) -> Result { + let reference_image_media_tokens = resolve_image_list_ref(builder.reference_images.take())?; + let reference_video_media_token = resolve_video_ref(builder.reference_video.take())?; + let idempotency_token = builder.get_or_generate_idempotency_token(); + + Ok(OmniGenSplatCostAndGenerateRequest { + idempotency_token: Some(idempotency_token), + model: Some(model), + prompt: builder.prompt.take(), + reference_image_media_tokens, + reference_video_media_token, + is_panoramic: builder.is_panoramic, + disable_recaption: builder.disable_recaption, + }) +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::video_ref::VideoRef; + use crate::errors::client_error::ClientError; + + use super::*; + + #[test] + fn all_fields_are_forwarded() { + let builder = GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image".to_string()), + ])), + reference_video: Some(VideoRef::MediaFileToken(MediaFileToken::new("mf_video".to_string()))), + is_panoramic: Some(true), + disable_recaption: Some(true), + idempotency_token: Some("test-token".to_string()), + ..base_builder() + }; + + let request = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p0) + .expect("build"); + + assert_eq!(request.idempotency_token.as_deref(), Some("test-token")); + assert_eq!(request.model, Some(CommonSplatModelEnum::Marble1p0)); + assert_eq!(request.prompt.as_deref(), Some("a cozy cabin")); + assert_eq!(request.reference_image_media_tokens.as_ref().map(|t| t.len()), Some(1)); + assert_eq!(request.reference_video_media_token.as_ref().map(|t| t.as_str()), Some("mf_video")); + assert_eq!(request.is_panoramic, Some(true)); + assert_eq!(request.disable_recaption, Some(true)); + } + + #[test] + fn idempotency_token_is_generated_when_missing() { + let request = build_artcraft_omni_splat_request(base_builder(), CommonSplatModelEnum::Marble1p0Draft) + .expect("build"); + assert!(request.idempotency_token.is_some()); + assert!(!request.idempotency_token.unwrap().is_empty()); + } + + #[test] + fn image_url_references_are_rejected() { + let builder = GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/a.png".to_string()])), + ..base_builder() + }; + let result = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p0); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + )); + } + + #[test] + fn video_url_references_are_rejected() { + let builder = GenerateSplatRequestBuilder { + reference_video: Some(VideoRef::Url("https://example.com/a.mp4".to_string())), + ..base_builder() + }; + let result = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p0); + assert!(matches!( + result, + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + )); + } + + // ── Helpers ── + + fn base_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + model: RouterSplatModel::Marble1p0, + provider: RouterProvider::Artcraft, + prompt: Some("a cozy cabin".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/cost_common.rs b/crates/router/src/generate/generate_splat/providers/artcraft/cost_common.rs new file mode 100644 index 00000000..79fcd6bf --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/cost_common.rs @@ -0,0 +1,65 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; + +use crate::generate::generate_splat::providers::artcraft::input_type::InputType; + +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +/// Flat prices for a splat model by input type, in USD cents. +#[derive(Copy, Clone, Debug)] +pub(crate) struct ArtcraftSplatPriceTable { + pub image_panorama: u64, + pub text: u64, + pub image_non_panorama: u64, + pub multi_image: u64, + pub video: u64, +} + +impl ArtcraftSplatPriceTable { + pub(crate) fn cost_in_usd_cents(&self, input_type: InputType) -> u64 { + match input_type { + InputType::ImagePanorama => self.image_panorama, + InputType::Text => self.text, + InputType::ImageNonPanorama => self.image_non_panorama, + InputType::MultiImage => self.multi_image, + InputType::Video => self.video, + } + } +} + +/// Derive the pricing input type from a forwarded omni splat request. +/// Mirrors the request-assembly derivation: video wins over images, two or +/// more images are multi-image, one image is panorama/non-panorama, and +/// anything else prices as text. +pub(crate) fn derive_input_type_for_pricing( + request: &OmniGenSplatCostAndGenerateRequest, +) -> InputType { + let image_count = request.reference_image_media_tokens.as_ref() + .map(|tokens| tokens.len()) + .unwrap_or(0); + + if request.reference_video_media_token.is_some() { + InputType::Video + } else if image_count >= 2 { + InputType::MultiImage + } else if image_count == 1 { + if request.is_panoramic == Some(true) { + InputType::ImagePanorama + } else { + InputType::ImageNonPanorama + } + } else { + InputType::Text + } +} + +pub(crate) fn artcraft_splat_cost_estimate(cost_in_usd_cents: u64) -> SplatGenerationCostEstimate { + SplatGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/input_type.rs b/crates/router/src/generate/generate_splat/providers/artcraft/input_type.rs new file mode 100644 index 00000000..10a01679 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/input_type.rs @@ -0,0 +1,11 @@ +/// How a splat request is driven, for pricing. Marble prices differ by +/// input kind (World Labs' published table), and Artcraft's flat prices +/// follow the same split. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum InputType { + Text, + ImageNonPanorama, + ImagePanorama, + MultiImage, + Video, +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/build.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/build.rs new file mode 100644 index 00000000..4cdd392f --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/build.rs @@ -0,0 +1,13 @@ +use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel as CommonSplatModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::artcraft::build_common::build_artcraft_omni_splat_request; +use crate::generate::generate_splat::providers::artcraft::marble_1p0::request::ArtcraftMarble1p0RequestState; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +pub fn build_artcraft_marble_1p0(builder: GenerateSplatRequestBuilder) -> Result { + let request = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p0)?; + let state = ArtcraftMarble1p0RequestState { request }; + Ok(SplatGenerationRequest::ArtcraftMarble1p0(state)) +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/cost.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/cost.rs new file mode 100644 index 00000000..66bdf1b9 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/cost.rs @@ -0,0 +1,120 @@ +use crate::generate::generate_splat::providers::artcraft::input_type::InputType; + +use crate::generate::generate_splat::providers::artcraft::cost_common::{ + artcraft_splat_cost_estimate, derive_input_type_for_pricing, ArtcraftSplatPriceTable, +}; +use crate::generate::generate_splat::providers::artcraft::marble_1p0::request::ArtcraftMarble1p0RequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +const PRICES: ArtcraftSplatPriceTable = ArtcraftSplatPriceTable { + image_panorama: 156, + text: 165, + image_non_panorama: 165, + multi_image: 167, + video: 167, +}; + +/// Marble 1.0 via Artcraft is flat priced by input type. +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p0CostState { + pub input_type: InputType, +} + +impl ArtcraftMarble1p0CostState { + pub fn from_request(request: &ArtcraftMarble1p0RequestState) -> Self { + Self { input_type: derive_input_type_for_pricing(&request.request) } + } + + pub fn estimate_cost(&self) -> SplatGenerationCostEstimate { + artcraft_splat_cost_estimate(PRICES.cost_in_usd_cents(self.input_type)) + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::video_ref::VideoRef; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + + #[test] + fn text_is_165_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 165); + } + + #[test] + fn single_image_is_165_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(false)), 165); + } + + #[test] + fn panoramic_image_is_156_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(true)), 156); + } + + #[test] + fn multi_image_is_167_cents() { + assert_eq!(estimate_usd_cents(multi_image_builder()), 167); + } + + #[test] + fn video_is_167_cents() { + assert_eq!(estimate_usd_cents(video_builder()), 167); + } + + // ── Helpers ── + + fn base_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + model: RouterSplatModel::Marble1p0, + provider: RouterProvider::Artcraft, + ..Default::default() + } + } + + fn text_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin in the snowy mountains".to_string()), + ..base_builder() + } + } + + fn single_image_builder(is_panoramic: bool) -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + ])), + is_panoramic: Some(is_panoramic), + ..base_builder() + } + } + + fn multi_image_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + MediaFileToken::new("mf_image_2".to_string()), + ])), + ..base_builder() + } + } + + fn video_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_video: Some(VideoRef::MediaFileToken(MediaFileToken::new("mf_video".to_string()))), + ..base_builder() + } + } + + fn estimate_usd_cents(builder: GenerateSplatRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/mod.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/request.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/request.rs new file mode 100644 index 00000000..2c5fbdec --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::artcraft::request_common::send_artcraft_omni_splat_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p0RequestState { + pub request: OmniGenSplatCostAndGenerateRequest, +} + +impl ArtcraftMarble1p0RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_splat_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/build.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/build.rs new file mode 100644 index 00000000..311761de --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/build.rs @@ -0,0 +1,13 @@ +use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel as CommonSplatModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::artcraft::build_common::build_artcraft_omni_splat_request; +use crate::generate::generate_splat::providers::artcraft::marble_1p0_draft::request::ArtcraftMarble1p0DraftRequestState; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +pub fn build_artcraft_marble_1p0_draft(builder: GenerateSplatRequestBuilder) -> Result { + let request = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p0Draft)?; + let state = ArtcraftMarble1p0DraftRequestState { request }; + Ok(SplatGenerationRequest::ArtcraftMarble1p0Draft(state)) +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/cost.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/cost.rs new file mode 100644 index 00000000..98d09673 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/cost.rs @@ -0,0 +1,120 @@ +use crate::generate::generate_splat::providers::artcraft::input_type::InputType; + +use crate::generate::generate_splat::providers::artcraft::cost_common::{ + artcraft_splat_cost_estimate, derive_input_type_for_pricing, ArtcraftSplatPriceTable, +}; +use crate::generate::generate_splat::providers::artcraft::marble_1p0_draft::request::ArtcraftMarble1p0DraftRequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +const PRICES: ArtcraftSplatPriceTable = ArtcraftSplatPriceTable { + image_panorama: 16, + text: 24, + image_non_panorama: 24, + multi_image: 26, + video: 26, +}; + +/// Marble 1.0 Draft via Artcraft is flat priced by input type. +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p0DraftCostState { + pub input_type: InputType, +} + +impl ArtcraftMarble1p0DraftCostState { + pub fn from_request(request: &ArtcraftMarble1p0DraftRequestState) -> Self { + Self { input_type: derive_input_type_for_pricing(&request.request) } + } + + pub fn estimate_cost(&self) -> SplatGenerationCostEstimate { + artcraft_splat_cost_estimate(PRICES.cost_in_usd_cents(self.input_type)) + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::video_ref::VideoRef; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + + #[test] + fn text_is_24_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 24); + } + + #[test] + fn single_image_is_24_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(false)), 24); + } + + #[test] + fn panoramic_image_is_16_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(true)), 16); + } + + #[test] + fn multi_image_is_26_cents() { + assert_eq!(estimate_usd_cents(multi_image_builder()), 26); + } + + #[test] + fn video_is_26_cents() { + assert_eq!(estimate_usd_cents(video_builder()), 26); + } + + // ── Helpers ── + + fn base_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + model: RouterSplatModel::Marble1p0Draft, + provider: RouterProvider::Artcraft, + ..Default::default() + } + } + + fn text_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin in the snowy mountains".to_string()), + ..base_builder() + } + } + + fn single_image_builder(is_panoramic: bool) -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + ])), + is_panoramic: Some(is_panoramic), + ..base_builder() + } + } + + fn multi_image_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + MediaFileToken::new("mf_image_2".to_string()), + ])), + ..base_builder() + } + } + + fn video_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_video: Some(VideoRef::MediaFileToken(MediaFileToken::new("mf_video".to_string()))), + ..base_builder() + } + } + + fn estimate_usd_cents(builder: GenerateSplatRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/mod.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/request.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/request.rs new file mode 100644 index 00000000..8790ff6d --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p0_draft/request.rs @@ -0,0 +1,53 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::artcraft::request_common::send_artcraft_omni_splat_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p0DraftRequestState { + pub request: OmniGenSplatCostAndGenerateRequest, +} + +impl ArtcraftMarble1p0DraftRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_splat_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; + use crate::test_helpers::get_artcraft_client; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_world() { + let builder = GenerateSplatRequestBuilder { + model: RouterSplatModel::Marble1p0Draft, + provider: RouterProvider::Artcraft, + prompt: Some("A cozy cabin in the snowy mountains".to_string()), + ..Default::default() + }; + + let client = get_artcraft_client(); + let request = builder.build2().expect("build2 should succeed"); + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateSplatResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + assert!(matches!(response, GenerateSplatResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/build.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/build.rs new file mode 100644 index 00000000..af22b518 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/build.rs @@ -0,0 +1,13 @@ +use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel as CommonSplatModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::artcraft::build_common::build_artcraft_omni_splat_request; +use crate::generate::generate_splat::providers::artcraft::marble_1p1::request::ArtcraftMarble1p1RequestState; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +pub fn build_artcraft_marble_1p1(builder: GenerateSplatRequestBuilder) -> Result { + let request = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p1)?; + let state = ArtcraftMarble1p1RequestState { request }; + Ok(SplatGenerationRequest::ArtcraftMarble1p1(state)) +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/cost.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/cost.rs new file mode 100644 index 00000000..8d46f6a7 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/cost.rs @@ -0,0 +1,120 @@ +use crate::generate::generate_splat::providers::artcraft::input_type::InputType; + +use crate::generate::generate_splat::providers::artcraft::cost_common::{ + artcraft_splat_cost_estimate, derive_input_type_for_pricing, ArtcraftSplatPriceTable, +}; +use crate::generate::generate_splat::providers::artcraft::marble_1p1::request::ArtcraftMarble1p1RequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +const PRICES: ArtcraftSplatPriceTable = ArtcraftSplatPriceTable { + image_panorama: 156, + text: 165, + image_non_panorama: 165, + multi_image: 167, + video: 167, +}; + +/// Marble 1.1 via Artcraft is flat priced by input type. +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p1CostState { + pub input_type: InputType, +} + +impl ArtcraftMarble1p1CostState { + pub fn from_request(request: &ArtcraftMarble1p1RequestState) -> Self { + Self { input_type: derive_input_type_for_pricing(&request.request) } + } + + pub fn estimate_cost(&self) -> SplatGenerationCostEstimate { + artcraft_splat_cost_estimate(PRICES.cost_in_usd_cents(self.input_type)) + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::video_ref::VideoRef; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + + #[test] + fn text_is_165_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 165); + } + + #[test] + fn single_image_is_165_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(false)), 165); + } + + #[test] + fn panoramic_image_is_156_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(true)), 156); + } + + #[test] + fn multi_image_is_167_cents() { + assert_eq!(estimate_usd_cents(multi_image_builder()), 167); + } + + #[test] + fn video_is_167_cents() { + assert_eq!(estimate_usd_cents(video_builder()), 167); + } + + // ── Helpers ── + + fn base_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + model: RouterSplatModel::Marble1p1, + provider: RouterProvider::Artcraft, + ..Default::default() + } + } + + fn text_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin in the snowy mountains".to_string()), + ..base_builder() + } + } + + fn single_image_builder(is_panoramic: bool) -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + ])), + is_panoramic: Some(is_panoramic), + ..base_builder() + } + } + + fn multi_image_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + MediaFileToken::new("mf_image_2".to_string()), + ])), + ..base_builder() + } + } + + fn video_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_video: Some(VideoRef::MediaFileToken(MediaFileToken::new("mf_video".to_string()))), + ..base_builder() + } + } + + fn estimate_usd_cents(builder: GenerateSplatRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/mod.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/request.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/request.rs new file mode 100644 index 00000000..0c0aed3d --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::artcraft::request_common::send_artcraft_omni_splat_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p1RequestState { + pub request: OmniGenSplatCostAndGenerateRequest, +} + +impl ArtcraftMarble1p1RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_splat_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/build.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/build.rs new file mode 100644 index 00000000..3c8f1c00 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/build.rs @@ -0,0 +1,13 @@ +use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel as CommonSplatModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::artcraft::build_common::build_artcraft_omni_splat_request; +use crate::generate::generate_splat::providers::artcraft::marble_1p1_plus::request::ArtcraftMarble1p1PlusRequestState; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +pub fn build_artcraft_marble_1p1_plus(builder: GenerateSplatRequestBuilder) -> Result { + let request = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::Marble1p1Plus)?; + let state = ArtcraftMarble1p1PlusRequestState { request }; + Ok(SplatGenerationRequest::ArtcraftMarble1p1Plus(state)) +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/cost.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/cost.rs new file mode 100644 index 00000000..0e850fa9 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/cost.rs @@ -0,0 +1,120 @@ +use crate::generate::generate_splat::providers::artcraft::input_type::InputType; + +use crate::generate::generate_splat::providers::artcraft::cost_common::{ + artcraft_splat_cost_estimate, derive_input_type_for_pricing, ArtcraftSplatPriceTable, +}; +use crate::generate::generate_splat::providers::artcraft::marble_1p1_plus::request::ArtcraftMarble1p1PlusRequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +const PRICES: ArtcraftSplatPriceTable = ArtcraftSplatPriceTable { + image_panorama: 312, + text: 321, + image_non_panorama: 321, + multi_image: 323, + video: 323, +}; + +/// Marble 1.1 Plus via Artcraft is flat priced by input type. +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p1PlusCostState { + pub input_type: InputType, +} + +impl ArtcraftMarble1p1PlusCostState { + pub fn from_request(request: &ArtcraftMarble1p1PlusRequestState) -> Self { + Self { input_type: derive_input_type_for_pricing(&request.request) } + } + + pub fn estimate_cost(&self) -> SplatGenerationCostEstimate { + artcraft_splat_cost_estimate(PRICES.cost_in_usd_cents(self.input_type)) + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::video_ref::VideoRef; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + + #[test] + fn text_is_321_cents() { + assert_eq!(estimate_usd_cents(text_builder()), 321); + } + + #[test] + fn single_image_is_321_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(false)), 321); + } + + #[test] + fn panoramic_image_is_312_cents() { + assert_eq!(estimate_usd_cents(single_image_builder(true)), 312); + } + + #[test] + fn multi_image_is_323_cents() { + assert_eq!(estimate_usd_cents(multi_image_builder()), 323); + } + + #[test] + fn video_is_323_cents() { + assert_eq!(estimate_usd_cents(video_builder()), 323); + } + + // ── Helpers ── + + fn base_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + model: RouterSplatModel::Marble1p1Plus, + provider: RouterProvider::Artcraft, + ..Default::default() + } + } + + fn text_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin in the snowy mountains".to_string()), + ..base_builder() + } + } + + fn single_image_builder(is_panoramic: bool) -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + ])), + is_panoramic: Some(is_panoramic), + ..base_builder() + } + } + + fn multi_image_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_image_1".to_string()), + MediaFileToken::new("mf_image_2".to_string()), + ])), + ..base_builder() + } + } + + fn video_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_video: Some(VideoRef::MediaFileToken(MediaFileToken::new("mf_video".to_string()))), + ..base_builder() + } + } + + fn estimate_usd_cents(builder: GenerateSplatRequestBuilder) -> u64 { + builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present") + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/mod.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/request.rs b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/request.rs new file mode 100644 index 00000000..576630b4 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/marble_1p1_plus/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::artcraft::request_common::send_artcraft_omni_splat_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftMarble1p1PlusRequestState { + pub request: OmniGenSplatCostAndGenerateRequest, +} + +impl ArtcraftMarble1p1PlusRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_splat_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/mod.rs b/crates/router/src/generate/generate_splat/providers/artcraft/mod.rs new file mode 100644 index 00000000..31c71496 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/mod.rs @@ -0,0 +1,10 @@ +pub(crate) mod build_common; +pub(crate) mod cost_common; +pub mod input_type; +pub(crate) mod request_common; +pub(crate) mod resolve; +pub mod marble_1p0; +pub mod marble_1p0_draft; +pub mod marble_1p1; +pub mod marble_1p1_plus; +pub mod triposplat; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/request_common.rs b/crates/router/src/generate/generate_splat/providers/artcraft/request_common.rs new file mode 100644 index 00000000..3a7a3460 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/request_common.rs @@ -0,0 +1,32 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; +use artcraft_client::credentials::api_or_web_creds::ApiOrWebCreds; +use artcraft_client::endpoints::omni_gen::generate::splat::omni_gen_splat::{omni_gen_splat_generate, OmniGenSplatGenerateArgs}; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_splat::generate_splat_response::{ + ArtcraftSplatResponsePayload, GenerateSplatResponse, +}; + +/// Send a splat generation request to the Artcraft omni-gen endpoint. +/// All Artcraft model request states delegate to this function. +pub async fn send_artcraft_omni_splat_request( + request: &OmniGenSplatCostAndGenerateRequest, + client: &RouterArtcraftClient, +) -> Result { + let api_or_web_creds = ApiOrWebCreds::from(&client.credentials); + + let response = omni_gen_splat_generate(OmniGenSplatGenerateArgs { + api_host: &client.api_host, + api_or_web_creds: Some(&api_or_web_creds), + request, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateSplatResponse::Artcraft(ArtcraftSplatResponsePayload { + inference_job_token: response.inference_job_token, + all_inference_job_tokens: response.all_job_tokens, + })) +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/resolve.rs b/crates/router/src/generate/generate_splat/providers/artcraft/resolve.rs new file mode 100644 index 00000000..8468a86b --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/resolve.rs @@ -0,0 +1,45 @@ +//! Shared resolve helpers for the Artcraft splat provider. +//! +//! Artcraft only accepts media file tokens — raw URLs are rejected. + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_ref::VideoRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +pub(super) fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +pub(super) fn resolve_video_ref( + video_ref: Option, +) -> Result, ArtcraftRouterError> { + match video_ref { + None => Ok(None), + Some(VideoRef::MediaFileToken(token)) => Ok(Some(token)), + Some(VideoRef::Url(_) | VideoRef::LocalPath(_) | VideoRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/build.rs b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/build.rs new file mode 100644 index 00000000..bdd3c3db --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/build.rs @@ -0,0 +1,13 @@ +use artcraft_client::enums::common::generation::common_splat_model::CommonSplatModel as CommonSplatModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::artcraft::build_common::build_artcraft_omni_splat_request; +use crate::generate::generate_splat::providers::artcraft::triposplat::request::ArtcraftTripoSplatRequestState; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +pub fn build_artcraft_triposplat(builder: GenerateSplatRequestBuilder) -> Result { + let request = build_artcraft_omni_splat_request(builder, CommonSplatModelEnum::TripoSplat)?; + let state = ArtcraftTripoSplatRequestState { request }; + Ok(SplatGenerationRequest::ArtcraftTripoSplat(state)) +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/cost.rs b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/cost.rs new file mode 100644 index 00000000..632cb2fd --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/cost.rs @@ -0,0 +1,51 @@ +use crate::generate::generate_splat::providers::artcraft::cost_common::artcraft_splat_cost_estimate; +use crate::generate::generate_splat::providers::artcraft::triposplat::request::ArtcraftTripoSplatRequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +const FLAT_COST_IN_USD_CENTS: u64 = 7; + +/// TripoSplat via Artcraft is flat priced: it takes a single input image and +/// no option affects the price. +#[derive(Clone, Debug)] +pub struct ArtcraftTripoSplatCostState { + pub cost_in_usd_cents: u64, +} + +impl ArtcraftTripoSplatCostState { + pub fn from_request(_request: &ArtcraftTripoSplatRequestState) -> Self { + Self { cost_in_usd_cents: FLAT_COST_IN_USD_CENTS } + } + + pub fn estimate_cost(&self) -> SplatGenerationCostEstimate { + artcraft_splat_cost_estimate(self.cost_in_usd_cents) + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + + #[test] + fn flat_seven_cents() { + let builder = GenerateSplatRequestBuilder { + model: RouterSplatModel::TripoSplat, + provider: RouterProvider::Artcraft, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..Default::default() + }; + let cost = builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present"); + assert_eq!(cost, 7); + } +} diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/mod.rs b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/request.rs b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/request.rs new file mode 100644 index 00000000..a0e928ef --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/artcraft/triposplat/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_splat_cost_and_generate_request::OmniGenSplatCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::artcraft::request_common::send_artcraft_omni_splat_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftTripoSplatRequestState { + pub request: OmniGenSplatCostAndGenerateRequest, +} + +impl ArtcraftTripoSplatRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_splat_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_splat/providers/fal/mod.rs b/crates/router/src/generate/generate_splat/providers/fal/mod.rs new file mode 100644 index 00000000..14e263d9 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/fal/mod.rs @@ -0,0 +1,2 @@ +pub(crate) mod request_common; +pub mod triposplat; diff --git a/crates/router/src/generate/generate_splat/providers/fal/request_common.rs b/crates/router/src/generate/generate_splat/providers/fal/request_common.rs new file mode 100644 index 00000000..0fbdfe10 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/fal/request_common.rs @@ -0,0 +1,44 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::{ + FalSplatResponsePayload, GenerateSplatResponse, +}; + +/// Send a splat request to fal using the client's dispatch mode (webhook or +/// queue). Shared by all Fal splat request states. +pub(crate) async fn send_fal_splat_request( + request: &R, + client: &RouterFalClient, +) -> Result +where + R: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + + let payload = if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + FalSplatResponsePayload { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound), + } + } else { + let response = request.send_queue_request(&client.api_key).await?; + FalSplatResponsePayload { + request_id: Some(response.request_id), + gateway_request_id: None, + maybe_status_url: Some(response.status_url), + maybe_response_url: Some(response.response_url), + maybe_outbound_request: Some(outbound), + } + }; + + Ok(GenerateSplatResponse::Fal(payload)) +} diff --git a/crates/router/src/generate/generate_splat/providers/fal/triposplat/build.rs b/crates/router/src/generate/generate_splat/providers/fal/triposplat/build.rs new file mode 100644 index 00000000..22c051bb --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/fal/triposplat/build.rs @@ -0,0 +1,238 @@ +use fal_client::requests::api::splat::image::triposplat_image_to_splat::api::{ + TripoSplatImageToSplatRequest, TripoSplatOutputFormat, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_mesh::providers::reject_unsupported::reject_unsupported_option; +use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; +use crate::generate::generate_splat::providers::fal::triposplat::request::FalTripoSplatRequestState; +use crate::generate::generate_splat::splat_generation_request::SplatGenerationRequest; + +/// TripoSplat takes exactly one input image and nothing else. Prompts, +/// videos, panorama and recaption flags are unsupported: rejected under +/// `ErrorOut`, dropped otherwise. +pub fn build_fal_triposplat(builder: GenerateSplatRequestBuilder) -> Result { + let state = build_fal_triposplat_state(builder)?; + Ok(SplatGenerationRequest::FalTripoSplat(state)) +} + +pub(crate) fn build_fal_triposplat_state( + mut builder: GenerateSplatRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + reject_unsupported_option("prompt", builder.prompt.as_ref(), strategy)?; + reject_unsupported_option("reference_video", builder.reference_video.as_ref(), strategy)?; + if builder.is_panoramic == Some(true) { + reject_unsupported_option("is_panoramic", builder.is_panoramic.as_ref(), strategy)?; + } + reject_unsupported_option("disable_recaption", builder.disable_recaption.as_ref(), strategy)?; + + let image_url = plan_single_image_url(builder.reference_images.take(), strategy)? + .ok_or_else(|| { + ArtcraftRouterError::InvalidInput( + "TripoSplat requires an input image".to_string(), + ) + })?; + + let request = TripoSplatImageToSplatRequest { + image_url, + num_gaussians: None, + num_inference_steps: None, + guidance_scale: None, + // Always request PLY output — it's the format our pipeline stores. + output_format: Some(TripoSplatOutputFormat::Ply), + seed: None, + enable_safety_checker: None, + }; + Ok(FalTripoSplatRequestState { request }) +} + +/// Resolve the single input image from `reference_images`. More than one +/// image rejects under `ErrorOut`; the other strategies keep the first. +/// Fal only takes URLs; media file tokens are rejected. +fn plan_single_image_url( + reference_images: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let urls = match reference_images { + None => return Ok(None), + Some(ImageListRef::Urls(urls)) => urls, + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => return Ok(None), + Some(ImageListRef::MediaFileTokens(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + urls + } + }; + + if urls.len() > 1 { + if let RequestMismatchMitigationStrategy::ErrorOut = strategy { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: format!("Expected at most 1 image, got {}", urls.len()), + })); + } + } + Ok(urls.into_iter().next()) +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::api::video_ref::VideoRef; + + use super::*; + + const IMAGE_URL: &str = "https://example.com/object.png"; + + mod input_tests { + use super::*; + + #[test] + fn single_image_builds() { + let state = build_fal_triposplat_state(image_builder()).expect("build"); + assert_eq!(state.request.image_url, IMAGE_URL); + } + + #[test] + fn output_format_is_always_ply() { + let state = build_fal_triposplat_state(image_builder()).expect("build"); + assert_eq!(state.request.output_format, Some(TripoSplatOutputFormat::Ply)); + } + + #[test] + fn no_image_is_rejected() { + let result = build_fal_triposplat_state(base_builder()); + assert!(matches!(result, Err(ArtcraftRouterError::InvalidInput(_)))); + } + + #[test] + fn media_tokens_are_rejected() { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + let builder = GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_test123".to_string()), + ])), + ..base_builder() + }; + assert!(matches!( + build_fal_triposplat_state(builder), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn multiple_images_error_out_under_error_out() { + let builder = GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + IMAGE_URL.to_string(), + "https://example.com/second.png".to_string(), + ])), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..base_builder() + }; + assert!(build_fal_triposplat_state(builder).is_err()); + } + + #[test] + fn multiple_images_keep_the_first_under_lenient_strategies() { + let builder = GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + IMAGE_URL.to_string(), + "https://example.com/second.png".to_string(), + ])), + ..base_builder() + }; + let state = build_fal_triposplat_state(builder).expect("build"); + assert_eq!(state.request.image_url, IMAGE_URL); + } + } + + mod unsupported_option_tests { + use super::*; + + #[test] + fn unsupported_options_error_out_under_error_out() { + let cases = [ + GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin".to_string()), + ..strict_image_builder() + }, + GenerateSplatRequestBuilder { + reference_video: Some(VideoRef::Url("https://example.com/v.mp4".to_string())), + ..strict_image_builder() + }, + GenerateSplatRequestBuilder { + is_panoramic: Some(true), + ..strict_image_builder() + }, + GenerateSplatRequestBuilder { + disable_recaption: Some(true), + ..strict_image_builder() + }, + ]; + for builder in cases { + assert!(build_fal_triposplat_state(builder).is_err()); + } + } + + #[test] + fn unsupported_options_are_dropped_under_lenient_strategies() { + let builder = GenerateSplatRequestBuilder { + prompt: Some("a cozy cabin".to_string()), + is_panoramic: Some(true), + disable_recaption: Some(true), + ..image_builder() + }; + assert!(build_fal_triposplat_state(builder).is_ok()); + } + + #[test] + fn is_panoramic_false_is_not_a_mismatch() { + let builder = GenerateSplatRequestBuilder { + is_panoramic: Some(false), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + }; + assert!(build_fal_triposplat_state(builder).is_ok()); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + model: RouterSplatModel::TripoSplat, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn image_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![IMAGE_URL.to_string()])), + ..base_builder() + } + } + + fn strict_image_builder() -> GenerateSplatRequestBuilder { + GenerateSplatRequestBuilder { + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..image_builder() + } + } +} diff --git a/crates/router/src/generate/generate_splat/providers/fal/triposplat/cost.rs b/crates/router/src/generate/generate_splat/providers/fal/triposplat/cost.rs new file mode 100644 index 00000000..aa79c564 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/fal/triposplat/cost.rs @@ -0,0 +1,59 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_splat::providers::fal::triposplat::request::FalTripoSplatRequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +/// Cost math is owned by fal_client's `FalRequestCostCalculator` — the +/// router state just forwards the result so router cost ≡ fal_client cost +/// by construction. TripoSplat is flat 5¢. +#[derive(Clone, Debug)] +pub struct FalTripoSplatCostState { + pub cost_in_usd_cents: u64, +} + +impl FalTripoSplatCostState { + pub fn from_request(request: &FalTripoSplatRequestState) -> Self { + Self { + cost_in_usd_cents: request.request.calculate_cost_in_cents(), + } + } + + pub fn estimate_cost(&self) -> SplatGenerationCostEstimate { + SplatGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + + #[test] + fn flat_five_cents() { + let builder = GenerateSplatRequestBuilder { + model: RouterSplatModel::TripoSplat, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![ + "https://example.com/object.png".to_string(), + ])), + ..Default::default() + }; + let cost = builder.build2() + .expect("build should succeed") + .estimate_cost() + .expect("estimate should succeed") + .cost_in_usd_cents + .expect("cost should be present"); + assert_eq!(cost, 5); + } +} diff --git a/crates/router/src/generate/generate_splat/providers/fal/triposplat/mod.rs b/crates/router/src/generate/generate_splat/providers/fal/triposplat/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/fal/triposplat/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_splat/providers/fal/triposplat/request.rs b/crates/router/src/generate/generate_splat/providers/fal/triposplat/request.rs new file mode 100644 index 00000000..bd98b8dc --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/fal/triposplat/request.rs @@ -0,0 +1,57 @@ +use fal_client::requests::api::splat::image::triposplat_image_to_splat::api::TripoSplatImageToSplatRequest; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::fal::request_common::send_fal_splat_request; + +#[derive(Clone, Debug)] +pub struct FalTripoSplatRequestState { + /// Final materialized request; ready to fire. + pub request: TripoSplatImageToSplatRequest, +} + +impl FalTripoSplatRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + send_fal_splat_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::ERNEST_SCARED_STUPID_IMAGE_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_splat_model::RouterSplatModel; + use crate::generate::generate_splat::generate_splat_request_builder::GenerateSplatRequestBuilder; + use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_triposplat_image_to_splat() { + let client = get_fal_client(); + + let builder = GenerateSplatRequestBuilder { + model: RouterSplatModel::TripoSplat, + provider: RouterProvider::Fal, + reference_images: Some(ImageListRef::Urls(vec![ + ERNEST_SCARED_STUPID_IMAGE_URL.to_string(), + ])), + ..Default::default() + }; + + let request = builder.build2().expect("build2 should succeed"); + + let response = request.send_request(&client).await.expect("send_request should succeed"); + println!("response: {:?}", response); + + let payload = match response { + GenerateSplatResponse::Fal(p) => p, + other => panic!("expected Fal payload, got {other:?}"), + }; + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + assert_eq!(1, 2, "Inspect output above"); + } +} diff --git a/crates/router/src/generate/generate_splat/providers/mod.rs b/crates/router/src/generate/generate_splat/providers/mod.rs new file mode 100644 index 00000000..cded7c36 --- /dev/null +++ b/crates/router/src/generate/generate_splat/providers/mod.rs @@ -0,0 +1,2 @@ +pub mod artcraft; +pub mod fal; diff --git a/crates/router/src/generate/generate_splat/splat_generation_cost_estimate.rs b/crates/router/src/generate/generate_splat/splat_generation_cost_estimate.rs new file mode 100644 index 00000000..a9b93682 --- /dev/null +++ b/crates/router/src/generate/generate_splat/splat_generation_cost_estimate.rs @@ -0,0 +1,16 @@ +/// The result of estimating the cost of a splat generation plan. +#[derive(Clone, Debug)] +pub struct SplatGenerationCostEstimate { + pub cost_in_credits: Option, + pub cost_in_usd_cents: Option, + pub is_free: bool, + pub is_unlimited: bool, + pub is_rate_limited: bool, + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/router/src/generate/generate_splat/splat_generation_plan.rs b/crates/router/src/generate/generate_splat/splat_generation_plan.rs new file mode 100644 index 00000000..42c100ae --- /dev/null +++ b/crates/router/src/generate/generate_splat/splat_generation_plan.rs @@ -0,0 +1,45 @@ +use crate::client::router_client::RouterClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::cost::artcraft::estimate_splat_cost_artcraft_marble_0p1_mini::estimate_splat_cost_artcraft_marble_0p1_mini; +use crate::generate::generate_splat::cost::artcraft::estimate_splat_cost_artcraft_marble_0p1_plus::estimate_splat_cost_artcraft_marble_0p1_plus; +use crate::generate::generate_splat::execute::artcraft::generate_splat_artcraft_marble_0p1_mini::execute_artcraft_marble_0p1_mini; +use crate::generate::generate_splat::execute::artcraft::generate_splat_artcraft_marble_0p1_plus::execute_artcraft_marble_0p1_plus; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_mini::PlanArtcraftMarble0p1Mini; +use crate::generate::generate_splat::plan::artcraft::plan_generate_splat_artcraft_marble_0p1_plus::PlanArtcraftMarble0p1Plus; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +#[derive(Debug)] +pub enum SplatGenerationPlan { + ArtcraftMarble0p1Mini(PlanArtcraftMarble0p1Mini), + ArtcraftMarble0p1Plus(PlanArtcraftMarble0p1Plus), +} + +impl SplatGenerationPlan { + pub async fn generate_splat( + &self, + client: &RouterClient, + ) -> Result { + match self { + SplatGenerationPlan::ArtcraftMarble0p1Mini(plan) => { + let artcraft_client = client.get_artcraft_client_ref()?; + execute_artcraft_marble_0p1_mini(plan, artcraft_client).await + } + SplatGenerationPlan::ArtcraftMarble0p1Plus(plan) => { + let artcraft_client = client.get_artcraft_client_ref()?; + execute_artcraft_marble_0p1_plus(plan, artcraft_client).await + } + } + } + + pub fn estimate_costs(&self) -> SplatGenerationCostEstimate { + match self { + SplatGenerationPlan::ArtcraftMarble0p1Mini(plan) => { + estimate_splat_cost_artcraft_marble_0p1_mini(plan) + } + SplatGenerationPlan::ArtcraftMarble0p1Plus(plan) => { + estimate_splat_cost_artcraft_marble_0p1_plus(plan) + } + } + } +} diff --git a/crates/router/src/generate/generate_splat/splat_generation_request.rs b/crates/router/src/generate/generate_splat/splat_generation_request.rs new file mode 100644 index 00000000..256d2c8c --- /dev/null +++ b/crates/router/src/generate/generate_splat/splat_generation_request.rs @@ -0,0 +1,84 @@ +use crate::api::router_provider::RouterProvider; +use crate::client::router_client::RouterClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_splat::generate_splat_response::GenerateSplatResponse; +use crate::generate::generate_splat::providers::artcraft::marble_1p0::cost::ArtcraftMarble1p0CostState; +use crate::generate::generate_splat::providers::artcraft::marble_1p0::request::ArtcraftMarble1p0RequestState; +use crate::generate::generate_splat::providers::artcraft::marble_1p0_draft::cost::ArtcraftMarble1p0DraftCostState; +use crate::generate::generate_splat::providers::artcraft::marble_1p0_draft::request::ArtcraftMarble1p0DraftRequestState; +use crate::generate::generate_splat::providers::artcraft::marble_1p1::cost::ArtcraftMarble1p1CostState; +use crate::generate::generate_splat::providers::artcraft::marble_1p1::request::ArtcraftMarble1p1RequestState; +use crate::generate::generate_splat::providers::artcraft::marble_1p1_plus::cost::ArtcraftMarble1p1PlusCostState; +use crate::generate::generate_splat::providers::artcraft::marble_1p1_plus::request::ArtcraftMarble1p1PlusRequestState; +use crate::generate::generate_splat::providers::artcraft::triposplat::cost::ArtcraftTripoSplatCostState; +use crate::generate::generate_splat::providers::artcraft::triposplat::request::ArtcraftTripoSplatRequestState; +use crate::generate::generate_splat::providers::fal::triposplat::cost::FalTripoSplatCostState; +use crate::generate::generate_splat::providers::fal::triposplat::request::FalTripoSplatRequestState; +use crate::generate::generate_splat::splat_generation_cost_estimate::SplatGenerationCostEstimate; + +#[derive(Clone, Debug)] +pub enum SplatGenerationRequest { + ArtcraftMarble1p0(ArtcraftMarble1p0RequestState), + ArtcraftMarble1p0Draft(ArtcraftMarble1p0DraftRequestState), + ArtcraftMarble1p1(ArtcraftMarble1p1RequestState), + ArtcraftMarble1p1Plus(ArtcraftMarble1p1PlusRequestState), + ArtcraftTripoSplat(ArtcraftTripoSplatRequestState), + FalTripoSplat(FalTripoSplatRequestState), +} + +impl SplatGenerationRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::ArtcraftMarble1p0(_) => RouterProvider::Artcraft, + Self::ArtcraftMarble1p0Draft(_) => RouterProvider::Artcraft, + Self::ArtcraftMarble1p1(_) => RouterProvider::Artcraft, + Self::ArtcraftMarble1p1Plus(_) => RouterProvider::Artcraft, + Self::ArtcraftTripoSplat(_) => RouterProvider::Artcraft, + Self::FalTripoSplat(_) => RouterProvider::Fal, + } + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match self { + SplatGenerationRequest::ArtcraftMarble1p0(request) => Ok(ArtcraftMarble1p0CostState::from_request(request).estimate_cost()), + SplatGenerationRequest::ArtcraftMarble1p0Draft(request) => Ok(ArtcraftMarble1p0DraftCostState::from_request(request).estimate_cost()), + SplatGenerationRequest::ArtcraftMarble1p1(request) => Ok(ArtcraftMarble1p1CostState::from_request(request).estimate_cost()), + SplatGenerationRequest::ArtcraftMarble1p1Plus(request) => Ok(ArtcraftMarble1p1PlusCostState::from_request(request).estimate_cost()), + SplatGenerationRequest::ArtcraftTripoSplat(request) => Ok(ArtcraftTripoSplatCostState::from_request(request).estimate_cost()), + SplatGenerationRequest::FalTripoSplat(request) => Ok(FalTripoSplatCostState::from_request(request).estimate_cost()), + } + } + + /// Send the splat generation request + /// If successful, returns the job IDs. + pub async fn send_request(&self, client: &RouterClient) -> Result { + match self { + SplatGenerationRequest::ArtcraftMarble1p0(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + SplatGenerationRequest::ArtcraftMarble1p0Draft(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + SplatGenerationRequest::ArtcraftMarble1p1(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + SplatGenerationRequest::ArtcraftMarble1p1Plus(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + SplatGenerationRequest::ArtcraftTripoSplat(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + SplatGenerationRequest::FalTripoSplat(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + } + } +} diff --git a/crates/router/src/generate/generate_video/CLAUDE.md b/crates/router/src/generate/generate_video/CLAUDE.md new file mode 100644 index 00000000..2abed645 --- /dev/null +++ b/crates/router/src/generate/generate_video/CLAUDE.md @@ -0,0 +1,127 @@ +# generate_video + +This module implements the v2 video generation pipeline. It replaces the v1 system +(in `generate_video/`) with a two-phase approach that separates request planning from +execution, allowing cost estimation and media uploads to happen at the right time. + +## Lifecycle + +``` +GenerateVideoRequestBuilder + │ + ▼ build2() +VideoGenerationDraftOrRequest + │ + ├─ Draft(VideoGenerationDraftRequest) + │ │ + │ ▼ estimate_cost() ← cost estimate from draft state + │ │ + │ ▼ finalize(context) ← uploads media, resolves tokens + │ │ + │ ▼ + │ VideoGenerationRequest + │ │ + │ ▼ estimate_cost() ← cost estimate from finalized request + │ │ + │ ▼ send_request() ← fires the API call + │ │ + │ ▼ + │ GenerateVideoResponse + │ + └─ Request(VideoGenerationRequest) ← skips draft phase (used by Artcraft provider) +``` + +### Key types + +- **`GenerateVideoRequestBuilder`** — generic builder with provider/model/prompt/resolution/etc. + Located in `generate_video/generate_video_request_builder.rs`. The `use_new_builder()` method + gates which provider+model combos use the v2 path. `build2()` dispatches to the correct + provider's build function. + +- **`VideoGenerationDraftOrRequest`** — the output of `build2()`. Either `Draft` (for providers + that need media upload/resolution, like Kinovi) or `Request` (for providers that work with + media file tokens directly, like Artcraft). + +- **`VideoGenerationDraftRequest`** — enum with one variant per provider+model. Holds + materialized settings (resolution, duration, batch count) plus unresolved media references. + Can estimate cost without network calls. + +- **`VideoGenerationDraftContext`** — context needed during `finalize()`: the provider client, + media file token-to-URL map, and character token-to-ID map. + +- **`VideoGenerationRequest`** — enum with one variant per provider+model. Holds a fully + materialized request ready to send. All media URLs are resolved and uploaded. + +### Cost estimation + +Cost can be estimated at two stages: +1. **From draft** — before `finalize()`. Uses the planned resolution/duration/batch count. + Good for showing the user a price before committing. +2. **From request** — after `finalize()`. Uses the final materialized request. Should match + the draft estimate for the same parameters. + +## Module layout + +``` +generate_video/ +├── mod.rs +├── video_generation_draft.rs ← VideoGenerationDraftRequest enum +├── video_generation_draft_context.rs ← context for finalize() +├── video_generation_draft_or_request.rs +├── video_generation_request.rs ← VideoGenerationRequest enum +└── providers/ + ├── artcraft/ ← Artcraft provider (uses media file tokens directly) + │ ├── seedance_2p0/ ← Seedance 2.0 Pro model (skips draft, returns Request directly) + │ │ ├── mod.rs + │ │ ├── build.rs ← builder → Request conversion + plan helpers + │ │ ├── cost.rs ← standalone cost estimation (independent of seedance2pro_client) + │ │ └── request.rs ← request state + send() via Artcraft multi-function API + │ └── seedance_2p0_fast/ ← Seedance 2.0 Fast model (skips draft, 480p/720p only) + │ ├── mod.rs + │ ├── build.rs ← builder → Request conversion + plan helpers (no 1080p) + │ ├── cost.rs ← standalone cost estimation with Fast-specific pricing + │ └── request.rs ← request state + send() via Artcraft omni-gen API + └── kinovi/ ← Kinovi/Seedance2Pro provider + ├── mod.rs + ├── resolve.rs ← shared: media token resolution, upload helpers + ├── upload.rs ← shared: download + re-upload to Seedance2Pro CDN + ├── seedance_2p0/ ← Seedance 2.0 Pro model + │ ├── mod.rs + │ ├── build.rs ← builder → draft conversion + plan helpers + │ ├── cost.rs ← cost estimation state + │ ├── draft.rs ← draft state + finalize (to_request) + │ └── request.rs ← request state + send() + └── seedance_2p0_fast/ ← Seedance 2.0 Fast model + ├── mod.rs + ├── build.rs + ├── cost.rs + ├── draft.rs + └── request.rs +``` + +## Adding a new provider or model + +1. **Create the module** under `providers/{provider}/{model}/` with these files: + - `mod.rs` — declares sub-modules + - `build.rs` — `build_{provider}_{model}(builder) -> VideoGenerationDraftOrRequest`. + Contains `plan_*` helpers for aspect ratio, resolution, batch count, duration. + - `draft.rs` — draft state struct with `to_request()` async method for finalization. + **Not needed** if the provider uses media tokens directly (no upload/resolution needed); + in that case `build.rs` returns `VideoGenerationDraftOrRequest::Request(...)` directly. + - `cost.rs` — cost state with `from_request()` and `estimate_cost()`. Add `from_draft()` + if the provider uses the draft phase. + - `request.rs` — request state with `send()` async method. + +2. **Register the module** in the parent provider's `mod.rs`. + +3. **Add enum variants** in: + - `video_generation_draft.rs` — `VideoGenerationDraftRequest` enum + `estimate_cost` + `finalize` + (skip if provider has no draft phase) + - `video_generation_request.rs` — `VideoGenerationRequest` enum + `estimate_cost` + `send_request` + +4. **Wire into the builder** in `generate_video_request_builder.rs`: + - Add the `(Provider, Model)` pair to `use_new_builder()` returning `true` + - Add the dispatch arm in `build2()` + +5. **Tests**: each `build.rs` and `cost.rs` should have comprehensive tests. `request.rs` + should have `#[ignore]` live API tests for manual verification. diff --git a/crates/router/src/generate/generate_video/generate_video_request_builder.rs b/crates/router/src/generate/generate_video/generate_video_request_builder.rs new file mode 100644 index 00000000..2669f357 --- /dev/null +++ b/crates/router/src/generate/generate_video/generate_video_request_builder.rs @@ -0,0 +1,270 @@ +use crate::api::audio_list_ref::AudioListRef; +use crate::api::character_list_ref::CharacterListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_bitrate::RouterBitrate; +use crate::api::router_resolution::RouterResolution; +use crate::api::router_video_model::RouterVideoModel; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_provider::RouterProvider; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video::build::build_artcraft_grok_imagine_video; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video_1p5::build::build_artcraft_grok_imagine_video_1p5; +use crate::generate::generate_video::providers::artcraft::happy_horse_1p0::build::build_artcraft_happy_horse_1p0; +use crate::generate::generate_video::providers::artcraft::kling_1_6_pro::build::build_artcraft_kling_1_6_pro; +use crate::generate::generate_video::providers::artcraft::kling_2_1_master::build::build_artcraft_kling_2_1_master; +use crate::generate::generate_video::providers::artcraft::kling_2_1_pro::build::build_artcraft_kling_2_1_pro; +use crate::generate::generate_video::providers::artcraft::kling_2_5_turbo_pro::build::build_artcraft_kling_2_5_turbo_pro; +use crate::generate::generate_video::providers::artcraft::kling_2_6_pro::build::build_artcraft_kling_2_6_pro; +use crate::generate::generate_video::providers::artcraft::kling_3p0_pro::build::build_artcraft_kling_3p0_pro; +use crate::generate::generate_video::providers::artcraft::kling_3p0_standard::build::build_artcraft_kling_3p0_standard; +use crate::generate::generate_video::providers::artcraft::preview_model::build::build_artcraft_preview_model; +use crate::generate::generate_video::providers::artcraft::preview_model_fast::build::build_artcraft_preview_model_fast; +use crate::generate::generate_video::providers::artcraft::seedance_1p0_lite::build::build_artcraft_seedance_1p0_lite; +use crate::generate::generate_video::providers::artcraft::seedance_1p5_pro::build::build_artcraft_seedance_1p5_pro; +use crate::generate::generate_video::providers::artcraft::seedance_2p0::build::build_artcraft_seedance_2p0; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_fast::build::build_artcraft_seedance_2p0_fast; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u::build::build_artcraft_seedance_2p0_u; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u_fast::build::build_artcraft_seedance_2p0_u_fast; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp::build::build_artcraft_seedance_2p0_bp; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_fast::build::build_artcraft_seedance_2p0_bp_fast; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu::build::build_artcraft_seedance_2p0_bpu; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_fast::build::build_artcraft_seedance_2p0_bpu_fast; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_mini::build::build_artcraft_seedance_2p0_mini; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_mini::build::build_artcraft_seedance_2p0_bp_mini; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_mini::build::build_artcraft_seedance_2p0_bpu_mini; +use crate::generate::generate_video::providers::artcraft::sora_2::build::build_artcraft_sora_2; +use crate::generate::generate_video::providers::artcraft::sora_2_pro::build::build_artcraft_sora_2_pro; +use crate::generate::generate_video::providers::artcraft::veo_2::build::build_artcraft_veo_2; +use crate::generate::generate_video::providers::artcraft::veo_3::build::build_artcraft_veo_3; +use crate::generate::generate_video::providers::artcraft::veo_3_fast::build::build_artcraft_veo_3_fast; +use crate::generate::generate_video::providers::artcraft::veo_3p1::build::build_artcraft_veo_3p1; +use crate::generate::generate_video::providers::artcraft::veo_3p1_fast::build::build_artcraft_veo_3p1_fast; +use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::build::build_artcraft_veo_3p1_lite; +use crate::generate::generate_video::providers::artcraft::vidu_q3::build::build_artcraft_vidu_q3; +use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::build::build_artcraft_vidu_q3_turbo; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::build::build_kinovi_happy_horse_1p0; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::build::build_kinovi_seedance_2p0; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_g::build::build_gmicloud_seedance_2p0_u; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_fast_g::build::build_gmicloud_seedance_2p0_u_fast; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video::build::build_grok_api_grok_imagine_video; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::build::build_grok_api_grok_imagine_video_1p5; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::build_fal_kling_1_6_pro; +use crate::generate::generate_video::providers::fal::kling_2_1_master::build::build_fal_kling_2_1_master; +use crate::generate::generate_video::providers::fal::kling_2_1_pro::build::build_fal_kling_2_1_pro; +use crate::generate::generate_video::providers::fal::kling_2_5_turbo_pro::build::build_fal_kling_2_5_turbo_pro; +use crate::generate::generate_video::providers::fal::kling_2_6_pro::build::build_fal_kling_2_6_pro; +use crate::generate::generate_video::providers::fal::kling_3p0_pro::build::build_fal_kling_3p0_pro; +use crate::generate::generate_video::providers::fal::kling_3p0_standard::build::build_fal_kling_3p0_standard; +use crate::generate::generate_video::providers::fal::seedance_1p0_lite::build::build_fal_seedance_1p0_lite; +use crate::generate::generate_video::providers::fal::seedance_1p5_pro::build::build_fal_seedance_1p5_pro; +use crate::generate::generate_video::providers::fal::sora_2::build::build_fal_sora_2; +use crate::generate::generate_video::providers::fal::sora_2_pro::build::build_fal_sora_2_pro; +use crate::generate::generate_video::providers::fal::veo_2::build::build_fal_veo_2; +use crate::generate::generate_video::providers::fal::veo_3::build::build_fal_veo_3; +use crate::generate::generate_video::providers::fal::veo_3_fast::build::build_fal_veo_3_fast; +use crate::generate::generate_video::providers::fal::veo_3p1::build::build_fal_veo_3p1; +use crate::generate::generate_video::providers::fal::veo_3p1_fast::build::build_fal_veo_3p1_fast; +use crate::generate::generate_video::providers::fal::veo_3p1_lite::build::build_fal_veo_3p1_lite; +use crate::generate::generate_video::providers::fal::vidu_q3::build::build_fal_vidu_q3; +use crate::generate::generate_video::providers::fal::vidu_q3_turbo::build::build_fal_vidu_q3_turbo; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::build::build_kinovi_seedance_2p0_fast; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::build::build_kinovi_seedance_2p0_mini; +use crate::generate::generate_video::providers::higgsfield::grok_imagine_1p5::build::build_higgsfield_grok_imagine_1p5; +use crate::generate::generate_video::providers::higgsfield::kling_3p0_pro::build::build_higgsfield_kling_3p0_pro; +use crate::generate::generate_video::providers::higgsfield::kling_3p0_standard::build::build_higgsfield_kling_3p0_standard; +use crate::generate::generate_video::providers::higgsfield::minimax_h3::build::build_higgsfield_minimax_h3; +use crate::generate::generate_video::providers::higgsfield::seedance_2p0::build::build_higgsfield_seedance_2p0; +use crate::generate::generate_video::providers::higgsfield::seedance_2p0_mini::build::build_higgsfield_seedance_2p0_mini; +use crate::generate::generate_video::providers::higgsfield::seedance_2p5::build::build_higgsfield_seedance_2p5; +use crate::generate::generate_video::providers::higgsfield::seedance_2p5_edit::build::build_higgsfield_seedance_2p5_edit; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +/// RouterProvider-agnostic video generation request. Distilled by `build2()` into a +/// `VideoGenerationDraftOrRequest` for the selected (provider, model) pair. +#[derive(Clone, Debug)] +pub struct GenerateVideoRequestBuilder { + /// Which model to use. + pub model: RouterVideoModel, + + /// Which provider to use. + pub provider: RouterProvider, + + /// The prompt for the video generation + pub prompt: Option, + + /// Some models support negative prompts + pub negative_prompt: Option, + + /// Starting keyframe (optional). + pub start_frame: Option, + + /// Ending keyframe (optional). + pub end_frame: Option, + + /// Reference images (optional). + pub reference_images: Option, + + /// Reference videos (optional). + pub reference_videos: Option, + + /// Reference audio (optional). + pub reference_audio: Option, + + /// Reference characters (optional). + pub reference_character_tokens: Option, + + /// The resolution to use + pub resolution: Option, + + /// The aspect ratio to use + pub aspect_ratio: Option, + + /// The output bitrate to use. + /// Not all models support this; models that don't simply ignore it. + pub bitrate: Option, + + /// How many seconds to generate. + pub duration_seconds: Option, + + /// How many videos to generate. + pub video_batch_count: Option, + + /// Whether to turn on/off audio. + /// Not all models support audio, not all models have a choice. + /// Some models will default this to true, others will default it to false, + /// so it's best to be explicit. + pub generate_audio: Option, + + /// If the request is a mismatch with the (model/provider), how to mitigate it. + pub request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy, + + /// Some providers support idempotency. + /// If not supplied, we'll generate one for the required providers. + pub idempotency_token: Option, +} + +impl Default for GenerateVideoRequestBuilder { + fn default() -> Self { + Self { + model: RouterVideoModel::Seedance2p0, + provider: RouterProvider::Artcraft, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + prompt: None, + negative_prompt: None, + start_frame: None, + end_frame: None, + reference_images: None, + reference_videos: None, + reference_audio: None, + reference_character_tokens: None, + resolution: None, + aspect_ratio: None, + bitrate: None, + duration_seconds: None, + video_batch_count: None, + generate_audio: None, + idempotency_token: None, + } + } +} + +impl GenerateVideoRequestBuilder { + + pub fn build2(self) -> Result { + match (self.provider, self.model) { + // Artcraft + (RouterProvider::Artcraft, RouterVideoModel::GrokImagineVideo) => build_artcraft_grok_imagine_video(self), + (RouterProvider::Artcraft, RouterVideoModel::GrokImagineVideo1p5) => build_artcraft_grok_imagine_video_1p5(self), + (RouterProvider::Artcraft, RouterVideoModel::HappyHorse1p0) => build_artcraft_happy_horse_1p0(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling16Pro) => build_artcraft_kling_1_6_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling21Master) => build_artcraft_kling_2_1_master(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling21Pro) => build_artcraft_kling_2_1_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling2p5TurboPro) => build_artcraft_kling_2_5_turbo_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling2p6Pro) => build_artcraft_kling_2_6_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling3p0Pro) => build_artcraft_kling_3p0_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Kling3p0Standard) => build_artcraft_kling_3p0_standard(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0) => build_artcraft_seedance_2p0(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0Fast) => build_artcraft_seedance_2p0_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0Ultra) => build_artcraft_seedance_2p0_u(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0UltraFast) => build_artcraft_seedance_2p0_u_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0BytePlus) => build_artcraft_seedance_2p0_bp(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0BytePlusFast) => build_artcraft_seedance_2p0_bp_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0BytePlusUltra) => build_artcraft_seedance_2p0_bpu(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0BytePlusUltraFast) => build_artcraft_seedance_2p0_bpu_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0Mini) => build_artcraft_seedance_2p0_mini(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0BytePlusMini) => build_artcraft_seedance_2p0_bp_mini(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance2p0BytePlusUltraMini) => build_artcraft_seedance_2p0_bpu_mini(self), + (RouterProvider::Artcraft, RouterVideoModel::PreviewModel) => build_artcraft_preview_model(self), + (RouterProvider::Artcraft, RouterVideoModel::PreviewModelFast) => build_artcraft_preview_model_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance10Lite) => build_artcraft_seedance_1p0_lite(self), + (RouterProvider::Artcraft, RouterVideoModel::Seedance1p5Pro) => build_artcraft_seedance_1p5_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Sora2) => build_artcraft_sora_2(self), + (RouterProvider::Artcraft, RouterVideoModel::Sora2Pro) => build_artcraft_sora_2_pro(self), + (RouterProvider::Artcraft, RouterVideoModel::Veo2) => build_artcraft_veo_2(self), + (RouterProvider::Artcraft, RouterVideoModel::Veo3) => build_artcraft_veo_3(self), + (RouterProvider::Artcraft, RouterVideoModel::Veo3Fast) => build_artcraft_veo_3_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Veo3p1) => build_artcraft_veo_3p1(self), + (RouterProvider::Artcraft, RouterVideoModel::Veo3p1Fast) => build_artcraft_veo_3p1_fast(self), + (RouterProvider::Artcraft, RouterVideoModel::Veo3p1Lite) => build_artcraft_veo_3p1_lite(self), + (RouterProvider::Artcraft, RouterVideoModel::ViduQ3) => build_artcraft_vidu_q3(self), + (RouterProvider::Artcraft, RouterVideoModel::ViduQ3Turbo) => build_artcraft_vidu_q3_turbo(self), + // Fal + (RouterProvider::Fal, RouterVideoModel::Kling16Pro) => build_fal_kling_1_6_pro(self), + (RouterProvider::Fal, RouterVideoModel::Kling21Master) => build_fal_kling_2_1_master(self), + (RouterProvider::Fal, RouterVideoModel::Kling21Pro) => build_fal_kling_2_1_pro(self), + (RouterProvider::Fal, RouterVideoModel::Kling2p5TurboPro) => build_fal_kling_2_5_turbo_pro(self), + (RouterProvider::Fal, RouterVideoModel::Kling2p6Pro) => build_fal_kling_2_6_pro(self), + (RouterProvider::Fal, RouterVideoModel::Kling3p0Pro) => build_fal_kling_3p0_pro(self), + (RouterProvider::Fal, RouterVideoModel::Kling3p0Standard) => build_fal_kling_3p0_standard(self), + (RouterProvider::Fal, RouterVideoModel::Seedance10Lite) => build_fal_seedance_1p0_lite(self), + (RouterProvider::Fal, RouterVideoModel::Seedance1p5Pro) => build_fal_seedance_1p5_pro(self), + (RouterProvider::Fal, RouterVideoModel::Sora2) => build_fal_sora_2(self), + (RouterProvider::Fal, RouterVideoModel::Sora2Pro) => build_fal_sora_2_pro(self), + (RouterProvider::Fal, RouterVideoModel::Veo2) => build_fal_veo_2(self), + (RouterProvider::Fal, RouterVideoModel::Veo3) => build_fal_veo_3(self), + (RouterProvider::Fal, RouterVideoModel::Veo3Fast) => build_fal_veo_3_fast(self), + (RouterProvider::Fal, RouterVideoModel::Veo3p1) => build_fal_veo_3p1(self), + (RouterProvider::Fal, RouterVideoModel::Veo3p1Fast) => build_fal_veo_3p1_fast(self), + (RouterProvider::Fal, RouterVideoModel::Veo3p1Lite) => build_fal_veo_3p1_lite(self), + (RouterProvider::Fal, RouterVideoModel::ViduQ3) => build_fal_vidu_q3(self), + (RouterProvider::Fal, RouterVideoModel::ViduQ3Turbo) => build_fal_vidu_q3_turbo(self), + // GmiCloud + (RouterProvider::GmiCloud, RouterVideoModel::Seedance2p0Ultra) => build_gmicloud_seedance_2p0_u(self), + (RouterProvider::GmiCloud, RouterVideoModel::Seedance2p0UltraFast) => build_gmicloud_seedance_2p0_u_fast(self), + // Grok + (RouterProvider::GrokApi, RouterVideoModel::GrokImagineVideo) => build_grok_api_grok_imagine_video(self), + (RouterProvider::GrokApi, RouterVideoModel::GrokImagineVideo1p5) => build_grok_api_grok_imagine_video_1p5(self), + // Kinovi + (RouterProvider::Seedance2Pro, RouterVideoModel::HappyHorse1p0) => build_kinovi_happy_horse_1p0(self), + (RouterProvider::Seedance2Pro, RouterVideoModel::Seedance2p0) => build_kinovi_seedance_2p0(self), + (RouterProvider::Seedance2Pro, RouterVideoModel::Seedance2p0Fast) => build_kinovi_seedance_2p0_fast(self), + (RouterProvider::Seedance2Pro, RouterVideoModel::Seedance2p0Mini) => build_kinovi_seedance_2p0_mini(self), + (RouterProvider::Seedance2Pro, RouterVideoModel::Seedance2p0BytePlusMini) => build_kinovi_seedance_2p0_mini(self), + (RouterProvider::Seedance2Pro, RouterVideoModel::Seedance2p0BytePlusUltraMini) => build_kinovi_seedance_2p0_mini(self), + // First-party (cookie-session) Higgsfield + (RouterProvider::Higgsfield, RouterVideoModel::Seedance2p5) => build_higgsfield_seedance_2p5(self), + (RouterProvider::Higgsfield, RouterVideoModel::Seedance2p5Edit) => build_higgsfield_seedance_2p5_edit(self), + (RouterProvider::Higgsfield, RouterVideoModel::Seedance2p0) => build_higgsfield_seedance_2p0(self), + (RouterProvider::Higgsfield, RouterVideoModel::Seedance2p0Mini) => build_higgsfield_seedance_2p0_mini(self), + (RouterProvider::Higgsfield, RouterVideoModel::MinimaxH3) => build_higgsfield_minimax_h3(self), + (RouterProvider::Higgsfield, RouterVideoModel::Kling3p0Standard) => build_higgsfield_kling_3p0_standard(self), + (RouterProvider::Higgsfield, RouterVideoModel::Kling3p0Pro) => build_higgsfield_kling_3p0_pro(self), + (RouterProvider::Higgsfield, RouterVideoModel::GrokImagineVideo1p5) => build_higgsfield_grok_imagine_1p5(self), + _ => self.unsupported_provider_and_model(), + } + } + + fn unsupported_provider_and_model(&self) -> Result { + Err(ArtcraftRouterError::UnsupportedProviderAndModelForNewApi( + format!("Video generation for model `{:?}` is not supported for provider {:?}", self.model, self.provider) + )) + } + + pub fn get_or_generate_idempotency_token(&self) -> String { + self.idempotency_token.clone() + .unwrap_or_else(|| uuid::Uuid::new_v4().to_string()) + } +} diff --git a/crates/router/src/generate/generate_video/generate_video_response.rs b/crates/router/src/generate/generate_video/generate_video_response.rs new file mode 100644 index 00000000..f3fcdf12 --- /dev/null +++ b/crates/router/src/generate/generate_video/generate_video_response.rs @@ -0,0 +1,126 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use artcraft_client::tokens::generic_inference_jobs::InferenceJobToken; + +#[derive(Clone, Debug)] +pub struct ArtcraftVideoResponsePayload { + pub inference_job_token: InferenceJobToken, + pub all_inference_job_tokens: Vec, +} + +#[derive(Clone, Debug)] +pub struct Seedance2proVideoResponsePayload { + pub order_id: String, + pub task_id: String, + pub maybe_order_ids: Option>, + pub maybe_task_ids: Option>, +} + +#[derive(Clone, Debug)] +pub struct FalVideoResponsePayload { + pub request_id: Option, + pub gateway_request_id: Option, + + /// Queue-mode status URL (fal's queue/polling flow). `None` for webhook + /// dispatch — the webhook callback drives status updates instead. + pub maybe_status_url: Option, + + /// Queue-mode response URL (fal's queue/polling flow). `None` for webhook + /// dispatch. + pub maybe_response_url: Option, + + /// The outbound request that was sent to Fal. + /// Stored as a trait object so any Request type can be captured. + /// Use `format!("{:?}", ...)` or `format!("{:#?}", ...)` to print. + pub maybe_outbound_request: Option>, +} + +#[derive(Clone, Debug)] +pub struct GmiCloudVideoResponsePayload { + pub request_id: String, +} + +#[derive(Clone, Debug)] +pub struct GrokVideoResponsePayload { + /// xAI request_id; poll with `grok_api_client::api::requests::videos::video_status` + /// to fetch the rendered video URL once it's ready. + pub request_id: String, + + /// The outbound request that was sent to Grok (xAI). + /// Stored as a trait object so any Request type can be captured. + /// Use `format!("{:?}", ...)` or `format!("{:#?}", ...)` to print. + pub maybe_outbound_request: Option>, +} + +/// Response from the first-party (cookie-session) Higgsfield provider. One +/// enqueue creates a job set with one job per requested video; the caller +/// polls the jobs (`HiggsfieldSession::job_status_batch`) by id. +#[derive(Clone, Debug)] +pub struct HiggsfieldVideoResponsePayload { + pub job_set_id: String, + /// In generation order; never empty. + pub job_ids: Vec, +} + +impl HiggsfieldVideoResponsePayload { + /// The first job, which stands in for the whole set as the task's + /// `provider_job_id`. + pub fn primary_job_id(&self) -> &str { + &self.job_ids[0] + } +} + +#[derive(Clone, Debug)] +pub enum GenerateVideoResponse { + Artcraft(ArtcraftVideoResponsePayload), + GmiCloud(GmiCloudVideoResponsePayload), + Grok(GrokVideoResponsePayload), + Higgsfield(HiggsfieldVideoResponsePayload), + Seedance2Pro(Seedance2proVideoResponsePayload), + Fal(FalVideoResponsePayload), +} + +impl GenerateVideoResponse { + pub fn get_artcraft_payload(&self) -> Option { + match self { + Self::Artcraft(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_seedance2pro_payload(&self) -> Option { + match self { + Self::Seedance2Pro(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_gmicloud_payload(&self) -> Option { + match self { + Self::GmiCloud(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_grok_payload(&self) -> Option { + match self { + Self::Grok(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_higgsfield_payload(&self) -> Option { + match self { + Self::Higgsfield(p) => Some(p.clone()), + _ => None, + } + } + + pub fn get_fal_payload(&self) -> Option { + match self { + Self::Fal(p) => Some(p.clone()), + _ => None, + } + } +} diff --git a/crates/router/src/generate/generate_video/mod.rs b/crates/router/src/generate/generate_video/mod.rs new file mode 100644 index 00000000..a0b3ddca --- /dev/null +++ b/crates/router/src/generate/generate_video/mod.rs @@ -0,0 +1,8 @@ +pub mod generate_video_request_builder; +pub mod generate_video_response; +pub mod providers; +pub mod video_generation_cost_estimate; +pub mod video_generation_draft; +pub mod video_generation_draft_context; +pub mod video_generation_draft_or_request; +pub mod video_generation_request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/build_common.rs b/crates/router/src/generate/generate_video/providers/artcraft/build_common.rs new file mode 100644 index 00000000..f899ff4c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/build_common.rs @@ -0,0 +1,314 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; +use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; +use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_bitrate::RouterBitrate; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::resolve::{ + resolve_audio_list_ref, resolve_character_list_ref, resolve_image_list_ref, + resolve_image_ref, resolve_video_list_ref, +}; + +/// Which output resolutions a model supports. +#[derive(Copy, Clone)] +pub enum SupportedResolutions { + /// 480p, 720p, 1080p + Full, + /// 480p, 720p, 1080p, 4K + FullWith4k, + /// 480p, 720p only (1080p downgrades to 720p) + Fast, + /// 720p, 1080p only (480p upgrades) + NoFourEightyP, +} + +/// Which aspect ratios a model supports for the 21:9 ultra-wide slot. +#[derive(Copy, Clone)] +pub enum UltraWideSupport { + /// 21:9 maps directly to WideTwentyOneByNine + Supported, + /// 21:9 is not a direct option; falls through to nearest_aspect_ratio + Unsupported, +} + +/// Build an `OmniGenVideoCostAndGenerateRequest` from the builder, using +/// model-specific configuration for the model enum variant, resolution +/// strategy, and ultra-wide aspect ratio support. +pub fn build_artcraft_omni_video_request( + mut builder: GenerateVideoRequestBuilder, + model: CommonVideoModelEnum, + resolutions: SupportedResolutions, + ultra_wide: UltraWideSupport, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy, ultra_wide)?; + let resolution = plan_output_resolution(builder.resolution.take(), strategy, resolutions)?; + let batch_count = plan_batch_count(builder.video_batch_count.take(), strategy)?; + let duration_seconds = plan_duration(builder.duration_seconds.take(), strategy)?; + let bitrate = plan_bitrate(builder.bitrate.take()); + let prompt = builder.prompt.take(); + + let start_frame = resolve_image_ref(builder.start_frame.take())?; + let end_frame = resolve_image_ref(builder.end_frame.take())?; + let reference_images = resolve_image_list_ref(builder.reference_images.take())?; + let reference_videos = resolve_video_list_ref(builder.reference_videos.take())?; + let reference_audio = resolve_audio_list_ref(builder.reference_audio.take())?; + let reference_characters = resolve_character_list_ref(builder.reference_character_tokens.take()); + let idempotency_token = builder.get_or_generate_idempotency_token(); + + Ok(OmniGenVideoCostAndGenerateRequest { + model: Some(model), + idempotency_token: Some(idempotency_token), + prompt, + start_frame_image_media_token: start_frame, + end_frame_image_media_token: end_frame, + reference_image_media_tokens: reference_images, + reference_video_media_tokens: reference_videos, + reference_audio_media_tokens: reference_audio, + reference_character_tokens: reference_characters, + resolution, + aspect_ratio, + bitrate, + duration_seconds: duration_seconds.map(|d| d as u16), + video_batch_count: Some(batch_count), + negative_prompt: None, + generate_audio: None, + quality: None, + }) +} + +// ── Plan helpers ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, + ultra_wide: UltraWideSupport, +) -> Result, ArtcraftRouterError> { + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(None), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Ok(Some(CommonAspectRatioEnum::WideSixteenByNine)) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Ok(Some(CommonAspectRatioEnum::TallNineBySixteen)) + } + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Ok(Some(CommonAspectRatioEnum::Square)) + } + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(CommonAspectRatioEnum::WideFourByThree)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(CommonAspectRatioEnum::TallThreeByFour)), + + Some(RouterAspectRatio::WideTwentyOneByNine) => match ultra_wide { + UltraWideSupport::Supported => Ok(Some(CommonAspectRatioEnum::WideTwentyOneByNine)), + UltraWideSupport::Unsupported => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", RouterAspectRatio::WideTwentyOneByNine), + })) + } + _ => Ok(Some(nearest_aspect_ratio(RouterAspectRatio::WideTwentyOneByNine))), + }, + }, + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(nearest_aspect_ratio(unsupported))) + } + }, + } +} + +fn nearest_aspect_ratio(aspect_ratio: RouterAspectRatio) -> CommonAspectRatioEnum { + match aspect_ratio { + RouterAspectRatio::WideFiveByFour => CommonAspectRatioEnum::WideFourByThree, + RouterAspectRatio::WideThreeByTwo => CommonAspectRatioEnum::WideFourByThree, + RouterAspectRatio::WideTwentyOneByNine => CommonAspectRatioEnum::WideSixteenByNine, + RouterAspectRatio::TallFourByFive => CommonAspectRatioEnum::TallThreeByFour, + RouterAspectRatio::TallTwoByThree => CommonAspectRatioEnum::TallThreeByFour, + RouterAspectRatio::TallNineByTwentyOne => CommonAspectRatioEnum::TallNineBySixteen, + _ => CommonAspectRatioEnum::Square, + } +} + +fn plan_output_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, + supported: SupportedResolutions, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + Some(RouterResolution::FourEightyP) => match supported { + SupportedResolutions::Full | SupportedResolutions::FullWith4k | SupportedResolutions::Fast => { + Ok(Some(CommonResolutionEnum::FourEightyP)) + } + SupportedResolutions::NoFourEightyP => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", RouterResolution::FourEightyP), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(CommonResolutionEnum::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(CommonResolutionEnum::SevenTwentyP)), + }, + }, + + Some(RouterResolution::SevenTwentyP) => Ok(Some(CommonResolutionEnum::SevenTwentyP)), + + Some(RouterResolution::TenEightyP) => match supported { + SupportedResolutions::Full | SupportedResolutions::FullWith4k | SupportedResolutions::NoFourEightyP => { + Ok(Some(CommonResolutionEnum::TenEightyP)) + } + SupportedResolutions::Fast => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", RouterResolution::TenEightyP), + })) + } + _ => Ok(Some(CommonResolutionEnum::SevenTwentyP)), + }, + }, + + // 4K is only available on models flagged `FullWith4k` (the non-Fast Seedance + // 2.0 family). Other models error out or fall back to their best resolution. + Some(RouterResolution::FourK) => match (supported, strategy) { + (SupportedResolutions::FullWith4k, _) => Ok(Some(CommonResolutionEnum::FourK)), + (_, RequestMismatchMitigationStrategy::ErrorOut) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", RouterResolution::FourK), + })) + } + (SupportedResolutions::Fast, _) => Ok(Some(CommonResolutionEnum::SevenTwentyP)), + (_, _) => Ok(Some(CommonResolutionEnum::TenEightyP)), + }, + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(match (unsupported, supported) { + (RouterResolution::HalfK, _) => CommonResolutionEnum::FourEightyP, + (_, SupportedResolutions::Fast) => CommonResolutionEnum::SevenTwentyP, + _ => CommonResolutionEnum::TenEightyP, + })) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(match (unsupported, supported) { + (RouterResolution::HalfK, _) => CommonResolutionEnum::FourEightyP, + (_, SupportedResolutions::Fast) => CommonResolutionEnum::SevenTwentyP, + _ => CommonResolutionEnum::TenEightyP, + })) + } + }, + } +} + +/// Batch counts: 1, 2, 4. +pub fn plan_batch_count( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = video_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 | 2 | 4 => Ok(count), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{}", count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(4), + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(if count < 4 { 2 } else { 4 }) + } + }, + } +} + +/// Translate the router-facing bitrate into the API `CommonBitrate`. +/// +/// Bitrate does not affect cost. An unset value leaves the field `None` (the +/// API applies its default); `Normal` and `High` map to their `CommonBitrate` +/// counterparts. +fn plan_bitrate(bitrate: Option) -> Option { + match bitrate { + None => None, + Some(RouterBitrate::Normal) => Some(CommonBitrateEnum::Normal), + Some(RouterBitrate::High) => Some(CommonBitrateEnum::High), + } +} + +/// Duration: 4-15 seconds. +pub fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + const MIN: u16 = 4; + const MAX: u16 = 15; + match duration_seconds { + None => Ok(None), + Some(d) if d >= MIN && d <= MAX => Ok(Some(d as u8)), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(Some(d.clamp(MIN, MAX) as u8)), + }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod bitrate_translation { + use super::*; + + #[test] + fn none_stays_none() { + assert_eq!(plan_bitrate(None), None); + } + + #[test] + fn normal_maps_to_common_normal() { + assert_eq!(plan_bitrate(Some(RouterBitrate::Normal)), Some(CommonBitrateEnum::Normal)); + } + + #[test] + fn high_maps_to_common_high() { + assert_eq!(plan_bitrate(Some(RouterBitrate::High)), Some(CommonBitrateEnum::High)); + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/build.rs new file mode 100644 index 00000000..ebfa7821 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/build.rs @@ -0,0 +1,180 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video::request::ArtcraftGrokImagineVideoRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Build an ArtCraft-routed Grok Imagine Video request. +/// +/// xAI's grok-imagine-video supports 480p and 720p (no 1080p — see +/// VideoResolution docs in grok_api_client), and does NOT have a 21:9 +/// ultra-wide aspect ratio. Hence `Fast` resolution support and +/// `Unsupported` ultra-wide. +pub fn build_artcraft_grok_imagine_video( + builder: GenerateVideoRequestBuilder, +) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::GrokImagineVideo, + SupportedResolutions::Fast, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftGrokImagineVideoRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftGrokImagineVideo(state), + )) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_grok_imagine_video() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::GrokImagineVideo))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + // SupportedResolutions::Fast caps at 720p (Grok Imagine doesn't render 1080p output). + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + // ArtCraft's omni endpoint requires media tokens — URLs are rejected + // (unlike the direct Grok provider, which is URL-only). + let result = build_artcraft_grok_imagine_video(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftGrokImagineVideoRequestState { + let result = build_artcraft_grok_imagine_video(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftGrokImagineVideo(state) + ) => state, + _ => panic!("expected ArtcraftGrokImagineVideo request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/cost.rs new file mode 100644 index 00000000..f72fa015 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/cost.rs @@ -0,0 +1,300 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video::request::ArtcraftGrokImagineVideoRequestState; + +// -- Pricing constants -- +// +// ArtCraft credits: 100 credits = $1.00. Credits always equal USD cents. +// +// We keep these as f64 because per-second rates are fractional; rounding +// happens once at the end after multiplying by duration * batch. + +const CENTS_PER_SECOND_480P: f64 = 6.5; +const CENTS_PER_SECOND_720P: f64 = 9.1; + +// Per-source-image surcharge. Kept as a separate term so it doesn't get +// lost in rounding when the per-second video cost is small. +const CENTS_PER_INPUT_IMAGE: f64 = 0.26; + +pub struct ArtcraftGrokImagineVideoCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub input_image_count: u64, +} + +impl ArtcraftGrokImagineVideoCostState { + pub fn from_request(request: &ArtcraftGrokImagineVideoRequestState) -> Self { + // Default duration is 8s when omitted, matching the upstream model's + // default — keeps cost estimates from reading 0 for under-specified + // requests. + let resolution = request.request.resolution.unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(8); + let batch_count = request.request.video_batch_count.unwrap_or(1); + + // Mirror grok_api_client's input-image counting: start_frame + reference_images. + let input_image_count = (request.request.start_frame_image_media_token.is_some() as u64) + + (request.request.reference_image_media_tokens + .as_ref() + .map(|v| v.len() as u64) + .unwrap_or(0)); + + Self { resolution, duration_seconds, batch_count, input_image_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + // Grok Imagine Video caps output at 720p; price anything else as 720p. + _ => CENTS_PER_SECOND_720P, + }; + + let video_cents = self.duration_seconds as f64 * cents_per_second * self.batch_count as f64; + // Input images are billed once, not per output in the batch. + let input_cents = self.input_image_count as f64 * CENTS_PER_INPUT_IMAGE; + + let usd_cents = (video_cents + input_cents).ceil() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + + // ── 720p pricing (9.1 ¢/s base × batch, ceil) ── + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + // 9.1 × 5 = 45.5 → 46 + // 9.1 × 10 = 91.0 → 91 + // 9.1 × 15 = 136.5 → 137 + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 46); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 91); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 137); + } + + #[test] + fn batch_2() { + // 9.1 × 5 × 2 = 91 → 91 + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 91); + // 9.1 × 15 × 2 = 273 → 273 + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 2), 273); + } + + #[test] + fn batch_4() { + // 9.1 × 5 × 4 = 182 → 182 + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 182); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!( + cost_cents(None, 5, 1), + cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), + ); + } + } + + // ── 480p pricing (6.5 ¢/s base × batch, ceil) ── + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + // 6.5 × 5 = 32.5 → 33 + // 6.5 × 10 = 65.0 → 65 + // 6.5 × 15 = 97.5 → 98 + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 33); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 65); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 98); + } + + #[test] + fn batch_2() { + // 6.5 × 5 × 2 = 65 → 65 + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 65); + } + + #[test] + fn batch_4() { + // 6.5 × 5 × 4 = 130 → 130 + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 130); + } + } + + // ── Input-image surcharge ── + + mod input_image_surcharge { + use super::*; + + #[test] + fn single_start_frame_adds_input_charge() { + // 720p 5s batch 1 = 45.5 + 0.26 (one start_frame) = 45.76 → ceil 46 + // Identical to the no-image case (45.5 → 46) because of ceil rounding. + let with_img = cost_cents_with_images(Some(RouterResolution::SevenTwentyP), 5, 1, true, 0); + let no_img = cost_cents_with_images(Some(RouterResolution::SevenTwentyP), 5, 1, false, 0); + assert_eq!(with_img, 46); + assert_eq!(no_img, 46); + } + + #[test] + fn many_reference_images_eventually_bump_a_cent() { + // 480p 4s batch 1 = 6.5 × 4 = 26 + 0.26 × N + // N=0 → 26 + // N=1 → 26.26 → 27 + // N=4 → 27.04 → 28 + assert_eq!(cost_cents_with_images(Some(RouterResolution::FourEightyP), 4, 1, false, 0), 26); + assert_eq!(cost_cents_with_images(Some(RouterResolution::FourEightyP), 4, 1, false, 1), 27); + assert_eq!(cost_cents_with_images(Some(RouterResolution::FourEightyP), 4, 1, false, 4), 28); + } + } + + // ── Relative pricing ── + + mod relative_pricing { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 10, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + assert!(c480 < c720, "480p ({c480}) should be cheaper than 720p ({c720})"); + } + + #[test] + fn cost_scales_with_duration() { + let c5 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1); + assert!(c5 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let b2 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2); + let b4 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // ── Credits equal cents ── + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + None, + ]; + for res in resolutions { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents for res={:?} dur={}s batch={}", + res, dur, batch, + ); + } + } + } + } + } + + // ── Helpers ── + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .unwrap() + } + + fn cost_cents_with_images( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + has_start_frame: bool, + extra_reference_images: usize, + ) -> u64 { + let start_frame = if has_start_frame { + Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_start".to_string()))) + } else { None }; + let reference_images = if extra_reference_images > 0 { + Some(ImageListRef::MediaFileTokens( + (0..extra_reference_images) + .map(|i| MediaFileToken::new(format!("mf_ref_{i}"))) + .collect(), + )) + } else { None }; + + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + start_frame, + reference_images, + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/request.rs new file mode 100644 index 00000000..8191c128 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftGrokImagineVideoRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftGrokImagineVideoRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/build.rs new file mode 100644 index 00000000..feb845c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/build.rs @@ -0,0 +1,196 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video_1p5::request::ArtcraftGrokImagineVideo1p5RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Build an ArtCraft-routed Grok Imagine Video 1.5 preview request. +/// +/// Same constraints as the v1 variant — xAI v1.5 still supports only 480p +/// and 720p and no 21:9 ultra-wide. The on-wire model identifier is +/// `grok-imagine-video-1.5`; the cost calculator in +/// [`super::cost`] keys off that to apply the v1.5 pricing tier (with a 5% +/// ArtCraft markup on top of the upstream rates). +pub fn build_artcraft_grok_imagine_video_1p5( + builder: GenerateVideoRequestBuilder, +) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::GrokImagineVideo1p5, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + + // NB: xAI's v1.5 model rejects text-to-video at the server, but that is + // NOT enforced here — the cost path builds image-less requests to price + // them while the user is still composing. The generate endpoints reject + // image-less v1.5 requests at the handler layer (validate_when_image_required). + let state = ArtcraftGrokImagineVideo1p5RequestState { request }; + + Ok(VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftGrokImagineVideo1p5(state), + )) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_grok_imagine_video_1p5() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::GrokImagineVideo1p5))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_is_supported() { + // Grok Imagine 1.5 produces genuine 1080p output. + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn builds_without_any_image_inputs() { + // The cost path prices image-less requests while the user is still + // composing; the generate endpoints enforce the image requirement. + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.start_frame_image_media_token.is_none()); + assert!(req.request.reference_image_media_tokens.is_none()); + } + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + // ArtCraft's omni endpoint requires media tokens — URLs are rejected + // (unlike the direct Grok provider, which is URL-only). + let result = build_artcraft_grok_imagine_video_1p5(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftGrokImagineVideo1p5RequestState { + let result = build_artcraft_grok_imagine_video_1p5(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftGrokImagineVideo1p5(state) + ) => state, + _ => panic!("expected ArtcraftGrokImagineVideo1p5 request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/cost.rs new file mode 100644 index 00000000..e57af8bb --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/cost.rs @@ -0,0 +1,417 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use grok_api_client::api::requests::videos::video_generation::video_generation::{ + VideoGenerationRequest as GrokVideoGenerationRequest, + VideoImageSource as GrokVideoImageSource, +}; +use grok_api_client::api::traits::grok_request_cost_calculator_trait::GrokRequestCostCalculator; +use grok_api_client::api::types::video_types::video_model::VideoModel as GrokVideoModel; +use grok_api_client::api::types::video_types::video_resolution::VideoResolution as GrokResolution; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video_1p5::request::ArtcraftGrokImagineVideo1p5RequestState; + +// ── Markup ── +// +// ArtCraft adds a modest 5% markup over the underlying xAI v1.5 pricing. The +// markup is applied at cent granularity with ceiling rounding so the final +// charge always covers the upstream cost (we never bill the user less than +// the cost of the API call we forwarded). +const MARKUP_NUMERATOR: u64 = 105; +const MARKUP_DENOMINATOR: u64 = 100; + +pub struct ArtcraftGrokImagineVideo1p5CostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub input_image_count: u64, +} + +impl ArtcraftGrokImagineVideo1p5CostState { + pub fn from_request(request: &ArtcraftGrokImagineVideo1p5RequestState) -> Self { + let resolution = request.request.resolution.unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(8); + let batch_count = request.request.video_batch_count.unwrap_or(1); + + // Mirror grok_api_client's input-image counting: start_frame + reference_images. + let input_image_count = (request.request.start_frame_image_media_token.is_some() as u64) + + (request.request.reference_image_media_tokens + .as_ref() + .map(|v| v.len() as u64) + .unwrap_or(0)); + + Self { resolution, duration_seconds, batch_count, input_image_count } + } + + /// Base cost in cents for a single video at this state's resolution, + /// duration, and input-image count. Computed via grok_api_client's + /// official cost calculator (with the model pinned to the v1.5 preview), + /// so this number tracks upstream pricing automatically and never drifts + /// from what xAI bills. + /// + /// Does NOT include the per-batch multiplier and does NOT include the + /// ArtCraft markup. Used by tests to assert parity with grok_api_client. + pub fn base_cost_in_cents_for_one_video(&self) -> u64 { + self.build_equivalent_grok_request().calculate_cost_in_cents() + } + + /// Total base cost (across the batch) in cents, before markup. + /// Each video in the batch costs [`Self::base_cost_in_cents_for_one_video`]. + pub fn base_cost_in_cents_for_batch(&self) -> u64 { + self.base_cost_in_cents_for_one_video() + .saturating_mul(self.batch_count as u64) + } + + pub fn estimate_cost(&self) -> Result { + // NB: Image-less requests DO get a quote even though xAI's v1.5 rejects + // text-to-video — the cost path prices requests the user is still + // composing. The image requirement is enforced at send time (request.rs) + // and by the generate endpoints. + let base = self.base_cost_in_cents_for_batch(); + // 5% markup, ceil so the user is always charged enough to cover the + // upstream grok cost regardless of rounding. + let usd_cents = base.saturating_mul(MARKUP_NUMERATOR).div_ceil(MARKUP_DENOMINATOR); + + Ok(VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + }) + } + + /// Build a `GrokVideoGenerationRequest` whose pricing-relevant fields + /// exactly mirror this cost state, so the grok_api_client calculator + /// produces the same number ArtCraft would owe for one video. Non-pricing + /// fields (prompt, aspect_ratio, user) are left empty — they don't affect + /// cost. + fn build_equivalent_grok_request(&self) -> GrokVideoGenerationRequest { + let resolution = Some(match self.resolution { + CommonResolution::FourEightyP => GrokResolution::FourEightyP, + CommonResolution::TenEightyP => GrokResolution::TenEightyP, + // Grok Imagine 1.5 tops out at 1080p (the build step downgrades higher + // tiers via SupportedResolutions::Full); price anything else as 720p. + _ => GrokResolution::SevenTwentyP, + }); + + // Grok's calculator only counts the TOTAL number of input images — it + // doesn't care how they're split between `image` and `reference_images` + // — so we put one in `image` (if any) and the rest in `reference_images`. + let image = (self.input_image_count >= 1) + .then(|| GrokVideoImageSource::Url(String::new())); + let reference_images = if self.input_image_count >= 2 { + Some( + (1..self.input_image_count) + .map(|_| GrokVideoImageSource::Url(String::new())) + .collect() + ) + } else { None }; + + GrokVideoGenerationRequest { + prompt: String::new(), + model: Some(GrokVideoModel::GrokImagineVideo1p5), + image, + reference_images, + aspect_ratio: None, + duration: Some(self.duration_seconds as u32), + resolution, + user: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + + // ── Markup correctness ───────────────────────────────────────────────── + + mod markup { + use super::*; + + #[test] + fn estimate_cost_equals_ceil_of_base_times_1p05() { + for &(res, dur, imgs, batch) in MARKUP_CASES { + let state = artcraft_state(res, dur, imgs, batch); + let base = state.base_cost_in_cents_for_batch(); + let want = base.saturating_mul(MARKUP_NUMERATOR).div_ceil(MARKUP_DENOMINATOR); + let got = state.estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert_eq!( + got, want, + "res={res:?} dur={dur} imgs={imgs} batch={batch} base={base}", + ); + } + } + + #[test] + fn final_cost_is_always_at_least_base() { + for &(res, dur, imgs, batch) in MARKUP_CASES { + let state = artcraft_state(res, dur, imgs, batch); + let base = state.base_cost_in_cents_for_batch(); + let final_ = state.estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert!( + final_ >= base, + "final {final_}¢ < base {base}¢ at res={res:?} dur={dur} imgs={imgs} batch={batch}", + ); + } + } + + #[test] + fn known_value_at_720p_5s_batch_1() { + // grok v1.5 720p × 5s + 1 image = 700 + 10 = 710 mills = 71¢ + // 71 × 1.05 = 74.55 → ceil = 75¢ + let state = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 1); + assert_eq!(state.base_cost_in_cents_for_one_video(), 71); + assert_eq!(state.estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(), 75); + } + + #[test] + fn known_value_at_480p_5s_batch_1() { + // grok v1.5 480p × 5s + 1 image = 400 + 10 = 410 mills = 41¢ + // 41 × 1.05 = 43.05 → ceil = 44¢ + let state = artcraft_state(Some(RouterResolution::FourEightyP), 5, 1, 1); + assert_eq!(state.base_cost_in_cents_for_one_video(), 41); + assert_eq!(state.estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(), 44); + } + + #[test] + fn known_value_at_720p_5s_batch_2() { + // base per video at 720p 5s + 1 image = 71¢. Batch 2 = 142¢. + // 142 × 1.05 = 149.1 → ceil 150¢. + let state = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 2); + assert_eq!(state.base_cost_in_cents_for_batch(), 142); + assert_eq!(state.estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(), 150); + } + + /// v1.5 doesn't support text-to-video at generation time, but the cost + /// calculator still quotes an image-less request — the cost UI prices + /// requests before the user has attached an image. The requirement is + /// enforced at send time and by the generate endpoints. + #[test] + fn estimate_cost_quotes_text_only_request() { + let state = ArtcraftGrokImagineVideo1p5CostState { + resolution: CommonResolution::SevenTwentyP, + duration_seconds: 5, + batch_count: 1, + input_image_count: 0, + }; + let base = state.base_cost_in_cents_for_batch(); + let want = base.saturating_mul(MARKUP_NUMERATOR).div_ceil(MARKUP_DENOMINATOR); + let got = state.estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert_eq!(got, want); + assert!(got > 0); + } + + // (resolution, duration, image_count, batch) — every case has at least + // one image since v1.5 rejects text-to-video. + const MARKUP_CASES: &[(Option, u16, u64, u16)] = &[ + (Some(RouterResolution::FourEightyP), 5, 1, 1), + (Some(RouterResolution::FourEightyP), 5, 1, 2), + (Some(RouterResolution::FourEightyP), 5, 1, 4), + (Some(RouterResolution::FourEightyP), 8, 1, 1), + (Some(RouterResolution::FourEightyP), 15, 1, 1), + (Some(RouterResolution::FourEightyP), 5, 3, 1), + (Some(RouterResolution::SevenTwentyP), 5, 1, 1), + (Some(RouterResolution::SevenTwentyP), 5, 1, 2), + (Some(RouterResolution::SevenTwentyP), 5, 1, 4), + (Some(RouterResolution::SevenTwentyP), 8, 1, 1), + (Some(RouterResolution::SevenTwentyP), 15, 1, 1), + (Some(RouterResolution::SevenTwentyP), 5, 3, 1), + (None, 5, 1, 1), + ]; + } + + // ── Relative pricing / monotonicity sanity ───────────────────────────── + + mod monotonicity { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let p480 = artcraft_state(Some(RouterResolution::FourEightyP), 5, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + let p720 = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert!(p480 < p720, "480p ({p480}¢) should be < 720p ({p720}¢)"); + } + + #[test] + fn longer_duration_costs_more() { + let c5 = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + let c10 = artcraft_state(Some(RouterResolution::SevenTwentyP), 10, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + let c15 = artcraft_state(Some(RouterResolution::SevenTwentyP), 15, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert!(c5 < c10); + assert!(c10 < c15); + } + + #[test] + fn more_images_cost_more_or_equal() { + // Each image is +10 mills = +1¢ before markup, so additional images + // monotonically increase cost. + let one = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + let three = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 3, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert!(one < three, "one={one}¢ vs three={three}¢"); + } + + #[test] + fn more_batch_costs_more() { + let b1 = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 1) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + let b4 = artcraft_state(Some(RouterResolution::SevenTwentyP), 5, 1, 4) + .estimate_cost().expect("estimate_cost").cost_in_usd_cents.unwrap(); + assert!(b1 < b4); + } + } + + // ── End-to-end through the public builder API ────────────────────────── + + mod end_to_end { + use super::*; + + #[test] + fn credits_equal_usd_cents() { + // ArtCraft credits == USD cents, as in the v1 module. + let resolutions = [ + None, + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), // clamps to 720p + ]; + for res in resolutions { + for dur in [4u16, 5, 10, 15] { + for batch in [1u16, 2, 4] { + let cost = build_cost_via_builder(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents at res={res:?} dur={dur}s batch={batch}", + ); + } + } + } + } + + #[test] + fn ten_eighty_p_prices_higher_than_720p() { + // Grok Imagine 1.5 now renders genuine 1080p ($0.25/s vs $0.14/s @ 720p). + let p1080 = build_cost_via_builder(Some(RouterResolution::TenEightyP), 10, 1) + .cost_in_usd_cents.unwrap(); + let p720 = build_cost_via_builder(Some(RouterResolution::SevenTwentyP), 10, 1) + .cost_in_usd_cents.unwrap(); + assert!(p1080 > p720, "1080p ({p1080}) should cost more than 720p ({p720})"); + } + + /// Regression: an image-less v1.5 request must get a quote through the + /// full public builder path (build2 → estimate_cost). The cost UI polls + /// for a price before the user has attached an image; the image + /// requirement is enforced at send time and by the generate endpoints, + /// NOT here. + #[test] + fn image_less_request_gets_a_quote_through_the_builder() { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + let cost = builder.build2() + .expect("build2 should succeed without an image") + .estimate_cost() + .expect("estimate_cost should succeed without an image"); + assert!(cost.cost_in_usd_cents.unwrap() > 0); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + + // ── Helpers ──────────────────────────────────────────────────────────── + + fn artcraft_state( + resolution: Option, + duration_seconds: u16, + input_image_count: u64, + batch_count: u16, + ) -> ArtcraftGrokImagineVideo1p5CostState { + // Build a state directly from a synthesized request — avoids the full + // build2() pipeline so we can construct arbitrary image counts without + // worrying about builder validation rules. + let state = unwrap_request_via_builder(resolution, duration_seconds, input_image_count, batch_count); + ArtcraftGrokImagineVideo1p5CostState::from_request(&state) + } + + fn unwrap_request_via_builder( + resolution: Option, + duration_seconds: u16, + input_image_count: u64, + batch_count: u16, + ) -> ArtcraftGrokImagineVideo1p5RequestState { + // Split input_image_count into start_frame (1 if any) + reference_images (the rest), + // mirroring how `from_request` counts source images. + let start_frame = if input_image_count >= 1 { + Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_start".to_string()))) + } else { None }; + let reference_images = if input_image_count >= 2 { + Some(ImageListRef::MediaFileTokens( + (1..input_image_count).map(|i| MediaFileToken::new(format!("mf_ref_{i}"))).collect(), + )) + } else { None }; + + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(batch_count), + start_frame, + reference_images, + ..Default::default() + }; + let result = builder.build2().expect("build2 should succeed"); + match result { + crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest::Request( + crate::generate::generate_video::video_generation_request::VideoGenerationRequest::ArtcraftGrokImagineVideo1p5(s) + ) => s, + _ => panic!("expected ArtcraftGrokImagineVideo1p5 request"), + } + } + + fn build_cost_via_builder( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + // These cases price the image-to-video tier (one input image). + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_default".to_string()))), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/request.rs new file mode 100644 index 00000000..58f64a65 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/grok_imagine_video_1p5/request.rs @@ -0,0 +1,84 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftGrokImagineVideo1p5RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftGrokImagineVideo1p5RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + // xAI's v1.5 model rejects text-to-video at the server. This is the + // GENERATION-time guard — `build()` and `estimate_cost()` deliberately + // allow image-less states so the cost path can quote a request the user + // is still composing. Bouncing here costs nothing and avoids an upstream + // call we know will fail. + if self.request.start_frame_image_media_token.is_none() + && self.request.reference_image_media_tokens.as_ref().map_or(true, |v| v.is_empty()) + { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "text-to-video isn't supported by grok-imagine-video-1.5; supply a start_frame or at least one reference image".to_string(), + })); + } + + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + + use super::*; + + /// Generation must never reach xAI with an image-less v1.5 request. The + /// build/cost layers allow that state (the cost path quotes it), so the + /// send-time guard is the router's last line of defense. + #[tokio::test] + async fn send_rejects_image_less_request_before_any_network_call() { + let state = ArtcraftGrokImagineVideo1p5RequestState { + request: OmniGenVideoCostAndGenerateRequest { + idempotency_token: Some("a1b2c3d4-e5f6-7890-abcd-ef1234567890".to_string()), + model: Some(CommonVideoModelEnum::GrokImagineVideo1p5), + prompt: Some("a corgi running through a field".to_string()), + negative_prompt: None, + start_frame_image_media_token: None, + end_frame_image_media_token: None, + reference_image_media_tokens: None, + reference_video_media_tokens: None, + reference_audio_media_tokens: None, + reference_character_tokens: None, + resolution: None, + aspect_ratio: None, + bitrate: None, + quality: None, + duration_seconds: Some(5), + video_batch_count: Some(1), + generate_audio: None, + }, + }; + + // The guard fires before the client is used, so an unroutable localhost + // client with empty credentials proves no network call happens. + let client = RouterArtcraftClient::new( + ApiHost::Localhost { port: 1 }, + StorytellerCredentialSet::empty(), + ); + + let err = state.send(&client).await.expect_err("image-less send should be rejected"); + match err { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field, .. }) => { + assert_eq!(field, "image_inputs"); + } + other => panic!("expected Client(ModelDoesNotSupportOption), got {:?}", other), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/build.rs new file mode 100644 index 00000000..c2bff11e --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/build.rs @@ -0,0 +1,170 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::happy_horse_1p0::request::ArtcraftHappyHorse1p0RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_happy_horse_1p0(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::HappyHorse1p0, + SupportedResolutions::NoFourEightyP, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftHappyHorse1p0RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftHappyHorse1p0(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_happy_horse_1p0() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::HappyHorse1p0))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + + #[test] + fn unsupported_480p_upgrades() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_happy_horse_1p0(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: crate::api::router_video_model::RouterVideoModel::HappyHorse1p0, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftHappyHorse1p0RequestState { + let result = build_artcraft_happy_horse_1p0(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftHappyHorse1p0(state) + ) => state, + _ => panic!("expected ArtcraftHappyHorse1p0 request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/cost.rs new file mode 100644 index 00000000..e4f7ff30 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/cost.rs @@ -0,0 +1,237 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::happy_horse_1p0::request::ArtcraftHappyHorse1p0RequestState; + +// ── Pricing ── +// +// Happy Horse 1.0 upstream credit pricing: +// +// | Resolution | Credits/sec | +// |------------|-------------| +// | 720p | 33 | +// | 1080p | 66 | +// +// Default resolution (None) is 720p. +// Batch count multiplies the total cost. +// Credit package (historical): 22,000 credits for $114 (~193 credits/$1). +// The upstream package is now 525,000 credits for $2,159.0909 (~243 credits/$1), +// but user pricing is intentionally kept at the 193-derived rates. +// +// ArtCraft credits: 100 credits = $1.00, so ArtCraft credits = USD cents. +// We compute USD cents from upstream credits ÷ credits_per_dollar × 100. + +const UPSTREAM_CREDITS_PER_SECOND_720P: u32 = 33; +const UPSTREAM_CREDITS_PER_SECOND_1080P: u32 = 66; +// Frozen at the historical rate so user pricing doesn't shift with the package deal. +const UPSTREAM_CREDITS_PER_DOLLAR: f64 = 193.0; + +pub struct ArtcraftHappyHorse1p0CostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, +} + +impl ArtcraftHappyHorse1p0CostState { + pub fn from_request(request: &ArtcraftHappyHorse1p0RequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + + Self { resolution, duration_seconds, batch_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let credits_per_second = match self.resolution { + CommonResolution::TenEightyP => UPSTREAM_CREDITS_PER_SECOND_1080P, + _ => UPSTREAM_CREDITS_PER_SECOND_720P, + }; + + let upstream_credits = credits_per_second as u64 + * self.duration_seconds as u64 + * self.batch_count as u64; + + let usd_cents = (upstream_credits as f64 / UPSTREAM_CREDITS_PER_DOLLAR * 100.0).round() as u64; + + // ArtCraft credits = USD cents. + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // ── 720p pricing (33 upstream credits/sec) ── + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + // 33 credits/sec; upstream_credits / 193 * 100 + // (NB: duration 3s is clamped to 4s by the builder) + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 68); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 85); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 171); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 256); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 171); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 342); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + // ── 1080p pricing (66 upstream credits/sec) ── + + mod pricing_1080p { + use super::*; + + #[test] + fn batch_1() { + // 66 credits/sec; upstream_credits / 193 * 100 + // (NB: duration 3s is clamped to 4s by the builder) + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 4, 1), 137); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 1), 171); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 1), 342); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15, 1), 513); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 2), 342); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 4), 684); + } + } + + // ── Relative pricing ── + + mod relative_pricing { + use super::*; + + #[test] + fn cost_720p_cheaper_than_1080p() { + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + assert!(c720 < c1080); + } + + #[test] + fn r1080p_approximately_double_720p() { + // 1080p upstream credits are exactly 2× 720p, but USD cents may differ + // by ±1 due to rounding (each is rounded independently). + for dur in [4u16, 5, 10, 15] { + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), dur, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), dur, 1); + let expected = c720 * 2; + assert!( + c1080 >= expected - 1 && c1080 <= expected + 1, + "1080p ({}) should be ~2× 720p ({}) at {}s", c1080, c720, dur, + ); + } + } + + #[test] + fn cost_scales_with_duration() { + let c4 = cost_cents(None, 4, 1); + let c10 = cost_cents(None, 10, 1); + let c15 = cost_cents(None, 15, 1); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(None, 5, 1); + let b2 = cost_cents(None, 5, 2); + let b4 = cost_cents(None, 5, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // ── Credits equal cents ── + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents() { + let resolutions = [ + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + None, + ]; + for res in resolutions { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents for res={:?} dur={}s batch={}", + res, dur, batch, + ); + } + } + } + } + } + + // ── Helpers ── + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::HappyHorse1p0, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/request.rs new file mode 100644 index 00000000..6249a524 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/happy_horse_1p0/request.rs @@ -0,0 +1,178 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftHappyHorse1p0RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftHappyHorse1p0RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use test_data::web::image_media_tokens::JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN; + + mod aspect_ratio_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn landscape() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn portrait() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A cat sitting on a windowsill watching rain.".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn square() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A hummingbird hovering near a flower.".to_string()), + aspect_ratio: Some(RouterAspectRatio::Square), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + mod resolution_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn res_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A golden retriever catching a frisbee on the beach.".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn res_1080p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A fox walking through a snowy forest.".to_string()), + resolution: Some(RouterResolution::TenEightyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + mod modality_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A whale breaching in the open ocean at dawn, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn keyframe_start_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog watches the lake as the sun sets.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // ── Helpers ── + + fn artcraft_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::HappyHorse1p0, + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/build.rs new file mode 100644 index 00000000..1d861199 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/build.rs @@ -0,0 +1,88 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_1_6_pro::request::ArtcraftKling16ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_1_6_pro(mut builder: GenerateVideoRequestBuilder) -> Result { + // Kling 1.6 Pro serves only {5, 10} seconds. Pre-plan the duration with the + // SAME normalization the dispatching provider uses, so the billed duration + // always matches the generated one. + let strategy = builder.request_mismatch_mitigation_strategy; + builder.duration_seconds = plan_kling_1_6_pro_duration(builder.duration_seconds, strategy)?; + + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling16Pro, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftKling16ProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling16Pro(state))) +} + +/// Mirrors the Fal-side `plan_duration` for Kling 1.6 Pro: unsupported +/// durations upgrade to 10s (PayMoreUpgrade) or downgrade to 5s +/// (PayLessDowngrade). +fn plan_kling_1_6_pro_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) | Some(10) => Ok(duration_seconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(10)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(5)), + }, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod duration_planning { + use super::*; + + #[test] + fn supported_durations_pass_through() { + let s = RequestMismatchMitigationStrategy::PayMoreUpgrade; + assert_eq!(plan_kling_1_6_pro_duration(None, s).unwrap(), None); + assert_eq!(plan_kling_1_6_pro_duration(Some(5), s).unwrap(), Some(5)); + assert_eq!(plan_kling_1_6_pro_duration(Some(10), s).unwrap(), Some(10)); + } + + #[test] + fn unsupported_duration_upgrades_to_ten() { + let s = RequestMismatchMitigationStrategy::PayMoreUpgrade; + assert_eq!(plan_kling_1_6_pro_duration(Some(4), s).unwrap(), Some(10)); + assert_eq!(plan_kling_1_6_pro_duration(Some(7), s).unwrap(), Some(10)); + } + + #[test] + fn unsupported_duration_downgrades_to_five() { + let s = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(plan_kling_1_6_pro_duration(Some(4), s).unwrap(), Some(5)); + } + + #[test] + fn unsupported_duration_errors_in_strict_mode() { + let s = RequestMismatchMitigationStrategy::ErrorOut; + assert!(plan_kling_1_6_pro_duration(Some(4), s).is_err()); + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/cost.rs new file mode 100644 index 00000000..794e4f67 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/cost.rs @@ -0,0 +1,61 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_1_6_pro::request::ArtcraftKling16ProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling16ProCostState { + pub is_ten_seconds: bool, +} + +impl ArtcraftKling16ProCostState { + pub fn from_request(request: &ArtcraftKling16ProRequestState) -> Self { + Self { + // Default duration is 5s (None → 5s) per v1 plan. + is_ten_seconds: request.request.duration_seconds == Some(10), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // 5s = 52¢, 10s = 103¢. + let cost_in_usd_cents: u64 = if self.is_ten_seconds { 103 } else { 52 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling16Pro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn five_seconds_is_52() { assert_eq!(cost_cents(Some(5)), 52); } + + #[test] + fn ten_seconds_is_103() { assert_eq!(cost_cents(Some(10)), 103); } + + #[test] + fn default_duration_is_5s_priced_at_52() { assert_eq!(cost_cents(None), 52); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/request.rs new file mode 100644 index 00000000..dbd88525 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_1_6_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling16ProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling16ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/build.rs new file mode 100644 index 00000000..78c38ac2 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/build.rs @@ -0,0 +1,21 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_2_1_master::request::ArtcraftKling21MasterRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_2_1_master(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling21Master, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftKling21MasterRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling21Master(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/cost.rs new file mode 100644 index 00000000..8e58c95c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/cost.rs @@ -0,0 +1,58 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_2_1_master::request::ArtcraftKling21MasterRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling21MasterCostState { + pub is_ten_seconds: bool, +} + +impl ArtcraftKling21MasterCostState { + pub fn from_request(request: &ArtcraftKling21MasterRequestState) -> Self { + Self { is_ten_seconds: request.request.duration_seconds == Some(10) } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_v2p1_master: 5s = $1.40, 10s = $2.80. + let cost_in_usd_cents: u64 = if self.is_ten_seconds { 280 } else { 140 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling21Master, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn five_seconds_is_140() { assert_eq!(cost_cents(Some(5)), 140); } + + #[test] + fn ten_seconds_is_280() { assert_eq!(cost_cents(Some(10)), 280); } + + #[test] + fn default_duration_is_5s_priced_at_140() { assert_eq!(cost_cents(None), 140); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/request.rs new file mode 100644 index 00000000..5dbece29 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_master/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling21MasterRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling21MasterRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/build.rs new file mode 100644 index 00000000..0457776f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/build.rs @@ -0,0 +1,21 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_2_1_pro::request::ArtcraftKling21ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_2_1_pro(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling21Pro, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftKling21ProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling21Pro(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/cost.rs new file mode 100644 index 00000000..9c6d0dcc --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/cost.rs @@ -0,0 +1,58 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_2_1_pro::request::ArtcraftKling21ProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling21ProCostState { + pub is_ten_seconds: bool, +} + +impl ArtcraftKling21ProCostState { + pub fn from_request(request: &ArtcraftKling21ProRequestState) -> Self { + Self { is_ten_seconds: request.request.duration_seconds == Some(10) } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_v2p1_pro: 5s = 45¢, 10s = 90¢. + let cost_in_usd_cents: u64 = if self.is_ten_seconds { 90 } else { 45 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling21Pro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn five_seconds_is_45() { assert_eq!(cost_cents(Some(5)), 45); } + + #[test] + fn ten_seconds_is_90() { assert_eq!(cost_cents(Some(10)), 90); } + + #[test] + fn default_duration_is_5s_priced_at_45() { assert_eq!(cost_cents(None), 45); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/request.rs new file mode 100644 index 00000000..ba70d5ff --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_1_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling21ProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling21ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/build.rs new file mode 100644 index 00000000..d73961b1 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/build.rs @@ -0,0 +1,21 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_2_5_turbo_pro::request::ArtcraftKling2p5TurboProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_2_5_turbo_pro(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling2p5TurboPro, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftKling2p5TurboProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling2p5TurboPro(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/cost.rs new file mode 100644 index 00000000..8e2290a8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/cost.rs @@ -0,0 +1,55 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_2_5_turbo_pro::request::ArtcraftKling2p5TurboProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling2p5TurboProCostState { + pub is_ten_seconds: bool, +} + +impl ArtcraftKling2p5TurboProCostState { + pub fn from_request(request: &ArtcraftKling2p5TurboProRequestState) -> Self { + Self { is_ten_seconds: request.request.duration_seconds == Some(10) } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_v2p5_turbo_pro: 5s = 35¢, 10s = 70¢. + let cost_in_usd_cents: u64 = if self.is_ten_seconds { 70 } else { 35 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling2p5TurboPro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn five_seconds_is_35() { assert_eq!(cost_cents(Some(5)), 35); } + + #[test] + fn ten_seconds_is_70() { assert_eq!(cost_cents(Some(10)), 70); } + + #[test] + fn default_duration_is_5s_priced_at_35() { assert_eq!(cost_cents(None), 35); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/request.rs new file mode 100644 index 00000000..c7ca3750 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_5_turbo_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling2p5TurboProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling2p5TurboProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/build.rs new file mode 100644 index 00000000..3aba7c0f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/build.rs @@ -0,0 +1,26 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_2_6_pro::request::ArtcraftKling2p6ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_2_6_pro(builder: GenerateVideoRequestBuilder) -> Result { + // Kling 2.6 Pro supports `generate_audio` — preserve it so cost can read it back. + // build_artcraft_omni_request hardcodes generate_audio = None on its output, + // so we extract before, build, then restore. + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling2p6Pro, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + let state = ArtcraftKling2p6ProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling2p6Pro(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/cost.rs new file mode 100644 index 00000000..5018020d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/cost.rs @@ -0,0 +1,76 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_2_6_pro::request::ArtcraftKling2p6ProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling2p6ProCostState { + pub is_ten_seconds: bool, + pub generate_audio: bool, +} + +impl ArtcraftKling2p6ProCostState { + pub fn from_request(request: &ArtcraftKling2p6ProRequestState) -> Self { + Self { + is_ten_seconds: request.request.duration_seconds == Some(10), + // Default per v1 plan / Fal client: audio is on when unspecified. + generate_audio: request.request.generate_audio.unwrap_or(true), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_v2p6_pro: + // audio off: $0.07/sec → 5s=35¢, 10s=70¢ + // audio on: $0.14/sec → 5s=70¢, 10s=140¢ + let cost_in_usd_cents: u64 = match (self.generate_audio, self.is_ten_seconds) { + (false, false) => 35, + (false, true) => 70, + (true, false) => 70, + (true, true) => 140, + }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling2p6Pro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_off_5s_is_35() { assert_eq!(cost_cents(Some(5), Some(false)), 35); } + + #[test] + fn audio_off_10s_is_70() { assert_eq!(cost_cents(Some(10), Some(false)), 70); } + + #[test] + fn audio_on_5s_is_70() { assert_eq!(cost_cents(Some(5), Some(true)), 70); } + + #[test] + fn audio_on_10s_is_140() { assert_eq!(cost_cents(Some(10), Some(true)), 140); } + + #[test] + fn audio_default_is_on() { + assert_eq!(cost_cents(Some(5), None), cost_cents(Some(5), Some(true))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/request.rs new file mode 100644 index 00000000..37fc7193 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_2_6_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling2p6ProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling2p6ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/build.rs new file mode 100644 index 00000000..6bcd164c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/build.rs @@ -0,0 +1,57 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_3p0_pro::request::ArtcraftKling3p0ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_3p0_pro(mut builder: GenerateVideoRequestBuilder) -> Result { + // Kling 3.0 Pro supports `generate_audio` — preserve it (build_artcraft_omni_request + // hardcodes None on output). Also Kling 3.0 supports 3-15s durations, but the + // omni-gen helper only accepts 4-15s; we plan the Kling-specific duration here + // and substitute a stand-in (≥4) for the omni-gen call, then restore. + let generate_audio = builder.generate_audio; + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_kling_3p0_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration.map(|d| d.max(4)); + + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling3p0Pro, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + request.duration_seconds = final_duration; + + let state = ArtcraftKling3p0ProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling3p0Pro(state))) +} + +/// Kling 3.0 (Pro and Standard) supports durations of 3-15 seconds. +pub(crate) fn plan_kling_3p0_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + const MIN: u16 = 3; + const MAX: u16 = 15; + match duration_seconds { + None => Ok(None), + Some(d) if (MIN..=MAX).contains(&d) => Ok(Some(d)), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(Some(d.clamp(MIN, MAX))), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/cost.rs new file mode 100644 index 00000000..27d0c98a --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/cost.rs @@ -0,0 +1,89 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_3p0_pro::request::ArtcraftKling3p0ProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling3p0ProCostState { + pub duration_seconds: u64, + pub generate_audio: bool, +} + +impl ArtcraftKling3p0ProCostState { + pub fn from_request(request: &ArtcraftKling3p0ProRequestState) -> Self { + Self { + // Default duration is 5s when unset (mirrors v1 plan default + Fal client default). + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(5), + generate_audio: request.request.generate_audio.unwrap_or(true), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_3p0_pro: + // audio off: $0.224/sec (rate=224 in tenths-of-cents) + // audio on: $0.336/sec (rate=336) + // ceiling-divided to whole cents. + let rate: u64 = if self.generate_audio { 336 } else { 224 }; + let cost_in_usd_cents = (rate * self.duration_seconds + 9) / 10; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Pro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_on_5s_is_168() { + // rate=336, (336*5 + 9) / 10 = 1689/10 = 168. + assert_eq!(cost_cents(Some(5), Some(true)), 168); + } + + #[test] + fn audio_off_5s_is_112() { + // rate=224, (224*5 + 9) / 10 = 1129/10 = 112. + assert_eq!(cost_cents(Some(5), Some(false)), 112); + } + + #[test] + fn audio_on_10s_is_336() { + assert_eq!(cost_cents(Some(10), Some(true)), 336); + } + + #[test] + fn audio_on_15s_is_504() { + // rate=336, (336*15 + 9) / 10 = 5049/10 = 504. + assert_eq!(cost_cents(Some(15), Some(true)), 504); + } + + #[test] + fn default_duration_is_5s() { + assert_eq!(cost_cents(None, Some(true)), cost_cents(Some(5), Some(true))); + } + + #[test] + fn audio_default_is_on() { + assert_eq!(cost_cents(Some(5), None), cost_cents(Some(5), Some(true))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/request.rs new file mode 100644 index 00000000..ff557fd2 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling3p0ProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling3p0ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/build.rs new file mode 100644 index 00000000..fd309bf3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/build.rs @@ -0,0 +1,31 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::kling_3p0_pro::build::plan_kling_3p0_duration; +use crate::generate::generate_video::providers::artcraft::kling_3p0_standard::request::ArtcraftKling3p0StandardRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_kling_3p0_standard(mut builder: GenerateVideoRequestBuilder) -> Result { + // Kling 3.0 Standard: same duration range as 3.0 Pro (3-15s); see kling_3p0_pro::build. + let generate_audio = builder.generate_audio; + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_kling_3p0_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration.map(|d| d.max(4)); + + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Kling3p0Standard, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + request.duration_seconds = final_duration; + + let state = ArtcraftKling3p0StandardRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftKling3p0Standard(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/cost.rs new file mode 100644 index 00000000..1143a039 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/cost.rs @@ -0,0 +1,82 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::kling_3p0_standard::request::ArtcraftKling3p0StandardRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling3p0StandardCostState { + pub duration_seconds: u64, + pub generate_audio: bool, +} + +impl ArtcraftKling3p0StandardCostState { + pub fn from_request(request: &ArtcraftKling3p0StandardRequestState) -> Self { + Self { + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(5), + generate_audio: request.request.generate_audio.unwrap_or(true), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_3p0_standard: + // audio off: $0.168/sec (rate=168) + // audio on: $0.252/sec (rate=252) + let rate: u64 = if self.generate_audio { 252 } else { 168 }; + let cost_in_usd_cents = (rate * self.duration_seconds + 9) / 10; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Standard, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_on_5s_is_126() { + // rate=252, (252*5 + 9) / 10 = 1269/10 = 126. + assert_eq!(cost_cents(Some(5), Some(true)), 126); + } + + #[test] + fn audio_off_5s_is_84() { + // rate=168, (168*5 + 9) / 10 = 849/10 = 84. + assert_eq!(cost_cents(Some(5), Some(false)), 84); + } + + #[test] + fn audio_on_10s_is_252() { + assert_eq!(cost_cents(Some(10), Some(true)), 252); + } + + #[test] + fn audio_on_15s_is_378() { + // (252*15 + 9) / 10 = 3789/10 = 378. + assert_eq!(cost_cents(Some(15), Some(true)), 378); + } + + #[test] + fn default_duration_is_5s() { + assert_eq!(cost_cents(None, Some(true)), cost_cents(Some(5), Some(true))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/request.rs new file mode 100644 index 00000000..8bc7bbf5 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/kling_3p0_standard/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftKling3p0StandardRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftKling3p0StandardRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/mod.rs new file mode 100644 index 00000000..6e44ce1c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/mod.rs @@ -0,0 +1,42 @@ +pub(crate) mod build_common; +pub(crate) mod seedance_common; +#[cfg(test)] +mod parity_tests; +pub mod grok_imagine_video; +pub mod grok_imagine_video_1p5; +pub mod happy_horse_1p0; +pub mod kling_1_6_pro; +pub mod kling_2_1_master; +pub mod kling_2_1_pro; +pub mod kling_2_5_turbo_pro; +pub mod kling_2_6_pro; +pub mod kling_3p0_pro; +pub mod kling_3p0_standard; +pub mod preview_model; +pub mod preview_model_fast; +pub(crate) mod request_common; +pub(crate) mod resolve; +pub mod seedance_1p0_lite; +pub mod seedance_1p5_pro; +pub mod seedance_2p0; +pub mod seedance_2p0_fast; +pub mod seedance_2p0_u_fast; +pub mod seedance_2p0_u; +pub mod seedance_2p0_bp; +pub mod seedance_2p0_bp_fast; +pub mod seedance_2p0_bpu; +pub mod seedance_2p0_bpu_fast; +pub mod seedance_2p0_mini; +pub mod seedance_2p0_bp_mini; +pub mod seedance_2p0_bpu_mini; +pub mod sora_2; +pub mod sora_2_pro; +pub mod veo_2; +pub mod veo_3; +pub mod veo_3_fast; +pub mod veo_3p1; +pub mod veo_3p1_fast; +pub mod veo_3p1_lite; +pub mod vidu_q3; +pub mod vidu_q3_turbo; + diff --git a/crates/router/src/generate/generate_video/providers/artcraft/parity_tests.rs b/crates/router/src/generate/generate_video/providers/artcraft/parity_tests.rs new file mode 100644 index 00000000..adc11241 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/parity_tests.rs @@ -0,0 +1,131 @@ +//! Cost-parity tests: the BPU (BytePlus Ultra) variants must price identically to +//! the BP (BytePlus) variants across every (resolution × duration × batch) combo. +//! +//! When BPU and BP pricing must diverge in the future, these tests should be +//! intentionally adjusted and split rather than relaxed. + +use crate::api::router_provider::RouterProvider; +use crate::api::router_resolution::RouterResolution; +use crate::api::router_video_model::RouterVideoModel; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +const RESOLUTIONS: [Option; 4] = [ + None, + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), +]; + +/// Durations spanning the supported window (1..=15 seconds) plus over-the-cap +/// inputs that exercise duration clamping in the builder. +const DURATIONS: [u16; 17] = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 30, 99]; + +const BATCHES: [u16; 4] = [1, 2, 3, 4]; + +mod seedance_2p0_bpu_matches_seedance_2p0_bp { + use super::*; + + #[test] + fn cost_parity_across_all_combos() { + for &res in &RESOLUTIONS { + for &dur in &DURATIONS { + for &batch in &BATCHES { + let bp = cost_cents(RouterVideoModel::Seedance2p0BytePlus, res, dur, batch); + let bpu = cost_cents(RouterVideoModel::Seedance2p0BytePlusUltra, res, dur, batch); + assert_eq!( + bpu, bp, + "cost mismatch at res={:?} dur={} batch={}: bp={} bpu={}", + res, dur, batch, bp, bpu, + ); + } + } + } + } + + #[test] + fn credits_parity_across_all_combos() { + for &res in &RESOLUTIONS { + for &dur in &DURATIONS { + for &batch in &BATCHES { + let bp = build_cost(RouterVideoModel::Seedance2p0BytePlus, res, dur, batch); + let bpu = build_cost(RouterVideoModel::Seedance2p0BytePlusUltra, res, dur, batch); + assert_eq!( + bpu.cost_in_credits, bp.cost_in_credits, + "credit mismatch at res={:?} dur={} batch={}", + res, dur, batch, + ); + } + } + } + } +} + +mod seedance_2p0_bpu_fast_matches_seedance_2p0_bp_fast { + use super::*; + + #[test] + fn cost_parity_across_all_combos() { + for &res in &RESOLUTIONS { + for &dur in &DURATIONS { + for &batch in &BATCHES { + let bp = cost_cents(RouterVideoModel::Seedance2p0BytePlusFast, res, dur, batch); + let bpu = cost_cents(RouterVideoModel::Seedance2p0BytePlusUltraFast, res, dur, batch); + assert_eq!( + bpu, bp, + "cost mismatch at res={:?} dur={} batch={}: bp_fast={} bpu_fast={}", + res, dur, batch, bp, bpu, + ); + } + } + } + } + + #[test] + fn credits_parity_across_all_combos() { + for &res in &RESOLUTIONS { + for &dur in &DURATIONS { + for &batch in &BATCHES { + let bp = build_cost(RouterVideoModel::Seedance2p0BytePlusFast, res, dur, batch); + let bpu = build_cost(RouterVideoModel::Seedance2p0BytePlusUltraFast, res, dur, batch); + assert_eq!( + bpu.cost_in_credits, bp.cost_in_credits, + "credit mismatch at res={:?} dur={} batch={}", + res, dur, batch, + ); + } + } + } + } +} + +fn build_cost( + model: RouterVideoModel, + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, +) -> VideoGenerationCostEstimate { + GenerateVideoRequestBuilder { + model, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + } + .build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") +} + +fn cost_cents( + model: RouterVideoModel, + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, +) -> u64 { + build_cost(model, resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .expect("cost_in_usd_cents should be Some") +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/build.rs new file mode 100644 index 00000000..89f5715d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/build.rs @@ -0,0 +1,175 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::preview_model::request::ArtcraftPreviewModelRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_preview_model(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::PreviewModel, + SupportedResolutions::Full, + UltraWideSupport::Supported, + )?; + let state = ArtcraftPreviewModelRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftPreviewModel(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Field conversions ── + + mod field_conversions { + use super::*; + + #[test] + fn model_is_preview_model() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::PreviewModel))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Media tokens ── + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_preview_model(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftPreviewModelRequestState { + let result = build_artcraft_preview_model(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftPreviewModel(state) + ) => state, + _ => panic!("expected ArtcraftPreviewModel request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/cost.rs new file mode 100644 index 00000000..7f4145c6 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/cost.rs @@ -0,0 +1,233 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::preview_model::request::ArtcraftPreviewModelRequestState; + +// ── Pricing constants ── +// +// ArtCraft credits: 100 credits = $1.00. Credits always equal USD cents. + +/// USD cents per second by resolution: +/// 480p: $0.10/s = 10.0 ¢/s +/// 720p: $0.25/s = 25.0 ¢/s +/// 1080p: $0.50/s = 50.0 ¢/s +const CENTS_PER_SECOND_480P: f64 = 10.0; +const CENTS_PER_SECOND_720P: f64 = 25.0; +const CENTS_PER_SECOND_1080P: f64 = 50.0; + +pub struct ArtcraftPreviewModelCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, +} + +impl ArtcraftPreviewModelCostState { + pub fn from_request(request: &ArtcraftPreviewModelRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + + Self { resolution, duration_seconds, batch_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + CommonResolution::TenEightyP => CENTS_PER_SECOND_1080P, + // Everything else (including 720p) prices at 720p. + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // -- 720p pricing -- + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 125); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 250); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 375); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 250); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 2), 750); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 500); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 4), 1500); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + // -- 480p pricing -- + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 40); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 50); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 150); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 100); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 200); + } + } + + // -- 1080p pricing -- + + mod pricing_1080p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 4, 1), 200); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 1), 250); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 1), 500); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15, 1), 750); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 2), 500); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 4), 1000); + } + } + + // -- Relative pricing -- + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p_cheaper_than_1080p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 5, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + assert!(c480 < c720); + assert!(c720 < c1080); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + let b2 = cost_cents(Some(RouterResolution::TenEightyP), 5, 2); + let b4 = cost_cents(Some(RouterResolution::TenEightyP), 5, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // -- Credits equal cents -- + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + None, + ]; + for res in resolutions { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents for res={:?} dur={}s batch={}", + res, dur, batch, + ); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::PreviewModel, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/request.rs new file mode 100644 index 00000000..35ebf486 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftPreviewModelRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftPreviewModelRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/build.rs new file mode 100644 index 00000000..d3d4fe07 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/build.rs @@ -0,0 +1,188 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::preview_model_fast::request::ArtcraftPreviewModelFastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_preview_model_fast(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::PreviewModelFast, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftPreviewModelFastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftPreviewModelFast(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Field conversions ── + + mod field_conversions { + use super::*; + + #[test] + fn model_is_preview_model_fast() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::PreviewModelFast))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_preview_model_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::PreviewModelFast, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Media tokens ── + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_preview_model_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::PreviewModelFast, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::PreviewModelFast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftPreviewModelFastRequestState { + let result = build_artcraft_preview_model_fast(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftPreviewModelFast(state) + ) => state, + _ => panic!("expected ArtcraftPreviewModelFast request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/cost.rs new file mode 100644 index 00000000..d23232fa --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/cost.rs @@ -0,0 +1,203 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::preview_model_fast::request::ArtcraftPreviewModelFastRequestState; + +// ── Pricing constants ── +// +// ArtCraft credits: 100 credits = $1.00. Credits always equal USD cents. + +/// USD cents per second by resolution: +/// 480p: $0.09/s = 9.0 ¢/s +/// 720p: $0.20/s = 20.0 ¢/s +const CENTS_PER_SECOND_480P: f64 = 9.0; +const CENTS_PER_SECOND_720P: f64 = 20.0; + +pub struct ArtcraftPreviewModelFastCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, +} + +impl ArtcraftPreviewModelFastCostState { + pub fn from_request(request: &ArtcraftPreviewModelFastRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + + Self { resolution, duration_seconds, batch_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + // Everything else (including 720p and unsupported resolutions) prices at 720p. + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // -- 720p pricing -- + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 80); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 200); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 300); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 200); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 2), 600); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 400); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 4), 1200); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + // -- 480p pricing -- + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 36); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 45); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 90); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 135); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 90); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 180); + } + } + + // -- Relative pricing -- + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 5, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + assert!(c480 < c720); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let b2 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2); + let b4 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // -- Credits equal cents -- + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + None, + ]; + for res in resolutions { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents for res={:?} dur={}s batch={}", + res, dur, batch, + ); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::PreviewModelFast, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/request.rs new file mode 100644 index 00000000..0353f6cc --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/preview_model_fast/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftPreviewModelFastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftPreviewModelFastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/request_common.rs b/crates/router/src/generate/generate_video/providers/artcraft/request_common.rs new file mode 100644 index 00000000..cf25e842 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/request_common.rs @@ -0,0 +1,32 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; +use artcraft_client::credentials::api_or_web_creds::ApiOrWebCreds; +use artcraft_client::endpoints::omni_gen::generate::video::omni_gen_video::{omni_gen_video_generate, OmniGenVideoGenerateArgs}; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + ArtcraftVideoResponsePayload, GenerateVideoResponse, +}; + +/// Send a video generation request to the Artcraft omni-gen endpoint. +/// All Artcraft model request states delegate to this function. +pub async fn send_artcraft_omni_video_request( + request: &OmniGenVideoCostAndGenerateRequest, + client: &RouterArtcraftClient, +) -> Result { + let api_or_web_creds = ApiOrWebCreds::from(&client.credentials); + + let response = omni_gen_video_generate(OmniGenVideoGenerateArgs { + api_host: &client.api_host, + api_or_web_creds: Some(&api_or_web_creds), + request, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Storyteller(err)))?; + + Ok(GenerateVideoResponse::Artcraft(ArtcraftVideoResponsePayload { + inference_job_token: response.inference_job_token.clone(), + all_inference_job_tokens: vec![response.inference_job_token], + })) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/resolve.rs b/crates/router/src/generate/generate_video/providers/artcraft/resolve.rs new file mode 100644 index 00000000..c8b2c47f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/resolve.rs @@ -0,0 +1,103 @@ +//! Shared resolve helpers for the Artcraft provider. +//! +//! Artcraft only accepts media file tokens — raw URLs are rejected. + +use artcraft_client::tokens::characters::CharacterToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::audio_ref::AudioRef; +use crate::api::character_list_ref::CharacterListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::api::video_ref::VideoRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; + +pub(super) fn resolve_image_ref( + image_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::MediaFileToken(t)) => Ok(Some(t)), + Some(ImageRef::Url(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + } +} + +pub(super) fn resolve_image_list_ref( + image_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match image_list_ref { + None => Ok(None), + Some(ImageListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(ImageListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(ImageListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +pub(super) fn resolve_video_list_ref( + video_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match video_list_ref { + None => Ok(None), + Some(VideoListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(VideoListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(VideoListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for video_ref in refs { + match video_ref { + VideoRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +pub(super) fn resolve_audio_list_ref( + audio_list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match audio_list_ref { + None => Ok(None), + Some(AudioListRef::MediaFileTokens(tokens)) => Ok(Some(tokens)), + Some(AudioListRef::Urls(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)) + } + Some(AudioListRef::Sources(refs)) => { + let mut tokens = Vec::with_capacity(refs.len()); + for audio_ref in refs { + match audio_ref { + AudioRef::MediaFileToken(token) => tokens.push(token), + _ => return Err(ArtcraftRouterError::Client(ClientError::ArtcraftOnlySupportsMediaTokens)), + } + } + Ok(Some(tokens)) + } + } +} + +pub(super) fn resolve_character_list_ref( + character_list_ref: Option, +) -> Option> { + match character_list_ref { + None => None, + Some(CharacterListRef::CharacterTokens(tokens)) => Some(tokens), + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/build.rs new file mode 100644 index 00000000..4f116adf --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/build.rs @@ -0,0 +1,49 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_1p0_lite::request::ArtcraftSeedance10LiteRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_1p0_lite(mut builder: GenerateVideoRequestBuilder) -> Result { + // Seedance 1.0 Lite accepts only {5, 10} seconds; pre-plan so cost parity holds. + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_seedance_1p0_lite_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance10Lite, + // The model serves 480p/720p/1080p; 1080p must plan (and price) as 1080p. + SupportedResolutions::Full, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance10LiteRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance10Lite(state))) +} + +fn plan_seedance_1p0_lite_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) | Some(10) => Ok(duration_seconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(10)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(5)), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/cost.rs new file mode 100644 index 00000000..9eecb541 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/cost.rs @@ -0,0 +1,108 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; +use fal_client::requests_old::webhook::video::image::enqueue_seedance_1_lite_image_to_video_webhook::{ + Seedance1LiteDuration, Seedance1LiteRequest, Seedance1LiteResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_1p0_lite::request::ArtcraftSeedance10LiteRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance10LiteCostState { + pub duration: Seedance1LiteDuration, + pub resolution: Seedance1LiteResolution, +} + +impl ArtcraftSeedance10LiteCostState { + pub fn from_request(request: &ArtcraftSeedance10LiteRequestState) -> Self { + // Legacy handler defaults: 5 seconds, 720p. + let duration = if request.request.duration_seconds == Some(10) { + Seedance1LiteDuration::TenSeconds + } else { + Seedance1LiteDuration::FiveSeconds + }; + let resolution = match request.request.resolution { + Some(CommonResolutionEnum::FourEightyP) => Seedance1LiteResolution::FourEightyP, + Some(CommonResolutionEnum::TenEightyP) => Seedance1LiteResolution::TenEightyP, + _ => Seedance1LiteResolution::SevenTwentyP, + }; + Self { duration, resolution } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Derived from the Fal client's cost calculator so the price tracks + // upstream pricing across every resolution and duration. + let req = Seedance1LiteRequest { + image_url: String::new(), + end_frame_image_url: None, + prompt: String::new(), + duration: self.duration, + resolution: self.resolution, + aspect_ratio: None, + camera_fixed: false, + seed: None, + }; + let cost_in_usd_cents = (req.calculate_cost_in_cents() * 21).div_ceil(20); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, resolution: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance10Lite, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn default_is_720p_5s_priced_at_19() { + assert_eq!(cost_cents(None, None), 19); + } + + #[test] + fn p480_5s_is_10() { assert_eq!(cost_cents(Some(5), Some(RouterResolution::FourEightyP)), 10); } + + #[test] + fn p480_10s_is_18() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::FourEightyP)), 18); } + + #[test] + fn p720_5s_is_19() { assert_eq!(cost_cents(Some(5), Some(RouterResolution::SevenTwentyP)), 19); } + + #[test] + fn p720_10s_is_52() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::SevenTwentyP)), 52); } + + #[test] + fn p1080_5s_is_58() { assert_eq!(cost_cents(Some(5), Some(RouterResolution::TenEightyP)), 58); } + + #[test] + fn p1080_10s_is_116() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::TenEightyP)), 116); } + + #[test] + fn p480_5s_cheaper_than_p720_5s() { + assert!( + cost_cents(Some(5), Some(RouterResolution::FourEightyP)) + < cost_cents(Some(5), Some(RouterResolution::SevenTwentyP)) + ); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/request.rs new file mode 100644 index 00000000..b90047e8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p0_lite/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance10LiteRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance10LiteRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/build.rs new file mode 100644 index 00000000..265fce0f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/build.rs @@ -0,0 +1,54 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_1p5_pro::request::ArtcraftSeedance1p5ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_1p5_pro(mut builder: GenerateVideoRequestBuilder) -> Result { + // Seedance 1.5 Pro supports 4-12 seconds; omni-gen helper accepts up to 15, + // so we clamp the upper bound ourselves. Preserve generate_audio (omni-gen + // hardcodes None on output). + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_seedance_1p5_pro_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance1p5Pro, + SupportedResolutions::Full, + UltraWideSupport::Supported, + )?; + request.generate_audio = generate_audio; + + let state = ArtcraftSeedance1p5ProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance1p5Pro(state))) +} + +fn plan_seedance_1p5_pro_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + const MIN: u16 = 4; + const MAX: u16 = 12; + match duration_seconds { + None => Ok(None), + Some(d) if (MIN..=MAX).contains(&d) => Ok(Some(d)), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(Some(d.clamp(MIN, MAX))), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/cost.rs new file mode 100644 index 00000000..e4f6cfa8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/cost.rs @@ -0,0 +1,109 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; +use fal_client::requests_old::webhook::video::text::enqueue_seedance_1p5_pro_text_to_video_webhook::{ + EnqueueSeedance1p5ProTextToVideoDuration, EnqueueSeedance1p5ProTextToVideoRequest, + EnqueueSeedance1p5ProTextToVideoResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_1p5_pro::request::ArtcraftSeedance1p5ProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance1p5ProCostState { + pub duration: Option, + pub resolution: Option, + pub generate_audio: Option, +} + +impl ArtcraftSeedance1p5ProCostState { + pub fn from_request(request: &ArtcraftSeedance1p5ProRequestState) -> Self { + let duration = request.request.duration_seconds.and_then(seconds_to_duration); + let resolution = request.request.resolution.and_then(common_resolution_to_seedance); + Self { + duration, + resolution, + generate_audio: request.request.generate_audio, + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Delegate to the Fal client's cost calculator. Pricing is identical for + // text-to-video and image-to-video at the same resolution+duration+audio, + // so we use the text-to-video request type as a stand-in. + let req = EnqueueSeedance1p5ProTextToVideoRequest { + prompt: String::new(), + duration: self.duration, + resolution: self.resolution, + aspect_ratio: None, + generate_audio: self.generate_audio, + }; + let cost_in_usd_cents = req.calculate_cost_in_cents(); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn seconds_to_duration(seconds: u16) -> Option { + use EnqueueSeedance1p5ProTextToVideoDuration as D; + match seconds { + 4 => Some(D::FourSeconds), + 5 => Some(D::FiveSeconds), + 6 => Some(D::SixSeconds), + 7 => Some(D::SevenSeconds), + 8 => Some(D::EightSeconds), + 9 => Some(D::NineSeconds), + 10 => Some(D::TenSeconds), + 11 => Some(D::ElevenSeconds), + 12 => Some(D::TwelveSeconds), + _ => None, + } +} + +fn common_resolution_to_seedance(r: CommonResolutionEnum) -> Option { + match r { + CommonResolutionEnum::FourEightyP => Some(EnqueueSeedance1p5ProTextToVideoResolution::FourEightyP), + CommonResolutionEnum::SevenTwentyP => Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP), + CommonResolutionEnum::TenEightyP => Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP), + _ => None, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance1p5Pro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // Numeric literals mirror the v1 Artcraft Seedance 1.5 Pro tests we deleted: + // resolution=None + generate_audio=None → fal client defaults (720p, audio on). + #[test] + fn default_5s_is_26() { assert_eq!(cost_cents(Some(5)), 26); } + + #[test] + fn default_4s_is_26() { assert_eq!(cost_cents(Some(4)), 26); } + + #[test] + fn default_10s_is_65() { assert_eq!(cost_cents(Some(10)), 65); } + + #[test] + fn default_12s_is_78() { assert_eq!(cost_cents(Some(12)), 78); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/request.rs new file mode 100644 index 00000000..8f0cfa7e --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_1p5_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance1p5ProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance1p5ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/build.rs new file mode 100644 index 00000000..ae947901 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/build.rs @@ -0,0 +1,189 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0::request::ArtcraftSeedance2p0RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0, + SupportedResolutions::FullWith4k, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Field conversions ── + + mod field_conversions { + use super::*; + + #[test] + fn model_is_seedance_2p0() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(make_builder(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn res_4k() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourK); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourK)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Media tokens ── + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0RequestState { + let result = build_artcraft_seedance_2p0(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0 request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/cost.rs new file mode 100644 index 00000000..2c5c23e8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/cost.rs @@ -0,0 +1,311 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_four_k_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0::request::ArtcraftSeedance2p0RequestState; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +// ── Pricing constants ── +// +// ArtCraft credits: 100 credits = $1.00. Credits always equal USD cents. +// +// The per-second USD cost varies by resolution. We compute cents directly +// from the upstream credit rates and their credit-package prices, +// then set ArtCraft credits = cents. + +/// USD cents per second by resolution, derived from upstream rates: +/// 480p: 15 upstream-credits/sec ÷ 193 upstream-credits/$1 × 100 ≈ 7.772 ¢/s +/// 720p: 40 upstream-credits/sec ÷ 250 upstream-credits/$1 × 100 = 16.0 ¢/s +/// 1080p: 90 upstream-credits/sec ÷ 193 upstream-credits/$1 × 100 ≈ 46.632 ¢/s +/// +/// We keep these as f64 because per-second rates are fractional; rounding +/// happens once at the end after multiplying by duration × batch. +/// +/// NB: Derivation is historical (193 credits/$1 package). The upstream +/// package is now 525,000 credits for $2,159.0909 (~243 credits/$1), but +/// user pricing is intentionally kept at these 193-derived rates. +const CENTS_PER_SECOND_480P: f64 = 7.772; +const CENTS_PER_SECOND_720P: f64 = 16.0; +const CENTS_PER_SECOND_1080P: f64 = 46.632; + +pub struct ArtcraftSeedance2p0CostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0CostState { + pub fn from_request(request: &ArtcraftSeedance2p0RequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + if self.resolution == CommonResolution::FourK { + let usd_cents = seedance_2p0_four_k_usd_cents( + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + return VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + }; + } + + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + CommonResolution::TenEightyP => CENTS_PER_SECOND_1080P, + // Everything else (including 720p) prices at 720p. + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + // ArtCraft credits: 100 credits = $1.00, so credits = cents. + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // -- 720p pricing -- + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 64); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 80); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 6, 1), 96); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 160); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 240); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 2), 128); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 160); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 2), 480); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 4), 256); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 320); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 4), 960); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + // -- 480p pricing -- + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 31); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 39); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 78); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 117); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 78); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 155); + } + } + + // -- 1080p pricing -- + + mod pricing_1080p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 4, 1), 187); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 1), 233); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 1), 466); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15, 1), 699); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 2), 466); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 4), 933); + } + } + + // -- 4K pricing -- + + mod four_k_pricing { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + + fn artcraft_4k_cents(duration_seconds: u16, batch_count: u16, has_video_reference: bool) -> u64 { + super::super::ArtcraftSeedance2p0CostState { + resolution: CommonResolution::FourK, + duration_seconds, + batch_count, + has_video_reference, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + #[test] + fn explicit_4k_without_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, false), 347); + assert_eq!(artcraft_4k_cents(5, 1, false), 433); + assert_eq!(artcraft_4k_cents(10, 1, false), 866); + assert_eq!(artcraft_4k_cents(15, 1, false), 1299); + } + + #[test] + fn explicit_4k_with_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, true), 416); + assert_eq!(artcraft_4k_cents(5, 1, true), 519); + assert_eq!(artcraft_4k_cents(10, 1, true), 1038); + assert_eq!(artcraft_4k_cents(15, 1, true), 1557); + } + } + + // -- Relative pricing -- + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p_cheaper_than_1080p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 5, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + assert!(c480 < c720); + assert!(c720 < c1080); + } + + #[test] + fn cost_4k_more_expensive_than_1080p() { + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + let c4k = cost_cents(Some(RouterResolution::FourK), 5, 1); + assert!(c4k > c1080); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + let b2 = cost_cents(Some(RouterResolution::TenEightyP), 5, 2); + let b4 = cost_cents(Some(RouterResolution::TenEightyP), 5, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // -- Credits equal cents -- + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + Some(RouterResolution::FourK), + None, + ]; + for res in resolutions { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents for res={:?} dur={}s batch={}", + res, dur, batch, + ); + } + } + } + } + } + + // -- Helpers -- + + /// Build a cost estimate end-to-end: GenerateVideoRequestBuilder → build2 → estimate_cost. + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/request.rs new file mode 100644 index 00000000..49f225c9 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0/request.rs @@ -0,0 +1,237 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use test_data::web::character_tokens::{JIM, KNIGHT}; + use test_data::web::image_media_tokens::{ + FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN, + JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN, + WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN, + }; + + // -- Aspect ratio tests -- + + mod aspect_ratio_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn landscape() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn portrait() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A cat sitting on a windowsill watching rain.".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn square() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A hummingbird hovering near a flower.".to_string()), + aspect_ratio: Some(RouterAspectRatio::Square), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Resolution tests -- + + mod resolution_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn res_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A golden retriever catching a frisbee on the beach.".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn res_1080p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A fox walking through a snowy forest.".to_string()), + resolution: Some(RouterResolution::TenEightyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Modality tests -- + + mod modality_tests { + use super::*; + use test_data::web::image_media_tokens::TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN; + + #[tokio::test] + #[ignore] + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A whale breaching in the open ocean at dawn, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn keyframe_start_and_end_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog walks from the lake to the forest.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + end_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()))), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn image_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog in @2 runs through the scenery in @1 towards the building in @3.".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn character_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("@Jim and @Knight are sparring in a medieval arena.".to_string()), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new(JIM.token.to_string()), + CharacterToken::new(KNIGHT.token.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Helpers -- + + fn artcraft_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/build.rs new file mode 100644 index 00000000..9e5474d6 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/build.rs @@ -0,0 +1,181 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp::request::ArtcraftSeedance2p0BytePlusRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_bp(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0BytePlus, + SupportedResolutions::FullWith4k, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0BytePlusRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlus(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_seedance_2p0_plus() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0BytePlus))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(make_builder(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn res_4k() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourK); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourK)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_bp(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0BytePlusRequestState { + let result = build_artcraft_seedance_2p0_bp(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0BytePlus(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0BytePlus request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/cost.rs new file mode 100644 index 00000000..f4f88f27 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/cost.rs @@ -0,0 +1,231 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_four_k_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp::request::ArtcraftSeedance2p0BytePlusRequestState; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +/// USD cents per second by resolution: +/// 480p: $0.10/s = 10.0 ¢/s +/// 720p: $0.25/s = 25.0 ¢/s +/// 1080p: $0.50/s = 50.0 ¢/s +const CENTS_PER_SECOND_480P: f64 = 10.0; +const CENTS_PER_SECOND_720P: f64 = 25.0; +const CENTS_PER_SECOND_1080P: f64 = 50.0; + +pub struct ArtcraftSeedance2p0BytePlusCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0BytePlusCostState { + pub fn from_request(request: &ArtcraftSeedance2p0BytePlusRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + if self.resolution == CommonResolution::FourK { + let usd_cents = seedance_2p0_four_k_usd_cents( + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + return VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + }; + } + + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + CommonResolution::TenEightyP => CENTS_PER_SECOND_1080P, + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 125); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 250); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 375); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 250); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 500); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 40); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 50); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 150); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 100); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 200); + } + } + + mod pricing_1080p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 4, 1), 200); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 1), 250); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 1), 500); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15, 1), 750); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 2), 500); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 4), 1000); + } + } + + mod four_k_pricing { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + + fn artcraft_4k_cents(duration_seconds: u16, batch_count: u16, has_video_reference: bool) -> u64 { + super::super::ArtcraftSeedance2p0BytePlusCostState { + resolution: CommonResolution::FourK, + duration_seconds, + batch_count, + has_video_reference, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + #[test] + fn explicit_4k_without_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, false), 347); + assert_eq!(artcraft_4k_cents(5, 1, false), 433); + assert_eq!(artcraft_4k_cents(10, 1, false), 866); + assert_eq!(artcraft_4k_cents(15, 1, false), 1299); + } + + #[test] + fn explicit_4k_with_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, true), 416); + assert_eq!(artcraft_4k_cents(5, 1, true), 519); + assert_eq!(artcraft_4k_cents(10, 1, true), 1038); + assert_eq!(artcraft_4k_cents(15, 1, true), 1557); + } + } + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p_cheaper_than_1080p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 5, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + assert!(c480 < c720); + assert!(c720 < c1080); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents() { + for res in [Some(RouterResolution::FourEightyP), Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP), None] { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlus, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }.build2().expect("build2").estimate_cost().expect("estimate_cost") + } + + fn cost_cents(resolution: Option, duration_seconds: u16, video_batch_count: u16) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count).cost_in_usd_cents.unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/request.rs new file mode 100644 index 00000000..d2233792 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0BytePlusRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0BytePlusRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/build.rs new file mode 100644 index 00000000..7322bb4e --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/build.rs @@ -0,0 +1,188 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_fast::request::ArtcraftSeedance2p0BytePlusFastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_bp_fast(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0BytePlusFast, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0BytePlusFastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusFast(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_seedance_2p0_plus_fast() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0BytePlusFast))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(make_builder(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_bp_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusFast, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_bp_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusFast, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusFast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0BytePlusFastRequestState { + let result = build_artcraft_seedance_2p0_bp_fast(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusFast(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0BytePlusFast request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/cost.rs new file mode 100644 index 00000000..794d7872 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/cost.rs @@ -0,0 +1,148 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_fast::request::ArtcraftSeedance2p0BytePlusFastRequestState; + +/// USD cents per second by resolution: +/// 480p: $0.09/s = 9.0 ¢/s +/// 720p: $0.20/s = 20.0 ¢/s +const CENTS_PER_SECOND_480P: f64 = 9.0; +const CENTS_PER_SECOND_720P: f64 = 20.0; + +pub struct ArtcraftSeedance2p0BytePlusFastCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, +} + +impl ArtcraftSeedance2p0BytePlusFastCostState { + pub fn from_request(request: &ArtcraftSeedance2p0BytePlusFastRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + Self { resolution, duration_seconds, batch_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 80); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 200); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 300); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 200); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 400); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 36); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 45); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 90); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 135); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 90); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 180); + } + } + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + assert!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1) < cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents() { + for res in [Some(RouterResolution::FourEightyP), Some(RouterResolution::SevenTwentyP), None] { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusFast, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }.build2().expect("build2").estimate_cost().expect("estimate_cost") + } + + fn cost_cents(resolution: Option, duration_seconds: u16, video_batch_count: u16) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count).cost_in_usd_cents.unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/request.rs new file mode 100644 index 00000000..b05b109a --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_fast/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0BytePlusFastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0BytePlusFastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/build.rs new file mode 100644 index 00000000..435cbf1f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/build.rs @@ -0,0 +1,225 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_mini::request::ArtcraftSeedance2p0BytePlusMiniRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_bp_mini(builder: GenerateVideoRequestBuilder) -> Result { + // Seedance 2.0 Mini supports 480p and 720p only (higher resolutions downgrade + // to 720p), and all six aspect ratios including 21:9. + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0BytePlusMini, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0BytePlusMiniRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusMini(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_bitrate::RouterBitrate; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let req = unwrap_request(builder_with(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn model_is_correct() { + let req = unwrap_request(builder_with(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0BytePlusMini))); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(builder_with(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(builder_with(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(builder_with(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn batch_count_clamped_to_platform_max() { + // The ArtCraft platform caps batch at 4 and downgrades higher requests. + let req = unwrap_request(builder_with(|b| { b.video_batch_count = Some(8); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(builder_with(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn wide() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideSixteenByNine)); + } + + #[test] + fn ultra_wide() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideTwentyOneByNine); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideTwentyOneByNine)); + } + + #[test] + fn tall() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::TallNineBySixteen)); + } + + #[test] + fn square() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::Square)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_bp_mini(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusMini, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(builder_with(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(builder_with(|b| { b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_bp_mini(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusMini, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ]; + let req = unwrap_request(builder_with(|b| { b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![ + CharacterToken::new("char_a".to_string()), + CharacterToken::new("char_b".to_string()), + ]; + let req = unwrap_request(builder_with(|b| { b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn builder_with(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusMini, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0BytePlusMiniRequestState { + let result = build_artcraft_seedance_2p0_bp_mini(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusMini(state)) => state, + _ => panic!("expected ArtcraftSeedance2p0BytePlusMini request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/cost.rs new file mode 100644 index 00000000..74cfb281 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/cost.rs @@ -0,0 +1,176 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_byteplus_mini_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_mini::request::ArtcraftSeedance2p0BytePlusMiniRequestState; + +pub struct ArtcraftSeedance2p0BytePlusMiniCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0BytePlusMiniCostState { + pub fn from_request(request: &ArtcraftSeedance2p0BytePlusMiniRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // BytePlus / BytePlus Ultra Mini share a higher-margin rate set; see + // seedance_common::seedance_2p0_byteplus_mini_usd_cents. + let usd_cents = seedance_2p0_byteplus_mini_usd_cents( + self.resolution, + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + + // ArtCraft credits: 100 credits = $1.00, so credits = cents. + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + + // Every combination, driven through the full build pipeline. These prices are + // the supplier's per-combo cost plus a 5% margin, rounded up to whole cents. + + mod pricing_480p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(cents(RouterResolution::FourEightyP, 4, 1, false), 14); + assert_eq!(cents(RouterResolution::FourEightyP, 5, 1, false), 17); + assert_eq!(cents(RouterResolution::FourEightyP, 10, 1, false), 33); + assert_eq!(cents(RouterResolution::FourEightyP, 15, 1, false), 50); + } + + #[test] + fn with_video_reference() { + assert_eq!(cents(RouterResolution::FourEightyP, 4, 1, true), 17); + assert_eq!(cents(RouterResolution::FourEightyP, 5, 1, true), 21); + assert_eq!(cents(RouterResolution::FourEightyP, 10, 1, true), 42); + assert_eq!(cents(RouterResolution::FourEightyP, 15, 1, true), 63); + } + } + + mod pricing_720p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(cents(RouterResolution::SevenTwentyP, 4, 1, false), 35); + assert_eq!(cents(RouterResolution::SevenTwentyP, 5, 1, false), 44); + assert_eq!(cents(RouterResolution::SevenTwentyP, 10, 1, false), 88); + assert_eq!(cents(RouterResolution::SevenTwentyP, 15, 1, false), 131); + } + + #[test] + fn with_video_reference() { + assert_eq!(cents(RouterResolution::SevenTwentyP, 4, 1, true), 42); + assert_eq!(cents(RouterResolution::SevenTwentyP, 5, 1, true), 53); + assert_eq!(cents(RouterResolution::SevenTwentyP, 10, 1, true), 105); + assert_eq!(cents(RouterResolution::SevenTwentyP, 15, 1, true), 158); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cents_no_ref(None, 5, 1), cents(RouterResolution::SevenTwentyP, 5, 1, false)); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + None, + ]; + for res in resolutions { + for dur in [4u16, 5, 10, 15] { + for batch in [1u16, 2, 4] { + for has_ref in [false, true] { + let cost = build_cost(res, dur, batch, has_ref); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + } + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + with_video_reference: bool, + ) -> VideoGenerationCostEstimate { + let reference_videos = with_video_reference.then(|| { + VideoListRef::MediaFileTokens(vec![MediaFileToken::new("mf_ref".to_string())]) + }); + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusMini, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + reference_videos, + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cents( + resolution: RouterResolution, + duration_seconds: u16, + video_batch_count: u16, + with_video_reference: bool, + ) -> u64 { + build_cost(Some(resolution), duration_seconds, video_batch_count, with_video_reference) + .cost_in_usd_cents + .unwrap() + } + + fn cents_no_ref( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count, false) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/request.rs new file mode 100644 index 00000000..71c4a848 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bp_mini/request.rs @@ -0,0 +1,86 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0BytePlusMiniRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0BytePlusMiniRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..mini_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..mini_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + fn mini_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusMini, + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + request.send_request(&client).await.expect("send_request should succeed") + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/build.rs new file mode 100644 index 00000000..ddfba99c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/build.rs @@ -0,0 +1,181 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu::request::ArtcraftSeedance2p0BytePlusUltraRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_bpu(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0BytePlusUltra, + SupportedResolutions::FullWith4k, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0BytePlusUltraRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltra(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_seedance_2p0_bpu() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0BytePlusUltra))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(make_builder(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn res_4k() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourK); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourK)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_bpu(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0BytePlusUltraRequestState { + let result = build_artcraft_seedance_2p0_bpu(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltra(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0BytePlusUltra request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/cost.rs new file mode 100644 index 00000000..d9ec6fed --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/cost.rs @@ -0,0 +1,231 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_four_k_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu::request::ArtcraftSeedance2p0BytePlusUltraRequestState; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +/// USD cents per second by resolution: +/// 480p: $0.10/s = 10.0 ¢/s +/// 720p: $0.25/s = 25.0 ¢/s +/// 1080p: $0.50/s = 50.0 ¢/s +const CENTS_PER_SECOND_480P: f64 = 10.0; +const CENTS_PER_SECOND_720P: f64 = 25.0; +const CENTS_PER_SECOND_1080P: f64 = 50.0; + +pub struct ArtcraftSeedance2p0BytePlusUltraCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0BytePlusUltraCostState { + pub fn from_request(request: &ArtcraftSeedance2p0BytePlusUltraRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + if self.resolution == CommonResolution::FourK { + let usd_cents = seedance_2p0_four_k_usd_cents( + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + return VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + }; + } + + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + CommonResolution::TenEightyP => CENTS_PER_SECOND_1080P, + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 125); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 250); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 375); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 250); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 500); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 40); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 50); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 150); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 100); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 200); + } + } + + mod pricing_1080p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 4, 1), 200); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 1), 250); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 1), 500); + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15, 1), 750); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 2), 500); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 4), 1000); + } + } + + mod four_k_pricing { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + + fn artcraft_4k_cents(duration_seconds: u16, batch_count: u16, has_video_reference: bool) -> u64 { + super::super::ArtcraftSeedance2p0BytePlusUltraCostState { + resolution: CommonResolution::FourK, + duration_seconds, + batch_count, + has_video_reference, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + #[test] + fn explicit_4k_without_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, false), 347); + assert_eq!(artcraft_4k_cents(5, 1, false), 433); + assert_eq!(artcraft_4k_cents(10, 1, false), 866); + assert_eq!(artcraft_4k_cents(15, 1, false), 1299); + } + + #[test] + fn explicit_4k_with_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, true), 416); + assert_eq!(artcraft_4k_cents(5, 1, true), 519); + assert_eq!(artcraft_4k_cents(10, 1, true), 1038); + assert_eq!(artcraft_4k_cents(15, 1, true), 1557); + } + } + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p_cheaper_than_1080p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 5, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 5, 1); + assert!(c480 < c720); + assert!(c720 < c1080); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents() { + for res in [Some(RouterResolution::FourEightyP), Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP), None] { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltra, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }.build2().expect("build2").estimate_cost().expect("estimate_cost") + } + + fn cost_cents(resolution: Option, duration_seconds: u16, video_batch_count: u16) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count).cost_in_usd_cents.unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/request.rs new file mode 100644 index 00000000..5e1b3bef --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0BytePlusUltraRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0BytePlusUltraRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/build.rs new file mode 100644 index 00000000..e0bdbb32 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/build.rs @@ -0,0 +1,188 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_fast::request::ArtcraftSeedance2p0BytePlusUltraFastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_bpu_fast(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0BytePlusUltraFast, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0BytePlusUltraFastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraFast(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn model_is_seedance_2p0_bpu_fast() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0BytePlusUltraFast))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(make_builder(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_bpu_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraFast, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_bpu_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraFast, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraFast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0BytePlusUltraFastRequestState { + let result = build_artcraft_seedance_2p0_bpu_fast(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraFast(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0BytePlusUltraFast request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/cost.rs new file mode 100644 index 00000000..54dabe53 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/cost.rs @@ -0,0 +1,148 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_fast::request::ArtcraftSeedance2p0BytePlusUltraFastRequestState; + +/// USD cents per second by resolution: +/// 480p: $0.09/s = 9.0 ¢/s +/// 720p: $0.20/s = 20.0 ¢/s +const CENTS_PER_SECOND_480P: f64 = 9.0; +const CENTS_PER_SECOND_720P: f64 = 20.0; + +pub struct ArtcraftSeedance2p0BytePlusUltraFastCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, +} + +impl ArtcraftSeedance2p0BytePlusUltraFastCostState { + pub fn from_request(request: &ArtcraftSeedance2p0BytePlusUltraFastRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + Self { resolution, duration_seconds, batch_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 80); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 100); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 200); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 300); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 200); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 400); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 36); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 45); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 90); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 135); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 90); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 180); + } + } + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + assert!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1) < cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents() { + for res in [Some(RouterResolution::FourEightyP), Some(RouterResolution::SevenTwentyP), None] { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraFast, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }.build2().expect("build2").estimate_cost().expect("estimate_cost") + } + + fn cost_cents(resolution: Option, duration_seconds: u16, video_batch_count: u16) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count).cost_in_usd_cents.unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/request.rs new file mode 100644 index 00000000..679f352d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_fast/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0BytePlusUltraFastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0BytePlusUltraFastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/build.rs new file mode 100644 index 00000000..7452473e --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/build.rs @@ -0,0 +1,225 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_mini::request::ArtcraftSeedance2p0BytePlusUltraMiniRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_bpu_mini(builder: GenerateVideoRequestBuilder) -> Result { + // Seedance 2.0 Mini supports 480p and 720p only (higher resolutions downgrade + // to 720p), and all six aspect ratios including 21:9. + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0BytePlusUltraMini, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0BytePlusUltraMiniRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraMini(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_bitrate::RouterBitrate; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let req = unwrap_request(builder_with(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn model_is_correct() { + let req = unwrap_request(builder_with(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0BytePlusUltraMini))); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(builder_with(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(builder_with(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(builder_with(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn batch_count_clamped_to_platform_max() { + // The ArtCraft platform caps batch at 4 and downgrades higher requests. + let req = unwrap_request(builder_with(|b| { b.video_batch_count = Some(8); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(builder_with(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn wide() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideSixteenByNine)); + } + + #[test] + fn ultra_wide() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideTwentyOneByNine); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideTwentyOneByNine)); + } + + #[test] + fn tall() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::TallNineBySixteen)); + } + + #[test] + fn square() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::Square)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_bpu_mini(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraMini, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(builder_with(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(builder_with(|b| { b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_bpu_mini(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraMini, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ]; + let req = unwrap_request(builder_with(|b| { b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![ + CharacterToken::new("char_a".to_string()), + CharacterToken::new("char_b".to_string()), + ]; + let req = unwrap_request(builder_with(|b| { b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn builder_with(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraMini, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0BytePlusUltraMiniRequestState { + let result = build_artcraft_seedance_2p0_bpu_mini(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraMini(state)) => state, + _ => panic!("expected ArtcraftSeedance2p0BytePlusUltraMini request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/cost.rs new file mode 100644 index 00000000..80477a6d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/cost.rs @@ -0,0 +1,176 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_byteplus_mini_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_mini::request::ArtcraftSeedance2p0BytePlusUltraMiniRequestState; + +pub struct ArtcraftSeedance2p0BytePlusUltraMiniCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0BytePlusUltraMiniCostState { + pub fn from_request(request: &ArtcraftSeedance2p0BytePlusUltraMiniRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // BytePlus / BytePlus Ultra Mini share a higher-margin rate set; see + // seedance_common::seedance_2p0_byteplus_mini_usd_cents. + let usd_cents = seedance_2p0_byteplus_mini_usd_cents( + self.resolution, + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + + // ArtCraft credits: 100 credits = $1.00, so credits = cents. + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + + // Every combination, driven through the full build pipeline. These prices are + // the supplier's per-combo cost plus a 5% margin, rounded up to whole cents. + + mod pricing_480p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(cents(RouterResolution::FourEightyP, 4, 1, false), 14); + assert_eq!(cents(RouterResolution::FourEightyP, 5, 1, false), 17); + assert_eq!(cents(RouterResolution::FourEightyP, 10, 1, false), 33); + assert_eq!(cents(RouterResolution::FourEightyP, 15, 1, false), 50); + } + + #[test] + fn with_video_reference() { + assert_eq!(cents(RouterResolution::FourEightyP, 4, 1, true), 17); + assert_eq!(cents(RouterResolution::FourEightyP, 5, 1, true), 21); + assert_eq!(cents(RouterResolution::FourEightyP, 10, 1, true), 42); + assert_eq!(cents(RouterResolution::FourEightyP, 15, 1, true), 63); + } + } + + mod pricing_720p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(cents(RouterResolution::SevenTwentyP, 4, 1, false), 35); + assert_eq!(cents(RouterResolution::SevenTwentyP, 5, 1, false), 44); + assert_eq!(cents(RouterResolution::SevenTwentyP, 10, 1, false), 88); + assert_eq!(cents(RouterResolution::SevenTwentyP, 15, 1, false), 131); + } + + #[test] + fn with_video_reference() { + assert_eq!(cents(RouterResolution::SevenTwentyP, 4, 1, true), 42); + assert_eq!(cents(RouterResolution::SevenTwentyP, 5, 1, true), 53); + assert_eq!(cents(RouterResolution::SevenTwentyP, 10, 1, true), 105); + assert_eq!(cents(RouterResolution::SevenTwentyP, 15, 1, true), 158); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cents_no_ref(None, 5, 1), cents(RouterResolution::SevenTwentyP, 5, 1, false)); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + None, + ]; + for res in resolutions { + for dur in [4u16, 5, 10, 15] { + for batch in [1u16, 2, 4] { + for has_ref in [false, true] { + let cost = build_cost(res, dur, batch, has_ref); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + } + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + with_video_reference: bool, + ) -> VideoGenerationCostEstimate { + let reference_videos = with_video_reference.then(|| { + VideoListRef::MediaFileTokens(vec![MediaFileToken::new("mf_ref".to_string())]) + }); + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraMini, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + reference_videos, + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cents( + resolution: RouterResolution, + duration_seconds: u16, + video_batch_count: u16, + with_video_reference: bool, + ) -> u64 { + build_cost(Some(resolution), duration_seconds, video_batch_count, with_video_reference) + .cost_in_usd_cents + .unwrap() + } + + fn cents_no_ref( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count, false) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/request.rs new file mode 100644 index 00000000..47350168 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_bpu_mini/request.rs @@ -0,0 +1,86 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0BytePlusUltraMiniRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0BytePlusUltraMiniRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..mini_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..mini_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + fn mini_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0BytePlusUltraMini, + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + request.send_request(&client).await.expect("send_request should succeed") + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/build.rs new file mode 100644 index 00000000..6000e745 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/build.rs @@ -0,0 +1,253 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_fast::request::ArtcraftSeedance2p0FastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_fast(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0Fast, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0FastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0Fast(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Field conversions ── + + mod field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn prompt_none_stays_none() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(req.request.prompt.is_none()); + } + + #[test] + fn model_is_seedance_2p0_fast() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0Fast))); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn wide() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideSixteenByNine)); + } + + #[test] + fn tall() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::TallNineBySixteen)); + } + + #[test] + fn square() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.aspect_ratio = Some(RouterAspectRatio::Square); + })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::Square)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(req.request.aspect_ratio.is_none()); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.resolution = Some(RouterResolution::FourEightyP); + })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.resolution = Some(RouterResolution::SevenTwentyP); + })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.resolution = Some(RouterResolution::TenEightyP); + })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Media tokens ── + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ]; + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![ + CharacterToken::new("char_a".to_string()), + CharacterToken::new("char_b".to_string()), + ]; + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn artcraft_fast_builder_with(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0FastRequestState { + let result = build_artcraft_seedance_2p0_fast(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0Fast(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0Fast request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/cost.rs new file mode 100644 index 00000000..cb70a108 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/cost.rs @@ -0,0 +1,219 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_fast::request::ArtcraftSeedance2p0FastRequestState; + +// -- Pricing constants -- +// +// ArtCraft credits: 100 credits = $1.00. Credits always equal USD cents. +// +// The per-second USD cost varies by resolution. We derive cents from the +// upstream credit rates and their credit-package prices, then set +// ArtCraft credits = cents. + +/// USD cents per second by resolution, derived from upstream Fast rates: +/// 480p: 10 upstream-credits/sec / 193 upstream-credits/$1 * 100 ~= 5.181 c/s +/// (historical 193 credits/$1 derivation; the upstream package is now +/// ~243 credits/$1 but user pricing is intentionally unchanged) +/// 720p: 28 upstream-credits/sec / 220 upstream-credits/$1 * 100 ~= 12.727 c/s +/// +/// We keep these as f64 because per-second rates are fractional; rounding +/// happens once at the end after multiplying by duration * batch. +const CENTS_PER_SECOND_480P: f64 = 5.181; +const CENTS_PER_SECOND_720P: f64 = 12.727; + +pub struct ArtcraftSeedance2p0FastCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0FastCostState { + pub fn from_request(request: &ArtcraftSeedance2p0FastRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + // Everything else (including 720p and unsupported resolutions) prices at 720p. + _ => CENTS_PER_SECOND_720P, + }; + + let usd_cents = (self.duration_seconds as f64 * cents_per_second * self.batch_count as f64).round() as u64; + + // ArtCraft credits: 100 credits = $1.00, so credits = cents. + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // -- 720p pricing -- + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1), 51); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 64); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 127); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 191); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 2), 102); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 127); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 2), 382); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 4, 4), 204); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 255); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 4), 764); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 5, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1)); + } + } + + // -- 480p pricing -- + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 4, 1), 21); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 26); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 52); + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 78); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 2), 52); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 4), 104); + } + } + + // -- Relative pricing -- + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 5, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + assert!(c480 < c720, "480p ({}) should be cheaper than 720p ({})", c480, c720); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = cost_cents(Some(RouterResolution::SevenTwentyP), 4, 1); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1); + let b2 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2); + let b4 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // -- Credits equal cents -- + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + None, + ]; + for res in resolutions { + for dur in [4, 5, 10, 15] { + for batch in [1, 2, 4] { + let cost = build_cost(res, dur, batch); + assert_eq!( + cost.cost_in_credits, cost.cost_in_usd_cents, + "credits should equal cents for res={:?} dur={}s batch={}", + res, dur, batch, + ); + } + } + } + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/request.rs new file mode 100644 index 00000000..87679d46 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_fast/request.rs @@ -0,0 +1,227 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0FastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0FastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use test_data::web::character_tokens::{JIM, KNIGHT}; + use test_data::web::image_media_tokens::{ + FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN, + JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN, + WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN, + }; + + // -- Aspect ratio tests -- + + mod aspect_ratio_tests { + use super::*; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn landscape() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn portrait() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A cat sitting on a windowsill watching rain.".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn square() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A hummingbird hovering near a flower.".to_string()), + aspect_ratio: Some(RouterAspectRatio::Square), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Resolution tests -- + + mod resolution_tests { + use super::*; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A golden retriever catching a frisbee on the beach.".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Modality tests -- + + mod modality_tests { + use super::*; + use test_data::web::image_media_tokens::TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A sky whale breaching in the open sky, pink clouds at dawn, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn keyframe_start_and_end_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog walks from the lake to the forest.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + end_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()))), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn image_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog in @2 runs through the scenery in @1 towards the building in @3.".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn character_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("@Jim and @Knight are sparring in a medieval arena.".to_string()), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new(JIM.token.to_string()), + CharacterToken::new(KNIGHT.token.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Helpers -- + + fn artcraft_fast_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/build.rs new file mode 100644 index 00000000..0ce89636 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/build.rs @@ -0,0 +1,225 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_mini::request::ArtcraftSeedance2p0MiniRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_mini(builder: GenerateVideoRequestBuilder) -> Result { + // Seedance 2.0 Mini supports 480p and 720p only (higher resolutions downgrade + // to 720p), and all six aspect ratios including 21:9. + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0Mini, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0MiniRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0Mini(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_bitrate::RouterBitrate; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let req = unwrap_request(builder_with(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn model_is_correct() { + let req = unwrap_request(builder_with(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0Mini))); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(builder_with(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(builder_with(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(builder_with(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn batch_count_clamped_to_platform_max() { + // The ArtCraft platform caps batch at 4 and downgrades higher requests. + let req = unwrap_request(builder_with(|b| { b.video_batch_count = Some(8); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(builder_with(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn wide() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideSixteenByNine)); + } + + #[test] + fn ultra_wide() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideTwentyOneByNine); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideTwentyOneByNine)); + } + + #[test] + fn tall() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::TallNineBySixteen)); + } + + #[test] + fn square() { + let req = unwrap_request(builder_with(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::Square)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(builder_with(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_mini(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(builder_with(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(builder_with(|b| { b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_mini(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ]; + let req = unwrap_request(builder_with(|b| { b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![ + CharacterToken::new("char_a".to_string()), + CharacterToken::new("char_b".to_string()), + ]; + let req = unwrap_request(builder_with(|b| { b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + fn builder_with(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0MiniRequestState { + let result = build_artcraft_seedance_2p0_mini(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0Mini(state)) => state, + _ => panic!("expected ArtcraftSeedance2p0Mini request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/cost.rs new file mode 100644 index 00000000..63427197 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/cost.rs @@ -0,0 +1,176 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_mini_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_mini::request::ArtcraftSeedance2p0MiniRequestState; + +pub struct ArtcraftSeedance2p0MiniCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0MiniCostState { + pub fn from_request(request: &ArtcraftSeedance2p0MiniRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Seedance 2.0 Mini is priced uniformly across its variants; see + // seedance_common::seedance_2p0_mini_usd_cents. + let usd_cents = seedance_2p0_mini_usd_cents( + self.resolution, + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + + // ArtCraft credits: 100 credits = $1.00, so credits = cents. + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + + // Every combination, driven through the full build pipeline. These prices are + // the supplier's per-combo cost plus a 5% margin, rounded up to whole cents. + + mod pricing_480p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(cents(RouterResolution::FourEightyP, 4, 1, false), 13); + assert_eq!(cents(RouterResolution::FourEightyP, 5, 1, false), 17); + assert_eq!(cents(RouterResolution::FourEightyP, 10, 1, false), 33); + assert_eq!(cents(RouterResolution::FourEightyP, 15, 1, false), 49); + } + + #[test] + fn with_video_reference() { + assert_eq!(cents(RouterResolution::FourEightyP, 4, 1, true), 17); + assert_eq!(cents(RouterResolution::FourEightyP, 5, 1, true), 21); + assert_eq!(cents(RouterResolution::FourEightyP, 10, 1, true), 42); + assert_eq!(cents(RouterResolution::FourEightyP, 15, 1, true), 62); + } + } + + mod pricing_720p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(cents(RouterResolution::SevenTwentyP, 4, 1, false), 35); + assert_eq!(cents(RouterResolution::SevenTwentyP, 5, 1, false), 44); + assert_eq!(cents(RouterResolution::SevenTwentyP, 10, 1, false), 87); + assert_eq!(cents(RouterResolution::SevenTwentyP, 15, 1, false), 130); + } + + #[test] + fn with_video_reference() { + assert_eq!(cents(RouterResolution::SevenTwentyP, 4, 1, true), 42); + assert_eq!(cents(RouterResolution::SevenTwentyP, 5, 1, true), 52); + assert_eq!(cents(RouterResolution::SevenTwentyP, 10, 1, true), 104); + assert_eq!(cents(RouterResolution::SevenTwentyP, 15, 1, true), 156); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cents_no_ref(None, 5, 1), cents(RouterResolution::SevenTwentyP, 5, 1, false)); + } + } + + mod credits_tests { + use super::*; + + #[test] + fn credits_equal_usd_cents_all_combos() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + None, + ]; + for res in resolutions { + for dur in [4u16, 5, 10, 15] { + for batch in [1u16, 2, 4] { + for has_ref in [false, true] { + let cost = build_cost(res, dur, batch, has_ref); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + } + } + } + } + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + with_video_reference: bool, + ) -> VideoGenerationCostEstimate { + let reference_videos = with_video_reference.then(|| { + VideoListRef::MediaFileTokens(vec![MediaFileToken::new("mf_ref".to_string())]) + }); + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + reference_videos, + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + } + + fn cents( + resolution: RouterResolution, + duration_seconds: u16, + video_batch_count: u16, + with_video_reference: bool, + ) -> u64 { + build_cost(Some(resolution), duration_seconds, video_batch_count, with_video_reference) + .cost_in_usd_cents + .unwrap() + } + + fn cents_no_ref( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> u64 { + build_cost(resolution, duration_seconds, video_batch_count, false) + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/request.rs new file mode 100644 index 00000000..b59f1085 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_mini/request.rs @@ -0,0 +1,86 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0MiniRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0MiniRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..mini_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..mini_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + fn mini_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + request.send_request(&client).await.expect("send_request should succeed") + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/build.rs new file mode 100644 index 00000000..788053a9 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/build.rs @@ -0,0 +1,189 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u::request::ArtcraftSeedance2p0UltraRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_u(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0Ultra, + SupportedResolutions::FullWith4k, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0UltraRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0Ultra(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Field conversions ── + + mod field_conversions { + use super::*; + + #[test] + fn model_is_seedance_2p0() { + let req = unwrap_request(make_builder(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0Ultra))); + } + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(make_builder(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(make_builder(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::TenEightyP)); + } + + #[test] + fn res_4k() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourK); })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourK)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Media tokens ── + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_u(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![MediaFileToken::new("mf_a".to_string()), MediaFileToken::new("mf_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![CharacterToken::new("char_a".to_string()), CharacterToken::new("char_b".to_string())]; + let req = unwrap_request(make_builder(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0UltraRequestState { + let result = build_artcraft_seedance_2p0_u(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0Ultra(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0 request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/cost.rs new file mode 100644 index 00000000..19ad0cc0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/cost.rs @@ -0,0 +1,237 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::providers::artcraft::seedance_common::seedance_2p0_four_k_usd_cents; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u::request::ArtcraftSeedance2p0UltraRequestState; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +// ── Pricing constants ── + +const CENTS_PER_SECOND_480P: f64 = 5.4404; +const CENTS_PER_SECOND_720P: f64 = 11.2; +const CENTS_PER_SECOND_1080P: f64 = 32.6424; + +pub struct ArtcraftSeedance2p0UltraCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, + pub has_video_reference: bool, +} + +impl ArtcraftSeedance2p0UltraCostState { + pub fn from_request(request: &ArtcraftSeedance2p0UltraRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + let has_video_reference = request.request.reference_video_media_tokens + .as_ref() + .is_some_and(|tokens| !tokens.is_empty()); + + Self { resolution, duration_seconds, batch_count, has_video_reference } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + if self.resolution == CommonResolution::FourK { + let usd_cents = seedance_2p0_four_k_usd_cents( + self.duration_seconds, + self.batch_count, + self.has_video_reference, + ); + return VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + }; + } + + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + CommonResolution::TenEightyP => CENTS_PER_SECOND_1080P, + _ => CENTS_PER_SECOND_720P, + }; + + let cents_per_video = (cents_per_second * self.duration_seconds as f64).ceil() as u64; + let usd_cents = cents_per_video * self.batch_count as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + // 11.2 * 5 = 56¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 56); + // 11.2 * 10 = 112¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 112); + // 11.2 * 15 = 168¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 168); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 2), 112); + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 2), 224); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 4), 224); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 10, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1)); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + // 5.4404 * 5 = 27.202 → ceil = 28¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 28); + // 5.4404 * 10 = 54.404 → ceil = 55¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 55); + // 5.4404 * 15 = 81.606 → ceil = 82¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 82); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 4), 220); + } + } + + mod pricing_1080p { + use super::*; + + #[test] + fn batch_1() { + // 32.6424 * 5 = 163.212 → ceil = 164¢ + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5, 1), 164); + // 32.6424 * 10 = 326.424 → ceil = 327¢ + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 1), 327); + // 32.6424 * 15 = 489.636 → ceil = 490¢ + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15, 1), 490); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10, 4), 1308); + } + } + + mod four_k_pricing { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + + fn artcraft_4k_cents(duration_seconds: u16, batch_count: u16, has_video_reference: bool) -> u64 { + super::super::ArtcraftSeedance2p0UltraCostState { + resolution: CommonResolution::FourK, + duration_seconds, + batch_count, + has_video_reference, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + #[test] + fn explicit_4k_without_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, false), 347); + assert_eq!(artcraft_4k_cents(5, 1, false), 433); + assert_eq!(artcraft_4k_cents(10, 1, false), 866); + assert_eq!(artcraft_4k_cents(15, 1, false), 1299); + } + + #[test] + fn explicit_4k_with_video_reference() { + assert_eq!(artcraft_4k_cents(4, 1, true), 416); + assert_eq!(artcraft_4k_cents(5, 1, true), 519); + assert_eq!(artcraft_4k_cents(10, 1, true), 1038); + assert_eq!(artcraft_4k_cents(15, 1, true), 1557); + } + } + + mod relative_pricing { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p_cheaper_than_1080p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 10, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 10, 1); + assert!(c480 < c720); + assert!(c720 < c1080); + } + + #[test] + fn cost_scales_with_duration() { + let c5 = cost_cents(None, 5, 1); + let c10 = cost_cents(None, 10, 1); + let c15 = cost_cents(None, 15, 1); + assert!(c5 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = cost_cents(None, 10, 1); + let b2 = cost_cents(None, 10, 2); + let b4 = cost_cents(None, 10, 4); + assert!(b1 < b2); + assert!(b2 < b4); + } + + #[test] + fn credits_equal_usd_cents() { + let cost = build_cost(None, 10, 1); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Ultra, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2().expect("build2").estimate_cost().expect("estimate_cost") + } + + fn cost_cents(resolution: Option, duration_seconds: u16, batch: u16) -> u64 { + build_cost(resolution, duration_seconds, batch).cost_in_usd_cents.unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/request.rs new file mode 100644 index 00000000..695005aa --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u/request.rs @@ -0,0 +1,237 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0UltraRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0UltraRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use test_data::web::character_tokens::{JIM, KNIGHT}; + use test_data::web::image_media_tokens::{ + FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN, + JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN, + WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN, + }; + + // -- Aspect ratio tests -- + + mod aspect_ratio_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn landscape() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn portrait() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A cat sitting on a windowsill watching rain.".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn square() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A hummingbird hovering near a flower.".to_string()), + aspect_ratio: Some(RouterAspectRatio::Square), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Resolution tests -- + + mod resolution_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn res_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A golden retriever catching a frisbee on the beach.".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn res_1080p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A fox walking through a snowy forest.".to_string()), + resolution: Some(RouterResolution::TenEightyP), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Modality tests -- + + mod modality_tests { + use super::*; + use test_data::web::image_media_tokens::TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN; + + #[tokio::test] + #[ignore] + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A whale breaching in the open ocean at dawn, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn keyframe_start_and_end_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog walks from the lake to the forest.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + end_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()))), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn image_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog in @2 runs through the scenery in @1 towards the building in @3.".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn character_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("@Jim and @Knight are sparring in a medieval arena.".to_string()), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new(JIM.token.to_string()), + CharacterToken::new(KNIGHT.token.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Helpers -- + + fn artcraft_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/build.rs new file mode 100644 index 00000000..a89afb49 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/build.rs @@ -0,0 +1,253 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u_fast::request::ArtcraftSeedance2p0UltraFastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_seedance_2p0_u_fast(builder: GenerateVideoRequestBuilder) -> Result { + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Seedance2p0UltraFast, + SupportedResolutions::Fast, + UltraWideSupport::Supported, + )?; + let state = ArtcraftSeedance2p0UltraFastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSeedance2p0UltraFast(state))) +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_aspect_ratio::CommonAspectRatio as CommonAspectRatioEnum; + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + use artcraft_client::enums::common::generation::common_bitrate::CommonBitrate as CommonBitrateEnum; + use crate::api::router_bitrate::RouterBitrate; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Field conversions ── + + mod field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.prompt = Some("test".to_string()); })); + assert_eq!(req.request.prompt, Some("test".to_string())); + } + + #[test] + fn prompt_none_stays_none() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(req.request.prompt.is_none()); + } + + #[test] + fn model_is_seedance_2p0_fast() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(matches!(req.request.model, Some(CommonVideoModelEnum::Seedance2p0UltraFast))); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration_seconds, Some(10)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration_seconds, Some(15)); + } + + #[test] + fn batch_count_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.video_batch_count = Some(4); })); + assert_eq!(req.request.video_batch_count, Some(4)); + } + + #[test] + fn bitrate_passed_through() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { b.bitrate = Some(RouterBitrate::High); })); + assert_eq!(req.request.bitrate, Some(CommonBitrateEnum::High)); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn wide() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::WideSixteenByNine)); + } + + #[test] + fn tall() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::TallNineBySixteen)); + } + + #[test] + fn square() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.aspect_ratio = Some(RouterAspectRatio::Square); + })); + assert_eq!(req.request.aspect_ratio, Some(CommonAspectRatioEnum::Square)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(req.request.aspect_ratio.is_none()); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.resolution = Some(RouterResolution::FourEightyP); + })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.resolution = Some(RouterResolution::SevenTwentyP); + })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_downgrades_to_720p() { + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.resolution = Some(RouterResolution::TenEightyP); + })); + assert_eq!(req.request.resolution, Some(CommonResolutionEnum::SevenTwentyP)); + } + + #[test] + fn res_1080p_error_out() { + let result = build_artcraft_seedance_2p0_u_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(artcraft_fast_builder_with(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Media tokens ── + + mod media_token_tests { + use super::*; + + #[test] + fn start_frame_token_passed_through() { + let token = MediaFileToken::new("mf_start".to_string()); + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(token.clone())); + })); + assert_eq!(req.request.start_frame_image_media_token, Some(token)); + } + + #[test] + fn url_start_frame_rejected() { + let result = build_artcraft_seedance_2p0_u_fast(GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::Artcraft, + start_frame: Some(ImageRef::Url("https://example.com".to_string())), + ..Default::default() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_tokens_passed_through() { + let tokens = vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ]; + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_image_media_tokens, Some(tokens)); + } + + #[test] + fn character_tokens_passed_through() { + let tokens = vec![ + CharacterToken::new("char_a".to_string()), + CharacterToken::new("char_b".to_string()), + ]; + let req = unwrap_request(artcraft_fast_builder_with(|b| { + b.reference_character_tokens = Some(CharacterListRef::CharacterTokens(tokens.clone())); + })); + assert_eq!(req.request.reference_character_tokens, Some(tokens)); + } + } + + // ── Helpers ── + + fn artcraft_fast_builder_with(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + }; + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> ArtcraftSeedance2p0UltraFastRequestState { + let result = build_artcraft_seedance_2p0_u_fast(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::ArtcraftSeedance2p0UltraFast(state) + ) => state, + _ => panic!("expected ArtcraftSeedance2p0Fast request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/cost.rs new file mode 100644 index 00000000..b3ec7e69 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/cost.rs @@ -0,0 +1,168 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u_fast::request::ArtcraftSeedance2p0UltraFastRequestState; + +// ── Pricing constants ── + +const CENTS_PER_SECOND_480P: f64 = 3.6267; +const CENTS_PER_SECOND_720P: f64 = 8.9089; + +pub struct ArtcraftSeedance2p0UltraFastCostState { + pub resolution: CommonResolution, + pub duration_seconds: u16, + pub batch_count: u16, +} + +impl ArtcraftSeedance2p0UltraFastCostState { + pub fn from_request(request: &ArtcraftSeedance2p0UltraFastRequestState) -> Self { + let resolution = request.request.resolution + .unwrap_or(CommonResolution::SevenTwentyP); + let duration_seconds = request.request.duration_seconds.unwrap_or(5); + let batch_count = request.request.video_batch_count.unwrap_or(1); + + Self { resolution, duration_seconds, batch_count } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cents_per_second = match self.resolution { + CommonResolution::FourEightyP => CENTS_PER_SECOND_480P, + // Fast model doesn't support 1080p; all non-480p resolves to 720p pricing + _ => CENTS_PER_SECOND_720P, + }; + + let cents_per_video = (cents_per_second * self.duration_seconds as f64).ceil() as u64; + let usd_cents = cents_per_video * self.batch_count as u64; + + VideoGenerationCostEstimate { + cost_in_credits: Some(usd_cents), + cost_in_usd_cents: Some(usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn batch_1() { + // 8.9089 * 5 = 44.5445 → ceil = 45¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, 1), 45); + // 8.9089 * 10 = 89.089 → ceil = 90¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1), 90); + // 8.9089 * 15 = 133.6335 → ceil = 134¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, 1), 134); + } + + #[test] + fn batch_2() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 2), 180); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, 4), 360); + } + + #[test] + fn none_defaults_to_720p() { + assert_eq!(cost_cents(None, 10, 1), cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1)); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn batch_1() { + // 3.6267 * 5 = 18.1335 → ceil = 19¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, 1), 19); + // 3.6267 * 10 = 36.267 → ceil = 37¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 1), 37); + // 3.6267 * 15 = 54.4005 → ceil = 55¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, 1), 55); + } + + #[test] + fn batch_4() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, 4), 148); + } + } + + mod relative_pricing { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 10, 1); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + assert!(c480 < c720, "480p ({c480}) should be < 720p ({c720})"); + } + + #[test] + fn cost_scales_with_duration() { + let c5 = cost_cents(None, 5, 1); + let c10 = cost_cents(None, 10, 1); + let c15 = cost_cents(None, 15, 1); + assert!(c5 < c10); + assert!(c10 < c15); + } + + #[test] + fn fast_g_cheaper_than_standard_g() { + let fast = cost_cents(Some(RouterResolution::SevenTwentyP), 10, 1); + let standard = { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Ultra, + provider: RouterProvider::Artcraft, + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(10), + video_batch_count: Some(1), + ..Default::default() + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + }; + assert!(fast < standard, "Fast ({fast}¢) should be < Standard ({standard}¢)"); + } + + #[test] + fn credits_equal_usd_cents() { + let cost = build_cost(None, 10, 1); + assert_eq!(cost.cost_in_credits, cost.cost_in_usd_cents); + } + } + + // -- Helpers -- + + fn build_cost( + resolution: Option, + duration_seconds: u16, + video_batch_count: u16, + ) -> crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::Artcraft, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + builder.build2().expect("build2").estimate_cost().expect("estimate_cost") + } + + fn cost_cents(resolution: Option, duration_seconds: u16, batch: u16) -> u64 { + build_cost(resolution, duration_seconds, batch).cost_in_usd_cents.unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/request.rs new file mode 100644 index 00000000..e84f1718 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_2p0_u_fast/request.rs @@ -0,0 +1,227 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSeedance2p0UltraFastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSeedance2p0UltraFastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + + use test_data::web::character_tokens::{JIM, KNIGHT}; + use test_data::web::image_media_tokens::{ + FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN, + JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN, + WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN, + }; + + // -- Aspect ratio tests -- + + mod aspect_ratio_tests { + use super::*; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn landscape() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn portrait() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A cat sitting on a windowsill watching rain.".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn square() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A hummingbird hovering near a flower.".to_string()), + aspect_ratio: Some(RouterAspectRatio::Square), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Resolution tests -- + + mod resolution_tests { + use super::*; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + resolution: Some(RouterResolution::FourEightyP), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn res_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A golden retriever catching a frisbee on the beach.".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Modality tests -- + + mod modality_tests { + use super::*; + use test_data::web::image_media_tokens::TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN; + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A sky whale breaching in the open sky, pink clouds at dawn, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn keyframe_start_and_end_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog walks from the lake to the forest.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + end_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()))), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn image_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog in @2 runs through the scenery in @1 towards the building in @3.".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new(FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN.to_string()), + MediaFileToken::new(WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // manually run — fires a real API request and incurs cost + async fn character_references() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("@Jim and @Knight are sparring in a medieval arena.".to_string()), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new(JIM.token.to_string()), + CharacterToken::new(KNIGHT.token.to_string()), + ])), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_fast_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // -- Helpers -- + + fn artcraft_fast_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::Artcraft, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/seedance_common.rs b/crates/router/src/generate/generate_video/providers/artcraft/seedance_common.rs new file mode 100644 index 00000000..f7de0998 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/seedance_common.rs @@ -0,0 +1,328 @@ +//! Shared pricing for the Seedance 2.0 family of ArtCraft providers. +//! +//! ArtCraft credits equal USD cents (100 credits = $1.00). + +use artcraft_client::enums::common::generation::common_resolution::CommonResolution; + +// 4K is priced uniformly across the non-Fast Seedance 2.0 models. Rates are held +// in hundredths of a USD cent per second so the math is exact integer arithmetic +// (no floating point), then rounded up to whole cents. + +/// 4K output price, in hundredths of a USD cent per second (86.60 ¢/s). +const FOUR_K_CENTI_CENTS_PER_SECOND: u64 = 8660; + +/// Extra hundredths of a USD cent per second when a reference video is attached +/// at 4K (17.20 ¢/s surcharge). +const FOUR_K_VIDEO_REFERENCE_SURCHARGE_CENTI_CENTS_PER_SECOND: u64 = 1720; + +/// ArtCraft's user-facing price (USD cents) for Seedance 2.0 at 4K. +/// +/// A reference video adds a per-second surcharge (4K with and without a video +/// reference are priced differently). The cost scales with duration and batch +/// count, rounded up to whole cents. +pub fn seedance_2p0_four_k_usd_cents( + duration_seconds: u16, + batch_count: u16, + has_video_reference: bool, +) -> u64 { + let mut centi_cents_per_second = FOUR_K_CENTI_CENTS_PER_SECOND; + if has_video_reference { + centi_cents_per_second += FOUR_K_VIDEO_REFERENCE_SURCHARGE_CENTI_CENTS_PER_SECOND; + } + + let total_centi_cents = + centi_cents_per_second * duration_seconds as u64 * batch_count as u64; + + // Round up to whole cents. + total_centi_cents.div_ceil(100) +} + +// ── Seedance 2.0 Mini pricing ── +// +// Mini offers only 480p and 720p. The rates below are the per-second USER price +// in USD cents (margin already included); a reference video adds a per-second +// surcharge. Rates are fractional, so the total is rounded UP to a whole cent +// once at the end (after multiplying by duration × batch). +// +// The regular Mini and the BytePlus / BytePlus Ultra Minis carry DIFFERENT +// margins, so they have separate rate sets and helpers below. + +/// Regular Mini — 480p price, USD cents per second. +const MINI_CENTS_PER_SECOND_480P: f64 = 3.24074074; +/// Regular Mini — 480p reference-video surcharge, USD cents per second. +const MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_480P: f64 = 0.86419753; +/// Regular Mini — 720p price, USD cents per second. +const MINI_CENTS_PER_SECOND_720P: f64 = 8.64197531; +/// Regular Mini — 720p reference-video surcharge, USD cents per second. +const MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_720P: f64 = 1.72839506; + +/// BytePlus / BytePlus Ultra Mini — 480p price, USD cents per second. +const BYTEPLUS_MINI_CENTS_PER_SECOND_480P: f64 = 3.27160494; +/// BytePlus / BytePlus Ultra Mini — 480p reference-video surcharge, USD cents per second. +const BYTEPLUS_MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_480P: f64 = 0.87242798; +/// BytePlus / BytePlus Ultra Mini — 720p price, USD cents per second. +const BYTEPLUS_MINI_CENTS_PER_SECOND_720P: f64 = 8.72427984; +/// BytePlus / BytePlus Ultra Mini — 720p reference-video surcharge, USD cents per second. +const BYTEPLUS_MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_720P: f64 = 1.74485597; + +/// ArtCraft's user-facing price (USD cents) for the regular Seedance 2.0 Mini. +/// +/// Only 480p and 720p are offered; any other resolution prices at 720p. A +/// reference video adds the per-second surcharge. The fractional total is +/// rounded UP to a whole cent. +pub fn seedance_2p0_mini_usd_cents( + resolution: CommonResolution, + duration_seconds: u16, + batch_count: u16, + has_video_reference: bool, +) -> u64 { + mini_usd_cents( + resolution, + duration_seconds, + batch_count, + has_video_reference, + MINI_CENTS_PER_SECOND_480P, + MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_480P, + MINI_CENTS_PER_SECOND_720P, + MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_720P, + ) +} + +/// ArtCraft's user-facing price (USD cents) for the Seedance 2.0 BytePlus Mini +/// and BytePlus Ultra Mini (which share the same rates — a higher margin than +/// the regular Mini). +/// +/// Only 480p and 720p are offered; any other resolution prices at 720p. A +/// reference video adds the per-second surcharge. The fractional total is +/// rounded UP to a whole cent. +pub fn seedance_2p0_byteplus_mini_usd_cents( + resolution: CommonResolution, + duration_seconds: u16, + batch_count: u16, + has_video_reference: bool, +) -> u64 { + mini_usd_cents( + resolution, + duration_seconds, + batch_count, + has_video_reference, + BYTEPLUS_MINI_CENTS_PER_SECOND_480P, + BYTEPLUS_MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_480P, + BYTEPLUS_MINI_CENTS_PER_SECOND_720P, + BYTEPLUS_MINI_VIDEO_REFERENCE_SURCHARGE_CENTS_PER_SECOND_720P, + ) +} + +#[allow(clippy::too_many_arguments)] +fn mini_usd_cents( + resolution: CommonResolution, + duration_seconds: u16, + batch_count: u16, + has_video_reference: bool, + cents_per_second_480p: f64, + video_reference_surcharge_per_second_480p: f64, + cents_per_second_720p: f64, + video_reference_surcharge_per_second_720p: f64, +) -> u64 { + let (base_per_second, video_reference_surcharge_per_second) = match resolution { + CommonResolution::FourEightyP => (cents_per_second_480p, video_reference_surcharge_per_second_480p), + // Everything else (including 720p and unsupported resolutions) prices at 720p. + _ => (cents_per_second_720p, video_reference_surcharge_per_second_720p), + }; + + let mut cents_per_second = base_per_second; + if has_video_reference { + cents_per_second += video_reference_surcharge_per_second; + } + + (cents_per_second * duration_seconds as f64 * batch_count as f64).ceil() as u64 +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn four_k_without_video_reference() { + assert_eq!(seedance_2p0_four_k_usd_cents(4, 1, false), 347); + assert_eq!(seedance_2p0_four_k_usd_cents(5, 1, false), 433); + assert_eq!(seedance_2p0_four_k_usd_cents(10, 1, false), 866); + assert_eq!(seedance_2p0_four_k_usd_cents(15, 1, false), 1299); + } + + #[test] + fn four_k_with_video_reference() { + assert_eq!(seedance_2p0_four_k_usd_cents(4, 1, true), 416); + assert_eq!(seedance_2p0_four_k_usd_cents(5, 1, true), 519); + assert_eq!(seedance_2p0_four_k_usd_cents(10, 1, true), 1038); + assert_eq!(seedance_2p0_four_k_usd_cents(15, 1, true), 1557); + } + + #[test] + fn video_reference_always_costs_more() { + for &duration in &[4u16, 5, 10, 15] { + assert!( + seedance_2p0_four_k_usd_cents(duration, 1, true) + > seedance_2p0_four_k_usd_cents(duration, 1, false), + "video reference should cost more at {duration}s", + ); + } + } + + #[test] + fn batch_count_multiplies() { + assert_eq!(seedance_2p0_four_k_usd_cents(5, 2, false), 866); + assert_eq!(seedance_2p0_four_k_usd_cents(5, 4, false), 1732); + assert_eq!(seedance_2p0_four_k_usd_cents(5, 2, true), 1038); + } + + // ── Seedance 2.0 Mini ── + // + // Every combination (480p/720p × with/without video reference × 4/5/10/15s) + // at batch 1. These are the supplier's per-combo cost plus a 5% margin, + // rounded up to whole cents. + + mod mini { + use super::*; + + fn cents(res: CommonResolution, dur: u16, has_ref: bool) -> u64 { + seedance_2p0_mini_usd_cents(res, dur, 1, has_ref) + } + + #[test] + fn four_eighty_p_without_video_reference() { + assert_eq!(cents(CommonResolution::FourEightyP, 4, false), 13); + assert_eq!(cents(CommonResolution::FourEightyP, 5, false), 17); + assert_eq!(cents(CommonResolution::FourEightyP, 10, false), 33); + assert_eq!(cents(CommonResolution::FourEightyP, 15, false), 49); + } + + #[test] + fn four_eighty_p_with_video_reference() { + assert_eq!(cents(CommonResolution::FourEightyP, 4, true), 17); + assert_eq!(cents(CommonResolution::FourEightyP, 5, true), 21); + assert_eq!(cents(CommonResolution::FourEightyP, 10, true), 42); + assert_eq!(cents(CommonResolution::FourEightyP, 15, true), 62); + } + + #[test] + fn seven_twenty_p_without_video_reference() { + assert_eq!(cents(CommonResolution::SevenTwentyP, 4, false), 35); + assert_eq!(cents(CommonResolution::SevenTwentyP, 5, false), 44); + assert_eq!(cents(CommonResolution::SevenTwentyP, 10, false), 87); + assert_eq!(cents(CommonResolution::SevenTwentyP, 15, false), 130); + } + + #[test] + fn seven_twenty_p_with_video_reference() { + assert_eq!(cents(CommonResolution::SevenTwentyP, 4, true), 42); + assert_eq!(cents(CommonResolution::SevenTwentyP, 5, true), 52); + assert_eq!(cents(CommonResolution::SevenTwentyP, 10, true), 104); + assert_eq!(cents(CommonResolution::SevenTwentyP, 15, true), 156); + } + + #[test] + fn video_reference_always_costs_more() { + for res in [CommonResolution::FourEightyP, CommonResolution::SevenTwentyP] { + for dur in [4u16, 5, 10, 15] { + assert!( + cents(res, dur, true) > cents(res, dur, false), + "video ref should cost more at {res:?} {dur}s", + ); + } + } + } + + #[test] + fn unsupported_resolution_prices_at_720p() { + assert_eq!( + seedance_2p0_mini_usd_cents(CommonResolution::TenEightyP, 5, 1, false), + seedance_2p0_mini_usd_cents(CommonResolution::SevenTwentyP, 5, 1, false), + ); + } + + #[test] + fn batch_count_scales_the_total() { + // Batch is baked in before the single round-up, so batched totals can be + // a cent under N× the single price. + assert_eq!(seedance_2p0_mini_usd_cents(CommonResolution::SevenTwentyP, 5, 2, false), 87); + assert_eq!(seedance_2p0_mini_usd_cents(CommonResolution::SevenTwentyP, 5, 4, false), 173); + assert_eq!(seedance_2p0_mini_usd_cents(CommonResolution::FourEightyP, 5, 2, false), 33); + } + } + + // ── Seedance 2.0 BytePlus / BytePlus Ultra Mini ── + // + // Same combinations as the regular Mini, but at a higher margin (6% vs 5%), + // so the prices are equal-or-higher than the regular Mini. + + mod byteplus_mini { + use super::*; + + fn cents(res: CommonResolution, dur: u16, has_ref: bool) -> u64 { + seedance_2p0_byteplus_mini_usd_cents(res, dur, 1, has_ref) + } + + #[test] + fn four_eighty_p_without_video_reference() { + assert_eq!(cents(CommonResolution::FourEightyP, 4, false), 14); + assert_eq!(cents(CommonResolution::FourEightyP, 5, false), 17); + assert_eq!(cents(CommonResolution::FourEightyP, 10, false), 33); + assert_eq!(cents(CommonResolution::FourEightyP, 15, false), 50); + } + + #[test] + fn four_eighty_p_with_video_reference() { + assert_eq!(cents(CommonResolution::FourEightyP, 4, true), 17); + assert_eq!(cents(CommonResolution::FourEightyP, 5, true), 21); + assert_eq!(cents(CommonResolution::FourEightyP, 10, true), 42); + assert_eq!(cents(CommonResolution::FourEightyP, 15, true), 63); + } + + #[test] + fn seven_twenty_p_without_video_reference() { + assert_eq!(cents(CommonResolution::SevenTwentyP, 4, false), 35); + assert_eq!(cents(CommonResolution::SevenTwentyP, 5, false), 44); + assert_eq!(cents(CommonResolution::SevenTwentyP, 10, false), 88); + assert_eq!(cents(CommonResolution::SevenTwentyP, 15, false), 131); + } + + #[test] + fn seven_twenty_p_with_video_reference() { + assert_eq!(cents(CommonResolution::SevenTwentyP, 4, true), 42); + assert_eq!(cents(CommonResolution::SevenTwentyP, 5, true), 53); + assert_eq!(cents(CommonResolution::SevenTwentyP, 10, true), 105); + assert_eq!(cents(CommonResolution::SevenTwentyP, 15, true), 158); + } + + #[test] + fn never_cheaper_than_regular_mini() { + for res in [CommonResolution::FourEightyP, CommonResolution::SevenTwentyP] { + for dur in [4u16, 5, 10, 15] { + for has_ref in [false, true] { + assert!( + seedance_2p0_byteplus_mini_usd_cents(res, dur, 1, has_ref) + >= seedance_2p0_mini_usd_cents(res, dur, 1, has_ref), + "byteplus mini (6%) should be >= regular mini (5%) at {res:?} {dur}s ref={has_ref}", + ); + } + } + } + } + + #[test] + fn unsupported_resolution_prices_at_720p() { + assert_eq!( + seedance_2p0_byteplus_mini_usd_cents(CommonResolution::TenEightyP, 5, 1, false), + seedance_2p0_byteplus_mini_usd_cents(CommonResolution::SevenTwentyP, 5, 1, false), + ); + } + + #[test] + fn batch_count_scales_the_total() { + assert_eq!(seedance_2p0_byteplus_mini_usd_cents(CommonResolution::SevenTwentyP, 5, 2, false), 88); + assert_eq!(seedance_2p0_byteplus_mini_usd_cents(CommonResolution::SevenTwentyP, 5, 4, false), 175); + assert_eq!(seedance_2p0_byteplus_mini_usd_cents(CommonResolution::FourEightyP, 5, 2, false), 33); + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/build.rs new file mode 100644 index 00000000..b2526ace --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/build.rs @@ -0,0 +1,49 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::sora_2::request::ArtcraftSora2RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_sora_2(mut builder: GenerateVideoRequestBuilder) -> Result { + // Sora 2 accepts only {4,8,12} seconds; pre-plan so cost parity holds for + // strategies that error or clamp. + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_sora_2_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Sora2, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftSora2RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSora2(state))) +} + +pub(crate) fn plan_sora_2_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) | Some(8) | Some(12) => Ok(duration_seconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(12)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(4)), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/cost.rs new file mode 100644 index 00000000..0ed26e27 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/cost.rs @@ -0,0 +1,61 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::sora_2::request::ArtcraftSora2RequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftSora2CostState { + pub duration_seconds: u64, +} + +impl ArtcraftSora2CostState { + pub fn from_request(request: &ArtcraftSora2RequestState) -> Self { + Self { + // v1 default: None → 4s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(4), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Sora 2: $0.10/second. Default duration 4s. + let cost_in_usd_cents = self.duration_seconds * 10; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Sora2, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn four_seconds_is_40() { assert_eq!(cost_cents(Some(4)), 40); } + + #[test] + fn eight_seconds_is_80() { assert_eq!(cost_cents(Some(8)), 80); } + + #[test] + fn twelve_seconds_is_120() { assert_eq!(cost_cents(Some(12)), 120); } + + #[test] + fn default_duration_is_4s_priced_at_40() { assert_eq!(cost_cents(None), 40); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/request.rs new file mode 100644 index 00000000..be0c93ae --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSora2RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSora2RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/build.rs new file mode 100644 index 00000000..f576aacb --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/build.rs @@ -0,0 +1,27 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::sora_2::build::plan_sora_2_duration; +use crate::generate::generate_video::providers::artcraft::sora_2_pro::request::ArtcraftSora2ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_sora_2_pro(mut builder: GenerateVideoRequestBuilder) -> Result { + // Sora 2 Pro: same duration constraints as Sora 2 ({4,8,12}); reuse helper. + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_sora_2_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Sora2Pro, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftSora2ProRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftSora2Pro(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/cost.rs new file mode 100644 index 00000000..7008f329 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/cost.rs @@ -0,0 +1,113 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::sora_2_pro::request::ArtcraftSora2ProRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftSora2ProCostState { + pub duration_seconds: u64, + pub is_ten_eighty_p: bool, +} + +impl ArtcraftSora2ProCostState { + pub fn from_request(request: &ArtcraftSora2ProRequestState) -> Self { + let req = &request.request; + Self { + duration_seconds: req.duration_seconds.map(u64::from).unwrap_or(4), + is_ten_eighty_p: is_ten_eighty_p_for_cost(req.resolution, req.start_frame_image_media_token.is_some()), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Sora 2 Pro: $0.30/sec @ 720p, $0.50/sec @ 1080p. Default 4s. + let per_second_cents: u64 = if self.is_ten_eighty_p { 50 } else { 30 }; + let cost_in_usd_cents = per_second_cents * self.duration_seconds; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Fal client defaults: text-to-video → 1080p; image-to-video → Auto (priced as 720p). +fn is_ten_eighty_p_for_cost(resolution: Option, has_start_frame: bool) -> bool { + match resolution { + Some(CommonResolutionEnum::TenEightyP) => true, + Some(CommonResolutionEnum::SevenTwentyP) => false, + // omni-gen drops Auto by returning None; default depends on mode. + Some(_) | None => !has_start_frame, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn cost_cents( + duration_seconds: Option, + resolution: Option, + has_start_frame: bool, + ) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Sora2Pro, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + }; + if has_start_frame { + b.start_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + } + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + mod numeric_literal_pricing { + use super::*; + + #[test] + fn p720_4s_is_120() { assert_eq!(cost_cents(Some(4), Some(RouterResolution::SevenTwentyP), false), 120); } + + #[test] + fn p720_8s_is_240() { assert_eq!(cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), false), 240); } + + #[test] + fn p720_12s_is_360() { assert_eq!(cost_cents(Some(12), Some(RouterResolution::SevenTwentyP), false), 360); } + + #[test] + fn p1080_4s_is_200() { assert_eq!(cost_cents(Some(4), Some(RouterResolution::TenEightyP), false), 200); } + + #[test] + fn p1080_12s_is_600() { assert_eq!(cost_cents(Some(12), Some(RouterResolution::TenEightyP), false), 600); } + + #[test] + fn t2v_default_resolution_priced_as_1080p() { + // T2V (no start_frame) with no resolution → 1080p default → 200¢ at 4s. + assert_eq!(cost_cents(Some(4), None, false), 200); + } + + #[test] + fn i2v_default_resolution_priced_as_720p() { + // I2V (with start_frame) with no resolution → 720p default → 120¢ at 4s. + assert_eq!(cost_cents(Some(4), None, true), 120); + } + } + + #[test] + fn higher_resolution_costs_more() { + let c720 = cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), false); + let c1080 = cost_cents(Some(8), Some(RouterResolution::TenEightyP), false); + assert!(c720 < c1080); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/request.rs new file mode 100644 index 00000000..734d5f88 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/sora_2_pro/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftSora2ProRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftSora2ProRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_2/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/build.rs new file mode 100644 index 00000000..e28fa567 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/build.rs @@ -0,0 +1,50 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::veo_2::request::ArtcraftVeo2RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_veo_2(mut builder: GenerateVideoRequestBuilder) -> Result { + // Veo 2 accepts only {5,6,7,8} seconds; omni-gen helper allows the whole + // 4-15 range, so we pre-plan here to maintain v1 parity (especially for + // strategies that clamp). + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_veo_2_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Veo2, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + let state = ArtcraftVeo2RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftVeo2(state))) +} + +fn plan_veo_2_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) | Some(6) | Some(7) | Some(8) => Ok(duration_seconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(8)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(5)), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_2/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/cost.rs new file mode 100644 index 00000000..6d21b61e --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/cost.rs @@ -0,0 +1,65 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::veo_2::request::ArtcraftVeo2RequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo2CostState { + pub duration_seconds: u64, +} + +impl ArtcraftVeo2CostState { + pub fn from_request(request: &ArtcraftVeo2RequestState) -> Self { + Self { + // v1 default: None → 5s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(5), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // 5s = $2.75, +$0.55/s above 5s. + let extra = self.duration_seconds.saturating_sub(5); + let cost_in_usd_cents = 275 + extra * 55; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo2, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn default_is_5s_priced_at_275() { assert_eq!(cost_cents(None), 275); } + + #[test] + fn five_seconds_is_275() { assert_eq!(cost_cents(Some(5)), 275); } + + #[test] + fn six_seconds_is_330() { assert_eq!(cost_cents(Some(6)), 330); } + + #[test] + fn seven_seconds_is_385() { assert_eq!(cost_cents(Some(7)), 385); } + + #[test] + fn eight_seconds_is_440() { assert_eq!(cost_cents(Some(8)), 440); } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_2/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_2/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/request.rs new file mode 100644 index 00000000..47aad9f6 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_2/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo2RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftVeo2RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/build.rs new file mode 100644 index 00000000..84b53bb8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/build.rs @@ -0,0 +1,27 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::veo_3::request::ArtcraftVeo3RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_veo_3(builder: GenerateVideoRequestBuilder) -> Result { + // Veo 3 cost depends on raw user-requested duration (v1's `duration_seconds_raw`) + // and on generate_audio — both survive omni-gen unchanged because their values + // are within omni-gen's accepted ranges. We just preserve generate_audio + // through the helper, then read both fields in cost.rs. + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Veo3, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + let state = ArtcraftVeo3RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftVeo3(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/cost.rs new file mode 100644 index 00000000..3d6ff6a7 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/cost.rs @@ -0,0 +1,88 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::veo_3::request::ArtcraftVeo3RequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3CostState { + pub duration_seconds: u64, + pub generate_audio: bool, +} + +impl ArtcraftVeo3CostState { + pub fn from_request(request: &ArtcraftVeo3RequestState) -> Self { + Self { + duration_seconds: duration_seconds_for_cost(request.request.duration_seconds), + // v1 legacy Veo 3 handler defaults generate_audio to false. + generate_audio: request.request.generate_audio.unwrap_or(false), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // $0.24/sec audio off, $0.48/sec audio on. + let per_second_cents: u64 = if self.generate_audio { 48 } else { 24 }; + let cost_in_usd_cents = per_second_cents * self.duration_seconds; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Mirrors v1 `duration_seconds_for_cost`: s≤4 → 4, s≤6 → 6, else → 8 (incl. None and 7+). +fn duration_seconds_for_cost(d: Option) -> u64 { + match d { + Some(s) if s <= 4 => 4, + Some(s) if s <= 6 => 6, + _ => 8, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_off_4s_is_96() { assert_eq!(cost_cents(Some(4), Some(false)), 96); } + + #[test] + fn audio_off_6s_is_144() { assert_eq!(cost_cents(Some(6), Some(false)), 144); } + + #[test] + fn audio_off_8s_is_192() { assert_eq!(cost_cents(Some(8), Some(false)), 192); } + + #[test] + fn audio_on_4s_is_192() { assert_eq!(cost_cents(Some(4), Some(true)), 192); } + + #[test] + fn audio_on_8s_is_384() { assert_eq!(cost_cents(Some(8), Some(true)), 384); } + + #[test] + fn default_duration_is_8s() { + assert_eq!(cost_cents(None, Some(false)), cost_cents(Some(8), Some(false))); + } + + #[test] + fn audio_default_is_off() { + // None → audio defaults to false. + assert_eq!(cost_cents(Some(8), None), cost_cents(Some(8), Some(false))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/request.rs new file mode 100644 index 00000000..9a8fcd86 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftVeo3RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/build.rs new file mode 100644 index 00000000..79b44cff --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/build.rs @@ -0,0 +1,26 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::veo_3_fast::request::ArtcraftVeo3FastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_veo_3_fast(builder: GenerateVideoRequestBuilder) -> Result { + // Veo 3 Fast always bills 8s (v1 maps everything to EightSeconds). We preserve + // generate_audio, and rely on cost.rs to bill 8s regardless of the request's + // stored duration. + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Veo3Fast, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + let state = ArtcraftVeo3FastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftVeo3Fast(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/cost.rs new file mode 100644 index 00000000..dfd06dbe --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/cost.rs @@ -0,0 +1,70 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::veo_3_fast::request::ArtcraftVeo3FastRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3FastCostState { + pub generate_audio: bool, +} + +impl ArtcraftVeo3FastCostState { + pub fn from_request(request: &ArtcraftVeo3FastRequestState) -> Self { + Self { + // v1 legacy Veo 3 Fast handler defaults generate_audio to false. + generate_audio: request.request.generate_audio.unwrap_or(false), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Flat per-video price: 88¢ audio off, 132¢ audio on. + let cost_in_usd_cents: u64 = if self.generate_audio { 132 } else { 88 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3Fast, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_off_is_88() { assert_eq!(cost_cents(Some(8), Some(false)), 88); } + + #[test] + fn audio_on_is_132() { assert_eq!(cost_cents(Some(8), Some(true)), 132); } + + #[test] + fn audio_default_is_off() { + assert_eq!(cost_cents(Some(8), None), 88); + } + + #[test] + fn duration_does_not_affect_cost() { + // v1 always bills 8s regardless of duration_seconds. + assert_eq!(cost_cents(Some(4), Some(false)), 88); + assert_eq!(cost_cents(Some(6), Some(false)), 88); + assert_eq!(cost_cents(Some(8), Some(false)), 88); + assert_eq!(cost_cents(None, Some(false)), 88); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/request.rs new file mode 100644 index 00000000..2653da4a --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3_fast/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3FastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftVeo3FastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/build.rs new file mode 100644 index 00000000..79021bd1 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/build.rs @@ -0,0 +1,53 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::veo_3p1::request::ArtcraftVeo3p1RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_veo_3p1(mut builder: GenerateVideoRequestBuilder) -> Result { + // Veo 3.1 accepts only {4,6,8} seconds; pre-plan so cost parity holds for + // strategies that error or clamp. Also preserve generate_audio (omni-gen + // helper hardcodes None on output). + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_veo_3p1_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Veo3p1, + SupportedResolutions::FullWith4k, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + + let state = ArtcraftVeo3p1RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftVeo3p1(state))) +} + +pub(crate) fn plan_veo_3p1_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) | Some(6) | Some(8) => Ok(duration_seconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(8)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(4)), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/cost.rs new file mode 100644 index 00000000..af0591f9 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/cost.rs @@ -0,0 +1,114 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::veo_3p1::request::ArtcraftVeo3p1RequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3p1CostState { + pub duration_seconds: u64, + pub generate_audio: bool, + pub is_4k: bool, +} + +impl ArtcraftVeo3p1CostState { + pub fn from_request(request: &ArtcraftVeo3p1RequestState) -> Self { + Self { + // v1 legacy Veo 3.1 multi-function handler defaults None → 6s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(6), + // v1 legacy Veo 3.1 handler defaults generate_audio to true. + generate_audio: request.request.generate_audio.unwrap_or(true), + is_4k: request.request.resolution == Some(CommonResolutionEnum::FourK), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // $0.24/sec audio off, $0.48/sec audio on; 4K renders bill a premium: + // $0.48/sec audio off, $0.72/sec audio on. + let per_second_cents: u64 = match (self.is_4k, self.generate_audio) { + (false, false) => 24, + (false, true) => 48, + (true, false) => 48, + (true, true) => 72, + }; + let cost_in_usd_cents = per_second_cents * self.duration_seconds; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + cost_cents_at(duration_seconds, generate_audio, None) + } + + fn cost_cents_at( + duration_seconds: Option, + generate_audio: Option, + resolution: Option, + ) -> u64 { + let b = GenerateVideoRequestBuilder { + resolution, + model: RouterVideoModel::Veo3p1, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_on_4s_is_192() { assert_eq!(cost_cents(Some(4), Some(true)), 192); } + + #[test] + fn audio_on_6s_is_288() { assert_eq!(cost_cents(Some(6), Some(true)), 288); } + + #[test] + fn audio_on_8s_is_384() { assert_eq!(cost_cents(Some(8), Some(true)), 384); } + + #[test] + fn audio_off_4s_is_96() { assert_eq!(cost_cents(Some(4), Some(false)), 96); } + + #[test] + fn default_duration_is_6s() { + assert_eq!(cost_cents(None, Some(true)), 288); + } + + #[test] + fn audio_default_is_on() { + assert_eq!(cost_cents(Some(6), None), 288); + } + + #[test] + fn four_k_audio_off_4s_is_192() { + assert_eq!(cost_cents_at(Some(4), Some(false), Some(RouterResolution::FourK)), 192); + } + + #[test] + fn four_k_audio_on_4s_is_288() { + assert_eq!(cost_cents_at(Some(4), Some(true), Some(RouterResolution::FourK)), 288); + } + + #[test] + fn non_four_k_resolutions_share_the_base_rate() { + assert_eq!( + cost_cents_at(Some(8), Some(true), Some(RouterResolution::SevenTwentyP)), + cost_cents_at(Some(8), Some(true), Some(RouterResolution::TenEightyP)), + ); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/request.rs new file mode 100644 index 00000000..553226b2 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3p1RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftVeo3p1RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/build.rs new file mode 100644 index 00000000..e5223829 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/build.rs @@ -0,0 +1,30 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::veo_3p1::build::plan_veo_3p1_duration; +use crate::generate::generate_video::providers::artcraft::veo_3p1_fast::request::ArtcraftVeo3p1FastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_veo_3p1_fast(mut builder: GenerateVideoRequestBuilder) -> Result { + // Same duration constraints as Veo 3.1 (4/6/8). See veo_3p1::build for rationale. + let strategy = builder.request_mismatch_mitigation_strategy; + let final_duration = plan_veo_3p1_duration(builder.duration_seconds, strategy)?; + builder.duration_seconds = final_duration; + + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Veo3p1Fast, + SupportedResolutions::FullWith4k, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + + let state = ArtcraftVeo3p1FastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftVeo3p1Fast(state))) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..8414b55f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/cost.rs @@ -0,0 +1,114 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::veo_3p1_fast::request::ArtcraftVeo3p1FastRequestState; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3p1FastCostState { + pub duration_seconds: u64, + pub generate_audio: bool, + pub is_4k: bool, +} + +impl ArtcraftVeo3p1FastCostState { + pub fn from_request(request: &ArtcraftVeo3p1FastRequestState) -> Self { + Self { + // v1 legacy Veo 3.1 Fast multi-function handler defaults None → 6s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(6), + // v1 legacy Veo 3.1 Fast handler defaults generate_audio to true. + generate_audio: request.request.generate_audio.unwrap_or(true), + is_4k: request.request.resolution == Some(CommonResolutionEnum::FourK), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Per-second rates in hundredths of a US cent; 4K renders bill a premium. + let rate_hundredth_cents: u64 = match (self.is_4k, self.generate_audio) { + (false, false) => 1_100, + (false, true) => 1_650, + (true, false) => 3_300, + (true, true) => 3_850, + }; + // Round up to the next whole cent. + let cost_in_usd_cents = (rate_hundredth_cents * self.duration_seconds).div_ceil(100); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + cost_cents_at(duration_seconds, generate_audio, None) + } + + fn cost_cents_at( + duration_seconds: Option, + generate_audio: Option, + resolution: Option, + ) -> u64 { + let b = GenerateVideoRequestBuilder { + resolution, + model: RouterVideoModel::Veo3p1Fast, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_on_4s_is_66() { assert_eq!(cost_cents(Some(4), Some(true)), 66); } + + #[test] + fn audio_on_6s_is_99() { assert_eq!(cost_cents(Some(6), Some(true)), 99); } + + #[test] + fn audio_on_8s_is_132() { assert_eq!(cost_cents(Some(8), Some(true)), 132); } + + #[test] + fn audio_off_4s_is_44() { assert_eq!(cost_cents(Some(4), Some(false)), 44); } + + #[test] + fn default_duration_is_6s() { + assert_eq!(cost_cents(None, Some(true)), 99); + } + + #[test] + fn audio_default_is_on() { + assert_eq!(cost_cents(Some(6), None), 99); + } + + #[test] + fn four_k_audio_off_4s_is_132() { + assert_eq!(cost_cents_at(Some(4), Some(false), Some(RouterResolution::FourK)), 132); + } + + #[test] + fn four_k_audio_on_4s_is_154() { + assert_eq!(cost_cents_at(Some(4), Some(true), Some(RouterResolution::FourK)), 154); + } + + #[test] + fn non_four_k_resolutions_share_the_base_rate() { + assert_eq!( + cost_cents_at(Some(8), Some(true), Some(RouterResolution::SevenTwentyP)), + cost_cents_at(Some(8), Some(true), Some(RouterResolution::TenEightyP)), + ); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/request.rs new file mode 100644 index 00000000..4a134e93 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_fast/request.rs @@ -0,0 +1,17 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3p1FastRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftVeo3p1FastRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/build.rs new file mode 100644 index 00000000..f6d3e985 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/build.rs @@ -0,0 +1,29 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::request::ArtcraftVeo3p1LiteRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_veo_3p1_lite(builder: GenerateVideoRequestBuilder) -> Result { + let state = build_artcraft_veo_3p1_lite_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftVeo3p1Lite(state))) +} + +pub(crate) fn build_artcraft_veo_3p1_lite_state(builder: GenerateVideoRequestBuilder) -> Result { + // Veo 3.1 Lite supports `generate_audio` — preserve it so cost can read it back. + // build_artcraft_omni_video_request hardcodes generate_audio = None on its output. + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::Veo3p1Lite, + SupportedResolutions::NoFourEightyP, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + Ok(ArtcraftVeo3p1LiteRequestState { request }) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/cost.rs new file mode 100644 index 00000000..fd177d55 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/cost.rs @@ -0,0 +1,119 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::request::ArtcraftVeo3p1LiteRequestState; + +/// Per-second rates in hundredths of a US cent. +const SEVEN_TWENTY_P_AUDIO_OFF_RATE: u64 = 315; +const SEVEN_TWENTY_P_AUDIO_ON_RATE: u64 = 525; +const TEN_EIGHTY_P_AUDIO_OFF_RATE: u64 = 525; +const TEN_EIGHTY_P_AUDIO_ON_RATE: u64 = 840; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3p1LiteCostState { + pub duration_seconds: u64, + pub is_1080p: bool, + pub generate_audio: bool, +} + +impl ArtcraftVeo3p1LiteCostState { + pub fn from_request(request: &ArtcraftVeo3p1LiteRequestState) -> Self { + Self { + // Veo 3.1 Lite defaults None → 8s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(8), + is_1080p: is_1080p(request.request.resolution), + // Audio is on when unspecified. + generate_audio: request.request.generate_audio.unwrap_or(true), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let rate = match (self.is_1080p, self.generate_audio) { + (false, false) => SEVEN_TWENTY_P_AUDIO_OFF_RATE, + (false, true) => SEVEN_TWENTY_P_AUDIO_ON_RATE, + (true, false) => TEN_EIGHTY_P_AUDIO_OFF_RATE, + (true, true) => TEN_EIGHTY_P_AUDIO_ON_RATE, + }; + // Round up to the next whole cent. + let cost_in_usd_cents = (rate * self.duration_seconds).div_ceil(100); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Veo 3.1 Lite renders 720p (the default) or 1080p. +fn is_1080p(resolution: Option) -> bool { + matches!( + resolution, + Some(CommonResolutionEnum::TenEightyP) + | Some(CommonResolutionEnum::TwoK) + | Some(CommonResolutionEnum::ThreeK) + | Some(CommonResolutionEnum::FourK) + ) +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::build::build_artcraft_veo_3p1_lite_state; + use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::cost::ArtcraftVeo3p1LiteCostState; + + fn cost_cents( + duration_seconds: Option, + resolution: Option, + generate_audio: Option, + ) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Lite, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + generate_audio, + ..Default::default() + }; + let state = build_artcraft_veo_3p1_lite_state(b).unwrap(); + ArtcraftVeo3p1LiteCostState::from_request(&state).estimate_cost().cost_in_usd_cents.unwrap() + } + + #[test] + fn defaults_8s_720p_audio_on_is_42() { assert_eq!(cost_cents(None, None, None), 42); } + + #[test] + fn audio_off_8s_720p_is_26() { + // 315 * 8 = 2520 hundredth-cents → 26 cents. + assert_eq!(cost_cents(Some(8), None, Some(false)), 26); + } + + #[test] + fn audio_on_8s_1080p_is_68() { + // 840 * 8 = 6720 hundredth-cents → 68 cents. + assert_eq!(cost_cents(Some(8), Some(RouterResolution::TenEightyP), Some(true)), 68); + } + + #[test] + fn audio_off_8s_1080p_is_42() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::TenEightyP), Some(false)), 42); + } + + #[test] + fn audio_on_4s_720p_is_21() { + assert_eq!(cost_cents(Some(4), None, Some(true)), 21); + } + + #[test] + fn audio_default_is_on() { + assert_eq!(cost_cents(Some(8), None, None), cost_cents(Some(8), None, Some(true))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/request.rs new file mode 100644 index 00000000..3677c6cf --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/veo_3p1_lite/request.rs @@ -0,0 +1,104 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftVeo3p1LiteRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftVeo3p1LiteRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use test_data::web::image_media_tokens::JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN; + + use crate::api::image_ref::ImageRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A lighthouse beam sweeping across a foggy bay at night.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn keyframe_start_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog turns its head toward the camera.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn artcraft_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Lite, + provider: RouterProvider::Artcraft, + duration_seconds: Some(8), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/build.rs new file mode 100644 index 00000000..9fbe8f03 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/build.rs @@ -0,0 +1,29 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::vidu_q3::request::ArtcraftViduQ3RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_vidu_q3(builder: GenerateVideoRequestBuilder) -> Result { + let state = build_artcraft_vidu_q3_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftViduQ3(state))) +} + +pub(crate) fn build_artcraft_vidu_q3_state(builder: GenerateVideoRequestBuilder) -> Result { + // Vidu Q3 supports `audio` — preserve it so cost can read it back. + // build_artcraft_omni_video_request hardcodes generate_audio = None on its output. + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::ViduQ3, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + Ok(ArtcraftViduQ3RequestState { request }) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/cost.rs new file mode 100644 index 00000000..af43df26 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/cost.rs @@ -0,0 +1,118 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::vidu_q3::request::ArtcraftViduQ3RequestState; + +/// Per-second rates in hundredths of a US cent. +const LOW_RES_RATE_HUNDREDTH_CENTS_PER_SEC: u64 = 735; +const HIGH_RES_RATE_HUNDREDTH_CENTS_PER_SEC: u64 = 1_634; + +#[derive(Clone, Debug)] +pub struct ArtcraftViduQ3CostState { + pub duration_seconds: u64, + pub is_high_res: bool, +} + +impl ArtcraftViduQ3CostState { + pub fn from_request(request: &ArtcraftViduQ3RequestState) -> Self { + Self { + // Vidu Q3 defaults None → 5s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(5), + is_high_res: is_high_res(request.request.resolution), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let rate = if self.is_high_res { + HIGH_RES_RATE_HUNDREDTH_CENTS_PER_SEC + } else { + LOW_RES_RATE_HUNDREDTH_CENTS_PER_SEC + }; + // Round up to the next whole cent. + let cost_in_usd_cents = (rate * self.duration_seconds).div_ceil(100); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Vidu prices 720p/1080p at a higher tier than 360p/540p. The default (unset) +/// resolution is 720p. +fn is_high_res(resolution: Option) -> bool { + match resolution { + None => true, // defaults to 720p + Some(CommonResolutionEnum::SevenTwentyP) + | Some(CommonResolutionEnum::TenEightyP) + | Some(CommonResolutionEnum::OneK) + | Some(CommonResolutionEnum::TwoK) + | Some(CommonResolutionEnum::ThreeK) + | Some(CommonResolutionEnum::FourK) => true, + Some(CommonResolutionEnum::HalfK) + | Some(CommonResolutionEnum::FourEightyP) => false, + } +} + +#[cfg(test)] +mod tests { + use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::artcraft::vidu_q3::build::build_artcraft_vidu_q3_state; + use crate::generate::generate_video::providers::artcraft::vidu_q3::cost::ArtcraftViduQ3CostState; + + fn cost_cents(duration_seconds: Option, resolution: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + }; + let state = build_artcraft_vidu_q3_state(b).unwrap(); + ArtcraftViduQ3CostState::from_request(&state).estimate_cost().cost_in_usd_cents.unwrap() + } + + #[test] + fn default_resolution_5s_is_82() { assert_eq!(cost_cents(Some(5), None), 82); } + + #[test] + fn default_duration_is_5s() { assert_eq!(cost_cents(None, None), 82); } + + #[test] + fn high_res_10s_is_164() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::TenEightyP)), 164); } + + #[test] + fn low_res_5s_is_37() { assert_eq!(cost_cents(Some(5), Some(RouterResolution::FourEightyP)), 37); } + + #[test] + fn low_res_10s_is_74() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::FourEightyP)), 74); } + + #[test] + fn seven_twenty_p_is_high_res_tier() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::SevenTwentyP)), 131); + } + + #[test] + fn odd_duration_rounds_up_to_whole_cents() { + // 7s high res: 1634 * 7 = 11438 hundredth-cents → 115 cents. + assert_eq!(cost_cents(Some(7), None), 115); + } + + #[test] + fn resolution_classifier_defaults_high() { + assert!(super::is_high_res(None)); + assert!(super::is_high_res(Some(CommonResolutionEnum::TenEightyP))); + assert!(!super::is_high_res(Some(CommonResolutionEnum::FourEightyP))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/request.rs new file mode 100644 index 00000000..f561006d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3/request.rs @@ -0,0 +1,117 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftViduQ3RequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftViduQ3RequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use test_data::web::image_media_tokens::JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN; + + use crate::api::image_ref::ImageRef; + use crate::api::image_list_ref::ImageListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A red kite soaring over coastal cliffs, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn keyframe_start_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog stands up and walks toward the lake.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn reference_images_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog explores a mossy forest clearing.".to_string()), + reference_images: Some(ImageListRef::MediaFileTokens(vec![MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string())])), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn artcraft_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/build.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/build.rs new file mode 100644 index 00000000..659bc128 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/build.rs @@ -0,0 +1,29 @@ +use artcraft_client::enums::common::generation::common_video_model::CommonVideoModel as CommonVideoModelEnum; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::artcraft::build_common::{ + build_artcraft_omni_video_request, SupportedResolutions, UltraWideSupport, +}; +use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::request::ArtcraftViduQ3TurboRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_artcraft_vidu_q3_turbo(builder: GenerateVideoRequestBuilder) -> Result { + let state = build_artcraft_vidu_q3_turbo_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::ArtcraftViduQ3Turbo(state))) +} + +pub(crate) fn build_artcraft_vidu_q3_turbo_state(builder: GenerateVideoRequestBuilder) -> Result { + // Vidu Q3 Turbo supports `audio` — preserve it so cost can read it back. + // build_artcraft_omni_video_request hardcodes generate_audio = None on its output. + let generate_audio = builder.generate_audio; + let mut request = build_artcraft_omni_video_request( + builder, + CommonVideoModelEnum::ViduQ3Turbo, + SupportedResolutions::Full, + UltraWideSupport::Unsupported, + )?; + request.generate_audio = generate_audio; + Ok(ArtcraftViduQ3TurboRequestState { request }) +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/cost.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/cost.rs new file mode 100644 index 00000000..c2fe4366 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/cost.rs @@ -0,0 +1,104 @@ +use artcraft_client::enums::common::generation::common_resolution::CommonResolution as CommonResolutionEnum; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::request::ArtcraftViduQ3TurboRequestState; + +/// Per-second rates in hundredths of a US cent. +const LOW_RES_RATE_HUNDREDTH_CENTS_PER_SEC: u64 = 401; +const HIGH_RES_RATE_HUNDREDTH_CENTS_PER_SEC: u64 = 834; + +#[derive(Clone, Debug)] +pub struct ArtcraftViduQ3TurboCostState { + pub duration_seconds: u64, + pub is_high_res: bool, +} + +impl ArtcraftViduQ3TurboCostState { + pub fn from_request(request: &ArtcraftViduQ3TurboRequestState) -> Self { + Self { + // Vidu Q3 Turbo defaults None → 5s. + duration_seconds: request.request.duration_seconds.map(u64::from).unwrap_or(5), + is_high_res: is_high_res(request.request.resolution), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let rate = if self.is_high_res { + HIGH_RES_RATE_HUNDREDTH_CENTS_PER_SEC + } else { + LOW_RES_RATE_HUNDREDTH_CENTS_PER_SEC + }; + // Round up to the next whole cent. + let cost_in_usd_cents = (rate * self.duration_seconds).div_ceil(100); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Vidu prices 720p/1080p at a higher tier than 360p/540p. The default (unset) +/// resolution is 720p. +fn is_high_res(resolution: Option) -> bool { + match resolution { + None => true, // defaults to 720p + Some(CommonResolutionEnum::SevenTwentyP) + | Some(CommonResolutionEnum::TenEightyP) + | Some(CommonResolutionEnum::OneK) + | Some(CommonResolutionEnum::TwoK) + | Some(CommonResolutionEnum::ThreeK) + | Some(CommonResolutionEnum::FourK) => true, + Some(CommonResolutionEnum::HalfK) + | Some(CommonResolutionEnum::FourEightyP) => false, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::build::build_artcraft_vidu_q3_turbo_state; + use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::cost::ArtcraftViduQ3TurboCostState; + + fn cost_cents(duration_seconds: Option, resolution: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3Turbo, + provider: RouterProvider::Artcraft, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + }; + let state = build_artcraft_vidu_q3_turbo_state(b).unwrap(); + ArtcraftViduQ3TurboCostState::from_request(&state).estimate_cost().cost_in_usd_cents.unwrap() + } + + #[test] + fn default_resolution_5s_is_42() { assert_eq!(cost_cents(Some(5), None), 42); } + + #[test] + fn default_duration_is_5s() { assert_eq!(cost_cents(None, None), 42); } + + #[test] + fn high_res_10s_is_84() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::TenEightyP)), 84); } + + #[test] + fn low_res_5s_is_21() { assert_eq!(cost_cents(Some(5), Some(RouterResolution::FourEightyP)), 21); } + + #[test] + fn low_res_10s_is_41() { assert_eq!(cost_cents(Some(10), Some(RouterResolution::FourEightyP)), 41); } + + #[test] + fn odd_duration_rounds_up_to_whole_cents() { + // 7s high res: 834 * 7 = 5838 hundredth-cents → 59 cents. + assert_eq!(cost_cents(Some(7), None), 59); + } +} diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/mod.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/request.rs b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/request.rs new file mode 100644 index 00000000..8bd300a8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/artcraft/vidu_q3_turbo/request.rs @@ -0,0 +1,104 @@ +use artcraft_client::api_defs::omni_gen::cost_and_generate_requests::omni_gen_video_cost_and_generate_request::OmniGenVideoCostAndGenerateRequest; + +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::providers::artcraft::request_common::send_artcraft_omni_video_request; + +#[derive(Clone, Debug)] +pub struct ArtcraftViduQ3TurboRequestState { + pub request: OmniGenVideoCostAndGenerateRequest, +} + +impl ArtcraftViduQ3TurboRequestState { + pub async fn send(&self, client: &RouterArtcraftClient) -> Result { + send_artcraft_omni_video_request(&self.request, client).await + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; + use artcraft_client::utils::api_host::ApiHost; + use test_data::web::image_media_tokens::JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN; + + use crate::api::image_ref::ImageRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::router_artcraft_client::RouterArtcraftClient; + use crate::client::router_client::RouterClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A paper boat drifting down a rainy gutter stream.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] // sends a real generation to the Artcraft backend, incurs cost + async fn keyframe_start_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog shakes off water in slow motion.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new(JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN.to_string()))), + ..artcraft_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Artcraft(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + // ── Helpers ── + + fn artcraft_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3Turbo, + provider: RouterProvider::Artcraft, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_artcraft_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read artcraft cookies"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(ApiHost::Storyteller, credentials)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_artcraft_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Artcraft skips draft)"), + }; + + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Artcraft(p) => { + println!("inference_job_token={:?}", p.inference_job_token); + println!("all_inference_job_tokens={:?}", p.all_inference_job_tokens); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/build.rs new file mode 100644 index 00000000..70d3bb8d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/build.rs @@ -0,0 +1,453 @@ +use fal_client::requests::api::video::elements::kling_1p6_pro_elements_to_video::api::{ + Kling1p6ProElementsToVideoAspectRatio, Kling1p6ProElementsToVideoDuration, + Kling1p6ProElementsToVideoRequest, +}; +use fal_client::requests::api::video::image::kling_1p6_pro_image_to_video::api::{ + Kling1p6ProImageToVideoAspectRatio, Kling1p6ProImageToVideoDuration, + Kling1p6ProImageToVideoRequest, +}; +use fal_client::requests::api::video::text::kling_1p6_pro_text_to_video::api::{ + Kling1p6ProTextToVideoAspectRatio, Kling1p6ProTextToVideoDuration, + Kling1p6ProTextToVideoRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::request::{ + FalKling16ProMode, FalKling16ProRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Five, + Ten, +} + +pub fn build_fal_kling_1_6_pro( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + + let reference_image_urls = resolve_reference_image_urls(builder.reference_images.clone())?; + let start_image_url = optional_url(builder.start_frame.clone())?; + let end_image_url = optional_url(builder.end_frame.clone())?; + + // Dispatch: reference_images → elements; start_frame → image; else → text. + // Elements-to-video has no concept of start/end frame, so passing both with + // reference_images is rejected unless the strategy is lenient. + let mode = if !reference_image_urls.is_empty() { + if (start_image_url.is_some() || end_image_url.is_some()) + && matches!(strategy, RequestMismatchMitigationStrategy::ErrorOut) + { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: "Kling 1.6 Pro elements-to-video cannot also accept start_frame or end_frame".to_string(), + })); + } + FalKling16ProMode::ElementsToVideo(Kling1p6ProElementsToVideoRequest { + prompt, + input_image_urls: reference_image_urls, + negative_prompt, + duration: duration.map(to_elements_duration), + aspect_ratio: aspect_ratio.map(to_elements_aspect_ratio), + }) + } else if let Some(image_url) = start_image_url { + FalKling16ProMode::ImageToVideo(Kling1p6ProImageToVideoRequest { + prompt, + image_url, + end_image_url, + negative_prompt, + duration: duration.map(to_i2v_duration), + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + cfg_scale: None, + }) + } else { + if end_image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Kling 1.6 Pro requires a start_frame when end_frame is provided".to_string(), + })); + } + FalKling16ProMode::TextToVideo(Kling1p6ProTextToVideoRequest { + prompt, + negative_prompt, + duration: duration.map(to_t2v_duration), + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + cfg_scale: None, + }) + }; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro( + FalKling16ProRequestState { mode }, + ))) +} + +// ── Shared URL helpers ── +// +// `optional_url` is also imported by other Kling router modules (e.g. +// kling_3p0_pro) to avoid copy/paste. Preserve the signature. + +pub(crate) fn require_url( + image_ref: Option, + field: &'static str, + reason: &str, +) -> Result { + match image_ref { + Some(ImageRef::Url(url)) => Ok(url), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + None => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: reason.to_string(), + })), + } +} + +pub(crate) fn optional_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + } +} + +fn resolve_reference_image_urls( + reference_images: Option, +) -> Result, ArtcraftRouterError> { + match reference_images { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +// ── Plan helpers ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::SixteenByNine)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) => Ok(Some(PlanDuration::Five)), + Some(10) => Ok(Some(PlanDuration::Ten)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanDuration::Ten)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanDuration::Five)), + }, + } +} + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Kling1p6ProTextToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling1p6ProTextToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling1p6ProTextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling1p6ProTextToVideoAspectRatio::NineBySixteen, + } +} + +fn to_t2v_duration(d: PlanDuration) -> Kling1p6ProTextToVideoDuration { + match d { + PlanDuration::Five => Kling1p6ProTextToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling1p6ProTextToVideoDuration::TenSeconds, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> Kling1p6ProImageToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling1p6ProImageToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling1p6ProImageToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling1p6ProImageToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Kling1p6ProImageToVideoDuration { + match d { + PlanDuration::Five => Kling1p6ProImageToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling1p6ProImageToVideoDuration::TenSeconds, + } +} + +fn to_elements_aspect_ratio(a: PlanAspectRatio) -> Kling1p6ProElementsToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling1p6ProElementsToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling1p6ProElementsToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling1p6ProElementsToVideoAspectRatio::NineBySixteen, + } +} + +fn to_elements_duration(d: PlanDuration) -> Kling1p6ProElementsToVideoDuration { + match d { + PlanDuration::Five => Kling1p6ProElementsToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling1p6ProElementsToVideoDuration::TenSeconds, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling16Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + // ── Mode dispatch ── + + mod mode_dispatch { + use super::*; + + #[test] + fn no_frames_picks_t2v() { + let result = build_fal_kling_1_6_pro(base_builder()).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + assert!(matches!(s.mode, FalKling16ProMode::TextToVideo(_))); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + assert!(matches!(s.mode, FalKling16ProMode::ImageToVideo(_))); + } + + #[test] + fn reference_images_picks_elements() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/r.png".to_string()])); + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + assert!(matches!(s.mode, FalKling16ProMode::ElementsToVideo(_))); + } + + #[test] + fn elements_with_start_frame_errors_in_strict_mode() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/r.png".to_string()])); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_kling_1_6_pro(b).is_err()); + } + + #[test] + fn elements_with_start_frame_drops_frame_in_lenient_mode() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/r.png".to_string()])); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + assert!(matches!(s.mode, FalKling16ProMode::ElementsToVideo(_))); + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_kling_1_6_pro(b).is_err()); + } + } + + // ── Field passthrough ── + + mod field_passthrough { + use super::*; + + #[test] + fn t2v_prompt_and_aspect_propagate() { + let mut b = base_builder(); + b.prompt = Some("custom prompt".to_string()); + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + b.duration_seconds = Some(10); + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + let FalKling16ProMode::TextToVideo(req) = s.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.prompt, "custom prompt"); + assert!(matches!(req.aspect_ratio, Some(Kling1p6ProTextToVideoAspectRatio::NineBySixteen))); + assert!(matches!(req.duration, Some(Kling1p6ProTextToVideoDuration::TenSeconds))); + } + + #[test] + fn i2v_start_and_end_frames_propagate() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + let FalKling16ProMode::ImageToVideo(req) = s.mode else { + panic!("expected ImageToVideo"); + }; + assert_eq!(req.image_url, "https://example.com/start.png"); + assert_eq!(req.end_image_url.as_deref(), Some("https://example.com/end.png")); + } + + #[test] + fn elements_input_image_urls_propagate() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + ])); + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + let FalKling16ProMode::ElementsToVideo(req) = s.mode else { + panic!("expected ElementsToVideo"); + }; + assert_eq!(req.input_image_urls.len(), 2); + } + } + + // ── Validation ── + + mod validation { + use super::*; + + #[test] + fn media_file_token_rejected_for_start_frame() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::MediaFileToken( + sqlite_identifiers::ids::media_file_token::MediaFileToken::new_from_str("mf_xxx"), + )); + assert!(matches!( + build_fal_kling_1_6_pro(b), + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + )); + } + + #[test] + fn duration_out_of_range_errors_in_strict_mode() { + let mut b = base_builder(); + b.duration_seconds = Some(7); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_kling_1_6_pro(b).is_err()); + } + + #[test] + fn duration_out_of_range_upgrades() { + let mut b = base_builder(); + b.duration_seconds = Some(7); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + let result = build_fal_kling_1_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling16Pro(s)) = result else { + panic!("expected FalKling16Pro"); + }; + let FalKling16ProMode::TextToVideo(req) = s.mode else { + panic!("expected TextToVideo"); + }; + assert!(matches!(req.duration, Some(Kling1p6ProTextToVideoDuration::TenSeconds))); + } + + #[test] + fn full_combinatorial_pass() { + let aspect_ratios = [None, Some(RouterAspectRatio::Square), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen), Some(RouterAspectRatio::Auto)]; + let durations = [None, Some(5u16), Some(10)]; + let mut combos = 0; + for &aspect_ratio in &aspect_ratios { + for &duration in &durations { + for include_end in [false, true] { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.aspect_ratio = aspect_ratio; + b.duration_seconds = duration; + if include_end { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + } + assert!(build_fal_kling_1_6_pro(b).is_ok()); + combos += 1; + } + } + } + assert_eq!(combos, 5 * 3 * 2); + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/cost.rs new file mode 100644 index 00000000..8ab1f406 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/cost.rs @@ -0,0 +1,132 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::request::{ + FalKling16ProMode, FalKling16ProRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalKling16ProCostState { + pub cost_in_usd_cents: u64, +} + +impl FalKling16ProCostState { + pub fn from_request(request: &FalKling16ProRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint `FalRequestCostCalculator` + // implementations. The router state mirrors whichever calculator matches + // the dispatched mode so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalKling16ProMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalKling16ProMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + FalKling16ProMode::ElementsToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents_with(mut configure: impl FnMut(&mut GenerateVideoRequestBuilder)) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling16Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + }; + configure(&mut b); + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // ── Image-to-video ($0.095/sec) ── + + #[test] + fn i2v_5s_is_48() { + // ceil(95 × 5 / 10) = 48¢ + let cost = cost_cents_with(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.duration_seconds = Some(5); + }); + assert_eq!(cost, 48); + } + + #[test] + fn i2v_10s_is_95() { + // ceil(95 × 10 / 10) = 95¢ + let cost = cost_cents_with(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.duration_seconds = Some(10); + }); + assert_eq!(cost, 95); + } + + #[test] + fn i2v_default_duration_is_5s_priced_at_48() { + let cost = cost_cents_with(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + }); + assert_eq!(cost, 48); + } + + // ── Text-to-video ($0.098/sec) ── + + #[test] + fn t2v_5s_is_49() { + // ceil(98 × 5 / 10) = 49¢ + let cost = cost_cents_with(|b| { + b.duration_seconds = Some(5); + }); + assert_eq!(cost, 49); + } + + #[test] + fn t2v_10s_is_98() { + let cost = cost_cents_with(|b| { + b.duration_seconds = Some(10); + }); + assert_eq!(cost, 98); + } + + #[test] + fn t2v_default_duration_is_5s_priced_at_49() { + let cost = cost_cents_with(|_b| {}); + assert_eq!(cost, 49); + } + + // ── Elements-to-video ($0.098/sec, same as t2v) ── + + #[test] + fn elements_5s_is_49() { + let cost = cost_cents_with(|b| { + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/r.png".to_string()])); + b.duration_seconds = Some(5); + }); + assert_eq!(cost, 49); + } + + #[test] + fn elements_10s_is_98() { + let cost = cost_cents_with(|b| { + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/r.png".to_string()])); + b.duration_seconds = Some(10); + }); + assert_eq!(cost, 98); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/request.rs new file mode 100644 index 00000000..2e72ea1c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_1_6_pro/request.rs @@ -0,0 +1,164 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::elements::kling_1p6_pro_elements_to_video::api::Kling1p6ProElementsToVideoRequest; +use fal_client::requests::api::video::image::kling_1p6_pro_image_to_video::api::Kling1p6ProImageToVideoRequest; +use fal_client::requests::api::video::text::kling_1p6_pro_text_to_video::api::Kling1p6ProTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalKling16ProMode { + TextToVideo(Kling1p6ProTextToVideoRequest), + ImageToVideo(Kling1p6ProImageToVideoRequest), + ElementsToVideo(Kling1p6ProElementsToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalKling16ProRequestState { + pub mode: FalKling16ProMode, +} + +impl FalKling16ProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalKling16ProMode::TextToVideo(request) => send_request(request, client).await, + FalKling16ProMode::ImageToVideo(request) => send_request(request, client).await, + FalKling16ProMode::ElementsToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::elements::kling_1p6_pro_elements_to_video::api::{ + Kling1p6ProElementsToVideoAspectRatio, Kling1p6ProElementsToVideoDuration, + }; + use fal_client::requests::api::video::image::kling_1p6_pro_image_to_video::api::{ + Kling1p6ProImageToVideoAspectRatio, Kling1p6ProImageToVideoDuration, + }; + use fal_client::requests::api::video::text::kling_1p6_pro_text_to_video::api::{ + Kling1p6ProTextToVideoAspectRatio, Kling1p6ProTextToVideoDuration, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_video_webhook() { + let state = FalKling16ProRequestState { + mode: FalKling16ProMode::TextToVideo(Kling1p6ProTextToVideoRequest { + prompt: "a calm lake at sunrise".to_string(), + negative_prompt: None, + duration: Some(Kling1p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_image_to_video_webhook() { + let state = FalKling16ProRequestState { + mode: FalKling16ProMode::ImageToVideo(Kling1p6ProImageToVideoRequest { + prompt: "the lake comes alive with gentle ripples".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + negative_prompt: None, + duration: Some(Kling1p6ProImageToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProImageToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_elements_to_video_webhook() { + let state = FalKling16ProRequestState { + mode: FalKling16ProMode::ElementsToVideo(Kling1p6ProElementsToVideoRequest { + prompt: "the elements come to life and dance".to_string(), + input_image_urls: vec![JUNO_AT_LAKE_IMAGE_URL.to_string()], + negative_prompt: None, + duration: Some(Kling1p6ProElementsToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling1p6ProElementsToVideoAspectRatio::SixteenByNine), + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/build.rs new file mode 100644 index 00000000..89621e2b --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/build.rs @@ -0,0 +1,123 @@ +use fal_client::requests_old::webhook::video::image::enqueue_kling_v2p1_master_image_to_video_webhook::{ + Kling2p1MasterAspectRatio, Kling2p1MasterDuration, Kling2p1MasterRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::require_url; +use crate::generate::generate_video::providers::fal::kling_2_1_master::request::FalKling21MasterRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_fal_kling_2_1_master( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let image_url = require_url(builder.start_frame.clone(), "start_frame", "Kling 2.1 Master requires a starting frame")?; + if builder.end_frame.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Kling 2.1 Master does not support an ending frame".to_string(), + })); + } + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + + let request = Kling2p1MasterRequest { + image_url, + prompt: builder.prompt.clone().unwrap_or_default(), + duration, + aspect_ratio, + }; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling21Master( + FalKling21MasterRequestState { request }, + ))) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use Kling2p1MasterAspectRatio as Ar; + match aspect_ratio { + None => Ok(Ar::WideSixteenNine), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::WideSixteenNine), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::TallNineSixteen), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::WideSixteenNine), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Ar::WideSixteenNine), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match duration_seconds { + None => Ok(Kling2p1MasterDuration::Default), + Some(5) => Ok(Kling2p1MasterDuration::FiveSeconds), + Some(10) => Ok(Kling2p1MasterDuration::TenSeconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Kling2p1MasterDuration::TenSeconds), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Kling2p1MasterDuration::FiveSeconds), + }, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling21Master, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/a.png".to_string())), + ..Default::default() + } + } + + #[test] + fn missing_start_frame_errors() { + let mut b = base_builder(); + b.start_frame = None; + assert!(build_fal_kling_2_1_master(b).is_err()); + } + + #[test] + fn end_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_kling_2_1_master(b).is_err()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/cost.rs new file mode 100644 index 00000000..f20f8297 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/cost.rs @@ -0,0 +1,61 @@ +use fal_client::requests_old::webhook::video::image::enqueue_kling_v2p1_master_image_to_video_webhook::Kling2p1MasterDuration; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_2_1_master::request::FalKling21MasterRequestState; + +#[derive(Clone, Debug)] +pub struct FalKling21MasterCostState { + pub is_ten_seconds: bool, +} + +impl FalKling21MasterCostState { + pub fn from_request(request: &FalKling21MasterRequestState) -> Self { + Self { + is_ten_seconds: matches!(request.request.duration, Kling2p1MasterDuration::TenSeconds), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_v2p1_master: 5s = $1.40, 10s = $2.80. + let cost_in_usd_cents: u64 = if self.is_ten_seconds { 280 } else { 140 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling21Master, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/a.png".to_string())), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn five_seconds_is_140() { assert_eq!(cost_cents(Some(5)), 140); } + + #[test] + fn ten_seconds_is_280() { assert_eq!(cost_cents(Some(10)), 280); } + + #[test] + fn default_duration_is_5s_priced_at_140() { assert_eq!(cost_cents(None), 140); } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/request.rs new file mode 100644 index 00000000..98ab2fb5 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_master/request.rs @@ -0,0 +1,45 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_kling_v2p1_master_image_to_video_webhook::{ + enqueue_kling_v2p1_master_image_to_video_webhook, Kling2p1MasterArgs, Kling2p1MasterRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalKling21MasterRequestState { + pub request: Kling2p1MasterRequest, +} + +impl FalKling21MasterRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let outbound_request: Arc = Arc::new(self.request.clone()); + + let args = Kling2p1MasterArgs { + request: self.request.clone(), + webhook_url, + api_key: &client.api_key, + }; + + let webhook_response = enqueue_kling_v2p1_master_image_to_video_webhook(args) + .await + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/build.rs new file mode 100644 index 00000000..4c21b7eb --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/build.rs @@ -0,0 +1,85 @@ +use fal_client::requests_old::webhook::video::image::enqueue_kling_v2p1_pro_image_to_video_webhook::{ + Kling2p1ProAspectRatio, Kling2p1ProDuration, Kling2p1ProRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::{optional_url, require_url}; +use crate::generate::generate_video::providers::fal::kling_2_1_pro::request::FalKling21ProRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_fal_kling_2_1_pro( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let image_url = require_url(builder.start_frame.clone(), "start_frame", "Kling 2.1 Pro requires a starting frame")?; + let end_frame_image_url = optional_url(builder.end_frame.clone())?; + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + + let request = Kling2p1ProRequest { + image_url, + end_frame_image_url, + prompt: builder.prompt.clone().unwrap_or_default(), + duration, + aspect_ratio, + }; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling21Pro( + FalKling21ProRequestState { request }, + ))) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use Kling2p1ProAspectRatio as Ar; + match aspect_ratio { + None => Ok(Ar::WideSixteenNine), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Ar::Square), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Ar::WideSixteenNine), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Ar::TallNineSixteen), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Ar::WideSixteenNine), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Ar::WideSixteenNine), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match duration_seconds { + None => Ok(Kling2p1ProDuration::Default), + Some(5) => Ok(Kling2p1ProDuration::FiveSeconds), + Some(10) => Ok(Kling2p1ProDuration::TenSeconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Kling2p1ProDuration::TenSeconds), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Kling2p1ProDuration::FiveSeconds), + }, + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/cost.rs new file mode 100644 index 00000000..2613c6bb --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/cost.rs @@ -0,0 +1,61 @@ +use fal_client::requests_old::webhook::video::image::enqueue_kling_v2p1_pro_image_to_video_webhook::Kling2p1ProDuration; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_2_1_pro::request::FalKling21ProRequestState; + +#[derive(Clone, Debug)] +pub struct FalKling21ProCostState { + pub is_ten_seconds: bool, +} + +impl FalKling21ProCostState { + pub fn from_request(request: &FalKling21ProRequestState) -> Self { + Self { + is_ten_seconds: matches!(request.request.duration, Kling2p1ProDuration::TenSeconds), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_v2p1_pro: 5s = 45¢, 10s = 90¢. + let cost_in_usd_cents: u64 = if self.is_ten_seconds { 90 } else { 45 }; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling21Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/a.png".to_string())), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn five_seconds_is_45() { assert_eq!(cost_cents(Some(5)), 45); } + + #[test] + fn ten_seconds_is_90() { assert_eq!(cost_cents(Some(10)), 90); } + + #[test] + fn default_duration_is_5s_priced_at_45() { assert_eq!(cost_cents(None), 45); } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/request.rs new file mode 100644 index 00000000..80748ef6 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_1_pro/request.rs @@ -0,0 +1,45 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_kling_v2p1_pro_image_to_video_webhook::{ + enqueue_kling_v2p1_pro_image_to_video_webhook, Kling2p1ProArgs, Kling2p1ProRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalKling21ProRequestState { + pub request: Kling2p1ProRequest, +} + +impl FalKling21ProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let outbound_request: Arc = Arc::new(self.request.clone()); + + let args = Kling2p1ProArgs { + request: self.request.clone(), + webhook_url, + api_key: &client.api_key, + }; + + let webhook_response = enqueue_kling_v2p1_pro_image_to_video_webhook(args) + .await + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/build.rs new file mode 100644 index 00000000..37afc884 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/build.rs @@ -0,0 +1,204 @@ +use fal_client::requests::api::video::image::kling_2p5_turbo_pro_image_to_video::api::{ + Kling2p5TurboProImageToVideoDuration, Kling2p5TurboProImageToVideoRequest, +}; +use fal_client::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::api::{ + Kling2p5TurboProTextToVideoAspectRatio, Kling2p5TurboProTextToVideoDuration, + Kling2p5TurboProTextToVideoRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::kling_2_5_turbo_pro::request::{ + FalKling2p5TurboProMode, FalKling2p5TurboProRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Five, + Ten, +} + +pub fn build_fal_kling_2_5_turbo_pro( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + + let mode = match optional_url(builder.start_frame.clone())? { + None => { + if builder.end_frame.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Kling 2.5 Turbo Pro requires a start_frame when end_frame is provided".to_string(), + })); + } + FalKling2p5TurboProMode::TextToVideo(Kling2p5TurboProTextToVideoRequest { + prompt, + negative_prompt, + duration: duration.map(to_t2v_duration), + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + cfg_scale: None, + }) + } + Some(image_url) => FalKling2p5TurboProMode::ImageToVideo(Kling2p5TurboProImageToVideoRequest { + prompt, + image_url, + tail_image_url: optional_url(builder.end_frame.clone())?, + duration: duration.map(to_i2v_duration), + negative_prompt, + cfg_scale: None, + }), + }; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p5TurboPro( + FalKling2p5TurboProRequestState { mode }, + ))) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::SixteenByNine)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) => Ok(Some(PlanDuration::Five)), + Some(10) => Ok(Some(PlanDuration::Ten)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanDuration::Ten)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanDuration::Five)), + }, + } +} + +fn to_t2v_duration(d: PlanDuration) -> Kling2p5TurboProTextToVideoDuration { + match d { + PlanDuration::Five => Kling2p5TurboProTextToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling2p5TurboProTextToVideoDuration::TenSeconds, + } +} + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Kling2p5TurboProTextToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling2p5TurboProTextToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling2p5TurboProTextToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Kling2p5TurboProImageToVideoDuration { + match d { + PlanDuration::Five => Kling2p5TurboProImageToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling2p5TurboProImageToVideoDuration::TenSeconds, + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling2p5TurboPro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + #[test] + fn no_start_frame_picks_t2v() { + let result = build_fal_kling_2_5_turbo_pro(base_builder()).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p5TurboPro(s)) = result else { + panic!("expected FalKling2p5TurboPro"); + }; + assert!(matches!(s.mode, FalKling2p5TurboProMode::TextToVideo(_))); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let result = build_fal_kling_2_5_turbo_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p5TurboPro(s)) = result else { + panic!("expected FalKling2p5TurboPro"); + }; + assert!(matches!(s.mode, FalKling2p5TurboProMode::ImageToVideo(_))); + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_kling_2_5_turbo_pro(b).is_err()); + } + + #[test] + fn tail_image_url_propagates() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + let result = build_fal_kling_2_5_turbo_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p5TurboPro(s)) = result else { + panic!("expected FalKling2p5TurboPro"); + }; + let FalKling2p5TurboProMode::ImageToVideo(req) = s.mode else { + panic!("expected ImageToVideo"); + }; + assert_eq!(req.tail_image_url.as_deref(), Some("https://example.com/end.png")); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/cost.rs new file mode 100644 index 00000000..dac10be4 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/cost.rs @@ -0,0 +1,74 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_2_5_turbo_pro::request::{ + FalKling2p5TurboProMode, FalKling2p5TurboProRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalKling2p5TurboProCostState { + pub cost_in_usd_cents: u64, +} + +impl FalKling2p5TurboProCostState { + pub fn from_request(request: &FalKling2p5TurboProRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint `FalRequestCostCalculator` + // implementations. + let cost_in_usd_cents = match &request.mode { + FalKling2p5TurboProMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalKling2p5TurboProMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, has_start: bool) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling2p5TurboPro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + if has_start { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // Pricing: $0.07/sec flat → 5s = 35¢, 10s = 70¢. Same for t2v and i2v. + + #[test] + fn t2v_5s_is_35() { assert_eq!(cost_cents(Some(5), false), 35); } + + #[test] + fn t2v_10s_is_70() { assert_eq!(cost_cents(Some(10), false), 70); } + + #[test] + fn i2v_5s_is_35() { assert_eq!(cost_cents(Some(5), true), 35); } + + #[test] + fn i2v_10s_is_70() { assert_eq!(cost_cents(Some(10), true), 70); } + + #[test] + fn default_is_5s_priced_at_35() { assert_eq!(cost_cents(None, false), 35); } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/request.rs new file mode 100644 index 00000000..43e0fe23 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_5_turbo_pro/request.rs @@ -0,0 +1,138 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::kling_2p5_turbo_pro_image_to_video::api::Kling2p5TurboProImageToVideoRequest; +use fal_client::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::api::Kling2p5TurboProTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalKling2p5TurboProMode { + TextToVideo(Kling2p5TurboProTextToVideoRequest), + ImageToVideo(Kling2p5TurboProImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalKling2p5TurboProRequestState { + pub mode: FalKling2p5TurboProMode, +} + +impl FalKling2p5TurboProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalKling2p5TurboProMode::TextToVideo(request) => send_request(request, client).await, + FalKling2p5TurboProMode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::kling_2p5_turbo_pro_image_to_video::api::Kling2p5TurboProImageToVideoDuration; + use fal_client::requests::api::video::text::kling_2p5_turbo_pro_text_to_video::api::{ + Kling2p5TurboProTextToVideoAspectRatio, Kling2p5TurboProTextToVideoDuration, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_video_webhook() { + let state = FalKling2p5TurboProRequestState { + mode: FalKling2p5TurboProMode::TextToVideo(Kling2p5TurboProTextToVideoRequest { + prompt: "a calm lake at sunrise".to_string(), + negative_prompt: None, + duration: Some(Kling2p5TurboProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p5TurboProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_image_to_video_webhook() { + let state = FalKling2p5TurboProRequestState { + mode: FalKling2p5TurboProMode::ImageToVideo(Kling2p5TurboProImageToVideoRequest { + prompt: "the lake comes alive".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + tail_image_url: None, + duration: Some(Kling2p5TurboProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + cfg_scale: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/build.rs new file mode 100644 index 00000000..bd821b17 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/build.rs @@ -0,0 +1,223 @@ +use fal_client::requests::api::video::image::kling_2p6_pro_image_to_video::api::{ + Kling2p6ProImageToVideoDuration, Kling2p6ProImageToVideoRequest, +}; +use fal_client::requests::api::video::text::kling_2p6_pro_text_to_video::api::{ + Kling2p6ProTextToVideoAspectRatio, Kling2p6ProTextToVideoDuration, + Kling2p6ProTextToVideoRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::kling_2_6_pro::request::{ + FalKling2p6ProMode, FalKling2p6ProRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Five, + Ten, +} + +pub fn build_fal_kling_2_6_pro( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let generate_audio = builder.generate_audio; + let end_image_url = optional_url(builder.end_frame.clone())?; + + let mode = match optional_url(builder.start_frame.clone())? { + None => { + if end_image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Kling 2.6 Pro requires a start_frame when end_frame is provided".to_string(), + })); + } + FalKling2p6ProMode::TextToVideo(Kling2p6ProTextToVideoRequest { + prompt, + generate_audio, + negative_prompt, + duration: duration.map(to_t2v_duration), + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + cfg_scale: None, + }) + } + Some(start_image_url) => FalKling2p6ProMode::ImageToVideo(Kling2p6ProImageToVideoRequest { + prompt, + start_image_url, + end_image_url, + duration: duration.map(to_i2v_duration), + negative_prompt, + generate_audio, + voice_ids: None, + }), + }; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p6Pro( + FalKling2p6ProRequestState { mode }, + ))) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::SixteenByNine)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) => Ok(Some(PlanDuration::Five)), + Some(10) => Ok(Some(PlanDuration::Ten)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanDuration::Ten)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanDuration::Five)), + }, + } +} + +fn to_t2v_duration(d: PlanDuration) -> Kling2p6ProTextToVideoDuration { + match d { + PlanDuration::Five => Kling2p6ProTextToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling2p6ProTextToVideoDuration::TenSeconds, + } +} + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Kling2p6ProTextToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling2p6ProTextToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling2p6ProTextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling2p6ProTextToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Kling2p6ProImageToVideoDuration { + match d { + PlanDuration::Five => Kling2p6ProImageToVideoDuration::FiveSeconds, + PlanDuration::Ten => Kling2p6ProImageToVideoDuration::TenSeconds, + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling2p6Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + #[test] + fn no_start_frame_picks_t2v() { + let result = build_fal_kling_2_6_pro(base_builder()).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p6Pro(s)) = result else { + panic!("expected FalKling2p6Pro"); + }; + assert!(matches!(s.mode, FalKling2p6ProMode::TextToVideo(_))); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let result = build_fal_kling_2_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p6Pro(s)) = result else { + panic!("expected FalKling2p6Pro"); + }; + assert!(matches!(s.mode, FalKling2p6ProMode::ImageToVideo(_))); + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_kling_2_6_pro(b).is_err()); + } + + #[test] + fn end_frame_with_start_frame_propagates_through_i2v() { + // Kling 2.6 Pro image-to-video accepts an end frame (`end_image_url`). + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + let result = build_fal_kling_2_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p6Pro(s)) = result else { + panic!("expected FalKling2p6Pro"); + }; + let FalKling2p6ProMode::ImageToVideo(req) = s.mode else { + panic!("expected ImageToVideo"); + }; + assert_eq!(req.end_image_url.as_deref(), Some("https://example.com/end.png")); + } + + #[test] + fn generate_audio_propagates() { + let mut b = base_builder(); + b.generate_audio = Some(false); + let result = build_fal_kling_2_6_pro(b).expect("build"); + let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling2p6Pro(s)) = result else { + panic!("expected FalKling2p6Pro"); + }; + let FalKling2p6ProMode::TextToVideo(req) = s.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.generate_audio, Some(false)); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/cost.rs new file mode 100644 index 00000000..f097812a --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/cost.rs @@ -0,0 +1,92 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_2_6_pro::request::{ + FalKling2p6ProMode, FalKling2p6ProRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalKling2p6ProCostState { + pub cost_in_usd_cents: u64, +} + +impl FalKling2p6ProCostState { + pub fn from_request(request: &FalKling2p6ProRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalKling2p6ProMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalKling2p6ProMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option, has_start: bool) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling2p6Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + if has_start { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + // Pricing: + // audio off: $0.07/sec → 5s=35¢, 10s=70¢ + // audio on: $0.14/sec → 5s=70¢, 10s=140¢ + // Image-to-video adds a third tier ($0.168/sec) for voice control, but + // the router build doesn't expose voice_ids yet, so it's not tested here. + + #[test] + fn t2v_audio_off_5s_is_35() { assert_eq!(cost_cents(Some(5), Some(false), false), 35); } + + #[test] + fn t2v_audio_off_10s_is_70() { assert_eq!(cost_cents(Some(10), Some(false), false), 70); } + + #[test] + fn t2v_audio_on_5s_is_70() { assert_eq!(cost_cents(Some(5), Some(true), false), 70); } + + #[test] + fn t2v_audio_on_10s_is_140() { assert_eq!(cost_cents(Some(10), Some(true), false), 140); } + + #[test] + fn i2v_audio_off_5s_is_35() { assert_eq!(cost_cents(Some(5), Some(false), true), 35); } + + #[test] + fn i2v_audio_on_5s_is_70() { assert_eq!(cost_cents(Some(5), Some(true), true), 70); } + + #[test] + fn audio_default_is_on() { + // generate_audio=None defaults to true on fal's server. + assert_eq!( + cost_cents(Some(5), None, false), + cost_cents(Some(5), Some(true), false), + ); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/request.rs new file mode 100644 index 00000000..6a24cec3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_2_6_pro/request.rs @@ -0,0 +1,140 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::kling_2p6_pro_image_to_video::api::Kling2p6ProImageToVideoRequest; +use fal_client::requests::api::video::text::kling_2p6_pro_text_to_video::api::Kling2p6ProTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalKling2p6ProMode { + TextToVideo(Kling2p6ProTextToVideoRequest), + ImageToVideo(Kling2p6ProImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalKling2p6ProRequestState { + pub mode: FalKling2p6ProMode, +} + +impl FalKling2p6ProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalKling2p6ProMode::TextToVideo(request) => send_request(request, client).await, + FalKling2p6ProMode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::kling_2p6_pro_image_to_video::api::Kling2p6ProImageToVideoDuration; + use fal_client::requests::api::video::text::kling_2p6_pro_text_to_video::api::{ + Kling2p6ProTextToVideoAspectRatio, Kling2p6ProTextToVideoDuration, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_video_webhook() { + let state = FalKling2p6ProRequestState { + mode: FalKling2p6ProMode::TextToVideo(Kling2p6ProTextToVideoRequest { + prompt: "a calm lake at sunrise".to_string(), + generate_audio: Some(false), + negative_prompt: None, + duration: Some(Kling2p6ProTextToVideoDuration::FiveSeconds), + aspect_ratio: Some(Kling2p6ProTextToVideoAspectRatio::SixteenByNine), + cfg_scale: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_image_to_video_webhook() { + let state = FalKling2p6ProRequestState { + mode: FalKling2p6ProMode::ImageToVideo(Kling2p6ProImageToVideoRequest { + prompt: "the lake comes alive".to_string(), + start_image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(Kling2p6ProImageToVideoDuration::FiveSeconds), + negative_prompt: None, + generate_audio: Some(false), + voice_ids: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/build.rs new file mode 100644 index 00000000..8d05e686 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/build.rs @@ -0,0 +1,253 @@ +use fal_client::requests_old::webhook::video::image::enqueue_kling_3p0_pro_image_to_video_webhook::{ + EnqueueKling3p0ProImageToVideoAspectRatio, EnqueueKling3p0ProImageToVideoDuration, + EnqueueKling3p0ProImageToVideoRequest, +}; +use fal_client::requests_old::webhook::video::text::enqueue_kling_3p0_pro_text_to_video_webhook::{ + EnqueueKling3p0ProTextToVideoAspectRatio, EnqueueKling3p0ProTextToVideoDuration, + EnqueueKling3p0ProTextToVideoRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::kling_3p0_pro::request::{ + FalKling3p0ProMode, FalKling3p0ProRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Square, + SixteenByNine, + NineBySixteen, +} + +/// 3-15 seconds inclusive — represented as a `u8` because the fal_client side +/// has 13 enum variants (Three..Fifteen). Stored here so the cost calculator +/// can recover the exact second count for billing. +#[derive(Debug, Clone, Copy)] +pub(crate) struct PlanDuration(pub u8); + +const MIN_DURATION: u16 = 3; +const MAX_DURATION: u16 = 15; + +pub fn build_fal_kling_3p0_pro( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_kling_3p0_pro_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling3p0Pro(state))) +} + +fn build_kling_3p0_pro_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let generate_audio = builder.generate_audio; + + let mode = match optional_url(builder.start_frame.clone())? { + None => { + if builder.end_frame.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Kling 3.0 Pro requires a start_frame when end_frame is provided".to_string(), + })); + } + FalKling3p0ProMode::TextToVideo(EnqueueKling3p0ProTextToVideoRequest { + prompt, + generate_audio, + negative_prompt, + duration: duration.map(to_t2v_duration), + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + shot_type: None, + }) + } + Some(image_url) => FalKling3p0ProMode::ImageToVideo(EnqueueKling3p0ProImageToVideoRequest { + prompt, + image_url, + end_image_url: optional_url(builder.end_frame.clone())?, + generate_audio, + negative_prompt, + duration: duration.map(to_i2v_duration), + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + shot_type: None, + }), + }; + + Ok(FalKling3p0ProRequestState { mode }) +} + +pub(crate) fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::SixteenByNine)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +pub(crate) fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(d) if (MIN_DURATION..=MAX_DURATION).contains(&d) => Ok(Some(PlanDuration(d as u8))), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(Some(PlanDuration(d.clamp(MIN_DURATION, MAX_DURATION) as u8))), + }, + } +} + +fn to_t2v_duration(d: PlanDuration) -> EnqueueKling3p0ProTextToVideoDuration { + use EnqueueKling3p0ProTextToVideoDuration as D; + match d.0 { + 3 => D::ThreeSeconds, + 4 => D::FourSeconds, + 5 => D::FiveSeconds, + 6 => D::SixSeconds, + 7 => D::SevenSeconds, + 8 => D::EightSeconds, + 9 => D::NineSeconds, + 10 => D::TenSeconds, + 11 => D::ElevenSeconds, + 12 => D::TwelveSeconds, + 13 => D::ThirteenSeconds, + 14 => D::FourteenSeconds, + _ => D::FifteenSeconds, + } +} + +fn to_i2v_duration(d: PlanDuration) -> EnqueueKling3p0ProImageToVideoDuration { + use EnqueueKling3p0ProImageToVideoDuration as D; + match d.0 { + 3 => D::ThreeSeconds, + 4 => D::FourSeconds, + 5 => D::FiveSeconds, + 6 => D::SixSeconds, + 7 => D::SevenSeconds, + 8 => D::EightSeconds, + 9 => D::NineSeconds, + 10 => D::TenSeconds, + 11 => D::ElevenSeconds, + 12 => D::TwelveSeconds, + 13 => D::ThirteenSeconds, + 14 => D::FourteenSeconds, + _ => D::FifteenSeconds, + } +} + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> EnqueueKling3p0ProTextToVideoAspectRatio { + match a { + PlanAspectRatio::Square => EnqueueKling3p0ProTextToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => EnqueueKling3p0ProTextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => EnqueueKling3p0ProTextToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> EnqueueKling3p0ProImageToVideoAspectRatio { + match a { + PlanAspectRatio::Square => EnqueueKling3p0ProImageToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => EnqueueKling3p0ProImageToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => EnqueueKling3p0ProImageToVideoAspectRatio::NineBySixteen, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + #[test] + fn no_start_frame_picks_t2v() { + let result = build_fal_kling_3p0_pro(base_builder()).expect("build"); + if let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling3p0Pro(s)) = result { + assert!(matches!(s.mode, FalKling3p0ProMode::TextToVideo(_))); + } else { panic!("expected FalKling3p0Pro"); } + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_kling_3p0_pro(b).is_err()); + } + + #[test] + fn duration_3s_accepted() { + let mut b = base_builder(); + b.duration_seconds = Some(3); + assert!(build_fal_kling_3p0_pro(b).is_ok()); + } + + #[test] + fn duration_15s_accepted() { + let mut b = base_builder(); + b.duration_seconds = Some(15); + assert!(build_fal_kling_3p0_pro(b).is_ok()); + } + + #[test] + fn duration_out_of_range_errors_with_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(2); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_kling_3p0_pro(b).is_err()); + } + + #[test] + fn duration_out_of_range_clamps_with_pay_less() { + let mut b = base_builder(); + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert!(build_fal_kling_3p0_pro(b).is_ok()); + } + + use crate::generate::generate_video::providers::fal::kling_3p0_pro::request::FalKling3p0ProMode; +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/cost.rs new file mode 100644 index 00000000..05d5c0a7 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/cost.rs @@ -0,0 +1,136 @@ +use fal_client::requests_old::webhook::video::image::enqueue_kling_3p0_pro_image_to_video_webhook::EnqueueKling3p0ProImageToVideoDuration; +use fal_client::requests_old::webhook::video::text::enqueue_kling_3p0_pro_text_to_video_webhook::EnqueueKling3p0ProTextToVideoDuration; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_3p0_pro::request::{ + FalKling3p0ProMode, FalKling3p0ProRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalKling3p0ProCostState { + pub duration_seconds: u64, + pub generate_audio: bool, +} + +impl FalKling3p0ProCostState { + pub fn from_request(request: &FalKling3p0ProRequestState) -> Self { + let (duration_seconds, generate_audio) = match &request.mode { + FalKling3p0ProMode::TextToVideo(req) => ( + t2v_duration_seconds(req.duration), + req.generate_audio.unwrap_or(true), + ), + FalKling3p0ProMode::ImageToVideo(req) => ( + i2v_duration_seconds(req.duration), + req.generate_audio.unwrap_or(true), + ), + }; + Self { duration_seconds, generate_audio } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors fal_client kling_3p0_pro: + // audio off: $0.224/sec (rate=224 in tenths-of-cents) + // audio on: $0.336/sec (rate=336) + // ceiling-divided to whole cents. + let rate: u64 = if self.generate_audio { 336 } else { 224 }; + let cost_in_usd_cents = (rate * self.duration_seconds + 9) / 10; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Default duration is 5s when None per Fal client. +fn t2v_duration_seconds(d: Option) -> u64 { + use EnqueueKling3p0ProTextToVideoDuration as D; + match d { + None => 5, + Some(D::ThreeSeconds) => 3, + Some(D::FourSeconds) => 4, + Some(D::FiveSeconds) => 5, + Some(D::SixSeconds) => 6, + Some(D::SevenSeconds) => 7, + Some(D::EightSeconds) => 8, + Some(D::NineSeconds) => 9, + Some(D::TenSeconds) => 10, + Some(D::ElevenSeconds) => 11, + Some(D::TwelveSeconds) => 12, + Some(D::ThirteenSeconds) => 13, + Some(D::FourteenSeconds) => 14, + Some(D::FifteenSeconds) => 15, + } +} + +fn i2v_duration_seconds(d: Option) -> u64 { + use EnqueueKling3p0ProImageToVideoDuration as D; + match d { + None => 5, + Some(D::ThreeSeconds) => 3, + Some(D::FourSeconds) => 4, + Some(D::FiveSeconds) => 5, + Some(D::SixSeconds) => 6, + Some(D::SevenSeconds) => 7, + Some(D::EightSeconds) => 8, + Some(D::NineSeconds) => 9, + Some(D::TenSeconds) => 10, + Some(D::ElevenSeconds) => 11, + Some(D::TwelveSeconds) => 12, + Some(D::ThirteenSeconds) => 13, + Some(D::FourteenSeconds) => 14, + Some(D::FifteenSeconds) => 15, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn audio_on_5s_is_168() { + // rate=336, (336*5 + 9) / 10 = 1689/10 = 168. + assert_eq!(cost_cents(Some(5), Some(true)), 168); + } + + #[test] + fn audio_off_5s_is_112() { + // rate=224, (224*5 + 9) / 10 = 1129/10 = 112. + assert_eq!(cost_cents(Some(5), Some(false)), 112); + } + + #[test] + fn audio_on_10s_is_336() { + assert_eq!(cost_cents(Some(10), Some(true)), 336); + } + + #[test] + fn audio_off_15s_is_336() { + // rate=224, (224*15 + 9) / 10 = 3369/10 = 336. + assert_eq!(cost_cents(Some(15), Some(false)), 336); + } + + #[test] + fn default_duration_is_5s() { + assert_eq!(cost_cents(None, Some(true)), cost_cents(Some(5), Some(true))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/request.rs new file mode 100644 index 00000000..2bb80175 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_pro/request.rs @@ -0,0 +1,68 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_kling_3p0_pro_image_to_video_webhook::{ + enqueue_kling_3p0_pro_image_to_video_webhook, EnqueueKling3p0ProImageToVideoArgs, + EnqueueKling3p0ProImageToVideoRequest, +}; +use fal_client::requests_old::webhook::video::text::enqueue_kling_3p0_pro_text_to_video_webhook::{ + enqueue_kling_3p0_pro_text_to_video_webhook, EnqueueKling3p0ProTextToVideoArgs, + EnqueueKling3p0ProTextToVideoRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalKling3p0ProMode { + TextToVideo(EnqueueKling3p0ProTextToVideoRequest), + ImageToVideo(EnqueueKling3p0ProImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalKling3p0ProRequestState { + pub mode: FalKling3p0ProMode, +} + +impl FalKling3p0ProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound_request): (_, Arc) = match &self.mode { + FalKling3p0ProMode::TextToVideo(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueKling3p0ProTextToVideoArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_kling_3p0_pro_text_to_video_webhook(args).await, outbound) + } + FalKling3p0ProMode::ImageToVideo(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueKling3p0ProImageToVideoArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_kling_3p0_pro_image_to_video_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/build.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/build.rs new file mode 100644 index 00000000..fecd3d58 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/build.rs @@ -0,0 +1,164 @@ +use fal_client::requests::api::video::image::kling_3p0_standard_image_to_video::api::{ + Kling3p0StandardImageToVideoAspectRatio, Kling3p0StandardImageToVideoDuration, + Kling3p0StandardImageToVideoRequest, +}; +use fal_client::requests::api::video::text::kling_3p0_standard_text_to_video::api::{ + Kling3p0StandardTextToVideoAspectRatio, Kling3p0StandardTextToVideoDuration, + Kling3p0StandardTextToVideoRequest, +}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::kling_3p0_pro::build::{ + plan_aspect_ratio, plan_duration, PlanAspectRatio, PlanDuration, +}; +use crate::generate::generate_video::providers::fal::kling_3p0_standard::request::{ + FalKling3p0StandardMode, FalKling3p0StandardRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_fal_kling_3p0_standard( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_kling_3p0_standard_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalKling3p0Standard(state))) +} + +pub(crate) fn build_fal_kling_3p0_standard_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let generate_audio = builder.generate_audio; + + let mode = match optional_url(builder.start_frame.clone())? { + None => { + if builder.end_frame.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Kling 3.0 Standard requires a start_frame when end_frame is provided".to_string(), + })); + } + FalKling3p0StandardMode::TextToVideo(Kling3p0StandardTextToVideoRequest { + prompt, + generate_audio, + negative_prompt, + duration: duration.map(to_t2v_duration), + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + shot_type: None, + }) + } + Some(image_url) => FalKling3p0StandardMode::ImageToVideo(Kling3p0StandardImageToVideoRequest { + prompt, + image_url, + end_image_url: optional_url(builder.end_frame.clone())?, + generate_audio, + negative_prompt, + duration: duration.map(to_i2v_duration), + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + shot_type: None, + }), + }; + + Ok(FalKling3p0StandardRequestState { mode }) +} + +fn to_t2v_duration(d: PlanDuration) -> Kling3p0StandardTextToVideoDuration { + use Kling3p0StandardTextToVideoDuration as D; + match d.0 { + 3 => D::ThreeSeconds, + 4 => D::FourSeconds, + 5 => D::FiveSeconds, + 6 => D::SixSeconds, + 7 => D::SevenSeconds, + 8 => D::EightSeconds, + 9 => D::NineSeconds, + 10 => D::TenSeconds, + 11 => D::ElevenSeconds, + 12 => D::TwelveSeconds, + 13 => D::ThirteenSeconds, + 14 => D::FourteenSeconds, + _ => D::FifteenSeconds, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Kling3p0StandardImageToVideoDuration { + use Kling3p0StandardImageToVideoDuration as D; + match d.0 { + 3 => D::ThreeSeconds, + 4 => D::FourSeconds, + 5 => D::FiveSeconds, + 6 => D::SixSeconds, + 7 => D::SevenSeconds, + 8 => D::EightSeconds, + 9 => D::NineSeconds, + 10 => D::TenSeconds, + 11 => D::ElevenSeconds, + 12 => D::TwelveSeconds, + 13 => D::ThirteenSeconds, + 14 => D::FourteenSeconds, + _ => D::FifteenSeconds, + } +} + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Kling3p0StandardTextToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling3p0StandardTextToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling3p0StandardTextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling3p0StandardTextToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> Kling3p0StandardImageToVideoAspectRatio { + match a { + PlanAspectRatio::Square => Kling3p0StandardImageToVideoAspectRatio::Square, + PlanAspectRatio::SixteenByNine => Kling3p0StandardImageToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Kling3p0StandardImageToVideoAspectRatio::NineBySixteen, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + + use super::*; + + #[test] + fn no_start_frame_picks_t2v() { + let state = build_fal_kling_3p0_standard_state(base_builder()).expect("build"); + assert!(matches!(state.mode, FalKling3p0StandardMode::TextToVideo(_))); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let state = build_fal_kling_3p0_standard_state(b).expect("build"); + assert!(matches!(state.mode, FalKling3p0StandardMode::ImageToVideo(_))); + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_kling_3p0_standard_state(b).is_err()); + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Standard, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/cost.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/cost.rs new file mode 100644 index 00000000..d8a9cab5 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/cost.rs @@ -0,0 +1,88 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::kling_3p0_standard::request::{ + FalKling3p0StandardMode, FalKling3p0StandardRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalKling3p0StandardCostState { + pub cost_in_usd_cents: u64, +} + +impl FalKling3p0StandardCostState { + pub fn from_request(request: &FalKling3p0StandardRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalKling3p0StandardMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalKling3p0StandardMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::kling_3p0_standard::build::build_fal_kling_3p0_standard_state; + + use super::*; + + // Pricing (fal): audio off $0.168/sec (rate=168 tenths-of-cents), audio on + // $0.252/sec (rate=252), rounded up to whole cents. + + #[test] + fn audio_on_5s_is_126() { + // rate=252, (252*5 + 9) / 10 = 1269/10 = 126. + assert_eq!(cost_cents(Some(5), Some(true)), 126); + } + + #[test] + fn audio_off_5s_is_84() { + // rate=168, (168*5 + 9) / 10 = 849/10 = 84. + assert_eq!(cost_cents(Some(5), Some(false)), 84); + } + + #[test] + fn audio_on_10s_is_252() { + assert_eq!(cost_cents(Some(10), Some(true)), 252); + } + + #[test] + fn audio_off_15s_is_252() { + // (168*15 + 9) / 10 = 2529/10 = 252. + assert_eq!(cost_cents(Some(15), Some(false)), 252); + } + + fn cost_cents(duration_seconds: Option, generate_audio: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Kling3p0Standard, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + let state = build_fal_kling_3p0_standard_state(b).expect("build_fal_kling_3p0_standard_state"); + FalKling3p0StandardCostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost_in_usd_cents") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/mod.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/request.rs b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/request.rs new file mode 100644 index 00000000..2497209e --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/kling_3p0_standard/request.rs @@ -0,0 +1,79 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::kling_3p0_standard_image_to_video::api::Kling3p0StandardImageToVideoRequest; +use fal_client::requests::api::video::text::kling_3p0_standard_text_to_video::api::Kling3p0StandardTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalKling3p0StandardMode { + TextToVideo(Kling3p0StandardTextToVideoRequest), + ImageToVideo(Kling3p0StandardImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalKling3p0StandardRequestState { + pub mode: FalKling3p0StandardMode, +} + +impl FalKling3p0StandardRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalKling3p0StandardMode::TextToVideo(request) => send_request(request, client).await, + FalKling3p0StandardMode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/mod.rs b/crates/router/src/generate/generate_video/providers/fal/mod.rs new file mode 100644 index 00000000..49f1ec50 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/mod.rs @@ -0,0 +1,19 @@ +pub mod kling_1_6_pro; +pub mod kling_2_1_master; +pub mod kling_2_1_pro; +pub mod kling_2_5_turbo_pro; +pub mod kling_2_6_pro; +pub mod kling_3p0_pro; +pub mod kling_3p0_standard; +pub mod seedance_1p0_lite; +pub mod seedance_1p5_pro; +pub mod sora_2; +pub mod sora_2_pro; +pub mod veo_2; +pub mod veo_3; +pub mod veo_3_fast; +pub mod veo_3p1; +pub mod veo_3p1_fast; +pub mod veo_3p1_lite; +pub mod vidu_q3; +pub mod vidu_q3_turbo; diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/build.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/build.rs new file mode 100644 index 00000000..5deb01f2 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/build.rs @@ -0,0 +1,526 @@ +use fal_client::requests_old::webhook::video::image::enqueue_seedance_1_lite_image_to_video_webhook::{ + Seedance1LiteAspectRatio, Seedance1LiteDuration, Seedance1LiteRequest, Seedance1LiteResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::seedance_1p0_lite::request::FalSeedance10LiteRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_fal_seedance_1p0_lite( + mut builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let image_url = require_url( + builder.start_frame.take(), + "start_frame", + "Seedance 1.0 Lite requires a starting frame", + )?; + let end_frame_image_url = optional_url(builder.end_frame.take())?; + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_resolution(builder.resolution.take(), strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + + let request = Seedance1LiteRequest { + image_url, + end_frame_image_url, + prompt, + duration, + resolution, + aspect_ratio, + camera_fixed: false, + seed: None, + }; + + let state = FalSeedance10LiteRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSeedance10Lite(state))) +} + +// ── Plan helpers (copies of v1 logic; kept in sync intentionally) ── + +fn require_url( + start_frame: Option, + field: &'static str, + msg: &'static str, +) -> Result { + match start_frame { + Some(ImageRef::Url(url)) => Ok(url), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: "Fal only supports image URLs, not media file tokens".to_string(), + })) + } + None => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: msg.to_string(), + })), + } +} + +fn optional_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Fal only supports image URLs, not media file tokens".to_string(), + })) + } + } +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Seedance1LiteAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(Ar::FourByThree)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Some(Ar::TwentyOneByNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(Ar::ThreeByFour)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(Ar::Auto)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + use Seedance1LiteResolution as R; + match resolution { + None => Ok(R::SevenTwentyP), + Some(RouterResolution::FourEightyP) => Ok(R::FourEightyP), + Some(RouterResolution::SevenTwentyP) => Ok(R::SevenTwentyP), + Some(RouterResolution::TenEightyP) => Ok(R::TenEightyP), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(R::TenEightyP), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(R::FourEightyP), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match duration_seconds { + None => Ok(Seedance1LiteDuration::FiveSeconds), + Some(5) => Ok(Seedance1LiteDuration::FiveSeconds), + Some(10) => Ok(Seedance1LiteDuration::TenSeconds), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Seedance1LiteDuration::TenSeconds), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Seedance1LiteDuration::FiveSeconds), + }, + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance10Lite, + provider: RouterProvider::Fal, + prompt: Some("a corgi running".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/start.png".to_string())), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut b = base_builder(); + f(&mut b); + b + } + + fn unwrap_request(result: Result) -> Seedance1LiteRequest { + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSeedance10Lite(state)) => state.request, + _ => panic!("expected FalSeedance10Lite request"), + } + } + + // ── Materialized field conversions ── + + mod materialized_field_conversions { + use super::*; + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.prompt = Some("hi".to_string()); + }))); + assert_eq!(req.prompt, "hi"); + } + + #[test] + fn prompt_defaults_to_empty() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { b.prompt = None; }))); + assert_eq!(req.prompt, ""); + } + + #[test] + fn start_frame_passed_through() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + }))); + assert_eq!(req.image_url, "https://example.com/a.png"); + } + + #[test] + fn end_frame_passed_through() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + }))); + assert_eq!(req.end_frame_image_url.as_deref(), Some("https://example.com/end.png")); + } + + #[test] + fn end_frame_absent_is_none() { + let req = unwrap_request(build_fal_seedance_1p0_lite(base_builder())); + assert!(req.end_frame_image_url.is_none()); + } + + #[test] + fn camera_fixed_defaults_to_false() { + let req = unwrap_request(build_fal_seedance_1p0_lite(base_builder())); + assert!(!req.camera_fixed); + } + + #[test] + fn seed_defaults_to_none() { + let req = unwrap_request(build_fal_seedance_1p0_lite(base_builder())); + assert!(req.seed.is_none()); + } + } + + // ── start_frame is required for 1.0 lite ── + + mod start_frame_required { + use super::*; + + #[test] + fn missing_start_frame_errors() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { b.start_frame = None; })); + assert!(result.is_err()); + } + + #[test] + fn end_frame_alone_errors() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { + b.start_frame = None; + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + })); + assert!(result.is_err()); + } + + #[test] + fn media_file_token_for_start_frame_errors() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + })); + assert!(result.is_err()); + } + + #[test] + fn media_file_token_for_end_frame_errors() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { + b.end_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + })); + assert!(result.is_err()); + } + } + + // ── Resolution conversions ── + + mod resolution_conversions { + use super::*; + + #[test] + fn resolution_480p() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.resolution = Some(RouterResolution::FourEightyP); + }))); + assert_eq!(req.resolution, Seedance1LiteResolution::FourEightyP); + } + + #[test] + fn resolution_720p() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.resolution = Some(RouterResolution::SevenTwentyP); + }))); + assert_eq!(req.resolution, Seedance1LiteResolution::SevenTwentyP); + } + + #[test] + fn resolution_1080p() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.resolution = Some(RouterResolution::TenEightyP); + }))); + assert_eq!(req.resolution, Seedance1LiteResolution::TenEightyP); + } + + #[test] + fn resolution_none_defaults_to_720p() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { b.resolution = None; }))); + assert_eq!(req.resolution, Seedance1LiteResolution::SevenTwentyP); + } + + #[test] + fn unsupported_resolution_errors_with_error_out() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + })); + assert!(result.is_err()); + } + + #[test] + fn unsupported_resolution_upgrades_with_pay_more() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + }))); + assert_eq!(req.resolution, Seedance1LiteResolution::TenEightyP); + } + + #[test] + fn unsupported_resolution_downgrades_with_pay_less() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + }))); + assert_eq!(req.resolution, Seedance1LiteResolution::FourEightyP); + } + } + + // ── Duration conversions ── + + mod duration_conversions { + use super::*; + + #[test] + fn duration_5s() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { b.duration_seconds = Some(5); }))); + assert_eq!(req.duration, Seedance1LiteDuration::FiveSeconds); + } + + #[test] + fn duration_10s() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { b.duration_seconds = Some(10); }))); + assert_eq!(req.duration, Seedance1LiteDuration::TenSeconds); + } + + #[test] + fn duration_none_defaults_to_5s() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { b.duration_seconds = None; }))); + assert_eq!(req.duration, Seedance1LiteDuration::FiveSeconds); + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { + b.duration_seconds = Some(7); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + })); + assert!(result.is_err()); + } + + #[test] + fn unsupported_duration_upgrades_with_pay_more() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.duration_seconds = Some(8); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + }))); + assert_eq!(req.duration, Seedance1LiteDuration::TenSeconds); + } + + #[test] + fn unsupported_duration_downgrades_with_pay_less() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.duration_seconds = Some(8); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + }))); + assert_eq!(req.duration, Seedance1LiteDuration::FiveSeconds); + } + } + + // ── Aspect ratio conversions ── + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn auto() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::Auto); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::Auto))); + } + + #[test] + fn square() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::Square); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::Square))); + } + + #[test] + fn sixteen_by_nine() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::SixteenByNine))); + } + + #[test] + fn nine_by_sixteen() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::NineBySixteen))); + } + + #[test] + fn twenty_one_by_nine() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideTwentyOneByNine); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::TwentyOneByNine))); + } + + #[test] + fn four_by_three() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideFourByThree); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::FourByThree))); + } + + #[test] + fn three_by_four() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::TallThreeByFour); + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::ThreeByFour))); + } + + #[test] + fn none() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { b.aspect_ratio = None; }))); + assert!(req.aspect_ratio.is_none()); + } + + #[test] + fn unsupported_aspect_ratio_errors_with_error_out() { + let result = build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideFiveByFour); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + })); + assert!(result.is_err()); + } + + #[test] + fn unsupported_aspect_ratio_falls_back_to_auto_with_pay_more() { + let req = unwrap_request(build_fal_seedance_1p0_lite(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideFiveByFour); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + }))); + assert!(matches!(req.aspect_ratio, Some(Seedance1LiteAspectRatio::Auto))); + } + } + + // ── Full combinatorial pass ── + + #[test] + fn full_combinatorial_pass() { + let resolutions = [ + None, + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + ]; + let durations = [None, Some(5u16), Some(10u16)]; + let aspect_ratios = [ + None, + Some(RouterAspectRatio::Auto), + Some(RouterAspectRatio::Square), + Some(RouterAspectRatio::WideFourByThree), + Some(RouterAspectRatio::WideSixteenByNine), + Some(RouterAspectRatio::WideTwentyOneByNine), + Some(RouterAspectRatio::TallThreeByFour), + Some(RouterAspectRatio::TallNineBySixteen), + ]; + + let mut combos = 0; + for &res in &resolutions { + for &dur in &durations { + for &ar in &aspect_ratios { + for has_end in [false, true] { + let mut b = base_builder(); + b.resolution = res; + b.duration_seconds = dur; + b.aspect_ratio = ar; + if has_end { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + } + let result = build_fal_seedance_1p0_lite(b); + assert!(result.is_ok(), "expected ok for res={:?} dur={:?} ar={:?} end={}", res, dur, ar, has_end); + combos += 1; + } + } + } + } + assert!(combos >= 192, "expected ≥192 combos, got {}", combos); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/cost.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/cost.rs new file mode 100644 index 00000000..74612543 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/cost.rs @@ -0,0 +1,204 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::seedance_1p0_lite::request::FalSeedance10LiteRequestState; + +pub struct FalSeedance10LiteCostState { + request: FalSeedance10LiteRequestState, +} + +impl FalSeedance10LiteCostState { + pub fn from_request(request: &FalSeedance10LiteRequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Mirrors v1 — delegate to the Fal client's cost calculator for billing parity. + let cost_in_usd_cents = self.request.request.calculate_cost_in_cents(); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance10Lite, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/start.png".to_string())), + ..Default::default() + } + } + + fn cost_cents(resolution: Option, duration_seconds: Option) -> u64 { + let mut b = base_builder(); + b.resolution = resolution; + b.duration_seconds = duration_seconds; + b.build2() + .expect("build2") + .estimate_cost() + .expect("estimate_cost") + .cost_in_usd_cents + .expect("cost_in_usd_cents") + } + + // ── Numeric literal price assertions (break if pricing changes) ── + + mod pricing_720p { + use super::*; + + #[test] + fn p720_5s_special_case() { + // Per the Fal cost calculator: 720p + 5s short-circuits to 18¢. + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), Some(5)), 18); + } + + #[test] + fn p720_10s() { + // 1280×720×30 fps × 10s / 1024 = 270000 tokens × $1.8/M = $0.486 → ceil = 49¢. + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), Some(10)), 49); + } + + #[test] + fn p720_default_duration_matches_5s() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), None), 18); + } + + #[test] + fn default_resolution_default_duration_matches_720p_5s() { + assert_eq!(cost_cents(None, None), 18); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn p480_5s() { + // 640×480×30×5/1024 = 45000 × $1.8/M = $0.081 → ceil = 9¢. + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), Some(5)), 9); + } + + #[test] + fn p480_10s() { + // 640×480×30×10/1024 = 90000 × $1.8/M = $0.162 → ceil = 17¢. + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), Some(10)), 17); + } + } + + mod pricing_1080p { + use super::*; + + #[test] + fn p1080_5s() { + // 1920×1080×30×5/1024 = 303750 × $1.8/M = $0.54675 → ceil = 55¢. + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), Some(5)), 55); + } + + #[test] + fn p1080_10s() { + // 1920×1080×30×10/1024 = 607500 × $1.8/M = $1.0935 → ceil = 110¢. + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), Some(10)), 110); + } + } + + // ── Relative pricing invariants ── + + mod relative_pricing { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let p480 = cost_cents(Some(RouterResolution::FourEightyP), Some(10)); + let p720 = cost_cents(Some(RouterResolution::SevenTwentyP), Some(10)); + let p1080 = cost_cents(Some(RouterResolution::TenEightyP), Some(10)); + assert!(p480 < p720, "480p ({p480}) should be < 720p ({p720})"); + assert!(p720 < p1080, "720p ({p720}) should be < 1080p ({p1080})"); + } + + #[test] + fn longer_duration_costs_more() { + let d5 = cost_cents(Some(RouterResolution::TenEightyP), Some(5)); + let d10 = cost_cents(Some(RouterResolution::TenEightyP), Some(10)); + assert!(d5 < d10, "5s ({d5}) should be < 10s ({d10})"); + } + } + + // ── Combinatorial sanity: every supported (res, dur, ar) yields a positive cost ── + + #[test] + fn combinatorial_positive_cost() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + ]; + let durations = [Some(5u16), Some(10u16)]; + let aspect_ratios = [ + None, + Some(RouterAspectRatio::Auto), + Some(RouterAspectRatio::Square), + Some(RouterAspectRatio::WideSixteenByNine), + Some(RouterAspectRatio::TallNineBySixteen), + ]; + + let mut combos = 0; + for &res in &resolutions { + for &dur in &durations { + for &ar in &aspect_ratios { + let mut b = base_builder(); + b.resolution = res; + b.duration_seconds = dur; + b.aspect_ratio = ar; + let cents = b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap(); + assert!(cents > 0, "expected positive cost for res={:?} dur={:?} ar={:?}", res, dur, ar); + combos += 1; + } + } + } + assert_eq!(combos, 30); + } + + // Aspect ratio doesn't influence cost (calculator only uses resolution and duration). + #[test] + fn aspect_ratio_does_not_affect_cost() { + let with_wide = cost_cents(Some(RouterResolution::SevenTwentyP), Some(10)); + let mut b = base_builder(); + b.resolution = Some(RouterResolution::SevenTwentyP); + b.duration_seconds = Some(10); + b.aspect_ratio = Some(RouterAspectRatio::Square); + let with_square = b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap(); + assert_eq!(with_wide, with_square); + } + + // End frame doesn't influence cost. + #[test] + fn end_frame_does_not_affect_cost() { + let without = cost_cents(Some(RouterResolution::TenEightyP), Some(5)); + let mut b = base_builder(); + b.resolution = Some(RouterResolution::TenEightyP); + b.duration_seconds = Some(5); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + let with_end = b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap(); + assert_eq!(without, with_end); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/mod.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/request.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/request.rs new file mode 100644 index 00000000..93bdef61 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p0_lite/request.rs @@ -0,0 +1,129 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_seedance_1_lite_image_to_video_webhook::{ + enqueue_seedance_1_lite_image_to_video_webhook, Seedance1LiteArgs, Seedance1LiteRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub struct FalSeedance10LiteRequestState { + pub request: Seedance1LiteRequest, +} + +impl FalSeedance10LiteRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let outbound_request: Arc = Arc::new(self.request.clone()); + + let args = Seedance1LiteArgs { + request: self.request.clone(), + api_key: &client.api_key, + webhook_url, + }; + + let webhook_response = enqueue_seedance_1_lite_image_to_video_webhook(args) + .await + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + // ── Live integration tests (require Fal credentials, incur costs) ── + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_image_to_video_720p_5s() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the dog leaps into the lake and splashes around.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..fal_seedance_1p0_lite_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_image_to_video_480p_10s() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a vivid splash of color filling the frame".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(10), + ..fal_seedance_1p0_lite_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_image_to_video_with_end_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a smooth transition between two scenes".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + end_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(5), + ..fal_seedance_1p0_lite_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + fn fal_seedance_1p0_lite_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance10Lite, + provider: RouterProvider::Fal, + video_batch_count: Some(1), + ..Default::default() + } + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_fal_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal skips draft)"), + }; + let response = request.send_request(&client).await.expect("send_request should succeed"); + match &response { + GenerateVideoResponse::Fal(p) => println!("fal request_id={:?}", p.request_id), + other => println!("unexpected response: {:?}", other), + } + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/build.rs new file mode 100644 index 00000000..eae57430 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/build.rs @@ -0,0 +1,704 @@ +use fal_client::requests_old::webhook::video::image::enqueue_seedance_1p5_pro_image_to_video_webhook::{ + EnqueueSeedance1p5ProImageToVideoAspectRatio, EnqueueSeedance1p5ProImageToVideoDuration, + EnqueueSeedance1p5ProImageToVideoRequest, EnqueueSeedance1p5ProImageToVideoResolution, +}; +use fal_client::requests_old::webhook::video::text::enqueue_seedance_1p5_pro_text_to_video_webhook::{ + EnqueueSeedance1p5ProTextToVideoAspectRatio, EnqueueSeedance1p5ProTextToVideoDuration, + EnqueueSeedance1p5ProTextToVideoRequest, EnqueueSeedance1p5ProTextToVideoResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::seedance_1p5_pro::request::{ + FalSeedance1p5ProMode, FalSeedance1p5ProRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +// Resolution / duration / aspect-ratio variants used for planning. Mirrors the +// v1 plan types, but lives entirely inside this module so the v2 dir is self-contained. +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +enum PlanResolution { + FourEightyP, + SevenTwentyP, + TenEightyP, +} + +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +enum PlanDuration { + Four, + Five, + Six, + Seven, + Eight, + Nine, + Ten, + Eleven, + Twelve, +} + +#[derive(Debug, Clone, Copy, Eq, PartialEq)] +enum PlanAspectRatio { + Auto, + TwentyOneByNine, + SixteenByNine, + FourByThree, + Square, + ThreeByFour, + NineBySixteen, +} + +pub fn build_fal_seedance_1p5_pro( + mut builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Decide t2v vs i2v based on whether a start_frame was provided. + let image_url = optional_url(builder.start_frame.take())?; + let end_image_url = optional_url(builder.end_frame.take())?; + + if image_url.is_none() && end_image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Seedance 1.5 Pro requires a start_frame when end_frame is provided".to_string(), + })); + } + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_resolution(builder.resolution.take(), strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + let generate_audio = builder.generate_audio.take(); + + let mode = match image_url { + None => FalSeedance1p5ProMode::TextToVideo(EnqueueSeedance1p5ProTextToVideoRequest { + prompt, + resolution: resolution.map(to_t2v_resolution), + duration: duration.map(to_t2v_duration), + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + generate_audio, + }), + Some(image_url) => FalSeedance1p5ProMode::ImageToVideo(EnqueueSeedance1p5ProImageToVideoRequest { + prompt, + image_url, + end_image_url, + resolution: resolution.map(to_i2v_resolution), + duration: duration.map(to_i2v_duration), + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + generate_audio, + }), + }; + + let state = FalSeedance1p5ProRequestState { mode }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSeedance1p5Pro(state))) +} + +// ── Plan helpers (kept in sync with v1 plan_generate_video_fal_seedance_1p5_pro.rs) ── + +fn optional_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "start_frame/end_frame", + value: "Fal only supports image URLs, not media file tokens".to_string(), + })) + } + } +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(Ar::FourByThree)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(Some(Ar::TwentyOneByNine)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(Ar::ThreeByFour)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(nearest_aspect_ratio(unsupported))), + }, + } +} + +/// Pick the nearest supported aspect ratio for unsupported inputs. +fn nearest_aspect_ratio(aspect_ratio: RouterAspectRatio) -> PlanAspectRatio { + use PlanAspectRatio as Ar; + match aspect_ratio { + RouterAspectRatio::WideFiveByFour => Ar::FourByThree, + RouterAspectRatio::WideThreeByTwo => Ar::FourByThree, + RouterAspectRatio::TallFourByFive => Ar::ThreeByFour, + RouterAspectRatio::TallTwoByThree => Ar::ThreeByFour, + RouterAspectRatio::TallNineByTwentyOne => Ar::NineBySixteen, + _ => Ar::Square, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanResolution as R; + match resolution { + None => Ok(None), + Some(RouterResolution::FourEightyP) => Ok(Some(R::FourEightyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(R::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(R::TenEightyP)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(R::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(R::FourEightyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanDuration as D; + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(D::Four)), + Some(5) => Ok(Some(D::Five)), + Some(6) => Ok(Some(D::Six)), + Some(7) => Ok(Some(D::Seven)), + Some(8) => Ok(Some(D::Eight)), + Some(9) => Ok(Some(D::Nine)), + Some(10) => Ok(Some(D::Ten)), + Some(11) => Ok(Some(D::Eleven)), + Some(12) => Ok(Some(D::Twelve)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(D::Twelve)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(D::Four)), + }, + } +} + +// ── PlanXxx → fal_client request enum mapping ── + +fn to_t2v_resolution(r: PlanResolution) -> EnqueueSeedance1p5ProTextToVideoResolution { + use EnqueueSeedance1p5ProTextToVideoResolution as R; + match r { + PlanResolution::FourEightyP => R::FourEightyP, + PlanResolution::SevenTwentyP => R::SevenTwentyP, + PlanResolution::TenEightyP => R::TenEightyP, + } +} + +fn to_t2v_duration(d: PlanDuration) -> EnqueueSeedance1p5ProTextToVideoDuration { + use EnqueueSeedance1p5ProTextToVideoDuration as D; + match d { + PlanDuration::Four => D::FourSeconds, + PlanDuration::Five => D::FiveSeconds, + PlanDuration::Six => D::SixSeconds, + PlanDuration::Seven => D::SevenSeconds, + PlanDuration::Eight => D::EightSeconds, + PlanDuration::Nine => D::NineSeconds, + PlanDuration::Ten => D::TenSeconds, + PlanDuration::Eleven => D::ElevenSeconds, + PlanDuration::Twelve => D::TwelveSeconds, + } +} + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> EnqueueSeedance1p5ProTextToVideoAspectRatio { + use EnqueueSeedance1p5ProTextToVideoAspectRatio as Ar; + match a { + PlanAspectRatio::Auto => Ar::Auto, + PlanAspectRatio::TwentyOneByNine => Ar::TwentyOneByNine, + PlanAspectRatio::SixteenByNine => Ar::SixteenByNine, + PlanAspectRatio::FourByThree => Ar::FourByThree, + PlanAspectRatio::Square => Ar::Square, + PlanAspectRatio::ThreeByFour => Ar::ThreeByFour, + PlanAspectRatio::NineBySixteen => Ar::NineBySixteen, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> EnqueueSeedance1p5ProImageToVideoResolution { + use EnqueueSeedance1p5ProImageToVideoResolution as R; + match r { + PlanResolution::FourEightyP => R::FourEightyP, + PlanResolution::SevenTwentyP => R::SevenTwentyP, + PlanResolution::TenEightyP => R::TenEightyP, + } +} + +fn to_i2v_duration(d: PlanDuration) -> EnqueueSeedance1p5ProImageToVideoDuration { + use EnqueueSeedance1p5ProImageToVideoDuration as D; + match d { + PlanDuration::Four => D::FourSeconds, + PlanDuration::Five => D::FiveSeconds, + PlanDuration::Six => D::SixSeconds, + PlanDuration::Seven => D::SevenSeconds, + PlanDuration::Eight => D::EightSeconds, + PlanDuration::Nine => D::NineSeconds, + PlanDuration::Ten => D::TenSeconds, + PlanDuration::Eleven => D::ElevenSeconds, + PlanDuration::Twelve => D::TwelveSeconds, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> EnqueueSeedance1p5ProImageToVideoAspectRatio { + use EnqueueSeedance1p5ProImageToVideoAspectRatio as Ar; + match a { + PlanAspectRatio::Auto => Ar::Auto, + PlanAspectRatio::TwentyOneByNine => Ar::TwentyOneByNine, + PlanAspectRatio::SixteenByNine => Ar::SixteenByNine, + PlanAspectRatio::FourByThree => Ar::FourByThree, + PlanAspectRatio::Square => Ar::Square, + PlanAspectRatio::ThreeByFour => Ar::ThreeByFour, + PlanAspectRatio::NineBySixteen => Ar::NineBySixteen, + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + // ── Helpers ── + + fn base_t2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance1p5Pro, + provider: RouterProvider::Fal, + prompt: Some("a corgi running".to_string()), + // No start_frame → text-to-video. + ..Default::default() + } + } + + fn base_i2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance1p5Pro, + provider: RouterProvider::Fal, + prompt: Some("a corgi running".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/start.png".to_string())), + ..Default::default() + } + } + + fn make_t2v(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut b = base_t2v_builder(); + f(&mut b); + b + } + + fn make_i2v(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut b = base_i2v_builder(); + f(&mut b); + b + } + + fn unwrap_t2v(result: Result) -> EnqueueSeedance1p5ProTextToVideoRequest { + use crate::generate::generate_video::providers::fal::seedance_1p5_pro::request::FalSeedance1p5ProMode; + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSeedance1p5Pro(state)) => match state.mode { + FalSeedance1p5ProMode::TextToVideo(req) => req, + FalSeedance1p5ProMode::ImageToVideo(_) => panic!("expected TextToVideo mode"), + }, + _ => panic!("expected FalSeedance1p5Pro request"), + } + } + + fn unwrap_i2v(result: Result) -> EnqueueSeedance1p5ProImageToVideoRequest { + use crate::generate::generate_video::providers::fal::seedance_1p5_pro::request::FalSeedance1p5ProMode; + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSeedance1p5Pro(state)) => match state.mode { + FalSeedance1p5ProMode::ImageToVideo(req) => req, + FalSeedance1p5ProMode::TextToVideo(_) => panic!("expected ImageToVideo mode"), + }, + _ => panic!("expected FalSeedance1p5Pro request"), + } + } + + // ── Mode selection (t2v vs i2v) ── + + mod mode_selection { + use super::*; + + #[test] + fn no_start_frame_picks_t2v() { + let _ = unwrap_t2v(build_fal_seedance_1p5_pro(base_t2v_builder())); + } + + #[test] + fn start_frame_picks_i2v() { + let _ = unwrap_i2v(build_fal_seedance_1p5_pro(base_i2v_builder())); + } + + #[test] + fn end_frame_alone_without_start_frame_errors() { + let result = build_fal_seedance_1p5_pro(make_t2v(|b| { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + })); + assert!(result.is_err()); + } + + #[test] + fn i2v_with_end_frame_succeeds() { + let req = unwrap_i2v(build_fal_seedance_1p5_pro(make_i2v(|b| { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + }))); + assert_eq!(req.end_image_url.as_deref(), Some("https://example.com/end.png")); + } + + #[test] + fn media_file_token_for_start_frame_errors() { + let result = build_fal_seedance_1p5_pro(make_t2v(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + })); + assert!(result.is_err()); + } + + #[test] + fn media_file_token_for_end_frame_errors() { + let result = build_fal_seedance_1p5_pro(make_i2v(|b| { + b.end_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + })); + assert!(result.is_err()); + } + } + + // ── Materialized field conversions ── + + mod materialized_field_conversions { + use super::*; + + #[test] + fn t2v_prompt_passed_through() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.prompt = Some("hello world".to_string()); + }))); + assert_eq!(req.prompt, "hello world"); + } + + #[test] + fn i2v_prompt_passed_through() { + let req = unwrap_i2v(build_fal_seedance_1p5_pro(make_i2v(|b| { + b.prompt = Some("hello world".to_string()); + }))); + assert_eq!(req.prompt, "hello world"); + } + + #[test] + fn t2v_prompt_defaults_to_empty() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { b.prompt = None; }))); + assert_eq!(req.prompt, ""); + } + + #[test] + fn i2v_image_url_passed_through() { + let req = unwrap_i2v(build_fal_seedance_1p5_pro(make_i2v(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + }))); + assert_eq!(req.image_url, "https://example.com/a.png"); + } + + #[test] + fn i2v_end_image_absent_is_none() { + let req = unwrap_i2v(build_fal_seedance_1p5_pro(base_i2v_builder())); + assert!(req.end_image_url.is_none()); + } + + #[test] + fn t2v_generate_audio_passed_through() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.generate_audio = Some(true); + }))); + assert_eq!(req.generate_audio, Some(true)); + } + + #[test] + fn t2v_generate_audio_none_passed_through() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.generate_audio = None; + }))); + assert!(req.generate_audio.is_none()); + } + + #[test] + fn i2v_generate_audio_false_passed_through() { + let req = unwrap_i2v(build_fal_seedance_1p5_pro(make_i2v(|b| { + b.generate_audio = Some(false); + }))); + assert_eq!(req.generate_audio, Some(false)); + } + } + + // ── Resolution conversions ── + + mod resolution_conversions { + use super::*; + + #[test] + fn t2v_resolution_480p() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.resolution = Some(RouterResolution::FourEightyP); + }))); + assert!(matches!(req.resolution, Some(EnqueueSeedance1p5ProTextToVideoResolution::FourEightyP))); + } + + #[test] + fn t2v_resolution_720p() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.resolution = Some(RouterResolution::SevenTwentyP); + }))); + assert!(matches!(req.resolution, Some(EnqueueSeedance1p5ProTextToVideoResolution::SevenTwentyP))); + } + + #[test] + fn t2v_resolution_1080p() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.resolution = Some(RouterResolution::TenEightyP); + }))); + assert!(matches!(req.resolution, Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP))); + } + + #[test] + fn t2v_resolution_none_stays_none() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { b.resolution = None; }))); + assert!(req.resolution.is_none()); + } + + #[test] + fn unsupported_resolution_errors_with_error_out() { + let result = build_fal_seedance_1p5_pro(make_t2v(|b| { + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + })); + assert!(result.is_err()); + } + + #[test] + fn unsupported_resolution_upgrades_with_pay_more() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + }))); + assert!(matches!(req.resolution, Some(EnqueueSeedance1p5ProTextToVideoResolution::TenEightyP))); + } + + #[test] + fn unsupported_resolution_downgrades_with_pay_less() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + }))); + assert!(matches!(req.resolution, Some(EnqueueSeedance1p5ProTextToVideoResolution::FourEightyP))); + } + } + + // ── Duration conversions (4 through 12 seconds supported) ── + + mod duration_conversions { + use super::*; + + #[test] + fn duration_4s() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { b.duration_seconds = Some(4); }))); + assert!(matches!(req.duration, Some(EnqueueSeedance1p5ProTextToVideoDuration::FourSeconds))); + } + + #[test] + fn duration_12s() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { b.duration_seconds = Some(12); }))); + assert!(matches!(req.duration, Some(EnqueueSeedance1p5ProTextToVideoDuration::TwelveSeconds))); + } + + #[test] + fn duration_none_stays_none() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { b.duration_seconds = None; }))); + assert!(req.duration.is_none()); + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let result = build_fal_seedance_1p5_pro(make_t2v(|b| { + b.duration_seconds = Some(13); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + })); + assert!(result.is_err()); + } + + #[test] + fn unsupported_duration_upgrades_to_max_with_pay_more() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + }))); + assert!(matches!(req.duration, Some(EnqueueSeedance1p5ProTextToVideoDuration::TwelveSeconds))); + } + + #[test] + fn unsupported_duration_downgrades_to_min_with_pay_less() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.duration_seconds = Some(2); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + }))); + assert!(matches!(req.duration, Some(EnqueueSeedance1p5ProTextToVideoDuration::FourSeconds))); + } + } + + // ── Aspect ratio conversions ── + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn auto() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.aspect_ratio = Some(RouterAspectRatio::Auto); + }))); + assert!(matches!(req.aspect_ratio, Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::Auto))); + } + + #[test] + fn sixteen_by_nine() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + }))); + assert!(matches!(req.aspect_ratio, Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::SixteenByNine))); + } + + #[test] + fn square() { + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.aspect_ratio = Some(RouterAspectRatio::Square); + }))); + assert!(matches!(req.aspect_ratio, Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::Square))); + } + + #[test] + fn unsupported_aspect_ratio_falls_back_to_nearest_with_pay_more() { + // WideFiveByFour → nearest wide → FourByThree (per nearest_aspect_ratio). + let req = unwrap_t2v(build_fal_seedance_1p5_pro(make_t2v(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideFiveByFour); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + }))); + assert!(matches!(req.aspect_ratio, Some(EnqueueSeedance1p5ProTextToVideoAspectRatio::FourByThree))); + } + + #[test] + fn unsupported_aspect_ratio_errors_with_error_out() { + let result = build_fal_seedance_1p5_pro(make_t2v(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideFiveByFour); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + })); + assert!(result.is_err()); + } + } + + // ── Full combinatorial pass (t2v + i2v) ── + + #[test] + fn t2v_combinatorial_pass() { + let resolutions = [ + None, + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + ]; + let durations = [None, Some(4u16), Some(8u16), Some(12u16)]; + let aspect_ratios = [ + None, + Some(RouterAspectRatio::Auto), + Some(RouterAspectRatio::Square), + Some(RouterAspectRatio::WideSixteenByNine), + Some(RouterAspectRatio::TallNineBySixteen), + ]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &res in &resolutions { + for &dur in &durations { + for &ar in &aspect_ratios { + for &audio in &audios { + let mut b = base_t2v_builder(); + b.resolution = res; + b.duration_seconds = dur; + b.aspect_ratio = ar; + b.generate_audio = audio; + assert!(build_fal_seedance_1p5_pro(b).is_ok()); + combos += 1; + } + } + } + } + assert_eq!(combos, 4 * 4 * 5 * 3); + } + + #[test] + fn i2v_combinatorial_pass() { + let resolutions = [ + None, + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + ]; + let durations = [None, Some(5u16), Some(12u16)]; + let aspect_ratios = [None, Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::Square)]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &res in &resolutions { + for &dur in &durations { + for &ar in &aspect_ratios { + for &audio in &audios { + for has_end in [false, true] { + let mut b = base_i2v_builder(); + b.resolution = res; + b.duration_seconds = dur; + b.aspect_ratio = ar; + b.generate_audio = audio; + if has_end { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + } + assert!(build_fal_seedance_1p5_pro(b).is_ok()); + combos += 1; + } + } + } + } + } + assert_eq!(combos, 3 * 3 * 3 * 3 * 2); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/cost.rs new file mode 100644 index 00000000..f5479d81 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/cost.rs @@ -0,0 +1,323 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; +use fal_client::requests_old::webhook::video::text::enqueue_seedance_1p5_pro_text_to_video_webhook::{ + EnqueueSeedance1p5ProTextToVideoDuration, EnqueueSeedance1p5ProTextToVideoRequest, + EnqueueSeedance1p5ProTextToVideoResolution, +}; +use fal_client::requests_old::webhook::video::image::enqueue_seedance_1p5_pro_image_to_video_webhook::{ + EnqueueSeedance1p5ProImageToVideoDuration, EnqueueSeedance1p5ProImageToVideoResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::seedance_1p5_pro::request::{ + FalSeedance1p5ProMode, FalSeedance1p5ProRequestState, +}; + +pub struct FalSeedance1p5ProCostState { + request: FalSeedance1p5ProRequestState, +} + +impl FalSeedance1p5ProCostState { + pub fn from_request(request: &FalSeedance1p5ProRequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Seedance 1.5 Pro t2v and i2v have identical pricing. v1 delegates both + // to the t2v calculator; v2 does the same to guarantee billing parity. + let t2v_request = match &self.request.mode { + FalSeedance1p5ProMode::TextToVideo(req) => req.clone(), + FalSeedance1p5ProMode::ImageToVideo(req) => EnqueueSeedance1p5ProTextToVideoRequest { + prompt: String::new(), + resolution: req.resolution.map(i2v_to_t2v_resolution), + duration: req.duration.map(i2v_to_t2v_duration), + aspect_ratio: None, + generate_audio: req.generate_audio, + }, + }; + + let cost_in_usd_cents = t2v_request.calculate_cost_in_cents(); + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn i2v_to_t2v_resolution(r: EnqueueSeedance1p5ProImageToVideoResolution) -> EnqueueSeedance1p5ProTextToVideoResolution { + use EnqueueSeedance1p5ProImageToVideoResolution as I; + use EnqueueSeedance1p5ProTextToVideoResolution as T; + match r { + I::FourEightyP => T::FourEightyP, + I::SevenTwentyP => T::SevenTwentyP, + I::TenEightyP => T::TenEightyP, + } +} + +fn i2v_to_t2v_duration(d: EnqueueSeedance1p5ProImageToVideoDuration) -> EnqueueSeedance1p5ProTextToVideoDuration { + use EnqueueSeedance1p5ProImageToVideoDuration as I; + use EnqueueSeedance1p5ProTextToVideoDuration as T; + match d { + I::FourSeconds => T::FourSeconds, + I::FiveSeconds => T::FiveSeconds, + I::SixSeconds => T::SixSeconds, + I::SevenSeconds => T::SevenSeconds, + I::EightSeconds => T::EightSeconds, + I::NineSeconds => T::NineSeconds, + I::TenSeconds => T::TenSeconds, + I::ElevenSeconds => T::ElevenSeconds, + I::TwelveSeconds => T::TwelveSeconds, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // ── Helpers ── + + fn t2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance1p5Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn i2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance1p5Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + start_frame: Some(ImageRef::Url("https://example.com/start.png".to_string())), + ..Default::default() + } + } + + fn cost_cents( + builder_factory: fn() -> GenerateVideoRequestBuilder, + resolution: Option, + duration_seconds: Option, + generate_audio: Option, + ) -> u64 { + let mut b = builder_factory(); + b.resolution = resolution; + b.duration_seconds = duration_seconds; + b.generate_audio = generate_audio; + b.build2() + .expect("build2") + .estimate_cost() + .expect("estimate_cost") + .cost_in_usd_cents + .expect("cost_in_usd_cents") + } + + // ── T2V numeric literal pricing assertions ── + + mod t2v_pricing_720p { + use super::*; + + #[test] + fn p720_5s_audio_special_case() { + // Special-case: 720p + 5s + audio short-circuits to 26¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(5), Some(true)), 26); + } + + #[test] + fn p720_5s_no_audio_special_case() { + // Special-case: 720p + 5s without audio → 13¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(5), Some(false)), 13); + } + + #[test] + fn p720_5s_default_audio_is_with_audio() { + // generate_audio = None defaults to true in the cost calculator. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(5), None), 26); + } + + #[test] + fn p720_10s_with_audio() { + // 1280×720×30×10/1024 = 270000 × $2.4/M = $0.648 → ceil = 65¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(10), Some(true)), 65); + } + + #[test] + fn p720_10s_no_audio() { + // 270000 × $1.2/M = $0.324 → ceil = 33¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(10), Some(false)), 33); + } + + #[test] + fn p720_12s_with_audio() { + // 1280×720×30×12/1024 = 324000 × $2.4/M = $0.7776 → ceil = 78¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(12), Some(true)), 78); + } + } + + mod t2v_pricing_480p { + use super::*; + + #[test] + fn p480_5s_audio() { + // 640×480×30×5/1024 = 45000 × $2.4/M = $0.108 → ceil = 11¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::FourEightyP), Some(5), Some(true)), 11); + } + + #[test] + fn p480_5s_no_audio() { + // 45000 × $1.2/M = $0.054 → ceil = 6¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::FourEightyP), Some(5), Some(false)), 6); + } + + #[test] + fn p480_10s_audio() { + // 90000 × $2.4/M = $0.216 → ceil = 22¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::FourEightyP), Some(10), Some(true)), 22); + } + } + + mod t2v_pricing_1080p { + use super::*; + + #[test] + fn p1080_5s_audio() { + // 1920×1080×30×5/1024 = 303750 × $2.4/M = $0.729 → ceil = 73¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(5), Some(true)), 73); + } + + #[test] + fn p1080_5s_no_audio() { + // 303750 × $1.2/M = $0.36450 → ceil = 37¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(5), Some(false)), 37); + } + + #[test] + fn p1080_10s_audio() { + // 607500 × $2.4/M = $1.458 → ceil = 146¢. + assert_eq!(cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(10), Some(true)), 146); + } + } + + // ── I2V costs match T2V at identical params ── + + mod i2v_matches_t2v { + use super::*; + + #[test] + fn p720_5s_audio() { + assert_eq!( + cost_cents(i2v_builder, Some(RouterResolution::SevenTwentyP), Some(5), Some(true)), + cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(5), Some(true)), + ); + } + + #[test] + fn p1080_10s_no_audio() { + assert_eq!( + cost_cents(i2v_builder, Some(RouterResolution::TenEightyP), Some(10), Some(false)), + cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(10), Some(false)), + ); + } + + #[test] + fn p480_12s_audio() { + assert_eq!( + cost_cents(i2v_builder, Some(RouterResolution::FourEightyP), Some(12), Some(true)), + cost_cents(t2v_builder, Some(RouterResolution::FourEightyP), Some(12), Some(true)), + ); + } + } + + // ── Relative pricing invariants ── + + mod relative_pricing { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let p480 = cost_cents(t2v_builder, Some(RouterResolution::FourEightyP), Some(5), Some(true)); + let p720 = cost_cents(t2v_builder, Some(RouterResolution::SevenTwentyP), Some(5), Some(true)); + let p1080 = cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(5), Some(true)); + assert!(p480 < p720, "480p ({p480}) < 720p ({p720})"); + assert!(p720 < p1080, "720p ({p720}) < 1080p ({p1080})"); + } + + #[test] + fn longer_duration_costs_more() { + let d4 = cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(4), Some(true)); + let d8 = cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(8), Some(true)); + let d12 = cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(12), Some(true)); + assert!(d4 < d8); + assert!(d8 < d12); + } + + #[test] + fn audio_costs_more_than_no_audio() { + let with_audio = cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(10), Some(true)); + let no_audio = cost_cents(t2v_builder, Some(RouterResolution::TenEightyP), Some(10), Some(false)); + assert!(no_audio < with_audio, "no-audio ({no_audio}) < audio ({with_audio})"); + } + } + + // ── Aspect ratio doesn't affect cost ── + + #[test] + fn aspect_ratio_does_not_affect_cost() { + let mut b = t2v_builder(); + b.resolution = Some(RouterResolution::SevenTwentyP); + b.duration_seconds = Some(10); + b.generate_audio = Some(true); + let baseline = b.clone().build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap(); + + for ar in [ + Some(RouterAspectRatio::Auto), + Some(RouterAspectRatio::Square), + Some(RouterAspectRatio::WideSixteenByNine), + Some(RouterAspectRatio::TallNineBySixteen), + Some(RouterAspectRatio::WideTwentyOneByNine), + ] { + let mut variant = b.clone(); + variant.aspect_ratio = ar; + let cost = variant.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap(); + assert_eq!(cost, baseline, "aspect_ratio {:?} changed cost", ar); + } + } + + // ── Combinatorial sanity ── + + #[test] + fn combinatorial_positive_cost() { + let resolutions = [ + Some(RouterResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP), + ]; + let durations = [Some(4u16), Some(5), Some(8), Some(12)]; + let audios = [Some(true), Some(false), None]; + + let mut combos = 0; + for &res in &resolutions { + for &dur in &durations { + for &audio in &audios { + for factory in [t2v_builder, i2v_builder] { + let cents = cost_cents(factory, res, dur, audio); + assert!(cents > 0, "expected positive cost: res={:?} dur={:?} audio={:?}", res, dur, audio); + combos += 1; + } + } + } + } + assert_eq!(combos, 3 * 4 * 3 * 2); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/request.rs new file mode 100644 index 00000000..b2e2895b --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/seedance_1p5_pro/request.rs @@ -0,0 +1,167 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_seedance_1p5_pro_image_to_video_webhook::{ + enqueue_seedance_1p5_pro_image_to_video_webhook, EnqueueSeedance1p5ProImageToVideoArgs, + EnqueueSeedance1p5ProImageToVideoRequest, +}; +use fal_client::requests_old::webhook::video::text::enqueue_seedance_1p5_pro_text_to_video_webhook::{ + enqueue_seedance_1p5_pro_text_to_video_webhook, EnqueueSeedance1p5ProTextToVideoArgs, + EnqueueSeedance1p5ProTextToVideoRequest, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalSeedance1p5ProMode { + TextToVideo(EnqueueSeedance1p5ProTextToVideoRequest), + ImageToVideo(EnqueueSeedance1p5ProImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalSeedance1p5ProRequestState { + pub mode: FalSeedance1p5ProMode, +} + +impl FalSeedance1p5ProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound_request): (_, Arc) = match &self.mode { + FalSeedance1p5ProMode::TextToVideo(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueSeedance1p5ProTextToVideoArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_seedance_1p5_pro_text_to_video_webhook(args).await, outbound) + } + FalSeedance1p5ProMode::ImageToVideo(request) => { + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueSeedance1p5ProImageToVideoArgs { + request: request.clone(), + webhook_url, + api_key: &client.api_key, + }; + (enqueue_seedance_1p5_pro_image_to_video_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + // ── Live integration tests (require Fal credentials, incur costs) ── + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_text_to_video_720p_5s() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a serene mountain landscape at sunrise.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + generate_audio: Some(true), + ..fal_seedance_1p5_pro_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_text_to_video_1080p_no_audio() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a city street bustling with people".to_string()), + resolution: Some(RouterResolution::TenEightyP), + duration_seconds: Some(5), + generate_audio: Some(false), + ..fal_seedance_1p5_pro_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_image_to_video_720p_5s() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the dog leaps into the lake and splashes around.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..fal_seedance_1p5_pro_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn live_image_to_video_with_end_frame() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a smooth transition between two scenes".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + end_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(5), + ..fal_seedance_1p5_pro_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + fn fal_seedance_1p5_pro_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance1p5Pro, + provider: RouterProvider::Fal, + video_batch_count: Some(1), + ..Default::default() + } + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_fal_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Fal skips draft)"), + }; + let response = request.send_request(&client).await.expect("send_request should succeed"); + match &response { + GenerateVideoResponse::Fal(p) => println!("fal request_id={:?}", p.request_id), + other => println!("unexpected response: {:?}", other), + } + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2/build.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2/build.rs new file mode 100644 index 00000000..2a2f0a15 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2/build.rs @@ -0,0 +1,166 @@ +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::sora_2::request::{ + FalSora2AspectRatio, FalSora2Duration, FalSora2Mode, FalSora2RequestState, FalSora2Resolution, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_fal_sora_2( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + if builder.end_frame.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Sora 2 does not support an ending frame".to_string(), + })); + } + + let mode = match optional_url(builder.start_frame.clone())? { + None => FalSora2Mode::TextToVideo, + Some(image_url) => FalSora2Mode::ImageToVideo { image_url }, + }; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSora2( + FalSora2RequestState { + prompt: builder.prompt.clone().unwrap_or_default(), + mode, + aspect_ratio, + resolution, + duration, + }, + ))) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use FalSora2AspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use FalSora2Resolution as R; + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(R::SevenTwentyP)), + // Only 720p is supported; everything else falls back or errors. + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(R::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use FalSora2Duration as D; + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(D::Four)), + Some(8) => Ok(Some(D::Eight)), + Some(12) => Ok(Some(D::Twelve)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(D::Twelve)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(D::Four)), + }, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Sora2, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + #[test] + fn no_start_frame_picks_t2v() { + let r = build_fal_sora_2(base_builder()).expect("build"); + if let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSora2(s)) = r { + assert!(matches!(s.mode, FalSora2Mode::TextToVideo)); + } else { panic!("expected FalSora2"); } + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let r = build_fal_sora_2(b).expect("build"); + if let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSora2(s)) = r { + assert!(matches!(s.mode, FalSora2Mode::ImageToVideo { .. })); + } else { panic!("expected FalSora2"); } + } + + #[test] + fn end_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_sora_2(b).is_err()); + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_sora_2(b).is_err()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2/cost.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2/cost.rs new file mode 100644 index 00000000..4a30ee82 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2/cost.rs @@ -0,0 +1,70 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::sora_2::request::{ + FalSora2Duration, FalSora2RequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalSora2CostState { + pub duration_seconds: u64, +} + +impl FalSora2CostState { + pub fn from_request(request: &FalSora2RequestState) -> Self { + Self { + duration_seconds: duration_seconds_for_cost(request.duration), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Sora 2: $0.10/second. Default duration (Fal client): 4s. + let cost_in_usd_cents = self.duration_seconds * 10; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +fn duration_seconds_for_cost(d: Option) -> u64 { + match d { + Some(FalSora2Duration::Four) | None => 4, + Some(FalSora2Duration::Eight) => 8, + Some(FalSora2Duration::Twelve) => 12, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option) -> u64 { + let b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Sora2, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + #[test] + fn four_seconds_is_40() { assert_eq!(cost_cents(Some(4)), 40); } + + #[test] + fn eight_seconds_is_80() { assert_eq!(cost_cents(Some(8)), 80); } + + #[test] + fn twelve_seconds_is_120() { assert_eq!(cost_cents(Some(12)), 120); } + + #[test] + fn default_duration_is_4s_priced_at_40() { assert_eq!(cost_cents(None), 40); } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2/mod.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2/request.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2/request.rs new file mode 100644 index 00000000..3c59ea99 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2/request.rs @@ -0,0 +1,158 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_sora_2_image_to_video_webhook::{ + enqueue_sora_2_image_to_video_webhook, EnqueueSora2ImageToVideoArgs, + EnqueueSora2ImageToVideoAspectRatio, EnqueueSora2ImageToVideoDurationSeconds, + EnqueueSora2ImageToVideoRequest, EnqueueSora2ImageToVideoResolution, +}; +use fal_client::requests_old::webhook::video::text::enqueue_sora_2_text_to_video_webhook::{ + enqueue_sora_2_text_to_video_webhook, EnqueueSora2TextToVideoArgs, + EnqueueSora2TextToVideoAspectRatio, EnqueueSora2TextToVideoDurationSeconds, + EnqueueSora2TextToVideoRequest, EnqueueSora2TextToVideoResolution, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +/// Router-level aspect ratio retained so the cost calculator and request +/// builder both see the same source of truth — fal_client's text-to-video +/// types do not represent `Auto`, so we must preserve it here. +#[derive(Debug, Clone, Copy)] +pub enum FalSora2AspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +/// Sora 2 supports 720p (and `auto` on image-to-video). +#[derive(Debug, Clone, Copy)] +pub enum FalSora2Resolution { + Auto, + SevenTwentyP, +} + +#[derive(Debug, Clone, Copy)] +pub enum FalSora2Duration { + Four, + Eight, + Twelve, +} + +#[derive(Debug, Clone)] +pub enum FalSora2Mode { + TextToVideo, + ImageToVideo { image_url: String }, +} + +#[derive(Debug, Clone)] +pub struct FalSora2RequestState { + pub prompt: String, + pub mode: FalSora2Mode, + pub aspect_ratio: Option, + pub resolution: Option, + pub duration: Option, +} + +impl FalSora2RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound_request): (_, Arc) = match &self.mode { + FalSora2Mode::TextToVideo => { + // Text-to-video does not support Auto aspect ratio or Auto resolution. + let request = EnqueueSora2TextToVideoRequest { + prompt: self.prompt.clone(), + resolution: self.resolution.and_then(to_t2v_resolution), + duration: self.duration.map(to_t2v_duration), + aspect_ratio: self.aspect_ratio.and_then(to_t2v_aspect_ratio), + }; + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueSora2TextToVideoArgs { + request, + webhook_url, + api_key: &client.api_key, + }; + (enqueue_sora_2_text_to_video_webhook(args).await, outbound) + } + FalSora2Mode::ImageToVideo { image_url } => { + let request = EnqueueSora2ImageToVideoRequest { + prompt: self.prompt.clone(), + image_url: image_url.clone(), + duration: self.duration.map(to_i2v_duration), + resolution: self.resolution.map(to_i2v_resolution), + aspect_ratio: self.aspect_ratio.map(to_i2v_aspect_ratio), + }; + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueSora2ImageToVideoArgs { + request, + webhook_url, + api_key: &client.api_key, + }; + (enqueue_sora_2_image_to_video_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} + +fn to_t2v_duration(d: FalSora2Duration) -> EnqueueSora2TextToVideoDurationSeconds { + match d { + FalSora2Duration::Four => EnqueueSora2TextToVideoDurationSeconds::Four, + FalSora2Duration::Eight => EnqueueSora2TextToVideoDurationSeconds::Eight, + FalSora2Duration::Twelve => EnqueueSora2TextToVideoDurationSeconds::Twelve, + } +} + +fn to_t2v_resolution(r: FalSora2Resolution) -> Option { + match r { + FalSora2Resolution::SevenTwentyP => Some(EnqueueSora2TextToVideoResolution::SevenTwentyP), + FalSora2Resolution::Auto => None, + } +} + +fn to_t2v_aspect_ratio(a: FalSora2AspectRatio) -> Option { + match a { + FalSora2AspectRatio::SixteenByNine => Some(EnqueueSora2TextToVideoAspectRatio::SixteenByNine), + FalSora2AspectRatio::NineBySixteen => Some(EnqueueSora2TextToVideoAspectRatio::NineBySixteen), + FalSora2AspectRatio::Auto => None, + } +} + +fn to_i2v_duration(d: FalSora2Duration) -> EnqueueSora2ImageToVideoDurationSeconds { + match d { + FalSora2Duration::Four => EnqueueSora2ImageToVideoDurationSeconds::Four, + FalSora2Duration::Eight => EnqueueSora2ImageToVideoDurationSeconds::Eight, + FalSora2Duration::Twelve => EnqueueSora2ImageToVideoDurationSeconds::Twelve, + } +} + +fn to_i2v_resolution(r: FalSora2Resolution) -> EnqueueSora2ImageToVideoResolution { + match r { + FalSora2Resolution::SevenTwentyP => EnqueueSora2ImageToVideoResolution::SevenTwentyP, + FalSora2Resolution::Auto => EnqueueSora2ImageToVideoResolution::Auto, + } +} + +fn to_i2v_aspect_ratio(a: FalSora2AspectRatio) -> EnqueueSora2ImageToVideoAspectRatio { + match a { + FalSora2AspectRatio::SixteenByNine => EnqueueSora2ImageToVideoAspectRatio::SixteenByNine, + FalSora2AspectRatio::NineBySixteen => EnqueueSora2ImageToVideoAspectRatio::NineBySixteen, + FalSora2AspectRatio::Auto => EnqueueSora2ImageToVideoAspectRatio::Auto, + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/build.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/build.rs new file mode 100644 index 00000000..50fe89ec --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/build.rs @@ -0,0 +1,167 @@ +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::sora_2_pro::request::{ + FalSora2ProAspectRatio, FalSora2ProDuration, FalSora2ProMode, FalSora2ProRequestState, + FalSora2ProResolution, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_fal_sora_2_pro( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + if builder.end_frame.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Sora 2 Pro does not support an ending frame".to_string(), + })); + } + + let mode = match optional_url(builder.start_frame.clone())? { + None => FalSora2ProMode::TextToVideo, + Some(image_url) => FalSora2ProMode::ImageToVideo { image_url }, + }; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSora2Pro( + FalSora2ProRequestState { + prompt: builder.prompt.clone().unwrap_or_default(), + mode, + aspect_ratio, + resolution, + duration, + }, + ))) +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use FalSora2ProAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use FalSora2ProResolution as R; + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(R::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(R::TenEightyP)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(R::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(R::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use FalSora2ProDuration as D; + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(D::Four)), + Some(8) => Ok(Some(D::Eight)), + Some(12) => Ok(Some(D::Twelve)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(D::Twelve)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(D::Four)), + }, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + + use super::*; + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Sora2Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + #[test] + fn no_start_frame_picks_t2v() { + let r = build_fal_sora_2_pro(base_builder()).expect("build"); + if let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSora2Pro(s)) = r { + assert!(matches!(s.mode, FalSora2ProMode::TextToVideo)); + } else { panic!("expected FalSora2Pro"); } + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let r = build_fal_sora_2_pro(b).expect("build"); + if let VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalSora2Pro(s)) = r { + assert!(matches!(s.mode, FalSora2ProMode::ImageToVideo { .. })); + } else { panic!("expected FalSora2Pro"); } + } + + #[test] + fn end_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_sora_2_pro(b).is_err()); + } + + #[test] + fn resolution_1080p_supported() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::TenEightyP); + assert!(build_fal_sora_2_pro(b).is_ok()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/cost.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/cost.rs new file mode 100644 index 00000000..29305089 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/cost.rs @@ -0,0 +1,133 @@ +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::sora_2_pro::request::{ + FalSora2ProDuration, FalSora2ProMode, FalSora2ProRequestState, FalSora2ProResolution, +}; + +#[derive(Clone, Debug)] +pub struct FalSora2ProCostState { + pub duration_seconds: u64, + pub is_ten_eighty_p: bool, +} + +impl FalSora2ProCostState { + pub fn from_request(request: &FalSora2ProRequestState) -> Self { + Self { + duration_seconds: duration_seconds_for_cost(request.duration), + is_ten_eighty_p: is_ten_eighty_p_for_cost(&request.mode, request.resolution), + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // Sora 2 Pro: $0.30/second @ 720p, $0.50/second @ 1080p. + let per_second_cents: u64 = if self.is_ten_eighty_p { 50 } else { 30 }; + let cost_in_usd_cents = per_second_cents * self.duration_seconds; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_usd_cents), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +/// Fal client default: 4s when no duration is supplied. +fn duration_seconds_for_cost(d: Option) -> u64 { + match d { + Some(FalSora2ProDuration::Four) | None => 4, + Some(FalSora2ProDuration::Eight) => 8, + Some(FalSora2ProDuration::Twelve) => 12, + } +} + +/// Fal client default varies by mode: text-to-video defaults to 1080p; image-to-video +/// defaults to auto (priced as 720p). +fn is_ten_eighty_p_for_cost(mode: &FalSora2ProMode, resolution: Option) -> bool { + match resolution { + Some(FalSora2ProResolution::TenEightyP) => true, + Some(FalSora2ProResolution::SevenTwentyP) | Some(FalSora2ProResolution::Auto) => false, + None => matches!(mode, FalSora2ProMode::TextToVideo), + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + fn cost_cents(duration_seconds: Option, resolution: Option, has_start: bool) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Sora2Pro, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + }; + if has_start { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + b.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + } + + mod numeric_literal_pricing { + use super::*; + + #[test] + fn p720_4s_is_120() { + // $0.30/sec × 4s = 120¢. + assert_eq!(cost_cents(Some(4), Some(RouterResolution::SevenTwentyP), false), 120); + } + + #[test] + fn p720_8s_is_240() { assert_eq!(cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), false), 240); } + + #[test] + fn p720_12s_is_360() { assert_eq!(cost_cents(Some(12), Some(RouterResolution::SevenTwentyP), false), 360); } + + #[test] + fn p1080_4s_is_200() { + // $0.50/sec × 4s = 200¢. + assert_eq!(cost_cents(Some(4), Some(RouterResolution::TenEightyP), false), 200); + } + + #[test] + fn p1080_8s_is_400() { assert_eq!(cost_cents(Some(8), Some(RouterResolution::TenEightyP), false), 400); } + + #[test] + fn p1080_12s_is_600() { assert_eq!(cost_cents(Some(12), Some(RouterResolution::TenEightyP), false), 600); } + + #[test] + fn t2v_default_resolution_priced_as_1080p() { + // T2V with no resolution → fal client defaults to 1080p, so cost = 200¢. + assert_eq!(cost_cents(Some(4), None, false), 200); + } + + #[test] + fn i2v_default_resolution_priced_as_720p() { + // I2V with no resolution → fal client defaults to auto (720p), so cost = 120¢. + assert_eq!(cost_cents(Some(4), None, true), 120); + } + } + + #[test] + fn higher_resolution_costs_more() { + assert!( + cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), false) + < cost_cents(Some(8), Some(RouterResolution::TenEightyP), false) + ); + } + + #[test] + fn longer_duration_costs_more() { + let r = Some(RouterResolution::TenEightyP); + assert!(cost_cents(Some(4), r, false) < cost_cents(Some(8), r, false)); + assert!(cost_cents(Some(8), r, false) < cost_cents(Some(12), r, false)); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/mod.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/request.rs b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/request.rs new file mode 100644 index 00000000..4f1ecacd --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/sora_2_pro/request.rs @@ -0,0 +1,157 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests_old::webhook::video::image::enqueue_sora_2_pro_image_to_video_webhook::{ + enqueue_sora_2_pro_image_to_video_webhook, EnqueueSora2ProImageToVideoArgs, + EnqueueSora2ProImageToVideoAspectRatio, EnqueueSora2ProImageToVideoDurationSeconds, + EnqueueSora2ProImageToVideoRequest, EnqueueSora2ProImageToVideoResolution, +}; +use fal_client::requests_old::webhook::video::text::enqueue_sora_2_pro_text_to_video_webhook::{ + enqueue_sora_2_pro_text_to_video_webhook, EnqueueSora2ProTextToVideoArgs, + EnqueueSora2ProTextToVideoAspectRatio, EnqueueSora2ProTextToVideoDurationSeconds, + EnqueueSora2ProTextToVideoRequest, EnqueueSora2ProTextToVideoResolution, +}; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Debug, Clone, Copy)] +pub enum FalSora2ProAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub enum FalSora2ProResolution { + Auto, + SevenTwentyP, + TenEightyP, +} + +#[derive(Debug, Clone, Copy)] +pub enum FalSora2ProDuration { + Four, + Eight, + Twelve, +} + +#[derive(Debug, Clone)] +pub enum FalSora2ProMode { + TextToVideo, + ImageToVideo { image_url: String }, +} + +#[derive(Debug, Clone)] +pub struct FalSora2ProRequestState { + pub prompt: String, + pub mode: FalSora2ProMode, + pub aspect_ratio: Option, + pub resolution: Option, + pub duration: Option, +} + +impl FalSora2ProRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + let webhook_url = client.webhook_url.as_deref() + .ok_or(ArtcraftRouterError::Client(ClientError::WebhookUrlRequired))?; + let (webhook_response, outbound_request): (_, Arc) = match &self.mode { + FalSora2ProMode::TextToVideo => { + // Text-to-video does not support Auto aspect ratio or Auto resolution. + let request = EnqueueSora2ProTextToVideoRequest { + prompt: self.prompt.clone(), + resolution: self.resolution.and_then(to_t2v_resolution), + duration: self.duration.map(to_t2v_duration), + aspect_ratio: self.aspect_ratio.and_then(to_t2v_aspect_ratio), + }; + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueSora2ProTextToVideoArgs { + request, + webhook_url, + api_key: &client.api_key, + }; + (enqueue_sora_2_pro_text_to_video_webhook(args).await, outbound) + } + FalSora2ProMode::ImageToVideo { image_url } => { + let request = EnqueueSora2ProImageToVideoRequest { + prompt: self.prompt.clone(), + image_url: image_url.clone(), + duration: self.duration.map(to_i2v_duration), + resolution: self.resolution.map(to_i2v_resolution), + aspect_ratio: self.aspect_ratio.map(to_i2v_aspect_ratio), + }; + let outbound: Arc = Arc::new(request.clone()); + let args = EnqueueSora2ProImageToVideoArgs { + request, + webhook_url, + api_key: &client.api_key, + }; + (enqueue_sora_2_pro_image_to_video_webhook(args).await, outbound) + } + }; + + let webhook_response = webhook_response + .map_err(|e| ArtcraftRouterError::Provider(ProviderError::Fal(e)))?; + + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: webhook_response.request_id, + gateway_request_id: webhook_response.gateway_request_id, + maybe_status_url: None, + maybe_response_url: None, + maybe_outbound_request: Some(outbound_request), + })) + } +} + +fn to_t2v_duration(d: FalSora2ProDuration) -> EnqueueSora2ProTextToVideoDurationSeconds { + match d { + FalSora2ProDuration::Four => EnqueueSora2ProTextToVideoDurationSeconds::Four, + FalSora2ProDuration::Eight => EnqueueSora2ProTextToVideoDurationSeconds::Eight, + FalSora2ProDuration::Twelve => EnqueueSora2ProTextToVideoDurationSeconds::Twelve, + } +} + +fn to_t2v_resolution(r: FalSora2ProResolution) -> Option { + match r { + FalSora2ProResolution::SevenTwentyP => Some(EnqueueSora2ProTextToVideoResolution::SevenTwentyP), + FalSora2ProResolution::TenEightyP => Some(EnqueueSora2ProTextToVideoResolution::TenEightyP), + FalSora2ProResolution::Auto => None, + } +} + +fn to_t2v_aspect_ratio(a: FalSora2ProAspectRatio) -> Option { + match a { + FalSora2ProAspectRatio::SixteenByNine => Some(EnqueueSora2ProTextToVideoAspectRatio::SixteenByNine), + FalSora2ProAspectRatio::NineBySixteen => Some(EnqueueSora2ProTextToVideoAspectRatio::NineBySixteen), + FalSora2ProAspectRatio::Auto => None, + } +} + +fn to_i2v_duration(d: FalSora2ProDuration) -> EnqueueSora2ProImageToVideoDurationSeconds { + match d { + FalSora2ProDuration::Four => EnqueueSora2ProImageToVideoDurationSeconds::Four, + FalSora2ProDuration::Eight => EnqueueSora2ProImageToVideoDurationSeconds::Eight, + FalSora2ProDuration::Twelve => EnqueueSora2ProImageToVideoDurationSeconds::Twelve, + } +} + +fn to_i2v_resolution(r: FalSora2ProResolution) -> EnqueueSora2ProImageToVideoResolution { + match r { + FalSora2ProResolution::Auto => EnqueueSora2ProImageToVideoResolution::Auto, + FalSora2ProResolution::SevenTwentyP => EnqueueSora2ProImageToVideoResolution::SevenTwentyP, + FalSora2ProResolution::TenEightyP => EnqueueSora2ProImageToVideoResolution::TenEightyP, + } +} + +fn to_i2v_aspect_ratio(a: FalSora2ProAspectRatio) -> EnqueueSora2ProImageToVideoAspectRatio { + match a { + FalSora2ProAspectRatio::Auto => EnqueueSora2ProImageToVideoAspectRatio::Auto, + FalSora2ProAspectRatio::SixteenByNine => EnqueueSora2ProImageToVideoAspectRatio::SixteenByNine, + FalSora2ProAspectRatio::NineBySixteen => EnqueueSora2ProImageToVideoAspectRatio::NineBySixteen, + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_2/build.rs b/crates/router/src/generate/generate_video/providers/fal/veo_2/build.rs new file mode 100644 index 00000000..9e3a2d39 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_2/build.rs @@ -0,0 +1,338 @@ +use fal_client::requests::api::video::image::veo_2::api::{ + Veo2ImageToVideoDuration, Veo2ImageToVideoRequest, +}; +use fal_client::requests::api::video::text::veo_2::api::{ + Veo2TextToVideoAspectRatio, Veo2TextToVideoDuration, Veo2TextToVideoRequest, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::veo_2::request::{FalVeo2Mode, FalVeo2RequestState}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Router-level duration plan shared by both modes — each mode maps it onto +/// its own fal duration enum. +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Five, + Six, + Seven, + Eight, +} + +pub fn build_fal_veo_2( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_veo_2_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo2(state))) +} + +pub(crate) fn build_fal_veo_2_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + if builder.end_frame.is_some() { + return Err(unsupported("end_frame", "Veo 2 does not support an ending frame")); + } + + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let duration = plan_duration(builder.duration_seconds, strategy)?; + + let mode = match builder.start_frame.clone() { + Some(ImageRef::Url(url)) => FalVeo2Mode::ImageToVideo(Veo2ImageToVideoRequest { + prompt, + image_url: url, + duration: duration.map(to_i2v_duration), + }), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + None => { + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + FalVeo2Mode::TextToVideo(Veo2TextToVideoRequest { + prompt, + aspect_ratio, + duration: duration.map(to_t2v_duration), + negative_prompt, + enhance_prompt: None, + seed: None, + auto_fix: None, + }) + } + }; + + Ok(FalVeo2RequestState { mode }) +} + +/// `None` lets fal pick its default (16:9); the old endpoint's explicit "auto" +/// no longer exists in the new API, so Auto maps to unset. +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo2TextToVideoAspectRatio as Ar; + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(None), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(unsupported_ar) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", unsupported_ar))) + } + _ => Ok(None), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(5) => Ok(Some(PlanDuration::Five)), + Some(6) => Ok(Some(PlanDuration::Six)), + Some(7) => Ok(Some(PlanDuration::Seven)), + Some(8) => Ok(Some(PlanDuration::Eight)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanDuration::Eight)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanDuration::Five)), + }, + } +} + +fn unsupported(field: &'static str, value: &str) -> ArtcraftRouterError { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: value.to_string(), + }) +} + +fn to_t2v_duration(d: PlanDuration) -> Veo2TextToVideoDuration { + match d { + PlanDuration::Five => Veo2TextToVideoDuration::FiveSeconds, + PlanDuration::Six => Veo2TextToVideoDuration::SixSeconds, + PlanDuration::Seven => Veo2TextToVideoDuration::SevenSeconds, + PlanDuration::Eight => Veo2TextToVideoDuration::EightSeconds, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Veo2ImageToVideoDuration { + match d { + PlanDuration::Five => Veo2ImageToVideoDuration::FiveSeconds, + PlanDuration::Six => Veo2ImageToVideoDuration::SixSeconds, + PlanDuration::Seven => Veo2ImageToVideoDuration::SevenSeconds, + PlanDuration::Eight => Veo2ImageToVideoDuration::EightSeconds, + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + mod mode_selection { + use super::*; + + #[test] + fn no_start_frame_picks_t2v() { + let _ = t2v_request(base_builder()); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + let _ = i2v_request(b); + } + + #[test] + fn end_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_veo_2_state(b).is_err()); + } + + #[test] + fn media_file_token_for_start_frame_errors() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + assert!(build_fal_veo_2_state(b).is_err()); + } + } + + mod materialized_fields { + use super::*; + + #[test] + fn t2v_prompt_passed_through() { + let mut b = base_builder(); + b.prompt = Some("hello".to_string()); + assert_eq!(t2v_request(b).prompt, "hello"); + } + + #[test] + fn t2v_negative_prompt_passed_through() { + let mut b = base_builder(); + b.negative_prompt = Some("no rain".to_string()); + assert_eq!(t2v_request(b).negative_prompt.as_deref(), Some("no rain")); + } + + #[test] + fn i2v_image_url_passed_through() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + assert_eq!(i2v_request(b).image_url, "https://example.com/start.png"); + } + } + + mod duration_conversions { + use super::*; + + #[test] + fn duration_none_is_unset() { + // fal defaults to 5s when unset. + assert!(t2v_request(base_builder()).duration.is_none()); + } + + #[test] + fn duration_5_through_8() { + for (seconds, expected) in [ + (5, Veo2TextToVideoDuration::FiveSeconds), + (6, Veo2TextToVideoDuration::SixSeconds), + (7, Veo2TextToVideoDuration::SevenSeconds), + (8, Veo2TextToVideoDuration::EightSeconds), + ] { + let mut b = base_builder(); + b.duration_seconds = Some(seconds); + assert_eq!(t2v_request(b).duration, Some(expected)); + } + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(10); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_2_state(b).is_err()); + } + + #[test] + fn unsupported_duration_upgrades_with_pay_more() { + let mut b = base_builder(); + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + assert_eq!(t2v_request(b).duration, Some(Veo2TextToVideoDuration::EightSeconds)); + } + + #[test] + fn unsupported_duration_downgrades_with_pay_less() { + let mut b = base_builder(); + b.duration_seconds = Some(2); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(t2v_request(b).duration, Some(Veo2TextToVideoDuration::FiveSeconds)); + } + } + + mod aspect_ratio_conversions { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + + #[test] + fn t2v_auto_is_unset() { + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + assert!(t2v_request(b).aspect_ratio.is_none()); + } + + #[test] + fn t2v_sixteen_nine() { + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + assert_eq!(t2v_request(b).aspect_ratio, Some(Veo2TextToVideoAspectRatio::SixteenByNine)); + } + + #[test] + fn t2v_unsupported_aspect_ratio_falls_back_with_pay_more() { + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Square); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + assert!(t2v_request(b).aspect_ratio.is_none()); + } + + #[test] + fn t2v_unsupported_aspect_ratio_errors_with_error_out() { + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Square); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_2_state(b).is_err()); + } + } + + #[test] + fn full_combinatorial_pass() { + use crate::api::router_aspect_ratio::RouterAspectRatio; + let aspect_ratios = [None, Some(RouterAspectRatio::Auto), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen)]; + let durations = [None, Some(5u16), Some(6), Some(7), Some(8)]; + + let mut combos = 0; + for &aspect_ratio in &aspect_ratios { + for &duration in &durations { + for has_start_frame in [false, true] { + let mut b = base_builder(); + b.aspect_ratio = aspect_ratio; + b.duration_seconds = duration; + if has_start_frame { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + assert!(build_fal_veo_2_state(b).is_ok()); + combos += 1; + } + } + } + assert_eq!(combos, 4 * 5 * 2); + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo2, + provider: RouterProvider::Fal, + prompt: Some("a corgi running".to_string()), + ..Default::default() + } + } + + fn t2v_request(b: GenerateVideoRequestBuilder) -> Veo2TextToVideoRequest { + match build_fal_veo_2_state(b).expect("build_fal_veo_2_state").mode { + FalVeo2Mode::TextToVideo(r) => r, + FalVeo2Mode::ImageToVideo(_) => panic!("expected TextToVideo"), + } + } + + fn i2v_request(b: GenerateVideoRequestBuilder) -> Veo2ImageToVideoRequest { + match build_fal_veo_2_state(b).expect("build_fal_veo_2_state").mode { + FalVeo2Mode::ImageToVideo(r) => r, + FalVeo2Mode::TextToVideo(_) => panic!("expected ImageToVideo"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_2/cost.rs b/crates/router/src/generate/generate_video/providers/fal/veo_2/cost.rs new file mode 100644 index 00000000..9bc56eb6 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_2/cost.rs @@ -0,0 +1,109 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::veo_2::request::{FalVeo2Mode, FalVeo2RequestState}; + +#[derive(Clone, Debug)] +pub struct FalVeo2CostState { + pub cost_in_usd_cents: u64, +} + +impl FalVeo2CostState { + pub fn from_request(request: &FalVeo2RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalVeo2Mode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalVeo2Mode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_2::build::build_fal_veo_2_state; + + use super::*; + + // Pricing (fal): 5s = $2.50, +$0.50 per additional second. Flat across + // modalities; no audio or resolution knobs. + + mod numeric_literal_pricing { + use super::*; + + #[test] + fn default_duration_is_5s_priced_at_250() { + // 5s = $2.50 baseline. + assert_eq!(cost_cents(None, false), 250); + } + + #[test] + fn five_seconds_is_250() { + assert_eq!(cost_cents(Some(5), false), 250); + } + + #[test] + fn six_seconds_is_300() { + // +$0.50 per second past 5s. + assert_eq!(cost_cents(Some(6), false), 300); + } + + #[test] + fn seven_seconds_is_350() { + assert_eq!(cost_cents(Some(7), false), 350); + } + + #[test] + fn eight_seconds_is_400() { + assert_eq!(cost_cents(Some(8), false), 400); + } + + #[test] + fn i2v_matches_t2v() { + assert_eq!(cost_cents(Some(7), false), cost_cents(Some(7), true)); + } + } + + #[test] + fn longer_duration_costs_more() { + assert!(cost_cents(Some(5), false) < cost_cents(Some(6), false)); + assert!(cost_cents(Some(6), false) < cost_cents(Some(7), false)); + assert!(cost_cents(Some(7), false) < cost_cents(Some(8), false)); + } + + fn cost_cents(duration_seconds: Option, has_start_frame: bool) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo2, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + ..Default::default() + }; + if has_start_frame { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + let state = build_fal_veo_2_state(b).expect("build_fal_veo_2_state"); + FalVeo2CostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost_in_usd_cents") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_2/mod.rs b/crates/router/src/generate/generate_video/providers/fal/veo_2/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_2/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_2/request.rs b/crates/router/src/generate/generate_video/providers/fal/veo_2/request.rs new file mode 100644 index 00000000..268eb1ce --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_2/request.rs @@ -0,0 +1,135 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::veo_2::api::Veo2ImageToVideoRequest; +use fal_client::requests::api::video::text::veo_2::api::Veo2TextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalVeo2Mode { + TextToVideo(Veo2TextToVideoRequest), + ImageToVideo(Veo2ImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalVeo2RequestState { + pub mode: FalVeo2Mode, +} + +impl FalVeo2RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalVeo2Mode::TextToVideo(request) => send_request(request, client).await, + FalVeo2Mode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::veo_2::api::Veo2ImageToVideoDuration; + use fal_client::requests::api::video::text::veo_2::api::{ + Veo2TextToVideoAspectRatio, Veo2TextToVideoDuration, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_text_to_video_5s() { + let state = FalVeo2RequestState { + mode: FalVeo2Mode::TextToVideo(Veo2TextToVideoRequest { + prompt: "a peaceful lake at dawn".to_string(), + aspect_ratio: Some(Veo2TextToVideoAspectRatio::SixteenByNine), + duration: Some(Veo2TextToVideoDuration::FiveSeconds), + negative_prompt: None, + enhance_prompt: None, + seed: None, + auto_fix: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_image_to_video_7s() { + let state = FalVeo2RequestState { + mode: FalVeo2Mode::ImageToVideo(Veo2ImageToVideoRequest { + prompt: "the dog leaps into the lake and splashes around.".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + duration: Some(Veo2ImageToVideoDuration::SevenSeconds), + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3/build.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3/build.rs new file mode 100644 index 00000000..5073db33 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3/build.rs @@ -0,0 +1,373 @@ +use fal_client::requests::api::video::image::veo_3::api::{ + Veo3ImageToVideoAspectRatio, Veo3ImageToVideoDuration, Veo3ImageToVideoRequest, + Veo3ImageToVideoResolution, +}; +use fal_client::requests::api::video::text::veo_3::api::{ + Veo3TextToVideoAspectRatio, Veo3TextToVideoDuration, Veo3TextToVideoRequest, + Veo3TextToVideoResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::veo_3::request::{FalVeo3Mode, FalVeo3RequestState}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Router-level resolution shared between both modes — each mode maps it onto +/// its own fal resolution enum. +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +pub fn build_fal_veo_3( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_veo_3_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3(state))) +} + +pub(crate) fn build_fal_veo_3_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + if builder.end_frame.is_some() { + return Err(unsupported("end_frame", "Veo 3 does not support an ending frame")); + } + + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + // fal's server default is audio-on; keep the explicit `true` the old + // endpoint sent so pricing stays deterministic. + let generate_audio = Some(builder.generate_audio.unwrap_or(true)); + + let mode = match builder.start_frame.clone() { + Some(ImageRef::Url(url)) => { + let i2v_aspect_ratio = plan_i2v_aspect_ratio(builder.aspect_ratio, strategy)?; + FalVeo3Mode::ImageToVideo(Veo3ImageToVideoRequest { + prompt, + image_url: url, + aspect_ratio: i2v_aspect_ratio, + duration: duration.map(to_i2v_duration), + resolution: resolution.map(to_i2v_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }) + } + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + None => { + let t2v_aspect_ratio = plan_t2v_aspect_ratio(builder.aspect_ratio, strategy)?; + FalVeo3Mode::TextToVideo(Veo3TextToVideoRequest { + prompt, + aspect_ratio: t2v_aspect_ratio, + duration: duration.map(to_t2v_duration), + resolution: resolution.map(to_t2v_resolution), + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }) + } + }; + + Ok(FalVeo3RequestState { mode }) +} + +/// Text-to-video: only 16:9 and 9:16 (no Auto, no Square). `None` lets fal +/// pick its default (16:9). +fn plan_t2v_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo3TextToVideoAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", other))) + } + _ => Ok(None), + }, + } +} + +/// Image-to-video: Auto, 16:9, 9:16 (no Square). +fn plan_i2v_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo3ImageToVideoAspectRatio as Ar; + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", other))) + } + _ => Ok(Some(Ar::Auto)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(PlanResolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(PlanResolution::TenEightyP)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", &format!("{:?}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanResolution::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanResolution::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(PlanDuration::FourSeconds)), + Some(6) => Ok(Some(PlanDuration::SixSeconds)), + Some(8) => Ok(Some(PlanDuration::EightSeconds)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanDuration::EightSeconds)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanDuration::FourSeconds)), + }, + } +} + +fn unsupported(field: &'static str, value: &str) -> ArtcraftRouterError { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: value.to_string(), + }) +} + +fn to_t2v_duration(d: PlanDuration) -> Veo3TextToVideoDuration { + match d { + PlanDuration::FourSeconds => Veo3TextToVideoDuration::FourSeconds, + PlanDuration::SixSeconds => Veo3TextToVideoDuration::SixSeconds, + PlanDuration::EightSeconds => Veo3TextToVideoDuration::EightSeconds, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Veo3ImageToVideoDuration { + match d { + PlanDuration::FourSeconds => Veo3ImageToVideoDuration::FourSeconds, + PlanDuration::SixSeconds => Veo3ImageToVideoDuration::SixSeconds, + PlanDuration::EightSeconds => Veo3ImageToVideoDuration::EightSeconds, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> Veo3TextToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3TextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3TextToVideoResolution::TenEightyP, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> Veo3ImageToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3ImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3ImageToVideoResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + mod mode_selection { + use super::*; + + #[test] + fn no_start_frame_picks_t2v() { let _ = t2v_request(base_t2v_builder()); } + + #[test] + fn start_frame_picks_i2v() { let _ = i2v_request(base_i2v_builder()); } + + #[test] + fn end_frame_errors() { + let mut b = base_t2v_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_veo_3_state(b).is_err()); + } + } + + mod resolution_conversions { + use super::*; + + #[test] + fn t2v_720p() { + let mut b = base_t2v_builder(); + b.resolution = Some(RouterResolution::SevenTwentyP); + assert_eq!(t2v_request(b).resolution, Some(Veo3TextToVideoResolution::SevenTwentyP)); + } + + #[test] + fn t2v_1080p() { + let mut b = base_t2v_builder(); + b.resolution = Some(RouterResolution::TenEightyP); + assert_eq!(t2v_request(b).resolution, Some(Veo3TextToVideoResolution::TenEightyP)); + } + + #[test] + fn t2v_unsupported_upgrades_with_pay_more() { + let mut b = base_t2v_builder(); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + assert_eq!(t2v_request(b).resolution, Some(Veo3TextToVideoResolution::TenEightyP)); + } + } + + mod duration_conversions { + use super::*; + + #[test] + fn t2v_4s_6s_8s() { + for (s, expected) in [ + (4, Veo3TextToVideoDuration::FourSeconds), + (6, Veo3TextToVideoDuration::SixSeconds), + (8, Veo3TextToVideoDuration::EightSeconds), + ] { + let mut b = base_t2v_builder(); + b.duration_seconds = Some(s); + assert_eq!(t2v_request(b).duration, Some(expected)); + } + } + } + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn t2v_sixteen_nine() { + let mut b = base_t2v_builder(); + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + assert_eq!(t2v_request(b).aspect_ratio, Some(Veo3TextToVideoAspectRatio::SixteenByNine)); + } + + #[test] + fn i2v_auto_when_unspecified() { + assert_eq!(i2v_request(base_i2v_builder()).aspect_ratio, Some(Veo3ImageToVideoAspectRatio::Auto)); + } + } + + mod audio_handling { + use super::*; + + #[test] + fn audio_defaults_to_true() { + assert_eq!(t2v_request(base_t2v_builder()).generate_audio, Some(true)); + } + + #[test] + fn audio_false_is_passed_through() { + let mut b = base_t2v_builder(); + b.generate_audio = Some(false); + assert_eq!(t2v_request(b).generate_audio, Some(false)); + } + } + + #[test] + fn full_combinatorial_pass() { + let resolutions = [None, Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP)]; + let durations = [None, Some(4u16), Some(6), Some(8)]; + let aspect_ratios = [None, Some(RouterAspectRatio::Auto), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen)]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &resolution in &resolutions { + for &duration in &durations { + for &aspect_ratio in &aspect_ratios { + for &generate_audio in &audios { + for has_start_frame in [false, true] { + let mut b = if has_start_frame { base_i2v_builder() } else { base_t2v_builder() }; + b.resolution = resolution; + b.duration_seconds = duration; + b.aspect_ratio = aspect_ratio; + b.generate_audio = generate_audio; + assert!(build_fal_veo_3_state(b).is_ok()); + combos += 1; + } + } + } + } + } + assert_eq!(combos, 3 * 4 * 4 * 3 * 2); + } + + fn base_t2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn base_i2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/a.png".to_string())), + ..base_t2v_builder() + } + } + + fn t2v_request(b: GenerateVideoRequestBuilder) -> Veo3TextToVideoRequest { + match build_fal_veo_3_state(b).expect("build_fal_veo_3_state").mode { + FalVeo3Mode::TextToVideo(r) => r, + FalVeo3Mode::ImageToVideo(_) => panic!("expected TextToVideo"), + } + } + + fn i2v_request(b: GenerateVideoRequestBuilder) -> Veo3ImageToVideoRequest { + match build_fal_veo_3_state(b).expect("build_fal_veo_3_state").mode { + FalVeo3Mode::ImageToVideo(r) => r, + FalVeo3Mode::TextToVideo(_) => panic!("expected ImageToVideo"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3/cost.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3/cost.rs new file mode 100644 index 00000000..b7870010 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3/cost.rs @@ -0,0 +1,114 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::veo_3::request::{FalVeo3Mode, FalVeo3RequestState}; + +#[derive(Clone, Debug)] +pub struct FalVeo3CostState { + pub cost_in_usd_cents: u64, +} + +impl FalVeo3CostState { + pub fn from_request(request: &FalVeo3RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalVeo3Mode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3Mode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_3::build::build_fal_veo_3_state; + + use super::*; + + // Pricing (fal): $0.20/sec audio off, $0.40/sec audio on. Flat across + // modalities; resolution (720p/1080p) does not change the price. + + mod numeric_literal_pricing { + use super::*; + + #[test] + fn audio_on_4s_is_160() { + // $0.40/sec audio on × 4s = 160¢. + assert_eq!(cost_cents(Some(4), Some(true), false), 160); + } + + #[test] + fn audio_on_6s_is_240() { assert_eq!(cost_cents(Some(6), Some(true), false), 240); } + + #[test] + fn audio_on_8s_is_320() { assert_eq!(cost_cents(Some(8), Some(true), false), 320); } + + #[test] + fn audio_off_4s_is_80() { + // $0.20/sec audio off × 4s = 80¢. + assert_eq!(cost_cents(Some(4), Some(false), false), 80); + } + + #[test] + fn audio_off_8s_is_160() { assert_eq!(cost_cents(Some(8), Some(false), false), 160); } + + #[test] + fn duration_default_is_8s() { + // No duration → fal default 8s. + assert_eq!(cost_cents(None, Some(true), false), 320); + } + + #[test] + fn audio_default_is_true() { + // None → defaults to audio=true via builder. + assert_eq!(cost_cents(Some(6), None, false), 240); + } + + #[test] + fn i2v_matches_t2v() { + assert_eq!(cost_cents(Some(6), Some(true), false), cost_cents(Some(6), Some(true), true)); + } + } + + #[test] + fn audio_costs_more_than_no_audio() { + assert!(cost_cents(Some(8), Some(false), false) < cost_cents(Some(8), Some(true), false)); + } + + fn cost_cents(duration_seconds: Option, generate_audio: Option, has_start_frame: bool) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + if has_start_frame { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + let state = build_fal_veo_3_state(b).expect("build_fal_veo_3_state"); + FalVeo3CostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost_in_usd_cents") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3/mod.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3/request.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3/request.rs new file mode 100644 index 00000000..69930757 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3/request.rs @@ -0,0 +1,146 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::veo_3::api::Veo3ImageToVideoRequest; +use fal_client::requests::api::video::text::veo_3::api::Veo3TextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalVeo3Mode { + TextToVideo(Veo3TextToVideoRequest), + ImageToVideo(Veo3ImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalVeo3RequestState { + pub mode: FalVeo3Mode, +} + +impl FalVeo3RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalVeo3Mode::TextToVideo(request) => send_request(request, client).await, + FalVeo3Mode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::veo_3::api::{ + Veo3ImageToVideoDuration, Veo3ImageToVideoResolution, + }; + use fal_client::requests::api::video::text::veo_3::api::{ + Veo3TextToVideoDuration, Veo3TextToVideoResolution, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_text_to_video_720p_4s_audio_on() { + let state = FalVeo3RequestState { + mode: FalVeo3Mode::TextToVideo(Veo3TextToVideoRequest { + prompt: "a serene mountain landscape".to_string(), + aspect_ratio: None, + duration: Some(Veo3TextToVideoDuration::FourSeconds), + resolution: Some(Veo3TextToVideoResolution::SevenTwentyP), + negative_prompt: None, + generate_audio: Some(true), + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_image_to_video_1080p_8s_no_audio() { + let state = FalVeo3RequestState { + mode: FalVeo3Mode::ImageToVideo(Veo3ImageToVideoRequest { + prompt: "the dog leaps into the lake.".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3ImageToVideoDuration::EightSeconds), + resolution: Some(Veo3ImageToVideoResolution::TenEightyP), + generate_audio: Some(false), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/build.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/build.rs new file mode 100644 index 00000000..a8bda52b --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/build.rs @@ -0,0 +1,342 @@ +use fal_client::requests::api::video::image::veo_3_fast::api::{ + Veo3FastImageToVideoAspectRatio, Veo3FastImageToVideoDuration, Veo3FastImageToVideoRequest, + Veo3FastImageToVideoResolution, +}; +use fal_client::requests::api::video::text::veo_3_fast::api::{ + Veo3FastTextToVideoAspectRatio, Veo3FastTextToVideoDuration, Veo3FastTextToVideoRequest, + Veo3FastTextToVideoResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_ref::ImageRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::veo_3_fast::request::{ + FalVeo3FastMode, FalVeo3FastRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Router-level resolution shared between both modes — each mode maps it onto +/// its own fal resolution enum. +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + FourSeconds, + SixSeconds, + EightSeconds, +} + +pub fn build_fal_veo_3_fast( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_veo_3_fast_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3Fast(state))) +} + +pub(crate) fn build_fal_veo_3_fast_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + if builder.end_frame.is_some() { + return Err(unsupported("end_frame", "Veo 3 Fast does not support an ending frame")); + } + + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + // fal's server default is audio-on; keep the explicit `true` the old + // endpoint sent so pricing stays deterministic. + let generate_audio = Some(builder.generate_audio.unwrap_or(true)); + + let mode = match builder.start_frame.clone() { + Some(ImageRef::Url(url)) => { + let i2v_aspect_ratio = plan_i2v_aspect_ratio(builder.aspect_ratio, strategy)?; + FalVeo3FastMode::ImageToVideo(Veo3FastImageToVideoRequest { + prompt, + image_url: url, + aspect_ratio: i2v_aspect_ratio, + duration: duration.map(to_i2v_duration), + resolution: resolution.map(to_i2v_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }) + } + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)); + } + None => { + let t2v_aspect_ratio = plan_t2v_aspect_ratio(builder.aspect_ratio, strategy)?; + FalVeo3FastMode::TextToVideo(Veo3FastTextToVideoRequest { + prompt, + aspect_ratio: t2v_aspect_ratio, + duration: duration.map(to_t2v_duration), + resolution: resolution.map(to_t2v_resolution), + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }) + } + }; + + Ok(FalVeo3FastRequestState { mode }) +} + +/// Text-to-video: only 16:9 and 9:16 (no Auto, no Square). `None` lets fal +/// pick its default (16:9). +fn plan_t2v_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo3FastTextToVideoAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", other))) + } + _ => Ok(None), + }, + } +} + +/// Image-to-video: Auto, 16:9, 9:16 (no Square). +fn plan_i2v_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo3FastImageToVideoAspectRatio as Ar; + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(unsupported_ar) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", unsupported_ar))) + } + _ => Ok(Some(Ar::Auto)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(PlanResolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(PlanResolution::TenEightyP)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", &format!("{:?}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanResolution::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanResolution::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(PlanDuration::FourSeconds)), + Some(6) => Ok(Some(PlanDuration::SixSeconds)), + Some(8) => Ok(Some(PlanDuration::EightSeconds)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanDuration::EightSeconds)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanDuration::FourSeconds)), + }, + } +} + +fn unsupported(field: &'static str, value: &str) -> ArtcraftRouterError { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: value.to_string(), + }) +} + +fn to_t2v_duration(d: PlanDuration) -> Veo3FastTextToVideoDuration { + match d { + PlanDuration::FourSeconds => Veo3FastTextToVideoDuration::FourSeconds, + PlanDuration::SixSeconds => Veo3FastTextToVideoDuration::SixSeconds, + PlanDuration::EightSeconds => Veo3FastTextToVideoDuration::EightSeconds, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Veo3FastImageToVideoDuration { + match d { + PlanDuration::FourSeconds => Veo3FastImageToVideoDuration::FourSeconds, + PlanDuration::SixSeconds => Veo3FastImageToVideoDuration::SixSeconds, + PlanDuration::EightSeconds => Veo3FastImageToVideoDuration::EightSeconds, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> Veo3FastTextToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3FastTextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3FastTextToVideoResolution::TenEightyP, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> Veo3FastImageToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3FastImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3FastImageToVideoResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + + use super::*; + + mod mode_selection { + use super::*; + + #[test] + fn no_start_frame_picks_t2v() { + let _ = t2v_request(base_t2v_builder()); + } + + #[test] + fn start_frame_picks_i2v() { + let _ = i2v_request(base_i2v_builder()); + } + + #[test] + fn end_frame_errors() { + let mut b = base_i2v_builder(); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + assert!(build_fal_veo_3_fast_state(b).is_err()); + } + + #[test] + fn media_file_token_for_start_frame_errors() { + let mut b = base_t2v_builder(); + b.start_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))); + assert!(build_fal_veo_3_fast_state(b).is_err()); + } + } + + mod materialized_fields { + use super::*; + + #[test] + fn i2v_prompt_passed_through() { + let mut b = base_i2v_builder(); + b.prompt = Some("hello world".to_string()); + assert_eq!(i2v_request(b).prompt, "hello world"); + } + + #[test] + fn i2v_image_url_passed_through() { + assert_eq!(i2v_request(base_i2v_builder()).image_url, "https://example.com/a.png"); + } + + #[test] + fn audio_defaults_to_true() { + assert_eq!(i2v_request(base_i2v_builder()).generate_audio, Some(true)); + assert_eq!(t2v_request(base_t2v_builder()).generate_audio, Some(true)); + } + + #[test] + fn audio_false_passed_through() { + let mut b = base_i2v_builder(); + b.generate_audio = Some(false); + assert_eq!(i2v_request(b).generate_audio, Some(false)); + } + } + + #[test] + fn full_combinatorial_pass() { + let resolutions = [None, Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP)]; + let durations = [None, Some(4u16), Some(6), Some(8)]; + let aspect_ratios = [None, Some(RouterAspectRatio::Auto), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen)]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &resolution in &resolutions { + for &duration in &durations { + for &aspect_ratio in &aspect_ratios { + for &generate_audio in &audios { + for has_start_frame in [false, true] { + let mut b = if has_start_frame { base_i2v_builder() } else { base_t2v_builder() }; + b.resolution = resolution; + b.duration_seconds = duration; + b.aspect_ratio = aspect_ratio; + b.generate_audio = generate_audio; + assert!(build_fal_veo_3_fast_state(b).is_ok()); + combos += 1; + } + } + } + } + } + assert_eq!(combos, 3 * 4 * 4 * 3 * 2); + } + + fn base_t2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3Fast, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn base_i2v_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/a.png".to_string())), + ..base_t2v_builder() + } + } + + fn t2v_request(b: GenerateVideoRequestBuilder) -> Veo3FastTextToVideoRequest { + match build_fal_veo_3_fast_state(b).expect("build_fal_veo_3_fast_state").mode { + FalVeo3FastMode::TextToVideo(r) => r, + FalVeo3FastMode::ImageToVideo(_) => panic!("expected TextToVideo"), + } + } + + fn i2v_request(b: GenerateVideoRequestBuilder) -> Veo3FastImageToVideoRequest { + match build_fal_veo_3_fast_state(b).expect("build_fal_veo_3_fast_state").mode { + FalVeo3FastMode::ImageToVideo(r) => r, + FalVeo3FastMode::TextToVideo(_) => panic!("expected ImageToVideo"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/cost.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/cost.rs new file mode 100644 index 00000000..25512878 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/cost.rs @@ -0,0 +1,115 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::fal::veo_3_fast::request::{ + FalVeo3FastMode, FalVeo3FastRequestState, +}; + +#[derive(Clone, Debug)] +pub struct FalVeo3FastCostState { + pub cost_in_usd_cents: u64, +} + +impl FalVeo3FastCostState { + pub fn from_request(request: &FalVeo3FastRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalVeo3FastMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3FastMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_3_fast::build::build_fal_veo_3_fast_state; + + use super::*; + + // Pricing (fal): $0.10/sec audio off, $0.15/sec audio on. Flat across + // modalities; resolution (720p/1080p) does not change the price. + + mod numeric_literal_pricing { + use super::*; + + #[test] + fn audio_on_4s_is_60() { + // $0.15/sec × 4s = 60¢. + assert_eq!(cost_cents(Some(4), Some(true), true), 60); + } + + #[test] + fn audio_on_6s_is_90() { assert_eq!(cost_cents(Some(6), Some(true), true), 90); } + + #[test] + fn audio_on_8s_is_120() { assert_eq!(cost_cents(Some(8), Some(true), true), 120); } + + #[test] + fn audio_off_4s_is_40() { + // $0.10/sec × 4s = 40¢. + assert_eq!(cost_cents(Some(4), Some(false), true), 40); + } + + #[test] + fn audio_off_8s_is_80() { assert_eq!(cost_cents(Some(8), Some(false), true), 80); } + + #[test] + fn default_duration_is_8s() { + assert_eq!(cost_cents(None, Some(true), true), 120); + } + + #[test] + fn t2v_matches_i2v() { + assert_eq!(cost_cents(Some(6), Some(true), false), cost_cents(Some(6), Some(true), true)); + } + } + + #[test] + fn audio_costs_more_than_no_audio() { + assert!(cost_cents(Some(8), Some(false), true) < cost_cents(Some(8), Some(true), true)); + } + + #[test] + fn longer_duration_costs_more() { + assert!(cost_cents(Some(4), Some(true), true) < cost_cents(Some(6), Some(true), true)); + assert!(cost_cents(Some(6), Some(true), true) < cost_cents(Some(8), Some(true), true)); + } + + fn cost_cents(duration_seconds: Option, generate_audio: Option, has_start_frame: bool) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3Fast, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + generate_audio, + ..Default::default() + }; + if has_start_frame { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + let state = build_fal_veo_3_fast_state(b).expect("build_fal_veo_3_fast_state"); + FalVeo3FastCostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost_in_usd_cents") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/mod.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/request.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/request.rs new file mode 100644 index 00000000..980e5869 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3_fast/request.rs @@ -0,0 +1,123 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::veo_3_fast::api::Veo3FastImageToVideoRequest; +use fal_client::requests::api::video::text::veo_3_fast::api::Veo3FastTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalVeo3FastMode { + TextToVideo(Veo3FastTextToVideoRequest), + ImageToVideo(Veo3FastImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalVeo3FastRequestState { + pub mode: FalVeo3FastMode, +} + +impl FalVeo3FastRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalVeo3FastMode::TextToVideo(request) => send_request(request, client).await, + FalVeo3FastMode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::veo_3_fast::api::{ + Veo3FastImageToVideoDuration, Veo3FastImageToVideoResolution, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_image_to_video_720p_4s_audio() { + let state = FalVeo3FastRequestState { + mode: FalVeo3FastMode::ImageToVideo(Veo3FastImageToVideoRequest { + prompt: "the dog leaps into the lake.".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + aspect_ratio: None, + duration: Some(Veo3FastImageToVideoDuration::FourSeconds), + resolution: Some(Veo3FastImageToVideoResolution::SevenTwentyP), + generate_audio: Some(true), + negative_prompt: None, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + assert!(matches!(response, GenerateVideoResponse::Fal(_))); + } + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1/build.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/build.rs new file mode 100644 index 00000000..df74ee06 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/build.rs @@ -0,0 +1,874 @@ +use fal_client::requests::api::video::extend::veo_3p1::api::{ + Veo3p1ExtendVideoAspectRatio, Veo3p1ExtendVideoDuration, Veo3p1ExtendVideoRequest, + Veo3p1ExtendVideoResolution, +}; +use fal_client::requests::api::video::image::veo_3p1::api::{ + Veo3p1ImageToVideoAspectRatio, Veo3p1ImageToVideoDuration, Veo3p1ImageToVideoRequest, + Veo3p1ImageToVideoResolution, +}; +use fal_client::requests::api::video::images::veo_3p1::api::{ + Veo3p1FirstLastFrameToVideoAspectRatio, Veo3p1FirstLastFrameToVideoDuration, + Veo3p1FirstLastFrameToVideoRequest, Veo3p1FirstLastFrameToVideoResolution, +}; +use fal_client::requests::api::video::reference::veo_3p1::api::{ + Veo3p1ReferenceToVideoAspectRatio, Veo3p1ReferenceToVideoDuration, Veo3p1ReferenceToVideoRequest, + Veo3p1ReferenceToVideoResolution, +}; +use fal_client::requests::api::video::text::veo_3p1::api::{ + Veo3p1TextToVideoAspectRatio, Veo3p1TextToVideoDuration, Veo3p1TextToVideoRequest, + Veo3p1TextToVideoResolution, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::video_list_ref::VideoListRef; +use crate::api::video_ref::VideoRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::veo_3p1::request::{FalVeo3p1Mode, FalVeo3p1RequestState}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Four, + Six, + Eight, +} + +pub fn build_fal_veo_3p1( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_veo_3p1_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3p1(state))) +} + +pub(crate) fn build_fal_veo_3p1_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let start = optional_url(builder.start_frame.clone())?; + let end = optional_url(builder.end_frame.clone())?; + let reference_images = reference_image_urls(builder.reference_images.clone())?; + let reference_videos = reference_video_urls(builder.reference_videos.clone())?; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let generate_audio = builder.generate_audio; + + // Modality dispatch, most specific inputs first: + // 1. reference videos → extend-video + // 2. reference images → reference-to-video + // 3. start + end frames → first-last-frame-to-video + // 4. start frame only → image-to-video + // 5. no media → text-to-video + let mode = if let Some(video_urls) = reference_videos { + if reference_images.is_some() { + return Err(unsupported( + "reference_images", + "Veo 3.1 extend-video cannot combine reference_images with a reference video", + )); + } + if start.is_some() { + return Err(unsupported( + "start_frame", + "Veo 3.1 extend-video cannot combine start_frame with a reference video", + )); + } + if end.is_some() { + return Err(unsupported( + "end_frame", + "Veo 3.1 extend-video cannot combine end_frame with a reference video", + )); + } + if video_urls.len() != 1 { + return Err(unsupported( + "reference_videos", + &format!("Veo 3.1 extend-video requires exactly 1 reference video, got {}", video_urls.len()), + )); + } + let video_url = video_urls.into_iter().next().expect("checked len == 1"); + FalVeo3p1Mode::ExtendVideo(Veo3p1ExtendVideoRequest { + prompt, + video_url, + aspect_ratio: aspect_ratio.map(to_extend_aspect_ratio), + duration: plan_extend_duration(builder.duration_seconds, strategy)?, + resolution: resolution.map(|r| to_extend_resolution(r, strategy)).transpose()?, + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }) + } else if let Some(image_urls) = reference_images { + if start.is_some() { + return Err(unsupported( + "start_frame", + "Veo 3.1 reference-to-video cannot combine start_frame with reference_images", + )); + } + if end.is_some() { + return Err(unsupported( + "end_frame", + "Veo 3.1 reference-to-video cannot combine end_frame with reference_images", + )); + } + // NB: reference-to-video has no negative_prompt or seed fields on fal's + // schema — those builder inputs are dropped silently. + FalVeo3p1Mode::ReferenceToVideo(Veo3p1ReferenceToVideoRequest { + prompt, + image_urls, + aspect_ratio: aspect_ratio.and_then(to_reference_aspect_ratio), + duration: plan_duration(builder.duration_seconds, strategy)?.map(to_reference_duration), + resolution: resolution.map(to_reference_resolution), + generate_audio, + auto_fix: None, + safety_tolerance: None, + }) + } else { + let duration = plan_duration(builder.duration_seconds, strategy)?; + match (start, end) { + (None, None) => FalVeo3p1Mode::TextToVideo(Veo3p1TextToVideoRequest { + prompt, + aspect_ratio: aspect_ratio.and_then(to_t2v_aspect_ratio), + duration: duration.map(to_t2v_duration), + resolution: resolution.map(to_t2v_resolution), + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + (Some(image_url), None) => FalVeo3p1Mode::ImageToVideo(Veo3p1ImageToVideoRequest { + prompt, + image_url, + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + duration: duration.map(to_i2v_duration), + resolution: resolution.map(to_i2v_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + (Some(first_frame_url), Some(last_frame_url)) => FalVeo3p1Mode::FirstLastFrameToVideo( + Veo3p1FirstLastFrameToVideoRequest { + prompt, + first_frame_url, + last_frame_url, + aspect_ratio: aspect_ratio.map(to_flf_aspect_ratio), + duration: duration.map(to_flf_duration), + resolution: resolution.map(to_flf_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }, + ), + (None, Some(_)) => { + return Err(unsupported( + "end_frame", + "Veo 3.1 requires a start_frame when end_frame is provided", + )); + } + } + }; + + Ok(FalVeo3p1RequestState { mode }) +} + +fn optional_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + } +} + +fn reference_image_urls(refs: Option) -> Result>, ArtcraftRouterError> { + match refs { + None => Ok(None), + Some(ImageListRef::Urls(urls)) if urls.is_empty() => Ok(None), + Some(ImageListRef::Urls(urls)) => Ok(Some(urls)), + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => Ok(None), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) if refs.is_empty() => Ok(None), + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + Ok(Some(urls)) + } + } +} + +fn reference_video_urls(refs: Option) -> Result>, ArtcraftRouterError> { + match refs { + None => Ok(None), + Some(VideoListRef::Urls(urls)) if urls.is_empty() => Ok(None), + Some(VideoListRef::Urls(urls)) => Ok(Some(urls)), + Some(VideoListRef::MediaFileTokens(tokens)) if tokens.is_empty() => Ok(None), + Some(VideoListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(VideoListRef::Sources(refs)) if refs.is_empty() => Ok(None), + Some(VideoListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for video_ref in refs { + match video_ref { + VideoRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + Ok(Some(urls)) + } + } +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", other))) + } + _ => Ok(Some(Ar::Auto)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanResolution as R; + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(R::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(R::TenEightyP)), + Some(RouterResolution::FourK) => Ok(Some(R::FourK)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", &format!("{:?}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(R::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(R::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(PlanDuration::Four)), + Some(6) => Ok(Some(PlanDuration::Six)), + Some(8) => Ok(Some(PlanDuration::Eight)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + // Nearest supported duration above/below, clamped to the 4s–8s range. + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(match other { + 0..=4 => PlanDuration::Four, + 5..=6 => PlanDuration::Six, + _ => PlanDuration::Eight, + })), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(match other { + 0..=5 => PlanDuration::Four, + 6..=7 => PlanDuration::Six, + _ => PlanDuration::Eight, + })), + }, + } +} + +/// Extend-video also supports fal's 7s default in addition to 4/6/8. +fn plan_extend_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo3p1ExtendVideoDuration as D; + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(D::FourSeconds)), + Some(6) => Ok(Some(D::SixSeconds)), + Some(7) => Ok(Some(D::SevenSeconds)), + Some(8) => Ok(Some(D::EightSeconds)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(if other < 5 { D::FourSeconds } else if other == 5 { D::SixSeconds } else { D::EightSeconds })) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(if other <= 5 { D::FourSeconds } else { D::EightSeconds })) + } + }, + } +} + +fn unsupported(field: &'static str, value: &str) -> ArtcraftRouterError { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: value.to_string(), + }) +} + +// The text-to-video endpoint has no `auto` aspect ratio; omit the field and +// let fal apply its own default (16:9). +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Option { + match a { + PlanAspectRatio::Auto => None, + PlanAspectRatio::SixteenByNine => Some(Veo3p1TextToVideoAspectRatio::SixteenByNine), + PlanAspectRatio::NineBySixteen => Some(Veo3p1TextToVideoAspectRatio::NineBySixteen), + } +} + +fn to_t2v_duration(d: PlanDuration) -> Veo3p1TextToVideoDuration { + match d { + PlanDuration::Four => Veo3p1TextToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1TextToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1TextToVideoDuration::EightSeconds, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> Veo3p1TextToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1TextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1TextToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1TextToVideoResolution::FourK, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> Veo3p1ImageToVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1ImageToVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1ImageToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1ImageToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Veo3p1ImageToVideoDuration { + match d { + PlanDuration::Four => Veo3p1ImageToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1ImageToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1ImageToVideoDuration::EightSeconds, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> Veo3p1ImageToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1ImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1ImageToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1ImageToVideoResolution::FourK, + } +} + +fn to_flf_aspect_ratio(a: PlanAspectRatio) -> Veo3p1FirstLastFrameToVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1FirstLastFrameToVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1FirstLastFrameToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1FirstLastFrameToVideoAspectRatio::NineBySixteen, + } +} + +fn to_flf_duration(d: PlanDuration) -> Veo3p1FirstLastFrameToVideoDuration { + match d { + PlanDuration::Four => Veo3p1FirstLastFrameToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1FirstLastFrameToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1FirstLastFrameToVideoDuration::EightSeconds, + } +} + +fn to_flf_resolution(r: PlanResolution) -> Veo3p1FirstLastFrameToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1FirstLastFrameToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1FirstLastFrameToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1FirstLastFrameToVideoResolution::FourK, + } +} + +// The reference-to-video endpoint has no `auto` aspect ratio; omit the field +// and let fal apply its own default (16:9). +fn to_reference_aspect_ratio(a: PlanAspectRatio) -> Option { + match a { + PlanAspectRatio::Auto => None, + PlanAspectRatio::SixteenByNine => Some(Veo3p1ReferenceToVideoAspectRatio::SixteenByNine), + PlanAspectRatio::NineBySixteen => Some(Veo3p1ReferenceToVideoAspectRatio::NineBySixteen), + } +} + +fn to_reference_duration(d: PlanDuration) -> Veo3p1ReferenceToVideoDuration { + match d { + PlanDuration::Four => Veo3p1ReferenceToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1ReferenceToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1ReferenceToVideoDuration::EightSeconds, + } +} + +fn to_reference_resolution(r: PlanResolution) -> Veo3p1ReferenceToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1ReferenceToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1ReferenceToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1ReferenceToVideoResolution::FourK, + } +} + +fn to_extend_aspect_ratio(a: PlanAspectRatio) -> Veo3p1ExtendVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1ExtendVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1ExtendVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1ExtendVideoAspectRatio::NineBySixteen, + } +} + +// Extend-video has no 4k tier; the nearest supported resolution in either +// direction is 1080p. +fn to_extend_resolution( + r: PlanResolution, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match r { + PlanResolution::SevenTwentyP => Ok(Veo3p1ExtendVideoResolution::SevenTwentyP), + PlanResolution::TenEightyP => Ok(Veo3p1ExtendVideoResolution::TenEightyP), + PlanResolution::FourK => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", "Veo 3.1 extend-video does not support 4k")) + } + _ => Ok(Veo3p1ExtendVideoResolution::TenEightyP), + }, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + const START_FRAME_URL: &str = "https://example.com/a.png"; + const END_FRAME_URL: &str = "https://example.com/b.png"; + const REFERENCE_IMAGE_URL_A: &str = "https://example.com/ref_a.png"; + const REFERENCE_IMAGE_URL_B: &str = "https://example.com/ref_b.png"; + const REFERENCE_VIDEO_URL: &str = "https://example.com/in.mp4"; + + mod mode_selection { + use super::*; + + #[test] + fn no_frames_picks_t2v() { + assert!(matches!(unwrap_mode(base_builder()), FalVeo3p1Mode::TextToVideo(_))); + } + + #[test] + fn start_only_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(matches!(unwrap_mode(b), FalVeo3p1Mode::ImageToVideo(_))); + } + + #[test] + fn start_and_end_picks_first_last_frame() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(matches!(unwrap_mode(b), FalVeo3p1Mode::FirstLastFrameToVideo(_))); + } + + #[test] + fn end_only_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn reference_images_pick_reference_to_video() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL_A.to_string()])); + assert!(matches!(unwrap_mode(b), FalVeo3p1Mode::ReferenceToVideo(_))); + } + + #[test] + fn reference_videos_pick_extend_video() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + assert!(matches!(unwrap_mode(b), FalVeo3p1Mode::ExtendVideo(_))); + } + + #[test] + fn empty_reference_lists_fall_through_to_t2v() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![])); + b.reference_videos = Some(VideoListRef::Urls(vec![])); + assert!(matches!(unwrap_mode(b), FalVeo3p1Mode::TextToVideo(_))); + } + + #[test] + fn public_build_fn_wraps_request_enum() { + match build_fal_veo_3p1(base_builder()).expect("build") { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3p1(s)) => { + assert!(matches!(s.mode, FalVeo3p1Mode::TextToVideo(_))); + } + _ => panic!("expected Request(FalVeo3p1)"), + } + } + } + + mod extend_video { + use super::*; + + #[test] + fn extend_maps_video_url_and_7s_duration() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.duration_seconds = Some(7); + match unwrap_mode(b) { + FalVeo3p1Mode::ExtendVideo(r) => { + assert_eq!(r.video_url, REFERENCE_VIDEO_URL); + assert!(matches!(r.duration, Some(Veo3p1ExtendVideoDuration::SevenSeconds))); + } + _ => panic!("expected extend"), + } + } + + #[test] + fn extend_requires_exactly_one_video() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![ + REFERENCE_VIDEO_URL.to_string(), + "https://example.com/other.mp4".to_string(), + ])); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn extend_rejects_start_frame() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn extend_rejects_end_frame() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn extend_rejects_reference_images() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL_A.to_string()])); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn extend_duration_5s_pay_more_upgrades_to_6() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + match unwrap_mode(b) { + FalVeo3p1Mode::ExtendVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1ExtendVideoDuration::SixSeconds))); + } + _ => panic!("expected extend"), + } + } + + #[test] + fn extend_4k_errors_with_error_out() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn extend_4k_maps_to_1080p_with_mitigation() { + for strategy in [ + RequestMismatchMitigationStrategy::PayMoreUpgrade, + RequestMismatchMitigationStrategy::PayLessDowngrade, + ] { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = strategy; + match unwrap_mode(b) { + FalVeo3p1Mode::ExtendVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1ExtendVideoResolution::TenEightyP))); + } + _ => panic!("expected extend"), + } + } + } + } + + mod reference_to_video { + use super::*; + + #[test] + fn reference_maps_image_urls() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![ + REFERENCE_IMAGE_URL_A.to_string(), + REFERENCE_IMAGE_URL_B.to_string(), + ])); + match unwrap_mode(b) { + FalVeo3p1Mode::ReferenceToVideo(r) => { + assert_eq!(r.image_urls, vec![REFERENCE_IMAGE_URL_A, REFERENCE_IMAGE_URL_B]); + } + _ => panic!("expected reference"), + } + } + + #[test] + fn reference_rejects_start_frame() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL_A.to_string()])); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn reference_rejects_end_frame() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL_A.to_string()])); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn reference_auto_aspect_ratio_is_omitted() { + // reference-to-video has no `auto` wire value; Auto must map to None. + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL_A.to_string()])); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + match unwrap_mode(b) { + FalVeo3p1Mode::ReferenceToVideo(r) => assert!(r.aspect_ratio.is_none()), + _ => panic!("expected reference"), + } + } + + #[test] + fn reference_maps_duration_and_resolution() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL_A.to_string()])); + b.duration_seconds = Some(6); + b.resolution = Some(RouterResolution::FourK); + match unwrap_mode(b) { + FalVeo3p1Mode::ReferenceToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1ReferenceToVideoDuration::SixSeconds))); + assert!(matches!(r.resolution, Some(Veo3p1ReferenceToVideoResolution::FourK))); + } + _ => panic!("expected reference"), + } + } + } + + mod duration_conversions { + use super::*; + + #[test] + fn duration_4s() { + let mut b = base_builder(); + b.duration_seconds = Some(4); + match unwrap_mode(b) { + FalVeo3p1Mode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1TextToVideoDuration::FourSeconds))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_3p1_state(b).is_err()); + } + + #[test] + fn duration_5s_pay_more_upgrades_to_6() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + match unwrap_mode(b) { + FalVeo3p1Mode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1TextToVideoDuration::SixSeconds))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn duration_5s_pay_less_downgrades_to_4() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + match unwrap_mode(b) { + FalVeo3p1Mode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1TextToVideoDuration::FourSeconds))); + } + _ => panic!("expected t2v"), + } + } + } + + mod resolution_conversions { + use super::*; + + #[test] + fn t2v_720p() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::SevenTwentyP); + match unwrap_mode(b) { + FalVeo3p1Mode::TextToVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1TextToVideoResolution::SevenTwentyP))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn t2v_4k_maps_to_four_k() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::FourK); + match unwrap_mode(b) { + FalVeo3p1Mode::TextToVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1TextToVideoResolution::FourK))); + } + _ => panic!("expected t2v"), + } + } + } + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn t2v_auto_aspect_ratio_is_omitted() { + // t2v has no `auto` wire value; Auto must map to None. + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + match unwrap_mode(b) { + FalVeo3p1Mode::TextToVideo(r) => assert!(r.aspect_ratio.is_none()), + _ => panic!("expected t2v"), + } + } + + #[test] + fn i2v_auto_aspect_ratio_maps_to_auto() { + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + match unwrap_mode(b) { + FalVeo3p1Mode::ImageToVideo(r) => { + assert!(matches!(r.aspect_ratio, Some(Veo3p1ImageToVideoAspectRatio::Auto))); + } + _ => panic!("expected i2v"), + } + } + } + + #[test] + fn full_combinatorial_pass() { + let resolutions = [None, Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP), Some(RouterResolution::FourK)]; + let durations = [None, Some(4u16), Some(6), Some(8)]; + let aspect_ratios = [None, Some(RouterAspectRatio::Auto), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen)]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &resolution in &resolutions { + for &duration in &durations { + for &aspect_ratio in &aspect_ratios { + for &generate_audio in &audios { + for frames in [0, 1, 2] { + let mut b = base_builder(); + b.resolution = resolution; + b.duration_seconds = duration; + b.aspect_ratio = aspect_ratio; + b.generate_audio = generate_audio; + if frames >= 1 { + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + } + if frames == 2 { + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + } + assert!(build_fal_veo_3p1_state(b).is_ok()); + combos += 1; + } + } + } + } + } + assert_eq!(combos, 4 * 4 * 4 * 3 * 3); + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn unwrap_mode(b: GenerateVideoRequestBuilder) -> FalVeo3p1Mode { + build_fal_veo_3p1_state(b).expect("build").mode + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1/cost.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/cost.rs new file mode 100644 index 00000000..4b4769ac --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/cost.rs @@ -0,0 +1,239 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::providers::fal::veo_3p1::request::{FalVeo3p1Mode, FalVeo3p1RequestState}; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +#[derive(Clone, Debug)] +pub struct FalVeo3p1CostState { + pub cost_in_usd_cents: u64, +} + +impl FalVeo3p1CostState { + pub fn from_request(request: &FalVeo3p1RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalVeo3p1Mode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1Mode::ImageToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1Mode::FirstLastFrameToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1Mode::ReferenceToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1Mode::ExtendVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_3p1::build::build_fal_veo_3p1_state; + + use super::*; + + // Veo 3.1 pricing: + // 720p / 1080p: $0.20/sec (audio off), $0.40/sec (audio on) + // 4k: $0.40/sec (audio off), $0.60/sec (audio on) + // Extend-video has no 4k tier and defaults to 7s. + + #[derive(Clone, Copy)] + enum Modality { + TextToVideo, + ImageToVideo, + FirstLastFrame, + Reference, + Extend, + } + + mod text_to_video { + use super::*; + + #[test] + fn t2v_8s_audio_on_720p_is_320() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::SevenTwentyP), Some(true)), 320); + } + + #[test] + fn t2v_8s_audio_off_720p_is_160() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::SevenTwentyP), Some(false)), 160); + } + + #[test] + fn t2v_4s_audio_on_is_160() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(4), None, Some(true)), 160); + } + + #[test] + fn t2v_6s_audio_on_is_240() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(6), None, Some(true)), 240); + } + + #[test] + fn t2v_8s_audio_on_4k_is_480() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::FourK), Some(true)), 480); + } + + #[test] + fn t2v_8s_audio_off_4k_is_320() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::FourK), Some(false)), 320); + } + + #[test] + fn t2v_defaults_are_8s_720p_audio_on_320() { + // duration=None→8s, resolution=None→720p, audio=None→on. + assert_eq!(cost_cents(Modality::TextToVideo, None, None, None), 320); + } + + #[test] + fn t2v_1080p_bills_same_as_720p() { + assert_eq!( + cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::TenEightyP), Some(true)), + cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::SevenTwentyP), Some(true)), + ); + } + } + + mod image_to_video { + use super::*; + + #[test] + fn i2v_6s_audio_on_is_240() { + assert_eq!(cost_cents(Modality::ImageToVideo, Some(6), None, Some(true)), 240); + } + + #[test] + fn i2v_8s_audio_off_1080p_is_160() { + assert_eq!(cost_cents(Modality::ImageToVideo, Some(8), Some(RouterResolution::TenEightyP), Some(false)), 160); + } + } + + mod first_last_frame_to_video { + use super::*; + + #[test] + fn flf_4s_audio_on_is_160() { + assert_eq!(cost_cents(Modality::FirstLastFrame, Some(4), None, Some(true)), 160); + } + + #[test] + fn flf_8s_audio_on_4k_is_480() { + assert_eq!(cost_cents(Modality::FirstLastFrame, Some(8), Some(RouterResolution::FourK), Some(true)), 480); + } + } + + mod reference_to_video { + use super::*; + + #[test] + fn reference_8s_audio_on_1080p_is_320() { + assert_eq!(cost_cents(Modality::Reference, Some(8), Some(RouterResolution::TenEightyP), Some(true)), 320); + } + + #[test] + fn reference_4s_audio_off_720p_is_80() { + assert_eq!(cost_cents(Modality::Reference, Some(4), Some(RouterResolution::SevenTwentyP), Some(false)), 80); + } + + #[test] + fn reference_8s_audio_on_4k_is_480() { + assert_eq!(cost_cents(Modality::Reference, Some(8), Some(RouterResolution::FourK), Some(true)), 480); + } + } + + mod extend_video { + use super::*; + + #[test] + fn extend_7s_audio_on_is_280() { + assert_eq!(cost_cents(Modality::Extend, Some(7), None, Some(true)), 280); + } + + #[test] + fn extend_7s_audio_off_is_140() { + assert_eq!(cost_cents(Modality::Extend, Some(7), None, Some(false)), 140); + } + + #[test] + fn extend_8s_audio_on_is_320() { + assert_eq!(cost_cents(Modality::Extend, Some(8), None, Some(true)), 320); + } + + #[test] + fn extend_defaults_are_7s_audio_on_280() { + // duration=None→7s (fal's extend default), audio=None→on. + assert_eq!(cost_cents(Modality::Extend, None, None, None), 280); + } + } + + #[test] + fn t2v_i2v_flf_and_reference_price_identically() { + let expected = cost_cents(Modality::TextToVideo, Some(6), Some(RouterResolution::TenEightyP), Some(true)); + for modality in [Modality::ImageToVideo, Modality::FirstLastFrame, Modality::Reference] { + assert_eq!(cost_cents(modality, Some(6), Some(RouterResolution::TenEightyP), Some(true)), expected); + } + } + + #[test] + fn audio_costs_more_than_no_audio() { + assert!( + cost_cents(Modality::TextToVideo, Some(8), None, Some(false)) + < cost_cents(Modality::TextToVideo, Some(8), None, Some(true)) + ); + } + + fn cost_cents( + modality: Modality, + duration_seconds: Option, + resolution: Option, + generate_audio: Option, + ) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + generate_audio, + ..Default::default() + }; + match modality { + Modality::TextToVideo => {} + Modality::ImageToVideo => { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + Modality::FirstLastFrame => { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/b.png".to_string())); + } + Modality::Reference => { + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])); + } + Modality::Extend => { + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/in.mp4".to_string()])); + } + } + let state = build_fal_veo_3p1_state(b).expect("build state"); + FalVeo3p1CostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1/mod.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1/request.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/request.rs new file mode 100644 index 00000000..c2b43ffb --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1/request.rs @@ -0,0 +1,186 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::extend::veo_3p1::api::Veo3p1ExtendVideoRequest; +use fal_client::requests::api::video::image::veo_3p1::api::Veo3p1ImageToVideoRequest; +use fal_client::requests::api::video::images::veo_3p1::api::Veo3p1FirstLastFrameToVideoRequest; +use fal_client::requests::api::video::reference::veo_3p1::api::Veo3p1ReferenceToVideoRequest; +use fal_client::requests::api::video::text::veo_3p1::api::Veo3p1TextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalVeo3p1Mode { + TextToVideo(Veo3p1TextToVideoRequest), + ImageToVideo(Veo3p1ImageToVideoRequest), + FirstLastFrameToVideo(Veo3p1FirstLastFrameToVideoRequest), + ReferenceToVideo(Veo3p1ReferenceToVideoRequest), + ExtendVideo(Veo3p1ExtendVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalVeo3p1RequestState { + pub mode: FalVeo3p1Mode, +} + +impl FalVeo3p1RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalVeo3p1Mode::TextToVideo(request) => send_request(request, client).await, + FalVeo3p1Mode::ImageToVideo(request) => send_request(request, client).await, + FalVeo3p1Mode::FirstLastFrameToVideo(request) => send_request(request, client).await, + FalVeo3p1Mode::ReferenceToVideo(request) => send_request(request, client).await, + FalVeo3p1Mode::ExtendVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + use test_data::web::video_urls::ANGRY_SHIBA_VIDEO_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_text_to_video_720p_4s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a quiet meadow with wildflowers".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(4), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_image_to_video_8s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the dog leaps into the lake.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(8), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_first_last_frame() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a smooth transition between scenes".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + end_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(6), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_reference_to_video_4s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the dog runs across a sunlit meadow".to_string()), + reference_images: Some(ImageListRef::Urls(vec![JUNO_AT_LAKE_IMAGE_URL.to_string()])), + duration_seconds: Some(4), + generate_audio: Some(false), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_extend_video_7s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the scene continues naturally, keeping the same motion and style".to_string()), + reference_videos: Some(VideoListRef::Urls(vec![ANGRY_SHIBA_VIDEO_URL.to_string()])), + duration_seconds: Some(7), + generate_audio: Some(false), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + fn builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + async fn run_pipeline(b: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_fal_client(); + let dor = b.build2().expect("build2"); + let req = match dor { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request"), + }; + req.send_request(&client).await.expect("send") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/build.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/build.rs new file mode 100644 index 00000000..37b358d5 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/build.rs @@ -0,0 +1,769 @@ +use fal_client::requests::api::video::extend::veo_3p1_fast::api::{ + Veo3p1FastExtendVideoAspectRatio, Veo3p1FastExtendVideoDuration, Veo3p1FastExtendVideoRequest, + Veo3p1FastExtendVideoResolution, +}; +use fal_client::requests::api::video::image::veo_3p1_fast::api::{ + Veo3p1FastImageToVideoAspectRatio, Veo3p1FastImageToVideoDuration, Veo3p1FastImageToVideoRequest, + Veo3p1FastImageToVideoResolution, +}; +use fal_client::requests::api::video::images::veo_3p1_fast::api::{ + Veo3p1FastFirstLastFrameToVideoAspectRatio, Veo3p1FastFirstLastFrameToVideoDuration, + Veo3p1FastFirstLastFrameToVideoRequest, Veo3p1FastFirstLastFrameToVideoResolution, +}; +use fal_client::requests::api::video::reference::veo_3p1_fast::api::{ + Veo3p1FastReferenceToVideoAspectRatio, Veo3p1FastReferenceToVideoDuration, + Veo3p1FastReferenceToVideoRequest, Veo3p1FastReferenceToVideoResolution, +}; +use fal_client::requests::api::video::text::veo_3p1_fast::api::{ + Veo3p1FastTextToVideoAspectRatio, Veo3p1FastTextToVideoDuration, Veo3p1FastTextToVideoRequest, + Veo3p1FastTextToVideoResolution, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::video_list_ref::VideoListRef; +use crate::api::video_ref::VideoRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::veo_3p1_fast::request::{ + FalVeo3p1FastMode, FalVeo3p1FastRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + SevenTwentyP, + TenEightyP, + FourK, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Four, + Six, + Eight, +} + +pub fn build_fal_veo_3p1_fast( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_veo_3p1_fast_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3p1Fast(state))) +} + +pub(crate) fn build_fal_veo_3p1_fast_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let start = optional_url(builder.start_frame.clone())?; + let end = optional_url(builder.end_frame.clone())?; + let reference_images = reference_image_urls(builder.reference_images.clone())?; + let reference_videos = reference_video_urls(builder.reference_videos.clone())?; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let generate_audio = builder.generate_audio; + + // Modality dispatch, most specific inputs first: + // 1. reference videos → extend-video + // 2. reference images → reference-to-video + // 3. start + end frames → first-last-frame-to-video + // 4. start frame only → image-to-video + // 5. no media → text-to-video + let mode = if let Some(video_urls) = reference_videos { + if reference_images.is_some() { + return Err(unsupported( + "reference_images", + "Veo 3.1 Fast extend-video cannot combine reference_images with a reference video", + )); + } + if start.is_some() { + return Err(unsupported( + "start_frame", + "Veo 3.1 Fast extend-video cannot combine start_frame with a reference video", + )); + } + if end.is_some() { + return Err(unsupported( + "end_frame", + "Veo 3.1 Fast extend-video cannot combine end_frame with a reference video", + )); + } + if video_urls.len() != 1 { + return Err(unsupported( + "reference_videos", + &format!("Veo 3.1 Fast extend-video requires exactly 1 reference video, got {}", video_urls.len()), + )); + } + let video_url = video_urls.into_iter().next().expect("checked len == 1"); + FalVeo3p1FastMode::ExtendVideo(Veo3p1FastExtendVideoRequest { + prompt, + video_url, + aspect_ratio: aspect_ratio.map(to_extend_aspect_ratio), + duration: plan_extend_duration(builder.duration_seconds, strategy)?, + resolution: resolution.map(|r| to_extend_resolution(r, strategy)).transpose()?, + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }) + } else if let Some(image_urls) = reference_images { + if start.is_some() { + return Err(unsupported( + "start_frame", + "Veo 3.1 Fast reference-to-video cannot combine start_frame with reference_images", + )); + } + if end.is_some() { + return Err(unsupported( + "end_frame", + "Veo 3.1 Fast reference-to-video cannot combine end_frame with reference_images", + )); + } + // NB: reference-to-video has no negative_prompt or seed fields on fal's + // schema — those builder inputs are dropped silently. + FalVeo3p1FastMode::ReferenceToVideo(Veo3p1FastReferenceToVideoRequest { + prompt, + image_urls, + aspect_ratio: aspect_ratio.and_then(to_reference_aspect_ratio), + duration: plan_duration(builder.duration_seconds, strategy)?.map(to_reference_duration), + resolution: resolution.map(to_reference_resolution), + generate_audio, + auto_fix: None, + safety_tolerance: None, + }) + } else { + let duration = plan_duration(builder.duration_seconds, strategy)?; + match (start, end) { + (None, None) => FalVeo3p1FastMode::TextToVideo(Veo3p1FastTextToVideoRequest { + prompt, + aspect_ratio: aspect_ratio.and_then(to_t2v_aspect_ratio), + duration: duration.map(to_t2v_duration), + resolution: resolution.map(to_t2v_resolution), + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + (Some(image_url), None) => FalVeo3p1FastMode::ImageToVideo(Veo3p1FastImageToVideoRequest { + prompt, + image_url, + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + duration: duration.map(to_i2v_duration), + resolution: resolution.map(to_i2v_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + (Some(first_frame_url), Some(last_frame_url)) => FalVeo3p1FastMode::FirstLastFrameToVideo( + Veo3p1FastFirstLastFrameToVideoRequest { + prompt, + first_frame_url, + last_frame_url, + aspect_ratio: aspect_ratio.map(to_flf_aspect_ratio), + duration: duration.map(to_flf_duration), + resolution: resolution.map(to_flf_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }, + ), + (None, Some(_)) => { + return Err(unsupported( + "end_frame", + "Veo 3.1 Fast requires a start_frame when end_frame is provided", + )); + } + } + }; + + Ok(FalVeo3p1FastRequestState { mode }) +} + +fn optional_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + } +} + +fn reference_image_urls(refs: Option) -> Result>, ArtcraftRouterError> { + match refs { + None => Ok(None), + Some(ImageListRef::Urls(urls)) if urls.is_empty() => Ok(None), + Some(ImageListRef::Urls(urls)) => Ok(Some(urls)), + Some(ImageListRef::MediaFileTokens(tokens)) if tokens.is_empty() => Ok(None), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) if refs.is_empty() => Ok(None), + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + Ok(Some(urls)) + } + } +} + +fn reference_video_urls(refs: Option) -> Result>, ArtcraftRouterError> { + match refs { + None => Ok(None), + Some(VideoListRef::Urls(urls)) if urls.is_empty() => Ok(None), + Some(VideoListRef::Urls(urls)) => Ok(Some(urls)), + Some(VideoListRef::MediaFileTokens(tokens)) if tokens.is_empty() => Ok(None), + Some(VideoListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(VideoListRef::Sources(refs)) if refs.is_empty() => Ok(None), + Some(VideoListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for video_ref in refs { + match video_ref { + VideoRef::Url(url) => urls.push(url), + _ => return Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + } + } + Ok(Some(urls)) + } + } +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", other))) + } + _ => Ok(Some(Ar::Auto)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanResolution as R; + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(R::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(R::TenEightyP)), + Some(RouterResolution::FourK) => Ok(Some(R::FourK)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", &format!("{:?}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(R::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(R::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(PlanDuration::Four)), + Some(6) => Ok(Some(PlanDuration::Six)), + Some(8) => Ok(Some(PlanDuration::Eight)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + // Nearest supported duration above/below, clamped to the 4s–8s range. + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(match other { + 0..=4 => PlanDuration::Four, + 5..=6 => PlanDuration::Six, + _ => PlanDuration::Eight, + })), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(match other { + 0..=5 => PlanDuration::Four, + 6..=7 => PlanDuration::Six, + _ => PlanDuration::Eight, + })), + }, + } +} + +/// Extend-video also supports fal's 7s default in addition to 4/6/8. +fn plan_extend_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use Veo3p1FastExtendVideoDuration as D; + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(D::FourSeconds)), + Some(6) => Ok(Some(D::SixSeconds)), + Some(7) => Ok(Some(D::SevenSeconds)), + Some(8) => Ok(Some(D::EightSeconds)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(if other < 5 { D::FourSeconds } else if other == 5 { D::SixSeconds } else { D::EightSeconds })) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(if other <= 5 { D::FourSeconds } else { D::EightSeconds })) + } + }, + } +} + +fn unsupported(field: &'static str, value: &str) -> ArtcraftRouterError { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: value.to_string(), + }) +} + +// The text-to-video endpoint has no `auto` aspect ratio; omit the field and +// let fal apply its own default (16:9). +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Option { + match a { + PlanAspectRatio::Auto => None, + PlanAspectRatio::SixteenByNine => Some(Veo3p1FastTextToVideoAspectRatio::SixteenByNine), + PlanAspectRatio::NineBySixteen => Some(Veo3p1FastTextToVideoAspectRatio::NineBySixteen), + } +} + +fn to_t2v_duration(d: PlanDuration) -> Veo3p1FastTextToVideoDuration { + match d { + PlanDuration::Four => Veo3p1FastTextToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1FastTextToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1FastTextToVideoDuration::EightSeconds, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> Veo3p1FastTextToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1FastTextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1FastTextToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1FastTextToVideoResolution::FourK, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> Veo3p1FastImageToVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1FastImageToVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1FastImageToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1FastImageToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Veo3p1FastImageToVideoDuration { + match d { + PlanDuration::Four => Veo3p1FastImageToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1FastImageToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1FastImageToVideoDuration::EightSeconds, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> Veo3p1FastImageToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1FastImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1FastImageToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1FastImageToVideoResolution::FourK, + } +} + +fn to_flf_aspect_ratio(a: PlanAspectRatio) -> Veo3p1FastFirstLastFrameToVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1FastFirstLastFrameToVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1FastFirstLastFrameToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1FastFirstLastFrameToVideoAspectRatio::NineBySixteen, + } +} + +fn to_flf_duration(d: PlanDuration) -> Veo3p1FastFirstLastFrameToVideoDuration { + match d { + PlanDuration::Four => Veo3p1FastFirstLastFrameToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1FastFirstLastFrameToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1FastFirstLastFrameToVideoDuration::EightSeconds, + } +} + +fn to_flf_resolution(r: PlanResolution) -> Veo3p1FastFirstLastFrameToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1FastFirstLastFrameToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1FastFirstLastFrameToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1FastFirstLastFrameToVideoResolution::FourK, + } +} + +// The reference-to-video endpoint has no `auto` aspect ratio; omit the field +// and let fal apply its own default (16:9). +fn to_reference_aspect_ratio(a: PlanAspectRatio) -> Option { + match a { + PlanAspectRatio::Auto => None, + PlanAspectRatio::SixteenByNine => Some(Veo3p1FastReferenceToVideoAspectRatio::SixteenByNine), + PlanAspectRatio::NineBySixteen => Some(Veo3p1FastReferenceToVideoAspectRatio::NineBySixteen), + } +} + +fn to_reference_duration(d: PlanDuration) -> Veo3p1FastReferenceToVideoDuration { + match d { + PlanDuration::Four => Veo3p1FastReferenceToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1FastReferenceToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1FastReferenceToVideoDuration::EightSeconds, + } +} + +fn to_reference_resolution(r: PlanResolution) -> Veo3p1FastReferenceToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1FastReferenceToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1FastReferenceToVideoResolution::TenEightyP, + PlanResolution::FourK => Veo3p1FastReferenceToVideoResolution::FourK, + } +} + +fn to_extend_aspect_ratio(a: PlanAspectRatio) -> Veo3p1FastExtendVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1FastExtendVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1FastExtendVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1FastExtendVideoAspectRatio::NineBySixteen, + } +} + +// Extend-video has no 4k tier; the nearest supported resolution in either +// direction is 1080p. +fn to_extend_resolution( + r: PlanResolution, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match r { + PlanResolution::SevenTwentyP => Ok(Veo3p1FastExtendVideoResolution::SevenTwentyP), + PlanResolution::TenEightyP => Ok(Veo3p1FastExtendVideoResolution::TenEightyP), + PlanResolution::FourK => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", "Veo 3.1 Fast extend-video does not support 4k")) + } + _ => Ok(Veo3p1FastExtendVideoResolution::TenEightyP), + }, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + const START_FRAME_URL: &str = "https://example.com/a.png"; + const END_FRAME_URL: &str = "https://example.com/b.png"; + const REFERENCE_IMAGE_URL: &str = "https://example.com/ref.png"; + const REFERENCE_VIDEO_URL: &str = "https://example.com/in.mp4"; + + mod mode_selection { + use super::*; + + #[test] + fn no_frames_picks_t2v() { + assert!(matches!(unwrap_mode(base_builder()), FalVeo3p1FastMode::TextToVideo(_))); + } + + #[test] + fn start_only_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(matches!(unwrap_mode(b), FalVeo3p1FastMode::ImageToVideo(_))); + } + + #[test] + fn start_and_end_picks_flf() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(matches!(unwrap_mode(b), FalVeo3p1FastMode::FirstLastFrameToVideo(_))); + } + + #[test] + fn end_only_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn reference_images_pick_reference_to_video() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL.to_string()])); + assert!(matches!(unwrap_mode(b), FalVeo3p1FastMode::ReferenceToVideo(_))); + } + + #[test] + fn reference_videos_pick_extend_video() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + assert!(matches!(unwrap_mode(b), FalVeo3p1FastMode::ExtendVideo(_))); + } + + #[test] + fn public_build_fn_wraps_request_enum() { + match build_fal_veo_3p1_fast(base_builder()).expect("build") { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3p1Fast(s)) => { + assert!(matches!(s.mode, FalVeo3p1FastMode::TextToVideo(_))); + } + _ => panic!("expected Request(FalVeo3p1Fast)"), + } + } + } + + mod extend_video { + use super::*; + + #[test] + fn extend_maps_video_url_and_7s_duration() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.duration_seconds = Some(7); + match unwrap_mode(b) { + FalVeo3p1FastMode::ExtendVideo(r) => { + assert_eq!(r.video_url, REFERENCE_VIDEO_URL); + assert!(matches!(r.duration, Some(Veo3p1FastExtendVideoDuration::SevenSeconds))); + } + _ => panic!("expected extend"), + } + } + + #[test] + fn extend_requires_exactly_one_video() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![ + REFERENCE_VIDEO_URL.to_string(), + "https://example.com/other.mp4".to_string(), + ])); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn extend_rejects_start_frame() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn extend_rejects_end_frame() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn extend_rejects_reference_images() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL.to_string()])); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn extend_4k_errors_with_error_out() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn extend_4k_maps_to_1080p_with_mitigation() { + for strategy in [ + RequestMismatchMitigationStrategy::PayMoreUpgrade, + RequestMismatchMitigationStrategy::PayLessDowngrade, + ] { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = strategy; + match unwrap_mode(b) { + FalVeo3p1FastMode::ExtendVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1FastExtendVideoResolution::TenEightyP))); + } + _ => panic!("expected extend"), + } + } + } + } + + mod reference_to_video { + use super::*; + + #[test] + fn reference_maps_image_urls() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL.to_string()])); + match unwrap_mode(b) { + FalVeo3p1FastMode::ReferenceToVideo(r) => { + assert_eq!(r.image_urls, vec![REFERENCE_IMAGE_URL]); + } + _ => panic!("expected reference"), + } + } + + #[test] + fn reference_rejects_start_frame() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL.to_string()])); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + + #[test] + fn reference_rejects_end_frame() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL.to_string()])); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + } + + mod duration_conversions { + use super::*; + + #[test] + fn duration_4s() { + let mut b = base_builder(); + b.duration_seconds = Some(4); + match unwrap_mode(b) { + FalVeo3p1FastMode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1FastTextToVideoDuration::FourSeconds))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_3p1_fast_state(b).is_err()); + } + } + + mod resolution_conversions { + use super::*; + + #[test] + fn t2v_720p() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::SevenTwentyP); + match unwrap_mode(b) { + FalVeo3p1FastMode::TextToVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1FastTextToVideoResolution::SevenTwentyP))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn t2v_4k_maps_to_four_k() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::FourK); + match unwrap_mode(b) { + FalVeo3p1FastMode::TextToVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1FastTextToVideoResolution::FourK))); + } + _ => panic!("expected t2v"), + } + } + } + + #[test] + fn full_combinatorial_pass() { + let resolutions = [None, Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP), Some(RouterResolution::FourK)]; + let durations = [None, Some(4u16), Some(6), Some(8)]; + let aspect_ratios = [None, Some(RouterAspectRatio::Auto), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen)]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &resolution in &resolutions { + for &duration in &durations { + for &aspect_ratio in &aspect_ratios { + for &generate_audio in &audios { + for frames in [0, 1, 2] { + let mut b = base_builder(); + b.resolution = resolution; + b.duration_seconds = duration; + b.aspect_ratio = aspect_ratio; + b.generate_audio = generate_audio; + if frames >= 1 { + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + } + if frames == 2 { + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + } + assert!(build_fal_veo_3p1_fast_state(b).is_ok()); + combos += 1; + } + } + } + } + } + assert_eq!(combos, 4 * 4 * 4 * 3 * 3); + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Fast, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn unwrap_mode(b: GenerateVideoRequestBuilder) -> FalVeo3p1FastMode { + build_fal_veo_3p1_fast_state(b).expect("build").mode + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/cost.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/cost.rs new file mode 100644 index 00000000..34e56b28 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/cost.rs @@ -0,0 +1,241 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::providers::fal::veo_3p1_fast::request::{ + FalVeo3p1FastMode, FalVeo3p1FastRequestState, +}; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +#[derive(Clone, Debug)] +pub struct FalVeo3p1FastCostState { + pub cost_in_usd_cents: u64, +} + +impl FalVeo3p1FastCostState { + pub fn from_request(request: &FalVeo3p1FastRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalVeo3p1FastMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1FastMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1FastMode::FirstLastFrameToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1FastMode::ReferenceToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1FastMode::ExtendVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_3p1_fast::build::build_fal_veo_3p1_fast_state; + + use super::*; + + // Veo 3.1 Fast pricing: + // 720p / 1080p: $0.10/sec (audio off), $0.15/sec (audio on) + // 4k: $0.30/sec (audio off), $0.35/sec (audio on) + // Extend-video has no 4k tier and defaults to 7s. + + #[derive(Clone, Copy)] + enum Modality { + TextToVideo, + ImageToVideo, + FirstLastFrame, + Reference, + Extend, + } + + mod text_to_video { + use super::*; + + #[test] + fn t2v_4s_audio_on_is_60() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(4), None, Some(true)), 60); + } + + #[test] + fn t2v_6s_audio_on_is_90() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(6), None, Some(true)), 90); + } + + #[test] + fn t2v_8s_audio_on_is_120() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), None, Some(true)), 120); + } + + #[test] + fn t2v_4s_audio_off_is_40() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(4), None, Some(false)), 40); + } + + #[test] + fn t2v_8s_audio_off_is_80() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), None, Some(false)), 80); + } + + #[test] + fn t2v_8s_audio_on_4k_is_280() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::FourK), Some(true)), 280); + } + + #[test] + fn t2v_8s_audio_off_4k_is_240() { + assert_eq!(cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::FourK), Some(false)), 240); + } + + #[test] + fn t2v_defaults_are_8s_720p_audio_on_120() { + // duration=None→8s, resolution=None→720p, audio=None→on. + assert_eq!(cost_cents(Modality::TextToVideo, None, None, None), 120); + } + + #[test] + fn t2v_1080p_bills_same_as_720p() { + assert_eq!( + cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::TenEightyP), Some(true)), + cost_cents(Modality::TextToVideo, Some(8), Some(RouterResolution::SevenTwentyP), Some(true)), + ); + } + } + + mod image_to_video { + use super::*; + + #[test] + fn i2v_6s_audio_on_is_90() { + assert_eq!(cost_cents(Modality::ImageToVideo, Some(6), None, Some(true)), 90); + } + + #[test] + fn i2v_8s_audio_off_1080p_is_80() { + assert_eq!(cost_cents(Modality::ImageToVideo, Some(8), Some(RouterResolution::TenEightyP), Some(false)), 80); + } + } + + mod first_last_frame_to_video { + use super::*; + + #[test] + fn flf_6s_audio_on_is_90() { + assert_eq!(cost_cents(Modality::FirstLastFrame, Some(6), None, Some(true)), 90); + } + + #[test] + fn flf_8s_audio_on_4k_is_280() { + assert_eq!(cost_cents(Modality::FirstLastFrame, Some(8), Some(RouterResolution::FourK), Some(true)), 280); + } + } + + mod reference_to_video { + use super::*; + + #[test] + fn reference_8s_audio_on_1080p_is_120() { + assert_eq!(cost_cents(Modality::Reference, Some(8), Some(RouterResolution::TenEightyP), Some(true)), 120); + } + + #[test] + fn reference_4s_audio_off_720p_is_40() { + assert_eq!(cost_cents(Modality::Reference, Some(4), Some(RouterResolution::SevenTwentyP), Some(false)), 40); + } + } + + mod extend_video { + use super::*; + + #[test] + fn extend_7s_audio_on_is_105() { + assert_eq!(cost_cents(Modality::Extend, Some(7), None, Some(true)), 105); + } + + #[test] + fn extend_7s_audio_off_is_70() { + assert_eq!(cost_cents(Modality::Extend, Some(7), None, Some(false)), 70); + } + + #[test] + fn extend_8s_audio_on_is_120() { + assert_eq!(cost_cents(Modality::Extend, Some(8), None, Some(true)), 120); + } + + #[test] + fn extend_defaults_are_7s_audio_on_105() { + // duration=None→7s (fal's extend default), audio=None→on. + assert_eq!(cost_cents(Modality::Extend, None, None, None), 105); + } + } + + #[test] + fn t2v_i2v_flf_and_reference_price_identically() { + let expected = cost_cents(Modality::TextToVideo, Some(6), Some(RouterResolution::TenEightyP), Some(true)); + for modality in [Modality::ImageToVideo, Modality::FirstLastFrame, Modality::Reference] { + assert_eq!(cost_cents(modality, Some(6), Some(RouterResolution::TenEightyP), Some(true)), expected); + } + } + + #[test] + fn audio_costs_more_than_no_audio() { + assert!( + cost_cents(Modality::TextToVideo, Some(8), None, Some(false)) + < cost_cents(Modality::TextToVideo, Some(8), None, Some(true)) + ); + } + + fn cost_cents( + modality: Modality, + duration_seconds: Option, + resolution: Option, + generate_audio: Option, + ) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Fast, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + generate_audio, + ..Default::default() + }; + match modality { + Modality::TextToVideo => {} + Modality::ImageToVideo => { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + Modality::FirstLastFrame => { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/b.png".to_string())); + } + Modality::Reference => { + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])); + } + Modality::Extend => { + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/in.mp4".to_string()])); + } + } + let state = build_fal_veo_3p1_fast_state(b).expect("build state"); + FalVeo3p1FastCostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/mod.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/request.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/request.rs new file mode 100644 index 00000000..0b9c4c52 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_fast/request.rs @@ -0,0 +1,171 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::extend::veo_3p1_fast::api::Veo3p1FastExtendVideoRequest; +use fal_client::requests::api::video::image::veo_3p1_fast::api::Veo3p1FastImageToVideoRequest; +use fal_client::requests::api::video::images::veo_3p1_fast::api::Veo3p1FastFirstLastFrameToVideoRequest; +use fal_client::requests::api::video::reference::veo_3p1_fast::api::Veo3p1FastReferenceToVideoRequest; +use fal_client::requests::api::video::text::veo_3p1_fast::api::Veo3p1FastTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalVeo3p1FastMode { + TextToVideo(Veo3p1FastTextToVideoRequest), + ImageToVideo(Veo3p1FastImageToVideoRequest), + FirstLastFrameToVideo(Veo3p1FastFirstLastFrameToVideoRequest), + ReferenceToVideo(Veo3p1FastReferenceToVideoRequest), + ExtendVideo(Veo3p1FastExtendVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalVeo3p1FastRequestState { + pub mode: FalVeo3p1FastMode, +} + +impl FalVeo3p1FastRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalVeo3p1FastMode::TextToVideo(request) => send_request(request, client).await, + FalVeo3p1FastMode::ImageToVideo(request) => send_request(request, client).await, + FalVeo3p1FastMode::FirstLastFrameToVideo(request) => send_request(request, client).await, + FalVeo3p1FastMode::ReferenceToVideo(request) => send_request(request, client).await, + FalVeo3p1FastMode::ExtendVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + use test_data::web::video_urls::ANGRY_SHIBA_VIDEO_URL; + + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::test_helpers::get_fal_client; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_text_to_video_4s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("a candle flickering in the dark".to_string()), + duration_seconds: Some(4), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_image_to_video_6s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the dog leaps into the lake.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(6), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_reference_to_video_4s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the dog runs across a sunlit meadow".to_string()), + reference_images: Some(ImageListRef::Urls(vec![JUNO_AT_LAKE_IMAGE_URL.to_string()])), + duration_seconds: Some(4), + generate_audio: Some(false), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_extend_video_7s() { + let r = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("the scene continues naturally, keeping the same motion and style".to_string()), + reference_videos: Some(VideoListRef::Urls(vec![ANGRY_SHIBA_VIDEO_URL.to_string()])), + duration_seconds: Some(7), + generate_audio: Some(false), + ..builder() + }).await; + assert!(matches!(r, GenerateVideoResponse::Fal(_))); + } + + fn builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Fast, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + async fn run_pipeline(b: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_fal_client(); + let dor = b.build2().expect("build2"); + let req = match dor { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request"), + }; + req.send_request(&client).await.expect("send") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/build.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/build.rs new file mode 100644 index 00000000..74b4cb93 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/build.rs @@ -0,0 +1,550 @@ +use fal_client::requests::api::video::image::veo_3p1_lite::api::{ + Veo3p1LiteImageToVideoAspectRatio, Veo3p1LiteImageToVideoDuration, Veo3p1LiteImageToVideoRequest, + Veo3p1LiteImageToVideoResolution, +}; +use fal_client::requests::api::video::images::veo_3p1_lite::api::{ + Veo3p1LiteFirstLastFrameToVideoAspectRatio, Veo3p1LiteFirstLastFrameToVideoDuration, + Veo3p1LiteFirstLastFrameToVideoRequest, Veo3p1LiteFirstLastFrameToVideoResolution, +}; +use fal_client::requests::api::video::text::veo_3p1_lite::api::{ + Veo3p1LiteTextToVideoAspectRatio, Veo3p1LiteTextToVideoDuration, Veo3p1LiteTextToVideoRequest, + Veo3p1LiteTextToVideoResolution, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::veo_3p1_lite::request::{ + FalVeo3p1LiteMode, FalVeo3p1LiteRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + Auto, + SixteenByNine, + NineBySixteen, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + SevenTwentyP, + TenEightyP, +} + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanDuration { + Four, + Six, + Eight, +} + +pub fn build_fal_veo_3p1_lite( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_veo_3p1_lite_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalVeo3p1Lite(state))) +} + +pub(crate) fn build_fal_veo_3p1_lite_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Lite has no reference-to-video or extend-video endpoints on fal. + if has_reference_videos(&builder.reference_videos) { + return Err(unsupported( + "reference_videos", + "Veo 3.1 Lite does not support extend-video (reference videos)", + )); + } + if has_reference_images(&builder.reference_images) { + return Err(unsupported( + "reference_images", + "Veo 3.1 Lite does not support reference-to-video (reference images)", + )); + } + + let start = optional_url(builder.start_frame.clone())?; + let end = optional_url(builder.end_frame.clone())?; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let negative_prompt = builder.negative_prompt.clone(); + let generate_audio = builder.generate_audio; + + let mode = match (start, end) { + (None, None) => FalVeo3p1LiteMode::TextToVideo(Veo3p1LiteTextToVideoRequest { + prompt, + aspect_ratio: aspect_ratio.and_then(to_t2v_aspect_ratio), + duration: duration.map(to_t2v_duration), + resolution: resolution.map(to_t2v_resolution), + negative_prompt, + generate_audio, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + (Some(image_url), None) => FalVeo3p1LiteMode::ImageToVideo(Veo3p1LiteImageToVideoRequest { + prompt, + image_url, + aspect_ratio: aspect_ratio.map(to_i2v_aspect_ratio), + duration: duration.map(to_i2v_duration), + resolution: resolution.map(to_i2v_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }), + (Some(first_frame_url), Some(last_frame_url)) => FalVeo3p1LiteMode::FirstLastFrameToVideo( + Veo3p1LiteFirstLastFrameToVideoRequest { + prompt, + first_frame_url, + last_frame_url, + aspect_ratio: aspect_ratio.map(to_flf_aspect_ratio), + duration: duration.map(to_flf_duration), + resolution: resolution.map(to_flf_resolution), + generate_audio, + negative_prompt, + seed: None, + auto_fix: None, + safety_tolerance: None, + }, + ), + (None, Some(_)) => { + return Err(unsupported( + "end_frame", + "Veo 3.1 Lite requires a start_frame when end_frame is provided", + )); + } + }; + + Ok(FalVeo3p1LiteRequestState { mode }) +} + +fn optional_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + } +} + +fn has_reference_images(refs: &Option) -> bool { + match refs { + None => false, + Some(ImageListRef::Urls(urls)) => !urls.is_empty(), + Some(ImageListRef::MediaFileTokens(tokens)) => !tokens.is_empty(), + Some(ImageListRef::Sources(refs)) => !refs.is_empty(), + } +} + +fn has_reference_videos(refs: &Option) -> bool { + match refs { + None => false, + Some(VideoListRef::Urls(urls)) => !urls.is_empty(), + Some(VideoListRef::MediaFileTokens(tokens)) => !tokens.is_empty(), + Some(VideoListRef::Sources(refs)) => !refs.is_empty(), + } +} + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::Auto)), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("aspect_ratio", &format!("{:?}", other))) + } + _ => Ok(Some(Ar::Auto)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanResolution as R; + match resolution { + None => Ok(None), + Some(RouterResolution::SevenTwentyP) => Ok(Some(R::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(R::TenEightyP)), + // Lite has no 4k tier; the nearest supported resolution in either + // direction is 1080p. + Some(RouterResolution::FourK) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", "Veo 3.1 Lite does not support 4k")) + } + _ => Ok(Some(R::TenEightyP)), + }, + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("resolution", &format!("{:?}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(R::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(R::SevenTwentyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(4) => Ok(Some(PlanDuration::Four)), + Some(6) => Ok(Some(PlanDuration::Six)), + Some(8) => Ok(Some(PlanDuration::Eight)), + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(unsupported("duration_seconds", &format!("{}", other))) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(match other { + 0..=4 => PlanDuration::Four, + 5..=6 => PlanDuration::Six, + _ => PlanDuration::Eight, + })), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(match other { + 0..=5 => PlanDuration::Four, + 6..=7 => PlanDuration::Six, + _ => PlanDuration::Eight, + })), + }, + } +} + +fn unsupported(field: &'static str, value: &str) -> ArtcraftRouterError { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: value.to_string(), + }) +} + +// The Lite text-to-video endpoint has no `auto` aspect ratio; omit the field +// and let fal apply its own default (16:9). +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> Option { + match a { + PlanAspectRatio::Auto => None, + PlanAspectRatio::SixteenByNine => Some(Veo3p1LiteTextToVideoAspectRatio::SixteenByNine), + PlanAspectRatio::NineBySixteen => Some(Veo3p1LiteTextToVideoAspectRatio::NineBySixteen), + } +} + +fn to_t2v_duration(d: PlanDuration) -> Veo3p1LiteTextToVideoDuration { + match d { + PlanDuration::Four => Veo3p1LiteTextToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1LiteTextToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1LiteTextToVideoDuration::EightSeconds, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> Veo3p1LiteTextToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1LiteTextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1LiteTextToVideoResolution::TenEightyP, + } +} + +fn to_i2v_aspect_ratio(a: PlanAspectRatio) -> Veo3p1LiteImageToVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1LiteImageToVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1LiteImageToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1LiteImageToVideoAspectRatio::NineBySixteen, + } +} + +fn to_i2v_duration(d: PlanDuration) -> Veo3p1LiteImageToVideoDuration { + match d { + PlanDuration::Four => Veo3p1LiteImageToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1LiteImageToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1LiteImageToVideoDuration::EightSeconds, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> Veo3p1LiteImageToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1LiteImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1LiteImageToVideoResolution::TenEightyP, + } +} + +fn to_flf_aspect_ratio(a: PlanAspectRatio) -> Veo3p1LiteFirstLastFrameToVideoAspectRatio { + match a { + PlanAspectRatio::Auto => Veo3p1LiteFirstLastFrameToVideoAspectRatio::Auto, + PlanAspectRatio::SixteenByNine => Veo3p1LiteFirstLastFrameToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => Veo3p1LiteFirstLastFrameToVideoAspectRatio::NineBySixteen, + } +} + +fn to_flf_duration(d: PlanDuration) -> Veo3p1LiteFirstLastFrameToVideoDuration { + match d { + PlanDuration::Four => Veo3p1LiteFirstLastFrameToVideoDuration::FourSeconds, + PlanDuration::Six => Veo3p1LiteFirstLastFrameToVideoDuration::SixSeconds, + PlanDuration::Eight => Veo3p1LiteFirstLastFrameToVideoDuration::EightSeconds, + } +} + +fn to_flf_resolution(r: PlanResolution) -> Veo3p1LiteFirstLastFrameToVideoResolution { + match r { + PlanResolution::SevenTwentyP => Veo3p1LiteFirstLastFrameToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => Veo3p1LiteFirstLastFrameToVideoResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + + use super::*; + + const START_FRAME_URL: &str = "https://example.com/a.png"; + const END_FRAME_URL: &str = "https://example.com/b.png"; + const REFERENCE_IMAGE_URL: &str = "https://example.com/ref.png"; + const REFERENCE_VIDEO_URL: &str = "https://example.com/in.mp4"; + + mod mode_selection { + use super::*; + + #[test] + fn no_frames_picks_t2v() { + assert!(matches!(unwrap_mode(base_builder()), FalVeo3p1LiteMode::TextToVideo(_))); + } + + #[test] + fn start_only_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + assert!(matches!(unwrap_mode(b), FalVeo3p1LiteMode::ImageToVideo(_))); + } + + #[test] + fn start_and_end_picks_first_last_frame() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(matches!(unwrap_mode(b), FalVeo3p1LiteMode::FirstLastFrameToVideo(_))); + } + + #[test] + fn end_only_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + assert!(build_fal_veo_3p1_lite_state(b).is_err()); + } + } + + mod unsupported_modalities { + use super::*; + + #[test] + fn reference_images_are_rejected() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![REFERENCE_IMAGE_URL.to_string()])); + assert!(build_fal_veo_3p1_lite_state(b).is_err()); + } + + #[test] + fn reference_videos_are_rejected() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec![REFERENCE_VIDEO_URL.to_string()])); + assert!(build_fal_veo_3p1_lite_state(b).is_err()); + } + + #[test] + fn empty_reference_lists_are_ignored() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec![])); + b.reference_videos = Some(VideoListRef::Urls(vec![])); + assert!(matches!(unwrap_mode(b), FalVeo3p1LiteMode::TextToVideo(_))); + } + } + + mod duration_conversions { + use super::*; + + #[test] + fn duration_4s() { + let mut b = base_builder(); + b.duration_seconds = Some(4); + match unwrap_mode(b) { + FalVeo3p1LiteMode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1LiteTextToVideoDuration::FourSeconds))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn unsupported_duration_errors_with_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_3p1_lite_state(b).is_err()); + } + + #[test] + fn duration_5s_pay_more_upgrades_to_6() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + match unwrap_mode(b) { + FalVeo3p1LiteMode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1LiteTextToVideoDuration::SixSeconds))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn duration_5s_pay_less_downgrades_to_4() { + let mut b = base_builder(); + b.duration_seconds = Some(5); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + match unwrap_mode(b) { + FalVeo3p1LiteMode::TextToVideo(r) => { + assert!(matches!(r.duration, Some(Veo3p1LiteTextToVideoDuration::FourSeconds))); + } + _ => panic!("expected t2v"), + } + } + } + + mod resolution_conversions { + use super::*; + + #[test] + fn t2v_720p() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::SevenTwentyP); + match unwrap_mode(b) { + FalVeo3p1LiteMode::TextToVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1LiteTextToVideoResolution::SevenTwentyP))); + } + _ => panic!("expected t2v"), + } + } + + #[test] + fn four_k_errors_with_error_out() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_veo_3p1_lite_state(b).is_err()); + } + + #[test] + fn four_k_maps_to_1080p_with_mitigation() { + for strategy in [ + RequestMismatchMitigationStrategy::PayMoreUpgrade, + RequestMismatchMitigationStrategy::PayLessDowngrade, + ] { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::FourK); + b.request_mismatch_mitigation_strategy = strategy; + match unwrap_mode(b) { + FalVeo3p1LiteMode::TextToVideo(r) => { + assert!(matches!(r.resolution, Some(Veo3p1LiteTextToVideoResolution::TenEightyP))); + } + _ => panic!("expected t2v"), + } + } + } + } + + #[test] + fn t2v_auto_aspect_ratio_is_omitted() { + // Lite t2v has no `auto` wire value; Auto must map to None. + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + match unwrap_mode(b) { + FalVeo3p1LiteMode::TextToVideo(r) => assert!(r.aspect_ratio.is_none()), + _ => panic!("expected t2v"), + } + } + + #[test] + fn i2v_auto_aspect_ratio_maps_to_auto() { + let mut b = base_builder(); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + match unwrap_mode(b) { + FalVeo3p1LiteMode::ImageToVideo(r) => { + assert!(matches!(r.aspect_ratio, Some(Veo3p1LiteImageToVideoAspectRatio::Auto))); + } + _ => panic!("expected i2v"), + } + } + + #[test] + fn full_combinatorial_pass() { + let resolutions = [None, Some(RouterResolution::SevenTwentyP), Some(RouterResolution::TenEightyP)]; + let durations = [None, Some(4u16), Some(6), Some(8)]; + let aspect_ratios = [None, Some(RouterAspectRatio::Auto), Some(RouterAspectRatio::WideSixteenByNine), Some(RouterAspectRatio::TallNineBySixteen)]; + let audios = [None, Some(true), Some(false)]; + + let mut combos = 0; + for &resolution in &resolutions { + for &duration in &durations { + for &aspect_ratio in &aspect_ratios { + for &generate_audio in &audios { + for frames in [0, 1, 2] { + let mut b = base_builder(); + b.resolution = resolution; + b.duration_seconds = duration; + b.aspect_ratio = aspect_ratio; + b.generate_audio = generate_audio; + if frames >= 1 { + b.start_frame = Some(ImageRef::Url(START_FRAME_URL.to_string())); + } + if frames == 2 { + b.end_frame = Some(ImageRef::Url(END_FRAME_URL.to_string())); + } + assert!(build_fal_veo_3p1_lite_state(b).is_ok()); + combos += 1; + } + } + } + } + } + assert_eq!(combos, 3 * 4 * 4 * 3 * 3); + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Lite, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn unwrap_mode(b: GenerateVideoRequestBuilder) -> FalVeo3p1LiteMode { + build_fal_veo_3p1_lite_state(b).expect("build").mode + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/cost.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/cost.rs new file mode 100644 index 00000000..c6f09adf --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/cost.rs @@ -0,0 +1,174 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::providers::fal::veo_3p1_lite::request::{ + FalVeo3p1LiteMode, FalVeo3p1LiteRequestState, +}; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +#[derive(Clone, Debug)] +pub struct FalVeo3p1LiteCostState { + pub cost_in_usd_cents: u64, +} + +impl FalVeo3p1LiteCostState { + pub fn from_request(request: &FalVeo3p1LiteRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalVeo3p1LiteMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1LiteMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + FalVeo3p1LiteMode::FirstLastFrameToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_3p1_lite::build::build_fal_veo_3p1_lite_state; + + use super::*; + + // Veo 3.1 Lite pricing (both resolution and audio move the rate; no 4k): + // 720p: $0.03/sec (audio off), $0.05/sec (audio on) + // 1080p: $0.05/sec (audio off), $0.08/sec (audio on) + + mod text_to_video { + use super::*; + + #[test] + fn t2v_8s_audio_on_720p_is_40() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), Some(true), 0), 40); + } + + #[test] + fn t2v_8s_audio_off_720p_is_24() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), Some(false), 0), 24); + } + + #[test] + fn t2v_8s_audio_on_1080p_is_64() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::TenEightyP), Some(true), 0), 64); + } + + #[test] + fn t2v_8s_audio_off_1080p_is_40() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::TenEightyP), Some(false), 0), 40); + } + + #[test] + fn t2v_4s_audio_on_720p_is_20() { + assert_eq!(cost_cents(Some(4), Some(RouterResolution::SevenTwentyP), Some(true), 0), 20); + } + + #[test] + fn t2v_6s_audio_on_720p_is_30() { + assert_eq!(cost_cents(Some(6), Some(RouterResolution::SevenTwentyP), Some(true), 0), 30); + } + + #[test] + fn t2v_defaults_are_8s_720p_audio_on_40() { + // duration=None→8s, resolution=None→720p, audio=None→on. + assert_eq!(cost_cents(None, None, None, 0), 40); + } + } + + mod image_to_video { + use super::*; + + #[test] + fn i2v_8s_audio_off_720p_is_24() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), Some(false), 1), 24); + } + + #[test] + fn i2v_6s_audio_on_720p_is_30() { + assert_eq!(cost_cents(Some(6), Some(RouterResolution::SevenTwentyP), Some(true), 1), 30); + } + } + + mod first_last_frame_to_video { + use super::*; + + #[test] + fn flf_8s_audio_on_1080p_is_64() { + assert_eq!(cost_cents(Some(8), Some(RouterResolution::TenEightyP), Some(true), 2), 64); + } + + #[test] + fn flf_4s_audio_off_720p_is_12() { + assert_eq!(cost_cents(Some(4), Some(RouterResolution::SevenTwentyP), Some(false), 2), 12); + } + } + + #[test] + fn all_three_modes_price_identically() { + let t2v = cost_cents(Some(6), Some(RouterResolution::TenEightyP), Some(true), 0); + let i2v = cost_cents(Some(6), Some(RouterResolution::TenEightyP), Some(true), 1); + let flf = cost_cents(Some(6), Some(RouterResolution::TenEightyP), Some(true), 2); + assert_eq!(t2v, i2v); + assert_eq!(i2v, flf); + } + + #[test] + fn audio_costs_more_than_no_audio() { + assert!( + cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), Some(false), 0) + < cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), Some(true), 0) + ); + } + + #[test] + fn ten_eighty_costs_more_than_seven_twenty() { + assert!( + cost_cents(Some(8), Some(RouterResolution::SevenTwentyP), Some(true), 0) + < cost_cents(Some(8), Some(RouterResolution::TenEightyP), Some(true), 0) + ); + } + + fn cost_cents( + duration_seconds: Option, + resolution: Option, + generate_audio: Option, + frames: u8, + ) -> u64 { + let mut b = GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Lite, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + generate_audio, + ..Default::default() + }; + if frames >= 1 { + b.start_frame = Some(ImageRef::Url("https://example.com/a.png".to_string())); + } + if frames == 2 { + b.end_frame = Some(ImageRef::Url("https://example.com/b.png".to_string())); + } + let state = build_fal_veo_3p1_lite_state(b).expect("build state"); + FalVeo3p1LiteCostState::from_request(&state) + .estimate_cost() + .cost_in_usd_cents + .expect("cost") + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/mod.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/request.rs b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/request.rs new file mode 100644 index 00000000..cafc6d8c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/veo_3p1_lite/request.rs @@ -0,0 +1,166 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::veo_3p1_lite::api::Veo3p1LiteImageToVideoRequest; +use fal_client::requests::api::video::images::veo_3p1_lite::api::Veo3p1LiteFirstLastFrameToVideoRequest; +use fal_client::requests::api::video::text::veo_3p1_lite::api::Veo3p1LiteTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalVeo3p1LiteMode { + TextToVideo(Veo3p1LiteTextToVideoRequest), + ImageToVideo(Veo3p1LiteImageToVideoRequest), + FirstLastFrameToVideo(Veo3p1LiteFirstLastFrameToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalVeo3p1LiteRequestState { + pub mode: FalVeo3p1LiteMode, +} + +impl FalVeo3p1LiteRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalVeo3p1LiteMode::TextToVideo(request) => send_request(request, client).await, + FalVeo3p1LiteMode::ImageToVideo(request) => send_request(request, client).await, + FalVeo3p1LiteMode::FirstLastFrameToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use fal_client::creds::fal_api_key::FalApiKey; + use test_data::web::image_urls::{JUNO_AT_LAKE_IMAGE_URL, TALL_MOCHI_WITH_GLASSES_IMAGE_URL}; + + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::veo_3p1_lite::build::build_fal_veo_3p1_lite_state; + + use super::*; + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_text_to_video_4s() { + let state = build_state(GenerateVideoRequestBuilder { + prompt: Some("a candle flickering in the dark".to_string()), + duration_seconds: Some(4), + generate_audio: Some(false), + ..builder() + }); + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_image_to_video_4s() { + let state = build_state(GenerateVideoRequestBuilder { + prompt: Some("the dog leaps into the lake.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(4), + generate_audio: Some(false), + ..builder() + }); + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn live_first_last_frame_4s() { + let state = build_state(GenerateVideoRequestBuilder { + prompt: Some("a smooth transition between scenes".to_string()), + start_frame: Some(ImageRef::Url(TALL_MOCHI_WITH_GLASSES_IMAGE_URL.to_string())), + end_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + duration_seconds: Some(4), + generate_audio: Some(false), + ..builder() + }); + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + fn builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Veo3p1Lite, + provider: RouterProvider::Fal, + ..Default::default() + } + } + + fn build_state(b: GenerateVideoRequestBuilder) -> FalVeo3p1LiteRequestState { + build_fal_veo_3p1_lite_state(b).expect("build state") + } + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3/build.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/build.rs new file mode 100644 index 00000000..0fefdc64 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/build.rs @@ -0,0 +1,523 @@ +use fal_client::requests::api::video::image::vidu_q3::api::{ + ViduQ3ImageToVideoRequest, ViduQ3ImageToVideoResolution, +}; +use fal_client::requests::api::video::reference::vidu_q3_reference_to_video::api::{ + ViduQ3ReferenceToVideoAspectRatio, ViduQ3ReferenceToVideoRequest, ViduQ3ReferenceToVideoResolution, +}; +use fal_client::requests::api::video::reference::vidu_q3_reference_to_video_mix::api::{ + ViduQ3ReferenceToVideoMixAspectRatio, ViduQ3ReferenceToVideoMixRequest, + ViduQ3ReferenceToVideoMixResolution, +}; +use fal_client::requests::api::video::text::vidu_q3::api::{ + ViduQ3TextToVideoAspectRatio, ViduQ3TextToVideoRequest, ViduQ3TextToVideoResolution, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::vidu_q3::request::{ + FalViduQ3Mode, FalViduQ3RequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +const MAX_REFERENCE_IMAGES: usize = 4; +const MIN_DURATION_SECONDS: u16 = 1; +const MAX_DURATION_SECONDS: u16 = 16; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + SixteenByNine, + NineBySixteen, + FourByThree, + ThreeByFour, + Square, +} + +/// Vidu also offers 360p, but no `RouterResolution` maps to it (fal bills 360p +/// and 540p identically, so 540p is always the better pick). +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +pub fn build_fal_vidu_q3( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_vidu_q3_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalViduQ3(state))) +} + +pub(crate) fn build_fal_vidu_q3_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + reject_reference_videos(&builder.reference_videos)?; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let audio = builder.generate_audio; + let reference_image_urls = resolve_reference_image_urls(builder.reference_images.clone())?; + let start_image_url = optional_url(builder.start_frame.clone())?; + let end_image_url = optional_url(builder.end_frame.clone())?; + + // Dispatch: reference_images → reference-to-video; start_frame → image; else → text. + let mode = if !reference_image_urls.is_empty() { + if start_image_url.is_some() || end_image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: "Vidu Q3 reference-to-video cannot also accept a start_frame or end_frame".to_string(), + })); + } + if reference_image_urls.len() > MAX_REFERENCE_IMAGES { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: format!( + "Vidu Q3 supports at most {} reference images, got {}", + MAX_REFERENCE_IMAGES, + reference_image_urls.len(), + ), + })); + } + // The plain reference endpoint keeps a single subject consistent; the /mix + // variant blends multiple subjects, so 2+ references route there. + if reference_image_urls.len() == 1 { + FalViduQ3Mode::ReferenceToVideo(ViduQ3ReferenceToVideoRequest { + prompt, + reference_image_urls, + duration, + seed: None, + aspect_ratio: aspect_ratio.map(to_reference_aspect_ratio), + resolution: resolution.map(to_reference_resolution), + audio, + }) + } else { + FalViduQ3Mode::ReferenceToVideoMix(ViduQ3ReferenceToVideoMixRequest { + prompt, + reference_image_urls, + duration, + seed: None, + aspect_ratio: aspect_ratio.map(to_mix_aspect_ratio), + resolution: resolution.map(to_mix_resolution), + audio, + }) + } + } else if let Some(image_url) = start_image_url { + let i2v_resolution = resolution.map(to_i2v_resolution); + check_i2v_end_frame_resolution(i2v_resolution, end_image_url.is_some())?; + // Image-to-video has no aspect_ratio input — the output follows the start + // frame — so any requested aspect ratio is silently dropped here. + FalViduQ3Mode::ImageToVideo(ViduQ3ImageToVideoRequest { + prompt, + image_url, + end_image_url, + duration, + seed: None, + resolution: i2v_resolution, + audio, + }) + } else { + if end_image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Vidu Q3 requires a start_frame when end_frame is provided".to_string(), + })); + } + FalViduQ3Mode::TextToVideo(ViduQ3TextToVideoRequest { + prompt, + duration, + seed: None, + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + resolution: resolution.map(to_t2v_resolution), + audio, + }) + }; + + Ok(FalViduQ3RequestState { mode }) +} + +// ── Input helpers ── + +fn reject_reference_videos( + reference_videos: &Option, +) -> Result<(), ArtcraftRouterError> { + let has_reference_videos = match reference_videos { + None => false, + Some(VideoListRef::Urls(urls)) => !urls.is_empty(), + Some(VideoListRef::MediaFileTokens(tokens)) => !tokens.is_empty(), + Some(VideoListRef::Sources(refs)) => !refs.is_empty(), + }; + if has_reference_videos { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_videos", + value: "Vidu Q3 does not support video references".to_string(), + })); + } + Ok(()) +} + +fn resolve_reference_image_urls( + reference_images: Option, +) -> Result, ArtcraftRouterError> { + match reference_images { + None => Ok(vec![]), + Some(ImageListRef::Urls(urls)) => Ok(urls), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)) + } + Some(ImageListRef::Sources(refs)) => refs + .into_iter() + .map(|image_ref| match image_ref { + ImageRef::Url(url) => Ok(url), + _ => Err(ArtcraftRouterError::Client(ClientError::FalOnlySupportsUrls)), + }) + .collect(), + } +} + +/// fal rejects 360p image-to-video requests that include an end frame. +/// `plan_resolution` can't currently produce 360p, but guard anyway so a +/// future mapping change can't silently ship the rejected combination. +fn check_i2v_end_frame_resolution( + resolution: Option, + has_end_frame: bool, +) -> Result<(), ArtcraftRouterError> { + if has_end_frame && matches!(resolution, Some(ViduQ3ImageToVideoResolution::ThreeSixtyP)) { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: "Vidu Q3 image-to-video does not support 360p when an end_frame is provided".to_string(), + })); + } + Ok(()) +} + +// ── Plan helpers ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(Ar::FourByThree)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(Ar::ThreeByFour)), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::SixteenByNine)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + // Vidu doesn't offer 480p; 540p is the nearest supported size (and bills + // at the same per-second rate as 360p, so nothing cheaper is lost). + Some(RouterResolution::FourEightyP) => Ok(Some(PlanResolution::FiveFortyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(PlanResolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(PlanResolution::TenEightyP)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanResolution::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanResolution::FiveFortyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(seconds) if (MIN_DURATION_SECONDS..=MAX_DURATION_SECONDS).contains(&seconds) => { + Ok(Some(seconds as u8)) + } + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(other.clamp(MIN_DURATION_SECONDS, MAX_DURATION_SECONDS) as u8)) + } + }, + } +} + +// ── Leaf converters ── + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> ViduQ3TextToVideoAspectRatio { + match a { + PlanAspectRatio::SixteenByNine => ViduQ3TextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => ViduQ3TextToVideoAspectRatio::NineBySixteen, + PlanAspectRatio::FourByThree => ViduQ3TextToVideoAspectRatio::FourByThree, + PlanAspectRatio::ThreeByFour => ViduQ3TextToVideoAspectRatio::ThreeByFour, + PlanAspectRatio::Square => ViduQ3TextToVideoAspectRatio::Square, + } +} + +fn to_reference_aspect_ratio(a: PlanAspectRatio) -> ViduQ3ReferenceToVideoAspectRatio { + match a { + PlanAspectRatio::SixteenByNine => ViduQ3ReferenceToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => ViduQ3ReferenceToVideoAspectRatio::NineBySixteen, + PlanAspectRatio::FourByThree => ViduQ3ReferenceToVideoAspectRatio::FourByThree, + PlanAspectRatio::ThreeByFour => ViduQ3ReferenceToVideoAspectRatio::ThreeByFour, + PlanAspectRatio::Square => ViduQ3ReferenceToVideoAspectRatio::Square, + } +} + +fn to_mix_aspect_ratio(a: PlanAspectRatio) -> ViduQ3ReferenceToVideoMixAspectRatio { + match a { + PlanAspectRatio::SixteenByNine => ViduQ3ReferenceToVideoMixAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => ViduQ3ReferenceToVideoMixAspectRatio::NineBySixteen, + PlanAspectRatio::FourByThree => ViduQ3ReferenceToVideoMixAspectRatio::FourByThree, + PlanAspectRatio::ThreeByFour => ViduQ3ReferenceToVideoMixAspectRatio::ThreeByFour, + PlanAspectRatio::Square => ViduQ3ReferenceToVideoMixAspectRatio::Square, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> ViduQ3TextToVideoResolution { + match r { + PlanResolution::FiveFortyP => ViduQ3TextToVideoResolution::FiveFortyP, + PlanResolution::SevenTwentyP => ViduQ3TextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => ViduQ3TextToVideoResolution::TenEightyP, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> ViduQ3ImageToVideoResolution { + match r { + PlanResolution::FiveFortyP => ViduQ3ImageToVideoResolution::FiveFortyP, + PlanResolution::SevenTwentyP => ViduQ3ImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => ViduQ3ImageToVideoResolution::TenEightyP, + } +} + +fn to_reference_resolution(r: PlanResolution) -> ViduQ3ReferenceToVideoResolution { + match r { + PlanResolution::FiveFortyP => ViduQ3ReferenceToVideoResolution::FiveFortyP, + PlanResolution::SevenTwentyP => ViduQ3ReferenceToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => ViduQ3ReferenceToVideoResolution::TenEightyP, + } +} + +fn to_mix_resolution(r: PlanResolution) -> ViduQ3ReferenceToVideoMixResolution { + match r { + PlanResolution::FiveFortyP => ViduQ3ReferenceToVideoMixResolution::FiveFortyP, + PlanResolution::SevenTwentyP => ViduQ3ReferenceToVideoMixResolution::SevenTwentyP, + PlanResolution::TenEightyP => ViduQ3ReferenceToVideoMixResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + + use super::*; + + const START_URL: &str = "https://example.com/start.png"; + const END_URL: &str = "https://example.com/end.png"; + + mod dispatch_tests { + use super::*; + + #[test] + fn no_inputs_picks_t2v() { + let state = build_fal_vidu_q3_state(base_builder()).expect("build"); + assert!(matches!(state.mode, FalViduQ3Mode::TextToVideo(_))); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + let state = build_fal_vidu_q3_state(b).expect("build"); + assert!(matches!(state.mode, FalViduQ3Mode::ImageToVideo(_))); + } + + #[test] + fn start_and_end_frame_picks_i2v_with_end_image_url() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + b.end_frame = Some(ImageRef::Url(END_URL.to_string())); + let state = build_fal_vidu_q3_state(b).expect("build"); + let FalViduQ3Mode::ImageToVideo(req) = state.mode else { + panic!("expected ImageToVideo"); + }; + assert_eq!(req.image_url, START_URL); + assert_eq!(req.end_image_url.as_deref(), Some(END_URL)); + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url(END_URL.to_string())); + assert!(build_fal_vidu_q3_state(b).is_err()); + } + + #[test] + fn one_reference_image_picks_reference_to_video() { + let state = build_fal_vidu_q3_state(builder_with_references(1)).expect("build"); + assert!(matches!(state.mode, FalViduQ3Mode::ReferenceToVideo(_))); + } + + #[test] + fn three_reference_images_pick_reference_to_video_mix() { + let state = build_fal_vidu_q3_state(builder_with_references(3)).expect("build"); + let FalViduQ3Mode::ReferenceToVideoMix(req) = state.mode else { + panic!("expected ReferenceToVideoMix"); + }; + assert_eq!(req.reference_image_urls.len(), 3); + } + + #[test] + fn five_reference_images_error() { + assert!(build_fal_vidu_q3_state(builder_with_references(5)).is_err()); + } + + #[test] + fn reference_images_with_start_frame_error() { + let mut b = builder_with_references(2); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + assert!(build_fal_vidu_q3_state(b).is_err()); + } + + #[test] + fn reference_videos_error() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/a.mp4".to_string()])); + assert!(build_fal_vidu_q3_state(b).is_err()); + } + } + + mod plan_tests { + use super::*; + + #[test] + fn duration_20_errors_under_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_vidu_q3_state(b).is_err()); + } + + #[test] + fn duration_20_clamps_to_16_under_pay_less() { + let mut b = base_builder(); + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + let state = build_fal_vidu_q3_state(b).expect("build"); + let FalViduQ3Mode::TextToVideo(req) = state.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.duration, Some(16)); + } + + #[test] + fn resolution_480p_maps_to_540p() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::FourEightyP); + let state = build_fal_vidu_q3_state(b).expect("build"); + let FalViduQ3Mode::TextToVideo(req) = state.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.resolution, Some(ViduQ3TextToVideoResolution::FiveFortyP)); + } + + #[test] + fn i2v_aspect_ratio_is_silently_dropped() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + // Image-to-video has no aspect_ratio field; the request still builds. + let state = build_fal_vidu_q3_state(b).expect("build"); + assert!(matches!(state.mode, FalViduQ3Mode::ImageToVideo(_))); + } + + #[test] + fn i2v_360p_with_end_frame_is_rejected_by_guard() { + // 360p is unreachable from RouterResolution today, so exercise the + // guard directly against the fal-level resolution enum. + let result = check_i2v_end_frame_resolution( + Some(ViduQ3ImageToVideoResolution::ThreeSixtyP), + true, + ); + assert!(result.is_err()); + assert!(check_i2v_end_frame_resolution(Some(ViduQ3ImageToVideoResolution::ThreeSixtyP), false).is_ok()); + assert!(check_i2v_end_frame_resolution(Some(ViduQ3ImageToVideoResolution::SevenTwentyP), true).is_ok()); + } + + #[test] + fn generate_audio_propagates() { + let mut b = base_builder(); + b.generate_audio = Some(false); + let state = build_fal_vidu_q3_state(b).expect("build"); + let FalViduQ3Mode::TextToVideo(req) = state.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.audio, Some(false)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } + + fn builder_with_references(count: usize) -> GenerateVideoRequestBuilder { + let urls = (0..count) + .map(|i| format!("https://example.com/ref-{}.png", i)) + .collect(); + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(urls)); + b + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3/cost.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/cost.rs new file mode 100644 index 00000000..3d22cc29 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/cost.rs @@ -0,0 +1,141 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::providers::fal::vidu_q3::request::{ + FalViduQ3Mode, FalViduQ3RequestState, +}; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +#[derive(Clone, Debug)] +pub struct FalViduQ3CostState { + pub cost_in_usd_cents: u64, +} + +impl FalViduQ3CostState { + pub fn from_request(request: &FalViduQ3RequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalViduQ3Mode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalViduQ3Mode::ImageToVideo(req) => req.calculate_cost_in_cents(), + FalViduQ3Mode::ReferenceToVideo(req) => req.calculate_cost_in_cents(), + FalViduQ3Mode::ReferenceToVideoMix(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::vidu_q3::build::build_fal_vidu_q3_state; + + use super::*; + + // Pricing (from fal_client's vidu_q3 cost modules): + // 360p/540p: $0.07/sec → 5s = 35¢ + // 720p/1080p: $0.154/sec → 5s = 77¢, 10s = 154¢ (ceil to whole cents) + // fal defaults when unset: duration = 5s, resolution = 720p. + // All four modes (text/image/reference/mix) bill identically. + // + // NB: `build2()` isn't wired up for Vidu Q3 yet, so these tests go through + // `build_fal_vidu_q3_state()` directly. + + #[test] + fn t2v_default_settings_is_77() { + assert_eq!(cost_cents(base_builder(None, None)), 77); + } + + #[test] + fn t2v_5s_720p_is_77() { + assert_eq!(cost_cents(base_builder(Some(5), Some(RouterResolution::SevenTwentyP))), 77); + } + + #[test] + fn t2v_5s_540p_is_35() { + // RouterResolution::FourEightyP maps to Vidu's 540p. + assert_eq!(cost_cents(base_builder(Some(5), Some(RouterResolution::FourEightyP))), 35); + } + + #[test] + fn t2v_10s_1080p_is_154() { + assert_eq!(cost_cents(base_builder(Some(10), Some(RouterResolution::TenEightyP))), 154); + } + + #[test] + fn t2v_3s_720p_rounds_up_to_47() { + // 3 × 15.4¢ = 46.2¢ → 47¢. + assert_eq!(cost_cents(base_builder(Some(3), Some(RouterResolution::SevenTwentyP))), 47); + } + + #[test] + fn i2v_5s_720p_is_77() { + let mut b = base_builder(Some(5), Some(RouterResolution::SevenTwentyP)); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + assert_eq!(cost_cents(b), 77); + } + + #[test] + fn reference_5s_540p_is_35() { + let mut b = base_builder(Some(5), Some(RouterResolution::FourEightyP)); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/ref-0.png".to_string(), + ])); + assert_eq!(cost_cents(b), 35); + } + + #[test] + fn reference_mix_10s_1080p_is_154() { + let mut b = base_builder(Some(10), Some(RouterResolution::TenEightyP)); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/ref-0.png".to_string(), + "https://example.com/ref-1.png".to_string(), + "https://example.com/ref-2.png".to_string(), + ])); + assert_eq!(cost_cents(b), 154); + } + + #[test] + fn estimate_cost_forwards_cents() { + let estimate = FalViduQ3CostState { cost_in_usd_cents: 77 }.estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(77)); + assert_eq!(estimate.cost_in_credits, Some(77)); + assert!(!estimate.is_free); + } + + fn base_builder( + duration_seconds: Option, + resolution: Option, + ) -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + } + } + + fn cost_cents(builder: GenerateVideoRequestBuilder) -> u64 { + let state = build_fal_vidu_q3_state(builder).expect("build"); + FalViduQ3CostState::from_request(&state).cost_in_usd_cents + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3/mod.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3/request.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/request.rs new file mode 100644 index 00000000..4833e4bb --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3/request.rs @@ -0,0 +1,146 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::vidu_q3::api::ViduQ3ImageToVideoRequest; +use fal_client::requests::api::video::reference::vidu_q3_reference_to_video::api::ViduQ3ReferenceToVideoRequest; +use fal_client::requests::api::video::reference::vidu_q3_reference_to_video_mix::api::ViduQ3ReferenceToVideoMixRequest; +use fal_client::requests::api::video::text::vidu_q3::api::ViduQ3TextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalViduQ3Mode { + TextToVideo(ViduQ3TextToVideoRequest), + ImageToVideo(ViduQ3ImageToVideoRequest), + ReferenceToVideo(ViduQ3ReferenceToVideoRequest), + ReferenceToVideoMix(ViduQ3ReferenceToVideoMixRequest), +} + +#[derive(Clone, Debug)] +pub struct FalViduQ3RequestState { + pub mode: FalViduQ3Mode, +} + +impl FalViduQ3RequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalViduQ3Mode::TextToVideo(request) => send_request(request, client).await, + FalViduQ3Mode::ImageToVideo(request) => send_request(request, client).await, + FalViduQ3Mode::ReferenceToVideo(request) => send_request(request, client).await, + FalViduQ3Mode::ReferenceToVideoMix(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::vidu_q3::api::ViduQ3ImageToVideoResolution; + use fal_client::requests::api::video::text::vidu_q3::api::{ + ViduQ3TextToVideoAspectRatio, ViduQ3TextToVideoResolution, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_video_webhook() { + let state = FalViduQ3RequestState { + mode: FalViduQ3Mode::TextToVideo(ViduQ3TextToVideoRequest { + prompt: "a calm lake at sunrise".to_string(), + duration: Some(5), + seed: None, + aspect_ratio: Some(ViduQ3TextToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3TextToVideoResolution::SevenTwentyP), + audio: Some(false), + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_image_to_video_webhook() { + let state = FalViduQ3RequestState { + mode: FalViduQ3Mode::ImageToVideo(ViduQ3ImageToVideoRequest { + prompt: "the lake comes alive".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(5), + seed: None, + resolution: Some(ViduQ3ImageToVideoResolution::SevenTwentyP), + audio: Some(false), + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/build.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/build.rs new file mode 100644 index 00000000..a42054a0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/build.rs @@ -0,0 +1,409 @@ +use fal_client::requests::api::video::image::vidu_q3_turbo::api::{ + ViduQ3TurboImageToVideoRequest, ViduQ3TurboImageToVideoResolution, +}; +use fal_client::requests::api::video::text::vidu_q3_turbo::api::{ + ViduQ3TurboTextToVideoAspectRatio, ViduQ3TurboTextToVideoRequest, ViduQ3TurboTextToVideoResolution, +}; + +use crate::api::image_list_ref::ImageListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::build::optional_url; +use crate::generate::generate_video::providers::fal::vidu_q3_turbo::request::{ + FalViduQ3TurboMode, FalViduQ3TurboRequestState, +}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +const MIN_DURATION_SECONDS: u16 = 1; +const MAX_DURATION_SECONDS: u16 = 16; + +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanAspectRatio { + SixteenByNine, + NineBySixteen, + FourByThree, + ThreeByFour, + Square, +} + +/// Vidu also offers 360p, but no `RouterResolution` maps to it (fal bills 360p +/// and 540p identically, so 540p is always the better pick). +#[derive(Debug, Clone, Copy)] +pub(crate) enum PlanResolution { + FiveFortyP, + SevenTwentyP, + TenEightyP, +} + +pub fn build_fal_vidu_q3_turbo( + builder: GenerateVideoRequestBuilder, +) -> Result { + let state = build_fal_vidu_q3_turbo_state(builder)?; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::FalViduQ3Turbo(state))) +} + +pub(crate) fn build_fal_vidu_q3_turbo_state( + builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + reject_reference_videos(&builder.reference_videos)?; + reject_reference_images(&builder.reference_images)?; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio, strategy)?; + let resolution = plan_resolution(builder.resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds, strategy)?; + let prompt = builder.prompt.clone().unwrap_or_default(); + let audio = builder.generate_audio; + let start_image_url = optional_url(builder.start_frame.clone())?; + let end_image_url = optional_url(builder.end_frame.clone())?; + + // Dispatch: start_frame → image; else → text. Turbo has no reference-to-video + // endpoint (that's the non-turbo Vidu Q3 model). + let mode = if let Some(image_url) = start_image_url { + let i2v_resolution = resolution.map(to_i2v_resolution); + check_i2v_end_frame_resolution(i2v_resolution, end_image_url.is_some())?; + // Image-to-video has no aspect_ratio input — the output follows the start + // frame — so any requested aspect ratio is silently dropped here. + FalViduQ3TurboMode::ImageToVideo(ViduQ3TurboImageToVideoRequest { + prompt, + image_url, + end_image_url, + duration, + seed: None, + resolution: i2v_resolution, + audio, + }) + } else { + if end_image_url.is_some() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "end_frame", + value: "Vidu Q3 Turbo requires a start_frame when end_frame is provided".to_string(), + })); + } + FalViduQ3TurboMode::TextToVideo(ViduQ3TurboTextToVideoRequest { + prompt, + duration, + seed: None, + aspect_ratio: aspect_ratio.map(to_t2v_aspect_ratio), + resolution: resolution.map(to_t2v_resolution), + audio, + }) + }; + + Ok(FalViduQ3TurboRequestState { mode }) +} + +// ── Input helpers ── + +fn reject_reference_videos( + reference_videos: &Option, +) -> Result<(), ArtcraftRouterError> { + let has_reference_videos = match reference_videos { + None => false, + Some(VideoListRef::Urls(urls)) => !urls.is_empty(), + Some(VideoListRef::MediaFileTokens(tokens)) => !tokens.is_empty(), + Some(VideoListRef::Sources(refs)) => !refs.is_empty(), + }; + if has_reference_videos { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_videos", + value: "Vidu Q3 Turbo does not support video references".to_string(), + })); + } + Ok(()) +} + +fn reject_reference_images( + reference_images: &Option, +) -> Result<(), ArtcraftRouterError> { + let has_reference_images = match reference_images { + None => false, + Some(ImageListRef::Urls(urls)) => !urls.is_empty(), + Some(ImageListRef::MediaFileTokens(tokens)) => !tokens.is_empty(), + Some(ImageListRef::Sources(refs)) => !refs.is_empty(), + }; + if has_reference_images { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: "Vidu Q3 Turbo does not support reference images (use Vidu Q3 for reference-to-video)".to_string(), + })); + } + Ok(()) +} + +/// fal rejects 360p image-to-video requests that include an end frame. +/// `plan_resolution` can't currently produce 360p, but guard anyway so a +/// future mapping change can't silently ship the rejected combination. +fn check_i2v_end_frame_resolution( + resolution: Option, + has_end_frame: bool, +) -> Result<(), ArtcraftRouterError> { + if has_end_frame && matches!(resolution, Some(ViduQ3TurboImageToVideoResolution::ThreeSixtyP)) { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: "Vidu Q3 Turbo image-to-video does not support 360p when an end_frame is provided".to_string(), + })); + } + Ok(()) +} + +// ── Plan helpers ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + use PlanAspectRatio as Ar; + match aspect_ratio { + None => Ok(None), + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Ar::Square)), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Ar::SixteenByNine)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Ar::NineBySixteen)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(Ar::FourByThree)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(Ar::ThreeByFour)), + + Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => Ok(Some(Ar::SixteenByNine)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", other), + })) + } + _ => Ok(Some(Ar::SixteenByNine)), + }, + } +} + +fn plan_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + // Vidu doesn't offer 480p; 540p is the nearest supported size (and bills + // at the same per-second rate as 360p, so nothing cheaper is lost). + Some(RouterResolution::FourEightyP) => Ok(Some(PlanResolution::FiveFortyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(PlanResolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(PlanResolution::TenEightyP)), + + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => Ok(Some(PlanResolution::TenEightyP)), + RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(Some(PlanResolution::FiveFortyP)), + }, + } +} + +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match duration_seconds { + None => Ok(None), + Some(seconds) if (MIN_DURATION_SECONDS..=MAX_DURATION_SECONDS).contains(&seconds) => { + Ok(Some(seconds as u8)) + } + Some(other) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", other), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(other.clamp(MIN_DURATION_SECONDS, MAX_DURATION_SECONDS) as u8)) + } + }, + } +} + +// ── Leaf converters ── + +fn to_t2v_aspect_ratio(a: PlanAspectRatio) -> ViduQ3TurboTextToVideoAspectRatio { + match a { + PlanAspectRatio::SixteenByNine => ViduQ3TurboTextToVideoAspectRatio::SixteenByNine, + PlanAspectRatio::NineBySixteen => ViduQ3TurboTextToVideoAspectRatio::NineBySixteen, + PlanAspectRatio::FourByThree => ViduQ3TurboTextToVideoAspectRatio::FourByThree, + PlanAspectRatio::ThreeByFour => ViduQ3TurboTextToVideoAspectRatio::ThreeByFour, + PlanAspectRatio::Square => ViduQ3TurboTextToVideoAspectRatio::Square, + } +} + +fn to_t2v_resolution(r: PlanResolution) -> ViduQ3TurboTextToVideoResolution { + match r { + PlanResolution::FiveFortyP => ViduQ3TurboTextToVideoResolution::FiveFortyP, + PlanResolution::SevenTwentyP => ViduQ3TurboTextToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => ViduQ3TurboTextToVideoResolution::TenEightyP, + } +} + +fn to_i2v_resolution(r: PlanResolution) -> ViduQ3TurboImageToVideoResolution { + match r { + PlanResolution::FiveFortyP => ViduQ3TurboImageToVideoResolution::FiveFortyP, + PlanResolution::SevenTwentyP => ViduQ3TurboImageToVideoResolution::SevenTwentyP, + PlanResolution::TenEightyP => ViduQ3TurboImageToVideoResolution::TenEightyP, + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_video_model::RouterVideoModel; + + use super::*; + + const START_URL: &str = "https://example.com/start.png"; + const END_URL: &str = "https://example.com/end.png"; + + mod dispatch_tests { + use super::*; + + #[test] + fn no_inputs_picks_t2v() { + let state = build_fal_vidu_q3_turbo_state(base_builder()).expect("build"); + assert!(matches!(state.mode, FalViduQ3TurboMode::TextToVideo(_))); + } + + #[test] + fn start_frame_picks_i2v() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + let state = build_fal_vidu_q3_turbo_state(b).expect("build"); + assert!(matches!(state.mode, FalViduQ3TurboMode::ImageToVideo(_))); + } + + #[test] + fn start_and_end_frame_picks_i2v_with_end_image_url() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + b.end_frame = Some(ImageRef::Url(END_URL.to_string())); + let state = build_fal_vidu_q3_turbo_state(b).expect("build"); + let FalViduQ3TurboMode::ImageToVideo(req) = state.mode else { + panic!("expected ImageToVideo"); + }; + assert_eq!(req.image_url, START_URL); + assert_eq!(req.end_image_url.as_deref(), Some(END_URL)); + } + + #[test] + fn end_frame_without_start_frame_errors() { + let mut b = base_builder(); + b.end_frame = Some(ImageRef::Url(END_URL.to_string())); + assert!(build_fal_vidu_q3_turbo_state(b).is_err()); + } + + #[test] + fn reference_images_error() { + let mut b = base_builder(); + b.reference_images = Some(ImageListRef::Urls(vec!["https://example.com/ref.png".to_string()])); + assert!(build_fal_vidu_q3_turbo_state(b).is_err()); + } + + #[test] + fn reference_videos_error() { + let mut b = base_builder(); + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/a.mp4".to_string()])); + assert!(build_fal_vidu_q3_turbo_state(b).is_err()); + } + } + + mod plan_tests { + use super::*; + + #[test] + fn duration_20_errors_under_error_out() { + let mut b = base_builder(); + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_fal_vidu_q3_turbo_state(b).is_err()); + } + + #[test] + fn duration_20_clamps_to_16_under_pay_less() { + let mut b = base_builder(); + b.duration_seconds = Some(20); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + let state = build_fal_vidu_q3_turbo_state(b).expect("build"); + let FalViduQ3TurboMode::TextToVideo(req) = state.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.duration, Some(16)); + } + + #[test] + fn resolution_480p_maps_to_540p() { + let mut b = base_builder(); + b.resolution = Some(RouterResolution::FourEightyP); + let state = build_fal_vidu_q3_turbo_state(b).expect("build"); + let FalViduQ3TurboMode::TextToVideo(req) = state.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.resolution, Some(ViduQ3TurboTextToVideoResolution::FiveFortyP)); + } + + #[test] + fn i2v_aspect_ratio_is_silently_dropped() { + let mut b = base_builder(); + b.start_frame = Some(ImageRef::Url(START_URL.to_string())); + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + // Image-to-video has no aspect_ratio field; the request still builds. + let state = build_fal_vidu_q3_turbo_state(b).expect("build"); + assert!(matches!(state.mode, FalViduQ3TurboMode::ImageToVideo(_))); + } + + #[test] + fn i2v_360p_with_end_frame_is_rejected_by_guard() { + // 360p is unreachable from RouterResolution today, so exercise the + // guard directly against the fal-level resolution enum. + let result = check_i2v_end_frame_resolution( + Some(ViduQ3TurboImageToVideoResolution::ThreeSixtyP), + true, + ); + assert!(result.is_err()); + assert!(check_i2v_end_frame_resolution(Some(ViduQ3TurboImageToVideoResolution::ThreeSixtyP), false).is_ok()); + assert!(check_i2v_end_frame_resolution(Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP), true).is_ok()); + } + + #[test] + fn generate_audio_propagates() { + let mut b = base_builder(); + b.generate_audio = Some(false); + let state = build_fal_vidu_q3_turbo_state(b).expect("build"); + let FalViduQ3TurboMode::TextToVideo(req) = state.mode else { + panic!("expected TextToVideo"); + }; + assert_eq!(req.audio, Some(false)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3Turbo, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + ..Default::default() + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/cost.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/cost.rs new file mode 100644 index 00000000..a9d85326 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/cost.rs @@ -0,0 +1,126 @@ +use fal_client::requests::traits::fal_request_cost_calculator_trait::FalRequestCostCalculator; + +use crate::generate::generate_video::providers::fal::vidu_q3_turbo::request::{ + FalViduQ3TurboMode, FalViduQ3TurboRequestState, +}; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +#[derive(Clone, Debug)] +pub struct FalViduQ3TurboCostState { + pub cost_in_usd_cents: u64, +} + +impl FalViduQ3TurboCostState { + pub fn from_request(request: &FalViduQ3TurboRequestState) -> Self { + // Cost math is owned by fal_client's per-endpoint + // `FalRequestCostCalculator` implementations. The router state just + // forwards the result so router cost ≡ fal_client cost by construction. + let cost_in_usd_cents = match &request.mode { + FalViduQ3TurboMode::TextToVideo(req) => req.calculate_cost_in_cents(), + FalViduQ3TurboMode::ImageToVideo(req) => req.calculate_cost_in_cents(), + }; + Self { cost_in_usd_cents } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(self.cost_in_usd_cents), + cost_in_usd_cents: Some(self.cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::fal::vidu_q3_turbo::build::build_fal_vidu_q3_turbo_state; + + use super::*; + + // Pricing (from fal_client's vidu_q3_turbo cost modules; half the Vidu Q3 rate): + // 360p/540p: $0.035/sec → 5s = 17.5¢ → 18¢ + // 720p/1080p: $0.077/sec → 5s = 38.5¢ → 39¢, 10s = 77¢ (ceil to whole cents) + // fal defaults when unset: duration = 5s, resolution = 720p. + // Both modes (text/image) bill identically. + // + // NB: `build2()` isn't wired up for Vidu Q3 Turbo yet, so these tests go + // through `build_fal_vidu_q3_turbo_state()` directly. + + #[test] + fn t2v_default_settings_is_39() { + assert_eq!(cost_cents(base_builder(None, None)), 39); + } + + #[test] + fn t2v_5s_720p_rounds_up_to_39() { + // 5 × 7.7¢ = 38.5¢ → 39¢. + assert_eq!(cost_cents(base_builder(Some(5), Some(RouterResolution::SevenTwentyP))), 39); + } + + #[test] + fn t2v_5s_540p_rounds_up_to_18() { + // RouterResolution::FourEightyP maps to Vidu's 540p; 5 × 3.5¢ = 17.5¢ → 18¢. + assert_eq!(cost_cents(base_builder(Some(5), Some(RouterResolution::FourEightyP))), 18); + } + + #[test] + fn t2v_10s_1080p_is_77() { + assert_eq!(cost_cents(base_builder(Some(10), Some(RouterResolution::TenEightyP))), 77); + } + + #[test] + fn t2v_3s_720p_rounds_up_to_24() { + // 3 × 7.7¢ = 23.1¢ → 24¢. + assert_eq!(cost_cents(base_builder(Some(3), Some(RouterResolution::SevenTwentyP))), 24); + } + + #[test] + fn i2v_5s_720p_is_39() { + let mut b = base_builder(Some(5), Some(RouterResolution::SevenTwentyP)); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + assert_eq!(cost_cents(b), 39); + } + + #[test] + fn i2v_10s_540p_is_35() { + let mut b = base_builder(Some(10), Some(RouterResolution::FourEightyP)); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + assert_eq!(cost_cents(b), 35); + } + + #[test] + fn estimate_cost_forwards_cents() { + let estimate = FalViduQ3TurboCostState { cost_in_usd_cents: 39 }.estimate_cost(); + assert_eq!(estimate.cost_in_usd_cents, Some(39)); + assert_eq!(estimate.cost_in_credits, Some(39)); + assert!(!estimate.is_free); + } + + fn base_builder( + duration_seconds: Option, + resolution: Option, + ) -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::ViduQ3Turbo, + provider: RouterProvider::Fal, + prompt: Some("test".to_string()), + duration_seconds, + resolution, + ..Default::default() + } + } + + fn cost_cents(builder: GenerateVideoRequestBuilder) -> u64 { + let state = build_fal_vidu_q3_turbo_state(builder).expect("build"); + FalViduQ3TurboCostState::from_request(&state).cost_in_usd_cents + } +} diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/mod.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/request.rs b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/request.rs new file mode 100644 index 00000000..c250d946 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/fal/vidu_q3_turbo/request.rs @@ -0,0 +1,140 @@ +use std::fmt::Debug; +use std::sync::Arc; + +use fal_client::requests::api::video::image::vidu_q3_turbo::api::ViduQ3TurboImageToVideoRequest; +use fal_client::requests::api::video::text::vidu_q3_turbo::api::ViduQ3TurboTextToVideoRequest; +use fal_client::requests::traits::fal_endpoint_trait::FalEndpoint; + +use crate::client::router_fal_client::RouterFalClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::{ + FalVideoResponsePayload, GenerateVideoResponse, +}; + +#[derive(Clone, Debug)] +pub enum FalViduQ3TurboMode { + TextToVideo(ViduQ3TurboTextToVideoRequest), + ImageToVideo(ViduQ3TurboImageToVideoRequest), +} + +#[derive(Clone, Debug)] +pub struct FalViduQ3TurboRequestState { + pub mode: FalViduQ3TurboMode, +} + +impl FalViduQ3TurboRequestState { + pub async fn send(&self, client: &RouterFalClient) -> Result { + match &self.mode { + FalViduQ3TurboMode::TextToVideo(request) => send_request(request, client).await, + FalViduQ3TurboMode::ImageToVideo(request) => send_request(request, client).await, + } + } +} + +// ── Helpers ── + +async fn send_request(request: &T, client: &RouterFalClient) -> Result +where + T: FalEndpoint + Clone + Debug + Send + Sync + 'static, +{ + let outbound: Arc = Arc::new(request.clone()); + let payload = send_fal_request(request, client).await?; + Ok(GenerateVideoResponse::Fal(FalVideoResponsePayload { + request_id: payload.request_id, + gateway_request_id: payload.gateway_request_id, + maybe_status_url: payload.status_url, + maybe_response_url: payload.response_url, + maybe_outbound_request: Some(outbound), + })) +} + +struct FalResponseIds { + request_id: Option, + gateway_request_id: Option, + status_url: Option, + response_url: Option, +} + +async fn send_fal_request( + request: &T, + client: &RouterFalClient, +) -> Result { + if let Some(webhook_url) = &client.webhook_url { + let response = request.send_webhook_request(&client.api_key, webhook_url).await?; + Ok(FalResponseIds { + request_id: response.request_id, + gateway_request_id: response.gateway_request_id, + status_url: None, + response_url: None, + }) + } else { + let response = request.send_queue_request(&client.api_key).await?; + Ok(FalResponseIds { + request_id: Some(response.request_id), + gateway_request_id: None, + status_url: Some(response.status_url), + response_url: Some(response.response_url), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use fal_client::creds::fal_api_key::FalApiKey; + use fal_client::requests::api::video::image::vidu_q3_turbo::api::ViduQ3TurboImageToVideoResolution; + use fal_client::requests::api::video::text::vidu_q3_turbo::api::{ + ViduQ3TurboTextToVideoAspectRatio, ViduQ3TurboTextToVideoResolution, + }; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + fn read_fal_api_key() -> FalApiKey { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read fal_api_key.txt"); + FalApiKey::from_str(secret.trim()) + } + + fn client_with_webhook() -> RouterFalClient { + RouterFalClient::new_with_webhook( + read_fal_api_key(), + "https://example.com/fal-webhook-test".to_string(), + ) + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_text_to_video_webhook() { + let state = FalViduQ3TurboRequestState { + mode: FalViduQ3TurboMode::TextToVideo(ViduQ3TurboTextToVideoRequest { + prompt: "a calm lake at sunrise".to_string(), + duration: Some(5), + seed: None, + aspect_ratio: Some(ViduQ3TurboTextToVideoAspectRatio::SixteenByNine), + resolution: Some(ViduQ3TurboTextToVideoResolution::SevenTwentyP), + audio: Some(false), + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs cost + async fn send_image_to_video_webhook() { + let state = FalViduQ3TurboRequestState { + mode: FalViduQ3TurboMode::ImageToVideo(ViduQ3TurboImageToVideoRequest { + prompt: "the lake comes alive".to_string(), + image_url: JUNO_AT_LAKE_IMAGE_URL.to_string(), + end_image_url: None, + duration: Some(5), + seed: None, + resolution: Some(ViduQ3TurboImageToVideoResolution::SevenTwentyP), + audio: Some(false), + }), + }; + let response = state.send(&client_with_webhook()).await.expect("send should succeed"); + let payload = response.get_fal_payload().expect("expected Fal payload"); + assert!(payload.request_id.is_some() || payload.gateway_request_id.is_some()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/mod.rs b/crates/router/src/generate/generate_video/providers/gmicloud/mod.rs new file mode 100644 index 00000000..f76c64a3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/mod.rs @@ -0,0 +1,2 @@ +pub mod seedance_2p0_g; +pub mod seedance_2p0_fast_g; diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/build.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/build.rs new file mode 100644 index 00000000..60e103c8 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/build.rs @@ -0,0 +1,372 @@ +use gmicloud_client::requests::api::video::seedance_2_0_fast_260128::api::{ + Seedance20FastRatio, Seedance20FastRequest, Seedance20FastResolution, +}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::audio_ref::AudioRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::api::video_ref::VideoRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::{ClientError, ClientType}; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_fast_g::request::GmiCloudSeedance2p0UltraFastRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_gmicloud_seedance_2p0_u_fast( + mut builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let ratio = plan_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_resolution(builder.resolution.take(), strategy)?; + let duration = builder.duration_seconds.take().map(|d| (d as u8).clamp(4, 15)); + let prompt = builder.prompt.take().unwrap_or_default(); + + let first_frame = resolve_url(builder.start_frame.take())?; + let last_frame = resolve_url(builder.end_frame.take())?; + let reference_images = resolve_url_list_from_images(builder.reference_images.take())?; + let reference_videos = resolve_url_list_from_videos(builder.reference_videos.take())?; + let reference_audios = resolve_url_list_from_audios(builder.reference_audio.take())?; + + let request = Seedance20FastRequest { + prompt, + duration, + resolution, + ratio, + seed: None, + watermark: Some(false), + generate_audio: Some(true), + web_search: None, + first_frame, + last_frame, + reference_images, + reference_videos, + reference_audios, + reference_asset_ids: None, + }; + + let state = GmiCloudSeedance2p0UltraFastRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::GmiCloudSeedance2p0UltraFast(state))) +} + +fn plan_ratio( + aspect_ratio: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match aspect_ratio { + None | Some(RouterAspectRatio::Auto) | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) | Some(RouterAspectRatio::Auto4k) => Ok(None), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Seedance20FastRatio::Landscape16x9)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Seedance20FastRatio::Portrait9x16)), + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Seedance20FastRatio::Square)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(Seedance20FastRatio::Standard4x3)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(Seedance20FastRatio::Portrait3x4)), + Some(RouterAspectRatio::WideTwentyOneByNine) | Some(RouterAspectRatio::TallNineByTwentyOne) => { + Ok(Some(Seedance20FastRatio::UltraWide21x9)) + } + Some(RouterAspectRatio::WideThreeByTwo) | Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::TallFourByFive) | Some(RouterAspectRatio::TallTwoByThree) => { + Ok(Some(Seedance20FastRatio::Adaptive)) + } + } +} + +fn plan_resolution( + resolution: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + Some(RouterResolution::FourEightyP) => Ok(Some(Seedance20FastResolution::FourEightyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(Seedance20FastResolution::SevenTwentyP)), + // Fast model doesn't support 1080p — fall back to 720p + Some(RouterResolution::TenEightyP) => Ok(Some(Seedance20FastResolution::SevenTwentyP)), + Some(RouterResolution::HalfK) | Some(RouterResolution::OneK) => Ok(Some(Seedance20FastResolution::FourEightyP)), + Some(RouterResolution::TwoK) | Some(RouterResolution::ThreeK) | Some(RouterResolution::FourK) => { + Ok(Some(Seedance20FastResolution::SevenTwentyP)) + } + } +} + +fn resolve_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "start_frame/end_frame", + value: "GmiCloud only supports image URLs, not media file tokens".to_string(), + })) + } + Some(ImageRef::LocalPath(_)) | Some(ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })) + } + } +} + +fn resolve_url_list_from_images( + list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match list_ref { + None => Ok(None), + Some(ImageListRef::Urls(urls)) => Ok(Some(urls)), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: "GmiCloud only supports image URLs, not media file tokens".to_string(), + })) + } + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })); + } + } + } + Ok(Some(urls)) + } + } +} + +fn resolve_url_list_from_videos( + list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match list_ref { + None => Ok(None), + Some(VideoListRef::Urls(urls)) => Ok(Some(urls)), + Some(VideoListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_videos", + value: "GmiCloud only supports video URLs, not media file tokens".to_string(), + })) + } + Some(VideoListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for video_ref in refs { + match video_ref { + VideoRef::Url(url) => urls.push(url), + VideoRef::MediaFileToken(_) | VideoRef::LocalPath(_) | VideoRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })); + } + } + } + Ok(Some(urls)) + } + } +} + +#[cfg(test)] +mod tests { + use gmicloud_client::requests::api::video::seedance_2_0_fast_260128::api::{ + Seedance20FastRatio, Seedance20FastResolution, + }; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::api::audio_list_ref::AudioListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("fast test".to_string()); })); + assert_eq!(req.request.prompt, "fast test"); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(8); })); + assert_eq!(req.request.duration, Some(8)); + } + + #[test] + fn duration_clamped_to_min() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(2); })); + assert_eq!(req.request.duration, Some(4)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(30); })); + assert_eq!(req.request.duration, Some(15)); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(Seedance20FastResolution::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(Seedance20FastResolution::SevenTwentyP)); + } + + #[test] + fn res_1080p_falls_back_to_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(Seedance20FastResolution::SevenTwentyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn landscape_16x9() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.ratio, Some(Seedance20FastRatio::Landscape16x9)); + } + + #[test] + fn square() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.ratio, Some(Seedance20FastRatio::Square)); + } + + #[test] + fn auto_maps_to_none() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Auto); })); + assert_eq!(req.request.ratio, None); + } + } + + mod media_url_tests { + use super::*; + + #[test] + fn start_frame_url_passed_through() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/img.png".to_string())); + })); + assert_eq!(req.request.first_frame, Some("https://example.com/img.png".to_string())); + } + + #[test] + fn media_file_token_rejected() { + let result = build_gmicloud_seedance_2p0_u_fast(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_x".to_string()))), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_urls_passed_through() { + let urls = vec!["https://example.com/ref.png".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::Urls(urls.clone())); + })); + assert_eq!(req.request.reference_images, Some(urls)); + } + + #[test] + fn reference_video_urls_passed_through() { + let urls = vec!["https://example.com/ref.mp4".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_videos = Some(VideoListRef::Urls(urls.clone())); + })); + assert_eq!(req.request.reference_videos, Some(urls)); + } + + #[test] + fn reference_audio_urls_passed_through() { + let urls = vec!["https://example.com/ref.wav".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_audio = Some(AudioListRef::Urls(urls.clone())); + })); + assert_eq!(req.request.reference_audios, Some(urls)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::GmiCloud, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> GmiCloudSeedance2p0UltraFastRequestState { + let result = build_gmicloud_seedance_2p0_u_fast(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::GmiCloudSeedance2p0UltraFast(state)) => state, + _ => panic!("expected GmiCloudSeedance2p0FastG request"), + } + } +} + +fn resolve_url_list_from_audios( + list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match list_ref { + None => Ok(None), + Some(AudioListRef::Urls(urls)) => Ok(Some(urls)), + Some(AudioListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_audios", + value: "GmiCloud only supports audio URLs, not media file tokens".to_string(), + })) + } + Some(AudioListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for audio_ref in refs { + match audio_ref { + AudioRef::Url(url) => urls.push(url), + AudioRef::MediaFileToken(_) | AudioRef::LocalPath(_) | AudioRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })); + } + } + } + Ok(Some(urls)) + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/cost.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/cost.rs new file mode 100644 index 00000000..9562d37c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/cost.rs @@ -0,0 +1,125 @@ +use gmicloud_client::traits::gmicloud_request_cost_calculator_trait::GmiCloudRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_fast_g::request::GmiCloudSeedance2p0UltraFastRequestState; + +pub struct GmiCloudSeedance2p0UltraFastCostState { + request: GmiCloudSeedance2p0UltraFastRequestState, +} + +impl GmiCloudSeedance2p0UltraFastCostState { + pub fn from_request(request: &GmiCloudSeedance2p0UltraFastRequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cost_in_usd_cents = self.request.request.calculate_cost_in_cents(); + + VideoGenerationCostEstimate { + cost_in_credits: None, + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn default_5s() { + // 720p: 3.1 ¢/s * 5 = 15.5 → ceil = 16¢ + assert_eq!(cost_cents(None, 5), 16); + } + + #[test] + fn default_10s() { + // 3.1 * 10 = 31¢ + assert_eq!(cost_cents(None, 10), 31); + } + + #[test] + fn default_15s() { + // 3.1 * 15 = 46.5 → ceil = 47¢ + assert_eq!(cost_cents(None, 15), 47); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn p480_5s() { + // 1.0 * 5 = 5¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5), 5); + } + + #[test] + fn p480_10s() { + // 1.0 * 10 = 10¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10), 10); + } + + #[test] + fn p480_15s() { + // 1.0 * 15 = 15¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15), 15); + } + } + + mod relative_pricing { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 10); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10); + assert!(c480 < c720, "480p ({c480}) should be < 720p ({c720})"); + } + + #[test] + fn fast_cheaper_than_standard() { + let fast = cost_cents(Some(RouterResolution::SevenTwentyP), 10); + let standard = { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Ultra, + provider: RouterProvider::GmiCloud, + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(10), + video_batch_count: Some(1), + ..Default::default() + }; + builder.build2().unwrap().estimate_cost().unwrap().cost_in_usd_cents.unwrap() + }; + assert!(fast < standard, "Fast ({fast}¢) should be < Standard ({standard}¢)"); + } + } + + fn cost_cents(resolution: Option, duration_seconds: u16) -> u64 { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::GmiCloud, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(1), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/mod.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/request.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/request.rs new file mode 100644 index 00000000..557e9577 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_fast_g/request.rs @@ -0,0 +1,100 @@ +use gmicloud_client::requests::api::video::seedance_2_0_fast_260128::api::Seedance20FastRequest; + +use crate::client::router_gmicloud_client::RouterGmiCloudClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + GenerateVideoResponse, GmiCloudVideoResponsePayload, +}; + +#[derive(Clone, Debug)] +pub struct GmiCloudSeedance2p0UltraFastRequestState { + pub request: Seedance20FastRequest, +} + +impl GmiCloudSeedance2p0UltraFastRequestState { + pub async fn send(&self, client: &RouterGmiCloudClient) -> Result { + let response = self.request.send_request(&client.api_key) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::GmiCloud(err)))?; + + Ok(GenerateVideoResponse::GmiCloud(GmiCloudVideoResponsePayload { + request_id: response.request_id, + })) + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_gmicloud_client::RouterGmiCloudClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use gmicloud_client::creds::gmicloud_api_key::GmiCloudApiKey; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_text_to_video_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A shiba inu playing in autumn leaves.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..gmicloud_fast_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::GmiCloud(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog starts running and splashing in the lake.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(5), + ..gmicloud_fast_builder() + }).await; + println!("response: {:?}", response); + assert!(matches!(response, GenerateVideoResponse::GmiCloud(_))); + } + + fn gmicloud_fast_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0UltraFast, + provider: RouterProvider::GmiCloud, + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_gmicloud_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/gmicloud_api_key.txt") + .expect("Failed to read GmiCloud API key"); + let api_key = GmiCloudApiKey::from_str(&secret); + RouterClient::GmiCloud(RouterGmiCloudClient::new(api_key)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_gmicloud_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (GmiCloud skips draft)"), + }; + let response = request.send_request(&client).await.expect("send_request should succeed"); + match &response { + GenerateVideoResponse::GmiCloud(p) => println!("request_id={}", p.request_id), + other => println!("response: {:?}", other), + } + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/build.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/build.rs new file mode 100644 index 00000000..cd86b65d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/build.rs @@ -0,0 +1,404 @@ +use gmicloud_client::requests::api::video::seedance_2_0_260128::api::{ + Seedance20Ratio, Seedance20Request, Seedance20Resolution, +}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::audio_ref::AudioRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::api::video_ref::VideoRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::{ClientError, ClientType}; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_g::request::GmiCloudSeedance2p0UltraRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn build_gmicloud_seedance_2p0_u( + mut builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let ratio = plan_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_resolution(builder.resolution.take(), strategy)?; + let duration = builder.duration_seconds.take().map(|d| (d as u8).clamp(4, 15)); + let prompt = builder.prompt.take().unwrap_or_default(); + + let first_frame = resolve_url(builder.start_frame.take())?; + let last_frame = resolve_url(builder.end_frame.take())?; + let reference_images = resolve_url_list_from_images(builder.reference_images.take())?; + let reference_videos = resolve_url_list_from_videos(builder.reference_videos.take())?; + let reference_audios = resolve_url_list_from_audios(builder.reference_audio.take())?; + + let request = Seedance20Request { + prompt, + duration, + resolution, + ratio, + seed: None, + watermark: Some(false), + generate_audio: Some(true), + web_search: None, + first_frame, + last_frame, + reference_images, + reference_videos, + reference_audios, + reference_asset_ids: None, + }; + + let state = GmiCloudSeedance2p0UltraRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::GmiCloudSeedance2p0Ultra(state))) +} + +fn plan_ratio( + aspect_ratio: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match aspect_ratio { + None | Some(RouterAspectRatio::Auto) | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) | Some(RouterAspectRatio::Auto4k) => Ok(None), + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => Ok(Some(Seedance20Ratio::Landscape16x9)), + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => Ok(Some(Seedance20Ratio::Portrait9x16)), + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => Ok(Some(Seedance20Ratio::Square)), + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(Seedance20Ratio::Standard4x3)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(Seedance20Ratio::Portrait3x4)), + Some(RouterAspectRatio::WideTwentyOneByNine) | Some(RouterAspectRatio::TallNineByTwentyOne) => { + Ok(Some(Seedance20Ratio::UltraWide21x9)) + } + Some(RouterAspectRatio::WideThreeByTwo) | Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::TallFourByFive) | Some(RouterAspectRatio::TallTwoByThree) => { + Ok(Some(Seedance20Ratio::Adaptive)) + } + } +} + +fn plan_resolution( + resolution: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + Some(RouterResolution::FourEightyP) => Ok(Some(Seedance20Resolution::FourEightyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(Seedance20Resolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(Seedance20Resolution::TenEightyP)), + Some(RouterResolution::HalfK) | Some(RouterResolution::OneK) => Ok(Some(Seedance20Resolution::FourEightyP)), + Some(RouterResolution::TwoK) | Some(RouterResolution::ThreeK) | Some(RouterResolution::FourK) => { + Ok(Some(Seedance20Resolution::TenEightyP)) + } + } +} + +fn resolve_url(image_ref: Option) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(url)), + Some(ImageRef::MediaFileToken(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "start_frame/end_frame", + value: "GmiCloud only supports image URLs, not media file tokens".to_string(), + })) + } + Some(ImageRef::LocalPath(_)) | Some(ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })) + } + } +} + +fn resolve_url_list_from_images( + list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match list_ref { + None => Ok(None), + Some(ImageListRef::Urls(urls)) => Ok(Some(urls)), + Some(ImageListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_images", + value: "GmiCloud only supports image URLs, not media file tokens".to_string(), + })) + } + Some(ImageListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + ImageRef::MediaFileToken(_) | ImageRef::LocalPath(_) | ImageRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })); + } + } + } + Ok(Some(urls)) + } + } +} + +fn resolve_url_list_from_videos( + list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match list_ref { + None => Ok(None), + Some(VideoListRef::Urls(urls)) => Ok(Some(urls)), + Some(VideoListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_videos", + value: "GmiCloud only supports video URLs, not media file tokens".to_string(), + })) + } + Some(VideoListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for video_ref in refs { + match video_ref { + VideoRef::Url(url) => urls.push(url), + VideoRef::MediaFileToken(_) | VideoRef::LocalPath(_) | VideoRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })); + } + } + } + Ok(Some(urls)) + } + } +} + +#[cfg(test)] +mod tests { + use gmicloud_client::requests::api::video::seedance_2_0_260128::api::{ + Seedance20Ratio, Seedance20Resolution, + }; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::api::audio_list_ref::AudioListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + use super::*; + + mod field_conversions { + use super::*; + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test prompt".to_string()); })); + assert_eq!(req.request.prompt, "test prompt"); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(10); })); + assert_eq!(req.request.duration, Some(10)); + } + + #[test] + fn duration_clamped_to_min() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(1); })); + assert_eq!(req.request.duration, Some(4)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration, Some(15)); + } + + #[test] + fn duration_none_stays_none() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = None; })); + assert_eq!(req.request.duration, None); + } + } + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn landscape_16x9() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.ratio, Some(Seedance20Ratio::Landscape16x9)); + } + + #[test] + fn portrait_9x16() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); })); + assert_eq!(req.request.ratio, Some(Seedance20Ratio::Portrait9x16)); + } + + #[test] + fn square() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.ratio, Some(Seedance20Ratio::Square)); + } + + #[test] + fn four_by_three() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideFourByThree); })); + assert_eq!(req.request.ratio, Some(Seedance20Ratio::Standard4x3)); + } + + #[test] + fn unsupported_maps_to_adaptive() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideThreeByTwo); })); + assert_eq!(req.request.ratio, Some(Seedance20Ratio::Adaptive)); + } + + #[test] + fn auto_maps_to_none() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Auto); })); + assert_eq!(req.request.ratio, None); + } + } + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(Seedance20Resolution::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(Seedance20Resolution::SevenTwentyP)); + } + + #[test] + fn res_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(Seedance20Resolution::TenEightyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + mod media_url_tests { + use super::*; + + #[test] + fn start_frame_url_passed_through() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + })); + assert_eq!(req.request.first_frame, Some("https://example.com/start.png".to_string())); + } + + #[test] + fn media_file_token_rejected_for_start_frame() { + let result = build_gmicloud_seedance_2p0_u(GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test".to_string()))), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_image_urls_passed_through() { + let urls = vec!["https://example.com/a.png".to_string(), "https://example.com/b.png".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::Urls(urls.clone())); + })); + assert_eq!(req.request.reference_images, Some(urls)); + } + + #[test] + fn reference_image_tokens_rejected() { + let result = build_gmicloud_seedance_2p0_u(GenerateVideoRequestBuilder { + reference_images: Some(ImageListRef::MediaFileTokens(vec![MediaFileToken::new("mf_a".to_string())])), + ..base_builder() + }); + assert!(result.is_err()); + } + + #[test] + fn reference_video_urls_passed_through() { + let urls = vec!["https://example.com/v.mp4".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_videos = Some(VideoListRef::Urls(urls.clone())); + })); + assert_eq!(req.request.reference_videos, Some(urls)); + } + + #[test] + fn reference_audio_urls_passed_through() { + let urls = vec!["https://example.com/a.wav".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_audio = Some(AudioListRef::Urls(urls.clone())); + })); + assert_eq!(req.request.reference_audios, Some(urls)); + } + } + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Ultra, + provider: RouterProvider::GmiCloud, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut builder = base_builder(); + f(&mut builder); + builder + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> GmiCloudSeedance2p0UltraRequestState { + let result = build_gmicloud_seedance_2p0_u(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::GmiCloudSeedance2p0Ultra(state)) => state, + _ => panic!("expected GmiCloudSeedance2p0G request"), + } + } +} + +fn resolve_url_list_from_audios( + list_ref: Option, +) -> Result>, ArtcraftRouterError> { + match list_ref { + None => Ok(None), + Some(AudioListRef::Urls(urls)) => Ok(Some(urls)), + Some(AudioListRef::MediaFileTokens(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "reference_audios", + value: "GmiCloud only supports audio URLs, not media file tokens".to_string(), + })) + } + Some(AudioListRef::Sources(refs)) => { + let mut urls = Vec::with_capacity(refs.len()); + for audio_ref in refs { + match audio_ref { + AudioRef::Url(url) => urls.push(url), + AudioRef::MediaFileToken(_) | AudioRef::LocalPath(_) | AudioRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GmiCloud, + })); + } + } + } + Ok(Some(urls)) + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/cost.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/cost.rs new file mode 100644 index 00000000..d31e1c32 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/cost.rs @@ -0,0 +1,133 @@ +use gmicloud_client::traits::gmicloud_request_cost_calculator_trait::GmiCloudRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_g::request::GmiCloudSeedance2p0UltraRequestState; + +pub struct GmiCloudSeedance2p0UltraCostState { + request: GmiCloudSeedance2p0UltraRequestState, +} + +impl GmiCloudSeedance2p0UltraCostState { + pub fn from_request(request: &GmiCloudSeedance2p0UltraRequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let cost_in_usd_cents = self.request.request.calculate_cost_in_cents(); + + VideoGenerationCostEstimate { + cost_in_credits: None, + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + mod pricing_720p { + use super::*; + + #[test] + fn default_5s() { + // 720p: 5.2 ¢/s * 5 = 26¢ + assert_eq!(cost_cents(None, 5), 26); + } + + #[test] + fn default_10s() { + assert_eq!(cost_cents(None, 10), 52); + } + + #[test] + fn explicit_720p_5s() { + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5), 26); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn p480_5s() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5), 12); + } + + #[test] + fn p480_10s() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10), 24); + } + + #[test] + fn p480_15s() { + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15), 36); + } + } + + mod pricing_1080p { + use super::*; + + #[test] + fn p1080_5s() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 5), 58); + } + + #[test] + fn p1080_10s() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 10), 116); + } + + #[test] + fn p1080_15s() { + assert_eq!(cost_cents(Some(RouterResolution::TenEightyP), 15), 174); + } + } + + mod relative_pricing { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let c480 = cost_cents(Some(RouterResolution::FourEightyP), 10); + let c720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10); + let c1080 = cost_cents(Some(RouterResolution::TenEightyP), 10); + assert!(c480 < c720, "480p ({c480}) should be < 720p ({c720})"); + assert!(c720 < c1080, "720p ({c720}) should be < 1080p ({c1080})"); + } + + #[test] + fn longer_duration_costs_more() { + let c5 = cost_cents(None, 5); + let c10 = cost_cents(None, 10); + let c15 = cost_cents(None, 15); + assert!(c5 < c10); + assert!(c10 < c15); + } + } + + fn cost_cents(resolution: Option, duration_seconds: u16) -> u64 { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Ultra, + provider: RouterProvider::GmiCloud, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(1), + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/mod.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/request.rs b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/request.rs new file mode 100644 index 00000000..f7224d7c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/gmicloud/seedance_2p0_g/request.rs @@ -0,0 +1,98 @@ +use gmicloud_client::requests::api::video::seedance_2_0_260128::api::Seedance20Request; + +use crate::client::router_gmicloud_client::RouterGmiCloudClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + GenerateVideoResponse, GmiCloudVideoResponsePayload, +}; + +#[derive(Clone, Debug)] +pub struct GmiCloudSeedance2p0UltraRequestState { + pub request: Seedance20Request, +} + +impl GmiCloudSeedance2p0UltraRequestState { + pub async fn send(&self, client: &RouterGmiCloudClient) -> Result { + let response = self.request.send_request(&client.api_key) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::GmiCloud(err)))?; + + Ok(GenerateVideoResponse::GmiCloud(GmiCloudVideoResponsePayload { + request_id: response.request_id, + })) + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_gmicloud_client::RouterGmiCloudClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use gmicloud_client::creds::gmicloud_api_key::GmiCloudApiKey; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_text_to_video_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..gmicloud_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::GmiCloud(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog starts running and splashing in the lake.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(5), + ..gmicloud_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::GmiCloud(_))); + } + + fn gmicloud_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Ultra, + provider: RouterProvider::GmiCloud, + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_gmicloud_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/gmicloud_api_key.txt") + .expect("Failed to read GmiCloud API key"); + let api_key = GmiCloudApiKey::from_str(&secret); + RouterClient::GmiCloud(RouterGmiCloudClient::new(api_key)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_gmicloud_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (GmiCloud skips draft)"), + }; + let response = request.send_request(&client).await.expect("send_request should succeed"); + match &response { + GenerateVideoResponse::GmiCloud(p) => println!("request_id={}", p.request_id), + other => println!("response: {:?}", other), + } + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/build.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/build.rs new file mode 100644 index 00000000..0e72a927 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/build.rs @@ -0,0 +1,576 @@ +use log::info; + +use grok_api_client::api::requests::videos::video_generation::video_generation::{ + VideoGenerationRequest as GrokVideoGenerationRequest, + VideoImageSource as GrokVideoImageSource, +}; +use grok_api_client::api::types::video_types::video_aspect_ratio::VideoAspectRatio as GrokAspectRatio; +use grok_api_client::api::types::video_types::video_resolution::VideoResolution as GrokResolution; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::{ClientError, ClientType}; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video::request::GrokApiGrokImagineVideoRequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Builds a Grok Imagine Video request from the generic GenerateVideoRequestBuilder. +/// +/// xAI's grok-imagine-video accepts: +/// - `image` (single source image, image-to-video mode) OR `reference_images` (multi-image +/// reference-to-video). These two are mutually exclusive per xAI's API. +/// - Aspect ratio, resolution (480p/720p), duration (1–15s), prompt. +/// +/// Fields that Grok DOESN'T accept (`end_frame`, `reference_videos`, `reference_audio`, +/// and `MediaFileToken`-style image refs) are silently dropped with an info-level log. +/// `LocalPath`/`Bytes` image refs are the exception: they error with +/// `ProviderCannotUseLocalMedia`, since silently dropping the caller's local media +/// would produce a video that ignores their input. +/// Same goes for the `start_frame` + `reference_images` conflict — we prefer +/// `start_frame` (image-to-video) and drop `reference_images`. This keeps the +/// pipeline tolerant when callers fan a single builder out to multiple providers +/// with different capabilities. +pub fn build_grok_api_grok_imagine_video( + mut builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Scalar fields. + let prompt = builder.prompt.take().unwrap_or_default(); + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy); + let resolution = plan_resolution(builder.resolution.take(), strategy); + let duration = builder.duration_seconds.take().map(|d| (d as u32).clamp(1, 15)); + + // Wholly-unsupported fields → drop with a log so it shows up in operator traces. + log_and_drop_end_frame(builder.end_frame.take()); + log_and_drop_reference_videos(builder.reference_videos.take()); + log_and_drop_reference_audio(builder.reference_audio.take()); + + // Image sources: prefer start_frame (image-to-video). If both start_frame and + // reference_images are supplied, drop reference_images (xAI rejects the + // combination on the wire). + let start_frame = resolve_url_to_image_source(builder.start_frame.take())?; + let reference_images_supplied = builder.reference_images.take(); + + let (image, reference_images) = match (start_frame, reference_images_supplied) { + (Some(img), Some(refs)) => { + info!( + "grok_imagine_video: both start_frame and reference_images supplied — \ + preferring start_frame (image-to-video). Dropping {} reference images.", + refs.len(), + ); + (Some(img), None) + } + (Some(img), None) => (Some(img), None), + (None, Some(refs)) => (None, resolve_url_list_to_image_sources(refs)?), + (None, None) => (None, None), + }; + + let request = GrokVideoGenerationRequest { + prompt, + model: None, // defaults to grok-imagine-video in the client + image, + reference_images, + aspect_ratio, + duration, + resolution, + user: None, + }; + + let state = GrokApiGrokImagineVideoRequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::GrokApiGrokImagineVideo(state), + )) +} + +// ── Field planners ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Option { + // xAI supports exactly: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3. + // Auto / unsupported ratios fall back to the closest match (or None → xAI default 16:9). + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => None, + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Some(GrokAspectRatio::Square) + } + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Some(GrokAspectRatio::Landscape16x9) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Some(GrokAspectRatio::Portrait9x16) + } + + Some(RouterAspectRatio::WideFourByThree) => Some(GrokAspectRatio::Landscape4x3), + Some(RouterAspectRatio::TallThreeByFour) => Some(GrokAspectRatio::Portrait3x4), + + Some(RouterAspectRatio::WideThreeByTwo) => Some(GrokAspectRatio::Landscape3x2), + Some(RouterAspectRatio::TallTwoByThree) => Some(GrokAspectRatio::Portrait2x3), + + // No exact xAI match — pick the closest cardinal direction. + Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::WideTwentyOneByNine) => Some(GrokAspectRatio::Landscape16x9), + Some(RouterAspectRatio::TallFourByFive) + | Some(RouterAspectRatio::TallNineByTwentyOne) => Some(GrokAspectRatio::Portrait9x16), + } +} + +fn plan_resolution( + resolution: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Option { + // Grok supports 480p and 720p only (1080p is downsized to 720p per xAI docs). + match resolution { + None => None, + Some(RouterResolution::FourEightyP) => Some(GrokResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP) => Some(GrokResolution::SevenTwentyP), + // Higher-than-720p requests get clamped to 720p (Grok's cap). + Some(RouterResolution::TenEightyP) + | Some(RouterResolution::TwoK) + | Some(RouterResolution::ThreeK) + | Some(RouterResolution::FourK) => Some(GrokResolution::SevenTwentyP), + // Lower-than-480p requests get bumped to 480p (Grok's floor). + Some(RouterResolution::HalfK) | Some(RouterResolution::OneK) => { + Some(GrokResolution::FourEightyP) + } + } +} + +// ── Image source resolvers (silent drops for unsupported variants) ── + +fn resolve_url_to_image_source( + image_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(GrokVideoImageSource::Url(url))), + Some(ImageRef::MediaFileToken(token)) => { + info!( + "grok_imagine_video: dropping MediaFileToken {:?} for start_frame — \ + Grok only accepts public URLs. Resolve the token to a URL upstream if needed.", + token, + ); + Ok(None) + } + Some(ImageRef::LocalPath(_)) | Some(ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GrokApi, + })) + } + } +} + +fn resolve_url_list_to_image_sources( + list_ref: ImageListRef, +) -> Result>, ArtcraftRouterError> { + match list_ref { + ImageListRef::Urls(urls) if urls.is_empty() => Ok(None), + ImageListRef::Urls(urls) => { + Ok(Some(urls.into_iter().map(GrokVideoImageSource::Url).collect())) + } + ImageListRef::MediaFileTokens(tokens) => { + info!( + "grok_imagine_video: dropping {} MediaFileToken reference image(s) — \ + Grok only accepts public URLs. Resolve tokens to URLs upstream if needed.", + tokens.len(), + ); + Ok(None) + } + ImageListRef::Sources(refs) => { + let mut urls = Vec::with_capacity(refs.len()); + let mut dropped_tokens = 0usize; + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + ImageRef::MediaFileToken(_) => dropped_tokens += 1, + ImageRef::LocalPath(_) | ImageRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GrokApi, + })); + } + } + } + if dropped_tokens > 0 { + info!( + "grok_imagine_video: dropping {} MediaFileToken reference image(s) — \ + Grok only accepts public URLs. Resolve tokens to URLs upstream if needed.", + dropped_tokens, + ); + } + resolve_url_list_to_image_sources(ImageListRef::Urls(urls)) + } + } +} + +// ── Drop-with-log helpers for fields Grok doesn't accept at all ── + +fn log_and_drop_end_frame(end_frame: Option) { + if end_frame.is_some() { + info!("grok_imagine_video: dropping end_frame — Grok doesn't support end-frame keyframes."); + } +} + +fn log_and_drop_reference_videos(refs: Option) { + if let Some(refs) = refs { + info!( + "grok_imagine_video: dropping {} reference video(s) — Grok doesn't accept reference videos.", + refs.len(), + ); + } +} + +fn log_and_drop_reference_audio(refs: Option) { + if let Some(refs) = refs { + info!( + "grok_imagine_video: dropping {} reference audio clip(s) — Grok doesn't accept reference audio.", + refs.len(), + ); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::api::audio_list_ref::AudioListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + // ── Field passthrough ── + + mod field_conversions { + use super::*; + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test prompt".to_string()); })); + assert_eq!(req.request.prompt, "test prompt"); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(8); })); + assert_eq!(req.request.duration, Some(8)); + } + + #[test] + fn duration_clamped_to_min() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(0); })); + assert_eq!(req.request.duration, Some(1)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration, Some(15)); + } + + #[test] + fn duration_none_stays_none() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = None; })); + assert_eq!(req.request.duration, None); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn square() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Square)); + } + + #[test] + fn landscape_16x9() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + } + + #[test] + fn portrait_9x16() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait9x16)); + } + + #[test] + fn landscape_4x3() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideFourByThree); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape4x3)); + } + + #[test] + fn portrait_3x4() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallThreeByFour); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait3x4)); + } + + #[test] + fn landscape_3x2() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideThreeByTwo); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape3x2)); + } + + #[test] + fn portrait_2x3() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallTwoByThree); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait2x3)); + } + + #[test] + fn auto_maps_to_none() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Auto); })); + assert_eq!(req.request.aspect_ratio, None); + } + + #[test] + fn unsupported_wide_falls_back_to_16x9() { + let req = unwrap_request(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideTwentyOneByNine); + })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + } + + #[test] + fn unsupported_tall_falls_back_to_9x16() { + let req = unwrap_request(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::TallNineByTwentyOne); + })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait9x16)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(GrokResolution::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + } + + #[test] + fn res_1080p_clamps_to_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + } + + #[test] + fn res_4k_clamps_to_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourK); })); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + } + + #[test] + fn res_1k_bumps_to_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::OneK); })); + assert_eq!(req.request.resolution, Some(GrokResolution::FourEightyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Image source plumbing (graceful — never errors) ── + + mod image_tests { + use super::*; + + #[test] + fn start_frame_url_becomes_image() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + })); + match &req.request.image { + Some(GrokVideoImageSource::Url(u)) => assert_eq!(u, "https://example.com/start.png"), + other => panic!("expected Url variant, got {:?}", other), + } + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn start_frame_media_file_token_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test".to_string()))); + })); + // Dropped, request still builds successfully with no image. + assert!(req.request.image.is_none()); + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn reference_image_urls_passed_through() { + let urls = vec!["https://example.com/a.png".to_string(), "https://example.com/b.png".to_string()]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::Urls(urls.clone())); + })); + let refs = req.request.reference_images.expect("reference_images should be set"); + assert_eq!(refs.len(), 2); + assert!(req.request.image.is_none()); + } + + #[test] + fn reference_image_tokens_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ])); + })); + // All tokens dropped; reference_images becomes None. + assert!(req.request.reference_images.is_none()); + assert!(req.request.image.is_none()); + } + + #[test] + fn start_frame_and_reference_images_together_prefers_start_frame() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/ref1.png".to_string(), + "https://example.com/ref2.png".to_string(), + ])); + })); + // start_frame wins; reference_images dropped (mutually exclusive on the wire). + match &req.request.image { + Some(GrokVideoImageSource::Url(u)) => assert_eq!(u, "https://example.com/start.png"), + other => panic!("expected start_frame URL, got {:?}", other), + } + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn empty_reference_image_url_list_becomes_none() { + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::Urls(vec![])); + })); + assert!(req.request.reference_images.is_none()); + } + } + + // ── Unsupported fields are silently dropped, not rejected ── + + mod unsupported_fields_graceful { + use super::*; + + #[test] + fn end_frame_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + })); + // Request still builds; Grok's request body has no end_frame field. + assert!(req.request.image.is_none()); + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn reference_videos_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/v.mp4".to_string()])); + })); + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn reference_audio_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.reference_audio = Some(AudioListRef::Urls(vec!["https://example.com/a.wav".to_string()])); + })); + // No audio field on Grok; just gone. + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn kitchen_sink_with_every_unsupported_field_still_succeeds() { + // Worst-case builder fanned out from a multi-provider context. Grok + // should keep what it can and drop the rest without erroring. + let req = unwrap_request(make_builder(|b| { + b.prompt = Some("kitchen sink".to_string()); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/ref.png".to_string(), + ])); + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/v.mp4".to_string()])); + b.reference_audio = Some(AudioListRef::Urls(vec!["https://example.com/a.wav".to_string()])); + b.resolution = Some(RouterResolution::SevenTwentyP); + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + b.duration_seconds = Some(8); + })); + // Kept: prompt + start_frame + resolution + aspect_ratio + duration. + assert_eq!(req.request.prompt, "kitchen sink"); + assert!(matches!( + req.request.image, + Some(GrokVideoImageSource::Url(_)) + )); + // Dropped because start_frame won the image-source contest. + assert!(req.request.reference_images.is_none()); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + assert_eq!(req.request.duration, Some(8)); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo, + provider: RouterProvider::GrokApi, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut b = base_builder(); + f(&mut b); + b + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> GrokApiGrokImagineVideoRequestState { + let result = build_grok_api_grok_imagine_video(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::GrokApiGrokImagineVideo(s)) => s, + _ => panic!("expected GrokApiGrokImagineVideo request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/cost.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/cost.rs new file mode 100644 index 00000000..79c93819 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/cost.rs @@ -0,0 +1,188 @@ +use grok_api_client::api::traits::grok_request_cost_calculator_trait::GrokRequestCostCalculator; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video::request::GrokApiGrokImagineVideoRequestState; + +pub struct GrokApiGrokImagineVideoCostState { + request: GrokApiGrokImagineVideoRequestState, +} + +impl GrokApiGrokImagineVideoCostState { + pub fn from_request(request: &GrokApiGrokImagineVideoRequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + // grok_api_client's GrokRequestCostCalculator does the math: + // - Output: resolution × duration (50 mills/s @ 480p, 70 mills/s @ 720p) + // - Input: 2 mills × source image count + // No source-video duration to factor in for `video_generation` — it's + // text/image → video, not edit/extension. + let cost_in_usd_cents = self.request.request.calculate_cost_in_cents(); + + VideoGenerationCostEstimate { + cost_in_credits: None, + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // Pricing reference (from grok_api_client/cost.rs, mirrors xAI's table): + // Output: 480p 50 mills/s ($0.05/s) + // 720p 70 mills/s ($0.07/s) + // Input: 2 mills per source image ($0.002/img) + // + // Cost in cents = ceil(mills / 10). + + mod pricing_720p { + use super::*; + + #[test] + fn five_s_no_image_ref() { + // 70 × 5 = 350 mills → 35¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, None, None), 35); + } + + #[test] + fn ten_s_no_image_ref() { + // 70 × 10 = 700 mills → 70¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None), 70); + } + + #[test] + fn fifteen_s_no_image_ref() { + // 70 × 15 = 1050 mills → 105¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, None, None), 105); + } + } + + mod pricing_480p { + use super::*; + + #[test] + fn five_s_no_image_ref() { + // 50 × 5 = 250 mills → 25¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, None, None), 25); + } + + #[test] + fn ten_s_no_image_ref() { + // 50 × 10 = 500 mills → 50¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, None, None), 50); + } + + #[test] + fn fifteen_s_no_image_ref() { + // 50 × 15 = 750 mills → 75¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, None, None), 75); + } + } + + mod image_inputs_add_to_cost { + use super::*; + + #[test] + fn single_start_frame_image_adds_2_mills() { + // 5s @ 720p output 350 mills + 1 input image 2 mills = 352 mills → 36¢ (ceil) + let cents = cost_cents( + Some(RouterResolution::SevenTwentyP), + 5, + Some(ImageRef::Url("https://example.com/a.png".to_string())), + None, + ); + assert_eq!(cents, 36); + } + + #[test] + fn three_reference_images_adds_6_mills() { + // 5s @ 720p output 350 mills + 3 input images 6 mills = 356 mills → 36¢ (ceil) + let cents = cost_cents( + Some(RouterResolution::SevenTwentyP), + 5, + None, + Some(ImageListRef::Urls(vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + ])), + ); + assert_eq!(cents, 36); + } + } + + mod relative_pricing { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let p480 = cost_cents(Some(RouterResolution::FourEightyP), 10, None, None); + let p720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None); + assert!(p480 < p720, "480p ({p480}) should be < 720p ({p720})"); + } + + #[test] + fn longer_duration_costs_more() { + let c5 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, None, None); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, None, None); + assert!(c5 < c10); + assert!(c10 < c15); + } + + #[test] + fn one_k_request_clamps_to_480p_pricing() { + // OneK gets bumped to 480p in plan_resolution, so cost equals 480p cost. + let one_k = cost_cents(Some(RouterResolution::OneK), 10, None, None); + let p480 = cost_cents(Some(RouterResolution::FourEightyP), 10, None, None); + assert_eq!(one_k, p480); + } + + #[test] + fn ten_eighty_p_request_clamps_to_720p_pricing() { + // TenEightyP gets clamped to 720p in plan_resolution. + let p1080 = cost_cents(Some(RouterResolution::TenEightyP), 10, None, None); + let p720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None); + assert_eq!(p1080, p720); + } + } + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + start_frame: Option, + reference_images: Option, + ) -> u64 { + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo, + provider: RouterProvider::GrokApi, + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(1), + start_frame, + reference_images, + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/mod.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/request.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/request.rs new file mode 100644 index 00000000..157d5095 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video/request.rs @@ -0,0 +1,111 @@ +use std::sync::Arc; + +use grok_api_client::api::requests::videos::video_generation::video_generation::{ + video_generation, VideoGenerationArgs, VideoGenerationRequest as GrokVideoGenerationRequest, +}; + +use crate::client::router_grok_api_client::RouterGrokApiClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + GenerateVideoResponse, GrokVideoResponsePayload, +}; + +#[derive(Clone, Debug)] +pub struct GrokApiGrokImagineVideoRequestState { + /// The fully-resolved Grok request body. Doesn't carry the API key — that + /// gets borrowed at send time from the router client. + pub request: GrokVideoGenerationRequest, +} + +impl GrokApiGrokImagineVideoRequestState { + pub async fn send(&self, client: &RouterGrokApiClient) -> Result { + let outbound_request = Arc::new(self.request.clone()); + + let response = video_generation(VideoGenerationArgs { + api_key: &client.api_key, + request: self.request.clone(), + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::GrokApi(err)))?; + + Ok(GenerateVideoResponse::Grok(GrokVideoResponsePayload { + request_id: response.request_id, + maybe_outbound_request: Some(outbound_request), + })) + } +} + +#[cfg(test)] +mod tests { + use grok_api_client::creds::grok_api_key::GrokApiKey; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_grok_api_client::RouterGrokApiClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_text_to_video_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A glowing crystal rocket launching from Mars.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..grok_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Grok(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog leaps into the lake and splashes around.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(5), + ..grok_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Grok(_))); + } + + fn grok_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo, + provider: RouterProvider::GrokApi, + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_grok_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/grok_api_key.txt") + .expect("Failed to read Grok API key"); + let api_key = GrokApiKey::new(secret.trim().to_string()); + RouterClient::GrokApi(RouterGrokApiClient::new(api_key)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_grok_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Grok skips draft)"), + }; + let response = request.send_request(&client).await.expect("send_request should succeed"); + match &response { + GenerateVideoResponse::Grok(p) => println!("grok request_id={}", p.request_id), + other => println!("unexpected response: {:?}", other), + } + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/build.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/build.rs new file mode 100644 index 00000000..b04d2a96 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/build.rs @@ -0,0 +1,718 @@ +use log::info; + +use grok_api_client::api::requests::videos::video_generation::video_generation::{ + VideoGenerationRequest as GrokVideoGenerationRequest, + VideoImageSource as GrokVideoImageSource, +}; +use grok_api_client::api::types::video_types::video_aspect_ratio::VideoAspectRatio as GrokAspectRatio; +use grok_api_client::api::types::video_types::video_model::VideoModel as GrokVideoModel; +use grok_api_client::api::types::video_types::video_resolution::VideoResolution as GrokResolution; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::{ClientError, ClientType}; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::request::GrokApiGrokImagineVideo1p5RequestState; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/// Builds a Grok Imagine Video 1.5 preview request from the generic +/// GenerateVideoRequestBuilder. Mirrors the v1 builder's capabilities and +/// graceful-drop policy (the 1.5 model accepts the same wire shape as v1); +/// the only material differences are the `model` identifier on the wire and +/// the steeper pricing in the cost calculator (see `cost.rs`). +/// +/// xAI's grok-imagine-video-1.5 accepts: +/// - `image` (single source image, image-to-video mode) OR `reference_images` +/// (multi-image reference-to-video). These two are mutually exclusive per +/// xAI's API. +/// - Aspect ratio, resolution (480p/720p/1080p), duration (1–15s), prompt. +/// +/// Fields that Grok DOESN'T accept (`end_frame`, `reference_videos`, +/// `reference_audio`, and `MediaFileToken`-style image refs) are silently +/// dropped with an info-level log. `LocalPath`/`Bytes` image refs are the +/// exception: they error with `ProviderCannotUseLocalMedia`, since silently +/// dropping the caller's local media would produce a video that ignores +/// their input. +pub fn build_grok_api_grok_imagine_video_1p5( + mut builder: GenerateVideoRequestBuilder, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + // Scalar fields. + let prompt = builder.prompt.take().unwrap_or_default(); + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy); + let resolution = plan_resolution(builder.resolution.take(), strategy); + let duration = builder.duration_seconds.take().map(|d| (d as u32).clamp(1, 15)); + + log_and_drop_end_frame(builder.end_frame.take()); + log_and_drop_reference_videos(builder.reference_videos.take()); + log_and_drop_reference_audio(builder.reference_audio.take()); + + let start_frame = resolve_url_to_image_source(builder.start_frame.take())?; + let reference_images_supplied = builder.reference_images.take(); + + // xAI's v1.5 model explicitly does NOT accept `reference_images` (it only + // supports text-to-video and single-image-to-video). If the caller supplies + // reference images and no start_frame, promote the first reference image + // into `image` (image-to-video) and drop the rest. + let (image, reference_images) = match (start_frame, reference_images_supplied) { + (Some(img), Some(refs)) => { + info!( + "grok_imagine_video_1p5: both start_frame and reference_images supplied — \ + preferring start_frame (image-to-video). Dropping {} reference image(s).", + refs.len(), + ); + (Some(img), None) + } + (Some(img), None) => (Some(img), None), + (None, Some(refs)) => promote_first_reference_to_image(refs)?, + (None, None) => (None, None), + }; + + // xAI's v1.5 model rejects text-to-video at the server. Bounce the request + // here rather than spending an API round-trip to learn the same thing. + if image.is_none() && reference_images.is_none() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "text-to-video isn't supported by grok-imagine-video-1.5; supply a start_frame or at least one reference image".to_string(), + })); + } + + let request = GrokVideoGenerationRequest { + prompt, + // Pin to the 1.5 preview identifier so the grok_api_client cost + // calculator picks the v1.5 pricing tier (see VideoModel::pricing_tier). + model: Some(GrokVideoModel::GrokImagineVideo1p5), + image, + reference_images, + aspect_ratio, + duration, + resolution, + user: None, + }; + + let state = GrokApiGrokImagineVideo1p5RequestState { request }; + Ok(VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::GrokApiGrokImagineVideo1p5(state), + )) +} + +// ── Field planners ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Option { + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto3k) + | Some(RouterAspectRatio::Auto4k) => None, + + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Some(GrokAspectRatio::Square) + } + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Some(GrokAspectRatio::Landscape16x9) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Some(GrokAspectRatio::Portrait9x16) + } + + Some(RouterAspectRatio::WideFourByThree) => Some(GrokAspectRatio::Landscape4x3), + Some(RouterAspectRatio::TallThreeByFour) => Some(GrokAspectRatio::Portrait3x4), + + Some(RouterAspectRatio::WideThreeByTwo) => Some(GrokAspectRatio::Landscape3x2), + Some(RouterAspectRatio::TallTwoByThree) => Some(GrokAspectRatio::Portrait2x3), + + Some(RouterAspectRatio::WideFiveByFour) + | Some(RouterAspectRatio::WideTwentyOneByNine) => Some(GrokAspectRatio::Landscape16x9), + Some(RouterAspectRatio::TallFourByFive) + | Some(RouterAspectRatio::TallNineByTwentyOne) => Some(GrokAspectRatio::Portrait9x16), + } +} + +fn plan_resolution( + resolution: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Option { + match resolution { + None => None, + Some(RouterResolution::FourEightyP) => Some(GrokResolution::FourEightyP), + Some(RouterResolution::SevenTwentyP) => Some(GrokResolution::SevenTwentyP), + Some(RouterResolution::TenEightyP) => Some(GrokResolution::TenEightyP), + // 2K/3K/4K aren't produced — cap at the model's max of 1080p. + Some(RouterResolution::TwoK) + | Some(RouterResolution::ThreeK) + | Some(RouterResolution::FourK) => Some(GrokResolution::TenEightyP), + Some(RouterResolution::HalfK) | Some(RouterResolution::OneK) => { + Some(GrokResolution::FourEightyP) + } + } +} + +// ── Image source resolvers (silent drops for unsupported variants) ── + +fn resolve_url_to_image_source( + image_ref: Option, +) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(ImageRef::Url(url)) => Ok(Some(GrokVideoImageSource::Url(url))), + Some(ImageRef::MediaFileToken(token)) => { + info!( + "grok_imagine_video_1p5: dropping MediaFileToken {:?} for start_frame — \ + Grok only accepts public URLs. Resolve the token to a URL upstream if needed.", + token, + ); + Ok(None) + } + Some(ImageRef::LocalPath(_)) | Some(ImageRef::Bytes(_)) => { + Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GrokApi, + })) + } + } +} + +/// xAI's v1.5 model rejects `reference_images` entirely. When a caller has +/// only supplied reference images (no start_frame), promote the first one +/// to `image` so they at least get image-to-video, and drop the remainder +/// with a log so it's visible in operator traces. +fn promote_first_reference_to_image( + list_ref: ImageListRef, +) -> Result<(Option, Option>), ArtcraftRouterError> { + match list_ref { + ImageListRef::Urls(urls) if urls.is_empty() => Ok((None, None)), + ImageListRef::Urls(mut urls) => { + let first_url = urls.remove(0); + let dropped = urls.len(); + if dropped > 0 { + info!( + "grok_imagine_video_1p5: v1.5 doesn't accept reference_images; promoting \ + the first reference image to start_frame (image-to-video). Dropping {} \ + additional reference image(s).", + dropped, + ); + } else { + info!( + "grok_imagine_video_1p5: v1.5 doesn't accept reference_images; promoting \ + the single reference image to start_frame (image-to-video).", + ); + } + Ok((Some(GrokVideoImageSource::Url(first_url)), None)) + } + ImageListRef::MediaFileTokens(tokens) => { + info!( + "grok_imagine_video_1p5: dropping {} MediaFileToken reference image(s) — \ + Grok only accepts public URLs. Resolve tokens to URLs upstream if needed.", + tokens.len(), + ); + Ok((None, None)) + } + ImageListRef::Sources(refs) => { + let mut urls = Vec::with_capacity(refs.len()); + let mut dropped_tokens = 0usize; + for image_ref in refs { + match image_ref { + ImageRef::Url(url) => urls.push(url), + ImageRef::MediaFileToken(_) => dropped_tokens += 1, + ImageRef::LocalPath(_) | ImageRef::Bytes(_) => { + return Err(ArtcraftRouterError::Client(ClientError::ProviderCannotUseLocalMedia { + client_type: ClientType::GrokApi, + })); + } + } + } + if dropped_tokens > 0 { + info!( + "grok_imagine_video_1p5: dropping {} MediaFileToken reference image(s) — \ + Grok only accepts public URLs. Resolve tokens to URLs upstream if needed.", + dropped_tokens, + ); + } + promote_first_reference_to_image(ImageListRef::Urls(urls)) + } + } +} + +// ── Drop-with-log helpers for fields Grok doesn't accept at all ── + +fn log_and_drop_end_frame(end_frame: Option) { + if end_frame.is_some() { + info!("grok_imagine_video_1p5: dropping end_frame — Grok doesn't support end-frame keyframes."); + } +} + +fn log_and_drop_reference_videos(refs: Option) { + if let Some(refs) = refs { + info!( + "grok_imagine_video_1p5: dropping {} reference video(s) — Grok doesn't accept reference videos.", + refs.len(), + ); + } +} + +fn log_and_drop_reference_audio(refs: Option) { + if let Some(refs) = refs { + info!( + "grok_imagine_video_1p5: dropping {} reference audio clip(s) — Grok doesn't accept reference audio.", + refs.len(), + ); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::api::audio_list_ref::AudioListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + + // ── Wire-shape: the built request always carries the 1.5 preview model id ── + + mod model_id { + use super::*; + + #[test] + fn built_request_pins_grok_imagine_video_1p5_preview() { + let req = unwrap_request(make_builder(|_| {})); + assert_eq!( + req.request.model, + Some(GrokVideoModel::GrokImagineVideo1p5), + ); + } + + #[test] + fn built_request_serializes_canonical_wire_name() { + // The on-wire model string is the canonical name; the v1.5 cost + // calculator in grok_api_client keys off this string. + let req = unwrap_request(make_builder(|_| {})); + let model = req.request.model.as_ref().expect("model should be set"); + assert_eq!(model.as_str(), "grok-imagine-video-1.5"); + } + } + + // ── Field passthrough ── + + mod field_conversions { + use super::*; + + #[test] + fn prompt_passed_through() { + let req = unwrap_request(make_builder(|b| { b.prompt = Some("test prompt".to_string()); })); + assert_eq!(req.request.prompt, "test prompt"); + } + + #[test] + fn duration_passed_through() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(8); })); + assert_eq!(req.request.duration, Some(8)); + } + + #[test] + fn duration_clamped_to_min() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(0); })); + assert_eq!(req.request.duration, Some(1)); + } + + #[test] + fn duration_clamped_to_max() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = Some(99); })); + assert_eq!(req.request.duration, Some(15)); + } + + #[test] + fn duration_none_stays_none() { + let req = unwrap_request(make_builder(|b| { b.duration_seconds = None; })); + assert_eq!(req.request.duration, None); + } + } + + // ── Aspect ratio ── + + mod aspect_ratio_tests { + use super::*; + + #[test] + fn square() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Square); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Square)); + } + + #[test] + fn landscape_16x9() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + } + + #[test] + fn portrait_9x16() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait9x16)); + } + + #[test] + fn landscape_4x3() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideFourByThree); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape4x3)); + } + + #[test] + fn portrait_3x4() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallThreeByFour); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait3x4)); + } + + #[test] + fn landscape_3x2() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::WideThreeByTwo); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape3x2)); + } + + #[test] + fn portrait_2x3() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::TallTwoByThree); })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait2x3)); + } + + #[test] + fn auto_maps_to_none() { + let req = unwrap_request(make_builder(|b| { b.aspect_ratio = Some(RouterAspectRatio::Auto); })); + assert_eq!(req.request.aspect_ratio, None); + } + + #[test] + fn unsupported_wide_falls_back_to_16x9() { + let req = unwrap_request(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::WideTwentyOneByNine); + })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + } + + #[test] + fn unsupported_tall_falls_back_to_9x16() { + let req = unwrap_request(make_builder(|b| { + b.aspect_ratio = Some(RouterAspectRatio::TallNineByTwentyOne); + })); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Portrait9x16)); + } + } + + // ── Resolution ── + + mod resolution_tests { + use super::*; + + #[test] + fn res_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourEightyP); })); + assert_eq!(req.request.resolution, Some(GrokResolution::FourEightyP)); + } + + #[test] + fn res_720p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::SevenTwentyP); })); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + } + + #[test] + fn res_1080p_maps_to_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::TenEightyP); })); + assert_eq!(req.request.resolution, Some(GrokResolution::TenEightyP)); + } + + #[test] + fn res_4k_caps_to_1080p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::FourK); })); + assert_eq!(req.request.resolution, Some(GrokResolution::TenEightyP)); + } + + #[test] + fn res_1k_bumps_to_480p() { + let req = unwrap_request(make_builder(|b| { b.resolution = Some(RouterResolution::OneK); })); + assert_eq!(req.request.resolution, Some(GrokResolution::FourEightyP)); + } + + #[test] + fn none_stays_none() { + let req = unwrap_request(make_builder(|_| {})); + assert!(req.request.resolution.is_none()); + } + } + + // ── Image source plumbing (graceful — never errors) ── + + mod image_tests { + use super::*; + + #[test] + fn start_frame_url_becomes_image() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + })); + match &req.request.image { + Some(GrokVideoImageSource::Url(u)) => assert_eq!(u, "https://example.com/start.png"), + other => panic!("expected Url variant, got {:?}", other), + } + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn start_frame_media_file_token_dropped_then_rejected_as_text_only() { + // MediaFileTokens get silently dropped (Grok only accepts URLs), but + // with no usable image left the no-image guard rejects the build. + let result = build_grok_api_grok_imagine_video_1p5(GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::GrokApi, + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test".to_string()))), + ..Default::default() + }); + assert!(matches!( + result, + Err(crate::errors::artcraft_router_error::ArtcraftRouterError::Client( + crate::errors::client_error::ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. } + )), + )); + } + + #[test] + fn multiple_reference_image_urls_promote_first_and_drop_rest() { + // xAI's v1.5 model rejects `reference_images`. The builder promotes the + // first reference to `image` and drops the remainder. + let urls = vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + ]; + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::Urls(urls.clone())); + })); + assert!( + req.request.reference_images.is_none(), + "reference_images must be None (xAI v1.5 rejects them)", + ); + match &req.request.image { + Some(GrokVideoImageSource::Url(u)) => assert_eq!(u, "https://example.com/a.png"), + other => panic!("expected first reference image promoted to `image`, got {:?}", other), + } + } + + #[test] + fn single_reference_image_url_promotes_to_image() { + let req = unwrap_request(make_builder(|b| { + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/only.png".to_string(), + ])); + })); + assert!(req.request.reference_images.is_none()); + match &req.request.image { + Some(GrokVideoImageSource::Url(u)) => assert_eq!(u, "https://example.com/only.png"), + other => panic!("expected single reference promoted to `image`, got {:?}", other), + } + } + + /// Replicates the production failure from 2026-05-31: storyteller-web + /// received `reference_image_media_tokens: [..., ...]` and routed it to + /// the v1.5 model, which rejected the request with + /// `reference_images is not supported for this model`. After the + /// promote-first fix, the resolved URLs go into `image` instead. + #[test] + fn reproduces_2026_05_31_two_ref_image_urls_no_start_frame() { + let req = unwrap_request(make_builder(|b| { + // Two URLs (the storyteller-web pipeline resolves media tokens to URLs + // before calling build2() on the GrokApi provider). + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://pub.example.com/media/a.png".to_string(), + "https://pub.example.com/media/b.png".to_string(), + ])); + b.start_frame = None; + b.resolution = Some(RouterResolution::SevenTwentyP); + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + b.duration_seconds = Some(5); + })); + // The fix: no `reference_images` ever reach xAI for v1.5. + assert!( + req.request.reference_images.is_none(), + "v1.5 must never send reference_images to xAI", + ); + // The first reference is preserved as image-to-video so the user still + // gets a sensible result. + assert!(matches!(req.request.image, Some(GrokVideoImageSource::Url(_)))); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + assert_eq!(req.request.duration, Some(5)); + assert_eq!(req.request.model, Some(GrokVideoModel::GrokImagineVideo1p5)); + } + + #[test] + fn reference_image_tokens_dropped_then_rejected_as_text_only() { + // MediaFileTokens get silently dropped; with no usable image left the + // no-image guard rejects the build. + let result = build_grok_api_grok_imagine_video_1p5(GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::GrokApi, + reference_images: Some(ImageListRef::MediaFileTokens(vec![ + MediaFileToken::new("mf_a".to_string()), + MediaFileToken::new("mf_b".to_string()), + ])), + ..Default::default() + }); + assert!(matches!( + result, + Err(crate::errors::artcraft_router_error::ArtcraftRouterError::Client( + crate::errors::client_error::ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. } + )), + )); + } + + #[test] + fn start_frame_and_reference_images_together_prefers_start_frame() { + let req = unwrap_request(make_builder(|b| { + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/ref1.png".to_string(), + "https://example.com/ref2.png".to_string(), + ])); + })); + match &req.request.image { + Some(GrokVideoImageSource::Url(u)) => assert_eq!(u, "https://example.com/start.png"), + other => panic!("expected start_frame URL, got {:?}", other), + } + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn empty_reference_image_url_list_rejected_as_text_only() { + // Empty list resolves to None for both image and reference_images; + // the no-image guard then rejects the build. + let result = build_grok_api_grok_imagine_video_1p5(GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::GrokApi, + reference_images: Some(ImageListRef::Urls(vec![])), + ..Default::default() + }); + assert!(matches!( + result, + Err(crate::errors::artcraft_router_error::ArtcraftRouterError::Client( + crate::errors::client_error::ClientError::ModelDoesNotSupportOption { field: "image_inputs", .. } + )), + )); + } + } + + // ── Unsupported fields are silently dropped, not rejected ── + + mod unsupported_fields_graceful { + use super::*; + + #[test] + fn end_frame_silently_dropped() { + // end_frame isn't on Grok's wire body at all, so the only thing to + // verify is that supplying it doesn't break the build. `make_builder` + // injects a default start_frame to satisfy the v1.5 no-image guard. + let req = unwrap_request(make_builder(|b| { + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + })); + // image comes from the default start_frame; reference_images stays None. + assert!(req.request.reference_images.is_none()); + assert!(matches!(req.request.image, Some(GrokVideoImageSource::Url(_)))); + } + + #[test] + fn reference_videos_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/v.mp4".to_string()])); + })); + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn reference_audio_silently_dropped() { + let req = unwrap_request(make_builder(|b| { + b.reference_audio = Some(AudioListRef::Urls(vec!["https://example.com/a.wav".to_string()])); + })); + assert!(req.request.reference_images.is_none()); + } + + #[test] + fn kitchen_sink_with_every_unsupported_field_still_succeeds() { + let req = unwrap_request(make_builder(|b| { + b.prompt = Some("kitchen sink".to_string()); + b.start_frame = Some(ImageRef::Url("https://example.com/start.png".to_string())); + b.end_frame = Some(ImageRef::Url("https://example.com/end.png".to_string())); + b.reference_images = Some(ImageListRef::Urls(vec![ + "https://example.com/ref.png".to_string(), + ])); + b.reference_videos = Some(VideoListRef::Urls(vec!["https://example.com/v.mp4".to_string()])); + b.reference_audio = Some(AudioListRef::Urls(vec!["https://example.com/a.wav".to_string()])); + b.resolution = Some(RouterResolution::SevenTwentyP); + b.aspect_ratio = Some(RouterAspectRatio::WideSixteenByNine); + b.duration_seconds = Some(8); + })); + assert_eq!(req.request.prompt, "kitchen sink"); + assert!(matches!( + req.request.image, + Some(GrokVideoImageSource::Url(_)) + )); + assert!(req.request.reference_images.is_none()); + assert_eq!(req.request.resolution, Some(GrokResolution::SevenTwentyP)); + assert_eq!(req.request.aspect_ratio, Some(GrokAspectRatio::Landscape16x9)); + assert_eq!(req.request.duration, Some(8)); + // Still pinned to the 1.5 model regardless of kitchen-sink inputs. + assert_eq!(req.request.model, Some(GrokVideoModel::GrokImagineVideo1p5)); + } + } + + // ── Helpers ── + + fn base_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::GrokApi, + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn make_builder(f: impl FnOnce(&mut GenerateVideoRequestBuilder)) -> GenerateVideoRequestBuilder { + let mut b = base_builder(); + f(&mut b); + // v1.5 requires an input image; tests that don't explicitly exercise the + // image-handling paths get a default start_frame so they sail past the + // no-image guard in `build()`. Tests that set start_frame or + // reference_images themselves keep their override. + if b.start_frame.is_none() && b.reference_images.is_none() { + b.start_frame = Some(ImageRef::Url("https://example.com/default.png".to_string())); + } + b + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> GrokApiGrokImagineVideo1p5RequestState { + let result = build_grok_api_grok_imagine_video_1p5(builder).expect("build should succeed"); + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::GrokApiGrokImagineVideo1p5(s)) => s, + _ => panic!("expected GrokApiGrokImagineVideo1p5 request"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/cost.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/cost.rs new file mode 100644 index 00000000..6230b02a --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/cost.rs @@ -0,0 +1,386 @@ +use grok_api_client::api::traits::grok_request_cost_calculator_trait::GrokRequestCostCalculator; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::request::GrokApiGrokImagineVideo1p5RequestState; + +pub struct GrokApiGrokImagineVideo1p5CostState { + request: GrokApiGrokImagineVideo1p5RequestState, +} + +impl GrokApiGrokImagineVideo1p5CostState { + pub fn from_request(request: &GrokApiGrokImagineVideo1p5RequestState) -> Self { + Self { request: request.clone() } + } + + pub fn estimate_cost(&self) -> Result { + // Defense in depth: `build()` already enforces this, but a request state + // constructed by hand must not get a cost quote for an operation the + // model will reject. + if self.request.request.image.is_none() && self.request.request.reference_images.is_none() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "text-to-video isn't supported by grok-imagine-video-1.5; supply a start_frame or at least one reference image".to_string(), + })); + } + + // grok_api_client's calculator picks the v1.5 pricing tier from the + // request's `model` field (see VideoModel::pricing_tier). The build step + // sets `model = Some(GrokImagineVideo1p5)`, so this returns the + // v1.5 rates: + // Output: 80 mills/s @ 480p, 140 mills/s @ 720p + // Input: 10 mills per source image + let cost_in_usd_cents = self.request.request.calculate_cost_in_cents(); + + Ok(VideoGenerationCostEstimate { + cost_in_credits: None, + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + }) + } +} + +#[cfg(test)] +mod tests { + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + + // v1.5 pricing reference (from grok_api_client/video_generation/cost.rs): + // Output: 480p 80 mills/s ($0.08/s), 720p 140 mills/s ($0.14/s) + // Input: 10 mills per source image ($0.01/img) + // + // Cost in cents = ceil(mills / 10). + + // ── 720p pricing ── + + mod pricing_720p { + use super::*; + + // Note: build_for() injects a default start_frame when no image source + // is given (v1.5 requires an image), so every "no explicit image" case + // here actually includes 1 image worth of input surcharge (+10 mills = +1¢). + + #[test] + fn five_s_with_default_image() { + // 140 × 5 + 10 = 710 mills → 71¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 5, None, None), 71); + } + + #[test] + fn ten_s_with_default_image() { + // 140 × 10 + 10 = 1410 mills → 141¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None), 141); + } + + #[test] + fn fifteen_s_with_default_image() { + // 140 × 15 + 10 = 2110 mills → 211¢ + assert_eq!(cost_cents(Some(RouterResolution::SevenTwentyP), 15, None, None), 211); + } + } + + // ── 480p pricing ── + + mod pricing_480p { + use super::*; + + #[test] + fn five_s_with_default_image() { + // 80 × 5 + 10 = 410 mills → 41¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 5, None, None), 41); + } + + #[test] + fn ten_s_with_default_image() { + // 80 × 10 + 10 = 810 mills → 81¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 10, None, None), 81); + } + + #[test] + fn fifteen_s_with_default_image() { + // 80 × 15 + 10 = 1210 mills → 121¢ + assert_eq!(cost_cents(Some(RouterResolution::FourEightyP), 15, None, None), 121); + } + } + + // ── Image input pricing (10 mills/image, NOT 2 mills as in v1) ── + + mod image_inputs_add_to_cost { + use super::*; + + #[test] + fn single_start_frame_image_adds_10_mills() { + // 5s @ 720p output 700 mills + 1 input image 10 mills = 710 mills → 71¢ + let cents = cost_cents( + Some(RouterResolution::SevenTwentyP), + 5, + Some(ImageRef::Url("https://example.com/a.png".to_string())), + None, + ); + assert_eq!(cents, 71); + } + + #[test] + fn three_reference_images_collapse_to_one_image() { + // v1.5 rejects reference_images, so the build step promotes the first + // reference to `image` and drops the rest (see promote_first_reference_to_image + // in build.rs). Effective input image count = 1 regardless of how + // many were submitted as references. + // + // 5s @ 720p output 700 mills + 1 effective input image 10 mills = 710 mills → 71¢ + let cents = cost_cents( + Some(RouterResolution::SevenTwentyP), + 5, + None, + Some(ImageListRef::Urls(vec![ + "https://example.com/a.png".to_string(), + "https://example.com/b.png".to_string(), + "https://example.com/c.png".to_string(), + ])), + ); + assert_eq!(cents, 71); + } + + #[test] + fn reference_image_count_does_not_scale_cost() { + // Promote-first collapses any number of reference_images down to one + // `image` on the wire, so the cost stays flat at the 1-image surcharge. + let baseline = cost_cents( + Some(RouterResolution::SevenTwentyP), + 5, + None, + Some(ImageListRef::Urls(vec!["https://example.com/0.png".to_string()])), + ); + for n in 1u64..=5 { + let images: Vec = (0..n) + .map(|i| format!("https://example.com/{i}.png")) + .collect(); + let cents = cost_cents( + Some(RouterResolution::SevenTwentyP), + 5, + None, + Some(ImageListRef::Urls(images)), + ); + assert_eq!(cents, baseline, "n={n} should still cost the same after promote-first"); + } + } + } + + // ── Relative pricing sanity ── + + mod relative_pricing { + use super::*; + + #[test] + fn higher_resolution_costs_more() { + let p480 = cost_cents(Some(RouterResolution::FourEightyP), 10, None, None); + let p720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None); + assert!(p480 < p720, "480p ({p480}) should be < 720p ({p720})"); + } + + #[test] + fn longer_duration_costs_more() { + let c5 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, None, None); + let c10 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None); + let c15 = cost_cents(Some(RouterResolution::SevenTwentyP), 15, None, None); + assert!(c5 < c10); + assert!(c10 < c15); + } + + #[test] + fn one_k_request_clamps_to_480p_pricing() { + let one_k = cost_cents(Some(RouterResolution::OneK), 10, None, None); + let p480 = cost_cents(Some(RouterResolution::FourEightyP), 10, None, None); + assert_eq!(one_k, p480); + } + + #[test] + fn ten_eighty_p_prices_higher_than_720p() { + // Grok Imagine 1.5 now renders genuine 1080p ($0.25/s vs $0.14/s @ 720p). + let p1080 = cost_cents(Some(RouterResolution::TenEightyP), 10, None, None); + let p720 = cost_cents(Some(RouterResolution::SevenTwentyP), 10, None, None); + assert!(p1080 > p720, "1080p ({p1080}) should cost more than 720p ({p720})"); + } + } + + // ── Cross-tier sanity: 1.5 must cost more than v1 at same settings ── + + mod cross_tier { + use super::*; + + #[test] + fn v1p5_costs_more_than_v1_at_720p() { + let v1p5 = cost_cents(Some(RouterResolution::SevenTwentyP), 5, None, None); + let v1 = v1_cost_cents(Some(RouterResolution::SevenTwentyP), 5, None, None); + assert!(v1 < v1p5, "v1={v1} v1p5={v1p5}"); + } + + #[test] + fn v1p5_costs_more_than_v1_at_480p() { + let v1p5 = cost_cents(Some(RouterResolution::FourEightyP), 5, None, None); + let v1 = v1_cost_cents(Some(RouterResolution::FourEightyP), 5, None, None); + assert!(v1 < v1p5, "v1={v1} v1p5={v1p5}"); + } + } + + // ── Exhaustive matrix ── + + mod exhaustive_matrix { + use super::*; + + // (resolution, duration_s, has_image, ref_count, expected_cents) + // + // Mills math: + // 480p output: 80 mills/s 720p output: 140 mills/s + // per input image: 10 mills + // cents = ceil(mills / 10) + // + // v1.5 requires at least one image, so every "has_image=false, + // ref_count=0" row would be rejected. Those rows are gone; everything + // else uses an explicit image source. + const CASES: &[(RouterResolution, u16, bool, usize, u64)] = &[ + // 480p with image-to-video (1 input image, +10 mills) + (RouterResolution::FourEightyP, 1, true, 0, 9), // 80 + 10 + (RouterResolution::FourEightyP, 5, true, 0, 41), // 400 + 10 + (RouterResolution::FourEightyP, 8, true, 0, 65), // 640 + 10 + (RouterResolution::FourEightyP, 15, true, 0, 121), // 1200 + 10 + // 720p with image-to-video (1 input image, +10 mills) + (RouterResolution::SevenTwentyP, 1, true, 0, 15), // 140 + 10 + (RouterResolution::SevenTwentyP, 5, true, 0, 71), // 700 + 10 + (RouterResolution::SevenTwentyP, 8, true, 0, 113), // 1120 + 10 + (RouterResolution::SevenTwentyP,15, true, 0, 211), // 2100 + 10 + (RouterResolution::SevenTwentyP,10, true, 0, 141), // 1400 + 10 + // 720p reference-to-video. Promote-first collapses any non-empty refs + // list down to ONE effective image on the wire, so all of these cost + // the same regardless of ref_count. + (RouterResolution::SevenTwentyP, 5, false, 1, 71), // 700 + 10 + (RouterResolution::SevenTwentyP, 5, false, 2, 71), // 700 + 10 (promote-first) + (RouterResolution::SevenTwentyP, 5, false, 3, 71), // 700 + 10 (promote-first) + ]; + + #[test] + fn all_matrix_cases() { + for &(res, duration, has_image, ref_count, expected_cents) in CASES { + let start_frame = if has_image { + Some(ImageRef::Url("https://example.com/start.png".to_string())) + } else { None }; + let reference_images = if ref_count > 0 { + Some(ImageListRef::Urls( + (0..ref_count).map(|i| format!("https://example.com/ref_{i}.png")).collect(), + )) + } else { None }; + let cents = cost_cents(Some(res), duration, start_frame, reference_images); + assert_eq!( + cents, expected_cents, + "res={res:?} dur={duration} has_image={has_image} ref_count={ref_count}", + ); + } + } + } + + // ── No-image rejection (defense in depth) ───────────────────────────── + + mod rejects_text_only { + use super::*; + use crate::errors::artcraft_router_error::ArtcraftRouterError; + use crate::errors::client_error::ClientError; + use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::cost::GrokApiGrokImagineVideo1p5CostState; + use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::request::GrokApiGrokImagineVideo1p5RequestState; + use grok_api_client::api::requests::videos::video_generation::video_generation::VideoGenerationRequest as GrokVideoGenerationRequest; + use grok_api_client::api::types::video_types::video_model::VideoModel as GrokVideoModel; + + /// A cost-state hand-built around a text-only Grok request must return + /// Err when estimate_cost is called. This guards against a state + /// constructed outside of `build()` (e.g. in a misuse). + #[test] + fn estimate_cost_returns_err_when_no_image_sources() { + let request = GrokVideoGenerationRequest { + prompt: "text only".to_string(), + model: Some(GrokVideoModel::GrokImagineVideo1p5), + image: None, + reference_images: None, + aspect_ratio: None, + duration: Some(5), + resolution: None, + user: None, + }; + let state = GrokApiGrokImagineVideo1p5CostState::from_request( + &GrokApiGrokImagineVideo1p5RequestState { request }, + ); + let err = state.estimate_cost().expect_err("text-only must be rejected"); + match err { + ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field, .. }) => { + assert_eq!(field, "image_inputs"); + } + other => panic!("expected Client(ModelDoesNotSupportOption), got {:?}", other), + } + } + } + + // ── Helpers ── + + fn cost_cents( + resolution: Option, + duration_seconds: u16, + start_frame: Option, + reference_images: Option, + ) -> u64 { + build_for(RouterVideoModel::GrokImagineVideo1p5, resolution, duration_seconds, start_frame, reference_images) + } + + fn v1_cost_cents( + resolution: Option, + duration_seconds: u16, + start_frame: Option, + reference_images: Option, + ) -> u64 { + build_for(RouterVideoModel::GrokImagineVideo, resolution, duration_seconds, start_frame, reference_images) + } + + fn build_for( + model: RouterVideoModel, + resolution: Option, + duration_seconds: u16, + start_frame: Option, + reference_images: Option, + ) -> u64 { + // v1.5 rejects text-to-video at build time. To keep pricing tests + // focused on duration/resolution/batch scaling (rather than constantly + // duplicating an image input in every call site), the helper injects a + // single default start_frame URL when neither image source is supplied. + // That adds a 10-mill / 1¢ input-image surcharge to every "no-image" + // case — all the expected values below account for it. + let start_frame = match (start_frame, &reference_images) { + (Some(sf), _) => Some(sf), + (None, Some(_)) => None, + (None, None) => Some(ImageRef::Url("https://example.com/default.png".to_string())), + }; + let builder = GenerateVideoRequestBuilder { + model, + provider: RouterProvider::GrokApi, + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(1), + start_frame, + reference_images, + ..Default::default() + }; + builder.build2() + .expect("build2 should succeed") + .estimate_cost() + .expect("estimate_cost should succeed") + .cost_in_usd_cents + .unwrap() + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/mod.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/mod.rs new file mode 100644 index 00000000..98150bd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/mod.rs @@ -0,0 +1,3 @@ +pub mod build; +pub mod cost; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/request.rs b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/request.rs new file mode 100644 index 00000000..7668ba38 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/grok_imagine_video_1p5/request.rs @@ -0,0 +1,164 @@ +use std::sync::Arc; + +use grok_api_client::api::requests::videos::video_generation::video_generation::{ + video_generation, VideoGenerationArgs, VideoGenerationRequest as GrokVideoGenerationRequest, +}; + +use crate::client::router_grok_api_client::RouterGrokApiClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{ + GenerateVideoResponse, GrokVideoResponsePayload, +}; + +#[derive(Clone, Debug)] +pub struct GrokApiGrokImagineVideo1p5RequestState { + /// The fully-resolved Grok request body, with `model` set to + /// `VideoModel::GrokImagineVideo1p5`. Doesn't carry the API key — + /// that gets borrowed at send time from the router client. + pub request: GrokVideoGenerationRequest, +} + +impl GrokApiGrokImagineVideo1p5RequestState { + pub async fn send(&self, client: &RouterGrokApiClient) -> Result { + // Defense in depth: `build()` already enforces this. Bouncing the + // request here costs nothing and avoids an HTTP call we know will fail. + if self.request.image.is_none() && self.request.reference_images.is_none() { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "image_inputs", + value: "text-to-video isn't supported by grok-imagine-video-1.5; supply a start_frame or at least one reference image".to_string(), + })); + } + + let outbound_request = Arc::new(self.request.clone()); + + let response = video_generation(VideoGenerationArgs { + api_key: &client.api_key, + request: self.request.clone(), + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::GrokApi(err)))?; + + Ok(GenerateVideoResponse::Grok(GrokVideoResponsePayload { + request_id: response.request_id, + maybe_outbound_request: Some(outbound_request), + })) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use grok_api_client::api::types::video_types::video_model::VideoModel; + use grok_api_client::creds::grok_api_key::GrokApiKey; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_grok_api_client::RouterGrokApiClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + // ── Wire-shape sanity: the built request always carries the 1.5 model id ── + + #[test] + fn built_request_targets_grok_imagine_video_1p5_preview() { + let builder = GenerateVideoRequestBuilder { + prompt: Some("test".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + // v1.5 requires an input image (no T2V). + start_frame: Some(ImageRef::Url("https://example.com/start.png".to_string())), + ..grok_builder() + }; + let request = unwrap_request(builder); + assert_eq!(request.request.model, Some(VideoModel::GrokImagineVideo1p5)); + } + + // ── Live API tests (manual) ── + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_text_to_video_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A glowing crystal rocket launching from Mars.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..grok_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Grok(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_480p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog leaps into the lake and splashes around.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + resolution: Some(RouterResolution::FourEightyP), + duration_seconds: Some(5), + ..grok_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Grok(_))); + } + + #[tokio::test] + #[ignore] // requires real API key, incurs costs + async fn test_image_to_video_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("The dog leaps into the lake and splashes around.".to_string()), + start_frame: Some(ImageRef::Url(JUNO_AT_LAKE_IMAGE_URL.to_string())), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(5), + ..grok_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Grok(_))); + } + + fn grok_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::GrokImagineVideo1p5, + provider: RouterProvider::GrokApi, + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_grok_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/grok_api_key.txt") + .expect("Failed to read Grok API key"); + let api_key = GrokApiKey::new(secret.trim().to_string()); + RouterClient::GrokApi(RouterGrokApiClient::new(api_key)) + } + + fn unwrap_request(builder: GenerateVideoRequestBuilder) -> GrokApiGrokImagineVideo1p5RequestState { + let result = builder.build2().expect("build2 should succeed"); + match result { + VideoGenerationDraftOrRequest::Request( + crate::generate::generate_video::video_generation_request::VideoGenerationRequest::GrokApiGrokImagineVideo1p5(s) + ) => s, + _ => panic!("expected GrokApiGrokImagineVideo1p5 request"), + } + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_grok_client(); + let draft_or_request = builder.build2().expect("build2 should succeed"); + let request = match draft_or_request { + VideoGenerationDraftOrRequest::Request(r) => r, + _ => panic!("expected Request variant (Grok skips draft)"), + }; + let response = request.send_request(&client).await.expect("send_request should succeed"); + match &response { + GenerateVideoResponse::Grok(p) => println!("grok request_id={}", p.request_id), + other => println!("unexpected response: {:?}", other), + } + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/grok_api/mod.rs b/crates/router/src/generate/generate_video/providers/grok_api/mod.rs new file mode 100644 index 00000000..3368e9b1 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/grok_api/mod.rs @@ -0,0 +1,2 @@ +pub mod grok_imagine_video; +pub mod grok_imagine_video_1p5; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/common.rs b/crates/router/src/generate/generate_video/providers/higgsfield/common.rs new file mode 100644 index 00000000..83417592 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/common.rs @@ -0,0 +1,410 @@ +//! Planning helpers shared by every Higgsfield video model. The resolution +//! and aspect-ratio snapping primitives come from the image provider's +//! `common`; this adds durations, batches, bitrates, and reference triage. + +use higgsfield_client::types::image_batch_size::ImageBatchSize; +use higgsfield_client::types::media_role::MediaRole; +use higgsfield_client::types::video_aspect_ratio::{KlingAspectRatio, SeedanceVideoAspectRatio}; +use higgsfield_client::types::video_bitrate_mode::VideoBitrateMode; +use higgsfield_client::types::video_duration::{VideoDurationRange, VideoDurationSeconds}; +use log::warn; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::character_list_ref::CharacterListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_bitrate::RouterBitrate; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_image::providers::higgsfield::common::{aspect_ratio_value, nearest_aspect_ratio}; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::draft::{HiggsfieldVideoDraftState, HiggsfieldVideoPlan}; +use crate::generate::generate_video::providers::higgsfield::request::HiggsfieldVideoRequestState; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub(crate) use crate::generate::generate_image::providers::higgsfield::common::{require_prompt, snap_resolution}; + +/// Clip length: in range passes through; out of range clamps (or errors out +/// under `ErrorOut`). `None` means `default`. +pub(crate) fn plan_duration( + requested: Option, + range: VideoDurationRange, + default: u32, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let Some(requested) = requested else { + return Ok(VideoDurationSeconds::new(default)); + }; + let duration = VideoDurationSeconds::new(requested as u32); + if range.contains(duration) { + return Ok(duration); + } + if let RequestMismatchMitigationStrategy::ErrorOut = strategy { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{requested} (Higgsfield offers {}–{}s for this model)", range.min_seconds, range.max_seconds), + })); + } + let clamped = (requested as u32).clamp(range.min_seconds, range.max_seconds); + warn!("Higgsfield offers {}–{}s for this model; clamping {}s to {}s", range.min_seconds, range.max_seconds, requested, clamped); + Ok(VideoDurationSeconds::new(clamped)) +} + +/// The Seedance models render 1–4 clips per request; larger batches clamp +/// to 4 (or error out under `ErrorOut`). +pub(crate) fn plan_batch_size( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = video_batch_count.unwrap_or(1); + if count == 0 { + return Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)); + } + if let Some(batch_size) = ImageBatchSize::from_u32(count as u32) { + return Ok(batch_size); + } + match strategy { + RequestMismatchMitigationStrategy::ErrorOut => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{count} (Higgsfield renders at most {} per request)", ImageBatchSize::MAX), + })), + _ => { + warn!("Higgsfield renders at most {} videos per request; clamping {}", ImageBatchSize::MAX, count); + Ok(ImageBatchSize::Four) + } + } +} + +/// Models with no batch control render one clip; a bigger request is an +/// error under `ErrorOut` and otherwise renders one. +pub(crate) fn plan_single_video( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, + model: &str, +) -> Result<(), ArtcraftRouterError> { + match video_batch_count.unwrap_or(1) { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(()), + count => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{count} ({model} on Higgsfield renders one video per request)"), + })), + _ => { + warn!("{model} on Higgsfield renders one video per request; ignoring batch of {count}"); + Ok(()) + } + }, + } +} + +/// The Seedance menu: 21:9, 16:9, 4:3, 1:1, 3:4, 9:16, and (for the models +/// that take it) Auto. Unset / auto ratios become Auto when `allow_auto`, +/// else 16:9; everything else snaps to the nearest ratio. +pub(crate) fn plan_seedance_aspect_ratio(requested: Option, allow_auto: bool) -> SeedanceVideoAspectRatio { + use SeedanceVideoAspectRatio as Ar; + const CANDIDATES: &[(f64, Ar)] = &[ + (21.0 / 9.0, Ar::Landscape21x9), + (16.0 / 9.0, Ar::Landscape16x9), + (4.0 / 3.0, Ar::Landscape4x3), + (1.0, Ar::Square1x1), + (3.0 / 4.0, Ar::Portrait3x4), + (9.0 / 16.0, Ar::Portrait9x16), + ]; + match requested.and_then(aspect_ratio_value) { + None if allow_auto => Ar::Auto, + None => Ar::Landscape16x9, + Some(value) => nearest_aspect_ratio(value, CANDIDATES), + } +} + +/// Kling's menu: 16:9, 9:16, 1:1. Unset / auto ratios are 16:9. +pub(crate) fn plan_kling_aspect_ratio(requested: Option) -> KlingAspectRatio { + use KlingAspectRatio as Ar; + const CANDIDATES: &[(f64, Ar)] = &[ + (16.0 / 9.0, Ar::Landscape16x9), + (9.0 / 16.0, Ar::Portrait9x16), + (1.0, Ar::Square1x1), + ]; + match requested.and_then(aspect_ratio_value) { + None => Ar::Landscape16x9, + Some(value) => nearest_aspect_ratio(value, CANDIDATES), + } +} + +/// Seedance bitrate: the web app defaults to high. +pub(crate) fn plan_bitrate(bitrate: Option) -> VideoBitrateMode { + match bitrate { + None | Some(RouterBitrate::High) => VideoBitrateMode::High, + Some(RouterBitrate::Normal) => VideoBitrateMode::Standard, + } +} + +/// A model has no menu for a field the caller set: say so, once. +pub(crate) fn warn_ignored(model: &str, field: &str, value: Option) { + if let Some(value) = value { + warn!("{model} on Higgsfield has no {field} control; ignoring {value:?}"); + } +} + +/// The media a video request came with, before upload. Taken off the +/// builder as a unit so every model triages it the same way. +#[derive(Clone, Debug, Default)] +pub struct HiggsfieldVideoReferences { + pub start_frame: Option, + pub end_frame: Option, + pub reference_images: Option, + pub reference_videos: Option, + pub reference_audio: Option, +} + +impl HiggsfieldVideoReferences { + /// Pull every reference off the builder. Character references have no + /// Higgsfield equivalent and are dropped with a warning. + pub fn take_from(builder: &mut GenerateVideoRequestBuilder, model: &str) -> Self { + if let Some(CharacterListRef::CharacterTokens(tokens)) = builder.reference_character_tokens.take() { + if !tokens.is_empty() { + warn!("{model} on Higgsfield has no character references; dropping {}", tokens.len()); + } + } + Self { + start_frame: builder.start_frame.take(), + end_frame: builder.end_frame.take(), + reference_images: builder.reference_images.take().filter(|list| list_len(list) > 0), + reference_videos: builder.reference_videos.take().filter(|list| video_list_len(list) > 0), + reference_audio: builder.reference_audio.take().filter(|list| audio_list_len(list) > 0), + } + } + + /// Drop every reference kind the model's endpoint doesn't accept, with a + /// warning per kind, so a stray attachment doesn't fail the whole request. + pub fn retain_roles(&mut self, allowed: &[MediaRole], model: &str) { + if !allowed.contains(&MediaRole::StartImage) && self.start_frame.take().is_some() { + warn!("{model} on Higgsfield takes no start frame; dropping it"); + } + if !allowed.contains(&MediaRole::EndImage) && self.end_frame.take().is_some() { + warn!("{model} on Higgsfield takes no end frame; dropping it"); + } + if !allowed.contains(&MediaRole::Image) && self.reference_images.take().is_some() { + warn!("{model} on Higgsfield takes no reference images; dropping them"); + } + if !allowed.contains(&MediaRole::Video) && self.reference_videos.take().is_some() { + warn!("{model} on Higgsfield takes no reference videos; dropping them"); + } + if !allowed.contains(&MediaRole::Audio) && self.reference_audio.take().is_some() { + warn!("{model} on Higgsfield takes no reference audio; dropping it"); + } + } + + /// Reject over-limit lists before anything is uploaded. + pub fn check_limits(&self, max_images: usize, max_videos: usize, max_audio: usize, model: &str) -> Result<(), ArtcraftRouterError> { + check_limit(self.reference_image_count(), max_images, "reference_images", "reference images", model)?; + check_limit(self.reference_video_count(), max_videos, "reference_videos", "reference videos", model)?; + check_limit(self.reference_audio_count(), max_audio, "reference_audio", "reference audio files", model) + } + + pub fn is_empty(&self) -> bool { + self.start_frame.is_none() + && self.end_frame.is_none() + && self.reference_images.is_none() + && self.reference_videos.is_none() + && self.reference_audio.is_none() + } + + pub fn reference_image_count(&self) -> usize { + self.reference_images.as_ref().map(list_len).unwrap_or(0) + } + + pub fn reference_video_count(&self) -> usize { + self.reference_videos.as_ref().map(video_list_len).unwrap_or(0) + } + + pub fn reference_audio_count(&self) -> usize { + self.reference_audio.as_ref().map(audio_list_len).unwrap_or(0) + } + + pub fn has_any_image(&self) -> bool { + self.start_frame.is_some() || self.end_frame.is_some() || self.reference_image_count() > 0 + } +} + +fn check_limit(count: usize, max: usize, field: &'static str, what: &str, model: &str) -> Result<(), ArtcraftRouterError> { + if count > max { + return Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field, + value: format!("{count} {what} ({model} on Higgsfield takes at most {max})"), + })); + } + Ok(()) +} + +fn list_len(list: &ImageListRef) -> usize { + list.len() +} + +fn video_list_len(list: &VideoListRef) -> usize { + list.len() +} + +fn audio_list_len(list: &AudioListRef) -> usize { + list.len() +} + +/// Wrap a plan: with media to upload it's a draft, otherwise it's ready to +/// send. `ip_check` is whether uploads should run Higgsfield's IP check (the +/// Seedance models refuse unchecked media). +pub(crate) fn finish(plan: HiggsfieldVideoPlan, references: HiggsfieldVideoReferences, ip_check: bool) -> VideoGenerationDraftOrRequest { + if references.is_empty() { + if let HiggsfieldVideoPlan::Request(request) = plan { + return VideoGenerationDraftOrRequest::Request( + VideoGenerationRequest::HiggsfieldVideo(HiggsfieldVideoRequestState { request }), + ); + } + } + VideoGenerationDraftOrRequest::Draft(VideoGenerationDraftRequest::HiggsfieldVideo(HiggsfieldVideoDraftState { + plan, + unhandled_request_state: Some(references), + ip_check, + })) +} + +#[cfg(test)] +mod tests { + use super::*; + + mod durations_and_batches { + use super::*; + + const RANGE: VideoDurationRange = VideoDurationRange::new(4, 15); + + #[test] + fn in_range_passes_and_none_defaults() { + assert_eq!(plan_duration(Some(10), RANGE, 5, RequestMismatchMitigationStrategy::ErrorOut).unwrap().seconds(), 10); + assert_eq!(plan_duration(None, RANGE, 5, RequestMismatchMitigationStrategy::ErrorOut).unwrap().seconds(), 5); + } + + #[test] + fn out_of_range_clamps_or_errors() { + assert_eq!(plan_duration(Some(30), RANGE, 5, RequestMismatchMitigationStrategy::PayMoreUpgrade).unwrap().seconds(), 15); + assert_eq!(plan_duration(Some(1), RANGE, 5, RequestMismatchMitigationStrategy::PayLessDowngrade).unwrap().seconds(), 4); + assert!(matches!( + plan_duration(Some(30), RANGE, 5, RequestMismatchMitigationStrategy::ErrorOut), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "duration_seconds", .. })), + )); + } + + #[test] + fn batches() { + assert_eq!(plan_batch_size(Some(2), RequestMismatchMitigationStrategy::ErrorOut).unwrap(), ImageBatchSize::Two); + assert_eq!(plan_batch_size(Some(9), RequestMismatchMitigationStrategy::PayLessDowngrade).unwrap(), ImageBatchSize::Four); + assert!(plan_batch_size(Some(9), RequestMismatchMitigationStrategy::ErrorOut).is_err()); + assert!(plan_batch_size(Some(0), RequestMismatchMitigationStrategy::ErrorOut).is_err()); + assert!(plan_single_video(Some(1), RequestMismatchMitigationStrategy::ErrorOut, "x").is_ok()); + assert!(plan_single_video(Some(3), RequestMismatchMitigationStrategy::PayMoreUpgrade, "x").is_ok()); + assert!(plan_single_video(Some(3), RequestMismatchMitigationStrategy::ErrorOut, "x").is_err()); + } + } + + mod aspect_ratios_and_bitrate { + use super::*; + + #[test] + fn seedance() { + use SeedanceVideoAspectRatio as Ar; + assert_eq!(plan_seedance_aspect_ratio(None, true), Ar::Auto); + assert_eq!(plan_seedance_aspect_ratio(None, false), Ar::Landscape16x9); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::Auto), false), Ar::Landscape16x9); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::Auto), true), Ar::Auto); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::WideThreeByTwo), true), Ar::Landscape4x3); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::TallTwoByThree), true), Ar::Portrait3x4); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::TallNineByTwentyOne), true), Ar::Portrait9x16); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::WideTwentyOneByNine), true), Ar::Landscape21x9); + assert_eq!(plan_seedance_aspect_ratio(Some(RouterAspectRatio::Wide), true), Ar::Landscape16x9); + } + + #[test] + fn kling() { + use KlingAspectRatio as Ar; + assert_eq!(plan_kling_aspect_ratio(None), Ar::Landscape16x9); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::Auto)), Ar::Landscape16x9); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::WideThreeByTwo)), Ar::Landscape16x9); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::WideTwentyOneByNine)), Ar::Landscape16x9); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::TallTwoByThree)), Ar::Portrait9x16); + // Nearest by ratio value: 4:3 (1.33) is closer to 1:1 than to 16:9, + // while 3:4 (0.75) is closer to 9:16 (0.56) than to 1:1. + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::WideFourByThree)), Ar::Square1x1); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::TallThreeByFour)), Ar::Portrait9x16); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::WideFiveByFour)), Ar::Square1x1); + assert_eq!(plan_kling_aspect_ratio(Some(RouterAspectRatio::Square)), Ar::Square1x1); + } + + #[test] + fn bitrate() { + assert_eq!(plan_bitrate(None), VideoBitrateMode::High); + assert_eq!(plan_bitrate(Some(RouterBitrate::High)), VideoBitrateMode::High); + assert_eq!(plan_bitrate(Some(RouterBitrate::Normal)), VideoBitrateMode::Standard); + } + } + + mod references { + use super::*; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + fn full_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("s".into())), + end_frame: Some(ImageRef::Url("e".into())), + reference_images: Some(ImageListRef::Urls(vec!["a".into(), "b".into()])), + reference_videos: Some(VideoListRef::MediaFileTokens(vec![MediaFileToken::new_from_str("m_v")])), + reference_audio: Some(AudioListRef::Urls(vec!["x".into()])), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![])), + ..Default::default() + } + } + + #[test] + fn takes_everything_and_drops_empty_lists() { + let mut builder = full_builder(); + builder.reference_audio = Some(AudioListRef::Urls(vec![])); + let references = HiggsfieldVideoReferences::take_from(&mut builder, "x"); + assert!(references.start_frame.is_some() && references.end_frame.is_some()); + assert_eq!(references.reference_image_count(), 2); + assert_eq!(references.reference_video_count(), 1); + assert_eq!(references.reference_audio_count(), 0); + assert!(references.reference_audio.is_none()); + assert!(builder.start_frame.is_none() && builder.reference_images.is_none()); + assert!(!references.is_empty()); + assert!(HiggsfieldVideoReferences::default().is_empty()); + } + + #[test] + fn retain_roles_drops_what_the_model_cannot_take() { + let mut references = HiggsfieldVideoReferences::take_from(&mut full_builder(), "x"); + references.retain_roles(&[MediaRole::StartImage, MediaRole::Image], "x"); + assert!(references.start_frame.is_some()); + assert!(references.end_frame.is_none()); + assert_eq!(references.reference_image_count(), 2); + assert!(references.reference_videos.is_none()); + assert!(references.reference_audio.is_none()); + } + + #[test] + fn limits() { + let references = HiggsfieldVideoReferences::take_from(&mut full_builder(), "x"); + assert!(references.check_limits(2, 1, 1, "x").is_ok()); + assert!(matches!( + references.check_limits(1, 1, 1, "x"), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "reference_images", .. })), + )); + assert!(matches!( + references.check_limits(2, 0, 1, "x"), + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { field: "reference_videos", .. })), + )); + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/common_test_helpers.rs b/crates/router/src/generate/generate_video/providers/higgsfield/common_test_helpers.rs new file mode 100644 index 00000000..7d217114 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/common_test_helpers.rs @@ -0,0 +1,66 @@ +//! Test-only helpers shared by the per-model `build.rs` tests. + +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::router_provider::RouterProvider; +use crate::api::router_video_model::RouterVideoModel; +use crate::api::video_list_ref::VideoListRef; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::draft::{HiggsfieldVideoDraftState, HiggsfieldVideoPlan}; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +pub fn base_builder(model: RouterVideoModel) -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model, + provider: RouterProvider::Higgsfield, + prompt: Some("a shiba inu surfing a big wave".to_string()), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..Default::default() + } +} + +pub fn with_start_frame(mut builder: GenerateVideoRequestBuilder) -> GenerateVideoRequestBuilder { + builder.start_frame = Some(ImageRef::Url("https://cdn.example.com/start.png".to_string())); + builder +} + +pub fn with_reference_images(mut builder: GenerateVideoRequestBuilder, count: usize) -> GenerateVideoRequestBuilder { + let urls = (0..count).map(|i| format!("https://cdn.example.com/ref_{i}.png")).collect(); + builder.reference_images = Some(ImageListRef::Urls(urls)); + builder +} + +pub fn with_reference_videos(mut builder: GenerateVideoRequestBuilder, count: usize) -> GenerateVideoRequestBuilder { + let urls = (0..count).map(|i| format!("https://cdn.example.com/clip_{i}.mp4")).collect(); + builder.reference_videos = Some(VideoListRef::Urls(urls)); + builder +} + +/// The planned request out of a direct (no media) build. +pub fn unwrap_request(result: VideoGenerationDraftOrRequest) -> HiggsfieldVideoRequest { + match result { + VideoGenerationDraftOrRequest::Request(VideoGenerationRequest::HiggsfieldVideo(state)) => state.request, + other => panic!("expected a direct Higgsfield request, got {other:?}"), + } +} + +/// The draft out of a build with media. +pub fn unwrap_draft(result: VideoGenerationDraftOrRequest) -> HiggsfieldVideoDraftState { + match result { + VideoGenerationDraftOrRequest::Draft(VideoGenerationDraftRequest::HiggsfieldVideo(draft)) => draft, + other => panic!("expected a Higgsfield draft, got {other:?}"), + } +} + +/// The planned request inside a draft (media not yet attached). +pub fn unwrap_draft_request(result: VideoGenerationDraftOrRequest) -> (HiggsfieldVideoRequest, HiggsfieldVideoDraftState) { + let draft = unwrap_draft(result); + match &draft.plan { + HiggsfieldVideoPlan::Request(request) => (request.clone(), draft), + other => panic!("expected a planned request, got {other:?}"), + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/cost.rs b/crates/router/src/generate/generate_video/providers/higgsfield/cost.rs new file mode 100644 index 00000000..a5c6bf1c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/cost.rs @@ -0,0 +1,33 @@ +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoDraftState; +use crate::generate::generate_video::providers::higgsfield::request::HiggsfieldVideoRequestState; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; + +/// Cost state for first-party (cookie-session) Higgsfield video generation. +/// +/// This runs on the USER'S OWN Higgsfield account (its credits or unlimited +/// plan), so it consumes no ArtCraft credits. Reported as free / unlimited +/// like the other first-party providers; Higgsfield's own credit pricing +/// isn't modelled here. +pub struct HiggsfieldVideoCostState; + +impl HiggsfieldVideoCostState { + pub fn from_request(_request: &HiggsfieldVideoRequestState) -> Self { + Self + } + + pub fn from_draft(_draft: &HiggsfieldVideoDraftState) -> Self { + Self + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + VideoGenerationCostEstimate { + cost_in_credits: Some(0), + cost_in_usd_cents: None, + is_free: true, + is_unlimited: true, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/draft.rs b/crates/router/src/generate/generate_video/providers/higgsfield/draft.rs new file mode 100644 index 00000000..27f1efd5 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/draft.rs @@ -0,0 +1,125 @@ +use higgsfield_client::endpoints::generate::video::seedance_2p5::Seedance2p5Resolution; +use higgsfield_client::endpoints::generate::video::seedance_2p5_edit::Seedance2p5EditRequest; +use higgsfield_client::types::image_batch_size::ImageBatchSize; +use higgsfield_client::types::media_reference::MediaReference; +use higgsfield_client::types::video_bitrate_mode::VideoBitrateMode; +use log::{info, warn}; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::providers::higgsfield::common::HiggsfieldVideoReferences; +use crate::generate::generate_video::providers::higgsfield::request::HiggsfieldVideoRequestState; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; +use crate::utils::higgsfield_media::{upload_image_ref, upload_media_list, HiggsfieldMediaKind, HiggsfieldUploadContext}; + +/// What a `build.rs` planned, before media is uploaded. +#[derive(Clone, Debug)] +pub enum HiggsfieldVideoPlan { + /// A request that only needs its references attached. + Request(HiggsfieldVideoRequest), + /// Seedance 2.5 Edit can't be constructed until its source clip has a + /// Higgsfield media id. + Seedance2p5Edit(Seedance2p5EditPlan), +} + +#[derive(Clone, Debug)] +pub struct Seedance2p5EditPlan { + pub prompt: String, + pub resolution: Seedance2p5Resolution, + pub batch_size: ImageBatchSize, + pub generate_audio: bool, + pub bitrate_mode: VideoBitrateMode, +} + +impl HiggsfieldVideoPlan { + pub fn model_label(&self) -> &'static str { + match self { + Self::Request(request) => request.model_label(), + Self::Seedance2p5Edit(_) => "Seedance 2.5 Edit", + } + } + + pub fn batch_size(&self) -> u32 { + match self { + Self::Request(request) => request.batch_size(), + Self::Seedance2p5Edit(plan) => plan.batch_size.as_u32(), + } + } +} + +/// A planned Higgsfield video request whose keyframes / references still +/// have to be uploaded. `to_request` does the uploads, tags each by role, +/// and produces the sendable state. +#[derive(Clone, Debug)] +pub struct HiggsfieldVideoDraftState { + pub plan: HiggsfieldVideoPlan, + pub unhandled_request_state: Option, + /// Run Higgsfield's IP check on uploaded images and clips (the Seedance + /// models refuse media that hasn't been checked). + pub ip_check: bool, +} + +impl HiggsfieldVideoDraftState { + pub async fn to_request( + &mut self, + draft_context: &VideoGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_higgsfield_client_ref()?; + let uploads = HiggsfieldUploadContext { + session: &client.session, + maybe_map: draft_context.media_file_to_artcraft_url_map, + maybe_cache: draft_context.asset_upload_cache, + maybe_observer: draft_context.asset_upload_observer, + }; + let label = self.plan.model_label(); + + let references = self.unhandled_request_state.take().unwrap_or_default(); + + let start_frame = upload_image_ref(uploads, references.start_frame, self.ip_check).await?; + let end_frame = upload_image_ref(uploads, references.end_frame, self.ip_check).await?; + let images = upload_media_list(uploads, references.reference_images.map(Into::into), HiggsfieldMediaKind::Image, self.ip_check).await?; + let mut videos = upload_media_list(uploads, references.reference_videos.map(Into::into), HiggsfieldMediaKind::Video, self.ip_check).await?; + // Audio has no IP check. + let audio = upload_media_list(uploads, references.reference_audio.map(Into::into), HiggsfieldMediaKind::Audio, false).await?; + + let mut request = match self.plan.clone() { + HiggsfieldVideoPlan::Request(request) => request, + HiggsfieldVideoPlan::Seedance2p5Edit(plan) => { + if videos.is_empty() { + return Err(ArtcraftRouterError::InvalidInput("Seedance 2.5 Edit needs the video to edit as a reference".to_string())); + } + let source_video = videos.remove(0); + if !videos.is_empty() { + warn!("Seedance 2.5 Edit edits one clip; ignoring {} extra reference video(s)", videos.len()); + videos.clear(); + } + let mut request = Seedance2p5EditRequest::new(plan.prompt, source_video, plan.resolution); + request.batch_size = plan.batch_size; + request.generate_audio = plan.generate_audio; + request.bitrate_mode = plan.bitrate_mode; + HiggsfieldVideoRequest::Seedance2p5Edit(request) + } + }; + + attach(&mut request, start_frame.map(MediaReference::start_frame)); + attach(&mut request, end_frame.map(MediaReference::end_frame)); + for image in images { + request.push_media(MediaReference::image(image)); + } + for video in videos { + request.push_media(MediaReference::video(video)); + } + for clip in audio { + request.push_media(MediaReference::audio(clip)); + } + + info!("Higgsfield {} request finalized with {} reference(s)", label, request.medias().len()); + Ok(HiggsfieldVideoRequestState { request }) + } +} + +fn attach(request: &mut HiggsfieldVideoRequest, reference: Option) { + if let Some(reference) = reference { + request.push_media(reference); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/grok_imagine_1p5/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/grok_imagine_1p5/build.rs new file mode 100644 index 00000000..67413151 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/grok_imagine_1p5/build.rs @@ -0,0 +1,87 @@ +//! Grok Imagine 1.5 on Higgsfield: text- or image-to-video at 480p / 720p / +//! 1080p, 1–15s, one clip, a start frame and image references. The output +//! follows the start frame's aspect ("auto"); a requested ratio is ignored. + +use higgsfield_client::endpoints::generate::video::grok_imagine_1p5::{GrokImagine1p5Request, GrokImagine1p5Resolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_duration, plan_single_video, require_prompt, snap_resolution, warn_ignored, HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoPlan; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Grok Imagine 1.5"; +pub const MAX_REFERENCE_IMAGES: usize = 4; +const DEFAULT_DURATION_SECONDS: u32 = 6; + +const RESOLUTION_TIERS: &[(RouterResolution, GrokImagine1p5Resolution)] = &[ + (RouterResolution::FourEightyP, GrokImagine1p5Resolution::P480), + (RouterResolution::SevenTwentyP, GrokImagine1p5Resolution::P720), + (RouterResolution::TenEightyP, GrokImagine1p5Resolution::P1080), +]; + +pub fn build_higgsfield_grok_imagine_1p5(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(MODEL, "negative prompt", builder.negative_prompt.take()); + warn_ignored(MODEL, "aspect ratio", builder.aspect_ratio.take()); + warn_ignored(MODEL, "bitrate", builder.bitrate.take()); + warn_ignored(MODEL, "audio toggle", builder.generate_audio.take()); + plan_single_video(builder.video_batch_count.take(), strategy, MODEL)?; + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, MODEL); + references.retain_roles(GrokImagine1p5Request::MEDIA_ROLES, MODEL); + references.check_limits(MAX_REFERENCE_IMAGES, 0, 0, MODEL)?; + + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, GrokImagine1p5Resolution::P720, strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), GrokImagine1p5Request::DURATION, DEFAULT_DURATION_SECONDS, strategy)?; + let request = GrokImagine1p5Request::text_to_video(prompt, resolution, duration); + + Ok(finish(HiggsfieldVideoPlan::Request(HiggsfieldVideoRequest::GrokImagine1p5(request)), references, false)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::image_ref::ImageRef; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_draft, unwrap_request, with_start_frame}; + + fn built(builder: GenerateVideoRequestBuilder) -> GrokImagine1p5Request { + match unwrap_request(build_higgsfield_grok_imagine_1p5(builder).expect("build")) { + HiggsfieldVideoRequest::GrokImagine1p5(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn text_to_video_works_without_a_frame() { + let request = built(base_builder(RouterVideoModel::GrokImagineVideo1p5)); + assert_eq!(request.resolution, GrokImagine1p5Resolution::P720); + assert_eq!(request.duration.seconds(), 6); + } + + #[test] + fn four_k_snaps_to_1080p_and_durations_clamp() { + let mut b = base_builder(RouterVideoModel::GrokImagineVideo1p5); + b.resolution = Some(RouterResolution::FourK); + b.duration_seconds = Some(20); + let request = built(b); + assert_eq!(request.resolution, GrokImagine1p5Resolution::P1080); + assert_eq!(request.duration.seconds(), 15); + } + + #[test] + fn end_frames_are_dropped_but_start_frames_kept() { + let mut b = with_start_frame(base_builder(RouterVideoModel::GrokImagineVideo1p5)); + b.end_frame = Some(ImageRef::Url("https://cdn.example.com/end.png".to_string())); + let draft = unwrap_draft(build_higgsfield_grok_imagine_1p5(b).expect("build")); + let references = draft.unhandled_request_state.unwrap(); + assert!(references.start_frame.is_some()); + assert!(references.end_frame.is_none()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/grok_imagine_1p5/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/grok_imagine_1p5/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/grok_imagine_1p5/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_pro/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_pro/build.rs new file mode 100644 index 00000000..4d1813dc --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_pro/build.rs @@ -0,0 +1,56 @@ +//! Kling 3.0 Pro on Higgsfield: the "pro" (1080p) and "4K" modes of the +//! Kling 3.0 endpoint — 16:9 / 9:16 / 1:1, 3–15s, one clip, start and end +//! frames only. + +use higgsfield_client::endpoints::generate::video::kling_3p0::Kling3p0Resolution; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::kling_3p0_standard::build::build_kling_3p0; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Kling 3.0 Pro"; + +const RESOLUTION_TIERS: &[(RouterResolution, Kling3p0Resolution)] = &[ + (RouterResolution::TenEightyP, Kling3p0Resolution::P1080), + (RouterResolution::FourK, Kling3p0Resolution::FourK), +]; + +pub fn build_higgsfield_kling_3p0_pro(builder: GenerateVideoRequestBuilder) -> Result { + build_kling_3p0(builder, MODEL, RESOLUTION_TIERS, Kling3p0Resolution::P1080) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; + use higgsfield_client::endpoints::generate::video::kling_3p0::Kling3p0Request; + use higgsfield_client::types::video_mode::VideoMode; + + fn built(builder: GenerateVideoRequestBuilder) -> Kling3p0Request { + match unwrap_request(build_higgsfield_kling_3p0_pro(builder).expect("build")) { + HiggsfieldVideoRequest::Kling3p0(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn pro_is_1080p_or_4k() { + let mut b = base_builder(RouterVideoModel::Kling3p0Pro); + assert_eq!(built(b.clone()).resolution, Kling3p0Resolution::P1080); + b.resolution = Some(RouterResolution::FourK); + assert_eq!(built(b.clone()).resolution, Kling3p0Resolution::FourK); + assert_eq!(built(b.clone()).resolution.to_video_mode(), VideoMode::FourK); + // 720p is the Standard tier; Pro upgrades it to 1080p. + b.resolution = Some(RouterResolution::SevenTwentyP); + assert_eq!(built(b.clone()).resolution, Kling3p0Resolution::P1080); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(built(b.clone()).resolution, Kling3p0Resolution::P1080); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_kling_3p0_pro(b).is_err()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_pro/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_pro/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_pro/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_standard/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_standard/build.rs new file mode 100644 index 00000000..d5c290e2 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_standard/build.rs @@ -0,0 +1,105 @@ +//! Kling 3.0 Standard on Higgsfield: the "std" mode of the Kling 3.0 +//! endpoint — 720p, 16:9 / 9:16 / 1:1, 3–15s, one clip, start and end +//! frames only (no other references). + +use higgsfield_client::endpoints::generate::video::kling_3p0::{Kling3p0Request, Kling3p0Resolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_duration, plan_kling_aspect_ratio, plan_single_video, require_prompt, snap_resolution, warn_ignored, + HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoPlan; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Kling 3.0 Standard"; +const DEFAULT_DURATION_SECONDS: u32 = 5; + +/// Standard is the 720p tier; the other modes belong to Kling 3.0 Pro. +const RESOLUTION_TIERS: &[(RouterResolution, Kling3p0Resolution)] = &[ + (RouterResolution::SevenTwentyP, Kling3p0Resolution::P720), +]; + +pub fn build_higgsfield_kling_3p0_standard(builder: GenerateVideoRequestBuilder) -> Result { + build_kling_3p0(builder, MODEL, RESOLUTION_TIERS, Kling3p0Resolution::P720) +} + +/// Shared by Standard and Pro: only the resolution tiers differ. +pub(crate) fn build_kling_3p0( + mut builder: GenerateVideoRequestBuilder, + model: &str, + resolution_tiers: &[(RouterResolution, Kling3p0Resolution)], + default_resolution: Kling3p0Resolution, +) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(model, "negative prompt", builder.negative_prompt.take()); + warn_ignored(model, "bitrate", builder.bitrate.take()); + plan_single_video(builder.video_batch_count.take(), strategy, model)?; + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, model); + references.retain_roles(Kling3p0Request::MEDIA_ROLES, model); + + let aspect_ratio = plan_kling_aspect_ratio(builder.aspect_ratio.take()); + let resolution = snap_resolution(builder.resolution.take(), resolution_tiers, default_resolution, strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), Kling3p0Request::DURATION, DEFAULT_DURATION_SECONDS, strategy)?; + + let mut request = Kling3p0Request::text_to_video(prompt, aspect_ratio, resolution, duration); + request.sound = builder.generate_audio.take().unwrap_or(true); + + Ok(finish(HiggsfieldVideoPlan::Request(HiggsfieldVideoRequest::Kling3p0(request)), references, false)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_draft, unwrap_request, with_reference_images, with_start_frame}; + use higgsfield_client::types::video_aspect_ratio::KlingAspectRatio; + + fn built(builder: GenerateVideoRequestBuilder) -> Kling3p0Request { + match unwrap_request(build_higgsfield_kling_3p0_standard(builder).expect("build")) { + HiggsfieldVideoRequest::Kling3p0(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn standard_is_always_720p() { + let mut b = base_builder(RouterVideoModel::Kling3p0Standard); + assert_eq!(built(b.clone()).resolution, Kling3p0Resolution::P720); + b.resolution = Some(RouterResolution::FourK); + assert_eq!(built(b.clone()).resolution, Kling3p0Resolution::P720); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_kling_3p0_standard(b).is_err()); + } + + #[test] + fn options_flow_through() { + let mut b = base_builder(RouterVideoModel::Kling3p0Standard); + b.aspect_ratio = Some(RouterAspectRatio::TallThreeByFour); + b.duration_seconds = Some(12); + b.generate_audio = Some(false); + let request = built(b); + assert_eq!(request.aspect_ratio, KlingAspectRatio::Portrait9x16); + assert_eq!(request.duration.seconds(), 12); + assert!(!request.sound); + assert!(request.enhance_prompt); + } + + #[test] + fn keyframes_draft_without_ip_check_and_reference_images_are_dropped() { + let draft = unwrap_draft(build_higgsfield_kling_3p0_standard(with_start_frame(base_builder(RouterVideoModel::Kling3p0Standard))).expect("build")); + assert!(!draft.ip_check); + assert!(draft.unhandled_request_state.unwrap().start_frame.is_some()); + // Reference images aren't a Kling input; with nothing else attached the + // request goes straight out. + let result = build_higgsfield_kling_3p0_standard(with_reference_images(base_builder(RouterVideoModel::Kling3p0Standard), 2)).expect("build"); + assert!(matches!(result, VideoGenerationDraftOrRequest::Request(_))); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_standard/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_standard/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/kling_3p0_standard/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/minimax_h3/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/minimax_h3/build.rs new file mode 100644 index 00000000..d75da1a7 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/minimax_h3/build.rs @@ -0,0 +1,73 @@ +//! MiniMax H3 on Higgsfield: a fixed 2K output that follows its references +//! (no aspect-ratio or resolution controls), 5–15s, one clip, keyframes +//! plus image / video / audio references. + +use higgsfield_client::endpoints::generate::video::minimax_h3::MinimaxH3Request; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_duration, plan_single_video, require_prompt, warn_ignored, HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoPlan; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "MiniMax H3"; +pub const MAX_REFERENCE_IMAGES: usize = 9; +pub const MAX_REFERENCE_VIDEOS: usize = 3; +pub const MAX_REFERENCE_AUDIO: usize = 3; +const DEFAULT_DURATION_SECONDS: u32 = 5; + +pub fn build_higgsfield_minimax_h3(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(MODEL, "negative prompt", builder.negative_prompt.take()); + warn_ignored(MODEL, "aspect ratio", builder.aspect_ratio.take()); + warn_ignored(MODEL, "resolution", builder.resolution.take()); + warn_ignored(MODEL, "bitrate", builder.bitrate.take()); + warn_ignored(MODEL, "audio toggle", builder.generate_audio.take()); + plan_single_video(builder.video_batch_count.take(), strategy, MODEL)?; + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, MODEL); + references.retain_roles(MinimaxH3Request::MEDIA_ROLES, MODEL); + references.check_limits(MAX_REFERENCE_IMAGES, MAX_REFERENCE_VIDEOS, MAX_REFERENCE_AUDIO, MODEL)?; + + let duration = plan_duration(builder.duration_seconds.take(), MinimaxH3Request::DURATION, DEFAULT_DURATION_SECONDS, strategy)?; + let request = MinimaxH3Request::text_to_video(prompt, duration); + + Ok(finish(HiggsfieldVideoPlan::Request(HiggsfieldVideoRequest::MinimaxH3(request)), references, false)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + + fn built(builder: GenerateVideoRequestBuilder) -> MinimaxH3Request { + match unwrap_request(build_higgsfield_minimax_h3(builder).expect("build")) { + HiggsfieldVideoRequest::MinimaxH3(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn resolution_and_aspect_are_ignored_and_durations_clamp() { + let mut b = base_builder(RouterVideoModel::MinimaxH3); + b.resolution = Some(RouterResolution::FourK); + b.duration_seconds = Some(3); + assert_eq!(built(b).duration.seconds(), 5); + } + + #[test] + fn batches_are_single() { + let mut b = base_builder(RouterVideoModel::MinimaxH3); + b.video_batch_count = Some(3); + assert!(build_higgsfield_minimax_h3(b.clone()).is_ok()); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_minimax_h3(b).is_err()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/minimax_h3/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/minimax_h3/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/minimax_h3/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/mod.rs new file mode 100644 index 00000000..f8920f34 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/mod.rs @@ -0,0 +1,33 @@ +//! First-party (cookie-session) Higgsfield video generation. +//! +//! Runs on the user's own higgsfield.ai account through a +//! [`HiggsfieldSession`](higgsfield_client::session::higgsfield_session::HiggsfieldSession). +//! Keyframes and image / video / audio references have to live on +//! Higgsfield first, so any request with media goes through the draft +//! phase: `finalize()` downloads each reference (ArtCraft CDN URL or media +//! token), uploads it as Higgsfield reference media (with the IP check the +//! Seedance models insist on), and the request goes out with the resulting +//! media ids tagged by role (start / end frame, image, video, audio). +//! +//! Each model has its own `build.rs` that plans the request against the +//! option menus Higgsfield actually offers — unsupported resolutions, +//! durations, ratios and batch sizes snap to the nearest tier per the +//! mismatch strategy, and reference kinds a model can't take are dropped +//! with a warning. The plumbing after that (draft, upload, send, cost) is +//! shared across all models via [`video_request::HiggsfieldVideoRequest`]. + +pub mod common; +#[cfg(test)] +pub(crate) mod common_test_helpers; +pub mod cost; +pub mod draft; +pub mod grok_imagine_1p5; +pub mod kling_3p0_pro; +pub mod kling_3p0_standard; +pub mod minimax_h3; +pub mod request; +pub mod seedance_2p0; +pub mod seedance_2p0_mini; +pub mod seedance_2p5; +pub mod seedance_2p5_edit; +pub mod video_request; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/request.rs b/crates/router/src/generate/generate_video/providers/higgsfield/request.rs new file mode 100644 index 00000000..7042ba36 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/request.rs @@ -0,0 +1,38 @@ +use log::info; + +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{GenerateVideoResponse, HiggsfieldVideoResponsePayload}; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; + +/// A ready-to-send Higgsfield video request: every keyframe and reference +/// has been uploaded and is referenced by its Higgsfield media id. +#[derive(Clone, Debug)] +pub struct HiggsfieldVideoRequestState { + pub request: HiggsfieldVideoRequest, +} + +impl HiggsfieldVideoRequestState { + pub async fn send(&self, client: &RouterHiggsfieldClient) -> Result { + info!( + "Enqueuing Higgsfield {} video job: batch={}, references={}", + self.request.model_label(), self.request.batch_size(), self.request.medias().len(), + ); + + let response = self.request.send(&client.session).await + .map_err(|err| ArtcraftRouterError::from(ProviderError::Higgsfield(err)))?; + + let job_ids: Vec = response.job_ids().into_iter().map(|id| id.into_string()).collect(); + let job_set_id = response.first_job_set() + .map(|job_set| job_set.id.to_string()) + .filter(|_| !job_ids.is_empty()) + .ok_or_else(|| ArtcraftRouterError::ProviderResponseInvalid( + "Higgsfield accepted the request but returned no jobs".to_string(), + ))?; + + info!("Higgsfield enqueued job set {} with {} job(s)", job_set_id, job_ids.len()); + + Ok(GenerateVideoResponse::Higgsfield(HiggsfieldVideoResponsePayload { job_set_id, job_ids })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0/build.rs new file mode 100644 index 00000000..e58bb060 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0/build.rs @@ -0,0 +1,98 @@ +//! Seedance 2.0 on Higgsfield: Auto / 21:9 / 16:9 / 4:3 / 1:1 / 3:4 / 9:16, +//! 480p / 720p / 1080p / 4K, 4–15s, 1–4 clips, keyframes plus image / +//! video / audio references. + +use higgsfield_client::endpoints::generate::video::seedance_2p0::{Seedance2p0Request, Seedance2p0Resolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_batch_size, plan_bitrate, plan_duration, plan_seedance_aspect_ratio, require_prompt, snap_resolution, + warn_ignored, HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoPlan; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Seedance 2.0"; +pub const MAX_REFERENCE_IMAGES: usize = 9; +pub const MAX_REFERENCE_VIDEOS: usize = 3; +pub const MAX_REFERENCE_AUDIO: usize = 3; +const DEFAULT_DURATION_SECONDS: u32 = 5; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedance2p0Resolution)] = &[ + (RouterResolution::FourEightyP, Seedance2p0Resolution::P480), + (RouterResolution::SevenTwentyP, Seedance2p0Resolution::P720), + (RouterResolution::TenEightyP, Seedance2p0Resolution::P1080), + (RouterResolution::FourK, Seedance2p0Resolution::FourK), +]; + +pub fn build_higgsfield_seedance_2p0(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(MODEL, "negative prompt", builder.negative_prompt.take()); + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, MODEL); + references.retain_roles(Seedance2p0Request::MEDIA_ROLES, MODEL); + references.check_limits(MAX_REFERENCE_IMAGES, MAX_REFERENCE_VIDEOS, MAX_REFERENCE_AUDIO, MODEL)?; + + let aspect_ratio = plan_seedance_aspect_ratio(builder.aspect_ratio.take(), true); + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, Seedance2p0Resolution::P720, strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), Seedance2p0Request::DURATION, DEFAULT_DURATION_SECONDS, strategy)?; + + let mut request = Seedance2p0Request::text_to_video(prompt, aspect_ratio, resolution, duration); + request.batch_size = plan_batch_size(builder.video_batch_count.take(), strategy)?; + request.generate_audio = builder.generate_audio.take().unwrap_or(true); + request.bitrate_mode = plan_bitrate(builder.bitrate.take()); + + Ok(finish(HiggsfieldVideoPlan::Request(HiggsfieldVideoRequest::Seedance2p0(request)), references, true)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + use higgsfield_client::types::video_aspect_ratio::SeedanceVideoAspectRatio; + + fn built(builder: GenerateVideoRequestBuilder) -> Seedance2p0Request { + match unwrap_request(build_higgsfield_seedance_2p0(builder).expect("build")) { + HiggsfieldVideoRequest::Seedance2p0(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn four_k_and_auto_are_offered() { + let mut b = base_builder(RouterVideoModel::Seedance2p0); + b.resolution = Some(RouterResolution::FourK); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + let request = built(b); + assert_eq!(request.resolution, Seedance2p0Resolution::FourK); + assert_eq!(request.aspect_ratio, SeedanceVideoAspectRatio::Auto); + } + + #[test] + fn image_tiers_snap_into_the_video_ladder() { + let mut b = base_builder(RouterVideoModel::Seedance2p0); + // 1K sits between 720p and 1080p. + b.resolution = Some(RouterResolution::OneK); + assert_eq!(built(b.clone()).resolution, Seedance2p0Resolution::P1080); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayLessDowngrade; + assert_eq!(built(b.clone()).resolution, Seedance2p0Resolution::P720); + // 2K sits between 1080p and 4K. + b.resolution = Some(RouterResolution::TwoK); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::PayMoreUpgrade; + assert_eq!(built(b).resolution, Seedance2p0Resolution::FourK); + } + + #[test] + fn durations_clamp_to_4_to_15() { + let mut b = base_builder(RouterVideoModel::Seedance2p0); + b.duration_seconds = Some(30); + assert_eq!(built(b).duration.seconds(), 15); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0_mini/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0_mini/build.rs new file mode 100644 index 00000000..7d80a3ff --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0_mini/build.rs @@ -0,0 +1,80 @@ +//! Seedance 2.0 Mini on Higgsfield: Auto / 21:9 / 16:9 / 4:3 / 1:1 / 3:4 / +//! 9:16, 480p / 720p, 4–15s, 1–4 clips, keyframes plus image / video / +//! audio references. No bitrate menu. + +use higgsfield_client::endpoints::generate::video::seedance_2p0_mini::{Seedance2p0MiniRequest, Seedance2p0MiniResolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_batch_size, plan_duration, plan_seedance_aspect_ratio, require_prompt, snap_resolution, warn_ignored, + HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoPlan; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Seedance 2.0 Mini"; +pub const MAX_REFERENCE_IMAGES: usize = 9; +pub const MAX_REFERENCE_VIDEOS: usize = 3; +pub const MAX_REFERENCE_AUDIO: usize = 3; +const DEFAULT_DURATION_SECONDS: u32 = 5; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedance2p0MiniResolution)] = &[ + (RouterResolution::FourEightyP, Seedance2p0MiniResolution::P480), + (RouterResolution::SevenTwentyP, Seedance2p0MiniResolution::P720), +]; + +pub fn build_higgsfield_seedance_2p0_mini(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(MODEL, "negative prompt", builder.negative_prompt.take()); + warn_ignored(MODEL, "bitrate", builder.bitrate.take()); + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, MODEL); + references.retain_roles(Seedance2p0MiniRequest::MEDIA_ROLES, MODEL); + references.check_limits(MAX_REFERENCE_IMAGES, MAX_REFERENCE_VIDEOS, MAX_REFERENCE_AUDIO, MODEL)?; + + let aspect_ratio = plan_seedance_aspect_ratio(builder.aspect_ratio.take(), true); + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, Seedance2p0MiniResolution::P720, strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), Seedance2p0MiniRequest::DURATION, DEFAULT_DURATION_SECONDS, strategy)?; + + let mut request = Seedance2p0MiniRequest::text_to_video(prompt, aspect_ratio, resolution, duration); + request.batch_size = plan_batch_size(builder.video_batch_count.take(), strategy)?; + request.generate_audio = builder.generate_audio.take().unwrap_or(true); + + Ok(finish(HiggsfieldVideoPlan::Request(HiggsfieldVideoRequest::Seedance2p0Mini(request)), references, true)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_request}; + + fn built(builder: GenerateVideoRequestBuilder) -> Seedance2p0MiniRequest { + match unwrap_request(build_higgsfield_seedance_2p0_mini(builder).expect("build")) { + HiggsfieldVideoRequest::Seedance2p0Mini(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn tops_out_at_720p() { + let mut b = base_builder(RouterVideoModel::Seedance2p0Mini); + b.resolution = Some(RouterResolution::FourK); + assert_eq!(built(b.clone()).resolution, Seedance2p0MiniResolution::P720); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_seedance_2p0_mini(b).is_err()); + } + + #[test] + fn defaults() { + let request = built(base_builder(RouterVideoModel::Seedance2p0Mini)); + assert_eq!(request.resolution, Seedance2p0MiniResolution::P720); + assert_eq!(request.duration.seconds(), 5); + assert!(request.generate_audio); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0_mini/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0_mini/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p0_mini/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5/build.rs new file mode 100644 index 00000000..62fcdbd1 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5/build.rs @@ -0,0 +1,142 @@ +//! Seedance 2.5 on Higgsfield: 21:9 / 16:9 / 4:3 / 1:1 / 3:4 / 9:16 (no +//! Auto), 480p / 720p / 1080p, 4–30s, 1–4 clips, keyframes plus image / +//! video / audio references. + +use higgsfield_client::endpoints::generate::video::seedance_2p5::{Seedance2p5Request, Seedance2p5Resolution}; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_batch_size, plan_bitrate, plan_duration, plan_seedance_aspect_ratio, require_prompt, snap_resolution, + warn_ignored, HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoPlan; +use crate::generate::generate_video::providers::higgsfield::video_request::HiggsfieldVideoRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Seedance 2.5"; +pub const MAX_REFERENCE_IMAGES: usize = 9; +pub const MAX_REFERENCE_VIDEOS: usize = 3; +pub const MAX_REFERENCE_AUDIO: usize = 3; +const DEFAULT_DURATION_SECONDS: u32 = 5; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedance2p5Resolution)] = &[ + (RouterResolution::FourEightyP, Seedance2p5Resolution::P480), + (RouterResolution::SevenTwentyP, Seedance2p5Resolution::P720), + (RouterResolution::TenEightyP, Seedance2p5Resolution::P1080), +]; + +pub fn build_higgsfield_seedance_2p5(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(MODEL, "negative prompt", builder.negative_prompt.take()); + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, MODEL); + references.retain_roles(Seedance2p5Request::MEDIA_ROLES, MODEL); + references.check_limits(MAX_REFERENCE_IMAGES, MAX_REFERENCE_VIDEOS, MAX_REFERENCE_AUDIO, MODEL)?; + + let aspect_ratio = plan_seedance_aspect_ratio(builder.aspect_ratio.take(), false); + let resolution = snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, Seedance2p5Resolution::P720, strategy)?; + let duration = plan_duration(builder.duration_seconds.take(), Seedance2p5Request::DURATION, DEFAULT_DURATION_SECONDS, strategy)?; + + let mut request = Seedance2p5Request::text_to_video(prompt, aspect_ratio, resolution, duration); + request.batch_size = plan_batch_size(builder.video_batch_count.take(), strategy)?; + request.generate_audio = builder.generate_audio.take().unwrap_or(true); + request.bitrate_mode = plan_bitrate(builder.bitrate.take()); + + Ok(finish(HiggsfieldVideoPlan::Request(HiggsfieldVideoRequest::Seedance2p5(request)), references, true)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_bitrate::RouterBitrate; + use crate::api::router_video_model::RouterVideoModel; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_draft_request, unwrap_request, with_reference_images, with_start_frame}; + use higgsfield_client::types::image_batch_size::ImageBatchSize; + use higgsfield_client::types::video_aspect_ratio::SeedanceVideoAspectRatio; + use higgsfield_client::types::video_bitrate_mode::VideoBitrateMode; + + fn builder() -> GenerateVideoRequestBuilder { + base_builder(RouterVideoModel::Seedance2p5) + } + + fn built(builder: GenerateVideoRequestBuilder) -> Seedance2p5Request { + match unwrap_request(build_higgsfield_seedance_2p5(builder).expect("build")) { + HiggsfieldVideoRequest::Seedance2p5(request) => request, + other => panic!("wrong model: {other:?}"), + } + } + + #[test] + fn defaults_are_the_web_apps() { + let request = built(builder()); + assert_eq!(request.aspect_ratio, SeedanceVideoAspectRatio::Landscape16x9); + assert_eq!(request.resolution, Seedance2p5Resolution::P720); + assert_eq!(request.duration.seconds(), 5); + assert_eq!(request.batch_size, ImageBatchSize::One); + assert!(request.generate_audio); + assert_eq!(request.bitrate_mode, VideoBitrateMode::High); + assert!(request.medias.is_empty()); + } + + #[test] + fn options_flow_through() { + let mut b = builder(); + b.aspect_ratio = Some(RouterAspectRatio::TallNineBySixteen); + b.resolution = Some(RouterResolution::TenEightyP); + b.duration_seconds = Some(30); + b.video_batch_count = Some(2); + b.generate_audio = Some(false); + b.bitrate = Some(RouterBitrate::Normal); + let request = built(b); + assert_eq!(request.aspect_ratio, SeedanceVideoAspectRatio::Portrait9x16); + assert_eq!(request.resolution, Seedance2p5Resolution::P1080); + assert_eq!(request.duration.seconds(), 30); + assert_eq!(request.batch_size, ImageBatchSize::Two); + assert!(!request.generate_audio); + assert_eq!(request.bitrate_mode, VideoBitrateMode::Standard); + } + + #[test] + fn four_k_is_not_offered_and_snaps_to_1080p() { + let mut b = builder(); + b.resolution = Some(RouterResolution::FourK); + assert_eq!(built(b.clone()).resolution, Seedance2p5Resolution::P1080); + b.request_mismatch_mitigation_strategy = RequestMismatchMitigationStrategy::ErrorOut; + assert!(build_higgsfield_seedance_2p5(b).is_err()); + } + + #[test] + fn durations_clamp_to_4_to_30() { + let mut b = builder(); + b.duration_seconds = Some(45); + assert_eq!(built(b.clone()).duration.seconds(), 30); + b.duration_seconds = Some(2); + assert_eq!(built(b).duration.seconds(), 4); + } + + #[test] + fn auto_aspect_becomes_16x9_because_2p5_has_no_auto() { + let mut b = builder(); + b.aspect_ratio = Some(RouterAspectRatio::Auto); + assert_eq!(built(b).aspect_ratio, SeedanceVideoAspectRatio::Landscape16x9); + } + + #[test] + fn media_makes_a_draft_that_runs_the_ip_check() { + let (request, draft) = unwrap_draft_request(build_higgsfield_seedance_2p5(with_start_frame(builder())).expect("build")); + assert!(draft.ip_check); + assert!(request.medias().is_empty(), "media is attached at finalize"); + assert!(draft.unhandled_request_state.as_ref().unwrap().start_frame.is_some()); + } + + #[test] + fn too_many_references_are_rejected_before_upload() { + assert!(build_higgsfield_seedance_2p5(with_reference_images(builder(), MAX_REFERENCE_IMAGES + 1)).is_err()); + assert!(build_higgsfield_seedance_2p5(with_reference_images(builder(), MAX_REFERENCE_IMAGES)).is_ok()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5_edit/build.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5_edit/build.rs new file mode 100644 index 00000000..64a97ced --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5_edit/build.rs @@ -0,0 +1,101 @@ +//! Seedance 2.5 Edit on Higgsfield: video-to-video. The first reference +//! video is the clip to edit; image and audio references guide the edit. +//! 480p / 720p / 1080p, 1–4 clips. The output follows the source clip, so +//! aspect ratio and duration have no effect and are ignored. + +use higgsfield_client::endpoints::generate::video::seedance_2p5::Seedance2p5Resolution; +use higgsfield_client::endpoints::generate::video::seedance_2p5_edit::Seedance2p5EditRequest; +use higgsfield_client::types::media_role::MediaRole; + +use crate::api::router_resolution::RouterResolution; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::higgsfield::common::{ + finish, plan_batch_size, plan_bitrate, require_prompt, snap_resolution, warn_ignored, HiggsfieldVideoReferences, +}; +use crate::generate::generate_video::providers::higgsfield::draft::{HiggsfieldVideoPlan, Seedance2p5EditPlan}; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +const MODEL: &str = "Seedance 2.5 Edit"; +pub const MAX_REFERENCE_IMAGES: usize = 9; +/// The source clip plus nothing else. +pub const MAX_REFERENCE_VIDEOS: usize = 1; +pub const MAX_REFERENCE_AUDIO: usize = 3; + +const RESOLUTION_TIERS: &[(RouterResolution, Seedance2p5Resolution)] = &[ + (RouterResolution::FourEightyP, Seedance2p5Resolution::P480), + (RouterResolution::SevenTwentyP, Seedance2p5Resolution::P720), + (RouterResolution::TenEightyP, Seedance2p5Resolution::P1080), +]; + +/// The roles the edit takes on top of its source clip. +const ACCEPTED_ROLES: &[MediaRole] = &[MediaRole::Video, MediaRole::Image, MediaRole::Audio]; + +pub fn build_higgsfield_seedance_2p5_edit(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + let prompt = require_prompt(builder.prompt.take())?; + warn_ignored(MODEL, "negative prompt", builder.negative_prompt.take()); + warn_ignored(MODEL, "aspect ratio", builder.aspect_ratio.take()); + warn_ignored(MODEL, "duration", builder.duration_seconds.take()); + + let mut references = HiggsfieldVideoReferences::take_from(&mut builder, MODEL); + references.retain_roles(ACCEPTED_ROLES, MODEL); + if references.reference_video_count() == 0 { + return Err(ArtcraftRouterError::InvalidInput("Seedance 2.5 Edit needs the video to edit as a reference video".to_string())); + } + references.check_limits(MAX_REFERENCE_IMAGES, MAX_REFERENCE_VIDEOS, MAX_REFERENCE_AUDIO, MODEL)?; + debug_assert!(Seedance2p5EditRequest::MEDIA_ROLES.iter().all(|role| ACCEPTED_ROLES.contains(role))); + + let plan = Seedance2p5EditPlan { + prompt, + resolution: snap_resolution(builder.resolution.take(), RESOLUTION_TIERS, Seedance2p5Resolution::P720, strategy)?, + batch_size: plan_batch_size(builder.video_batch_count.take(), strategy)?, + generate_audio: builder.generate_audio.take().unwrap_or(true), + bitrate_mode: plan_bitrate(builder.bitrate.take()), + }; + + Ok(finish(HiggsfieldVideoPlan::Seedance2p5Edit(plan), references, true)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_video_model::RouterVideoModel; + use crate::generate::generate_video::providers::higgsfield::common_test_helpers::{base_builder, unwrap_draft, with_reference_videos, with_start_frame}; + + fn builder() -> GenerateVideoRequestBuilder { + with_reference_videos(base_builder(RouterVideoModel::Seedance2p5Edit), 1) + } + + #[test] + fn needs_a_source_video() { + let err = build_higgsfield_seedance_2p5_edit(base_builder(RouterVideoModel::Seedance2p5Edit)).unwrap_err(); + assert!(matches!(err, ArtcraftRouterError::InvalidInput(_))); + assert!(build_higgsfield_seedance_2p5_edit(with_reference_videos(base_builder(RouterVideoModel::Seedance2p5Edit), 2)).is_err()); + } + + #[test] + fn always_drafts_with_an_edit_plan() { + let mut b = builder(); + b.resolution = Some(RouterResolution::FourK); + b.video_batch_count = Some(2); + b.generate_audio = Some(false); + let draft = unwrap_draft(build_higgsfield_seedance_2p5_edit(b).expect("build")); + assert!(draft.ip_check); + match draft.plan { + HiggsfieldVideoPlan::Seedance2p5Edit(plan) => { + assert_eq!(plan.resolution, Seedance2p5Resolution::P1080); + assert_eq!(plan.batch_size.as_u32(), 2); + assert!(!plan.generate_audio); + } + other => panic!("expected an edit plan, got {other:?}"), + } + assert_eq!(draft.unhandled_request_state.unwrap().reference_video_count(), 1); + } + + #[test] + fn keyframes_are_dropped_not_rejected() { + let draft = unwrap_draft(build_higgsfield_seedance_2p5_edit(with_start_frame(builder())).expect("build")); + assert!(draft.unhandled_request_state.unwrap().start_frame.is_none()); + } +} diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5_edit/mod.rs b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5_edit/mod.rs new file mode 100644 index 00000000..76f610c3 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/seedance_2p5_edit/mod.rs @@ -0,0 +1 @@ +pub mod build; diff --git a/crates/router/src/generate/generate_video/providers/higgsfield/video_request.rs b/crates/router/src/generate/generate_video/providers/higgsfield/video_request.rs new file mode 100644 index 00000000..36969e45 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/higgsfield/video_request.rs @@ -0,0 +1,107 @@ +//! One planned Higgsfield video request, whichever model it's for. The +//! per-model `build.rs` files produce these (or, for Seedance 2.5 Edit, a +//! plan that becomes one once the source clip is uploaded); the shared +//! draft / request / cost states carry them. + +use higgsfield_client::endpoints::generate::video::grok_imagine_1p5::GrokImagine1p5Request; +use higgsfield_client::endpoints::generate::video::kling_3p0::Kling3p0Request; +use higgsfield_client::endpoints::generate::video::minimax_h3::MinimaxH3Request; +use higgsfield_client::endpoints::generate::video::seedance_2p0::Seedance2p0Request; +use higgsfield_client::endpoints::generate::video::seedance_2p0_mini::Seedance2p0MiniRequest; +use higgsfield_client::endpoints::generate::video::seedance_2p5::Seedance2p5Request; +use higgsfield_client::endpoints::generate::video::seedance_2p5_edit::Seedance2p5EditRequest; +use higgsfield_client::error::higgsfield_error::HiggsfieldError; +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; +use higgsfield_client::types::enqueue_jobs_response::EnqueueJobsResponse; +use higgsfield_client::types::media_reference::MediaReference; + +#[derive(Clone, Debug)] +pub enum HiggsfieldVideoRequest { + Seedance2p5(Seedance2p5Request), + Seedance2p5Edit(Seedance2p5EditRequest), + Seedance2p0(Seedance2p0Request), + Seedance2p0Mini(Seedance2p0MiniRequest), + MinimaxH3(MinimaxH3Request), + /// Both Kling 3.0 model ids: the "mode" (std / pro / 4K) is in the request. + Kling3p0(Kling3p0Request), + GrokImagine1p5(GrokImagine1p5Request), +} + +impl HiggsfieldVideoRequest { + /// Enqueue on the session (which mints the bearer token and retries once + /// on a rejected token). + pub async fn send(&self, session: &HiggsfieldSession) -> Result { + match self { + Self::Seedance2p5(request) => session.seedance_2p5(request.clone()).await, + Self::Seedance2p5Edit(request) => session.seedance_2p5_edit(request.clone()).await, + Self::Seedance2p0(request) => session.seedance_2p0(request.clone()).await, + Self::Seedance2p0Mini(request) => session.seedance_2p0_mini(request.clone()).await, + Self::MinimaxH3(request) => session.minimax_h3(request.clone()).await, + Self::Kling3p0(request) => session.kling_3p0(request.clone()).await, + Self::GrokImagine1p5(request) => session.grok_imagine_1p5(request.clone()).await, + } + } + + /// Attach an uploaded reference with its role. (For Seedance 2.5 Edit the + /// source clip is set at construction; this adds the extra references.) + pub fn push_media(&mut self, reference: MediaReference) { + match self { + Self::Seedance2p5(request) => request.medias.push(reference), + Self::Seedance2p5Edit(request) => request.references.push(reference), + Self::Seedance2p0(request) => request.medias.push(reference), + Self::Seedance2p0Mini(request) => request.medias.push(reference), + Self::MinimaxH3(request) => request.medias.push(reference), + Self::Kling3p0(request) => request.medias.push(reference), + Self::GrokImagine1p5(request) => request.medias.push(reference), + } + } + + /// The attached references (excluding Seedance 2.5 Edit's source clip). + pub fn medias(&self) -> &[MediaReference] { + match self { + Self::Seedance2p5(request) => &request.medias, + Self::Seedance2p5Edit(request) => &request.references, + Self::Seedance2p0(request) => &request.medias, + Self::Seedance2p0Mini(request) => &request.medias, + Self::MinimaxH3(request) => &request.medias, + Self::Kling3p0(request) => &request.medias, + Self::GrokImagine1p5(request) => &request.medias, + } + } + + pub fn prompt(&self) -> &str { + match self { + Self::Seedance2p5(request) => &request.prompt, + Self::Seedance2p5Edit(request) => &request.prompt, + Self::Seedance2p0(request) => &request.prompt, + Self::Seedance2p0Mini(request) => &request.prompt, + Self::MinimaxH3(request) => &request.prompt, + Self::Kling3p0(request) => &request.prompt, + Self::GrokImagine1p5(request) => &request.prompt, + } + } + + /// How many clips the request renders. + pub fn batch_size(&self) -> u32 { + match self { + Self::Seedance2p5(request) => request.batch_size.as_u32(), + Self::Seedance2p5Edit(request) => request.batch_size.as_u32(), + Self::Seedance2p0(request) => request.batch_size.as_u32(), + Self::Seedance2p0Mini(request) => request.batch_size.as_u32(), + Self::MinimaxH3(_) | Self::Kling3p0(_) | Self::GrokImagine1p5(_) => 1, + } + } + + /// A short label for logs. + pub fn model_label(&self) -> &'static str { + match self { + Self::Seedance2p5(_) => "Seedance 2.5", + Self::Seedance2p5Edit(_) => "Seedance 2.5 Edit", + Self::Seedance2p0(_) => "Seedance 2.0", + Self::Seedance2p0Mini(_) => "Seedance 2.0 Mini", + Self::MinimaxH3(_) => "MiniMax H3", + Self::Kling3p0(_) => "Kling 3.0", + Self::GrokImagine1p5(_) => "Grok Imagine 1.5", + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/build.rs b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/build.rs new file mode 100644 index 00000000..03b849bc --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/build.rs @@ -0,0 +1,460 @@ +use seedance2pro_client::generate::video::generate_happy_horse_1p0::{ + KinoviHappyHorse1p0AspectRatio, KinoviHappyHorse1p0BatchCount, + KinoviHappyHorse1p0OutputResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::draft::{ + KinoviHappyHorse1p0DraftState, KinoviHappyHorse1p0RemainingItems, +}; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +pub fn build_kinovi_happy_horse_1p0(builder: GenerateVideoRequestBuilder) -> Result { + let draft = do_build(builder)?; + Ok(VideoGenerationDraftOrRequest::Draft(VideoGenerationDraftRequest::KinoviHappyHorse1p0(draft))) +} + +fn do_build(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_output_resolution(builder.resolution.take(), strategy)?; + let batch_count = plan_batch_count(builder.video_batch_count.take(), strategy)?; + let duration_seconds = plan_duration(builder.duration_seconds.take(), strategy)?; + let prompt = builder.prompt.take().unwrap_or_default(); + + let unhandled_request_state = KinoviHappyHorse1p0RemainingItems { + start_frame: builder.start_frame.take(), + }; + + Ok(KinoviHappyHorse1p0DraftState { + prompt, + aspect_ratio, + resolution, + duration_seconds, + batch_count, + unhandled_request_state: Some(unhandled_request_state), + }) +} + +// ── Plan helpers ── + +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match aspect_ratio { + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(None), + + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Ok(Some(KinoviHappyHorse1p0AspectRatio::Landscape16x9)) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Ok(Some(KinoviHappyHorse1p0AspectRatio::Portrait9x16)) + } + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Ok(Some(KinoviHappyHorse1p0AspectRatio::Square1x1)) + } + Some(RouterAspectRatio::WideFourByThree) => Ok(Some(KinoviHappyHorse1p0AspectRatio::Landscape4x3)), + Some(RouterAspectRatio::TallThreeByFour) => Ok(Some(KinoviHappyHorse1p0AspectRatio::Portrait3x4)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(nearest_aspect_ratio(unsupported))) + } + }, + } +} + +fn nearest_aspect_ratio(aspect_ratio: RouterAspectRatio) -> KinoviHappyHorse1p0AspectRatio { + match aspect_ratio { + RouterAspectRatio::WideFiveByFour => KinoviHappyHorse1p0AspectRatio::Landscape4x3, + RouterAspectRatio::WideThreeByTwo => KinoviHappyHorse1p0AspectRatio::Landscape4x3, + RouterAspectRatio::WideTwentyOneByNine => KinoviHappyHorse1p0AspectRatio::Landscape16x9, + RouterAspectRatio::TallFourByFive => KinoviHappyHorse1p0AspectRatio::Portrait3x4, + RouterAspectRatio::TallTwoByThree => KinoviHappyHorse1p0AspectRatio::Portrait3x4, + RouterAspectRatio::TallNineByTwentyOne => KinoviHappyHorse1p0AspectRatio::Portrait9x16, + _ => KinoviHappyHorse1p0AspectRatio::Square1x1, + } +} + +// Happy Horse supports 720p and 1080p only (no 480p). +fn plan_output_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + Some(RouterResolution::SevenTwentyP) => Ok(Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(KinoviHappyHorse1p0OutputResolution::TenEightyP)), + + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(KinoviHappyHorse1p0OutputResolution::TenEightyP)) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP)) + } + }, + } +} + +fn plan_batch_count( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + let count = video_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(None), + 2 => Ok(Some(KinoviHappyHorse1p0BatchCount::Two)), + 4 => Ok(Some(KinoviHappyHorse1p0BatchCount::Four)), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{}", count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(if count >= 4 { KinoviHappyHorse1p0BatchCount::Four } else { KinoviHappyHorse1p0BatchCount::Two })) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(if count <= 2 { KinoviHappyHorse1p0BatchCount::Two } else { KinoviHappyHorse1p0BatchCount::Four })) + } + }, + } +} + +// Happy Horse supports 4–15 seconds, defaults to 5. +fn plan_duration( + duration_seconds: Option, + _strategy: RequestMismatchMitigationStrategy, +) -> Result { + let seconds = duration_seconds.unwrap_or(5); + Ok(seconds.clamp(4, 15) as u8) +} + +#[cfg(test)] +mod tests { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::errors::artcraft_router_error::ArtcraftRouterError; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + use super::*; + + // ── Materialized field conversions ── + + mod materialized_field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(happy_horse_builder())); + assert_eq!(draft.prompt, "a cat dancing"); + } + + #[test] + fn prompt_defaults_to_empty() { + let builder = GenerateVideoRequestBuilder { prompt: None, ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert_eq!(draft.prompt, ""); + } + + #[test] + fn duration_seconds_converted() { + let builder = GenerateVideoRequestBuilder { duration_seconds: Some(10), ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert_eq!(draft.duration_seconds, 10); + } + + #[test] + fn duration_defaults_to_5() { + let builder = GenerateVideoRequestBuilder { duration_seconds: None, ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert_eq!(draft.duration_seconds, 5); + } + + #[test] + fn duration_clamped_to_max() { + let builder = GenerateVideoRequestBuilder { duration_seconds: Some(99), ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert_eq!(draft.duration_seconds, 15); + } + + #[test] + fn batch_count_none_for_one() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(1), ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(draft.batch_count.is_none()); + } + + #[test] + fn batch_count_two() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(2), ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.batch_count, Some(KinoviHappyHorse1p0BatchCount::Two))); + } + + #[test] + fn batch_count_four() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(4), ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.batch_count, Some(KinoviHappyHorse1p0BatchCount::Four))); + } + } + + // ── Aspect ratio conversions ── + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn aspect_ratio_wide() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.aspect_ratio, Some(KinoviHappyHorse1p0AspectRatio::Landscape16x9))); + } + + #[test] + fn aspect_ratio_tall() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.aspect_ratio, Some(KinoviHappyHorse1p0AspectRatio::Portrait9x16))); + } + + #[test] + fn aspect_ratio_square() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.aspect_ratio, Some(KinoviHappyHorse1p0AspectRatio::Square1x1))); + } + + #[test] + fn aspect_ratio_none_defaults_to_none() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: None, ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(draft.aspect_ratio.is_none()); + } + + #[test] + fn aspect_ratio_auto_defaults_to_none() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Auto), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(draft.aspect_ratio.is_none()); + } + + #[test] + fn unsupported_aspect_ratio_falls_back() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideFiveByFour), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.aspect_ratio, Some(KinoviHappyHorse1p0AspectRatio::Landscape4x3))); + } + + #[test] + fn unsupported_aspect_ratio_errors_out() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideFiveByFour), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..happy_horse_builder() + }; + assert!(build_kinovi_happy_horse_1p0(builder).is_err()); + } + } + + // ── Resolution conversions ── + + mod resolution_conversions { + use super::*; + + #[test] + fn resolution_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::SevenTwentyP), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP))); + } + + #[test] + fn resolution_none() { + let builder = GenerateVideoRequestBuilder { resolution: None, ..happy_horse_builder() }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(draft.resolution.is_none()); + } + + #[test] + fn unsupported_resolution_error_out() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..happy_horse_builder() + }; + assert!(build_kinovi_happy_horse_1p0(builder).is_err()); + } + + #[test] + fn unsupported_resolution_upgrades() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourK), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP))); + } + + #[test] + fn unsupported_resolution_downgrades() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourK), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayLessDowngrade, + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP))); + } + } + + // ── unhandled_request_state ── + + mod unhandled_request_state { + use super::*; + + #[test] + fn unhandled_state_is_present() { + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(happy_horse_builder())); + assert!(draft.unhandled_request_state.is_some()); + } + + #[test] + fn start_frame_url_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::Url(url)) if url == "https://example.com/start.jpg")); + } + + #[test] + fn start_frame_media_token_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test123".to_string()))), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::MediaFileToken(t)) if t.as_str() == "mf_test123")); + } + + #[test] + fn empty_refs_are_none_in_unhandled() { + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(happy_horse_builder())); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_none()); + } + } + + // ── Full combination ── + + #[test] + fn full_request_all_fields() { + let builder = GenerateVideoRequestBuilder { + prompt: Some("full test".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + resolution: Some(RouterResolution::TenEightyP), + duration_seconds: Some(10), + video_batch_count: Some(4), + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + ..happy_horse_builder() + }; + let draft = unwrap_draft(build_kinovi_happy_horse_1p0(builder)); + + assert_eq!(draft.prompt, "full test"); + assert!(matches!(draft.aspect_ratio, Some(KinoviHappyHorse1p0AspectRatio::Portrait9x16))); + assert!(matches!(draft.resolution, Some(KinoviHappyHorse1p0OutputResolution::TenEightyP))); + assert_eq!(draft.duration_seconds, 10); + assert!(matches!(draft.batch_count, Some(KinoviHappyHorse1p0BatchCount::Four))); + + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_some()); + } + + // ── Helpers ── + + fn happy_horse_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Seedance2Pro, + prompt: Some("a cat dancing".to_string()), + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn unwrap_draft(result: Result) -> KinoviHappyHorse1p0DraftState { + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviHappyHorse1p0(draft) + ) => draft, + _ => panic!("expected KinoviHappyHorse1p0 draft"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/cost.rs b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/cost.rs new file mode 100644 index 00000000..649ede01 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/cost.rs @@ -0,0 +1,344 @@ +use seedance2pro_client::generate::video::generate_happy_horse_1p0::{ + GenerateHappyHorse1p0Request, KinoviHappyHorse1p0BatchCount, + KinoviHappyHorse1p0OutputResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::draft::KinoviHappyHorse1p0DraftState; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::request::KinoviHappyHorse1p0RequestState; + +pub struct KinoviHappyHorse1p0CostState { + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, +} + +impl KinoviHappyHorse1p0CostState { + pub fn from_request(request: &KinoviHappyHorse1p0RequestState) -> Self { + Self { + resolution: request.request.output_resolution, + duration_seconds: request.request.duration_seconds, + batch_count: request.request.batch_count, + } + } + + pub fn from_draft(draft: &KinoviHappyHorse1p0DraftState) -> Self { + Self { + resolution: draft.resolution, + duration_seconds: draft.duration_seconds, + batch_count: draft.batch_count, + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let pricing_request = GenerateHappyHorse1p0Request { + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: self.batch_count, + + // No impact on price + prompt: String::new(), + aspect_ratio: None, + start_frame_url: None, + }; + + let costs = pricing_request.calculate_costs(); + let cost_in_credits = costs.kinovi_credits; + let cost_in_usd_cents = costs.usd_cents_rounded_up; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_provider::RouterProvider; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + // ── 720p pricing (33 credits/sec) ── + + mod pricing_720p { + use super::*; + + #[test] + fn credits_720p_every_duration() { + assert_eq!(credits(None, 3), 99); + assert_eq!(credits(None, 4), 132); + assert_eq!(credits(None, 5), 165); + assert_eq!(credits(None, 6), 198); + assert_eq!(credits(None, 7), 231); + assert_eq!(credits(None, 8), 264); + assert_eq!(credits(None, 9), 297); + assert_eq!(credits(None, 10), 330); + assert_eq!(credits(None, 11), 363); + assert_eq!(credits(None, 12), 396); + assert_eq!(credits(None, 13), 429); + assert_eq!(credits(None, 14), 462); + assert_eq!(credits(None, 15), 495); + } + + #[test] + fn explicit_720p_same_as_default() { + let default = credits(None, 5); + let explicit = credits(Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP), 5); + assert_eq!(default, explicit); + } + + #[test] + fn usd_cents_720p() { + assert_eq!(usd_cents(None, 5, None), 68); // 16500/243 = 67.90 -> rounds UP + assert_eq!(usd_cents(None, 15, None), 204); // 49500/243 = 203.70 -> rounds UP + } + } + + // ── 1080p pricing (66 credits/sec) ── + + mod pricing_1080p { + use super::*; + + #[test] + fn credits_1080p_every_duration() { + let r = Some(KinoviHappyHorse1p0OutputResolution::TenEightyP); + assert_eq!(credits(r, 3), 198); + assert_eq!(credits(r, 4), 264); + assert_eq!(credits(r, 5), 330); + assert_eq!(credits(r, 6), 396); + assert_eq!(credits(r, 7), 462); + assert_eq!(credits(r, 8), 528); + assert_eq!(credits(r, 9), 594); + assert_eq!(credits(r, 10), 660); + assert_eq!(credits(r, 11), 726); + assert_eq!(credits(r, 12), 792); + assert_eq!(credits(r, 13), 858); + assert_eq!(credits(r, 14), 924); + assert_eq!(credits(r, 15), 990); + } + + #[test] + fn usd_cents_1080p() { + let r = Some(KinoviHappyHorse1p0OutputResolution::TenEightyP); + // 330 credits; 33000/243 = 135.80 → rounds UP to 136¢ + assert_eq!(usd_cents(r, 5, None), 136); + // 990 credits; 99000/243 = 407.41 → rounds UP to 408¢ + assert_eq!(usd_cents(r, 15, None), 408); + } + } + + // ── Batch multiplier ── + + mod batch_tests { + use super::*; + + #[test] + fn batch_2_doubles_credits() { + let base = credits(None, 5); + let batch2 = credits_with_batch(None, 5, Some(KinoviHappyHorse1p0BatchCount::Two)); + assert_eq!(batch2, base * 2); + } + + #[test] + fn batch_4_quadruples_credits() { + let base = credits(None, 5); + let batch4 = credits_with_batch(None, 5, Some(KinoviHappyHorse1p0BatchCount::Four)); + assert_eq!(batch4, base * 4); + } + + #[test] + fn batch_applies_to_1080p() { + let r = Some(KinoviHappyHorse1p0OutputResolution::TenEightyP); + let base = credits(r, 5); + let batch4 = credits_with_batch(r, 5, Some(KinoviHappyHorse1p0BatchCount::Four)); + assert_eq!(batch4, base * 4); + } + } + + // ── Relative pricing ── + + mod relative_pricing { + use super::*; + + #[test] + fn r1080p_is_double_720p() { + for dur in 3..=15u8 { + let c720 = credits(None, dur); + let c1080 = credits(Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), dur); + assert_eq!(c1080, c720 * 2, "1080p should be 2× 720p at {}s", dur); + } + } + + #[test] + fn cost_scales_with_duration() { + let c3 = credits(None, 3); + let c10 = credits(None, 10); + let c15 = credits(None, 15); + assert!(c3 < c10); + assert!(c10 < c15); + } + + #[test] + fn not_free() { + let est = KinoviHappyHorse1p0CostState { + resolution: None, duration_seconds: 5, batch_count: None, + }.estimate_cost(); + assert!(!est.is_free); + } + } + + // ── from_draft() ── + + mod from_draft_tests { + use super::*; + + #[test] + fn from_draft_720p_default() { + let draft = make_draft(5, 1, None); + let cost = KinoviHappyHorse1p0CostState::from_draft(&draft); + assert_eq!(cost.duration_seconds, 5); + assert_eq!(cost.estimate_cost().cost_in_credits, Some(165)); + } + + #[test] + fn from_draft_1080p_batch_4() { + let draft = make_draft(5, 4, Some(RouterResolution::TenEightyP)); + let cost = KinoviHappyHorse1p0CostState::from_draft(&draft); + assert_eq!(cost.estimate_cost().cost_in_credits, Some(330 * 4)); + } + } + + // ── from_request() ── + + mod from_request_tests { + use super::*; + + #[test] + fn from_request_default() { + let req = make_request_state(None, 5, None); + let cost = KinoviHappyHorse1p0CostState::from_request(&req); + assert_eq!(cost.estimate_cost().cost_in_credits, Some(165)); + } + + #[test] + fn from_request_1080p() { + let req = make_request_state( + Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), 5, None, + ); + let cost = KinoviHappyHorse1p0CostState::from_request(&req); + assert_eq!(cost.estimate_cost().cost_in_credits, Some(330)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(136)); + } + } + + // ── Cross-check: draft matches request ── + + mod cross_check { + use super::*; + + #[test] + fn draft_and_request_produce_same_cost() { + let draft = make_draft(5, 1, Some(RouterResolution::SevenTwentyP)); + let req = make_request_state( + Some(KinoviHappyHorse1p0OutputResolution::SevenTwentyP), 5, None, + ); + let draft_cost = KinoviHappyHorse1p0CostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviHappyHorse1p0CostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + + #[test] + fn draft_and_request_produce_same_cost_1080p_batch_2() { + let draft = make_draft(10, 2, Some(RouterResolution::TenEightyP)); + let req = make_request_state( + Some(KinoviHappyHorse1p0OutputResolution::TenEightyP), 10, + Some(KinoviHappyHorse1p0BatchCount::Two), + ); + let draft_cost = KinoviHappyHorse1p0CostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviHappyHorse1p0CostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + } + + // ── Helpers ── + + fn credits( + resolution: Option, + duration_seconds: u8, + ) -> u64 { + credits_with_batch(resolution, duration_seconds, None) + } + + fn credits_with_batch( + resolution: Option, + duration_seconds: u8, + batch_count: Option, + ) -> u64 { + KinoviHappyHorse1p0CostState { resolution, duration_seconds, batch_count } + .estimate_cost() + .cost_in_credits + .unwrap() + } + + fn usd_cents( + resolution: Option, + duration_seconds: u8, + batch_count: Option, + ) -> u64 { + KinoviHappyHorse1p0CostState { resolution, duration_seconds, batch_count } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + fn make_draft( + duration_seconds: u16, + video_batch_count: u16, + resolution: Option, + ) -> KinoviHappyHorse1p0DraftState { + use crate::api::router_video_model::RouterVideoModel; + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::HappyHorse1p0, + provider: RouterProvider::Seedance2Pro, + resolution, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + + match builder.build2().expect("build2 should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviHappyHorse1p0(draft) + ) => draft, + _ => panic!("expected KinoviHappyHorse1p0 draft"), + } + } + + fn make_request_state( + resolution: Option, + duration_seconds: u8, + batch_count: Option, + ) -> KinoviHappyHorse1p0RequestState { + KinoviHappyHorse1p0RequestState { + request: GenerateHappyHorse1p0Request { + prompt: "test".to_string(), + aspect_ratio: None, + output_resolution: resolution, + batch_count, + duration_seconds, + start_frame_url: None, + }, + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/draft.rs b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/draft.rs new file mode 100644 index 00000000..db057d68 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/draft.rs @@ -0,0 +1,54 @@ +use seedance2pro_client::generate::video::generate_happy_horse_1p0::{ + GenerateHappyHorse1p0Request, KinoviHappyHorse1p0AspectRatio, + KinoviHappyHorse1p0BatchCount, KinoviHappyHorse1p0OutputResolution, +}; + +use crate::api::image_ref::ImageRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::providers::kinovi::resolve::resolve_and_upload_single; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::request::KinoviHappyHorse1p0RequestState; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; + +#[derive(Debug, Clone)] +pub struct KinoviHappyHorse1p0DraftState { + pub prompt: String, + pub aspect_ratio: Option, + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviHappyHorse1p0RemainingItems { + pub start_frame: Option, +} + +impl KinoviHappyHorse1p0DraftState { + pub async fn to_request( + &mut self, + draft_context: &VideoGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut start_frame_url = None; + + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + start_frame_url = resolve_and_upload_single(session, remaining.start_frame, map).await?; + } + + let request = GenerateHappyHorse1p0Request { + prompt: self.prompt.clone(), + aspect_ratio: self.aspect_ratio, + output_resolution: self.resolution, + batch_count: self.batch_count, + duration_seconds: self.duration_seconds, + start_frame_url, + }; + + Ok(KinoviHappyHorse1p0RequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/mod.rs b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/mod.rs new file mode 100644 index 00000000..89225a36 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod cost; +pub mod draft; +pub mod request; diff --git a/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/request.rs b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/request.rs new file mode 100644 index 00000000..286eda69 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/happy_horse_1p0/request.rs @@ -0,0 +1,256 @@ +use seedance2pro_client::generate::video::generate_happy_horse_1p0::{ + generate_happy_horse_1p0, GenerateHappyHorse1p0Args, GenerateHappyHorse1p0Request, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{GenerateVideoResponse, Seedance2proVideoResponsePayload}; + +#[derive(Debug, Clone)] +pub struct KinoviHappyHorse1p0RequestState { + pub request: GenerateHappyHorse1p0Request, +} + +impl KinoviHappyHorse1p0RequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateHappyHorse1p0Args { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_happy_horse_1p0(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateVideoResponse::Seedance2Pro(Seedance2proVideoResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} + +#[cfg(test)] +mod tests { + use std::collections::HashMap; + + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::client::router_client::RouterClient; + use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; + use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; + use test_data::web::image_urls::JUNO_AT_LAKE_IMAGE_URL; + + mod aspect_ratio_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn landscape() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A corgi running through a field of wildflowers at sunset.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..happy_horse_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn portrait() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A cat sitting on a windowsill watching rain.".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..happy_horse_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn square() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A hummingbird hovering near a flower.".to_string()), + aspect_ratio: Some(RouterAspectRatio::Square), + ..happy_horse_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + mod resolution_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn res_720p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A golden retriever catching a frisbee on the beach.".to_string()), + resolution: Some(RouterResolution::SevenTwentyP), + ..happy_horse_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn res_1080p() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A fox walking through a snowy forest.".to_string()), + resolution: Some(RouterResolution::TenEightyP), + ..happy_horse_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + mod modality_tests { + use super::*; + + #[tokio::test] + #[ignore] + async fn text_to_video() { + let response = run_pipeline(GenerateVideoRequestBuilder { + prompt: Some("A whale breaching in the open ocean at dawn, cinematic.".to_string()), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..happy_horse_builder() + }).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn keyframe_start_frame() { + let start_token = MediaFileToken::new("mf_start".to_string()); + + let mut media_map = HashMap::new(); + media_map.insert(start_token.clone(), JUNO_AT_LAKE_IMAGE_URL.to_string()); + + let response = run_pipeline_with_media_map(GenerateVideoRequestBuilder { + prompt: Some("The dog watches the sunset over the lake.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(start_token)), + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..happy_horse_builder() + }, media_map).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + + #[tokio::test] + #[ignore] + async fn keyframe_1080p_square() { + let start_token = MediaFileToken::new("mf_start".to_string()); + + let mut media_map = HashMap::new(); + media_map.insert(start_token.clone(), JUNO_AT_LAKE_IMAGE_URL.to_string()); + + let response = run_pipeline_with_media_map(GenerateVideoRequestBuilder { + prompt: Some("A dragon soaring over the mountains.".to_string()), + start_frame: Some(ImageRef::MediaFileToken(start_token)), + aspect_ratio: Some(RouterAspectRatio::Square), + resolution: Some(RouterResolution::TenEightyP), + duration_seconds: Some(15), + ..happy_horse_builder() + }, media_map).await; + assert!(matches!(response, GenerateVideoResponse::Seedance2Pro(_))); + assert_eq!(1, 2, "Inspect output above"); + } + } + + // ── Helpers ── + + fn happy_horse_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::HappyHorse1p0, + provider: RouterProvider::Seedance2Pro, + duration_seconds: Some(4), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn get_seedance2pro_client() -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/seedance2pro_cookies.txt") + .expect("Failed to read seedance2pro cookies"); + let session = Seedance2ProSession::from_cookies_string(cookies.trim().to_string()); + RouterClient::Seedance2Pro(RouterSeedance2ProClient::new(session)) + } + + async fn run_pipeline(builder: GenerateVideoRequestBuilder) -> GenerateVideoResponse { + let client = get_seedance2pro_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let draft = match draft_or_request { + VideoGenerationDraftOrRequest::Draft(d) => d, + _ => panic!("expected Draft variant"), + }; + + let draft_context = VideoGenerationDraftContext { + client: Some(&client), + ..Default::default() + }; + + let request = draft.finalize(draft_context).await.expect("finalize should succeed"); + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Seedance2Pro(p) => { + println!("task_id={}, order_id={}", p.task_id, p.order_id); + } + other => println!("response: {:?}", other), + } + + response + } + + async fn run_pipeline_with_media_map( + builder: GenerateVideoRequestBuilder, + media_map: HashMap, + ) -> GenerateVideoResponse { + let client = get_seedance2pro_client(); + + let draft_or_request = builder.build2().expect("build2 should succeed"); + let draft = match draft_or_request { + VideoGenerationDraftOrRequest::Draft(d) => d, + _ => panic!("expected Draft variant"), + }; + + let draft_context = VideoGenerationDraftContext { + client: Some(&client), + media_file_to_artcraft_url_map: Some(&media_map), + ..Default::default() + }; + + let request = draft.finalize(draft_context).await.expect("finalize should succeed"); + let response = request.send_request(&client).await.expect("send_request should succeed"); + + match &response { + GenerateVideoResponse::Seedance2Pro(p) => { + println!("task_id={}, order_id={}", p.task_id, p.order_id); + } + other => println!("response: {:?}", other), + } + + response + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/mod.rs b/crates/router/src/generate/generate_video/providers/kinovi/mod.rs new file mode 100644 index 00000000..6537d5a9 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/mod.rs @@ -0,0 +1,6 @@ +pub mod happy_horse_1p0; +pub mod seedance_2p0; +pub mod seedance_2p0_fast; +pub mod seedance_2p0_mini; +pub(crate) mod resolve; +pub(crate) mod upload; diff --git a/crates/router/src/generate/generate_video/providers/kinovi/resolve.rs b/crates/router/src/generate/generate_video/providers/kinovi/resolve.rs new file mode 100644 index 00000000..e2187dba --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/resolve.rs @@ -0,0 +1,74 @@ +use std::collections::HashMap; + +use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::character_list_ref::CharacterListRef; +use crate::api::image_ref::ImageRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::providers::kinovi::upload::upload_source_to_seedance2pro; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; +use crate::utils::media_source_ref::MediaSourceRef; + +/// Resolve a single ImageRef and upload to Seedance2Pro CDN. +pub(crate) async fn resolve_and_upload_single( + session: &Seedance2ProSession, + image_ref: Option, + maybe_map: Option<&HashMap>, +) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(image_ref) => Ok(Some(upload_source_to_seedance2pro(session, image_ref.into(), maybe_map).await?)), + } +} + +/// Resolve a list of sources and upload each to Seedance2Pro CDN. Order is +/// preserved. `None` / empty lists resolve to `None`. +pub(crate) async fn resolve_and_upload_list( + session: &Seedance2ProSession, + sources: Option>, + maybe_map: Option<&HashMap>, +) -> Result>, ArtcraftRouterError> { + let sources = match sources { + None => return Ok(None), + Some(sources) if sources.is_empty() => return Ok(None), + Some(sources) => sources, + }; + + let mut uploaded = Vec::with_capacity(sources.len()); + for source in sources { + uploaded.push(upload_source_to_seedance2pro(session, source, maybe_map).await?); + } + Ok(Some(uploaded)) +} + +/// Map character tokens to their Kinovi character IDs, preserving order. +pub(crate) fn resolve_character_tokens( + character_list_ref: Option<&CharacterListRef>, + draft_context: &VideoGenerationDraftContext<'_>, +) -> Result>, ArtcraftRouterError> { + let list = match character_list_ref { + None => return Ok(None), + Some(r) => r, + }; + + let tokens = match list { + CharacterListRef::CharacterTokens(tokens) if tokens.is_empty() => return Ok(None), + CharacterListRef::CharacterTokens(tokens) => tokens, + }; + + let map = draft_context.get_character_token_to_kinovi_map()?; + + let ids: Result, _> = tokens.iter() + .map(|token| { + map.get(token).cloned().ok_or_else(|| { + ArtcraftRouterError::Client(ClientError::CharacterTokenNotFoundInMap { + token: token.clone(), + }) + }) + }) + .collect(); + + ids.map(Some) +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/build.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/build.rs new file mode 100644 index 00000000..a4a0da1f --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/build.rs @@ -0,0 +1,634 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0::{ + KinoviSeedance2p0AspectRatio as KinoviAspectRatio, + KinoviSeedance2p0Bitrate as KinoviBitrate, + KinoviSeedance2p0BatchCount as KinoviBatchCount, + KinoviSeedance2p0OutputResolution as KinoviOutputResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_bitrate::RouterBitrate; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::draft::{KinoviSeedance2p0DraftState, KinoviSeedance2p0RemainingItems}; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +pub fn build_kinovi_seedance_2p0(builder: GenerateVideoRequestBuilder) -> Result { + let draft = do_build_kinovi_seedance_2p0(builder)?; + Ok(VideoGenerationDraftOrRequest::Draft(VideoGenerationDraftRequest::KinoviSeedance2p0(draft))) +} + +fn do_build_kinovi_seedance_2p0(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_output_resolution(builder.resolution.take(), strategy)?; + let batch_count = plan_batch_count(builder.video_batch_count.take(), strategy)?; + let duration_seconds = plan_duration(builder.duration_seconds.take(), strategy)?; + let bitrate = plan_bitrate(builder.bitrate.take()); + let prompt = builder.prompt.take().unwrap_or_default(); + + let unhandled_request_state = KinoviSeedance2p0RemainingItems { + start_frame: builder.start_frame.take(), + end_frame: builder.end_frame.take(), + reference_images: builder.reference_images.take(), + reference_videos: builder.reference_videos.take(), + reference_audio: builder.reference_audio.take(), + reference_character_tokens: builder.reference_character_tokens.take(), + }; + + Ok(KinoviSeedance2p0DraftState { + aspect_ratio, + resolution, + batch_count, + duration_seconds, + bitrate, + prompt, + unhandled_request_state: Some(unhandled_request_state), + }) +} + +// ── Plan helpers ── + +// Supported aspect ratios and their AR values (width / height): +// Portrait9x16 = 0.5625, Portrait3x4 = 0.75, Square1x1 = 1.0, Standard4x3 = 1.33, Landscape16x9 = 1.78 +// +// All supported ratios cost the same, so PayMoreUpgrade and PayLessDowngrade both +// select the nearest match rather than rounding in a specific direction. +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match aspect_ratio { + // No preference or auto — default to landscape + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(KinoviAspectRatio::Landscape16x9), + + // Direct mappings + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Ok(KinoviAspectRatio::Landscape16x9) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Ok(KinoviAspectRatio::Portrait9x16) + } + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Ok(KinoviAspectRatio::Square1x1) + } + Some(RouterAspectRatio::WideFourByThree) => Ok(KinoviAspectRatio::Standard4x3), + Some(RouterAspectRatio::TallThreeByFour) => Ok(KinoviAspectRatio::Portrait3x4), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(KinoviAspectRatio::UltraWide21x9), + + // Mismatches — apply strategy + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(nearest_aspect_ratio(unsupported)) + } + }, + } +} + +/// Pick the nearest supported aspect ratio by AR value (width / height). +fn nearest_aspect_ratio(aspect_ratio: RouterAspectRatio) -> KinoviAspectRatio { + match aspect_ratio { + RouterAspectRatio::WideFiveByFour => KinoviAspectRatio::Standard4x3, // 1.25, nearest 1.33 + RouterAspectRatio::WideThreeByTwo => KinoviAspectRatio::Standard4x3, // 1.50, nearest 1.33 + RouterAspectRatio::TallFourByFive => KinoviAspectRatio::Portrait3x4, // 0.80, nearest 0.75 + RouterAspectRatio::TallTwoByThree => KinoviAspectRatio::Portrait3x4, // 0.67, nearest 0.75 + RouterAspectRatio::TallNineByTwentyOne => KinoviAspectRatio::Portrait9x16, // 0.43, nearest 0.56 + _ => KinoviAspectRatio::Square1x1, + } +} + +// Seedance 2.0 Pro supports output resolutions: 480p, 720p, 1080p, 4K. +fn plan_output_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + // Direct mappings + Some(RouterResolution::FourEightyP) => Ok(Some(KinoviOutputResolution::FourEightyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(KinoviOutputResolution::SevenTwentyP)), + Some(RouterResolution::TenEightyP) => Ok(Some(KinoviOutputResolution::TenEightyP)), + Some(RouterResolution::FourK) => Ok(Some(KinoviOutputResolution::FourK)), + + // Mismatches + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(match unsupported { + RouterResolution::HalfK => KinoviOutputResolution::FourEightyP, + _ => KinoviOutputResolution::TenEightyP, + })) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(match unsupported { + RouterResolution::HalfK => KinoviOutputResolution::FourEightyP, + _ => KinoviOutputResolution::TenEightyP, + })) + } + }, + } +} + +// Seedance2p0 supports batch counts of 1, 2, and 4 only. +fn plan_batch_count( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = video_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviBatchCount::One), + 2 => Ok(KinoviBatchCount::Two), + 4 => Ok(KinoviBatchCount::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{}", count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(if count < 4 { KinoviBatchCount::Four } else { KinoviBatchCount::Four }) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(if count < 4 { KinoviBatchCount::Two } else { KinoviBatchCount::Four }) + } + }, + } +} + +// Seedance2p0 supports duration of 4–15 seconds. +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + const MIN: u16 = 4; + const MAX: u16 = 15; + const DEFAULT: u8 = 5; + match duration_seconds { + None => Ok(DEFAULT), + Some(d) if d >= MIN && d <= MAX => Ok(d as u8), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(d.clamp(MIN, MAX) as u8), + }, + } +} + +// Seedance 2.0 Pro bitrate: "standard" (default, field omitted) or "high". +// Bitrate does not affect cost. `Normal` and an unset value both map to the +// standard bitrate (None); only `High` requests the higher bitrate. +fn plan_bitrate(bitrate: Option) -> Option { + match bitrate { + Some(RouterBitrate::High) => Some(KinoviBitrate::High), + Some(RouterBitrate::Normal) | None => None, + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::generate::video::generate_seedance_2p0::{ + KinoviSeedance2p0AspectRatio as KinoviAspectRatio, + KinoviSeedance2p0BatchCount as KinoviBatchCount, + KinoviSeedance2p0OutputResolution as KinoviOutputResolution, + }; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + use super::*; + + // ── Materialized field conversions ── + + mod materialized_field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let draft = unwrap_draft(build_kinovi_seedance_2p0(seedance2pro_builder())); + assert_eq!(draft.prompt, "a cat dancing"); + } + + #[test] + fn prompt_defaults_to_empty() { + let builder = GenerateVideoRequestBuilder { prompt: None, ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert_eq!(draft.prompt, ""); + } + + #[test] + fn duration_seconds_converted() { + let builder = GenerateVideoRequestBuilder { duration_seconds: Some(10), ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert_eq!(draft.duration_seconds, 10); + } + + #[test] + fn duration_defaults_to_5() { + let builder = GenerateVideoRequestBuilder { duration_seconds: None, ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert_eq!(draft.duration_seconds, 5); + } + + #[test] + fn duration_clamped_to_max() { + let builder = GenerateVideoRequestBuilder { + duration_seconds: Some(99), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert_eq!(draft.duration_seconds, 15); + } + + #[test] + fn batch_count_one() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(1), ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::One)); + } + + #[test] + fn batch_count_two() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(2), ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::Two)); + } + + #[test] + fn batch_count_four() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(4), ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::Four)); + } + } + + // ── Aspect ratio conversions ── + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn aspect_ratio_wide() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Landscape16x9)); + } + + #[test] + fn aspect_ratio_tall() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Portrait9x16)); + } + + #[test] + fn aspect_ratio_square() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Square1x1)); + } + + #[test] + fn aspect_ratio_defaults_to_landscape() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: None, ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Landscape16x9)); + } + } + + // ── Resolution conversions ── + + mod resolution_conversions { + use super::*; + + #[test] + fn resolution_480p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourEightyP), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::FourEightyP))); + } + + #[test] + fn resolution_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::SevenTwentyP), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::TenEightyP))); + } + + #[test] + fn resolution_4k() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourK), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::FourK))); + } + + #[test] + fn resolution_none() { + let builder = GenerateVideoRequestBuilder { resolution: None, ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(draft.resolution.is_none()); + } + + #[test] + fn unsupported_resolution_error_out() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::ThreeK), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..seedance2pro_builder() + }; + assert!(build_kinovi_seedance_2p0(builder).is_err()); + } + + #[test] + fn unsupported_resolution_rounds_up() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::ThreeK), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::TenEightyP))); + } + } + + // ── Bitrate conversions ── + + mod bitrate_conversions { + use super::*; + + #[test] + fn bitrate_high() { + let builder = GenerateVideoRequestBuilder { + bitrate: Some(RouterBitrate::High), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(matches!(draft.bitrate, Some(KinoviBitrate::High))); + } + + #[test] + fn bitrate_normal_maps_to_standard() { + let builder = GenerateVideoRequestBuilder { + bitrate: Some(RouterBitrate::Normal), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(draft.bitrate.is_none()); + } + + #[test] + fn bitrate_none_maps_to_standard() { + let builder = GenerateVideoRequestBuilder { bitrate: None, ..seedance2pro_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + assert!(draft.bitrate.is_none()); + } + } + + // ── unhandled_request_state: media refs are placed there ── + + mod unhandled_request_state { + use super::*; + + #[test] + fn unhandled_state_is_present() { + let draft = unwrap_draft(build_kinovi_seedance_2p0(seedance2pro_builder())); + assert!(draft.unhandled_request_state.is_some()); + } + + #[test] + fn start_frame_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::Url(url)) if url == "https://example.com/start.jpg")); + } + + #[test] + fn end_frame_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + end_frame: Some(ImageRef::Url("https://example.com/end.jpg".to_string())), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.end_frame, Some(ImageRef::Url(url)) if url == "https://example.com/end.jpg")); + } + + #[test] + fn start_frame_media_token_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test123".to_string()))), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::MediaFileToken(t)) if t.as_str() == "mf_test123")); + } + + #[test] + fn reference_images_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + "https://example.com/ref1.jpg".to_string(), + "https://example.com/ref2.jpg".to_string(), + ])), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + match remaining.reference_images { + Some(ImageListRef::Urls(urls)) => { + assert_eq!(urls.len(), 2); + assert_eq!(urls[0], "https://example.com/ref1.jpg"); + assert_eq!(urls[1], "https://example.com/ref2.jpg"); + } + _ => panic!("expected Urls variant"), + } + } + + #[test] + fn reference_videos_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_videos: Some(VideoListRef::Urls(vec![ + "https://example.com/vid.mp4".to_string(), + ])), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.reference_videos, Some(VideoListRef::Urls(urls)) if urls.len() == 1)); + } + + #[test] + fn reference_audio_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_audio: Some(AudioListRef::Urls(vec![ + "https://example.com/audio.mp3".to_string(), + ])), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.reference_audio, Some(AudioListRef::Urls(urls)) if urls.len() == 1)); + } + + #[test] + fn character_tokens_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new("char_abc".to_string()), + CharacterToken::new("char_def".to_string()), + ])), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + match remaining.reference_character_tokens { + Some(CharacterListRef::CharacterTokens(tokens)) => { + assert_eq!(tokens.len(), 2); + assert_eq!(tokens[0].as_str(), "char_abc"); + assert_eq!(tokens[1].as_str(), "char_def"); + } + _ => panic!("expected CharacterTokens variant"), + } + } + + #[test] + fn empty_refs_are_none_in_unhandled() { + let draft = unwrap_draft(build_kinovi_seedance_2p0(seedance2pro_builder())); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_none()); + assert!(remaining.end_frame.is_none()); + assert!(remaining.reference_images.is_none()); + assert!(remaining.reference_videos.is_none()); + assert!(remaining.reference_audio.is_none()); + assert!(remaining.reference_character_tokens.is_none()); + } + } + + // ── Full combination ── + + #[test] + fn full_request_all_fields() { + let builder = GenerateVideoRequestBuilder { + prompt: Some("full test".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + resolution: Some(RouterResolution::TenEightyP), + duration_seconds: Some(10), + video_batch_count: Some(4), + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + end_frame: Some(ImageRef::Url("https://example.com/end.jpg".to_string())), + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/ref.jpg".to_string()])), + reference_videos: Some(VideoListRef::Urls(vec!["https://example.com/vid.mp4".to_string()])), + reference_audio: Some(AudioListRef::Urls(vec!["https://example.com/audio.mp3".to_string()])), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new("char_xyz".to_string()), + ])), + ..seedance2pro_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0(builder)); + + assert_eq!(draft.prompt, "full test"); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Portrait9x16)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::TenEightyP))); + assert_eq!(draft.duration_seconds, 10); + assert!(matches!(draft.batch_count, KinoviBatchCount::Four)); + + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_some()); + assert!(remaining.end_frame.is_some()); + assert!(remaining.reference_images.is_some()); + assert!(remaining.reference_videos.is_some()); + assert!(remaining.reference_audio.is_some()); + assert!(remaining.reference_character_tokens.is_some()); + } + + // ── Helpers ── + + fn seedance2pro_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + provider: RouterProvider::Seedance2Pro, + prompt: Some("a cat dancing".to_string()), + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn unwrap_draft(result: Result) -> KinoviSeedance2p0DraftState { + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviSeedance2p0(draft) + ) => draft, + _ => panic!("expected KinoviSeedance2p0 draft"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/cost.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/cost.rs new file mode 100644 index 00000000..6a53d716 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/cost.rs @@ -0,0 +1,629 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0::{ + GenerateSeedance2p0Request, KinoviSeedance2p0BatchCount, + KinoviSeedance2p0OutputResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::draft::KinoviSeedance2p0DraftState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::request::KinoviSeedance2p0RequestState; + +pub struct KinoviSeedance2p0CostState { + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + pub has_video_reference: bool, +} + +impl KinoviSeedance2p0CostState { + pub fn from_request(request: &KinoviSeedance2p0RequestState) -> Self { + Self { + resolution: request.request.output_resolution, + duration_seconds: request.request.duration_seconds, + batch_count: request.request.batch_count, + has_video_reference: request.request.reference_video_urls + .as_ref() + .is_some_and(|urls| !urls.is_empty()), + } + } + + pub fn from_draft(draft: &KinoviSeedance2p0DraftState) -> Self { + let has_video_reference = draft.unhandled_request_state + .as_ref() + .and_then(|rem| rem.reference_videos.as_ref()) + .is_some(); + + Self { + resolution: draft.resolution, + duration_seconds: draft.duration_seconds, + batch_count: Some(draft.batch_count), + has_video_reference, + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let pricing_request = GenerateSeedance2p0Request { + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: self.batch_count, + + // PRESENCE of reference videos changes the price (per-second + // surcharge); the URL contents don't. + reference_video_urls: if self.has_video_reference { + Some(vec!["pricing-placeholder".to_string()]) + } else { + None + }, + + // No impact on price + prompt: String::new(), + aspect_ratio: None, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }; + + let costs = pricing_request.calculate_costs(); + let cost_in_credits = costs.total_cost.kinovi_credits; + let cost_in_usd_cents = costs.total_cost.usd_cents_rounded_up; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use seedance2pro_client::generate::video::generate_seedance_2p0::{ + KinoviSeedance2p0OutputResolution as KinoviOutputResolution, + KinoviSeedance2p0BatchCount as KinoviBatchCount, + }; + + use crate::api::router_resolution::RouterResolution; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + // ── 720p pricing ── + + mod pricing_720p { + use super::*; + + #[test] + fn cost_720p_batch_1() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One), 66); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One), 83); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 6, KinoviBatchCount::One), 99); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 7, KinoviBatchCount::One), 116); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 10, KinoviBatchCount::One), 165); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One), 247); + } + + #[test] + fn cost_720p_batch_2() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::Two), 132); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Two), 165); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::Two), 494); + } + + #[test] + fn cost_720p_batch_4() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::Four), 264); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Four), 330); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::Four), 988); + } + } + + // ── 480p pricing ── + + mod pricing_480p { + use super::*; + + #[test] + fn cost_480p_batch_1() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 4, KinoviBatchCount::One), 25); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One), 31); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 10, KinoviBatchCount::One), 62); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 15, KinoviBatchCount::One), 93); + } + + #[test] + fn cost_480p_batch_2() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::Two), 62); + } + + #[test] + fn cost_480p_batch_4() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::Four), 124); + } + } + + // ── 1080p pricing ── + + mod pricing_1080p { + use super::*; + + #[test] + fn cost_1080p_batch_1() { + assert_eq!(usd_cents(KinoviOutputResolution::TenEightyP, 4, KinoviBatchCount::One), 149); + assert_eq!(usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::One), 186); + assert_eq!(usd_cents(KinoviOutputResolution::TenEightyP, 10, KinoviBatchCount::One), 371); + assert_eq!(usd_cents(KinoviOutputResolution::TenEightyP, 15, KinoviBatchCount::One), 556); + } + + #[test] + fn cost_1080p_batch_2() { + assert_eq!(usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::Two), 371); + } + + #[test] + fn cost_1080p_batch_4() { + assert_eq!(usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::Four), 741); + } + } + + // ── 4K pricing ── + // + // Routes to the seedance2pro_client: 4K base is 200 credits/s (vs 90 at 1080p). + // Credits → cents at 243 credits/$1, rounded up. + + mod pricing_4k { + use super::*; + + #[test] + fn cost_4k_batch_1() { + assert_eq!(usd_cents(KinoviOutputResolution::FourK, 4, KinoviBatchCount::One), 330); + assert_eq!(usd_cents(KinoviOutputResolution::FourK, 5, KinoviBatchCount::One), 412); + assert_eq!(usd_cents(KinoviOutputResolution::FourK, 10, KinoviBatchCount::One), 824); + assert_eq!(usd_cents(KinoviOutputResolution::FourK, 15, KinoviBatchCount::One), 1235); + } + + #[test] + fn cost_4k_batch_2() { + assert_eq!(usd_cents(KinoviOutputResolution::FourK, 5, KinoviBatchCount::Two), 824); + } + + #[test] + fn cost_4k_batch_4() { + assert_eq!(usd_cents(KinoviOutputResolution::FourK, 5, KinoviBatchCount::Four), 1647); + } + } + + // ── 4K: router cost must match the seedance2pro_client binding ── + // + // The router delegates to GenerateSeedance2p0Request::calculate_costs(), so these + // assert the exact 4K numbers AND cross-check the router against the binding for + // every duration (4/5/10/15s) with and without a video reference. + // + // 4K base = 200 credits/s; with a video reference = 240 credits/s (+40 surcharge). + // USD cents = ceil(total_credits / 243 * 100). + + mod four_k_matches_binding { + use super::*; + use seedance2pro_client::generate::video::generate_seedance_2p0::GenerateSeedance2p0Request; + + /// Router-side 4K cost (batch 1) for a duration / video-reference combo. + fn router(duration_seconds: u8, has_video_reference: bool) -> VideoGenerationCostEstimate { + KinoviSeedance2p0CostState { + resolution: Some(KinoviOutputResolution::FourK), + duration_seconds, + batch_count: Some(KinoviBatchCount::One), + has_video_reference, + } + .estimate_cost() + } + + /// The seedance2pro_client binding's own 4K cost for the same inputs. + /// Returns (kinovi_credits, usd_cents_rounded_up). + fn binding(duration_seconds: u8, has_video_reference: bool) -> (u64, u64) { + let reference_video_urls = if has_video_reference { + Some(vec!["pricing-placeholder".to_string()]) + } else { + None + }; + let costs = GenerateSeedance2p0Request { + output_resolution: Some(KinoviOutputResolution::FourK), + duration_seconds, + batch_count: Some(KinoviBatchCount::One), + reference_video_urls, + prompt: String::new(), + aspect_ratio: None, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + } + .calculate_costs(); + (costs.total_cost.kinovi_credits, costs.total_cost.usd_cents_rounded_up) + } + + #[test] + fn explicit_values_without_video_reference() { + // 200 credits/s. + assert_eq!((router(4, false).cost_in_credits, router(4, false).cost_in_usd_cents), (Some(800), Some(330))); + assert_eq!((router(5, false).cost_in_credits, router(5, false).cost_in_usd_cents), (Some(1000), Some(412))); + assert_eq!((router(10, false).cost_in_credits, router(10, false).cost_in_usd_cents), (Some(2000), Some(824))); + assert_eq!((router(15, false).cost_in_credits, router(15, false).cost_in_usd_cents), (Some(3000), Some(1235))); + } + + #[test] + fn explicit_values_with_video_reference() { + // 240 credits/s (200 base + 40 surcharge). + assert_eq!((router(4, true).cost_in_credits, router(4, true).cost_in_usd_cents), (Some(960), Some(396))); + assert_eq!((router(5, true).cost_in_credits, router(5, true).cost_in_usd_cents), (Some(1200), Some(494))); + assert_eq!((router(10, true).cost_in_credits, router(10, true).cost_in_usd_cents), (Some(2400), Some(988))); + assert_eq!((router(15, true).cost_in_credits, router(15, true).cost_in_usd_cents), (Some(3600), Some(1482))); + } + + #[test] + fn router_matches_binding_for_every_duration_and_video_ref() { + for &duration in &[4u8, 5, 10, 15] { + for &has_ref in &[false, true] { + let r = router(duration, has_ref); + let (b_credits, b_cents) = binding(duration, has_ref); + assert_eq!( + r.cost_in_credits, Some(b_credits), + "credits differ at {duration}s has_video_reference={has_ref}", + ); + assert_eq!( + r.cost_in_usd_cents, Some(b_cents), + "usd cents differ at {duration}s has_video_reference={has_ref}", + ); + } + } + } + } + + // ── Relative pricing ── + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p_cheaper_than_1080p() { + let c480 = usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One); + let c720 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One); + let c1080 = usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::One); + assert!(c480 < c720, "480p ({}) should be cheaper than 720p ({})", c480, c720); + assert!(c720 < c1080, "720p ({}) should be cheaper than 1080p ({})", c720, c1080); + } + + #[test] + fn cost_1080p_cheaper_than_4k() { + let c1080 = usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::One); + let c4k = usd_cents(KinoviOutputResolution::FourK, 5, KinoviBatchCount::One); + assert!(c1080 < c4k, "1080p ({}) should be cheaper than 4K ({})", c1080, c4k); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One); + let c10 = usd_cents(KinoviOutputResolution::SevenTwentyP, 10, KinoviBatchCount::One); + let c15 = usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::One); + let b2 = usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::Two); + let b4 = usd_cents(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::Four); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // -- Video reference does NOT affect cost (yet) -- + + #[test] + fn video_reference_adds_surcharge() { + let base = KinoviSeedance2p0CostState { + resolution: Some(KinoviOutputResolution::SevenTwentyP), + duration_seconds: 5, + batch_count: Some(KinoviBatchCount::One), + has_video_reference: false, + }; + let without = base.estimate_cost(); + let with = KinoviSeedance2p0CostState { has_video_reference: true, ..base }.estimate_cost(); + // 720p surcharge is +8 credits/s: 200 -> 240 credits (24000/243 = 98.77 -> 99 cents). + assert_eq!(without.cost_in_credits, Some(200)); + assert_eq!(with.cost_in_credits, Some(240)); + assert_eq!(with.cost_in_usd_cents, Some(99)); + } + + // ── from_request() tests ── + + mod from_request_tests { + use super::*; + + #[test] + fn from_request_720p() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0CostState::from_request(&req); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + assert_eq!(cost.duration_seconds, 5); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::One))); + assert!(!cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(83)); + } + + #[test] + fn from_request_none_defaults_to_720p() { + let req = make_request_state(None, 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0CostState::from_request(&req); + assert!(cost.resolution.is_none()); // None defaults to 720p pricing + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(83)); + } + + #[test] + fn from_request_480p() { + let req = make_request_state(Some(KinoviOutputResolution::FourEightyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0CostState::from_request(&req); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(31)); + } + + #[test] + fn from_request_1080p_batch_2() { + let req = make_request_state(Some(KinoviOutputResolution::TenEightyP), 5, KinoviBatchCount::Two, false); + let cost = KinoviSeedance2p0CostState::from_request(&req); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(371)); + } + + #[test] + fn from_request_with_video_reference() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, true); + let cost = KinoviSeedance2p0CostState::from_request(&req); + assert!(cost.has_video_reference); + // Video refs add a +8 credits/s surcharge at 720p: 240 credits -> 125 cents. + assert_eq!(cost.estimate_cost().cost_in_credits, Some(240)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(99)); + } + + #[test] + fn from_request_without_video_reference() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0CostState::from_request(&req); + assert!(!cost.has_video_reference); + } + } + + // ── from_draft() tests ── + + mod from_draft_tests { + use super::*; + + #[test] + fn from_draft_720p_default() { + let draft = make_draft(5, 1, None, false); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert!(cost.resolution.is_none()); // None defaults to 720p pricing + assert_eq!(cost.duration_seconds, 5); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::One))); + assert!(!cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(83)); + } + + #[test] + fn from_draft_480p() { + let draft = make_draft(5, 1, Some(RouterResolution::FourEightyP), false); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::FourEightyP))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(31)); + } + + #[test] + fn from_draft_4k() { + let draft = make_draft(5, 1, Some(RouterResolution::FourK), false); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::FourK))); + assert_eq!(cost.estimate_cost().cost_in_credits, Some(1000)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(412)); + } + + #[test] + fn from_draft_4k_with_video_reference() { + let draft = make_draft(5, 1, Some(RouterResolution::FourK), true); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + // 4K base 200 + video-ref surcharge 40 = 240 credits/s -> 1200 credits for 5s. + assert_eq!(cost.estimate_cost().cost_in_credits, Some(1200)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(494)); + } + + #[test] + fn from_draft_1080p_batch_4() { + let draft = make_draft(5, 4, Some(RouterResolution::TenEightyP), false); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::TenEightyP))); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::Four))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(741)); + } + + #[test] + fn from_draft_with_video_reference() { + let draft = make_draft(5, 1, None, true); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert!(cost.has_video_reference); + // Video refs add a +8 credits/s surcharge at 720p: 240 credits -> 125 cents. + assert_eq!(cost.estimate_cost().cost_in_credits, Some(240)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(99)); + } + + #[test] + fn from_draft_without_video_reference() { + let draft = make_draft(5, 1, None, false); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert!(!cost.has_video_reference); + } + + #[test] + fn from_draft_duration_15_batch_2() { + let draft = make_draft(15, 2, Some(RouterResolution::SevenTwentyP), false); + let cost = KinoviSeedance2p0CostState::from_draft(&draft); + assert_eq!(cost.duration_seconds, 15); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::Two))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(494)); + } + } + + // ── Cross-check: from_draft matches from_request ── + + mod cross_check_tests { + use super::*; + + #[test] + fn draft_and_request_produce_same_cost() { + // 720p, 5s, batch 1 + let draft = make_draft(5, 1, Some(RouterResolution::SevenTwentyP), false); + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let draft_cost = KinoviSeedance2p0CostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviSeedance2p0CostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + + #[test] + fn draft_and_request_produce_same_cost_1080p() { + let draft = make_draft(10, 2, Some(RouterResolution::TenEightyP), false); + let req = make_request_state(Some(KinoviOutputResolution::TenEightyP), 10, KinoviBatchCount::Two, false); + let draft_cost = KinoviSeedance2p0CostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviSeedance2p0CostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + } + + // ── Credits spot checks ── + + mod credits_tests { + use super::*; + + #[test] + fn credits_720p() { + assert_eq!(credits(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One), 200); + } + + #[test] + fn credits_480p() { + assert_eq!(credits(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One), 75); + } + + #[test] + fn credits_1080p() { + assert_eq!(credits(KinoviOutputResolution::TenEightyP, 5, KinoviBatchCount::One), 450); + } + + #[test] + fn credits_4k() { + assert_eq!(credits(KinoviOutputResolution::FourK, 5, KinoviBatchCount::One), 1000); + } + } + + // ── Helpers ── + + fn usd_cents( + resolution: KinoviOutputResolution, + duration_seconds: u8, + batch_count: KinoviBatchCount, + ) -> u64 { + KinoviSeedance2p0CostState { + resolution: Some(resolution), duration_seconds, batch_count: Some(batch_count), + has_video_reference: false, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + fn credits( + resolution: KinoviOutputResolution, + duration_seconds: u8, + batch_count: KinoviBatchCount, + ) -> u64 { + KinoviSeedance2p0CostState { + resolution: Some(resolution), duration_seconds, batch_count: Some(batch_count), + has_video_reference: false, + } + .estimate_cost() + .cost_in_credits + .unwrap() + } + + /// Build a draft via the builder to test from_draft(). + fn make_draft( + duration_seconds: u16, + video_batch_count: u16, + resolution: Option, + with_video_ref: bool, + ) -> KinoviSeedance2p0DraftState { + let reference_videos = if with_video_ref { + Some(VideoListRef::Urls(vec!["https://example.com/video.mp4".to_string()])) + } else { + None + }; + + let builder = GenerateVideoRequestBuilder { + provider: RouterProvider::Seedance2Pro, + resolution, + reference_videos, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + + match builder.build2().expect("build2 should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviSeedance2p0(draft) + ) => draft, + _ => panic!("expected KinoviSeedance2p0 draft"), + } + } + + /// Build a request state for from_request() tests. + fn make_request_state( + resolution: Option, + duration_seconds: u8, + batch_count: KinoviBatchCount, + with_video_ref: bool, + ) -> KinoviSeedance2p0RequestState { + let reference_video_urls = if with_video_ref { + Some(vec!["https://cdn.seedance2-pro.com/video.mp4".to_string()]) + } else { + None + }; + + KinoviSeedance2p0RequestState { + request: GenerateSeedance2p0Request { + prompt: "test".to_string(), + aspect_ratio: None, + output_resolution: resolution, + duration_seconds, + batch_count: Some(batch_count), + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/draft.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/draft.rs new file mode 100644 index 00000000..b6505cb2 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/draft.rs @@ -0,0 +1,101 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0::{ + GenerateSeedance2p0Request, KinoviSeedance2p0AspectRatio, KinoviSeedance2p0Bitrate, + KinoviSeedance2p0BatchCount, KinoviSeedance2p0OutputResolution, +}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::character_list_ref::CharacterListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::providers::kinovi::resolve::{ + resolve_and_upload_list, resolve_and_upload_single, resolve_character_tokens, +}; +use crate::utils::media_source_ref::MediaSourceRef; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::request::KinoviSeedance2p0RequestState; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0DraftState { + // Materialized / finalized types + + pub prompt: String, + pub aspect_ratio: KinoviSeedance2p0AspectRatio, + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: KinoviSeedance2p0BatchCount, + pub bitrate: Option, + + // Pending types that need to be queried. + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0RemainingItems { + pub start_frame: Option, + pub end_frame: Option, + pub reference_images: Option, + pub reference_videos: Option, + pub reference_audio: Option, + pub reference_character_tokens: Option, +} + +impl KinoviSeedance2p0DraftState { + pub async fn to_request( + &mut self, + draft_context: &VideoGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut start_frame_url = None; + let mut end_frame_url = None; + let mut reference_image_urls = None; + let mut reference_video_urls = None; + let mut reference_audio_urls = None; + let mut character_ids = None; + + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + + start_frame_url = resolve_and_upload_single(session, remaining.start_frame, map).await?; + end_frame_url = resolve_and_upload_single(session, remaining.end_frame, map).await?; + + reference_image_urls = resolve_and_upload_list( + session, remaining.reference_images.map(MediaSourceRef::list_from_images), map, + ).await?; + + reference_video_urls = resolve_and_upload_list( + session, remaining.reference_videos.map(MediaSourceRef::list_from_videos), map, + ).await?; + + reference_audio_urls = resolve_and_upload_list( + session, remaining.reference_audio.map(MediaSourceRef::list_from_audios), map, + ).await?; + + character_ids = resolve_character_tokens( + remaining.reference_character_tokens.as_ref(), + draft_context, + )?; + } + + let request = GenerateSeedance2p0Request { + prompt: self.prompt.clone(), + aspect_ratio: Some(self.aspect_ratio), + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: Some(self.batch_count), + start_frame_url, + end_frame_url, + reference_image_urls, + reference_video_urls, + reference_audio_urls, + character_ids, + use_face_blur_hack: None, + bitrate: self.bitrate, + }; + + Ok(KinoviSeedance2p0RequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/mod.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/mod.rs new file mode 100644 index 00000000..9ebe3f9c --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod draft; +pub mod request; +pub mod cost; \ No newline at end of file diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/request.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/request.rs new file mode 100644 index 00000000..3ccfe4f6 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0/request.rs @@ -0,0 +1,37 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0::{ + generate_seedance_2p0, GenerateSeedance2p0Args, GenerateSeedance2p0Request, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{GenerateVideoResponse, Seedance2proVideoResponsePayload}; + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0RequestState { + /// Final materialized request; ready to fire. + pub request: GenerateSeedance2p0Request, +} + +impl KinoviSeedance2p0RequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSeedance2p0Args { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_seedance_2p0(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateVideoResponse::Seedance2Pro(Seedance2proVideoResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/build.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/build.rs new file mode 100644 index 00000000..7f274071 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/build.rs @@ -0,0 +1,663 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_fast::{ + KinoviSeedance2p0FastAspectRatio as KinoviAspectRatio, + KinoviSeedance2p0FastBitrate as KinoviBitrate, + KinoviSeedance2p0FastBatchCount as KinoviBatchCount, + KinoviSeedance2p0FastOutputResolution as KinoviOutputResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_bitrate::RouterBitrate; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::draft::{KinoviSeedance2p0FastDraftState, KinoviSeedance2p0FastRemainingItems}; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +pub fn build_kinovi_seedance_2p0_fast(builder: GenerateVideoRequestBuilder) -> Result { + let draft = do_build_kinovi_seedance_2p0_fast(builder)?; + Ok(VideoGenerationDraftOrRequest::Draft(VideoGenerationDraftRequest::KinoviSeedance2p0Fast(draft))) +} + +fn do_build_kinovi_seedance_2p0_fast(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_output_resolution(builder.resolution.take(), strategy)?; + let batch_count = plan_batch_count(builder.video_batch_count.take(), strategy)?; + let duration_seconds = plan_duration(builder.duration_seconds.take(), strategy)?; + let bitrate = plan_bitrate(builder.bitrate.take()); + let prompt = builder.prompt.take().unwrap_or_default(); + + let unhandled_request_state = KinoviSeedance2p0FastRemainingItems { + start_frame: builder.start_frame.take(), + end_frame: builder.end_frame.take(), + reference_images: builder.reference_images.take(), + reference_videos: builder.reference_videos.take(), + reference_audio: builder.reference_audio.take(), + reference_character_tokens: builder.reference_character_tokens.take(), + }; + + Ok(KinoviSeedance2p0FastDraftState { + aspect_ratio, + resolution, + batch_count, + duration_seconds, + bitrate, + prompt, + unhandled_request_state: Some(unhandled_request_state), + }) +} + +// ── Plan helpers ── + +// Supported aspect ratios and their AR values (width / height): +// Portrait9x16 = 0.5625, Portrait3x4 = 0.75, Square1x1 = 1.0, Standard4x3 = 1.33, Landscape16x9 = 1.78 +// +// All supported ratios cost the same, so PayMoreUpgrade and PayLessDowngrade both +// select the nearest match rather than rounding in a specific direction. +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match aspect_ratio { + // No preference or auto — default to landscape + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(KinoviAspectRatio::Landscape16x9), + + // Direct mappings + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Ok(KinoviAspectRatio::Landscape16x9) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Ok(KinoviAspectRatio::Portrait9x16) + } + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Ok(KinoviAspectRatio::Square1x1) + } + Some(RouterAspectRatio::WideFourByThree) => Ok(KinoviAspectRatio::Standard4x3), + Some(RouterAspectRatio::TallThreeByFour) => Ok(KinoviAspectRatio::Portrait3x4), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(KinoviAspectRatio::UltraWide21x9), + + // Mismatches — apply strategy + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(nearest_aspect_ratio(unsupported)) + } + }, + } +} + +/// Pick the nearest supported aspect ratio by AR value (width / height). +fn nearest_aspect_ratio(aspect_ratio: RouterAspectRatio) -> KinoviAspectRatio { + match aspect_ratio { + RouterAspectRatio::WideFiveByFour => KinoviAspectRatio::Standard4x3, // 1.25, nearest 1.33 + RouterAspectRatio::WideThreeByTwo => KinoviAspectRatio::Standard4x3, // 1.50, nearest 1.33 + RouterAspectRatio::TallFourByFive => KinoviAspectRatio::Portrait3x4, // 0.80, nearest 0.75 + RouterAspectRatio::TallTwoByThree => KinoviAspectRatio::Portrait3x4, // 0.67, nearest 0.75 + RouterAspectRatio::TallNineByTwentyOne => KinoviAspectRatio::Portrait9x16, // 0.43, nearest 0.56 + _ => KinoviAspectRatio::Square1x1, + } +} + +// Seedance 2.0 Fast supports output resolutions: 480p and 720p only. +// 1080p is NOT supported — downgrade to 720p or error based on strategy. +fn plan_output_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + // Direct mappings + Some(RouterResolution::FourEightyP) => Ok(Some(KinoviOutputResolution::FourEightyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(KinoviOutputResolution::SevenTwentyP)), + + // 1080p is not supported for Fast — handle via strategy + Some(RouterResolution::TenEightyP) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", RouterResolution::TenEightyP), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + // 1080p not available — downgrade to 720p (highest supported) + Ok(Some(KinoviOutputResolution::SevenTwentyP)) + } + }, + + // Other unsupported resolutions + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(Some(match unsupported { + RouterResolution::HalfK => KinoviOutputResolution::FourEightyP, + _ => KinoviOutputResolution::SevenTwentyP, + })) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(match unsupported { + RouterResolution::HalfK => KinoviOutputResolution::FourEightyP, + _ => KinoviOutputResolution::SevenTwentyP, + })) + } + }, + } +} + +// Seedance2p0Fast supports batch counts of 1, 2, and 4 only. +fn plan_batch_count( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = video_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviBatchCount::One), + 2 => Ok(KinoviBatchCount::Two), + 4 => Ok(KinoviBatchCount::Four), + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{}", count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade => { + Ok(if count < 4 { KinoviBatchCount::Four } else { KinoviBatchCount::Four }) + } + RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(if count < 4 { KinoviBatchCount::Two } else { KinoviBatchCount::Four }) + } + }, + } +} + +// Seedance2p0Fast supports duration of 4–15 seconds. +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + const MIN: u16 = 4; + const MAX: u16 = 15; + const DEFAULT: u8 = 5; + match duration_seconds { + None => Ok(DEFAULT), + Some(d) if d >= MIN && d <= MAX => Ok(d as u8), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(d.clamp(MIN, MAX) as u8), + }, + } +} + +// Seedance 2.0 Fast bitrate: "standard" (default, field omitted) or "high". +// Bitrate does not affect cost. `Normal` and an unset value both map to the +// standard bitrate (None); only `High` requests the higher bitrate. +fn plan_bitrate(bitrate: Option) -> Option { + match bitrate { + Some(RouterBitrate::High) => Some(KinoviBitrate::High), + Some(RouterBitrate::Normal) | None => None, + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::generate::video::generate_seedance_2p0_fast::{ + KinoviSeedance2p0FastAspectRatio as KinoviAspectRatio, + KinoviSeedance2p0FastBatchCount as KinoviBatchCount, + KinoviSeedance2p0FastOutputResolution as KinoviOutputResolution, + }; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::draft::KinoviSeedance2p0FastDraftState; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + use super::*; + + // ── Materialized field conversions ── + + mod materialized_field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(seedance2pro_fast_builder())); + assert_eq!(draft.prompt, "a cat dancing"); + } + + #[test] + fn prompt_defaults_to_empty() { + let builder = GenerateVideoRequestBuilder { prompt: None, ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert_eq!(draft.prompt, ""); + } + + #[test] + fn duration_seconds_converted() { + let builder = GenerateVideoRequestBuilder { duration_seconds: Some(10), ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert_eq!(draft.duration_seconds, 10); + } + + #[test] + fn duration_defaults_to_5() { + let builder = GenerateVideoRequestBuilder { duration_seconds: None, ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert_eq!(draft.duration_seconds, 5); + } + + #[test] + fn duration_clamped_to_max() { + let builder = GenerateVideoRequestBuilder { + duration_seconds: Some(99), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert_eq!(draft.duration_seconds, 15); + } + + #[test] + fn batch_count_one() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(1), ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::One)); + } + + #[test] + fn batch_count_two() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(2), ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::Two)); + } + + #[test] + fn batch_count_four() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(4), ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::Four)); + } + } + + // ── Aspect ratio conversions ── + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn aspect_ratio_wide() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Landscape16x9)); + } + + #[test] + fn aspect_ratio_tall() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Portrait9x16)); + } + + #[test] + fn aspect_ratio_square() { + let builder = GenerateVideoRequestBuilder { + aspect_ratio: Some(RouterAspectRatio::Square), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Square1x1)); + } + + #[test] + fn aspect_ratio_defaults_to_landscape() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: None, ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Landscape16x9)); + } + } + + // ── Resolution conversions ── + + mod resolution_conversions { + use super::*; + + #[test] + fn resolution_480p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourEightyP), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::FourEightyP))); + } + + #[test] + fn resolution_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::SevenTwentyP), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p_downgrades_to_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayLessDowngrade, + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p_upgrade_also_downgrades_to_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p_error_out() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..seedance2pro_fast_builder() + }; + assert!(build_kinovi_seedance_2p0_fast(builder).is_err()); + } + + #[test] + fn resolution_none() { + let builder = GenerateVideoRequestBuilder { resolution: None, ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(draft.resolution.is_none()); + } + + #[test] + fn unsupported_resolution_error_out() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourK), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..seedance2pro_fast_builder() + }; + assert!(build_kinovi_seedance_2p0_fast(builder).is_err()); + } + + #[test] + fn unsupported_resolution_rounds_to_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::FourK), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayMoreUpgrade, + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + } + + // ── Bitrate conversions ── + + mod bitrate_conversions { + use super::*; + + #[test] + fn bitrate_high() { + let builder = GenerateVideoRequestBuilder { + bitrate: Some(RouterBitrate::High), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(matches!(draft.bitrate, Some(KinoviBitrate::High))); + } + + #[test] + fn bitrate_normal_maps_to_standard() { + let builder = GenerateVideoRequestBuilder { + bitrate: Some(RouterBitrate::Normal), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(draft.bitrate.is_none()); + } + + #[test] + fn bitrate_none_maps_to_standard() { + let builder = GenerateVideoRequestBuilder { bitrate: None, ..seedance2pro_fast_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + assert!(draft.bitrate.is_none()); + } + } + + // ── unhandled_request_state: media refs are placed there ── + + mod unhandled_request_state { + use super::*; + + #[test] + fn unhandled_state_is_present() { + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(seedance2pro_fast_builder())); + assert!(draft.unhandled_request_state.is_some()); + } + + #[test] + fn start_frame_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::Url(url)) if url == "https://example.com/start.jpg")); + } + + #[test] + fn end_frame_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + end_frame: Some(ImageRef::Url("https://example.com/end.jpg".to_string())), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.end_frame, Some(ImageRef::Url(url)) if url == "https://example.com/end.jpg")); + } + + #[test] + fn start_frame_media_token_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test123".to_string()))), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::MediaFileToken(t)) if t.as_str() == "mf_test123")); + } + + #[test] + fn reference_images_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_images: Some(ImageListRef::Urls(vec![ + "https://example.com/ref1.jpg".to_string(), + "https://example.com/ref2.jpg".to_string(), + ])), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + match remaining.reference_images { + Some(ImageListRef::Urls(urls)) => { + assert_eq!(urls.len(), 2); + assert_eq!(urls[0], "https://example.com/ref1.jpg"); + assert_eq!(urls[1], "https://example.com/ref2.jpg"); + } + _ => panic!("expected Urls variant"), + } + } + + #[test] + fn reference_videos_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_videos: Some(VideoListRef::Urls(vec![ + "https://example.com/vid.mp4".to_string(), + ])), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.reference_videos, Some(VideoListRef::Urls(urls)) if urls.len() == 1)); + } + + #[test] + fn reference_audio_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_audio: Some(AudioListRef::Urls(vec![ + "https://example.com/audio.mp3".to_string(), + ])), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.reference_audio, Some(AudioListRef::Urls(urls)) if urls.len() == 1)); + } + + #[test] + fn character_tokens_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new("char_abc".to_string()), + CharacterToken::new("char_def".to_string()), + ])), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + match remaining.reference_character_tokens { + Some(CharacterListRef::CharacterTokens(tokens)) => { + assert_eq!(tokens.len(), 2); + assert_eq!(tokens[0].as_str(), "char_abc"); + assert_eq!(tokens[1].as_str(), "char_def"); + } + _ => panic!("expected CharacterTokens variant"), + } + } + + #[test] + fn empty_refs_are_none_in_unhandled() { + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(seedance2pro_fast_builder())); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_none()); + assert!(remaining.end_frame.is_none()); + assert!(remaining.reference_images.is_none()); + assert!(remaining.reference_videos.is_none()); + assert!(remaining.reference_audio.is_none()); + assert!(remaining.reference_character_tokens.is_none()); + } + } + + // ── Full combination ── + + #[test] + fn full_request_all_fields() { + let builder = GenerateVideoRequestBuilder { + prompt: Some("full test".to_string()), + aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), + resolution: Some(RouterResolution::SevenTwentyP), + duration_seconds: Some(10), + video_batch_count: Some(4), + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + end_frame: Some(ImageRef::Url("https://example.com/end.jpg".to_string())), + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/ref.jpg".to_string()])), + reference_videos: Some(VideoListRef::Urls(vec!["https://example.com/vid.mp4".to_string()])), + reference_audio: Some(AudioListRef::Urls(vec!["https://example.com/audio.mp3".to_string()])), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new("char_xyz".to_string()), + ])), + ..seedance2pro_fast_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_fast(builder)); + + assert_eq!(draft.prompt, "full test"); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Portrait9x16)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + assert_eq!(draft.duration_seconds, 10); + assert!(matches!(draft.batch_count, KinoviBatchCount::Four)); + + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_some()); + assert!(remaining.end_frame.is_some()); + assert!(remaining.reference_images.is_some()); + assert!(remaining.reference_videos.is_some()); + assert!(remaining.reference_audio.is_some()); + assert!(remaining.reference_character_tokens.is_some()); + } + + // ── Helpers ── + + fn seedance2pro_fast_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a cat dancing".to_string()), + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn unwrap_draft(result: Result) -> KinoviSeedance2p0FastDraftState { + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviSeedance2p0Fast(draft) + ) => draft, + _ => panic!("expected KinoviSeedance2p0Fast draft"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/cost.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/cost.rs new file mode 100644 index 00000000..10bb6bee --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/cost.rs @@ -0,0 +1,436 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_fast::{ + GenerateSeedance2p0FastRequest, KinoviSeedance2p0FastBatchCount, + KinoviSeedance2p0FastOutputResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::draft::KinoviSeedance2p0FastDraftState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::request::KinoviSeedance2p0FastRequestState; + +pub struct KinoviSeedance2p0FastCostState { + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + pub has_video_reference: bool, +} + +impl KinoviSeedance2p0FastCostState { + pub fn from_request(request: &KinoviSeedance2p0FastRequestState) -> Self { + Self { + resolution: request.request.output_resolution, + duration_seconds: request.request.duration_seconds, + batch_count: request.request.batch_count, + has_video_reference: request.request.reference_video_urls + .as_ref() + .is_some_and(|urls| !urls.is_empty()), + } + } + + pub fn from_draft(draft: &KinoviSeedance2p0FastDraftState) -> Self { + let has_video_reference = draft.unhandled_request_state + .as_ref() + .and_then(|rem| rem.reference_videos.as_ref()) + .is_some(); + + Self { + resolution: draft.resolution, + duration_seconds: draft.duration_seconds, + batch_count: Some(draft.batch_count), + has_video_reference, + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let pricing_request = GenerateSeedance2p0FastRequest { + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: self.batch_count, + + // PRESENCE of reference videos changes the price (per-second + // surcharge); the URL contents don't. + reference_video_urls: if self.has_video_reference { + Some(vec!["pricing-placeholder".to_string()]) + } else { + None + }, + + // No impact on price + prompt: String::new(), + aspect_ratio: None, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }; + + let costs = pricing_request.calculate_costs(); + let cost_in_credits = costs.total_cost.kinovi_credits; + let cost_in_usd_cents = costs.total_cost.usd_cents_rounded_up; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_resolution::RouterResolution; + use seedance2pro_client::generate::video::generate_seedance_2p0_fast::{ + KinoviSeedance2p0FastOutputResolution as KinoviOutputResolution, + KinoviSeedance2p0FastBatchCount as KinoviBatchCount, + }; + + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + // ── Direct estimate_cost() tests ── + // These must match the reference implementation values exactly. + + // -- 720p (28 credits/sec, 243 credits/$1) -- + + mod pricing_720p { + use super::*; + + #[test] + fn cost_720p_batch_1() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One), 47); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One), 58); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 10, KinoviBatchCount::One), 116); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One), 173); + } + + #[test] + fn cost_720p_batch_2() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Two), 116); + } + + #[test] + fn cost_720p_batch_4() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Four), 231); + } + } + + // -- 480p (14 credits/sec, 243 credits/$1) -- + + mod pricing_480p { + use super::*; + + #[test] + fn cost_480p_batch_1() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 4, KinoviBatchCount::One), 24); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One), 29); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 10, KinoviBatchCount::One), 58); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 15, KinoviBatchCount::One), 87); + } + + #[test] + fn cost_480p_batch_2() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::Two), 58); + } + + #[test] + fn cost_480p_batch_4() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::Four), 116); + } + } + + // -- Relative pricing -- + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + let c480 = usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One); + let c720 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One); + assert!(c480 < c720, "480p ({}) should be cheaper than 720p ({})", c480, c720); + } + + #[test] + fn cost_scales_with_duration() { + let c4 = usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One); + let c10 = usd_cents(KinoviOutputResolution::SevenTwentyP, 10, KinoviBatchCount::One); + let c15 = usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One); + assert!(c4 < c10); + assert!(c10 < c15); + } + + #[test] + fn cost_scales_with_batch() { + let b1 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One); + let b2 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Two); + let b4 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Four); + assert!(b1 < b2); + assert!(b2 < b4); + } + } + + // -- Video reference does NOT affect cost (yet) -- + + #[test] + fn video_reference_adds_surcharge() { + let base = KinoviSeedance2p0FastCostState { + resolution: Some(KinoviOutputResolution::SevenTwentyP), + duration_seconds: 5, + batch_count: Some(KinoviBatchCount::One), + has_video_reference: false, + }; + let without = base.estimate_cost(); + let with = KinoviSeedance2p0FastCostState { has_video_reference: true, ..base }.estimate_cost(); + // Fast 720p surcharge is +6 credits/s: 140 -> 170 credits (17000/243 = 69.96 -> 70 cents). + assert_eq!(without.cost_in_credits, Some(140)); + assert_eq!(with.cost_in_credits, Some(170)); + assert_eq!(with.cost_in_usd_cents, Some(70)); + } + + // ── from_request() tests ── + + mod from_request_tests { + use super::*; + + #[test] + fn from_request_720p() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0FastCostState::from_request(&req); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + assert_eq!(cost.duration_seconds, 5); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::One))); + assert!(!cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(58)); + } + + #[test] + fn from_request_none_defaults_to_720p() { + let req = make_request_state(None, 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0FastCostState::from_request(&req); + assert!(cost.resolution.is_none()); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(58)); + } + + #[test] + fn from_request_480p() { + let req = make_request_state(Some(KinoviOutputResolution::FourEightyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0FastCostState::from_request(&req); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(29)); + } + + #[test] + fn from_request_with_video_reference() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, true); + let cost = KinoviSeedance2p0FastCostState::from_request(&req); + assert!(cost.has_video_reference); + // Video refs add a +6 credits/s surcharge at 720p: 170 credits -> 89 cents. + assert_eq!(cost.estimate_cost().cost_in_credits, Some(170)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(70)); + } + + #[test] + fn from_request_without_video_reference() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0FastCostState::from_request(&req); + assert!(!cost.has_video_reference); + } + } + + // ── from_draft() tests ── + + mod from_draft_tests { + use super::*; + + #[test] + fn from_draft_720p_default() { + let draft = make_draft(5, 1, None, false); + let cost = KinoviSeedance2p0FastCostState::from_draft(&draft); + assert!(cost.resolution.is_none()); + assert_eq!(cost.duration_seconds, 5); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::One))); + assert!(!cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(58)); + } + + #[test] + fn from_draft_480p() { + let draft = make_draft(5, 1, Some(RouterResolution::FourEightyP), false); + let cost = KinoviSeedance2p0FastCostState::from_draft(&draft); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::FourEightyP))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(29)); + } + + #[test] + fn from_draft_with_video_reference() { + let draft = make_draft(5, 1, None, true); + let cost = KinoviSeedance2p0FastCostState::from_draft(&draft); + assert!(cost.has_video_reference); + // Video refs add a +6 credits/s surcharge at 720p: 170 credits -> 89 cents. + assert_eq!(cost.estimate_cost().cost_in_credits, Some(170)); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(70)); + } + + #[test] + fn from_draft_without_video_reference() { + let draft = make_draft(5, 1, None, false); + let cost = KinoviSeedance2p0FastCostState::from_draft(&draft); + assert!(!cost.has_video_reference); + } + + #[test] + fn from_draft_duration_15_batch_2() { + let draft = make_draft(15, 2, Some(RouterResolution::SevenTwentyP), false); + let cost = KinoviSeedance2p0FastCostState::from_draft(&draft); + assert_eq!(cost.duration_seconds, 15); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::Two))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(346)); + } + } + + // ── Cross-check: from_draft matches from_request ── + + mod cross_check_tests { + use super::*; + + #[test] + fn draft_and_request_produce_same_cost() { + // 720p, 5s, batch 1 + let draft = make_draft(5, 1, Some(RouterResolution::SevenTwentyP), false); + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let draft_cost = KinoviSeedance2p0FastCostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviSeedance2p0FastCostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + + #[test] + fn draft_and_request_produce_same_cost_480p() { + let draft = make_draft(10, 2, Some(RouterResolution::FourEightyP), false); + let req = make_request_state(Some(KinoviOutputResolution::FourEightyP), 10, KinoviBatchCount::Two, false); + let draft_cost = KinoviSeedance2p0FastCostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviSeedance2p0FastCostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + } + + // ── Credits spot checks ── + + mod credits_tests { + use super::*; + + #[test] + fn credits_720p() { + assert_eq!(credits(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One), 140); + } + + #[test] + fn credits_480p() { + assert_eq!(credits(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One), 70); + } + } + + // ── Helpers ── + + fn usd_cents( + resolution: KinoviOutputResolution, + duration_seconds: u8, + batch_count: KinoviBatchCount, + ) -> u64 { + KinoviSeedance2p0FastCostState { + resolution: Some(resolution), duration_seconds, batch_count: Some(batch_count), + has_video_reference: false, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + fn credits( + resolution: KinoviOutputResolution, + duration_seconds: u8, + batch_count: KinoviBatchCount, + ) -> u64 { + KinoviSeedance2p0FastCostState { + resolution: Some(resolution), duration_seconds, batch_count: Some(batch_count), + has_video_reference: false, + } + .estimate_cost() + .cost_in_credits + .unwrap() + } + + /// Build a draft via the builder to test from_draft(). + fn make_draft( + duration_seconds: u16, + video_batch_count: u16, + resolution: Option, + with_video_ref: bool, + ) -> KinoviSeedance2p0FastDraftState { + let reference_videos = if with_video_ref { + Some(VideoListRef::Urls(vec!["https://example.com/video.mp4".to_string()])) + } else { + None + }; + + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Fast, + provider: RouterProvider::Seedance2Pro, + resolution, + reference_videos, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + + match builder.build2().expect("build2 should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviSeedance2p0Fast(draft) + ) => draft, + _ => panic!("expected KinoviSeedance2p0Fast draft"), + } + } + + /// Build a request state for from_request() tests. + fn make_request_state( + resolution: Option, + duration_seconds: u8, + batch_count: KinoviBatchCount, + with_video_ref: bool, + ) -> KinoviSeedance2p0FastRequestState { + let reference_video_urls = if with_video_ref { + Some(vec!["https://cdn.seedance2-pro.com/video.mp4".to_string()]) + } else { + None + }; + + KinoviSeedance2p0FastRequestState { + request: GenerateSeedance2p0FastRequest { + prompt: "test".to_string(), + aspect_ratio: None, + output_resolution: resolution, + duration_seconds, + batch_count: Some(batch_count), + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/draft.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/draft.rs new file mode 100644 index 00000000..4a338f5b --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/draft.rs @@ -0,0 +1,98 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_fast::{ + GenerateSeedance2p0FastRequest, KinoviSeedance2p0FastAspectRatio, KinoviSeedance2p0FastBitrate, + KinoviSeedance2p0FastBatchCount, KinoviSeedance2p0FastOutputResolution, +}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::character_list_ref::CharacterListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::providers::kinovi::resolve::{ + resolve_and_upload_list, resolve_and_upload_single, resolve_character_tokens, +}; +use crate::utils::media_source_ref::MediaSourceRef; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::request::KinoviSeedance2p0FastRequestState; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0FastDraftState { + pub prompt: String, + pub aspect_ratio: KinoviSeedance2p0FastAspectRatio, + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: KinoviSeedance2p0FastBatchCount, + pub bitrate: Option, + + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0FastRemainingItems { + pub start_frame: Option, + pub end_frame: Option, + pub reference_images: Option, + pub reference_videos: Option, + pub reference_audio: Option, + pub reference_character_tokens: Option, +} + +impl KinoviSeedance2p0FastDraftState { + pub async fn to_request( + &mut self, + draft_context: &VideoGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut start_frame_url = None; + let mut end_frame_url = None; + let mut reference_image_urls = None; + let mut reference_video_urls = None; + let mut reference_audio_urls = None; + let mut character_ids = None; + + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + + start_frame_url = resolve_and_upload_single(session, remaining.start_frame, map).await?; + end_frame_url = resolve_and_upload_single(session, remaining.end_frame, map).await?; + + reference_image_urls = resolve_and_upload_list( + session, remaining.reference_images.map(MediaSourceRef::list_from_images), map, + ).await?; + + reference_video_urls = resolve_and_upload_list( + session, remaining.reference_videos.map(MediaSourceRef::list_from_videos), map, + ).await?; + + reference_audio_urls = resolve_and_upload_list( + session, remaining.reference_audio.map(MediaSourceRef::list_from_audios), map, + ).await?; + + character_ids = resolve_character_tokens( + remaining.reference_character_tokens.as_ref(), + draft_context, + )?; + } + + let request = GenerateSeedance2p0FastRequest { + prompt: self.prompt.clone(), + aspect_ratio: Some(self.aspect_ratio), + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: Some(self.batch_count), + start_frame_url, + end_frame_url, + reference_image_urls, + reference_video_urls, + reference_audio_urls, + character_ids, + use_face_blur_hack: None, + bitrate: self.bitrate, + }; + + Ok(KinoviSeedance2p0FastRequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/mod.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/mod.rs new file mode 100644 index 00000000..fcfc9ddc --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod draft; +pub mod request; +pub mod cost; diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/request.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/request.rs new file mode 100644 index 00000000..fdbf4cd0 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_fast/request.rs @@ -0,0 +1,37 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_fast::{ + generate_seedance_2p0_fast, GenerateSeedance2p0FastArgs, GenerateSeedance2p0FastRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{GenerateVideoResponse, Seedance2proVideoResponsePayload}; + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0FastRequestState { + /// Final materialized request; ready to fire. + pub request: GenerateSeedance2p0FastRequest, +} + +impl KinoviSeedance2p0FastRequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSeedance2p0FastArgs { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_seedance_2p0_fast(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateVideoResponse::Seedance2Pro(Seedance2proVideoResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/build.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/build.rs new file mode 100644 index 00000000..7b837ebf --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/build.rs @@ -0,0 +1,510 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_mini::{ + KinoviSeedance2p0MiniAspectRatio as KinoviAspectRatio, + KinoviSeedance2p0MiniBitrate as KinoviBitrate, + KinoviSeedance2p0MiniBatchCount as KinoviBatchCount, + KinoviSeedance2p0MiniOutputResolution as KinoviOutputResolution, +}; + +use crate::api::router_aspect_ratio::RouterAspectRatio; +use crate::api::router_bitrate::RouterBitrate; +use crate::api::router_resolution::RouterResolution; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::draft::{KinoviSeedance2p0MiniDraftState, KinoviSeedance2p0MiniRemainingItems}; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + +pub fn build_kinovi_seedance_2p0_mini(builder: GenerateVideoRequestBuilder) -> Result { + let draft = do_build_kinovi_seedance_2p0_mini(builder)?; + Ok(VideoGenerationDraftOrRequest::Draft(VideoGenerationDraftRequest::KinoviSeedance2p0Mini(draft))) +} + +fn do_build_kinovi_seedance_2p0_mini(mut builder: GenerateVideoRequestBuilder) -> Result { + let strategy = builder.request_mismatch_mitigation_strategy; + + let aspect_ratio = plan_aspect_ratio(builder.aspect_ratio.take(), strategy)?; + let resolution = plan_output_resolution(builder.resolution.take(), strategy)?; + let batch_count = plan_batch_count(builder.video_batch_count.take(), strategy)?; + let duration_seconds = plan_duration(builder.duration_seconds.take(), strategy)?; + let bitrate = plan_bitrate(builder.bitrate.take()); + let prompt = builder.prompt.take().unwrap_or_default(); + + let unhandled_request_state = KinoviSeedance2p0MiniRemainingItems { + start_frame: builder.start_frame.take(), + end_frame: builder.end_frame.take(), + reference_images: builder.reference_images.take(), + reference_videos: builder.reference_videos.take(), + reference_audio: builder.reference_audio.take(), + reference_character_tokens: builder.reference_character_tokens.take(), + }; + + Ok(KinoviSeedance2p0MiniDraftState { + aspect_ratio, + resolution, + batch_count, + duration_seconds, + bitrate, + prompt, + unhandled_request_state: Some(unhandled_request_state), + }) +} + +// ── Plan helpers ── + +// Seedance 2.0 Mini supports all six aspect ratios: +// 16:9, 21:9, 9:16, 1:1, 4:3, 3:4. All supported ratios cost the same, so +// both upgrade and downgrade pick the nearest match. +fn plan_aspect_ratio( + aspect_ratio: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + match aspect_ratio { + // No preference or auto — default to landscape + None + | Some(RouterAspectRatio::Auto) + | Some(RouterAspectRatio::Auto2k) + | Some(RouterAspectRatio::Auto4k) => Ok(KinoviAspectRatio::Landscape16x9), + + // Direct mappings + Some(RouterAspectRatio::WideSixteenByNine) | Some(RouterAspectRatio::Wide) => { + Ok(KinoviAspectRatio::Landscape16x9) + } + Some(RouterAspectRatio::TallNineBySixteen) | Some(RouterAspectRatio::Tall) => { + Ok(KinoviAspectRatio::Portrait9x16) + } + Some(RouterAspectRatio::Square) | Some(RouterAspectRatio::SquareHd) => { + Ok(KinoviAspectRatio::Square1x1) + } + Some(RouterAspectRatio::WideFourByThree) => Ok(KinoviAspectRatio::Standard4x3), + Some(RouterAspectRatio::TallThreeByFour) => Ok(KinoviAspectRatio::Portrait3x4), + Some(RouterAspectRatio::WideTwentyOneByNine) => Ok(KinoviAspectRatio::UltraWide21x9), + + // Mismatches — apply strategy + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "aspect_ratio", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(nearest_aspect_ratio(unsupported)) + } + }, + } +} + +/// Pick the nearest supported aspect ratio by AR value (width / height). +fn nearest_aspect_ratio(aspect_ratio: RouterAspectRatio) -> KinoviAspectRatio { + match aspect_ratio { + RouterAspectRatio::WideFiveByFour => KinoviAspectRatio::Standard4x3, // 1.25, nearest 1.33 + RouterAspectRatio::WideThreeByTwo => KinoviAspectRatio::Standard4x3, // 1.50, nearest 1.33 + RouterAspectRatio::TallFourByFive => KinoviAspectRatio::Portrait3x4, // 0.80, nearest 0.75 + RouterAspectRatio::TallTwoByThree => KinoviAspectRatio::Portrait3x4, // 0.67, nearest 0.75 + RouterAspectRatio::TallNineByTwentyOne => KinoviAspectRatio::Portrait9x16, // 0.43, nearest 0.56 + _ => KinoviAspectRatio::Square1x1, + } +} + +// Seedance 2.0 Mini supports output resolutions: 480p and 720p only. +// 1080p (and higher) is NOT supported — downgrade to 720p or error based on strategy. +fn plan_output_resolution( + resolution: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result, ArtcraftRouterError> { + match resolution { + None => Ok(None), + + // Direct mappings + Some(RouterResolution::FourEightyP) => Ok(Some(KinoviOutputResolution::FourEightyP)), + Some(RouterResolution::SevenTwentyP) => Ok(Some(KinoviOutputResolution::SevenTwentyP)), + + // 1080p is not supported for Mini — handle via strategy + Some(RouterResolution::TenEightyP) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", RouterResolution::TenEightyP), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + // 1080p not available — downgrade to 720p (highest supported) + Ok(Some(KinoviOutputResolution::SevenTwentyP)) + } + }, + + // Other unsupported resolutions + Some(unsupported) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "resolution", + value: format!("{:?}", unsupported), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => { + Ok(Some(match unsupported { + RouterResolution::HalfK => KinoviOutputResolution::FourEightyP, + _ => KinoviOutputResolution::SevenTwentyP, + })) + } + }, + } +} + +// Seedance 2.0 Mini supports batch counts of 1–8. +fn plan_batch_count( + video_batch_count: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + let count = video_batch_count.unwrap_or(1); + match count { + 0 => Err(ArtcraftRouterError::Client(ClientError::UserRequestedZeroGenerations)), + 1 => Ok(KinoviBatchCount::One), + 2 => Ok(KinoviBatchCount::Two), + 3 => Ok(KinoviBatchCount::Three), + 4 => Ok(KinoviBatchCount::Four), + 5 => Ok(KinoviBatchCount::Five), + 6 => Ok(KinoviBatchCount::Six), + 7 => Ok(KinoviBatchCount::Seven), + 8 => Ok(KinoviBatchCount::Eight), + // Over the maximum of 8. + _ => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "video_batch_count", + value: format!("{}", count), + })) + } + RequestMismatchMitigationStrategy::PayMoreUpgrade + | RequestMismatchMitigationStrategy::PayLessDowngrade => Ok(KinoviBatchCount::Eight), + }, + } +} + +// Seedance 2.0 Mini supports duration of 4–15 seconds. +fn plan_duration( + duration_seconds: Option, + strategy: RequestMismatchMitigationStrategy, +) -> Result { + const MIN: u16 = 4; + const MAX: u16 = 15; + const DEFAULT: u8 = 5; + match duration_seconds { + None => Ok(DEFAULT), + Some(d) if d >= MIN && d <= MAX => Ok(d as u8), + Some(d) => match strategy { + RequestMismatchMitigationStrategy::ErrorOut => { + Err(ArtcraftRouterError::Client(ClientError::ModelDoesNotSupportOption { + field: "duration_seconds", + value: format!("{}", d), + })) + } + _ => Ok(d.clamp(MIN, MAX) as u8), + }, + } +} + +// Seedance 2.0 Mini bitrate: "standard" (default, field omitted) or "high". +// Bitrate does not affect cost. `Normal` and unset both map to standard (None); +// only `High` requests the higher bitrate. +fn plan_bitrate(bitrate: Option) -> Option { + match bitrate { + Some(RouterBitrate::High) => Some(KinoviBitrate::High), + Some(RouterBitrate::Normal) | None => None, + } +} + +#[cfg(test)] +mod tests { + use seedance2pro_client::generate::video::generate_seedance_2p0_mini::{ + KinoviSeedance2p0MiniAspectRatio as KinoviAspectRatio, + KinoviSeedance2p0MiniBatchCount as KinoviBatchCount, + KinoviSeedance2p0MiniOutputResolution as KinoviOutputResolution, + }; + use artcraft_client::tokens::characters::CharacterToken; + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::api::audio_list_ref::AudioListRef; + use crate::api::character_list_ref::CharacterListRef; + use crate::api::router_aspect_ratio::RouterAspectRatio; + use crate::api::router_resolution::RouterResolution; + use crate::api::router_video_model::RouterVideoModel; + use crate::api::image_list_ref::ImageListRef; + use crate::api::image_ref::ImageRef; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::draft::KinoviSeedance2p0MiniDraftState; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + use super::*; + + mod materialized_field_conversions { + use super::*; + + #[test] + fn prompt_is_passed_through() { + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(mini_builder())); + assert_eq!(draft.prompt, "a cat dancing"); + } + + #[test] + fn prompt_defaults_to_empty() { + let builder = GenerateVideoRequestBuilder { prompt: None, ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert_eq!(draft.prompt, ""); + } + + #[test] + fn duration_seconds_converted() { + let builder = GenerateVideoRequestBuilder { duration_seconds: Some(10), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert_eq!(draft.duration_seconds, 10); + } + + #[test] + fn duration_defaults_to_5() { + let builder = GenerateVideoRequestBuilder { duration_seconds: None, ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert_eq!(draft.duration_seconds, 5); + } + + #[test] + fn duration_clamped_to_max() { + let builder = GenerateVideoRequestBuilder { duration_seconds: Some(99), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert_eq!(draft.duration_seconds, 15); + } + } + + mod batch_count_conversions { + use super::*; + + #[test] + fn batch_counts_one_through_eight() { + let expected = [ + (1u16, KinoviBatchCount::One), + (2, KinoviBatchCount::Two), + (3, KinoviBatchCount::Three), + (4, KinoviBatchCount::Four), + (5, KinoviBatchCount::Five), + (6, KinoviBatchCount::Six), + (7, KinoviBatchCount::Seven), + (8, KinoviBatchCount::Eight), + ]; + for (count, variant) in expected { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(count), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!( + std::mem::discriminant(&draft.batch_count) == std::mem::discriminant(&variant), + "batch {count} mapped wrong", + ); + } + } + + #[test] + fn batch_over_max_downgrades_to_eight() { + let builder = GenerateVideoRequestBuilder { + video_batch_count: Some(12), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayLessDowngrade, + ..mini_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.batch_count, KinoviBatchCount::Eight)); + } + + #[test] + fn batch_over_max_error_out() { + let builder = GenerateVideoRequestBuilder { + video_batch_count: Some(12), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..mini_builder() + }; + assert!(build_kinovi_seedance_2p0_mini(builder).is_err()); + } + + #[test] + fn batch_zero_errors() { + let builder = GenerateVideoRequestBuilder { video_batch_count: Some(0), ..mini_builder() }; + assert!(build_kinovi_seedance_2p0_mini(builder).is_err()); + } + } + + mod aspect_ratio_conversions { + use super::*; + + #[test] + fn aspect_ratio_wide() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: Some(RouterAspectRatio::WideSixteenByNine), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Landscape16x9)); + } + + #[test] + fn aspect_ratio_ultra_wide() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: Some(RouterAspectRatio::WideTwentyOneByNine), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::UltraWide21x9)); + } + + #[test] + fn aspect_ratio_tall() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: Some(RouterAspectRatio::TallNineBySixteen), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Portrait9x16)); + } + + #[test] + fn aspect_ratio_square() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: Some(RouterAspectRatio::Square), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Square1x1)); + } + + #[test] + fn aspect_ratio_four_by_three() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: Some(RouterAspectRatio::WideFourByThree), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Standard4x3)); + } + + #[test] + fn aspect_ratio_three_by_four() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: Some(RouterAspectRatio::TallThreeByFour), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Portrait3x4)); + } + + #[test] + fn aspect_ratio_defaults_to_landscape() { + let builder = GenerateVideoRequestBuilder { aspect_ratio: None, ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.aspect_ratio, KinoviAspectRatio::Landscape16x9)); + } + } + + mod resolution_conversions { + use super::*; + + #[test] + fn resolution_480p() { + let builder = GenerateVideoRequestBuilder { resolution: Some(RouterResolution::FourEightyP), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::FourEightyP))); + } + + #[test] + fn resolution_720p() { + let builder = GenerateVideoRequestBuilder { resolution: Some(RouterResolution::SevenTwentyP), ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p_downgrades_to_720p() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::PayLessDowngrade, + ..mini_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(matches!(draft.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + } + + #[test] + fn resolution_1080p_error_out() { + let builder = GenerateVideoRequestBuilder { + resolution: Some(RouterResolution::TenEightyP), + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + ..mini_builder() + }; + assert!(build_kinovi_seedance_2p0_mini(builder).is_err()); + } + + #[test] + fn resolution_none() { + let builder = GenerateVideoRequestBuilder { resolution: None, ..mini_builder() }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + assert!(draft.resolution.is_none()); + } + } + + mod unhandled_request_state { + use super::*; + + #[test] + fn media_refs_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::Url("https://example.com/start.jpg".to_string())), + end_frame: Some(ImageRef::Url("https://example.com/end.jpg".to_string())), + reference_images: Some(ImageListRef::Urls(vec!["https://example.com/ref.jpg".to_string()])), + reference_videos: Some(VideoListRef::Urls(vec!["https://example.com/vid.mp4".to_string()])), + reference_audio: Some(AudioListRef::Urls(vec!["https://example.com/audio.mp3".to_string()])), + reference_character_tokens: Some(CharacterListRef::CharacterTokens(vec![ + CharacterToken::new("char_abc".to_string()), + ])), + ..mini_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_some()); + assert!(remaining.end_frame.is_some()); + assert!(remaining.reference_images.is_some()); + assert!(remaining.reference_videos.is_some()); + assert!(remaining.reference_audio.is_some()); + assert!(remaining.reference_character_tokens.is_some()); + } + + #[test] + fn start_frame_media_token_placed_in_unhandled() { + let builder = GenerateVideoRequestBuilder { + start_frame: Some(ImageRef::MediaFileToken(MediaFileToken::new("mf_test123".to_string()))), + ..mini_builder() + }; + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(builder)); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(matches!(remaining.start_frame, Some(ImageRef::MediaFileToken(t)) if t.as_str() == "mf_test123")); + } + + #[test] + fn empty_refs_are_none_in_unhandled() { + let draft = unwrap_draft(build_kinovi_seedance_2p0_mini(mini_builder())); + let remaining = draft.unhandled_request_state.unwrap(); + assert!(remaining.start_frame.is_none()); + assert!(remaining.end_frame.is_none()); + assert!(remaining.reference_images.is_none()); + assert!(remaining.reference_videos.is_none()); + assert!(remaining.reference_audio.is_none()); + assert!(remaining.reference_character_tokens.is_none()); + } + } + + // ── Helpers ── + + fn mini_builder() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Seedance2Pro, + prompt: Some("a cat dancing".to_string()), + duration_seconds: Some(5), + video_batch_count: Some(1), + ..Default::default() + } + } + + fn unwrap_draft(result: Result) -> KinoviSeedance2p0MiniDraftState { + match result.expect("build should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviSeedance2p0Mini(draft) + ) => draft, + _ => panic!("expected KinoviSeedance2p0Mini draft"), + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/cost.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/cost.rs new file mode 100644 index 00000000..082b8230 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/cost.rs @@ -0,0 +1,378 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_mini::{ + GenerateSeedance2p0MiniRequest, KinoviSeedance2p0MiniBatchCount, + KinoviSeedance2p0MiniOutputResolution, +}; + +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::draft::KinoviSeedance2p0MiniDraftState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::request::KinoviSeedance2p0MiniRequestState; + +pub struct KinoviSeedance2p0MiniCostState { + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: Option, + pub has_video_reference: bool, +} + +impl KinoviSeedance2p0MiniCostState { + pub fn from_request(request: &KinoviSeedance2p0MiniRequestState) -> Self { + Self { + resolution: request.request.output_resolution, + duration_seconds: request.request.duration_seconds, + batch_count: request.request.batch_count, + has_video_reference: request.request.reference_video_urls + .as_ref() + .is_some_and(|urls| !urls.is_empty()), + } + } + + pub fn from_draft(draft: &KinoviSeedance2p0MiniDraftState) -> Self { + let has_video_reference = draft.unhandled_request_state + .as_ref() + .and_then(|rem| rem.reference_videos.as_ref()) + .is_some(); + + Self { + resolution: draft.resolution, + duration_seconds: draft.duration_seconds, + batch_count: Some(draft.batch_count), + has_video_reference, + } + } + + pub fn estimate_cost(&self) -> VideoGenerationCostEstimate { + let pricing_request = GenerateSeedance2p0MiniRequest { + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: self.batch_count, + + // PRESENCE of reference videos changes the price (per-second + // surcharge); the URL contents don't. + reference_video_urls: if self.has_video_reference { + Some(vec!["pricing-placeholder".to_string()]) + } else { + None + }, + + // No impact on price + prompt: String::new(), + aspect_ratio: None, + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }; + + let costs = pricing_request.calculate_costs(); + // Mini credits can be fractional (e.g. 480p odd durations land on 37.5). + // The router's credit field is an integer, so round to the nearest credit; + // the USD cents (the authoritative charge) are already rounded up. + let cost_in_credits = costs.total_cost.kinovi_credits.round() as u64; + let cost_in_usd_cents = costs.total_cost.usd_cents_rounded_up; + + VideoGenerationCostEstimate { + cost_in_credits: Some(cost_in_credits), + cost_in_usd_cents: Some(cost_in_usd_cents), + is_free: false, + is_unlimited: false, + is_rate_limited: false, + has_watermark: false, + failures_are_refunded: None, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::router_resolution::RouterResolution; + use seedance2pro_client::generate::video::generate_seedance_2p0_mini::{ + KinoviSeedance2p0MiniOutputResolution as KinoviOutputResolution, + KinoviSeedance2p0MiniBatchCount as KinoviBatchCount, + }; + + use crate::api::router_video_model::RouterVideoModel; + use crate::api::router_provider::RouterProvider; + use crate::api::video_list_ref::VideoListRef; + use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; + use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; + use crate::generate::generate_video::video_generation_draft_or_request::VideoGenerationDraftOrRequest; + + // ── USD cents: every combination (480p/720p × with/without video ref) ── + + mod pricing_480p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 4, KinoviBatchCount::One, false), 13); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One, false), 16); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 10, KinoviBatchCount::One, false), 31); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 15, KinoviBatchCount::One, false), 47); + } + + #[test] + fn with_video_reference() { + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 4, KinoviBatchCount::One, true), 16); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One, true), 20); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 10, KinoviBatchCount::One, true), 40); + assert_eq!(usd_cents(KinoviOutputResolution::FourEightyP, 15, KinoviBatchCount::One, true), 59); + } + } + + mod pricing_720p { + use super::*; + + #[test] + fn without_video_reference() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One, false), 33); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One, false), 42); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 10, KinoviBatchCount::One, false), 83); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One, false), 124); + } + + #[test] + fn with_video_reference() { + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One, true), 40); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One, true), 50); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 10, KinoviBatchCount::One, true), 99); + assert_eq!(usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One, true), 149); + } + } + + // ── Credits (mini bills fractional credits, rounded for the integer field) ── + + mod credits_tests { + use super::*; + + #[test] + fn credits_480p() { + // 7.5 credits/s; odd durations are fractional (37.5 → 38, 112.5 → 113). + assert_eq!(credits(KinoviOutputResolution::FourEightyP, 4, KinoviBatchCount::One, false), 30); + assert_eq!(credits(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One, false), 38); + assert_eq!(credits(KinoviOutputResolution::FourEightyP, 10, KinoviBatchCount::One, false), 75); + assert_eq!(credits(KinoviOutputResolution::FourEightyP, 15, KinoviBatchCount::One, false), 113); + } + + #[test] + fn credits_720p() { + assert_eq!(credits(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One, false), 100); + assert_eq!(credits(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One, false), 300); + } + } + + // ── Relative pricing ── + + mod relative_pricing_tests { + use super::*; + + #[test] + fn cost_480p_cheaper_than_720p() { + let c480 = usd_cents(KinoviOutputResolution::FourEightyP, 5, KinoviBatchCount::One, false); + let c720 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One, false); + assert!(c480 < c720, "480p ({c480}) should be cheaper than 720p ({c720})"); + } + + #[test] + fn video_reference_costs_more() { + for res in [KinoviOutputResolution::FourEightyP, KinoviOutputResolution::SevenTwentyP] { + for dur in [4u8, 5, 10, 15] { + let without = usd_cents(res, dur, KinoviBatchCount::One, false); + let with = usd_cents(res, dur, KinoviBatchCount::One, true); + assert!(with > without, "video ref should cost more at {res:?} {dur}s"); + } + } + } + + #[test] + fn cost_scales_with_duration_and_batch() { + let c4 = usd_cents(KinoviOutputResolution::SevenTwentyP, 4, KinoviBatchCount::One, false); + let c15 = usd_cents(KinoviOutputResolution::SevenTwentyP, 15, KinoviBatchCount::One, false); + assert!(c4 < c15); + let b1 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::One, false); + let b4 = usd_cents(KinoviOutputResolution::SevenTwentyP, 5, KinoviBatchCount::Four, false); + assert!(b1 < b4); + } + } + + // ── from_request() ── + + mod from_request_tests { + use super::*; + + #[test] + fn from_request_720p() { + let req = make_request_state(Some(KinoviOutputResolution::SevenTwentyP), 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0MiniCostState::from_request(&req); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::SevenTwentyP))); + assert_eq!(cost.duration_seconds, 5); + assert!(!cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(42)); + } + + #[test] + fn from_request_480p_with_video_reference() { + let req = make_request_state(Some(KinoviOutputResolution::FourEightyP), 5, KinoviBatchCount::One, true); + let cost = KinoviSeedance2p0MiniCostState::from_request(&req); + assert!(cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(20)); + } + + #[test] + fn from_request_none_defaults_to_720p() { + let req = make_request_state(None, 5, KinoviBatchCount::One, false); + let cost = KinoviSeedance2p0MiniCostState::from_request(&req); + assert!(cost.resolution.is_none()); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(42)); + } + } + + // ── from_draft() ── + + mod from_draft_tests { + use super::*; + + #[test] + fn from_draft_480p() { + let draft = make_draft(5, 1, Some(RouterResolution::FourEightyP), false); + let cost = KinoviSeedance2p0MiniCostState::from_draft(&draft); + assert!(matches!(cost.resolution, Some(KinoviOutputResolution::FourEightyP))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(16)); + } + + #[test] + fn from_draft_with_video_reference() { + let draft = make_draft(5, 1, Some(RouterResolution::SevenTwentyP), true); + let cost = KinoviSeedance2p0MiniCostState::from_draft(&draft); + assert!(cost.has_video_reference); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(50)); + } + + #[test] + fn from_draft_batch_8() { + // Mini supports up to batch 8: 720p 5s × 8 = 800 credits → 80000/243 → 330¢. + let draft = make_draft(5, 8, Some(RouterResolution::SevenTwentyP), false); + let cost = KinoviSeedance2p0MiniCostState::from_draft(&draft); + assert!(matches!(cost.batch_count, Some(KinoviBatchCount::Eight))); + assert_eq!(cost.estimate_cost().cost_in_usd_cents, Some(330)); + } + } + + // ── Cross-check: from_draft matches from_request ── + + mod cross_check_tests { + use super::*; + + #[test] + fn draft_and_request_produce_same_cost() { + let draft = make_draft(10, 2, Some(RouterResolution::FourEightyP), true); + let req = make_request_state(Some(KinoviOutputResolution::FourEightyP), 10, KinoviBatchCount::Two, true); + let draft_cost = KinoviSeedance2p0MiniCostState::from_draft(&draft).estimate_cost(); + let req_cost = KinoviSeedance2p0MiniCostState::from_request(&req).estimate_cost(); + assert_eq!(draft_cost.cost_in_usd_cents, req_cost.cost_in_usd_cents); + assert_eq!(draft_cost.cost_in_credits, req_cost.cost_in_credits); + } + } + + // ── Helpers ── + + fn usd_cents( + resolution: KinoviOutputResolution, + duration_seconds: u8, + batch_count: KinoviBatchCount, + has_video_reference: bool, + ) -> u64 { + KinoviSeedance2p0MiniCostState { + resolution: Some(resolution), + duration_seconds, + batch_count: Some(batch_count), + has_video_reference, + } + .estimate_cost() + .cost_in_usd_cents + .unwrap() + } + + fn credits( + resolution: KinoviOutputResolution, + duration_seconds: u8, + batch_count: KinoviBatchCount, + has_video_reference: bool, + ) -> u64 { + KinoviSeedance2p0MiniCostState { + resolution: Some(resolution), + duration_seconds, + batch_count: Some(batch_count), + has_video_reference, + } + .estimate_cost() + .cost_in_credits + .unwrap() + } + + /// Build a draft via the builder to test from_draft(). + fn make_draft( + duration_seconds: u16, + video_batch_count: u16, + resolution: Option, + with_video_ref: bool, + ) -> KinoviSeedance2p0MiniDraftState { + let reference_videos = if with_video_ref { + Some(VideoListRef::Urls(vec!["https://example.com/video.mp4".to_string()])) + } else { + None + }; + + let builder = GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0Mini, + provider: RouterProvider::Seedance2Pro, + resolution, + reference_videos, + duration_seconds: Some(duration_seconds), + video_batch_count: Some(video_batch_count), + ..Default::default() + }; + + match builder.build2().expect("build2 should succeed") { + VideoGenerationDraftOrRequest::Draft( + VideoGenerationDraftRequest::KinoviSeedance2p0Mini(draft) + ) => draft, + _ => panic!("expected KinoviSeedance2p0Mini draft"), + } + } + + /// Build a request state for from_request() tests. + fn make_request_state( + resolution: Option, + duration_seconds: u8, + batch_count: KinoviBatchCount, + with_video_ref: bool, + ) -> KinoviSeedance2p0MiniRequestState { + let reference_video_urls = if with_video_ref { + Some(vec!["https://cdn.seedance2-pro.com/video.mp4".to_string()]) + } else { + None + }; + + KinoviSeedance2p0MiniRequestState { + request: GenerateSeedance2p0MiniRequest { + prompt: "test".to_string(), + aspect_ratio: None, + output_resolution: resolution, + duration_seconds, + batch_count: Some(batch_count), + start_frame_url: None, + end_frame_url: None, + reference_image_urls: None, + reference_video_urls, + reference_audio_urls: None, + character_ids: None, + use_face_blur_hack: None, + bitrate: None, + }, + } + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/draft.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/draft.rs new file mode 100644 index 00000000..df155871 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/draft.rs @@ -0,0 +1,98 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_mini::{ + GenerateSeedance2p0MiniRequest, KinoviSeedance2p0MiniAspectRatio, KinoviSeedance2p0MiniBitrate, + KinoviSeedance2p0MiniBatchCount, KinoviSeedance2p0MiniOutputResolution, +}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::character_list_ref::CharacterListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::providers::kinovi::resolve::{ + resolve_and_upload_list, resolve_and_upload_single, resolve_character_tokens, +}; +use crate::utils::media_source_ref::MediaSourceRef; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::request::KinoviSeedance2p0MiniRequestState; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0MiniDraftState { + pub prompt: String, + pub aspect_ratio: KinoviSeedance2p0MiniAspectRatio, + pub resolution: Option, + pub duration_seconds: u8, + pub batch_count: KinoviSeedance2p0MiniBatchCount, + pub bitrate: Option, + + pub unhandled_request_state: Option, +} + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0MiniRemainingItems { + pub start_frame: Option, + pub end_frame: Option, + pub reference_images: Option, + pub reference_videos: Option, + pub reference_audio: Option, + pub reference_character_tokens: Option, +} + +impl KinoviSeedance2p0MiniDraftState { + pub async fn to_request( + &mut self, + draft_context: &VideoGenerationDraftContext<'_>, + ) -> Result { + let client = draft_context.get_seedance2pro_client_ref()?; + let session = &client.session; + + let mut start_frame_url = None; + let mut end_frame_url = None; + let mut reference_image_urls = None; + let mut reference_video_urls = None; + let mut reference_audio_urls = None; + let mut character_ids = None; + + if let Some(remaining) = self.unhandled_request_state.take() { + let map = draft_context.media_file_to_artcraft_url_map; + + start_frame_url = resolve_and_upload_single(session, remaining.start_frame, map).await?; + end_frame_url = resolve_and_upload_single(session, remaining.end_frame, map).await?; + + reference_image_urls = resolve_and_upload_list( + session, remaining.reference_images.map(MediaSourceRef::list_from_images), map, + ).await?; + + reference_video_urls = resolve_and_upload_list( + session, remaining.reference_videos.map(MediaSourceRef::list_from_videos), map, + ).await?; + + reference_audio_urls = resolve_and_upload_list( + session, remaining.reference_audio.map(MediaSourceRef::list_from_audios), map, + ).await?; + + character_ids = resolve_character_tokens( + remaining.reference_character_tokens.as_ref(), + draft_context, + )?; + } + + let request = GenerateSeedance2p0MiniRequest { + prompt: self.prompt.clone(), + aspect_ratio: Some(self.aspect_ratio), + output_resolution: self.resolution, + duration_seconds: self.duration_seconds, + batch_count: Some(self.batch_count), + start_frame_url, + end_frame_url, + reference_image_urls, + reference_video_urls, + reference_audio_urls, + character_ids, + use_face_blur_hack: None, + bitrate: self.bitrate, + }; + + Ok(KinoviSeedance2p0MiniRequestState { request }) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/mod.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/mod.rs new file mode 100644 index 00000000..fcfc9ddc --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/mod.rs @@ -0,0 +1,4 @@ +pub mod build; +pub mod draft; +pub mod request; +pub mod cost; diff --git a/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/request.rs b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/request.rs new file mode 100644 index 00000000..c861f191 --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/seedance_2p0_mini/request.rs @@ -0,0 +1,37 @@ +use seedance2pro_client::generate::video::generate_seedance_2p0_mini::{ + generate_seedance_2p0_mini, GenerateSeedance2p0MiniArgs, GenerateSeedance2p0MiniRequest, +}; + +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::generate::generate_video::generate_video_response::{GenerateVideoResponse, Seedance2proVideoResponsePayload}; + +#[derive(Debug, Clone)] +pub struct KinoviSeedance2p0MiniRequestState { + /// Final materialized request; ready to fire. + pub request: GenerateSeedance2p0MiniRequest, +} + +impl KinoviSeedance2p0MiniRequestState { + pub async fn send(&self, client: &RouterSeedance2ProClient) -> Result { + let session = &client.session; + + let args = GenerateSeedance2p0MiniArgs { + session, + host_override: None, + request: self.request.clone(), + }; + + let response = generate_seedance_2p0_mini(args) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(GenerateVideoResponse::Seedance2Pro(Seedance2proVideoResponsePayload { + order_id: response.order_id, + task_id: response.task_id, + maybe_order_ids: response.order_ids, + maybe_task_ids: response.task_ids, + })) + } +} diff --git a/crates/router/src/generate/generate_video/providers/kinovi/upload.rs b/crates/router/src/generate/generate_video/providers/kinovi/upload.rs new file mode 100644 index 00000000..9744bf7d --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/kinovi/upload.rs @@ -0,0 +1,64 @@ +use std::collections::HashMap; + +use log::info; +use seedance2pro_client::creds::seedance2pro_session::Seedance2ProSession; +use seedance2pro_client::requests::prepare_file_upload::prepare_file_upload::{prepare_file_upload, PrepareFileUploadArgs}; +use seedance2pro_client::requests::upload_file::upload_file::{upload_file, UploadFileArgs}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::utils::media_source_ref::{ + extension_from_name_hint, resolve_media_source_bytes, MediaSourceRef, ResolvedMediaBytes, +}; + +/// Resolves one media source to bytes (token → CDN download, URL → download, +/// local path → disk read, bytes → as-is) and uploads it to the Seedance2Pro +/// CDN. Returns the public URL. +pub(crate) async fn upload_source_to_seedance2pro( + session: &Seedance2ProSession, + source: MediaSourceRef, + maybe_map: Option<&HashMap>, +) -> Result { + let ResolvedMediaBytes { bytes, maybe_name_hint, description, .. } = + resolve_media_source_bytes(source, maybe_map).await?; + + let extension = maybe_name_hint.as_deref() + .and_then(extension_from_name_hint) + .unwrap_or_else(|| "jpg".to_string()); + + info!("Uploading reference to Seedance2Pro from {} ({} bytes, .{})", description, bytes.len(), extension); + upload_bytes_to_seedance2pro(session, bytes, extension).await +} + +/// Downloads a file from a source URL and re-uploads it to seedance2pro CDN. +pub(crate) async fn upload_to_seedance2pro( + session: &Seedance2ProSession, + source_url: &str, +) -> Result { + upload_source_to_seedance2pro(session, MediaSourceRef::Url(source_url.to_string()), None).await +} + +async fn upload_bytes_to_seedance2pro( + session: &Seedance2ProSession, + file_bytes: Vec, + extension: String, +) -> Result { + let prepare_response = prepare_file_upload(PrepareFileUploadArgs { + session, + extension, + host_override: None, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + let upload_response = upload_file(UploadFileArgs { + upload_url: prepare_response.upload_url, + file_bytes, + host_override: None, + }) + .await + .map_err(|err| ArtcraftRouterError::Provider(ProviderError::Seedance2Pro(err)))?; + + Ok(upload_response.public_url) +} diff --git a/crates/router/src/generate/generate_video/providers/mod.rs b/crates/router/src/generate/generate_video/providers/mod.rs new file mode 100644 index 00000000..fe2f160a --- /dev/null +++ b/crates/router/src/generate/generate_video/providers/mod.rs @@ -0,0 +1,6 @@ +pub mod artcraft; +pub mod fal; +pub mod gmicloud; +pub mod grok_api; +pub mod higgsfield; +pub mod kinovi; \ No newline at end of file diff --git a/crates/router/src/generate/generate_video/video_generation_cost_estimate.rs b/crates/router/src/generate/generate_video/video_generation_cost_estimate.rs new file mode 100644 index 00000000..adaf5364 --- /dev/null +++ b/crates/router/src/generate/generate_video/video_generation_cost_estimate.rs @@ -0,0 +1,16 @@ +/// The result of estimating the cost of a video generation plan. +#[derive(Clone, Debug)] +pub struct VideoGenerationCostEstimate { + pub cost_in_credits: Option, + pub cost_in_usd_cents: Option, + pub is_free: bool, + pub is_unlimited: bool, + pub is_rate_limited: bool, + pub has_watermark: bool, + + /// Whether failures are refunded. + /// True: 100% yes + /// False: 100% no + /// None: Unknown or variable + pub failures_are_refunded: Option, +} diff --git a/crates/router/src/generate/generate_video/video_generation_draft.rs b/crates/router/src/generate/generate_video/video_generation_draft.rs new file mode 100644 index 00000000..6b859bb5 --- /dev/null +++ b/crates/router/src/generate/generate_video/video_generation_draft.rs @@ -0,0 +1,79 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::cost::KinoviHappyHorse1p0CostState; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::draft::KinoviHappyHorse1p0DraftState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::cost::KinoviSeedance2p0CostState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::draft::KinoviSeedance2p0DraftState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::cost::KinoviSeedance2p0FastCostState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::draft::KinoviSeedance2p0FastDraftState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::cost::KinoviSeedance2p0MiniCostState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::draft::KinoviSeedance2p0MiniDraftState; +use crate::generate::generate_video::providers::higgsfield::cost::HiggsfieldVideoCostState; +use crate::generate::generate_video::providers::higgsfield::draft::HiggsfieldVideoDraftState; +use crate::generate::generate_video::video_generation_draft_context::VideoGenerationDraftContext; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +/** + * Wrapper for all video generation draft requests. + */ +#[derive(Clone, Debug)] +pub enum VideoGenerationDraftRequest { + KinoviHappyHorse1p0(KinoviHappyHorse1p0DraftState), + KinoviSeedance2p0(KinoviSeedance2p0DraftState), + KinoviSeedance2p0Fast(KinoviSeedance2p0FastDraftState), + KinoviSeedance2p0Mini(KinoviSeedance2p0MiniDraftState), + /// Any Higgsfield video model (the state says which). + HiggsfieldVideo(HiggsfieldVideoDraftState), +} + +impl VideoGenerationDraftRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::KinoviHappyHorse1p0(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedance2p0(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedance2p0Fast(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedance2p0Mini(_) => RouterProvider::Seedance2Pro, + Self::HiggsfieldVideo(_) => RouterProvider::Higgsfield, + } + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match self { + VideoGenerationDraftRequest::KinoviHappyHorse1p0(draft) => Ok(KinoviHappyHorse1p0CostState::from_draft(draft).estimate_cost()), + VideoGenerationDraftRequest::KinoviSeedance2p0(draft) => Ok(KinoviSeedance2p0CostState::from_draft(draft).estimate_cost()), + VideoGenerationDraftRequest::KinoviSeedance2p0Fast(draft) => Ok(KinoviSeedance2p0FastCostState::from_draft(draft).estimate_cost()), + VideoGenerationDraftRequest::KinoviSeedance2p0Mini(draft) => Ok(KinoviSeedance2p0MiniCostState::from_draft(draft).estimate_cost()), + VideoGenerationDraftRequest::HiggsfieldVideo(draft) => Ok(HiggsfieldVideoCostState::from_draft(draft).estimate_cost()), + } + } + + /// Finalize the draft request before generation + /// This may involve uploading media to the provider. + pub async fn finalize(self, draft_context: VideoGenerationDraftContext<'_>) -> Result { + match self { + VideoGenerationDraftRequest::KinoviHappyHorse1p0(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(VideoGenerationRequest::KinoviHappyHorse1p0(result)) + }, + VideoGenerationDraftRequest::KinoviSeedance2p0(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(VideoGenerationRequest::KinoviSeedance2p0(result)) + }, + VideoGenerationDraftRequest::KinoviSeedance2p0Fast(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(VideoGenerationRequest::KinoviSeedance2p0Fast(result)) + }, + VideoGenerationDraftRequest::KinoviSeedance2p0Mini(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(VideoGenerationRequest::KinoviSeedance2p0Mini(result)) + }, + VideoGenerationDraftRequest::HiggsfieldVideo(mut draft) => { + let result = draft.to_request(&draft_context).await?; + Ok(VideoGenerationRequest::HiggsfieldVideo(result)) + }, + } + } +} diff --git a/crates/router/src/generate/generate_video/video_generation_draft_context.rs b/crates/router/src/generate/generate_video/video_generation_draft_context.rs new file mode 100644 index 00000000..51de5556 --- /dev/null +++ b/crates/router/src/generate/generate_video/video_generation_draft_context.rs @@ -0,0 +1,69 @@ +use crate::api::asset_upload_cache::AssetUploadCache; +use crate::api::asset_upload_observer::AssetUploadObserver; +use crate::client::router_client::RouterClient; +use crate::client::router_higgsfield_client::RouterHiggsfieldClient; +use crate::client::router_seedance2pro_client::RouterSeedance2ProClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use std::collections::HashMap; +use std::fmt::Debug; +use artcraft_client::tokens::characters::CharacterToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +#[derive(Clone, Default)] +pub struct VideoGenerationDraftContext<'a> { + /// Optional: the router client, needed for providers that require authentication. + pub client: Option<&'a RouterClient>, + + /// Optional context: a map of Media File Tokens to their ArtCraft URLs + /// Only needed if we have to fetch these assets and upload them to another provider. + pub media_file_to_artcraft_url_map: Option<&'a HashMap>, + + /// Optional context: a map of Character Tokens to their respective Kinovi IDs + /// Only necessary if using Kinovi characters + pub character_token_to_kinovi_id_map: Option<&'a HashMap>, + + /// Optional: the account's upload history on the target provider, so + /// media it already holds isn't uploaded again. + pub asset_upload_cache: Option<&'a dyn AssetUploadCache>, + + /// Optional: told whether each reference was reused or uploaded, so the + /// caller can show the right notice. + pub asset_upload_observer: Option<&'a dyn AssetUploadObserver>, +} + +impl <'a> VideoGenerationDraftContext<'a> { + pub fn get_seedance2pro_client_ref(&self) -> Result<&RouterSeedance2ProClient, ArtcraftRouterError> { + let client = self.client.ok_or(ArtcraftRouterError::Client(ClientError::RouterClientNotProvided))?; + client.get_seedance2pro_client_ref() + .map_err(|err| ArtcraftRouterError::Client(err)) + } + + pub fn get_higgsfield_client_ref(&self) -> Result<&RouterHiggsfieldClient, ArtcraftRouterError> { + let client = self.client.ok_or(ArtcraftRouterError::Client(ClientError::RouterClientNotProvided))?; + client.get_higgsfield_client_ref() + .map_err(ArtcraftRouterError::Client) + } + + pub fn get_media_file_to_artcraft_url_map(&self) -> Result<&HashMap, ArtcraftRouterError> { + self.media_file_to_artcraft_url_map + .ok_or_else(|| ArtcraftRouterError::Client(ClientError::MediaFileToUrlMapNotProvided)) + } + + pub fn get_character_token_to_kinovi_map(&self) -> Result<&HashMap, ArtcraftRouterError> { + self.character_token_to_kinovi_id_map + .ok_or_else(|| ArtcraftRouterError::Client(ClientError::CharacterTokenToKinoviCharacterIdNotProvided)) + } +} + +impl Debug for VideoGenerationDraftContext<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("VideoGenerationDraftContext") + .field("client", &self.client.is_some()) + .field("media_file_to_artcraft_url_map", &self.media_file_to_artcraft_url_map) + .field("character_token_to_kinovi_id_map", &self.character_token_to_kinovi_id_map) + .field("asset_upload_cache", &self.asset_upload_cache.is_some()) + .field("asset_upload_observer", &self.asset_upload_observer.is_some()) + .finish() + } +} diff --git a/crates/router/src/generate/generate_video/video_generation_draft_or_request.rs b/crates/router/src/generate/generate_video/video_generation_draft_or_request.rs new file mode 100644 index 00000000..5906f5cc --- /dev/null +++ b/crates/router/src/generate/generate_video/video_generation_draft_or_request.rs @@ -0,0 +1,28 @@ +use crate::api::router_provider::RouterProvider; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::video_generation_draft::VideoGenerationDraftRequest; +use crate::generate::generate_video::video_generation_request::VideoGenerationRequest; + +#[derive(Debug, Clone)] +pub enum VideoGenerationDraftOrRequest { + Draft(VideoGenerationDraftRequest), + Request(VideoGenerationRequest), +} + +impl VideoGenerationDraftOrRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::Draft(draft) => draft.get_provider(), + Self::Request(request) => request.get_provider(), + } + } + + pub fn estimate_cost(&self) -> Result { + match self { + VideoGenerationDraftOrRequest::Draft(draft) => draft.estimate_cost(), + VideoGenerationDraftOrRequest::Request(request) => request.estimate_cost(), + } + } +} \ No newline at end of file diff --git a/crates/router/src/generate/generate_video/video_generation_request.rs b/crates/router/src/generate/generate_video/video_generation_request.rs new file mode 100644 index 00000000..65011575 --- /dev/null +++ b/crates/router/src/generate/generate_video/video_generation_request.rs @@ -0,0 +1,598 @@ +use crate::api::router_provider::RouterProvider; +use crate::client::router_client::RouterClient; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::generate::generate_video::generate_video_response::GenerateVideoResponse; +use crate::generate::generate_video::video_generation_cost_estimate::VideoGenerationCostEstimate; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video::cost::ArtcraftGrokImagineVideoCostState; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video::request::ArtcraftGrokImagineVideoRequestState; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video_1p5::cost::ArtcraftGrokImagineVideo1p5CostState; +use crate::generate::generate_video::providers::artcraft::grok_imagine_video_1p5::request::ArtcraftGrokImagineVideo1p5RequestState; +use crate::generate::generate_video::providers::artcraft::happy_horse_1p0::cost::ArtcraftHappyHorse1p0CostState; +use crate::generate::generate_video::providers::artcraft::happy_horse_1p0::request::ArtcraftHappyHorse1p0RequestState; +use crate::generate::generate_video::providers::artcraft::kling_1_6_pro::cost::ArtcraftKling16ProCostState; +use crate::generate::generate_video::providers::artcraft::kling_1_6_pro::request::ArtcraftKling16ProRequestState; +use crate::generate::generate_video::providers::artcraft::kling_2_1_master::cost::ArtcraftKling21MasterCostState; +use crate::generate::generate_video::providers::artcraft::kling_2_1_master::request::ArtcraftKling21MasterRequestState; +use crate::generate::generate_video::providers::artcraft::kling_2_1_pro::cost::ArtcraftKling21ProCostState; +use crate::generate::generate_video::providers::artcraft::kling_2_1_pro::request::ArtcraftKling21ProRequestState; +use crate::generate::generate_video::providers::artcraft::kling_2_5_turbo_pro::cost::ArtcraftKling2p5TurboProCostState; +use crate::generate::generate_video::providers::artcraft::kling_2_5_turbo_pro::request::ArtcraftKling2p5TurboProRequestState; +use crate::generate::generate_video::providers::artcraft::kling_2_6_pro::cost::ArtcraftKling2p6ProCostState; +use crate::generate::generate_video::providers::artcraft::kling_2_6_pro::request::ArtcraftKling2p6ProRequestState; +use crate::generate::generate_video::providers::artcraft::kling_3p0_pro::cost::ArtcraftKling3p0ProCostState; +use crate::generate::generate_video::providers::artcraft::kling_3p0_pro::request::ArtcraftKling3p0ProRequestState; +use crate::generate::generate_video::providers::artcraft::kling_3p0_standard::cost::ArtcraftKling3p0StandardCostState; +use crate::generate::generate_video::providers::artcraft::kling_3p0_standard::request::ArtcraftKling3p0StandardRequestState; +use crate::generate::generate_video::providers::artcraft::preview_model::cost::ArtcraftPreviewModelCostState; +use crate::generate::generate_video::providers::artcraft::preview_model::request::ArtcraftPreviewModelRequestState; +use crate::generate::generate_video::providers::artcraft::preview_model_fast::cost::ArtcraftPreviewModelFastCostState; +use crate::generate::generate_video::providers::artcraft::preview_model_fast::request::ArtcraftPreviewModelFastRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_1p0_lite::cost::ArtcraftSeedance10LiteCostState; +use crate::generate::generate_video::providers::artcraft::seedance_1p0_lite::request::ArtcraftSeedance10LiteRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_1p5_pro::cost::ArtcraftSeedance1p5ProCostState; +use crate::generate::generate_video::providers::artcraft::seedance_1p5_pro::request::ArtcraftSeedance1p5ProRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0::cost::ArtcraftSeedance2p0CostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0::request::ArtcraftSeedance2p0RequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_fast::cost::ArtcraftSeedance2p0FastCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_fast::request::ArtcraftSeedance2p0FastRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u::cost::ArtcraftSeedance2p0UltraCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u::request::ArtcraftSeedance2p0UltraRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u_fast::cost::ArtcraftSeedance2p0UltraFastCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_u_fast::request::ArtcraftSeedance2p0UltraFastRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp::cost::ArtcraftSeedance2p0BytePlusCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp::request::ArtcraftSeedance2p0BytePlusRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_fast::cost::ArtcraftSeedance2p0BytePlusFastCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_fast::request::ArtcraftSeedance2p0BytePlusFastRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu::cost::ArtcraftSeedance2p0BytePlusUltraCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu::request::ArtcraftSeedance2p0BytePlusUltraRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_fast::cost::ArtcraftSeedance2p0BytePlusUltraFastCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_fast::request::ArtcraftSeedance2p0BytePlusUltraFastRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_mini::cost::ArtcraftSeedance2p0MiniCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_mini::request::ArtcraftSeedance2p0MiniRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_mini::cost::ArtcraftSeedance2p0BytePlusMiniCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bp_mini::request::ArtcraftSeedance2p0BytePlusMiniRequestState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_mini::cost::ArtcraftSeedance2p0BytePlusUltraMiniCostState; +use crate::generate::generate_video::providers::artcraft::seedance_2p0_bpu_mini::request::ArtcraftSeedance2p0BytePlusUltraMiniRequestState; +use crate::generate::generate_video::providers::artcraft::sora_2::cost::ArtcraftSora2CostState; +use crate::generate::generate_video::providers::artcraft::sora_2::request::ArtcraftSora2RequestState; +use crate::generate::generate_video::providers::artcraft::sora_2_pro::cost::ArtcraftSora2ProCostState; +use crate::generate::generate_video::providers::artcraft::sora_2_pro::request::ArtcraftSora2ProRequestState; +use crate::generate::generate_video::providers::artcraft::veo_2::cost::ArtcraftVeo2CostState; +use crate::generate::generate_video::providers::artcraft::veo_2::request::ArtcraftVeo2RequestState; +use crate::generate::generate_video::providers::artcraft::veo_3::cost::ArtcraftVeo3CostState; +use crate::generate::generate_video::providers::artcraft::veo_3::request::ArtcraftVeo3RequestState; +use crate::generate::generate_video::providers::artcraft::veo_3_fast::cost::ArtcraftVeo3FastCostState; +use crate::generate::generate_video::providers::artcraft::veo_3_fast::request::ArtcraftVeo3FastRequestState; +use crate::generate::generate_video::providers::artcraft::veo_3p1::cost::ArtcraftVeo3p1CostState; +use crate::generate::generate_video::providers::artcraft::veo_3p1::request::ArtcraftVeo3p1RequestState; +use crate::generate::generate_video::providers::artcraft::veo_3p1_fast::cost::ArtcraftVeo3p1FastCostState; +use crate::generate::generate_video::providers::artcraft::veo_3p1_fast::request::ArtcraftVeo3p1FastRequestState; +use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::cost::ArtcraftVeo3p1LiteCostState; +use crate::generate::generate_video::providers::artcraft::veo_3p1_lite::request::ArtcraftVeo3p1LiteRequestState; +use crate::generate::generate_video::providers::artcraft::vidu_q3::cost::ArtcraftViduQ3CostState; +use crate::generate::generate_video::providers::artcraft::vidu_q3::request::ArtcraftViduQ3RequestState; +use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::cost::ArtcraftViduQ3TurboCostState; +use crate::generate::generate_video::providers::artcraft::vidu_q3_turbo::request::ArtcraftViduQ3TurboRequestState; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::cost::FalKling16ProCostState; +use crate::generate::generate_video::providers::fal::kling_1_6_pro::request::FalKling16ProRequestState; +use crate::generate::generate_video::providers::fal::kling_2_1_master::cost::FalKling21MasterCostState; +use crate::generate::generate_video::providers::fal::kling_2_1_master::request::FalKling21MasterRequestState; +use crate::generate::generate_video::providers::fal::kling_2_1_pro::cost::FalKling21ProCostState; +use crate::generate::generate_video::providers::fal::kling_2_1_pro::request::FalKling21ProRequestState; +use crate::generate::generate_video::providers::fal::kling_2_5_turbo_pro::cost::FalKling2p5TurboProCostState; +use crate::generate::generate_video::providers::fal::kling_2_5_turbo_pro::request::FalKling2p5TurboProRequestState; +use crate::generate::generate_video::providers::fal::kling_2_6_pro::cost::FalKling2p6ProCostState; +use crate::generate::generate_video::providers::fal::kling_2_6_pro::request::FalKling2p6ProRequestState; +use crate::generate::generate_video::providers::fal::kling_3p0_pro::cost::FalKling3p0ProCostState; +use crate::generate::generate_video::providers::fal::kling_3p0_pro::request::FalKling3p0ProRequestState; +use crate::generate::generate_video::providers::fal::kling_3p0_standard::cost::FalKling3p0StandardCostState; +use crate::generate::generate_video::providers::fal::kling_3p0_standard::request::FalKling3p0StandardRequestState; +use crate::generate::generate_video::providers::fal::seedance_1p0_lite::cost::FalSeedance10LiteCostState; +use crate::generate::generate_video::providers::fal::seedance_1p0_lite::request::FalSeedance10LiteRequestState; +use crate::generate::generate_video::providers::fal::sora_2::cost::FalSora2CostState; +use crate::generate::generate_video::providers::fal::sora_2::request::FalSora2RequestState; +use crate::generate::generate_video::providers::fal::sora_2_pro::cost::FalSora2ProCostState; +use crate::generate::generate_video::providers::fal::sora_2_pro::request::FalSora2ProRequestState; +use crate::generate::generate_video::providers::fal::seedance_1p5_pro::cost::FalSeedance1p5ProCostState; +use crate::generate::generate_video::providers::fal::seedance_1p5_pro::request::FalSeedance1p5ProRequestState; +use crate::generate::generate_video::providers::fal::veo_2::cost::FalVeo2CostState; +use crate::generate::generate_video::providers::fal::veo_2::request::FalVeo2RequestState; +use crate::generate::generate_video::providers::fal::veo_3::cost::FalVeo3CostState; +use crate::generate::generate_video::providers::fal::veo_3::request::FalVeo3RequestState; +use crate::generate::generate_video::providers::fal::veo_3_fast::cost::FalVeo3FastCostState; +use crate::generate::generate_video::providers::fal::veo_3_fast::request::FalVeo3FastRequestState; +use crate::generate::generate_video::providers::fal::veo_3p1::cost::FalVeo3p1CostState; +use crate::generate::generate_video::providers::fal::veo_3p1::request::FalVeo3p1RequestState; +use crate::generate::generate_video::providers::fal::veo_3p1_fast::cost::FalVeo3p1FastCostState; +use crate::generate::generate_video::providers::fal::veo_3p1_fast::request::FalVeo3p1FastRequestState; +use crate::generate::generate_video::providers::fal::veo_3p1_lite::cost::FalVeo3p1LiteCostState; +use crate::generate::generate_video::providers::fal::veo_3p1_lite::request::FalVeo3p1LiteRequestState; +use crate::generate::generate_video::providers::fal::vidu_q3::cost::FalViduQ3CostState; +use crate::generate::generate_video::providers::fal::vidu_q3::request::FalViduQ3RequestState; +use crate::generate::generate_video::providers::fal::vidu_q3_turbo::cost::FalViduQ3TurboCostState; +use crate::generate::generate_video::providers::fal::vidu_q3_turbo::request::FalViduQ3TurboRequestState; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_g::cost::GmiCloudSeedance2p0UltraCostState; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_g::request::GmiCloudSeedance2p0UltraRequestState; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_fast_g::cost::GmiCloudSeedance2p0UltraFastCostState; +use crate::generate::generate_video::providers::gmicloud::seedance_2p0_fast_g::request::GmiCloudSeedance2p0UltraFastRequestState; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video::cost::GrokApiGrokImagineVideoCostState; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video::request::GrokApiGrokImagineVideoRequestState; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::cost::GrokApiGrokImagineVideo1p5CostState; +use crate::generate::generate_video::providers::grok_api::grok_imagine_video_1p5::request::GrokApiGrokImagineVideo1p5RequestState; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::cost::KinoviHappyHorse1p0CostState; +use crate::generate::generate_video::providers::kinovi::happy_horse_1p0::request::KinoviHappyHorse1p0RequestState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::cost::KinoviSeedance2p0CostState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0::request::KinoviSeedance2p0RequestState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::cost::KinoviSeedance2p0FastCostState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_fast::request::KinoviSeedance2p0FastRequestState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::cost::KinoviSeedance2p0MiniCostState; +use crate::generate::generate_video::providers::kinovi::seedance_2p0_mini::request::KinoviSeedance2p0MiniRequestState; +use crate::generate::generate_video::providers::higgsfield::cost::HiggsfieldVideoCostState; +use crate::generate::generate_video::providers::higgsfield::request::HiggsfieldVideoRequestState; + +#[derive(Clone, Debug)] +pub enum VideoGenerationRequest { + ArtcraftGrokImagineVideo(ArtcraftGrokImagineVideoRequestState), + ArtcraftGrokImagineVideo1p5(ArtcraftGrokImagineVideo1p5RequestState), + ArtcraftHappyHorse1p0(ArtcraftHappyHorse1p0RequestState), + ArtcraftKling16Pro(ArtcraftKling16ProRequestState), + ArtcraftKling21Master(ArtcraftKling21MasterRequestState), + ArtcraftKling21Pro(ArtcraftKling21ProRequestState), + ArtcraftKling2p5TurboPro(ArtcraftKling2p5TurboProRequestState), + ArtcraftKling2p6Pro(ArtcraftKling2p6ProRequestState), + ArtcraftKling3p0Pro(ArtcraftKling3p0ProRequestState), + ArtcraftKling3p0Standard(ArtcraftKling3p0StandardRequestState), + ArtcraftPreviewModel(ArtcraftPreviewModelRequestState), + ArtcraftPreviewModelFast(ArtcraftPreviewModelFastRequestState), + ArtcraftSeedance10Lite(ArtcraftSeedance10LiteRequestState), + ArtcraftSeedance1p5Pro(ArtcraftSeedance1p5ProRequestState), + ArtcraftSeedance2p0(ArtcraftSeedance2p0RequestState), + ArtcraftSeedance2p0Fast(ArtcraftSeedance2p0FastRequestState), + ArtcraftSeedance2p0Ultra(ArtcraftSeedance2p0UltraRequestState), + ArtcraftSeedance2p0UltraFast(ArtcraftSeedance2p0UltraFastRequestState), + ArtcraftSeedance2p0BytePlus(ArtcraftSeedance2p0BytePlusRequestState), + ArtcraftSeedance2p0BytePlusFast(ArtcraftSeedance2p0BytePlusFastRequestState), + ArtcraftSeedance2p0BytePlusUltra(ArtcraftSeedance2p0BytePlusUltraRequestState), + ArtcraftSeedance2p0BytePlusUltraFast(ArtcraftSeedance2p0BytePlusUltraFastRequestState), + ArtcraftSeedance2p0Mini(ArtcraftSeedance2p0MiniRequestState), + ArtcraftSeedance2p0BytePlusMini(ArtcraftSeedance2p0BytePlusMiniRequestState), + ArtcraftSeedance2p0BytePlusUltraMini(ArtcraftSeedance2p0BytePlusUltraMiniRequestState), + ArtcraftSora2(ArtcraftSora2RequestState), + ArtcraftSora2Pro(ArtcraftSora2ProRequestState), + ArtcraftVeo2(ArtcraftVeo2RequestState), + ArtcraftVeo3(ArtcraftVeo3RequestState), + ArtcraftVeo3Fast(ArtcraftVeo3FastRequestState), + ArtcraftVeo3p1(ArtcraftVeo3p1RequestState), + ArtcraftVeo3p1Fast(ArtcraftVeo3p1FastRequestState), + ArtcraftVeo3p1Lite(ArtcraftVeo3p1LiteRequestState), + ArtcraftViduQ3(ArtcraftViduQ3RequestState), + ArtcraftViduQ3Turbo(ArtcraftViduQ3TurboRequestState), + FalKling16Pro(FalKling16ProRequestState), + FalKling21Master(FalKling21MasterRequestState), + FalKling21Pro(FalKling21ProRequestState), + FalKling2p5TurboPro(FalKling2p5TurboProRequestState), + FalKling2p6Pro(FalKling2p6ProRequestState), + FalKling3p0Pro(FalKling3p0ProRequestState), + FalKling3p0Standard(FalKling3p0StandardRequestState), + FalSeedance10Lite(FalSeedance10LiteRequestState), + FalSeedance1p5Pro(FalSeedance1p5ProRequestState), + FalSora2(FalSora2RequestState), + FalSora2Pro(FalSora2ProRequestState), + FalVeo2(FalVeo2RequestState), + FalVeo3(FalVeo3RequestState), + FalVeo3Fast(FalVeo3FastRequestState), + FalVeo3p1(FalVeo3p1RequestState), + FalVeo3p1Fast(FalVeo3p1FastRequestState), + FalVeo3p1Lite(FalVeo3p1LiteRequestState), + FalViduQ3(FalViduQ3RequestState), + FalViduQ3Turbo(FalViduQ3TurboRequestState), + GmiCloudSeedance2p0Ultra(GmiCloudSeedance2p0UltraRequestState), + GmiCloudSeedance2p0UltraFast(GmiCloudSeedance2p0UltraFastRequestState), + GrokApiGrokImagineVideo(GrokApiGrokImagineVideoRequestState), + GrokApiGrokImagineVideo1p5(GrokApiGrokImagineVideo1p5RequestState), + KinoviHappyHorse1p0(KinoviHappyHorse1p0RequestState), + KinoviSeedance2p0(KinoviSeedance2p0RequestState), + KinoviSeedance2p0Fast(KinoviSeedance2p0FastRequestState), + KinoviSeedance2p0Mini(KinoviSeedance2p0MiniRequestState), + /// First-party (cookie-session) Higgsfield, any of its models. + HiggsfieldVideo(HiggsfieldVideoRequestState), +} + +impl VideoGenerationRequest { + + pub fn get_provider(&self) -> RouterProvider { + match self { + Self::ArtcraftGrokImagineVideo(_) => RouterProvider::Artcraft, + Self::ArtcraftGrokImagineVideo1p5(_) => RouterProvider::Artcraft, + Self::ArtcraftHappyHorse1p0(_) => RouterProvider::Artcraft, + Self::ArtcraftKling16Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftKling21Master(_) => RouterProvider::Artcraft, + Self::ArtcraftKling21Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftKling2p5TurboPro(_) => RouterProvider::Artcraft, + Self::ArtcraftKling2p6Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftKling3p0Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftKling3p0Standard(_) => RouterProvider::Artcraft, + Self::ArtcraftPreviewModel(_) => RouterProvider::Artcraft, + Self::ArtcraftPreviewModelFast(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance10Lite(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance1p5Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0Fast(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0Ultra(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0UltraFast(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0BytePlus(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0BytePlusFast(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0BytePlusUltra(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0BytePlusUltraFast(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0Mini(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0BytePlusMini(_) => RouterProvider::Artcraft, + Self::ArtcraftSeedance2p0BytePlusUltraMini(_) => RouterProvider::Artcraft, + Self::ArtcraftSora2(_) => RouterProvider::Artcraft, + Self::ArtcraftSora2Pro(_) => RouterProvider::Artcraft, + Self::ArtcraftVeo2(_) => RouterProvider::Artcraft, + Self::ArtcraftVeo3(_) => RouterProvider::Artcraft, + Self::ArtcraftVeo3Fast(_) => RouterProvider::Artcraft, + Self::ArtcraftVeo3p1(_) => RouterProvider::Artcraft, + Self::ArtcraftVeo3p1Fast(_) => RouterProvider::Artcraft, + Self::ArtcraftVeo3p1Lite(_) => RouterProvider::Artcraft, + Self::ArtcraftViduQ3(_) => RouterProvider::Artcraft, + Self::ArtcraftViduQ3Turbo(_) => RouterProvider::Artcraft, + Self::FalKling16Pro(_) => RouterProvider::Fal, + Self::FalKling21Master(_) => RouterProvider::Fal, + Self::FalKling21Pro(_) => RouterProvider::Fal, + Self::FalKling2p5TurboPro(_) => RouterProvider::Fal, + Self::FalKling2p6Pro(_) => RouterProvider::Fal, + Self::FalKling3p0Pro(_) => RouterProvider::Fal, + Self::FalKling3p0Standard(_) => RouterProvider::Fal, + Self::FalSeedance10Lite(_) => RouterProvider::Fal, + Self::FalSeedance1p5Pro(_) => RouterProvider::Fal, + Self::FalSora2(_) => RouterProvider::Fal, + Self::FalSora2Pro(_) => RouterProvider::Fal, + Self::FalVeo2(_) => RouterProvider::Fal, + Self::FalVeo3(_) => RouterProvider::Fal, + Self::FalVeo3Fast(_) => RouterProvider::Fal, + Self::FalVeo3p1(_) => RouterProvider::Fal, + Self::FalVeo3p1Fast(_) => RouterProvider::Fal, + Self::FalVeo3p1Lite(_) => RouterProvider::Fal, + Self::FalViduQ3(_) => RouterProvider::Fal, + Self::FalViduQ3Turbo(_) => RouterProvider::Fal, + Self::GmiCloudSeedance2p0Ultra(_) => RouterProvider::GmiCloud, + Self::GmiCloudSeedance2p0UltraFast(_) => RouterProvider::GmiCloud, + Self::GrokApiGrokImagineVideo(_) => RouterProvider::GrokApi, + Self::GrokApiGrokImagineVideo1p5(_) => RouterProvider::GrokApi, + Self::KinoviHappyHorse1p0(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedance2p0(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedance2p0Fast(_) => RouterProvider::Seedance2Pro, + Self::KinoviSeedance2p0Mini(_) => RouterProvider::Seedance2Pro, + Self::HiggsfieldVideo(_) => RouterProvider::Higgsfield, + } + } + + /// Return a cost estimate to fulfill the request. + pub fn estimate_cost(&self) -> Result { + match self { + VideoGenerationRequest::ArtcraftGrokImagineVideo(request) => Ok(ArtcraftGrokImagineVideoCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftGrokImagineVideo1p5(request) => ArtcraftGrokImagineVideo1p5CostState::from_request(request).estimate_cost(), + VideoGenerationRequest::ArtcraftHappyHorse1p0(request) => Ok(ArtcraftHappyHorse1p0CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling16Pro(request) => Ok(ArtcraftKling16ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling21Master(request) => Ok(ArtcraftKling21MasterCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling21Pro(request) => Ok(ArtcraftKling21ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling2p5TurboPro(request) => Ok(ArtcraftKling2p5TurboProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling2p6Pro(request) => Ok(ArtcraftKling2p6ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling3p0Pro(request) => Ok(ArtcraftKling3p0ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftKling3p0Standard(request) => Ok(ArtcraftKling3p0StandardCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftPreviewModel(request) => Ok(ArtcraftPreviewModelCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftPreviewModelFast(request) => Ok(ArtcraftPreviewModelFastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance10Lite(request) => Ok(ArtcraftSeedance10LiteCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance1p5Pro(request) => Ok(ArtcraftSeedance1p5ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0(request) => Ok(ArtcraftSeedance2p0CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0Fast(request) => Ok(ArtcraftSeedance2p0FastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0Ultra(request) => Ok(ArtcraftSeedance2p0UltraCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0UltraFast(request) => Ok(ArtcraftSeedance2p0UltraFastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0BytePlus(request) => Ok(ArtcraftSeedance2p0BytePlusCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusFast(request) => Ok(ArtcraftSeedance2p0BytePlusFastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltra(request) => Ok(ArtcraftSeedance2p0BytePlusUltraCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraFast(request) => Ok(ArtcraftSeedance2p0BytePlusUltraFastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0Mini(request) => Ok(ArtcraftSeedance2p0MiniCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusMini(request) => Ok(ArtcraftSeedance2p0BytePlusMiniCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraMini(request) => Ok(ArtcraftSeedance2p0BytePlusUltraMiniCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSora2(request) => Ok(ArtcraftSora2CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftSora2Pro(request) => Ok(ArtcraftSora2ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftVeo2(request) => Ok(ArtcraftVeo2CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftVeo3(request) => Ok(ArtcraftVeo3CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftVeo3Fast(request) => Ok(ArtcraftVeo3FastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftVeo3p1(request) => Ok(ArtcraftVeo3p1CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftVeo3p1Fast(request) => Ok(ArtcraftVeo3p1FastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftVeo3p1Lite(request) => Ok(ArtcraftVeo3p1LiteCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftViduQ3(request) => Ok(ArtcraftViduQ3CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::ArtcraftViduQ3Turbo(request) => Ok(ArtcraftViduQ3TurboCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling16Pro(request) => Ok(FalKling16ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling21Master(request) => Ok(FalKling21MasterCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling21Pro(request) => Ok(FalKling21ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling2p5TurboPro(request) => Ok(FalKling2p5TurboProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling2p6Pro(request) => Ok(FalKling2p6ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling3p0Pro(request) => Ok(FalKling3p0ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalKling3p0Standard(request) => Ok(FalKling3p0StandardCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalSeedance10Lite(request) => Ok(FalSeedance10LiteCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalSeedance1p5Pro(request) => Ok(FalSeedance1p5ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalSora2(request) => Ok(FalSora2CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalSora2Pro(request) => Ok(FalSora2ProCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalVeo2(request) => Ok(FalVeo2CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalVeo3(request) => Ok(FalVeo3CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalVeo3Fast(request) => Ok(FalVeo3FastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalVeo3p1(request) => Ok(FalVeo3p1CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalVeo3p1Fast(request) => Ok(FalVeo3p1FastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalVeo3p1Lite(request) => Ok(FalVeo3p1LiteCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalViduQ3(request) => Ok(FalViduQ3CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::FalViduQ3Turbo(request) => Ok(FalViduQ3TurboCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::GmiCloudSeedance2p0Ultra(request) => Ok(GmiCloudSeedance2p0UltraCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::GmiCloudSeedance2p0UltraFast(request) => Ok(GmiCloudSeedance2p0UltraFastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::GrokApiGrokImagineVideo(request) => Ok(GrokApiGrokImagineVideoCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::GrokApiGrokImagineVideo1p5(request) => GrokApiGrokImagineVideo1p5CostState::from_request(request).estimate_cost(), + VideoGenerationRequest::KinoviHappyHorse1p0(request) => Ok(KinoviHappyHorse1p0CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::KinoviSeedance2p0(request) => Ok(KinoviSeedance2p0CostState::from_request(request).estimate_cost()), + VideoGenerationRequest::KinoviSeedance2p0Fast(request) => Ok(KinoviSeedance2p0FastCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::KinoviSeedance2p0Mini(request) => Ok(KinoviSeedance2p0MiniCostState::from_request(request).estimate_cost()), + VideoGenerationRequest::HiggsfieldVideo(request) => Ok(HiggsfieldVideoCostState::from_request(request).estimate_cost()), + } + } + + /// Send the video generation request + /// If successful, returns the job IDs. + pub async fn send_request(&self, client: &RouterClient) -> Result { + match self { + VideoGenerationRequest::ArtcraftGrokImagineVideo(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftGrokImagineVideo1p5(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftHappyHorse1p0(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling16Pro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling21Master(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling21Pro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling2p5TurboPro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling2p6Pro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling3p0Pro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftKling3p0Standard(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftPreviewModel(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftPreviewModelFast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance10Lite(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance1p5Pro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0Fast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0Ultra(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0UltraFast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0BytePlus(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusFast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltra(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraFast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0Mini(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusMini(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSeedance2p0BytePlusUltraMini(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSora2(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftSora2Pro(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftVeo2(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftVeo3(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftVeo3Fast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftVeo3p1(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftVeo3p1Fast(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftVeo3p1Lite(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftViduQ3(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::ArtcraftViduQ3Turbo(request) => { + let client_ref = client.get_artcraft_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling16Pro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling21Master(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling21Pro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling2p5TurboPro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling2p6Pro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling3p0Pro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalKling3p0Standard(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalSeedance10Lite(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalSeedance1p5Pro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalSora2(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalSora2Pro(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalVeo2(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalVeo3(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalVeo3Fast(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalVeo3p1(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalVeo3p1Fast(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalVeo3p1Lite(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalViduQ3(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::FalViduQ3Turbo(request) => { + let client_ref = client.get_fal_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::GmiCloudSeedance2p0Ultra(request) => { + let client_ref = client.get_gmicloud_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::GmiCloudSeedance2p0UltraFast(request) => { + let client_ref = client.get_gmicloud_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::GrokApiGrokImagineVideo(request) => { + let client_ref = client.get_grok_api_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::GrokApiGrokImagineVideo1p5(request) => { + let client_ref = client.get_grok_api_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::KinoviHappyHorse1p0(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::KinoviSeedance2p0(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::KinoviSeedance2p0Fast(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::KinoviSeedance2p0Mini(request) => { + let client_ref = client.get_seedance2pro_client_ref()?; + request.send(client_ref).await + }, + VideoGenerationRequest::HiggsfieldVideo(request) => { + let client_ref = client.get_higgsfield_client_ref()?; + request.send(client_ref).await + }, + } + } +} diff --git a/crates/router/src/generate/mod.rs b/crates/router/src/generate/mod.rs new file mode 100644 index 00000000..e6b63cc2 --- /dev/null +++ b/crates/router/src/generate/mod.rs @@ -0,0 +1,5 @@ +pub mod generate_audio; +pub mod generate_image; +pub mod generate_mesh; +pub mod generate_splat; +pub mod generate_video; diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs new file mode 100644 index 00000000..b7ace7c4 --- /dev/null +++ b/crates/router/src/lib.rs @@ -0,0 +1,8 @@ +pub mod api; +pub mod client; +pub mod errors; +pub mod generate; +pub mod utils; + +#[cfg(test)] +pub mod test_helpers; diff --git a/crates/router/src/test_helpers.rs b/crates/router/src/test_helpers.rs new file mode 100644 index 00000000..0ddfa1a4 --- /dev/null +++ b/crates/router/src/test_helpers.rs @@ -0,0 +1,361 @@ +use crate::api::router_image_model::RouterImageModel; +use crate::api::router_video_model::RouterVideoModel; +use crate::api::router_provider::RouterProvider; +use crate::client::request_mismatch_mitigation_strategy::RequestMismatchMitigationStrategy; +use crate::client::router_artcraft_client::RouterArtcraftClient; +use crate::client::router_client::RouterClient; +use crate::client::router_fal_client::RouterFalClient; +use crate::generate::generate_image::generate_image_request_builder::GenerateImageRequestBuilder; +use crate::generate::generate_video::generate_video_request_builder::GenerateVideoRequestBuilder; +use artcraft_client::credentials::storyteller_credential_set::StorytellerCredentialSet; +use artcraft_client::utils::api_host::ApiHost; +use fal_client::creds::fal_api_key::FalApiKey; + +pub fn get_artcraft_client_for_env(host: ApiHost) -> RouterClient { + let cookies = std::fs::read_to_string("/Users/bt/Artcraft/credentials/artcraft_cookies.txt") + .expect("Failed to read /Users/bt/Artcraft/credentials/artcraft_cookies.txt"); + let cookies = cookies.trim().to_string(); + let credentials = StorytellerCredentialSet::parse_multi_cookie_header(&cookies) + .expect("Failed to parse cookies") + .expect("No credentials found"); + RouterClient::Artcraft(RouterArtcraftClient::new(host, credentials)) +} + +pub fn get_artcraft_client() -> RouterClient { + get_artcraft_client_for_env(ApiHost::Storyteller) +} + +pub fn base_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBananaPro, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn get_fal_client() -> RouterClient { + let secret = std::fs::read_to_string("/Users/bt/Artcraft/credentials/fal_api_key.txt") + .expect("Failed to read /Users/bt/Artcraft/credentials/fal_api_key.txt"); + let api_key = FalApiKey::from_str(secret.trim()); + let webhook_url = "https://example.com/fal-webhook-test".to_string(); + RouterClient::Fal(RouterFalClient::new_with_webhook(api_key, webhook_url)) +} + +pub fn base_fal_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBananaPro, + provider: RouterProvider::Fal, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_seedream_4_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream4, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_seedream_4p5_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream4p5, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_seedream_5_lite_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Seedream5Lite, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_nano_banana_2_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBanana2, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_nano_banana_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::NanoBanana, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_gpt_image_1_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage1, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_gpt_image_2_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage2, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_gpt_image_1p5_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::GptImage1p5, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_flux_1_dev_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Flux1Dev, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_flux_1_schnell_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Flux1Schnell, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_flux_pro_1p1_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::FluxPro11, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_qwen_edit_2511_angles_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::QwenEdit2511Angles, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_flux_2_lora_angles_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::Flux2LoraAngles, + provider: RouterProvider::Artcraft, + prompt: None, + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_flux_pro_1p1_ultra_image_request() -> GenerateImageRequestBuilder { + GenerateImageRequestBuilder { + model: RouterImageModel::FluxPro11Ultra, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + image_inputs: None, + resolution: None, + aspect_ratio: None, + quality: None, + image_batch_count: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + generation_mode_mismatch_strategy: None, + idempotency_token: None, + horizontal_angle: None, + vertical_angle: None, + zoom: None, + } +} + +pub fn base_video_request() -> GenerateVideoRequestBuilder { + GenerateVideoRequestBuilder { + model: RouterVideoModel::Seedance2p0, + provider: RouterProvider::Artcraft, + prompt: Some("a cat in space".to_string()), + negative_prompt: None, + start_frame: None, + end_frame: None, + reference_images: None, + reference_videos: None, + reference_audio: None, + reference_character_tokens: None, + resolution: None, + aspect_ratio: None, + bitrate: None, + duration_seconds: None, + video_batch_count: None, + generate_audio: None, + request_mismatch_mitigation_strategy: RequestMismatchMitigationStrategy::ErrorOut, + idempotency_token: None, + } +} diff --git a/crates/router/src/utils/download_file.rs b/crates/router/src/utils/download_file.rs new file mode 100644 index 00000000..e71b3958 --- /dev/null +++ b/crates/router/src/utils/download_file.rs @@ -0,0 +1,30 @@ +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::download_error::DownloadError; + +/// Download a file from a URL, returning its bytes. +pub async fn download_file(url: &str) -> Result, ArtcraftRouterError> { + let response = reqwest::get(url) + .await + .map_err(|err| DownloadError::ReqwestDownload { + url: url.to_string(), + maybe_status: err.status(), + error: err, + })?; + + let status = response.status(); + if !status.is_success() { + return Err(DownloadError::BadStatus { + url: url.to_string(), + status_code: status.as_u16(), + }.into()); + } + + response.bytes() + .await + .map(|b| b.to_vec()) + .map_err(|err| DownloadError::ReqwestDownload { + url: url.to_string(), + maybe_status: err.status(), + error: err, + }.into()) +} diff --git a/crates/router/src/utils/higgsfield_media.rs b/crates/router/src/utils/higgsfield_media.rs new file mode 100644 index 00000000..304d3962 --- /dev/null +++ b/crates/router/src/utils/higgsfield_media.rs @@ -0,0 +1,630 @@ +//! Reference media for first-party Higgsfield: each source — an ArtCraft +//! media token, a public URL, a local file, or in-memory bytes — is turned +//! into bytes and uploaded through the session, and the resulting +//! [`MediaInput`] is what generation requests reference. Shared by the image +//! and video Higgsfield providers. +//! +//! Only ArtCraft media tokens touch the ArtCraft cloud (they resolve through +//! the token→URL map); local files and bytes go straight to Higgsfield. +//! +//! With an [`AssetUploadCache`] in hand, bytes the account already uploaded +//! are reused by id instead: the cached id is checked against Higgsfield's +//! media status endpoint first, and any doubt means a fresh upload. + +use std::collections::HashMap; + +use file_hashing::hash_bytes_blake3; +use higgsfield_client::endpoints::media::get_media_status::MediaStatusFamily; +use higgsfield_client::session::higgsfield_session::HiggsfieldSession; +use higgsfield_client::session::upload_media::ReferenceMediaFile; +use higgsfield_client::session::upload_source_guard::check_upload_source_url; +use higgsfield_client::types::ids::{JobId, MediaId}; +use higgsfield_client::types::media_input::MediaInput; +use higgsfield_client::types::media_mime_type::MediaMimeType; +use log::{info, warn}; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +use crate::api::asset_upload_observer::AssetUploadObserver; +use crate::api::asset_upload_cache::{AssetUploadCache, AssetUploadOrigin, CachedAssetUpload}; +use crate::api::audio_list_ref::AudioListRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::video_list_ref::VideoListRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::provider_error::ProviderError; +use crate::utils::media_source_ref::{ + extension_from_name_hint, resolve_media_source_bytes, MediaSourceRef, ResolvedMediaBytes, +}; + +pub use crate::utils::media_source_ref::{resolve_media_token, resolve_media_tokens}; + +/// What a reference file is expected to be. Picks the upload endpoint family +/// and the fallback MIME type when the bytes and name don't say. +#[derive(Copy, Clone, Debug, PartialEq, Eq)] +pub enum HiggsfieldMediaKind { + Image, + Video, + Audio, +} + +impl HiggsfieldMediaKind { + /// Lower-case name for notices ("image" / "video" / "audio"). + pub fn label(self) -> &'static str { + match self { + Self::Image => "image", + Self::Video => "video", + Self::Audio => "audio", + } + } + + /// The status endpoint family for verifying a previous upload. Audio has + /// none, so cached audio ids are trusted as-is. + fn status_family(self) -> Option { + match self { + Self::Image => Some(MediaStatusFamily::Image), + Self::Video => Some(MediaStatusFamily::Video), + Self::Audio => None, + } + } + + fn media_input(self, id: MediaId, url: String) -> MediaInput { + match self { + Self::Image => MediaInput::uploaded(id, url), + Self::Video => MediaInput::uploaded_video(id, url), + Self::Audio => MediaInput::uploaded_audio(id, url), + } + } + + /// A previous Higgsfield generation used as this kind of reference. Audio + /// is never generated, so it has no job form. + fn job_input(self, job_id: MediaId, url: String) -> Option { + match self { + Self::Image => Some(MediaInput::from_image_job(job_id, url)), + Self::Video => Some(MediaInput::from_video_job(job_id, url)), + Self::Audio => None, + } + } + + fn fallback_mime_type(self) -> MediaMimeType { + match self { + Self::Image => MediaMimeType::ImageJpeg, + Self::Video => MediaMimeType::VideoMp4, + Self::Audio => MediaMimeType::AudioMpeg, + } + } + + fn accepts(self, mime_type: &MediaMimeType) -> bool { + match self { + Self::Image => mime_type.is_image(), + Self::Video => mime_type.is_video(), + Self::Audio => mime_type.is_audio(), + } + } +} + +/// A list of reference sources, in upload order. +#[derive(Clone, Debug)] +pub struct HiggsfieldMediaSources(pub Vec); + +impl From for HiggsfieldMediaSources { + fn from(list: ImageListRef) -> Self { + Self(MediaSourceRef::list_from_images(list)) + } +} + +impl From for HiggsfieldMediaSources { + fn from(list: VideoListRef) -> Self { + Self(MediaSourceRef::list_from_videos(list)) + } +} + +impl From for HiggsfieldMediaSources { + fn from(list: AudioListRef) -> Self { + Self(MediaSourceRef::list_from_audios(list)) + } +} + +impl HiggsfieldMediaSources { + pub fn len(&self) -> usize { + self.0.len() + } + + pub fn is_empty(&self) -> bool { + self.0.is_empty() + } +} + +/// Everything an upload needs besides the source itself. +#[derive(Clone, Copy)] +pub struct HiggsfieldUploadContext<'a> { + pub session: &'a HiggsfieldSession, + /// Media file tokens resolve to ArtCraft CDN URLs through this. + pub maybe_map: Option<&'a HashMap>, + /// The account's prior uploads; `None` uploads unconditionally. + pub maybe_cache: Option<&'a dyn AssetUploadCache>, + /// Told whether each source was reused or uploaded. + pub maybe_observer: Option<&'a dyn AssetUploadObserver>, +} + +/// Upload every source in `list`, in order. `None` / empty lists upload +/// nothing. +pub async fn upload_media_list( + context: HiggsfieldUploadContext<'_>, + list: Option, + kind: HiggsfieldMediaKind, + ip_check: bool, +) -> Result, ArtcraftRouterError> { + let sources = match list { + None => return Ok(Vec::new()), + Some(sources) => sources.0, + }; + let mut uploaded = Vec::with_capacity(sources.len()); + for source in sources { + uploaded.push(upload_source_to_higgsfield(context, source, kind, ip_check).await?); + } + Ok(uploaded) +} + +/// Upload a single image reference (a keyframe), if present. +pub async fn upload_image_ref( + context: HiggsfieldUploadContext<'_>, + image_ref: Option, + ip_check: bool, +) -> Result, ArtcraftRouterError> { + match image_ref { + None => Ok(None), + Some(image_ref) => { + Ok(Some(upload_source_to_higgsfield(context, image_ref.into(), HiggsfieldMediaKind::Image, ip_check).await?)) + } + } +} + +/// Turn one source into bytes and get a Higgsfield reference for it: the +/// account's previous upload of the same bytes when the cache knows one and +/// Higgsfield confirms it, otherwise a fresh upload (recorded for next +/// time). `ip_check` asks Higgsfield to run (and waits for) its +/// intellectual-property check, which the Seedance video models require on +/// images and clips; a cached upload that never had it is uploaded again. +/// +/// The first-party-domain guard applies only to caller-supplied `Url` +/// sources: a token that resolves to our own CDN is a deliberate library +/// pick, and local paths / bytes never had a URL at all. +pub async fn upload_source_to_higgsfield( + context: HiggsfieldUploadContext<'_>, + source: MediaSourceRef, + kind: HiggsfieldMediaKind, + ip_check: bool, +) -> Result { + if let MediaSourceRef::Url(url) = &source { + check_upload_source_url(url) + .map_err(|err| ArtcraftRouterError::from(ProviderError::Higgsfield(err.into())))?; + } + let resolved = resolve_media_source_bytes(source, context.maybe_map).await?; + + let file_hash = hash_bytes_blake3(&resolved.bytes); + if let Some(cache) = context.maybe_cache { + if let Some(reusable) = reusable_upload(context.session, cache, &file_hash, kind, ip_check).await { + info!("Reusing Higgsfield {:?} reference {} for {} (already uploaded by this account)", kind, reusable.id, resolved.description); + cache.note_reused(&file_hash).await; + if let Some(observer) = context.maybe_observer { + observer.on_reused(kind.label(), &resolved.description); + } + return Ok(reusable); + } + } + + let byte_count = resolved.bytes.len() as u64; + let file = reference_media_file(resolved, kind, ip_check); + info!( + "Uploading {:?} reference to Higgsfield ({} bytes, {}, ip_check={})", + kind, file.bytes.len(), file.mime_type, ip_check, + ); + if let Some(observer) = context.maybe_observer { + observer.on_uploading(kind.label(), byte_count, ip_check); + } + let uploaded = session_upload(context.session, file).await?; + + if let Some(cache) = context.maybe_cache { + cache.record_upload(&file_hash, byte_count, &CachedAssetUpload::uploaded( + uploaded.id.as_str(), + Some(uploaded.url.clone()), + )).await; + } + Ok(uploaded) +} + +async fn session_upload(session: &HiggsfieldSession, file: ReferenceMediaFile) -> Result { + session.upload_reference_media(file).await + .map_err(|err| ArtcraftRouterError::from(ProviderError::Higgsfield(err))) +} + +/// The cached upload for `file_hash`, if Higgsfield still honours it. Any +/// problem — no cached URL, a failed status read, a missing or flagged +/// upload, or a required IP check that never ran — forgets the entry and +/// answers `None` so the caller uploads afresh. +async fn reusable_upload( + session: &HiggsfieldSession, + cache: &dyn AssetUploadCache, + file_hash: &str, + kind: HiggsfieldMediaKind, + ip_check: bool, +) -> Option { + let cached = cache.find_upload(file_hash).await?; + let media_id = MediaId::new(cached.service_id.clone()); + + if cached.origin == AssetUploadOrigin::GenerationResult { + return reusable_generation_result(session, cache, file_hash, kind, media_id).await; + } + + let Some(url) = cached.maybe_service_url.clone() else { + warn!("Cached Higgsfield upload {} has no URL; uploading again", media_id); + cache.forget_upload(file_hash).await; + return None; + }; + + if let Some(family) = kind.status_family() { + match session.get_media_status(family, &media_id).await { + Ok(status) if status.is_ip_detected() => { + warn!("Cached Higgsfield upload {} is flagged as protected content; uploading again", media_id); + cache.forget_upload(file_hash).await; + return None; + } + Ok(status) if ip_check && !status.is_ip_check_finished() => { + info!("Cached Higgsfield upload {} never had its IP check; uploading again with one", media_id); + cache.forget_upload(file_hash).await; + return None; + } + Ok(_) => {} + Err(err) => { + warn!("Could not confirm cached Higgsfield upload {} ({}); uploading again", media_id, err); + cache.forget_upload(file_hash).await; + return None; + } + } + } + + Some(kind.media_input(media_id, url)) +} + +/// A file Higgsfield generated itself (we downloaded the result) is used as a +/// "previous generation" reference by job id — no upload, and no IP check, +/// since it never left Higgsfield. The job is confirmed to still exist with +/// a result, and the fresh result URL is used (CDN URLs are time-limited). +async fn reusable_generation_result( + session: &HiggsfieldSession, + cache: &dyn AssetUploadCache, + file_hash: &str, + kind: HiggsfieldMediaKind, + job_id: MediaId, +) -> Option { + let job = match session.job_status(&JobId::new(job_id.as_str())).await { + Ok(job) => job, + Err(err) => { + warn!("Could not confirm Higgsfield generation {} still exists ({}); uploading instead", job_id, err); + cache.forget_upload(file_hash).await; + return None; + } + }; + let Some(url) = job.result_url() else { + warn!("Higgsfield generation {} no longer has a result; uploading instead", job_id); + cache.forget_upload(file_hash).await; + return None; + }; + let Some(input) = kind.job_input(job_id.clone(), url.to_string()) else { + info!("Higgsfield generation {} can't stand in for a {:?} reference; uploading instead", job_id, kind); + return None; + }; + Some(input) +} + +/// Describe resolved bytes for upload: the MIME type is sniffed from the +/// bytes, then guessed from the name hint (URL, path, or file name), then +/// defaulted by `kind`. The resolved source URL (caller-supplied URLs only) +/// engages the client's first-party-domain guard. +pub fn reference_media_file(resolved: ResolvedMediaBytes, kind: HiggsfieldMediaKind, ip_check: bool) -> ReferenceMediaFile { + let ResolvedMediaBytes { bytes, maybe_name_hint, maybe_source_url, description } = resolved; + let mime_type = media_mime_type_for(maybe_name_hint.as_deref(), &bytes, kind); + info!("Higgsfield reference resolved from {} as {}", description, mime_type); + let file_name = format!("reference.{}", mime_type.file_extension()); + let mut file = ReferenceMediaFile::new(file_name, mime_type, bytes); + if let Some(source_url) = maybe_source_url { + file = file.with_source_url(source_url); + } + if ip_check { file.with_ip_check() } else { file } +} + +/// The best MIME type for a reference: magic bytes first (the name may have +/// no extension, or lie), then the name hint's extension, then the kind's +/// default. A type from the wrong family for `kind` is ignored. +pub fn media_mime_type_for(maybe_name_hint: Option<&str>, bytes: &[u8], kind: HiggsfieldMediaKind) -> MediaMimeType { + sniff_mime_type(bytes) + .or_else(|| maybe_name_hint.and_then(mime_type_from_name_hint)) + .filter(|mime_type| kind.accepts(mime_type)) + .unwrap_or_else(|| kind.fallback_mime_type()) +} + +/// Extension-based MIME guess for a URL, filesystem path, or bare file name. +fn mime_type_from_name_hint(name_hint: &str) -> Option { + let extension = extension_from_name_hint(name_hint)?; + MediaMimeType::from_file_name(&format!("file.{extension}")) +} + +/// Recognise the common image / video / audio containers by their magic +/// bytes. Returns `None` for anything else. +pub fn sniff_mime_type(bytes: &[u8]) -> Option { + if bytes.starts_with(b"\x89PNG\r\n\x1a\n") { + return Some(MediaMimeType::ImagePng); + } + if bytes.starts_with(&[0xFF, 0xD8, 0xFF]) { + return Some(MediaMimeType::ImageJpeg); + } + if bytes.starts_with(b"GIF87a") || bytes.starts_with(b"GIF89a") { + return Some(MediaMimeType::ImageGif); + } + if bytes.len() >= 12 && bytes.starts_with(b"RIFF") { + return match &bytes[8..12] { + b"WEBP" => Some(MediaMimeType::ImageWebp), + b"WAVE" => Some(MediaMimeType::AudioWav), + _ => None, + }; + } + if bytes.len() >= 12 && &bytes[4..8] == b"ftyp" { + // ISO base media: MP4 / MOV / M4A / HEIC share the box; brand tells. + return match &bytes[8..12] { + b"qt " => Some(MediaMimeType::VideoQuicktime), + b"M4A " => Some(MediaMimeType::AudioMp4), + b"heic" | b"heix" | b"mif1" => Some(MediaMimeType::ImageHeic), + b"avif" => Some(MediaMimeType::ImageAvif), + _ => Some(MediaMimeType::VideoMp4), + }; + } + if bytes.starts_with(&[0x1A, 0x45, 0xDF, 0xA3]) { + // Matroska / WebM. Assume the web flavour; it's what browsers produce. + return Some(MediaMimeType::VideoWebm); + } + if bytes.starts_with(b"ID3") || (bytes.len() >= 2 && bytes[0] == 0xFF && (bytes[1] & 0xE0) == 0xE0) { + return Some(MediaMimeType::AudioMpeg); + } + if bytes.starts_with(b"OggS") { + return Some(MediaMimeType::AudioOgg); + } + None +} + +#[cfg(test)] +mod tests { + use std::path::PathBuf; + + use crate::api::media_bytes::MediaBytes; + use crate::errors::client_error::ClientError; + + use super::*; + + const PNG: &[u8] = b"\x89PNG\r\n\x1a\n\0\0\0\rIHDR"; + const JPEG: &[u8] = &[0xFF, 0xD8, 0xFF, 0xE0, 0x00, 0x10, b'J', b'F', b'I', b'F']; + const MP4: &[u8] = b"\0\0\0\x18ftypisom\0\0\x02\0isomiso2"; + const MOV: &[u8] = b"\0\0\0\x14ftypqt \0\0\0\0qt "; + const WAV: &[u8] = b"RIFF\x24\0\0\0WAVEfmt "; + const WEBP: &[u8] = b"RIFF\x24\0\0\0WEBPVP8 "; + const MP3_ID3: &[u8] = b"ID3\x04\0\0\0\0\0\0"; + + mod sniffing { + use super::*; + + #[test] + fn recognises_common_containers() { + assert_eq!(sniff_mime_type(PNG), Some(MediaMimeType::ImagePng)); + assert_eq!(sniff_mime_type(JPEG), Some(MediaMimeType::ImageJpeg)); + assert_eq!(sniff_mime_type(WEBP), Some(MediaMimeType::ImageWebp)); + assert_eq!(sniff_mime_type(MP4), Some(MediaMimeType::VideoMp4)); + assert_eq!(sniff_mime_type(MOV), Some(MediaMimeType::VideoQuicktime)); + assert_eq!(sniff_mime_type(WAV), Some(MediaMimeType::AudioWav)); + assert_eq!(sniff_mime_type(MP3_ID3), Some(MediaMimeType::AudioMpeg)); + assert_eq!(sniff_mime_type(&[0x1A, 0x45, 0xDF, 0xA3, 0x01]), Some(MediaMimeType::VideoWebm)); + } + + #[test] + fn unknown_bytes_are_none() { + assert_eq!(sniff_mime_type(b"hello world"), None); + assert_eq!(sniff_mime_type(b""), None); + assert_eq!(sniff_mime_type(b"RIFF\0\0\0\0AVI "), None); + } + } + + mod mime_resolution { + use super::*; + + #[test] + fn bytes_win_over_extension() { + // A PNG served from a ".jpg" URL is still a PNG. + assert_eq!(media_mime_type_for(Some("https://cdn.example.com/a.jpg"), PNG, HiggsfieldMediaKind::Image), MediaMimeType::ImagePng); + } + + #[test] + fn extension_is_used_when_bytes_are_unrecognised() { + assert_eq!(media_mime_type_for(Some("https://cdn.example.com/a.webp?x=1"), b"????", HiggsfieldMediaKind::Image), MediaMimeType::ImageWebp); + assert_eq!(media_mime_type_for(Some("https://cdn.example.com/clip.mov"), b"????", HiggsfieldMediaKind::Video), MediaMimeType::VideoQuicktime); + assert_eq!(media_mime_type_for(Some("https://cdn.example.com/song.mp3"), b"????", HiggsfieldMediaKind::Audio), MediaMimeType::AudioMpeg); + } + + #[test] + fn local_paths_and_bare_names_give_extensions() { + assert_eq!(media_mime_type_for(Some("/Users/me/Pictures/photo.webp"), b"????", HiggsfieldMediaKind::Image), MediaMimeType::ImageWebp); + assert_eq!(media_mime_type_for(Some("clip.mov"), b"????", HiggsfieldMediaKind::Video), MediaMimeType::VideoQuicktime); + } + + #[test] + fn falls_back_by_kind() { + assert_eq!(media_mime_type_for(Some("https://cdn.example.com/media/abc"), b"????", HiggsfieldMediaKind::Image), MediaMimeType::ImageJpeg); + assert_eq!(media_mime_type_for(None, b"????", HiggsfieldMediaKind::Video), MediaMimeType::VideoMp4); + assert_eq!(media_mime_type_for(None, b"????", HiggsfieldMediaKind::Audio), MediaMimeType::AudioMpeg); + } + + #[test] + fn wrong_family_for_kind_is_ignored() { + // An image handed in as a video reference: don't claim it's a PNG video. + assert_eq!(media_mime_type_for(Some("https://cdn.example.com/a.png"), PNG, HiggsfieldMediaKind::Video), MediaMimeType::VideoMp4); + } + + #[test] + fn reference_file_carries_extension_ip_check_and_source_url() { + let resolved = ResolvedMediaBytes { + bytes: MP4.to_vec(), + maybe_name_hint: Some("https://cdn.example.com/x".into()), + maybe_source_url: Some("https://cdn.example.com/x".into()), + description: "url https://cdn.example.com/x".into(), + }; + let file = reference_media_file(resolved, HiggsfieldMediaKind::Video, true); + assert_eq!(file.file_name, "reference.mp4"); + assert_eq!(file.mime_type, MediaMimeType::VideoMp4); + assert!(file.force_ip_check); + assert_eq!(file.maybe_source_url.as_deref(), Some("https://cdn.example.com/x")); + + let resolved = ResolvedMediaBytes { + bytes: PNG.to_vec(), + maybe_name_hint: Some("/local/x.png".into()), + maybe_source_url: None, + description: "local file /local/x.png".into(), + }; + let file = reference_media_file(resolved, HiggsfieldMediaKind::Image, false); + assert_eq!(file.file_name, "reference.png"); + assert!(!file.force_ip_check); + assert!(file.maybe_source_url.is_none()); + } + } + + mod upload_reuse { + use std::sync::Mutex; + + use async_trait::async_trait; + use higgsfield_client::client::clerk_host::ClerkHost; + use higgsfield_client::client::higgsfield_host::HiggsfieldHost; + use higgsfield_client::types::media_input::MediaInputKind; + + use super::*; + + /// A cache with one canned entry that records what the router did. + struct CannedCache { + entry: Option, + forgotten: Mutex>, + reused: Mutex>, + } + + impl CannedCache { + fn with(entry: CachedAssetUpload) -> Self { + Self { entry: Some(entry), forgotten: Mutex::new(Vec::new()), reused: Mutex::new(Vec::new()) } + } + } + + #[async_trait] + impl AssetUploadCache for CannedCache { + async fn find_upload(&self, _file_hash_blake3: &str) -> Option { + self.entry.clone() + } + async fn record_upload(&self, _file_hash_blake3: &str, _file_size_bytes: u64, _upload: &CachedAssetUpload) {} + async fn note_reused(&self, file_hash_blake3: &str) { + self.reused.lock().unwrap().push(file_hash_blake3.to_string()); + } + async fn forget_upload(&self, file_hash_blake3: &str) { + self.forgotten.lock().unwrap().push(file_hash_blake3.to_string()); + } + } + + /// A session whose every request fails (nothing listens on port 9). + fn unreachable_session() -> HiggsfieldSession { + HiggsfieldSession::from_cookie_header("__client=x") + .with_hosts(HiggsfieldHost::Custom("http://127.0.0.1:9".into()), ClerkHost::Custom("http://127.0.0.1:9".into())) + } + + #[tokio::test] + async fn audio_has_no_status_endpoint_so_the_cached_id_is_trusted() { + let cache = CannedCache::with(CachedAssetUpload::uploaded("media-audio", Some("https://cdn/a.mp3".into()))); + let reused = reusable_upload(&unreachable_session(), &cache, "hash", HiggsfieldMediaKind::Audio, false).await.unwrap(); + assert_eq!(reused.id.as_str(), "media-audio"); + assert_eq!(reused.kind, MediaInputKind::AudioInput); + assert_eq!(reused.url, "https://cdn/a.mp3"); + assert!(cache.forgotten.lock().unwrap().is_empty()); + } + + #[tokio::test] + async fn an_entry_without_a_url_is_forgotten() { + let cache = CannedCache::with(CachedAssetUpload::uploaded("media-1", None)); + assert!(reusable_upload(&unreachable_session(), &cache, "hash", HiggsfieldMediaKind::Audio, false).await.is_none()); + assert_eq!(*cache.forgotten.lock().unwrap(), vec!["hash".to_string()]); + } + + #[tokio::test] + async fn a_generation_result_that_cannot_be_confirmed_means_a_fresh_upload() { + let cache = CannedCache::with(CachedAssetUpload::generation_result("job-1", "https://cdn/result.png")); + let result = reusable_upload(&unreachable_session(), &cache, "hash", HiggsfieldMediaKind::Image, true).await; + assert!(result.is_none()); + assert!(cache.forgotten.lock().unwrap().contains(&"hash".to_string())); + } + + #[test] + fn generation_results_become_job_references_by_kind() { + let image = HiggsfieldMediaKind::Image.job_input(MediaId::new("job-1"), "https://cdn/r.png".into()).unwrap(); + assert_eq!(image.kind, MediaInputKind::ImageJob); + assert_eq!(image.id.as_str(), "job-1"); + let video = HiggsfieldMediaKind::Video.job_input(MediaId::new("job-2"), "https://cdn/r.mp4".into()).unwrap(); + assert_eq!(video.kind, MediaInputKind::VideoJob); + assert!(HiggsfieldMediaKind::Audio.job_input(MediaId::new("job-3"), "https://cdn/r.mp3".into()).is_none()); + } + + #[tokio::test] + async fn a_status_check_that_fails_means_a_fresh_upload() { + let cache = CannedCache::with(CachedAssetUpload::uploaded("media-1", Some("https://cdn/x.png".into()))); + assert!(reusable_upload(&unreachable_session(), &cache, "hash", HiggsfieldMediaKind::Image, true).await.is_none()); + assert_eq!(*cache.forgotten.lock().unwrap(), vec!["hash".to_string()]); + assert!(cache.reused.lock().unwrap().is_empty()); + } + + #[test] + fn media_inputs_take_their_kind_from_the_reference_kind() { + let id = MediaId::new("abc"); + assert_eq!(HiggsfieldMediaKind::Image.media_input(id.clone(), "u".into()).kind, MediaInputKind::MediaInput); + assert_eq!(HiggsfieldMediaKind::Video.media_input(id.clone(), "u".into()).kind, MediaInputKind::VideoInput); + assert_eq!(HiggsfieldMediaKind::Audio.media_input(id, "u".into()).kind, MediaInputKind::AudioInput); + } + } + + mod token_resolution { + use std::collections::HashMap; + + use super::*; + + #[test] + fn tokens_resolve_through_the_map() { + let token = MediaFileToken::new_from_str("m_abc"); + let mut map = HashMap::new(); + map.insert(token.clone(), "https://cdn.example.com/abc.png".to_string()); + assert_eq!(resolve_media_token(Some(&map), &token).unwrap(), "https://cdn.example.com/abc.png"); + assert!(matches!( + resolve_media_token(None, &token), + Err(ArtcraftRouterError::Client(ClientError::MediaFileToUrlMapNotProvided)), + )); + assert!(matches!( + resolve_media_token(Some(&map), &MediaFileToken::new_from_str("m_missing")), + Err(ArtcraftRouterError::Client(ClientError::MediaFileTokenNotFoundInMap { .. })), + )); + } + + #[test] + fn source_lists_convert_from_every_ref_type() { + let images: HiggsfieldMediaSources = ImageListRef::Urls(vec!["a".into(), "b".into()]).into(); + assert_eq!(images.len(), 2); + let videos: HiggsfieldMediaSources = VideoListRef::MediaFileTokens(vec![MediaFileToken::new_from_str("m_1")]).into(); + assert_eq!(videos.len(), 1); + let audio: HiggsfieldMediaSources = AudioListRef::Urls(vec![]).into(); + assert!(audio.is_empty()); + let mixed: HiggsfieldMediaSources = ImageListRef::Sources(vec![ + ImageRef::MediaFileToken(MediaFileToken::new_from_str("m_2")), + ImageRef::LocalPath(PathBuf::from("/tmp/a.png")), + ImageRef::Bytes(MediaBytes::new(vec![1, 2, 3])), + ]).into(); + assert_eq!(mixed.len(), 3); + assert!(matches!(mixed.0[1], MediaSourceRef::LocalPath(_))); + assert!(matches!(mixed.0[2], MediaSourceRef::Bytes(_))); + } + } +} diff --git a/crates/router/src/utils/media_source_ref.rs b/crates/router/src/utils/media_source_ref.rs new file mode 100644 index 00000000..83e3089f --- /dev/null +++ b/crates/router/src/utils/media_source_ref.rs @@ -0,0 +1,237 @@ +//! A provider-agnostic view of one media reference, and the machinery to +//! turn it into bytes. The per-kind ref enums (`ImageRef`, `VideoRef`, +//! `AudioRef`, `MeshRef`) all collapse into [`MediaSourceRef`] for providers +//! that re-upload media (Higgsfield, Kinovi). +//! +//! Only ArtCraft media tokens touch the ArtCraft cloud (they resolve through +//! the token→URL map); local files and bytes never leave the machine until +//! they're uploaded to the target provider. + +use std::collections::HashMap; +use std::path::{Path, PathBuf}; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use url_utils::extension::extract_extension_from_url::{extract_extension_from_url_str, ExtractExtensions}; + +use crate::api::audio_list_ref::AudioListRef; +use crate::api::audio_ref::AudioRef; +use crate::api::image_list_ref::ImageListRef; +use crate::api::image_ref::ImageRef; +use crate::api::media_bytes::MediaBytes; +use crate::api::mesh_ref::MeshRef; +use crate::api::video_list_ref::VideoListRef; +use crate::api::video_ref::VideoRef; +use crate::errors::artcraft_router_error::ArtcraftRouterError; +use crate::errors::client_error::ClientError; +use crate::utils::download_file::download_file; + +/// One media reference, stripped of its image/video/audio kind. +#[derive(Clone, Debug)] +pub enum MediaSourceRef { + MediaFileToken(MediaFileToken), + Url(String), + LocalPath(PathBuf), + Bytes(MediaBytes), +} + +/// A reference resolved to bytes, plus what's known about where it came from. +#[derive(Debug)] +pub struct ResolvedMediaBytes { + pub bytes: Vec, + + /// URL, filesystem path, or bare file name — whatever can lend an + /// extension for MIME/extension guessing. + pub maybe_name_hint: Option, + + /// Set only for caller-supplied `Url` sources; feeds provider-side source + /// guards. Token-resolved CDN URLs deliberately don't set this: a token is + /// a library pick, not a leaked local file. + pub maybe_source_url: Option, + + /// Human-readable origin for logs ("local file /a/b.png", ...). + pub description: String, +} + +impl MediaSourceRef { + pub fn list_from_images(list: ImageListRef) -> Vec { + list.into_refs().into_iter().map(Into::into).collect() + } + + pub fn list_from_videos(list: VideoListRef) -> Vec { + list.into_refs().into_iter().map(Into::into).collect() + } + + pub fn list_from_audios(list: AudioListRef) -> Vec { + list.into_refs().into_iter().map(Into::into).collect() + } +} + +impl From for MediaSourceRef { + fn from(image_ref: ImageRef) -> Self { + match image_ref { + ImageRef::MediaFileToken(token) => Self::MediaFileToken(token), + ImageRef::Url(url) => Self::Url(url), + ImageRef::LocalPath(path) => Self::LocalPath(path), + ImageRef::Bytes(bytes) => Self::Bytes(bytes), + } + } +} + +impl From for MediaSourceRef { + fn from(video_ref: VideoRef) -> Self { + match video_ref { + VideoRef::MediaFileToken(token) => Self::MediaFileToken(token), + VideoRef::Url(url) => Self::Url(url), + VideoRef::LocalPath(path) => Self::LocalPath(path), + VideoRef::Bytes(bytes) => Self::Bytes(bytes), + } + } +} + +impl From for MediaSourceRef { + fn from(audio_ref: AudioRef) -> Self { + match audio_ref { + AudioRef::MediaFileToken(token) => Self::MediaFileToken(token), + AudioRef::Url(url) => Self::Url(url), + AudioRef::LocalPath(path) => Self::LocalPath(path), + AudioRef::Bytes(bytes) => Self::Bytes(bytes), + } + } +} + +impl From for MediaSourceRef { + fn from(mesh_ref: MeshRef) -> Self { + match mesh_ref { + MeshRef::MediaFileToken(token) => Self::MediaFileToken(token), + MeshRef::Url(url) => Self::Url(url), + MeshRef::LocalPath(path) => Self::LocalPath(path), + MeshRef::Bytes(bytes) => Self::Bytes(bytes), + } + } +} + +/// Turn one source into bytes: tokens resolve through `maybe_map` and +/// download; URLs download; local paths read from disk; bytes pass through. +pub async fn resolve_media_source_bytes( + source: MediaSourceRef, + maybe_map: Option<&HashMap>, +) -> Result { + match source { + MediaSourceRef::MediaFileToken(token) => { + let url = resolve_media_token(maybe_map, &token)?; + let bytes = download_file(&url).await?; + Ok(ResolvedMediaBytes { + bytes, + description: format!("media token {}", token.as_str()), + maybe_name_hint: Some(url), + maybe_source_url: None, + }) + } + MediaSourceRef::Url(url) => { + let bytes = download_file(&url).await?; + Ok(ResolvedMediaBytes { + bytes, + description: format!("url {url}"), + maybe_name_hint: Some(url.clone()), + maybe_source_url: Some(url), + }) + } + MediaSourceRef::LocalPath(path) => { + let bytes = read_local_file(&path).await?; + Ok(ResolvedMediaBytes { + bytes, + description: format!("local file {}", path.display()), + maybe_name_hint: Some(path.to_string_lossy().into_owned()), + maybe_source_url: None, + }) + } + MediaSourceRef::Bytes(media_bytes) => { + let MediaBytes { bytes, maybe_file_name } = media_bytes; + Ok(ResolvedMediaBytes { + bytes, + description: "raw bytes".to_string(), + maybe_name_hint: maybe_file_name, + maybe_source_url: None, + }) + } + } +} + +/// Read a local reference file, distinguishing "not there" from "unreadable". +pub async fn read_local_file(path: &Path) -> Result, ArtcraftRouterError> { + if !path.is_file() { + return Err(ArtcraftRouterError::Client(ClientError::LocalFileNotFound { path: path.to_path_buf() })); + } + tokio::fs::read(path).await.map_err(|error| { + ArtcraftRouterError::Client(ClientError::LocalFileRead { path: path.to_path_buf(), error }) + }) +} + +/// The extension a name hint (URL, filesystem path, or bare file name) +/// carries, without its period. `None` when there isn't one. +pub fn extension_from_name_hint(name_hint: &str) -> Option { + if let Some(extension) = extract_extension_from_url_str(name_hint, &ExtractExtensions::All) { + return Some(extension.without_period().to_string()); + } + Path::new(name_hint).extension()?.to_str().map(str::to_string) +} + +pub fn resolve_media_token( + maybe_map: Option<&HashMap>, + token: &MediaFileToken, +) -> Result { + let map = maybe_map.ok_or(ArtcraftRouterError::Client(ClientError::MediaFileToUrlMapNotProvided))?; + map.get(token).cloned().ok_or_else(|| { + ArtcraftRouterError::Client(ClientError::MediaFileTokenNotFoundInMap { token: token.clone() }) + }) +} + +pub fn resolve_media_tokens( + maybe_map: Option<&HashMap>, + tokens: &[MediaFileToken], +) -> Result, ArtcraftRouterError> { + tokens.iter().map(|token| resolve_media_token(maybe_map, token)).collect() +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn extensions_come_from_urls_paths_and_names() { + assert_eq!(extension_from_name_hint("https://cdn.example.com/a.webp?x=1").as_deref(), Some("webp")); + assert_eq!(extension_from_name_hint("/Users/me/Pictures/photo.PNG").as_deref(), Some("PNG")); + assert_eq!(extension_from_name_hint("clip.mov").as_deref(), Some("mov")); + assert_eq!(extension_from_name_hint("no_extension"), None); + } + + #[test] + fn lists_collapse_to_sources() { + let sources = MediaSourceRef::list_from_images(ImageListRef::Sources(vec![ + ImageRef::Url("https://a.example/a.png".into()), + ImageRef::LocalPath(PathBuf::from("/tmp/b.png")), + ImageRef::Bytes(MediaBytes::new(vec![1])), + ])); + assert_eq!(sources.len(), 3); + assert!(matches!(sources[0], MediaSourceRef::Url(_))); + assert!(matches!(sources[1], MediaSourceRef::LocalPath(_))); + assert!(matches!(sources[2], MediaSourceRef::Bytes(_))); + } + + #[tokio::test] + async fn missing_local_file_is_a_clear_error() { + let err = read_local_file(Path::new("/definitely/not/a/real/file.png")).await.unwrap_err(); + assert!(matches!(err, ArtcraftRouterError::Client(ClientError::LocalFileNotFound { .. }))); + } + + #[tokio::test] + async fn bytes_pass_straight_through() { + let resolved = resolve_media_source_bytes( + MediaSourceRef::Bytes(MediaBytes::new(vec![9, 9]).with_file_name("a.png")), + None, + ).await.unwrap(); + assert_eq!(resolved.bytes, vec![9, 9]); + assert_eq!(resolved.maybe_name_hint.as_deref(), Some("a.png")); + assert!(resolved.maybe_source_url.is_none()); + } +} diff --git a/crates/router/src/utils/mod.rs b/crates/router/src/utils/mod.rs new file mode 100644 index 00000000..c5531161 --- /dev/null +++ b/crates/router/src/utils/mod.rs @@ -0,0 +1,3 @@ +pub mod download_file; +pub mod higgsfield_media; +pub mod media_source_ref; diff --git a/crates/schema/local_files_database/Cargo.toml b/crates/schema/local_files_database/Cargo.toml new file mode 100644 index 00000000..bdce66e8 --- /dev/null +++ b/crates/schema/local_files_database/Cargo.toml @@ -0,0 +1,34 @@ +[package] +name = "local_files_database" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "local_files_database" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true + +# External +chrono.workspace = true +log.workspace = true + +# NB: Unlike `sqlite_database`, this crate uses RUNTIME queries (no sqlx +# compile-time macros). The workspace's `.sqlx` offline data and the single +# global DATABASE_URL can only describe one schema; runtime queries keep this +# second database free of the `cargo sqlx prepare` dance. +sqlx = { package = "sqlx", version = "0.7.4", features = ["runtime-tokio-rustls", "sqlite", "chrono"] } + +[dev-dependencies] +# Integration tests run queries against a throwaway migrated database. +tempfile.workspace = true +tokio = { workspace = true, features = ["macros", "rt-multi-thread"] } diff --git a/crates/schema/local_files_database/migrations/20260901000000_create_local_files.sql b/crates/schema/local_files_database/migrations/20260901000000_create_local_files.sql new file mode 100644 index 00000000..eb01d4e7 --- /dev/null +++ b/crates/schema/local_files_database/migrations/20260901000000_create_local_files.sql @@ -0,0 +1,36 @@ +-- The content-hash index of local files the app has seen. +-- +-- One row per absolute file path. `file_size_bytes` + `file_mtime_ms` exist +-- so lookups can trust the cached hash without re-reading the file: if the +-- stat matches, the hash is current; if not, rehash and update. +-- +-- `has_thumbnail` / `has_animated_preview` are hints — the thumbnail cache +-- directory on disk is the source of truth (files are keyed by +-- `{file_hash_blake3}.jpg` / `.webp` and regenerate if missing). + +CREATE TABLE local_files ( + -- Absolute local file path. + file_path TEXT PRIMARY KEY NOT NULL, + + -- Lowercase extension-ish type: "mp4", "png", "jpg", ... + file_type TEXT, + + -- Stat fields captured when the hash was computed (invalidation). + file_size_bytes INTEGER NOT NULL, + file_mtime_ms INTEGER NOT NULL, + + -- BLAKE3 content hash, 64 lowercase hex characters. + file_hash_blake3 TEXT NOT NULL, + + -- A static thumbnail jpg exists in the cache for this hash. + has_thumbnail INTEGER NOT NULL DEFAULT 0, + + -- A ~1s animated preview webp exists in the cache for this hash. + has_animated_preview INTEGER NOT NULL DEFAULT 0, + + created_at TEXT NOT NULL, + updated_at TEXT NOT NULL +); + +-- Content-addressed lookups (dedup; the future upload ledger joins on this). +CREATE INDEX idx_local_files_hash_blake3 ON local_files (file_hash_blake3); diff --git a/crates/schema/local_files_database/migrations/20260907000000_add_thumbnail_state.sql b/crates/schema/local_files_database/migrations/20260907000000_add_thumbnail_state.sql new file mode 100644 index 00000000..f1d20013 --- /dev/null +++ b/crates/schema/local_files_database/migrations/20260907000000_add_thumbnail_state.sql @@ -0,0 +1,23 @@ +-- Thumbnail generation bookkeeping, so the background worker can find work +-- with one query instead of stat-ing the cache directory per file. +-- +-- `thumbnail_state`: +-- 'pending' - never generated (or the file's content changed) +-- 'generated' - the jpg (and, for videos that allow it, the webp) exist +-- 'unsupported' - the container/codec can't be thumbnailed; don't retry +-- 'failed' - generation errored; retried until `thumbnail_attempts` +-- reaches the worker's cap +-- +-- The cache file paths are recorded so readers (the task queue, the +-- frontend) never have to derive them; they are content-addressed: +-- `cache/thumbnails/{file_hash_blake3}.jpg` / `.webp`. + +ALTER TABLE local_files ADD COLUMN thumbnail_state TEXT NOT NULL DEFAULT 'pending'; +ALTER TABLE local_files ADD COLUMN thumbnail_attempts INTEGER NOT NULL DEFAULT 0; +ALTER TABLE local_files ADD COLUMN thumbnail_last_error TEXT; +ALTER TABLE local_files ADD COLUMN thumbnail_jpg_path TEXT; +ALTER TABLE local_files ADD COLUMN animated_preview_webp_path TEXT; +ALTER TABLE local_files ADD COLUMN thumbnail_updated_at TEXT; + +-- The worker's "what needs doing" scan. +CREATE INDEX idx_local_files_thumbnail_state ON local_files (thumbnail_state); diff --git a/crates/schema/local_files_database/migrations/20260907000001_add_thumbnail_generator_version.sql b/crates/schema/local_files_database/migrations/20260907000001_add_thumbnail_generator_version.sql new file mode 100644 index 00000000..74fd902f --- /dev/null +++ b/crates/schema/local_files_database/migrations/20260907000001_add_thumbnail_generator_version.sql @@ -0,0 +1,6 @@ +-- Which generator produced a row's thumbnails. The worker regenerates rows +-- whose version is older than the current one, so output changes (size, +-- duration, quality) roll out to existing cache entries without anyone +-- deleting the cache. + +ALTER TABLE local_files ADD COLUMN thumbnail_generator_version INTEGER NOT NULL DEFAULT 0; diff --git a/crates/schema/local_files_database/migrations/20260907000002_create_asset_uploads.sql b/crates/schema/local_files_database/migrations/20260907000002_create_asset_uploads.sql new file mode 100644 index 00000000..52adbbf7 --- /dev/null +++ b/crates/schema/local_files_database/migrations/20260907000002_create_asset_uploads.sql @@ -0,0 +1,37 @@ +-- The upload-dedup ledger: which remote service already holds a copy of a +-- local file, per account. Before uploading, callers look up +-- (service, account, content hash) and reuse the service's id for the +-- asset instead of pushing the bytes again. +-- +-- `service` - which remote: "artcraft", "higgsfield", ... +-- `account_id` - the credential the upload was made with (a credential id +-- for stored accounts; a session fingerprint for ArtCraft +-- web sessions). Different accounts never share uploads. +-- `service_id` - the service's own primary key for the asset (ArtCraft media +-- file token, Higgsfield media id, ...). +-- `service_url` - where the asset can be reached remotely, when the service +-- publishes one (Higgsfield's CDN URL, ArtCraft's CDN URL). +-- +-- Rows are advisory: a reuse is verified against the service first, and any +-- failure falls back to a fresh upload that overwrites the row. + +CREATE TABLE asset_uploads ( + service TEXT NOT NULL, + account_id TEXT NOT NULL, + file_hash_blake3 TEXT NOT NULL, + + service_id TEXT NOT NULL, + service_url TEXT, + + -- Size of the bytes that were uploaded, for sanity checks / display. + file_size_bytes INTEGER, + + uploaded_at TEXT NOT NULL, + -- Last time a caller reused this row instead of uploading. + last_reused_at TEXT, + + PRIMARY KEY (service, account_id, file_hash_blake3) +); + +-- Reverse lookups (which local content is behind a service id). +CREATE INDEX idx_asset_uploads_service_id ON asset_uploads (service, service_id); diff --git a/crates/schema/local_files_database/migrations/20260907000003_add_asset_upload_origin.sql b/crates/schema/local_files_database/migrations/20260907000003_add_asset_upload_origin.sql new file mode 100644 index 00000000..733cb202 --- /dev/null +++ b/crates/schema/local_files_database/migrations/20260907000003_add_asset_upload_origin.sql @@ -0,0 +1,6 @@ +-- How the service came to hold the content. `upload`: we sent the bytes. +-- `generation_result`: the service produced the file itself (a generation +-- we downloaded), so `service_id` is its job id and the content can be +-- referenced as a previous generation without ever uploading it. + +ALTER TABLE asset_uploads ADD COLUMN origin TEXT NOT NULL DEFAULT 'upload'; diff --git a/crates/schema/local_files_database/src/connection.rs b/crates/schema/local_files_database/src/connection.rs new file mode 100644 index 00000000..c546d0d7 --- /dev/null +++ b/crates/schema/local_files_database/src/connection.rs @@ -0,0 +1,79 @@ +use std::path::Path; +use std::time::Duration; + +use errors::AnyhowResult; +use log::{error, info}; +use sqlx::migrate::MigrateError; +use sqlx::sqlite::{SqliteConnectOptions, SqliteJournalMode, SqliteSynchronous}; +use sqlx::{Pool, Sqlite, SqlitePool}; + +/// How long a writer waits for the lock before erroring. Thumbnail +/// generation writes in bursts; without this SQLite returns SQLITE_BUSY +/// immediately. +const BUSY_TIMEOUT: Duration = Duration::from_secs(5); + +#[derive(Clone)] +pub struct LocalFilesDbConnection { + pool: Pool, +} + +impl LocalFilesDbConnection { + /// Open (creating if missing) and migrate the database. + /// + /// On migration failure the file is moved aside (`.broken-`) + /// and a fresh one created. Nothing here is irreplaceable — thumbnails + /// regenerate and the upload ledger only costs a re-upload — but the + /// ledger is worth keeping for a hand recovery, so it isn't deleted. + pub async fn connect_and_migrate>(database_file: P) -> AnyhowResult { + match run_migrations(&database_file).await { + Ok(pool) => return Ok(Self { pool }), + Err(err) => { + error!("Error running local_files SQLite migrations: {:?}", err); + } + } + + let database_file = database_file.as_ref(); + let unix_ms = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|duration| duration.as_millis()) + .unwrap_or(0); + let aside = database_file.with_extension(format!("broken-{unix_ms}")); + info!("Moving local_files SQLite database aside to {:?} and recreating it", aside); + + if let Err(err) = std::fs::rename(database_file, &aside) { + error!("Error moving local_files SQLite database file aside: {:?}", err); + } + // WAL/shm sidecars belong to the old file; a stale WAL must not replay + // into the new database. + for sidecar in ["-wal", "-shm"] { + let mut path = database_file.as_os_str().to_owned(); + path.push(sidecar); + let _ = std::fs::remove_file(path); + } + + let pool = run_migrations(database_file).await?; + + Ok(Self { pool }) + } + + pub fn get_pool(&self) -> &Pool { + &self.pool + } +} + +async fn run_migrations>(database_file: P) -> Result { + let connection_options = SqliteConnectOptions::new() + .filename(database_file) + .create_if_missing(true) + .journal_mode(SqliteJournalMode::Wal) + .synchronous(SqliteSynchronous::Normal) + .busy_timeout(BUSY_TIMEOUT); + + let pool = SqlitePool::connect_with(connection_options).await?; + + // Additive migrations against a stable filename; sqlx tracks which have + // run. The SQL is compiled into the binary. + sqlx::migrate!().run(&pool).await?; + + Ok(pool) +} diff --git a/crates/schema/local_files_database/src/error.rs b/crates/schema/local_files_database/src/error.rs new file mode 100644 index 00000000..954856a5 --- /dev/null +++ b/crates/schema/local_files_database/src/error.rs @@ -0,0 +1,23 @@ +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum LocalFilesDbError { + SqlxError(sqlx::Error), +} + +impl Error for LocalFilesDbError {} + +impl Display for LocalFilesDbError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + LocalFilesDbError::SqlxError(err) => write!(f, "SQLx error: {:?}", err), + } + } +} + +impl From for LocalFilesDbError { + fn from(err: sqlx::Error) -> Self { + LocalFilesDbError::SqlxError(err) + } +} diff --git a/crates/schema/local_files_database/src/lib.rs b/crates/schema/local_files_database/src/lib.rs new file mode 100644 index 00000000..0077d6e8 --- /dev/null +++ b/crates/schema/local_files_database/src/lib.rs @@ -0,0 +1,29 @@ +//! local_files_database +//! +//! A content-hash index of local files the app has seen, separate from the +//! tasks database on purpose: this is a rebuildable index (thumbnail +//! accounting today; an (account, checksum) upload-dedup ledger later), +//! with its own write patterns, lock domain, and lifecycle. The tasks +//! database is irreplaceable history; this one can be nuked and re-derived. +//! +//! Unlike the tasks database it keeps a STABLE filename with additive +//! migrations — no version-bumped filenames. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] + +pub mod connection; +pub mod error; +pub mod queries; +pub mod thumbnail_state; diff --git a/crates/schema/local_files_database/src/queries/asset_upload_record.rs b/crates/schema/local_files_database/src/queries/asset_upload_record.rs new file mode 100644 index 00000000..e6ef855b --- /dev/null +++ b/crates/schema/local_files_database/src/queries/asset_upload_record.rs @@ -0,0 +1,18 @@ +use chrono::{DateTime, Utc}; + +/// One row of `asset_uploads`: a remote copy of some local content. +#[derive(Clone, Debug, sqlx::FromRow)] +pub struct AssetUploadRecord { + pub service: String, + pub account_id: String, + pub file_hash_blake3: String, + /// The service's own primary key for the asset: a media id for an upload, + /// a job id for a generation result (see `origin`). + pub service_id: String, + /// `upload` or `generation_result`. + pub origin: String, + pub service_url: Option, + pub file_size_bytes: Option, + pub uploaded_at: DateTime, + pub last_reused_at: Option>, +} diff --git a/crates/schema/local_files_database/src/queries/delete_asset_upload.rs b/crates/schema/local_files_database/src/queries/delete_asset_upload.rs new file mode 100644 index 00000000..2dd824e6 --- /dev/null +++ b/crates/schema/local_files_database/src/queries/delete_asset_upload.rs @@ -0,0 +1,21 @@ +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; + +/// Forget a remote copy (it no longer exists, or failed verification). +/// Returns whether a row was deleted. +pub async fn delete_asset_upload( + db: &LocalFilesDbConnection, + service: &str, + account_id: &str, + file_hash_blake3: &str, +) -> Result { + let result = sqlx::query( + "DELETE FROM asset_uploads WHERE service = ?1 AND account_id = ?2 AND file_hash_blake3 = ?3", + ) + .bind(service) + .bind(account_id) + .bind(file_hash_blake3) + .execute(db.get_pool()) + .await?; + Ok(result.rows_affected() > 0) +} diff --git a/crates/schema/local_files_database/src/queries/get_asset_upload.rs b/crates/schema/local_files_database/src/queries/get_asset_upload.rs new file mode 100644 index 00000000..aba8ed4b --- /dev/null +++ b/crates/schema/local_files_database/src/queries/get_asset_upload.rs @@ -0,0 +1,27 @@ +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; +use crate::queries::asset_upload_record::AssetUploadRecord; + +pub struct GetAssetUploadArgs<'a> { + pub db: &'a LocalFilesDbConnection, + pub service: &'a str, + pub account_id: &'a str, + pub file_hash_blake3: &'a str, +} + +/// The remote copy of this content on this service+account, if one was +/// recorded. +pub async fn get_asset_upload(args: GetAssetUploadArgs<'_>) -> Result, LocalFilesDbError> { + let record = sqlx::query_as::<_, AssetUploadRecord>( + r#" + SELECT * FROM asset_uploads + WHERE service = ?1 AND account_id = ?2 AND file_hash_blake3 = ?3 + "#, + ) + .bind(args.service) + .bind(args.account_id) + .bind(args.file_hash_blake3) + .fetch_optional(args.db.get_pool()) + .await?; + Ok(record) +} diff --git a/crates/schema/local_files_database/src/queries/get_local_file_by_path.rs b/crates/schema/local_files_database/src/queries/get_local_file_by_path.rs new file mode 100644 index 00000000..782d95ab --- /dev/null +++ b/crates/schema/local_files_database/src/queries/get_local_file_by_path.rs @@ -0,0 +1,16 @@ +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; +use crate::queries::local_file_record::LocalFileRecord; + +pub async fn get_local_file_by_path( + db: &LocalFilesDbConnection, + file_path: &str, +) -> Result, LocalFilesDbError> { + let record = sqlx::query_as::<_, LocalFileRecord>( + "SELECT * FROM local_files WHERE file_path = ?1", + ) + .bind(file_path) + .fetch_optional(db.get_pool()) + .await?; + Ok(record) +} diff --git a/crates/schema/local_files_database/src/queries/get_local_files_by_hash.rs b/crates/schema/local_files_database/src/queries/get_local_files_by_hash.rs new file mode 100644 index 00000000..0d39bcc1 --- /dev/null +++ b/crates/schema/local_files_database/src/queries/get_local_files_by_hash.rs @@ -0,0 +1,18 @@ +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; +use crate::queries::local_file_record::LocalFileRecord; + +/// Every known path with this content hash (dedup lookups; the future +/// upload-dedup ledger keys on this). +pub async fn get_local_files_by_hash( + db: &LocalFilesDbConnection, + file_hash_blake3: &str, +) -> Result, LocalFilesDbError> { + let records = sqlx::query_as::<_, LocalFileRecord>( + "SELECT * FROM local_files WHERE file_hash_blake3 = ?1 ORDER BY file_path", + ) + .bind(file_hash_blake3) + .fetch_all(db.get_pool()) + .await?; + Ok(records) +} diff --git a/crates/schema/local_files_database/src/queries/get_local_files_by_paths.rs b/crates/schema/local_files_database/src/queries/get_local_files_by_paths.rs new file mode 100644 index 00000000..eb225342 --- /dev/null +++ b/crates/schema/local_files_database/src/queries/get_local_files_by_paths.rs @@ -0,0 +1,38 @@ +use std::collections::HashMap; + +use sqlx::{QueryBuilder, Sqlite}; + +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; +use crate::queries::local_file_record::LocalFileRecord; + +/// SQLite's default bound-parameter ceiling; larger inputs are chunked. +const MAX_PATHS_PER_QUERY: usize = 900; + +/// Batch lookup by path (one query per 900 paths). Paths with no row are +/// simply absent from the map. +pub async fn get_local_files_by_paths( + db: &LocalFilesDbConnection, + file_paths: &[String], +) -> Result, LocalFilesDbError> { + let mut records = HashMap::with_capacity(file_paths.len()); + + for chunk in file_paths.chunks(MAX_PATHS_PER_QUERY) { + let mut query_builder: QueryBuilder = QueryBuilder::new("SELECT * FROM local_files WHERE file_path IN ("); + let mut separated = query_builder.separated(", "); + for file_path in chunk { + separated.push_bind(file_path); + } + separated.push_unseparated(")"); + + let chunk_records = query_builder + .build_query_as::() + .fetch_all(db.get_pool()) + .await?; + for record in chunk_records { + records.insert(record.file_path.clone(), record); + } + } + + Ok(records) +} diff --git a/crates/schema/local_files_database/src/queries/list_local_files_needing_thumbnails.rs b/crates/schema/local_files_database/src/queries/list_local_files_needing_thumbnails.rs new file mode 100644 index 00000000..778ddbdb --- /dev/null +++ b/crates/schema/local_files_database/src/queries/list_local_files_needing_thumbnails.rs @@ -0,0 +1,30 @@ +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; +use crate::queries::local_file_record::LocalFileRecord; + +/// Rows the thumbnail worker should (re)try: never generated, failed fewer +/// than `max_attempts` times, or generated by an older generator than +/// `current_generator_version`. Newest first, so fresh downloads win. +pub async fn list_local_files_needing_thumbnails( + db: &LocalFilesDbConnection, + max_attempts: i64, + current_generator_version: i64, + limit: i64, +) -> Result, LocalFilesDbError> { + let records = sqlx::query_as::<_, LocalFileRecord>( + r#" + SELECT * FROM local_files + WHERE thumbnail_state = 'pending' + OR (thumbnail_state = 'failed' AND thumbnail_attempts < ?1) + OR (thumbnail_state = 'generated' AND thumbnail_generator_version < ?2) + ORDER BY updated_at DESC + LIMIT ?3 + "#, + ) + .bind(max_attempts) + .bind(current_generator_version) + .bind(limit) + .fetch_all(db.get_pool()) + .await?; + Ok(records) +} diff --git a/crates/schema/local_files_database/src/queries/local_file_record.rs b/crates/schema/local_files_database/src/queries/local_file_record.rs new file mode 100644 index 00000000..2701446b --- /dev/null +++ b/crates/schema/local_files_database/src/queries/local_file_record.rs @@ -0,0 +1,40 @@ +use chrono::{DateTime, Utc}; + +use crate::thumbnail_state::ThumbnailState; + +/// One row of `local_files`. +#[derive(Clone, Debug, sqlx::FromRow)] +pub struct LocalFileRecord { + pub file_path: String, + pub file_type: Option, + pub file_size_bytes: i64, + pub file_mtime_ms: i64, + pub file_hash_blake3: String, + pub has_thumbnail: bool, + pub has_animated_preview: bool, + + /// Raw `thumbnail_state` column; read it through [`Self::thumbnail_state`]. + #[sqlx(rename = "thumbnail_state")] + pub thumbnail_state_raw: String, + pub thumbnail_attempts: i64, + pub thumbnail_last_error: Option, + pub thumbnail_jpg_path: Option, + pub animated_preview_webp_path: Option, + pub thumbnail_updated_at: Option>, + /// Which generator version produced the cache entries (0 = none yet). + pub thumbnail_generator_version: i64, + + pub created_at: DateTime, + pub updated_at: DateTime, +} + +impl LocalFileRecord { + /// Whether the cached hash is still current for a file with this stat. + pub fn matches_stat(&self, file_size_bytes: i64, file_mtime_ms: i64) -> bool { + self.file_size_bytes == file_size_bytes && self.file_mtime_ms == file_mtime_ms + } + + pub fn thumbnail_state(&self) -> ThumbnailState { + ThumbnailState::from_str_lenient(&self.thumbnail_state_raw) + } +} diff --git a/crates/schema/local_files_database/src/queries/mod.rs b/crates/schema/local_files_database/src/queries/mod.rs new file mode 100644 index 00000000..00e88009 --- /dev/null +++ b/crates/schema/local_files_database/src/queries/mod.rs @@ -0,0 +1,15 @@ +// ── local_files: the content-hash index ── +pub mod local_file_record; +pub mod get_local_file_by_path; +pub mod get_local_files_by_hash; +pub mod get_local_files_by_paths; +pub mod list_local_files_needing_thumbnails; +pub mod set_thumbnail_result; +pub mod upsert_local_file; + +// ── asset_uploads: the per-account upload-dedup ledger ── +pub mod asset_upload_record; +pub mod delete_asset_upload; +pub mod get_asset_upload; +pub mod touch_asset_upload_reused; +pub mod upsert_asset_upload; diff --git a/crates/schema/local_files_database/src/queries/set_thumbnail_result.rs b/crates/schema/local_files_database/src/queries/set_thumbnail_result.rs new file mode 100644 index 00000000..73f9db05 --- /dev/null +++ b/crates/schema/local_files_database/src/queries/set_thumbnail_result.rs @@ -0,0 +1,56 @@ +use chrono::Utc; + +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; +use crate::thumbnail_state::ThumbnailState; + +pub struct SetThumbnailResultArgs<'a> { + pub db: &'a LocalFilesDbConnection, + pub file_path: &'a str, + pub state: ThumbnailState, + /// The generator that produced this outcome; rows below the current + /// version are regenerated by the worker. + pub generator_version: i64, + /// Absolute cache path of the static jpg, when it was written. + pub maybe_thumbnail_jpg_path: Option<&'a str>, + /// Absolute cache path of the animated webp, when it was written. + pub maybe_animated_preview_webp_path: Option<&'a str>, + /// Why generation failed (or was unsupported); cleared on success. + pub maybe_error: Option<&'a str>, +} + +/// Record the outcome of one generation attempt for a path. Every call +/// counts as an attempt. Returns whether a row was updated (there is no row +/// until the file has been hashed). +pub async fn set_thumbnail_result(args: SetThumbnailResultArgs<'_>) -> Result { + let now = Utc::now(); + let result = sqlx::query( + r#" + UPDATE local_files + SET + thumbnail_state = ?2, + thumbnail_attempts = thumbnail_attempts + 1, + thumbnail_last_error = ?3, + thumbnail_jpg_path = ?4, + animated_preview_webp_path = ?5, + has_thumbnail = ?6, + has_animated_preview = ?7, + thumbnail_updated_at = ?8, + updated_at = ?8, + thumbnail_generator_version = ?9 + WHERE file_path = ?1 + "#, + ) + .bind(args.file_path) + .bind(args.state.to_str()) + .bind(args.maybe_error) + .bind(args.maybe_thumbnail_jpg_path) + .bind(args.maybe_animated_preview_webp_path) + .bind(args.maybe_thumbnail_jpg_path.is_some()) + .bind(args.maybe_animated_preview_webp_path.is_some()) + .bind(now) + .bind(args.generator_version) + .execute(args.db.get_pool()) + .await?; + Ok(result.rows_affected() > 0) +} diff --git a/crates/schema/local_files_database/src/queries/touch_asset_upload_reused.rs b/crates/schema/local_files_database/src/queries/touch_asset_upload_reused.rs new file mode 100644 index 00000000..484f603b --- /dev/null +++ b/crates/schema/local_files_database/src/queries/touch_asset_upload_reused.rs @@ -0,0 +1,27 @@ +use chrono::Utc; + +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; + +/// Note that a caller skipped an upload thanks to this row. Returns whether +/// the row existed. +pub async fn touch_asset_upload_reused( + db: &LocalFilesDbConnection, + service: &str, + account_id: &str, + file_hash_blake3: &str, +) -> Result { + let result = sqlx::query( + r#" + UPDATE asset_uploads SET last_reused_at = ?4 + WHERE service = ?1 AND account_id = ?2 AND file_hash_blake3 = ?3 + "#, + ) + .bind(service) + .bind(account_id) + .bind(file_hash_blake3) + .bind(Utc::now()) + .execute(db.get_pool()) + .await?; + Ok(result.rows_affected() > 0) +} diff --git a/crates/schema/local_files_database/src/queries/upsert_asset_upload.rs b/crates/schema/local_files_database/src/queries/upsert_asset_upload.rs new file mode 100644 index 00000000..802a59a6 --- /dev/null +++ b/crates/schema/local_files_database/src/queries/upsert_asset_upload.rs @@ -0,0 +1,46 @@ +use chrono::Utc; + +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; + +pub struct UpsertAssetUploadArgs<'a> { + pub db: &'a LocalFilesDbConnection, + pub service: &'a str, + pub account_id: &'a str, + pub file_hash_blake3: &'a str, + pub service_id: &'a str, + /// `upload` or `generation_result`. + pub origin: &'a str, + pub maybe_service_url: Option<&'a str>, + pub maybe_file_size_bytes: Option, +} + +/// Record (or replace) the remote copy of some content. A re-upload of the +/// same content overwrites the old service id and resets the reuse time. +pub async fn upsert_asset_upload(args: UpsertAssetUploadArgs<'_>) -> Result<(), LocalFilesDbError> { + sqlx::query( + r#" + INSERT INTO asset_uploads + (service, account_id, file_hash_blake3, service_id, origin, service_url, file_size_bytes, uploaded_at, last_reused_at) + VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, NULL) + ON CONFLICT(service, account_id, file_hash_blake3) DO UPDATE SET + service_id = excluded.service_id, + origin = excluded.origin, + service_url = excluded.service_url, + file_size_bytes = excluded.file_size_bytes, + uploaded_at = excluded.uploaded_at, + last_reused_at = NULL + "#, + ) + .bind(args.service) + .bind(args.account_id) + .bind(args.file_hash_blake3) + .bind(args.service_id) + .bind(args.origin) + .bind(args.maybe_service_url) + .bind(args.maybe_file_size_bytes) + .bind(Utc::now()) + .execute(args.db.get_pool()) + .await?; + Ok(()) +} diff --git a/crates/schema/local_files_database/src/queries/upsert_local_file.rs b/crates/schema/local_files_database/src/queries/upsert_local_file.rs new file mode 100644 index 00000000..3565775a --- /dev/null +++ b/crates/schema/local_files_database/src/queries/upsert_local_file.rs @@ -0,0 +1,68 @@ +use chrono::Utc; + +use crate::connection::LocalFilesDbConnection; +use crate::error::LocalFilesDbError; + +pub struct UpsertLocalFileArgs<'a> { + pub db: &'a LocalFilesDbConnection, + pub file_path: &'a str, + pub maybe_file_type: Option<&'a str>, + pub file_size_bytes: i64, + pub file_mtime_ms: i64, + pub file_hash_blake3: &'a str, +} + +/// Insert or refresh the row for a path. A changed hash (file overwritten +/// in place) resets all thumbnail bookkeeping to `pending` — the cache +/// entries for the old hash no longer describe this path's content. +pub async fn upsert_local_file(args: UpsertLocalFileArgs<'_>) -> Result<(), LocalFilesDbError> { + let now = Utc::now(); + sqlx::query( + r#" + INSERT INTO local_files + (file_path, file_type, file_size_bytes, file_mtime_ms, file_hash_blake3, + has_thumbnail, has_animated_preview, thumbnail_state, thumbnail_attempts, + created_at, updated_at) + VALUES (?1, ?2, ?3, ?4, ?5, 0, 0, 'pending', 0, ?6, ?6) + ON CONFLICT(file_path) DO UPDATE SET + file_type = excluded.file_type, + file_size_bytes = excluded.file_size_bytes, + file_mtime_ms = excluded.file_mtime_ms, + file_hash_blake3 = excluded.file_hash_blake3, + has_thumbnail = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.has_thumbnail ELSE 0 END, + has_animated_preview = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.has_animated_preview ELSE 0 END, + thumbnail_state = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.thumbnail_state ELSE 'pending' END, + thumbnail_attempts = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.thumbnail_attempts ELSE 0 END, + thumbnail_last_error = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.thumbnail_last_error ELSE NULL END, + thumbnail_jpg_path = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.thumbnail_jpg_path ELSE NULL END, + animated_preview_webp_path = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.animated_preview_webp_path ELSE NULL END, + thumbnail_generator_version = CASE + WHEN local_files.file_hash_blake3 = excluded.file_hash_blake3 + THEN local_files.thumbnail_generator_version ELSE 0 END, + updated_at = excluded.updated_at + "#, + ) + .bind(args.file_path) + .bind(args.maybe_file_type) + .bind(args.file_size_bytes) + .bind(args.file_mtime_ms) + .bind(args.file_hash_blake3) + .bind(now) + .execute(args.db.get_pool()) + .await?; + Ok(()) +} diff --git a/crates/schema/local_files_database/src/thumbnail_state.rs b/crates/schema/local_files_database/src/thumbnail_state.rs new file mode 100644 index 00000000..bd250c2b --- /dev/null +++ b/crates/schema/local_files_database/src/thumbnail_state.rs @@ -0,0 +1,56 @@ +use std::fmt; + +/// Where a `local_files` row is in thumbnail generation. Stored as text in +/// `thumbnail_state`; NEVER change an existing value, only add new ones. +#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] +pub enum ThumbnailState { + /// Never generated, or the file's content changed since. + Pending, + /// The cache files exist (see the path columns). + Generated, + /// Can't be thumbnailed (container/codec); never retried. + Unsupported, + /// Generation errored; retried until the attempt cap. + Failed, +} + +impl ThumbnailState { + pub fn to_str(&self) -> &'static str { + match self { + Self::Pending => "pending", + Self::Generated => "generated", + Self::Unsupported => "unsupported", + Self::Failed => "failed", + } + } + + /// Unknown values (a newer binary wrote them) read as `Pending` so the + /// worker re-derives them rather than erroring the whole row set. + pub fn from_str_lenient(value: &str) -> Self { + match value { + "generated" => Self::Generated, + "unsupported" => Self::Unsupported, + "failed" => Self::Failed, + _ => Self::Pending, + } + } +} + +impl fmt::Display for ThumbnailState { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(self.to_str()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trip() { + for state in [ThumbnailState::Pending, ThumbnailState::Generated, ThumbnailState::Unsupported, ThumbnailState::Failed] { + assert_eq!(ThumbnailState::from_str_lenient(state.to_str()), state); + } + assert_eq!(ThumbnailState::from_str_lenient("something_new"), ThumbnailState::Pending); + } +} diff --git a/crates/schema/local_files_database/tests/asset_upload_queries.rs b/crates/schema/local_files_database/tests/asset_upload_queries.rs new file mode 100644 index 00000000..2e237e80 --- /dev/null +++ b/crates/schema/local_files_database/tests/asset_upload_queries.rs @@ -0,0 +1,88 @@ +//! Integration tests for the upload-dedup ledger, against a throwaway +//! migrated database in a tempdir. + +use local_files_database::connection::LocalFilesDbConnection; +use local_files_database::queries::delete_asset_upload::delete_asset_upload; +use local_files_database::queries::get_asset_upload::{get_asset_upload, GetAssetUploadArgs}; +use local_files_database::queries::touch_asset_upload_reused::touch_asset_upload_reused; +use local_files_database::queries::upsert_asset_upload::{upsert_asset_upload, UpsertAssetUploadArgs}; + +const HASH_A: &str = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; + +#[tokio::test] +async fn record_lookup_and_reuse() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + assert!(lookup(&db, "higgsfield", "credential_1", HASH_A).await.is_none()); + + record(&db, "higgsfield", "credential_1", HASH_A, "media-1", Some("https://cdn.higgsfield.ai/x.png")).await; + let row = lookup(&db, "higgsfield", "credential_1", HASH_A).await.unwrap(); + assert_eq!(row.service_id, "media-1"); + assert_eq!(row.service_url.as_deref(), Some("https://cdn.higgsfield.ai/x.png")); + assert_eq!(row.file_size_bytes, Some(1234)); + assert!(row.last_reused_at.is_none()); + + assert!(touch_asset_upload_reused(&db, "higgsfield", "credential_1", HASH_A).await.unwrap()); + assert!(lookup(&db, "higgsfield", "credential_1", HASH_A).await.unwrap().last_reused_at.is_some()); + assert!(!touch_asset_upload_reused(&db, "higgsfield", "nobody", HASH_A).await.unwrap()); +} + +#[tokio::test] +async fn accounts_and_services_are_isolated() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + record(&db, "higgsfield", "credential_1", HASH_A, "media-1", None).await; + record(&db, "higgsfield", "credential_2", HASH_A, "media-2", None).await; + record(&db, "artcraft", "credential_1", HASH_A, "m_token", None).await; + + assert_eq!(lookup(&db, "higgsfield", "credential_1", HASH_A).await.unwrap().service_id, "media-1"); + assert_eq!(lookup(&db, "higgsfield", "credential_2", HASH_A).await.unwrap().service_id, "media-2"); + assert_eq!(lookup(&db, "artcraft", "credential_1", HASH_A).await.unwrap().service_id, "m_token"); + assert!(lookup(&db, "artcraft", "credential_2", HASH_A).await.is_none()); +} + +#[tokio::test] +async fn reupload_replaces_and_delete_forgets() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + record(&db, "higgsfield", "credential_1", HASH_A, "media-old", Some("https://old")).await; + touch_asset_upload_reused(&db, "higgsfield", "credential_1", HASH_A).await.unwrap(); + + record(&db, "higgsfield", "credential_1", HASH_A, "media-new", None).await; + let row = lookup(&db, "higgsfield", "credential_1", HASH_A).await.unwrap(); + assert_eq!(row.service_id, "media-new"); + assert!(row.service_url.is_none()); + assert!(row.last_reused_at.is_none(), "a fresh upload resets the reuse marker"); + + assert!(delete_asset_upload(&db, "higgsfield", "credential_1", HASH_A).await.unwrap()); + assert!(!delete_asset_upload(&db, "higgsfield", "credential_1", HASH_A).await.unwrap()); + assert!(lookup(&db, "higgsfield", "credential_1", HASH_A).await.is_none()); +} + +// ── Helpers ── + +async fn test_db(dir: &tempfile::TempDir) -> LocalFilesDbConnection { + LocalFilesDbConnection::connect_and_migrate(dir.path().join("local_files.sqlite")) + .await + .expect("connect and migrate") +} + +async fn record(db: &LocalFilesDbConnection, service: &str, account_id: &str, hash: &str, service_id: &str, url: Option<&str>) { + upsert_asset_upload(UpsertAssetUploadArgs { + db, + service, + account_id, + file_hash_blake3: hash, + service_id, + origin: "upload", + maybe_service_url: url, + maybe_file_size_bytes: Some(1234), + }).await.expect("upsert"); +} + +async fn lookup(db: &LocalFilesDbConnection, service: &str, account_id: &str, hash: &str) -> Option { + get_asset_upload(GetAssetUploadArgs { db, service, account_id, file_hash_blake3: hash }).await.expect("get") +} diff --git a/crates/schema/local_files_database/tests/local_file_queries.rs b/crates/schema/local_files_database/tests/local_file_queries.rs new file mode 100644 index 00000000..341e53a4 --- /dev/null +++ b/crates/schema/local_files_database/tests/local_file_queries.rs @@ -0,0 +1,219 @@ +//! Integration tests against a throwaway migrated database in a tempdir. + +use local_files_database::connection::LocalFilesDbConnection; +use local_files_database::queries::get_local_file_by_path::get_local_file_by_path; +use local_files_database::queries::get_local_files_by_hash::get_local_files_by_hash; +use local_files_database::queries::get_local_files_by_paths::get_local_files_by_paths; +use local_files_database::queries::list_local_files_needing_thumbnails::list_local_files_needing_thumbnails; +use local_files_database::queries::set_thumbnail_result::{set_thumbnail_result, SetThumbnailResultArgs}; +use local_files_database::queries::upsert_local_file::{upsert_local_file, UpsertLocalFileArgs}; +use local_files_database::thumbnail_state::ThumbnailState; + +const HASH_A: &str = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; +const GENERATOR_VERSION: i64 = 2; +const HASH_B: &str = "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"; + +#[tokio::test] +async fn insert_read_and_stat_matching() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + assert!(get_local_file_by_path(&db, "/a/video.mp4").await.unwrap().is_none()); + + upsert(&db, "/a/video.mp4", 1000, 111, HASH_A).await; + let record = get_local_file_by_path(&db, "/a/video.mp4").await.unwrap().unwrap(); + assert_eq!(record.file_hash_blake3, HASH_A); + assert_eq!(record.file_type.as_deref(), Some("mp4")); + assert!(!record.has_thumbnail); + assert_eq!(record.thumbnail_state(), ThumbnailState::Pending); + assert_eq!(record.thumbnail_attempts, 0); + assert!(record.matches_stat(1000, 111)); + assert!(!record.matches_stat(1000, 222)); + assert!(!record.matches_stat(999, 111)); +} + +#[tokio::test] +async fn thumbnail_result_survives_same_hash_upsert_but_resets_on_new_hash() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + upsert(&db, "/a/video.mp4", 1000, 111, HASH_A).await; + assert!(record_generated(&db, "/a/video.mp4", true).await); + assert!(!record_generated(&db, "/missing", true).await); + + // Same content re-upserted (e.g. mtime refreshed): bookkeeping survives. + upsert(&db, "/a/video.mp4", 1000, 222, HASH_A).await; + let record = get_local_file_by_path(&db, "/a/video.mp4").await.unwrap().unwrap(); + assert!(record.has_thumbnail); + assert!(record.has_animated_preview); + assert_eq!(record.thumbnail_state(), ThumbnailState::Generated); + assert_eq!(record.thumbnail_attempts, 1); + assert_eq!(record.thumbnail_generator_version, GENERATOR_VERSION); + assert_eq!(record.thumbnail_jpg_path.as_deref(), Some("/cache/a.jpg")); + assert_eq!(record.animated_preview_webp_path.as_deref(), Some("/cache/a.webp")); + assert!(record.thumbnail_updated_at.is_some()); + assert_eq!(record.file_mtime_ms, 222); + + // File overwritten in place with new content: everything resets. + upsert(&db, "/a/video.mp4", 2000, 333, HASH_B).await; + let record = get_local_file_by_path(&db, "/a/video.mp4").await.unwrap().unwrap(); + assert!(!record.has_thumbnail); + assert!(!record.has_animated_preview); + assert_eq!(record.thumbnail_state(), ThumbnailState::Pending); + assert_eq!(record.thumbnail_attempts, 0); + assert!(record.thumbnail_jpg_path.is_none()); + assert!(record.animated_preview_webp_path.is_none()); + assert_eq!(record.thumbnail_generator_version, 0); + assert_eq!(record.file_hash_blake3, HASH_B); +} + +#[tokio::test] +async fn failures_count_attempts_and_keep_the_error() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + upsert(&db, "/a/video.mp4", 1000, 111, HASH_A).await; + + set_thumbnail_result(SetThumbnailResultArgs { + db: &db, + file_path: "/a/video.mp4", + state: ThumbnailState::Failed, + generator_version: GENERATOR_VERSION, + maybe_thumbnail_jpg_path: None, + maybe_animated_preview_webp_path: None, + maybe_error: Some("decoder exploded"), + }).await.unwrap(); + + let record = get_local_file_by_path(&db, "/a/video.mp4").await.unwrap().unwrap(); + assert_eq!(record.thumbnail_state(), ThumbnailState::Failed); + assert_eq!(record.thumbnail_attempts, 1); + assert_eq!(record.thumbnail_last_error.as_deref(), Some("decoder exploded")); + assert!(!record.has_thumbnail); + + // A later success clears the error. + assert!(record_generated(&db, "/a/video.mp4", false).await); + let record = get_local_file_by_path(&db, "/a/video.mp4").await.unwrap().unwrap(); + assert_eq!(record.thumbnail_attempts, 2); + assert!(record.thumbnail_last_error.is_none()); + assert!(record.has_thumbnail); + assert!(!record.has_animated_preview); +} + +#[tokio::test] +async fn worker_scan_lists_pending_and_retryable_failures_only() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + upsert(&db, "/pending.mp4", 1, 1, HASH_A).await; + upsert(&db, "/generated.mp4", 1, 1, HASH_A).await; + upsert(&db, "/unsupported.mp4", 1, 1, HASH_A).await; + upsert(&db, "/failed_once.mp4", 1, 1, HASH_A).await; + upsert(&db, "/failed_thrice.mp4", 1, 1, HASH_A).await; + + record_generated(&db, "/generated.mp4", true).await; + record_state(&db, "/unsupported.mp4", ThumbnailState::Unsupported).await; + record_state(&db, "/failed_once.mp4", ThumbnailState::Failed).await; + for _ in 0..3 { + record_state(&db, "/failed_thrice.mp4", ThumbnailState::Failed).await; + } + + let mut paths: Vec = list_local_files_needing_thumbnails(&db, 3, GENERATOR_VERSION, 100).await.unwrap() + .into_iter() + .map(|record| record.file_path) + .collect(); + paths.sort(); + assert_eq!(paths, vec!["/failed_once.mp4".to_string(), "/pending.mp4".to_string()]); + + let limited = list_local_files_needing_thumbnails(&db, 3, GENERATOR_VERSION, 1).await.unwrap(); + assert_eq!(limited.len(), 1); + + // A newer generator makes every generated row owed again. + let mut paths: Vec = list_local_files_needing_thumbnails(&db, 3, GENERATOR_VERSION + 1, 100).await.unwrap() + .into_iter() + .map(|record| record.file_path) + .collect(); + paths.sort(); + assert_eq!(paths, vec!["/failed_once.mp4".to_string(), "/generated.mp4".to_string(), "/pending.mp4".to_string()]); +} + +#[tokio::test] +async fn hash_lookup_finds_duplicate_paths() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + upsert(&db, "/a/video.mp4", 1000, 111, HASH_A).await; + upsert(&db, "/b/copy.mp4", 1000, 999, HASH_A).await; + upsert(&db, "/c/other.mp4", 500, 111, HASH_B).await; + + let matches = get_local_files_by_hash(&db, HASH_A).await.unwrap(); + assert_eq!(matches.len(), 2); + assert_eq!(matches[0].file_path, "/a/video.mp4"); + assert_eq!(matches[1].file_path, "/b/copy.mp4"); +} + +#[tokio::test] +async fn batch_path_lookup_skips_unknown_paths() { + let dir = tempfile::tempdir().unwrap(); + let db = test_db(&dir).await; + + upsert(&db, "/a/video.mp4", 1000, 111, HASH_A).await; + upsert(&db, "/b/copy.mp4", 1000, 999, HASH_A).await; + + let empty = get_local_files_by_paths(&db, &[]).await.unwrap(); + assert!(empty.is_empty()); + + let paths = vec!["/a/video.mp4".to_string(), "/nope.mp4".to_string(), "/b/copy.mp4".to_string()]; + let found = get_local_files_by_paths(&db, &paths).await.unwrap(); + assert_eq!(found.len(), 2); + assert!(found.contains_key("/a/video.mp4")); + assert!(found.contains_key("/b/copy.mp4")); + assert!(!found.contains_key("/nope.mp4")); +} + +// ── Helpers ── + +async fn test_db(dir: &tempfile::TempDir) -> LocalFilesDbConnection { + LocalFilesDbConnection::connect_and_migrate(dir.path().join("local_files.sqlite")) + .await + .expect("connect and migrate") +} + +async fn upsert(db: &LocalFilesDbConnection, path: &str, size: i64, mtime: i64, hash: &str) { + upsert_local_file(UpsertLocalFileArgs { + db, + file_path: path, + maybe_file_type: Some("mp4"), + file_size_bytes: size, + file_mtime_ms: mtime, + file_hash_blake3: hash, + }) + .await + .expect("upsert"); +} + +async fn record_generated(db: &LocalFilesDbConnection, path: &str, with_animated: bool) -> bool { + set_thumbnail_result(SetThumbnailResultArgs { + db, + file_path: path, + state: ThumbnailState::Generated, + generator_version: GENERATOR_VERSION, + maybe_thumbnail_jpg_path: Some("/cache/a.jpg"), + maybe_animated_preview_webp_path: with_animated.then_some("/cache/a.webp"), + maybe_error: None, + }) + .await + .expect("set result") +} + +async fn record_state(db: &LocalFilesDbConnection, path: &str, state: ThumbnailState) { + set_thumbnail_result(SetThumbnailResultArgs { + db, + file_path: path, + state, + generator_version: GENERATOR_VERSION, + maybe_thumbnail_jpg_path: None, + maybe_animated_preview_webp_path: None, + maybe_error: Some("nope"), + }) + .await + .expect("set result"); +} diff --git a/crates/schema/sqlite_database/Cargo.toml b/crates/schema/sqlite_database/Cargo.toml new file mode 100644 index 00000000..c5cc1b83 --- /dev/null +++ b/crates/schema/sqlite_database/Cargo.toml @@ -0,0 +1,50 @@ +[package] +name = "sqlite_database" +edition = "2024" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "sqlite_database" +path = "src/lib.rs" + +[dependencies] +core_types.workspace = true +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true +sqlite_identifiers.workspace = true + +# External +anyhow.workspace = true +chrono.workspace = true +log.workspace = true + +# TODO(bt,2025-07-09): Update sqlx ASAP. We're stuck on 0.7 because of the complex use of internal types and macros in the database crate. +# We're going to embed in-memory SQLite +sqlx = { package = "sqlx", version = "0.7.4", features = ["runtime-tokio-rustls", "sqlite", "chrono"] } + +# Needed to safety check some queries we can't use escaping for +once_cell.workspace = true +regex.workspace = true + +# Serialization +serde.workspace = true +serde_derive.workspace = true +serde_json.workspace = true + +[dev-dependencies] +# Integration tests run queries against a throwaway migrated database. +tempfile.workspace = true +tokio = { workspace = true, features = ["macros", "rt-multi-thread"] } +# serial_test = "3.0.0" + +[build-dependencies] +tempfile.workspace = true +sqlx = { package = "sqlx", version = "0.7.4", features = ["runtime-tokio-rustls", "sqlite", "chrono"] } +#rusqlite = "0.25.4" # NB: For the build.rs file diff --git a/crates/schema/sqlite_database/build.rs b/crates/schema/sqlite_database/build.rs new file mode 100644 index 00000000..2296d83b --- /dev/null +++ b/crates/schema/sqlite_database/build.rs @@ -0,0 +1,40 @@ +use std::env; +use std::path::PathBuf; + +pub fn main() { + // NB: This should help JetBrains' RustRover from highlighting failing query macros, + // but we do not want to interfere with the following: + // + // (1) User development builds + // (2) Tooling to cache offline queries + // (3) CI builds + let family = env::var("CARGO_CFG_TARGET_FAMILY").ok(); + + match family.as_deref() { + Some("unix") => unix_temp_database_pathing(), + Some("windows") => windows_temp_database_pathing(), + _ => { + println!("cargo:warning=Unsupported target family, using Unix temp database pathing."); + unix_temp_database_pathing(); + }, + } +} + +fn unix_temp_database_pathing() { + println!("cargo:rustc-env=DATABASE_URL=sqlite:/tmp/tasks.sqlite"); +} + +fn windows_temp_database_pathing() { + if let Ok(local_app_data) = env::var("LOCALAPPDATA") { + let path = PathBuf::from(local_app_data); + let path = path.join("Temp\\tasks.sqlite"); + let path = path + .to_str() + .expect("path should be valid") + .to_string(); + println!("cargo:warning=LocalAppData path: {}", path); + println!("cargo:rustc-env=DATABASE_URL=sqlite:{}", path); + } else { + panic!("LOCALAPPDATA environment variable not set"); + } +} diff --git a/crates/schema/sqlite_database/migrations/20250708000000_create_tasks_table.sql b/crates/schema/sqlite_database/migrations/20250708000000_create_tasks_table.sql new file mode 100644 index 00000000..c0fb8516 --- /dev/null +++ b/crates/schema/sqlite_database/migrations/20250708000000_create_tasks_table.sql @@ -0,0 +1,136 @@ +-- noinspection SqlDialectInspectionForFile +-- +-- NB: This version needs to be bumped even if just adding or changing comments! +-- Failure to do so will cause Windows to segfault at start. (This is horrible!) +-- +-- NB: `app_state_dir.rs` contains the file version number. +-- +-- Migration history: +-- tasks_v1.sqlite - initial version +-- tasks_v8.sqlite - is_batch_generation, on_complete_directory_location, on_complete_first_file_location + +CREATE TABLE tasks ( + -- Task auto-incrementing primary key. + -- We don't use this. + id TEXT NOT NULL PRIMARY KEY, + + -- TaskStatus enum + -- This is how the job system manages job states. + -- e.g. pending, started, complete_success, dead, etc. + task_status TEXT NOT NULL, + + -- TaskType enum + -- e.g. image_generation, video_generation, etc. + task_type TEXT NOT NULL, + + -- TaskModelType enum + -- e.g. flux_1_dev, veo_2, etc. + model_type TEXT, + + -- GenerationProvider enum + -- Together with `provider_job_id`, this creates a foreign key lookup to the job. + -- e.g. 'artcraft', 'fal', 'sora', etc. + provider TEXT, + + -- The primary key for the job in the provider's system. + -- Sometimes this may not be enough to look up the job + provider_job_id TEXT, + + -- Whether the job produces more than one file (a batch). Written on enqueue. + -- When false, exactly one file is generated. + is_batch_generation INTEGER NOT NULL DEFAULT 0, + + -- TODO: Need to store prompts + -- OPTIONAL. + -- For third party jobs, we need to record the prompt details upfront. + -- We create a prompt record and store the token to associate once the task completes. + prompt_token TEXT, + + -- OPTIONAL. + -- Tell the job system which caller initiated the task. + -- e.g. 'canvas' + frontend_caller TEXT, + + -- OPTIONAL. + -- An arbitrary opaque identifier that frontend can set. + frontend_subscriber_id TEXT, + + -- OPTIONAL. + -- An opaque JSON payload set by the frontend subscriber that + -- will be re-emitted back to the frontend. + frontend_subscriber_payload TEXT, + + -- Whether the user has dismissed the task from view. + is_dismissed_by_user INTEGER NOT NULL DEFAULT 0, + + -- OPTIONAL. + -- For some third party systems (eg. FAL), the URL to check the status of the + -- job in the queue. + queue_status_url TEXT, + + -- OPTIONAL. + -- For some third party systems (eg. FAL), the URL to check the + -- results (when the job completes) + queue_response_url TEXT, + + -- OPTIONAL. + -- If the results were downloaded, the directory they were saved into. + -- Recorded as an absolute path at completion time, so it stays correct + -- even if the preferred download directory changes later. + on_complete_directory_location TEXT, + + -- OPTIONAL. + -- If the results were downloaded, the first file of the batch (or the only + -- file). Absolute path, recorded at completion time. + on_complete_first_file_location TEXT, + + -- TODO: Necessary? Can probably kill this. + -- OPTIONAL. + -- When the generation completes, the batch token (if any). + -- This will point to a collection of multiple files. + on_complete_batch_token TEXT, + + -- TODO: Point to files. Rather, have a files table. + -- OPTIONAL. + -- When the generation completes, the media token of the "primary" media file. + -- We'll probably always generate homogenous types, but just in case this is the first or primary item in a batch. + on_complete_primary_media_file_token TEXT, + + -- TODO: Point to files. Rather, have a files table. + -- TODO: Do we need this? + -- OPTIONAL. + -- When the generation completes, the file type of the primary media file. + -- We'll probably always generate homogenous types, but just in case this is the first or primary item in a batch. + on_complete_primary_media_file_class TEXT, + + -- TODO: Point to files. Rather, have a files table. + -- TODO: Do we need this? + -- OPTIONAL. + -- The URL to the media file. + on_complete_primary_media_file_cdn_url TEXT, + + -- TODO: Point to files. Rather, have a files table. + -- OPTIONAL. + -- The URL template for the thumbnail of the primary media file. + on_complete_primary_media_file_thumbnail_url_template TEXT, + + -- OPTIONAL. + -- An enum-like string describing the failure reason (even for non-terminal failures). + -- The enum is `TaskFailureType`, which is a close analogue of the backend API's `FrontendFailureCategory`. + on_failure_type TEXT, + + -- OPTIONAL. + -- A human-readable message describing the failure reason (even for non-terminal failures). + on_failure_message TEXT, + + created_at INTEGER NOT NULL DEFAULT (unixepoch('now')), + updated_at INTEGER NOT NULL DEFAULT (unixepoch('now')), + completed_at INTEGER DEFAULT NULL +); + +-- Unique Indices +CREATE UNIQUE INDEX idx_tasks_on_provider_job_id ON tasks(provider_job_id); + +-- Indices +CREATE INDEX idx_tasks_on_status ON tasks(task_status); +CREATE INDEX idx_tasks_on_provider ON tasks(provider); diff --git a/crates/schema/sqlite_database/src/connection.rs b/crates/schema/sqlite_database/src/connection.rs new file mode 100644 index 00000000..04a25ed2 --- /dev/null +++ b/crates/schema/sqlite_database/src/connection.rs @@ -0,0 +1,64 @@ +use errors::AnyhowResult; +use log::{error, info}; +use sqlx::migrate::MigrateError; +use sqlx::sqlite::{SqliteConnectOptions, SqliteJournalMode}; +use sqlx::{Pool, Sqlite, SqlitePool}; +use std::path::Path; + +#[derive(Clone)] +pub struct TaskDbConnection { + pool: Pool, +} + +impl TaskDbConnection { + pub async fn connect_and_migrate>(database_file: P) -> AnyhowResult { + { + match run_migrations(&database_file).await { + Ok(pool) => return Ok(Self { pool }), + Err(err) => { + error!("Error running SQLite migrations: {:?}", err); + } + } + + info!("Deleting and recreating SQLite database at {:?}", database_file.as_ref()); + + if let Err(err) = std::fs::remove_file(&database_file) { + error!("Error deleting SQLite database file: {:?}", err); + } + + // NB: Scope change here is an attempt to drop the open file connection for Windows. + // On Windows, we've observed that the file might still be open, preventing deletion: + // [2025-08-08][06:42:29][sqlite_database::connection][INFO] Deleting and recreating SQLite + // database at "C:\Users\User\Artcraft\state\tasks_v2.sqlite" + // [2025-08-08][06:42:29][sqlite_database::connection][ERROR] Error deleting SQLite database + // file: Os { code: 32, kind: Uncategorized, message: "The process cannot access the file + // because it is being used by another process." } + } + + let pool = run_migrations(database_file).await?; + + Ok(Self { pool }) + } + + pub fn get_pool(&self) -> &Pool { + &self.pool + } +} + +async fn run_migrations>(database_file: P) -> Result { + let connection_options = SqliteConnectOptions::new() + .filename(database_file) + .create_if_missing(true) + .journal_mode(SqliteJournalMode::Wal); + + let pool = SqlitePool::connect_with(connection_options).await?; + + // Run migrations regardless of whether the database is new, SQLx will track which migrations + // have been run. + // The migrations text get compiled into the binary, so no worries about build inclusion. + // Since the task database is being treated as ephemeral, we can always run migrations without + // worrying about previous state if we simply blow away old versions of the schema. + sqlx::migrate!().run(&pool).await?; + + Ok(pool) +} diff --git a/crates/schema/sqlite_database/src/error.rs b/crates/schema/sqlite_database/src/error.rs new file mode 100644 index 00000000..72ac3821 --- /dev/null +++ b/crates/schema/sqlite_database/src/error.rs @@ -0,0 +1,45 @@ +use core_types::enums::enum_error::EnumError as CoreEnumError; +use sqlite_identifiers::enums::enum_error::EnumError; +use std::error::Error; +use std::fmt::{Display, Formatter}; + +#[derive(Debug)] +pub enum SqliteTasksError { + SqlxError(sqlx::Error), + EnumError(EnumError), + //TaskNotFound, + //TaskAlreadyExists, + //InvalidTaskStatus, + //InvalidTaskType, + //InvalidGenerationProvider, +} + +impl Error for SqliteTasksError {} + +impl Display for SqliteTasksError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + SqliteTasksError::SqlxError(err) => write!(f, "SQLx error: {:?}", err), + SqliteTasksError::EnumError(err) => write!(f, "Error parsing enum: {:?}", err), + } + } +} + +impl From for SqliteTasksError { + fn from(err: sqlx::Error) -> Self { + SqliteTasksError::SqlxError(err) + } +} + +impl From for SqliteTasksError { + fn from(err: EnumError) -> Self { + SqliteTasksError::EnumError(err) + } +} + +impl From for SqliteTasksError { + fn from(err: CoreEnumError) -> Self { + let CoreEnumError::CouldNotConvertFromString(value) = err; + SqliteTasksError::EnumError(EnumError::CouldNotConvertFromString(value)) + } +} diff --git a/crates/schema/sqlite_database/src/lib.rs b/crates/schema/sqlite_database/src/lib.rs new file mode 100644 index 00000000..eeb20485 --- /dev/null +++ b/crates/schema/sqlite_database/src/lib.rs @@ -0,0 +1,23 @@ +//! sqlite_database +//! +//! sqlx is happier with different compilation units? So be it! +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod connection; +pub mod error; +pub mod queries; diff --git a/crates/schema/sqlite_database/src/queries/create/create_task.rs b/crates/schema/sqlite_database/src/queries/create/create_task.rs new file mode 100644 index 00000000..1bc4c2b4 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/create/create_task.rs @@ -0,0 +1,78 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlite_identifiers::ids::prompt_token::PromptToken; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct CreateTaskArgs<'a> { + pub db: &'a TaskDbConnection, + pub status: TaskStatus, + pub task_type: TaskType, + pub model_type: Option, + pub provider: GenerationSource, + pub provider_job_id: Option<&'a str>, + /// Whether the job produces more than one file. + pub is_batch_generation: bool, + pub queue_status_url: Option<&'a str>, + pub queue_response_url: Option<&'a str>, + pub prompt_token: Option<&'a PromptToken>, + pub frontend_caller: Option, + pub frontend_subscriber_id: Option<&'a str>, + pub frontend_subscriber_payload: Option<&'a str>, +} + +pub async fn create_task( + args: CreateTaskArgs<'_>, +) -> Result { + let task_id = TaskId::generate(); + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let task_id_temp = task_id.as_str(); + let status_temp = args.status.to_str(); + let task_type_temp = args.task_type.to_str(); + let model_type_temp = args.model_type.map(|s| s.to_str()); + let provider_temp = args.provider.to_string(); + let prompt_token_temp = args.prompt_token.map(|t| t.as_str()); + let frontend_caller_temp = args.frontend_caller.map(|s| s.to_str()); + + let query = sqlx::query!(r#" + INSERT INTO tasks ( + id, + task_status, + task_type, + model_type, + provider, + provider_job_id, + is_batch_generation, + queue_status_url, + queue_response_url, + prompt_token, + frontend_caller, + frontend_subscriber_id, + frontend_subscriber_payload + ) + VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?) + "#, + task_id_temp, + status_temp, + task_type_temp, + model_type_temp, + provider_temp, + args.provider_job_id, + args.is_batch_generation, + args.queue_status_url, + args.queue_response_url, + prompt_token_temp, + frontend_caller_temp, + args.frontend_subscriber_id, + args.frontend_subscriber_payload + ); + + let _r = query.execute(args.db.get_pool()).await?; + + Ok(task_id) +} diff --git a/crates/schema/sqlite_database/src/queries/create/mod.rs b/crates/schema/sqlite_database/src/queries/create/mod.rs new file mode 100644 index 00000000..78dfb6c8 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/create/mod.rs @@ -0,0 +1 @@ +pub mod create_task; diff --git a/crates/schema/sqlite_database/src/queries/mod.rs b/crates/schema/sqlite_database/src/queries/mod.rs new file mode 100644 index 00000000..4de86f8f --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/mod.rs @@ -0,0 +1,4 @@ +pub mod create; +pub mod read; +pub mod task; +pub mod update; diff --git a/crates/schema/sqlite_database/src/queries/read/get_task_by_provider_and_provider_job_id.rs b/crates/schema/sqlite_database/src/queries/read/get_task_by_provider_and_provider_job_id.rs new file mode 100644 index 00000000..78067992 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/get_task_by_provider_and_provider_job_id.rs @@ -0,0 +1,86 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use crate::queries::task::Task; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlx::Error; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct GetTaskByProviderAndProviderJobIdArgs<'a> { + pub db: &'a TaskDbConnection, + pub provider: GenerationSource, + pub provider_job_id: &'a str, +} + + +pub async fn get_task_by_provider_and_provider_job_id( + args: GetTaskByProviderAndProviderJobIdArgs<'_>, +) -> Result, SqliteTasksError> { + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let temp_provider = args.provider.to_str(); + let temp_provider_job_id = args.provider_job_id; + + let query = sqlx::query!(r#" + SELECT + id, + task_status, + task_type, + model_type, + provider, + provider_job_id, + is_batch_generation, + frontend_caller, + queue_status_url, + queue_response_url, + prompt_token, + frontend_subscriber_id, + frontend_subscriber_payload + FROM tasks + WHERE + provider = ? + AND provider_job_id = ? + "#, + temp_provider, + temp_provider_job_id, + ); + + // info!("Query: {:?}", query.sql()); + + let result = query.fetch_one(args.db.get_pool()).await; + + let record = match result { + Ok(record) => record, + Err(err) => return match err { + Error::RowNotFound => Ok(None), + _ => Err(err.into()), + }, + }; + + // NB: Not sure why query can't figure out this isn't nullable + let provider = record.provider.as_deref() + .unwrap_or_else(|| args.provider.to_str()); + + Ok(Some(Task { + id: TaskId::new_from_str(&record.id), + status: TaskStatus::from_str(&record.task_status)?, + task_type: TaskType::from_str(&record.task_type)?, + model_type: record.model_type + .map(|model| TaskModelType::from_str(&model)) + .transpose()?, + provider: GenerationSource::from_str(provider)?, + provider_job_id: record.provider_job_id, + is_batch_generation: record.is_batch_generation != 0, + queue_status_url: record.queue_status_url, + queue_response_url: record.queue_response_url, + prompt_token: record.prompt_token, + frontend_caller: record.frontend_caller + .map(|caller| TauriCommandCaller::from_str(&caller)) + .transpose()?, + frontend_subscriber_id: record.frontend_subscriber_id, + frontend_subscriber_payload: record.frontend_subscriber_payload, + })) +} diff --git a/crates/schema/sqlite_database/src/queries/read/list_completed_task_download_files.rs b/crates/schema/sqlite_database/src/queries/read/list_completed_task_download_files.rs new file mode 100644 index 00000000..aa838d84 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/list_completed_task_download_files.rs @@ -0,0 +1,30 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::enums::task_status::TaskStatus; + +/// The first downloaded file of the most recently completed tasks (newest +/// first). Feeds the thumbnail worker's periodic scan: anything here without +/// a generated thumbnail is work. +/// +/// NB: A runtime query on purpose — it needs no compile-time schema and +/// avoids regenerating the `.sqlx` offline data for a read-only scan. +pub async fn list_completed_task_download_files( + db: &TaskDbConnection, + limit: i64, +) -> Result, SqliteTasksError> { + let rows: Vec<(String,)> = sqlx::query_as( + r#" + SELECT on_complete_first_file_location + FROM tasks + WHERE task_status = ?1 + AND on_complete_first_file_location IS NOT NULL + ORDER BY completed_at DESC + LIMIT ?2 + "#, + ) + .bind(TaskStatus::CompleteSuccess.to_str()) + .bind(limit) + .fetch_all(db.get_pool()) + .await?; + Ok(rows.into_iter().map(|(path,)| path).collect()) +} diff --git a/crates/schema/sqlite_database/src/queries/read/list_non_artcraft_pending_tasks.rs b/crates/schema/sqlite_database/src/queries/read/list_non_artcraft_pending_tasks.rs new file mode 100644 index 00000000..16e368b7 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/list_non_artcraft_pending_tasks.rs @@ -0,0 +1,86 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use crate::queries::task::{RawTask, Task}; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlx::{QueryBuilder, Sqlite}; +use std::collections::HashSet; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct ListNonArtcraftPendingTasksArgs<'a> { + pub db: &'a TaskDbConnection, + pub task_statuses: &'a HashSet, +} + +pub struct NonArtcraftTaskList { + pub tasks: Vec, +} + +/// List all tasks that are NOT from the Artcraft provider and match the given statuses. +pub async fn list_non_artcraft_pending_tasks( + args: ListNonArtcraftPendingTasksArgs<'_>, +) -> Result { + let artcraft_provider = GenerationSource::Artcraft.to_string(); + + let mut query_builder: QueryBuilder = QueryBuilder::new(r#" + SELECT + id, + task_status, + task_type, + model_type, + provider, + provider_job_id, + is_batch_generation, + queue_status_url, + queue_response_url, + prompt_token, + frontend_caller, + frontend_subscriber_id, + frontend_subscriber_payload + FROM tasks + WHERE provider != + "#); + + query_builder.push_bind(artcraft_provider); + + if !args.task_statuses.is_empty() { + query_builder.push(" AND task_status IN ("); + let mut separated = query_builder.separated(", "); + for task_status in args.task_statuses.into_iter() { + separated.push_bind(task_status.to_str()); + } + separated.push_unseparated(") "); + } + + let query = query_builder.build_query_as::(); + let results = query.fetch_all(args.db.get_pool()).await?; + + let mut tasks: Vec = Vec::new(); + + for task in results { + tasks.push(Task { + id: TaskId::new_from_str(&task.id), + status: TaskStatus::from_str(&task.task_status)?, + task_type: TaskType::from_str(&task.task_type)?, + model_type: task.model_type + .map(|model| TaskModelType::from_str(&model)) + .transpose()?, + provider: GenerationSource::from_str(&task.provider)?, + provider_job_id: task.provider_job_id, + is_batch_generation: task.is_batch_generation, + queue_status_url: task.queue_status_url, + queue_response_url: task.queue_response_url, + prompt_token: task.prompt_token, + frontend_caller: task.frontend_caller + .map(|caller| TauriCommandCaller::from_str(&caller)) + .transpose()?, + frontend_subscriber_id: task.frontend_subscriber_id, + frontend_subscriber_payload: task.frontend_subscriber_payload, + }); + } + + Ok(NonArtcraftTaskList { tasks }) +} diff --git a/crates/schema/sqlite_database/src/queries/read/list_tasks_by_provider_and_status.rs b/crates/schema/sqlite_database/src/queries/read/list_tasks_by_provider_and_status.rs new file mode 100644 index 00000000..bbcb598c --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/list_tasks_by_provider_and_status.rs @@ -0,0 +1,95 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use crate::queries::task::{RawTask, Task}; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlx::{QueryBuilder, Sqlite}; +use std::collections::HashSet; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct ListTasksByProviderAndStatusArgs<'a> { + pub db: &'a TaskDbConnection, + pub provider: GenerationSource, + pub task_statuses: &'a HashSet, +} + +pub struct TaskList { + pub tasks: Vec, +} + +pub async fn list_tasks_by_provider_and_status( + args: ListTasksByProviderAndStatusArgs<'_>, +) -> Result { + + let mut query_builder: QueryBuilder = QueryBuilder::new(r#" + SELECT + id, + task_status, + task_type, + model_type, + provider, + provider_job_id, + is_batch_generation, + queue_status_url, + queue_response_url, + prompt_token, + frontend_caller, + frontend_subscriber_id, + frontend_subscriber_payload + FROM tasks + WHERE provider = + "#); + + // TODO(bt,2025-07-15): Fix this. The sqlx mysql queries never required temporaries + let provider = args.provider.to_string(); + + query_builder.push_bind(provider); + + if !args.task_statuses.is_empty() { + query_builder.push(" AND task_status IN ("); + let mut separated = query_builder.separated(", "); + + for task_status in args.task_statuses.into_iter() { + separated.push_bind(task_status.to_str()); + } + + separated.push_unseparated(") "); + } + + let query = query_builder.build_query_as::(); + + // info!("Query: {:?}", query.sql()); + + let results = query.fetch_all(args.db.get_pool()).await?; + + let mut tasks: Vec = Vec::new(); + + for task in results { + tasks.push(Task { + id: TaskId::new_from_str(&task.id), + status: TaskStatus::from_str(&task.task_status)?, + task_type: TaskType::from_str(&task.task_type)?, + model_type: task.model_type + .map(|model| TaskModelType::from_str(&model)) + .transpose()?, + provider: GenerationSource::from_str(&task.provider)?, + provider_job_id: task.provider_job_id, + is_batch_generation: task.is_batch_generation, + queue_status_url: task.queue_status_url, + queue_response_url: task.queue_response_url, + prompt_token: task.prompt_token, + frontend_caller: task.frontend_caller + .map(|caller| TauriCommandCaller::from_str(&caller)) + .transpose()?, + frontend_subscriber_id: task.frontend_subscriber_id, + frontend_subscriber_payload: task.frontend_subscriber_payload, + }); + } + + Ok(TaskList { + tasks, + }) +} diff --git a/crates/schema/sqlite_database/src/queries/read/list_tasks_by_provider_and_tokens.rs b/crates/schema/sqlite_database/src/queries/read/list_tasks_by_provider_and_tokens.rs new file mode 100644 index 00000000..07eaf1c0 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/list_tasks_by_provider_and_tokens.rs @@ -0,0 +1,94 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use crate::queries::task::{RawTask, Task}; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlx::{QueryBuilder, Sqlite}; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct ListTasksArgs<'a> { + pub db: &'a TaskDbConnection, + pub provider: GenerationSource, + pub provider_job_ids: Option>, +} + +pub struct TaskList { + pub tasks: Vec, +} + +pub async fn list_tasks_by_provider_and_tokens( + args: ListTasksArgs<'_>, +) -> Result { + + let mut query_builder: QueryBuilder = QueryBuilder::new(r#" + SELECT + id, + task_status, + task_type, + model_type, + provider, + provider_job_id, + is_batch_generation, + frontend_caller, + queue_status_url, + queue_response_url, + prompt_token, + frontend_subscriber_id, + frontend_subscriber_payload + FROM tasks + WHERE provider = + "#); + + // TODO(bt,2025-07-15): Fix this. The sqlx mysql queries never required temporaries + let provider = args.provider.to_string(); + + query_builder.push_bind(provider); + + if let Some(provider_job_ids) = args.provider_job_ids { + query_builder.push(" AND provider_job_id IN ("); + let mut separated = query_builder.separated(", "); + + for job_id in provider_job_ids.into_iter() { + separated.push_bind(job_id); + } + + separated.push_unseparated(") "); + } + + let query = query_builder.build_query_as::(); + + // info!("Query: {:?}", query.sql()); + + let results = query.fetch_all(args.db.get_pool()).await?; + + let mut tasks: Vec = Vec::new(); + + for task in results { + tasks.push(Task { + id: TaskId::new_from_str(&task.id), + status: TaskStatus::from_str(&task.task_status)?, + task_type: TaskType::from_str(&task.task_type)?, + model_type: task.model_type + .map(|model| TaskModelType::from_str(&model)) + .transpose()?, + provider: GenerationSource::from_str(&task.provider)?, + provider_job_id: task.provider_job_id, + is_batch_generation: task.is_batch_generation, + queue_status_url: task.queue_status_url, + queue_response_url: task.queue_response_url, + prompt_token: task.prompt_token, + frontend_caller: task.frontend_caller + .map(|caller| TauriCommandCaller::from_str(&caller)) + .transpose()?, + frontend_subscriber_id: task.frontend_subscriber_id, + frontend_subscriber_payload: task.frontend_subscriber_payload, + }); + } + + Ok(TaskList { + tasks, + }) +} diff --git a/crates/schema/sqlite_database/src/queries/read/list_tasks_for_frontend.rs b/crates/schema/sqlite_database/src/queries/read/list_tasks_for_frontend.rs new file mode 100644 index 00000000..ac114c10 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/list_tasks_for_frontend.rs @@ -0,0 +1,148 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use chrono::{DateTime, Utc}; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct TaskList { + pub tasks: Vec, +} + +pub struct TaskItem { + pub id: TaskId, + pub status: TaskStatus, + pub task_type: TaskType, + pub model_type: Option, + pub provider: Option, + pub provider_job_id: Option, + pub is_batch_generation: bool, + pub frontend_caller: Option, + pub frontend_subscriber_id: Option, + pub frontend_subscriber_payload: Option, + pub on_complete_primary_media_file_token: Option, + pub on_complete_primary_media_file_class: Option, + pub on_complete_batch_token: Option, + pub on_complete_primary_media_file_cdn_url: Option, + pub on_complete_primary_media_file_thumbnail_url_template: Option, + /// Where the results were downloaded, if they were (absolute paths). + pub on_complete_directory_location: Option, + pub on_complete_first_file_location: Option, + pub on_failure_type: Option, + pub on_failure_message: Option, + pub created_at: DateTime, + pub updated_at: DateTime, + pub completed_at: Option>, +} + +pub async fn list_tasks_for_frontend( + db: & TaskDbConnection +) -> Result { + let query = sqlx::query_as!( + TaskItemRaw, + r#" + SELECT + id, + task_status, + task_type, + model_type, + provider, + provider_job_id, + is_batch_generation, + frontend_caller, + frontend_subscriber_id, + frontend_subscriber_payload, + on_complete_primary_media_file_token, + on_complete_primary_media_file_class, + on_complete_batch_token, + on_complete_primary_media_file_cdn_url, + on_complete_primary_media_file_thumbnail_url_template, + on_complete_directory_location, + on_complete_first_file_location, + on_failure_type, + on_failure_message, + created_at as "created_at: DateTime", + updated_at as "updated_at: DateTime", + completed_at as "completed_at: DateTime" + FROM tasks + WHERE is_dismissed_by_user == 0 + "#); + + let result = query.fetch_all(db.get_pool()) + .await?; + + let mut tasks = Vec::with_capacity(result.len()); + + for raw in result.into_iter() { + tasks.push(TaskItem { + id: TaskId::new(raw.id), + status: TaskStatus::from_str(&raw.task_status)?, + task_type: TaskType::from_str(&raw.task_type)?, + model_type: raw.model_type + .map(|model| TaskModelType::from_str(&model)) + .transpose()?, + provider: raw.provider + .map(|provider| GenerationSource::from_str(&provider)) + .transpose()?, + provider_job_id: raw.provider_job_id, + is_batch_generation: raw.is_batch_generation != 0, + frontend_caller: raw.frontend_caller + .map(|caller| TauriCommandCaller::from_str(&caller)) + .transpose()?, + frontend_subscriber_id: raw.frontend_subscriber_id, + frontend_subscriber_payload: raw.frontend_subscriber_payload, + on_complete_primary_media_file_token: raw.on_complete_primary_media_file_token.map(|t| MediaFileToken::new_from_str(&t)), + on_complete_primary_media_file_class: raw.on_complete_primary_media_file_class + .map(|c| TaskMediaFileClass::from_str(&c)) + .transpose()?, + on_complete_batch_token: raw.on_complete_batch_token.map(|t| BatchGenerationToken::new_from_str(&t)), + on_complete_primary_media_file_cdn_url: raw.on_complete_primary_media_file_cdn_url, + on_complete_primary_media_file_thumbnail_url_template: raw.on_complete_primary_media_file_thumbnail_url_template, + on_complete_directory_location: raw.on_complete_directory_location, + on_complete_first_file_location: raw.on_complete_first_file_location, + on_failure_type: raw.on_failure_type + .map(|t| TaskFailureType::from_str(&t)) + .transpose()?, + on_failure_message: raw.on_failure_message, + created_at: raw.created_at, + updated_at: raw.updated_at, + completed_at: raw.completed_at, + }) + } + + Ok(TaskList { + tasks, + }) +} + +struct TaskItemRaw { + id: String, + task_status: String, + task_type: String, + model_type: Option, + provider: Option, + provider_job_id: Option, + is_batch_generation: i64, + frontend_caller: Option, + frontend_subscriber_id: Option, + frontend_subscriber_payload: Option, + on_complete_primary_media_file_token: Option, + on_complete_primary_media_file_class: Option, + on_complete_batch_token: Option, + on_complete_primary_media_file_cdn_url: Option, + on_complete_primary_media_file_thumbnail_url_template: Option, + on_complete_directory_location: Option, + on_complete_first_file_location: Option, + on_failure_type: Option, + on_failure_message: Option, + created_at: DateTime, + updated_at: DateTime, + completed_at: Option>, +} diff --git a/crates/schema/sqlite_database/src/queries/read/mod.rs b/crates/schema/sqlite_database/src/queries/read/mod.rs new file mode 100644 index 00000000..23557773 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/read/mod.rs @@ -0,0 +1,6 @@ +pub mod get_task_by_provider_and_provider_job_id; +pub mod list_completed_task_download_files; +pub mod list_non_artcraft_pending_tasks; +pub mod list_tasks_by_provider_and_status; +pub mod list_tasks_by_provider_and_tokens; +pub mod list_tasks_for_frontend; diff --git a/crates/schema/sqlite_database/src/queries/task.rs b/crates/schema/sqlite_database/src/queries/task.rs new file mode 100644 index 00000000..a9a902ad --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/task.rs @@ -0,0 +1,42 @@ +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_model_type::TaskModelType; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::enums::tauri_command_caller::TauriCommandCaller; +use sqlite_identifiers::ids::task_id::TaskId; + +#[derive(Debug, Clone)] +pub struct Task { + pub id: TaskId, + pub status: TaskStatus, + pub task_type: TaskType, + pub model_type: Option, + pub provider: GenerationSource, + pub provider_job_id: Option, + /// The job produces more than one file. Written on enqueue. + pub is_batch_generation: bool, + pub queue_status_url: Option, + pub queue_response_url: Option, + pub prompt_token: Option, + pub frontend_caller: Option, + pub frontend_subscriber_id: Option, + pub frontend_subscriber_payload: Option, +} + +#[derive(Debug)] +#[derive(sqlx::FromRow)] +pub (crate) struct RawTask { + pub (crate) id: String, + pub (crate) task_status: String, + pub (crate) task_type: String, + pub (crate) model_type: Option, + pub (crate) provider: String, + pub (crate) provider_job_id: Option, + pub (crate) is_batch_generation: bool, + pub (crate) queue_status_url: Option, + pub (crate) queue_response_url: Option, + pub (crate) prompt_token: Option, + pub (crate) frontend_caller: Option, + pub (crate) frontend_subscriber_id: Option, + pub (crate) frontend_subscriber_payload: Option, +} diff --git a/crates/schema/sqlite_database/src/queries/update/dismiss_all_tasks.rs b/crates/schema/sqlite_database/src/queries/update/dismiss_all_tasks.rs new file mode 100644 index 00000000..fb2e7c7e --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/dismiss_all_tasks.rs @@ -0,0 +1,19 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; + +/// Mark everything as dismissed. +pub async fn dismiss_all_tasks( + db: &TaskDbConnection, +) -> Result { + + let query = sqlx::query!(r#" + UPDATE tasks + SET is_dismissed_by_user = 1 + WHERE is_dismissed_by_user != 1 + "#); + + let res = query.execute(db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/src/queries/update/mark_task_as_dismissed.rs b/crates/schema/sqlite_database/src/queries/update/mark_task_as_dismissed.rs new file mode 100644 index 00000000..a588a1b0 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/mark_task_as_dismissed.rs @@ -0,0 +1,27 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::ids::task_id::TaskId; + +/// Returns true if rows were updated. +pub async fn mark_task_as_dismissed( + db: &TaskDbConnection, + task_id: &TaskId, +) -> Result { + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let task_id_temp = task_id.as_str(); + + // TODO(bt,2025-07-15): We can't set a LIMIT without a certain compiler flag for SQLite ? + let query = sqlx::query!(r#" + UPDATE tasks + SET is_dismissed_by_user = 1 + WHERE id = ? + "#, + task_id_temp, + ); + + let res = query.execute(db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/src/queries/update/mod.rs b/crates/schema/sqlite_database/src/queries/update/mod.rs new file mode 100644 index 00000000..3c2cbc7b --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/mod.rs @@ -0,0 +1,8 @@ +pub mod dismiss_all_tasks; +pub mod mark_task_as_dismissed; +pub mod nuke_all_tasks; +pub mod update_successful_task_status_with_metadata; +pub mod update_successful_task_status_with_metadata_by_provider; +pub mod update_task_download_locations; +pub mod update_task_status; +pub mod update_task_status_with_rich_failure; diff --git a/crates/schema/sqlite_database/src/queries/update/nuke_all_tasks.rs b/crates/schema/sqlite_database/src/queries/update/nuke_all_tasks.rs new file mode 100644 index 00000000..48edfb74 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/nuke_all_tasks.rs @@ -0,0 +1,28 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; + +/// Abandon all in-progress tasks. +/// Marked as user cancellation. +pub async fn nuke_all_tasks( + db: &TaskDbConnection, +) -> Result { + + // TODO(bt,2025-07-15): We can't set a LIMIT without a certain compiler flag for SQLite ? + let query = sqlx::query!(r#" + UPDATE tasks + SET task_status = "cancelled_by_user" + WHERE task_status NOT IN ( + "complete_success", + "complete_failure", + "dead", + "cancelled_by_user", + "cancelled_by_provider", + "cancelled_by_us" + ) + "#); + + let res = query.execute(db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/src/queries/update/update_successful_task_status_with_metadata.rs b/crates/schema/sqlite_database/src/queries/update/update_successful_task_status_with_metadata.rs new file mode 100644 index 00000000..1b196b18 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/update_successful_task_status_with_metadata.rs @@ -0,0 +1,59 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use sqlite_identifiers::ids::task_id::TaskId; + +const SUCCESSFUL_STATUS : &str = TaskStatus::CompleteSuccess.to_str(); + +pub struct UpdateSuccessfulTaskArgs<'a> { + pub db: &'a TaskDbConnection, + pub task_id: &'a TaskId, + pub maybe_batch_token: Option<&'a BatchGenerationToken>, + pub maybe_primary_media_file_token: Option<&'a MediaFileToken>, + pub maybe_primary_media_file_class: Option, + pub maybe_primary_media_file_cdn_url: Option<&'a str>, + pub maybe_primary_media_file_thumbnail_url_template: Option<&'a str>, +} + +/// Returns true if rows were updated. +pub async fn update_successful_task_status_with_metadata( + args: UpdateSuccessfulTaskArgs<'_>, +) -> Result { + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let task_id_temp = args.task_id.as_str(); + let maybe_batch_token_temp = args.maybe_batch_token.map(|t| t.as_str()); + let maybe_primary_media_token_temp = args.maybe_primary_media_file_token.map(|t| t.as_str()); + let maybe_primary_media_class = args.maybe_primary_media_file_class.map(|c| c.to_str()); + + // TODO(bt,2025-07-15): We can't set a LIMIT without a certain compiler flag for SQLite ? + let query = sqlx::query!(r#" + UPDATE tasks + SET + task_status = ?, + on_complete_batch_token = ?, + on_complete_primary_media_file_token = ?, + on_complete_primary_media_file_class = ?, + on_complete_primary_media_file_cdn_url = ?, + on_complete_primary_media_file_thumbnail_url_template = ? + WHERE id = ? + "#, + SUCCESSFUL_STATUS, + maybe_batch_token_temp, + maybe_primary_media_token_temp, + maybe_primary_media_class, + args.maybe_primary_media_file_cdn_url, + args.maybe_primary_media_file_thumbnail_url_template, + task_id_temp, + ); + + // info!("query: {:?}", query.sql()); + + let res = query.execute(args.db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/src/queries/update/update_successful_task_status_with_metadata_by_provider.rs b/crates/schema/sqlite_database/src/queries/update/update_successful_task_status_with_metadata_by_provider.rs new file mode 100644 index 00000000..aa1256d0 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/update_successful_task_status_with_metadata_by_provider.rs @@ -0,0 +1,64 @@ +use core_types::enums::generation_source::GenerationSource; +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::ids::batch_generation_token::BatchGenerationToken; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +const SUCCESSFUL_STATUS : &str = TaskStatus::CompleteSuccess.to_str(); + +pub struct UpdateSuccessfulTaskByProviderArgs<'a> { + pub db: &'a TaskDbConnection, + pub provider: GenerationSource, + pub provider_job_id: &'a str, + pub maybe_batch_token: Option<&'a BatchGenerationToken>, + pub maybe_primary_media_file_token: Option<&'a MediaFileToken>, + pub maybe_primary_media_file_class: Option, + pub maybe_primary_media_file_cdn_url: Option<&'a str>, + pub maybe_primary_media_file_thumbnail_url_template: Option<&'a str>, +} + +/// Returns true if rows were updated. +pub async fn update_successful_task_status_with_metadata_by_provider( + args: UpdateSuccessfulTaskByProviderArgs<'_>, +) -> Result { + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let provider_temp = args.provider.to_str(); + let provider_job_id_temp = args.provider_job_id; + let maybe_batch_token_temp = args.maybe_batch_token.map(|t| t.as_str()); + let maybe_primary_media_token_temp = args.maybe_primary_media_file_token.map(|t| t.as_str()); + let maybe_primary_media_class = args.maybe_primary_media_file_class.map(|c| c.to_str()); + + // TODO(bt,2025-07-15): We can't set a LIMIT without a certain compiler flag for SQLite ? + let query = sqlx::query!(r#" + UPDATE tasks + SET + task_status = ?, + on_complete_batch_token = ?, + on_complete_primary_media_file_token = ?, + on_complete_primary_media_file_class = ?, + on_complete_primary_media_file_cdn_url = ?, + on_complete_primary_media_file_thumbnail_url_template = ? + WHERE + provider = ? + AND provider_job_id = ? + "#, + SUCCESSFUL_STATUS, + maybe_batch_token_temp, + maybe_primary_media_token_temp, + maybe_primary_media_class, + args.maybe_primary_media_file_cdn_url, + args.maybe_primary_media_file_thumbnail_url_template, + provider_temp, + provider_job_id_temp, + ); + + // info!("query: {:?}", query.sql()); + + let res = query.execute(args.db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/src/queries/update/update_task_download_locations.rs b/crates/schema/sqlite_database/src/queries/update/update_task_download_locations.rs new file mode 100644 index 00000000..1a9ed12f --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/update_task_download_locations.rs @@ -0,0 +1,39 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::ids::task_id::TaskId; +use std::path::Path; + +pub struct UpdateTaskDownloadLocationsArgs<'a> { + pub db: &'a TaskDbConnection, + pub task_id: &'a TaskId, + /// The directory the results were saved into. + pub directory_location: &'a Path, + /// The first (or only) downloaded file. + pub first_file_location: &'a Path, +} + +/// Record where a completed task's results were downloaded. Paths are stored +/// as given (absolute), so later changes to the preferred download directory +/// don't affect them. Returns true if rows were updated. +pub async fn update_task_download_locations( + args: UpdateTaskDownloadLocationsArgs<'_>, +) -> Result { + let task_id_temp = args.task_id.as_str(); + let directory_temp = args.directory_location.to_string_lossy().into_owned(); + let first_file_temp = args.first_file_location.to_string_lossy().into_owned(); + + let query = sqlx::query!(r#" + UPDATE tasks + SET + on_complete_directory_location = ?, + on_complete_first_file_location = ? + WHERE id = ? + "#, + directory_temp, + first_file_temp, + task_id_temp, + ); + + let res = query.execute(args.db.get_pool()).await?; + Ok(res.rows_affected() > 0) +} diff --git a/crates/schema/sqlite_database/src/queries/update/update_task_status.rs b/crates/schema/sqlite_database/src/queries/update/update_task_status.rs new file mode 100644 index 00000000..482da7be --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/update_task_status.rs @@ -0,0 +1,39 @@ +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct UpdateTaskArgs<'a> { + pub db: &'a TaskDbConnection, + pub task_id: &'a TaskId, + pub status: TaskStatus, +} + +/// Returns true if rows were updated. +pub async fn update_task_status( + args: UpdateTaskArgs<'_>, +) -> Result { + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let task_id_temp = args.task_id.as_str(); + let status_temp = args.status.to_str(); + + // info!("Update task id: {}, status: {}", task_id_temp, status_temp); + + // TODO(bt,2025-07-15): We can't set a LIMIT without a certain compiler flag for SQLite ? + let query = sqlx::query!(r#" + UPDATE tasks + SET task_status = ? + WHERE id = ? + "#, + status_temp, + task_id_temp, + ); + + // info!("query: {:?}", query.sql()); + + let res = query.execute(args.db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/src/queries/update/update_task_status_with_rich_failure.rs b/crates/schema/sqlite_database/src/queries/update/update_task_status_with_rich_failure.rs new file mode 100644 index 00000000..61b77f55 --- /dev/null +++ b/crates/schema/sqlite_database/src/queries/update/update_task_status_with_rich_failure.rs @@ -0,0 +1,51 @@ +use sqlite_identifiers::enums::task_failure_type::TaskFailureType; +use crate::connection::TaskDbConnection; +use crate::error::SqliteTasksError; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::ids::task_id::TaskId; + +pub struct UpdateTaskWithRichFailureArgs<'a> { + pub db: &'a TaskDbConnection, + pub task_id: &'a TaskId, + pub status: TaskStatus, + pub maybe_failure_type: Option, + pub maybe_failure_message: Option<&'a str>, +} + +/// Returns true if rows were updated. +pub async fn update_task_status_with_rich_failure( + args: UpdateTaskWithRichFailureArgs<'_>, +) -> Result { + + // TODO(bt,2025-07-12): Fix this. The sqlx mysql queries never required temporaries + let task_id_temp = args.task_id.as_str(); + let status_temp = args.status.to_str(); + let maybe_failure_type_temp = args.maybe_failure_type.map(|val| val.to_str()); + + // Trim the message so it doesn't overflow the database column + let maybe_failure_message_temp = args.maybe_failure_message + .map(|s| if s.len() > 255 { &s[..255] } else { s }); + + // info!("Update task id: {}, status: {}", task_id_temp, status_temp); + + // TODO(bt,2025-07-15): We can't set a LIMIT without a certain compiler flag for SQLite ? + let query = sqlx::query!(r#" + UPDATE tasks + SET task_status = ?, + on_failure_type = ?, + on_failure_message = ? + WHERE id = ? + "#, + status_temp, + maybe_failure_type_temp, + maybe_failure_message_temp, + task_id_temp, + ); + + // info!("query: {:?}", query.sql()); + + let res = query.execute(args.db.get_pool()).await?; + let rows_updated = res.rows_affected() > 0; + + Ok(rows_updated) +} diff --git a/crates/schema/sqlite_database/tests/task_queries.rs b/crates/schema/sqlite_database/tests/task_queries.rs new file mode 100644 index 00000000..630dcc27 --- /dev/null +++ b/crates/schema/sqlite_database/tests/task_queries.rs @@ -0,0 +1,128 @@ +//! Round-trip tests against a throwaway, freshly migrated SQLite database. +//! +//! Run with `SQLX_OFFLINE=true cargo test -p sqlite_database`. + +use sqlite_database::connection::TaskDbConnection; +use sqlite_database::queries::create::create_task::{create_task, CreateTaskArgs}; +use sqlite_database::queries::read::get_task_by_provider_and_provider_job_id::{ + get_task_by_provider_and_provider_job_id, GetTaskByProviderAndProviderJobIdArgs, +}; +use sqlite_database::queries::read::list_tasks_for_frontend::list_tasks_for_frontend; +use sqlite_database::queries::update::update_successful_task_status_with_metadata::{ + update_successful_task_status_with_metadata, UpdateSuccessfulTaskArgs, +}; +use sqlite_database::queries::update::update_task_download_locations::{ + update_task_download_locations, UpdateTaskDownloadLocationsArgs, +}; +use core_types::enums::generation_source::GenerationSource; +use sqlite_identifiers::enums::task_media_file_class::TaskMediaFileClass; +use sqlite_identifiers::enums::task_status::TaskStatus; +use sqlite_identifiers::enums::task_type::TaskType; +use sqlite_identifiers::ids::media_file_token::MediaFileToken; +use std::path::Path; + +const PROVIDER_JOB_ID: &str = "job_test_123"; + +#[tokio::test] +async fn batch_flag_is_written_on_insert_and_read_back() { + let (_dir, db) = fresh_database().await; + + let task_id = create_task(CreateTaskArgs { + db: &db, + status: TaskStatus::Pending, + task_type: TaskType::ImageGeneration, + model_type: None, + provider: GenerationSource::Artcraft, + provider_job_id: Some(PROVIDER_JOB_ID), + is_batch_generation: true, + queue_status_url: None, + queue_response_url: None, + prompt_token: None, + frontend_caller: None, + frontend_subscriber_id: None, + frontend_subscriber_payload: None, + }).await.unwrap(); + + let task = get_task_by_provider_and_provider_job_id(GetTaskByProviderAndProviderJobIdArgs { + db: &db, + provider: GenerationSource::Artcraft, + provider_job_id: PROVIDER_JOB_ID, + }).await.unwrap().expect("task exists"); + assert_eq!(task.id, task_id); + assert!(task.is_batch_generation); + + let listed = list_tasks_for_frontend(&db).await.unwrap(); + assert_eq!(listed.tasks.len(), 1); + assert!(listed.tasks[0].is_batch_generation); + assert_eq!(listed.tasks[0].on_complete_directory_location, None); + assert_eq!(listed.tasks[0].on_complete_first_file_location, None); +} + +#[tokio::test] +async fn download_locations_are_recorded_on_completion() { + let (_dir, db) = fresh_database().await; + + let task_id = create_task(CreateTaskArgs { + db: &db, + status: TaskStatus::Pending, + task_type: TaskType::VideoGeneration, + model_type: None, + provider: GenerationSource::Artcraft, + provider_job_id: Some(PROVIDER_JOB_ID), + is_batch_generation: false, + queue_status_url: None, + queue_response_url: None, + prompt_token: None, + frontend_caller: None, + frontend_subscriber_id: None, + frontend_subscriber_payload: None, + }).await.unwrap(); + + let media_token = MediaFileToken::new_from_str("m_test"); + let completed = update_successful_task_status_with_metadata(UpdateSuccessfulTaskArgs { + db: &db, + task_id: &task_id, + maybe_batch_token: None, + maybe_primary_media_file_token: Some(&media_token), + maybe_primary_media_file_class: Some(TaskMediaFileClass::Video), + maybe_primary_media_file_cdn_url: Some("https://cdn.example/out.mp4"), + maybe_primary_media_file_thumbnail_url_template: None, + }).await.unwrap(); + assert!(completed); + + let recorded = update_task_download_locations(UpdateTaskDownloadLocationsArgs { + db: &db, + task_id: &task_id, + directory_location: Path::new("/Users/someone/Downloads/Artcraft"), + first_file_location: Path::new("/Users/someone/Downloads/Artcraft/veo_3_2026-08-30.mp4"), + }).await.unwrap(); + assert!(recorded); + + let listed = list_tasks_for_frontend(&db).await.unwrap(); + let task = &listed.tasks[0]; + assert_eq!(task.status, TaskStatus::CompleteSuccess); + assert!(!task.is_batch_generation); + assert_eq!(task.on_complete_directory_location.as_deref(), Some("/Users/someone/Downloads/Artcraft")); + assert_eq!( + task.on_complete_first_file_location.as_deref(), + Some("/Users/someone/Downloads/Artcraft/veo_3_2026-08-30.mp4"), + ); +} + +#[tokio::test] +async fn recording_locations_for_an_unknown_task_updates_nothing() { + let (_dir, db) = fresh_database().await; + let recorded = update_task_download_locations(UpdateTaskDownloadLocationsArgs { + db: &db, + task_id: &sqlite_identifiers::ids::task_id::TaskId::generate(), + directory_location: Path::new("/tmp"), + first_file_location: Path::new("/tmp/x.png"), + }).await.unwrap(); + assert!(!recorded); +} + +async fn fresh_database() -> (tempfile::TempDir, TaskDbConnection) { + let dir = tempfile::tempdir().unwrap(); + let db = TaskDbConnection::connect_and_migrate(dir.path().join("tasks.sqlite")).await.unwrap(); + (dir, db) +} diff --git a/crates/schema/sqlite_identifiers/Cargo.toml b/crates/schema/sqlite_identifiers/Cargo.toml new file mode 100644 index 00000000..79f70a83 --- /dev/null +++ b/crates/schema/sqlite_identifiers/Cargo.toml @@ -0,0 +1,34 @@ +[package] +name = "sqlite_identifiers" +edition = "2021" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +name = "sqlite_identifiers" +path = "src/lib.rs" + +[dependencies] +# Workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Serialization +serde.workspace = true +serde_derive.workspace = true + +# Token entropy +rand = { version = "0.8.5", features = ["std_rng"] } + +[dev-dependencies] +# Enum utilities +strum.workspace = true + +# Test serialization +serde_json.workspace = true diff --git a/crates/schema/sqlite_identifiers/src/enums/enum_error.rs b/crates/schema/sqlite_identifiers/src/enums/enum_error.rs new file mode 100644 index 00000000..a86cf4ed --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/enum_error.rs @@ -0,0 +1,18 @@ +use std::error::Error; + +#[derive(Debug)] +pub enum EnumError { + CouldNotConvertFromString(String), +} + +impl Error for EnumError {} + +impl std::fmt::Display for EnumError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + EnumError::CouldNotConvertFromString(value) => { + write!(f, "Could not convert from string: {}", value) + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/enums/mod.rs b/crates/schema/sqlite_identifiers/src/enums/mod.rs new file mode 100644 index 00000000..e5627b39 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/mod.rs @@ -0,0 +1,7 @@ +pub mod enum_error; +pub mod task_failure_type; +pub mod task_media_file_class; +pub mod task_model_type; +pub mod task_status; +pub mod task_type; +pub mod tauri_command_caller; diff --git a/crates/schema/sqlite_identifiers/src/enums/task_failure_type.rs b/crates/schema/sqlite_identifiers/src/enums/task_failure_type.rs new file mode 100644 index 00000000..d318b73a --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/task_failure_type.rs @@ -0,0 +1,278 @@ +use std::collections::BTreeSet; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Failure type for tasks in the Tauri desktop app. +/// +/// Mirrors the relevant variants from `FrontendFailureCategory` so the desktop +/// client can display localized failure information without depending / breaking on the +/// server-side enum directly. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TaskFailureType { + /// Catch-all for unknown failures. + Unknown, + + RuleBansUserImage, + RuleBansUserImageWithFaces, + RuleBansUserTextPrompt, + RuleBansUserContent, + + RuleBansGeneratedVideo, + RuleBansGeneratedAudio, + RuleBansGeneratedContent, + + /// No foreground subject could be detected in the input image after + /// background removal (e.g. TripoSplat image-to-splat). + NoForegroundSubjectDetected, + + /// The input file's format isn't supported by the model (e.g. Hunyuan 3D + /// Part only accepts FBX input). + FormatNotSupported, + + /// No reason given for generation failure, but this matches what we were told. + GenerationFailed, + + /// When a face is not detected in the image used for animation. + FaceNotDetected, + + /// The user stepped away and a keep-alive-required workload timed out. + KeepAliveElapsed, + + /// A feature isn't complete somewhere in the code. + NotYetImplemented, + + /// A transient error happened; the workload will be retried. + RetryableWorkerError, + + /// Model content rules were violated. + ModelRulesViolation, + + /// The uploaded file exceeds the maximum allowed size for this model. + FilesizeTooLarge, + + /// The uploaded image dimensions are below the minimum required by the model. + ImageDimensionsTooSmall, + + /// The uploaded image dimensions exceed the maximum allowed by the model. + ImageDimensionsTooLarge, +} + +impl_enum_display_and_debug_using_to_str!(TaskFailureType); + +impl TaskFailureType { + + pub const fn to_str(&self) -> &'static str { + match self { + Self::Unknown => "unknown", + Self::RuleBansUserImage => "rule_bans_user_image", + Self::RuleBansUserImageWithFaces => "rule_bans_user_image_with_faces", + Self::RuleBansUserTextPrompt => "rule_bans_user_text_prompt", + Self::RuleBansUserContent => "rule_bans_user_content", + Self::RuleBansGeneratedVideo => "rule_bans_generated_video", + Self::RuleBansGeneratedAudio => "rule_bans_generated_audio", + Self::RuleBansGeneratedContent => "rule_bans_generated_content", + Self::NoForegroundSubjectDetected => "no_foreground_subject_detected", + Self::FormatNotSupported => "format_not_supported", + Self::GenerationFailed => "generation_failed", + Self::FaceNotDetected => "face_not_detected", + Self::KeepAliveElapsed => "keep_alive_elapsed", + Self::NotYetImplemented => "not_yet_implemented", + Self::RetryableWorkerError => "retryable_worker_error", + Self::ModelRulesViolation => "model_rules_violation", + Self::FilesizeTooLarge => "filesize_too_large", + Self::ImageDimensionsTooSmall => "image_dimensions_too_small", + Self::ImageDimensionsTooLarge => "image_dimensions_too_large", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "unknown" => Ok(Self::Unknown), + "rule_bans_user_image" => Ok(Self::RuleBansUserImage), + "rule_bans_user_image_with_faces" => Ok(Self::RuleBansUserImageWithFaces), + "rule_bans_user_text_prompt" => Ok(Self::RuleBansUserTextPrompt), + "rule_bans_user_content" => Ok(Self::RuleBansUserContent), + "rule_bans_generated_video" => Ok(Self::RuleBansGeneratedVideo), + "rule_bans_generated_audio" => Ok(Self::RuleBansGeneratedAudio), + "rule_bans_generated_content" => Ok(Self::RuleBansGeneratedContent), + "no_foreground_subject_detected" => Ok(Self::NoForegroundSubjectDetected), + "format_not_supported" => Ok(Self::FormatNotSupported), + "generation_failed" => Ok(Self::GenerationFailed), + "face_not_detected" => Ok(Self::FaceNotDetected), + "keep_alive_elapsed" => Ok(Self::KeepAliveElapsed), + "not_yet_implemented" => Ok(Self::NotYetImplemented), + "retryable_worker_error" => Ok(Self::RetryableWorkerError), + "model_rules_violation" => Ok(Self::ModelRulesViolation), + "filesize_too_large" => Ok(Self::FilesizeTooLarge), + "image_dimensions_too_small" => Ok(Self::ImageDimensionsTooSmall), + "image_dimensions_too_large" => Ok(Self::ImageDimensionsTooLarge), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + BTreeSet::from([ + Self::Unknown, + Self::RuleBansUserImage, + Self::RuleBansUserImageWithFaces, + Self::RuleBansUserTextPrompt, + Self::RuleBansUserContent, + Self::RuleBansGeneratedVideo, + Self::RuleBansGeneratedAudio, + Self::RuleBansGeneratedContent, + Self::NoForegroundSubjectDetected, + Self::FormatNotSupported, + Self::GenerationFailed, + Self::FaceNotDetected, + Self::KeepAliveElapsed, + Self::NotYetImplemented, + Self::RetryableWorkerError, + Self::ModelRulesViolation, + Self::FilesizeTooLarge, + Self::ImageDimensionsTooSmall, + Self::ImageDimensionsTooLarge, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::task_failure_type::TaskFailureType; + use crate::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(TaskFailureType::Unknown, "unknown"); + assert_serialization(TaskFailureType::RuleBansUserImage, "rule_bans_user_image"); + assert_serialization(TaskFailureType::RuleBansUserImageWithFaces, "rule_bans_user_image_with_faces"); + assert_serialization(TaskFailureType::RuleBansUserTextPrompt, "rule_bans_user_text_prompt"); + assert_serialization(TaskFailureType::RuleBansUserContent, "rule_bans_user_content"); + assert_serialization(TaskFailureType::RuleBansGeneratedVideo, "rule_bans_generated_video"); + assert_serialization(TaskFailureType::RuleBansGeneratedAudio, "rule_bans_generated_audio"); + assert_serialization(TaskFailureType::RuleBansGeneratedContent, "rule_bans_generated_content"); + assert_serialization(TaskFailureType::NoForegroundSubjectDetected, "no_foreground_subject_detected"); + assert_serialization(TaskFailureType::FormatNotSupported, "format_not_supported"); + assert_serialization(TaskFailureType::GenerationFailed, "generation_failed"); + assert_serialization(TaskFailureType::FaceNotDetected, "face_not_detected"); + assert_serialization(TaskFailureType::KeepAliveElapsed, "keep_alive_elapsed"); + assert_serialization(TaskFailureType::NotYetImplemented, "not_yet_implemented"); + assert_serialization(TaskFailureType::RetryableWorkerError, "retryable_worker_error"); + assert_serialization(TaskFailureType::ModelRulesViolation, "model_rules_violation"); + assert_serialization(TaskFailureType::FilesizeTooLarge, "filesize_too_large"); + assert_serialization(TaskFailureType::ImageDimensionsTooSmall, "image_dimensions_too_small"); + assert_serialization(TaskFailureType::ImageDimensionsTooLarge, "image_dimensions_too_large"); + } + + #[test] + fn to_str() { + assert_eq!(TaskFailureType::Unknown.to_str(), "unknown"); + assert_eq!(TaskFailureType::RuleBansUserImage.to_str(), "rule_bans_user_image"); + assert_eq!(TaskFailureType::RuleBansUserImageWithFaces.to_str(), "rule_bans_user_image_with_faces"); + assert_eq!(TaskFailureType::RuleBansUserTextPrompt.to_str(), "rule_bans_user_text_prompt"); + assert_eq!(TaskFailureType::RuleBansUserContent.to_str(), "rule_bans_user_content"); + assert_eq!(TaskFailureType::RuleBansGeneratedVideo.to_str(), "rule_bans_generated_video"); + assert_eq!(TaskFailureType::RuleBansGeneratedAudio.to_str(), "rule_bans_generated_audio"); + assert_eq!(TaskFailureType::RuleBansGeneratedContent.to_str(), "rule_bans_generated_content"); + assert_eq!(TaskFailureType::NoForegroundSubjectDetected.to_str(), "no_foreground_subject_detected"); + assert_eq!(TaskFailureType::FormatNotSupported.to_str(), "format_not_supported"); + assert_eq!(TaskFailureType::GenerationFailed.to_str(), "generation_failed"); + assert_eq!(TaskFailureType::FaceNotDetected.to_str(), "face_not_detected"); + assert_eq!(TaskFailureType::KeepAliveElapsed.to_str(), "keep_alive_elapsed"); + assert_eq!(TaskFailureType::NotYetImplemented.to_str(), "not_yet_implemented"); + assert_eq!(TaskFailureType::RetryableWorkerError.to_str(), "retryable_worker_error"); + assert_eq!(TaskFailureType::ModelRulesViolation.to_str(), "model_rules_violation"); + assert_eq!(TaskFailureType::FilesizeTooLarge.to_str(), "filesize_too_large"); + assert_eq!(TaskFailureType::ImageDimensionsTooSmall.to_str(), "image_dimensions_too_small"); + assert_eq!(TaskFailureType::ImageDimensionsTooLarge.to_str(), "image_dimensions_too_large"); + } + + #[test] + fn from_str() { + assert_eq!(TaskFailureType::from_str("unknown").unwrap(), TaskFailureType::Unknown); + assert_eq!(TaskFailureType::from_str("rule_bans_user_image").unwrap(), TaskFailureType::RuleBansUserImage); + assert_eq!(TaskFailureType::from_str("rule_bans_user_image_with_faces").unwrap(), TaskFailureType::RuleBansUserImageWithFaces); + assert_eq!(TaskFailureType::from_str("rule_bans_user_text_prompt").unwrap(), TaskFailureType::RuleBansUserTextPrompt); + assert_eq!(TaskFailureType::from_str("rule_bans_user_content").unwrap(), TaskFailureType::RuleBansUserContent); + assert_eq!(TaskFailureType::from_str("rule_bans_generated_video").unwrap(), TaskFailureType::RuleBansGeneratedVideo); + assert_eq!(TaskFailureType::from_str("rule_bans_generated_audio").unwrap(), TaskFailureType::RuleBansGeneratedAudio); + assert_eq!(TaskFailureType::from_str("rule_bans_generated_content").unwrap(), TaskFailureType::RuleBansGeneratedContent); + assert_eq!(TaskFailureType::from_str("no_foreground_subject_detected").unwrap(), TaskFailureType::NoForegroundSubjectDetected); + assert_eq!(TaskFailureType::from_str("format_not_supported").unwrap(), TaskFailureType::FormatNotSupported); + assert_eq!(TaskFailureType::from_str("generation_failed").unwrap(), TaskFailureType::GenerationFailed); + assert_eq!(TaskFailureType::from_str("face_not_detected").unwrap(), TaskFailureType::FaceNotDetected); + assert_eq!(TaskFailureType::from_str("keep_alive_elapsed").unwrap(), TaskFailureType::KeepAliveElapsed); + assert_eq!(TaskFailureType::from_str("not_yet_implemented").unwrap(), TaskFailureType::NotYetImplemented); + assert_eq!(TaskFailureType::from_str("retryable_worker_error").unwrap(), TaskFailureType::RetryableWorkerError); + assert_eq!(TaskFailureType::from_str("model_rules_violation").unwrap(), TaskFailureType::ModelRulesViolation); + assert_eq!(TaskFailureType::from_str("filesize_too_large").unwrap(), TaskFailureType::FilesizeTooLarge); + assert_eq!(TaskFailureType::from_str("image_dimensions_too_small").unwrap(), TaskFailureType::ImageDimensionsTooSmall); + assert_eq!(TaskFailureType::from_str("image_dimensions_too_large").unwrap(), TaskFailureType::ImageDimensionsTooLarge); + } + + #[test] + fn from_str_err() { + let result = TaskFailureType::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = TaskFailureType::all_variants(); + assert_eq!(variants.len(), 19); + assert_eq!(variants.pop_first(), Some(TaskFailureType::Unknown)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansUserImage)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansUserImageWithFaces)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansUserTextPrompt)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansUserContent)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansGeneratedVideo)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansGeneratedAudio)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RuleBansGeneratedContent)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::NoForegroundSubjectDetected)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::FormatNotSupported)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::GenerationFailed)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::FaceNotDetected)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::KeepAliveElapsed)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::NotYetImplemented)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::RetryableWorkerError)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::ModelRulesViolation)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::FilesizeTooLarge)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::ImageDimensionsTooSmall)); + assert_eq!(variants.pop_first(), Some(TaskFailureType::ImageDimensionsTooLarge)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(TaskFailureType::all_variants().len(), TaskFailureType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TaskFailureType::all_variants() { + assert_eq!(variant, TaskFailureType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TaskFailureType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TaskFailureType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/enums/task_media_file_class.rs b/crates/schema/sqlite_identifiers/src/enums/task_media_file_class.rs new file mode 100644 index 00000000..2e1fd24a --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/task_media_file_class.rs @@ -0,0 +1,149 @@ +use std::collections::BTreeSet; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TaskMediaFileClass { + /// Audio files: wav, mp3, etc. + Audio, + + /// Image files: png, jpeg, etc. + Image, + + /// Video files: mp4, etc. + Video, + + /// Gaussian splats: ply, spz, etc. + Splat, + + /// 3D meshes: glb, gltf, fbx, etc. + Mesh, +} + +impl_enum_display_and_debug_using_to_str!(TaskMediaFileClass); +//impl_mysql_enum_coders!(TaskMediaFileType); +//impl_mysql_from_row!(TaskMediaFileType); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl TaskMediaFileClass { + pub fn to_str(&self) -> &'static str { + match self { + Self::Audio => "audio", + Self::Image => "image", + Self::Video => "video", + Self::Splat => "splat", + Self::Mesh => "mesh", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "audio" => Ok(Self::Audio), + "image" => Ok(Self::Image), + "video" => Ok(Self::Video), + "splat" => Ok(Self::Splat), + "mesh" => Ok(Self::Mesh), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Audio, + Self::Image, + Self::Video, + Self::Splat, + Self::Mesh, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::task_media_file_class::TaskMediaFileClass; + use crate::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(TaskMediaFileClass::Audio, "audio"); + assert_serialization(TaskMediaFileClass::Image, "image"); + assert_serialization(TaskMediaFileClass::Video, "video"); + assert_serialization(TaskMediaFileClass::Splat, "splat"); + assert_serialization(TaskMediaFileClass::Mesh, "mesh"); + } + + #[test] + fn to_str() { + assert_eq!(TaskMediaFileClass::Audio.to_str(), "audio"); + assert_eq!(TaskMediaFileClass::Image.to_str(), "image"); + assert_eq!(TaskMediaFileClass::Video.to_str(), "video"); + assert_eq!(TaskMediaFileClass::Splat.to_str(), "splat"); + assert_eq!(TaskMediaFileClass::Mesh.to_str(), "mesh"); + } + + #[test] + fn from_str() { + assert_eq!(TaskMediaFileClass::from_str("audio").unwrap(), TaskMediaFileClass::Audio); + assert_eq!(TaskMediaFileClass::from_str("image").unwrap(), TaskMediaFileClass::Image); + assert_eq!(TaskMediaFileClass::from_str("video").unwrap(), TaskMediaFileClass::Video); + assert_eq!(TaskMediaFileClass::from_str("splat").unwrap(), TaskMediaFileClass::Splat); + assert_eq!(TaskMediaFileClass::from_str("mesh").unwrap(), TaskMediaFileClass::Mesh); + } + + #[test] + fn from_str_err() { + let result = TaskMediaFileClass::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = TaskMediaFileClass::all_variants(); + assert_eq!(variants.len(), 5); + assert_eq!(variants.pop_first(), Some(TaskMediaFileClass::Audio)); + assert_eq!(variants.pop_first(), Some(TaskMediaFileClass::Image)); + assert_eq!(variants.pop_first(), Some(TaskMediaFileClass::Video)); + assert_eq!(variants.pop_first(), Some(TaskMediaFileClass::Splat)); + assert_eq!(variants.pop_first(), Some(TaskMediaFileClass::Mesh)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(TaskMediaFileClass::all_variants().len(), TaskMediaFileClass::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TaskMediaFileClass::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, TaskMediaFileClass::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TaskMediaFileClass::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TaskMediaFileClass::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/enums/task_model_type.rs b/crates/schema/sqlite_identifiers/src/enums/task_model_type.rs new file mode 100644 index 00000000..b0a50edc --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/task_model_type.rs @@ -0,0 +1,842 @@ +use std::collections::BTreeSet; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TaskModelType { + // Image models + #[serde(rename = "flux_1_dev")] + Flux1Dev, + #[serde(rename = "flux_1_schnell")] + Flux1Schnell, + #[serde(rename = "flux_dev_juggernaut")] + FluxDevJuggernaut, + // NB: For inpainting for now + #[serde(rename = "flux_pro_1")] + FluxPro1, + #[serde(rename = "flux_pro_1.1")] + FluxPro11, + #[serde(rename = "flux_pro_1.1_ultra")] + FluxPro11Ultra, + #[serde(rename = "flux_pro_kontext_max")] + FluxProKontextMax, + #[serde(rename = "gemini_25_flash")] + Gemini25Flash, + #[serde(rename = "nano_banana")] + NanoBanana, + #[serde(rename = "nano_banana_2")] + NanoBanana2, + #[serde(rename = "nano_banana_2_lite")] + NanoBanana2Lite, + #[serde(rename = "nano_banana_pro")] + NanoBananaPro, + #[serde(rename = "gpt_image_1")] + GptImage1, + #[serde(rename = "gpt_image_1p5")] + GptImage1p5, + #[serde(rename = "gpt_image_2")] + GptImage2, + #[serde(rename = "seedream_4")] + Seedream4, + #[serde(rename = "seedream_4p5")] + Seedream4p5, + #[serde(rename = "seedream_5_lite")] + Seedream5Lite, + #[serde(rename = "seedream_5p0_pro")] + Seedream5p0Pro, + #[serde(rename = "seedream_5p0_pro_u")] + Seedream5p0ProUltra, + #[serde(rename = "qwen_edit_2511_angles")] + QwenEdit2511Angles, + #[serde(rename = "flux_2_lora_angles")] + Flux2LoraAngles, + #[serde(rename = "grok_image")] + GrokImage, + #[serde(rename = "recraft_3")] + Recraft3, + + // Generic Midjourney model, version unknown. + #[serde(rename = "midjourney")] + Midjourney, + #[serde(rename = "midjourney_7")] + Midjourney7, + #[serde(rename = "midjourney_7_niji")] + Midjourney7Niji, + #[serde(rename = "midjourney_8")] + Midjourney8, + + // Video models + #[serde(rename = "grok_video")] + GrokVideo, // Video version unspecified/unknown + #[serde(rename = "grok_imagine_video_1p5")] + GrokImagineVideo1p5, + #[serde(rename = "kling_1.6_pro")] + Kling16Pro, + #[serde(rename = "kling_2.1_pro")] + Kling21Pro, + #[serde(rename = "kling_2.1_master")] + Kling21Master, + #[serde(rename = "kling_2p5_turbo_pro")] + Kling2p5TurboPro, + #[serde(rename = "kling_2p6_pro")] + Kling2p6Pro, + #[serde(rename = "kling_3p0_standard")] + Kling3p0Standard, + #[serde(rename = "kling_3p0_pro")] + Kling3p0Pro, + #[serde(rename = "happy_horse_1p0")] + HappyHorse1p0, + #[serde(rename = "seedance_1.0_lite")] + Seedance10Lite, + #[serde(rename = "seedance_1p5_pro")] + Seedance1p5Pro, + #[serde(rename = "seedance_2p0")] + Seedance2p0, + #[serde(rename = "seedance_2p0_fast")] + Seedance2p0Fast, + #[serde(rename = "seedance_2p0_mini")] + Seedance2p0Mini, + #[serde(rename = "seedance_2p5")] + Seedance2p5, + #[serde(rename = "seedance_2p5_edit")] + Seedance2p5Edit, + #[serde(rename = "minimax_h3")] + MinimaxH3, + #[serde(rename = "sora_2")] + Sora2, + #[serde(rename = "sora_2_pro")] + Sora2Pro, + #[serde(rename = "veo_2")] + Veo2, + #[serde(rename = "veo_3")] + Veo3, + #[serde(rename = "veo_3_fast")] + Veo3Fast, + #[serde(rename = "veo_3p1")] + Veo3p1, + #[serde(rename = "veo_3p1_fast")] + Veo3p1Fast, + #[serde(rename = "veo_3p1_lite")] + Veo3p1Lite, + #[serde(rename = "vidu_q3")] + ViduQ3, + #[serde(rename = "vidu_q3_turbo")] + ViduQ3Turbo, + + // 3D Object generation models + #[serde(rename = "hunyuan_3d_2.0")] + Hunyuan3d2_0, + #[serde(rename = "hunyuan_3d_2.1")] + Hunyuan3d2_1, + #[serde(rename = "hunyuan_3d_3")] + Hunyuan3d3, + #[serde(rename = "worldlabs_marble")] + WorldlabsMarble, + #[serde(rename = "marble_0p1_mini")] + WorldlabsMarble0p1Mini, + #[serde(rename = "marble_0p1_plus")] + WorldlabsMarble0p1Plus, + #[serde(rename = "hunyuan_3d_3_sketch")] + Hunyuan3d3Sketch, + #[serde(rename = "hunyuan_3d_3p1_pro")] + Hunyuan3d3p1Pro, + #[serde(rename = "hunyuan_3d_3p1_rapid")] + Hunyuan3d3p1Rapid, + #[serde(rename = "hunyuan_3d_3p1_part")] + Hunyuan3d3p1Part, + #[serde(rename = "hunyuan_3d_3p1_topology")] + Hunyuan3d3p1SmartTopology, + #[serde(rename = "tripo3d_h3p1")] + Tripo3dH3p1, + #[serde(rename = "meshy_v6")] + MeshyV6, + #[serde(rename = "rodin_2p5_fast")] + Rodin2p5Fast, + + // Splat generation models + #[serde(rename = "marble_1p0")] + Marble1p0, + #[serde(rename = "marble_1p0_draft")] + Marble1p0Draft, + #[serde(rename = "marble_1p1")] + Marble1p1, + #[serde(rename = "marble_1p1_plus")] + Marble1p1Plus, + #[serde(rename = "triposplat")] + TripoSplat, + + // Audio generation models + #[serde(rename = "suno_music")] + SunoMusic, + #[serde(rename = "suno_remix")] + SunoRemix, + #[serde(rename = "suno_sounds")] + SunoSounds, + #[serde(rename = "suno_sample")] + SunoSample, + #[serde(rename = "seed_audio_1p0")] + SeedAudio1p0, +} + +impl_enum_display_and_debug_using_to_str!(TaskModelType); +//impl_mysql_enum_coders!(TaskModelType); +//impl_mysql_from_row!(TaskModelType); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl TaskModelType { + pub fn to_str(&self) -> &'static str { + match self { + // Image models + Self::Flux1Dev => "flux_1_dev", + Self::Flux1Schnell => "flux_1_schnell", + Self::FluxDevJuggernaut => "flux_dev_juggernaut", + Self::FluxPro1 => "flux_pro_1", + Self::FluxPro11 => "flux_pro_1.1", + Self::FluxPro11Ultra => "flux_pro_1.1_ultra", + Self::FluxProKontextMax => "flux_pro_kontext_max", + Self::Gemini25Flash => "gemini_25_flash", + Self::NanoBanana => "nano_banana", + Self::NanoBanana2 => "nano_banana_2", + Self::NanoBanana2Lite => "nano_banana_2_lite", + Self::NanoBananaPro => "nano_banana_pro", + Self::GptImage1 => "gpt_image_1", + Self::GptImage1p5 => "gpt_image_1p5", + Self::GptImage2 => "gpt_image_2", + Self::Seedream4 => "seedream_4", + Self::Seedream4p5 => "seedream_4p5", + Self::Seedream5Lite => "seedream_5_lite", + Self::Seedream5p0Pro => "seedream_5p0_pro", + Self::Seedream5p0ProUltra => "seedream_5p0_pro_u", + Self::QwenEdit2511Angles => "qwen_edit_2511_angles", + Self::Flux2LoraAngles => "flux_2_lora_angles", + Self::GrokImage => "grok_image", + Self::Recraft3 => "recraft_3", + Self::Midjourney => "midjourney", + Self::Midjourney7 => "midjourney_7", + Self::Midjourney7Niji => "midjourney_7_niji", + Self::Midjourney8 => "midjourney_8", + // Video models + Self::GrokVideo => "grok_video", + Self::GrokImagineVideo1p5 => "grok_imagine_video_1p5", + Self::Kling16Pro => "kling_1.6_pro", + Self::Kling21Pro => "kling_2.1_pro", + Self::Kling21Master => "kling_2.1_master", + Self::Kling2p5TurboPro => "kling_2p5_turbo_pro", + Self::Kling2p6Pro => "kling_2p6_pro", + Self::Kling3p0Standard => "kling_3p0_standard", + Self::Kling3p0Pro => "kling_3p0_pro", + Self::HappyHorse1p0 => "happy_horse_1p0", + Self::Seedance10Lite => "seedance_1.0_lite", + Self::Seedance1p5Pro => "seedance_1p5_pro", + Self::Seedance2p0 => "seedance_2p0", + Self::Seedance2p0Fast => "seedance_2p0_fast", + Self::Seedance2p0Mini => "seedance_2p0_mini", + Self::Seedance2p5 => "seedance_2p5", + Self::Seedance2p5Edit => "seedance_2p5_edit", + Self::MinimaxH3 => "minimax_h3", + Self::Sora2 => "sora_2", + Self::Sora2Pro => "sora_2_pro", + Self::Veo2 => "veo_2", + Self::Veo3 => "veo_3", + Self::Veo3Fast => "veo_3_fast", + Self::Veo3p1 => "veo_3p1", + Self::Veo3p1Fast => "veo_3p1_fast", + Self::Veo3p1Lite => "veo_3p1_lite", + Self::ViduQ3 => "vidu_q3", + Self::ViduQ3Turbo => "vidu_q3_turbo", + // 3D Object generation models + Self::Hunyuan3d2_0 => "hunyuan_3d_2.0", + Self::Hunyuan3d2_1 => "hunyuan_3d_2.1", + Self::Hunyuan3d3 => "hunyuan_3d_3", + Self::WorldlabsMarble => "worldlabs_marble", + Self::WorldlabsMarble0p1Mini => "marble_0p1_mini", + Self::WorldlabsMarble0p1Plus => "marble_0p1_plus", + Self::Hunyuan3d3Sketch => "hunyuan_3d_3_sketch", + Self::Hunyuan3d3p1Pro => "hunyuan_3d_3p1_pro", + Self::Hunyuan3d3p1Rapid => "hunyuan_3d_3p1_rapid", + Self::Hunyuan3d3p1Part => "hunyuan_3d_3p1_part", + Self::Hunyuan3d3p1SmartTopology => "hunyuan_3d_3p1_topology", + Self::Tripo3dH3p1 => "tripo3d_h3p1", + Self::MeshyV6 => "meshy_v6", + Self::Rodin2p5Fast => "rodin_2p5_fast", + Self::Marble1p0 => "marble_1p0", + Self::Marble1p0Draft => "marble_1p0_draft", + Self::Marble1p1 => "marble_1p1", + Self::Marble1p1Plus => "marble_1p1_plus", + Self::TripoSplat => "triposplat", + Self::SunoMusic => "suno_music", + Self::SunoRemix => "suno_remix", + Self::SunoSounds => "suno_sounds", + Self::SunoSample => "suno_sample", + Self::SeedAudio1p0 => "seed_audio_1p0", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + // Image models + "flux_1_dev" => Ok(Self::Flux1Dev), + "flux_1_schnell" => Ok(Self::Flux1Schnell), + "flux_dev_juggernaut" => Ok(Self::FluxDevJuggernaut), + "flux_pro_1" => Ok(Self::FluxPro1), + "flux_pro_1.1" => Ok(Self::FluxPro11), + "flux_pro_1.1_ultra" => Ok(Self::FluxPro11Ultra), + "flux_pro_kontext_max" => Ok(Self::FluxProKontextMax), + "gemini_25_flash" => Ok(Self::Gemini25Flash), + "nano_banana" => Ok(Self::NanoBanana), + "nano_banana_2" => Ok(Self::NanoBanana2), + "nano_banana_2_lite" => Ok(Self::NanoBanana2Lite), + "nano_banana_pro" => Ok(Self::NanoBananaPro), + "gpt_image_1" => Ok(Self::GptImage1), + "gpt_image_1p5" => Ok(Self::GptImage1p5), + "gpt_image_2" => Ok(Self::GptImage2), + "seedream_4" => Ok(Self::Seedream4), + "seedream_4p5" => Ok(Self::Seedream4p5), + "seedream_5_lite" => Ok(Self::Seedream5Lite), + "seedream_5p0_pro" => Ok(Self::Seedream5p0Pro), + "seedream_5p0_pro_u" => Ok(Self::Seedream5p0ProUltra), + "qwen_edit_2511_angles" => Ok(Self::QwenEdit2511Angles), + "flux_2_lora_angles" => Ok(Self::Flux2LoraAngles), + "grok_image" => Ok(Self::GrokImage), + "recraft_3" => Ok(Self::Recraft3), + "midjourney" => Ok(Self::Midjourney), + "midjourney_7" => Ok(Self::Midjourney7), + "midjourney_7_niji" => Ok(Self::Midjourney7Niji), + "midjourney_8" => Ok(Self::Midjourney8), + // Video models + "grok_video" => Ok(Self::GrokVideo), + "grok_imagine_video_1p5" => Ok(Self::GrokImagineVideo1p5), + "kling_1.6_pro" => Ok(Self::Kling16Pro), + "kling_2.1_pro" => Ok(Self::Kling21Pro), + "kling_2.1_master" => Ok(Self::Kling21Master), + "kling_2p5_turbo_pro" => Ok(Self::Kling2p5TurboPro), + "kling_2p6_pro" => Ok(Self::Kling2p6Pro), + "kling_3p0_standard" => Ok(Self::Kling3p0Standard), + "kling_3p0_pro" => Ok(Self::Kling3p0Pro), + "happy_horse_1p0" => Ok(Self::HappyHorse1p0), + "seedance_1.0_lite" => Ok(Self::Seedance10Lite), + "seedance_1p5_pro" => Ok(Self::Seedance1p5Pro), + "seedance_2p0" => Ok(Self::Seedance2p0), + "seedance_2p0_fast" => Ok(Self::Seedance2p0Fast), + "seedance_2p0_mini" => Ok(Self::Seedance2p0Mini), + "seedance_2p5" => Ok(Self::Seedance2p5), + "seedance_2p5_edit" => Ok(Self::Seedance2p5Edit), + "minimax_h3" => Ok(Self::MinimaxH3), + "sora_2" => Ok(Self::Sora2), + "sora_2_pro" => Ok(Self::Sora2Pro), + "veo_2" => Ok(Self::Veo2), + "veo_3" => Ok(Self::Veo3), + "veo_3_fast" => Ok(Self::Veo3Fast), + "veo_3p1" => Ok(Self::Veo3p1), + "veo_3p1_fast" => Ok(Self::Veo3p1Fast), + "veo_3p1_lite" => Ok(Self::Veo3p1Lite), + "vidu_q3" => Ok(Self::ViduQ3), + "vidu_q3_turbo" => Ok(Self::ViduQ3Turbo), + // 3D Object generation models + "hunyuan_3d_2.0" => Ok(Self::Hunyuan3d2_0), + "hunyuan_3d_2.1" => Ok(Self::Hunyuan3d2_1), + "hunyuan_3d_3" => Ok(Self::Hunyuan3d3), + "worldlabs_marble" => Ok(Self::WorldlabsMarble), + "marble_0p1_mini" => Ok(Self::WorldlabsMarble0p1Mini), + "marble_0p1_plus" => Ok(Self::WorldlabsMarble0p1Plus), + "hunyuan_3d_3_sketch" => Ok(Self::Hunyuan3d3Sketch), + "hunyuan_3d_3p1_pro" => Ok(Self::Hunyuan3d3p1Pro), + "hunyuan_3d_3p1_rapid" => Ok(Self::Hunyuan3d3p1Rapid), + "hunyuan_3d_3p1_part" => Ok(Self::Hunyuan3d3p1Part), + "hunyuan_3d_3p1_topology" => Ok(Self::Hunyuan3d3p1SmartTopology), + "tripo3d_h3p1" => Ok(Self::Tripo3dH3p1), + "meshy_v6" => Ok(Self::MeshyV6), + "rodin_2p5_fast" => Ok(Self::Rodin2p5Fast), + "marble_1p0" => Ok(Self::Marble1p0), + "marble_1p0_draft" => Ok(Self::Marble1p0Draft), + "marble_1p1" => Ok(Self::Marble1p1), + "marble_1p1_plus" => Ok(Self::Marble1p1Plus), + "triposplat" => Ok(Self::TripoSplat), + "suno_music" => Ok(Self::SunoMusic), + "suno_remix" => Ok(Self::SunoRemix), + "suno_sounds" => Ok(Self::SunoSounds), + "suno_sample" => Ok(Self::SunoSample), + "seed_audio_1p0" => Ok(Self::SeedAudio1p0), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + // Image models + Self::Flux1Dev, + Self::Flux1Schnell, + Self::FluxDevJuggernaut, + Self::FluxPro1, + Self::FluxPro11, + Self::FluxPro11Ultra, + Self::FluxProKontextMax, + Self::Gemini25Flash, + Self::NanoBanana, + Self::NanoBanana2, + Self::NanoBanana2Lite, + Self::NanoBananaPro, + Self::GptImage1, + Self::GptImage1p5, + Self::GptImage2, + Self::Seedream4, + Self::Seedream4p5, + Self::Seedream5Lite, + Self::Seedream5p0Pro, + Self::Seedream5p0ProUltra, + Self::QwenEdit2511Angles, + Self::Flux2LoraAngles, + Self::GrokImage, + Self::Recraft3, + Self::Midjourney, + Self::Midjourney7, + Self::Midjourney7Niji, + Self::Midjourney8, + // Video models + Self::GrokVideo, + Self::GrokImagineVideo1p5, + Self::Kling16Pro, + Self::Kling21Pro, + Self::Kling21Master, + Self::Kling2p5TurboPro, + Self::Kling2p6Pro, + Self::Kling3p0Standard, + Self::Kling3p0Pro, + Self::HappyHorse1p0, + Self::Seedance10Lite, + Self::Seedance1p5Pro, + Self::Seedance2p0, + Self::Seedance2p0Fast, + Self::Seedance2p0Mini, + Self::Seedance2p5, + Self::Seedance2p5Edit, + Self::MinimaxH3, + Self::Sora2, + Self::Sora2Pro, + Self::Veo2, + Self::Veo3, + Self::Veo3Fast, + Self::Veo3p1, + Self::Veo3p1Fast, + Self::Veo3p1Lite, + Self::ViduQ3, + Self::ViduQ3Turbo, + // 3D Object generation models + Self::Hunyuan3d2_0, + Self::Hunyuan3d2_1, + Self::Hunyuan3d3, + Self::WorldlabsMarble, + Self::WorldlabsMarble0p1Mini, + Self::WorldlabsMarble0p1Plus, + Self::Hunyuan3d3Sketch, + Self::Hunyuan3d3p1Pro, + Self::Hunyuan3d3p1Rapid, + Self::Hunyuan3d3p1Part, + Self::Hunyuan3d3p1SmartTopology, + Self::Tripo3dH3p1, + Self::MeshyV6, + Self::Rodin2p5Fast, + Self::Marble1p0, + Self::Marble1p0Draft, + Self::Marble1p1, + Self::Marble1p1Plus, + Self::TripoSplat, + Self::SunoMusic, + Self::SunoRemix, + Self::SunoSounds, + Self::SunoSample, + Self::SeedAudio1p0, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::task_model_type::TaskModelType; + use crate::test_helpers::assert_serialization; + use crate::enums::enum_error::EnumError; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + // Image models + assert_serialization(TaskModelType::Flux1Dev, "flux_1_dev"); + assert_serialization(TaskModelType::Flux1Schnell, "flux_1_schnell"); + assert_serialization(TaskModelType::FluxDevJuggernaut, "flux_dev_juggernaut"); + assert_serialization(TaskModelType::FluxPro1, "flux_pro_1"); + assert_serialization(TaskModelType::FluxPro11, "flux_pro_1.1"); + assert_serialization(TaskModelType::FluxPro11Ultra, "flux_pro_1.1_ultra"); + assert_serialization(TaskModelType::FluxProKontextMax, "flux_pro_kontext_max"); + assert_serialization(TaskModelType::Gemini25Flash, "gemini_25_flash"); + assert_serialization(TaskModelType::NanoBanana, "nano_banana"); + assert_serialization(TaskModelType::NanoBanana2, "nano_banana_2"); + assert_serialization(TaskModelType::NanoBananaPro, "nano_banana_pro"); + assert_serialization(TaskModelType::GptImage1, "gpt_image_1"); + assert_serialization(TaskModelType::GptImage1p5, "gpt_image_1p5"); + assert_serialization(TaskModelType::GptImage2, "gpt_image_2"); + assert_serialization(TaskModelType::Seedream4, "seedream_4"); + assert_serialization(TaskModelType::Seedream4p5, "seedream_4p5"); + assert_serialization(TaskModelType::Seedream5Lite, "seedream_5_lite"); + assert_serialization(TaskModelType::Seedream5p0Pro, "seedream_5p0_pro"); + assert_serialization(TaskModelType::Seedream5p0ProUltra, "seedream_5p0_pro_u"); + assert_serialization(TaskModelType::QwenEdit2511Angles, "qwen_edit_2511_angles"); + assert_serialization(TaskModelType::Flux2LoraAngles, "flux_2_lora_angles"); + assert_serialization(TaskModelType::GrokImage, "grok_image"); + assert_serialization(TaskModelType::Recraft3, "recraft_3"); + assert_serialization(TaskModelType::Midjourney, "midjourney"); + // Video models + assert_serialization(TaskModelType::Midjourney7, "midjourney_7"); + assert_serialization(TaskModelType::Midjourney7Niji, "midjourney_7_niji"); + assert_serialization(TaskModelType::Midjourney8, "midjourney_8"); + assert_serialization(TaskModelType::GrokVideo, "grok_video"); + assert_serialization(TaskModelType::GrokImagineVideo1p5, "grok_imagine_video_1p5"); + assert_serialization(TaskModelType::Kling16Pro, "kling_1.6_pro"); + assert_serialization(TaskModelType::Kling21Pro, "kling_2.1_pro"); + assert_serialization(TaskModelType::Kling21Master, "kling_2.1_master"); + assert_serialization(TaskModelType::Kling2p5TurboPro, "kling_2p5_turbo_pro"); + assert_serialization(TaskModelType::Kling2p6Pro, "kling_2p6_pro"); + assert_serialization(TaskModelType::Kling3p0Standard, "kling_3p0_standard"); + assert_serialization(TaskModelType::Kling3p0Pro, "kling_3p0_pro"); + assert_serialization(TaskModelType::HappyHorse1p0, "happy_horse_1p0"); + assert_serialization(TaskModelType::Seedance10Lite, "seedance_1.0_lite"); + assert_serialization(TaskModelType::Seedance1p5Pro, "seedance_1p5_pro"); + assert_serialization(TaskModelType::Seedance2p0, "seedance_2p0"); + assert_serialization(TaskModelType::Seedance2p0Fast, "seedance_2p0_fast"); + assert_serialization(TaskModelType::Sora2, "sora_2"); + assert_serialization(TaskModelType::Sora2Pro, "sora_2_pro"); + assert_serialization(TaskModelType::Veo2, "veo_2"); + assert_serialization(TaskModelType::Veo3, "veo_3"); + assert_serialization(TaskModelType::Veo3Fast, "veo_3_fast"); + assert_serialization(TaskModelType::Veo3p1, "veo_3p1"); + assert_serialization(TaskModelType::Veo3p1Fast, "veo_3p1_fast"); + assert_serialization(TaskModelType::Veo3p1Lite, "veo_3p1_lite"); + assert_serialization(TaskModelType::ViduQ3, "vidu_q3"); + assert_serialization(TaskModelType::ViduQ3Turbo, "vidu_q3_turbo"); + // 3D Object generation models + assert_serialization(TaskModelType::Hunyuan3d2_0, "hunyuan_3d_2.0"); + assert_serialization(TaskModelType::Hunyuan3d2_1, "hunyuan_3d_2.1"); + assert_serialization(TaskModelType::Hunyuan3d3, "hunyuan_3d_3"); + assert_serialization(TaskModelType::WorldlabsMarble, "worldlabs_marble"); + assert_serialization(TaskModelType::WorldlabsMarble0p1Mini, "marble_0p1_mini"); + assert_serialization(TaskModelType::WorldlabsMarble0p1Plus, "marble_0p1_plus"); + assert_serialization(TaskModelType::Hunyuan3d3Sketch, "hunyuan_3d_3_sketch"); + assert_serialization(TaskModelType::Hunyuan3d3p1Pro, "hunyuan_3d_3p1_pro"); + assert_serialization(TaskModelType::Hunyuan3d3p1Rapid, "hunyuan_3d_3p1_rapid"); + assert_serialization(TaskModelType::Hunyuan3d3p1Part, "hunyuan_3d_3p1_part"); + assert_serialization(TaskModelType::Hunyuan3d3p1SmartTopology, "hunyuan_3d_3p1_topology"); + assert_serialization(TaskModelType::Tripo3dH3p1, "tripo3d_h3p1"); + assert_serialization(TaskModelType::MeshyV6, "meshy_v6"); + assert_serialization(TaskModelType::Rodin2p5Fast, "rodin_2p5_fast"); + assert_serialization(TaskModelType::Marble1p0, "marble_1p0"); + assert_serialization(TaskModelType::Marble1p0Draft, "marble_1p0_draft"); + assert_serialization(TaskModelType::Marble1p1, "marble_1p1"); + assert_serialization(TaskModelType::Marble1p1Plus, "marble_1p1_plus"); + assert_serialization(TaskModelType::TripoSplat, "triposplat"); + assert_serialization(TaskModelType::SunoMusic, "suno_music"); + assert_serialization(TaskModelType::SunoRemix, "suno_remix"); + assert_serialization(TaskModelType::SunoSounds, "suno_sounds"); + assert_serialization(TaskModelType::SunoSample, "suno_sample"); + assert_serialization(TaskModelType::SeedAudio1p0, "seed_audio_1p0"); + } + + #[test] + fn to_str() { + // Image models + assert_eq!(TaskModelType::Flux1Dev.to_str(), "flux_1_dev"); + assert_eq!(TaskModelType::Flux1Schnell.to_str(), "flux_1_schnell"); + assert_eq!(TaskModelType::FluxDevJuggernaut.to_str(), "flux_dev_juggernaut"); + assert_eq!(TaskModelType::FluxPro1.to_str(), "flux_pro_1"); + assert_eq!(TaskModelType::FluxPro11.to_str(), "flux_pro_1.1"); + assert_eq!(TaskModelType::FluxPro11Ultra.to_str(), "flux_pro_1.1_ultra"); + assert_eq!(TaskModelType::FluxProKontextMax.to_str(), "flux_pro_kontext_max"); + assert_eq!(TaskModelType::Gemini25Flash.to_str(), "gemini_25_flash"); + assert_eq!(TaskModelType::NanoBanana.to_str(), "nano_banana"); + assert_eq!(TaskModelType::NanoBanana2.to_str(), "nano_banana_2"); + assert_eq!(TaskModelType::NanoBananaPro.to_str(), "nano_banana_pro"); + assert_eq!(TaskModelType::GptImage1.to_str(), "gpt_image_1"); + assert_eq!(TaskModelType::GptImage1p5.to_str(), "gpt_image_1p5"); + assert_eq!(TaskModelType::GptImage2.to_str(), "gpt_image_2"); + assert_eq!(TaskModelType::Seedream4.to_str(), "seedream_4"); + assert_eq!(TaskModelType::Seedream4p5.to_str(), "seedream_4p5"); + assert_eq!(TaskModelType::Seedream5Lite.to_str(), "seedream_5_lite"); + assert_eq!(TaskModelType::Seedream5p0Pro.to_str(), "seedream_5p0_pro"); + assert_eq!(TaskModelType::Seedream5p0ProUltra.to_str(), "seedream_5p0_pro_u"); + assert_eq!(TaskModelType::QwenEdit2511Angles.to_str(), "qwen_edit_2511_angles"); + assert_eq!(TaskModelType::Flux2LoraAngles.to_str(), "flux_2_lora_angles"); + assert_eq!(TaskModelType::GrokImage.to_str(), "grok_image"); + assert_eq!(TaskModelType::Recraft3.to_str(), "recraft_3"); + assert_eq!(TaskModelType::Midjourney.to_str(), "midjourney"); + // Video models + assert_eq!(TaskModelType::GrokVideo.to_str(), "grok_video"); + assert_eq!(TaskModelType::GrokImagineVideo1p5.to_str(), "grok_imagine_video_1p5"); + assert_eq!(TaskModelType::Kling16Pro.to_str(), "kling_1.6_pro"); + assert_eq!(TaskModelType::Kling21Pro.to_str(), "kling_2.1_pro"); + assert_eq!(TaskModelType::Kling21Master.to_str(), "kling_2.1_master"); + assert_eq!(TaskModelType::Kling2p5TurboPro.to_str(), "kling_2p5_turbo_pro"); + assert_eq!(TaskModelType::Kling2p6Pro.to_str(), "kling_2p6_pro"); + assert_eq!(TaskModelType::Kling3p0Standard.to_str(), "kling_3p0_standard"); + assert_eq!(TaskModelType::Kling3p0Pro.to_str(), "kling_3p0_pro"); + assert_eq!(TaskModelType::HappyHorse1p0.to_str(), "happy_horse_1p0"); + assert_eq!(TaskModelType::Seedance10Lite.to_str(), "seedance_1.0_lite"); + assert_eq!(TaskModelType::Seedance1p5Pro.to_str(), "seedance_1p5_pro"); + assert_eq!(TaskModelType::Seedance2p0.to_str(), "seedance_2p0"); + assert_eq!(TaskModelType::Seedance2p0Fast.to_str(), "seedance_2p0_fast"); + assert_eq!(TaskModelType::Sora2.to_str(), "sora_2"); + assert_eq!(TaskModelType::Sora2Pro.to_str(), "sora_2_pro"); + assert_eq!(TaskModelType::Veo2.to_str(), "veo_2"); + assert_eq!(TaskModelType::Veo3.to_str(), "veo_3"); + assert_eq!(TaskModelType::Veo3Fast.to_str(), "veo_3_fast"); + assert_eq!(TaskModelType::Veo3p1.to_str(), "veo_3p1"); + assert_eq!(TaskModelType::Veo3p1Fast.to_str(), "veo_3p1_fast"); + assert_eq!(TaskModelType::Veo3p1Lite.to_str(), "veo_3p1_lite"); + assert_eq!(TaskModelType::ViduQ3.to_str(), "vidu_q3"); + assert_eq!(TaskModelType::ViduQ3Turbo.to_str(), "vidu_q3_turbo"); + // 3D Object generation models + assert_eq!(TaskModelType::Hunyuan3d2_0.to_str(), "hunyuan_3d_2.0"); + assert_eq!(TaskModelType::Hunyuan3d2_1.to_str(), "hunyuan_3d_2.1"); + assert_eq!(TaskModelType::Hunyuan3d3.to_str(), "hunyuan_3d_3"); + assert_eq!(TaskModelType::WorldlabsMarble.to_str(), "worldlabs_marble"); + assert_eq!(TaskModelType::WorldlabsMarble0p1Mini.to_str(), "marble_0p1_mini"); + assert_eq!(TaskModelType::WorldlabsMarble0p1Plus.to_str(), "marble_0p1_plus"); + assert_eq!(TaskModelType::Hunyuan3d3Sketch.to_str(), "hunyuan_3d_3_sketch"); + assert_eq!(TaskModelType::Hunyuan3d3p1Pro.to_str(), "hunyuan_3d_3p1_pro"); + assert_eq!(TaskModelType::Hunyuan3d3p1Rapid.to_str(), "hunyuan_3d_3p1_rapid"); + assert_eq!(TaskModelType::Hunyuan3d3p1Part.to_str(), "hunyuan_3d_3p1_part"); + assert_eq!(TaskModelType::Hunyuan3d3p1SmartTopology.to_str(), "hunyuan_3d_3p1_topology"); + assert_eq!(TaskModelType::Tripo3dH3p1.to_str(), "tripo3d_h3p1"); + assert_eq!(TaskModelType::MeshyV6.to_str(), "meshy_v6"); + assert_eq!(TaskModelType::Rodin2p5Fast.to_str(), "rodin_2p5_fast"); + assert_eq!(TaskModelType::Marble1p0.to_str(), "marble_1p0"); + assert_eq!(TaskModelType::Marble1p0Draft.to_str(), "marble_1p0_draft"); + assert_eq!(TaskModelType::Marble1p1.to_str(), "marble_1p1"); + assert_eq!(TaskModelType::Marble1p1Plus.to_str(), "marble_1p1_plus"); + assert_eq!(TaskModelType::TripoSplat.to_str(), "triposplat"); + assert_eq!(TaskModelType::SunoMusic.to_str(), "suno_music"); + assert_eq!(TaskModelType::SunoRemix.to_str(), "suno_remix"); + assert_eq!(TaskModelType::SunoSounds.to_str(), "suno_sounds"); + assert_eq!(TaskModelType::SunoSample.to_str(), "suno_sample"); + assert_eq!(TaskModelType::SeedAudio1p0.to_str(), "seed_audio_1p0"); + } + + #[test] + fn from_str() { + // Image models + assert_eq!(TaskModelType::from_str("flux_1_dev").unwrap(), TaskModelType::Flux1Dev); + assert_eq!(TaskModelType::from_str("flux_1_schnell").unwrap(), TaskModelType::Flux1Schnell); + assert_eq!(TaskModelType::from_str("flux_dev_juggernaut").unwrap(), TaskModelType::FluxDevJuggernaut); + assert_eq!(TaskModelType::from_str("flux_pro_1").unwrap(), TaskModelType::FluxPro1); + assert_eq!(TaskModelType::from_str("flux_pro_1.1").unwrap(), TaskModelType::FluxPro11); + assert_eq!(TaskModelType::from_str("flux_pro_1.1_ultra").unwrap(), TaskModelType::FluxPro11Ultra); + assert_eq!(TaskModelType::from_str("flux_pro_kontext_max").unwrap(), TaskModelType::FluxProKontextMax); + assert_eq!(TaskModelType::from_str("gemini_25_flash").unwrap(), TaskModelType::Gemini25Flash); + assert_eq!(TaskModelType::from_str("nano_banana").unwrap(), TaskModelType::NanoBanana); + assert_eq!(TaskModelType::from_str("nano_banana_2").unwrap(), TaskModelType::NanoBanana2); + assert_eq!(TaskModelType::from_str("nano_banana_pro").unwrap(), TaskModelType::NanoBananaPro); + assert_eq!(TaskModelType::from_str("gpt_image_1").unwrap(), TaskModelType::GptImage1); + assert_eq!(TaskModelType::from_str("gpt_image_1p5").unwrap(), TaskModelType::GptImage1p5); + assert_eq!(TaskModelType::from_str("gpt_image_2").unwrap(), TaskModelType::GptImage2); + assert_eq!(TaskModelType::from_str("seedream_4").unwrap(), TaskModelType::Seedream4); + assert_eq!(TaskModelType::from_str("seedream_4p5").unwrap(), TaskModelType::Seedream4p5); + assert_eq!(TaskModelType::from_str("seedream_5_lite").unwrap(), TaskModelType::Seedream5Lite); + assert_eq!(TaskModelType::from_str("seedream_5p0_pro").unwrap(), TaskModelType::Seedream5p0Pro); + assert_eq!(TaskModelType::from_str("seedream_5p0_pro_u").unwrap(), TaskModelType::Seedream5p0ProUltra); + assert_eq!(TaskModelType::from_str("qwen_edit_2511_angles").unwrap(), TaskModelType::QwenEdit2511Angles); + assert_eq!(TaskModelType::from_str("flux_2_lora_angles").unwrap(), TaskModelType::Flux2LoraAngles); + assert_eq!(TaskModelType::from_str("grok_image").unwrap(), TaskModelType::GrokImage); + assert_eq!(TaskModelType::from_str("recraft_3").unwrap(), TaskModelType::Recraft3); + assert_eq!(TaskModelType::from_str("midjourney").unwrap(), TaskModelType::Midjourney); + // Video models + assert_eq!(TaskModelType::from_str("grok_video").unwrap(), TaskModelType::GrokVideo); + assert_eq!(TaskModelType::from_str("grok_imagine_video_1p5").unwrap(), TaskModelType::GrokImagineVideo1p5); + assert_eq!(TaskModelType::from_str("kling_1.6_pro").unwrap(), TaskModelType::Kling16Pro); + assert_eq!(TaskModelType::from_str("kling_2.1_pro").unwrap(), TaskModelType::Kling21Pro); + assert_eq!(TaskModelType::from_str("kling_2.1_master").unwrap(), TaskModelType::Kling21Master); + assert_eq!(TaskModelType::from_str("kling_2p5_turbo_pro").unwrap(), TaskModelType::Kling2p5TurboPro); + assert_eq!(TaskModelType::from_str("kling_2p6_pro").unwrap(), TaskModelType::Kling2p6Pro); + assert_eq!(TaskModelType::from_str("kling_3p0_standard").unwrap(), TaskModelType::Kling3p0Standard); + assert_eq!(TaskModelType::from_str("kling_3p0_pro").unwrap(), TaskModelType::Kling3p0Pro); + assert_eq!(TaskModelType::from_str("happy_horse_1p0").unwrap(), TaskModelType::HappyHorse1p0); + assert_eq!(TaskModelType::from_str("seedance_1.0_lite").unwrap(), TaskModelType::Seedance10Lite); + assert_eq!(TaskModelType::from_str("seedance_1p5_pro").unwrap(), TaskModelType::Seedance1p5Pro); + assert_eq!(TaskModelType::from_str("seedance_2p0").unwrap(), TaskModelType::Seedance2p0); + assert_eq!(TaskModelType::from_str("seedance_2p0_fast").unwrap(), TaskModelType::Seedance2p0Fast); + assert_eq!(TaskModelType::from_str("sora_2").unwrap(), TaskModelType::Sora2); + assert_eq!(TaskModelType::from_str("sora_2_pro").unwrap(), TaskModelType::Sora2Pro); + assert_eq!(TaskModelType::from_str("veo_2").unwrap(), TaskModelType::Veo2); + assert_eq!(TaskModelType::from_str("veo_3").unwrap(), TaskModelType::Veo3); + assert_eq!(TaskModelType::from_str("veo_3_fast").unwrap(), TaskModelType::Veo3Fast); + assert_eq!(TaskModelType::from_str("veo_3p1").unwrap(), TaskModelType::Veo3p1); + assert_eq!(TaskModelType::from_str("veo_3p1_fast").unwrap(), TaskModelType::Veo3p1Fast); + assert_eq!(TaskModelType::from_str("veo_3p1_lite").unwrap(), TaskModelType::Veo3p1Lite); + assert_eq!(TaskModelType::from_str("vidu_q3").unwrap(), TaskModelType::ViduQ3); + assert_eq!(TaskModelType::from_str("vidu_q3_turbo").unwrap(), TaskModelType::ViduQ3Turbo); + // 3D Object generation models + assert_eq!(TaskModelType::from_str("hunyuan_3d_2.0").unwrap(), TaskModelType::Hunyuan3d2_0); + assert_eq!(TaskModelType::from_str("hunyuan_3d_2.1").unwrap(), TaskModelType::Hunyuan3d2_1); + assert_eq!(TaskModelType::from_str("hunyuan_3d_3").unwrap(), TaskModelType::Hunyuan3d3); + assert_eq!(TaskModelType::from_str("worldlabs_marble").unwrap(), TaskModelType::WorldlabsMarble); + assert_eq!(TaskModelType::from_str("marble_0p1_mini").unwrap(), TaskModelType::WorldlabsMarble0p1Mini); + assert_eq!(TaskModelType::from_str("marble_0p1_plus").unwrap(), TaskModelType::WorldlabsMarble0p1Plus); + assert_eq!(TaskModelType::from_str("hunyuan_3d_3_sketch").unwrap(), TaskModelType::Hunyuan3d3Sketch); + assert_eq!(TaskModelType::from_str("hunyuan_3d_3p1_pro").unwrap(), TaskModelType::Hunyuan3d3p1Pro); + assert_eq!(TaskModelType::from_str("hunyuan_3d_3p1_rapid").unwrap(), TaskModelType::Hunyuan3d3p1Rapid); + assert_eq!(TaskModelType::from_str("hunyuan_3d_3p1_part").unwrap(), TaskModelType::Hunyuan3d3p1Part); + assert_eq!(TaskModelType::from_str("hunyuan_3d_3p1_topology").unwrap(), TaskModelType::Hunyuan3d3p1SmartTopology); + assert_eq!(TaskModelType::from_str("tripo3d_h3p1").unwrap(), TaskModelType::Tripo3dH3p1); + assert_eq!(TaskModelType::from_str("meshy_v6").unwrap(), TaskModelType::MeshyV6); + assert_eq!(TaskModelType::from_str("rodin_2p5_fast").unwrap(), TaskModelType::Rodin2p5Fast); + assert_eq!(TaskModelType::from_str("marble_1p0").unwrap(), TaskModelType::Marble1p0); + assert_eq!(TaskModelType::from_str("marble_1p0_draft").unwrap(), TaskModelType::Marble1p0Draft); + assert_eq!(TaskModelType::from_str("marble_1p1").unwrap(), TaskModelType::Marble1p1); + assert_eq!(TaskModelType::from_str("marble_1p1_plus").unwrap(), TaskModelType::Marble1p1Plus); + assert_eq!(TaskModelType::from_str("triposplat").unwrap(), TaskModelType::TripoSplat); + assert_eq!(TaskModelType::from_str("suno_music").unwrap(), TaskModelType::SunoMusic); + assert_eq!(TaskModelType::from_str("suno_remix").unwrap(), TaskModelType::SunoRemix); + assert_eq!(TaskModelType::from_str("suno_sounds").unwrap(), TaskModelType::SunoSounds); + assert_eq!(TaskModelType::from_str("suno_sample").unwrap(), TaskModelType::SunoSample); + assert_eq!(TaskModelType::from_str("seed_audio_1p0").unwrap(), TaskModelType::SeedAudio1p0); + } + + #[test] + fn from_str_err() { + let result = TaskModelType::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = TaskModelType::all_variants(); + assert_eq!(variants.len(), 80); + // Image models + assert_eq!(variants.pop_first(), Some(TaskModelType::Flux1Dev)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Flux1Schnell)); + assert_eq!(variants.pop_first(), Some(TaskModelType::FluxDevJuggernaut)); + assert_eq!(variants.pop_first(), Some(TaskModelType::FluxPro1)); + assert_eq!(variants.pop_first(), Some(TaskModelType::FluxPro11)); + assert_eq!(variants.pop_first(), Some(TaskModelType::FluxPro11Ultra)); + assert_eq!(variants.pop_first(), Some(TaskModelType::FluxProKontextMax)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Gemini25Flash)); + assert_eq!(variants.pop_first(), Some(TaskModelType::NanoBanana)); + assert_eq!(variants.pop_first(), Some(TaskModelType::NanoBanana2)); + assert_eq!(variants.pop_first(), Some(TaskModelType::NanoBanana2Lite)); + assert_eq!(variants.pop_first(), Some(TaskModelType::NanoBananaPro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::GptImage1)); + assert_eq!(variants.pop_first(), Some(TaskModelType::GptImage1p5)); + assert_eq!(variants.pop_first(), Some(TaskModelType::GptImage2)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedream4)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedream4p5)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedream5Lite)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedream5p0Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedream5p0ProUltra)); + assert_eq!(variants.pop_first(), Some(TaskModelType::QwenEdit2511Angles)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Flux2LoraAngles)); + assert_eq!(variants.pop_first(), Some(TaskModelType::GrokImage)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Recraft3)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Midjourney)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Midjourney7)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Midjourney7Niji)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Midjourney8)); + // Video models + assert_eq!(variants.pop_first(), Some(TaskModelType::GrokVideo)); + assert_eq!(variants.pop_first(), Some(TaskModelType::GrokImagineVideo1p5)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling16Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling21Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling21Master)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling2p5TurboPro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling2p6Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling3p0Standard)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Kling3p0Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::HappyHorse1p0)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance10Lite)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance1p5Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance2p0)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance2p0Fast)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance2p0Mini)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance2p5)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Seedance2p5Edit)); + assert_eq!(variants.pop_first(), Some(TaskModelType::MinimaxH3)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Sora2)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Sora2Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Veo2)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Veo3)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Veo3Fast)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Veo3p1)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Veo3p1Fast)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Veo3p1Lite)); + assert_eq!(variants.pop_first(), Some(TaskModelType::ViduQ3)); + assert_eq!(variants.pop_first(), Some(TaskModelType::ViduQ3Turbo)); + // 3D Object generation models + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d2_0)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d2_1)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d3)); + assert_eq!(variants.pop_first(), Some(TaskModelType::WorldlabsMarble)); + assert_eq!(variants.pop_first(), Some(TaskModelType::WorldlabsMarble0p1Mini)); + assert_eq!(variants.pop_first(), Some(TaskModelType::WorldlabsMarble0p1Plus)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d3Sketch)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d3p1Pro)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d3p1Rapid)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d3p1Part)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Hunyuan3d3p1SmartTopology)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Tripo3dH3p1)); + assert_eq!(variants.pop_first(), Some(TaskModelType::MeshyV6)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Rodin2p5Fast)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Marble1p0)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Marble1p0Draft)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Marble1p1)); + assert_eq!(variants.pop_first(), Some(TaskModelType::Marble1p1Plus)); + assert_eq!(variants.pop_first(), Some(TaskModelType::TripoSplat)); + assert_eq!(variants.pop_first(), Some(TaskModelType::SunoMusic)); + assert_eq!(variants.pop_first(), Some(TaskModelType::SunoRemix)); + assert_eq!(variants.pop_first(), Some(TaskModelType::SunoSounds)); + assert_eq!(variants.pop_first(), Some(TaskModelType::SunoSample)); + assert_eq!(variants.pop_first(), Some(TaskModelType::SeedAudio1p0)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(TaskModelType::all_variants().len(), TaskModelType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TaskModelType::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, TaskModelType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TaskModelType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TaskModelType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + #[test] + fn serialized_length_ok_for_database() { + const MAX_LENGTH : usize = 24; + for variant in TaskModelType::all_variants() { + let serialized = variant.to_str(); + assert!(serialized.len() > 0, "variant {:?} is too short", variant); + assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/enums/task_status.rs b/crates/schema/sqlite_identifiers/src/enums/task_status.rs new file mode 100644 index 00000000..70a55a98 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/task_status.rs @@ -0,0 +1,183 @@ +use std::collections::BTreeSet; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TaskStatus { + Pending, + Started, + CompleteSuccess, + CompleteFailure, + AttemptFailed, + Dead, + CancelledByUser, + CancelledByProvider, + CancelledByUs, +} + +impl_enum_display_and_debug_using_to_str!(TaskStatus); +//impl_mysql_enum_coders!(TaskStatus); +//impl_mysql_from_row!(TaskStatus); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl Default for TaskStatus { + fn default() -> Self { + Self::Pending + } +} + +impl TaskStatus { + pub const fn to_str(&self) -> &'static str { + match self { + Self::Pending => "pending", + Self::Started => "started", + Self::CompleteSuccess => "complete_success", + Self::CompleteFailure => "complete_failure", + Self::AttemptFailed => "attempt_failed", + Self::Dead => "dead", + Self::CancelledByUser => "cancelled_by_user", + Self::CancelledByProvider => "cancelled_by_provider", + Self::CancelledByUs => "cancelled_by_us", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "pending" => Ok(Self::Pending), + "started" => Ok(Self::Started), + "complete_success" => Ok(Self::CompleteSuccess), + "complete_failure" => Ok(Self::CompleteFailure), + "attempt_failed" => Ok(Self::AttemptFailed), + "dead" => Ok(Self::Dead), + "cancelled_by_user" => Ok(Self::CancelledByUser), + "cancelled_by_provider" => Ok(Self::CancelledByProvider), + "cancelled_by_us" => Ok(Self::CancelledByUs), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::Pending, + Self::Started, + Self::CompleteSuccess, + Self::CompleteFailure, + Self::AttemptFailed, + Self::Dead, + Self::CancelledByUser, + Self::CancelledByProvider, + Self::CancelledByUs, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::task_status::TaskStatus; + use crate::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::enum_error::EnumError; + + #[test] + fn test_default() { + assert_eq!(TaskStatus::default(), TaskStatus::Pending); + } + + #[test] + fn test_serialization() { + assert_serialization(TaskStatus::Pending, "pending"); + assert_serialization(TaskStatus::Started, "started"); + assert_serialization(TaskStatus::CompleteSuccess, "complete_success"); + assert_serialization(TaskStatus::CompleteFailure, "complete_failure"); + assert_serialization(TaskStatus::AttemptFailed, "attempt_failed"); + assert_serialization(TaskStatus::Dead, "dead"); + assert_serialization(TaskStatus::CancelledByUser, "cancelled_by_user"); + assert_serialization(TaskStatus::CancelledByProvider, "cancelled_by_provider"); + assert_serialization(TaskStatus::CancelledByUs, "cancelled_by_us"); + } + + #[test] + fn to_str() { + assert_eq!(TaskStatus::Pending.to_str(), "pending"); + assert_eq!(TaskStatus::Started.to_str(), "started"); + assert_eq!(TaskStatus::CompleteSuccess.to_str(), "complete_success"); + assert_eq!(TaskStatus::CompleteFailure.to_str(), "complete_failure"); + assert_eq!(TaskStatus::AttemptFailed.to_str(), "attempt_failed"); + assert_eq!(TaskStatus::Dead.to_str(), "dead"); + assert_eq!(TaskStatus::CancelledByUser.to_str(), "cancelled_by_user"); + assert_eq!(TaskStatus::CancelledByProvider.to_str(), "cancelled_by_provider"); + assert_eq!(TaskStatus::CancelledByUs.to_str(), "cancelled_by_us"); + } + + #[test] + fn from_str() { + assert_eq!(TaskStatus::from_str("pending").unwrap(), TaskStatus::Pending); + assert_eq!(TaskStatus::from_str("started").unwrap(), TaskStatus::Started); + assert_eq!(TaskStatus::from_str("complete_success").unwrap(), TaskStatus::CompleteSuccess); + assert_eq!(TaskStatus::from_str("complete_failure").unwrap(), TaskStatus::CompleteFailure); + assert_eq!(TaskStatus::from_str("attempt_failed").unwrap(), TaskStatus::AttemptFailed); + assert_eq!(TaskStatus::from_str("dead").unwrap(), TaskStatus::Dead); + assert_eq!(TaskStatus::from_str("cancelled_by_user").unwrap(), TaskStatus::CancelledByUser); + assert_eq!(TaskStatus::from_str("cancelled_by_provider").unwrap(), TaskStatus::CancelledByProvider); + assert_eq!(TaskStatus::from_str("cancelled_by_us").unwrap(), TaskStatus::CancelledByUs); + } + + #[test] + fn from_str_err() { + let result = TaskStatus::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = TaskStatus::all_variants(); + assert_eq!(variants.len(), 9); + assert_eq!(variants.pop_first(), Some(TaskStatus::Pending)); + assert_eq!(variants.pop_first(), Some(TaskStatus::Started)); + assert_eq!(variants.pop_first(), Some(TaskStatus::CompleteSuccess)); + assert_eq!(variants.pop_first(), Some(TaskStatus::CompleteFailure)); + assert_eq!(variants.pop_first(), Some(TaskStatus::AttemptFailed)); + assert_eq!(variants.pop_first(), Some(TaskStatus::Dead)); + assert_eq!(variants.pop_first(), Some(TaskStatus::CancelledByUser)); + assert_eq!(variants.pop_first(), Some(TaskStatus::CancelledByProvider)); + assert_eq!(variants.pop_first(), Some(TaskStatus::CancelledByUs)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(TaskStatus::all_variants().len(), TaskStatus::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TaskStatus::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, TaskStatus::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TaskStatus::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TaskStatus::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/enums/task_type.rs b/crates/schema/sqlite_identifiers/src/enums/task_type.rs new file mode 100644 index 00000000..d8471dda --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/task_type.rs @@ -0,0 +1,140 @@ +use std::collections::BTreeSet; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TaskType { + ImageGeneration, + VideoGeneration, + AudioGeneration, + MeshGeneration, + SplatGeneration, +} + +impl_enum_display_and_debug_using_to_str!(TaskType); +//impl_mysql_enum_coders!(TaskType); +//impl_mysql_from_row!(TaskType); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl TaskType { + pub fn to_str(&self) -> &'static str { + match self { + Self::ImageGeneration => "image_generation", + Self::VideoGeneration => "video_generation", + Self::AudioGeneration => "audio_generation", + Self::MeshGeneration => "mesh_generation", + Self::SplatGeneration => "splat_generation", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "image_generation" => Ok(Self::ImageGeneration), + "video_generation" => Ok(Self::VideoGeneration), + "audio_generation" => Ok(Self::AudioGeneration), + "mesh_generation" => Ok(Self::MeshGeneration), + "splat_generation" => Ok(Self::SplatGeneration), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ImageGeneration, + Self::VideoGeneration, + Self::AudioGeneration, + Self::MeshGeneration, + Self::SplatGeneration, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::task_type::TaskType; + use crate::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + use crate::enums::enum_error::EnumError; + + #[test] + fn test_serialization() { + assert_serialization(TaskType::ImageGeneration, "image_generation"); + assert_serialization(TaskType::VideoGeneration, "video_generation"); + assert_serialization(TaskType::AudioGeneration, "audio_generation"); + assert_serialization(TaskType::MeshGeneration, "mesh_generation"); + assert_serialization(TaskType::SplatGeneration, "splat_generation"); + } + + #[test] + fn to_str() { + assert_eq!(TaskType::ImageGeneration.to_str(), "image_generation"); + assert_eq!(TaskType::VideoGeneration.to_str(), "video_generation"); + assert_eq!(TaskType::AudioGeneration.to_str(), "audio_generation"); + assert_eq!(TaskType::MeshGeneration.to_str(), "mesh_generation"); + assert_eq!(TaskType::SplatGeneration.to_str(), "splat_generation"); + } + + #[test] + fn from_str() { + assert_eq!(TaskType::from_str("image_generation").unwrap(), TaskType::ImageGeneration); + assert_eq!(TaskType::from_str("video_generation").unwrap(), TaskType::VideoGeneration); + assert_eq!(TaskType::from_str("audio_generation").unwrap(), TaskType::AudioGeneration); + assert_eq!(TaskType::from_str("mesh_generation").unwrap(), TaskType::MeshGeneration); + assert_eq!(TaskType::from_str("splat_generation").unwrap(), TaskType::SplatGeneration); + } + + #[test] + fn from_str_err() { + let result = TaskType::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = TaskType::all_variants(); + assert_eq!(variants.len(), 5); + assert_eq!(variants.pop_first(), Some(TaskType::ImageGeneration)); + assert_eq!(variants.pop_first(), Some(TaskType::VideoGeneration)); + assert_eq!(variants.pop_first(), Some(TaskType::AudioGeneration)); + assert_eq!(variants.pop_first(), Some(TaskType::MeshGeneration)); + assert_eq!(variants.pop_first(), Some(TaskType::SplatGeneration)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + + #[test] + fn variant_length() { + use strum::IntoEnumIterator; + assert_eq!(TaskType::all_variants().len(), TaskType::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TaskType::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, TaskType::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TaskType::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TaskType::from_str(&format!("{:?}", variant)).unwrap()); + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/enums/tauri_command_caller.rs b/crates/schema/sqlite_identifiers/src/enums/tauri_command_caller.rs new file mode 100644 index 00000000..2f8f8778 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/enums/tauri_command_caller.rs @@ -0,0 +1,155 @@ +use std::collections::BTreeSet; + +use crate::enums::enum_error::EnumError; +#[cfg(test)] +use strum::EnumCount; +#[cfg(test)] +use strum::EnumIter; + +/// Which frontend page/component invoked a Tauri command. +/// These values are stored in the tasks database, so keep them short-ish. +#[cfg_attr(test, derive(EnumIter, EnumCount))] +#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum TauriCommandCaller { + /// The image generation page + ImagePage, + /// The video generation page + VideoPage, + /// The audio generation page + AudioPage, + /// The mesh (3D object) generation page + MeshPage, + /// The splat (3D world) generation page + SplatPage, +} + +impl_enum_display_and_debug_using_to_str!(TauriCommandCaller); + +// NB: We can derive `sqlx::Type` instead of using `impl_mysql_enum_coders` + +impl TauriCommandCaller { + pub fn to_str(&self) -> &'static str { + match self { + Self::ImagePage => "image_page", + Self::VideoPage => "video_page", + Self::AudioPage => "audio_page", + Self::MeshPage => "mesh_page", + Self::SplatPage => "splat_page", + } + } + + pub fn from_str(value: &str) -> Result { + match value { + "image_page" => Ok(Self::ImagePage), + "video_page" => Ok(Self::VideoPage), + "audio_page" => Ok(Self::AudioPage), + "mesh_page" => Ok(Self::MeshPage), + "splat_page" => Ok(Self::SplatPage), + _ => Err(EnumError::CouldNotConvertFromString(value.to_string())), + } + } + + pub fn all_variants() -> BTreeSet { + // NB: BTreeSet is sorted + // NB: BTreeSet::from() isn't const, but not worth using LazyStatic, etc. + BTreeSet::from([ + Self::ImagePage, + Self::VideoPage, + Self::AudioPage, + Self::MeshPage, + Self::SplatPage, + ]) + } +} + +#[cfg(test)] +mod tests { + use crate::enums::enum_error::EnumError; + use crate::enums::tauri_command_caller::TauriCommandCaller; + use crate::test_helpers::assert_serialization; + + mod explicit_checks { + use super::*; + + #[test] + fn test_serialization() { + assert_serialization(TauriCommandCaller::ImagePage, "image_page"); + assert_serialization(TauriCommandCaller::VideoPage, "video_page"); + assert_serialization(TauriCommandCaller::AudioPage, "audio_page"); + assert_serialization(TauriCommandCaller::MeshPage, "mesh_page"); + assert_serialization(TauriCommandCaller::SplatPage, "splat_page"); + } + + #[test] + fn to_str() { + assert_eq!(TauriCommandCaller::ImagePage.to_str(), "image_page"); + assert_eq!(TauriCommandCaller::VideoPage.to_str(), "video_page"); + assert_eq!(TauriCommandCaller::AudioPage.to_str(), "audio_page"); + assert_eq!(TauriCommandCaller::MeshPage.to_str(), "mesh_page"); + assert_eq!(TauriCommandCaller::SplatPage.to_str(), "splat_page"); + } + + #[test] + fn from_str() { + assert_eq!(TauriCommandCaller::from_str("image_page").unwrap(), TauriCommandCaller::ImagePage); + assert_eq!(TauriCommandCaller::from_str("video_page").unwrap(), TauriCommandCaller::VideoPage); + assert_eq!(TauriCommandCaller::from_str("audio_page").unwrap(), TauriCommandCaller::AudioPage); + assert_eq!(TauriCommandCaller::from_str("mesh_page").unwrap(), TauriCommandCaller::MeshPage); + assert_eq!(TauriCommandCaller::from_str("splat_page").unwrap(), TauriCommandCaller::SplatPage); + } + + #[test] + fn from_str_err() { + let result = TauriCommandCaller::from_str("asdf"); + assert!(result.is_err()); + if let Err(EnumError::CouldNotConvertFromString(value)) = result { + assert_eq!(value, "asdf"); + } else { + panic!("Expected EnumError::CouldNotConvertFromString"); + } + } + + #[test] + fn all_variants() { + let mut variants = TauriCommandCaller::all_variants(); + assert_eq!(variants.len(), 5); + assert_eq!(variants.pop_first(), Some(TauriCommandCaller::ImagePage)); + assert_eq!(variants.pop_first(), Some(TauriCommandCaller::VideoPage)); + assert_eq!(variants.pop_first(), Some(TauriCommandCaller::AudioPage)); + assert_eq!(variants.pop_first(), Some(TauriCommandCaller::MeshPage)); + assert_eq!(variants.pop_first(), Some(TauriCommandCaller::SplatPage)); + assert_eq!(variants.pop_first(), None); + } + } + + mod mechanical_checks { + use super::*; + use strum::IntoEnumIterator; + + #[test] + fn variant_length() { + assert_eq!(TauriCommandCaller::all_variants().len(), TauriCommandCaller::iter().len()); + } + + #[test] + fn round_trip() { + for variant in TauriCommandCaller::all_variants() { + // Test to_str(), from_str(), Display, and Debug. + assert_eq!(variant, TauriCommandCaller::from_str(variant.to_str()).unwrap()); + assert_eq!(variant, TauriCommandCaller::from_str(&format!("{}", variant)).unwrap()); + assert_eq!(variant, TauriCommandCaller::from_str(&format!("{:?}", variant)).unwrap()); + } + } + + //#[test] + //fn serialized_length_ok_for_database() { + // const MAX_LENGTH : usize = 16; + // for variant in TauriCommandCaller::all_variants() { + // let serialized = variant.to_str(); + // assert!(serialized.len() > 0, "variant {:?} is too short", variant); + // assert!(serialized.len() <= MAX_LENGTH, "variant {:?} is too long", variant); + // } + //} + } +} diff --git a/crates/schema/sqlite_identifiers/src/ids/batch_generation_token.rs b/crates/schema/sqlite_identifiers/src/ids/batch_generation_token.rs new file mode 100644 index 00000000..2617b09a --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/ids/batch_generation_token.rs @@ -0,0 +1,12 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for Audit Logs. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct BatchGenerationToken(pub String); + +impl_crockford_generator!(BatchGenerationToken, 32usize, "batch_g_", crate::CROCKFORD_LOWERCASE_CHARSET); +impl_string_token!(BatchGenerationToken); diff --git a/crates/schema/sqlite_identifiers/src/ids/media_file_token.rs b/crates/schema/sqlite_identifiers/src/ids/media_file_token.rs new file mode 100644 index 00000000..b4dce37e --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/ids/media_file_token.rs @@ -0,0 +1,12 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for Media Files +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct MediaFileToken(pub String); + +impl_string_token!(MediaFileToken); +impl_crockford_generator!(MediaFileToken, 32usize, "m_", crate::CROCKFORD_LOWERCASE_CHARSET); diff --git a/crates/schema/sqlite_identifiers/src/ids/mod.rs b/crates/schema/sqlite_identifiers/src/ids/mod.rs new file mode 100644 index 00000000..0c1b0b31 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/ids/mod.rs @@ -0,0 +1,4 @@ +pub mod batch_generation_token; +pub mod media_file_token; +pub mod prompt_token; +pub mod task_id; diff --git a/crates/schema/sqlite_identifiers/src/ids/prompt_token.rs b/crates/schema/sqlite_identifiers/src/ids/prompt_token.rs new file mode 100644 index 00000000..6088fd52 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/ids/prompt_token.rs @@ -0,0 +1,12 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for Prompts +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize, Deserialize)] +pub struct PromptToken(pub String); + +impl_crockford_generator!(PromptToken, 32usize, "prompt_", crate::CROCKFORD_LOWERCASE_CHARSET); +impl_string_token!(PromptToken); diff --git a/crates/schema/sqlite_identifiers/src/ids/task_id.rs b/crates/schema/sqlite_identifiers/src/ids/task_id.rs new file mode 100644 index 00000000..ff7344eb --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/ids/task_id.rs @@ -0,0 +1,12 @@ +use std::fmt::Debug; + +use serde::Deserialize; +use serde::Serialize; + + +/// The primary key for tasks (Tauri / Sqlite) +#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize)] +pub struct TaskId(pub String); + +impl_string_token!(TaskId); +impl_crockford_generator!(TaskId, 32usize, "task_", crate::CROCKFORD_MIXED_CASE_CHARSET); diff --git a/crates/schema/sqlite_identifiers/src/lib.rs b/crates/schema/sqlite_identifiers/src/lib.rs new file mode 100644 index 00000000..c9e04a77 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/lib.rs @@ -0,0 +1,114 @@ +//! Strongly-typed identifiers and enums for the desktop app's local SQLite +//! tasks database — the types that cross the query boundary as keys or +//! stored enum strings. Extracted from the `enums` / `tokens` crates so the +//! task database has a small, database-free dependency. + +#[macro_use] extern crate serde_derive; + +// Crockford characters +// https://en.wikipedia.org/wiki/Base32#Crockford's_Base32 +pub(crate) const CROCKFORD_LOWERCASE_CHARSET: &[u8] = b"0123456789abcdefghjkmnpqrstvwxyz"; +pub(crate) const CROCKFORD_MIXED_CASE_CHARSET: &[u8] = b"0123456789ABCDEFGHJKMNPQRSTVWXYZabcdefghjkmnpqrstvwxyz"; + +/// Display + Debug via `to_str()` for string-backed enums. +#[macro_export] +macro_rules! impl_enum_display_and_debug_using_to_str { + ($t:ident) => { + impl std::fmt::Display for $t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.to_str()) + } + } + impl std::fmt::Debug for $t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.to_str()) + } + } + }; +} + +/// Constructors and accessors for string-backed token newtypes. +#[macro_export] +macro_rules! impl_string_token { + ($t:ident) => { + impl $t { + #[inline] + pub fn new(value: String) -> Self { + $t(value) + } + + #[inline] + pub fn new_from_str(value: &str) -> Self { + $t(value.to_string()) + } + + #[inline] + pub fn as_str(&self) -> &str { + &self.0 + } + + /// The part of the token after the prefix (best-effort: returns the + /// whole string if the prefix doesn't match). + #[inline] + pub fn entropy_suffix(&self) -> &str { + self.0.strip_prefix(Self::PREFIX).unwrap_or(&self.0) + } + } + + impl std::fmt::Display for $t { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.0) + } + } + }; +} + +/// `generate()` for prefixed Crockford tokens: `{prefix}{entropy}` where the +/// total length is `$total_string_length`. Matches the original `tokens` +/// crate generator (including the safe-entropy re-roll). +#[macro_export] +macro_rules! impl_crockford_generator { + ($t:ident, $total_string_length:literal, $prefix:literal, $charset:expr) => { + impl $t { + pub const PREFIX: &'static str = $prefix; + + /// Constructor for a new token. + #[inline] + pub fn generate() -> Self { + use rand::Rng; + + let mut rng = rand::thread_rng(); + + let charset: &[u8] = $charset; + let entropy_length = $total_string_length.saturating_sub($prefix.len()); + + let mut entropy_part: String = (0..entropy_length) + .map(|_| { + let idx = rng.gen_range(0..charset.len()); + charset[idx] as char + }) + .collect(); + + let mut i = 0; + while !$crate::safe_entropy::entropy_is_safe(&entropy_part) && i < 10 { + i += 1; + entropy_part = (0..entropy_length) + .map(|_| { + let idx = rng.gen_range(0..charset.len()); + charset[idx] as char + }) + .collect(); + } + + $t(format!("{}{}", $prefix, entropy_part)) + } + } + }; +} + +pub mod enums; +pub mod ids; +pub(crate) mod safe_entropy; + +#[cfg(test)] +pub(crate) mod test_helpers; diff --git a/crates/schema/sqlite_identifiers/src/safe_entropy.rs b/crates/schema/sqlite_identifiers/src/safe_entropy.rs new file mode 100644 index 00000000..d5d1d6e4 --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/safe_entropy.rs @@ -0,0 +1,127 @@ + + +// Don't generate slurs or dangerous terms in the token generator +// Beware, this is an n*m*k operation. +// see: https://news.ycombinator.com/item?id=35337210 +// see: https://www.reddit.com/r/ProgrammerHumor/comments/3ov56n/randomly_generating_ids_can_be_dangerous/ +// see: https://stackoverflow.com/a/36294356 +#[inline] +pub fn entropy_is_safe(entropic_string: &str) -> bool { + let entropic_string = entropic_string.to_lowercase(); + for bad in BAD_LIST.iter() { + if entropic_string.contains(bad) { + return false; + } + } + true +} + +/// This list of atoms should be kept *short* and the atoms themselves should +/// be short as long strings are improbable. +/// Some of this list came via ChatGPT. +/// Note: Crockford does not have `i`, `l`, `o`, `u`, ... +const BAD_LIST : [&str; 64] = [ + "000", + "111", + "1s15", // ISIS + "1s1s", // ISIS + "1sd", + "455", // ass + "4s5", // ass + "4ss", // ass + "53x", + "5ex", // sex + "5h1t", + "a1ep", // https://news.ycombinator.com/item?id=35337210 + "a55", // ass + "a5s", // ass + "as5", // ass + "ass", + "b0mb", + "bmb", // bomb + "crp", + "cvm", // cum + "d1c", // dick + "d1e", // die + "d1k", // dick + "dyk", // dyk[e] / ~dick + "f3c", + "f4ck", // fuck + "f4g", // fag + "fag", + "fec", + "fvc", // fvc[k] + "fvk", // fuck + "g0d", + "g4y", // gay + "gay", + "gvn", // gun + "jew", + "k11", // kill + "mvs", + "n1g", + "p00", + "p0t", + "p15", // piss + "p1s", // piss + "p33", // pee + "p3e", // pee + "p3n", // p3n[1s] + "pcp", + "pe3", // pee + "pee", + "pen", // pen[1s] + "pn15", // penis + "pn5", // penis + "pns", // penis + "pvs", // pus + "r1p", + "s3x", // sex + "sex", + "sh1t", // shit + "sht", // shit + "t1t", + "tw4t", // twat + "twt", // twat + "war", + "xxx", +]; + +#[cfg(test)] +mod tests { + use crate::CROCKFORD_LOWERCASE_CHARSET; + use super::BAD_LIST; + + mod do_not_waste_compute { + use std::collections::HashSet; + use super::*; + + #[test] + fn no_duplicates() { + let set = HashSet::from(BAD_LIST); + assert_eq!(set.len(), BAD_LIST.len()); + } + + #[test] + fn every_bad_word_is_crockford() { + for bad in BAD_LIST.iter() { + for c_test in bad.chars() { + if !CROCKFORD_LOWERCASE_CHARSET.contains(&(c_test as u8)) { + panic!("Bad word '{}' contains non-crockford character '{}'", bad, c_test); + } + } + } + } + + #[test] + fn no_bad_word_is_a_subset_of_another_bad_word() { + for bad_large in BAD_LIST.iter() { + for bad_small in BAD_LIST.iter() { + if bad_large != bad_small && bad_large.contains(bad_small) { + panic!("Bad word '{}' contains another bad word '{}'", bad_large, bad_small); + } + } + } + } + } +} diff --git a/crates/schema/sqlite_identifiers/src/test_helpers.rs b/crates/schema/sqlite_identifiers/src/test_helpers.rs new file mode 100644 index 00000000..3a1eafcd --- /dev/null +++ b/crates/schema/sqlite_identifiers/src/test_helpers.rs @@ -0,0 +1,18 @@ +//! Only imported in tests + +use serde::Serialize; + +pub fn to_json(t: &T) -> String { + serde_json::to_string(t) + .expect("serialization error") + .replace("\"", "") // JSON values are quoted, so we remove quotes +} + +/// Assert that the Serialize is represented by the expected string value. +/// This is useful for ensuring stability of serialization. +pub fn assert_serialization(t: T, expected: &str) { + // TODO: See if there's a way to check the sqlx serialization + // TODO(bt,2024-06-27): Something broke with serde toml serialization, so we're disabling it + // assert_eq!(&to_toml(&t), expected); + assert_eq!(&to_json(&t), expected); +} diff --git a/crates/schema/sqlite_identifiers/tests/media_file_token_tests.rs b/crates/schema/sqlite_identifiers/tests/media_file_token_tests.rs new file mode 100644 index 00000000..9971dee9 --- /dev/null +++ b/crates/schema/sqlite_identifiers/tests/media_file_token_tests.rs @@ -0,0 +1,194 @@ +/// Test MediaFileToken in isolation, just in case our macro-derived tests break. + +use serde::Deserialize; +use serde::Serialize; + +use sqlite_identifiers::ids::media_file_token::MediaFileToken; + +#[derive(Serialize, Deserialize, PartialEq, Debug)] +struct CompositeType { + media_file_token: MediaFileToken, + string: String, +} + +mod interface { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + #[test] + fn generate() { + let token = MediaFileToken::generate(); + assert!(!token.to_string().is_empty()); + assert!(token.to_string().starts_with("m_")); + } + + #[test] + fn generated_tokens_have_stable_format() { + for _ in 0..25 { + let token = MediaFileToken::generate(); + let value = token.as_str(); + assert_eq!(value.len(), 32, "token {value} should be 32 chars"); + assert!(value.starts_with("m_")); + assert!(value[2..].bytes().all(|b| b"0123456789abcdefghjkmnpqrstvwxyz".contains(&b)), + "token {value} should be lowercase crockford"); + } + } + + #[test] + fn new() { + let token = MediaFileToken::new("m_foo".to_string()); + assert_eq!(token, MediaFileToken("m_foo".to_string())); + } + + #[test] + fn new_from_str() { + let token = MediaFileToken::new_from_str("m_foo"); + assert_eq!(token, MediaFileToken("m_foo".to_string())); + } + + #[test] + fn as_str() { + let token = MediaFileToken("m_foo".to_string()); + assert_eq!(token.as_str(), "m_foo"); + } + + #[test] + fn to_string() { + let token = MediaFileToken("m_foo".to_string()); + assert_eq!(token.to_string(), "m_foo".to_string()); + } +} + +mod traits { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + #[test] + fn display() { + let token = MediaFileToken("m_foo".to_string()); + assert_eq!(format!("{}", token), "m_foo".to_string()); + } + + #[test] + fn debug() { + let token = MediaFileToken("m_foo".to_string()); + assert_eq!(format!("{:?}", token), "MediaFileToken(\"m_foo\")".to_string()); + } +} + +mod serialization { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::CompositeType; + +// NB(bt,2024-09-25): These tests are broken with a recent upgrade +// #[test] +// fn serialize() { +// let expected = "\"m_foo\"".to_string(); // NB: Quoted +// +// let token = MediaFileToken("m_foo".to_string()); +// assert_eq!(expected, toml::to_string(&token).unwrap()); +// +// // Just to show this serializes the same as a string +// assert_eq!(expected, toml::to_string("m_foo").unwrap()); +// } + + #[test] + fn nested_serialize() { + let value = CompositeType { media_file_token: MediaFileToken("m_foo".to_string()), string: "bar".to_string() }; + let expected = r#"{"media_file_token":"m_foo","string":"bar"}"#.to_string(); + assert_eq!(expected, serde_json::to_string(&value).unwrap()); + } +} + +mod deserialization { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + use crate::CompositeType; + + #[test] + fn deserialize() { + let payload = "\"m_foo\""; // NB: Quoted + let expected = "m_foo".to_string(); + + let value: MediaFileToken = serde_json::from_str(payload).unwrap(); + assert_eq!(value, MediaFileToken(expected.clone())); + + // Just to show this deserializes the same way as a string + let value: String = serde_json::from_str(payload).unwrap(); + assert_eq!(value, expected.clone()); + } + + #[test] + fn nested_deserialize() { + let payload = r#"{"media_file_token":"m_foo","string":"bar"}"#.to_string(); + let expected = CompositeType { + media_file_token: MediaFileToken("m_foo".to_string()), + string: "bar".to_string(), + }; + + assert_eq!(expected, serde_json::from_str::(&payload).unwrap()); + } +} + +// These traits should be tested by the macro, but we duplicate them in case that breaks +mod crockford_traits { + use sqlite_identifiers::ids::media_file_token::MediaFileToken; + + const ENTROPIC_CHARACTERS_MINIMUM : usize = 8; + + #[test] + fn entropy_is_sufficient() { + assert!((32 - MediaFileToken::PREFIX.len()) > ENTROPIC_CHARACTERS_MINIMUM); + } + + #[test] + fn token_length() { + assert_eq!(MediaFileToken::generate().as_str().len(), 32); + } + + #[test] + fn tokens_are_random() { + let mut tokens = std::collections::HashSet::new(); + for _ in 0..100 { + tokens.insert(MediaFileToken::generate().to_string()); + } + assert_eq!(tokens.len(), 100); + } + + #[test] + fn character_set() { + let token_string = MediaFileToken::generate().to_string(); + let prefix = MediaFileToken::PREFIX; + let random_part = token_string.replace(prefix, ""); + + assert!(random_part.len() > ENTROPIC_CHARACTERS_MINIMUM); + assert!(random_part.chars().all(|c| c.is_numeric() || c.is_lowercase())); + } + + #[test] + fn prefix_ends_with_separator() { + let prefix = MediaFileToken::PREFIX; + assert!(prefix.ends_with("_")); + + let token_string = MediaFileToken::generate().to_string(); + assert!(token_string.contains(":") || token_string.contains("_")); + } + + #[test] + fn token_begins_with_prefix() { + let prefix = MediaFileToken::PREFIX; + let token_string = MediaFileToken::generate().to_string(); + assert!(token_string.starts_with(prefix)); + } + + #[test] + fn entropy_suffix() { + let token = MediaFileToken::new_from_str("m_foo"); + assert_eq!(token.entropy_suffix(), "foo"); + + let token = MediaFileToken::new_from_str("bar"); + assert_eq!(token.entropy_suffix(), "bar"); + + let token = MediaFileToken::generate(); + assert_eq!(token.entropy_suffix().len(), 30); + } +} diff --git a/crates/testing/test_data/Cargo.toml b/crates/testing/test_data/Cargo.toml new file mode 100644 index 00000000..23d9c471 --- /dev/null +++ b/crates/testing/test_data/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "test_data" +edition = "2021" +version = "0.0.1" +publish = false + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[lib] +# NB: Did not look for public-facing crate with same name. +name = "test_data" +path = "src/lib.rs" + +[dependencies] +# cargo-hakari workspace hack (faster compile times) +workspace-build-acceleration.workspace = true + +# Internal +errors.workspace = true + +# External +anyhow.workspace = true + +[dev-dependencies] +# None yet diff --git a/crates/testing/test_data/src/lib.rs b/crates/testing/test_data/src/lib.rs new file mode 100644 index 00000000..a64a6b61 --- /dev/null +++ b/crates/testing/test_data/src/lib.rs @@ -0,0 +1,18 @@ +//! A library with test data for our test cases. + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod web; diff --git a/crates/testing/test_data/src/web/character_tokens.rs b/crates/testing/test_data/src/web/character_tokens.rs new file mode 100644 index 00000000..b000479d --- /dev/null +++ b/crates/testing/test_data/src/web/character_tokens.rs @@ -0,0 +1,25 @@ +//! Production character test data from the test account. + +pub struct TestCharacter { + pub token: &'static str, + pub name: &'static str, + pub avatar_cdn_url: &'static str, +} + +pub const JIM: TestCharacter = TestCharacter { + token: "character_9f3sa1qatp1nr3876srm0b", + name: "Jim", + avatar_cdn_url: "https://cdn-2.fakeyou.com/media/b/b/w/7/3/bbw7329f04h0zcsyvh5tb908htfvq9fy/artcraft_bbw7329f04h0zcsyvh5tb908htfvq9fy.jpg", +}; + +pub const FANTASY_RAPTOR: TestCharacter = TestCharacter { + token: "character_6rhsk8a7twjdnykhw4kr4n", + name: "Fantasy Raptor", + avatar_cdn_url: "https://cdn-2.fakeyou.com/media/p/1/q/v/m/p1qvmnh5z637cdpc5m3wr6qmjr77q48f/artcraft_p1qvmnh5z637cdpc5m3wr6qmjr77q48f.png", +}; + +pub const KNIGHT: TestCharacter = TestCharacter { + token: "character_6xvgbmm9q79c5ygsj0y4fb", + name: "Knight", + avatar_cdn_url: "https://cdn-2.fakeyou.com/media/w/k/j/5/q/wkj5qwnpg9dm5969jbz4vs49xncypq2y/artcraft_wkj5qwnpg9dm5969jbz4vs49xncypq2y.png", +}; diff --git a/crates/testing/test_data/src/web/image_media_tokens.rs b/crates/testing/test_data/src/web/image_media_tokens.rs new file mode 100644 index 00000000..53341172 --- /dev/null +++ b/crates/testing/test_data/src/web/image_media_tokens.rs @@ -0,0 +1,6 @@ +//! Production media file tokens corresponding to the image URLs in `image_urls.rs`. + +pub const JUNO_AT_LAKE_PRODUCTION_MEDIA_TOKEN: &str = "m_m1bz02z1kkzanxy6rb4vk1kvq9de9g"; +pub const FOREST_BACKDROP_PRODUCTION_MEDIA_TOKEN: &str = "m_f5yy0fdmkwrf2hxaq4yw4sd95tvvrf"; +pub const WHITE_HOUSE_SUNSET_PRODUCTION_MEDIA_TOKEN: &str = "m_xmzdeqhjpxs5418kvepcrj5a3vkfb1"; +pub const TALL_MOCHI_WITH_GLASSES_PRODUCTION_MEDIA_TOKEN: &str = "m_5y81rcnpnrbey55da6cc2s9z4d2f45"; \ No newline at end of file diff --git a/crates/testing/test_data/src/web/image_urls.rs b/crates/testing/test_data/src/web/image_urls.rs new file mode 100644 index 00000000..074f3d8f --- /dev/null +++ b/crates/testing/test_data/src/web/image_urls.rs @@ -0,0 +1,46 @@ +//! Links to images that should remain available for tests to download. + +// media token: m_g978j1h93fatjastnv43bcwnem667p +pub const ERNEST_GHOST_TREX_IMAGE_URL :&str = "https://cdn-2.fakeyou.com/media/h/p/v/2/n/hpv2ncy2d3wcy02mr2kh9e807z8whrm8/image_hpv2ncy2d3wcy02mr2kh9e807z8whrm8.png"; + +// media token: m_1997908e4tcbaj34wa0s5bvr4y4szt +pub const ERNEST_SCARED_STUPID_IMAGE_URL :&str = "https://cdn-2.fakeyou.com/media/t/8/r/q/3/t8rq3b8tvabpyrmp9c0tw9t612bjq4rm/asset_t8rq3b8tvabpyrmp9c0tw9t612bjq4rm.jpg"; + +// media token: m_f5yy0fdmkwrf2hxaq4yw4sd95tvvrf +pub const FOREST_BACKDROP_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/0/p/0/s/9/0p0s9brjd8k3xr6qgahmkkhs5d4kga30/asset_0p0s9brjd8k3xr6qgahmkkhs5d4kga30.jpg"; + +// media token: m_deprc7e171byqqe0z8n9f7tjqxvdvj +pub const GHOST_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/g/r/m/e/t/grmetywfpztmxcn2f796ambvm3hdhrt3/asset_grmetywfpztmxcn2f796ambvm3hdhrt3.jpg"; + +// media token: m_6mhxhv9wat9p63nc6w502zxrz31t3a +pub const GRASSY_HILL_TRANSPARENT_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/y/4/n/w/7/y4nw7rebh54j4cnw7nmcy81v2nsjkpxg/asset_y4nw7rebh54j4cnw7nmcy81v2nsjkpxg.png"; + +// media token: m_43vfk9rc35yt2rxb1tgcsx11wedc01 +pub const MOUNTAIN_TREE_IMAGE_URL :&str = "https://cdn-2.fakeyou.com/media/3/4/h/f/s/34hfsmt8e38rvne6mwa4pwbxr6292sgy/image_34hfsmt8e38rvne6mwa4pwbxr6292sgy.png"; + +// media token: m_xmzdeqhjpxs5418kvepcrj5a3vkfb1 +pub const WHITE_HOUSE_SUNSET_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/q/t/z/w/k/qtzwka8dd0g2nfyk94k1qh3zzfwqtfhn/asset_qtzwka8dd0g2nfyk94k1qh3zzfwqtfhn.jpg"; + +// media token: m_z61yg5w7dnnvhb1f9sqt8jf02y61bv +pub const SUPER_WIDE_FALL_MOUNTAINS_IMAGE_URL: &str = "https://cdn-2.fakeyou.com/media/w/6/m/j/p/w6mjpcqkky7f2f3xkyvkcv3qeedkmejs/asset_w6mjpcqkky7f2f3xkyvkcv3qeedkmejs.jpg"; + +// media token: m_m1bz02z1kkzanxy6rb4vk1kvq9de9g +pub const JUNO_AT_LAKE_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/s/v/c/p/p/svcpp441gyb6mjtt8413kf5zxw1ehy4t/upload_svcpp441gyb6mjtt8413kf5zxw1ehy4t.jpg"; + +// media token: m_5y81rcnpnrbey55da6cc2s9z4d2f45 +pub const TALL_MOCHI_WITH_GLASSES_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/n/m/f/h/a/nmfhaz9h5wsgzfyz7nh402wxrfwa7c2y/upload_nmfhaz9h5wsgzfyz7nh402wxrfwa7c2y.jpg"; + +// media token: m_7x18h6qnyay4a42kyyyw2xctasx5k9 +pub const TALL_MOCHI_WITH_GLASSES_GLASSES_MASK_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/r/e/j/b/p/rejbp61m56hqx4a498xh7j47vkjd7jnh/upload_rejbp61m56hqx4a498xh7j47vkjd7jnh.png"; + +// media token: m_77cpdyaby60z0qv9g6tv67gw2a1337 +pub const TREX_SKELETON_IMAGE_URL : &str = "https://cdn-2.fakeyou.com/media/f/4/j/5/3/f4j53296sc35wqs3csgw4j4vvjf5yyxe/image_f4j53296sc35wqs3csgw4j4vvjf5yyxe.png"; + +// media token: m_zyh17gn6prfp4xs6z76mqkz9k0sr0j +pub const TALL_CORGI_SHIBA_TREASURE_OCEAN_URL: &str = "https://cdn-2.fakeyou.com/media/j/z/7/2/p/jz72pgwb6fegem74pr36yy88hsshwx4m/artcraft_jz72pgwb6fegem74pr36yy88hsshwx4m.png"; + +// media token: m_a9c4g43nw87y6mebjammrqz849c5xe +pub const WIDE_CORGI_SHIBA_TREASURE_OCEAN_URL: &str = "https://cdn-2.fakeyou.com/media/v/a/g/g/a/vaggan4137tqsz173432cjjg33xkrxpc/artcraft_vaggan4137tqsz173432cjjg33xkrxpc.png"; + +// media token: m_ytkp3tk2ptvr03p75fwqvend0m3qsg +pub const TALL_CORGI_SHIBA_TREASURE_SKY_URL: &str = "https://cdn-2.fakeyou.com/media/a/4/s/x/x/a4sxxecwenrbta5kx5jk34dp2z9apxqv/artcraft_a4sxxecwenrbta5kx5jk34dp2z9apxqv.png"; diff --git a/crates/testing/test_data/src/web/mod.rs b/crates/testing/test_data/src/web/mod.rs new file mode 100644 index 00000000..6321d567 --- /dev/null +++ b/crates/testing/test_data/src/web/mod.rs @@ -0,0 +1,4 @@ +pub mod character_tokens; +pub mod image_media_tokens; +pub mod image_urls; +pub mod video_urls; \ No newline at end of file diff --git a/crates/testing/test_data/src/web/video_urls.rs b/crates/testing/test_data/src/web/video_urls.rs new file mode 100644 index 00000000..93583b2b --- /dev/null +++ b/crates/testing/test_data/src/web/video_urls.rs @@ -0,0 +1,5 @@ + + +// media token: m_fz9r14yhfe05ffg9wqda5291p7mp75 +pub const ANGRY_SHIBA_VIDEO_URL : &str = "https://cdn-2.fakeyou.com/media/q/0/1/e/9/q01e9xsye0scamh5mrskr2emsv401x14/artcraft_q01e9xsye0scamh5mrskr2emsv401x14.mp4"; + diff --git a/crates/testing/test_utils/Cargo.toml b/crates/testing/test_utils/Cargo.toml new file mode 100644 index 00000000..166c6b52 --- /dev/null +++ b/crates/testing/test_utils/Cargo.toml @@ -0,0 +1,32 @@ +[package] +name = "test_utils" +edition = "2018" +version = "0.0.1" +authors = [ + "Brandon Thomas ", + "Brandon Thomas ", +] +publish = false + +[lib] +# NB: Public "testing" crate is used by the "swc" project as an internal project. +# It isn't a crate meant to be consumed by others, so we'll use it internally. +name = "test_utils" +path = "src/lib.rs" + +[package.metadata.cargo-udeps.ignore] +normal = ["workspace-build-acceleration"] + +[dependencies] + +# Internal +errors = { path = "../../lib/errors" } + +# Workspace hack (faster compile times) +workspace-build-acceleration = { version = "0.1", path = "../../workspace-build-acceleration" } + +# External +# None yet + +[dev-dependencies] +# None yet diff --git a/crates/testing/test_utils/src/lib.rs b/crates/testing/test_utils/src/lib.rs new file mode 100644 index 00000000..51da30fc --- /dev/null +++ b/crates/testing/test_utils/src/lib.rs @@ -0,0 +1,27 @@ +//! testing +//! +//! This crate collects some of our common code around test setup and execution. +//! In the future we may have several such crates that deal with specific functions (http serving, +//! mocks, database, etc.). This crate is meant for general testing concerns. It will also import +//! and re-export the most common testing libraries we use. +//! +//! (The public "testing" crate is used for another project's internal tooling and isn't meant for +//! public consumption.) +//! + +// Never allow these +#![forbid(private_bounds)] +#![forbid(private_interfaces)] +#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things + +// Okay to toggle +#![forbid(unreachable_patterns)] +#![forbid(unused_imports)] +#![forbid(unused_mut)] +#![forbid(unused_variables)] + +// Always allow +#![allow(dead_code)] +#![allow(non_snake_case)] + +pub mod test_file_path; \ No newline at end of file diff --git a/crates/testing/test_utils/src/test_file_path.rs b/crates/testing/test_utils/src/test_file_path.rs new file mode 100644 index 00000000..1804a16f --- /dev/null +++ b/crates/testing/test_utils/src/test_file_path.rs @@ -0,0 +1,41 @@ +use std::path::{Path, PathBuf}; + +use errors::{anyhow, AnyhowResult}; + +/// Refer to test files using the path from repo root and return a canonical path. +/// +/// NB: The path must exist or the canonicalization will return an error! +/// +/// (If each library had to deal with this problem separately, they would have to concern +/// themselves with the number of directories between the Cargo.toml project declaration +/// and the test directory, ie. this differs based on code nestedness.) +pub fn test_file_path>(path_from_repo_root: P) -> AnyhowResult { + // https://doc.rust-lang.org/cargo/reference/environment-variables.html + let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let file = path_from_repo_root + .as_ref() + .to_str() + .ok_or(anyhow!("path cannot convert to string"))?; + path.push(format!("../../../{}", file)); + println!(" >>> path = {:?}", path); + Ok(path.canonicalize()?) + +} + +#[cfg(test)] +mod tests { + use super::test_file_path; + + #[test] + fn assert_canonicalized() { + // NB: We can't assert the exact paths since each machine (dev, CI) differs, + // but we can make assertions + let str_path = "test_data/audio/flac/zelda_ocarina_small_item.flac"; + let path = test_file_path(str_path).unwrap(); + + assert!(path.is_absolute()); + assert!(path.exists()); + assert!(path.ends_with(str_path)); + assert_eq!(path.canonicalize().unwrap(), path); + } +} diff --git a/crates/vendor/tauri-plugin-http/CHANGELOG.md b/crates/vendor/tauri-plugin-http/CHANGELOG.md new file mode 100644 index 00000000..4e1fb76b --- /dev/null +++ b/crates/vendor/tauri-plugin-http/CHANGELOG.md @@ -0,0 +1,249 @@ +# Changelog + +## \[2.4.3] + +- [`37c0477a`](https://github.com/tauri-apps/plugins-workspace/commit/37c0477afe926d326573f1827045875ce8bf8187) ([#2561](https://github.com/tauri-apps/plugins-workspace/pull/2561)) Add `zstd` cargo feature flag to enable `reqwest/zstd` flag. +- [`9ebbfb2e`](https://github.com/tauri-apps/plugins-workspace/commit/9ebbfb2e3ccef8e0f277a0c02fe6b399b41feeb6) ([#1978](https://github.com/tauri-apps/plugins-workspace/pull/1978)) Persist cookies to disk and load it on next app start. + +### Dependencies + +- Upgraded to `fs-js@2.2.1` + +## \[2.4.2] + +- [`a15eedf3`](https://github.com/tauri-apps/plugins-workspace/commit/a15eedf37854344f7ffbcb0d373d848563817011) ([#2535](https://github.com/tauri-apps/plugins-workspace/pull/2535) by [@amrbashir](https://github.com/tauri-apps/plugins-workspace/../../amrbashir)) Fix `fetch` occasionally throwing an error due to trying to close the underline stream twice. + +## \[2.4.1] + +- [`d3183aa9`](https://github.com/tauri-apps/plugins-workspace/commit/d3183aa99da7ca67e627394132ddeb3b85ccef06) ([#2522](https://github.com/tauri-apps/plugins-workspace/pull/2522) by [@adrieljss](https://github.com/tauri-apps/plugins-workspace/../../adrieljss)) Fix `fetch` blocking until the whole response is read even if it was a streaming response. + +## \[2.4.0] + +- [`cb38f54f`](https://github.com/tauri-apps/plugins-workspace/commit/cb38f54f4a4ef30995283cd82166c62da17bac44) ([#2479](https://github.com/tauri-apps/plugins-workspace/pull/2479) by [@adrieljss](https://github.com/tauri-apps/plugins-workspace/../../adrieljss)) Add stream support for HTTP stream responses. + +## \[2.3.0] + +- [`10513649`](https://github.com/tauri-apps/plugins-workspace/commit/105136494c5a5bf4b1f1cc06cc71815412d17ec8) ([#2204](https://github.com/tauri-apps/plugins-workspace/pull/2204) by [@RickeyWard](https://github.com/tauri-apps/plugins-workspace/../../RickeyWard)) Add `dangerous-settings` feature flag and new JS `danger` option to disable tls hostname/certificate validation. + +## \[2.2.0] + +- [`3a79266b`](https://github.com/tauri-apps/plugins-workspace/commit/3a79266b8cf96a55b1ae6339d725567d45a44b1d) ([#2173](https://github.com/tauri-apps/plugins-workspace/pull/2173) by [@FabianLars](https://github.com/tauri-apps/plugins-workspace/../../FabianLars)) Bumped all plugins to `v2.2.0`. From now, the versions for the Rust and JavaScript packages of each plugin will be in sync with each other. + +### Dependencies + +- Upgraded to `fs@2.2.0` + +## \[2.0.2] + +### Dependencies + +- Upgraded to `fs-js@2.0.4` + +## \[2.0.4] + +- [`a3b553dd`](https://github.com/tauri-apps/plugins-workspace/commit/a3b553ddb403771aa699362c4e69a064b7731da5) ([#2079](https://github.com/tauri-apps/plugins-workspace/pull/2079) by [@amrbashir](https://github.com/tauri-apps/plugins-workspace/../../amrbashir)) Add tracing logs for requestes and responses behind `tracing` feature flag. + +### Dependencies + +- Upgraded to `fs@2.1.0` + +## \[2.0.3] + +### Dependencies + +- Upgraded to `fs@2.0.3` + +## \[2.0.1] + +- [`cfd48b3b`](https://github.com/tauri-apps/plugins-workspace/commit/cfd48b3b2ec0fccfc162197518694ed59ceda22c) ([#1941](https://github.com/tauri-apps/plugins-workspace/pull/1941) by [@Nipsuli](https://github.com/tauri-apps/plugins-workspace/../../Nipsuli)) Allow skipping sending `Origin` header in HTTP requests by setting `Origin` header to an empty string when calling `fetch`. +- [`9b2840db`](https://github.com/tauri-apps/plugins-workspace/commit/9b2840db9464cf08db75806270e4441f0af81e5d) ([#1884](https://github.com/tauri-apps/plugins-workspace/pull/1884) by [@amrbashir](https://github.com/tauri-apps/plugins-workspace/../../amrbashir)) Retain headers order. + +## \[2.0.1] + +- [`a1a82208`](https://github.com/tauri-apps/plugins-workspace/commit/a1a82208ed4ab87f83310be0dc95428aec9ab241) ([#1873](https://github.com/tauri-apps/plugins-workspace/pull/1873) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Downgrade MSRV to 1.77.2 to support Windows 7. + +### Dependencies + +- Upgraded to `fs@2.0.1` + +## \[2.0.0] + +- [`e2c4dfb6`](https://github.com/tauri-apps/plugins-workspace/commit/e2c4dfb6af43e5dd8d9ceba232c315f5febd55c1) Update to tauri v2 stable release. + +### Dependencies + +- Upgraded to `fs@2.0.0` + +## \[2.0.0-rc.6] + +### Dependencies + +- Upgraded to `fs@2.0.0-rc.6` + +## \[2.0.0-rc.5] + +### Dependencies + +- Upgraded to `fs@2.0.0-rc.5` + +## \[2.0.0-rc.4] + +### Dependencies + +- Upgraded to `fs@2.0.0-rc.4` + +## \[2.0.0-rc.3] + +### Dependencies + +- Upgraded to `fs@2.0.0-rc.3` + +## \[2.0.0-rc.2] + +### Dependencies + +- Upgraded to `fs@2.0.0-rc.2` + +## \[2.0.0-rc.2] + +- [`e2e97db5`](https://github.com/tauri-apps/plugins-workspace/commit/e2e97db51983267f5be84d4f6f0278d58834d1f5) ([#1701](https://github.com/tauri-apps/plugins-workspace/pull/1701) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Update to tauri 2.0.0-rc.8 + +## \[2.0.0-rc.1] + +- [`84f8bd5e`](https://github.com/tauri-apps/plugins-workspace/commit/84f8bd5e1ef22e664267380b5bbf756ebc5389c3) ([#1662](https://github.com/tauri-apps/plugins-workspace/pull/1662) by [@twlite](https://github.com/tauri-apps/plugins-workspace/../../twlite)) Fixed an issue with abort signal not aborting the fetch request. + +## \[2.0.0-rc.0] + +- [`9887d1`](https://github.com/tauri-apps/plugins-workspace/commit/9887d14bd0e971c4c0f5c1188fc4005d3fc2e29e) Update to tauri RC. + +### Dependencies + +- Upgraded to `fs@2.0.0-rc.0` + +## \[2.0.0-beta.9] + +- [`99d6ac0f`](https://github.com/tauri-apps/plugins-workspace/commit/99d6ac0f9506a6a4a1aa59c728157190a7441af6) ([#1606](https://github.com/tauri-apps/plugins-workspace/pull/1606) by [@FabianLars](https://github.com/tauri-apps/plugins-workspace/../../FabianLars)) The JS packages now specify the *minimum* `@tauri-apps/api` version instead of a single exact version. +- [`6de87966`](https://github.com/tauri-apps/plugins-workspace/commit/6de87966ecc00ad9d91c25be452f1f46bd2b7e1f) ([#1597](https://github.com/tauri-apps/plugins-workspace/pull/1597) by [@Legend-Master](https://github.com/tauri-apps/plugins-workspace/../../Legend-Master)) Update to tauri beta.25. + +## \[2.0.0-beta.8] + +- [`ac9a25cc`](https://github.com/tauri-apps/plugins-workspace/commit/ac9a25cc12ee2b325f00212ba74316da3369bde5) ([#1395](https://github.com/tauri-apps/plugins-workspace/pull/1395) by [@amrbashir](https://github.com/tauri-apps/plugins-workspace/../../amrbashir)) Fix cancelling requests using `AbortSignal`. +- [`a6654932`](https://github.com/tauri-apps/plugins-workspace/commit/a66549329c60dea35e3a06a38c357e368c9053a1) ([#1526](https://github.com/tauri-apps/plugins-workspace/pull/1526) by [@amrbashir](https://github.com/tauri-apps/plugins-workspace/../../amrbashir)) Fix missing `Set-Cookie` headers in the response which meant `request.headers.getSetCookie()` always returned empty array. +- [`22a17980`](https://github.com/tauri-apps/plugins-workspace/commit/22a17980ff4f6f8c40adb1b8f4ffc6dae2fe7e30) ([#1537](https://github.com/tauri-apps/plugins-workspace/pull/1537) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Update to tauri beta.24. + +## \[2.0.0-beta.7] + +- [`76daee7a`](https://github.com/tauri-apps/plugins-workspace/commit/76daee7aafece34de3092c86e531cf9eb1138989) ([#1512](https://github.com/tauri-apps/plugins-workspace/pull/1512) by [@renovate](https://github.com/tauri-apps/plugins-workspace/../../renovate)) Update to tauri beta.23. + +## \[2.0.0-beta.6] + +- [`0f739dbc`](https://github.com/tauri-apps/plugins-workspace/commit/0f739dbc483a1f091977cbe575c3862fd39f8cf1) ([#1392](https://github.com/tauri-apps/plugins-workspace/pull/1392) by [@amrbashir](https://github.com/tauri-apps/plugins-workspace/../../amrbashir)) Allow setting `Origin` header when `unsafe-headers` feature flag is active. + +## \[2.0.0-beta.5] + +- [`9013854f`](https://github.com/tauri-apps/plugins-workspace/commit/9013854f42a49a230b9dbb9d02774765528a923f)([#1382](https://github.com/tauri-apps/plugins-workspace/pull/1382)) Update to tauri beta.22. + +## \[2.0.0-beta.4] + +- [`9d7ae45b`](https://github.com/tauri-apps/plugins-workspace/commit/9d7ae45b0edf9b22c73e7d7c413a784bb35c3d77)([#1354](https://github.com/tauri-apps/plugins-workspace/pull/1354)) Include headers created by browser if not declared by user, which fixes missing headers like `Content-Type` when using `FormData`. +- [`430bd6f4`](https://github.com/tauri-apps/plugins-workspace/commit/430bd6f4f379bee5d232ae6b098ae131db7f178a)([#1363](https://github.com/tauri-apps/plugins-workspace/pull/1363)) Update to tauri beta.20. + +## \[2.0.0-beta.3] + +- [`bd1ed590`](https://github.com/tauri-apps/plugins-workspace/commit/bd1ed5903ffcce5500310dac1e59e8c67674ef1e)([#1237](https://github.com/tauri-apps/plugins-workspace/pull/1237)) Update to tauri beta.17. + +## \[2.0.0-beta.6] + +### Dependencies + +- Upgraded to `fs@2.0.0-beta.6` + +## \[2.0.0-beta.5] + +- [`500ff10`](https://github.com/tauri-apps/plugins-workspace/commit/500ff10fbd89fdfc73caf9d153029dad567b4ff1)([#1166](https://github.com/tauri-apps/plugins-workspace/pull/1166)) **Breaking change:** Removed the `default-tls` feature flag. The `rustls-tls`, `http2`, `macos-system-configuration`, and `charset` feature flags are now enabled by default. +- [`e3d41f4`](https://github.com/tauri-apps/plugins-workspace/commit/e3d41f4011bd3ea3ce281bb38bbe31d3709f8e0f)([#1191](https://github.com/tauri-apps/plugins-workspace/pull/1191)) Internally use the webview scoped resources table instead of the app one, so other webviews can't access other webviews resources. +- [`7e2fcc5`](https://github.com/tauri-apps/plugins-workspace/commit/7e2fcc5e74df7c3c718e40f75bfb0eafc7d69d8d)([#1146](https://github.com/tauri-apps/plugins-workspace/pull/1146)) Update dependencies to align with tauri 2.0.0-beta.14. +- [`e3d41f4`](https://github.com/tauri-apps/plugins-workspace/commit/e3d41f4011bd3ea3ce281bb38bbe31d3709f8e0f)([#1191](https://github.com/tauri-apps/plugins-workspace/pull/1191)) Update for tauri 2.0.0-beta.15. + +### Dependencies + +- Upgraded to `fs@2.0.0-beta.5` + +## \[2.0.0-beta.4] + +### Dependencies + +- Upgraded to `fs@2.0.0-beta.4` + +## \[2.0.0-beta.3] + +- [`c873e4d`](https://github.com/tauri-apps/plugins-workspace/commit/c873e4d6c74e759742f7c9a88e35cff10a75122a)([#1059](https://github.com/tauri-apps/plugins-workspace/pull/1059)) Fixes scope not allowing subpaths, query parameters and hash when those values are empty. +- [`a04ea2f`](https://github.com/tauri-apps/plugins-workspace/commit/a04ea2f38294d5a3987578283badc8eec87a7752)([#1071](https://github.com/tauri-apps/plugins-workspace/pull/1071)) The global API script is now only added to the binary when the `withGlobalTauri` config is true. +- [`753c7be`](https://github.com/tauri-apps/plugins-workspace/commit/753c7be0a6a78121d2e88ea0efc3040580c885b4)([#1050](https://github.com/tauri-apps/plugins-workspace/pull/1050)) Add `unsafe-headers` cargo feature flag to allow using [forbidden headers](https://fetch.spec.whatwg.org/#terminology-headers). + +### Dependencies + +- Upgraded to `fs@2.0.0-beta.3` + +## \[2.0.0-beta.2] + +- [`ae56b13`](https://github.com/tauri-apps/plugins-workspace/commit/ae56b13a4d49dbf922b8a0fbb0d557bb63c1d72b)([#983](https://github.com/tauri-apps/plugins-workspace/pull/983)) Allow `User-Agent` header to be set. +- [`99bea25`](https://github.com/tauri-apps/plugins-workspace/commit/99bea2559c2c0648c2519c50a18cd124dacef57b)([#1005](https://github.com/tauri-apps/plugins-workspace/pull/1005)) Update to tauri beta.8. + +## \[2.0.0-beta.1] + +- [`569defb`](https://github.com/tauri-apps/plugins-workspace/commit/569defbe9492e38938554bb7bdc1be9151456d21) Update to tauri beta.4. + +## \[2.0.0-beta.0] + +- [`d198c01`](https://github.com/tauri-apps/plugins-workspace/commit/d198c014863ee260cb0de88a14b7fc4356ef7474)([#862](https://github.com/tauri-apps/plugins-workspace/pull/862)) Update to tauri beta. +- [`1a34720`](https://github.com/tauri-apps/plugins-workspace/commit/1a347203a54eccc954749d11c4ee81fdd9a0cde7)([#858](https://github.com/tauri-apps/plugins-workspace/pull/858)) Fix http fetch client option init with parameter `connectTimeout` + +## \[2.0.0-alpha.9] + +### Dependencies + +- Upgraded to `fs@2.0.0-alpha.7` + +## \[2.0.0-alpha.6] + +- [`bfa87da`](https://github.com/tauri-apps/plugins-workspace/commit/bfa87da848f9f1da2abae3354eed632881eddf11)([#824](https://github.com/tauri-apps/plugins-workspace/pull/824)) Add `proxy` field to `fetch` options to configure proxy. + +## \[2.0.0-alpha.5] + +- [`387c2f9`](https://github.com/tauri-apps/plugins-workspace/commit/387c2f9e0ce4c75c07ffa3fd76391a25b58f5daf)([#802](https://github.com/tauri-apps/plugins-workspace/pull/802)) Update to @tauri-apps/api v2.0.0-alpha.13. + +## \[2.0.0-alpha.4] + +- [`387c2f9`](https://github.com/tauri-apps/plugins-workspace/commit/387c2f9e0ce4c75c07ffa3fd76391a25b58f5daf)([#802](https://github.com/tauri-apps/plugins-workspace/pull/802)) Update to @tauri-apps/api v2.0.0-alpha.12. + +## \[2.0.0-alpha.3] + +- [`e438e0a`](https://github.com/tauri-apps/plugins-workspace/commit/e438e0a62d4b430a5159f05f13ecd397dd891a0d)([#676](https://github.com/tauri-apps/plugins-workspace/pull/676)) Update to @tauri-apps/api v2.0.0-alpha.11. + +## \[2.0.0-alpha.2] + +- [`5c13736`](https://github.com/tauri-apps/plugins-workspace/commit/5c137365c60790e8d4037d449e8237aa3fffdab0)([#673](https://github.com/tauri-apps/plugins-workspace/pull/673)) Update to @tauri-apps/api v2.0.0-alpha.9. + +## \[2.0.0-alpha.3] + +- [`2cb0fa7`](https://github.com/tauri-apps/plugins-workspace/commit/2cb0fa719b8b1f5ac07dada93520dbbcf637d64c)([#587](https://github.com/tauri-apps/plugins-workspace/pull/587)) Remove `cmd` property which breaks invoke call. +- [`4e2cef9`](https://github.com/tauri-apps/plugins-workspace/commit/4e2cef9b702bbbb9cf4ee17de50791cb21f1b2a4)([#593](https://github.com/tauri-apps/plugins-workspace/pull/593)) Update to alpha.12. + +### Dependencies + +- Upgraded to `fs@2.0.0-alpha.2` + +## \[2.0.0-alpha.2] + +- [`aec17a9`](https://github.com/tauri-apps/plugins-workspace/commit/aec17a90fc365774c70c4876b94a899416120e26)([#558](https://github.com/tauri-apps/plugins-workspace/pull/558)) Improve response performance by using the new IPC streaming data. + +## \[2.0.0-alpha.1] + +- [`7d9df72`](https://github.com/tauri-apps/plugins-workspace/commit/7d9df7297a221a64d9de945ffc2cd8313d3104dc)([#428](https://github.com/tauri-apps/plugins-workspace/pull/428)) Multipart requests are now handled in JavaScript by the `Request` JavaScript class so you just need to use a `FormData` body and not set the content-type header to `multipart/form-data`. `application/x-www-form-urlencoded` requests must be done manually. +- [`7d9df72`](https://github.com/tauri-apps/plugins-workspace/commit/7d9df7297a221a64d9de945ffc2cd8313d3104dc)([#428](https://github.com/tauri-apps/plugins-workspace/pull/428)) The http plugin has been rewritten from scratch and now only exposes a `fetch` function in Javascript and Re-exports `reqwest` crate in Rust. The new `fetch` method tries to be as close and compliant to the `fetch` Web API as possible. +- [`d74fc0a`](https://github.com/tauri-apps/plugins-workspace/commit/d74fc0a097996e90a37be8f57d50b7d1f6ca616f)([#555](https://github.com/tauri-apps/plugins-workspace/pull/555)) Update to alpha.11. + +## \[2.0.0-alpha.0] + +- [`717ae67`](https://github.com/tauri-apps/plugins-workspace/commit/717ae670978feb4492fac1f295998b93f2b9347f)([#371](https://github.com/tauri-apps/plugins-workspace/pull/371)) First v2 alpha release! diff --git a/crates/vendor/tauri-plugin-http/Cargo.toml b/crates/vendor/tauri-plugin-http/Cargo.toml new file mode 100644 index 00000000..fd5fb7c5 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/Cargo.toml @@ -0,0 +1,88 @@ +# NB(bt): We've made some changes to the packages and directives. +# The original values are commented out. + +[package] +name = "tauri-plugin-http" +version = "2.4.3" +description = "Access an HTTP client written in Rust." +#edition = { workspace = true } +edition = "2021" +#authors = { workspace = true } +#license = { workspace = true } +#rust-version = { workspace = true } +rust-version = "1.77.2" +#repository = { workspace = true } +links = "tauri-plugin-http" + +[package.metadata.docs.rs] +rustc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs"] + +[package.metadata.platforms.support] +windows = { level = "full", notes = "" } +linux = { level = "full", notes = "" } +macos = { level = "full", notes = "" } +android = { level = "full", notes = "" } +ios = { level = "full", notes = "" } + +[build-dependencies] +#tauri-plugin = { workspace = true, features = ["build"] } +tauri-plugin = { version = "2.6.2", features = ["build"] } +#schemars = { workspace = true } +schemars = { version = "0.8" } +serde = { workspace = true } +url = { workspace = true } +urlpattern = "0.3" +regex = "1" + +[dependencies] +serde = { workspace = true } +serde_json = { workspace = true } +tauri = { workspace = true } +thiserror = { workspace = true } +tokio = { version = "1", features = ["sync", "macros"] } +#tauri-plugin-fs = { path = "../fs", version = "2.2.1" } +tauri-plugin-fs = { workspace = true } +urlpattern = "0.3" +regex = "1" +http = "1" +reqwest = { version = "0.12", default-features = false } +url = { workspace = true } +data-url = "0.3" +cookie_store = { version = "0.21.1", optional = true, features = ["serde"] } +bytes = { version = "1.9", optional = true } +#tracing = { workspace = true, optional = true } +tracing = { version = "0.1", optional = true } + +[features] +default = [ + "rustls-tls", + "http2", + "charset", + "macos-system-configuration", + "cookies", +] +multipart = ["reqwest/multipart"] +json = ["reqwest/json"] +stream = ["reqwest/stream"] +native-tls = ["reqwest/native-tls"] +native-tls-vendored = ["reqwest/native-tls-vendored"] +native-tls-alpn = ["reqwest/native-tls-alpn"] +rustls-tls = ["reqwest/rustls-tls"] +rustls-tls-manual-roots = ["reqwest/rustls-tls-manual-roots"] +rustls-tls-webpki-roots = ["reqwest/rustls-tls-webpki-roots"] +rustls-tls-native-roots = ["reqwest/rustls-tls-native-roots"] +blocking = ["reqwest/blocking"] +cookies = ["reqwest/cookies", "dep:cookie_store", "dep:bytes"] +gzip = ["reqwest/gzip"] +brotli = ["reqwest/brotli"] +deflate = ["reqwest/deflate"] +zstd = ["reqwest/zstd"] +trust-dns = ["reqwest/trust-dns"] +socks = ["reqwest/socks"] +http2 = ["reqwest/http2"] +charset = ["reqwest/charset"] +macos-system-configuration = ["reqwest/macos-system-configuration"] +unsafe-headers = [] +tracing = ["dep:tracing"] +dangerous-settings = [] diff --git a/crates/vendor/tauri-plugin-http/LICENSE.spdx b/crates/vendor/tauri-plugin-http/LICENSE.spdx new file mode 100644 index 00000000..cdd0df5a --- /dev/null +++ b/crates/vendor/tauri-plugin-http/LICENSE.spdx @@ -0,0 +1,20 @@ +SPDXVersion: SPDX-2.1 +DataLicense: CC0-1.0 +PackageName: tauri +DataFormat: SPDXRef-1 +PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy +PackageHomePage: https://tauri.app +PackageLicenseDeclared: Apache-2.0 +PackageLicenseDeclared: MIT +PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy +PackageSummary: Tauri is a rust project that enables developers to make secure +and small desktop applications using a web frontend. + +PackageComment: The package includes the following libraries; see +Relationship information. + +Created: 2019-05-20T09:00:00Z +PackageDownloadLocation: git://github.com/tauri-apps/tauri +PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git +PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git +Creator: Person: Daniel Thompson-Yvetot \ No newline at end of file diff --git a/crates/vendor/tauri-plugin-http/LICENSE_APACHE-2.0 b/crates/vendor/tauri-plugin-http/LICENSE_APACHE-2.0 new file mode 100644 index 00000000..4947287f --- /dev/null +++ b/crates/vendor/tauri-plugin-http/LICENSE_APACHE-2.0 @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/crates/vendor/tauri-plugin-http/LICENSE_MIT b/crates/vendor/tauri-plugin-http/LICENSE_MIT new file mode 100644 index 00000000..4d754725 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/LICENSE_MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 - Present Tauri Apps Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/crates/vendor/tauri-plugin-http/README.md b/crates/vendor/tauri-plugin-http/README.md new file mode 100644 index 00000000..5c3cd9c2 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/README.md @@ -0,0 +1,102 @@ +![plugin-http](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/http/banner.png) + +Access the HTTP client written in Rust. + +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + +## Install + +_This plugin requires a Rust version of at least **1.77.2**_ + +There are three general methods of installation that we can recommend. + +1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked) +2. Pull sources directly from Github using git tags / revision hashes (most secure) +3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use) + +Install the Core plugin by adding the following to your `Cargo.toml` file: + +`src-tauri/Cargo.toml` + +```toml +[dependencies] +tauri-plugin-http = "2.0.0" +# alternatively with Git: +tauri-plugin-http = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" } +``` + +You can install the JavaScript Guest bindings using your preferred JavaScript package manager: + +> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. + +```sh +pnpm add @tauri-apps/plugin-http +# or +npm add @tauri-apps/plugin-http +# or +yarn add @tauri-apps/plugin-http + +# alternatively with Git: +pnpm add https://github.com/tauri-apps/tauri-plugin-http#v2 +# or +npm add https://github.com/tauri-apps/tauri-plugin-http#v2 +# or +yarn add https://github.com/tauri-apps/tauri-plugin-http#v2 +``` + +## Usage + +First you need to register the core plugin with Tauri: + +`src-tauri/src/lib.rs` + +```rust +fn main() { + tauri::Builder::default() + .plugin(tauri_plugin_http::init()) + .run(tauri::generate_context!()) + .expect("error while running tauri application"); +} +``` + +Afterwards all the plugin's APIs are available through the JavaScript guest bindings: + +```javascript +import { fetch } from '@tauri-apps/plugin-http' +const response = await fetch('http://localhost:3003/users/2', { + method: 'GET', + timeout: 30 +}) +``` + +## Contributing + +PRs accepted. Please make sure to read the Contributing Guide before making a pull request. + +## Partners + + + + + + + +
+ + CrabNebula + +
+ +For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri). + +## License + +Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy. + +MIT or MIT/Apache 2.0 where applicable. diff --git a/crates/vendor/tauri-plugin-http/SECURITY.md b/crates/vendor/tauri-plugin-http/SECURITY.md new file mode 100644 index 00000000..4f09bbac --- /dev/null +++ b/crates/vendor/tauri-plugin-http/SECURITY.md @@ -0,0 +1,23 @@ +# Security Policy + +**Do not report security vulnerabilities through public GitHub issues.** + +**Please use the [Private Vulnerability Disclosure](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability) feature of GitHub.** + +Include as much of the following information: + +- Type of issue (e.g. improper input parsing, privilege escalation, etc.) +- The location of the affected source code (tag/branch/commit or direct URL) +- Any special configuration required to reproduce the issue +- The distribution affected or used to help us with reproduction of the issue +- Step-by-step instructions to reproduce the issue +- Ideally a reproduction repository +- Impact of the issue, including how an attacker might exploit the issue + +We prefer to receive reports in English. + +## Contact + +Please disclose a vulnerability or security relevant issue here: [https://github.com/tauri-apps/plugins-workspace/security/advisories/new](https://github.com/tauri-apps/plugins-workspace/security/advisories/new). + +Alternatively, you can also contact us by email via [security@tauri.app](mailto:security@tauri.app). diff --git a/crates/vendor/tauri-plugin-http/api-iife.js b/crates/vendor/tauri-plugin-http/api-iife.js new file mode 100644 index 00000000..70b99c24 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/api-iife.js @@ -0,0 +1 @@ +if("__TAURI__"in window){var __TAURI_PLUGIN_HTTP__=function(e){"use strict";function t(e,t,r,n){if("function"==typeof t||!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?n:"a"===r?n.call(e):n?n.value:t.get(e)}function r(e,t,r,n,s){if("function"==typeof t||!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");return t.set(e,r),r}var n,s,i,a;"function"==typeof SuppressedError&&SuppressedError;const o="__TAURI_TO_IPC_KEY__";class c{constructor(e){n.set(this,void 0),s.set(this,0),i.set(this,[]),a.set(this,void 0),r(this,n,e||(()=>{})),this.id=function(e,t=!1){return window.__TAURI_INTERNALS__.transformCallback(e,t)}((e=>{const o=e.index;if("end"in e)return void(o==t(this,s,"f")?this.cleanupCallback():r(this,a,o));const c=e.message;if(o==t(this,s,"f")){for(t(this,n,"f").call(this,c),r(this,s,t(this,s,"f")+1);t(this,s,"f")in t(this,i,"f");){const e=t(this,i,"f")[t(this,s,"f")];t(this,n,"f").call(this,e),delete t(this,i,"f")[t(this,s,"f")],r(this,s,t(this,s,"f")+1)}t(this,s,"f")===t(this,a,"f")&&this.cleanupCallback()}else t(this,i,"f")[o]=c}))}cleanupCallback(){Reflect.deleteProperty(window,`_${this.id}`)}set onmessage(e){r(this,n,e)}get onmessage(){return t(this,n,"f")}[(n=new WeakMap,s=new WeakMap,i=new WeakMap,a=new WeakMap,o)](){return`__CHANNEL__:${this.id}`}toJSON(){return this[o]()}}async function d(e,t={},r){return window.__TAURI_INTERNALS__.invoke(e,t,r)}const h="Request cancelled";return e.fetch=async function(e,t){const r=t?.signal;if(r?.aborted)throw new Error(h);const n=t?.maxRedirections,s=t?.connectTimeout,i=t?.proxy,a=t?.danger;t&&(delete t.maxRedirections,delete t.connectTimeout,delete t.proxy,delete t.danger);const o=t?.headers?t.headers instanceof Headers?t.headers:new Headers(t.headers):new Headers,f=new Request(e,t),l=await f.arrayBuffer(),u=0!==l.byteLength?Array.from(new Uint8Array(l)):null;for(const[e,t]of f.headers)o.get(e)||o.set(e,t);const _=(o instanceof Headers?Array.from(o.entries()):Array.isArray(o)?o:Object.entries(o)).map((([e,t])=>[e,"string"==typeof t?t:t.toString()]));if(r?.aborted)throw new Error(h);const w=await d("plugin:http|fetch",{clientConfig:{method:f.method,url:f.url,headers:_,data:u,maxRedirections:n,connectTimeout:s,proxy:i,danger:a}}),p=()=>d("plugin:http|fetch_cancel",{rid:w});if(r?.aborted)throw p(),new Error(h);r?.addEventListener("abort",(()=>{p()}));const{status:y,statusText:m,url:b,headers:g,rid:T}=await d("plugin:http|fetch_send",{rid:w}),R=[101,103,204,205,304].includes(y)?null:new ReadableStream({start:e=>{const t=new c;t.onmessage=t=>{if(r?.aborted)return void e.error(h);const n=new Uint8Array(t),s=n[n.byteLength-1],i=n.slice(0,n.byteLength-1);1!=s?e.enqueue(i):e.close()},d("plugin:http|fetch_read_body",{rid:T,streamChannel:t}).catch((t=>{e.error(t)}))}}),A=new Response(R,{status:y,statusText:m});return Object.defineProperty(A,"url",{value:b}),Object.defineProperty(A,"headers",{value:new Headers(g)}),A},e}({});Object.defineProperty(window.__TAURI__,"http",{value:__TAURI_PLUGIN_HTTP__})} diff --git a/crates/vendor/tauri-plugin-http/banner.png b/crates/vendor/tauri-plugin-http/banner.png new file mode 100644 index 00000000..121741e5 Binary files /dev/null and b/crates/vendor/tauri-plugin-http/banner.png differ diff --git a/crates/vendor/tauri-plugin-http/build.rs b/crates/vendor/tauri-plugin-http/build.rs new file mode 100644 index 00000000..a4b802ad --- /dev/null +++ b/crates/vendor/tauri-plugin-http/build.rs @@ -0,0 +1,67 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +#[path = "src/scope.rs"] +#[allow(dead_code)] +mod scope; + +const COMMANDS: &[&str] = &["fetch", "fetch_cancel", "fetch_send", "fetch_read_body"]; + +/// HTTP scope entry. +#[derive(schemars::JsonSchema)] +#[serde(untagged)] +#[allow(unused)] +enum HttpScopeEntry { + /// A URL that can be accessed by the webview when using the HTTP APIs. + /// Wildcards can be used following the URL pattern standard. + /// + /// See [the URL Pattern spec](https://urlpattern.spec.whatwg.org/) for more information. + /// + /// Examples: + /// + /// - "https://*" : allows all HTTPS origin on port 443 + /// + /// - "https://*:*" : allows all HTTPS origin on any port + /// + /// - "https://*.github.com/tauri-apps/tauri": allows any subdomain of "github.com" with the "tauri-apps/api" path + /// + /// - "https://myapi.service.com/users/*": allows access to any URLs that begins with "https://myapi.service.com/users/" + Value(String), + Object { + /// A URL that can be accessed by the webview when using the HTTP APIs. + /// Wildcards can be used following the URL pattern standard. + /// + /// See [the URL Pattern spec](https://urlpattern.spec.whatwg.org/) for more information. + /// + /// Examples: + /// + /// - "https://*" : allows all HTTPS origin on port 443 + /// + /// - "https://*:*" : allows all HTTPS origin on any port + /// + /// - "https://*.github.com/tauri-apps/tauri": allows any subdomain of "github.com" with the "tauri-apps/api" path + /// + /// - "https://myapi.service.com/users/*": allows access to any URLs that begins with "https://myapi.service.com/users/" + url: String, + }, +} + +// Ensure `HttpScopeEntry` and `scope::EntryRaw` is kept in sync +fn _f() { + match scope::EntryRaw::Value(String::new()) { + scope::EntryRaw::Value(url) => HttpScopeEntry::Value(url), + scope::EntryRaw::Object { url } => HttpScopeEntry::Object { url }, + }; + match HttpScopeEntry::Value(String::new()) { + HttpScopeEntry::Value(url) => scope::EntryRaw::Value(url), + HttpScopeEntry::Object { url } => scope::EntryRaw::Object { url }, + }; +} + +fn main() { + tauri_plugin::Builder::new(COMMANDS) + .global_api_script_path("./api-iife.js") + .global_scope_schema(schemars::schema_for!(HttpScopeEntry)) + .build(); +} diff --git a/crates/vendor/tauri-plugin-http/dist-js/index.cjs b/crates/vendor/tauri-plugin-http/dist-js/index.cjs new file mode 100644 index 00000000..93f34384 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/dist-js/index.cjs @@ -0,0 +1,166 @@ +'use strict'; + +var core = require('@tauri-apps/api/core'); + +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT +/** + * Make HTTP requests with the Rust backend. + * + * ## Security + * + * This API has a scope configuration that forces you to restrict the URLs that can be accessed using glob patterns. + * + * For instance, this scope configuration only allows making HTTP requests to all subdomains for `tauri.app` except for `https://private.tauri.app`: + * ```json + * { + * "permissions": [ + * { + * "identifier": "http:default", + * "allow": [{ "url": "https://*.tauri.app" }], + * "deny": [{ "url": "https://private.tauri.app" }] + * } + * ] + * } + * ``` + * Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access. + * + * @module + */ +const ERROR_REQUEST_CANCELLED = 'Request cancelled'; +/** + * Fetch a resource from the network. It returns a `Promise` that resolves to the + * `Response` to that `Request`, whether it is successful or not. + * + * @example + * ```typescript + * const response = await fetch("http://my.json.host/data.json"); + * console.log(response.status); // e.g. 200 + * console.log(response.statusText); // e.g. "OK" + * const jsonData = await response.json(); + * ``` + * + * @since 2.0.0 + */ +async function fetch(input, init) { + // abort early here if needed + const signal = init?.signal; + if (signal?.aborted) { + throw new Error(ERROR_REQUEST_CANCELLED); + } + const maxRedirections = init?.maxRedirections; + const connectTimeout = init?.connectTimeout; + const proxy = init?.proxy; + const danger = init?.danger; + // Remove these fields before creating the request + if (init) { + delete init.maxRedirections; + delete init.connectTimeout; + delete init.proxy; + delete init.danger; + } + const headers = init?.headers + ? init.headers instanceof Headers + ? init.headers + : new Headers(init.headers) + : new Headers(); + const req = new Request(input, init); + const buffer = await req.arrayBuffer(); + const data = buffer.byteLength !== 0 ? Array.from(new Uint8Array(buffer)) : null; + // append new headers created by the browser `Request` implementation, + // if not already declared by the caller of this function + for (const [key, value] of req.headers) { + if (!headers.get(key)) { + headers.set(key, value); + } + } + const headersArray = headers instanceof Headers + ? Array.from(headers.entries()) + : Array.isArray(headers) + ? headers + : Object.entries(headers); + // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment + const mappedHeaders = headersArray.map(([name, val]) => [ + name, + // we need to ensure we have all header values as strings + // eslint-disable-next-line + typeof val === 'string' ? val : val.toString() + ]); + // abort early here if needed + if (signal?.aborted) { + throw new Error(ERROR_REQUEST_CANCELLED); + } + const rid = await core.invoke('plugin:http|fetch', { + clientConfig: { + method: req.method, + url: req.url, + headers: mappedHeaders, + data, + maxRedirections, + connectTimeout, + proxy, + danger + } + }); + const abort = () => core.invoke('plugin:http|fetch_cancel', { rid }); + // abort early here if needed + if (signal?.aborted) { + // we don't care about the result of this proimse + // eslint-disable-next-line @typescript-eslint/no-floating-promises + abort(); + throw new Error(ERROR_REQUEST_CANCELLED); + } + signal?.addEventListener('abort', () => void abort()); + const { status, statusText, url, headers: responseHeaders, rid: responseRid } = await core.invoke('plugin:http|fetch_send', { + rid + }); + // no body for 101, 103, 204, 205 and 304 + // see https://fetch.spec.whatwg.org/#null-body-status + const body = [101, 103, 204, 205, 304].includes(status) + ? null + : new ReadableStream({ + start: (controller) => { + const streamChannel = new core.Channel(); + streamChannel.onmessage = (res) => { + // close early if aborted + if (signal?.aborted) { + controller.error(ERROR_REQUEST_CANCELLED); + return; + } + const resUint8 = new Uint8Array(res); + const lastByte = resUint8[resUint8.byteLength - 1]; + const actualRes = resUint8.slice(0, resUint8.byteLength - 1); + // close when the signal to close (last byte is 1) is sent from the IPC. + if (lastByte == 1) { + controller.close(); + return; + } + controller.enqueue(actualRes); + }; + // run a non-blocking body stream fetch + core.invoke('plugin:http|fetch_read_body', { + rid: responseRid, + streamChannel + }).catch((e) => { + controller.error(e); + }); + } + }); + const res = new Response(body, { + status, + statusText + }); + // Set `Response` properties that are ignored by the + // constructor, like url and some headers + // + // Since url and headers are read only properties + // this is the only way to set them. + Object.defineProperty(res, 'url', { value: url }); + Object.defineProperty(res, 'headers', { + value: new Headers(responseHeaders) + }); + return res; +} + +exports.fetch = fetch; diff --git a/crates/vendor/tauri-plugin-http/dist-js/index.d.ts b/crates/vendor/tauri-plugin-http/dist-js/index.d.ts new file mode 100644 index 00000000..b030d621 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/dist-js/index.d.ts @@ -0,0 +1,89 @@ +/** + * Configuration of a proxy that a Client should pass requests to. + * + * @since 2.0.0 + */ +export interface Proxy { + /** + * Proxy all traffic to the passed URL. + */ + all?: string | ProxyConfig; + /** + * Proxy all HTTP traffic to the passed URL. + */ + http?: string | ProxyConfig; + /** + * Proxy all HTTPS traffic to the passed URL. + */ + https?: string | ProxyConfig; +} +export interface ProxyConfig { + /** + * The URL of the proxy server. + */ + url: string; + /** + * Set the `Proxy-Authorization` header using Basic auth. + */ + basicAuth?: { + username: string; + password: string; + }; + /** + * A configuration for filtering out requests that shouldn't be proxied. + * Entries are expected to be comma-separated (whitespace between entries is ignored) + */ + noProxy?: string; +} +/** + * Options to configure the Rust client used to make fetch requests + * + * @since 2.0.0 + */ +export interface ClientOptions { + /** + * Defines the maximum number of redirects the client should follow. + * If set to 0, no redirects will be followed. + */ + maxRedirections?: number; + /** Timeout in milliseconds */ + connectTimeout?: number; + /** + * Configuration of a proxy that a Client should pass requests to. + */ + proxy?: Proxy; + /** + * Configuration for dangerous settings on the client such as disabling SSL verification. + */ + danger?: DangerousSettings; +} +/** + * Configuration for dangerous settings on the client such as disabling SSL verification. + * + * @since 2.3.0 + */ +export interface DangerousSettings { + /** + * Disables SSL verification. + */ + acceptInvalidCerts?: boolean; + /** + * Disables hostname verification. + */ + acceptInvalidHostnames?: boolean; +} +/** + * Fetch a resource from the network. It returns a `Promise` that resolves to the + * `Response` to that `Request`, whether it is successful or not. + * + * @example + * ```typescript + * const response = await fetch("http://my.json.host/data.json"); + * console.log(response.status); // e.g. 200 + * console.log(response.statusText); // e.g. "OK" + * const jsonData = await response.json(); + * ``` + * + * @since 2.0.0 + */ +export declare function fetch(input: URL | Request | string, init?: RequestInit & ClientOptions): Promise; diff --git a/crates/vendor/tauri-plugin-http/dist-js/index.js b/crates/vendor/tauri-plugin-http/dist-js/index.js new file mode 100644 index 00000000..f4db76b0 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/dist-js/index.js @@ -0,0 +1,164 @@ +import { invoke, Channel } from '@tauri-apps/api/core'; + +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT +/** + * Make HTTP requests with the Rust backend. + * + * ## Security + * + * This API has a scope configuration that forces you to restrict the URLs that can be accessed using glob patterns. + * + * For instance, this scope configuration only allows making HTTP requests to all subdomains for `tauri.app` except for `https://private.tauri.app`: + * ```json + * { + * "permissions": [ + * { + * "identifier": "http:default", + * "allow": [{ "url": "https://*.tauri.app" }], + * "deny": [{ "url": "https://private.tauri.app" }] + * } + * ] + * } + * ``` + * Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access. + * + * @module + */ +const ERROR_REQUEST_CANCELLED = 'Request cancelled'; +/** + * Fetch a resource from the network. It returns a `Promise` that resolves to the + * `Response` to that `Request`, whether it is successful or not. + * + * @example + * ```typescript + * const response = await fetch("http://my.json.host/data.json"); + * console.log(response.status); // e.g. 200 + * console.log(response.statusText); // e.g. "OK" + * const jsonData = await response.json(); + * ``` + * + * @since 2.0.0 + */ +async function fetch(input, init) { + // abort early here if needed + const signal = init?.signal; + if (signal?.aborted) { + throw new Error(ERROR_REQUEST_CANCELLED); + } + const maxRedirections = init?.maxRedirections; + const connectTimeout = init?.connectTimeout; + const proxy = init?.proxy; + const danger = init?.danger; + // Remove these fields before creating the request + if (init) { + delete init.maxRedirections; + delete init.connectTimeout; + delete init.proxy; + delete init.danger; + } + const headers = init?.headers + ? init.headers instanceof Headers + ? init.headers + : new Headers(init.headers) + : new Headers(); + const req = new Request(input, init); + const buffer = await req.arrayBuffer(); + const data = buffer.byteLength !== 0 ? Array.from(new Uint8Array(buffer)) : null; + // append new headers created by the browser `Request` implementation, + // if not already declared by the caller of this function + for (const [key, value] of req.headers) { + if (!headers.get(key)) { + headers.set(key, value); + } + } + const headersArray = headers instanceof Headers + ? Array.from(headers.entries()) + : Array.isArray(headers) + ? headers + : Object.entries(headers); + // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment + const mappedHeaders = headersArray.map(([name, val]) => [ + name, + // we need to ensure we have all header values as strings + // eslint-disable-next-line + typeof val === 'string' ? val : val.toString() + ]); + // abort early here if needed + if (signal?.aborted) { + throw new Error(ERROR_REQUEST_CANCELLED); + } + const rid = await invoke('plugin:http|fetch', { + clientConfig: { + method: req.method, + url: req.url, + headers: mappedHeaders, + data, + maxRedirections, + connectTimeout, + proxy, + danger + } + }); + const abort = () => invoke('plugin:http|fetch_cancel', { rid }); + // abort early here if needed + if (signal?.aborted) { + // we don't care about the result of this proimse + // eslint-disable-next-line @typescript-eslint/no-floating-promises + abort(); + throw new Error(ERROR_REQUEST_CANCELLED); + } + signal?.addEventListener('abort', () => void abort()); + const { status, statusText, url, headers: responseHeaders, rid: responseRid } = await invoke('plugin:http|fetch_send', { + rid + }); + // no body for 101, 103, 204, 205 and 304 + // see https://fetch.spec.whatwg.org/#null-body-status + const body = [101, 103, 204, 205, 304].includes(status) + ? null + : new ReadableStream({ + start: (controller) => { + const streamChannel = new Channel(); + streamChannel.onmessage = (res) => { + // close early if aborted + if (signal?.aborted) { + controller.error(ERROR_REQUEST_CANCELLED); + return; + } + const resUint8 = new Uint8Array(res); + const lastByte = resUint8[resUint8.byteLength - 1]; + const actualRes = resUint8.slice(0, resUint8.byteLength - 1); + // close when the signal to close (last byte is 1) is sent from the IPC. + if (lastByte == 1) { + controller.close(); + return; + } + controller.enqueue(actualRes); + }; + // run a non-blocking body stream fetch + invoke('plugin:http|fetch_read_body', { + rid: responseRid, + streamChannel + }).catch((e) => { + controller.error(e); + }); + } + }); + const res = new Response(body, { + status, + statusText + }); + // Set `Response` properties that are ignored by the + // constructor, like url and some headers + // + // Since url and headers are read only properties + // this is the only way to set them. + Object.defineProperty(res, 'url', { value: url }); + Object.defineProperty(res, 'headers', { + value: new Headers(responseHeaders) + }); + return res; +} + +export { fetch }; diff --git a/crates/vendor/tauri-plugin-http/guest-js/index.ts b/crates/vendor/tauri-plugin-http/guest-js/index.ts new file mode 100644 index 00000000..4b38f8bf --- /dev/null +++ b/crates/vendor/tauri-plugin-http/guest-js/index.ts @@ -0,0 +1,285 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +/** + * Make HTTP requests with the Rust backend. + * + * ## Security + * + * This API has a scope configuration that forces you to restrict the URLs that can be accessed using glob patterns. + * + * For instance, this scope configuration only allows making HTTP requests to all subdomains for `tauri.app` except for `https://private.tauri.app`: + * ```json + * { + * "permissions": [ + * { + * "identifier": "http:default", + * "allow": [{ "url": "https://*.tauri.app" }], + * "deny": [{ "url": "https://private.tauri.app" }] + * } + * ] + * } + * ``` + * Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access. + * + * @module + */ + +import { Channel, invoke } from '@tauri-apps/api/core' + +/** + * Configuration of a proxy that a Client should pass requests to. + * + * @since 2.0.0 + */ +export interface Proxy { + /** + * Proxy all traffic to the passed URL. + */ + all?: string | ProxyConfig + /** + * Proxy all HTTP traffic to the passed URL. + */ + http?: string | ProxyConfig + /** + * Proxy all HTTPS traffic to the passed URL. + */ + https?: string | ProxyConfig +} + +export interface ProxyConfig { + /** + * The URL of the proxy server. + */ + url: string + /** + * Set the `Proxy-Authorization` header using Basic auth. + */ + basicAuth?: { + username: string + password: string + } + /** + * A configuration for filtering out requests that shouldn't be proxied. + * Entries are expected to be comma-separated (whitespace between entries is ignored) + */ + noProxy?: string +} + +/** + * Options to configure the Rust client used to make fetch requests + * + * @since 2.0.0 + */ +export interface ClientOptions { + /** + * Defines the maximum number of redirects the client should follow. + * If set to 0, no redirects will be followed. + */ + maxRedirections?: number + /** Timeout in milliseconds */ + connectTimeout?: number + /** + * Configuration of a proxy that a Client should pass requests to. + */ + proxy?: Proxy + /** + * Configuration for dangerous settings on the client such as disabling SSL verification. + */ + danger?: DangerousSettings +} + +/** + * Configuration for dangerous settings on the client such as disabling SSL verification. + * + * @since 2.3.0 + */ +export interface DangerousSettings { + /** + * Disables SSL verification. + */ + acceptInvalidCerts?: boolean + /** + * Disables hostname verification. + */ + acceptInvalidHostnames?: boolean +} + +const ERROR_REQUEST_CANCELLED = 'Request cancelled' + +/** + * Fetch a resource from the network. It returns a `Promise` that resolves to the + * `Response` to that `Request`, whether it is successful or not. + * + * @example + * ```typescript + * const response = await fetch("http://my.json.host/data.json"); + * console.log(response.status); // e.g. 200 + * console.log(response.statusText); // e.g. "OK" + * const jsonData = await response.json(); + * ``` + * + * @since 2.0.0 + */ +export async function fetch( + input: URL | Request | string, + init?: RequestInit & ClientOptions +): Promise { + // abort early here if needed + const signal = init?.signal + if (signal?.aborted) { + throw new Error(ERROR_REQUEST_CANCELLED) + } + + const maxRedirections = init?.maxRedirections + const connectTimeout = init?.connectTimeout + const proxy = init?.proxy + const danger = init?.danger + + // Remove these fields before creating the request + if (init) { + delete init.maxRedirections + delete init.connectTimeout + delete init.proxy + delete init.danger + } + + const headers = init?.headers + ? init.headers instanceof Headers + ? init.headers + : new Headers(init.headers) + : new Headers() + + const req = new Request(input, init) + const buffer = await req.arrayBuffer() + const data = + buffer.byteLength !== 0 ? Array.from(new Uint8Array(buffer)) : null + + // append new headers created by the browser `Request` implementation, + // if not already declared by the caller of this function + for (const [key, value] of req.headers) { + if (!headers.get(key)) { + headers.set(key, value) + } + } + + const headersArray = + headers instanceof Headers + ? Array.from(headers.entries()) + : Array.isArray(headers) + ? headers + : Object.entries(headers) + + // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment + const mappedHeaders: Array<[string, string]> = headersArray.map( + ([name, val]) => [ + name, + // we need to ensure we have all header values as strings + // eslint-disable-next-line + typeof val === 'string' ? val : (val as any).toString() + ] + ) + + // abort early here if needed + if (signal?.aborted) { + throw new Error(ERROR_REQUEST_CANCELLED) + } + + const rid = await invoke('plugin:http|fetch', { + clientConfig: { + method: req.method, + url: req.url, + headers: mappedHeaders, + data, + maxRedirections, + connectTimeout, + proxy, + danger + } + }) + + const abort = () => invoke('plugin:http|fetch_cancel', { rid }) + + // abort early here if needed + if (signal?.aborted) { + // we don't care about the result of this proimse + // eslint-disable-next-line @typescript-eslint/no-floating-promises + abort() + throw new Error(ERROR_REQUEST_CANCELLED) + } + + signal?.addEventListener('abort', () => void abort()) + + interface FetchSendResponse { + status: number + statusText: string + headers: [[string, string]] + url: string + rid: number + } + + const { + status, + statusText, + url, + headers: responseHeaders, + rid: responseRid + } = await invoke('plugin:http|fetch_send', { + rid + }) + + // no body for 101, 103, 204, 205 and 304 + // see https://fetch.spec.whatwg.org/#null-body-status + const body = [101, 103, 204, 205, 304].includes(status) + ? null + : new ReadableStream({ + start: (controller) => { + const streamChannel = new Channel() + streamChannel.onmessage = (res: ArrayBuffer | number[]) => { + // close early if aborted + if (signal?.aborted) { + controller.error(ERROR_REQUEST_CANCELLED) + return + } + + const resUint8 = new Uint8Array(res) + const lastByte = resUint8[resUint8.byteLength - 1] + const actualRes = resUint8.slice(0, resUint8.byteLength - 1) + + // close when the signal to close (last byte is 1) is sent from the IPC. + if (lastByte == 1) { + controller.close() + return + } + + controller.enqueue(actualRes) + } + + // run a non-blocking body stream fetch + invoke('plugin:http|fetch_read_body', { + rid: responseRid, + streamChannel + }).catch((e) => { + controller.error(e) + }) + } + }) + + const res = new Response(body, { + status, + statusText + }) + + // Set `Response` properties that are ignored by the + // constructor, like url and some headers + // + // Since url and headers are read only properties + // this is the only way to set them. + Object.defineProperty(res, 'url', { value: url }) + Object.defineProperty(res, 'headers', { + value: new Headers(responseHeaders) + }) + + return res +} diff --git a/crates/vendor/tauri-plugin-http/package.json b/crates/vendor/tauri-plugin-http/package.json new file mode 100644 index 00000000..7439c461 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/package.json @@ -0,0 +1,29 @@ +{ + "name": "@tauri-apps/plugin-http", + "version": "2.4.3", + "license": "MIT OR Apache-2.0", + "authors": [ + "Tauri Programme within The Commons Conservancy" + ], + "repository": "https://github.com/tauri-apps/plugins-workspace", + "type": "module", + "types": "./dist-js/index.d.ts", + "main": "./dist-js/index.cjs", + "module": "./dist-js/index.js", + "exports": { + "types": "./dist-js/index.d.ts", + "import": "./dist-js/index.js", + "require": "./dist-js/index.cjs" + }, + "scripts": { + "build": "rollup -c" + }, + "files": [ + "dist-js", + "README.md", + "LICENSE" + ], + "dependencies": { + "@tauri-apps/api": "^2.0.0" + } +} diff --git a/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch.toml b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch.toml new file mode 100644 index 00000000..c4e068a7 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch.toml @@ -0,0 +1,13 @@ +# Automatically generated - DO NOT EDIT! + +"$schema" = "../../schemas/schema.json" + +[[permission]] +identifier = "allow-fetch" +description = "Enables the fetch command without any pre-configured scope." +commands.allow = ["fetch"] + +[[permission]] +identifier = "deny-fetch" +description = "Denies the fetch command without any pre-configured scope." +commands.deny = ["fetch"] diff --git a/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_cancel.toml b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_cancel.toml new file mode 100644 index 00000000..70c1139b --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_cancel.toml @@ -0,0 +1,13 @@ +# Automatically generated - DO NOT EDIT! + +"$schema" = "../../schemas/schema.json" + +[[permission]] +identifier = "allow-fetch-cancel" +description = "Enables the fetch_cancel command without any pre-configured scope." +commands.allow = ["fetch_cancel"] + +[[permission]] +identifier = "deny-fetch-cancel" +description = "Denies the fetch_cancel command without any pre-configured scope." +commands.deny = ["fetch_cancel"] diff --git a/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_read_body.toml b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_read_body.toml new file mode 100644 index 00000000..b5867e99 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_read_body.toml @@ -0,0 +1,13 @@ +# Automatically generated - DO NOT EDIT! + +"$schema" = "../../schemas/schema.json" + +[[permission]] +identifier = "allow-fetch-read-body" +description = "Enables the fetch_read_body command without any pre-configured scope." +commands.allow = ["fetch_read_body"] + +[[permission]] +identifier = "deny-fetch-read-body" +description = "Denies the fetch_read_body command without any pre-configured scope." +commands.deny = ["fetch_read_body"] diff --git a/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_send.toml b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_send.toml new file mode 100644 index 00000000..f6a55d28 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/autogenerated/commands/fetch_send.toml @@ -0,0 +1,13 @@ +# Automatically generated - DO NOT EDIT! + +"$schema" = "../../schemas/schema.json" + +[[permission]] +identifier = "allow-fetch-send" +description = "Enables the fetch_send command without any pre-configured scope." +commands.allow = ["fetch_send"] + +[[permission]] +identifier = "deny-fetch-send" +description = "Denies the fetch_send command without any pre-configured scope." +commands.deny = ["fetch_send"] diff --git a/crates/vendor/tauri-plugin-http/permissions/autogenerated/reference.md b/crates/vendor/tauri-plugin-http/permissions/autogenerated/reference.md new file mode 100644 index 00000000..40c41cac --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/autogenerated/reference.md @@ -0,0 +1,133 @@ +## Default Permission + +This permission set configures what kind of +fetch operations are available from the http plugin. + +This enables all fetch operations but does not +allow explicitly any origins to be fetched. This needs to +be manually configured before usage. + +#### Granted Permissions + +All fetch operations are enabled. + +#### This default permission set includes the following: + +- `allow-fetch` +- `allow-fetch-cancel` +- `allow-fetch-read-body` +- `allow-fetch-send` + +## Permission Table + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IdentifierDescription
+ +`http:allow-fetch` + + + +Enables the fetch command without any pre-configured scope. + +
+ +`http:deny-fetch` + + + +Denies the fetch command without any pre-configured scope. + +
+ +`http:allow-fetch-cancel` + + + +Enables the fetch_cancel command without any pre-configured scope. + +
+ +`http:deny-fetch-cancel` + + + +Denies the fetch_cancel command without any pre-configured scope. + +
+ +`http:allow-fetch-read-body` + + + +Enables the fetch_read_body command without any pre-configured scope. + +
+ +`http:deny-fetch-read-body` + + + +Denies the fetch_read_body command without any pre-configured scope. + +
+ +`http:allow-fetch-send` + + + +Enables the fetch_send command without any pre-configured scope. + +
+ +`http:deny-fetch-send` + + + +Denies the fetch_send command without any pre-configured scope. + +
diff --git a/crates/vendor/tauri-plugin-http/permissions/default.toml b/crates/vendor/tauri-plugin-http/permissions/default.toml new file mode 100644 index 00000000..b469536d --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/default.toml @@ -0,0 +1,22 @@ +"$schema" = "schemas/schema.json" + +[default] +description = """ +This permission set configures what kind of +fetch operations are available from the http plugin. + +This enables all fetch operations but does not +allow explicitly any origins to be fetched. This needs to +be manually configured before usage. + +#### Granted Permissions + +All fetch operations are enabled. + +""" +permissions = [ + "allow-fetch", + "allow-fetch-cancel", + "allow-fetch-read-body", + "allow-fetch-send", +] diff --git a/crates/vendor/tauri-plugin-http/permissions/schemas/schema.json b/crates/vendor/tauri-plugin-http/permissions/schemas/schema.json new file mode 100644 index 00000000..ea774399 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/permissions/schemas/schema.json @@ -0,0 +1,354 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "PermissionFile", + "description": "Permission file that can define a default permission, a set of permissions or a list of inlined permissions.", + "type": "object", + "properties": { + "default": { + "description": "The default permission set for the plugin", + "anyOf": [ + { + "$ref": "#/definitions/DefaultPermission" + }, + { + "type": "null" + } + ] + }, + "set": { + "description": "A list of permissions sets defined", + "type": "array", + "items": { + "$ref": "#/definitions/PermissionSet" + } + }, + "permission": { + "description": "A list of inlined permissions", + "default": [], + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + } + } + }, + "definitions": { + "DefaultPermission": { + "description": "The default permission set of the plugin.\n\nWorks similarly to a permission with the \"default\" identifier.", + "type": "object", + "required": [ + "permissions" + ], + "properties": { + "version": { + "description": "The version of the permission.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 1.0 + }, + "description": { + "description": "Human-readable description of what the permission does. Tauri convention is to use `

` headings in markdown content for Tauri documentation generation purposes.", + "type": [ + "string", + "null" + ] + }, + "permissions": { + "description": "All permissions this set contains.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PermissionSet": { + "description": "A set of direct permissions grouped together under a new name.", + "type": "object", + "required": [ + "description", + "identifier", + "permissions" + ], + "properties": { + "identifier": { + "description": "A unique identifier for the permission.", + "type": "string" + }, + "description": { + "description": "Human-readable description of what the permission does.", + "type": "string" + }, + "permissions": { + "description": "All permissions this set contains.", + "type": "array", + "items": { + "$ref": "#/definitions/PermissionKind" + } + } + } + }, + "Permission": { + "description": "Descriptions of explicit privileges of commands.\n\nIt can enable commands to be accessible in the frontend of the application.\n\nIf the scope is defined it can be used to fine grain control the access of individual or multiple commands.", + "type": "object", + "required": [ + "identifier" + ], + "properties": { + "version": { + "description": "The version of the permission.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 1.0 + }, + "identifier": { + "description": "A unique identifier for the permission.", + "type": "string" + }, + "description": { + "description": "Human-readable description of what the permission does. Tauri internal convention is to use `

` headings in markdown content for Tauri documentation generation purposes.", + "type": [ + "string", + "null" + ] + }, + "commands": { + "description": "Allowed or denied commands when using this permission.", + "default": { + "allow": [], + "deny": [] + }, + "allOf": [ + { + "$ref": "#/definitions/Commands" + } + ] + }, + "scope": { + "description": "Allowed or denied scoped when using this permission.", + "allOf": [ + { + "$ref": "#/definitions/Scopes" + } + ] + }, + "platforms": { + "description": "Target platforms this permission applies. By default all platforms are affected by this permission.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Target" + } + } + } + }, + "Commands": { + "description": "Allowed and denied commands inside a permission.\n\nIf two commands clash inside of `allow` and `deny`, it should be denied by default.", + "type": "object", + "properties": { + "allow": { + "description": "Allowed command.", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "deny": { + "description": "Denied command, which takes priority.", + "default": [], + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Scopes": { + "description": "An argument for fine grained behavior control of Tauri commands.\n\nIt can be of any serde serializable type and is used to allow or prevent certain actions inside a Tauri command. The configured scope is passed to the command and will be enforced by the command implementation.\n\n## Example\n\n```json { \"allow\": [{ \"path\": \"$HOME/**\" }], \"deny\": [{ \"path\": \"$HOME/secret.txt\" }] } ```", + "type": "object", + "properties": { + "allow": { + "description": "Data that defines what is allowed by the scope.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Value" + } + }, + "deny": { + "description": "Data that defines what is denied by the scope. This should be prioritized by validation logic.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Value" + } + } + } + }, + "Value": { + "description": "All supported ACL values.", + "anyOf": [ + { + "description": "Represents a null JSON value.", + "type": "null" + }, + { + "description": "Represents a [`bool`].", + "type": "boolean" + }, + { + "description": "Represents a valid ACL [`Number`].", + "allOf": [ + { + "$ref": "#/definitions/Number" + } + ] + }, + { + "description": "Represents a [`String`].", + "type": "string" + }, + { + "description": "Represents a list of other [`Value`]s.", + "type": "array", + "items": { + "$ref": "#/definitions/Value" + } + }, + { + "description": "Represents a map of [`String`] keys to [`Value`]s.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Value" + } + } + ] + }, + "Number": { + "description": "A valid ACL number.", + "anyOf": [ + { + "description": "Represents an [`i64`].", + "type": "integer", + "format": "int64" + }, + { + "description": "Represents a [`f64`].", + "type": "number", + "format": "double" + } + ] + }, + "Target": { + "description": "Platform target.", + "oneOf": [ + { + "description": "MacOS.", + "type": "string", + "enum": [ + "macOS" + ] + }, + { + "description": "Windows.", + "type": "string", + "enum": [ + "windows" + ] + }, + { + "description": "Linux.", + "type": "string", + "enum": [ + "linux" + ] + }, + { + "description": "Android.", + "type": "string", + "enum": [ + "android" + ] + }, + { + "description": "iOS.", + "type": "string", + "enum": [ + "iOS" + ] + } + ] + }, + "PermissionKind": { + "type": "string", + "oneOf": [ + { + "description": "Enables the fetch command without any pre-configured scope.", + "type": "string", + "const": "allow-fetch", + "markdownDescription": "Enables the fetch command without any pre-configured scope." + }, + { + "description": "Denies the fetch command without any pre-configured scope.", + "type": "string", + "const": "deny-fetch", + "markdownDescription": "Denies the fetch command without any pre-configured scope." + }, + { + "description": "Enables the fetch_cancel command without any pre-configured scope.", + "type": "string", + "const": "allow-fetch-cancel", + "markdownDescription": "Enables the fetch_cancel command without any pre-configured scope." + }, + { + "description": "Denies the fetch_cancel command without any pre-configured scope.", + "type": "string", + "const": "deny-fetch-cancel", + "markdownDescription": "Denies the fetch_cancel command without any pre-configured scope." + }, + { + "description": "Enables the fetch_read_body command without any pre-configured scope.", + "type": "string", + "const": "allow-fetch-read-body", + "markdownDescription": "Enables the fetch_read_body command without any pre-configured scope." + }, + { + "description": "Denies the fetch_read_body command without any pre-configured scope.", + "type": "string", + "const": "deny-fetch-read-body", + "markdownDescription": "Denies the fetch_read_body command without any pre-configured scope." + }, + { + "description": "Enables the fetch_send command without any pre-configured scope.", + "type": "string", + "const": "allow-fetch-send", + "markdownDescription": "Enables the fetch_send command without any pre-configured scope." + }, + { + "description": "Denies the fetch_send command without any pre-configured scope.", + "type": "string", + "const": "deny-fetch-send", + "markdownDescription": "Denies the fetch_send command without any pre-configured scope." + }, + { + "description": "This permission set configures what kind of\nfetch operations are available from the http plugin.\n\nThis enables all fetch operations but does not\nallow explicitly any origins to be fetched. This needs to\nbe manually configured before usage.\n\n#### Granted Permissions\n\nAll fetch operations are enabled.\n\n\n#### This default permission set includes:\n\n- `allow-fetch`\n- `allow-fetch-cancel`\n- `allow-fetch-read-body`\n- `allow-fetch-send`", + "type": "string", + "const": "default", + "markdownDescription": "This permission set configures what kind of\nfetch operations are available from the http plugin.\n\nThis enables all fetch operations but does not\nallow explicitly any origins to be fetched. This needs to\nbe manually configured before usage.\n\n#### Granted Permissions\n\nAll fetch operations are enabled.\n\n\n#### This default permission set includes:\n\n- `allow-fetch`\n- `allow-fetch-cancel`\n- `allow-fetch-read-body`\n- `allow-fetch-send`" + } + ] + } + } +} \ No newline at end of file diff --git a/crates/vendor/tauri-plugin-http/rollup.config.js b/crates/vendor/tauri-plugin-http/rollup.config.js new file mode 100644 index 00000000..1f349ec8 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/rollup.config.js @@ -0,0 +1,7 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +import { createConfig } from '../../shared/rollup.config.js' + +export default createConfig() diff --git a/crates/vendor/tauri-plugin-http/src/commands.rs b/crates/vendor/tauri-plugin-http/src/commands.rs new file mode 100644 index 00000000..7093a727 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/src/commands.rs @@ -0,0 +1,490 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +use std::{future::Future, pin::Pin, str::FromStr, sync::Arc, time::Duration}; + +use http::{header, HeaderMap, HeaderName, HeaderValue, Method, StatusCode}; +use reqwest::{redirect::Policy, NoProxy}; +use serde::{Deserialize, Serialize}; +use tauri::{ + async_runtime::Mutex, + command, + ipc::{Channel, CommandScope, GlobalScope}, + Manager, ResourceId, ResourceTable, Runtime, State, Webview, +}; +use tokio::sync::oneshot::{channel, Receiver, Sender}; + +use crate::{ + scope::{Entry, Scope}, + Error, Http, Result, +}; + +const HTTP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"),); + +struct ReqwestResponse(reqwest::Response); +impl tauri::Resource for ReqwestResponse {} + +type CancelableResponseResult = Result; +type CancelableResponseFuture = + Pin + Send + Sync>>; + +struct FetchRequest { + fut: Mutex, + abort_tx_rid: ResourceId, + abort_rx_rid: ResourceId, +} +impl tauri::Resource for FetchRequest {} + +struct AbortSender(Sender<()>); +impl tauri::Resource for AbortRecveiver {} + +impl AbortSender { + fn abort(self) { + let _ = self.0.send(()); + } +} + +struct AbortRecveiver(Receiver<()>); +impl tauri::Resource for AbortSender {} + +trait AddRequest { + fn add_request(&mut self, fut: CancelableResponseFuture) -> ResourceId; +} + +impl AddRequest for ResourceTable { + fn add_request(&mut self, fut: CancelableResponseFuture) -> ResourceId { + let (tx, rx) = channel::<()>(); + let (tx, rx) = (AbortSender(tx), AbortRecveiver(rx)); + let req = FetchRequest { + fut: Mutex::new(fut), + abort_tx_rid: self.add(tx), + abort_rx_rid: self.add(rx), + }; + self.add(req) + } +} + +#[derive(Serialize)] +#[serde(rename_all = "camelCase")] +pub struct FetchResponse { + status: u16, + status_text: String, + headers: Vec<(String, String)>, + url: String, + rid: ResourceId, +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +#[allow(dead_code)] //feature flags shoudln't affect api +pub struct DangerousSettings { + accept_invalid_certs: bool, + accept_invalid_hostnames: bool, +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ClientConfig { + method: String, + url: url::Url, + headers: Vec<(String, String)>, + data: Option>, + connect_timeout: Option, + max_redirections: Option, + proxy: Option, + danger: Option, +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Proxy { + all: Option, + http: Option, + https: Option, +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +#[serde(untagged)] +pub enum UrlOrConfig { + Url(String), + Config(ProxyConfig), +} + +#[derive(Debug, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ProxyConfig { + url: String, + basic_auth: Option, + no_proxy: Option, +} + +#[derive(Debug, Deserialize)] +pub struct BasicAuth { + username: String, + password: String, +} + +#[inline] +fn proxy_creator( + url_or_config: UrlOrConfig, + proxy_fn: fn(String) -> reqwest::Result, +) -> reqwest::Result { + match url_or_config { + UrlOrConfig::Url(url) => Ok(proxy_fn(url)?), + UrlOrConfig::Config(ProxyConfig { + url, + basic_auth, + no_proxy, + }) => { + let mut proxy = proxy_fn(url)?; + if let Some(basic_auth) = basic_auth { + proxy = proxy.basic_auth(&basic_auth.username, &basic_auth.password); + } + if let Some(no_proxy) = no_proxy { + proxy = proxy.no_proxy(NoProxy::from_string(&no_proxy)); + } + Ok(proxy) + } + } +} + +fn attach_proxy( + proxy: Proxy, + mut builder: reqwest::ClientBuilder, +) -> crate::Result { + let Proxy { all, http, https } = proxy; + + if let Some(all) = all { + let proxy = proxy_creator(all, reqwest::Proxy::all)?; + builder = builder.proxy(proxy); + } + + if let Some(http) = http { + let proxy = proxy_creator(http, reqwest::Proxy::http)?; + builder = builder.proxy(proxy); + } + + if let Some(https) = https { + let proxy = proxy_creator(https, reqwest::Proxy::https)?; + builder = builder.proxy(proxy); + } + + Ok(builder) +} + +#[command] +pub async fn fetch( + webview: Webview, + state: State<'_, Http>, + client_config: ClientConfig, + command_scope: CommandScope, + global_scope: GlobalScope, +) -> crate::Result { + let ClientConfig { + method, + url, + headers: headers_raw, + data, + connect_timeout, + max_redirections, + proxy, + danger, + } = client_config; + + let scheme = url.scheme(); + let method = Method::from_bytes(method.as_bytes())?; + + let mut headers = HeaderMap::new(); + for (h, v) in headers_raw { + let name = HeaderName::from_str(&h)?; + #[cfg(not(feature = "unsafe-headers"))] + if is_unsafe_header(&name) { + #[cfg(debug_assertions)] + { + eprintln!("[\x1b[33mWARNING\x1b[0m] Skipping {name} header as it is a forbidden header per fetch spec https://fetch.spec.whatwg.org/#terminology-headers"); + eprintln!("[\x1b[33mWARNING\x1b[0m] if keeping the header is a desired behavior, you can enable `unsafe-headers` feature flag in your Cargo.toml"); + } + continue; + } + + headers.append(name, HeaderValue::from_str(&v)?); + } + + match scheme { + "http" | "https" => { + if Scope::new( + command_scope + .allows() + .iter() + .chain(global_scope.allows()) + .collect(), + command_scope + .denies() + .iter() + .chain(global_scope.denies()) + .collect(), + ) + .is_allowed(&url) + { + let mut builder = reqwest::ClientBuilder::new(); + + if let Some(danger_config) = danger { + #[cfg(not(feature = "dangerous-settings"))] + { + #[cfg(debug_assertions)] + { + eprintln!("[\x1b[33mWARNING\x1b[0m] using dangerous settings requires `dangerous-settings` feature flag in your Cargo.toml"); + } + let _ = danger_config; + return Err(Error::DangerousSettings); + } + #[cfg(feature = "dangerous-settings")] + { + builder = builder + .danger_accept_invalid_certs(danger_config.accept_invalid_certs) + .danger_accept_invalid_hostnames(danger_config.accept_invalid_hostnames) + } + } + + if let Some(timeout) = connect_timeout { + builder = builder.connect_timeout(Duration::from_millis(timeout)); + } + + if let Some(max_redirections) = max_redirections { + builder = builder.redirect(if max_redirections == 0 { + Policy::none() + } else { + Policy::limited(max_redirections) + }); + } + + if let Some(proxy_config) = proxy { + builder = attach_proxy(proxy_config, builder)?; + } + + #[cfg(feature = "cookies")] + { + builder = builder.cookie_provider(state.cookies_jar.clone()); + } + + let mut request = builder.build()?.request(method.clone(), url); + + // POST and PUT requests should always have a 0 length content-length, + // if there is no body. https://fetch.spec.whatwg.org/#http-network-or-cache-fetch + if data.is_none() && matches!(method, Method::POST | Method::PUT) { + headers.append(header::CONTENT_LENGTH, HeaderValue::from_str("0")?); + } + + if headers.contains_key(header::RANGE) { + // https://fetch.spec.whatwg.org/#http-network-or-cache-fetch step 18 + // If httpRequest’s header list contains `Range`, then append (`Accept-Encoding`, `identity`) + headers.append(header::ACCEPT_ENCODING, HeaderValue::from_str("identity")?); + } + + if !headers.contains_key(header::USER_AGENT) { + headers.append(header::USER_AGENT, HeaderValue::from_str(HTTP_USER_AGENT)?); + } + + // ensure we have an Origin header set + if cfg!(not(feature = "unsafe-headers")) || !headers.contains_key(header::ORIGIN) { + if let Ok(url) = webview.url() { + headers.append( + header::ORIGIN, + HeaderValue::from_str(&url.origin().ascii_serialization())?, + ); + } + } + + // In case empty origin is passed, remove it. Some services do not like Origin header + // so this way we can remove it in explicit way. The default behaviour is still to set it + if cfg!(feature = "unsafe-headers") + && headers.get(header::ORIGIN) == Some(&HeaderValue::from_static("")) + { + headers.remove(header::ORIGIN); + }; + + // NB(bt): In production builds, the origin seems to be "null". This is what our server CORS filter sees: + // [2025-05-01T23:42:35Z WARN actix_cors_configs::configs::fakeyou] Invalid origin: "null" + // [2025-05-01T23:42:35Z WARN actix_cors_configs::util::netlify_branch_domain_matches] Invalid origin: "null" + // [2025-05-01T23:42:35Z WARN actix_cors_configs::util::netlify_branch_domain_matches] Invalid origin: "null" + // ... + // [2025-05-01T23:42:35Z WARN actix_cors_configs::util::netlify_branch_domain_matches] Invalid origin: "null" + // [2025-05-01T23:42:35Z INFO actix_web::middleware::logger] [storyteller-web-85f9b4974-ddvq7] IP=[redact] + // 939322e1095ee5e4-IAD "POST /v1/login HTTP/1.1" 400 42 "-" "tauri-plugin-http/2.4.3" 0.000076 + let mut maybe_origin_header = headers.get(header::ORIGIN); + + let replace_origin_header = maybe_origin_header.is_none() + || maybe_origin_header == Some(&HeaderValue::from_static("null")) // Above error (Mac) + || maybe_origin_header == Some(&HeaderValue::from_static("http://tauri.localhost")) // Windows + || maybe_origin_header == Some(&HeaderValue::from_static("tauri://localhost")); // Mac plausibly causes this + + if replace_origin_header { + // TODO(bt): Make this a sentinel origin, eg. sentinel.storyteller.ai. + // NB: HeadersMap is a multimap, but this should ensure we just have one value. + headers.insert(header::ORIGIN, HeaderValue::from_static("https://studio.storyteller.ai")); + } + + if let Some(data) = data { + request = request.body(data); + } + + request = request.headers(headers); + + #[cfg(feature = "tracing")] + tracing::trace!("{:?}", request); + + let fut = async move { request.send().await.map_err(Into::into) }; + + let mut resources_table = webview.resources_table(); + let rid = resources_table.add_request(Box::pin(fut)); + + Ok(rid) + } else { + Err(Error::UrlNotAllowed(url)) + } + } + "data" => { + let data_url = + data_url::DataUrl::process(url.as_str()).map_err(|_| Error::DataUrlError)?; + let (body, _) = data_url + .decode_to_vec() + .map_err(|_| Error::DataUrlDecodeError)?; + + let response = http::Response::builder() + .status(StatusCode::OK) + .header(header::CONTENT_TYPE, data_url.mime_type().to_string()) + .body(reqwest::Body::from(body))?; + + #[cfg(feature = "tracing")] + tracing::trace!("{:?}", response); + + let fut = async move { Ok(reqwest::Response::from(response)) }; + let mut resources_table = webview.resources_table(); + let rid = resources_table.add_request(Box::pin(fut)); + Ok(rid) + } + _ => Err(Error::SchemeNotSupport(scheme.to_string())), + } +} + +#[command] +pub fn fetch_cancel(webview: Webview, rid: ResourceId) -> crate::Result<()> { + let mut resources_table = webview.resources_table(); + let req = resources_table.get::(rid)?; + let abort_tx = resources_table.take::(req.abort_tx_rid)?; + if let Some(abort_tx) = Arc::into_inner(abort_tx) { + abort_tx.abort(); + } + Ok(()) +} + +#[command] +pub async fn fetch_send( + webview: Webview, + rid: ResourceId, +) -> crate::Result { + let (req, abort_rx) = { + let mut resources_table = webview.resources_table(); + let req = resources_table.get::(rid)?; + let abort_rx = resources_table.take::(req.abort_rx_rid)?; + (req, abort_rx) + }; + + let Some(abort_rx) = Arc::into_inner(abort_rx) else { + return Err(Error::RequestCanceled); + }; + + let mut fut = req.fut.lock().await; + + let res = tokio::select! { + res = fut.as_mut() => res?, + _ = abort_rx.0 => { + let mut resources_table = webview.resources_table(); + resources_table.close(rid)?; + return Err(Error::RequestCanceled); + } + }; + + #[cfg(feature = "tracing")] + tracing::trace!("{:?}", res); + + let status = res.status(); + let url = res.url().to_string(); + let mut headers = Vec::new(); + for (key, val) in res.headers().iter() { + headers.push(( + key.as_str().into(), + String::from_utf8(val.as_bytes().to_vec())?, + )); + } + + let mut resources_table = webview.resources_table(); + let rid = resources_table.add(ReqwestResponse(res)); + + Ok(FetchResponse { + status: status.as_u16(), + status_text: status.canonical_reason().unwrap_or_default().to_string(), + headers, + url, + rid, + }) +} + +#[command] +pub async fn fetch_read_body( + webview: Webview, + rid: ResourceId, + stream_channel: Channel, +) -> crate::Result<()> { + let res = { + let mut resources_table = webview.resources_table(); + resources_table.take::(rid)? + }; + + let mut res = Arc::into_inner(res).unwrap().0; + + // send response through IPC channel + while let Some(chunk) = res.chunk().await? { + let mut chunk = chunk.to_vec(); + // append 0 to indicate we are not done yet + chunk.push(0); + stream_channel.send(tauri::ipc::InvokeResponseBody::Raw(chunk))?; + } + + // send 1 to indicate we are done + stream_channel.send(tauri::ipc::InvokeResponseBody::Raw(vec![1]))?; + + Ok(()) +} + +// forbidden headers per fetch spec https://fetch.spec.whatwg.org/#terminology-headers +#[cfg(not(feature = "unsafe-headers"))] +fn is_unsafe_header(header: &HeaderName) -> bool { + matches!( + *header, + header::ACCEPT_CHARSET + | header::ACCEPT_ENCODING + | header::ACCESS_CONTROL_REQUEST_HEADERS + | header::ACCESS_CONTROL_REQUEST_METHOD + | header::CONNECTION + | header::CONTENT_LENGTH + | header::COOKIE + | header::DATE + | header::DNT + | header::EXPECT + | header::HOST + | header::ORIGIN + | header::REFERER + | header::SET_COOKIE + | header::TE + | header::TRAILER + | header::TRANSFER_ENCODING + | header::UPGRADE + | header::VIA + ) || { + let lower = header.as_str().to_lowercase(); + lower.starts_with("proxy-") || lower.starts_with("sec-") + } +} diff --git a/crates/vendor/tauri-plugin-http/src/error.rs b/crates/vendor/tauri-plugin-http/src/error.rs new file mode 100644 index 00000000..ef8de0c5 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/src/error.rs @@ -0,0 +1,57 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +use serde::{Serialize, Serializer}; +use url::Url; + +#[derive(Debug, thiserror::Error)] +pub enum Error { + #[error(transparent)] + Json(#[from] serde_json::Error), + #[error(transparent)] + Io(#[from] std::io::Error), + #[error(transparent)] + Network(#[from] reqwest::Error), + #[error(transparent)] + Http(#[from] http::Error), + #[error(transparent)] + HttpInvalidHeaderName(#[from] http::header::InvalidHeaderName), + #[error(transparent)] + HttpInvalidHeaderValue(#[from] http::header::InvalidHeaderValue), + /// URL not allowed by the scope. + #[error("url not allowed on the configured scope: {0}")] + UrlNotAllowed(Url), + #[error(transparent)] + UrlParseError(#[from] url::ParseError), + /// HTTP method error. + #[error(transparent)] + HttpMethod(#[from] http::method::InvalidMethod), + #[error("scheme {0} not supported")] + SchemeNotSupport(String), + #[error("Request canceled")] + RequestCanceled, + #[error(transparent)] + FsError(#[from] tauri_plugin_fs::Error), + #[error("failed to process data url")] + DataUrlError, + #[error("failed to decode data url into bytes")] + DataUrlDecodeError, + #[error(transparent)] + Tauri(#[from] tauri::Error), + #[error(transparent)] + Utf8(#[from] std::string::FromUtf8Error), + #[error("dangerous settings used but are not enabled")] + DangerousSettings, +} + +impl Serialize for Error { + fn serialize(&self, serializer: S) -> std::result::Result + where + S: Serializer, + { + serializer.serialize_str(self.to_string().as_ref()) + } +} + +pub type Result = std::result::Result; diff --git a/crates/vendor/tauri-plugin-http/src/lib.rs b/crates/vendor/tauri-plugin-http/src/lib.rs new file mode 100644 index 00000000..1da8993f --- /dev/null +++ b/crates/vendor/tauri-plugin-http/src/lib.rs @@ -0,0 +1,96 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +//! Access the HTTP client written in Rust. + +pub use reqwest; +use tauri::{ + plugin::{Builder, TauriPlugin}, + Manager, Runtime, +}; + +pub use error::{Error, Result}; + +// NB(bt): We're making everything public so we can access it. +pub mod commands; +pub mod error; +#[cfg(feature = "cookies")] +pub mod reqwest_cookie_store; +pub mod scope; + +#[cfg(feature = "cookies")] +const COOKIES_FILENAME: &str = ".cookies"; + +// NB(bt): We've vendored in this library so we can poke at the cookie data store. +pub struct Http { + #[cfg(feature = "cookies")] + pub cookies_jar: std::sync::Arc, +} + +pub fn init() -> TauriPlugin { + Builder::::new("http") + .setup(|app, _| { + #[cfg(feature = "cookies")] + let cookies_jar = { + use crate::reqwest_cookie_store::*; + use std::fs::File; + use std::io::BufReader; + + let cache_dir = app.path().app_cache_dir()?; + std::fs::create_dir_all(&cache_dir)?; + + let path = cache_dir.join(COOKIES_FILENAME); + + // NB(bt): Let's always log this. + println!("Tauri plugin http: using cookie store at {}", path.display()); + + let file = File::options() + .create(true) + .append(true) + .read(true) + .open(&path)?; + + let reader = BufReader::new(file); + CookieStoreMutex::load(path.clone(), reader).unwrap_or_else(|_e| { + #[cfg(feature = "tracing")] + tracing::warn!( + "failed to load cookie store: {_e}, falling back to empty store" + ); + CookieStoreMutex::new(path, Default::default()) + }) + }; + + let state = Http { + #[cfg(feature = "cookies")] + cookies_jar: std::sync::Arc::new(cookies_jar), + }; + + app.manage(state); + + Ok(()) + }) + .on_event(|app, event| { + #[cfg(feature = "cookies")] + if let tauri::RunEvent::Exit = event { + let state = app.state::(); + + match state.cookies_jar.request_save() { + Ok(rx) => { + let _ = rx.recv(); + } + Err(_e) => { + #[cfg(feature = "tracing")] + tracing::error!("failed to save cookie jar: {_e}"); + } + } + } + }) + .invoke_handler(tauri::generate_handler![ + commands::fetch, + commands::fetch_cancel, + commands::fetch_send, + commands::fetch_read_body + ]) + .build() +} diff --git a/crates/vendor/tauri-plugin-http/src/reqwest_cookie_store.rs b/crates/vendor/tauri-plugin-http/src/reqwest_cookie_store.rs new file mode 100644 index 00000000..be4215ca --- /dev/null +++ b/crates/vendor/tauri-plugin-http/src/reqwest_cookie_store.rs @@ -0,0 +1,135 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +// taken from https://github.com/pfernie/reqwest_cookie_store/blob/2ec4afabcd55e24d3afe3f0626ee6dc97bed938d/src/lib.rs + +use std::{ + path::PathBuf, + sync::{mpsc::Receiver, Mutex}, +}; + +// NB(bt): Re-export these for reuse +pub use cookie_store::{CookieStore, RawCookie, RawCookieParseError}; +use reqwest::header::HeaderValue; + +fn set_cookies( + cookie_store: &mut CookieStore, + cookie_headers: &mut dyn Iterator, + url: &url::Url, +) { + let cookies = cookie_headers.filter_map(|val| { + std::str::from_utf8(val.as_bytes()) + .map_err(RawCookieParseError::from) + .and_then(RawCookie::parse) + .map(|c| c.into_owned()) + .ok() + }); + cookie_store.store_response_cookies(cookies, url); +} + +fn cookies(cookie_store: &CookieStore, url: &url::Url) -> Option { + let s = cookie_store + .get_request_values(url) + .map(|(name, value)| format!("{}={}", name, value)) + .collect::>() + .join("; "); + + if s.is_empty() { + return None; + } + + HeaderValue::from_maybe_shared(bytes::Bytes::from(s)).ok() +} + +/// A [`cookie_store::CookieStore`] wrapped internally by a [`std::sync::Mutex`], suitable for use in +/// async/concurrent contexts. +#[derive(Debug)] +pub struct CookieStoreMutex { + pub path: PathBuf, + // NB(bt): We've made both of these public so we can access them. + pub store: Mutex, + pub save_task: Mutex>, +} + +impl CookieStoreMutex { + /// Create a new [`CookieStoreMutex`] from an existing [`cookie_store::CookieStore`]. + pub fn new(path: PathBuf, cookie_store: CookieStore) -> CookieStoreMutex { + CookieStoreMutex { + path, + store: Mutex::new(cookie_store), + save_task: Default::default(), + } + } + + pub fn load( + path: PathBuf, + reader: R, + ) -> cookie_store::Result { + cookie_store::serde::load(reader, |c| serde_json::from_str(c)) + .map(|store| CookieStoreMutex::new(path, store)) + } + + fn cookies_to_str(&self) -> Result { + let mut cookies = Vec::new(); + for cookie in self + .store + .lock() + .expect("poisoned cookie jar mutex") + .iter_unexpired() + { + if cookie.is_persistent() { + cookies.push(cookie.clone()); + } + } + serde_json::to_string(&cookies) + } + + pub fn request_save(&self) -> cookie_store::Result> { + let cookie_str = self.cookies_to_str()?; + let path = self.path.clone(); + let (tx, rx) = std::sync::mpsc::channel(); + let task = tauri::async_runtime::spawn(async move { + match tokio::fs::write(&path, &cookie_str).await { + Ok(()) => { + let _ = tx.send(()); + } + Err(_e) => { + #[cfg(feature = "tracing")] + tracing::error!("failed to save cookie jar: {_e}"); + } + } + }); + self.save_task + .lock() + .unwrap() + .replace(CancellableTask(task)); + Ok(rx) + } +} + +impl reqwest::cookie::CookieStore for CookieStoreMutex { + fn set_cookies(&self, cookie_headers: &mut dyn Iterator, url: &url::Url) { + set_cookies(&mut self.store.lock().unwrap(), cookie_headers, url); + + // try to persist cookies immediately asynchronously + if let Err(_e) = self.request_save() { + #[cfg(feature = "tracing")] + tracing::error!("failed to save cookie jar: {_e}"); + } + } + + fn cookies(&self, url: &url::Url) -> Option { + let store = self.store.lock().unwrap(); + cookies(&store, url) + } +} + +#[derive(Debug)] +struct CancellableTask(tauri::async_runtime::JoinHandle<()>); + +impl Drop for CancellableTask { + fn drop(&mut self) { + self.0.abort(); + } +} diff --git a/crates/vendor/tauri-plugin-http/src/scope.rs b/crates/vendor/tauri-plugin-http/src/scope.rs new file mode 100644 index 00000000..2123f215 --- /dev/null +++ b/crates/vendor/tauri-plugin-http/src/scope.rs @@ -0,0 +1,231 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +use std::sync::Arc; + +use serde::{Deserialize, Deserializer}; +use url::Url; +use urlpattern::{UrlPattern, UrlPatternMatchInput}; + +#[allow(rustdoc::bare_urls)] +#[derive(Debug)] +pub struct Entry { + pub url: UrlPattern, +} + +fn parse_url_pattern(s: &str) -> Result { + let mut init = urlpattern::UrlPatternInit::parse_constructor_string::(s, None)?; + if init.search.as_ref().map(|p| p.is_empty()).unwrap_or(true) { + init.search.replace("*".to_string()); + } + if init.hash.as_ref().map(|p| p.is_empty()).unwrap_or(true) { + init.hash.replace("*".to_string()); + } + if init + .pathname + .as_ref() + .map(|p| p.is_empty() || p == "/") + .unwrap_or(true) + { + init.pathname.replace("*".to_string()); + } + UrlPattern::parse(init, Default::default()) +} + +#[derive(Deserialize)] +#[serde(untagged)] +pub(crate) enum EntryRaw { + Value(String), + Object { url: String }, +} + +impl<'de> Deserialize<'de> for Entry { + fn deserialize(deserializer: D) -> std::result::Result + where + D: Deserializer<'de>, + { + EntryRaw::deserialize(deserializer).and_then(|raw| { + let url = match raw { + EntryRaw::Value(url) => url, + EntryRaw::Object { url } => url, + }; + Ok(Entry { + url: parse_url_pattern(&url).map_err(|e| { + serde::de::Error::custom(format!("`{}` is not a valid URL pattern: {e}", url)) + })?, + }) + }) + } +} + +/// Scope for filesystem access. +#[derive(Debug)] +pub struct Scope<'a> { + allowed: Vec<&'a Arc>, + denied: Vec<&'a Arc>, +} + +impl<'a> Scope<'a> { + /// Creates a new scope from the scope configuration. + pub(crate) fn new(allowed: Vec<&'a Arc>, denied: Vec<&'a Arc>) -> Self { + Self { allowed, denied } + } + + /// Determines if the given URL is allowed on this scope. + pub fn is_allowed(&self, url: &Url) -> bool { + let denied = self.denied.iter().any(|entry| { + entry + .url + .test(UrlPatternMatchInput::Url(url.clone())) + .unwrap_or_default() + }); + if denied { + false + } else { + self.allowed.iter().any(|entry| { + entry + .url + .test(UrlPatternMatchInput::Url(url.clone())) + .unwrap_or_default() + }) + } + } +} + +#[cfg(test)] +mod tests { + use std::{str::FromStr, sync::Arc}; + + use super::Entry; + + impl FromStr for Entry { + type Err = urlpattern::quirks::Error; + + fn from_str(s: &str) -> Result { + let pattern = super::parse_url_pattern(s)?; + Ok(Self { url: pattern }) + } + } + + #[test] + fn denied_takes_precedence() { + let allow = Arc::new("http://localhost:8080/file.png".parse().unwrap()); + let deny = Arc::new("http://localhost:8080/*".parse().unwrap()); + let scope = super::Scope::new(vec![&allow], vec![&deny]); + assert!(!scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap())); + assert!(!scope.is_allowed(&"http://localhost:8080?framework=tauri".parse().unwrap())); + } + + #[test] + fn fixed_url() { + // plain URL + let entry = Arc::new("http://localhost:8080".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + assert!(scope.is_allowed(&"http://localhost:8080".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/file".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/path/to/asset.png".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/path/list?limit=50".parse().unwrap())); + + assert!(!scope.is_allowed(&"https://localhost:8080".parse().unwrap())); + assert!(!scope.is_allowed(&"http://localhost:8081".parse().unwrap())); + assert!(!scope.is_allowed(&"http://local:8080".parse().unwrap())); + } + + #[test] + fn fixed_path() { + // URL with fixed path + let entry = Arc::new("http://localhost:8080/file.png".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/file.png?q=1".parse().unwrap())); + + assert!(!scope.is_allowed(&"http://localhost:8080".parse().unwrap())); + assert!(!scope.is_allowed(&"http://localhost:8080/file".parse().unwrap())); + assert!(!scope.is_allowed(&"http://localhost:8080/file.png/other.jpg".parse().unwrap())); + } + + #[test] + fn pattern_wildcard() { + let entry = Arc::new("http://localhost:8080/*.png".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/file.png#head".parse().unwrap())); + assert!(scope.is_allowed(&"http://localhost:8080/assets/file.png".parse().unwrap())); + assert!(scope.is_allowed( + &"http://localhost:8080/assets/file.png?width=100&height=200" + .parse() + .unwrap() + )); + + assert!(!scope.is_allowed(&"http://localhost:8080/file.jpeg".parse().unwrap())); + } + + #[test] + fn domain_wildcard() { + let entry = Arc::new("http://*".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"http://something.else".parse().unwrap())); + assert!(scope.is_allowed(&"http://something.else#tauri".parse().unwrap())); + assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap())); + assert!(scope.is_allowed(&"http://something.else?rel=tauri".parse().unwrap())); + assert!(scope.is_allowed( + &"http://something.else/path/to/file.mp4?start=500" + .parse() + .unwrap() + )); + + assert!(!scope.is_allowed(&"https://something.else".parse().unwrap())); + + let entry = Arc::new("http://*/*".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"http://something.else".parse().unwrap())); + assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap())); + } + + #[test] + fn scheme_wildcard() { + let entry = Arc::new("*://*".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"http://something.else".parse().unwrap())); + assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap())); + assert!(scope.is_allowed(&"file://path".parse().unwrap())); + assert!(scope.is_allowed(&"file://path/to/file".parse().unwrap())); + assert!(scope.is_allowed(&"https://something.else".parse().unwrap())); + assert!(scope.is_allowed(&"https://something.else?x=1#frag".parse().unwrap())); + + let entry = Arc::new("*://*/*".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"http://something.else".parse().unwrap())); + assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap())); + assert!(scope.is_allowed(&"file://path/to/file".parse().unwrap())); + assert!(scope.is_allowed(&"https://something.else".parse().unwrap())); + } + + #[test] + fn validate_query() { + let entry = Arc::new("https://tauri.app/path?x=*".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"https://tauri.app/path?x=5".parse().unwrap())); + + assert!(!scope.is_allowed(&"https://tauri.app/path?y=5".parse().unwrap())); + } + + #[test] + fn validate_hash() { + let entry = Arc::new("https://tauri.app/path#frame*".parse().unwrap()); + let scope = super::Scope::new(vec![&entry], Vec::new()); + + assert!(scope.is_allowed(&"https://tauri.app/path#frame".parse().unwrap())); + + assert!(!scope.is_allowed(&"https://tauri.app/path#work".parse().unwrap())); + } +} diff --git a/crates/vendor/tauri-plugin-http/tsconfig.json b/crates/vendor/tauri-plugin-http/tsconfig.json new file mode 100644 index 00000000..5098169a --- /dev/null +++ b/crates/vendor/tauri-plugin-http/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig.base.json", + "include": ["guest-js/*.ts"] +} diff --git a/crates/workspace-build-acceleration/.gitattributes b/crates/workspace-build-acceleration/.gitattributes new file mode 100644 index 00000000..3e9dba4b --- /dev/null +++ b/crates/workspace-build-acceleration/.gitattributes @@ -0,0 +1,4 @@ +# Avoid putting conflict markers in the generated Cargo.toml file, since their presence breaks +# Cargo. +# Also do not check out the file as CRLF on Windows, as that's what hakari needs. +Cargo.toml merge=binary -crlf diff --git a/crates/workspace-build-acceleration/Cargo.toml b/crates/workspace-build-acceleration/Cargo.toml new file mode 100644 index 00000000..3354d582 --- /dev/null +++ b/crates/workspace-build-acceleration/Cargo.toml @@ -0,0 +1,20 @@ +# This file is generated by `cargo hakari`. +# To regenerate, run: +# cargo hakari generate + +[package] +name = "workspace-build-acceleration" +edition = "2018" +version = "0.1.0" +description = "workspace-hack package, managed by hakari" +# You can choose to publish this crate: see https://docs.rs/cargo-hakari/latest/cargo_hakari/publishing. +publish = false + +# The parts of the file between the BEGIN HAKARI SECTION and END HAKARI SECTION comments +# are managed by hakari. +# +# NB(artcraftx): Hakari is currently disabled in this pared-down workspace. +# Re-run `cargo hakari generate` if/when we want the build acceleration back. + +### BEGIN HAKARI SECTION +### END HAKARI SECTION diff --git a/crates/workspace-build-acceleration/build.rs b/crates/workspace-build-acceleration/build.rs new file mode 100644 index 00000000..92518ef0 --- /dev/null +++ b/crates/workspace-build-acceleration/build.rs @@ -0,0 +1,2 @@ +// A build script is required for cargo to consider build dependencies. +fn main() {} diff --git a/crates/workspace-build-acceleration/src/lib.rs b/crates/workspace-build-acceleration/src/lib.rs new file mode 100644 index 00000000..22489f63 --- /dev/null +++ b/crates/workspace-build-acceleration/src/lib.rs @@ -0,0 +1 @@ +// This is a stub lib.rs. diff --git a/frontend/.editorconfig b/frontend/.editorconfig new file mode 100644 index 00000000..6e87a003 --- /dev/null +++ b/frontend/.editorconfig @@ -0,0 +1,13 @@ +# Editor configuration, see http://editorconfig.org +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 2 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +max_line_length = off +trim_trailing_whitespace = false diff --git a/frontend/.eslintignore b/frontend/.eslintignore new file mode 100644 index 00000000..3c3629e6 --- /dev/null +++ b/frontend/.eslintignore @@ -0,0 +1 @@ +node_modules diff --git a/frontend/.eslintrc.json b/frontend/.eslintrc.json new file mode 100644 index 00000000..c21b3ce9 --- /dev/null +++ b/frontend/.eslintrc.json @@ -0,0 +1,56 @@ +{ + "root": true, + "ignorePatterns": [ + "**/*" + ], + "plugins": [ + "@nx" + ], + "overrides": [ + { + "files": [ + "*.ts", + "*.tsx", + "*.js", + "*.jsx" + ], + "rules": { + "@nx/enforce-module-boundaries": [ + "error", + { + "enforceBuildableLibDependency": true, + "allow": [], + "depConstraints": [ + { + "sourceTag": "*", + "onlyDependOnLibsWithTags": [ + "*" + ] + } + ] + } + ] + } + }, + { + "files": [ + "*.ts", + "*.tsx" + ], + "extends": [ + "plugin:@nx/typescript" + ], + "rules": {} + }, + { + "files": [ + "*.js", + "*.jsx" + ], + "extends": [ + "plugin:@nx/javascript" + ], + "rules": {} + } + ] +} diff --git a/frontend/.gitignore b/frontend/.gitignore new file mode 100644 index 00000000..cbe39ccc --- /dev/null +++ b/frontend/.gitignore @@ -0,0 +1,52 @@ +# See https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files for more about ignoring files. + +# compiled output +dist +tmp +out-tsc +*.tsbuildinfo + +# dependencies +node_modules + +# IDEs and editors +/.idea +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace + +# IDE - VSCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +# misc +/.sass-cache +/connect.lock +/coverage +/libpeerconnection.log +npm-debug.log +yarn-error.log +testem.log +/typings + +# System Files +.DS_Store +Thumbs.db + +.nx/cache +.nx/workspace-data + +vite.config.*.timestamp* +vitest.config.*.timestamp* +.cursor/rules/nx-rules.mdc +.github/instructions/nx.instructions.md + +# Environment files +.env.local +.env*.local diff --git a/frontend/.nxignore b/frontend/.nxignore new file mode 100644 index 00000000..9b6ca4c7 --- /dev/null +++ b/frontend/.nxignore @@ -0,0 +1,8 @@ +# The admin dashboard is intentionally isolated from the Nx/npm workspace. +# +# It pins its own incompatible toolchain (React 19, Vite 7, Tailwind 4) and +# installs with pnpm into its own node_modules. Nx must NOT infer it as a +# project — otherwise `nx run-many`/`nx affected` would try to build it with the +# workspace's React 18 toolchain and root node_modules. It builds standalone +# (see apps/artcraft-dashboard/netlify.toml). +apps/artcraft-dashboard diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 00000000..cd38d0d3 --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,118 @@ +# Frontend + +This is an `nx` monorepo that can contain multiple apps and shared libraries. + +All commands to run these projects are performed from _this_ directory +(except the repo-root launcher scripts noted below). + +## Requirements + +- **Node.js 20+** (Nx 21 / Vite 6 requirement). Install via [nvm](https://github.com/nvm-sh/nvm), + [nodejs.org](https://nodejs.org), or `brew install node`. +- **npm** (ships with Node). + +> **We use npm, not pnpm.** pnpm was briefly adopted ("add pnpm to solve build +> issues") and later removed ("fix(frontend): consume video-editor libs via nx +> path aliases, drop pnpm"). If you have leftovers from that era — a +> `pnpm-lock.yaml`, `pnpm-workspace.yaml`, or a `node_modules/.pnpm` directory — +> npm installs will fail (typically with `ENOTEMPTY` rename errors). See +> Troubleshooting below. + +## Install dependencies + +``` +npm install +``` + +## Running the apps in dev mode + +From the **repository root**, the launcher scripts (these preflight your +environment, install dependencies, and free the dev port first): + +```bash +./script/website/unix_frontend_dev.sh # artcraft-website (marketing site), port 4200 +./script/website/unix_frontend_webapp_dev.sh # artcraft-webapp (user dashboard), port 4201 +./script/artcraft/unix_frontend_dev.sh # artcraft (Tauri app frontend), port 5173 +``` + +Or directly from this directory: + +```bash +nx dev artcraft-website +nx dev artcraft-webapp +nx dev artcraft # NB: the Tauri app also needs the Rust dev server running +nx dev editor2d +``` + +## Building + +```bash +npx nx build artcraft-website +npx nx build artcraft-webapp +npx nx build artcraft +npx nx build editor2d +``` + +Netlify deploys run `apps//script/netlify_build.sh` (see each app's +`netlify.toml`). + +## Troubleshooting + +### `npm install` fails with `ENOTEMPTY: directory not empty, rename ...` + +Your `node_modules` tree is corrupted — usually an interrupted install, or a +tree written by pnpm back when the repo briefly used it. Fix: + +```bash +./clean_modules.sh +npm install +``` + +Or the manual minimum: + +```bash +rm -rf node_modules .nx pnpm-lock.yaml pnpm-workspace.yaml +npm install +``` + +### Stale build state after switching branches + +Call this when starting on main or a new branch: + +```bash +./clean_modules.sh +``` + +It removes all `dist/` outputs, resets the nx cache, and removes +`node_modules`. + +## Import aliases + +The names for `@frontend` and `@storyteller` come from the `package.json` file +in the libs folder: + +```ts +import { Login } from "@frontend/login"; +import { api } from "@storyteller/api"; +``` + +For shared UI components, import from `@storyteller/ui-[componentname]`: + +```ts +import { Button } from "@storyteller/ui-button"; +import { Modal } from "@storyteller/ui-modal"; +``` + +## Generating a new component library + +```bash +# 1. Generate the library +npx nx g @nx/react:library libs/components/toaster --import-path=@storyteller/ui-toaster --bundler=vite +npm install + +# 2. Import it somewhere in code + +# 3. Sync and build +nx sync +nx build +``` diff --git a/frontend/apps/artcraft/.env-local-proxy b/frontend/apps/artcraft/.env-local-proxy new file mode 100644 index 00000000..63669068 --- /dev/null +++ b/frontend/apps/artcraft/.env-local-proxy @@ -0,0 +1,9 @@ +BASE_API="http://localhost:3000" +GOOGLE_API="http://localhost:3000/google" +FUNNEL_API="http://localhost:3000/funnel" +CDN_API="http://localhost:3000/cdn" +GRAVATAR_API="https://www.gravatar.com" +DEPLOY_PRIME_URL="http://localhost:5173" +REACT_APP_PUBLIC_POSTHOG_KEY="phc_jBFgac0mVALAFk3negnSfYCcHgvkT00yBLQDmCDYNBb" +REACT_APP_PUBLIC_POSTHOG_UI="https://us.i.posthog.com" +CONTEXT="DEVELOPMENT" \ No newline at end of file diff --git a/frontend/apps/artcraft/.env-no-proxy b/frontend/apps/artcraft/.env-no-proxy new file mode 100644 index 00000000..466e082f --- /dev/null +++ b/frontend/apps/artcraft/.env-no-proxy @@ -0,0 +1,9 @@ +BASE_API="https://localhost:12345" +GOOGLE_API="https://storage.googleapis.com" +FUNNEL_API="https://style.storyteller.ai" +CDN_API="https://cdn.storyteller.ai" +GRAVATAR_API="https://www.gravatar.com" +DEPLOY_PRIME_URL="https://studio.storyteller.ai" +REACT_APP_PUBLIC_POSTHOG_KEY="phc_jBFgac0mVALAFk3negnSfYCcHgvkT00yBLQDmCDYNBb" +REACT_APP_PUBLIC_POSTHOG_UI="https://us.i.posthog.com" +CONTEXT="DEVELOPMENT" \ No newline at end of file diff --git a/frontend/apps/artcraft/.eslintrc.cjs b/frontend/apps/artcraft/.eslintrc.cjs new file mode 100644 index 00000000..b96f4b98 --- /dev/null +++ b/frontend/apps/artcraft/.eslintrc.cjs @@ -0,0 +1,95 @@ +/** + * This is intended to be a basic starting point for linting in your app. + * It relies on recommended configs out of the box for simplicity, but you can + * and should modify this configuration to best suit your team's needs. + */ +const SEVERITY = { + OFF: 0, + WARN: 1, + ERROR: 2, +}; + +/** @type {import('eslint').Linter.Config} */ +module.exports = { + root: true, + parserOptions: { + ecmaVersion: "latest", + sourceType: "module", + ecmaFeatures: { + jsx: true, + }, + }, + env: { + browser: true, + commonjs: true, + es6: true, + }, + + // Base config + extends: ["eslint:recommended"], + + overrides: [ + // React + { + files: ["**/*.{js,jsx,ts,tsx}"], + plugins: ["react", "jsx-a11y"], + extends: [ + "plugin:react/recommended", + "plugin:react/jsx-runtime", + "plugin:react-hooks/recommended", + "plugin:jsx-a11y/recommended", + ], + settings: { + react: { + version: "detect", + }, + formComponents: ["Form"], + linkComponents: [ + { name: "Link", linkAttribute: "to" }, + { name: "NavLink", linkAttribute: "to" }, + ], + "import/resolver": { + typescript: {}, + }, + }, + rules: { + // we are incapable to provide support for blind people atm + "jsx-a11y/click-events-have-key-events": SEVERITY.OFF, + "jsx-a11y/no-static-element-interactions": SEVERITY.OFF, + "jsx-a11y/media-has-caption": SEVERITY.OFF, + "jsx-a11y/no-autofocus": SEVERITY.OFF, + }, + }, + + // Typescript + { + files: ["**/*.{ts,tsx}"], + plugins: ["@typescript-eslint", "import"], + parser: "@typescript-eslint/parser", + settings: { + "import/internal-regex": "^~/", + "import/resolver": { + node: { + extensions: [".ts", ".tsx"], + }, + typescript: { + alwaysTryTypes: true, + }, + }, + }, + extends: [ + "plugin:@typescript-eslint/recommended", + "plugin:import/recommended", + "plugin:import/typescript", + ], + }, + + // Node + { + files: [".eslintrc.js"], + env: { + node: true, + }, + }, + ], +}; diff --git a/frontend/apps/artcraft/.github/workflows/sync-studio-staging-branch.yml b/frontend/apps/artcraft/.github/workflows/sync-studio-staging-branch.yml new file mode 100644 index 00000000..4bc7a27f --- /dev/null +++ b/frontend/apps/artcraft/.github/workflows/sync-studio-staging-branch.yml @@ -0,0 +1,33 @@ +# This action syncs "studio-staging" with "main" by force pushing every time it is run. +# Adapted from: +# https://github.community/t/user-github-pages-site-auto-deploy-from-another-branch-on-push/17912/2 +on: + push: + branches: + - main + +jobs: + sync_studio_staging_branch: + runs-on: [ubuntu-latest] + steps: + - name: checkout main branch + uses: actions/checkout@v2 + with: + persist-credentials: false + - name: sync main to studio-staging + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git checkout -b studio-staging + - name: push changes + uses: ad-m/github-push-action@0fafdd62b84042d49ec0cb92d9cac7f7ce4ec79e + with: + # Note: Github does not allow the default access token to push to + # protected branches. Using a PAT with permissions can bypass this, + # but it triggers recursive Github Actions calls on branch updates + # (which the default access token does not). Ultimately, it's better + # to leave the studio-staging branch unprotected. + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: studio-staging + force: true + diff --git a/frontend/apps/artcraft/.gitignore b/frontend/apps/artcraft/.gitignore new file mode 100644 index 00000000..1d7b8398 --- /dev/null +++ b/frontend/apps/artcraft/.gitignore @@ -0,0 +1,30 @@ +.env +.eslintcache +.vite +.notes +node_modules +/~/ +proxy/~/ +/.cache +/public/build +/build +/backup +.idea +$ + +# VS Code Setting +.vscode + +# Local Netlify folder +.netlify +# Mac +.DS_Store + +# Assets to ignore +public/resources/movie/Big_Buck_Bunny_180_10s.webm +public/resources/models/room/room_with_girl.glb + +*storybook.log + +# VIM +*~ diff --git a/frontend/apps/artcraft/.prettierrc b/frontend/apps/artcraft/.prettierrc new file mode 100644 index 00000000..7ff0eaa3 --- /dev/null +++ b/frontend/apps/artcraft/.prettierrc @@ -0,0 +1,11 @@ +{ + "plugins": ["prettier-plugin-tailwindcss"], + "semi": true, + "singleQuote": false, + "trailingComma": "all", + "bracketSpacing": true, + "bracketSameLine": false, + "arrowParens": "always", + "useTabs": false, + "tabWidth": 2 +} diff --git a/frontend/apps/artcraft/README.md b/frontend/apps/artcraft/README.md new file mode 100644 index 00000000..f341c53f --- /dev/null +++ b/frontend/apps/artcraft/README.md @@ -0,0 +1,130 @@ +# Storyteller GGF + +## Coding Rules and Styles + +``` +Short Style Guide TS React and Engine: + +No use of lets + +No basic for loop operators. +Use the collection operators and array operators. + +React Side / No modules over 200 lines. ( loose rule ) + +Don't do: +if (condition) return; + +Do: +if (condition) { + return; +} + +No use of any type. +If you can use chat gpt to create the interface. +``` + +## Branches + +- `main` - The main branch is the production source of truth. + + Changes to main will automatically build, but will not auto-deploy to production. You'll have to promote changes to production using the Netlify control panel. + + Merge your code to main frequently. If you have to have a long-lived set of changes, ask yourself whether it might be better to feature flag your code off and + land it to main rather than fight rebasing against the whole team. + +- `studio-staging` - The staging auto-deploy branch. + + You do not ever need to interact with this branch. Changes to `main` will automatically be pushed to `studio-staging` and auto-deployed to + https://studio-staging.studio.storyteller.ai . You can test changes that have landed in `main` here before promoting them to production. + +- `studio-testing` - The testing branch. + +Anyone can push their changes to this branch for testing in a production-like environment. Since it is built and hosted on https://studio-testing.studio.storyteller.ai , +you won't face CORS issues, same-site cookie issues, or have to use a local development proxy. (This doesn't obviate the need for a development +proxy for fast development iteration, but is a fantastic way to test your changes in a "production-like" environment.) + +Force push to this branch by using `git push -f origin studio-testing` + +## API Docs + +Server API docs live here: https://storyteller-docs.netlify.app/ + +## Local Testing & Development + +### Apple Silicon package installation issues + +Installation of some dependencies via npm may fail on M-series macs (like node-canvas) and may require additional setup including python3 and some brew dependencies: + +``` +brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman python-setuptools +``` + +### Set up `.env` and the Proxy Server + +Copy & paste the env settings from `.env-local-proxy` to `.env`, (if the file `.env` do not exist, simply create one at the root of this project's folder beside the other env settings files). + +The settings from `.env-local-proxy` directs all requests to `localhost:3000`, this will relieve us from having to deal with CORS between various services. + +Then, start the proxy server in the folder `/proxy`. Before running the proxy for the first time, run: + +``` +npm i +``` + +To start the proxy run: + +``` +npm run dev +``` + +If the proxy fails, make sure your node version is 18.18. If you need to change the node version +run `npm rebuild` once before re-running `npm run dev` + +### Run the Code Locally + +To setup and run this project's code locally: + +``` +npm install +npm run dev +``` + +## PostHog + +PostHog is installed and working. To create a feature flag go to https://us.posthog.com/project/75284/feature_flags +Add the feature flag for all users. + +To check the feature flag in the app use code similar to this + +```ts +import { usePosthogFeatureFlag } from "~/hooks/usePosthogFeatureflag"; +import { FeatureFlags } from "~/enums"; + +const Component = () => { + const flag = usePosthogFeatureFlag(FeaturesFlags.FLAG_NAME); + // if flag is true, the feature shoud be executed & showed; + // if flag is false, the feature should be disabled & hid; + // for example + return( + <> + {flag && } + + ); +}; +``` + +## Other Documentation + +Here is the Swagger documentation for the backend endpoints + +- https://storyteller-docs.netlify.app/ + +This project uses Remix for routing and Tailwind for styling: + +- [Remix Docs](https://remix.run/docs) +- [Tailwind Docs](https://tailwindcss.com/docs) + +On Netlify, we use functions: + +- [Netlify Functions Overview](https://docs.netlify.com/functions/overview) diff --git a/frontend/apps/artcraft/_headers b/frontend/apps/artcraft/_headers new file mode 100644 index 00000000..e69de29b diff --git a/frontend/apps/artcraft/app/index.html b/frontend/apps/artcraft/app/index.html new file mode 100644 index 00000000..dd12a228 --- /dev/null +++ b/frontend/apps/artcraft/app/index.html @@ -0,0 +1,41 @@ + + + + + ArtCraft + + + + + + + + + + + + + + + + + + + + +
+ + + + diff --git a/frontend/apps/artcraft/app/public/favicon.ico b/frontend/apps/artcraft/app/public/favicon.ico new file mode 100644 index 00000000..df243d83 Binary files /dev/null and b/frontend/apps/artcraft/app/public/favicon.ico differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/0.webp b/frontend/apps/artcraft/app/public/resources/avatars/0.webp new file mode 100644 index 00000000..f95afe03 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/0.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/1.webp b/frontend/apps/artcraft/app/public/resources/avatars/1.webp new file mode 100644 index 00000000..6acf0da5 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/1.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/10.webp b/frontend/apps/artcraft/app/public/resources/avatars/10.webp new file mode 100644 index 00000000..f6fd4df8 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/10.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/11.webp b/frontend/apps/artcraft/app/public/resources/avatars/11.webp new file mode 100644 index 00000000..c14bcebd Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/11.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/12.webp b/frontend/apps/artcraft/app/public/resources/avatars/12.webp new file mode 100644 index 00000000..0078476c Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/12.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/13.webp b/frontend/apps/artcraft/app/public/resources/avatars/13.webp new file mode 100644 index 00000000..e8b1635f Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/13.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/14.webp b/frontend/apps/artcraft/app/public/resources/avatars/14.webp new file mode 100644 index 00000000..fd532381 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/14.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/15.webp b/frontend/apps/artcraft/app/public/resources/avatars/15.webp new file mode 100644 index 00000000..c61aea6d Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/15.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/16.webp b/frontend/apps/artcraft/app/public/resources/avatars/16.webp new file mode 100644 index 00000000..f112d25d Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/16.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/17.webp b/frontend/apps/artcraft/app/public/resources/avatars/17.webp new file mode 100644 index 00000000..f7ab7660 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/17.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/18.webp b/frontend/apps/artcraft/app/public/resources/avatars/18.webp new file mode 100644 index 00000000..fa3fc2f0 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/18.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/19.webp b/frontend/apps/artcraft/app/public/resources/avatars/19.webp new file mode 100644 index 00000000..0207cd88 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/19.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/2.webp b/frontend/apps/artcraft/app/public/resources/avatars/2.webp new file mode 100644 index 00000000..03777b78 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/2.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/20.webp b/frontend/apps/artcraft/app/public/resources/avatars/20.webp new file mode 100644 index 00000000..367f4115 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/20.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/21.webp b/frontend/apps/artcraft/app/public/resources/avatars/21.webp new file mode 100644 index 00000000..e6eeb4d1 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/21.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/22.webp b/frontend/apps/artcraft/app/public/resources/avatars/22.webp new file mode 100644 index 00000000..f8c0ffca Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/22.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/23.webp b/frontend/apps/artcraft/app/public/resources/avatars/23.webp new file mode 100644 index 00000000..15137375 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/23.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/24.webp b/frontend/apps/artcraft/app/public/resources/avatars/24.webp new file mode 100644 index 00000000..4e925a9e Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/24.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/3.webp b/frontend/apps/artcraft/app/public/resources/avatars/3.webp new file mode 100644 index 00000000..ccb44b0a Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/3.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/4.webp b/frontend/apps/artcraft/app/public/resources/avatars/4.webp new file mode 100644 index 00000000..421877e2 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/4.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/5.webp b/frontend/apps/artcraft/app/public/resources/avatars/5.webp new file mode 100644 index 00000000..2b4db489 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/5.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/6.webp b/frontend/apps/artcraft/app/public/resources/avatars/6.webp new file mode 100644 index 00000000..dc8e5a2d Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/6.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/7.webp b/frontend/apps/artcraft/app/public/resources/avatars/7.webp new file mode 100644 index 00000000..d711281f Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/7.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/8.webp b/frontend/apps/artcraft/app/public/resources/avatars/8.webp new file mode 100644 index 00000000..a71c77e6 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/8.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/avatars/9.webp b/frontend/apps/artcraft/app/public/resources/avatars/9.webp new file mode 100644 index 00000000..bf72a412 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/avatars/9.webp differ diff --git a/frontend/apps/artcraft/app/public/resources/gifs/artcraft-logo-load.gif b/frontend/apps/artcraft/app/public/resources/gifs/artcraft-logo-load.gif new file mode 100644 index 00000000..6d5e2bca Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/gifs/artcraft-logo-load.gif differ diff --git a/frontend/apps/artcraft/app/public/resources/images/services/alibaba.svg b/frontend/apps/artcraft/app/public/resources/images/services/alibaba.svg new file mode 100644 index 00000000..a4bb382a --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/alibaba.svg @@ -0,0 +1 @@ +Qwen \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/artcraft.svg b/frontend/apps/artcraft/app/public/resources/images/services/artcraft.svg new file mode 100644 index 00000000..3fefcd11 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/artcraft.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/blackforestlabs.svg b/frontend/apps/artcraft/app/public/resources/images/services/blackforestlabs.svg new file mode 100644 index 00000000..12a4ba1d --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/blackforestlabs.svg @@ -0,0 +1 @@ +Flux \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/bytedance.svg b/frontend/apps/artcraft/app/public/resources/images/services/bytedance.svg new file mode 100644 index 00000000..dec27435 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/bytedance.svg @@ -0,0 +1 @@ +ByteDance \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/fal.svg b/frontend/apps/artcraft/app/public/resources/images/services/fal.svg new file mode 100644 index 00000000..c41076f9 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/fal.svg @@ -0,0 +1 @@ +Fal \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/generic.svg b/frontend/apps/artcraft/app/public/resources/images/services/generic.svg new file mode 100644 index 00000000..90ecd722 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/generic.svg @@ -0,0 +1 @@ + diff --git a/frontend/apps/artcraft/app/public/resources/images/services/google.svg b/frontend/apps/artcraft/app/public/resources/images/services/google.svg new file mode 100644 index 00000000..87736bbe --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/google.svg @@ -0,0 +1 @@ +Gemini \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/grok.svg b/frontend/apps/artcraft/app/public/resources/images/services/grok.svg new file mode 100644 index 00000000..efb1a618 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/grok.svg @@ -0,0 +1 @@ +Grok \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/higgsfield.svg b/frontend/apps/artcraft/app/public/resources/images/services/higgsfield.svg new file mode 100644 index 00000000..de897848 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/higgsfield.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/hyper3d.svg b/frontend/apps/artcraft/app/public/resources/images/services/hyper3d.svg new file mode 100644 index 00000000..aa99495e --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/hyper3d.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/kling.svg b/frontend/apps/artcraft/app/public/resources/images/services/kling.svg new file mode 100644 index 00000000..32fb6bed --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/kling.svg @@ -0,0 +1 @@ +Kling \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/krea.svg b/frontend/apps/artcraft/app/public/resources/images/services/krea.svg new file mode 100644 index 00000000..d112dc3e --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/krea.svg @@ -0,0 +1,14 @@ + + + + + + + + + + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/magnific.svg b/frontend/apps/artcraft/app/public/resources/images/services/magnific.svg new file mode 100644 index 00000000..85f9ab3a --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/magnific.svg @@ -0,0 +1 @@ +Magnific diff --git a/frontend/apps/artcraft/app/public/resources/images/services/meshy.svg b/frontend/apps/artcraft/app/public/resources/images/services/meshy.svg new file mode 100644 index 00000000..da77f22e --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/meshy.svg @@ -0,0 +1 @@ +Meshy \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/midjourney.svg b/frontend/apps/artcraft/app/public/resources/images/services/midjourney.svg new file mode 100644 index 00000000..e59e3b07 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/midjourney.svg @@ -0,0 +1 @@ +Midjourney \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/openai.svg b/frontend/apps/artcraft/app/public/resources/images/services/openai.svg new file mode 100644 index 00000000..50d94d6c --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/openai.svg @@ -0,0 +1 @@ +OpenAI \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/openart.svg b/frontend/apps/artcraft/app/public/resources/images/services/openart.svg new file mode 100644 index 00000000..f47a86e8 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/openart.svg @@ -0,0 +1,11 @@ + + + + + + + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/recraft.svg b/frontend/apps/artcraft/app/public/resources/images/services/recraft.svg new file mode 100644 index 00000000..b4ea390a --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/recraft.svg @@ -0,0 +1 @@ +Recraft \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/replicate.svg b/frontend/apps/artcraft/app/public/resources/images/services/replicate.svg new file mode 100644 index 00000000..48f148af --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/replicate.svg @@ -0,0 +1 @@ +Replicate \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/runway.svg b/frontend/apps/artcraft/app/public/resources/images/services/runway.svg new file mode 100644 index 00000000..a7017ac2 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/runway.svg @@ -0,0 +1 @@ +Runway diff --git a/frontend/apps/artcraft/app/public/resources/images/services/suno.svg b/frontend/apps/artcraft/app/public/resources/images/services/suno.svg new file mode 100644 index 00000000..7aceb6d5 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/suno.svg @@ -0,0 +1 @@ +Suno diff --git a/frontend/apps/artcraft/app/public/resources/images/services/tencent.svg b/frontend/apps/artcraft/app/public/resources/images/services/tencent.svg new file mode 100644 index 00000000..724a8150 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/tencent.svg @@ -0,0 +1 @@ +Hunyuan \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/tensorart.svg b/frontend/apps/artcraft/app/public/resources/images/services/tensorart.svg new file mode 100644 index 00000000..d7e32012 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/tensorart.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/tripo.svg b/frontend/apps/artcraft/app/public/resources/images/services/tripo.svg new file mode 100644 index 00000000..40f4c371 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/tripo.svg @@ -0,0 +1 @@ +Tripo \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/vidu.svg b/frontend/apps/artcraft/app/public/resources/images/services/vidu.svg new file mode 100644 index 00000000..0cb11823 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/vidu.svg @@ -0,0 +1 @@ +Vidu \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/images/services/worldlabs.svg b/frontend/apps/artcraft/app/public/resources/images/services/worldlabs.svg new file mode 100644 index 00000000..795cf7d0 --- /dev/null +++ b/frontend/apps/artcraft/app/public/resources/images/services/worldlabs.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/frontend/apps/artcraft/app/public/resources/placeholders/audio_placeholder.png b/frontend/apps/artcraft/app/public/resources/placeholders/audio_placeholder.png new file mode 100644 index 00000000..a5715be6 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/placeholders/audio_placeholder.png differ diff --git a/frontend/apps/artcraft/app/public/resources/placeholders/placeholder.png b/frontend/apps/artcraft/app/public/resources/placeholders/placeholder.png new file mode 100644 index 00000000..f02db529 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/placeholders/placeholder.png differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_101.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_101.wav new file mode 100644 index 00000000..ecdaa953 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_101.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_102.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_102.wav new file mode 100644 index 00000000..d508557b Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_102.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_111.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_111.wav new file mode 100644 index 00000000..c477f5c4 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_111.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_113.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_113.wav new file mode 100644 index 00000000..5ae208c9 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_113.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_135.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_135.wav new file mode 100644 index 00000000..30b04b46 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_135.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_173.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_173.wav new file mode 100644 index 00000000..70eeab32 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_173.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_174.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_174.wav new file mode 100644 index 00000000..2845ef0d Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_174.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_175.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_175.wav new file mode 100644 index 00000000..d0f5e053 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_175.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/goldensun_214.wav b/frontend/apps/artcraft/app/public/resources/sound/goldensun_214.wav new file mode 100644 index 00000000..fd58d552 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/goldensun_214.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_12.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_12.wav new file mode 100644 index 00000000..2323f269 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_12.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_13.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_13.wav new file mode 100644 index 00000000..fdd1442c Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_13.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_14.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_14.wav new file mode 100644 index 00000000..c4394427 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_14.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_15.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_15.wav new file mode 100644 index 00000000..a51077fe Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_15.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_18.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_18.wav new file mode 100644 index 00000000..f6eb9351 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_18.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_51.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_51.wav new file mode 100644 index 00000000..649699fd Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_51.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_52.wav b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_52.wav new file mode 100644 index 00000000..467db391 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/metroidprime_UI_52.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/oot_dialogue_done.wav b/frontend/apps/artcraft/app/public/resources/sound/oot_dialogue_done.wav new file mode 100644 index 00000000..6a342349 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/oot_dialogue_done.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/oot_dialogue_next.wav b/frontend/apps/artcraft/app/public/resources/sound/oot_dialogue_next.wav new file mode 100644 index 00000000..33fdd819 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/oot_dialogue_next.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/oot_scrub_crumble.wav b/frontend/apps/artcraft/app/public/resources/sound/oot_scrub_crumble.wav new file mode 100644 index 00000000..cacadcc2 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/oot_scrub_crumble.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_character_extrapower.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_character_extrapower.wav new file mode 100644 index 00000000..48eb4e45 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_character_extrapower.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_click.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_click.wav new file mode 100644 index 00000000..f954d9c7 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_click.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_correct.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_correct.wav new file mode 100644 index 00000000..ccb8c517 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_correct.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_drybones_crumble.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_drybones_crumble.wav new file mode 100644 index 00000000..7513d1f1 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_drybones_crumble.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_enemy_spikethrow.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_enemy_spikethrow.wav new file mode 100644 index 00000000..a08dc150 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_enemy_spikethrow.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_flower.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_flower.wav new file mode 100644 index 00000000..f7b73939 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_flower.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_ghost.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_ghost.wav new file mode 100644 index 00000000..ebb3f365 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_ghost.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_mario_giantshellkick.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_mario_giantshellkick.wav new file mode 100644 index 00000000..0a0a24ec Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_mario_giantshellkick.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_specialflower.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_specialflower.wav new file mode 100644 index 00000000..003a20ee Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_specialflower.wav differ diff --git a/frontend/apps/artcraft/app/public/resources/sound/smrpg_wrong.wav b/frontend/apps/artcraft/app/public/resources/sound/smrpg_wrong.wav new file mode 100644 index 00000000..f7a026c9 Binary files /dev/null and b/frontend/apps/artcraft/app/public/resources/sound/smrpg_wrong.wav differ diff --git a/frontend/apps/artcraft/app/src/BuildEnvironment.ts b/frontend/apps/artcraft/app/src/BuildEnvironment.ts new file mode 100644 index 00000000..21b0b25e --- /dev/null +++ b/frontend/apps/artcraft/app/src/BuildEnvironment.ts @@ -0,0 +1,61 @@ + +/** + * This is cached whenever vite/remix/whatever launches. + * It's fed from an environment variable. + */ +export enum BuildEnvironmentType { + Dev, + DevProxy, + Staging, + Production, +} + +export class BuildEnvironment { + private static instance: BuildEnvironment; + private readonly environmentType: BuildEnvironmentType; + + public static getInstance(): BuildEnvironment { + if (BuildEnvironment.instance !== undefined) { + return BuildEnvironment.instance; + } + + // https://v2.vitejs.dev/guide/env-and-mode.html + console.log('Reading environment variable: `VITE_ENVIRONMENT_TYPE` to determine build environment.') + console.log(`Environment variable 'VITE_ENVIRONMENT_TYPE' = ${import.meta.env.VITE_ENVIRONMENT_TYPE}`) + + const environmentLabel : string | undefined = import.meta.env.VITE_ENVIRONMENT_TYPE; + + let environmentType = BuildEnvironmentType.Production; + + switch (environmentLabel?.toLocaleLowerCase()) { + case "dev": + case "development": + environmentType = BuildEnvironmentType.Dev; + break; + case "dev-proxy": + case "devproxy": + environmentType = BuildEnvironmentType.DevProxy; + break; + case "stage": + case "staging": + environmentType = BuildEnvironmentType.Staging; + break; + } + + const instance = new BuildEnvironment(environmentType); + BuildEnvironment.instance = instance; + return instance; + } + + public getBuildEnvironmentType(): BuildEnvironmentType { + return this.environmentType; + } + + private constructor(environmentType: BuildEnvironmentType) { + this.environmentType = environmentType; + } +} + +export function GetBuildEnvironment() : BuildEnvironment { + return BuildEnvironment.getInstance(); +} diff --git a/frontend/apps/artcraft/app/src/Classes/ApiManager/ApiManager.ts b/frontend/apps/artcraft/app/src/Classes/ApiManager/ApiManager.ts new file mode 100644 index 00000000..fcdf08be --- /dev/null +++ b/frontend/apps/artcraft/app/src/Classes/ApiManager/ApiManager.ts @@ -0,0 +1,212 @@ +import environmentVariables from "../EnvironmentVariables"; +import { FetchProxy as fetch } from "@storyteller/tauri-utils"; +import { StorytellerApiHostStore } from "@storyteller/api"; + +type NonNullableObject = NonNullable; + +export interface ApiResponse { + success: boolean; + errorMessage?: string; + data?: T; + pagination?: P; +} + +export class ApiManager { + ApiTargets: Record = {}; + + constructor() { + // TODO(bt,2025-07-06): Not sure that any of this is used anymore. + // If so, try to use StorytellerApiHostStore or another configuration source. + + // look at the .env file + this.ApiTargets = { + GoggleApi: environmentVariables.values.GOOGLE_API as string, + FunnelApi: environmentVariables.values.FUNNEL_API as string, + CdnApi: environmentVariables.values.CDN_API as string, + GravatarApi: environmentVariables.values.GRAVATAR_API as string, + uploadApi: environmentVariables.values.UPLOAD_API_VIDEO as string, + }; + } + + protected getApiSchemeAndHost(): string { + return StorytellerApiHostStore.getInstance().getApiSchemeAndHost(); + } + + public async fetch( + endpoint: string, + { + method, + query, + body, + }: { + method: string; + query?: Record; + body?: B; + }, + ): Promise { + const queryInString = + query && + Object.entries(query).reduce( + (allOptions, [key, value]) => { + if (!value) { + return allOptions; + } + allOptions[key] = value.toString(); + return allOptions; + }, + {} as Record, + ); + + const endpointWithQueries = queryInString + ? endpoint + "?" + new URLSearchParams(queryInString) + : endpoint; + + const bodyInString = JSON.stringify(body); + + const response = await fetch(endpointWithQueries, { + method, + headers: { + Accept: "application/json", + "Content-Type": "application/json", + }, + credentials: "include", + body: bodyInString, + }); + return response.json(); + } + + public async fetchMultipartFormData( + endpoint: string, + { + method, + body, + }: { + method: string; + body: FormData; + }, + ): Promise { + const response = await fetch(endpoint, { + method, + headers: { + Accept: "application/json", + }, + credentials: "include", + body: body, + }); + return response.json(); + } + + protected get({ + endpoint, + query, + }: { + endpoint: string; + query?: Record; + }): Promise { + return this.fetch(endpoint, { method: "GET", query }); + } + + protected post({ + endpoint, + query, + body, + }: { + endpoint: string; + query?: Record; + body?: B; + }): Promise { + return this.fetch(endpoint, { + method: "POST", + query, + body, + }); + } + + protected delete({ + endpoint, + query, + body, + }: { + endpoint: string; + query?: Record; + body?: B; + }): Promise { + return this.fetch(endpoint, { + method: "DELETE", + query, + body, + }); + } + + protected async postForm({ + endpoint, + formRecord, + uuid, + blob, + blobFileName, + }: { + endpoint: string; + formRecord: Record; + uuid: string; + blob?: Blob | File; + blobFileName?: string; + }): Promise { + const formData = new FormData(); + formData.append("uuid_idempotency_token", uuid); + Object.entries(formRecord).forEach(([key, value]) => { + formData.append(key, value); + }); + if (blob && blobFileName) { + formData.append("file", blob, blobFileName); + } else if (blob) { + formData.append("file", blob); + } + + console.log(`HELLO${formData}`); + return this.fetchMultipartFormData(endpoint, { + method: "POST", + headers: { + Accept: "application/json", + }, + credentials: "include", + body: formData, + }); + } + + protected camelToSnakeCase(str: string) { + return str.replace(/([a-z0])([A-Z])/g, "$1_$2").toLowerCase(); + } + + protected parseQueryValues( + params: Record, + ): Record { + return Object.entries(params).reduce( + (allParams, [key, value]) => { + if (!value) { + return allParams; + } + const snakeKey = this.camelToSnakeCase(key); + if (Array.isArray(value)) { + return { ...allParams, [snakeKey]: value.join(",") }; + } + return { ...allParams, [snakeKey]: value.toString() }; + }, + {} as Record, + ); + } + + protected parseBodyValues( + params: NonNullableObject, + ): B { + return Object.entries(params).reduce((allParams, [key, value]) => { + if (!value) { + return allParams; + } + const snakeKey = this.camelToSnakeCase(key); + if (Array.isArray(value)) { + return { ...allParams, [snakeKey]: value }; + } + return { ...allParams, [snakeKey]: value }; + }, {} as B); + } +} diff --git a/frontend/apps/artcraft/app/src/Classes/ApiManager/BillingApi.ts b/frontend/apps/artcraft/app/src/Classes/ApiManager/BillingApi.ts new file mode 100644 index 00000000..51282a16 --- /dev/null +++ b/frontend/apps/artcraft/app/src/Classes/ApiManager/BillingApi.ts @@ -0,0 +1,33 @@ +import { ApiManager, ApiResponse } from "./ApiManager"; +import { Subscription } from "~/models/Billing"; +import { LoyaltyProgram } from "~/enums"; + +export class BillingApi extends ApiManager { + public async ListActiveSubscriptions(): Promise< + ApiResponse<{ + active_subscriptions: Subscription[]; + maybe_loyalty_program?: LoyaltyProgram; + }> + > { + const endpoint = `${this.getApiSchemeAndHost()}/v1/billing/active_subscriptions`; + return await this.get<{ + success: boolean; + active_subscriptions?: Subscription[]; + maybe_loyalty_program?: LoyaltyProgram; + error_message?: string; + }>({ endpoint: endpoint }) + .then((response) => ({ + success: response.success, + data: { + active_subscriptions: response.active_subscriptions || [], + maybe_loyalty_program: response.maybe_loyalty_program, + }, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } +} diff --git a/frontend/apps/artcraft/app/src/Classes/ApiManager/MediaFilesApi.ts b/frontend/apps/artcraft/app/src/Classes/ApiManager/MediaFilesApi.ts new file mode 100644 index 00000000..921b734f --- /dev/null +++ b/frontend/apps/artcraft/app/src/Classes/ApiManager/MediaFilesApi.ts @@ -0,0 +1,399 @@ +import type { + MediaFile, + MediaInfo, + Pagination, + PaginationInfinite, +} from "~/types/artcraft-web"; +import { ApiManager, ApiResponse } from "./ApiManager"; +import { authentication } from "~/signals"; +import type { Property } from "csstype"; +import { Visibility } from "~/enums"; + +import { + FilterEngineCategories, + FilterMediaClasses, + FilterMediaType, +} from "~/enums"; + +interface ListMediaQuery { + sort_ascending?: boolean; + page_size?: number; + cursor?: string; + cursor_is_reversed?: boolean; + filter_media_classes?: FilterMediaClasses[]; + filter_media_type?: FilterMediaType[]; + filter_engine_categories?: FilterEngineCategories[]; +} + +interface ListUserMediaQuery { + sort_ascending?: boolean; + page_size?: number; + page_index?: number; + filter_media_classes?: FilterMediaClasses[]; + filter_media_type?: FilterMediaType[]; + filter_engine_categories?: FilterEngineCategories[]; +} + +interface SearchFeaturedMediaQuery { + search_term: string; + filter_media_classes?: FilterMediaClasses[]; + filter_media_type?: FilterMediaType[]; + filter_engine_categories?: FilterEngineCategories[]; +} + +export class MediaFilesApi extends ApiManager { + + public async ListMediaFilesByTokens({ + mediaTokens, + }: { + mediaTokens: string[]; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/batch`; + + return await this.get<{ + success: boolean; + media_files: MediaFile[]; + error_reason?: string; + }>({ endpoint, query: { tokens: mediaTokens.join(",") } }) + .then((response) => ({ + success: response.success, + data: response.media_files, + })) + .catch((err) => { + return { success: false, errorMessage: err.message }; + }); + } + + public async GetMediaFileByToken({ + mediaFileToken, + }: { + mediaFileToken: string; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/file/${mediaFileToken}`; + return await this.get<{ + success: boolean; + media_file: MediaFile; + }>({ endpoint }) + .then((response) => ({ + success: response.success, + data: response.media_file, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async ListMediaFiles( + query: ListMediaQuery, + ): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/list`; + const queryWithStrings = { + ...query, + filter_media_classes: query.filter_media_classes + ? query.filter_media_classes.join(",") + : undefined, + filter_media_type: query.filter_media_type + ? query.filter_media_type.join(",") + : undefined, + filter_engine_categories: query.filter_engine_categories + ? query.filter_engine_categories.join(",") + : undefined, + }; + return await this.get<{ + success: boolean; + results: MediaInfo[]; + pagination?: PaginationInfinite; + }>({ endpoint, query: queryWithStrings }) + .then((response) => ({ + success: response.success, + data: response.results ?? [], + pagination: response.pagination, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async ListFeaturedMediaFiles( + query: ListMediaQuery, + ): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/list_featured`; + const queryWithStrings = { + ...query, + filter_media_classes: query.filter_media_classes + ? query.filter_media_classes.join(",") + : undefined, + filter_media_type: query.filter_media_type + ? query.filter_media_type.join(",") + : undefined, + filter_engine_categories: query.filter_engine_categories + ? query.filter_engine_categories.join(",") + : undefined, + }; + return await this.get<{ + success: boolean; + results: MediaInfo[]; + pagination: PaginationInfinite; + }>({ endpoint, query: queryWithStrings }) + .then((response) => ({ + success: true, + data: response.results, + pagination: response.pagination, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async ListUserMediaFiles( + query: ListUserMediaQuery, + ): Promise> { + const userName = authentication.userInfo.value?.username; + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/list/user/${userName}`; + const queryWithStrings = { + ...query, + include_user_uploads: true, + filter_media_classes: query.filter_media_classes + ? query.filter_media_classes.join(",") + : undefined, + filter_media_type: query.filter_media_type + ? query.filter_media_type.join(",") + : undefined, + filter_engine_categories: query.filter_engine_categories + ? query.filter_engine_categories.join(",") + : undefined, + }; + return await this.get<{ + success: boolean; + results: MediaInfo[]; + pagination?: Pagination; + }>({ endpoint, query: queryWithStrings }) + .then((response) => ({ + success: response.success, + data: response.results ?? [], + pagination: response.pagination, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async SearchFeaturedMediaFiles( + query: SearchFeaturedMediaQuery, + ): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/search_featured`; + const queryWithStrings = { + search_term: query.search_term, + filter_media_classes: query.filter_media_classes + ? query.filter_media_classes.join(",") + : undefined, + filter_media_type: query.filter_media_type + ? query.filter_media_type.join(",") + : undefined, + filter_engine_categories: query.filter_engine_categories + ? query.filter_engine_categories.join(",") + : undefined, + }; + return await this.get<{ + success: boolean; + results: MediaInfo[]; + pagination: Pagination; + }>({ endpoint, query: queryWithStrings }) + .then((response) => ({ + success: true, + data: response.results, + pagination: response.pagination, + })) + .catch((err) => ({ + success: false, + errorMessage: err.message, + })); + } + + public async SearchUserMediaFiles( + query: SearchFeaturedMediaQuery, + ): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/search_session`; + const queryWithStrings = { + search_term: query.search_term, + filter_media_classes: query.filter_media_classes + ? query.filter_media_classes.join(",") + : undefined, + filter_media_type: query.filter_media_type + ? query.filter_media_type.join(",") + : undefined, + filter_engine_categories: query.filter_engine_categories + ? query.filter_engine_categories.join(",") + : undefined, + }; + return await this.get<{ + success: boolean; + results: MediaInfo[]; + pagination: Pagination; + }>({ endpoint, query: queryWithStrings }) + .then((response) => ({ + success: true, + data: response.results, + pagination: response.pagination, + })) + .catch((err) => ({ + success: false, + errorMessage: err.message, + })); + } + + public async RenameMediaFileByToken({ + mediaToken, + name, + }: { + mediaToken: string; + name: string; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/rename/${mediaToken}`; + const body = { name }; + + return await this.post< + { name: string }, + { + success?: boolean; + BadInput?: string; + } + >({ endpoint, body }) + .then((response) => ({ + success: response.success ?? false, + errorMessage: response.BadInput, + })) + .catch((err) => { + return { success: false, errorMessage: err.message }; + }); + } + + public async UpdateCoverImage({ + mediaFileToken, + imageToken, + }: { + mediaFileToken: string; + imageToken: string; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/cover_image/${mediaFileToken}`; + return await this.post< + { cover_image_media_file_token: string }, + { + success?: boolean; + BadInput?: string; + } + >({ endpoint, body: { cover_image_media_file_token: imageToken } }) + .then((response) => ({ + success: response.success ?? false, + errorMessage: response.BadInput, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async UpdateVisibility({ + mediaFileToken, + visibility, + }: { + mediaFileToken: string; + visibility: Visibility; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/visibility/${mediaFileToken}`; + return await this.post< + { creator_set_visibility: string }, + { + success?: boolean; + BadInput?: string; + } + >({ endpoint, body: { creator_set_visibility: visibility } }) + .then((response) => ({ + success: response.success ?? false, + errorMessage: response.BadInput, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async UploadSpzFile({ + file, + fileName, + uuid, + maybe_title, + maybe_visibility = Visibility.Public, + }: { + file: File; + fileName: string; + uuid: string; + maybe_title?: string; + maybe_visibility?: Visibility; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/media_files/upload/spz`; + const options: Record = { + maybe_title, + maybe_visibility: maybe_visibility?.toString(), + }; + return this.Upload({ endpoint, blob: file, fileName, uuid, options }); + } + + private async Upload({ + endpoint, + uuid, + blob, + fileName, + options, + }: { + endpoint: string; + blob: Blob | File; + fileName: string; + uuid: string; + options: Record; + }): Promise> { + const formRecord = Object.entries(options).reduce( + (allOptions, [key, value]) => { + if (value === undefined) { + return allOptions; + } + return { ...allOptions, [key]: value.toString() }; + }, + {} as Record, + ); + + return await this.postForm<{ + success: boolean; + media_file_token?: string; + BadInput?: string; + }>({ endpoint, formRecord, blob, blobFileName: fileName, uuid }) + .then((response) => ({ + success: Boolean(response.success ?? false), + data: response.media_file_token, + errorMessage: response.BadInput, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + +} diff --git a/frontend/apps/artcraft/app/src/Classes/ApiManager/UsersApi.ts b/frontend/apps/artcraft/app/src/Classes/ApiManager/UsersApi.ts new file mode 100644 index 00000000..daa14749 --- /dev/null +++ b/frontend/apps/artcraft/app/src/Classes/ApiManager/UsersApi.ts @@ -0,0 +1,169 @@ +import { ApiManager, ApiResponse } from "./ApiManager"; +import { UserInfo } from "~/models"; + +interface SignupRequest { + username: string; + email_address: string; + password: string; + password_confirmation: string; + signup_source?: string; +}; + +export class UsersApi extends ApiManager { + public GetSession(): Promise< + ApiResponse<{ + loggedIn: boolean; + user?: UserInfo; + }> + > { + const endpoint = `${this.getApiSchemeAndHost()}/v1/session`; + return this.get<{ + success: boolean; + logged_in: boolean; + user?: UserInfo; + error_message?: string; + }>({ endpoint: endpoint }) + .then((response) => ({ + success: response.success, + data: { + loggedIn: response.logged_in, + user: response.user, + }, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.mesasge, + }; + }); + } + + public GetUserProfile(username: string): Promise< + ApiResponse<{ + user?: UserInfo; + }> + > { + const endpoint = `${this.getApiSchemeAndHost()}/v1/user/${username}/profile`; + return this.get<{ + success: boolean; + user?: UserInfo; + error_message?: string; + }>({ endpoint: endpoint }) + .then((response) => ({ + success: response.success, + data: { + user: response.user, + }, + })) + .catch((err) => { + return { + success: false, + error_message: err.message, + }; + }); + } + + public async Login({ + usernameOrEmail, + password, + }: { + usernameOrEmail: string; + password: string; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/login`; + const body = { + username_or_email: usernameOrEmail, + password: password, + }; + return await this.post< + { username_or_email: string; password: string }, + { + success: boolean; + signed_session?: string; + error_message?: string; + error_type?: string; + } + >({ + endpoint: endpoint, + body: body, + }) + .then((response) => ({ + success: response.success, + data: { signedSession: response.signed_session }, + errorMessage: response.error_message, + })) + .catch((err) => { + return { + success: false, + error_message: err.message, + }; + }); + } + + public Logout(): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/logout`; + return this.post({ + endpoint: endpoint, + }) + .then((response) => ({ + success: response.success, + })) + .catch((err) => { + return { + success: false, + errorMessage: err.message, + }; + }); + } + + public async Signup({ + username, + email, + password, + passwordConfirmation, + signupSource, + }: { + username: string; + email: string; + password: string; + passwordConfirmation: string; + signupSource?: string; + }): Promise> { + const endpoint = `${this.getApiSchemeAndHost()}/v1/create_account`; + let body: SignupRequest = { + email_address: email, + password, + password_confirmation: passwordConfirmation, + username, + }; + if (!!signupSource) { + body.signup_source = signupSource; + } + return await this.post< + SignupRequest, + { + success: boolean; + signed_session?: string; + error_fields?: Record; + error_message?: string; + error_type?: string; + } + >({ + endpoint: endpoint, + body: body, + }) + .then((response) => { + return { + success: response.success, + data: { signedSession: response.signed_session }, + errorMessage: Object.values(response.error_fields ?? {}).join(","), + }; + }) + .catch((err) => { + return { + success: false, + error_message: err.message, + }; + }); + } +} diff --git a/frontend/apps/artcraft/app/src/Classes/ApiManager/index.ts b/frontend/apps/artcraft/app/src/Classes/ApiManager/index.ts new file mode 100644 index 00000000..a0aed03b --- /dev/null +++ b/frontend/apps/artcraft/app/src/Classes/ApiManager/index.ts @@ -0,0 +1,3 @@ +export * from "./BillingApi"; +export * from "./MediaFilesApi"; +export * from "./UsersApi"; diff --git a/frontend/apps/artcraft/app/src/Classes/EnvironmentVariables.ts b/frontend/apps/artcraft/app/src/Classes/EnvironmentVariables.ts new file mode 100644 index 00000000..90813c83 --- /dev/null +++ b/frontend/apps/artcraft/app/src/Classes/EnvironmentVariables.ts @@ -0,0 +1,10 @@ +class EnvironmentVariables { + values: Record = {}; + + initialize(values: Record) { + this.values = values; + } +} + +const environmentVariables = new EnvironmentVariables(); +export default environmentVariables; diff --git a/frontend/apps/artcraft/app/src/Helpers/CanvasHelpers.ts b/frontend/apps/artcraft/app/src/Helpers/CanvasHelpers.ts new file mode 100644 index 00000000..929ab134 --- /dev/null +++ b/frontend/apps/artcraft/app/src/Helpers/CanvasHelpers.ts @@ -0,0 +1,29 @@ + +export const normalizeCanvas = (canvas: HTMLCanvasElement, width: number, height: number): OffscreenCanvas => { + const newCanvas = new OffscreenCanvas(width, height); + newCanvas.width = width; + newCanvas.height = height; + + const ctx = newCanvas.getContext("2d"); + if (!ctx) { + throw new Error("Failed to get offscreen canvas context"); + } + + ctx.imageSmoothingEnabled = true; + ctx.drawImage(canvas, 0, 0, width, height); + return newCanvas; +} + +export const drawAlphaMask = (canvas: OffscreenCanvas, width: number, height: number) => { + const ctx = canvas.getContext("2d"); + if (!ctx) { + throw new Error("Failed to get canvas context"); + } + + // Fill the entire screen with black and composite to keep non-transparent pixels + ctx.save(); + ctx.globalCompositeOperation = "source-in"; + ctx.fillStyle = "black"; + ctx.fillRect(0, 0, width, height); + ctx.restore(); +} diff --git a/frontend/apps/artcraft/app/src/Helpers/ImageHelpers.ts b/frontend/apps/artcraft/app/src/Helpers/ImageHelpers.ts new file mode 100644 index 00000000..585fc55f --- /dev/null +++ b/frontend/apps/artcraft/app/src/Helpers/ImageHelpers.ts @@ -0,0 +1,19 @@ +export async function loadImage(img: HTMLImageElement) { + return new Promise((resolve, reject) => { + img.onload = () => resolve(img); + img.onerror = reject; + }); +} + +export async function loadImageFromUrl(url: string) { + const img = new Image(); + img.src = url; + return loadImage(img); +} + +export async function loadImageFromAnonymousOriginUrl(url: string) { + const img = new Image(); + img.crossOrigin = "anonymous"; + img.src = url; + return loadImage(img); +} diff --git a/frontend/apps/artcraft/app/src/api/SyncStorytellerApiConfig.ts b/frontend/apps/artcraft/app/src/api/SyncStorytellerApiConfig.ts new file mode 100644 index 00000000..04c63ee9 --- /dev/null +++ b/frontend/apps/artcraft/app/src/api/SyncStorytellerApiConfig.ts @@ -0,0 +1,70 @@ +import { GetAppInfo } from "@storyteller/tauri-api"; +import { StorytellerApiHostStore } from "@storyteller/api"; +import { forceGetUserInfoAndSubcriptions } from "~/signals"; + +// Time before we should call Tauri again. +const SYNC_THRESHOLD = 10 * 1000; + +/** + * Keep track of if we can call Tauri again. + */ +class Cache { + private static instance: Cache; + private lastFetchSuccess?: number; + + public static getInstance(): Cache { + if (Cache.instance !== undefined) { + return Cache.instance; + } + const instance = new Cache(); + Cache.instance = instance; + return instance; + } + + public canCall() : boolean { + if (this.lastFetchSuccess === undefined) { + return true; + } + return Date.now() - this.lastFetchSuccess > SYNC_THRESHOLD; + } + + public setCallSuccess() { + this.lastFetchSuccess = Date.now(); + } +} + +/** + * Syncs our view of the Storyteller API configs with Tauri. + * Runs any necessary user session functions if things change. + */ +export const SyncStorytellerApiConfig = async () => { + console.log("SyncStorytellerApiConfig()") + + const cache = Cache.getInstance(); + const oldValue = StorytellerApiHostStore.getInstance().getApiSchemeAndHost(); + + if (!cache.canCall()) { + return; + } + + GetAppInfo().then(async (appInfo) => { + console.log("SyncStorytellerApiConfig() - appInfo", appInfo); + + const schemeAndHost = appInfo.payload.storyteller_host; + if (!schemeAndHost) { + return ; + } + + console.log(`Updating hostname to ${schemeAndHost}`); + StorytellerApiHostStore.getInstance().setApiSchemeAndHost(schemeAndHost); + + cache.setCallSuccess(); + + if (oldValue !== schemeAndHost) { + console.log("SyncStorytellerApiConfig() - force session refresh") + // NB: This is a hack that might prevent the login screen from being shown + // if the user is working in development. + await forceGetUserInfoAndSubcriptions(); + } + }); +} diff --git a/frontend/apps/artcraft/app/src/components/CredentialErrorModal/CredentialErrorModal.tsx b/frontend/apps/artcraft/app/src/components/CredentialErrorModal/CredentialErrorModal.tsx new file mode 100644 index 00000000..5a037912 --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/CredentialErrorModal/CredentialErrorModal.tsx @@ -0,0 +1,82 @@ +import { useState } from "react"; +import { invoke } from "@tauri-apps/api/core"; +import { Modal } from "@storyteller/ui-modal"; +import { Button } from "@storyteller/ui-button"; +import { LogIn, UserX } from "lucide-react"; +import { ShowCredentialErrorModalEvent, useShowCredentialErrorModalEvent } from "@storyteller/tauri-events"; + +// `LoginWebsite` values (crates/artcraftx/src/credentials/login_website.rs) +// as users know them. +const LOGIN_WEBSITE_NAMES: Record = { + artcraft: "ArtCraft", + higgsfield: "Higgsfield", + magnific: "Magnific", + midjourney: "Midjourney", + openart: "OpenArt", + runway: "Runway", + xai: "Grok", +}; + +/** + * Dismissable modal shown when the backend reports a credential problem with + * a generation request (no account selected, unknown credential id, or a + * credential that can't serve the request). Mounted once in MainApp; opens + * itself on `show_credential_error_modal_event`. + * + * When the problem is an expired session, the event names the website to + * log into again and the credential to refresh, and the modal offers a + * button that opens that login window. Logging in rewrites that credential + * in place rather than adding a second account. + */ +export const CredentialErrorModal = () => { + const [event, setEvent] = useState(null); + + useShowCredentialErrorModalEvent(async (event) => { + setEvent(event); + }); + + const close = () => setEvent(null); + + const reloginWebsite = event?.maybe_relogin_website; + const reloginName = reloginWebsite ? LOGIN_WEBSITE_NAMES[reloginWebsite] ?? reloginWebsite : undefined; + + const openLogin = async () => { + if (!reloginWebsite) return; + const credentialId = event?.maybe_credential_id; + close(); + try { + await invoke("open_web_login_command", { website: reloginWebsite, credentialId }); + } catch (err) { + console.error("[credentials] could not open login window:", err); + } + }; + + return ( + +
+

{event?.message}

+ {reloginWebsite ? ( +
+ + +
+ ) : ( + + )} +
+ + ); +}; diff --git a/frontend/apps/artcraft/app/src/components/GlobalFileDropHandler/GlobalFileDropHandler.tsx b/frontend/apps/artcraft/app/src/components/GlobalFileDropHandler/GlobalFileDropHandler.tsx new file mode 100644 index 00000000..b89ed3fa --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/GlobalFileDropHandler/GlobalFileDropHandler.tsx @@ -0,0 +1,228 @@ +import { useEffect, useRef, useState } from "react"; +import { toast } from "react-hot-toast"; +import { Box, Images, Maximize2 } from "lucide-react"; +import { + UploadModal3D, + UploadModalImage, + UploadModalSplat, +} from "@storyteller/ui-upload-modal"; +import { isPromptBoxDropZoneActive } from "@storyteller/ui-promptbox"; +import { FilterEngineCategories } from "../../enums"; + +type ModalType = "3d" | "image" | "splat" | null; + +function getModalTypeForFileName(name: string): ModalType { + const ext = name.split(".").pop()?.toLowerCase() ?? ""; + if (ext === "glb") return "3d"; + if (ext === "png" || ext === "jpg" || ext === "jpeg") return "image"; + if (ext === "spz") return "splat"; + return null; +} + +function isAnyModalOpen(): boolean { + return !!document.querySelector("[data-radix-dialog-content]"); +} + +/** + * Whole-app drops stand down while a prompt box owns them. On the create + * pages the prompt box is the only drop target (matching the webapp), so a + * drop anywhere else must do nothing rather than open the upload modal. + */ +function isGlobalDropSuppressed(): boolean { + return isAnyModalOpen() || isPromptBoxDropZoneActive(); +} + +const isTauri = typeof window !== "undefined" && "__TAURI__" in window; + +export function GlobalFileDropHandler() { + const dragCounter = useRef(0); + const [isDragging, setIsDragging] = useState(false); + const [modalType, setModalType] = useState(null); + const [pendingFiles, setPendingFiles] = useState([]); + + const closeModal = () => { + setModalType(null); + setPendingFiles([]); + }; + + useEffect(() => { + if (isTauri) { + const unlisteners: Array<() => void> = []; + + const setup = async () => { + try { + const { getCurrentWebviewWindow } = await import("@tauri-apps/api/webviewWindow"); + const { convertFileSrc } = await import("@tauri-apps/api/core"); + const appWindow = getCurrentWebviewWindow(); + + const unlisten = await appWindow.onDragDropEvent(async (event) => { + const payload = event.payload; + + if (payload.type === "enter") { + if (!isGlobalDropSuppressed()) setIsDragging(true); + } else if (payload.type === "over") { + // The prompt box can mount mid-drag (or the pointer can move + // onto it), so keep re-checking rather than trusting "enter". + if (isGlobalDropSuppressed()) setIsDragging(false); + } else if (payload.type === "drop") { + setIsDragging(false); + if (isGlobalDropSuppressed()) return; + + if (payload.paths.length === 0) return; + + // Find first path with a recognised extension + let modalKind: ModalType = null; + for (const p of payload.paths) { + modalKind = getModalTypeForFileName(p.split(/[/\\]/).pop() ?? ""); + if (modalKind) break; + } + if (!modalKind) return; + + // Keep only paths matching the detected modal type + const matchingPaths = payload.paths.filter((p) => { + const name = p.split(/[/\\]/).pop() ?? ""; + return getModalTypeForFileName(name) === modalKind; + }); + + const skippedCount = payload.paths.length - matchingPaths.length; + if (skippedCount > 0) { + toast( + `${skippedCount} file${skippedCount > 1 ? "s" : ""} skipped — unsupported or mixed types`, + { icon: "⚠️" } + ); + } + + try { + const files = await Promise.all( + matchingPaths.map(async (path) => { + const fileName = path.split(/[/\\]/).pop() ?? "file"; + const assetUrl = convertFileSrc(path); + const response = await fetch(assetUrl); + if (!response.ok) throw new Error(`HTTP ${response.status}`); + const blob = await response.blob(); + return new File([blob], fileName); + }) + ); + await appWindow.setFocus(); + setModalType(modalKind); + setPendingFiles(files); + } catch (err) { + console.error("[DragDrop] file read failed:", err); + } + } else { + setIsDragging(false); + } + }); + + unlisteners.push(unlisten); + } catch (err) { + console.error("[DragDrop] setup failed:", err); + } + }; + + setup(); + return () => { unlisteners.forEach((fn) => fn()); }; + + } else { + // HTML5 path (browser dev mode) + const handleDragEnter = (e: DragEvent) => { + e.preventDefault(); + if (!e.dataTransfer?.types.includes("Files")) return; + if (isGlobalDropSuppressed()) return; + dragCounter.current++; + setIsDragging(true); + }; + const handleDragLeave = (e: DragEvent) => { + if (!e.dataTransfer?.types.includes("Files")) return; + dragCounter.current--; + if (dragCounter.current <= 0) { dragCounter.current = 0; setIsDragging(false); } + }; + const handleDragOver = (e: DragEvent) => { + e.preventDefault(); + if (e.dataTransfer) e.dataTransfer.dropEffect = "copy"; + }; + const handleDrop = (e: DragEvent) => { + if (!e.dataTransfer?.types.includes("Files")) return; + e.preventDefault(); + setIsDragging(false); + dragCounter.current = 0; + if (isGlobalDropSuppressed()) return; + + const allFiles = Array.from(e.dataTransfer.files); + if (allFiles.length === 0) return; + + // Find first file with a recognised extension + let modalKind: ModalType = null; + for (const f of allFiles) { + modalKind = getModalTypeForFileName(f.name); + if (modalKind) break; + } + if (!modalKind) return; + + // Keep only files matching the detected modal type + const matchingFiles = allFiles.filter( + (f) => getModalTypeForFileName(f.name) === modalKind + ); + + const skippedCount = allFiles.length - matchingFiles.length; + if (skippedCount > 0) { + toast( + `${skippedCount} file${skippedCount > 1 ? "s" : ""} skipped — unsupported or mixed types`, + { icon: "⚠️" } + ); + } + + setModalType(modalKind); + setPendingFiles(matchingFiles); + }; + window.addEventListener("dragenter", handleDragEnter); + window.addEventListener("dragleave", handleDragLeave); + window.addEventListener("dragover", handleDragOver); + window.addEventListener("drop", handleDrop); + return () => { + window.removeEventListener("dragenter", handleDragEnter); + window.removeEventListener("dragleave", handleDragLeave); + window.removeEventListener("dragover", handleDragOver); + window.removeEventListener("drop", handleDrop); + }; + } + }, []); + + return ( + <> + {isDragging && modalType === null && ( +
+
+ +
Drop to Upload
+
GLB, PNG, JPG, JPEG, SPZ
+
+
+ )} + 0 ? pendingFiles : undefined} + onClose={closeModal} + onSuccess={(_category: FilterEngineCategories) => closeModal()} + title="Upload a 3D Model" + titleIcon={Box} + /> + 0 ? pendingFiles : undefined} + onClose={closeModal} + onSuccess={() => closeModal()} + title="Upload an Image" + titleIcon={Images} + /> + 0 ? pendingFiles : undefined} + onClose={closeModal} + onSuccess={() => {}} + title="Upload a Splat" + titleIcon={Box} + /> + + ); +} diff --git a/frontend/apps/artcraft/app/src/components/PromptShell/PromptShell.tsx b/frontend/apps/artcraft/app/src/components/PromptShell/PromptShell.tsx new file mode 100644 index 00000000..a83dcf8d --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/PromptShell/PromptShell.tsx @@ -0,0 +1,101 @@ +import { ReactNode, useEffect, useRef, useState } from "react"; +import { Check } from "lucide-react"; +import type { CompletedFile } from "./useComposerTasks"; + +// The full-window composer frame, styled after the marketing site's AppWindow +// mock: "Prompt" heading, editor filling the window, a signal progress bar +// riding the bottom edge while rendering, and a mono "written to disk" +// receipt when a result lands. Results are auto-saved to the user's download +// directory — the app shows no galleries, files just appear on disk. + +const RECEIPT_HIDE_MS = 6000; + +interface Receipt { + text: string; + key: number; +} + +interface PromptShellProps { + /** Modality glyph rendered before the heading. */ + icon?: ReactNode; + /** Any task for this page's modality currently in flight. */ + busy: boolean; + /** Newly-completed files; each gets a "written to disk" receipt once. */ + completed?: CompletedFile[]; + /** The page's promptbox, rendered full-bleed. */ + children: ReactNode; +} + +export function PromptShell({ + icon, + busy, + completed, + children, +}: PromptShellProps) { + const [receipt, setReceipt] = useState(null); + const savedIdsRef = useRef>(new Set()); + + // Receipt each completed file exactly once. Every provider's completion + // path on the Rust side (the ArtCraft poller and the shared third-party + // completion routine used by Grok, FAL, Midjourney, World Labs and + // Higgsfield) already saves the results to the user's download directory, + // named per their filename convention. Downloading them again here would + // create duplicates (it used to, for every non-ArtCraft provider). The Rust + // side flashes a toast if a save fails. + useEffect(() => { + if (!completed?.length) return; + const fresh = completed.filter((f) => !savedIdsRef.current.has(f.id)); + if (fresh.length === 0) return; + fresh.forEach((f) => savedIdsRef.current.add(f.id)); + + setReceipt({ + text: fresh.length === 1 ? "1 file" : `${fresh.length} files`, + key: Date.now(), + }); + }, [completed]); + + // Auto-fade the receipt. + useEffect(() => { + if (!receipt) return; + const id = window.setTimeout(() => setReceipt(null), RECEIPT_HIDE_MS); + return () => window.clearTimeout(id); + }, [receipt]); + + return ( +
+
+
+ {icon && {icon}} +

Prompt

+
+
{children}
+
+ + {receipt && ( +
+
+ + + + + {receipt.text} + + + written to disk + +
+
+ )} + + {/* Render progress rides the bottom edge of the window. */} +
+ {busy && ( +
+ )} +
+
+ ); +} diff --git a/frontend/apps/artcraft/app/src/components/PromptShell/index.ts b/frontend/apps/artcraft/app/src/components/PromptShell/index.ts new file mode 100644 index 00000000..03f54284 --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/PromptShell/index.ts @@ -0,0 +1,6 @@ +export { PromptShell } from "./PromptShell"; +export { + useComposerTasks, + type ComposerTaskModality, + type CompletedFile, +} from "./useComposerTasks"; diff --git a/frontend/apps/artcraft/app/src/components/PromptShell/useComposerTasks.ts b/frontend/apps/artcraft/app/src/components/PromptShell/useComposerTasks.ts new file mode 100644 index 00000000..4c95bb8a --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/PromptShell/useComposerTasks.ts @@ -0,0 +1,149 @@ +import { useCallback, useEffect, useRef, useState } from "react"; +import { listen, UnlistenFn } from "@tauri-apps/api/event"; +import { GetTaskQueue } from "@storyteller/tauri-api"; +import { MediaFilesApi } from "@storyteller/api"; + +// Lean activity tracker for the full-bleed composers: "is anything in flight +// for this modality" plus newly-completed file URLs. The old generation feed +// expanded results into gallery items; here completions only drive the disk +// receipt, so this stays thumbnail- and gallery-free. + +const POLL_INTERVAL_MS = 5000; + +export type ComposerTaskModality = "image" | "video" | "splat" | "mesh" | "audio"; + +export interface CompletedFile { + /** Unique per file (task id, or task id + batch index). */ + id: string; + url: string; + /** Generation provider ("artcraft", "fal", "higgsfield", ...). Every + * provider's files are auto-saved by the Rust polling threads; the + * frontend only receipts them. */ + provider?: string; +} + +const TASK_TYPES: Record> = { + image: new Set(["image_generation"]), + video: new Set(["video_generation"]), + splat: new Set(["splat_generation"]), + mesh: new Set(["mesh_generation"]), + audio: new Set(["audio_generation"]), +}; + +export function useComposerTasks(modality: ComposerTaskModality) { + const [busy, setBusy] = useState(false); + const [completed, setCompleted] = useState([]); + const mediaApiRef = useRef(new MediaFilesApi()); + // null until the first load — pre-existing completions must not re-emit + // (and re-save) every time the page remounts on a tab switch. + const prevCompletedIdsRef = useRef | null>(null); + + const load = useCallback(async () => { + try { + const { tasks } = await GetTaskQueue(); + const mine = tasks.filter((t) => + TASK_TYPES[modality].has(String(t.task_type)), + ); + + setBusy( + mine.some( + (t) => t.task_status === "pending" || t.task_status === "started", + ), + ); + + const done = mine.filter( + (t) => + String(t.task_status) === "complete_success" && + t.completed_item?.primary_media_file?.cdn_url, + ); + const doneIds = new Set(done.map((t) => t.id)); + + if (prevCompletedIdsRef.current) { + const prev = prevCompletedIdsRef.current; + const fresh = done.filter((t) => !prev.has(t.id)); + if (fresh.length > 0) { + const expanded = await Promise.all( + fresh.map((t) => expandTaskFiles(t, mediaApiRef.current)), + ); + const files = expanded.flat(); + if (files.length > 0) { + setCompleted((prevFiles) => { + const existing = new Set(prevFiles.map((f) => f.id)); + return [ + ...prevFiles, + ...files.filter((f) => !existing.has(f.id)), + ]; + }); + } + } + } + prevCompletedIdsRef.current = doneIds; + } catch { + // ignore — next poll retries + } + }, [modality]); + + useEffect(() => { + load(); + const intervalId = setInterval(load, POLL_INTERVAL_MS); + + const handleTaskUpdate = () => load(); + window.addEventListener("task-queue-update", handleTaskUpdate); + + let cancelled = false; + const unlistens: Promise[] = [ + "generation-complete-event", + "generation-failed-event", + ].map((name) => + listen(name, () => { + if (!cancelled) load(); + }), + ); + + return () => { + cancelled = true; + clearInterval(intervalId); + window.removeEventListener("task-queue-update", handleTaskUpdate); + unlistens.forEach((p) => p.then((f) => f())); + }; + }, [load]); + + return { busy, completed }; +} + +/** One image task can produce a whole batch — expand to every file so all of + * them land on disk, falling back to the primary file alone. */ +async function expandTaskFiles( + t: Awaited>["tasks"][number], + mediaFilesApi: MediaFilesApi, +): Promise { + const provider = t.provider ? String(t.provider) : undefined; + const primary: CompletedFile = { + id: t.id, + // Callers filter on cdn_url presence before expanding (line ~57). + url: t.completed_item!.primary_media_file!.cdn_url, + provider, + }; + + const batchToken = t.completed_item?.maybe_batch_token; + if (!batchToken) return [primary]; + + try { + const batchResponse = await mediaFilesApi.GetMediaFilesByBatchToken({ + batchToken, + }); + if (!batchResponse.success || !batchResponse.data?.length) { + return [primary]; + } + const files = batchResponse.data + .map((file: any, index: number): CompletedFile | null => { + const cdnUrl = file.media_links?.cdn_url; + if (!cdnUrl) return null; + return { id: `${t.id}:${file.token ?? index}`, url: cdnUrl, provider }; + }) + .filter((f: CompletedFile | null): f is CompletedFile => f !== null); + return files.length > 0 ? files : [primary]; + } catch { + return [primary]; + } +} diff --git a/frontend/apps/artcraft/app/src/components/account-selector/AccountSelector.tsx b/frontend/apps/artcraft/app/src/components/account-selector/AccountSelector.tsx new file mode 100644 index 00000000..250a9691 --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/account-selector/AccountSelector.tsx @@ -0,0 +1,145 @@ +import { useCallback, useEffect, useState } from "react"; +import { User } from "lucide-react"; +import { PopoverMenu, type PopoverItem } from "@storyteller/ui-popover"; +import { Tooltip } from "@storyteller/ui-tooltip"; +import { useRefreshAccountStateEvent } from "@storyteller/tauri-events"; +import { + CredentialPayload, + getServiceLogoPath, + getServiceMeta, + listCredentials, +} from "@storyteller/ui-settings-modal"; +import { useClassyModelSelectorStore, useSelectedAccountId } from "@storyteller/ui-model-selector"; + +/** + * Toolbar account picker: lists every stored credential (API keys and + * website/ArtCraft logins) and records the pick in the shared selection + * store, which keeps each page's model/provider compatible with it. Rendered + * to the left of the model selector on each generation page. + * + * Fetches the credential list on every mount for now — caching and cache + * busting come later. + */ +export const AccountSelector = () => { + const [credentials, setCredentials] = useState([]); + const selectedAccountId = useSelectedAccountId(); + const setSelectedAccountId = useClassyModelSelectorStore((s) => s.setSelectedAccountId); + const setAccounts = useClassyModelSelectorStore((s) => s.setAccounts); + + const refresh = useCallback(async () => { + try { + setCredentials(await listCredentials()); + } catch (e) { + console.error("Failed to list accounts", e); + } + }, []); + + useEffect(() => { + refresh(); + }, [refresh]); + + // Logins and credential edits emit this event; reload so the list is fresh. + useRefreshAccountStateEvent(async () => { + await refresh(); + }); + + // Hand the accounts to the selection store; it defaults to the first one + // and re-points (or clears) when the selected credential is deleted. + useEffect(() => { + setAccounts(credentials.map((c) => ({ id: c.id, service: c.service }))); + }, [credentials, setAccounts]); + + const items: PopoverItem[] = + credentials.length > 0 + ? credentials.map((credential) => ({ + label: accountLabel(credential), + description: accountDescription(credential), + selected: credential.id === selectedAccountId, + action: credential.id, + icon: ( + + ), + })) + : [ + { + label: "No accounts yet", + description: "Add one in Settings → Accounts", + selected: false, + disabled: true, + }, + ]; + + const handleSelect = (item: PopoverItem) => { + if (item.action) setSelectedAccountId(item.action); + }; + + const selectedCredential = credentials.find( + (credential) => credential.id === selectedAccountId + ); + + return ( + + + {selectedCredential ? ( + + ) : ( + + )} + + } + /> + + ); +}; + +/** + * Auto-assigned usernames (notably Midjourney's, e.g. "u3869671173") are just + * "u" followed by digits. They carry no human meaning, so we prefer the email + * for these; a username that looks human-set is still preferred. + */ +const AUTO_ASSIGNED_USERNAME_PATTERN = /^u\d+$/; + +/** Row title: the most personal identity we have for the account. */ +const accountLabel = (credential: CredentialPayload): string => { + const name = credential.name?.trim(); + if (name) { + return name; + } + + const username = credential.username?.trim(); + const email = credential.email?.trim(); + const serviceLabel = getServiceMeta(credential.service).label; + + if (username && !AUTO_ASSIGNED_USERNAME_PATTERN.test(username)) { + return username; + } + + // Auto-assigned (or missing) username: prefer the email, then fall back. + return email || username || serviceLabel; +}; + +/** Row subtitle: the service, plus a key preview for API-key accounts. */ +const accountDescription = (credential: CredentialPayload): string => { + const serviceLabel = getServiceMeta(credential.service).label; + if (credential.kind === "api_key") { + return `${serviceLabel} · ${credential.api_key_preview ?? ""}${"*".repeat(8)}`; + } + return serviceLabel; +}; diff --git a/frontend/apps/artcraft/app/src/components/experiences/ImageTo3DComposer.tsx b/frontend/apps/artcraft/app/src/components/experiences/ImageTo3DComposer.tsx new file mode 100644 index 00000000..2de4de93 --- /dev/null +++ b/frontend/apps/artcraft/app/src/components/experiences/ImageTo3DComposer.tsx @@ -0,0 +1,307 @@ +import { useMemo, useRef, useState } from "react"; +import { Box, Earth, Plus, X } from "lucide-react"; +import { toast } from "react-hot-toast"; +import { twMerge } from "tailwind-merge"; +import { GenerateIconButton } from "@storyteller/ui-button"; +import { useCostBreakdownModalStore } from "@storyteller/ui-pricing-modal"; +import { + GenerateMesh, + GenerateSplat, + useSplatModels, + type MediaSource, +} from "@storyteller/tauri-api"; +import { + ClassyModelSelector, + ModelPage, + useImageTo3dObjectPageModelList, + useImageTo3dWorldPageModelList, + useSelectedModel, +} from "@storyteller/ui-model-selector"; +import { PromptShell, useComposerTasks } from "~/components/PromptShell"; +import { AccountSelector } from "~/components/account-selector/AccountSelector"; +import { useSelectedAccountId } from "@storyteller/ui-model-selector"; + +// Minimal image→3D composer in the marketing-site style: reference tray + +// optional prompt + generate. Replaces the old ImageTo3DExperience page UI +// (viewer/history/gallery) — results are written to disk like every other +// modality. The old experience component is kept in the tree, just unused. + +type Variant = "object" | "world"; + +interface TrayImage { + id: string; + preview: string; + /** Set only for library picks; locally attached files keep their bytes in + * `file` and travel with the generate request instead. */ + mediaToken: string | null; + file: File | null; + name: string; + isUploading: boolean; +} + +const MAX_WORLD_IMAGES = 10; +const DEFAULT_OBJECT_MODEL_ID = "hunyuan_3d_3"; + +const generateId = () => + typeof crypto !== "undefined" && crypto.randomUUID + ? crypto.randomUUID() + : Math.random().toString(36).slice(2, 10); + +interface ImageTo3DComposerProps { + variant: Variant; +} + +export const ImageTo3DComposer = ({ variant }: ImageTo3DComposerProps) => { + const isWorld = variant === "world"; + const pageId = isWorld ? ModelPage.ImageTo3DWorld : ModelPage.ImageTo3DObject; + const maxImages = isWorld ? MAX_WORLD_IMAGES : 1; + + const selectedModel = useSelectedModel(pageId); + const selectedObjectModelId = selectedModel?.id ?? DEFAULT_OBJECT_MODEL_ID; + const worldModelList = useImageTo3dWorldPageModelList(); + const objectModelList = useImageTo3dObjectPageModelList(); + // Fallback when nothing is selected yet (lists load from the backend). + const defaultSplatModel = useSplatModels()[0]; + + const { busy, completed } = useComposerTasks(isWorld ? "splat" : "mesh"); + + const estimatedCredits = useCostBreakdownModalStore( + (state) => state.estimatedCreditsByPage[pageId], + ); + + const [images, setImages] = useState([]); + const [prompt, setPrompt] = useState(""); + const selectedAccountId = useSelectedAccountId(); + const [isGenerating, setIsGenerating] = useState(false); + const fileInputRef = useRef(null); + + const readyImages = useMemo( + () => + images.filter((img) => (img.mediaToken || img.file) && !img.isUploading), + [images], + ); + const canGenerate = + !isGenerating && readyImages.length > 0 && !images.some((i) => i.isUploading); + + const handleFiles = async (files?: FileList | File[] | null) => { + if (!files) return; + const remaining = maxImages - images.length; + const imageFiles = Array.from(files) + .filter((f) => f.type.startsWith("image/")) + .slice(0, Math.max(0, remaining)); + if (imageFiles.length === 0) return; + + // No upload at attach time: keep the bytes local; they travel with the + // generate request (the backend uploads to ArtCraft only then, since + // mesh/splat generation runs on the ArtCraft provider). + await Promise.all( + imageFiles.map(async (file) => { + const imageId = generateId(); + const preview = await new Promise((resolve) => { + const reader = new FileReader(); + reader.onload = (e) => resolve(e.target?.result as string); + reader.readAsDataURL(file); + }); + + setImages((prev) => [ + ...prev, + { + id: imageId, + preview, + mediaToken: null, + file, + name: file.name, + isUploading: false, + }, + ]); + }), + ); + }; + + const handleGenerate = async () => { + if (!canGenerate) return; + setIsGenerating(true); + const subscriberId = generateId(); + + try { + window.__storeTaskEnqueueMeta?.({ + prompt: prompt.trim() || undefined, + refImageUrls: images.map((img) => img.preview).filter(Boolean), + modelType: isWorld + ? (selectedModel as any)?.tauriId || + defaultSplatModel?.tauriId || + String(selectedModel ?? defaultSplatModel) + : (selectedModel as any)?.tauriId || selectedObjectModelId, + timestamp: Date.now(), + }); + + // Three-way sources: library tokens pass through; locally attached + // files travel as bytes. + const referenceImageSources: MediaSource[] = await Promise.all( + readyImages.map(async (img): Promise => { + if (img.mediaToken) { + return { kind: "media_file_token", token: img.mediaToken }; + } + const bytes = Array.from( + new Uint8Array(await img.file!.arrayBuffer()), + ); + return { kind: "bytes", bytes, file_name: img.name || undefined }; + }), + ); + + const result = isWorld + ? await GenerateSplat({ + credential_id: selectedAccountId ?? undefined, + model: + (selectedModel as any)?.tauriId ?? + defaultSplatModel?.tauriId, + prompt: prompt.trim() || undefined, + reference_image_sources: referenceImageSources, + frontend_caller: "splat_page", + frontend_subscriber_id: subscriberId, + }) + : await GenerateMesh({ + credential_id: selectedAccountId ?? undefined, + model: selectedObjectModelId, + prompt: prompt.trim() || undefined, + reference_image_sources: referenceImageSources, + frontend_caller: "mesh_page", + frontend_subscriber_id: subscriberId, + }); + + if ("error_type" in result) { + throw new Error( + (result as any).error_message || (result as any).error_type, + ); + } + window.dispatchEvent(new Event("task-queue-update")); + } catch (error) { + const errorMessage = + error instanceof Error + ? error.message + : ((error as { error_message?: string } | null)?.error_message ?? + "An unexpected error occurred"); + toast.error(`Failed to generate 3D model: ${errorMessage}`); + } finally { + setIsGenerating(false); + } + }; + + return ( + + ) : ( + + ) + } + busy={busy} + completed={completed} + > +
e.preventDefault()} + onDrop={(e) => { + e.preventDefault(); + handleFiles(e.dataTransfer?.files); + }} + > + {isWorld ? ( +